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

package/README.md

@@ -0,0 +1,3 @@
+> INTERNAL USE ONLY
+
+This package contains the AWS Amplify Interactions category and is intended for internal use only. To integrate Amplify into your app, please use [aws-amplify](https://www.npmjs.com/package/aws-amplify).

package/lex-v1/package.json

@@ -0,0 +1,7 @@
+{
+	"name": "@aws-amplify/interactions/lex-v1",
+	"main": "../lib/lex-v1/index.js",
+	"browser": "../lib-esm/lex-v1/index.js",
+	"module": "../lib-esm/lex-v1/index.js",
+	"typings": "../lib-esm/lex-v1/index.d.ts"
+}

package/lex-v2/package.json

@@ -0,0 +1,7 @@
+{
+	"name": "@aws-amplify/interactions/lex-v2",
+	"main": "../lib/lex-v2/index.js",
+	"browser": "../lib-esm/lex-v2/index.js",
+	"module": "../lib-esm/lex-v2/index.js",
+	"typings": "../lib-esm/lex-v2/index.d.ts"
+}

package/lib/errors/InteractionsError.d.ts

@@ -0,0 +1,4 @@
+import { AmplifyError, AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+export declare class InteractionsError extends AmplifyError {
+    constructor(params: AmplifyErrorParams);
+}

package/lib/errors/InteractionsError.js

@@ -0,0 +1,16 @@
+"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.InteractionsError = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+class InteractionsError extends utils_1.AmplifyError {
+    constructor(params) {
+        super(params);
+        // Hack for making the custom error class work when transpiled to es5
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        this.constructor = InteractionsError;
+        Object.setPrototypeOf(this, InteractionsError.prototype);
+    }
+}
+exports.InteractionsError = InteractionsError;

package/lib/errors/assertValidationError.d.ts

@@ -0,0 +1,2 @@
+import { InteractionsValidationErrorCode } from './validation';
+export declare function assertValidationError(assertion: boolean, name: InteractionsValidationErrorCode, message?: string): asserts assertion;

package/lib/errors/assertValidationError.js

@@ -0,0 +1,18 @@
+"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.assertValidationError = void 0;
+const validation_1 = require("./validation");
+const InteractionsError_1 = require("./InteractionsError");
+function assertValidationError(assertion, name, message) {
+    if (!assertion) {
+        const { message: defaultMessage, recoverySuggestion } = validation_1.validationErrorMap[name];
+        throw new InteractionsError_1.InteractionsError({
+            name,
+            message: message ?? defaultMessage,
+            recoverySuggestion,
+        });
+    }
+}
+exports.assertValidationError = assertValidationError;

package/lib/errors/index.d.ts

@@ -0,0 +1,2 @@
+export { assertValidationError } from './assertValidationError';
+export { InteractionsValidationErrorCode } from './validation';

package/lib/errors/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.InteractionsValidationErrorCode = exports.assertValidationError = void 0;
+var assertValidationError_1 = require("./assertValidationError");
+Object.defineProperty(exports, "assertValidationError", { enumerable: true, get: function () { return assertValidationError_1.assertValidationError; } });
+var validation_1 = require("./validation");
+Object.defineProperty(exports, "InteractionsValidationErrorCode", { enumerable: true, get: function () { return validation_1.InteractionsValidationErrorCode; } });

package/lib/errors/validation.d.ts

@@ -0,0 +1,5 @@
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+export declare enum InteractionsValidationErrorCode {
+    NoBotConfig = "NoBotConfig"
+}
+export declare const validationErrorMap: AmplifyErrorMap<InteractionsValidationErrorCode>;

package/lib/errors/validation.js

@@ -0,0 +1,14 @@
+"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.validationErrorMap = exports.InteractionsValidationErrorCode = void 0;
+var InteractionsValidationErrorCode;
+(function (InteractionsValidationErrorCode) {
+    InteractionsValidationErrorCode["NoBotConfig"] = "NoBotConfig";
+})(InteractionsValidationErrorCode || (exports.InteractionsValidationErrorCode = InteractionsValidationErrorCode = {}));
+exports.validationErrorMap = {
+    [InteractionsValidationErrorCode.NoBotConfig]: {
+        message: 'Missing configuration for the bot',
+    },
+};

package/lib/index.d.ts

@@ -1,5 +1,2 @@
-export { Interactions } from './Interactions';
-export * from './types';
-export { AbstractInteractionsProvider } from './Providers/InteractionsProvider';
-export { AWSLexProvider } from './Providers/AWSLexProvider';
-export { AWSLexV2Provider } from './Providers/AWSLexV2Provider';
+export { Interactions } from './lex-v2';
+export { SendInput, OnCompleteInput, SendOutput } from './lex-v2/types';

package/lib/index.js

@@ -2,12 +2,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var Interactions_1 = require("./Interactions");
-exports.Interactions = Interactions_1.Interactions;
-var InteractionsProvider_1 = require("./Providers/InteractionsProvider");
-exports.AbstractInteractionsProvider = InteractionsProvider_1.AbstractInteractionsProvider;
-var AWSLexProvider_1 = require("./Providers/AWSLexProvider");
-exports.AWSLexProvider = AWSLexProvider_1.AWSLexProvider;
-var AWSLexV2Provider_1 = require("./Providers/AWSLexV2Provider");
-exports.AWSLexV2Provider = AWSLexV2Provider_1.AWSLexV2Provider;
-//# sourceMappingURL=index.js.map
+exports.Interactions = void 0;
+var lex_v2_1 = require("./lex-v2");
+Object.defineProperty(exports, "Interactions", { enumerable: true, get: function () { return lex_v2_1.Interactions; } });

package/lib/lex-v1/AWSLexProvider.d.ts

@@ -0,0 +1,20 @@
+import { InteractionsOnCompleteCallback, InteractionsMessage, InteractionsResponse } from '../types/Interactions';
+import { PostContentCommandOutput, PostTextCommandOutput } from '@aws-sdk/client-lex-runtime-service';
+import { AWSLexProviderOption } from './types';
+interface PostContentCommandOutputFormatted extends Omit<PostContentCommandOutput, 'audioStream'> {
+    audioStream?: Uint8Array;
+}
+type AWSLexProviderSendResponse = PostTextCommandOutput | PostContentCommandOutputFormatted;
+declare class AWSLexProvider {
+    private readonly _botsCompleteCallback;
+    /**
+     * @deprecated
+     * This is used internally by 'sendMessage' to call onComplete callback
+     * for a bot if configured
+     */
+    reportBotStatus(data: AWSLexProviderSendResponse, { name }: AWSLexProviderOption): void;
+    sendMessage(botConfig: AWSLexProviderOption, message: string | InteractionsMessage): Promise<InteractionsResponse>;
+    onComplete({ name }: AWSLexProviderOption, callback: InteractionsOnCompleteCallback): void;
+}
+export declare const lexProvider: AWSLexProvider;
+export {};

package/lib/lex-v1/AWSLexProvider.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lexProvider = void 0;
+const client_lex_runtime_service_1 = require("@aws-sdk/client-lex-runtime-service");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const core_1 = require("@aws-amplify/core");
+const utils_2 = require("../utils");
+const logger = new core_1.ConsoleLogger('AWSLexProvider');
+class AWSLexProvider {
+    constructor() {
+        this._botsCompleteCallback = {};
+    }
+    /**
+     * @deprecated
+     * This is used internally by 'sendMessage' to call onComplete callback
+     * for a bot if configured
+     */
+    reportBotStatus(data, { name }) {
+        const callback = this._botsCompleteCallback[name];
+        if (!callback) {
+            return;
+        }
+        // Check if state is fulfilled to resolve onFullfilment promise
+        logger.debug('postContent state', data.dialogState);
+        switch (data.dialogState) {
+            case client_lex_runtime_service_1.DialogState.READY_FOR_FULFILLMENT:
+            case client_lex_runtime_service_1.DialogState.FULFILLED:
+                callback(undefined, data);
+                break;
+            case client_lex_runtime_service_1.DialogState.FAILED:
+                callback(new Error('Bot conversation failed'));
+                break;
+            default:
+                break;
+        }
+    }
+    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 { name, region, alias } = botConfig;
+        const client = new client_lex_runtime_service_1.LexRuntimeServiceClient({
+            region,
+            credentials: session.credentials,
+            customUserAgent: (0, utils_1.getAmplifyUserAgentObject)(),
+        });
+        let params;
+        if (typeof message === 'string') {
+            params = {
+                botAlias: alias,
+                botName: name,
+                inputText: message,
+                userId: session.identityId,
+            };
+            logger.debug('postText to lex', message);
+            try {
+                const postTextCommand = new client_lex_runtime_service_1.PostTextCommand(params);
+                const data = await client.send(postTextCommand);
+                this.reportBotStatus(data, botConfig);
+                return data;
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        }
+        else {
+            const { content, options: { messageType }, } = message;
+            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 = {
+                    botAlias: alias,
+                    botName: name,
+                    contentType: 'audio/x-l16; sample-rate=16000; channel-count=1',
+                    userId: session.identityId,
+                    accept: 'audio/mpeg',
+                    inputStream,
+                };
+            }
+            else {
+                if (typeof content !== 'string')
+                    return Promise.reject('invalid content type');
+                params = {
+                    botAlias: alias,
+                    botName: name,
+                    contentType: 'text/plain; charset=utf-8',
+                    inputStream: content,
+                    userId: session.identityId,
+                    accept: 'audio/mpeg',
+                };
+            }
+            logger.debug('postContent to lex', message);
+            try {
+                const postContentCommand = new client_lex_runtime_service_1.PostContentCommand(params);
+                const data = await client.send(postContentCommand);
+                const audioArray = data.audioStream
+                    ? await (0, utils_2.convert)(data.audioStream)
+                    : undefined;
+                const response = { ...data, ...{ audioStream: audioArray } };
+                this.reportBotStatus(response, botConfig);
+                return response;
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        }
+    }
+    onComplete({ name }, callback) {
+        this._botsCompleteCallback[name] = callback;
+    }
+}
+exports.lexProvider = new AWSLexProvider();

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

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

package/lib/lex-v1/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-v1/apis/onComplete.d.ts

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

package/lib/lex-v1/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 AWSLexProvider_1 = require("../AWSLexProvider");
+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.`);
+    AWSLexProvider_1.lexProvider.onComplete(botConfig, callback);
+};
+exports.onComplete = onComplete;

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

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

package/lib/lex-v1/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 utils_1 = require("../utils");
+const AWSLexProvider_1 = require("../AWSLexProvider");
+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 AWSLexProvider_1.lexProvider.sendMessage(botConfig, message);
+};
+exports.send = send;

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

@@ -0,0 +1,6 @@
+import { IInteractions } from './types/AWSLexProviderOption';
+/**
+ * @deprecated recommend to migrate to AWS Lex V2 instead
+ * */
+export declare const Interactions: IInteractions;
+export { SendInput, OnCompleteInput, SendOutput } from './types';

package/lib/lex-v1/index.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.Interactions = void 0;
+const apis_1 = require("./apis");
+/**
+ * @deprecated recommend to migrate to AWS Lex V2 instead
+ * */
+exports.Interactions = {
+    send: apis_1.send,
+    onComplete: apis_1.onComplete,
+};

package/lib/lex-v1/types/AWSLexProviderOption.d.ts

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

package/lib/{types/Response.js → lex-v1/types/AWSLexProviderOption.js}

@@ -2,4 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Response.js.map

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

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

package/lib/lex-v1/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-v1/types/inputs.d.ts

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

package/lib/lex-v1/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-v1/types/outputs.d.ts

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

package/lib/lex-v1/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-v1/utils/index.d.ts

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

package/lib/lex-v1/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-v1/utils/resolveBotConfig.d.ts

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

package/lib/lex-v1/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?.LexV1 ?? {};
+    if (botConfig !== undefined) {
+        return { ...botConfig, name: botName };
+    }
+};
+exports.resolveBotConfig = resolveBotConfig;

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

@@ -0,0 +1,52 @@
+import { InteractionsOnCompleteCallback, InteractionsMessage, InteractionsResponse } from '../types/Interactions';
+import { RecognizeTextCommandOutput, RecognizeUtteranceCommandOutput } from '@aws-sdk/client-lex-runtime-v2';
+import { AWSLexV2ProviderOption } from './types';
+interface RecognizeUtteranceCommandOutputFormatted extends Omit<RecognizeUtteranceCommandOutput, 'messages' | 'interpretations' | 'sessionState' | 'requestAttributes' | 'audioStream'> {
+    messages?: RecognizeTextCommandOutput['messages'];
+    sessionState?: RecognizeTextCommandOutput['sessionState'];
+    interpretations?: RecognizeTextCommandOutput['interpretations'];
+    requestAttributes?: RecognizeTextCommandOutput['requestAttributes'];
+    audioStream?: Uint8Array;
+}
+type AWSLexV2ProviderSendResponse = RecognizeTextCommandOutput | RecognizeUtteranceCommandOutputFormatted;
+declare class AWSLexV2Provider {
+    private readonly _botsCompleteCallback;
+    private defaultSessionId;
+    /**
+     * 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
+     */
+    sendMessage(botConfig: AWSLexV2ProviderOption, message: string | InteractionsMessage): Promise<InteractionsResponse>;
+    /**
+     * 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 }: AWSLexV2ProviderOption, callback: InteractionsOnCompleteCallback): void;
+    /**
+     * call onComplete callback for a bot if configured
+     */
+    _reportBotStatus(data: AWSLexV2ProviderSendResponse, { name }: AWSLexV2ProviderOption): void;
+    /**
+     * Format UtteranceCommandOutput's response
+     * decompress attributes
+     * update audioStream format
+     */
+    private _formatUtteranceCommandOutput;
+    /**
+     * handle client's `RecognizeTextCommand`
+     * used for sending simple text message
+     */
+    private _handleRecognizeTextCommand;
+    /**
+     * handle client's `RecognizeUtteranceCommand`
+     * used for obj text or obj voice message
+     */
+    private _handleRecognizeUtteranceCommand;
+}
+export declare const lexProvider: AWSLexV2Provider;
+export {};