@onereach/step-voice 7.0.21 → 7.0.22-deskphones.0

package/dst/Initiate Call.d.ts

@@ -29,6 +29,7 @@ interface INPUT {
         name: string;
         value: string;
     }>;
+    uui?: unknown;
     enableSpoofCallerId?: boolean;
     spoofCallerId?: string;
     isAMD?: boolean;

package/dst/Initiate Call.js

@@ -7,6 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const voice_1 = tslib_1.__importDefault(require("./voice"));
+const uui_1 = require("./uui");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const timestring_1 = tslib_1.__importDefault(require("timestring"));
 const uuid = tslib_1.__importStar(require("uuid"));
@@ -47,7 +48,7 @@ class InitiateCall extends voice_1.default {
         this.exitStep('cancel');
     }
     async waitForCall() {
-        const { asr, tts, from: botNumber, endUserNumber, gatewaySettingsMode, sipHost, sipUser, sipPassword, sipProfile, timeout, headers, enableSpoofCallerId, spoofCallerId, isAMD, otherCallRef, otherCallRefThread, handleCancel, } = this.data;
+        const { asr, tts, from: botNumber, endUserNumber, gatewaySettingsMode, sipHost, sipUser, sipPassword, sipProfile, timeout, headers, uui, enableSpoofCallerId, spoofCallerId, isAMD, otherCallRef, otherCallRefThread, handleCancel, } = this.data;
         const call = await this.fetchData();
         this.triggers.once(`in/voice/${call.id}/event`, async (event) => {
             switch (event.params.type) {
@@ -69,6 +70,7 @@ class InitiateCall extends voice_1.default {
                     const newCall = {
                         headers: event.params.headers,
                         ...event.params.channel,
+                        uui: (0, uui_1.decodeUui)(event.params.headers),
                         asr: asr.getSettings(),
                         tts: tts.getVoice(),
                         botNumber: event.params.channel.to ?? 'unknown',
@@ -157,10 +159,19 @@ class InitiateCall extends voice_1.default {
         this.triggers.otherwise(async () => {
             await this.triggers.flush();
             const originateTimeout = (0, timestring_1.default)(`${timeout ?? 30} sec`, 'ms'); // timeout or 30 seconds
-            const customHeaders = lodash_1.default.reduce(headers, (memo, header) => {
+            const customHeaders = (0, uui_1.headersWithoutUui)(lodash_1.default.reduce(headers, (memo, header) => {
                 memo[header.name] = `${header.value}`;
                 return memo;
-            }, {});
+            }, {}));
+            try {
+                (0, uui_1.assertUuiFits)(uui);
+                const encoded = (0, uui_1.encodeUui)(uui);
+                if (encoded != null)
+                    customHeaders['User-to-User'] = encoded;
+            }
+            catch (error) {
+                this.throwError(error);
+            }
             // GET SIP PROFILE SETTINGS
             let gateway;
             const profile = sipProfile !== "default" /* SIP_PROFILE.DEFAULT */ ? sipProfile : undefined;

package/dst/Wait For Call.js

@@ -7,6 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const voice_1 = tslib_1.__importDefault(require("./voice"));
+const uui_1 = require("./uui");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const defaultSessionTimeout = 5 * 60 * 1000;
 class WaitForCall extends voice_1.default {
@@ -30,6 +31,7 @@ class WaitForCall extends voice_1.default {
             // @ts-expect-error
             endUserNumber: event.params.channel?.from ?? 'unknown',
             ...event.params.channel,
+            uui: (0, uui_1.decodeUui)(event.params.headers),
             asr: asr.getSettings(),
             tts: tts.getVoice()
         };

package/dst/uui.d.ts

@@ -0,0 +1,5 @@
+export declare function encodeUui(uui: unknown): string | undefined;
+export declare function encodedUuiLength(uui: unknown): number;
+export declare function assertUuiFits(uui: unknown): void;
+export declare function decodeUui(headers?: Record<string, string>): Record<string, unknown>;
+export declare function headersWithoutUui(headers?: Record<string, string>): Record<string, string>;

package/dst/uui.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.headersWithoutUui = exports.decodeUui = exports.assertUuiFits = exports.encodedUuiLength = exports.encodeUui = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+function uuiTypeName(uui) {
+    if (Array.isArray(uui))
+        return 'array';
+    if (uui === null)
+        return 'null';
+    return typeof uui;
+}
+function encodeUui(uui) {
+    if (uui === undefined || uui === null)
+        return undefined;
+    if (typeof uui === 'string')
+        return uui === '' ? undefined : uui;
+    if (Array.isArray(uui) || typeof uui === 'number' || typeof uui === 'boolean') {
+        throw new Error(`uui must be an object or a string, got ${uuiTypeName(uui)}`);
+    }
+    if (lodash_1.default.isPlainObject(uui)) {
+        if (lodash_1.default.isEmpty(uui))
+            return undefined;
+        const json = JSON.stringify(uui);
+        if (json === '{}')
+            return undefined;
+        const payload = Buffer.from(json, 'utf8').toString('base64');
+        return `${payload};encoding=base64`;
+    }
+    throw new Error(`uui must be an object or a string, got ${uuiTypeName(uui)}`);
+}
+exports.encodeUui = encodeUui;
+function encodedUuiLength(uui) {
+    const encoded = encodeUui(uui);
+    return encoded == null ? 0 : encoded.length;
+}
+exports.encodedUuiLength = encodedUuiLength;
+function assertUuiFits(uui) {
+    const length = encodedUuiLength(uui);
+    if (length > 256) {
+        throw new Error(`User-to-User final header value exceeds 256 characters (${length}). The cap is the final header value (object path includes ;encoding=base64).`);
+    }
+}
+exports.assertUuiFits = assertUuiFits;
+function headerValue(headers, name) {
+    if (headers == null)
+        return undefined;
+    const found = Object.keys(headers).find(key => key.toLowerCase() === name.toLowerCase());
+    if (found == null)
+        return undefined;
+    const value = headers[found];
+    if (typeof value !== 'string' || value === '')
+        return undefined;
+    return value;
+}
+function parseEncoding(header) {
+    const parts = header.split(';').map(part => part.trim());
+    const payload = parts[0] ?? '';
+    let encoding;
+    for (const part of parts.slice(1)) {
+        const eq = part.indexOf('=');
+        if (eq === -1)
+            continue;
+        const key = part.slice(0, eq).trim().toLowerCase();
+        const val = part.slice(eq + 1).trim();
+        if (key === 'encoding')
+            encoding = val;
+    }
+    return { payload, encoding };
+}
+function asJsonObjectOrRaw(text) {
+    try {
+        const parsed = JSON.parse(text);
+        if (lodash_1.default.isPlainObject(parsed))
+            return parsed;
+    }
+    catch { }
+    return { raw: text };
+}
+function decodeUui(headers) {
+    const header = headerValue(headers, 'User-to-User') ?? headerValue(headers, 'X-User-to-User');
+    if (header == null)
+        return {};
+    const { payload, encoding } = parseEncoding(header);
+    if (encoding != null && encoding.toLowerCase() !== 'base64') {
+        return { raw: header };
+    }
+    const utf8 = Buffer.from(payload, 'base64').toString('utf8');
+    return asJsonObjectOrRaw(utf8);
+}
+exports.decodeUui = decodeUui;
+function headersWithoutUui(headers) {
+    const next = {};
+    for (const [key, value] of Object.entries(headers ?? {})) {
+        const lower = key.toLowerCase();
+        if (lower === 'user-to-user' || lower === 'x-user-to-user')
+            continue;
+        next[key] = value;
+    }
+    return next;
+}
+exports.headersWithoutUui = headersWithoutUui;

package/dst/voice.d.ts

@@ -28,6 +28,7 @@ export interface IVoiceCall extends IConversationData {
     to?: string;
     from?: string;
     headers?: Record<string, string>;
+    uui?: Record<string, unknown>;
     conference?: {
         room: string;
         user: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "7.0.21",
+  "version": "7.0.22-deskphones.0",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",