@aws-amplify/api 5.3.4-api-v6.29 → 5.3.4-api-v6-models.34

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api",
-	"version": "5.3.4-api-v6.29+98c172c32",
+	"version": "5.3.4-api-v6-models.34+62a13d7bc",
 	"description": "Api category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -28,14 +28,14 @@
 		"build-with-test": "npm test && npm run build",
 		"build:cjs": "rimraf lib && tsc -p ./tsconfig.build.json -m commonjs --outDir lib && webpack && webpack --config ./webpack.config.dev.js",
 		"build:esm": "rimraf lib-esm && tsc -p ./tsconfig.build.json -m esnext --outDir lib-esm",
-		"build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
-		"build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm --watch",
+		"build:cjs:watch": "rimraf lib && tsc -p ./tsconfig.build.json -m commonjs --outDir lib --watch",
+		"build:esm:watch": "rimraf lib-esm && tsc -p ./tsconfig.build.json -m esnext --outDir lib-esm --watch",
 		"build": "npm run clean && npm run build:esm && npm run build:cjs",
 		"clean": "npm run clean:size && rimraf lib-esm lib dist",
 		"clean:size": "rimraf dual-publish-tmp tmp*",
 		"format": "echo \"Not implemented\"",
 		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 83"
 	},
 	"repository": {
 		"type": "git",
@@ -49,7 +49,7 @@
 	"homepage": "https://aws-amplify.github.io/",
 	"devDependencies": {
 		"@types/zen-observable": "^0.8.0",
-		"typescript": "^5.1.6"
+		"typescript": "5.1.6"
 	},
 	"files": [
 		"lib",
@@ -59,9 +59,9 @@
 		"internals"
 	],
 	"dependencies": {
-		"@aws-amplify/api-graphql": "3.4.4-api-v6.29+98c172c32",
-		"@aws-amplify/api-rest": "3.3.3-api-v6.29+98c172c32",
-		"@aws-amplify/types-package-alpha": "0.0.1-api-v6.8114+98c172c32",
+		"@aws-amplify/api-graphql": "3.4.4-api-v6-models.34+62a13d7bc",
+		"@aws-amplify/api-rest": "3.3.3-api-v6-models.34+62a13d7bc",
+		"@aws-amplify/types-package-alpha": "0.0.1-api-v6-models.8123+62a13d7bc",
 		"tslib": "^2.6.1"
 	},
 	"size-limit": [
@@ -69,7 +69,7 @@
 			"name": "API (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, API }",
-			"limit": "92 kB"
+			"limit": "93.82 kB"
 		}
 	],
 	"jest": {
@@ -116,5 +116,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "98c172c32bc793b99b31442ea2d84829baea6e3c"
+	"gitHead": "62a13d7bcd5a015eab416b66dff503b0f657f6bc"
 }

package/src/API.ts

@@ -11,8 +11,20 @@ import { graphql as v6graphql } from '@aws-amplify/api-graphql/internals';
 import { Amplify, ConsoleLogger as Logger } from '@aws-amplify/core';
 import Observable from 'zen-observable-ts';
 import { InternalAPIClass } from './internals/InternalAPI';
+import {
+	initializeModel,
+	generateGraphQLDocument,
+	buildGraphQLVariables,
+	graphQLOperationsInfo,
+	ModelOperation,
+} from './APIClient';
 import type { ModelTypes } from '@aws-amplify/types-package-alpha';
 
