@aws-amplify/predictions 6.0.22 → 6.0.23

package/src/providers/AmazonAIIdentifyPredictionsProvider.ts

@@ -26,6 +26,7 @@ import {
 	DetectDocumentTextCommandInput,
 	TextractClient,
 } from '@aws-sdk/client-textract';
+
 import { PredictionsValidationErrorCode } from '../errors/types/validation';
 import { assertValidationError } from '../errors/utils/assertValidationError';
 import {
@@ -50,12 +51,8 @@ import {
 	isStorageSource,
 	isValidIdentifyInput,
 } from '../types';
-import {
-	BlockList,
-	Document,
-	Image,
-	TextDetectionList,
-} from '../types/AWSTypes';
+import { BlockList, Image, TextDetectionList } from '../types/AWSTypes';
+
 import {
 	categorizeRekognitionBlocks,
 	categorizeTextractBlocks,
@@ -84,12 +81,15 @@ export class AmazonAIIdentifyPredictionsProvider {
 
 		if (isIdentifyTextInput(input)) {
 			logger.debug('identifyText');
+
 			return this.identifyText(input);
 		} else if (isIdentifyLabelsInput(input)) {
 			logger.debug('identifyLabels');
+
 			return this.identifyLabels(input);
 		} else {
 			logger.debug('identifyEntities');
+
 			return this.identifyEntities(input);
 		}
 	}
@@ -102,7 +102,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 	 * @return {Promise<Image>} - Promise resolving to the converted source object.
 	 */
 	private configureSource(source: IdentifySource): Promise<Image> {
-		return new Promise((res, rej) => {
+		return new Promise((resolve, reject) => {
 			if (isStorageSource(source)) {
 				const storageConfig = {
 					accessLevel: source.level,
@@ -114,37 +114,44 @@ export class AmazonAIIdentifyPredictionsProvider {
 						const parser =
 							/https:\/\/([a-zA-Z0-9%\-_.]+)\.s3\.[A-Za-z0-9%\-._~]+\/([a-zA-Z0-9%\-._~/]+)\?/;
 						const parsedURL = value.url.toString().match(parser) ?? '';
-						if (parsedURL.length < 3) rej('Invalid S3 key was given.');
-						res({
+						if (parsedURL.length < 3)
+							reject(new Error('Invalid S3 key was given.'));
+						resolve({
 							S3Object: {
 								Bucket: parsedURL[1],
 								Name: decodeURIComponent(parsedURL[2]),
 							},
 						});
 					})
-					.catch(err => rej(err));
+					.catch(err => {
+						reject(err);
+					});
 			} else if (isFileSource(source)) {
 				blobToArrayBuffer(source.file)
 					.then(buffer => {
-						res({ Bytes: new Uint8Array(buffer) });
+						resolve({ Bytes: new Uint8Array(buffer) });
 					})
-					.catch(err => rej(err));
+					.catch(err => {
+						reject(err);
+					});
 			} else if (isIdentifyBytesSource(source)) {
-				const bytes = source.bytes;
+				const { bytes } = source;
 				if (bytes instanceof Blob) {
 					blobToArrayBuffer(bytes)
 						.then(buffer => {
-							res({ Bytes: new Uint8Array(buffer) });
+							resolve({ Bytes: new Uint8Array(buffer) });
 						})
-						.catch(err => rej(err));
+						.catch(err => {
+							reject(err);
+						});
 				}
 				if (bytes instanceof ArrayBuffer || bytes instanceof Buffer) {
-					res({ Bytes: new Uint8Array(bytes) } as Image);
+					resolve({ Bytes: new Uint8Array(bytes) } as Image);
 				}
 				// everything else can be directly passed to Rekognition / Textract.
-				res({ Bytes: bytes } as Image);
+				resolve({ Bytes: bytes } as Image);
 			} else {
-				rej('Input source is not configured correctly.');
+				reject(new Error('Input source is not configured correctly.'));
 			}
 		});
 	}
@@ -179,9 +186,8 @@ export class AmazonAIIdentifyPredictionsProvider {
 			credentials,
 			customUserAgent: _getPredictionsIdentifyAmplifyUserAgent(),
 		});
-		let inputDocument: Document;
 
-		inputDocument = await this.configureSource(input.text?.source);
+		const inputDocument = await this.configureSource(input.text?.source);
 
 		// get default value if format isn't specified in the input.
 		const format = input.text?.format ?? configFormat;
@@ -237,6 +243,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 
 			const analyzeDocumentCommand = new AnalyzeDocumentCommand(param);
 			const { Blocks } = await this.textractClient.send(analyzeDocumentCommand);
+
 			return categorizeTextractBlocks(Blocks as BlockList);
 		}
 	}
@@ -285,14 +292,15 @@ export class AmazonAIIdentifyPredictionsProvider {
 			data.forEach(val => {
 				identifyResult = { ...identifyResult, ...val };
 			});
+
 			return identifyResult;
 		});
 	}
 
 	/**
 	 * Calls Rekognition.detectLabels and organizes the returned data.
-	 * @param {DetectLabelsInput} param - parameter to be passed onto Rekognition
-	 * @return {Promise<IdentifyLabelsOutput>} - Promise resolving to organized detectLabels response.
+	 * @param param - parameters as {@link DetectLabelsCommandInput} to be passed onto Rekognition
+	 * @return a promise resolving to organized detectLabels response as {@link IdentifyLabelsOutput}.
 	 */
 	private async detectLabels(
 		param: DetectLabelsCommandInput,
@@ -306,6 +314,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 					instance =>
 						makeCamelCase(instance.BoundingBox) as BoundingBox | undefined,
 				) || [];
+
 			return {
 				name: label.Name,
 				boundingBoxes: boxes,
@@ -315,13 +324,14 @@ export class AmazonAIIdentifyPredictionsProvider {
 				},
 			};
 		});
