@puzzmo/sdk 1.0.30 → 1.0.32

package/dist/contracts.d.ts

@@ -0,0 +1,95 @@
+/** The SDK-owned timer methods exposed to plugins. */
+export interface SDKTimer {
+    /** Get elapsed time in milliseconds */
+    timeMs: () => number;
+    /** Get elapsed time in seconds */
+    timeSecs: () => number;
+    /** Get added/penalty time in milliseconds */
+    addedTimeMs: () => number;
+    /** Get added/penalty time in seconds */
+    addedTimeSecs: () => number;
+    /** Get elapsed time without penalties in seconds */
+    timeWithoutPenaltySecs: () => number;
+    /** Get formatted display strings [elapsed, added] */
+    display: () => [string, string];
+    /** Add penalty time in milliseconds */
+    addPenalty: (ms: number) => void;
+    /** Check if timer is paused */
+    isPaused: () => boolean;
+    /** Check if timer has been started */
+    isRunning: () => boolean;
+}
+/**
+ * The bootstrap payload exposed to plugins. `currentUser` is typed for convenience; the rest of the
+ * host payload (`startOrFindGameplay`, `theme`, `hostContext`, …) is reachable via the index
+ * signature so this stays self-contained and doesn't have to restate the full `BootstrapGameData`.
+ */
+export interface SDKPluginBootstrap {
+    /** The signed-in Puzzmo user, or null when the viewer is anonymous. */
+    currentUser?: {
+        id?: string;
+        name?: string | null;
+        username?: string;
+        usernameID?: string;
+        type?: string;
+        roles?: string;
+        /** Nakama account id for multiplayer; null when not logged into Nakama. */
+        nakamaID?: string | null;
+    } | null;
+    [key: string]: any;
+}
+/**
+ * The low-level seam a plugin is handed in `setup`. It exposes the same host transport the core SDK
+ * uses, so a plugin can send/receive message types the slim core does not surface itself (e.g.
+ * `SENSORY_EVENT`, `SIDEBAR_UPDATE`, the `COLLAB_*` family). The host already understands the full
+ * protocol; plugins just opt extra channels back in.
+ */
+export interface SDKPluginContext {
+    /** Send a host message. The type is intentionally open so plugins can use the full protocol. */
+    send: (type: string, json: unknown) => void;
+    /** Subscribe to a host message by type. Returns an unsubscribe function. */
+    on: (type: string, handler: (data: any) => void) => () => void;
+    /** The SDK-owned timer (read-only for plugins; the SDK still drives it). */
+    timer: SDKTimer;
+    /** The resolved bootstrap payload, or null until `gameReady()` has resolved. */
+    bootstrap: () => SDKPluginBootstrap | null;
+}
+/**
+ * A Puzzmo SDK plugin. `setup` wires up host messaging and returns the plugin's public API, which is
+ * hung off `sdk.plugins[name]`. Keep `name` a string literal so the `sdk.plugins` map stays typed.
+ */
+export interface SDKPlugin<Name extends string = string, API = unknown> {
+    /** Unique key the returned API is exposed under (`sdk.plugins[name]`). */
+    name: Name;
+    /** Wire up host messaging and return the plugin's public API. */
+    setup: (ctx: SDKPluginContext) => API;
+}
+/** Maps a tuple of plugins to the `{ [name]: API }` shape exposed at `sdk.plugins`. */
+export type PluginAPIs<Plugins extends readonly SDKPlugin[]> = {
+    [Plugin in Plugins[number] as Plugin["name"]]: Plugin extends SDKPlugin<string, infer API> ? API : never;
+};
+/** The simulator context a plugin-provided view renders into (the subset views use). */
+export interface SimulatorContext {
+    /** Find an element inside the simulator panel by selector. */
+    getElement: <T extends HTMLElement>(selector: string) => T | null;
+    /** Update the badge count on this view's tab. Pass 0/undefined to hide it. */
+    updateBadge: (tabId: string, count: number | undefined) => void;
+    /** Send a host→game message down to the game (the simulator acts as the host). */
+    sendToGame: (type: string, data: any) => void;
+}
+/** A simulator tab/view a plugin contributes via `createSimulator({ views })`. */
+export interface SimulatorView {
+    /** Tab id (also the message-badge key). */
+    id: string;
+    /** Tab label. */
+    label: string;
+    /** Returns the tab's HTML. */
+    render(): string;
+    /** Wire up event listeners after render. */
+    bind(context: SimulatorContext): void;
+    /** Called when the tab becomes active. */
+    onActivate?(context: SimulatorContext): void;
+    /** Handle a message coming from the game. */
+    onMessage?(type: string, data: any, context: SimulatorContext): void;
+}
+//# sourceMappingURL=contracts.d.ts.map

package/dist/contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":"AAQA,sDAAsD;AACtD,MAAM,WAAW,QAAQ;IACvB,uCAAuC;IACvC,MAAM,EAAE,MAAM,MAAM,CAAA;IACpB,kCAAkC;IAClC,QAAQ,EAAE,MAAM,MAAM,CAAA;IACtB,6CAA6C;IAC7C,WAAW,EAAE,MAAM,MAAM,CAAA;IACzB,wCAAwC;IACxC,aAAa,EAAE,MAAM,MAAM,CAAA;IAC3B,oDAAoD;IACpD,sBAAsB,EAAE,MAAM,MAAM,CAAA;IACpC,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,uCAAuC;IACvC,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,OAAO,CAAA;IACvB,sCAAsC;IACtC,SAAS,EAAE,MAAM,OAAO,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,uEAAuE;IACvE,WAAW,CAAC,EAAE;QACZ,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,2EAA2E;QAC3E,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACzB,GAAG,IAAI,CAAA;IACR,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gGAAgG;IAChG,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;IAC3C,4EAA4E;IAC5E,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;IAC9D,4EAA4E;IAC5E,KAAK,EAAE,QAAQ,CAAA;IACf,gFAAgF;IAChF,SAAS,EAAE,MAAM,kBAAkB,GAAG,IAAI,CAAA;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,GAAG,OAAO;IACpE,0EAA0E;IAC1E,IAAI,EAAE,IAAI,CAAA;IACV,iEAAiE;IACjE,KAAK,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,GAAG,CAAA;CACtC;AAED,uFAAuF;AACvF,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,SAAS,SAAS,EAAE,IAAI;KAC5D,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,SAAS,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK;CACzG,CAAA;AAED,wFAAwF;AACxF,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,UAAU,EAAE,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC,GAAG,IAAI,CAAA;IACjE,8EAA8E;IAC9E,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAA;IAC/D,oFAAkF;IAClF,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAA;CAC9C;AAED,kFAAkF;AAClF,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,MAAM,IAAI,MAAM,CAAA;IAChB,4CAA4C;IAC5C,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;IACrC,0CAA0C;IAC1C,UAAU,CAAC,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC5C,6CAA6C;IAC7C,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;CACrE"}