@zylem/editor 0.6.8 → 0.7.0

package/dist/zylem-editor.d.ts

@@ -1,116 +1,7 @@
 import { Component } from 'solid-js';
 import { LucideProps } from 'lucide-solid';
-
-type EditorLauncherMode = 'floating' | 'hidden';
-
-/**
- * Configuration options for the ZylemEditorElement
- */
-interface ZylemEditorConfig {
-    /**
-     * External debug state to sync with.
-     * If provided, the editor will use this state instead of its internal state.
-     */
-    debugState?: any;
-    /**
-     * External game state to sync with.
-     */
-    gameState?: any;
-    /**
-     * External stage state to sync with.
-     */
-    stageState?: any;
-    /**
-     * Whether to include default styles.
-     * @default true
-     */
-    includeStyles?: boolean;
-    /**
-     * Controls whether the internal floating launcher is rendered.
-     * @default 'floating'
-     */
-    launcherMode?: EditorLauncherMode;
-}
-/**
- * ZylemEditorElement - A web component that wraps the Zylem Editor.
- *
- * This component is fully self-contained with bundled styles.
- * It can be imported and used in any project without additional CSS configuration.
- *
- * @example
- * ```html
- * <!-- Standalone usage -->
- * <zylem-editor></zylem-editor>
- * ```
- *
- * @example
- * ```js
- * // Configured usage
- * const editor = document.querySelector('zylem-editor');
- * editor.config = {
- *   debugState: myGame.debugState,
- *   gameState: myGame.gameState,
- *   stageState: myGame.stageState,
- * };
- * ```
- *
- * @example
- * ```js
- * // Manual registration in another project
- * import { ZylemEditorElement } from '@zylem/editor';
- *
- * // Optionally customize before registering
- * customElements.define('my-editor', ZylemEditorElement);
- * ```
- */
-declare class ZylemEditorElement extends HTMLElement {
-    private dispose;
-    private _config;
-    private _initialized;
-    private controller;
-    constructor();
-    /**
-     * Set configuration for the editor.
-     * Must be set before the element is connected to the DOM, or call `reinitialize()` after.
-     */
-    set config(value: ZylemEditorConfig);
-    get config(): ZylemEditorConfig;
-    set launcherMode(value: EditorLauncherMode);
-    get launcherMode(): EditorLauncherMode;
-    /**
-     * Observed attributes for the web component
-     */
-    static get observedAttributes(): string[];
-    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
-    connectedCallback(): void;
-    private initialize;
-    openPanel(): void;
-    closePanel(): void;
-    togglePanel(): void;
-    /**
-     * Reinitialize the editor with new configuration.
-     * Call this after changing the `config` property if the element is already connected.
-     */
-    reinitialize(): void;
-    disconnectedCallback(): void;
-}
-/**
- * Register the ZylemEditorElement as a custom element.
- * Call this function to use the default 'zylem-editor' tag name.
- *
- * @example
- * ```js
- * import { registerZylemEditor } from '@zylem/editor';
- * registerZylemEditor();
- * // Now you can use <zylem-editor> in your HTML
- * ```
- */
-declare function registerZylemEditor(tagName?: string): void;
-
-interface IconProps extends LucideProps {
-    icon: Component<LucideProps>;
-}
-declare const Icon: Component<IconProps>;
+import * as _zylem_bridge from '@zylem/bridge';
+import { BridgeDebugTool } from '@zylem/bridge';
 
 /**
  * Editor Event Bus
@@ -164,53 +55,11 @@ declare class EditorEventBusWrapper {
  */
 declare const editorEvents: EditorEventBusWrapper;
 
