stentor-models 1.50.23 → 1.51.4

package/lib/Context.d.ts

@@ -5,6 +5,7 @@ import { AbstractResponseBuilder } from "./Response";
 import { SessionStore, Storage } from "./Storage";
 import { UserDataType } from "./UserData";
 import { UserProfile } from "./UserProfile";
+import { CrmService, SMSService } from "./Services";
 export declare enum UserDataRequestStatus {
     DEFERRED = 0,
     AVAILABLE = 1,
@@ -16,6 +17,13 @@ export interface UserDataValue {
     requestStatus: UserDataRequestStatus;
 }
 export declare type UserData = (userDataType: UserDataType) => Promise<UserDataRequestStatus>;
+/**
+ * These we want to make available for custom handlers
+ */
+export interface ContextServices {
+    crmService?: CrmService;
+    smsService?: SMSService;
+}
 /**
  * Context object that is passed around while formulating the response.
  *
@@ -41,7 +49,7 @@ export interface Context<S extends Storage = Storage> {
      */
     response: AbstractResponseBuilder;
     /**
-     * A method that servers user profile data (email, location, phone number, etc)
+     * A method that serves user profile data (email, location, phone number, etc)
      */
     requestUserData?: UserData;
     /**
@@ -52,4 +60,8 @@ export interface Context<S extends Storage = Storage> {
      * Milliseconds left from the execution (NOTE: infinity if not executing in a lambda)
      */
     timeLeftInMillis?(): number;
+    /**
+     * Services available for the handlers
+     */
+    services: ContextServices;
 }

package/lib/Context.js.map

@@ -1 +1 @@
-{"version":3,"file":"Context.js","sourceRoot":"","sources":["../src/Context.ts"],"names":[],"mappings":";;;AAQA,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,yEAAQ,CAAA;IACR,2EAAS,CAAA;IACT,mFAAa,CAAA;IACb,mEAAK,CAAA;AACT,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC"}
+{"version":3,"file":"Context.js","sourceRoot":"","sources":["../src/Context.ts"],"names":[],"mappings":";;;AASA,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,yEAAQ,CAAA;IACR,2EAAS,CAAA;IACT,mFAAa,CAAA;IACb,mEAAK,CAAA;AACT,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC"}

package/lib/Crm.d.ts

@@ -0,0 +1,31 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export interface LeadFormField {
+    name: string;
+    value: string;
+}
+export interface CrmTranscriptAttributes {
+    [attribute: string]: unknown;
+}
+/**
+ * Transcript representation of the session. The input/output is an easily readable, simplified representation
+ * of the visitor/bot "chat". This is usually emailed or sent to a CRM system or customer service for a quick overview.
+ * That is why input an output are strings.
+ */
+export interface CrmTranscriptExchange {
+    input: string;
+    output: string;
+    attributes?: CrmTranscriptAttributes;
+}
+export interface CrmTranscript {
+    items: CrmTranscriptExchange[];
+}
+export interface ExternalLead {
+    fields: LeadFormField[];
+    source?: string;
+    company?: string;
+    transcript?: CrmTranscript[];
+}
+export interface CrmResponse {
+    status: "Success" | "Failure";
+    message?: string;
+}

package/lib/Crm.js

@@ -0,0 +1,4 @@
+"use strict";
+/*! Copyright (c) 2022, XAPPmedia */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Crm.js.map

package/lib/Crm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Crm.js","sourceRoot":"","sources":["../src/Crm.ts"],"names":[],"mappings":";AAAA,oCAAoC"}

package/lib/Services/CrmService.d.ts

@@ -0,0 +1,9 @@
+/*! Copyright (c) 2022, XAPPmedia */
+import { CrmResponse, ExternalLead } from "../Crm";
+export interface CrmService {
+    /**
+     *
+     * @param externalLead
+     */
+    send(externalLead: ExternalLead): Promise<CrmResponse>;
+}

package/lib/Services/CrmService.js

@@ -0,0 +1,4 @@
+"use strict";
+/*! Copyright (c) 2022, XAPPmedia */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CrmService.js.map

package/lib/Services/CrmService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrmService.js","sourceRoot":"","sources":["../../src/Services/CrmService.ts"],"names":[],"mappings":";AAAA,oCAAoC"}

package/lib/Services/index.d.ts

