@opentray/ext-webview 0.0.0 → 0.1.0

package/README.md

@@ -9,3 +9,11 @@ Official rich popup extension for OpenTray.
 - Route WebView messages through the owning `surfaceId` / `trayId`.
 
 This package is an extension atom. It must not become the owner of core tray lifecycle.
+
+## Example
+
+Run a broker-free example that sends WebView `show`, `navigate`, `postMessage`, and `hide` commands through the normal OpenTray extension command path:
+
+```bash
+pnpm --filter @opentray/ext-webview example:webview
+```

package/dist/index.d.mts

@@ -0,0 +1,66 @@
+import { TrayHandle } from "opentray";
+
+//#region ../spec/src/index.d.ts
+type SurfaceId = string;
+type TrayId = string;
+interface Rect {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+interface ExtensionScope {
+  surfaceId: SurfaceId;
+  trayId?: TrayId;
+  ext: string;
+}
+interface ExtensionEnvelope<TData = unknown> {
+  scope: ExtensionScope;
+  data: TData;
+}
+//#endregion
+//#region src/index.d.ts
+type WebviewCommand = {
+  type: "show";
+  html?: string;
+  url?: string;
+  width: number;
+  height: number;
+  fallbackRect?: Rect;
+} | {
+  type: "hide";
+} | {
+  type: "navigate";
+  url: string;
+} | {
+  type: "evaluate";
+  js: string;
+} | {
+  type: "postMessage";
+  payload: unknown;
+};
+type WebviewEvent = {
+  type: "shown";
+} | {
+  type: "hidden";
+} | {
+  type: "message";
+  payload: unknown;
+} | {
+  type: "positionFallback";
+  strategy: "cursor" | "platformDefault";
+};
+interface WebviewHandle {
+  show(command: Extract<WebviewCommand, {
+    type: "show";
+  }>): Promise<void>;
+  hide(): Promise<void>;
+  navigate(url: string): Promise<void>;
+  evaluate(js: string): Promise<void>;
+  postMessage(payload: unknown): Promise<void>;
+}
+declare const attachWebview: (tray: TrayHandle) => WebviewHandle;
+declare const isWebviewEvent: (event: ExtensionEnvelope) => event is ExtensionEnvelope<WebviewEvent>;
+//#endregion
+export { WebviewCommand, WebviewEvent, WebviewHandle, attachWebview, isWebviewEvent };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../spec/src/index.ts","../src/index.ts"],"mappings":";;;KACY,SAAA;AAAA,KACA,MAAA;AAAA,UAuEK,IAAA;EACf,CAAA;EACA,CAAA;EACA,KAAA;EACA,MAAA;AAAA;AAAA,UAWe,cAAA;EACf,SAAA,EAAW,SAAA;EACX,MAAA,GAAS,MAAM;EACf,GAAA;AAAA;AAAA,UAGe,iBAAA;EACf,KAAA,EAAO,cAAA;EACP,IAAA,EAAM,KAAK;AAAA;;;KC7FD,cAAA;EACN,IAAA;EAAc,IAAA;EAAe,GAAA;EAAc,KAAA;EAAe,MAAA;EAAgB,YAAA,GAAe,IAAI;AAAA;EAC7F,IAAA;AAAA;EACA,IAAA;EAAkB,GAAA;AAAA;EAClB,IAAA;EAAkB,EAAA;AAAA;EAClB,IAAA;EAAqB,OAAA;AAAA;AAAA,KAEf,YAAA;EACN,IAAA;AAAA;EACA,IAAA;AAAA;EACA,IAAA;EAAiB,OAAA;AAAA;EACjB,IAAA;EAA0B,QAAA;AAAA;AAAA,UAEf,aAAA;EACf,IAAA,CAAK,OAAA,EAAS,OAAA,CAAQ,cAAA;IAAkB,IAAA;EAAA,KAAkB,OAAA;EAC1D,IAAA,IAAQ,OAAA;EACR,QAAA,CAAS,GAAA,WAAc,OAAA;EACvB,QAAA,CAAS,EAAA,WAAa,OAAA;EACtB,WAAA,CAAY,OAAA,YAAmB,OAAA;AAAA;AAAA,cAGpB,aAAA,GAAiB,IAAA,EAAM,UAAA,KAAa,aAgB/C;AAAA,cAEW,cAAA,GAAkB,KAAA,EAAO,iBAAA,KAAoB,KAAA,IAAS,iBAAA,CAAkB,YAAA"}

package/dist/index.mjs

@@ -0,0 +1,32 @@
+//#region src/index.ts
+const attachWebview = (tray) => ({
+	show(command) {
+		return tray.commandExtension("webview", command);
+	},
+	hide() {
+		return tray.commandExtension("webview", { type: "hide" });
+	},
+	navigate(url) {
+		return tray.commandExtension("webview", {
+			type: "navigate",
+			url
+		});
+	},
+	evaluate(js) {
+		return tray.commandExtension("webview", {
+			type: "evaluate",
+			js
+		});
+	},
+	postMessage(payload) {
+		return tray.commandExtension("webview", {
+			type: "postMessage",
+			payload
+		});
+	}
+});
+const isWebviewEvent = (event) => event.scope.ext === "webview" && typeof event.data === "object" && event.data !== null && "type" in event.data;
+//#endregion
+export { attachWebview, isWebviewEvent };
+
+//# 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 { ExtensionEnvelope, Rect } from \"@opentray/spec\";\nimport type { TrayHandle } from \"opentray\";\n\nexport type WebviewCommand =\n  | { type: \"show\"; html?: string; url?: string; width: number; height: number; fallbackRect?: Rect }\n  | { type: \"hide\" }\n  | { type: \"navigate\"; url: string }\n  | { type: \"evaluate\"; js: string }\n  | { type: \"postMessage\"; payload: unknown };\n\nexport type WebviewEvent =\n  | { type: \"shown\" }\n  | { type: \"hidden\" }\n  | { type: \"message\"; payload: unknown }\n  | { type: \"positionFallback\"; strategy: \"cursor\" | \"platformDefault\" };\n\nexport interface WebviewHandle {\n  show(command: Extract<WebviewCommand, { type: \"show\" }>): Promise<void>;\n  hide(): Promise<void>;\n  navigate(url: string): Promise<void>;\n  evaluate(js: string): Promise<void>;\n  postMessage(payload: unknown): Promise<void>;\n}\n\nexport const attachWebview = (tray: TrayHandle): WebviewHandle => ({\n  show(command) {\n    return tray.commandExtension(\"webview\", command);\n  },\n  hide() {\n    return tray.commandExtension(\"webview\", { type: \"hide\" } satisfies WebviewCommand);\n  },\n  navigate(url) {\n    return tray.commandExtension(\"webview\", { type: \"navigate\", url } satisfies WebviewCommand);\n  },\n  evaluate(js) {\n    return tray.commandExtension(\"webview\", { type: \"evaluate\", js } satisfies WebviewCommand);\n  },\n  postMessage(payload) {\n    return tray.commandExtension(\"webview\", { type: \"postMessage\", payload } satisfies WebviewCommand);\n  },\n});\n\nexport const isWebviewEvent = (event: ExtensionEnvelope): event is ExtensionEnvelope<WebviewEvent> =>\n  event.scope.ext === \"webview\" &&\n  typeof event.data === \"object\" &&\n  event.data !== null &&\n  \"type\" in event.data;\n"],"mappings":";AAwBA,MAAa,iBAAiB,UAAqC;CACjE,KAAK,SAAS;EACZ,OAAO,KAAK,iBAAiB,WAAW,OAAO;CACjD;CACA,OAAO;EACL,OAAO,KAAK,iBAAiB,WAAW,EAAE,MAAM,OAAO,CAA0B;CACnF;CACA,SAAS,KAAK;EACZ,OAAO,KAAK,iBAAiB,WAAW;GAAE,MAAM;GAAY;EAAI,CAA0B;CAC5F;CACA,SAAS,IAAI;EACX,OAAO,KAAK,iBAAiB,WAAW;GAAE,MAAM;GAAY;EAAG,CAA0B;CAC3F;CACA,YAAY,SAAS;EACnB,OAAO,KAAK,iBAAiB,WAAW;GAAE,MAAM;GAAe;EAAQ,CAA0B;CACnG;AACF;AAEA,MAAa,kBAAkB,UAC7B,MAAM,MAAM,QAAQ,aACpB,OAAO,MAAM,SAAS,YACtB,MAAM,SAAS,QACf,UAAU,MAAM"}

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@opentray/ext-webview",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Official OpenTray rich popup extension backed by platform WebView engines.",
   "type": "module",
   "license": "MIT",
+  "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"
   },
@@ -21,6 +25,16 @@
     "opentray": ">=0.0.0"
   },
   "devDependencies": {
-    "opentray": "0.0.0"
+    "tsdown": "^0.22.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.7",
+    "@opentray/spec": "0.1.0",
+    "opentray": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm --dts",
+    "example:webview": "bun run examples/webview-command.ts",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
   }
 }