turbine-orm 0.40.1 → 0.41.0

package/dist/cjs/generate.js

@@ -11,10 +11,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = generate;
+exports.resolveImportExtension = resolveImportExtension;
+exports.detectTsconfigExtension = detectTsconfigExtension;
+exports.classifyTsconfig = classifyTsconfig;
+exports.stripJsonComments = stripJsonComments;
 exports.generateTypes = generateTypes;
 exports.generateZod = generateZod;
 exports.generateMetadata = generateMetadata;
 exports.generateIndex = generateIndex;
+exports.generatePrismaMap = generatePrismaMap;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const schema_js_1 = require("./schema.js");
@@ -56,29 +61,177 @@ function generate(options) {
         throw new Error(`Output directory must be within the project root. Got: ${outDir}`);
     }
     (0, node_fs_1.mkdirSync)(outDir, { recursive: true });
+    // F4: keep raw DB column names as field names (opt-in). Pure transform: when
+    // the flag is off `withDbFieldNames` is never called and output is unchanged.
+    const schema = options.keepColumnNames ? (0, schema_js_1.withDbFieldNames)(options.schema) : options.schema;
+    // F3: resolve which extension sibling imports get in index.ts.
+    const { ext: importExt, mode: importMode } = resolveImportExtension(outDir, options.importExtension ?? 'auto');
     const files = [];
-    const fileOptions = { noTimestamp: options.noTimestamp };
+    const fileOptions = { noTimestamp: options.noTimestamp, importExt, importMode };
     // Generate types.ts
-    const typesContent = generateTypes(options.schema, fileOptions);
+    const typesContent = generateTypes(schema, fileOptions);
     (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outDir, 'types.ts'), typesContent, 'utf-8');
     files.push('types.ts');
     // Generate metadata.ts
-    const metadataContent = generateMetadata(options.schema, fileOptions);
+    const metadataContent = generateMetadata(schema, fileOptions);
     (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outDir, 'metadata.ts'), metadataContent, 'utf-8');
     files.push('metadata.ts');
     // Generate index.ts (configured client)
-    const indexContent = generateIndex(options.schema, fileOptions);
+    const indexContent = generateIndex(schema, fileOptions);
     (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outDir, 'index.ts'), indexContent, 'utf-8');
     files.push('index.ts');
     // Generate zod.ts (optional — --zod flag)
     if (options.zod) {
-        const zodContent = generateZod(options.schema, fileOptions);
+        const zodContent = generateZod(schema, fileOptions);
         (0, node_fs_1.writeFileSync)((0, node_path_1.join)(outDir, 'zod.ts'), zodContent, 'utf-8');
         files.push('zod.ts');
     }
     return { outDir, files };
 }
 // ---------------------------------------------------------------------------
