restql 1.1.6 → 1.1.7

package/package.json

@@ -1,86 +1,74 @@
 {
   "name": "restql",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "RESTful API Resolver for Nested-Linked Resources | 🕸 🕷",
+  "type": "module",
   "main": "./dist/cjs/index.js",
-  "module": "./dist/es/index.js",
+  "module": "./dist/esm/index.js",
+  "unpkg": "./dist/umd/index.js",
   "files": [
     "dist/"
   ],
   "scripts": {
-    "prepare": "npm run clean && npm run lint && npm run test && npm run build",
-    "clean": "rimraf ./coverage/ ./dist/ ./stats.html",
-    "lint": "npm run lint:es && npm run lint:markdown",
-    "lint:es": "eslint ./src/",
-    "lint:es:fix": "npm run lint:es -- --fix",
-    "lint:markdown": "markdownlint $(find . -type f -name \"*.md\" -not \\( -path \"./.github/*\" -o -path \"./node_modules/*\" \\))",
-    "test": "npm run test:code:coverage",
-    "test:code": "cross-env BABEL_ENV=test jest --config ./.jest.config.json",
-    "test:code:coverage": "npm run test:code -- --coverage",
-    "test:code:watch": "npm run test:code -- --watch",
-    "build": "npm run build:cjs && npm run build:es && npm run build:umd && npm run build:umd:min",
-    "build:cjs": "cross-env BABEL_ENV=production NODE_ENV=development RESTQL_FMT=cjs rollup --config",
-    "build:es": "cross-env BABEL_ENV=production NODE_ENV=development RESTQL_FMT=es rollup --config",
-    "build:umd": "cross-env BABEL_ENV=production NODE_ENV=development RESTQL_FMT=umd rollup --config",
-    "build:umd:min": "cross-env BABEL_ENV=production NODE_ENV=production RESTQL_FMT=umd rollup --config"
+    "prepare": "npm run clear && npm run lint && npm run test && npm run build",
+    "clear": "rm -fr ./coverage/ ./dist/ ./stats.html",
+    "lint": "eslint ./src/",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "jest --config ./.jest.config.json",
+    "test:coverage": "npm run test -- --coverage",
+    "test:watch": "npm run test -- --watch",
+    "build": "npm run build:cjs && npm run build:esm && npm run build:umd && npm run build:umd:min",
+    "build:cjs": "BABEL_ENV=production MODULE_FMT=cjs rollup --config",
+    "build:esm": "BABEL_ENV=production MODULE_FMT=esm rollup --config",
+    "build:umd": "BABEL_ENV=production MODULE_FMT=umd rollup --config",
+    "build:umd:min": "BABEL_ENV=production MODULE_FMT=umd MINIFY=true rollup --config"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/relztic/restql.git"
   },
   "keywords": [
-    "library",
+    "package",
+    "javascript",
     "rest",
     "api",
-    "resolver",
-    "javascript",
-    "node",
-    "npm",
-    "yarn"
+    "recursive",
+    "resolver"
   ],
-  "author": "Ariel de Jesús Díaz Sánchez <relztic@gmail.com> (https://www.linkedin.com/in/relztic/)",
+  "author": "Ariel Díaz <relztic@gmail.com> (https://www.linkedin.com/in/relztic/)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/relztic/restql/issues/"
   },
   "homepage": "https://github.com/relztic/restql/#readme",
   "dependencies": {
-    "axios": "^0.17.1",
-    "babel-runtime": "^6.26.0",
-    "lodash": "^4.17.4",
-    "md5": "^2.2.1",
-    "url-regex": "^4.1.1"
+    "axios": "^1.13.6",
+    "lodash": "^4.17.23",
+    "md5": "^2.3.0",
+    "validator": "^13.15.26"
   },
   "devDependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-core": "^6.26.0",
-    "babel-eslint": "^8.2.1",
-    "babel-plugin-external-helpers": "^6.22.0",
-    "babel-plugin-transform-export-extensions": "^6.22.0",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-plugin-transform-runtime": "^6.23.0",
-    "babel-preset-env": "^1.6.1",
-    "cross-env": "^5.1.3",
-    "eslint": "^4.15.0",
-    "eslint-config-airbnb": "^16.1.0",
-    "eslint-config-prettier": "^2.9.0",
-    "eslint-plugin-import": "^2.8.0",
-    "eslint-plugin-jest": "^21.7.0",
-    "eslint-plugin-jsx-a11y": "^6.0.2",
-    "eslint-plugin-prettier": "^2.5.0",
-    "eslint-plugin-react": "^7.5.1",
-    "jest": "^22.1.4",
-    "markdownlint-cli": "^0.6.0",
-    "prettier": "1.10.2",
-    "rimraf": "^2.6.2",
-    "rollup": "^0.54.1",
-    "rollup-plugin-babel": "^3.0.3",
-    "rollup-plugin-commonjs": "^8.2.6",
-    "rollup-plugin-json": "^2.3.0",
-    "rollup-plugin-node-builtins": "^2.1.2",
-    "rollup-plugin-node-globals": "^1.1.0",
-    "rollup-plugin-node-resolve": "^3.0.0",
-    "rollup-plugin-uglify": "^2.0.1",
-    "rollup-plugin-visualizer": "^0.3.1"
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@rollup/plugin-babel": "^6.1.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@trivago/prettier-plugin-sort-imports": "^6.0.2",
+    "eslint": "^10.0.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-flat-config-airbnb": "^2.0.5",
+    "eslint-plugin-jest": "^29.15.0",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^17.3.0",
+    "jest": "^30.2.0",
+    "prettier": "^3.8.1",
+    "rollup": "^4.59.0",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "rollup-plugin-visualizer": "^7.0.0"
+  },
+  "overrides": {
+    "serialize-javascript": "^7.0.3"
   }
