ebay-api 8.4.0 → 8.5.0

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): {};
+}

package/dist/api/index.js

@@ -1,29 +1,29 @@
-import Auth from '../auth/index.js';
-import Base from './base.js';
-import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
-/**
- * Superclass with Auth container.
- */
-export default class Api extends Base {
-    constructor(config, req, auth) {
-        super(config, req);
-        this.auth = auth || new Auth(this.config, this.req);
-    }
-    getDigitalSignatureHeaders(signatureComponents, payload) {
-        if (!this.config.signature) {
-            return {};
-        }
-        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)
-        };
-        return {
-            ...digitalSignatureHeaders,
-            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload)
-        };
-    }
-}
+import Auth from '../auth/index.js';
+import Base from './base.js';
+import { generateContentDigestValue, generateSignature, generateSignatureInput } from './digitalSignature.js';
+/**
+ * Superclass with Auth container.
+ */
+export default class Api extends Base {
+    constructor(config, req, auth) {
+        super(config, req);
+        this.auth = auth || new Auth(this.config, this.req);
+    }
+    getDigitalSignatureHeaders(signatureComponents, payload) {
+        if (!this.config.signature) {
+            return {};
+        }
+        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)
+        };
+        return {
+            ...digitalSignatureHeaders,
+            'signature': generateSignature(digitalSignatureHeaders, this.config.signature.privateKey, signatureComponents, payload)
+        };
+    }
+}

package/dist/api/restful/buy/browse/index.d.ts

@@ -1,84 +1,84 @@
-import Restful from '../../index.js';
-import { AddCartItemInput, BrowseSearchParams, CompatibilityPayload, ItemsParams, LegacyItemParams, RemoveCartItemInput, SearchByImageParams, UpdateCartItemInput } from '../../../../types/index.js';
-/**
- * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
- * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
- * and fields values.
- */
-export default class Browse extends Restful {
-    static id: string;
-    get basePath(): string;
-    /**
-     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
-     *
-     * @param {BrowseSearchParams} params
-     */
-    search(params: BrowseSearchParams): Promise<any>;
-    /**
-     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
-     * the items.
-     *
-     * @param {BrowseSearchParams} params
-     * @param {Object} body The container for the image information fields.
-     */
-    searchByImage(params: SearchByImageParams, body?: {}): Promise<any>;
-    /**
-     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
-     *
-     * @param itemIds A list of item IDs. Item IDs are the eBay RESTful identifier of items.
-     * @param itemGroupIds A list of item group IDs.
-     */
-    getItems({ itemIds: item_ids, itemGroupIds: item_group_ids }: ItemsParams): Promise<any>;
-    /**
-     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
-     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
-     * and other information the buyer needs to make a purchasing decision.
-     *
-     * @param {String} itemId The eBay RESTful identifier of an item.
-     * @param {String} fieldgroups
-     */
-    getItem(itemId: string, fieldgroups?: string): Promise<any>;
-    /**
-     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
-     *
-     * @param {LegacyItemParams} params
-     */
-    getItemByLegacyId(params: LegacyItemParams): Promise<any>;
-    /**
-     * This method retrieves the details of the individual items in an item group.
-     *
-     * @param itemGroupId
-     */
-    getItemsByItemGroup(itemGroupId: string): Promise<any>;
-    /**
-     * This method checks if a product is compatible with the specified item.
-     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
-     * @param {Object} body CompatibilityPayload
-     */
-    checkCompatibility(itemId: string, body?: CompatibilityPayload): Promise<any>;
-    /**
-     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
-     * adds items to that cart.
-     *
-     * @param {Object} item AddCartItemInput
-     */
-    addItem(item: AddCartItemInput): Promise<any>;
-    /**
-     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
-     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
-     */
-    getShoppingCart(): Promise<any>;
-    /**
-     * This is an experimental method. This method removes a specific item from the eBay member's cart.
-     *
-     *  @param {Object} item RemoveCartItemInput
-     */
-    removeItem(item: RemoveCartItemInput): Promise<any>;
-    /**
-     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
-     * cart.
-     *
-     * @param {UpdateCartItemInput} item UpdateCartItemInput
-     */
-    updateQuantity(item: UpdateCartItemInput): Promise<any>;
-}
+import { AddCartItemInput, BuyBrowseGetItemsParams, BuyBrowseItemByLegacyIdParams, BuyBrowseSearchByImageParams, BuyBrowseSearchParams, CompatibilityPayload, RemoveCartItemInput, SearchByImageRequest, UpdateCartItemInput } from '../../../../types/index.js';
+import { operations } from '../../../../types/restful/specs/buy_browse_v1_oas3.js';
+import Restful, { OpenApi } from '../../index.js';
+/**
+ * The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN,
+ * category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility,
+ * and fields values.
+ */
+export default class Browse extends Restful implements OpenApi<operations> {
+    static id: string;
+    get basePath(): string;
+    /**
+     * This method searches for eBay items by various query parameters and retrieves summaries of the items.
+     *
+     * @param {BrowseSearchParams} params
+     */
+    search(params: BuyBrowseSearchParams): Promise<any>;
+    /**
+     * This is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of
+     * the items.
+     *
+     * @param {params} params
+     * @param {Object} body The container for the image information fields.
+     */
+    searchByImage(params: BuyBrowseSearchByImageParams, body?: SearchByImageRequest): Promise<any>;
+    /**
+     * This method retrieves the details of specific items that the buyer needs to make a purchasing decision.
+     *
+     * @param {params} params
+     */
+    getItems(params: BuyBrowseGetItemsParams): Promise<any>;
+    /**
+     * This method retrieves the details of a specific item, such as description, price, category, all item aspects,
+     * condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery,
+     * and other information the buyer needs to make a purchasing decision.
+     *
+     * @param {String} itemId The eBay RESTful identifier of an item.
+     * @param {String} fieldgroups
+     */
+    getItem(itemId: string, fieldgroups?: string): Promise<any>;
+    /**
+     * This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Api APIs.
+     *
+     * @param {LegacyItemParams} params
+     */
+    getItemByLegacyId(params: BuyBrowseItemByLegacyIdParams): Promise<any>;
+    /**
+     * This method retrieves the details of the individual items in an item group.
+     *
+     * @param itemGroupId
+     */
+    getItemsByItemGroup(itemGroupId: string): Promise<any>;
+    /**
+     * This method checks if a product is compatible with the specified item.
+     * @param {String} itemId The eBay RESTful identifier of an item (such as a part you want to check).
+     * @param {Object} body CompatibilityPayload
+     */
+    checkCompatibility(itemId: string, body?: CompatibilityPayload): Promise<any>;
+    /**
+     * This is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and
+     * adds items to that cart.
+     *
+     * @param {Object} item AddCartItemInput
+     */
+    addItem(item: AddCartItemInput): Promise<any>;
+    /**
+     * This is an experimental method. This method retrieves all the items in the eBay member's cart;
+     * items added to the cart while on ebay.com as well as items added to the cart using the Browse API.
+     */
+    getShoppingCart(): Promise<any>;
+    /**
+     * This is an experimental method. This method removes a specific item from the eBay member's cart.
+     *
+     *  @param {Object} item RemoveCartItemInput
+     */
+    removeItem(item: RemoveCartItemInput): Promise<any>;
+    /**
+     * This is an experimental method. This method updates the quantity value of a specific item in the eBay member's
+     * cart.
+     *
+     * @param {UpdateCartItemInput} item UpdateCartItemInput
+     */
+    updateQuantity(item: UpdateCartItemInput): Promise<any>;
+}