@weasel-js/forge 1.6.0 → 1.7.0

package/dist/shell/index.d.ts

@@ -1,15 +1,14 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { LabContribution, StorageAdapter, RenderContext, InstrumentList } from '@weasel-js/labkit';
-import { FrameImporters } from '../frame/index.js';
-import { g as IndexEntry, F as FrameSetup, L as LoadedStory, h as Layout, G as Globals, i as FromFrame, b as A11yReport, T as ToFrame, C as CssVarReport, j as CapturedPicture, V as Viewport } from '../FrameController-BspC9Zr5.js';
-import { S as ShellConfig, a as GlobalDeclarations } from '../config-DU_WuORS.js';
 import * as react from 'react';
 import { RefObject, ReactNode } from 'react';
+import { LabContribution, StorageAdapter, RenderContext, InstrumentList } from '@weasel-js/labkit';
+import { FrameImporters } from '../frame/index.js';
+import { h as IndexEntry, F as FrameSetup, c as DepGraph, L as LoadedStory, i as Layout, G as Globals, j as FromFrame, b as A11yReport, T as ToFrame, k as CssVarReport, l as CapturedPicture, V as Viewport } from '../FrameController-HEcTM04H.js';
+import { S as ShellConfig, a as GlobalDeclarations } from '../config-pDbcbGco.js';
 import '@weasel-js/labkit/config';
 import '@weasel-js/theme';
 
 /** What axe found in the story of the trial this is rendered inside, re-run on demand. */
-declare function A11yPanel(): react_jsx_runtime.JSX.Element;
+declare function A11yPanel(): react.JSX.Element;
 declare const A11Y_SECTION: LabContribution;
 
 /** Story files edited while the workshop runs, for the registry to load again. */
@@ -33,8 +32,10 @@ interface WorkshopProps {
     stories?: readonly string[];
     storageKey?: string;
     storage?: StorageAdapter;
+    /** The component graph index pages list dependencies from. */
+    dependencies?: DepGraph;
 }
