ebay-api 8.7.1 → 8.7.2-RC.0

package/README.md

@@ -21,7 +21,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v8.7.1` is the latest release.
+* `v8.7.2-RC.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status

package/dist/api/digitalSignature.d.ts

@@ -1,4 +1,5 @@
 import { Cipher, Headers } from '../types/index.js';
+export declare const getUnixTimestamp: () => number;
 export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
 export type SignatureComponents = {
     method: string;

package/dist/api/digitalSignature.js

@@ -1,7 +1,7 @@
 import { createHash, sign } from 'crypto';
 const beginPrivateKey = '-----BEGIN PRIVATE KEY-----';
 const endPrivateKey = '-----END PRIVATE KEY-----';
-const getUnixTimestamp = () => Date.now() / 1000 | 0;
+export const getUnixTimestamp = () => Math.floor(Date.now() / 1000);
 const getSignatureParams = (payload) => [
     ...payload ? ['content-digest'] : [],
     'x-ebay-signature-key',

package/dist/api/index.js

@@ -1,6 +1,6 @@
 import Auth from '../auth/index.js';
 import Base from './base.js';
-import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
+import { generateContentDigestValue, generateSignature, generateSignatureInput, getUnixTimestamp } from './digitalSignature.js';
 export default class Api extends Base {
     constructor(config, req, auth) {
         super(config, req);
@@ -10,17 +10,18 @@ export default class Api extends Base {
         if (!this.config.signature) {
             return {};
         }
+        const timestamp = getUnixTimestamp();
         const digitalSignatureHeaders = {
             'x-ebay-enforce-signature': true,
             'x-ebay-signature-key': this.config.signature.jwe,
             ...payload ? {
                 'content-digest': generateContentDigestValue(payload, this.config.signature.cipher ?? 'sha256')
             } : {},
-            'signature-input': generateSignatureInput(payload)
+            'signature-input': generateSignatureInput(payload, timestamp)
         };
         return {
             ...digitalSignatureHeaders,
-            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload)
+            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload, timestamp)
         };
     }
 }

package/dist/api/restful/sell/analytics/index.d.ts

@@ -9,7 +9,7 @@ export default class Analytics extends Restful implements OpenApi<operations> {
     getTrafficReport({ dimension, filter, metric, sort }?: {
         dimension?: string;
         filter?: string;
-        metric?: Metric | `${Metric}`;
+        metric?: string | Metric | `${Metric}`;
         sort?: string;
     }): Promise<any>;
     getCustomerServiceMetric(customerServiceMetricType: string, evaluationType: string): Promise<any>;

package/dist/api/traditional/index.d.ts

@@ -8,6 +8,7 @@ export default class Traditional extends Api {
     createMerchandisingApi(): Merchandising;
     createBusinessPolicyManagementApi(): void;
     private createXMLRequest;
+    private shouldRefreshToken;
     private request;
     private getConfig;
     private createTraditionalXMLApi;

package/dist/api/traditional/index.js

@@ -1,5 +1,5 @@
 import { stringify } from 'qs';
-import { EBayIAFTokenExpired, EBayIAFTokenInvalid, handleEBayError } from '../../errors/index.js';
+import { EBayAuthTokenIsHardExpired, EBayIAFTokenExpired, EBayIAFTokenInvalid, handleEBayError } from '../../errors/index.js';
 import Api from '../index.js';
 import ClientAlertsCalls from './clientAlerts/index.js';
 import FindingCalls from './finding/index.js';
@@ -16,7 +16,7 @@ export default class Traditional extends Api {
                 return await this.request(apiConfig, api, callName, fields);
             }
             catch (error) {
-                if (this.config.autoRefreshToken && (error.name === EBayIAFTokenExpired.name || error.name === EBayIAFTokenInvalid.name)) {
+                if (this.shouldRefreshToken(error)) {
                     return await this.request(apiConfig, api, callName, fields, true);
                 }
                 throw error;
@@ -140,6 +140,14 @@ export default class Traditional extends Api {
     createBusinessPolicyManagementApi() {
         throw new Error('Important! This API is deprecated and will be decommissioned on January 31, 2022. We recommend that you migrate to the fulfillment_policy, payment_policy, and return_policy resources of the Account API to set up and manage all of your fulfillment, payment, and return business policies.');
     }
+    shouldRefreshToken(error) {
+        if (!this.config.autoRefreshToken) {
+            return false;
+        }
+        return error.name === EBayIAFTokenExpired.name
+            || error.name === EBayIAFTokenInvalid.name
+            || error.name === EBayAuthTokenIsHardExpired.name;
+    }
     async request(apiConfig, api, callName, fields, refreshToken = false) {
         try {
             if (refreshToken) {

package/dist/auth/oAuth2.d.ts

@@ -1,5 +1,5 @@
-import { EventCallback } from '../nanoevents.js';
 import Base from '../api/base.js';
+import { EventCallback } from '../nanoevents.js';
 import { IEBayApiRequest } from '../request.js';
 import { AppConfig, Scope } from '../types/index.js';
 export type Token = {

package/dist/auth/oAuth2.js

@@ -1,6 +1,6 @@
 import debug from 'debug';
-import { createNanoEvents } from '../nanoevents.js';
 import Base from '../api/base.js';
+import { createNanoEvents } from '../nanoevents.js';
 const log = debug('ebay:oauth2');
 class OAuth2 extends Base {
     constructor(config, req) {
@@ -60,13 +60,13 @@ class OAuth2 extends Base {
             throw new Error('Missing Cert Id (Client Secret)');
         }
         try {
-            const response = await this.req.postForm(this.identityEndpoint, {
+            const response = await this.req.post(this.identityEndpoint, {
                 scope: this.scope.join(' '),
-                grant_type: 'client_credentials'
+                grant_type: 'client_credentials',
             }, {
-                auth: {
-                    username: this.config.appId,
-                    password: this.config.certId
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                    'Authorization': 'Basic ' + btoa(this.config.appId + ':' + this.config.certId)
                 }
             });
             return response.data;
@@ -98,15 +98,21 @@ class OAuth2 extends Base {
         return OAuth2.generateAuthUrl(this.config.sandbox, this.config.appId, ruName, scope, state);
     }
     async mintUserAccessToken(code, ruName = this.config.ruName) {
+        if (!this.config.appId) {
+            throw new Error('Missing App ID (Client Id)');
+        }
+        if (!this.config.certId) {
+            throw new Error('Missing Cert Id (Client Secret)');
+        }
         try {
-            const response = await this.req.postForm(this.identityEndpoint, {
+            const response = await this.req.post(this.identityEndpoint, {
                 grant_type: 'authorization_code',
                 code,
                 redirect_uri: ruName
             }, {
-                auth: {
-                    username: this.config.appId,
-                    password: this.config.certId
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                    'Authorization': 'Basic ' + btoa(this.config.appId + ':' + this.config.certId)
                 }
             });
             const token = response.data;
@@ -127,14 +133,14 @@ class OAuth2 extends Base {
             throw new Error('Failed to refresh the user access token. Token or refresh_token is not set.');
         }
         try {
-            const response = await this.req.postForm(this.identityEndpoint, {
+            const response = await this.req.post(this.identityEndpoint, {
                 grant_type: 'refresh_token',
                 refresh_token: this._authToken.refresh_token,
                 scope: this.scope.join(' ')
             }, {
-                auth: {
-                    username: this.config.appId,
-                    password: this.config.certId
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                    'Authorization': 'Basic ' + btoa(this.config.appId + ':' + this.config.certId)
                 }
             });
             const token = response.data;