@aws-amplify/predictions 5.5.6-api-v6-models.b3abc9b.0 → 6.0.0

package/lib-esm/types/Predictions.d.ts

@@ -1,24 +1,8 @@
 /// <reference types="node" />
-/**
- * Base types
- */
-export interface PredictionsOptions {
-    [key: string]: any;
-}
-export interface ProviderOptions {
-    providerName?: string;
-}
 /**
  * Convert types
  */
-export declare enum InterpretTextCategories {
-    ALL = "ALL",
-    LANGUAGE = "LANGUAGE",
-    ENTITIES = "ENTITIES",
-    SENTIMENT = "SENTIMENT",
-    SYNTAX = "SYNTAX",
-    KEY_PHRASES = "KEY_PHRASES"
-}
+export type InterpretTextCategories = 'all' | 'language' | 'entities' | 'sentiment' | 'syntax' | 'keyPhrases';
 export interface InterpretTextInput {
     text: InterpretTextInputLanguage | InterpretTextOthers | InterpretTextAll;
 }
@@ -26,28 +10,29 @@ export interface InterpretTextInputLanguage {
     source: {
         text: string;
     };
-    type: InterpretTextCategories.LANGUAGE;
+    type: Extract<InterpretTextCategories, 'language'>;
 }
 export interface InterpretTextOthers {
     source: {
         text: string;
         language: string;
     };
-    type: InterpretTextCategories.ENTITIES | InterpretTextCategories.SENTIMENT | InterpretTextCategories.SYNTAX | InterpretTextCategories.KEY_PHRASES;
+    type: Extract<InterpretTextCategories, 'entities' | 'sentiment' | 'syntax' | 'keyPhrases'>;
 }
 export interface InterpretTextAll {
     source: {
         text: string;
     };
-    type: InterpretTextCategories.ALL;
+    type: Extract<InterpretTextCategories, 'all'>;
 }
 export interface TextEntities {
-    type: string;
-    text: string;
-}
-export interface KeyPhrases {
-    text: string;
+    type?: string;
+    text?: string;
 }
