@aws-amplify/api-graphql 4.0.1 → 4.0.2-unstable.b778a9e.0

package/src/internals/InternalGraphQLAPI.ts

@@ -400,7 +400,7 @@ export class InternalGraphQLAPIClass {
 				variables,
 				appSyncGraphqlEndpoint: config?.endpoint,
 				region: config?.region,
-				authenticationType: authMode ?? config?.defaultAuthMode,
+				authenticationType: authMode || config?.defaultAuthMode,
 				apiKey: config?.apiKey,
 				additionalHeaders,
 			},

package/src/internals/generateClient.ts

@@ -0,0 +1,33 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { graphql, cancel, isCancelError } from './v6';
+import { generateModelsProperty } from './generateModelsProperty';
+import { V6Client, __amplify, __authMode, __authToken } from '../types';
+import { ClientGenerationParams } from './types';
+
+/**
+ * @private
+ *
+ * Creates a client that can be used to make GraphQL requests, using a provided `AmplifyClassV6`
+ * compatible context object for config and auth fetching.
+ *
+ * @param params
+ * @returns
+ */
+export function generateClient<T extends Record<any, any> = never>(
+	params: ClientGenerationParams
+): V6Client<T> {
+	const client = {
+		[__amplify]: params.amplify,
+		[__authMode]: params.authMode,
+		[__authToken]: params.authToken,
+		graphql,
+		cancel,
+		isCancelError,
+		models: {},
+	} as any;
+
+	client.models = generateModelsProperty<T>(client, params);
+
+	return client as V6Client<T>;
+}

package/src/internals/generateModelsProperty.ts

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ModelTypes } from '@aws-amplify/data-schema-types';
+import { graphQLOperationsInfo, ModelOperation } from './APIClient';
+import { ClientGenerationParams } from './types';
+import { V6Client, __authMode, __authToken } from '../types';
+
+import { listFactory } from './operations/list';
+import { getFactory } from './operations/get';
+import { subscriptionFactory } from './operations/subscription';
+import { observeQueryFactory } from './operations/observeQuery';
+
+export function generateModelsProperty<T extends Record<any, any> = never>(
+	client: V6Client,
+	params: ClientGenerationParams
+): ModelTypes<T> {
+	const models = {} as any;
+	const config = params.amplify.getConfig();
+
+	if (!config.API?.GraphQL) {
+		throw new Error(
+			'The API configuration is missing. This is likely due to Amplify.configure() not being called prior to generateClient().'
+		);
+	}
+
+	const modelIntrospection = config.API?.GraphQL?.modelIntrospection;
+	if (!modelIntrospection) {
+		return {} as any;
+	}
+
+	const SUBSCRIPTION_OPS = ['ONCREATE', 'ONUPDATE', 'ONDELETE'];
+
+	for (const model of Object.values(modelIntrospection.models)) {
+		const { name } = model as any;
+
+		models[name] = {} as any;
+
+		Object.entries(graphQLOperationsInfo).forEach(
+			([key, { operationPrefix }]) => {
+				const operation = key as ModelOperation;
+
+				if (operation === 'LIST') {
+					models[name][operationPrefix] = listFactory(
+						client,
+						modelIntrospection,
+						model
+					);
+				} else if (SUBSCRIPTION_OPS.includes(operation)) {
+					models[name][operationPrefix] = subscriptionFactory(
+						client,
+						modelIntrospection,
+						model,
+						operation
+					);
+				} else if (operation === 'OBSERVE_QUERY') {
+					models[name][operationPrefix] = observeQueryFactory(models, model);
+				} else {
+					models[name][operationPrefix] = getFactory(
+						client,
+						modelIntrospection,
+						model,
+						operation
+					);
+				}
+			}
+		);
+	}
+
+	return models;
+}

package/src/internals/index.ts

@@ -6,3 +6,4 @@ export {
 } from './InternalGraphQLAPI';
 
 export { graphql, cancel, isCancelError } from './v6';
+export { generateClient } from './generateClient';

package/src/internals/operations/get.ts

