restql 1.1.7 → 1.2.0

package/package.json

@@ -1,27 +1,38 @@
 {
   "name": "restql",
-  "version": "1.1.7",
+  "version": "1.2.0",
   "description": "RESTful API Resolver for Nested-Linked Resources | 🕸 🕷",
   "type": "module",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "unpkg": "./dist/umd/index.js",
+  "unpkg": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    }
+  },
   "files": [
     "dist/"
   ],
   "scripts": {
-    "prepare": "npm run clear && npm run lint && npm run test && npm run build",
-    "clear": "rm -fr ./coverage/ ./dist/ ./stats.html",
+    "prepare": "npm run clean && npm run lint && npm run test && npm run build",
+    "clean": "rm -fr ./coverage/ ./dist/ ./stats.html",
     "lint": "eslint ./src/",
     "lint:fix": "npm run lint -- --fix",
-    "test": "jest --config ./.jest.config.json",
+    "test": "jest ./src/",
     "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"
+    "build": "npm run build:cjs && npm run build:esm && npm run build:umd && npm run build:umd:min && npm run build:types",
+    "build:cjs": "MODULE_FMT=cjs rollup --config",
+    "build:esm": "MODULE_FMT=esm rollup --config",
+    "build:umd": "MODULE_FMT=umd rollup --config",
+    "build:umd:min": "MODULE_FMT=umd MINIFY=true rollup --config",
+    "build:types": "MODULE_FMT=esm TYPES=true rollup --config",
+    "playground": "tsx ./playground/index.ts"
   },
   "repository": {
     "type": "git",
@@ -29,7 +40,7 @@
   },
   "keywords": [
     "package",
-    "javascript",
+    "typescript",
     "rest",
     "api",
     "recursive",
@@ -42,31 +53,29 @@
   },
   "homepage": "https://github.com/relztic/restql/#readme",
   "dependencies": {
-    "axios": "^1.13.6",
-    "lodash": "^4.17.23",
-    "md5": "^2.3.0",
-    "validator": "^13.15.26"
+    "es-toolkit": "^1.44.0"
   },
   "devDependencies": {
-    "@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",
+    "@types/jest": "^30.0.0",
+    "eslint": "^10.0.3",
     "eslint-config-prettier": "^10.1.8",
     "eslint-flat-config-airbnb": "^2.0.5",
+    "eslint-import-resolver-typescript": "^4.4.4",
     "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"
+    "rollup-plugin-dts": "^6.3.0",
+    "rollup-plugin-esbuild": "^6.2.1",
+    "rollup-plugin-visualizer": "^7.0.0",
+    "ts-jest": "^29.4.6",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.1"
   },
   "overrides": {
     "serialize-javascript": "^7.0.3"

package/dist/cjs/index.js

@@ -1,191 +0,0 @@
-'use strict';
-
-var cloneDeep = require('lodash/cloneDeep');
-var merge = require('lodash/merge');
-var axios = require('axios');
-var md5 = require('md5');
-var isURL = require('validator/lib/isURL');
-
-/**
- * @constant {Object} responses The responses to cache.
- */
-const 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.
- */
-async function fetchResource(resource, options) {
-  const key = md5(`${resource}-${JSON.stringify(options)}`);
-  if (!(key in responses)) {
-    responses[key] = axios(resource, options).then(response => {
-      responses[key] = response;
-      return response;
-    });
-  }
-  return responses[key];
-}
-
-/**
- * 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 isURL(resource);
-}
-
-/**
- * @constant {string} PROP_DELIMITER The delimiter of a property.
- */
-const PROP_DELIMITER = '.';
-
-/**
- * @constant {RegExp} REGEX_PROP_IS_ARR_IS_OPT Determines whether or not a property is an array and/or is optional.
- */
-const REGEX_PROP_IS_ARR_IS_OPT = /^([^[\]?]+)(\[])?(\?)?$/;
-
-/**
- * @constant {Object} constants The constants of the library.
- */
-const constants = Object.freeze({
-  PROP_DELIMITER,
-  REGEX_PROP_IS_ARR_IS_OPT
-});
-
-/**
- * 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) {
-  const nextPropsArr = props.split(constants.PROP_DELIMITER);
-  const [, prop, isArr, isOpt] = constants.REGEX_PROP_IS_ARR_IS_OPT.exec(nextPropsArr.shift()) || [];
-  const 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}\``);
-  }
-  const nextObjs = obj[prop];
-  return isArr ? nextObjs.map(nextObj => objectGet(nextObj, nextProps)) : objectGet(nextObjs, nextProps);
-}
-
-/**
- * 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) {
-  const nextPropsArr = props.split(constants.PROP_DELIMITER);
-  const [, prop, isArr] = constants.REGEX_PROP_IS_ARR_IS_OPT.exec(nextPropsArr.shift()) || [];
-  const nextProps = nextPropsArr.join(constants.PROP_DELIMITER);
-  if (!prop) {
-    return data;
-  }
-  return {
-    [prop]: isArr ? data.map(nextData => objectSet(nextData, nextProps)) : objectSet(data, nextProps)
-  };
-}
-
-/**
- * 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.
- */
-async function resolve(resource, resolver, options) {
-  if (!resource) {
-    return null;
-  }
-  if (!isResource(resource)) {
-    throw new Error(`InvalidArgumentError: invalid resource \`${resource}\``);
-  }
-  const response = cloneDeep(await fetchResource(resource, options));
-  if (!response.config.validateStatus(response.status)) {
-    throw new Error(`RuntimeError: could not fetch resource \`${resource}\``);
-  }
-  const obj = response.data;
-  if (!resolver) {
-    return obj;
-  }
-  const resourcesObj = Object.keys(resolver).map(props => ({
-    [props]: objectGet(obj, props)
-  }));
-  const resourcesArr = Object.entries(resourcesObj.reduce((result, val) => ({
-    ...result,
-    ...val
-  }), {}));
-  const responses = await Promise.all(resourcesArr.map(async ([props, resources]) => {
-    const nextResolver = resolver[props];
-    const data = Array.isArray(resources) ? await Promise.all(resources.map(async nextResource => resolve(nextResource, nextResolver, options))) : await resolve(resources, nextResolver, options);
-    return [props, data];
-  }));
-  return responses.reduce((result, [props, data]) => merge(result, objectSet(data, props)), obj);
-}
-
-/**
- * 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 === 'object' && !Array.isArray(obj);
-}
-
-/**
- * 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;
-  }
-  const keys = Object.keys(resolver);
-  if (!keys.length) {
-    return false;
-  }
-  return keys.map(key => !key.startsWith(constants.PROP_DELIMITER) && !key.endsWith(constants.PROP_DELIMITER) && isResolver(resolver[key])).reduce((result, val) => result && val, true);
-}
-
-/**
- * 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.
- */
-async function restql(resource, resolver, options = {}) {
-  if (!isObject(resolver) || !isResolver(resolver)) {
-    throw new Error(`InvalidArgumentError: invalid resolver \`${JSON.stringify(resolver)}\``);
-  }
-  if (!isObject(options)) {
-    throw new Error(`InvalidArgumentError: invalid options \`${JSON.stringify(options)}\``);
-  }
-  return resolve(resource, resolver, options);
-}
-
-module.exports = restql;

package/dist/esm/index.js

@@ -1,189 +0,0 @@
-import cloneDeep from 'lodash/cloneDeep';
-import merge from 'lodash/merge';
-import axios from 'axios';
-import md5 from 'md5';
-import isURL from 'validator/lib/isURL';
-
-/**
- * @constant {Object} responses The responses to cache.
- */
-const 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.
- */
-async function fetchResource(resource, options) {
-  const key = md5(`${resource}-${JSON.stringify(options)}`);
-  if (!(key in responses)) {
-    responses[key] = axios(resource, options).then(response => {
-      responses[key] = response;
-      return response;
-    });
-  }
-  return responses[key];
-}
-
-/**
- * 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 isURL(resource);
-}
-
-/**
- * @constant {string} PROP_DELIMITER The delimiter of a property.
- */
-const PROP_DELIMITER = '.';
-
-/**
- * @constant {RegExp} REGEX_PROP_IS_ARR_IS_OPT Determines whether or not a property is an array and/or is optional.
- */
-const REGEX_PROP_IS_ARR_IS_OPT = /^([^[\]?]+)(\[])?(\?)?$/;
-
-/**
- * @constant {Object} constants The constants of the library.
- */
-const constants = Object.freeze({
-  PROP_DELIMITER,
-  REGEX_PROP_IS_ARR_IS_OPT
-});
-
-/**
- * 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) {
-  const nextPropsArr = props.split(constants.PROP_DELIMITER);
-  const [, prop, isArr, isOpt] = constants.REGEX_PROP_IS_ARR_IS_OPT.exec(nextPropsArr.shift()) || [];
-  const 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}\``);
-  }
-  const nextObjs = obj[prop];
-  return isArr ? nextObjs.map(nextObj => objectGet(nextObj, nextProps)) : objectGet(nextObjs, nextProps);
-}
-
-/**
- * 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) {
-  const nextPropsArr = props.split(constants.PROP_DELIMITER);
-  const [, prop, isArr] = constants.REGEX_PROP_IS_ARR_IS_OPT.exec(nextPropsArr.shift()) || [];
-  const nextProps = nextPropsArr.join(constants.PROP_DELIMITER);
-  if (!prop) {
-    return data;
-  }
-  return {
-    [prop]: isArr ? data.map(nextData => objectSet(nextData, nextProps)) : objectSet(data, nextProps)
-  };
-}
-
-/**
- * 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.
- */
-async function resolve(resource, resolver, options) {
-  if (!resource) {
-    return null;
-  }
-  if (!isResource(resource)) {
-    throw new Error(`InvalidArgumentError: invalid resource \`${resource}\``);
-  }
-  const response = cloneDeep(await fetchResource(resource, options));
-  if (!response.config.validateStatus(response.status)) {
-    throw new Error(`RuntimeError: could not fetch resource \`${resource}\``);
-  }
-  const obj = response.data;
-  if (!resolver) {
-    return obj;
-  }
-  const resourcesObj = Object.keys(resolver).map(props => ({
-    [props]: objectGet(obj, props)
-  }));
-  const resourcesArr = Object.entries(resourcesObj.reduce((result, val) => ({
-    ...result,
-    ...val
-  }), {}));
-  const responses = await Promise.all(resourcesArr.map(async ([props, resources]) => {
-    const nextResolver = resolver[props];
-    const data = Array.isArray(resources) ? await Promise.all(resources.map(async nextResource => resolve(nextResource, nextResolver, options))) : await resolve(resources, nextResolver, options);
-    return [props, data];
-  }));
-  return responses.reduce((result, [props, data]) => merge(result, objectSet(data, props)), obj);
-}
-
-/**
- * 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 === 'object' && !Array.isArray(obj);
-}
-
-/**
- * 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;
-  }
-  const keys = Object.keys(resolver);
-  if (!keys.length) {
-    return false;
-  }
-  return keys.map(key => !key.startsWith(constants.PROP_DELIMITER) && !key.endsWith(constants.PROP_DELIMITER) && isResolver(resolver[key])).reduce((result, val) => result && val, true);
-}
-
-/**
- * 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.
- */
-async function restql(resource, resolver, options = {}) {
-  if (!isObject(resolver) || !isResolver(resolver)) {
-    throw new Error(`InvalidArgumentError: invalid resolver \`${JSON.stringify(resolver)}\``);
-  }
-  if (!isObject(options)) {
-    throw new Error(`InvalidArgumentError: invalid options \`${JSON.stringify(options)}\``);
-  }
-  return resolve(resource, resolver, options);
-}
-
-export { restql as default };