@crowdedkingdoms/crowdyjs 12.0.0 → 12.2.0

package/dist/crowdy-studio/embed/panel.d.ts

@@ -0,0 +1,162 @@
+import { type MountCrowdyStudioOptions } from '../mount.js';
+import type { CrowdyStudioController, CrowdyStudioPlayerCompute, CrowdyStudioPlayerWallet } from '../controller.js';
+import type { CrowdyStudioProjectProvider } from '../models.js';
+import type { CrowdyAgentMode, CrowdyAgentPreemptionReason, CrowdyStudioAgentController, CrowdyStudioAgentTransportV1 } from '../../crowdy-agent/index.js';
+import type { AgentControlLeaseManager, AgentControlLeaseManagerOptionsV1, PlayerHostAdapterV1 } from '../../player-host/index.js';
+import type { PlayerCodeGridBounds, PlayerCodeHostCall, PlayerCodePresentation } from '../../player-runtime/player-code-broker.js';
+import { type CrowdyStudioEmbedDockStorage } from './dock.js';
+import type { CrowdyStudioTextHud } from './hud-layer.js';
+export type CrowdyStudioEmbedDisplayMode = 'docked' | 'fullscreen';
+/**
+ * The studio-facing domain services the embed needs. `CrowdyClient`
+ * satisfies this structurally, so most games pass their client directly.
+ */
+export interface CrowdyStudioEmbedServices {
+    crowdyStudio: CrowdyStudioProjectProvider;
+    playerCompute: CrowdyStudioPlayerCompute;
+    playerWallet?: CrowdyStudioPlayerWallet;
+    /** Production agent transport; omission keeps the agent fail-closed/hidden. */
+    crowdyStudioAgent?: CrowdyStudioAgentTransportV1;
+}
+export interface CrowdyStudioEmbedTargetPermission {
+    canWrite: boolean;
+    canRun: boolean;
+}
+export interface CrowdyStudioEmbedTargetPermissions {
+    SERVER: CrowdyStudioEmbedTargetPermission;
+    CLIENT: CrowdyStudioEmbedTargetPermission;
+}
+export interface CrowdyStudioEmbedHandle {
+    readonly api: 'crowdy-studio';
+    readonly controller: CrowdyStudioController;
+    readonly agent: CrowdyStudioAgentController | null;
+    readonly controlLeaseManager: AgentControlLeaseManager | null;
+    destroy(): void;
+}
+export interface CrowdyStudioEmbedAgentSessionOptions {
+    mode?: CrowdyAgentMode;
+    providerDataConsent?: boolean;
+    /** Prefixes the generated per-session idempotency key. */
+    idempotencyKeyPrefix?: string;
+}
+/** Static, game-lifetime configuration for the embed shell. */
+export interface CrowdyStudioEmbedOptions {
+    client: CrowdyStudioEmbedServices;
+    appId: string | (() => string);
+    /** Header title. Defaults to "Crowdy Studio". */
+    title?: string;
+    /** Game name used in the screen-reader description of the panel. */
+    gameName?: string;
+    /**
+     * Keyboard code that closes the studio from chrome (not from text entry).
+     * Defaults to `KeyM` to match the common open keybind; `null` disables the
+     * key entirely. Escape always closes.
+     */
+    closeKeyCode?: string | null;
+    agentSession?: CrowdyStudioEmbedAgentSessionOptions;
+    controlGate?: AgentControlLeaseManagerOptionsV1;
+    onLocalPreempt?(reason: CrowdyAgentPreemptionReason): void;
+    /**
+     * Suppress gameplay input and return a restoration callback. Used only by
+     * the narrow-screen modal; the desktop dock remains non-modal.
+     */
+    suppressGameplayInput?(): () => void;
+    /** Re-measure the game canvas and HUD after dock geometry changes. */
+    onLayoutChange?(): void;
+    onAgentMounted?(handle: CrowdyStudioEmbedHandle): void;
+    onAgentUnavailable?(message: string): void;
+    onAgentUnmounted?(): void;
+    /** Called after the panel closes for any reason (Escape, key, close()). */
+    onClosed?(): void;
+    dockStorage?: CrowdyStudioEmbedDockStorage | null;
+    /** Browser-regression-only fault/config injection; never set by a game. */
+    runtimeOverrides?: Partial<MountCrowdyStudioOptions>;
+}
+/** Per-open context: the grid the player is editing and its capabilities. */
+export interface CrowdyStudioEmbedContext {
+    gridId: string;
+    /** Chunk AABB; required to run CLIENT projects. */
+    grid?: PlayerCodeGridBounds;
+    targetPermissions: CrowdyStudioEmbedTargetPermissions;
+    /** Optional provenance note rendered under the permission cards. */
+    permissionsNote?: string;
+    /** Same-origin glue worker URL; required to run CLIENT projects. */
+    workerUrl?: string;
+    /** Allow-listed world reads/writes for CLIENT projects. */
+    onHostCall?(call: PlayerCodeHostCall): Promise<unknown>;
+    /** Text-only HUD sink; enables the drawer HUD preview when provided. */
+    hud?: CrowdyStudioTextHud;
+    /** Custom presentation routing; defaults to `hud` when omitted. */
+    onPresentation?(presentation: PlayerCodePresentation): void;
+    /** Game Play adapter; with `client.crowdyStudioAgent` enables the agent. */
+    playerHost?: PlayerHostAdapterV1;
+}
+/**
+ * Responsive game shell around CrowdyJS's project-first Crowdy Studio.
+ * Desktop uses a resizable right dock; narrow screens use a focus-trapped
+ * modal. Construct once per game and `toggle(context)` per open.
+ */
+export declare class CrowdyStudioEmbed {
+    private readonly options;
+    private root;
+    private mountElement;
+    private statusElement;
+    private drawerElement;
+    private drawerButton;
+    private handle;
+    private context;
+    private previousFocus;
+    private restoreGameplayInput;
+    private unmountHudPreview;
+    private mountGeneration;
+    private displayMode;
+    private readonly dock;
+    constructor(options: CrowdyStudioEmbedOptions);
+    get open(): boolean;
+    get modal(): boolean;
+    get mode(): CrowdyStudioEmbedDisplayMode | null;
+    toggle(context: CrowdyStudioEmbedContext): void;
+    destroy(): void;
+    close(): void;
+    private show;
+    /**
+     * Single compact header row: title, context pill, on-demand Context drawer
+     * toggle, Close. Project context and permission details live in the drawer
+     * so every workflow starts with maximum studio space.
+     */
+    private header;
+    /**
+     * On-demand context drawer: grid context, effective permissions, and (when
+     * a HUD sink is supplied) a lazily mounted HUD preview. Hidden by default;
+     * toggled from the header.
+     */
+    private drawer;
+    private toggleDrawer;
+    private mountStudio;
+    /** Assemble mount options from the game client + per-open context. */
+    private mountSdkStudio;
+    private currentAppId;
+    private agentIdempotencyKey;
+    private presentationSource;
+    private accessibleDescription;
+    private shortcutHint;
+    private closeKeyLabel;
+    private closeKeyCode;
+    private readonly viewportResize;
+    private updateDisplayMode;
+    private enterModalMode;
+    private leaveModalMode;
+    private applyDockWidth;
+    private clearDockWidth;
+    private readonly keyDown;
+    private readonly documentKeyDown;
+    private readonly captureEscape;
+    private handleDialogKey;
+    private trapTab;
+    private readonly stopKeyboardEvent;
+    private readonly documentKeyUp;
+    private readonly keepFocusInside;
+}
+/** Convenience factory mirroring the class constructor. */
+export declare function createCrowdyStudioEmbed(options: CrowdyStudioEmbedOptions): CrowdyStudioEmbed;
+//# sourceMappingURL=panel.d.ts.map

