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

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.
package/README.md CHANGED
@@ -64,6 +64,31 @@ const client = new SellersApiClient({
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 SellersApiClient({
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);
@@ -1,38 +1,21 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SellersApiClient = 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: 'get',
9
+ // eslint-disable-next-line prefer-regex-literals
11
10
  urlRegex: new RegExp('^/sellers/v1/marketplaceParticipations$'),
12
11
  rate: 0.016,
13
12
  burst: 15,
14
13
  },
15
14
  ];
16
15
  class SellersApiClient extends api_model_1.SellersApi {
17
- constructor(parameters) {
18
- const config = common_1.sellingPartnerRegions[parameters.region];
19
- if (!config) {
20
- throw new error_1.SellersApiError(`Unknown region: ${parameters.region}`);
21
- }
22
- const { rateLimiting, ...clientParameters } = parameters;
23
- const axiosParameters = {
24
- ...clientParameters,
25
- region: config.awsRegion,
26
- };
27
- if (rateLimiting?.retry) {
28
- axiosParameters.rateLimits = exports.clientRateLimits;
29
- axiosParameters.onRetry = rateLimiting.onRetry;
30
- }
31
- const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
32
- const configuration = new api_model_1.Configuration();
33
- const environment = parameters.sandbox ? 'sandbox' : 'production';
34
- const endpoint = config.endpoints[environment];
35
- super(configuration, endpoint, axiosInstance);
16
+ constructor(configuration) {
17
+ const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
18
+ super(new api_model_1.Configuration(), endpoint, axios);
36
19
  }
37
20
  }
38
21
  exports.SellersApiClient = SellersApiClient;
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';
@@ -1,34 +1,17 @@
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, SellersApi } from './api-model';
4
- import { SellersApiError } from './error';
5
3
  export const clientRateLimits = [
6
4
  {
7
5
  method: 'get',
6
+ // eslint-disable-next-line prefer-regex-literals
8
7
  urlRegex: new RegExp('^/sellers/v1/marketplaceParticipations$'),
9
8
  rate: 0.016,
10
9
  burst: 15,
11
10
  },
12
11
  ];
13
12
  export class SellersApiClient extends SellersApi {
14
- constructor(parameters) {
15
- const config = sellingPartnerRegions[parameters.region];
16
- if (!config) {
17
- throw new SellersApiError(`Unknown region: ${parameters.region}`);
18
- }
19
- const { rateLimiting, ...clientParameters } = parameters;
20
- const axiosParameters = {
21
- ...clientParameters,
22
- region: config.awsRegion,
23
- };
24
- if (rateLimiting?.retry) {
25
- axiosParameters.rateLimits = clientRateLimits;
26
- axiosParameters.onRetry = rateLimiting.onRetry;
27
- }
28
- const axiosInstance = createAxiosInstance(axiosParameters);
29
- const configuration = new Configuration();
30
- const environment = parameters.sandbox ? 'sandbox' : 'production';
31
- const endpoint = config.endpoints[environment];
32
- super(configuration, endpoint, axiosInstance);
13
+ constructor(configuration) {
14
+ const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
15
+ super(new Configuration(), endpoint, axios);
33
16
  }
34
17
  }
@@ -1,3 +1,2 @@
1
1
  export * from './src/client';
2
- export * from './src/error';
3
2
  export * from './src/api-model/models';
@@ -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 { SellersApi } 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 SellersApiClient extends SellersApi {
12
- constructor(parameters: ClientParameters);
5
+ constructor(configuration: ClientConfiguration);
13
6
  }
package/package.json CHANGED
@@ -2,10 +2,11 @@
2
2
  "name": "@sp-api-sdk/sellers-api-v1",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace.",
5
- "version": "1.7.3",
5
+ "version": "1.8.2",
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,8 +27,8 @@
26
27
  "test": "NODE_ENV='test' yarn jest"
27
28
  },
28
29
  "dependencies": {
29
- "@sp-api-sdk/auth": "^1.9.12",
30
- "@sp-api-sdk/common": "^1.7.14",
30
+ "@sp-api-sdk/auth": "^1.9.15",
31
+ "@sp-api-sdk/common": "^1.9.1",
31
32
  "axios": "^0.27.2"
32
33
  },
33
34
  "repository": {
@@ -49,5 +50,5 @@
49
50
  "sp sdk",
50
51
  "sellers api"
51
52
  ],
52
- "gitHead": "e6a6c9da0de5a001da60b1d3f34a3796a3adab0d"
53
+ "gitHead": "e49e4267a61beba2869d509719731bea6cc2c6d8"
53
54
  }
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SellersApiError = void 0;
4
- class SellersApiError extends Error {
5
- constructor(message) {
6
- super(message);
7
- this.name = 'SellersApiError';
8
- }
9
- }
10
- exports.SellersApiError = SellersApiError;
@@ -1,6 +0,0 @@
1
- export class SellersApiError extends Error {
2
- constructor(message) {
3
- super(message);
4
- this.name = 'SellersApiError';
5
- }
6
- }
@@ -1,3 +0,0 @@
1
- export declare class SellersApiError extends Error {
2
- constructor(message: string);
3
- }