@aws-amplify/api-rest 4.0.1-console-preview.3d7f188.0 → 4.0.1-mjs-test.20ead30.0

package/lib/apis/index.d.ts

@@ -1,203 +0,0 @@
-import { DeleteInput, DeleteOperation, GetInput, GetOperation, HeadInput, HeadOperation, PatchInput, PatchOperation, PostInput, PostOperation, PutInput, PutOperation } from '../types';
-/**
- * GET HTTP request
- * @param {GetInput} input - Input for GET operation
- * @returns {GetOperation} Operation for GET request
- * @throws - {@link RestApiError}
- * @example
- * Send a GET request
- * ```js
- * import { get, isCancelError } from '@aws-amplify/api';
- *
- * const { body } = await get({
- *   apiName,
- *   path,
- *   options: {
- *     headers, // Optional, A map of custom header key/values
- *     body, // Optional, JSON object or FormData
- *     queryParams, // Optional, A map of query strings
- *   }
- * }).response;
- * const data = await body.json();
- * ```
- * @example
- * Cancel a GET request
- *
- * ```js
- * import { get, isCancelError } from '@aws-amplify/api';
- *
- * const { response, cancel } = get({apiName, path, options});
- * cancel(message);
- * try {
- *   await response;
- * } cache (e) {
- *   if (isCancelError(e)) {
- *    // handle request cancellation
- *   }
- *   //...
- * }
- * ```
- */
-export declare const get: (input: GetInput) => GetOperation;
-/**
- * POST HTTP request
- * @param {PostInput} input - Input for POST operation
- * @returns {PostOperation} Operation for POST request
- * @throws - {@link RestApiError}
- * @example
- * Send a POST request
- * ```js
- * import { post, isCancelError } from '@aws-amplify/api';
- *
- * const { body } = await post({
- *   apiName,
- *   path,
- *   options: {
- *     headers, // Optional, A map of custom header key/values
- *     body, // Optional, JSON object or FormData
- *     queryParams, // Optional, A map of query strings
- *   }
- * }).response;
- * const data = await body.json();
- * ```
- * @example
- * Cancel a POST request
- *
- * ```js
- * import { post, isCancelError } from '@aws-amplify/api';
- *
- * const { response, cancel } = post({apiName, path, options});
- * cancel(message);
- * try {
- *   await response;
- * } cache (e) {
- *   if (isCancelError(e)) {
- *    // handle request cancellation
- *   }
- *   //...
- * }
- * ```
- */
-export declare const post: (input: PostInput) => PostOperation;
-/**
- * PUT HTTP request
- * @param {PutInput} input - Input for PUT operation
- * @returns {PutOperation} Operation for PUT request
- * @throws - {@link RestApiError}
- * @example
- * Send a PUT request
- * ```js
- * import { put, isCancelError } from '@aws-amplify/api';
- *
- * const { body } = await put({
- *   apiName,
- *   path,
- *   options: {
- *     headers, // Optional, A map of custom header key/values
- *     body, // Optional, JSON object or FormData
- *     queryParams, // Optional, A map of query strings
- *   }
- * }).response;
- * const data = await body.json();
- * ```
- * @example
- * Cancel a PUT request
- * ```js
- * import { put, isCancelError } from '@aws-amplify/api';
- *
- * const { response, cancel } = put({apiName, path, options});
- * cancel(message);
- * try {
- *  await response;
- * } cache (e) {
- *   if (isCancelError(e)) {
- *     // handle request cancellation
- *   }
- * //...
- * }
- * ```
- */
-export declare const put: (input: PutInput) => PutOperation;
-/**
- * DELETE HTTP request
- * @param {DeleteInput} input - Input for DELETE operation
- * @returns {DeleteOperation} Operation for DELETE request
- * @throws - {@link RestApiError}
- * @example
- * Send a DELETE request
- * ```js
- * import { del } from '@aws-amplify/api';
- *
- * const { statusCode } = await del({
- *   apiName,
- *   path,
- *   options: {
- *     headers, // Optional, A map of custom header key/values
- *     queryParams, // Optional, A map of query strings
- *   }
- * }).response;
- * ```
- */
-export declare const del: (input: DeleteInput) => DeleteOperation;
-/**
- * HEAD HTTP request
- * @param {HeadInput} input - Input for HEAD operation
- * @returns {HeadOperation} Operation for HEAD request
- * @throws - {@link RestApiError}
- * @example
- * Send a HEAD request
- * ```js
- * import { head, isCancelError } from '@aws-amplify/api';
- *
- * const { headers, statusCode } = await head({
- *   apiName,
- *   path,
- *   options: {
- *     headers, // Optional, A map of custom header key/values
- *     queryParams, // Optional, A map of query strings
- *   }
- * }),response;
- * ```
- *
- */
-export declare const head: (input: HeadInput) => HeadOperation;
-/**
- * PATCH HTTP request
- * @param {PatchInput} input - Input for PATCH operation
- * @returns {PatchOperation} Operation for PATCH request
- * @throws - {@link RestApiError}
- * @example
- * Send a PATCH request
- * ```js
- * import { patch } from '@aws-amplify/api';
- *
- * const { body } = await patch({
- *   apiName,
- *   path,
- *   options: {
- *     headers, // Optional, A map of custom header key/values
- *     body, // Optional, JSON object or FormData
- *     queryParams, // Optional, A map of query strings
- *   }
- * }).response;
- * const data = await body.json();
- * ```
- *
- * @example
- * Cancel a PATCH request
- * ```js
- * import { patch, isCancelError } from '@aws-amplify/api';
- *
- * const { response, cancel } = patch({apiName, path, options});
- * cancel(message);
- * try {
- *  await response;
- * } cache (e) {
- *  if (isCancelError(e)) {
- *   // handle request cancellation
- *  }
- * //...
- * }
- * ```
- */
-export declare const patch: (input: PatchInput) => PatchOperation;

package/lib/apis/server.d.ts

@@ -1,151 +0,0 @@
-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/errors/CanceledError.d.ts

@@ -1,17 +0,0 @@
-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/RestApiError.d.ts

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

package/lib/errors/RestApiError.js

@@ -1,19 +0,0 @@
-"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

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

package/lib/errors/index.d.ts

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

package/lib/errors/validation.d.ts

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

package/lib/index.d.ts

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

package/lib/internals/index.d.ts

@@ -1,19 +0,0 @@
-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/server.d.ts

@@ -1,20 +0,0 @@
-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/server.d.ts

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