package/dist/crowdy-studio/embed/panel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"panel.d.ts","sourceRoot":"","sources":["../../../src/crowdy-studio/embed/panel.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,wBAAwB,EAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EACV,sBAAsB,EACtB,yBAAyB,EACzB,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,KAAK,EACV,eAAe,EACf,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,EAC7B,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,wBAAwB,EACxB,iCAAiC,EACjC,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EACV,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAKL,KAAK,4BAA4B,EAClC,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAO1D,MAAM,MAAM,4BAA4B,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,2BAA2B,CAAC;IAC1C,aAAa,EAAE,yBAAyB,CAAC;IACzC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,4BAA4B,CAAC;CAClD;AAED,MAAM,WAAW,iCAAiC;IAChD,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IACjD,MAAM,EAAE,iCAAiC,CAAC;IAC1C,MAAM,EAAE,iCAAiC,CAAC;CAC3C;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,sBAAsB,CAAC;IAC5C,QAAQ,CAAC,KAAK,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACnD,QAAQ,CAAC,mBAAmB,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC9D,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,oCAAoC;IACnD,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,+DAA+D;AAC/D,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,yBAAyB,CAAC;IAClC,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAC/B,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,oCAAoC,CAAC;IACpD,WAAW,CAAC,EAAE,iCAAiC,CAAC;IAChD,cAAc,CAAC,CAAC,MAAM,EAAE,2BAA2B,GAAG,IAAI,CAAC;IAC3D;;;OAGG;IACH,qBAAqB,CAAC,IAAI,MAAM,IAAI,CAAC;IACrC,sEAAsE;IACtE,cAAc,CAAC,IAAI,IAAI,CAAC;IACxB,cAAc,CAAC,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACvD,kBAAkB,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,gBAAgB,CAAC,IAAI,IAAI,CAAC;IAC1B,2EAA2E;IAC3E,QAAQ,CAAC,IAAI,IAAI,CAAC;IAClB,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAClD,2EAA2E;IAC3E,gBAAgB,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACtD;AAED,6EAA6E;AAC7E,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,iBAAiB,EAAE,kCAAkC,CAAC;IACtD,oEAAoE;IACpE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,UAAU,CAAC,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,wEAAwE;IACxE,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,mEAAmE;IACnE,cAAc,CAAC,CAAC,YAAY,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC5D,4EAA4E;IAC5E,UAAU,CAAC,EAAE,mBAAmB,CAAC;CAClC;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAehB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAdpC,OAAO,CAAC,IAAI,CAA+B;IAC3C,OAAO,CAAC,YAAY,CAA+B;IACnD,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,MAAM,CAAwC;IACtD,OAAO,CAAC,OAAO,CAAyC;IACxD,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,oBAAoB,CAA6B;IACzD,OAAO,CAAC,iBAAiB,CAA6B;IACtD,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,WAAW,CAA6C;IAChE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAwB;gBAEhB,OAAO,EAAE,wBAAwB;IAS9D,IAAI,IAAI,IAAI,OAAO,CAElB;IAED,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,IAAI,IAAI,IAAI,4BAA4B,GAAG,IAAI,CAE9C;IAED,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;IAK/C,OAAO,IAAI,IAAI;IAKf,KAAK,IAAI,IAAI;IAqCb,OAAO,CAAC,IAAI;IA6DZ;;;;OAIG;IACH,OAAO,CAAC,MAAM;IAqCd;;;;OAIG;IACH,OAAO,CAAC,MAAM;IAmEd,OAAO,CAAC,YAAY;YAgBN,WAAW;IAkDzB,sEAAsE;YACxD,cAAc;IAkE5B,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,mBAAmB;IAU3B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAE7B;IAEF,OAAO,CAAC,iBAAiB;IAyCzB,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAEtB;IAEF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAG9B;IAEF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAO5B;IAEF,OAAO,CAAC,eAAe;IA2BvB,OAAO,CAAC,OAAO;IAsBf,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAEhC;IAEF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAI5B;IAEF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAK9B;CACH;AAED,2DAA2D;AAC3D,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,wBAAwB,GAChC,iBAAiB,CAEnB"}