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

package/lib/{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/{common → apis/common}/handler.js

@@ -3,16 +3,15 @@ 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");
+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.
+ * @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
  */
@@ -49,7 +48,7 @@ var transferHandler = function (amplify, options, signingServiceInfo) { return t
                 };
                 isIamAuthApplicable = iamAuthApplicable(request, signingServiceInfo);
                 if (!isIamAuthApplicable) return [3 /*break*/, 3];
-                signingInfoFromUrl = (0, utils_1.parseUrl)(url);
+                signingInfoFromUrl = (0, utils_1.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*/, (0, utils_1.resolveCredentials)(amplify)];

package/{lib-esm → lib/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/{common → apis/common}/internalPost.js

@@ -5,7 +5,18 @@ 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 utils_1 = require("../../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/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/apis/common/publicApis.js

@@ -0,0 +1,50 @@
+"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.patch = exports.head = exports.del = exports.put = exports.post = exports.get = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("../../utils");
+var handler_1 = require("./handler");
+var publicHandler = function (amplify, options, method) {
+    return (0, utils_1.createCancellableOperation)(function (abortSignal) { return tslib_1.__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 tslib_1.__generator(this, function (_g) {
+            switch (_g.label) {
+                case 0:
+                    apiName = options.apiName, _a = options.options, apiOptions = _a === void 0 ? {} : _a, apiPath = options.path;
+                    url = (0, utils_1.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 = tslib_1.__assign(tslib_1.__assign({}, libraryOptionsHeaders), invocationHeaders);
+                    signingServiceInfo = (0, utils_1.parseSigningInfo)(url, {
+                        amplify: amplify,
+                        apiName: apiName,
+                    });
+                    utils_1.logger.debug(method, url, headers, "IAM signing options: ".concat(JSON.stringify(signingServiceInfo)));
+                    return [2 /*return*/, (0, handler_1.transferHandler)(amplify, tslib_1.__assign(tslib_1.__assign({}, apiOptions), { url: url, method: method, headers: headers, abortSignal: abortSignal }), signingServiceInfo)];
+            }
+        });
+    }); });
+};
+var get = function (amplify, input) {
+    return publicHandler(amplify, input, 'GET');
+};
+exports.get = get;
+var post = function (amplify, input) { return publicHandler(amplify, input, 'POST'); };
+exports.post = post;
+var put = function (amplify, input) {
+    return publicHandler(amplify, input, 'PUT');
+};
+exports.put = put;
+var del = function (amplify, input) { return publicHandler(amplify, input, 'DELETE'); };
+exports.del = del;
+var head = function (amplify, input) { return publicHandler(amplify, input, 'HEAD'); };
+exports.head = head;
+var patch = function (amplify, input) { return publicHandler(amplify, input, 'PATCH'); };
+exports.patch = patch;

package/lib/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/apis/index.js

@@ -0,0 +1,45 @@
+"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.patch = exports.head = exports.del = exports.put = exports.post = exports.get = void 0;
+var core_1 = require("@aws-amplify/core");
+var publicApis_1 = require("./common/publicApis");
+/**
+ * GET HTTP request
+ */
+var get = function (input) { return (0, publicApis_1.get)(core_1.Amplify, input); };
+exports.get = get;
+/**
+ * POST HTTP request
+ */
+var post = function (input) {
+    return (0, publicApis_1.post)(core_1.Amplify, input);
+};
+exports.post = post;
+/**
+ * PUT HTTP request
+ */
+var put = function (input) { return (0, publicApis_1.put)(core_1.Amplify, input); };
+exports.put = put;
+/**
+ * DELETE HTTP request
+ */
+var del = function (input) {
+    return (0, publicApis_1.del)(core_1.Amplify, input);
+};
+exports.del = del;
+/**
+ * HEAD HTTP request
+ */
+var head = function (input) {
+    return (0, publicApis_1.head)(core_1.Amplify, input);
+};
+exports.head = head;
+/**
+ * PATCH HTTP request
+ */
+var patch = function (input) {
+    return (0, publicApis_1.patch)(core_1.Amplify, input);
+};
+exports.patch = patch;

package/lib/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/apis/server.js

@@ -0,0 +1,49 @@
+"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.patch = exports.head = exports.del = exports.put = exports.post = exports.get = void 0;
+var adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+var publicApis_1 = require("./common/publicApis");
+/**
+ * GET HTTP request (server-side)
+ */
+var get = function (contextSpec, input) {
+    return (0, publicApis_1.get)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.get = get;
+/**
+ * POST HTTP request (server-side)
+ */
+var post = function (contextSpec, input) {
+    return (0, publicApis_1.post)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.post = post;
+/**
+ * PUT HTTP request (server-side)
+ */
+var put = function (contextSpec, input) {
+    return (0, publicApis_1.put)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.put = put;
+/**
+ * DELETE HTTP request (server-side)
+ */
+var del = function (contextSpec, input) {
+    return (0, publicApis_1.del)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.del = del;
+/**
+ * HEAD HTTP request (server-side)
+ */
+var head = function (contextSpec, input) {
+    return (0, publicApis_1.head)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.head = head;
+/**
+ * PATCH HTTP request (server-side)
+ */
+var patch = function (contextSpec, input) {
+    return (0, publicApis_1.patch)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.patch = patch;

package/lib/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/errors/validation.js

@@ -7,9 +7,14 @@ exports.validationErrorMap = exports.RestApiValidationErrorCode = void 0;
 var RestApiValidationErrorCode;
 (function (RestApiValidationErrorCode) {
     RestApiValidationErrorCode["NoCredentials"] = "NoCredentials";
+    RestApiValidationErrorCode["InvalidApiName"] = "InvalidApiName";
 })(RestApiValidationErrorCode = exports.RestApiValidationErrorCode || (exports.RestApiValidationErrorCode = {}));
 exports.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);

package/lib/index.d.ts

@@ -1 +1,2 @@
 export { isCancelError } from './errors/CancelledError';
+export { get, post, put, del, head, patch } from './apis';

package/lib/index.js

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

package/lib/internals/index.d.ts

@@ -16,4 +16,4 @@ import { InternalPostInput } from '../types';
  * @internal
  */
 export declare const post: (input: InternalPostInput) => Promise<import("../types").RestApiResponse>;
-export { cancel, updateRequestToBeCancellable } from '../common/internalPost';
+export { cancel, updateRequestToBeCancellable, } from '../apis/common/internalPost';

package/lib/internals/index.js

@@ -4,7 +4,7 @@ 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");
+var internalPost_1 = require("../apis/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:
@@ -25,6 +25,6 @@ var post = function (input) {
     return (0, internalPost_1.post)(core_1.Amplify, input);
 };
 exports.post = post;
-var internalPost_2 = require("../common/internalPost");
+var internalPost_2 = require("../apis/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

@@ -17,4 +17,4 @@ import { InternalPostInput } from '../types';
  * @internal
  */
 export declare const post: (contextSpec: AmplifyServer.ContextSpec, input: InternalPostInput) => Promise<import("../types").RestApiResponse>;
-export { cancel, updateRequestToBeCancellable } from '../common/internalPost';
+export { cancel, updateRequestToBeCancellable, } from '../apis/common/internalPost';

package/lib/internals/server.js

@@ -4,7 +4,7 @@ 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");
+var internalPost_1 = require("../apis/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:
@@ -25,6 +25,6 @@ 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");
+var internalPost_2 = require("../apis/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/server.d.ts

@@ -0,0 +1,2 @@
+export { isCancelError } from './errors/CancelledError';
+export { get, post, put, del, head, patch } from './apis/server';

package/lib/server.js

@@ -0,0 +1,14 @@
+"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.patch = exports.head = exports.del = exports.put = exports.post = exports.get = exports.isCancelError = void 0;
+var CancelledError_1 = require("./errors/CancelledError");
+Object.defineProperty(exports, "isCancelError", { enumerable: true, get: function () { return CancelledError_1.isCancelError; } });
+var server_1 = require("./apis/server");
+Object.defineProperty(exports, "get", { enumerable: true, get: function () { return server_1.get; } });
+Object.defineProperty(exports, "post", { enumerable: true, get: function () { return server_1.post; } });
+Object.defineProperty(exports, "put", { enumerable: true, get: function () { return server_1.put; } });
+Object.defineProperty(exports, "del", { enumerable: true, get: function () { return server_1.del; } });
+Object.defineProperty(exports, "head", { enumerable: true, get: function () { return server_1.head; } });
+Object.defineProperty(exports, "patch", { enumerable: true, get: function () { return server_1.patch; } });