@civet/core 1.4.2 → 2.0.0

package/src/DataProvider.js

@@ -1,228 +0,0 @@
-import deepEquals from 'fast-deep-equal';
-import objectHash from 'object-hash';
-import PropTypes from 'prop-types';
-import AbortSignal from './AbortSignal';
-import ChannelNotifier from './ChannelNotifier';
-import Meta from './Meta';
-
-const getMeta = (meta) => (meta instanceof Meta ? meta : new Meta(meta));
-
-class DataProvider {
-  notifier = new ChannelNotifier();
-
-  constructor() {
-    const contextPlugins = [];
-    const uiPlugins = [];
-    this.extend({
-      context: (plugin) => {
-        const plugins = contextPlugins;
-        if (plugin != null && !plugins.includes(plugin)) plugins.push(plugin);
-      },
-      ui: (plugin) => {
-        const plugins = uiPlugins;
-        if (plugin != null && !plugins.includes(plugin)) plugins.push(plugin);
-      },
-    });
-    Object.defineProperties(this, {
-      contextPlugins: {
-        value: Object.freeze(contextPlugins.slice()),
-        enumerable: true,
-        writable: false,
-        configurable: false,
-      },
-      uiPlugins: {
-        value: Object.freeze(uiPlugins.slice()),
-        enumerable: true,
-        writable: false,
-        configurable: false,
-      },
-    });
-  }
-
-  extend() {}
-
-  createInstance() {
-    return null;
-  }
-
-  releaseInstance() {}
-
-  subscribe(resource, handler) {
-    if (resource == null) throw new Error('No resource name specified');
-    return this.notifier.subscribe(resource, handler);
-  }
-
-  notify(resource) {
-    this.notifier.trigger(resource);
-  }
-
-  get(resource, query, options, meta, abortSignal) {
-    return new Promise((resolve, reject) =>
-      this.continuousGet(
-        resource,
-        query,
-        options,
-        meta,
-        (error, done, result) => {
-          if (error != null) {
-            reject(error);
-            return;
-          }
-          if (done) resolve(result);
-        },
-        abortSignal,
-      ),
-    );
-  }
-
-  continuousGet(resource, query, options, meta, callback, abortSignal) {
-    const signal = abortSignal == null ? new AbortSignal() : abortSignal;
-
-    new Promise((resolve) => {
-      if (resource == null) throw new Error('No resource name specified');
-
-      // result transformation
-      const cb = (error, done, result) => {
-        // prevent updates after completion
-        if (signal.locked) return;
-        if (error != null || done) {
-          signal.lock();
-        }
-        if (error != null) callback(error, true, []);
-        else if (result == null) callback(undefined, done, []);
-        else if (Array.isArray(result)) callback(undefined, done, result);
-        else callback(undefined, done, [result]);
-      };
-
-      const proxy = signal.proxy();
-
-      resolve(
-        Promise.resolve(
-          this.handleGet(resource, query, options, getMeta(meta), proxy),
-        ).then((result) => {
-          if (typeof result === 'function') {
-            // `proxy` is being passed down here for backwards compatibility
-            result(cb, proxy);
-          } else {
-            cb(undefined, true, result);
-          }
-        }),
-      );
-    }).catch((e) => {
-      if (!signal.locked) callback(e, true, []);
-    });
-  }
-
-  create(resource, data, options, meta) {
-    return new Promise((resolve) => {
-      if (resource == null) throw new Error('No resource name specified');
-      if (data == null) throw new Error('No data specified');
-      resolve(
-        Promise.resolve(
-          this.handleCreate(resource, data, options, getMeta(meta)),
-        ),
-      );
-    });
-  }
-
-  update(resource, query, data, options, meta) {
-    return new Promise((resolve) => {
-      if (resource == null) throw new Error('No resource name specified');
-      if (data == null) throw new Error('No data specified');
-      resolve(
-        Promise.resolve(
-          this.handleUpdate(resource, query, data, options, getMeta(meta)),
-        ),
-      );
-    });
-  }
-
-  patch(resource, query, data, options, meta) {
-    return new Promise((resolve) => {
-      if (resource == null) throw new Error('No resource name specified');
-      if (data == null) throw new Error('No data specified');
-      resolve(
-        Promise.resolve(
-          this.handlePatch(resource, query, data, options, getMeta(meta)),
-        ),
-      );
-    });
-  }
-
-  remove(resource, query, options, meta) {
-    return new Promise((resolve) => {
-      if (resource == null) throw new Error('No resource name specified');
-      resolve(
-        Promise.resolve(
-          this.handleRemove(resource, query, options, getMeta(meta)),
-        ),
-      );
-    });
-  }
-
-  compareRequests(nextRequestDetails, prevRequestDetails) {
-    return deepEquals(nextRequestDetails, prevRequestDetails);
-  }
-
-  shouldPersist(nextRequestDetails, prevRequestDetails, persistent) {
-    return (
-      persistent === 'very' ||
-      (persistent && prevRequestDetails.name === nextRequestDetails.name)
-    );
-  }
-
-  compareItemVersions() {
-    return true;
-  }
-
-  getItemIdentifier(item) {
-    return objectHash(item);
-  }
-
-  transition(nextContext) {
-    return nextContext.data;
-  }
-
-  recycleItems(nextContext, prevContext) {
-    const prevMapping = {};
-    if (nextContext.data.length > 0) {
-      prevContext.data.forEach((item) => {
-        const id = this.getItemIdentifier(item);
-        if (id != null) prevMapping[id] = item;
-      });
-    }
-    let result;
-    if (prevContext.data.length > 0) {
-      result = nextContext.data.map((nextItem) => {
-        const id = this.getItemIdentifier(nextItem);
-        if (
-          id != null &&
-          Object.prototype.hasOwnProperty.call(prevMapping, id)
-        ) {
-          const prevItem = prevMapping[id];
-          if (this.compareItemVersions(nextItem, prevItem)) return prevItem;
-        }
-        return nextItem;
-      });
-    } else {
-      result = nextContext.data;
-    }
-    if (
-      prevContext.data.length === result.length &&
-      result.reduce(
-        (sum, item, i) => sum && Object.is(prevContext.data[i], item),
-        true,
-      )
-    ) {
-      return prevContext.data;
-    }
-    return result;
-  }
-}
-
-const isDataProvider = (dataProvider) => dataProvider instanceof DataProvider;
-
-const dataProviderPropType = PropTypes.instanceOf(DataProvider);
-
-export default DataProvider;
-export { dataProviderPropType, isDataProvider };

