@crowdedkingdoms/crowdyjs 17.14.0-dev.1 → 18.0.0-dev.1

package/dist/stores/model.d.ts

@@ -1,81 +0,0 @@
-/**
- * ContainerMirror — the client half of the platform's **notify-to-pull**
- * pattern for game-model state: keep typed snapshots of the containers you
- * care about, re-pull them on demand or whenever a bound channel pings
- * ("state changed"), and render straight from the cache.
- *
- * Model changes are pull-based on this platform (there is no model
- * subscription); functions declare channel/spatial notifications and clients
- * re-read. The Game Kit's match layer pings a per-match channel — bind the
- * mirror to that channel and every watched container refreshes itself.
- */
-import type { WorldSessionContext } from './session.js';
-/** A typed snapshot of one watched container. */
-export interface MirroredContainer<T = Record<string, unknown>> {
-    readonly containerId: string;
-    typeName: string;
-    displayName: string;
-    ownerUserId: string | null;
-    /** The parsed, caller-visible properties. */
-    value: T;
-    /** Bumped on every refresh that changed the snapshot. */
-    revision: number;
-    /** Local time of the last refresh. */
-    refreshedAt: number;
-}
-/** Options for {@link attachContainerMirror}. */
-export interface ContainerMirrorConfig {
-    /** Clock override for tests. Defaults to `Date.now`. */
-    now?: () => number;
-}
-/**
- * The SDK-managed **model mirror**: typed, cached snapshots of watched
- * game-model containers with coalesced refresh and channel-ping binding.
- * Reads are synchronous ({@link get}); {@link onChange} fires only when a
- * refresh actually changed the visible state.
- */
-export declare class ContainerMirror {
-    private readonly ctx;
-    private readonly watches;
-    private readonly listeners;
-    private readonly boundChannels;
-    private readonly now;
-    private refreshing;
-    private refreshQueued;
-    constructor(ctx: WorldSessionContext, config?: ContainerMirrorConfig);
-    /**
-     * Watch a container: fetches the initial snapshot and keeps it refreshable.
-     * `parse` maps the visible properties object to your type (defaults to the
-     * raw object).
-     */
-    watch<T = Record<string, unknown>>(containerId: string, parse?: (properties: Record<string, unknown>) => T): Promise<MirroredContainer<T>>;
-    /** Stop watching a container (its snapshot is dropped). */
-    unwatch(containerId: string): void;
-    /** The current snapshot of a watched container (undefined before watch resolves). */
-    get<T = Record<string, unknown>>(containerId: string): MirroredContainer<T> | undefined;
-    /** Every watched snapshot. */
-    list(): Array<MirroredContainer<unknown>>;
-    /**
-     * Subscribe to snapshot changes — every watched container, or one
-     * `containerId`. Fires only when a refresh changed the visible state.
-     * @returns off.
-     */
-    onChange(handler: (container: MirroredContainer<unknown>) => void, containerId?: string): () => void;
-    /**
-     * Bind a channel: any message on it triggers a coalesced {@link refreshAll}
-     * — pair with model functions that declare channel notifications (e.g. the
-     * Game Kit's `match_changed` pings).
-     */
-    bindToChannel(channelId: string): () => void;
-    /** Re-pull one watched container now. */
-    refresh(containerId: string): Promise<void>;
-    /**
-     * Re-pull every watched container. Concurrent calls coalesce: a refresh
-     * requested while one is running queues exactly one follow-up pass (pings
-     * can burst; state converges without stampeding the API).
-     */
-    refreshAll(): Promise<void>;
-}
-/** Attach a {@link ContainerMirror}. Prefer the `model` config key. */
-export declare function attachContainerMirror(ctx: WorldSessionContext, config?: ContainerMirrorConfig): ContainerMirror;
-//# sourceMappingURL=model.d.ts.map

package/dist/stores/model.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/stores/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAExD,iDAAiD;AACjD,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC5D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6CAA6C;IAC7C,KAAK,EAAE,CAAC,CAAC;IACT,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,iDAAiD;AACjD,MAAM,WAAW,qBAAqB;IACpC,wDAAwD;IACxD,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB;AASD;;;;;GAKG;AACH,qBAAa,eAAe;IAYxB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAXtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiC;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAGrB;IACL,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,aAAa,CAAS;gBAGX,GAAG,EAAE,mBAAmB,EACzC,MAAM,GAAE,qBAA0B;IAcpC;;;;OAIG;IACG,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,WAAW,EAAE,MAAM,EACnB,KAAK,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,GACjD,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAWhC,2DAA2D;IAC3D,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAIlC,qFAAqF;IACrF,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,SAAS;IAMvF,8BAA8B;IAC9B,IAAI,IAAI,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAQzC;;;;OAIG;IACH,QAAQ,CACN,OAAO,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,IAAI,EACxD,WAAW,CAAC,EAAE,MAAM,GACnB,MAAM,IAAI;IAMb;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,IAAI;IAK5C,yCAAyC;IACnC,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDjD;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAqBlC;AAED,uEAAuE;AACvE,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,mBAAmB,EACxB,MAAM,GAAE,qBAA0B,GACjC,eAAe,CAEjB"}

package/dist/stores/model.js

@@ -1,163 +0,0 @@
-/**
- * ContainerMirror — the client half of the platform's **notify-to-pull**
- * pattern for game-model state: keep typed snapshots of the containers you
- * care about, re-pull them on demand or whenever a bound channel pings
- * ("state changed"), and render straight from the cache.
- *
- * Model changes are pull-based on this platform (there is no model
- * subscription); functions declare channel/spatial notifications and clients
- * re-read. The Game Kit's match layer pings a per-match channel — bind the
- * mirror to that channel and every watched container refreshes itself.
- */
-/**
- * The SDK-managed **model mirror**: typed, cached snapshots of watched
- * game-model containers with coalesced refresh and channel-ping binding.
- * Reads are synchronous ({@link get}); {@link onChange} fires only when a
- * refresh actually changed the visible state.
- */
-export class ContainerMirror {
-    constructor(ctx, config = {}) {
-        this.ctx = ctx;
-        this.watches = new Map();
-        this.listeners = new Set();
-        this.boundChannels = new Set();
-        this.refreshing = false;
-        this.refreshQueued = false;
-        this.now = config.now ?? Date.now;
-        // One listener serves every bound channel: a ping means "model state
-        // changed somewhere relevant" → coalesced refresh of all watches.
-        ctx.onDispose(ctx.on('channelMessage', (notification) => {
-            if (!this.boundChannels.has(String(notification.channelId)))
-                return;
-            void this.refreshAll();
-        }));
-    }
-    /**
-     * Watch a container: fetches the initial snapshot and keeps it refreshable.
-     * `parse` maps the visible properties object to your type (defaults to the
-     * raw object).
-     */
-    async watch(containerId, parse) {
-        const entry = {
-            parse: parse ?? ((props) => props),
-            snapshot: null,
-            lastSerialized: null,
-        };
-        this.watches.set(containerId, entry);
-        await this.refresh(containerId);
-        return entry.snapshot;
-    }
-    /** Stop watching a container (its snapshot is dropped). */
-    unwatch(containerId) {
-        this.watches.delete(containerId);
-    }
-    /** The current snapshot of a watched container (undefined before watch resolves). */
-    get(containerId) {
-        return (this.watches.get(containerId)?.snapshot ?? undefined);
-    }
-    /** Every watched snapshot. */
-    list() {
-        const out = [];
-        for (const entry of this.watches.values()) {
-            if (entry.snapshot)
-                out.push(entry.snapshot);
-        }
-        return out;
-    }
-    /**
-     * Subscribe to snapshot changes — every watched container, or one
-     * `containerId`. Fires only when a refresh changed the visible state.
-     * @returns off.
-     */
-    onChange(handler, containerId) {
-        const entry = { containerId, handler };
-        this.listeners.add(entry);
-        return () => this.listeners.delete(entry);
-    }
-    /**
-     * Bind a channel: any message on it triggers a coalesced {@link refreshAll}
-     * — pair with model functions that declare channel notifications (e.g. the
-     * Game Kit's `match_changed` pings).
-     */
-    bindToChannel(channelId) {
-        this.boundChannels.add(String(channelId));
-        return () => this.boundChannels.delete(String(channelId));
-    }
-    /** Re-pull one watched container now. */
-    async refresh(containerId) {
-        const entry = this.watches.get(containerId);
-        if (!entry)
-            return;
-        const state = await this.ctx.client.gameModel.containerState({
-            appId: this.ctx.appId,
-            containerId,
-        });
-        let properties;
-        try {
-            properties = JSON.parse(state.propertiesJson);
-        }
-        catch {
-            properties = {};
-        }
-        const serialized = `${state.displayName}|${state.propertiesJson}`;
-        const changed = serialized !== entry.lastSerialized;
-        entry.lastSerialized = serialized;
-        if (!entry.snapshot) {
-            entry.snapshot = {
-                containerId,
-                typeName: state.typeName,
-                displayName: state.displayName,
-                ownerUserId: state.ownerUserId != null ? String(state.ownerUserId) : null,
-                value: entry.parse(properties),
-                revision: 1,
-                refreshedAt: this.now(),
-            };
-        }
-        else {
-            entry.snapshot.refreshedAt = this.now();
-            if (changed) {
-                entry.snapshot.typeName = state.typeName;
-                entry.snapshot.displayName = state.displayName;
-                entry.snapshot.ownerUserId =
-                    state.ownerUserId != null ? String(state.ownerUserId) : null;
-                entry.snapshot.value = entry.parse(properties);
-                entry.snapshot.revision += 1;
-            }
-        }
-        if (changed) {
-            for (const listener of [...this.listeners]) {
-                if (listener.containerId === undefined ||
-                    listener.containerId === containerId) {
-                    listener.handler(entry.snapshot);
-                }
-            }
-        }
-    }
-    /**
-     * Re-pull every watched container. Concurrent calls coalesce: a refresh
-     * requested while one is running queues exactly one follow-up pass (pings
-     * can burst; state converges without stampeding the API).
-     */
-    async refreshAll() {
-        if (this.refreshing) {
-            this.refreshQueued = true;
-            return;
-        }
-        this.refreshing = true;
-        try {
-            do {
-                this.refreshQueued = false;
-                await Promise.all([...this.watches.keys()].map((id) => this.refresh(id).catch(() => {
-                    // A failed pull keeps the previous snapshot; the next ping retries.
-                })));
-            } while (this.refreshQueued);
-        }
-        finally {
-            this.refreshing = false;
-        }
-    }
-}
-/** Attach a {@link ContainerMirror}. Prefer the `model` config key. */
-export function attachContainerMirror(ctx, config = {}) {
-    return new ContainerMirror(ctx, config);
-}