@adaskothebeast/react-redux-toolkit-hierarchical-date-hook 1.1.0 → 1.2.0

package/index.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src\\index";

package/index.esm.js

@@ -0,0 +1,51 @@
+import 'core-js/modules/es.array.iterator.js';
+import 'core-js/modules/es.object.assign.js';
+
+/**
+ * This custom hook transforms the string date fields based on matching regex to Date objects
+ * of a Redux Toolkit query result using the HierarchicalConverter.
+ * In cases of some libraries it is also possible to convert Period automatically.
+ * It deep-clones the data field and then performs the conversion.
+ * If there's no data, it returns the original query result unchanged.
+ *
+ * Usage:
+ * ```jsx
+ *  // choose one function from below depending on library which you use for date manipulation
+ *  import { hierarchicalConvertToDate } from '@adaskothebeast/hierarchical-convert-to-date';
+ *  import { hierarchicalConvertToDateFns } from '@adaskothebeast/hierarchical-convert-to-date-fns';
+ *  import { hierarchicalConvertToDayjs } from '@adaskothebeast/hierarchical-convert-to-dayjs';
+ *  import { hierarchicalConvertToJsJoda } from '@adaskothebeast/hierarchical-convert-to-js-joda';
+ *  import { hierarchicalConvertToLuxon } from '@adaskothebeast/hierarchical-convert-to-luxon';
+ *  import { hierarchicalConvertToMoment } from '@adaskothebeast/hierarchical-convert-to-moment';
+ *
+ * const MyComponent: React.FC = () => {
+ *   // Call your generated hook here
+ *   const useQueryResult = useQueryFunction(arg, options);
+ *
+ *   // Pass the result to the custom hook
+ *   const adjustedResult = useAdjustUseQueryHookResultWithHierarchicalDateConverter(useQueryResult, hierarchicalConvertToDate);
+ *
+ *   // Rest of your component...
+ * }
+ * ```
+ *
+ * @param useQueryResult The result of a Redux Toolkit query hook
+ * @param convertFunc The function that performs the conversion in place
+ * @returns The original query result with its data field transformed, if it exists
+ */
+function useAdjustUseQueryHookResultWithHierarchicalDateConverter(useQueryResult, convertFunc) {
+  const result = useQueryResult;
+  // Transform 'data' field if it exists
+  if (result.data) {
+    // Deep clone the data to avoid mutating the state directly
+    const clonedData = structuredClone(result.data);
+    convertFunc(clonedData);
+    return Object.assign(Object.assign({}, result), {
+      data: clonedData
+    }); // Type assertion via 'unknown'
+  }
+  // If there's no 'data', return the result as is
+  return result;
+}
+
+export { useAdjustUseQueryHookResultWithHierarchicalDateConverter };

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@adaskothebeast/react-redux-toolkit-hierarchical-date-hook",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "peerDependencies": {
-    "@reduxjs/toolkit": "^1.9.5"
+    "@reduxjs/toolkit": "^1.9.5",
+    "core-js": "3.32.0"
   },
   "devDependencies": {
-    "@adaskothebeast/hierarchical-convert-to-date": "1.0.0"
+    "@adaskothebeast/hierarchical-convert-to-date": "1.2.0"
   },
   "sideEffects": false,
-  "module": "./index.js",
-  "main": "./index.js",
+  "module": "./index.esm.js",
   "type": "module",
-  "types": "./src\\index.d.ts"
+  "main": "./index.esm.js"
 }