@civet/core 1.3.0 → 1.4.0

package/lib/ConfigProvider.js

@@ -8,11 +8,11 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = require("react");
 var _DataProvider = require("./DataProvider");
 var _context = require("./context");
+var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 /**
  * Provides general configuration to its descendants using React's context API.
- */
-function ConfigProvider(_ref) {
+ */function ConfigProvider(_ref) {
   var dataProvider = _ref.dataProvider,
     children = _ref.children;
   var context = (0, _react.useMemo)(function () {
@@ -20,9 +20,10 @@ function ConfigProvider(_ref) {
       dataProvider: dataProvider
     };
   }, [dataProvider]);
-  return /*#__PURE__*/React.createElement(_context.ConfigContext.Provider, {
-    value: context
-  }, children);
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_context.ConfigContext.Provider, {
+    value: context,
+    children: children
+  });
 }
 ConfigProvider.propTypes = {
   dataProvider: _DataProvider.dataProviderPropType,

package/lib/DataProvider.js

@@ -76,7 +76,7 @@ var DataProvider = /*#__PURE__*/function () {
     }
   }, {
     key: "get",
-    value: function get(resource, query, options, meta) {
+    value: function get(resource, query, options, meta, abortSignal) {
       var _this = this;
       return new Promise(function (resolve, reject) {
         return _this.continuousGet(resource, query, options, meta, function (error, done, result) {
@@ -85,7 +85,7 @@ var DataProvider = /*#__PURE__*/function () {
             return;
           }
           if (done) resolve(result);
-        });
+        }, abortSignal);
       });
     }
   }, {

package/lib/Resource.js

@@ -9,9 +9,9 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _DataProvider = require("./DataProvider");
 var _context = require("./context");
 var _useResource = _interopRequireDefault(require("./useResource"));
+var _jsxRuntime = require("react/jsx-runtime");
 var _excluded = ["dataProvider", "name", "query", "empty", "options", "persistent", "children"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -20,25 +20,28 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 var propTypes = {
-  /** DataProvider to be used for requests */
+  /** DataProvider to be used for requests - must not be changed */
   dataProvider: _DataProvider.dataProviderPropType,
   /** Resource name */
   name: _propTypes["default"].string.isRequired,
-  /** Query */
+  /** Query instructions */
   query: _propTypes["default"].any,
-  /** Whether to prevent fetching data */
+  /** Disables fetching data, resulting in an empty data array */
   empty: _propTypes["default"].bool,
-  /** DataProvider options for requests */
+  /** Query options for requests */
   options: _propTypes["default"].object,
-  /** Whether stale data should be retained during the next request - this only applies if neither dataProvider nor name have changed, unless set to "very" */
+  /** Whether stale data should be retained during the next request - this only applies if name did not change, unless set to "very" */
   persistent: _propTypes["default"].oneOfType([_propTypes["default"].bool, _propTypes["default"].oneOf(['very'])]),
   children: _propTypes["default"].node
 };
 
 /**
- * Makes data from an DataProvider available to its descendants using React's context API.
- * If not explicitly specified, necessary configuration is taken from the nearest <ConfigProvider>.
- * The provided DataProvider must not be replaced.
+ * 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(_ref) {
   var dataProvider = _ref.dataProvider,
@@ -61,15 +64,17 @@ function Resource(_ref) {
     return (
       // eslint-disable-next-line react/display-name
       function (result) {
-        return /*#__PURE__*/React.createElement(Plugin, _extends({}, rest, {
-          context: result
-        }), next);
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)(Plugin, _objectSpread(_objectSpread({}, rest), {}, {
+          context: result,
+          children: next
+        }));
       }
     );
   }, function (result) {
-    return /*#__PURE__*/React.createElement(_context.ResourceContext.Provider, {
-      value: result
-    }, children);
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(_context.ResourceContext.Provider, {
+      value: result,
+      children: children
+    });
   })(context);
 }
 Resource.propTypes = propTypes;

package/lib/useResource.js

@@ -179,9 +179,11 @@ function fetchData(requestInstruction, instance, abortSignal, dispatch) {
 }
 
 /**
- * Makes data from a DataProvider available.
- * If not explicitly specified, necessary configuration is taken from the nearest <ConfigProvider>.
- * The provided DataProvider must not be replaced.
+ * Provides data based on the given request details and DataProvider.
+ *
+ * Necessary configuration that is not directly specified is taken from the ConfigContext.
+ *
+ * The provided DataProvider must not be changed.
  */
 function useResource(_ref) {
   var dataProviderProp = _ref.dataProvider,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@civet/core",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Civet",
   "main": "./lib/index.js",
   "exports": {

package/src/DataProvider.js

@@ -56,15 +56,22 @@ class DataProvider {
     this.notifier.trigger(resource);
   }
 
-  get(resource, query, options, meta) {
+  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);
-      }),
+      this.continuousGet(
+        resource,
+        query,
+        options,
+        meta,
+        (error, done, result) => {
+          if (error != null) {
+            reject(error);
+            return;
+          }
+          if (done) resolve(result);
+        },
+        abortSignal,
+      ),
     );
   }
 

package/src/Resource.jsx

@@ -4,25 +4,28 @@ import { ResourceContext } from './context';
 import useResource from './useResource';
 
 const propTypes = {
-  /** DataProvider to be used for requests */
+  /** DataProvider to be used for requests - must not be changed */
   dataProvider: dataProviderPropType,
   /** Resource name */
   name: PropTypes.string.isRequired,
-  /** Query */
+  /** Query instructions */
   query: PropTypes.any,
-  /** Whether to prevent fetching data */
+  /** Disables fetching data, resulting in an empty data array */
   empty: PropTypes.bool,
-  /** DataProvider options for requests */
+  /** Query options for requests */
   options: PropTypes.object,
-  /** Whether stale data should be retained during the next request - this only applies if neither dataProvider nor name have changed, unless set to "very" */
+  /** 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,
 };
 
 /**
- * Makes data from an DataProvider available to its descendants using React's context API.
- * If not explicitly specified, necessary configuration is taken from the nearest <ConfigProvider>.
- * The provided DataProvider must not be replaced.
+ * 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 });

package/src/useResource.js

@@ -160,16 +160,24 @@ function fetchData(requestInstruction, instance, abortSignal, dispatch) {
 }
 
 /**
- * Makes data from a DataProvider available.
- * If not explicitly specified, necessary configuration is taken from the nearest <ConfigProvider>.
- * The provided DataProvider must not be replaced.
+ * Provides data based on the given request details and DataProvider.
+ *
+ * Necessary configuration that is not directly specified is taken from the ConfigContext.
+ *
+ * The provided DataProvider must not be changed.
  */
 function useResource({
+  /** DataProvider to be used for requests - must not be changed */
   dataProvider: dataProviderProp,
+  /** Resource name */
   name: nextName,
+  /** Query instructions */
   query: nextQuery,
+  /** Disables fetching data, resulting in an empty data array */
   empty: nextEmpty,
+  /** Query options for requests */
   options: nextOptions,
+  /** Whether stale data should be retained during the next request - this only applies if name did not change, unless set to "very" */
   persistent: nextPersistent,
   ...rest
 }) {