@@ -0,0 +1,121 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import {
+	initializeModel,
+	generateGraphQLDocument,
+	buildGraphQLVariables,
+	flattenItems,
+	authModeParams,
+} from '../APIClient';
+
+export function getFactory(
+	client,
+	modelIntrospection,
+	model,
+	operation,
+	context = false
+) {
+	const getWithContext = async (
+		contextSpec: AmplifyServer.ContextSpec,
+		arg?: any,
+		options?: any
+	) => {
+		return _get(
+			client,
+			modelIntrospection,
+			model,
+			arg,
+			options,
+			operation,
+			contextSpec
+		);
+	};
+
+	const get = async (arg?: any, options?: any) => {
+		return _get(
+			client,
+			modelIntrospection,
+			model,
+			arg,
+			options,
+			operation,
+			context
+		);
+	};
+
+	return context ? getWithContext : get;
+}
+
+async function _get(
+	client,
+	modelIntrospection,
+	model,
+	arg,
+	options,
+	operation,
+	context
+) {
+	const { name } = model as any;
+
+	const query = generateGraphQLDocument(
+		modelIntrospection.models,
+		name,
+		operation,
+		options
+	);
+	const variables = buildGraphQLVariables(
+		model,
+		operation,
+		arg,
+		modelIntrospection
+	);
+
+	try {
+		const auth = authModeParams(client, options);
+		const { data, extensions } = context
+			? ((await client.graphql(context, {
+					...auth,
+					query,
+					variables,
+			  })) as any)
+			: ((await client.graphql({
+					...auth,
+					query,
+					variables,
+			  })) as any);
+
+		// flatten response
+		if (data !== undefined) {
+			const [key] = Object.keys(data);
+			const flattenedResult = flattenItems(data)[key];
+
+			if (options?.selectionSet) {
+				return { data: flattenedResult, extensions };
+			} else {
+				// TODO: refactor to avoid destructuring here
+				const [initialized] = initializeModel(
+					client,
+					name,
+					[flattenedResult],
+					modelIntrospection,
+					auth.authMode,
+					auth.authToken,
+					context
+				);
+
+				return { data: initialized, extensions };
+			}
+		} else {
+			return { data: null, extensions };
+		}
+	} catch (error) {
+		if (error.errors) {
+			// graphql errors pass through
+			return error as any;
+		} else {
+			// non-graphql errors re re-thrown
+			throw error;
+		}
+	}
+}

package/src/internals/operations/list.ts

@@ -0,0 +1,111 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import {
+	initializeModel,
+	generateGraphQLDocument,
+	buildGraphQLVariables,
+	flattenItems,
+	authModeParams,
+} from '../APIClient';
+
+export function listFactory(
+	client,
+	modelIntrospection,
+	model,
+	context = false
+) {
+	const listWithContext = async (
+		contextSpec: AmplifyServer.ContextSpec,
+		args?: any
+	) => {
+		return _list(client, modelIntrospection, model, args, contextSpec);
+	};
+
+	const list = async (args?: any) => {
+		return _list(client, modelIntrospection, model, args, context);
+	};
+
+	return context ? listWithContext : list;
+}
+
+async function _list(client, modelIntrospection, model, args, context) {
+	const { name } = model as any;
+
+	const query = generateGraphQLDocument(
+		modelIntrospection.models,
+		name,
+		'LIST',
+		args
+	);
+	const variables = buildGraphQLVariables(
+		model,
+		'LIST',
+		args,
+		modelIntrospection
+	);
+
+	try {
+		const auth = authModeParams(client, args);
+
+		const { data, extensions } = context
+			? ((await client.graphql(context, {
+					...auth,
+					query,
+					variables,
+			  })) as any)
+			: ((await client.graphql({
+					...auth,
+					query,
+					variables,
+			  })) as any);
+
+		// flatten response
+		if (data !== undefined) {
+			const [key] = Object.keys(data);
+
+			if (data[key].items) {
+				const flattenedResult = flattenItems(data)[key];
+
+				// don't init if custom selection set
+				if (args?.selectionSet) {
+					return {
+						data: flattenedResult,
+						nextToken: data[key].nextToken,
+						extensions,
+					};
+				} else {
+					const initialized = initializeModel(
+						client,
+						name,
+						flattenedResult,
+						modelIntrospection,
+						auth.authMode,
+						auth.authToken,
+						context
+					);
+
+					return {
+						data: initialized,
+						nextToken: data[key].nextToken,
+						extensions,
+					};
+				}
+			}
+
+			return {
+				data: data[key],
+				nextToken: data[key].nextToken,
+				extensions,
+			};
+		}
+	} catch (error) {
+		if (error.errors) {
+			// graphql errors pass through
+			return error as any;
+		} else {
+			// non-graphql errors re re-thrown
+			throw error;
+		}
+	}
+}

package/src/internals/operations/observeQuery.ts

@@ -0,0 +1,140 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Observable, map } from 'rxjs';
+import { findIndexByFields, resolvePKFields } from '../../utils';
+
+export function observeQueryFactory(models, model) {
+	const { name } = model as any;
+
+	const observeQuery = (arg?: 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).subscribe({
+				next(item) {
+					receiveMessages({ item, type: 'create' });
+				},
+				error(error) {
+					subscriber.error({ type: 'onCreate', error });
+				},
+			});
+			const onUpdateSub = models[name].onUpdate(arg).subscribe({
+				next(item) {
+					receiveMessages({ item, type: 'update' });
+				},
+				error(error) {
+					subscriber.error({ type: 'onUpdate', error });
+				},
+			});
+			const onDeleteSub = models[name].onDelete(arg).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 });
+					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.
+			};
+		});
+
+	return observeQuery;
+}

package/src/internals/operations/subscription.ts

