@k-int/stripes-kint-components 5.27.0 → 5.28.0

package/src/lib/Settings/hooks/staticSettingsPages/useSettingsSectionInitalValues/useSettingsSectionInitalValues.js

@@ -0,0 +1,27 @@
+import { useMemo } from 'react';
+
+const useSettingsSectionInitalValues = ({
+  settings: rawSettings, // A settingsSection return of EXACTLY the shape defined in useSettingsSection
+}) => {
+  const initialValues = useMemo(() => {
+    const settingsKeyValue = rawSettings.map(setting => {
+      const { key, value, settingType } = setting;
+      let parsedValue;
+      if (settingType === 'Boolean') {
+        parsedValue = value === 'true';
+      } else if (settingType === 'Integer') {
+        parsedValue = Number(value);
+      } else {
+        parsedValue = value;
+      }
+
+      return [key, parsedValue];
+    });
+
+    return Object.fromEntries(settingsKeyValue);
+  }, [rawSettings]);
+
+  return initialValues;
+};
+
+export default useSettingsSectionInitalValues;

package/src/lib/Settings/hooks/staticSettingsPages/useStaticSettingsSection.js

@@ -0,0 +1,100 @@
+import { useCallback } from 'react';
+
+import useSettingSection from '../useSettingSection';
+import useSettingsSectionInitalValues from './useSettingsSectionInitalValues';
+import useSettingCallout from './useSettingCallout';
+
+/**
+ * A helper hook which collates several hooks useful in the setup and operation of static setting pages, in which
+ * an entire section of AppSetting objects needs to be submitted at once
+ */
+const useStaticSettingsSection = ({
+  intlKey: passedIntlKey,
+  intlNS: passedIntlNS,
+  onSubmitComplete = () => null, // Callback which runs after all promises have completed
+  onSettingsSuccess = () => null, // Specifically logic to handle a list of successful settings calls
+  onSettingsFailure = () => null, // Specifically logic to handle a list of failed settings calls
+  sectionName,
+  settingEndpoint,
+  getQueryNamespaceGenerator
+}) => {
+  // Following example in agreements for useAgreementsDisplaySettings
+  const settingsSection = useSettingSection({
+    sectionName,
+    settingEndpoint,
+    getQueryNamespaceGenerator
+  });
+
+  const { handleSubmit, settings: rawSettings } = settingsSection;
+
+  // We should ONLY change initial values when autoResponderValues updates
+  // initialValues should take a KIWT AppSetting object and turn it into key/value for the Form
+  const initialValues = useSettingsSectionInitalValues({ settings: rawSettings });
+  const sendSettingsCallout = useSettingCallout({
+    intlKey: passedIntlKey,
+    intlNS: passedIntlNS,
+  }); // Translations will need to be set up here for this to work
+
+  const onSubmit = useCallback((values) => {
+    const updates = [];
+
+    rawSettings.forEach(setting => {
+      const originalValue = initialValues[setting.key];
+      const formValue = values[setting.key];
+      if (formValue !== originalValue) {
+        updates.push({
+          ...setting,
+          value: formValue.toString()
+        });
+      }
+    });
+
+    if (updates.length > 0) {
+      const successful = [];
+      const failed = [];
+
+      // type MUST be 'success' or 'error'
+
+      // We catch any failed requests and stick them in an array for us to deal with later
+      const updatePromises = updates.map(update => handleSubmit(update)
+        .then(() => {
+          // Ensure same shape for these objects in failure AND success
+          successful.push({ setting: update });
+        })
+        .catch((error) => {
+          failed.push({ setting: update, error });
+        }));
+
+      return Promise.all(updatePromises)
+        .then(() => {
+          if (successful.length > 0) {
+            sendSettingsCallout({ type: 'success', settings: successful });
+            onSettingsSuccess({ settings: successful });
+          }
+
+          if (failed.length > 0) {
+            sendSettingsCallout({ type: 'error', settings: failed });
+            onSettingsFailure({ settings: failed });
+          }
+
+          onSubmitComplete();
+          return true;
+        });
+    }
+    // In case we somehow called this with no updates
+    // (Shouldn't be possible because of the disabled save button),
+    // return an empty promise
+    return Promise.resolve(true);
+  }, [rawSettings, initialValues, handleSubmit, onSubmitComplete, sendSettingsCallout, onSettingsSuccess, onSettingsFailure]);
+
+
+  return ({
+    rawSettings,
+    initialValues,
+    onSubmit,
+    sendSettingsCallout,
+    settingsSection
+  });
+};
+
+export default useStaticSettingsSection;

package/src/lib/{settingsHooks → Settings/hooks}/useAppSettings/README.md

