@aws-amplify/api-rest 0.0.0-unstable-1ca644b-20260128091132

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

@@ -0,0 +1,122 @@
+import { DocumentType, RESTAuthMode, RetryStrategy } from '@aws-amplify/core/internals/utils';
+export type GetInput = ApiInput<RestApiOptionsBase>;
+export type PostInput = ApiInput<RestApiOptionsBase>;
+export type PutInput = ApiInput<RestApiOptionsBase>;
+export type PatchInput = ApiInput<RestApiOptionsBase>;
+export type DeleteInput = ApiInput<RestApiOptionsBase>;
+export type HeadInput = ApiInput<Omit<RestApiOptionsBase, 'body'>>;
+export type GetOperation = Operation<RestApiResponse>;
+export type PostOperation = Operation<RestApiResponse>;
+export type PutOperation = Operation<RestApiResponse>;
+export type PatchOperation = Operation<RestApiResponse>;
+export type DeleteOperation = Operation<RestApiResponse>;
+export type HeadOperation = Operation<Omit<RestApiResponse, 'body'>>;
+/**
+ * @internal
+ */
+export interface RestApiOptionsBase {
+    headers?: Headers;
+    queryParams?: Record<string, string>;
+    body?: DocumentType | FormData;
+    /**
+     * Option controls whether or not cross-site Access-Control requests should be made using credentials
+     * such as cookies, authorization headers or TLS client certificates. It has no effect on same-origin requests.
+     * If set to `true`, the request will include credentials such as cookies, authorization headers, TLS
+     * client certificates, and so on. Moreover the response cookies will also be set.
+     * If set to `false`, the cross-site request will not include credentials, and the response cookies from a different
+     * domain will be ignored.
+     *
+     * @default false
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials}
+     */
+    withCredentials?: boolean;
+    /**
+     * Retry strategy for the REST API calls. It will take precedence over REST `retryStrategy` in Amplify configuration libraryOptions.
+     *
+     * @default ` { strategy: 'jittered-exponential-backoff' } `
+     */
+    retryStrategy?: RetryStrategy;
+    defaultAuthMode?: RESTAuthMode;
+    /**
+     * custom timeout in milliseconds.
+     */
+    timeout?: number;
+}
+type Headers = Record<string, string>;
+/**
+ * Type representing an operation that can be canceled.
+ *
+ * @internal
+ */
+export interface Operation<Response> {
+    response: Promise<Response>;
+    cancel(abortMessage?: string): void;
+}
+interface ResponsePayload {
+    blob(): Promise<Blob>;
+    json(): Promise<DocumentType>;
+    text(): Promise<string>;
+}
+/**
+ * Basic response type of REST API.
+ *
+ * @internal
+ */
+export interface RestApiResponse {
+    body: ResponsePayload;
+    statusCode: number;
+    headers: Headers;
+}
+/**
+ * @internal
+ */
+export interface ApiInput<Options> {
+    /**
+     * Name of the REST API configured in Amplify singleton.
+     */
+    apiName: string;
+    /**
+     * Path of the REST API.
+     */
+    path: string;
+    /**
+     * Options to overwrite the REST API call behavior.
+     */
+    options?: Options;
+}
+/**
+ * Input type to invoke REST POST API from GraphQl client.
+ * @internal
+ */
+export interface InternalPostInput {
+    url: URL;
+    options?: Omit<RestApiOptionsBase, 'retryStrategy'> & {
+        /**
+         * Internal-only option for GraphQL client to provide the IAM signing service and region.
+         * * If auth mode is 'iam', you MUST set this value.
+         * * If auth mode is 'none', you MUST NOT set this value;
+         * * If auth mode is 'apiKey' or 'oidc' or 'lambda' or 'userPool' because associated
+         *   headers are provided, this value is ignored.
+         */
+        signingServiceInfo?: {
+            service?: string;
+            region?: string;
+        };
+    };
+    /**
+     * The abort controller to cancel the in-flight POST request.
+     * Required if you want to make the internal post request cancellable. To make the internal post cancellable, you
+     * must also call `updateRequestToBeCancellable()` with the promise from internal post call and the abort
+     * controller.
+     */
+    abortController?: AbortController;
+}
+/**
+ * Type for signingServiceInfo which enable IAM auth as well as overwrite the IAM signing info.
+ * @internal
+ */
+export interface SigningServiceInfo {
+    service?: string;
+    region?: string;
+}
+export {};

package/dist/esm/types/index.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/esm/utils/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_REST_IAM_SIGNING_SERVICE = "execute-api";
+export declare const DEFAULT_APPSYNC_API_SERVICE = "appsync-api";
+export declare const DEFAULT_IAM_SIGNING_REGION = "us-east-1";
+/**
+ * The REST endpoints generated by API Gateway
+ * @see {@link https://docs.aws.amazon.com/general/latest/gr/apigateway.html#apigateway_region_data_plane}
+ */
+export declare const APIG_HOSTNAME_PATTERN: RegExp;

