@rawsql-ts/ztd-cli 0.19.0 → 0.20.2

package/dist/commands/diff.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DDL_DIFF_SPAN_NAMES = void 0;
+exports.runDiffSchema = runDiffSchema;
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node:path"));
+const diff_1 = require("diff");
+const collectSqlFiles_1 = require("../utils/collectSqlFiles");
+const connectionSummary_1 = require("../utils/connectionSummary");
+const fs_1 = require("../utils/fs");
+const pgDump_1 = require("../utils/pgDump");
+const telemetry_1 = require("../utils/telemetry");
+exports.DDL_DIFF_SPAN_NAMES = {
+    collectLocalDdl: 'collect-local-ddl',
+    pullRemoteDdl: 'pull-remote-ddl',
+    computeDiffPlan: 'compute-diff-plan',
+    emitDiffPlan: 'emit-diff-plan',
+};
+function runDiffSchema(options) {
+    const localSources = (0, telemetry_1.withSpanSync)(exports.DDL_DIFF_SPAN_NAMES.collectLocalDdl, () => {
+        const discovered = (0, collectSqlFiles_1.collectSqlFiles)(options.directories, options.extensions);
+        if (discovered.length === 0) {
+            throw new Error(`No SQL files were discovered under ${options.directories.join(', ')}`);
+        }
+        return discovered;
+    }, {
+        directoryCount: options.directories.length,
+        extensionCount: options.extensions.length,
+    });
+    // Concatenate the local DDL files in a stable order for deterministic diff outputs.
+    const localSql = localSources.map((source) => source.sql).join('\n\n');
+    const remoteSql = (0, telemetry_1.withSpanSync)(exports.DDL_DIFF_SPAN_NAMES.pullRemoteDdl, () => {
+        return (0, pgDump_1.runPgDump)({
+            url: options.url,
+            pgDumpPath: options.pgDumpPath,
+            pgDumpShell: options.pgDumpShell,
+            connectionContext: options.connectionContext
+        });
+    });
+    const plan = (0, telemetry_1.withSpanSync)(exports.DDL_DIFF_SPAN_NAMES.computeDiffPlan, () => {
+        const hasChanges = localSql !== remoteSql;
+        const patch = hasChanges
+            ? (0, diff_1.createTwoFilesPatch)('local', 'database', localSql, remoteSql, '', '', { context: 3 })
+            : '-- No schema differences detected.';
+        const databaseTarget = (0, connectionSummary_1.formatConnectionTarget)(options.connectionContext) || 'target: unknown';
+        const header = `-- ztd ddl diff plan\n-- Local DDL: ${options.directories.join(', ')}\n-- Database: ${databaseTarget}\n-- Generated: ${new Date().toISOString()}\n\n`;
+        return {
+            hasChanges,
+            patch: `${header}${patch}\n`,
+        };
+    }, {
+        localFileCount: localSources.length,
+    });
+    if (!options.dryRun) {
+        (0, telemetry_1.withSpanSync)(exports.DDL_DIFF_SPAN_NAMES.emitDiffPlan, () => {
+            (0, fs_1.ensureDirectory)(node_path_1.default.dirname(options.out));
+            (0, node_fs_1.writeFileSync)(options.out, plan.patch, 'utf8');
+            console.log(`DDL diff plan written to ${options.out}`);
+        }, {
+            outFile: options.out,
+        });
+    }
+    return {
+        outFile: options.out,
+        patch: plan.patch,
+        dryRun: Boolean(options.dryRun),
+        hasChanges: plan.hasChanges
+    };
+}
+//# sourceMappingURL=diff.js.map