+
 		return { labels: detectLabelData };
 	}
 
 	/**
 	 * Calls Rekognition.detectModerationLabels and organizes the returned data.
-	 * @param {Rekognition.DetectLabelsRequest} param - Parameter to be passed onto Rekognition
-	 * @return {Promise<IdentifyLabelsOutput>} - Promise resolving to organized detectModerationLabels response.
+	 * @param param parameter to be passed onto Rekognition as {@link DetectModerationLabelsCommandInput}
+	 * @return a promise resolving to organized detectModerationLabels response as {@link IdentifyLabelsOutput}.
 	 */
 	private async detectModerationLabels(
 		param: DetectModerationLabelsCommandInput,
@@ -342,8 +352,8 @@ export class AmazonAIIdentifyPredictionsProvider {
 	/**
 	 * Identify faces within an image that is provided as input, and match faces from a collection
 	 * or identify celebrities.
-	 * @param {IdentifyEntityInput} input - object containing the source image and face match options.
-	 * @return {Promise<IdentifyEntityOutput>} Promise resolving to identify results.
+	 * @param input - object of {@link IdentifyEntitiesInput} containing the source image and face match options.
+	 * @return a promise resolving to identify results as {@link IdentifyEntitiesOutput}.
 	 */
 	protected async identifyEntities(
 		input: IdentifyEntitiesInput,
@@ -401,6 +411,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 							},
 						}) as IdentifyEntity,
 				) ?? [];
+
 			return { entities: faces };
 		} else if (
 			isIdentifyFromCollection(input.entities) &&
@@ -425,6 +436,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 					const externalImageId = match.Face?.ExternalImageId
 						? this.decodeExternalImageId(match.Face.ExternalImageId)
 						: undefined;
+
 					return {
 						boundingBox: makeCamelCase(match.Face?.BoundingBox),
 						metadata: {
@@ -433,6 +445,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 						},
 					} as IdentifyEntity;
 				}) ?? [];
+
 			return { entities: faces };
 		} else {
 			const detectFacesCommand = new DetectFacesCommand(param);
@@ -458,6 +471,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 					faceAttributes.emotions = detail.Emotions?.map(
 						emotion => emotion.Type,
 					);
+
 					return {
 						boundingBox: makeCamelCase(detail.BoundingBox),
 						landmarks: makeCamelCaseArray(detail.Landmarks),
@@ -469,6 +483,7 @@ export class AmazonAIIdentifyPredictionsProvider {
 						},
 					} as IdentifyEntity;
 				}) ?? [];
