@aws-amplify/api-rest 4.0.1-console-preview.b5a42af.0 → 4.0.1-console-preview.9607e4a.0

package/lib/utils/createCancellableOperation.js

@@ -6,40 +6,50 @@ exports.createCancellableOperation = void 0;
 var tslib_1 = require("tslib");
 var errors_1 = require("../errors");
 var serviceError_1 = require("./serviceError");
+var logger_1 = require("./logger");
 /**
  * @internal
  */
 function createCancellableOperation(handler, abortController) {
     var _this = this;
     var isInternalPost = function (handler) { return !!abortController; };
-    var signal = abortController === null || abortController === void 0 ? void 0 : abortController.signal;
+    // For creating a cancellable operation for public REST APIs, we need to create an AbortController
+    // internally. Whereas for internal POST APIs, we need to accept in the AbortController from the
+    // callers.
+    var publicApisAbortController = new AbortController();
+    var publicApisAbortSignal = publicApisAbortController.signal;
+    var internalPostAbortSignal = abortController === null || abortController === void 0 ? void 0 : abortController.signal;
     var job = function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-        var response, error_1;
+        var response, error_1, abortSignal, cancelledError;
         var _a;
         return tslib_1.__generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    _b.trys.push([0, 2, , 3]);
+                    _b.trys.push([0, 4, , 5]);
                     return [4 /*yield*/, (isInternalPost(handler)
                             ? handler()
-                            : handler(signal))];
+                            : handler(publicApisAbortSignal))];
                 case 1:
                     response = _b.sent();
-                    if (response.statusCode >= 300) {
-                        throw (0, serviceError_1.parseRestApiServiceError)(response);
-                    }
-                    return [2 /*return*/, response];
-                case 2:
+                    if (!(response.statusCode >= 300)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, (0, serviceError_1.parseRestApiServiceError)(response)];
+                case 2: throw _b.sent();
+                case 3: return [2 /*return*/, response];
+                case 4:
                     error_1 = _b.sent();
-                    if (error_1.name === 'AbortError' || (signal === null || signal === void 0 ? void 0 : signal.aborted) === true) {
-                        throw new errors_1.CancelledError({
+                    abortSignal = internalPostAbortSignal !== null && internalPostAbortSignal !== void 0 ? internalPostAbortSignal : publicApisAbortSignal;
+                    if (error_1.name === 'AbortError' || (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) === true) {
+                        cancelledError = new errors_1.CancelledError({
                             name: error_1.name,
-                            message: (_a = signal.reason) !== null && _a !== void 0 ? _a : error_1.message,
+                            message: (_a = abortSignal.reason) !== null && _a !== void 0 ? _a : error_1.message,
                             underlyingError: error_1,
                         });
+                        logger_1.logger.debug(error_1);
+                        throw cancelledError;
                     }
-                    throw new errors_1.RestApiError(tslib_1.__assign(tslib_1.__assign({}, error_1), { underlyingError: error_1 }));
-                case 3: return [2 /*return*/];
+                    logger_1.logger.debug(error_1);
+                    throw error_1;
+                case 5: return [2 /*return*/];
             }
         });
     }); };
