@weasel-js/forge 1.5.0 → 1.5.2

package/dist/shell/index.d.ts

@@ -1,10 +1,15 @@
-import { I as IndexEntry, c as FromFrame } from '../FrameController-Ba3LaWfq.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { StorageAdapter, InstrumentList } from '@weasel-js/labkit';
-import { S as ShellConfig, a as GlobalDeclarations } from '../config-DdumOfyd.js';
+import { LabContribution, StorageAdapter, InstrumentList } from '@weasel-js/labkit';
+import { I as IndexEntry, e as FromFrame, b as A11yReport, T as ToFrame, C as CssVarReport, f as CapturedPicture, V as Viewport } from '../FrameController-eZM3hlcE.js';
+import { S as ShellConfig, a as GlobalDeclarations } from '../config-CSVP6duU.js';
 import * as react from 'react';
+import { RefObject } from 'react';
 import '@weasel-js/labkit/config';
 
+/** 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 const A11Y_SECTION: LabContribution;
+
 interface WorkshopProps {
     index: readonly IndexEntry[];
     frameUrl: string;
@@ -34,8 +39,60 @@ type Ready = Extract<FromFrame, {
     type: 'ready';
 }>;
 
+type Send = (msg: ToFrame) => void;
+/** What an axe run in the frame came back with. */
+type A11yOutcome = {
+    ok: true;
+    report: A11yReport;
+} | {
+    ok: false;
+    message: string;
+};
+/** The half of a trial's frame that answers a request: each call is one round trip over the frame's channel. */
+interface TrialFrameCalls {
+    send: Send;
+    audit: () => Promise<A11yOutcome>;
+    /** Rejects when the frame could not draw itself, or went away before it did. */
+    capture: () => Promise<CapturedPicture>;
+}
+/** What trial chrome can reach of the frame its trial shows. */
+interface TrialFrame {
+    /** Null while no frame is connected. */
+    send: Send | null;
+    /** The frame's latest `vars` report. */
+    vars: readonly CssVarReport[];
+    /** Runs axe over the story and records the answer as `a11y`. Null while no frame is connected. */
+    audit: (() => Promise<A11yOutcome>) | null;
+    /** What the last audit found; null until one has run against the connected frame. */
+    a11y: A11yOutcome | null;
+    /** The story's own picture, for an export to draw over. Null while no frame is connected. */
+    capture: (() => Promise<CapturedPicture>) | null;
+    /** The story's content box, as the frame last measured it; null until it has. */
+    size: Viewport | null;
+}
+/** Each trial's frame, keyed by trial id: `FrameView` connects and reports, trial chrome reads. */
+interface TrialFrames {
+    /** Returns a disconnect that does nothing once a newer connection replaced this one. */
+    connect(trialId: string, calls: TrialFrameCalls): () => void;
+    report(trialId: string, vars: readonly CssVarReport[]): void;
+    reportA11y(trialId: string, outcome: A11yOutcome): void;
+    reportSize(trialId: string, size: Viewport): void;
+    /** The element a trial's frame is mounted in — stable across the frame reloads that replace the link,
+     *  because an annotation target's ref has to outlive them. */
+    hostRef(trialId: string): RefObject<HTMLElement | null>;
+    get(trialId: string): TrialFrame;
+    subscribe(listener: () => void): () => void;
+}
+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 frame has reported its schema. An instrument is built
+     *  either way, and before the report 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;
 }
@@ -46,6 +103,7 @@ interface StoryRegistry {
 declare function useStoryRegistry(index: readonly IndexEntry[], options: {
     frameUrl: string;
     globals?: GlobalDeclarations;
+    frames?: TrialFrames;
 }): StoryRegistry;
 
-export { type MountWorkshopOptions, type MountedWorkshop, StoryGlobalsContext, type StoryRegistry, Workshop, type WorkshopProps, mountWorkshop, useStoryRegistry };
+export { A11Y_SECTION, type A11yOutcome, A11yPanel, type MountWorkshopOptions, type MountedWorkshop, StoryGlobalsContext, type StoryRegistry, type TrialFrame, type TrialFrames, TrialFramesContext, Workshop, type WorkshopProps, mountWorkshop, useStoryRegistry, useTrialFrame };