@design.estate/wcctools 6.1.0 → 7.0.0

package/dist_ts/capture/navigationguard.js

@@ -0,0 +1,129 @@
+import * as plugins from '../plugins.js';
+import { WccCaptureError, getErrorMessage } from './errors.js';
+/** The message of a navigation the capture blocked. */
+export const formatBlockedNavigation = (urlArg) => {
+    return `navigation to ${urlArg} blocked: a capture stays on the rendered preview`;
+};
+/**
+ * Runs in the main frame before the preview's scripts, so its `navigate` listener is the first:
+ * cancels each navigation that would replace the document (a link, a form submission, a script
+ * assigning `location`, a reload, also to the same URL, to `about:blank` or a `blob:` URL) as it
+ * starts, and records its URL. Same-document navigations (`history.replaceState`, fragments) and
+ * downloads pass. Link clicks and scripts start their navigation while the step that caused it
+ * runs; form submissions in a task right after.
+ */
+const cancelLeavingNavigations = () => {
+    if (window !== window.top) {
+        return;
+    }
+    const cancelled = [];
+    window.wccCancelledNavigations = cancelled;
+    navigation.addEventListener('navigate', (eventArg) => {
+        if (eventArg.destination.sameDocument || eventArg.downloadRequest !== null || !eventArg.cancelable) {
+            return;
+        }
+        eventArg.preventDefault();
+        cancelled.push(eventArg.destination.url);
+    });
+};
+/**
+ * Keeps a capture page on the preview. Its main frame loads the preview document once; after that,
+ * the page script above cancels every navigation that would replace the document before it starts.
+ * Request interception backs it up: a main-frame navigation request the page could not cancel is
+ * aborted before it leaves. The preview's history holds the preview alone, so there is no earlier
+ * document to go back to. Subframes and all other requests are left alone.
+ *
+ * `takeBlockedNavigation()` answers the navigation blocked since its last call, so each step of an
+ * interaction learns about the navigation it started.
+ */
+export class WccNavigationGuard {
+    page;
+    /** Navigation requests aborted by the backstop since the last `takeBlockedNavigation()`. */
+    abortedUrls = [];
+    interceptionFailure = null;
+    previewUrl;
+    constructor(page, previewUrlArg) {
+        this.page = page;
+        this.previewUrl = new URL(previewUrlArg).href;
+    }
+    /**
+     * Installs the page script and intercepts the page's requests; the page's first main-frame
+     * navigation may load `previewUrlArg` only. Install before loading the preview.
+     */
+    static async install(pageArg, previewUrlArg) {
+        const guard = new WccNavigationGuard(pageArg, previewUrlArg);
+        pageArg.on('request', (requestArg) => guard.decide(requestArg));
+        await pageArg.setRequestInterception(true);
+        await pageArg.evaluateOnNewDocument(cancelLeavingNavigations);
+        return guard;
+    }
+    /** Drops the history entries before the loaded preview (the blank page it opened as), so going back leaves nothing. */
+    async forgetEarlierHistory() {
+        const session = await this.page.createCDPSession();
+        try {
+            await session.send('Page.resetNavigationHistory');
+        }
+        finally {
+            await session.detach();
+        }
+    }
+    /**
+     * Lets the page run the tasks queued so far (an animation frame, then a task), then answers the
+     * URL of the first navigation blocked since the last call, by the page script or the backstop,
+     * or null when none was.
+     */
+    async takeBlockedNavigation() {
+        const cancelledUrl = await this.page.evaluate(() => {
+            return new Promise((resolve) => {
+                requestAnimationFrame(() => {
+                    setTimeout(() => {
+                        const cancelled = window.wccCancelledNavigations ?? [];
+                        resolve(cancelled[0] ?? null);
+                        cancelled.length = 0;
+                    }, 0);
+                });
+            });
+        });
+        if (this.interceptionFailure !== null) {
+            throw new WccCaptureError(`wcctools: the capture failed to handle a request of the preview: ${getErrorMessage(this.interceptionFailure)}`);
+        }
+        const abortedUrl = this.abortedUrls[0] ?? null;
+        this.abortedUrls = [];
+        return cancelledUrl ?? abortedUrl;
+    }
+    /** Throws when the page tried to leave the preview while `whileArg` (e.g. "rendering"). */
+    async assertStayed(whileArg) {
+        const blockedUrl = await this.takeBlockedNavigation();
+        if (blockedUrl !== null) {
+            throw new WccCaptureError(`wcctools: the demo tried to navigate away while ${whileArg}; ${formatBlockedNavigation(blockedUrl)}.`);
+        }
+    }
+    decide(requestArg) {
+        if (requestArg.isInterceptResolutionHandled()) {
+            return;
+        }
+        if (!requestArg.isNavigationRequest() || requestArg.frame() !== this.page.mainFrame()) {
+            this.settle(requestArg.continue());
+            return;
+        }
+        if (this.previewUrl !== null && requestArg.url() === this.previewUrl) {
+            // The preview document's own load, once
+            this.previewUrl = null;
+            this.settle(requestArg.continue());
+            return;
+        }
+        this.abortedUrls.push(requestArg.url());
+        // `aborted` drops the navigation without committing an error page, so the preview stays
+        this.settle(requestArg.abort('aborted'));
+    }
+    /**
+     * Keeps the first failure of an interception decision. Puppeteer itself tolerates a request
+     * that ended or a page that closed meanwhile; what reaches here fails the capture.
+     */
+    settle(decisionArg) {
+        decisionArg.catch((errorArg) => {
+            this.interceptionFailure ??= errorArg;
+        });
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmF2aWdhdGlvbmd1YXJkLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vdHMvY2FwdHVyZS9uYXZpZ2F0aW9uZ3VhcmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUM7QUFDekMsT0FBTyxFQUFFLGVBQWUsRUFBRSxlQUFlLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFLL0QsdURBQXVEO0FBQ3ZELE1BQU0sQ0FBQyxNQUFNLHVCQUF1QixHQUFHLENBQUMsTUFBYyxFQUFVLEVBQUU7SUFDaEUsT0FBTyxpQkFBaUIsTUFBTSxtREFBbUQsQ0FBQztBQUNwRixDQUFDLENBQUM7QUFRRjs7Ozs7OztHQU9HO0FBQ0gsTUFBTSx3QkFBd0IsR0FBRyxHQUFHLEVBQUU7SUFDcEMsSUFBSSxNQUFNLEtBQUssTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQzFCLE9BQU87SUFDVCxDQUFDO0lBQ0QsTUFBTSxTQUFTLEdBQWEsRUFBRSxDQUFDO0lBQzlCLE1BQStDLENBQUMsdUJBQXVCLEdBQUcsU0FBUyxDQUFDO0lBQ3JGLFVBQVUsQ0FBQyxnQkFBZ0IsQ0FBQyxVQUFVLEVBQUUsQ0FBQyxRQUFRLEVBQUUsRUFBRTtRQUNuRCxJQUFJLFFBQVEsQ0FBQyxXQUFXLENBQUMsWUFBWSxJQUFJLFFBQVEsQ0FBQyxlQUFlLEtBQUssSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLFVBQVUsRUFBRSxDQUFDO1lBQ25HLE9BQU87UUFDVCxDQUFDO1FBQ0QsUUFBUSxDQUFDLGNBQWMsRUFBRSxDQUFDO1FBQzFCLFNBQVMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUMzQyxDQUFDLENBQUMsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUVGOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sT0FBTyxrQkFBa0I7SUFPVjtJQU5uQiw0RkFBNEY7SUFDcEYsV0FBVyxHQUFhLEVBQUUsQ0FBQztJQUMzQixtQkFBbUIsR0FBWSxJQUFJLENBQUM7SUFDcEMsVUFBVSxDQUFnQjtJQUVsQyxZQUNtQixJQUFXLEVBQzVCLGFBQXFCO1FBREosU0FBSSxHQUFKLElBQUksQ0FBTztRQUc1QixJQUFJLENBQUMsVUFBVSxHQUFHLElBQUksR0FBRyxDQUFDLGFBQWEsQ0FBQyxDQUFDLElBQUksQ0FBQztJQUNoRCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0ksTUFBTSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsT0FBYyxFQUFFLGFBQXFCO1FBQy9ELE1BQU0sS0FBSyxHQUFHLElBQUksa0JBQWtCLENBQUMsT0FBTyxFQUFFLGFBQWEsQ0FBQyxDQUFDO1FBQzdELE9BQU8sQ0FBQyxFQUFFLENBQUMsU0FBUyxFQUFFLENBQUMsVUFBVSxFQUFFLEVBQUUsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUM7UUFDaEUsTUFBTSxPQUFPLENBQUMsc0JBQXNCLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDM0MsTUFBTSxPQUFPLENBQUMscUJBQXFCLENBQUMsd0JBQXdCLENBQUMsQ0FBQztRQUM5RCxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCx1SEFBdUg7SUFDaEgsS0FBSyxDQUFDLG9CQUFvQjtRQUMvQixNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQztRQUNuRCxJQUFJLENBQUM7WUFDSCxNQUFNLE9BQU8sQ0FBQyxJQUFJLENBQUMsNkJBQTZCLENBQUMsQ0FBQztRQUNwRCxDQUFDO2dCQUFTLENBQUM7WUFDVCxNQUFNLE9BQU8sQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUN6QixDQUFDO0lBQ0gsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sWUFBWSxHQUFHLE1BQU0sSUFBSSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxFQUFFO1lBQ2pELE9BQU8sSUFBSSxPQUFPLENBQWdCLENBQUMsT0FBTyxFQUFFLEVBQUU7Z0JBQzVDLHFCQUFxQixDQUFDLEdBQUcsRUFBRTtvQkFDekIsVUFBVSxDQUFDLEdBQUcsRUFBRTt3QkFDZCxNQUFNLFNBQVMsR0FBSSxNQUErQyxDQUFDLHVCQUF1QixJQUFJLEVBQUUsQ0FBQzt3QkFDakcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQzt3QkFDOUIsU0FBUyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUM7b0JBQ3ZCLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztnQkFDUixDQUFDLENBQUMsQ0FBQztZQUNMLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUM7UUFDSCxJQUFJLElBQUksQ0FBQyxtQkFBbUIsS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUN0QyxNQUFNLElBQUksZUFBZSxDQUFDLG9FQUFvRSxlQUFlLENBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQzdJLENBQUM7UUFDRCxNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQztRQUMvQyxJQUFJLENBQUMsV0FBVyxHQUFHLEVBQUUsQ0FBQztRQUN0QixPQUFPLFlBQVksSUFBSSxVQUFVLENBQUM7SUFDcEMsQ0FBQztJQUVELDJGQUEyRjtJQUNwRixLQUFLLENBQUMsWUFBWSxDQUFDLFFBQWdCO1FBQ3hDLE1BQU0sVUFBVSxHQUFHLE1BQU0sSUFBSSxDQUFDLHFCQUFxQixFQUFFLENBQUM7UUFDdEQsSUFBSSxVQUFVLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDeEIsTUFBTSxJQUFJLGVBQWUsQ0FBQyxtREFBbUQsUUFBUSxLQUFLLHVCQUF1QixDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNwSSxDQUFDO0lBQ0gsQ0FBQztJQUVPLE1BQU0sQ0FBQyxVQUF3QjtRQUNyQyxJQUFJLFVBQVUsQ0FBQyw0QkFBNEIsRUFBRSxFQUFFLENBQUM7WUFDOUMsT0FBTztRQUNULENBQUM7UUFDRCxJQUFJLENBQUMsVUFBVSxDQUFDLG1CQUFtQixFQUFFLElBQUksVUFBVSxDQUFDLEtBQUssRUFBRSxLQUFLLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLEVBQUUsQ0FBQztZQUN0RixJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ25DLE9BQU87UUFDVCxDQUFDO1FBQ0QsSUFBSSxJQUFJLENBQUMsVUFBVSxLQUFLLElBQUksSUFBSSxVQUFVLENBQUMsR0FBRyxFQUFFLEtBQUssSUFBSSxDQUFDLFVBQVUsRUFBRSxDQUFDO1lBQ3JFLHdDQUF3QztZQUN4QyxJQUFJLENBQUMsVUFBVSxHQUFHLElBQUksQ0FBQztZQUN2QixJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ25DLE9BQU87UUFDVCxDQUFDO1FBQ0QsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDeEMsd0ZBQXdGO1FBQ3hGLElBQUksQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO0lBQzNDLENBQUM7SUFFRDs7O09BR0c7SUFDSyxNQUFNLENBQUMsV0FBMEI7UUFDdkMsV0FBVyxDQUFDLEtBQUssQ0FBQyxDQUFDLFFBQWlCLEVBQUUsRUFBRTtZQUN0QyxJQUFJLENBQUMsbUJBQW1CLEtBQUssUUFBUSxDQUFDO1FBQ3hDLENBQUMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztDQUNGIn0=

package/dist_ts/capture/previewpage.d.ts

@@ -0,0 +1,29 @@
+import * as plugins from '../plugins.js';
+import { WccNavigationGuard } from './navigationguard.js';
+import { type IWccResolvedImageOptions, type IWccResolvedView } from './request.js';
+type TBrowserContext = plugins.smartbrowser.puppeteer.BrowserContext;
+type TPage = plugins.smartbrowser.puppeteer.Page;
+/** A preview document in the capture browser that rendered one demo. */
+export interface IWccRenderedPreview {
+    page: TPage;
+    /** Keeps the page on the preview and knows the navigation it blocked. */
+    navigationGuard: WccNavigationGuard;
+    selection: plugins.interfaces.IWccSelection;
+    /** What the demo rendered: an element demo or a page. */
+    type: 'element' | 'page';
+}
+/**
+ * Opens the preview route of the dev server at `originArg` in the context, waits for the preview
+ * runtime to install its bridge (it does once it rendered the route), resolves the subject against
+ * the catalog manifest and renders it. Waits only on the preview's own signals: the bridge, the
+ * render's completed updates and the document's fonts. The page stays on the preview: every
+ * later navigation of its main frame is blocked, and one blocked while rendering fails the capture.
+ */
+export declare const renderPreview: (contextArg: TBrowserContext, originArg: string, viewArg: IWccResolvedView, subjectArg: plugins.interfaces.IWccCaptureSubject) => Promise<IWccRenderedPreview>;
+/** Screenshots a rendered preview as framed. */
+export declare const screenshotPreview: (previewArg: IWccRenderedPreview, viewArg: IWccResolvedView, optionsArg: IWccResolvedImageOptions) => Promise<{
+    framing: plugins.interfaces.TWccCaptureFraming;
+    image: plugins.interfaces.IWccImage;
+    truncated: boolean;
+}>;
+export {};

package/dist_ts/capture/previewpage.js

@@ -0,0 +1,96 @@
+import * as plugins from '../plugins.js';
+import { WccCaptureError, WccCaptureRequestError, getErrorMessage } from './errors.js';
+import { toWccImage } from './images.js';
+import { WccNavigationGuard } from './navigationguard.js';
+import { captureLimits, resolveSelection } from './request.js';
+/** How long the preview document may take to load and render its demo. */
+const previewStartTimeoutMs = 20_000;
+const formatPageErrors = (errorsArg) => {
+    return errorsArg.length > 0 ? ` The preview reported: ${errorsArg.slice(0, 5).join(' | ')}` : '';
+};
+/**
+ * Opens the preview route of the dev server at `originArg` in the context, waits for the preview
+ * runtime to install its bridge (it does once it rendered the route), resolves the subject against
+ * the catalog manifest and renders it. Waits only on the preview's own signals: the bridge, the
+ * render's completed updates and the document's fonts. The page stays on the preview: every
+ * later navigation of its main frame is blocked, and one blocked while rendering fails the capture.
+ */
+export const renderPreview = async (contextArg, originArg, viewArg, subjectArg) => {
+    const page = await contextArg.newPage();
+    const pageErrors = [];
+    page.on('pageerror', (errorArg) => {
+        pageErrors.push(getErrorMessage(errorArg));
+    });
+    page.on('console', (messageArg) => {
+        if (messageArg.type() === 'error') {
+            pageErrors.push(messageArg.text());
+        }
+    });
+    await page.setViewport({ width: viewArg.width, height: viewArg.height, deviceScaleFactor: viewArg.scale });
+    await page.emulateMediaFeatures([
+        { name: 'prefers-color-scheme', value: viewArg.theme === 'bright' ? 'light' : 'dark' },
+    ]);
+    const previewUrl = `${originArg}${plugins.shared.previewRoutePath}${plugins.shared.formatPreviewQuery({ selection: null, theme: viewArg.theme })}`;
+    const navigationGuard = await WccNavigationGuard.install(page, previewUrl);
+    const response = await page.goto(previewUrl, { waitUntil: 'load', timeout: previewStartTimeoutMs });
+    if (!response?.ok()) {
+        throw new WccCaptureError(`wcctools: the preview document answered ${response?.status() ?? 'nothing'}.${formatPageErrors(pageErrors)}`);
+    }
+    await navigationGuard.forgetEarlierHistory();
+    try {
+        await page.waitForFunction(() => window.wccPreview !== undefined, { polling: 'raf', timeout: previewStartTimeoutMs });
+    }
+    catch (error) {
+        throw new WccCaptureError(`wcctools: the preview did not start within ${previewStartTimeoutMs / 1000} s (${getErrorMessage(error)}).${formatPageErrors(pageErrors)}`);
+    }
+    const manifest = await page.evaluate(() => window.wccPreview.getManifest());
+    const selection = resolveSelection(manifest, subjectArg);
+    const outcome = await page.evaluate((selectionArg) => window.wccPreview.render(selectionArg), selection);
+    if (outcome.kind === 'empty') {
+        throw new WccCaptureError(`wcctools: ${selection.sectionName}/${selection.itemName} demo ${selection.demoIndex} did not render: ${outcome.emptyState.title}. ${outcome.emptyState.detail}${formatPageErrors(pageErrors)}`);
+    }
+    await page.evaluate(async () => {
+        await document.fonts.ready;
+    });
+    await navigationGuard.assertStayed('rendering');
+    return { page, navigationGuard, selection, type: outcome.type };
+};
+/** Screenshots a rendered preview as framed. */
+export const screenshotPreview = async (previewArg, viewArg, optionsArg) => {
+    const { page } = previewArg;
+    const framing = optionsArg.framing ?? (previewArg.type === 'page' ? 'fullpage' : 'element');
+    const encoding = { type: optionsArg.format, ...(optionsArg.quality === undefined ? {} : { quality: optionsArg.quality }) };
+    if (framing === 'element') {
+        if (previewArg.type === 'page') {
+            throw new WccCaptureRequestError('wcctools: a page has no element to frame; use the viewport or fullpage framing.');
+        }
+        const handle = await page.evaluateHandle(() => window.wccPreview.findRenderedInstance());
+        try {
+            const element = handle.asElement();
+            if (!element) {
+                throw new WccCaptureError(`wcctools: the demo of ${previewArg.selection.itemName} renders no instance of its element; use the viewport framing.`);
+            }
+            const bytes = await element.screenshot(encoding);
+            return { framing, image: toWccImage(bytes, optionsArg.format), truncated: false };
+        }
+        finally {
+            await handle.dispose();
+        }
+    }
+    if (framing === 'viewport') {
+        const bytes = await page.screenshot(encoding);
+        return { framing, image: toWccImage(bytes, optionsArg.format), truncated: false };
+    }
+    const documentHeight = await page.evaluate(() => document.documentElement.scrollHeight);
+    if (documentHeight > captureLimits.maxFullPageHeight) {
+        const bytes = await page.screenshot({
+            ...encoding,
+            clip: { x: 0, y: 0, width: viewArg.width, height: captureLimits.maxFullPageHeight },
+            captureBeyondViewport: true,
+        });
+        return { framing, image: toWccImage(bytes, optionsArg.format), truncated: true };
+    }
+    const bytes = await page.screenshot({ ...encoding, fullPage: true });
+    return { framing, image: toWccImage(bytes, optionsArg.format), truncated: false };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJldmlld3BhZ2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9jYXB0dXJlL3ByZXZpZXdwYWdlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxlQUFlLEVBQUUsc0JBQXNCLEVBQUUsZUFBZSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ3ZGLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDekMsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDMUQsT0FBTyxFQUFFLGFBQWEsRUFBRSxnQkFBZ0IsRUFBd0QsTUFBTSxjQUFjLENBQUM7QUFLckgsMEVBQTBFO0FBQzFFLE1BQU0scUJBQXFCLEdBQUcsTUFBTSxDQUFDO0FBWXJDLE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxTQUFtQixFQUFVLEVBQUU7SUFDdkQsT0FBTyxTQUFTLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsMEJBQTBCLFNBQVMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7QUFDbkcsQ0FBQyxDQUFDO0FBRUY7Ozs7OztHQU1HO0FBQ0gsTUFBTSxDQUFDLE1BQU0sYUFBYSxHQUFHLEtBQUssRUFDaEMsVUFBMkIsRUFDM0IsU0FBaUIsRUFDakIsT0FBeUIsRUFDekIsVUFBaUQsRUFDbkIsRUFBRTtJQUNoQyxNQUFNLElBQUksR0FBRyxNQUFNLFVBQVUsQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUN4QyxNQUFNLFVBQVUsR0FBYSxFQUFFLENBQUM7SUFDaEMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxRQUFRLEVBQUUsRUFBRTtRQUNoQyxVQUFVLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO0lBQzdDLENBQUMsQ0FBQyxDQUFDO0lBQ0gsSUFBSSxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsQ0FBQyxVQUFVLEVBQUUsRUFBRTtRQUNoQyxJQUFJLFVBQVUsQ0FBQyxJQUFJLEVBQUUsS0FBSyxPQUFPLEVBQUUsQ0FBQztZQUNsQyxVQUFVLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBQ3JDLENBQUM7SUFDSCxDQUFDLENBQUMsQ0FBQztJQUNILE1BQU0sSUFBSSxDQUFDLFdBQVcsQ0FBQyxFQUFFLEtBQUssRUFBRSxPQUFPLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxPQUFPLENBQUMsTUFBTSxFQUFFLGlCQUFpQixFQUFFLE9BQU8sQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDO0lBQzNHLE1BQU0sSUFBSSxDQUFDLG9CQUFvQixDQUFDO1FBQzlCLEVBQUUsSUFBSSxFQUFFLHNCQUFzQixFQUFFLEtBQUssRUFBRSxPQUFPLENBQUMsS0FBSyxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxNQUFNLEVBQUU7S0FDdkYsQ0FBQyxDQUFDO0lBRUgsTUFBTSxVQUFVLEdBQUcsR0FBRyxTQUFTLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxnQkFBZ0IsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLEtBQUssRUFBRSxDQUFDLEVBQUUsQ0FBQztJQUNuSixNQUFNLGVBQWUsR0FBRyxNQUFNLGtCQUFrQixDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7SUFDM0UsTUFBTSxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxFQUFFLFNBQVMsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLHFCQUFxQixFQUFFLENBQUMsQ0FBQztJQUNwRyxJQUFJLENBQUMsUUFBUSxFQUFFLEVBQUUsRUFBRSxFQUFFLENBQUM7UUFDcEIsTUFBTSxJQUFJLGVBQWUsQ0FBQywyQ0FBMkMsUUFBUSxFQUFFLE1BQU0sRUFBRSxJQUFJLFNBQVMsSUFBSSxnQkFBZ0IsQ0FBQyxVQUFVLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDMUksQ0FBQztJQUNELE1BQU0sZUFBZSxDQUFDLG9CQUFvQixFQUFFLENBQUM7SUFDN0MsSUFBSSxDQUFDO1FBQ0gsTUFBTSxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxVQUFVLEtBQUssU0FBUyxFQUFFLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUscUJBQXFCLEVBQUUsQ0FBQyxDQUFDO0lBQ3hILENBQUM7SUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1FBQ2YsTUFBTSxJQUFJLGVBQWUsQ0FDdkIsOENBQThDLHFCQUFxQixHQUFHLElBQUksT0FBTyxlQUFlLENBQUMsS0FBSyxDQUFDLEtBQUssZ0JBQWdCLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FDM0ksQ0FBQztJQUNKLENBQUM7SUFFRCxNQUFNLFFBQVEsR0FBRyxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxFQUFFLENBQUMsTUFBTSxDQUFDLFVBQVcsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxDQUFDO0lBQzdFLE1BQU0sU0FBUyxHQUFHLGdCQUFnQixDQUFDLFFBQVEsRUFBRSxVQUFVLENBQUMsQ0FBQztJQUN6RCxNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxZQUFZLEVBQUUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxVQUFXLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBQzFHLElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxPQUFPLEVBQUUsQ0FBQztRQUM3QixNQUFNLElBQUksZUFBZSxDQUN2QixhQUFhLFNBQVMsQ0FBQyxXQUFXLElBQUksU0FBUyxDQUFDLFFBQVEsU0FBUyxTQUFTLENBQUMsU0FBUyxvQkFBb0IsT0FBTyxDQUFDLFVBQVUsQ0FBQyxLQUFLLEtBQUssT0FBTyxDQUFDLFVBQVUsQ0FBQyxNQUFNLEdBQUcsZ0JBQWdCLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FDaE0sQ0FBQztJQUNKLENBQUM7SUFDRCxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDN0IsTUFBTSxRQUFRLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQztJQUM3QixDQUFDLENBQUMsQ0FBQztJQUNILE1BQU0sZUFBZSxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNoRCxPQUFPLEVBQUUsSUFBSSxFQUFFLGVBQWUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQztBQUNsRSxDQUFDLENBQUM7QUFFRixnREFBZ0Q7QUFDaEQsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUcsS0FBSyxFQUNwQyxVQUErQixFQUMvQixPQUF5QixFQUN6QixVQUFvQyxFQUNrRixFQUFFO0lBQ3hILE1BQU0sRUFBRSxJQUFJLEVBQUUsR0FBRyxVQUFVLENBQUM7SUFDNUIsTUFBTSxPQUFPLEdBQUcsVUFBVSxDQUFDLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEtBQUssTUFBTSxDQUFDLENBQUMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzVGLE1BQU0sUUFBUSxHQUFHLEVBQUUsSUFBSSxFQUFFLFVBQVUsQ0FBQyxNQUFNLEVBQUUsR0FBRyxDQUFDLFVBQVUsQ0FBQyxPQUFPLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLEVBQUUsT0FBTyxFQUFFLFVBQVUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxFQUFXLENBQUM7SUFFcEksSUFBSSxPQUFPLEtBQUssU0FBUyxFQUFFLENBQUM7UUFDMUIsSUFBSSxVQUFVLENBQUMsSUFBSSxLQUFLLE1BQU0sRUFBRSxDQUFDO1lBQy9CLE1BQU0sSUFBSSxzQkFBc0IsQ0FBQyxpRkFBaUYsQ0FBQyxDQUFDO1FBQ3RILENBQUM7UUFDRCxNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxjQUFjLENBQUMsR0FBRyxFQUFFLENBQUMsTUFBTSxDQUFDLFVBQVcsQ0FBQyxvQkFBb0IsRUFBRSxDQUFDLENBQUM7UUFDMUYsSUFBSSxDQUFDO1lBQ0gsTUFBTSxPQUFPLEdBQUcsTUFBTSxDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQ25DLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztnQkFDYixNQUFNLElBQUksZUFBZSxDQUN2Qix5QkFBeUIsVUFBVSxDQUFDLFNBQVMsQ0FBQyxRQUFRLGdFQUFnRSxDQUN2SCxDQUFDO1lBQ0osQ0FBQztZQUNELE1BQU0sS0FBSyxHQUFHLE1BQU0sT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUNqRCxPQUFPLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxVQUFVLENBQUMsS0FBSyxFQUFFLFVBQVUsQ0FBQyxNQUFNLENBQUMsRUFBRSxTQUFTLEVBQUUsS0FBSyxFQUFFLENBQUM7UUFDcEYsQ0FBQztnQkFBUyxDQUFDO1lBQ1QsTUFBTSxNQUFNLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDekIsQ0FBQztJQUNILENBQUM7SUFFRCxJQUFJLE9BQU8sS0FBSyxVQUFVLEVBQUUsQ0FBQztRQUMzQixNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDOUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsVUFBVSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsTUFBTSxDQUFDLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxDQUFDO0lBQ3BGLENBQUM7SUFFRCxNQUFNLGNBQWMsR0FBRyxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxFQUFFLENBQUMsUUFBUSxDQUFDLGVBQWUsQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUN4RixJQUFJLGNBQWMsR0FBRyxhQUFhLENBQUMsaUJBQWlCLEVBQUUsQ0FBQztRQUNyRCxNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUM7WUFDbEMsR0FBRyxRQUFRO1lBQ1gsSUFBSSxFQUFFLEVBQUUsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxFQUFFLEtBQUssRUFBRSxPQUFPLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxhQUFhLENBQUMsaUJBQWlCLEVBQUU7WUFDbkYscUJBQXFCLEVBQUUsSUFBSTtTQUM1QixDQUFDLENBQUM7UUFDSCxPQUFPLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxVQUFVLENBQUMsS0FBSyxFQUFFLFVBQVUsQ0FBQyxNQUFNLENBQUMsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDbkYsQ0FBQztJQUNELE1BQU0sS0FBSyxHQUFHLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxFQUFFLEdBQUcsUUFBUSxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ3JFLE9BQU8sRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFVBQVUsQ0FBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLE1BQU0sQ0FBQyxFQUFFLFNBQVMsRUFBRSxLQUFLLEVBQUUsQ0FBQztBQUNwRixDQUFDLENBQUMifQ==

package/dist_ts/capture/request.d.ts

@@ -0,0 +1,69 @@
+import * as plugins from '../plugins.js';
+type IWccCaptureSubject = plugins.interfaces.IWccCaptureSubject;
+type TWccCaptureFraming = plugins.interfaces.TWccCaptureFraming;
+type TWccInteractionStep = plugins.interfaces.TWccInteractionStep;
+/** The limits every capture request is held to. */
+export declare const captureLimits: {
+    readonly minWidth: 200;
+    readonly maxWidth: 3840;
+    readonly minHeight: 200;
+    readonly maxHeight: 4320;
+    readonly defaultHeight: 800;
+    /** Full-page captures are cut at this height in CSS pixels. */
+    readonly maxFullPageHeight: 10000;
+    readonly defaultJpegQuality: 80;
+    readonly maxSteps: 20;
+    readonly stepTimeoutMs: 5000;
+    readonly maxWaitMs: 3000;
+    readonly defaultObserveMs: 500;
+    readonly maxObserveMs: 5000;
+    readonly defaultMaxFrames: 12;
+    readonly maxMaxFrames: 40;
+    readonly defaultFrameQuality: 70;
+    readonly maxSelectorLength: 500;
+    readonly maxTextLength: 2000;
+    readonly maxKeyLength: 32;
+    readonly maxSubjectLength: 200;
+};
+/** The capture widths of the named viewports: the dees-domtools breakpoints. */
+export declare const captureViewportWidths: Readonly<Record<plugins.interfaces.TWccCaptureViewportPreset, number>>;
+/** The preview set-up of a capture, validated and with its defaults applied. */
+export interface IWccResolvedView {
+    width: number;
+    height: number;
+    theme: plugins.interfaces.TWccTheme;
+    scale: 1 | 2;
+}
+export interface IWccResolvedImageOptions {
+    /** Undefined: the default framing of what the demo rendered. */
+    framing?: TWccCaptureFraming;
+    format: 'png' | 'jpeg';
+    /** JPEG quality; undefined for PNG. */
+    quality?: number;
+}
+export interface IWccResolvedScreenshotRequest {
+    subject: IWccCaptureSubject;
+    view: IWccResolvedView;
+    image: IWccResolvedImageOptions;
+}
+export interface IWccResolvedInteractionRequest {
+    subject: IWccCaptureSubject;
+    view: IWccResolvedView;
+    steps: TWccInteractionStep[];
+    observeMs: number;
+    maxFrames: number;
+    frameQuality: number;
+    finalScreenshot: IWccResolvedImageOptions | null;
+}
+/** Reads a viewport: a named one, or a width in CSS pixels. */
+export declare const resolveViewportWidth: (viewportArg: unknown) => number;
+/** Validates a screenshot request and applies its defaults. */
+export declare const resolveScreenshotRequest: (requestArg: plugins.interfaces.IWccScreenshotRequest) => IWccResolvedScreenshotRequest;
+/** Validates an interaction request and applies its defaults. */
+export declare const resolveInteractionRequest: (requestArg: plugins.interfaces.IWccInteractionRequest) => IWccResolvedInteractionRequest;
+/**
+ * Resolves a subject to one demo of the catalog: an entry named by its name or its element's tag,
+ * in the named section or, without one, in exactly one section.
+ */
+export declare const resolveSelection: (manifestArg: plugins.interfaces.IWccCatalogManifest, subjectArg: IWccCaptureSubject) => plugins.interfaces.IWccSelection;
+export {};

package/dist_ts/capture/request.js

@@ -0,0 +1,239 @@
+import * as plugins from '../plugins.js';
+import { WccCaptureRequestError } from './errors.js';
+/** The limits every capture request is held to. */
+export const captureLimits = {
+    minWidth: 200,
+    maxWidth: 3840,
+    minHeight: 200,
+    maxHeight: 4320,
+    defaultHeight: 800,
+    /** Full-page captures are cut at this height in CSS pixels. */
+    maxFullPageHeight: 10_000,
+    defaultJpegQuality: 80,
+    maxSteps: 20,
+    stepTimeoutMs: 5_000,
+    maxWaitMs: 3_000,
+    defaultObserveMs: 500,
+    maxObserveMs: 5_000,
+    defaultMaxFrames: 12,
+    maxMaxFrames: 40,
+    defaultFrameQuality: 70,
+    maxSelectorLength: 500,
+    maxTextLength: 2_000,
+    maxKeyLength: 32,
+    maxSubjectLength: 200,
+};
+/** The capture widths of the named viewports: the dees-domtools breakpoints. */
+export const captureViewportWidths = {
+    phone: plugins.deesDomtools.breakpoints.phone,
+    phablet: plugins.deesDomtools.breakpoints.phablet,
+    tablet: plugins.deesDomtools.breakpoints.tablet,
+    desktop: plugins.deesDomtools.breakpoints.desktop,
+};
+const isViewportPreset = (valueArg) => {
+    return typeof valueArg === 'string' && Object.hasOwn(captureViewportWidths, valueArg);
+};
+const framings = ['element', 'viewport', 'fullpage'];
+const isInteger = (valueArg) => typeof valueArg === 'number' && Number.isInteger(valueArg);
+const requireIntegerIn = (valueArg, minArg, maxArg, nameArg) => {
+    if (!isInteger(valueArg) || valueArg < minArg || valueArg > maxArg) {
+        throw new WccCaptureRequestError(`wcctools: ${nameArg} must be a whole number from ${minArg} to ${maxArg}.`);
+    }
+    return valueArg;
+};
+const requireText = (valueArg, maxLengthArg, nameArg, allowEmptyArg = false) => {
+    if (typeof valueArg !== 'string' || (!allowEmptyArg && valueArg.trim() === '') || valueArg.length > maxLengthArg) {
+        throw new WccCaptureRequestError(`wcctools: ${nameArg} must be ${allowEmptyArg ? 'a' : 'a non-empty'} string of at most ${maxLengthArg} characters.`);
+    }
+    return valueArg;
+};
+const resolveSubject = (subjectArg) => {
+    if (typeof subjectArg !== 'object' || subjectArg === null) {
+        throw new WccCaptureRequestError('wcctools: a capture needs a subject: the catalog entry to render.');
+    }
+    const subject = subjectArg;
+    const resolved = {
+        itemName: requireText(subject.itemName, captureLimits.maxSubjectLength, 'the subject\'s itemName'),
+        demoIndex: subject.demoIndex === undefined ? 0 : requireIntegerIn(subject.demoIndex, 0, 1_000, 'the demo index'),
+    };
+    if (subject.sectionName !== undefined) {
+        resolved.sectionName = requireText(subject.sectionName, captureLimits.maxSubjectLength, 'the subject\'s sectionName');
+    }
+    return resolved;
+};
+/** Reads a viewport: a named one, or a width in CSS pixels. */
+export const resolveViewportWidth = (viewportArg) => {
+    if (viewportArg === undefined) {
+        return captureViewportWidths.desktop;
+    }
+    if (isViewportPreset(viewportArg)) {
+        return captureViewportWidths[viewportArg];
+    }
+    if (isInteger(viewportArg)) {
+        return requireIntegerIn(viewportArg, captureLimits.minWidth, captureLimits.maxWidth, 'the viewport width');
+    }
+    throw new WccCaptureRequestError(`wcctools: the viewport must be one of ${Object.keys(captureViewportWidths).join(', ')} or a width from ${captureLimits.minWidth} to ${captureLimits.maxWidth}.`);
+};
+const resolveView = (requestArg) => {
+    const theme = requestArg.theme ?? 'dark';
+    if (theme !== 'dark' && theme !== 'bright') {
+        throw new WccCaptureRequestError('wcctools: the theme must be dark or bright.');
+    }
+    const scale = requestArg.scale ?? 1;
+    if (scale !== 1 && scale !== 2) {
+        throw new WccCaptureRequestError('wcctools: the scale must be 1 or 2.');
+    }
+    return {
+        width: resolveViewportWidth(requestArg.viewport),
+        height: requestArg.height === undefined
+            ? captureLimits.defaultHeight
+            : requireIntegerIn(requestArg.height, captureLimits.minHeight, captureLimits.maxHeight, 'the height'),
+        theme,
+        scale,
+    };
+};
+const resolveImageOptions = (optionsArg) => {
+    const framing = optionsArg.framing;
+    if (framing !== undefined && !framings.includes(framing)) {
+        throw new WccCaptureRequestError(`wcctools: the framing must be one of ${framings.join(', ')}.`);
+    }
+    const format = optionsArg.format ?? 'png';
+    if (format !== 'png' && format !== 'jpeg') {
+        throw new WccCaptureRequestError('wcctools: the format must be png or jpeg.');
+    }
+    if (format === 'png' && optionsArg.quality !== undefined) {
+        throw new WccCaptureRequestError('wcctools: a quality applies to jpeg only.');
+    }
+    return {
+        framing: framing,
+        format,
+        quality: format === 'jpeg'
+            ? (optionsArg.quality === undefined ? captureLimits.defaultJpegQuality : requireIntegerIn(optionsArg.quality, 1, 100, 'the quality'))
+            : undefined,
+    };
+};
+/** Validates a screenshot request and applies its defaults. */
+export const resolveScreenshotRequest = (requestArg) => {
+    if (typeof requestArg !== 'object' || requestArg === null) {
+        throw new WccCaptureRequestError('wcctools: the screenshot request is missing.');
+    }
+    return {
+        subject: resolveSubject(requestArg.subject),
+        view: resolveView(requestArg),
+        image: resolveImageOptions(requestArg),
+    };
+};
+const resolveStep = (stepArg, indexArg) => {
+    const name = `step ${indexArg}`;
+    if (typeof stepArg !== 'object' || stepArg === null) {
+        throw new WccCaptureRequestError(`wcctools: ${name} must be an object with an action.`);
+    }
+    const step = stepArg;
+    const selector = (requiredArg) => {
+        if (!requiredArg && step.selector === undefined) {
+            return undefined;
+        }
+        return requireText(step.selector, captureLimits.maxSelectorLength, `the selector of ${name}`);
+    };
+    switch (step.action) {
+        case 'click':
+        case 'hover':
+            return { action: step.action, selector: selector(true) };
+        case 'fill':
+            return {
+                action: 'fill',
+                selector: selector(true),
+                text: requireText(step.text, captureLimits.maxTextLength, `the text of ${name}`, true),
+            };
+        case 'press': {
+            const pressStep = {
+                action: 'press',
+                key: requireText(step.key, captureLimits.maxKeyLength, `the key of ${name}`),
+            };
+            const pressSelector = selector(false);
+            return pressSelector === undefined ? pressStep : { ...pressStep, selector: pressSelector };
+        }
+        case 'waitFor': {
+            const state = step.state ?? 'visible';
+            if (state !== 'visible' && state !== 'hidden') {
+                throw new WccCaptureRequestError(`wcctools: the state of ${name} must be visible or hidden.`);
+            }
+            return { action: 'waitFor', selector: selector(true), state };
+        }
+        case 'wait':
+            return { action: 'wait', ms: requireIntegerIn(step.ms, 0, captureLimits.maxWaitMs, `the time of ${name}`) };
+        default:
+            throw new WccCaptureRequestError(`wcctools: the action of ${name} must be one of click, hover, fill, press, waitFor, wait.`);
+    }
+};
+/** Validates an interaction request and applies its defaults. */
+export const resolveInteractionRequest = (requestArg) => {
+    if (typeof requestArg !== 'object' || requestArg === null) {
+        throw new WccCaptureRequestError('wcctools: the interaction request is missing.');
+    }
+    if (!Array.isArray(requestArg.steps) || requestArg.steps.length > captureLimits.maxSteps) {
+        throw new WccCaptureRequestError(`wcctools: an interaction has a list of at most ${captureLimits.maxSteps} steps.`);
+    }
+    if (requestArg.finalScreenshot !== undefined && (typeof requestArg.finalScreenshot !== 'object' || requestArg.finalScreenshot === null)) {
+        throw new WccCaptureRequestError('wcctools: finalScreenshot must be an object.');
+    }
+    return {
+        subject: resolveSubject(requestArg.subject),
+        view: resolveView(requestArg),
+        steps: requestArg.steps.map((stepArg, indexArg) => resolveStep(stepArg, indexArg)),
+        observeMs: requestArg.observeMs === undefined
+            ? captureLimits.defaultObserveMs
+            : requireIntegerIn(requestArg.observeMs, 0, captureLimits.maxObserveMs, 'observeMs'),
+        maxFrames: requestArg.maxFrames === undefined
+            ? captureLimits.defaultMaxFrames
+            : requireIntegerIn(requestArg.maxFrames, 1, captureLimits.maxMaxFrames, 'maxFrames'),
+        frameQuality: requestArg.frameQuality === undefined
+            ? captureLimits.defaultFrameQuality
+            : requireIntegerIn(requestArg.frameQuality, 1, 100, 'frameQuality'),
+        finalScreenshot: requestArg.finalScreenshot ? resolveImageOptions(requestArg.finalScreenshot) : null,
+    };
+};
+const describeEntry = (sectionNameArg, entryNameArg) => `${sectionNameArg}/${entryNameArg}`;
+const listSome = (namesArg) => {
+    const shown = namesArg.slice(0, 20).join(', ');
+    return namesArg.length > 20 ? `${shown}, … (${namesArg.length} in all)` : shown;
+};
+/**
+ * Resolves a subject to one demo of the catalog: an entry named by its name or its element's tag,
+ * in the named section or, without one, in exactly one section.
+ */
+export const resolveSelection = (manifestArg, subjectArg) => {
+    const sections = subjectArg.sectionName === undefined
+        ? manifestArg.sections
+        : manifestArg.sections.filter((sectionArg) => sectionArg.name === subjectArg.sectionName);
+    if (sections.length === 0) {
+        throw new WccCaptureRequestError(`wcctools: the catalog has no section "${subjectArg.sectionName}". Sections: ${listSome(manifestArg.sections.map((sectionArg) => sectionArg.name))}.`);
+    }
+    const wanted = subjectArg.itemName;
+    const matchesName = (entryArg) => {
+        return entryArg.name === wanted || (entryArg.tagName !== null && entryArg.tagName === wanted.toLowerCase());
+    };
+    const matches = sections.flatMap((sectionArg) => sectionArg.entries
+        .filter(matchesName)
+        .map((entryArg) => ({ section: sectionArg, entry: entryArg })));
+    if (matches.length === 0) {
+        const withoutDemo = sections.flatMap((sectionArg) => sectionArg.entriesWithoutDemo
+            .filter(matchesName)
+            .map((entryArg) => describeEntry(sectionArg.name, entryArg.name)));
+        if (withoutDemo.length > 0) {
+            throw new WccCaptureRequestError(`wcctools: ${listSome(withoutDemo)} has no demo to capture.`);
+        }
+        const known = sections.flatMap((sectionArg) => sectionArg.entries.map((entryArg) => describeEntry(sectionArg.name, entryArg.name)));
+        throw new WccCaptureRequestError(`wcctools: the catalog has no entry "${wanted}". Entries: ${listSome(known)}.`);
+    }
+    if (matches.length > 1) {
+        throw new WccCaptureRequestError(`wcctools: "${wanted}" names ${matches.length} entries (${listSome(matches.map((matchArg) => describeEntry(matchArg.section.name, matchArg.entry.name)))}); name its section.`);
+    }
+    const [{ section, entry }] = matches;
+    const demoIndex = subjectArg.demoIndex ?? 0;
+    if (demoIndex >= entry.demoCount) {
+        throw new WccCaptureRequestError(`wcctools: ${describeEntry(section.name, entry.name)} has ${entry.demoCount} demo${entry.demoCount === 1 ? '' : 's'}; demo ${demoIndex} does not exist (demos count from 0).`);
+    }
+    return { sectionName: section.name, itemName: entry.name, demoIndex };
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../ts/capture/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAMrD,mDAAmD;AACnD,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,QAAQ,EAAE,GAAG;IACb,QAAQ,EAAE,IAAI;IACd,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,IAAI;IACf,aAAa,EAAE,GAAG;IAClB,+DAA+D;IAC/D,iBAAiB,EAAE,MAAM;IACzB,kBAAkB,EAAE,EAAE;IACtB,QAAQ,EAAE,EAAE;IACZ,aAAa,EAAE,KAAK;IACpB,SAAS,EAAE,KAAK;IAChB,gBAAgB,EAAE,GAAG;IACrB,YAAY,EAAE,KAAK;IACnB,gBAAgB,EAAE,EAAE;IACpB,YAAY,EAAE,EAAE;IAChB,mBAAmB,EAAE,EAAE;IACvB,iBAAiB,EAAE,GAAG;IACtB,aAAa,EAAE,KAAK;IACpB,YAAY,EAAE,EAAE;IAChB,gBAAgB,EAAE,GAAG;CACb,CAAC;AAEX,gFAAgF;AAChF,MAAM,CAAC,MAAM,qBAAqB,GAA2E;IAC3G,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK;IAC7C,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO;IACjD,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM;IAC/C,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO;CAClD,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAiB,EAA4D,EAAE;IACvG,OAAO,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;AACxF,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAkC,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAkCpF,MAAM,SAAS,GAAG,CAAC,QAAiB,EAAsB,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAExH,MAAM,gBAAgB,GAAG,CAAC,QAAiB,EAAE,MAAc,EAAE,MAAc,EAAE,OAAe,EAAU,EAAE;IACtG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,MAAM,IAAI,QAAQ,GAAG,MAAM,EAAE,CAAC;QACnE,MAAM,IAAI,sBAAsB,CAAC,aAAa,OAAO,gCAAgC,MAAM,OAAO,MAAM,GAAG,CAAC,CAAC;IAC/G,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,QAAiB,EAAE,YAAoB,EAAE,OAAe,EAAE,aAAa,GAAG,KAAK,EAAU,EAAE;IAC9G,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,aAAa,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,YAAY,EAAE,CAAC;QACjH,MAAM,IAAI,sBAAsB,CAAC,aAAa,OAAO,YAAY,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,sBAAsB,YAAY,cAAc,CAAC,CAAC;IACxJ,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,UAAmB,EAAsB,EAAE;IACjE,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,sBAAsB,CAAC,mEAAmE,CAAC,CAAC;IACxG,CAAC;IACD,MAAM,OAAO,GAAG,UAAyC,CAAC;IAC1D,MAAM,QAAQ,GAAuB;QACnC,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,gBAAgB,EAAE,yBAAyB,CAAC;QAClG,SAAS,EAAE,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC;KACjH,CAAC;IACF,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACtC,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,gBAAgB,EAAE,4BAA4B,CAAC,CAAC;IACxH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,WAAoB,EAAU,EAAE;IACnE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IACD,IAAI,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;QAClC,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;QAC3B,OAAO,gBAAgB,CAAC,WAAW,EAAE,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAC7G,CAAC;IACD,MAAM,IAAI,sBAAsB,CAC9B,yCAAyC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,aAAa,CAAC,QAAQ,OAAO,aAAa,CAAC,QAAQ,GAAG,CACjK,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,UAA8C,EAAoB,EAAE;IACvF,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC;IACzC,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC3C,MAAM,IAAI,sBAAsB,CAAC,6CAA6C,CAAC,CAAC;IAClF,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC;IACpC,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO;QACL,KAAK,EAAE,oBAAoB,CAAC,UAAU,CAAC,QAAQ,CAAC;QAChD,MAAM,EAAE,UAAU,CAAC,MAAM,KAAK,SAAS;YACrC,CAAC,CAAC,aAAa,CAAC,aAAa;YAC7B,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC;QACvG,KAAK;QACL,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAC1B,UAAsE,EAC5C,EAAE;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IACnC,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAA6B,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,sBAAsB,CAAC,wCAAwC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnG,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,IAAI,KAAK,CAAC;IAC1C,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,sBAAsB,CAAC,2CAA2C,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,MAAM,KAAK,KAAK,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACzD,MAAM,IAAI,sBAAsB,CAAC,2CAA2C,CAAC,CAAC;IAChF,CAAC;IACD,OAAO;QACL,OAAO,EAAE,OAAyC;QAClD,MAAM;QACN,OAAO,EAAE,MAAM,KAAK,MAAM;YACxB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;YACrI,CAAC,CAAC,SAAS;KACd,CAAC;AACJ,CAAC,CAAC;AAEF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,UAAoD,EAAiC,EAAE;IAC9H,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,sBAAsB,CAAC,8CAA8C,CAAC,CAAC;IACnF,CAAC;IACD,OAAO;QACL,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC;QAC3C,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;QAC7B,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAAC;KACvC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,OAAgB,EAAE,QAAgB,EAAuB,EAAE;IAC9E,MAAM,IAAI,GAAG,QAAQ,QAAQ,EAAE,CAAC;IAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,sBAAsB,CAAC,aAAa,IAAI,oCAAoC,CAAC,CAAC;IAC1F,CAAC;IACD,MAAM,IAAI,GAAG,OAAkC,CAAC;IAChD,MAAM,QAAQ,GAAG,CAAC,WAAoB,EAAE,EAAE;QACxC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,iBAAiB,EAAE,mBAAmB,IAAI,EAAE,CAAC,CAAC;IAChG,CAAC,CAAC;IACF,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,KAAK,MAAM;YACT,OAAO;gBACL,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC;gBACxB,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,aAAa,EAAE,eAAe,IAAI,EAAE,EAAE,IAAI,CAAC;aACvF,CAAC;QACJ,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,SAAS,GAAwB;gBACrC,MAAM,EAAE,OAAO;gBACf,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,YAAY,EAAE,cAAc,IAAI,EAAE,CAAC;aAC7E,CAAC;YACF,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YACtC,OAAO,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;QAC7F,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,SAAS,CAAC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9C,MAAM,IAAI,sBAAsB,CAAC,0BAA0B,IAAI,6BAA6B,CAAC,CAAC;YAChG,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC;QAChE,CAAC;QACD,KAAK,MAAM;YACT,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,eAAe,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9G;YACE,MAAM,IAAI,sBAAsB,CAAC,2BAA2B,IAAI,2DAA2D,CAAC,CAAC;IACjI,CAAC;AACH,CAAC,CAAC;AAEF,iEAAiE;AACjE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,UAAqD,EAAkC,EAAE;IACjI,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,sBAAsB,CAAC,+CAA+C,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;QACzF,MAAM,IAAI,sBAAsB,CAAC,kDAAkD,aAAa,CAAC,QAAQ,SAAS,CAAC,CAAC;IACtH,CAAC;IACD,IAAI,UAAU,CAAC,eAAe,KAAK,SAAS,IAAI,CAAC,OAAO,UAAU,CAAC,eAAe,KAAK,QAAQ,IAAI,UAAU,CAAC,eAAe,KAAK,IAAI,CAAC,EAAE,CAAC;QACxI,MAAM,IAAI,sBAAsB,CAAC,8CAA8C,CAAC,CAAC;IACnF,CAAC;IACD,OAAO;QACL,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC;QAC3C,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;QAC7B,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAClF,SAAS,EAAE,UAAU,CAAC,SAAS,KAAK,SAAS;YAC3C,CAAC,CAAC,aAAa,CAAC,gBAAgB;YAChC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC;QACtF,SAAS,EAAE,UAAU,CAAC,SAAS,KAAK,SAAS;YAC3C,CAAC,CAAC,aAAa,CAAC,gBAAgB;YAChC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC;QACtF,YAAY,EAAE,UAAU,CAAC,YAAY,KAAK,SAAS;YACjD,CAAC,CAAC,aAAa,CAAC,mBAAmB;YACnC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,EAAE,cAAc,CAAC;QACrE,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;KACrG,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,cAAsB,EAAE,YAAoB,EAAE,EAAE,CAAC,GAAG,cAAc,IAAI,YAAY,EAAE,CAAC;AAE5G,MAAM,QAAQ,GAAG,CAAC,QAAkB,EAAU,EAAE;IAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,QAAQ,CAAC,MAAM,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;AAClF,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,WAAmD,EACnD,UAA8B,EACI,EAAE;IACpC,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,KAAK,SAAS;QACnD,CAAC,CAAC,WAAW,CAAC,QAAQ;QACtB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,CAAC,CAAC;IAC5F,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,sBAAsB,CAC9B,yCAAyC,UAAU,CAAC,WAAW,gBAAgB,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,CACtJ,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC;IACnC,MAAM,WAAW,GAAG,CAAC,QAAkD,EAAE,EAAE;QACzE,OAAO,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,IAAI,QAAQ,CAAC,OAAO,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9G,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO;SAChE,MAAM,CAAC,WAAW,CAAC;SACnB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,kBAAkB;aAC/E,MAAM,CAAC,WAAW,CAAC;aACnB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrE,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,sBAAsB,CAAC,aAAa,QAAQ,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC;QACjG,CAAC;QACD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpI,MAAM,IAAI,sBAAsB,CAAC,uCAAuC,MAAM,eAAe,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,sBAAsB,CAC9B,cAAc,MAAM,WAAW,OAAO,CAAC,MAAM,aAAa,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAC/K,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;IACrC,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,IAAI,CAAC,CAAC;IAC5C,IAAI,SAAS,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,sBAAsB,CAC9B,aAAa,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,SAAS,QAAQ,KAAK,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,UAAU,SAAS,uCAAuC,CAC9K,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;AACxE,CAAC,CAAC"}

package/dist_ts/classes.bundlestatus.d.ts

@@ -0,0 +1,36 @@
+import * as plugins from './plugins.js';
+/** The longest time a status request waits for a change before it answers the unchanged status. */
+export declare const bundleStatusWaitLimitMs = 25000;
+/** What a status request answers while the board is closed: the server is not serving. */
+export declare const bundleStatusClosedMessage = "wcctools: the dev server is not serving the bundle status.";
+/**
+ * The status of the catalog bundles, as tswatch's bundle events report it, for the shell's
+ * `getBundleStatus` requests. Every event raises the revision and answers the requests waiting for
+ * a change. While closed (the server is not serving), requests are refused with a typed error, so
+ * a client backs off as it does for any failed request.
+ */
+export declare class WccBundleStatusBoard {
+    private readonly bundles;
+    private revision;
+    private isOpen;
+    /** Settles one waiting request: answers the current snapshot, or refuses; each removes itself. */
+    private readonly waiters;
+    /** Starts a run of the server: the bundles of an earlier run are forgotten. */
+    open(): void;
+    /** Ends the run: every waiting request is refused now, later ones at once. */
+    close(): void;
+    /** The number of requests waiting for a change. */
+    getWaiterCount(): number;
+    record(eventArg: plugins.tswatch.TBundleEvent): void;
+    getSnapshot(): plugins.interfaces.IWccBundleStatusSnapshot;
+    /**
+     * The snapshot once it differs from `afterRevisionArg`, or after the wait limit; at once without
+     * a revision or for a revision that is no longer current. Refused while closed. When
+     * `abortSignalArg` aborts (the client went away), the wait ends at once and releases its timer;
+     * it answers the current snapshot, which the transport drops.
+     */
+    waitForChange(afterRevisionArg: number | undefined, abortSignalArg?: AbortSignal): Promise<plugins.interfaces.IWccBundleStatusSnapshot>;
+    private changed;
+    private answerWaiters;
+    private createClosedError;
+}