@aws-amplify/api-graphql 4.0.3-unstable.032ab8e.0 → 4.0.3-unstable.4953a58.0

package/src/internals/InternalGraphQLAPI.ts

@@ -29,6 +29,7 @@ import {
 	updateRequestToBeCancellable,
 } from '@aws-amplify/api-rest/internals';
 import { AWSAppSyncRealTimeProvider } from '../Providers/AWSAppSyncRealTimeProvider';
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
 import { resolveConfig, resolveLibraryOptions } from '../utils';
 
 const USER_AGENT_HEADER = 'x-amz-user-agent';
@@ -66,9 +67,8 @@ export class InternalGraphQLAPIClass {
 	private async _headerBasedAuth(
 		amplify: AmplifyClassV6,
 		authMode: GraphQLAuthMode,
-		additionalHeaders: { [key: string]: string } = {}
+		additionalHeaders: Record<string, string> = {}
 	) {
-		const config = amplify.getConfig();
 		const {
 			region: region,
 			endpoint: appSyncGraphqlEndpoint,
@@ -114,9 +114,13 @@ export class InternalGraphQLAPIClass {
 				}
 				break;
 			case 'lambda':
-				if (!additionalHeaders.Authorization) {
+				if (
+					typeof additionalHeaders === 'object' &&
+					!additionalHeaders.Authorization
+				) {
 					throw new Error(GraphQLAuthError.NO_AUTH_TOKEN);
 				}
+
 				headers = {
 					Authorization: additionalHeaders.Authorization,
 				};
@@ -155,7 +159,7 @@ export class InternalGraphQLAPIClass {
 			| AmplifyClassV6
 			| ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>),
 		{ query: paramQuery, variables = {}, authMode, authToken }: GraphQLOptions,
-		additionalHeaders?: { [key: string]: string },
+		additionalHeaders?: CustomHeaders,
 		customUserAgentDetails?: CustomUserAgentDetails
 	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
 		const query =
@@ -171,11 +175,6 @@ export class InternalGraphQLAPIClass {
 
 		const headers = additionalHeaders || {};
 
-		// if an authorization header is set, have the explicit authToken take precedence
-		if (authToken) {
-			headers.Authorization = authToken;
-		}
-
 		switch (operationType) {
 			case 'query':
 			case 'mutation':
@@ -189,7 +188,8 @@ export class InternalGraphQLAPIClass {
 						{ query, variables, authMode },
 						headers,
 						abortController,
-						customUserAgentDetails
+						customUserAgentDetails,
+						authToken
 					);
 				} else {
 					const wrapper = (amplifyInstance: AmplifyClassV6) =>
@@ -198,7 +198,8 @@ export class InternalGraphQLAPIClass {
 							{ query, variables, authMode },
 							headers,
 							abortController,
-							customUserAgentDetails
+							customUserAgentDetails,
+							authToken
 						);
 
 					responsePromise = amplify(wrapper) as unknown as Promise<
@@ -216,7 +217,8 @@ export class InternalGraphQLAPIClass {
 					amplify as AmplifyClassV6,
 					{ query, variables, authMode },
 					headers,
-					customUserAgentDetails
+					customUserAgentDetails,
+					authToken
 				);
 			default:
 				throw new Error(`invalid operation type: ${operationType}`);
@@ -226,9 +228,10 @@ export class InternalGraphQLAPIClass {
 	private async _graphql<T = any>(
 		amplify: AmplifyClassV6,
 		{ query, variables, authMode }: GraphQLOptions,
-		additionalHeaders = {},
+		additionalHeaders: CustomHeaders = {},
 		abortController: AbortController,
-		customUserAgentDetails?: CustomUserAgentDetails
+		customUserAgentDetails?: CustomUserAgentDetails,
+		authToken?: string
 	): Promise<GraphQLResult<T>> {
 		const {
 			region: region,
@@ -237,14 +240,45 @@ export class InternalGraphQLAPIClass {
 			customEndpointRegion,
 		} = resolveConfig(amplify);
 
-		// Retrieve library options from Amplify configuration
+		/**
+		 * Retrieve library options from Amplify configuration.
+		 * `customHeaders` here are from the Amplify configuration options,
+		 * and are for non-AppSync endpoints only. These are *not* the same as
+		 * `additionalHeaders`, which are custom headers that are either 1)
+		 * included when configuring the API client or 2) passed along with
+		 * individual requests.
+		 */
 		const { headers: customHeaders, withCredentials } =
 			resolveLibraryOptions(amplify);
 
+		/**
+		 * Client or request-specific custom headers that may or may not be
+		 * returned by a function:
+		 */
+		let additionalCustomHeaders: Record<string, string>;
+
+		if (typeof additionalHeaders === 'function') {
+			additionalCustomHeaders = await additionalHeaders();
+		} else {
+			additionalCustomHeaders = additionalHeaders;
+		}
+
+		// if an authorization header is set, have the explicit authToken take precedence
+		if (authToken) {
+			additionalCustomHeaders = {
+				...additionalCustomHeaders,
+				Authorization: authToken,
+			};
+		}
+
 		// TODO: Figure what we need to do to remove `!`'s.
 		const headers = {
 			...(!customEndpoint &&
-				(await this._headerBasedAuth(amplify, authMode!, additionalHeaders))),
+				(await this._headerBasedAuth(
+					amplify,
+					authMode!,
+					additionalCustomHeaders
+				))),
 			/**
 			 * Custom endpoint headers.
 			 * If there is both a custom endpoint and custom region present, we get the headers.
@@ -253,7 +287,11 @@ export class InternalGraphQLAPIClass {
 			 */
 			...((customEndpoint &&
 				(customEndpointRegion
-					? await this._headerBasedAuth(amplify, authMode!, additionalHeaders)
+					? await this._headerBasedAuth(
+							amplify,
+							authMode!,
+							additionalCustomHeaders
+					  )
 					: {})) ||
 				{}),
 			// Custom headers included in Amplify configuration options:
@@ -262,8 +300,8 @@ export class InternalGraphQLAPIClass {
 					query: print(query as DocumentNode),
 					variables,
 				}))),
-			// Headers from individual calls to `graphql`:
-			...additionalHeaders,
+			// Custom headers from individual requests or API client configuration:
+			...additionalCustomHeaders,
 			// User agent headers:
 			...(!customEndpoint && {
 				[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
@@ -379,8 +417,9 @@ export class InternalGraphQLAPIClass {
 	private _graphqlSubscribe(
 		amplify: AmplifyClassV6,
 		{ query, variables, authMode }: GraphQLOptions,
-		additionalHeaders = {},
-		customUserAgentDetails?: CustomUserAgentDetails
+		additionalHeaders: CustomHeaders = {},
+		customUserAgentDetails?: CustomUserAgentDetails,
+		authToken?: string
 	): Observable<any> {
 		const config = resolveConfig(amplify);
 
@@ -393,6 +432,7 @@ export class InternalGraphQLAPIClass {
 				authenticationType: authMode || config?.defaultAuthMode,
 				apiKey: config?.apiKey,
 				additionalHeaders,
+				authToken,
 			},
 			customUserAgentDetails
 		);

package/src/internals/generateClient.ts

@@ -2,7 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 import { graphql, cancel, isCancelError } from './v6';
 import { generateModelsProperty } from './generateModelsProperty';
-import { V6Client, __amplify, __authMode, __authToken } from '../types';
+import {
+	V6Client,
+	__amplify,
+	__authMode,
+	__authToken,
+	__headers,
+} from '../types';
 import { ClientGenerationParams } from './types';
 
 /**
@@ -21,6 +27,7 @@ export function generateClient<T extends Record<any, any> = never>(
 		[__amplify]: params.amplify,
 		[__authMode]: params.authMode,
 		[__authToken]: params.authToken,
+		[__headers]: params.headers,
 		graphql,
 		cancel,
 		isCancelError,

package/src/internals/generateModelsProperty.ts

@@ -19,9 +19,14 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 	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().'
-		);
+		// breaks compatibility with certain bundler, e.g. Vite where component files are evaluated before
+		// the entry point causing false positive errors. Revisit how to better handle this post-launch
+
+		// throw new Error(
+		// 	'The API configuration is missing. This is likely due to Amplify.configure() not being called
+		// prior to generateClient().'
+		// );
+		return {} as ModelTypes<never>;
 	}
 
 	const modelIntrospection: ModelIntrospectionSchema | undefined =

package/src/internals/operations/get.ts

@@ -8,6 +8,7 @@ import {
 	flattenItems,
 	authModeParams,
 	ModelOperation,
+	getCustomHeaders,
 } from '../APIClient';
 import {
 	AuthModeParams,
@@ -80,6 +81,9 @@ async function _get(
 
 	try {
 		const auth = authModeParams(client, options);
+
+		const headers = getCustomHeaders(client, options?.headers);
+
 		const { data, extensions } = context
 			? ((await (client as V6ClientSSRRequest<Record<string, any>>).graphql(
 					context,
@@ -87,13 +91,17 @@ async function _get(
 						...auth,
 						query,
 						variables,
-					}
+					},
+					headers
 			  )) as GraphQLResult<any>)
-			: ((await (client as V6Client<Record<string, any>>).graphql({
-					...auth,
-					query,
-					variables,
-			  })) as GraphQLResult<any>);
+			: ((await (client as V6Client<Record<string, any>>).graphql(
+					{
+						...auth,
+						query,
+						variables,
+					},
+					headers
+			  )) as GraphQLResult<any>);
 
 		// flatten response
 		if (data) {

package/src/internals/operations/list.ts

@@ -7,6 +7,7 @@ import {
 	buildGraphQLVariables,
 	flattenItems,
 	authModeParams,
+	getCustomHeaders,
 } from '../APIClient';
 import {
 	AuthModeParams,
@@ -66,6 +67,8 @@ async function _list(
 	try {
 		const auth = authModeParams(client, args);
 
+		const headers = getCustomHeaders(client, args?.headers);
+
 		const { data, extensions } = !!contextSpec
 			? ((await (client as V6ClientSSRRequest<Record<string, any>>).graphql(
 					contextSpec,
@@ -73,13 +76,17 @@ async function _list(
 						...auth,
 						query,
 						variables,
-					}
+					},
+					headers
 			  )) as GraphQLResult<any>)
-			: ((await (client as V6Client<Record<string, any>>).graphql({
-					...auth,
-					query,
-					variables,
-			  })) as GraphQLResult<any>);
+			: ((await (client as V6Client<Record<string, any>>).graphql(
+					{
+						...auth,
+						query,
+						variables,
+					},
+					headers
+			  )) as GraphQLResult<any>);
 
 		// flatten response
 		if (data !== undefined) {

package/src/internals/operations/subscription.ts

@@ -9,6 +9,7 @@ import {
 	buildGraphQLVariables,
 	authModeParams,
 	ModelOperation,
+	getCustomHeaders,
 } from '../APIClient';
 import {
 	ModelIntrospectionSchema,
@@ -38,11 +39,16 @@ export function subscriptionFactory(
 
 		const auth = authModeParams(client, args);
 
-		const observable = client.graphql({
-			...auth,
-			query,
-			variables,
-		}) as GraphqlSubscriptionResult<object>;
+		const headers = getCustomHeaders(client, args?.headers);
+
+		const observable = client.graphql(
+			{
+				...auth,
+				query,
+				variables,
+			},
+			headers
+		) as GraphqlSubscriptionResult<object>;
 
 		return observable.pipe(
 			map(value => {

package/src/internals/server/generateModelsProperty.ts

@@ -10,7 +10,7 @@ import { listFactory } from '../operations/list';
 import { getFactory } from '../operations/get';
 
 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<
@@ -26,9 +26,7 @@ export function generateModelsProperty<
 	}
 
 	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().'
-		);
+		return {} as ModelTypes<never>;
 	}
 
 	const modelIntrospection: ModelIntrospectionSchema | undefined =

package/src/internals/types.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6 } from '@aws-amplify/core';
 import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
 
 /**
  * @private
@@ -18,4 +19,5 @@ export type ClientGenerationParams = {
 export type CommonPublicClientOptions = {
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
+	headers?: CustomHeaders;
 };

package/src/internals/v6.ts

@@ -7,6 +7,7 @@ import {
 	GraphQLOptionsV6,
 	GraphQLResponseV6,
 } from '../types';
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
 
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
@@ -98,7 +99,7 @@ export function graphql<
 >(
 	this: V6Client,
 	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
-	additionalHeaders?: { [key: string]: string }
+	additionalHeaders?: CustomHeaders
 ): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING> {
 	/**
 	 * The correctness of these typings depends on correct string branding or overrides.

package/src/types/index.ts

@@ -1,7 +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 { ModelTypes, CustomHeaders } from '@aws-amplify/data-schema-types';
 import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
@@ -176,7 +176,7 @@ export interface AWSAppSyncRealTimeProviderOptions {
 	apiKey?: string;
 	region?: string;
 	graphql_headers?: () => {} | (() => Promise<{}>);
-	additionalHeaders?: { [key: string]: string };
+	additionalHeaders?: CustomHeaders;
 }
 
 export type AWSAppSyncRealTimeProvider = {
@@ -363,6 +363,7 @@ type ExcludeNeverFields<O> = {
 export const __amplify = Symbol('amplify');
 export const __authMode = Symbol('authMode');
 export const __authToken = Symbol('authToken');
+export const __headers = Symbol('headers');
 
 export type ClientWithModels =
 	| V6Client<Record<string, any>>
@@ -373,6 +374,7 @@ export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
 	[__amplify]: AmplifyClassV6;
 	[__authMode]?: GraphQLAuthMode;
 	[__authToken]?: string;
+	[__headers]?: CustomHeaders;
 	graphql: GraphQLMethod;
 	cancel: (promise: Promise<any>, message?: string) => boolean;
 	isCancelError: (error: any) => boolean;
@@ -384,6 +386,7 @@ export type V6ClientSSRRequest<T extends Record<any, any> = never> =
 		[__amplify]: AmplifyClassV6;
 		[__authMode]?: GraphQLAuthMode;
 		[__authToken]?: string;
+		[__headers]?: CustomHeaders;
 		graphql: GraphQLMethodSSR;
 		cancel: (promise: Promise<any>, message?: string) => boolean;
 		isCancelError: (error: any) => boolean;
@@ -395,6 +398,7 @@ export type V6ClientSSRCookies<T extends Record<any, any> = never> =
 		[__amplify]: AmplifyClassV6;
 		[__authMode]?: GraphQLAuthMode;
 		[__authToken]?: string;
+		[__headers]?: CustomHeaders;
 		graphql: GraphQLMethod;
 		cancel: (promise: Promise<any>, message?: string) => boolean;
 		isCancelError: (error: any) => boolean;
@@ -406,11 +410,7 @@ export type GraphQLMethod = <
 	TYPED_GQL_STRING extends string = string
 >(
 	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
-	additionalHeaders?:
-		| {
-				[key: string]: string;
-		  }
-		| undefined
+	additionalHeaders?: CustomHeaders | undefined
 ) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 
 export type GraphQLMethodSSR = <
@@ -419,11 +419,7 @@ export type GraphQLMethodSSR = <
 >(
 	contextSpec: AmplifyServer.ContextSpec,
 	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
-	additionalHeaders?:
-		| {
-				[key: string]: string;
-		  }
-		| undefined
+	additionalHeaders?: CustomHeaders | undefined
 ) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 
 /**
@@ -442,7 +438,11 @@ export type ServerClientGenerationParams = {
 
 export type QueryArgs = Record<string, unknown>;
 
-export type ListArgs = { selectionSet?: string[]; filter?: {} };
+export type ListArgs = {
+	selectionSet?: string[];
+	filter?: {};
+	headers?: CustomHeaders;
+};
 
 export type AuthModeParams = {
 	authMode?: GraphQLAuthMode;

package/src/utils/resolveConfig.ts

@@ -1,13 +1,23 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { AmplifyClassV6 } from '@aws-amplify/core';
+import { AmplifyClassV6, ConsoleLogger } from '@aws-amplify/core';
 import { APIValidationErrorCode, assertValidationError } from './errors';
 
+const logger = new ConsoleLogger('GraphQLAPI resolveConfig');
+
 /**
  * @internal
  */
 export const resolveConfig = (amplify: AmplifyClassV6) => {
+	const config = amplify.getConfig();
+
+	if (!config.API?.GraphQL) {
+		logger.warn(
+			'The API configuration is missing. This is likely due to Amplify.configure() not being called prior to generateClient().'
+		);
+	}
+
 	const {
 		apiKey,
 		customEndpoint,
@@ -15,7 +25,7 @@ export const resolveConfig = (amplify: AmplifyClassV6) => {
 		defaultAuthMode,
 		endpoint,
 		region,
-	} = amplify.getConfig().API?.GraphQL ?? {};
+	} = config.API?.GraphQL ?? {};
 
 	// TODO: re-enable when working in all test environments:
 	// assertValidationError(!!endpoint, APIValidationErrorCode.NoEndpoint);