@rehearsal-db/core 0.1.0-beta.14 → 0.1.0-beta.16

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

@@ -0,0 +1,8 @@
+/** Provider-neutral copied-account planning and application handlers. */
+import type { CommandDefinition } from "./command_contract.mjs";
+import type { createProjectCommands } from "./project_commands.mjs";
+type ProjectCommands = ReturnType<typeof createProjectCommands>;
+export declare const createIdentityCommandHandlers: ({ loadIdentityClaimPlan, }: {
+    loadIdentityClaimPlan: ProjectCommands["loadIdentityClaimPlan"];
+}) => readonly CommandDefinition[];
+export {};

package/dist/src/cli/identity_command_handlers.mjs

@@ -0,0 +1,43 @@
+/** Provider-neutral copied-account planning and application handlers. */
+import { readFile } from "node:fs/promises";
+import { parseEnv } from "node:util";
+import { applyIdentityClaim } from "../identity/claim.mjs";
+import { createSupabaseStorageTransfer } from "../identity/storage.mjs";
+import { exactCommands, renderedCommand } from "./command_contract.mjs";
+import { renderIdentityPlan } from "./renderers.mjs";
+export const createIdentityCommandHandlers = ({ loadIdentityClaimPlan, }) => [
+    exactCommands("identity", ["identity plan", "identity claim"], async ({ command, flags, planOptions }) => {
+        const { loaded, plan } = await loadIdentityClaimPlan({
+            flags,
+            planOptions,
+        });
+        if (command === "identity plan" || !flags.identityConfirmation) {
+            const data = { mode: "preview", plan };
+            return renderedCommand({ data, render: renderIdentityPlan });
+        }
+        const runtimeEnvironment = parseEnv(await readFile(loaded.paths.applicationEnvironment, "utf8"));
+        if (!runtimeEnvironment.DATABASE_URL) {
+            throw new Error("The local runtime environment has no DATABASE_URL.");
+        }
+        const needsStorageTransfer = plan.identity.assets.some((asset) => asset.rewritePath);
+        if (needsStorageTransfer &&
+            (!runtimeEnvironment.SUPABASE_URL ||
+                !runtimeEnvironment.SUPABASE_SERVICE_ROLE_KEY)) {
+            throw new Error("Identity asset transfer requires local Supabase URL and service-role credentials.");
+        }
+        const storageTransfer = needsStorageTransfer
+            ? createSupabaseStorageTransfer({
+                url: runtimeEnvironment.SUPABASE_URL,
+                serviceRoleKey: runtimeEnvironment.SUPABASE_SERVICE_ROLE_KEY,
+            })
+            : undefined;
+        const result = await applyIdentityClaim({
+            plan,
+            confirmation: flags.identityConfirmation,
+            connectionString: runtimeEnvironment.DATABASE_URL,
+            ...(storageTransfer === undefined ? {} : { storageTransfer }),
+        });
+        const data = { mode: "written", plan, result };
+        return renderedCommand({ data, render: renderIdentityPlan });
+    }),
+];

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

@@ -0,0 +1,21 @@
+/** Preview or create the project-root Rehearsal configuration. */
+interface InitFlags {
+    readonly configPath: string | undefined;
+    readonly write: boolean;
+}
+interface InitOptions {
+    readonly projectRoot: string;
+    readonly flags: InitFlags;
+}
+export declare const runRehearsalInit: ({ projectRoot, flags }: InitOptions) => Promise<{
+    mode: string;
+    destination: string;
+    detected: import("../project/project_detection.mjs").DetectedProject;
+    source: string;
+    availableOptions: {
+        path: string;
+        summary: string;
+    }[];
+    nextAction: string;
+}>;
+export {};

package/dist/src/cli/init_command.mjs

