mirinjs 0.1.0-alpha.15 → 0.1.0-alpha.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mirinjs",
-  "version": "0.1.0-alpha.15",
+  "version": "0.1.0-alpha.17",
   "description": "Build desktop apps with Bun, TypeScript, and Chromium (CEF). The Bun-native Electron alternative.",
   "type": "module",
   "license": "MIT",

package/src/config/manifest.ts

@@ -311,6 +311,8 @@ export interface ReleaseConfig {
   baseUrl: string;
   /** Update channel; baked into artifact names + support dir. Default "stable". */
   channel?: string;
+  /** Optional markdown release notes embedded in the update manifest. */
+  notes?: string;
 }
 
 export interface CefConfig {

package/src/index.ts

@@ -50,10 +50,12 @@ export type { LogLevel } from "./logger.ts";
 export { getLogLevel, Logger, logger, setLogLevel } from "./logger.ts";
 export type { MenuItemTemplate, MenuRole } from "./menu.ts";
 export { menu } from "./menu.ts";
+export type { NotificationOptions } from "./notification.ts";
+export { notification } from "./notification.ts";
 export { NotAttachedError, resolveWorker } from "./runtime.ts";
 export { globalShortcut } from "./shortcut.ts";
 export type { SidecarOptions, SidecarProcess } from "./sidecar.ts";
-export { sidecar } from "./sidecar.ts";
+export { resolveSidecar, sidecar } from "./sidecar.ts";
 export type { TrayOptions } from "./tray.ts";
 export { Tray } from "./tray.ts";
 export type { UpdateInfo, UpdateProgress, UpdaterEvents, UpdaterStatus } from "./updater/index.ts";

package/src/native.ts

@@ -42,6 +42,7 @@ const symbols = {
   mirin_clipboard_read_text: { args: [], returns: FFIType.ptr },
   mirin_clipboard_write_text: { args: [FFIType.ptr], returns: FFIType.void },
   mirin_dialog_show: { args: [FFIType.ptr], returns: FFIType.void },
+  mirin_notification_show: { args: [FFIType.ptr], returns: FFIType.i32 },
 } as const;
 
 export type EventListener = (event: string) => void;
@@ -174,4 +175,9 @@ export class Core {
     const buf = nullTerminated(specJson);
     this.#lib.symbols.mirin_dialog_show(ptr(buf));
   }
+
+  notificationShow(specJson: string): boolean {
+    const buf = nullTerminated(specJson);
+    return this.#lib.symbols.mirin_notification_show(ptr(buf)) === 1;
+  }
 }

package/src/notification.ts

@@ -0,0 +1,19 @@
+import { runtime } from "./runtime.ts";
+
+export interface NotificationOptions {
+  title: string;
+  body?: string;
+}
+
+export const notification = {
+  /** Ask the operating system to display a desktop notification. */
+  show(options: NotificationOptions): boolean {
+    const title = options.title.trim();
+    if (!title || title.length > 128) return false;
+    if (options.body && options.body.length > 512) return false;
+
+    return runtime().core.notificationShow(
+      JSON.stringify({ ...options, title, appName: runtime().id }),
+    );
+  },
+};

package/src/sidecar.ts

@@ -36,6 +36,17 @@ export interface SidecarProcess {
   kill(signal?: number | NodeJS.Signals): void;
 }
 
+/** Resolve a declared sidecar's staged/bundled path without starting it. */
+export function resolveSidecar(name: string): string {
+  const dir = runtime().sidecarDir;
+  if (!dir) {
+    throw new Error(
+      `resolveSidecar("${name}"): no sidecar dir (is this running under the mirin host?)`,
+    );
+  }
+  return join(dir, name);
+}
+
 const children = new Set<Bun.Subprocess>();
 let hooked = false;
 
@@ -68,15 +79,9 @@ function ensureHooks(): void {
  * isn't attached or no `sidecarDir` is known (e.g. run outside the host).
  */
 export function sidecar(name: string, opts: SidecarOptions = {}): SidecarProcess {
-  const dir = runtime().sidecarDir;
-  if (!dir) {
-    throw new Error(
-      `app.sidecar("${name}"): no sidecar dir (is this running under the mirin host?)`,
-    );
-  }
   ensureHooks();
 
-  const bin = join(dir, name);
+  const bin = resolveSidecar(name);
   const child = Bun.spawn([bin, ...(opts.args ?? [])], {
     cwd: opts.cwd,
     env: opts.env ? { ...process.env, ...opts.env } : process.env,

package/src/updater/lib/manifest.ts

@@ -8,11 +8,13 @@ export function parseManifest(
   expected: { channel: string; platform: string; arch: string },
 ): Manifest {
   const manifest = record(value, "manifest");
+  const body = optionalStringField(manifest, "body", 64 * 1024);
   const parsed: Manifest = {
     version: versionField(manifest, "version"),
     channel: stringField(manifest, "channel"),
     platform: stringField(manifest, "platform"),
     arch: stringField(manifest, "arch"),
+    ...(body === undefined ? {} : { body }),
     tarHash: sha256Field(manifest, "tarHash"),
     bundle: artifactField(manifest.bundle, "bundle"),
     patches: patchesField(manifest.patches),
@@ -44,6 +46,19 @@ function stringField(source: Record<string, unknown>, key: string): string {
   return value;
 }
 
+function optionalStringField(
+  source: Record<string, unknown>,
+  key: string,
+  maxLength: number,
+): string | undefined {
+  const value = source[key];
+  if (value === undefined) return undefined;
+  if (typeof value !== "string" || value.length > maxLength) {
+    throw new Error(`invalid update manifest field: ${key}`);
+  }
+  return value;
+}
+
 function versionField(source: Record<string, unknown>, key: string): string {
   const value = stringField(source, key);
   if (

package/src/updater/types.ts

@@ -32,6 +32,8 @@ export interface Manifest {
   channel: string;
   platform: string;
   arch: string;
+  /** Optional markdown release notes shown by app UIs. */
+  body?: string;
   /** SHA-256 of the uncompressed bundle tar (update identity + integrity). */
   tarHash: string;
   bundle: UpdateArtifact;
@@ -43,6 +45,8 @@ export interface UpdateInfo {
   version: string;
   currentVersion: string;
   channel: string;
+  /** Optional markdown release notes from the update manifest. */
+  body?: string;
 }
 
 export interface UpdateProgress {

package/src/updater/updater.ts

@@ -95,6 +95,7 @@ export class Updater {
         version: m.version,
         currentVersion: v.version,
         channel: v.channel,
+        body: m.body,
       };
       this.#setStatus("update-available");
       this.#emit("update-available", info);