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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/interactions",
-	"version": "5.2.12-unstable.7762f1a.0+7762f1a",
+	"version": "6.0.0",
 	"description": "Interactions category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -8,10 +8,7 @@
 	"react-native": {
 		"./lib/index": "./lib-esm/index.js"
 	},
-	"sideEffects": [
-		"./lib/Interactions.js",
-		"./lib-esm/Interactions.js"
-	],
+	"sideEffects": false,
 	"publishConfig": {
 		"access": "public"
 	},
@@ -19,16 +16,43 @@
 		"test": "npm run lint && jest -w 1 --coverage",
 		"test:size": "size-limit",
 		"build-with-test": "npm run clean && npm test && tsc && webpack",
-		"build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
-		"build:esm": "node ./build es6",
-		"build:cjs:watch": "node ./build es5 --watch",
-		"build:esm:watch": "node ./build es6 --watch",
+		"build:cjs": "rimraf lib && tsc -m commonjs --outDir lib && webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm": "rimraf lib-esm && tsc -m esnext --outDir lib-esm",
+		"build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
+		"build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm",
 		"build": "npm run clean && npm run build:esm && npm run build:cjs",
 		"clean": "npm run clean:size && rimraf lib-esm lib dist",
 		"clean:size": "rimraf dual-publish-tmp tmp*",
 		"format": "echo \"Not implemented\"",
 		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.6"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 88.6"
+	},
+	"typesVersions": {
+		">=4.2": {
+			"lex-v1": [
+				"./lib-esm/lex-v1/index.d.ts"
+			],
+			"lex-v2": [
+				"./lib-esm/lex-v2/index.d.ts"
+			]
+		}
+	},
+	"exports": {
+		".": {
+			"types": "./lib-esm/index.d.ts",
+			"import": "./lib-esm/index.js",
+			"require": "./lib/index.js"
+		},
+		"./lex-v1": {
+			"types": "./lib-esm/lex-v1/index.d.ts",
+			"import": "./lib-esm/lex-v1/index.js",
+			"require": "./lib/lex-v1/index.js"
+		},
+		"./lex-v2": {
+			"types": "./lib-esm/lex-v2/index.d.ts",
+			"import": "./lib-esm/lex-v2/index.js",
+			"require": "./lib/lex-v2/index.js"
+		}
 	},
 	"repository": {
 		"type": "git",
@@ -43,23 +67,41 @@
 	"files": [
 		"lib",
 		"lib-esm",
-		"src"
+		"src",
+		"lex-v1",
+		"lex-v2"
 	],
 	"dependencies": {
-		"@aws-amplify/core": "5.8.6-unstable.7762f1a.0+7762f1a",
-		"@aws-sdk/client-lex-runtime-service": "3.186.3",
-		"@aws-sdk/client-lex-runtime-v2": "3.186.3",
+		"@aws-sdk/client-lex-runtime-service": "3.398.0",
+		"@aws-sdk/client-lex-runtime-v2": "3.398.0",
 		"base-64": "1.0.0",
 		"fflate": "0.7.3",
 		"pako": "2.0.4",
-		"tslib": "^1.8.0"
+		"tslib": "^2.5.0",
+		"uuid": "^9.0.0"
+	},
+	"devDependencies": {
+		"@aws-amplify/core": "6.0.0",
+		"typescript": "^5.0.2"
 	},
 	"size-limit": [
 		{
-			"name": "Interactions (top-level class with Lex v2)",
+			"name": "Interactions (default to Lex v2)",
 			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Interactions, AWSLexV2Provider }",
-			"limit": "76.02 kB"
+			"import": "{ Amplify, Interactions }",
+			"limit": "52.00 kB"
+		},
+		{
+			"name": "Interactions (Lex v2)",
+			"path": "./lib-esm/lex-v2/index.js",
+			"import": "{ Amplify, Interactions }",
+			"limit": "52.00 kB"
+		},
+		{
+			"name": "Interactions (Lex v1)",
+			"path": "./lib-esm/lex-v1/index.js",
+			"import": "{ Amplify, Interactions }",
+			"limit": "47.00 kB"
 		}
 	],
 	"jest": {
@@ -67,20 +109,17 @@
 			"ts-jest": {
 				"diagnostics": false,
 				"tsConfig": {
-					"lib": [
-						"es5",
-						"es2015",
-						"dom",
-						"esnext.asynciterable",
-						"es2017.object"
-					],
-					"allowJs": true
+					"allowJs": true,
+					"noEmitOnError": false
 				}
 			}
 		},
 		"transform": {
 			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
 		},
