@remix-run/data-table 0.2.1 → 0.4.0

package/dist/lib/errors.js

@@ -49,16 +49,16 @@ export class DataTableQueryError extends DataTableError {
     }
 }
 /**
- * Thrown when adapter execution fails.
+ * Thrown when database execution fails.
  */
-export class DataTableAdapterError extends DataTableError {
+export class DataTableDatabaseError extends DataTableError {
     constructor(message, options) {
         super(message, {
-            code: 'DATA_TABLE_ADAPTER_ERROR',
+            code: 'DATA_TABLE_DATABASE_ERROR',
             cause: options?.cause,
             metadata: options?.metadata,
         });
-        this.name = 'DataTableAdapterError';
+        this.name = 'DataTableDatabaseError';
     }
 }
 /**

package/dist/lib/migrations/directive.d.ts

@@ -0,0 +1,12 @@
+import type { MigrationTransactionMode } from '../migrations.ts';
+/**
+ * Parses an optional `-- data-table/transaction: auto|required|none` directive
+ * from any single-line SQL comment in the script.
+ *
+ * Returns `undefined` when no directive is present.
+ * @param sql SQL script contents.
+ * @returns The declared transaction mode, or `undefined` when not declared.
+ * @throws when more than one directive is present or the value is invalid.
+ */
+export declare function parseTransactionDirective(sql: string): MigrationTransactionMode | undefined;
+//# sourceMappingURL=directive.d.ts.map

package/dist/lib/migrations/directive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directive.d.ts","sourceRoot":"","sources":["../../../src/lib/migrations/directive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAA;AAIhE;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS,CAwB3F"}

package/dist/lib/migrations/directive.js

@@ -0,0 +1,28 @@
+const directivePattern = /^\s*--\s*data-table\/transaction\s*:\s*(auto|required|none)\s*$/i;
+/**
+ * Parses an optional `-- data-table/transaction: auto|required|none` directive
+ * from any single-line SQL comment in the script.
+ *
+ * Returns `undefined` when no directive is present.
+ * @param sql SQL script contents.
+ * @returns The declared transaction mode, or `undefined` when not declared.
+ * @throws when more than one directive is present or the value is invalid.
+ */
+export function parseTransactionDirective(sql) {
+    let match;
+    for (let line of sql.split(/\r?\n/)) {
+        let trimmed = line.trim();
+        if (!trimmed.startsWith('--')) {
+            continue;
+        }
+        let result = directivePattern.exec(trimmed);
+        if (!result) {
+            continue;
+        }
+        if (match !== undefined) {
+            throw new Error('Migration script declares more than one transaction directive');
+        }
+        match = result[1].toLowerCase();
+    }
+    return match;
+}

package/dist/lib/migrations/directory-name.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Parses a migration directory name into `{ id, name }`.
+ *
+ * Expected format: `YYYYMMDDHHmmss_name`.
+ * @param name Migration directory basename.
+ * @returns Parsed migration id and name.
+ */
+export declare function parseMigrationDirectoryName(name: string): {
+    id: string;
+    name: string;
+};
+//# sourceMappingURL=directory-name.d.ts.map

package/dist/lib/migrations/directory-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory-name.d.ts","sourceRoot":"","sources":["../../../src/lib/migrations/directory-name.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAatF"}

package/dist/lib/migrations/directory-name.js

@@ -0,0 +1,18 @@
+const migrationDirectoryPattern = /^(\d{14})_(.+)$/;
+/**
+ * Parses a migration directory name into `{ id, name }`.
+ *
+ * Expected format: `YYYYMMDDHHmmss_name`.
+ * @param name Migration directory basename.
+ * @returns Parsed migration id and name.
+ */
+export function parseMigrationDirectoryName(name) {
+    let match = name.match(migrationDirectoryPattern);
+    if (!match) {
+        throw new Error('Invalid migration directory name "' + name + '". Expected format YYYYMMDDHHmmss_name');
+    }
+    return {
+        id: match[1],
+        name: match[2],
+    };
+}

package/dist/lib/migrations/journal-store.d.ts

@@ -1,15 +1,15 @@
-import type { DatabaseAdapter, TransactionToken } from '../adapter.ts';
+import type { DatabaseDriver, TransactionToken } from '../driver.ts';
 import type { MigrationDescriptor, MigrationJournalRow } from '../migrations.ts';
-export declare function normalizeChecksum(migration: MigrationDescriptor): string;
-export declare function ensureMigrationJournal(adapter: DatabaseAdapter, tableName: string): Promise<void>;
-export declare function hasMigrationJournal(adapter: DatabaseAdapter, tableName: string): Promise<boolean>;
-export declare function loadJournalRows(adapter: DatabaseAdapter, tableName: string): Promise<MigrationJournalRow[]>;
-export declare function insertJournalRow(adapter: DatabaseAdapter, tableName: string, row: {
+export declare function computeChecksum(migration: MigrationDescriptor): Promise<string>;
+export declare function ensureMigrationJournal(driver: DatabaseDriver, tableName: string): Promise<void>;
+export declare function hasMigrationJournal(driver: DatabaseDriver, tableName: string): Promise<boolean>;
+export declare function loadJournalRows(driver: DatabaseDriver, tableName: string): Promise<MigrationJournalRow[]>;
+export declare function insertJournalRow(driver: DatabaseDriver, tableName: string, row: {
     id: string;
     name: string;
     checksum: string;
     batch: number;
 }, transaction?: TransactionToken): Promise<void>;
-export declare function deleteJournalRow(adapter: DatabaseAdapter, tableName: string, id: string, transaction?: TransactionToken): Promise<void>;
+export declare function deleteJournalRow(driver: DatabaseDriver, tableName: string, id: string, transaction?: TransactionToken): Promise<void>;
 export declare function getBatch(rows: MigrationJournalRow[]): number;
 //# sourceMappingURL=journal-store.d.ts.map

package/dist/lib/migrations/journal-store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"journal-store.d.ts","sourceRoot":"","sources":["../../../src/lib/migrations/journal-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAEhF,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,mBAAmB,GAAG,MAAM,CAMxE;AAED,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAef;AAED,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAalB;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAmBhC;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE;IACH,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd,EACD,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAaf;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAQf;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAO5D"}
+{"version":3,"file":"journal-store.d.ts","sourceRoot":"","sources":["../../../src/lib/migrations/journal-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAEpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAEhF,wBAAsB,eAAe,CAAC,SAAS,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAGrF;AAYD,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAYf;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAuBlB;AAED,wBAAsB,eAAe,CACnC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAmBhC;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE;IACH,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd,EACD,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAaf;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,MAAM,EACV,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAQf;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAO5D"}

package/dist/lib/migrations/journal-store.js

@@ -1,29 +1,29 @@
-import { rawSql } from "../sql.js";
-export function normalizeChecksum(migration) {
-    if (migration.checksum) {
-        return migration.checksum;
+import { rawSql } from '../sql.js';
+export async function computeChecksum(migration) {
+    let digest = await crypto.subtle.digest('SHA-256', new TextEncoder().encode(migration.up));
+    return bytesToHex(new Uint8Array(digest));
+}
+function bytesToHex(bytes) {
+    let hex = '';
+    for (let byte of bytes) {
+        hex += byte.toString(16).padStart(2, '0');
     }
-    return migration.id + ':' + migration.name;
+    return hex;
 }
-export async function ensureMigrationJournal(adapter, tableName) {
-    await adapter.migrate({
-        operation: {
-            kind: 'createTable',
-            table: { name: tableName },
-            ifNotExists: true,
-            columns: {
-                id: { type: 'varchar', length: 64, nullable: false, primaryKey: true },
-                name: { type: 'varchar', length: 255, nullable: false },
-                checksum: { type: 'varchar', length: 128, nullable: false },
-                batch: { type: 'integer', nullable: false },
-                applied_at: { type: 'timestamp', nullable: false, default: { kind: 'now' } },
-            },
-        },
-    });
+export async function ensureMigrationJournal(driver, tableName) {
+    await driver.executeScript('create table if not exists ' +
+        tableName +
+        ' (' +
+        'id varchar(64) not null primary key, ' +
+        'name varchar(255) not null, ' +
+        'checksum varchar(128) not null, ' +
+        'batch integer not null, ' +
+        'applied_at timestamp not null default current_timestamp' +
+        ')');
 }
-export async function hasMigrationJournal(adapter, tableName) {
+export async function hasMigrationJournal(driver, tableName) {
     try {
-        await adapter.execute({
+        await driver.execute({
             operation: {
                 kind: 'raw',
                 sql: rawSql('select 1 from ' + tableName + ' limit 1'),
@@ -32,11 +32,20 @@ export async function hasMigrationJournal(adapter, tableName) {
         return true;
     }
     catch {
+        // The probe fails both when the journal table is missing and when the
+        // database itself is unreachable. Only the former means "no journal yet";
+        // rethrow connection/auth failures via a table-independent query.
+        await driver.execute({
+            operation: {
+                kind: 'raw',
+                sql: rawSql('select 1'),
+            },
+        });
         return false;
     }
 }
-export async function loadJournalRows(adapter, tableName) {
-    let result = await adapter.execute({
+export async function loadJournalRows(driver, tableName) {
+    let result = await driver.execute({
         operation: {
             kind: 'raw',
             sql: rawSql('select id, name, checksum, batch, applied_at from ' + tableName + ' order by id asc'),
@@ -51,8 +60,8 @@ export async function loadJournalRows(adapter, tableName) {
         appliedAt: new Date(String(row.applied_at)),
     }));
 }
-export async function insertJournalRow(adapter, tableName, row, transaction) {
-    await adapter.execute({
+export async function insertJournalRow(driver, tableName, row, transaction) {
+    await driver.execute({
         operation: {
             kind: 'raw',
             sql: rawSql('insert into ' + tableName + ' (id, name, checksum, batch) values (?, ?, ?, ?)', [
@@ -65,8 +74,8 @@ export async function insertJournalRow(adapter, tableName, row, transaction) {
         transaction,
     });
 }
-export async function deleteJournalRow(adapter, tableName, id, transaction) {
-    await adapter.execute({
+export async function deleteJournalRow(driver, tableName, id, transaction) {
+    await driver.execute({
         operation: {
             kind: 'raw',
             sql: rawSql('delete from ' + tableName + ' where id = ?', [id]),

package/dist/lib/migrations/registry.d.ts

@@ -20,7 +20,7 @@ export declare function resolveMigrations(input: MigrationDescriptor[] | Migrati
  * import { createMigrationRegistry } from 'remix/data-table/migrations'
  *
  * let registry = createMigrationRegistry()
- * registry.register({ id, name, migration })
+ * registry.register({ id, name, up, down })
  * ```
  */
 export declare function createMigrationRegistry(initial?: MigrationDescriptor[]): MigrationRegistry;

package/dist/lib/migrations/registry.js

@@ -26,7 +26,7 @@ export function resolveMigrations(input) {
  * import { createMigrationRegistry } from 'remix/data-table/migrations'
  *
  * let registry = createMigrationRegistry()
- * registry.register({ id, name, migration })
+ * registry.register({ id, name, up, down })
  * ```
  */
 export function createMigrationRegistry(initial = []) {

package/dist/lib/migrations/runner.d.ts

@@ -1,20 +1,13 @@
-import type { DatabaseAdapter } from '../adapter.ts';
-import type { MigrationDescriptor, MigrationRegistry, MigrationRunner, MigrationRunnerOptions } from '../migrations.ts';
-/**
- * Creates a migration runner for applying/reverting migrations against an adapter.
- * @param adapter Database adapter used to compile and execute migration operations.
- * @param migrations Migration descriptors or registry.
- * @param options Optional runner configuration.
- * @returns A migration runner instance.
- * @example
- * ```ts
- * import { createMigrationRunner } from 'remix/data-table/migrations'
- *
- * let runner = createMigrationRunner(adapter, migrations, {
- *   journalTable: 'app_migrations',
- * })
- * await runner.up()
- * ```
- */
-export declare function createMigrationRunner(adapter: DatabaseAdapter, migrations: MigrationDescriptor[] | MigrationRegistry, options?: MigrationRunnerOptions): MigrationRunner;
+import type { DatabaseDriver } from '../driver.ts';
+import type { MigrationOperationOptions, MigrateResult, MigrationDescriptor, MigrationRegistry, MigrationStatusEntry } from '../migrations.ts';
+interface MigrationRunnerOptions {
+    journalTable?: string;
+}
+interface MigrationRunner {
+    up(options?: MigrationOperationOptions): Promise<MigrateResult>;
+    down(options?: MigrationOperationOptions): Promise<MigrateResult>;
+    status(): Promise<MigrationStatusEntry[]>;
+}
+export declare function createMigrationRunner(driver: DatabaseDriver, migrations: MigrationDescriptor[] | MigrationRegistry, options?: MigrationRunnerOptions): MigrationRunner;
+export {};
 //# sourceMappingURL=runner.d.ts.map

package/dist/lib/migrations/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../../src/lib/migrations/runner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAoB,MAAM,eAAe,CAAA;AAEtE,OAAO,KAAK,EAIV,mBAAmB,EAGnB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EAGvB,MAAM,kBAAkB,CAAA;AAyRzB;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,mBAAmB,EAAE,GAAG,iBAAiB,EACrD,OAAO,GAAE,sBAA2B,GACnC,eAAe,CAwDjB"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../../src/lib/migrations/runner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAoB,MAAM,cAAc,CAAA;AACpE,OAAO,KAAK,EACV,yBAAyB,EACzB,aAAa,EACb,mBAAmB,EAGnB,iBAAiB,EAEjB,oBAAoB,EAErB,MAAM,kBAAkB,CAAA;AAEzB,UAAU,sBAAsB;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,UAAU,eAAe;IACvB,EAAE,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAC/D,IAAI,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IACjE,MAAM,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;CAC1C;AAkSD,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,mBAAmB,EAAE,GAAG,iBAAiB,EACrD,OAAO,GAAE,sBAA2B,GACnC,eAAe,CA6EjB"}