@vtxdeo/protocol 3.3.0 → 3.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtxdeo/protocol",
-  "version": "3.3.0",
+  "version": "3.4.1",
   "description": "WIT interface definitions for VTX plugins",
   "main": "index.js",
   "types": "index.d.ts",

package/wit/vtx.wit

@@ -8,23 +8,38 @@ interface sql {
         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>;
+    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>;
+        read: func(
+            offset: u64,
+            max-bytes: u64,
+        ) -> list<u8>;
 
-        write: func(data: list<u8>) -> u64;
+        write: func(
+            data: list<u8>,
+        ) -> u64;
     }
 
-    open-file: func(uuid: string) -> result<buffer, string>;
+    open-file: func(
+        uuid: string,
+    ) -> result<buffer, string>;
 
-    create-memory-buffer: func(data: list<u8>) -> buffer;
+    create-memory-buffer: func(
+        data: list<u8>,
+    ) -> buffer;
 }
 
 interface auth-types {
@@ -34,6 +49,12 @@ interface auth-types {
         groups: list<string>,
         metadata: string,
     }
+
+    record current-user {
+        user-id: string,
+        username: string,
+        groups: list<string>,
+    }
 }
 
 interface types {
@@ -69,18 +90,59 @@ interface ffmpeg {
         args: list<string>,
     }
 
-    execute: func(params: transcode-params) -> result<buffer, string>;
+    execute: func(
+        params: transcode-params,
+    ) -> result<buffer, string>;
+}
+
+interface events {
+    record event-context {
+        user-id: option<string>,
+        username: option<string>,
+        request-id: option<string>,
+    }
+
+    record vtx-event {
+        id: string,
+        topic: string,
+        source: string,
+        payload: string,
+        context: event-context,
+        occurred-at: u64,
+    }
+}
+
+interface context {
+    use auth-types.{current-user};
+
+    get-current-user: func() -> option<current-user>;
+}
+
+interface event-bus {
+    publish-event: func(
+        topic: string,
+        payload: string,
+    ) -> result<_, string>;
 }
 
 world plugin {
     use types.{http-request, http-response, manifest};
     use auth-types.{user-context};
+    use events.{vtx-event};
 
     import stream-io;
     import sql;
     import ffmpeg;
+    import context;
+    import event-bus;
+
+    export handle: func(
+        req: http-request,
+    ) -> http-response;
 
-    export handle: func(req: http-request) -> http-response;
+    export handle-event: func(
+        event: vtx-event,
+    ) -> result<_, string>;
 
     export get-migrations: func() -> list<string>;
 
@@ -88,5 +150,7 @@ world plugin {
 
     export get-resources: func() -> list<string>;
 
-    export authenticate: func(headers: list<tuple<string, string>>) -> result<user-context, u16>;
+    export authenticate: func(
+        headers: list<tuple<string, string>>,
+    ) -> result<user-context, u16>;
 }