+// Import-extension resolution (F3)
+// ---------------------------------------------------------------------------
+/**
+ * Resolve the requested {@link GenerateOptions.importExtension} to the concrete
+ * extension string used on `index.ts`'s sibling imports plus a human-readable
+ * mode label for the generated comment.
+ *
+ *   - `'js'`   → `.js`
+ *   - `'none'` → `''`
+ *   - `'auto'` → tsconfig-driven ({@link detectTsconfigExtension}); falls back
+ *     to `.js` (the pre-0.41 default) when detection is uncertain, so NodeNext
+ *     consumers can never regress.
+ */
+function resolveImportExtension(outDir, requested) {
+    if (requested === 'js')
+        return { ext: '.js', mode: 'js' };
+    if (requested === 'none')
+        return { ext: '', mode: 'none' };
+    const detected = detectTsconfigExtension((0, node_path_1.resolve)(outDir));
+    if (detected === 'js')
+        return { ext: '.js', mode: 'auto (nodenext → .js)' };
+    if (detected === 'none')
+        return { ext: '', mode: 'auto (bundler → no extension)' };
+    return { ext: '.js', mode: 'auto (fallback → .js)' };
+}
+/**
+ * Walk up from `startDir` to the nearest `tsconfig.json` and classify its module
+ * resolution. Does NOT follow `extends` chains (a monorepo whose base config
+ * sets `moduleResolution` needs the explicit flag). Returns:
+ *   - `'js'`: `module`/`moduleResolution` is `node16`/`nodenext`;
+ *   - `'none'`: both fields present and neither is node16/nodenext (bundler,
+ *     node, node10, classic, esnext, commonjs, preserve);
+ *   - `null`: no tsconfig found, unparseable, or the fields are absent
+ *     (possibly hidden behind `extends`) → caller falls back to `.js`.
+ */
+function detectTsconfigExtension(startDir) {
+    let dir = startDir;
+    for (;;) {
+        const candidate = (0, node_path_1.join)(dir, 'tsconfig.json');
+        if ((0, node_fs_1.existsSync)(candidate)) {
+            try {
+                return classifyTsconfig((0, node_fs_1.readFileSync)(candidate, 'utf-8'));
+            }
+            catch {
+                return null;
+            }
+        }
+        const parent = (0, node_path_1.dirname)(dir);
+        if (parent === dir)
+            return null; // reached the filesystem root
+        dir = parent;
+    }
+}
+/**
+ * Classify a tsconfig's `compilerOptions.module` / `moduleResolution` (see
+ * {@link detectTsconfigExtension}). Tolerant of `//` and block comments and
+ * trailing commas (real-world tsconfigs use JSONC).
+ */
+function classifyTsconfig(text) {
+    let parsed;
+    try {
+        parsed = JSON.parse(stripJsonComments(text));
+    }
+    catch {
+        return null;
+    }
+    if (typeof parsed !== 'object' || parsed === null)
+        return null;
+    const co = parsed.compilerOptions;
+    if (typeof co !== 'object' || co === null)
+        return null;
+    const opts = co;
+    const mod = typeof opts.module === 'string' ? opts.module.toLowerCase() : undefined;
+    const modRes = typeof opts.moduleResolution === 'string' ? opts.moduleResolution.toLowerCase() : undefined;
+    const isNodeNext = (v) => v === 'node16' || v === 'nodenext';
+    if (isNodeNext(mod) || isNodeNext(modRes))
+        return 'js';
+    if (mod !== undefined && modRes !== undefined)
+        return 'none';
+    return null;
+}
+/**
+ * Strip `//` line comments and block comments from JSONC text, leaving anything
+ * inside a double-quoted string untouched. Trailing commas are then removed so
+ * `JSON.parse` accepts the result.
+ */
+function stripJsonComments(text) {
+    let out = '';
+    let inString = false;
+    let inLine = false;
+    let inBlock = false;
+    for (let i = 0; i < text.length; i++) {
+        const ch = text[i];
+        const next = text[i + 1];
+        if (inLine) {
+            if (ch === '\n') {
+                inLine = false;
+                out += ch;
+            }
+            continue;
+        }
+        if (inBlock) {
+            if (ch === '*' && next === '/') {
+                inBlock = false;
+                i++;
+            }
+            continue;
+        }
+        if (inString) {
+            out += ch;
+            if (ch === '\\') {
+                // Preserve the escaped character verbatim.
+                if (next !== undefined) {
+                    out += next;
+                    i++;
+                }
+            }
+            else if (ch === '"') {
+                inString = false;
+            }
+            continue;
+        }
+        if (ch === '"') {
+            inString = true;
+            out += ch;
+            continue;
+        }
+        if (ch === '/' && next === '/') {
+            inLine = true;
+            i++;
+            continue;
+        }
+        if (ch === '/' && next === '*') {
+            inBlock = true;
+            i++;
+            continue;
+        }
+        out += ch;
+    }
+    // Drop trailing commas before } or ].
+    return out.replace(/,(\s*[}\]])/g, '$1');
+}
+// ---------------------------------------------------------------------------
 // types.ts generator
 // ---------------------------------------------------------------------------
 function generatedFileHeader(options) {
@@ -174,7 +327,7 @@ function generateTypes(schema, options) {
             const piiNote = col.pii ? ' (PII: absent unless selected or includePii)' : '';
             const optional = col.pii ? '?' : '';
             lines.push(`  /** Column: ${col.name}, ${col.pgType}${pkNote}${nullNote}${piiNote} */`);
-            lines.push(`  ${col.field}${optional}: ${columnTsType(col, schema.enums)};`);
+            lines.push(`  ${quoteIfNeeded(col.field)}${optional}: ${columnTsType(col, schema.enums)};`);
         }
         lines.push('}');
         lines.push('');
@@ -192,10 +345,10 @@ function generateTypes(schema, options) {
             if (isOptional) {
                 const reason = isPk ? 'auto-generated' : col.hasDefault ? 'has default' : 'nullable';
                 lines.push(`  /** Optional: ${reason} */`);
-                lines.push(`  ${col.field}?: ${columnTsType(col, schema.enums)};`);
+                lines.push(`  ${quoteIfNeeded(col.field)}?: ${columnTsType(col, schema.enums)};`);
             }
             else {
-                lines.push(`  ${col.field}: ${columnTsType(col, schema.enums)};`);
+                lines.push(`  ${quoteIfNeeded(col.field)}: ${columnTsType(col, schema.enums)};`);
             }
         }
         lines.push('};');
@@ -207,7 +360,7 @@ function generateTypes(schema, options) {
         lines.push(`/** Input type for updating a row in \`${table.name}\` */`);
         lines.push(`export type ${typeName}Update = {`);
         for (const col of nonPkCols) {
-            lines.push(`  ${col.field}?: ${updateFieldType(columnTsType(col, schema.enums))};`);
+            lines.push(`  ${quoteIfNeeded(col.field)}?: ${updateFieldType(columnTsType(col, schema.enums))};`);
         }
         lines.push('};');
         lines.push('');
@@ -276,15 +429,54 @@ function generateTypes(schema, options) {
             }
         }
         if (uniqueSets.length > 0) {
-            const branches = uniqueSets.map((cols) => {
+            const memberType = (colName) => {
+                const col = table.columns.find((c) => c.name === colName);
+                return { field: col?.field ?? colName, tsType: col?.tsType ?? 'unknown' };
+            };
+            // Flat branches: one object per unique constraint carrying its columns.
+            const flatBranches = uniqueSets.map((cols) => {
                 const fields = cols.map((colName) => {
-                    const col = table.columns.find((c) => c.name === colName);
-                    const field = col?.field ?? colName;
-                    const tsType = col?.tsType ?? 'unknown';
-                    return `${field}: ${tsType}`;
+                    const m = memberType(colName);
+                    return `${quoteIfNeeded(m.field)}: ${m.tsType}`;
                 });
                 return `{ ${fields.join('; ')} }`;
             });
+            // Prisma-style compound-unique SELECTOR branches: a synthetic key
+            // (`orgId_userId`) whose value holds the member columns, emitted for every
+            // COMPOSITE unique (PK, composite UNIQUE constraint, or composite UNIQUE
+            // index). Runtime expansion lives in query/compound-unique.ts.
+            const compoundSeen = new Set();
+            const compoundSets = [];
+            const addCompound = (cols) => {
+                if (cols.length < 2)
+                    return;
+                const key = cols.join(',');
+                if (compoundSeen.has(key))
+                    return;
+                compoundSeen.add(key);
+                compoundSets.push(cols);
+            };
+            addCompound(table.primaryKey);
+            for (const uc of table.uniqueColumns)
+                addCompound(uc);
+            for (const idx of table.indexes) {
+                if (idx.unique && !idx.docPath)
+                    addCompound(idx.columns);
+            }
+            const selectorEntries = compoundSets.map((cols) => {
+                const members = cols.map(memberType);
+                return {
+                    selectorName: members.map((m) => m.field).join('_'),
+                    memberType: `{ ${members.map((m) => `${quoteIfNeeded(m.field)}: ${m.tsType}`).join('; ')} }`,
+                };
+            });
+            // Named helper type for annotating a compound selector by hand (Prisma parity).
+            if (selectorEntries.length > 0) {
+                const cuFields = selectorEntries.map((e) => `${e.selectorName}: ${e.memberType}`);
+                lines.push(`export type ${typeName}CompoundUniques = { ${cuFields.join('; ')} };`);
+            }
+            const selectorBranches = selectorEntries.map((e) => `{ ${e.selectorName}: ${e.memberType} }`);
+            const branches = [...flatBranches, ...selectorBranches];
             lines.push(`export type ${typeName}WhereUnique = ${branches.join(' | ')};`);
             lines.push('');
         }
@@ -414,7 +606,7 @@ function generateZod(schema, options) {
             let expr = zodBaseType(col, schema.enums);
             if (col.nullable)
                 expr += '.nullable()';
-            lines.push(`  ${col.field}: ${expr},`);
+            lines.push(`  ${quoteIfNeeded(col.field)}: ${expr},`);
         }
         lines.push('});');
         lines.push('');
@@ -431,7 +623,7 @@ function generateZod(schema, options) {
                 expr += '.nullable()';
             if (col.hasDefault || col.nullable || isPk)
                 expr += '.optional()';
-            lines.push(`  ${col.field}: ${expr},`);
+            lines.push(`  ${quoteIfNeeded(col.field)}: ${expr},`);
         }
         lines.push('});');
         lines.push('');
@@ -447,7 +639,7 @@ function generateZod(schema, options) {
             if (col.nullable)
                 expr += '.nullable()';
             expr += '.optional()';
-            lines.push(`  ${col.field}: ${expr},`);
+            lines.push(`  ${quoteIfNeeded(col.field)}: ${expr},`);
         }
         lines.push('});');
         lines.push('');
@@ -477,7 +669,7 @@ function generateMetadata(schema, options) {
         // columnMap
         lines.push('      columnMap: {');
         for (const [field, col] of Object.entries(table.columnMap)) {
-            lines.push(`        ${field}: '${escSQ(col)}',`);
+            lines.push(`        ${quoteIfNeeded(field)}: '${escSQ(col)}',`);
         }
         lines.push('      },');
         // reverseColumnMap
@@ -577,11 +769,17 @@ function generateIndex(schema, options) {
     const hasSafeRelations = new Map();
     for (const t of tableEntries)
         hasSafeRelations.set(t.name, typeSafeRelations(t, false).length > 0);
+    // F3: sibling-import extension. Defaults to '.js' for direct callers so their
+    // output stays byte-stable; `generate()` resolves it (auto / js / none).
+    const ext = options?.importExt ?? '.js';
     const lines = [
         ...generatedFileHeader(options),
+        // Record the resolved import mode for debuggability (only when generate()
+        // drove it, so direct generateIndex() callers stay byte-identical).
+        ...(options?.importMode ? [`// Sibling imports resolved with importExtension: ${options.importMode}.`, ''] : []),
         "import { TurbineClient as BaseTurbineClient, TransactionClient as BaseTransactionClient, QueryInterface } from 'turbine-orm';",
         "import type { TurbineConfig, TransactionOptions, DeferredQuery, PipelineResults } from 'turbine-orm';",
-        "import { SCHEMA } from './metadata.js';",
+        `import { SCHEMA } from './metadata${ext}';`,
     ];
     // Import all entity types and relations maps
     const typeImports = [];
@@ -591,7 +789,7 @@ function generateIndex(schema, options) {
             typeImports.push(`${entityName(t.name)}Relations`);
         }
     }
-    lines.push(`import type { ${typeImports.join(', ')} } from './types.js';`);
+    lines.push(`import type { ${typeImports.join(', ')} } from './types${ext}';`);
     lines.push('');
     // -------------------------------------------------------------------------
     // TypedTransactionClient — same typed table accessors as TurbineClient,
@@ -702,11 +900,70 @@ function generateIndex(schema, options) {
     lines.push('}');
     lines.push('');
     // Re-export everything
-    lines.push("export * from './types.js';");
-    lines.push("export { SCHEMA } from './metadata.js';");
+    lines.push(`export * from './types${ext}';`);
+    lines.push(`export { SCHEMA } from './metadata${ext}';`);
+    lines.push('');
+    return lines.join('\n');
+}
+// ---------------------------------------------------------------------------
+// prisma-map.ts generator
+// ---------------------------------------------------------------------------
+/**
+ * Serialize a resolved {@link PrismaCompatMap} into a `prisma-map.ts` module
+ * that exports `export const PRISMA_MAP: PrismaCompatMap = {...}`. Written next
+ * to the generated client by `turbine migrate-from-prisma`; consumed later by
+ * the phase-2 `turbine-orm/prisma-compat` runtime adapter.
+ *
+ * Deterministic: uses the same reproducible header as the other emitters, so a
+ * stable input regenerates byte-identical output under `noTimestamp`.
+ */
+function generatePrismaMap(map, options) {
+    const lines = [
+        ...generatedFileHeader(options),
+        "import type { PrismaCompatMap } from 'turbine-orm';",
+        '',
+        '/**',
+        ' * Name map from your Prisma schema onto this Turbine client. Every entry was',
+        ' * resolved against the live database; unresolved items are omitted (see the',
+        ' * migration report). Pass this to the phase-2 prisma-compat adapter, or read',
+        ' * it directly for hand-written compatibility wrappers.',
+        ' */',
+        'export const PRISMA_MAP: PrismaCompatMap = {',
+        '  models: {',
+    ];
+    for (const [modelName, model] of Object.entries(map.models)) {
+        lines.push(`    ${quoteIfNeeded(modelName)}: {`);
+        lines.push(`      table: '${escSQ(model.table)}',`);
+        lines.push(`      accessor: '${escSQ(model.accessor)}',`);
+        lines.push(`      fields: ${serializeStringRecord(model.fields)},`);
+        lines.push('      relations: {');
+        for (const [rel, r] of Object.entries(model.relations)) {
+            lines.push(`        ${quoteIfNeeded(rel)}: { name: '${escSQ(r.name)}', cardinality: '${r.cardinality}' },`);
+        }
+        lines.push('      },');
+        lines.push(`      compoundUniques: ${serializeStringArrayRecord(model.compoundUniques)},`);
+        lines.push('    },');
+    }
+    lines.push('  },');
+    lines.push(`  enums: ${serializeStringRecord(map.enums)},`);
+    lines.push('};');
     lines.push('');
     return lines.join('\n');
 }
+/** Serialize a `Record<string, string>` as an inline object literal. */
+function serializeStringRecord(rec) {
+    const entries = Object.entries(rec);
+    if (entries.length === 0)
+        return '{}';
+    return `{ ${entries.map(([k, v]) => `${quoteIfNeeded(k)}: '${escSQ(v)}'`).join(', ')} }`;
+}
+/** Serialize a `Record<string, string[]>` as an inline object literal. */
+function serializeStringArrayRecord(rec) {
+    const entries = Object.entries(rec);
+    if (entries.length === 0)
+        return '{}';
+    return `{ ${entries.map(([k, v]) => `${quoteIfNeeded(k)}: [${v.map((s) => `'${escSQ(s)}'`).join(', ')}]`).join(', ')} }`;
+}
 // ---------------------------------------------------------------------------
 // Helpers
 // ---------------------------------------------------------------------------

package/dist/cjs/index.js

@@ -34,8 +34,8 @@
  * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyManyToManyRelations = exports.snakeToPascal = exports.snakeToCamel = exports.singularize = exports.pgTypeToTs = exports.pgArrayType = exports.normalizeKeyColumns = exports.isDateType = exports.camelToSnake = exports.validateChannel = exports.QueryInterface = exports.pipelineSupported = exports.executePipeline = exports.hasRelationFields = exports.executeNestedUpdate = exports.executeNestedCreate = exports.introspect = exports.generate = exports.wrapPgError = exports.ValidationError = exports.UnsupportedFeatureError = exports.UniqueConstraintError = exports.TurbineErrorCode = exports.TurbineError = exports.TimeoutError = exports.setErrorMessageMode = exports.SerializationFailureError = exports.RelationError = exports.ReadOnlyError = exports.PipelineError = exports.OptimisticLockError = exports.NotNullViolationError = exports.NotFoundError = exports.MigrationError = exports.getErrorMessageMode = exports.ForeignKeyError = exports.ExclusionConstraintError = exports.DeadlockError = exports.ConnectionError = exports.CircularRelationError = exports.CheckConstraintError = exports.postgresDialect = exports.withRetry = exports.TurbineClient = exports.TransactionClient = exports.yugabytedb = exports.timescale = exports.postgresql = exports.cockroachdb = exports.alloydb = void 0;
-exports.TypedSqlQuery = exports.buildTypedSql = exports.turbineHttp = exports.defineSeed = exports.schemaToSQLString = exports.schemaToSQL = exports.schemaPush = exports.schemaDiff = exports.DestructivePushRefusal = exports.schemaDefToMetadata = exports.table = exports.isDocFieldIndexDef = exports.defineSchema = exports.column = exports.ColumnBuilder = void 0;
+exports.withDbFieldNames = exports.snakeToPascal = exports.snakeToCamel = exports.singularize = exports.pgTypeToTs = exports.pgArrayType = exports.normalizeKeyColumns = exports.isDateType = exports.camelToSnake = exports.validateChannel = exports.QueryInterface = exports.pipelineSupported = exports.executePipeline = exports.hasRelationFields = exports.executeNestedUpdate = exports.executeNestedCreate = exports.introspect = exports.generate = exports.wrapPgError = exports.ValidationError = exports.UnsupportedFeatureError = exports.UniqueConstraintError = exports.TurbineErrorCode = exports.TurbineError = exports.TimeoutError = exports.setErrorMessageMode = exports.SerializationFailureError = exports.RelationError = exports.ReadOnlyError = exports.PipelineError = exports.OptimisticLockError = exports.NotNullViolationError = exports.NotFoundError = exports.MigrationError = exports.getErrorMessageMode = exports.ForeignKeyError = exports.ExclusionConstraintError = exports.DeadlockError = exports.ConnectionError = exports.CircularRelationError = exports.CheckConstraintError = exports.postgresDialect = exports.withRetry = exports.TurbineClient = exports.TransactionClient = exports.yugabytedb = exports.timescale = exports.postgresql = exports.cockroachdb = exports.alloydb = void 0;
+exports.TypedSqlQuery = exports.buildTypedSql = exports.turbineHttp = exports.defineSeed = exports.schemaToSQLString = exports.schemaToSQL = exports.schemaPush = exports.schemaDiff = exports.DestructivePushRefusal = exports.schemaDefToMetadata = exports.table = exports.isDocFieldIndexDef = exports.defineSchema = exports.column = exports.ColumnBuilder = exports.applyManyToManyRelations = void 0;
 var index_js_1 = require("./adapters/index.js");
 Object.defineProperty(exports, "alloydb", { enumerable: true, get: function () { return index_js_1.alloydb; } });
 Object.defineProperty(exports, "cockroachdb", { enumerable: true, get: function () { return index_js_1.cockroachdb; } });
@@ -105,6 +105,7 @@ Object.defineProperty(exports, "pgTypeToTs", { enumerable: true, get: function (
 Object.defineProperty(exports, "singularize", { enumerable: true, get: function () { return schema_js_1.singularize; } });
 Object.defineProperty(exports, "snakeToCamel", { enumerable: true, get: function () { return schema_js_1.snakeToCamel; } });
 Object.defineProperty(exports, "snakeToPascal", { enumerable: true, get: function () { return schema_js_1.snakeToPascal; } });
+Object.defineProperty(exports, "withDbFieldNames", { enumerable: true, get: function () { return schema_js_1.withDbFieldNames; } });
 // Schema builder — define schemas in TypeScript
 var schema_builder_js_1 = require("./schema-builder.js");
 Object.defineProperty(exports, "applyManyToManyRelations", { enumerable: true, get: function () { return schema_builder_js_1.applyManyToManyRelations; } });