ebay-api 1.13.4 → 6.0.0

package/lib/types/restfulTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=restfulTypes.js.map

package/lib/types/restfulTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restfulTypes.js","sourceRoot":"","sources":["../../src/types/restfulTypes.ts"],"names":[],"mappings":""}

package/lib/types/traditonalTypes.d.ts

@@ -0,0 +1,34 @@
+import ClientAlertsCalls from '../api/traditional/clientAlerts';
+import { Fields } from '../api/traditional/fields';
+import FindingCalls from '../api/traditional/finding';
+import ShoppingCalls from '../api/traditional/shopping';
+import TradingCalls from '../api/traditional/trading';
+import MerchandisingCalls from '../api/traditional/merchandising';
+import { Options } from '../api/traditional/XMLRequest';
+export declare type XMLApiCall = (fields?: Fields, options?: Options) => Promise<any>;
+export declare type Trading = {
+    [key in typeof TradingCalls[number]]: XMLApiCall;
+};
+export declare type Shopping = {
+    [key in typeof ShoppingCalls[number]]: XMLApiCall;
+};
+export declare type Finding = {
+    [key in typeof FindingCalls[number]]: XMLApiCall;
+};
+export declare type ClientAlerts = {
+    [key in typeof ClientAlertsCalls[number]]: (fields?: object, options?: Options) => Promise<any>;
+};
+export declare type Merchandising = {
+    [key in typeof MerchandisingCalls[number]]: (fields?: object, options?: Options) => Promise<any>;
+};
+declare type Endpoint = {
+    production: string;
+    sandbox: string;
+};
+export declare type TraditionalApi = {
+    endpoint: Endpoint;
+    xmlns: string;
+    calls: typeof TradingCalls | typeof ShoppingCalls | typeof FindingCalls | typeof ClientAlertsCalls | typeof MerchandisingCalls;
+    headers: (callName: string, accessToken?: string) => object;
+};
+export {};

package/lib/types/traditonalTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=traditonalTypes.js.map