-/**
- * Editor Events Module
- *
- * Bidirectional window CustomEvents for communication between @zylem/editor and consuming apps.
- *
- * EDITOR_STATE_DISPATCH: Editor sends state changes → external apps listen
- * EDITOR_STATE_RECEIVE: External apps send updates → editor listens
- */
-/**
- * Payload structure for editor state events.
- * Matches the nested state structure for both directions.
- */
-interface EditorUpdatePayload {
-    gameState?: {
-        debugFlag?: boolean;
-        [key: string]: unknown;
-    };
-    toolbarState?: {
-        tool?: 'select' | 'translate' | 'rotate' | 'scale' | 'delete' | 'none';
-        paused?: boolean;
-    };
-    [key: string]: unknown;
-}
-/**
- * Event name constants
- */
-declare const EDITOR_STATE_DISPATCH = "editor-state-dispatch";
-declare const EDITOR_STATE_RECEIVE = "editor-state-receive";
-declare const EDITOR_UPDATE_EVENT = "editor-state-dispatch";
-/**
- * Dispatch state changes from the editor to external consumers.
- *
- * @param payload - The state update payload
- *
- * @example
- * ```ts
- * // From GameSection when debug checkbox changes
- * dispatchEditorUpdate({ gameState: { debugFlag: true } });
- * ```
- */
-declare function dispatchEditorUpdate(payload: EditorUpdatePayload): void;
-
 /**
  * Entities state for the entities section.
  * Manages debug state and entity selection/hover.
  */