@@ -48,15 +58,15 @@ function createCancellableOperation(handler, abortController) {
     }
     else {
         var cancel = function (abortMessage) {
-            if ((signal === null || signal === void 0 ? void 0 : signal.aborted) === true) {
+            if (publicApisAbortSignal.aborted === true) {
                 return;
             }
-            abortController === null || abortController === void 0 ? void 0 : abortController.abort(abortMessage);
+            publicApisAbortController.abort(abortMessage);
             // Abort reason is not widely support enough across runtimes and and browsers, so we set it
             // if it is not already set.
-            if ((signal === null || signal === void 0 ? void 0 : signal.reason) !== abortMessage) {
-                // @ts-expect-error reason is a readonly property
-                signal['reason'] = abortMessage;
+            if (publicApisAbortSignal.reason !== abortMessage) {
+                publicApisAbortSignal['reason'] =
+                    abortMessage;
             }
         };
         return { response: job(), cancel: cancel };

package/lib/utils/index.d.ts

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

package/lib/utils/index.js

@@ -2,12 +2,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseRestApiServiceError = exports.parseUrl = exports.resolveCredentials = exports.createCancellableOperation = void 0;
+exports.logger = exports.resolveApiUrl = exports.parseRestApiServiceError = exports.parseSigningInfo = exports.resolveCredentials = exports.createCancellableOperation = void 0;
 var createCancellableOperation_1 = require("./createCancellableOperation");
 Object.defineProperty(exports, "createCancellableOperation", { enumerable: true, get: function () { return createCancellableOperation_1.createCancellableOperation; } });
 var resolveCredentials_1 = require("./resolveCredentials");
 Object.defineProperty(exports, "resolveCredentials", { enumerable: true, get: function () { return resolveCredentials_1.resolveCredentials; } });
-var parseUrl_1 = require("./parseUrl");
-Object.defineProperty(exports, "parseUrl", { enumerable: true, get: function () { return parseUrl_1.parseUrl; } });
+var parseSigningInfo_1 = require("./parseSigningInfo");
+Object.defineProperty(exports, "parseSigningInfo", { enumerable: true, get: function () { return parseSigningInfo_1.parseSigningInfo; } });
 var serviceError_1 = require("./serviceError");
 Object.defineProperty(exports, "parseRestApiServiceError", { enumerable: true, get: function () { return serviceError_1.parseRestApiServiceError; } });
+var resolveApiUrl_1 = require("./resolveApiUrl");
+Object.defineProperty(exports, "resolveApiUrl", { enumerable: true, get: function () { return resolveApiUrl_1.resolveApiUrl; } });
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });

package/lib/utils/index.native.d.ts

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

package/lib/utils/index.native.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.resolveApiUrl = exports.parseRestApiServiceError = exports.parseSigningInfo = exports.resolveCredentials = exports.createCancellableOperation = void 0;
+var react_native_1 = require("@aws-amplify/react-native");
+(0, react_native_1.loadUrlPolyfill)();
+var createCancellableOperation_1 = require("./createCancellableOperation");
+Object.defineProperty(exports, "createCancellableOperation", { enumerable: true, get: function () { return createCancellableOperation_1.createCancellableOperation; } });
+var resolveCredentials_1 = require("./resolveCredentials");
+Object.defineProperty(exports, "resolveCredentials", { enumerable: true, get: function () { return resolveCredentials_1.resolveCredentials; } });
+var parseSigningInfo_1 = require("./parseSigningInfo");
+Object.defineProperty(exports, "parseSigningInfo", { enumerable: true, get: function () { return parseSigningInfo_1.parseSigningInfo; } });
+var serviceError_1 = require("./serviceError");
+Object.defineProperty(exports, "parseRestApiServiceError", { enumerable: true, get: function () { return serviceError_1.parseRestApiServiceError; } });
+var resolveApiUrl_1 = require("./resolveApiUrl");
+Object.defineProperty(exports, "resolveApiUrl", { enumerable: true, get: function () { return resolveApiUrl_1.resolveApiUrl; } });
+var logger_1 = require("./logger");
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });

package/lib/utils/logger.d.ts

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

package/lib/utils/logger.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+var utils_1 = require("@aws-amplify/core/internals/utils");
+exports.logger = new utils_1.Logger('RestApis');

package/lib/utils/normalizeHeaders.d.ts

@@ -1 +1 @@
-export declare const normalizeHeaders: (headers: Record<string, string>) => Record<string, string>;
+export declare const normalizeHeaders: (headers?: Record<string, string>) => Record<string, string>;

package/lib/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/lib/utils/parseSigningInfo.js