package/lib/types/traditonalTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traditonalTypes.js","sourceRoot":"","sources":["../../src/types/traditonalTypes.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,31 +1,125 @@
 {
   "name": "ebay-api",
-  "description": "eBay API Client",
-  "version": "1.13.4",
-  "homepage": "https://github.com/benbuckman/nodejs-ebay-api",
-  "author": "Ben Buckman",
-  "repository": {
-    "url": "git://github.com/benbuckman/nodejs-ebay-api.git"
+  "author": "Daniil Tomilow",
+  "version": "6.0.0",
+  "description": "eBay TypeScript/JavaScript API for Node and Browser",
+  "browser": "./lib/ebay-api.min.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.js",
+  "scripts": {
+    "build": "rimraf lib && tsc && rollup -c",
+    "prepare": "npm run build",
+    "coverage": "codecov",
+    "tslint": "tslint -c tslint.json '{src,test,examples}/**/*.ts'",
+    "test": "mocha -r ts-node/register 'test/**/*.spec.ts' --reporter=dot",
+    "report": "nyc npm run test",
+    "report:summary": "nyc --reporter=lcov --reporter=text-summary npm run test",
+    "prerelease": "npm run tslint && npm run test && npm run build",
+    "release": "standard-version",
+    "rc": "npm run release -- --prerelease RC && git push --follow-tags origin next"
   },
-  "main": "index.js",
   "dependencies": {
-    "async": "1.5.2",
-    "debug": "2.2.0",
-    "lodash": "3.10.1",
-    "request": "2.72.0",
-    "xml": "1.0.1",
-    "xml2js": "0.4.16"
+    "axios": "^0.21.4",
+    "debug": "^2.1.1",
+    "fast-xml-parser": "^3.19.0",
+    "nanoevents": "^2.0.0",
+    "qs": "^6.8.0"
   },
   "devDependencies": {
-    "chai": "3.5.0",
-    "mocha": "2.5.3",
-    "sinon": "1.17.4",
-    "sinon-chai": "2.8.0"
+    "@rollup/plugin-commonjs": "^15.1.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^9.0.0",
+    "@rollup/plugin-strip": "^2.0.0",
+    "@types/chai": "^4.2.3",
+    "@types/debug": "^4.1.5",
+    "@types/mocha": "^5.2.7",
+    "@types/nanoevents": "^1.0.0",
+    "@types/node": "^12.7.4",
+    "@types/qs": "^6.5.3",
+    "@types/sinon": "^7.0.13",
+    "chai": "^3.5.0",
+    "form-data": "^4.0.0",
+    "mocha": "^9.1.2",
+    "nyc": "^15.1.0",
+    "readline": "^1.3.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.28.2",
+    "rollup-plugin-terser": "^7.0.2",
+    "sinon": "^7.4.2",
+    "standard-version": "^9.0.0",
+    "ts-node": "^8.4.1",
+    "tslint": "^6.1.0",
+    "typescript": "^4.0.3"
   },
-  "scripts": {
-    "test": "mocha"
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/hendt/ebay-api.git"
+  },
+  "keywords": [
+    "api",
+    "eBay",
+    "Shopping",
+    "Searching",
+    "products",
+    "Browse",
+    "Category",
+    "FindingApi",
+    "node-api",
+    "eBay Traditional API",
+    "eBay Full API",
+    "eBay Account API",
+    "eBay Inventory API",
+    "eBay Compliance API",
+    "eBay Marketing API",
+    "eBay Fulfillment API",
+    "eBay Marketing API",
+    "eBay Analytics API",
+    "eBay Metadata API",
+    "eBay Browse API",
+    "eBay Feed API",
+    "eBay Order API",
+    "eBay Marketplace Insights API",
+    "eBay Taxonomy API",
+    "eBay Catalog API",
+    "eBay Translation API",
+    "eBay Analytics API",
+    "eBay Finding API",
+    "eBay Shopping API",
+    "eBay Merchandising API",
+    "eBay Trading API",
+    "eBay Product Services",
+    "eBay Client Alerts API",
+    "ebay-node",
+    "eBay-node-api",
+    "eBay-node-client",
+    "eBay-typescript",
+    "eBay-await",
+    "eBay-async",
+    "eBay-promises",
+    "eBay-products",
+    "eBay-sellers",
+    "eBay-orders",
+    "eBay-finances",
+    "eBay-inventory",
+    "eBay-shipment",
+    "eBay-api",
+    "eBay-sdk",
+    "eBay-client",
+    "eBay-node-api",
+    "eBay-node"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/hendt/ebay-api/issues"
+  },
+  "homepage": "https://github.com/hendt/ebay-api#readme",
+  "directories": {
+    "test": "test"
   },
   "engines": {
-    "node": ">= 0.10"
-  }
+    "node": ">= 14.0.0"
+  },
+  "files": [
+    "lib"
+  ]
 }

package/.npmignore

@@ -1,17 +0,0 @@
-lib-cov
-*.seed
-*.log
-*.csv
-*.dat
-*.out
-*.pid
-*.gz
-
-pids
-logs
-results
-
-node_modules
-npm-debug.log
-
-.idea

package/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: node_js
-node_js:
-  - "4.1"
-  - "4.0"
-  - "0.12"
-  - "0.10"

package/examples/Finding-FindItemsByKeywords.js

@@ -1,46 +0,0 @@
-/**
- * example eBay API request to FindingService:findItemsByKeywords
- */
-
-var ebay = require('../index.js');
-
-var params = {
-  keywords: ["Canon", "Powershot"],
-
-  // add additional fields
-  outputSelector: ['AspectHistogram'],
-
-  paginationInput: {
-    entriesPerPage: 10
-  },
-
-  itemFilter: [
-    {name: 'FreeShippingOnly', value: true},
-    {name: 'MaxPrice', value: '150'}
-  ],
-
-  domainFilter: [
-    {name: 'domainName', value: 'Digital_Cameras'}
-  ]
-};
-
-ebay.xmlRequest({
-    serviceName: 'Finding',
-    opType: 'findItemsByKeywords',
-    appId: '......................',      // FILL IN YOUR OWN APP KEY, GET ONE HERE: https://publisher.ebaypartnernetwork.com/PublisherToolsAPI
-    params: params,
-    parser: ebay.parseResponseJson    // (default)
-  },
-  // gets all the items together in a merged array
-  function itemsCallback(error, itemsResponse) {
-    if (error) throw error;
-
-    var items = itemsResponse.searchResult.item;
-
-    console.log('Found', items.length, 'items');
-    
-    for (var i = 0; i < items.length; i++) {
-      console.log('- ' + items[i].title);
-    }  
-  }
-);

