@cognigy/rest-api-client 0.15.0 → 0.17.0

package/build/shared/helper/BaseContext.js

@@ -34,6 +34,14 @@ class BaseContext {
     createProxy(initial = {}) {
         return new Proxy(initial, {
             set: (obj, prop, value) => {
+                if (!prop) {
+                    logger_1.logger.log("debug", { traceId: this.traceId, disableSensitiveLogging: true }, `Trying to set context with an invalid key '${prop === null || prop === void 0 ? void 0 : prop.toString()}' (context with an invalid key cannot be set).`, {
+                        key: prop,
+                        module: "BaseContext.ts",
+                        function: "set:createProxy"
+                    });
+                    return true;
+                }
                 if (this.ignoreTrapHandler) {
                     obj[prop] = value;
                     return true;
@@ -71,20 +79,13 @@ class BaseContext {
      * @memberOf Context
      */
     importContext(data, traceId, replace) {
-        var _a;
         if (replace) {
-            if (typeof data !== 'object' || data !== null) {
+            if (typeof data !== 'object' && data !== null) {
                 logger_1.logger.log("debug", { traceId }, `[importContext] Trying to replace context with data that is not an object`, {
                     organisationId: this.organisationId,
                     projectId: this.projectId,
                 });
             }
-            else {
-                logger_1.logger.log("debug", { traceId }, `[importContext] Replacing the brains context, length: ${(_a = JSON.stringify(data)) === null || _a === void 0 ? void 0 : _a.length}`, {
-                    organisationId: this.organisationId,
-                    projectId: this.projectId,
-                });
-            }
             // make a deep copy of the provided 'data' to get rid of references.
             // we also do not allow 'null' as an input
             const deepCopy = JSON.parse(JSON.stringify(data));
@@ -111,18 +112,12 @@ class BaseContext {
             }
         }
         else {
-            if (typeof data !== 'object' || data !== null) {
+            if (typeof data !== 'object' && data !== null) {
                 logger_1.logger.log("debug", { traceId }, `[importContext] Trying to set context for data that is not an object`, {
                     organisationId: this.organisationId,
                     projectId: this.projectId,
                 });
             }
-            else {
-                logger_1.logger.log("debug", { traceId }, `[importContext] Set context for ${Object.keys(data).length} keys`, {
-                    organisationId: this.organisationId,
-                    projectId: this.projectId,
-                });
-            }
             for (let c in data) {
                 this.setContext(c, data[c], traceId);
             }
@@ -136,6 +131,14 @@ class BaseContext {
      * @memberOf Context
      */
     getContext(key) {
+        if (!key) {
+            logger_1.logger.log("debug", { traceId: this.traceId, disableSensitiveLogging: true }, `Trying to get context with an invalid key '${key}' (context with an invalid key cannot be accessed).`, {
+                key,
+                module: "BaseContext.ts",
+                function: "getContext"
+            });
+            return undefined;
+        }
         let s = [];
         if (key.indexOf(".") > -1)
             s = key.split(".");
@@ -172,6 +175,14 @@ class BaseContext {
      * @memberOf Context
      */
     setContext(key, value, traceId) {
+        if (!key) {
+            logger_1.logger.log("debug", { traceId, disableSensitiveLogging: true }, `Trying to set context with an invalid key '${key}' (context with an invalid key cannot be set).`, {
+                key,
+                module: "BaseContext.ts",
+                function: "setContext"
+            });
+            return;
+        }
         this.context[key] = value;
     }
     /**
@@ -227,6 +238,13 @@ class BaseContext {
      * @memberOf Context
      */
     delete(key) {
+        if (!key) {
+            logger_1.logger.log("debug", { traceId: this.traceId, disableSensitiveLogging: true }, `Trying to delete key from the context with an invalid key '${key}' (context with an invalid key cannot be accessed).`, {
+                key,
+                module: "BaseContext.ts",
+                function: "delete"
+            });
+        }
         delete this.context[key];
     }
     /**

package/build/shared/helper/nlu/textCleaner.js

@@ -54,8 +54,8 @@ class TextCleaner {
             phrase = this.resolveSpelledOutNumbers(phrase, detailedSlots, false);
         if (!options || options.resolvePhoneticAlphabet)
             phrase = this.resolvePhoneticAlphabet(phrase);
-        if (!options || options.replaceSpecialWords)
-            phrase = this.replaceSpecialWords(phrase);
+        if (!options || options.replaceSpecialWords || options.replaceSpecialPhrases)
+            phrase = this.replaceSpecialPhrases(phrase);
         if (!options || options.resolveSpelledOutAlphabet)
             phrase = this.resolveSpelledOutAlphabet(phrase);
         if (!options || options.resolvePhoneticCounters)
@@ -136,6 +136,7 @@ class TextCleaner {
     /**
      * Replaces specifically determined words with their replacements
      * e.g. "färben" -> "verden"
+     * @deprecated Use replaceSpecialPhrases instead
      */
     replaceSpecialWords(phrase) {
         phrase = phrase.toLowerCase().replace(this.allowedSymbolsRegex, '');
@@ -159,6 +160,27 @@ class TextCleaner {
         phrase = cleanedWords.join(' ');
         return phrase;
     }
+    /**
+     * Replaces specifically determined phrases with their replacements
+     * e.g. "swiss airlines international" -> "SWISS"
+     */
+    replaceSpecialPhrases(phrase) {
+        // lowercase the whole dictSpecials
+        for (const [key, value] of Object.entries(this.dictSpecials)) {
+            this.dictSpecials[key.toLowerCase()] = value;
+        }
+        // Replace all double spaces with single spaces
+        let normalizedPhrase = phrase.replace(/\s+/g, ' ').toLowerCase();
+        for (let phraseToDetect of Object.keys(this.dictSpecials)) {
+            // make phrase regex-safe
+            phraseToDetect = phraseToDetect.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
+            const matches = normalizedPhrase.match(new RegExp(`\\b(${phraseToDetect})\\b`, 'gi'));
+            if (matches) {
+                normalizedPhrase = normalizedPhrase.replace(new RegExp(`\\b${matches[0]}\\b`, "gi"), this.dictSpecials[phraseToDetect]);
+            }
+        }
+        return normalizedPhrase;
+    }
     /**
      * Detects and replaces all words which are known in the spelling alphabet
      * e.g. "alpha tango lima" -> "a t l" or "anton ida otto" -> "a i o"
@@ -228,7 +250,7 @@ class TextCleaner {
         let matches;
         do {
             const allowedRepeaters = this.dictNumberMultipliers.join("|");
-            const xMalYRegex = new RegExp(`(\\d){1}\\s*(${allowedRepeaters}|\\*)\\s*[die\\s]*(\\d+|\\w+)`, "gi");
+            const xMalYRegex = new RegExp(`(\\d+){1}\\s*(${allowedRepeaters}|\\*)\\s*[die\\s]*(\\d+|\\w+)`, "gi");
             phrase = phrase.replace(/\s\s/gi, ' ');
             matches = xMalYRegex.exec(phrase);
             if (matches && !isNaN(Number(matches[1])) && !isNaN(Number(matches[3]))) {

package/build/shared/interfaces/IEndpointTranslationSettings.js

@@ -18,6 +18,15 @@ exports.translationSettingsEndpointSchema = {
         noTranslateMarker: {
             type: "string"
         },
+        glossaryId: {
+            type: "string"
+        },
+        glossaryIdInput: {
+            type: "string"
+        },
+        formality: {
+            type: "string"
+        },
         padPayloads: {
             type: "boolean"
         },

package/build/shared/interfaces/IOrganisation.js

@@ -10,6 +10,7 @@ exports.organisationDataPrivacySettingsSchema = {
     properties: {
         enabled: { type: "boolean" },
         useAnalytics: { type: "boolean" },
+        storeDataPayload: { type: "boolean" },
         useContactProfiles: { type: "boolean" },
         useConversations: { type: "boolean" },
         maskIPAddress: { type: "boolean" },
@@ -59,7 +60,7 @@ exports.organisationSchema = {
     title: "organisationSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, exports.organisationDataSchema.properties), { liveAgentAccount: { type: "number" } }),
+    properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, exports.organisationDataSchema.properties), { liveAgentAccount: { type: "number" }, voiceGatewayAccount: { type: "string" } }),
 };
 exports.organisationQuerySchema = (0, createQuerySchema_1.createQuerySchema)("organisationQuerySchema", exports.organisationSchema);
 //# sourceMappingURL=IOrganisation.js.map

package/build/shared/interfaces/agentAssist/ISendConfigUpdateParams.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ISendConfigUpdateParams.js.map

package/build/shared/interfaces/agentAssist/ISendUpdateReferenceParams.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ISendUpdateReferenceParams.js.map

package/build/shared/interfaces/amqpInterface.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeRpcInternalParamsSchema = exports.referenceKeys = void 0;
-;
 exports.referenceKeys = [
     "analyticsStepReference",
     "chartReference",
@@ -31,39 +30,33 @@ exports.referenceKeys = [
 exports.executeRpcInternalParamsSchema = {
     title: "executeRpcInternalParamsSchema",
     type: "object",
-    required: [
-        "serviceQueue",
-        "payload"
-    ],
+    required: ["serviceQueue", "payload"],
     additionalProperties: false,
     properties: {
         serviceQueue: {
             type: "string",
-            minLength: 1
+            minLength: 1,
         },
         payload: {
             type: "object",
-            required: [
-                "type",
-                "data",
-            ],
+            required: ["type", "data"],
             properties: {
                 type: {
                     type: "string",
-                    minLength: 1
+                    minLength: 1,
                 },
                 data: {
-                    type: "object"
-                }
-            }
+                    type: "object",
+                },
+            },
         },
         timeout: {
             anyOf: [
                 {
                     type: ["integer", "null"],
-                    minimum: -1
-                }
-            ]
+                    minimum: -1,
+                },
+            ],
         },
         consumerTag: {
             type: "string",
@@ -77,18 +70,21 @@ exports.executeRpcInternalParamsSchema = {
             type: "boolean",
         },
         reThrow: {
-            type: "boolean"
+            type: "boolean",
         },
         exchange: {
-            type: "string"
+            type: "string",
         },
         expiration: {
-            type: "string"
+            type: "string",
         },
         errorLogLevel: {
             type: "string",
             enum: ["error", "warn"],
-        }
-    }
+        },
+        priority: {
+            type: "number",
+        },
+    },
 };
 //# sourceMappingURL=amqpInterface.js.map

package/build/shared/interfaces/channels/genesysBotConnector.js

@@ -0,0 +1,21 @@
+"use strict";
+// generated using https://app.quicktype.io/?l=ts
+// and the "post utterance response body" schema
+// https://developer.dev-genesys.cloud/commdigital/textbots/botconnector-customer-api-spec#postutterance-response-schema
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isJsonChannelConfiguration = exports.isTextChannelConfiguration = void 0;
+/**
+ * type-guard that checks whether a "genesys channel configuration" is a "text configuration"
+ */
+const isTextChannelConfiguration = (channelContent) => {
+    return typeof (channelContent === null || channelContent === void 0 ? void 0 : channelContent.text) === 'string';
+};
+exports.isTextChannelConfiguration = isTextChannelConfiguration;
+/**
+ * type-guard that checks whether a "genesys channel configuration" is a "json configuration"
+ */
+const isJsonChannelConfiguration = (channelContent) => {
+    return !!(channelContent === null || channelContent === void 0 ? void 0 : channelContent.json);
+};
+exports.isJsonChannelConfiguration = isJsonChannelConfiguration;
+//# sourceMappingURL=genesysBotConnector.js.map

package/build/shared/interfaces/channels/niceCXOne.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNiceCXOneJsonContent = exports.isNiceCXOneTextContent = void 0;
+const isNiceCXOneTextContent = (content) => !!(content === null || content === void 0 ? void 0 : content.text);
+exports.isNiceCXOneTextContent = isNiceCXOneTextContent;
+const isNiceCXOneJsonContent = (content) => !!(content === null || content === void 0 ? void 0 : content.json);
+exports.isNiceCXOneJsonContent = isNiceCXOneJsonContent;
+//# sourceMappingURL=niceCXOne.js.map

package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js

@@ -13,8 +13,12 @@ exports.modeType = exports.generativeAIUseCases = exports.generativeAIProviders
  *       type: string
  *       enum:
  *         - gpt-3.5-turbo
+ *         - gpt-3.5-turbo-instruct
  *         - text-davinci-003
+ *         - gpt-4
  *         - text-embedding-ada-002
+ *         - luminous-extended-control
+ *         - luminous-embedding-128
  *         - claude-v1-100k
  *         - claude-instant-v1
  *         - text-bison@001
@@ -25,11 +29,15 @@ exports.modeType = exports.generativeAIUseCases = exports.generativeAIProviders
  */
 exports.generativeAIModels = [
     "gpt-3.5-turbo",
+    "gpt-3.5-turbo-instruct",
+    "gpt-4",
     "text-davinci-003",
     "text-embedding-ada-002",
+    "luminous-extended-control",
+    "luminous-embedding-128",
     "claude-v1-100k",
     "claude-instant-v1",
-    "text-bison@001"
+    "text-bison@001",
 ];
 /*************
  * PROVIDERS
@@ -46,8 +54,9 @@ exports.generativeAIModels = [
  *         - openAI
  *         - anthropic
  *         - googleVertexAI
+ *         - alephAlpha
  */
-exports.generativeAIProviders = ["azureOpenAI", "openAI", "anthropic", "googleVertexAI"];
+exports.generativeAIProviders = ["azureOpenAI", "openAI", "alephAlpha", "anthropic", "googleVertexAI"];
 /***********************
  * COGNIGY.AI USE CASES
  ***********************/
@@ -56,14 +65,15 @@ exports.generativeAIProviders = ["azureOpenAI", "openAI", "anthropic", "googleVe
  * mongoose schema too. models/settings/generativeAISettings.ts
  */
 exports.generativeAIUseCases = [
-    "intentSentenceGeneration",
+    "knowledgeSearch",
+    "gptPromptNode",
+    "gptConversation",
     "aiEnhancedOutputs",
-    "lexiconGeneration",
+    "sentimentAnalysis",
+    "intentSentenceGeneration",
     "flowGeneration",
-    "gptConversation",
-    "gptPromptNode",
     "generateNodeOutput",
-    "knowledgeSearch",
+    "lexiconGeneration",
 ];
 /************************
  * GENERATIVE AI MODELS MODE TYPES

package/build/shared/interfaces/handover.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.genesysCloudSettingsSchema = exports.liveAgentSettingsSchema = exports.salesforceSettingsSchema = exports.chatwootSettingsSchema = exports.handoverAgentReplySchema = exports.eightByEightSettingsSchema = exports.rceSettingsSchema = exports.foreignSessionDataSchema = exports.handoverRequestSettingsSchema = exports.handoverSettingsSchema = exports.whisperAssistConfigurations = exports.handoverProviders = exports.internalHandoverProviders = exports.externalHandoverProviders = void 0;
+exports.genesysCloudOMSettingsSchema = exports.genesysCloudSettingsSchema = exports.liveAgentSettingsSchema = exports.salesforceSettingsSchema = exports.chatwootSettingsSchema = exports.handoverAgentReplySchema = exports.eightByEightSettingsSchema = exports.rceSettingsSchema = exports.foreignSessionDataSchema = exports.handoverRequestSettingsSchema = exports.handoverSettingsSchema = exports.whisperAssistConfigurations = exports.handoverProviders = exports.internalHandoverProviders = exports.externalHandoverProviders = void 0;
 exports.externalHandoverProviders = [
     "rce",
     "chatwoot",
     "salesforce",
     "liveAgent",
     "genesysCloud",
+    "genesysCloudOM",
     "eightByEight",
 ];
 exports.internalHandoverProviders = [
@@ -37,6 +38,7 @@ exports.handoverSettingsSchema = {
                 "salesforce",
                 "liveAgent",
                 "genesysCloud",
+                "genesysCloudOM",
                 "eightByEight"
             ]
         },
@@ -53,6 +55,7 @@ exports.handoverSettingsSchema = {
                         apiTenant: { type: "string" },
                         usePlatformToken: { type: "boolean" },
                         forwardOnlyHandoverConversations: { type: "boolean" },
+                        getQueueUpdates: { type: "boolean" },
                         apiAccessToken: { type: "string" },
                         baseApiUrl: { type: "string", format: "url" },
                         realtimeAccessToken: { type: "string" },
@@ -63,6 +66,9 @@ exports.handoverSettingsSchema = {
                         apiVersion: { type: "string" },
                         organizationId: { type: "string" },
                         deploymentId: { type: "string" },
+                        deploymentName: { type: "string" },
+                        clientId: { type: "string" },
+                        clientSecret: { type: "string" },
                         buttonId: { type: "string" },
                         forwardUnknownEventsToFlow: { type: "boolean" },
                         liveAgentInboxId: { type: "string" },
@@ -85,7 +91,8 @@ exports.handoverSettingsSchema = {
                 agentAssistConfigId: { type: "string" },
                 enableTranscriptTile: { type: "boolean" },
                 enableTranscriptTileChatInput: { type: "boolean" },
-                redactTranscriptTileMessages: { type: "boolean" }
+                redactTranscriptTileMessages: { type: "boolean" },
+                oAuth2Connection: { type: "string" }
             }
         }
     }
@@ -106,7 +113,13 @@ exports.foreignSessionDataSchema = {
         foreignSessionId: { type: "string" },
         memberId: { type: "string" },
         token: { type: "string" },
-        affinityToken: { type: "string" }
+        affinityToken: { type: "string" },
+        userId: { type: "string" },
+        firstname: { type: "string" },
+        lastname: { type: "string" },
+        nickname: { type: "string" },
+        integrationId: { type: "string" },
+        conversationId: { type: "string" }
     }
 };
 exports.rceSettingsSchema = {
@@ -127,6 +140,9 @@ exports.rceSettingsSchema = {
         "forwardOnlyHandoverConversations": {
             "type": "boolean"
         },
+        "getQueueUpdates": {
+            "type": "boolean"
+        },
         "apiAccessToken": {
             "type": "string"
         },
@@ -342,4 +358,42 @@ exports.genesysCloudSettingsSchema = {
         }
     }
 };
+exports.genesysCloudOMSettingsSchema = {
+    title: "genesysCloudOMSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "host",
+        "deploymentName",
+        "queue",
+        "clientId",
+        "clientSecret"
+    ],
+    properties: {
+        host: {
+            type: "string"
+        },
+        deploymentName: {
+            type: "string"
+        },
+        queue: {
+            type: "string"
+        },
+        webhookSecret: {
+            type: "string"
+        },
+        sendProfile: {
+            type: "boolean"
+        },
+        clientId: {
+            type: "string"
+        },
+        clientSecret: {
+            type: "string"
+        },
+        forwardOnlyHandoverConversations: {
+            "type": "boolean",
+        }
+    }
+};
 //# sourceMappingURL=handover.js.map

package/build/shared/interfaces/journeys/IJourney.js

@@ -11,6 +11,8 @@ exports.journeyStepGoals = [
     "createEndpoint",
     "createLexicon",
     "createSnapshot",
+    "createKnowledgeStore",
+    "createKnowledgeSource",
     "openWebchat",
     "createCodeNode",
     "createHttpRequestNode",
@@ -18,6 +20,10 @@ exports.journeyStepGoals = [
     "createQuestionNode",
     "createSayNode",
     "createLookupNode",
+    "createKnowledgeSearchNode",
+    "createSearchExtractOutputNode",
+    "createGptConversationNode",
+    "createLlmPromptNode",
     "updateCaseNode",
     "updateHttpRequestNode",
     "updateIfNode",

package/build/shared/interfaces/journeys/IJourneyTrackEvent.js

@@ -8,6 +8,8 @@ exports.trackableJourneyEvent = [
     "createEndpoint",
     "createLexicon",
     "createSnapshot",
+    "createKnowledgeStore",
+    "createKnowledgeSource",
     /* endpoint editor */
     "openWebchat",
     /* flow chart */