@@ -0,0 +1,42 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSigningInfo = void 0;
+var tslib_1 = require("tslib");
+var constants_1 = require("./constants");
+/**
+ * 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
+ */
+var parseSigningInfo = function (url, restApiOptions) {
+    var _a, _b, _c, _d, _e;
+    var _f = (_d = (_c = (_b = (_a = restApiOptions === null || restApiOptions === void 0 ? void 0 : restApiOptions.amplify.getConfig()) === null || _a === void 0 ? void 0 : _a.API) === null || _b === void 0 ? void 0 : _b.REST) === null || _c === void 0 ? void 0 : _c[restApiOptions === null || restApiOptions === void 0 ? void 0 : restApiOptions.apiName]) !== null && _d !== void 0 ? _d : {}, _g = _f.service, signingService = _g === void 0 ? constants_1.DEFAULT_REST_IAM_SIGNING_SERVICE : _g, _h = _f.region, signingRegion = _h === void 0 ? constants_1.DEFAULT_IAM_SIGNING_REGION : _h;
+    var hostname = url.hostname;
+    var _j = tslib_1.__read((_e = constants_1.APIG_HOSTNAME_PATTERN.exec(hostname)) !== null && _e !== void 0 ? _e : [], 3), service = _j[1], region = _j[2];
+    if (service === constants_1.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: service,
+            region: region !== null && region !== void 0 ? 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 !== null && region !== void 0 ? region : signingRegion,
+        };
+    }
+    else {
+        return {
+            service: signingService,
+            region: signingRegion,
+        };
+    }
+};
+exports.parseSigningInfo = parseSigningInfo;

package/lib/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/lib/utils/resolveApiUrl.js

@@ -0,0 +1,38 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveApiUrl = void 0;
+var tslib_1 = require("tslib");
+var errors_1 = require("../errors");
+/**
+ * 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
+ */
+var resolveApiUrl = function (amplify, apiName, path, queryParams) {
+    var _a, _b, _c, _d;
+    var urlStr = (_d = (_c = (_b = (_a = amplify.getConfig()) === null || _a === void 0 ? void 0 : _a.API) === null || _b === void 0 ? void 0 : _b.REST) === null || _c === void 0 ? void 0 : _c[apiName]) === null || _d === void 0 ? void 0 : _d.endpoint;
+    (0, errors_1.assertValidationError)(!!urlStr, errors_1.RestApiValidationErrorCode.InvalidApiName);
+    try {
+        var url = new URL(urlStr + path);
+        if (queryParams) {
+            var mergedQueryParams_1 = new URLSearchParams(url.searchParams);
+            Object.entries(queryParams).forEach(function (_a) {
+                var _b = tslib_1.__read(_a, 2), key = _b[0], value = _b[1];
+                mergedQueryParams_1.set(key, value);
+            });
+            url.search = new URLSearchParams(mergedQueryParams_1).toString();
+        }
+        return url;
+    }
+    catch (error) {
+        throw new errors_1.RestApiError(tslib_1.__assign(tslib_1.__assign({ name: errors_1.RestApiValidationErrorCode.InvalidApiName }, errors_1.validationErrorMap[errors_1.RestApiValidationErrorCode.InvalidApiName]), { recoverySuggestion: "Please make sure the REST endpoint URL is a valid URL string. Got ".concat(urlStr) }));
+    }
+};
+exports.resolveApiUrl = resolveApiUrl;

package/lib/utils/resolveCredentials.d.ts

@@ -5,6 +5,6 @@ import { AmplifyClassV6 } from '@aws-amplify/core';
 export declare const resolveCredentials: (amplify: AmplifyClassV6) => Promise<{
     accessKeyId: string;
     secretAccessKey: string;
-    sessionToken?: string;
-    expiration?: Date;
+    sessionToken?: string | undefined;
+    expiration?: Date | undefined;
 }>;

package/lib/utils/resolveCredentials.js

@@ -15,7 +15,7 @@ var resolveCredentials = function (amplify) { return tslib_1.__awaiter(void 0, v
             case 0: return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
             case 1:
                 credentials = (_a.sent()).credentials;
-                (0, errors_1.assertValidationError)(!!credentials, errors_1.RestApiValidationErrorCode.NoCredentials);
+                (0, errors_1.assertValidationError)(!!credentials && !!credentials.accessKeyId && !!credentials.secretAccessKey, errors_1.RestApiValidationErrorCode.NoCredentials);
                 return [2 /*return*/, credentials];
         }
     });

package/lib/utils/serviceError.d.ts

@@ -7,4 +7,4 @@ import { RestApiError } from '../errors';
  * @internal
  */
 export declare const buildRestApiServiceError: (error: Error) => RestApiError;
