@gd-kirie/tray 0.11.0 → 0.12.0

package/README.md

@@ -1,9 +1,9 @@
 # `@gd-kirie/tray`
 
-`@gd-kirie/tray` exposes system tray and native menu capabilities over an
-existing Kirie Eventa context.
+`@gd-kirie/tray` adds system tray support to desktop Kirie applications. It
+uses the application's existing Eventa context.
 
-Install the plugin explicitly in `kirie.config.ts`:
+Add the plugin to `kirie.config.ts`:
 
 ```ts
 import tray from "@gd-kirie/tray/plugin";
@@ -15,34 +15,10 @@ export default defineKirieConfig({
 });
 ```
 
-Create the browser client from the same context used by the application:
+Install the plugin dependencies:
 
-```ts
-import { createContext } from "@gd-kirie/ipc-eventa";
-import { createTrayClient, trayMenuItemActivated } from "@gd-kirie/tray";
-
-const eventa = createContext();
-const tray = createTrayClient(eventa.context);
-
-await tray.configure({
-  icon: "res://tray-template.svg",
-  iconAsTemplate: true,
-  tooltip: "Kirie",
-});
-await tray.setMenu([
-  { id: "show", text: "Show Kirie" },
-  { id: "enabled", text: "Enabled", type: "check", checked: true },
-]);
-const stop = eventa.context.on(trayMenuItemActivated, ({ body }) => console.log(body?.id));
-await tray.updateItem({ id: "enabled", checked: false });
+```sh
+pnpm kirie doctor --fix plugin:tray
 ```
 
-Browser icons are imported Godot resources referenced by `res://` paths. Use
-black artwork with transparency when `iconAsTemplate` is enabled. The option is
-supported only on macOS; other platforms reject `true`. See Apple's
-[`NSImage.isTemplate`](https://developer.apple.com/documentation/appkit/nsimage/istemplate)
-documentation for the native rendering behavior.
-
-Menu types are `item`, `check`, `radio`, `multistate`, `separator`, and
-`submenu`. IDs must be non-empty and unique across the menu tree. The tray
-survives browser reloads and is destroyed explicitly or with its C# host.
+See the [`tray` example](../../examples/tray/README.md) for a complete setup.

package/dist/index.d.ts

@@ -2,42 +2,39 @@ import { InboundEventa } from "@moeru/eventa";
 import { KirieEventaContext } from "@gd-kirie/ipc-eventa";
 
 //#region src/index.d.ts
-type TrayMenuItemType = "item" | "check" | "radio" | "multistate" | "separator" | "submenu";
-interface TrayConfiguration {
+interface TrayIcon {
   icon: string;
-  /** Render the icon as a macOS template image. Non-macOS hosts reject `true`. */
   iconAsTemplate?: boolean;
-  tooltip?: string;
-  visible?: boolean;
 }
-interface TrayMenuItem {
+type TrayMenuItem = {
+  type: "item";
   id: string;
   text: string;
-  type?: TrayMenuItemType;
-  icon?: string;
-  accelerator?: number;
-  disabled?: boolean;
-  checked?: boolean;
-  state?: number;
-  maxStates?: number;
-  tooltip?: string;
-  indent?: number;
-  children?: TrayMenuItem[];
-}
-interface TrayMenuItemUpdate extends Omit<Partial<TrayMenuItem>, "id" | "type" | "children"> {
+  enabled?: boolean;
+} | {
+  type: "check";
   id: string;
-  clearIcon?: boolean;
-}
+  text: string;
+  enabled?: boolean;
+  checked?: boolean;
+} | {
+  type: "submenu";
+  text: string;
+  enabled?: boolean;
+  children: TrayMenuItem[];
+} | {
+  type: "separator";
+};
 interface TrayClient {
-  configure: (configuration: TrayConfiguration) => Promise<void>;
+  create: (icon: TrayIcon) => Promise<void>;
+  setIcon: (icon: TrayIcon) => Promise<void>;
   setMenu: (items: TrayMenuItem[]) => Promise<void>;
-  updateItem: (update: TrayMenuItemUpdate) => Promise<void>;
+  setTooltip: (tooltip: string | null) => Promise<void>;
+  setVisible: (visible: boolean) => Promise<void>;
   destroy: () => Promise<void>;
 }
-declare const trayMenuItemActivated: InboundEventa<{
-  id: string;
-}>;
+declare const trayMenuItemActivated: InboundEventa<string>;
 declare function createTrayClient(context: KirieEventaContext): TrayClient;
 //#endregion
-export { TrayClient, TrayConfiguration, TrayMenuItem, TrayMenuItemType, TrayMenuItemUpdate, createTrayClient, trayMenuItemActivated };
+export { TrayClient, TrayIcon, TrayMenuItem, createTrayClient, trayMenuItemActivated };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;;KAIY,gBAAA;AAAA,UAEK,iBAAA;EACf,IAAA;EAHU;EAKV,cAAA;EACA,OAAA;EACA,OAAA;AAAA;AAAA,UAGe,YAAA;EACf,EAAA;EACA,IAAA;EACA,IAAA,GAAO,gBAAA;EACP,IAAA;EACA,WAAA;EACA,QAAA;EACA,OAAA;EACA,KAAA;EACA,SAAA;EACA,OAAA;EACA,MAAA;EACA,QAAA,GAAW,YAAA;AAAA;AAAA,UAGI,kBAAA,SAA2B,IAAA,CAAK,OAAA,CAAQ,YAAA;EACvD,EAAA;EACA,SAAA;AAAA;AAAA,UAGe,UAAA;EACf,SAAA,GAAY,aAAA,EAAe,iBAAA,KAAsB,OAAA;EACjD,OAAA,GAAU,KAAA,EAAO,YAAA,OAAmB,OAAA;EACpC,UAAA,GAAa,MAAA,EAAQ,kBAAA,KAAuB,OAAA;EAC5C,OAAA,QAAe,OAAA;AAAA;AAAA,cAYJ,qBAAA,EAAuB,aAAA;EAAgB,EAAA;AAAA;AAAA,iBAIpC,gBAAA,CAAiB,OAAA,EAAS,kBAAA,GAAqB,UAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;;UAIiB,QAAA;EACf,IAAA;EACA,cAAA;AAAA;AAAA,KAGU,YAAA;EACN,IAAA;EAAc,EAAA;EAAY,IAAA;EAAc,OAAA;AAAA;EAC1C,IAAA;EAAe,EAAA;EAAY,IAAA;EAAc,OAAA;EAAmB,OAAA;AAAA;EAC5D,IAAA;EAAiB,IAAA;EAAc,OAAA;EAAmB,QAAA,EAAU,YAAA;AAAA;EAC5D,IAAA;AAAA;AAAA,UAEa,UAAA;EACf,MAAA,GAAS,IAAA,EAAM,QAAA,KAAa,OAAA;EAC5B,OAAA,GAAU,IAAA,EAAM,QAAA,KAAa,OAAA;EAC7B,OAAA,GAAU,KAAA,EAAO,YAAA,OAAmB,OAAA;EACpC,UAAA,GAAa,OAAA,oBAA2B,OAAA;EACxC,UAAA,GAAa,OAAA,cAAqB,OAAA;EAClC,OAAA,QAAe,OAAA;AAAA;AAAA,cAcJ,qBAAA,EAAuB,aAAA;AAAA,iBAIpB,gBAAA,CAAiB,OAAA,EAAS,kBAAA,GAAqB,UAAA"}

package/dist/index.js

@@ -1,23 +1,31 @@
 import { defineInboundEventa, defineInvokeEventa, defineInvokes } from "@moeru/eventa";
 //#region src/index.ts
 const events = {
-	configure: defineInvokeEventa("kirie:tray:configure"),
+	create: defineInvokeEventa("kirie:tray:create"),
+	setIcon: defineInvokeEventa("kirie:tray:set-icon"),
 	setMenu: defineInvokeEventa("kirie:tray:set-menu"),
-	updateItem: defineInvokeEventa("kirie:tray:update-item"),
+	setTooltip: defineInvokeEventa("kirie:tray:set-tooltip"),
+	setVisible: defineInvokeEventa("kirie:tray:set-visible"),
 	destroy: defineInvokeEventa("kirie:tray:destroy")
 };
 const trayMenuItemActivated = defineInboundEventa("kirie:tray:menu-item-activated");
 function createTrayClient(context) {
 	const invokes = defineInvokes(context, events);
 	return {
-		async configure(configuration) {
-			await invokes.configure(configuration);
+		async create(icon) {
+			await invokes.create(icon);
+		},
+		async setIcon(icon) {
+			await invokes.setIcon(icon);
 		},
 		async setMenu(items) {
 			await invokes.setMenu(items);
 		},
-		async updateItem(update) {
-			await invokes.updateItem(update);
+		async setTooltip(tooltip) {
+			await invokes.setTooltip(tooltip);
+		},
+		async setVisible(visible) {
+			await invokes.setVisible(visible);
 		},
 		async destroy() {
 			await invokes.destroy({});

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { KirieEventaContext } from \"@gd-kirie/ipc-eventa\";\nimport type { InboundEventa } from \"@moeru/eventa\";\nimport { defineInboundEventa, defineInvokeEventa, defineInvokes } from \"@moeru/eventa\";\n\nexport type TrayMenuItemType = \"item\" | \"check\" | \"radio\" | \"multistate\" | \"separator\" | \"submenu\";\n\nexport interface TrayConfiguration {\n  icon: string;\n  /** Render the icon as a macOS template image. Non-macOS hosts reject `true`. */\n  iconAsTemplate?: boolean;\n  tooltip?: string;\n  visible?: boolean;\n}\n\nexport interface TrayMenuItem {\n  id: string;\n  text: string;\n  type?: TrayMenuItemType;\n  icon?: string;\n  accelerator?: number;\n  disabled?: boolean;\n  checked?: boolean;\n  state?: number;\n  maxStates?: number;\n  tooltip?: string;\n  indent?: number;\n  children?: TrayMenuItem[];\n}\n\nexport interface TrayMenuItemUpdate extends Omit<Partial<TrayMenuItem>, \"id\" | \"type\" | \"children\"> {\n  id: string;\n  clearIcon?: boolean;\n}\n\nexport interface TrayClient {\n  configure: (configuration: TrayConfiguration) => Promise<void>;\n  setMenu: (items: TrayMenuItem[]) => Promise<void>;\n  updateItem: (update: TrayMenuItemUpdate) => Promise<void>;\n  destroy: () => Promise<void>;\n}\n\ntype EmptyPayload = Record<string, never>;\n\nconst events = {\n  configure: defineInvokeEventa<EmptyPayload, TrayConfiguration>(\"kirie:tray:configure\"),\n  setMenu: defineInvokeEventa<EmptyPayload, TrayMenuItem[]>(\"kirie:tray:set-menu\"),\n  updateItem: defineInvokeEventa<EmptyPayload, TrayMenuItemUpdate>(\"kirie:tray:update-item\"),\n  destroy: defineInvokeEventa<EmptyPayload, EmptyPayload>(\"kirie:tray:destroy\"),\n};\n\nexport const trayMenuItemActivated: InboundEventa<{ id: string }> = defineInboundEventa(\n  \"kirie:tray:menu-item-activated\",\n);\n\nexport function createTrayClient(context: KirieEventaContext): TrayClient {\n  const invokes = defineInvokes(context, events);\n\n  return {\n    async configure(configuration) {\n      await invokes.configure(configuration);\n    },\n    async setMenu(items) {\n      await invokes.setMenu(items);\n    },\n    async updateItem(update) {\n      await invokes.updateItem(update);\n    },\n    async destroy() {\n      await invokes.destroy({});\n    },\n  };\n}\n"],"mappings":";;AA2CA,MAAM,SAAS;CACb,WAAW,mBAAoD,sBAAsB;CACrF,SAAS,mBAAiD,qBAAqB;CAC/E,YAAY,mBAAqD,wBAAwB;CACzF,SAAS,mBAA+C,oBAAoB;AAC9E;AAEA,MAAa,wBAAuD,oBAClE,gCACF;AAEA,SAAgB,iBAAiB,SAAyC;CACxE,MAAM,UAAU,cAAc,SAAS,MAAM;CAE7C,OAAO;EACL,MAAM,UAAU,eAAe;GAC7B,MAAM,QAAQ,UAAU,aAAa;EACvC;EACA,MAAM,QAAQ,OAAO;GACnB,MAAM,QAAQ,QAAQ,KAAK;EAC7B;EACA,MAAM,WAAW,QAAQ;GACvB,MAAM,QAAQ,WAAW,MAAM;EACjC;EACA,MAAM,UAAU;GACd,MAAM,QAAQ,QAAQ,CAAC,CAAC;EAC1B;CACF;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { KirieEventaContext } from \"@gd-kirie/ipc-eventa\";\nimport type { InboundEventa } from \"@moeru/eventa\";\nimport { defineInboundEventa, defineInvokeEventa, defineInvokes } from \"@moeru/eventa\";\n\nexport interface TrayIcon {\n  icon: string;\n  iconAsTemplate?: boolean;\n}\n\nexport type TrayMenuItem =\n  | { type: \"item\"; id: string; text: string; enabled?: boolean } |\n  { type: \"check\"; id: string; text: string; enabled?: boolean; checked?: boolean } |\n  { type: \"submenu\"; text: string; enabled?: boolean; children: TrayMenuItem[] } |\n  { type: \"separator\" };\n\nexport interface TrayClient {\n  create: (icon: TrayIcon) => Promise<void>;\n  setIcon: (icon: TrayIcon) => Promise<void>;\n  setMenu: (items: TrayMenuItem[]) => Promise<void>;\n  setTooltip: (tooltip: string | null) => Promise<void>;\n  setVisible: (visible: boolean) => Promise<void>;\n  destroy: () => Promise<void>;\n}\n\ntype EmptyPayload = Record<string, never>;\n\nconst events = {\n  create: defineInvokeEventa<EmptyPayload, TrayIcon>(\"kirie:tray:create\"),\n  setIcon: defineInvokeEventa<EmptyPayload, TrayIcon>(\"kirie:tray:set-icon\"),\n  setMenu: defineInvokeEventa<EmptyPayload, TrayMenuItem[]>(\"kirie:tray:set-menu\"),\n  setTooltip: defineInvokeEventa<EmptyPayload, string | null>(\"kirie:tray:set-tooltip\"),\n  setVisible: defineInvokeEventa<EmptyPayload, boolean>(\"kirie:tray:set-visible\"),\n  destroy: defineInvokeEventa<EmptyPayload, EmptyPayload>(\"kirie:tray:destroy\"),\n};\n\nexport const trayMenuItemActivated: InboundEventa<string> = defineInboundEventa(\n  \"kirie:tray:menu-item-activated\",\n);\n\nexport function createTrayClient(context: KirieEventaContext): TrayClient {\n  const invokes = defineInvokes(context, events);\n\n  return {\n    async create(icon) {\n      await invokes.create(icon);\n    },\n    async setIcon(icon) {\n      await invokes.setIcon(icon);\n    },\n    async setMenu(items) {\n      await invokes.setMenu(items);\n    },\n    async setTooltip(tooltip) {\n      await invokes.setTooltip(tooltip);\n    },\n    async setVisible(visible) {\n      await invokes.setVisible(visible);\n    },\n    async destroy() {\n      await invokes.destroy({});\n    },\n  };\n}\n"],"mappings":";;AA0BA,MAAM,SAAS;CACb,QAAQ,mBAA2C,mBAAmB;CACtE,SAAS,mBAA2C,qBAAqB;CACzE,SAAS,mBAAiD,qBAAqB;CAC/E,YAAY,mBAAgD,wBAAwB;CACpF,YAAY,mBAA0C,wBAAwB;CAC9E,SAAS,mBAA+C,oBAAoB;AAC9E;AAEA,MAAa,wBAA+C,oBAC1D,gCACF;AAEA,SAAgB,iBAAiB,SAAyC;CACxE,MAAM,UAAU,cAAc,SAAS,MAAM;CAE7C,OAAO;EACL,MAAM,OAAO,MAAM;GACjB,MAAM,QAAQ,OAAO,IAAI;EAC3B;EACA,MAAM,QAAQ,MAAM;GAClB,MAAM,QAAQ,QAAQ,IAAI;EAC5B;EACA,MAAM,QAAQ,OAAO;GACnB,MAAM,QAAQ,QAAQ,KAAK;EAC7B;EACA,MAAM,WAAW,SAAS;GACxB,MAAM,QAAQ,WAAW,OAAO;EAClC;EACA,MAAM,WAAW,SAAS;GACxB,MAAM,QAAQ,WAAW,OAAO;EAClC;EACA,MAAM,UAAU;GACd,MAAM,QAAQ,QAAQ,CAAC,CAAC;EAC1B;CACF;AACF"}

package/dist/plugin.js

@@ -5,7 +5,7 @@ var plugin_default = defineKiriePlugin({
 	id: "tray",
 	dotnetPackages: [{
 		id: "GdKirie.Tray",
-		version: "0.11.0"
+		version: "0.12.0"
 	}]
 });
 //#endregion

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","names":["packageJson.version"],"sources":["../package.json","../src/plugin.ts"],"sourcesContent":["","import type { KiriePlugin } from \"kirie/plugin\";\nimport { defineKiriePlugin } from \"kirie/plugin\";\nimport packageJson from \"../package.json\" with { type: \"json\" };\n\n// ADR-0012: Tray is installed explicitly and owns its .NET host dependency.\n// See docs/decisions/0012-extract-system-tray-into-a-kirie-plugin.md.\nexport default defineKiriePlugin({\n  id: \"tray\",\n  dotnetPackages: [\n    {\n      id: \"GdKirie.Tray\",\n      version: packageJson.version,\n    },\n  ],\n}) as KiriePlugin;\n"],"mappings":";;;ACMA,IAAA,iBAAe,kBAAkB;CAC/B,IAAI;CACJ,gBAAgB,CACd;EACE,IAAI;EACKA;CACX,CACF;AACF,CAAC"}
+{"version":3,"file":"plugin.js","names":["packageJson.version"],"sources":["../package.json","../src/plugin.ts"],"sourcesContent":["","import type { KiriePlugin } from \"kirie/plugin\";\nimport { defineKiriePlugin } from \"kirie/plugin\";\nimport packageJson from \"../package.json\" with { type: \"json\" };\n\n// ADR-0013: Tray stays an explicit plugin and owns its .NET and native host.\n// See docs/decisions/0013-use-tray-icon-for-the-tray-plugin.md.\nexport default defineKiriePlugin({\n  id: \"tray\",\n  dotnetPackages: [\n    {\n      id: \"GdKirie.Tray\",\n      version: packageJson.version,\n    },\n  ],\n}) as KiriePlugin;\n"],"mappings":";;;ACMA,IAAA,iBAAe,kBAAkB;CAC/B,IAAI;CACJ,gBAAgB,CACd;EACE,IAAI;EACKA;CACX,CACF;AACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gd-kirie/tray",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -23,11 +23,11 @@
     "dist"
   ],
   "dependencies": {
-    "@gd-kirie/ipc-eventa": "0.11.0",
+    "@gd-kirie/ipc-eventa": "0.12.0",
     "@moeru/eventa": "^1.0.2"
   },
   "peerDependencies": {
-    "kirie": "^0.11.0"
+    "kirie": "^0.12.0"
   },
   "devDependencies": {
     "tsdown": "^0.22.2",