@asrunjs/asrun 0.0.0-stage → 0.2.0

package/dist/ui/shared/types.d.ts

@@ -0,0 +1,257 @@
+import type { ResultStatus } from '../../lib/run-summary.js';
+import type { AiCommand, AiTool } from './ai-commands.js';
+export type JobStatus = 'running' | 'succeeded' | 'failed' | 'cancelled';
+export type JobKind = 'signin' | 'visit' | 'run' | 'ai';
+/** What changed on disk: case files (`cases/**`) and/or specs (`tests/**`). */
+export interface FilesChange {
+    cases: boolean;
+    specs: boolean;
+}
+export interface JobInfo {
+    id: string;
+    kind: JobKind;
+    /** Set for `signin` and `visit` jobs. */
+    profile?: string;
+    /** Environment of the job (`signin`, `visit` and `run`). */
+    env?: string;
+    /** Human-readable command, e.g. `pnpm signin example-staging`. */
+    command: string;
+    status: JobStatus;
+    exitCode: number | null;
+    signal: string | null;
+    startedAt: string;
+    endedAt: string | null;
+    /** The process reads stdin (used by `signin`, which waits for Enter). */
+    acceptsInput: boolean;
+    /** Set for a test run that overwrote the screenshot baselines of these cases. */
+    baselineCases?: string[];
+    /** Set for a test run: the folder under reports/ it writes (it may only exist once the run has produced one). */
+    reportId?: string;
+    /** Set for the one-shot runs of an AI command on a case. */
+    caseId?: string;
+    /** Set for the one-shot runs of an AI command on a case: which command ran. */
+    aiCommand?: AiCommand;
+    /** The conversation of an AI run; a later job can resume it. */
+    sessionId?: string;
+    /** What the agent said in its last `RESULT:` line; null when it did not say or the run did not succeed. */
+    resultState?: ResultState | null;
+    /** The earlier job whose conversation this job continues. */
+    continuesJobId?: string;
+    /** An AI run that has handed a step to the person in the browser window and waits for them to press Done. */
+    awaitingUser?: AwaitingUserInfo | null;
+}
+export interface AwaitingUserInfo {
+    /** What the person is asked to do, as the agent wrote it on the card; null when unknown. */
+    message: string | null;
+    since: string;
+}
+/** `needs-input`: the agent wrote open questions into the case file and cannot go on without answers. */
+export type ResultState = 'ready' | 'needs-input';
+export interface JobChunk {
+    seq: number;
+    stream: 'stdout' | 'stderr' | 'system';
+    data: string;
+}
+export type StartJobRequest = {
+    action: 'signin';
+    profile: string;
+    env: string;
+} | {
+    action: 'visit';
+    profile: string;
+    env: string;
+} | {
+    action: 'ai';
+    tool: AiTool;
+    command: AiCommand;
+    caseId: string;
+    env: string;
+    force?: boolean;
+    attended?: boolean;
+    /** `heal-spec` only: the profiles to heal; omitted = every profile that is logged in. */
+    profiles?: string[];
+    /** `heal-spec` only: what the user knows (optional). The server stores it as a file for the agent. */
+    hints?: string;
+    /** `heal-spec` only: the report to read first (folder name under reports/); omitted = the newest one. */
+    report?: string;
+} | {
+    action: 'continue';
+    jobId: string;
+    reply: string;
+} | {
+    action: 'make-cases';
+    tool: AiTool;
+    memo: string;
+} | {
+    action: 'run';
+    env: string;
+    profiles?: string[];
+    /** Only the profiles that carry one of these tags. */
+    tags?: string[];
+    suites?: string[];
+    grep?: string;
+    stepText?: boolean;
+    /** Leave out the cases that write data. */
+    readOnly?: boolean;
+    /** Cases (ids) whose screenshot baselines are overwritten with what the page shows now (`--update-baselines`). */
+    updateBaselines?: string[];
+    /** The environment the user confirmed write cases for. Must equal `env`; checked again on the server. */
+    confirmWritesIn?: string;
+};
+/** A case that writes data and would run, as listed in the confirmation. */
+export interface WriteCaseInfo {
+    id: string;
+    note: string;
+    profiles: string[];
+}
+export interface RunPreviewRequest {
+    env: string;
+    profiles?: string[];
+    tags?: string[];
+    suites?: string[];
+    grep?: string;
+    readOnly?: boolean;
+}
+export interface RunPreview {
+    env: string;
+    /** True when the environment is protected and the run includes write cases: the user must confirm. */
+    needsConfirmation: boolean;
+    writeCases: WriteCaseInfo[];
+    /** Cases that write only in other environments; they are skipped in this run. */
+    skippedWriteCases: WriteCaseInfo[];
+}
+export interface PlannedCaseInfo {
+    id: string;
+    profiles: string[];
+    writes: boolean;
+    /** Why the case is skipped in this environment; null when it runs. */
+    skip: string | null;
+    /** How many baseline images the case has on disk (all profiles and environments). */
+    baselineCount: number;
+}
+/** One screenshot baseline, with what it must show (from the target card of the case). */
+export interface BaselineItem {
+    caseId: string;
+    file: string;
+    profile: string | null;
+    env: string | null;
+    /** New or modified in git. */
+    changed: boolean;
+    mtimeMs: number;
+    targetId: string | null;
+    card: {
+        id: string;
+        name: string;
+        what: string | null;
+        where: string | null;
+        not: string | null;
+        pages: string | null;
+        region: string | null;
+    } | null;
+    problem: string | null;
+}
+/** The cases a run with the chosen filters would list. */
+export interface RunPlan {
+    env: string;
+    /** Playwright could not list the tests (for example an invalid search expression). */
+    error: string | null;
+    /** Cases that run (skipped ones not counted). */
+    totalCases: number;
+    /** Case x profile combinations that run. */
+    totalTests: number;
+    cases: PlannedCaseInfo[];
+}
+export type ProfileStatus = 'missing' | 'unverified' | 'ok' | 'expired' | 'error';
+/** One profile: a row of the Profiles page. */
+export interface ProfileInfo {
+    id: string;
+    name: string;
+    env: string;
+    baseURL: string;
+    account: string | null;
+    tags: string[];
+    status: ProfileStatus;
+    verifying: boolean;
+    /** When the session file was last written. */
+    savedAt: string | null;
+    checkedAt: string | null;
+    error?: string;
+}
+export interface AddProfileRequest {
+    id: string;
+    name: string;
+    /** The environment this profile points at, e.g. `production`, `staging`. */
+    env: string;
+    baseURL: string;
+    /** A label for humans (a mailbox or username). Never a password. */
+    account?: string;
+    tags?: string[];
+    /** Page that redirects to /login when logged out. Defaults to /account/. */
+    sessionCheckPath?: string;
+    /** Only for environments other than production. Defaults to false. */
+    email?: boolean;
+}
+export interface ProfilesResponse {
+    profiles: ProfileInfo[];
+    /** Every environment used in profiles.yaml, `production` first. */
+    envs: string[];
+    verifying: boolean;
+}
+export interface CaseSummary {
+    /** Path below `cases/` without `.md`, e.g. `documents/landing-page`. */
+    id: string;
+    /** The folder of the case (`documents`), `null` for a case directly in `cases/`. */
+    group: string | null;
+    title: string | null;
+    login: string | null;
+    suites: string[];
+    /** Environments the case may write in; empty = read-only. */
+    writes: string[];
+    writesNote: string | null;
+    /** Environments the case may run in; null = all. */
+    envs: string[] | null;
+    /** Set when the front matter is invalid; the case is still listed so it can be fixed. */
+    problem: string | null;
+    hasSpec: boolean;
+    updatedAt: string;
+}
+export interface CaseDetail {
+    id: string;
+    content: string;
+    mtimeMs: number;
+}
+/** The spec of a case. */
+export interface SpecDetail {
+    id: string;
+    /** Path relative to the project root, for display. */
+    file: string;
+    /** Absolute path, to paste into a terminal. */
+    path: string;
+    content: string;
+    mtimeMs: number;
+}
+export interface ReportInfo {
+    /** Folder name under reports/. */
+    id: string;
+    /** Environment the run targeted; null for runs from before environments existed (those were production). */
+    env: string | null;
+    createdAt: string;
+    isLatest: boolean;
+    /** Pass/fail counts; null for runs from before summaries existed. */
+    counts: Record<ResultStatus, number> | null;
+}
+export type { ParsedError, ResultStatus, RunSettings, RunSummary, TestRunResult } from '../../lib/run-summary.js';
+export interface InfoResponse {
+    root: string;
+    envs: string[];
+    suites: string[];
+    caseIds: string[];
+}
+/** Everything that belongs to one case. Shown before a delete or rename, and returned by them. */
+export interface CaseImpact {
+    id: string;
+    caseFile: string;
+    specFile: string | null;
+    snapshotDir: string | null;
+    snapshotCount: number;
+}

package/dist/ui/shared/types.js

@@ -0,0 +1 @@
+export {};