use-state-redux 1.0.0 → 1.0.1

package/README.md

@@ -1,11 +1,11 @@
-# useReduxState
+# usestate-redux
 
 A small React global state hook built on Redux Toolkit and Redux Persist. Use a
 named state value from multiple components with an API similar to React's
 `useState`:
 
 ```tsx
-const [state, setState] = useReduxState("name", initialState);
+const [state, setState] = usestateRedux("name", initialState);
 ```
 
 The hook uses an internal Redux store, so you do not need to add a Redux
@@ -16,17 +16,17 @@ The hook uses an internal Redux store, so you do not need to add a Redux
 Install this package and its peer dependencies:
 
 ```sh
-npm install useReduxState @reduxjs/toolkit react react-redux redux-persist
+npm install use-state-redux @reduxjs/toolkit react react-redux redux-persist
 ```
 
 
 ## Basic usage
 
 ```tsx
-import { useReduxState } from "useReduxState";
+import { usestateRedux } from "usestate-redux";
 
 function Counter() {
-  const [count, setCount] = useReduxState("count", 0);
+  const [count, setCount] = usestateRedux("count", 0);
 
   return (
     <button onClick={() => setCount((current) => current + 1)}>
@@ -41,12 +41,12 @@ same value:
 
 ```tsx
 function CountLabel() {
-  const [count] = useReduxState("count", 0);
+  const [count] = usestateRedux("count", 0);
   return <p>{count}</p>;
 }
 
 function ResetCountButton() {
-  const [, setCount] = useReduxState("count", 0);
+  const [, setCount] = usestateRedux("count", 0);
   return <button onClick={() => setCount(0)}>Reset count</button>;
 }
 ```
@@ -69,7 +69,7 @@ State is not persisted by default. Set `persist: true` in the third argument to
 save a named value with Redux Persist:
 
 ```tsx
