@anweather/plugin-board-kit 1.20.0 → 1.22.0

package/README.md

@@ -45,6 +45,10 @@ cross-directory import produced ("Cannot read properties of null (reading
 - `useCanvasCamera`: pinch/wheel zoom and two-finger pan for a
   canvas-rendered board, renderer-agnostic (Canvas2D via `applyTransform`,
   or drive a Pixi container from `.zoom`/`.offsetX`/`.offsetY`).
+- `boardTelemetry(props)`: the host's `BoardProps.telemetry` reporter
+  (`event(name, attrs)`, `error(err, context)`, into the platform's Faro,
+  rate-limited and stamped with game type/id/participant by the platform),
+  or `NOOP_BOARD_TELEMETRY` on a host without one. Never throws.
 
 Not here on purpose: `nameplateAccent.ts` (this repo's
 `frontend/src/plugins/`) hardcodes per-`gameType` colours across the native

package/dist/index.d.ts

@@ -10,4 +10,6 @@ export type { TurnClockState } from './turnClock';
 export { ClockBadge, StartTurnGate } from './TurnClockViews';
 export { useCanvasCamera } from './useCanvasCamera';
 export type { Vec2, UseCanvasCameraOptions, CanvasCamera } from './useCanvasCamera';
+export { boardTelemetry, NOOP_BOARD_TELEMETRY } from './telemetry';
+export type { BoardTelemetry } from './telemetry';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAClF,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpF,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACjD,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC9G,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAClF,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACpF,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACjD,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC9G,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACnF,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -9,4 +9,5 @@ export { teamOf, teamMembers } from './teamUtils';
 export { useClockNow, useClockTimeout, formatClock, liveUsedMs, remainingMs, clockReading } from './turnClock';
 export { ClockBadge, StartTurnGate } from './TurnClockViews';
 export { useCanvasCamera } from './useCanvasCamera';
+export { boardTelemetry, NOOP_BOARD_TELEMETRY } from './telemetry';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,0EAA0E;AAC1E,0EAA0E;AAC1E,4CAA4C;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAEpF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE9G,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,0EAA0E;AAC1E,0EAA0E;AAC1E,4CAA4C;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAEpF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE9G,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA"}

package/dist/telemetry.d.ts

@@ -0,0 +1,17 @@
+/** `BoardProps.telemetry`, as a board sees it. Both calls never throw. */
+export interface BoardTelemetry {
+    /** A named event, e.g. `event('resync', { reason: 'gap' })`. */
+    event(name: string, attrs?: Record<string, unknown>): void;
+    /** A caught error, with where it happened (`{ where: 'mount' }`). */
+    error(error: unknown, context?: Record<string, unknown>): void;
+}
+/** Accepts every call and does nothing: what a board gets from a host without the hook. */
+export declare const NOOP_BOARD_TELEMETRY: BoardTelemetry;
+/**
+ * The host's reporter if it passed one, else the no-op -- so a board can
+ * call `boardTelemetry(props).event(...)` unconditionally on any host,
+ * including a platform deploy older than the hook. Read structurally: props
+ * cross the ShadowMount boundary untyped.
+ */
+export declare function boardTelemetry(props: unknown): BoardTelemetry;
+//# sourceMappingURL=telemetry.d.ts.map

package/dist/telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAMA,0EAA0E;AAC1E,MAAM,WAAW,cAAc;IAC7B,gEAAgE;IAChE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAC1D,qEAAqE;IACrE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC/D;AAED,2FAA2F;AAC3F,eAAO,MAAM,oBAAoB,EAAE,cAGjC,CAAA;AAEF;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAQ7D"}

package/dist/telemetry.js

@@ -0,0 +1,33 @@
+// The board half of BoardProps.telemetry (web-boardgame-platform
+// frontend/src/observability/boardTelemetry.ts): what a board may report
+// into the platform's Faro. The platform rate-limits, size-caps and stamps
+// every report with the game type, game id and participant; a board only
+// names what happened.
+/** Accepts every call and does nothing: what a board gets from a host without the hook. */
+export const NOOP_BOARD_TELEMETRY = Object.freeze({
+    event() { },
+    error() { },
+});
+/**
+ * The host's reporter if it passed one, else the no-op -- so a board can
+ * call `boardTelemetry(props).event(...)` unconditionally on any host,
+ * including a platform deploy older than the hook. Read structurally: props
+ * cross the ShadowMount boundary untyped.
+ */
+export function boardTelemetry(props) {
+    const t = props?.telemetry;
+    if (!t || typeof t.event !== 'function' || typeof t.error !== 'function')
+        return NOOP_BOARD_TELEMETRY;
+    // A misbehaving host must not break the board either.
+    return {
+        event(name, attrs) { try {
+            t.event(name, attrs);
+        }
+        catch { /* telemetry never throws */ } },
+        error(error, context) { try {
+            t.error(error, context);
+        }
+        catch { /* as above */ } },
+    };
+}
+//# sourceMappingURL=telemetry.js.map

package/dist/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,yEAAyE;AACzE,2EAA2E;AAC3E,yEAAyE;AACzE,uBAAuB;AAUvB,2FAA2F;AAC3F,MAAM,CAAC,MAAM,oBAAoB,GAAmB,MAAM,CAAC,MAAM,CAAC;IAChE,KAAK,KAAI,CAAC;IACV,KAAK,KAAI,CAAC;CACX,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,MAAM,CAAC,GAAI,KAAoD,EAAE,SAAgD,CAAA;IACjH,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,UAAU,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,UAAU;QAAE,OAAO,oBAAoB,CAAA;IACrG,sDAAsD;IACtD,OAAO;QACL,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC;YAAC,CAAC,CAAC,KAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAAC,CAAC;QAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC3F,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC;YAAC,CAAC,CAAC,KAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAAC,CAAC;QAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;KACpF,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anweather/plugin-board-kit",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "Board-UI primitives for a web-boardgame-platform game board: the mount/update/unmount handle a remote plugin's bundle exports, BoardShell/TurnIdentity layout, turn/spectator/team helpers, the TurnClock display half, and the pinch/wheel canvas camera. React is a peer dependency, so a plugin's bundle carries exactly one React.",
   "license": "MIT",
   "type": "module",