@osdlc/repo-cleaner 0.17.2 → 0.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdlc/repo-cleaner",
-  "version": "0.17.2",
+  "version": "0.19.0",
   "description": "What has been merged into the default branch, and what can go away. Inventories local branches, worktrees and remote branches across one repository or many, classifying each with the evidence behind the verdict and the command that would act on it. Plans and applies approved deletes, compare-and-swap.",
   "license": "MIT OR Apache-2.0",
   "author": "sksizer",
@@ -50,11 +50,11 @@
   "dependencies": {
     "zod": "^4.6.6",
     "@osdlc/cli-tool": "^0.17.0",
-    "@osdlc/command-seam": "^0.14.0",
     "@osdlc/path-guard": "^0.3.1",
-    "@osdlc/typed-gh": "^0.16.0",
-    "@osdlc/typed-git": "^0.12.0",
-    "@osdlc/ux": "^0.1.1"
+    "@osdlc/typed-gh": "^0.16.1",
+    "@osdlc/command-seam": "^0.14.0",
+    "@osdlc/ux": "^0.1.1",
+    "@osdlc/typed-git": "^0.13.0"
   },
   "devDependencies": {
     "@types/node": "^26.1.0",

package/dist/apply.d.ts

@@ -1,131 +0,0 @@
-/**
- * Apply an approved cleanup plan.
- *
- * Re-sweeps each repository and drops selected rows that are gone, no longer
- * deletable, changed, or lack a grant. Deletes the rest in a fixed order and
- * stops at the first failure:
- *
- * 1. worktrees, each unlocked first when its lock's owner is dead, and each
- *    checked again for live processes just before it is unlocked or removed;
- * 2. local branches;
- * 3. remote branches;
- * 4. one prune per repository.
- *
- * Branch deletes are compare-and-swap on the planned sha. Every step is
- * verified, and the receipt is rewritten after each.
- */
-import { type CommandRunner } from '@osdlc/command-seam';
-import type { HostHooks } from './hooks.ts';
-import { type ProcessProbe } from './processes.ts';
-import { type Plan } from './plan.ts';
-import { type Dropped, type Receipt, type RowRef, type Step } from './receipt.ts';
-import { type Authorization, type SweepItem, type SweepProgress } from './types.ts';
-/** An authorization the caller gave, for one row or (`row: null`) for all. */
-export interface Grant {
-    name: Authorization;
-    row: RowRef | null;
-}
-export interface ApplyOptions extends HostHooks {
-    /** Injected runners. Defaults spawn the real `git`, `gh` and `glab`. */
-    git?: CommandRunner | undefined;
-    gh?: CommandRunner | undefined;
-    glab?: CommandRunner | undefined;
-    /**
-     * Answers lock-owner and working-directory questions, for the re-sweep and
-     * for the checks just before an unlock and a remove. Defaults to `ps` and
-     * `lsof`.
-     */
-    probe?: ProcessProbe | undefined;
-    /** The caller's directory; the sweep never offers the worktree holding it. */
-    callerCwd: string;
-    dryRun: boolean;
-    /** Where the receipt is written after each step; null writes none. Unused under `dryRun`. */
-    receiptPath: string | null;
-    /** Where the plan came from, shown in the receipt. */
-    planPath: string;
-    /** Limit the run to the plan repository rooted here. */
-    repoRoot?: string | undefined;
-    now?: () => Date;
-    /**
-     * Drop each selected row the re-check does not judge `safe-to-delete`.
-     * Defaults to true when no rows are requested, so a row to review runs only
-     * when it is named. Pass it to keep that guard on a run whose rows came
-     * from such a selection, such as the run a preview confirmed.
-     */
-    safeOnly?: boolean | undefined;
-    /**
-     * Items to re-check against instead of sweeping again, keyed by repository
-     * root, already annotated: the hook is not applied to them again, though
-     * `holdFreedBranches` is, so a freed branch matches its worktree. For a
-     * preview straight after a sweep; the run that deletes should always sweep
-     * again.
-     */
-    swept?: ReadonlyMap<string, readonly SweepItem[]> | undefined;
-    /** Rows dropped before this run, such as by a preview; recorded first in the receipt. */
-    dropped?: readonly Dropped[] | undefined;
-    /**
-     * Remote branch rows to keep: not deleted, but checked. Each must be a
-     * `remote_branch` row of the plan; its id is `<remote>/<branch>`, as in the
-     * plan, e.g. `origin/topic`. The re-check refuses the run with
-     * {@link ApplyRefused} when a kept branch is gone or its tip is not the
-     * planned one, and the run's first steps check each tip again with
-     * `ls-remote`, so a branch that moves after the re-check stops the run
-     * before anything is deleted. A kept row cannot also be selected.
-     */
-    keep?: readonly RowSelection[] | undefined;
-    /**
-     * Fetch each repository's remote before the re-sweep. Defaults to what the
-     * plan repository records in `fetch`: a plan swept after a fetch is
-     * re-checked after one. Remote branch tips are read live either way; the
-     * fetch moves the default branch those tips and the local refs are judged
-     * against. A failed fetch fails the run before any step.
-     */
-    fetch?: boolean | undefined;
-    /** Passed to the re-sweep's `onProgress`, for a status line. */
-    onSweepProgress?: ((progress: SweepProgress) => void) | undefined;
-    /**
-     * Told once the steps are planned, before the first runs, with the list
-     * itself: each step's `result` is updated in place as the run goes. Not
-     * called under `dryRun`.
-     */
-    onStart?: ((steps: readonly Step[]) => void) | undefined;
-    /** Told before each step runs: its 0-based index, the step count and the step. Not called under `dryRun`. */
-    onStep?: ((index: number, total: number, step: Step) => void) | undefined;
-    /** Told after each step, with its `result` set (`ok`, or `failed` and the run stops), before the receipt is saved. Not called under `dryRun`. */
-    onStepDone?: ((index: number, total: number, step: Step) => void) | undefined;
-}
-/** A selection or grant the plan cannot satisfy. Nothing has been touched. */
-export declare class ApplyArgumentError extends Error {
-}
-/** A kept row is gone or moved since the plan, so the run refuses. Nothing has been touched. */
-export declare class ApplyRefused extends Error {
-}
-/** `<category>:<id>`, split at the first colon. */
-export declare function parseRowRef(text: string): RowRef;
-/** `<name>` for every row, or `<name>=<category>:<id>` for one. */
-export declare function parseGrant(text: string): Grant;
-/**
- * A row to apply, optionally pinned to the plan repository rooted at `repo`.
- * Without `repo`, a row id that two plan repositories share is ambiguous.
- */
-export type RowSelection = RowRef & {
-    repo?: string;
-};
-/**
- * A network URL as `host[:port]/path`, the same for `git@host:o/r.git`,
- * `ssh://git@host/o/r` and `https://host/o/r/`; the whole path is kept, so
- * nested groups stay apart. Null for a path on this machine, including
- * `file://` and a Windows drive path.
- */
-export declare function networkRemoteKey(url: string): string | null;
-/**
- * Apply the `requested` rows of `plan` under `grants`. An empty `requested`
- * selects every row of the plan (of `repoRoot`'s repository, when given) and
- * then drops each one the re-sweep does not judge `safe-to-delete`: a row to
- * review runs only when it is named. A row named twice runs once. A row whose
- * `requires` was not granted is dropped, never run.
- *
- * @throws ApplyArgumentError before touching anything, when a row or grant does
- *   not fit the plan.
- */
-export declare function applyPlan(plan: Plan, requested: readonly RowSelection[], grants: readonly Grant[], opts: ApplyOptions): Receipt;