@@ -1,6 +1,7 @@
 /*! Copyright (c) 2019, XAPPmedia */
 export * from "./AppService";
 export * from "./HandlerService";
+export * from "./CrmService";
 export * from "./KnowledgeBaseService";
 export * from "./PIIService";
 export * from "./SMSService";

package/lib/Services/index.js

@@ -13,6 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /*! Copyright (c) 2019, XAPPmedia */
 __exportStar(require("./AppService"), exports);
 __exportStar(require("./HandlerService"), exports);
+__exportStar(require("./CrmService"), exports);
 __exportStar(require("./KnowledgeBaseService"), exports);
 __exportStar(require("./PIIService"), exports);
 __exportStar(require("./SMSService"), exports);

package/lib/Services/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAoC;AACpC,+CAA6B;AAC7B,mDAAiC;AACjC,yDAAuC;AACvC,+CAA6B;AAC7B,+CAA6B;AAC7B,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAoC;AACpC,+CAA6B;AAC7B,mDAAiC;AACjC,+CAA6B;AAC7B,yDAAuC;AACvC,+CAA6B;AAC7B,+CAA6B;AAC7B,uDAAqC"}

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export * from "./Channel";
 export * from "./Conditional";
 export * from "./Context";
 export * from "./Contextual";
+export * from "./Crm";
 export * from "./DateTime";
 export * from "./DelegatingHandler";
 export * from "./Device";

package/lib/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./Channel"), exports);
 __exportStar(require("./Conditional"), exports);
 __exportStar(require("./Context"), exports);
 __exportStar(require("./Contextual"), exports);
+__exportStar(require("./Crm"), exports);
 __exportStar(require("./DateTime"), exports);
 __exportStar(require("./DelegatingHandler"), exports);
 __exportStar(require("./Device"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAoC;AACpC,2CAAyB;AACzB,wCAAsB;AACtB,4CAA0B;AAC1B,gDAA8B;AAC9B,4CAA0B;AAC1B,+CAA6B;AAC7B,6CAA2B;AAC3B,sDAAoC;AACpC,2CAAyB;AACzB,4CAA0B;AAC1B,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,kDAAgC;AAChC,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB;AACxB,0CAAwB;AACxB,wCAAsB;AACtB,yCAAuB;AACvB,wCAAsB;AACtB,4CAA0B;AAC1B,mDAAiC;AACjC,6CAA2B;AAC3B,4CAA0B;AAC1B,6CAA2B;AAC3B,yCAAuB;AACvB,wCAAsB;AACtB,4CAA0B;AAC1B,+CAA6B;AAC7B,6CAA2B;AAC3B,gDAA8B;AAC9B,kDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAoC;AACpC,2CAAyB;AACzB,wCAAsB;AACtB,4CAA0B;AAC1B,gDAA8B;AAC9B,4CAA0B;AAC1B,+CAA6B;AAC7B,wCAAsB;AACtB,6CAA2B;AAC3B,sDAAoC;AACpC,2CAAyB;AACzB,4CAA0B;AAC1B,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,kDAAgC;AAChC,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB;AACxB,0CAAwB;AACxB,wCAAsB;AACtB,yCAAuB;AACvB,wCAAsB;AACtB,4CAA0B;AAC1B,mDAAiC;AACjC,6CAA2B;AAC3B,4CAA0B;AAC1B,6CAA2B;AAC3B,yCAAuB;AACvB,wCAAsB;AACtB,4CAA0B;AAC1B,+CAA6B;AAC7B,6CAA2B;AAC3B,gDAA8B;AAC9B,kDAAgC"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.50.23",
+  "version": "1.51.4",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -20,7 +20,7 @@
     "@microsoft/api-extractor": "7.19.4",
     "@rollup/plugin-typescript": "8.3.0",
     "@xapp/config": "0.2.3",
-    "rollup": "2.66.0",
+    "rollup": "2.66.1",
     "tslib": "2.3.1",
     "typescript": "4.5.5"
   },
@@ -31,7 +31,7 @@
     "clean": "rm -rf ./lib/* && rm -rf ./dist/*"
   },
   "dependencies": {
-    "@xapp/patterns": "1.39.50"
+    "@xapp/patterns": "1.39.67"
   },
-  "gitHead": "5046383ed2451e173ab4900e2b413cd54dc832e3"
+  "gitHead": "88fffe00e6e2383eb59ffc93f8c394ce23db349d"
 }