react-redux-cache 0.19.5 → 0.20.0

package/dist/types/types.d.ts

@@ -2,11 +2,14 @@ import type {Actions} from './createActions'
 import type {Selectors} from './createSelectors'
 
 export type Key = string | number | symbol
+
 export type Dict<T> = Record<Key, T>
+
 export type OptionalPartial<T, K extends keyof T> = Partial<{
   [A in K]: Partial<T[A]>
 }> &
   Omit<T, K>
+
 /** Entity changes to be merged to the state. */
 export type EntityChanges<T extends Typenames> = {
   /** Entities that will be merged with existing. */
@@ -18,12 +21,15 @@ export type EntityChanges<T extends Typenames> = {
   /** Alias for `merge` to support normalizr. */
   entities?: EntityChanges<T>['merge']
 }
+
 export type Store<S = unknown> = {
   dispatch: (action: ReturnType<Actions[keyof Actions]>) => unknown
   getState: () => S
 }
+
 /** Record of typename and its corresponding entity type */
 export type Typenames = Record<string, object>
+
 export type Cache<N extends string, T extends Typenames, QP, QR, MP, MR> = {
   /** Used as prefix for actions and in default cacheStateSelector for selecting cache state from store root state. */
   name: N
@@ -51,10 +57,12 @@ export type Cache<N extends string, T extends Typenames, QP, QR, MP, MR> = {
       : never
   }
 }
+
 export type QueryStateComparer<T extends Typenames, P, R> = (
   x: QueryState<T, P, R> | undefined,
   y: QueryState<T, P, R> | undefined
 ) => boolean
+
 export type Globals<N extends string, T extends Typenames, QP, QR, MP, MR> = {
   /** Handles errors, not handled by onError from queries and mutations. @Default undefined. */
   onError?: (
@@ -85,6 +93,7 @@ export type Globals<N extends string, T extends Typenames, QP, QR, MP, MR> = {
     selectorComparer?: QueryStateComparer<T, unknown, unknown> | (keyof QueryState<T, unknown, unknown>)[]
   }
 }
+
 export type CacheOptions = {
   /** Enables additional validation with logging to console.warn. Recommened to enable in dev/testing mode. @Default true in dev mode. */
   additionalValidation: boolean
@@ -98,15 +107,19 @@ export type CacheOptions = {
    */
   deepComparisonEnabled: boolean
 }
+
 export type PartialEntitiesMap<T extends Typenames> = {
   [K in keyof T]?: Dict<Partial<T[K]>>
 }
+
 export type EntitiesMap<T extends Typenames> = {
   [K in keyof T]?: Dict<T[K]>
 }
+
 export type EntityIds<T extends Typenames> = {
   [K in keyof T]?: Key[]
 }
+
 export type CacheState<T extends Typenames, QP, QR, MP, MR> = {
   entities: EntitiesMap<T>
   queries: {
@@ -116,6 +129,7 @@ export type CacheState<T extends Typenames, QP, QR, MP, MR> = {
     [MK in keyof (MP | MR)]: MutationState<T, MP[MK], MR[MK]>
   }
 }
+
 export type QueryInfo<
   N extends string,
   T extends Typenames = Typenames,
@@ -180,15 +194,18 @@ export type QueryInfo<
   /** Either comparer function, or array of keys to subscribe by useQuery's useSelector. Default compares params, result, loading, error. */
   selectorComparer?: QueryStateComparer<T, P, R> | (keyof QueryState<T, P, R>)[]
 }
+
 export type Query<P = unknown, R = unknown> = (
   /** Query parameters */
   params: P,
   /** Store */
   store: Store
 ) => Promise<QueryResponse<R>>
+
 export type NormalizedQuery<T extends Typenames = Typenames, P = unknown, R = unknown> = (
   ...args: Parameters<Query<P, R>>
 ) => Promise<NormalizedQueryResponse<T, R>>
+
 export type QueryState<T extends Typenames, P, R> = MutationState<T, P, R> & {
   /**
    * Timestamp in milliseconds, after which state is considered expired.
@@ -197,6 +214,7 @@ export type QueryState<T extends Typenames, P, R> = MutationState<T, P, R> & {
    * */
   expiresAt?: number
 }
+
 export type UseQueryOptions<
   N extends string,
   T extends Typenames,
@@ -228,6 +246,7 @@ export type UseQueryOptions<
   | 'onSuccess'
   | 'onError'
 >
+
 export type QueryOptions<
   N extends string,
   T extends Typenames,
@@ -250,19 +269,24 @@ export type QueryOptions<
   /** If set to true, query will run only if it is expired or result not yet cached. */
   onlyIfExpired?: boolean
 }
+
 export type QueryResponse<R = unknown> = {
   result: R
   /** If defined, overrides this value for query state, ignoring `secondsToLive`. */
   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. */
 export type QueryResult<R = unknown> = {
   error?: unknown
   /** Fetch cancelled reason. */
   cancelled?: 'loading' | 'not-expired'
   result?: R
 }
+
 export type MutationInfo<
   N extends string,
   T extends Typenames = Typenames,
@@ -275,6 +299,7 @@ export type MutationInfo<
 > = Pick<QueryInfo<N, T, P, R, QP, QR, MP, MR>, 'onCompleted' | 'onSuccess' | 'onError'> & {
   mutation: NormalizedMutation<T, P, R>
 }
+
 export type Mutation<P = unknown, R = unknown> = (
   /** Mutation parameters */
   params: P,
@@ -283,9 +308,11 @@ export type Mutation<P = unknown, R = unknown> = (
   /** Signal is aborted for current mutation when the same mutation was called once again. */
   abortSignal: AbortSignal
 ) => Promise<MutationResponse<R>>
+
 export type NormalizedMutation<T extends Typenames = Typenames, P = unknown, R = unknown> = (
   ...args: Parameters<Mutation<P, R>>
 ) => Promise<NormalizedMutationResponse<T, R>>
+
 export type MutateOptions<
   N extends string,
   T extends Typenames,
@@ -310,16 +337,20 @@ export type MutateOptions<
   mutation: MK
   params: MK extends keyof (MP | MR) ? MP[MK] : never
 }
+
 export type MutationResponse<R = unknown> = {
   result?: R
 }
+
 export type NormalizedMutationResponse<T extends Typenames = Typenames, R = unknown> = EntityChanges<T> &
   MutationResponse<R>
+
 export type MutationResult<R = unknown> = {
   error?: unknown
   aborted?: true
   result?: R
 }
+
 export type MutationState<T extends Typenames, P, R> = {
   /** Set when fetch is currently in progress. */
   loading?: Promise<NormalizedQueryResponse<T, R>>

package/dist/types/useMutation.d.ts

@@ -11,7 +11,7 @@ export declare const useMutation: <
   MR,
   MK extends keyof (MP & MR)
 >(
-  cache: Cache<N, T, QP, QR, MP, MR>,
+  cache: Pick<Cache<N, T, QP, QR, MP, MR>, 'options' | 'globals' | 'mutations' | 'storeHooks'>,
   actions: Actions<N, T, QP, QR, MP, MR>,
   selectors: Selectors<N, T, QP, QR, MP, MR>,
   options: Omit<MutateOptions<N, T, QP, QR, MP, MR, MK>, 'params'>,

package/dist/types/useQuery.d.ts

@@ -11,7 +11,7 @@ export declare const useQuery: <
   MR,
   QK extends keyof (QP & QR)
 >(
-  cache: Cache<N, T, QP, QR, MP, MR>,
+  cache: Pick<Cache<N, T, QP, QR, MP, MR>, 'options' | 'globals' | 'queries' | 'storeHooks'>,
   actions: Actions<N, T, QP, QR, MP, MR>,
   selectors: Selectors<N, T, QP, QR, MP, MR>,
   options: UseQueryOptions<N, T, QK, QP, QR, MP, MR>

package/dist/types/utilsAndConstants.d.ts

@@ -9,31 +9,48 @@ import type {
 } from './types'
 
 export declare const PACKAGE_SHORT_NAME = 'rrc'
+
 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 FetchPolicy: {
-  /** Only if cache does not exist (result is undefined) or expired. */
-  NoCacheOrExpired: <T extends Typenames = Typenames, P = unknown, R = unknown>(
-    expired: boolean,
-    _params: P,
-    state: QueryState<T, P, R>
-  ) => boolean
-  /** Every fetch trigger. */
-  Always: () => boolean
-}
+
 export declare const applyEntityChanges: <T extends Typenames>(
   entities: EntitiesMap<T>,
   changes: EntityChanges<T>,
   options: CacheOptions
 ) => EntitiesMap<T> | undefined
+
+/** Returns true if object has no keys. */
 export declare const isEmptyObject: (o: object) => boolean
+
+/** Returns query state comparer that compares only provided fields. Used in implementation of `selectorComparer` option. */
 export declare const createStateComparer: <T extends Typenames = Typenames, Q = unknown, P = unknown>(
   fields: (keyof QueryState<T, Q, P>)[]
 ) => QueryStateComparer<T, Q, P>
+
+export declare const FetchPolicy: {
+  /** Only if cache does not exist (result is undefined) or expired. @Default */
+  NoCacheOrExpired: <T extends Typenames = Typenames, P = unknown, R = unknown>(
+    expired: boolean,
+    _params: P,
+    state: QueryState<T, P, R>
+  ) => boolean
+  /** Every fetch trigger. */
+  Always: () => boolean
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-redux-cache",
   "author": "Alexander Danilov",
   "license": "MIT",
-  "version": "0.19.5",
+  "version": "0.20.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",
@@ -23,14 +23,15 @@
     "build-cjs": "tsc -p tsconfig.cjs.json && rm -rf dist/cjs/testing && rm -rf dist/cjs/__tests__",
     "build-esm": "tsc -p tsconfig.esm.json > /dev/null ; rm -rf dist/esm/testing && rm -rf dist/esm/__tests__",
     "build-types": "tsc -p tsconfig.types.json > /dev/null ; rm -rf dist/types/testing && rm -rf dist/types/__tests__",
-    "build": "yarn clean && yarn lint && yarn build-cjs && yarn build-esm && yarn build-types && yarn size && yarn lint-fix-dist",
+    "build": "yarn clean && yarn lint && yarn build-cjs && yarn build-esm && yarn build-types && yarn size && yarn lint-fix-dist && yarn generate-docs",
     "size": "npx minified-size dist/esm/*.js | grep 'total:' | sed -E 's/.*total: [^,]*, ([^,]*), ([^,]*), ([^,]*).*/<br\\/>minified: \\1<br\\/>gzipped: \\2<br\\/>brotlied: \\3/'",
     "test": "node node_modules/jest/bin/jest.js",
     "preminor-rc": "yarn build && npm version preminor --preid rc",
     "prepatch-rc": "yarn build && npm version prepatch --preid rc",
     "publish-rc": "npm publish --tag rc",
     "remove-rc": "npm version <same-version-without-rc>",
-    "prepublishOnly": "yarn build && yarn test"
+    "prepublishOnly": "yarn build && yarn test",
+    "generate-docs": "node --experimental-strip-types scripts/generate-docs.ts"
   },
   "peerDependencies": {
     "fast-deep-equal": "*",