ebay-api 9.0.2 → 9.1.0

package/dist/errors/index.d.ts

@@ -13,7 +13,8 @@ export declare class ApiEnvError extends EBayError {
 export declare class EbayApiError extends EBayError {
     readonly errorCode: number | undefined;
     readonly meta?: EBayErrorMeta;
-    constructor(message: string, description?: string, meta?: EBayErrorMeta, errorCode?: number | undefined);
+    readonly firstError?: EBayFirstError;
+    constructor(message: string, description?: string, meta?: EBayErrorMeta, errorCode?: number, firstError?: EBayFirstError);
 }
 export declare class EBayApiError extends EbayApiError {
 }
@@ -89,7 +90,7 @@ export type EBayApiErrorResponse = string | EBayPostOrderErrorResponse | EBayRes
 export type ApiRequestResult = {
     response: {
         data?: EBayApiErrorResponse;
-        status?: string;
+        status?: number;
         statusText?: string;
         headers?: Record<string, string>;
     };
@@ -103,7 +104,7 @@ export type ApiRequestResult = {
 export type ErrorCommonMeta = {
     res?: {
         data: any;
-        status?: string;
+        status?: number;
         statusText?: string;
         headers?: Record<string, string>;
     };
@@ -127,4 +128,4 @@ export type EBayErrorBag = {
 };
 export declare const extractEBayError: (result: ApiRequestResult, data?: EBayApiErrorResponse) => EBayErrorBag;
 export declare const handleEBayError: (error: any) => never;
-export declare const checkEBayTraditionalResponse: (result: any, data: any) => void;
+export declare const checkEBayTraditionalResponse: (apiResponse: any, data: any) => void;

package/dist/errors/index.js

@@ -21,9 +21,10 @@ export class ApiEnvError extends EBayError {
     }
 }
 export class EbayApiError extends EBayError {
-    constructor(message, description, meta, errorCode) {
+    constructor(message, description, meta, errorCode, firstError) {
         super(message, description, meta);
         this.errorCode = errorCode;
+        this.firstError = firstError;
     }
 }
 export class EBayApiError extends EbayApiError {
@@ -51,7 +52,7 @@ export class EBayTokenRequired extends EBayApiError {
 EBayTokenRequired.code = 930;
 export class EBayInvalidScope extends EBayApiError {
 }
-function getEBayErrorFromResponse(data) {
+function getEBayError(data) {
     if (!data) {
         return {
             message: `eBay API Error`,
@@ -114,7 +115,7 @@ const getErrorCode = (eBayError) => {
     return undefined;
 };
 export const extractEBayError = (result, data) => {
-    const eBayError = getEBayErrorFromResponse(result.response?.data || data);
+    const eBayError = getEBayError(data || result.response?.data);
     const meta = {
         ...eBayError,
         [rawError]: result
@@ -154,42 +155,42 @@ export const handleEBayError = (error) => {
     else if (typeof error !== 'object') {
         throw new EBayError(error);
     }
-    const { message, meta, description, errorCode } = extractEBayError(error);
+    const { message, meta, description, errorCode, firstError } = extractEBayError(error);
     if ('domain' in meta && meta.domain === 'ACCESS') {
-        throw new EBayAccessDenied(message, description, meta, errorCode);
+        throw new EBayAccessDenied(message, description, meta, errorCode, firstError);
     }
     else if ('message' in meta && meta.message === 'invalid_grant') {
-        throw new EBayInvalidGrant(message, description, meta, errorCode);
+        throw new EBayInvalidGrant(message, description, meta, errorCode, firstError);
     }
     else if ('message' in meta && meta.message === 'invalid_scope') {
-        throw new EBayInvalidScope(message, description, meta, errorCode);
+        throw new EBayInvalidScope(message, description, meta, errorCode, firstError);
     }
     else if ('message' in meta && meta.message === 'Invalid access token') {
-        throw new EBayInvalidAccessToken(message, description, meta, errorCode);
+        throw new EBayInvalidAccessToken(message, description, meta, errorCode, firstError);
     }
     else if (errorCode === EBayNotFound.code) {
-        throw new EBayNotFound(message, description, meta, errorCode);
+        throw new EBayNotFound(message, description, meta, errorCode, firstError);
     }
-    throw new EBayApiError(message, description, meta, errorCode);
+    throw new EBayApiError(message, description, meta, errorCode, firstError);
 };
-export const checkEBayTraditionalResponse = (result, data) => {
+export const checkEBayTraditionalResponse = (apiResponse, data) => {
     if (!('Errors' in data) && !('errorMessage' in data)) {
         return;
     }
-    const { message, meta, description, errorCode } = extractEBayError(result, data);
+    const { message, meta, description, errorCode, firstError } = extractEBayError(apiResponse, data);
     if (typeof errorCode === 'undefined') {
-        throw new EBayApiError(message, description, meta, errorCode);
+        throw new EBayApiError(message, description, meta, errorCode, firstError);
     }
     switch (errorCode) {
         case EBayIAFTokenExpired.code:
-            throw new EBayIAFTokenExpired(message, description, meta, errorCode);
+            throw new EBayIAFTokenExpired(message, description, meta, errorCode, firstError);
         case EBayIAFTokenInvalid.code:
         case 1.32:
-            throw new EBayIAFTokenInvalid(message, description, meta, errorCode);
+            throw new EBayIAFTokenInvalid(message, description, meta, errorCode, firstError);
         case EBayTokenRequired.code:
-            throw new EBayTokenRequired(message, description, meta, errorCode);
+            throw new EBayTokenRequired(message, description, meta, errorCode, firstError);
         case EBayAuthTokenIsHardExpired.code:
-            throw new EBayAuthTokenIsHardExpired(message, description, meta, errorCode);
+            throw new EBayAuthTokenIsHardExpired(message, description, meta, errorCode, firstError);
     }
-    throw new EBayApiError(message, description, meta, errorCode);
+    throw new EBayApiError(message, description, meta, errorCode, firstError);
 };

package/lib/api/traditional/XMLRequest.d.ts

@@ -1,8 +1,8 @@
-import { XMLBuilder } from 'fast-xml-parser';
+import { X2jOptions, XMLBuilder, XmlBuilderOptions } from 'fast-xml-parser';
 import { IEBayApiRequest } from '../../request.js';
 import { ApiRequestConfig, Headers } from '../../types/index.js';
 import { Fields } from './fields.js';
-export declare const defaultJSON2XMLOptions: {
+export declare const defaultXmlBuilderOptions: {
     attributeNamePrefix: string;
     textNodeName: string;
     ignoreAttributes: boolean;
@@ -32,7 +32,8 @@ export type BodyHeaders = {
 };
 export type TraditionalApiConfig = {
     raw?: boolean;
-    parseOptions?: object;
+    parseOptions?: X2jOptions;
+    xmlBuilderOptions?: XmlBuilderOptions;
     useIaf?: boolean;
     sign?: boolean;
     hook?: (xml: string) => BodyHeaders;
@@ -52,7 +53,7 @@ export default class XMLRequest {
     private readonly fields;
     private readonly config;
     private readonly req;
-    static j2x: XMLBuilder;
+    readonly j2x: XMLBuilder;
     constructor(callName: string, fields: Fields | null, config: XMLReqConfig, req: IEBayApiRequest);
     private getResponseWrapper;
     private getCredentials;

package/lib/api/traditional/XMLRequest.js

@@ -3,12 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultHeaders = exports.defaultApiConfig = exports.defaultXML2JSONParseOptions = exports.defaultJSON2XMLOptions = void 0;
+exports.defaultHeaders = exports.defaultApiConfig = exports.defaultXML2JSONParseOptions = exports.defaultXmlBuilderOptions = void 0;
 const debug_1 = __importDefault(require("debug"));
 const fast_xml_parser_1 = require("fast-xml-parser");
 const index_js_1 = require("../../errors/index.js");
 const log = (0, debug_1.default)('ebay:xml:request');
-exports.defaultJSON2XMLOptions = {
+exports.defaultXmlBuilderOptions = {
     attributeNamePrefix: '@_',
     textNodeName: '#value',
     ignoreAttributes: false,
@@ -37,6 +37,7 @@ exports.defaultXML2JSONParseOptions = {
 exports.defaultApiConfig = {
     raw: false,
     parseOptions: exports.defaultXML2JSONParseOptions,
+    xmlBuilderOptions: exports.defaultXmlBuilderOptions,
     useIaf: true,
     sign: false,
     headers: {},
@@ -50,9 +51,10 @@ class XMLRequest {
         if (!callName) {
             throw new index_js_1.EBayNoCallError();
         }
+        this.config = { ...exports.defaultApiConfig, ...config };
+        this.j2x = new fast_xml_parser_1.XMLBuilder({ ...exports.defaultXmlBuilderOptions, ...this.config.xmlBuilderOptions });
         this.callName = callName;
         this.fields = fields || {};
-        this.config = { ...exports.defaultApiConfig, ...config };
         this.req = req;
     }
     getResponseWrapper() {
@@ -84,7 +86,7 @@ class XMLRequest {
     }
     toXML(fields) {
         const HEADING = '<?xml version="1.0" encoding="utf-8"?>';
-        return HEADING + XMLRequest.j2x.build({
+        return HEADING + this.j2x.build({
             [this.callName + 'Request']: {
                 '@_xmlns': this.config.xmlns,
                 ...this.getCredentials(),
@@ -122,7 +124,7 @@ class XMLRequest {
             log('error', error);
             if (error.response?.data) {
                 const json = this.toJSON(error.response.data);
-                (0, index_js_1.checkEBayTraditionalResponse)(error.response, json[this.callName + 'Response']);
+                (0, index_js_1.checkEBayTraditionalResponse)(error, json[this.callName + 'Response']);
             }
             throw error;
         }
@@ -132,5 +134,4 @@ class XMLRequest {
         return json[this.getResponseWrapper()] ?? json;
     }
 }
-XMLRequest.j2x = new fast_xml_parser_1.XMLBuilder(exports.defaultJSON2XMLOptions);
 exports.default = XMLRequest;