@aws-amplify/api-graphql 3.4.12-unstable.7762f1a.0 → 4.0.0

package/lib-esm/utils/errors/APIError.d.ts

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

package/lib-esm/utils/errors/APIError.js

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AmplifyError, } from '@aws-amplify/core/internals/utils';
+/**
+ * @internal
+ */
+export class APIError extends 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 = APIError;
+        Object.setPrototypeOf(this, APIError.prototype);
+    }
+}

package/lib-esm/utils/errors/assertValidationError.d.ts

@@ -0,0 +1,5 @@
+import { APIValidationErrorCode } from './validation';
+/**
+ * @internal
+ */
+export declare function assertValidationError(assertion: boolean, name: APIValidationErrorCode): asserts assertion;

package/lib-esm/utils/errors/assertValidationError.js

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

package/lib-esm/utils/errors/index.d.ts

@@ -0,0 +1,3 @@
+export { APIError } from './APIError';
+export { assertValidationError } from './assertValidationError';
+export { APIValidationErrorCode, validationErrorMap } from './validation';

package/lib-esm/utils/errors/index.js

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

package/lib-esm/utils/errors/validation.d.ts

@@ -0,0 +1,7 @@
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+export declare enum APIValidationErrorCode {
+    NoAuthSession = "NoAuthSession",
+    NoRegion = "NoRegion",
+    NoCustomEndpoint = "NoCustomEndpoint"
+}
+export declare const validationErrorMap: AmplifyErrorMap<APIValidationErrorCode>;

package/lib-esm/utils/errors/validation.js

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export var APIValidationErrorCode;
+(function (APIValidationErrorCode) {
+    APIValidationErrorCode["NoAuthSession"] = "NoAuthSession";
+    APIValidationErrorCode["NoRegion"] = "NoRegion";
+    APIValidationErrorCode["NoCustomEndpoint"] = "NoCustomEndpoint";
+})(APIValidationErrorCode || (APIValidationErrorCode = {}));
+export const validationErrorMap = {
+    [APIValidationErrorCode.NoAuthSession]: {
+        message: 'Auth session should not be empty.',
+    },
+    // TODO: re-enable when working in all test environments:
+    // [APIValidationErrorCode.NoEndpoint]: {
+    // 	message: 'Missing endpoint',
+    // },
+    [APIValidationErrorCode.NoRegion]: {
+        message: 'Missing region.',
+    },
+    [APIValidationErrorCode.NoCustomEndpoint]: {
+        message: 'Custom endpoint region is present without custom endpoint.',
+    },
+};

package/lib-esm/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { resolveConfig } from './resolveConfig';
+export { resolveLibraryOptions } from './resolveLibraryOptions';

package/lib-esm/utils/index.js

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

package/lib-esm/utils/resolveConfig.d.ts

@@ -0,0 +1,12 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+/**
+ * @internal
+ */
+export declare const resolveConfig: (amplify: AmplifyClassV6) => {
+    apiKey: string | undefined;
+    customEndpoint: string | undefined;
+    customEndpointRegion: string | undefined;
+    defaultAuthMode: "apiKey" | "oidc" | "userPool" | "iam" | "lambda" | "none" | undefined;
+    endpoint: string | undefined;
+    region: string | undefined;
+};

package/lib-esm/utils/resolveConfig.js

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { APIValidationErrorCode, assertValidationError } from './errors';
+/**
+ * @internal
+ */
+export const resolveConfig = (amplify) => {
+    const { apiKey, customEndpoint, customEndpointRegion, defaultAuthMode, endpoint, region, } = amplify.getConfig().API?.GraphQL ?? {};
+    // TODO: re-enable when working in all test environments:
+    // assertValidationError(!!endpoint, APIValidationErrorCode.NoEndpoint);
+    assertValidationError(!(!customEndpoint && customEndpointRegion), APIValidationErrorCode.NoCustomEndpoint);
+    return {
+        apiKey,
+        customEndpoint,
+        customEndpointRegion,
+        defaultAuthMode,
+        endpoint,
+        region,
+    };
+};

package/lib-esm/utils/resolveLibraryOptions.d.ts

