@rehearsal-db/core 0.1.0-beta.9 → 0.1.0-rc.2

package/dist/src/cli/renderers.d.mts

@@ -0,0 +1,299 @@
+/**
+ * Human-readable CLI output. These functions are intentionally pure so the
+ * command and guided workflow modules can focus on orchestration.
+ */
+import type { SourceAccessPlan } from "../source/access.mjs";
+import type { IdentityClaimPlan } from "../identity/claim.mjs";
+type Verbosity = "normal" | "verbose";
+type RenderFlags = Readonly<{
+    plain?: boolean;
+    json?: boolean;
+}>;
+type RenderMode = "preview" | "written";
+interface RenderMigration {
+    readonly filename: string;
+    readonly sha256: string;
+    readonly status?: string;
+}
+interface RenderEnvironment {
+    readonly kind: string;
+    readonly hostedAccess: string;
+    readonly outboundNetwork: string;
+    readonly authenticationProviders: readonly string[];
+    readonly authenticationCallback: string | null;
+    readonly barriers: readonly string[];
+}
+interface RenderBaselineSummary {
+    readonly generationId: string;
+    readonly tableCount: number;
+    readonly rowCount: number;
+    readonly verification: string;
+}
+interface RenderMigrationSummary {
+    readonly candidates: readonly RenderMigration[];
+    readonly candidateSha256: string;
+    readonly candidateCount: number;
+    readonly representedCount: number;
+}
+interface RenderSinglePlan {
+    readonly environment: RenderEnvironment;
+    readonly baseline: RenderBaselineSummary;
+    readonly migrations: RenderMigrationSummary;
+    readonly execution: readonly string[];
+    readonly guarantee: string;
+}
+interface RenderStackTarget {
+    readonly name: string;
+    readonly plan: {
+        readonly config: {
+            readonly project: string;
+        };
+        readonly environment: RenderEnvironment;
+        readonly baseline: RenderBaselineSummary;
+        readonly migrations: Pick<RenderMigrationSummary, "candidates">;
+    };
+}
+interface RenderStackPlan {
+    readonly targets: readonly RenderStackTarget[];
+    readonly migrations: Pick<RenderMigrationSummary, "candidateSha256" | "candidateCount">;
+    readonly execution: readonly string[];
+    readonly guarantee: string;
+}
+interface ReadinessCheck {
+    readonly id: string;
+    readonly label: string;
+    readonly status: "pass" | "fail";
+    readonly detail: string;
+    readonly remediation?: string;
+}
+interface ReadinessReport {
+    readonly state: string;
+    readonly checks: readonly ReadinessCheck[];
+    readonly ambientHostedVariables?: {
+        readonly presentButQuarantined: readonly string[];
+    };
+}
+interface RenderTable {
+    readonly name: string;
+    readonly rowCount: number;
+    readonly columns: readonly string[];
+}
+interface CandidateSummary {
+    readonly baselineGenerationId: string;
+    readonly candidates: readonly RenderMigration[];
+    readonly candidateSha256: string;
+    readonly candidateCount: number;
+    readonly targets?: readonly {
+        readonly name: string;
+        readonly baselineGenerationId: string;
+        readonly candidates: readonly RenderMigration[];
+    }[];
+}
+interface CleanupImage {
+    readonly bytes: number;
+    readonly tags: readonly string[];
+}
+interface CleanupTargetPlan {
+    readonly project: string;
+    readonly projectId: string;
+    readonly baselines: {
+        readonly available: boolean;
+        readonly removed: readonly string[];
+        readonly retained: readonly string[];
+    };
+    readonly runtime: {
+        readonly included: boolean;
+        readonly detected: boolean;
+    };
+    readonly images: {
+        readonly requested: boolean;
+        readonly inspected: boolean;
+        readonly candidates: readonly CleanupImage[];
+    };
+}
+interface AppliedCleanup {
+    readonly baselines: {
+        readonly removed: readonly string[];
+    };
+    readonly runtimeRemoved: boolean;
+    readonly imagesRemoved: readonly string[];
+}
+interface CleanupResult {
+    readonly mode: RenderMode;
+    readonly plan: (CleanupTargetPlan & {
+        readonly digest: string;
+        readonly docker: {
+            readonly resources: readonly unknown[];
+            readonly disk: {
+                readonly usedBytes: number;
+                readonly totalBytes: number;
+                readonly availableBytes: number;
+                readonly usedPercent: number;
+            } | null;
+        };
+    }) | {
+        readonly targets: readonly {
+            readonly name: string;
+            readonly plan: CleanupTargetPlan;
+        }[];
+        readonly digest: string;
+    };
+    readonly applied?: AppliedCleanup | {
+        readonly targets: readonly {
+            readonly name: string;
+            readonly applied: AppliedCleanup;
+        }[];
+    };
+}
+interface RefreshPlan {
+    readonly digest: string;
+    readonly review: {
+        readonly currentBaseline: string;
+        readonly source: {
+            readonly readerExpiresAt: string;
+        };
+        readonly runtimeTargets: readonly string[];
+        readonly retention: {
+            readonly generations: number;
+            readonly removeAfterReplacement: readonly string[];
+        };
+        readonly steps: readonly string[];
+    };
+}
+interface SourceRetirementPlan {
+    readonly digest: string;
+    readonly review: {
+        readonly targetFingerprint: string;
+        readonly readerRole: string;
+        readonly exportSchema: string;
+        readonly accessMode: "managed" | "external";
+        readonly views: readonly string[];
+    };
+}
+export declare const renderPlan: (plan: RenderSinglePlan | RenderStackPlan, verbosity: Verbosity) => string;
+export declare const renderDoctor: (doctor: ReadinessReport, verbosity: Verbosity) => string;
+export declare const renderBaseline: (baseline: {
+    rehearsalVersion: string;
+    generationId: string;
+    createdAt?: string | null;
+    formatVersion: number;
+    tableCount: number;
+    rowCount: number;
+    migrationCount: number;
+    migrationCutoff: string;
+    dataSha256: string;
+    sanitizationPolicySha256: string;
+    verification: string;
+}) => string;
+export declare const renderMigrations: (inspection: {
+    baselineGenerationId: string;
+    baselineCutoff: string;
+    candidateSha256: string;
+    migrations: readonly (RenderMigration & {
+        status: string;
+    })[];
+}, verbosity: Verbosity) => string;
+export declare const renderCandidates: (summary: CandidateSummary, verbosity: Verbosity) => string;
+export declare const renderInit: (result: {
+    mode: RenderMode;
+    destination: string;
+    detected: {
+        packageManager: string;
+        hasSupabaseConfig: boolean;
+        hasMigrations: boolean;
+    };
+    availableOptions?: readonly {
+        path: string;
+        summary: string;
+    }[];
+    source?: string | null;
+    nextAction: string;
+}) => string;
+export declare const renderSetup: (result: {
+    mode: RenderMode;
+    project: string;
+    configurationPath: string;
+    configurationAction: "create" | "update" | "unchanged";
+    rootConfigGenerationSkipped?: boolean;
+    target: "postgresql" | "supabase";
+    projectId: string;
+    applicationUrl: string;
+    ports: Readonly<Record<string, number>> & {
+        readonly database: number;
+    };
+    files: readonly {
+        action: "create" | "update" | "unchanged";
+        path: string;
+    }[];
+    safety: readonly string[];
+    readiness?: ReadinessReport;
+    nextAction: string;
+}) => string;
+export declare const renderBaselinePreparation: (result: {
+    mode: RenderMode;
+    destination: string;
+    rowCount: number;
+    recordsPath: string;
+    migrationCount: number;
+    migrationCutoff: string;
+    tables: readonly RenderTable[];
+    nextAction: string;
+}, flags?: RenderFlags) => string;
+export declare const renderBaselineInputInspection: (result: {
+    rowCount: number;
+    recordsPath: string;
+    migrationCount: number;
+    migrationCutoff: string;
+    ledgerPath: string;
+    assetsPath?: string;
+    assetCount: number;
+    tables: readonly RenderTable[];
+}, flags?: RenderFlags) => string;
+export declare const renderSupportReport: (report: {
+    rehearsalVersion: string;
+    system: {
+        platform: string;
+        architecture: string;
+        release: string;
+        node: string;
+    };
+    tools: Record<"npm" | "supabase" | "dockerClient" | "dockerServer", {
+        status: string;
+        version?: string;
+    }>;
+    readiness: {
+        state: string;
+        checks: readonly Omit<ReadinessCheck, "detail">[];
+        quarantinedHostedVariableCount: number;
+    };
+    supportUrl: string;
+}) => string;
+export declare const formatBytes: (bytes: number) => string;
+export declare const renderCleanup: (result: CleanupResult) => string;
+export declare const renderSourceAccessPlan: (plan: SourceAccessPlan) => string;
+export declare const renderRefreshWorkflow: ({ mode, plan, refreshed, runtime, cleanup, }: {
+    mode: RenderMode;
+    plan: RefreshPlan;
+    refreshed?: {
+        generationId: string;
+    };
+    runtime?: {
+        targets?: readonly unknown[];
+    };
+    cleanup?: {
+        state: "complete";
+        removed: readonly string[];
+    } | {
+        state: string;
+        remaining: number;
+    };
+}) => string;
+export declare const renderSourceRetirement: ({ mode, plan, }: {
+    mode: RenderMode;
+    plan: SourceRetirementPlan;
+}) => string;
+export declare const renderIdentityPlan: ({ mode, plan, }: {
+    mode: RenderMode;
+    plan: IdentityClaimPlan;
+}) => string;
+export {};