@aws-amplify/api-graphql 4.0.17 → 4.0.18-experimental-lerna-test.d2b0b08.55

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,
-	SchemaModels,
-	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,
-	V6ClientSSRCookies,
-	V6ClientSSRRequest,
 	__authMode,
 	__authToken,
 	__headers,
 } from '../types';
-import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { CustomHeaders } from '@aws-amplify/data-schema-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,23 +316,63 @@ export const graphQLOperationsInfo = {
 } as const;
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 
-type OperationPrefix =
-	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
-
 const SELECTION_SET_WILDCARD = '*';
 
+export function defaultSelectionSetForNonModelWithIR(
+	nonModelDefinition: SchemaNonModel,
+	modelIntrospection: ModelIntrospectionSchema,
+): Record<string, unknown> {
+	const { fields } = nonModelDefinition;
+	const mappedFields = Object.values(fields)
+		.map(({ type, name }) => {
+			if (typeof (type as { enum: string }).enum === 'string') {
+				return [name, FIELD_IR];
+			}
+
+			if (typeof (type as NonModelFieldType).nonModel === 'string') {
+				return [
+					name,
+					defaultSelectionSetForNonModelWithIR(
+						modelIntrospection.nonModels[(type as NonModelFieldType).nonModel],
+						modelIntrospection,
+					),
+				];
+			}
+
+			if (typeof type === 'string') {
+				return [name, FIELD_IR];
+			}
+
+			return undefined;
+		})
+		.filter(
+			(
+				pair: (string | Record<string, unknown>)[] | undefined,
+			): pair is (string | Record<string, unknown>)[] => pair !== undefined,
+		);
+
+	return Object.fromEntries(mappedFields);
+}
+
 function defaultSelectionSetForModel(modelDefinition: SchemaModel): string[] {
 	// fields that are explicitly part of the graphql schema; not
 	// inferred from owner auth rules.
 	const { fields } = modelDefinition;
 	const explicitFields = Object.values<any>(fields)
 		// Default selection set omits model fields
-		.map(
-			({ type, name }) =>
-				(typeof type === 'string' ||
-					(typeof type === 'object' && typeof type?.enum === 'string')) &&
-				name,
-		)
+		.map(({ type, name }) => {
+			if (typeof type === 'string') return name;
+
+			if (typeof type === 'object') {
+				if (typeof type?.enum === 'string') {
+					return name;
+				} else if (typeof type?.nonModel === 'string') {
+					return `${name}.${SELECTION_SET_WILDCARD}`;
+				}
+			}
+
+			return undefined;
+		})
 		.filter(Boolean);
 
 	// fields used for owner auth rules that may or may not also
@@ -357,59 +404,119 @@ const FIELD_IR = '';
  * ```
  */
 export function customSelectionSetToIR(
-	modelDefinitions: SchemaModels,
+	modelIntrospection: ModelIntrospectionSchema,
 	modelName: string,
 	selectionSet: string[],
 ): Record<string, string | object> {
-	const dotNotationToObject = (
-		path: string,
-		modelName: string,
-	): Record<string, any> => {
+	const dotNotationToObject = (path: string, modelOrNonModelName: string) => {
 		const [fieldName, ...rest] = path.split('.');
 
-		let result: Record<string, any> = {};
+		const nested = rest[0];
+		const modelOrNonModelDefinition =
+			modelIntrospection.models[modelOrNonModelName] ??
+			modelIntrospection.nonModels[modelOrNonModelName];
+
+		const modelOrNonModelFields = modelOrNonModelDefinition?.fields;
+		const relatedModel = (
+			modelOrNonModelFields?.[fieldName]?.type as ModelFieldType
+		)?.model;
+
+		const relatedModelDefinition = modelIntrospection.models[relatedModel];
+		const relatedNonModel = (
+			modelOrNonModelFields?.[fieldName]?.type as NonModelFieldType
+		)?.nonModel;
+		const relatedNonModelDefinition =
+			modelIntrospection.nonModels[relatedNonModel];
+
+		const isModelOrNonModelOrFieldType = relatedModelDefinition
+			? 'model'
+			: relatedNonModelDefinition
+				? 'nonModel'
+				: 'field';
+
+		if (isModelOrNonModelOrFieldType === 'nonModel') {
+			let result: Record<string, any> = {};
+
+			if (!nested) {
+				throw Error(
+					`${fieldName} must declare a wildcard (*) or a field of custom type ${relatedNonModel}`,
+				);
+			}
 
-		if (rest.length === 0) {
-			result = { [fieldName]: FIELD_IR };
-		} else {
-			const nested = rest[0];
-			const modelDefinition = modelDefinitions[modelName];
-			const modelFields = modelDefinition.fields;
-			const relatedModel = (modelFields[fieldName]?.type as ModelFieldType)
-				?.model;
-
-			if (!relatedModel) {
-				// TODO: may need to change this to support custom types
-				throw Error(`${fieldName} is not a model field`);
+			if (nested === SELECTION_SET_WILDCARD) {
+				result = {
+					[fieldName]: defaultSelectionSetForNonModelWithIR(
+						relatedNonModelDefinition,
+						modelIntrospection,
+					),
+				};
+			} else {
+				result = {
+					[fieldName]: dotNotationToObject(rest.join('.'), relatedNonModel),
+				};
+			}
+
+			return result;
+		} else if (isModelOrNonModelOrFieldType === 'model') {
+			let result: Record<string, any> = {};
+
+			if (!nested) {
+				throw Error(
+					`${fieldName} must declare a wildcard (*) or a field of model ${relatedModel}`,
+				);
 			}
 
 			if (nested === SELECTION_SET_WILDCARD) {
-				const relatedModelDefinition = modelDefinitions[relatedModel];
+				const nestedRelatedModelDefinition =
+					modelIntrospection.models[relatedModel];
 
 				result = {
-					[fieldName]: defaultSelectionSetIR(relatedModelDefinition),
+					[fieldName]: modelsDefaultSelectionSetIR(
+						nestedRelatedModelDefinition,
+					),
 				};
 			} else {
-				const exists = Boolean(modelFields[fieldName]);
-				if (!exists) {
-					throw Error(`${fieldName} is not a field of model ${modelName}`);
-				}
-
 				result = {
 					[fieldName]: dotNotationToObject(rest.join('.'), relatedModel),
 				};
 			}
 
-			if (modelFields[fieldName]?.isArray) {
+			if (modelOrNonModelFields[fieldName]?.isArray) {
 				result = {
 					[fieldName]: {
 						items: result[fieldName],
 					},
 				};
 			}
-		}
 
-		return result;
+			return result;
+		} else {
+			const modelField = modelOrNonModelFields?.[fieldName];
+
+			const nonModelDefinition =
+				modelIntrospection.nonModels[modelOrNonModelName];
+			const nonModelField = nonModelDefinition?.fields?.[fieldName];
+
+			if (!nonModelDefinition) {
+				const isOwnerField = resolveOwnerFields(
+					modelOrNonModelDefinition,
+				).includes(fieldName);
+
+				if (!modelField && !isOwnerField) {
+					throw Error(
+						`${fieldName} is not a field of model ${modelOrNonModelName}`,
+					);
+				}
+			} else {
+				if (!nonModelField) {
+					throw Error(
+						`${fieldName} is not a field of custom type ${modelOrNonModelName}`,
+					);
+				}
+			}
+
+			return { [fieldName]: FIELD_IR };
+		}
 	};
 
 	return selectionSet.reduce(
@@ -422,7 +529,7 @@ export function customSelectionSetToIR(
 	);
 }
 
-const defaultSelectionSetIR = (relatedModelDefinition: SchemaModel) => {
+const modelsDefaultSelectionSetIR = (relatedModelDefinition: SchemaModel) => {
 	const defaultSelectionSet = defaultSelectionSetForModel(
 		relatedModelDefinition,
 	);
@@ -430,6 +537,7 @@ const defaultSelectionSetIR = (relatedModelDefinition: SchemaModel) => {
 	const reduced = defaultSelectionSet.reduce(
 		(acc: Record<string, any>, curVal) => {
 			acc[curVal] = FIELD_IR;
+
 			return acc;
 		},
 		{},
@@ -497,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];
@@ -510,20 +621,16 @@ function deepMergeSelectionSetObjects<T extends Record<string, any>>(
 }
 
 export function generateSelectionSet(
-	modelDefinitions: SchemaModels,
+	modelIntrospection: ModelIntrospectionSchema,
 	modelName: string,
 	selectionSet?: string[],
 ) {
-	const modelDefinition = modelDefinitions[modelName];
-
-	if (!selectionSet) {
-		return defaultSelectionSetForModel(modelDefinition).join(' ');
-	}
+	const modelDefinition = modelIntrospection.models[modelName];
 
 	const selSetIr = customSelectionSetToIR(
-		modelDefinitions,
+		modelIntrospection,
 		modelName,
-		selectionSet,
+		selectionSet ?? defaultSelectionSetForModel(modelDefinition),
 	);
 	const selSetString = selectionSetIRToString(selSetIr);
 
@@ -531,13 +638,13 @@ export function generateSelectionSet(
 }
 
 export function generateGraphQLDocument(
-	modelDefinitions: SchemaModels,
+	modelIntrospection: ModelIntrospectionSchema,
 	modelName: string,
 	modelOperation: ModelOperation,
 	listArgs?: ListArgs | QueryArgs,
 	indexMeta?: IndexMeta,
 ): string {
-	const modelDefinition = modelDefinitions[modelName];
+	const modelDefinition = modelIntrospection.models[modelName];
 
 	const {
 		name,
@@ -566,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;
 		}, {});
 
@@ -584,7 +692,7 @@ export function generateGraphQLDocument(
 	let graphQLArguments: Record<string, any> | undefined;
 
 	const selectionSetFields = generateSelectionSet(
-		modelDefinitions,
+		modelIntrospection,
 		modelName,
 		selectionSet as ListArgs['selectionSet'],
 	);
@@ -601,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
@@ -616,27 +726,44 @@ 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 = {
 					filter: `Model${name}FilterInput`,
+					...(sortKeyFieldNames.length > 0
+						? [primaryKeyFieldName, ...sortKeyFieldNames].reduce(
+								(acc: Record<string, any>, fieldName) => {
+									acc[fieldName] = `${fields[fieldName].type}`;
+
+									return acc;
+								},
+								{ sortDirection: 'ModelSortDirection' },
+							)
+						: []),
 					limit: 'Int',
 					nextToken: 'String',
 				});
 			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 = {
 					...indexQueryArgs!,
 					filter: `Model${name}FilterInput`,
+					sortDirection: 'ModelSortDirection',
 					limit: 'Int',
 					nextToken: 'String',
 				});
 			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':
@@ -657,13 +784,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} } }`;
@@ -742,6 +869,10 @@ export function buildGraphQLVariables(
 			if (arg?.filter) {
 				variables.filter = arg.filter;
 			}
+			if (arg?.sortDirection) {
+				variables.sortDirection = arg.sortDirection;
+				variables[primaryKeyFieldName] = arg[primaryKeyFieldName];
+			}
 			if (arg?.nextToken) {
 				variables.nextToken = arg.nextToken;
 			}
@@ -749,7 +880,7 @@ export function buildGraphQLVariables(
 				variables.limit = arg.limit;
 			}
 			break;
-		case 'INDEX_QUERY':
+		case 'INDEX_QUERY': {
 			const { pk, sk = [] } = indexMeta!;
 
 			variables[pk] = arg![pk];
@@ -761,6 +892,11 @@ export function buildGraphQLVariables(
 			if (arg?.filter) {
 				variables.filter = arg.filter;
 			}
+
+			if (arg?.sortDirection) {
+				variables.sortDirection = arg.sortDirection;
+			}
+
 			if (arg?.nextToken) {
 				variables.nextToken = arg.nextToken;
 			}
@@ -768,6 +904,7 @@ export function buildGraphQLVariables(
 				variables.limit = arg.limit;
 			}
 			break;
+		}
 		case 'ONCREATE':
 		case 'ONUPDATE':
 		case 'ONDELETE':
@@ -780,9 +917,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;
@@ -861,7 +999,7 @@ export function normalizeMutationInput(
  * as a fallback.
  *
  * @param client Configured client from `generateClient`
- * @param options Args/Options obect from call site.
+ * @param options Args/Options object from call site.
  * @returns
  */
 export function authModeParams(
@@ -876,9 +1014,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,