package/examples/Merchandising-GetMostWatchedItemsRequest.js

@@ -1,16 +0,0 @@
-/**
- * example ebay API request to Merchandising:getMostWatchedItems
- */
-
-var ebay = require('../index.js');
-
-ebay.xmlRequest({
-  'serviceName': 'Merchandising',
-  'opType': 'getMostWatchedItems',
-  'appId': '......................',      // FILL IN YOUR OWN APP KEY, GET ONE HERE: https://publisher.ebaypartnernetwork.com/PublisherToolsAPI
-
-  params: {}
-},
-function(error, data) {
-  // ...
-});

package/examples/Shopping-GetSingleItem.js

@@ -1,18 +0,0 @@
-/**
- * example ebay API request to Shopping:GetSingleItem
- */
-
-var ebay = require('../index.js');
-
-ebay.xmlRequest({
-  'serviceName': 'Shopping',
-  'opType': 'GetSingleItem',
-  'appId': '......................',      // FILL IN YOUR OWN APP KEY, GET ONE HERE: https://publisher.ebaypartnernetwork.com/PublisherToolsAPI
-  
-  params: {
-    'ItemID': '1234567890'      // FILL IN A REAL ItemID
-  }
-},
-function(error, data) {
-  // ...
-});

package/examples/Trading-GetOrders.js

@@ -1,26 +0,0 @@
-/**
- * example ebay API request to Trading:GetOrders
- */
-
-var ebay = require('../index.js');
-
-ebay.xmlRequest({
-  serviceName : 'Trading',
-  opType : 'GetOrders',
-
-  // app/environment
-  devId: '...........',
-  certId: '...........',
-  appId: '...........',
-  sandbox: true,
-
-  // per user
-  authToken: '...........',
-
-  params: {
-    'OrderStatus': 'Active',
-    'NumberOfDays': 1
-  }
-}, function(error, results) {
-  // ...
-});

package/index.js

@@ -1,10 +0,0 @@
-// eBay API client for Node.js
-
-var _ = require('lodash');
-
-module.exports = _.extend({},
-  require('./lib/xml-request'),
-  require('./lib/xml-converter'),
-  require('./lib/json-parser'),
-  require('./lib/errors')
-);

package/lib/deep-to-array.js

@@ -1,42 +0,0 @@
-var _ = require('lodash');
-
-  /**
- * handle quirk of 'xml' module:
- * need arrays all the way down,
- * and objects can only have a single key:value,
- * e.g. {k1:v1,k2:v2} need to become [{k1:[v1]}, {k2:[v2]}].
- * @see tests in xml-request.test.js.
- */
-exports.deepToArray = function deepToArray(obj) {
-  var key, value, arr = [];
-
-  if (_.isArray(obj)) {
-    // not sure about this: arrays within objects are handled below;
-    // top level should never be an array;
-    // but seems ok. change/fix if a scenario comes up that this breaks.
-    return obj.map(function(value) {
-      return deepToArray(value);
-    });
-  }
-  else if (_.isObject(obj)) {
-    for (key in obj) {
-      if (obj.hasOwnProperty(key)) {
-        value = obj[key];
-
-        // `{foo: [a,b,c]}` => `[{foo:a},{foo:b},{foo:c}]`
-        if (_.isArray(value)) {
-          value.forEach(function(subValue) {
-            arr.push(_.set({}, key, deepToArray(subValue)));
-          });
-        }
-        else {
-          arr.push(_.set({}, key, deepToArray(value)));
-        }
-      }
-    }
-  }
-  else {
-    arr = [obj];
-  }
-  return arr;
-};

package/lib/defaults.js