@@ -0,0 +1,90 @@
+/** Preview or create the project-root Rehearsal configuration. */
+import { writeFile } from "node:fs/promises";
+import { join, relative } from "node:path";
+import { findRehearsalConfigPath, inspectDetectedProject, loadRehearsalConfig, renderDetectedConfig, renderDetectedPostgresqlConfig, } from "../project/configuration.mjs";
+const findExistingConfig = async ({ projectRoot, configPath, }) => {
+    try {
+        return await findRehearsalConfigPath({
+            projectRoot,
+            ...(configPath === undefined ? {} : { configPath }),
+        });
+    }
+    catch (error) {
+        if (String(error instanceof Error ? error.message : error).startsWith("No Rehearsal configuration")) {
+            return null;
+        }
+        throw error;
+    }
+};
+export const runRehearsalInit = async ({ projectRoot, flags }) => {
+    const detected = await inspectDetectedProject({ projectRoot });
+    const destination = join(projectRoot, "rehearsal.config.mjs");
+    const existingPath = await findExistingConfig({
+        projectRoot,
+        configPath: flags.configPath,
+    });
+    if (existingPath) {
+        if (flags.write) {
+            throw new Error(`A Rehearsal configuration already exists at ${relative(projectRoot, existingPath)}; Rehearsal will not overwrite it.`);
+        }
+        const loaded = await loadRehearsalConfig({
+            projectRoot,
+            ...(flags.configPath === undefined
+                ? {}
+                : { configPath: flags.configPath }),
+        });
+        let source;
+        if (loaded.config.supabase) {
+            const { api, database, studio } = loaded.config.runtime.ports;
+            if (api === undefined || studio === undefined) {
+                throw new Error("The normalized Supabase configuration is missing its API or Studio port.");
+            }
+            source = renderDetectedConfig(detected, {
+                applicationUrl: loaded.config.runtime.applicationUrl,
+                ports: { api, database, studio },
+            });
+        }
+        else {
+            source = renderDetectedPostgresqlConfig(detected, {
+                applicationUrl: loaded.config.runtime.applicationUrl,
+                databasePort: loaded.config.runtime.ports.database,
+            });
+        }
+        const usesLegacyAuthentication = Boolean(loaded.config.supabase?.serviceEnvironmentFile ||
+            loaded.config.safety.authenticationProviders.length);
+        const availableOptions = loaded.config.supabase && !loaded.config.supabase.authentication
+            ? [
+                {
+                    path: "supabase.authentication",
+                    summary: usesLegacyAuthentication
+                        ? "A declarative Google/GitHub replacement is available; replace the legacy provider fields together after review."
+                        : "Configure local Google or GitHub sign-in with credentials kept outside tracked files.",
+                },
+            ]
+            : [];
+        return {
+            mode: "current-template",
+            destination: relative(projectRoot, existingPath),
+            detected,
+            source,
+            availableOptions,
+            nextAction: "Your existing configuration was not changed. Compare it with this installed-release template to discover new optional keys.",
+        };
+    }
+    const source = detected.hasSupabaseConfig
+        ? renderDetectedConfig(detected)
+        : renderDetectedPostgresqlConfig(detected);
+    if (flags.write) {
+        await writeFile(destination, source, { flag: "wx", mode: 0o600 });
+    }
+    return {
+        mode: flags.write ? "written" : "preview",
+        destination: relative(projectRoot, destination),
+        detected,
+        source,
+        availableOptions: [],
+        nextAction: flags.write
+            ? "Review the generated safety settings and run rehearsal doctor."
+            : "Review this preview, then rerun rehearsal init --write to create it.",
+    };
+};

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

@@ -0,0 +1,3 @@
+/** Read-only readiness, support, planning, and inspection command handlers. */
+import type { CommandDefinition } from "./command_contract.mjs";
+export declare const createInspectionCommandHandlers: () => readonly CommandDefinition[];

package/dist/src/cli/inspection_command_handlers.mjs

