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

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>(client, params);
+
+	return client as ClientType;
+}

package/src/internals/server/generateModelsProperty.ts

@@ -0,0 +1,80 @@
+// 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';
+
+export function generateModelsProperty<
+	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 {
+	const models = {} as any;
+	const config = params.config;
+	const useContext = client === null;
+
+	if (!config) {
+		throw new Error('generateModelsProperty cannot retrieve Amplify config');
+	}
+
+	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 ModelTypes<never>;
+	}
+
+	const SSR_UNSUPORTED_OPS = [
+		'ONCREATE',
+		'ONUPDATE',
+		'ONDELETE',
+		'OBSERVE_QUERY',
+	];
+
+	for (const model of Object.values(modelIntrospection.models)) {
+		const { name } = model;
+		models[name] = {} as Record<string, 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;
+};

package/src/types/index.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6, ResourcesConfig } from '@aws-amplify/core';
+import { ModelTypes } from '@aws-amplify/data-schema-types';
 import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
@@ -12,6 +13,11 @@ import {
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 
 export { CONTROL_MSG, ConnectionState } from './PubSub';
+
+export { SelectionSet } from '@aws-amplify/data-schema-types';
+
+export { CommonPublicClientOptions } from '../internals/types';
+
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
  */
@@ -349,25 +355,50 @@ export type GeneratedSubscription<InputType, OutputType> = string & {
 type FilteredKeys<T> = {
 	[P in keyof T]: T[P] extends never ? never : P;
 }[keyof T];
+
 type ExcludeNeverFields<O> = {
 	[K in FilteredKeys<O>]: O[K];
 };
 
 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;
+	[__authToken]?: string;
 	graphql: GraphQLMethod;
 	cancel: (promise: Promise<any>, message?: string) => boolean;
 	isCancelError: (error: any) => boolean;
+	models: ModelTypes<T>;
 }>;
 
-export type V6ClientSSR<T extends Record<any, any> = never> =
+export type V6ClientSSRRequest<T extends Record<any, any> = never> =
 	ExcludeNeverFields<{
 		[__amplify]: AmplifyClassV6;
+		[__authMode]?: GraphQLAuthMode;
+		[__authToken]?: string;
 		graphql: GraphQLMethodSSR;
 		cancel: (promise: Promise<any>, message?: string) => boolean;
 		isCancelError: (error: any) => boolean;
+		models: ModelTypes<T, 'REQUEST'>;
+	}>;
+
+export type V6ClientSSRCookies<T extends Record<any, any> = never> =
+	ExcludeNeverFields<{
+		[__amplify]: AmplifyClassV6;
+		[__authMode]?: GraphQLAuthMode;
+		[__authToken]?: string;
+		graphql: GraphQLMethod;
+		cancel: (promise: Promise<any>, message?: string) => boolean;
+		isCancelError: (error: any) => boolean;
+		models: ModelTypes<T, 'COOKIES'>;
 	}>;
 
 export type GraphQLMethod = <
@@ -404,7 +435,16 @@ export type ServerClientGenerationParams = {
 	amplify:
 		| null // null expected when used with `generateServerClient`
 		// closure expected with `generateServerClientUsingCookies`
-		| ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>);
+		| ((fn: (amplify: AmplifyClassV6) => Promise<any>) => Promise<any>);
 	// 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

@@ -0,0 +1,31 @@
+// 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] as any)[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/resolveOwnerFields.ts

@@ -0,0 +1,65 @@
+// 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 Model = ModelIntrospectionSchema['models'][string];
+
+type AuthAttribute = {
+	type: 'auth';
+	properties: {
+		rules: AuthRule[];
+	};
+};
+
+/**
+ * Only the portions of an Auth rule we care about.
+ */
+type AuthRule = {
+	allow: string;
+	ownerField?: string;
+};
+
+/**
+ * Given an introspection schema model, returns all owner fields.
+ *
+ * @param model Model from an introspection schema
+ * @returns List of owner field names
+ */
+export function resolveOwnerFields(model: Model): string[] {
+	const ownerFields = new Set<string>();
+	for (const attr of model.attributes || []) {
+		if (isAuthAttribute(attr)) {
+			for (const rule of attr.properties.rules) {
+				if (rule.allow === 'owner') {
+					ownerFields.add(rule.ownerField || 'owner');
+				}
+			}
+		}
+	}
+	return Array.from(ownerFields);
+}
+
+/**
+ * Type guard that identifies an auth attribute with an attached rules list that
+ * specifies an `allow` attribute at a minimum.
+ *
+ * @param attribute Any object. Ideally a model introspection schema model attribute
+ * @returns True if given object is an auth attribute
+ */
+function isAuthAttribute(attribute: any): attribute is AuthAttribute {
+	if (attribute?.type === 'auth') {
+		if (typeof attribute?.properties === 'object') {
+			if (Array.isArray(attribute?.properties?.rules)) {
+				return (attribute?.properties?.rules as Array<any>).every(
+					rule => !!rule.allow
+				);
+			}
+		}
+	}
+	return false;
+}

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];
+}