@aws-amplify/api-graphql 4.6.7-graphql-multi-client.4f8e7a9.0 → 4.6.7-graphql-multi-client.93b5136.0

package/dist/esm/internals/generateClient.d.ts

@@ -1,5 +1,5 @@
 import { V6Client } from '../types';
-import { ClientGenerationParams } from './types';
+import { ClientGenerationParams, CommonPublicClientOptions } from './types';
 /**
  * @private
  *
@@ -9,4 +9,4 @@ import { ClientGenerationParams } from './types';
  * @param params
  * @returns
  */
-export declare function generateClient<T extends Record<any, any> = never, WithCustomEndpoint extends boolean = false, WithApiKey extends boolean = false>(params: ClientGenerationParams<WithCustomEndpoint, WithApiKey>): V6Client<T, WithCustomEndpoint, WithApiKey>;
+export declare function generateClient<T extends Record<any, any> = never, Options extends CommonPublicClientOptions = object>(params: ClientGenerationParams): V6Client<T, Options>;

package/dist/esm/internals/server/generateClientWithAmplifyInstance.d.ts

@@ -10,4 +10,4 @@ import { CommonPublicClientOptions, ServerClientGenerationParams, V6ClientSSRCoo
  * @param params
  * @returns
  */
-export declare function generateClientWithAmplifyInstance<T extends Record<any, any> = never, ClientType extends V6ClientSSRRequest<T, any, any> | V6ClientSSRCookies<T, any, any> = V6ClientSSRCookies<T, any, any>>(params: ServerClientGenerationParams & CommonPublicClientOptions<any, any>): ClientType;
+export declare function generateClientWithAmplifyInstance<T extends Record<any, any> = never, ClientType extends V6ClientSSRRequest<T> | V6ClientSSRCookies<T> = V6ClientSSRCookies<T>>(params: ServerClientGenerationParams & CommonPublicClientOptions): ClientType;

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

@@ -6,33 +6,28 @@ import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
  *
  * The knobs available for configuring `generateClient` internally.
  */
-export type ClientGenerationParams<WithCustomEndpoint extends boolean, WithApiKey extends boolean> = {
+export type ClientGenerationParams = {
     amplify: AmplifyClassV6;
-} & CommonPublicClientOptions<WithCustomEndpoint, WithApiKey>;
+} & CommonPublicClientOptions;
 /**
  * Common options that can be used on public `generateClient()` interfaces.
  */
-export type CommonPublicClientOptions<WithCustomEndpoint extends boolean, WithApiKey extends boolean> = WithCustomEndpoint extends true ? WithApiKey extends true ? {
-    endpoint: string;
-    authMode: 'apiKey';
-    apiKey: string;
+export type CommonPublicClientOptions = {
+    endpoint?: never;
+    authMode?: GraphQLAuthMode;
     authToken?: string;
+    apiKey?: string;
     headers?: CustomHeaders;
 } | {
     endpoint: string;
+    authMode: 'apiKey';
     apiKey: string;
-    authMode: Exclude<GraphQLAuthMode, 'apiKey'>;
     authToken?: string;
     headers?: CustomHeaders;
-} : {
+} | {
     endpoint: string;
     authMode: Exclude<GraphQLAuthMode, 'apiKey'>;
-    apiKey?: never;
-    authToken?: string;
-    headers?: CustomHeaders;
-} : {
-    endpoint?: never;
-    authMode?: GraphQLAuthMode;
+    apiKey?: string;
     authToken?: string;
     headers?: CustomHeaders;
 };

package/dist/esm/internals/v6.d.ts

@@ -1,5 +1,5 @@
 import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
-import { GraphQLOptionsV6, GraphQLResponseV6, V6Client } from '../types';
+import { CommonPublicClientOptions, GraphQLOptionsV6, GraphQLResponseV6, V6Client } from '../types';
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
  * output types if Amplify-generated graphql from a recent version of the CLI/codegen
@@ -84,7 +84,7 @@ import { GraphQLOptionsV6, GraphQLResponseV6, V6Client } from '../types';
  * @param options
  * @param additionalHeaders
  */
-export declare function graphql<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(this: V6Client, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: CustomHeaders): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+export declare 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>, additionalHeaders?: CustomHeaders): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 /**
  * Cancels an inflight request. Only applicable for graphql queries and mutations
  * @param {any} request - request to cancel

package/dist/esm/server/generateClient.d.ts

@@ -1,3 +1,4 @@
+import { ResourcesConfig } from '@aws-amplify/core';
 import { GenerateServerClientParams, V6ClientSSRRequest } from '../types';
 /**
  * Generates an GraphQL API client that works with Amplify server context.
@@ -15,4 +16,6 @@ import { GenerateServerClientParams, V6ClientSSRRequest } from '../types';
  *   }),
  * });
  */
-export declare function generateClient<T extends Record<any, any> = never, WithCustomEndpoint extends boolean = false, WithApiKey extends boolean = false>(options: GenerateServerClientParams<WithCustomEndpoint, WithApiKey>): V6ClientSSRRequest<T, WithCustomEndpoint, WithApiKey>;
+export declare function generateClient<T extends Record<any, any> = never, Options extends GenerateServerClientParams = {
+    config: ResourcesConfig;
+}>(options: Options): V6ClientSSRRequest<T, Options>;

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

@@ -165,7 +165,7 @@ export type GraphQLOperation = Source | string;
  * API V6 `graphql({options})` type that can leverage branded graphql `query`
  * objects and fallback types.
  */
-export type GraphQLOptionsV6<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string, WithCustomEndpoint extends boolean = false, WithApiKey extends boolean = false> = WithCustomEndpoint extends true ? WithApiKey extends true ? {
+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;
@@ -324,23 +324,23 @@ export declare const __headers: unique symbol;
 export declare const __endpoint: unique symbol;
 export declare function getInternals(client: BaseClient): ClientInternals;
 export type ClientWithModels = V6Client | V6ClientSSRRequest | V6ClientSSRCookies;
-export type V6Client<T extends Record<any, any> = never, WithCustomEndpoint extends boolean = false, WithApiKey extends boolean = false> = {
-    graphql: GraphQLMethod<WithCustomEndpoint, WithApiKey>;
+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, WithCustomEndpoint extends boolean = false, WithApiKey extends boolean = false> = {
-    graphql: GraphQLMethodSSR<WithCustomEndpoint, WithApiKey>;
+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, WithCustomEndpoint extends boolean = false, WithApiKey extends boolean = false> = {
-    graphql: GraphQLMethod<WithCustomEndpoint, WithApiKey>;
+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<WithCustomEndpoint extends boolean, WithApiKey extends boolean> = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, WithCustomEndpoint, WithApiKey>, additionalHeaders?: CustomHeaders | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-export type GraphQLMethodSSR<WithCustomEndpoint extends boolean, WithApiKey extends boolean> = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(contextSpec: AmplifyServer.ContextSpec, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, WithCustomEndpoint, WithApiKey>, 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
  *
@@ -361,6 +361,6 @@ export interface AuthModeParams extends Record<string, unknown> {
     authMode?: GraphQLAuthMode;
     authToken?: string;
 }
-export type GenerateServerClientParams<WithCustomEndpoint extends boolean, WithApiKey extends boolean> = {
+export type GenerateServerClientParams = {
     config: ResourcesConfig;
-} & CommonPublicClientOptions<WithCustomEndpoint, WithApiKey>;
+} & CommonPublicClientOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.6.7-graphql-multi-client.4f8e7a9.0+4f8e7a9",
+	"version": "4.6.7-graphql-multi-client.93b5136.0+93b5136",
 	"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.64-graphql-multi-client.4f8e7a9.0+4f8e7a9",
-		"@aws-amplify/core": "6.7.4-graphql-multi-client.4f8e7a9.0+4f8e7a9",
+		"@aws-amplify/api-rest": "4.0.64-graphql-multi-client.93b5136.0+93b5136",
+		"@aws-amplify/core": "6.7.4-graphql-multi-client.93b5136.0+93b5136",
 		"@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": "4f8e7a94a1c2540baa7eda530787b248b0fb237a"
+	"gitHead": "93b51360e57e283a7d4ed64c6b701d85ec71e94b"
 }

package/src/internals/generateClient.ts

@@ -24,7 +24,7 @@ import {
 import { isApiGraphQLConfig } from './utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
 import { isConfigureEventWithResourceConfig } from './utils/runtimeTypeGuards/isConfigureEventWithResourceConfig';
 import { cancel, graphql, isCancelError } from './v6';
-import { ClientGenerationParams } from './types';
+import { ClientGenerationParams, CommonPublicClientOptions } from './types';
 
 /**
  * @private
@@ -37,11 +37,8 @@ import { ClientGenerationParams } from './types';
  */
 export function generateClient<
 	T extends Record<any, any> = never,
-	WithCustomEndpoint extends boolean = false,
-	WithApiKey extends boolean = false,
->(
-	params: ClientGenerationParams<WithCustomEndpoint, WithApiKey>,
-): V6Client<T, WithCustomEndpoint, WithApiKey> {
+	Options extends CommonPublicClientOptions = object,
+>(params: ClientGenerationParams): V6Client<T, Options> {
 	const client = {
 		[__amplify]: params.amplify,
 		[__authMode]: params.authMode,

package/src/internals/server/generateClientWithAmplifyInstance.ts

@@ -33,10 +33,10 @@ import { cancel, graphql, isCancelError } from '..';
 export function generateClientWithAmplifyInstance<
 	T extends Record<any, any> = never,
 	ClientType extends
-		| V6ClientSSRRequest<T, any, any>
-		| V6ClientSSRCookies<T, any, any> = V6ClientSSRCookies<T, any, any>,
+		| V6ClientSSRRequest<T>
+		| V6ClientSSRCookies<T> = V6ClientSSRCookies<T>,
 >(
-	params: ServerClientGenerationParams & CommonPublicClientOptions<any, any>,
+	params: ServerClientGenerationParams & CommonPublicClientOptions,
 ): ClientType {
 	const client = {
 		[__amplify]: params.amplify,

package/src/internals/types.ts

@@ -9,46 +9,32 @@ import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
  *
  * The knobs available for configuring `generateClient` internally.
  */
-export type ClientGenerationParams<
-	WithCustomEndpoint extends boolean,
-	WithApiKey extends boolean,
-> = {
+export type ClientGenerationParams = {
 	amplify: AmplifyClassV6;
-} & CommonPublicClientOptions<WithCustomEndpoint, WithApiKey>;
+} & CommonPublicClientOptions;
 
 /**
  * Common options that can be used on public `generateClient()` interfaces.
  */
-export type CommonPublicClientOptions<
-	WithCustomEndpoint extends boolean,
-	WithApiKey extends boolean,
-> = WithCustomEndpoint extends true
-	? WithApiKey extends true
-		?
-				| {
-						endpoint: string;
-						authMode: 'apiKey';
-						apiKey: string;
-						authToken?: string;
-						headers?: CustomHeaders;
-				  }
-				| {
-						endpoint: string;
-						apiKey: string;
-						authMode: Exclude<GraphQLAuthMode, 'apiKey'>;
-						authToken?: string;
-						headers?: CustomHeaders;
-				  }
-		: {
-				endpoint: string;
-				authMode: Exclude<GraphQLAuthMode, 'apiKey'>;
-				apiKey?: never;
-				authToken?: string;
-				headers?: CustomHeaders;
-			}
-	: {
+export type CommonPublicClientOptions =
+	| {
 			endpoint?: never;
 			authMode?: GraphQLAuthMode;
 			authToken?: string;
+			apiKey?: string;
 			headers?: CustomHeaders;
-		};
+	  }
+	| {
+			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,
 	GraphQLOptionsV6,
 	GraphQLResponseV6,
 	V6Client,
@@ -97,9 +98,10 @@ 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
@@ -154,7 +156,7 @@ export function graphql<
 		{
 			...options,
 			endpoint: clientEndpoint,
-		},
+		} as any,
 		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';
@@ -35,26 +36,17 @@ import {
  */
 export function generateClient<
 	T extends Record<any, any> = never,
-	WithCustomEndpoint extends boolean = false,
-	WithApiKey extends boolean = false,
->(
-	options: GenerateServerClientParams<WithCustomEndpoint, WithApiKey>,
-): V6ClientSSRRequest<T, WithCustomEndpoint, WithApiKey> {
+	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, any, any>
-	>({
+	const client = generateClientWithAmplifyInstance<T, V6ClientSSRRequest<T>>({
 		amplify: null,
 		...options,
 	});
 
 	// TODO: improve this and the next type
-	const prevGraphql = client.graphql as unknown as GraphQLMethod<
-		WithCustomEndpoint,
-		WithApiKey
-	>;
+	const prevGraphql = client.graphql as unknown as GraphQLMethod<Options>;
 
 	const wrappedGraphql = (
 		contextSpec: AmplifyServer.ContextSpec,
@@ -70,10 +62,7 @@ export function generateClient<
 		);
 	};
 
-	client.graphql = wrappedGraphql as unknown as GraphQLMethodSSR<
-		WithCustomEndpoint,
-		WithApiKey
-	>;
+	client.graphql = wrappedGraphql as unknown as GraphQLMethodSSR<Options>;
 
 	return client;
 }

package/src/types/index.ts

@@ -216,10 +216,9 @@ export type GraphQLOperation = Source | string;
 export type GraphQLOptionsV6<
 	FALLBACK_TYPES = unknown,
 	TYPED_GQL_STRING extends string = string,
-	WithCustomEndpoint extends boolean = false,
-	WithApiKey extends boolean = false, // i.e., The client already has apiKey configured.
-> = WithCustomEndpoint extends true
-	? WithApiKey extends true
+	Options extends CommonPublicClientOptions = object,
+> = Options['endpoint'] extends string
+	? Options['apiKey'] extends string
 		? {
 				query: TYPED_GQL_STRING | DocumentNode;
 				variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
@@ -447,58 +446,45 @@ export type ClientWithModels =
 
 export type V6Client<
 	T extends Record<any, any> = never,
-	WithCustomEndpoint extends boolean = false,
-	WithApiKey extends boolean = false,
+	Options extends CommonPublicClientOptions = object,
 > = {
-	graphql: GraphQLMethod<WithCustomEndpoint, WithApiKey>;
+	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,
-	WithCustomEndpoint extends boolean = false,
-	WithApiKey extends boolean = false,
+	Options extends CommonPublicClientOptions = object,
 > = {
-	graphql: GraphQLMethodSSR<WithCustomEndpoint, WithApiKey>;
+	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,
-	WithCustomEndpoint extends boolean = false,
-	WithApiKey extends boolean = false,
+	Options extends CommonPublicClientOptions = object,
 > = {
-	graphql: GraphQLMethod<WithCustomEndpoint, WithApiKey>;
+	graphql: GraphQLMethod<Options>;
 	cancel(promise: Promise<any>, message?: string): boolean;
 	isCancelError(error: any): boolean;
 } & ClientExtensionsSSRCookies<T>;
 
-export type GraphQLMethod<
-	WithCustomEndpoint extends boolean,
-	WithApiKey extends boolean,
-> = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(
-	options: GraphQLOptionsV6<
-		FALLBACK_TYPES,
-		TYPED_GQL_STRING,
-		WithCustomEndpoint,
-		WithApiKey
-	>,
+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<
-	WithCustomEndpoint extends boolean,
-	WithApiKey extends boolean,
-> = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = 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,
-		WithCustomEndpoint,
-		WithApiKey
-	>,
+	options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING, Options>,
 	additionalHeaders?: CustomHeaders | undefined,
 ) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
 
@@ -530,9 +516,6 @@ export interface AuthModeParams extends Record<string, unknown> {
 	authToken?: string;
 }
 
-export type GenerateServerClientParams<
-	WithCustomEndpoint extends boolean,
-	WithApiKey extends boolean,
-> = {
+export type GenerateServerClientParams = {
 	config: ResourcesConfig;
-} & CommonPublicClientOptions<WithCustomEndpoint, WithApiKey>;
+} & CommonPublicClientOptions;