stentor-models 1.51.0 → 1.52.2

package/lib/App/App.d.ts

@@ -1,6 +1,7 @@
 /*! Copyright (c) 2019, XAPPmedia */
 import { ChannelData } from "../Channel";
 import { ImageSpecification } from "../Display";
+import { KnowledgebaseData } from "../Knowledgebase";
 import { Locale, Localizable } from "../Locale";
 import { Location } from "../Location";
 import { NLUData } from "../NLU";
@@ -180,6 +181,8 @@ export interface App extends Localizable<LocaleSpecificApp> {
     /**
      * Channels for the app.
      *
+     * Channels may have their own NLU and or Knowledgebase
+     *
      * Upgrade from platformData as it allows to publish the same
      * assistant app multiple times to the same channel.
      *
@@ -190,6 +193,12 @@ export interface App extends Localizable<LocaleSpecificApp> {
      *
      */
     nlu?: NLUData[];
+    /**
+     * Knowledgebase available to the assistant application.
+     *
+     * @alpha This feature is currently under development
+     */
+    knowledgebase?: KnowledgebaseData[];
     /**
      * Data streams for the app.
      *

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/Knowledgebase/KnowledgebaseData.d.ts

@@ -0,0 +1,11 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export interface KnowledgebaseData {
+    /**
+     * Unique ID of the knowledgebase
+     */
+    id: string;
+    /**
+     * The type of knowledgebase
+     */
+    type: string;
+}

package/lib/Knowledgebase/KnowledgebaseData.js

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

package/lib/Knowledgebase/KnowledgebaseData.js.map

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

package/lib/Knowledgebase/index.d.ts

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2022, XAPPmedia */
+export * from "./KnowledgebaseData";

package/lib/Knowledgebase/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*! Copyright (c) 2022, XAPPmedia */
+__exportStar(require("./KnowledgebaseData"), exports);
+//# sourceMappingURL=index.js.map

package/lib/Knowledgebase/index.js.map

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

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.51.0",
+  "version": "1.52.2",
   "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"
   },
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "1.39.67"
   },
-  "gitHead": "c5b725070a376dfe5eceaca64a6d79430acd5740"
+  "gitHead": "604f697ca4395aa7ac85ef010b4466a15e0fe7b2"
 }