@aws-amplify/api-graphql 4.0.17 → 4.0.18-experimental-lerna-test.d2b0b08.55

package/src/internals/server/generateClientWithAmplifyInstance.ts

@@ -1,17 +1,25 @@
 // 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 { cancel, graphql, isCancelError } from '..';
 import {
+	CommonPublicClientOptions,
+	ServerClientGenerationParams,
+	V6ClientSSRCookies,
+	V6ClientSSRRequest,
 	__amplify,
 	__authMode,
 	__authToken,
-	V6ClientSSRRequest,
-	V6ClientSSRCookies,
-	ServerClientGenerationParams,
-	CommonPublicClientOptions,
+	__headers,
 } from '../../types';
+import { isApiGraphQLConfig } from '../utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
+import { generateEnumsProperty } from '../utils/clientProperties/generateEnumsProperty';
+import {
+	generateCustomMutationsProperty,
+	generateCustomQueriesProperty,
+} from '../generateCustomOperationsProperty';
+
+import { generateModelsProperty } from './generateModelsProperty';
 
 /**
  * @private
@@ -36,12 +44,23 @@ export function generateClientWithAmplifyInstance<
 		[__amplify]: params.amplify,
 		[__authMode]: params.authMode,
 		[__authToken]: params.authToken,
+		[__headers]: params.headers,
 		graphql,
 		cancel,
 		isCancelError,
 	} as any;
 
-	client.models = generateModelsProperty<T>(client, params);
+	const apiGraphqlConfig = params.config?.API?.GraphQL;
+
+	if (isApiGraphQLConfig(apiGraphqlConfig)) {
+		client.models = generateModelsProperty<T>(client, params);
+		client.enums = generateEnumsProperty<T>(apiGraphqlConfig);
+		client.queries = generateCustomQueriesProperty<T>(client, apiGraphqlConfig);
+		client.mutations = generateCustomMutationsProperty<T>(
+			client,
+			apiGraphqlConfig,
+		);
+	}
 
 	return client as ClientType;
 }

package/src/internals/server/generateModelsProperty.ts

@@ -1,26 +1,32 @@
 // 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 { ModelOperation, graphQLOperationsInfo } from '../APIClient';
+import {
+	ServerClientGenerationParams,
+	V6ClientSSRCookies,
+	V6ClientSSRRequest,
+} from '../../types/';
 import { listFactory } from '../operations/list';
 import { indexQueryFactory } from '../operations/indexQuery';
 import { getFactory } from '../operations/get';
 import { getSecondaryIndexesFromSchemaModel } from '../clientUtils';
 
 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<
 		Record<string, any>
 	>,
->(client: ClientType, params: ServerClientGenerationParams): ClientType {
+>(
+	client: ClientType,
+	params: ServerClientGenerationParams,
+): ModelTypes<T> | ModelTypes<never> {
 	const models = {} as any;
-	const config = params.config;
+	const { config } = params;
 	const useContext = params.amplify === null;
 
 	if (!config) {

package/src/internals/types.ts

@@ -16,8 +16,8 @@ export type ClientGenerationParams = {
 /**
  * Common options that can be used on public `generateClient()` interfaces.
  */
-export type CommonPublicClientOptions = {
+export interface CommonPublicClientOptions {
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
 	headers?: CustomHeaders;
-};
+}

package/src/internals/utils/{generateEnumsProperty.ts → clientProperties/generateEnumsProperty.ts}

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-	ModelIntrospectionSchema,
 	GraphQLProviderConfig,
+	ModelIntrospectionSchema,
 } from '@aws-amplify/core/internals/utils';
 import { EnumTypes } from '@aws-amplify/data-schema-types';
 
@@ -17,11 +17,12 @@ export const generateEnumsProperty = <T extends Record<any, any> = never>(
 		return {} as EnumTypes<never>;
 	}
 