-export declare const parseRestApiServiceError: (response?: HttpResponse) => Promise<RestApiError & MetadataBearer>;
+export declare const parseRestApiServiceError: (response?: HttpResponse) => Promise<(RestApiError & MetadataBearer) | undefined>;

package/lib/utils/serviceError.js

@@ -11,7 +11,7 @@ var errors_1 = require("../errors");
  */
 var buildRestApiServiceError = function (error) {
     var restApiError = new errors_1.RestApiError({
-        name: error.name,
+        name: error === null || error === void 0 ? void 0 : error.name,
         message: error.message,
         underlyingError: error,
     });
@@ -25,11 +25,13 @@ var parseRestApiServiceError = function (response) { return tslib_1.__awaiter(vo
             case 0: return [4 /*yield*/, (0, aws_client_utils_1.parseJsonError)(response)];
             case 1:
                 parsedError = _a.sent();
-                return [2 /*return*/, parsedError
-                        ? Object.assign((0, exports.buildRestApiServiceError)(parsedError), {
-                            $metadata: parsedError.$metadata,
-                        })
-                        : undefined];
+                if (!parsedError) {
+                    // Response is not an error.
+                    return [2 /*return*/];
+                }
+                return [2 /*return*/, Object.assign((0, exports.buildRestApiServiceError)(parsedError), {
+                        $metadata: parsedError.$metadata,
+                    })];
         }
     });
 }); };

package/lib-esm/{common → apis/common}/handler.d.ts

@@ -1,6 +1,7 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
 import { HttpRequest, Headers } from '@aws-amplify/core/internals/aws-client-utils';
 import { DocumentType } from '@aws-amplify/core/internals/utils';
+import { RestApiResponse } from '../../types';
 type HandlerOptions = Omit<HttpRequest, 'body' | 'headers'> & {
     body?: DocumentType | FormData;
     headers?: Headers;
@@ -15,17 +16,16 @@ type SigningServiceInfo = {
  * @param amplify Amplify instance to to resolve credentials and tokens. Should use different instance in client-side
  *   and SSR
  * @param options Options accepted from public API options when calling the handlers.
- * @param signingServiceInfo Internal-only options for graphql client to overwrite the IAM signing service and region.
- *   MUST ONLY be used by internal post method consumed by GraphQL when auth mode is IAM. Otherwise IAM auth may not be
- *   used.
+ * @param signingServiceInfo Internal-only options enable IAM auth as well as to to overwrite the IAM signing service
+ *   and region. If specified, and NONE of API Key header or Auth header is present, IAM auth will be used.
  *
  * @internal
  */
 export declare const transferHandler: (amplify: AmplifyClassV6, options: Omit<HttpRequest, "body" | "headers"> & {
-    body?: DocumentType | FormData;
-    headers?: Headers;
-    withCredentials?: boolean;
+    body?: FormData | DocumentType | undefined;
+    headers?: Headers | undefined;
+    withCredentials?: boolean | undefined;
 } & {
     abortSignal: AbortSignal;
-}, signingServiceInfo?: SigningServiceInfo) => Promise<import("@aws-amplify/core/internals/aws-client-utils").HttpResponse>;
+}, signingServiceInfo?: SigningServiceInfo) => Promise<RestApiResponse>;
 export {};

package/lib-esm/{common → apis/common}/handler.js

@@ -1,15 +1,14 @@
 import { __assign, __awaiter, __generator } from "tslib";
 import { unauthenticatedHandler, getRetryDecider, jitteredBackoff, authenticatedHandler, } from '@aws-amplify/core/internals/aws-client-utils';
