@aws-amplify/api-graphql 4.0.22-unstable.f6055cb.0 → 4.0.22

package/src/internals/APIClient.ts

@@ -1,18 +1,15 @@
 // 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,
-	ModelFieldType,
 	ModelIntrospectionSchema,
+	ModelFieldType,
 	NonModelFieldType,
 	SchemaModel,
-	SchemaNonModel,
+	AssociationHasOne,
+	AssociationBelongsTo,
 } 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,
@@ -24,17 +21,18 @@ import {
 	__authToken,
 	__headers,
 } from '../types';
-import { resolveOwnerFields } from '../utils/resolveOwnerFields';
-
+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 type { IndexMeta } from './operations/indexQuery';
 
-interface LazyLoadOptions {
+type LazyLoadOptions = {
 	authMode?: GraphQLAuthMode;
 	authToken?: string | undefined;
 	limit?: number | undefined;
 	nextToken?: string | undefined | null;
 	headers?: CustomHeaders | undefined;
-}
+};
 
 const connectionType = {
 	HAS_ONE: 'HAS_ONE',
@@ -56,11 +54,9 @@ 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;
 		}
 
@@ -113,17 +109,15 @@ export function initializeModel(
 				connectionFields = modelField.association.associatedWith;
 			}
 
-			const targetNames: string[] = [];
+			let targetNames: string[] = [];
 			if (modelField.association && 'targetNames' in modelField.association) {
-				targetNames.push(...modelField.association.targetNames);
+				targetNames = 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]);
@@ -152,7 +146,6 @@ export function initializeModel(
 									},
 								);
 							}
-
 							return undefined;
 						};
 					} else {
@@ -173,14 +166,12 @@ export function initializeModel(
 									},
 								);
 							}
-
 							return undefined;
 						};
 					}
 
 					break;
-				}
-				case connectionType.HAS_MANY: {
+				case connectionType.HAS_MANY:
 					const parentPk = introModel.primaryKeyInfo.primaryKeyFieldName;
 					const parentSK = introModel.primaryKeyInfo.sortKeyFieldNames;
 
@@ -223,7 +214,6 @@ export function initializeModel(
 										authToken: options?.authToken || authToken,
 									});
 								}
-
 								return [];
 							};
 						} else {
@@ -241,7 +231,6 @@ export function initializeModel(
 										authToken: options?.authToken || authToken,
 									});
 								}
-
 								return [];
 							};
 						}
@@ -275,7 +264,6 @@ export function initializeModel(
 									authToken: options?.authToken || authToken,
 								});
 							}
-
 							return [];
 						};
 					} else {
@@ -293,13 +281,11 @@ export function initializeModel(
 									authToken: options?.authToken || authToken,
 								});
 							}
-
 							return [];
 						};
 					}
 
 					break;
-				}
 				default:
 					break;
 			}
@@ -323,6 +309,9 @@ export const graphQLOperationsInfo = {
 } as const;
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 
+type OperationPrefix =
+	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
+
 const SELECTION_SET_WILDCARD = '*';
 
 export function defaultSelectionSetForNonModelWithIR(
@@ -357,7 +346,6 @@ export function defaultSelectionSetForNonModelWithIR(
 				pair: (string | Record<string, unknown>)[] | undefined,
 			): pair is (string | Record<string, unknown>)[] => pair !== undefined,
 		);
-
 	return Object.fromEntries(mappedFields);
 }
 
@@ -377,8 +365,6 @@ function defaultSelectionSetForModel(modelDefinition: SchemaModel): string[] {
 					return `${name}.${SELECTION_SET_WILDCARD}`;
 				}
 			}
-
-			return undefined;
 		})
 		.filter(Boolean);
 
