@aws-amplify/api-rest 4.0.1-console-preview.a1c533e.0 → 4.0.1-console-preview.23dc225.0

package/lib-esm/apis/server.js

@@ -4,36 +4,161 @@ import { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-co
 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)
+ * @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 var get = function (contextSpec, input) {
     return commonGet(getAmplifyServerContext(contextSpec).amplify, input);
 };
 /**
  * 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 var post = function (contextSpec, input) {
     return commonPost(getAmplifyServerContext(contextSpec).amplify, input);
 };
 /**
  * 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 var put = function (contextSpec, input) {
     return commonPut(getAmplifyServerContext(contextSpec).amplify, input);
 };
 /**
  * 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 var del = function (contextSpec, input) {
     return commonDel(getAmplifyServerContext(contextSpec).amplify, input);
 };
 /**
  * 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 var head = function (contextSpec, input) {
     return commonHead(getAmplifyServerContext(contextSpec).amplify, input);
 };
 /**
  * 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 var patch = function (contextSpec, input) {
     return commonPatch(getAmplifyServerContext(contextSpec).amplify, input);

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

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign, __extends } from "tslib";
+import { RestApiError } from './RestApiError';
+/**
+ * Internal-only class for CanceledError.
+ *
+ * @internal
+ */
+var CanceledError = /** @class */ (function (_super) {
+    __extends(CanceledError, _super);
+    function CanceledError(params) {
+        if (params === void 0) { params = {}; }
+        var _this = _super.call(this, __assign({ name: 'CanceledError', message: 'Request is canceled by user' }, params)) || this;
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        _this.constructor = CanceledError;
+        Object.setPrototypeOf(_this, CanceledError.prototype);
+        return _this;
+    }
+    return CanceledError;
+}(RestApiError));
+export { 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`.
+ */
+export var isCancelError = function (error) {
+    return !!error && error instanceof CanceledError;
+};

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

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

package/lib-esm/errors/index.js

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { CancelledError, isCancelError } from './CancelledError';
+export { CanceledError, isCancelError } from './CanceledError';
 export { RestApiError } from './RestApiError';
 export { assertValidationError } from './assertValidatonError';
 export { RestApiValidationErrorCode, validationErrorMap } from './validation';

package/lib-esm/index.d.ts

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

package/lib-esm/index.js

@@ -1,4 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { isCancelError } from './errors/CancelledError';
+export { isCancelError } from './errors/CanceledError';
 export { get, post, put, del, head, patch } from './apis';

package/lib-esm/server.d.ts

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

package/lib-esm/server.js

@@ -1,4 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { isCancelError } from './errors/CancelledError';
+export { isCancelError } from './errors/CanceledError';
 export { get, post, put, del, head, patch } from './apis/server';