@weasel-js/hud 1.4.2 → 1.4.4

package/dist/attach.d.ts

@@ -1,10 +1,24 @@
 import type { Hud } from './hud';
 import type { CanvasExtensionApi } from '@weasel-js/core';
+import { type FontAtlasUrls } from './fonts/registerDefaultFont';
 import { type ResolvedTheme } from '@weasel-js/theme';
 export interface AttachHudOptions {
     /** Resolved theme the widgets draw with. Defaults to the built-in theme's
      *  default mode; pass `useTheme().resolved` to follow a live theme. */
     readonly theme?: ResolvedTheme;
+    /**
+     * Where the text a widget draws without naming a family comes from.
+     *
+     * - A family name: that family, already registered by the host. The HUD
+     *   fetches nothing, which is the point — an app that has registered Inter
+     *   as `'sans-serif'` was downloading the HUD's byte-identical copy of it a
+     *   second time.
+     * - A `{ metricsUrl, atlasUrl }` pair: the HUD's own family, registered from
+     *   the host's copy of the atlas rather than the bundled one.
+     *
+     * Unset, the bundled atlas is fetched and registered.
+     */
+    readonly font?: string | FontAtlasUrls;
 }
 /**
  * Bind a HUD to a canvas: register its render layer, route pointer input to

package/dist/attach.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attach.d.ts","sourceRoot":"","sources":["../src/attach.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,kBAAkB,EAA+B,MAAM,iBAAiB,CAAC;AAOvF,OAAO,EAA6B,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjF,MAAM,WAAW,gBAAgB;IAC/B;2EACuE;IACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,GAAG,EAAE,kBAAkB,EACvB,GAAG,EAAE,GAAG,EACR,OAAO,GAAE,gBAAqB,GAC7B,MAAM,IAAI,CAkIZ"}
+{"version":3,"file":"attach.d.ts","sourceRoot":"","sources":["../src/attach.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,kBAAkB,EAA+B,MAAM,iBAAiB,CAAC;AAIvF,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAA6B,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjF,MAAM,WAAW,gBAAgB;IAC/B;2EACuE;IACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IAC/B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CACxC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,GAAG,EAAE,kBAAkB,EACvB,GAAG,EAAE,GAAG,EACR,OAAO,GAAE,gBAAqB,GAC7B,MAAM,IAAI,CAwIZ"}

package/dist/fonts/registerDefaultFont.d.ts

@@ -1,7 +1,19 @@
 /** Family name the bundled HUD font registers under. Widgets that name no
  *  family draw with it. */
 export declare const DEFAULT_FONT_FAMILY = "weasel-hud-default";
-/** Register the bundled Inter atlas under `DEFAULT_FONT_FAMILY`. `attachHud`
- *  calls this; calling it again is a no-op. */
-export declare function registerDefaultFont(): Promise<void>;
+/** A bitmap face: the `registerFont` pair, as one value. */
+export interface FontAtlasUrls {
+    metricsUrl: string;
+    atlasUrl: string;
+}
+/**
+ * Register an Inter-shaped atlas under {@link DEFAULT_FONT_FAMILY}. `attachHud`
+ * calls this; calling it again is a no-op.
+ *
+ * `urls` points the family at a copy the host already serves. The bundled atlas
+ * is the same Inter every weasel app ships in its own publicDir, and fetching
+ * both costs a second 150 kB transfer and a second `createImageBitmap` for
+ * bytes already in memory.
+ */
+export declare function registerDefaultFont(urls?: FontAtlasUrls): Promise<void>;
 //# sourceMappingURL=registerDefaultFont.d.ts.map

