ebay-api 8.4.1 → 8.5.0

package/README.md

@@ -21,7 +21,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v8.4.1` is the latest release.
+* `v8.5.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/apiFactory.d.ts

@@ -1,27 +1,27 @@
-import { ClientAlerts, Finding, Shopping, Trading, Merchandising } from '../types/index.js';
-import Api from './index.js';
-import { Buy } from './restful/buy/index.js';
-import { Commerce } from './restful/commerce/index.js';
-import { Developer } from './restful/developer/index.js';
-import { PostOrder } from './restful/postOrder/index.js';
-import { Sell } from './restful/sell/index.js';
-import Traditional from './traditional/index.js';
-/**
- * Factory class to create RESTFul API or Traditional API.
- */
-export default class ApiFactory extends Api {
-    private _traditional?;
-    private _restful;
-    createBuyApi(): Buy;
-    createCommerceApi(): Commerce;
-    createDeveloperApi(): Developer;
-    createPostOrderApi(): PostOrder;
-    createSellApi(): Sell;
-    get traditional(): Traditional;
-    createTradingApi(): Trading;
-    createShoppingApi(): Shopping;
-    createFindingApi(): Finding;
-    createClientAlertsApi(): ClientAlerts;
-    createMerchandisingApi(): Merchandising;
-    private createRestfulApi;
-}
+import { ClientAlerts, Finding, Shopping, Trading, Merchandising } from '../types/index.js';
+import Api from './index.js';
+import { Buy } from './restful/buy/index.js';
+import { Commerce } from './restful/commerce/index.js';
+import { Developer } from './restful/developer/index.js';
+import { PostOrder } from './restful/postOrder/index.js';
+import { Sell } from './restful/sell/index.js';
+import Traditional from './traditional/index.js';
+/**
+ * Factory class to create RESTFul API or Traditional API.
+ */
+export default class ApiFactory extends Api {
+    private _traditional?;
+    private _restful;
+    createBuyApi(): Buy;
+    createCommerceApi(): Commerce;
+    createDeveloperApi(): Developer;
+    createPostOrderApi(): PostOrder;
+    createSellApi(): Sell;
+    get traditional(): Traditional;
+    createTradingApi(): Trading;
+    createShoppingApi(): Shopping;
+    createFindingApi(): Finding;
+    createClientAlertsApi(): ClientAlerts;
+    createMerchandisingApi(): Merchandising;
+    private createRestfulApi;
+}

package/dist/api/apiFactory.js

