@civet/core 1.0.0-rc1 → 1.0.0-rc2

package/lib/ConfigProvider.js

@@ -19,14 +19,14 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * Provides general configuration to its descendants using React's context API.
  */
 function ConfigProvider(_ref) {
-  var provider = _ref.provider,
+  var dataProvider = _ref.dataProvider,
       children = _ref.children;
 
   var context = _react["default"].useMemo(function () {
     return {
-      provider: provider
+      dataProvider: dataProvider
     };
-  }, [provider]);
+  }, [dataProvider]);
 
   return /*#__PURE__*/_react["default"].createElement(_context.ConfigContext.Provider, {
     value: context
@@ -34,7 +34,7 @@ function ConfigProvider(_ref) {
 }
 
 ConfigProvider.propTypes = {
-  provider: _DataProvider.dataProviderPropType,
+  dataProvider: _DataProvider.dataProviderPropType,
   children: _propTypes["default"].node
 };
 var _default = ConfigProvider;

package/lib/DataProvider.js

@@ -234,8 +234,8 @@ var DataProvider = /*#__PURE__*/function () {
   return DataProvider;
 }();
 
-var isDataProvider = function isDataProvider(provider) {
-  return provider instanceof DataProvider;
+var isDataProvider = function isDataProvider(dataProvider) {
+  return dataProvider instanceof DataProvider;
 };
 
 exports.isDataProvider = isDataProvider;

package/lib/Resource.js

@@ -62,10 +62,10 @@ Resource.propTypes = {
   /**
    * DataProvider to be used for requests
    */
-  provider: _DataProvider.dataProviderPropType.isRequired,
+  dataProvider: _DataProvider.dataProviderPropType.isRequired,
 
   /**
-   * Whether stale data should be retained during the next request - this only applies if neither provider nor name have changed, unless set to "very"
+   * Whether stale data should be retained during the next request - this only applies if neither dataProvider nor name have changed, unless set to "very"
    */
   persistent: _propTypes["default"].oneOfType([_propTypes["default"].bool, _propTypes["default"].oneOf(['very'])]),
   children: _propTypes["default"].node

package/lib/createPlugin.js

@@ -29,14 +29,14 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 
 function createPlugin(plugin) {
   if (typeof plugin !== 'function') throw new Error('No valid plugin definition specified');
-  return function (providerClass) {
-    if (!Object.prototype.isPrototypeOf.call(_DataProvider["default"], providerClass)) {
+  return function (dataProviderClass) {
+    if (!Object.prototype.isPrototypeOf.call(_DataProvider["default"], dataProviderClass)) {
       // eslint-disable-next-line no-console
       console.error('A plugin should be given a derivative of the DataProvider class as its first parameter');
     }
 
-    var result = plugin( /*#__PURE__*/function (_providerClass) {
-      _inherits(_class, _providerClass);
+    var result = plugin( /*#__PURE__*/function (_dataProviderClass) {
+      _inherits(_class, _dataProviderClass);
 
       var _super = _createSuper(_class);
 
@@ -47,7 +47,7 @@ function createPlugin(plugin) {
       }
 
       return _class;
-    }(providerClass));
+    }(dataProviderClass));
 
     if (result == null) {
       throw new Error('A plugin is expected to return a derivative of the DataProvider class but returned nothing');

package/lib/useResource.js

@@ -15,7 +15,7 @@ var _Meta = _interopRequireDefault(require("./Meta"));
 
 var _uniqueIdentifier = _interopRequireDefault(require("./uniqueIdentifier"));
 
-var _excluded = ["name", "query", "empty", "options", "provider", "persistent"],
+var _excluded = ["name", "query", "empty", "options", "dataProvider", "persistent"],
     _excluded2 = ["data"];
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -56,23 +56,23 @@ function useResource(props) {
       query = props.query,
       empty = props.empty,
       options = props.options,
-      providerProp = props.provider,
+      dataProviderProp = props.dataProvider,
       persistent = props.persistent,
       rest = _objectWithoutProperties(props, _excluded);
 
   var configContext = (0, _context2.useConfigContext)();
-  var currentProvider = providerProp || configContext.provider;
+  var currentDataProvider = dataProviderProp || configContext.dataProvider;
 
-  var provider = _react["default"].useMemo(function () {
-    return currentProvider;
+  var dataProvider = _react["default"].useMemo(function () {
+    return currentDataProvider;
   }, []);
 
-  if (provider == null) {
-    throw new Error('Unmet requirement: The DataProvider for the useResource hook is missing - Check your ConfigContext and the provider property');
+  if (dataProvider == null) {
+    throw new Error('Unmet requirement: The DataProvider for the useResource hook is missing - Check your ConfigContext provider and the dataProvider property');
   }
 
-  if (provider !== currentProvider) {
-    throw new Error('Constant violation: The DataProvider provided to the useResource hook must not be replaced - Check your ConfigContext and the provider property');
+  if (dataProvider !== currentDataProvider) {
+    throw new Error('Constant violation: The DataProvider provided to the useResource hook must not be replaced - Check your ConfigContext provider and the dataProvider property');
   }
 
   var comparator = {
@@ -117,7 +117,7 @@ function useResource(props) {
       value = state.value,
       prevPersistent = state.persistent;
 
-  if (prevComparator !== comparator && !provider.compareRequests(prevComparator, comparator)) {
+  if (prevComparator !== comparator && !dataProvider.compareRequests(prevComparator, comparator)) {
     setState(function (prevState) {
       var nextRequest = (0, _uniqueIdentifier["default"])(prevState.request);
       var nextRevision = (0, _uniqueIdentifier["default"])(prevState.revision);
@@ -190,9 +190,9 @@ function useResource(props) {
 
   _react["default"].useEffect(function () {
     if (empty) return undefined;
-    var unsubscribe = provider.subscribe(name, notify);
+    var unsubscribe = dataProvider.subscribe(name, notify);
     return unsubscribe;
-  }, [!empty, provider, name, notify]);
+  }, [!empty, dataProvider, name, notify]);
 
   _react["default"].useEffect(function () {
     if (empty) return undefined;
@@ -232,13 +232,13 @@ function useResource(props) {
         return {
           isLoading: !done,
           value: _objectSpread(_objectSpread({}, context), {}, {
-            data: provider.recycleItems(provider.transition(data, prevData, context, prevContext), prevData, context, prevContext)
+            data: dataProvider.recycleItems(dataProvider.transition(data, prevData, context, prevContext), prevData, context, prevContext)
           })
         };
       });
     };
 
-    provider.continuousGet(name, query, options, meta, callback, abortSignal);
+    dataProvider.continuousGet(name, query, options, meta, callback, abortSignal);
     return function () {
       abortSignal.abort();
     };
@@ -248,14 +248,14 @@ function useResource(props) {
 
   var context = _react["default"].useMemo(function () {
     return _objectSpread(_objectSpread({}, value), {}, {
-      provider: provider,
+      dataProvider: dataProvider,
       isLoading: isLoading,
       isStale: isStale,
       notify: notify
     });
-  }, [value, provider, isLoading, isStale, notify]);
+  }, [value, dataProvider, isLoading, isStale, notify]);
 
-  var contextPlugins = Array.isArray(provider.contextPlugins) ? provider.contextPlugins : [];
+  var contextPlugins = Array.isArray(dataProvider.contextPlugins) ? dataProvider.contextPlugins : [];
   return contextPlugins.reduce(function (result, fn) {
     return fn(result, rest);
   }, context);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civet/core",
-  "version": "1.0.0-rc1",
+  "version": "1.0.0-rc2",
   "description": "Civet",
   "main": "./lib/index.js",
   "scripts": {

package/src/ConfigProvider.js

@@ -7,14 +7,14 @@ import { dataProviderPropType } from './DataProvider';
 /**
  * Provides general configuration to its descendants using React's context API.
  */
-function ConfigProvider({ provider, children }) {
-  const context = React.useMemo(() => ({ provider }), [provider]);
+function ConfigProvider({ dataProvider, children }) {
+  const context = React.useMemo(() => ({ dataProvider }), [dataProvider]);
 
   return <ConfigContext.Provider value={context}>{children}</ConfigContext.Provider>;
 }
 
 ConfigProvider.propTypes = {
-  provider: dataProviderPropType,
+  dataProvider: dataProviderPropType,
   children: PropTypes.node,
 };
 

package/src/DataProvider.js

@@ -174,7 +174,7 @@ class DataProvider {
   }
 }
 
-const isDataProvider = (provider) => provider instanceof DataProvider;
+const isDataProvider = (dataProvider) => dataProvider instanceof DataProvider;
 
 const dataProviderPropType = PropTypes.instanceOf(DataProvider);
 

package/src/Resource.js

@@ -36,9 +36,9 @@ Resource.propTypes = {
   /**
    * DataProvider to be used for requests
    */
-  provider: dataProviderPropType.isRequired,
+  dataProvider: dataProviderPropType.isRequired,
   /**
-   * Whether stale data should be retained during the next request - this only applies if neither provider nor name have changed, unless set to "very"
+   * Whether stale data should be retained during the next request - this only applies if neither dataProvider nor name have changed, unless set to "very"
    */
   persistent: PropTypes.oneOfType([PropTypes.bool, PropTypes.oneOf(['very'])]),
   children: PropTypes.node,

package/src/createPlugin.js

@@ -2,14 +2,14 @@ import DataProvider from './DataProvider';
 
 function createPlugin(plugin) {
   if (typeof plugin !== 'function') throw new Error('No valid plugin definition specified');
-  return (providerClass) => {
-    if (!Object.prototype.isPrototypeOf.call(DataProvider, providerClass)) {
+  return (dataProviderClass) => {
+    if (!Object.prototype.isPrototypeOf.call(DataProvider, dataProviderClass)) {
       // eslint-disable-next-line no-console
       console.error(
         'A plugin should be given a derivative of the DataProvider class as its first parameter',
       );
     }
-    const result = plugin(class extends providerClass {});
+    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',

package/src/useResource.js

@@ -11,19 +11,27 @@ import uniqueIdentifier from './uniqueIdentifier';
  * The provided DataProvider must not be replaced.
  */
 function useResource(props) {
-  const { name, query, empty, options, provider: providerProp, persistent, ...rest } = props;
+  const {
+    name,
+    query,
+    empty,
+    options,
+    dataProvider: dataProviderProp,
+    persistent,
+    ...rest
+  } = props;
 
   const configContext = useConfigContext();
-  const currentProvider = providerProp || configContext.provider;
-  const provider = React.useMemo(() => currentProvider, []);
-  if (provider == null) {
+  const currentDataProvider = dataProviderProp || configContext.dataProvider;
+  const dataProvider = React.useMemo(() => currentDataProvider, []);
+  if (dataProvider == null) {
     throw new Error(
-      'Unmet requirement: The DataProvider for the useResource hook is missing - Check your ConfigContext and the provider property',
+      'Unmet requirement: The DataProvider for the useResource hook is missing - Check your ConfigContext provider and the dataProvider property',
     );
   }
-  if (provider !== currentProvider) {
+  if (dataProvider !== currentDataProvider) {
     throw new Error(
-      'Constant violation: The DataProvider provided to the useResource hook must not be replaced - Check your ConfigContext and the provider property',
+      'Constant violation: The DataProvider provided to the useResource hook must not be replaced - Check your ConfigContext provider and the dataProvider property',
     );
   }
 
@@ -61,7 +69,7 @@ function useResource(props) {
     persistent: prevPersistent,
   } = state;
 
-  if (prevComparator !== comparator && !provider.compareRequests(prevComparator, comparator)) {
+  if (prevComparator !== comparator && !dataProvider.compareRequests(prevComparator, comparator)) {
     setState((prevState) => {
       const nextRequest = uniqueIdentifier(prevState.request);
       const nextRevision = uniqueIdentifier(prevState.revision);
@@ -122,9 +130,9 @@ function useResource(props) {
   React.useEffect(() => {
     if (empty) return undefined;
 
-    const unsubscribe = provider.subscribe(name, notify);
+    const unsubscribe = dataProvider.subscribe(name, notify);
     return unsubscribe;
-  }, [!empty, provider, name, notify]);
+  }, [!empty, dataProvider, name, notify]);
 
   React.useEffect(() => {
     if (empty) return undefined;
@@ -167,8 +175,8 @@ function useResource(props) {
           isLoading: !done,
           value: {
             ...context,
-            data: provider.recycleItems(
-              provider.transition(data, prevData, context, prevContext),
+            data: dataProvider.recycleItems(
+              dataProvider.transition(data, prevData, context, prevContext),
               prevData,
               context,
               prevContext,
@@ -178,7 +186,7 @@ function useResource(props) {
       });
     };
 
-    provider.continuousGet(name, query, options, meta, callback, abortSignal);
+    dataProvider.continuousGet(name, query, options, meta, callback, abortSignal);
 
     return () => {
       abortSignal.abort();
@@ -187,11 +195,13 @@ function useResource(props) {
 
   const isStale = request !== value.request;
   const context = React.useMemo(
-    () => ({ ...value, provider, isLoading, isStale, notify }),
-    [value, provider, isLoading, isStale, notify],
+    () => ({ ...value, dataProvider, isLoading, isStale, notify }),
+    [value, dataProvider, isLoading, isStale, notify],
   );
 
-  const contextPlugins = Array.isArray(provider.contextPlugins) ? provider.contextPlugins : [];
+  const contextPlugins = Array.isArray(dataProvider.contextPlugins)
+    ? dataProvider.contextPlugins
+    : [];
   return contextPlugins.reduce((result, fn) => fn(result, rest), context);
 }