-import { parseRestApiServiceError, parseUrl, resolveCredentials, } from '../utils';
-import { normalizeHeaders } from '../utils/normalizeHeaders';
+import { parseRestApiServiceError, parseSigningInfo, resolveCredentials, } from '../../utils';
+import { normalizeHeaders } from '../../utils/normalizeHeaders';
 /**
  * Make REST API call with best-effort IAM auth.
  * @param amplify Amplify instance to to resolve credentials and tokens. Should use different instance in client-side
  *   and SSR
  * @param options Options accepted from public API options when calling the handlers.
- * @param signingServiceInfo Internal-only options for graphql client to overwrite the IAM signing service and region.
- *   MUST ONLY be used by internal post method consumed by GraphQL when auth mode is IAM. Otherwise IAM auth may not be
- *   used.
+ * @param signingServiceInfo Internal-only options enable IAM auth as well as to to overwrite the IAM signing service
+ *   and region. If specified, and NONE of API Key header or Auth header is present, IAM auth will be used.
  *
  * @internal
  */
@@ -46,7 +45,7 @@ export var transferHandler = function (amplify, options, signingServiceInfo) { r
                 };
                 isIamAuthApplicable = iamAuthApplicable(request, signingServiceInfo);
                 if (!isIamAuthApplicable) return [3 /*break*/, 3];
-                signingInfoFromUrl = parseUrl(url);
+                signingInfoFromUrl = parseSigningInfo(url);
                 signingService = (_a = signingServiceInfo === null || signingServiceInfo === void 0 ? void 0 : signingServiceInfo.service) !== null && _a !== void 0 ? _a : signingInfoFromUrl.service;
                 signingRegion = (_b = signingServiceInfo === null || signingServiceInfo === void 0 ? void 0 : signingServiceInfo.region) !== null && _b !== void 0 ? _b : signingInfoFromUrl.region;
                 return [4 /*yield*/, resolveCredentials(amplify)];

package/{lib → lib-esm/apis}/common/internalPost.d.ts

@@ -1,5 +1,5 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
-import { InternalPostInput, RestApiResponse } from '../types';
+import { InternalPostInput, RestApiResponse } from '../../types';
 /**
  * @internal
  */

package/lib-esm/{common → apis/common}/internalPost.js

@@ -2,7 +2,18 @@
 // SPDX-License-Identifier: Apache-2.0
 import { __assign, __awaiter, __generator } from "tslib";
 import { transferHandler } from './handler';
