opentray 0.0.0 → 0.1.0

package/README.md

@@ -16,3 +16,11 @@ pnpm add opentray
 - Resolve per-platform optional binary packages.
 
 `packages/cli` is the only unscoped npm package in this monorepo.
+
+## Example
+
+Run a protocol-only example that creates a surface, creates a tray, dispatches an extension command, and prints each client frame:
+
+```bash
+pnpm --filter opentray example:basic
+```

package/dist/index.d.mts

@@ -0,0 +1,24 @@
+import { ClientFrame, SurfaceOptions, SurfaceRef, TrayId, TrayOptions } from "@opentray/spec";
+
+//#region src/index.d.ts
+interface OpenTrayTransport {
+  send(frame: ClientFrame): Promise<void>;
+}
+interface SurfaceHandle {
+  surface: SurfaceRef;
+  createTray(options: TrayOptions): Promise<TrayHandle>;
+}
+interface TrayHandle {
+  surface: SurfaceRef;
+  trayId: TrayId;
+  commandExtension(ext: string, data: unknown): Promise<void>;
+  destroy(): Promise<void>;
+}
+declare const createClient: (transport: OpenTrayTransport) => {
+  createSurface(options: SurfaceOptions): Promise<SurfaceHandle>;
+};
+declare const createSurfaceHandle: (transport: OpenTrayTransport, surface: SurfaceRef) => SurfaceHandle;
+declare const createTrayHandle: (transport: OpenTrayTransport, surface: SurfaceRef, trayId: TrayId) => TrayHandle;
+//#endregion
+export { OpenTrayTransport, SurfaceHandle, TrayHandle, createClient, createSurfaceHandle, createTrayHandle };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;UAEiB,iBAAA;EACf,IAAA,CAAK,KAAA,EAAO,WAAA,GAAc,OAAO;AAAA;AAAA,UAGlB,aAAA;EACf,OAAA,EAAS,UAAA;EACT,UAAA,CAAW,OAAA,EAAS,WAAA,GAAc,OAAA,CAAQ,UAAA;AAAA;AAAA,UAG3B,UAAA;EACf,OAAA,EAAS,UAAA;EACT,MAAA,EAAQ,MAAA;EACR,gBAAA,CAAiB,GAAA,UAAa,IAAA,YAAgB,OAAA;EAC9C,OAAA,IAAW,OAAA;AAAA;AAAA,cAGA,YAAA,GAAgB,SAAA,EAAW,iBAAA;yBACT,cAAA,GAAiB,OAAA,CAAQ,aAAA;AAAA;AAAA,cAU3C,mBAAA,GAAuB,SAAA,EAAW,iBAAA,EAAmB,OAAA,EAAS,UAAA,KAAa,aAAA;AAAA,cAQ3E,gBAAA,GACX,SAAA,EAAW,iBAAA,EACX,OAAA,EAAS,UAAA,EACT,MAAA,EAAQ,MAAA,KACP,UAAA"}

package/dist/index.mjs

