stunk 0.1.0

package/LICENSE

@@ -0,0 +1,27 @@
+---
+
+### **`LICENSE`**
+
+```text
+MIT License
+
+Copyright (c) 2025 AbdulAzeez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

package/README.md

@@ -0,0 +1,23 @@
+# Stunk
+
+**Stunk** is a framework-agnostic state management library implementing the **Atomic State technique**, utilizing chunk-based units for efficient state management. Whether you're building applications in plain JavaScript/TypeScript, React, Vue, Svelte, or any other modern framework, **Stunk** can seamlessly fit into your project.
+
+## Pronunciation and Meaning
+
+- **Pronunciation**: _Stunk_ (A playful blend of "state" and "chunk")
+- **Meaning**: "Stunk" represents the combination of state management with chunk-based atomic units. The term captures the essence of atomic state management while using "chunk" to refer to these discrete units of state.
+
+## Features
+
+- **Framework-agnostic**: Use it in any JavaScript/TypeScript application, regardless of framework.
+- **Atomic State technique**: Implements state management using atomic units (chunks) that are discrete and easily manageable.
+- **TypeScript support**: Fully typed for better developer experience and type safety.
+- **Easy to use**: Simple API for creating, getting, and updating state.
+
+## Installation
+
+You can install **Stunk** from NPM:
+
+```bash
+npm install stunk
+```

package/dist/core.js

@@ -0,0 +1,22 @@
+// Chunk creation function
+export function createChunk(initialValue) {
+    let value = initialValue; // The current value of the chunk
+    const subscribers = new Set(); // Set of subscribers
+    return {
+        // Get the current value
+        get() {
+            return value;
+        },
+        // Set a new value and notify subscribers
+        set(newValue) {
+            value = newValue;
+            subscribers.forEach((callback) => callback(value));
+        },
+        // Subscribe to changes
+        subscribe(callback) {
+            subscribers.add(callback);
+            // Return an unsubscribe function
+            return () => subscribers.delete(callback);
+        },
+    };
+}

package/dist/index.js

@@ -0,0 +1,2 @@
+// src/index.ts
+export { createChunk } from './core';

package/dist/utils.js

@@ -0,0 +1,3 @@
+export function isValidChunkValue(value) {
+    return value !== null && value !== undefined;
+}

package/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "stunk",
+  "version": "0.1.0",
+  "description": "Stunk - A framework-agnostic state management library implementing the Atomic State technique, utilizing chunk-based units for efficient state management.",
+  "main": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "state-management",
+    "atomic-state",
+    "framework-agnostic",
+    "dàrá"
+  ],
+  "author": "AbdulAzeez",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.0.0"
+  }
+}

package/src/core.ts

@@ -0,0 +1,30 @@
+// Define the Chunk type
+export type Chunk<T> = {
+  get: () => T; // Get the value of the chunk
+  set: (newValue: T) => void; // Set the value of the chunk
+  subscribe: (callback: (value: T) => void) => () => void; // Subscribe to changes
+};
+
+// Chunk creation function
+export function createChunk<T>(initialValue: T): Chunk<T> {
+  let value = initialValue; // The current value of the chunk
+  const subscribers = new Set<(value: T) => void>(); // Set of subscribers
+
+  return {
+    // Get the current value
+    get() {
+      return value;
+    },
+    // Set a new value and notify subscribers
+    set(newValue: T) {
+      value = newValue;
+      subscribers.forEach((callback) => callback(value));
+    },
+    // Subscribe to changes
+    subscribe(callback: (value: T) => void) {
+      subscribers.add(callback);
+      // Return an unsubscribe function
+      return () => subscribers.delete(callback);
+    },
+  };
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+// src/index.ts
+
+export { createChunk } from './core';
+export type { Chunk } from './core';

package/src/utils.ts

@@ -0,0 +1,3 @@
+export function isValidChunkValue(value: any): boolean {
+  return value !== null && value !== undefined;
+}

package/tests/chunk.test.ts

@@ -0,0 +1,35 @@
+// tests/chunk.test.ts
+
+import { createChunk } from "../src/core";
+
+test("Chunk should get and set values correctly", () => {
+  const chunk = createChunk<number>(0);
+  expect(chunk.get()).toBe(0);
+  chunk.set(10);
+  expect(chunk.get()).toBe(10);
+});
+
+test("Chunk should notify subscribers on value change", () => {
+  const chunk = createChunk<number>(0);
+  const callback = jest.fn();
+  chunk.subscribe(callback);
+
+  chunk.set(5);
+  expect(callback).toHaveBeenCalledWith(5);
+
+  chunk.set(10);
+  expect(callback).toHaveBeenCalledWith(10);
+});
+
+test("Chunk should allow unsubscribing from updates", () => {
+  const chunk = createChunk<number>(0);
+  const callback = jest.fn();
+  const unsubscribe = chunk.subscribe(callback);
+
+  chunk.set(5);
+  expect(callback).toHaveBeenCalledWith(5);
+
+  unsubscribe();
+  chunk.set(10); // No callback should be called now
+  expect(callback).toHaveBeenCalledTimes(1);
+});

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "outDir": "./dist",
+    "declaration": true,
+    "declarationDir": "./dist/types",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}