@remix-run/data-table-postgres 0.0.0 → 0.1.0

package/dist/lib/sql-compiler.js

@@ -0,0 +1,392 @@
+import { getTableName, getTablePrimaryKey } from '@remix-run/data-table';
+export function compilePostgresStatement(statement) {
+    if (statement.kind === 'raw') {
+        return compileRawStatement(statement.sql);
+    }
+    let context = { values: [] };
+    if (statement.kind === 'select') {
+        let selection = '*';
+        if (statement.select !== '*') {
+            selection = statement.select
+                .map((field) => quotePath(field.column) + ' as ' + quoteIdentifier(field.alias))
+                .join(', ');
+        }
+        let text = 'select ' +
+            (statement.distinct ? 'distinct ' : '') +
+            selection +
+            compileFromClause(statement.table, statement.joins, context) +
+            compileWhereClause(statement.where, context) +
+            compileGroupByClause(statement.groupBy) +
+            compileHavingClause(statement.having, context) +
+            compileOrderByClause(statement.orderBy) +
+            compileLimitClause(statement.limit) +
+            compileOffsetClause(statement.offset);
+        return {
+            text,
+            values: context.values,
+        };
+    }
+    if (statement.kind === 'count' || statement.kind === 'exists') {
+        let inner = 'select 1' +
+            compileFromClause(statement.table, statement.joins, context) +
+            compileWhereClause(statement.where, context) +
+            compileGroupByClause(statement.groupBy) +
+            compileHavingClause(statement.having, context);
+        return {
+            text: 'select count(*) as ' +
+                quoteIdentifier('count') +
+                ' from (' +
+                inner +
+                ') as ' +
+                quoteIdentifier('__dt_count'),
+            values: context.values,
+        };
+    }
+    if (statement.kind === 'insert') {
+        return compileInsertStatement(statement.table, statement.values, statement.returning, context);
+    }
+    if (statement.kind === 'insertMany') {
+        return compileInsertManyStatement(statement.table, statement.values, statement.returning, context);
+    }
+    if (statement.kind === 'update') {
+        let changes = Object.keys(statement.changes);
+        let assignments = changes
+            .map((column) => quotePath(column) + ' = ' + pushValue(context, statement.changes[column]))
+            .join(', ');
+        return {
+            text: 'update ' +
+                quotePath(getTableName(statement.table)) +
+                ' set ' +
+                assignments +
+                compileWhereClause(statement.where, context) +
+                compileReturningClause(statement.returning),
+            values: context.values,
+        };
+    }
+    if (statement.kind === 'delete') {
+        return {
+            text: 'delete from ' +
+                quotePath(getTableName(statement.table)) +
+                compileWhereClause(statement.where, context) +
+                compileReturningClause(statement.returning),
+            values: context.values,
+        };
+    }
+    if (statement.kind === 'upsert') {
+        return compileUpsertStatement(statement, context);
+    }
+    throw new Error('Unsupported statement kind');
+}
+function compileInsertStatement(table, values, returning, context) {
+    let columns = Object.keys(values);
+    if (columns.length === 0) {
+        return {
+            text: 'insert into ' +
+                quotePath(getTableName(table)) +
+                ' default values' +
+                compileReturningClause(returning),
+            values: context.values,
+        };
+    }
+    let quotedColumns = columns.map((column) => quotePath(column));
+    let placeholders = columns.map((column) => pushValue(context, values[column]));
+    return {
+        text: 'insert into ' +
+            quotePath(getTableName(table)) +
+            ' (' +
+            quotedColumns.join(', ') +
+            ') values (' +
+            placeholders.join(', ') +
+            ')' +
+            compileReturningClause(returning),
+        values: context.values,
+    };
+}
+function compileInsertManyStatement(table, rows, returning, context) {
+    if (rows.length === 0) {
+        return {
+            text: 'select 0 where 1 = 0',
+            values: context.values,
+        };
+    }
+    let columns = collectColumns(rows);
+    if (columns.length === 0) {
+        return {
+            text: 'insert into ' +
+                quotePath(getTableName(table)) +
+                ' default values' +
+                compileReturningClause(returning),
+            values: context.values,
+        };
+    }
+    let quotedColumns = columns.map((column) => quotePath(column));
+    let valueSets = rows.map((row) => {
+        let placeholders = columns.map((column) => {
+            let value = Object.prototype.hasOwnProperty.call(row, column) ? row[column] : null;
+            return pushValue(context, value);
+        });
+        return '(' + placeholders.join(', ') + ')';
+    });
+    return {
+        text: 'insert into ' +
+            quotePath(getTableName(table)) +
+            ' (' +
+            quotedColumns.join(', ') +
+            ') values ' +
+            valueSets.join(', ') +
+            compileReturningClause(returning),
+        values: context.values,
+    };
+}
+function compileUpsertStatement(statement, context) {
+    let insertColumns = Object.keys(statement.values);
+    let conflictTarget = statement.conflictTarget ?? [...getTablePrimaryKey(statement.table)];
+    if (insertColumns.length === 0) {
+        throw new Error('upsert requires at least one value');
+    }
+    let quotedInsertColumns = insertColumns.map((column) => quotePath(column));
+    let insertPlaceholders = insertColumns.map((column) => pushValue(context, statement.values[column]));
+    let updateValues = statement.update ?? statement.values;
+    let updateColumns = Object.keys(updateValues);
+    let onConflictClause = '';
+    if (updateColumns.length === 0) {
+        onConflictClause =
+            ' on conflict (' +
+                conflictTarget.map((column) => quotePath(column)).join(', ') +
+                ') do nothing';
+    }
+    else {
+        onConflictClause =
+            ' on conflict (' +
+                conflictTarget.map((column) => quotePath(column)).join(', ') +
+                ') do update set ' +
+                updateColumns
+                    .map((column) => quotePath(column) + ' = ' + pushValue(context, updateValues[column]))
+                    .join(', ');
+    }
+    return {
+        text: 'insert into ' +
+            quotePath(getTableName(statement.table)) +
+            ' (' +
+            quotedInsertColumns.join(', ') +
+            ') values (' +
+            insertPlaceholders.join(', ') +
+            ')' +
+            onConflictClause +
+            compileReturningClause(statement.returning),
+        values: context.values,
+    };
+}
+function compileRawStatement(statement) {
+    if (!statement.text.includes('?')) {
+        return {
+            text: statement.text,
+            values: [...statement.values],
+        };
+    }
+    let index = 1;
+    let text = statement.text.replace(/\?/g, function replaceParameter() {
+        let placeholder = '$' + String(index);
+        index += 1;
+        return placeholder;
+    });
+    return {
+        text,
+        values: [...statement.values],
+    };
+}
+function compileFromClause(table, joins, context) {
+    let output = ' from ' + quotePath(getTableName(table));
+    for (let join of joins) {
+        output +=
+            ' ' +
+                normalizeJoinType(join.type) +
+                ' join ' +
+                quotePath(getTableName(join.table)) +
+                ' on ' +
+                compilePredicate(join.on, context);
+    }
+    return output;
+}
+function compileWhereClause(predicates, context) {
+    if (predicates.length === 0) {
+        return '';
+    }
+    let where = predicates
+        .map((predicate) => '(' + compilePredicate(predicate, context) + ')')
+        .join(' and ');
+    return ' where ' + where;
+}
+function compileGroupByClause(columns) {
+    if (columns.length === 0) {
+        return '';
+    }
+    return ' group by ' + columns.map((column) => quotePath(column)).join(', ');
+}
+function compileHavingClause(predicates, context) {
+    if (predicates.length === 0) {
+        return '';
+    }
+    let having = predicates
+        .map((predicate) => '(' + compilePredicate(predicate, context) + ')')
+        .join(' and ');
+    return ' having ' + having;
+}
+function compileOrderByClause(orderBy) {
+    if (orderBy.length === 0) {
+        return '';
+    }
+    return (' order by ' +
+        orderBy
+            .map((clause) => quotePath(clause.column) + ' ' + clause.direction.toUpperCase())
+            .join(', '));
+}
+function compileLimitClause(limit) {
+    if (limit === undefined) {
+        return '';
+    }
+    return ' limit ' + String(limit);
+}
+function compileOffsetClause(offset) {
+    if (offset === undefined) {
+        return '';
+    }
+    return ' offset ' + String(offset);
+}
+function compileReturningClause(returning) {
+    if (!returning) {
+        return '';
+    }
+    if (returning === '*') {
+        return ' returning *';
+    }
+    return ' returning ' + returning.map((column) => quotePath(column)).join(', ');
+}
+function compilePredicate(predicate, context) {
+    if (predicate.type === 'comparison') {
+        let column = quotePath(predicate.column);
+        if (predicate.operator === 'eq') {
+            if (predicate.valueType === 'value' &&
+                (predicate.value === null || predicate.value === undefined)) {
+                return column + ' is null';
+            }
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' = ' + comparisonValue;
+        }
+        if (predicate.operator === 'ne') {
+            if (predicate.valueType === 'value' &&
+                (predicate.value === null || predicate.value === undefined)) {
+                return column + ' is not null';
+            }
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' <> ' + comparisonValue;
+        }
+        if (predicate.operator === 'gt') {
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' > ' + comparisonValue;
+        }
+        if (predicate.operator === 'gte') {
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' >= ' + comparisonValue;
+        }
+        if (predicate.operator === 'lt') {
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' < ' + comparisonValue;
+        }
+        if (predicate.operator === 'lte') {
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' <= ' + comparisonValue;
+        }
+        if (predicate.operator === 'in' || predicate.operator === 'notIn') {
+            let values = Array.isArray(predicate.value) ? predicate.value : [];
+            if (values.length === 0) {
+                return predicate.operator === 'in' ? '1 = 0' : '1 = 1';
+            }
+            let placeholders = values.map((value) => pushValue(context, value));
+            let keyword = predicate.operator === 'in' ? 'in' : 'not in';
+            return column + ' ' + keyword + ' (' + placeholders.join(', ') + ')';
+        }
+        if (predicate.operator === 'like') {
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' like ' + comparisonValue;
+        }
+        if (predicate.operator === 'ilike') {
+            let comparisonValue = compileComparisonValue(predicate, context);
+            return column + ' ilike ' + comparisonValue;
+        }
+    }
+    if (predicate.type === 'between') {
+        return (quotePath(predicate.column) +
+            ' between ' +
+            pushValue(context, predicate.lower) +
+            ' and ' +
+            pushValue(context, predicate.upper));
+    }
+    if (predicate.type === 'null') {
+        return (quotePath(predicate.column) + (predicate.operator === 'isNull' ? ' is null' : ' is not null'));
+    }
+    if (predicate.type === 'logical') {
+        if (predicate.predicates.length === 0) {
+            return predicate.operator === 'and' ? '1 = 1' : '1 = 0';
+        }
+        let childOperator = predicate.operator === 'and' ? ' and ' : ' or ';
+        let childPredicates = predicate.predicates
+            .map((child) => '(' + compilePredicate(child, context) + ')')
+            .join(childOperator);
+        return childPredicates;
+    }
+    throw new Error('Unsupported predicate');
+}
+function compileComparisonValue(predicate, context) {
+    if (predicate.valueType === 'column') {
+        return quotePath(predicate.value);
+    }
+    return pushValue(context, predicate.value);
+}
+function normalizeJoinType(type) {
+    if (type === 'left') {
+        return 'left';
+    }
+    if (type === 'right') {
+        return 'right';
+    }
+    return 'inner';
+}
+function quoteIdentifier(value) {
+    return '"' + value.replace(/"/g, '""') + '"';
+}
+function quotePath(path) {
+    if (path === '*') {
+        return '*';
+    }
+    let segments = path.split('.');
+    return segments
+        .map((segment) => {
+        if (segment === '*') {
+            return '*';
+        }
+        return quoteIdentifier(segment);
+    })
+        .join('.');
+}
+function pushValue(context, value) {
+    context.values.push(value);
+    return '$' + String(context.values.length);
+}
+function collectColumns(rows) {
+    let columns = [];
+    let seen = new Set();
+    for (let row of rows) {
+        for (let key in row) {
+            if (!Object.prototype.hasOwnProperty.call(row, key)) {
+                continue;
+            }
+            if (seen.has(key)) {
+                continue;
+            }
+            seen.add(key);
+            columns.push(key);
+        }
+    }
+    return columns;
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@remix-run/data-table-postgres",
-  "version": "0.0.0",
-  "private": false,
-  "description": "Placeholder package for future Remix data-table-postgres APIs",
+  "version": "0.1.0",
+  "description": "PostgreSQL adapter for @remix-run/data-table",
+  "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -10,11 +10,53 @@
     "directory": "packages/data-table-postgres"
   },
   "homepage": "https://github.com/remix-run/remix/tree/main/packages/data-table-postgres#readme",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "dist",
+    "src",
+    "!src/**/*.test.ts"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "devDependencies": {
+    "@types/node": "^24.6.0",
+    "@types/pg": "^8.15.6",
+    "@typescript/native-preview": "7.0.0-dev.20251125.1",
+    "pg": "^8.16.3",
+    "@remix-run/data-schema": "0.1.0",
+    "@remix-run/data-table": "0.1.0"
+  },
+  "dependencies": {
+    "@remix-run/data-table": "^0.1.0"
+  },
+  "peerDependencies": {
+    "pg": "^8.16.3"
+  },
+  "peerDependenciesMeta": {
+    "pg": {
+      "optional": true
+    }
+  },
   "keywords": [
     "remix",
-    "placeholder"
+    "orm",
+    "postgres",
+    "database",
+    "sql"
   ],
-  "publishConfig": {
-    "access": "public"
+  "scripts": {
+    "build": "tsgo -p tsconfig.build.json",
+    "clean": "git clean -fdX",
+    "test": "node --disable-warning=ExperimentalWarning --test",
+    "test:coverage": "node --disable-warning=ExperimentalWarning --experimental-test-coverage --test-coverage-include='src/**/*.ts' --test-coverage-lines=90 --test-coverage-branches=90 --test-coverage-functions=90 --test ./src/lib/adapter.test.ts ./src/lib/sql-compiler.test.ts",
+    "typecheck": "tsgo --noEmit"
   }
-}
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+export type {
+  PostgresDatabaseAdapterOptions,
+  PostgresDatabaseClient,
+  PostgresDatabasePool,
+  PostgresQueryResult,
+  PostgresTransactionClient,
+} from './lib/adapter.ts'
+export { createPostgresDatabaseAdapter, PostgresDatabaseAdapter } from './lib/adapter.ts'