arkormx 2.9.1 → 2.9.3

package/dist/{index-18M5gEFk.d.cts → index-BFNEyqme.d.cts}

@@ -291,7 +291,7 @@ declare class LengthAwarePaginator<T> {
   readonly meta: PaginationMeta;
   private readonly urlDriver;
   /**
-  * Creates a new LengthAwarePaginator instance.
+   * Creates a new LengthAwarePaginator instance.
    *
    * @param data          The collection of data being paginated.
    * @param total         The total number of items.
@@ -2328,6 +2328,7 @@ declare const defineFactory: <TModel, TAttributes extends FactoryAttributes = Pa
  */
 declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<string, unknown> | string = Record<string, any>, TAttributes extends Record<string, unknown> = ModelAttributesOf<TSchema>> {
   private static readonly lifecycleStates;
+  private static readonly castMapCache;
   private static readonly emittedDeprecationWarnings;
   private static eventsSuppressed;
   protected static factoryClass?: new () => ModelFactory<any, any>;
@@ -2372,8 +2373,8 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
   constructor(attributes?: Record<string, unknown>);
   private static emitDeprecationWarning;
   /**
-      * Compatibility-only runtime API retained for the 2.x transition window.
-      * This is no longer part of the supported runtime bootstrap path.
+   * Compatibility-only runtime API retained for the 2.x transition window.
+   * This is no longer part of the supported runtime bootstrap path.
    *
    * @deprecated Use Model.setAdapter(createPrismaDatabaseAdapter(...)) or another
    * adapter-first bootstrap path instead.
@@ -2390,6 +2391,19 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
   static getColumnMap(): Record<string, string>;
   static getColumnName(attribute: string): string;
   static getModelMetadata(): ModelMetadata;
+  /**
+   * The model's cast map. Resolved from a throwaway instance (casts are an
+   * instance field) and cached per model class.
+   */
+  static getCasts(): CastMap;
+  /**
+   * Apply built-in persistence casts (currently `json` serialisation) to a raw
+   * attribute payload, without re-running arbitrary custom setters. Used by
+   * both instance `save()` and the query-builder insert/update paths so a JS
+   * object/array destined for a `json`/`jsonb` column is serialised to a string
+   * rather than bound as a Postgres array.
+   */
+  static castAttributesForPersistence(attributes: Record<string, unknown>): Record<string, unknown>;
   static getRelationMetadata(name: string): RelationMetadata | null;
   static setFactory<TFactory extends ModelFactory<any, any>>(factoryClass: new () => TFactory): void;
   static factory<TFactory extends ModelFactory<any, any>>(count?: number): TFactory;
@@ -2885,7 +2899,7 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
    * Define a belongs to many relationship.
    *
    * @param related
-  * @param throughTable
+   * @param throughTable
    * @param foreignPivotKey
    * @param relatedPivotKey
    * @param parentKey
@@ -2897,7 +2911,7 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
    * Define a has one through relationship.
    *
    * @param related
-  * @param throughTable
+   * @param throughTable
    * @param firstKey
    * @param secondKey
    * @param localKey
@@ -2909,7 +2923,7 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
    * Define a has many through relationship.
    *
    * @param related
-  * @param throughTable
+   * @param throughTable
    * @param firstKey
    * @param secondKey
    * @param localKey
@@ -4479,6 +4493,13 @@ declare class QueryBuilder<TModel, TDelegate extends ModelQuerySchemaLike = Mode
    */
   doesntExist(): Promise<boolean>;
   private normalizeInsertPayloads;
+  /**
+   * Apply the model's persistence casts when a real model backs the query.
+   *
+   * @param payload
+   * @returns
+   */
+  private castForPersistence;
   private normalizeUpdatePayload;
   private resolveAffectedCount;
   private resolveInsertUsingRows;
@@ -4542,8 +4563,8 @@ declare class QueryBuilder<TModel, TDelegate extends ModelQuerySchemaLike = Mode
    */
   orWhereRaw(sql: string, bindings?: unknown[]): this;
   /**
-  * Paginates the query results and returns a LengthAwarePaginator instance
-  * containing data and total-aware pagination metadata.
+   * Paginates the query results and returns a LengthAwarePaginator instance
+   * containing data and total-aware pagination metadata.
    *
    * @param page
    * @param perPage
@@ -4680,6 +4701,8 @@ interface ModelStatic<TModel, TDelegate extends ModelQuerySchemaLike = ModelQuer
   getColumnMap: () => Record<string, string>;
   getColumnName: (attribute: string) => string;
   getModelMetadata: () => ModelMetadata;
+  getCasts: () => Record<string, unknown>;
+  castAttributesForPersistence: (attributes: Record<string, unknown>) => Record<string, unknown>;
   getPrimaryKey: () => string;
   getRelationMetadata: (name: string) => RelationMetadata | null;
   setAdapter: (adapter?: DatabaseAdapter) => void;
@@ -4780,12 +4803,12 @@ type NamingCase = 'camel' | 'snake' | 'kebab' | 'studly';
 type ModelTableCase = NamingCase;
 interface ArkormConfig {
   /**
-  * @property client Optional runtime client instance or resolver used for compatibility mode, CLI flows, and client-backed transactions.
-  */
+   * @property client Optional runtime client instance or resolver used for compatibility mode, CLI flows, and client-backed transactions.
+   */
   client?: ClientResolver;
   /**
-  * @deprecated Use client instead.
-  * @property prisma Optional Prisma client instance or resolver used for compatibility mode, CLI flows, and Prisma-backed transactions.
+   * @deprecated Use client instead.
+   * @property prisma Optional Prisma client instance or resolver used for compatibility mode, CLI flows, and Prisma-backed transactions.
    */
   prisma?: ClientResolver;
   /**
@@ -6284,7 +6307,7 @@ declare class CliApp {
    *
    * @param schema The Prisma schema source.
    * @returns      A map of enum names to their declared member names.
-      */
+   */
   private parsePrismaEnums;
   /**
    * Resolve the generated TypeScript declaration type for a Prisma field.
@@ -7006,6 +7029,47 @@ declare class TableBuilder {
  */
 declare class SchemaBuilder {
   private readonly operations;
+  /**
+   * Disable foreign-key constraint enforcement on the active PostgreSQL
+   * connection by switching the session into replication mode, which
+   * suppresses the internal triggers that enforce foreign keys.
+   *
+   * The setting is connection-scoped, so the disable, the work that depends
+   * on it, and the matching {@link SchemaBuilder.enableForeignKeyConstraints}
+   * must run on the same connection. Prefer
+   * {@link SchemaBuilder.withoutForeignKeyConstraints}, which guarantees this
+   * by wrapping the work in a transaction. Requires a SQL-backed adapter and
+   * a database role permitted to set `session_replication_role`.
+   *
+   * @returns
+   */
+  static disableForeignKeyConstraints(): Promise<void>;
+  /**
+   * Re-enable foreign-key constraint enforcement on the active PostgreSQL
+   * connection by restoring the default session replication role.
+   *
+   * @returns
+   */
+  static enableForeignKeyConstraints(): Promise<void>;
+  /**
+   * Run the given callback with foreign-key constraints disabled, then
+   * restore them. The whole unit runs inside a transaction so the disable,
+   * the callback, and the re-enable share a single connection (required for
+   * the connection-scoped replication role to take effect) and roll back
+   * together on failure.
+   *
+   * @example
+   * await SchemaBuilder.withoutForeignKeyConstraints(async () => {
+   *   await User.factory()
+   *     .hasAttached(Tenant.factory().has(Project.factory(3)), { status: 'active' }, 'tenantMemberships')
+   *     .create()
+   * })
+   *
+   * @param callback
+   * @returns
+   */
+  static withoutForeignKeyConstraints<TResult>(callback: () => TResult | Promise<TResult>): Promise<TResult>;
+  private static setSessionReplicationRole;
   /**
    * Defines a new table to be created in the migration.
    *

package/dist/{index-CFXreeV7.d.mts → index-EVK8EOKN.d.mts}

@@ -291,7 +291,7 @@ declare class LengthAwarePaginator<T> {
   readonly meta: PaginationMeta;
   private readonly urlDriver;
   /**
-  * Creates a new LengthAwarePaginator instance.
+   * Creates a new LengthAwarePaginator instance.
    *
    * @param data          The collection of data being paginated.
    * @param total         The total number of items.
@@ -2328,6 +2328,7 @@ declare const defineFactory: <TModel, TAttributes extends FactoryAttributes = Pa
  */
 declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<string, unknown> | string = Record<string, any>, TAttributes extends Record<string, unknown> = ModelAttributesOf<TSchema>> {
   private static readonly lifecycleStates;
+  private static readonly castMapCache;
   private static readonly emittedDeprecationWarnings;
   private static eventsSuppressed;
   protected static factoryClass?: new () => ModelFactory<any, any>;
@@ -2372,8 +2373,8 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
   constructor(attributes?: Record<string, unknown>);
   private static emitDeprecationWarning;
   /**
-      * Compatibility-only runtime API retained for the 2.x transition window.
-      * This is no longer part of the supported runtime bootstrap path.
+   * Compatibility-only runtime API retained for the 2.x transition window.
+   * This is no longer part of the supported runtime bootstrap path.
    *
    * @deprecated Use Model.setAdapter(createPrismaDatabaseAdapter(...)) or another
    * adapter-first bootstrap path instead.
@@ -2390,6 +2391,19 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
   static getColumnMap(): Record<string, string>;
   static getColumnName(attribute: string): string;
   static getModelMetadata(): ModelMetadata;
+  /**
+   * The model's cast map. Resolved from a throwaway instance (casts are an
+   * instance field) and cached per model class.
+   */
+  static getCasts(): CastMap;
+  /**
+   * Apply built-in persistence casts (currently `json` serialisation) to a raw
+   * attribute payload, without re-running arbitrary custom setters. Used by
+   * both instance `save()` and the query-builder insert/update paths so a JS
+   * object/array destined for a `json`/`jsonb` column is serialised to a string
+   * rather than bound as a Postgres array.
+   */
+  static castAttributesForPersistence(attributes: Record<string, unknown>): Record<string, unknown>;
   static getRelationMetadata(name: string): RelationMetadata | null;
   static setFactory<TFactory extends ModelFactory<any, any>>(factoryClass: new () => TFactory): void;
   static factory<TFactory extends ModelFactory<any, any>>(count?: number): TFactory;
@@ -2885,7 +2899,7 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
    * Define a belongs to many relationship.
    *
    * @param related
-  * @param throughTable
+   * @param throughTable
    * @param foreignPivotKey
    * @param relatedPivotKey
    * @param parentKey
@@ -2897,7 +2911,7 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
    * Define a has one through relationship.
    *
    * @param related
-  * @param throughTable
+   * @param throughTable
    * @param firstKey
    * @param secondKey
    * @param localKey
@@ -2909,7 +2923,7 @@ declare abstract class Model<TSchema extends ModelQuerySchemaLike | Record<strin
    * Define a has many through relationship.
    *
    * @param related
-  * @param throughTable
+   * @param throughTable
    * @param firstKey
    * @param secondKey
    * @param localKey
@@ -4479,6 +4493,13 @@ declare class QueryBuilder<TModel, TDelegate extends ModelQuerySchemaLike = Mode
    */
   doesntExist(): Promise<boolean>;
   private normalizeInsertPayloads;
+  /**
+   * Apply the model's persistence casts when a real model backs the query.
+   *
+   * @param payload
+   * @returns
+   */
+  private castForPersistence;
   private normalizeUpdatePayload;
   private resolveAffectedCount;
   private resolveInsertUsingRows;
@@ -4542,8 +4563,8 @@ declare class QueryBuilder<TModel, TDelegate extends ModelQuerySchemaLike = Mode
    */
   orWhereRaw(sql: string, bindings?: unknown[]): this;
   /**
-  * Paginates the query results and returns a LengthAwarePaginator instance
-  * containing data and total-aware pagination metadata.
+   * Paginates the query results and returns a LengthAwarePaginator instance
+   * containing data and total-aware pagination metadata.
    *
    * @param page
    * @param perPage
@@ -4680,6 +4701,8 @@ interface ModelStatic<TModel, TDelegate extends ModelQuerySchemaLike = ModelQuer
   getColumnMap: () => Record<string, string>;
   getColumnName: (attribute: string) => string;
   getModelMetadata: () => ModelMetadata;
+  getCasts: () => Record<string, unknown>;
+  castAttributesForPersistence: (attributes: Record<string, unknown>) => Record<string, unknown>;
   getPrimaryKey: () => string;
   getRelationMetadata: (name: string) => RelationMetadata | null;
   setAdapter: (adapter?: DatabaseAdapter) => void;
@@ -4780,12 +4803,12 @@ type NamingCase = 'camel' | 'snake' | 'kebab' | 'studly';
 type ModelTableCase = NamingCase;
 interface ArkormConfig {
   /**
-  * @property client Optional runtime client instance or resolver used for compatibility mode, CLI flows, and client-backed transactions.
-  */
+   * @property client Optional runtime client instance or resolver used for compatibility mode, CLI flows, and client-backed transactions.
+   */
   client?: ClientResolver;
   /**
-  * @deprecated Use client instead.
-  * @property prisma Optional Prisma client instance or resolver used for compatibility mode, CLI flows, and Prisma-backed transactions.
+   * @deprecated Use client instead.
+   * @property prisma Optional Prisma client instance or resolver used for compatibility mode, CLI flows, and Prisma-backed transactions.
    */
   prisma?: ClientResolver;
   /**
@@ -6284,7 +6307,7 @@ declare class CliApp {
    *
    * @param schema The Prisma schema source.
    * @returns      A map of enum names to their declared member names.
-      */
+   */
   private parsePrismaEnums;
   /**
    * Resolve the generated TypeScript declaration type for a Prisma field.
@@ -7006,6 +7029,47 @@ declare class TableBuilder {
  */
 declare class SchemaBuilder {
   private readonly operations;
+  /**
+   * Disable foreign-key constraint enforcement on the active PostgreSQL
+   * connection by switching the session into replication mode, which
+   * suppresses the internal triggers that enforce foreign keys.
+   *
+   * The setting is connection-scoped, so the disable, the work that depends
+   * on it, and the matching {@link SchemaBuilder.enableForeignKeyConstraints}
+   * must run on the same connection. Prefer
+   * {@link SchemaBuilder.withoutForeignKeyConstraints}, which guarantees this
+   * by wrapping the work in a transaction. Requires a SQL-backed adapter and
+   * a database role permitted to set `session_replication_role`.
+   *
+   * @returns
+   */
+  static disableForeignKeyConstraints(): Promise<void>;
+  /**
+   * Re-enable foreign-key constraint enforcement on the active PostgreSQL
+   * connection by restoring the default session replication role.
+   *
+   * @returns
+   */
+  static enableForeignKeyConstraints(): Promise<void>;
+  /**
+   * Run the given callback with foreign-key constraints disabled, then
+   * restore them. The whole unit runs inside a transaction so the disable,
+   * the callback, and the re-enable share a single connection (required for
+   * the connection-scoped replication role to take effect) and roll back
+   * together on failure.
+   *
+   * @example
+   * await SchemaBuilder.withoutForeignKeyConstraints(async () => {
+   *   await User.factory()
+   *     .hasAttached(Tenant.factory().has(Project.factory(3)), { status: 'active' }, 'tenantMemberships')
+   *     .create()
+   * })
+   *
+   * @param callback
+   * @returns
+   */
+  static withoutForeignKeyConstraints<TResult>(callback: () => TResult | Promise<TResult>): Promise<TResult>;
+  private static setSessionReplicationRole;
   /**
    * Defines a new table to be created in the migration.
    *