@easy-cms/drizzle 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -75,6 +75,10 @@ interface ColumnModel {
     readonly path: readonly string[];
     readonly field: Field;
     readonly column: string;
+    /** For localized fields: the locale whose value this column holds. */
+    readonly locale?: string;
+    /** The default locale's column, used when a query names no locale. */
+    readonly defaultLocale?: boolean;
 }
 /** A child table holding array rows or hasMany values. */
 interface ChildModel {
@@ -82,6 +86,9 @@ interface ChildModel {
     readonly path: readonly string[];
     readonly field: Field;
     readonly table: TableModel;
+    /** Localized: rows carry `_locale`, and the data holds `{ [locale]: rows }`. */
+    readonly locales?: readonly string[];
+    readonly defaultLocale?: string;
 }
 interface TableModel {
     readonly name: string;

package/dist/index.js

@@ -22,15 +22,21 @@ function setAt(data, path, value) {
   }
   current[path[path.length - 1]] = value;
 }
+var columnPath = (column) => column.locale === void 0 ? column.path : [...column.path, column.locale];
 function rowToData(model, row) {
   const data = {};
-  for (const column of model.columns) setAt(data, column.path, row[column.column] ?? null);
-  for (const child of model.children) setAt(data, child.path, []);
+  for (const column of model.columns) setAt(data, columnPath(column), row[column.column] ?? null);
+  for (const child of model.children)
+    setAt(
+      data,
+      child.path,
+      child.locales ? Object.fromEntries(child.locales.map((locale) => [locale, []])) : []
+    );
   return data;
 }
 function dataToRow(model, data) {
   const row = {};
-  for (const column of model.columns) row[column.column] = getAt(data, column.path) ?? null;
+  for (const column of model.columns) row[column.column] = getAt(data, columnPath(column)) ?? null;
   return row;
 }
 var CHUNK = 500;
@@ -54,8 +60,12 @@ async function attachChildren(db, model, rows, docs) {
     childRows.forEach((childRow, i) => {
       const index = indexById.get(childRow._parent_id);
       if (index === void 0) return;
-      const list = getAt(docs[index], child.path);
-      list.push(child.kind === "array" ? { id: childRow.id, ...childDocs?.[i] } : childRow.value);
+      const locale = child.locales ? String(childRow._locale) : void 0;
+      const path = locale === void 0 ? child.path : [...child.path, locale];
+      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);
     });
   }
 }
