react-redux-cache 0.9.0 → 0.11.0

package/README.md

@@ -41,13 +41,12 @@ Examples of states, generated by cache reducer from `/example` project:
     queries: {
       // each query has its own map of query states, stored by cache key, which is generated from query params
       getUser: {
-        "2": {loading: false, result: 2, params: 2, expiresAt: 1727217298025},
+        "2": {result: 2, params: 2, expiresAt: 1727217298025},
         "3": {loading: true, params: 3}
       },
       getUsers: {
         // example of paginated state under custom cache key
         "all-pages": {
-          loading: false,
           result: {items: [0,1,2], page: 1},
           params: {page: 1}
         }
@@ -56,7 +55,6 @@ Examples of states, generated by cache reducer from `/example` project:
     mutations: {
       // each mutation has its own state as well
       updateUser: {
-        loading: false,
         result: 1,
         params: {id: 1, name: "User 1 *"}
       } 
@@ -78,7 +76,6 @@ Examples of states, generated by cache reducer from `/example` project:
       // each query has its own map of query states, stored by cache key, which is generated from query params
       getUser: {
         "2": {
-          loading: false,
           result: {id: 2, bank: {id: "2", name: "Bank 2"}, name: "User 2"},
           params: 2,
           expiresAt: 1727217298025
@@ -88,7 +85,6 @@ Examples of states, generated by cache reducer from `/example` project:
       getUsers: {
         // example of paginated state under custom cache key
         "all-pages": {
-          loading: false,
           result: {
             items: [
               {id: 0, bank: {id: "0", name: "Bank 0"}, name: "User 0 *"},
@@ -104,7 +100,6 @@ Examples of states, generated by cache reducer from `/example` project:
     mutations: {
       // each mutation has its own state as well
       updateUser: {
-        loading: false,
         result: {id: 1, bank: {id: "1", name: "Bank 1"}, name: "User 1 *"},
         params: {id: 1, name: "User 1 *"}
       } 
@@ -165,6 +160,7 @@ export const {
       query: getUser,
       // For each query `secondsToLive` option can be set, which is used to set expiration date of a cached result when query response is received.
       // After expiration query result is considered invalidated and will be refetched on the next useQuery mount.
+      // Can also be set globally in `globals`.
       secondsToLive: 5 * 60 // Here cached result is valid for 5 minutes.
     },
   },

package/dist/createCache.js

@@ -30,7 +30,7 @@ const withTypenames = () => {
             // provide all optional fields
             (_a = partialCache.options) !== null && _a !== void 0 ? _a : (partialCache.options = {});
             (_b = (_k = partialCache.options).logsEnabled) !== null && _b !== void 0 ? _b : (_k.logsEnabled = false);
-            (_c = (_l = partialCache.options).validateFunctionArguments) !== null && _c !== void 0 ? _c : (_l.validateFunctionArguments = utilsAndConstants_1.IS_DEV);
+            (_c = (_l = partialCache.options).additionalValidation) !== null && _c !== void 0 ? _c : (_l.additionalValidation = utilsAndConstants_1.IS_DEV);
             (_d = (_m = partialCache.options).deepComparisonEnabled) !== null && _d !== void 0 ? _d : (_m.deepComparisonEnabled = true);
             (_e = partialCache.queries) !== null && _e !== void 0 ? _e : (partialCache.queries = {});
             (_f = partialCache.mutations) !== null && _f !== void 0 ? _f : (partialCache.mutations = {});
@@ -53,12 +53,12 @@ const withTypenames = () => {
             const selectQueryState = (state, query, cacheKey) => {
                 var _a;
                 // @ts-expect-error fix later
-                return (_a = cache.cacheStateSelector(state).queries[query][cacheKey]) !== null && _a !== void 0 ? _a : utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE;
+                return (_a = cache.cacheStateSelector(state).queries[query][cacheKey]) !== null && _a !== void 0 ? _a : utilsAndConstants_1.EMPTY_OBJECT;
             };
             const selectMutationState = (state, mutation) => {
                 var _a;
                 // @ts-expect-error fix later
-                return (_a = cache.cacheStateSelector(state).mutations[mutation]) !== null && _a !== void 0 ? _a : utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE;
+                return (_a = cache.cacheStateSelector(state).mutations[mutation]) !== null && _a !== void 0 ? _a : utilsAndConstants_1.EMPTY_OBJECT;
             };
             const actions = (0, createActions_1.createActions)(cache.name);
             return {
@@ -76,7 +76,8 @@ const withTypenames = () => {
                     },
                     /** Selects query loading state. */
                     selectQueryLoading: (state, query, cacheKey) => {
-                        return selectQueryState(state, query, cacheKey).loading;
+                        var _a;
+                        return (_a = selectQueryState(state, query, cacheKey).loading) !== null && _a !== void 0 ? _a : false;
                     },
                     /** Selects query latest error. */
                     selectQueryError: (state, query, cacheKey) => {
@@ -98,7 +99,8 @@ const withTypenames = () => {
                     },
                     /** Selects mutation loading state. */
                     selectMutationLoading: (state, mutation) => {
-                        return selectMutationState(state, mutation).loading;
+                        var _a;
+                        return (_a = selectMutationState(state, mutation).loading) !== null && _a !== void 0 ? _a : false;
                     },
                     /** Selects mutation latest error. */
                     selectMutationError: (state, mutation) => {

package/dist/createCacheReducer.js

@@ -1,4 +1,15 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCacheReducer = void 0;
 const utilsAndConstants_1 = require("./utilsAndConstants");
@@ -23,22 +34,25 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
         });
     const deepEqual = cacheOptions.deepComparisonEnabled ? utilsAndConstants_1.optionalUtils.deepEqual : undefined;
     return (state = initialState, action) => {
-        var _a, _b;
         switch (action.type) {
             case actions.updateQueryStateAndEntities.type: {
                 const { queryKey, queryCacheKey, state: queryState, entityChanges, } = action;
-                const oldQueryState = (_a = state.queries[queryKey][queryCacheKey]) !== null && _a !== void 0 ? _a : utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE;
+                const oldQueryState = state.queries[queryKey][queryCacheKey];
                 let newQueryState = queryState && Object.assign(Object.assign({}, oldQueryState), queryState);
-                // remove undefined optional fields
                 if (newQueryState) {
+                    // remove undefined optional fields
                     for (const key of optionalQueryKeys) {
                         if (key in newQueryState && newQueryState[key] === undefined) {
                             delete newQueryState[key];
                         }
                     }
-                }
-                if (deepEqual === null || deepEqual === void 0 ? void 0 : deepEqual(oldQueryState, newQueryState)) {
-                    newQueryState = undefined;
+                    if ('loading' in newQueryState && !newQueryState.loading) {
+                        delete newQueryState.loading;
+                    }
+                    // skip if new state deep equals to the old state
+                    if (deepEqual === null || deepEqual === void 0 ? void 0 : deepEqual(oldQueryState !== null && oldQueryState !== void 0 ? oldQueryState : utilsAndConstants_1.EMPTY_OBJECT, newQueryState)) {
+                        newQueryState = undefined;
+                    }
                 }
                 const newEntities = entityChanges && (0, utilsAndConstants_1.applyEntityChanges)(state.entities, entityChanges, cacheOptions);
                 let newState;
@@ -47,25 +61,37 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
                     newState.entities = newEntities;
                 }
                 if (newQueryState) {
-                    newState !== null && newState !== void 0 ? newState : (newState = Object.assign({}, state));
-                    newState.queries = Object.assign(Object.assign({}, state.queries), { [queryKey]: Object.assign(Object.assign({}, state.queries[queryKey]), { [queryCacheKey]: newQueryState }) });
+                    if (!(0, utilsAndConstants_1.isEmptyObject)(newQueryState)) {
+                        newState !== null && newState !== void 0 ? newState : (newState = Object.assign({}, state));
+                        newState.queries = Object.assign(Object.assign({}, state.queries), { [queryKey]: Object.assign(Object.assign({}, state.queries[queryKey]), { [queryCacheKey]: newQueryState }) });
+                    }
+                    else if (oldQueryState !== undefined) {
+                        // empty states are removed
+                        const _a = state.queries[queryKey], _b = queryCacheKey, _ = _a[_b], withoutCacheKey = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
+                        newState !== null && newState !== void 0 ? newState : (newState = Object.assign({}, state));
+                        newState.queries = Object.assign(Object.assign({}, state.queries), { [queryKey]: withoutCacheKey });
+                    }
                 }
                 return newState !== null && newState !== void 0 ? newState : state;
             }
             case actions.updateMutationStateAndEntities.type: {
                 const { mutationKey, state: mutationState, entityChanges, } = action;
-                const oldMutationState = (_b = state.mutations[mutationKey]) !== null && _b !== void 0 ? _b : utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE;
+                const oldMutationState = state.mutations[mutationKey];
                 let newMutationState = mutationState && Object.assign(Object.assign({}, oldMutationState), mutationState);
-                // remove undefined optional fields
                 if (newMutationState) {
+                    // remove optional fields with default values
                     for (const key of optionalMutationKeys) {
                         if (key in newMutationState && newMutationState[key] === undefined) {
                             delete newMutationState[key];
                         }
                     }
-                }
-                if (deepEqual === null || deepEqual === void 0 ? void 0 : deepEqual(oldMutationState, newMutationState)) {
-                    newMutationState = undefined;
+                    if ('loading' in newMutationState && !newMutationState.loading) {
+                        delete newMutationState.loading;
+                    }
+                    // skip if new state deep equals to the old state
+                    if (deepEqual === null || deepEqual === void 0 ? void 0 : deepEqual(oldMutationState !== null && oldMutationState !== void 0 ? oldMutationState : utilsAndConstants_1.EMPTY_OBJECT, newMutationState)) {
+                        newMutationState = undefined;
+                    }
                 }
                 const newEntities = entityChanges && (0, utilsAndConstants_1.applyEntityChanges)(state.entities, entityChanges, cacheOptions);
                 let newState;
@@ -74,8 +100,16 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
                     newState.entities = newEntities;
                 }
                 if (newMutationState) {
-                    newState !== null && newState !== void 0 ? newState : (newState = Object.assign({}, state));
-                    newState.mutations = Object.assign(Object.assign({}, state.mutations), { [mutationKey]: newMutationState });
+                    if (!(0, utilsAndConstants_1.isEmptyObject)(newMutationState)) {
+                        newState !== null && newState !== void 0 ? newState : (newState = Object.assign({}, state));
+                        newState.mutations = Object.assign(Object.assign({}, state.mutations), { [mutationKey]: newMutationState });
+                    }
+                    else if (oldMutationState !== undefined) {
+                        // empty states are removed
+                        const _c = state.mutations, _d = mutationKey, _ = _c[_d], withoutMutationKey = __rest(_c, [typeof _d === "symbol" ? _d : _d + ""]);
+                        newState !== null && newState !== void 0 ? newState : (newState = Object.assign({}, state));
+                        newState.mutations = withoutMutationKey;
+                    }
                 }
                 return newState !== null && newState !== void 0 ? newState : state;
             }
@@ -86,7 +120,7 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
             }
             case actions.invalidateQuery.type: {
                 const { queries: queriesToInvalidate } = action;
-                if (!queriesToInvalidate.length) {
+                if (queriesToInvalidate.length === 0) {
                     return state;
                 }
                 const now = Date.now();
@@ -125,13 +159,13 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
                         }
                     }
                 }
-                return !newQueries
+                return newQueries === undefined
                     ? state
                     : Object.assign(Object.assign({}, state), { queries: newQueries });
             }
             case actions.clearQueryState.type: {
                 const { queries: queriesToClear } = action;
-                if (!queriesToClear.length) {
+                if (queriesToClear.length === 0) {
                     return state;
                 }
                 let newQueries = undefined;
@@ -151,13 +185,13 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
                         newQueries[queryKey] = utilsAndConstants_1.EMPTY_OBJECT;
                     }
                 }
-                return !newQueries
+                return newQueries === undefined
                     ? state
                     : Object.assign(Object.assign({}, state), { queries: newQueries });
             }
             case actions.clearMutationState.type: {
                 const { mutationKeys } = action;
-                if (!mutationKeys.length) {
+                if (mutationKeys.length === 0) {
                     return state;
                 }
                 let newMutations = undefined;
@@ -167,7 +201,7 @@ const createCacheReducer = (actions, queryKeys, cacheOptions) => {
                         delete newMutations[mutation];
                     }
                 }
-                return !newMutations
+                return newMutations === undefined
                     ? state
                     : Object.assign(Object.assign({}, state), { mutations: newMutations });
             }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { createCache, withTypenames } from './createCache';
 export type { ReduxCacheState } from './createCacheReducer';
 export * from './types';
-export { defaultGetCacheKey, DEFAULT_QUERY_MUTATION_STATE as defaultQueryMutationState, } from './utilsAndConstants';
+export { defaultGetCacheKey } from './utilsAndConstants';

package/dist/index.js

@@ -14,22 +14,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultQueryMutationState = exports.defaultGetCacheKey = exports.withTypenames = exports.createCache = void 0;
+exports.defaultGetCacheKey = exports.withTypenames = exports.createCache = void 0;
 var createCache_1 = require("./createCache");
 Object.defineProperty(exports, "createCache", { enumerable: true, get: function () { return createCache_1.createCache; } });
 Object.defineProperty(exports, "withTypenames", { enumerable: true, get: function () { return createCache_1.withTypenames; } });
 __exportStar(require("./types"), exports);
 var utilsAndConstants_1 = require("./utilsAndConstants");
 Object.defineProperty(exports, "defaultGetCacheKey", { enumerable: true, get: function () { return utilsAndConstants_1.defaultGetCacheKey; } });
-Object.defineProperty(exports, "defaultQueryMutationState", { enumerable: true, get: function () { return utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE; } });
 // Backlog
 // ! high (1.0.0)
-// rca -> vite
-// check validateFunctionArguments
-// remove undefined optional fields & emtpy states. remove mutation state when it finished without errors
 // remove cachePolicy? make skip/enabled a function? skip -> enabled/shouldFetch?
 // generate full api docs
 // ! medium
+// example rca -> vite
 // optimistic response
 // reset [whole] cache to initial / to provided state
 // globals for success, completions and loading states?

package/dist/types.d.ts

@@ -50,12 +50,12 @@ export type Globals<QP, MP> = {
 };
 export type CacheOptions = {
     /**
-     * Enables validation of package function arguments. Recommened to enable in dev/testing mode.
+     * Enables additional validation with logging to console.warn. Recommened to enable in dev/testing mode.
      * @default true in dev mode.
      * */
-    validateFunctionArguments: boolean;
+    additionalValidation: boolean;
     /**
-     * Enables console logs.
+     * Enables debug logs.
      * @default false
      */
     logsEnabled: boolean;
@@ -145,8 +145,8 @@ export type MutationResult<R> = {
     result?: R;
 };
 export type MutationState<P, R> = {
-    /** `true` when query or mutation is currently in progress. */
-    loading: boolean;
+    /** `true` when fetch is currently in progress. */
+    loading?: boolean;
     /** Result of the latest successfull response. */
     result?: R;
     /** Error of the latest response. */

package/dist/useMutation.js

@@ -53,7 +53,7 @@ const useMutation = (cache, actions, options, abortControllers) => {
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [mutationKey, store]);
     // @ts-expect-error fix later
-    const mutationState = (_a = (0, react_redux_1.useSelector)(mutationStateSelector)) !== null && _a !== void 0 ? _a : utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE;
+    const mutationState = (_a = (0, react_redux_1.useSelector)(mutationStateSelector)) !== null && _a !== void 0 ? _a : utilsAndConstants_1.EMPTY_OBJECT;
     cache.options.logsEnabled &&
         (0, utilsAndConstants_1.log)('useMutation', {
             options,

package/dist/useQuery.js

@@ -39,7 +39,7 @@ const useQuery = (cache, actions, options) => {
     const queryState = (_c = (0, react_redux_1.useSelector)((state) => {
         const queryState = cacheStateSelector(state).queries[queryKey][cacheKey];
         return queryState; // TODO proper type
-    }, (useQueryStateComparer))) !== null && _c !== void 0 ? _c : utilsAndConstants_1.DEFAULT_QUERY_MUTATION_STATE;
+    }, (useQueryStateComparer))) !== null && _c !== void 0 ? _c : utilsAndConstants_1.EMPTY_OBJECT;
     (0, react_1.useEffect)(() => {
         if (skip) {
             logsEnabled && (0, utilsAndConstants_1.log)('useQuery.useEffect skip fetch', { skip, cacheKey });

package/dist/utilsAndConstants.d.ts

@@ -4,11 +4,9 @@ export declare const optionalUtils: {
     deepEqual?: (a: any, b: any) => boolean;
 };
 export declare const IS_DEV: boolean;
-export declare const DEFAULT_QUERY_MUTATION_STATE: Readonly<{
-    loading: false;
-}>;
 export declare const EMPTY_OBJECT: Readonly<{}>;
 export declare const EMPTY_ARRAY: readonly never[];
 export declare const defaultGetCacheKey: <P = unknown>(params: P) => Key;
 export declare const log: (tag: string, data?: unknown) => void;
 export declare const applyEntityChanges: <T extends Typenames>(entities: EntitiesMap<T>, changes: EntityChanges<T>, options: CacheOptions) => EntitiesMap<T> | undefined;
+export declare const isEmptyObject: (o: object) => boolean;

package/dist/utilsAndConstants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyEntityChanges = exports.log = exports.defaultGetCacheKey = exports.EMPTY_ARRAY = exports.EMPTY_OBJECT = exports.DEFAULT_QUERY_MUTATION_STATE = exports.IS_DEV = exports.optionalUtils = exports.PACKAGE_SHORT_NAME = void 0;
+exports.isEmptyObject = exports.applyEntityChanges = exports.log = exports.defaultGetCacheKey = exports.EMPTY_ARRAY = exports.EMPTY_OBJECT = exports.IS_DEV = exports.optionalUtils = exports.PACKAGE_SHORT_NAME = void 0;
 exports.PACKAGE_SHORT_NAME = 'rrc';
 exports.optionalUtils = {
     deepEqual: undefined,
@@ -20,7 +20,6 @@ exports.IS_DEV = (() => {
         return process.env.NODE_ENV === 'development';
     }
 })();
-exports.DEFAULT_QUERY_MUTATION_STATE = Object.freeze({ loading: false });
 exports.EMPTY_OBJECT = Object.freeze({});
 exports.EMPTY_ARRAY = Object.freeze([]);
 const defaultGetCacheKey = (params) => {
@@ -65,7 +64,7 @@ const applyEntityChanges = (entities, changes, options) => {
             continue;
         }
         // check for key intersection
-        if (options.validateFunctionArguments) {
+        if (options.additionalValidation) {
             const mergeIds = entitiesToMerge && Object.keys(entitiesToMerge);
             const replaceIds = entitiesToReplace && Object.keys(entitiesToReplace);
             const idsSet = new Set(mergeIds);
@@ -124,3 +123,10 @@ const applyEntityChanges = (entities, changes, options) => {
     return result;
 };
 exports.applyEntityChanges = applyEntityChanges;
+const isEmptyObject = (o) => {
+    for (const _ in o) {
+        return false;
+    }
+    return true;
+};
+exports.isEmptyObject = isEmptyObject;

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-redux-cache",
   "author": "Alexander Danilov",
   "license": "MIT",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Powerful data fetching and caching library that supports normalization, built on top of redux",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",