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

package/lib/apis/server.js

@@ -7,6 +7,28 @@ var adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
 var 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}
  */
 var get = function (contextSpec, input) {
     return (0, publicApis_1.get)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
@@ -14,6 +36,27 @@ var get = function (contextSpec, 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;
+ *     }
+ *   },
+ * });
+ * ```
  */
 var post = function (contextSpec, input) {
     return (0, publicApis_1.post)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
@@ -21,6 +64,27 @@ var post = function (contextSpec, 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;
+ *     }
+ *   },
+ * });
+ * ```
  */
 var put = function (contextSpec, input) {
     return (0, publicApis_1.put)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
@@ -28,6 +92,26 @@ var put = function (contextSpec, 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;
+ *     }
+ *   },
+ * });
+ * ```
  */
 var del = function (contextSpec, input) {
     return (0, publicApis_1.del)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
@@ -35,6 +119,26 @@ var del = function (contextSpec, 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;
+ *     }
+ *   },
+ * });
+ * ```
  */
 var head = function (contextSpec, input) {
     return (0, publicApis_1.head)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
@@ -42,6 +146,27 @@ var head = function (contextSpec, 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;
+ *     }
+ *   },
+ * });
+ * ```
  */
 var patch = function (contextSpec, input) {
     return (0, publicApis_1.patch)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);

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,35 @@
+"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;
+var tslib_1 = require("tslib");
+var RestApiError_1 = require("./RestApiError");
+/**
+ * Internal-only class for CanceledError.
+ *
+ * @internal
+ */
+var CanceledError = /** @class */ (function (_super) {
+    tslib_1.__extends(CanceledError, _super);
+    function CanceledError(params) {
+        if (params === void 0) { params = {}; }
+        var _this = _super.call(this, tslib_1.__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_1.RestApiError));
+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`.
+ */
+var isCancelError = function (error) {
+    return !!error && error instanceof CanceledError;
+};
+exports.isCancelError = isCancelError;

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

@@ -2,10 +2,10 @@
 // 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; } });
+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");

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

@@ -3,8 +3,8 @@
 // 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 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; } });

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

@@ -3,8 +3,8 @@
 // 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 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; } });