@vtxdeo/protocol 2.0.6 → 3.2.1

package/README.md

@@ -1,61 +1,28 @@
 # @vtxdeo/protocol
 
-[![npm version](https://img.shields.io/npm/v/@vtx/protocol.svg)](https://www.npmjs.com/package/@vtx/protocol)
+[![npm version](https://img.shields.io/npm/v/@vtxdeo/protocol.svg)](https://www.npmjs.com/package/@vtxdeo/protocol)
 
-**Official WIT interface definitions for VTX Project plugins.**
+**Official WIT interface definitions for VTX Project.**
 
-This package contains the raw `vtx.wit` definitions required to compile JavaScript/TypeScript code into VTX-compatible WebAssembly components.
+This package contains the raw `.wit` definitions used by the VTX ecosystem. It is intended for use by build tools, CLIs, and SDKs that need to reference the official protocol contract.
+
+> **Note**: This package does **not** contain the CLI tool or runtime bindings.
+> * To build plugins, use the **VTX CLI**.
+> * To write plugins, use the **VTX SDK**.
 
 ## Installation
 
 ```bash
-npm install @vtx/protocol --save-dev
+npm install @vtxdeo/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',
-});
-
-```
+const { witPath, witDir } = require('@vtxdeo/protocol');
 
-## Versioning
+console.log(`Protocol definition is located at: ${witPath}`);
+// Output: .../node_modules/@vtxdeo/protocol/wit/vtx.wit
 
-The version of this package matches the version of the `vtx:api` WIT definition.
+```

package/index.d.ts

@@ -0,0 +1,2 @@
+export const witPath: string;
+export const witDir: string;

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@vtxdeo/protocol",
-  "version": "2.0.6",
-  "description": "WIT definitions for VTX plugins",
+  "version": "3.2.1",
+  "description": "WIT interface definitions for VTX plugins",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
     "index.js",
+    "index.d.ts",
     "wit/"
   ],
   "scripts": {
     "prepublishOnly": "cp -r ../../wit ./"
-  }
+  },
+  "dependencies": {},
+  "devDependencies": {}
 }

package/wit/vtx.wit

@@ -58,12 +58,25 @@ interface types {
     }
 }
 
+interface ffmpeg {
+    use stream-io.{buffer};
+
+    record transcode-params {
+        profile: string,
+        input-id: string,
+        args: list<string>,
+    }
+
+    execute: func(params: transcode-params) -> result<buffer, string>;
+}
+
 world plugin {
     use types.{http-request, http-response, manifest};
     use auth-types.{user-context};
 
     import stream-io;
     import sql;
+    import ffmpeg;
 
     export handle: func(req: http-request) -> http-response;