@@ -1,94 +1,94 @@
-import Api from './index.js';
-import { Browse, Deal, Feed, Marketing as BuyMarketing, MarketplaceInsights, Offer, Order } from './restful/buy/index.js';
-import { Catalog, Charity, Identity, Notification, Taxonomy, Translation } from './restful/commerce/index.js';
-import { Analytics as DeveloperAnalytics, KeyManagement } from './restful/developer/index.js';
-import { Cancellation, Case, Inquiry, Return, } from './restful/postOrder/index.js';
-import { Account, Analytics as SellAnalytics, Compliance, Feed as SellFeed, Finances, Fulfillment, Inventory, Listing, Logistics, Marketing as SellMarketing, Metadata, Negotiation, Recommendation } from './restful/sell/index.js';
-import Traditional from './traditional/index.js';
-/**
- * Factory class to create RESTFul API or Traditional API.
- */
-export default class ApiFactory extends Api {
-    constructor() {
-        super(...arguments);
-        this._restful = {};
-    }
-    createBuyApi() {
-        return {
-            browse: this.createRestfulApi(Browse),
-            feed: this.createRestfulApi(Feed),
-            marketing: this.createRestfulApi(BuyMarketing),
-            offer: this.createRestfulApi(Offer),
-            order: this.createRestfulApi(Order),
-            deal: this.createRestfulApi(Deal),
-            marketplaceInsights: this.createRestfulApi(MarketplaceInsights),
-        };
-    }
-    createCommerceApi() {
-        return {
-            catalog: this.createRestfulApi(Catalog),
-            identity: this.createRestfulApi(Identity),
-            taxonomy: this.createRestfulApi(Taxonomy),
-            translation: this.createRestfulApi(Translation),
-            charity: this.createRestfulApi(Charity),
-            notification: this.createRestfulApi(Notification),
-        };
-    }
-    createDeveloperApi() {
-        return {
-            analytics: this.createRestfulApi(DeveloperAnalytics),
-            keyManagement: this.createRestfulApi(KeyManagement),
-        };
-    }
-    createPostOrderApi() {
-        return {
-            cancellation: this.createRestfulApi(Cancellation),
-            case: this.createRestfulApi(Case),
-            inquiry: this.createRestfulApi(Inquiry),
-            return: this.createRestfulApi(Return),
-        };
-    }
-    createSellApi() {
-        return {
-            account: this.createRestfulApi(Account),
-            analytics: this.createRestfulApi(SellAnalytics),
-            compliance: this.createRestfulApi(Compliance),
-            fulfillment: this.createRestfulApi(Fulfillment),
-            inventory: this.createRestfulApi(Inventory),
-            marketing: this.createRestfulApi(SellMarketing),
-            metadata: this.createRestfulApi(Metadata),
-            recommendation: this.createRestfulApi(Recommendation),
-            finances: this.createRestfulApi(Finances),
-            feed: this.createRestfulApi(SellFeed),
-            logistics: this.createRestfulApi(Logistics),
-            negotiation: this.createRestfulApi(Negotiation),
-            listing: this.createRestfulApi(Listing),
-        };
-    }
-    get traditional() {
-        if (this._traditional) {
-            return this._traditional;
-        }
-        return (this._traditional = new Traditional(this.config, this.req, this.auth));
-    }
-    createTradingApi() {
-        return this.traditional.createTradingApi();
-    }
-    createShoppingApi() {
-        return this.traditional.createShoppingApi();
-    }
-    createFindingApi() {
-        return this.traditional.createFindingApi();
-    }
-    createClientAlertsApi() {
-        return this.traditional.createClientAlertsApi();
-    }
-    createMerchandisingApi() {
-        return this.traditional.createMerchandisingApi();
-    }
-    // tslint:disable-next-line:variable-name
-    createRestfulApi(RestfulApiClass) {
-        const id = RestfulApiClass.id;
-        return (this._restful[id] || (this._restful[id] = new RestfulApiClass(this.config, this.req, this.auth)));
-    }
-}
+import Api from './index.js';
+import { Browse, Deal, Feed, Marketing as BuyMarketing, MarketplaceInsights, Offer, Order } from './restful/buy/index.js';
+import { Catalog, Charity, Identity, Notification, Taxonomy, Translation } from './restful/commerce/index.js';
+import { Analytics as DeveloperAnalytics, KeyManagement } from './restful/developer/index.js';
+import { Cancellation, Case, Inquiry, Return, } from './restful/postOrder/index.js';
+import { Account, Analytics as SellAnalytics, Compliance, Feed as SellFeed, Finances, Fulfillment, Inventory, Listing, Logistics, Marketing as SellMarketing, Metadata, Negotiation, Recommendation } from './restful/sell/index.js';
+import Traditional from './traditional/index.js';
+/**
+ * Factory class to create RESTFul API or Traditional API.
+ */
+export default class ApiFactory extends Api {
+    constructor() {
+        super(...arguments);
+        this._restful = {};
+    }
+    createBuyApi() {
+        return {
+            browse: this.createRestfulApi(Browse),
+            feed: this.createRestfulApi(Feed),
+            marketing: this.createRestfulApi(BuyMarketing),
+            offer: this.createRestfulApi(Offer),
+            order: this.createRestfulApi(Order),
+            deal: this.createRestfulApi(Deal),
+            marketplaceInsights: this.createRestfulApi(MarketplaceInsights),
+        };
+    }
+    createCommerceApi() {
+        return {
+            catalog: this.createRestfulApi(Catalog),
+            identity: this.createRestfulApi(Identity),
+            taxonomy: this.createRestfulApi(Taxonomy),
+            translation: this.createRestfulApi(Translation),
+            charity: this.createRestfulApi(Charity),
+            notification: this.createRestfulApi(Notification),
+        };
+    }
+    createDeveloperApi() {
+        return {
+            analytics: this.createRestfulApi(DeveloperAnalytics),
+            keyManagement: this.createRestfulApi(KeyManagement),
+        };
+    }
+    createPostOrderApi() {
+        return {
+            cancellation: this.createRestfulApi(Cancellation),
+            case: this.createRestfulApi(Case),
+            inquiry: this.createRestfulApi(Inquiry),
+            return: this.createRestfulApi(Return),
+        };
+    }
+    createSellApi() {
+        return {
+            account: this.createRestfulApi(Account),
+            analytics: this.createRestfulApi(SellAnalytics),
+            compliance: this.createRestfulApi(Compliance),
+            fulfillment: this.createRestfulApi(Fulfillment),
+            inventory: this.createRestfulApi(Inventory),
+            marketing: this.createRestfulApi(SellMarketing),
+            metadata: this.createRestfulApi(Metadata),
+            recommendation: this.createRestfulApi(Recommendation),
+            finances: this.createRestfulApi(Finances),
+            feed: this.createRestfulApi(SellFeed),
+            logistics: this.createRestfulApi(Logistics),
+            negotiation: this.createRestfulApi(Negotiation),
+            listing: this.createRestfulApi(Listing),
+        };
+    }
+    get traditional() {
+        if (this._traditional) {
+            return this._traditional;
+        }
+        return (this._traditional = new Traditional(this.config, this.req, this.auth));
+    }
+    createTradingApi() {
+        return this.traditional.createTradingApi();
+    }
+    createShoppingApi() {
+        return this.traditional.createShoppingApi();
+    }
+    createFindingApi() {
+        return this.traditional.createFindingApi();
+    }
+    createClientAlertsApi() {
+        return this.traditional.createClientAlertsApi();
+    }
+    createMerchandisingApi() {
+        return this.traditional.createMerchandisingApi();
+    }
+    // tslint:disable-next-line:variable-name
+    createRestfulApi(RestfulApiClass) {
+        const id = RestfulApiClass.id;
+        return (this._restful[id] || (this._restful[id] = new RestfulApiClass(this.config, this.req, this.auth)));
+    }
+}

