@amazon-sp-api-release/amazon-sp-api-sdk-js 1.0.0-rc6 → 1.0.0-rc7

package/src/vendordftransactions_v2021_12_28/ApiClient.js

@@ -14,6 +14,9 @@
 import superagent from "superagent";
 import querystring from "querystring";
 import { URL } from 'node:url';
+import { RateLimitConfiguration } from "../../helper/RateLimitConfiguration.mjs";
+import { SuperagentRateLimiter } from "../../helper/SuperagentRateLimiter.mjs";
+import { DefaultRateLimitFetcher } from "../../helper/DefaultRateLimitFetcher.mjs";
 
 /**
 * @module vendordftransactions_v2021_12_28/ApiClient
@@ -26,32 +29,27 @@ import { URL } from 'node:url';
 */
 class LwaOAuthClient {
     /**
-    * Private member to store LWA credential and refresh token.
-    * @type {Object.<String, String>}
+    * Private member to store LWA credential, refresh token or scope.
+    * @type {Object<String, String>}
     */
     #lwaClientInfo = {};
 
     /**
-    * Private member to cache one access token that is retrieved by auto-retrieval.
-    * @type {String | null}
+    * Private member to cache access token that is retrieved by auto-retrieval.
+    * @type {Map<String, {String, Number}> | null}
     */
-    #cachedToken = null;
-
-    /**
-    * Private member to cache one access token that is retrieved by auto-retrieval.
-    * @type {Number | null}
-    */
-    #cachedTokenExpiration = null;
+    #cachedTokenMap = null;
 
     /**
     * Constructs a new LwaOAuthClient.
     * @param {String} clientId LWA Client ID.
     * @param {String} clientSecret LWA Client Secret.
-    * @param {String} refreshToken LWA Refresh token.
+    * @param {String|null} refreshToken LWA Refresh token.
+    * @param {String|null} scope LWA scope(s) for grantless operations.
     */
-    constructor(clientId, clientSecret, refreshToken) {
+    constructor(clientId, clientSecret, refreshToken = null, scope = null) {
         this.#lwaClientInfo = {
-            clientId, clientSecret, refreshToken,
+            clientId, clientSecret, refreshToken, scope
         };
     }
 
@@ -60,13 +58,30 @@ class LwaOAuthClient {
      * @returns {Promise<String>} LWA access token.
      */
     retrieveAccessToken = async () => {
-        if (this.#cachedToken && this.#cachedTokenExpiration && this.#cachedTokenExpiration > Date.now()) {
-            return Promise.resolve(this.#cachedToken);
+        const key = JSON.stringify(this.#lwaClientInfo);
+
+        if (this.#cachedTokenMap) {
+            const cachedTokenItem = this.#cachedTokenMap.get(key);
+
+            if (cachedTokenItem) {
+                const cachedToken = cachedTokenItem.cachedToken;
+                const cachedTokenExpiration = cachedTokenItem.cachedTokenExpiration;
+                //Adjustment in milliseconds (60s) to avoid using nearly expired tokens
+                const adjustedExpiryTime = cachedTokenExpiration - 60000;
+                if (adjustedExpiryTime > Date.now()) {
+                    return Promise.resolve(cachedToken); 
+                } else {
+                    this.#cachedTokenMap.delete(key);
+                }
+            }
         }
+
         const res = await this.#doRefresh();
-        this.#cachedToken = res.access_token;
-        this.#cachedTokenExpiration = Date.now() + res.expires_in * 1000;
-        return this.#cachedToken;
+        if (!this.#cachedTokenMap) {
+            this.#cachedTokenMap = new Map();
+        }
+        this.#cachedTokenMap.set(key, {cachedToken: res.access_token, cachedTokenExpiration: Date.now() + res.expires_in * 1000});
+        return res.access_token;
     }
 
     /**
@@ -74,11 +89,24 @@ class LwaOAuthClient {
      * @returns {Promise<Object>} LWA token response.
      */
     #doRefresh = async () => {
+        let requestBody = null;
+        if (this.#lwaClientInfo.scope) {
+            //grantless operations
+            requestBody = `grant_type=client_credentials&client_id=${this.#lwaClientInfo.clientId}&client_secret=${this.#lwaClientInfo.clientSecret}&scope=${this.#lwaClientInfo.scope}`;
+        } else {
+            requestBody = `grant_type=refresh_token&refresh_token=${this.#lwaClientInfo.refreshToken}&client_id=${this.#lwaClientInfo.clientId}&client_secret=${this.#lwaClientInfo.clientSecret}`;
+        }
         const res = await superagent.post('https://api.amazon.com/auth/o2/token')
-            .send(`grant_type=refresh_token&refresh_token=${this.#lwaClientInfo.refreshToken}&client_id=${this.#lwaClientInfo.clientId}&client_secret=${this.#lwaClientInfo.clientSecret}`)
+            .send(requestBody)
             .set("Content-Type", "application/x-www-form-urlencoded;charset=UTF-8");
         return res.body;
     }
+
+    clearCachedTokenMap() {
+        if (this.#cachedTokenMap) {
+            this.#cachedTokenMap.clear();
+        }
+    }
 }
 
 /**
@@ -88,13 +116,13 @@ class LwaOAuthClient {
 class TokensApiClient {
     /**
     * Private member to execute LWA refresh token flow.
-    * @type {Object.<LwaOAuthClient>}
+    * @type {Object<LwaOAuthClient>}
     */
     #lwaClient = null;
 
     /**
     * Private member to store 'dataElements' parameter for Tokens API call.
-    * @type {Array.<String>}
+    * @type {Array<String>}
     */
     #dataElements = null;
 
@@ -103,10 +131,10 @@ class TokensApiClient {
     * @param {String} clientId LWA Client ID.
     * @param {String} clientSecret LWA Client Secret.
     * @param {String} refreshToken LWA Refresh token.
-    * @param {Array.<String>} dataElements Optional specifiers for PII data elements tp retrieve.
+    * @param {Array<String>} dataElements Optional specifiers for PII data elements tp retrieve.
     */
     constructor(clientId, clientSecret, refreshToken, dataElements) {
-        this.#lwaClient = new LwaOAuthClient(clientId, clientSecret, refreshToken, dataElements);
+        this.#lwaClient = new LwaOAuthClient(clientId, clientSecret, refreshToken, null);
         if (dataElements && !Array.isArray(dataElements)) {
             throw new Error(`dataElements parameter to TokensApiClient constructor must be array of string. Illegal parameter:${dataElements}`);
         }
@@ -117,7 +145,7 @@ class TokensApiClient {
      * Execute createRestrictedDataToken to retrieve RDT to be used for PII-handling SP-API calls.
      * @param {String} method method for SP-API request.
      * @param {String} url URL for SP-API call to be made.
-     * @param {Array.<String>} dataElements specify PII information to get from "buyerInfo", "shippingAddress" and "buyerTaxInformation".
+     * @param {Array<String>} dataElements specify PII information to get from "buyerInfo", "shippingAddress" and "buyerTaxInformation".
      * @returns {Promise<String>} Restricted Data Token (RDT).
      */
     retrieveRestrictedDataToken = async (method, url) => {
@@ -127,11 +155,11 @@ class TokensApiClient {
         return res.restrictedDataToken;
     }
 
-     /**
+    /**
      * Private method to execute createRestrictedDataToken
      * @param {String} accessToken Access token to call RDT request.
      * @param {URL} url URL object for URL string manipulation.
-     * @param {Array.<String>} dataElements specify PII information to get from "buyerInfo", "shippingAddress" and "buyerTaxInformation".
+     * @param {Array<String>} dataElements specify PII information to get from "buyerInfo", "shippingAddress" and "buyerTaxInformation".
      * @returns {Promise<Object>} createRestrictedDataToken response.
      */
     #doCreateRestrictedDataToken = async (accessToken, method, url) => {
@@ -165,6 +193,9 @@ export class ApiClient {
     #tokenForApiCall = null;
     #lwaClient = null;
     #rdtClient = null;
+    #defaultRateLimitFetcher = null;
+    #customizedRateLimiter = null;
+    #useDefaultRateLimiter = false;
 
     /**
     * Constructs a new ApiClient.
@@ -180,17 +211,19 @@ export class ApiClient {
 
         /**
          * The authentication methods to be included for all API calls.
-         * @type {Array.<String>}
+         * @type {Array<String>}
          */
         this.authentications = {
         }
 
         /**
          * The default HTTP headers to be included for all API calls.
-         * @type {Array.<String>}
+         * @type {Array<String>}
          * @default {}
          */
-        this.defaultHeaders = {};
+        this.defaultHeaders = {
+            'User-Agent': 'amazon-selling-partner-api-sdk/1.0.0/JavaScript'
+        };
 
         /**
          * The default HTTP timeout for all API calls.
@@ -228,16 +261,51 @@ export class ApiClient {
          this.requestAgent = null;
     }
 
+    /**
+    * Initialize #defaultRateLimitFetcher
+    */
+    async initializeDefaultRateLimit() {
+        try {
+            this.#defaultRateLimitFetcher = await DefaultRateLimitFetcher.getInstance();
+        } catch (err) {
+            throw new Error('Error reading default rate limit:', err);
+        } 
+    }
+
+    /**
+    * Enable default rate limiter
+    */
+    enableDefaultRateLimiter() {
+        this.#useDefaultRateLimiter = true;
+        this.#customizedRateLimiter = null;
+    }
+
+    /**
+    * Set customized rate limiter
+    * @param {RateLimitConfiguration} config
+    */
+    enableCustomizedRateLimiter(config) {
+        this.#customizedRateLimiter = new SuperagentRateLimiter(config);
+        this.#useDefaultRateLimiter = false;
+    }
+
+    /**
+    * Disable both customized and default rate limiter
+    */
+    disableRatelimiter() {
+        this.#customizedRateLimiter = null;
+        this.defaultRateLimiter = false;
+    }
+
     /**
     * Returns this ApiClient so that you can chain the methods.
     * @param {String} clientId LWA client ID.
     * @param {String} clientSecret LWA client secret.
     * @param {String} refreshToken LWA refresh token.
-    * @param {Array.<String>} dataElementsOption specify PII information to get from "buyerInfo", "shippingAddress" and "buyerTaxInformation".
+    * @param {Array<String>} dataElementsOption specify PII information to get from "buyerInfo", "shippingAddress" and "buyerTaxInformation".
     * @returns {ApiClient} This ApiClient, which is going to use give accessToken for all API calls.
     */
     enableAutoRetrievalRestrictedDataToken(clientId, clientSecret, refreshToken, dataElementsOption) {
-        // TODO
         if (!clientId || !clientSecret || !refreshToken) {
             throw new Error('invalid parameter(s) to enableAutoRetrievalRestrictedDataToken.');
         }
@@ -249,17 +317,28 @@ export class ApiClient {
     * Returns this ApiClient so that you can chain the methods.
     * @param {String} clientId LWA client ID.
     * @param {String} clientSecret LWA client secret.
-    * @param {String} refreshToken LWA refresh token.
+    * @param {String|null} refreshToken LWA refresh token.
+    * @param {String|null} scope LWA scope(s) for grantless operations.
     * @returns {ApiClient} This ApiClient, which is going to use give accessToken for all API calls.
     */
-    enableAutoRetrievalAccessToken(clientId, clientSecret, refreshToken) {
-        if (!clientId || !clientSecret || !refreshToken) {
-            throw new Error('invalid parameter(s) to enableAutoRetrievalAccessToken.');
+    enableAutoRetrievalAccessToken(clientId, clientSecret, refreshToken = null, scope = null) {
+        if (!clientId || !clientSecret) {
+            throw new Error('invalid parameter(s) to enableAutoRetrievalAccessToken: clientId or clientSecret is null or undefined.');
+        } else if ((!refreshToken && !scope) || (refreshToken && scope)) {
+            throw new Error('invalid parameter(s) to enableAutoRetrievalAccessToken: either refreshToken or scope must be defined.');
         }
-        this.#lwaClient = new LwaOAuthClient(clientId, clientSecret, refreshToken);
+        this.#lwaClient = new LwaOAuthClient(clientId, clientSecret, refreshToken, scope);
         return this;
     }
 
+    /**
+     * Clear Token Cache
+     */
+    clearAccessTokenCache() {
+        if (this.#lwaClient) {
+            this.#lwaClient.clearCachedTokenMap();
+        }
+    }
 
     /**
     * Returns this ApiClient so that you can chain the methods.
@@ -271,6 +350,19 @@ export class ApiClient {
         return this;
     }
 
+    /**
+    * Applies authentication headers to the request.
+    * @param {String} accessOrRdtToken Either Access Token or Restricted Data Token to add as 'x-amz-access-token'.
+    * @returns {ApiClient} This ApiClient, which is going to use give RDT for all API calls.
+    */
+    applyXAmzAccessTokenToRequest(accessOrRdtToken) {
+        if (!accessOrRdtToken) {
+            throw new Error('empty string, null or undefined passed to applyXAmzAccessTokenToRequest');
+        }
+        this.#tokenForApiCall = accessOrRdtToken;
+        return this;
+    }    
+
     /**
     * Returns a string representation for an actual parameter.
     * @param param The actual parameter.
@@ -283,7 +375,6 @@ export class ApiClient {
         if (param instanceof Date) {
             return param.toJSON();
         }
-
         return param.toString();
     }
 
@@ -298,7 +389,6 @@ export class ApiClient {
         if (!path.match(/^\//)) {
             path = '/' + path;
         }
-
         var url = this.basePath + path;
         url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
             var value;
@@ -307,10 +397,8 @@ export class ApiClient {
             } else {
                 value = fullMatch;
             }
-
             return encodeURIComponent(value);
         });
-
         return url;
     }
 
@@ -331,7 +419,7 @@ export class ApiClient {
 
     /**
     * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
-    * @param {Array.<String>} contentTypes
+    * @param {Array<String>} contentTypes
     * @returns {String} The chosen content type, preferring JSON.
     */
     jsonPreferredMime(contentTypes) {
@@ -340,7 +428,6 @@ export class ApiClient {
                 return contentTypes[i];
             }
         }
-
         return contentTypes[0];
     }
 
@@ -386,8 +473,8 @@ export class ApiClient {
     * <li>keep files and arrays</li>
     * <li>format to string with `paramToString` for other cases</li>
     * </ul>
-    * @param {Object.<String, Object>} params The parameters as object properties.
-    * @returns {Object.<String, Object>} normalized parameters.
+    * @param {Object<String, Object>} params The parameters as object properties.
+    * @returns {Object<String, Object>} normalized parameters.
     */
     normalizeParams(params) {
         var newParams = {};
@@ -401,7 +488,6 @@ export class ApiClient {
                 }
             }
         }
-
         return newParams;
     }
 
@@ -470,23 +556,10 @@ export class ApiClient {
         }
     }
 
-    /**
-    * Applies authentication headers to the request.
-    * @param {String} accessOrRdtToken Either Access Token or Restricted Data Token to add as 'x-amz-access-token'.
-    * @returns {ApiClient} This ApiClient, which is going to use give RDT for all API calls.
-    */
-    applyXAmzAccessTokenToRequest(accessOrRdtToken) {
-        if (!accessOrRdtToken) {
-            throw new Error('empty string, null or undefined passed to applyXAmzAccessTokenToRequest');
-        }
-        this.#tokenForApiCall = accessOrRdtToken;
-        return this;
-    }
-
     /**
     * Deserializes an HTTP response body into a value of the specified type.
     * @param {Object} response A SuperAgent response object.
-    * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType The type to return. Pass a string for simple types
+    * @param {(String|Array<String>|Object<String, Object>|Function)} returnType The type to return. Pass a string for simple types
     * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
     * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
     * all properties on <code>data<code> will be converted to this type.
@@ -512,20 +585,21 @@ export class ApiClient {
 
     /**
     * Invokes the REST service using the supplied settings and parameters.
+    * @param {String} operation operation name.
     * @param {String} path The base URL to invoke.
     * @param {String} httpMethod The HTTP method to use.
-    * @param {Object.<String, String>} pathParams A map of path parameters and their values.
-    * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
-    * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
-    * @param {Object.<String, Object>} formParams A map of form parameters and their values.
+    * @param {Object<String, String>} pathParams A map of path parameters and their values.
+    * @param {Object<String, Object>} queryParams A map of query parameters and their values.
+    * @param {Object<String, Object>} headerParams A map of header parameters and their values.
+    * @param {Object<String, Object>} formParams A map of form parameters and their values.
     * @param {Object} bodyParam The value to pass as the request body.
-    * @param {Array.<String>} contentTypes An array of request MIME types.
-    * @param {Array.<String>} accepts An array of acceptable response MIME types.
+    * @param {Array<String>} contentTypes An array of request MIME types.
+    * @param {Array<String>} accepts An array of acceptable response MIME types.
     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
     * constructor for a complex type.
     * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
     */
-    async callApi(path, httpMethod, pathParams,
+    async callApi(operation, path, httpMethod, pathParams,
         queryParams, headerParams, formParams, bodyParam, contentTypes, accepts,
         returnType) {
 
@@ -535,6 +609,16 @@ export class ApiClient {
             throw new Error('none of accessToken, RDT token and auto-retrieval is set.');
         }
 
+        //Set rate limiter
+        if (this.#useDefaultRateLimiter) {
+            await this.initializeDefaultRateLimit();
+            const defaultRateLimiter = new SuperagentRateLimiter(this.#defaultRateLimitFetcher.getLimit(operation));
+            request.use(defaultRateLimiter.getPlugin());
+        } else if (this.#customizedRateLimiter) {
+            request.use(this.#customizedRateLimiter.getPlugin());
+        }
+        
+
         // set query parameters
         if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {
             queryParams['_'] = new Date().getTime();
@@ -625,7 +709,6 @@ export class ApiClient {
                         if (this.enableCookies && typeof window === 'undefined'){
                             this.agent.saveCookies(response);
                         }
-
                         resolve({data, response});
                     } catch (err) {
                         reject(err);
@@ -649,7 +732,7 @@ export class ApiClient {
     /**
     * Converts a value to the specified type.
     * @param {(String|Object)} data The data to convert, as a string or object.
-    * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
+    * @param {(String|Array<String>|Object<String, Object>|Function)} type The type to return. Pass a string for simple types
     * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
     * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
     * all properties on <code>data<code> will be converted to this type.
@@ -682,7 +765,6 @@ export class ApiClient {
                 } else if (Array.isArray(type)) {
                     // for array type like: ['String']
                     var itemType = type[0];
-
                     return data.map((item) => {
                         return ApiClient.convertToType(item, itemType);
                     });

package/src/vendordftransactions_v2021_12_28/api/VendorTransactionApi.js

@@ -64,7 +64,7 @@ export class VendorTransactionApi {
       let accepts = ['application/json'];
       let returnType = TransactionStatus;
 
-      return this.apiClient.callApi(
+      return this.apiClient.callApi( 'VendorTransactionApi-getTransactionStatus',
         '/vendor/directFulfillment/transactions/2021-12-28/transactions/{transactionId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         contentTypes, accepts, returnType