feat: Adds completedFaceToFace statement creator. (#2)

Author: lydiamross

src/examples/completedFaceToFace.ts

@@ -0,0 +1,16 @@
+import completedFaceToFace from '../statementCreators/completedFaceToFace';
+
+const statement = completedFaceToFace({
+  actionDate: new Date(),
+  activityUrl: 'https://demo.example.org/courses/demo-course',
+  siteUrl: 'https://demo.example.org',
+  siteName: 'Demo Example Site',
+  platformUrl: 'https://example.org',
+  platformName: 'Example Platform',
+  userId: '123',
+  userIdProviderUrl: 'https://demo.example.org',
+  userEmail: '[email protected]',
+  userDisplayName: 'Demo User',
+});
+
+export default statement;

src/statementCreators/completedFaceToFace.ts

@@ -0,0 +1,57 @@
+import UserSiteAction from '../actionUtils/UserSiteAction';
+import { faceToFace, site, source } from '../statementConstants/activityTypes';
+import { completed } from '../statementConstants/verbs';
+import createActivity from '../statementUtils/createActivity';
+import createAgent from '../statementUtils/createAgent';
+import createTimestamp from '../statementUtils/createTimestamp';
+import { Extensions, Statement } from '../statementUtils/types';
+
+export interface CompletedFaceToFaceAction extends UserSiteAction {
+  /** The URL where the activity can be accessed. */
+  readonly activityUrl: string;
+
+  /** The human readable name for the activity. */
+  readonly activityName?: string;
+
+  /** Additional properties of the activity. */
+  readonly activityExtensions?: Extensions;
+}
+
+/**
+ * Creates an xAPI Statement to represent a user completing a face-to-face meeting.
+ */
+export default function completedFaceToFace(action: CompletedFaceToFaceAction): Statement {
+  return {
+    timestamp: createTimestamp(action.actionDate),
+    actor: createAgent({
+      displayName: action.userDisplayName,
+      id: action.userId,
+      idProviderUrl: action.userIdProviderUrl,
+      email: action.userEmail,
+    }),
+    verb: completed,
+    object: createActivity({
+      type: faceToFace,
+      url: action.activityUrl,
+      name: action.activityName,
+      extensions: action.activityExtensions,
+    }),
+    context: {
+      platform: action.platformName,
+      language: 'en',
+      extensions: action.contextExtensions,
+      contextActivities: {
+        grouping: [createActivity({
+          type: site,
+          url: action.siteUrl,
+          name: action.siteName,
+        })],
+        category: [createActivity({
+          type: source,
+          url: action.platformUrl,
+          name: action.platformName,
+        })],
+      },
+    },
+  };
+}

src/statementCreators/plannedFaceToFace.ts

@@ -32,7 +32,7 @@ export default function plannedFaceToFace(action: PlannedFaceToFaceAction): Stat
     verb: planned,
     object: createActivity({
       type: faceToFace,
-      url: action.siteUrl,
+      url: action.activityUrl,
       name: action.activityName,
       extensions: action.activityExtensions,
     }),