strictjs-runtime 1.0.3 → 1.0.4

package/README.md

@@ -0,0 +1,189 @@
+
+# **StrictJS Runtime**
+
+> ⚡ *StrictJS Runtime is an experimental, low-level JavaScript runtime powered by WebAssembly (WASM).*
+>
+> It’s built to give JavaScript **strict data handling**, **Rust-like safety**, and **C-like performance** — while staying fully compatible with any environment where JS runs: browser, Node.js, React Native, TensorFlow.js, and more.
+
+---
+
+## **Why StrictJS?**
+
+JavaScript is powerful but *loose*.
+- Memory is garbage-collected and unpredictable.
+- Numbers, arrays, and objects are dynamic but error-prone.
+- Performance bottlenecks appear in **games**, **simulations**, **trading platforms**, and **AI applications**.
+
+StrictJS Runtime solves these problems by introducing **strict, typed structures** running inside a **WebAssembly core** — without abandoning JavaScript.
+
+**Think of it as:**
+- The **discipline of Rust**,
+- The **familiarity of JavaScript**,
+- And the **flexibility to run anywhere**.
+
+---
+
+## **Key Features**
+
+- 🚀 **High performance** – WebAssembly core for heavy computation.
+- 🧩 **Strict memory control** – Typed arrays and objects with predictable behavior.
+- 🛡 **Runtime type safety** – Reduce hidden bugs and crashes.
+- 🌐 **Cross-platform** – Works in browsers, Node.js, and other JS runtimes.
+- ⚡ **Universal integration** – Plug it into Three.js, TensorFlow.js, React Native, or your backend logic.
+
+---
+
+## **Installation**
+
+Install via **npm**:
+
+```bash
+npm install strictjs-runtime
+```
+
+Or use **pnpm**:
+
+```bash
+pnpm add strictjs-runtime
+```
+
+Or **yarn**:
+
+```bash
+yarn add strictjs-runtime
+```
+
+Or load directly from a **CDN** in the browser:
+
+```html
+<script src="https://unpkg.com/strictjs-runtime/pkg/strictjs_runtime.js"></script>
+```
+
+---
+
+## **Quick Start**
+
+Here's a minimal example showing how to initialize StrictJS Runtime and work with strict arrays.
+
+```js
+import init, { HeapType, StrictArray, StrictFunction } from "strictjs-runtime/pkg/strictjs_runtime.js";
+
+async function main() {
+  await init(); // Initialize the WebAssembly runtime
+
+  // Create a strict typed array
+  const numbers = new StrictArray(HeapType.U8, 3);
+  numbers.set(0, 42);
+  numbers.set(1, 99);
+
+  console.log("First number:", numbers.get(0)); // → 42
+  console.log("Second number:", numbers.get(1)); // → 99
+
+  // Wrap a JS function with type safety
+  const safeAdd = new StrictFunction(
+    (a, b) => a + b,
+    ["u8", "u8"], // Input types
+    "u8"          // Output type
+  );
+
+  console.log("200 + 100 =", safeAdd.call([200, 100])); // → 255 (clamped)
+}
+
+main();
+```
+
+---
+
+## **Core APIs**
+
+### **HeapType**
+An enum representing different memory layouts for strict arrays.
+
+| Type    | Description              |
+|---------|--------------------------|
+| `U8`    | Unsigned 8-bit integer  |
+| `I32`   | Signed 32-bit integer   |
+| `F32`   | 32-bit floating-point   |
+| `F64`   | 64-bit floating-point   |
+
+---
+
+### **StrictArray**
+A fixed-size, type-safe array backed by the WASM heap.
+
+```js
+const arr = new StrictArray(HeapType.U8, 3);
+arr.set(0, 10);
+console.log(arr.get(0)); // → 10
+```
+
+---
+
+### **StrictFunction**
+Wraps JavaScript functions with runtime type checking and strict argument enforcement.
+
+```js
+const multiply = new StrictFunction(
+  (a, b) => a * b,
+  ["u8", "u8"], // Input types
+  "u8"          // Output type
+);
+
+console.log(multiply.call([5, 6])); // → 30
+```
+
+---
+
+## **Project Status**
+
+StrictJS Runtime is **early stage and experimental**.
+- ✅ Stable core runtime for strict arrays and functions.
+- ⚠️ APIs are evolving — expect breaking changes before `v1.0`.
+- 🧪 Best for experiments, demos, and learning how to integrate strict, low-level operations into your JS projects.
+
+---
+
+## **Roadmap**
+
+- [ ] Strict object system
+- [ ] Improved type inference and enforcement
+- [ ] Developer tools & debugging support
+- [ ] Performance benchmarks
+- [ ] Integrations with React, TensorFlow.js, and Three.js
+- [ ] Potential compiler to **StrictJS language** for low-level JS development
+
+---
+
+## **Contributing**
+
+Contributions are welcome!
+
+1. Fork the repo  
+2. Create a feature branch  
+3. Submit a pull request with clear explanations and tests  
+
+---
+
+## **License**
+
+This project is licensed under the **MIT License**.
+See the [LICENSE](LICENSE) file for details.
+
+---
+
+## **Links**
+
+- **GitHub:** [https://github.com/kennethmburu/strictjs-runtime](https://github.com/kennethmburu/strictjs-runtime)  
+- **NPM:** [https://www.npmjs.com/package/strictjs-runtime](https://www.npmjs.com/package/strictjs-runtime)  
+- **Issues / Bug Tracker:** [Open Issues](https://github.com/kennethmburu/strictjs-runtime/issues)
+
+---
+
+## **Vision**
+
+StrictJS is starting small — just a runtime today — but it has **big potential**:
+- It could grow into a **framework**, powering full apps like React or Vue.
+- It could evolve into a **language**, compiling to strict, predictable JavaScript.
+- It could remain a **universal tool**, dropped into any stack to bring low-level safety and performance.
+
+*"Wherever JavaScript runs, StrictJS can run too."*

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "strictjs-runtime",
-  "version": "1.0.3",
-  "description": "A low-level runtime for StrictJS with WebAssembly support",
+  "version": "1.0.4",
+  "description": "A lightweight low-level runtime for StrictJS with WebAssembly support.",
   "main": "index.js",
   "type": "module",
   "files": [
@@ -9,15 +9,26 @@
     "index.js"
   ],
   "scripts": {
-    "build": "echo 'Add your build script here, e.g., wasm-pack build'",
-    "test": "node test.js"
+    "build": "wasm-pack build --target bundler --out-dir pkg",
+    "test": "node test.js",
+    "clean": "rm -rf pkg node_modules"
   },
   "keywords": [
     "strictjs",
     "wasm",
     "runtime",
-    "lowlevel"
+    "lowlevel",
+    "javascript",
+    "webassembly"
   ],
-  "author": "Kennneth Mburu",
+  "author": "Kenneth Mburu kennethmburu21@gmail.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Kenneth732/strictJS.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kenneth732/strictJS.git"
+  },
+  "homepage": "https://github.com/Kenneth732/strictJS.git",
   "license": "MIT"
 }