@appport/transport-tauri 1.0.0

package/README.md

@@ -0,0 +1,45 @@
+# @appport/transport-tauri
+
+The Tauri IPC transport.
+
+```ts
+import { invoke } from "@tauri-apps/api/core";
+import { listen } from "@tauri-apps/api/event";
+import { createTauriTransport } from "@appport/transport-tauri";
+
+const transport = createTauriTransport({ invoke, listen });
+```
+
+Tauri already models IPC as serialized request/response commands plus one-way
+events, which is the same split AppPort makes between capabilities and events.
+One command carries every capability; the envelope names it.
+
+## The Rust side
+
+```rust
+#[tauri::command]
+pub async fn appport_request(
+    app: AppHandle,
+    state: State<'_, AppPort>,
+    envelope: Value,
+) -> Result<Option<Value>, String> {
+    match envelope.get("type").and_then(Value::as_str) {
+        // Request envelopes are answered by the command's return value.
+        Some("request") => Ok(Some(state.runtime.handle_request(envelope).await)),
+        // Everything else replies asynchronously on one event channel.
+        _ => {
+            let handle = app.clone();
+            state
+                .runtime
+                .handle_duplex(envelope, move |outgoing| {
+                    let _ = handle.emit("appport://message", outgoing);
+                })
+                .await;
+            Ok(None)
+        }
+    }
+}
+```
+
+Without `listen`, the transport is request/response only — conformance level 1.
+With it, events and streams work exactly as they do over WebSocket.

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { type AppTransport } from "@appport/client";
+/** `@tauri-apps/api`'s `invoke`, structurally. */
+export type TauriInvoke = (command: string, args?: Record<string, unknown>) => Promise<unknown>;
+/** `@tauri-apps/api`'s `listen`, structurally. */
+export type TauriListen = (event: string, handler: (event: {
+    payload: unknown;
+}) => void) => Promise<() => void>;
+export declare const APPPORT_COMMAND = "appport_request";
+export declare const APPPORT_EVENT = "appport://message";
+export interface TauriTransportOptions {
+    invoke: TauriInvoke;
+    /**
+     * Event listener used for server-pushed envelopes (events, stream chunks).
+     * Without it the transport is request/response only — conformance level 1.
+     */
+    listen?: TauriListen;
+    /** Command name. Defaults to `appport_request`. */
+    command?: string;
+    /** Event name the Rust side emits envelopes on. */
+    eventName?: string;
+}
+export declare function createTauriTransport(options: TauriTransportOptions): AppTransport;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAyB,KAAK,YAAY,EAAuB,MAAM,iBAAiB,CAAC;AAEhG,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhG,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG,CACxB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,CAAC,KAAK,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,KAAK,IAAI,KAC3C,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;AAEzB,eAAO,MAAM,eAAe,oBAAoB,CAAC;AACjD,eAAO,MAAM,aAAa,sBAAsB,CAAC;AAEjD,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,WAAW,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,YAAY,CAiCjF"}

package/dist/index.js

@@ -0,0 +1,44 @@
+/**
+ * `@appport/transport-tauri` — the Tauri IPC transport (§23, §29).
+ *
+ * Tauri already models IPC as serialized request/response commands plus
+ * one-way events, which is the same split AppPort makes between capabilities
+ * and events. One command, `appport_request`, carries every capability; the
+ * envelope names the capability.
+ */
+import { errors } from "@appport/protocol";
+import { createDuplexTransport } from "@appport/client";
+export const APPPORT_COMMAND = "appport_request";
+export const APPPORT_EVENT = "appport://message";
+export function createTauriTransport(options) {
+    const command = options.command ?? APPPORT_COMMAND;
+    const eventName = options.eventName ?? APPPORT_EVENT;
+    let unlisten;
+    let deliver;
+    return createDuplexTransport({
+        kind: "ipc",
+        features: { events: Boolean(options.listen), streams: Boolean(options.listen), persistent: true },
+        async open(handlers) {
+            deliver = handlers.onEnvelope;
+            if (options.listen) {
+                unlisten = await options.listen(eventName, (event) => handlers.onEnvelope(event.payload));
+            }
+        },
+        async send(envelope) {
+            const result = await options.invoke(command, { envelope });
+            // The command answers synchronously for request/response capabilities and
+            // returns null when the reply arrives as an event instead.
+            if (result !== null && result !== undefined) {
+                if (!deliver)
+                    throw errors.internal("The Tauri transport received a reply before it was opened");
+                deliver(result);
+            }
+        },
+        async close() {
+            unlisten?.();
+            unlisten = undefined;
+            deliver = undefined;
+        }
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,MAAM,EAAuB,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAA0C,MAAM,iBAAiB,CAAC;AAWhG,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,CAAC;AACjD,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAejD,MAAM,UAAU,oBAAoB,CAAC,OAA8B;IACjE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC;IACrD,IAAI,QAAkC,CAAC;IACvC,IAAI,OAA+C,CAAC;IAEpD,OAAO,qBAAqB,CAAC;QAC3B,IAAI,EAAE,KAAK;QACX,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE;QAEjG,KAAK,CAAC,IAAI,CAAC,QAAwB;YACjC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC9B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAC5F,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,QAAwB;YACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC3D,0EAA0E;YAC1E,2DAA2D;YAC3D,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC5C,IAAI,CAAC,OAAO;oBAAE,MAAM,MAAM,CAAC,QAAQ,CAAC,2DAA2D,CAAC,CAAC;gBACjG,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;QAED,KAAK,CAAC,KAAK;YACT,QAAQ,EAAE,EAAE,CAAC;YACb,QAAQ,GAAG,SAAS,CAAC;YACrB,OAAO,GAAG,SAAS,CAAC;QACtB,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@appport/transport-tauri",
+  "version": "1.0.0",
+  "description": "Tauri IPC AppPort transport.",
+  "license": "Apache-2.0",
+  "repository": { "type": "git", "url": "git+https://github.com/rkendel1/appport.git", "directory": "packages/transports/tauri" },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "tsc -b --clean"
+  },
+  "dependencies": {
+    "@appport/protocol": "1.0.0",
+    "@appport/client": "1.0.0"
+  },
+  "publishConfig": { "access": "public" }
+}