@@ -0,0 +1,11 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+/**
+ * @internal
+ */
+export declare const resolveLibraryOptions: (amplify: AmplifyClassV6) => {
+    headers: ((options: {
+        query: string;
+        variables?: Record<string, import("@aws-amplify/core/lib-esm/libraryUtils").DocumentType> | undefined;
+    }) => Promise<Record<string, string>>) | undefined;
+    withCredentials: boolean | undefined;
+};

package/lib-esm/utils/resolveLibraryOptions.js

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @internal
+ */
+export const resolveLibraryOptions = (amplify) => {
+    const headers = amplify.libraryOptions?.API?.GraphQL?.headers;
+    const withCredentials = amplify.libraryOptions?.API?.GraphQL?.withCredentials;
+    return { headers, withCredentials };
+};

package/package.json

@@ -1,116 +1,124 @@
 {
-  "name": "@aws-amplify/api-graphql",
-  "version": "3.4.12-unstable.7762f1a.0+7762f1a",
-  "description": "Api-graphql category of aws-amplify",
-  "main": "./lib/index.js",
-  "module": "./lib-esm/index.js",
-  "typings": "./lib-esm/index.d.ts",
-  "react-native": {
-    "./lib/index": "./lib-esm/index.js"
-  },
-  "sideEffects": [
-    "./lib/GraphQLAPI.js",
-    "./lib-esm/GraphQLAPI.js"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "npm run lint && jest --coverage",
-    "test:size": "size-limit",
-    "build-with-test": "npm test && npm run build",
-    "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": "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 75.62"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/aws-amplify/amplify-js.git"
-  },
-  "author": "Amazon Web Services",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/aws/aws-amplify/issues"
-  },
-  "homepage": "https://aws-amplify.github.io/",
-  "devDependencies": {
-    "@types/zen-observable": "^0.8.0"
-  },
-  "files": [
-    "lib",
-    "lib-esm",
-    "src",
-    "internals"
-  ],
-  "dependencies": {
-    "@aws-amplify/api-rest": "3.5.6-unstable.7762f1a.0+7762f1a",
-    "@aws-amplify/auth": "5.6.6-unstable.7762f1a.0+7762f1a",
-    "@aws-amplify/cache": "5.1.12-unstable.7762f1a.0+7762f1a",
-    "@aws-amplify/core": "5.8.6-unstable.7762f1a.0+7762f1a",
-    "@aws-amplify/pubsub": "5.5.6-unstable.7762f1a.0+7762f1a",
-    "graphql": "15.8.0",
-    "tslib": "^1.8.0",
-    "uuid": "^3.2.1",
-    "zen-observable-ts": "0.8.19"
-  },
-  "size-limit": [
-    {
-      "name": "API (GraphQL client)",
-      "path": "./lib-esm/index.js",
-      "import": "{ Amplify, GraphQLAPI }",
-      "limit": "89.52 kB"
-    }
-  ],
-  "jest": {
-    "globals": {
-      "ts-jest": {
-        "diagnostics": false,
-        "tsConfig": {
-          "lib": [
-            "es5",
-            "es2015",
-            "dom",
-            "esnext.asynciterable",
-            "es2017.object"
-          ],
-          "allowJs": true
-        }
-      }
-    },
-    "transform": {
-      "^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
-    },
-    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "json",
-      "jsx"
-    ],
-    "testEnvironment": "jsdom",
-    "testURL": "http://localhost/",
-    "coverageThreshold": {
-      "global": {
-        "branches": 0,
-        "functions": 0,
-        "lines": 0,
-        "statements": 0
-      }
-    },
-    "coveragePathIgnorePatterns": [
-      "/node_modules/",
-      "dist",
-      "lib",
-      "lib-esm"
-    ]
-  },
-  "gitHead": "7762f1a7076e622ec354c24539a3b57ce3ec4290"
+	"name": "@aws-amplify/api-graphql",
+	"version": "4.0.0",
+	"description": "Api-graphql category of aws-amplify",
+	"main": "./lib/index.js",
+	"module": "./lib-esm/index.js",
+	"typings": "./lib-esm/index.d.ts",
+	"react-native": {
+		"./lib/index": "./lib-esm/index.js"
+	},
+	"sideEffects": [
+		"./lib/GraphQLAPI.js",
+		"./lib-esm/GraphQLAPI.js"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"test": "npm run lint && jest -w 1 --coverage",
+		"test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
+		"build-with-test": "npm run clean && npm test && tsc && webpack",
+		"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*",
+		"format": "echo \"Not implemented\"",
+		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 70.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/aws-amplify/amplify-js.git"
+	},
+	"author": "Amazon Web Services",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/aws/aws-amplify/issues"
+	},
+	"homepage": "https://aws-amplify.github.io/",
+	"files": [
+		"lib",
+		"lib-esm",
+		"src",
+		"internals"
+	],
+	"dependencies": {
+		"@aws-amplify/api-rest": "4.0.0",
+		"@aws-amplify/auth": "6.0.0",
+		"@aws-amplify/core": "6.0.0",
+		"@aws-sdk/types": "3.387.0",
+		"graphql": "15.8.0",
+		"rxjs": "^7.8.1",
+		"tslib": "^2.5.0"
+	},
+	"size-limit": [
+		{
+			"name": "API (GraphQL client)",
+			"path": "./lib-esm/index.js",
+			"import": "{ Amplify, GraphQLAPI }",
+			"limit": "91.7 kB"
+		}
+	],
+	"jest": {
+		"globals": {
+			"ts-jest": {
+				"diagnostics": {
+					"pathRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$"
+				},
+				"tsConfig": {
+					"lib": [
+						"es5",
+						"es2015",
+						"dom",
+						"esnext.asynciterable",
+						"es2017.object"
+					],
+					"allowJs": true,
+					"noEmitOnError": false,
+					"strictNullChecks": true,
+					"types": [
+						"@types/jest"
+					]
+				}
+			}
+		},
+		"transform": {
+			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
+		},
+		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
+		"testPathIgnorePatterns": [
+			"<rootDir>/__tests__/helpers.ts",
+			"<rootDir>/__tests__/fixtures/",
+			"<rootDir>/__tests__/utils/"
+		],
+		"moduleFileExtensions": [
+			"ts",
+			"tsx",
+			"js",
+			"json",
+			"jsx"
+		],
+		"testEnvironment": "jsdom",
+		"testURL": "http://localhost/",
+		"coverageThreshold": {
+			"global": {
+				"branches": 0,
+				"functions": 0,
+				"lines": 0,
+				"statements": 0
+			}
+		},
+		"coveragePathIgnorePatterns": [
+			"<rootDir>/node_modules/",
+			"<rootDir>/dist",
+			"<rootDir>/lib",
+			"<rootDir>/lib-esm",
+			"<rootDir>/__tests__"
+		]
+	},
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }

package/src/GraphQLAPI.ts

@@ -1,9 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { Amplify } from '@aws-amplify/core';
+import { AmplifyClassV6 } from '@aws-amplify/core';
+import { Category, ApiAction } from '@aws-amplify/core/internals/utils';
 import { GraphQLOptions, GraphQLResult } from './types';
 import { InternalGraphQLAPIClass } from './internals';
-import Observable from 'zen-observable-ts';
+import { Observable } from 'rxjs';
 
 export const graphqlOperation = (
 	query,
@@ -31,12 +32,33 @@ export class GraphQLAPIClass extends InternalGraphQLAPIClass {
 	 * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
 	 */
 	graphql<T = any>(
+		amplify: AmplifyClassV6 | (() => Promise<AmplifyClassV6>),
 		options: GraphQLOptions,
 		additionalHeaders?: { [key: string]: string }
 	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
-		return super.graphql(options, additionalHeaders);
+		return super.graphql(amplify, options, additionalHeaders, {
+			category: Category.API,
+			action: ApiAction.GraphQl,
+		});
+	}
+
+	/**
+	 * Checks to see if an error thrown is from an api request cancellation
+	 * @param error - Any error
+	 * @returns A boolean indicating if the error was from an api request cancellation
+	 */
+	isCancelError(error: any): boolean {
+		return super.isCancelError(error);
+	}
+
+	/**
+	 * Cancels an inflight request. Only applicable for graphql queries and mutations
+	 * @param {any} request - request to cancel
+	 * @returns A boolean indicating if the request was cancelled
+	 */
+	cancel(request: Promise<any>, message?: string): boolean {
+		return super.cancel(request, message);
 	}
 }
 
 export const GraphQLAPI = new GraphQLAPIClass(null);
-Amplify.register(GraphQLAPI);