@sp-api-sdk/shipping-api-v1 1.7.2 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +25 -0
  2. package/dist/cjs/index.js +0 -1
  3. package/dist/cjs/src/client.js +12 -21
  4. package/dist/es/index.js +0 -1
  5. package/dist/es/src/client.js +13 -22
  6. package/dist/types/index.d.ts +0 -1
  7. package/dist/types/src/client.d.ts +2 -9
  8. package/package.json +6 -5
  9. package/dist/cjs/src/error.js +0 -10
  10. package/dist/es/src/error.js +0 -6
  11. package/dist/types/src/error.d.ts +0 -3
package/README.md CHANGED
@@ -64,6 +64,31 @@ const client = new ShippingApiClient({
64
64
 
65
65
  The rate limits used for each route are specified in the [API documentation](https://developer-docs.amazon.com/sp-api/docs).
66
66
 
67
+ ## Logging
68
+
69
+ You can enable logging for both SP-API requests and responses by configuring the `logging.request` and `logging.response` properties.
70
+
71
+ ```javascript
72
+ const client = new ShippingApiClient({
73
+ auth,
74
+ region: 'eu',
75
+ logging: {
76
+ request: {
77
+ logger: console.debug
78
+ },
79
+ response: {
80
+ logger: console.debug
81
+ },
82
+ error: true,
83
+ },
84
+ })
85
+ ```
86
+
87
+ Specifying `true` will use the default options, specifying an object will allow you to override the default options.
88
+ This uses [axios-logger](https://github.com/hg-pyun/axios-logger) under the hood.
89
+ By default, if enabled, the `request` and `response` loggers will use `console.info` and the `error` logger will use `console.error`.
90
+
91
+
67
92
  ## License
68
93
 
69
94
  MIT
package/dist/cjs/index.js CHANGED
@@ -2,5 +2,4 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
4
  tslib_1.__exportStar(require("./src/client"), exports);
5
- tslib_1.__exportStar(require("./src/error"), exports);
6
5
  tslib_1.__exportStar(require("./src/api-model/models"), exports);
package/dist/cjs/src/client.js CHANGED
@@ -1,86 +1,77 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ShippingApiClient = exports.clientRateLimits = void 0;
4
- /* eslint-disable prefer-regex-literals */
5
4
  const common_1 = require("@sp-api-sdk/common");
6
5
  const api_model_1 = require("./api-model");
7
- const error_1 = require("./error");
8
6
  exports.clientRateLimits = [
9
7
  {
10
8
  method: 'post',
9
+ // eslint-disable-next-line prefer-regex-literals
11
10
  urlRegex: new RegExp('^/shipping/v1/shipments$'),
12
11
  rate: 5,
13
12
  burst: 15,
14
13
  },
15
14
  {
16
15
  method: 'get',
16
+ // eslint-disable-next-line prefer-regex-literals
17
17
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*$'),
18
18
  rate: 5,
19
19
  burst: 15,
20
20
  },
21
21
  {
22
22
  method: 'post',
23
+ // eslint-disable-next-line prefer-regex-literals
23
24
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/cancel$'),
24
25
  rate: 5,
25
26
  burst: 15,
26
27
  },
27
28
  {
28
29
  method: 'post',
30
+ // eslint-disable-next-line prefer-regex-literals
29
31
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/purchaseLabels$'),
30
32
  rate: 5,
31
33
  burst: 15,
32
34
  },
33
35
  {
34
36
  method: 'post',
37
+ // eslint-disable-next-line prefer-regex-literals
35
38
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/label$'),
36
39
  rate: 5,
37
40
  burst: 15,
38
41
  },
39
42
  {
40
43
  method: 'post',
44
+ // eslint-disable-next-line prefer-regex-literals
41
45
  urlRegex: new RegExp('^/shipping/v1/purchaseShipment$'),
42
46
  rate: 5,
43
47
  burst: 15,
44
48
  },
45
49
  {
46
50
  method: 'post',
51
+ // eslint-disable-next-line prefer-regex-literals
47
52
  urlRegex: new RegExp('^/shipping/v1/rates$'),
48
53
  rate: 5,
49
54
  burst: 15,
50
55
  },
51
56
  {
52
57
  method: 'get',
58
+ // eslint-disable-next-line prefer-regex-literals
53
59
  urlRegex: new RegExp('^/shipping/v1/account$'),
54
60
  rate: 5,
55
61
  burst: 15,
56
62
  },
57
63
  {
58
64
  method: 'get',
65
+ // eslint-disable-next-line prefer-regex-literals
59
66
  urlRegex: new RegExp('^/shipping/v1/tracking/[^/]*$'),
60
67
  rate: 1,
61
68
  burst: 1,
62
69
  },
63
70
  ];
64
71
  class ShippingApiClient extends api_model_1.ShippingApi {
65
- constructor(parameters) {
66
- const config = common_1.sellingPartnerRegions[parameters.region];
67
- if (!config) {
68
- throw new error_1.ShippingApiError(`Unknown region: ${parameters.region}`);
69
- }
70
- const { rateLimiting, ...clientParameters } = parameters;
71
- const axiosParameters = {
72
- ...clientParameters,
73
- region: config.awsRegion,
74
- };
75
- if (rateLimiting?.retry) {
76
- axiosParameters.rateLimits = exports.clientRateLimits;
77
- axiosParameters.onRetry = rateLimiting.onRetry;
78
- }
79
- const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
80
- const configuration = new api_model_1.Configuration();
81
- const environment = parameters.sandbox ? 'sandbox' : 'production';
82
- const endpoint = config.endpoints[environment];
83
- super(configuration, endpoint, axiosInstance);
72
+ constructor(configuration) {
73
+ const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
74
+ super(new api_model_1.Configuration(), endpoint, axios);
84
75
  }
85
76
  }
86
77
  exports.ShippingApiClient = ShippingApiClient;
package/dist/es/index.js CHANGED
@@ -1,3 +1,2 @@
1
1
  export * from './src/client';
2
- export * from './src/error';
3
2
  export * from './src/api-model/models';
package/dist/es/src/client.js CHANGED
@@ -1,82 +1,73 @@
1
- /* eslint-disable prefer-regex-literals */
2
- import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
1
+ import { createAxiosInstance } from '@sp-api-sdk/common';
3
2
  import { Configuration, ShippingApi } from './api-model';
4
- import { ShippingApiError } from './error';
5
3
  export const clientRateLimits = [
6
4
  {
7
5
  method: 'post',
6
+ // eslint-disable-next-line prefer-regex-literals
8
7
  urlRegex: new RegExp('^/shipping/v1/shipments$'),
9
8
  rate: 5,
10
9
  burst: 15,
11
10
  },
12
11
  {
13
12
  method: 'get',
13
+ // eslint-disable-next-line prefer-regex-literals
14
14
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*$'),
15
15
  rate: 5,
16
16
  burst: 15,
17
17
  },
18
18
  {
19
19
  method: 'post',
20
+ // eslint-disable-next-line prefer-regex-literals
20
21
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/cancel$'),
21
22
  rate: 5,
22
23
  burst: 15,
23
24
  },
24
25
  {
25
26
  method: 'post',
27
+ // eslint-disable-next-line prefer-regex-literals
26
28
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/purchaseLabels$'),
27
29
  rate: 5,
28
30
  burst: 15,
29
31
  },
30
32
  {
31
33
  method: 'post',
34
+ // eslint-disable-next-line prefer-regex-literals
32
35
  urlRegex: new RegExp('^/shipping/v1/shipments/[^/]*/label$'),
33
36
  rate: 5,
34
37
  burst: 15,
35
38
  },
36
39
  {
37
40
  method: 'post',
41
+ // eslint-disable-next-line prefer-regex-literals
38
42
  urlRegex: new RegExp('^/shipping/v1/purchaseShipment$'),
39
43
  rate: 5,
40
44
  burst: 15,
41
45
  },
42
46
  {
43
47
  method: 'post',
48
+ // eslint-disable-next-line prefer-regex-literals
44
49
  urlRegex: new RegExp('^/shipping/v1/rates$'),
45
50
  rate: 5,
46
51
  burst: 15,
47
52
  },
48
53
  {
49
54
  method: 'get',
55
+ // eslint-disable-next-line prefer-regex-literals
50
56
  urlRegex: new RegExp('^/shipping/v1/account$'),
51
57
  rate: 5,
52
58
  burst: 15,
53
59
  },
54
60
  {
55
61
  method: 'get',
62
+ // eslint-disable-next-line prefer-regex-literals
56
63
  urlRegex: new RegExp('^/shipping/v1/tracking/[^/]*$'),
57
64
  rate: 1,
58
65
  burst: 1,
59
66
  },
60
67
  ];
61
68
  export class ShippingApiClient extends ShippingApi {
62
- constructor(parameters) {
63
- const config = sellingPartnerRegions[parameters.region];
64
- if (!config) {
65
- throw new ShippingApiError(`Unknown region: ${parameters.region}`);
66
- }
67
- const { rateLimiting, ...clientParameters } = parameters;
68
- const axiosParameters = {
69
- ...clientParameters,
70
- region: config.awsRegion,
71
- };
72
- if (rateLimiting?.retry) {
73
- axiosParameters.rateLimits = clientRateLimits;
74
- axiosParameters.onRetry = rateLimiting.onRetry;
75
- }
76
- const axiosInstance = createAxiosInstance(axiosParameters);
77
- const configuration = new Configuration();
78
- const environment = parameters.sandbox ? 'sandbox' : 'production';
79
- const endpoint = config.endpoints[environment];
80
- super(configuration, endpoint, axiosInstance);
69
+ constructor(configuration) {
70
+ const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
71
+ super(new Configuration(), endpoint, axios);
81
72
  }
82
73
  }
package/dist/types/index.d.ts CHANGED
@@ -1,3 +1,2 @@
1
1
  export * from './src/client';
2
- export * from './src/error';
3
2
  export * from './src/api-model/models';
package/dist/types/src/client.d.ts CHANGED
@@ -1,13 +1,6 @@
1
- import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
1
+ import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
2
  import { ShippingApi } from './api-model';
3
3
  export declare const clientRateLimits: RateLimit[];
4
- export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
5
- region: SellingPartnerRegion;
6
- rateLimiting?: {
7
- retry: boolean;
8
- onRetry?: OnRetryHandler;
9
- };
10
- }
11
4
  export declare class ShippingApiClient extends ShippingApi {
12
- constructor(parameters: ClientParameters);
5
+ constructor(configuration: ClientConfiguration);
13
6
  }
package/package.json CHANGED
@@ -2,10 +2,11 @@
2
2
  "name": "@sp-api-sdk/shipping-api-v1",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "Provides programmatic access to Amazon Shipping APIs.",
5
- "version": "1.7.2",
5
+ "version": "1.8.1",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
9
+ "typedocMain": "./index.ts",
9
10
  "license": "MIT",
10
11
  "publishConfig": {
11
12
  "access": "public"
@@ -26,9 +27,9 @@
26
27
  "test": "NODE_ENV='test' yarn jest"
27
28
  },
28
29
  "dependencies": {
29
- "@sp-api-sdk/auth": "^1.9.11",
30
- "@sp-api-sdk/common": "^1.7.13",
31
- "axios": "^0.26.1"
30
+ "@sp-api-sdk/auth": "^1.9.14",
31
+ "@sp-api-sdk/common": "^1.9.0",
32
+ "axios": "^0.27.2"
32
33
  },
33
34
  "repository": {
34
35
  "type": "git",
@@ -49,5 +50,5 @@
49
50
  "sp sdk",
50
51
  "shipping api"
51
52
  ],
52
- "gitHead": "61adb3dd4480de30ba48c20a1da60cebf9d4f0ac"
53
+ "gitHead": "15c172555c85ce89731cebb62eb7e23f550f9506"
53
54
  }
package/dist/cjs/src/error.js DELETED
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ShippingApiError = void 0;
4
- class ShippingApiError extends Error {
5
- constructor(message) {
6
- super(message);
7
- this.name = 'ShippingApiError';
8
- }
9
- }
10
- exports.ShippingApiError = ShippingApiError;
package/dist/es/src/error.js DELETED
@@ -1,6 +0,0 @@
1
- export class ShippingApiError extends Error {
2
- constructor(message) {
3
- super(message);
4
- this.name = 'ShippingApiError';
5
- }
6
- }
package/dist/types/src/error.d.ts DELETED
@@ -1,3 +0,0 @@
1
- export declare class ShippingApiError extends Error {
2
- constructor(message: string);
3
- }