ebay-api 9.4.3 → 9.5.0

package/README.md

@@ -75,7 +75,7 @@ For more examples, check out the [examples directory](./examples).
 
 ## Changelog
 
-* `v9.4.3` is the latest release.
+* `v9.5.0` is the latest release.
 * See [here](https://github.com/hendt/ebay-api/blob/master/CHANGELOG.md) for the full changelog.
 
 ## Implementation status
@@ -187,6 +187,7 @@ The first (required) parameter in eBayApi instance takes an object with followin
 | autoRefreshToken                  | Required<pre>Default: `true`</pre>                                                   | Auto refresh the token if it's expired.                                                                                                                                                                                                                                                                        |
 | siteId<br><i>Traditional</i>      | Required<br><pre>Default: `SiteId.EBAY_US`</pre>                                     | eBay site to which you want to send the request (Trading API, Shopping API).                                                                                                                                                                                                                                   |
 | authToken<br><i>Traditional</i>   | Optional                                                                             | The Auth'N'Auth token. The traditional authentication and authorization technology used by the eBay APIs.                                                                                                                                                                                                      |
+| parseOptions<br><i>Traditional</i> | Optional<br><pre>Default: `{ processEntities: { maxTotalExpansions: 10000 } }`</pre> | Global [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) parse options applied to all Traditional API responses. Can be overridden per-call. |
 | marketplaceId<br><i>RESTful</i>   | Required<br><pre>Default: `MarketplaceId.EBAY_US`</pre>                              | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#marketpl) REST HTTP Header. X-EBAY-C-MARKETPLACE-ID identifies the user's business context and is specified using a marketplace ID value. Note that this header does not indicate a language preference or consumer location.   |
 | scope<br><i>RESTful</i>           | Conditionally<bre><pre>Default:<br>`['https://api.ebay.com/oauth/api_scope']` </pre> | The scopes assigned to your application allow access to different API resources and functionality.                                                                                                                                                                                                             |
 | endUserCtx<br><i>RESTful</i>      | Conditionally recommended<br><i>RESTful</i>                                          | [Docs](https://developer.ebay.com/api-docs/static/rest-request-components.html#headers) X-EBAY\_C\_ENDUSERCTX provides various types of information associated with the request.                                                                                                                               |
@@ -562,12 +563,34 @@ The `errorCode` is extracted from the first error in the API response.
 
 ## Controlling Traditional XML request and response
 
+### Global parse options (constructor)
+
+Pass `parseOptions` in the constructor config to apply [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) options to **all** Traditional API responses:
+
+```typescript
+const eBay = new eBayApi({
+  appId: '...',
+  certId: '...',
+  devId: '...',
+  siteId: eBayApi.SiteId.EBAY_DE,
+  parseOptions: {
+    processEntities: {
+      maxTotalExpansions: 20000 // raise limit for stores with rich HTML descriptions (default: 10000)
+    }
+  }
+});
+```
+
+Per-call `parseOptions` (see below) are merged on top and take precedence.
+
+### Per-call options
+
 The second parameter in the traditional API has the following options:
 
 ```typescript
 export type Options = {
   raw?: boolean // return raw XML
-  parseOptions?: X2jOptions // https://github.com/NaturalIntelligence/fast-xml-parser
+  parseOptions?: X2jOptions // https://github.com/NaturalIntelligence/fast-xml-parser — merged with global parseOptions
   xmlBuilderOptions?: XmlBuilderOptions // https://github.com/NaturalIntelligence/fast-xml-parser
   useIaf?: boolean // use IAF in header instead of Bearer
   headers?: Headers // additional Headers (key, value)

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

@@ -22,6 +22,13 @@ export declare const defaultXML2JSONParseOptions: {
         leadingZeros: boolean;
     };
     removeNSPrefix: boolean;
+    processEntities: {
+        enabled: boolean;
+        maxEntitySize: number;
+        maxTotalExpansions: number;
+        maxExpandedLength: number;
+        maxEntityCount: number;
+    };
     isArray: (name: string, jpath: string) => boolean;
 };
 export type BodyHeaders = {
@@ -55,7 +62,6 @@ export default class XMLRequest {
     constructor(callName: string, fields: Fields | null, config: XMLReqConfig, req: IEBayApiRequest);
     private getResponseWrapper;
     private getCredentials;
-    private getParseOptions;
     private getHeaders;
     toJSON(xml: string): any;
     toXML(fields: Fields): string;

package/dist/api/traditional/XMLRequest.js

@@ -22,6 +22,13 @@ export const defaultXML2JSONParseOptions = {
         leadingZeros: false
     },
     removeNSPrefix: true,
+    processEntities: {
+        enabled: true,
+        maxEntitySize: 10000,
+        maxTotalExpansions: 10000,
+        maxExpandedLength: 100000,
+        maxEntityCount: 100
+    },
     isArray: (name, jpath) => {
         return /Array$/.test(jpath.slice(0, -name.length - 1));
     }
@@ -59,12 +66,6 @@ export default class XMLRequest {
             }
         } : {};
     }
-    getParseOptions() {
-        return {
-            ...defaultXML2JSONParseOptions,
-            ...this.config.parseOptions
-        };
-    }
     getHeaders() {
         return {
             ...defaultHeaders,
@@ -72,9 +73,8 @@ export default class XMLRequest {
         };
     }
     toJSON(xml) {
-        const parseOptions = this.getParseOptions();
-        log('parseOption', parseOptions);
-        return new XMLParser(parseOptions).parse(xml);
+        log('parseOption', this.config.parseOptions);
+        return new XMLParser(this.config.parseOptions).parse(xml);
     }
     toXML(fields) {
         const HEADING = '<?xml version="1.0" encoding="utf-8"?>';

package/dist/api/traditional/index.js

@@ -11,7 +11,20 @@ export default class Traditional extends Api {
     constructor() {
         super(...arguments);
         this.createXMLRequest = (callName, api) => async (fields, opts) => {
-            const apiConfig = { ...defaultApiConfig, ...opts };
+            const apiConfig = {
+                ...defaultApiConfig,
+                ...opts,
+                parseOptions: {
+                    ...defaultApiConfig.parseOptions,
+                    ...this.config.parseOptions,
+                    ...opts?.parseOptions,
+                    processEntities: {
+                        ...defaultApiConfig.parseOptions.processEntities,
+                        ...this.config.parseOptions?.processEntities,
+                        ...opts?.parseOptions?.processEntities
+                    }
+                }
+            };
             try {
                 return await this.request(apiConfig, api, callName, fields);
             }