package/dist/commands/diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../../src/commands/diff.ts"],"names":[],"mappings":";;;;;;AAmCA,sCAwDC;AA3FD,qCAAwC;AACxC,0DAA6B;AAC7B,+BAA2C;AAC3C,8DAA2D;AAC3D,kEAAoE;AAEpE,oCAA8C;AAC9C,4CAA4C;AAC5C,kDAAkD;AAoBrC,QAAA,mBAAmB,GAAG;IACjC,eAAe,EAAE,mBAAmB;IACpC,aAAa,EAAE,iBAAiB;IAChC,eAAe,EAAE,mBAAmB;IACpC,YAAY,EAAE,gBAAgB;CACtB,CAAC;AAEX,SAAgB,aAAa,CAAC,OAA0B;IACtD,MAAM,YAAY,GAAG,IAAA,wBAAY,EAAC,2BAAmB,CAAC,eAAe,EAAE,GAAG,EAAE;QAC1E,MAAM,UAAU,GAAG,IAAA,iCAAe,EAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sCAAsC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC,EAAE;QACD,cAAc,EAAE,OAAO,CAAC,WAAW,CAAC,MAAM;QAC1C,cAAc,EAAE,OAAO,CAAC,UAAU,CAAC,MAAM;KAC1C,CAAC,CAAC;IAEH,oFAAoF;IACpF,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvE,MAAM,SAAS,GAAG,IAAA,wBAAY,EAAC,2BAAmB,CAAC,aAAa,EAAE,GAAG,EAAE;QACrE,OAAO,IAAA,kBAAS,EAAC;YACf,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;SAC7C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,IAAA,wBAAY,EAAC,2BAAmB,CAAC,eAAe,EAAE,GAAG,EAAE;QAClE,MAAM,UAAU,GAAG,QAAQ,KAAK,SAAS,CAAC;QAC1C,MAAM,KAAK,GAAG,UAAU;YACtB,CAAC,CAAC,IAAA,0BAAmB,EAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YACvF,CAAC,CAAC,oCAAoC,CAAC;QAEzC,MAAM,cAAc,GAAG,IAAA,0CAAsB,EAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,CAAC;QAC9F,MAAM,MAAM,GAAG,uCAAuC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,cAAc,mBAAmB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC;QAEtK,OAAO;YACL,UAAU;YACV,KAAK,EAAE,GAAG,MAAM,GAAG,KAAK,IAAI;SAC7B,CAAC;IACJ,CAAC,EAAE;QACD,cAAc,EAAE,YAAY,CAAC,MAAM;KACpC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,IAAA,wBAAY,EAAC,2BAAmB,CAAC,YAAY,EAAE,GAAG,EAAE;YAClD,IAAA,oBAAe,EAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAA,uBAAa,EAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC/C,OAAO,CAAC,GAAG,CAAC,4BAA4B,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QACzD,CAAC,EAAE;YACD,OAAO,EAAE,OAAO,CAAC,GAAG;SACrB,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG;QACpB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;KAC5B,CAAC;AACJ,CAAC"}

package/dist/commands/genEntities.d.ts

@@ -0,0 +1,14 @@
+import { type TableMetadata } from './ztdConfig';
+export interface GenerateEntitiesOptions {
+    directories: string[];
+    extensions: string[];
+    out: string;
+    dryRun?: boolean;
+}
+export interface GenerateEntitiesResult {
+    outFile: string;
+    rendered: string;
+    tables: TableMetadata[];
+    dryRun: boolean;
+}
+export declare function runGenerateEntities(options: GenerateEntitiesOptions): GenerateEntitiesResult;

