restql 1.1.6 → 1.1.8

package/dist/esm/index.js

@@ -0,0 +1,185 @@
+import { merge } from 'es-toolkit';
+
+/**
+ * @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 = `${resource}-${JSON.stringify(options)}`;
+  if (!(key in responses)) {
+    responses[key] = fetch(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 Boolean(URL.parse(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 = (await fetchResource(resource, options)).clone();
+  if (!response.ok) {
+    throw new Error(`RuntimeError: could not fetch resource \`${resource}\``);
+  }
+  const obj = await response.json();
+  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 };