prae-cli 0.1.0

package/lib/index.d.ts

@@ -0,0 +1,61 @@
+import { PreflightFinding } from "dsh-overlay-check";
+
+//#region src/cli.d.ts
+
+/**
+ * The PRAE command line.
+ *
+ * Four verbs, and the one that writes defaults to not writing. `init` prints
+ * the diff and stops unless `--apply` is passed, because the thing it edits is
+ * the file that decides whether the harness boots at all.
+ */
+declare function main(argv: string[]): Promise<void>;
+//#endregion
+//#region src/profile.d.ts
+
+interface Profile {
+  /** The directory holding `cordis.yml`, e.g. `~/.dsh/profiles/web`. */
+  readonly dir: string;
+  readonly patchPath: string;
+}
+/** Where dsh keeps its home, honouring the same env var the CLI does. */
+declare function dshHome(): string;
+declare function profileAt(dir: string): Profile;
+/** The default profile, unless a caller names one. */
+declare function defaultProfile(name?: string): Profile;
+/**
+ * The overlay row that mounts PRAE with a policy.
+ *
+ * The pack is embedded rather than referenced by path. A row pointing at a
+ * file that later moves or changes is a policy nobody can reconstruct from the
+ * profile alone, and the whole point of this plugin is being able to say what
+ * was in force at the time.
+ */
+declare function praeRow(options: {
+  readonly pack: string;
+  readonly ledger?: string;
+  readonly approver?: string;
+}): string;
+interface WritePlan {
+  readonly patchPath: string;
+  readonly before: string;
+  readonly after: string;
+  readonly revision: string;
+  readonly findings: readonly PreflightFinding[];
+  readonly blocking: boolean;
+}
+/** Compose the write and check it, without touching the file. */
+declare function planWrite(profile: Profile, row: string): Promise<WritePlan>;
+/**
+ * Apply a plan, snapshotting first.
+ *
+ * `expectedRevision` is a precondition rather than a formality: between
+ * previewing and applying, the user may have edited the file, and writing over
+ * an edit they made after reviewing our diff would hand them a profile nobody
+ * chose.
+ */
+declare function applyWrite(profile: Profile, plan: WritePlan, expectedRevision: string): Promise<{
+  readonly snapshot: string;
+}>;
+//#endregion
+export { type Profile, type WritePlan, applyWrite, defaultProfile, dshHome, main, planWrite, praeRow, profileAt };

package/lib/index.js

@@ -0,0 +1,3 @@
+import { a as planWrite, i as dshHome, n as applyWrite, o as praeRow, r as defaultProfile, s as profileAt, t as main } from "./cli-DGVWMDT0.js";
+
+export { applyWrite, defaultProfile, dshHome, main, planWrite, praeRow, profileAt };