react-redux-cache 0.19.2 → 0.19.4-rc.0

package/dist/types/useQuery.d.ts

@@ -0,0 +1,40 @@
+import {Actions} from './createActions'
+import {Selectors} from './createSelectors'
+import {Cache, QueryOptions, QueryState, Typenames, UseQueryOptions} from './types'
+
+export declare const useQuery: <
+  N extends string,
+  T extends Typenames,
+  QP,
+  QR,
+  MP,
+  MR,
+  QK extends keyof (QP & QR)
+>(
+  cache: Cache<N, T, QP, QR, MP, MR>,
+  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>
+) => readonly [
+  Omit<
+    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'>>
+  ) => Promise<
+    import('./types').QueryResult<
+      QK extends infer T_1
+        ? T_1 extends QK
+          ? T_1 extends keyof QP & keyof QR
+            ? QR[T_1]
+            : never
+          : never
+        : never
+    >
+  >
+]

package/dist/types/utilsAndConstants.d.ts

@@ -0,0 +1,39 @@
+import type {
+  CacheOptions,
+  EntitiesMap,
+  EntityChanges,
+  Key,
+  QueryState,
+  QueryStateComparer,
+  Typenames,
+} from './types'
+
+export declare const PACKAGE_SHORT_NAME = 'rrc'
+export declare const optionalUtils: {
+  deepEqual?: (a: any, b: any) => boolean
+}
+export declare const IS_DEV: boolean
+export declare const EMPTY_OBJECT: Readonly<{}>
+export declare const EMPTY_ARRAY: readonly never[]
+export declare const NOOP: () => void
+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
+export declare const isEmptyObject: (o: object) => boolean
+export declare const createStateComparer: <T extends Typenames = Typenames, Q = unknown, P = unknown>(
+  fields: (keyof QueryState<T, Q, P>)[]
+) => QueryStateComparer<T, Q, P>

package/package.json

@@ -2,16 +2,29 @@
   "name": "react-redux-cache",
   "author": "Alexander Danilov",
   "license": "MIT",