-const [theme, setTheme] = useReduxState("theme", "light", {
+const [theme, setTheme] = usestateRedux("theme", "light", {
   persist: true,
 });
 ```
@@ -87,12 +87,12 @@ enables persistence for that name for the lifetime of the app session. Keep the
 
 ## API
 
-### `useReduxState(name, initialState, options?)`
+### `usestateRedux(name, initialState, options?)`
 
 Returns a tuple of the current value and setter:
 
 ```ts
-const [state, setState] = useReduxState<T>(name, initialState, options?);
+const [state, setState] = usestateRedux<T>(name, initialState, options?);
 ```
 
 | Argument | Type | Description |
@@ -103,7 +103,7 @@ const [state, setState] = useReduxState<T>(name, initialState, options?);
 
 ### `useRedux(name, initialState, options?)`
 
-Alias for `useReduxState`.
+The `useRedux` export is an alias for `usestateRedux`.
 
 ### `setGlobalStateValue(name, value)`
 
@@ -111,7 +111,7 @@ Set a named value outside a component. The matching hook updates when the Redux
 store changes.
 
 ```ts
-import { setGlobalStateValue } from "useReduxState";
+import { setGlobalStateValue } from "usestate-redux";
 
 setGlobalStateValue("count", 10);
 ```
@@ -121,7 +121,7 @@ setGlobalStateValue("count", 10);
 Restore a registered name to the initial value from its first hook call.
 
 ```ts
-import { resetGlobalState } from "useReduxState";
+import { resetGlobalState } from "usestate-redux";
 
 resetGlobalState("count");
 ```
@@ -137,7 +137,7 @@ need direct access to the internal Redux store or persistor. For example, the
 persistor can be used to flush pending writes or purge persisted data:
 
 ```ts
-import { reduxPersistor } from "useReduxState";
+import { reduxPersistor } from "usestate-redux";
 
 await reduxPersistor.flush();
 // To remove the persisted store instead:
@@ -146,7 +146,7 @@ await reduxPersistor.flush();
 
 ## Exports
 
-- `useReduxState` and `useRedux`
+- `usestateRedux` and `useRedux`
 - `setGlobalStateValue`
 - `resetGlobalState` and `resetAllGlobalState`
 - `reduxStore` and `reduxPersistor`

package/dist/index.js

@@ -143,5 +143,5 @@ export {
   ee as resetGlobalState,
   j as setGlobalStateValue,
   K as useRedux,
-  K as useReduxState
+  K as usestateRedux
 };

package/dist/index.umd.cjs

@@ -1 +1 @@
-(function(o,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("react"),require("@reduxjs/toolkit"),require("redux-persist")):typeof define=="function"&&define.amd?define(["exports","react","@reduxjs/toolkit","redux-persist"],n):(o=typeof globalThis<"u"?globalThis:o||self,n(o.ReduxUseState={},o.React,o.ReduxToolkit,o.ReduxPersist))})(this,function(o,n,h,u){"use strict";var p={},g={};g.__esModule=!0,g.default=V;function S(e){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?S=function(r){return typeof r}:S=function(r){return r&&typeof Symbol=="function"&&r.constructor===Symbol&&r!==Symbol.prototype?"symbol":typeof r},S(e)}function b(){}var E={getItem:b,setItem:b,removeItem:b};function w(e){if((typeof self>"u"?"undefined":S(self))!=="object"||!(e in self))return!1;try{var t=self[e],r="redux-persist ".concat(e," test");t.setItem(r,"test"),t.getItem(r),t.removeItem(r)}catch{return process.env.NODE_ENV!=="production"&&console.warn("redux-persist ".concat(e," test failed, persistence will be disabled.")),!1}return!0}function V(e){var t="".concat(e,"Storage");return w(t)?self[t]:(process.env.NODE_ENV!=="production"&&console.error("redux-persist failed to create sync storage. falling back to noop storage."),E)}p.__esModule=!0,p.default=N;var k=M(g);function M(e){return e&&e.__esModule?e:{default:e}}function N(e){var t=(0,k.default)(e);return{getItem:function(s){return new Promise(function(l,d){l(t.getItem(s))})},setItem:function(s,l){return new Promise(function(d,G){d(t.setItem(s,l))})},removeItem:function(s){return new Promise(function(l,d){l(t.removeItem(s))})}}}var m=void 0,T=q(p);function q(e){return e&&e.__esModule?e:{default:e}}var x=(0,T.default)("local");m=x;const _=h.createSlice({name:"globalState",initialState:{},reducers:{setGlobalStateValue(e,t){e[t.payload.name]=t.payload.value},removeGlobalStateValue(e,t){delete e[t.payload]},resetGlobalStateValues(){return{}}}}),{setGlobalStateValue:y,removeGlobalStateValue:A,resetGlobalStateValues:D}=_.actions,O=_.reducer,R=[],v=new Set,f=new Set,P=u.persistReducer({key:"useredux",storage:m,whitelist:R},O),a=h.configureStore({reducer:P,middleware:e=>e({serializableCheck:{ignoredActions:[u.FLUSH,u.REHYDRATE,u.PAUSE,u.PERSIST,u.PURGE,u.REGISTER],ignoredPaths:["_persist"]}})}),i=new Map,C=u.persistStore(a);function U(e,t,r){i.has(e)||i.set(e,t),r.persist&&!v.has(e)&&(v.add(e),R.push(e))}function I(e,t,r={}){U(e,t,r);const s=n.useCallback(()=>{const c=a.getState();return Object.prototype.hasOwnProperty.call(c,e)&&(v.has(e)||f.has(e))?c[e]:i.get(e)},[e]),l=n.useCallback(()=>i.get(e),[e]),d=n.useSyncExternalStore(a.subscribe,s,l),G=n.useCallback(c=>{const z=s(),F=typeof c=="function"?c(z):c;f.add(e),a.dispatch(y({name:e,value:F}))},[s,e]);return[d,G]}function $(e,t){f.add(e),a.dispatch(y({name:e,value:t}))}function W(e){i.has(e)?(f.add(e),a.dispatch(y({name:e,value:i.get(e)}))):a.dispatch(A(e))}function H(){f.clear(),a.dispatch(D())}o.reduxPersistor=C,o.reduxStore=a,o.resetAllGlobalState=H,o.resetGlobalState=W,o.setGlobalStateValue=$,o.useRedux=I,o.useReduxState=I,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})});
+(function(o,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("react"),require("@reduxjs/toolkit"),require("redux-persist")):typeof define=="function"&&define.amd?define(["exports","react","@reduxjs/toolkit","redux-persist"],n):(o=typeof globalThis<"u"?globalThis:o||self,n(o.UsestateRedux={},o.React,o.ReduxToolkit,o.ReduxPersist))})(this,function(o,n,h,u){"use strict";var p={},g={};g.__esModule=!0,g.default=V;function S(e){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?S=function(r){return typeof r}:S=function(r){return r&&typeof Symbol=="function"&&r.constructor===Symbol&&r!==Symbol.prototype?"symbol":typeof r},S(e)}function b(){}var E={getItem:b,setItem:b,removeItem:b};function w(e){if((typeof self>"u"?"undefined":S(self))!=="object"||!(e in self))return!1;try{var t=self[e],r="redux-persist ".concat(e," test");t.setItem(r,"test"),t.getItem(r),t.removeItem(r)}catch{return process.env.NODE_ENV!=="production"&&console.warn("redux-persist ".concat(e," test failed, persistence will be disabled.")),!1}return!0}function V(e){var t="".concat(e,"Storage");return w(t)?self[t]:(process.env.NODE_ENV!=="production"&&console.error("redux-persist failed to create sync storage. falling back to noop storage."),E)}p.__esModule=!0,p.default=N;var k=M(g);function M(e){return e&&e.__esModule?e:{default:e}}function N(e){var t=(0,k.default)(e);return{getItem:function(s){return new Promise(function(l,d){l(t.getItem(s))})},setItem:function(s,l){return new Promise(function(d,G){d(t.setItem(s,l))})},removeItem:function(s){return new Promise(function(l,d){l(t.removeItem(s))})}}}var m=void 0,T=q(p);function q(e){return e&&e.__esModule?e:{default:e}}var x=(0,T.default)("local");m=x;const _=h.createSlice({name:"globalState",initialState:{},reducers:{setGlobalStateValue(e,t){e[t.payload.name]=t.payload.value},removeGlobalStateValue(e,t){delete e[t.payload]},resetGlobalStateValues(){return{}}}}),{setGlobalStateValue:y,removeGlobalStateValue:A,resetGlobalStateValues:D}=_.actions,O=_.reducer,R=[],v=new Set,f=new Set,P=u.persistReducer({key:"useredux",storage:m,whitelist:R},O),a=h.configureStore({reducer:P,middleware:e=>e({serializableCheck:{ignoredActions:[u.FLUSH,u.REHYDRATE,u.PAUSE,u.PERSIST,u.PURGE,u.REGISTER],ignoredPaths:["_persist"]}})}),i=new Map,C=u.persistStore(a);function U(e,t,r){i.has(e)||i.set(e,t),r.persist&&!v.has(e)&&(v.add(e),R.push(e))}function I(e,t,r={}){U(e,t,r);const s=n.useCallback(()=>{const c=a.getState();return Object.prototype.hasOwnProperty.call(c,e)&&(v.has(e)||f.has(e))?c[e]:i.get(e)},[e]),l=n.useCallback(()=>i.get(e),[e]),d=n.useSyncExternalStore(a.subscribe,s,l),G=n.useCallback(c=>{const z=s(),F=typeof c=="function"?c(z):c;f.add(e),a.dispatch(y({name:e,value:F}))},[s,e]);return[d,G]}function $(e,t){f.add(e),a.dispatch(y({name:e,value:t}))}function W(e){i.has(e)?(f.add(e),a.dispatch(y({name:e,value:i.get(e)}))):a.dispatch(A(e))}function H(){f.clear(),a.dispatch(D())}o.reduxPersistor=C,o.reduxStore=a,o.resetAllGlobalState=H,o.resetGlobalState=W,o.setGlobalStateValue=$,o.useRedux=I,o.usestateRedux=I,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})});

