kysely-schema 0.1.0

package/.turbo/turbo-build.log

@@ -0,0 +1,20 @@
+
+> kysely-schema@0.1.0 build C:\Codes\node\2026\github\kysely-schema\packages\core
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: C:\Codes\node\2026\github\kysely-schema\packages\core\tsup.config.ts
+CLI Target: es2022
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+CJS dist\index.js 18.21 KB
+CJS ⚡️ Build success in 41ms
+ESM dist\index.mjs 16.80 KB
+ESM ⚡️ Build success in 42ms
+DTS Build start
+DTS ⚡️ Build success in 655ms
+DTS dist\index.d.mts 7.09 KB
+DTS dist\index.d.ts  7.09 KB

package/dist/index.d.mts

@@ -0,0 +1,207 @@
+type ReferentialAction = 'cascade' | 'set null' | 'restrict' | 'no action';
+type ColumnType = 'serial' | 'integer' | 'bigint' | 'decimal' | 'text' | 'varchar' | 'timestamp' | 'date' | 'time' | 'boolean' | 'json' | 'jsonb' | 'binary' | 'uuid';
+interface ForeignKeyReference {
+    table: string;
+    column: string;
+}
+interface ColumnDefinition {
+    type: ColumnType;
+    primaryKey?: boolean;
+    notNull?: boolean;
+    nullable?: boolean;
+    unique?: boolean;
+    default?: string | number | boolean;
+    references?: ForeignKeyReference;
+    onDelete?: ReferentialAction;
+    onUpdate?: ReferentialAction;
+    index?: boolean;
+    check?: string;
+    length?: number;
+    precision?: number;
+    scale?: number;
+}
+interface IndexDefinition {
+    name?: string;
+    columns: string[];
+    unique?: boolean;
+}
+interface TableDefinition {
+    columns: Record<string, ColumnDefinition>;
+    indexes: IndexDefinition[];
+    checks?: string[];
+}
+interface SchemaDefinition {
+    tables: Record<string, TableDefinition>;
+}
+interface MigrationFile {
+    filename: string;
+    content: string;
+}
+type DiffOperationType = 'addTable' | 'dropTable' | 'addColumn' | 'dropColumn' | 'alterColumn' | 'addIndex' | 'dropIndex';
+interface BaseDiffOperation {
+    type: DiffOperationType;
+    description: string;
+}
+interface AddTableOperation extends BaseDiffOperation {
+    type: 'addTable';
+    tableName: string;
+    table: TableDefinition;
+}
+interface DropTableOperation extends BaseDiffOperation {
+    type: 'dropTable';
+    tableName: string;
+}
+interface AddColumnOperation extends BaseDiffOperation {
+    type: 'addColumn';
+    tableName: string;
+    columnName: string;
+    column: ColumnDefinition;
+}
+interface DropColumnOperation extends BaseDiffOperation {
+    type: 'dropColumn';
+    tableName: string;
+    columnName: string;
+}
+interface AlterColumnOperation extends BaseDiffOperation {
+    type: 'alterColumn';
+    tableName: string;
+    columnName: string;
+    oldColumn: ColumnDefinition;
+    newColumn: ColumnDefinition;
+}
+interface AddIndexOperation extends BaseDiffOperation {
+    type: 'addIndex';
+    tableName: string;
+    index: IndexDefinition;
+}
+interface DropIndexOperation extends BaseDiffOperation {
+    type: 'dropIndex';
+    tableName: string;
+    indexName: string;
+}
+type DiffOperation = AddTableOperation | DropTableOperation | AddColumnOperation | DropColumnOperation | AlterColumnOperation | AddIndexOperation | DropIndexOperation;
+interface SchemaSnapshot {
+    version: string;
+    timestamp: string;
+    schema: SchemaDefinition;
+}
+interface KyselySchemaConfig {
+    schemaPath: string;
+    migrationsDir: string;
+    generatedDir: string;
+    snapshotDir: string;
+}
+
+declare class ColumnBuilder {
+    private def;
+    constructor(init: Partial<ColumnDefinition> & {
+        type: ColumnType;
+    });
+    primaryKey(): this;
+    notNull(): this;
+    nullable(): this;
+    unique(): this;
+    default(value: string | number | boolean): this;
+    references(table: string, col: string): this;
+    onDelete(action: ReferentialAction): this;
+    onUpdate(action: ReferentialAction): this;
+    index(): this;
+    check(expression: string): this;
+    /** @internal Return the raw column definition. */
+    build(): ColumnDefinition;
+}
+declare const column: {
+    serial: () => ColumnBuilder;
+    integer: () => ColumnBuilder;
+    bigint: () => ColumnBuilder;
+    decimal: (precision?: number, scale?: number) => ColumnBuilder;
+    text: () => ColumnBuilder;
+    varchar: (length?: number) => ColumnBuilder;
+    timestamp: () => ColumnBuilder;
+    date: () => ColumnBuilder;
+    time: () => ColumnBuilder;
+    boolean: () => ColumnBuilder;
+    json: () => ColumnBuilder;
+    jsonb: () => ColumnBuilder;
+    binary: () => ColumnBuilder;
+    uuid: () => ColumnBuilder;
+};
+declare function table(columns: Record<string, ColumnBuilder>): TableDefinition;
+declare function defineSchema(tables: Record<string, TableDefinition>): SchemaDefinition;
+
+interface ValidationError {
+    table: string;
+    column?: string;
+    message: string;
+}
+/**
+ * Validate a schema definition and return a list of problems.
+ * Returns an empty array if the schema is valid.
+ */
+declare function validateSchema(schema: SchemaDefinition): ValidationError[];
+
+/**
+ * Generates Kysely migration files from a SchemaDefinition.
+ */
+declare class MigrationGenerator {
+    /**
+     * Generate a full CREATE-TABLE migration for the entire schema.
+     */
+    generate(schema: SchemaDefinition, migrationName: string): MigrationFile;
+    private generateUpFunction;
+    private generateCreateTable;
+    private generateColumnDefinition;
+    private buildModifiers;
+    private generateDownFunction;
+    private generateIndexes;
+    private mapColumnType;
+    private formatDefaultValue;
+    private generateTimestamp;
+    private sanitize;
+}
+
+/**
+ * Generates a TypeScript `Database` interface from a SchemaDefinition.
+ */
+declare class TypeGenerator {
+    generate(schema: SchemaDefinition): string;
+    private mapToTypeScript;
+    private baseTypeMap;
+    private toPascalCase;
+}
+
+/**
+ * Default schema template written by `kysely-schema init`.
+ */
+declare const schemaTemplate = "import { defineSchema, table, column } from 'kysely-schema';\n\nexport default defineSchema({\n  // Define your tables here. Example:\n  //\n  // user: table({\n  //   id: column.serial().primaryKey(),\n  //   email: column.text().notNull().unique(),\n  //   name: column.text().nullable(),\n  //   createdAt: column.timestamp().default('now()').notNull(),\n  // }),\n});\n";
+/**
+ * Default config file template.
+ */
+declare const configTemplate = "import type { KyselySchemaConfig } from 'kysely-schema';\n\nconst config: KyselySchemaConfig = {\n  schemaPath: './schema/index.ts',\n  migrationsDir: './migrations',\n  generatedDir: './generated',\n  snapshotDir: './.kysely-schema',\n};\n\nexport default config;\n";
+
+/**
+ * Compares two schema snapshots and returns a list of diff operations
+ * needed to migrate from `previous` to `current`.
+ */
+declare class SchemaDiffer {
+    diff(previous: SchemaDefinition, current: SchemaDefinition): DiffOperation[];
+    /**
+     * Generate an ALTER-TABLE migration string from a list of diff operations.
+     */
+    generateAlterMigration(ops: DiffOperation[]): {
+        up: string;
+        down: string;
+    };
+    private columnsEqual;
+}
+
+/**
+ * Labels used when printing diffs to the console.
+ */
+declare const operationLabels: Record<DiffOperation['type'], string>;
+/**
+ * Return a human-readable summary for a diff operation.
+ */
+declare function describeOperation(op: DiffOperation): string;
+
+export { type AddColumnOperation, type AddIndexOperation, type AddTableOperation, type AlterColumnOperation, ColumnBuilder, type ColumnDefinition, type ColumnType, type DiffOperation, type DiffOperationType, type DropColumnOperation, type DropIndexOperation, type DropTableOperation, type ForeignKeyReference, type IndexDefinition, type KyselySchemaConfig, type MigrationFile, MigrationGenerator, type ReferentialAction, type SchemaDefinition, SchemaDiffer, type SchemaSnapshot, type TableDefinition, TypeGenerator, type ValidationError, column, configTemplate, defineSchema, describeOperation, operationLabels, schemaTemplate, table, validateSchema };

