@aws-amplify/api-graphql 4.0.2-unstable.51ed7b4.0 → 4.0.2-unstable.a5eb335.0

package/src/internals/operations/get.ts

@@ -7,17 +7,32 @@ import {
 	buildGraphQLVariables,
 	flattenItems,
 	authModeParams,
+	ModelOperation,
 } from '../APIClient';
+import {
+	AuthModeParams,
+	ClientWithModels,
+	GraphQLOptionsV6,
+	GraphQLResult,
+	ListArgs,
+	QueryArgs,
+	V6Client,
+	V6ClientSSRRequest,
+} from '../../types';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
 
 export function getFactory(
-	client,
-	modelIntrospection,
-	model,
-	operation,
-	context = false
+	client: ClientWithModels,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
+	operation: ModelOperation,
+	useContext = false
 ) {
 	const getWithContext = async (
-		contextSpec: AmplifyServer.ContextSpec,
+		contextSpec: AmplifyServer.ContextSpec & GraphQLOptionsV6<unknown, string>,
 		arg?: any,
 		options?: any
 	) => {
@@ -33,30 +48,22 @@ export function getFactory(
 	};
 
 	const get = async (arg?: any, options?: any) => {
-		return _get(
-			client,
-			modelIntrospection,
-			model,
-			arg,
-			options,
-			operation,
-			context
-		);
+		return _get(client, modelIntrospection, model, arg, options, operation);
 	};
 
-	return context ? getWithContext : get;
+	return useContext ? getWithContext : get;
 }
 
 async function _get(
-	client,
-	modelIntrospection,
-	model,
-	arg,
-	options,
-	operation,
-	context
+	client: ClientWithModels,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
+	arg: QueryArgs,
+	options: AuthModeParams & ListArgs,
+	operation: ModelOperation,
+	context?: AmplifyServer.ContextSpec
 ) {
-	const { name } = model as any;
+	const { name } = model;
 
 	const query = generateGraphQLDocument(
 		modelIntrospection.models,
@@ -74,19 +81,22 @@ async function _get(
 	try {
 		const auth = authModeParams(client, options);
 		const { data, extensions } = context
-			? ((await client.graphql(context, {
-					...auth,
-					query,
-					variables,
-			  })) as any)
-			: ((await client.graphql({
+			? ((await (client as V6ClientSSRRequest<Record<string, any>>).graphql(
+					context,
+					{
+						...auth,
+						query,
+						variables,
+					}
+			  )) as GraphQLResult<any>)
+			: ((await (client as V6Client<Record<string, any>>).graphql({
 					...auth,
 					query,
 					variables,
-			  })) as any);
+			  })) as GraphQLResult<any>);
 
 		// flatten response
-		if (data !== undefined) {
+		if (data) {
 			const [key] = Object.keys(data);
 			const flattenedResult = flattenItems(data)[key];
 
@@ -101,7 +111,7 @@ async function _get(
 					modelIntrospection,
 					auth.authMode,
 					auth.authToken,
-					context
+					!!context
 				);
 
 				return { data: initialized, extensions };
@@ -109,7 +119,7 @@ async function _get(
 		} else {
 			return { data: null, extensions };
 		}
-	} catch (error) {
+	} catch (error: any) {
 		if (error.errors) {
 			// graphql errors pass through
 			return error as any;

package/src/internals/operations/list.ts

@@ -8,29 +8,47 @@ import {
 	flattenItems,
 	authModeParams,
 } from '../APIClient';
+import {
+	AuthModeParams,
+	ClientWithModels,
+	ListArgs,
+	V6Client,
+	V6ClientSSRRequest,
+	GraphQLResult,
+} from '../../types';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
 
 export function listFactory(
-	client,
-	modelIntrospection,
-	model,
+	client: ClientWithModels,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
 	context = false
 ) {
 	const listWithContext = async (
 		contextSpec: AmplifyServer.ContextSpec,
-		args?: any
+		args?: ListArgs
 	) => {
 		return _list(client, modelIntrospection, model, args, contextSpec);
 	};
 
 	const list = async (args?: any) => {
-		return _list(client, modelIntrospection, model, args, context);
+		return _list(client, modelIntrospection, model, args);
 	};
 
 	return context ? listWithContext : list;
 }
 
-async function _list(client, modelIntrospection, model, args, context) {
-	const { name } = model as any;
+async function _list(
+	client: ClientWithModels,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
+	args?: ListArgs & AuthModeParams,
+	contextSpec?: AmplifyServer.ContextSpec
+) {
+	const { name } = model;
 
 	const query = generateGraphQLDocument(
 		modelIntrospection.models,
@@ -48,17 +66,20 @@ async function _list(client, modelIntrospection, model, args, context) {
 	try {
 		const auth = authModeParams(client, args);
 
-		const { data, extensions } = context
-			? ((await client.graphql(context, {
-					...auth,
-					query,
-					variables,
-			  })) as any)
-			: ((await client.graphql({
+		const { data, extensions } = !!contextSpec
+			? ((await (client as V6ClientSSRRequest<Record<string, any>>).graphql(
+					contextSpec,
+					{
+						...auth,
+						query,
+						variables,
+					}
+			  )) as GraphQLResult<any>)
+			: ((await (client as V6Client<Record<string, any>>).graphql({
 					...auth,
 					query,
 					variables,
-			  })) as any);
+			  })) as GraphQLResult<any>);
 
 		// flatten response
 		if (data !== undefined) {
@@ -82,7 +103,7 @@ async function _list(client, modelIntrospection, model, args, context) {
 						modelIntrospection,
 						auth.authMode,
 						auth.authToken,
-						context
+						!!contextSpec
 					);
 
 					return {
@@ -99,7 +120,7 @@ async function _list(client, modelIntrospection, model, args, context) {
 				extensions,
 			};
 		}
-	} catch (error) {
+	} catch (error: any) {
 		if (error.errors) {
 			// graphql errors pass through
 			return error as any;

package/src/internals/operations/observeQuery.ts

@@ -1,11 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-
-import { Observable, map } from 'rxjs';
+import { Observable } from 'rxjs';
 import { findIndexByFields, resolvePKFields } from '../../utils';
+import { SchemaModel } from '@aws-amplify/core/internals/utils';
 
-export function observeQueryFactory(models, model) {
-	const { name } = model as any;
+export function observeQueryFactory(models: any, model: SchemaModel) {
+	const { name } = model;
 
 	const observeQuery = (arg?: any) =>
 		new Observable(subscriber => {
@@ -28,26 +28,26 @@ export function observeQueryFactory(models, model) {
 
 			// start subscriptions
 			const onCreateSub = models[name].onCreate(arg).subscribe({
-				next(item) {
+				next(item: object) {
 					receiveMessages({ item, type: 'create' });
 				},
-				error(error) {
+				error(error: any) {
 					subscriber.error({ type: 'onCreate', error });
 				},
 			});
 			const onUpdateSub = models[name].onUpdate(arg).subscribe({
-				next(item) {
+				next(item: object) {
 					receiveMessages({ item, type: 'update' });
 				},
-				error(error) {
+				error(error: any) {
 					subscriber.error({ type: 'onUpdate', error });
 				},
 			});
 			const onDeleteSub = models[name].onDelete(arg).subscribe({
-				next(item) {
+				next(item: object) {
 					receiveMessages({ item, type: 'delete' });
 				},
-				error(error) {
+				error(error: any) {
 					subscriber.error({ type: 'onDelete', error });
 				},
 			});
@@ -89,6 +89,10 @@ export function observeQueryFactory(models, model) {
 						data: page,
 						errors,
 						nextToken: _nextToken,
+					}: {
+						data: any;
+						errors: any;
+						nextToken: string | null;
 					} = await models[name].list({ ...arg, nextToken });
 					nextToken = _nextToken;
 

package/src/internals/operations/subscription.ts

@@ -2,19 +2,24 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { map } from 'rxjs';
-import { GraphqlSubscriptionResult } from '../../types';
+import { V6Client, GraphqlSubscriptionResult } from '../../types';
 import {
 	initializeModel,
 	generateGraphQLDocument,
 	buildGraphQLVariables,
 	authModeParams,
+	ModelOperation,
 } from '../APIClient';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
 
 export function subscriptionFactory(
-	client,
-	modelIntrospection,
-	model,
-	operation
+	client: any,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
+	operation: ModelOperation
 ) {
 	const { name } = model as any;
 
@@ -42,10 +47,11 @@ export function subscriptionFactory(
 		return observable.pipe(
 			map(value => {
 				const [key] = Object.keys(value.data);
+				const data = (value.data as any)[key];
 				const [initialized] = initializeModel(
-					client,
+					client as V6Client<Record<string, any>>,
 					name,
-					[value.data[key]],
+					[data],
 					modelIntrospection,
 					auth.authMode,
 					auth.authToken

package/src/internals/server/generateClient.ts

@@ -39,7 +39,7 @@ export function generateClient<
 		isCancelError,
 	} as any;
 
-	client.models = generateModelsProperty<T, ClientType>(client, params);
+	client.models = generateModelsProperty<T>(client, params);
 
 	return client as ClientType;
 }

package/src/internals/server/generateModelsProperty.ts

@@ -1,9 +1,10 @@
 // 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 { listFactory } from '../operations/list';
 import { getFactory } from '../operations/get';
@@ -11,21 +12,30 @@ import { getFactory } from '../operations/get';
 export function generateModelsProperty<
 	T extends Record<any, any> = never,
 	ClientType extends
-		| V6ClientSSRRequest<T>
-		| V6ClientSSRCookies<T> = V6ClientSSRCookies<T>
+		| V6ClientSSRRequest<Record<string, any>>
+		| V6ClientSSRCookies<Record<string, any>> = V6ClientSSRCookies<
+		Record<string, any>
+	>
 >(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 (!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: ModelIntrospectionSchema | undefined =
+		config.API.GraphQL.modelIntrospection;
+
 	if (!modelIntrospection) {
-		return {} as any;
+		return {} as ModelTypes<never>;
 	}
 
 	const SSR_UNSUPORTED_OPS = [
@@ -36,8 +46,8 @@ export function generateModelsProperty<
 	];
 
 	for (const model of Object.values(modelIntrospection.models)) {
-		const { name } = model as any;
-		models[name] = {} as any;
+		const { name } = model;
+		models[name] = {} as Record<string, any>;
 
 		Object.entries(graphQLOperationsInfo).forEach(
 			([key, { operationPrefix }]) => {

package/src/types/index.ts

@@ -364,6 +364,11 @@ export const __amplify = Symbol('amplify');
 export const __authMode = Symbol('authMode');
 export const __authToken = Symbol('authToken');
 
+export type ClientWithModels =
+	| V6Client<Record<string, any>>
+	| V6ClientSSRRequest<Record<string, any>>
+	| V6ClientSSRCookies<Record<string, any>>;
+
 export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
 	[__amplify]: AmplifyClassV6;
 	[__authMode]?: GraphQLAuthMode;
@@ -434,3 +439,12 @@ export type ServerClientGenerationParams = {
 	// global env-sourced config use for retrieving modelIntro
 	config: ResourcesConfig;
 };
+
+export type QueryArgs = Record<string, unknown>;
+
+export type ListArgs = { selectionSet?: string[]; filter?: {} };
+
+export type AuthModeParams = {
+	authMode?: GraphQLAuthMode;
+	authToken?: string;
+};

package/src/utils/ConnectionStateMonitor.ts

@@ -50,7 +50,9 @@ export class ConnectionStateMonitor {
 	 */
 	private _linkedConnectionState: LinkedConnectionStates;
 	private _linkedConnectionStateObservable: Observable<LinkedConnectionStates>;
-	private _linkedConnectionStateObserver: Observer<LinkedConnectionStates>;
+	private _linkedConnectionStateObserver:
+		| Observer<LinkedConnectionStates>
+		| undefined;
 	private _networkMonitoringSubscription?: SubscriptionLike;
 	private _initialNetworkStateSubscription?: SubscriptionLike;
 

package/src/utils/findIndexByFields.ts

@@ -19,7 +19,9 @@ export function findIndexByFields<T>(
 
 	for (let i = 0; i < haystack.length; i++) {
 		if (
-			Object.keys(searchObject).every(k => searchObject[k] === haystack[i][k])
+			Object.keys(searchObject).every(
+				k => searchObject[k] === (haystack[i] as any)[k]
+			)
 		) {
 			return i;
 		}