@aws-amplify/api-graphql 4.0.22 → 4.0.23

package/src/internals/APIClient.ts

@@ -1,38 +1,39 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { resolveOwnerFields } from '../utils/resolveOwnerFields';
 import {
+	AssociationBelongsTo,
+	AssociationHasOne,
 	GraphQLAuthMode,
-	ModelIntrospectionSchema,
 	ModelFieldType,
+	ModelIntrospectionSchema,
 	NonModelFieldType,
 	SchemaModel,
-	AssociationHasOne,
-	AssociationBelongsTo,
+	SchemaNonModel,
 } from '@aws-amplify/core/internals/utils';
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
+
 import {
 	AuthModeParams,
 	ClientWithModels,
 	ListArgs,
 	QueryArgs,
 	V6Client,
-	V6ClientSSRRequest,
 	__authMode,
 	__authToken,
 	__headers,
 } from '../types';
-import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { CustomHeaders } from '@aws-amplify/data-schema-types';
-import { SchemaNonModel } from '@aws-amplify/core/dist/esm/singleton/API/types';
+import { resolveOwnerFields } from '../utils/resolveOwnerFields';
+
 import type { IndexMeta } from './operations/indexQuery';
 
-type LazyLoadOptions = {
+interface LazyLoadOptions {
 	authMode?: GraphQLAuthMode;
 	authToken?: string | undefined;
 	limit?: number | undefined;
 	nextToken?: string | undefined | null;
 	headers?: CustomHeaders | undefined;
-};
+}
 
 const connectionType = {
 	HAS_ONE: 'HAS_ONE',
@@ -54,9 +55,11 @@ export const flattenItems = (obj: Record<string, any>): Record<string, any> => {
 				res[prop] = value.items.map((item: Record<string, any>) =>
 					flattenItems(item),
 				);
+
 				return;
 			}
 			res[prop] = flattenItems(value);
+
 			return;
 		}
 
@@ -109,15 +112,17 @@ export function initializeModel(
 				connectionFields = modelField.association.associatedWith;
 			}
 
