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

package/lib/common/handler.d.ts

@@ -0,0 +1,31 @@
+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';
+type HandlerOptions = Omit<HttpRequest, 'body' | 'headers'> & {
+    body?: DocumentType | FormData;
+    headers?: Headers;
+    withCredentials?: boolean;
+};
+type SigningServiceInfo = {
+    service?: string;
+    region?: string;
+};
+/**
+ * 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.
+ *
+ * @internal
+ */
+export declare const transferHandler: (amplify: AmplifyClassV6, options: Omit<HttpRequest, "body" | "headers"> & {
+    body?: DocumentType | FormData;
+    headers?: Headers;
+    withCredentials?: boolean;
+} & {
+    abortSignal: AbortSignal;
+}, signingServiceInfo?: SigningServiceInfo) => Promise<import("@aws-amplify/core/internals/aws-client-utils").HttpResponse>;
+export {};

package/lib/common/handler.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transferHandler = void 0;
+var tslib_1 = require("tslib");
+var aws_client_utils_1 = require("@aws-amplify/core/internals/aws-client-utils");
+var utils_1 = require("../utils");
+var normalizeHeaders_1 = require("../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.
+ *
+ * @internal
+ */
+var transferHandler = function (amplify, options, signingServiceInfo) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+    var url, method, headers, body, withCredentials, abortSignal, resolvedBody, resolvedHeaders, request, baseOptions, isIamAuthApplicable, signingInfoFromUrl, signingService, signingRegion, credentials;
+    var _a, _b;
+    return tslib_1.__generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                url = options.url, method = options.method, headers = options.headers, body = options.body, withCredentials = options.withCredentials, abortSignal = options.abortSignal;
+                resolvedBody = body
+                    ? body instanceof FormData
+                        ? body
+                        : JSON.stringify(body !== null && body !== void 0 ? body : '')
+                    : undefined;
+                resolvedHeaders = tslib_1.__assign(tslib_1.__assign({}, (0, normalizeHeaders_1.normalizeHeaders)(headers)), (resolvedBody
+                    ? {
+                        'content-type': body instanceof FormData
+                            ? 'multipart/form-data'
+                            : 'application/json; charset=UTF-8',
+                    }
+                    : {}));
+                request = {
+                    url: url,
+                    headers: resolvedHeaders,
+                    method: method,
+                    body: resolvedBody,
+                };
+                baseOptions = {
+                    retryDecider: (0, aws_client_utils_1.getRetryDecider)(utils_1.parseRestApiServiceError),
+                    computeDelay: aws_client_utils_1.jitteredBackoff,
+                    withCrossDomainCredentials: withCredentials,
+                    abortSignal: abortSignal,
+                };
+                isIamAuthApplicable = iamAuthApplicable(request, signingServiceInfo);
+                if (!isIamAuthApplicable) return [3 /*break*/, 3];
+                signingInfoFromUrl = (0, utils_1.parseUrl)(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*/, (0, utils_1.resolveCredentials)(amplify)];
+            case 1:
+                credentials = _c.sent();
+                return [4 /*yield*/, (0, aws_client_utils_1.authenticatedHandler)(request, tslib_1.__assign(tslib_1.__assign({}, baseOptions), { credentials: credentials, region: signingRegion, service: signingService }))];
+            case 2: return [2 /*return*/, _c.sent()];
+            case 3: return [4 /*yield*/, (0, aws_client_utils_1.unauthenticatedHandler)(request, tslib_1.__assign({}, baseOptions))];
+            case 4: return [2 /*return*/, _c.sent()];
+        }
+    });
+}); };
+exports.transferHandler = transferHandler;
+var iamAuthApplicable = function (_a, signingServiceInfo) {
+    var headers = _a.headers;
+    return !headers.authorization && !headers['x-api-key'] && !!signingServiceInfo;
+};

package/lib/common/internalPost.d.ts

