stunk 2.2.2 → 2.2.3
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 +27 -27
- package/README.md +43 -43
- package/dist/index.cjs +1 -1
- package/package.json +100 -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,43 @@
|
|
|
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
|
+
## 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
|
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,100 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "stunk",
|
|
3
|
-
"version": "2.2.
|
|
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
|
-
"
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
-
},
|
|
33
|
-
"./middleware": {
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
},
|
|
37
|
-
"./react": {
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
},
|
|
41
|
-
"./vue": {
|
|
42
|
-
"
|
|
43
|
-
"
|
|
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.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
|
+
}
|