@@ -1,69 +0,0 @@
-var
-  _ = require('lodash'),
-  debug = require('debug')('ebay:defaults');
-
-
-/*
-default params per service type.
-@param {object} options: request context. see `xmlRequest()` docs, and code below.
-*/
-exports.getDefaultHeaders = function(options) {
-  if (!options || !options.serviceName) throw new Error("Need serviceName for default params");
-
-  switch (options.serviceName) {
-    case 'Finding':
-      return {
-        'X-EBAY-SOA-SECURITY-APPNAME': options.appId ? options.appId : null,
-        'X-EBAY-SOA-REQUEST-DATA-FORMAT': 'XML',
-        'X-EBAY-SOA-RESPONSE-DATA-FORMAT': 'XML',
-        'X-EBAY-SOA-GLOBAL-ID': options.globalId ? options.globalId : 'EBAY-US',
-        'X-EBAY-SOA-SERVICE-VERSION': options.version ? options.version : '1.13.0',
-        'X-EBAY-SOA-OPERATION-NAME': options.opType
-      };
-
-    case 'Product':
-      return {
-        'SERVICE-NAME': options.opType,
-        'SECURITY-APPNAME': options.appId ? options.appId : null,
-        // based on response data
-        'SERVICE-VERSION': options.version ? options.version : '1.5.0',
-        'OPERATION-NAME': options.opType,
-        'GLOBAL-ID': options.globalId ? options.globalId : 'EBAY-US',
-        'RESPONSE-DATA-FORMAT': 'XML',
-        'REST-PAYLOAD': null     // (not sure what this does)
-      };
-
-    case 'Merchandising':
-      return {
-        'X-EBAY-SOA-SERVICE-NAME': 'MerchandisingService',
-        'X-EBAY-SOA-OPERATION-NAME': options.opType,
-        'EBAY-SOA-CONSUMER-ID': options.appId ? options.appId : null,
-        'SERVICE-VERSION': options.version ? options.version : '1.5.0',
-        'X-EBAY-SOA-REQUEST-DATA-FORMAT': 'XML',
-        //'RESPONSE-DATA-FORMAT': 'XML',
-        //'REST-PAYLOAD': null     // (not sure what this does)
-      };
-
-    case 'Shopping':
-      return {
-        'X-EBAY-API-APP-ID': options.appId ? options.appId : null,
-        'X-EBAY-API-CALL-NAME': options.opType,
-        'X-EBAY-API-VERSION': options.version ? options.version : '897',
-        'X-EBAY-API-SITE-ID': options.siteId ? options.siteId : '0', // US
-        'X-EBAY-API-REQUEST-ENCODING': 'XML',
-        'X-EBAY-API-RESPONSE-ENCODING': 'XML',
-        'Content-Type': 'text/xml',
-        //'Accept': 'text/xml'
-      };
-
-    case 'Trading':
-      return {
-        'X-EBAY-API-APP-NAME': options.appId,
-        'X-EBAY-API-CALL-NAME': options.opType,
-        'X-EBAY-API-COMPATIBILITY-LEVEL': options.version ? options.version : '775',
-        'X-EBAY-API-SITEID': options.siteId ? options.siteId : '0', // US
-        'X-EBAY-API-DEV-NAME': options.devId,
-        'X-EBAY-API-CERT-NAME': options.certId,
-      };
-  }
-};

package/lib/errors.js

@@ -1,44 +0,0 @@
-/**
- * Custom error types to differentiate eBay response errors and client-level errors.
- *
- * @see http://developer.ebay.com/devzone/xml/docs/Reference/ebay/Errors/ErrorMessages.htm
- */
-
-var
-  inherits = require('util').inherits,
-  _ = require('lodash');
-
-function EbayClientError(message, extraProps) {
-  Error.apply(this, arguments);
-  Error.captureStackTrace(this, this.constructor);
-  this.name = this.constructor.name;
-  this.message = message;
-  _.defaults(this, extraProps);
-}
-inherits(EbayClientError, Error);
-
-function EbaySystemError(message, extraProps) {
-  EbayClientError.apply(this, arguments);
-  this.name = this.constructor.name;
-}
-inherits(EbaySystemError, EbayClientError);
-
-function EbayRequestError(message) {
-  EbayClientError.apply(this, arguments);
-  this.name = this.constructor.name;
-}
-inherits(EbayRequestError, EbayClientError);
-
-function EbayAuthenticationError(message) {
-  EbayClientError.apply(this, arguments);
-  this.name = this.constructor.name;
-}
-inherits(EbayAuthenticationError, EbayClientError);
-
-
-module.exports = {
-  EbayClientError: EbayClientError,
-  EbaySystemError: EbaySystemError,
-  EbayRequestError: EbayRequestError,
-  EbayAuthenticationError: EbayAuthenticationError,
-};