@calliopelabs/ui 0.6.1 → 0.11.0

package/dist/provider/messages.d.ts

@@ -1,4 +1,19 @@
 import type { ProductTheme } from "../appearance/product.js";
+import type { WorkflowAction, WorkflowAvailability, WorkflowScope, WorkflowStatus } from "../workflow/model.js";
+import type { ArtifactStatus, GateStatus, ReviewDecision, ReviewVerdict, RunStageStatus } from "../workflow/run.js";
+import type { WorkflowConnectReason, WorkflowNode, WorkflowNodeKind, WorkflowSelector } from "../workflow/definition.js";
+/** The names a node's summary line uses, looked up by the caller. */
+export interface WorkflowSummaryNames {
+    /** A step's or variants' preset, and its module. */
+    preset?: string;
+    module?: string;
+    /** A gate's kind. */
+    gate?: string;
+    /** A go-to's target's label. */
+    target?: string;
+}
+import type { WorkflowProblem, WorkflowProblemLevel } from "../workflow/problems.js";
+import type { WorkflowReadError } from "../workflow/portable.js";
 /**
  * Every string the package renders, in English. An app with a message
  * catalog overrides any of them through `UIProvider messages={...}`; a
@@ -19,6 +34,10 @@ export interface Messages {
         expand: string;
         collapseTitle: string;
         expandTitle: string;
+        /** An icon-only row or area with a badge: its name and the badge's label, "Inbox, 3 unread". */
+        withBadge: (label: string, badge: string) => string;
+        /** A collapsed area whose rows carry badges, named before its flyout opens. */
+        areaWithBadges: (area: string) => string;
     };
     rail: {
         show: (label: string) => string;
@@ -72,6 +91,18 @@ export interface Messages {
         failed: string;
         reasonRequired: string;
     };
+    data: {
+        /** A Stat whose figure the server did not give: read in place of the dash. */
+        noValue: string;
+        /** A DefinitionList entry with no value. */
+        notSet: string;
+        /** A removable Tag's remove button. */
+        removeTag: (label: string) => string;
+    };
+    avatar: {
+        /** An AvatarStack read as one phrase: the names shown, then how many more. */
+        people: (names: readonly string[], more: number) => string;
+    };
     user: {
         /** The collapsed trigger's name: it shows only the initials, so the name starts with them (WCAG 2.5.3). */
         accountMenu: (name: string, initials: string) => string;
@@ -100,8 +131,390 @@ export interface Messages {
         customAccentHelp: string;
         customAccentInvalid: string;
         customAccentInUse: string;
-        customAccentOk: (ratio: string) => string;
-        customAccentFaint: (ratio: string, min: number, mode: "dark" | "light") => string;
+        /** `ground` is the ground's key, for a message that names it. */
+        customAccentOk: (ratio: string, ground: string) => string;
+        customAccentFaint: (ratio: string, min: number, mode: "dark" | "light", ground: string) => string;
+    };
+    workflow: {
+        status: (status: WorkflowStatus) => string;
+        scope: (scope: WorkflowScope) => string;
+        /** A module and the version a definition was written against: "Media 1.2". */
+        module: (label: string, version?: string) => string;
+        revision: (revision: string) => string;
+        /** An action's visible label. */
+        action: (action: WorkflowAction) => string;
+        /** An action's accessible name: its visible label first (WCAG 2.5.3), then the workflow. */
+        actionName: (label: string, name: string) => string;
+        /** The badge for a workflow this factory cannot run. */
+        availability: (status: WorkflowAvailability["status"]) => string;
+        unsupported: string;
+        missingCapabilities: (missing: readonly string[]) => string;
+        /** The actions the person's role does not allow, in one sentence. */
+        denied: (actions: readonly string[]) => string;
+        /** Names the host's preview. */
+        preview: (name: string) => string;
+        galleryTitle: string;
+        /** Names the gallery's search and filter region. */
+        filters: string;
+        search: string;
+        moduleFilter: string;
+        anyModule: string;
+        scopeFilter: string;
+        anyScope: string;
+        statusFilter: string;
+        anyStatus: string;
+        view: string;
+        grid: string;
+        list: string;
+        count: (count: number) => string;
+        create: string;
+        import: string;
+        loadFailed: string;
+        empty: string;
+        emptyDescription: string;
+        noMatches: string;
+        noMatchesDescription: string;
+        clearFilters: string;
+    };
+    editor: {
+        /** A node kind's name: "Step", "Sub-flow", "Go to". */
+        kind: (kind: WorkflowNodeKind) => string;
+        /** One line on what a kind does, for the palette. */
+        kindHint: (kind: WorkflowNodeKind) => string;
+        /** A fixed exit's name (`else`, `yes`, `no`, `other`, `pass`, `fail`, `out`); a case's or label's own words come through as they are. */
+        exit: (exit: string) => string;
+        selector: (selector: WorkflowSelector) => string;
+        problemLevel: (level: WorkflowProblemLevel) => string;
+        /** One problem, in a sentence. */
+        problem: (problem: WorkflowProblem) => string;
+        /** Why a connection was refused, for the live region. */
+        connect: (reason: WorkflowConnectReason, values: Record<string, string>) => string;
+        /** Why a definition or package could not be read. */
+        readError: (error: WorkflowReadError) => string;
+        canvas: string;
+        canvasTools: string;
+        add: string;
+        /** A palette group that is not a module. */
+        paletteGroup: (group: "gates" | "logic" | "judges" | "other") => string;
+        customStep: string;
+        connectAction: string;
+        connectTitle: (node: string) => string;
+        connectDescription: string;
+        connectFrom: string;
+        connectTo: string;
+        connectNone: string;
+        cancel: string;
+        deleteSelection: string;
+        arrange: string;
+        zoomIn: string;
+        zoomOut: string;
+        fit: string;
+        /** A node's accessible name: kind, label, then what is wrong. */
+        nodeName: (kind: string, label: string, blocking: number, warnings: number, notRun: boolean) => string;
+        /** An edge's accessible name. */
+        edgeName: (kind: "next" | "loop" | "data" | "goto", from: string, to: string, detail?: string) => string;
+        /** One line under a node's label saying what it is set to. */
+        summary: (node: WorkflowNode, names: WorkflowSummaryNames) => string;
+        notRun: string;
+        /** A loop's limit, on its edge. */
+        loopMax: (max?: number) => string;
+        /** A port, with its type. */
+        port: (label: string, type: string) => string;
+        loopHandle: string;
+        loopInHandle: string;
+        inHandle: string;
+        regionName: (kind: "loop" | "branches", head: string, count: number) => string;
+        fold: (name: string) => string;
+        unfold: (name: string) => string;
+        showInPlace: (label: string) => string;
+        hideInPlace: (label: string) => string;
+        readOnly: string;
+        /** The live region, after an edit or a refusal. */
+        connected: (from: string, to: string) => string;
+        added: (label: string) => string;
+        deleted: (count: number) => string;
+        selected: (name: string) => string;
+        /** How to work a focused node and edge with the keyboard. */
+        nodeHelp: string;
+        edgeHelp: string;
+        movedLive: (direction: string, x: number, y: number) => string;
+        palette: string;
+        paletteSearch: string;
+        paletteEmpty: string;
+        problems: string;
+        noProblems: string;
+        problemCount: (level: WorkflowProblemLevel, count: number) => string;
+        json: string;
+        jsonHint: string;
+        inspector: string;
+        inspectorFor: (kind: string, label: string) => string;
+        inspectorEmpty: string;
+        workflowDetails: string;
+        name: string;
+        description: string;
+        runInputs: string;
+        label: string;
+        nodeId: (id: string) => string;
+        note: string;
+        choose: string;
+        hostDefault: string;
+        preset: string;
+        noPreset: string;
+        model: string;
+        harness: string;
+        effort: string;
+        inputs: string;
+        outputs: string;
+        optional: string;
+        addPort: string;
+        newPort: string;
+        portLabel: string;
+        portType: string;
+        anyType: string;
+        remove: (label: string) => string;
+        subflow: string;
+        each: string;
+        eachHint: string;
+        gateKind: string;
+        approvers: string;
+        roles: string;
+        members: string;
+        quorum: string;
+        quorumHint: string;
+        timeoutHours: string;
+        onTimeout: string;
+        onTimeoutOption: (option: "fail" | "escalate") => string;
+        threshold: string;
+        rule: string;
+        cases: string;
+        caseLabel: string;
+        addCase: string;
+        newCase: (n: number) => string;
+        when: (label: string) => string;
+        fact: string;
+        factNode: string;
+        operator: string;
+        value: string;
+        boolean: (value: boolean) => string;
+        target: string;
+        limit: string;
+        wait: string;
+        waitOption: (wait: "all" | "any" | "n") => string;
+        waitN: string;
+        winner: string;
+        evaluator: string;
+        variants: string;
+        addVariant: string;
+        newVariant: (n: number) => string;
+        variantLabel: string;
+        question: string;
+        levels: string;
+        levelsHint: string;
+        routes: string;
+        minConfidence: string;
+        minConfidenceHint: string;
+        options: string;
+        addOption: string;
+        newOption: (n: number) => string;
+        optionLabel: string;
+        optionDescription: string;
+        otherExit: string;
+        yesAt: string;
+        exitIs: (exit: string) => string;
+        edgeLabel: string;
+        dataFlow: (output: string, input: string) => string;
+        until: string;
+        deleteNode: (label: string) => string;
+        deleteEdge: string;
+    };
+    workspace: {
+        loading: string;
+        loadFailed: string;
+        actions: string;
+        panels: string;
+        paletteRegion: string;
+        problemsTab: (count: number) => string;
+        jsonTab: string;
+        flow: string;
+        unsaved: string;
+        saved: (label?: string) => string;
+        live: (label?: string) => string;
+        differsFromLive: (label?: string) => string;
+        notPublished: string;
+        conflict: string;
+        conflictDescription: (by?: string, label?: string) => string;
+        compare: string;
+        compareTitle: string;
+        compareDescription: string;
+        useTheirs: string;
+        keepMine: string;
+        save: string;
+        saving: string;
+        savedNotice: string;
+        saveAs: string;
+        saveAsTitle: string;
+        saveAsDescription: string;
+        copyName: (name: string) => string;
+        savedAsNotice: (name: string) => string;
+        publish: string;
+        publishing: string;
+        publishTitle: string;
+        publishDescription: (label?: string) => string;
+        firstPublish: string;
+        draftAgainstLive: string;
+        publishBlocked: (count: number) => string;
+        publishedNotice: string;
+        failed: string;
+        discard: string;
+        discardTitle: string;
+        discardDescription: string;
+        export: string;
+        import: string;
+        importTitle: string;
+        importDescription: string;
+        importAction: string;
+        importing: string;
+        importedNotice: string;
+        importAvailability: (status: WorkflowAvailability["status"]) => string;
+        modules: string;
+        noModules: string;
+        moduleStatus: (status: "available" | "missing" | "version" | "unavailable", installed?: string) => string;
+        missingCapabilities: string;
+        unknownVocabulary: string;
+        unknownGateKind: (id: string) => string;
+        unknownFact: (id: string) => string;
+        unknownOperator: (id: string) => string;
+        disabledNodes: (count: number) => string;
+        needsApprovers: string;
+        importBlocking: (count: number) => string;
+        replaces: string;
+        diff: string;
+        noChanges: string;
+        onlyMoved: (count: number) => string;
+        moved: (count: number) => string;
+        change: (change: "added" | "removed" | "changed", what: string) => string;
+        details: string;
+        detail: (key: "name" | "description" | "module" | "main") => string;
+        flows: string;
+        nodes: string;
+        connections: string;
+    };
+    run: {
+        /** The timeline's default name. */
+        timeline: string;
+        loadFailed: (label: string) => string;
+        noStages: string;
+        noStagesDescription: string;
+        stageStatus: (status: RunStageStatus) => string;
+        /** "Attempt 2 of 3", or "Attempt 2" without a limit. */
+        attempt: (attempt: number, max?: number) => string;
+        startedAt: (time: string) => string;
+        duration: (duration: string) => string;
+        /** The disclosure for a stage's values. */
+        inputsOutputs: (inputs: number, outputs: number) => string;
+        inputs: string;
+        outputs: string;
+        none: string;
+        /** A gate in one phrase: what it asks, where it stands, the quorum. */
+        gate: (label: string, status: GateStatus, approvals?: number, required?: number) => string;
+        artifacts: string;
+        noArtifacts: string;
+        noArtifactsDescription: string;
+        artifactStatus: (status: ArtifactStatus) => string;
+        version: (version: string) => string;
+        producedBy: (stage: string) => string;
+    };
+    review: {
+        title: string;
+        titleFor: (subject: string) => string;
+        verdict: (verdict: ReviewVerdict) => string;
+        /** The closing decision's line: who decided what, when. */
+        decided: (verdict: ReviewDecision["verdict"], by?: string, at?: string) => string;
+        approve: string;
+        reject: string;
+        approveTitle: string;
+        approveDescription: string;
+        rejectTitle: string;
+        rejectDescription: string;
+        reasonLabel: string;
+        comments: (count: number) => string;
+        noComments: string;
+        addComment: string;
+        post: string;
+        commentOn: (anchor: string) => string;
+        clearAnchor: string;
+        /** A comment's anchor as a button: its visible anchor first (WCAG 2.5.3). */
+        goToAnchor: (anchor: string) => string;
+        resolved: string;
+    };
+    media: {
+        /** Names the rail of timecoded comments. */
+        markers: string;
+        /** A timeline marker's name: the timecode first, then who wrote it. */
+        timeComment: (timecode: string, author: string) => string;
+        /** A region box's name. */
+        regionComment: (author: string, timecode?: string) => string;
+        commentHere: string;
+        drawHint: string;
+        count: (count: number) => string;
+        /** Starts the keyboard path: drops a box to move and size before commenting on it. */
+        markRegion: string;
+        /** Names the box being placed. */
+        regionBox: string;
+        /** How to move, size, confirm and cancel the box from the keyboard. */
+        regionHelp: string;
+        /** The box's bounds in whole percent of the picture. */
+        regionBounds: (left: number, top: number, width: number, height: number) => string;
+        confirmRegion: string;
+        cancel: string;
+    };
+    document: {
+        changes: (count: number) => string;
+        annotations: (count: number) => string;
+        /** Names the page navigation. */
+        pages: string;
+        previousPage: string;
+        nextPage: string;
+        pageOf: (page: number, total: number) => string;
+        /** A block's anchor in words, for a comment: "p. 3, 4.2". */
+        anchor: (page: number, clause?: string) => string;
+        /** A clause reference as a button: the visible reference first. */
+        commentOnClause: (clause: string) => string;
+        commentOnBlock: (anchor: string) => string;
+        /** Read in place of a redline's colour and strike. */
+        inserted: (text: string) => string;
+        deleted: (text: string) => string;
+        annotationBy: (author: string, anchor: string) => string;
+        empty: string;
+        signOff: string;
+        signOffAction: string;
+        signOffStatus: (status: "pending" | "signed" | "declined") => string;
+        signOffTitle: (title: string) => string;
+        signOffDescription: (role?: string) => string;
+    };
+    form: {
+        source: string;
+        /** Names the source page switcher. */
+        sourcePage: string;
+        page: (page: number) => string;
+        fields: string;
+        /** A field's box on the source page. */
+        fieldOnSource: (label: string) => string;
+        /** Progress: confirmed of all, and how many low-confidence fields remain. */
+        progress: (done: number, total: number, flagged: number) => string;
+        /** Confidence from 0 to 1, in words. */
+        confidence: (confidence: number) => string;
+        status: (status: "accepted" | "corrected") => string;
+        accept: string;
+        correct: string;
+        /** An action's accessible name: its visible label first, then the field. */
+        actionName: (label: string, field: string) => string;
+        correctLabel: (label: string) => string;
+        extracted: (value: string) => string;
+        save: string;
+        cancel: string;
+        /** A field extraction found nothing in. */
+        empty: string;
     };
 }
 export declare const defaultMessages: Messages;