@k-int/stripes-kint-components 5.5.2 → 5.6.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.6.1](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.6.0...v5.6.1) (2024-04-16)
+
+
+### Bug Fixes
+
+* ERM-3194 Always display error message if delete of picklist value unsuccessful ([f58d971](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/f58d9710238730d6d65b3f348106892daec0d54e))
+
+# [5.6.0](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.5.2...v5.6.0) (2024-04-04)
+
+
+### Features
+
+* FormModal default now handles async and sync submit handlers differently, and implementor can hook into those with onError and onSuccess props. ([822882c](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/commit/822882cfa428e8785c2f04541776526b5846e5f3))
+
 ## [5.5.2](https://gitlab.com/knowledge-integration/folio/stripes-kint-components/compare/v5.5.1...v5.5.2) (2024-03-25)
 
 

package/es/lib/FormModal/FormModal.js

@@ -21,7 +21,11 @@ const FormModal = _ref => {
       onClose,
       ...modalProps
     },
+    onError,
+    // Optional handler to run onSuccess for default handleSaveAndClear
     onSubmit,
+    onSuccess,
+    // Optional handler to run onSuccess for default handleSaveAndClear
     ...formProps
   } = _ref;
   const kintIntl = (0, _hooks.useKintIntl)(passedIntlKey, passedIntlNS);
@@ -41,9 +45,52 @@ const FormModal = _ref => {
         onClose(e);
         restart();
       };
+
+      // Handle asynchronous submit functions differently to synchronous ones
       const handleSaveAndClear = function () {
-        handleSubmit(...arguments);
-        restart();
+        try {
+          const submitReturn = handleSubmit(...arguments);
+
+          // Figure out if we're in an async or sync submit function
+          if (typeof submitReturn === 'object' && typeof submitReturn.then === 'function') {
+            // Async function
+            return submitReturn.then(incomingParams => {
+              restart();
+              return incomingParams;
+            }).then(incomingParams => {
+              if (onSuccess && typeof onSuccess === 'function') {
+                // Allow onSuccess to dictate what continues downstream
+                return onSuccess(incomingParams);
+              }
+              return incomingParams;
+            }).catch(incomingParams => {
+              if (onError && typeof onError === 'function') {
+                // Allow onError to dictate what continues downstream
+                return onError(incomingParams);
+              }
+              return incomingParams;
+            });
+          } else if (onSuccess && typeof onSuccess === 'function') {
+            // Sync function and we have an onSuccess handler
+
+            // onSuccess dictates return
+            const returnShape = onSuccess(submitReturn);
+            restart();
+            return returnShape;
+          } else {
+            // Sync function and we have no onSuccess handler
+
+            restart();
+            return submitReturn;
+          }
+        } catch (err) {
+          // Sync function catch
+          if (onError && typeof onError === 'function') {
+            // Allow onError to dictate what continues downstream
+            return onError(err);
+          }
+          return null;
+        }
       };
       const renderFooter = () => {
         if (footer) {
@@ -51,7 +98,9 @@ const FormModal = _ref => {
             formState,
             handleSubmit: handleSaveAndClear,
             handleClose,
-            handleSubmitNoRestart: handleSubmit
+            handleSubmitNoRestart: handleSubmit,
+            // DEPRECATED -- should use handleSubmitRaw
+            handleSubmitRaw: handleSubmit
           });
         }
         const {
@@ -100,6 +149,8 @@ FormModal.propTypes = {
     footer: _propTypes.default.func,
     onClose: _propTypes.default.func
   }),
-  onSubmit: _propTypes.default.func
+  onError: _propTypes.default.func,
+  onSubmit: _propTypes.default.func,
+  onSuccess: _propTypes.default.func
 };
 var _default = exports.default = FormModal;

package/es/lib/utils/parseErrorResponse.js

