@aws-amplify/api-graphql 4.0.26 → 4.0.27-unstable.68a9f28.0

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';

package/src/utils/errors/repackageAuthError.ts

@@ -1,23 +1,21 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
-
-interface ErrorObject {
-	errors: AmplifyErrorParams[];
-}
+import { GraphQLResult } from '../../types';
 
 /**
  * Checks to see if the given response or subscription message contains an
- * unauth error. If it does, it changes the error message to include instructions
+ * Unauthorized error. If it does, it changes the error message to include instructions
  * for the app developer.
  */
-export function repackageUnauthError<T extends ErrorObject>(content: T): T {
+export function repackageUnauthorizedError<T extends GraphQLResult<any>>(
+	content: T,
+): T {
 	if (content.errors && Array.isArray(content.errors)) {
 		content.errors.forEach(e => {
-			if (isUnauthError(e)) {
+			if (isUnauthorizedError(e)) {
 				e.message = 'Unauthorized';
-				e.recoverySuggestion =
+				(e as any).recoverySuggestion =
 					`If you're calling an Amplify-generated API, make sure ` +
 					`to set the "authMode" in generateClient({ authMode: '...' }) to the backend authorization ` +
 					`rule's auth provider ('apiKey', 'userPool', 'iam', 'oidc', 'lambda')`;
@@ -28,7 +26,7 @@ export function repackageUnauthError<T extends ErrorObject>(content: T): T {
 	return content;
 }
 
-function isUnauthError(error: any): boolean {
+function isUnauthorizedError(error: any): boolean {
 	// Error pattern corresponding to appsync calls
 	if (error?.originalError?.name?.startsWith('UnauthorizedException')) {
 		return true;