package/dist/src/index.d.ts

@@ -1,4 +1,3 @@
-export { resetAllGlobalState, resetGlobalState, reduxStore, reduxPersistor, setGlobalStateValue, useRedux, } from './useReduxState.js';
-export type { GlobalStateSetter, UseReduxOptions } from './useReduxState.js';
-export { useRedux as useReduxState } from './useReduxState.js';
+export { resetAllGlobalState, resetGlobalState, reduxStore, reduxPersistor, setGlobalStateValue, usestateRedux, useRedux, } from './usestateRedux.js';
+export type { GlobalStateSetter, UseReduxOptions } from './usestateRedux.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,QAAQ,GACT,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,QAAQ,GACT,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/src/{useReduxState.d.ts → usestateRedux.d.ts}

@@ -16,7 +16,7 @@ export type GlobalStateSetter<T> = Dispatch<SetStateAction<T>>;
  * name share the same value and ignore their own initial value. Persistence is
  * enabled for a name when any caller opts in; it stays enabled for that name.
  */
-export declare function useRedux<T>(name: string, initialState: T, options?: UseReduxOptions): [T, GlobalStateSetter<T>];
+export declare function usestateRedux<T>(name: string, initialState: T, options?: UseReduxOptions): [T, GlobalStateSetter<T>];
 /** Set a named global value outside a React component. */
 export declare function setGlobalStateValue<T>(name: string, value: T): void;
 /** Restore a named value to the initial value supplied to its first hook call. */
