arkormx 2.9.2 → 2.9.4

package/dist/{index-BDnvZR_9.d.cts → index-CJ7yJR43.d.mts}

@@ -1,10 +1,10 @@
-import { Kysely, Transaction } from "kysely";
-import { PrismaClient } from "@prisma/client";
 import { Collection } from "@h3ravel/collect.js";
+import { Kysely, Transaction } from "kysely";
 import { Command } from "@h3ravel/musket";
+import { PrismaClient } from "@prisma/client";
 
 //#region src/types/migrations.d.ts
-type SchemaColumnType = 'id' | 'uuid' | 'enum' | 'string' | 'text' | 'integer' | 'bigInteger' | 'float' | 'boolean' | 'json' | 'date' | 'timestamp';
+type SchemaColumnType = 'id' | 'uuid' | 'enum' | 'string' | 'text' | 'integer' | 'bigInteger' | 'float' | 'decimal' | 'boolean' | 'json' | 'date' | 'dateTime' | 'timestamp';
 interface PrimaryKeyGeneration {
   strategy: 'uuid';
   prismaDefault?: string;
@@ -29,6 +29,10 @@ interface SchemaColumn {
   after?: string;
   default?: unknown;
   updatedAt?: boolean;
+  /** Total number of digits for `decimal` columns. */
+  precision?: number;
+  /** Number of digits to the right of the decimal point for `decimal` columns. */
+  scale?: number;
   primaryKeyGeneration?: PrimaryKeyGeneration;
 }
 interface SchemaIndex {
@@ -291,7 +295,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.
@@ -2373,8 +2377,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.
@@ -2899,7 +2903,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
@@ -2911,7 +2915,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
@@ -2923,7 +2927,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
@@ -4563,8 +4567,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
@@ -4723,7 +4727,7 @@ interface RelationshipModelStatic {
 }
 //#endregion
 //#region src/types/core.d.ts
-type CastType = 'string' | 'number' | 'boolean' | 'date' | 'json' | 'array';
+type CastType = 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'array';
 interface CastHandler<T = unknown> {
   get: (value: unknown) => T;
   set: (value: unknown) => unknown;
@@ -4803,12 +4807,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;
   /**
@@ -6307,7 +6311,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.
@@ -6796,6 +6800,16 @@ declare class TableBuilder {
    * @returns         The current TableBuilder instance for chaining.
    */
   float(name: string, options?: Partial<SchemaColumn>): this;
+  /**
+   * Defines a fixed-precision decimal column in the table.
+   *
+   * @param name      The name of the decimal column.
+   * @param precision The total number of digits. Defaults to 8.
+   * @param scale     The number of digits to the right of the point. Defaults to 2.
+   * @param options   Additional options for the decimal column.
+   * @returns         The current TableBuilder instance for chaining.
+   */
+  decimal(name: string, precision?: number, scale?: number, options?: Partial<SchemaColumn>): this;
   /**
    * Marks a column as unique in the table.
    *
@@ -6829,6 +6843,14 @@ declare class TableBuilder {
    * @returns
    */
   date(name: string, options?: Partial<SchemaColumn>): this;
+  /**
+   * Defines a date-time column in the table (timestamp without time zone).
+   *
+   * @param name      The name of the date-time column.
+   * @param options   Additional options for the date-time column.
+   * @returns         The current TableBuilder instance for chaining.
+   */
+  dateTime(name: string, options?: Partial<SchemaColumn>): this;
   /**
    * Defines colonns for a polymorphic relationship in the table.
    *
@@ -7029,6 +7051,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-CmVlF-_5.d.mts → index-CgzhC61F.d.cts}

@@ -1,10 +1,10 @@
-import { Collection } from "@h3ravel/collect.js";
 import { Kysely, Transaction } from "kysely";
-import { Command } from "@h3ravel/musket";
 import { PrismaClient } from "@prisma/client";
+import { Collection } from "@h3ravel/collect.js";
+import { Command } from "@h3ravel/musket";
 
 //#region src/types/migrations.d.ts
-type SchemaColumnType = 'id' | 'uuid' | 'enum' | 'string' | 'text' | 'integer' | 'bigInteger' | 'float' | 'boolean' | 'json' | 'date' | 'timestamp';
+type SchemaColumnType = 'id' | 'uuid' | 'enum' | 'string' | 'text' | 'integer' | 'bigInteger' | 'float' | 'decimal' | 'boolean' | 'json' | 'date' | 'dateTime' | 'timestamp';
 interface PrimaryKeyGeneration {
   strategy: 'uuid';
   prismaDefault?: string;
@@ -29,6 +29,10 @@ interface SchemaColumn {
   after?: string;
   default?: unknown;
   updatedAt?: boolean;
+  /** Total number of digits for `decimal` columns. */
+  precision?: number;
+  /** Number of digits to the right of the decimal point for `decimal` columns. */
+  scale?: number;
   primaryKeyGeneration?: PrimaryKeyGeneration;
 }
 interface SchemaIndex {
@@ -291,7 +295,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.
@@ -2373,8 +2377,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.
@@ -2899,7 +2903,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
@@ -2911,7 +2915,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
@@ -2923,7 +2927,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
@@ -4563,8 +4567,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
@@ -4723,7 +4727,7 @@ interface RelationshipModelStatic {
 }
 //#endregion
 //#region src/types/core.d.ts
-type CastType = 'string' | 'number' | 'boolean' | 'date' | 'json' | 'array';
+type CastType = 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'array';
 interface CastHandler<T = unknown> {
   get: (value: unknown) => T;
   set: (value: unknown) => unknown;
@@ -4803,12 +4807,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;
   /**
@@ -6307,7 +6311,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.
@@ -6796,6 +6800,16 @@ declare class TableBuilder {
    * @returns         The current TableBuilder instance for chaining.
    */
   float(name: string, options?: Partial<SchemaColumn>): this;
+  /**
+   * Defines a fixed-precision decimal column in the table.
+   *
+   * @param name      The name of the decimal column.
+   * @param precision The total number of digits. Defaults to 8.
+   * @param scale     The number of digits to the right of the point. Defaults to 2.
+   * @param options   Additional options for the decimal column.
+   * @returns         The current TableBuilder instance for chaining.
+   */
+  decimal(name: string, precision?: number, scale?: number, options?: Partial<SchemaColumn>): this;
   /**
    * Marks a column as unique in the table.
    *
@@ -6829,6 +6843,14 @@ declare class TableBuilder {
    * @returns
    */
   date(name: string, options?: Partial<SchemaColumn>): this;
+  /**
+   * Defines a date-time column in the table (timestamp without time zone).
+   *
+   * @param name      The name of the date-time column.
+   * @param options   Additional options for the date-time column.
+   * @returns         The current TableBuilder instance for chaining.
+   */
+  dateTime(name: string, options?: Partial<SchemaColumn>): this;
   /**
    * Defines colonns for a polymorphic relationship in the table.
    *
@@ -7029,6 +7051,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.
    *