ebay-api 9.0.2 → 9.1.0

package/README.md

@@ -22,7 +22,7 @@ It supports `client credentials grant` and `authorization code grant` \(Auth'N'A
 
 ## Changelog
 
-* `v8.7.2-RC.0` is the latest release.
+* `v9.1.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -497,6 +497,45 @@ try {
   console.error(error);
 }
 ```
+## Handling errors
+```js
+import eBayApi from 'ebay-api';
+import { EBayApiError } from 'ebay-api/lib/errors';
+
+const eBay = new eBayApi(/* {  your config here } */);
+
+try {
+  const result = await eBay.trading.GetItem({
+    ItemID: 'itemId',
+  });
+  console.log(result);
+} catch (error) {
+  if (error instanceof EBayApiError && error.errorCode === 17) {
+    // Item not found
+  } else {
+    throw error;
+  }
+  
+  // in error there is also the field "meta" with the response
+  if (error instanceof EBayApiError && error.meta?.res?.status === 404) {
+    // not found
+    
+    // The first error
+    console.log(error?.firstError);
+  }
+  
+  
+}
+```
+
+The `errorCode` is extracted from the first error in the API response.
+
+* [Shopping API Error Codes](https://developer.ebay.com/devzone/shopping/docs/callref/Errors/ErrorMessages.html)
+* [Trading API  Error Codes](https://developer.ebay.com/devzone/xml/docs/reference/ebay/errors/errormessages.htm)
+* [RESTful  Error Codes](https://developer.ebay.com/devzone/xml/docs/reference/ebay/errors/errormessages.htm)
+* [PostOrder  Error Codes](https://developer.ebay.com/Devzone/post-order/ErrorMessages.html#ErrorsByNumber)
+
+
 
 ## Controlling Traditional XML request and response
 
@@ -505,7 +544,8 @@ The second parameter in the traditional API has the following options:
 ```typescript
 export type Options = {
   raw?: boolean // return raw XML
-  parseOptions?: object // https://github.com/NaturalIntelligence/fast-xml-parser
+  parseOptions?: X2jOptions // https://github.com/NaturalIntelligence/fast-xml-parser
+  xmlBuilderOptions?: XmlBuilderOptions // https://github.com/NaturalIntelligence/fast-xml-parser
   useIaf?: boolean // use IAF in header instead of Bearer
   headers?: Headers // additional Headers (key, value)
   hook?: (xml) => BodyHeaders // hook into the request to modify the body and headers
@@ -515,6 +555,40 @@ export type Options = {
 [Fast XML](https://github.com/NaturalIntelligence/fast-xml-parser) is used to parse the XML. You can pass the parse
 option to `parseOptions` parameter.
 
+### Parse JSON Array
+```js
+
+eBay.trading.SetNotificationPreferences({
+  UserDeliveryPreferenceArray: [{
+    NotificationEnable: {
+      EventType: 'ItemListed',
+      EventEnable: 'Enable',
+    }
+  }, {
+    NotificationEnable: {
+      EventType: 'ItemSold',
+      EventEnable: 'Enable',
+    },
+  }],
+}, { xmlBuilderOptions: { oneListGroup: true }})
+```
+
+Will produce:
+```xml
+<UserDeliveryPreferenceArray>
+  <NotificationEnable>
+    <EventType>ItemListed</EventType>
+    <EventEnable>Enable</EventEnable>
+  </NotificationEnable>
+  <NotificationEnable>
+    <EventType>ItemSold</EventType>
+    <EventEnable>Enable</EventEnable>
+  </NotificationEnable>
+</UserDeliveryPreferenceArray>
+```
+
+
+
 ## Examples
 
 ### Trading - AddFixedPriceItem \(CDATA\)

package/dist/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/dist/api/traditional/XMLRequest.js

@@ -2,7 +2,7 @@ import debug from 'debug';
 import { XMLBuilder, XMLParser } from 'fast-xml-parser';
 import { checkEBayTraditionalResponse, EBayNoCallError } from '../../errors/index.js';
 const log = debug('ebay:xml:request');
-export const defaultJSON2XMLOptions = {
+export const defaultXmlBuilderOptions = {
     attributeNamePrefix: '@_',
     textNodeName: '#value',
     ignoreAttributes: false,
@@ -31,6 +31,7 @@ export const defaultXML2JSONParseOptions = {
 export const defaultApiConfig = {
     raw: false,
     parseOptions: defaultXML2JSONParseOptions,
+    xmlBuilderOptions: defaultXmlBuilderOptions,
     useIaf: true,
     sign: false,
     headers: {},
@@ -39,14 +40,15 @@ export const defaultApiConfig = {
 export const defaultHeaders = {
     'Content-Type': 'text/xml'
 };
-class XMLRequest {
+export default class XMLRequest {
     constructor(callName, fields, config, req) {
         if (!callName) {
             throw new EBayNoCallError();
         }
+        this.config = { ...defaultApiConfig, ...config };
+        this.j2x = new XMLBuilder({ ...defaultXmlBuilderOptions, ...this.config.xmlBuilderOptions });
         this.callName = callName;
         this.fields = fields || {};
-        this.config = { ...defaultApiConfig, ...config };
         this.req = req;
     }
     getResponseWrapper() {
@@ -78,7 +80,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(),
@@ -116,7 +118,7 @@ class XMLRequest {
             log('error', error);
             if (error.response?.data) {
                 const json = this.toJSON(error.response.data);
-                checkEBayTraditionalResponse(error.response, json[this.callName + 'Response']);
+                checkEBayTraditionalResponse(error, json[this.callName + 'Response']);
             }
             throw error;
         }
@@ -126,5 +128,3 @@ class XMLRequest {
         return json[this.getResponseWrapper()] ?? json;
     }
 }
-XMLRequest.j2x = new XMLBuilder(defaultJSON2XMLOptions);
-export default XMLRequest;