uql-codemod 0.37.0 → 0.39.0

package/README.md

@@ -28,10 +28,11 @@ Only `--flag=value` is read, and anything unrecognised is an error. It exits `0`
 - `entity: () => X` on a bare relation decorator, and `Relation<T>` to `T`, its import going with the last use.
 - `virtual` to `computed` (on `@Field` and in `defineEntity`'s `fields`), a check's `expression` and a filter's `condition` to `where` (`@Entity`/`defineEntity`, `@Filter`, `defineFilter`), `raw('sql')` to the tagged template, and a `raw` alias argument onto `.as()`.
 - Members named by string to callbacks: `mappedBy: 'author'` to `(post) => post.author`, and `@Index`, `include`, `references` and `@Entity`/`defineEntity`'s `indexes` and `hooks` likewise: `@Index((post) => [post.title])`.
+- `references: (post) => post.authorId` on a to-one (`@ManyToOne`, `@OneToOne`, or `defineEntity`/`defineRelation`) that names no foreign key, declaring `@Field({ references: () => User }) authorId` first on a decorated class that has no such column, typed as the key it points at.
 - A partial-index `where` string to `raw`, importing it, on entities and in the migration builder.
 - `col('cost')` to the ref it names, ``(product) => raw`${product.cost}` `` in a `computed` and `refs(Item).cost` in a statement, and `$lock: { wait: 'skip' }` to `{ $wait: 'skip' }`, or to `true` for `{}` and a `'block'` wait.
 - An aggregate's `$agg` to `$select`, and each field it or `$text`'s `$fields` names to a key: `{ $sum: { amount: true } }`.
-- Renamed exports, at the import and every use: `QueryWhereMap` to `QueryWhere`, `RelationKeyMap` to `KeyMap`, `FilterCondition` to `FilterWhere`, `SqlMigrationModuleOptions` to `MigrationModuleOptions` and `buildSqlQuerierMigrationModule` to `buildMigrationModule`, and the removed driver classes to the one each extended: `PgDialect`/`NeonDialect`/`PgliteDialect` to `PostgresDialect`, `CrdbQuerier`/`NeonQuerier` to `PgQuerier`, `LibsqlQuerier`/`TursoQuerier` to `HranaQuerier`, `TursoLocalQuerier` to `SqliteQuerier` and `TursoDatabase` to `SqliteDatabase`, `MySql2Dialect` to `MySqlDialect`, `MongodbNativeDialect` to `MongoDialect`, moving the import to the entry that exports it.
+- Renamed exports, at the import and every use: `QueryWhereMap` to `QueryWhere`, `RelationKeyMap` to `KeyMap`, `FilterCondition` to `FilterWhere`, `SqlMigrationModuleOptions` to `MigrationModuleOptions`, `buildSqlQuerierMigrationModule` to `buildMigrationModule`, `QueryDialect` to `SqlQueryDialect`, `EngineFeatures` to `DialectFeatures`, `KnownMigratorDialect` to `DialectName` and `D1Preparer` to `D1Database`, and the removed driver classes to the one each extended: `PgDialect`/`NeonDialect`/`PgliteDialect` to `PostgresDialect`, `CrdbQuerier`/`NeonQuerier` to `PgQuerier`, `LibsqlQuerier`/`TursoQuerier` to `HranaQuerier`, `TursoLocalQuerier` to `SqliteQuerier` and `TursoDatabase` to `SqliteDatabase`, `MySql2Dialect` to `MySqlDialect`, `MongodbNativeDialect` to `MongoDialect`, moving the import to the entry that exports it.
 - The `[idKey]?: '...'` brand, and its import, on a key not called `id`, `_id` or `uuid` and on every composite.
 - `import 'reflect-metadata'`, and `experimentalDecorators`/`emitDecoratorMetadata` in `tsconfig.json`, comments and formatting kept.
 
@@ -43,6 +44,8 @@ Reported with what to do, never guessed:
 - `@Log()`, `@Serialized()`, `@Transactional()` and `@InjectQuerier()`: a `@Transactional()` method becomes a `pool.transaction()` around its body, and only you know which pool.
 - An export removed with no one-to-one replacement (`setQuerierPool`, `getQuerier`, `augmentWhere`, `AbstractPgQuerier`, ...).
 - A value it cannot read: options passed as a variable or a spread, a list that is not a literal, a key under a computed name.
+- A to-one onto a composite key: declare a column per key and pair each with it in `references`.
+- A to-one in `defineEntity`/`defineRelation` whose entity has no foreign key column: declare it with `defineField`.
 - A partial-index `where` string that interpolates, since `raw` would bind what the template spliced in.
 - A `col()` whose entity it cannot tell: a raw built apart from its query, one under a relation filter, or a column no field maps.
 - SQL in a definition that names a column by hand, as a note: a rename reaches a callback's refs, ``(user) => raw`lower(${user.email})` ``, and never the text.

package/dist/edits.d.ts

@@ -13,6 +13,7 @@ export type Edit = {
 export declare function applyEdits(text: string, edits: readonly Edit[]): string;
 export declare function replaced(node: ts.Node, text: string): Edit;
 export declare function inserted(node: ts.Node, text: string): Edit;
+export declare function appended(node: ts.Node, text: string): Edit;
 /**
  * Removes one element of a comma-separated list - a parameter, a named import, a JSON property - taking
  * the separator that would otherwise dangle. The last element gives up the comma before it; any other

package/dist/edits.js

@@ -16,6 +16,9 @@ export function replaced(node, text) {
 export function inserted(node, text) {
     return { start: node.getStart(), end: node.getStart(), text };
 }
+export function appended(node, text) {
+    return { start: node.getEnd(), end: node.getEnd(), text };
+}
 /**
  * Removes one element of a comma-separated list - a parameter, a named import, a JSON property - taking
  * the separator that would otherwise dangle. The last element gives up the comma before it; any other

package/dist/transform.js

@@ -1,10 +1,12 @@
 import ts from 'typescript';
-import { applyEdits, inserted, removeFromList, replaced } from './edits.js';
+import { appended, applyEdits, inserted, removeFromList, replaced } from './edits.js';
 import { columnExpressions, handNamedColumns, isRaw, rawTag, rawWhereEdit } from './entitySql.js';
 import { fieldTypeFor, isBrandedString, relationTargetFor } from './fieldType.js';
 import { entityGetterTarget, fieldKeysEdits, isCallback, keyListEdits, mappedByEdits, memberAccess, paramFor, propertyKey, propertyValue, quoted, referencesEdits, } from './keyMaps.js';
 const FIELD_DECORATORS = new Set(['Field', 'Id']);
 const RELATION_DECORATORS = new Set(['OneToOne', 'ManyToOne', 'OneToMany', 'ManyToMany']);
+const TO_ONE_DECORATORS = new Set(['OneToOne', 'ManyToOne']);
+const TO_ONE_CARDINALITIES = new Set(['11', 'm1']);
 /**
  * Decorators that no longer exist, mapped to what to do instead. None is removed for you: what to put
  * in its place is a judgement call, and removing only the import would swap a clear error for a
@@ -43,6 +45,17 @@ const REMOVED_EXPORTS = new Map([
         'IndexColumnOptions',
         "an entity's index entry is `EntityIndexColumnInput<E>`, the migration builder's `IndexColumnInput`",
     ],
+    ['isKnownMigratorDialect', 'every dialect has a migrator, so it always held: drop the check'],
+    ['QuerierPoolDialect', "read the pool's own: `P['dialect']`"],
+    ['QuerierPoolQuerier', "read the pool's own: `Awaited<ReturnType<P['getQuerier']>>`"],
+    [
+        'POSTGRES_WIRE_DRIVER_CAPABILITIES',
+        'pass `driverCapabilities: { nativeArrays: false, explicitJsonCast: true }` to the dialect',
+    ],
+    ['MysqlLikeSqlDialect', 'extend `MySqlDialect` (`uql-orm/mysql`) or `MariaDialect` (`uql-orm/maria`)'],
+    ['D1Meta', "uql reads `D1Result['meta']`; the rest of a binding is typed by `@cloudflare/workers-types`"],
+    ['D1ExecResult', 'the rest of a binding is typed by `@cloudflare/workers-types`'],
+    ['createSchemaGenerator', 'use `new SqlSchemaGenerator(dialect)`, or `migrator.getSchemaGenerator()`'],
 ]);
 /**
  * Exports renamed and nothing else - the driver classes were empty subclasses - so the import and every
@@ -65,6 +78,10 @@ const RENAMED_EXPORTS = new Map([
     ['TursoDatabase', { to: 'SqliteDatabase', from: 'uql-orm/sqlite' }],
     ['SqlMigrationModuleOptions', { to: 'MigrationModuleOptions' }],
     ['buildSqlQuerierMigrationModule', { to: 'buildMigrationModule' }],
+    ['QueryDialect', { to: 'SqlQueryDialect' }],
+    ['EngineFeatures', { to: 'DialectFeatures' }],
+    ['KnownMigratorDialect', { to: 'DialectName', from: 'uql-orm' }],
+    ['D1Preparer', { to: 'D1Database' }],
 ]);
 /** A node's decorators, or none where it is a kind that cannot carry them. */
 function decoratorsOf(node) {
@@ -210,6 +227,64 @@ function addRelationEntity(decorator, node, ctx) {
         },
     });
 }
