@aws-amplify/api-rest 3.5.6-api-v6-models.b3abc9b.0 → 4.0.0

package/lib/apis/server.d.ts

@@ -0,0 +1,151 @@
+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)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {GetInput} input - Input for GET operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a GET request
+ * ```js
+ * import { get } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await get(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ * @see {@link clientGet}
+ */
+export declare const get: (contextSpec: AmplifyServer.ContextSpec, input: GetInput) => GetOperation;
+/**
+ * POST HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {PostInput} input - Input for POST operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a POST request
+ * ```js
+ * import { post } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await post(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export declare const post: (contextSpec: AmplifyServer.ContextSpec, input: PostInput) => PostOperation;
+/**
+ * PUT HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {PutInput} input - Input for PUT operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a PUT request
+ * ```js
+ * import { put } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await put(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export declare const put: (contextSpec: AmplifyServer.ContextSpec, input: PutInput) => PutOperation;
+/**
+ * DELETE HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {DeleteInput} input - Input for DELETE operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a DELETE request
+ * ```js
+ * import { del } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { headers } = await del(contextSpec, input).response;
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export declare const del: (contextSpec: AmplifyServer.ContextSpec, input: DeleteInput) => DeleteOperation;
+/**
+ * HEAD HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {HeadInput} input - Input for HEAD operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a HEAD request
+ * ```js
+ * import { head } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { headers } = await head(contextSpec, input).response;
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export declare const head: (contextSpec: AmplifyServer.ContextSpec, input: HeadInput) => HeadOperation;
+/**
+ * PATCH HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {PatchInput} input - Input for PATCH operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a PATCH request
+ * ```js
+ * import { patch } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await patch(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+export declare const patch: (contextSpec: AmplifyServer.ContextSpec, input: PatchInput) => PatchOperation;

package/lib/apis/server.js

@@ -0,0 +1,162 @@
+"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;
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const publicApis_1 = require("./common/publicApis");
+/**
+ * GET HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {GetInput} input - Input for GET operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a GET request
+ * ```js
+ * import { get } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await get(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ * @see {@link clientGet}
+ */
+const get = (contextSpec, input) => (0, publicApis_1.get)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+exports.get = get;
+/**
+ * POST HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {PostInput} input - Input for POST operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a POST request
+ * ```js
+ * import { post } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await post(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+const post = (contextSpec, input) => (0, publicApis_1.post)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+exports.post = post;
+/**
+ * PUT HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {PutInput} input - Input for PUT operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a PUT request
+ * ```js
+ * import { put } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await put(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+const put = (contextSpec, input) => (0, publicApis_1.put)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+exports.put = put;
+/**
+ * DELETE HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {DeleteInput} input - Input for DELETE operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a DELETE request
+ * ```js
+ * import { del } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { headers } = await del(contextSpec, input).response;
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+const del = (contextSpec, input) => (0, publicApis_1.del)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+exports.del = del;
+/**
+ * HEAD HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {HeadInput} input - Input for HEAD operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a HEAD request
+ * ```js
+ * import { head } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { headers } = await head(contextSpec, input).response;
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+const head = (contextSpec, input) => (0, publicApis_1.head)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+exports.head = head;
+/**
+ * PATCH HTTP request (server-side)
+ * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
+ * @param {PatchInput} input - Input for PATCH operation.
+ * @throws - {@link RestApiError}
+ * @example
+ * Send a PATCH request
+ * ```js
+ * import { patch } from 'aws-amplify/api/server';
+ * //...
+ * const restApiResponse = await runWithAmplifyServerContext({
+ *   nextServerContext: { request, response },
+ *   operation: async (contextSpec) => {
+ *     try {
+ *       const { body } = await patch(contextSpec, input).response;
+ *       return await body.json();
+ *     } catch (error) {
+ *       console.log(error);
+ *       return false;
+ *     }
+ *   },
+ * });
+ * ```
+ */
+const patch = (contextSpec, input) => (0, publicApis_1.patch)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+exports.patch = patch;

package/lib/errors/CanceledError.d.ts

@@ -0,0 +1,17 @@
+import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+import { RestApiError } from './RestApiError';
+/**
+ * Internal-only class for CanceledError.
+ *
+ * @internal
+ */
+export declare class CanceledError extends RestApiError {
+    constructor(params?: Partial<AmplifyErrorParams>);
+}
+/**
+ * Check if an error is caused by user calling `cancel()` in REST API.
+ *
+ * @note This function works **ONLY** for errors thrown by REST API. For GraphQL APIs, use `client.isCancelError(error)`
+ *   instead. `client` is generated from  `generateClient()` API from `aws-amplify/api`.
+ */
+export declare const isCancelError: (error: unknown) => error is CanceledError;

package/lib/errors/CanceledError.js

@@ -0,0 +1,32 @@
+"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.CanceledError = void 0;
+const RestApiError_1 = require("./RestApiError");
+/**
+ * Internal-only class for CanceledError.
+ *
+ * @internal
+ */
+class CanceledError extends RestApiError_1.RestApiError {
+    constructor(params = {}) {
+        super({
+            name: 'CanceledError',
+            message: 'Request is canceled by user',
+            ...params,
+        });
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        this.constructor = CanceledError;
+        Object.setPrototypeOf(this, CanceledError.prototype);
+    }
+}
+exports.CanceledError = CanceledError;
+/**
+ * Check if an error is caused by user calling `cancel()` in REST API.
+ *
+ * @note This function works **ONLY** for errors thrown by REST API. For GraphQL APIs, use `client.isCancelError(error)`
+ *   instead. `client` is generated from  `generateClient()` API from `aws-amplify/api`.
+ */
+const isCancelError = (error) => !!error && error instanceof CanceledError;
+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,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.RestApiError = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+class RestApiError extends utils_1.AmplifyError {
+    constructor(params) {
+        super(params);
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        this.constructor = RestApiError;
+        Object.setPrototypeOf(this, RestApiError.prototype);
+    }
+}
+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;
+const RestApiError_1 = require("./RestApiError");
+const validation_1 = require("./validation");
+/**
+ * @internal
+ */
+function assertValidationError(assertion, name) {
+    const { message, recoverySuggestion } = validation_1.validationErrorMap[name];
+    if (!assertion) {
+        throw new RestApiError_1.RestApiError({ name, message, recoverySuggestion });
+    }
+}
+exports.assertValidationError = assertValidationError;

package/lib/errors/index.d.ts

@@ -0,0 +1,4 @@
+export { CanceledError, isCancelError } from './CanceledError';
+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.CanceledError = void 0;
+var CanceledError_1 = require("./CanceledError");
+Object.defineProperty(exports, "CanceledError", { enumerable: true, get: function () { return CanceledError_1.CanceledError; } });
+Object.defineProperty(exports, "isCancelError", { enumerable: true, get: function () { return CanceledError_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,6 @@
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+export declare enum RestApiValidationErrorCode {
+    NoCredentials = "NoCredentials",
+    InvalidApiName = "InvalidApiName"
+}
+export declare const validationErrorMap: AmplifyErrorMap<RestApiValidationErrorCode>;

package/lib/errors/validation.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.validationErrorMap = exports.RestApiValidationErrorCode = void 0;
+var RestApiValidationErrorCode;
+(function (RestApiValidationErrorCode) {
+    RestApiValidationErrorCode["NoCredentials"] = "NoCredentials";
+    RestApiValidationErrorCode["InvalidApiName"] = "InvalidApiName";
+})(RestApiValidationErrorCode = exports.RestApiValidationErrorCode || (exports.RestApiValidationErrorCode = {}));
+exports.validationErrorMap = {
+    [RestApiValidationErrorCode.NoCredentials]: {
+        message: 'Credentials should not be empty.',
+    },
+    [RestApiValidationErrorCode.InvalidApiName]: {
+        message: 'API name is invalid.',
+        recoverySuggestion: 'Check if the API name matches the one in your configuration or `aws-exports.js`',
+    },
+};

package/lib/index.d.ts

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

package/lib/index.js

@@ -2,9 +2,13 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var RestAPI_1 = require("./RestAPI");
-exports.RestAPI = RestAPI_1.RestAPI;
-exports.RestAPIClass = RestAPI_1.RestAPIClass;
-var RestClient_1 = require("./RestClient");
-exports.RestClient = RestClient_1.RestClient;
-//# sourceMappingURL=index.js.map
+exports.patch = exports.head = exports.del = exports.put = exports.post = exports.get = exports.isCancelError = void 0;
+var CanceledError_1 = require("./errors/CanceledError");
+Object.defineProperty(exports, "isCancelError", { enumerable: true, get: function () { return CanceledError_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

@@ -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 '../apis/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
+const core_1 = require("@aws-amplify/core");
+const 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:
+ * * 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
+ */
+const post = (input) => {
+    return (0, internalPost_1.post)(core_1.Amplify, input);
+};
+exports.post = post;
+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

@@ -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 '../apis/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
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const 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:
+ * * 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
+ */
+const post = (contextSpec, input) => {
+    return (0, internalPost_1.post)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.post = post;
+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/CanceledError';
+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 CanceledError_1 = require("./errors/CanceledError");
+Object.defineProperty(exports, "isCancelError", { enumerable: true, get: function () { return CanceledError_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; } });