react-redux-cache 0.19.6 → 0.21.0

package/README.md

@@ -23,7 +23,7 @@ Can be considered as `ApolloClient` for protocols other than `GraphQL`, but with
 |Not overengineered|Simplicity is the main goal.|
 |Performance|Every function is heavily optimized, Immer is not used ([RTK [Query] issue](https://github.com/reduxjs/redux-toolkit/issues/4793)).|
 |Reliability|High test coverage, zero issue policy.|
-|Lightweight|`npx minified-size dist/esm/*.js`<br/>minified: 18.2 kB<br/>gzipped: 7.91 kB<br/>brotlied: 7.03 kB|
+|Lightweight|`npx minified-size dist/esm/*.js`<br/>minified: 18.2 kB<br/>gzipped: 7.91 kB<br/>brotlied: 7.03 kB
 
 |Feature|Description|
 |--|--|
@@ -34,6 +34,7 @@ Can be considered as `ApolloClient` for protocols other than `GraphQL`, but with
 |Error handling|No need to use try / catch, errors are returned by fuctions and / or can be handled globally from single place.|
 |Fetch policies|Decide if data is full enough or need to be fetched.|
 |Normalization|Consistent state accross the app - better UX, minimum loading states and lower traffic consumption.|
+|Minimal state|Default values such as `undefined` or default query states are removed from the state tree.|
 
 #### Examples of states, generated by cache reducer from `/example` project:
 <details>
@@ -552,7 +553,7 @@ export const defaultGetCacheKey = <P = unknown>(params: P): Key => {
 }
 ```
 
-It is recommended to override it when default implementation is not optimal or when keys in params object can be sorted in random order.
+It is recommended to override it when default implementation is not optimal or when keys in params object can be sorted in random order. In second case you can also consider using array to pass params.
 
 As example, can be overridden when implementing pagination.
 

package/dist/cjs/createCache.js

@@ -53,8 +53,9 @@ const withTypenames = () => {
       }
       const cache = partialCache
       if (cache.options.deepComparisonEnabled && !utilsAndConstants_1.optionalUtils.deepEqual) {
-        console.warn(
-          'react-redux-cache: optional dependency for fast-deep-equal was not provided, while deepComparisonEnabled option is true'
+        ;(0, utilsAndConstants_1.logWarn)(
+          'createCache',
+          'optional dependency for fast-deep-equal was not provided, while deepComparisonEnabled option is true'
         )
       }
       const setDefaultComparer = (target) => {

package/dist/cjs/createReducer.js

@@ -35,7 +35,7 @@ const createReducer = (actions, queryKeys, cacheOptions) => {
     mutations: Object.freeze({}),
   })
   cacheOptions.logsEnabled &&
-    (0, utilsAndConstants_1.log)('createCacheReducer', {
+    (0, utilsAndConstants_1.logDebug)('createCacheReducer', {
       queryKeys,
       initialState,
     })

package/dist/cjs/index.js

@@ -33,7 +33,8 @@ var __exportStar =
     }
   }
 Object.defineProperty(exports, '__esModule', {value: true})
-exports.isEmptyObject =
+exports.noop =
+  exports.isEmptyObject =
   exports.FetchPolicy =
   exports.defaultGetCacheKey =
   exports.createStateComparer =
@@ -81,3 +82,9 @@ Object.defineProperty(exports, 'isEmptyObject', {
     return utilsAndConstants_1.isEmptyObject
   },
 })
+Object.defineProperty(exports, 'noop', {
+  enumerable: true,
+  get() {
+    return utilsAndConstants_1.noop
+  },
+})

package/dist/cjs/mutate.js

@@ -82,7 +82,7 @@ const mutate = (
       {
         const abortController = abortControllersOfStore[mutationKey]
         cache.options.logsEnabled &&
-          (0, utilsAndConstants_1.log)(logTag, {
+          (0, utilsAndConstants_1.logDebug)(logTag, {
             mutationKey,
             params,
             previousAborted: abortController !== undefined,
@@ -109,7 +109,7 @@ const mutate = (
         error = e
       }
       cache.options.logsEnabled &&
-        (0, utilsAndConstants_1.log)(`${logTag} finished`, {
+        (0, utilsAndConstants_1.logDebug)(`${logTag} finished`, {
           response,
           error,
           aborted: abortController.signal.aborted,

package/dist/cjs/query.js

@@ -75,27 +75,19 @@ const query = (
     const logsEnabled = cache.options.logsEnabled
     const queryStateOnStart = selectQueryState(store.getState(), queryKey, cacheKey)
     if (skipFetch) {
-      return {
-        result: queryStateOnStart.result,
-      }
+      return {result: queryStateOnStart.result}
     }
     if (queryStateOnStart === null || queryStateOnStart === void 0 ? void 0 : queryStateOnStart.loading) {
       logsEnabled &&
-        (0, utilsAndConstants_1.log)(`${logTag} fetch cancelled: already loading`, {
+        (0, utilsAndConstants_1.logDebug)(`${logTag} fetch cancelled: already loading`, {
           queryStateOnStart,
           params,
           cacheKey,
         })
-      const error = yield queryStateOnStart.loading.then(utilsAndConstants_1.NOOP).catch(catchAndReturn)
-      return error
-        ? {
-            cancelled: 'loading',
-            error,
-          }
-        : {
-            cancelled: 'loading',
-            result: selectQueryResult(store.getState(), queryKey, cacheKey),
-          }
+      const error = yield queryStateOnStart.loading.then(utilsAndConstants_1.noop).catch(catchAndReturn)
+      const result = selectQueryResult(store.getState(), queryKey, cacheKey)
+      const cancelled = 'loading'
+      return error ? {cancelled, result, error} : {cancelled, result}
     }
     if (
       onlyIfExpired &&
@@ -104,16 +96,13 @@ const query = (
       queryStateOnStart.expiresAt > Date.now()
     ) {
       logsEnabled &&
-        (0, utilsAndConstants_1.log)(`${logTag} fetch cancelled: not expired yet`, {
+        (0, utilsAndConstants_1.logDebug)(`${logTag} fetch cancelled: not expired yet`, {
           queryStateOnStart,
           params,
           cacheKey,
           onlyIfExpired,
         })
-      return {
-        cancelled: 'not-expired',
-        result: queryStateOnStart.result,
-      }
+      return {cancelled: 'not-expired', result: queryStateOnStart.result}
     }
     const {updateQueryStateAndEntities} = actions
     const fetchPromise = cache.queries[queryKey].query(params, store)
@@ -124,7 +113,7 @@ const query = (
       })
     )
     logsEnabled &&
-      (0, utilsAndConstants_1.log)(`${logTag} started`, {
+      (0, utilsAndConstants_1.logDebug)(`${logTag} started`, {
         queryKey,
         params,
         cacheKey,
@@ -149,7 +138,7 @@ const query = (
       onCompleted === null || onCompleted === void 0
         ? void 0
         : onCompleted(undefined, error, params, store, actions, selectors)
-      return {error}
+      return {error, result: selectQueryResult(store.getState(), queryKey, cacheKey)}
     }
     const newState = {
       error: undefined,
@@ -178,9 +167,7 @@ const query = (
     onCompleted === null || onCompleted === void 0
       ? void 0
       : onCompleted(response, undefined, params, store, actions, selectors)
-    return {
-      result: newState === null || newState === void 0 ? void 0 : newState.result,
-    }
+    return {result: newState === null || newState === void 0 ? void 0 : newState.result}
   })
 exports.query = query
 const catchAndReturn = (x) => x

package/dist/cjs/useMutation.js

@@ -67,11 +67,7 @@ const useMutation = (cache, actions, selectors, options, abortControllers) => {
     (_a = cache.storeHooks.useSelector(mutationStateSelector)) !== null && _a !== void 0
       ? _a
       : utilsAndConstants_1.EMPTY_OBJECT
-  cache.options.logsEnabled &&
-    (0, utilsAndConstants_1.log)('useMutation', {
-      options,
-      mutationState,
-    })
+  cache.options.logsEnabled && (0, utilsAndConstants_1.logDebug)('useMutation', {options, mutationState})
   return [mutate, mutationState, abort]
 }
 exports.useMutation = useMutation

package/dist/cjs/useQuery.js

@@ -88,13 +88,13 @@ const useQuery = (cache, actions, selectors, options) => {
   ;(0, react_1.useEffect)(() => {
     if (skipFetch) {
       logsEnabled &&
-        (0, utilsAndConstants_1.log)('useQuery.useEffect skip fetch', {skipFetch, queryKey, cacheKey})
+        (0, utilsAndConstants_1.logDebug)('useQuery.useEffect skip fetch', {skipFetch, queryKey, cacheKey})
       return
     }
     const expired = queryState.expiresAt != null && queryState.expiresAt <= Date.now()
     if (!fetchPolicy(expired, params, queryState, store, selectors)) {
       logsEnabled &&
-        (0, utilsAndConstants_1.log)('useQuery.useEffect skip fetch due to fetch policy', {
+        (0, utilsAndConstants_1.logDebug)('useQuery.useEffect skip fetch due to fetch policy', {
           queryState,
           expired,
           queryKey,
@@ -104,12 +104,7 @@ const useQuery = (cache, actions, selectors, options) => {
     }
     performFetch()
   }, [cacheKey, skipFetch])
-  logsEnabled &&
-    (0, utilsAndConstants_1.log)('useQuery', {
-      cacheKey,
-      options,
-      queryState,
-    })
+  logsEnabled && (0, utilsAndConstants_1.logDebug)('useQuery', {cacheKey, options, queryState})
   return [queryState, performFetch]
 }
 exports.useQuery = useQuery

package/dist/cjs/utilsAndConstants.js

@@ -4,12 +4,13 @@ exports.FetchPolicy =
   exports.createStateComparer =
   exports.isEmptyObject =
   exports.applyEntityChanges =
-  exports.log =
   exports.defaultGetCacheKey =
-  exports.NOOP =
+  exports.noop =
   exports.EMPTY_ARRAY =
   exports.EMPTY_OBJECT =
   exports.IS_DEV =
+  exports.logWarn =
+  exports.logDebug =
   exports.optionalUtils =
   exports.PACKAGE_SHORT_NAME =
     void 0
@@ -17,10 +18,18 @@ exports.PACKAGE_SHORT_NAME = 'rrc'
 exports.optionalUtils = {
   deepEqual: undefined,
 }
+const logDebug = (tag, data) => {
+  console.debug(`@${exports.PACKAGE_SHORT_NAME} [${tag}]`, data)
+}
+exports.logDebug = logDebug
+const logWarn = (tag, data) => {
+  console.warn(`@${exports.PACKAGE_SHORT_NAME} [${tag}]`, data)
+}
+exports.logWarn = logWarn
 try {
   exports.optionalUtils.deepEqual = require('fast-deep-equal/es6')
 } catch (_a) {
-  console.debug(exports.PACKAGE_SHORT_NAME + ': fast-deep-equal optional dependency was not installed')
+  ;(0, exports.logDebug)('deepEqual', 'fast-deep-equal optional dependency was not installed')
 }
 exports.IS_DEV = (() => {
   try {
@@ -31,8 +40,8 @@ exports.IS_DEV = (() => {
 })()
 exports.EMPTY_OBJECT = Object.freeze({})
 exports.EMPTY_ARRAY = Object.freeze([])
-const NOOP = () => {}
-exports.NOOP = NOOP
+const noop = () => {}
+exports.noop = noop
 const defaultGetCacheKey = (params) => {
   switch (typeof params) {
     case 'string':
@@ -45,14 +54,10 @@ const defaultGetCacheKey = (params) => {
   }
 }
 exports.defaultGetCacheKey = defaultGetCacheKey
-const log = (tag, data) => {
-  console.debug(`@${exports.PACKAGE_SHORT_NAME} [${tag}]`, data)
-}
-exports.log = log
 const applyEntityChanges = (entities, changes, options) => {
   var _a, _b, _c, _d
   if (changes.merge && changes.entities) {
-    console.warn('react-redux-cache.applyEntityChanges: merge and entities should not be both set')
+    ;(0, exports.logWarn)('applyEntityChanges', 'merge and entities should not be both set')
   }
   const {merge = changes.entities, replace, remove} = changes
   if (!merge && !replace && !remove) {
@@ -60,13 +65,11 @@ const applyEntityChanges = (entities, changes, options) => {
   }
   const deepEqual = options.deepComparisonEnabled ? exports.optionalUtils.deepEqual : undefined
   let result
-  const typenames = new Set([
-    ...(changes.entities ? Object.keys(changes.entities) : exports.EMPTY_ARRAY),
-    ...(changes.merge ? Object.keys(changes.merge) : exports.EMPTY_ARRAY),
-    ...(changes.remove ? Object.keys(changes.remove) : exports.EMPTY_ARRAY),
-    ...(changes.replace ? Object.keys(changes.replace) : exports.EMPTY_ARRAY),
-  ])
-  for (const typename of typenames) {
+  const objectWithAllTypenames = Object.assign(
+    Object.assign(Object.assign({}, changes.merge), changes.remove),
+    changes.replace
+  )
+  for (const typename in objectWithAllTypenames) {
     const entitiesToMerge = merge === null || merge === void 0 ? void 0 : merge[typename]
     const entitiesToReplace = replace === null || replace === void 0 ? void 0 : replace[typename]
     const entitiesToRemove = remove === null || remove === void 0 ? void 0 : remove[typename]
@@ -99,9 +102,9 @@ const applyEntityChanges = (entities, changes, options) => {
           ? _c
           : 0)
       if (totalKeysInResponse !== 0 && idsSet.size !== totalKeysInResponse) {
-        console.warn(
-          'react-redux-cache.applyEntityChanges: merge, replace and remove changes have intersections for: ' +
-            typename
+        ;(0, exports.logWarn)(
+          'applyEntityChanges',
+          'merge, replace and remove changes have intersections for: ' + typename
         )
       }
     }
@@ -147,7 +150,7 @@ const applyEntityChanges = (entities, changes, options) => {
     result[typename] = newEntities
   }
   options.logsEnabled &&
-    (0, exports.log)('applyEntityChanges', {
+    (0, exports.logDebug)('applyEntityChanges', {
       entities,
       changes,
       options,

package/dist/esm/createCache.js

@@ -14,6 +14,7 @@ import {
   EMPTY_OBJECT,
   FetchPolicy,
   IS_DEV,
+  logWarn,
   optionalUtils,
 } from './utilsAndConstants'
 
@@ -59,8 +60,9 @@ export const withTypenames = () => {
       }
       const cache = partialCache
       if (cache.options.deepComparisonEnabled && !optionalUtils.deepEqual) {
-        console.warn(
-          'react-redux-cache: optional dependency for fast-deep-equal was not provided, while deepComparisonEnabled option is true'
+        logWarn(
+          'createCache',
+          'optional dependency for fast-deep-equal was not provided, while deepComparisonEnabled option is true'
         )
       }
       const setDefaultComparer = (target) => {

package/dist/esm/createReducer.js

@@ -16,7 +16,7 @@ var __rest =
     }
     return t
   }
-import {applyEntityChanges, EMPTY_OBJECT, isEmptyObject, log, optionalUtils} from './utilsAndConstants'
+import {applyEntityChanges, EMPTY_OBJECT, isEmptyObject, logDebug, optionalUtils} from './utilsAndConstants'
 
 const optionalQueryKeys = ['error', 'expiresAt', 'result', 'params', 'loading']
 const optionalMutationKeys = ['error', 'result', 'params', 'loading']
@@ -33,7 +33,7 @@ export const createReducer = (actions, queryKeys, cacheOptions) => {
     mutations: Object.freeze({}),
   })
   cacheOptions.logsEnabled &&
-    log('createCacheReducer', {
+    logDebug('createCacheReducer', {
       queryKeys,
       initialState,
     })

package/dist/esm/index.js

@@ -2,4 +2,4 @@ export {createCache, withTypenames} from './createCache'
 
 export * from './types'
 
-export {createStateComparer, defaultGetCacheKey, FetchPolicy, isEmptyObject} from './utilsAndConstants'
+export {createStateComparer, defaultGetCacheKey, FetchPolicy, isEmptyObject, noop} from './utilsAndConstants'

package/dist/esm/mutate.js

@@ -29,7 +29,7 @@ var __awaiter =
       step((generator = generator.apply(thisArg, _arguments || [])).next())
     })
   }
-import {log} from './utilsAndConstants'
+import {logDebug} from './utilsAndConstants'
 
 export const mutate = (
   logTag_1,
@@ -79,11 +79,7 @@ export const mutate = (
       {
         const abortController = abortControllersOfStore[mutationKey]
         cache.options.logsEnabled &&
-          log(logTag, {
-            mutationKey,
-            params,
-            previousAborted: abortController !== undefined,
-          })
+          logDebug(logTag, {mutationKey, params, previousAborted: abortController !== undefined})
         if (abortController !== undefined) {
           abortController.abort()
         }
@@ -106,11 +102,7 @@ export const mutate = (
         error = e
       }
       cache.options.logsEnabled &&
-        log(`${logTag} finished`, {
-          response,
-          error,
-          aborted: abortController.signal.aborted,
-        })
+        logDebug(`${logTag} finished`, {response, error, aborted: abortController.signal.aborted})
       if (abortController.signal.aborted) {
         return ABORTED_RESULT
       }

package/dist/esm/query.js

@@ -29,7 +29,7 @@ var __awaiter =
       step((generator = generator.apply(thisArg, _arguments || [])).next())
     })
   }
-import {log, NOOP} from './utilsAndConstants'
+import {logDebug, noop} from './utilsAndConstants'
 
 export const query = (
   logTag,
@@ -72,27 +72,15 @@ export const query = (
     const logsEnabled = cache.options.logsEnabled
     const queryStateOnStart = selectQueryState(store.getState(), queryKey, cacheKey)
     if (skipFetch) {
-      return {
-        result: queryStateOnStart.result,
-      }
+      return {result: queryStateOnStart.result}
     }
     if (queryStateOnStart === null || queryStateOnStart === void 0 ? void 0 : queryStateOnStart.loading) {
       logsEnabled &&
-        log(`${logTag} fetch cancelled: already loading`, {
-          queryStateOnStart,
-          params,
-          cacheKey,
-        })
-      const error = yield queryStateOnStart.loading.then(NOOP).catch(catchAndReturn)
-      return error
-        ? {
-            cancelled: 'loading',
-            error,
-          }
-        : {
-            cancelled: 'loading',
-            result: selectQueryResult(store.getState(), queryKey, cacheKey),
-          }
+        logDebug(`${logTag} fetch cancelled: already loading`, {queryStateOnStart, params, cacheKey})
+      const error = yield queryStateOnStart.loading.then(noop).catch(catchAndReturn)
+      const result = selectQueryResult(store.getState(), queryKey, cacheKey)
+      const cancelled = 'loading'
+      return error ? {cancelled, result, error} : {cancelled, result}
     }
     if (
       onlyIfExpired &&
@@ -101,16 +89,13 @@ export const query = (
       queryStateOnStart.expiresAt > Date.now()
     ) {
       logsEnabled &&
-        log(`${logTag} fetch cancelled: not expired yet`, {
+        logDebug(`${logTag} fetch cancelled: not expired yet`, {
           queryStateOnStart,
           params,
           cacheKey,
           onlyIfExpired,
         })
-      return {
-        cancelled: 'not-expired',
-        result: queryStateOnStart.result,
-      }
+      return {cancelled: 'not-expired', result: queryStateOnStart.result}
     }
     const {updateQueryStateAndEntities} = actions
     const fetchPromise = cache.queries[queryKey].query(params, store)
@@ -120,7 +105,8 @@ export const query = (
         params,
       })
     )
-    logsEnabled && log(`${logTag} started`, {queryKey, params, cacheKey, queryStateOnStart, onlyIfExpired})
+    logsEnabled &&
+      logDebug(`${logTag} started`, {queryKey, params, cacheKey, queryStateOnStart, onlyIfExpired})
     let response
     try {
       response = yield fetchPromise
@@ -139,7 +125,7 @@ export const query = (
       onCompleted === null || onCompleted === void 0
         ? void 0
         : onCompleted(undefined, error, params, store, actions, selectors)
-      return {error}
+      return {error, result: selectQueryResult(store.getState(), queryKey, cacheKey)}
     }
     const newState = {
       error: undefined,
@@ -168,9 +154,7 @@ export const query = (
     onCompleted === null || onCompleted === void 0
       ? void 0
       : onCompleted(response, undefined, params, store, actions, selectors)
-    return {
-      result: newState === null || newState === void 0 ? void 0 : newState.result,
-    }
+    return {result: newState === null || newState === void 0 ? void 0 : newState.result}
   })
 
 const catchAndReturn = (x) => x

package/dist/esm/useMutation.js

@@ -32,7 +32,7 @@ var __awaiter =
 import {useMemo} from 'react'
 
 import {mutate as mutateImpl} from './mutate'
-import {EMPTY_OBJECT, log} from './utilsAndConstants'
+import {EMPTY_OBJECT, logDebug} from './utilsAndConstants'
 
 export const useMutation = (cache, actions, selectors, options, abortControllers) => {
   var _a
@@ -74,10 +74,6 @@ export const useMutation = (cache, actions, selectors, options, abortControllers
   }, [mutationKey, store])
   const mutationState =
     (_a = cache.storeHooks.useSelector(mutationStateSelector)) !== null && _a !== void 0 ? _a : EMPTY_OBJECT
-  cache.options.logsEnabled &&
-    log('useMutation', {
-      options,
-      mutationState,
-    })
+  cache.options.logsEnabled && logDebug('useMutation', {options, mutationState})
   return [mutate, mutationState, abort]
 }

package/dist/esm/useQuery.js

@@ -32,7 +32,7 @@ var __awaiter =
 import {useCallback, useEffect} from 'react'
 
 import {query as queryImpl} from './query'
-import {createStateComparer, defaultGetCacheKey, EMPTY_OBJECT, log} from './utilsAndConstants'
+import {createStateComparer, defaultGetCacheKey, EMPTY_OBJECT, logDebug} from './utilsAndConstants'
 
 export const useQuery = (cache, actions, selectors, options) => {
   var _a, _b, _c, _d, _e
@@ -99,13 +99,13 @@ export const useQuery = (cache, actions, selectors, options) => {
       : EMPTY_OBJECT
   useEffect(() => {
     if (skipFetch) {
-      logsEnabled && log('useQuery.useEffect skip fetch', {skipFetch, queryKey, cacheKey})
+      logsEnabled && logDebug('useQuery.useEffect skip fetch', {skipFetch, queryKey, cacheKey})
       return
     }
     const expired = queryState.expiresAt != null && queryState.expiresAt <= Date.now()
     if (!fetchPolicy(expired, params, queryState, store, selectors)) {
       logsEnabled &&
-        log('useQuery.useEffect skip fetch due to fetch policy', {
+        logDebug('useQuery.useEffect skip fetch due to fetch policy', {
           queryState,
           expired,
           queryKey,
@@ -115,12 +115,7 @@ export const useQuery = (cache, actions, selectors, options) => {
     }
     performFetch()
   }, [cacheKey, skipFetch])
-  logsEnabled &&
-    log('useQuery', {
-      cacheKey,
-      options,
-      queryState,
-    })
+  logsEnabled && logDebug('useQuery', {cacheKey, options, queryState})
   return [queryState, performFetch]
 }
 

package/dist/esm/utilsAndConstants.js

@@ -4,10 +4,18 @@ export const optionalUtils = {
   deepEqual: undefined,
 }
 
+export const logDebug = (tag, data) => {
+  console.debug(`@${PACKAGE_SHORT_NAME} [${tag}]`, data)
+}
+
+export const logWarn = (tag, data) => {
+  console.warn(`@${PACKAGE_SHORT_NAME} [${tag}]`, data)
+}
+
 try {
   optionalUtils.deepEqual = require('fast-deep-equal/es6')
 } catch (_a) {
-  console.debug(PACKAGE_SHORT_NAME + ': fast-deep-equal optional dependency was not installed')
+  logDebug('deepEqual', 'fast-deep-equal optional dependency was not installed')
 }
 
 export const IS_DEV = (() => {
@@ -22,7 +30,7 @@ export const EMPTY_OBJECT = Object.freeze({})
 
 export const EMPTY_ARRAY = Object.freeze([])
 
-export const NOOP = () => {}
+export const noop = () => {}
 
 export const defaultGetCacheKey = (params) => {
   switch (typeof params) {
@@ -36,14 +44,10 @@ export const defaultGetCacheKey = (params) => {
   }
 }
 
-export const log = (tag, data) => {
-  console.debug(`@${PACKAGE_SHORT_NAME} [${tag}]`, data)
-}
-
 export const applyEntityChanges = (entities, changes, options) => {
   var _a, _b, _c, _d
   if (changes.merge && changes.entities) {
-    console.warn('react-redux-cache.applyEntityChanges: merge and entities should not be both set')
+    logWarn('applyEntityChanges', 'merge and entities should not be both set')
   }
   const {merge = changes.entities, replace, remove} = changes
   if (!merge && !replace && !remove) {
@@ -51,13 +55,11 @@ export const applyEntityChanges = (entities, changes, options) => {
   }
   const deepEqual = options.deepComparisonEnabled ? optionalUtils.deepEqual : undefined
   let result
-  const typenames = new Set([
-    ...(changes.entities ? Object.keys(changes.entities) : EMPTY_ARRAY),
-    ...(changes.merge ? Object.keys(changes.merge) : EMPTY_ARRAY),
-    ...(changes.remove ? Object.keys(changes.remove) : EMPTY_ARRAY),
-    ...(changes.replace ? Object.keys(changes.replace) : EMPTY_ARRAY),
-  ])
-  for (const typename of typenames) {
+  const objectWithAllTypenames = Object.assign(
+    Object.assign(Object.assign({}, changes.merge), changes.remove),
+    changes.replace
+  )
+  for (const typename in objectWithAllTypenames) {
     const entitiesToMerge = merge === null || merge === void 0 ? void 0 : merge[typename]
     const entitiesToReplace = replace === null || replace === void 0 ? void 0 : replace[typename]
     const entitiesToRemove = remove === null || remove === void 0 ? void 0 : remove[typename]
@@ -90,10 +92,7 @@ export const applyEntityChanges = (entities, changes, options) => {
           ? _c
           : 0)
       if (totalKeysInResponse !== 0 && idsSet.size !== totalKeysInResponse) {
-        console.warn(
-          'react-redux-cache.applyEntityChanges: merge, replace and remove changes have intersections for: ' +
-            typename
-        )
+        logWarn('applyEntityChanges', 'merge, replace and remove changes have intersections for: ' + typename)
       }
     }
     const oldEntities = (_d = entities[typename]) !== null && _d !== void 0 ? _d : EMPTY_OBJECT
@@ -138,7 +137,7 @@ export const applyEntityChanges = (entities, changes, options) => {
     result[typename] = newEntities
   }
   options.logsEnabled &&
-    log('applyEntityChanges', {
+    logDebug('applyEntityChanges', {
       entities,
       changes,
       options,

package/dist/types/createCache.d.ts

@@ -32,7 +32,7 @@ import {applyEntityChanges} from './utilsAndConstants'
  * `const cache = withTypenames<MyTypenames>().createCache({...})`
  */
 export declare const withTypenames: <T extends Typenames = Typenames>() => {
-  /** Creates reducer, actions and hooks for managing queries and mutations through redux cache. */
+  /** Creates reducer, actions and hooks for managing queries and mutations. */
   createCache: <N extends string, QP, QR, MP, MR>(
     partialCache: OptionalPartial<
       Omit<Cache<N, T, QP, QR, MP, MR>, 'globals'>,
@@ -43,7 +43,7 @@ export declare const withTypenames: <T extends Typenames = Typenames>() => {
   ) => {
     /** Keeps all options, passed while creating the cache. */
     cache: Cache<N, T, QP, QR, MP, MR>
-    /** Reducer of the cache, should be added to redux store. */
+    /** Reducer of the cache, should be added to redux/zustand store. */
     reducer: (
       state: CacheState<T, QP, QR, MP, MR> | undefined,
       action:
@@ -170,7 +170,7 @@ export declare const withTypenames: <T extends Typenames = Typenames>() => {
         }
         type: `@rrc/${N}/clearMutationState`
       }
-      /** Replaces cache state with initial, optionally merging with provided state. Doesn't cancel running fetches and shoult be used with caution. */
+      /** Replaces cache state with initial, optionally merging with provided state. Doesn't cancel running fetches and should be used with caution. */
       clearCache: {
         (stateToKeep?: Partial<CacheState<T, QP, QR, MP, MR>> | undefined): {
           type: `@rrc/${N}/clearCache`
@@ -262,9 +262,17 @@ export declare const withTypenames: <T extends Typenames = Typenames>() => {
     hooks: {
       /** Returns memoized object with query and mutate functions. Memoization dependency is the store. */
       useClient: () => {
+        /**
+         * Performs a query using provided options. Deduplicates calls with the same cache key. Always returns current cached result, even when query is cancelled or finished with error.
+         * @param onlyIfExpired When true, cancels fetch if result is not yet expired.
+         * @param skipFetch Fetch is cancelled and current cached result is returned.
+         */
         query: <QK extends keyof (QP & QR)>(
           options: QueryOptions<N, T, QP, QR, QK, MP, MR>
         ) => Promise<QueryResult<QK extends keyof QP & keyof QR ? QR[QK] : never>>
+        /**
+         * Performs a mutation, aborting previous one with the same mutation key. Returns result only if finished succesfully.
+         */
         mutate: <MK extends keyof (MP & MR)>(
           options: MutateOptions<N, T, QP, QR, MP, MR, MK>
         ) => Promise<MutationResult<MK extends keyof MP & keyof MR ? MR[MK] : never>>
@@ -325,19 +333,31 @@ export declare const withTypenames: <T extends Typenames = Typenames>() => {
       useSelectEntityById: <TN extends keyof T>(id: Key | null | undefined, typename: TN) => T[TN] | undefined
     }
     utils: {
-      /** Creates client by providing the store. Can be used when the store is a singleton - to not use a hook for getting the client, but import it directly. */
+      /** Creates client by providing the store. Can be used when the store is a singleton - to not use a useClient hook for getting the client, but import it directly. */
       createClient: (store: Store) => {
+        /**
+         * Performs a query using provided options. Deduplicates calls with the same cache key. Always returns current cached result, even when query is cancelled or finished with error.
+         * @param onlyIfExpired When true, cancels fetch if result is not yet expired.
+         * @param skipFetch Fetch is cancelled and current cached result is returned.
+         */
         query: <QK extends keyof (QP & QR)>(
           options: QueryOptions<N, T, QP, QR, QK, MP, MR>
         ) => Promise<QueryResult<QK extends keyof QP & keyof QR ? QR[QK] : never>>
+        /**
+         * Performs a mutation, aborting previous one with the same mutation key. Returns result only if finished succesfully.
+         */
         mutate: <MK extends keyof (MP & MR)>(
           options: MutateOptions<N, T, QP, QR, MP, MR, MK>
         ) => Promise<MutationResult<MK extends keyof MP & keyof MR ? MR[MK] : never>>
       }
       /** Generates the initial state by calling a reducer. Not needed for redux — it already generates it the same way when creating the store. */
       getInitialState: () => CacheState<T, QP, QR, MP, MR>
-      /** Apply changes to the entities map.
-       * @returns `undefined` if nothing to change, otherwise new `EntitiesMap<T>` with applied changes. */
+      /**
+       * Apply changes to the entities map.
+       * Returns `undefined` if nothing to change, otherwise new `EntitiesMap<T>` with applied changes.
+       * Uses deep comparison if `deepComparisonEnabled` option is `true`.
+       * Performs additional checks for intersections if `additionalValidation` option is `true`, and prints warnings if finds any issues.
+       */
       applyEntityChanges: (
         entities: Parameters<typeof applyEntityChanges<T>>[0],
         changes: Parameters<typeof applyEntityChanges<T>>[1]
@@ -346,9 +366,7 @@ export declare const withTypenames: <T extends Typenames = Typenames>() => {
   }
 }
 
-/**
- * Creates reducer, actions and hooks for managing queries and mutations through redux cache.
- */
+/** Creates reducer, actions and hooks for managing queries and mutations. */
 export declare const createCache: <N extends string, QP, QR, MP, MR>(
   partialCache: Partial<{
     queries: Partial<{
@@ -377,7 +395,7 @@ export declare const createCache: <N extends string, QP, QR, MP, MR>(
 ) => {
   /** Keeps all options, passed while creating the cache. */
   cache: Cache<N, Typenames, QP, QR, MP, MR>
-  /** Reducer of the cache, should be added to redux store. */
+  /** Reducer of the cache, should be added to redux/zustand store. */
   reducer: (
     state: CacheState<Typenames, QP, QR, MP, MR> | undefined,
     action:
@@ -506,7 +524,7 @@ export declare const createCache: <N extends string, QP, QR, MP, MR>(
       }
       type: `@rrc/${N}/clearMutationState`
     }
-    /** Replaces cache state with initial, optionally merging with provided state. Doesn't cancel running fetches and shoult be used with caution. */
+    /** Replaces cache state with initial, optionally merging with provided state. Doesn't cancel running fetches and should be used with caution. */
     clearCache: {
       (stateToKeep?: Partial<CacheState<Typenames, QP, QR, MP, MR>> | undefined): {
         type: `@rrc/${N}/clearCache`
@@ -605,9 +623,17 @@ export declare const createCache: <N extends string, QP, QR, MP, MR>(
   hooks: {
     /** Returns memoized object with query and mutate functions. Memoization dependency is the store. */
     useClient: () => {
+      /**
+       * Performs a query using provided options. Deduplicates calls with the same cache key. Always returns current cached result, even when query is cancelled or finished with error.
+       * @param onlyIfExpired When true, cancels fetch if result is not yet expired.
+       * @param skipFetch Fetch is cancelled and current cached result is returned.
+       */
       query: <QK_1 extends keyof QP | keyof QR>(
         options: QueryOptions<N, Typenames, QP, QR, QK_1, MP, MR>
       ) => Promise<QueryResult<QK_1 extends keyof QP & keyof QR ? QR[QK_1] : never>>
+      /**
+       * Performs a mutation, aborting previous one with the same mutation key. Returns result only if finished succesfully.
+       */
       mutate: <MK_1 extends keyof MP | keyof MR>(
         options: MutateOptions<N, Typenames, QP, QR, MP, MR, MK_1>
       ) => Promise<MutationResult<MK_1 extends keyof MP & keyof MR ? MR[MK_1] : never>>
@@ -668,19 +694,31 @@ export declare const createCache: <N extends string, QP, QR, MP, MR>(
     useSelectEntityById: <TN extends string>(id: Key | null | undefined, typename: TN) => object | undefined
   }
   utils: {
-    /** Creates client by providing the store. Can be used when the store is a singleton - to not use a hook for getting the client, but import it directly. */
+    /** Creates client by providing the store. Can be used when the store is a singleton - to not use a useClient hook for getting the client, but import it directly. */
     createClient: (store: Store) => {
+      /**
+       * Performs a query using provided options. Deduplicates calls with the same cache key. Always returns current cached result, even when query is cancelled or finished with error.
+       * @param onlyIfExpired When true, cancels fetch if result is not yet expired.
+       * @param skipFetch Fetch is cancelled and current cached result is returned.
+       */
       query: <QK_1 extends keyof QP | keyof QR>(
         options: QueryOptions<N, Typenames, QP, QR, QK_1, MP, MR>
       ) => Promise<QueryResult<QK_1 extends keyof QP & keyof QR ? QR[QK_1] : never>>
+      /**
+       * Performs a mutation, aborting previous one with the same mutation key. Returns result only if finished succesfully.
+       */
       mutate: <MK_1 extends keyof MP | keyof MR>(
         options: MutateOptions<N, Typenames, QP, QR, MP, MR, MK_1>
       ) => Promise<MutationResult<MK_1 extends keyof MP & keyof MR ? MR[MK_1] : never>>
     }
     /** Generates the initial state by calling a reducer. Not needed for redux — it already generates it the same way when creating the store. */
     getInitialState: () => CacheState<Typenames, QP, QR, MP, MR>
-    /** Apply changes to the entities map.
-     * @returns `undefined` if nothing to change, otherwise new `EntitiesMap<T>` with applied changes. */
+    /**
+     * Apply changes to the entities map.
+     * Returns `undefined` if nothing to change, otherwise new `EntitiesMap<T>` with applied changes.
+     * Uses deep comparison if `deepComparisonEnabled` option is `true`.
+     * Performs additional checks for intersections if `additionalValidation` option is `true`, and prints warnings if finds any issues.
+     */
     applyEntityChanges: (
       entities: EntitiesMap<Typenames>,
       changes: EntityChanges<Typenames>

package/dist/types/index.d.ts

@@ -2,4 +2,4 @@ export {createCache, withTypenames} from './createCache'
 
 export * from './types'
 
-export {createStateComparer, defaultGetCacheKey, FetchPolicy, isEmptyObject} from './utilsAndConstants'
+export {createStateComparer, defaultGetCacheKey, FetchPolicy, isEmptyObject, noop} from './utilsAndConstants'

package/dist/types/types.d.ts

@@ -95,7 +95,7 @@ export type Globals<N extends string, T extends Typenames, QP, QR, MP, MR> = {
 }
 
 export type CacheOptions = {
-  /** Enables additional validation with logging to console.warn. Recommened to enable in dev/testing mode. @Default true in dev mode. */
+  /** Enables additional validation with logging to console.warn. Recommended to enable in dev/testing mode. @Default true in dev mode. */
   additionalValidation: boolean
   /** Enables debug logs. @Default false */
   logsEnabled: boolean
@@ -165,7 +165,7 @@ export type QueryInfo<
    * Default implementation uses `String()` or `JSON.stringify` depending on type.
    * It is recommended to override it when default implementation is not optimal or when keys in params object can be sorted in random order etc.
    */
-  getCacheKey?: (params?: P) => Key
+  getCacheKey?: (params: P) => Key
   /** Called after fetch completed either successfully or not. */
   onCompleted?: (
     response: NormalizedQueryResponse<T, R> | undefined,
@@ -272,16 +272,21 @@ export type QueryOptions<
 
 export type QueryResponse<R = unknown> = {
   result: R
-  /** If defined, overrides this value for query state, ignoring `secondsToLive`. */
+  /** If defined, overrides this value in the query state, ignoring `secondsToLive` option. */
   expiresAt?: number
 }
 
 export type NormalizedQueryResponse<T extends Typenames = Typenames, R = unknown> = EntityChanges<T> &
   QueryResponse<R>
 
+/** Result is always returned, even if cancelled or finished with error. */
 export type QueryResult<R = unknown> = {
   error?: unknown
-  /** Fetch cancelled reason. */
+  /**
+   * Fetch cancelled reason.
+   * @value loading - already loading. Result of current fetch is returned.
+   * @value not-expired - not expired yet. Current state result is returned.
+   */
   cancelled?: 'loading' | 'not-expired'
   result?: R
 }

package/dist/types/utilsAndConstants.d.ts

@@ -14,19 +14,22 @@ export declare const optionalUtils: {
   deepEqual?: (a: any, b: any) => boolean
 }
 
+export declare const logDebug: (tag: string, data?: unknown) => void
+
+export declare const logWarn: (tag: string, data?: unknown) => void
+
 export declare const IS_DEV: boolean
 
 export declare const EMPTY_OBJECT: Readonly<{}>
 
 export declare const EMPTY_ARRAY: readonly never[]
 
-export declare const NOOP: () => void
+/** Empty function. */
+export declare const noop: () => void
 
 /** Default getCacheKey implementation. */
 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>,
@@ -42,7 +45,10 @@ export declare const createStateComparer: <T extends Typenames = Typenames, Q =
 ) => QueryStateComparer<T, Q, P>
 
 export declare const FetchPolicy: {
-  /** Only if cache does not exist (result is undefined) or expired. @Default */
+  /**
+   * Only if cache does not exist (result is undefined) or expired. Default.
+   * @param expired `true` when `expiresAt` is defined and lower than `Date.now()`
+   */
   NoCacheOrExpired: <T extends Typenames = Typenames, P = unknown, R = unknown>(
     expired: boolean,
     _params: P,

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-redux-cache",
   "author": "Alexander Danilov",
   "license": "MIT",
-  "version": "0.19.6",
+  "version": "0.21.0",
   "description": "Powerful data fetching and caching library for Redux and Zustand that supports normalization.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",