@gd-kirie/tray 0.0.0-stage → 0.12.0

package/README.md

@@ -1,3 +1,24 @@
-# 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` adds system tray support to desktop Kirie applications. It
+uses the application's existing Eventa context.
+
+Add the plugin to `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],
+});
+```
+
+Install the plugin dependencies:
+
+```sh
+pnpm kirie doctor --fix plugin:tray
+```
+
+See the [`tray` example](../../examples/tray/README.md) for a complete setup.

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import { InboundEventa } from "@moeru/eventa";
+import { KirieEventaContext } from "@gd-kirie/ipc-eventa";
+
+//#region src/index.d.ts
+interface TrayIcon {
+  icon: string;
+  iconAsTemplate?: boolean;
+}
+type TrayMenuItem = {
+  type: "item";
+  id: string;
+  text: string;
+  enabled?: boolean;
+} | {
+  type: "check";
+  id: string;
+  text: string;
+  enabled?: boolean;
+  checked?: boolean;
+} | {
+  type: "submenu";
+  text: string;
+  enabled?: boolean;
+  children: TrayMenuItem[];
+} | {
+  type: "separator";
+};
+interface TrayClient {
+  create: (icon: TrayIcon) => Promise<void>;
+  setIcon: (icon: TrayIcon) => Promise<void>;
+  setMenu: (items: TrayMenuItem[]) => Promise<void>;
+  setTooltip: (tooltip: string | null) => Promise<void>;
+  setVisible: (visible: boolean) => Promise<void>;
+  destroy: () => Promise<void>;
+}
+declare const trayMenuItemActivated: InboundEventa<string>;
+declare function createTrayClient(context: KirieEventaContext): TrayClient;
+//#endregion
+export { TrayClient, TrayIcon, TrayMenuItem, 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":";;;;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

@@ -0,0 +1,38 @@
+import { defineInboundEventa, defineInvokeEventa, defineInvokes } from "@moeru/eventa";
+//#region src/index.ts
+const events = {
+	create: defineInvokeEventa("kirie:tray:create"),
+	setIcon: defineInvokeEventa("kirie:tray:set-icon"),
+	setMenu: defineInvokeEventa("kirie:tray:set-menu"),
+	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 create(icon) {
+			await invokes.create(icon);
+		},
+		async setIcon(icon) {
+			await invokes.setIcon(icon);
+		},
+		async setMenu(items) {
+			await invokes.setMenu(items);
+		},
+		async setTooltip(tooltip) {
+			await invokes.setTooltip(tooltip);
+		},
+		async setVisible(visible) {
+			await invokes.setVisible(visible);
+		},
+		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 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.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.12.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-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,46 @@
 {
   "name": "@gd-kirie/tray",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.12.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.12.0",
+    "@moeru/eventa": "^1.0.2"
+  },
+  "peerDependencies": {
+    "kirie": "^0.12.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"
+  }
 }