+		"testPathIgnorePatterns": [
+			"/testUtils/"
+		],
 		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
 		"moduleFileExtensions": [
 			"ts",
@@ -100,11 +139,11 @@
 			}
 		},
 		"coveragePathIgnorePatterns": [
-			"/node_modules/",
+			"node_modules",
 			"dist",
 			"lib",
 			"lib-esm"
 		]
 	},
-	"gitHead": "7762f1a7076e622ec354c24539a3b57ce3ec4290"
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }

package/src/errors/InteractionsError.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AmplifyError,
+	AmplifyErrorParams,
+} from '@aws-amplify/core/internals/utils';
+
+export class InteractionsError extends AmplifyError {
+	constructor(params: AmplifyErrorParams) {
+		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);
+	}
+}

package/src/errors/assertValidationError.ts

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	InteractionsValidationErrorCode,
+	validationErrorMap,
+} from './validation';
+import { InteractionsError } from './InteractionsError';
+
+export function assertValidationError(
+	assertion: boolean,
+	name: InteractionsValidationErrorCode,
+	message?: string
+): asserts assertion {
+	if (!assertion) {
+		const { message: defaultMessage, recoverySuggestion } =
+			validationErrorMap[name];
+		throw new InteractionsError({
+			name,
+			message: message ?? defaultMessage,
+			recoverySuggestion,
+		});
+	}
+}

package/src/errors/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { assertValidationError } from './assertValidationError';
+export { InteractionsValidationErrorCode } from './validation';

package/src/errors/validation.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+
+export enum InteractionsValidationErrorCode {
+	NoBotConfig = 'NoBotConfig',
+}
+
+export const validationErrorMap: AmplifyErrorMap<InteractionsValidationErrorCode> =
+	{
+		[InteractionsValidationErrorCode.NoBotConfig]: {
+			message: 'Missing configuration for the bot',
+		},
+	};

package/src/index.ts

@@ -1,8 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-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/src/lex-v1/AWSLexProvider.ts

@@ -0,0 +1,167 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import {
+	InteractionsOnCompleteCallback,
+	InteractionsMessage,
+	InteractionsResponse,
+} from '../types/Interactions';
+import {
+	DialogState,
+	LexRuntimeServiceClient,
+	PostContentCommand,
+	PostContentCommandInput,
+	PostContentCommandOutput,
+	PostTextCommand,
+	PostTextCommandInput,
+	PostTextCommandOutput,
+} from '@aws-sdk/client-lex-runtime-service';
+import { getAmplifyUserAgentObject } from '@aws-amplify/core/internals/utils';
+import { ConsoleLogger, fetchAuthSession } from '@aws-amplify/core';
+import { convert } from '../utils';
+import { AWSLexProviderOption } from './types';
+
+const logger = new ConsoleLogger('AWSLexProvider');
+
+interface PostContentCommandOutputFormatted
+	extends Omit<PostContentCommandOutput, 'audioStream'> {
+	audioStream?: Uint8Array;
+}
+
+type AWSLexProviderSendResponse =
+	| PostTextCommandOutput
+	| PostContentCommandOutputFormatted;
+
+class AWSLexProvider {
+	private readonly _botsCompleteCallback: Record<
+		string,
+		InteractionsOnCompleteCallback
+	> = {};
+
+	/**
+	 * @deprecated
+	 * This is used internally by 'sendMessage' to call onComplete callback
+	 * for a bot if configured
+	 */
+	reportBotStatus(
+		data: AWSLexProviderSendResponse,
+		{ name }: AWSLexProviderOption
+	) {
+		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 DialogState.READY_FOR_FULFILLMENT:
+			case DialogState.FULFILLED:
+				callback(undefined, data);
+				break;
+			case DialogState.FAILED:
+				callback(new Error('Bot conversation failed'));
+				break;
+			default:
+				break;
+		}
+	}
+
+	async sendMessage(
+		botConfig: AWSLexProviderOption,
+		message: string | InteractionsMessage
+	): Promise<InteractionsResponse> {
+		// check if credentials are present
+		let session;
+		try {
+			session = await fetchAuthSession();
+		} catch (error) {
+			return Promise.reject('No credentials');
+		}
+
+		const { name, region, alias } = botConfig;
+		const client = new LexRuntimeServiceClient({
+			region,
+			credentials: session.credentials,
+			customUserAgent: getAmplifyUserAgentObject(),
+		});
+
+		let params: PostTextCommandInput | PostContentCommandInput;
+		if (typeof message === 'string') {
+			params = {
+				botAlias: alias,
+				botName: name,
+				inputText: message,
+				userId: session.identityId,
+			};
+
+			logger.debug('postText to lex', message);
+			try {
+				const postTextCommand = new 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 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 PostContentCommand(params);
+				const data = await client.send(postContentCommand);
+
+				const audioArray = data.audioStream
+					? await convert(data.audioStream)
+					: undefined;
+
+				const response = { ...data, ...{ audioStream: audioArray } };
+
+				this.reportBotStatus(response, botConfig);
+				return response;
+			} catch (err) {
+				return Promise.reject(err);
+			}
+		}
+	}
+
+	onComplete(
+		{ name }: AWSLexProviderOption,
+		callback: InteractionsOnCompleteCallback
+	) {
+		this._botsCompleteCallback[name] = callback;
+	}
+}
+
+export const lexProvider = new AWSLexProvider();