-			let targetNames: string[] = [];
+			const targetNames: string[] = [];
 			if (modelField.association && 'targetNames' in modelField.association) {
-				targetNames = modelField.association.targetNames;
+				targetNames.push(...modelField.association.targetNames);
 			}
 
 			switch (relationType) {
 				case connectionType.HAS_ONE:
-				case connectionType.BELONGS_TO:
+				case connectionType.BELONGS_TO: {
 					const sortKeyValues = relatedModelSKFieldNames.reduce(
+						// TODO(Eslint): is this implementation correct?
+						// eslint-disable-next-line array-callback-return
 						(acc: Record<string, any>, curVal) => {
 							if (record[curVal]) {
 								return (acc[curVal] = record[curVal]);
@@ -132,9 +137,7 @@ export function initializeModel(
 							options?: LazyLoadOptions,
 						) => {
 							if (record[targetNames[0]]) {
-								return (
-									client as V6ClientSSRRequest<Record<string, any>>
-								).models[relatedModelName].get(
+								return (client as any).models[relatedModelName].get(
 									contextSpec,
 									{
 										[relatedModelPKFieldName]: record[targetNames[0]],
@@ -146,6 +149,7 @@ export function initializeModel(
 									},
 								);
 							}
+
 							return undefined;
 						};
 					} else {
@@ -153,9 +157,7 @@ export function initializeModel(
 							options?: LazyLoadOptions,
 						) => {
 							if (record[targetNames[0]]) {
-								return (client as V6Client<Record<string, any>>).models[
-									relatedModelName
-								].get(
+								return (client as any).models[relatedModelName].get(
 									{
 										[relatedModelPKFieldName]: record[targetNames[0]],
 										...sortKeyValues,
@@ -166,12 +168,14 @@ export function initializeModel(
 									},
 								);
 							}
+
 							return undefined;
 						};
 					}
 
 					break;
-				case connectionType.HAS_MANY:
+				}
+				case connectionType.HAS_MANY: {
 					const parentPk = introModel.primaryKeyInfo.primaryKeyFieldName;
 					const parentSK = introModel.primaryKeyInfo.sortKeyFieldNames;
 
@@ -204,16 +208,18 @@ export function initializeModel(
 								options?: LazyLoadOptions,
 							) => {
 								if (record[parentPk]) {
-									return (
-										client as V6ClientSSRRequest<Record<string, any>>
-									).models[relatedModelName].list(contextSpec, {
-										filter: { and: hasManyFilter },
-										limit: options?.limit,
-										nextToken: options?.nextToken,
-										authMode: options?.authMode || authMode,
-										authToken: options?.authToken || authToken,
-									});
+									return (client as any).models[relatedModelName].list(
+										contextSpec,
+										{
+											filter: { and: hasManyFilter },
+											limit: options?.limit,
+											nextToken: options?.nextToken,
+											authMode: options?.authMode || authMode,
+											authToken: options?.authToken || authToken,
+										},
+									);
 								}
+
 								return [];
 							};
 						} else {
@@ -221,9 +227,7 @@ export function initializeModel(
 								options?: LazyLoadOptions,
 							) => {
 								if (record[parentPk]) {
-									return (client as V6Client<Record<string, any>>).models[
-										relatedModelName
-									].list({
+									return (client as any).models[relatedModelName].list({
 										filter: { and: hasManyFilter },
 										limit: options?.limit,
 										nextToken: options?.nextToken,
@@ -231,6 +235,7 @@ export function initializeModel(
 										authToken: options?.authToken || authToken,
 									});
 								}
+
 								return [];
 							};
 						}
@@ -254,16 +259,18 @@ export function initializeModel(
 							options?: LazyLoadOptions,
 						) => {
 							if (record[parentPk]) {
-								return (
-									client as V6ClientSSRRequest<Record<string, any>>
-								).models[relatedModelName].list(contextSpec, {
-									filter: { and: hasManyFilter },
-									limit: options?.limit,
-									nextToken: options?.nextToken,
-									authMode: options?.authMode || authMode,
-									authToken: options?.authToken || authToken,
-								});
+								return (client as any).models[relatedModelName].list(
+									contextSpec,
+									{
+										filter: { and: hasManyFilter },
+										limit: options?.limit,
+										nextToken: options?.nextToken,
+										authMode: options?.authMode || authMode,
+										authToken: options?.authToken || authToken,
+									},
+								);
 							}
+
 							return [];
 						};
 					} else {
@@ -271,9 +278,7 @@ export function initializeModel(
 							options?: LazyLoadOptions,
 						) => {
 							if (record[parentPk]) {
-								return (client as V6Client<Record<string, any>>).models[
-									relatedModelName
-								].list({
+								return (client as any).models[relatedModelName].list({
 									filter: { and: hasManyFilter },
 									limit: options?.limit,
 									nextToken: options?.nextToken,
@@ -281,11 +286,13 @@ export function initializeModel(
 									authToken: options?.authToken || authToken,
 								});
 							}
+
 							return [];
 						};
 					}
 
 					break;
+				}
 				default:
 					break;
 			}
@@ -309,9 +316,6 @@ export const graphQLOperationsInfo = {
 } as const;
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 
-type OperationPrefix =
-	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
-
 const SELECTION_SET_WILDCARD = '*';
 
 export function defaultSelectionSetForNonModelWithIR(
@@ -346,6 +350,7 @@ export function defaultSelectionSetForNonModelWithIR(
 				pair: (string | Record<string, unknown>)[] | undefined,
 			): pair is (string | Record<string, unknown>)[] => pair !== undefined,
 		);
+
 	return Object.fromEntries(mappedFields);
 }
 
@@ -365,6 +370,8 @@ function defaultSelectionSetForModel(modelDefinition: SchemaModel): string[] {
 					return `${name}.${SELECTION_SET_WILDCARD}`;
 				}
 			}
+
+			return undefined;
 		})
 		.filter(Boolean);
 
@@ -460,10 +467,13 @@ export function customSelectionSetToIR(
 			}
 
 			if (nested === SELECTION_SET_WILDCARD) {
-				const relatedModelDefinition = modelIntrospection.models[relatedModel];
+				const nestedRelatedModelDefinition =
+					modelIntrospection.models[relatedModel];
 
 				result = {
-					[fieldName]: modelsDefaultSelectionSetIR(relatedModelDefinition),
+					[fieldName]: modelsDefaultSelectionSetIR(
+						nestedRelatedModelDefinition,
+					),
 				};
 			} else {
 				result = {
@@ -527,6 +537,7 @@ const modelsDefaultSelectionSetIR = (relatedModelDefinition: SchemaModel) => {
 	const reduced = defaultSelectionSet.reduce(
 		(acc: Record<string, any>, curVal) => {
 			acc[curVal] = FIELD_IR;
+
 			return acc;
 		},
 		{},
@@ -594,9 +605,12 @@ function deepMergeSelectionSetObjects<T extends Record<string, any>>(
 
 	for (const key in source) {
 		// This verification avoids 'Prototype Pollution' issue
-		if (!source.hasOwnProperty(key)) continue;
+		if (!Object.prototype.hasOwnProperty.call(source, key)) continue;
 
-		if (target.hasOwnProperty(key) && isObject(target[key])) {
+		if (
+			Object.prototype.hasOwnProperty.call(target, key) &&
+			isObject(target[key])
+		) {
 			deepMergeSelectionSetObjects(source[key], target[key]);
 		} else {
 			target[key] = source[key];
@@ -659,6 +673,7 @@ export function generateGraphQLDocument(
 		const skQueryArgs = sk.reduce((acc: Record<string, any>, fieldName) => {
 			const fieldType = fields[fieldName].type;
 			acc[fieldName] = `Model${fieldType}KeyConditionInput`;
+
 			return acc;
 		}, {});
 
@@ -694,6 +709,8 @@ export function generateGraphQLDocument(
 					}${name}Input!`,
 				});
 			graphQLOperationType ?? (graphQLOperationType = 'mutation');
+		// TODO(Eslint): this this case clause correct without the break statement?
+		// eslint-disable-next-line no-fallthrough
 		case 'READ':
 			graphQLArguments ??
 				(graphQLArguments = isCustomPrimaryKey
@@ -709,6 +726,8 @@ export function generateGraphQLDocument(
 							[primaryKeyFieldName]: `${fields[primaryKeyFieldName].type}!`,
 						});
 			graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
+		// TODO(Eslint): this this case clause correct without the break statement?
+		// eslint-disable-next-line no-fallthrough
 		case 'LIST':
 			graphQLArguments ??
 				(graphQLArguments = {
@@ -719,6 +738,8 @@ export function generateGraphQLDocument(
 			graphQLOperationType ?? (graphQLOperationType = 'query');
 			graphQLSelectionSet ??
 				(graphQLSelectionSet = `items { ${selectionSetFields} } nextToken __typename`);
+		// TODO(Eslint): this this case clause correct without the break statement?
+		// eslint-disable-next-line no-fallthrough
 		case 'INDEX_QUERY':
 			graphQLArguments ??
 				(graphQLArguments = {
@@ -730,6 +751,8 @@ export function generateGraphQLDocument(
 			graphQLOperationType ?? (graphQLOperationType = 'query');
 			graphQLSelectionSet ??
 				(graphQLSelectionSet = `items { ${selectionSetFields} } nextToken __typename`);
+		// TODO(Eslint): this this case clause correct without the break statement?
+		// eslint-disable-next-line no-fallthrough
 		case 'ONCREATE':
 		case 'ONUPDATE':
 		case 'ONDELETE':
@@ -750,13 +773,13 @@ export function generateGraphQLDocument(
 	const graphQLDocument = `${graphQLOperationType}${
 		graphQLArguments
 			? `(${Object.entries(graphQLArguments).map(
-					([fieldName, type]) => `\$${fieldName}: ${type}`,
+					([fieldName, type]) => `$${fieldName}: ${type}`,
 				)})`
 			: ''
 	} { ${graphQLFieldName}${
 		graphQLArguments
 			? `(${Object.keys(graphQLArguments).map(
-					fieldName => `${fieldName}: \$${fieldName}`,
+					fieldName => `${fieldName}: $${fieldName}`,
 				)})`
 			: ''
 	} { ${graphQLSelectionSet} } }`;
@@ -842,7 +865,7 @@ export function buildGraphQLVariables(
 				variables.limit = arg.limit;
 			}
 			break;
-		case 'INDEX_QUERY':
+		case 'INDEX_QUERY': {
 			const { pk, sk = [] } = indexMeta!;
 
 			variables[pk] = arg![pk];
@@ -861,6 +884,7 @@ export function buildGraphQLVariables(
 				variables.limit = arg.limit;
 			}
 			break;
+		}
 		case 'ONCREATE':
 		case 'ONUPDATE':
 		case 'ONDELETE':
@@ -873,9 +897,10 @@ export function buildGraphQLVariables(
 				'Internal error: Attempted to build variables for observeQuery. Please report this error.',
 			);
 			break;
-		default:
+		default: {
 			const exhaustiveCheck: never = operation;
 			throw new Error(`Unhandled operation case: ${exhaustiveCheck}`);
+		}
 	}
 
 	return variables;
@@ -969,9 +994,9 @@ export function authModeParams(
 
 /**
  * Retrieves custom headers from either the client or request options.
- * @param {client} V6Client | V6ClientSSRRequest | V6ClientSSRCookies - for extracting client headers
- * @param {requestHeaders} [CustomHeaders] - request headers
- * @returns {CustomHeaders} - custom headers
+ * @param client V6Client | V6ClientSSRRequest | V6ClientSSRCookies - for extracting client headers
+ * @param requestHeaders {@link CustomHeaders} - request headers
+ * @returns custom headers as {@link CustomHeaders}
  */
 export function getCustomHeaders(
 	client: V6Client | ClientWithModels,

package/src/internals/InternalGraphQLAPI.ts

@@ -2,41 +2,40 @@
 // SPDX-License-Identifier: Apache-2.0
 import {
 	DocumentNode,
-	OperationDefinitionNode,
-	print,
-	parse,
 	GraphQLError,
+	OperationDefinitionNode,
 	OperationTypeNode,
+	parse,
+	print,
 } from 'graphql';
 import { Observable, catchError } from 'rxjs';
-import { AmplifyClassV6, ConsoleLogger } from '@aws-amplify/core';
+import { AmplifyClassV6 } from '@aws-amplify/core';
 import {
-	GraphQLAuthMode,
+	AmplifyUrl,
 	CustomUserAgentDetails,
+	GraphQLAuthMode,
 	getAmplifyUserAgent,
-	AmplifyUrl,
 } from '@aws-amplify/core/internals/utils';
-import {
-	GraphQLAuthError,
-	GraphQLResult,
-	GraphQLOperation,
-	GraphQLOptions,
-} from '../types';
 import { isCancelError as isCancelErrorREST } from '@aws-amplify/api-rest';
 import {
-	post,
 	cancel as cancelREST,
+	post,
 	updateRequestToBeCancellable,
 } from '@aws-amplify/api-rest/internals';
-import { AWSAppSyncRealTimeProvider } from '../Providers/AWSAppSyncRealTimeProvider';
 import { CustomHeaders, RequestOptions } from '@aws-amplify/data-schema-types';
+
+import { AWSAppSyncRealTimeProvider } from '../Providers/AWSAppSyncRealTimeProvider';
+import {
+	GraphQLAuthError,
+	GraphQLOperation,
+	GraphQLOptions,
+	GraphQLResult,
+} from '../types';
 import { resolveConfig, resolveLibraryOptions } from '../utils';
 import { repackageUnauthError } from '../utils/errors/repackageAuthError';
 
 const USER_AGENT_HEADER = 'x-amz-user-agent';
 
-const logger = new ConsoleLogger('GraphQLAPI');
-
 const isAmplifyInstance = (
 	amplify:
 		| AmplifyClassV6
@@ -70,11 +69,7 @@ export class InternalGraphQLAPIClass {
 		authMode: GraphQLAuthMode,
 		additionalHeaders: Record<string, string> = {},
 	) {
-		const {
-			region: region,
-			endpoint: appSyncGraphqlEndpoint,
-			apiKey,
-		} = resolveConfig(amplify);
+		const { apiKey } = resolveConfig(amplify);
 
 		let headers = {};
 
@@ -87,18 +82,17 @@ export class InternalGraphQLAPIClass {
 					'X-Api-Key': apiKey,
 				};
 				break;
-			case 'iam':
+			case 'iam': {
 				const session = await amplify.Auth.fetchAuthSession();
 				if (session.credentials === undefined) {
 					throw new Error(GraphQLAuthError.NO_CREDENTIALS);
 				}
 				break;
+			}
 			case 'oidc':
 			case 'userPool':
 				try {
-					let token;
-
-					token = (
+					const token = (
 						await amplify.Auth.fetchAuthSession()
 					).tokens?.accessToken.toString();
 
@@ -139,8 +133,7 @@ export class InternalGraphQLAPIClass {
 	 */
 	getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode {
 		const doc = parse(operation);
-		const definitions =
-			doc.definitions as ReadonlyArray<OperationDefinitionNode>;
+		const definitions = doc.definitions as readonly OperationDefinitionNode[];
 		const [{ operation: operationType }] = definitions;
 
 		return operationType;
@@ -176,7 +169,7 @@ export class InternalGraphQLAPIClass {
 
 		switch (operationType) {
 			case 'query':
-			case 'mutation':
+			case 'mutation': {
 				const abortController = new AbortController();
 
 				let responsePromise: Promise<GraphQLResult<T>>;
@@ -215,7 +208,9 @@ export class InternalGraphQLAPIClass {
 					responsePromise,
 					abortController,
 				);
+
 				return responsePromise;
+			}
 			case 'subscription':
 				return this._graphqlSubscribe(
 					amplify as AmplifyClassV6,
@@ -238,7 +233,7 @@ export class InternalGraphQLAPIClass {
 		authToken?: string,
 	): Promise<GraphQLResult<T>> {
 		const {
-			region: region,
+			region,
 			endpoint: appSyncGraphqlEndpoint,
 			customEndpoint,
 			customEndpointRegion,
@@ -356,7 +351,8 @@ export class InternalGraphQLAPIClass {
 
 		if (!endpoint) {
 			const error = new GraphQLError('No graphql endpoint provided.');
-
+			// TODO(Eslint): refactor this to throw an Error instead of a plain object
+			// eslint-disable-next-line no-throw-literal
 			throw {
 				data: {},
 				errors: [error],

package/src/internals/clientUtils.ts

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type {
-	SchemaModel,
 	ModelAttribute,
+	SchemaModel,
 	SecondaryIndexAttribute,
 } from '@aws-amplify/core/internals/utils';
 

package/src/internals/generateClient.ts

@@ -1,20 +1,14 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Hub } from '@aws-amplify/core';
-import { graphql, cancel, isCancelError } from './v6';
 import {
+	CustomMutations,
+	CustomQueries,
+	CustomSubscriptions,
 	EnumTypes,
 	ModelTypes,
-	CustomQueries,
-	CustomMutations,
 } from '@aws-amplify/data-schema-types';
-import { generateEnumsProperty } from './utils/clientProperties/generateEnumsProperty';
-import { generateModelsProperty } from './utils/clientProperties/generateModelsProperty';
-import { isApiGraphQLConfig } from './utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
-import {
-	generateCustomQueriesProperty,
-	generateCustomMutationsProperty,
-} from './generateCustomOperationsProperty';
+
 import {
 	V6Client,
 	__amplify,
@@ -22,6 +16,16 @@ import {
 	__authToken,
 	__headers,
 } from '../types';
+
+import { cancel, graphql, isCancelError } from './v6';
+import { generateEnumsProperty } from './utils/clientProperties/generateEnumsProperty';
+import { generateModelsProperty } from './utils/clientProperties/generateModelsProperty';
+import { isApiGraphQLConfig } from './utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
+import {
+	generateCustomMutationsProperty,
+	generateCustomQueriesProperty,
+	generateCustomSubscriptionsProperty,
+} from './generateCustomOperationsProperty';
 import { ClientGenerationParams } from './types';
 import { isConfigureEventWithResourceConfig } from './utils/runtimeTypeGuards/isConfigureEventWithResourceConfig';
 
@@ -49,6 +53,7 @@ export function generateClient<T extends Record<any, any> = never>(
 		enums: emptyProperty as EnumTypes<never>,
 		queries: emptyProperty as CustomQueries<never>,
 		mutations: emptyProperty as CustomMutations<never>,
+		subscriptions: emptyProperty as CustomSubscriptions<never>,
 	} as any;
 
 	const apiGraphqlConfig = params.amplify.getConfig().API?.GraphQL;
@@ -61,6 +66,10 @@ export function generateClient<T extends Record<any, any> = never>(
 			client,
 			apiGraphqlConfig,
 		);
+		client.subscriptions = generateCustomSubscriptionsProperty(
+			client,
+			apiGraphqlConfig,
+		);
 	} else {
 		// This happens when the `Amplify.configure()` call gets evaluated after the `generateClient()` call.
 		//
@@ -99,6 +108,10 @@ const generateModelsPropertyOnAmplifyConfigure = (clientRef: any) => {
 				clientRef,
 				apiGraphQLConfig,
 			);
+			clientRef.subscriptions = generateCustomSubscriptionsProperty(
+				clientRef,
+				apiGraphQLConfig,
+			);
 		}
 	});
 };

package/src/internals/generateCustomOperationsProperty.ts

@@ -1,24 +1,36 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { CustomQueries, CustomMutations } from '@aws-amplify/data-schema-types';
-import { V6Client, __authMode, __authToken, __amplify } from '../types';
-
-import { customOpFactory } from './operations/custom';
 import {
-	ModelIntrospectionSchema,
+	CustomMutations,
+	CustomQueries,
+	CustomSubscriptions,
+} from '@aws-amplify/data-schema-types';
+import {
 	GraphQLProviderConfig,
+	ModelIntrospectionSchema,
 } from '@aws-amplify/core/internals/utils';
 
-type OpTypes = 'queries' | 'mutations';
+import { V6Client, __amplify } from '../types';
+
+import { customOpFactory } from './operations/custom';
+
+type OpTypes = 'queries' | 'mutations' | 'subscriptions';
 
 type CustomOpsProperty<
 	T extends Record<any, any>,
 	OpType extends OpTypes,
-> = OpType extends 'queries' ? CustomQueries<T> : CustomMutations<T>;
+> = OpType extends 'queries'
+	? CustomQueries<T>
+	: OpType extends 'mutations'
+		? CustomMutations<T>
+		: OpType extends 'subscriptions'
+			? CustomSubscriptions<T>
+			: never;
 
 const operationTypeMap = {
 	queries: 'query',
 	mutations: 'mutation',
+	subscriptions: 'subscription',
 } as const;
 
 export function generateCustomOperationsProperty<
@@ -59,7 +71,7 @@ export function generateCustomOperationsProperty<
 			modelIntrospection,
 			operationTypeMap[operationsType],
 			operation,
-			useContext
+			useContext,
 		);
 	}
 
@@ -87,3 +99,14 @@ export function generateCustomQueriesProperty<T extends Record<any, any>>(
 		'queries',
 	);
 }
+
+export function generateCustomSubscriptionsProperty<T extends Record<any, any>>(
+	client: V6Client<Record<string, any>>,
+	config: GraphQLProviderConfig['GraphQL'],
+) {
+	return generateCustomOperationsProperty<T, 'subscriptions'>(
+		client,
+		config,
+		'subscriptions',
+	);
+}