@aws-amplify/api-graphql 4.0.1-api-v6-models.3eb7748.0 → 4.0.1-api-v6-models.01b2bb8.0

package/lib-esm/utils/findIndexByFields.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Iterates through a collection to find a matching item and returns the index.
+ *
+ * @param needle The item to search for
+ * @param haystack The collection to search
+ * @param keyFields The fields used to indicate a match
+ * @returns Index of `needle` in `haystack`, otherwise -1 if not found.
+ */
+export declare function findIndexByFields<T>(needle: T, haystack: T[], keyFields: Array<keyof T>): number;

package/lib-esm/utils/findIndexByFields.js

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Iterates through a collection to find a matching item and returns the index.
+ *
+ * @param needle The item to search for
+ * @param haystack The collection to search
+ * @param keyFields The fields used to indicate a match
+ * @returns Index of `needle` in `haystack`, otherwise -1 if not found.
+ */
+export function findIndexByFields(needle, haystack, keyFields) {
+    var searchObject = Object.fromEntries(keyFields.map(function (fieldName) { return [fieldName, needle[fieldName]]; }));
+    var _loop_1 = function (i) {
+        if (Object.keys(searchObject).every(function (k) { return searchObject[k] === haystack[i][k]; })) {
+            return { value: i };
+        }
+    };
+    for (var i = 0; i < haystack.length; i++) {
+        var state_1 = _loop_1(i);
+        if (typeof state_1 === "object")
+            return state_1.value;
+    }
+    return -1;
+}

package/lib-esm/utils/index.d.ts

@@ -1,2 +1,4 @@
 export { resolveConfig } from './resolveConfig';
 export { resolveLibraryOptions } from './resolveLibraryOptions';
+export { resolvePKFields } from './resolvePKFields';
+export { findIndexByFields } from './findIndexByFields';

package/lib-esm/utils/index.js

@@ -2,3 +2,5 @@
 // SPDX-License-Identifier: Apache-2.0
 export { resolveConfig } from './resolveConfig';
 export { resolveLibraryOptions } from './resolveLibraryOptions';
+export { resolvePKFields } from './resolvePKFields';
+export { findIndexByFields } from './findIndexByFields';

package/lib-esm/utils/resolvePKFields.d.ts

@@ -0,0 +1,13 @@
+import { ResourcesConfig } from '@aws-amplify/core';
+type GraphQLConfig = Exclude<ResourcesConfig['API'], undefined>['GraphQL'];
+type ModelIntrospectionSchema = Exclude<Exclude<GraphQLConfig, undefined>['modelIntrospection'], undefined>;
+type SchemaModel = ModelIntrospectionSchema['models'][string];
+/**
+ * Given a SchemaModel from a ModelIntrospectionSchema, returns the primary key
+ * as an array of field names.
+ *
+ * @param model The model object
+ * @returns Array of field names
+ */
+export declare function resolvePKFields(model: SchemaModel): string[];
+export {};

package/lib-esm/utils/resolvePKFields.js

@@ -0,0 +1,12 @@
+import { __read, __spreadArray } from "tslib";
+/**
+ * Given a SchemaModel from a ModelIntrospectionSchema, returns the primary key
+ * as an array of field names.
+ *
+ * @param model The model object
+ * @returns Array of field names
+ */
+export function resolvePKFields(model) {
+    var _a = model.primaryKeyInfo, primaryKeyFieldName = _a.primaryKeyFieldName, sortKeyFieldNames = _a.sortKeyFieldNames;
+    return __spreadArray([primaryKeyFieldName], __read(sortKeyFieldNames), false);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.0.1-api-v6-models.3eb7748.0+3eb7748",
+	"version": "4.0.1-api-v6-models.01b2bb8.0+01b2bb8",
 	"description": "Api-graphql category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -52,9 +52,9 @@
 	],
 	"dependencies": {
 		"@aws-amplify/amplify-api-next-types-alpha": "^0.2.0",
-		"@aws-amplify/api-rest": "4.0.1-api-v6-models.3eb7748.0+3eb7748",
-		"@aws-amplify/auth": "6.0.1-api-v6-models.3eb7748.0+3eb7748",
-		"@aws-amplify/core": "6.0.1-api-v6-models.3eb7748.0+3eb7748",
+		"@aws-amplify/api-rest": "4.0.1-api-v6-models.01b2bb8.0+01b2bb8",
+		"@aws-amplify/auth": "6.0.1-api-v6-models.01b2bb8.0+01b2bb8",
+		"@aws-amplify/core": "6.0.1-api-v6-models.01b2bb8.0+01b2bb8",
 		"@aws-sdk/types": "3.387.0",
 		"graphql": "15.8.0",
 		"rxjs": "^7.8.1",
@@ -126,5 +126,5 @@
 			"<rootDir>/__tests__"
 		]
 	},