@@ -76,20 +86,41 @@ function toDocument(row, data, drafts) {
 async function insertChildren(db, model, parentId, data) {
   for (const child of model.children) {
     const value = getAt(data, child.path);
+    if (child.locales) {
+      if (!value || typeof value !== "object") continue;
+      for (const locale of child.locales) {
+        const items = value[locale];
+        if (Array.isArray(items) && items.length > 0)
+          await insertChild(db, child, parentId, items, locale);
+      }
+      continue;
+    }
     if (!Array.isArray(value) || value.length === 0) continue;
     await insertChild(db, child, parentId, value);
   }
 }
-async function insertChild(db, child, parentId, items) {
+async function insertChild(db, child, parentId, items, locale) {
+  const localeColumn = locale === void 0 ? {} : { _locale: locale };
   if (child.kind === "values") {
-    const rows = items.map((value, i) => ({ _parent_id: parentId, _order: i, value }));
+    const rows = items.map((value, i) => ({
+      _parent_id: parentId,
+      _order: i,
+      value,
+      ...localeColumn
+    }));
     for (const part of chunks(rows)) await db.insert(child.table.table).values(part);
     return;
   }
   for (const [i, item] of items.entries()) {
     const rowData = item;
-    const id = rowData.id;
-    await db.insert(child.table.table).values({ ...dataToRow(child.table, rowData), id, _parent_id: parentId, _order: i });
+    const id = locale === void 0 ? rowData.id : `${rowData.id}:${locale}`;
+    await db.insert(child.table.table).values({
+      ...dataToRow(child.table, rowData),
+      id,
+      _parent_id: parentId,
+      _order: i,
+      ...localeColumn
+    });
     await insertChildren(db, child.table, id, rowData);
   }
 }
@@ -412,14 +443,31 @@ function resolvePath(model, segments, drafts) {
       continue;
     }
     const child = model.children.find((c) => c.path.join(".") === path.join("."));
+    if (child?.locales) {
+      const next = segments[i + 1];
+      const named = next !== void 0 && child.locales.includes(next);
+      return {
+        kind: "child",
+        child,
+        rest: segments.slice(i + (named ? 2 : 1)),
+        locale: named ? next : child.defaultLocale
+      };
+    }
     if (child) return { kind: "child", child, rest: segments.slice(i + 1) };
-    if (i < segments.length - 1) {
+    const locale = field.localized ? segments[i + 1] : void 0;
+    const last = field.localized && locale !== void 0 ? i + 1 : i;
+    if (last < segments.length - 1) {
       throw new QueryError(`Cannot query inside "${shown}" (${field.type} field)`);
     }
-    if (field.type === "json" || field.type === "richText") {
+    if (field.type === "json" || field.type === "richText" || field.type === "blocks") {
       throw new QueryError(`Cannot query "${shown}": ${field.type} fields are not queryable`);
     }
-    const column = model.columns.find((c) => c.path.join(".") === path.join("."));
+    const same = (c) => c.path.join(".") === path.join(".");
+    const column = field.localized ? model.columns.find(
+      (c) => same(c) && (locale === void 0 ? c.defaultLocale : c.locale === locale)
+    ) : model.columns.find(same);
+    if (field.localized && !column)
+      throw new QueryError(`Unknown locale "${locale}" for "${shown}"`);
     if (!column) throw new QueryError(`Unknown field "${shown}"`);
     return { kind: "column", column: col2(model, column.column), field };
   }
@@ -510,14 +558,15 @@ var WhereBuilder = class {
       if (!OPERATORS.has(op)) throw new QueryError(`Unknown operator "${op}" on "${path}"`);
       if (target.kind === "column")
         return operatorSQL(this.dialect, target.column, target.field, op, value, path);
-      return this.child(model, target.child, target.rest, op, value, path);
+      return this.child(model, target.child, target.rest, op, value, path, target.locale);
     });
     return parts.length === 1 ? parts[0] : and(...parts);
   }
   /** Conditions on array rows or hasMany values become (NOT) EXISTS subqueries. */
-  child(parent, child, rest, op, value, path) {
+  child(parent, child, rest, op, value, path, locale) {
     const table = child.table;
-    const link = eq2(col2(table, "_parent_id"), col2(parent, "id"));
+    const parentLink = eq2(col2(table, "_parent_id"), col2(parent, "id"));
+    const link = locale === void 0 ? parentLink : and(parentLink, eq2(col2(table, "_locale"), locale));
     const subquery = (condition) => exists(
       this.db.select({ one: sql`1` }).from(table.table).where(condition ? and(link, condition) : link)
     );
@@ -569,6 +618,8 @@ function columnKind(field) {
       return "boolean";
     case "json":
     case "richText":
+    // Blocks are stored whole as JSON: rows of different kinds don't fit one child table.
+    case "blocks":
       return "json";
     case "upload":
     case "relationship":
@@ -583,7 +634,8 @@ function buildSchema(config, prefix, dialect) {
     prefix,
     tableNames: /* @__PURE__ */ new Set([migrationsTableName(prefix)]),
     // The hash covers the logical schema only, so it stays stable across releases for the same config.
-    description: []
+    description: [],
+    localization: config.localization
   };
   const collections = /* @__PURE__ */ new Map();
   const tables = {};
@@ -688,6 +740,14 @@ function buildTable(builder, name, kind, fields, options) {
     );
     add("_order", dialect.integer("_order").notNull(), "int!");
     indexes.push({ column: "_parent_id", unique: false });
+    if (options.localized) {
+      add(
+        "_locale",
+        dialect.text("_locale").notNull().default(options.localized),
+        `locale:${options.localized}`
+      );
+      indexes.push({ column: "_locale", unique: false });
+    }
     if (kind === "values" && options.valueField) {
       const valueKind = columnKind(options.valueField);
       add("value", makeColumn(dialect, "value", valueKind), valueKind);
@@ -701,26 +761,57 @@ function buildTable(builder, name, kind, fields, options) {
       if (field.type === "group") {
         walk(field.fields, fieldPath, false);
       } else if (field.type === "array") {
+        const localization = field.localized ? builder.localization : null;
         const child = buildTable(builder, `${name}__${base}`, "array", field.fields, {
-          parentIdKind: kind === "array" ? "text" : "integer"
+          parentIdKind: kind === "array" ? "text" : "integer",
+          ...localization ? { localized: localization.defaultLocale } : {}
+        });
+        children.push({
+          kind: "array",
+          path: fieldPath,
+          field,
+          table: child,
+          ...localeInfo(localization)
         });
-        children.push({ kind: "array", path: fieldPath, field, table: child });
         described.push([base, "array", child.name]);
       } else if ((field.type === "select" || field.type === "relationship") && field.hasMany) {
+        const localization = field.localized ? builder.localization : null;
         const child = buildTable(builder, `${name}__${base}`, "values", [], {
           parentIdKind: kind === "array" ? "text" : "integer",
-          valueField: field
+          valueField: field,
+          ...localization ? { localized: localization.defaultLocale } : {}
+        });
+        children.push({
+          kind: "values",
+          path: fieldPath,
+          field,
+          table: child,
+          ...localeInfo(localization)
         });
-        children.push({ kind: "values", path: fieldPath, field, table: child });
         described.push([base, "values", child.name]);
       } else {
         const kindOfColumn = columnKind(field);
-        add(base, makeColumn(dialect, base, kindOfColumn), kindOfColumn);
-        columnModels.push({ path: fieldPath, field, column: base });
-        if (topLevel && kind === "root" && (field.unique || field.type === "slug")) {
-          indexes.push({ column: base, unique: true });
-        } else if (field.index || field.unique || field.type === "relationship" || field.type === "upload") {
-          indexes.push({ column: base, unique: false });
+        const localization = field.localized ? builder.localization : null;
+        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
+            }
+          );
+          if (topLevel && kind === "root" && (field.unique || field.type === "slug")) {
+            indexes.push({ column, unique: true });
+          } else if (field.index || field.unique || field.type === "relationship" || field.type === "upload") {
+            indexes.push({ column, unique: false });
+          }
         }
       }
     }
@@ -738,6 +829,9 @@ function buildTable(builder, name, kind, fields, options) {
   const model = { name, kind, table, fields, columns: columnModels, children };
   return options.valueField ? { ...model, valueField: options.valueField } : model;
 }
+function localeInfo(localization) {
+  return localization ? { locales: localization.locales, defaultLocale: localization.defaultLocale } : {};
+}
 
 // src/database.ts
 var DEFAULT_TABLE_PREFIX = "ecms_";

package/package.json

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