@objectstack/driver-sql 9.10.0 → 9.11.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { SchemaMode, QueryAST, DriverOptions } from '@objectstack/spec/data';
+import { AutonumberToken, SchemaMode, QueryAST, DriverOptions } from '@objectstack/spec/data';
 import { IDataDriver } from '@objectstack/spec/contracts';
 import knex, { Knex } from 'knex';
 
@@ -119,12 +119,19 @@ declare class SqlDriver implements IDataDriver {
     protected autoNumberFields: Record<string, Array<{
         name: string;
         format: string;
-        prefix: string;
-        padWidth: number;
+        tokens: AutonumberToken[];
         tenantField: string | null;
     }>>;
     /** Whether the sequences table has been ensured this process. */
     protected sequencesTableReady: boolean;
+    /**
+     * Whether `_objectstack_sequences` is the current `key_hash`-keyed shape.
+     * Set on a fresh create or a successful in-place migration. If a legacy table
+     * could NOT be migrated, this stays false: fixed-prefix sequences (empty
+     * scope) keep working via the legacy `(object, tenant_id, field)` key, while a
+     * per-scope write raises an actionable error rather than corrupting counters.
+     */
+    protected sequencesHasKeyHash: boolean;
     /** In-flight ensure promise; deduplicates concurrent first calls. */
     protected sequencesTableEnsurePromise: Promise<void> | null;
     /**
@@ -214,8 +221,34 @@ declare class SqlDriver implements IDataDriver {
     /**
      * Ensure the sequence-counter table exists. Idempotent and cheap after
      * the first call (cached via `sequencesTableReady`).
+     *
+     * The row key is `key_hash` — a SHA-256 of `(object, tenant_id, field, scope)`
+     * where `scope` is the rendered autonumber prefix (date/field tokens before
+     * the `{0000}` slot), so a new day/group/parent starts a fresh counter. A
+     * single 64-char hashed primary key (rather than the four raw columns, which
+     * blow past MySQL's 3072-byte index limit under utf8mb4 and bound how long a
+     * `{field}` scope may be) keys every dialect uniformly and lets `scope` be a
+     * generous non-indexed column. Fixed-prefix formats use the empty scope and
+     * keep their single global counter (backward compatible).
      */
     protected ensureSequencesTable(): Promise<void>;
+    /** SHA-256 of the composite counter key — the table's single-column PK. */
+    protected sequenceKeyHash(object: string, tenantId: string, field: string, scope: string): string;
+    /** Create the current `key_hash`-keyed sequences table shape. */
+    protected createSequencesTable(table: string): Promise<void>;
+    /**
+     * Migrate a pre-existing `_objectstack_sequences` table to the current
+     * `key_hash`-keyed shape. Handles both the original 3-column table (no
+     * `scope`) and an interim 4-column `(object, tenant_id, field, scope)` table:
+     * every legacy row is read, its `key_hash` computed in app code (no portable
+     * SQL hash exists), and re-inserted into a freshly built table that then
+     * replaces the original. Idempotent — a no-op once `key_hash` is present.
+     *
+     * If the rebuild fails, `sequencesHasKeyHash` stays false: fixed-prefix
+     * sequences keep working via the legacy key and per-scope writes error
+     * actionably (see getNextSequenceValue), rather than corrupting data.
+     */
+    protected ensureSequencesKeyHashShape(): Promise<void>;
     /**
      * Bootstrap helper: scan the data table for the highest numeric suffix
      * matching `prefix` (optionally scoped to a tenant). Used the first time
@@ -237,12 +270,14 @@ declare class SqlDriver implements IDataDriver {
      * Gaps are tolerated by design — a rolled-back insert "burns" a number,
      * matching standard sequence semantics.
      */
-    protected getNextSequenceValue(object: string, tableName: string, field: string, prefix: string, tenantField: string | null, tenantId: string | null, parentTrx?: Knex.Transaction): Promise<number>;
+    protected getNextSequenceValue(object: string, tableName: string, field: string, prefix: string, tenantField: string | null, tenantId: string | null, parentTrx?: Knex.Transaction, scope?: string): Promise<number>;
     /**
-     * For each `auto_number` field on the object that the caller did not
-     * provide a value for, reserve the next sequence value scoped to the
-     * record's tenant (or globally if the object has no tenant field) and
-     * render `prefix + zero-padded(value)`.
+     * For each `auto_number` field the caller left empty, render the format and
+     * reserve the next counter value. The counter is scoped to the rendered
+     * prefix (date tokens like `{YYYYMMDD}` in the request's business timezone,
+     * plus `{field}` interpolation from the row), so it resets per period/group;
+     * the full rendered prefix bootstraps the counter from existing data, and the
+     * tenant scopes it for isolation.
      */
     protected fillAutoNumberFields(object: string, row: Record<string, any>, options?: DriverOptions): Promise<void>;
     update(object: string, id: string | number, data: Record<string, any>, options?: DriverOptions): Promise<any>;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SchemaMode, QueryAST, DriverOptions } from '@objectstack/spec/data';