@@ -0,0 +1,16 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+import { InternalPostInput, RestApiResponse } from '../types';
+/**
+ * @internal
+ */
+export declare const post: (amplify: AmplifyClassV6, { url, options, abortController }: InternalPostInput) => Promise<RestApiResponse>;
+/**
+ * Cancels a request given the promise returned by `post`.
+ * If the request is already completed, this function does nothing.
+ * It MUST be used after `updateRequestToBeCancellable` is called.
+ */
+export declare const cancel: (promise: Promise<RestApiResponse>, message?: string) => boolean;
+/**
+ * MUST be used to make a promise including internal `post` API call cancellable.
+ */
+export declare const updateRequestToBeCancellable: (promise: Promise<any>, controller: AbortController) => void;

package/lib/common/internalPost.js

@@ -0,0 +1,54 @@
+"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.updateRequestToBeCancellable = exports.cancel = exports.post = void 0;
+var tslib_1 = require("tslib");
+var handler_1 = require("./handler");
+var utils_1 = require("../utils");
+var cancelTokenMap = new WeakMap();
+/**
+ * @internal
+ */
+var post = function (amplify, _a) {
+    var url = _a.url, options = _a.options, abortController = _a.abortController;
+    var controller = abortController !== null && abortController !== void 0 ? abortController : new AbortController();
+    var responsePromise = (0, utils_1.createCancellableOperation)(function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return tslib_1.__generator(this, function (_a) {
+            response = (0, handler_1.transferHandler)(amplify, tslib_1.__assign(tslib_1.__assign({ url: url, method: 'POST' }, options), { abortSignal: controller.signal }), options === null || options === void 0 ? void 0 : options.signingServiceInfo);
+            return [2 /*return*/, response];
+        });
+    }); }, controller);
+    var responseWithCleanUp = responsePromise.finally(function () {
+        cancelTokenMap.delete(responseWithCleanUp);
+    });
+    return responseWithCleanUp;
+};
+exports.post = post;
+/**
+ * Cancels a request given the promise returned by `post`.
+ * If the request is already completed, this function does nothing.
+ * It MUST be used after `updateRequestToBeCancellable` is called.
+ */
+var cancel = function (promise, message) {
+    var controller = cancelTokenMap.get(promise);
+    if (controller) {
+        controller.abort(message);
+        if (controller.signal.reason !== message) {
+            // In runtimes where `AbortSignal.reason` is not supported, we track the reason ourselves.
+            // @ts-expect-error reason is read-only property.
+            controller.signal['reason'] = message;
+        }
+        return true;
+    }
+    return false;
+};
+exports.cancel = cancel;
+/**
+ * MUST be used to make a promise including internal `post` API call cancellable.
+ */
+var updateRequestToBeCancellable = function (promise, controller) {
+    cancelTokenMap.set(promise, controller);
+};
+exports.updateRequestToBeCancellable = updateRequestToBeCancellable;

package/lib/errors/CancelledError.d.ts

@@ -0,0 +1,14 @@
+import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+import { RestApiError } from './RestApiError';
+/**
+ * Internal-only class for CancelledError.
+ *
+ * @internal
+ */
+export declare class CancelledError extends RestApiError {
+    constructor(params: AmplifyErrorParams);
+}
+/**
+ * Check if an error is caused by user calling `cancel()` REST API.
+ */
+export declare const isCancelError: (error: unknown) => boolean;

package/lib/errors/CancelledError.js