package/dist/esm/utils/constants.mjs

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+const DEFAULT_REST_IAM_SIGNING_SERVICE = 'execute-api';
+const DEFAULT_APPSYNC_API_SERVICE = 'appsync-api';
+const DEFAULT_IAM_SIGNING_REGION = 'us-east-1';
+/**
+ * The REST endpoints generated by API Gateway
+ * @see {@link https://docs.aws.amazon.com/general/latest/gr/apigateway.html#apigateway_region_data_plane}
+ */
+const APIG_HOSTNAME_PATTERN = /^.+\.([a-z0-9-]+)\.([a-z0-9-]+)\.amazonaws\.com/;
+
+export { APIG_HOSTNAME_PATTERN, DEFAULT_APPSYNC_API_SERVICE, DEFAULT_IAM_SIGNING_REGION, DEFAULT_REST_IAM_SIGNING_SERVICE };
+//# sourceMappingURL=constants.mjs.map

package/dist/esm/utils/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sources":["../../../src/utils/constants.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport const DEFAULT_REST_IAM_SIGNING_SERVICE = 'execute-api';\nexport const DEFAULT_APPSYNC_API_SERVICE = 'appsync-api';\nexport const DEFAULT_IAM_SIGNING_REGION = 'us-east-1';\n/**\n * The REST endpoints generated by API Gateway\n * @see {@link https://docs.aws.amazon.com/general/latest/gr/apigateway.html#apigateway_region_data_plane}\n */\nexport const APIG_HOSTNAME_PATTERN = /^.+\\.([a-z0-9-]+)\\.([a-z0-9-]+)\\.amazonaws\\.com/;\n"],"names":[],"mappings":"AAAA;AACA;AACY,MAAC,gCAAgC,GAAG;AACpC,MAAC,2BAA2B,GAAG;AAC/B,MAAC,0BAA0B,GAAG;AAC1C;AACA;AACA;AACA;AACY,MAAC,qBAAqB,GAAG;;;;"}

package/dist/esm/utils/createCancellableOperation.d.ts

@@ -0,0 +1,12 @@
+import { HttpResponse } from '@aws-amplify/core/internals/aws-client-utils';
+import { Operation } from '../types';
+/**
+ * Create a cancellable operation conforming to the internal POST API interface.
+ * @internal
+ */
+export declare function createCancellableOperation(handler: () => Promise<HttpResponse>, abortController: AbortController, operationType: 'internal', timeout?: number): Promise<HttpResponse>;
+/**
+ * Create a cancellable operation conforming to the external REST API interface.
+ * @internal
+ */
+export declare function createCancellableOperation(handler: () => Promise<HttpResponse>, abortController: AbortController, operationType: 'public', timeout?: number): Operation<HttpResponse>;

package/dist/esm/utils/createCancellableOperation.mjs

@@ -0,0 +1,77 @@
+import { CanceledError } from '../errors/CanceledError.mjs';
+import '@aws-amplify/core/internals/utils';
+import '../errors/validation.mjs';
+import { parseRestApiServiceError } from './serviceError.mjs';
+import { logger } from './logger.mjs';
+
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @internal
+ */
+function createCancellableOperation(handler, abortController, operationType, timeout) {
+    const abortSignal = abortController.signal;
+    let abortReason;
+    if (timeout != null) {
+        if (timeout < 0) {
+            throw new Error('Timeout must be a non-negative number');
+        }
+        setTimeout(() => {
+            abortReason = 'TimeoutError';
+            abortController.abort(abortReason);
+        }, timeout);
+    }
+    const job = async () => {
+        try {
+            const response = await handler();
+            if (response.statusCode >= 300) {
+                throw await parseRestApiServiceError(response);
+            }
+            return response;
+        }
+        catch (error) {
+            if (error.name === 'AbortError' || abortSignal?.aborted === true) {
+                // Check if timeout caused the abort
+                const isTimeout = abortReason && abortReason === 'TimeoutError';
+                if (isTimeout) {
+                    const timeoutError = new Error(`Request timeout after ${timeout}ms`);
+                    timeoutError.name = 'TimeoutError';
+                    logger.debug(timeoutError);
+                    throw timeoutError;
+                }
+                else {
+                    const message = abortReason ?? abortSignal.reason;
+                    const canceledError = new CanceledError({
+                        ...(message && { message }),
+                        underlyingError: error,
+                        recoverySuggestion: 'The API request was explicitly canceled. If this is not intended, validate if you called the `cancel()` function on the API request erroneously.',
+                    });
+                    logger.debug(canceledError);
+                    throw canceledError;
+                }
+            }
+            logger.debug(error);
+            throw error;
+        }
+    };
+    if (operationType === 'internal') {
+        return job();
+    }
+    else {
+        const cancel = (abortMessage) => {
+            if (abortSignal.aborted === true) {
+                return;
+            }
+            abortController.abort(abortMessage);
+            // If abort reason is not supported, set a scoped reasons instead. The reason property inside an
+            // AbortSignal is a readonly property and trying to set it would throw an error.
+            if (abortMessage && abortSignal.reason !== abortMessage) {
+                abortReason = abortMessage;
+            }
+        };
+        return { response: job(), cancel };
+    }
+}
+
+export { createCancellableOperation };
+//# sourceMappingURL=createCancellableOperation.mjs.map

