@aws-amplify/api-graphql 4.0.22 → 4.0.23

package/src/internals/operations/custom.ts

@@ -2,31 +2,52 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 import {
-	initializeModel,
-	flattenItems,
+	CustomOperation,
+	ModelIntrospectionSchema,
+} from '@aws-amplify/core/internals/utils';
+import { map } from 'rxjs';
+
+import {
 	authModeParams,
-	getCustomHeaders,
+	defaultSelectionSetForNonModelWithIR,
+	flattenItems,
 	generateSelectionSet,
+	getCustomHeaders,
+	initializeModel,
 	selectionSetIRToString,
-	defaultSelectionSetForNonModelWithIR,
 } from '../APIClient';
 import {
 	AuthModeParams,
 	ClientWithModels,
-	GraphQLOptionsV6,
 	GraphQLResult,
+	GraphqlSubscriptionResult,
 	ListArgs,
 	QueryArgs,
 	V6Client,
 	V6ClientSSRRequest,
 } from '../../types';
-import {
-	ModelIntrospectionSchema,
-	SchemaModel,
-	SchemaNonModel,
-	CustomOperation,
-	CustomOperationArgument,
-} from '@aws-amplify/core/internals/utils';
+
+type CustomOperationOptions = AuthModeParams & ListArgs;
+
+// these are the 4 possible sets of arguments custom operations methods can receive
+type OpArgs =
+	// SSR Request Client w Args defined
+	| [AmplifyServer.ContextSpec, QueryArgs, CustomOperationOptions]
+	// SSR Request Client without Args defined
+	| [AmplifyServer.ContextSpec, CustomOperationOptions]
+	// Client or SSR Cookies Client w Args defined
+	| [QueryArgs, CustomOperationOptions]
+	// Client or SSR Cookies Client without Args defined
+	| [CustomOperationOptions];
+
+/**
+ * Type guard for checking whether a Custom Operation argument is a contextSpec object
+ */
+const argIsContextSpec = (
+	arg: OpArgs[number],
+): arg is AmplifyServer.ContextSpec => {
+	return typeof (arg as AmplifyServer.ContextSpec)?.token?.value === 'symbol';
+};
 
 /**
  * Builds an operation function, embedded with all client and context data, that
@@ -87,27 +108,50 @@ import {
 export function customOpFactory(
 	client: ClientWithModels,
 	modelIntrospection: ModelIntrospectionSchema,
-	operationType: 'query' | 'mutation',
+	operationType: 'query' | 'mutation' | 'subscription',
 	operation: CustomOperation,
 	useContext: boolean,
 ) {
-	const opWithContext = async (
-		contextSpec: AmplifyServer.ContextSpec & GraphQLOptionsV6<unknown, string>,
-		arg?: QueryArgs,
-		options?: AuthModeParams & ListArgs,
-	) => {
-		return _op(
-			client,
-			modelIntrospection,
-			operationType,
-			operation,
-			arg,
-			options,
-			contextSpec,
-		);
-	};
+	// .arguments() are defined for the custom operation in the schema builder
+	// and are present in the model introspection schema
+	const argsDefined = operation.arguments !== undefined;
+
+	const op = (...args: OpArgs) => {
+		// options is always the last argument
+		const options = args[args.length - 1] as CustomOperationOptions;
+
+		let contextSpec: AmplifyServer.ContextSpec | undefined;
+		let arg: QueryArgs | undefined;
+
+		if (useContext) {
+			if (argIsContextSpec(args[0])) {
+				contextSpec = args[0];
+			} else {
+				throw new Error(
+					`Invalid first argument passed to ${operation.name}. Expected contextSpec`,
+				);
+			}
+		}
+
+		if (argsDefined) {
+			if (useContext) {
+				arg = args[1] as QueryArgs;
+			} else {
+				arg = args[0] as QueryArgs;
+			}
+		}
+
+		if (operationType === 'subscription') {
+			return _opSubscription(
+				// subscriptions are only enabled on the clientside
+				client as V6Client<Record<string, any>>,
+				modelIntrospection,
+				operation,
+				arg,
+				options,
+			);
+		}
 
-	const op = async (arg?: QueryArgs, options?: AuthModeParams & ListArgs) => {
 		return _op(
 			client,
 			modelIntrospection,
@@ -115,10 +159,11 @@ export function customOpFactory(
 			operation,
 			arg,
 			options,
+			contextSpec,
 		);
 	};
 
-	return useContext ? opWithContext : op;
+	return op;
 }
 
 /**
@@ -162,15 +207,20 @@ function hasStringField<Field extends string>(
  * @returns "outer" arguments string
  */
 function outerArguments(operation: CustomOperation): string {
+	if (operation.arguments === undefined) {
+		return '';
+	}
 	const args = Object.entries(operation.arguments)
 		.map(([k, v]) => {
 			const baseType = v.type + (v.isRequired ? '!' : '');
 			const finalType = v.isArray
 				? `[${baseType}]${v.isArrayNullable ? '' : '!'}`
 				: baseType;
+
 			return `$${k}: ${finalType}`;
 		})
 		.join(', ');
+
 	return args.length > 0 ? `(${args})` : '';
 }
 