@@ -24,4 +24,5 @@ export declare function resetGlobalState(name: string): void;
 /** Reset every named value to its initial value. */
 export declare function resetAllGlobalState(): void;
 export { store as reduxStore };
-//# sourceMappingURL=useReduxState.d.ts.map
+export { usestateRedux as useRedux };
+//# sourceMappingURL=usestateRedux.d.ts.map

package/dist/src/{useReduxState.d.ts.map → usestateRedux.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"useReduxState.d.ts","sourceRoot":"","sources":["../../src/useReduxState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAatD,OAA2B,EAIzB,KAAK,WAAW,EACjB,MAAM,YAAY,CAAC;AAiBpB,QAAA,MAAM,KAAK;;oCAST,CAAC;AAGH,eAAO,MAAM,cAAc,mCAAsB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC9B,mEAAmE;IACnE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAiBD,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/D;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,CAAC,EACf,OAAO,GAAE,eAAoB,GAC5B,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAuC3B;AAED,0DAA0D;AAC1D,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAGnE;AAED,kFAAkF;AAClF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CASnD;AAED,oDAAoD;AACpD,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,CAAC"}
+{"version":3,"file":"usestateRedux.d.ts","sourceRoot":"","sources":["../../src/usestateRedux.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAatD,OAA2B,EAIzB,KAAK,WAAW,EACjB,MAAM,YAAY,CAAC;AAiBpB,QAAA,MAAM,KAAK;;oCAST,CAAC;AAGH,eAAO,MAAM,cAAc,mCAAsB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC9B,mEAAmE;IACnE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAiBD,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/D;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,CAAC,EACf,OAAO,GAAE,eAAoB,GAC5B,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAuC3B;AAED,0DAA0D;AAC1D,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAGnE;AAED,kFAAkF;AAClF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CASnD;AAED,oDAAoD;AACpD,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,CAAC;AAG/B,OAAO,EAAE,aAAa,IAAI,QAAQ,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-state-redux",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A zero-boilerplate Redux wrapper providing a useState-like global hook experience",
   "type": "module",
   "main": "./dist/index.umd.cjs",
@@ -36,4 +36,4 @@
   "dependencies": {
     "@types/redux-persist": "^4.0.0"
   }
-}
+}