@objectstack/driver-sql 9.11.0 → 10.0.0

package/dist/index.d.mts

@@ -101,6 +101,20 @@ declare class SqlDriver implements IDataDriver {
     protected numericFields: Record<string, string[]>;
     protected dateFields: Record<string, Set<string>>;
     protected datetimeFields: Record<string, Set<string>>;
+    /**
+     * Federation read path (ADR-0015). For external objects whose physical
+     * remote table differs from the object name, these map between the two so
+     * {@link getBuilder} targets the remote table while the coercion maps above
+     * stay keyed by OBJECT name (matching formatInput/formatOutput). Empty for
+     * managed objects, so the managed query path is unchanged.
+     */
+    protected physicalTableByObject: Record<string, string>;
+    protected physicalSchemaByObject: Record<string, string>;
+    protected objectByPhysicalTable: Record<string, string>;
+    /** External columnMap (ADR-0015): logical field -> physical remote column (for WHERE/ORDER BY/writes). */
+    protected fieldColumnByObject: Record<string, Record<string, string>>;
+    /** External columnMap inverse: physical remote column -> logical field (for read output remap). */
+    protected columnFieldByObject: Record<string, Record<string, string>>;
     protected tablesWithTimestamps: Set<string>;
     /**
      * Autonumber field configs per table, captured during initObjects.
@@ -334,6 +348,30 @@ declare class SqlDriver implements IDataDriver {
     /**
      * Batch-initialise tables from an array of object definitions.
      */
+    /**
+     * DDL-free metadata registration for a federated (external) object — the
+     * read-path counterpart to {@link initObjects} (ADR-0015 federation).
+     *
+     * `initObjects` is gated by `assertSchemaMutable` and therefore throws for
+     * any non-`managed` driver, which left external objects with NO read-coercion
+     * metadata and the query path resolving to a table named after the object
+     * instead of its remote table. This populates the same coercion maps (keyed
+     * by OBJECT name, matching formatInput/formatOutput/coerceFilterValue) and
+     * records the physical remote table (`external.remoteName`, optionally
+     * `external.remoteSchema`) so {@link getBuilder} targets it — WITHOUT running
+     * any DDL (createTable/alterTable/columnInfo). Keep the field-classification
+     * below in sync with initObjects() if the field-type -> storage mapping changes.
+     */
+    registerExternalObject(schema: {
+        name: string;
+        fields?: Record<string, any>;
+        tenancy?: any;
+        external?: {
+            remoteName?: string;
+            remoteSchema?: string;
+            columnMap?: Record<string, string>;
+        };
+    }): void;
     initObjects(objects: Array<{
         name: string;
         fields?: Record<string, any>;
@@ -439,6 +477,16 @@ declare class SqlDriver implements IDataDriver {
      * `initObjects`). Returns null when the builder is not table-scoped yet.
      */
     protected tableNameForBuilder(builder: any): string | null;
+    /**
+     * Coercion-map key for a builder. Coercion maps (date/datetime) are keyed by
+     * OBJECT name, but after the federation change {@link getBuilder} targets the
+     * physical remote table, so a builder reports the remote name. Map it back to
+     * the object name for external objects; identity for managed ones (no reverse
+     * entry). Note datetime coercion is a SQLite-only concern (see
+     * coerceFilterValue), and SQLite external tables are bare-named, so this is
+     * exact where it matters.
+     */
+    protected coercionKey(builder: any): string | null;
     /**
      * Collapse a `Field.date` value to a timezone-naive `YYYY-MM-DD`
      * calendar-day string (ADR-0053 Phase 1). A `Date` collapses to its UTC
@@ -498,6 +546,19 @@ declare class SqlDriver implements IDataDriver {
     private applyContainsLike;
     protected applyFilterCondition(builder: Knex.QueryBuilder, condition: any, logicalOp?: 'and' | 'or', tableHint?: string | null): void;
     protected mapSortField(field: string): string;
+    /**
+     * Physical column for a logical field on an external object that declares an
+     * `external.columnMap` (ADR-0015). Returns `fallback` (the caller's existing
+     * per-site resolution) when the object has no columnMap, so managed objects
+     * and external objects without a columnMap are byte-for-byte unchanged.
+     */
+    protected remoteColumn(object: string | null | undefined, field: string, fallback: string): string;
+    /**
+     * Remap a write payload's logical field keys to physical remote columns for an
+     * external object with a columnMap. No-op otherwise. Applied AFTER formatInput
+     * (whose value coercion is keyed by logical field name).
+     */
+    protected applyWriteColumnMap(object: string, data: any): any;
     protected mapAggregateFunc(func: string): string;
     protected buildWindowFunction(spec: any): string;
     protected createColumn(table: Knex.CreateTableBuilder, name: string, field: any): void;

package/dist/index.d.ts

@@ -101,6 +101,20 @@ declare class SqlDriver implements IDataDriver {
     protected numericFields: Record<string, string[]>;
     protected dateFields: Record<string, Set<string>>;
     protected datetimeFields: Record<string, Set<string>>;
+    /**
+     * Federation read path (ADR-0015). For external objects whose physical
+     * remote table differs from the object name, these map between the two so
+     * {@link getBuilder} targets the remote table while the coercion maps above
+     * stay keyed by OBJECT name (matching formatInput/formatOutput). Empty for
+     * managed objects, so the managed query path is unchanged.
+     */
+    protected physicalTableByObject: Record<string, string>;
+    protected physicalSchemaByObject: Record<string, string>;
+    protected objectByPhysicalTable: Record<string, string>;
+    /** External columnMap (ADR-0015): logical field -> physical remote column (for WHERE/ORDER BY/writes). */
+    protected fieldColumnByObject: Record<string, Record<string, string>>;
+    /** External columnMap inverse: physical remote column -> logical field (for read output remap). */
+    protected columnFieldByObject: Record<string, Record<string, string>>;
     protected tablesWithTimestamps: Set<string>;
     /**
      * Autonumber field configs per table, captured during initObjects.
@@ -334,6 +348,30 @@ declare class SqlDriver implements IDataDriver {
     /**
      * Batch-initialise tables from an array of object definitions.
      */
+    /**
+     * DDL-free metadata registration for a federated (external) object — the
+     * read-path counterpart to {@link initObjects} (ADR-0015 federation).
+     *
+     * `initObjects` is gated by `assertSchemaMutable` and therefore throws for
+     * any non-`managed` driver, which left external objects with NO read-coercion
+     * metadata and the query path resolving to a table named after the object
+     * instead of its remote table. This populates the same coercion maps (keyed
+     * by OBJECT name, matching formatInput/formatOutput/coerceFilterValue) and
+     * records the physical remote table (`external.remoteName`, optionally
+     * `external.remoteSchema`) so {@link getBuilder} targets it — WITHOUT running
+     * any DDL (createTable/alterTable/columnInfo). Keep the field-classification
+     * below in sync with initObjects() if the field-type -> storage mapping changes.
+     */
+    registerExternalObject(schema: {
+        name: string;
+        fields?: Record<string, any>;
+        tenancy?: any;
+        external?: {
+            remoteName?: string;
+            remoteSchema?: string;
+            columnMap?: Record<string, string>;
+        };
+    }): void;
     initObjects(objects: Array<{
         name: string;
         fields?: Record<string, any>;
@@ -439,6 +477,16 @@ declare class SqlDriver implements IDataDriver {
      * `initObjects`). Returns null when the builder is not table-scoped yet.
      */
     protected tableNameForBuilder(builder: any): string | null;
+    /**
+     * Coercion-map key for a builder. Coercion maps (date/datetime) are keyed by
+     * OBJECT name, but after the federation change {@link getBuilder} targets the
+     * physical remote table, so a builder reports the remote name. Map it back to
+     * the object name for external objects; identity for managed ones (no reverse
+     * entry). Note datetime coercion is a SQLite-only concern (see
+     * coerceFilterValue), and SQLite external tables are bare-named, so this is
+     * exact where it matters.
+     */
+    protected coercionKey(builder: any): string | null;
     /**
      * Collapse a `Field.date` value to a timezone-naive `YYYY-MM-DD`
      * calendar-day string (ADR-0053 Phase 1). A `Date` collapses to its UTC
@@ -498,6 +546,19 @@ declare class SqlDriver implements IDataDriver {
     private applyContainsLike;
     protected applyFilterCondition(builder: Knex.QueryBuilder, condition: any, logicalOp?: 'and' | 'or', tableHint?: string | null): void;
     protected mapSortField(field: string): string;
+    /**
+     * Physical column for a logical field on an external object that declares an
+     * `external.columnMap` (ADR-0015). Returns `fallback` (the caller's existing
+     * per-site resolution) when the object has no columnMap, so managed objects
+     * and external objects without a columnMap are byte-for-byte unchanged.
+     */
+    protected remoteColumn(object: string | null | undefined, field: string, fallback: string): string;
+    /**
+     * Remap a write payload's logical field keys to physical remote columns for an
+     * external object with a columnMap. No-op otherwise. Applied AFTER formatInput
+     * (whose value coercion is keyed by logical field name).
+     */
+    protected applyWriteColumnMap(object: string, data: any): any;
     protected mapAggregateFunc(func: string): string;
     protected buildWindowFunction(spec: any): string;
     protected createColumn(table: Knex.CreateTableBuilder, name: string, field: any): void;

package/dist/index.js

@@ -86,6 +86,20 @@ var SqlDriver = class {
     this.numericFields = {};
     this.dateFields = {};
     this.datetimeFields = {};
+    /**
+     * Federation read path (ADR-0015). For external objects whose physical
+     * remote table differs from the object name, these map between the two so
+     * {@link getBuilder} targets the remote table while the coercion maps above
+     * stay keyed by OBJECT name (matching formatInput/formatOutput). Empty for
+     * managed objects, so the managed query path is unchanged.
+     */
+    this.physicalTableByObject = {};
+    this.physicalSchemaByObject = {};
+    this.objectByPhysicalTable = {};
+    /** External columnMap (ADR-0015): logical field -> physical remote column (for WHERE/ORDER BY/writes). */
+    this.fieldColumnByObject = {};
+    /** External columnMap inverse: physical remote column -> logical field (for read output remap). */
+    this.columnFieldByObject = {};
     this.tablesWithTimestamps = /* @__PURE__ */ new Set();
     /**
      * Autonumber field configs per table, captured during initObjects.
@@ -310,6 +324,13 @@ var SqlDriver = class {
   // ===================================
   async connect() {
     await this.ensureDatabaseExists();
+    if (this.isSqlite) {
+      try {
+        await this.knex.raw("PRAGMA auto_vacuum = INCREMENTAL");
+      } catch (e) {
+        this.logger.warn("Failed to set PRAGMA auto_vacuum=INCREMENTAL", e);
+      }
+    }
   }
   async checkHealth() {
     try {
@@ -335,7 +356,7 @@ var SqlDriver = class {
       if (query.orderBy && Array.isArray(query.orderBy)) {
         for (const item of query.orderBy) {
           if (item.field) {
-            b.orderBy(this.mapSortField(item.field), item.order || "asc");
+            b.orderBy(this.remoteColumn(object, item.field, this.mapSortField(item.field)), item.order || "asc");
           }
         }
       }
@@ -412,7 +433,7 @@ var SqlDriver = class {
     this.injectTenantOnInsert(object, toInsert, options);
     await this.fillAutoNumberFields(object, toInsert, options);
     const builder = this.getBuilder(object, options);
-    const formatted = this.formatInput(object, toInsert);
+    const formatted = this.applyWriteColumnMap(object, this.formatInput(object, toInsert));
     const result = await builder.insert(formatted).returning("*");
     return this.formatOutput(object, result[0]);
   }
@@ -609,8 +630,8 @@ var SqlDriver = class {
    * tenant scopes it for isolation.
    */
   async fillAutoNumberFields(object, row, options) {
-    const tableName = import_system.StorageNameMapping.resolveTableName({ name: object });
-    const cfgs = this.autoNumberFields[tableName] || this.autoNumberFields[object];
+    const tableName = this.physicalTableByObject[object] ?? import_system.StorageNameMapping.resolveTableName({ name: object });
+    const cfgs = this.autoNumberFields[object] || this.autoNumberFields[tableName];
     if (!cfgs || cfgs.length === 0) return;
     const parentTrx = options?.transaction;
     const timezone = options?.timezone;
@@ -644,7 +665,7 @@ var SqlDriver = class {
     this.auditMissingTenant(object, "update", options);
     const builder = this.getBuilder(object, options).where("id", id);
     this.applyTenantScope(builder, object, options);
-    const formatted = this.formatInput(object, data);
+    const formatted = this.applyWriteColumnMap(object, this.formatInput(object, data));
     if (this.tablesWithTimestamps.has(object)) {
       if (this.isSqlite) {
         const now = /* @__PURE__ */ new Date();
@@ -670,7 +691,7 @@ var SqlDriver = class {
     this.auditMissingTenant(object, "upsert", options);
     this.injectTenantOnInsert(object, toUpsert, options);
     await this.fillAutoNumberFields(object, toUpsert, options);
-    const formatted = this.formatInput(object, toUpsert);
+    const formatted = this.applyWriteColumnMap(object, this.formatInput(object, toUpsert));
     const mergeKeys = conflictKeys && conflictKeys.length > 0 ? conflictKeys : ["id"];
     const builder = this.getBuilder(object, options);
     await builder.insert(formatted).onConflict(mergeKeys).merge();
@@ -953,6 +974,89 @@ var SqlDriver = class {
   /**
    * Batch-initialise tables from an array of object definitions.
    */
+  /**
+   * DDL-free metadata registration for a federated (external) object — the
+   * read-path counterpart to {@link initObjects} (ADR-0015 federation).
+   *
+   * `initObjects` is gated by `assertSchemaMutable` and therefore throws for
+   * any non-`managed` driver, which left external objects with NO read-coercion
+   * metadata and the query path resolving to a table named after the object
+   * instead of its remote table. This populates the same coercion maps (keyed
+   * by OBJECT name, matching formatInput/formatOutput/coerceFilterValue) and
+   * records the physical remote table (`external.remoteName`, optionally
+   * `external.remoteSchema`) so {@link getBuilder} targets it — WITHOUT running
+   * any DDL (createTable/alterTable/columnInfo). Keep the field-classification
+   * below in sync with initObjects() if the field-type -> storage mapping changes.
+   */
+  registerExternalObject(schema) {
+    const key = schema.name;
+    const remoteName = schema.external?.remoteName || schema.name;
+    const remoteSchema = schema.external?.remoteSchema;
+    this.physicalTableByObject[key] = remoteName;
+    this.objectByPhysicalTable[remoteName] = key;
+    if (remoteSchema) {
+      if (this.isSqlite) {
+        this.logger.warn(
+          `[sql-driver] external object "${key}" declares remoteSchema="${remoteSchema}" but SQLite has no schema namespace; ignoring (treating "${remoteName}" as a bare table).`
+        );
+      } else {
+        this.physicalSchemaByObject[key] = remoteSchema;
+      }
+    }
+    const columnMap = schema.external?.columnMap;
+    if (columnMap && typeof columnMap === "object" && Object.keys(columnMap).length > 0) {
+      const fieldToCol = {};
+      const colToField = {};
+      for (const [remoteCol, localField] of Object.entries(columnMap)) {
+        if (typeof localField === "string" && localField) {
+          fieldToCol[localField] = remoteCol;
+          colToField[remoteCol] = localField;
+        }
+      }
+      this.fieldColumnByObject[key] = fieldToCol;
+      this.columnFieldByObject[key] = colToField;
+    }
+    const jsonCols = [];
+    const booleanCols = [];
+    const numericCols = [];
+    const dateCols = [];
+    const datetimeCols = [];
+    const autoNumberCols = [];
+    const tenancyDecl = schema?.tenancy;
+    let tenantField = null;
+    if (tenancyDecl && tenancyDecl.enabled !== false && tenancyDecl.tenantField) {
+      const declared = String(tenancyDecl.tenantField);
+      if (schema.fields && Object.prototype.hasOwnProperty.call(schema.fields, declared)) {
+        tenantField = declared;
+      }
+    }
+    if (!tenantField) {
+      const hasOrgField = !!(schema.fields && Object.prototype.hasOwnProperty.call(schema.fields, "organization_id"));
+      tenantField = hasOrgField ? "organization_id" : null;
+    }
+    if (schema.fields) {
+      for (const [name, field] of Object.entries(schema.fields)) {
+        const type = field.type || "string";
+        if (this.isJsonField(type, field)) jsonCols.push(name);
+        if (type === "boolean" || type === "toggle") booleanCols.push(name);
+        if (NUMERIC_SCALAR_TYPES.has(type) && !field.multiple) numericCols.push(name);
+        if (type === "date") dateCols.push(name);
+        if (type === "datetime") datetimeCols.push(name);
+        if (type === "auto_number" || type === "autonumber") {
+          const rawFmt = typeof field.autonumberFormat === "string" && field.autonumberFormat ? field.autonumberFormat : typeof field.format === "string" && field.format ? field.format : "";
+          const fmt = rawFmt || "{0000}";
+          autoNumberCols.push({ name, format: fmt, tokens: (0, import_data.parseAutonumberFormat)(fmt), tenantField });
+        }
+      }
+    }
+    this.jsonFields[key] = jsonCols;
+    this.booleanFields[key] = booleanCols;
+    this.numericFields[key] = numericCols;
+    this.autoNumberFields[key] = autoNumberCols;
+    this.tenantFieldByTable[key] = tenantField;
+    if (dateCols.length) this.dateFields[key] = new Set(dateCols);
+    if (datetimeCols.length) this.datetimeFields[key] = new Set(datetimeCols);
+  }
   async initObjects(objects) {
     var _a, _b;
     this.assertSchemaMutable("initObjects");
@@ -1194,7 +1298,12 @@ var SqlDriver = class {
     return this.knex;
   }
   getBuilder(object, options) {
-    let builder = this.knex(object);
+    const physical = this.physicalTableByObject[object] ?? object;
+    let builder = this.knex(physical);
+    const remoteSchema = this.physicalSchemaByObject[object];
+    if (remoteSchema) {
+      builder = builder.withSchema(remoteSchema);
+    }
     if (options?.transaction) {
       builder = builder.transacting(options.transaction);
     }
@@ -1293,6 +1402,20 @@ var SqlDriver = class {
     if (typeof t === "string") return t;
     return null;
   }
+  /**
+   * Coercion-map key for a builder. Coercion maps (date/datetime) are keyed by
+   * OBJECT name, but after the federation change {@link getBuilder} targets the
+   * physical remote table, so a builder reports the remote name. Map it back to
+   * the object name for external objects; identity for managed ones (no reverse
+   * entry). Note datetime coercion is a SQLite-only concern (see
+   * coerceFilterValue), and SQLite external tables are bare-named, so this is
+   * exact where it matters.
+   */
+  coercionKey(builder) {
+    const physical = this.tableNameForBuilder(builder);
+    if (physical == null) return null;
+    return this.objectByPhysicalTable[physical] ?? physical;
+  }
   /**
    * Collapse a `Field.date` value to a timezone-naive `YYYY-MM-DD`
    * calendar-day string (ADR-0053 Phase 1). A `Date` collapses to its UTC
@@ -1386,7 +1509,7 @@ var SqlDriver = class {
   }
   applyFilters(builder, filters) {
     if (!filters) return;
-    const table = this.tableNameForBuilder(builder);
+    const table = this.coercionKey(builder);
     if (!Array.isArray(filters) && typeof filters === "object") {
       const hasMongoOperators = Object.keys(filters).some(
         (k) => k.startsWith("$") || typeof filters[k] === "object" && filters[k] !== null && Object.keys(filters[k]).some((op) => op.startsWith("$"))
@@ -1397,7 +1520,7 @@ var SqlDriver = class {
       }
       for (const [key, value] of Object.entries(filters)) {
         if (["limit", "offset", "fields", "orderBy"].includes(key)) continue;
-        builder.where(key, this.coerceFilterValue(table, key, value));
+        builder.where(this.remoteColumn(table, key, key), this.coerceFilterValue(table, key, value));
       }
       return;
     }
@@ -1413,8 +1536,9 @@ var SqlDriver = class {
         const [fieldRaw, op, value] = item;
         const isCriterion = typeof fieldRaw === "string" && typeof op === "string";
         if (isCriterion) {
-          const field = this.mapSortField(fieldRaw);
-          const coerced = this.coerceFilterValue(table, field, value);
+          const localField = this.mapSortField(fieldRaw);
+          const field = this.remoteColumn(table, fieldRaw, localField);
+          const coerced = this.coerceFilterValue(table, localField, value);
           const apply = (b) => {
             const method = nextJoin === "or" ? "orWhere" : "where";
             const methodIn = nextJoin === "or" ? "orWhereIn" : "whereIn";
@@ -1466,7 +1590,7 @@ var SqlDriver = class {
   }
   applyFilterCondition(builder, condition, logicalOp = "and", tableHint) {
     if (!condition || typeof condition !== "object") return;
-    const table = tableHint ?? this.tableNameForBuilder(builder);
+    const table = tableHint ?? this.coercionKey(builder);
     for (const [key, value] of Object.entries(condition)) {
       if (key === "$and" && Array.isArray(value)) {
         builder.where((qb) => {
@@ -1486,10 +1610,11 @@ var SqlDriver = class {
           }
         });
       } else if (typeof value === "object" && value !== null && !Array.isArray(value)) {
-        const field = this.mapSortField(key);
+        const localField = this.mapSortField(key);
+        const field = this.remoteColumn(table, key, localField);
         for (const [op, opValue] of Object.entries(value)) {
           const method = logicalOp === "or" ? "orWhere" : "where";
-          const coerced = this.coerceFilterValue(table, field, opValue);
+          const coerced = this.coerceFilterValue(table, localField, opValue);
           switch (op) {
             case "$eq":
               builder[method](field, coerced);
@@ -1527,9 +1652,10 @@ var SqlDriver = class {
           }
         }
       } else {
-        const field = this.mapSortField(key);
+        const localField = this.mapSortField(key);
+        const field = this.remoteColumn(table, key, localField);
         const method = logicalOp === "or" ? "orWhere" : "where";
-        builder[method](field, this.coerceFilterValue(table, field, value));
+        builder[method](field, this.coerceFilterValue(table, localField, value));
       }
     }
   }
@@ -1539,6 +1665,28 @@ var SqlDriver = class {
     if (field === "updatedAt") return "updated_at";
     return field;
   }
+  /**
+   * Physical column for a logical field on an external object that declares an
+   * `external.columnMap` (ADR-0015). Returns `fallback` (the caller's existing
+   * per-site resolution) when the object has no columnMap, so managed objects
+   * and external objects without a columnMap are byte-for-byte unchanged.
+   */
+  remoteColumn(object, field, fallback) {
+    const m = object ? this.fieldColumnByObject[object] : void 0;
+    return m && m[field] || fallback;
+  }
+  /**
+   * Remap a write payload's logical field keys to physical remote columns for an
+   * external object with a columnMap. No-op otherwise. Applied AFTER formatInput
+   * (whose value coercion is keyed by logical field name).
+   */
+  applyWriteColumnMap(object, data) {
+    const m = this.fieldColumnByObject[object];
+    if (!m || !data || typeof data !== "object") return data;
+    const out = {};
+    for (const [k, v] of Object.entries(data)) out[m[k] ?? k] = v;
+    return out;
+  }
   mapAggregateFunc(func) {
     switch (func) {
       case "count":
@@ -1795,6 +1943,15 @@ var SqlDriver = class {
   }
   formatOutput(object, data) {
     if (!data) return data;
+    const colToField = this.columnFieldByObject[object];
+    if (colToField && typeof data === "object") {
+      for (const [remoteCol, localField] of Object.entries(colToField)) {
+        if (remoteCol !== localField && Object.prototype.hasOwnProperty.call(data, remoteCol)) {
+          data[localField] = data[remoteCol];
+          delete data[remoteCol];
+        }
+      }
+    }
     if (this.isSqlite) {
       const jsonFields = this.jsonFields[object];
       if (jsonFields && jsonFields.length > 0) {