@remix-run/data-table-postgres 0.4.0 → 0.5.1

package/src/lib/sql-compiler.ts

@@ -1,5 +1,6 @@
 import { getTableName, getTablePrimaryKey } from '@remix-run/data-table'
-import type { DataManipulationOperation, Predicate, SqlStatement } from '@remix-run/data-table'
+import type { Predicate, SqlStatement } from '@remix-run/data-table'
+import type { DataManipulationOperation } from '@remix-run/data-table'
 import {
   collectColumns as collectColumnsHelper,
   normalizeJoinType as normalizeJoinTypeHelper,
@@ -39,8 +40,8 @@ export function compilePostgresOperation(operation: DataManipulationOperation):
       compileGroupByClause(operation.groupBy) +
       compileHavingClause(operation.having, context) +
       compileOrderByClause(operation.orderBy) +
-      compileLimitClause(operation.limit) +
-      compileOffsetClause(operation.offset)
+      compileLimitClause(operation.limit, context) +
+      compileOffsetClause(operation.offset, context)
 
     return {
       text,
@@ -555,20 +556,20 @@ function compileOrderByClause(orderBy: { column: string; direction: 'asc' | 'des
   )
 }
 
-function compileLimitClause(limit: number | undefined): string {
+function compileLimitClause(limit: number | undefined, context: CompileContext): string {
   if (limit === undefined) {
     return ''
   }
 
-  return ' limit ' + String(limit)
+  return ' limit ' + pushValue(context, limit)
 }
 
-function compileOffsetClause(offset: number | undefined): string {
+function compileOffsetClause(offset: number | undefined, context: CompileContext): string {
   if (offset === undefined) {
     return ''
   }
 
-  return ' offset ' + String(offset)
+  return ' offset ' + pushValue(context, offset)
 }
 
 function compileReturningClause(returning: '*' | string[] | undefined): string {

package/dist/lib/adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/lib/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,KAAK,EACV,MAAM,IAAI,cAAc,EACxB,IAAI,IAAI,YAAY,EACpB,UAAU,IAAI,kBAAkB,EACjC,MAAM,IAAI,CAAA;AASX,KAAK,iBAAiB,GAAG,cAAc,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAE3E;;GAEG;AACH,qBAAa,uBAAwB,YAAW,eAAe;;IAC7D;;OAEG;IACH,OAAO,SAAa;IAEpB;;OAEG;IACH,YAAY;;;;;;MAAA;IAMZ,YAAY,MAAM,EAAE,iBAAiB,EASpC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAS,EAAE,yBAAyB,GAAG,YAAY,EAAE,CAG/D;IAED;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAuB/E;IAED;;;;;;;;OAQG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;IAED;;;;;OAKG;IACG,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAMhF;IAED;;;;;;OAMG;IACG,SAAS,CACb,KAAK,EAAE,QAAQ,EACf,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,OAAO,CAAC,CASlB;IAED;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA0B9E;IAED;;;;OAIG;IACG,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9D;IAED;;;;OAIG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBhE;IAED;;;;;OAKG;IACG,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAED;;;;;OAKG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;IAED;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;IAED;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;CAmBF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,MAAM,EAAE,iBAAiB,GAAG,uBAAuB,CAEhG"}

package/dist/lib/adapter.js

@@ -1,343 +0,0 @@
-import { getTablePrimaryKey } from '@remix-run/data-table';
-import { compilePostgresOperation } from "./sql-compiler.js";
-/**
- * `DatabaseAdapter` implementation for postgres-compatible clients.
- */
-export class PostgresDatabaseAdapter {
-    /**
-     * The SQL dialect identifier reported by this adapter.
-     */
-    dialect = 'postgres';
-    /**
-     * Feature flags describing the postgres behaviors supported by this adapter.
-     */
-    capabilities;
-    #client;
-    #transactions = new Map();
-    #transactionCounter = 0;
-    constructor(client) {
-        this.#client = client;
-        this.capabilities = {
-            returning: true,
-            savepoints: true,
-            upsert: true,
-            transactionalDdl: true,
-            migrationLock: true,
-        };
-    }
-    /**
-     * Compiles a data-manipulation operation to postgres SQL statements.
-     * @param operation Operation to compile.
-     * @returns Compiled SQL statements.
-     */
-    compileSql(operation) {
-        let compiled = compilePostgresOperation(operation);
-        return [{ text: compiled.text, values: compiled.values }];
-    }
-    /**
-     * Executes a postgres data-manipulation request.
-     * @param request Request to execute.
-     * @returns Execution result.
-     */
-    async execute(request) {
-        if (request.operation.kind === 'insertMany' && request.operation.values.length === 0) {
-            return {
-                affectedRows: 0,
-                insertId: undefined,
-                rows: request.operation.returning ? [] : undefined,
-            };
-        }
-        let statement = compilePostgresOperation(request.operation);
-        let client = this.#resolveClient(request.transaction);
-        let result = await client.query(statement.text, statement.values);
-        let rows = normalizeRows(result.rows);
-        if (request.operation.kind === 'count' || request.operation.kind === 'exists') {
-            rows = normalizeCountRows(rows);
-        }
-        return {
-            rows,
-            affectedRows: normalizeAffectedRows(request.operation.kind, result.rowCount, rows),
-            insertId: normalizeInsertId(request.operation.kind, request.operation, rows),
-        };
-    }
-    /**
-     * Executes a multi-statement postgres SQL script.
-     *
-     * Postgres natively supports multi-statement scripts when `query` is called
-     * without a parameter array.
-     * @param sql SQL script to execute.
-     * @param transaction Optional transaction token.
-     * @returns A promise that resolves once execution completes.
-     */
-    async executeScript(sql, transaction) {
-        let client = this.#resolveClient(transaction);
-        await client.query(sql);
-    }
-    /**
-     * Checks whether a table exists in postgres.
-     * @param table Table reference to inspect.
-     * @param transaction Optional transaction token.
-     * @returns `true` when the table exists.
-     */
-    async hasTable(table, transaction) {
-        let relation = toPostgresRelationName(table);
-        let client = this.#resolveClient(transaction);
-        let result = await client.query('select to_regclass($1) is not null as "exists"', [relation]);
-        let row = result.rows[0];
-        return toBooleanExists(row?.exists);
-    }
-    /**
-     * Checks whether a column exists in postgres.
-     * @param table Table reference to inspect.
-     * @param column Column name to look up.
-     * @param transaction Optional transaction token.
-     * @returns `true` when the column exists.
-     */
-    async hasColumn(table, column, transaction) {
-        let relation = toPostgresRelationName(table);
-        let client = this.#resolveClient(transaction);
-        let result = await client.query('select exists (select 1 from pg_attribute where attrelid = to_regclass($1) and attname = $2 and attnum > 0 and not attisdropped) as "exists"', [relation, column]);
-        let row = result.rows[0];
-        return toBooleanExists(row?.exists);
-    }
-    /**
-     * Starts a postgres transaction.
-     * @param options Transaction options.
-     * @returns Transaction token.
-     */
-    async beginTransaction(options) {
-        let releaseOnClose = false;
-        let transactionClient;
-        if (isPostgresPool(this.#client)) {
-            transactionClient = await this.#client.connect();
-            releaseOnClose = true;
-        }
-        else {
-            transactionClient = this.#client;
-        }
-        await transactionClient.query('begin');
-        if (options?.isolationLevel || options?.readOnly !== undefined) {
-            await transactionClient.query(buildSetTransactionStatement(options));
-        }
-        this.#transactionCounter += 1;
-        let token = { id: 'tx_' + String(this.#transactionCounter) };
-        this.#transactions.set(token.id, {
-            client: transactionClient,
-            releaseOnClose,
-        });
-        return token;
-    }
-    /**
-     * Commits an open postgres transaction.
-     * @param token Transaction token to commit.
-     * @returns A promise that resolves when the transaction is committed.
-     */
-    async commitTransaction(token) {
-        let transaction = this.#transactions.get(token.id);
-        if (!transaction) {
-            throw new Error('Unknown transaction token: ' + token.id);
-        }
-        try {
-            await transaction.client.query('commit');
-        }
-        finally {
-            this.#transactions.delete(token.id);
-            if (transaction.releaseOnClose) {
-                releasePostgresClient(transaction.client);
-            }
-        }
-    }
-    /**
-     * Rolls back an open postgres transaction.
-     * @param token Transaction token to roll back.
-     * @returns A promise that resolves when the transaction is rolled back.
-     */
-    async rollbackTransaction(token) {
-        let transaction = this.#transactions.get(token.id);
-        if (!transaction) {
-            throw new Error('Unknown transaction token: ' + token.id);
-        }
-        try {
-            await transaction.client.query('rollback');
-        }
-        finally {
-            this.#transactions.delete(token.id);
-            if (transaction.releaseOnClose) {
-                releasePostgresClient(transaction.client);
-            }
-        }
-    }
-    /**
-     * Creates a savepoint in an open postgres transaction.
-     * @param token Transaction token to use.
-     * @param name Savepoint name.
-     * @returns A promise that resolves when the savepoint is created.
-     */
-    async createSavepoint(token, name) {
-        let client = this.#transactionClient(token);
-        await client.query('savepoint ' + quoteIdentifier(name));
-    }
-    /**
-     * Rolls back to a savepoint in an open postgres transaction.
-     * @param token Transaction token to use.
-     * @param name Savepoint name.
-     * @returns A promise that resolves when the rollback completes.
-     */
-    async rollbackToSavepoint(token, name) {
-        let client = this.#transactionClient(token);
-        await client.query('rollback to savepoint ' + quoteIdentifier(name));
-    }
-    /**
-     * Releases a savepoint in an open postgres transaction.
-     * @param token Transaction token to use.
-     * @param name Savepoint name.
-     * @returns A promise that resolves when the savepoint is released.
-     */
-    async releaseSavepoint(token, name) {
-        let client = this.#transactionClient(token);
-        await client.query('release savepoint ' + quoteIdentifier(name));
-    }
-    /**
-     * Acquires the postgres migration lock.
-     * @returns A promise that resolves when the lock is acquired.
-     */
-    async acquireMigrationLock() {
-        await this.#client.query('select pg_advisory_lock(hashtext($1))', ['data_table_migrations']);
-    }
-    /**
-     * Releases the postgres migration lock.
-     * @returns A promise that resolves when the lock is released.
-     */
-    async releaseMigrationLock() {
-        await this.#client.query('select pg_advisory_unlock(hashtext($1))', ['data_table_migrations']);
-    }
-    #resolveClient(token) {
-        if (!token) {
-            return this.#client;
-        }
-        return this.#transactionClient(token);
-    }
-    #transactionClient(token) {
-        let transaction = this.#transactions.get(token.id);
-        if (!transaction) {
-            throw new Error('Unknown transaction token: ' + token.id);
-        }
-        return transaction.client;
-    }
-}
-/**
- * Creates a postgres `DatabaseAdapter`.
- * @param client `pg` pool or pool client.
- * @param options Optional adapter capability overrides.
- * @returns A configured postgres adapter.
- * @example
- * ```ts
- * import { Pool } from 'pg'
- * import { createDatabase } from 'remix/data-table'
- * import { createPostgresDatabaseAdapter } from 'remix/data-table/postgres'
- *
- * let pool = new Pool({ connectionString: process.env.DATABASE_URL })
- * let adapter = createPostgresDatabaseAdapter(pool)
- * let db = createDatabase(adapter)
- * ```
- */
-export function createPostgresDatabaseAdapter(client) {
-    return new PostgresDatabaseAdapter(client);
-}
-function isPostgresPool(client) {
-    return 'connect' in client && typeof client.connect === 'function';
-}
-function releasePostgresClient(client) {
-    let release = client.release;
-    release?.();
-}
-function buildSetTransactionStatement(options) {
-    let parts = ['set transaction'];
-    if (options.isolationLevel) {
-        parts.push('isolation level ' + options.isolationLevel);
-    }
-    if (options.readOnly !== undefined) {
-        parts.push(options.readOnly ? 'read only' : 'read write');
-    }
-    return parts.join(' ');
-}
-function normalizeRows(rows) {
-    return rows.map((row) => {
-        if (typeof row !== 'object' || row === null) {
-            return {};
-        }
-        return { ...row };
-    });
-}
-function normalizeCountRows(rows) {
-    return rows.map((row) => {
-        let count = row.count;
-        if (typeof count === 'string') {
-            let numeric = Number(count);
-            if (!Number.isNaN(numeric)) {
-                return {
-                    ...row,
-                    count: numeric,
-                };
-            }
-        }
-        if (typeof count === 'bigint') {
-            return {
-                ...row,
-                count: Number(count),
-            };
-        }
-        return row;
-    });
-}
-function normalizeAffectedRows(kind, rowCount, rows) {
-    if (kind === 'select' || kind === 'count' || kind === 'exists') {
-        return undefined;
-    }
-    if (rowCount !== null) {
-        return rowCount;
-    }
-    if (kind === 'raw') {
-        return undefined;
-    }
-    return rows.length;
-}
-function normalizeInsertId(kind, operation, rows) {
-    if (!isInsertOperationKind(kind) || !isInsertOperation(operation)) {
-        return undefined;
-    }
-    let primaryKey = getTablePrimaryKey(operation.table);
-    if (primaryKey.length !== 1) {
-        return undefined;
-    }
-    let key = primaryKey[0];
-    let row = rows[rows.length - 1];
-    return row ? row[key] : undefined;
-}
-function quoteIdentifier(value) {
-    return '"' + value.replace(/"/g, '""') + '"';
-}
-function toPostgresRelationName(table) {
-    if (table.schema) {
-        return quoteIdentifier(table.schema) + '.' + quoteIdentifier(table.name);
-    }
-    return quoteIdentifier(table.name);
-}
-function toBooleanExists(value) {
-    if (typeof value === 'boolean') {
-        return value;
-    }
-    if (typeof value === 'number') {
-        return value > 0;
-    }
-    if (typeof value === 'string') {
-        return value === 't' || value === 'true' || value === '1';
-    }
-    return false;
-}
-function isInsertOperationKind(kind) {
-    return kind === 'insert' || kind === 'insertMany' || kind === 'upsert';
-}
-function isInsertOperation(operation) {
-    return (operation.kind === 'insert' || operation.kind === 'insertMany' || operation.kind === 'upsert');
-}