+/*
+	await post.comments()
+		=> await graphql()
+*/
+
 const logger = new Logger('API');
 /**
  * @deprecated
@@ -62,6 +74,8 @@ export class APIClass extends InternalAPIClass {
 			models: {},
 		};
 
+		// TODO: refactor this to use separate methods for each CRUDL.
+		// Doesn't make sense to gen the methods dynamically given the different args and return values
 		for (const model of Object.values(modelIntrospection.models)) {
 			const { name } = model as any;
 
@@ -71,29 +85,87 @@ export class APIClass extends InternalAPIClass {
 				([key, { operationPrefix }]) => {
 					const operation = key as ModelOperation;
 
-					// e.g. clients.models.Todo.update
-					client.models[name][operationPrefix] = async (arg?: any) => {
-						const query = generateGraphQLDocument(model, operation);
-						const variables = buildGraphQLVariables(model, operation, arg);
-
-						const res = (await this.graphql({
-							query,
-							variables,
-						})) as any;
-
-						// flatten response
-						if (res.data !== undefined) {
-							const [key] = Object.keys(res.data);
-
-							if (res.data[key].items) {
-								return res.data[key].items;
+					if (operation === 'LIST') {
+						client.models[name][operationPrefix] = async (args?: any) => {
+							const query = generateGraphQLDocument(
+								modelIntrospection.models,
+								name,
+								'LIST',
+								args
+							);
+							const variables = buildGraphQLVariables(model, 'LIST', args);
+
+							console.log('API list', query, variables);
+
+							const res = (await this.graphql({
+								query,
+								variables,
+							})) as any;
+
+							// flatten response
+							if (res.data !== undefined) {
+								const [key] = Object.keys(res.data);
+
+								if (res.data[key].items) {
+									const flattenedResult = res.data[key].items;
+
+									// don't init if custom selection set
+									if (args?.selectionSet) {
+										return flattenedResult;
+									} else {
+										const initialized = initializeModel(
+											client,
+											name,
+											flattenedResult,
+											modelIntrospection
+										);
+
+										return initialized;
+									}
+								}
+
+								return res.data[key];
 							}
 
-							return res.data[key];
-						}
+							return res as any;
+						};
+					} else {
+						client.models[name][operationPrefix] = async (
+							arg?: any,
+							options?: any
+						) => {
+							const query = generateGraphQLDocument(
+								modelIntrospection.models,
+								name,
+								operation
+							);
+							const variables = buildGraphQLVariables(model, operation, arg);
+
+							console.log(`API ${operationPrefix}`, query, variables);
+
+							const res = (await this.graphql({
+								query,
+								variables,
+							})) as any;
+
+							// flatten response
+							if (res.data !== undefined) {
+								const [key] = Object.keys(res.data);
+
+								// TODO: refactor to avoid destructuring here
+								const [initialized] = initializeModel(
+									client,
+									name,
+									[res.data[key]],
+									modelIntrospection
+								);
+
+								return initialized;
+							}
 
-						return res;
-					};
+							return res;
+						};
+					}
 				}
 			);
 		}
@@ -102,167 +174,6 @@ export class APIClass extends InternalAPIClass {
 	}
 }
 
-const graphQLOperationsInfo = {
-	CREATE: { operationPrefix: 'create' as const, usePlural: false },
-	READ: { operationPrefix: 'get' as const, usePlural: false },
-	UPDATE: { operationPrefix: 'update' as const, usePlural: false },
-	DELETE: { operationPrefix: 'delete' as const, usePlural: false },
-	LIST: { operationPrefix: 'list' as const, usePlural: true },
-};
-type ModelOperation = keyof typeof graphQLOperationsInfo;
-type OperationPrefix =
-	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
-
-const graphQLDocumentsCache = new Map<string, Map<ModelOperation, string>>();
-
-function generateGraphQLDocument(
-	modelDefinition: any,
-	modelOperation: ModelOperation
-): string {
-	const {
-		name,
-		pluralName,
-		fields,
-		primaryKeyInfo: {
-			isCustomPrimaryKey,
-			primaryKeyFieldName,
-			sortKeyFieldNames,
-		},
-	} = modelDefinition;
-	const { operationPrefix, usePlural } = graphQLOperationsInfo[modelOperation];
-
-	const fromCache = graphQLDocumentsCache.get(name)?.get(modelOperation);
-
-	if (fromCache !== undefined) {
-		return fromCache;
-	}
-
-	if (!graphQLDocumentsCache.has(name)) {
-		graphQLDocumentsCache.set(name, new Map());
-	}
-
-	const graphQLFieldName = `${operationPrefix}${usePlural ? pluralName : name}`;
-	let graphQLOperationType: 'mutation' | 'query' | undefined;
-	let graphQLSelectionSet: string | undefined;
-	let graphQLArguments: Record<string, any> | undefined;
-
-	const selectionSetFields = Object.values<any>(fields)
-		.map(({ type, name }) => typeof type === 'string' && name) // Only scalars for now
-		.filter(Boolean)
-		.join(' ');
-
-	switch (modelOperation) {
-		case 'CREATE':
-		case 'UPDATE':
-		case 'DELETE':
-			graphQLArguments ??
-				(graphQLArguments = {
-					input: `${
-						operationPrefix.charAt(0).toLocaleUpperCase() +
-						operationPrefix.slice(1)
-					}${name}Input!`,
-				});
-			graphQLOperationType ?? (graphQLOperationType = 'mutation');
-		case 'READ':
-			graphQLArguments ??
-				(graphQLArguments = isCustomPrimaryKey
-					? [primaryKeyFieldName, ...sortKeyFieldNames].reduce(
-							(acc, fieldName) => {
-								acc[fieldName] = fields[fieldName].type;
-
-								return acc;
-							},
-							{}
-					  )
-					: {
-							[primaryKeyFieldName]: `${fields[primaryKeyFieldName].type}!`,
-					  });
-			graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
-		case 'LIST':
-			graphQLOperationType ?? (graphQLOperationType = 'query');
-			graphQLSelectionSet ??
-				(graphQLSelectionSet = `items { ${selectionSetFields} }`);
-	}
-
-	const graphQLDocument = `${graphQLOperationType}${
-		graphQLArguments
-			? `(${Object.entries(graphQLArguments).map(
-					([fieldName, type]) => `\$${fieldName}: ${type}`
-			  )})`
-			: ''
-	} { ${graphQLFieldName}${
-		graphQLArguments
-			? `(${Object.keys(graphQLArguments).map(
-					fieldName => `${fieldName}: \$${fieldName}`
-			  )})`
-			: ''
-	} { ${graphQLSelectionSet} } }`;
-
-	graphQLDocumentsCache.get(name)?.set(modelOperation, graphQLDocument);
-
-	return graphQLDocument;
-}
-
-function buildGraphQLVariables(
-	modelDefinition: any,
-	operation: ModelOperation,
-	arg: any
-): object {
-	const {
-		fields,
-		primaryKeyInfo: {
-			isCustomPrimaryKey,
-			primaryKeyFieldName,
-			sortKeyFieldNames,
-		},
-	} = modelDefinition;
-
-	let variables = {};
-
-	switch (operation) {
-		case 'CREATE':
-			variables = { input: arg };
-			break;
-		case 'UPDATE':
-			// readonly fields are not  updated
-			variables = {
-				input: Object.fromEntries(
-					Object.entries(arg).filter(([fieldName]) => {
-						const { isReadOnly } = fields[fieldName];
-
-						return !isReadOnly;
-					})
-				),
-			};
-			break;
-		case 'READ':
-		case 'DELETE':
-			// only identifiers are sent
-			variables = isCustomPrimaryKey
-				? [primaryKeyFieldName, ...sortKeyFieldNames].reduce(
-						(acc, fieldName) => {
-							acc[fieldName] = arg[fieldName];
-
-							return acc;
-						},
-						{}
-				  )
-				: { [primaryKeyFieldName]: arg[primaryKeyFieldName] };
-
-			if (operation === 'DELETE') {
-				variables = { input: variables };
-			}
-			break;
-		case 'LIST':
-			break;
-		default:
-			const exhaustiveCheck: never = operation;
-			throw new Error(`Unhandled operation case: ${exhaustiveCheck}`);
-	}
-
-	return variables;
-}
-
 type FilteredKeys<T> = {
 	[P in keyof T]: T[P] extends never ? never : P;
 }[keyof T];

package/src/APIClient.ts

@@ -0,0 +1,283 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ModelTypes } from '@aws-amplify/types-package-alpha';
+
+type ListArgs = { selectionSet?: string[]; filter?: {} };
+
+// TODO: this should accept single result to support CRUD methods; create helper for array/list
+export function initializeModel(
+	client: any,
+	modelName: string,
+	result: any[],
+	modelIntrospection: any
+): any[] {
+	const introModel = modelIntrospection.models[modelName];
+	const introModelFields = introModel.fields;
+
+	const modelFields: string[] = Object.entries(introModelFields)
+		.filter(([_, field]: [string, any]) => typeof field.type !== 'string')
+		.map(([fieldName]) => fieldName);
+
+	return result.map(record => {
+		const initialized = {};
+
+		for (const field of modelFields) {
+			const relatedModel = introModelFields[field].type.model;
+			const connectionField =
+				introModelFields[field].association.associatedWith;
+			// TODO: support sort key
+			const parentPk = introModel.primaryKeyInfo.primaryKeyFieldName;
+
+			initialized[field] = async () => {
+				return client.models[relatedModel].list({
+					filter: { [connectionField]: { eq: record[parentPk] } },
+				});
+			};
+		}
+
+		return { ...record, ...initialized };
+	});
+}
+
+export const graphQLOperationsInfo = {
+	CREATE: { operationPrefix: 'create' as const, usePlural: false },
+	READ: { operationPrefix: 'get' as const, usePlural: false },
+	UPDATE: { operationPrefix: 'update' as const, usePlural: false },
+	DELETE: { operationPrefix: 'delete' as const, usePlural: false },
+	LIST: { operationPrefix: 'list' as const, usePlural: true },
+};
+export type ModelOperation = keyof typeof graphQLOperationsInfo;
+
+type OperationPrefix =
+	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
+
+const graphQLDocumentsCache = new Map<string, Map<ModelOperation, string>>();
+const SELECTION_SET_ALL_NESTED = '*';
+
+function defaultSelectionSetForModel(modelDefinition: any): string {
+	const { fields } = modelDefinition;
+	return Object.values<any>(fields)
+		.map(({ type, name }) => typeof type === 'string' && name) // Default selection set omits model fields
+		.filter(Boolean)
+		.join(' ');
+}
+
+function generateSelectionSet(
+	modelIntrospection: any,
+	modelName: string,
+	selectionSet?: string[]
+) {
+	const modelDefinition = modelIntrospection[modelName];
+	const { fields } = modelDefinition;
+
+	if (!selectionSet) {
+		return defaultSelectionSetForModel(modelDefinition);
+	}
+
+	const selSet: string[] = [];
+
+	for (const f of selectionSet) {
+		const nested = f.includes('.');
+
+		if (nested) {
+			const [modelFieldName, selectedField] = f.split('.');
+
+			const relatedModel = fields[modelFieldName]?.type?.model;
+
+			if (!relatedModel) {
+				// TODO: may need to change this to support custom types
+				throw Error(`${modelFieldName} is not a model field`);
+			}
+
+			if (selectedField === SELECTION_SET_ALL_NESTED) {
+				const relatedModelDefinition = modelIntrospection[relatedModel];
+				const defaultSelectionSet = defaultSelectionSetForModel(
+					relatedModelDefinition
+				);
+
+				if (fields[modelFieldName]?.isArray) {
+					selSet.push(`${modelFieldName} { items { ${defaultSelectionSet} } }`);
+				} else {
+					selSet.push(`${modelFieldName} { ${defaultSelectionSet} }`);
+				}
+			}
+		} else {
+			const exists = Boolean(fields[f]);
+
+			if (!exists) {
+				throw Error(`${f} is not a field of model ${modelName}`);
+			}
+
+			selSet.push(f);
+		}
+	}
+
+	return selSet.join(' ');
+}
+
+export function generateGraphQLDocument(
+	modelIntrospection: any,
+	modelName: string,
+	modelOperation: ModelOperation,
+	listArgs?: ListArgs
+): string {
+	const modelDefinition = modelIntrospection[modelName];
+
+	const {
+		name,
+		pluralName,
+		fields,
+		primaryKeyInfo: {
+			isCustomPrimaryKey,
+			primaryKeyFieldName,
+			sortKeyFieldNames,
+		},
+	} = modelDefinition;
+
+	const { operationPrefix, usePlural } = graphQLOperationsInfo[modelOperation];
+
+	const { selectionSet } = listArgs || {};
+
+	const fromCache = graphQLDocumentsCache.get(name)?.get(modelOperation);
+
+	if (fromCache !== undefined) {
+		return fromCache;
+	}
+
+	if (!graphQLDocumentsCache.has(name)) {
+		graphQLDocumentsCache.set(name, new Map());
+	}
+
+	const graphQLFieldName = `${operationPrefix}${usePlural ? pluralName : name}`;
+	let graphQLOperationType: 'mutation' | 'query' | undefined;
+	let graphQLSelectionSet: string | undefined;
+	let graphQLArguments: Record<string, any> | undefined;
+
+	const selectionSetFields = generateSelectionSet(
+		modelIntrospection,
+		modelName,
+		selectionSet
+	);
+
+	console.log('generated sel set', selectionSetFields);
+
+	switch (modelOperation) {
+		case 'CREATE':
+		case 'UPDATE':
+		case 'DELETE':
+			graphQLArguments ??
+				(graphQLArguments = {
+					input: `${
+						operationPrefix.charAt(0).toLocaleUpperCase() +
+						operationPrefix.slice(1)
+					}${name}Input!`,
+				});
+			graphQLOperationType ?? (graphQLOperationType = 'mutation');
+		case 'READ':
+			graphQLArguments ??
+				(graphQLArguments = isCustomPrimaryKey
+					? [primaryKeyFieldName, ...sortKeyFieldNames].reduce(
+							(acc, fieldName) => {
+								acc[fieldName] = fields[fieldName].type;
+
+								return acc;
+							},
+							{}
+					  )
+					: {
+							[primaryKeyFieldName]: `${fields[primaryKeyFieldName].type}!`,
+					  });
+			graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
+		case 'LIST':
+			graphQLArguments ??
+				(graphQLArguments = {
+					filter: `Model${name}FilterInput`,
+				});
+			graphQLOperationType ?? (graphQLOperationType = 'query');
+			graphQLSelectionSet ??
+				(graphQLSelectionSet = `items { ${selectionSetFields} }`);
+	}
+
+	const graphQLDocument = `${graphQLOperationType}${
+		graphQLArguments
+			? `(${Object.entries(graphQLArguments).map(
+					([fieldName, type]) => `\$${fieldName}: ${type}`
+			  )})`
+			: ''
+	} { ${graphQLFieldName}${
+		graphQLArguments
+			? `(${Object.keys(graphQLArguments).map(
+					fieldName => `${fieldName}: \$${fieldName}`
+			  )})`
+			: ''
+	} { ${graphQLSelectionSet} } }`;
+
+	graphQLDocumentsCache.get(name)?.set(modelOperation, graphQLDocument);
+
+	return graphQLDocument;
+}
+
+export function buildGraphQLVariables(
+	modelDefinition: any,
+	operation: ModelOperation,
+	arg: any
+): object {
+	const {
+		fields,
+		primaryKeyInfo: {
+			isCustomPrimaryKey,
+			primaryKeyFieldName,
+			sortKeyFieldNames,
+		},
+	} = modelDefinition;
+
+	let variables = {};
+
+	// TODO: process input
+	switch (operation) {
+		case 'CREATE':
+			variables = { input: arg };
+			break;
+		case 'UPDATE':
+			// readonly fields are not  updated
+			variables = {
+				input: Object.fromEntries(
+					Object.entries(arg).filter(([fieldName]) => {
+						const { isReadOnly } = fields[fieldName];
+
+						return !isReadOnly;
+					})
+				),
+			};
+			break;
+		case 'READ':
+		case 'DELETE':
+			// only identifiers are sent
+			variables = isCustomPrimaryKey
+				? [primaryKeyFieldName, ...sortKeyFieldNames].reduce(
+						(acc, fieldName) => {
+							acc[fieldName] = arg[fieldName];
+
+							return acc;
+						},
+						{}
+				  )
+				: { [primaryKeyFieldName]: arg[primaryKeyFieldName] };
+
+			if (operation === 'DELETE') {
+				variables = { input: variables };
+			}
+			break;
+		case 'LIST':
+			if (arg?.filter) {
+				variables = { filter: arg.filter };
+			}
+			break;
+		default:
+			const exhaustiveCheck: never = operation;
+			throw new Error(`Unhandled operation case: ${exhaustiveCheck}`);
+	}
+
+	return variables;
+}