@webappwiz/arbor 0.0.28 → 0.0.30

package/worktree-service.d.ts

@@ -1,51 +0,0 @@
-import { type Fs, type Ps } from "webappwiz/system";
-import type { Config } from "./config.js";
-import type { Git, GitResult } from "./git.js";
-import { type TaskState, Worktree } from "./worktree.js";
-export interface AddOptions {
-    /** Branch the new worktree starts from. Defaults to the trunk. */
-    base?: string;
-}
-/**
- * Where tasks live and everything persistent about them: the worktree
- * directories, the records under `.git/arbor/tasks`, and the names of tasks
- * already removed. One name, one lookup, whatever state it turns out to be in.
- */
-/** What a `WorktreeService` works through; the real ones by default. */
-export interface WorktreeServiceOptions {
-    fs?: Fs;
-    ps?: Ps;
-}
-export declare class WorktreeService {
-    readonly git: Git;
-    readonly config: Config;
-    private readonly tasksDir;
-    private readonly removedDir;
-    private readonly fs;
-    readonly ps: Ps;
-    constructor(git: Git, config: Config, arborDir: string, opts?: WorktreeServiceOptions);
-    init(): Promise<void>;
-    get trunk(): string;
-    /** Where a task's worktree lives: a sibling of the repo, never inside it. */
-    pathFor(task: string): string;
-    branchFor(task: string): string;
-    taskFor(branch: string): string | null;
-    recordPath(task: string): string;
-    /** Always answers; the returned worktree's status says what was found. */
-    find(task: string): Promise<Worktree>;
-    list(): Promise<Worktree[]>;
-    /** Adds the branch and the working directory. The record comes after. */
-    add(task: string, { base }?: AddOptions): Promise<GitResult>;
-    discard(worktree: Worktree): Promise<GitResult>;
-    /** Writes a task's record. A concurrent reader sees the old one or the new. */
-    saveRecord(state: TaskState): Promise<void>;
-    private readRecord;
-    private removedPath;
-    private removedAt;
-    /**
-     * Remembers a removed name so a second `remove` can say "already removed"
-     * instead of "never existed", then drops the oldest so the list of
-     * remembered names cannot grow without bound.
-     */
-    private rememberRemoved;
-}

package/worktree.d.ts

@@ -1,95 +0,0 @@
-import type { GitResult } from "./git.js";
-import type { WorktreeService } from "./worktree-service.js";
-/** The status a task's own record carries. */
-export type RecordStatus = "working" | "merging" | "escalated";
-/** What a task's record stores about who is driving it. */
-export interface LeaseState {
-    pid: number;
-    hostname: string;
-    heartbeatAt: string;
-}
-export interface Escalation {
-    reason: string;
-    at: string;
-    /**
-     * For a task handed over to be approved rather than to answer questions,
-     * the question in its plan that asks for the approval, `4`.
-     */
-    review?: string;
-}
-export interface TaskState {
-    task: string;
-    branch: string;
-    worktree: string;
-    /** The branch this task lands on. Absent in old records: trunk. */
-    base?: string;
-    status: RecordStatus;
-    lease: LeaseState | null;
-    mergeAttempts: number;
-    createdAt: string;
-    updatedAt: string;
-    escalations?: Escalation[];
-}
-/**
- * Everything a name can turn out to be. The record's own status when the
- * task is intact, and otherwise the way in which it is not.
- */
-export type WorktreeStatus = RecordStatus | "absent" | "removed" | "orphaned" | "stray" | "unrecorded" | "unknown";
-/** What the service found on disk. */
-export interface WorktreeSnapshot {
-    task: string;
-    branch: string;
-    path: string;
-    state: TaskState | null;
-    exists: boolean;
-    hasBranch: boolean;
-    removedAt: string | null;
-    corrupt: boolean;
-}
-/**
- * One task, whether or not it is still there. Commands ask the service for
- * one of these and read its status rather than assembling the same handful of
- * existence checks themselves.
- */
-export declare class Worktree {
-    private readonly service;
-    private readonly snapshot;
-    constructor(service: WorktreeService, snapshot: WorktreeSnapshot);
-    get task(): string;
-    get branch(): string;
-    /** Where this task's work lands: its recorded base branch, else trunk. */
-    get base(): string;
-    get path(): string;
-    get state(): TaskState | null;
-    get lease(): LeaseState | null;
-    get leaseHeld(): boolean;
-    get leaseStatus(): "held" | "stale" | "none";
-    get leaseOurs(): boolean;
-    get leaseHeldByOther(): boolean;
-    get mergeAttempts(): number;
-    get exists(): boolean;
-    get hasBranch(): boolean;
-    get removedAt(): string | null;
-    get status(): WorktreeStatus;
-    get gone(): boolean;
-    /**
-     * Merges changes into the record and writes it. Works on a name that has no
-     * record yet, which is how `add` writes the first one and how `claim`
-     * rebuilds one from a worktree found on disk.
-     */
-    save(changes?: Partial<TaskState>): Promise<Worktree>;
-    take(changes?: Partial<TaskState>): Promise<Worktree>;
-    /** Re-reads from disk. `merge` needs this: the record is the truth. */
-    reload(): Promise<Worktree>;
-    /** Removes the directory, the branch, and the record; remembers the name. */
-    discard(): Promise<GitResult>;
-    commitsAhead(): Promise<number | null>;
-    diffStat(): Promise<{
-        added: number;
-        removed: number;
-    } | null>;
-    /** Committed and uncommitted paths this task touches; null without a branch. */
-    changedFiles(): Promise<string[] | null>;
-    uncommitted(): Promise<string[]>;
-    interruptedOps(): Promise<string[]>;
-}