@tiga-ipc/mmap 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TigaIpc contributors
+
+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,106 @@
+# @tiga-ipc/mmap
+
+`@tiga-ipc/mmap` is the Node.js package for the Tiga memory-mapped IPC protocol.
+
+It provides a small CommonJS wrapper around the native `index.node` addon and exposes the current Tiga channel APIs:
+
+- `initialized()`
+- `tigaWrite(name, message, options?)`
+- `tigaRead(name, options?)`
+- `tigaInvoke(requestName, responseName, method, data, options?)`
+
+## Install
+
+```bash
+npm install @tiga-ipc/mmap
+```
+
+Current package scope:
+
+- Windows only
+- File-backed mapping usage
+- `mappingDirectory` must be passed explicitly by the caller
+
+## Usage
+
+```js
+const { tigaInvoke, tigaWrite, tigaRead } = require('@tiga-ipc/mmap');
+
+const mappingDirectory = 'C:\\temp\\tiga-ipc';
+
+const reply = tigaInvoke(
+  'sample.req.client-a',
+  'sample.resp.client-a',
+  'echo',
+  'hello from node',
+  {
+    mappingDirectory,
+    timeoutMs: 3000,
+  },
+);
+
+console.log(reply);
+
+tigaWrite('sample.events', 'event payload', {
+  mappingDirectory,
+  mediaType: 'text/plain',
+});
+
+const result = tigaRead('sample.events', {
+  mappingDirectory,
+  lastId: 0,
+});
+
+console.log(result.lastId, result.entries.length);
+```
+
+## API
+
+### `tigaWrite(name, message, options?)`
+
+- `name: string`
+- `message: Buffer | string`
+- `options?.mappingDirectory: string`
+- `options?.mediaType?: string`
+
+Returns a short write result string from the native addon.
+
+### `tigaRead(name, options?)`
+
+- `name: string`
+- `options?.mappingDirectory: string`
+- `options?.lastId?: number`
+
+Returns:
+
+```ts
+interface TigaReadResult {
+  lastId: number;
+  entries: Array<{
+    id: number;
+    message: Buffer;
+    mediaType?: string;
+  }>;
+}
+```
+
+### `tigaInvoke(requestName, responseName, method, data, options?)`
+
+- `requestName: string`
+- `responseName: string`
+- `method: string`
+- `data: string`
+- `options?.mappingDirectory: string`
+- `options?.timeoutMs?: number`
+
+Returns the response payload string.
+
+## Notes
+
+- This package intentionally uses the current `tiga*` API only. The old generic `write/read` export surface is not part of the published package entry.
+- The native binary is packaged as `index.node`, so publish from a Windows environment after rebuilding the addon you want to ship.
+- For repository examples and cross-language smoke tests, see the monorepo root README and `examples/`.
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export declare function initialized(): string
+export interface TigaReadResult {
+  lastId: number
+  entries: Array<TigaEntry>
+}
+export interface TigaEntry {
+  id: number
+  message: Buffer
+  mediaType?: string
+}
+export interface TigaChannelOptions {
+  mappingDirectory?: string
+}
+export interface TigaWriteOptions extends TigaChannelOptions {
+  mediaType?: string | null
+}
+export interface TigaReadOptions extends TigaChannelOptions {
+  lastId?: number
+}
+export interface TigaInvokeOptions extends TigaChannelOptions {
+  timeoutMs?: number
+}
+export declare function tigaWrite(name: string, message: Buffer | string, options?: TigaWriteOptions): string
+export declare function tigaRead(name: string, options?: TigaReadOptions): TigaReadResult
+export declare function tigaInvoke(requestName: string, responseName: string, method: string, data: string, options?: TigaInvokeOptions): string

package/index.js

@@ -0,0 +1,8 @@
+const binding = require('./index.node');
+
+module.exports = {
+  initialized: binding.initialized,
+  tigaWrite: binding.tigaWrite,
+  tigaRead: binding.tigaRead,
+  tigaInvoke: binding.tigaInvoke,
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@tiga-ipc/mmap",
+  "version": "0.1.0",
+  "description": "Windows memory-mapped IPC bindings for Tiga channels.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "index.js",
+    "index.d.ts",
+    "index.node"
+  ],
+  "os": [
+    "win32"
+  ],
+  "scripts": {
+    "test": "cargo test",
+    "cargo-build": "npx @napi-rs/cli build",
+    "cross-build": "npx @napi-rs/cli build",
+    "debug": "npm run cargo-build --",
+    "build": "npm run cargo-build -- --release",
+    "cross": "npm run cross-build -- --release",
+    "prepack": "node -e \"require('fs').accessSync('index.node')\""
+  },
+  "keywords": [
+    "ipc",
+    "mmap",
+    "memory-mapped-file",
+    "napi-rs",
+    "tiga"
+  ],
+  "author": "TigaIpc contributors",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sugarbearr/TigaIpc.git",
+    "directory": "nodejs/mmap-napi"
+  },
+  "bugs": {
+    "url": "https://github.com/sugarbearr/TigaIpc/issues"
+  },
+  "homepage": "https://github.com/sugarbearr/TigaIpc",
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.0"
+  }
+}