-type DebugTools = 'select' | 'translate' | 'rotate' | 'scale' | 'delete' | 'none';
+type DebugTools = 'select' | 'translate' | 'rotate' | 'scale' | 'delete' | 'add' | 'none';
 interface DebugState {
     paused: boolean;
     tool: DebugTools;
@@ -260,9 +109,11 @@ interface BaseEntityInterface {
     position?: Vector3Like | undefined;
     rotation?: Vector3Like | undefined;
     scale?: Vector3Like | undefined;
-    /** PNG data URL of a framed entity preview. */
-    thumbnail?: string | null | undefined;
-    /** World-space AABB size for thumbnail rulers. */
+    /**
+     * World-space AABB size for thumbnail rulers. Preview images themselves
+     * live in the thumbnail side-channel store, keyed by uuid, so entity state
+     * stays small enough to diff cheaply.
+     */
     bounds?: {
         width: number;
         height: number;
@@ -294,6 +145,58 @@ interface StageStateInterface {
 
 declare const stageState: StageStateInterface;
 
+/**
+ * Dock layout geometry.
+ *
+ * Docking used to be per-panel: each panel snapped itself to a viewport edge
+ * and sized itself from `window.innerWidth`. That cannot express two panels
+ * sharing a side, or a bottom strip that stops at a left-docked panel, so the
+ * dock state lives in one registry (persisted in the editor store) and every
+ * panel's rect comes from `computeDockLayout`.
+ *
+ * This module is deliberately free of Solid and `window` so the geometry can
+ * be unit tested directly.
+ */
+type DockSide = 'left' | 'right' | 'top' | 'bottom';
+/** `'main'` is the editor panel; any other id is a detached section id. */
+type DockPanelId = string;
+interface DockZoneState {
+    /** Occupants in slot order along the zone's long axis. */
+    panels: DockPanelId[];
+    /**
+     * Width for left/right, height for top/bottom.
+     * `0` means "not chosen yet"; the layout falls back to a viewport quarter.
+     */
+    thickness: number;
+}
+type DockRegistry = Record<DockSide, DockZoneState>;
+interface Viewport {
+    width: number;
+    height: number;
+}
+interface DockRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+declare const DOCK_SIDES: readonly DockSide[];
+declare const findDockedSide: (registry: DockRegistry, panelId: DockPanelId) => DockSide | null;
+interface DockLayoutOptions {
+    /** Smallest slot extent along a zone's long axis. */
+    minSlotExtent?: number;
+}
+/**
+ * Rect for every docked panel.
+ *
+ * Left and right zones take the full viewport height and win over top and
+ * bottom, which inset horizontally to the space between them. Panels sharing a
+ * zone split its long axis evenly.
+ */
+declare const computeDockLayout: (registry: DockRegistry, viewport: Viewport, options?: DockLayoutOptions) => Record<DockPanelId, DockRect>;
+
+/** Registry id of the main editor panel; detached sections use their panel id. */
+declare const MAIN_PANEL_ID = "main";
 interface DetachedPanelState {
     position: {
         x: number;
@@ -304,6 +207,8 @@ interface DetachedPanelState {
         height: number;
     };
 }
+/** First-run dock assignments a host can request; see `applyDefaultDocks`. */
+type EditorDockDefaults = Partial<Record<DockSide, DockPanelId[]>>;
 declare const debugStore: {
     debug: boolean;
     tool: DebugTools;
@@ -314,6 +219,11 @@ declare const debugStore: {
         x: number;
         y: number;
     } | null;
+    /** Main panel's floating size; its docked size comes from the registry. */
+    panelSize: {
+        width: number;
+        height: number;
+    } | null;
     toggleButtonPosition: {
         x: number;
         y: number;
@@ -322,40 +232,231 @@ declare const debugStore: {
     detachedPanels: Record<string, DetachedPanelState>;
     openSections: string[];
     panelZOrder: string[];
+    docks: DockRegistry;
+    dockDefaultsApplied: boolean;
     draggingPanelId: string | null;
     dropTargetIndex: number | null;
 };
+declare const dockPanelToSide: (panelId: DockPanelId, side: DockSide, index?: number) => void;
+declare const undockPanelFromSides: (panelId: DockPanelId) => void;
+declare const getDockedSide: (panelId: DockPanelId) => DockSide | null;
+
+type EditorLauncherMode = 'floating' | 'hidden';
+
+/**
+ * Configuration options for the ZylemEditorElement
+ */
+interface ZylemEditorConfig {
+    /**
+     * External debug state to sync with.
+     * If provided, the editor will use this state instead of its internal state.
+     */
+    debugState?: any;
+    /**
+     * External game state to sync with.
+     */
+    gameState?: any;
+    /**
+     * External stage state to sync with.
+     */
+    stageState?: any;
+    /**
+     * Whether to include default styles.
+     * @default true
+     */
+    includeStyles?: boolean;
+    /**
+     * Controls whether the internal floating launcher is rendered.
+     * @default 'floating'
+     */
+    launcherMode?: EditorLauncherMode;
+    /**
+     * Dock layout to seed the first time the editor runs in this browser, keyed
+     * by viewport edge. Use `'main'` for the editor panel itself; any other id is
+     * a section (for example `'console'`), which gets detached from the accordion
+     * so it can hold a dock slot.
+     *
+     * Ignored once the user has a saved layout, so it sets a starting point
+     * rather than forcing one.
+     */
+    defaultDocks?: EditorDockDefaults;
+}
+/**
+ * ZylemEditorElement - A web component that wraps the Zylem Editor.
+ *
+ * This component is fully self-contained with bundled styles.
+ * It can be imported and used in any project without additional CSS configuration.
+ *
+ * @example
+ * ```html
+ * <!-- Standalone usage -->
+ * <zylem-editor></zylem-editor>
+ * ```
+ *
+ * @example
+ * ```js
+ * // Configured usage
+ * const editor = document.querySelector('zylem-editor');
+ * editor.config = {
+ *   debugState: myGame.debugState,
+ *   gameState: myGame.gameState,
+ *   stageState: myGame.stageState,
+ * };
+ * ```
+ *
+ * @example
+ * ```js
+ * // Manual registration in another project
+ * import { ZylemEditorElement } from '@zylem/editor';
+ *
+ * // Optionally customize before registering
+ * customElements.define('my-editor', ZylemEditorElement);
+ * ```
+ */
+declare class ZylemEditorElement extends HTMLElement {
+    private dispose;
+    private _config;
+    private _initialized;
+    private controller;
+    /** Releases this element's bridge subscription (reference-counted). */
+    private releaseBridge;
+    constructor();
+    /**
+     * Set configuration for the editor.
+     * Must be set before the element is connected to the DOM, or call `reinitialize()` after.
+     */
+    set config(value: ZylemEditorConfig);
+    get config(): ZylemEditorConfig;
+    set launcherMode(value: EditorLauncherMode);
+    get launcherMode(): EditorLauncherMode;
+    /**
+     * Observed attributes for the web component
+     */
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
+    connectedCallback(): void;
+    private initialize;
+    openPanel(): void;
+    closePanel(): void;
+    togglePanel(): void;
+    /**
+     * Dock a panel to a viewport edge, or pass `null` to float it again.
+     * Defaults to the main editor panel.
+     */
+    dockPanel(side: DockSide | null, panelId?: DockPanelId): void;
+    /**
+     * Reinitialize the editor with new configuration.
+     * Call this after changing the `config` property if the element is already connected.
+     */
+    reinitialize(): void;
+    disconnectedCallback(): void;
+    private teardown;
+}
+/**
+ * Register the ZylemEditorElement as a custom element.
+ * Call this function to use the default 'zylem-editor' tag name.
+ *
+ * @example
+ * ```js
+ * import { registerZylemEditor } from '@zylem/editor';
+ * registerZylemEditor();
+ * // Now you can use <zylem-editor> in your HTML
+ * ```
+ */
+declare function registerZylemEditor(tagName?: string): void;
+
+interface IconProps extends LucideProps {
+    icon: Component<LucideProps>;
+}
+declare const Icon: Component<IconProps>;
+
+declare const channel: _zylem_bridge.BridgeChannel;
+/**
+ * Subscribe the editor stores to game→editor bridge messages and hydrate
+ * from the channel's retained state.
+ *
+ * Reference-counted: the game gates expensive editor-only work (thumbnails,
+ * entity summaries) on these subscriptions existing, so the last editor to
+ * unmount must actually release them, while any editor still mounted must
+ * keep them alive.
+ *
+ * @returns A release function; safe to call more than once.
+ */
+declare function connectEditorBridge(): () => void;
+/** Tear down all bridge subscriptions, ignoring the reference count. */
+declare function disconnectEditorBridge(): void;
+/** Toggle the game's debug mode. */
+declare function sendDebugEnabled(enabled: boolean): void;
+/** Switch the active editor tool in the game. */
+declare function sendTool(tool: BridgeDebugTool): void;
+/** Pause or resume the game loop. */
+declare function sendPlayback(paused: boolean): void;
+/** Select an entity in the game (null clears the selection). */
+declare function sendEntitySelect(uuid: string | null): void;
+/** Focus/frame the game debug camera on an entity. */
+declare function sendEntityFocus(uuid: string): void;
+/** Write a stage variable in the running game. */
+declare function sendStageVariable(key: string, value: unknown): void;
 
 /**
  * Editor Host Helpers
  *
  * Reusable wiring for apps that embed the <zylem-editor> overlay next to a
- * running Zylem game. Consolidates the mount + state-bridge boilerplate that
- * was previously duplicated across consuming apps (examples, creator preview).
+ * running Zylem game. These helpers are thin wrappers over the shared
+ * `@zylem/bridge` channel: the game applies editor commands itself (via its
+ * bridge adapter), so hosts only need this module to mount the overlay,
+ * mirror editor commands into their own stores, or push state into the
+ * editor UI.
  */
 
+/**
+ * Nested state payload used by host-facing helpers.
+ * Mirrors the historical `editor-state-dispatch` window-event shape so
+ * existing hosts keep working; internally everything rides the bridge.
+ */
+interface EditorUpdatePayload {
+    gameState?: {
+        debugFlag?: boolean;
+        [key: string]: unknown;
+    };
+    toolbarState?: {
+        tool?: BridgeDebugTool;
+        paused?: boolean;
+    };
+    [key: string]: unknown;
+}
 interface EditorStateBridgeOptions {
     /**
-     * Called after each editor state dispatch has been applied to the
-     * game-lib debug state, so hosts can mirror the payload into their own
-     * stores (e.g. a SolidJS store).
+     * Called after each editor command has been sent to the game, so hosts
+     * can mirror the payload into their own stores (e.g. a SolidJS store).
      */
     onStateDispatch?: (payload: EditorUpdatePayload) => void;
 }
 interface EditorStateBridge {
     /** Push external app state back into the editor UI. */
     dispatchToEditor(payload: EditorUpdatePayload): void;
-    /** Remove the window listener installed by the bridge. */
+    /** Remove the bridge subscriptions installed by this helper. */
     dispose(): void;
 }
 /**
- * Dispatch a state update payload to the editor (EDITOR_STATE_RECEIVE).
- * Safe to call in non-browser environments (no-op).
+ * Push a state update payload into the editor UI (stores + game command).
+ * Safe to call in non-browser environments (no-op side effects only).
  */
 declare function dispatchToEditor(payload: EditorUpdatePayload): void;
 /**
- * Listen for editor state dispatches (EDITOR_STATE_DISPATCH) and sync them
- * into the game-lib debug state: debug flag, active tool, and pause state.
+ * Observe editor→game commands on the shared bridge.
+ *
+ * The game side applies commands itself; this helper exists so external
+ * hosts can mirror editor actions (debug toggle, tool, pause) into their own
+ * state via `onStateDispatch`.
+ *
+ * This deliberately does **not** open the editor's game→editor store
+ * subscriptions. Those are owned by `<zylem-editor>` for the duration it is
+ * mounted, and the game gates expensive work (thumbnail renders, entity
+ * summaries) on them being present. A long-lived host helper holding one open
+ * would keep that work running forever, even with no editor on screen. Hosts
+ * that render editor components without the custom element should call
+ * `connectEditorBridge()` directly and release it themselves.
  *
  * @example
  * ```ts
@@ -365,12 +466,31 @@ declare function dispatchToEditor(payload: EditorUpdatePayload): void;
  * ```
  */
 declare function attachEditorStateBridge(options?: EditorStateBridgeOptions): EditorStateBridge;
+/**
+ * Send an editor state payload as bridge commands to the running game.
+ *
+ * @deprecated Use the typed bridge commands (`sendDebugEnabled`, `sendTool`,
+ * `sendPlayback`) instead. Kept for hosts migrating off the old
+ * window-CustomEvent API.
+ */
+declare function dispatchEditorUpdate(payload: EditorUpdatePayload): void;
 interface MountZylemEditorOptions extends EditorStateBridgeOptions {
     /**
      * Controls the editor's floating launcher button.
      * @default 'floating'
      */
     launcherMode?: EditorLauncherMode;
+    /**
+     * Dock layout to seed on first run, keyed by viewport edge. `'main'` is the
+     * editor panel; any other id is a section such as `'console'`. Ignored once
+     * the user has a saved layout.
+     *
+     * @example
+     * ```ts
+     * mountZylemEditor({ defaultDocks: { left: ['main'], bottom: ['console'] } });
+     * ```
+     */
+    defaultDocks?: EditorDockDefaults;
     /**
      * Element the <zylem-editor> overlay is appended to.
      * @default document.body
@@ -379,6 +499,8 @@ interface MountZylemEditorOptions extends EditorStateBridgeOptions {
 }
 interface MountedZylemEditor extends EditorStateBridge {
     element: ZylemEditorElement;
+    /** Dock a panel to a viewport edge, or pass `null` to float it again. */
+    dockPanel(side: DockSide | null, panelId?: DockPanelId): void;
 }
 /**
  * Imperatively mount a <zylem-editor> overlay and attach the state bridge.
@@ -392,4 +514,4 @@ interface MountedZylemEditor extends EditorStateBridge {
  */
 declare function mountZylemEditor(options?: MountZylemEditorOptions): MountedZylemEditor;
 
-export { EDITOR_STATE_DISPATCH, EDITOR_STATE_RECEIVE, EDITOR_UPDATE_EVENT, type EditorEvent, type EditorEventType, type EditorStateBridge, type EditorStateBridgeOptions, type EditorUpdatePayload, Icon, type MountZylemEditorOptions, type MountedZylemEditor, type ZylemEditorConfig, ZylemEditorElement, attachEditorStateBridge, debugState, debugStore, dispatchEditorUpdate, dispatchToEditor, editorEvents, gameState, mountZylemEditor, registerZylemEditor, stageState };
+export { DOCK_SIDES, type DockPanelId, type DockRect, type DockRegistry, type DockSide, type DockZoneState, type EditorDockDefaults, type EditorEvent, type EditorEventType, type EditorStateBridge, type EditorStateBridgeOptions, type EditorUpdatePayload, Icon, MAIN_PANEL_ID, type MountZylemEditorOptions, type MountedZylemEditor, type ZylemEditorConfig, ZylemEditorElement, attachEditorStateBridge, channel as bridgeChannel, computeDockLayout, connectEditorBridge, debugState, debugStore, disconnectEditorBridge, dispatchEditorUpdate, dispatchToEditor, dockPanelToSide, editorEvents, findDockedSide, gameState, getDockedSide, mountZylemEditor, registerZylemEditor, sendDebugEnabled, sendEntityFocus, sendEntitySelect, sendPlayback, sendStageVariable, sendTool, stageState, undockPanelFromSides };