stentor-models 1.52.33 → 1.53.1

package/lib/Crm.d.ts

@@ -1,29 +1,14 @@
 /*! Copyright (c) 2022, XAPPmedia */
+import { Message } from "./Message";
 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[];
+    transcript?: Message[];
 }
 export interface CrmResponse {
     status: "Success" | "Failure";

package/lib/Crm.js

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

package/lib/Crm.js.map

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

package/lib/Message.d.ts

@@ -0,0 +1,31 @@
+/*! Copyright (c) 2022, XAPPmedia */
+import { ResponseOutput } from "./Response";
+import { UserProfile } from "./UserProfile";
+export interface Message {
+    /**
+     * The time the message was created
+     */
+    createdTime: string;
+    /**
+     * Who the message is from
+     */
+    from?: UserProfile;
+    /**
+     * Who the message is two, it can be to multiple recipients.
+     */
+    to?: UserProfile[];
+    /**
+     * A simple version of the message.  It will not include displays or SSML if the original message includes it.
+     */
+    message: string;
+    /**
+     * Optional, more detailed information about the message
+     */
+    response?: ResponseOutput;
+    /**
+     * Optional, additional attributes that can exist on the message.
+     *
+     * Useful to pass additional context.
+     */
+    attributes?: object;
+}

package/lib/Message.js

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

package/lib/Message.js.map

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

package/lib/Request/Request.d.ts

@@ -27,6 +27,10 @@ export interface BaseRequest {
      * pulls content or paths for this key instead of for the request.
      */
     overrideKey?: string;
+    /**
+     * When the message was created, an ISO-8601 compatible date time string
+     */
+    createdTime?: string;
     /**
      * ID for the user making the request.
      */
@@ -100,6 +104,12 @@ export interface BaseRequest {
      * Currently only Google and Dialogflow perform health checks.
      */
     isHealthCheck?: boolean;
+    /**
+     * Optional request attributes to be passed through on the request.
+     *
+     * If the channel supports it, it will be populated.
+     */
+    attributes?: object;
 }
 export interface ApiAccessData {
     apiBaseUrl: string;

package/lib/Storage/SessionStore.d.ts

@@ -1,9 +1,20 @@
 /*! Copyright (c) 2019, XAPPmedia */
+import { Message } from "../Message";
 /**
  * Lets make it simple and versatile
  */
 export interface SessionStoreData {
+    /**
+     * ID for the session storage, typically the session ID.
+     */
     id: string;
+    /**
+     * Optional transcript of the session that can be used for reporting purposes.
+     */
+    transcript?: Message[];
+    /**
+     * The data store that is modified.
+     */
     data: {
         [key: string]: any;
     };
@@ -29,4 +40,8 @@ export interface SessionStore {
      * @returns The session storage
      */
     getStore(): any;
+    /**
+     * Returns the transcript of the session.
+     */
+    transcript?(): Message[];
 }

package/lib/UserProfile.d.ts

@@ -1,5 +1,9 @@
 /*! Copyright (c) 2019, XAPPmedia */
 export interface UserProfile {
+    /**
+     * Unique userId
+     */
+    id: string;
     /**
      * The first name, or given name, of the user.
      */

package/lib/index.d.ts

@@ -22,6 +22,7 @@ export * from "./Location";
 export * from "./Logic";
 export * from "./Match";
 export * from "./Media";
+export * from "./Message";
 export * from "./NLU";
 export * from "./Path";
 export * from "./Pii";

package/lib/index.js

@@ -38,6 +38,7 @@ __exportStar(require("./Location"), exports);
 __exportStar(require("./Logic"), exports);
 __exportStar(require("./Match"), exports);
 __exportStar(require("./Media"), exports);
+__exportStar(require("./Message"), exports);
 __exportStar(require("./NLU"), exports);
 __exportStar(require("./Path"), exports);
 __exportStar(require("./Pii"), 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,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"}
+{"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,4CAA0B;AAC1B,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.52.33",
+  "version": "1.53.1",
   "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.1",
     "@xapp/config": "0.2.3",
-    "rollup": "2.69.0",
+    "rollup": "2.70.0",
     "tslib": "2.3.1",
     "typescript": "4.6.2"
   },
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "1.40.63"
   },
-  "gitHead": "de6d2332824f8892015770cd832b6a4577f0afb0"
+  "gitHead": "7aad19c222a8e75e78399ee9903b9ed6fc26c2cc"
 }