-declare function Workshop({ index, frameUrl, importers, setup, changes, config, stories, storageKey, storage }: WorkshopProps): react_jsx_runtime.JSX.Element;
+declare function Workshop({ index, frameUrl, importers, setup, changes, config, stories, storageKey, storage, dependencies }: WorkshopProps): react.JSX.Element;
 
 interface MountWorkshopOptions extends WorkshopProps {
     /** Default: the document's `#root`. */
@@ -47,6 +48,8 @@ interface MountedWorkshop {
     setImporters(importers: FrameImporters): void;
     /** Loads `file` again for every story that had it, through the current importers. */
     reloadStory(file: string): void;
+    /** Swaps in the component graph, as the vite plugin's `forge:deps` event carries. */
+    setDependencies(dependencies: DepGraph): void;
     unmount(): void;
 }
 declare function mountWorkshop({ container, ...props }: MountWorkshopOptions): MountedWorkshop;
@@ -65,7 +68,7 @@ interface StoryTrialProps {
     onError?: (error: unknown) => void;
 }
 /** A story rendered in the workshop document, inside a `TrialHost`, from the trial's own config and state. */
-declare function StoryTrial({ story, setup, ctx, hostRef, onRendered, onError }: StoryTrialProps): react_jsx_runtime.JSX.Element;
+declare function StoryTrial({ story, setup, ctx, hostRef, onRendered, onError }: StoryTrialProps): react.JSX.Element;
 
 interface TrialHostProps {
     layout: Layout;
@@ -84,12 +87,39 @@ interface TrialHostProps {
  * itself, keeps its CSS variable overrides on itself, contains fixed-position descendants and portals, reports its
  * vars, size and audits to the trial's frame registry, and unmounts its content while out of view.
  */
-declare function TrialHost({ layout, setup, config, children, hostRef, onRendered }: TrialHostProps): react_jsx_runtime.JSX.Element;
+declare function TrialHost({ layout, setup, config, children, hostRef, onRendered }: TrialHostProps): react.JSX.Element;
 
 type Ready = Extract<FromFrame, {
     type: 'ready';
 }>;
 
+interface StoryRegistry {
+    instruments: InstrumentList;
+    /** Whether a story's schema is known: its module has loaded, or its frame has reported. An instrument is built
+     *  either way, and before that its schema is empty — which reads as "no args" to anything that cannot tell the
+     *  two apart. */
+    isReady: (id: string) => boolean;
+    /** Called by FrameView. Replaces the story's instrument only when `ready.schema`, layout or viewport differ from what it holds. */
+    onReady: (entry: IndexEntry, ready: Ready) => void;
+    /** Drops what was loaded from `file` and loads it again for every entry that had it, as after an edit. */
+    reload: (file: string) => void;
+}
+interface StoryRegistryOptions {
+    frameUrl: string;
+    globals?: GlobalDeclarations;
+    /** Story modules by file. Given, every entry without `isolate` renders in the workshop document; absent, every
+     *  entry renders in a frame. */
+    importers?: FrameImporters;
+    /** The frame config, applied to each story host in the document. */
+    setup?: FrameSetup;
+    load?: (mod: Record<string, unknown>, autoTitle: string, parameters?: Record<string, unknown>) => LoadedStory[];
+}
+/**
+ * One instrument per story in `index`, each schema holding a `$globals` group for `globals`. The lab's global values
+ * reach the stories through `StoryGlobalsContext`, not through here.
+ */
+declare function useStoryRegistry(index: readonly IndexEntry[], options: StoryRegistryOptions): StoryRegistry;
+
 type Send = (msg: ToFrame) => void;
 /** What an axe run in the frame came back with. */
 type A11yOutcome = {
@@ -138,32 +168,4 @@ declare const TrialFramesContext: react.Context<TrialFrames | null>;
 /** The frame of the trial `trialId` names, re-read when it connects or reports. */
 declare function useTrialFrame(trialId: string): TrialFrame;
 
-interface StoryRegistry {
-    instruments: InstrumentList;
-    /** Whether a story's schema is known: its module has loaded, or its frame has reported. An instrument is built
-     *  either way, and before that its schema is empty — which reads as "no args" to anything that cannot tell the
-     *  two apart. */
-    isReady: (id: string) => boolean;
-    /** Called by FrameView. Replaces the story's instrument only when `ready.schema`, layout or viewport differ from what it holds. */
-    onReady: (entry: IndexEntry, ready: Ready) => void;
-    /** Drops what was loaded from `file` and loads it again for every entry that had it, as after an edit. */
-    reload: (file: string) => void;
-}
-interface StoryRegistryOptions {
-    frameUrl: string;
-    globals?: GlobalDeclarations;
-    frames?: TrialFrames;
-    /** Story modules by file. Given, every entry without `isolate` renders in the workshop document; absent, every
-     *  entry renders in a frame. */
-    importers?: FrameImporters;
-    /** The frame config, applied to each story host in the document. */
-    setup?: FrameSetup;
-    load?: (mod: Record<string, unknown>, autoTitle: string, parameters?: Record<string, unknown>) => LoadedStory[];
-}
-/**
- * One instrument per story in `index`, each schema holding a `$globals` group for `globals`. The lab's global values
- * reach the stories through `StoryGlobalsContext`, not through here.
- */
-declare function useStoryRegistry(index: readonly IndexEntry[], options: StoryRegistryOptions): StoryRegistry;
-
 export { A11Y_SECTION, type A11yOutcome, A11yPanel, type MountWorkshopOptions, type MountedWorkshop, StoryGlobalsContext, type StoryRegistry, StoryTrial, type StoryTrialProps, type TrialFrame, type TrialFrames, TrialFramesContext, TrialHost, type TrialHostProps, Workshop, type WorkshopProps, mountWorkshop, useStoryRegistry, useTrialFrame };