@@ -194,9 +244,13 @@ function outerArguments(operation: CustomOperation): string {
  * @returns "outer" arguments string
  */
 function innerArguments(operation: CustomOperation): string {
-	const args = Object.entries(operation.arguments)
-		.map(([k, v]) => `${k}: $${k}`)
+	if (operation.arguments === undefined) {
+		return '';
+	}
+	const args = Object.keys(operation.arguments)
+		.map(k => `${k}: $${k}`)
 		.join(', ');
+
 	return args.length > 0 ? `(${args})` : '';
 }
 
@@ -234,6 +288,7 @@ function operationSelectionSet(
 		return '';
 	} else if (hasStringField(operation.type, 'nonModel')) {
 		const nonModel = modelIntrospection.nonModels[operation.type.nonModel];
+
 		return `{${selectionSetIRToString(
 			defaultSelectionSetForNonModelWithIR(nonModel, modelIntrospection),
 		)}}`;
@@ -257,6 +312,9 @@ function operationVariables(
 	args: QueryArgs = {},
 ): Record<string, unknown> {
 	const variables = {} as Record<string, unknown>;
+	if (operation.arguments === undefined) {
+		return variables;
+	}
 	for (const argDef of Object.values(operation.arguments)) {
 		if (typeof args[argDef.name] !== 'undefined') {
 			variables[argDef.name] = args[argDef.name];
@@ -266,6 +324,7 @@ function operationVariables(
 			throw new Error(`${operation.name} requires arguments '${argDef.name}'`);
 		}
 	}
+
 	return variables;
 }
 
@@ -363,3 +422,71 @@ async function _op(
 		}
 	}
 }
+
+/**
+ * Executes an operation from the given model intro schema against a client, returning
+ * a fully instantiated model when relevant.
+ *
+ * @param client The client to operate `graphql()` calls through.
+ * @param modelIntrospection The model intro schema to construct requests from.
+ * @param operation The specific operation name, args, return type details.
+ * @param args The arguments to provide to the operation as variables.
+ * @param options Request options like headers, etc.
+ * @returns Result from the graphql request, model-instantiated when relevant.
+ */
+function _opSubscription(
+	client: V6Client<Record<string, any>>,
+	modelIntrospection: ModelIntrospectionSchema,
+	operation: CustomOperation,
+	args?: QueryArgs,
+	options?: AuthModeParams & ListArgs,
+) {
+	const operationType = 'subscription';
+	const { name: operationName } = operation;
+	const auth = authModeParams(client, options);
+	const headers = getCustomHeaders(client, options?.headers);
+	const outerArgsString = outerArguments(operation);
+	const innerArgsString = innerArguments(operation);
+	const selectionSet = operationSelectionSet(modelIntrospection, operation);
+
+	const returnTypeModelName = hasStringField(operation.type, 'model')
+		? operation.type.model
+		: undefined;
+
+	const query = `
+		${operationType.toLocaleLowerCase()}${outerArgsString} {
+			${operationName}${innerArgsString} ${selectionSet}
+		}
+	`;
+
+	const variables = operationVariables(operation, args);
+
+	const observable = client.graphql(
+		{
+			...auth,
+			query,
+			variables,
+		},
+		headers,
+	) as GraphqlSubscriptionResult<object>;
+
+	return observable.pipe(
+		map(value => {
+			const [key] = Object.keys(value.data);
+			const data = (value.data as any)[key];
+
+			const [initialized] = returnTypeModelName
+				? initializeModel(
+						client as V6Client<Record<string, any>>,
+						returnTypeModelName,
+						[data],
+						modelIntrospection,
+						auth.authMode,
+						auth.authToken,
+					)
+				: [data];
+
+			return initialized;
+		}),
+	);
+}

package/src/internals/operations/get.ts

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

package/src/internals/operations/list.ts

@@ -2,25 +2,26 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 import {
-	initializeModel,
-	generateGraphQLDocument,
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
+
+import {
+	authModeParams,
 	buildGraphQLVariables,
 	flattenItems,
-	authModeParams,
+	generateGraphQLDocument,
 	getCustomHeaders,
+	initializeModel,
 } from '../APIClient';
 import {
 	AuthModeParams,
 	ClientWithModels,
+	GraphQLResult,
 	ListArgs,
 	V6Client,
 	V6ClientSSRRequest,
-	GraphQLResult,
 } from '../../types';
-import {
-	ModelIntrospectionSchema,
-	SchemaModel,
-} from '@aws-amplify/core/internals/utils';
 
 export function listFactory(
 	client: ClientWithModels,
@@ -51,12 +52,7 @@ async function _list(
 ) {
 	const { name } = model;
 
-	const query = generateGraphQLDocument(
-		modelIntrospection,
-		name,
-		'LIST',
-		args,
-	);
+	const query = generateGraphQLDocument(modelIntrospection, name, 'LIST', args);
 	const variables = buildGraphQLVariables(
 		model,
 		'LIST',
@@ -69,7 +65,7 @@ async function _list(
 
 		const headers = getCustomHeaders(client, args?.headers);
 
-		const { data, extensions } = !!contextSpec
+		const { data, extensions } = contextSpec
 			? ((await (client as V6ClientSSRRequest<Record<string, any>>).graphql(
 					contextSpec,
 					{

package/src/internals/operations/observeQuery.ts

@@ -1,9 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Observable } from 'rxjs';
-import { findIndexByFields, resolvePKFields } from '../../utils';
 import { SchemaModel } from '@aws-amplify/core/internals/utils';
 
+import { findIndexByFields, resolvePKFields } from '../../utils';
+
 export function observeQueryFactory(models: any, model: SchemaModel) {
 	const { name } = model;
 
@@ -124,6 +125,7 @@ export function observeQueryFactory(models: any, model: SchemaModel) {
 				// switch the queue to write directly to the items collection
 				receiveMessages = (...messages: typeof messageQueue) => {
 					ingestMessages(messages);
+
 					return items.length;
 				};
 			})();

package/src/internals/operations/subscription.ts

@@ -2,20 +2,21 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { map } from 'rxjs';
-import { V6Client, GraphqlSubscriptionResult } from '../../types';
-import {
-	initializeModel,
-	generateGraphQLDocument,
-	buildGraphQLVariables,
-	authModeParams,
-	ModelOperation,
-	getCustomHeaders,
-} from '../APIClient';
 import {
 	ModelIntrospectionSchema,
 	SchemaModel,
 } from '@aws-amplify/core/internals/utils';
 
+import { GraphqlSubscriptionResult, V6Client } from '../../types';
+import {
+	ModelOperation,
+	authModeParams,
+	buildGraphQLVariables,
+	generateGraphQLDocument,
+	getCustomHeaders,
+	initializeModel,
+} from '../APIClient';
+
 export function subscriptionFactory(
 	client: any,
 	modelIntrospection: ModelIntrospectionSchema,
@@ -29,7 +30,7 @@ export function subscriptionFactory(
 			modelIntrospection,
 			name,
 			operation,
-			args
+			args,
 		);
 
 		const variables = buildGraphQLVariables(
@@ -64,6 +65,7 @@ export function subscriptionFactory(
 					auth.authMode,
 					auth.authToken,
 				);
+
 				return initialized;
 			}),
 		);

package/src/internals/server/generateClientWithAmplifyInstance.ts

@@ -1,18 +1,16 @@
 // 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 { Hub } from '@aws-amplify/core';
+import { cancel, graphql, isCancelError } from '..';
 import {
+	CommonPublicClientOptions,
+	ServerClientGenerationParams,
+	V6ClientSSRCookies,
+	V6ClientSSRRequest,
 	__amplify,
 	__authMode,
 	__authToken,
 	__headers,
-	V6ClientSSRRequest,
-	V6ClientSSRCookies,
-	ServerClientGenerationParams,
-	CommonPublicClientOptions,
 } from '../../types';
 import { isApiGraphQLConfig } from '../utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
 import { generateEnumsProperty } from '../utils/clientProperties/generateEnumsProperty';
@@ -21,6 +19,8 @@ import {
 	generateCustomQueriesProperty,
 } from '../generateCustomOperationsProperty';
 
+import { generateModelsProperty } from './generateModelsProperty';
+
 /**
  * @private
  *

package/src/internals/server/generateModelsProperty.ts

@@ -1,26 +1,32 @@
 // 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 { ServerClientGenerationParams } from '../../types/';
-import { V6ClientSSRRequest, V6ClientSSRCookies } from '../../types';
 import { ModelIntrospectionSchema } from '@aws-amplify/core/internals/utils';
 
+import { ModelOperation, graphQLOperationsInfo } from '../APIClient';
+import {
+	ServerClientGenerationParams,
+	V6ClientSSRCookies,
+	V6ClientSSRRequest,
+} from '../../types/';
 import { listFactory } from '../operations/list';
 import { indexQueryFactory } from '../operations/indexQuery';
 import { getFactory } from '../operations/get';
 import { getSecondaryIndexesFromSchemaModel } from '../clientUtils';
 
 export function generateModelsProperty<
-	_T extends Record<any, any> = never,
+	T extends Record<any, any> = never,
 	ClientType extends
 		| V6ClientSSRRequest<Record<string, any>>
 		| V6ClientSSRCookies<Record<string, any>> = V6ClientSSRCookies<
 		Record<string, any>
 	>,
->(client: ClientType, params: ServerClientGenerationParams): ClientType {
+>(
+	client: ClientType,
+	params: ServerClientGenerationParams,
+): ModelTypes<T> | ModelTypes<never> {
 	const models = {} as any;
-	const config = params.config;
+	const { config } = params;
 	const useContext = params.amplify === null;
 
 	if (!config) {

package/src/internals/types.ts

@@ -16,8 +16,8 @@ export type ClientGenerationParams = {
 /**
  * Common options that can be used on public `generateClient()` interfaces.
  */
-export type CommonPublicClientOptions = {
+export interface CommonPublicClientOptions {
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
 	headers?: CustomHeaders;
-};
+}

package/src/internals/utils/clientProperties/generateEnumsProperty.ts

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-	ModelIntrospectionSchema,
 	GraphQLProviderConfig,
+	ModelIntrospectionSchema,
 } from '@aws-amplify/core/internals/utils';
 import { EnumTypes } from '@aws-amplify/data-schema-types';
 
@@ -17,11 +17,12 @@ export const generateEnumsProperty = <T extends Record<any, any> = never>(
 		return {} as EnumTypes<never>;
 	}
 
-	const enums: {
-		[EnumName: string]: {
-			values: () => string[];
-		};
-	} = {};
+	const enums: Record<
+		string,
+		{
+			values(): string[];
+		}
+	> = {};
 
 	for (const [_, enumData] of Object.entries(modelIntrospection.enums)) {
 		enums[enumData.name] = {

package/src/internals/utils/clientProperties/generateModelsProperty.ts

@@ -1,23 +1,24 @@
 // 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 { V6Client, __authMode, __authToken } from '../../../types';
+import {
+	GraphQLProviderConfig,
+	ModelIntrospectionSchema,
+} from '@aws-amplify/core/internals/utils';
+
+import { ModelOperation, graphQLOperationsInfo } from '../../APIClient';
+import { V6Client } from '../../../types';
 import { listFactory } from '../../operations/list';
 import { indexQueryFactory } from '../../operations/indexQuery';
 import { getFactory } from '../../operations/get';
 import { subscriptionFactory } from '../../operations/subscription';
 import { observeQueryFactory } from '../../operations/observeQuery';
-import {
-	ModelIntrospectionSchema,
-	GraphQLProviderConfig,
-} from '@aws-amplify/core/internals/utils';
 import { getSecondaryIndexesFromSchemaModel } from '../../clientUtils';
 
 export function generateModelsProperty<T extends Record<any, any> = never>(
 	client: V6Client<Record<string, any>>,
 	apiGraphQLConfig: GraphQLProviderConfig['GraphQL'],
-): ModelTypes<T> {
+): ModelTypes<T> | ModelTypes<never> {
 	const models = {} as any;
 
 	const modelIntrospection: ModelIntrospectionSchema | undefined =

package/src/internals/v6.ts

@@ -1,15 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
+
 import { GraphQLAPI } from '../GraphQLAPI';
 import {
+	GraphQLOptionsV6,
+	GraphQLResponseV6,
+	V6Client,
 	__amplify,
 	__authMode,
 	__authToken,
-	V6Client,
-	GraphQLOptionsV6,
-	GraphQLResponseV6,
 } from '../types';
-import { CustomHeaders } from '@aws-amplify/data-schema-types';
 
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
@@ -117,6 +118,7 @@ export function graphql<
 		options,
 		additionalHeaders,
 	);
+
 	return result as any;
 }
 

package/src/server/generateClient.ts

@@ -5,6 +5,8 @@ import {
 	AmplifyServer,
 	getAmplifyServerContext,
 } from '@aws-amplify/core/internals/adapter-core';
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
+
 import { generateClientWithAmplifyInstance } from '../internals/server';
 import {
 	GenerateServerClientParams,
@@ -14,7 +16,6 @@ import {
 	V6ClientSSRRequest,
 	__amplify,
 } from '../types';
-import { CustomHeaders } from '@aws-amplify/data-schema-types';
 
 /**
  * Generates an GraphQL API client that works with Amplify server context.
@@ -55,6 +56,7 @@ export function generateClient<T extends Record<any, any> = never>({
 		additionalHeaders?: CustomHeaders,
 	) => {
 		const amplifyInstance = getAmplifyServerContext(contextSpec).amplify;
+
 		return prevGraphql.call(
 			{ [__amplify]: amplifyInstance },
 			options,
@@ -63,5 +65,6 @@ export function generateClient<T extends Record<any, any> = never>({
 	};
 
 	client.graphql = wrappedGraphql as unknown as GraphQLMethodSSR;
+
 	return client;
 }