-}
+}

package/dist/es/index.js

@@ -1,544 +0,0 @@
-import _regeneratorRuntime from 'babel-runtime/regenerator';
-import cloneDeep from 'lodash/cloneDeep';
-import merge from 'lodash/merge';
-import axios from 'axios';
-import md5 from 'md5';
-import UrlRegex from 'url-regex';
-
-var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) {
-  return typeof obj;
-} : function (obj) {
-  return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
-};
-
-
-
-
-
-
-
-
-
-var asyncToGenerator = function (fn) {
-  return function () {
-    var gen = fn.apply(this, arguments);
-    return new Promise(function (resolve, reject) {
-      function step(key, arg) {
-        try {
-          var info = gen[key](arg);
-          var value = info.value;
-        } catch (error) {
-          reject(error);
-          return;
-        }
-
-        if (info.done) {
-          resolve(value);
-        } else {
-          return Promise.resolve(value).then(function (value) {
-            step("next", value);
-          }, function (err) {
-            step("throw", err);
-          });
-        }
-      }
-
-      return step("next");
-    });
-  };
-};
-
-
-
-
-
-
-
-
-
-var defineProperty = function (obj, key, value) {
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value: value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-
-  return obj;
-};
-
-var _extends = Object.assign || function (target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = arguments[i];
-
-    for (var key in source) {
-      if (Object.prototype.hasOwnProperty.call(source, key)) {
-        target[key] = source[key];
-      }
-    }
-  }
-
-  return target;
-};
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-var slicedToArray = function () {
-  function sliceIterator(arr, i) {
-    var _arr = [];
-    var _n = true;
-    var _d = false;
-    var _e = undefined;
-
-    try {
-      for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
-        _arr.push(_s.value);
-
-        if (i && _arr.length === i) break;
-      }
-    } catch (err) {
-      _d = true;
-      _e = err;
-    } finally {
-      try {
-        if (!_n && _i["return"]) _i["return"]();
-      } finally {
-        if (_d) throw _e;
-      }
-    }
-
-    return _arr;
-  }
-
-  return function (arr, i) {
-    if (Array.isArray(arr)) {
-      return arr;
-    } else if (Symbol.iterator in Object(arr)) {
-      return sliceIterator(arr, i);
-    } else {
-      throw new TypeError("Invalid attempt to destructure non-iterable instance");
-    }
-  };
-}();
-
-// External Packages
-/**
- * @constant {Object} responses The responses to cache.
- */
-var responses = {};
-
-/**
- * Fetches a resource based on its options, if not cached.
- *
- * @param {string} resource The resource to fetch.
- * @param {Object} options  The options to bypass.
- * @returns {Promise<Object>} A promise which resolves into an object.
- */
-var fetchResource = (function () {
-  var _ref = asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(resource, options) {
-    var key;
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            key = md5(resource + '-' + JSON.stringify(options));
-
-
-            if (!(key in responses)) {
-              responses[key] = axios(resource, options).then(function (response) {
-                responses[key] = response;
-
-                return response;
-              });
-            }
-
-            return _context.abrupt('return', responses[key]);
-
-          case 3:
-          case 'end':
-            return _context.stop();
-        }
-      }
-    }, _callee, this);
-  }));
-
-  function fetchResource(_x, _x2) {
-    return _ref.apply(this, arguments);
-  }
-
-  return fetchResource;
-})();
-
-// External Packages
-/**
- * @constant {Object} urlRegex The URL regex to test.
- */
-var urlRegex = UrlRegex({ exact: true });
-
-/**
- * Determines whether or not a resource is valid.
- *
- * @param {string} resource The resource to test.
- * @returns {boolean} Whether or not a resource is valid.
- */
-function isResource(resource) {
-  return urlRegex.test(resource);
-}
-
-/**
- * @constant {string} PROP_DELIMITER The delimiter of a property.
- */
-var PROP_DELIMITER = '.';
-
-/**
- * @constant {RegExp} REGEX_PROP_IS_ARR_IS_OPT Determines whether or not a property is an array and/or is optional.
- */
-var REGEX_PROP_IS_ARR_IS_OPT = /^([^[\]?]+)(\[])?(\?)?$/;
-
-/**
- * @constant {Object} constants The constants of the library.
- */
-var constants = Object.freeze({
-  PROP_DELIMITER: PROP_DELIMITER,
-  REGEX_PROP_IS_ARR_IS_OPT: REGEX_PROP_IS_ARR_IS_OPT
-});
-
-// Internal Packages
-/**
- * Gets the parsed properties from an object.
- *
- * @param {Object} obj   The object to use.
- * @param {string} props The properties to apply.
- * @returns {Array} An array.
- * @throws {RuntimeError} If a property could not be got.
- */
-function objectGet(obj, props) {
-  var nextPropsArr = props.split(constants.PROP_DELIMITER);
-
-  var _ref = constants.REGEX_PROP_IS_ARR_IS_OPT.exec(nextPropsArr.shift()) || [],
-      _ref2 = slicedToArray(_ref, 4),
-      prop = _ref2[1],
-      isArr = _ref2[2],
-      isOpt = _ref2[3];
-
-  var nextProps = nextPropsArr.join(constants.PROP_DELIMITER);
-
-  if (!prop) {
-    return obj;
-  }
-
-  if (!(prop in obj)) {
-    if (isOpt) {
-      return isArr ? [] : null;
-    }
-
-    throw new Error('RuntimeError: could not get property `' + prop + '`');
-  }
-
-  var nextObjs = obj[prop];
-
-  return isArr ? nextObjs.map(function (nextObj) {
-    return objectGet(nextObj, nextProps);
-  }) : objectGet(nextObjs, nextProps);
-}
-
-// Internal Packages
-/**
- * Sets the parsed properties to an object.
- *
- * @param {Array}  data  The data to use.
- * @param {string} props The properties to apply.
- * @returns {Object} An object.
- */
-function objectSet(data, props) {
-  var nextPropsArr = props.split(constants.PROP_DELIMITER);
-
-  var _ref = constants.REGEX_PROP_IS_ARR_IS_OPT.exec(nextPropsArr.shift()) || [],
-      _ref2 = slicedToArray(_ref, 3),
-      prop = _ref2[1],
-      isArr = _ref2[2];
-
-  var nextProps = nextPropsArr.join(constants.PROP_DELIMITER);
-
-  if (!prop) {
-    return data;
-  }
-
-  return defineProperty({}, prop, isArr ? data.map(function (nextData) {
-    return objectSet(nextData, nextProps);
-  }) : objectSet(data, nextProps));
-}
-
-// External Packages
-// Internal Packages
-/**
- * Resolves the nested-linked resources of a RESTful API.
- *
- * @param {string} resource The resource to fetch.
- * @param {Object} resolver The resolver to apply.
- * @param {Object} options  The options to bypass.
- * @returns {Promise<Object>} A promise which resolves into an object.
- * @throws {InvalidArgumentError} If a resource is invalid.
- * @throws {RuntimeError}         If a resource could not be fetched.
- */
-var resolve = (function () {
-  var _ref = asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(resource, resolver, options) {
-    var _this = this;
-
-    var response, obj, resourcesObj, resourcesArr, responses;
-    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-      while (1) {
-        switch (_context3.prev = _context3.next) {
-          case 0:
-            if (resource) {
-              _context3.next = 2;
-              break;
-            }
-
-            return _context3.abrupt('return', null);
-
-          case 2:
-            if (isResource(resource)) {
-              _context3.next = 4;
-              break;
-            }
-
-            throw new Error('InvalidArgumentError: invalid resource `' + resource + '`');
-
-          case 4:
-            _context3.t0 = cloneDeep;
-            _context3.next = 7;
-            return fetchResource(resource, options);
-
-          case 7:
-            _context3.t1 = _context3.sent;
-            response = (0, _context3.t0)(_context3.t1);
-
-            if (response.config.validateStatus(response.status)) {
-              _context3.next = 11;
-              break;
-            }
-
-            throw new Error('RuntimeError: could not fetch resource `' + resource + '`');
-
-          case 11:
-            obj = response.data;
-
-            if (resolver) {
-              _context3.next = 14;
-              break;
-            }
-
-            return _context3.abrupt('return', obj);
-
-          case 14:
-            resourcesObj = Object.keys(resolver).map(function (props) {
-              return defineProperty({}, props, objectGet(obj, props));
-            });
-            resourcesArr = Object.entries(resourcesObj.reduce(function (result, val) {
-              return _extends({}, result, val);
-            }, {}));
-            _context3.next = 18;
-            return Promise.all(resourcesArr.map(function () {
-              var _ref4 = asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref3) {
-                var _ref5 = slicedToArray(_ref3, 2),
-                    props = _ref5[0],
-                    resources = _ref5[1];
-
-                var nextResolver, data;
-                return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-                  while (1) {
-                    switch (_context2.prev = _context2.next) {
-                      case 0:
-                        nextResolver = resolver[props];
-
-                        if (!Array.isArray(resources)) {
-                          _context2.next = 7;
-                          break;
-                        }
-
-                        _context2.next = 4;
-                        return Promise.all(resources.map(function () {
-                          var _ref6 = asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(nextResource) {
-                            return _regeneratorRuntime.wrap(function _callee$(_context) {
-                              while (1) {
-                                switch (_context.prev = _context.next) {
-                                  case 0:
-                                    return _context.abrupt('return', resolve(nextResource, nextResolver, options));
-
-                                  case 1:
-                                  case 'end':
-                                    return _context.stop();
-                                }
-                              }
-                            }, _callee, _this);
-                          }));
-
-                          return function (_x5) {
-                            return _ref6.apply(this, arguments);
-                          };
-                        }()));
-
-                      case 4:
-                        _context2.t0 = _context2.sent;
-                        _context2.next = 10;
-                        break;
-
-                      case 7:
-                        _context2.next = 9;
-                        return resolve(resources, nextResolver, options);
-
-                      case 9:
-                        _context2.t0 = _context2.sent;
-
-                      case 10:
-                        data = _context2.t0;
-                        return _context2.abrupt('return', [props, data]);
-
-                      case 12:
-                      case 'end':
-                        return _context2.stop();
-                    }
-                  }
-                }, _callee2, _this);
-              }));
-
-              return function (_x4) {
-                return _ref4.apply(this, arguments);
-              };
-            }()));
-
-          case 18:
-            responses = _context3.sent;
-            return _context3.abrupt('return', responses.reduce(function (result, _ref7) {
-              var _ref8 = slicedToArray(_ref7, 2),
-                  props = _ref8[0],
-                  data = _ref8[1];
-
-              return merge(result, objectSet(data, props));
-            }, obj));
-
-          case 20:
-          case 'end':
-            return _context3.stop();
-        }
-      }
-    }, _callee3, this);
-  }));
-
-  function resolve(_x, _x2, _x3) {
-    return _ref.apply(this, arguments);
-  }
-
-  return resolve;
-})();
-
-/**
- * Determines whether or not an object is valid.
- *
- * @param {Object} obj The object to test.
- * @returns {boolean} Whether or not an object is valid.
- */
-function isObject(obj) {
-  return obj !== null && (typeof obj === 'undefined' ? 'undefined' : _typeof(obj)) === 'object' && !Array.isArray(obj);
-}
-
-// Internal Packages
-/**
- * Determines whether or not a resolver is valid.
- *
- * @param {Object} resolver The resolver to test.
- * @returns {boolean} Whether or not a resolver is valid.
- */
-function isResolver(resolver) {
-  if (!resolver) {
-    return true;
-  }
-
-  var keys = Object.keys(resolver);
-
-  if (!keys.length) {
-    return false;
-  }
-
-  return keys.map(function (key) {
-    return !key.startsWith(constants.PROP_DELIMITER) && !key.endsWith(constants.PROP_DELIMITER) && isResolver(resolver[key]);
-  }).reduce(function (result, val) {
-    return result && val;
-  }, true);
-}
-
-// Internal Packages
-/**
- * Resolves the nested-linked resources of a RESTful API.
- *
- * @param {string} resource  The resource to fetch.
- * @param {Object} resolver  The resolver to apply.
- * @param {Object} [options] The options to bypass.
- * @returns {Promise<Object>} A promise which resolves into an object.
- * @throws {InvalidArgumentError} If a resolver is invalid.
- * @throws {InvalidArgumentError} If an options are invalid.
- */
-var restql = (function () {
-  var _ref = asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(resource, resolver) {
-    var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            if (!(!isObject(resolver) || !isResolver(resolver))) {
-              _context.next = 2;
-              break;
-            }
-
-            throw new Error('InvalidArgumentError: invalid resolver `' + JSON.stringify(resolver) + '`');
-
-          case 2:
-            if (isObject(options)) {
-              _context.next = 4;
-              break;
-            }
-
-            throw new Error('InvalidArgumentError: invalid options `' + JSON.stringify(options) + '`');
-
-          case 4:
-            return _context.abrupt('return', resolve(resource, resolver, options));
-
-          case 5:
-          case 'end':
-            return _context.stop();
-        }
-      }
-    }, _callee, this);
-  }));
-
-  function restql(_x2, _x3) {
-    return _ref.apply(this, arguments);
-  }
-
-  return restql;
-})();
-
-export default restql;