-	const enums: {
-		[EnumName: string]: {
-			values: () => string[];
-		};
-	} = {};
+	const enums: Record<
+		string,
+		{
+			values(): string[];
+		}
+	> = {};
 
 	for (const [_, enumData] of Object.entries(modelIntrospection.enums)) {
 		enums[enumData.name] = {

package/src/internals/utils/{generateModelsProperty.ts → clientProperties/generateModelsProperty.ts}

@@ -1,23 +1,24 @@
 // 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 { V6Client, __authMode, __authToken } from '../../types';
-import { listFactory } from '../operations/list';
-import { indexQueryFactory } from '../operations/indexQuery';
-import { getFactory } from '../operations/get';
-import { subscriptionFactory } from '../operations/subscription';
-import { observeQueryFactory } from '../operations/observeQuery';
 import {
-	ModelIntrospectionSchema,
 	GraphQLProviderConfig,
+	ModelIntrospectionSchema,
 } from '@aws-amplify/core/internals/utils';
-import { getSecondaryIndexesFromSchemaModel } from '../clientUtils';
+
+import { ModelOperation, graphQLOperationsInfo } from '../../APIClient';
+import { V6Client } from '../../../types';
+import { listFactory } from '../../operations/list';
+import { indexQueryFactory } from '../../operations/indexQuery';
+import { getFactory } from '../../operations/get';
+import { subscriptionFactory } from '../../operations/subscription';
+import { observeQueryFactory } from '../../operations/observeQuery';
+import { getSecondaryIndexesFromSchemaModel } from '../../clientUtils';
 
 export function generateModelsProperty<T extends Record<any, any> = never>(
 	client: V6Client<Record<string, any>>,
 	apiGraphQLConfig: GraphQLProviderConfig['GraphQL'],
-): ModelTypes<T> {
+): ModelTypes<T> | ModelTypes<never> {
 	const models = {} as any;
 
 	const modelIntrospection: ModelIntrospectionSchema | undefined =

package/src/internals/utils/runtimeTypeGuards/isGraphQLResponseWithErrors.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { GraphQLResult } from '../../../types';
+
+export function isGraphQLResponseWithErrors(
+	response: unknown,
+): response is GraphQLResult {
+	if (!response) {
+		return false;
+	}
+	const r = response as GraphQLResult;
+
+	return Array.isArray(r.errors) && r.errors.length > 0;
+}

package/src/internals/v6.ts

@@ -1,15 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
+
 import { GraphQLAPI } from '../GraphQLAPI';
 import {
+	GraphQLOptionsV6,
+	GraphQLResponseV6,
+	V6Client,
 	__amplify,
 	__authMode,
 	__authToken,
-	V6Client,
-	GraphQLOptionsV6,
-	GraphQLResponseV6,
 } from '../types';
-import { CustomHeaders } from '@aws-amplify/data-schema-types';
 
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
@@ -117,6 +118,7 @@ export function graphql<
 		options,
 		additionalHeaders,
 	);
+
 	return result as any;
 }
 

package/src/server/generateClient.ts

@@ -5,6 +5,8 @@ import {
 	AmplifyServer,
 	getAmplifyServerContext,
 } from '@aws-amplify/core/internals/adapter-core';
+import { CustomHeaders } from '@aws-amplify/data-schema-types';
+
 import { generateClientWithAmplifyInstance } from '../internals/server';
 import {
 	GenerateServerClientParams,
@@ -14,7 +16,6 @@ import {
 	V6ClientSSRRequest,
 	__amplify,
 } from '../types';
-import { CustomHeaders } from '@aws-amplify/data-schema-types';
 
 /**
  * Generates an GraphQL API client that works with Amplify server context.
@@ -55,6 +56,7 @@ export function generateClient<T extends Record<any, any> = never>({
 		additionalHeaders?: CustomHeaders,
 	) => {
 		const amplifyInstance = getAmplifyServerContext(contextSpec).amplify;
+
 		return prevGraphql.call(
 			{ [__amplify]: amplifyInstance },
 			options,
@@ -63,5 +65,6 @@ export function generateClient<T extends Record<any, any> = never>({
 	};
 
 	client.graphql = wrappedGraphql as unknown as GraphQLMethodSSR;
+
 	return client;
 }

package/src/types/PubSub.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Observer } from 'rxjs';
+
 export interface SubscriptionObserver<T> {
 	closed: boolean;
 	next(value: T): void;

package/src/types/index.ts

@@ -2,20 +2,24 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6, ResourcesConfig } from '@aws-amplify/core';
 import {
-	ModelTypes,
 	CustomHeaders,
+	CustomMutations,
+	CustomQueries,
+	CustomSubscriptions,
 	EnumTypes,
+	ModelSortDirection,
+	ModelTypes,
 } from '@aws-amplify/data-schema-types';
-import { Source, DocumentNode, GraphQLError } from 'graphql';
-export { OperationTypeNode } from 'graphql';
+import { DocumentNode, GraphQLError, Source } from 'graphql';
 import { Observable } from 'rxjs';
-
 import {
-	GraphQLAuthMode,
 	DocumentType,
+	GraphQLAuthMode,
 } from '@aws-amplify/core/internals/utils';
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 
+export { OperationTypeNode } from 'graphql';
+
 export { CONTROL_MSG, ConnectionState } from './PubSub';
 
 export { SelectionSet } from '@aws-amplify/data-schema-types';
@@ -39,9 +43,7 @@ export interface GraphQLOptions {
 export interface GraphQLResult<T = object> {
 	data: T;
 	errors?: GraphQLError[];
-	extensions?: {
-		[key: string]: any;
-	};
+	extensions?: Record<string, any>;
 }
 
 // Opaque type used for determining the graphql query type
@@ -73,21 +75,22 @@ export type GraphQLSubscription<T> = T & {
  *
  * This util simply makes related model properties optional recursively.
  */
-export type GraphQLReturnType<T> = T extends {}
-	? {
-			[K in keyof T]?: GraphQLReturnType<T[K]>;
-		}
-	: T;
+export type GraphQLReturnType<T> =
+	T extends Record<string, unknown>
+		? {
+				[K in keyof T]?: GraphQLReturnType<T[K]>;
+			}
+		: T;
 
 /**
  * Describes a paged list result from AppSync, which can either
  * live at the top query or property (e.g., related model) level.
  */
-type PagedList<T, TYPENAME> = {
+interface PagedList<T, TYPENAME> {
 	__typename: TYPENAME;
 	nextToken?: string | null | undefined;
-	items: Array<T>;
-};
+	items: T[];
+}
 
 /**
  * Recursively looks through a result type and removes nulls and
@@ -100,7 +103,7 @@ type PagedList<T, TYPENAME> = {
 type WithListsFixed<T> =
 	T extends PagedList<infer IT, infer NAME>
 		? PagedList<Exclude<IT, null | undefined>, NAME>
-		: T extends {}
+		: T extends Record<string, unknown>
 			? {
 					[K in keyof T]: WithListsFixed<T[K]>;
 				}
@@ -167,9 +170,9 @@ export type GraphqlSubscriptionResult<T> = Observable<
  * })
  * ```
  */
-export type GraphqlSubscriptionMessage<T> = {
+export interface GraphqlSubscriptionMessage<T> {
 	data: T;
-};
+}
 
 export interface AWSAppSyncRealTimeProviderOptions {
 	appSyncGraphqlEndpoint?: string;
@@ -178,15 +181,15 @@ export interface AWSAppSyncRealTimeProviderOptions {
 	variables?: Record<string, unknown>;
 	apiKey?: string;
 	region?: string;
-	libraryConfigHeaders?: () => {} | (() => Promise<{}>);
+	libraryConfigHeaders?(): () => Promise<Record<string, unknown> | Headers>;
 	additionalHeaders?: CustomHeaders;
 }
 
-export type AWSAppSyncRealTimeProvider = {
+export interface AWSAppSyncRealTimeProvider {
 	subscribe(
 		options?: AWSAppSyncRealTimeProviderOptions,
 	): Observable<Record<string, unknown>>;
-};
+}
 
 export enum GraphQLAuthError {
 	NO_API_KEY = 'No api-key configured',
@@ -257,18 +260,18 @@ export type GraphQLResponseV6<
 	FALLBACK_TYPE = unknown,
 	TYPED_GQL_STRING extends string = string,
 > =
-	TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer QUERY_OUT>
+	TYPED_GQL_STRING extends GeneratedQuery<infer _, infer QUERY_OUT>
 		? Promise<GraphQLResult<FixedQueryResult<QUERY_OUT>>>
-		: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer MUTATION_OUT>
+		: TYPED_GQL_STRING extends GeneratedMutation<infer _, infer MUTATION_OUT>
 			? Promise<GraphQLResult<NeverEmpty<MUTATION_OUT>>>
-			: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer SUB_OUT>
+			: TYPED_GQL_STRING extends GeneratedSubscription<infer _, infer SUB_OUT>
 				? GraphqlSubscriptionResult<NeverEmpty<SUB_OUT>>
-				: FALLBACK_TYPE extends GraphQLQuery<infer T>
+				: FALLBACK_TYPE extends GraphQLQuery<infer _>
 					? Promise<GraphQLResult<FALLBACK_TYPE>>
-					: FALLBACK_TYPE extends GraphQLSubscription<infer T>
+					: FALLBACK_TYPE extends GraphQLSubscription<infer _>
 						? GraphqlSubscriptionResult<FALLBACK_TYPE>
 						: FALLBACK_TYPE extends GraphQLOperationType<
-									infer IN,
+									infer _,
 									infer CUSTOM_OUT
 							  >
 							? CUSTOM_OUT
@@ -292,10 +295,13 @@ export type GraphQLResponseV6<
  * })
  * ```
  */
-export type GraphQLOperationType<IN extends {}, OUT extends {}> = {
+export interface GraphQLOperationType<
+	IN extends Record<string, DocumentType>,
+	OUT extends Record<string, DocumentType>,
+> {
 	variables: IN;
 	result: OUT;
-};
+}
 
 /**
  * Nominal type for branding generated graphql query operation strings with
@@ -384,10 +390,13 @@ export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
 	[__authToken]?: string;
 	[__headers]?: CustomHeaders;
 	graphql: GraphQLMethod;
-	cancel: (promise: Promise<any>, message?: string) => boolean;
-	isCancelError: (error: any) => boolean;
+	cancel(promise: Promise<any>, message?: string): boolean;
+	isCancelError(error: any): boolean;
 	models: ModelTypes<T>;
 	enums: EnumTypes<T>;
+	queries: CustomQueries<T>;
+	mutations: CustomMutations<T>;
+	subscriptions: CustomSubscriptions<T>;
 }>;
 
 export type V6ClientSSRRequest<T extends Record<any, any> = never> =
@@ -397,9 +406,12 @@ export type V6ClientSSRRequest<T extends Record<any, any> = never> =
 		[__authToken]?: string;
 		[__headers]?: CustomHeaders;
 		graphql: GraphQLMethodSSR;
-		cancel: (promise: Promise<any>, message?: string) => boolean;
-		isCancelError: (error: any) => boolean;
+		cancel(promise: Promise<any>, message?: string): boolean;
+		isCancelError(error: any): boolean;
 		models: ModelTypes<T, 'REQUEST'>;
+		enums: EnumTypes<T>;
+		queries: CustomQueries<T, 'REQUEST'>;
+		mutations: CustomMutations<T, 'REQUEST'>;
 	}>;
 
 export type V6ClientSSRCookies<T extends Record<any, any> = never> =
@@ -409,9 +421,12 @@ export type V6ClientSSRCookies<T extends Record<any, any> = never> =
 		[__authToken]?: string;
 		[__headers]?: CustomHeaders;
 		graphql: GraphQLMethod;
-		cancel: (promise: Promise<any>, message?: string) => boolean;
-		isCancelError: (error: any) => boolean;
+		cancel(promise: Promise<any>, message?: string): boolean;
+		isCancelError(error: any): boolean;
 		models: ModelTypes<T, 'COOKIES'>;
+		enums: EnumTypes<T>;
+		queries: CustomQueries<T, 'COOKIES'>;
+		mutations: CustomMutations<T, 'COOKIES'>;
 	}>;
 
 export type GraphQLMethod = <
@@ -436,30 +451,31 @@ export type GraphQLMethodSSR = <
  *
  * The knobs available for configuring `server/generateClient` internally.
  */
-export type ServerClientGenerationParams = {
+export interface ServerClientGenerationParams {
 	amplify:
 		| null // null expected when used with `generateServerClient`
 		// closure expected with `generateServerClientUsingCookies`
 		| ((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 = {
+export interface ListArgs extends Record<string, unknown> {
 	selectionSet?: string[];
-	filter?: {};
+	filter?: Record<string, unknown>;
+	sortDirection?: ModelSortDirection;
 	headers?: CustomHeaders;
-};
+}
 
-export type AuthModeParams = {
+export interface AuthModeParams extends Record<string, unknown> {
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
-};
+}
 
-export type GenerateServerClientParams = {
+export interface GenerateServerClientParams {
 	config: ResourcesConfig;
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
-};
+}

package/src/utils/ConnectionStateMonitor.ts

@@ -1,19 +1,21 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Observable, Observer, SubscriptionLike, map, filter } from 'rxjs';
+import { Observable, Observer, SubscriptionLike, filter, map } from 'rxjs';
+
 import { ConnectionState } from '../types/PubSub';
+
 import { ReachabilityMonitor } from './ReachabilityMonitor';
 
 // Internal types for tracking different connection states
 type LinkedConnectionState = 'connected' | 'disconnected';
 type LinkedHealthState = 'healthy' | 'unhealthy';
-type LinkedConnectionStates = {
+interface LinkedConnectionStates {
 	networkState: LinkedConnectionState;
 	connectionState: LinkedConnectionState | 'connecting';
 	intendedConnectionState: LinkedConnectionState;
 	keepAliveState: LinkedHealthState;
-};
+}
 
 export const CONNECTION_CHANGE: {
 	[key in
@@ -53,6 +55,7 @@ export class ConnectionStateMonitor {
 	private _linkedConnectionStateObserver:
 		| Observer<LinkedConnectionStates>
 		| undefined;
+
 	private _networkMonitoringSubscription?: SubscriptionLike;
 	private _initialNetworkStateSubscription?: SubscriptionLike;
 
@@ -132,6 +135,7 @@ export class ConnectionStateMonitor {
 				filter(current => {
 					const toInclude = current !== previous;
 					previous = current;
+
 					return toInclude;
 				}),
 			);
@@ -196,6 +200,7 @@ export class ConnectionStateMonitor {
 		// All remaining states directly correspond to the connection state
 		if (connectionState === 'connecting') return ConnectionState.Connecting;
 		if (connectionState === 'disconnected') return ConnectionState.Disconnected;
+
 		return ConnectionState.Connected;
 	}
 }

package/src/utils/ReachabilityMonitor/index.native.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Reachability } from '@aws-amplify/core/internals/utils';
-import { default as NetInfo } from '@react-native-community/netinfo';
+import NetInfo from '@react-native-community/netinfo';
 
 export const ReachabilityMonitor = () =>
 	new Reachability().networkMonitor(NetInfo);

package/src/utils/ReachabilityMonitor/index.ts

@@ -1,4 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Reachability } from '@aws-amplify/core/internals/utils';
+
 export const ReachabilityMonitor = () => new Reachability().networkMonitor();

package/src/utils/ReconnectionMonitor.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Observer } from 'rxjs';
+
 import { RECONNECT_DELAY, RECONNECT_INTERVAL } from '../Providers/constants';
 
 export enum ReconnectEvent {

package/src/utils/errors/constants.ts

@@ -0,0 +1,56 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+
+import { GraphQLAuthError } from '../../types';
+
+export const NO_API_KEY: AmplifyErrorParams = {
+	name: 'NoApiKey',
+	// ideal: No API key configured.
+	message: GraphQLAuthError.NO_API_KEY,
+	recoverySuggestion:
+		'The API request was made with `authMode: "apiKey"` but no API Key was passed into `Amplify.configure()`. Review if your API key is passed into the `Amplify.configure()` function.',
+};
+
+export const NO_VALID_CREDENTIALS: AmplifyErrorParams = {
+	name: 'NoCredentials',
+	// ideal: No auth credentials available.
+	message: GraphQLAuthError.NO_CREDENTIALS,
+	recoverySuggestion: `The API request was made with \`authMode: "iam"\` but no authentication credentials are available.
+
+If you intended to make a request using an authenticated role, review if your user is signed in before making the request.
+
+If you intend to make a request using an unauthenticated role or also known as "guest access", verify if "Auth.Cognito.allowGuestAccess" is set to "true" in the \`Amplify.configure()\` function.`,
+};
+
+export const NO_VALID_AUTH_TOKEN: AmplifyErrorParams = {
+	name: 'NoValidAuthTokens',
+	// ideal: No valid JWT auth token provided to make the API request..
+	message: GraphQLAuthError.NO_FEDERATED_JWT,
+	recoverySuggestion:
+		'If you intended to make an authenticated API request, review if the current user is signed in.',
+};
+
+export const NO_SIGNED_IN_USER: AmplifyErrorParams = {
+	name: 'NoSignedUser',
+	// ideal: Couldn't retrieve authentication credentials to make the API request.
+	message: GraphQLAuthError.NO_CURRENT_USER,
+	recoverySuggestion:
+		'Review the underlying exception field for more details. If you intended to make an authenticated API request, review if the current user is signed in.',
+};
+
+export const NO_AUTH_TOKEN_HEADER: AmplifyErrorParams = {
+	name: 'NoAuthorizationHeader',
+	// ideal: Authorization header not specified.
+	message: GraphQLAuthError.NO_AUTH_TOKEN,
+	recoverySuggestion:
+		'The API request was made with `authMode: "lambda"` but no `authToken` is set. Review if a valid authToken is passed into the request options or in the `Amplify.configure()` function.',
+};
+
+export const NO_ENDPOINT: AmplifyErrorParams = {
+	name: 'NoEndpoint',
+	message: 'No GraphQL endpoint configured in `Amplify.configure()`.',
+	recoverySuggestion:
+		'Review if the GraphQL API endpoint is set in the `Amplify.configure()` function.',
+};

package/src/utils/errors/createGraphQLResultWithError.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { GraphQLError } from 'graphql';
+
+import { GraphQLResult } from '../../types';
+
+export const createGraphQLResultWithError = <T>(
+	error: Error,
+): GraphQLResult<T> => {
+	return {
+		data: {} as T,
+		errors: [new GraphQLError(error.message, null, null, null, null, error)],
+	};
+};

package/src/utils/errors/index.ts

@@ -4,3 +4,4 @@
 export { GraphQLApiError } from './GraphQLApiError';
 export { assertValidationError } from './assertValidationError';
 export { APIValidationErrorCode, validationErrorMap } from './validation';
+export { createGraphQLResultWithError } from './createGraphQLResultWithError';