package/dist/api/base.d.ts

@@ -1,10 +1,10 @@
-import { IEBayApiRequest } from '../request.js';
-import { AppConfig } from '../types/index.js';
-/**
- * Abstract superclass.
- */
-export default abstract class Base {
-    readonly config: AppConfig;
-    readonly req: IEBayApiRequest;
-    protected constructor(config: AppConfig, req?: IEBayApiRequest);
-}
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig } from '../types/index.js';
+/**
+ * Abstract superclass.
+ */
+export default abstract class Base {
+    readonly config: AppConfig;
+    readonly req: IEBayApiRequest;
+    protected constructor(config: AppConfig, req?: IEBayApiRequest);
+}

package/dist/api/base.js

@@ -1,10 +1,10 @@
-import { AxiosRequest } from '../request.js';
-/**
- * Abstract superclass.
- */
-export default class Base {
-    constructor(config, req = new AxiosRequest(config.axiosConfig)) {
-        this.config = config;
-        this.req = req;
-    }
-}
+import { AxiosRequest } from '../request.js';
+/**
+ * Abstract superclass.
+ */
+export default class Base {
+    constructor(config, req = new AxiosRequest(config.axiosConfig)) {
+        this.config = config;
+        this.req = req;
+    }
+}

package/dist/api/digitalSignature.d.ts

