@vtxdeo/protocol 1.2.6

package/README.md

@@ -0,0 +1,62 @@
+# @vtxdeo/protocol
+
+[![npm version](https://img.shields.io/npm/v/@vtx/protocol.svg)](https://www.npmjs.com/package/@vtx/protocol)
+
+**Official WIT interface definitions for VTX Project plugins.**
+
+This package contains the raw `vtx.wit` definitions required to compile JavaScript/TypeScript code into VTX-compatible WebAssembly components.
+
+## Installation
+
+```bash
+npm install @vtx/protocol --save-dev
+
+```
+
+## Usage
+
+### 1. Programmatic Usage (Build Scripts)
+
+This package exports the absolute path to the `vtx.wit` file.
+
+```javascript
+import { witPath, witDir } from '@vtx/protocol';
+// or: const { witPath } = require('@vtx/protocol');
+
+console.log(witPath);
+// Output example: /Users/dev/project/node_modules/@vtx/protocol/wit/vtx.wit
+
+```
+
+### 2. Using with `jco` (CLI)
+
+You can use the path directly in your CLI commands to componentize your application:
+
+```bash
+# Example: Transpile JS to Component
+jco componentize app.js \
+  --wit "$(node -p "require('@vtx/protocol').witPath")" \
+  --world plugin \
+  --out plugin.wasm
+
+```
+
+### 3. Using with `componentize-js` (API)
+
+```javascript
+import { componentize } from '@bytecodealliance/componentize-js';
+import { witPath } from '@vtx/protocol';
+import { readFile } from 'node:fs/promises';
+
+const source = await readFile('app.js', 'utf8');
+
+const { component } = await componentize(source, {
+  witPath: witPath, // Pass the path directly
+  world: 'plugin',
+});
+
+```
+
+## Versioning
+
+The version of this package matches the version of the `vtx:api` WIT definition.

package/index.js

@@ -0,0 +1,6 @@
+const path = require('path');
+
+module.exports = {
+    witPath: path.join(__dirname, 'wit', 'vtx.wit'),
+    witDir: path.join(__dirname, 'wit')
+};

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@vtxdeo/protocol",
+  "version": "1.2.6",
+  "description": "WIT definitions for VTX plugins",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "wit/"
+  ],
+  "scripts": {
+    "prepublishOnly": "cp -r ../../wit ./"
+  }
+}

package/wit/vtx.wit

@@ -0,0 +1,77 @@
+package vtx:api@1.2.6;
+
+interface sql {
+    variant db-value {
+        text(string),
+        integer(s64),
+        real(f64),
+        null-val,
+    }
+
+    execute: func(statement: string, params: list<db-value>) -> result<u64, string>;
+
+    query-json: func(statement: string, params: list<db-value>) -> result<string, string>;
+}
+
+interface stream-io {
+    resource buffer {
+        size: func() -> u64;
+
+        read: func(offset: u64, max-bytes: u64) -> list<u8>;
+    }
+
+    open-file: func(uuid: string) -> result<buffer, string>;
+
+    create-memory-buffer: func(data: list<u8>) -> buffer;
+}
+
+interface auth-types {
+    record user-context {
+        user-id: string,
+        username: string,
+        groups: list<string>,
+        metadata: string,
+    }
+}
+
+interface types {
+    use stream-io.{buffer};
+    use auth-types.{user-context};
+
+    record http-request {
+        method: string,
+        path: string,
+        query: string,
+    }
+
+    record http-response {
+        status: u16,
+        body: option<buffer>,
+    }
+
+    record manifest {
+        id: string,
+        name: string,
+        version: string,
+        description: string,
+        entrypoint: string,
+    }
+}
+
+world plugin {
+    use types.{http-request, http-response, manifest};
+    use auth-types.{user-context};
+
+    import stream-io;
+    import sql;
+
+    export handle: func(req: http-request) -> http-response;
+
+    export get-migrations: func() -> list<string>;
+
+    export get-manifest: func() -> manifest;
+
+    export get-resources: func() -> list<string>;
+
+    export authenticate: func(headers: list<tuple<string, string>>) -> result<user-context, u16>;
+}