@octane-xplat/workshop 0.1.0 → 0.15.0

package/types/generated/web/entry.web.d.ts

@@ -0,0 +1,53 @@
+import { createStore } from '@octane-xplat/ui/data';
+import type { CatalogEntry } from '../catalog.js';
+import type { WorkshopTarget } from '../contract.js';
+import type { SessionSnapshot } from '../session.js';
+import { WorkshopSession } from '../session.js';
+export interface ShellState {
+    mode: 'wide' | 'compact' | 'phone';
+    query: string;
+    selectedId: string | null;
+    expanded: ReadonlySet<string>;
+    catalogCollapsed: boolean;
+    controlsCollapsed: boolean;
+    auxPanel: 'stories' | 'controls' | null;
+    stageOnly: boolean;
+    stageBackground: 'default' | 'light' | 'dark';
+    stageBounds: 'available' | 'small' | 'medium';
+    catalog: CatalogEntry[];
+    catalogError: string | undefined;
+    missingId: string | null;
+    session: SessionSnapshot;
+    drafts: Record<string, string>;
+    fieldErrors: Record<string, string>;
+    unsetKeys: ReadonlySet<string>;
+}
+export interface WorkshopRuntime {
+    store: ReturnType<typeof createStore<ShellState>>;
+    session: WorkshopSession;
+    mountHost: HTMLElement;
+    selectEntry(entry: CatalogEntry): Promise<void>;
+    updateCatalog(entries: CatalogEntry[], diagnostics?: readonly {
+        message: string;
+    }[]): void;
+    loadGeneration: number;
+}
+/** Called by the generated catalog module on load and on every HMR re-execution. */
+export declare function catalogDidUpdate(entries: CatalogEntry[], diagnostics?: readonly {
+    message: string;
+}[]): void;
+export interface WorkshopBootOptions {
+    catalog: CatalogEntry[];
+    diagnostics?: readonly {
+        message: string;
+    }[];
+    target: WorkshopTarget;
+    initialStoryId?: string | null;
+    globalProviders?: readonly unknown[];
+    /** Vite HMR handle — passed by the generated entry because lib builds
+     *  fold `import.meta.hot` to undefined. */
+    hot?: {
+        on?: (event: string, cb: (payload?: unknown) => void) => void;
+    };
+}
+export declare function startWorkshop(options: WorkshopBootOptions): WorkshopRuntime;

package/types/generated/web/index.web.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Web runtime entry — the catalog virtual module and the generated workshop
+ * entry import this. Exposes startWorkshop plus the catalog-update seam the
+ * virtual catalog calls back into after HMR re-execution.
+ */
+export { createWebStageHost } from './mount.web.js';
+export { startWorkshop, catalogDidUpdate } from './entry.web.js';

package/types/generated/web/mount.web.d.ts

@@ -0,0 +1,2 @@
+import type { StageHost } from '../session.js';
+export declare function createWebStageHost(stageElement: HTMLElement): StageHost;

package/types/generated/web/shell.web.d.ts

@@ -0,0 +1,4 @@
+import type { WorkshopRuntime } from './entry.web.js';
+export declare function WorkshopApp(props: {
+    runtime: WorkshopRuntime;
+}): import("octane/jsx-runtime").JSX.Element;