@aws-amplify/api-graphql 4.0.17-unstable.e316a2e.0 → 4.0.17

package/src/GraphQLAPI.ts

@@ -10,7 +10,7 @@ import { Observable } from 'rxjs';
 export const graphqlOperation = (
 	query: any,
 	variables = {},
-	authToken?: string
+	authToken?: string,
 ) => ({
 	query,
 	variables,
@@ -35,7 +35,7 @@ export class GraphQLAPIClass extends InternalGraphQLAPIClass {
 	graphql<T = any>(
 		amplify: AmplifyClassV6 | (() => Promise<AmplifyClassV6>),
 		options: GraphQLOptions,
-		additionalHeaders?: CustomHeaders
+		additionalHeaders?: CustomHeaders,
 	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
 		return super.graphql(amplify, options, additionalHeaders, {
 			category: Category.API,

package/src/Providers/AWSAppSyncRealTimeProvider/index.ts

@@ -158,7 +158,7 @@ export class AWSAppSyncRealTimeProvider {
 					) {
 						this.reconnectionMonitor.record(ReconnectEvent.HALT_RECONNECT);
 					}
-				}
+				},
 			);
 	}
 
@@ -191,7 +191,7 @@ export class AWSAppSyncRealTimeProvider {
 
 	subscribe(
 		options?: AWSAppSyncRealTimeProviderOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
+		customUserAgentDetails?: CustomUserAgentDetails,
 	): Observable<Record<string, unknown>> {
 		const {
 			appSyncGraphqlEndpoint,
@@ -211,7 +211,7 @@ export class AWSAppSyncRealTimeProvider {
 					errors: [
 						{
 							...new GraphQLError(
-								`Subscribe only available for AWS AppSync endpoint`
+								`Subscribe only available for AWS AppSync endpoint`,
 							),
 						},
 					],
@@ -242,7 +242,7 @@ export class AWSAppSyncRealTimeProvider {
 								customUserAgentDetails,
 							}).catch<any>(err => {
 								logger.debug(
-									`${CONTROL_MSG.REALTIME_SUBSCRIPTION_INIT_ERROR}: ${err}`
+									`${CONTROL_MSG.REALTIME_SUBSCRIPTION_INIT_ERROR}: ${err}`,
 								);
 
 								this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
@@ -428,13 +428,13 @@ export class AWSAppSyncRealTimeProvider {
 	private _logStartSubscriptionError(
 		subscriptionId: string,
 		observer: PubSubContentObserver,
-		err: { message?: string }
+		err: { message?: string },
 	) {
 		logger.debug({ err });
 		const message = String(err.message ?? '');
 		// Resolving to give the state observer time to propogate the update
 		Promise.resolve(
-			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED)
+			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED),
 		);
 
 		// Capture the error only when the network didn't cause disruption
@@ -447,7 +447,7 @@ export class AWSAppSyncRealTimeProvider {
 					errors: [
 						{
 							...new GraphQLError(
-								`${CONTROL_MSG.CONNECTION_FAILED}: ${message}`
+								`${CONTROL_MSG.CONNECTION_FAILED}: ${message}`,
 							),
 						},
 					],
@@ -558,7 +558,7 @@ export class AWSAppSyncRealTimeProvider {
 			return;
 		}
 		logger.debug(
-			`subscription message from AWS AppSync RealTime: ${message.data}`
+			`subscription message from AWS AppSync RealTime: ${message.data}`,
 		);
 		const {
 			id = '',
@@ -587,7 +587,7 @@ export class AWSAppSyncRealTimeProvider {
 
 		if (type === MESSAGE_TYPES.GQL_START_ACK) {
 			logger.debug(
-				`subscription ready for ${JSON.stringify({ query, variables })}`
+				`subscription ready for ${JSON.stringify({ query, variables })}`,
 			);
 			if (typeof subscriptionReadyCallback === 'function') {
 				subscriptionReadyCallback();
@@ -611,7 +611,7 @@ export class AWSAppSyncRealTimeProvider {
 				});
 			}
 			this.connectionStateMonitor.record(
-				CONNECTION_CHANGE.CONNECTION_ESTABLISHED
+				CONNECTION_CHANGE.CONNECTION_ESTABLISHED,
 			);
 
 			return;
@@ -623,7 +623,7 @@ export class AWSAppSyncRealTimeProvider {
 				clearTimeout(this.keepAliveAlertTimeoutId);
 			this.keepAliveTimeoutId = setTimeout(
 				() => this._errorDisconnect(CONTROL_MSG.TIMEOUT_DISCONNECT),
-				this.keepAliveTimeout
+				this.keepAliveTimeout,
 			);
 			this.keepAliveAlertTimeoutId = setTimeout(() => {
 				this.connectionStateMonitor.record(CONNECTION_CHANGE.KEEP_ALIVE_MISSED);
@@ -646,14 +646,14 @@ export class AWSAppSyncRealTimeProvider {
 				});
 
 				logger.debug(
-					`${CONTROL_MSG.CONNECTION_FAILED}: ${JSON.stringify(payload)}`
+					`${CONTROL_MSG.CONNECTION_FAILED}: ${JSON.stringify(payload)}`,
 				);
 
 				observer.error({
 					errors: [
 						{
 							...new GraphQLError(
-								`${CONTROL_MSG.CONNECTION_FAILED}: ${JSON.stringify(payload)}`
+								`${CONTROL_MSG.CONNECTION_FAILED}: ${JSON.stringify(payload)}`,
 							),
 						},
 					],
@@ -697,7 +697,7 @@ export class AWSAppSyncRealTimeProvider {
 			this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 			logger.debug(
 				'timeoutStartSubscription',
-				JSON.stringify({ query, variables })
+				JSON.stringify({ query, variables }),
 			);
 		}
 	}
@@ -785,7 +785,7 @@ export class AWSAppSyncRealTimeProvider {
 		await jitteredExponentialRetry(
 			this._initializeHandshake.bind(this),
 			[awsRealTimeUrl],
-			MAX_DELAY_MS
+			MAX_DELAY_MS,
 		);
 	}
 
@@ -827,7 +827,7 @@ export class AWSAppSyncRealTimeProvider {
 								return;
 							}
 							logger.debug(
-								`subscription message from AWS AppSyncRealTime: ${message.data} `
+								`subscription message from AWS AppSyncRealTime: ${message.data} `,
 							);
 							const data = JSON.parse(message.data) as ParsedMessagePayload;
 							const {
@@ -874,12 +874,12 @@ export class AWSAppSyncRealTimeProvider {
 						const checkAckOk = (ackOk: boolean) => {
 							if (!ackOk) {
 								this.connectionStateMonitor.record(
-									CONNECTION_CHANGE.CONNECTION_FAILED
+									CONNECTION_CHANGE.CONNECTION_FAILED,
 								);
 								rej(
 									new Error(
-										`Connection timeout: ack from AWSAppSyncRealTime was not received after ${CONNECTION_INIT_TIMEOUT} ms`
-									)
+										`Connection timeout: ack from AWSAppSyncRealTime was not received after ${CONNECTION_INIT_TIMEOUT} ms`,
+									),
 								);
 							}
 						};
@@ -1010,7 +1010,7 @@ export class AWSAppSyncRealTimeProvider {
 				credentials: creds!,
 				signingRegion: endpointInfo.region!,
 				signingService: endpointInfo.service,
-			}
+			},
 		);
 		return signed_params.headers;
 	}

package/src/internals/APIClient.ts

@@ -579,8 +579,6 @@ export function generateGraphQLDocument(
 		);
 	}
 
-	console.log('indexQueryArgs', indexQueryArgs!);
-
 	let graphQLOperationType: 'mutation' | 'query' | 'subscription' | undefined;
 	let graphQLSelectionSet: string | undefined;
 	let graphQLArguments: Record<string, any> | undefined;
@@ -613,10 +611,10 @@ export function generateGraphQLDocument(
 								return acc;
 							},
 							{},
-					  )
+						)
 					: {
 							[primaryKeyFieldName]: `${fields[primaryKeyFieldName].type}!`,
-					  });
+						});
 			graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
 		case 'LIST':
 			graphQLArguments ??
@@ -660,13 +658,13 @@ export function generateGraphQLDocument(
 		graphQLArguments
 			? `(${Object.entries(graphQLArguments).map(
 					([fieldName, type]) => `\$${fieldName}: ${type}`,
-			  )})`
+				)})`
 			: ''
 	} { ${graphQLFieldName}${
 		graphQLArguments
 			? `(${Object.keys(graphQLArguments).map(
 					fieldName => `${fieldName}: \$${fieldName}`,
-			  )})`
+				)})`
 			: ''
 	} { ${graphQLSelectionSet} } }`;
 
@@ -716,7 +714,7 @@ export function buildGraphQLVariables(
 
 								return !isReadOnly;
 							}),
-					  )
+						)
 					: {},
 			};
 			break;
@@ -732,7 +730,7 @@ export function buildGraphQLVariables(
 								return acc;
 							},
 							{},
-					  )
+						)
 					: { [primaryKeyFieldName]: arg[primaryKeyFieldName] };
 			}
 

package/src/internals/InternalGraphQLAPI.ts

@@ -306,7 +306,7 @@ export class InternalGraphQLAPIClass {
 							amplify,
 							authMode!,
 							additionalCustomHeaders,
-					  )
+						)
 					: {})) ||
 				{}),
 			// Custom headers included in Amplify configuration options:

package/src/internals/operations/get.ts

@@ -30,12 +30,12 @@ export function getFactory(
 	modelIntrospection: ModelIntrospectionSchema,
 	model: SchemaModel,
 	operation: ModelOperation,
-	useContext = false
+	useContext = false,
 ) {
 	const getWithContext = async (
 		contextSpec: AmplifyServer.ContextSpec & GraphQLOptionsV6<unknown, string>,
 		arg?: any,
-		options?: any
+		options?: any,
 	) => {
 		return _get(
 			client,
@@ -44,7 +44,7 @@ export function getFactory(
 			arg,
 			options,
 			operation,
-			contextSpec
+			contextSpec,
 		);
 	};
 
@@ -62,7 +62,7 @@ async function _get(
 	arg: QueryArgs,
 	options: AuthModeParams & ListArgs,
 	operation: ModelOperation,
-	context?: AmplifyServer.ContextSpec
+	context?: AmplifyServer.ContextSpec,
 ) {
 	const { name } = model;
 
@@ -70,13 +70,13 @@ async function _get(
 		modelIntrospection.models,
 		name,
 		operation,
-		options
+		options,
 	);
 	const variables = buildGraphQLVariables(
 		model,
 		operation,
 		arg,
-		modelIntrospection
+		modelIntrospection,
 	);
 
 	try {
@@ -92,16 +92,16 @@ async function _get(
 						query,
 						variables,
 					},
-					headers
-			  )) as GraphQLResult<any>)
+					headers,
+				)) as GraphQLResult<any>)
 			: ((await (client as V6Client<Record<string, any>>).graphql(
 					{
 						...auth,
 						query,
 						variables,
 					},
-					headers
-			  )) as GraphQLResult<any>);
+					headers,
+				)) as GraphQLResult<any>);
 
 		// flatten response
 		if (data) {
@@ -119,7 +119,7 @@ async function _get(
 					modelIntrospection,
 					auth.authMode,
 					auth.authToken,
-					!!context
+					!!context,
 				);
 
 				return { data: initialized, extensions };

package/src/internals/operations/list.ts

@@ -26,11 +26,11 @@ export function listFactory(
 	client: ClientWithModels,
 	modelIntrospection: ModelIntrospectionSchema,
 	model: SchemaModel,
-	context = false
+	context = false,
 ) {
 	const listWithContext = async (
 		contextSpec: AmplifyServer.ContextSpec,
-		args?: ListArgs
+		args?: ListArgs,
 	) => {
 		return _list(client, modelIntrospection, model, args, contextSpec);
 	};
@@ -47,7 +47,7 @@ async function _list(
 	modelIntrospection: ModelIntrospectionSchema,
 	model: SchemaModel,
 	args?: ListArgs & AuthModeParams,
-	contextSpec?: AmplifyServer.ContextSpec
+	contextSpec?: AmplifyServer.ContextSpec,
 ) {
 	const { name } = model;
 
@@ -55,13 +55,13 @@ async function _list(
 		modelIntrospection.models,
 		name,
 		'LIST',
-		args
+		args,
 	);
 	const variables = buildGraphQLVariables(
 		model,
 		'LIST',
 		args,
-		modelIntrospection
+		modelIntrospection,
 	);
 
 	try {
@@ -77,16 +77,16 @@ async function _list(
 						query,
 						variables,
 					},
-					headers
-			  )) as GraphQLResult<any>)
+					headers,
+				)) as GraphQLResult<any>)
 			: ((await (client as V6Client<Record<string, any>>).graphql(
 					{
 						...auth,
 						query,
 						variables,
 					},
-					headers
-			  )) as GraphQLResult<any>);
+					headers,
+				)) as GraphQLResult<any>);
 
 		// flatten response
 		if (data !== undefined) {
@@ -110,7 +110,7 @@ async function _list(
 						modelIntrospection,
 						auth.authMode,
 						auth.authToken,
-						!!contextSpec
+						!!contextSpec,
 					);
 
 					return {

package/src/internals/operations/subscription.ts

@@ -20,7 +20,7 @@ export function subscriptionFactory(
 	client: any,
 	modelIntrospection: ModelIntrospectionSchema,
 	model: SchemaModel,
-	operation: ModelOperation
+	operation: ModelOperation,
 ) {
 	const { name } = model as any;
 
@@ -28,13 +28,13 @@ export function subscriptionFactory(
 		const query = generateGraphQLDocument(
 			modelIntrospection.models,
 			name,
-			operation
+			operation,
 		);
 		const variables = buildGraphQLVariables(
 			model,
 			operation,
 			args,
-			modelIntrospection
+			modelIntrospection,
 		);
 
 		const auth = authModeParams(client, args);
@@ -47,7 +47,7 @@ export function subscriptionFactory(
 				query,
 				variables,
 			},
-			headers
+			headers,
 		) as GraphqlSubscriptionResult<object>;
 
 		return observable.pipe(
@@ -60,10 +60,10 @@ export function subscriptionFactory(
 					[data],
 					modelIntrospection,
 					auth.authMode,
-					auth.authToken
+					auth.authToken,
 				);
 				return initialized;
-			})
+			}),
 		);
 	};
 

package/src/internals/server/generateClientWithAmplifyInstance.ts

@@ -30,7 +30,7 @@ export function generateClientWithAmplifyInstance<
 		| V6ClientSSRRequest<T>
 		| V6ClientSSRCookies<T> = V6ClientSSRCookies<T>,
 >(
-	params: ServerClientGenerationParams & CommonPublicClientOptions
+	params: ServerClientGenerationParams & CommonPublicClientOptions,
 ): ClientType {
 	const client = {
 		[__amplify]: params.amplify,

package/src/internals/v6.ts

@@ -101,12 +101,12 @@ export function graphql<
 >(
 	this: V6Client,
 	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
-	additionalHeaders?: CustomHeaders
+	additionalHeaders?: CustomHeaders,
 ): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING> {
-	// inject client-level auth 
+	// inject client-level auth
 	options.authMode = options.authMode || this[__authMode];
 	options.authToken = options.authToken || this[__authToken];
-	
+
 	/**
 	 * The correctness of these typings depends on correct string branding or overrides.
 	 * Neither of these can actually be validated at runtime. Hence, we don't perform
@@ -115,7 +115,7 @@ export function graphql<
 	const result = GraphQLAPI.graphql(
 		this[__amplify],
 		options,
-		additionalHeaders
+		additionalHeaders,
 	);
 	return result as any;
 }
@@ -128,7 +128,7 @@ export function graphql<
 export function cancel(
 	this: V6Client,
 	promise: Promise<any>,
-	message?: string
+	message?: string,
 ): boolean {
 	return GraphQLAPI.cancel(promise, message);
 }

package/src/server/generateClient.ts

@@ -52,13 +52,13 @@ export function generateClient<T extends Record<any, any> = never>({
 	const wrappedGraphql = (
 		contextSpec: AmplifyServer.ContextSpec,
 		options: GraphQLOptionsV6,
-		additionalHeaders?: CustomHeaders
+		additionalHeaders?: CustomHeaders,
 	) => {
 		const amplifyInstance = getAmplifyServerContext(contextSpec).amplify;
 		return prevGraphql.call(
 			{ [__amplify]: amplifyInstance },
 			options,
-			additionalHeaders as any
+			additionalHeaders as any,
 		);
 	};
 

package/src/types/index.ts

@@ -1,7 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6, ResourcesConfig } from '@aws-amplify/core';
-import { ModelTypes, CustomHeaders, EnumTypes } from '@aws-amplify/data-schema-types';
+import {
+	ModelTypes,
+	CustomHeaders,
+	EnumTypes,
+} from '@aws-amplify/data-schema-types';
 import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
@@ -72,7 +76,7 @@ export type GraphQLSubscription<T> = T & {
 export type GraphQLReturnType<T> = T extends {}
 	? {
 			[K in keyof T]?: GraphQLReturnType<T[K]>;
-	  }
+		}
 	: T;
 
 /**
@@ -93,13 +97,14 @@ type PagedList<T, TYPENAME> = {
  * array, this will only be the case when we also have errors,
  * which will then be *thrown*.
  */
-type WithListsFixed<T> = T extends PagedList<infer IT, infer NAME>
-	? PagedList<Exclude<IT, null | undefined>, NAME>
-	: T extends {}
-	  ? {
-				[K in keyof T]: WithListsFixed<T[K]>;
-	    }
-	  : T;
+type WithListsFixed<T> =
+	T extends PagedList<infer IT, infer NAME>
+		? PagedList<Exclude<IT, null | undefined>, NAME>
+		: T extends {}
+			? {
+					[K in keyof T]: WithListsFixed<T[K]>;
+				}
+			: T;
 
 /**
  * Returns an updated response type to always return a value.
@@ -115,14 +120,12 @@ type NeverEmpty<T> = {
  * If empty members are present, there will also be errors present,
  * and the response will instead be *thrown*.
  */
-type FixedQueryResult<T> = Exclude<
-	T[keyof T],
-	null | undefined
-> extends PagedList<any, any>
-	? {
-			[K in keyof T]-?: WithListsFixed<Exclude<T[K], null | undefined>>;
-	  }
-	: T;
+type FixedQueryResult<T> =
+	Exclude<T[keyof T], null | undefined> extends PagedList<any, any>
+		? {
+				[K in keyof T]-?: WithListsFixed<Exclude<T[K], null | undefined>>;
+			}
+		: T;
 
 /**
  * The return value from a `graphql({query})` call when `query` is a subscription.
@@ -181,7 +184,7 @@ export interface AWSAppSyncRealTimeProviderOptions {
 
 export type AWSAppSyncRealTimeProvider = {
 	subscribe(
-		options?: AWSAppSyncRealTimeProviderOptions
+		options?: AWSAppSyncRealTimeProviderOptions,
 	): Observable<Record<string, unknown>>;
 };
 
@@ -235,15 +238,16 @@ export type UnknownGraphQLResponse =
 export type GraphQLVariablesV6<
 	FALLBACK_TYPES = unknown,
 	TYPED_GQL_STRING extends string = string,
-> = TYPED_GQL_STRING extends GeneratedQuery<infer IN, any>
-	? IN
-	: TYPED_GQL_STRING extends GeneratedMutation<infer IN, any>
-	  ? IN
-	  : TYPED_GQL_STRING extends GeneratedSubscription<infer IN, any>
-	    ? IN
-	    : FALLBACK_TYPES extends GraphQLOperationType<infer IN, any>
-	      ? IN
-	      : any;
+> =
+	TYPED_GQL_STRING extends GeneratedQuery<infer IN, any>
+		? IN
+		: TYPED_GQL_STRING extends GeneratedMutation<infer IN, any>
+			? IN
+			: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, any>
+				? IN
+				: FALLBACK_TYPES extends GraphQLOperationType<infer IN, any>
+					? IN
+					: any;
 
 /**
  * The expected return type with respect to the given `FALLBACK_TYPE`
@@ -252,22 +256,23 @@ export type GraphQLVariablesV6<
 export type GraphQLResponseV6<
 	FALLBACK_TYPE = unknown,
 	TYPED_GQL_STRING extends string = string,
-> = TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer QUERY_OUT>
-	? Promise<GraphQLResult<FixedQueryResult<QUERY_OUT>>>
-	: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer MUTATION_OUT>
-	  ? Promise<GraphQLResult<NeverEmpty<MUTATION_OUT>>>
-	  : TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer SUB_OUT>
-	    ? GraphqlSubscriptionResult<NeverEmpty<SUB_OUT>>
-	    : FALLBACK_TYPE extends GraphQLQuery<infer T>
-	      ? Promise<GraphQLResult<FALLBACK_TYPE>>
-	      : FALLBACK_TYPE extends GraphQLSubscription<infer T>
-	        ? GraphqlSubscriptionResult<FALLBACK_TYPE>
-	        : FALLBACK_TYPE extends GraphQLOperationType<
-								infer IN,
-								infer CUSTOM_OUT
-	            >
-	          ? CUSTOM_OUT
-	          : UnknownGraphQLResponse;
+> =
+	TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer QUERY_OUT>
+		? Promise<GraphQLResult<FixedQueryResult<QUERY_OUT>>>
+		: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer MUTATION_OUT>
+			? Promise<GraphQLResult<NeverEmpty<MUTATION_OUT>>>
+			: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer SUB_OUT>
+				? GraphqlSubscriptionResult<NeverEmpty<SUB_OUT>>
+				: FALLBACK_TYPE extends GraphQLQuery<infer T>
+					? Promise<GraphQLResult<FALLBACK_TYPE>>
+					: FALLBACK_TYPE extends GraphQLSubscription<infer T>
+						? GraphqlSubscriptionResult<FALLBACK_TYPE>
+						: FALLBACK_TYPE extends GraphQLOperationType<
+									infer IN,
+									infer CUSTOM_OUT
+							  >
+							? CUSTOM_OUT
+							: UnknownGraphQLResponse;
 
 /**
  * The shape customers can use to provide `T` to `graphql<T>()` to specify both
@@ -414,7 +419,7 @@ export type GraphQLMethod = <
 	TYPED_GQL_STRING extends string = string,
 >(
 	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
-	additionalHeaders?: CustomHeaders | undefined
+	additionalHeaders?: CustomHeaders | undefined,
 ) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 
 export type GraphQLMethodSSR = <
@@ -423,7 +428,7 @@ export type GraphQLMethodSSR = <
 >(
 	contextSpec: AmplifyServer.ContextSpec,
 	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
-	additionalHeaders?: CustomHeaders | undefined
+	additionalHeaders?: CustomHeaders | undefined,
 ) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 
 /**