@aws-amplify/api-rest 2.0.62-unstable.4 → 2.0.62

package/src/index.ts

@@ -1,5 +1,18 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { RestAPI } from './RestAPI';
 
 export { RestAPI, RestAPIClass } from './RestAPI';
 export { RestClient } from './RestClient';
+export default RestAPI;

package/src/types/index.ts

@@ -1,5 +1,15 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
 
 /**
  * RestClient instance options

package/webpack.config.dev.js

@@ -0,0 +1,6 @@
+var config = require('./webpack.config.js');
+
+var entry = {
+	'aws-amplify-api-rest': './lib-esm/index.js',
+};
+module.exports = Object.assign(config, { entry, mode: 'development' });

package/lib/RestAPI.d.ts

@@ -1,108 +0,0 @@
-/**
- * Export Cloud Logic APIs
- */
-export declare class RestAPIClass {
-    /**
-     * @private
-     */
-    private _options;
-    private _api;
-    Credentials: import("@aws-amplify/core").CredentialsClass;
-    /**
-     * Initialize Rest API with AWS configuration
-     * @param {Object} options - Configuration object for API
-     */
-    constructor(options: any);
-    getModuleName(): string;
-    /**
-     * Configure API part with aws configurations
-     * @param {Object} config - Configuration of the API
-     * @return {Object} - The current configuration
-     */
-    configure(options: any): any;
-    /**
-     * Create an instance of API for the library
-     * @return - A promise of true if Success
-     */
-    createInstance(): boolean;
-    /**
-     * Make a GET request
-     * @param {string} apiName - The api name of the request
-     * @param {string} path - The path of the request
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    get(apiName: any, path: any, init: any): Promise<any>;
-    /**
-     * Make a POST request
-     * @param {string} apiName - The api name of the request
-     * @param {string} path - The path of the request
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    post(apiName: any, path: any, init: any): Promise<any>;
-    /**
-     * Make a PUT request
-     * @param {string} apiName - The api name of the request
-     * @param {string} path - The path of the request
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    put(apiName: any, path: any, init: any): Promise<any>;
-    /**
-     * Make a PATCH request
-     * @param {string} apiName - The api name of the request
-     * @param {string} path - The path of the request
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    patch(apiName: any, path: any, init: any): Promise<any>;
-    /**
-     * Make a DEL request
-     * @param {string} apiName - The api name of the request
-     * @param {string} path - The path of the request
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    del(apiName: any, path: any, init: any): Promise<any>;
-    /**
-     * Make a HEAD request
-     * @param {string} apiName - The api name of the request
-     * @param {string} path - The path of the request
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    head(apiName: any, path: any, init: any): Promise<any>;
-    /**
-     * Checks to see if an error thrown is from an api request cancellation
-     * @param {any} error - Any error
-     * @return {boolean} - A boolean indicating if the error was from an api request cancellation
-     */
-    isCancel(error: any): boolean;
-    /**
-     * Cancels an inflight request
-     * @param {any} request - request to cancel
-     * @return {boolean} - A boolean indicating if the request was cancelled
-     */
-    cancel(request: Promise<any>, message?: string): boolean;
-    /**
-     * Check if the request has a corresponding cancel token in the WeakMap.
-     * @params request - The request promise
-     * @return if the request has a corresponding cancel token.
-     */
-    hasCancelToken(request: Promise<any>): boolean;
-    /**
-     * Getting endpoint for API
-     * @param {string} apiName - The name of the api
-     * @return {string} - The endpoint of the api
-     */
-    endpoint(apiName: any): Promise<string>;
-    /**
-     * Getting endpoint info for API
-     * @param {string} apiName - The name of the api
-     * @param {string} path - The path of the api that is going to accessed
-     * @return {ApiInfo} - The endpoint information for that api-name
-     */
-    private getEndpointInfo;
-}
-export declare const RestAPI: RestAPIClass;

package/lib/RestClient.d.ts

@@ -1,138 +0,0 @@
-import { apiOptions, ApiInfo } from './types';
-import { CancelTokenSource } from 'axios';
-/**
-* HTTP Client for REST requests. Send and receive JSON data.
-* Sign request with AWS credentials if available
-* Usage:
-<pre>
-const restClient = new RestClient();
-restClient.get('...')
-    .then(function(data) {
-        console.log(data);
-    })
-    .catch(err => console.log(err));
-</pre>
-*/
-export declare class RestClient {
-    private _options;
-    private _region;
-    private _service;
-    private _custom_header;
-    /**
-     * This weak map provides functionality to let clients cancel
-     * in-flight axios requests. https://github.com/axios/axios#cancellation
-     *
-     * 1. For every axios request, a unique cancel token is generated and added in the request.
-     * 2. Promise for fulfilling the request is then mapped to that unique cancel token.
-     * 3. The promise is returned to the client.
-     * 4. Clients can either wait for the promise to fulfill or call `API.cancel(promise)` to cancel the request.
-     * 5. If `API.cancel(promise)` is called, then the corresponding cancel token is retrieved from the map below.
-     * 6. Promise returned to the client will be in rejected state with the error provided during cancel.
-     * 7. Clients can check if the error is because of cancelling by calling `API.isCancel(error)`.
-     *
-     * For more details, see https://github.com/aws-amplify/amplify-js/pull/3769#issuecomment-552660025
-     */
-    private _cancelTokenMap;
-    Credentials: import("@aws-amplify/core").CredentialsClass;
-    /**
-     * @param {RestClientOptions} [options] - Instance options
-     */
-    constructor(options: apiOptions);
-    /**
-    * Update AWS credentials
-    * @param {AWSCredentials} credentials - AWS credentials
-    *
-    updateCredentials(credentials: AWSCredentials) {
-        this.options.credentials = credentials;
-    }
-*/
-    /**
-     * Basic HTTP request. Customizable
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {string} method - Request HTTP method
-     * @param {json} [init] - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    ajax(urlOrApiInfo: string | ApiInfo, method: string, init: any): Promise<any>;
-    /**
-     * GET HTTP request
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {JSON} init - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    get(urlOrApiInfo: string | ApiInfo, init: any): Promise<any>;
-    /**
-     * PUT HTTP request
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {json} init - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    put(urlOrApiInfo: string | ApiInfo, init: any): Promise<any>;
-    /**
-     * PATCH HTTP request
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {json} init - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    patch(urlOrApiInfo: string | ApiInfo, init: any): Promise<any>;
-    /**
-     * POST HTTP request
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {json} init - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    post(urlOrApiInfo: string | ApiInfo, init: any): Promise<any>;
-    /**
-     * DELETE HTTP request
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {json} init - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    del(urlOrApiInfo: string | ApiInfo, init: any): Promise<any>;
-    /**
-     * HEAD HTTP request
-     * @param {string | ApiInfo } urlOrApiInfo - Full request URL or Api information
-     * @param {json} init - Request extra params
-     * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
-     */
-    head(urlOrApiInfo: string | ApiInfo, init: any): Promise<any>;
-    /**
-     * Cancel an inflight API request
-     * @param {Promise<any>} request - The request promise to cancel
-     * @param {string} [message] - A message to include in the cancelation exception
-     */
-    cancel(request: Promise<any>, message?: string): boolean;
-    /**
-     * Check if the request has a corresponding cancel token in the WeakMap.
-     * @params request - The request promise
-     * @return if the request has a corresponding cancel token.
-     */
-    hasCancelToken(request: Promise<any>): boolean;
-    /**
-     * Checks to see if an error thrown is from an api request cancellation
-     * @param {any} error - Any error
-     * @return {boolean} - A boolean indicating if the error was from an api request cancellation
-     */
-    isCancel(error: any): boolean;
-    /**
-     * Retrieves a new and unique cancel token which can be
-     * provided in an axios request to be cancelled later.
-     */
-    getCancellableToken(): CancelTokenSource;
-    /**
-     * Updates the weakmap with a response promise and its
-     * cancel token such that the cancel token can be easily
-     * retrieved (and used for cancelling the request)
-     */
-    updateRequestToBeCancellable(promise: Promise<any>, cancelTokenSource: CancelTokenSource): void;
-    /**
-     * Getting endpoint for API
-     * @param {string} apiName - The name of the api
-     * @return {string} - The endpoint of the api
-     */
-    endpoint(apiName: string): string;
-    /** private methods **/
-    private _signed;
-    private _request;
-    private _parseUrl;
-}

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export { RestAPI, RestAPIClass } from './RestAPI';
-export { RestClient } from './RestClient';

package/lib/types/index.d.ts

@@ -1,50 +0,0 @@
-/**
- * RestClient instance options
- */
-export declare class RestClientOptions {
-    /** AWS credentials */
-    credentials: AWSCredentials;
-    /**
-     * Lookup key of AWS credentials.
-     * If credentials not provided then lookup from sessionStorage.
-     * Default 'awsCredentials'
-     */
-    credentials_key: string;
-    /** Additional headers for all requests send by this client. e.g. user-agent */
-    headers: object;
-    constructor();
-}
-/**
- * AWS credentials needed for RestClient
- */
-export declare class AWSCredentials {
-    /**
-     * Secret Access Key
-     *
-     * [Access Key ID and Secret Access Key]
-     * (http://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys)
-     */
-    secretAccessKey: string;
-    /**
-     * Access Key ID
-     *
-     * [Access Key ID and Secret Access Key]
-     * (http://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys)
-     */
-    accessKeyId: string;
-    /** Access Token of current session */
-    sessionToken: string;
-}
-export interface apiOptions {
-    headers: object;
-    endpoints: object;
-    credentials?: object;
-}
-export declare type ApiInfo = {
-    endpoint: string;
-    region?: string;
-    service?: string;
-    custom_header?: () => {
-        [key: string]: string;
-    };
-};