Don't include deleted parameter for default value (#130)

* bump version

* Only calculate glue when needed

* Skip deleted if not set

* Attempt to fix lint

* update packages

* Fix/add tests

* Fix hash test

* Upgrade eslint

* Upgrade most dependencies

* Upgrade last dependencies

* Downgrade eslint and fix hasOwnProperty

* Downgrade eslint and fix hasOwnProperty

Author: Mechazawa

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapcreator/maps4news",
-  "version": "1.6.34",
+  "version": "1.6.35",
   "description": "Maps4News JavaScript Api",
   "main": "dist/bundle.js",
   "repository": "[email protected]:MapcreatorIO/api-wrapper.git",
@@ -12,52 +12,51 @@
     "manual"
   ],
   "dependencies": {
-    "@babel/runtime": "^7.2.0",
-    "axios": "^0.18.0",
-    "case": "^1.6.1",
-    "form-data": "^2.3.3",
+    "@babel/runtime": "^7.10.2",
+    "axios": "^0.19.2",
+    "case": "^1.6.3",
+    "form-data": "^3.0.0",
     "json-stable-stringify": "^1.0.1",
-    "mitt": "^1.1.2"
+    "mitt": "^1.2.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.2.2",
-    "@babel/plugin-proposal-class-properties": "^7.2.3",
-    "@babel/plugin-proposal-export-default-from": "^7.2.0",
-    "@babel/plugin-proposal-export-namespace-from": "^7.2.0",
-    "@babel/plugin-transform-runtime": "^7.2.0",
-    "@babel/preset-env": "^7.2.3",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-eslint": "^10.0.1",
-    "babel-jest": "^23.6.0",
-    "babel-loader": "^8.0.5",
+    "@babel/core": "^7.10.2",
+    "@babel/plugin-proposal-class-properties": "^7.10.1",
+    "@babel/plugin-proposal-export-default-from": "^7.10.1",
+    "@babel/plugin-proposal-export-namespace-from": "^7.10.1",
+    "@babel/plugin-transform-runtime": "^7.10.1",
+    "@babel/preset-env": "^7.10.2",
+    "babel-eslint": "^10.1.0",
+    "babel-jest": "^26.0.1",
+    "babel-loader": "^8.1.0",
     "contributors": "^0.5.1",
-    "dotenv-webpack": "^1.7.0",
+    "dotenv-webpack": "^1.8.0",
     "esdoc": "^1.1.0",
     "esdoc-ecmascript-proposal-plugin": "^1.0.0",
     "esdoc-inject-script-plugin": "^1.0.0",
     "esdoc-inject-style-plugin": "^1.0.0",
     "esdoc-standard-plugin": "^1.0.0",
     "eslint": "^5.12.0",
-    "eslint-plugin-compat": "^2.6.3",
-    "eslint-plugin-promise": "^4.0.1",
-    "fs-extra": "^6.0.1",
-    "jest": "^23.6.0",
-    "jest-junit": "^5.2.0",
+    "eslint-plugin-compat": "^3.7.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "fs-extra": "^9.0.1",
+    "jest": "^26.0.1",
+    "jest-junit": "^10.0.0",
     "licensecheck": "^1.3.0",
     "moxios": "^0.4.0",
-    "nyc": "^11.9.0",
+    "nyc": "^15.1.0",
     "tap-nyc": "^1.0.3",
-    "uglifyjs-webpack-plugin": "^1.3.0",
-    "webpack": "^4.28.4",
-    "webpack-cli": "^3.3.10",
-    "webpack-merge": "^4.2.1",
+    "uglifyjs-webpack-plugin": "^2.2.0",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11",
+    "webpack-merge": "^4.2.2",
     "webpack-node-externals": "^1.7.2"
   },
   "scripts": {
     "build": "APP_ENV=production npx webpack",
     "watch": "npx webpack --progress --watch",
     "docs": "npx esdoc",
-    "lint": "APP_ENV=production npx eslint --no-color --format checkstyle --output-file build/checkstyle.xml src",
+    "lint": "npx eslint --no-color --format checkstyle --output-file build/checkstyle.xml src",
     "clean": "rm -fr dist docs build || true",
     "all": "npm run clean && npm run lint && npm run build && npm run test && npm run docs",
     "test": "npx jest",

package.json

@@ -244,10 +244,10 @@ export default class RequestParameters extends EventEmitter {
 
   /**
    * Default deleted items filter state
-   * @returns {String} -  Deleted items filter state
+   * @returns {String|undefined} -  Deleted items filter state
    */
   static get deleted () {
-    return RequestParameters._deleted || DeletedState.NONE;
+    return RequestParameters._deleted || void 0;
   }
 
   /**
@@ -470,6 +470,10 @@ export default class RequestParameters extends EventEmitter {
   }
 
   static _validateDeleted (value) {
+    if (typeof value === 'undefined') {
+      return value;
+    }
+
     if (typeof value !== 'string') {
       throw new TypeError(`Expected deleted to be of type "string" got "${getTypeName(value)}". See: DeletedState`);
     }
@@ -605,6 +609,12 @@ export default class RequestParameters extends EventEmitter {
       data[key] = extra[key];
     }
 
+    for (const key of Object.keys(data)) {
+      if (typeof data[key] === 'undefined') {
+        delete data[key];
+      }
+    }
+
     return data;
   }
 

src/RequestParameters.js

@@ -62,7 +62,7 @@ export default class ResourceLister extends EventEmitter {
 
     this._api = api;
     this._Resource = Resource;
-    this._route = route || (new this.Resource(api, {})).baseUrl;
+    this._route = route || new this.Resource(api, {}).baseUrl;
     this._parameters = new RequestParameters(parameters || { perPage: RequestParameters.maxPerPage });
     this._key = snakeCase(key);
     this._waiting = false;

src/ResourceLister.js

@@ -72,16 +72,19 @@ export default class ResourceProxy extends SimpleResourceProxy {
   /**
    * Get target resource
    * @param {Number|String|Object} [id=] - The resource id to be requested
-   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=null] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<ResourceBase>} - Target resource
    * @throws {ApiError}
    */
-  async get (id, deleted = RequestParameters.deleted) {
+  async get (id, deleted = null) {
     const data = { ...this._seedData, ...this._parseSelector(id) };
     let url = this.new(data).url;
-    const glue = url.includes('?') ? '&' : '?';
 
-    url += glue + encodeQueryString({ deleted });
+    if (typeof deleted === 'string') {
+      const glue = url.includes('?') ? '&' : '?';
+
+      url += glue + encodeQueryString({ deleted });
+    }
 
     const { data: { data: result } } = await this.api.axios.get(url);
 

src/proxy/ResourceProxy.js

@@ -76,7 +76,7 @@ export default class User extends CrudBase {
    * @throws {ApiError}
    */
   organisation () {
-    return (new ResourceProxy(this.api, Organisation)).get(this.organisationId);
+    return new ResourceProxy(this.api, Organisation).get(this.organisationId);
   }
 
   /**
@@ -85,7 +85,7 @@ export default class User extends CrudBase {
    * @throws {ApiError}
    */
   language () {
-    return (new ResourceProxy(this.api, Language)).get(this.languageCode);
+    return new ResourceProxy(this.api, Language).get(this.languageCode);
   }
 
   // region Resource listing

src/resources/User.js

@@ -76,6 +76,10 @@ export function isParentOf (parent, child) {
  * @returns {string} - Value type name
  */
 export function getTypeName (value) {
+  if (typeof value === 'undefined') {
+    return 'undefined';
+  }
+
   value = typeof value === 'function' ? value : value.constructor;
 
   return value.name;
@@ -86,7 +90,8 @@ export function getTypeName (value) {
  * Helper class for mix
  * @see {@link mix}
  */
-class Empty {}
+class Empty {
+}
 
 /**
  * Copy properties from source to target

src/utils/reflection.js

@@ -60,17 +60,17 @@ test('RequestParameters should be able to reset defaults', () => {
 test('RequestParameters can generate cache tokens', () => {
   const params = cleanParams.copy();
 
-  expect(params.token()).toEqual('65f40b0d'); // Default token
+  expect(params.token()).toEqual('0c574931'); // Default token
 
   // Page and perPage shouldn't affect the token
   params.page = Math.round(Math.random() * 100000);
   params.perPage = Math.round(Math.random() * 50);
 
-  expect(params.token()).toEqual('65f40b0d');
+  expect(params.token()).toEqual('0c574931');
 
   params.sort = 'quick,-brown,fox';
 
-  expect(params.token()).toEqual('b4b47dc1');
+  expect(params.token()).toEqual('47115fb4');
 });
 
 const validationTests = {
@@ -150,7 +150,19 @@ test('issue #93', () => {
   const params = new RequestParameters({sort: '-name'});
 
   expect(params.toObject().sort).toEqual(['-name']);
-  expect(params.encode()).toEqual('deleted=none&page=1&per_page=12&sort=-name');
+  expect(params.encode()).toEqual('page=1&per_page=12&sort=-name');
+});
+
+test('deleted will be omitted unless defined', () => {
+  const params = new RequestParameters();
+
+  expect(params.toObject().deleted).toBeUndefined();
+  expect(params.encode()).toEqual('page=1&per_page=12&sort=');
+
+  params.deleted = DeletedState.ALL;
+
+  expect(params.toObject().deleted).toEqual(DeletedState.ALL);
+  expect(params.encode()).toEqual('deleted=all&page=1&per_page=12&sort=');
 });
 
 test('extra parameters overwrite others', () => {
@@ -178,7 +190,7 @@ test('encoded search keys must be snake_case', () => {
     'fooBar,Baz': 'test',
   };
 
-  expect(params.encode()).toEqual('deleted=none&page=1&per_page=12&search[foo_bar,baz]=test&sort='.replace(',', '%2C'));
+  expect(params.encode()).toEqual('page=1&per_page=12&search[foo_bar,baz]=test&sort='.replace(',', '%2C'));
 });
 
 test('null is properly encoded', () => {
@@ -188,7 +200,7 @@ test('null is properly encoded', () => {
     foo: null,
   };
 
-  expect(params.encode()).toEqual('deleted=none&foo&page=1&per_page=12&sort=');
+  expect(params.encode()).toEqual('foo&page=1&per_page=12&sort=');
 });
 
 test('RequestParameters can have properties applied to it', () => {
@@ -205,9 +217,9 @@ test('RequestParameters can have properties applied to it', () => {
     _deleted: 'only',
   });
 
-  expect(params.deleted).toEqual('none');
+  expect(params.deleted).toBeUndefined();
   expect(params.toParameterObject().pirateFlag).toEqual('cool');
-  expect(params.foo).toEqual(undefined);
+  expect(params.foo).toBeUndefined();
 });
 
 test('RequestParameters can have properties applied to it from other RequestParameters', () => {
@@ -224,7 +236,7 @@ test('RequestParameters can have properties applied to it from other RequestPara
     _deleted: 'only',
   }));
 
-  expect(params.deleted).toEqual('none');
+  expect(params.deleted).toBeUndefined();
   expect(params.toParameterObject().pirateFlag).toEqual('cool');
-  expect(params.foo).toEqual(undefined);
+  expect(params.foo).toBeUndefined();
 });