mockpit 1.3.0 → 3.0.0

package/dist/server/types.d.ts

@@ -1,4 +1,4 @@
-import type { Palette } from "./themes.ts";
+import type { Mode, Palette } from "./themes.ts";
 export interface Session {
     id: string;
     agent: string;
@@ -68,6 +68,8 @@ export interface HtmlSurface {
     kind: "html";
     html: string;
     kits?: string[];
+    poster?: string;
+    posterMode?: Mode;
 }
 export interface MarkdownSurface {
     kind: "markdown";
@@ -196,10 +198,22 @@ export interface PadValue {
     y: number;
 }
 export type KnobValue = number | boolean | string | PadValue | SpringKnob | EasingKnob;
-export type MockKind = "page" | "component";
-export type PostStatus = "open" | "accepted" | "archived" | "dropped";
-export declare const isLive: (status: PostStatus) => boolean;
+export type DesignKind = "screen" | "component" | "idea";
+export declare const isDesignKind: (k: unknown) => k is DesignKind;
+export type PostStatus = "open" | "accepted" | "archived";
+export type VariantStatus = "open" | "inUse" | "archived";
+export declare const variantStatus: (status: PostStatus) => VariantStatus;
+export declare const isLive: (status: PostStatus | VariantStatus) => boolean;
 export declare const inUseVersion: (post: Pick<Post, "status" | "version" | "acceptedVersion">) => number;
+type VersionLine = Pick<Post, "status" | "version" | "acceptedVersion" | "hiddenVersions" | "stayedVersion"> & {
+    history: {
+        version: number;
+    }[];
+};
+export declare const newestVisible: (post: VersionLine) => number;
+export declare const currentVersion: (post: VersionLine) => number;
+export declare const changedTo: (post: VersionLine) => number | undefined;
+export declare const recommendedVariant: (asks: Pick<Ask, "state" | "options">[], state: string | null) => string | undefined;
 export declare function postAtVersion(post: Post, version: number): Post | null;
 export declare function versionAt(post: Pick<Post, "version" | "history">, n: number): number;
 export interface AskOption {
@@ -208,34 +222,68 @@ export interface AskOption {
     variant?: string;
     version?: number;
     set?: Record<string, KnobValue>;
+    recommended?: true;
+}
+export interface AnswerAddition {
+    knob: string;
+    value: string;
+    style?: string;
+    fill?: string;
 }
 export type AskAnswer = string | string[];
-export declare const optionState: (ask: Pick<Ask, "state">, mock: {
+export interface HiddenAnswer {
+    id: string;
+    label: string;
+    why?: string;
+}
+export interface AnswerStanding {
+    kept: string[];
+    hidden: HiddenAnswer[];
+    carried?: string[];
+    since?: Record<string, string>;
+    unsent?: true;
+}
+export interface AnswerSet {
+    name: string;
+    answers: Record<string, AskAnswer>;
+    at: string;
+}
+export declare const optionState: (ask: Pick<Ask, "state">, design: {
     states: string[];
 }) => string | null;
 export interface Ask {
     id: string;
     text: string;
-    scope: "mock" | "state" | "part";
+    scope: "design" | "state" | "part";
     state?: string;
+    states?: string[];
     part?: string;
     options: AskOption[];
     multi?: boolean;
     after?: string;
     answer?: AskAnswer;
     other?: string;
-    note?: string;
+    comment?: string;
     otherImages?: string[];
-    noteImages?: string[];
+    commentImages?: string[];
     dismissed?: true;
     at: string;
 }
 export declare const OTHER_ID = "other";
+export interface ParagraphAnchor {
+    surface: number;
+    index: number;
+    kind: string;
+    text: string;
+}
+export declare const PARAGRAPH_TEXT_MAX = 600;
+export declare const PARAGRAPHS_MAX = 500;
 export interface PartCommentAnchor {
     offset?: [number, number];
     quote?: string;
     selector?: string;
     box?: number[];
+    paragraph?: ParagraphAnchor;
     width?: number;
 }
 export declare const REACTIONS: readonly ["up", "down", "more"];
@@ -247,9 +295,14 @@ export interface PartComment {
     anchor?: PartCommentAnchor;
     reaction?: Reaction;
     variant?: string;
+    version?: number;
+    borrow?: {
+        from: string;
+        part?: string;
+    };
 }
-export interface ReplyDecision {
-    kind: "accept" | "revise" | "drop";
+export interface ReplyVerdict {
+    kind: "use" | "revise";
     state: string | null;
     variant: string;
     version?: number;
@@ -257,45 +310,84 @@ export interface ReplyDecision {
 export interface Draft {
     version: number;
     answers: Record<string, AskAnswer>;
-    mix: Record<string, string>;
+    borrowed: Record<string, string>;
     tuned: Record<string, KnobValue>;
     comments: PartComment[];
     others?: Record<string, string>;
-    notes?: Record<string, string>;
+    askComments?: Record<string, string>;
     otherImages?: Record<string, string[]>;
-    noteImages?: Record<string, string[]>;
+    askCommentImages?: Record<string, string[]>;
     updatedAt: string;
 }
 export interface Reply {
-    mockId: string;
+    designId: string;
     version: number;
     answers: Record<string, AskAnswer>;
-    mix: Record<string, string>;
+    borrowed: Record<string, string>;
     tuned: Record<string, KnobValue>;
     comments: PartComment[];
     others?: Record<string, string>;
-    notes?: Record<string, string>;
+    askComments?: Record<string, string>;
     otherImages?: Record<string, string[]>;
-    noteImages?: Record<string, string[]>;
+    askCommentImages?: Record<string, string[]>;
     text?: string;
-    decision?: ReplyDecision;
-    resolved?: {
+    routed?: true;
+    more?: {
+        ask: string;
+        note?: string;
+        like?: string;
+    };
+    standings?: Record<string, AnswerStanding>;
+    update?: {
+        ask: string;
+        option: string;
+    };
+    set?: string;
+    verdict?: ReplyVerdict;
+    archived?: {
         dismissed: string[];
     };
+    edited?: DesignEdit;
+}
+export interface DesignEdit {
+    kind?: DesignKind;
+    area?: string | null;
+    notes?: string | null;
 }
-export interface Mock {
+export declare const AREA_ORDER_SETTING = "areaOrder";
+export declare const DECISION_EDITS_SETTING = "decisions";
+export interface DesignNotes {
+    text: string;
+    by: "agent" | "user";
+    at: string;
+}
+export declare const MAX_NOTES = 4000;
+export type StateOutline = "dismissed" | "requested";
+export declare const isPlanned: (design: {
+    kind: DesignKind;
+}, variants: number) => boolean;
+export interface Design {
     id: string;
     project: string;
     slug: string;
     title: string;
-    kind: MockKind;
+    kind: DesignKind;
+    area: string | null;
+    source: string | null;
     states: string[];
     asks: Ask[];
     knobs: Knobs;
     widths: number[];
     draft: Draft | null;
     sessionId: string | null;
-    resolvedAt: string | null;
+    shortlist: boolean;
+    archivedAt: string | null;
+    archiveReason: string | null;
+    notes: DesignNotes | null;
+    stateOutlines: Record<string, StateOutline>;
+    answerAdditions: AnswerAddition[];
+    standings: Record<string, AnswerStanding>;
+    sets: AnswerSet[];
     createdAt: string;
     updatedAt: string;
 }
@@ -313,15 +405,23 @@ export interface PostVersion {
     from?: number;
     prompt?: string;
     author?: string;
+    publishedBy?: string;
+    amendedAt?: string;
 }
 export interface ForkRef {
     variant: string;
     version: number;
 }
+export interface CopyRef {
+    design: string;
+    state: string | null;
+    variant: string;
+    version: number;
+}
 export interface Post {
     id: string;
     sessionId: string;
-    mock: string;
+    design: string;
     state: string | null;
     variant: string;
     status: PostStatus;
@@ -332,18 +432,24 @@ export interface Post {
     version: number;
     history: PostVersion[];
     knobs?: Knobs;
-    note?: string;
+    description?: string;
     embeds: Embed[];
     forkedFrom?: ForkRef;
-    starred?: true;
+    copiedFrom?: CopyRef;
     acceptedVersion?: number;
     hiddenVersions?: number[];
+    archiveReason?: string;
+    archivedAt?: string;
+    stayedVersion?: number;
     from?: number;
     prompt?: string;
     author?: string;
+    publishedBy?: string;
+    amendedAt?: string;
+    rewrites?: number;
 }
 export interface FlowStep {
-    mock: string;
+    design: string;
     state: string | null;
 }
 export interface Flow {
@@ -354,14 +460,36 @@ export interface Flow {
     updatedAt: string;
 }
 export declare const sameScreen: (a: FlowStep, b: FlowStep) => boolean;
+export interface JumpRows {
+    designs: {
+        id: string;
+        project: string;
+        slug: string;
+        title: string;
+        kind: DesignKind;
+        area: string | null;
+        states: string[];
+        asks: Ask[];
+        widths: number[];
+        archivedAt: string | null;
+        updatedAt: string;
+    }[];
+    variants: {
+        designId: string;
+        state: string | null;
+        variant: string;
+        description: string | null;
+        status: PostStatus;
+    }[];
+}
 export interface ProjectSummary {
     name: string;
-    mocks: number;
+    designs: number;
     open: number;
     lastActiveAt: string;
     sessions: number;
 }
-export interface DesignSettings {
+export interface DesignSystem {
     detected: {
         tailwind: boolean;
         shadcn: boolean;
@@ -463,7 +591,7 @@ export interface Comment {
     id: string;
     seq: number;
     sessionId: string;
-    mockId: string | null;
+    designId: string | null;
     postId: string | null;
     author: string;
     text: string;
@@ -501,55 +629,70 @@ export interface CreateSessionInput {
     project?: string;
     key?: string;
 }
-export interface CreateMockInput {
+export interface CreateDesignInput {
     project: string;
     slug: string;
     title?: string;
-    kind?: MockKind;
+    kind?: DesignKind;
+    area?: string | null;
+    source?: string | null;
     states?: string[];
     knobs?: Knobs;
     widths?: number[];
     sessionId?: string | null;
+    shortlist?: boolean;
 }
-export interface UpdateMockInput {
+export interface UpdateDesignInput {
     title?: string;
-    kind?: MockKind;
+    kind?: DesignKind;
+    area?: string | null;
+    source?: string | null;
     states?: string[];
     asks?: Ask[];
     knobs?: Knobs;
     widths?: number[];
     sessionId?: string | null;
-    resolvedAt?: string | null;
+    archivedAt?: string | null;
+    archiveReason?: string | null;
+    notes?: DesignNotes | null;
+    stateOutlines?: Record<string, StateOutline>;
+    answerAdditions?: AnswerAddition[];
+    standings?: Record<string, AnswerStanding>;
+    sets?: AnswerSet[];
 }
 export interface CreatePostInput {
     sessionId: string;
-    mock: string;
+    design: string;
     state: string | null;
     variant?: string;
     title?: string;
     surfaces: Surface[];
     knobs?: Knobs;
-    note?: string;
+    description?: string;
     embeds?: Embed[];
     forkedFrom?: ForkRef;
+    copiedFrom?: CopyRef;
     from?: number;
     prompt?: string;
     author?: string;
+    publishedBy?: string;
 }
 export interface UpdatePostInput {
     title?: string;
     surfaces?: Surface[];
     knobs?: Knobs | null;
-    note?: string;
+    description?: string;
     embeds?: Embed[];
     from?: number;
     prompt?: string;
     author?: string;
     state?: string | null;
+    publishedBy?: string;
 }
+export type AmendPostInput = Omit<UpdatePostInput, "state" | "publishedBy">;
 export interface CreateCommentInput {
     sessionId: string;
-    mockId?: string | null;
+    designId?: string | null;
     postId?: string | null;
     author: string;
     text: string;
@@ -562,12 +705,24 @@ export interface CreateCommentInput {
 }
 export interface CommentQuery {
     sessionId?: string;
-    mockId?: string;
+    designId?: string;
     postId?: string;
     afterSeq?: number;
 }
+export interface DecisionVariant {
+    designId: string;
+    state: string | null;
+    variant: string;
+    status: PostStatus;
+    version: number;
+    acceptedVersion: number | null;
+}
+export interface DecisionSources {
+    variants: DecisionVariant[];
+    decidedAt: Record<string, string>;
+}
 export interface CommitReplyInput {
-    mockId: string;
+    designId: string;
     sessionId: string;
     text: string;
     payload: Reply;
@@ -577,12 +732,13 @@ export interface CommitReplyInput {
         version: number;
     }[];
     archive: string[];
-    drop?: string[];
-    resolvedAt?: string;
+    release?: string[];
+    standings?: Record<string, AnswerStanding>;
     keepDraft?: true;
+    owner?: string;
 }
 export interface PostQuery {
-    mockId?: string;
+    designId?: string;
     sessionId?: string;
 }
 export interface Store {
@@ -598,25 +754,42 @@ export interface Store {
     getSetting(key: string): Promise<string | null>;
     setSetting(key: string, value: string): Promise<void>;
     listProjects(): Promise<ProjectSummary[]>;
-    listMocks(project?: string): Promise<Mock[]>;
-    getMock(id: string): Promise<Mock | null>;
-    findMock(project: string, slug: string): Promise<Mock | null>;
-    createMock(input: CreateMockInput): Promise<Mock>;
-    updateMock(id: string, patch: UpdateMockInput): Promise<Mock | null>;
-    removeMock(id: string): Promise<boolean>;
+    listJumpRows(): Promise<JumpRows>;
+    listDesigns(project?: string): Promise<Design[]>;
+    getDesign(id: string): Promise<Design | null>;
+    findDesign(project: string, slug: string): Promise<Design | null>;
+    createDesign(input: CreateDesignInput): Promise<Design>;
+    updateDesign(id: string, patch: UpdateDesignInput): Promise<Design | null>;
+    removeDesign(id: string): Promise<boolean>;
+    renameDesign(id: string, slug: string): Promise<Design | null>;
+    nameFirstState(id: string, state: string): Promise<Design | null>;
+    renameProject(from: string, to: string): Promise<boolean>;
     listFlows(project: string): Promise<Flow[]>;
     placeFlowStep(project: string, name: string, screen: FlowStep, step: number): Promise<Flow | null>;
-    putDraft(mockId: string, draft: Draft | null): Promise<Mock | null>;
+    putDraft(designId: string, draft: Draft | null): Promise<Design | null>;
     listPosts(query?: PostQuery): Promise<Post[]>;
+    listPostHeads(project?: string): Promise<PostHead[]>;
+    listCopies(project: string): Promise<LiveCopy[]>;
     countPostsBySession(): Promise<Map<string, number>>;
     getPost(id: string): Promise<Post | null>;
-    findPost(mockId: string, state: string | null, variant: string): Promise<Post | null>;
+    setForkedFrom(id: string, from: ForkRef | null): Promise<Post | null>;
+    findPost(designId: string, state: string | null, variant: string): Promise<Post | null>;
     createPost(input: CreatePostInput): Promise<Post | null>;
     updatePost(id: string, patch: UpdatePostInput): Promise<Post | null>;
     removePost(id: string): Promise<boolean>;
+    amendPost(id: string, version: number, patch: AmendPostInput): Promise<Post | null>;
+    setPosterOnce(id: string, version: number, poster: string, mode?: Mode): Promise<boolean>;
+    withdrawVersion(id: string, version: number, embeds: Embed[]): Promise<{
+        post: Post | null;
+    } | null>;
     setPostStatus(id: string, status: PostStatus, acceptedVersion?: number): Promise<Post | null>;
-    setPostStarred(id: string, starred: boolean): Promise<Post | null>;
+    bumpRewrites(designId: string): Promise<void>;
+    setPostArchived(id: string, archivedAt: string, reason: string | null): Promise<Post | null>;
     setVersionHidden(id: string, version: number, hidden: boolean): Promise<Post | null>;
+    deleteOldVersions(id: string, versions: number[]): Promise<Post | null>;
+    setPostReason(id: string, reason: string | null): Promise<Post | null>;
+    setPostStayed(id: string, version: number): Promise<Post | null>;
+    listDecisionSources(project: string): Promise<DecisionSources>;
     listComments(query: CommentQuery): Promise<Comment[]>;
     createComment(input: CreateCommentInput): Promise<Comment | null>;
     removeComment(id: string): Promise<Comment | null>;
@@ -637,6 +810,25 @@ export interface SqlStorage {
     exec(query: string, ...bindings: SqlStorageValue[]): SqlStorageCursor;
     transactionSync?<T>(fn: () => T): T;
 }
+export interface SurfaceHead {
+    kind: Surface["kind"];
+    poster?: string;
+    posterMode?: Mode;
+    marked?: boolean;
+}
+export type PostHead = Omit<Post, "surfaces" | "history"> & {
+    surfaces: SurfaceHead[];
+    history: {
+        version: number;
+        surfaces: SurfaceHead[];
+    }[];
+};
+export interface LiveCopy {
+    design: string;
+    state: string | null;
+    variant: string;
+    copiedFrom: CopyRef;
+}
 export declare const HISTORY_LIMIT = 20;
 export declare function reservedAgent(name: string): string;
 export declare function stripNul<T extends string | null | undefined>(s: T): T;
@@ -652,28 +844,18 @@ export declare const DEFAULT_VARIANT = "default";
 export declare function slugify(input: string): string;
 export declare function projectFromCwd(cwd: string | null | undefined): string | null;
 export declare const htmlSurface: (html: string, kits?: unknown) => HtmlSurface;
-export declare const askAnswered: (a: Pick<Ask, "answer" | "other" | "note">) => boolean;
-export declare const openAsks: (mock: Pick<Mock, "asks">) => Ask[];
-export declare function builtinAskIds(mock: Pick<Mock, "asks" | "states"> & {
-    resolvedAt?: string | null;
-}, posts: Pick<Post, "mock" | "state" | "variant" | "status">[], mockId: string): string[];
-export declare const builtinAskCount: (mock: Pick<Mock, "asks" | "states"> & {
-    resolvedAt?: string | null;
-}, posts: Pick<Post, "mock" | "state" | "variant" | "status">[], mockId: string) => number;
-export declare const openCount: (mock: Pick<Mock, "id" | "asks" | "states"> & {
-    resolvedAt?: string | null;
-}, posts: Pick<Post, "mock" | "state" | "variant" | "status">[]) => number;
-export declare function draftedCount(mock: Pick<Mock, "id" | "asks" | "states" | "draft"> & {
-    resolvedAt?: string | null;
-}, posts: Pick<Post, "mock" | "state" | "variant" | "status">[]): number | null;
+export declare const askAnswered: (a: Pick<Ask, "answer" | "other" | "comment">) => boolean;
+export declare const openAsks: (design: Pick<Design, "asks">) => Ask[];
+export declare const openCount: (design: Pick<Design, "asks">) => number;
+export declare function draftedCount(design: Pick<Design, "asks" | "draft">): number | null;
 export declare const BUILTIN_ASK_ID = "variant";
-export declare function builtinAsk(mock: Pick<Mock, "states">, posts: Pick<Post, "state" | "variant">[], id: string): Ask | undefined;
-export declare function summarizeProjects(mocks: Mock[], sessions: Session[], posts?: Post[]): ProjectSummary[];
+export declare function builtinAsk(design: Pick<Design, "states">, posts: Pick<Post, "state" | "variant">[], id: string): Ask | undefined;
+export declare function summarizeProjects(designs: Design[], sessions: Session[]): ProjectSummary[];
 export declare function surfacesByteLength(surfaces: Surface[]): number;
 export declare function collectAssetIds(surfaces: Surface[], out: Set<string>): void;
 export declare function collectAttachedIds(holder: {
     otherImages?: unknown;
-    noteImages?: unknown;
+    askCommentImages?: unknown;
 } | null | undefined, out: Set<string>): void;
 export interface EvictionCandidate {
     id: string;
@@ -682,3 +864,4 @@ export interface EvictionCandidate {
     referenced: boolean;
 }
 export declare function selectEvictions(candidates: EvictionCandidate[], incomingBytes: number, budget: number): string[];
+export {};