@aws-amplify/api-graphql 4.6.8-unstable.0ecded1.0 → 4.6.8-unstable.ca2e4b8.0

package/dist/esm/types/index.d.ts

@@ -4,18 +4,21 @@ import { DocumentNode, GraphQLError, Source } from 'graphql';
 import { Observable } from 'rxjs';
 import { DocumentType, GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { CommonPublicClientOptions } from '../internals/types';
 export { OperationTypeNode } from 'graphql';
 export { CONTROL_MSG, ConnectionState } from './PubSub';
 export { SelectionSet } from '@aws-amplify/data-schema/runtime';
-export { CommonPublicClientOptions } from '../internals/types';
+export type { CommonPublicClientOptions };
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
  */
 export interface GraphQLOptions {
     query: string | DocumentNode;
+    endpoint?: string;
     variables?: Record<string, DocumentType>;
     authMode?: GraphQLAuthMode;
     authToken?: string;
+    apiKey?: string;
     /**
      * @deprecated This property should not be used
      */
@@ -162,16 +165,57 @@ export type GraphQLOperation = Source | string;
  * API V6 `graphql({options})` type that can leverage branded graphql `query`
  * objects and fallback types.
  */
-export interface GraphQLOptionsV6<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string> extends Record<string, unknown> {
+export type GraphQLOptionsV6<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string, Options extends CommonPublicClientOptions = object> = Options['endpoint'] extends string ? Options['apiKey'] extends string ? {
     query: TYPED_GQL_STRING | DocumentNode;
     variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
     authMode?: GraphQLAuthMode;
+    apiKey?: string;
     authToken?: string;
     /**
      * @deprecated This property should not be used
      */
     userAgentSuffix?: string;
-}
+} : {
+    query: TYPED_GQL_STRING | DocumentNode;
+    variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+    authMode?: never;
+    apiKey?: never;
+    authToken?: string;
+    /**
+     * @deprecated This property should not be used
+     */
+    userAgentSuffix?: string;
+} | {
+    query: TYPED_GQL_STRING | DocumentNode;
+    variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+    authMode: 'apiKey';
+    apiKey: string;
+    authToken?: string;
+    /**
+     * @deprecated This property should not be used
+     */
+    userAgentSuffix?: string;
+} | {
+    query: TYPED_GQL_STRING | DocumentNode;
+    variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+    authMode: Exclude<GraphQLAuthMode, 'apiKey'>;
+    apiKey?: never;
+    authToken?: string;
+    /**
+     * @deprecated This property should not be used
+     */
+    userAgentSuffix?: string;
+} : {
+    query: TYPED_GQL_STRING | DocumentNode;
+    variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+    authMode?: GraphQLAuthMode;
+    apiKey?: string;
+    authToken?: string;
+    /**
+     * @deprecated This property should not be used
+     */
+    userAgentSuffix?: string;
+};
 /**
  * Result type for `graphql()` operations that don't include any specific
  * type information. The result could be either a `Promise` or `Subscription`.
@@ -275,26 +319,31 @@ export type GeneratedSubscription<InputType, OutputType> = string & {
 export declare const __amplify: unique symbol;
 export declare const __authMode: unique symbol;
 export declare const __authToken: unique symbol;
+export declare const __apiKey: unique symbol;
 export declare const __headers: unique symbol;
-export declare function getInternals(client: BaseClient): ClientInternals;
+export declare const __endpoint: unique symbol;
+export declare function getInternals(client: BaseClient): ClientInternals & {
+    apiKey?: string;
+    endpoint?: string;
+};
 export type ClientWithModels = V6Client | V6ClientSSRRequest | V6ClientSSRCookies;
-export type V6Client<T extends Record<any, any> = never> = {
-    graphql: GraphQLMethod;
+export type V6Client<T extends Record<any, any> = never, Options extends CommonPublicClientOptions = object> = {
+    graphql: GraphQLMethod<Options>;
     cancel(promise: Promise<any>, message?: string): boolean;
     isCancelError(error: any): boolean;
 } & ClientExtensions<T>;
-export type V6ClientSSRRequest<T extends Record<any, any> = never> = {
-    graphql: GraphQLMethodSSR;
+export type V6ClientSSRRequest<T extends Record<any, any> = never, Options extends CommonPublicClientOptions = object> = {
+    graphql: GraphQLMethodSSR<Options>;
     cancel(promise: Promise<any>, message?: string): boolean;
     isCancelError(error: any): boolean;
 } & ClientExtensionsSSRRequest<T>;
-export type V6ClientSSRCookies<T extends Record<any, any> = never> = {
-    graphql: GraphQLMethod;
+export type V6ClientSSRCookies<T extends Record<any, any> = never, Options extends CommonPublicClientOptions = object> = {
+    graphql: GraphQLMethod<Options>;
     cancel(promise: Promise<any>, message?: string): boolean;
     isCancelError(error: any): boolean;
 } & ClientExtensionsSSRCookies<T>;
-export type GraphQLMethod = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: CustomHeaders | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-export type GraphQLMethodSSR = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(contextSpec: AmplifyServer.ContextSpec, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: CustomHeaders | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+export type GraphQLMethod<Options extends CommonPublicClientOptions> = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, Options>, additionalHeaders?: CustomHeaders | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+export type GraphQLMethodSSR<Options extends CommonPublicClientOptions> = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(contextSpec: AmplifyServer.ContextSpec, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, Options>, additionalHeaders?: CustomHeaders | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 /**
  * @private
  *
@@ -315,8 +364,6 @@ export interface AuthModeParams extends Record<string, unknown> {
     authMode?: GraphQLAuthMode;
     authToken?: string;
 }
-export interface GenerateServerClientParams {
+export type GenerateServerClientParams = {
     config: ResourcesConfig;
-    authMode?: GraphQLAuthMode;
-    authToken?: string;
-}
+} & CommonPublicClientOptions;

package/dist/esm/types/index.mjs

@@ -11,16 +11,20 @@ var GraphQLAuthError;
 const __amplify = Symbol('amplify');
 const __authMode = Symbol('authMode');
 const __authToken = Symbol('authToken');
+const __apiKey = Symbol('apiKey');
 const __headers = Symbol('headers');
+const __endpoint = Symbol('endpoint');
 function getInternals(client) {
     const c = client;
     return {
         amplify: c[__amplify],
+        apiKey: c[__apiKey],
         authMode: c[__authMode],
         authToken: c[__authToken],
+        endpoint: c[__endpoint],
         headers: c[__headers],
     };
 }
 
-export { GraphQLAuthError, __amplify, __authMode, __authToken, __headers, getInternals };
+export { GraphQLAuthError, __amplify, __apiKey, __authMode, __authToken, __endpoint, __headers, getInternals };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/types/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../../../src/types/index.ts"],"sourcesContent":["export { CONTROL_MSG, ConnectionState } from './PubSub';\nexport var GraphQLAuthError;\n(function (GraphQLAuthError) {\n    GraphQLAuthError[\"NO_API_KEY\"] = \"No api-key configured\";\n    GraphQLAuthError[\"NO_CURRENT_USER\"] = \"No current user\";\n    GraphQLAuthError[\"NO_CREDENTIALS\"] = \"No credentials\";\n    GraphQLAuthError[\"NO_FEDERATED_JWT\"] = \"No federated jwt\";\n    GraphQLAuthError[\"NO_AUTH_TOKEN\"] = \"No auth token specified\";\n})(GraphQLAuthError || (GraphQLAuthError = {}));\nexport const __amplify = Symbol('amplify');\nexport const __authMode = Symbol('authMode');\nexport const __authToken = Symbol('authToken');\nexport const __headers = Symbol('headers');\nexport function getInternals(client) {\n    const c = client;\n    return {\n        amplify: c[__amplify],\n        authMode: c[__authMode],\n        authToken: c[__authToken],\n        headers: c[__headers],\n    };\n}\n"],"names":[],"mappings":";;AACU,IAAC,iBAAiB;AAC5B,CAAC,UAAU,gBAAgB,EAAE;AAC7B,IAAI,gBAAgB,CAAC,YAAY,CAAC,GAAG,uBAAuB,CAAC;AAC7D,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,iBAAiB,CAAC;AAC5D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;AAC1D,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AAC9D,IAAI,gBAAgB,CAAC,eAAe,CAAC,GAAG,yBAAyB,CAAC;AAClE,CAAC,EAAE,gBAAgB,KAAK,gBAAgB,GAAG,EAAE,CAAC,CAAC,CAAC;AACpC,MAAC,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE;AAC/B,MAAC,UAAU,GAAG,MAAM,CAAC,UAAU,EAAE;AACjC,MAAC,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE;AACnC,MAAC,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE;AACpC,SAAS,YAAY,CAAC,MAAM,EAAE;AACrC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AACrB,IAAI,OAAO;AACX,QAAQ,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;AAC7B,QAAQ,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC;AAC/B,QAAQ,SAAS,EAAE,CAAC,CAAC,WAAW,CAAC;AACjC,QAAQ,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;AAC7B,KAAK,CAAC;AACN;;;;"}
+{"version":3,"file":"index.mjs","sources":["../../../src/types/index.ts"],"sourcesContent":["export { CONTROL_MSG, ConnectionState } from './PubSub';\nexport var GraphQLAuthError;\n(function (GraphQLAuthError) {\n    GraphQLAuthError[\"NO_API_KEY\"] = \"No api-key configured\";\n    GraphQLAuthError[\"NO_CURRENT_USER\"] = \"No current user\";\n    GraphQLAuthError[\"NO_CREDENTIALS\"] = \"No credentials\";\n    GraphQLAuthError[\"NO_FEDERATED_JWT\"] = \"No federated jwt\";\n    GraphQLAuthError[\"NO_AUTH_TOKEN\"] = \"No auth token specified\";\n})(GraphQLAuthError || (GraphQLAuthError = {}));\nexport const __amplify = Symbol('amplify');\nexport const __authMode = Symbol('authMode');\nexport const __authToken = Symbol('authToken');\nexport const __apiKey = Symbol('apiKey');\nexport const __headers = Symbol('headers');\nexport const __endpoint = Symbol('endpoint');\nexport function getInternals(client) {\n    const c = client;\n    return {\n        amplify: c[__amplify],\n        apiKey: c[__apiKey],\n        authMode: c[__authMode],\n        authToken: c[__authToken],\n        endpoint: c[__endpoint],\n        headers: c[__headers],\n    };\n}\n"],"names":[],"mappings":";;AACU,IAAC,iBAAiB;AAC5B,CAAC,UAAU,gBAAgB,EAAE;AAC7B,IAAI,gBAAgB,CAAC,YAAY,CAAC,GAAG,uBAAuB,CAAC;AAC7D,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,iBAAiB,CAAC;AAC5D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;AAC1D,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AAC9D,IAAI,gBAAgB,CAAC,eAAe,CAAC,GAAG,yBAAyB,CAAC;AAClE,CAAC,EAAE,gBAAgB,KAAK,gBAAgB,GAAG,EAAE,CAAC,CAAC,CAAC;AACpC,MAAC,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE;AAC/B,MAAC,UAAU,GAAG,MAAM,CAAC,UAAU,EAAE;AACjC,MAAC,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE;AACnC,MAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE;AAC7B,MAAC,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE;AAC/B,MAAC,UAAU,GAAG,MAAM,CAAC,UAAU,EAAE;AACtC,SAAS,YAAY,CAAC,MAAM,EAAE;AACrC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AACrB,IAAI,OAAO;AACX,QAAQ,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;AAC7B,QAAQ,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC;AAC3B,QAAQ,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC;AAC/B,QAAQ,SAAS,EAAE,CAAC,CAAC,WAAW,CAAC;AACjC,QAAQ,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC;AAC/B,QAAQ,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;AAC7B,KAAK,CAAC;AACN;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.6.8-unstable.0ecded1.0+0ecded1",
+	"version": "4.6.8-unstable.ca2e4b8.0+ca2e4b8",
 	"description": "Api-graphql category of aws-amplify",
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.mjs",
@@ -84,8 +84,8 @@
 		"server"
 	],
 	"dependencies": {
-		"@aws-amplify/api-rest": "4.0.65-unstable.0ecded1.0+0ecded1",
-		"@aws-amplify/core": "6.8.1-unstable.0ecded1.0+0ecded1",
+		"@aws-amplify/api-rest": "4.0.65-unstable.ca2e4b8.0+ca2e4b8",
+		"@aws-amplify/core": "6.8.1-unstable.ca2e4b8.0+ca2e4b8",
 		"@aws-amplify/data-schema": "^1.7.0",
 		"@aws-sdk/types": "3.387.0",
 		"graphql": "15.8.0",
@@ -101,5 +101,5 @@
 			"limit": "91.7 kB"
 		}
 	],
-	"gitHead": "0ecded15a4d1318fe10b16dbe534a111a12bdc21"
+	"gitHead": "ca2e4b87a456dfe9a027e49bdcd912a2cba8e59d"
 }

package/src/internals/InternalGraphQLAPI.ts

@@ -52,7 +52,7 @@ export class InternalGraphQLAPIClass {
 	/**
 	 * @private
 	 */
-	private appSyncRealTime = new AWSAppSyncRealTimeProvider();
+	private appSyncRealTime = new Map<string, AWSAppSyncRealTimeProvider>();
 
 	private _api = {
 		post,
@@ -88,7 +88,14 @@ export class InternalGraphQLAPIClass {
 		amplify:
 			| AmplifyClassV6
 			| ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>),
-		{ query: paramQuery, variables = {}, authMode, authToken }: GraphQLOptions,
+		{
+			query: paramQuery,
+			variables = {},
+			authMode,
+			authToken,
+			endpoint,
+			apiKey,
+		}: GraphQLOptions,
 		additionalHeaders?: CustomHeaders,
 		customUserAgentDetails?: CustomUserAgentDetails,
 	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
@@ -115,7 +122,7 @@ export class InternalGraphQLAPIClass {
 				if (isAmplifyInstance(amplify)) {
 					responsePromise = this._graphql<T>(
 						amplify,
-						{ query, variables, authMode },
+						{ query, variables, authMode, apiKey, endpoint },
 						headers,
 						abortController,
 						customUserAgentDetails,
@@ -127,7 +134,7 @@ export class InternalGraphQLAPIClass {
 					const wrapper = async (amplifyInstance: AmplifyClassV6) => {
 						const result = await this._graphql<T>(
 							amplifyInstance,
-							{ query, variables, authMode },
+							{ query, variables, authMode, apiKey, endpoint },
 							headers,
 							abortController,
 							customUserAgentDetails,
@@ -152,7 +159,7 @@ export class InternalGraphQLAPIClass {
 			case 'subscription':
 				return this._graphqlSubscribe(
 					amplify as AmplifyClassV6,
-					{ query, variables, authMode },
+					{ query, variables, authMode, apiKey, endpoint },
 					headers,
 					customUserAgentDetails,
 					authToken,
@@ -164,7 +171,13 @@ export class InternalGraphQLAPIClass {
 
 	private async _graphql<T = any>(
 		amplify: AmplifyClassV6,
-		{ query, variables, authMode: explicitAuthMode }: GraphQLOptions,
+		{
+			query,
+			variables,
+			authMode: authModeOverride,
+			endpoint: endpointOverride,
+			apiKey: apiKeyOverride,
+		}: GraphQLOptions,
 		additionalHeaders: CustomHeaders = {},
 		abortController: AbortController,
 		customUserAgentDetails?: CustomUserAgentDetails,
@@ -179,7 +192,7 @@ export class InternalGraphQLAPIClass {
 			defaultAuthMode,
 		} = resolveConfig(amplify);
 
-		const initialAuthMode = explicitAuthMode || defaultAuthMode || 'iam';
+		const initialAuthMode = authModeOverride || defaultAuthMode || 'iam';
 		// identityPool is an alias for iam. TODO: remove 'iam' in v7
 		const authMode =
 			initialAuthMode === 'identityPool' ? 'iam' : initialAuthMode;
@@ -205,7 +218,7 @@ export class InternalGraphQLAPIClass {
 			const requestOptions: RequestOptions = {
 				method: 'POST',
 				url: new AmplifyUrl(
-					customEndpoint || appSyncGraphqlEndpoint || '',
+					endpointOverride || customEndpoint || appSyncGraphqlEndpoint || '',
 				).toString(),
 				queryString: print(query as DocumentNode),
 			};
@@ -226,7 +239,7 @@ export class InternalGraphQLAPIClass {
 		const authHeaders = await headerBasedAuth(
 			amplify,
 			authMode,
-			apiKey,
+			apiKeyOverride ?? apiKey,
 			additionalCustomHeaders,
 		);
 
@@ -282,7 +295,8 @@ export class InternalGraphQLAPIClass {
 			};
 		}
 
-		const endpoint = customEndpoint || appSyncGraphqlEndpoint;
+		const endpoint =
+			endpointOverride || customEndpoint || appSyncGraphqlEndpoint;
 
 		if (!endpoint) {
 			throw createGraphQLResultWithError<T>(new GraphQLApiError(NO_ENDPOINT));
@@ -341,7 +355,13 @@ export class InternalGraphQLAPIClass {
 
 	private _graphqlSubscribe(
 		amplify: AmplifyClassV6,
-		{ query, variables, authMode: explicitAuthMode }: GraphQLOptions,
+		{
+			query,
+			variables,
+			authMode: authModeOverride,
+			apiKey: apiKeyOverride,
+			endpoint,
+		}: GraphQLOptions,
 		additionalHeaders: CustomHeaders = {},
 		customUserAgentDetails?: CustomUserAgentDetails,
 		authToken?: string,
@@ -349,7 +369,7 @@ export class InternalGraphQLAPIClass {
 		const config = resolveConfig(amplify);
 
 		const initialAuthMode =
-			explicitAuthMode || config?.defaultAuthMode || 'iam';
+			authModeOverride || config?.defaultAuthMode || 'iam';
 		// identityPool is an alias for iam. TODO: remove 'iam' in v7
 		const authMode =
 			initialAuthMode === 'identityPool' ? 'iam' : initialAuthMode;
@@ -364,15 +384,26 @@ export class InternalGraphQLAPIClass {
 		 */
 		const { headers: libraryConfigHeaders } = resolveLibraryOptions(amplify);
 
-		return this.appSyncRealTime
+		const appSyncGraphqlEndpoint = endpoint ?? config?.endpoint;
+
+		// TODO: This could probably be an exception. But, lots of tests rely on
+		// attempting to connect to nowhere. So, I'm treating as the opposite of
+		// a Chesterton's fence for now. (A fence I shouldn't build, because I don't
+		// know why somethings depends on its absence!)
+		const memoKey = appSyncGraphqlEndpoint ?? 'none';
+		const realtimeProvider =
+			this.appSyncRealTime.get(memoKey) ?? new AWSAppSyncRealTimeProvider();
+		this.appSyncRealTime.set(memoKey, realtimeProvider);
+
+		return realtimeProvider
 			.subscribe(
 				{
 					query: print(query as DocumentNode),
 					variables,
-					appSyncGraphqlEndpoint: config?.endpoint,
+					appSyncGraphqlEndpoint,
 					region: config?.region,
 					authenticationType: authMode,
-					apiKey: config?.apiKey,
+					apiKey: apiKeyOverride ?? config?.apiKey,
 					additionalHeaders,
 					authToken,
 					libraryConfigHeaders,

package/src/internals/generateClient.ts

@@ -13,8 +13,10 @@ import {
 import {
 	V6Client,
 	__amplify,
+	__apiKey,
 	__authMode,
 	__authToken,
+	__endpoint,
 	__headers,
 	getInternals,
 } from '../types';
@@ -33,13 +35,16 @@ import { ClientGenerationParams } from './types';
  * @param params
  * @returns
  */
-export function generateClient<T extends Record<any, any> = never>(
-	params: ClientGenerationParams,
-): V6Client<T> {
+export function generateClient<
+	T extends Record<any, any> = never,
+	Options extends ClientGenerationParams = ClientGenerationParams,
+>(params: Options): V6Client<T, Options> {
 	const client = {
 		[__amplify]: params.amplify,
 		[__authMode]: params.authMode,
 		[__authToken]: params.authToken,
+		[__apiKey]: 'apiKey' in params ? params.apiKey : undefined,
+		[__endpoint]: 'endpoint' in params ? params.endpoint : undefined,
 		[__headers]: params.headers,
 		graphql,
 		cancel,
@@ -53,22 +58,37 @@ export function generateClient<T extends Record<any, any> = never>(
 
 	const apiGraphqlConfig = params.amplify.getConfig().API?.GraphQL;
 
-	if (isApiGraphQLConfig(apiGraphqlConfig)) {
-		addSchemaToClient(client, apiGraphqlConfig, getInternals);
-	} else {
-		// This happens when the `Amplify.configure()` call gets evaluated after the `generateClient()` call.
-		//
-		// Cause: when the `generateClient()` and the `Amplify.configure()` calls are located in
-		// different source files, script bundlers may randomly arrange their orders in the production
-		// bundle.
-		//
-		// With the current implementation, the `client.models` instance created by `generateClient()`
-		// will be rebuilt on every `Amplify.configure()` call that's provided with a valid GraphQL
-		// provider configuration.
-		//
-		// TODO: revisit, and reverify this approach when enabling multiple clients for multi-endpoints
-		// configuration.
-		generateModelsPropertyOnAmplifyConfigure(client);
+	if (client[__endpoint]) {
+		if (!client[__authMode]) {
+			throw new Error(
+				'generateClient() requires an explicit `authMode` when `endpoint` is provided.',
+			);
+		}
+		if (client[__authMode] === 'apiKey' && !client[__apiKey]) {
+			throw new Error(
+				"generateClient() requires an explicit `apiKey` when `endpoint` is provided and `authMode = 'apiKey'`.",
+			);
+		}
+	}
+
+	if (!client[__endpoint]) {
+		if (isApiGraphQLConfig(apiGraphqlConfig)) {
+			addSchemaToClient(client, apiGraphqlConfig, getInternals);
+		} else {
+			// This happens when the `Amplify.configure()` call gets evaluated after the `generateClient()` call.
+			//
+			// Cause: when the `generateClient()` and the `Amplify.configure()` calls are located in
+			// different source files, script bundlers may randomly arrange their orders in the production
+			// bundle.
+			//
+			// With the current implementation, the `client.models` instance created by `generateClient()`
+			// will be rebuilt on every `Amplify.configure()` call that's provided with a valid GraphQL
+			// provider configuration.
+			//
+			// TODO: revisit, and reverify this approach when enabling multiple clients for multi-endpoints
+			// configuration.
+			generateModelsPropertyOnAmplifyConfigure(client);
+		}
 	}
 
 	return client as any;

package/src/internals/index.ts

@@ -7,3 +7,4 @@ export {
 
 export { graphql, cancel, isCancelError } from './v6';
 export { generateClient } from './generateClient';
+export { CommonPublicClientOptions, DefaultCommonClientOptions } from './types';

package/src/internals/server/generateClientWithAmplifyInstance.ts

@@ -9,8 +9,10 @@ import {
 	V6ClientSSRCookies,
 	V6ClientSSRRequest,
 	__amplify,
+	__apiKey,
 	__authMode,
 	__authToken,
+	__endpoint,
 	__headers,
 	getInternals,
 } from '../../types';
@@ -40,6 +42,8 @@ export function generateClientWithAmplifyInstance<
 		[__amplify]: params.amplify,
 		[__authMode]: params.authMode,
 		[__authToken]: params.authToken,
+		[__apiKey]: 'apiKey' in params ? params.apiKey : undefined,
+		[__endpoint]: 'endpoint' in params ? params.endpoint : undefined,
 		[__headers]: params.headers,
 		graphql,
 		cancel,
@@ -48,7 +52,20 @@ export function generateClientWithAmplifyInstance<
 
 	const apiGraphqlConfig = params.config?.API?.GraphQL;
 
-	if (isApiGraphQLConfig(apiGraphqlConfig)) {
+	if (client[__endpoint]) {
+		if (!client[__authMode]) {
+			throw new Error(
+				'generateClient() requires an explicit `authMode` when `endpoint` is provided.',
+			);
+		}
+		if (client[__authMode] === 'apiKey' && !client[__apiKey]) {
+			throw new Error(
+				"generateClient() requires an explicit `apiKey` when `endpoint` is provided and `authMode = 'apiKey'`.",
+			);
+		}
+	}
+
+	if (!client[__endpoint] && isApiGraphQLConfig(apiGraphqlConfig)) {
 		addSchemaToClientWithInstance<T>(client, params, getInternals);
 	}
 

package/src/internals/types.ts

@@ -13,11 +13,30 @@ export type ClientGenerationParams = {
 	amplify: AmplifyClassV6;
 } & CommonPublicClientOptions;
 
-/**
- * Common options that can be used on public `generateClient()` interfaces.
- */
-export interface CommonPublicClientOptions {
+export interface DefaultCommonClientOptions {
+	endpoint?: never;
 	authMode?: GraphQLAuthMode;
+	apiKey?: string;
 	authToken?: string;
 	headers?: CustomHeaders;
 }
+
+/**
+ * Common options that can be used on public `generateClient()` interfaces.
+ */
+export type CommonPublicClientOptions =
+	| DefaultCommonClientOptions
+	| {
+			endpoint: string;
+			authMode: 'apiKey';
+			apiKey: string;
+			authToken?: string;
+			headers?: CustomHeaders;
+	  }
+	| {
+			endpoint: string;
+			authMode: Exclude<GraphQLAuthMode, 'apiKey'>;
+			apiKey?: string;
+			authToken?: string;
+			headers?: CustomHeaders;
+	  };

package/src/internals/v6.ts

@@ -4,6 +4,7 @@ import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
 
 import { GraphQLAPI } from '../GraphQLAPI';
 import {
+	CommonPublicClientOptions,
 	GraphQLOptions,
 	GraphQLOptionsV6,
 	GraphQLResponseV6,
@@ -98,15 +99,51 @@ import {
 export function graphql<
 	FALLBACK_TYPES = unknown,
 	TYPED_GQL_STRING extends string = string,
+	Options extends CommonPublicClientOptions = object,
 >(
 	this: V6Client,
-	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>,
+	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, Options>,
 	additionalHeaders?: CustomHeaders,
 ): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING> {
 	// inject client-level auth
-	const internals = getInternals(this as any);
-	options.authMode = options.authMode || internals.authMode;
+	const internals = getInternals(this);
+
+	/**
+	 * The custom `endpoint` specific to the client
+	 */
+	const clientEndpoint = internals.endpoint;
+
+	/**
+	 * The `authMode` specific to the client.
+	 */
+	const clientAuthMode = internals.authMode;
+
+	/**
+	 * The `apiKey` specific to the client.
+	 */
+	const clientApiKey = internals.apiKey;
+
+	/**
+	 * The most specific `authMode` wins. Setting an `endpoint` value without also
+	 * setting an `authMode` value is invalid. This helps to prevent customers apps
+	 * from unexpectedly sending auth details to endpoints the auth details do not
+	 * belong to.
+	 *
+	 * This is especially pronounced for `apiKey`. When both an `endpoint` *and*
+	 * `authMode: 'apiKey'` are provided, an explicit `apiKey` override is required
+	 * to prevent inadvertent sending of an API's `apiKey` to an endpoint is does
+	 * not belong to.
+	 */
+	options.authMode = options.authMode || clientAuthMode;
+	options.apiKey = options.apiKey ?? clientApiKey;
 	options.authToken = options.authToken || internals.authToken;
+
+	if (clientEndpoint && options.authMode === 'apiKey' && !options.apiKey) {
+		throw new Error(
+			"graphql() requires an explicit `apiKey` for a custom `endpoint` when `authMode = 'apiKey'`.",
+		);
+	}
+
 	const headers = additionalHeaders || internals.headers;
 
 	/**
@@ -114,11 +151,13 @@ export function graphql<
 	 * Neither of these can actually be validated at runtime. Hence, we don't perform
 	 * any validation or type-guarding here.
 	 */
-
 	const result = GraphQLAPI.graphql(
 		// TODO: move V6Client back into this package?
 		internals.amplify as any,
-		options as GraphQLOptions,
+		{
+			...options,
+			endpoint: clientEndpoint,
+		} as GraphQLOptions,
 		headers,
 	);
 

package/src/server/generateClient.ts

@@ -5,6 +5,7 @@ import {
 	AmplifyServer,
 	getAmplifyServerContext,
 } from '@aws-amplify/core/internals/adapter-core';
+import { ResourcesConfig } from '@aws-amplify/core';
 import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
 
 import { generateClientWithAmplifyInstance } from '../internals/server';
@@ -33,38 +34,35 @@ import {
  *   }),
  * });
  */
-export function generateClient<T extends Record<any, any> = never>({
-	config,
-	authMode,
-	authToken,
-}: GenerateServerClientParams): V6ClientSSRRequest<T> {
+export function generateClient<
+	T extends Record<any, any> = never,
+	Options extends GenerateServerClientParams = { config: ResourcesConfig },
+>(options: Options): V6ClientSSRRequest<T, Options> {
 	// passing `null` instance because each (future model) method must retrieve a valid instance
 	// from server context
 	const client = generateClientWithAmplifyInstance<T, V6ClientSSRRequest<T>>({
 		amplify: null,
-		config,
-		authMode,
-		authToken,
+		...options,
 	});
 
 	// TODO: improve this and the next type
-	const prevGraphql = client.graphql as unknown as GraphQLMethod;
+	const prevGraphql = client.graphql as unknown as GraphQLMethod<Options>;
 
 	const wrappedGraphql = (
 		contextSpec: AmplifyServer.ContextSpec,
-		options: GraphQLOptionsV6,
+		innerOptions: GraphQLOptionsV6<unknown, string, Options>,
 		additionalHeaders?: CustomHeaders,
 	) => {
 		const amplifyInstance = getAmplifyServerContext(contextSpec).amplify;
 
 		return prevGraphql.call(
 			{ [__amplify]: amplifyInstance },
-			options,
-			additionalHeaders as any,
+			innerOptions,
+			additionalHeaders,
 		);
 	};
 
-	client.graphql = wrappedGraphql as unknown as GraphQLMethodSSR;
+	client.graphql = wrappedGraphql as unknown as GraphQLMethodSSR<Options>;
 
 	return client;
 }