stunk 2.2.3 → 2.3.0

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.
Files changed (4) hide show
  1. package/LICENSE +27 -27
  2. package/README.md +204 -43
  3. package/dist/index.cjs +1 -1
  4. package/package.json +111 -100
package/LICENSE CHANGED
@@ -1,27 +1,27 @@
1
- ---
2
-
3
- ### **`LICENSE`**
4
-
5
- ```text
6
- MIT License
7
-
8
- Copyright (c) 2025 AbdulAzeez
9
-
10
- Permission is hereby granted, free of charge, to any person obtaining a copy
11
- of this software and associated documentation files (the "Software"), to deal
12
- in the Software without restriction, including without limitation the rights
13
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
- copies of the Software, and to permit persons to whom the Software is
15
- furnished to do so, subject to the following conditions:
16
-
17
- The above copyright notice and this permission notice shall be included in all
18
- copies or substantial portions of the Software.
19
-
20
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
- SOFTWARE.
27
- ```
1
+ ---
2
+
3
+ ### **`LICENSE`**
4
+
5
+ ```text
6
+ MIT License
7
+
8
+ Copyright (c) 2025 AbdulAzeez
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+ ```
package/README.md CHANGED
@@ -1,43 +1,204 @@
1
- # Stunk
2
-
3
- Stunk is a lightweight, framework-agnostic state management library built on atomic state principles. It simplifies state management by breaking state into manageable "chunks", ensuring efficient updates and reactivity.
4
-
5
- - **Pronunciation**: _Stunk_ (A playful blend of "state" and "chunk")
6
-
7
- **Stunk** is like dividing your jar into many smaller containers, each holding a single piece of state. These smaller containers are called **chunks**. Each **chunk** can be updated and accessed easily, and any part of your app can subscribe to changes in a chunk so it gets updated automatically.
8
-
9
- ## Features
10
-
11
- - 🚀 **Lightweight and Fast**: No dependencies, minimal overhead
12
- - 🔄 **Reactive**: Automatic updates when state changes
13
- - 📦 **Batch Updates**: Group multiple state updates together
14
- - 🎯 **Atomic State Management**: Break down state into manageable chunks
15
- - 🎭 **State Selection**: Select and derive specific parts of the state
16
- - 🔄 **Async Support**: Handle async state with built-in loading and error states
17
- - 🔌 **Middleware Support**: Extend functionality with custom middleware
18
- - ⏱️ **Time Travel**: Undo/redo state changes
19
- - 🔍 **Type-Safe**: Written in TypeScript with full type inference
20
-
21
- ## Installation
22
-
23
- ```bash
24
- npm install stunk
25
- # or
26
- yarn add stunk
27
- # or
28
- pnpm install stunk
29
- ```
30
-
31
- Read Docs:
32
-
33
- [Stunk](https://stunk.vercel.app/)
34
-
35
- ## Contributing
36
-
37
- Contributions are welcome! Please feel free to submit a Pull Request.
38
-
39
- [Pull Request](https://github.com/I-am-abdulazeez/stunk/pulls)
40
-
41
- ## License
42
-
43
- This is licence under MIT
1
+ # Stunk
2
+
3
+ Stunk is a lightweight, framework-agnostic state management library built on atomic state principles. It simplifies state management by breaking state into manageable "chunks", ensuring efficient updates and reactivity.
4
+
5
+ - **Pronunciation**: _Stunk_ (A playful blend of "state" and "chunk")
6
+
7
+ **Stunk** is like dividing your jar into many smaller containers, each holding a single piece of state. These smaller containers are called **chunks**. Each **chunk** can be updated and accessed easily, and any part of your app can subscribe to changes in a chunk so it gets updated automatically.
8
+
9
+ ## Features
10
+
11
+ - 🚀 **Lightweight and Fast**: No dependencies, minimal overhead
12
+ - 🔄 **Reactive**: Automatic updates when state changes
13
+ - 📦 **Batch Updates**: Group multiple state updates together
14
+ - 🎯 **Atomic State Management**: Break down state into manageable chunks
15
+ - 🎭 **State Selection**: Select and derive specific parts of the state
16
+ - 🔄 **Async Support**: Handle async state with built-in loading and error states
17
+ - 🔌 **Middleware Support**: Extend functionality with custom middleware
18
+ - ⏱️ **Time Travel**: Undo/redo state changes
19
+ - 🔍 **Type-Safe**: Written in TypeScript with full type inference
20
+
21
+ ## Installation
22
+
23
+ ```bash
24
+ npm install stunk
25
+ # or
26
+ yarn add stunk
27
+ # or
28
+ pnpm install stunk
29
+ ```
30
+
31
+ Read Docs:
32
+
33
+ [Stunk](https://stunk.vercel.app/)
34
+
35
+ ## Creating a Chunk
36
+
37
+ ```typescript
38
+ import { chunk } from "stunk";
39
+
40
+ // Create a chunk holding a number
41
+ const count = chunk(0);
42
+
43
+ // Create a chunk holding a string
44
+ const name = chunk("Stunky, chunky");
45
+ ```
46
+
47
+ 👉 [See full explanation in docs](https://stunk.vercel.app/chunk.html)
48
+
49
+ ## Interacting with a Chunk
50
+
51
+ ```typescript
52
+ // Get value
53
+ console.log(count.get()); // 0
54
+
55
+ // Set a new value
56
+ count.set(10);
57
+
58
+ // Update based on the previous value
59
+ count.set((prev) => prev + 1);
60
+
61
+ // Reset to the initial value
62
+ count.reset();
63
+
64
+ // Destroy the chunk and all its subscribers.
65
+ count.destroy();
66
+ ```
67
+
68
+ 👉 [See full explanation in docs](https://stunk.vercel.app/chunk.html)
69
+
70
+ ## React via useChunk
71
+
72
+ The `useChunk` hook, enables components to reactively read and update state from a Chunk. The counter example below depicts
73
+
74
+ ```typescript
75
+ import { chunk } from "stunk";
76
+ import { useChunk } from "stunk/react";
77
+
78
+ const count = chunk(0);
79
+
80
+ const Counter = () => {
81
+ const [value, set, reset] = useChunk(count);
82
+
83
+ return (
84
+ <div>
85
+ <p>Count: {value}</p>
86
+ <button onClick={() => set((prev) => prev + 1)}>Increment</button>
87
+ <button onClick={() => reset()}>Reset</button>
88
+ </div>
89
+ );
90
+ };
91
+ ```
92
+
93
+ 👉 [See full explanation in docs](https://stunk.vercel.app/useChunk.html)
94
+
95
+ ## React via useDerive
96
+
97
+ Hook that lets you create a read-only derived state from a Chunk. It keeps the derived value reactive, automatically updating whenever the source Chunk changes.
98
+
99
+ ```typescript
100
+ import { chunk } from "stunk";
101
+ import { useDerive } from "stunk/react";
102
+
103
+ const count = chunk(0);
104
+
105
+ const DoubledCount = () => {
106
+ const double = useDerive(count, (value) => value * 2);
107
+
108
+ return <p>Double: {double}</p>;
109
+ };
110
+ ```
111
+
112
+ 👉 [See full explanation in docs](https://stunk.vercel.app/useDerive.html)
113
+
114
+ ## React via useComputed
115
+
116
+ Hook that derives a computed value from one or more Chunks. It automatically re-evaluates whenever any of its dependencies change, ensuring efficient and reactive updates.
117
+
118
+ ```typescript
119
+ import { chunk } from "stunk";
120
+ import { useComputed } from "stunk/react";
121
+
122
+ const count = chunk(2);
123
+ const multiplier = chunk(3);
124
+
125
+ const ComputedExample = () => {
126
+ const product = useComputed([count, multiplier], (c, m) => c * m);
127
+
128
+ return <p>Product: {product}</p>;
129
+ };
130
+ ```
131
+
132
+ 👉 [See full explanation in docs](https://stunk.vercel.app/useComputed.html)
133
+
134
+ ## React via useAsyncChunk
135
+
136
+ Hook that manages that manages asynchronous state. It offers built-in reactivity, handling loading, error, and data states, ensuring the UI stays in sync with asynchronous operations.
137
+
138
+ ```typescript
139
+ import { asyncChunk } from "stunk";
140
+ import { useAsyncChunk } from "stunk/react";
141
+
142
+ const fetchUser = asyncChunk(async () => {
143
+ const res = await fetch("https://jsonplaceholder.typicode.com/users/1");
144
+ return res.json();
145
+ });
146
+
147
+ const UserProfile = () => {
148
+ const { data, loading, error, reload } = useAsyncChunk(fetchUser);
149
+
150
+ if (loading) return <p>Loading...</p>;
151
+ if (error) return <p>Error: {error.message}</p>;
152
+
153
+ return (
154
+ <div>
155
+ <h2>{data.name}</h2>
156
+ <p>{data.email}</p>
157
+ <button onClick={reload}>Reload</button>
158
+ </div>
159
+ );
160
+ };
161
+ ```
162
+
163
+ 👉 [See full explanation in docs](https://stunk.vercel.app/useAysncChunk.html)
164
+
165
+ ## React via useChunkValue
166
+
167
+ Hook that subscribes to a Chunk and returns its current value. It is useful for read-only components that don’t need to modify the state.
168
+
169
+ ```typescript
170
+ import { chunk } from "stunk";
171
+ import { useChunkValue } from "stunk/react";
172
+
173
+ const count = chunk(0);
174
+
175
+ const CounterDisplay = () => {
176
+ const value = useChunkValue(count);
177
+
178
+ return <p>Count: {value}</p>;
179
+ };
180
+ ```
181
+
182
+ 👉 [See full explanation in docs](https://stunk.vercel.app/read-only-values.html)
183
+
184
+ Live Examples:
185
+
186
+ 👉 [Visit](https://stunk-examples.vercel.app/)
187
+
188
+ Coding Examples:
189
+
190
+ 👉 [Visit](https://stunk.vercel.app/examples.html)
191
+
192
+ Further Examples:
193
+
194
+ 👉 [Visit](https://github.com/I-am-abdulazeez/stunk-examples/)
195
+
196
+ ## Contributing
197
+
198
+ Contributions are welcome! Please feel free to submit a Pull Request.
199
+
200
+ [Pull Request](https://github.com/I-am-abdulazeez/stunk/pulls)
201
+
202
+ ## License
203
+
204
+ This is licence under MIT
package/dist/index.cjs CHANGED
@@ -1 +1 @@
1
- 'module.exports = require("./index.js");'
1
+ module.exports = require("./index.js");
package/package.json CHANGED
@@ -1,100 +1,111 @@
1
- {
2
- "name": "stunk",
3
- "version": "2.2.3",
4
- "description": "Stunk is a lightweight, framework-agnostic state management library for JavaScript and TypeScript. It uses chunk-based state units for efficient updates, reactivity, and performance optimization in React, Vue, Svelte, and Vanilla JS/TS applications.",
5
- "scripts": {
6
- "build": "tsc --project tsconfig.json && npm run build:cjs",
7
- "build:cjs": "echo 'module.exports = require(\"./index.js\");' > dist/index.cjs",
8
- "test": "tsc --project tsconfig.test.json && vitest",
9
- "prepublishOnly": "vitest && tsc",
10
- "prepare": "npm run build",
11
- "lint": "eslint . --ext .js,.ts,.tsx,.vue"
12
- },
13
- "type": "module",
14
- "repository": {
15
- "type": "git",
16
- "url": "https://github.com/I-am-abdulazeez/stunk"
17
- },
18
- "homepage": "https://stunk.vercel.app/",
19
- "bugs": {
20
- "url": "https://github.com/I-am-abdulazeez/stunk/issues"
21
- },
22
- "main": "dist/index.js",
23
- "types": "dist/index.d.ts",
24
- "files": [
25
- "dist"
26
- ],
27
- "exports": {
28
- ".": {
29
- "types": "./dist/index.d.ts",
30
- "import": "./dist/index.js",
31
- "require": "./dist/index.cjs"
32
- },
33
- "./middleware": {
34
- "types": "./dist/types/middleware/index.d.ts",
35
- "import": "./dist/middleware/index.js"
36
- },
37
- "./react": {
38
- "types": "./dist/types/use-react/index.d.ts",
39
- "import": "./dist/use-react/index.js"
40
- },
41
- "./vue": {
42
- "types": "./dist/types/use-vue/index.d.ts",
43
- "import": "./dist/use-vue/index.js"
44
- },
45
- "./package.json": "./package.json"
46
- },
47
- "keywords": [
48
- "state-management",
49
- "atomic-state",
50
- "chunk-based state",
51
- "framework-agnostic",
52
- "reactive state library",
53
- "frontend state management",
54
- "JavaScript state management",
55
- "TypeScript state management",
56
- "React state management",
57
- "Vue state management",
58
- "Svelte state management",
59
- "recoil alternative",
60
- "jotai alternative",
61
- "zustand alternative",
62
- "lightweight state management",
63
- "state container",
64
- "reusable state",
65
- "efficient state updates",
66
- "performance optimization",
67
- "stunk",
68
- "chunk"
69
- ],
70
- "author": "AbdulAzeez",
71
- "contributors": [
72
- {
73
- "name": "AbdulAzeez",
74
- "url": "https://github.com/I-am-abdulazeez"
75
- }
76
- ],
77
- "license": "MIT",
78
- "devDependencies": {
79
- "@testing-library/dom": "^10.4.0",
80
- "@testing-library/react": "^16.2.0",
81
- "@testing-library/vue": "^8.1.0",
82
- "@types/react": "^19.0.10",
83
- "@typescript-eslint/eslint-plugin": "^8.26.1",
84
- "@typescript-eslint/parser": "^8.27.0",
85
- "@vitejs/plugin-react": "^4.3.4",
86
- "@vitejs/plugin-vue": "^5.2.1",
87
- "eslint": "^9.22.0",
88
- "eslint-plugin-react-hooks": "^5.2.0",
89
- "jsdom": "^26.0.0",
90
- "react": "^19.0.0",
91
- "react-dom": "^19.0.0",
92
- "typescript": "^5.0.0",
93
- "vitest": "^3.0.8",
94
- "vue": "^3.5.13"
95
- },
96
- "peerDependencies": {
97
- "react": "^19.0.0",
98
- "vue": "^3.5.13"
99
- }
100
- }
1
+ {
2
+ "name": "stunk",
3
+ "version": "2.3.0",
4
+ "description": "Stunk is a lightweight, framework-agnostic state management library for JavaScript and TypeScript. It uses chunk-based state units for efficient updates, reactivity, and performance optimization in React, Vue, Svelte, and Vanilla JS/TS applications.",
5
+ "scripts": {
6
+ "build": "tsc --project tsconfig.json && npm run build:cjs",
7
+ "build:cjs": "echo 'module.exports = require(\"./index.js\");' > dist/index.cjs",
8
+ "test": "tsc --project tsconfig.test.json && vitest",
9
+ "test:react17": "npm install react@^17.0.0 react-dom@^17.0.0 @types/react@^17.0.0 && npm test",
10
+ "test:react18": "npm install react@^18.0.0 react-dom@^18.0.0 @types/react@^18.0.0 && npm test",
11
+ "test:react19": "npm install react@^19.0.0 react-dom@^19.0.0 @types/react@^19.0.0 && npm test",
12
+ "prepublishOnly": "vitest && tsc",
13
+ "prepare": "npm run build",
14
+ "lint": "eslint . --ext .js,.ts,.tsx,.vue"
15
+ },
16
+ "type": "module",
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "https://github.com/I-am-abdulazeez/stunk"
20
+ },
21
+ "homepage": "https://stunk.vercel.app/",
22
+ "bugs": {
23
+ "url": "https://github.com/I-am-abdulazeez/stunk/issues"
24
+ },
25
+ "main": "dist/index.js",
26
+ "types": "dist/index.d.ts",
27
+ "files": [
28
+ "dist"
29
+ ],
30
+ "exports": {
31
+ ".": {
32
+ "import": "./dist/index.js",
33
+ "require": "./dist/index.cjs",
34
+ "types": "./dist/index.d.ts"
35
+ },
36
+ "./middleware": {
37
+ "import": "./dist/middleware/index.js",
38
+ "types": "./dist/types/middleware/index.d.ts"
39
+ },
40
+ "./react": {
41
+ "import": "./dist/use-react/index.js",
42
+ "types": "./dist/types/use-react/index.d.ts"
43
+ },
44
+ "./vue": {
45
+ "import": "./dist/use-vue/index.js",
46
+ "types": "./dist/types/use-vue/index.d.ts"
47
+ },
48
+ "./package.json": "./package.json"
49
+ },
50
+ "keywords": [
51
+ "state-management",
52
+ "atomic-state",
53
+ "chunk-based state",
54
+ "framework-agnostic",
55
+ "reactive state library",
56
+ "frontend state management",
57
+ "JavaScript state management",
58
+ "TypeScript state management",
59
+ "React state management",
60
+ "Vue state management",
61
+ "Svelte state management",
62
+ "recoil alternative",
63
+ "jotai alternative",
64
+ "zustand alternative",
65
+ "lightweight state management",
66
+ "state container",
67
+ "reusable state",
68
+ "efficient state updates",
69
+ "performance optimization",
70
+ "stunk",
71
+ "chunk"
72
+ ],
73
+ "author": "AbdulAzeez",
74
+ "contributors": [
75
+ {
76
+ "name": "AbdulAzeez",
77
+ "url": "https://github.com/I-am-abdulazeez"
78
+ }
79
+ ],
80
+ "license": "MIT",
81
+ "devDependencies": {
82
+ "@testing-library/dom": "^10.4.0",
83
+ "@testing-library/react": "^16.2.0",
84
+ "@testing-library/vue": "^8.1.0",
85
+ "@types/react": "^18.0.0",
86
+ "@typescript-eslint/eslint-plugin": "^8.26.1",
87
+ "@typescript-eslint/parser": "^8.27.0",
88
+ "@vitejs/plugin-react": "^4.3.4",
89
+ "@vitejs/plugin-vue": "^5.2.1",
90
+ "eslint": "^9.22.0",
91
+ "eslint-plugin-react-hooks": "^5.2.0",
92
+ "jsdom": "^26.0.0",
93
+ "react": "^18.0.0",
94
+ "react-dom": "^18.0.0",
95
+ "typescript": "^5.0.0",
96
+ "vitest": "^3.0.8",
97
+ "vue": "^3.5.13"
98
+ },
99
+ "peerDependencies": {
100
+ "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
101
+ "vue": "^3.5.13"
102
+ },
103
+ "peerDependenciesMeta": {
104
+ "react": {
105
+ "optional": true
106
+ },
107
+ "vue": {
108
+ "optional": true
109
+ }
110
+ }
111
+ }