+
 			return { entities: faces };
 		}
 	}

package/src/providers/AmazonAIInterpretPredictionsProvider.ts

@@ -6,7 +6,6 @@ import {
 	PredictionsAction,
 	getAmplifyUserAgentObject,
 } from '@aws-amplify/core/internals/utils';
-
 import {
 	ComprehendClient,
 	DetectDominantLanguageCommand,
@@ -17,6 +16,7 @@ import {
 	Entity,
 	SyntaxToken,
 } from '@aws-sdk/client-comprehend';
+
 import { PredictionsValidationErrorCode } from '../errors/types/validation';
 import { assertValidationError } from '../errors/utils/assertValidationError';
 import {
@@ -63,9 +63,9 @@ export class AmazonAIInterpretPredictionsProvider {
 		const { text: textSource } = input;
 		const { source, type = defaultType } = textSource;
 		const { text } = source;
-		let language;
+		let sourceLanguage;
 		if (isInterpretTextOthers(textSource)) {
-			language = (textSource as InterpretTextOthers).source.language;
+			sourceLanguage = (textSource as InterpretTextOthers).source.language;
 		}
 
 		this.comprehendClient = new ComprehendClient({
@@ -79,7 +79,7 @@ export class AmazonAIInterpretPredictionsProvider {
 
 		const doAll = type === 'all';
 
-		let languageCode = language;
+		let languageCode = sourceLanguage;
 		if (doAll || type === 'language') {
 			const languageDetectionParams = {
 				Text: text,
@@ -87,7 +87,7 @@ export class AmazonAIInterpretPredictionsProvider {
 			languageCode = await this.detectLanguage(languageDetectionParams);
 		}
 
-		let entitiesPromise: Promise<Array<TextEntities>> | undefined;
+		let entitiesPromise: Promise<TextEntities[]> | undefined;
 		if (doAll || type === 'entities') {
 			assertValidationError(
 				!!languageCode,
@@ -113,7 +113,7 @@ export class AmazonAIInterpretPredictionsProvider {
 			sentimentPromise = this.detectSentiment(sentimentParams);
 		}
 
-		let syntaxPromise: Promise<Array<TextSyntax>> | undefined;
+		let syntaxPromise: Promise<TextSyntax[]> | undefined;
 		if (doAll || type === 'syntax') {
 			assertValidationError(
 				!!languageCode,
@@ -145,6 +145,7 @@ export class AmazonAIInterpretPredictionsProvider {
 			syntaxPromise,
 			keyPhrasesPromise,
 		]);
+
 		return {
 			textInterpretation: {
 				keyPhrases,
@@ -160,8 +161,9 @@ export class AmazonAIInterpretPredictionsProvider {
 		try {
 			const detectKeyPhrasesCommand = new DetectKeyPhrasesCommand(params);
 			const data = await this.comprehendClient!.send(detectKeyPhrasesCommand);
-			const { KeyPhrases = [] } = data || {};
-			return KeyPhrases.map(({ Text: text }) => {
+			const { KeyPhrases: keyPhrases = [] } = data || {};
+
+			return keyPhrases.map(({ Text: text }) => {
 				return { text };
 			});
 		} catch (err: any) {
@@ -176,11 +178,12 @@ export class AmazonAIInterpretPredictionsProvider {
 		}
 	}
 
-	private async detectSyntax(params: DetectParams): Promise<Array<TextSyntax>> {
+	private async detectSyntax(params: DetectParams): Promise<TextSyntax[]> {
 		try {
 			const detectSyntaxCommand = new DetectSyntaxCommand(params);
 			const data = await this.comprehendClient!.send(detectSyntaxCommand);
 			const { SyntaxTokens = [] } = data || {};
+
 			return this.serializeSyntaxFromComprehend(SyntaxTokens);
 		} catch (err: any) {
 			if (err.code === 'AccessDeniedException') {
@@ -194,9 +197,7 @@ export class AmazonAIInterpretPredictionsProvider {
 		}
 	}
 
-	private serializeSyntaxFromComprehend(
-		tokens: SyntaxToken[],
-	): Array<TextSyntax> {
+	private serializeSyntaxFromComprehend(tokens: SyntaxToken[]): TextSyntax[] {
 		let response: TextSyntax[] = [];
 		if (tokens && Array.isArray(tokens)) {
 			response = tokens.map(
@@ -205,6 +206,7 @@ export class AmazonAIInterpretPredictionsProvider {
 				},
 			);
 		}
+
 		return response;
 	}
 
@@ -220,7 +222,8 @@ export class AmazonAIInterpretPredictionsProvider {
 					Neutral: neutral = 0,
 					Mixed: mixed = 0,
 				} = {},
-			} = ({} = data);
+			} = data ?? {};
+
 			return { predominant, positive, negative, neutral, mixed };
 		} catch (err: any) {
 			if (err.code === 'AccessDeniedException') {
@@ -234,13 +237,12 @@ export class AmazonAIInterpretPredictionsProvider {
 		}
 	}
 
-	private async detectEntities(
-		params: DetectParams,
-	): Promise<Array<TextEntities>> {
+	private async detectEntities(params: DetectParams): Promise<TextEntities[]> {
 		try {
 			const detectEntitiesCommand = new DetectEntitiesCommand(params);
 			const data = await this.comprehendClient!.send(detectEntitiesCommand);
 			const { Entities = [] } = data || {};
+
 			return this.serializeEntitiesFromComprehend(Entities);
 		} catch (err: any) {
 			if (err.code === 'AccessDeniedException') {
@@ -254,13 +256,14 @@ export class AmazonAIInterpretPredictionsProvider {
 		}
 	}
 
-	private serializeEntitiesFromComprehend(data: Entity[]): Array<TextEntities> {
+	private serializeEntitiesFromComprehend(data: Entity[]): TextEntities[] {
 		let response: TextEntities[] = [];
 		if (data && Array.isArray(data)) {
 			response = data.map(({ Type: type, Text: text }) => {
 				return { type, text };
 			});
 		}
+
 		return response;
 	}
 
@@ -272,7 +275,8 @@ export class AmazonAIInterpretPredictionsProvider {
 			const data = await this.comprehendClient!.send(
 				detectDominantLanguageCommand,
 			);
-			const { Languages: [{ LanguageCode }] = [{}] } = ({} = data || {});
+			const { Languages: [{ LanguageCode }] = [{ LanguageCode: undefined }] } =
+				data ?? {};
 			assertValidationError(
 				!!LanguageCode,
 				PredictionsValidationErrorCode.NoLanguage,

package/src/providers/IdentifyTextUtils.ts

@@ -11,6 +11,7 @@ import {
 	TableCell,
 } from '../types';
 import { Block, BlockList, TextDetectionList } from '../types/AWSTypes';
+
 import { makeCamelCase, makeCamelCaseArray } from './Utils';
 
 function getBoundingBox(geometry?: Geometry): BoundingBox | undefined {
@@ -19,6 +20,7 @@ function getBoundingBox(geometry?: Geometry): BoundingBox | undefined {
 
 function getPolygon(geometry?: Geometry): Polygon | undefined {
 	if (!geometry?.Polygon) return undefined;
+
 	return makeCamelCaseArray(Array.from(geometry.Polygon)) as Polygon;
 }
 
@@ -69,6 +71,7 @@ export function categorizeRekognitionBlocks(
 		0,
 		response.text.fullText.length - 1,
 	);
+
 	return response;
 }
 
@@ -102,9 +105,9 @@ export function categorizeTextractBlocks(
 	 * Note that we do not map `WORD` and `TABLE` in `blockMap` because they will not be referenced by any other
 	 * block except the Page block.
 	 */
-	const tableBlocks: BlockList = Array();
-	const keyValueBlocks: BlockList = Array();
-	const blockMap: { [id: string]: Block } = {};
+	const tableBlocks: BlockList = [];
+	const keyValueBlocks: BlockList = [];
+	const blockMap: Record<string, Block> = {};
 
 	blocks.forEach(block => {
 		switch (block.BlockType) {
@@ -130,9 +133,8 @@ export function categorizeTextractBlocks(
 					blockMap[block.Id] = block;
 				}
 				break;
-			case 'SELECTION_ELEMENT':
-				const selectionStatus =
-					block.SelectionStatus === 'SELECTED' ? true : false;
+			case 'SELECTION_ELEMENT': {
+				const selectionStatus = block.SelectionStatus === 'SELECTED';
 				if (!response.text.selections) response.text.selections = [];
 				response.text.selections.push({
 					selected: selectionStatus,
@@ -143,6 +145,7 @@ export function categorizeTextractBlocks(
 					blockMap[block.Id] = block;
 				}
 				break;
+			}
 			case 'TABLE':
 				tableBlocks.push(block);
 				break;
@@ -166,14 +169,14 @@ export function categorizeTextractBlocks(
 
 	// Post-process complex structures if they exist.
 	if (tableBlocks.length !== 0) {
-		const tableResponse: Table[] = Array();
+		const tableResponse: Table[] = [];
 		tableBlocks.forEach(table => {
 			tableResponse.push(constructTable(table, blockMap));
 		});
 		response.text.tables = tableResponse;
 	}
 	if (keyValueBlocks.length !== 0) {
-		const keyValueResponse: KeyValue[] = Array();
+		const keyValueResponse: KeyValue[] = [];
 		keyValueBlocks.forEach(keyValue => {
 			// We need the KeyValue blocks of EntityType = `KEY`, which has both key and value references.
 			if (keyValue.EntityTypes) {
@@ -185,6 +188,7 @@ export function categorizeTextractBlocks(
 		});
 		response.text.keyValues = keyValueResponse;
 	}
+
 	return response;
 }
 
@@ -193,12 +197,8 @@ export function categorizeTextractBlocks(
  * @param {Block} table - Table block that has references (`Relationships`) to its cells
  * @param {[id: string]: Block} blockMap - Maps block Ids to blocks.
  */
-function constructTable(
-	table: Block,
-	blockMap: { [key: string]: Block },
-): Table {
-	let tableMatrix: TableCell[][];
-	tableMatrix = [];
+function constructTable(table: Block, blockMap: Record<string, Block>): Table {
+	const tableMatrix: TableCell[][] = [];
 	// visit each of the cell associated with the table's relationship.
 	for (const tableRelation of table.Relationships ?? []) {
 		for (const cellId of tableRelation.Ids ?? []) {
@@ -225,6 +225,7 @@ function constructTable(
 	const columnSize = tableMatrix[0].length;
 	const boundingBox = getBoundingBox(table.Geometry);
 	const polygon = getPolygon(table.Geometry);
+
 	// Note that we leave spanned cells undefined for distinction
 	return {
 		size: { rows: rowSize, columns: columnSize },
@@ -241,11 +242,11 @@ function constructTable(
  */
 function constructKeyValue(
 	keyBlock: Block,
-	blockMap: { [key: string]: Block },
+	blockMap: Record<string, Block>,
 ): KeyValue {
-	let keyText: string = '';
-	let valueText: string = '';
-	let valueSelected: boolean = false;
+	let keyText = '';
+	let valueText = '';
+	let valueSelected = false;
 	for (const keyValueRelation of keyBlock.Relationships ?? []) {
 		if (keyValueRelation.Type === 'CHILD') {
 			// relation refers to key
@@ -261,6 +262,7 @@ function constructKeyValue(
 			}
 		}
 	}
+
 	return {
 		key: keyText,
 		value: { text: valueText, selected: valueSelected },
@@ -276,10 +278,10 @@ function constructKeyValue(
  */
 function extractContentsFromBlock(
 	block: Block,
-	blockMap: { [id: string]: Block },
+	blockMap: Record<string, Block>,
 ): Content {
-	let words: string = '';
-	let isSelected: boolean = false;
+	let words = '';
+	let isSelected = false;
 
 	if (!block.Relationships) {
 		// some block might have no content
@@ -291,11 +293,12 @@ function extractContentsFromBlock(
 			if (contentBlock.BlockType === 'WORD') {
 				words += contentBlock.Text + ' ';
 			} else if (contentBlock.BlockType === 'SELECTION_ELEMENT') {
-				isSelected = contentBlock.SelectionStatus === 'SELECTED' ? true : false;
+				isSelected = contentBlock.SelectionStatus === 'SELECTED';
 			}
 		}
 	}
 
 	words = words.substr(0, words.length - 1); // remove trailing space.
+
 	return { text: words, selected: isSelected };
 }

package/src/providers/Utils.ts

@@ -7,14 +7,15 @@
 export function makeCamelCase(obj?: any, keys?: string[]) {
 	if (!obj) return undefined;
 	const newObj = {};
-	const keysToRename = keys ? keys : Object.keys(obj);
+	const keysToRename = keys || Object.keys(obj);
 	keysToRename.forEach(key => {
-		if (obj.hasOwnProperty(key)) {
+		if (Object.prototype.hasOwnProperty.call(obj, key)) {
 			// change the key to camelcase.
 			const camelCaseKey = key.charAt(0).toLowerCase() + key.substr(1);
 			Object.assign(newObj, { [camelCaseKey]: obj[key] });
 		}
 	});
+
 	return newObj;
 }
 
@@ -23,6 +24,7 @@ export function makeCamelCase(obj?: any, keys?: string[]) {
  */
 export function makeCamelCaseArray(objArr?: object[], keys?: string[]) {
 	if (!objArr) return undefined;
+
 	return objArr.map(obj => makeCamelCase(obj, keys));
 }
 
@@ -30,18 +32,18 @@ export function makeCamelCaseArray(objArr?: object[], keys?: string[]) {
  * Converts blob to array buffer
  */
 export function blobToArrayBuffer(blob: Blob): Promise<Uint8Array> {
-	return new Promise((res, rej) => {
+	return new Promise((resolve, reject) => {
 		const reader = new FileReader();
 		reader.onload = _event => {
-			res(reader.result as Uint8Array);
+			resolve(reader.result as Uint8Array);
 		};
 		reader.onerror = err => {
-			rej(err);
+			reject(err);
 		};
 		try {
 			reader.readAsArrayBuffer(blob);
 		} catch (err) {
-			rej(err); // in case user gives invalid type
+			reject(err); // in case user gives invalid type
 		}
 	});
 }

package/src/providers/index.ts

@@ -3,6 +3,7 @@
 import { AmazonAIConvertPredictionsProvider } from './AmazonAIConvertPredictionsProvider';
 import { AmazonAIIdentifyPredictionsProvider } from './AmazonAIIdentifyPredictionsProvider';
 import { AmazonAIInterpretPredictionsProvider } from './AmazonAIInterpretPredictionsProvider';
+
 export {
 	AmazonAIConvertPredictionsProvider,
 	AmazonAIIdentifyPredictionsProvider,

package/src/types/AWSTypes.ts

@@ -1,6 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-/* tslint:disable:max-line-length */
 import { Geometry, Relationship } from './Predictions';
 
 export type BlockList = Block[];
@@ -61,13 +60,13 @@ export interface Block {
 	/**
 	 * <p>A list of child blocks of the current block. For example a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:</p> <ul> <li> <p>0 - The block has no child blocks.</p> </li> <li> <p>1 - The block has child blocks.</p> </li> </ul>
 	 */
-	Relationships?: Array<Relationship> | Iterable<Relationship>;
+	Relationships?: Relationship[] | Iterable<Relationship>;
 
 	/**
 	 * <p>The type of entity. The following can be returned:</p> <ul> <li> <p> <i>KEY</i> - An identifier for a field on the document.</p> </li> <li> <p> <i>VALUE</i> - The field text.</p> </li> </ul> <p> <code>EntityTypes</code> isn't returned by <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>.</p>
 	 */
 	EntityTypes?:
-		| Array<'KEY' | 'VALUE' | string>
+		| ('KEY' | 'VALUE' | string)[]
 		| Iterable<'KEY' | 'VALUE' | string>;
 
 	/**