package/src/Meta.js

@@ -1,50 +0,0 @@
-class Meta {
-  constructor(base, instance) {
-    this.data = base == null ? {} : base;
-    this.instance = instance;
-  }
-
-  clear = () => {
-    Object.keys(this.data).forEach((key) => {
-      delete this.data[key];
-    });
-  };
-
-  delete = (key) => {
-    const value = this.data[key];
-    delete this.data[key];
-    return value;
-  };
-
-  entries = () => Object.entries(this.data);
-
-  get = (key) => this.data[key];
-
-  has = (key) => Object.prototype.hasOwnProperty.call(this.data, key);
-
-  keys = () => Object.keys(this.data);
-
-  set = (key, value) => {
-    this.data[key] = value;
-  };
-
-  values = () => Object.values(this.data);
-
-  commit = (prev, ignore) => {
-    const next = { ...this.data };
-    (ignore || []).forEach((item) => {
-      delete next[item];
-    });
-    const keys = Object.keys(next);
-    if (
-      prev != null &&
-      Object.keys(prev).length === keys.length &&
-      keys.reduce((sum, key) => sum && Object.is(next[key], prev[key]), true)
-    ) {
-      return prev;
-    }
-    return next;
-  };
-}
-
-export default Meta;

package/src/Notifier.js

@@ -1,21 +0,0 @@
-class Notifier {
-  listeners = new Set();
-
-  subscribe = (handler) => {
-    if (typeof handler !== 'function') {
-      throw new Error('Handler must be a function');
-    }
-    this.listeners.add(handler);
-    return () => {
-      this.listeners.delete(handler);
-    };
-  };
-
-  isSubscribed = (handler) => this.listeners.has(handler);
-
-  trigger = (...args) => {
-    this.listeners.forEach((handler) => handler(...args));
-  };
-}
-
-export default Notifier;

package/src/Resource.jsx

