@aws-amplify/api-graphql 4.0.1-api-v6-models.01b2bb8.0 → 4.0.1-api-v6-models.9351bcf.0

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

@@ -6,6 +6,7 @@ import { Observable } from 'rxjs';
 import { GraphQLAuthMode, DocumentType } from '@aws-amplify/core/internals/utils';
 export { CONTROL_MSG, ConnectionState } from './PubSub';
 export { SelectionSet } from '@aws-amplify/amplify-api-next-types-alpha';
+export { CommonPublicClientOptions } from '../internals/types';
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
  */
@@ -281,8 +282,12 @@ type ExcludeNeverFields<O> = {
     [K in FilteredKeys<O>]: O[K];
 };
 export declare const __amplify: unique symbol;
+export declare const __authMode: unique symbol;
+export declare const __authToken: unique symbol;
 export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
     [__amplify]: AmplifyClassV6;
+    [__authMode]?: GraphQLAuthMode;
+    [__authToken]?: string;
     graphql: <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
         [key: string]: string;
     } | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;

package/lib-esm/types/index.js

@@ -8,3 +8,5 @@ export var GraphQLAuthError;
     GraphQLAuthError["NO_AUTH_TOKEN"] = "No auth token specified";
 })(GraphQLAuthError || (GraphQLAuthError = {}));
 export var __amplify = Symbol('amplify');
+export var __authMode = Symbol('authMode');
+export var __authToken = Symbol('authToken');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.0.1-api-v6-models.01b2bb8.0+01b2bb8",
+	"version": "4.0.1-api-v6-models.9351bcf.0+9351bcf",
 	"description": "Api-graphql category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -51,10 +51,10 @@
 		"internals"
 	],
 	"dependencies": {
-		"@aws-amplify/amplify-api-next-types-alpha": "^0.2.0",
-		"@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-amplify/amplify-api-next-types-alpha": "^0.2.4",
+		"@aws-amplify/api-rest": "4.0.1-api-v6-models.9351bcf.0+9351bcf",
+		"@aws-amplify/auth": "6.0.1-api-v6-models.9351bcf.0+9351bcf",
+		"@aws-amplify/core": "6.0.1-api-v6-models.9351bcf.0+9351bcf",
 		"@aws-sdk/types": "3.387.0",
 		"graphql": "15.8.0",
 		"rxjs": "^7.8.1",
@@ -126,5 +126,5 @@
 			"<rootDir>/__tests__"
 		]
 	},
-	"gitHead": "01b2bb8503ffd202c858da1ff6afeb7c008a4563"
+	"gitHead": "9351bcfbeb9ec15f67fc6404ca192689a398d260"
 }

package/src/internals/APIClient.ts

@@ -1,9 +1,15 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { resolveOwnerFields } from '../utils/resolveOwnerFields';
+import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
 
 type ListArgs = { selectionSet?: string[]; filter?: {} };
 