package/dist/commands/genEntities.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runGenerateEntities = runGenerateEntities;
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node:path"));
+const collectSqlFiles_1 = require("../utils/collectSqlFiles");
+const fs_1 = require("../utils/fs");
+const typeMapper_1 = require("../utils/typeMapper");
+const ztdConfig_1 = require("./ztdConfig");
+function runGenerateEntities(options) {
+    const sources = (0, collectSqlFiles_1.collectSqlFiles)(options.directories, options.extensions);
+    if (sources.length === 0) {
+        throw new Error(`No SQL files were discovered under ${options.directories.join(', ')}`);
+    }
+    const tables = (0, ztdConfig_1.snapshotTableMetadata)(sources);
+    if (tables.length === 0) {
+        throw new Error('The provided DDL sources did not contain any CREATE TABLE statements.');
+    }
+    const output = renderEntitiesFile(tables);
+    if (!options.dryRun) {
+        (0, fs_1.ensureDirectory)(node_path_1.default.dirname(options.out));
+        (0, node_fs_1.writeFileSync)(options.out, output, 'utf8');
+        console.log(`Generated ${tables.length} schema helpers at ${options.out}`);
+    }
+    return {
+        outFile: options.out,
+        rendered: output,
+        tables,
+        dryRun: Boolean(options.dryRun)
+    };
+}
+function renderEntitiesFile(tables) {
+    // The header reminds maintainers that this file is a secondary reference next to tests/generated/ztd-row-map.generated.ts.
+    const header = [
+        '// ENTITY HELPERS - AUTO GENERATED',
+        '// Complementary reference for tooling. TestRowMap in tests/generated/ztd-row-map.generated.ts remains authoritative.',
+        ''
+    ].join('\n');
+    // Emit an interface per table to keep column metadata available for optional helpers.
+    const definitions = tables
+        .map((table) => {
+        const entityName = table.testRowInterfaceName.replace(/TestRow$/, 'Entity');
+        const fields = table.columns
+            .map((column) => {
+            const baseType = (0, typeMapper_1.mapSqlTypeToTs)(column.typeName, `${table.name}.${column.name}`);
+            const tsType = column.isNullable ? `${baseType} | null` : baseType;
+            return `  ${column.name}: ${tsType};`;
+        })
+            .join('\n');
+        return `export interface ${entityName} {\n${fields}\n}`;
+    })
+        .join('\n\n');
+    return `${header}${definitions}\n`;
+}
+//# sourceMappingURL=genEntities.js.map

package/dist/commands/genEntities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genEntities.js","sourceRoot":"","sources":["../../src/commands/genEntities.ts"],"names":[],"mappings":";;;;;AAqBA,kDAuBC;AA5CD,qCAAwC;AACxC,0DAA6B;AAC7B,8DAA2D;AAC3D,oCAA8C;AAC9C,oDAAqD;AACrD,2CAAwE;AAgBxE,SAAgB,mBAAmB,CAAC,OAAgC;IAClE,MAAM,OAAO,GAAG,IAAA,iCAAe,EAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACzE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,sCAAsC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,iCAAqB,EAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IAC3F,CAAC;IAED,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,IAAA,oBAAe,EAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,IAAA,uBAAa,EAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,CAAC,MAAM,sBAAsB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG;QACpB,QAAQ,EAAE,MAAM;QAChB,MAAM;QACN,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;KAChC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAuB;IACjD,2HAA2H;IAC3H,MAAM,MAAM,GAAG;QACb,oCAAoC;QACpC,uHAAuH;QACvH,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,sFAAsF;IACtF,MAAM,WAAW,GAAG,MAAM;SACvB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,UAAU,GAAG,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO;aACzB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACd,MAAM,QAAQ,GAAG,IAAA,2BAAc,EAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACjF,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;YACnE,OAAO,KAAK,MAAM,CAAC,IAAI,KAAK,MAAM,GAAG,CAAC;QACxC,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,oBAAoB,UAAU,OAAO,MAAM,KAAK,CAAC;IAC1D,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,CAAC,CAAC;IAEhB,OAAO,GAAG,MAAM,GAAG,WAAW,IAAI,CAAC;AACrC,CAAC"}

package/dist/commands/init.d.ts