@@ -6,7 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 const parseErrorResponse = async responseObj => {
   var _ref;
-  let errorResp;
+  let errorResp = {
+    message: 'something went wrong'
+  };
+  if (!responseObj) {
+    return errorResp;
+  }
   const code = responseObj === null || responseObj === void 0 ? void 0 : responseObj.status;
   const contentType = (_ref = [...(responseObj === null || responseObj === void 0 ? void 0 : responseObj.headers)]) === null || _ref === void 0 || (_ref = _ref.find(header => header[0] === 'content-type')) === null || _ref === void 0 ? void 0 : _ref[1];
   if (contentType.includes('json')) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-int/stripes-kint-components",
-  "version": "5.5.2",
+  "version": "5.6.1",
   "description": "Stripes Component library for K-Int specific applications",
   "sideEffects": [
     "*.css"
@@ -59,7 +59,7 @@
     "core-js": "^3.6.1",
     "eslint": "^8.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-jest": "^28.0.0",
     "graphql": "^16.0.0",
     "identity-obj-proxy": "^3.0.0",
     "moment": "^2.29.4",

package/src/lib/FormModal/FormModal.js

@@ -10,7 +10,9 @@ const FormModal = ({
   intlNS: passedIntlNS,
   labelOverrides = {},
   modalProps: { footer, onClose, ...modalProps },
+  onError, // Optional handler to run onSuccess for default handleSaveAndClear
   onSubmit,
+  onSuccess, // Optional handler to run onSuccess for default handleSaveAndClear
   ...formProps
 }) => {
   const kintIntl = useKintIntl(passedIntlKey, passedIntlNS);
@@ -27,14 +29,63 @@ const FormModal = ({
           restart();
         };
 
+        // Handle asynchronous submit functions differently to synchronous ones
         const handleSaveAndClear = (...onSaveProps) => {
-          handleSubmit(...onSaveProps);
-          restart();
+          try {
+            const submitReturn = handleSubmit(...onSaveProps);
+
+            // Figure out if we're in an async or sync submit function
+            if (typeof submitReturn === 'object' && typeof submitReturn.then === 'function') {
+              // Async function
+              return submitReturn.then((incomingParams) => {
+                restart();
+                return incomingParams;
+              }).then((incomingParams) => {
+                if (onSuccess && typeof onSuccess === 'function') {
+                  // Allow onSuccess to dictate what continues downstream
+                  return onSuccess(incomingParams);
+                }
+                return incomingParams;
+              }).catch((incomingParams) => {
+                if (onError && typeof onError === 'function') {
+                  // Allow onError to dictate what continues downstream
+                  return onError(incomingParams);
+                }
+                return incomingParams;
+              });
+            } else if (onSuccess && typeof onSuccess === 'function') {
+              // Sync function and we have an onSuccess handler
+
+              // onSuccess dictates return
+              const returnShape = onSuccess(submitReturn);
+              restart();
+              return returnShape;
+            } else {
+              // Sync function and we have no onSuccess handler
+
+              restart();
+              return submitReturn;
+            }
+          } catch (err) {
+            // Sync function catch
+            if (onError && typeof onError === 'function') {
+              // Allow onError to dictate what continues downstream
+              return onError(err);
+            }
+
+            return null;
+          }
         };
 
         const renderFooter = () => {
           if (footer) {
-            return footer({ formState, handleSubmit: handleSaveAndClear, handleClose, handleSubmitNoRestart: handleSubmit });
+            return footer({
+              formState,
+              handleSubmit: handleSaveAndClear,
+              handleClose,
+              handleSubmitNoRestart: handleSubmit, // DEPRECATED -- should use handleSubmitRaw
+              handleSubmitRaw: handleSubmit
+            });
           }
 
           const { invalid, pristine, submitting, validating } = formState;
@@ -93,7 +144,9 @@ FormModal.propTypes = {
     footer: PropTypes.func,
     onClose: PropTypes.func,
   }),
-  onSubmit: PropTypes.func
+  onError: PropTypes.func,
+  onSubmit: PropTypes.func,
+  onSuccess: PropTypes.func
 };
 
 export default FormModal;

package/src/lib/utils/parseErrorResponse.js

@@ -1,5 +1,8 @@
 const parseErrorResponse = async (responseObj) => {
-  let errorResp;
+  let errorResp = { message: 'something went wrong' };
+  if (!responseObj) {
+    return errorResp;
+  }
   const code = responseObj?.status;
   const contentType = [...responseObj?.headers]?.find(header => header[0] === 'content-type')?.[1];