@kequtech/tenon-orm 0.3.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kequtech/tenon-orm",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "license": "ISC",
   "type": "module",
   "description": "A PostgreSQL ORM designed for coding agents, with explicit SQL, typed queries, and migrations",
@@ -28,6 +28,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./check": {
+      "types": "./dist/check.d.ts",
+      "import": "./dist/check.js"
     }
   },
   "files": [
@@ -53,21 +57,21 @@
     "format:check": "prettier --check .",
     "benchmark": "npm run build && node scripts/benchmark.mjs"
   },
-  "dependencies": {
-    "pg": "8.23.1",
-    "@types/pg": "8.23.1"
-  },
   "devDependencies": {
+    "@js-temporal/polyfill": "^0.5.1",
     "@types/node": "^24.19.2",
     "prettier": "^3.9.10",
-    "typescript": "~6.0.2",
     "typescript-next": "npm:typescript@^7.0.2"
   },
   "bin": {
-    "tenon": "./dist/cli.js"
+    "tenon": "dist/cli.js"
   },
   "prettier": {
     "singleQuote": true,
     "printWidth": 100
+  },
+  "dependencies": {
+    "@kequtech/pgclear": "^0.3.0",
+    "typescript": "~6.0.2"
   }
 }

package/dist/driver/types.d.ts

@@ -1,10 +0,0 @@
-/** pg default representations, shared by generation and query inspection. */
-export type ValueTypes = Readonly<{
-    read: string;
-    write: string;
-}>;
-type TypeMapping = string | ValueTypes;
-export declare const arrayTypes: Readonly<Record<string, TypeMapping>>;
-export declare const scalarTypes: Readonly<Record<string, TypeMapping>>;
-export declare function valueTypes(mapping: TypeMapping): ValueTypes;
-export {};

package/dist/driver/types.js

@@ -1,49 +0,0 @@
-// Arrays use verified built-in OIDs: their parsers can differ from scalar parsers.
-export const arrayTypes = {
-    '1000': 'boolean',
-    '1001': 'import("node:buffer").Buffer',
-    '1005': 'number',
-    '1007': 'number',
-    '1021': 'number',
-    '1022': 'number',
-    '1028': 'number',
-    '1016': { read: 'string', write: 'string | bigint' },
-    '1231': { read: 'number', write: 'string | number' },
-    '1009': 'string',
-    '1014': 'string',
-    '1015': 'string',
-    '1183': 'string',
-    '1270': 'string',
-    '2951': 'string',
-    '1182': { read: 'globalThis.Date | number', write: 'globalThis.Date | string' },
-    '1115': { read: 'globalThis.Date | number', write: 'globalThis.Date | string' },
-    '1185': { read: 'globalThis.Date | number', write: 'globalThis.Date | string' },
-    '199': { read: 'unknown', write: 'string' },
-    '3807': { read: 'unknown', write: 'string' },
-};
-export const scalarTypes = {
-    int2: 'number',
-    int4: 'number',
-    oid: 'number',
-    float4: 'number',
-    float8: 'number',
-    bool: 'boolean',
-    text: 'string',
-    name: 'string',
-    varchar: 'string',
-    bpchar: 'string',
-    time: 'string',
-    timetz: 'string',
-    uuid: 'string',
-    date: { read: 'globalThis.Date | number', write: 'globalThis.Date | string' },
-    timestamp: { read: 'globalThis.Date | number', write: 'globalThis.Date | string' },
-    timestamptz: { read: 'globalThis.Date | number', write: 'globalThis.Date | string' },
-    int8: { read: 'string', write: 'string | bigint' },
-    numeric: { read: 'string', write: 'string | number' },
-    json: { read: 'unknown', write: 'string' },
-    jsonb: { read: 'unknown', write: 'string' },
-    bytea: 'import("node:buffer").Buffer',
-};
-export function valueTypes(mapping) {
-    return typeof mapping === 'string' ? { read: mapping, write: mapping } : mapping;
-}

package/dist/generation/table-types.d.ts

@@ -1,2 +0,0 @@
-import type { TableRow } from './catalog.js';
-export declare function renderTableTypes(tables: readonly TableRow[], namespace: string, onWarning: (message: string) => void): string;

package/dist/generation/table-types.js

