@aws-amplify/interactions 5.2.12-unstable.7762f1a.0 → 6.0.0

package/lib/lex-v2/AWSLexV2Provider.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lexProvider = void 0;
+const client_lex_runtime_v2_1 = require("@aws-sdk/client-lex-runtime-v2");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const core_1 = require("@aws-amplify/core");
+const utils_2 = require("../utils");
+const uuid_1 = require("uuid");
+const logger = new core_1.ConsoleLogger('AWSLexV2Provider');
+class AWSLexV2Provider {
+    constructor() {
+        this._botsCompleteCallback = {};
+        this.defaultSessionId = (0, uuid_1.v4)();
+    }
+    /**
+     * Send a message to a bot
+     * @async
+     * @param {AWSLexV2ProviderOption} botConfig - Bot configuration for sending the message
+     * @param {string | InteractionsMessage} message - message to send to the bot
+     * @return {Promise<InteractionsResponse>} A promise resolves to the response from the bot
+     */
+    async sendMessage(botConfig, message) {
+        // check if credentials are present
+        let session;
+        try {
+            session = await (0, core_1.fetchAuthSession)();
+        }
+        catch (error) {
+            return Promise.reject('No credentials');
+        }
+        const { region, aliasId, localeId, botId } = botConfig;
+        const client = new client_lex_runtime_v2_1.LexRuntimeV2Client({
+            region,
+            credentials: session.credentials,
+            customUserAgent: (0, utils_1.getAmplifyUserAgentObject)(),
+        });
+        let response;
+        // common base params for all requests
+        const reqBaseParams = {
+            botAliasId: aliasId,
+            botId,
+            localeId,
+            sessionId: session.identityId ?? this.defaultSessionId,
+        };
+        if (typeof message === 'string') {
+            response = await this._handleRecognizeTextCommand(botConfig, message, reqBaseParams, client);
+        }
+        else {
+            response = await this._handleRecognizeUtteranceCommand(botConfig, message, reqBaseParams, client);
+        }
+        return response;
+    }
+    /**
+     * Attach a onComplete callback function to a bot.
+     * The callback is called once the bot's intent is fulfilled
+     * @param {AWSLexV2ProviderOption} botConfig - Bot configuration to attach the onComplete callback
+     * @param {InteractionsOnCompleteCallback} callback - called when Intent Fulfilled
+     */
+    onComplete({ name }, callback) {
+        this._botsCompleteCallback[name] = callback;
+    }
+    /**
+     * call onComplete callback for a bot if configured
+     */
+    _reportBotStatus(data, { name }) {
+        const sessionState = data?.sessionState;
+        // Check if state is fulfilled to resolve onFullfilment promise
+        logger.debug('postContent state', sessionState?.intent?.state);
+        const callback = this._botsCompleteCallback[name];
+        if (!callback) {
+            return;
+        }
+        switch (sessionState?.intent?.state) {
+            case client_lex_runtime_v2_1.IntentState.READY_FOR_FULFILLMENT:
+            case client_lex_runtime_v2_1.IntentState.FULFILLED:
+                callback(undefined, data);
+                break;
+            case client_lex_runtime_v2_1.IntentState.FAILED:
+                callback(new Error('Bot conversation failed'));
+                break;
+            default:
+                break;
+        }
+    }
+    /**
+     * Format UtteranceCommandOutput's response
+     * decompress attributes
+     * update audioStream format
+     */
+    async _formatUtteranceCommandOutput(data) {
+        return {
+            ...data,
+            messages: await (0, utils_2.unGzipBase64AsJson)(data.messages),
+            sessionState: await (0, utils_2.unGzipBase64AsJson)(data.sessionState),
+            interpretations: await (0, utils_2.unGzipBase64AsJson)(data.interpretations),
+            requestAttributes: await (0, utils_2.unGzipBase64AsJson)(data.requestAttributes),
+            inputTranscript: await (0, utils_2.unGzipBase64AsJson)(data.inputTranscript),
+            audioStream: data.audioStream
+                ? await (0, utils_2.convert)(data.audioStream)
+                : undefined,
+        };
+    }
+    /**
+     * handle client's `RecognizeTextCommand`
+     * used for sending simple text message
+     */
+    async _handleRecognizeTextCommand(botConfig, data, baseParams, client) {
+        logger.debug('postText to lex2', data);
+        const params = {
+            ...baseParams,
+            text: data,
+        };
+        try {
+            const recognizeTextCommand = new client_lex_runtime_v2_1.RecognizeTextCommand(params);
+            const data = await client.send(recognizeTextCommand);
+            this._reportBotStatus(data, botConfig);
+            return data;
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
+    }
+    /**
+     * handle client's `RecognizeUtteranceCommand`
+     * used for obj text or obj voice message
+     */
+    async _handleRecognizeUtteranceCommand(botConfig, data, baseParams, client) {
+        const { content, options: { messageType }, } = data;
+        logger.debug('postContent to lex2', data);
+        let params;
+        // prepare params
+        if (messageType === 'voice') {
+            if (typeof content !== 'object') {
+                return Promise.reject('invalid content type');
+            }
+            const inputStream = content instanceof Uint8Array ? content : await (0, utils_2.convert)(content);
+            params = {
+                ...baseParams,
+                requestContentType: 'audio/x-l16; sample-rate=16000; channel-count=1',
+                inputStream,
+            };
+        }
+        else {
+            // text input
+            if (typeof content !== 'string')
+                return Promise.reject('invalid content type');
+            params = {
+                ...baseParams,
+                requestContentType: 'text/plain; charset=utf-8',
+                inputStream: content,
+            };
+        }
+        // make API call to lex
+        try {
+            const recognizeUtteranceCommand = new client_lex_runtime_v2_1.RecognizeUtteranceCommand(params);
+            const data = await client.send(recognizeUtteranceCommand);
+            const response = await this._formatUtteranceCommandOutput(data);
+            this._reportBotStatus(response, botConfig);
+            return response;
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
+    }
+}
+exports.lexProvider = new AWSLexV2Provider();

package/lib/lex-v2/apis/index.d.ts

@@ -0,0 +1,2 @@
+export { send } from './send';
+export { onComplete } from './onComplete';

package/lib/lex-v2/apis/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onComplete = exports.send = void 0;
+var send_1 = require("./send");
+Object.defineProperty(exports, "send", { enumerable: true, get: function () { return send_1.send; } });
+var onComplete_1 = require("./onComplete");
+Object.defineProperty(exports, "onComplete", { enumerable: true, get: function () { return onComplete_1.onComplete; } });

package/lib/lex-v2/apis/onComplete.d.ts

@@ -0,0 +1,2 @@
+import { OnCompleteInput } from '../types';
+export declare const onComplete: (input: OnCompleteInput) => void;

package/lib/lex-v2/apis/onComplete.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onComplete = void 0;
+const utils_1 = require("../utils");
+const AWSLexV2Provider_1 = require("../AWSLexV2Provider");
+const errors_1 = require("../../errors");
+const onComplete = (input) => {
+    const { botName, callback } = input;
+    const botConfig = (0, utils_1.resolveBotConfig)(botName);
+    (0, errors_1.assertValidationError)(!!botConfig, errors_1.InteractionsValidationErrorCode.NoBotConfig, `Bot ${botName} does not exist.`);
+    AWSLexV2Provider_1.lexProvider.onComplete(botConfig, callback);
+};
+exports.onComplete = onComplete;

package/lib/lex-v2/apis/send.d.ts

@@ -0,0 +1,2 @@
+import { SendInput, SendOutput } from '../types';
+export declare const send: (input: SendInput) => Promise<SendOutput>;

package/lib/lex-v2/apis/send.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.send = void 0;
+const AWSLexV2Provider_1 = require("../AWSLexV2Provider");
+const utils_1 = require("../utils");
+const errors_1 = require("../../errors");
+const send = async (input) => {
+    const { botName, message } = input;
+    const botConfig = (0, utils_1.resolveBotConfig)(botName);
+    (0, errors_1.assertValidationError)(!!botConfig, errors_1.InteractionsValidationErrorCode.NoBotConfig, `Bot ${botName} does not exist.`);
+    return AWSLexV2Provider_1.lexProvider.sendMessage(botConfig, message);
+};
+exports.send = send;

package/lib/lex-v2/index.d.ts

@@ -0,0 +1,3 @@
+import { IInteractions } from './types/AWSLexV2ProviderOption';
+export declare const Interactions: IInteractions;
+export { SendInput, OnCompleteInput, SendOutput } from './types';

package/lib/lex-v2/index.js

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Interactions = void 0;
+const apis_1 = require("./apis");
+exports.Interactions = {
+    send: apis_1.send,
+    onComplete: apis_1.onComplete,
+};

package/lib/lex-v2/types/AWSLexV2ProviderOption.d.ts

@@ -0,0 +1,13 @@
+import { SendInput, OnCompleteInput } from './inputs';
+import { SendOutput } from './outputs';
+export interface AWSLexV2ProviderOption {
+    name: string;
+    botId: string;
+    aliasId: string;
+    localeId: string;
+    region: string;
+}
+export interface IInteractions {
+    send(input: SendInput): Promise<SendOutput>;
+    onComplete(input: OnCompleteInput): void;
+}

package/lib/lex-v2/types/AWSLexV2ProviderOption.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/lex-v2/types/index.d.ts

@@ -0,0 +1,3 @@
+export { AWSLexV2ProviderOption } from './AWSLexV2ProviderOption';
+export { SendInput, OnCompleteInput } from './inputs';
+export { SendOutput } from './outputs';

package/lib/lex-v2/types/index.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/lex-v2/types/inputs.d.ts

@@ -0,0 +1,9 @@
+import { InteractionsSendInput, InteractionsOnCompleteInput } from '../../types';
+/**
+ * Input type for LexV2 send API.
+ */
+export type SendInput = InteractionsSendInput;
+/**
+ * Input type for LexV2 onComplete API.
+ */
+export type OnCompleteInput = InteractionsOnCompleteInput;

package/lib/lex-v2/types/inputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/lex-v2/types/outputs.d.ts

@@ -0,0 +1,5 @@
+import { InteractionsSendOutput } from '../../types';
+/**
+ * Output type for LexV2 send API.
+ */
+export type SendOutput = InteractionsSendOutput;

package/lib/lex-v2/types/outputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/lex-v2/utils/index.d.ts

@@ -0,0 +1 @@
+export { resolveBotConfig } from './resolveBotConfig';

package/lib/lex-v2/utils/index.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveBotConfig = void 0;
+var resolveBotConfig_1 = require("./resolveBotConfig");
+Object.defineProperty(exports, "resolveBotConfig", { enumerable: true, get: function () { return resolveBotConfig_1.resolveBotConfig; } });

package/lib/lex-v2/utils/resolveBotConfig.d.ts

@@ -0,0 +1,2 @@
+import { AWSLexV2ProviderOption } from '../types';
+export declare const resolveBotConfig: (botName: string) => AWSLexV2ProviderOption | undefined;

package/lib/lex-v2/utils/resolveBotConfig.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveBotConfig = void 0;
+const core_1 = require("@aws-amplify/core");
+const resolveBotConfig = (botName) => {
+    const { [botName]: botConfig = undefined } = core_1.Amplify.getConfig().Interactions?.LexV2 ?? {};
+    if (botConfig !== undefined) {
+        return { ...botConfig, name: botName };
+    }
+};
+exports.resolveBotConfig = resolveBotConfig;