@@ -0,0 +1,79 @@
+/** Read-only readiness, support, planning, and inspection command handlers. */
+import { collectRehearsalSupportReport } from "../project/support_report.mjs";
+import { inspectRehearsalBaseline, inspectRehearsalMigrations, } from "../runtime/plan.mjs";
+import { buildRuntimeStackPlan, runRuntimeStackDoctor, topologyCandidateSummary, } from "./runtime_commands.mjs";
+import { renderBaseline, renderCandidates, renderDoctor, renderMigrations, renderPlan, renderSupportReport, } from "./renderers.mjs";
+import { exactCommands, renderedCommand } from "./command_contract.mjs";
+export const createInspectionCommandHandlers = () => [
+    exactCommands("doctor", ["doctor"], async ({ guided, flags, planOptions }) => {
+        const data = await runRuntimeStackDoctor(planOptions);
+        return renderedCommand({
+            data,
+            render: (result, verbosity) => renderDoctor(result, verbosity),
+            status: data.state === "READY" ? "success" : "not_ready",
+            ...(data.state !== "READY" && !guided ? { exitCode: 1 } : {}),
+        });
+    }),
+    exactCommands("support", ["support"], async ({ planOptions }) => {
+        const data = await collectRehearsalSupportReport(planOptions, {
+            runDoctor: async (options) => {
+                const report = await runRuntimeStackDoctor(options);
+                const targetAliases = new Map();
+                const aliasFor = (name) => {
+                    if (!targetAliases.has(name)) {
+                        targetAliases.set(name, `runtime-${targetAliases.size + 1}`);
+                    }
+                    return targetAliases.get(name);
+                };
+                return {
+                    ...report,
+                    checks: report.checks.map((check) => {
+                        const separator = check.id.indexOf(":");
+                        if (separator === -1)
+                            return check;
+                        const target = check.id.slice(0, separator);
+                        const alias = aliasFor(target);
+                        return {
+                            ...check,
+                            id: `${alias}:${check.id.slice(separator + 1)}`,
+                            label: check.label.replace(`${target}:`, `${alias}:`),
+                        };
+                    }),
+                };
+            },
+        });
+        return renderedCommand({
+            data,
+            render: (result) => renderSupportReport(result),
+        });
+    }),
+    {
+        id: "explain",
+        matches: ({ command, flags }) => command === "explain" || (command === "run" && flags.dryRun),
+        handle: async ({ planOptions }) => {
+            const data = await buildRuntimeStackPlan(planOptions);
+            return renderedCommand({
+                data,
+                render: (result, verbosity) => renderPlan(result, verbosity),
+            });
+        },
+    },
+    exactCommands("inspect-baseline", ["inspect baseline"], async ({ planOptions }) => {
+        const data = await inspectRehearsalBaseline(planOptions);
+        return renderedCommand({ data, render: renderBaseline });
+    }),
+    exactCommands("inspect-migrations", ["inspect migrations"], async ({ planOptions }) => {
+        const data = await inspectRehearsalMigrations(planOptions);
+        return renderedCommand({
+            data,
+            render: (result, verbosity) => renderMigrations(result, verbosity),
+        });
+    }),
+    exactCommands("candidates", ["candidates"], async ({ planOptions }) => {
+        const { topology: _topology, ...data } = await topologyCandidateSummary(planOptions);
+        return renderedCommand({
+            data,
+            render: (result, verbosity) => renderCandidates(result, verbosity),
+        });
+    }),
+];

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

@@ -0,0 +1,11 @@
+/** Project setup, baseline creation, privacy-key, and cleanup command handlers. */
+import type { CommandDefinition } from "./command_contract.mjs";
+import type { createProjectCommands } from "./project_commands.mjs";
+type ProjectCommands = ReturnType<typeof createProjectCommands>;
+export declare const createProjectCommandHandlers: ({ projectRoot, runSetup, runBaselinePreparation, runCleanup, }: {
+    projectRoot: string;
+    runSetup: ProjectCommands["runSetup"];
+    runBaselinePreparation: ProjectCommands["runBaselinePreparation"];
+    runCleanup: ProjectCommands["runCleanup"];
+}) => readonly CommandDefinition[];
+export {};

package/dist/src/cli/project_command_handlers.mjs