@@ -0,0 +1,59 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { map } from 'rxjs';
+import { GraphqlSubscriptionResult } from '../../types';
+import {
+	initializeModel,
+	generateGraphQLDocument,
+	buildGraphQLVariables,
+	authModeParams,
+} from '../APIClient';
+
+export function subscriptionFactory(
+	client,
+	modelIntrospection,
+	model,
+	operation
+) {
+	const { name } = model as any;
+
+	const subscription = (args?: any) => {
+		const query = generateGraphQLDocument(
+			modelIntrospection.models,
+			name,
+			operation
+		);
+		const variables = buildGraphQLVariables(
+			model,
+			operation,
+			args,
+			modelIntrospection
+		);
+
+		const auth = authModeParams(client, args);
+
+		const observable = client.graphql({
+			...auth,
+			query,
+			variables,
+		}) as GraphqlSubscriptionResult<object>;
+
+		return observable.pipe(
+			map(value => {
+				const [key] = Object.keys(value.data);
+				const [initialized] = initializeModel(
+					client,
+					name,
+					[value.data[key]],
+					modelIntrospection,
+					auth.authMode,
+					auth.authToken
+				);
+				return initialized;
+			})
+		);
+	};
+
+	return subscription;
+}

package/src/internals/server/generateClient.ts

@@ -0,0 +1,45 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { graphql, cancel, isCancelError } from '../';
+import { generateModelsProperty } from './generateModelsProperty';
+import {
+	__amplify,
+	__authMode,
+	__authToken,
+	V6ClientSSRRequest,
+	V6ClientSSRCookies,
+	ServerClientGenerationParams,
+	CommonPublicClientOptions,
+} from '../../types';
+
+/**
+ * @private
+ *
+ * Creates a client that can be used to make GraphQL requests, using a provided `AmplifyClassV6`
+ * compatible context object for config and auth fetching.
+ *
+ * @param params
+ * @returns
+ */
+export function generateClient<
+	T extends Record<any, any> = never,
+	ClientType extends
+		| V6ClientSSRRequest<T>
+		| V6ClientSSRCookies<T> = V6ClientSSRCookies<T>
+>(
+	params: ServerClientGenerationParams & CommonPublicClientOptions
+): ClientType {
+	const client = {
+		[__amplify]: params.amplify,
+		[__authMode]: params.authMode,
+		[__authToken]: params.authToken,
+		graphql,
+		cancel,
+		isCancelError,
+	} as any;
+
+	client.models = generateModelsProperty<T, ClientType>(client, params);
+
+	return client as ClientType;
+}

package/src/internals/server/generateModelsProperty.ts

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { graphQLOperationsInfo, ModelOperation } from '../APIClient';
+import { ServerClientGenerationParams } from '../../types/';
+import { V6ClientSSRRequest, V6ClientSSRCookies } from '../../types';
+
+import { listFactory } from '../operations/list';
+import { getFactory } from '../operations/get';
+
+export function generateModelsProperty<
+	T extends Record<any, any> = never,
+	ClientType extends
+		| V6ClientSSRRequest<T>
+		| V6ClientSSRCookies<T> = V6ClientSSRCookies<T>
+>(client: ClientType, params: ServerClientGenerationParams): ClientType {
+	const models = {} as any;
+	const config = params.config;
+	const useContext = client === null;
+
+	if (!config) {
+		// TODO: improve
+		throw new Error('generateModelsProperty cannot retrieve Amplify config');
+	}
+
+	const modelIntrospection = config.API?.GraphQL?.modelIntrospection;
+	if (!modelIntrospection) {
+		return {} as any;
+	}
+
+	const SSR_UNSUPORTED_OPS = [
+		'ONCREATE',
+		'ONUPDATE',
+		'ONDELETE',
+		'OBSERVE_QUERY',
+	];
+
+	for (const model of Object.values(modelIntrospection.models)) {
+		const { name } = model as any;
+		models[name] = {} as any;
+
+		Object.entries(graphQLOperationsInfo).forEach(
+			([key, { operationPrefix }]) => {
+				const operation = key as ModelOperation;
+
+				// subscriptions are not supported in SSR
+				if (SSR_UNSUPORTED_OPS.includes(operation)) return;
+
+				if (operation === 'LIST') {
+					models[name][operationPrefix] = listFactory(
+						client,
+						modelIntrospection,
+						model,
+						useContext
+					);
+				} else {
+					models[name][operationPrefix] = getFactory(
+						client,
+						modelIntrospection,
+						model,
+						operation,
+						useContext
+					);
+				}
+			}
+		);
+	}
+
+	return models;
+}

package/src/internals/server/index.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { generateClient } from './generateClient';

package/src/internals/types.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AmplifyClassV6 } from '@aws-amplify/core';
+import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
+
+/**
+ * @private
+ *
+ * The knobs available for configuring `generateClient` internally.
+ */
+export type ClientGenerationParams = {
+	amplify: AmplifyClassV6;
+} & CommonPublicClientOptions;
+
+/**
+ * Common options that can be used on public `generateClient()` interfaces.
+ */
+export type CommonPublicClientOptions = {
+	authMode?: GraphQLAuthMode;
+	authToken?: string;
+};