@easy-cms/drizzle 1.28.0 → 1.30.0

package/dist/index.d.ts

@@ -126,7 +126,13 @@ interface ColumnModel {
     readonly locale?: string;
     /** The default locale's column, used when a query names no locale. */
     readonly defaultLocale?: boolean;
+    /**
+     * A relationship to several collections (#327) has two columns, `<field>_relation_to` and
+     * `<field>_value`: which part of `{ relationTo, value }` this one holds.
+     */
+    readonly part?: PolymorphicPart;
 }
+type PolymorphicPart = 'relationTo' | 'value';
 /** A child table holding array rows or hasMany values. */
 interface ChildModel {
     readonly kind: 'array' | 'values';
@@ -213,6 +219,13 @@ declare class Migrator {
     private statistics;
     /** Renames become drop + add unless interactive. */
     private changes;
+    /**
+     * A relationship that gets several collections (#327) keeps its values: the id moves from
+     * `<field>` to `<field>_value`, with the first collection of `to` as `<field>_relation_to`
+     * (list the collection it had first). Back to one collection, the values of that collection
+     * stay and the others are removed, with a warning.
+     */
+    private relationMoves;
     /**
      * A new default locale changes which locale the plain column holds (`title` is the default
      * locale's, `title__en` another's). Moves the values so every locale keeps its own.

package/dist/index.js

@@ -24,10 +24,19 @@ function setAt(data, path, value) {
   }
   current[path[path.length - 1]] = value;
 }
-var columnPath = (column) => column.locale === void 0 ? column.path : [...column.path, column.locale];
+var columnPath = (column) => {
+  const path = column.locale === void 0 ? column.path : [...column.path, column.locale];
+  return column.part === void 0 ? path : [...path, column.part];
+};
 function rowToData(model, row) {
   const data = {};
   for (const column of model.columns) setAt(data, columnPath(column), row[column.column] ?? null);
+  for (const column of model.columns) {
+    if (column.part !== "value") continue;
+    const path = columnPath(column).slice(0, -1);
+    const pair = getAt(data, path);
+    if (pair && pair.value === null && pair.relationTo === null) setAt(data, path, null);
+  }
   for (const child of model.children)
     setAt(
       data,
@@ -67,7 +76,9 @@ async function attachChildren(db, model, rows, docs) {
       const list = getAt(docs[index], path);
       if (!Array.isArray(list)) return;
       const id = locale === void 0 ? childRow.id : String(childRow.id).replace(new RegExp(`:${locale}$`), "");
-      list.push(child.kind === "array" ? { id, ...childDocs?.[i] } : childRow.value);
+      list.push(
+        child.kind === "array" ? { id, ...childDocs?.[i] } : "relation_to" in childRow ? { relationTo: childRow.relation_to, value: childRow.value } : childRow.value
+      );
     });
   }
 }
@@ -104,10 +115,12 @@ async function insertChildren(db, model, parentId, data) {
 async function insertChild(db, child, parentId, items, locale) {
   const localeColumn = locale === void 0 ? {} : { _locale: locale };
   if (child.kind === "values") {
+    const polymorphic = "relation_to" in child.table.table;
     const rows = items.map((value, i) => ({
       _parent_id: parentId,
       _order: i,
-      value,
+      // Several collections (#327): `{ relationTo, value }`.
+      ...polymorphic ? { relation_to: value.relationTo, value: value.value } : { value },
       ...localeColumn
     }));
     for (const part of chunks(rows)) await db.insert(child.table.table).values(part);
@@ -176,7 +189,7 @@ import { SchemaError } from "@easy-cms/core";
 // src/schema.ts
 import { createHash } from "crypto";
 import { ConfigError } from "@easy-cms/core";
-import { isHasMany } from "@easy-cms/core/internal";
+import { isHasMany, isPolymorphic } from "@easy-cms/core/internal";
 function tableModels(schema) {
   const all = [];
   const walk = (model) => {
@@ -345,6 +358,7 @@ function buildTable(builder, name, kind, fields, options) {
     }
     if (kind === "values" && options.valueField) {
       const valueKind = columnKind(options.valueField);
+      if (isPolymorphic(options.valueField)) add("relation_to", dialect.text("relation_to"), "text");
       add("value", makeColumn(dialect, "value", valueKind), valueKind);
       indexes.push({ column: "value", unique: false });
     }
@@ -387,21 +401,34 @@ function buildTable(builder, name, kind, fields, options) {
       } else {
         const kindOfColumn = columnKind(field);
         const localization = field.localized ? builder.localization : null;
-        const targets = localization ? localization.locales.map((locale) => ({
+        const parts = isPolymorphic(
+          field
+        ) ? [
+          { suffix: "_relation_to", part: "relationTo", kind: "text" },
+          { suffix: "_value", part: "value", kind: kindOfColumn }
+        ] : [{ suffix: "", kind: kindOfColumn }];
+        const targets = (localization ? localization.locales.map((locale) => ({
           column: locale === localization.defaultLocale ? base : `${base}__${snake(locale)}`,
           locale
-        })) : [{ column: base, locale: void 0 }];
-        for (const { column, locale } of targets) {
-          add(column, makeColumn(dialect, column, kindOfColumn), kindOfColumn);
-          columnModels.push(
-            locale === void 0 ? { path: fieldPath, field, column } : {
-              path: fieldPath,
-              field,
-              column,
-              locale,
-              defaultLocale: locale === localization?.defaultLocale
-            }
-          );
+        })) : [{ column: base, locale: void 0 }]).flatMap(
+          ({ column, locale }) => parts.map(({ suffix, part, kind: kind2 }) => ({
+            column: locale === void 0 ? `${base}${suffix}` : column.replace(base, `${base}${suffix}`),
+            locale,
+            part,
+            kind: kind2
+          }))
+        );
+        for (const { column, locale, part, kind: partKind } of targets) {
+          add(column, makeColumn(dialect, column, partKind), partKind);
+          const model2 = locale === void 0 ? { path: fieldPath, field, column } : {
+            path: fieldPath,
+            field,
+            column,
+            locale,
+            defaultLocale: locale === localization?.defaultLocale
+          };
+          columnModels.push(part ? { ...model2, part } : model2);
+          if (part === "relationTo") continue;
           if (topLevel && kind === "root" && (field.unique || field.type === "slug") && field.uniqueWithin !== void 0) {
             const within = [field.uniqueWithin].flat().map(snake);
             indexes.push({
@@ -547,7 +574,10 @@ var Migrator = class {
   /** Renames become drop + add unless interactive. */
   async changes(prev, cur, interactive) {
     const { dialect } = this.options;
-    const moves = this.localeMoves(prev, metaOf(prev), metaOf(cur));
+    const moves = [
+      ...this.localeMoves(prev, metaOf(prev), metaOf(cur)),
+      ...this.relationMoves(prev)
+    ];
     const [from, to] = [withoutMeta(prev), withoutMeta(cur)];
     if (interactive && moves.length === 0) return dialect.migration(from, to);
     const union = unionSnapshot(from, to);
@@ -557,6 +587,62 @@ var Migrator = class {
       ...await dialect.migration(union, to)
     ];
   }
+  /**
+   * A relationship that gets several collections (#327) keeps its values: the id moves from
+   * `<field>` to `<field>_value`, with the first collection of `to` as `<field>_relation_to`
+   * (list the collection it had first). Back to one collection, the values of that collection
+   * stay and the others are removed, with a warning.
+   */
+  relationMoves(prev) {
+    const q = (name) => this.q(name);
+    const text = (value) => `'${value.replace(/'/g, "''")}'`;
+    const statements = [];
+    const lost = /* @__PURE__ */ new Set();
+    for (const model of tableModels(this.options.schema)) {
+      const old = snapshotTable(prev, model.name);
+      if (!old) continue;
+      const has = (column) => Object.hasOwn(old.columns ?? {}, column);
+      if (model.kind === "values" && model.valueField?.type === "relationship") {
+        const to = model.valueField.to;
+        if (typeof to !== "string" && !has("relation_to"))
+          statements.push(
+            `UPDATE ${q(model.name)} SET ${q("relation_to")} = ${text(to[0])} WHERE ${q("relation_to")} IS NULL`
+          );
+        if (typeof to === "string" && has("relation_to")) {
+          statements.push(
+            `DELETE FROM ${q(model.name)} WHERE ${q("relation_to")} IS NULL OR ${q("relation_to")} <> ${text(to)}`
+          );
+          lost.add(model.name);
+        }
+        continue;
+      }
+      for (const column of model.columns) {
+        const { field } = column;
+        if (field.type !== "relationship") continue;
+        if (column.part === "value" && typeof field.to !== "string") {
+          const before = column.column.replace(/_value(?=__|$)/, "");
+          const relationTo = column.column.replace(/_value(?=__|$)/, "_relation_to");
+          if (has(column.column) || !has(before)) continue;
+          statements.push(
+            `UPDATE ${q(model.name)} SET ${q(column.column)} = ${q(before)}, ${q(relationTo)} = ${text(field.to[0])} WHERE ${q(before)} IS NOT NULL`
+          );
+        } else if (column.part === void 0 && typeof field.to === "string") {
+          const value = column.column.replace(/(?=__|$)/, "_value");
+          const relationTo = column.column.replace(/(?=__|$)/, "_relation_to");
+          if (has(column.column) || !has(value) || !has(relationTo)) continue;
+          statements.push(
+            `UPDATE ${q(model.name)} SET ${q(column.column)} = ${q(value)} WHERE ${q(relationTo)} = ${text(field.to)}`
+          );
+          lost.add(`${model.name}.${column.column}`);
+        }
+      }
+    }
+    if (lost.size > 0)
+      this.options.logger.warn(
+        `Links to other collections are removed from ${[...lost].join(", ")}: those relationships now have one collection.`
+      );
+    return statements;
+  }
   /**
    * A new default locale changes which locale the plain column holds (`title` is the default
    * locale's, `title__en` another's). Moves the values so every locale keeps its own.
@@ -579,7 +665,7 @@ var Migrator = class {
         if (!column.defaultLocale || !has(column.column)) continue;
         const base = column.column;
         const moved = model.columns.find(
-          (c) => c.path.join(".") === column.path.join(".") && c.locale === was.defaultLocale
+          (c) => c.path.join(".") === column.path.join(".") && c.part === column.part && c.locale === was.defaultLocale
         );
         if (moved && !has(moved.column)) keep.push(`${q(moved.column)} = ${q(base)}`);
         clear.push(`${q(base)} = NULL`);
@@ -764,7 +850,7 @@ function extensionHint(error) {
 
 // src/query.ts
 import { QueryError } from "@easy-cms/core";
-import { parseId, TRIGRAM_LIKE_MIN } from "@easy-cms/core/internal";
+import { isPolymorphic as isPolymorphic2, parseId, TRIGRAM_LIKE_MIN } from "@easy-cms/core/internal";
 import {
   and as and2,
   asc as asc2,
@@ -802,6 +888,14 @@ var SYSTEM_COLUMNS = {
   updatedAt: "updated_at"
 };
 var col2 = (model, name) => model.table[name];
+var PARTS = /* @__PURE__ */ new Set(["relationTo", "value"]);
+function polymorphicPart(segment, shown, to) {
+  if (segment !== void 0 && PARTS.has(segment)) return segment;
+  if (segment !== void 0 && to.includes(segment)) return { collection: segment };
+  throw new QueryError(
+    `"${shown}" links to several collections: query "${shown}.relationTo" and "${shown}.value", or "${shown}.<collection>" (${to.map((t) => `"${shown}.${t}"`).join(", ")})`
+  );
+}
 var ID_FIELD = { name: "id", type: "relationship", to: "" };
 var LIKE_TYPES = /* @__PURE__ */ new Set(["text", "textarea", "email", "slug", "select"]);
 var JSON_TYPES = {
@@ -836,6 +930,16 @@ function resolveJsonValue(fields, rest, shown, localization, blocks) {
     }
     const inner = rest.slice(next);
     const shownHere = [shown, ...rest.slice(0, next)].join(".");
+    if (isPolymorphic2(field)) {
+      if (inner.length > 1) throw new QueryError(`Cannot query inside "${shownHere}"`);
+      const part = polymorphicPart(inner[0], shownHere, field.to);
+      if (typeof part === "object")
+        throw new QueryError(
+          `Inside blocks, query "${shownHere}.relationTo" and "${shownHere}.value"`
+        );
+      const value = part === "value" ? { type: "integer", field } : { type: "text", field: void 0 };
+      return field.hasMany ? { lists: [path], path: [part], ...value } : { lists: [], path: [...path, part], ...value };
+    }
     if ("hasMany" in field && field.hasMany === true) {
       if (inner.length > 0) throw new QueryError(`Cannot query inside "${shownHere}"`);
       return { lists: [path], path: [], type: JSON_TYPES[field.type] ?? "text", field };
@@ -903,6 +1007,33 @@ function resolvePath(model, segments, drafts, localization = null) {
       const value = resolveJsonValue(rows, rest, shown, localization, true);
       return { kind: "blocks", column: col2(model, column2.column), value };
     }
+    if (isPolymorphic2(field)) {
+      if (last + 1 < segments.length - 1)
+        throw new QueryError(`Cannot query inside "${segments.slice(0, last + 2).join(".")}"`);
+      const shownField = segments.slice(0, last + 1).join(".");
+      const named = segments[last + 1];
+      const part = named === void 0 ? "value" : polymorphicPart(named, shownField, field.to);
+      const columnOfPart = (wanted) => {
+        const found = model.columns.find(
+          (c) => same(c) && c.part === wanted && (!field.localized || (locale === void 0 ? c.defaultLocale : c.locale === locale))
+        );
+        if (!found) throw new QueryError(`Unknown locale "${locale}" for "${shown}"`);
+        return col2(model, found.column);
+      };
+      if (typeof part === "object")
+        return {
+          kind: "column",
+          column: columnOfPart("value"),
+          field,
+          collection: { slug: part.collection, column: columnOfPart("relationTo") }
+        };
+      return {
+        kind: "column",
+        column: columnOfPart(part),
+        field: part === "value" ? field : void 0,
+        ...named === void 0 ? { bare: field.to } : {}
+      };
+    }
     if (last < segments.length - 1) {
       throw new QueryError(`Cannot query inside "${shown}" (${field.type} field)`);
     }
@@ -1011,8 +1142,32 @@ var WhereBuilder = class {
     );
     const parts = entries.map(([op, value]) => {
       if (!OPERATORS.has(op)) throw new QueryError(`Unknown operator "${op}" on "${path}"`);
-      if (target.kind === "column")
+      if (target.kind === "column") {
+        if (target.bare && op !== "exists") polymorphicPart(void 0, path, target.bare);
+        if (target.collection) {
+          const { slug, column } = target.collection;
+          const is = eq2(column, slug);
+          if (op === "exists")
+            return value === false ? or(isNull(column), ne(column, slug)) : is;
+          if (op === "not_equals" || op === "not_in") {
+            const positive = op === "not_equals" ? "equals" : "in";
+            const match = operatorSQL(
+              this.dialect,
+              target.column,
+              target.field,
+              positive,
+              value,
+              path
+            );
+            return or(isNull(column), not(and2(is, match)));
+          }
+          return and2(
+            is,
+            operatorSQL(this.dialect, target.column, target.field, op, value, path)
+          );
+        }
         return operatorSQL(this.dialect, target.column, target.field, op, value, path);
+      }
       if (target.kind === "blocks") return this.blocks(target, op, value, path);
       return this.child(model, target.child, target.rest, op, value, path, target.locale);
     });
@@ -1068,18 +1223,25 @@ var WhereBuilder = class {
       this.db.select({ one: sql`1` }).from(table.table).where(condition ? and2(link, condition) : link)
     );
     if (child.kind === "values") {
-      if (rest.length > 0) throw new QueryError(`Cannot query inside "${path}"`);
-      const valueColumn = col2(table, "value");
-      if (op === "exists") return value === false ? not(subquery(void 0)) : subquery(void 0);
-      if (op === "not_equals")
-        return not(
-          subquery(operatorSQL(this.dialect, valueColumn, table.valueField, "equals", value, path))
-        );
-      if (op === "not_in")
-        return not(
-          subquery(operatorSQL(this.dialect, valueColumn, table.valueField, "in", value, path))
-        );
-      return subquery(operatorSQL(this.dialect, valueColumn, table.valueField, op, value, path));
+      let valueColumn = col2(table, "value");
+      let valueField = table.valueField;
+      let only;
+      if (valueField && isPolymorphic2(valueField)) {
+        if (rest.length > 1) throw new QueryError(`Cannot query inside "${path}"`);
+        const shown = rest.length === 1 ? path.split(".").slice(0, -1).join(".") : path;
+        const part = rest.length === 0 && op === "exists" ? "value" : polymorphicPart(rest[0], shown, valueField.to);
+        if (part === "relationTo") {
+          valueColumn = col2(table, "relation_to");
+          valueField = void 0;
+        } else if (typeof part === "object") only = eq2(col2(table, "relation_to"), part.collection);
+      } else if (rest.length > 0) throw new QueryError(`Cannot query inside "${path}"`);
+      if (op === "exists") return value === false ? not(subquery(only)) : subquery(only);
+      const matching = (operator) => subquery(
+        and2(only, operatorSQL(this.dialect, valueColumn, valueField, operator, value, path))
+      );
+      if (op === "not_equals") return not(matching("equals"));
+      if (op === "not_in") return not(matching("in"));
+      return matching(op);
     }
     if (rest.length === 0) {
       if (op !== "exists") throw new QueryError(`"${path}" is an array; query one of its fields`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/drizzle",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "description": "Shared Drizzle ORM layer for Easy CMS database adapters",
   "license": "MIT",
   "type": "module",
@@ -23,10 +23,10 @@
     "drizzle-orm": "0.45.4"
   },
   "peerDependencies": {
-    "@easy-cms/core": "^1.28.0"
+    "@easy-cms/core": "^1.30.0"
   },
   "devDependencies": {
-    "@easy-cms/core": "^1.28.0"
+    "@easy-cms/core": "^1.30.0"
   },
   "publishConfig": {
     "access": "public"