@@ -1,96 +0,0 @@
-import { arrayTypes, scalarTypes, valueTypes } from '../driver/types.js';
-// Every generated table remains accessible through Rows["exact SQL name"].
-const reservedTypeNames = new Set(`
-  as await break case catch class const continue debugger default delete do else enum
-  export extends false finally for function if implements import in instanceof
-  interface let new null package private protected public return static super
-  switch this throw true try typeof var void while with yield any bigint boolean
-  intrinsic never number object string symbol undefined unknown
-  Rows globalThis PgArray
-`
-    .trim()
-    .split(/\s+/));
-function canExportRowName(name) {
-    return (/^[$_\p{ID_Start}][$_\u200c\u200d\p{ID_Continue}]*$/u.test(name) && !reservedTypeNames.has(name));
-}
-function isSupportedArray(value) {
-    return Object.hasOwn(arrayTypes, value.oid);
-}
-function columnTypes(value, column, onWarning) {
-    let types;
-    if (isSupportedArray(value)) {
-        const element = valueTypes(arrayTypes[value.oid]);
-        types = { read: `PgArray<${element.read}>`, write: `PgArray<${element.write}>` };
-    }
-    else if (value.typeKind === 'e') {
-        const choice = value.choices?.map((choice) => JSON.stringify(choice)).join(' | ') || 'never';
-        types = { read: choice, write: choice };
-    }
-    else {
-        const type = value.typeSchema === 'pg_catalog' && Object.hasOwn(scalarTypes, value.type)
-            ? scalarTypes[value.type]
-            : undefined;
-        if (type) {
-            types = valueTypes(type);
-        }
-        else {
-            const underlying = value.declaredOid === value.oid
-                ? ''
-                : ` with underlying type ${JSON.stringify(value.typeSchema)}.${JSON.stringify(value.type)} (OID ${value.oid})`;
-            onWarning(`Column ${column} uses PostgreSQL type ${JSON.stringify(value.declaredSchema)}.${JSON.stringify(value.declaredType)} (OID ${value.declaredOid})${underlying} without a verified pg mapping; generated as unknown for reads and never for non-null writes.`);
-            types = { read: 'unknown', write: 'never' };
-        }
-    }
-    // unknown already includes null, including for nullable JSON and unmapped types.
-    return {
-        read: `${types.read}${value.nullable && types.read !== 'unknown' ? ' | null' : ''}`,
-        write: `${types.write}${value.writeNullable ? ' | null' : ''}`,
-    };
-}
-export function renderTableTypes(tables, namespace, onWarning) {
-    const definitions = tables.map((table) => {
-        const tableName = JSON.stringify(table.name);
-        const columns = table.columns.map((column) => {
-            const columnName = JSON.stringify(column.name);
-            const path = `${JSON.stringify(namespace)}.${tableName}.${columnName}`;
-            const types = columnTypes(column, path, onWarning);
-            const requiredOnInsert = column.writable && !column.hasDefault && !column.writeNullable;
-            const optionalInputType = column.writable ? `${types.write} | undefined` : 'never';
-            return {
-                row: `    ${columnName}: ${types.read};`,
-                insert: `    ${columnName}${requiredOnInsert ? '' : '?'}: ${requiredOnInsert ? types.write : optionalInputType};`,
-                update: `    ${columnName}?: ${optionalInputType};`,
-            };
-        });
-        return { tableName, columns };
-    });
-    const render = (kind, indent = '') => definitions
-        .map(({ tableName, columns }) => `${indent}  ${tableName}: {
-${columns.map((column) => indent + column[kind]).join('\n')}
-${indent}  };`)
-        .join('\n');
-    const aliases = tables
-        .filter((table) => canExportRowName(table.name))
-        .map((table) => `export type ${table.name} = Rows[${JSON.stringify(table.name)}];`);
-    const arrays = tables.some((table) => table.columns.some(isSupportedArray))
-        ? 'export type PgArray<T> = (T | null | PgArray<T>)[];\n\n'
-        : '';
-    return `${arrays}// Full database rows. Compose query types with Pick, indexed access, and intersections.
-export type Rows = {
-${render('row')}
-};
-
-export declare namespace Rows {
-  // Bound inputs for sql.insertValues. Missing/undefined fields use database defaults.
-  type Insert = {
-${render('insert', '  ')}
-  };
-
-  // Bound inputs for sql.assignments. Missing/undefined fields are omitted.
-  type Update = {
-${render('update', '  ')}
-  };
-}
-${aliases.join('\n')}
-`;
-}

package/dist/inspection/protocol.d.ts

@@ -1,7 +0,0 @@
-import type { Client, FieldDef } from 'pg';
-export interface Description {
-    parameters: number[];
-    fields: FieldDef[];
-}
-/** Describe through pg custom query dispatch; send no Bind or Execute messages. */
-export declare function describe(client: Client, text: string): Promise<Description>;

package/dist/inspection/protocol.js

@@ -1,45 +0,0 @@
-/** Describe through pg custom query dispatch; send no Bind or Execute messages. */
-export function describe(client, text) {
-    return new Promise((resolve, reject) => {
-        let connection;
-        const description = { parameters: [], fields: [] };
-        const parameters = (message) => {
-            description.parameters = message.dataTypeIDs;
-        };
-        const cleanup = () => connection?.removeListener('parameterDescription', parameters);
-        const query = {
-            // pg wraps callback to manage query_timeout, including clearing its timer.
-            callback(error) {
-                cleanup();
-                if (error)
-                    reject(error);
-                else
-                    resolve(description);
-            },
-            submit(wire) {
-                connection = wire;
-                wire.once('parameterDescription', parameters);
-                try {
-                    wire.parse({ name: '', text, types: [] }, false);
-                    wire.describe({ type: 'S', name: '' }, false);
-                    wire.sync();
-                }
-                catch (error) {
-                    return error instanceof Error
-                        ? error
-                        : new Error('Describe dispatch failed', { cause: error });
-                }
-            },
-            handleRowDescription(message) {
-                description.fields = message.fields;
-            },
-            handleReadyForQuery() {
-                query.callback(null);
-            },
-            handleError(error) {
-                query.callback(error);
-            },
-        };
-        client.query(query);
-    });
-}