+export type KeyPhrases = KeyPhrase[];
+export type KeyPhrase = {
+    text?: string;
+};
 export interface TextSyntax {
     text: string;
     syntax: string;
@@ -59,11 +44,15 @@ export interface TextSentiment {
     neutral: number;
     mixed: number;
 }
+export type DetectParams = {
+    Text: string;
+    LanguageCode: string;
+};
 export interface InterpretTextOutput {
     textInterpretation: {
         language?: string;
         textEntities?: Array<TextEntities>;
-        keyPhrases?: Array<KeyPhrases>;
+        keyPhrases?: KeyPhrases;
         sentiment?: TextSentiment;
         syntax?: Array<TextSyntax>;
     };
@@ -99,27 +88,34 @@ export interface TextToSpeechOutput {
 }
 export interface StorageSource {
     key: string;
-    level?: 'public' | 'private' | 'protected';
+    level?: 'guest' | 'private' | 'protected';
     identityId?: string;
 }
 export interface FileSource {
     file: File;
 }
-export interface BytesSource {
-    bytes: Buffer | ArrayBuffer | Blob | string;
+export type ConvertBytes = Buffer | ArrayBuffer | string;
+export type IdentifyBytes = ConvertBytes | Blob;
+export interface BytesSource<T> {
+    bytes: T;
 }
 export interface SpeechToTextInput {
     transcription: {
-        source: BytesSource;
+        source: BytesSource<ConvertBytes>;
         language?: string;
     };
 }
+export type TranscribeData = {
+    connection: WebSocket;
+    raw: ConvertBytes;
+    languageCode: string;
+};
 export interface SpeechToTextOutput {
     transcription: {
         fullText: string;
     };
 }
-export declare type IdentifySource = StorageSource | FileSource | BytesSource;
+export type IdentifySource = StorageSource | FileSource | BytesSource<IdentifyBytes>;
 export interface IdentifyTextInput {
     text: {
         source: IdentifySource;
@@ -153,14 +149,14 @@ export interface Table {
         columns: number;
     };
     table: TableCell[][];
-    polygon: Polygon;
-    boundingBox: BoundingBox;
+    polygon?: Polygon;
+    boundingBox?: BoundingBox;
 }
 export interface KeyValue {
     key: string;
     value: Content;
-    polygon: Polygon;
-    boundingBox: BoundingBox;
+    polygon?: Polygon;
+    boundingBox?: BoundingBox;
 }
 export interface IdentifyTextOutput {
     text: {
@@ -172,8 +168,8 @@ export interface IdentifyTextOutput {
         tables?: Table[];
         selections?: {
             selected: boolean;
-            polygon: Polygon;
-            boundingBox: BoundingBox;
+            polygon?: Polygon;
+            boundingBox?: BoundingBox;
         }[];
     };
 }
@@ -187,7 +183,7 @@ export interface Point {
     x?: Number;
     y?: Number;
 }
-export declare type Polygon = Array<Point> | Iterable<Point>;
+export type Polygon = Array<Point> | Iterable<Point>;
 export interface BoundingBox {
     width?: Number;
     height?: Number;
@@ -196,8 +192,8 @@ export interface BoundingBox {
 }
 export interface IdentifyLabelsOutput {
     labels?: {
-        name: string;
-        boundingBoxes: BoundingBox[];
+        name?: string;
+        boundingBoxes?: (BoundingBox | undefined)[];
         metadata?: Object;
     }[];
     unsafe?: 'YES' | 'NO' | 'UNKNOWN';
@@ -227,24 +223,30 @@ export interface FaceAttributes {
     mustache?: boolean;
     eyesOpen?: boolean;
     mouthOpen?: boolean;
-    emotions?: string[];
-}
+    emotions?: (string | undefined)[];
+}
+export type EntityAgeRange = {
+    low?: Number;
+    high?: Number;
+};
+export type EntityLandmark = {
+    type?: string;
+    x?: number;
+    y?: number;
+};
+export type IdentifyEntity = {
+    boundingBox?: BoundingBox;
+    ageRange?: EntityAgeRange;
+    landmarks?: (EntityLandmark | undefined)[];
+    attributes?: FaceAttributes;
+    metadata?: object;
+};
 export interface IdentifyEntitiesOutput {
-    entities: {
-        boundingBox?: BoundingBox;
-        ageRange?: {
-            low?: Number;
-            high?: Number;
-        };
-        landmarks?: {
-            type?: string;
-            x?: number;
-            y?: number;
-        }[];
-        attributes?: FaceAttributes;
-        metadata?: object;
-    }[];
+    entities: IdentifyEntity[];
 }
+export declare function isValidConvertInput(obj: any): boolean;
+export declare function isValidIdentifyInput(obj: any): boolean;
+export declare function isValidInterpretInput(obj: any): boolean;
 export declare function isIdentifyFromCollection(obj: any): obj is IdentifyFromCollection;
 export declare function isIdentifyCelebrities(obj: any): obj is IdentifyCelebrities;
 export declare function isTranslateTextInput(obj: any): obj is TranslateTextInput;
@@ -252,11 +254,13 @@ export declare function isTextToSpeechInput(obj: any): obj is TextToSpeechInput;
 export declare function isSpeechToTextInput(obj: any): obj is SpeechToTextInput;
 export declare function isStorageSource(obj: any): obj is StorageSource;
 export declare function isFileSource(obj: any): obj is FileSource;
-export declare function isBytesSource(obj: any): obj is BytesSource;
+export declare function isConvertBytesSource(obj: any): obj is BytesSource<ConvertBytes>;
+export declare function isIdentifyBytesSource(obj: any): obj is BytesSource<IdentifyBytes>;
 export declare function isIdentifyTextInput(obj: any): obj is IdentifyTextInput;
 export declare function isIdentifyLabelsInput(obj: any): obj is IdentifyLabelsInput;
 export declare function isIdentifyEntitiesInput(obj: any): obj is IdentifyEntitiesInput;
 export declare function isInterpretTextInput(obj: any): obj is InterpretTextInput;
+export declare function isInterpretTextOthers(text: InterpretTextInput['text']): text is InterpretTextOthers;
 export interface Geometry {
     /**
      * <p>An axis-aligned coarse representation of the detected text's location on the image.</p>
@@ -277,5 +281,5 @@ export interface Relationship {
      */
     Ids?: Array<string> | Iterable<string>;
 }
-export declare type FeatureType = 'TABLES' | 'FORMS' | string;
-export declare type FeatureTypes = FeatureType[];
+export type FeatureType = 'TABLES' | 'FORMS' | string;
+export type FeatureTypes = FeatureType[];

package/lib-esm/types/Predictions.js

@@ -1,65 +1,72 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 /* tslint:disable:max-line-length */
-/**
- * Convert types
- */
-export var InterpretTextCategories;
-(function (InterpretTextCategories) {
-    InterpretTextCategories["ALL"] = "ALL";
-    InterpretTextCategories["LANGUAGE"] = "LANGUAGE";
-    InterpretTextCategories["ENTITIES"] = "ENTITIES";
-    InterpretTextCategories["SENTIMENT"] = "SENTIMENT";
-    InterpretTextCategories["SYNTAX"] = "SYNTAX";
-    InterpretTextCategories["KEY_PHRASES"] = "KEY_PHRASES";
-})(InterpretTextCategories || (InterpretTextCategories = {}));
+export function isValidConvertInput(obj) {
+    return (isTranslateTextInput(obj) ||
+        isTextToSpeechInput(obj) ||
+        isSpeechToTextInput(obj));
+}
+export function isValidIdentifyInput(obj) {
+    return (isIdentifyTextInput(obj) ||
+        isIdentifyLabelsInput(obj) ||
+        isIdentifyEntitiesInput(obj));
+}
+export function isValidInterpretInput(obj) {
+    return isInterpretTextInput(obj);
+}
 export function isIdentifyFromCollection(obj) {
-    var key = 'collection';
-    var keyId = 'collectionId';
+    const key = 'collection';
+    const keyId = 'collectionId';
     return obj && (obj.hasOwnProperty(key) || obj.hasOwnProperty(keyId));
 }
 export function isIdentifyCelebrities(obj) {
-    var key = 'celebrityDetection';
+    const key = 'celebrityDetection';
     return obj && obj.hasOwnProperty(key);
 }
 export function isTranslateTextInput(obj) {
-    var key = 'translateText';
+    const key = 'translateText';
     return obj && obj.hasOwnProperty(key);
 }
 export function isTextToSpeechInput(obj) {
-    var key = 'textToSpeech';
+    const key = 'textToSpeech';
     return obj && obj.hasOwnProperty(key);
 }
 export function isSpeechToTextInput(obj) {
-    var key = 'transcription';
+    const key = 'transcription';
     return obj && obj.hasOwnProperty(key);
 }
 export function isStorageSource(obj) {
-    var key = 'key';
+    const key = 'key';
     return obj && obj.hasOwnProperty(key);
 }
 export function isFileSource(obj) {
-    var key = 'file';
+    const key = 'file';
     return obj && obj.hasOwnProperty(key);
 }
-export function isBytesSource(obj) {
-    var key = 'bytes';
+export function isConvertBytesSource(obj) {
+    const key = 'bytes';
+    return obj && obj.hasOwnProperty(key);
+}
+export function isIdentifyBytesSource(obj) {
+    const key = 'bytes';
     return obj && obj.hasOwnProperty(key);
 }
 export function isIdentifyTextInput(obj) {
-    var key = 'text';
+    const key = 'text';
     return obj && obj.hasOwnProperty(key);
 }
 export function isIdentifyLabelsInput(obj) {
-    var key = 'labels';
+    const key = 'labels';
     return obj && obj.hasOwnProperty(key);
 }
 export function isIdentifyEntitiesInput(obj) {
-    var key = 'entities';
+    const key = 'entities';
     return obj && obj.hasOwnProperty(key);
 }
 export function isInterpretTextInput(obj) {
-    var key = 'text';
+    const key = 'text';
     return obj && obj.hasOwnProperty(key);
 }
-//# sourceMappingURL=Predictions.js.map
+export function isInterpretTextOthers(text) {
+    return text.source.language !== undefined;
+}

package/lib-esm/types/index.js

@@ -1,4 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 export * from './Predictions';
-//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/predictions",
-	"version": "5.5.6-api-v6-models.b3abc9b.0+b3abc9b",
+	"version": "6.0.0",
 	"description": "Machine learning category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -15,11 +15,11 @@
 	"scripts": {
 		"test": "npm run lint && jest -w 1 --passWithNoTests --coverage --maxWorkers 2",
 		"test:size": "size-limit",
-		"build-with-test": "npm run clean && npm test && tsc && webpack -p",
-		"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-with-test": "npm test && npm run build",
+		"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 --watch",
 		"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*",
@@ -27,7 +27,7 @@
 		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
 		"generate-docs-local": "typedoc --out docs src",
 		"generate-docs-root": "typedoc --out ../../docs src",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 87.84"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 87.84"
 	},
 	"repository": {
 		"type": "git",
@@ -45,58 +45,49 @@
 		"src"
 	],
 	"dependencies": {
-		"@aws-amplify/core": "5.8.6-api-v6-models.b3abc9b.0+b3abc9b",
-		"@aws-amplify/storage": "5.9.6-api-v6-models.b3abc9b.0+b3abc9b",
-		"@aws-sdk/client-comprehend": "3.6.1",
-		"@aws-sdk/client-polly": "3.6.1",
-		"@aws-sdk/client-rekognition": "3.6.1",
-		"@aws-sdk/client-textract": "3.6.1",
-		"@aws-sdk/client-translate": "3.6.1",
-		"@aws-sdk/eventstream-marshaller": "3.6.1",
-		"@aws-sdk/util-utf8-node": "3.6.1",
+		"@aws-amplify/storage": "6.0.0",
+		"@aws-sdk/client-comprehend": "3.398.0",
+		"@aws-sdk/client-polly": "3.398.0",
+		"@aws-sdk/client-rekognition": "3.398.0",
+		"@aws-sdk/client-textract": "3.398.0",
+		"@aws-sdk/client-translate": "3.398.0",
+		"@smithy/eventstream-codec": "2.0.9",
+		"@smithy/util-utf8": "2.0.0",
 		"buffer": "4.9.2",
-		"tslib": "^1.8.0",
-		"uuid": "^3.2.1"
+		"tslib": "^2.5.0",
+		"uuid": "^9.0.0"
+	},
+	"peerDependencies": {
+		"@aws-amplify/core": "^6.0.0"
+	},
+	"devDependencies": {
+		"@aws-amplify/core": "6.0.0",
+		"typescript": "5.0.2"
 	},
 	"size-limit": [
 		{
-			"name": "Predictions (all providers)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Predictions, AmazonAIPredictionsProvider }",
-			"limit": "103.2 kB"
-		},
-		{
-			"name": "Predictions (Convert provider)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Predictions, AmazonAIConvertPredictionsProvider }",
-			"limit": "60.09 kB"
-		},
-		{
-			"name": "Predictions (Identify provider)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Predictions, AmazonAIIdentifyPredictionsProvider }",
-			"limit": "76.22 kB"
-		},
-		{
-			"name": "Predictions (Interpret provider)",
+			"name": "Predictions",
 			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Predictions, AmazonAIInterpretPredictionsProvider }",
-			"limit": "46.77 kB"
+			"import": "{ Amplify, Predictions }",
+			"limit": "66 kB"
 		}
 	],
 	"jest": {
 		"globals": {
 			"ts-jest": {
-				"diagnostics": false,
+				"diagnostics": {
+					"pathRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$"
+				},
 				"tsConfig": {
-					"lib": [
-						"es5",
-						"es2015",
-						"dom",
-						"esnext.asynciterable",
-						"es2017.object"
+					"downlevelIteration": true,
+					"allowJs": true,
+					"types": [
+						"@types/jest"
 					],
-					"allowJs": true
+					"outDir": "./tsconfig.json",
+					"noEmitOnError": false,
+					"noImplicitAny": false,
+					"skipLibCheck": true
 				}
 			}
 		},
@@ -128,5 +119,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "b3abc9b75f6f1353f4c2fbc10cd3369be498e9fc"
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }