@sp-api-sdk/shipping-api-v1 1.7.3 → 1.8.2

package/README.md

@@ -64,6 +64,31 @@ const client = new ShippingApiClient({
 
 The rate limits used for each route are specified in the [API documentation](https://developer-docs.amazon.com/sp-api/docs).
 
+## Logging
+
+You can enable logging for both SP-API requests and responses by configuring the `logging.request` and `logging.response` properties.
+
+```javascript
+const client = new ShippingApiClient({
+  auth,
+  region: 'eu',
+  logging: {
+    request: {
+      logger: console.debug
+    },
+    response: {
+      logger: console.debug
+    },
+    error: true,
+  },
+})
+```
+
+Specifying `true` will use the default options, specifying an object will allow you to override the default options.  
+This uses [axios-logger](https://github.com/hg-pyun/axios-logger) under the hood.  
+By default, if enabled, the `request` and `response` loggers will use `console.info` and the `error` logger will use `console.error`.
+
+
 ## License
 
 MIT

package/dist/cjs/index.js

@@ -2,5 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./src/client"), exports);
-tslib_1.__exportStar(require("./src/error"), exports);
 tslib_1.__exportStar(require("./src/api-model/models"), exports);

package/dist/cjs/src/client.js

@@ -1,86 +1,77 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShippingApiClient = exports.clientRateLimits = void 0;
-/* eslint-disable prefer-regex-literals */
 const common_1 = require("@sp-api-sdk/common");
 const api_model_1 = require("./api-model");
-const error_1 = require("./error");
 exports.clientRateLimits = [
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/cancel$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/purchaseLabels$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/label$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/purchaseShipment$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/rates$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/account$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/tracking/[^/]*$'),
         rate: 1,
         burst: 1,
     },
 ];
 class ShippingApiClient extends api_model_1.ShippingApi {
-    constructor(parameters) {
-        const config = common_1.sellingPartnerRegions[parameters.region];
-        if (!config) {
-            throw new error_1.ShippingApiError(`Unknown region: ${parameters.region}`);
-        }
-        const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = {
-            ...clientParameters,
-            region: config.awsRegion,
-        };
-        if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = exports.clientRateLimits;
-            axiosParameters.onRetry = rateLimiting.onRetry;
-        }
-        const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
-        const configuration = new api_model_1.Configuration();
-        const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = config.endpoints[environment];
-        super(configuration, endpoint, axiosInstance);
+    constructor(configuration) {
+        const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
+        super(new api_model_1.Configuration(), endpoint, axios);
     }
 }
 exports.ShippingApiClient = ShippingApiClient;

package/dist/es/index.js

@@ -1,3 +1,2 @@
 export * from './src/client';
-export * from './src/error';
 export * from './src/api-model/models';

package/dist/es/src/client.js

@@ -1,82 +1,73 @@
-/* eslint-disable prefer-regex-literals */
-import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
+import { createAxiosInstance } from '@sp-api-sdk/common';
 import { Configuration, ShippingApi } from './api-model';
-import { ShippingApiError } from './error';
 export const clientRateLimits = [
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/cancel$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/purchaseLabels$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/label$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/purchaseShipment$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'post',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/rates$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/account$'),
         rate: 5,
         burst: 15,
     },
     {
         method: 'get',
+        // eslint-disable-next-line prefer-regex-literals
         urlRegex: new RegExp('^/shipping/v1/tracking/[^/]*$'),
         rate: 1,
         burst: 1,
     },
 ];
 export class ShippingApiClient extends ShippingApi {
-    constructor(parameters) {
-        const config = sellingPartnerRegions[parameters.region];
-        if (!config) {
-            throw new ShippingApiError(`Unknown region: ${parameters.region}`);
-        }
-        const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = {
-            ...clientParameters,
-            region: config.awsRegion,
-        };
-        if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = clientRateLimits;
-            axiosParameters.onRetry = rateLimiting.onRetry;
-        }
-        const axiosInstance = createAxiosInstance(axiosParameters);
-        const configuration = new Configuration();
-        const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = config.endpoints[environment];
-        super(configuration, endpoint, axiosInstance);
+    constructor(configuration) {
+        const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
+        super(new Configuration(), endpoint, axios);
     }
 }

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
 export * from './src/client';
-export * from './src/error';
 export * from './src/api-model/models';

package/dist/types/src/client.d.ts

@@ -1,13 +1,6 @@
-import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
 import { ShippingApi } from './api-model';
 export declare const clientRateLimits: RateLimit[];
-export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
-    region: SellingPartnerRegion;
-    rateLimiting?: {
-        retry: boolean;
-        onRetry?: OnRetryHandler;
-    };
-}
 export declare class ShippingApiClient extends ShippingApi {
-    constructor(parameters: ClientParameters);
+    constructor(configuration: ClientConfiguration);
 }

package/package.json

@@ -2,10 +2,11 @@
   "name": "@sp-api-sdk/shipping-api-v1",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "Provides programmatic access to Amazon Shipping APIs.",
-  "version": "1.7.3",
+  "version": "1.8.2",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
+  "typedocMain": "./index.ts",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -26,8 +27,8 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.12",
-    "@sp-api-sdk/common": "^1.7.14",
+    "@sp-api-sdk/auth": "^1.9.15",
+    "@sp-api-sdk/common": "^1.9.1",
     "axios": "^0.27.2"
   },
   "repository": {
@@ -49,5 +50,5 @@
     "sp sdk",
     "shipping api"
   ],
-  "gitHead": "e6a6c9da0de5a001da60b1d3f34a3796a3adab0d"
+  "gitHead": "e49e4267a61beba2869d509719731bea6cc2c6d8"
 }

package/dist/cjs/src/error.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShippingApiError = void 0;
-class ShippingApiError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'ShippingApiError';
-    }
-}
-exports.ShippingApiError = ShippingApiError;

package/dist/es/src/error.js

@@ -1,6 +0,0 @@
-export class ShippingApiError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'ShippingApiError';
-    }
-}

package/dist/types/src/error.d.ts

@@ -1,3 +0,0 @@
-export declare class ShippingApiError extends Error {
-    constructor(message: string);
-}