package/dist/fonts/registerDefaultFont.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registerDefaultFont.d.ts","sourceRoot":"","sources":["../../src/fonts/registerDefaultFont.ts"],"names":[],"mappings":"AAOA;2BAC2B;AAC3B,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AAExD;+CAC+C;AAC/C,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzD"}
+{"version":3,"file":"registerDefaultFont.d.ts","sourceRoot":"","sources":["../../src/fonts/registerDefaultFont.ts"],"names":[],"mappings":"AAOA;2BAC2B;AAC3B,eAAO,MAAM,mBAAmB,uBAAuB,CAAC;AAExD,4DAA4D;AAC5D,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAO7E"}

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export type { Widget, WidgetBounds, HudDrawCtx, HudPointerEvent, } from './widge
 export { DEFAULT_WIDGET_CLAIMS, claimsOf } from './widget';
 export type { HudHost } from './host';
 export { DEFAULT_FONT_FAMILY, registerDefaultFont } from './fonts/registerDefaultFont';
+export type { FontAtlasUrls } from './fonts/registerDefaultFont';
 export type { RectOptions, RectWidget } from './widgets/rect';
 export type { TextOptions, TextWidget } from './widgets/text';
 export type { ImageOptions, ImageWidget } from './widgets/image';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AACxF,YAAY,EACV,MAAM,EACN,YAAY,EACZ,UAAU,EACV,eAAe,GAChB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC3D,YAAY,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvF,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9D,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACjE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACjE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAChG,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EACL,sBAAsB,EAAE,aAAa,EACrC,KAAK,UAAU,EAAE,KAAK,aAAa,GACpC,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACvG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AACxF,YAAY,EACV,MAAM,EACN,YAAY,EACZ,UAAU,EACV,eAAe,GAChB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC3D,YAAY,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvF,YAAY,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AACjE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9D,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACjE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACjE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAChG,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EACL,sBAAsB,EAAE,aAAa,EACrC,KAAK,UAAU,EAAE,KAAK,aAAa,GACpC,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACvG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,4 +1,4 @@
-import { a as e, c as t, i as n, l as r, n as i, o as a, r as o, s, t as c, u as l } from "./tool-sq7ioZyd.js";
+import { a as e, c as t, i as n, l as r, n as i, o as a, r as o, s, t as c, u as l } from "./tool-ahNtvOfu.js";
 import { createViewportLayer as u, screenToWorld as d, viewToTransform as f } from "@weasel-js/core";
 import { createLoupeModel as p, loupeInnerView as m, loupeInnerView as h } from "@weasel-js/loupe";
 //#region src/loupe/readback.ts

package/dist/react/index.js

@@ -1,16 +1,23 @@
-import { c as e, n as t, r as n } from "../tool-sq7ioZyd.js";
+import { c as e, n as t, r as n } from "../tool-ahNtvOfu.js";
 import { resolveTheme as r, weaselTheme as i } from "@weasel-js/theme";
 import { useEffect as a, useMemo as o, useState as s } from "react";
 import { useThemeOptional as c } from "@weasel-js/theme/react";
 //#region src/react/useHud.ts
