@noego/proper 0.0.3 → 0.0.5

package/bin/index.d.ts

@@ -0,0 +1,179 @@
+import mysql from 'mysql2/promise';
+
+interface MigrationConfig {
+    config_file?: string;
+    migration_table: string;
+    migration_folder: string;
+    database: string;
+    sql?: {
+        host: string;
+        user: string;
+        database: string;
+        password?: string;
+        port?: number;
+    };
+    sqlite?: {
+        database: string;
+    };
+    seeds?: {
+        migrationsDir?: string;
+        dataDir?: string;
+        list?: string[];
+    };
+}
+
+interface MigrationStatus {
+    completed: boolean;
+}
+
+interface ISQLRunner {
+    query(sql: string, params?: any[]): Promise<any>;
+    execute(sql: string, params?: any[]): Promise<any>;
+    end(): Promise<void>;
+}
+
+declare abstract class MigrationNode {
+    name: string;
+    constructor(name?: string);
+    abstract get_key(): string;
+    abstract status(): Promise<MigrationStatus>;
+    abstract up(): Promise<void>;
+    abstract down(): Promise<void>;
+    abstract up_sql(): string;
+    abstract down_sql(): string;
+}
+declare class SqlMigrationNode extends MigrationNode {
+    private conn;
+    private table;
+    private key;
+    private up_file;
+    private sql_up;
+    private down_file;
+    private sql_down;
+    up_sql(): string;
+    down_sql(): string;
+    get_key(): string;
+    constructor(conn: ISQLRunner, table: string, key: string, up_file: string, sql_up: string, down_file: string, sql_down: string);
+    status(): Promise<MigrationStatus>;
+    up(): Promise<void>;
+    down(): Promise<void>;
+}
+
+declare class SqlMigrationBuilder {
+    private key;
+    private up;
+    private up_file;
+    private down;
+    private down_file;
+    constructor(key: string);
+    set_up(file: string, up: string): void;
+    set_down(file: string, down: string): void;
+    build(table: string, conn: ISQLRunner): SqlMigrationNode;
+}
+
+declare class MigrationDirectoryReader {
+    private directory;
+    private read_strategy;
+    private sqlrunner;
+    private dialect;
+    constructor(directory: string, read_strategy: any, sqlrunner: ISQLRunner, dialect?: 'sql' | 'sqlite');
+    /**
+     * Resolves the appropriate file for a migration based on dialect.
+     * Priority: dialect-specific file > generic file
+     */
+    private resolveFile;
+    /**
+     * Checks if a file path is dialect-specific (contains .mysql. or .sqlite. in the name)
+     */
+    private isDialectSpecific;
+    loadMigrations(table: string, connection: any): MigrationNode[];
+    loadMigration(builder: SqlMigrationBuilder, file: string): SqlMigrationBuilder;
+    sql_up(file: string): string;
+    sql_down(file: string): string;
+}
+
+declare class MigrationSetup {
+    private sqlrunner;
+    private config;
+    constructor(sqlrunner: ISQLRunner, config: MigrationConfig);
+    setup(): Promise<void>;
+    teardown(): Promise<void>;
+}
+
+declare function loadMigrationConfig(configFile: string): MigrationConfig;
+declare class MigrationRunnerFactory {
+    private static isSQLRunner;
+    static create(configFile: string, conn?: any): Promise<MySQLMigrationRunner>;
+    static createConnection(config: MigrationConfig): Promise<any>;
+    static createEmpty(configFile: string): Promise<MySQLMigrationRunner>;
+    create(config: MigrationConfig, conn: any): Promise<MySQLMigrationRunner>;
+    createEmpty(config: MigrationConfig): Promise<MySQLMigrationRunner>;
+    private getReadStategy;
+}
+interface MigrationHistory {
+    name: string;
+    up: string;
+    down: string;
+}
+interface IMigrationRunner {
+    setup(): Promise<void>;
+    terminate(): Promise<void>;
+    getMigrationsHistory(): Promise<MigrationHistory[]>;
+    getMigrations(): Promise<MigrationNode[]>;
+    getPendingMigrations(): Promise<MigrationNode[]>;
+    getCompletedMigrations(): Promise<MigrationNode[]>;
+    migrate(migrationNodes: MigrationNode[], forward: boolean): Promise<void>;
+    reset(): Promise<void>;
+    createMigration(name: string): void;
+    close(): Promise<void>;
+    init(config_file: string): Promise<void>;
+    query(sql: string, params?: any[]): Promise<any>;
+}
+declare class MySQLMigrationRunner implements IMigrationRunner {
+    private config;
+    private directory;
+    private setupRunner;
+    private sqlrunner;
+    private connection;
+    constructor(config: MigrationConfig, directory: MigrationDirectoryReader, setupRunner: MigrationSetup, sqlrunner: ISQLRunner, connection: mysql.Connection);
+    setup(): Promise<void>;
+    terminate(): Promise<void>;
+    getMigrationsHistory(): Promise<MigrationHistory[]>;
+    getMigrations(): Promise<MigrationNode[]>;
+    getPendingMigrations(): Promise<MigrationNode[]>;
+    getCompletedMigrations(): Promise<MigrationNode[]>;
+    migrate(migrationNodes: MigrationNode[], forward: boolean): Promise<void>;
+    reset(): Promise<void>;
+    createMigration(name: string): void;
+    close(): Promise<void>;
+    query(sql: string, params?: any[]): Promise<any>;
+    init(config_file: string): Promise<void>;
+}
+
+type SeedTransactionalMode = 'runner' | 'seed' | 'none';
+type SeedOptions = {
+    migrationsDir?: string;
+    dataDir?: string;
+    validate?: boolean;
+    transactional?: SeedTransactionalMode;
+    aliasMap?: Record<string, string>;
+    preloadedData?: Record<string, unknown>;
+    log?: (msg: string) => void;
+    names?: string[];
+};
+type SeedContext = {
+    data: unknown;
+    log?: (msg: string) => void;
+    dialect: string;
+};
+declare function runSeedsWithRunner(runner: IMigrationRunner, migrationConfig: MigrationConfig, direction: 'up' | 'down', options: SeedOptions): Promise<void>;
+type SeedFactoryOptions = SeedOptions & {
+    configFile?: string;
+};
+type SeedFactory = {
+    up(names?: string[]): Promise<void>;
+    down(names?: string[]): Promise<void>;
+};
+declare function createSeedFactory(options: SeedFactoryOptions): SeedFactory;
+
+export { type MigrationConfig, MySQLMigrationRunner as MigrationRunner, MigrationRunnerFactory, type SeedContext, type SeedFactory, type SeedFactoryOptions, createSeedFactory, loadMigrationConfig, runSeedsWithRunner };