+import { AutonumberToken, SchemaMode, QueryAST, DriverOptions } from '@objectstack/spec/data';
 import { IDataDriver } from '@objectstack/spec/contracts';
 import knex, { Knex } from 'knex';
 
@@ -119,12 +119,19 @@ declare class SqlDriver implements IDataDriver {
     protected autoNumberFields: Record<string, Array<{
         name: string;
         format: string;
-        prefix: string;
-        padWidth: number;
+        tokens: AutonumberToken[];
         tenantField: string | null;
     }>>;
     /** Whether the sequences table has been ensured this process. */
     protected sequencesTableReady: boolean;
+    /**
+     * Whether `_objectstack_sequences` is the current `key_hash`-keyed shape.
+     * Set on a fresh create or a successful in-place migration. If a legacy table
+     * could NOT be migrated, this stays false: fixed-prefix sequences (empty
+     * scope) keep working via the legacy `(object, tenant_id, field)` key, while a
+     * per-scope write raises an actionable error rather than corrupting counters.
+     */
+    protected sequencesHasKeyHash: boolean;
     /** In-flight ensure promise; deduplicates concurrent first calls. */
     protected sequencesTableEnsurePromise: Promise<void> | null;
     /**
@@ -214,8 +221,34 @@ declare class SqlDriver implements IDataDriver {
     /**
      * Ensure the sequence-counter table exists. Idempotent and cheap after
      * the first call (cached via `sequencesTableReady`).
+     *
+     * The row key is `key_hash` — a SHA-256 of `(object, tenant_id, field, scope)`
+     * where `scope` is the rendered autonumber prefix (date/field tokens before
+     * the `{0000}` slot), so a new day/group/parent starts a fresh counter. A
+     * single 64-char hashed primary key (rather than the four raw columns, which
+     * blow past MySQL's 3072-byte index limit under utf8mb4 and bound how long a
+     * `{field}` scope may be) keys every dialect uniformly and lets `scope` be a
+     * generous non-indexed column. Fixed-prefix formats use the empty scope and
+     * keep their single global counter (backward compatible).
      */
     protected ensureSequencesTable(): Promise<void>;
+    /** SHA-256 of the composite counter key — the table's single-column PK. */
+    protected sequenceKeyHash(object: string, tenantId: string, field: string, scope: string): string;
+    /** Create the current `key_hash`-keyed sequences table shape. */
+    protected createSequencesTable(table: string): Promise<void>;
+    /**
+     * Migrate a pre-existing `_objectstack_sequences` table to the current
+     * `key_hash`-keyed shape. Handles both the original 3-column table (no
+     * `scope`) and an interim 4-column `(object, tenant_id, field, scope)` table:
+     * every legacy row is read, its `key_hash` computed in app code (no portable
+     * SQL hash exists), and re-inserted into a freshly built table that then
+     * replaces the original. Idempotent — a no-op once `key_hash` is present.
+     *
+     * If the rebuild fails, `sequencesHasKeyHash` stays false: fixed-prefix
+     * sequences keep working via the legacy key and per-scope writes error
+     * actionably (see getNextSequenceValue), rather than corrupting data.
+     */
+    protected ensureSequencesKeyHashShape(): Promise<void>;
     /**
      * Bootstrap helper: scan the data table for the highest numeric suffix
      * matching `prefix` (optionally scoped to a tenant). Used the first time
@@ -237,12 +270,14 @@ declare class SqlDriver implements IDataDriver {
      * Gaps are tolerated by design — a rolled-back insert "burns" a number,
      * matching standard sequence semantics.
      */
-    protected getNextSequenceValue(object: string, tableName: string, field: string, prefix: string, tenantField: string | null, tenantId: string | null, parentTrx?: Knex.Transaction): Promise<number>;
+    protected getNextSequenceValue(object: string, tableName: string, field: string, prefix: string, tenantField: string | null, tenantId: string | null, parentTrx?: Knex.Transaction, scope?: string): Promise<number>;
     /**
-     * For each `auto_number` field on the object that the caller did not
-     * provide a value for, reserve the next sequence value scoped to the
-     * record's tenant (or globally if the object has no tenant field) and
-     * render `prefix + zero-padded(value)`.
+     * For each `auto_number` field the caller left empty, render the format and
+     * reserve the next counter value. The counter is scoped to the rendered
+     * prefix (date tokens like `{YYYYMMDD}` in the request's business timezone,
+     * plus `{field}` interpolation from the row), so it resets per period/group;
+     * the full rendered prefix bootstraps the counter from existing data, and the
+     * tenant scopes it for isolation.
      */
     protected fillAutoNumberFields(object: string, row: Record<string, any>, options?: DriverOptions): Promise<void>;
     update(object: string, id: string | number, data: Record<string, any>, options?: DriverOptions): Promise<any>;

package/dist/index.js

@@ -36,6 +36,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/sql-driver.ts
+var import_data = require("@objectstack/spec/data");
 var import_system = require("@objectstack/spec/system");
 var import_shared = require("@objectstack/spec/shared");
 var import_knex = __toESM(require("knex"));
@@ -103,6 +104,14 @@ var SqlDriver = class {
     this.autoNumberFields = {};
     /** Whether the sequences table has been ensured this process. */
     this.sequencesTableReady = false;
+    /**
+     * Whether `_objectstack_sequences` is the current `key_hash`-keyed shape.
+     * Set on a fresh create or a successful in-place migration. If a legacy table
+     * could NOT be migrated, this stays false: fixed-prefix sequences (empty
+     * scope) keep working via the legacy `(object, tenant_id, field)` key, while a
+     * per-scope write raises an actionable error rather than corrupting counters.
+     */
+    this.sequencesHasKeyHash = false;
     /** In-flight ensure promise; deduplicates concurrent first calls. */
     this.sequencesTableEnsurePromise = null;
     /**
@@ -410,6 +419,15 @@ var SqlDriver = class {
   /**
    * Ensure the sequence-counter table exists. Idempotent and cheap after
    * the first call (cached via `sequencesTableReady`).
+   *
+   * The row key is `key_hash` — a SHA-256 of `(object, tenant_id, field, scope)`
+   * where `scope` is the rendered autonumber prefix (date/field tokens before
+   * the `{0000}` slot), so a new day/group/parent starts a fresh counter. A
+   * single 64-char hashed primary key (rather than the four raw columns, which
+   * blow past MySQL's 3072-byte index limit under utf8mb4 and bound how long a
+   * `{field}` scope may be) keys every dialect uniformly and lets `scope` be a
+   * generous non-indexed column. Fixed-prefix formats use the empty scope and
+   * keep their single global counter (backward compatible).
    */
   async ensureSequencesTable() {
     if (this.sequencesTableReady) return;
@@ -421,18 +439,15 @@ var SqlDriver = class {
       const exists = await this.knex.schema.hasTable(SEQUENCES_TABLE);
       if (!exists) {
         try {
-          await this.knex.schema.createTable(SEQUENCES_TABLE, (t) => {
-            t.string("object").notNullable();
-            t.string("tenant_id").notNullable();
-            t.string("field").notNullable();
-            t.bigInteger("last_value").notNullable().defaultTo(0);
-            t.timestamp("updated_at").defaultTo(this.knex.fn.now());
-            t.primary(["object", "tenant_id", "field"]);
-          });
+          await this.createSequencesTable(SEQUENCES_TABLE);
+          this.sequencesHasKeyHash = true;
         } catch (err) {
           const stillMissing = !await this.knex.schema.hasTable(SEQUENCES_TABLE);
           if (stillMissing) throw err;
+          await this.ensureSequencesKeyHashShape();
         }
+      } else {
+        await this.ensureSequencesKeyHashShape();
       }
       this.sequencesTableReady = true;
     })();
@@ -442,6 +457,71 @@ var SqlDriver = class {
       this.sequencesTableEnsurePromise = null;
     }
   }
+  /** SHA-256 of the composite counter key — the table's single-column PK. */
+  sequenceKeyHash(object, tenantId, field, scope) {
+    return (0, import_node_crypto.createHash)("sha256").update(`${object}${tenantId}${field}${scope}`).digest("hex");
+  }
+  /** Create the current `key_hash`-keyed sequences table shape. */
+  async createSequencesTable(table) {
+    await this.knex.schema.createTable(table, (t) => {
+      t.string("key_hash", 64).notNullable().primary();
+      t.string("object").notNullable();
+      t.string("tenant_id").notNullable();
+      t.string("field").notNullable();
+      t.string("scope", 1024).notNullable().defaultTo("");
+      t.bigInteger("last_value").notNullable().defaultTo(0);
+      t.timestamp("updated_at").defaultTo(this.knex.fn.now());
+    });
+  }
+  /**
+   * Migrate a pre-existing `_objectstack_sequences` table to the current
+   * `key_hash`-keyed shape. Handles both the original 3-column table (no
+   * `scope`) and an interim 4-column `(object, tenant_id, field, scope)` table:
+   * every legacy row is read, its `key_hash` computed in app code (no portable
+   * SQL hash exists), and re-inserted into a freshly built table that then
+   * replaces the original. Idempotent — a no-op once `key_hash` is present.
+   *
+   * If the rebuild fails, `sequencesHasKeyHash` stays false: fixed-prefix
+   * sequences keep working via the legacy key and per-scope writes error
+   * actionably (see getNextSequenceValue), rather than corrupting data.
+   */
+  async ensureSequencesKeyHashShape() {
+    if (await this.knex.schema.hasColumn(SEQUENCES_TABLE, "key_hash")) {
+      this.sequencesHasKeyHash = true;
+      return;
+    }
+    const hasScope = await this.knex.schema.hasColumn(SEQUENCES_TABLE, "scope");
+    const TMP = `${SEQUENCES_TABLE}__rebuild`;
+    try {
+      const rows = await this.knex(SEQUENCES_TABLE).select("*");
+      await this.knex.schema.dropTableIfExists(TMP);
+      await this.createSequencesTable(TMP);
+      const migrated = rows.map((r) => {
+        const scope = hasScope && r.scope != null ? String(r.scope) : "";
+        return {
+          key_hash: this.sequenceKeyHash(String(r.object), String(r.tenant_id), String(r.field), scope),
+          object: r.object,
+          tenant_id: r.tenant_id,
+          field: r.field,
+          scope,
+          last_value: r.last_value ?? 0,
+          updated_at: r.updated_at ?? this.knex.fn.now()
+        };
+      });
+      if (migrated.length > 0) await this.knex(TMP).insert(migrated);
+      await this.knex.schema.dropTable(SEQUENCES_TABLE);
+      await this.knex.schema.renameTable(TMP, SEQUENCES_TABLE);
+      this.sequencesHasKeyHash = true;
+    } catch (err) {
+      this.sequencesHasKeyHash = false;
+      await this.knex.schema.dropTableIfExists(TMP).catch(() => {
+      });
+      this.logger.warn(
+        `[autonumber] Failed to migrate ${SEQUENCES_TABLE} to the key_hash shape. Fixed-prefix autonumbers keep working; date/{field}/per-parent formats will error until the table is migrated.`,
+        { error: String(err) }
+      );
+    }
+  }
   /**
    * Bootstrap helper: scan the data table for the highest numeric suffix
    * matching `prefix` (optionally scoped to a tenant). Used the first time
@@ -479,10 +559,16 @@ var SqlDriver = class {
    * Gaps are tolerated by design — a rolled-back insert "burns" a number,
    * matching standard sequence semantics.
    */
-  async getNextSequenceValue(object, tableName, field, prefix, tenantField, tenantId, parentTrx) {
+  async getNextSequenceValue(object, tableName, field, prefix, tenantField, tenantId, parentTrx, scope = "") {
     await this.ensureSequencesTable();
     const resolvedTenantId = tenantField && tenantId ? String(tenantId) : GLOBAL_TENANT;
-    const key = { object: tableName, tenant_id: resolvedTenantId, field };
+    if (scope !== "" && !this.sequencesHasKeyHash) {
+      throw new Error(
+        `Cannot generate a per-scope autonumber for "${object}.${field}": the ${SEQUENCES_TABLE} table is still the legacy shape. Migrate it to the key_hash shape before using date/{field}/per-parent formats.`
+      );
+    }
+    const key = this.sequencesHasKeyHash ? { key_hash: this.sequenceKeyHash(tableName, resolvedTenantId, field, scope) } : { object: tableName, tenant_id: resolvedTenantId, field };
+    const insertRow = this.sequencesHasKeyHash ? { ...key, object: tableName, tenant_id: resolvedTenantId, field, scope } : { ...key };
     const runner = parentTrx ?? this.knex;
     return runner.transaction(async (trx) => {
       let existing;
@@ -502,7 +588,7 @@ var SqlDriver = class {
         );
         const initial = seedMax + 1;
         try {
-          await trx(SEQUENCES_TABLE).insert({ ...key, last_value: initial });
+          await trx(SEQUENCES_TABLE).insert({ ...insertRow, last_value: initial });
           return initial;
         } catch (err) {
           existing = await trx(SEQUENCES_TABLE).where(key).forUpdate().first();
@@ -515,31 +601,43 @@ var SqlDriver = class {
     });
   }
   /**
-   * For each `auto_number` field on the object that the caller did not
-   * provide a value for, reserve the next sequence value scoped to the
-   * record's tenant (or globally if the object has no tenant field) and
-   * render `prefix + zero-padded(value)`.
+   * For each `auto_number` field the caller left empty, render the format and
+   * reserve the next counter value. The counter is scoped to the rendered
+   * prefix (date tokens like `{YYYYMMDD}` in the request's business timezone,
+   * plus `{field}` interpolation from the row), so it resets per period/group;
+   * the full rendered prefix bootstraps the counter from existing data, and the
+   * 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];
     if (!cfgs || cfgs.length === 0) return;
     const parentTrx = options?.transaction;
+    const timezone = options?.timezone;
+    const now = /* @__PURE__ */ new Date();
     for (const cfg of cfgs) {
       if (row[cfg.name] !== void 0 && row[cfg.name] !== null && row[cfg.name] !== "") continue;
+      const missing = (0, import_data.missingFieldValues)(cfg.tokens, row);
+      if (missing.length > 0) {
+        throw new Error(
+          `Cannot generate autonumber "${object}.${cfg.name}" (format "${cfg.format}"): referenced field(s) [${missing.join(", ")}] are empty on the record. Fields interpolated into an autonumber format must be set before the record is created.`
+        );
+      }
       const rowTenant = cfg.tenantField ? row[cfg.tenantField] : void 0;
       const optTenant = options?.tenantId;
       const tenantId = rowTenant != null && rowTenant !== "" ? String(rowTenant) : optTenant != null && optTenant !== "" ? String(optTenant) : null;
+      const probe = (0, import_data.renderAutonumber)({ tokens: cfg.tokens, seq: 0, record: row, now, timezone });
       const next = await this.getNextSequenceValue(
         object,
         tableName,
         cfg.name,
-        cfg.prefix,
+        probe.prefix,
         cfg.tenantField,
         tenantId,
-        parentTrx
+        parentTrx,
+        probe.scope
       );
-      row[cfg.name] = `${cfg.prefix}${String(next).padStart(cfg.padWidth, "0")}`;
+      row[cfg.name] = (0, import_data.renderAutonumber)({ tokens: cfg.tokens, seq: next, record: row, now, timezone }).value;
     }
   }
   async update(object, id, data, options) {
@@ -898,10 +996,8 @@ var SqlDriver = class {
           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}";
-            const m = fmt.match(/\{(0+)\}/);
-            const padWidth = m ? m[1].length : 4;
-            const prefix = m ? fmt.slice(0, m.index ?? 0) : fmt;
-            autoNumberCols.push({ name, format: fmt, prefix, padWidth, tenantField });
+            const tokens = (0, import_data.parseAutonumberFormat)(fmt);
+            autoNumberCols.push({ name, format: fmt, tokens, tenantField });
           }
         }
       }