@@ -474,13 +460,10 @@ export function customSelectionSetToIR(
 			}
 
 			if (nested === SELECTION_SET_WILDCARD) {
-				const nestedRelatedModelDefinition =
-					modelIntrospection.models[relatedModel];
+				const relatedModelDefinition = modelIntrospection.models[relatedModel];
 
 				result = {
-					[fieldName]: modelsDefaultSelectionSetIR(
-						nestedRelatedModelDefinition,
-					),
+					[fieldName]: modelsDefaultSelectionSetIR(relatedModelDefinition),
 				};
 			} else {
 				result = {
@@ -544,7 +527,6 @@ const modelsDefaultSelectionSetIR = (relatedModelDefinition: SchemaModel) => {
 	const reduced = defaultSelectionSet.reduce(
 		(acc: Record<string, any>, curVal) => {
 			acc[curVal] = FIELD_IR;
-
 			return acc;
 		},
 		{},
@@ -612,12 +594,9 @@ function deepMergeSelectionSetObjects<T extends Record<string, any>>(
 
 	for (const key in source) {
 		// This verification avoids 'Prototype Pollution' issue
-		if (!Object.prototype.hasOwnProperty.call(source, key)) continue;
+		if (!source.hasOwnProperty(key)) continue;
 
-		if (
-			Object.prototype.hasOwnProperty.call(target, key) &&
-			isObject(target[key])
-		) {
+		if (target.hasOwnProperty(key) && isObject(target[key])) {
 			deepMergeSelectionSetObjects(source[key], target[key]);
 		} else {
 			target[key] = source[key];
@@ -680,7 +659,6 @@ export function generateGraphQLDocument(
 		const skQueryArgs = sk.reduce((acc: Record<string, any>, fieldName) => {
 			const fieldType = fields[fieldName].type;
 			acc[fieldName] = `Model${fieldType}KeyConditionInput`;
-
 			return acc;
 		}, {});
 
@@ -716,8 +694,6 @@ 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
@@ -733,8 +709,6 @@ 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 = {
@@ -745,8 +719,6 @@ 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 = {
@@ -758,8 +730,6 @@ 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':
@@ -780,13 +750,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} } }`;
@@ -872,7 +842,7 @@ export function buildGraphQLVariables(
 				variables.limit = arg.limit;
 			}
 			break;
-		case 'INDEX_QUERY': {
+		case 'INDEX_QUERY':
 			const { pk, sk = [] } = indexMeta!;
 
 			variables[pk] = arg![pk];
@@ -891,7 +861,6 @@ export function buildGraphQLVariables(
 				variables.limit = arg.limit;
 			}
 			break;
-		}
 		case 'ONCREATE':
 		case 'ONUPDATE':
 		case 'ONDELETE':
@@ -904,10 +873,9 @@ 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;
@@ -1001,9 +969,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 {@link CustomHeaders} - request headers
- * @returns custom headers as {@link CustomHeaders}
+ * @param {client} V6Client | V6ClientSSRRequest | V6ClientSSRCookies - for extracting client headers
+ * @param {requestHeaders} [CustomHeaders] - request headers
+ * @returns {CustomHeaders} - custom headers
  */
 export function getCustomHeaders(
 	client: V6Client | ClientWithModels,

package/src/internals/InternalGraphQLAPI.ts

@@ -2,40 +2,41 @@
 // SPDX-License-Identifier: Apache-2.0
 import {
 	DocumentNode,
-	GraphQLError,
 	OperationDefinitionNode,
-	OperationTypeNode,
-	parse,
 	print,
+	parse,
+	GraphQLError,
+	OperationTypeNode,
 } from 'graphql';
 import { Observable, catchError } from 'rxjs';
-import { AmplifyClassV6 } from '@aws-amplify/core';
+import { AmplifyClassV6, ConsoleLogger } from '@aws-amplify/core';
 import {
-	AmplifyUrl,
-	CustomUserAgentDetails,
 	GraphQLAuthMode,
+	CustomUserAgentDetails,
 	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 {
-	cancel as cancelREST,
 	post,
+	cancel as cancelREST,
 	updateRequestToBeCancellable,
 } from '@aws-amplify/api-rest/internals';
-import { CustomHeaders, RequestOptions } from '@aws-amplify/data-schema-types';
-
 import { AWSAppSyncRealTimeProvider } from '../Providers/AWSAppSyncRealTimeProvider';
-import {
-	GraphQLAuthError,
-	GraphQLOperation,
-	GraphQLOptions,
-	GraphQLResult,
-} from '../types';
+import { CustomHeaders, RequestOptions } from '@aws-amplify/data-schema-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
@@ -69,7 +70,11 @@ export class InternalGraphQLAPIClass {
 		authMode: GraphQLAuthMode,
 		additionalHeaders: Record<string, string> = {},
 	) {
-		const { apiKey } = resolveConfig(amplify);
+		const {
+			region: region,
+			endpoint: appSyncGraphqlEndpoint,
+			apiKey,
+		} = resolveConfig(amplify);
 
 		let headers = {};
 
@@ -82,17 +87,18 @@ 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 {
-					const token = (
+					let token;
+
+					token = (
 						await amplify.Auth.fetchAuthSession()
 					).tokens?.accessToken.toString();
 
@@ -133,7 +139,8 @@ export class InternalGraphQLAPIClass {
 	 */
 	getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode {
 		const doc = parse(operation);
-		const definitions = doc.definitions as readonly OperationDefinitionNode[];
+		const definitions =
+			doc.definitions as ReadonlyArray<OperationDefinitionNode>;
 		const [{ operation: operationType }] = definitions;
 
 		return operationType;
@@ -169,7 +176,7 @@ export class InternalGraphQLAPIClass {
 
 		switch (operationType) {
 			case 'query':
-			case 'mutation': {
+			case 'mutation':
 				const abortController = new AbortController();
 
 				let responsePromise: Promise<GraphQLResult<T>>;
@@ -208,9 +215,7 @@ export class InternalGraphQLAPIClass {
 					responsePromise,
 					abortController,
 				);
-
 				return responsePromise;
-			}
 			case 'subscription':
 				return this._graphqlSubscribe(
 					amplify as AmplifyClassV6,
@@ -233,7 +238,7 @@ export class InternalGraphQLAPIClass {
 		authToken?: string,
 	): Promise<GraphQLResult<T>> {
 		const {
-			region,
+			region: region,
 			endpoint: appSyncGraphqlEndpoint,
 			customEndpoint,
 			customEndpointRegion,
@@ -351,8 +356,7 @@ 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 {
-	ModelAttribute,
 	SchemaModel,
+	ModelAttribute,
 	SecondaryIndexAttribute,
 } from '@aws-amplify/core/internals/utils';
 

package/src/internals/generateClient.ts

@@ -1,13 +1,20 @@
 // 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,
 	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,
@@ -15,15 +22,6 @@ 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,
-} from './generateCustomOperationsProperty';
 import { ClientGenerationParams } from './types';
 import { isConfigureEventWithResourceConfig } from './utils/runtimeTypeGuards/isConfigureEventWithResourceConfig';
 

package/src/internals/generateCustomOperationsProperty.ts

@@ -1,15 +1,14 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { CustomMutations, CustomQueries } from '@aws-amplify/data-schema-types';
+import { CustomQueries, CustomMutations } from '@aws-amplify/data-schema-types';
+import { V6Client, __authMode, __authToken, __amplify } from '../types';
+
+import { customOpFactory } from './operations/custom';
 import {
-	GraphQLProviderConfig,
 	ModelIntrospectionSchema,
+	GraphQLProviderConfig,
 } from '@aws-amplify/core/internals/utils';
 
-import { V6Client, __amplify } from '../types';
-
-import { customOpFactory } from './operations/custom';
-
 type OpTypes = 'queries' | 'mutations';
 
 type CustomOpsProperty<
@@ -60,7 +59,7 @@ export function generateCustomOperationsProperty<
 			modelIntrospection,
 			operationTypeMap[operationsType],
 			operation,
-			useContext,
+			useContext
 		);
 	}
 

package/src/internals/operations/custom.ts

@@ -2,18 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 import {
-	CustomOperation,
-	ModelIntrospectionSchema,
-} from '@aws-amplify/core/internals/utils';
-
-import {
-	authModeParams,
-	defaultSelectionSetForNonModelWithIR,
+	initializeModel,
 	flattenItems,
-	generateSelectionSet,
+	authModeParams,
 	getCustomHeaders,
-	initializeModel,
+	generateSelectionSet,
 	selectionSetIRToString,
+	defaultSelectionSetForNonModelWithIR,
 } from '../APIClient';
 import {
 	AuthModeParams,
@@ -25,6 +20,13 @@ import {
 	V6Client,
 	V6ClientSSRRequest,
 } from '../../types';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+	SchemaNonModel,
+	CustomOperation,
+	CustomOperationArgument,
+} from '@aws-amplify/core/internals/utils';
 
 /**
  * Builds an operation function, embedded with all client and context data, that
@@ -166,11 +168,9 @@ function outerArguments(operation: CustomOperation): string {
 			const finalType = v.isArray
 				? `[${baseType}]${v.isArrayNullable ? '' : '!'}`
 				: baseType;
-
 			return `$${k}: ${finalType}`;
 		})
 		.join(', ');
-
 	return args.length > 0 ? `(${args})` : '';
 }
 
@@ -194,10 +194,9 @@ function outerArguments(operation: CustomOperation): string {
  * @returns "outer" arguments string
  */
 function innerArguments(operation: CustomOperation): string {
-	const args = Object.keys(operation.arguments)
-		.map(k => `${k}: $${k}`)
+	const args = Object.entries(operation.arguments)
+		.map(([k, v]) => `${k}: $${k}`)
 		.join(', ');
-
 	return args.length > 0 ? `(${args})` : '';
 }
 
@@ -235,7 +234,6 @@ function operationSelectionSet(
 		return '';
 	} else if (hasStringField(operation.type, 'nonModel')) {
 		const nonModel = modelIntrospection.nonModels[operation.type.nonModel];
-
 		return `{${selectionSetIRToString(
 			defaultSelectionSetForNonModelWithIR(nonModel, modelIntrospection),
 		)}}`;
@@ -268,7 +266,6 @@ function operationVariables(
 			throw new Error(`${operation.name} requires arguments '${argDef.name}'`);
 		}
 	}
-
 	return variables;
 }
 

package/src/internals/operations/get.ts

@@ -2,18 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 import {
-	ModelIntrospectionSchema,
-	SchemaModel,
-} from '@aws-amplify/core/internals/utils';
-
-import {
-	ModelOperation,
-	authModeParams,
+	initializeModel,
+	generateGraphQLDocument,
 	buildGraphQLVariables,
 	flattenItems,
-	generateGraphQLDocument,
+	authModeParams,
+	ModelOperation,
 	getCustomHeaders,
-	initializeModel,
 } from '../APIClient';
 import {
 	AuthModeParams,
@@ -25,6 +20,10 @@ import {
 	V6Client,
 	V6ClientSSRRequest,
 } from '../../types';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
 
 export function getFactory(
 	client: ClientWithModels,

package/src/internals/operations/indexQuery.ts

@@ -2,32 +2,31 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 import {
-	ModelIntrospectionSchema,
-	SchemaModel,
-} from '@aws-amplify/core/internals/utils';
-
-import {
-	authModeParams,
+	initializeModel,
+	generateGraphQLDocument,
 	buildGraphQLVariables,
 	flattenItems,
-	generateGraphQLDocument,
+	authModeParams,
 	getCustomHeaders,
-	initializeModel,
 } from '../APIClient';
 import {
 	AuthModeParams,
 	ClientWithModels,
-	GraphQLResult,
 	ListArgs,
-	QueryArgs,
 	V6ClientSSRRequest,
+	GraphQLResult,
+	QueryArgs,
 } from '../../types';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
 
-export interface IndexMeta {
+export type IndexMeta = {
 	queryField: string;
 	pk: string;
 	sk?: string[];
-}
+};
 
 export function indexQueryFactory(
 	client: ClientWithModels,