package/src/lex-v1/apis/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { send } from './send';
+export { onComplete } from './onComplete';

package/src/lex-v1/apis/onComplete.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { OnCompleteInput } from '../types';
+import { resolveBotConfig } from '../utils';
+import { lexProvider } from '../AWSLexProvider';
+import {
+	assertValidationError,
+	InteractionsValidationErrorCode,
+} from '../../errors';
+
+export const onComplete = (input: OnCompleteInput): void => {
+	const { botName, callback } = input;
+	const botConfig = resolveBotConfig(botName);
+	assertValidationError(
+		!!botConfig,
+		InteractionsValidationErrorCode.NoBotConfig,
+		`Bot ${botName} does not exist.`
+	);
+	lexProvider.onComplete(botConfig, callback);
+};

package/src/lex-v1/apis/send.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { SendInput, SendOutput } from '../types';
+import { resolveBotConfig } from '../utils';
+import { lexProvider } from '../AWSLexProvider';
+import {
+	assertValidationError,
+	InteractionsValidationErrorCode,
+} from '../../errors';
+
+export const send = async (input: SendInput): Promise<SendOutput> => {
+	const { botName, message } = input;
+	const botConfig = resolveBotConfig(botName);
+	assertValidationError(
+		!!botConfig,
+		InteractionsValidationErrorCode.NoBotConfig,
+		`Bot ${botName} does not exist.`
+	);
+	return lexProvider.sendMessage(botConfig, message);
+};

package/src/lex-v1/index.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { send, onComplete } from './apis';
+import { IInteractions } from './types/AWSLexProviderOption';
+
+/**
+ * @deprecated recommend to migrate to AWS Lex V2 instead
+ * */
+export const Interactions: IInteractions = {
+	send,
+	onComplete,
+};
+export { SendInput, OnCompleteInput, SendOutput } from './types';

package/src/lex-v1/types/AWSLexProviderOption.ts

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/lex-v1/types/index.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { AWSLexProviderOption } from './AWSLexProviderOption';
+export { SendInput, OnCompleteInput } from './inputs';
+export { SendOutput } from './outputs';

package/src/lex-v1/types/inputs.ts

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/lex-v1/types/outputs.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { InteractionsSendOutput } from '../../types';
+
+/**
+ * Output type for LexV1 send API.
+ */
+export type SendOutput = InteractionsSendOutput;

package/src/{types/Response.ts → lex-v1/utils/index.ts}

@@ -1,6 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export type InteractionsResponse = {
-	[key: string]: any;
-};
+export { resolveBotConfig } from './resolveBotConfig';

package/src/lex-v1/utils/resolveBotConfig.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AWSLexProviderOption } from '../types';
+import { Amplify } from '@aws-amplify/core';
+
+export const resolveBotConfig = (
+	botName: string
+): AWSLexProviderOption | undefined => {
+	const { [botName]: botConfig = undefined } =
+		Amplify.getConfig().Interactions?.LexV1 ?? {};
+	if (botConfig !== undefined) {
+		return { ...botConfig, name: botName };
+	}
+};