package/dist/esm/utils/createCancellableOperation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createCancellableOperation.mjs","sources":["../../../src/utils/createCancellableOperation.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { CanceledError } from '../errors';\nimport { parseRestApiServiceError } from './serviceError';\nimport { logger } from './logger';\n/**\n * @internal\n */\nexport function createCancellableOperation(handler, abortController, operationType, timeout) {\n    const abortSignal = abortController.signal;\n    let abortReason;\n    if (timeout != null) {\n        if (timeout < 0) {\n            throw new Error('Timeout must be a non-negative number');\n        }\n        setTimeout(() => {\n            abortReason = 'TimeoutError';\n            abortController.abort(abortReason);\n        }, timeout);\n    }\n    const job = async () => {\n        try {\n            const response = await handler();\n            if (response.statusCode >= 300) {\n                throw await parseRestApiServiceError(response);\n            }\n            return response;\n        }\n        catch (error) {\n            if (error.name === 'AbortError' || abortSignal?.aborted === true) {\n                // Check if timeout caused the abort\n                const isTimeout = abortReason && abortReason === 'TimeoutError';\n                if (isTimeout) {\n                    const timeoutError = new Error(`Request timeout after ${timeout}ms`);\n                    timeoutError.name = 'TimeoutError';\n                    logger.debug(timeoutError);\n                    throw timeoutError;\n                }\n                else {\n                    const message = abortReason ?? abortSignal.reason;\n                    const canceledError = new CanceledError({\n                        ...(message && { message }),\n                        underlyingError: error,\n                        recoverySuggestion: 'The API request was explicitly canceled. If this is not intended, validate if you called the `cancel()` function on the API request erroneously.',\n                    });\n                    logger.debug(canceledError);\n                    throw canceledError;\n                }\n            }\n            logger.debug(error);\n            throw error;\n        }\n    };\n    if (operationType === 'internal') {\n        return job();\n    }\n    else {\n        const cancel = (abortMessage) => {\n            if (abortSignal.aborted === true) {\n                return;\n            }\n            abortController.abort(abortMessage);\n            // If abort reason is not supported, set a scoped reasons instead. The reason property inside an\n            // AbortSignal is a readonly property and trying to set it would throw an error.\n            if (abortMessage && abortSignal.reason !== abortMessage) {\n                abortReason = abortMessage;\n            }\n        };\n        return { response: job(), cancel };\n    }\n}\n"],"names":[],"mappings":";;;;;;AAAA;AACA;AAIA;AACA;AACA;AACO,SAAS,0BAA0B,CAAC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,OAAO,EAAE;AAC7F,IAAI,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM;AAC9C,IAAI,IAAI,WAAW;AACnB,IAAI,IAAI,OAAO,IAAI,IAAI,EAAE;AACzB,QAAQ,IAAI,OAAO,GAAG,CAAC,EAAE;AACzB,YAAY,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC;AACpE,QAAQ;AACR,QAAQ,UAAU,CAAC,MAAM;AACzB,YAAY,WAAW,GAAG,cAAc;AACxC,YAAY,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;AAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;AACnB,IAAI;AACJ,IAAI,MAAM,GAAG,GAAG,YAAY;AAC5B,QAAQ,IAAI;AACZ,YAAY,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE;AAC5C,YAAY,IAAI,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE;AAC5C,gBAAgB,MAAM,MAAM,wBAAwB,CAAC,QAAQ,CAAC;AAC9D,YAAY;AACZ,YAAY,OAAO,QAAQ;AAC3B,QAAQ;AACR,QAAQ,OAAO,KAAK,EAAE;AACtB,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,IAAI,WAAW,EAAE,OAAO,KAAK,IAAI,EAAE;AAC9E;AACA,gBAAgB,MAAM,SAAS,GAAG,WAAW,IAAI,WAAW,KAAK,cAAc;AAC/E,gBAAgB,IAAI,SAAS,EAAE;AAC/B,oBAAoB,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;AACxF,oBAAoB,YAAY,CAAC,IAAI,GAAG,cAAc;AACtD,oBAAoB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC;AAC9C,oBAAoB,MAAM,YAAY;AACtC,gBAAgB;AAChB,qBAAqB;AACrB,oBAAoB,MAAM,OAAO,GAAG,WAAW,IAAI,WAAW,CAAC,MAAM;AACrE,oBAAoB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC;AAC5D,wBAAwB,IAAI,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;AACnD,wBAAwB,eAAe,EAAE,KAAK;AAC9C,wBAAwB,kBAAkB,EAAE,kJAAkJ;AAC9L,qBAAqB,CAAC;AACtB,oBAAoB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC;AAC/C,oBAAoB,MAAM,aAAa;AACvC,gBAAgB;AAChB,YAAY;AACZ,YAAY,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;AAC/B,YAAY,MAAM,KAAK;AACvB,QAAQ;AACR,IAAI,CAAC;AACL,IAAI,IAAI,aAAa,KAAK,UAAU,EAAE;AACtC,QAAQ,OAAO,GAAG,EAAE;AACpB,IAAI;AACJ,SAAS;AACT,QAAQ,MAAM,MAAM,GAAG,CAAC,YAAY,KAAK;AACzC,YAAY,IAAI,WAAW,CAAC,OAAO,KAAK,IAAI,EAAE;AAC9C,gBAAgB;AAChB,YAAY;AACZ,YAAY,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC;AAC/C;AACA;AACA,YAAY,IAAI,YAAY,IAAI,WAAW,CAAC,MAAM,KAAK,YAAY,EAAE;AACrE,gBAAgB,WAAW,GAAG,YAAY;AAC1C,YAAY;AACZ,QAAQ,CAAC;AACT,QAAQ,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE;AAC1C,IAAI;AACJ;;;;"}

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

@@ -0,0 +1,6 @@
+export { createCancellableOperation } from './createCancellableOperation';
+export { parseSigningInfo } from './parseSigningInfo';
+export { parseRestApiServiceError } from './serviceError';
+export { resolveApiUrl } from './resolveApiUrl';
+export { resolveLibraryOptions } from './resolveLibraryOptions';
+export { logger } from './logger';

package/dist/esm/utils/index.mjs

@@ -0,0 +1,7 @@
+export { createCancellableOperation } from './createCancellableOperation.mjs';
+export { parseSigningInfo } from './parseSigningInfo.mjs';
+export { parseRestApiServiceError } from './serviceError.mjs';
+export { resolveApiUrl } from './resolveApiUrl.mjs';
+export { resolveLibraryOptions } from './resolveLibraryOptions.mjs';
+export { logger } from './logger.mjs';
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/esm/utils/isIamAuthApplicable.d.ts

@@ -0,0 +1,32 @@
+import { HttpRequest } from '@aws-amplify/core/internals/aws-client-utils';
+import { SigningServiceInfo } from '../types';
+/**
+ * Determines if IAM authentication should be applied for a GraphQL request.
+ *
+ * This function checks the `headers` of the HTTP request to determine if IAM authentication
+ * is applicable. IAM authentication is considered applicable if there is no `authorization`
+ * header, no `x-api-key` header, and `signingServiceInfo` is provided.
+ *
+ * @param request - The HTTP request object containing headers.
+ * @param signingServiceInfo - Optional signing service information,
+ * including service and region.
+ * @returns A boolean `true` if IAM authentication should be applied.
+ *
+ * @internal
+ */
+export declare const isIamAuthApplicableForGraphQL: ({ headers }: HttpRequest, signingServiceInfo?: SigningServiceInfo) => boolean;
+/**
+ * Determines if IAM authentication should be applied for a REST request.
+ *
+ * This function checks the `headers` of the HTTP request to determine if IAM authentication
+ * is applicable. IAM authentication is considered applicable if there is no `authorization`
+ * header and `signingServiceInfo` is provided.
+ *
+ * @param request - The HTTP request object containing headers.
+ * @param signingServiceInfo - Optional signing service information,
+ * including service and region.
+ * @returns A boolean `true` if IAM authentication should be applied.
+ *
+ * @internal
+ */
+export declare const isIamAuthApplicableForRest: ({ headers }: HttpRequest, signingServiceInfo?: SigningServiceInfo) => boolean;

package/dist/esm/utils/isIamAuthApplicable.mjs

@@ -0,0 +1,35 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Determines if IAM authentication should be applied for a GraphQL request.
+ *
+ * This function checks the `headers` of the HTTP request to determine if IAM authentication
+ * is applicable. IAM authentication is considered applicable if there is no `authorization`
+ * header, no `x-api-key` header, and `signingServiceInfo` is provided.
+ *
+ * @param request - The HTTP request object containing headers.
+ * @param signingServiceInfo - Optional signing service information,
+ * including service and region.
+ * @returns A boolean `true` if IAM authentication should be applied.
+ *
+ * @internal
+ */
+const isIamAuthApplicableForGraphQL = ({ headers }, signingServiceInfo) => !headers.authorization && !headers['x-api-key'] && !!signingServiceInfo;
+/**
+ * Determines if IAM authentication should be applied for a REST request.
+ *
+ * This function checks the `headers` of the HTTP request to determine if IAM authentication
+ * is applicable. IAM authentication is considered applicable if there is no `authorization`
+ * header and `signingServiceInfo` is provided.
+ *
+ * @param request - The HTTP request object containing headers.
+ * @param signingServiceInfo - Optional signing service information,
+ * including service and region.
+ * @returns A boolean `true` if IAM authentication should be applied.
+ *
+ * @internal
+ */
+const isIamAuthApplicableForRest = ({ headers }, signingServiceInfo) => !headers.authorization && !!signingServiceInfo;
+
+export { isIamAuthApplicableForGraphQL, isIamAuthApplicableForRest };
+//# sourceMappingURL=isIamAuthApplicable.mjs.map

package/dist/esm/utils/isIamAuthApplicable.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"isIamAuthApplicable.mjs","sources":["../../../src/utils/isIamAuthApplicable.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n/**\n * Determines if IAM authentication should be applied for a GraphQL request.\n *\n * This function checks the `headers` of the HTTP request to determine if IAM authentication\n * is applicable. IAM authentication is considered applicable if there is no `authorization`\n * header, no `x-api-key` header, and `signingServiceInfo` is provided.\n *\n * @param request - The HTTP request object containing headers.\n * @param signingServiceInfo - Optional signing service information,\n * including service and region.\n * @returns A boolean `true` if IAM authentication should be applied.\n *\n * @internal\n */\nexport const isIamAuthApplicableForGraphQL = ({ headers }, signingServiceInfo) => !headers.authorization && !headers['x-api-key'] && !!signingServiceInfo;\n/**\n * Determines if IAM authentication should be applied for a REST request.\n *\n * This function checks the `headers` of the HTTP request to determine if IAM authentication\n * is applicable. IAM authentication is considered applicable if there is no `authorization`\n * header and `signingServiceInfo` is provided.\n *\n * @param request - The HTTP request object containing headers.\n * @param signingServiceInfo - Optional signing service information,\n * including service and region.\n * @returns A boolean `true` if IAM authentication should be applied.\n *\n * @internal\n */\nexport const isIamAuthApplicableForRest = ({ headers }, signingServiceInfo) => !headers.authorization && !!signingServiceInfo;\n"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,6BAA6B,GAAG,CAAC,EAAE,OAAO,EAAE,EAAE,kBAAkB,KAAK,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AACvI;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,0BAA0B,GAAG,CAAC,EAAE,OAAO,EAAE,EAAE,kBAAkB,KAAK,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,CAAC;;;;"}

package/dist/esm/utils/logger.d.ts

@@ -0,0 +1,2 @@
+import { ConsoleLogger } from '@aws-amplify/core';
+export declare const logger: ConsoleLogger;

package/dist/esm/utils/logger.mjs

@@ -0,0 +1,8 @@
+import { ConsoleLogger } from '@aws-amplify/core';
+
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+const logger = new ConsoleLogger('RestApis');
+
+export { logger };
+//# sourceMappingURL=logger.mjs.map

package/dist/esm/utils/logger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.mjs","sources":["../../../src/utils/logger.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { ConsoleLogger } from '@aws-amplify/core';\nexport const logger = new ConsoleLogger('RestApis');\n"],"names":[],"mappings":";;AAAA;AACA;AAEY,MAAC,MAAM,GAAG,IAAI,aAAa,CAAC,UAAU;;;;"}

package/dist/esm/utils/parseSigningInfo.d.ts

@@ -0,0 +1,14 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+/**
+ * Infer the signing service and region from the given URL, and for REST API only, from the Amplify configuration.
+ * It supports raw API Gateway endpoint and AppSync endpoint.
+ *
+ * @internal
+ */
+export declare const parseSigningInfo: (url: URL, restApiOptions?: {
+    amplify: AmplifyClassV6;
+    apiName: string;
+}) => {
+    service: string;
+    region: string;
+};

package/dist/esm/utils/parseSigningInfo.mjs

@@ -0,0 +1,41 @@
+import { DEFAULT_IAM_SIGNING_REGION, DEFAULT_REST_IAM_SIGNING_SERVICE, APIG_HOSTNAME_PATTERN } from './constants.mjs';
+
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Infer the signing service and region from the given URL, and for REST API only, from the Amplify configuration.
+ * It supports raw API Gateway endpoint and AppSync endpoint.
+ *
+ * @internal
+ */
+const parseSigningInfo = (url, restApiOptions) => {
+    const { service: signingService = DEFAULT_REST_IAM_SIGNING_SERVICE, region: signingRegion = DEFAULT_IAM_SIGNING_REGION, } = restApiOptions?.amplify.getConfig()?.API?.REST?.[restApiOptions?.apiName] ??
+        {};
+    const { hostname } = url;
+    const [, service, region] = APIG_HOSTNAME_PATTERN.exec(hostname) ?? [];
+    if (service === DEFAULT_REST_IAM_SIGNING_SERVICE) {
+        // The configured endpoint is an API Gateway endpoint
+        // @see: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-call-api.html
+        return {
+            service,
+            region: region ?? signingRegion,
+        };
+    }
+    else if (service === 'appsync-api') {
+        // AppSync endpoint is internally supported because GraphQL operation will send request using POST handler.
+        // example: https://xxxx.appsync-api.us-east-1.amazonaws.com/graphql
+        return {
+            service: 'appsync',
+            region: region ?? signingRegion,
+        };
+    }
+    else {
+        return {
+            service: signingService,
+            region: signingRegion,
+        };
+    }
+};
+
+export { parseSigningInfo };
+//# sourceMappingURL=parseSigningInfo.mjs.map

package/dist/esm/utils/parseSigningInfo.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseSigningInfo.mjs","sources":["../../../src/utils/parseSigningInfo.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { APIG_HOSTNAME_PATTERN, DEFAULT_IAM_SIGNING_REGION, DEFAULT_REST_IAM_SIGNING_SERVICE, } from './constants';\n/**\n * Infer the signing service and region from the given URL, and for REST API only, from the Amplify configuration.\n * It supports raw API Gateway endpoint and AppSync endpoint.\n *\n * @internal\n */\nexport const parseSigningInfo = (url, restApiOptions) => {\n    const { service: signingService = DEFAULT_REST_IAM_SIGNING_SERVICE, region: signingRegion = DEFAULT_IAM_SIGNING_REGION, } = restApiOptions?.amplify.getConfig()?.API?.REST?.[restApiOptions?.apiName] ??\n        {};\n    const { hostname } = url;\n    const [, service, region] = APIG_HOSTNAME_PATTERN.exec(hostname) ?? [];\n    if (service === DEFAULT_REST_IAM_SIGNING_SERVICE) {\n        // The configured endpoint is an API Gateway endpoint\n        // @see: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-call-api.html\n        return {\n            service,\n            region: region ?? signingRegion,\n        };\n    }\n    else if (service === 'appsync-api') {\n        // AppSync endpoint is internally supported because GraphQL operation will send request using POST handler.\n        // example: https://xxxx.appsync-api.us-east-1.amazonaws.com/graphql\n        return {\n            service: 'appsync',\n            region: region ?? signingRegion,\n        };\n    }\n    else {\n        return {\n            service: signingService,\n            region: signingRegion,\n        };\n    }\n};\n"],"names":[],"mappings":";;AAAA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,gBAAgB,GAAG,CAAC,GAAG,EAAE,cAAc,KAAK;AACzD,IAAI,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,gCAAgC,EAAE,MAAM,EAAE,aAAa,GAAG,0BAA0B,GAAG,GAAG,cAAc,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,cAAc,EAAE,OAAO,CAAC;AACzM,QAAQ,EAAE;AACV,IAAI,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG;AAC5B,IAAI,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;AAC1E,IAAI,IAAI,OAAO,KAAK,gCAAgC,EAAE;AACtD;AACA;AACA,QAAQ,OAAO;AACf,YAAY,OAAO;AACnB,YAAY,MAAM,EAAE,MAAM,IAAI,aAAa;AAC3C,SAAS;AACT,IAAI;AACJ,SAAS,IAAI,OAAO,KAAK,aAAa,EAAE;AACxC;AACA;AACA,QAAQ,OAAO;AACf,YAAY,OAAO,EAAE,SAAS;AAC9B,YAAY,MAAM,EAAE,MAAM,IAAI,aAAa;AAC3C,SAAS;AACT,IAAI;AACJ,SAAS;AACT,QAAQ,OAAO;AACf,YAAY,OAAO,EAAE,cAAc;AACnC,YAAY,MAAM,EAAE,aAAa;AACjC,SAAS;AACT,IAAI;AACJ;;;;"}

package/dist/esm/utils/resolveApiUrl.d.ts

@@ -0,0 +1,12 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+/**
+ * Resolve the REST API request URL by:
+ * 1. Loading the REST API endpoint from the Amplify configuration with corresponding API name.
+ * 2. Appending the path to the endpoint.
+ * 3. Merge the query parameters from path and the queryParameter argument which is taken from the public REST API
+ *   options.
+ * 4. Validating the resulting URL string.
+ *
+ * @internal
+ */
+export declare const resolveApiUrl: (amplify: AmplifyClassV6, apiName: string, path: string, queryParams?: Record<string, string>) => URL;

package/dist/esm/utils/resolveApiUrl.mjs

@@ -0,0 +1,48 @@
+import { AmplifyUrl, AmplifyUrlSearchParams } from '@aws-amplify/core/internals/utils';
+import { RestApiError } from '../errors/RestApiError.mjs';
+import { assertValidationError } from '../errors/assertValidatonError.mjs';
+import { RestApiValidationErrorCode, validationErrorMap } from '../errors/validation.mjs';
+
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Resolve the REST API request URL by:
+ * 1. Loading the REST API endpoint from the Amplify configuration with corresponding API name.
+ * 2. Appending the path to the endpoint.
+ * 3. Merge the query parameters from path and the queryParameter argument which is taken from the public REST API
+ *   options.
+ * 4. Validating the resulting URL string.
+ *
+ * @internal
+ */
+const resolveApiUrl = (amplify, apiName, path, queryParams) => {
+    const urlStr = amplify.getConfig()?.API?.REST?.[apiName]?.endpoint;
+    assertValidationError(!!urlStr, RestApiValidationErrorCode.InvalidApiName);
+    try {
+        let url;
+        if (AmplifyUrl.canParse(urlStr + path)) {
+            url = new AmplifyUrl(urlStr + path);
+        }
+        else {
+            url = new AmplifyUrl(urlStr + path, location?.origin);
+        }
+        if (queryParams) {
+            const mergedQueryParams = new AmplifyUrlSearchParams(url.searchParams);
+            Object.entries(queryParams).forEach(([key, value]) => {
+                mergedQueryParams.set(key, value);
+            });
+            url.search = new AmplifyUrlSearchParams(mergedQueryParams).toString();
+        }
+        return url;
+    }
+    catch (error) {
+        throw new RestApiError({
+            name: RestApiValidationErrorCode.InvalidApiName,
+            ...validationErrorMap[RestApiValidationErrorCode.InvalidApiName],
+            recoverySuggestion: `Please make sure the REST endpoint URL is a valid URL string. Got ${urlStr}`,
+        });
+    }
+};
+
+export { resolveApiUrl };
+//# sourceMappingURL=resolveApiUrl.mjs.map

package/dist/esm/utils/resolveApiUrl.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveApiUrl.mjs","sources":["../../../src/utils/resolveApiUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { AmplifyUrl, AmplifyUrlSearchParams, } from '@aws-amplify/core/internals/utils';\nimport { RestApiError, RestApiValidationErrorCode, assertValidationError, validationErrorMap, } from '../errors';\n/**\n * Resolve the REST API request URL by:\n * 1. Loading the REST API endpoint from the Amplify configuration with corresponding API name.\n * 2. Appending the path to the endpoint.\n * 3. Merge the query parameters from path and the queryParameter argument which is taken from the public REST API\n *   options.\n * 4. Validating the resulting URL string.\n *\n * @internal\n */\nexport const resolveApiUrl = (amplify, apiName, path, queryParams) => {\n    const urlStr = amplify.getConfig()?.API?.REST?.[apiName]?.endpoint;\n    assertValidationError(!!urlStr, RestApiValidationErrorCode.InvalidApiName);\n    try {\n        let url;\n        if (AmplifyUrl.canParse(urlStr + path)) {\n            url = new AmplifyUrl(urlStr + path);\n        }\n        else {\n            url = new AmplifyUrl(urlStr + path, location?.origin);\n        }\n        if (queryParams) {\n            const mergedQueryParams = new AmplifyUrlSearchParams(url.searchParams);\n            Object.entries(queryParams).forEach(([key, value]) => {\n                mergedQueryParams.set(key, value);\n            });\n            url.search = new AmplifyUrlSearchParams(mergedQueryParams).toString();\n        }\n        return url;\n    }\n    catch (error) {\n        throw new RestApiError({\n            name: RestApiValidationErrorCode.InvalidApiName,\n            ...validationErrorMap[RestApiValidationErrorCode.InvalidApiName],\n            recoverySuggestion: `Please make sure the REST endpoint URL is a valid URL string. Got ${urlStr}`,\n        });\n    }\n};\n"],"names":[],"mappings":";;;;;AAAA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,aAAa,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,KAAK;AACtE,IAAI,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,EAAE,QAAQ;AACtE,IAAI,qBAAqB,CAAC,CAAC,CAAC,MAAM,EAAE,0BAA0B,CAAC,cAAc,CAAC;AAC9E,IAAI,IAAI;AACR,QAAQ,IAAI,GAAG;AACf,QAAQ,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE;AAChD,YAAY,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;AAC/C,QAAQ;AACR,aAAa;AACb,YAAY,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC;AACjE,QAAQ;AACR,QAAQ,IAAI,WAAW,EAAE;AACzB,YAAY,MAAM,iBAAiB,GAAG,IAAI,sBAAsB,CAAC,GAAG,CAAC,YAAY,CAAC;AAClF,YAAY,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK;AAClE,gBAAgB,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC;AACjD,YAAY,CAAC,CAAC;AACd,YAAY,GAAG,CAAC,MAAM,GAAG,IAAI,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;AACjF,QAAQ;AACR,QAAQ,OAAO,GAAG;AAClB,IAAI;AACJ,IAAI,OAAO,KAAK,EAAE;AAClB,QAAQ,MAAM,IAAI,YAAY,CAAC;AAC/B,YAAY,IAAI,EAAE,0BAA0B,CAAC,cAAc;AAC3D,YAAY,GAAG,kBAAkB,CAAC,0BAA0B,CAAC,cAAc,CAAC;AAC5E,YAAY,kBAAkB,EAAE,CAAC,kEAAkE,EAAE,MAAM,CAAC,CAAC;AAC7G,SAAS,CAAC;AACV,IAAI;AACJ;;;;"}

package/dist/esm/utils/resolveHeaders.d.ts

@@ -0,0 +1 @@
+export declare const resolveHeaders: (headers?: Record<string, string>, body?: unknown) => Record<string, string>;

package/dist/esm/utils/resolveHeaders.mjs

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+const resolveHeaders = (headers, body) => {
+    const normalizedHeaders = {};
+    for (const key in headers) {
+        normalizedHeaders[key.toLowerCase()] = headers[key];
+    }
+    if (body) {
+        const contentType = normalizedHeaders['content-type'];
+        const isJsonCompatible = contentType &&
+            (contentType.startsWith('application/json') ||
+                (contentType.startsWith('application/') &&
+                    contentType.includes('+json')));
+        if (!isJsonCompatible) {
+            normalizedHeaders['content-type'] = 'application/json; charset=UTF-8';
+        }
+        if (body instanceof FormData) {
+            /**
+             * If body is a FormData we should not allow setting content-type.
+             * It's because runtime HTTP handlers(xhr, fetch, undici, node-fetch,
+             * etc.) will modify the content-type value when setting multipart
+             * boundary.
+             */
+            delete normalizedHeaders['content-type'];
+        }
+    }
+    return normalizedHeaders;
+};
+
+export { resolveHeaders };
+//# sourceMappingURL=resolveHeaders.mjs.map

package/dist/esm/utils/resolveHeaders.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveHeaders.mjs","sources":["../../../src/utils/resolveHeaders.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport const resolveHeaders = (headers, body) => {\n    const normalizedHeaders = {};\n    for (const key in headers) {\n        normalizedHeaders[key.toLowerCase()] = headers[key];\n    }\n    if (body) {\n        const contentType = normalizedHeaders['content-type'];\n        const isJsonCompatible = contentType &&\n            (contentType.startsWith('application/json') ||\n                (contentType.startsWith('application/') &&\n                    contentType.includes('+json')));\n        if (!isJsonCompatible) {\n            normalizedHeaders['content-type'] = 'application/json; charset=UTF-8';\n        }\n        if (body instanceof FormData) {\n            /**\n             * If body is a FormData we should not allow setting content-type.\n             * It's because runtime HTTP handlers(xhr, fetch, undici, node-fetch,\n             * etc.) will modify the content-type value when setting multipart\n             * boundary.\n             */\n            delete normalizedHeaders['content-type'];\n        }\n    }\n    return normalizedHeaders;\n};\n"],"names":[],"mappings":"AAAA;AACA;AACY,MAAC,cAAc,GAAG,CAAC,OAAO,EAAE,IAAI,KAAK;AACjD,IAAI,MAAM,iBAAiB,GAAG,EAAE;AAChC,IAAI,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;AAC/B,QAAQ,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;AAC3D,IAAI;AACJ,IAAI,IAAI,IAAI,EAAE;AACd,QAAQ,MAAM,WAAW,GAAG,iBAAiB,CAAC,cAAc,CAAC;AAC7D,QAAQ,MAAM,gBAAgB,GAAG,WAAW;AAC5C,aAAa,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC;AACvD,iBAAiB,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC;AACvD,oBAAoB,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AACnD,QAAQ,IAAI,CAAC,gBAAgB,EAAE;AAC/B,YAAY,iBAAiB,CAAC,cAAc,CAAC,GAAG,iCAAiC;AACjF,QAAQ;AACR,QAAQ,IAAI,IAAI,YAAY,QAAQ,EAAE;AACtC;AACA;AACA;AACA;AACA;AACA;AACA,YAAY,OAAO,iBAAiB,CAAC,cAAc,CAAC;AACpD,QAAQ;AACR,IAAI;AACJ,IAAI,OAAO,iBAAiB;AAC5B;;;;"}

package/dist/esm/utils/resolveLibraryOptions.d.ts

@@ -0,0 +1,8 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+/**
+ * @internal
+ */
+export declare const resolveLibraryOptions: (amplify: AmplifyClassV6) => {
+    retryStrategy: import("@aws-amplify/core/internals/utils").RetryStrategy | undefined;
+    defaultAuthMode: import("@aws-amplify/core/internals/utils").RESTAuthMode | undefined;
+};

package/dist/esm/utils/resolveLibraryOptions.mjs

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @internal
+ */
+const resolveLibraryOptions = (amplify) => {
+    const retryStrategy = amplify.libraryOptions?.API?.REST?.retryStrategy;
+    const defaultAuthMode = amplify.libraryOptions?.API?.REST?.defaultAuthMode;
+    return { retryStrategy, defaultAuthMode };
+};
+
+export { resolveLibraryOptions };
+//# sourceMappingURL=resolveLibraryOptions.mjs.map

package/dist/esm/utils/resolveLibraryOptions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveLibraryOptions.mjs","sources":["../../../src/utils/resolveLibraryOptions.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n/**\n * @internal\n */\nexport const resolveLibraryOptions = (amplify) => {\n    const retryStrategy = amplify.libraryOptions?.API?.REST?.retryStrategy;\n    const defaultAuthMode = amplify.libraryOptions?.API?.REST?.defaultAuthMode;\n    return { retryStrategy, defaultAuthMode };\n};\n"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACY,MAAC,qBAAqB,GAAG,CAAC,OAAO,KAAK;AAClD,IAAI,MAAM,aAAa,GAAG,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa;AAC1E,IAAI,MAAM,eAAe,GAAG,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,eAAe;AAC9E,IAAI,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE;AAC7C;;;;"}

package/dist/esm/utils/serviceError.d.ts

@@ -0,0 +1,13 @@
+import { MetadataBearer } from '@aws-sdk/types';
+import { HttpResponse } from '@aws-amplify/core/internals/aws-client-utils';
+import { RestApiError } from '../errors';
+/**
+ * Parses both AWS and non-AWS error responses coming from the users' backend code.
+ * * AWS errors generated by the AWS services(e.g. API Gateway, Bedrock). They can be Signature errors,
+ *   ClockSkew errors, etc. These responses will be parsed to errors with proper name and message from the AWS
+ *   services.
+ * * non-AWS errors thrown by the user code. They can contain any headers or body. Users need to access the
+ *   error.response to get the headers and body and parse them accordingly. The JS error name and message will
+ *   be `UnknownError` and `Unknown error` respectively.
+ */
+export declare const parseRestApiServiceError: (response?: HttpResponse) => Promise<(RestApiError & MetadataBearer) | undefined>;