@aws-amplify/api-graphql 4.0.1-console-preview.11cf989.0 → 4.0.1-console-preview.4ae78ed.0

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

@@ -1,8 +1,7 @@
 import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
-import { DocumentType } from '@aws-amplify/api-rest';
-import { GraphQLAuthModeKeys } from '@aws-amplify/core/internals/utils';
+import { APIAuthMode, DocumentType } from '@aws-amplify/core/internals/utils';
 export { CONTROL_MSG, ConnectionState } from './PubSub';
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
@@ -10,7 +9,7 @@ export { CONTROL_MSG, ConnectionState } from './PubSub';
 export interface GraphQLOptions {
     query: string | DocumentNode;
     variables?: Record<string, DocumentType>;
-    authMode?: string;
+    authMode?: APIAuthMode;
     authToken?: string;
     /**
      * @deprecated This property should not be used
@@ -73,7 +72,7 @@ export declare type GraphqlSubscriptionMessage<T> = {
 };
 export interface AWSAppSyncRealTimeProviderOptions {
     appSyncGraphqlEndpoint?: string;
-    authenticationType?: GraphQLAuthModeKeys;
+    authenticationType?: APIAuthMode;
     query?: string;
     variables?: Record<string, unknown>;
     apiKey?: string;
@@ -105,7 +104,7 @@ export declare type GraphQLOperation = Source | string;
 export interface GraphQLOptionsV6<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string> {
     query: TYPED_GQL_STRING | DocumentNode;
     variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-    authMode?: GraphQLAuthModeKeys;
+    authMode?: APIAuthMode;
     authToken?: string;
     /**
      * @deprecated This property should not be used

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

@@ -4,5 +4,5 @@
 export declare const resolveConfig: () => {
     endpoint: string;
     region: string;
-    defaultAuthMode: import("@aws-amplify/core/lib-esm/libraryUtils").GraphQLAuthMode;
+    defaultAuthMode: import("@aws-amplify/core/lib-esm/libraryUtils").APIAuthMode;
 };

package/lib-esm/utils/resolveConfig.js

@@ -7,7 +7,7 @@ import { APIValidationErrorCode, assertValidationError } from './errors';
  */
 export var resolveConfig = function () {
     var _a, _b;
-    var _c = (_b = (_a = Amplify.getConfig().API) === null || _a === void 0 ? void 0 : _a.AppSync) !== null && _b !== void 0 ? _b : {}, region = _c.region, defaultAuthMode = _c.defaultAuthMode, endpoint = _c.endpoint;
+    var _c = (_b = (_a = Amplify.getConfig().API) === null || _a === void 0 ? void 0 : _a.GraphQL) !== null && _b !== void 0 ? _b : {}, region = _c.region, defaultAuthMode = _c.defaultAuthMode, endpoint = _c.endpoint;
     assertValidationError(!!endpoint, APIValidationErrorCode.NoAppId);
     assertValidationError(!!region, APIValidationErrorCode.NoRegion);
     assertValidationError(!!defaultAuthMode, APIValidationErrorCode.NoDefaultAuthMode);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.0.1-console-preview.11cf989.0+11cf989",
+	"version": "4.0.1-console-preview.4ae78ed.0+4ae78ed",
 	"description": "Api-graphql category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -47,13 +47,14 @@
 		"internals"
 	],
 	"dependencies": {
-		"@aws-amplify/api-rest": "4.0.1-console-preview.11cf989.0+11cf989",
-		"@aws-amplify/auth": "6.0.1-console-preview.11cf989.0+11cf989",
-		"@aws-amplify/core": "6.0.1-console-preview.11cf989.0+11cf989",
+		"@aws-amplify/api-rest": "4.0.1-console-preview.4ae78ed.0+4ae78ed",
+		"@aws-amplify/auth": "6.0.1-console-preview.4ae78ed.0+4ae78ed",
+		"@aws-amplify/core": "6.0.1-console-preview.4ae78ed.0+4ae78ed",
 		"@aws-sdk/types": "3.387.0",
 		"graphql": "15.8.0",
 		"rxjs": "^7.8.1",
 		"tslib": "^1.8.0",
+		"url": "0.11.0",
 		"uuid": "^3.2.1"
 	},
 	"size-limit": [
@@ -120,5 +121,5 @@
 			"<rootDir>/__tests__"
 		]
 	},
