hank-zilla 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 phamdung2209
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 phamdung2209
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/README.md ADDED
@@ -0,0 +1,209 @@
1
+ # 🦖 Hank-Zilla
2
+
3
+ A lightweight React state management library that eliminates the need for Context, Redux, or Providers. Share state across components as easily as `useState` with global accessibility.
4
+
5
+ [![npm version](https://badge.fury.io/js/hank-zilla.svg)](https://badge.fury.io/js/hank-zilla)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+ [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
8
+
9
+ ## ✨ Features
10
+
11
+ - 🚀 **No Provider Required**: Share state globally without wrapping components in Providers
12
+ - 🔄 **Drop-in Replacement**: Replace `useState` with `useAppState` for global state
13
+ - 🎯 **Access Anywhere**: Use the same state in any component, anywhere in your app
14
+ - 🪶 **Lightweight**: Zero dependencies, minimal bundle size (~2.1KB)
15
+ - ⚡ **Fast**: Built on React's `useSyncExternalStore` for optimal performance
16
+ - 📦 **TypeScript**: Full TypeScript support with type inference
17
+
18
+ ## 📦 Installation
19
+
20
+ ```bash
21
+ npm install hank-zilla
22
+ ```
23
+
24
+ ## 🚀 Quick Start
25
+
26
+ ```typescript
27
+ import { useAppState, setAppState, getAppState } from 'hank-zilla'
28
+
29
+ // Parent Component - Set state
30
+ function ParentComponent() {
31
+ const user = useAppState('user', { name: '', email: '' })
32
+
33
+ return (
34
+ <div>
35
+ <button
36
+ onClick={() => setAppState('user', { name: 'John Doe', email: 'john@example.com' })}
37
+ >
38
+ Set User
39
+ </button>
40
+ <ChildComponent />
41
+ </div>
42
+ )
43
+ }
44
+
45
+ // Child Component - Access same state (no props needed!)
46
+ function ChildComponent() {
47
+ const user = useAppState('user')
48
+
49
+ return <div>{user ? `Welcome, ${user.name}!` : 'No user logged in'}</div>
50
+ }
51
+ ```
52
+
53
+ ## 📖 API Reference
54
+
55
+ ### `useAppState(key, defaultValue?, removeOnUnmount?)`
56
+
57
+ React hook for managing global state - works exactly like `useState` but globally accessible.
58
+
59
+ ```typescript
60
+ // Basic usage
61
+ const count = useAppState('count', 0)
62
+
63
+ // Auto-cleanup when component unmounts
64
+ const tempData = useAppState('tempData', null, true)
65
+
66
+ // TypeScript support
67
+ interface User {
68
+ name: string
69
+ email: string
70
+ }
71
+ const user = useAppState<User>('user', null)
72
+ ```
73
+
74
+ ### `setAppState(key, value)`
75
+
76
+ Update state from anywhere in your app - works with values or updater functions.
77
+
78
+ ```typescript
79
+ // Set value directly
80
+ setAppState('count', 42)
81
+
82
+ // Update with function (like useState)
83
+ setAppState('count', (prev) => prev + 1)
84
+
85
+ // Update object (shallow merge)
86
+ setAppState('user', { name: 'John' })
87
+
88
+ // Update array
89
+ setAppState('items', (prev) => [...prev, 'new item'])
90
+ ```
91
+
92
+ ### `getAppState(key?)`
93
+
94
+ Get state value without subscribing to changes (no re-renders).
95
+
96
+ ```typescript
97
+ // Get specific key
98
+ const currentCount = getAppState('count')
99
+
100
+ // Get all state
101
+ const allState = getAppState()
102
+
103
+ // ⚠️ Note: This doesn't trigger re-renders when state changes
104
+ ```
105
+
106
+ ### `$getAppState` (Console Helper)
107
+
108
+ Debug helper available in browser console to inspect your app state.
109
+
110
+ ```javascript
111
+ // In browser console
112
+ $getAppState // Returns all state
113
+ $getAppState('key') // Returns specific key
114
+ ```
115
+
116
+ ## 🎯 Advanced Usage
117
+
118
+ ### Auto-cleanup with `removeOnUnmount`
119
+
120
+ ```typescript
121
+ function TemporaryComponent() {
122
+ // This state will be deleted when component unmounts
123
+ const [data, setData] = useAppState('tempData', [], true)
124
+
125
+ return <div>Temporary data: {data.length} items</div>
126
+ }
127
+ ```
128
+
129
+ ### TypeScript Support
130
+
131
+ ```typescript
132
+ interface CartItem {
133
+ id: string
134
+ name: string
135
+ price: number
136
+ }
137
+
138
+ // Type inference
139
+ const [cart, setCart] = useAppState<CartItem[]>('cart', [])
140
+
141
+ // Add item with type safety
142
+ const addItem = (item: CartItem) => {
143
+ setCart((prev) => [...prev, item])
144
+ }
145
+ ```
146
+
147
+ ### Performance: When to use `getAppState`
148
+
149
+ ```typescript
150
+ // ✅ Good: Use useAppState for UI components
151
+ function Counter() {
152
+ const [count, setCount] = useAppState('count', 0)
153
+ return <div>Count: {count}</div> // Re-renders when count changes
154
+ }
155
+
156
+ // ✅ Good: Use getAppState for utilities/callbacks
157
+ function logCurrentState() {
158
+ const count = getAppState('count')
159
+ console.log('Current count:', count) // No re-renders
160
+ }
161
+ ```
162
+
163
+ ## 📊 Comparison
164
+
165
+ | Feature | Hank-Zilla | Context API | Redux | Zustand |
166
+ | ----------------- | ----------- | ----------------- | ------------------ | ----------- |
167
+ | **Setup** | ❌ None | ✅ Provider | ✅ Store + Actions | ✅ Store |
168
+ | **Bundle Size** | 🟢 ~2.1KB | 🟢 Built-in | 🔴 ~45KB | 🟡 ~8KB |
169
+ | **Global Access** | ✅ Anywhere | ❌ Provider scope | ✅ Anywhere | ✅ Anywhere |
170
+ | **TypeScript** | 🟢 Full | 🟡 Manual | 🟢 Full | 🟢 Full |
171
+
172
+ ## 🔧 Migration
173
+
174
+ ### From `useState` to `useAppState`
175
+
176
+ ```typescript
177
+ // Before: Local state
178
+ const [count, setCount] = useState(0)
179
+
180
+ // After: Global state
181
+ const count = useAppState('count', 0)
182
+ ```
183
+
184
+ ### From Context API
185
+
186
+ ```typescript
187
+ // Before: Complex setup
188
+ const UserContext = createContext()
189
+ const { user, setUser } = useContext(UserContext)
190
+
191
+ // After: Direct usage
192
+ const user = useAppState('user', null)
193
+ ```
194
+
195
+ ## 🤝 Contributing
196
+
197
+ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
198
+
199
+ ## 📄 License
200
+
201
+ MIT License - see the [LICENSE](LICENSE) file for details.
202
+
203
+ ## 🙏 Acknowledgments
204
+
205
+ Built with ❤️ by [phamdung2209](https://github.com/phamdung2209) • Special thanks to the React team for `useSyncExternalStore`
206
+
207
+ ---
208
+
209
+ Made with 🦖 by the Hank-Zilla team
@@ -0,0 +1 @@
1
+ import{useEffect,useSyncExternalStore}from"react";import init$ from"./init$";const listeners=new Set,store={state:{},getState:()=>store.state,subscribe:t=>(listeners.add(t),()=>listeners.delete(t)),setState:(t,e)=>{store.state={...store.state,...Object.entries(t).reduce((t,[e,s])=>{const r=store.state[e];return t[e]="function"==typeof s?s(r):"object"==typeof s&&null!==s?Array.isArray(s)?Array.isArray(r)?[...r,...s]:[...s]:0===Object.keys(s).length?s:{...r||{},...s}:s,t},{})},e||listeners.forEach(t=>t())}};export const useAppState=(t,e,s=!1,r)=>(t in store.state||void 0===e||store.setState({[t]:e},r),useEffect(()=>()=>{s&&deleteAppState(t)},[t,s]),useSyncExternalStore(store.subscribe,()=>store.state[t]??e,()=>e));export const setAppState=(t,e,s)=>{store.setState({[t]:e},s)};export const getAppState=t=>void 0===t?store.getState():store.getState()[t];export const deleteAppState=t=>{t in store.state&&delete store.state[t]};init$({getAppState:getAppState});export default store;
@@ -0,0 +1,17 @@
1
+ const init$ = (() => {
2
+ const $ = (k, v) => {
3
+ if (k in globalThis)
4
+ delete globalThis[k];
5
+ Object.defineProperty(globalThis, k, { value: v, configurable: true });
6
+ };
7
+ const deleteKey = (k) => {
8
+ if (!k.startsWith('$'))
9
+ k = `$${k}`;
10
+ if (k in globalThis)
11
+ delete globalThis[k];
12
+ };
13
+ const service = ((s) => Object.entries(s).forEach(([k, v]) => $(`$${k}`, v)));
14
+ service.delete = (keys) => Array.isArray(keys) ? keys.forEach(deleteKey) : deleteKey(keys);
15
+ return service;
16
+ })();
17
+ export default init$;
package/package.json CHANGED
@@ -1,19 +1,19 @@
1
1
  {
2
2
  "name": "hank-zilla",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "description": "A lightweight React state management library with modular architecture",
5
- "main": "dist/index.min.js",
6
- "module": "dist/index.min.js",
5
+ "main": "dist/index.js",
6
+ "module": "dist/index.js",
7
7
  "types": "dist/index.d.ts",
8
8
  "exports": {
9
9
  ".": {
10
- "import": "./dist/index.min.js",
11
- "require": "./dist/index.min.js",
10
+ "import": "./dist/index.js",
11
+ "require": "./dist/index.js",
12
12
  "types": "./dist/index.d.ts"
13
13
  },
14
14
  "./useAppState": {
15
- "import": "./dist/useAppState/index.min.js",
16
- "require": "./dist/useAppState/index.min.js",
15
+ "import": "./dist/useAppState/index.js",
16
+ "require": "./dist/useAppState/index.js",
17
17
  "types": "./dist/useAppState/index.d.ts"
18
18
  },
19
19
  "./package.json": "./package.json"
@@ -24,13 +24,17 @@
24
24
  "LICENSE"
25
25
  ],
26
26
  "scripts": {
27
- "build": "npm run clean && tsc --project tsconfig.json && npm run minify && npm run cleanup",
28
- "minify": "terser dist/index.js --compress --mangle --output dist/index.min.js && terser dist/useAppState/index.js --compress --mangle --output dist/useAppState/index.min.js",
29
- "cleanup": "rimraf dist/index.js dist/useAppState/index.js dist/useAppState/appState.js dist/useAppState/init$.js",
27
+ "build": "npm run clean && tsc && npm run minify && npm run copy-files",
28
+ "minify": "npm run minify-index && npm run minify-useappstate",
29
+ "minify-index": "terser dist/index.js -o dist/index.js -c -m",
30
+ "minify-useappstate": "terser dist/useAppState/index.js -o dist/useAppState/index.js -c -m && terser dist/useAppState/appState.js -o dist/useAppState/appState.js -c -m",
31
+ "copy-files": "npm run copy-readme && npm run copy-license",
32
+ "copy-readme": "cp README.md dist/ || copy README.md dist\\",
33
+ "copy-license": "cp LICENSE dist/ || copy LICENSE dist\\ || echo 'LICENSE not found'",
30
34
  "dev": "tsc --watch",
31
35
  "clean": "rimraf dist",
32
- "prebuild": "npm run clean",
33
36
  "prepublishOnly": "npm run build",
37
+ "postbuild": "ls -la dist || dir dist",
34
38
  "test": "echo \"Error: no test specified\" && exit 1"
35
39
  },
36
40
  "keywords": [
File without changes
File without changes