uql-codemod 0.38.0 → 0.39.1

package/README.md

@@ -28,7 +28,7 @@ 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`) whose entity declares or inherits `authorId`, which it used to join by name.
+- `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 } }`.
@@ -44,7 +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 whose columns the entity declares: pair each with its key in `references`, which the error at startup spells out.
+- A to-one onto a composite key: declare a column per key and pair each with it in `references`.
+- A to-one whose `<relation>Id` is not a declared column: an undecorated property, a `defineEntity` whose `fields` leave it out, or a `defineRelation` whose entity has no such member.
 - 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/transform.js

@@ -157,8 +157,12 @@ function noteHandNamedColumns(sql, owner, ctx) {
 }
 /** The names of the members of the entity `node` declares or names. */
 function memberNames(node, checker) {
+    return propertyNames(instanceTypeOf(node, checker));
+}
+/** The instance type of the entity `node` declares or names. */
+function instanceTypeOf(node, checker) {
     const type = checker.getTypeAtLocation(node);
-    return propertyNames(type.getConstructSignatures()[0]?.getReturnType() ?? type);
+    return type.getConstructSignatures()[0]?.getReturnType() ?? type;
 }
 function propertyNames(type) {
     return new Set(type.getProperties().map(({ name }) => name));
@@ -228,21 +232,72 @@ function addRelationEntity(decorator, node, ctx) {
     });
 }
 /**
- * Names the foreign key a to-one found by name alone, `references: (post) => post.authorId` beside `author`,
- * where its entity declares or inherits that key: a declared key is no longer joined by its name.
+ * Names the foreign key a to-one used to find by name, `references: (post) => post.authorId` beside `author`.
+ * `site` says where the entity declares its columns: the decorated property, ahead of which a missing column
+ * is declared, or `defineEntity`'s `fields`. A column it cannot see declared is reported instead.
  */
-function addForeignKeyReference(relation, key, owner, ctx) {
+function addForeignKeyReference(relation, key, owner, ctx, site) {
     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 (!key || !last || !toOne || joined || !memberNames(owner.entity, ctx.checker).has(column)) {
+    const declaration = columnDeclaration(column, relation, owner, ctx.checker, site);
+    if (typeof declaration === 'string') {
+        ctx.unresolved.push(`${ctx.describe(site && ts.isPropertyDeclaration(site) ? site : relation)}: ${declaration}`);
         return;
     }
+    if (declaration) {
+        ctx.edits.push(declaration);
+        ctx.imports.set('Field', 'the foreign key column');
+    }
     ctx.edits.push(appended(last, `, references: (${owner.param}) => ${memberAccess(owner.param, column)}`));
 }
+const undeclaredColumn = (column) => `declare the foreign key column '${column}' and name it in 'references'`;
+/** Nothing where `column` is declared, the declaration to write where a decorated class lacks it, or why neither. */
+function columnDeclaration(column, relation, owner, checker, site) {
+    const member = instanceTypeOf(owner.entity, checker).getProperty(column);
+    if (site && ts.isPropertyDeclaration(site)) {
+        if (!member) {
+            return foreignKeyColumn(site, column, relation, checker);
+        }
+        return member.declarations?.some(isFieldProperty) ? undefined : undeclaredColumn(column);
+    }
+    const declared = site ? objectProperties(site).some(({ name }) => propertyKey(name) === column) : member;
+    return declared ? undefined : undeclaredColumn(column);
+}
+/** `@Field({ references: () => Target }) <column>?: <key type>;` ahead of the relation, or why it cannot be written. */
+function foreignKeyColumn(property, column, relation, checker) {
+    const targetType = checker.getNonNullableType(checker.getTypeAtLocation(property));
+    const target = entityGetterTarget(relation) ?? relationTargetFor(targetType, checker);
+    const keys = targetType.getProperties().filter((member) => member.declarations?.some(isIdProperty));
+    if (keys.length > 1) {
+        return `'${target}' has a composite key: declare a column per key and pair each in 'references'`;
+    }
+    const [key] = keys;
+    if (!target || !key) {
+        return undeclaredColumn(column);
+    }
+    const indent = ' '.repeat(property.getSourceFile().getLineAndCharacterOfPosition(property.getStart()).character);
+    const type = keyTypeSource(key, property, checker);
+    return inserted(property, `@Field({ references: () => ${target} }) ${column}?: ${type};\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, checker) {
+    const written = key.declarations?.find(isIdProperty)?.type;
+    if (written && written.getSourceFile() === at.getSourceFile()) {
+        return written.getText();
+    }
+    return checker.typeToString(checker.getNonNullableType(checker.getTypeOfSymbolAtLocation(key, at)), at);
+}
+/** Whether a declaration is a property carrying one of `names` as a decorator. */
+const decoratedWith = (names) => (node) => ts.isPropertyDeclaration(node) && decoratorsOf(node).some((decorator) => names.has(decoratorName(decorator) ?? ''));
+const isIdProperty = decoratedWith(new Set(['Id']));
+const isFieldProperty = decoratedWith(FIELD_DECORATORS);
 /**
  * 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
@@ -310,6 +365,7 @@ function rewriteDefineCall(call, ctx) {
     }
 }
 function rewriteEntityOptions(options, owner, ctx) {
+    const fields = propertyValue(options, 'fields');
     for (const index of arrayElements(propertyValue(options, 'indexes'))) {
         if (ts.isObjectLiteralExpression(index)) {
             rewriteIndexOptions(index, owner, ctx);
@@ -318,7 +374,7 @@ function rewriteEntityOptions(options, owner, ctx) {
     for (const check of arrayElements(propertyValue(options, 'checks'))) {
         renameSqlOption(optionsOf(check), 'expression', 'where', check, owner, ctx);
     }
-    for (const field of objectProperties(propertyValue(options, 'fields'))) {
+    for (const field of objectProperties(fields)) {
         renameSqlOption(optionsOf(field.initializer), 'virtual', 'computed', field, owner, ctx);
     }
     for (const filter of objectProperties(propertyValue(options, 'filters'))) {
@@ -327,10 +383,11 @@ function rewriteEntityOptions(options, owner, ctx) {
     for (const hook of objectProperties(propertyValue(options, 'hooks'))) {
         rewriteKeyList(hook.initializer, owner.param, hook, 'a hook list', ctx);
     }
+    const declared = fields && ts.isObjectLiteralExpression(fields) ? fields : undefined;
     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);
+            addForeignKeyReference(relation.initializer, propertyKey(relation.name), owner, ctx, declared);
         }
     }
 }
@@ -563,7 +620,7 @@ function isIdKeyBrand(member) {
  * One written makes `idKey` a value the file has to import, which is recorded for {@link addImports}.
  */
 function brandIdKey(node, ctx) {
-    const ids = node.members.filter((m) => ts.isPropertyDeclaration(m) && decoratorsOf(m).some((d) => decoratorName(d) === 'Id'));
+    const ids = node.members.filter(isIdProperty);
     if (!ids.length || node.members.some(isIdKeyBrand)) {
         return;
     }
@@ -624,9 +681,9 @@ function rewriteProperty(node, ctx) {
         if (RELATION_DECORATORS.has(name) && options.kind === 'literal') {
             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);
+            if (TO_ONE_DECORATORS.has(name)) {
+                addForeignKeyReference(options.node, propertyKey(node.name), owner, ctx, node);
+            }
         }
     }
     if (decorators.length) {
@@ -927,9 +984,9 @@ export function transformFile(source, checker) {
         }
         if (ts.isCallExpression(node)) {
             rewriteDefineCall(node, ctx);
-        }
-        if (importsUql && ts.isCallExpression(node)) {
-            rewriteBuilderCall(node, ctx);
+            if (importsUql) {
+                rewriteBuilderCall(node, ctx);
+            }
         }
         if (ts.isPropertyAssignment(node)) {
             rewriteStatementKeys(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.38.0",
+  "version": "0.39.1",
   "type": "module",
   "engines": {
     "node": ">=24"