@cognigy/rest-api-client 0.14.0 → 0.16.0

package/build/shared/charts/helpers/generativeAI/getRephraseWithAIFields.js

@@ -9,20 +9,20 @@ const getRephraseWithAIFields = () => {
         {
             key: "generativeAI_rephraseOutputMode",
             type: "select",
-            label: "Rephrase Output",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__LABEL",
             params: {
                 required: true,
                 options: [
                     {
-                        label: "None",
+                        label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__OPTIONS__NONE__LABEL",
                         value: "none"
                     },
                     {
-                        label: "Based on Previous User Inputs",
+                        label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__OPTIONS__USER_INPUTS__LABEL",
                         value: "userInputs"
                     },
                     {
-                        label: "Based on Custom Input",
+                        label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__OPTIONS__CUSTOM_INPUTS__LABEL",
                         value: "customInputs"
                     },
                 ],
@@ -32,7 +32,7 @@ const getRephraseWithAIFields = () => {
         {
             key: "generativeAI_amountOfLastUserInputs",
             type: "slider",
-            label: "Number of Previous User Inputs",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__AMOUNT_OF_LAST_USER_INPUTS__LABEL",
             params: {
                 min: 1,
                 max: 10,
@@ -47,7 +47,7 @@ const getRephraseWithAIFields = () => {
         {
             key: "generativeAI_customInputs",
             type: "cognigyTextArray",
-            label: "Custom Inputs",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__CUSTOM_INPUTS__LABEL",
             condition: {
                 key: "generativeAI_rephraseOutputMode",
                 value: "customInputs",
@@ -56,7 +56,7 @@ const getRephraseWithAIFields = () => {
         {
             key: "generativeAI_temperature",
             type: "slider",
-            label: "Temperature",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__TEMPERATURE__LABEL",
             params: {
                 min: 0,
                 max: 1,
@@ -86,7 +86,7 @@ exports.getRephraseWithAIFields = getRephraseWithAIFields;
 const getRephraseWithAISection = () => {
     return {
         key: "aiEnhancedOutput",
-        label: "AI-enhanced output",
+        label: "UI__NODE_EDITOR__GENERATIVE_AI__LABEL",
         defaultCollapsed: true,
         fields: [
             "generativeAI_rephraseOutputMode",

package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js

@@ -19,7 +19,7 @@ const rephraseMultipleSentencesWithAI = async (sentences, config, api, organisat
 exports.rephraseMultipleSentencesWithAI = rephraseMultipleSentencesWithAI;
 const createRephraseSentenceWithAIOptions = (params) => {
     const options = {
-        promptType: params.promtType,
+        promptType: params.promptType,
         questionType: params.questionType,
         temperature: params.generativeAI_temperature,
         question: params.question,

package/build/shared/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GENERATIVE_AI_PROVIDER_EXTENSION = exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
+exports.IP_NOT_AVAILABLE = exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = exports.TRANSLATION_PROVIDER_EXTENSION = exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = exports.GENERATIVE_AI_PROVIDER_EXTENSION = exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
 exports.CREATED_BY_SSO = "000000000000000000000550";
 exports.SYSTEM = "000000000000000000000000";
 exports.SYSTEM_EMAIL = "system@mail.com";
@@ -21,4 +21,21 @@ exports.EMBEDDED_EXTENSION = "@embedded/";
 exports.X_COGNIGY_ORIGIN = "x-cognigy-origin";
 exports.ADMIN_CONSOLE_URL_TOKEN = "ffffffffffffffffffff55555555555555555eeeeeeeeeeeeeeeaaaaaaaaaaaa";
 exports.GENERATIVE_AI_PROVIDER_EXTENSION = "@cognigy/generative-ai-provider";
+exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = "@cognigy/audio-preview-provider";
+exports.TRANSLATION_PROVIDER_EXTENSION = "@cognigy/translation-provider";
+exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = {
+    ESCALATE_INTENTS_HANDOVER_LIVE_AGENT_INBOX_ID: "escalateIntentsHandoverLiveAgentInboxId",
+    ESCALATE_INTENTS_AGENT_ASSIST_INIT_MESSAGE: "escalateIntentsAgentAssistInitMessage",
+    ESCALATE_INTENTS_ALLOW_AGENT_INJECT: "escalateIntentsAllowAgentInject",
+    ESCALATE_ANSWERS_HANDOVER_LIVE_AGENT_INBOX_ID: "escalateAnswersHandoverLiveAgentInboxId",
+    ESCALATE_ANSWERS_ALLOW_AGENT_INJECT: "escalateAnswersAllowAgentInject",
+    ESCALATE_ANSWERS_AGENT_ASSIST_INIT_MESSAGE: "escalateAnswersAgentAssistInitMessage",
+    LIVE_AGENT_INBOX_ID: "liveAgentInboxId",
+    LIVE_AGENT_SKILLS: "liveAgentSkills",
+    LIVE_AGENT_LANGUAGES: "liveAgentLanguages",
+    LIVE_AGENT_PRIORITY: "liveAgentPriority",
+    AGENT_ASSIST_INIT_MESSAGE: "agentAssistInitMessage",
+    ALLOW_AGENT_INJECT: "allowAgentInject",
+};
+exports.IP_NOT_AVAILABLE = "not available";
 //# sourceMappingURL=constants.js.map

package/build/shared/errors/ErrorCode.js

@@ -7,6 +7,7 @@ var ErrorCode;
     ErrorCode[ErrorCode["UNAUTHORIZED_ERROR"] = 401] = "UNAUTHORIZED_ERROR";
     ErrorCode[ErrorCode["PAYMENT_REQUIRED_ERROR"] = 402] = "PAYMENT_REQUIRED_ERROR";
     ErrorCode[ErrorCode["PAYLOAD_TOO_LARGE_ERROR"] = 413] = "PAYLOAD_TOO_LARGE_ERROR";
+    ErrorCode[ErrorCode["TOO_MANY_REQUESTS_ERROR"] = 429] = "TOO_MANY_REQUESTS_ERROR";
     ErrorCode[ErrorCode["FORBIDDEN_ERROR"] = 403] = "FORBIDDEN_ERROR";
     ErrorCode[ErrorCode["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
     ErrorCode[ErrorCode["SERVICE_UNAVAILABLE_ERROR"] = 503] = "SERVICE_UNAVAILABLE_ERROR";

package/build/shared/errors/TooManyRequestsError.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TooManyRequestsError = void 0;
+/* Custom modules */
+const baseError_1 = require("./baseError");
+const codes_1 = require("./codes");
+const HttpStatusCode_1 = require("../helper/HttpStatusCode");
+/**
+ * @openapi
+ * components:
+ *   responses:
+ *     TooManyRequestsError:
+ *       description: The server got too many requests than it is required to handle.
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               type:
+ *                 type: string
+ *                 example: TooManyRequestsError
+ *               title:
+ *                 type: string
+ *                 example: Too Many Requests Error
+ *               status:
+ *                 type: number
+ *                 example: 429
+ *               detail:
+ *                 type: string
+ *               instance:
+ *                 type: string
+ *                 example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432
+ *               code:
+ *                 type: string
+ *                 example: 1000
+ *               traceId:
+ *                 type: string
+ *                 example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f
+ *               details:
+ *                 type: object
+ *                 example: {}
+ */
+class TooManyRequestsError extends baseError_1.BaseError {
+    constructor(message, stack, meta, details, logLevel) {
+        super({
+            name: "Too Many Requests Error",
+            message,
+            code: codes_1.TOO_MANY_REQUESTS_ERROR,
+            httpStatusCode: HttpStatusCode_1.HttpStatusCode.TOO_MANY_REQUESTS,
+            httpStatusText: "Too Many Requests Error",
+            meta,
+            stack,
+            details,
+            logLevel,
+        });
+    }
+}
+exports.TooManyRequestsError = TooManyRequestsError;
+//# sourceMappingURL=TooManyRequestsError.js.map

package/build/shared/errors/baseError.js

@@ -41,10 +41,14 @@ class BaseError extends Error {
         }
         if (tracer) {
             if (this.logLevel === "error" || this.logLevel === "fatal") {
+                const { projectId, organisationId, organisation, groupingKey, organisationName, projectName, } = this.meta;
                 tracer.captureException(this, {
                     traceId: (_a = this.loggerstack) === null || _a === void 0 ? void 0 : _a.traceId,
-                    organisationId: (meta === null || meta === void 0 ? void 0 : meta.organisationId) || (meta === null || meta === void 0 ? void 0 : meta.organisation),
-                    projectId: meta === null || meta === void 0 ? void 0 : meta.projectId,
+                    organisationId: organisationId || organisation,
+                    projectId,
+                    groupingKey,
+                    organisationName,
+                    projectName,
                 });
             }
         }

package/build/shared/errors/codes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GATEWAY_TIMEOUT_ERROR = exports.BAD_GATEWAY_ERROR = exports.FORBIDDEN_ERROR = exports.PAYLOAD_TOO_LARGE_ERROR = exports.UNAUTHORIZED_ERROR = exports.TIMEOUT_ERROR = exports.INPUT_OUTPUT_ERROR = exports.DATABASE_QUERY_ERROR = exports.DATABASE_CONNECT_ERROR = exports.SMTP_CONNECT_ERROR = exports.METHOD_NOT_ALLOWED_ERROR = exports.FILE_WRITE_ERROR = exports.FILE_READ_ERROR = exports.PROCESS_ERROR = exports.NOT_IMPLEMENTED_ERROR = exports.INTERNAL_SERVER_ERROR = exports.EXPORT_ERROR = exports.IMPORT_ERROR = exports.INVALID_ARGUMENT_ERROR = exports.CONFLICT_ERROR = exports.DATABASE_READ_ERROR = exports.RESOURCE_NOT_FOUND_ERROR = exports.DATABASE_WRITE_ERROR = exports.MISSING_ARGUMENT_ERROR = void 0;
+exports.TOO_MANY_REQUESTS_ERROR = exports.GATEWAY_TIMEOUT_ERROR = exports.BAD_GATEWAY_ERROR = exports.FORBIDDEN_ERROR = exports.PAYLOAD_TOO_LARGE_ERROR = exports.UNAUTHORIZED_ERROR = exports.TIMEOUT_ERROR = exports.INPUT_OUTPUT_ERROR = exports.DATABASE_QUERY_ERROR = exports.DATABASE_CONNECT_ERROR = exports.SMTP_CONNECT_ERROR = exports.METHOD_NOT_ALLOWED_ERROR = exports.FILE_WRITE_ERROR = exports.FILE_READ_ERROR = exports.PROCESS_ERROR = exports.NOT_IMPLEMENTED_ERROR = exports.INTERNAL_SERVER_ERROR = exports.EXPORT_ERROR = exports.IMPORT_ERROR = exports.INVALID_ARGUMENT_ERROR = exports.CONFLICT_ERROR = exports.DATABASE_READ_ERROR = exports.RESOURCE_NOT_FOUND_ERROR = exports.DATABASE_WRITE_ERROR = exports.MISSING_ARGUMENT_ERROR = void 0;
 const ErrorCode_1 = require("./ErrorCode");
 exports.MISSING_ARGUMENT_ERROR = ErrorCode_1.ErrorCode.MISSING_ARGUMENT_ERROR;
 exports.DATABASE_WRITE_ERROR = ErrorCode_1.ErrorCode.DATABASE_WRITE_ERROR;
@@ -26,4 +26,5 @@ exports.PAYLOAD_TOO_LARGE_ERROR = ErrorCode_1.ErrorCode.PAYLOAD_TOO_LARGE_ERROR;
 exports.FORBIDDEN_ERROR = ErrorCode_1.ErrorCode.FORBIDDEN_ERROR;
 exports.BAD_GATEWAY_ERROR = ErrorCode_1.ErrorCode.BAD_GATEWAY;
 exports.GATEWAY_TIMEOUT_ERROR = ErrorCode_1.ErrorCode.GATEWAY_TIMEOUT_ERROR;
+exports.TOO_MANY_REQUESTS_ERROR = ErrorCode_1.ErrorCode.TOO_MANY_REQUESTS_ERROR;
 //# sourceMappingURL=codes.js.map

package/build/shared/errors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorCode = exports.ErrorCollection = exports.UnauthorizedError = exports.TimeoutError = exports.SMTPConnectError = exports.ResourceNotFoundError = exports.ProcessError = exports.PaymentRequiredError = exports.PayloadTooLargeError = exports.NotImplementedError = exports.NetworkError = exports.MissingArgumentError = exports.MethodNotAllowedError = exports.InvalidArgumentError = exports.InternalServerError = exports.InputOutputError = exports.ImportError = exports.GatewayTimeoutError = exports.ForbiddenError = exports.FileWriteError = exports.FileReadError = exports.ExportError = exports.DatabaseWriteError = exports.DatabaseReadError = exports.DatabaseQueryError = exports.DatabaseConnectError = exports.ConflictError = exports.BadRequestError = exports.BadGatewayError = exports.BaseError = void 0;
+exports.ErrorCode = exports.ErrorCollection = exports.UnauthorizedError = exports.TooManyRequestsError = exports.TimeoutError = exports.SMTPConnectError = exports.ResourceNotFoundError = exports.ProcessError = exports.PaymentRequiredError = exports.PayloadTooLargeError = exports.NotImplementedError = exports.NetworkError = exports.MissingArgumentError = exports.MethodNotAllowedError = exports.InvalidArgumentError = exports.InternalServerError = exports.InputOutputError = exports.ImportError = exports.GatewayTimeoutError = exports.ForbiddenError = exports.FileWriteError = exports.FileReadError = exports.ExportError = exports.DatabaseWriteError = exports.DatabaseReadError = exports.DatabaseQueryError = exports.DatabaseConnectError = exports.ConflictError = exports.BadRequestError = exports.BadGatewayError = exports.BaseError = void 0;
 var baseError_1 = require("./baseError");
 Object.defineProperty(exports, "BaseError", { enumerable: true, get: function () { return baseError_1.BaseError; } });
 var BadGatewayError_1 = require("./BadGatewayError");
@@ -55,6 +55,8 @@ var smtpConnectError_1 = require("./smtpConnectError");
 Object.defineProperty(exports, "SMTPConnectError", { enumerable: true, get: function () { return smtpConnectError_1.SMTPConnectError; } });
 var timeoutError_1 = require("./timeoutError");
 Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function () { return timeoutError_1.TimeoutError; } });
+var TooManyRequestsError_1 = require("./TooManyRequestsError");
+Object.defineProperty(exports, "TooManyRequestsError", { enumerable: true, get: function () { return TooManyRequestsError_1.TooManyRequestsError; } });
 var UnauthorizedError_1 = require("./UnauthorizedError");
 Object.defineProperty(exports, "UnauthorizedError", { enumerable: true, get: function () { return UnauthorizedError_1.UnauthorizedError; } });
 var ErrorCollection_1 = require("./ErrorCollection");

package/build/shared/handoverClients/interfaces/THandoverEventType.js

@@ -7,6 +7,8 @@ exports.handoverEventTypes = [
     "conversationFailed",
     "agentTypingOn",
     "agentTypingOff",
-    "unknown"
+    "queueUpdate",
+    "RCEImplementationInfo",
+    "unknown",
 ];
 //# sourceMappingURL=THandoverEventType.js.map

package/build/shared/helper/BaseContext.js

@@ -19,6 +19,12 @@ class BaseContext {
      * @memberOf Context
      */
     constructor(options = {}, traceId) {
+        /**
+         * We need to ignore proxy object trap handlers to keep context object reference immutable.
+         * This flag is used to ignore unwanted invocation of proxy settes/getters/deleters/etc. when context is reset
+         * and new fields are added to the context object by cleaning/emptying up of old context fields.
+         */
+        this.ignoreTrapHandler = false;
         const { injectSystemDefault, organisationId } = options;
         this.traceId = traceId;
         // we validate set context with a proxy, not for the default context
@@ -28,6 +34,10 @@ class BaseContext {
     createProxy(initial = {}) {
         return new Proxy(initial, {
             set: (obj, prop, value) => {
+                if (this.ignoreTrapHandler) {
+                    obj[prop] = value;
+                    return true;
+                }
                 // check if maximum context size is not reached
                 const merged = Object.assign(obj, { [prop]: value });
                 const validObjectSize = (0, objectSizeValidator_1.validateObjectSize)(merged, (process.env.MAX_MEMORY_OBJECT_SIZE && parseInt(process.env.MAX_MEMORY_OBJECT_SIZE)) || 64000);
@@ -62,14 +72,44 @@ class BaseContext {
      */
     importContext(data, traceId, replace) {
         if (replace) {
+            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,
+                });
+            }
             // 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));
-            if (deepCopy)
-                // we validate setting context with a proxy, if not injectSystemDefault
-                this.context = this.createProxy(deepCopy);
+            if (deepCopy) {
+                try {
+                    this.ignoreTrapHandler = true;
+                    for (var variableKey in this.context) {
+                        if (this.context.hasOwnProperty(variableKey)) {
+                            delete this.context[variableKey];
+                        }
+                    }
+                    // we validate setting context with a proxy, if not injectSystemDefault
+                    const sourceContext = this.createProxy(deepCopy);
+                    /**
+                     * Object.assign(@target, @source) function copies the values of all of the enumerable own properties from the source object
+                     * to a target object and returns the target object.
+                     * Below code will preserve the `this.context` (as target object) reference after copying props from deep copy data object.
+                     */
+                    this.context = Object.assign(this.context, sourceContext);
+                }
+                finally {
+                    this.ignoreTrapHandler = false;
+                }
+            }
         }
         else {
+            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,
+                });
+            }
             for (let c in data) {
                 this.setContext(c, data[c], traceId);
             }