-import { createCancellableOperation } from '../utils';
+import { createCancellableOperation } from '../../utils';
+/**
+ * This weak map provides functionality to cancel a request given the promise containing the `post` request.
+ *
+ * 1. For every GraphQL POST request, an abort controller is created and supplied to the request.
+ * 2. The promise fulfilled by GraphGL POST request is then mapped to that abort controller.
+ * 3. The promise is returned to the external caller.
+ * 4. The caller can either wait for the promise to fulfill or call `cancel(promise)` to cancel the request.
+ * 5. If `cancel(promise)` is called, then the corresponding abort controller is retrieved from the map below.
+ * 6. GraphQL POST request will be rejected with the error message provided during cancel.
+ * 7. Caller can check if the error is because of cancelling by calling `isCancelError(error)`.
+ */
 var cancelTokenMap = new WeakMap();
 /**
  * @internal

package/lib-esm/apis/common/publicApis.d.ts

@@ -0,0 +1,8 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+import { GetInput, GetOperation, PostInput, PostOperation, PutInput, PutOperation, DeleteInput, DeleteOperation, HeadInput, HeadOperation, PatchInput, PatchOperation } from '../../types';
+export declare const get: (amplify: AmplifyClassV6, input: GetInput) => GetOperation;
+export declare const post: (amplify: AmplifyClassV6, input: PostInput) => PostOperation;
+export declare const put: (amplify: AmplifyClassV6, input: PutInput) => PutOperation;
+export declare const del: (amplify: AmplifyClassV6, input: DeleteInput) => DeleteOperation;
+export declare const head: (amplify: AmplifyClassV6, input: HeadInput) => HeadOperation;
+export declare const patch: (amplify: AmplifyClassV6, input: PatchInput) => PatchOperation;

package/lib-esm/apis/common/publicApis.js

@@ -0,0 +1,41 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign, __awaiter, __generator } from "tslib";
+import { resolveApiUrl, createCancellableOperation, logger, parseSigningInfo, } from '../../utils';
+import { transferHandler } from './handler';
+var publicHandler = function (amplify, options, method) {
+    return createCancellableOperation(function (abortSignal) { return __awaiter(void 0, void 0, void 0, function () {
+        var apiName, _a, apiOptions, apiPath, url, libraryOptionsHeaders, _b, invocationHeaders, headers, signingServiceInfo;
+        var _c, _d, _e, _f;
+        return __generator(this, function (_g) {
+            switch (_g.label) {
+                case 0:
+                    apiName = options.apiName, _a = options.options, apiOptions = _a === void 0 ? {} : _a, apiPath = options.path;
+                    url = resolveApiUrl(amplify, apiName, apiPath, apiOptions === null || apiOptions === void 0 ? void 0 : apiOptions.queryParams);
+                    return [4 /*yield*/, ((_f = (_e = (_d = (_c = amplify.libraryOptions) === null || _c === void 0 ? void 0 : _c.API) === null || _d === void 0 ? void 0 : _d.REST) === null || _e === void 0 ? void 0 : _e.headers) === null || _f === void 0 ? void 0 : _f.call(_e, {
+                            apiName: apiName,
+                        }))];
+                case 1:
+                    libraryOptionsHeaders = _g.sent();
+                    _b = apiOptions.headers, invocationHeaders = _b === void 0 ? {} : _b;
+                    headers = __assign(__assign({}, libraryOptionsHeaders), invocationHeaders);
+                    signingServiceInfo = parseSigningInfo(url, {
+                        amplify: amplify,
+                        apiName: apiName,
+                    });
+                    logger.debug(method, url, headers, "IAM signing options: ".concat(JSON.stringify(signingServiceInfo)));
+                    return [2 /*return*/, transferHandler(amplify, __assign(__assign({}, apiOptions), { url: url, method: method, headers: headers, abortSignal: abortSignal }), signingServiceInfo)];
+            }
+        });
+    }); });
+};
+export var get = function (amplify, input) {
+    return publicHandler(amplify, input, 'GET');
+};
+export var post = function (amplify, input) { return publicHandler(amplify, input, 'POST'); };
+export var put = function (amplify, input) {
+    return publicHandler(amplify, input, 'PUT');
+};
+export var del = function (amplify, input) { return publicHandler(amplify, input, 'DELETE'); };
+export var head = function (amplify, input) { return publicHandler(amplify, input, 'HEAD'); };
+export var patch = function (amplify, input) { return publicHandler(amplify, input, 'PATCH'); };

package/lib-esm/apis/index.d.ts

@@ -0,0 +1,25 @@
+import { DeleteInput, DeleteOperation, GetInput, GetOperation, HeadInput, HeadOperation, PatchInput, PatchOperation, PostInput, PostOperation, PutInput, PutOperation } from '../types';
+/**
+ * GET HTTP request
+ */
+export declare const get: (input: GetInput) => GetOperation;
+/**
+ * POST HTTP request
+ */
+export declare const post: (input: PostInput) => PostOperation;
+/**
+ * PUT HTTP request
+ */
+export declare const put: (input: PutInput) => PutOperation;
+/**
+ * DELETE HTTP request
+ */
+export declare const del: (input: DeleteInput) => DeleteOperation;
+/**
+ * HEAD HTTP request
+ */
+export declare const head: (input: HeadInput) => HeadOperation;
+/**
+ * PATCH HTTP request
+ */
+export declare const patch: (input: PatchInput) => PatchOperation;

package/lib-esm/apis/index.js

@@ -0,0 +1,36 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Amplify } from '@aws-amplify/core';
+import { get as commonGet, post as commonPost, put as commonPut, del as commonDel, head as commonHead, patch as commonPatch, } from './common/publicApis';
+/**
+ * GET HTTP request
+ */
+export var get = function (input) { return commonGet(Amplify, input); };
+/**
+ * POST HTTP request
+ */
+export var post = function (input) {
+    return commonPost(Amplify, input);
+};
+/**
+ * PUT HTTP request
+ */
+export var put = function (input) { return commonPut(Amplify, input); };
+/**
+ * DELETE HTTP request
+ */
+export var del = function (input) {
+    return commonDel(Amplify, input);
+};
+/**
+ * HEAD HTTP request
+ */
+export var head = function (input) {
+    return commonHead(Amplify, input);
+};
+/**
+ * PATCH HTTP request
+ */
+export var patch = function (input) {
+    return commonPatch(Amplify, input);
+};