-	"gitHead": "11cf9890e0229d7f36a7b2375e57bc0decf9935a"
+	"gitHead": "4ae78ed23fc03ae718488c98fc48782d2bd6f5f3"
 }

package/src/GraphQLAPI.ts

@@ -35,6 +35,24 @@ export class GraphQLAPIClass extends InternalGraphQLAPIClass {
 	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
 		return super.graphql(options, additionalHeaders);
 	}
+
+	/**
+	 * 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);

package/src/Providers/AWSAppSyncRealTimeProvider/index.ts

@@ -6,16 +6,24 @@ import * as url from 'url';
 import { v4 as uuid } from 'uuid';
 import { Buffer } from 'buffer';
 import { Hub, fetchAuthSession } from '@aws-amplify/core';
+import { signRequest } from '@aws-amplify/core/internals/aws-client-utils';
+import {
+	APIAuthMode,
+	CustomUserAgentDetails,
+	Logger,
+	NonRetryableError,
+	USER_AGENT_HEADER,
+	getAmplifyUserAgent,
+	isNonRetryableError,
+	jitteredExponentialRetry,
+	DocumentType,
+} from '@aws-amplify/core/internals/utils';
 
 import {
 	CONTROL_MSG,
 	ConnectionState,
-	PubSubContent,
 	PubSubContentObserver,
 } from '../../types/PubSub';
-
-import { signRequest } from '@aws-amplify/core/internals/aws-client-utils';
-
 import {
 	AMPLIFY_SYMBOL,
 	AWS_APPSYNC_REALTIME_HEADERS,
@@ -39,18 +47,6 @@ import {
 	ReconnectionMonitor,
 } from '../../utils/ReconnectionMonitor';
 
-import {
-	CustomUserAgentDetails,
-	Logger,
-	NonRetryableError,
-	USER_AGENT_HEADER,
-	getAmplifyUserAgent,
-	isNonRetryableError,
-	jitteredExponentialRetry,
-	GraphQLAuthMode,
-} from '@aws-amplify/core/internals/utils';
-import { DocumentType } from '@aws-amplify/api-rest';
-
 const logger = new Logger('AWSAppSyncRealTimeProvider');
 
 const dispatchApiEvent = payload => {
@@ -92,7 +88,7 @@ type ParsedMessagePayload = {
 
 export interface AWSAppSyncRealTimeProviderOptions {
 	appSyncGraphqlEndpoint?: string;
-	authenticationType?: GraphQLAuthMode;
+	authenticationType?: APIAuthMode;
 	query?: string;
 	variables?: Record<string, DocumentType>;
 	apiKey?: string;
@@ -197,6 +193,7 @@ export class AWSAppSyncRealTimeProvider {
 			variables,
 			authenticationType,
 			additionalHeaders,
+			apiKey,
 		} = options || {};
 
 		return new Observable(observer => {
@@ -227,6 +224,7 @@ export class AWSAppSyncRealTimeProvider {
 									authenticationType,
 									appSyncGraphqlEndpoint,
 									additionalHeaders,
+									apiKey,
 								},
 								observer,
 								subscriptionId,
@@ -875,6 +873,7 @@ export class AWSAppSyncRealTimeProvider {
 	}
 
 	private async _awsRealTimeHeaderBasedAuth({
+		apiKey,
 		authenticationType,
 		payload,
 		canonicalUri,
@@ -885,32 +884,34 @@ export class AWSAppSyncRealTimeProvider {
 		Record<string, unknown> | undefined
 	> {
 		const headerHandler: {
-			[key: string]: (arg0: AWSAppSyncRealTimeAuthInput) => {};
+			[key in APIAuthMode]: (arg0: AWSAppSyncRealTimeAuthInput) => {};
 		} = {
 			apiKey: this._awsRealTimeApiKeyHeader.bind(this),
 			iam: this._awsRealTimeIAMHeader.bind(this),
-			jwt: this._awsRealTimeOPENIDHeader.bind(this),
-			custom: this._customAuthHeader,
+			oidc: this._awsAuthTokenHeader.bind(this),
+			userPool: this._awsAuthTokenHeader.bind(this),
+			lambda: this._customAuthHeader,
+			none: this._customAuthHeader,
 		};
 
-		if (!authenticationType || !headerHandler[authenticationType.type]) {
+		if (!authenticationType || !headerHandler[authenticationType]) {
 			logger.debug(`Authentication type ${authenticationType} not supported`);
 			return undefined;
 		} else {
-			const handler = headerHandler[authenticationType.type];
+			const handler = headerHandler[authenticationType];
 
 			const { host } = url.parse(appSyncGraphqlEndpoint ?? '');
 
 			logger.debug(`Authenticating with ${JSON.stringify(authenticationType)}`);
-			let apiKey;
-			if (authenticationType.type === 'apiKey') {
-				apiKey = authenticationType.apiKey;
+			let resolvedApiKey;
+			if (authenticationType === 'apiKey') {
+				resolvedApiKey = apiKey;
 			}
 			const result = await handler({
 				payload,
 				canonicalUri,
 				appSyncGraphqlEndpoint,
-				apiKey,
+				apiKey: resolvedApiKey,
 				region,
 				host,
 				additionalHeaders,
@@ -920,9 +921,7 @@ export class AWSAppSyncRealTimeProvider {
 		}
 	}
 
-	private async _awsRealTimeOPENIDHeader({
-		host,
-	}: AWSAppSyncRealTimeAuthInput) {
+	private async _awsAuthTokenHeader({ host }: AWSAppSyncRealTimeAuthInput) {
 		const session = await fetchAuthSession();
 
 		return {

package/src/internals/InternalGraphQLAPI.ts

@@ -11,6 +11,7 @@ import {
 import { Observable } from 'rxjs';
 import { Amplify, Cache, fetchAuthSession } from '@aws-amplify/core';
 import {
+	APIAuthMode,
 	CustomUserAgentDetails,
 	ConsoleLogger as Logger,
 	getAmplifyUserAgent,
@@ -21,7 +22,12 @@ import {
 	GraphQLOperation,
 	GraphQLOptions,
 } from '../types';
-import { post } from '@aws-amplify/api-rest';
+import { isCancelError as isCancelErrorREST } from '@aws-amplify/api-rest';
+import {
+	post,
+	cancel as cancelREST,
+	updateRequestToBeCancellable,
+} from '@aws-amplify/api-rest/internals';
 import { AWSAppSyncRealTimeProvider } from '../Providers/AWSAppSyncRealTimeProvider';
 
 const USER_AGENT_HEADER = 'x-amz-user-agent';
@@ -49,7 +55,7 @@ export class InternalGraphQLAPIClass {
 	private appSyncRealTime: AWSAppSyncRealTimeProvider | null;
 
 	Cache = Cache;
-	private _api = { post };
+	private _api = { post, updateRequestToBeCancellable };
 
 	/**
 	 * Initialize GraphQL API with AWS configuration
@@ -65,26 +71,27 @@ export class InternalGraphQLAPIClass {
 	}
 
 	private async _headerBasedAuth(
-		defaultAuthenticationType?,
-		additionalHeaders: { [key: string]: string } = {},
-		customUserAgentDetails?: CustomUserAgentDetails
+		authMode: APIAuthMode,
+		additionalHeaders: { [key: string]: string } = {}
 	) {
 		const config = Amplify.getConfig();
 		const {
 			region: region,
 			endpoint: appSyncGraphqlEndpoint,
-			defaultAuthMode: authenticationType,
-		} = config.API.AppSync;
+			apiKey,
+			defaultAuthMode,
+		} = config.API.GraphQL;
 
+		const authenticationType = authMode || defaultAuthMode || 'iam';
 		let headers = {};
 
-		switch (authenticationType.type) {
+		switch (authenticationType) {
 			case 'apiKey':
-				if (!authenticationType.apiKey) {
+				if (!apiKey) {
 					throw new Error(GraphQLAuthError.NO_API_KEY);
 				}
 				headers = {
-					'X-Api-Key': authenticationType.apiKey,
+					'X-Api-Key': apiKey,
 				};
 				break;
 			case 'iam':
@@ -93,7 +100,8 @@ export class InternalGraphQLAPIClass {
 					throw new Error(GraphQLAuthError.NO_CREDENTIALS);
 				}
 				break;
-			case 'jwt':
+			case 'oidc':
+			case 'userPool':
 				try {
 					let token;
 
@@ -109,7 +117,7 @@ export class InternalGraphQLAPIClass {
 					throw new Error(GraphQLAuthError.NO_CURRENT_USER);
 				}
 				break;
-			case 'custom':
+			case 'lambda':
 				if (!additionalHeaders.Authorization) {
 					throw new Error(GraphQLAuthError.NO_AUTH_TOKEN);
 				}
@@ -117,6 +125,8 @@ export class InternalGraphQLAPIClass {
 					Authorization: additionalHeaders.Authorization,
 				};
 				break;
+			case 'none':
+				break;
 			default:
 				headers = {
 					Authorization: null,
@@ -173,11 +183,17 @@ export class InternalGraphQLAPIClass {
 		switch (operationType) {
 			case 'query':
 			case 'mutation':
+				const abortController = new AbortController();
 				const responsePromise = this._graphql<T>(
 					{ query, variables, authMode },
 					headers,
+					abortController,
 					customUserAgentDetails
 				);
+				this._api.updateRequestToBeCancellable(
+					responsePromise,
+					abortController
+				);
 				return responsePromise;
 			case 'subscription':
 				return this._graphqlSubscribe(
@@ -193,30 +209,23 @@ export class InternalGraphQLAPIClass {
 	private async _graphql<T = any>(
 		{ query, variables, authMode }: GraphQLOptions,
 		additionalHeaders = {},
+		abortController: AbortController,
 		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<GraphQLResult<T>> {
 		const config = Amplify.getConfig();
 
 		const { region: region, endpoint: appSyncGraphqlEndpoint } =
-			config.API.AppSync;
+			config.API.GraphQL;
 
 		const customGraphqlEndpoint = null;
 		const customEndpointRegion = null;
 
 		const headers = {
 			...(!customGraphqlEndpoint &&
-				(await this._headerBasedAuth(
-					authMode,
-					additionalHeaders,
-					customUserAgentDetails
-				))),
+				(await this._headerBasedAuth(authMode, additionalHeaders))),
 			...(customGraphqlEndpoint &&
 				(customEndpointRegion
-					? await this._headerBasedAuth(
-							authMode,
-							additionalHeaders,
-							customUserAgentDetails
-					  )
+					? await this._headerBasedAuth(authMode, additionalHeaders)
 					: { Authorization: null })),
 			...additionalHeaders,
 			...(!customGraphqlEndpoint && {
@@ -242,13 +251,30 @@ export class InternalGraphQLAPIClass {
 
 		let response;
 		try {
-			response = await this._api.post(endpoint, {
-				headers,
-				body,
-				region,
-				serviceName: 'appsync',
+			const { body: responseBody } = await this._api.post({
+				url: new URL(endpoint),
+				options: {
+					headers,
+					body,
+					signingServiceInfo: {
+						service: 'appsync',
+						region,
+					},
+				},
+				abortController,
 			});
+
+			const result = await responseBody.json();
+
+			response = result;
 		} catch (err) {
+			// If the exception is because user intentionally
+			// cancelled the request, do not modify the exception
+			// so that clients can identify the exception correctly.
+			if (isCancelErrorREST(err)) {
+				throw err;
+			}
+
 			response = {
 				data: {},
 				errors: [new GraphQLError(err.message, null, null, null, null, err)],
@@ -264,27 +290,45 @@ export class InternalGraphQLAPIClass {
 		return response;
 	}
 
+	/**
+	 * Checks to see if an error thrown is from an api request cancellation
+	 * @param {any} error - Any error
+	 * @return {boolean} - A boolean indicating if the error was from an api request cancellation
+	 */
+	isCancelError(error: any): boolean {
+		return isCancelErrorREST(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 cancelREST(request, message);
+	}
+
 	private _graphqlSubscribe(
-		{
-			query,
-			variables,
-			authMode: defaultAuthenticationType,
-			authToken,
-		}: GraphQLOptions,
+		{ query, variables, authMode }: GraphQLOptions,
 		additionalHeaders = {},
 		customUserAgentDetails?: CustomUserAgentDetails
 	): Observable<any> {
-		const { AppSync } = Amplify.getConfig().API ?? {};
+		const { GraphQL } = Amplify.getConfig().API ?? {};
 		if (!this.appSyncRealTime) {
 			this.appSyncRealTime = new AWSAppSyncRealTimeProvider();
 		}
-		return this.appSyncRealTime.subscribe({
-			query: print(query as DocumentNode),
-			variables,
-			appSyncGraphqlEndpoint: AppSync?.endpoint,
-			region: AppSync?.region,
-			authenticationType: AppSync?.defaultAuthMode,
-		});
+		return this.appSyncRealTime.subscribe(
+			{
+				query: print(query as DocumentNode),
+				variables,
+				appSyncGraphqlEndpoint: GraphQL?.endpoint,
+				region: GraphQL?.region,
+				authenticationType: authMode ?? GraphQL?.defaultAuthMode,
+				apiKey: GraphQL?.apiKey,
+				additionalHeaders,
+			},
+			customUserAgentDetails
+		);
 	}
 }
 

