react-redux-cache 0.19.3 → 0.19.4

package/dist/createCache.d.ts

@@ -1,378 +0,0 @@
-import type { Cache, CacheOptions, Globals, Key, MutateOptions, MutationResult, OptionalPartial, QueryOptions, QueryResult, Store, Typenames } from './types';
-import { useMutation } from './useMutation';
-import { useQuery } from './useQuery';
-import { applyEntityChanges } from './utilsAndConstants';
-/**
- * Function to provide generic Typenames if normalization is needed - this is a Typescript limitation.
- * Returns object with createCache function with provided typenames.
- * @example
- * const cache = withTypenames<MyTypenames>().createCache({
- *   ...
- * })
- */
-export declare const withTypenames: <T extends Typenames = Typenames>() => {
-    createCache: <N extends string, QP, QR, MP, MR>(partialCache: OptionalPartial<Omit<Cache<N, T, QP, QR, MP, MR>, "globals">, "options" | "queries" | "mutations" | "cacheStateSelector" | "storeHooks"> & {
-        globals?: OptionalPartial<Cache<N, T, QP, QR, MP, MR>["globals"], "queries">;
-    }) => {
-        /** 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: (state: import("./types").CacheState<T, QP, QR, MP, MR> | undefined, action: {
-            type: `@rrc/${N}/updateQueryStateAndEntities`;
-            queryKey: keyof QP & keyof QR;
-            queryCacheKey: Key;
-            state: Partial<import("./types").QueryState<T, QP[keyof QP & keyof QR], QR[keyof QP & keyof QR]>> | undefined;
-            entityChanges: import("./types").EntityChanges<T> | undefined;
-        } | {
-            type: `@rrc/${N}/updateMutationStateAndEntities`;
-            mutationKey: keyof MP & keyof MR;
-            state: Partial<import("./types").MutationState<T, MP[keyof MP & keyof MR], MR[keyof MP & keyof MR]>> | undefined;
-            entityChanges: import("./types").EntityChanges<T> | undefined;
-        } | {
-            type: `@rrc/${N}/mergeEntityChanges`;
-            changes: import("./types").EntityChanges<T>;
-        } | {
-            type: `@rrc/${N}/invalidateQuery`;
-            queries: {
-                query: keyof QP & keyof QR;
-                cacheKey?: Key;
-                expiresAt?: number;
-            }[];
-        } | {
-            type: `@rrc/${N}/clearQueryState`;
-            queries: {
-                query: keyof QP & keyof QR;
-                cacheKey?: Key;
-            }[];
-        } | {
-            type: `@rrc/${N}/clearMutationState`;
-            mutationKeys: (keyof MP & keyof MR)[];
-        } | {
-            type: `@rrc/${N}/clearCache`;
-            stateToKeep: Partial<import("./types").CacheState<T, QP, QR, MP, MR>> | undefined;
-        }) => import("./types").CacheState<T, QP, QR, MP, MR>;
-        actions: {
-            /** Updates query state, and optionally merges entity changes in a single action. */
-            updateQueryStateAndEntities: {
-                <K extends keyof QP & keyof QR>(queryKey: K, queryCacheKey: Key, state?: Partial<import("./types").QueryState<T, QP[K], QR[K]>> | undefined, entityChanges?: import("./types").EntityChanges<T> | undefined): {
-                    type: `@rrc/${N}/updateQueryStateAndEntities`;
-                    queryKey: K;
-                    queryCacheKey: Key;
-                    state: Partial<import("./types").QueryState<T, QP[K], QR[K]>> | undefined;
-                    entityChanges: import("./types").EntityChanges<T> | undefined;
-                };
-                type: `@rrc/${N}/updateQueryStateAndEntities`;
-            };
-            /** Updates mutation state, and optionally merges entity changes in a single action. */
-            updateMutationStateAndEntities: {
-                <K extends keyof MP & keyof MR>(mutationKey: K, state?: Partial<import("./types").MutationState<T, MP[K], MR[K]>> | undefined, entityChanges?: import("./types").EntityChanges<T> | undefined): {
-                    type: `@rrc/${N}/updateMutationStateAndEntities`;
-                    mutationKey: K;
-                    state: Partial<import("./types").MutationState<T, MP[K], MR[K]>> | undefined;
-                    entityChanges: import("./types").EntityChanges<T> | undefined;
-                };
-                type: `@rrc/${N}/updateMutationStateAndEntities`;
-            };
-            /** Merges EntityChanges to the state. */
-            mergeEntityChanges: {
-                (changes: import("./types").EntityChanges<T>): {
-                    type: `@rrc/${N}/mergeEntityChanges`;
-                    changes: import("./types").EntityChanges<T>;
-                };
-                type: `@rrc/${N}/mergeEntityChanges`;
-            };
-            /** Invalidates query states. */
-            invalidateQuery: {
-                <K extends keyof QP & keyof QR>(queries: {
-                    query: K;
-                    cacheKey?: Key;
-                    expiresAt?: number;
-                }[]): {
-                    type: `@rrc/${N}/invalidateQuery`;
-                    queries: {
-                        query: K;
-                        cacheKey?: Key;
-                        expiresAt?: number;
-                    }[];
-                };
-                type: `@rrc/${N}/invalidateQuery`;
-            };
-            /** Clears states for provided query keys and cache keys.
-             * If cache key for query key is not provided, the whole state for query key is cleared. */
-            clearQueryState: {
-                <K extends keyof QP & keyof QR>(queries: {
-                    query: K;
-                    cacheKey?: Key;
-                }[]): {
-                    type: `@rrc/${N}/clearQueryState`;
-                    queries: {
-                        query: K;
-                        cacheKey?: Key;
-                    }[];
-                };
-                type: `@rrc/${N}/clearQueryState`;
-            };
-            /** Clears states for provided mutation keys. */
-            clearMutationState: {
-                <K extends keyof MP & keyof MR>(mutationKeys: K[]): {
-                    type: `@rrc/${N}/clearMutationState`;
-                    mutationKeys: K[];
-                };
-                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. */
-            clearCache: {
-                (stateToKeep?: Partial<import("./types").CacheState<T, QP, QR, MP, MR>> | undefined): {
-                    type: `@rrc/${N}/clearCache`;
-                    stateToKeep: Partial<import("./types").CacheState<T, QP, QR, MP, MR>> | undefined;
-                };
-                type: `@rrc/${N}/clearCache`;
-            };
-        };
-        selectors: {
-            /** This is a cacheStateSelector from createCache options, or default one if was not provided. */
-            selectCacheState: (state: any) => import("./types").CacheState<T, QP, QR, MP, MR>;
-            /** Selects query state. */
-            selectQueryState: <QK extends keyof QP | keyof QR>(state: unknown, query: QK, cacheKey: Key) => import("./types").QueryState<T, QK extends keyof QP & keyof QR ? QP[QK] : never, QK extends keyof QP & keyof QR ? QR[QK] : never>;
-            /** Selects query latest result. */
-            selectQueryResult: <QK extends keyof QP | keyof QR>(state: unknown, query: QK, cacheKey: Key) => (QK extends keyof QP & keyof QR ? QR[QK] : never) | undefined;
-            /** Selects query loading state. */
-            selectQueryLoading: <QK extends keyof QP | keyof QR>(state: unknown, query: QK, cacheKey: Key) => false | Promise<import("./types").NormalizedQueryResponse<T, QK extends keyof QP & keyof QR ? QR[QK] : never>>;
-            /** Selects query latest error. */
-            selectQueryError: <QK extends keyof QP | keyof QR>(state: unknown, query: QK, cacheKey: Key) => Error | undefined;
-            /** Selects query latest params. */
-            selectQueryParams: <QK extends keyof QP | keyof QR>(state: unknown, query: QK, cacheKey: Key) => (QK extends keyof QP & keyof QR ? QP[QK] : never) | undefined;
-            /** Selects query latest expiresAt. */
-            selectQueryExpiresAt: <QK extends keyof QP | keyof QR>(state: unknown, query: QK, cacheKey: Key) => number | undefined;
-            /** Selects mutation state. */
-            selectMutationState: <MK extends keyof MP | keyof MR>(state: unknown, mutation: MK) => import("./types").MutationState<T, MK extends keyof MP & keyof MR ? MP[MK] : never, MK extends keyof MP & keyof MR ? MR[MK] : never>;
-            /** Selects mutation latest result. */
-            selectMutationResult: <MK extends keyof MP | keyof MR>(state: unknown, mutation: MK) => (MK extends keyof MP & keyof MR ? MR[MK] : never) | undefined;
-            /** Selects mutation loading state. */
-            selectMutationLoading: <MK extends keyof MP | keyof MR>(state: unknown, mutation: MK) => false | Promise<import("./types").NormalizedQueryResponse<T, MK extends keyof MP & keyof MR ? MR[MK] : never>>;
-            /** Selects mutation latest error. */
-            selectMutationError: <MK extends keyof MP | keyof MR>(state: unknown, mutation: MK) => Error | undefined;
-            /** Selects mutation latest params. */
-            selectMutationParams: <MK extends keyof MP | keyof MR>(state: unknown, mutation: MK) => (MK extends keyof MP & keyof MR ? MP[MK] : never) | undefined;
-            /** Selects entity by id and typename. */
-            selectEntityById: <TN extends keyof T>(state: unknown, id: Key | null | undefined, typename: TN) => T[TN] | undefined;
-            /** Selects all entities. */
-            selectEntities: (state: unknown) => import("./types").EntitiesMap<T>;
-            /** Selects all entities of provided typename. */
-            selectEntitiesByTypename: <TN extends keyof T>(state: unknown, typename: TN) => import("./types").EntitiesMap<T>[TN];
-        };
-        hooks: {
-            /** Returns client object with query and mutate functions. */
-            useClient: () => {
-                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>>;
-                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>>;
-            };
-            /** Fetches query when params change and subscribes to query state changes (except `expiresAt` field). */
-            useQuery: <QK extends keyof (QP & QR)>(options: Parameters<typeof useQuery<N, T, QP, QR, MP, MR, QK>>[3]) => readonly [Omit<import("./types").QueryState<T, QK extends keyof QP & keyof QR ? QP[QK] : never, QK extends keyof QP & keyof QR ? QR[QK] : never>, "expiresAt">, (options?: Partial<Pick<QueryOptions<N, T, QP, QR, QK, MP, MR>, "params" | "onlyIfExpired">> | undefined) => Promise<QueryResult<QK extends infer T_1 ? T_1 extends QK ? T_1 extends keyof QP & keyof QR ? QR[T_1] : never : never : never>>];
-            /** Subscribes to provided mutation state and provides mutate function. */
-            useMutation: <MK extends keyof (MP & MR)>(options: Parameters<typeof useMutation<N, T, QP, QR, MP, MR, MK>>[3]) => readonly [(params: MK extends keyof MP & keyof MR ? MP[MK] : never) => Promise<MutationResult<MK extends infer T_1 ? T_1 extends MK ? T_1 extends keyof MP & keyof MR ? MR[T_1] : never : never : never>>, import("./types").MutationState<T, MK extends keyof MP & keyof MR ? MP[MK] : never, MK extends keyof MP & keyof MR ? MP[MK] : never>, () => boolean];
-            /** useSelector + selectEntityById. */
-            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. */
-            createClient: (store: Store) => {
-                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>>;
-                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: () => import("./types").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. */
-            applyEntityChanges: (entities: Parameters<typeof applyEntityChanges<T>>[0], changes: Parameters<typeof applyEntityChanges<T>>[1]) => import("./types").EntitiesMap<T> | undefined;
-        };
-    };
-};
-/**
- * Creates reducer, actions and hooks for managing queries and mutations through redux cache.
- */
-export declare const createCache: <N extends string, QP, QR, MP, MR>(partialCache: Partial<{
-    queries: Partial<{ [QK in keyof (QP & QR)]: QK extends keyof QP & keyof QR ? import("./types").QueryInfo<N, Typenames, QP[QK], QR[QK], QP, QR, MP, MR> : never; }>;
-    mutations: Partial<{ [MK in keyof (MP & MR)]: MK extends keyof MP & keyof MR ? import("./types").MutationInfo<N, Typenames, MP[MK], MR[MK], QP, QR, MP, MR> : never; }>;
-    options: Partial<CacheOptions>;
-    storeHooks: Partial<{
-        useStore: () => Store;
-        useSelector: <R>(selector: (state: unknown) => R, comparer?: (x: R, y: R) => boolean) => R;
-    }>;
-    cacheStateSelector: Partial<(state: any) => import("./types").CacheState<Typenames, QP, QR, MP, MR>>;
-}> & Omit<Omit<Cache<N, Typenames, QP, QR, MP, MR>, "globals">, "queries" | "mutations" | "options" | "storeHooks" | "cacheStateSelector"> & {
-    globals?: OptionalPartial<Globals<N, Typenames, QP, QR, MP, MR>, "queries"> | undefined;
-}) => {
-    /** 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: (state: import("./types").CacheState<Typenames, QP, QR, MP, MR> | undefined, action: {
-        type: `@rrc/${N}/updateQueryStateAndEntities`;
-        queryKey: keyof QP & keyof QR;
-        queryCacheKey: Key;
-        state: Partial<import("./types").QueryState<Typenames, QP[keyof QP & keyof QR], QR[keyof QP & keyof QR]>> | undefined;
-        entityChanges: import("./types").EntityChanges<Typenames> | undefined;
-    } | {
-        type: `@rrc/${N}/updateMutationStateAndEntities`;
-        mutationKey: keyof MP & keyof MR;
-        state: Partial<import("./types").MutationState<Typenames, MP[keyof MP & keyof MR], MR[keyof MP & keyof MR]>> | undefined;
-        entityChanges: import("./types").EntityChanges<Typenames> | undefined;
-    } | {
-        type: `@rrc/${N}/mergeEntityChanges`;
-        changes: import("./types").EntityChanges<Typenames>;
-    } | {
-        type: `@rrc/${N}/invalidateQuery`;
-        queries: {
-            query: keyof QP & keyof QR;
-            cacheKey?: Key;
-            expiresAt?: number;
-        }[];
-    } | {
-        type: `@rrc/${N}/clearQueryState`;
-        queries: {
-            query: keyof QP & keyof QR;
-            cacheKey?: Key;
-        }[];
-    } | {
-        type: `@rrc/${N}/clearMutationState`;
-        mutationKeys: (keyof MP & keyof MR)[];
-    } | {
-        type: `@rrc/${N}/clearCache`;
-        stateToKeep: Partial<import("./types").CacheState<Typenames, QP, QR, MP, MR>> | undefined;
-    }) => import("./types").CacheState<Typenames, QP, QR, MP, MR>;
-    actions: {
-        /** Updates query state, and optionally merges entity changes in a single action. */
-        updateQueryStateAndEntities: {
-            <K extends keyof QP & keyof QR>(queryKey: K, queryCacheKey: Key, state?: Partial<import("./types").QueryState<Typenames, QP[K], QR[K]>> | undefined, entityChanges?: import("./types").EntityChanges<Typenames> | undefined): {
-                type: `@rrc/${N}/updateQueryStateAndEntities`;
-                queryKey: K;
-                queryCacheKey: Key;
-                state: Partial<import("./types").QueryState<Typenames, QP[K], QR[K]>> | undefined;
-                entityChanges: import("./types").EntityChanges<Typenames> | undefined;
-            };
-            type: `@rrc/${N}/updateQueryStateAndEntities`;
-        };
-        /** Updates mutation state, and optionally merges entity changes in a single action. */
-        updateMutationStateAndEntities: {
-            <K extends keyof MP & keyof MR>(mutationKey: K, state?: Partial<import("./types").MutationState<Typenames, MP[K], MR[K]>> | undefined, entityChanges?: import("./types").EntityChanges<Typenames> | undefined): {
-                type: `@rrc/${N}/updateMutationStateAndEntities`;
-                mutationKey: K;
-                state: Partial<import("./types").MutationState<Typenames, MP[K], MR[K]>> | undefined;
-                entityChanges: import("./types").EntityChanges<Typenames> | undefined;
-            };
-            type: `@rrc/${N}/updateMutationStateAndEntities`;
-        };
-        /** Merges EntityChanges to the state. */
-        mergeEntityChanges: {
-            (changes: import("./types").EntityChanges<Typenames>): {
-                type: `@rrc/${N}/mergeEntityChanges`;
-                changes: import("./types").EntityChanges<Typenames>;
-            };
-            type: `@rrc/${N}/mergeEntityChanges`;
-        };
-        /** Invalidates query states. */
-        invalidateQuery: {
-            <K extends keyof QP & keyof QR>(queries: {
-                query: K;
-                cacheKey?: Key;
-                expiresAt?: number;
-            }[]): {
-                type: `@rrc/${N}/invalidateQuery`;
-                queries: {
-                    query: K;
-                    cacheKey?: Key;
-                    expiresAt?: number;
-                }[];
-            };
-            type: `@rrc/${N}/invalidateQuery`;
-        };
-        /** Clears states for provided query keys and cache keys.
-         * If cache key for query key is not provided, the whole state for query key is cleared. */
-        clearQueryState: {
-            <K extends keyof QP & keyof QR>(queries: {
-                query: K;
-                cacheKey?: Key;
-            }[]): {
-                type: `@rrc/${N}/clearQueryState`;
-                queries: {
-                    query: K;
-                    cacheKey?: Key;
-                }[];
-            };
-            type: `@rrc/${N}/clearQueryState`;
-        };
-        /** Clears states for provided mutation keys. */
-        clearMutationState: {
-            <K extends keyof MP & keyof MR>(mutationKeys: K[]): {
-                type: `@rrc/${N}/clearMutationState`;
-                mutationKeys: K[];
-            };
-            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. */
-        clearCache: {
-            (stateToKeep?: Partial<import("./types").CacheState<Typenames, QP, QR, MP, MR>> | undefined): {
-                type: `@rrc/${N}/clearCache`;
-                stateToKeep: Partial<import("./types").CacheState<Typenames, QP, QR, MP, MR>> | undefined;
-            };
-            type: `@rrc/${N}/clearCache`;
-        };
-    };
-    selectors: {
-        /** This is a cacheStateSelector from createCache options, or default one if was not provided. */
-        selectCacheState: (state: any) => import("./types").CacheState<Typenames, QP, QR, MP, MR>;
-        /** Selects query state. */
-        selectQueryState: <QK_1 extends keyof QP | keyof QR>(state: unknown, query: QK_1, cacheKey: Key) => import("./types").QueryState<Typenames, QK_1 extends keyof QP & keyof QR ? QP[QK_1] : never, QK_1 extends keyof QP & keyof QR ? QR[QK_1] : never>;
-        /** Selects query latest result. */
-        selectQueryResult: <QK_1 extends keyof QP | keyof QR>(state: unknown, query: QK_1, cacheKey: Key) => (QK_1 extends keyof QP & keyof QR ? QR[QK_1] : never) | undefined;
-        /** Selects query loading state. */
-        selectQueryLoading: <QK_1 extends keyof QP | keyof QR>(state: unknown, query: QK_1, cacheKey: Key) => false | Promise<import("./types").NormalizedQueryResponse<Typenames, QK_1 extends keyof QP & keyof QR ? QR[QK_1] : never>>;
-        /** Selects query latest error. */
-        selectQueryError: <QK_1 extends keyof QP | keyof QR>(state: unknown, query: QK_1, cacheKey: Key) => Error | undefined;
-        /** Selects query latest params. */
-        selectQueryParams: <QK_1 extends keyof QP | keyof QR>(state: unknown, query: QK_1, cacheKey: Key) => (QK_1 extends keyof QP & keyof QR ? QP[QK_1] : never) | undefined;
-        /** Selects query latest expiresAt. */
-        selectQueryExpiresAt: <QK_1 extends keyof QP | keyof QR>(state: unknown, query: QK_1, cacheKey: Key) => number | undefined;
-        /** Selects mutation state. */
-        selectMutationState: <MK_1 extends keyof MP | keyof MR>(state: unknown, mutation: MK_1) => import("./types").MutationState<Typenames, MK_1 extends keyof MP & keyof MR ? MP[MK_1] : never, MK_1 extends keyof MP & keyof MR ? MR[MK_1] : never>;
-        /** Selects mutation latest result. */
-        selectMutationResult: <MK_1 extends keyof MP | keyof MR>(state: unknown, mutation: MK_1) => (MK_1 extends keyof MP & keyof MR ? MR[MK_1] : never) | undefined;
-        /** Selects mutation loading state. */
-        selectMutationLoading: <MK_1 extends keyof MP | keyof MR>(state: unknown, mutation: MK_1) => false | Promise<import("./types").NormalizedQueryResponse<Typenames, MK_1 extends keyof MP & keyof MR ? MR[MK_1] : never>>;
-        /** Selects mutation latest error. */
-        selectMutationError: <MK_1 extends keyof MP | keyof MR>(state: unknown, mutation: MK_1) => Error | undefined;
-        /** Selects mutation latest params. */
-        selectMutationParams: <MK_1 extends keyof MP | keyof MR>(state: unknown, mutation: MK_1) => (MK_1 extends keyof MP & keyof MR ? MP[MK_1] : never) | undefined;
-        /** Selects entity by id and typename. */
-        selectEntityById: <TN extends string>(state: unknown, id: Key | null | undefined, typename: TN) => object | undefined;
-        /** Selects all entities. */
-        selectEntities: (state: unknown) => import("./types").EntitiesMap<Typenames>;
-        /** Selects all entities of provided typename. */
-        selectEntitiesByTypename: <TN extends string>(state: unknown, typename: TN) => import("./types").Dict<object> | undefined;
-    };
-    hooks: {
-        /** Returns client object with query and mutate functions. */
-        useClient: () => {
-            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>>;
-            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>>;
-        };
-        /** Fetches query when params change and subscribes to query state changes (except `expiresAt` field). */
-        useQuery: <QK_1 extends keyof QP | keyof QR>(options: import("./types").UseQueryOptions<N, Typenames, QK_1, QP, QR, MP, MR>) => readonly [Omit<import("./types").QueryState<Typenames, QK_1 extends keyof QP & keyof QR ? QP[QK_1] : never, QK_1 extends keyof QP & keyof QR ? QR[QK_1] : never>, "expiresAt">, (options?: Partial<Pick<QueryOptions<N, Typenames, QP, QR, QK_1, MP, MR>, "params" | "onlyIfExpired">> | undefined) => Promise<QueryResult<QK_1 extends infer T ? T extends QK_1 ? T extends keyof QP & keyof QR ? QR[T] : never : never : never>>];
-        /** Subscribes to provided mutation state and provides mutate function. */
-        useMutation: <MK_1 extends keyof MP | keyof MR>(options: Omit<MutateOptions<N, Typenames, QP, QR, MP, MR, MK_1>, "params">) => readonly [(params: MK_1 extends keyof MP & keyof MR ? MP[MK_1] : never) => Promise<MutationResult<MK_1 extends infer T ? T extends MK_1 ? T extends keyof MP & keyof MR ? MR[T] : never : never : never>>, import("./types").MutationState<Typenames, MK_1 extends keyof MP & keyof MR ? MP[MK_1] : never, MK_1 extends keyof MP & keyof MR ? MP[MK_1] : never>, () => boolean];
-        /** useSelector + selectEntityById. */
-        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. */
-        createClient: (store: Store) => {
-            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>>;
-            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: () => import("./types").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. */
-        applyEntityChanges: (entities: import("./types").EntitiesMap<Typenames>, changes: import("./types").EntityChanges<Typenames>) => import("./types").EntitiesMap<Typenames> | undefined;
-    };
-};

package/dist/createCache.js

@@ -1,192 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCache = exports.withTypenames = void 0;
-const react_1 = require("react");
-const createActions_1 = require("./createActions");
-const createCacheReducer_1 = require("./createCacheReducer");
-const createSelectors_1 = require("./createSelectors");
-const mutate_1 = require("./mutate");
-const query_1 = require("./query");
-const useMutation_1 = require("./useMutation");
-const useQuery_1 = require("./useQuery");
-const utilsAndConstants_1 = require("./utilsAndConstants");
-/**
- * Function to provide generic Typenames if normalization is needed - this is a Typescript limitation.
- * Returns object with createCache function with provided typenames.
- * @example
- * const cache = withTypenames<MyTypenames>().createCache({
- *   ...
- * })
- */
-const withTypenames = () => {
-    /**
-     * Creates reducer, actions and hooks for managing queries and mutations through redux cache.
-     */
-    return {
-        createCache: (partialCache) => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-            var _o, _p, _q, _r, _s, _t;
-            const abortControllers = new WeakMap();
-            // Provide all optional fields
-            (_a = partialCache.options) !== null && _a !== void 0 ? _a : (partialCache.options = {});
-            (_b = (_o = partialCache.options).logsEnabled) !== null && _b !== void 0 ? _b : (_o.logsEnabled = false);
-            (_c = (_p = partialCache.options).additionalValidation) !== null && _c !== void 0 ? _c : (_p.additionalValidation = utilsAndConstants_1.IS_DEV);
-            (_d = (_q = partialCache.options).deepComparisonEnabled) !== null && _d !== void 0 ? _d : (_q.deepComparisonEnabled = true);
-            (_e = partialCache.globals) !== null && _e !== void 0 ? _e : (partialCache.globals = {});
-            (_f = (_r = partialCache.globals).queries) !== null && _f !== void 0 ? _f : (_r.queries = {});
-            (_g = (_s = partialCache.globals.queries).fetchPolicy) !== null && _g !== void 0 ? _g : (_s.fetchPolicy = utilsAndConstants_1.FetchPolicy.NoCacheOrExpired);
-            (_h = (_t = partialCache.globals.queries).skipFetch) !== null && _h !== void 0 ? _h : (_t.skipFetch = false);
-            (_j = partialCache.cacheStateSelector) !== null && _j !== void 0 ? _j : (partialCache.cacheStateSelector = (state) => state[cache.name]);
-            (_k = partialCache.mutations) !== null && _k !== void 0 ? _k : (partialCache.mutations = {});
-            (_l = partialCache.queries) !== null && _l !== void 0 ? _l : (partialCache.queries = {});
-            // @ts-expect-error private field for testing
-            partialCache.abortControllers = abortControllers;
-            // Try/catch just for bunders like metro to consider this as optional dependency
-            // eslint-disable-next-line no-useless-catch
-            try {
-                (_m = partialCache.storeHooks) !== null && _m !== void 0 ? _m : (partialCache.storeHooks = {
-                    useStore: require('react-redux').useStore,
-                    useSelector: require('react-redux').useSelector,
-                });
-            }
-            catch (e) {
-                throw e;
-            }
-            const cache = partialCache;
-            // Validate options
-            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');
-            }
-            // State comparers
-            /** Transforms array of keys to comparer function. */
-            const setDefaultComparer = (target) => {
-                if ((target === null || target === void 0 ? void 0 : target.selectorComparer) != null && typeof target.selectorComparer === 'object') {
-                    target.selectorComparer = (0, utilsAndConstants_1.createStateComparer)(target.selectorComparer);
-                }
-            };
-            setDefaultComparer(cache.globals.queries);
-            for (const queryKey in partialCache.queries) {
-                // @ts-expect-error TODO fix types
-                setDefaultComparer(partialCache.queries[queryKey]);
-            }
-            // Selectors
-            const selectors = Object.assign({ selectCacheState: cache.cacheStateSelector }, (0, createSelectors_1.createSelectors)(cache));
-            const { selectCacheState, selectQueryState, selectQueryResult, selectQueryLoading, selectQueryError, selectQueryParams, selectQueryExpiresAt, selectMutationState, selectMutationResult, selectMutationLoading, selectMutationError, selectMutationParams, selectEntityById, selectEntities, selectEntitiesByTypename, } = selectors;
-            // Actions
-            const actions = (0, createActions_1.createActions)(cache.name);
-            const { updateQueryStateAndEntities, updateMutationStateAndEntities, mergeEntityChanges, invalidateQuery, clearQueryState, clearMutationState, clearCache, } = actions;
-            // Reducer
-            const reducer = (0, createCacheReducer_1.createCacheReducer)(actions, Object.keys(cache.queries), cache.options);
-            // Client creator
-            const createClient = (store) => {
-                const client = {
-                    query: (options) => {
-                        var _a;
-                        const { query: queryKey, params } = options;
-                        const getCacheKey = (_a = cache.queries[queryKey].getCacheKey) !== null && _a !== void 0 ? _a : (utilsAndConstants_1.defaultGetCacheKey);
-                        // @ts-expect-error fix later
-                        const cacheKey = getCacheKey(params);
-                        return (0, query_1.query)('query', store, cache, actions, selectors, queryKey, cacheKey, params, options.secondsToLive, options.onlyIfExpired, 
-                        // @ts-expect-error fix later
-                        options.mergeResults, options.onCompleted, options.onSuccess, options.onError);
-                    },
-                    mutate: (options) => {
-                        return (0, mutate_1.mutate)('mutate', store, cache, actions, selectors, options.mutation, options.params, abortControllers, 
-                        // @ts-expect-error fix later
-                        options.onCompleted, options.onSuccess, options.onError);
-                    },
-                };
-                return client;
-            };
-            return {
-                /** Keeps all options, passed while creating the cache. */
-                cache,
-                /** Reducer of the cache, should be added to redux store. */
-                reducer,
-                actions: {
-                    /** Updates query state, and optionally merges entity changes in a single action. */
-                    updateQueryStateAndEntities,
-                    /** Updates mutation state, and optionally merges entity changes in a single action. */
-                    updateMutationStateAndEntities,
-                    /** Merges EntityChanges to the state. */
-                    mergeEntityChanges,
-                    /** Invalidates query states. */
-                    invalidateQuery,
-                    /** Clears states for provided query keys and cache keys.
-                     * If cache key for query key is not provided, the whole state for query key is cleared. */
-                    clearQueryState,
-                    /** Clears states for provided mutation keys. */
-                    clearMutationState,
-                    /** Replaces cache state with initial, optionally merging with provided state. Doesn't cancel running fetches and shoult be used with caution. */
-                    clearCache,
-                },
-                selectors: {
-                    /** This is a cacheStateSelector from createCache options, or default one if was not provided. */
-                    selectCacheState,
-                    /** Selects query state. */
-                    selectQueryState,
-                    /** Selects query latest result. */
-                    selectQueryResult,
-                    /** Selects query loading state. */
-                    selectQueryLoading,
-                    /** Selects query latest error. */
-                    selectQueryError,
-                    /** Selects query latest params. */
-                    selectQueryParams,
-                    /** Selects query latest expiresAt. */
-                    selectQueryExpiresAt,
-                    /** Selects mutation state. */
-                    selectMutationState,
-                    /** Selects mutation latest result. */
-                    selectMutationResult,
-                    /** Selects mutation loading state. */
-                    selectMutationLoading,
-                    /** Selects mutation latest error. */
-                    selectMutationError,
-                    /** Selects mutation latest params. */
-                    selectMutationParams,
-                    /** Selects entity by id and typename. */
-                    selectEntityById,
-                    /** Selects all entities. */
-                    selectEntities,
-                    /** Selects all entities of provided typename. */
-                    selectEntitiesByTypename,
-                },
-                hooks: {
-                    /** Returns client object with query and mutate functions. */
-                    useClient: () => {
-                        const store = cache.storeHooks.useStore();
-                        return (0, react_1.useMemo)(() => createClient(store), [store]);
-                    },
-                    /** Fetches query when params change and subscribes to query state changes (except `expiresAt` field). */
-                    useQuery: (options) => (0, useQuery_1.useQuery)(cache, actions, selectors, options),
-                    /** Subscribes to provided mutation state and provides mutate function. */
-                    useMutation: (options) => (0, useMutation_1.useMutation)(cache, actions, selectors, options, abortControllers),
-                    /** useSelector + selectEntityById. */
-                    useSelectEntityById: (id, typename) => {
-                        return cache.storeHooks.useSelector((state) => selectEntityById(state, id, typename));
-                    },
-                },
-                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. */
-                    createClient,
-                    /** Generates the initial state by calling a reducer. Not needed for redux — it already generates it the same way when creating the store. */
-                    getInitialState: () => {
-                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        return reducer(undefined, utilsAndConstants_1.EMPTY_OBJECT);
-                    },
-                    /** Apply changes to the entities map.
-                     * @returns `undefined` if nothing to change, otherwise new `EntitiesMap<T>` with applied changes. */
-                    applyEntityChanges: (entities, changes) => {
-                        return (0, utilsAndConstants_1.applyEntityChanges)(entities, changes, cache.options);
-                    },
-                },
-            };
-        },
-    };
-};
-exports.withTypenames = withTypenames;
-/**
- * Creates reducer, actions and hooks for managing queries and mutations through redux cache.
- */
-exports.createCache = (0, exports.withTypenames)().createCache;

package/dist/createCacheReducer.d.ts

@@ -1,3 +0,0 @@
-import type { Actions } from './createActions';
-import type { CacheOptions, CacheState, Typenames } from './types';
-export declare const createCacheReducer: <N extends string, T extends Typenames, QP, QR, MP, MR>(actions: Actions<N, T, QP, QR, MP, MR>, queryKeys: (keyof (QP | QR))[], cacheOptions: CacheOptions) => (state: CacheState<T, QP, QR, MP, MR> | undefined, action: ReturnType<(typeof actions)[keyof typeof actions]>) => CacheState<T, QP, QR, MP, MR>;