@aws-amplify/interactions 4.0.51 → 4.1.0

package/src/Providers/AWSLexProviderHelper/utils.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { gunzip, strFromU8 } from 'fflate';
+
+export const convert = async (stream: object): Promise<Uint8Array> => {
+	if (stream instanceof Blob || stream instanceof ReadableStream) {
+		return new Response(stream)
+			.arrayBuffer()
+			.then(buffer => new Uint8Array(buffer));
+	} else {
+		return Promise.reject('Invalid content type');
+	}
+};
+
+export const base64ToArrayBuffer = (base64: string): Uint8Array => {
+	return Uint8Array.from(window.atob(base64), c => c.charCodeAt(0));
+};
+
+export const gzipDecompressToString = async (
+	data: Uint8Array
+): Promise<string> => {
+	return await new Promise((resolve, reject) => {
+		gunzip(data, (err, resp) => {
+			if (err) reject(err);
+			else resolve(strFromU8(resp));
+		});
+	});
+};

package/src/Providers/AWSLexV2Provider.ts

@@ -0,0 +1,343 @@
+/*
+ * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+import { AbstractInteractionsProvider } from './InteractionsProvider';
+import {
+	InteractionsOptions,
+	AWSLexV2ProviderOptions,
+	InteractionsResponse,
+	InteractionsMessage,
+} from '../types';
+import {
+	LexRuntimeV2Client,
+	RecognizeTextCommand,
+	RecognizeTextCommandInput,
+	RecognizeTextCommandOutput,
+	RecognizeUtteranceCommand,
+	RecognizeUtteranceCommandInput,
+	RecognizeUtteranceCommandOutput,
+} from '@aws-sdk/client-lex-runtime-v2';
+import {
+	ConsoleLogger as Logger,
+	Credentials,
+	getAmplifyUserAgent,
+} from '@aws-amplify/core';
+import { convert } from './AWSLexProviderHelper/utils';
+import { unGzipBase64AsJson } from './AWSLexProviderHelper/commonUtils';
+
+const logger = new Logger('AWSLexV2Provider');
+
+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;
+
+type lexV2BaseReqParams = {
+	botId: string;
+	botAliasId: string;
+	localeId: string;
+	sessionId: string;
+};
+
+export class AWSLexV2Provider extends AbstractInteractionsProvider {
+	private _lexRuntimeServiceV2Client: LexRuntimeV2Client;
+	private _botsCompleteCallback: object;
+
+	/**
+	 * Initialize Interactions with AWS configurations
+	 * @param {InteractionsOptions} options - Configuration object for Interactions
+	 */
+	constructor(options: InteractionsOptions = {}) {
+		super(options);
+		this._botsCompleteCallback = {};
+	}
+
+	/**
+	 * get provider name of the plugin
+	 * @returns {string} name of the provider
+	 */
+	public getProviderName() {
+		return 'AWSLexV2Provider';
+	}
+
+	/**
+	 * Configure Interactions part with aws configuration
+	 * @param {AWSLexV2ProviderOptions} config - Configuration of the Interactions
+	 * @return {AWSLexV2ProviderOptions} - Current configuration
+	 */
+	public configure(
+		config: AWSLexV2ProviderOptions = {}
+	): AWSLexV2ProviderOptions {
+		const propertiesToTest = [
+			'name',
+			'botId',
+			'aliasId',
+			'localeId',
+			'providerName',
+			'region',
+		];
+
+		Object.keys(config).forEach(botKey => {
+			const botConfig = config[botKey];
+
+			// is bot config correct
+			if (!propertiesToTest.every(x => x in botConfig)) {
+				throw new Error('invalid bot configuration');
+			}
+		});
+		return super.configure(config);
+	}
+
+	/**
+	 * Send a message to a bot
+	 * @async
+	 * @param {string} botname - Bot name to send the message
+	 * @param {string | InteractionsMessage} message - message to send to the bot
+	 * @return {Promise<InteractionsResponse>} A promise resolves to the response from the bot
+	 */
+	public async sendMessage(
+		botname: string,
+		message: string | InteractionsMessage
+	): Promise<InteractionsResponse> {
+		// check if bot exists
+		if (!this._config[botname]) {
+			return Promise.reject('Bot ' + botname + ' does not exist');
+		}
+
+		// check if credentials are present
+		let credentials;
+		try {
+			credentials = await Credentials.get();
+		} catch (error) {
+			return Promise.reject('No credentials');
+		}
+
+		this._lexRuntimeServiceV2Client = new LexRuntimeV2Client({
+			region: this._config[botname].region,
+			credentials,
+			customUserAgent: getAmplifyUserAgent(),
+		});
+
+		let response: AWSLexV2ProviderSendResponse;
+
+		// common base params for all requests
+		const reqBaseParams: lexV2BaseReqParams = {
+			botAliasId: this._config[botname].aliasId,
+			botId: this._config[botname].botId,
+			localeId: this._config[botname].localeId,
+			sessionId: credentials.identityId,
+		};
+
+		if (typeof message === 'string') {
+			response = await this._handleRecognizeTextCommand(
+				botname,
+				message,
+				reqBaseParams
+			);
+		} else {
+			response = await this._handleRecognizeUtteranceCommand(
+				botname,
+				message,
+				reqBaseParams
+			);
+		}
+		return response;
+	}
+
+	/**
+	 * Attach a onComplete callback function to a bot.
+	 * The callback is called once the bot's intent is fulfilled
+	 * @param {string} botname - Bot name to attach the onComplete callback
+	 * @param {(err: Error | null, confirmation: InteractionsResponse) => void} callback - called when Intent Fulfilled
+	 */
+	public onComplete(
+		botname: string,
+		callback: (err: Error | null, confirmation: InteractionsResponse) => void
+	) {
+		// does bot exist
+		if (!this._config[botname]) {
+			throw new Error('Bot ' + botname + ' does not exist');
+		}
+		this._botsCompleteCallback[botname] = callback;
+	}
+
+	/**
+	 * @private
+	 * call onComplete callback for a bot if configured
+	 */
+	private _reportBotStatus(
+		data: AWSLexV2ProviderSendResponse,
+		botname: string
+	) {
+		const sessionState = data?.sessionState;
+
+		// Check if state is fulfilled to resolve onFullfilment promise
+		logger.debug('postContent state', sessionState?.intent?.state);
+
+		const isConfigOnCompleteAttached =
+			typeof this._config?.[botname].onComplete === 'function';
+
+		const isApiOnCompleteAttached =
+			typeof this._botsCompleteCallback?.[botname] === 'function';
+
+		// no onComplete callbacks added
+		if (!isConfigOnCompleteAttached && !isApiOnCompleteAttached) return;
+
+		if (
+			sessionState?.intent?.state === 'ReadyForFulfillment' ||
+			sessionState?.intent?.state === 'Fulfilled'
+		) {
+			if (isApiOnCompleteAttached) {
+				setTimeout(() => this._botsCompleteCallback?.[botname](null, data), 0);
+			}
+
+			if (isConfigOnCompleteAttached) {
+				setTimeout(() => this._config[botname].onComplete(null, data), 0);
+			}
+		}
+
+		if (sessionState?.intent?.state === 'Failed') {
+			const error = new Error('Bot conversation failed');
+			if (isApiOnCompleteAttached) {
+				setTimeout(() => this._botsCompleteCallback[botname](error), 0);
+			}
+
+			if (isConfigOnCompleteAttached) {
+				setTimeout(() => this._config[botname].onComplete(error), 0);
+			}
+		}
+	}
+
+	/**
+	 * Format UtteranceCommandOutput's response
+	 * decompress attributes
+	 * update audioStream format
+	 */
+	private async _formatUtteranceCommandOutput(
+		data: RecognizeUtteranceCommandOutput
+	): Promise<RecognizeUtteranceCommandOutputFormatted> {
+		const response: RecognizeUtteranceCommandOutputFormatted = {
+			...data,
+			messages: await unGzipBase64AsJson(data.messages),
+			sessionState: await unGzipBase64AsJson(data.sessionState),
+			interpretations: await unGzipBase64AsJson(data.interpretations),
+			requestAttributes: await unGzipBase64AsJson(data.requestAttributes),
+			inputTranscript: await unGzipBase64AsJson(data.inputTranscript),
+			audioStream: data.audioStream
+				? await convert(data.audioStream)
+				: undefined,
+		};
+		return response;
+	}
+
+	/**
+	 * handle client's `RecognizeTextCommand`
+	 * used for sending simple text message
+	 */
+	private async _handleRecognizeTextCommand(
+		botname: string,
+		data: string,
+		baseParams: lexV2BaseReqParams
+	) {
+		logger.debug('postText to lex2', data);
+
+		const params: RecognizeTextCommandInput = {
+			...baseParams,
+			text: data,
+		};
+
+		try {
+			const recognizeTextCommand = new RecognizeTextCommand(params);
+			const data = await this._lexRuntimeServiceV2Client.send(
+				recognizeTextCommand
+			);
+
+			this._reportBotStatus(data, botname);
+			return data;
+		} catch (err) {
+			return Promise.reject(err);
+		}
+	}
+
+	/**
+	 * handle client's `RecognizeUtteranceCommand`
+	 * used for obj text or obj voice message
+	 */
+	private async _handleRecognizeUtteranceCommand(
+		botname: string,
+		data: InteractionsMessage,
+		baseParams: lexV2BaseReqParams
+	) {
+		const {
+			content,
+			options: { messageType },
+		} = data;
+
+		logger.debug('postContent to lex2', data);
+		let params: RecognizeUtteranceCommandInput;
+
+		// prepare params
+		if (messageType === 'voice') {
+			if (typeof content !== 'object') {
+				return Promise.reject('invalid content type');
+			}
+
+			const inputStream =
+				content instanceof Uint8Array ? content : await 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 RecognizeUtteranceCommand(params);
+			const data = await this._lexRuntimeServiceV2Client.send(
+				recognizeUtteranceCommand
+			);
+
+			const response = await this._formatUtteranceCommandOutput(data);
+			this._reportBotStatus(response, botname);
+			return response;
+		} catch (err) {
+			return Promise.reject(err);
+		}
+	}
+}