@@ -0,0 +1,31 @@
+"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.isCancelError = exports.CancelledError = void 0;
+var tslib_1 = require("tslib");
+var RestApiError_1 = require("./RestApiError");
+/**
+ * Internal-only class for CancelledError.
+ *
+ * @internal
+ */
+var CancelledError = /** @class */ (function (_super) {
+    tslib_1.__extends(CancelledError, _super);
+    function CancelledError(params) {
+        var _this = _super.call(this, params) || this;
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        _this.constructor = CancelledError;
+        Object.setPrototypeOf(_this, CancelledError.prototype);
+        return _this;
+    }
+    return CancelledError;
+}(RestApiError_1.RestApiError));
+exports.CancelledError = CancelledError;
+/**
+ * Check if an error is caused by user calling `cancel()` REST API.
+ */
+var isCancelError = function (error) {
+    return !!error && error instanceof CancelledError;
+};
+exports.isCancelError = isCancelError;

package/lib/errors/RestApiError.d.ts

@@ -0,0 +1,4 @@
+import { AmplifyError, AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+export declare class RestApiError extends AmplifyError {
+    constructor(params: AmplifyErrorParams);
+}

package/lib/errors/RestApiError.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.RestApiError = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("@aws-amplify/core/internals/utils");
+var RestApiError = /** @class */ (function (_super) {
+    tslib_1.__extends(RestApiError, _super);
+    function RestApiError(params) {
+        var _this = _super.call(this, params) || this;
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        _this.constructor = RestApiError;
+        Object.setPrototypeOf(_this, RestApiError.prototype);
+        return _this;
+    }
+    return RestApiError;
+}(utils_1.AmplifyError));
+exports.RestApiError = RestApiError;

package/lib/errors/assertValidatonError.d.ts

@@ -0,0 +1,5 @@
+import { RestApiValidationErrorCode } from './validation';
+/**
+ * @internal
+ */
+export declare function assertValidationError(assertion: boolean, name: RestApiValidationErrorCode): asserts assertion;

package/lib/errors/assertValidatonError.js

@@ -0,0 +1,17 @@
+"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.assertValidationError = void 0;
+var RestApiError_1 = require("./RestApiError");
+var validation_1 = require("./validation");
+/**
+ * @internal
+ */
+function assertValidationError(assertion, name) {
+    var _a = validation_1.validationErrorMap[name], message = _a.message, recoverySuggestion = _a.recoverySuggestion;
+    if (!assertion) {
+        throw new RestApiError_1.RestApiError({ name: name, message: message, recoverySuggestion: recoverySuggestion });
+    }
+}
+exports.assertValidationError = assertValidationError;

package/lib/errors/index.d.ts

@@ -0,0 +1,4 @@
+export { CancelledError, isCancelError } from './CancelledError';
+export { RestApiError } from './RestApiError';
+export { assertValidationError } from './assertValidatonError';
+export { RestApiValidationErrorCode, validationErrorMap } from './validation';

package/lib/errors/index.js

@@ -0,0 +1,15 @@
+"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.validationErrorMap = exports.RestApiValidationErrorCode = exports.assertValidationError = exports.RestApiError = exports.isCancelError = exports.CancelledError = void 0;
+var CancelledError_1 = require("./CancelledError");
+Object.defineProperty(exports, "CancelledError", { enumerable: true, get: function () { return CancelledError_1.CancelledError; } });
+Object.defineProperty(exports, "isCancelError", { enumerable: true, get: function () { return CancelledError_1.isCancelError; } });
+var RestApiError_1 = require("./RestApiError");
+Object.defineProperty(exports, "RestApiError", { enumerable: true, get: function () { return RestApiError_1.RestApiError; } });
+var assertValidatonError_1 = require("./assertValidatonError");
+Object.defineProperty(exports, "assertValidationError", { enumerable: true, get: function () { return assertValidatonError_1.assertValidationError; } });
+var validation_1 = require("./validation");
+Object.defineProperty(exports, "RestApiValidationErrorCode", { enumerable: true, get: function () { return validation_1.RestApiValidationErrorCode; } });
+Object.defineProperty(exports, "validationErrorMap", { enumerable: true, get: function () { return validation_1.validationErrorMap; } });

package/lib/errors/validation.d.ts

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

package/lib/errors/validation.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validationErrorMap = exports.RestApiValidationErrorCode = void 0;
+var RestApiValidationErrorCode;
+(function (RestApiValidationErrorCode) {
+    RestApiValidationErrorCode["NoCredentials"] = "NoCredentials";
+})(RestApiValidationErrorCode = exports.RestApiValidationErrorCode || (exports.RestApiValidationErrorCode = {}));
+exports.validationErrorMap = (_a = {},
+    _a[RestApiValidationErrorCode.NoCredentials] = {
+        message: 'Credentials should not be empty.',
+    },
+    _a);

package/lib/index.d.ts

@@ -1,2 +1 @@
-export { post, cancel, isCancel } from './API';
-export { DocumentType } from './types';
+export { isCancelError } from './errors/CancelledError';

package/lib/index.js

@@ -2,8 +2,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCancel = exports.cancel = exports.post = void 0;
-var API_1 = require("./API");
-Object.defineProperty(exports, "post", { enumerable: true, get: function () { return API_1.post; } });
-Object.defineProperty(exports, "cancel", { enumerable: true, get: function () { return API_1.cancel; } });
-Object.defineProperty(exports, "isCancel", { enumerable: true, get: function () { return API_1.isCancel; } });
+exports.isCancelError = void 0;
+var CancelledError_1 = require("./errors/CancelledError");
+Object.defineProperty(exports, "isCancelError", { enumerable: true, get: function () { return CancelledError_1.isCancelError; } });

package/lib/internals/index.d.ts

@@ -0,0 +1,19 @@
+import { InternalPostInput } from '../types';
+/**
+ * Internal-only REST POST handler to send GraphQL request to given endpoint. By default, it will use IAM to authorize
+ * the request. In some auth modes, the IAM auth has to be disabled. Here's how to set up the request auth correctly:
+ * * If auth mode is 'iam', you MUST NOT set 'authorization' header and 'x-api-key' header, since it would disable IAM
+ *   auth. You MUST also set 'input.options.signingServiceInfo' option.
+ *   * The including 'input.options.signingServiceInfo.service' and 'input.options.signingServiceInfo.region' are
+ *     optional. If omitted, the signing service and region will be inferred from url.
+ * * If auth mode is 'none', you MUST NOT set 'options.signingServiceInfo' option.
+ * * If auth mode is 'apiKey', you MUST set 'x-api-key' custom header.
+ * * If auth mode is 'oidc' or 'lambda' or 'userPool', you MUST set 'authorization' header.
+ *
+ * To make the internal post cancellable, you must also call `updateRequestToBeCancellable()` with the promise from
+ * internal post call and the abort controller supplied to the internal post call.
+ *
+ * @internal
+ */
+export declare const post: (input: InternalPostInput) => Promise<import("../types").RestApiResponse>;
+export { cancel, updateRequestToBeCancellable } from '../common/internalPost';

package/lib/internals/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateRequestToBeCancellable = exports.cancel = exports.post = void 0;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var core_1 = require("@aws-amplify/core");
+var internalPost_1 = require("../common/internalPost");
+/**
+ * Internal-only REST POST handler to send GraphQL request to given endpoint. By default, it will use IAM to authorize
+ * the request. In some auth modes, the IAM auth has to be disabled. Here's how to set up the request auth correctly:
+ * * If auth mode is 'iam', you MUST NOT set 'authorization' header and 'x-api-key' header, since it would disable IAM
+ *   auth. You MUST also set 'input.options.signingServiceInfo' option.
+ *   * The including 'input.options.signingServiceInfo.service' and 'input.options.signingServiceInfo.region' are
+ *     optional. If omitted, the signing service and region will be inferred from url.
+ * * If auth mode is 'none', you MUST NOT set 'options.signingServiceInfo' option.
+ * * If auth mode is 'apiKey', you MUST set 'x-api-key' custom header.
+ * * If auth mode is 'oidc' or 'lambda' or 'userPool', you MUST set 'authorization' header.
+ *
+ * To make the internal post cancellable, you must also call `updateRequestToBeCancellable()` with the promise from
+ * internal post call and the abort controller supplied to the internal post call.
+ *
+ * @internal
+ */
+var post = function (input) {
+    return (0, internalPost_1.post)(core_1.Amplify, input);
+};
+exports.post = post;
+var internalPost_2 = require("../common/internalPost");
+Object.defineProperty(exports, "cancel", { enumerable: true, get: function () { return internalPost_2.cancel; } });
+Object.defineProperty(exports, "updateRequestToBeCancellable", { enumerable: true, get: function () { return internalPost_2.updateRequestToBeCancellable; } });

package/lib/internals/server.d.ts

@@ -0,0 +1,20 @@
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { InternalPostInput } from '../types';
+/**
+ * Internal-only REST POST handler to send GraphQL request to given endpoint. By default, it will use IAM to authorize
+ * the request. In some auth modes, the IAM auth has to be disabled. Here's how to set up the request auth correctly:
+ * * If auth mode is 'iam', you MUST NOT set 'authorization' header and 'x-api-key' header, since it would disable IAM
+ *   auth. You MUST also set 'input.options.signingServiceInfo' option.
+ *   * The including 'input.options.signingServiceInfo.service' and 'input.options.signingServiceInfo.region' are
+ *     optional. If omitted, the signing service and region will be inferred from url.
+ * * If auth mode is 'none', you MUST NOT set 'options.signingServiceInfo' option.
+ * * If auth mode is 'apiKey', you MUST set 'x-api-key' custom header.
+ * * If auth mode is 'oidc' or 'lambda' or 'userPool', you MUST set 'authorization' header.
+ *
+ * To make the internal post cancellable, you must also call `updateRequestToBeCancellable()` with the promise from
+ * internal post call and the abort controller supplied to the internal post call.
+ *
+ * @internal
+ */
+export declare const post: (contextSpec: AmplifyServer.ContextSpec, input: InternalPostInput) => Promise<import("../types").RestApiResponse>;
+export { cancel, updateRequestToBeCancellable } from '../common/internalPost';

package/lib/internals/server.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateRequestToBeCancellable = exports.cancel = exports.post = void 0;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+var internalPost_1 = require("../common/internalPost");
+/**
+ * Internal-only REST POST handler to send GraphQL request to given endpoint. By default, it will use IAM to authorize
+ * the request. In some auth modes, the IAM auth has to be disabled. Here's how to set up the request auth correctly:
+ * * If auth mode is 'iam', you MUST NOT set 'authorization' header and 'x-api-key' header, since it would disable IAM
+ *   auth. You MUST also set 'input.options.signingServiceInfo' option.
+ *   * The including 'input.options.signingServiceInfo.service' and 'input.options.signingServiceInfo.region' are
+ *     optional. If omitted, the signing service and region will be inferred from url.
+ * * If auth mode is 'none', you MUST NOT set 'options.signingServiceInfo' option.
+ * * If auth mode is 'apiKey', you MUST set 'x-api-key' custom header.
+ * * If auth mode is 'oidc' or 'lambda' or 'userPool', you MUST set 'authorization' header.
+ *
+ * To make the internal post cancellable, you must also call `updateRequestToBeCancellable()` with the promise from
+ * internal post call and the abort controller supplied to the internal post call.
+ *
+ * @internal
+ */
+var post = function (contextSpec, input) {
+    return (0, internalPost_1.post)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.post = post;
+var internalPost_2 = require("../common/internalPost");
+Object.defineProperty(exports, "cancel", { enumerable: true, get: function () { return internalPost_2.cancel; } });
+Object.defineProperty(exports, "updateRequestToBeCancellable", { enumerable: true, get: function () { return internalPost_2.updateRequestToBeCancellable; } });