react-redux-cache 0.19.1 → 0.19.3

package/README.md

@@ -11,13 +11,31 @@
 
 ### Supports both `Redux` and `Zustand` (check /example)
 
-**Powerful**, **performant** yet **lightweight** data fetching and caching library that supports **normalization** unlike `React Query` and `RTK-Query`, while having similar but not over-engineered, simple interface. Another advantage over `RTK-Query` is that it **doesn't use Immer** ([perf issue](https://github.com/reduxjs/redux-toolkit/issues/4793)). Covered with tests, fully typed and written on Typescript.
-
-**Normalization** is the best way to keep the state of the app **consistent** between different views, reduces the number of fetches and allows to show cached data when navigating, which greatly improves **user experience**.
-
-Can be considered as `ApolloClient` for protocols other than `GraphQL`, but with **full control** over its storage - redux or zustand store, with ability to write custom selectors, actions and reducers to manage cached state.
-
-Examples of states, generated by cache reducer from `/example` project:
+**Powerful**, **performant** yet **lightweight** data fetching and caching library that supports **normalization** unlike `React Query` and `RTK-Query`, while having similar but not over-engineered, simple interface. Covered with tests, fully typed and written on Typescript.
+
+Can be considered as `ApolloClient` for protocols other than `GraphQL`, but with **full control** over its store - redux or zustand.
+
+|Principle|Description|
+|--|--|
+|Full access to the store|You choose the store (redux / zustand) and have full access to state, reducer, actions, hooks, selectors and utils, used by this library, and can create your own.|
+|Supports all kinds of queries / mutations|REST, GraphQL, databases - any async operations can be cached.|
+|Fully typed|Written on TypeScript, everything is checked by compiler.|
+|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/*.js`<br/>minified: 22.9 kB<br/>gzipped: 9.06 kB<br/>brotlied: 8.07 kB|
+
+|Feature|Description|
+|--|--|
+|De-duplication of queries / mutations|Similar parallel queries are combined into one, mutations - aborted.|
+|Time to live & Invalidation|Choose how long query result can be used before expired, or clear / invalidate it manually.|
+|Deep comparison|Rendering is much heavier than deep comparison of incoming data, so it is enabled by default to prevent excess renders.|
+|Infinite pagination|Easily implemented - one or two direction.|
+|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.|
+
+#### Examples of states, generated by cache reducer from `/example` project:
 <details>
   <summary>
     Normalized

package/dist/createCache.js

@@ -36,15 +36,22 @@ const withTypenames = () => {
             (_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.storeHooks) !== null && _j !== void 0 ? _j : (partialCache.storeHooks = {
-                useStore: require('react-redux').useStore,
-                useSelector: require('react-redux').useSelector,
-            });
-            (_k = partialCache.cacheStateSelector) !== null && _k !== void 0 ? _k : (partialCache.cacheStateSelector = (state) => state[cache.name]);
-            (_l = partialCache.mutations) !== null && _l !== void 0 ? _l : (partialCache.mutations = {});
-            (_m = partialCache.queries) !== null && _m !== void 0 ? _m : (partialCache.queries = {});
+            (_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) {

package/package.json

@@ -2,16 +2,17 @@
   "name": "react-redux-cache",
   "author": "Alexander Danilov",
   "license": "MIT",
-  "version": "0.19.1",
+  "version": "0.19.3",
   "description": "Powerful data fetching and caching library for Redux and Zustand that supports normalization.",
   "main": "dist/index.js",
   "types": "dist/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__",
+    "build": "yarn clean && yarn lint && tsc && rm -rf dist/testing && rm -rf dist/__tests__ && yarn size",
+    "size": "npx minified-size dist/*.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",
@@ -20,8 +21,8 @@
   },
   "peerDependencies": {
     "fast-deep-equal": "*",
-    "react": "^16",
-    "react-redux": "^4"
+    "react": ">=16",
+    "react-redux": ">=4"
   },
   "peerDependenciesMeta": {
     "fast-deep-equal": {
@@ -47,6 +48,7 @@
     "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",