restql 1.1.7 → 1.1.8

package/README.md

@@ -25,33 +25,27 @@ npm install restql
 <script src="https://unpkg.com/restql/dist/umd/index.min.js"></script>
 ```
 
-## Parameters
-
-### `resource`
+## Usage
 
-`{string} The resource to fetch.`
+### `restql(resource, resolver[, options])`
 
-**Description**
+#### Parameters
 
-Self-explanatory.
+- `resource` (`string`): The resource to fetch.
+  - Self-explanatory.
 
-**e.g.:**
+##### Example
 
 ```js
 'https://pokeapi.co/api/v2/pokemon/1/'
 ```
 
-### `resolver`
-
-`{Object} The resolver to apply.`
-
-**Description**
+- `resolver` (`Object`): The resolver to apply.
+  - At every level, each property describes a path to the nested resources within the current one.
+  - RestQL resolves the sames and call the subsequent resolver against them.
+  - Until the base case (`null`) is reached; from which it returns back the merged responses.
 
-At each level, each property describes a path to the nested resources within the current one.  
-RestQL resolves the sames and call the subsequent resolver against them.  
-Until the base case (`null`) is reached; from which it returns back the merged responses.
-
-**Quantifiers**
+##### Quantifiers
 
 Following is a table of the quantifiers you can use:
 
@@ -60,7 +54,7 @@ Following is a table of the quantifiers you can use:
 | `[]`       | Collection of properties. |
 | `?`        | Optional property.        |
 
-**e.g.:**
+##### Example
 
 ```js
 {
@@ -77,66 +71,27 @@ Following is a table of the quantifiers you can use:
 }
 ```
 
-### `[options]`
-
-`{Object} The options to bypass.`
-
-**Description**
-
-[`Request Config`](https://github.com/axios/axios/tree/v1.13.6#request-config)
+- `[options]` (`Object`): The options to bypass.
+  - [See `RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit)
 
-**e.g.:**
+##### Example
 
 ```js
-{
-  // ...
-}
+{ ... }
 ```
 
-## Usage
+#### Returns
 
-```js
-import restql from 'restql'
+(`Promise<Object>`): A promise which resolves into an object.
 
-/**
- * @constant {string} resource The resource to fetch.
- */
-const resource = 'https://pokeapi.co/api/v2/pokemon/1/'
+## Try It
 
-/**
- * @constant {Object} resolver The resolver to apply.
- */
-const resolver = {
-  'abilities[]?.ability.url': {
-    'generation.url': {
-      'main_region.url': null,
-    },
-  },
-  'stats[].stat.url?': {
-    'affecting_natures.increase[].url': null,
-    'affecting_natures.decrease[].url': null,
-  },
-  'moves[].move?.url': null,
-}
-
-/**
- * @constant {Object} options The options to bypass.
- */
-const options = {
-  // ...
-}
-
-;(async () => {
-  try {
-    const data = await restql(resource, resolver, options)
-
-    console.log(data)
-  } catch (error) {
-    console.error(error.message)
-  }
-})()
+```sh
+npm run playground
 ```
 
+[See Playground](https://github.com/relztic/restql/blob/main/playground/index.js)
+
 ## Roadmap
 
 - ~~Support for authentication~~
@@ -145,4 +100,4 @@ const options = {
 - ~~Ability to cache responses~~
 - Support for recursive resolvers
 
-Take 🎂, Folks! 🌮 🐴 💨
+> Take 🎂, Folks! 🌮 🐴 💨

package/dist/cjs/index.js

@@ -1,10 +1,6 @@
 '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');
+var esToolkit = require('es-toolkit');
 
 /**
  * @constant {Object} responses The responses to cache.
@@ -19,9 +15,9 @@ const responses = {};
  * @returns {Promise<Object>} A promise which resolves into an object.
  */
 async function fetchResource(resource, options) {
-  const key = md5(`${resource}-${JSON.stringify(options)}`);
+  const key = `${resource}-${JSON.stringify(options)}`;
   if (!(key in responses)) {
-    responses[key] = axios(resource, options).then(response => {
+    responses[key] = fetch(resource, options).then(response => {
       responses[key] = response;
       return response;
     });
@@ -36,7 +32,7 @@ async function fetchResource(resource, options) {
  * @returns {boolean} Whether or not a resource is valid.
  */
 function isResource(resource) {
-  return isURL(resource);
+  return Boolean(URL.parse(resource));
 }
 
 /**
@@ -118,11 +114,11 @@ async function resolve(resource, resolver, options) {
   if (!isResource(resource)) {
     throw new Error(`InvalidArgumentError: invalid resource \`${resource}\``);
   }
-  const response = cloneDeep(await fetchResource(resource, options));
-  if (!response.config.validateStatus(response.status)) {
+  const response = (await fetchResource(resource, options)).clone();
+  if (!response.ok) {
     throw new Error(`RuntimeError: could not fetch resource \`${resource}\``);
   }
-  const obj = response.data;
+  const obj = await response.json();
   if (!resolver) {
     return obj;
   }
@@ -138,7 +134,7 @@ async function resolve(resource, resolver, options) {
     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);
+  return responses.reduce((result, [props, data]) => esToolkit.merge(result, objectSet(data, props)), obj);
 }
 
 /**

package/dist/esm/index.js

@@ -1,8 +1,4 @@
-import cloneDeep from 'lodash/cloneDeep';
-import merge from 'lodash/merge';
-import axios from 'axios';
-import md5 from 'md5';
-import isURL from 'validator/lib/isURL';
+import { merge } from 'es-toolkit';
 
 /**
  * @constant {Object} responses The responses to cache.
@@ -17,9 +13,9 @@ const responses = {};
  * @returns {Promise<Object>} A promise which resolves into an object.
  */
 async function fetchResource(resource, options) {
-  const key = md5(`${resource}-${JSON.stringify(options)}`);
+  const key = `${resource}-${JSON.stringify(options)}`;
   if (!(key in responses)) {
-    responses[key] = axios(resource, options).then(response => {
+    responses[key] = fetch(resource, options).then(response => {
       responses[key] = response;
       return response;
     });
@@ -34,7 +30,7 @@ async function fetchResource(resource, options) {
  * @returns {boolean} Whether or not a resource is valid.
  */
 function isResource(resource) {
-  return isURL(resource);
+  return Boolean(URL.parse(resource));
 }
 
 /**
@@ -116,11 +112,11 @@ async function resolve(resource, resolver, options) {
   if (!isResource(resource)) {
     throw new Error(`InvalidArgumentError: invalid resource \`${resource}\``);
   }
-  const response = cloneDeep(await fetchResource(resource, options));
-  if (!response.config.validateStatus(response.status)) {
+  const response = (await fetchResource(resource, options)).clone();
+  if (!response.ok) {
     throw new Error(`RuntimeError: could not fetch resource \`${resource}\``);
   }
-  const obj = response.data;
+  const obj = await response.json();
   if (!resolver) {
     return obj;
   }