package/src/internals/index.ts

@@ -5,4 +5,4 @@ export {
 	InternalGraphQLAPIClass,
 } from './InternalGraphQLAPI';
 
-export { graphql } from './v6';
+export { graphql, cancel, isCancelError } from './v6';

package/src/internals/v6.ts

@@ -103,4 +103,22 @@ export function graphql<
 	return result as any;
 }
 
+/**
+ * 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
+ */
+export function cancel(promise: Promise<any>, message?: string): boolean {
+	return GraphQLAPI.cancel(promise, message);
+}
+
+/**
+ * Checks to see if an error thrown is from an api request cancellation
+ * @param {any} error - Any error
+ * @returns - A boolean indicating if the error was from an api request cancellation
+ */
+export function isCancelError(error: any): boolean {
+	return GraphQLAPI.isCancelError(error);
+}
+
 export { GraphQLOptionsV6, GraphQLResponseV6 };

package/src/types/index.ts

@@ -4,8 +4,7 @@ import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
 
-import { DocumentType } from '@aws-amplify/api-rest';
-import { GraphQLAuthModeKeys } from '@aws-amplify/core/internals/utils';
+import { APIAuthMode, DocumentType } from '@aws-amplify/core/internals/utils';
 export { CONTROL_MSG, ConnectionState } from './PubSub';
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
@@ -13,7 +12,7 @@ export { CONTROL_MSG, ConnectionState } from './PubSub';
 export interface GraphQLOptions {
 	query: string | DocumentNode;
 	variables?: Record<string, DocumentType>;
-	authMode?: string;
+	authMode?: APIAuthMode;
 	authToken?: string;
 	/**
 	 * @deprecated This property should not be used
@@ -83,7 +82,7 @@ export type GraphqlSubscriptionMessage<T> = {
 
 export interface AWSAppSyncRealTimeProviderOptions {
 	appSyncGraphqlEndpoint?: string;
-	authenticationType?: GraphQLAuthModeKeys;
+	authenticationType?: APIAuthMode;
 	query?: string;
 	variables?: Record<string, unknown>;
 	apiKey?: string;
@@ -122,7 +121,7 @@ export interface GraphQLOptionsV6<
 > {
 	query: TYPED_GQL_STRING | DocumentNode;
 	variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-	authMode?: GraphQLAuthModeKeys;
+	authMode?: APIAuthMode;
 	authToken?: string;
 	/**
 	 * @deprecated This property should not be used

package/src/utils/resolveConfig.ts

@@ -9,7 +9,7 @@ import { APIValidationErrorCode, assertValidationError } from './errors';
  */
 export const resolveConfig = () => {
 	const { region, defaultAuthMode, endpoint } =
-		Amplify.getConfig().API?.AppSync ?? {};
+		Amplify.getConfig().API?.GraphQL ?? {};
 	assertValidationError(!!endpoint, APIValidationErrorCode.NoAppId);
 	assertValidationError(!!region, APIValidationErrorCode.NoRegion);
 	assertValidationError(