@@ -1,43 +1,43 @@
-import { Cipher, Headers } from '../types/index.js';
-/**
- * Generates the 'Content-Digest' header value for the input payload.
- *
- * @param {any} payload The request payload.
- * @param {string} cipher The algorithm used to calculate the digest.
- * @returns {string} contentDigest The 'Content-Digest' header value.
- */
-export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
-export type SignatureComponents = {
-    method: string;
-    authority: string;
-    path: string;
-};
-/**
- * Generates the base string.
- *
- * @param {any} headers The HTTP request headers.
- * @param {SignatureComponents} signatureComponents The config.
- * @param {any} payload The payload.
- * @param {number} timestamp The timestamp.
- * @returns {string} payload The base string.
- */
-export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
-/**
- * Generates the Signature-Input header value for the input payload.
- *
- * @param {any} payload The input config.
- * @param {number} timestamp The timestamp.
- * @returns {string} the 'Signature-Input' header value.
- */
-export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
-/**
- * Generates the 'Signature' header.
- *
- * @param {any} headers The HTTP headers.
- * @param {string} privateKey The HTTP headers.
- * @param {SignatureComponents} signatureComponents The signature components
- * @param {any} payload The payload
- * @param {number} timestamp The payload
- * @returns {string} the signature header value.
- */
-export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
+import { Cipher, Headers } from '../types/index.js';
+/**
+ * Generates the 'Content-Digest' header value for the input payload.
+ *
+ * @param {any} payload The request payload.
+ * @param {string} cipher The algorithm used to calculate the digest.
+ * @returns {string} contentDigest The 'Content-Digest' header value.
+ */
+export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
+export type SignatureComponents = {
+    method: string;
+    authority: string;
+    path: string;
+};
+/**
+ * Generates the base string.
+ *
+ * @param {any} headers The HTTP request headers.
+ * @param {SignatureComponents} signatureComponents The config.
+ * @param {any} payload The payload.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} payload The base string.
+ */
+export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
+/**
+ * Generates the Signature-Input header value for the input payload.
+ *
+ * @param {any} payload The input config.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} the 'Signature-Input' header value.
+ */
+export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
+/**
+ * Generates the 'Signature' header.
+ *
+ * @param {any} headers The HTTP headers.
+ * @param {string} privateKey The HTTP headers.
+ * @param {SignatureComponents} signatureComponents The signature components
+ * @param {any} payload The payload
+ * @param {number} timestamp The payload
+ * @returns {string} the signature header value.
+ */
+export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;

package/dist/api/digitalSignature.js

