@ethlete/cli 3.0.0-next.26 → 3.0.0-next.28

package/src/lib/design/system/actions-command.d.ts

@@ -0,0 +1,108 @@
+import { NoVerdict } from './no-verdict';
+import { DesignConfig, DesignPreset } from '../design-config';
+import { Browser } from '../thumb';
+import { ActionInput } from './actions';
+import { checkLiveActions } from './live-actions';
+import { StartHarnessServer } from './harness-server';
+import { ResolvedProduct } from './resolve-product';
+export declare const ACTIONS_USAGE = "actions <layer>/<name> --product <name> [--url <app dev server url>] [--state <name>] | actions [<layer>/<name>] --product <name> --live [--url <app build url>]";
+/** A state the check starts from: its harness props, and the trigger a click opens first when the state is an open surface. */
+export type ActionStart = {
+    state: string;
+    props: unknown;
+    opener: string | null;
+};
+type Line = {
+    state: string;
+    element: string;
+    input: ActionInput | null;
+    failure: string | null;
+    warning?: string | null;
+};
+/**
+ * Loads the harness page of `start`, clicks its opener, then presses `input` on the element `pick` names and returns
+ * the outputs it fired, whether its keydown default was prevented, and the host shot when `shoot` asks for one. The
+ * outputs include those of the components under the `listen` selectors; `expanded` adds each element's
+ * `aria-expanded` after the press. The wait for outputs ends as soon as `output` fired or the page settled.
+ */
+export declare const runActionInput: (options: {
+    browser: Browser;
+    url: string;
+    start: ActionStart;
+    pick: {
+        key: string;
+        occurrence: number;
+    };
+    input: ActionInput;
+    size: DesignPreset | null;
+    shoot: {
+        room: boolean;
+    } | null;
+    timeout: number;
+    listen?: string[];
+    expanded?: boolean;
+    output?: string | null;
+    focused?: boolean;
+}) => Promise<{
+    after?: {
+        key: string;
+        expanded: string | null;
+    }[] | undefined;
+    emitted: string[];
+    prevented: boolean;
+    app: Buffer<ArrayBufferLike> | null;
+}>;
+/** Presses each interactive element of each start state of a part on the app's harness page and checks its declared action. */
+export declare const checkActions: (options: {
+    target: string;
+    config: DesignConfig;
+    product: ResolvedProduct;
+    part: string;
+    url: string;
+    only: string | null;
+    onLine?: (line: Line) => void;
+    appRoot?: string | null;
+    /** Settles once another run has drawn the design pictures into the shared store, so this check reads them instead of drawing them twice. */
+    designsDrawn?: Promise<unknown>;
+}) => Promise<{
+    lines: Line[];
+    pictures: string | null;
+    embedders?: string[];
+    hosts?: string[];
+} | string>;
+/** The line `design actions` prints for one checked element and input. */
+export declare const actionLineOf: ({ state, element, input, failure, warning }: Line) => string;
+/** The line the action check prints once per run for a declared host component it skipped in a state. */
+export declare const hostLineOf: (host: string) => string;
+/** The line the action check prints for a part it skips because no app component renders it in the harness. */
+export declare const unlinkedSkipLineOf: (part: string) => string;
+/** The failed lines `design actions` prints for a part, or why the check could not run (`[]` for a part without an implements link); with `harness` it checks the part harness at that URL instead of starting one. */
+export declare const partActionFailuresOf: (options: {
+    target: string;
+    config: DesignConfig;
+    product: ResolvedProduct;
+    part: string;
+    url?: string;
+    harness?: string;
+    start?: StartHarnessServer;
+    check?: typeof checkActions;
+    checkLive?: typeof checkLiveActions;
+    onNote?: (line: string) => void;
+    appRoot?: string | null;
+    designsDrawn?: Promise<unknown>;
+}) => Promise<string[] | NoVerdict>;
+/** The note a ready refusal adds when the action check ran on the part harness only. */
+export declare const PART_HARNESS_ONLY = "checked on the part harness only - pass --url <studio build> to check the live pages too";
+/**
+ * `et design actions <layer>/<name> …` clicks and presses Enter and Space on each interactive element of a part in the
+ * app's harness page and fails unless each reaches the state or fires the output its design's `data-et-action` declares.
+ */
+export declare const designActions: (options: {
+    target: string;
+    argv: string[];
+    invocation: string;
+    check?: typeof checkActions;
+    checkLive?: typeof checkLiveActions;
+    start?: StartHarnessServer;
+}) => Promise<0 | 1 | 2>;
+export {};