package/src/Providers/index.ts

@@ -11,4 +11,5 @@
  * and limitations under the License.
  */
 export * from './AWSLexProvider';
+export * from './AWSLexV2Provider';
 export * from './InteractionsProvider';

package/src/index.ts

@@ -20,5 +20,6 @@ export default Interactions;
 export * from './types';
 export * from './Providers/InteractionsProvider';
 export * from './Providers/AWSLexProvider';
+export * from './Providers/AWSLexV2Provider';
 
 export { Interactions };

package/src/types/Providers/AWSLexProvider.ts

@@ -1,3 +1,15 @@
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 export interface AWSLexProviderOption {
 	name: string;
 	alias: string;

package/src/types/Providers/AWSLexV2Provider.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+export interface AWSLexV2ProviderOption {
+	name: string;
+	botId: string;
+	aliasId: string;
+	localeId: string;
+	region: string;
+	providerName: string;
+	onComplete?(botname: string, callback: (err, confirmation) => void): void;
+}
+
+export interface AWSLexV2ProviderOptions {
+	[key: string]: AWSLexV2ProviderOption;
+}

package/src/types/index.ts

@@ -13,4 +13,5 @@
 export * from './Interactions';
 export * from './Provider';
 export * from './Providers/AWSLexProvider';
+export * from './Providers/AWSLexV2Provider';
 export * from './Response';

package/lib/Providers/AWSLexProviderHelper/convert.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" />
-import { Readable } from 'stream';
-export declare const convert: (stream: Blob | ReadableStream<any> | Readable) => Promise<Uint8Array>;

package/lib/Providers/AWSLexProviderHelper/convert.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convert = function (stream) {
-    if (stream instanceof Blob || stream instanceof ReadableStream) {
-        return new Response(stream)
-            .arrayBuffer()
-            .then(function (buffer) { return new Uint8Array(buffer); });
-    }
-    else {
-        throw new Error('Readable is not supported.');
-    }
-};
-//# sourceMappingURL=convert.js.map

package/lib/Providers/AWSLexProviderHelper/convert.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"convert.js","sourceRoot":"","sources":["../../../src/Providers/AWSLexProviderHelper/convert.ts"],"names":[],"mappings":";;AACa,QAAA,OAAO,GAAG,UACtB,MAAwC;IAExC,IAAI,MAAM,YAAY,IAAI,IAAI,MAAM,YAAY,cAAc,EAAE;QAC/D,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC;aACzB,WAAW,EAAE;aACb,IAAI,CAAC,UAAA,MAAM,IAAI,OAAA,IAAI,UAAU,CAAC,MAAM,CAAC,EAAtB,CAAsB,CAAC,CAAC;KACzC;SAAM;QACN,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC9C;AACF,CAAC,CAAC"}