-function l(t) {
-	let [l] = s(() => e()), u = c(), d = o(() => u?.resolved ?? r(i, i.defaultMode), [u]);
+function l(t, l = {}) {
+	let [u] = s(() => e()), d = c(), f = o(() => d?.resolved ?? r(i, i.defaultMode), [d]), p = l.font;
 	return a(() => {
 		let e = t.current;
 		if (!e) return;
-		let r = n(e, l, { theme: d });
+		let r = n(e, u, {
+			theme: f,
+			...p === void 0 ? {} : { font: p }
+		});
 		return e.requestRedraw(), r;
-	}, [l, d]), l;
+	}, [
+		u,
+		f,
+		p
+	]), u;
 }
 function u() {
 	return o(() => t(), []);

package/dist/react/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/react/useHud.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'react';\nimport { useThemeOptional } from '@weasel-js/theme/react';\nimport { resolveTheme, weaselTheme } from '@weasel-js/theme';\nimport { createHud, type Hud } from '../hud';\nimport { attachHud } from '../attach';\nimport type { CanvasExtensionApi, Contribution } from '@weasel-js/core';\nimport { createHudContribution } from '../tool';\n\n/**\n * Create a HUD and attach it to a Canvas via its imperative ref handle.\n * Returns the Hud immediately (unbound); attaches in an effect after the\n * canvas ref populates. Cleans up on unmount.\n *\n * Usage:\n *   const ref = useRef<CanvasExtensionApi>(null);\n *   const hud = useHud(ref);\n *   // ... later\n *   const btn = hud.button({ ... });\n */\nexport function useHud(canvasRef: { current: CanvasExtensionApi | null }): Hud {\n  const [hud] = useState(() => createHud());\n\n  // Follow the app's theme when there is one. Widgets are drawn into the\n  // canvas, so they can't inherit the cascade — handing them the resolved\n  // record is what keeps HUD chrome in step with a mode switch.\n  const provided = useThemeOptional();\n  const theme = useMemo(\n    () => provided?.resolved ?? resolveTheme(weaselTheme, weaselTheme.defaultMode),\n    [provided],\n  );\n\n  useEffect(() => {\n    const api = canvasRef.current;\n    if (!api) return;\n    const detach = attachHud(api, hud, { theme });\n    api.requestRedraw();\n    return detach;\n    // canvasRef.current changing during component lifetime is unusual for\n    // canvas refs; treat as effectively-stable in v1. The dep on `hud` is\n    // also stable (it comes from useState's initializer, never changes).\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [hud, theme]);\n\n  return hud;\n}\n\n/**\n * Memoize the HUD's input contribution — see {@link createHudContribution}\n * for how the routing works.\n *\n * It is stateless (its actions resolve the hit widget from the gesture's\n * affordance payload), so one instance serves any number of HUDs on the page.\n */\nexport function useHudContribution(): Contribution {\n  return useMemo(() => createHudContribution(), []);\n}\n"],"mappings":";;;;;AAmBA,SAAgB,EAAO,GAAwD;CAC7E,IAAM,CAAC,KAAO,QAAe,GAAW,CAAC,EAKnC,IAAW,GAAkB,EAC7B,IAAQ,QACN,GAAU,YAAY,EAAa,GAAa,EAAY,YAAY,EAC9E,CAAC,EAAS,CACX;AAcD,QAZA,QAAgB;EACd,IAAM,IAAM,EAAU;AACtB,MAAI,CAAC,EAAK;EACV,IAAM,IAAS,EAAU,GAAK,GAAK,EAAE,UAAO,CAAC;AAE7C,SADA,EAAI,eAAe,EACZ;IAKN,CAAC,GAAK,EAAM,CAAC,EAET;;AAUT,SAAgB,IAAmC;AACjD,QAAO,QAAc,GAAuB,EAAE,EAAE,CAAC"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/react/useHud.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'react';\nimport { useThemeOptional } from '@weasel-js/theme/react';\nimport { resolveTheme, weaselTheme } from '@weasel-js/theme';\nimport { createHud, type Hud } from '../hud';\nimport { attachHud, type AttachHudOptions } from '../attach';\nimport type { CanvasExtensionApi, Contribution } from '@weasel-js/core';\nimport { createHudContribution } from '../tool';\n\n/**\n * Create a HUD and attach it to a Canvas via its imperative ref handle.\n * Returns the Hud immediately (unbound); attaches in an effect after the\n * canvas ref populates. Cleans up on unmount.\n *\n * Usage:\n *   const ref = useRef<CanvasExtensionApi>(null);\n *   const hud = useHud(ref);\n *   // ... later\n *   const btn = hud.button({ ... });\n *\n * An app that has already registered a bitmap family should say so —\n * `useHud(ref, { font: 'sans-serif' })` — or the HUD fetches its own copy of\n * the same atlas.\n */\nexport function useHud(\n  canvasRef: { current: CanvasExtensionApi | null },\n  options: Pick<AttachHudOptions, 'font'> = {},\n): Hud {\n  const [hud] = useState(() => createHud());\n\n  // Follow the app's theme when there is one. Widgets are drawn into the\n  // canvas, so they can't inherit the cascade — handing them the resolved\n  // record is what keeps HUD chrome in step with a mode switch.\n  const provided = useThemeOptional();\n  const theme = useMemo(\n    () => provided?.resolved ?? resolveTheme(weaselTheme, weaselTheme.defaultMode),\n    [provided],\n  );\n\n  const font = options.font;\n  useEffect(() => {\n    const api = canvasRef.current;\n    if (!api) return;\n    const detach = attachHud(api, hud, { theme, ...(font !== undefined ? { font } : {}) });\n    api.requestRedraw();\n    return detach;\n    // canvasRef.current changing during component lifetime is unusual for\n    // canvas refs; treat as effectively-stable in v1. The dep on `hud` is\n    // also stable (it comes from useState's initializer, never changes).\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [hud, theme, font]);\n\n  return hud;\n}\n\n/**\n * Memoize the HUD's input contribution — see {@link createHudContribution}\n * for how the routing works.\n *\n * It is stateless (its actions resolve the hit widget from the gesture's\n * affordance payload), so one instance serves any number of HUDs on the page.\n */\nexport function useHudContribution(): Contribution {\n  return useMemo(() => createHudContribution(), []);\n}\n"],"mappings":";;;;;AAuBA,SAAgB,EACd,GACA,IAA0C,EAAE,EACvC;CACL,IAAM,CAAC,KAAO,QAAe,GAAW,CAAC,EAKnC,IAAW,GAAkB,EAC7B,IAAQ,QACN,GAAU,YAAY,EAAa,GAAa,EAAY,YAAY,EAC9E,CAAC,EAAS,CACX,EAEK,IAAO,EAAQ;AAarB,QAZA,QAAgB;EACd,IAAM,IAAM,EAAU;AACtB,MAAI,CAAC,EAAK;EACV,IAAM,IAAS,EAAU,GAAK,GAAK;GAAE;GAAO,GAAI,MAAS,KAAA,IAAuB,EAAE,GAAb,EAAE,SAAM;GAAQ,CAAC;AAEtF,SADA,EAAI,eAAe,EACZ;IAKN;EAAC;EAAK;EAAO;EAAK,CAAC,EAEf;;AAUT,SAAgB,IAAmC;AACjD,QAAO,QAAc,GAAuB,EAAE,EAAE,CAAC"}

package/dist/react/useHud.d.ts

@@ -1,4 +1,5 @@
 import { type Hud } from '../hud';
+import { type AttachHudOptions } from '../attach';
 import type { CanvasExtensionApi, Contribution } from '@weasel-js/core';
 /**
  * Create a HUD and attach it to a Canvas via its imperative ref handle.
@@ -10,10 +11,14 @@ import type { CanvasExtensionApi, Contribution } from '@weasel-js/core';
  *   const hud = useHud(ref);
  *   // ... later
  *   const btn = hud.button({ ... });
+ *
+ * An app that has already registered a bitmap family should say so —
+ * `useHud(ref, { font: 'sans-serif' })` — or the HUD fetches its own copy of
+ * the same atlas.
  */
 export declare function useHud(canvasRef: {
     current: CanvasExtensionApi | null;
-}): Hud;
+}, options?: Pick<AttachHudOptions, 'font'>): Hud;
 /**
  * Memoize the HUD's input contribution — see {@link createHudContribution}
  * for how the routing works.

package/dist/react/useHud.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useHud.d.ts","sourceRoot":"","sources":["../../src/react/useHud.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,KAAK,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAGxE;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE;IAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAA;CAAE,GAAG,GAAG,CAyB7E;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,IAAI,YAAY,CAEjD"}
+{"version":3,"file":"useHud.d.ts","sourceRoot":"","sources":["../../src/react/useHud.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,KAAK,GAAG,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAa,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAGxE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CACpB,SAAS,EAAE;IAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAA;CAAE,EACjD,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAM,GAC3C,GAAG,CA0BL;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,IAAI,YAAY,CAEjD"}