-  "version": "0.19.2",
+  "version": "0.19.4-rc.0",
   "description": "Powerful data fetching and caching library for Redux and Zustand that supports normalization.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
   "scripts": {
-    "example": "(cd example && yarn && yarn dev)",
+    "example": "(cd example && yarn --production && yarn dev)",
     "clean": "rm -rf dist",
-    "lint": "yarn eslint src",
-    "lint-fix": "yarn eslint --fix src",
-    "build": "yarn clean && yarn lint && tsc && rm -rf dist/testing && rm -rf dist/__tests__",
+    "lint": "yarn eslint",
+    "lint-fix": "yarn eslint --fix",
+    "lint-fix-dist": "yarn eslint --quiet --fix dist/ > /dev/null 2>&1 || true",
+    "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",
+    "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",
@@ -41,12 +54,14 @@
     "@typescript-eslint/parser": "5.59.5",
     "eslint": "8.40.0",
     "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-import": "2.32.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",
     "eslint-plugin-simple-import-sort": "10.0.0",
     "jest": "29.5.0",
     "jest-environment-jsdom": "29.7.0",
+    "minified-size": "4.0.0",
     "prettier": "2.8.8",
     "react": "18.2.0",
     "react-dom": "18.2.0",
@@ -60,9 +75,6 @@
   "files": [
     "dist/*"
   ],
-  "exports": {
-    ".": "./dist/index.js"
-  },
   "keywords": [
     "react",
     "redux",

package/dist/createActions.d.ts

@@ -1,83 +0,0 @@
-import type { EntityChanges, Key, MutationState, QueryState, Typenames } from './types';
-import { CacheState } from './types';
-export type Actions<N extends string = string, T extends Typenames = Typenames, QP = unknown, QR = unknown, MP = unknown, MR = unknown> = ReturnType<typeof createActions<N, T, QP, QR, MP, MR>>;
-export declare const createActions: <N extends string, T extends Typenames, QP, QR, MP, MR>(name: N) => {
-    updateQueryStateAndEntities: {
-        <K extends keyof (QP | QR)>(queryKey: K, queryCacheKey: Key, state?: Partial<QueryState<T, QP[K], QR[K]>>, entityChanges?: EntityChanges<T>): {
-            type: `@rrc/${N}/updateQueryStateAndEntities`;
-            queryKey: K;
-            queryCacheKey: Key;
-            state: Partial<QueryState<T, QP[K], QR[K]>> | undefined;
-            entityChanges: EntityChanges<T> | undefined;
-        };
-        type: `@rrc/${N}/updateQueryStateAndEntities`;
-    };
-    updateMutationStateAndEntities: {
-        <K extends keyof (MP | MR)>(mutationKey: K, state?: Partial<MutationState<T, MP[K], MR[K]>>, entityChanges?: EntityChanges<T>): {
-            type: `@rrc/${N}/updateMutationStateAndEntities`;
-            mutationKey: K;
-            state: Partial<MutationState<T, MP[K], MR[K]>> | undefined;
-            entityChanges: EntityChanges<T> | undefined;
-        };
-        type: `@rrc/${N}/updateMutationStateAndEntities`;
-    };
-    mergeEntityChanges: {
-        (changes: EntityChanges<T>): {
-            type: `@rrc/${N}/mergeEntityChanges`;
-            changes: EntityChanges<T>;
-        };
-        type: `@rrc/${N}/mergeEntityChanges`;
-    };
-    invalidateQuery: {
-        <K extends keyof (QP | QR)>(queries: {
-            /** Query key */
-            query: K;
-            /** Query cache key */
-            cacheKey?: Key;
-            /** Unix timestamp at which query expires. Is set to the query state. @Default Date.now() */
-            expiresAt?: number;
-        }[]): {
-            type: `@rrc/${N}/invalidateQuery`;
-            queries: {
-                /** Query key */
-                query: K;
-                /** Query cache key */
-                cacheKey?: Key;
-                /** Unix timestamp at which query expires. Is set to the query state. @Default Date.now() */
-                expiresAt?: number;
-            }[];
-        };
-        type: `@rrc/${N}/invalidateQuery`;
-    };
-    clearQueryState: {
-        <K extends keyof (QP | QR)>(queries: {
-            /** Query key */
-            query: K;
-            /** Query cache key */
-            cacheKey?: Key;
-        }[]): {
-            type: `@rrc/${N}/clearQueryState`;
-            queries: {
-                /** Query key */
-                query: K;
-                /** Query cache key */
-                cacheKey?: Key;
-            }[];
-        };
-        type: `@rrc/${N}/clearQueryState`;
-    };
-    clearMutationState: {
-        <K extends keyof (MP | MR)>(mutationKeys: K[]): {
-            type: `@rrc/${N}/clearMutationState`;
-            mutationKeys: K[];
-        };
-        type: `@rrc/${N}/clearMutationState`;
-    };
-    clearCache: {
-        (stateToKeep?: Partial<CacheState<T, QP, QR, MP, MR>>): {
-            type: `@rrc/${N}/clearCache`;
-            stateToKeep: Partial<CacheState<T, QP, QR, MP, MR>> | undefined;
-        };
-        type: `@rrc/${N}/clearCache`;
-    };
-};

package/dist/createActions.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createActions = void 0;
-const utilsAndConstants_1 = require("./utilsAndConstants");
-const createActions = (name) => {
-    const actionPrefix = `@${utilsAndConstants_1.PACKAGE_SHORT_NAME}/${name}/`;
-    const updateQueryStateAndEntitiesType = `${actionPrefix}updateQueryStateAndEntities`;
-    const updateQueryStateAndEntities = (queryKey, queryCacheKey, state, entityChanges) => ({
-        type: updateQueryStateAndEntitiesType,
-        queryKey,
-        queryCacheKey,
-        state,
-        entityChanges,
-    });
-    updateQueryStateAndEntities.type = updateQueryStateAndEntitiesType;
-    const updateMutationStateAndEntitiesType = `${actionPrefix}updateMutationStateAndEntities`;
-    const updateMutationStateAndEntities = (mutationKey, state, entityChanges) => ({
-        type: updateMutationStateAndEntitiesType,
-        mutationKey,
-        state,
-        entityChanges,
-    });
-    updateMutationStateAndEntities.type = updateMutationStateAndEntitiesType;
-    const mergeEntityChangesType = `${actionPrefix}mergeEntityChanges`;
-    const mergeEntityChanges = (changes) => ({
-        type: mergeEntityChangesType,
-        changes,
-    });
-    mergeEntityChanges.type = mergeEntityChangesType;
-    const invalidateQueryType = `${actionPrefix}invalidateQuery`;
-    const invalidateQuery = (queries) => ({
-        type: invalidateQueryType,
-        queries,
-    });
-    invalidateQuery.type = invalidateQueryType;
-    const clearQueryStateType = `${actionPrefix}clearQueryState`;
-    const clearQueryState = (queries) => ({
-        type: clearQueryStateType,
-        queries,
-    });
-    clearQueryState.type = clearQueryStateType;
-    const clearMutationStateType = `${actionPrefix}clearMutationState`;
-    const clearMutationState = (mutationKeys) => ({
-        type: clearMutationStateType,
-        mutationKeys,
-    });
-    clearMutationState.type = clearMutationStateType;
-    const clearCacheType = `${actionPrefix}clearCache`;
-    const clearCache = (stateToKeep) => ({
-        type: clearCacheType,
-        stateToKeep,
-    });
-    clearCache.type = clearCacheType;
-    return {
-        updateQueryStateAndEntities,
-        updateMutationStateAndEntities,
-        mergeEntityChanges,
-        invalidateQuery,
-        clearQueryState,
-        clearMutationState,
-        clearCache,
-    };
-};
-exports.createActions = createActions;