@lavaz/store 1.0.2

package/README.md

@@ -0,0 +1,94 @@
+# @lavaz/store 🚀
+
+![Lavaz Store Logo](https://github.com/huylongnguyendev/lavaz-store/blob/main/assets/logo-80.png)
+
+A lightweight, high-level state management infrastructure for React and JavaScript applications. Designed for complex workspaces, not just simple kanbans.
+
+[![npm version](https://img.shields.io/npm/v/@lavaz/store/beta)](https://www.npmjs.com/package/@lavaz/store)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@lavaz/store)](https://bundlephobia.com/package/@lavaz/store)
+
+## ✨ Features
+
+- **Ultra Lightweight**: Less than 3kB gzipped.
+- **Type-safe**: Built with TypeScript for excellent developer experience.
+- **High Performance**: Optimized with `useSyncExternalStore` and shallow comparison to prevent unnecessary re-renders.
+- **Zero Configuration**: Easy to set up and integrate into any project.
+
+## 📦 Installation
+
+```bash
+pnpm add @lavaz/store
+# or
+npm install @lavaz/store
+# or
+yarn add @lavaz/store
+# or
+bun add @lavaz/store@beta
+```
+
+# 🚀 Quick Start
+
+## 1. Create a Box
+A "Box" is where your state and actions live.
+
+```bash
+import { createBox } from "@lavaz/store";
+
+export const counterBox = createBox({
+  state: { count: 0 },
+  actions: (set) => ({
+    inc: () => set((s) => ({ count: s.count + 1 })),
+    dec: () => set((s) => ({ count: s.count - 1 })),
+  }),
+});
+```
+
+## 2. Create a store
+A "Store" is the central hub that manages multiple boxes. It provides a unified interface to access your state and actions across the entire workspace.
+
+```bash
+import { createStore } from "@lavaz/store";
+import { authBox } from "./boxes/authBox";
+import { projectBox } from "./boxes/projectBox";
+
+// Initialize your global workspace store
+export const store = createStore({
+  auth: authBox,
+  projects: projectBox,
+  // You can add more boxes as your workspace grows
+});
+```
+
+## 3. Use in React
+Use the `useAppStore` hook with a selector for optimal performance.
+
+```bash
+import { useAppStore } from "@lavaz/store";
+import { counterBox } from "./counterBox";
+
+const Counter = () => {
+  // Only re-renders if 'count' changes
+  const [count, { inc, dec }] = useAppStore(counterBox, (s) => s.count);
+
+  return (
+    <div>
+      <h1>{count}</h1>
+      <button onClick={inc}>+</button>
+      <button onClick={dec}>-</button>
+    </div>
+  );
+};
+```
+
+## 🛠 Advanced: Shallow Comparison
+Lavaz automatically performs a shallow check on the data returned by your selector.
+
+```bash
+const [user] = useAppStore(userBox, (s) => ({
+  name: s.name,
+  age: s.age
+}));
+```
+
+# 📄 License
+MIT © [Nguyen Huy Long/Lavaz Ecosystem]

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }var S=e=>e!==null&&typeof e=="object"&&!Array.isArray(e),d= exports.validateState =(e,r,o,s=new WeakSet)=>{if(e===void 0)throw new Error(`[Lavaz]: ${r} cannot be undefined.`);if(typeof e=="function")throw new Error(`[Lavaz]: ${r} cannot be a function.`);if(S(e)){if(s.has(e))return;s.add(e);let t=Object.keys(e);if(o&&t.length===0)throw new Error("[Lavaz]: `initialState` cannot be an empty object.");for(let i of t)d(e,`${r}.${i}`,!1,s)}Array.isArray(e)&&e.forEach((t,i)=>{d(t,`${r}[${i}]`,!1,s)})};var v=(e,r)=>{let o=typeof process<"u"&&process.env.NODE_ENV==="production"||typeof import.meta<"u"&&import.meta.env.NODE_ENV==="production",s=typeof process<"u"&&(process.env.NODE_ENV==="test"||!!process.env.VITEST),t=null,i={persist:(n,c="local")=>(t={name:n,storage:c},i),create:()=>{(!o||s)&&d(e,"initialState",!0);let n=e,c=new Set,f=t?`lavaz-${t.name}`:null,p=_optionalChain([t, 'optionalAccess', _ => _.storage])==="session"?window.sessionStorage:window.localStorage;if(typeof window<"u"&&f)try{let a=p.getItem(f);a&&(n=JSON.parse(a))}catch (e2){o||console.warn(`[Lavaz]: Hydration failed for ${f}`)}let l=r(a=>{let u=typeof a=="function"?a(n):a;if(u===void 0)throw new Error("[Lavaz]: Cannot update `state` to `undefined`.");Object.is(n,u)||(n=u,f&&p.setItem(f,JSON.stringify(n)),c.forEach(m=>m(n)))});return{getState:()=>n,dispatch:l,subscribe:a=>(c.add(a),()=>c.delete(a)),boxId:_optionalChain([t, 'optionalAccess', _2 => _2.name])||`box-${Math.random().toString(36).substring(2,9)}`}}};return i};var $=e=>{let r=typeof process<"u"&&process.env.NODE_ENV==="production"||typeof import.meta<"u"&&import.meta.env.NODE_ENV==="production",o=typeof process<"u"&&(process.env.NODE_ENV==="test"||!!process.env.VITEST);if(!r||o){if(Object.keys(e).length===0)throw new Error("[Lavaz]: `store` cannot be an empty object.");let t=new Map;for(let[i,n]of Object.entries(e)){let c=t.get(n.boxId);if(c)throw new Error(`[Lavaz]: Conflict. The box you are trying to assign to "${i}" is already used by "${c}`);t.set(n.boxId,i)}}return e};var _react = require('react');var y=(e,r)=>{if(Object.is(e,r))return!0;if(typeof e!="object"||e===null||typeof r!="object"||r===null)return!1;let o=Object.keys(e),s=Object.keys(r);if(o.length!==s.length)return!1;for(let t=0;t<=o.length;t++)if(!Object.prototype.hasOwnProperty.call(r,o[t])||Object.is(e[o[t]],r[o[t]]))return!1;return!0};var z=(e,r=o=>o)=>{let o=_react.useRef.call(void 0, void 0),s=_react.useCallback.call(void 0, ()=>{let n=r(e.getState());return o.current===void 0||!y(o,n)?(o.current=n,n):o.current},[r,e]),t=_react.useSyncExternalStore.call(void 0, e.subscribe,s,s),i=_react.useMemo.call(void 0, ()=>e.dispatch,[e.dispatch]);return[t,i]};exports.createBox = v; exports.createStore = $; exports.shallowCompare = y; exports.useAppStore = z; exports.validateState = d;

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+type PrevFn<S> = (prev: S) => S;
+type Next<S> = S | PrevFn<S>;
+type Subscribe<S> = (cb: (state: S) => void) => () => void;
+interface CreateBox<S = unknown, A = unknown> {
+    getState: () => S;
+    dispatch: A;
+    subscribe: Subscribe<S>;
+    boxId: string;
+}
+interface BoxBuilder<S, A> {
+    persist: (name: string, storage?: "local" | "session") => BoxBuilder<S, A>;
+    create: () => CreateBox<S, A>;
+}
+
+declare const createBox: <S, A>(initialState: S, actions: (set: (next: Next<S>) => void) => A) => BoxBuilder<S, A>;
+
+declare const createStore: <T extends Record<string, CreateBox>>(boxes: T) => T;
+
+declare const useAppStore: <S, A, R>(box: CreateBox<S, A>, selector?: (state: S) => R) => [R, A];
+
+declare const validateState: (val: any, path: string, isRoot: boolean, seen?: WeakSet<WeakKey>) => void;
+
+declare const shallowCompare: (prevObj: any, newObj: any) => boolean;
+
+interface Persistance {
+    name: string;
+    storage?: "local" | "session";
+}
+
+export { type BoxBuilder, type CreateBox, type Next, type Persistance, type PrevFn, type Subscribe, createBox, createStore, shallowCompare, useAppStore, validateState };

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+type PrevFn<S> = (prev: S) => S;
+type Next<S> = S | PrevFn<S>;
+type Subscribe<S> = (cb: (state: S) => void) => () => void;
+interface CreateBox<S = unknown, A = unknown> {
+    getState: () => S;
+    dispatch: A;
+    subscribe: Subscribe<S>;
+    boxId: string;
+}
+interface BoxBuilder<S, A> {
+    persist: (name: string, storage?: "local" | "session") => BoxBuilder<S, A>;
+    create: () => CreateBox<S, A>;
+}
+
+declare const createBox: <S, A>(initialState: S, actions: (set: (next: Next<S>) => void) => A) => BoxBuilder<S, A>;
+
+declare const createStore: <T extends Record<string, CreateBox>>(boxes: T) => T;
+
+declare const useAppStore: <S, A, R>(box: CreateBox<S, A>, selector?: (state: S) => R) => [R, A];
+
+declare const validateState: (val: any, path: string, isRoot: boolean, seen?: WeakSet<WeakKey>) => void;
+
+declare const shallowCompare: (prevObj: any, newObj: any) => boolean;
+
+interface Persistance {
+    name: string;
+    storage?: "local" | "session";
+}
+
+export { type BoxBuilder, type CreateBox, type Next, type Persistance, type PrevFn, type Subscribe, createBox, createStore, shallowCompare, useAppStore, validateState };

package/dist/index.js

@@ -0,0 +1 @@
+var S=e=>e!==null&&typeof e=="object"&&!Array.isArray(e),d=(e,r,o,s=new WeakSet)=>{if(e===void 0)throw new Error(`[Lavaz]: ${r} cannot be undefined.`);if(typeof e=="function")throw new Error(`[Lavaz]: ${r} cannot be a function.`);if(S(e)){if(s.has(e))return;s.add(e);let t=Object.keys(e);if(o&&t.length===0)throw new Error("[Lavaz]: `initialState` cannot be an empty object.");for(let i of t)d(e,`${r}.${i}`,!1,s)}Array.isArray(e)&&e.forEach((t,i)=>{d(t,`${r}[${i}]`,!1,s)})};var v=(e,r)=>{let o=typeof process<"u"&&process.env.NODE_ENV==="production"||typeof import.meta<"u"&&import.meta.env.NODE_ENV==="production",s=typeof process<"u"&&(process.env.NODE_ENV==="test"||!!process.env.VITEST),t=null,i={persist:(n,c="local")=>(t={name:n,storage:c},i),create:()=>{(!o||s)&&d(e,"initialState",!0);let n=e,c=new Set,f=t?`lavaz-${t.name}`:null,p=t?.storage==="session"?window.sessionStorage:window.localStorage;if(typeof window<"u"&&f)try{let a=p.getItem(f);a&&(n=JSON.parse(a))}catch{o||console.warn(`[Lavaz]: Hydration failed for ${f}`)}let l=r(a=>{let u=typeof a=="function"?a(n):a;if(u===void 0)throw new Error("[Lavaz]: Cannot update `state` to `undefined`.");Object.is(n,u)||(n=u,f&&p.setItem(f,JSON.stringify(n)),c.forEach(m=>m(n)))});return{getState:()=>n,dispatch:l,subscribe:a=>(c.add(a),()=>c.delete(a)),boxId:t?.name||`box-${Math.random().toString(36).substring(2,9)}`}}};return i};var $=e=>{let r=typeof process<"u"&&process.env.NODE_ENV==="production"||typeof import.meta<"u"&&import.meta.env.NODE_ENV==="production",o=typeof process<"u"&&(process.env.NODE_ENV==="test"||!!process.env.VITEST);if(!r||o){if(Object.keys(e).length===0)throw new Error("[Lavaz]: `store` cannot be an empty object.");let t=new Map;for(let[i,n]of Object.entries(e)){let c=t.get(n.boxId);if(c)throw new Error(`[Lavaz]: Conflict. The box you are trying to assign to "${i}" is already used by "${c}`);t.set(n.boxId,i)}}return e};import{useCallback as g,useMemo as x,useRef as h,useSyncExternalStore as w}from"react";var y=(e,r)=>{if(Object.is(e,r))return!0;if(typeof e!="object"||e===null||typeof r!="object"||r===null)return!1;let o=Object.keys(e),s=Object.keys(r);if(o.length!==s.length)return!1;for(let t=0;t<=o.length;t++)if(!Object.prototype.hasOwnProperty.call(r,o[t])||Object.is(e[o[t]],r[o[t]]))return!1;return!0};var z=(e,r=o=>o)=>{let o=h(void 0),s=g(()=>{let n=r(e.getState());return o.current===void 0||!y(o,n)?(o.current=n,n):o.current},[r,e]),t=w(e.subscribe,s,s),i=x(()=>e.dispatch,[e.dispatch]);return[t,i]};export{v as createBox,$ as createStore,y as shallowCompare,z as useAppStore,d as validateState};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@lavaz/store",
+  "version": "1.0.2",
+  "description": "",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "test": "vitest",
+    "dev": "tsup --watch",
+    "build": "npm run clean && tsup src/index.ts --format esm,cjs --dts --clean --external react --minify --splitting",
+    "release:patch": "npm run build && npm version patch && npm publish --access public --tag beta"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [],
+  "author": "Nguyen Huy Long",
+  "license": "ISC",
+  "packageManager": "pnpm@10.32.1",
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/node": "^25.5.0",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.1",
+    "jsdom": "^29.0.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "rimraf": "^6.1.3",
+    "rslib": "^0.0.10",
+    "tsc-alias": "^1.8.16",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
+  }
+}