@@ -0,0 +1,104 @@
+import { Command } from 'commander';
+import { type ZtdConfigGenerationOptions } from './ztdConfig';
+import { type PullSchemaOptions } from './pull';
+type PackageManager = 'pnpm' | 'npm' | 'yarn';
+type PackageInstallKind = 'devDependencies' | 'install';
+interface PnpmWorkspaceGuard {
+    workspaceRoot: string | null;
+    shouldIgnoreWorkspace: boolean;
+}
+/**
+ * Prompt interface for interactive input during `ztd init`.
+ */
+export interface Prompter {
+    selectChoice(question: string, choices: string[]): Promise<number>;
+    promptInput(question: string, example?: string): Promise<string>;
+    promptInputWithDefault(question: string, defaultValue: string, example?: string): Promise<string>;
+    confirm(question: string): Promise<boolean>;
+    close(): void;
+}
+/**
+ * Create a readline-backed prompter that reads from stdin/stdout.
+ */
+export declare function createConsolePrompter(): Prompter;
+/**
+ * Summarizes how an individual file was created during initialization.
+ */
+export interface FileSummary {
+    relativePath: string;
+    outcome: 'created' | 'overwritten' | 'unchanged';
+}
+/**
+ * Result payload for `ztd init` describing outputs and next steps.
+ */
+export interface InitResult {
+    summary: string;
+    files: FileSummary[];
+}
+/**
+ * Dependency overrides used to orchestrate the init flow and IO side effects.
+ */
+export interface ZtdConfigWriterDependencies {
+    ensureDirectory: (directory: string) => void;
+    writeFile: (filePath: string, contents: string) => void;
+    fileExists: (filePath: string) => boolean;
+    runPullSchema: (options: PullSchemaOptions) => Promise<unknown> | unknown;
+    runGenerateZtdConfig: (options: ZtdConfigGenerationOptions) => Promise<unknown> | unknown;
+    checkPgDump: () => boolean;
+    log: (message: string) => void;
+    copyAgentsTemplate: (rootDir: string) => string | null;
+    installPackages: (options: {
+        rootDir: string;
+        kind: PackageInstallKind;
+        packages: string[];
+        packageManager: PackageManager;
+    }) => Promise<void> | void;
+}
+/**
+ * Options for configuring the `ztd init` command execution.
+ */
+export interface InitCommandOptions {
+    rootDir?: string;
+    dependencies?: Partial<ZtdConfigWriterDependencies>;
+    appShape?: InitAppShape;
+    withSqlClient?: boolean;
+    withAiGuidance?: boolean;
+    withAppInterface?: boolean;
+    forceOverwrite?: boolean;
+    nonInteractive?: boolean;
+    workflow?: InitWorkflow;
+    validator?: ValidatorBackend;
+    localSourceRoot?: string;
+    dryRun?: boolean;
+}
+type ValidatorBackend = 'zod' | 'arktype';
+type InitAppShape = 'default' | 'webapi';
+type InitWorkflow = 'pg_dump' | 'empty' | 'demo';
+/**
+ * Run the interactive `ztd init` workflow and return the resulting summary.
+ */
+export declare function runInitCommand(prompter: Prompter, options?: InitCommandOptions): Promise<InitResult>;
+export declare function findAncestorPnpmWorkspaceRoot(rootDir: string): string | null;
+export declare function resolvePnpmWorkspaceGuard(rootDir: string, packageManager: PackageManager): PnpmWorkspaceGuard;
+export interface InitInstallStrategy {
+    installCommand: string;
+    workspaceGuard: PnpmWorkspaceGuard;
+    shouldDeferAutoInstall: boolean;
+}
+export declare function resolveInitInstallStrategy(rootDir: string, packageManager: PackageManager, environment?: {
+    platform?: NodeJS.Platform;
+    npmCommand?: string;
+}): InitInstallStrategy;
+export declare function buildPackageManagerArgs(kind: PackageInstallKind, packageManager: PackageManager, packages: string[], rootDir?: string): string[];
+/**
+ * Normalizes a schema identifier into the canonical lowercase form used by ztd-cli file naming.
+ * Empty input falls back to the configured default schema.
+ */
+export declare function normalizeSchemaName(value: string): string;
+/**
+ * Sanitizes a normalized schema identifier so it can be used as a filesystem-safe file stem.
+ * Returns `schema` when all characters are stripped by sanitization.
+ */
+export declare function sanitizeSchemaFileName(schemaName: string): string;
+export declare function registerInitCommand(program: Command): void;
+export {};