react-redux-cache 0.20.0 → 0.21.0

package/README.md

@@ -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/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`
@@ -352,8 +352,12 @@ export declare const withTypenames: <T extends Typenames = Typenames>() => {
       }
       /** 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]
@@ -362,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<{
@@ -393,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:
@@ -522,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`
@@ -711,8 +713,12 @@ export declare const createCache: <N extends string, QP, QR, MP, MR>(
     }
     /** 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/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,17 +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>
 
-/** Current result is always returned, even if cancelled or finished with error. */
+/** 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

@@ -45,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.20.0",
+  "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",