package/lib-esm/apis/server.d.ts

@@ -0,0 +1,26 @@
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { DeleteInput, DeleteOperation, GetInput, GetOperation, HeadInput, HeadOperation, PatchInput, PatchOperation, PostInput, PostOperation, PutInput, PutOperation } from '../types';
+/**
+ * GET HTTP request (server-side)
+ */
+export declare const get: (contextSpec: AmplifyServer.ContextSpec, input: GetInput) => GetOperation;
+/**
+ * POST HTTP request (server-side)
+ */
+export declare const post: (contextSpec: AmplifyServer.ContextSpec, input: PostInput) => PostOperation;
+/**
+ * PUT HTTP request (server-side)
+ */
+export declare const put: (contextSpec: AmplifyServer.ContextSpec, input: PutInput) => PutOperation;
+/**
+ * DELETE HTTP request (server-side)
+ */
+export declare const del: (contextSpec: AmplifyServer.ContextSpec, input: DeleteInput) => DeleteOperation;
+/**
+ * HEAD HTTP request (server-side)
+ */
+export declare const head: (contextSpec: AmplifyServer.ContextSpec, input: HeadInput) => HeadOperation;
+/**
+ * PATCH HTTP request (server-side)
+ */
+export declare const patch: (contextSpec: AmplifyServer.ContextSpec, input: PatchInput) => PatchOperation;

package/lib-esm/apis/server.js

@@ -0,0 +1,40 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';
+import { get as commonGet, post as commonPost, put as commonPut, del as commonDel, head as commonHead, patch as commonPatch, } from './common/publicApis';
+/**
+ * GET HTTP request (server-side)
+ */
+export var get = function (contextSpec, input) {
+    return commonGet(getAmplifyServerContext(contextSpec).amplify, input);
+};
+/**
+ * POST HTTP request (server-side)
+ */
+export var post = function (contextSpec, input) {
+    return commonPost(getAmplifyServerContext(contextSpec).amplify, input);
+};
+/**
+ * PUT HTTP request (server-side)
+ */
+export var put = function (contextSpec, input) {
+    return commonPut(getAmplifyServerContext(contextSpec).amplify, input);
+};
+/**
+ * DELETE HTTP request (server-side)
+ */
+export var del = function (contextSpec, input) {
+    return commonDel(getAmplifyServerContext(contextSpec).amplify, input);
+};
+/**
+ * HEAD HTTP request (server-side)
+ */
+export var head = function (contextSpec, input) {
+    return commonHead(getAmplifyServerContext(contextSpec).amplify, input);
+};
+/**
+ * PATCH HTTP request (server-side)
+ */
+export var patch = function (contextSpec, input) {
+    return commonPatch(getAmplifyServerContext(contextSpec).amplify, input);
+};

package/lib-esm/errors/validation.d.ts

@@ -1,5 +1,6 @@
 import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
 export declare enum RestApiValidationErrorCode {
-    NoCredentials = "NoCredentials"
+    NoCredentials = "NoCredentials",
+    InvalidApiName = "InvalidApiName"
 }
 export declare const validationErrorMap: AmplifyErrorMap<RestApiValidationErrorCode>;

package/lib-esm/errors/validation.js

@@ -4,9 +4,14 @@ var _a;
 export var RestApiValidationErrorCode;
 (function (RestApiValidationErrorCode) {
     RestApiValidationErrorCode["NoCredentials"] = "NoCredentials";
+    RestApiValidationErrorCode["InvalidApiName"] = "InvalidApiName";
 })(RestApiValidationErrorCode || (RestApiValidationErrorCode = {}));
 export var validationErrorMap = (_a = {},
     _a[RestApiValidationErrorCode.NoCredentials] = {
         message: 'Credentials should not be empty.',
     },
+    _a[RestApiValidationErrorCode.InvalidApiName] = {
+        message: 'API name is invalid.',
+        recoverySuggestion: 'Check if the API name matches the one in your configuration or `aws-exports.js`',
+    },
     _a);