@@ -1,68 +0,0 @@
-import PropTypes from 'prop-types';
-import { dataProviderPropType } from './DataProvider';
-import { ResourceContext } from './context';
-import useResource from './useResource';
-
-const propTypes = {
-  /** DataProvider to be used for requests - must not be changed */
-  dataProvider: dataProviderPropType,
-  /** Resource name */
-  name: PropTypes.string.isRequired,
-  /** Query instructions */
-  query: PropTypes.any,
-  /** Disables fetching data, resulting in an empty data array */
-  empty: PropTypes.bool,
-  /** Query options for requests */
-  options: PropTypes.object,
-  /** Whether stale data should be retained during the next request - this only applies if name did not change, unless set to "very" */
-  persistent: PropTypes.oneOfType([PropTypes.bool, PropTypes.oneOf(['very'])]),
-  children: PropTypes.node,
-};
-
-/**
- * Provides data based on the given request details and DataProvider.
- * Context provider for the ResourceContext.
- *
- * Necessary configuration that is not directly specified is taken from the ConfigContext.
- *
- * The provided DataProvider must not be changed.
- */
-function Resource({
-  dataProvider,
-  name,
-  query,
-  empty,
-  options,
-  persistent,
-  children,
-  ...rest
-}) {
-  const context = useResource({
-    dataProvider,
-    name,
-    query,
-    empty,
-    options,
-    persistent,
-    ...rest,
-  });
-
-  return context.dataProvider.uiPlugins.reduceRight(
-    (next, Plugin) =>
-      // eslint-disable-next-line react/display-name
-      (result) => (
-        <Plugin {...rest} context={result}>
-          {next}
-        </Plugin>
-      ),
-    (result) => (
-      <ResourceContext.Provider value={result}>
-        {children}
-      </ResourceContext.Provider>
-    ),
-  )(context);
-}
-
-Resource.propTypes = propTypes;
-
-export default Resource;

package/src/compose.js

@@ -1,9 +0,0 @@
-function compose(...fn) {
-  if (fn.length === 0) return (arg) => arg;
-
-  if (fn.length === 1) return fn[0];
-
-  return fn.reduce((a, b) => (arg) => a(b(arg)));
-}
-
-export default compose;

package/src/context.js

@@ -1,11 +0,0 @@
-import { createContext, useContext } from 'react';
-
-const noop = () => {};
-
-export const ConfigContext = createContext({});
-ConfigContext.displayName = 'ConfigContext';
-export const useConfigContext = () => useContext(ConfigContext);
-
-export const ResourceContext = createContext({ data: [], notify: noop });
-ResourceContext.displayName = 'ResourceContext';
-export const useResourceContext = () => useContext(ResourceContext);

package/src/createPlugin.js

@@ -1,23 +0,0 @@
-import DataProvider from './DataProvider';
-
-function createPlugin(plugin) {
-  if (typeof plugin !== 'function') {
-    throw new Error('No valid plugin definition specified');
-  }
-  return (dataProviderClass) => {
-    if (!Object.prototype.isPrototypeOf.call(DataProvider, dataProviderClass)) {
-      console.error(
-        'A plugin should be given a derivative of the DataProvider class as its first parameter',
-      );
-    }
-    const result = plugin(class extends dataProviderClass {});
-    if (result == null) {
-      throw new Error(
-        'A plugin is expected to return a derivative of the DataProvider class but returned nothing',
-      );
-    }
-    return result;
-  };
-}
-
-export default createPlugin;

package/src/index.js

@@ -1,25 +0,0 @@
-import {
-  ConfigContext,
-  ResourceContext,
-  useConfigContext,
-  useResourceContext,
-} from './context';
-
-export const { Consumer: ConfigConsumer } = ConfigContext;
-export const { Provider: ResourceProvider, Consumer: ResourceConsumer } =
-  ResourceContext;
-export { default as AbortSignal } from './AbortSignal';
-export { default as ChannelNotifier } from './ChannelNotifier';
-export { default as ConfigProvider } from './ConfigProvider';
-export {
-  default as DataProvider,
-  dataProviderPropType,
-  isDataProvider,
-} from './DataProvider';
-export { default as Meta } from './Meta';
-export { default as Notifier } from './Notifier';
-export { default as Resource } from './Resource';
-export { default as compose } from './compose';
-export { default as createPlugin } from './createPlugin';
-export { default as useResource } from './useResource';
-export { useConfigContext, useResourceContext };

package/src/uniqueIdentifier.js

@@ -1,27 +0,0 @@
-import { v1 as uuid } from 'uuid';
-
-/**
- * Returns incrementing unique string identifiers.
- * Uniqueness is guaranteed for <Number.MAX_SAFE_INTEGER> iterations.
- * The values can be compared alphanumerically, as long as they do not exceed the previously specified number of iterations.
- *
- * @param {string?} previous Previous identifier
- */
-function uniqueIdentifier(previous) {
-  let prefix;
-  let value;
-  let scope;
-  if (typeof previous !== 'string') {
-    prefix = '~';
-    value = 0;
-    scope = uuid();
-  } else {
-    let prevValue;
-    [prefix, prevValue, scope] = previous.split('$');
-    value = ((parseInt(prevValue, 36) || 0) + 1) % Number.MAX_SAFE_INTEGER;
-    if (value === 0) prefix += '~';
-  }
-  return `${prefix}$${value.toString(36).padStart(11, '0')}$${scope}`;
-}
-
-export default uniqueIdentifier;