@@ -0,0 +1,92 @@
+/** Project setup, baseline creation, privacy-key, and cleanup command handlers. */
+import { relative } from "node:path";
+import { createSyntheticBaselineFromFiles } from "../baseline/builder.mjs";
+import { inspectBaselineInputFiles } from "../baseline/preparation.mjs";
+import { createPrivacyKey } from "../baseline/privacy_engine.mjs";
+import { formatCount } from "../shared/human_output.mjs";
+import { runRehearsalInit } from "./init_command.mjs";
+import { loadPreparationContext } from "./source_commands.mjs";
+import { renderBaselinePreparation, renderCleanup, renderInit, renderSetup, } from "./renderers.mjs";
+import { exactCommands, renderedCommand } from "./command_contract.mjs";
+export const createProjectCommandHandlers = ({ projectRoot, runSetup, runBaselinePreparation, runCleanup, }) => [
+    exactCommands("setup", ["setup"], async ({ flags, planOptions, state }) => {
+        const data = await runSetup({ flags, planOptions, session: state });
+        return renderedCommand({
+            data,
+            render: () => renderSetup(data),
+        });
+    }),
+    exactCommands("init", ["init"], async ({ flags }) => {
+        const data = await runRehearsalInit({ projectRoot, flags });
+        return renderedCommand({
+            data,
+            render: (result) => renderInit(result),
+        });
+    }),
+    exactCommands("baseline-prepare", ["baseline prepare"], async ({ flags, planOptions, state }) => {
+        const data = await runBaselinePreparation({
+            flags,
+            planOptions,
+            session: state,
+        });
+        return renderedCommand({
+            data,
+            render: (result) => renderBaselinePreparation(result, flags),
+        });
+    }),
+    exactCommands("baseline-create", ["baseline create"], async ({ flags, planOptions }) => {
+        if (!flags.recordsPath || !flags.ledgerPath) {
+            throw new Error("baseline create requires --records and --ledger input paths.");
+        }
+        const baselineInput = {
+            ...planOptions,
+            recordsPath: flags.recordsPath,
+            ledgerPath: flags.ledgerPath,
+            ...(flags.assetsPath === undefined
+                ? {}
+                : { assetsPath: flags.assetsPath }),
+        };
+        await inspectBaselineInputFiles(baselineInput);
+        const data = await createSyntheticBaselineFromFiles(baselineInput);
+        return renderedCommand({
+            data,
+            render: (baseline) => [
+                `Activated synthetic baseline ${baseline.generationId}: ${formatCount(baseline.rowCount, "row")} across ${formatCount(baseline.tableCount, "table")}; ${formatCount(baseline.migrationCount, "migration")} through ${baseline.migrationCutoff}.`,
+                "",
+                flags.guided
+                    ? "Next: choose Run a rehearsal when you are ready."
+                    : "Next: run rehearsal doctor to check readiness.",
+            ].join("\n"),
+        });
+    }),
+    exactCommands("privacy-key", ["privacy key"], async ({ flags, planOptions }) => {
+        const { loaded } = await loadPreparationContext(planOptions);
+        if (!loaded.paths.privacyKey) {
+            throw new Error("No config.preparation.privacyKey is configured.");
+        }
+        const privacyKeyPath = loaded.paths.privacyKey;
+        const data = flags.write
+            ? {
+                mode: "written",
+                path: relative(loaded.projectRoot, privacyKeyPath),
+                ...(await createPrivacyKey(privacyKeyPath)),
+            }
+            : {
+                mode: "preview",
+                path: relative(loaded.projectRoot, privacyKeyPath),
+            };
+        return renderedCommand({
+            data,
+            render: (result) => result.mode === "preview"
+                ? `PRIVACY KEY — PREVIEW\n\nWould create ${result.path} with owner-only permissions.\nNothing was written. Rerun with --write after reviewing the path.`
+                : `Created owner-only privacy key at ${result.path}.\nFingerprint: ${result.fingerprint}\nThe key is excluded from source control and must not be shared.`,
+        });
+    }),
+    exactCommands("cleanup", ["cleanup"], async ({ flags, planOptions, state }) => {
+        const data = await runCleanup({ flags, planOptions, session: state });
+        return renderedCommand({
+            data,
+            render: () => renderCleanup(data),
+        });
+    }),
+];

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