@@ -1,105 +1,105 @@
-import { createHash, sign } from 'crypto';
-const beginPrivateKey = '-----BEGIN PRIVATE KEY-----';
-const endPrivateKey = '-----END PRIVATE KEY-----';
-// based on https://github.com/ebay/digital-signature-nodejs-sdk
-/**
- * Returns the current UNIX timestamp.
- *
- * @returns {number} The unix timestamp.
- */
-const getUnixTimestamp = () => Date.now() / 1000 | 0;
-const getSignatureParams = (payload) => [
-    ...payload ? ['content-digest'] : [],
-    'x-ebay-signature-key',
-    '@method',
-    '@path',
-    '@authority'
-];
-const getSignatureParamsValue = (payload) => getSignatureParams(payload).map(param => `"${param}"`).join(' ');
-/**
- * Generates the 'Content-Digest' header value for the input payload.
- *
- * @param {any} payload The request payload.
- * @param {string} cipher The algorithm used to calculate the digest.
- * @returns {string} contentDigest The 'Content-Digest' header value.
- */
-export const generateContentDigestValue = (payload, cipher = 'sha256') => {
-    const payloadBuffer = Buffer.from(typeof payload === 'string' ? payload : JSON.stringify(payload));
-    const hash = createHash(cipher).update(payloadBuffer).digest('base64');
-    const algo = cipher === 'sha512' ? 'sha-512' : 'sha-256';
-    return `${algo}=:${hash}:`;
-};
-/**
- * Generates the base string.
- *
- * @param {any} headers The HTTP request headers.
- * @param {SignatureComponents} signatureComponents The config.
- * @param {any} payload The payload.
- * @param {number} timestamp The timestamp.
- * @returns {string} payload The base string.
- */
-export function generateBaseString(headers, signatureComponents, payload, timestamp = getUnixTimestamp()) {
-    try {
-        let baseString = '';
-        const signatureParams = getSignatureParams(payload);
-        signatureParams.forEach(param => {
-            baseString += `"${param.toLowerCase()}": `;
-            if (param.startsWith('@')) {
-                switch (param.toLowerCase()) {
-                    case '@method':
-                        baseString += signatureComponents.method;
-                        break;
-                    case '@authority':
-                        baseString += signatureComponents.authority;
-                        break;
-                    case '@path':
-                        baseString += signatureComponents.path;
-                        break;
-                    default:
-                        throw new Error('Unknown pseudo header ' + param);
-                }
-            }
-            else {
-                if (!headers[param]) {
-                    throw new Error('Header ' + param + ' not included in message');
-                }
-                baseString += headers[param];
-            }
-            baseString += '\n';
-        });
-        baseString += `"@signature-params": (${getSignatureParamsValue(payload)});created=${timestamp}`;
-        return baseString;
-    }
-    catch (ex) {
-        throw new Error(`Error calculating signature base: ${ex.message}`);
-    }
-}
-/**
- * Generates the Signature-Input header value for the input payload.
- *
- * @param {any} payload The input config.
- * @param {number} timestamp The timestamp.
- * @returns {string} the 'Signature-Input' header value.
- */
-export const generateSignatureInput = (payload, timestamp = getUnixTimestamp()) => `sig1=(${getSignatureParamsValue(payload)});created=${timestamp}`;
-/**
- * Generates the 'Signature' header.
- *
- * @param {any} headers The HTTP headers.
- * @param {string} privateKey The HTTP headers.
- * @param {SignatureComponents} signatureComponents The signature components
- * @param {any} payload The payload
- * @param {number} timestamp The payload
- * @returns {string} the signature header value.
- */
-export function generateSignature(headers, privateKey, signatureComponents, payload, timestamp = getUnixTimestamp()) {
-    const baseString = generateBaseString(headers, signatureComponents, payload, timestamp);
-    privateKey = privateKey.trim();
-    if (!privateKey.startsWith(beginPrivateKey)) {
-        privateKey = beginPrivateKey + '\n' + privateKey + '\n' + endPrivateKey;
-    }
-    const signatureBuffer = sign(undefined, // If algorithm is undefined, then it is dependent upon the private key type.
-    Buffer.from(baseString), privateKey);
-    const signature = signatureBuffer.toString('base64');
-    return `sig1=:${signature}:`;
-}
+import { createHash, sign } from 'crypto';
+const beginPrivateKey = '-----BEGIN PRIVATE KEY-----';
+const endPrivateKey = '-----END PRIVATE KEY-----';
+// based on https://github.com/ebay/digital-signature-nodejs-sdk
+/**
+ * Returns the current UNIX timestamp.
+ *
+ * @returns {number} The unix timestamp.
+ */
+const getUnixTimestamp = () => Date.now() / 1000 | 0;
+const getSignatureParams = (payload) => [
+    ...payload ? ['content-digest'] : [],
+    'x-ebay-signature-key',
+    '@method',
+    '@path',
+    '@authority'
+];
+const getSignatureParamsValue = (payload) => getSignatureParams(payload).map(param => `"${param}"`).join(' ');
+/**
+ * Generates the 'Content-Digest' header value for the input payload.
+ *
+ * @param {any} payload The request payload.
+ * @param {string} cipher The algorithm used to calculate the digest.
+ * @returns {string} contentDigest The 'Content-Digest' header value.
+ */
+export const generateContentDigestValue = (payload, cipher = 'sha256') => {
+    const payloadBuffer = Buffer.from(typeof payload === 'string' ? payload : JSON.stringify(payload));
+    const hash = createHash(cipher).update(payloadBuffer).digest('base64');
+    const algo = cipher === 'sha512' ? 'sha-512' : 'sha-256';
+    return `${algo}=:${hash}:`;
+};
+/**
+ * Generates the base string.
+ *
+ * @param {any} headers The HTTP request headers.
+ * @param {SignatureComponents} signatureComponents The config.
+ * @param {any} payload The payload.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} payload The base string.
+ */
+export function generateBaseString(headers, signatureComponents, payload, timestamp = getUnixTimestamp()) {
+    try {
+        let baseString = '';
+        const signatureParams = getSignatureParams(payload);
+        signatureParams.forEach(param => {
+            baseString += `"${param.toLowerCase()}": `;
+            if (param.startsWith('@')) {
+                switch (param.toLowerCase()) {
+                    case '@method':
+                        baseString += signatureComponents.method;
+                        break;
+                    case '@authority':
+                        baseString += signatureComponents.authority;
+                        break;
+                    case '@path':
+                        baseString += signatureComponents.path;
+                        break;
+                    default:
+                        throw new Error('Unknown pseudo header ' + param);
+                }
+            }
+            else {
+                if (!headers[param]) {
+                    throw new Error('Header ' + param + ' not included in message');
+                }
+                baseString += headers[param];
+            }
+            baseString += '\n';
+        });
+        baseString += `"@signature-params": (${getSignatureParamsValue(payload)});created=${timestamp}`;
+        return baseString;
+    }
+    catch (ex) {
+        throw new Error(`Error calculating signature base: ${ex.message}`);
+    }
+}
+/**
+ * Generates the Signature-Input header value for the input payload.
+ *
+ * @param {any} payload The input config.
+ * @param {number} timestamp The timestamp.
+ * @returns {string} the 'Signature-Input' header value.
+ */
+export const generateSignatureInput = (payload, timestamp = getUnixTimestamp()) => `sig1=(${getSignatureParamsValue(payload)});created=${timestamp}`;
+/**
+ * Generates the 'Signature' header.
+ *
+ * @param {any} headers The HTTP headers.
+ * @param {string} privateKey The HTTP headers.
+ * @param {SignatureComponents} signatureComponents The signature components
+ * @param {any} payload The payload
+ * @param {number} timestamp The payload
+ * @returns {string} the signature header value.
+ */
+export function generateSignature(headers, privateKey, signatureComponents, payload, timestamp = getUnixTimestamp()) {
+    const baseString = generateBaseString(headers, signatureComponents, payload, timestamp);
+    privateKey = privateKey.trim();
+    if (!privateKey.startsWith(beginPrivateKey)) {
+        privateKey = beginPrivateKey + '\n' + privateKey + '\n' + endPrivateKey;
+    }
+    const signatureBuffer = sign(undefined, // If algorithm is undefined, then it is dependent upon the private key type.
+    Buffer.from(baseString), privateKey);
+    const signature = signatureBuffer.toString('base64');
+    return `sig1=:${signature}:`;
+}

package/dist/api/index.d.ts

@@ -1,13 +1,13 @@
-import Auth from '../auth/index.js';
-import { IEBayApiRequest } from '../request.js';
-import { AppConfig } from '../types/index.js';
-import Base from './base.js';
-import { SignatureComponents } from './digitalSignature.js';
-/**
- * Superclass with Auth container.
- */
-export default abstract class Api extends Base {
-    readonly auth: Auth;
-    constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth);
-    getDigitalSignatureHeaders(signatureComponents: SignatureComponents, payload: any): {};
-}
+import Auth from '../auth/index.js';
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig } from '../types/index.js';
+import Base from './base.js';
+import { SignatureComponents } from './digitalSignature.js';
+/**
+ * Superclass with Auth container.
+ */
+export default abstract class Api extends Base {
+    readonly auth: Auth;
+    constructor(config: AppConfig, req?: IEBayApiRequest, auth?: Auth);
+    getDigitalSignatureHeaders(signatureComponents: SignatureComponents, payload: any): {};
+}