sabcom 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ivan Zakharchanka
+
+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,122 @@
+# SABCOM 
+
+[![Coverage Status][codecov-image]][codecov-url]
+[![Github Build Status][github-image]][github-url]
+[![NPM version][npm-image]][npm-url]
+[![Downloads][downloads-image]][npm-url]
+[![Snyk][snyk-image]][snyk-url]
+
+A TypeScript/Node.js library for inter-thread communication using SharedArrayBuffer with atomic operations and V8 serialization.
+
+## Features
+
+- **Thread-safe communication** using atomic operations
+- **Chunked data transfer** for large payloads
+- **V8 serialization** for complex data types
+- **Timeout handling** with configurable timeouts
+- **Zero-copy operations** where possible
+
+## Installation
+
+```bash
+npm install sabcom
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { write, read } from 'sabcom';
+
+// Create a shared buffer (1MB)
+const buffer = new SharedArrayBuffer(1024 * 1024);
+
+// Writer thread
+const data = { message: 'Hello World', numbers: [1, 2, 3, 4, 5] };
+write(data, buffer);
+
+// Reader thread
+const received = read(buffer);
+console.log(received); // { message: 'Hello World', numbers: [1, 2, 3, 4, 5] }
+```
+
+### With Custom Timeout
+
+```typescript
+// 10 second timeout
+write(data, buffer, 10000);
+const received = read(buffer, 10000);
+```
+
+## API Reference
+
+### `write(data: unknown, buffer: SharedArrayBuffer, timeout?: number): void`
+
+Writes data to the shared buffer using chunked transfer.
+
+- `data` - Any serializable data
+- `buffer` - SharedArrayBuffer for communication
+- `timeout` - Timeout in milliseconds (default: 5000)
+
+**Throws:**
+- `Error` - On handshake or chunk timeout
+
+### `read(buffer: SharedArrayBuffer, timeout?: number): unknown`
+
+Reads data from the shared buffer.
+
+- `buffer` - SharedArrayBuffer for communication  
+- `timeout` - Timeout in milliseconds (default: 5000)
+
+**Returns:** Deserialized data
+
+**Throws:**
+- `Error` - On timeout or integrity failure
+
+## Protocol
+
+The library uses a header-based protocol with atomic operations:
+
+1. **READY** - Buffer available for new transfer
+2. **HANDSHAKE** - Writer sends total size and chunk count
+3. **PAYLOAD** - Chunked data transfer with integrity checks
+
+### Buffer Layout
+
+```
+[Header: 4 * HEADER_VALUES bytes] [Payload: remaining bytes]
+```
+
+## Error Handling
+
+- **Handshake timeout** - Reader not ready within timeout
+- **Chunk timeout** - Individual chunk transfer timeout  
+- **Integrity failure** - Chunk index mismatch
+- **Invalid state** - Unexpected semaphore state
+
+## Thread Safety
+
+Uses `Atomics.wait()`, `Atomics.notify()`, and `Atomics.store()` for synchronization. Requires SharedArrayBuffer support and proper threading context.
+
+## Requirements
+
+- Node.js with SharedArrayBuffer support
+- Multi-threaded environment (Worker threads, etc.)
+- V8 engine for serialization
+
+
+## License
+
+License [The MIT License](./LICENSE)
+Copyright (c) 2025 Ivan Zakharchanka
+
+[npm-url]: https://www.npmjs.com/package/sabcom
+[downloads-image]: https://img.shields.io/npm/dw/sabcom.svg?maxAge=43200
+[npm-image]: https://img.shields.io/npm/v/sabcom.svg?maxAge=43200
+[github-url]: https://github.com/3axap4eHko/sabcom/actions
+[github-image]: https://github.com/3axap4eHko/sabcom/actions/workflows/build.yml/badge.svg?branch=master
+[codecov-url]: https://codecov.io/gh/3axap4eHko/sabcom
+[codecov-image]: https://codecov.io/gh/3axap4eHko/sabcom/branch/master/graph/badge.svg?maxAge=43200
+[snyk-url]: https://snyk.io/test/npm/sabcom/latest
+[snyk-image]: https://snyk.io/test/github/3axap4eHko/sabcom/badge.svg?maxAge=43200

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sabcom",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.0.2",
+  "description": "A TypeScript/Node.js library for inter-thread communication using SharedArrayBuffer with atomic operations and V8 serialization",
   "type": "module",
   "types": "build/index.d.ts",
   "main": "build/index.cjs",
@@ -14,7 +14,20 @@
     "build",
     "src/index.ts"
   ],
-  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/3axap4eHko/sabcom.git"
+  },
+  "keywords": [
+    "SharedArrayBuffer",
+    "shared",
+    "atomic",
+    "buffer",
+    "thread",
+    "worker",
+    "communication"
+  ],
+  "license": "MIT",
   "author": {
     "name": "Ivan Zakharchanka",
     "email": "3axap4eHko@gmail.com",