@@ -3,7 +3,7 @@ A hook for fetching AppSetting values
 
 ## Basic usage
 ```javascript
-import { useAppSettings } from '@k-int/stripes-kint-components'
+import { useAppSettings } from '@k-int/stripes-kint-components';
 ...
 const data = useAppSettings({ 
   endpoint: 'oa/settings/appSettings'

package/src/lib/{settingsHooks → Settings/hooks}/useAppSettings/useAppSettings.js

@@ -1,6 +1,6 @@
 import { useQuery } from 'react-query';
 import { useOkapiKy } from '@folio/stripes/core';
-import { generateKiwtQueryParams } from '../../utils';
+import { generateKiwtQueryParams } from '../../../utils';
 
 const useAppSettings = ({
   endpoint,

package/src/lib/{settingsHooks → Settings/hooks}/useSettingSection/useSettingSection.js

@@ -1,12 +1,14 @@
 import { useMutation, useQuery } from 'react-query';
 import { useOkapiKy } from '@folio/stripes/core';
-import { generateKiwtQueryParams } from '../../utils';
+import { generateKiwtQueryParams } from '../../../utils';
+
+import { GET_SETTING_SECTION_MUTATE_KEY, GET_SETTING_SECTION_QUERY_KEY } from '../../constants';
 
 const useSettingSection = ({
   sectionName,
   settingEndpoint,
-  getQueryNamespaceGenerator = ({ queryParams }) => ['stripes-kint-components', 'useSetting', 'appSettings', queryParams, sectionName],
-  getMutateNamespaceGenerator = () => ['stripes-kint-components', 'useSetting', 'putSetting', sectionName]
+  getQueryNamespaceGenerator = ({ queryParams }) => GET_SETTING_SECTION_QUERY_KEY(queryParams, sectionName),
+  getMutateNamespaceGenerator = () => GET_SETTING_SECTION_MUTATE_KEY(sectionName)
 }) => {
   const ky = useOkapiKy();
   const queryParams = generateKiwtQueryParams({

package/src/lib/{settingsHooks → Settings/hooks}/useSettings/useSettings.js

@@ -9,8 +9,8 @@ import { Settings } from '@folio/stripes/smart-components';
 import { SettingPage, SettingPagePane } from '../../SettingPage';
 import { SettingsContext } from '../../contexts';
 
-import { generateKiwtQueryParams, sortByLabel, toCamelCase } from '../../utils';
-import { useKintIntl, useIntlKey } from '../../hooks';
+import { generateKiwtQueryParams, sortByLabel, toCamelCase } from '../../../utils';
+import { useKintIntl, useIntlKey } from '../../../hooks';
 
 // TODO work underway to make the settings hook more useful when trying to render multiple sections at a time
 const useSettings = (settingsProps = {}) => {

package/src/lib/Settings/index.js

@@ -0,0 +1,28 @@
+export { default as SettingsFormContainer } from './SettingsFormContainer';
+
+// Settings hooks
+export * from './hooks';
+
+// Setting Page Components
+export {
+  SettingPage,
+  SettingPagePane,
+} from './SettingPage';
+
+// EditableSettingsList
+export * from './EditableSettingsList';
+
+// Refdata categories
+export { default as RefdataCategoriesSettings } from './RefdataCategoriesSettings';
+
+export { default as EditableRefdataList } from './EditableRefdataList';
+export { default as EditableRefdataCategoryList } from './EditableRefdataCategoryList';
+
+export { default as StaticSettingsField } from './StaticSettingsField';
+
+// Contexts
+export {
+  SettingsContext,
+} from './contexts';
+
+export * from './constants';

package/test/jest/helpers/KintHarness.js

@@ -4,7 +4,7 @@ import { BaseHarness } from '@folio/stripes-erm-testing';
 
 import { useIntlKeyStore } from '../../../src';
 
-import { SettingsContext } from '../../../src/lib/contexts';
+import { SettingsContext } from '../../../src/lib/Settings';
 import translationsProperties from '../../helpers';
 
 const InternalKintIntlHarness = ({ children, intlKey, moduleName }) => {

package/es/lib/EditableSettingsList/SettingField/EditSettingValue/EditSettingValue.js

@@ -1,107 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _react = _interopRequireDefault(require("react"));
-var _propTypes = _interopRequireDefault(require("prop-types"));
-var _reactFinalForm = require("react-final-form");
-var _components = require("@folio/stripes/components");
-var _RefdataButtons = _interopRequireDefault(require("../../../RefdataButtons"));
-var _hooks = require("../../../hooks");
-var _jsxRuntime = require("react/jsx-runtime");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const EditSettingValue = props => {
-  const {
-    currentSetting: setting,
-    input,
-    intlKey: passedIntlKey,
-    intlNS: passedIntlNS,
-    labelOverrides = {},
-    refdata,
-    templates
-  } = props;
-  const kintIntl = (0, _hooks.useKintIntl)(passedIntlKey, passedIntlNS);
-  const fieldLabel = kintIntl.formatKintMessage({
-    id: 'settings.valueFor',
-    overrideValue: labelOverrides === null || labelOverrides === void 0 ? void 0 : labelOverrides.valueFor
-  }, {
-    name: setting.key
-  });
-
-  // Adding default sort to refdata object in ascending order by label
-  const sortByLabel = (a, b) => a.label.localeCompare(b.label);
-  const sortedRefdata = refdata === null || refdata === void 0 ? void 0 : refdata.sort(sortByLabel);
-  switch (setting.settingType) {
-    case 'Refdata':
-      // Grab refdata values corresponding to setting
-      // eslint-disable-next-line no-case-declarations
-      let RefdataComponent = _components.Select;
-      if (refdata.length > 0 && refdata.length <= 4) {
-        RefdataComponent = _RefdataButtons.default;
-      }
-      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactFinalForm.Field, {
-        "aria-label": fieldLabel,
-        component: RefdataComponent,
-        dataOptions: sortedRefdata,
-        name: "".concat(input.name, ".value")
-      });
-    case 'Password':
-      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactFinalForm.Field, {
-        "aria-label": fieldLabel,
-        autoFocus: true,
-        component: _components.TextField,
-        name: "".concat(input.name, ".value"),
-        parse: v => v // Lets us send an empty string instead of 'undefined'
-        ,
-        type: "password"
-      });
-    case 'Template':
-      {
-        // Grab refdata values corresponding to setting
-        // eslint-disable-next-line no-case-declarations
-        const selectTemplateValues = [{
-          value: '',
-          label: ''
-        }, ...templates.map(t => ({
-          value: t.id,
-          label: t.name
-        }))];
-        return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactFinalForm.Field, {
-          "aria-label": fieldLabel,
-          component: _components.Select,
-          dataOptions: selectTemplateValues,
-          name: "".concat(input.name, ".value"),
-          parse: v => v
-        });
-      }
-    default:
-      // If in doubt, go with String
-      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactFinalForm.Field, {
-        "aria-label": fieldLabel,
-        autoFocus: true,
-        component: _components.TextField,
-        name: "".concat(input.name, ".value"),
-        parse: v => v // Lets us send an empty string instead of 'undefined'
-      });
-  }
-};
-EditSettingValue.propTypes = {
-  currentSetting: _propTypes.default.shape({
-    settingType: _propTypes.default.string,
-    key: _propTypes.default.string
-  }),
-  input: _propTypes.default.shape({
-    name: _propTypes.default.string
-  }),
-  intlKey: _propTypes.default.string,
-  intlNS: _propTypes.default.string,
-  labelOverrides: _propTypes.default.object,
-  refdata: _propTypes.default.arrayOf(_propTypes.default.object),
-  templates: _propTypes.default.arrayOf(_propTypes.default.shape({
-    name: _propTypes.default.string,
-    id: _propTypes.default.string
-  }))
-};
-var _default = exports.default = EditSettingValue;

package/src/lib/EditableRefdataList/README.md

@@ -1,26 +0,0 @@
-# EditableRefdataList
-A component designed to render an editable list of refdata, which is editable if the refdata has property `internal: false`.
-This will create an `ActionList` complete with `edit`, `delete` and `create` actions, and allow the user to edit the `value` and `label` of refdataValues.
-
-## Basic Usage
-```
-import { EditableRefdataList } from '@k-int/stripes-kint-components';
-
-...
-<EditableRefdataList
-  desc="PublicationRequest.RequestStatus"
-  refdataEndpoint="oa/refdata"
-/>
-```
-
-## Props
-
-Name | Type | Description | default | required
---- | --- | --- | --- | ---
-afterQueryCalls | object | An object of the form `{delete: func1, put: func2}` where `func1`/`func2` are functions to be called after the `delete`/`put`. | | ✕ |
-allowSpecial | boolean | A boolean to turn off/on the stripping out of special characters and replacing them with `_`. Generally turning this on will cause problems with queries to KIWT endpoints and internally with Stripes filters, where a refdata value includes `&&`, `||`, `\` or `"`. | false | ✕ |
-catchQueryCalls | object | An object of the form `{delete: func1, put: func2}` where `func1`/`func2` are functions to be called with a HTTPError object when the `delete`/`put` calls fail. | `{delete: <Fires a callout of the format "<strong>Error: {label}</strong> was not deleted. {error}">}` | | ✕ |
-desc | String | A string corresponding to the refdataValue category, usually of the form `DomainClass.Field`. See `useRefdata` for more information. | | ✕ |
-displayConditions | object | An object of the form `{delete: false, edit: true, create: true}`, with keys `delete`, `edit` and `create`, and a boolean value. These will each default to true if not specified. These booleans will act as an additional check before rendering the actions for create/delete/edit, as well as whether or not to render the actions column at all. | `{delete: true, edit: true, create: true}` | ✕ |
-endpoint | String | A string containing the path to the endpoint for refdata | | ✓ |
-labelOverrides | object | An object containing translation overrides. Currently accepts: `deleteError: (err, object) => { ... output a callout message }`. | | ✕ |