@@ -0,0 +1,46 @@
+//#region src/index.ts
+const createClient = (transport) => ({ async createSurface(options) {
+	await transport.send({
+		type: "create-surface",
+		...options
+	});
+	return createSurfaceHandle(transport, {
+		surfaceId: `pending:${options.appId}`,
+		appId: options.appId
+	});
+} });
+const createSurfaceHandle = (transport, surface) => ({
+	surface,
+	async createTray(options) {
+		await transport.send({
+			type: "create-tray",
+			surface,
+			tray: options
+		});
+		return createTrayHandle(transport, surface, options.trayId ?? "pending");
+	}
+});
+const createTrayHandle = (transport, surface, trayId) => ({
+	surface,
+	trayId,
+	async commandExtension(ext, data) {
+		await transport.send({
+			type: "ext-command",
+			surfaceId: surface.surfaceId,
+			trayId,
+			ext,
+			data
+		});
+	},
+	async destroy() {
+		await transport.send({
+			type: "destroy-tray",
+			surfaceId: surface.surfaceId,
+			trayId
+		});
+	}
+});
+//#endregion
+export { createClient, createSurfaceHandle, createTrayHandle };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { ClientFrame, SurfaceOptions, SurfaceRef, TrayId, TrayOptions } from \"@opentray/spec\";\n\nexport interface OpenTrayTransport {\n  send(frame: ClientFrame): Promise<void>;\n}\n\nexport interface SurfaceHandle {\n  surface: SurfaceRef;\n  createTray(options: TrayOptions): Promise<TrayHandle>;\n}\n\nexport interface TrayHandle {\n  surface: SurfaceRef;\n  trayId: TrayId;\n  commandExtension(ext: string, data: unknown): Promise<void>;\n  destroy(): Promise<void>;\n}\n\nexport const createClient = (transport: OpenTrayTransport) => ({\n  async createSurface(options: SurfaceOptions): Promise<SurfaceHandle> {\n    await transport.send({ type: \"create-surface\", ...options });\n    const surface: SurfaceRef = {\n      surfaceId: `pending:${options.appId}`,\n      appId: options.appId,\n    };\n    return createSurfaceHandle(transport, surface);\n  },\n});\n\nexport const createSurfaceHandle = (transport: OpenTrayTransport, surface: SurfaceRef): SurfaceHandle => ({\n  surface,\n  async createTray(options: TrayOptions): Promise<TrayHandle> {\n    await transport.send({ type: \"create-tray\", surface, tray: options });\n    return createTrayHandle(transport, surface, options.trayId ?? \"pending\");\n  },\n});\n\nexport const createTrayHandle = (\n  transport: OpenTrayTransport,\n  surface: SurfaceRef,\n  trayId: TrayId,\n): TrayHandle => ({\n  surface,\n  trayId,\n  async commandExtension(ext: string, data: unknown): Promise<void> {\n    await transport.send({\n      type: \"ext-command\",\n      surfaceId: surface.surfaceId,\n      trayId,\n      ext,\n      data,\n    });\n  },\n  async destroy(): Promise<void> {\n    await transport.send({\n      type: \"destroy-tray\",\n      surfaceId: surface.surfaceId,\n      trayId,\n    });\n  },\n});\n"],"mappings":";AAkBA,MAAa,gBAAgB,eAAkC,EAC7D,MAAM,cAAc,SAAiD;CACnE,MAAM,UAAU,KAAK;EAAE,MAAM;EAAkB,GAAG;CAAQ,CAAC;CAK3D,OAAO,oBAAoB,WAAW;EAHpC,WAAW,WAAW,QAAQ;EAC9B,OAAO,QAAQ;CAE2B,CAAC;AAC/C,EACF;AAEA,MAAa,uBAAuB,WAA8B,aAAwC;CACxG;CACA,MAAM,WAAW,SAA2C;EAC1D,MAAM,UAAU,KAAK;GAAE,MAAM;GAAe;GAAS,MAAM;EAAQ,CAAC;EACpE,OAAO,iBAAiB,WAAW,SAAS,QAAQ,UAAU,SAAS;CACzE;AACF;AAEA,MAAa,oBACX,WACA,SACA,YACgB;CAChB;CACA;CACA,MAAM,iBAAiB,KAAa,MAA8B;EAChE,MAAM,UAAU,KAAK;GACnB,MAAM;GACN,WAAW,QAAQ;GACnB;GACA;GACA;EACF,CAAC;CACH;CACA,MAAM,UAAyB;EAC7B,MAAM,UAAU,KAAK;GACnB,MAAM;GACN,WAAW,QAAQ;GACnB;EACF,CAAC;CACH;AACF"}

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "opentray",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Developer-facing OpenTray SDK and CLI package.",
   "type": "module",
   "license": "MIT",
-  "bin": {
-    "opentray": "./dist/cli.js"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jixoai/opentray"
   },
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     },
     "./package.json": "./package.json"
   },
@@ -20,14 +21,25 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@opentray/spec": "0.0.0"
+    "@opentray/spec": "0.1.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.22.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.7"
   },
   "optionalDependencies": {
-    "@opentray/darwin-arm64": "0.0.0",
     "@opentray/darwin-x64": "0.0.0",
-    "@opentray/windows-arm64": "0.0.0",
-    "@opentray/windows-x64": "0.0.0",
+    "@opentray/darwin-arm64": "0.0.0",
     "@opentray/linux-x64": "0.0.0",
-    "@opentray/linux-arm64": "0.0.0"
+    "@opentray/linux-arm64": "0.0.0",
+    "@opentray/windows-arm64": "0.0.0",
+    "@opentray/windows-x64": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm --dts",
+    "example:basic": "bun run examples/basic-surface.ts",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
   }
 }