@gd-kirie/tray 0.0.0-stage → 0.11.0

package/README.md

@@ -1,3 +1,48 @@
-# Temporary Holding Version
+# `@gd-kirie/tray`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@gd-kirie/tray` exposes system tray and native menu capabilities over an
+existing Kirie Eventa context.
+
+Install the plugin explicitly in `kirie.config.ts`:
+
+```ts
+import tray from "@gd-kirie/tray/plugin";
+import { defineKirieConfig } from "kirie";
+import core from "kirie/plugin/core";
+
+export default defineKirieConfig({
+  plugins: [core, tray],
+});
+```
+
+Create the browser client from the same context used by the application:
+
+```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 });
+```
+
+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.

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+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 {
+  icon: string;
+  /** Render the icon as a macOS template image. Non-macOS hosts reject `true`. */
+  iconAsTemplate?: boolean;
+  tooltip?: string;
+  visible?: boolean;
+}
+interface TrayMenuItem {
+  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"> {
+  id: string;
+  clearIcon?: boolean;
+}
+interface TrayClient {
+  configure: (configuration: TrayConfiguration) => Promise<void>;
+  setMenu: (items: TrayMenuItem[]) => Promise<void>;
+  updateItem: (update: TrayMenuItemUpdate) => Promise<void>;
+  destroy: () => Promise<void>;
+}
+declare const trayMenuItemActivated: InboundEventa<{
+  id: string;
+}>;
+declare function createTrayClient(context: KirieEventaContext): TrayClient;
+//#endregion
+export { TrayClient, TrayConfiguration, TrayMenuItem, TrayMenuItemType, TrayMenuItemUpdate, createTrayClient, trayMenuItemActivated };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/index.js

@@ -0,0 +1,30 @@
+import { defineInboundEventa, defineInvokeEventa, defineInvokes } from "@moeru/eventa";
+//#region src/index.ts
+const events = {
+	configure: defineInvokeEventa("kirie:tray:configure"),
+	setMenu: defineInvokeEventa("kirie:tray:set-menu"),
+	updateItem: defineInvokeEventa("kirie:tray:update-item"),
+	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 setMenu(items) {
+			await invokes.setMenu(items);
+		},
+		async updateItem(update) {
+			await invokes.updateItem(update);
+		},
+		async destroy() {
+			await invokes.destroy({});
+		}
+	};
+}
+//#endregion
+export { createTrayClient, trayMenuItemActivated };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/plugin.d.ts

@@ -0,0 +1,7 @@
+import { KiriePlugin } from "kirie/plugin";
+
+//#region src/plugin.d.ts
+declare const _default: KiriePlugin;
+//#endregion
+export { _default as default };
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","names":[],"sources":["../src/plugin.ts"],"mappings":";;;cAMA,QAAA,EAQM,WAAA"}

package/dist/plugin.js

@@ -0,0 +1,14 @@
+import { defineKiriePlugin } from "kirie/plugin";
+//#endregion
+//#region src/plugin.ts
+var plugin_default = defineKiriePlugin({
+	id: "tray",
+	dotnetPackages: [{
+		id: "GdKirie.Tray",
+		version: "0.11.0"
+	}]
+});
+//#endregion
+export { plugin_default as default };
+
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +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"}

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@gd-kirie/tray",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.11.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/moeru-ai/godot-kirie.git",
+    "directory": "packages/tray"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@gd-kirie/ipc-eventa": "0.11.0",
+    "@moeru/eventa": "^1.0.2"
+  },
+  "peerDependencies": {
+    "kirie": "^0.11.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.22.2",
+    "typescript": "^6.0.3",
+    "vitest": "4.1.10"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test:run": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
 }