+/**
+ * Names the foreign key a to-one found by name alone, `references: (post) => post.authorId` beside `author`.
+ * A key the entity neither declares nor inherits is declared first, on a decorated property, typed as the
+ * target's key; elsewhere it is reported.
+ */
+function addForeignKeyReference(relation, key, owner, ctx, property) {
+    const options = { kind: 'literal', node: relation };
+    const cardinality = propertyValue(relation, 'cardinality');
+    const toOne = !cardinality || (ts.isStringLiteralLike(cardinality) && TO_ONE_CARDINALITIES.has(cardinality.text));
+    const joined = ['mappedBy', 'through', 'references'].some((option) => findProperty(options, option));
+    const last = relation.properties.at(-1);
+    if (!key || !last || !toOne || joined) {
+        return;
+    }
+    const column = `${key}Id`;
+    if (!memberNames(owner.entity, ctx.checker).has(column)) {
+        if (!property) {
+            ctx.unresolved.push(`${ctx.describe(relation)}: declare the foreign key column '${column}' and name it in 'references'`);
+            return;
+        }
+        const declared = foreignKeyColumn(property, column, relation, ctx);
+        if (!declared) {
+            return;
+        }
+        ctx.edits.push(declared);
+    }
+    ctx.edits.push(appended(last, `, references: (${owner.param}) => ${memberAccess(owner.param, column)}`));
+}
+/** `@Field({ references: () => Target }) <column>?: <key type>;` ahead of the relation, or why it cannot be written. */
+function foreignKeyColumn(property, column, relation, ctx) {
+    const { checker } = ctx;
+    const targetType = checker.getNonNullableType(checker.getTypeAtLocation(property));
+    const target = entityGetterTarget(relation) ?? relationTargetFor(targetType, checker);
+    const keys = targetType.getProperties().filter((member) => member.declarations?.some(isIdProperty));
+    const [soleKey] = keys;
+    if (!target || !soleKey || keys.length > 1) {
+        const advice = keys.length > 1
+            ? `'${target}' has a composite key: declare a column per key and pair each in 'references'`
+            : `declare the foreign key column '${column}' and name it in 'references'`;
+        ctx.unresolved.push(`${ctx.describe(property)}: ${advice}`);
+        return undefined;
+    }
+    const source = property.getSourceFile();
+    const indent = ' '.repeat(source.getLineAndCharacterOfPosition(property.getStart()).character);
+    ctx.imports.set('Field', 'the foreign key column');
+    return inserted(property, `@Field({ references: () => ${target} }) ${column}?: ${keyTypeSource(soleKey, property, ctx)};\n${indent}`);
+}
+/** The key's type as written where that is in scope, the same file, or as the checker spells it out. */
+function keyTypeSource(key, at, ctx) {
+    const written = key.declarations?.find(isIdProperty)?.type;
+    if (written && written.getSourceFile() === at.getSourceFile()) {
+        return written.getText();
+    }
+    return ctx.checker.typeToString(ctx.checker.getNonNullableType(ctx.checker.getTypeOfSymbolAtLocation(key, at)), at);
+}
+function isIdProperty(node) {
+    return ts.isPropertyDeclaration(node) && decoratorsOf(node).some((decorator) => decoratorName(decorator) === 'Id');
+}
 /**
  * Writes the edits `rewrite` reads off `value`, which still names members as strings, or reports it
  * where it could not be read: what it holds is only known at runtime. A callback or an object literal
@@ -270,6 +345,7 @@ function rewriteDefineCall(call, ctx) {
     }
     else if (name === 'defineRelation' && third && ts.isObjectLiteralExpression(third)) {
         rewriteRelationOptions(third, owner.param, ctx);
+        addForeignKeyReference(third, second && ts.isStringLiteralLike(second) ? second.text : undefined, owner, ctx);
     }
     else if (name === 'defineFilter' && third) {
         renameOption(optionsOf(third), 'condition', 'where', call, ctx);
@@ -296,6 +372,7 @@ function rewriteEntityOptions(options, owner, ctx) {
     for (const relation of objectProperties(propertyValue(options, 'relations'))) {
         if (ts.isObjectLiteralExpression(relation.initializer)) {
             rewriteRelationOptions(relation.initializer, owner.param, ctx);
+            addForeignKeyReference(relation.initializer, propertyKey(relation.name), owner, ctx);
         }
     }
 }
@@ -590,6 +667,9 @@ function rewriteProperty(node, ctx) {
             const target = relationTargetFor(ctx.checker.getTypeAtLocation(node), ctx.checker);
             rewriteRelationOptions(options.node, owner.param, ctx, paramFor(target));
         }
+        if (TO_ONE_DECORATORS.has(name) && options.kind === 'literal') {
+            addForeignKeyReference(options.node, propertyKey(node.name), owner, ctx, node);
+        }
     }
     if (decorators.length) {
         dropDeclare(node, ctx);

package/package.json

@@ -2,7 +2,7 @@
   "name": "uql-codemod",
   "description": "Upgrade uql-orm across versions that introduce breaking changes",
   "license": "MIT",
-  "version": "0.37.0",
+  "version": "0.39.0",
   "type": "module",
   "engines": {
     "node": ">=24"