package/lib/Providers/AWSLexProviderHelper/convert.native.d.ts

@@ -1 +0,0 @@
-export declare const convert: (stream: Blob) => Promise<Uint8Array>;

package/lib/Providers/AWSLexProviderHelper/convert.native.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"convert.native.js","sourceRoot":"","sources":["../../../src/Providers/AWSLexProviderHelper/convert.native.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAa,QAAA,OAAO,GAAG,UAAC,MAAY;IACnC,OAAO,IAAI,OAAO,CAAC,UAAO,GAAG,EAAE,GAAG;;;YAC3B,OAAO,GAAG,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACtC,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;YACrC,OAAO,CAAC,YAAY,GAAG,aAAa,CAAC;YACrC,OAAO,CAAC,MAAM,GAAG,UAAA,MAAM;gBACtB,OAAO,GAAG,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9C,CAAC,CAAC;YACF,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YACnC,OAAO,CAAC,IAAI,EAAE,CAAC;;;SACf,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/lib-esm/Providers/AWSLexProviderHelper/convert.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" />
-import { Readable } from 'stream';
-export declare const convert: (stream: Blob | ReadableStream<any> | Readable) => Promise<Uint8Array>;

package/lib-esm/Providers/AWSLexProviderHelper/convert.js

@@ -1,11 +0,0 @@
-export var convert = function (stream) {
-    if (stream instanceof Blob || stream instanceof ReadableStream) {
-        return new Response(stream)
-            .arrayBuffer()
-            .then(function (buffer) { return new Uint8Array(buffer); });
-    }
-    else {
-        throw new Error('Readable is not supported.');
-    }
-};
-//# sourceMappingURL=convert.js.map

package/lib-esm/Providers/AWSLexProviderHelper/convert.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"convert.js","sourceRoot":"","sources":["../../../src/Providers/AWSLexProviderHelper/convert.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,IAAM,OAAO,GAAG,UACtB,MAAwC;IAExC,IAAI,MAAM,YAAY,IAAI,IAAI,MAAM,YAAY,cAAc,EAAE;QAC/D,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC;aACzB,WAAW,EAAE;aACb,IAAI,CAAC,UAAA,MAAM,IAAI,OAAA,IAAI,UAAU,CAAC,MAAM,CAAC,EAAtB,CAAsB,CAAC,CAAC;KACzC;SAAM;QACN,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC9C;AACF,CAAC,CAAC"}

package/lib-esm/Providers/AWSLexProviderHelper/convert.native.d.ts

@@ -1 +0,0 @@
-export declare const convert: (stream: Blob) => Promise<Uint8Array>;

package/lib-esm/Providers/AWSLexProviderHelper/convert.native.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"convert.native.js","sourceRoot":"","sources":["../../../src/Providers/AWSLexProviderHelper/convert.native.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAM,CAAC,IAAM,OAAO,GAAG,UAAC,MAAY;IACnC,OAAO,IAAI,OAAO,CAAC,UAAO,GAAG,EAAE,GAAG;;;YAC3B,OAAO,GAAG,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACtC,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;YACrC,OAAO,CAAC,YAAY,GAAG,aAAa,CAAC;YACrC,OAAO,CAAC,MAAM,GAAG,UAAA,MAAM;gBACtB,OAAO,GAAG,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9C,CAAC,CAAC;YACF,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YACnC,OAAO,CAAC,IAAI,EAAE,CAAC;;;SACf,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/src/Providers/AWSLexProviderHelper/convert.native.ts

@@ -1,13 +0,0 @@
-export const convert = (stream: Blob): Promise<Uint8Array> => {
-	return new Promise(async (res, rej) => {
-		const blobURL = URL.createObjectURL(stream);
-		const request = new XMLHttpRequest();
-		request.responseType = 'arraybuffer';
-		request.onload = _event => {
-			return res(new Uint8Array(request.response));
-		};
-		request.onerror = rej;
-		request.open('GET', blobURL, true);
-		request.send();
-	});
-};

package/src/Providers/AWSLexProviderHelper/convert.ts

@@ -1,12 +0,0 @@
-import { Readable } from 'stream';
-export const convert = (
-	stream: Blob | Readable | ReadableStream
-): Promise<Uint8Array> => {
-	if (stream instanceof Blob || stream instanceof ReadableStream) {
-		return new Response(stream)
-			.arrayBuffer()
-			.then(buffer => new Uint8Array(buffer));
-	} else {
-		throw new Error('Readable is not supported.');
-	}
-};