-	"gitHead": "3eb7748aee2fcdea705c93904d1f30ff596649fa"
+	"gitHead": "01b2bb8503ffd202c858da1ff6afeb7c008a4563"
 }

package/src/internals/APIClient.ts

@@ -157,6 +157,7 @@ export const graphQLOperationsInfo = {
 	ONCREATE: { operationPrefix: 'onCreate' as const, usePlural: false },
 	ONUPDATE: { operationPrefix: 'onUpdate' as const, usePlural: false },
 	ONDELETE: { operationPrefix: 'onDelete' as const, usePlural: false },
+	OBSERVE_QUERY: { operationPrefix: 'observeQuery' as const, usePlural: false },
 };
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 
@@ -164,7 +165,7 @@ type OperationPrefix =
 	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
 
 const graphQLDocumentsCache = new Map<string, Map<ModelOperation, string>>();
-const SELECTION_SET_ALL_NESTED = '*';
+const SELECTION_SET_WILDCARD = '*';
 
 function defaultSelectionSetForModel(modelDefinition: any): string[] {
 	// fields that are explicitly part of the graphql schema; not
@@ -208,78 +209,70 @@ export function customSelectionSetToIR(
 	selectionSet: string[]
 ): Record<string, string | object> {
 	const modelDefinition = modelIntrospection[modelName];
-	const { fields } = modelDefinition;
-
-	const intermediateSelectionSet: Record<string, string | object> = {};
+	const { fields: modelFields } = modelDefinition;
 
-	for (const f of selectionSet) {
-		const nested = f.includes('.');
+	return selectionSet.reduce((resultObj, path) => {
+		const [fieldName, nested, ...rest] = path.split('.');
 
 		if (nested) {
-			const [modelFieldName, selectedField] = f.split('.');
-
-			const relatedModel = fields[modelFieldName]?.type?.model;
+			const relatedModel = modelFields[fieldName]?.type?.model;
 
 			if (!relatedModel) {
 				// TODO: may need to change this to support custom types
-				throw Error(`${modelFieldName} is not a model field`);
+				throw Error(`${fieldName} is not a model field`);
 			}
 
-			if (selectedField === SELECTION_SET_ALL_NESTED) {
-				const relatedModelDefinition = modelIntrospection[relatedModel];
+			const relatedModelDefinition = modelIntrospection[relatedModel];
 
-				const defaultSelectionSet = defaultSelectionSetForModel(
-					relatedModelDefinition
-				);
+			const selectionSet =
+				nested === SELECTION_SET_WILDCARD
+					? defaultSelectionSetIR(relatedModelDefinition)
+					: // if we have a path like 'field.anotherField' recursively build up selection set IR
+					  customSelectionSetToIR(modelIntrospection, relatedModel, [
+							[nested, ...rest].join('.'),
+					  ]);
 
-				const reduced = defaultSelectionSet.reduce((acc, curVal) => {
-					acc[curVal] = FIELD_IR;
-					return acc;
-				}, {});
+			if (modelFields[fieldName]?.isArray) {
+				const existing = resultObj[fieldName] || {
+					items: {},
+				};
+				const merged = { ...existing.items, ...selectionSet };
 
-				if (fields[modelFieldName]?.isArray) {
-					intermediateSelectionSet[modelFieldName] = {
-						items: reduced,
-					};
-				} else {
-					intermediateSelectionSet[modelFieldName] = reduced;
-				}
-			} else {
-				const getNestedSelSet = customSelectionSetToIR(
-					modelIntrospection,
-					relatedModel,
-					[selectedField]
-				);
-
-				if (fields[modelFieldName]?.isArray) {
-					const existing = (intermediateSelectionSet as any)[
-						modelFieldName
-					] || { items: {} };
-					const merged = { ...existing.items, ...getNestedSelSet };
+				resultObj[fieldName] = { items: merged };
+				return resultObj;
+			}
 
-					intermediateSelectionSet[modelFieldName] = { items: merged };
-				} else {
-					const existingItems =
-						(intermediateSelectionSet as any)[modelFieldName] || {};
-					const merged = { ...existingItems, ...getNestedSelSet };
+			const existingItems = resultObj[fieldName] || {};
+			const merged = { ...existingItems, ...selectionSet };
 
-					intermediateSelectionSet[modelFieldName] = merged;
-				}
-			}
-		} else {
-			const exists = Boolean(fields[f]);
+			resultObj[fieldName] = merged;
+			return resultObj;
+		}
 
-			if (!exists) {
-				throw Error(`${f} is not a field of model ${modelName}`);
-			}
+		const exists = Boolean(modelFields[fieldName]);
 
-			intermediateSelectionSet[f] = FIELD_IR;
+		if (!exists) {
+			throw Error(`${fieldName} is not a field of model ${modelName}`);
 		}
-	}
 
-	return intermediateSelectionSet;
+		resultObj[fieldName] = FIELD_IR;
+		return resultObj;
+	}, {});
 }
 
+const defaultSelectionSetIR = relatedModelDefinition => {
+	const defaultSelectionSet = defaultSelectionSetForModel(
+		relatedModelDefinition
+	);
+
+	const reduced = defaultSelectionSet.reduce((acc, curVal) => {
+		acc[curVal] = FIELD_IR;
+		return acc;
+	}, {});
+
+	return reduced;
+};
+
 /**
  * Stringifies selection set IR
  * * @example
@@ -419,10 +412,12 @@ export function generateGraphQLDocument(
 			graphQLArguments ??
 				(graphQLArguments = {
 					filter: `Model${name}FilterInput`,
+					limit: 'Int',
+					nextToken: 'String',
 				});
 			graphQLOperationType ?? (graphQLOperationType = 'query');
 			graphQLSelectionSet ??
-				(graphQLSelectionSet = `items { ${selectionSetFields} }`);
+				(graphQLSelectionSet = `items { ${selectionSetFields} } nextToken __typename`);
 		case 'ONCREATE':
 		case 'ONUPDATE':
 		case 'ONDELETE':
@@ -432,6 +427,12 @@ export function generateGraphQLDocument(
 				});
 			graphQLOperationType ?? (graphQLOperationType = 'subscription');
 			graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
+			break;
+		case 'OBSERVE_QUERY':
+		default:
+			throw new Error(
+				'Internal error: Attempted to generate graphql document for observeQuery. Please report this error.'
+			);
 	}
 
 	const graphQLDocument = `${graphQLOperationType}${
@@ -468,7 +469,7 @@ export function buildGraphQLVariables(
 		},
 	} = modelDefinition;
 
-	let variables = {};
+	let variables: Record<string, any> = {};
 
 	// TODO: process input
 	switch (operation) {
@@ -510,6 +511,13 @@ export function buildGraphQLVariables(
 			}
 			break;
 		case 'LIST':
+			if (arg?.filter) {
+				variables.filter = arg.filter;
+			}
+			if (arg?.nextToken) {
+				variables.nextToken = arg.nextToken;
+			}
+			break;
 		case 'ONCREATE':
 		case 'ONUPDATE':
 		case 'ONDELETE':
@@ -517,6 +525,11 @@ export function buildGraphQLVariables(
 				variables = { filter: arg.filter };
 			}
 			break;
+		case 'OBSERVE_QUERY':
+			throw new Error(
+				'Internal error: Attempted to build variables for observeQuery. Please report this error.'
+			);
+			break;
 		default:
 			const exhaustiveCheck: never = operation;
 			throw new Error(`Unhandled operation case: ${exhaustiveCheck}`);

package/src/internals/generateModelsProperty.ts

@@ -11,6 +11,7 @@ import {
 } from './APIClient';
 import { ClientGenerationParams } from './types';
 import { V6Client, GraphqlSubscriptionResult } from '../types';
+import { findIndexByFields, resolvePKFields } from '../utils';
 import { Observable, map } from 'rxjs';
 
 export function generateModelsProperty<T extends Record<any, any> = never>(
@@ -52,7 +53,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 						);
 
 						try {
-							const { data, nextToken, extensions } = (await client.graphql({
+							const { data, extensions } = (await client.graphql({
 								query,
 								variables,
 							})) as any;
@@ -68,7 +69,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 									if (args?.selectionSet) {
 										return {
 											data: flattenedResult,
-											nextToken,
+											nextToken: data[key].nextToken,
 											extensions,
 										};
 									} else {
@@ -81,7 +82,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 
 										return {
 											data: initialized,
-											nextToken,
+											nextToken: data[key].nextToken,
 											extensions,
 										};
 									}
@@ -89,7 +90,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 
 								return {
 									data: data[key],
-									nextToken,
+									nextToken: data[key].nextToken,
 									extensions,
 								};
 							}
@@ -129,6 +130,148 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 							})
 						);
 					};
+				} else if (operation === 'OBSERVE_QUERY') {
+					models[name][operationPrefix] = (arg?: any, options?: any) =>
+						new Observable(subscriber => {
+							// what we'll be sending to our subscribers
+							const items: object[] = [];
+
+							// To enqueue subscription messages while we collect our initial
+							// result set.
+							const messageQueue = [] as {
+								type: 'create' | 'update' | 'delete';
+								item: object;
+							}[];
+
+							// operation to take when message(s) arrive.
+							// this operation will be swapped out once initial "sync" is complete
+							// to immediately ingest messsages.
+							let receiveMessages = (...messages: typeof messageQueue) => {
+								return messageQueue.push(...messages);
+							};
+
+							// start subscriptions
+							const onCreateSub = models[name]
+								.onCreate(arg, options)
+								.subscribe({
+									next(item) {
+										receiveMessages({ item, type: 'create' });
+									},
+									error(error) {
+										subscriber.error({ type: 'onCreate', error });
+									},
+								});
+							const onUpdateSub = models[name]
+								.onUpdate(arg, options)
+								.subscribe({
+									next(item) {
+										receiveMessages({ item, type: 'update' });
+									},
+									error(error) {
+										subscriber.error({ type: 'onUpdate', error });
+									},
+								});
+							const onDeleteSub = models[name]
+								.onDelete(arg, options)
+								.subscribe({
+									next(item) {
+										receiveMessages({ item, type: 'delete' });
+									},
+									error(error) {
+										subscriber.error({ type: 'onDelete', error });
+									},
+								});
+
+							// consumes a list of messages and sends a snapshot
+							function ingestMessages(messages: typeof messageQueue) {
+								for (const message of messages) {
+									const idx = findIndexByFields(
+										message.item,
+										items,
+										pkFields as any
+									);
+									switch (message.type) {
+										case 'create':
+											if (idx < 0) items.push(message.item);
+											break;
+										case 'update':
+											if (idx >= 0) items[idx] = message.item;
+											break;
+										case 'delete':
+											if (idx >= 0) items.splice(idx, 1);
+											break;
+										default:
+											console.error(
+												'Unrecognized message in observeQuery.',
+												message
+											);
+									}
+								}
+								subscriber.next({
+									items,
+									isSynced: true,
+								});
+							}
+
+							const pkFields = resolvePKFields(model);
+
+							// initial results
+							(async () => {
+								let firstPage = true;
+								let nextToken: string | null = null;
+								while (!subscriber.closed && (firstPage || nextToken)) {
+									firstPage = false;
+
+									const {
+										data: page,
+										errors,
+										nextToken: _nextToken,
+									} = await models[name].list({ ...arg, nextToken }, options);
+									nextToken = _nextToken;
+
+									items.push(...page);
+
+									// if there are no more pages and no items we already know about
+									// that need to be merged in from sub, we're "synced"
+									const isSynced =
+										messageQueue.length === 0 &&
+										(nextToken === null || nextToken === undefined);
+
+									subscriber.next({
+										items,
+										isSynced,
+									});
+
+									if (Array.isArray(errors)) {
+										for (const error of errors) {
+											subscriber.error(error);
+										}
+									}
+								}
+
+								// play through the queue
+								if (messageQueue.length > 0) {
+									ingestMessages(messageQueue);
+								}
+
+								// switch the queue to write directly to the items collection
+								receiveMessages = (...messages: typeof messageQueue) => {
+									ingestMessages(messages);
+									return items.length;
+								};
+							})();
+
+							// when subscriber unsubscribes, tear down internal subs
+							return () => {
+								// 1. tear down internal subs
+								onCreateSub.unsubscribe();
+								onUpdateSub.unsubscribe();
+								onDeleteSub.unsubscribe();
+
+								// 2. there is no need to explicitly stop paging. instead, we
+								// just check `subscriber.closed` above before fetching each page.
+							};
+						});
 				} else {
 					models[name][operationPrefix] = async (arg?: any, options?: any) => {
 						const query = generateGraphQLDocument(

package/src/utils/findIndexByFields.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Iterates through a collection to find a matching item and returns the index.
+ *
+ * @param needle The item to search for
+ * @param haystack The collection to search
+ * @param keyFields The fields used to indicate a match
+ * @returns Index of `needle` in `haystack`, otherwise -1 if not found.
+ */
+export function findIndexByFields<T>(
+	needle: T,
+	haystack: T[],
+	keyFields: Array<keyof T>
+): number {
+	const searchObject = Object.fromEntries(
+		keyFields.map(fieldName => [fieldName, needle[fieldName]])
+	);
+
+	for (let i = 0; i < haystack.length; i++) {
+		if (
+			Object.keys(searchObject).every(k => searchObject[k] === haystack[i][k])
+		) {
+			return i;
+		}
+	}
+
+	return -1;
+}

package/src/utils/index.ts

@@ -3,3 +3,5 @@
 
 export { resolveConfig } from './resolveConfig';
 export { resolveLibraryOptions } from './resolveLibraryOptions';
+export { resolvePKFields } from './resolvePKFields';
+export { findIndexByFields } from './findIndexByFields';

package/src/utils/resolvePKFields.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ResourcesConfig } from '@aws-amplify/core';
+
+type GraphQLConfig = Exclude<ResourcesConfig['API'], undefined>['GraphQL'];
+type ModelIntrospectionSchema = Exclude<
+	Exclude<GraphQLConfig, undefined>['modelIntrospection'],
+	undefined
+>;
+type SchemaModel = ModelIntrospectionSchema['models'][string];
+
+/**
+ * Given a SchemaModel from a ModelIntrospectionSchema, returns the primary key
+ * as an array of field names.
+ *
+ * @param model The model object
+ * @returns Array of field names
+ */
+export function resolvePKFields(model: SchemaModel) {
+	const { primaryKeyFieldName, sortKeyFieldNames } = model.primaryKeyInfo;
+	return [primaryKeyFieldName, ...sortKeyFieldNames];
+}