uql-codemod 0.50.1 → 0.51.0

package/README.md

@@ -31,12 +31,13 @@ Only `--flag=value` is read, and anything unrecognised is an error. It exits `0`
 - Members named by string to callbacks: `mappedBy: 'author'` to `(post) => post.author`, and `include`, `references` and `@Entity`/`defineEntity`'s `indexes` and `hooks` likewise: `{ columns: (post) => [post.title] }`.
 - `references: (post) => post.authorId` on a to-one (`@ManyToOne`, `@OneToOne`, or in `defineEntity`) 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 `sql`, importing it, on entities and in the migration builder.
-- A class registered with `defineEntity(Post, { ... })` to the `defineEntity({ ... })` call it stands for, whole or not at all: `export const Post = defineEntity({ name: 'Post', fields })` with its sections chained, as a defined entity's options are above, and `export type Post = InstanceType<typeof Post>`. The class is removed and a table it named kept as `table`; a field stating no `type` takes the one its property declares (`authorId?: number | null` is `f.number().nullable()`), each relation becomes `author: () => rel.manyToOne(User, { ... })`, a relation aggregate a derived field (`(post) => ({ total: () => post.comments.count() })`), a hook's method a function of the row (`this` read as the row), and the same class's `defineField`, `defineId`, `defineRelation`, `defineHook`, `defineIndex`, `defineTrigger` and `defineFilter` are folded in.
+- A class registered with `defineEntity(Post, { ... })` to the `defineEntity({ ... })` call it stands for, whole or not at all: `export const Post = defineEntity({ name: 'Post', fields })` with its sections chained, as a defined entity's options are above, and `export type Post = InstanceType<typeof Post>`. The class is removed and a table it named kept as `table`; a field stating no `type` takes the one its property declares (`authorId?: number | null` is `f.number().nullable()`), each relation becomes `author: () => rel.manyToOne(User, { ... })`, a relation aggregate an aggregate field (`(post) => ({ total: () => post.comments.count() })`), a hook's method a function of the row (`this` read as the row), and the same class's `defineField`, `defineId`, `defineRelation`, `defineHook`, `defineIndex`, `defineTrigger` and `defineFilter` are folded in.
 - A JSON index entry to the path read off the column's ref: `{ column: post.kind, jsonPath: { path: 'theme', type: Number } }` to `{ column: post.kind.theme, type: Number }`, and a `jsonArray`'s element type to `type: [String]`.
 - `col('cost')` to the ref it names, ``(product) => sql`${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.
 - `$exclude` to a `$select` leaving its fields out: `$exclude: { password: true }` to `$select: { password: false }`, at every depth of `$populate`.
 - 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: `raw` to `sql`, `QueryWhereMap` to `QueryWhere`, `IndexColumnSchema` to `IndexEntry`, `IndexColumnModifiers` to `IndexEntryModifiers`, `RelationKeyMap` to `KeyMap`, `FilterCondition` to `FilterWhere`, `SqlMigrationModuleOptions` to `MigrationModuleOptions`, `buildSqlQuerierMigrationModule` to `buildMigrationModule`, `QueryDialect` to `SqlQueryDialect`, `EngineFeatures` to `DialectFeatures`, `KnownMigratorDialect` to `DialectName`, `D1Preparer`/`D1Database` to `D1Queryable`, 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`, `Sqlite3QuerierPool` to `SqliteQuerierPool`, the migration builder's `I`-prefixed types to the unprefixed name (`IColumnBuilder`/`IColumnFactory`, and `uql-orm/migrate`'s `ColumnBuilder`/`ColumnFactory`, to `TableColumnBuilder`/`TableColumnFactory`), moving the import to the entry that exports it; and `MongoQuerier`, `isMongoQuerier` and `MongoSchemaIntrospector` to `uql-orm/mongodb`.