package/dist/index.d.ts

@@ -0,0 +1,207 @@
+type ReferentialAction = 'cascade' | 'set null' | 'restrict' | 'no action';
+type ColumnType = 'serial' | 'integer' | 'bigint' | 'decimal' | 'text' | 'varchar' | 'timestamp' | 'date' | 'time' | 'boolean' | 'json' | 'jsonb' | 'binary' | 'uuid';
+interface ForeignKeyReference {
+    table: string;
+    column: string;
+}
+interface ColumnDefinition {
+    type: ColumnType;
+    primaryKey?: boolean;
+    notNull?: boolean;
+    nullable?: boolean;
+    unique?: boolean;
+    default?: string | number | boolean;
+    references?: ForeignKeyReference;
+    onDelete?: ReferentialAction;
+    onUpdate?: ReferentialAction;
+    index?: boolean;
+    check?: string;
+    length?: number;
+    precision?: number;
+    scale?: number;
+}
+interface IndexDefinition {
+    name?: string;
+    columns: string[];
+    unique?: boolean;
+}
+interface TableDefinition {
+    columns: Record<string, ColumnDefinition>;
+    indexes: IndexDefinition[];
+    checks?: string[];
+}
+interface SchemaDefinition {
+    tables: Record<string, TableDefinition>;
+}
+interface MigrationFile {
+    filename: string;
+    content: string;
+}
+type DiffOperationType = 'addTable' | 'dropTable' | 'addColumn' | 'dropColumn' | 'alterColumn' | 'addIndex' | 'dropIndex';
+interface BaseDiffOperation {
+    type: DiffOperationType;
+    description: string;
+}
+interface AddTableOperation extends BaseDiffOperation {
+    type: 'addTable';
+    tableName: string;
+    table: TableDefinition;
+}
+interface DropTableOperation extends BaseDiffOperation {
+    type: 'dropTable';
+    tableName: string;
+}
+interface AddColumnOperation extends BaseDiffOperation {
+    type: 'addColumn';
+    tableName: string;
+    columnName: string;
+    column: ColumnDefinition;
+}
+interface DropColumnOperation extends BaseDiffOperation {
+    type: 'dropColumn';
+    tableName: string;
+    columnName: string;
+}
+interface AlterColumnOperation extends BaseDiffOperation {
+    type: 'alterColumn';
+    tableName: string;
+    columnName: string;
+    oldColumn: ColumnDefinition;
+    newColumn: ColumnDefinition;
+}
+interface AddIndexOperation extends BaseDiffOperation {
+    type: 'addIndex';
+    tableName: string;
+    index: IndexDefinition;
+}
+interface DropIndexOperation extends BaseDiffOperation {
+    type: 'dropIndex';
+    tableName: string;
+    indexName: string;
+}
+type DiffOperation = AddTableOperation | DropTableOperation | AddColumnOperation | DropColumnOperation | AlterColumnOperation | AddIndexOperation | DropIndexOperation;
+interface SchemaSnapshot {
+    version: string;
+    timestamp: string;
+    schema: SchemaDefinition;
+}
+interface KyselySchemaConfig {
+    schemaPath: string;
+    migrationsDir: string;
+    generatedDir: string;
+    snapshotDir: string;
+}
+
+declare class ColumnBuilder {
+    private def;
+    constructor(init: Partial<ColumnDefinition> & {
+        type: ColumnType;
+    });
+    primaryKey(): this;
+    notNull(): this;
+    nullable(): this;
+    unique(): this;
+    default(value: string | number | boolean): this;
+    references(table: string, col: string): this;
+    onDelete(action: ReferentialAction): this;
+    onUpdate(action: ReferentialAction): this;
+    index(): this;
+    check(expression: string): this;
+    /** @internal Return the raw column definition. */
+    build(): ColumnDefinition;
+}
+declare const column: {
+    serial: () => ColumnBuilder;
+    integer: () => ColumnBuilder;
+    bigint: () => ColumnBuilder;
+    decimal: (precision?: number, scale?: number) => ColumnBuilder;
+    text: () => ColumnBuilder;
+    varchar: (length?: number) => ColumnBuilder;
+    timestamp: () => ColumnBuilder;
+    date: () => ColumnBuilder;
+    time: () => ColumnBuilder;
+    boolean: () => ColumnBuilder;
+    json: () => ColumnBuilder;
+    jsonb: () => ColumnBuilder;
+    binary: () => ColumnBuilder;
+    uuid: () => ColumnBuilder;
+};
+declare function table(columns: Record<string, ColumnBuilder>): TableDefinition;
+declare function defineSchema(tables: Record<string, TableDefinition>): SchemaDefinition;
+
+interface ValidationError {
+    table: string;
+    column?: string;
+    message: string;
+}
+/**
+ * Validate a schema definition and return a list of problems.
+ * Returns an empty array if the schema is valid.
+ */
+declare function validateSchema(schema: SchemaDefinition): ValidationError[];
+
+/**
+ * Generates Kysely migration files from a SchemaDefinition.
+ */
+declare class MigrationGenerator {
+    /**
+     * Generate a full CREATE-TABLE migration for the entire schema.
+     */
+    generate(schema: SchemaDefinition, migrationName: string): MigrationFile;
+    private generateUpFunction;
+    private generateCreateTable;
+    private generateColumnDefinition;
+    private buildModifiers;
+    private generateDownFunction;
+    private generateIndexes;
+    private mapColumnType;
+    private formatDefaultValue;
+    private generateTimestamp;
+    private sanitize;
+}
+
+/**
+ * Generates a TypeScript `Database` interface from a SchemaDefinition.
+ */
+declare class TypeGenerator {
+    generate(schema: SchemaDefinition): string;
+    private mapToTypeScript;
+    private baseTypeMap;
+    private toPascalCase;
+}
+
+/**
+ * Default schema template written by `kysely-schema init`.
+ */
+declare const schemaTemplate = "import { defineSchema, table, column } from 'kysely-schema';\n\nexport default defineSchema({\n  // Define your tables here. Example:\n  //\n  // user: table({\n  //   id: column.serial().primaryKey(),\n  //   email: column.text().notNull().unique(),\n  //   name: column.text().nullable(),\n  //   createdAt: column.timestamp().default('now()').notNull(),\n  // }),\n});\n";
+/**
+ * Default config file template.
+ */
+declare const configTemplate = "import type { KyselySchemaConfig } from 'kysely-schema';\n\nconst config: KyselySchemaConfig = {\n  schemaPath: './schema/index.ts',\n  migrationsDir: './migrations',\n  generatedDir: './generated',\n  snapshotDir: './.kysely-schema',\n};\n\nexport default config;\n";
+
+/**
+ * Compares two schema snapshots and returns a list of diff operations
+ * needed to migrate from `previous` to `current`.
+ */
+declare class SchemaDiffer {
+    diff(previous: SchemaDefinition, current: SchemaDefinition): DiffOperation[];
+    /**
+     * Generate an ALTER-TABLE migration string from a list of diff operations.
+     */
+    generateAlterMigration(ops: DiffOperation[]): {
+        up: string;
+        down: string;
+    };
+    private columnsEqual;
+}
+
+/**
+ * Labels used when printing diffs to the console.
+ */
+declare const operationLabels: Record<DiffOperation['type'], string>;
+/**
+ * Return a human-readable summary for a diff operation.
+ */
+declare function describeOperation(op: DiffOperation): string;
+
+export { type AddColumnOperation, type AddIndexOperation, type AddTableOperation, type AlterColumnOperation, ColumnBuilder, type ColumnDefinition, type ColumnType, type DiffOperation, type DiffOperationType, type DropColumnOperation, type DropIndexOperation, type DropTableOperation, type ForeignKeyReference, type IndexDefinition, type KyselySchemaConfig, type MigrationFile, MigrationGenerator, type ReferentialAction, type SchemaDefinition, SchemaDiffer, type SchemaSnapshot, type TableDefinition, TypeGenerator, type ValidationError, column, configTemplate, defineSchema, describeOperation, operationLabels, schemaTemplate, table, validateSchema };