feat: Adds statement creators for completed sale and generated lead (LLC-36) (#10)

Author: lydiamross

src/examples/completedSale.ts

@@ -0,0 +1,20 @@
+import completedSale from '../statementCreators/completedSale';
+
+const statement = completedSale({
+  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: 'demo@example.org',
+  userDisplayName: 'Demo User',
+  isWon: true,
+  closedReason: 'Too expensive',
+  accountDisplayName: 'Example Account',
+  accountUrl: 'https://demo.example.org',
+});
+
+export default statement;

src/examples/generatedLead.ts

@@ -0,0 +1,16 @@
+import generatedLead from '../statementCreators/generatedLead';
+
+const statement = generatedLead({
+  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: 'demo@example.org',
+  userDisplayName: 'Demo User',
+});
+
+export default statement;

src/statementConstants/activityTypes.ts

@@ -89,6 +89,11 @@ export const image = 'http://activitystrea.ms/schema/1.0/image';
  */
 export const issue = 'http://activitystrea.ms/schema/1.0/issue';
 
+/**
+ * Represents a person or business who may eventually become a client
+ */
+export const salesLead = `${customBaseUrl}/sales-lead`;
+
 /**
  * Means of expressing a link to another resource within, or external to, an activity.
  * Not synonymous with launching another resource.
@@ -172,6 +177,11 @@ export const resourceStructure = `${customBaseUrl}/resource-structure`;
  */
 export const resourceStructureNode = `${customBaseUrl}/resource-structure-node`;
 
+/**
+ * Represents a sales opportunity.
+ */
+export const salesOpportunity = 'http://id.tincanapi.com/activitytype/sales-opportunity';
+
 /**
  * Represents a feature to enable admins to manage access on a per-user or per-group basis.
  */

src/statementConstants/verbs.ts

@@ -21,6 +21,10 @@ export const attended = createVerb('http://activitystrea.ms/schema/1.0/attend',
 export const bookmarked = createVerb('http://id.tincanapi.com/verb/bookmarked', 'bookmarked');
 export const called = createVerb('http://id.tincanapi.com/verb/called', 'called');
 export const canceled = createVerb('https://w3id.org/xapi/dod-isd/verbs/canceled', 'canceled');
+export const closedSale = createVerb(
+  'http://id.tincanapi.com/verb/closed-sale',
+  'closed a sale with',
+);
 export const commentedOn = createVerb('http://adlnet.gov/expapi/verbs/commented', 'commented on');
 export const completed = createVerb('http://adlnet.gov/expapi/verbs/completed', 'completed');
 export const created = createVerb('http://activitystrea.ms/schema/1.0/create', 'created');
@@ -32,6 +36,10 @@ export const evaluated = createVerb('http://www.tincanapi.co.uk/verbs/evaluated'
 export const exited = createVerb('http://adlnet.gov/expapi/verbs/exited', 'exited');
 export const filled = createVerb('https://w3id.org/xapi/dod-isd/verbs/filled-out', 'filled');
 export const followed = createVerb('https://w3id.org/xapi/dod-isd/verbs/followed', 'followed');
+export const generated = createVerb(
+  'https://w3id.org/xapi/dod-isd/verbs/generated',
+  'generated a lead with',
+);
 export const joined = createVerb('http://activitystrea.ms/schema/1.0/join', 'joined');
 export const launched = createVerb('http://adlnet.gov/expapi/verbs/launched', 'launched');
 export const liked = createVerb('https://w3id.org/xapi/acrossx/verbs/liked', 'liked');

src/statementCreators/completedSale.ts

@@ -0,0 +1,82 @@
+import UserSiteAction from '../actionUtils/UserSiteAction';
+import { organization, salesOpportunity, site, source } from '../statementConstants/activityTypes';
+import { closedSale } 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 CompletedSaleAction 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;
+
+  /** Determines if the sale was a success or failure. */
+  readonly isWon?: boolean;
+
+  /** The reason for which a sale or opportunity is closed, usually when lost */
+  readonly closedReason?: string;
+
+  /** The URL or identifier of the account or organization linked to the sale or opportunity. */
+  readonly accountUrl: string;
+
+  /** The name of the account or organization linked to the sale or opportunity. */
+  readonly accountDisplayName?: string;
+}
+
+/**
+ * Creates an xAPI Statement to represent a user completing a face-to-face meeting.
+ */
+export default function completedSale(action: CompletedSaleAction): Statement {
+  return {
+    timestamp: createTimestamp(action.actionDate),
+    actor: createAgent({
+      displayName: action.userDisplayName,
+      id: action.userId,
+      idProviderUrl: action.userIdProviderUrl,
+      email: action.userEmail,
+    }),
+    verb: closedSale,
+    object: createActivity({
+      type: salesOpportunity,
+      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,
+          }),
+        ],
+        parent: [
+          createActivity({
+            type: organization,
+            url: action.accountUrl,
+            name: action.accountDisplayName,
+          }),
+        ],
+        category: [createActivity({
+          type: source,
+          url: action.platformUrl,
+          name: action.platformName,
+        })],
+      },
+    },
+    result: {
+      success: action.isWon,
+      response: action.closedReason,
+    },
+  };
+}

src/statementCreators/generatedLead.ts

@@ -0,0 +1,57 @@
+import UserSiteAction from '../actionUtils/UserSiteAction';
+import { salesLead, site, source } from '../statementConstants/activityTypes';
+import { generated } 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 GeneratedLeadAction 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 generatedLead(action: GeneratedLeadAction): Statement {
+  return {
+    timestamp: createTimestamp(action.actionDate),
+    actor: createAgent({
+      displayName: action.userDisplayName,
+      id: action.userId,
+      idProviderUrl: action.userIdProviderUrl,
+      email: action.userEmail,
+    }),
+    verb: generated,
+    object: createActivity({
+      type: salesLead,
+      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,
+        })],
+      },
+    },
+  };
+}