+- An upsert's conflict keys to a query, `upsertOne(User, { email: true }, row)` to `upsertOne(User, { $conflict: { email: true } }, row)`, and its `{ update: X }` options to `X` as its fourth argument, in `upsertOne`, `upsertMany` and a trigger's `upsertInto`; `const { id } = await upsertOne(...)` to `const id`.
+- Renamed exports, at the import and every use: `raw` to `sql`, `QueryWhereMap` to `QueryWhere`, `IndexColumnSchema` to `IndexEntry`, `IndexColumnModifiers` to `IndexEntryModifiers`, `RelationKeyMap` to `KeyMap`, `FilterCondition` to `FilterWhere`, `SqlMigrationModuleOptions` to `MigrationModuleOptions`, `buildSqlQuerierMigrationModule` to `buildMigrationModule`, `QueryDialect` to `SqlQueryDialect`, `EngineFeatures` to `DialectFeatures`, `KnownMigratorDialect` to `DialectName`, `QueryConflictPaths` to `QueryConflictKeys`, `D1Preparer`/`D1Database` to `D1Queryable`, 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`, `Sqlite3QuerierPool` to `SqliteQuerierPool`, the migration builder's `I`-prefixed types to the unprefixed name (`IColumnBuilder`/`IColumnFactory`, and `uql-orm/migrate`'s `ColumnBuilder`/`ColumnFactory`, to `TableColumnBuilder`/`TableColumnFactory`), moving the import to the entry that exports it; and `MongoQuerier`, `isMongoQuerier` and `MongoSchemaIntrospector` to `uql-orm/mongodb`.
 - Imports off `uql-orm/maria`, `uql-orm/mongo` and `uql-orm/bunSql` to `uql-orm/mariadb`, `uql-orm/mongodb` and `uql-orm/bun-sql`, and off `uql-orm/type`, `uql-orm/dialect`, `uql-orm/entity`, `uql-orm/querier` and `uql-orm/namingStrategy` to `uql-orm`.
 - The `[idKey]?: '...'` brand, and its import, on a key not called `id`, `_id` or `uuid` and on every composite.
 

package/dist/builders.js

@@ -1,7 +1,7 @@
 import ts from 'typescript';
 import { call, flag, flagOrCall } from './columnMethods.js';
 import { formatFindings, locationAt } from './context.js';
-import { FOREIGN_KEY_IN_DEFINED, NO_KEY_TYPE, nameClash, ON_DELETE_ON_RELATION } from './definedMessages.js';
+import { UNJOINED_FOREIGN_KEY, NO_KEY_TYPE, nameClash, ON_DELETE_ON_RELATION } from './definedMessages.js';
 import { CHAINED_OPTIONS, FIRST_CALL_OPTIONS } from './definedOptions.js';
 import { applyEdits, editedText, replaced, replacingUses, reparsedAgain, unedited, } from './edits.js';
 import { importEdits } from './imports.js';
@@ -340,7 +340,7 @@ function definedColumn(node) {
         }
         const target = targetOf(references.call.arguments[0]);
         if (identifierText(references.receiver) === 'f' || !target) {
-            return { message: target ? NO_KEY_TYPE : FOREIGN_KEY_IN_DEFINED };
+            return { message: target ? NO_KEY_TYPE : UNJOINED_FOREIGN_KEY };
         }
         const onDelete = methods.get('onDelete');
         const cut = [references, ...(onDelete ? [onDelete] : [])].map((method) => ({
@@ -360,7 +360,7 @@ function definedColumn(node) {
     const references = options.get('references');
     const target = references && targetOf(references);
     if (references && !target) {
-        return { message: FOREIGN_KEY_IN_DEFINED };
+        return { message: UNJOINED_FOREIGN_KEY };
     }
     if (target && !options.has('type')) {
         return { message: NO_KEY_TYPE };
@@ -408,7 +408,7 @@ function claimKey(name, { target, onDelete }, claims, targets) {
     }
     const relation = ts.isIdentifier(name) ? /^(.+?)(?:Id|_id)$/.exec(key)?.[1] : undefined;
     if (!relation || claims.named.has(relation) || !targets.insertable) {
-        return { claims, problem: FOREIGN_KEY_IN_DEFINED };
+        return { claims, problem: UNJOINED_FOREIGN_KEY };
     }
     const written = [
         `references: (${targets.param}) => ${targets.param}.${key}`,

package/dist/definedMessages.d.ts

@@ -1,7 +1,7 @@
 /** Why a name the codemod writes is refused: a file already binds it. */
 export declare const nameClash: (name: string) => string;
 /** Why a defined column's foreign key is refused: no relation joins on it, and none can be written for it. */
-export declare const FOREIGN_KEY_IN_DEFINED = "references another entity, and no relation can be named for it: declare one in '.relations()', as 'rel.manyToOne(Target, { references: (row) => row.key })'";
+export declare const UNJOINED_FOREIGN_KEY = "references another entity, and no relation can be named for it: declare one in '.relations()', as 'rel.manyToOne(Target, { references: (row) => row.key })'";
 /** Why a joined column's `onDelete` is refused: its relation states another, or takes options the codemod cannot write into. */
 export declare const ON_DELETE_ON_RELATION = "joins through a relation that cannot take its 'onDelete': settle the action in that relation's options";
 /** Why a foreign key with no type is refused: a defined column states its own, which only its target's key implied. */

package/dist/definedMessages.js

@@ -1,7 +1,7 @@
 /** Why a name the codemod writes is refused: a file already binds it. */
 export const nameClash = (name) => `'${name}' is already named here, and the codemod writes it`;
 /** Why a defined column's foreign key is refused: no relation joins on it, and none can be written for it. */
-export const FOREIGN_KEY_IN_DEFINED = "references another entity, and no relation can be named for it: declare one in '.relations()', as 'rel.manyToOne(Target, { references: (row) => row.key })'";
+export const UNJOINED_FOREIGN_KEY = "references another entity, and no relation can be named for it: declare one in '.relations()', as 'rel.manyToOne(Target, { references: (row) => row.key })'";
 /** Why a joined column's `onDelete` is refused: its relation states another, or takes options the codemod cannot write into. */
 export const ON_DELETE_ON_RELATION = "joins through a relation that cannot take its 'onDelete': settle the action in that relation's options";
 /** Why a foreign key with no type is refused: a defined column states its own, which only its target's key implied. */

package/dist/imports.js

@@ -76,6 +76,7 @@ export const SQL_TAG = 'sql';
  */
 const RENAMED_EXPORTS = new Map([
     ['QueryWhereMap', { to: 'QueryWhere' }],
+    ['QueryConflictPaths', { to: 'QueryConflictKeys' }],
     ['IndexColumnSchema', { to: 'IndexEntry' }],
     ['IndexColumnModifiers', { to: 'IndexEntryModifiers' }],
     ['RelationKeyMap', { to: 'KeyMap' }],

package/dist/transform.js

@@ -428,19 +428,31 @@ function rewriteBuilderCall(call, ctx) {
 }
 const UPSERT_CALLS = new Set(['upsertOne', 'upsertMany', 'upsertInto']);
 /**
- * Rewrites an upsert's options holding `update` alone into that update, its fourth argument now. Read wherever it is
- * called, since a querier is seldom imported from uql where it is used. Any other fourth argument is already an
- * update, `{}` included, so a second run changes nothing.
+ * Rewrites an upsert's conflict keys into its query's `$conflict`, `{ $conflict: { sku: true } }`, and its options
+ * holding `update` alone into that update, its fourth argument now. Read wherever it is called, since a querier is
+ * seldom imported from uql where it is used. A query already naming `$conflict`, or typed with one, is left as it is,
+ * and any other fourth argument is already an update, `{}` included, so a second run changes nothing.
  */
 function rewriteUpsertCall(call, ctx) {
     const callee = call.expression;
     const name = identifierText(ts.isPropertyAccessExpression(callee) ? callee.name : callee);
+    if (!name || !UPSERT_CALLS.has(name)) {
+        return;
+    }
+    const keys = call.arguments[1];
+    if (call.arguments.length >= 3 && keys && isConflictKeys(keys, ctx)) {
+        ctx.edits.push(replaced(keys, ['{ $conflict: ', original(keys), ' }']));
+    }
     const options = call.arguments[3];
     const update = options && upsertUpdate(options);
-    if (name && UPSERT_CALLS.has(name) && update) {
+    if (update) {
         ctx.edits.push(replaced(options, [original(update)]));
     }
 }
+/** Whether `keys` is the old conflict map, `{ sku: true }`: an argument of its own, not yet a query naming `$conflict`. */
+function isConflictKeys(keys, ctx) {
+    return !ts.isSpreadElement(keys) && !ctx.checker.getTypeAtLocation(keys).getProperty('$conflict');
+}
 /** The value of options holding `update` alone, `{ update: value }` or `{ update }`. */
 function upsertUpdate(options) {
     const literal = objectLiteral(options);

package/package.json

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