@@ -0,0 +1,159 @@
+/** Project-scoped CLI orchestration that is shared by direct and guided commands. */
+import { summarizeBaselinePreparation } from "../baseline/preparation.mjs";
+import type { RehearsalConfigPathOptions } from "../project/configuration.mjs";
+import type { RehearsalCleanupPlan } from "../runtime/cleanup.mjs";
+import type { RehearsalCliFlags } from "./arguments.mjs";
+import type { CliSessionState } from "./command_contract.mjs";
+type CleanupStackPlan = Readonly<{
+    digest: string;
+    targets: readonly Readonly<{
+        name: string;
+        configPath: string;
+        plan: RehearsalCleanupPlan;
+    }>[];
+}>;
+type RunManager = (input: {
+    action: "discard";
+    flags: RehearsalCliFlags;
+    configPath?: string;
+    targetName?: string;
+}) => unknown;
+interface ProjectCommandInput {
+    readonly flags: RehearsalCliFlags;
+    readonly planOptions: RehearsalConfigPathOptions;
+    readonly session?: CliSessionState;
+}
+export declare const createProjectCommands: ({ projectRoot, runManager, }: {
+    projectRoot: string;
+    runManager: RunManager;
+}) => Readonly<{
+    loadIdentityClaimPlan: ({ flags, planOptions, }: ProjectCommandInput) => Promise<{
+        loaded: Readonly<{
+            config: Readonly<{
+                schemaVersion: 1;
+                project: Readonly<{
+                    name: string;
+                }>;
+                supabase: Readonly<{
+                    workdir: string;
+                    migrationDirectory: string;
+                    rehearsalConfig: string;
+                    runtimeWorkdir: string;
+                    authentication: Readonly<{
+                        enableLocalSignup: true;
+                        environmentFile: string;
+                        providers: readonly Readonly<{
+                            name: "github" | "google";
+                            clientIdEnvironmentVariable: string;
+                            clientSecretEnvironmentVariable: string;
+                            skipNonceCheck: boolean;
+                            emailOptional: boolean;
+                        }>[];
+                    }> | null;
+                    serviceEnvironmentFile: string | null;
+                    serviceEnvironmentVariables: readonly string[];
+                }> | null;
+                postgresql: Readonly<{
+                    migrationDirectory: string;
+                    runtimeWorkdir: string;
+                    image: string;
+                    database: string;
+                    user: string;
+                }> | null;
+                baseline: Readonly<{
+                    artifactDirectory: string;
+                    sanitizationPolicy: string;
+                }>;
+                containerRuntime: Readonly<{
+                    autoStartColima: boolean;
+                }>;
+                cleanup: Readonly<{
+                    retainBaselineGenerations: number;
+                }>;
+                preparation: Readonly<{
+                    sourcePolicy: string;
+                    privacyKey: string;
+                    batchRows: number;
+                    maximumRows: number;
+                    maximumBytes: number;
+                    diskHeadroomBytes: number;
+                }> | null;
+                runtimePolicy: string | null;
+                identityPolicy: string | null;
+                dependentTargets: readonly Readonly<{
+                    name: string;
+                    configPath: string;
+                    prepareCommand: string | null;
+                }>[];
+                application: Readonly<{
+                    startCommand: string;
+                    proofCommand: string;
+                    environmentFile: string;
+                    environmentVariables: Readonly<Record<string, string>>;
+                    readiness: Readonly<{
+                        url: string;
+                        expectedStatus: number;
+                        timeoutSeconds: number;
+                    }> | null;
+                    httpProofs: readonly Readonly<{
+                        name: string;
+                        kind: "positive" | "negative";
+                        url: string;
+                        method: string;
+                        expectedStatus: number;
+                        json: Readonly<{
+                            path: readonly string[];
+                            equals?: unknown;
+                            notEquals?: unknown;
+                            minimumItems?: number;
+                        }> | null;
+                    }>[];
+                    runtimeAdapter: string | null;
+                }>;
+                runtime: Readonly<{
+                    target: "postgresql" | "supabase";
+                    applicationUrl: string;
+                    projectId: string;
+                    ports: Readonly<{
+                        api?: number;
+                        database: number;
+                        studio?: number;
+                    }>;
+                }>;
+                safety: Readonly<{
+                    allowedHosts: readonly string[];
+                    blockedEnvironmentVariables: readonly string[];
+                    authenticationProviders: readonly string[];
+                    hostedAccess: "disabled";
+                    outboundNetwork: "deny";
+                }>;
+                verification: Readonly<{
+                    commands: readonly string[];
+                }>;
+            }>;
+            configPath: string;
+            projectRoot: string;
+            paths: Readonly<{
+                artifactDirectory: string;
+                applicationEnvironment: string;
+                migrationDirectory: string;
+                rehearsalConfig: string | null;
+                runtimeWorkdir: string;
+                serviceEnvironment: string | null;
+                sanitizationPolicy: string;
+                sourcePolicy: string | null;
+                privacyKey: string | null;
+                runtimePolicy: string | null;
+                identityPolicy: string | null;
+                supabaseWorkdir: string | null;
+                runtimeAdapter: string | null;
+            }>;
+        }>;
+        plan: import("../identity/claim_contract.mjs").IdentityClaimPlan;
+    }>;
+    planRuntimeStackCleanup: ({ flags, planOptions, }: ProjectCommandInput) => Promise<RehearsalCleanupPlan | CleanupStackPlan>;
+    runBaselinePreparation: ({ flags, planOptions, session, }: ProjectCommandInput) => Promise<ReturnType<typeof summarizeBaselinePreparation>>;
+    runCleanup: ({ flags, planOptions, session, }: ProjectCommandInput) => Promise<unknown>;
+    runSetup: ({ flags, planOptions, session, }: ProjectCommandInput) => Promise<unknown>;
+}>;
+export {};