+type LazyLoadOptions = {
+	authMode?: GraphQLAuthMode;
+	authToken?: string | undefined;
+};
+
 const connectionType = {
 	HAS_ONE: 'HAS_ONE',
 	HAS_MANY: 'HAS_MANY',
@@ -41,7 +47,9 @@ export function initializeModel(
 	client: any,
 	modelName: string,
 	result: any[],
-	modelIntrospection: any
+	modelIntrospection: any,
+	authMode: GraphQLAuthMode | undefined,
+	authToken: string | undefined
 ): any[] {
 	const introModel = modelIntrospection.models[modelName];
 	const introModelFields = introModel.fields;
@@ -83,12 +91,18 @@ export function initializeModel(
 						{}
 					);
 
-					initializedRelationalFields[field] = () => {
+					initializedRelationalFields[field] = (options?: LazyLoadOptions) => {
 						if (record[targetNames[0]]) {
-							return client.models[relatedModelName].get({
-								[relatedModelPKFieldName]: record[targetNames[0]],
-								...sortKeyValues,
-							});
+							return client.models[relatedModelName].get(
+								{
+									[relatedModelPKFieldName]: record[targetNames[0]],
+									...sortKeyValues,
+								},
+								{
+									authMode: options?.authMode || authMode,
+									authToken: options?.authToken || authToken,
+								}
+							);
 						}
 						return undefined;
 					};
@@ -111,10 +125,14 @@ export function initializeModel(
 							return { [field]: { eq: record[parentSK[idx - 1]] } };
 						});
 
-						initializedRelationalFields[field] = () => {
+						initializedRelationalFields[field] = (
+							options?: LazyLoadOptions
+						) => {
 							if (record[parentPk]) {
 								return client.models[relatedModelName].list({
 									filter: { and: hasManyFilter },
+									authMode: options?.authMode || authMode,
+									authToken: options?.authToken || authToken,
 								});
 							}
 							return [];
@@ -130,10 +148,12 @@ export function initializeModel(
 						return { [field]: { eq: record[parentSK[idx - 1]] } };
 					});
 
-					initializedRelationalFields[field] = () => {
+					initializedRelationalFields[field] = (options?: LazyLoadOptions) => {
 						if (record[parentPk]) {
 							return client.models[relatedModelName].list({
 								filter: { and: hasManyFilter },
+								authMode: options?.authMode || authMode,
+								authToken: options?.authToken || authToken,
 							});
 						}
 						return [];

package/src/internals/InternalGraphQLAPI.ts

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

package/src/internals/generateClient.ts

@@ -3,7 +3,7 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
 import { graphql, cancel, isCancelError } from './v6';
 import { generateModelsProperty } from './generateModelsProperty';
-import { V6Client, __amplify } from '../types';
+import { V6Client, __amplify, __authMode, __authToken } from '../types';
 import { ClientGenerationParams } from './types';
 
 /**
@@ -20,6 +20,8 @@ export function generateClient<T extends Record<any, any> = never>(
 ): V6Client<T> {
 	const client = {
 		[__amplify]: params.amplify,
+		[__authMode]: params.authMode,
+		[__authToken]: params.authToken,
 		graphql,
 		cancel,
 		isCancelError,

package/src/internals/generateModelsProperty.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { ModelTypes } from '@aws-amplify/amplify-api-next-types-alpha';
+import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
 import {
 	initializeModel,
 	generateGraphQLDocument,
@@ -10,10 +11,39 @@ import {
 	flattenItems,
 } from './APIClient';
 import { ClientGenerationParams } from './types';
-import { V6Client, GraphqlSubscriptionResult } from '../types';
+import {
+	V6Client,
+	GraphqlSubscriptionResult,
+	__authMode,
+	__authToken,
+} from '../types';
 import { findIndexByFields, resolvePKFields } from '../utils';
 import { Observable, map } from 'rxjs';
 
+type AuthModeParams = {
+	authMode?: GraphQLAuthMode;
+	authToken?: string;
+};
+
+/**
+ * Produces a parameter object that can contains auth mode/token overrides
+ * only if present in either `options` (first) or configured on the `client`
+ * as a fallback.
+ *
+ * @param client Configured client from `generateClient`
+ * @param options Args/Options obect from call site.
+ * @returns
+ */
+function authModeParams(
+	client: V6Client,
+	options: AuthModeParams = {}
+): AuthModeParams {
+	return {
+		authMode: options.authMode || client[__authMode],
+		authToken: options.authToken || client[__authToken],
+	};
+}
+
 export function generateModelsProperty<T extends Record<any, any> = never>(
 	client: V6Client,
 	params: ClientGenerationParams
@@ -53,7 +83,10 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 						);
 
 						try {
+							const auth = authModeParams(client, args);
+
 							const { data, extensions } = (await client.graphql({
+								...auth,
 								query,
 								variables,
 							})) as any;
@@ -77,7 +110,9 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 											client,
 											name,
 											flattenedResult,
-											modelIntrospection
+											modelIntrospection,
+											auth.authMode,
+											auth.authToken
 										);
 
 										return {
@@ -105,7 +140,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 						}
 					};
 				} else if (['ONCREATE', 'ONUPDATE', 'ONDELETE'].includes(operation)) {
-					models[name][operationPrefix] = (arg?: any, options?: any) => {
+					models[name][operationPrefix] = (args?: any) => {
 						const query = generateGraphQLDocument(
 							modelIntrospection.models,
 							name,
@@ -114,11 +149,14 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 						const variables = buildGraphQLVariables(
 							model,
 							operation,
-							arg,
+							args,
 							modelIntrospection
 						);
 
+						const auth = authModeParams(client, args);
+
 						const observable = client.graphql({
+							...auth,
 							query,
 							variables,
 						}) as GraphqlSubscriptionResult<object>;
@@ -126,12 +164,20 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 						return observable.pipe(
 							map(value => {
 								const [key] = Object.keys(value.data);
-								return value.data[key];
+								const [initialized] = initializeModel(
+									client,
+									name,
+									[value.data[key]],
+									modelIntrospection,
+									auth.authMode,
+									auth.authToken
+								);
+								return initialized;
 							})
 						);
 					};
 				} else if (operation === 'OBSERVE_QUERY') {
-					models[name][operationPrefix] = (arg?: any, options?: any) =>
+					models[name][operationPrefix] = (arg?: any) =>
 						new Observable(subscriber => {
 							// what we'll be sending to our subscribers
 							const items: object[] = [];
@@ -151,36 +197,30 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 							};
 
 							// 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 });
-									},
-								});
+							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) {
@@ -226,7 +266,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 										data: page,
 										errors,
 										nextToken: _nextToken,
-									} = await models[name].list({ ...arg, nextToken }, options);
+									} = await models[name].list({ ...arg, nextToken });
 									nextToken = _nextToken;
 
 									items.push(...page);
@@ -288,7 +328,9 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 						);
 
 						try {
+							const auth = authModeParams(client, options);
 							const { data, extensions } = (await client.graphql({
+								...auth,
 								query,
 								variables,
 							})) as any;
@@ -306,7 +348,9 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 										client,
 										name,
 										[flattenedResult],
-										modelIntrospection
+										modelIntrospection,
+										auth.authMode,
+										auth.authToken
 									);
 
 									return { data: initialized, extensions };

package/src/internals/types.ts

@@ -1,6 +1,7 @@
 // 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
@@ -9,4 +10,12 @@ import { AmplifyClassV6 } from '@aws-amplify/core';
  */
 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

@@ -14,6 +14,8 @@ export { CONTROL_MSG, ConnectionState } from './PubSub';
 
 export { SelectionSet } from '@aws-amplify/amplify-api-next-types-alpha';
 
+export { CommonPublicClientOptions } from '../internals/types';
+
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
  */
@@ -357,9 +359,13 @@ type ExcludeNeverFields<O> = {
 };
 
 export const __amplify = Symbol('amplify');
+export const __authMode = Symbol('authMode');
+export const __authToken = Symbol('authToken');
 
 export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
 	[__amplify]: AmplifyClassV6;
+	[__authMode]?: GraphQLAuthMode;
+	[__authToken]?: string;
 	graphql: <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(
 		options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
 		additionalHeaders?: