@rvoh/dream 2.1.2 → 2.1.4-alpha.1

package/dist/esm/src/package-exports/system.js

@@ -3,6 +3,7 @@ export { CliFileWriter } from '../cli/CliFileWriter.js';
 export { default as DreamCLI } from '../cli/index.js';
 export { default as DreamImporter } from '../dream-app/helpers/DreamImporter.js';
 export { DreamAppAllowedPackageManagersEnumValues, } from '../dream-app/index.js';
+export { primaryKeyTypes } from '../dream/constants.js';
 export { default as DreamLogos } from '../helpers/DreamLogos/DreamLogos.js';
 export { default as DreamSerializerBuilder } from '../serializer/builders/DreamSerializerBuilder.js';
 export { default as ObjectSerializerBuilder } from '../serializer/builders/ObjectSerializerBuilder.js';

package/dist/types/src/Dream.d.ts

@@ -707,6 +707,34 @@ export default class Dream {
      * @returns the min value of the specified column for this model's records
      */
     static min<T extends typeof Dream, ColumnName extends DreamColumnNames<InstanceType<T>>>(this: T, columnName: ColumnName): Promise<InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]][ColumnName & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]]]["coercedType" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]][ColumnName & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]]]]>;
+    /**
+     * Retrieves the sum for all values of the specified column
+     * for this model's records.
+     *
+     *
+     * ```ts
+     * await Game.sum('score')
+     * // 100
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the sum for all values of the specified column for this model's records
+     */
+    static sum<T extends typeof Dream, ColumnName extends DreamColumnNames<InstanceType<T>>>(this: T, columnName: ColumnName): Promise<InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]][ColumnName & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]]]["coercedType" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]][ColumnName & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]]]]>;
+    /**
+     * Retrieves the average for all values of the specified column
+     * for this model's records.
+     *
+     *
+     * ```ts
+     * await Game.avg('score')
+     * // 100
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the average for all values of the specified column for this model's records
+     */
+    static avg<T extends typeof Dream, ColumnName extends DreamColumnNames<InstanceType<T>>>(this: T, columnName: ColumnName): Promise<InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]][ColumnName & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]]]["coercedType" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]][ColumnName & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]["columns" & keyof InstanceType<T>["schema"][InstanceType<T>["table"] & keyof InstanceType<T>["schema"]]]]]>;
     /**
      * Persists a new record, setting the provided attributes.
      * Automatically sets createdAt and updatedAt timestamps.
@@ -2349,6 +2377,13 @@ export default class Dream {
      * For HasMany associations, returns an array (empty if no records). For BelongsTo/HasOne
      * associations, returns the associated model or null if not found.
      *
+     * @remarks
+     * **Warning:** Using `association` in loops or when processing multiple records can lead to the
+     * [N+1 query problem](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations).
+     * Each call to `association` on an unloaded association will trigger a separate database query.
+     * To avoid this, use {@link Dream.load | `load`} or {@link Dream.preload | `preload`} to eager load
+     * associations before accessing them.
+     *
      * ```ts
      * // Basic association loading
      * const user = await post.association('user')
@@ -2401,6 +2436,13 @@ export default class Dream {
      * For HasMany associations, returns an array (empty if no records). For BelongsTo/HasOne
      * associations, returns the associated model or throws RecordNotFound if not found.
      *
+     * @remarks
+     * **Warning:** Using `associationOrFail` in loops or when processing multiple records can lead to the
+     * [N+1 query problem](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations).
+     * Each call to `associationOrFail` on an unloaded association will trigger a separate database query.
+     * To avoid this, use {@link Dream.load | `load`} or {@link Dream.preload | `preload`} to eager load
+     * associations before accessing them.
+     *
      * ```ts
      * // Basic association loading - throws RecordNotFound if user doesn't exist
      * const user = await post.associationOrFail('user')

package/dist/types/src/dream/DreamClassTransactionBuilder.d.ts

@@ -115,6 +115,32 @@ export default class DreamClassTransactionBuilder<DreamClass extends typeof Drea
      * @returns The min value of the specified column for this model's records
      */
     min<I extends DreamClassTransactionBuilder<DreamClass, DreamInstance>, T extends DreamColumnNames<DreamInstance>>(this: I, columnName: T): Promise<DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]][T & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]]]["coercedType" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]][T & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]]]]>;
+    /**
+     * Retrieves the sum value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.txn(txn).sum('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the sum of the values of the specified column for this Query
+     */
+    sum<I extends DreamClassTransactionBuilder<DreamClass, DreamInstance>, T extends DreamColumnNames<DreamInstance>>(this: I, columnName: T): Promise<DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]][T & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]]]["coercedType" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]][T & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]]]]>;
+    /**
+     * Retrieves the average value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.txn(txn).avg('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the average of the values of the specified column for this Query
+     */
+    avg<I extends DreamClassTransactionBuilder<DreamClass, DreamInstance>, T extends DreamColumnNames<DreamInstance>>(this: I, columnName: T): Promise<DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]][T & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]]]["coercedType" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]][T & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]["columns" & keyof DreamInstance["schema"][DreamInstance["table"] & keyof DreamInstance["schema"]]]]]>;
     /**
      * Persists a new record, setting the provided attributes.
      * Automatically sets createdAt and updatedAt timestamps.

package/dist/types/src/dream/Query.d.ts

@@ -752,6 +752,32 @@ export default class Query<DreamInstance extends Dream, QueryTypeOpts extends Re
      * @returns the min value of the specified column for this Query
      */
     min<Q extends Query<DreamInstance, QueryTypeOpts>, DB extends DreamInstance['DB'], ColumnName extends ColumnNamesAccountingForJoinedAssociations<Q['queryTypeOpts']['joinedAssociations'], DB, QueryTypeOpts['rootTableName'], QueryTypeOpts['rootTableAlias']>, ReturnType extends NamespacedOrBaseModelColumnTypes<[ColumnName], Q, DreamInstance>[0]>(columnName: ColumnName): Promise<ReturnType>;
+    /**
+     * Retrieves the sum value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.query().sum('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the sum of the values of the specified column for this Query
+     */
+    sum<Q extends Query<DreamInstance, QueryTypeOpts>, DB extends DreamInstance['DB'], ColumnName extends ColumnNamesAccountingForJoinedAssociations<Q['queryTypeOpts']['joinedAssociations'], DB, QueryTypeOpts['rootTableName'], QueryTypeOpts['rootTableAlias']>, ReturnType extends NamespacedOrBaseModelColumnTypes<[ColumnName], Q, DreamInstance>[0]>(columnName: ColumnName): Promise<ReturnType>;
+    /**
+     * Retrieves the average value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.query().avg('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the average of the values of the specified column for this Query
+     */
+    avg<Q extends Query<DreamInstance, QueryTypeOpts>, DB extends DreamInstance['DB'], ColumnName extends ColumnNamesAccountingForJoinedAssociations<Q['queryTypeOpts']['joinedAssociations'], DB, QueryTypeOpts['rootTableName'], QueryTypeOpts['rootTableAlias']>, ReturnType extends NamespacedOrBaseModelColumnTypes<[ColumnName], Q, DreamInstance>[0]>(columnName: ColumnName): Promise<ReturnType>;
     /**
      * Plucks the provided fields from the given dream class table
      *

package/dist/types/src/dream/QueryDriver/Base.d.ts

@@ -1,12 +1,12 @@
 import { CompiledQuery, DeleteQueryBuilder, SelectQueryBuilder, UpdateQueryBuilder } from 'kysely';
 import Dream from '../../Dream.js';
+import { SchemaBuilderAssociationData, SchemaBuilderColumnData } from '../../helpers/cli/ASTBuilder.js';
 import { AssociationStatement } from '../../types/associations/shared.js';
-import { DbConnectionType } from '../../types/db.js';
-import { DreamColumnNames, DreamConstructorType, DreamTableSchema, PrimaryKeyType } from '../../types/dream.js';
+import { DbConnectionType, PrimaryKeyType } from '../../types/db.js';
+import { DreamColumnNames, DreamConstructorType, DreamTableSchema } from '../../types/dream.js';
 import { PreloadedDreamsAndWhatTheyPointTo, QueryToKyselyDBType, QueryToKyselyTableNamesType } from '../../types/query.js';
 import DreamTransaction from '../DreamTransaction.js';
 import Query from '../Query.js';
-import { SchemaBuilderAssociationData, SchemaBuilderColumnData } from '../../helpers/cli/ASTBuilder.js';
 export default class QueryDriverBase<DreamInstance extends Dream> {
     query: Query<DreamInstance, any>;
     protected readonly dreamClass: DreamConstructorType<DreamInstance>;
@@ -195,6 +195,32 @@ export default class QueryDriverBase<DreamInstance extends Dream> {
      * @returns the min value of the specified column for this Query
      */
     min(columnName: string): Promise<any>;
+    /**
+     * Retrieves the sum value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.query().sum('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the sum of the values of the specified column for this Query
+     */
+    sum(columnName: string): Promise<any>;
+    /**
+     * Retrieves the average value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.query().avg('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the average of the values of the specified column for this Query
+     */
+    avg(columnName: string): Promise<any>;
     /**
      * Retrieves the number of records in the database
      *

package/dist/types/src/dream/QueryDriver/Kysely.d.ts

@@ -3,8 +3,8 @@ import { DialectProviderCb } from '../../db/DreamDbConnection.js';
 import Dream from '../../Dream.js';
 import { SchemaBuilderInformationSchemaRow } from '../../helpers/cli/ASTBuilder.js';
 import { AssociationStatement } from '../../types/associations/shared.js';
-import { DbConnectionType } from '../../types/db.js';
-import { DreamColumnNames, DreamTableSchema, OrderDir, PrimaryKeyType, SqlCommandType } from '../../types/dream.js';
+import { DbConnectionType, PrimaryKeyType } from '../../types/db.js';
+import { DreamColumnNames, DreamTableSchema, OrderDir, SqlCommandType } from '../../types/dream.js';
 import { PreloadedDreamsAndWhatTheyPointTo, QueryToKyselyDBType, QueryToKyselyTableNamesType } from '../../types/query.js';
 import DreamTransaction from '../DreamTransaction.js';
 import Query from '../Query.js';
@@ -48,14 +48,14 @@ export default class KyselyQueryDriver<DreamInstance extends Dream> extends Quer
      * returns the foreign key type based on the primary key received.
      * gives the driver the opportunity to switch i.e. bigserial to bigint.
      */
-    static foreignKeyTypeFromPrimaryKey(primaryKey: PrimaryKeyType): "bigint" | "uuid" | "integer";
+    static foreignKeyTypeFromPrimaryKey(primaryKey: PrimaryKeyType): "bigint" | "integer" | "uuid";
     /**
      * @internal
      *
      * used to return the computed primary key type based
      * on the primaryKeyType set in the DreamApp class.
      */
-    static primaryKeyType(): "bigint" | "bigserial" | "uuid" | "integer";
+    static primaryKeyType(): PrimaryKeyType;
     /**
      * destroys a dream, possibly implementing soft delete if reallyDestroy is false
      * and the record being deleted implements soft delete.
@@ -168,6 +168,32 @@ export default class KyselyQueryDriver<DreamInstance extends Dream> extends Quer
      * @returns the min value of the specified column for this Query
      */
     min(columnName: string): Promise<any>;
+    /**
+     * Retrieves the sum value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.query().sum('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the sum of the values of the specified column for this Query
+     */
+    sum(columnName: string): Promise<any>;
+    /**
+     * Retrieves the average value of the specified column
+     * for this Query
+     *
+     * ```ts
+     * await Game.query().avg('score')
+     * // 1
+     * ```
+     *
+     * @param columnName - a column name on the model
+     * @returns the average of the values of the specified column for this Query
+     */
+    avg(columnName: string): Promise<any>;
     /**
      * Retrieves the number of records in the database
      *

package/dist/types/src/dream/QueryDriver/helpers/kysely/foreignKeyTypeFromPrimaryKey.d.ts

@@ -1,2 +1,2 @@
-import { PrimaryKeyType } from '../../../../types/dream.js';
-export default function foreignKeyTypeFromPrimaryKey(primaryKey: PrimaryKeyType): "bigint" | "uuid" | "integer";
+import { PrimaryKeyType } from '../../../../types/db.js';
+export default function foreignKeyTypeFromPrimaryKey(primaryKey: PrimaryKeyType): "bigint" | "integer" | "uuid";

package/dist/types/src/dream/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const primaryKeyTypes: readonly ["bigserial", "bigint", "uuid", "integer"];
+export declare const primaryKeyTypes: readonly ["uuid7", "uuid4", "bigserial", "bigint", "integer"];
 export declare const TRIGRAM_OPERATORS: readonly ["%", "<%", "<<%"];
 declare class RequiredAttribute {
     constructor();

package/dist/types/src/dream-app/helpers/PackageManager.d.ts

@@ -1,5 +1,5 @@
 export default class PackageManager {
-    static get packageManager(): "yarn" | "npm" | "pnpm";
+    static get packageManager(): "pnpm" | "yarn" | "npm";
     static add(dependencyOrDependencies: string | string[], { dev }?: {
         dev?: boolean;
     }): string;

package/dist/types/src/dream-app/index.d.ts

@@ -1,7 +1,6 @@
 import { CompiledQuery } from 'kysely';
 import { Context } from 'node:vm';
 import Dream from '../Dream.js';
-import { primaryKeyTypes } from '../dream/constants.js';
 import QueryDriverBase from '../dream/QueryDriver/Base.js';
 import { EncryptOptions } from '../encrypt/index.js';
 import autogeneratedFileDisclaimer from '../helpers/cli/autoGeneratedFileDisclaimer.js';
@@ -13,7 +12,7 @@ import expandStiClasses from '../helpers/sti/expandStiClasses.js';
 import inferSerializerFromDreamOrViewModel, { inferSerializersFromDreamClassOrViewModelClass } from '../serializer/helpers/inferSerializerFromDreamOrViewModel.js';
 import isDreamSerializer from '../serializer/helpers/isDreamSerializer.js';
 import serializerNameFromFullyQualifiedModelName from '../serializer/helpers/serializerNameFromFullyQualifiedModelName.js';
-import { DbConnectionType } from '../types/db.js';
+import { DbConnectionType, PrimaryKeyType } from '../types/db.js';
 import { DreamModelSerializerType, SimpleObjectSerializerType } from '../types/serializer.js';
 export default class DreamApp {
     /**
@@ -116,7 +115,7 @@ export default class DreamApp {
     private _paginationPageSize;
     get paginationPageSize(): number;
     private _primaryKeyType;
-    get primaryKeyType(): "bigint" | "bigserial" | "uuid" | "integer";
+    get primaryKeyType(): PrimaryKeyType;
     private _projectRoot;
     get projectRoot(): string;
     private _paths;
@@ -130,7 +129,7 @@ export default class DreamApp {
     private _plugins;
     get plugins(): ((app: DreamApp) => void | Promise<void>)[];
     private _packageManager;
-    get packageManager(): "yarn" | "npm" | "pnpm";
+    get packageManager(): "pnpm" | "yarn" | "npm";
     private _importExtension;
     get importExtension(): ".js" | ".ts" | "none";
     /**
@@ -153,13 +152,13 @@ export default class DreamApp {
     get parallelDatabasesEnabled(): boolean;
     load<RT extends 'models' | 'serializers'>(resourceType: RT, resourcePath: string, importCb: (path: string) => Promise<any>): Promise<void>;
     plugin(cb: (app: DreamApp) => void | Promise<void>): void;
-    set<ApplyOpt extends DreamAppSetOption>(applyOption: ApplyOpt, options: ApplyOpt extends 'bypassDeprecationChecks' ? boolean : ApplyOpt extends 'db' ? DreamDbCredentialOptions | string : ApplyOpt extends 'encryption' ? DreamAppEncryptionOptions : ApplyOpt extends 'primaryKeyType' ? (typeof primaryKeyTypes)[number] : ApplyOpt extends 'importExtension' ? GeneratorImportStyle : ApplyOpt extends 'logger' ? DreamLogger : ApplyOpt extends 'projectRoot' ? string : ApplyOpt extends 'inflections' ? () => void | Promise<void> : ApplyOpt extends 'packageManager' ? DreamAppAllowedPackageManagersEnum : ApplyOpt extends 'paths' ? DreamDirectoryPaths : ApplyOpt extends 'parallelTests' ? number : ApplyOpt extends 'unicodeNormalization' ? UnicodeNormalizationForm : ApplyOpt extends 'paginationPageSize' ? number : never, secondaryOptions?: ApplyOpt extends 'db' ? DreamDbCredentialOptions : never): void;
+    set<ApplyOpt extends DreamAppSetOption>(applyOption: ApplyOpt, options: ApplyOpt extends 'bypassDeprecationChecks' ? boolean : ApplyOpt extends 'db' ? DreamDbCredentialOptions | string : ApplyOpt extends 'encryption' ? DreamAppEncryptionOptions : ApplyOpt extends 'primaryKeyType' ? PrimaryKeyType : ApplyOpt extends 'importExtension' ? GeneratorImportStyle : ApplyOpt extends 'logger' ? DreamLogger : ApplyOpt extends 'projectRoot' ? string : ApplyOpt extends 'inflections' ? () => void | Promise<void> : ApplyOpt extends 'packageManager' ? DreamAppAllowedPackageManagersEnum : ApplyOpt extends 'paths' ? DreamDirectoryPaths : ApplyOpt extends 'parallelTests' ? number : ApplyOpt extends 'unicodeNormalization' ? UnicodeNormalizationForm : ApplyOpt extends 'paginationPageSize' ? number : never, secondaryOptions?: ApplyOpt extends 'db' ? DreamDbCredentialOptions : never): void;
     on<T extends DreamHookEventType>(hookEventType: T, cb: T extends 'db:log' ? (event: KyselyLogEvent) => void : T extends 'repl:start' ? (context: Context) => void | Promise<void> : never): void;
 }
 export type DreamHookEventType = 'db:log' | 'repl:start';
 export interface DreamAppOpts {
     projectRoot: string;
-    primaryKeyType: (typeof primaryKeyTypes)[number];
+    primaryKeyType: PrimaryKeyType;
     db: DreamDbCredentialOptions;
     inflections?: () => void | Promise<void>;
     paths?: DreamDirectoryPaths;
@@ -219,7 +218,7 @@ export interface KyselyLogEvent {
     queryDurationMillis: number;
     error: unknown;
 }
-export declare const DreamAppAllowedPackageManagersEnumValues: readonly ["yarn", "npm", "pnpm"];
+export declare const DreamAppAllowedPackageManagersEnumValues: readonly ["pnpm", "yarn", "npm"];
 export type DreamAppAllowedPackageManagersEnum = (typeof DreamAppAllowedPackageManagersEnumValues)[number];
 export declare const GeneratorImportStyles: readonly [".js", ".ts", "none"];
 export type GeneratorImportStyle = (typeof GeneratorImportStyles)[number];

package/dist/types/src/helpers/cli/generateMigrationContent.d.ts

@@ -1,4 +1,4 @@
-import { PrimaryKeyType } from '../../types/dream.js';
+import { PrimaryKeyType } from '../../types/db.js';
 export default function generateMigrationContent({ connectionName, table, columnsWithTypes, primaryKeyType, createOrAlter, stiChildClassName, }?: {
     connectionName?: string;
     table?: string | undefined;

package/dist/types/src/helpers/cli/generateStiMigrationContent.d.ts

@@ -1,4 +1,4 @@
-import { PrimaryKeyType } from '../../types/dream.js';
+import { PrimaryKeyType } from '../../types/db.js';
 export default function generateStiMigrationContent({ table, columnsWithTypes, primaryKeyType, stiChildClassName, }: {
     table?: string;
     columnsWithTypes?: string[];

package/dist/types/src/package-exports/system.d.ts

@@ -3,6 +3,7 @@ export { CliFileWriter } from '../cli/CliFileWriter.js';
 export { default as DreamCLI } from '../cli/index.js';
 export { default as DreamImporter } from '../dream-app/helpers/DreamImporter.js';
 export { DreamAppAllowedPackageManagersEnumValues, type DreamAppAllowedPackageManagersEnum, } from '../dream-app/index.js';
+export { primaryKeyTypes } from '../dream/constants.js';
 export { default as DreamLogos } from '../helpers/DreamLogos/DreamLogos.js';
 export { default as DreamSerializerBuilder } from '../serializer/builders/DreamSerializerBuilder.js';
 export { default as ObjectSerializerBuilder } from '../serializer/builders/ObjectSerializerBuilder.js';

package/dist/types/src/package-exports/types.d.ts

@@ -7,7 +7,7 @@ export { type SerializerRendererOpts } from '../serializer/SerializerRenderer.js
 export { type BelongsToStatement } from '../types/associations/belongsTo.js';
 export { type HasManyStatement } from '../types/associations/hasMany.js';
 export { type HasOneStatement } from '../types/associations/hasOne.js';
-export { type DbConnectionType, type DbTypes } from '../types/db.js';
+export { type DbConnectionType, type DbTypes, type PrimaryKeyType } from '../types/db.js';
 export { type StrictInterface } from '../types/utils.js';
 export { type DreamAssociationMetadata, type DreamAttributes, type DreamClassAssociationAndStatement, type DreamClassColumn, type DreamColumn, type DreamColumnNames, type DreamOrViewModelClassSerializerKey, type DreamOrViewModelSerializerKey, type DreamParamSafeAttributes, type DreamParamSafeColumnNames, type DreamSerializable, type DreamSerializableArray, type DreamSerializerKey, type DreamSerializers, type DreamVirtualColumns, type UpdateableAssociationProperties, type UpdateableProperties, type ViewModel, type ViewModelClass, } from '../types/dream.js';
 export { type DreamModelSerializerType, type InternalAnyTypedSerializerRendersMany, type InternalAnyTypedSerializerRendersOne, type SerializerCasing, type SimpleObjectSerializerType, } from '../types/serializer.js';

package/dist/types/src/types/associations/belongsTo.d.ts

@@ -6,7 +6,7 @@ export interface BelongsToStatement<BaseInstance extends Dream, DB, Schema, Tabl
     globalAssociationNameOrNames: string[];
     type: 'BelongsTo';
     as: string;
-    primaryKey: (associationInstance?: Dream | undefined, opts?: {
+    primaryKey: (associationInstance?: Dream, opts?: {
         associatedClassOverride?: typeof Dream | undefined;
     }) => keyof DB[TableName] & string;
     primaryKeyValue: (associationInstance: Dream | null) => any;

package/dist/types/src/types/associations/belongsTo.ts

@@ -20,7 +20,7 @@ export interface BelongsToStatement<
   type: 'BelongsTo'
   as: string
   primaryKey: (
-    associationInstance?: Dream | undefined,
+    associationInstance?: Dream,
     opts?: { associatedClassOverride?: typeof Dream | undefined }
   ) => keyof DB[TableName] & string
   primaryKeyValue: (associationInstance: Dream | null) => any

package/dist/types/src/types/db.d.ts

@@ -1,4 +1,5 @@
 import { postgresDatatypes } from '../db/dataTypes.js';
+import { primaryKeyTypes } from '../dream/constants.js';
 export type DbConnectionType = 'primary' | 'replica';
 export type AssociationTableNames<DB, Schema> = keyof DB & keyof Schema extends never ? unknown : keyof DB & keyof Schema & string;
 export type Tables<DB> = keyof DB;
@@ -6,4 +7,5 @@ export type TableInterfaces<DB> = valueof<DB>;
 type valueof<T> = T[keyof T];
 export type NonArrayDbTypes = (typeof postgresDatatypes)[number];
 export type DbTypes = NonArrayDbTypes | `${NonArrayDbTypes}[]`;
+export type PrimaryKeyType = (typeof primaryKeyTypes)[number] | 'uuid';
 export {};

package/dist/types/src/types/db.ts

@@ -1,4 +1,5 @@
 import { postgresDatatypes } from '../db/dataTypes.js'
+import { primaryKeyTypes } from '../dream/constants.js'
 
 export type DbConnectionType = 'primary' | 'replica'
 
@@ -12,3 +13,4 @@ type valueof<T> = T[keyof T]
 
 export type NonArrayDbTypes = (typeof postgresDatatypes)[number]
 export type DbTypes = NonArrayDbTypes | `${NonArrayDbTypes}[]`
+export type PrimaryKeyType = (typeof primaryKeyTypes)[number] | 'uuid'

package/dist/types/src/types/dream.d.ts

@@ -1,7 +1,7 @@
 import { ColumnType, Updateable } from 'kysely';
 import { STI_SCOPE_NAME } from '../decorators/class/STI.js';
 import Dream from '../Dream.js';
-import { primaryKeyTypes, TRIGRAM_OPERATORS } from '../dream/constants.js';
+import { TRIGRAM_OPERATORS } from '../dream/constants.js';
 import CalendarDate from '../helpers/CalendarDate.js';
 import { DateTime } from '../helpers/DateTime.js';
 import OpsStatement from '../ops/ops-statement.js';
@@ -11,7 +11,6 @@ import { FindEachOpts } from './query.js';
 import { DreamModelSerializerType, SimpleObjectSerializerType } from './serializer.js';
 import { FilterInterface, Inc, RejectInterface } from './utils.js';
 import { AliasedSchemaAssociation } from './variadic.js';
-export type PrimaryKeyType = (typeof primaryKeyTypes)[number];
 export type DreamPrimaryKeyType<I extends Dream, Schema extends I['schema'] = I['schema'], TableName extends keyof Schema = I['table'] & keyof Schema, PrimaryKey extends I['primaryKey' & keyof I] extends undefined ? 'id' : I['primaryKey' & keyof I] = I['primaryKey' & keyof I] extends undefined ? 'id' : I['primaryKey' & keyof I]> = Schema[TableName]['columns'][PrimaryKey & keyof Schema[TableName]['columns']]['coercedType'];
 export type Timestamp = ColumnType<DateTime | CalendarDate>;
 export type MAX_VARIADIC_DEPTH = 25;

package/dist/types/src/types/dream.ts

@@ -1,7 +1,7 @@
 import { ColumnType, Updateable } from 'kysely'
 import { STI_SCOPE_NAME } from '../decorators/class/STI.js'
 import Dream from '../Dream.js'
-import { primaryKeyTypes, TRIGRAM_OPERATORS } from '../dream/constants.js'
+import { TRIGRAM_OPERATORS } from '../dream/constants.js'
 import CalendarDate from '../helpers/CalendarDate.js'
 import { DateTime } from '../helpers/DateTime.js'
 import OpsStatement from '../ops/ops-statement.js'
@@ -17,8 +17,6 @@ import { DreamModelSerializerType, SimpleObjectSerializerType } from './serializ
 import { FilterInterface, Inc, RejectInterface } from './utils.js'
 import { AliasedSchemaAssociation } from './variadic.js'
 
-export type PrimaryKeyType = (typeof primaryKeyTypes)[number]
-
 export type DreamPrimaryKeyType<
   I extends Dream,
   Schema extends I['schema'] = I['schema'],

package/dist/types/src/types/serializer.ts

@@ -13,13 +13,13 @@ import {
 export type SerializerCasing = 'camel' | 'snake'
 export type DreamsOrSerializersOrViewModels = DreamSerializable | DreamSerializableArray
 
-export interface InternalAnyTypedSerializerAttribute<> {
+export interface InternalAnyTypedSerializerAttribute {
   type: 'attribute'
   name: string
   options: Partial<NonAutomaticSerializerAttributeOptionsWithPossibleDecimalRenderOption>
 }
 
-export interface InternalAnyTypedSerializerDelegatedAttribute<> {
+export interface InternalAnyTypedSerializerDelegatedAttribute {
   type: 'delegatedAttribute'
   targetName: string
   name: string

package/docs/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62b23LbthaG30XX6W6T3WPuZMlONbEtV1Kdi05mD0QuS2hAgAUgJ0qn774HPIggCCyAdO80xL++HyRx4gL0x98zDV/07O0s389ezUqij7O3s0LkJwbq23z/n6Mu2OzV7BPl+eztm1ez7EhZLoHP3v5xCV1KIMUdPUiiqeC/AitBqo6WMaJUTfMq+x6v3/z8z6sL+v1ZATv/dgJ5Xkr6DNKLHagw5INQ+iBBxaAeHYa1ZFdEgRfpaDBcxoSCOWPL/UJwDpl5XtYzfTrx+pLBerV9+I/fW+zcvIUU8FCIUE9cn0vIl/sA7FKOMJ4JoznRsBDsVPAAqC9KoO3InkEEVmkGrI8WDaQUdrNuO0l9PamjLI6QfVoIrrQklOtHKljVEYaNpYGGArCWUz+W9TPIJyY+h9E9GQqUQDSs5Q3l+dX5hlAG+U7UV+c8N5fDLvFYzHpJNFnxTBQl0XTP4APVR3NtTxTcUGBh42hkzHZ3LpsWZn7dUVUQnR1RP38IZvSOiT1h96SAe6G3oIN4V4hBV7xq1AvCgOdELon2jEYN16PF0HdUKcoPW5CUMPoVpFrCE+UUbcRYEGZ2L/itIDnkc6VERvGe4hPjcH1/YizeBV0hBt1AJmR+L/SNOCGdoi/DgI/16EQFvzahQaKjw5DloZKYFuobEhugpUIHRcpz+DIcE6vLaUMi2kprTmrrXJrnSrTwLT5qUqdAOWbaCyJMYTR6XpYoYF6WUcZOEq5I5m+dFsvSYcxr/hzCXPPn6NImFFsVRgZT2NHCertmHXC5g6bUaSzf/fLT6x/eoJRnIqmZtF3SN6/7rP++cR9sNaEioIsGAYlShQmiVLE6dKOhrxdaFemEyEpnvf8TMp3CdJUIdAMloxnZkifvSFHzLBGC2u5WYcR2t8JCxZNeAgONVKLToIOVKIGTkg6Hq6YgacBa19olqEzSst85Kdcgn0hmIYdyx+WHH+33WKu32REK8iBFCVJTUCkObswEm+1RSH0k9syV7ncJTjA200q1CKtbY4qdE4KZLERRCN6rZh1UxSt3HGqNImGxAaoJnDNmqhp0cWSJ1BshC6Jj0EaVyLw/FXuQaeSeNpH/IGlBNX0G86mb8kyGAWOdRrmMcaibw1xKco7gLeV4tqcDxkxC3Q5362coEI9hmiJGFnnaIzLC0eRxD6gXMcqrHgvw8SIYMMrp+kspQSkq+Jyx9VOSmRMz1Y+fx/uZmIl+aw6j/aqYiX4bGOu2gRd41ZfGNVAMMKomK67hYC/7ENNGO4pvvoCT4EY4kmxmlkS2kY6iu+sLhO5dV6TQ0/utpZ/qM659+QKnOCePFJZ+qs+kO+wFTnBOng87+USXKbfXi5vgmz7yWvqpPlNusB84wXmK6TS/y/LxHXCQNEsydINGOV7qOWWpEAp+cQ2Sh4RQ8EtrkN6oQ8EvrUGbRDGZn9TFRhzzb9UK5L9QpwoyrUaTOkowelwdtKT8kGZYSVPpbe0SP/IH+rE+oz+hkcjJ3tN8x3hecjsRl4suxhV4XqBL17YG3gA0kSwSH1fQKxDpMbVTmOqsNFh7E20Gs76etuPC6A1l8EFS7Tv50JB6quhWxRX1bFE0pFYQhSxuVzhkcbuKQlZFKSR2Yz1VFHcrDsKzm2SzKkkU1I2oVyfK8lgFB3LMwM3pxxwC+pRNrTlj4jPkDyT7RA5wRzg5gFTX/FS4fde+GzQwuvMTJTwSdvL3ueRK1Ai06+l+x257nvYMdP6OdwVM8IPaia0mGgrg/sR3DRyKsZT3ZV9zIXh1KQx2pSi2eW4rTvW6dE4KDclDdQp8XeoUqpFhuGueyXOZUM2+EEOaTInkhM352YzNub0q4jlIdUf4GXFKin9RBdYcXuK/5u5nbM/e1YOMvCt/ALpXQwowAYOpvwZeiqODhHVIrX+0wca5qjjVu/hpYUlrnLr9dodS7kCTnGgSgAbUaS5aS7o/6WCN+6Ik5sJMHVaF5jz3DF8DFyws3dc9Bui38Z0DDFGjwLEscyQLe9yWKol6Kw638AyDbKuFbCWpPE9iuE9LyAbXB3dFDqzr40g/C6iTXNbykcLnKrp6vR3iPQy2liw/NG6s8wTT8X4PRJLCnJxI6rge9TiXtAbrkyf52HkMhG/LRnO9O7ABeNIerLPYxl/2+DdsnXlM4qY96Ucq9Ymw+gVh4L4wxm4WRnN2EJLq42BF31s+XVQx6q+kWuZEJg1XlUBdc4hDbVGUeS6PwMOLka48RnogKiPIsqYrj5E25oQo5YcHCRlVvcNGNnAgi3G7JrcgypMsc9dztSpKpUXJwP28DM8TYX3UiZNPQJ9o6Al35VGSljTTq3YpG8D1RTHm76X5S0E1CHVLIN9xLtsjEpTumW6UTu8OGIffZl8TJbbzZgDWFidzqkk/Aqs0MeKHI8hu1LgR0jkPbJP92mkOyA0gATGv3Wb1bjO/+9/64Xoz3603W1+epHYZSJH8ZylpQeT5PZyDCc8a6gjRFMtJU+ZJsVSXk1IszeQ0zHzViKYYS3RtCD94DqLX8VUhFp0136u+o6o1olUgJ14zUlJNYphWg4GY4LAEKENHeBuWLcNw5s809mmKAagWIIiDFKfy6hxGNAIEcWxn4TDkIkEwVe5CgXO63iXZKgymrotSI7fVCBAEN2crzfv8ndNM5MjduUoEWrbrjDDtIsEwILPeImsAqQUIQva7lQuoit2tjz6g/4+aAWD4T5peuCLm/0Zfwd0adDl9HQasFxjIO28VGERI5Kma0kgw1pXq8gigOWBy7n34+EiWMBFZpdTToJUUwZ54yphoq1AY/QuD0L8GwR//+fh/b6EHfik9AAA="
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62bXXPbNhaG/4v2Nrtt0rS7zZ0s2akmtuVKqnPRyexA5LGEBgRYEHKidvrfO+CHCIDAAUj3TkO853lB4oOHAPTrnzMFX9Xs3Szfz17NSqKOs3ezQuQnBtU3+f4/R1Ww2avZZ8rz2bs3r2bZkbJcAp+9+/USupRAijt6kERRwX8CVoKselrGSFU1NK/S9nj95n9/vbqgP5wrYOefTyDPS0mfQXqxAxWGfBCVOkioYlCPDsMasitSgRfpaDBcxkQFc8aW+4XgHDL9vIxn+nTizSWN9Wpt+A9vDXauWyEFPBQi1BNX5xLy5T4Au5QjjGfCaE4ULAQ7FTwAskUJtB3ZM4jAas2A9cmggZTC7NbdIGmuJw2UxRGyzwvBKyUJ5eqRClYPhGFnaaGhAKznNI9l/QzyiYkvYbQlQ4ESiIK1vKE8vzrfEMog34nm6pzn+nLYJR6LWS+JIiueiaIkiu4ZfKTqqK/tSQU3FFjYOBoZs92dy7aH6V93tCqIyo6onz8EM3rPxJ6we1LAvVBbUEG8K8SgK1536gVhwHMil0R5ZqOW69Fi6DtaVZQftiApYfQPkNUSniinaCfGgjCze8FvBckhn1eVyCg+UnxiHK7uT4zFh6ArxKAbyITM74W6ESdkUNgyDPjYzE5U8GsdGiQ6OgxZHmqJ7qG+KbEFGip0UqQ8h6/DObG+nDYlor204aT2zqV+rkQJX/LRkHoFytGvvSBCF0aj52WJAuZlGWXsJOEVyfy902AZOox5zZ9DmGv+HE1tQrF1YWQyhR0tjNbVecDlDtpSp7N8++N/X3//BqU8E0n1S9sl/fu1zfrujftg6xcqArpoEJAoqzBBlFWsDv1s6BuFRkV6IZLprPe/QaZSmK4SgW6gZDQjW/LknSkaniFCUNvdKozY7lZYqHhSS2CgkEr0GnSyEiVwUtLhdNUWJE1Y60a7hCqTtLQHJ+UK5BPJDORQ7rh8/4PZjo16mx2hIA9SlCAVhSrFwY2ZYLM9CqmOxHxzpftdghOM9WulTsKa3phi54RgJgtRFIJb1WyC6vjKnYc6o0hYbIJqA+eM6aoGXRxZIvVGyIKoGLRVJTLvT8UeZBrZ0ibyHyQtqKLPoD91U57JMGCs0yiXMQ5Nd5hLSc4RvKEcz/YMwJhJaNjhbvYKBeIxXKaIkUWe9oi0cDR53AOyIkZ5NXMBPl8EA0Y5XX8tJVQVFXzO2PopycyJmerHz+P9dMxEvzWH0X51zES/DYx128ALvJpL4zooBhhVkxVXcDDTPsS01Y7i6y/gJLgWjiTrN0siW0tH0d38AqF784oUevq4NfRTfcb1L1/gFOfkmcLQT/WZdIdW4ATn5PdhL5/oMuX2rLgJvukzr6Gf6jPlBu3ACc5TTKf5XdLH98BB0izJ0A0a5Xip55RUIRT84hokTwmh4JfWIL1Th4JfWoNuEUWv/KQmG3HMP1UrkP9AnWrItBpNGijB6HF1UJLyQ5phLU2ld7VL/Mgf6Mf6jP6ERiIne0/zHeN5WduJuFx0Ma7A1wX65drOwBuALiSLxMcV9ApEekzNJczqXCkw9ia6FczmetqOC6M3lMFHSZXv5ENLslTRrYor6tmiaEmdIApZ3K5wyOJ2FYWsilJI7MYsVRR3Kw7Cs5tksmpJFNTPqFcnyvJYBQdyzMBd0485BPQpm1pzxsQXyB9I9pkc4I5wcgBZXfNT4Y5d827QwOjOT5TwSNjJP+aSK9EgkPFeSloQef4A5+AAb80cJTqclc3qRrPyTJ7+wRys1hD1r6G2Qb99/ePb774191yugAl+qHZiq4iCArh/ib5hD8XY4vxlB3YheH0pDHalKLZt4RWnal06Z5qG5KE6Bb4uVQpVyzDcNc/kuUyopi3EkHpNR3LC5rxu29zM33gOsroj/Iw4JcW/qAJrDi/xX3P3g9uyd/UgI23lD0B3lUgBOmCQpDTAS3F0OjOO09mHMEycq4pTvWlaB0vKxpr+2x+fuQNFcqJIABpQp7koJen+pII1tkVJzIV+yRkVmvPcM30NXLCwdF/3wKLfxndiMUSNAsey9OEx7HEbqiTqrTjcwjMM1oUNZCdJ5XmWsG1awrp1c8RY5MD6MY6Ms4A6yWUtHyl8qaPr5u0RH2CwCWb4oXFjnSeYjvd7IJIU+oxH0sD1qMe5pHVYnzzJx1xxQfimbDTXu1ccgCftFjufBXhjj29h43RmEjftST9SqU6ENQ2EgW1hjN0mRnN2EJKq4+Dbw0qfLqoY9SdSpzmRl4arSqCuOcShpijKPJdH4OFkpC+PkR5IlREkrenLoyTr6yJAszQx4kafjqX88CAho5V10MqEDmQxbt+JF6TyLBS6GWKjilJpUTJwP63DzyKsjzpx8hnoEw21WV8eJSlJM7XqkuMAzhbFmL+U+u8U9bTWJ1W+o2ymRyQo3TPdKJ3eH64Ot6atiRK7N3EA1hUnc+o0IgKrNTHixyPIfh66EdI5C22S/dppDsgNIAExr91m9X4zv/v/+uF6M9+tN1vfsk3jMpCi6zYnRZlnsaW+nLRu076bhkt0DaItxlbkNoQfPCfmm/i6EIvO2s9V35naBtEpkKO5GSmpIjFMp8FATHBYApShs8Yty5RhOP2vH/PYxwDUCBDEQYpTeXUOI1oBgjh2L+Ew5CJBMPXSRQXO3wBckqnCYNV1USrktloBguD6EKhuz184zUSO3J2rRKBll2aEaRcJhgGZWTnWANIIEIS0h5ULqIvdPRobYP/1ZwAY/uXHCq+I/mPUH+DuYbocW4cBm2wAafNOgUGERJ6qLo0EY0OpKY8A2pMwZ+u7x0cyhInIeu0/DVpLEeyJp8yJpgqF0d8xCP19EPzpr09/A6O47jvSPQAA"