@k-int/stripes-kint-components 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.5.0 Released 9th December 2021
+ * useKiwtFieldArray hook
+
 ## 1.4.0 Released 26th Nov 2021
  * useHelperApp now exposes an `isOpen` function to check if current helper is open or not.
  * useQIndex hook exposed to allow setting and parsing of qindex from url. QIndex now used in useKiwtSASQuery.

package/es/index.js

@@ -111,6 +111,12 @@ Object.defineProperty(exports, "useHelperApp", {
     return _hooks.useHelperApp;
   }
 });
+Object.defineProperty(exports, "useKiwtFieldArray", {
+  enumerable: true,
+  get: function get() {
+    return _hooks.useKiwtFieldArray;
+  }
+});
 Object.defineProperty(exports, "useKiwtSASQuery", {
   enumerable: true,
   get: function get() {

package/es/lib/hooks/index.js

@@ -15,6 +15,12 @@ Object.defineProperty(exports, "useHelperApp", {
     return _useHelperApp["default"];
   }
 });
+Object.defineProperty(exports, "useKiwtFieldArray", {
+  enumerable: true,
+  get: function get() {
+    return _useKiwtFieldArray["default"];
+  }
+});
 Object.defineProperty(exports, "useKiwtSASQuery", {
   enumerable: true,
   get: function get() {
@@ -68,4 +74,6 @@ var _useLocalStorageState = _interopRequireDefault(require("./useLocalStorageSta
 
 var _useQIndex = _interopRequireDefault(require("./useQIndex"));
 
+var _useKiwtFieldArray = _interopRequireDefault(require("./useKiwtFieldArray"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }

package/es/lib/hooks/useKiwtFieldArray.js

@@ -0,0 +1,109 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _react = require("react");
+
+var _reactFinalFormArrays = require("react-final-form-arrays");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+var useKiwtFieldArray = function useKiwtFieldArray(name) {
+  var submitWholeDeletedObject = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+
+  var _useFieldArray = (0, _reactFinalFormArrays.useFieldArray)(name),
+      fields = _useFieldArray.fields;
+
+  var _fields$value = fields.value,
+      values = _fields$value === void 0 ? [] : _fields$value;
+
+  var _useState = (0, _react.useState)(0),
+      _useState2 = _slicedToArray(_useState, 2),
+      endOfList = _useState2[0],
+      setEndOfList = _useState2[1];
+
+  (0, _react.useEffect)(function () {
+    var i = values.filter(function (line) {
+      return !line._delete;
+    });
+    setEndOfList(i.length);
+  }, [values]);
+
+  var onAddField = function onAddField() {
+    var field = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {
+      _delete: false
+    };
+    fields.insert(endOfList, field);
+  };
+
+  var onMarkForDeletion = function onMarkForDeletion(field) {
+    if (field && field.id) {
+      if (submitWholeDeletedObject) {
+        fields.push(_objectSpread(_objectSpread({}, field), {}, {
+          _delete: true
+        }));
+      } else {
+        fields.push({
+          id: field.id,
+          _delete: true
+        });
+      }
+    }
+  };
+
+  var onDeleteField = function onDeleteField(index, field) {
+    fields.remove(index);
+    onMarkForDeletion(field);
+  };
+
+  var onPrependField = function onPrependField() {
+    var field = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {
+      _delete: false
+    };
+    fields.unshift(field);
+  };
+
+  var onReplaceField = function onReplaceField(index, field) {
+    if (fields.update) {
+      // react-final-form-arrays
+      fields.update(index, field);
+    }
+  };
+
+  var onUpdateField = function onUpdateField(index, field) {
+    fields.update(index, _objectSpread(_objectSpread({}, fields.value[index]), field));
+  };
+
+  var items = values.slice(0, endOfList);
+  return {
+    items: items,
+    onAddField: onAddField,
+    onDeleteField: onDeleteField,
+    onMarkForDeletion: onMarkForDeletion,
+    onPrependField: onPrependField,
+    onReplaceField: onReplaceField,
+    onUpdateField: onUpdateField
+  };
+};
+
+var _default = useKiwtFieldArray;
+exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-int/stripes-kint-components",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Stripes Component library for K-Int specific applications",
   "sideEffects": [
     "*.css"

package/src/index.js

@@ -2,6 +2,7 @@
 export {
   useActiveElement,
   useHelperApp,
+  useKiwtFieldArray,
   useKiwtSASQuery,
   useLocalStorageState,
   useMutateRefdataValue,

package/src/lib/hooks/README.md

@@ -214,4 +214,77 @@ const Test() {
 }
 
 export default Test;
-```
+```
+
+## useKiwtFieldArray
+A hook to replace `withKiwtFieldArray` [from stripes-erm-components](https://github.com/folio-org/stripes-erm-components/tree/master/lib/withKiwtFieldArray). Provides functions for adding and deleting items in a way which the backend endpoints will understand, as well as an "items" array to track the current set of valid items in the form.
+
+
+### BasicUsage
+```
+...
+import useKiwtFieldArray from '../../../util/useKiwtFieldArray';
+...
+
+const TestFieldArray = () => {
+  const {
+    items,
+    onAddField,
+    onDeleteField
+  } = useKiwtFieldArray(name, true);
+
+  return (
+    <>
+      {items.map((item, index) => {
+        return (
+          <Row>
+            <Col xs={3}>
+              <Field
+                name={`${name}[${index}].name`}
+                component={TextField}
+                required
+                validate={requiredValidator}
+              />
+            </Col>
+            <Col xs={1}>
+              <IconButton
+                icon="trash"
+                id="remove-volume-button"
+                onClick={() => onDeleteField(index, volume)}
+              />
+            </Col>
+          </Row>
+        );
+      })}
+      <Button
+        onClick={() => onAddField({}})}
+      >
+        ADD NEW
+      </Button>
+    </>
+  );
+};
+
+const Test = ({}) => {
+  return (
+    <Form
+      ...
+      render={({ handleSubmit, submitting, form }) => (
+        <form onSubmit={handleSubmit}>
+          <FieldArray
+            name="test"
+            component={TestFieldArray}
+          />
+        </form>
+      )}
+    />
+  );
+};
+export default Test
+```
+
+### Props
+Name | Type | Description | default | required
+--- | --- | --- | --- | ---
+name | String | The name of the fieldArray, used to hook into the final form state for that field. | | ✓ |
+submitWholeDeletedObject | bool | a boolean flag to ensure that a deleted object is sent whole to the backend, rather than just as an id. | false | ✕ |

package/src/lib/hooks/index.js

@@ -6,4 +6,4 @@ export { default as useKiwtSASQuery } from './useKiwtSASQuery';
 export { default as useHelperApp } from './useHelperApp';
 export { default as useLocalStorageState } from './useLocalStorageState';
 export { default as useQIndex } from './useQIndex';
-
+export { default as useKiwtFieldArray } from './useKiwtFieldArray';

package/src/lib/hooks/useKiwtFieldArray.js

@@ -0,0 +1,63 @@
+import { useEffect, useState } from 'react';
+import { useFieldArray } from 'react-final-form-arrays';
+
+const useKiwtFieldArray = (name, submitWholeDeletedObject = false) => {
+  const { fields } = useFieldArray(name);
+  const { value: values = [] } = fields;
+  const [endOfList, setEndOfList] = useState(0);
+
+  useEffect(() => {
+    const i = values.filter(line => !line._delete);
+    setEndOfList(i.length);
+  }, [values]);
+
+  const onAddField = (field = { _delete: false }) => {
+    fields.insert(endOfList, field);
+  };
+
+  const onMarkForDeletion = (field) => {
+    if (field && field.id) {
+      if (submitWholeDeletedObject) {
+        fields.push({ ...field, _delete: true });
+      } else {
+        fields.push({ id: field.id, _delete: true });
+      }
+    }
+  };
+
+  const onDeleteField = (index, field) => {
+    fields.remove(index);
+    onMarkForDeletion(field);
+  };
+
+  const onPrependField = (field = { _delete: false }) => {
+    fields.unshift(field);
+  };
+
+  const onReplaceField = (index, field) => {
+    if (fields.update) { // react-final-form-arrays
+      fields.update(index, field);
+    }
+  };
+
+  const onUpdateField = (index, field) => {
+    fields.update(index, {
+      ...fields.value[index],
+      ...field,
+    });
+  };
+
+  const items = values.slice(0, endOfList);
+
+  return {
+    items,
+    onAddField,
+    onDeleteField,
+    onMarkForDeletion,
+    onPrependField,
+    onReplaceField,
+    onUpdateField,
+  };
+};
+
+export default useKiwtFieldArray;