@adaskothebeast/react-redux-toolkit-hierarchical-date-hook 4.0.1 → 6.0.0

package/index.esm.js

@@ -1,9 +1,12 @@
-import 'core-js/modules/es.array.iterator.js';
-import 'core-js/modules/es.object.assign.js';
-import 'core-js/modules/web.dom-exception.constructor.js';
-import 'core-js/modules/web.dom-exception.stack.js';
-import 'core-js/modules/web.dom-exception.to-string-tag.js';
-import 'core-js/modules/web.structured-clone.js';
+function _extends() {
+  return _extends = Object.assign ? Object.assign.bind() : function (n) {
+    for (var e = 1; e < arguments.length; e++) {
+      var t = arguments[e];
+      for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]);
+    }
+    return n;
+  }, _extends.apply(null, arguments);
+}
 
 /**
  * This custom hook transforms the string date fields based on matching regex to Date objects
@@ -21,16 +24,25 @@ import 'core-js/modules/web.structured-clone.js';
  *  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';
+ *   import { hierarchicalConvertToDate } from '@adaskothebeast/hierarchical-convert-to-date';
+ *
+ *   const MyComponent: React.FC = () => {
+ *     const useQueryResult = useGetUserQuery(userId);
+ *     const adjustedResult = useAdjustUseQueryHookResultWithHierarchicalDateConverter(
+ *       useQueryResult,
+ *       hierarchicalConvertToDate
+ *     );
  *
- * const MyComponent: React.FC = () => {
- *   // Call your generated hook here
- *   const useQueryResult = useQueryFunction(arg, options);
+ *     if (adjustedResult.isLoading) {
+ *       return <div>Loading...</div>;
+ *     }
  *
- *   // Pass the result to the custom hook
- *   const adjustedResult = useAdjustUseQueryHookResultWithHierarchicalDateConverter(useQueryResult, hierarchicalConvertToDate);
+ *     if (adjustedResult.error) {
+ *       return <div>Error: {adjustedResult.error}</div>;
+ *     }
  *
- *   // Rest of your component...
- * }
+ *     return <div>User's name is {adjustedResult.data?.name}</div>;
+ *   };
  * ```
  *
  * @param useQueryResult The result of a Redux Toolkit query hook
@@ -38,18 +50,14 @@ import 'core-js/modules/web.structured-clone.js';
  * @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);
+  if (useQueryResult.data) {
+    const clonedData = structuredClone(useQueryResult.data);
     convertFunc(clonedData);
-    return Object.assign(Object.assign({}, result), {
+    return _extends({}, useQueryResult, {
       data: clonedData
-    }); // Type assertion via 'unknown'
+    });
   }
-  // If there's no 'data', return the result as is
-  return result;
+  return useQueryResult;
 }
 
 export { useAdjustUseQueryHookResultWithHierarchicalDateConverter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaskothebeast/react-redux-toolkit-hierarchical-date-hook",
-  "version": "4.0.1",
+  "version": "6.0.0",
   "license": "MIT",
   "author": "Adam Pluciński <adaskothebeast@gmail.com> (https://github.com/adaskothebeast)",
   "repository": {
@@ -12,11 +12,11 @@
   },
   "homepage": "https://github.com/AdaskoTheBeAsT/date-interceptors",
   "peerDependencies": {
-    "@reduxjs/toolkit": "^2.2.5",
     "jest-environment-jsdom": "*"
   },
   "sideEffects": false,
   "module": "./index.esm.js",
   "type": "module",
-  "main": "./index.esm.js"
+  "main": "./index.esm.js",
+  "types": "./index.d.ts"
 }

package/src/lib/react-redux-toolkit-hierarchical-date-hook.d.ts

@@ -1,5 +1,12 @@
-import { UseQueryHookResult } from '@reduxjs/toolkit/dist/query/react/buildHooks';
-import { BaseQueryFn, QueryDefinition, TypedUseQueryStateResult } from '@reduxjs/toolkit/query/react';
+interface CustomQueryResult<ResultType> {
+    data?: ResultType;
+    error?: Error;
+    isLoading: boolean;
+    isFetching: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    refetch: () => void;
+}
 /**
  * This custom hook transforms the string date fields based on matching regex to Date objects
  * of a Redux Toolkit query result using the HierarchicalConverter.
@@ -16,20 +23,30 @@ import { BaseQueryFn, QueryDefinition, TypedUseQueryStateResult } from '@reduxjs
  *  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';
+ *   import { hierarchicalConvertToDate } from '@adaskothebeast/hierarchical-convert-to-date';
  *
- * const MyComponent: React.FC = () => {
- *   // Call your generated hook here
- *   const useQueryResult = useQueryFunction(arg, options);
+ *   const MyComponent: React.FC = () => {
+ *     const useQueryResult = useGetUserQuery(userId);
+ *     const adjustedResult = useAdjustUseQueryHookResultWithHierarchicalDateConverter(
+ *       useQueryResult,
+ *       hierarchicalConvertToDate
+ *     );
  *
- *   // Pass the result to the custom hook
- *   const adjustedResult = useAdjustUseQueryHookResultWithHierarchicalDateConverter(useQueryResult, hierarchicalConvertToDate);
+ *     if (adjustedResult.isLoading) {
+ *       return <div>Loading...</div>;
+ *     }
  *
- *   // Rest of your component...
- * }
+ *     if (adjustedResult.error) {
+ *       return <div>Error: {adjustedResult.error}</div>;
+ *     }
+ *
+ *     return <div>User's name is {adjustedResult.data?.name}</div>;
+ *   };
  * ```
  *
  * @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
  */
-export declare function useAdjustUseQueryHookResultWithHierarchicalDateConverter<ResultType, QueryArg, BaseQuery extends BaseQueryFn = BaseQueryFn, ReducerPath extends string = string, R extends TypedUseQueryStateResult<ResultType, QueryArg, BaseQuery> = TypedUseQueryStateResult<ResultType, QueryArg, BaseQuery>>(useQueryResult: UseQueryHookResult<QueryDefinition<QueryArg, BaseQuery, string, ResultType, ReducerPath>, R>, convertFunc: (obj: object) => void): UseQueryHookResult<QueryDefinition<QueryArg, BaseQuery, string, ResultType, ReducerPath>, R>;
+export declare function useAdjustUseQueryHookResultWithHierarchicalDateConverter<ResultType>(useQueryResult: CustomQueryResult<ResultType>, convertFunc: (obj: object) => void): CustomQueryResult<ResultType>;
+export {};