@rvoh/dream 1.4.1 → 1.5.0

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

@@ -1,36 +1,81 @@
 import { DeleteQueryBuilder, Kysely, Transaction as KyselyTransaction, SelectQueryBuilder, UpdateQueryBuilder } from 'kysely';
+import { DialectProviderCb } from '../../db/DreamDbConnection.js';
 import Dream from '../../Dream.js';
+import { SchemaBuilderInformationSchemaRow } from '../../helpers/cli/SchemaBuilder.js';
 import { AssociationStatement } from '../../types/associations/shared.js';
 import { DbConnectionType } from '../../types/db.js';
-import { DreamColumnNames, DreamTableSchema, SqlCommandType } from '../../types/dream.js';
+import { DreamColumnNames, DreamTableSchema, OrderDir, PrimaryKeyType, SqlCommandType } from '../../types/dream.js';
 import { PreloadedDreamsAndWhatTheyPointTo, QueryToKyselyDBType, QueryToKyselyTableNamesType } from '../../types/query.js';
 import DreamTransaction from '../DreamTransaction.js';
 import Query from '../Query.js';
 import QueryDriverBase from './Base.js';
 export default class KyselyQueryDriver<DreamInstance extends Dream> extends QueryDriverBase<DreamInstance> {
     dbFor(sqlCommandType: SqlCommandType): Kysely<DreamInstance['DB']> | KyselyTransaction<DreamInstance['DB']>;
+    static dbFor<I extends Dream>(connectionName: string, dbConnectionType: DbConnectionType, dreamTransaction?: DreamTransaction<I> | null): Kysely<I['DB']> | KyselyTransaction<I['DB']>;
+    static dialectProvider(connectionName: string, dbConnectionType: DbConnectionType): DialectProviderCb;
     /**
      * migrate the database. Must respond to the NODE_ENV value.
      */
-    static migrate(): Promise<void>;
+    static migrate(connectionName: string): Promise<void>;
     /**
      * rollback the database. Must respond to the NODE_ENV value.
      */
     static rollback(opts: {
+        connectionName: string;
         steps: number;
     }): Promise<void>;
-    static generateMigration(migrationName: string, columnsWithTypes: string[]): Promise<void>;
-    static sync(onSync: () => Promise<void> | void, options?: {
+    /**
+     * This should build a new migration file in the migrations folder
+     * of your application. This will then need to be read and run
+     * whenever the `migrate` method is called. The filename should
+     * contain a timestamp at the front of the filename, so that it
+     * is sorted by date in the file tree, and, more importantly, so
+     * they can be run in order by your migration runner.
+     */
+    static generateMigration(connectionName: string, migrationName: string, columnsWithTypes: string[]): Promise<void>;
+    /**
+     * defines the syncing behavior for dream and psychic,
+     * which is run whenever the `sync` command is called.
+     * This is an important step, and will be incredibly
+     * comlpex to override. You will need to do the following
+     * when overriding this method:
+     *
+     * 1. introspect the db and use it to generate a db.ts file in the
+     *    same shape as the existing one. Currently, the process for generating
+     *    this file is extremely complex and messy, and will be difficult
+     *    to achieve.
+     * 2. generate a types/dream.ts file in the same shape as the existing
+     *    one. This is normally done using `await new SchemaBuilder().build()`,
+     *    but this will likely need to be overridden to tailor to your custom
+     *    database engine.
+     */
+    static sync(connectionName: string, onSync: () => Promise<void> | void, options?: {
         schemaOnly?: boolean;
     }): Promise<void>;
+    static get syncDialect(): string;
     /**
-     * create the database. Must respond to the NODE_ENV value.
+     * @internal
+     *
+     * returns the foreign key type based on the primary key received.
+     * gives the driver the opportunity to switch i.e. bigserial to bigint.
      */
-    static dbCreate(): Promise<void>;
+    static foreignKeyTypeFromPrimaryKey(primaryKey: PrimaryKeyType): "bigint" | "uuid" | "integer";
     /**
-     * delete the database. Must respond to the NODE_ENV value.
+     * @internal
+     *
+     * used to return the computed primary key type based
+     * on the primaryKeyType set in the DreamApp class.
      */
-    static dbDrop(): Promise<void>;
+    static primaryKeyType(): "bigint" | "bigserial" | "uuid" | "integer";
+    /**
+     * destroys a dream, possibly implementing soft delete if reallyDestroy is false
+     * and the record being deleted implements soft delete.
+     *
+     * @param dream - the dream instance you wish to destroy
+     * @param txn - a transaction to encapsulate, consistently provided by underlying dream mechanisms
+     * @param reallyDestroy - whether or not to reallyDestroy. If false, soft delete will be attempted when relevant
+     */
+    static destroyDream(dream: Dream, txn: DreamTransaction<Dream>, reallyDestroy: boolean): Promise<void>;
     /**
      * Converts the given dream class into a Kysely query, enabling
      * you to build custom queries using the Kysely API
@@ -43,6 +88,27 @@ export default class KyselyQueryDriver<DreamInstance extends Dream> extends Quer
      * @returns A Kysely query. Depending on the type passed, it will return either a SelectQueryBuilder, DeleteQueryBuilder, or an UpdateQueryBuilder
      */
     toKysely<QueryType extends 'select' | 'delete' | 'update', DbType = QueryToKyselyDBType<Query<DreamInstance>>, TableNames = QueryToKyselyTableNamesType<Query<DreamInstance>>, ToKyselyReturnType = QueryType extends 'select' ? SelectQueryBuilder<DbType, TableNames & keyof DbType, unknown> : QueryType extends 'delete' ? DeleteQueryBuilder<DbType, TableNames & keyof DbType, unknown> : QueryType extends 'update' ? UpdateQueryBuilder<DbType, TableNames & keyof DbType, TableNames & keyof DbType, unknown> : never>(type: QueryType): ToKyselyReturnType;
+    /**
+     * Builds a new DreamTransaction instance, provides
+     * the instance to the provided callback.
+     *
+     * ```ts
+     * await ApplicationModel.transaction(async txn => {
+     *   const user = await User.txn(txn).create({ email: 'how@yadoin' })
+     *   await Pet.txn(txn).create({ user })
+     * })
+     * ```
+     *
+     * @param callback - A callback function to call. The transaction provided to the callback can be passed to subsequent database calls within the transaction callback
+     * @returns void
+     */
+    static transaction<DreamInstance extends Dream, CB extends (txn: DreamTransaction<DreamInstance>) => unknown, RetType extends ReturnType<CB>>(dreamInstance: DreamInstance, callback: CB): Promise<RetType>;
+    /**
+     * @internal
+     *
+     * this is used by getColumnData to serialize enums
+     */
+    static enumType(row: SchemaBuilderInformationSchemaRow): Capitalize<string>;
     /**
      * @internal
      *
@@ -200,6 +266,7 @@ export default class KyselyQueryDriver<DreamInstance extends Dream> extends Quer
     }>;
     private buildDelete;
     private buildSelect;
+    orderByDirection(direction: OrderDir | null): import("kysely").RawBuilder<unknown>;
     private buildUpdate;
     /**
      * @internal
@@ -213,7 +280,6 @@ export default class KyselyQueryDriver<DreamInstance extends Dream> extends Quer
      * Used by loadBuider
      */
     hydratePreload(this: KyselyQueryDriver<DreamInstance>, dream: Dream): Promise<void>;
-    static duplicateDatabase(): Promise<void>;
     private aliasWhereStatements;
     private aliasWhereStatement;
     private rawifiedSelfOnClause;

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

@@ -1,4 +1,36 @@
 import Dream from '../../Dream.js';
+import { SchemaBuilderAssociationData, SchemaBuilderColumnData } from '../../helpers/cli/SchemaBuilder.js';
 import KyselyQueryDriver from './Kysely.js';
 export default class PostgresQueryDriver<DreamInstance extends Dream> extends KyselyQueryDriver<DreamInstance> {
+    /**
+     * create the database. Must respond to the NODE_ENV value.
+     */
+    static dbCreate(connectionName: string): Promise<void>;
+    /**
+     * delete the database. Must respond to the NODE_ENV value.
+     */
+    static dbDrop(connectionName: string): Promise<void>;
+    /**
+     * @internal
+     *
+     * this method is called when dream is initializing, and is used
+     * to configure the database to utilize custom type parsers for
+     * a variety of data types.
+     *
+     * @param connectionName - the name of the connection you are doing this for
+     * @returns void
+     */
+    static setDatabaseTypeParsers(connectionName: string): Promise<void>;
+    /**
+     * @internal
+     *
+     * this is used by the SchemaBuilder to store column data permanently
+     * within the types/dream.ts file.
+     */
+    static getColumnData(connectionName: string, tableName: string, associationData: {
+        [key: string]: SchemaBuilderAssociationData;
+    }): Promise<{
+        [key: string]: SchemaBuilderColumnData;
+    }>;
+    static duplicateDatabase(connectionName: string): Promise<void>;
 }

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

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

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

@@ -0,0 +1,9 @@
+import { DialectProviderCb } from '../../../../db/DreamDbConnection.js';
+type MigrationModes = 'migrate' | 'rollback';
+interface MigrationOpts {
+    connectionName: string;
+    dialectProvider: DialectProviderCb;
+    mode?: MigrationModes;
+}
+export default function runMigration({ connectionName, mode, dialectProvider, }: MigrationOpts): Promise<void>;
+export {};

package/dist/types/src/dream/QueryDriver/helpers/pg/createDb.d.ts

@@ -0,0 +1,2 @@
+import { DbConnectionType } from '../../../../types/db.js';
+export default function createDb(connectionName: string, connectionType: DbConnectionType, dbName?: string | null): Promise<false | undefined>;

package/dist/types/src/dream/QueryDriver/helpers/pg/dropDb.d.ts

@@ -0,0 +1,2 @@
+import { DbConnectionType } from '../../../../types/db.js';
+export default function dropDb(connectionName: string, connection: DbConnectionType, dbName?: string | null): Promise<false | undefined>;

package/dist/types/src/dream/QueryDriver/helpers/pg/loadPgClient.d.ts

@@ -0,0 +1,5 @@
+import pg from 'pg';
+export default function loadPgClient({ connectionName, useSystemDb, }: {
+    connectionName: string;
+    useSystemDb?: boolean;
+}): Promise<pg.Client>;

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

@@ -27,19 +27,19 @@ export interface DestroyOptions<DreamInstance extends Dream> {
 export declare function destroyOptions<DreamInstance extends Dream>(options: DestroyOptions<DreamInstance>): {
     reallyDestroy: boolean;
     bypassAllDefaultScopes: boolean;
-    defaultScopesToBypass: Exclude<DreamInstance["globalSchema" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["globalSchema" & keyof DreamInstance]][number & keyof DreamInstance["globalSchema" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["globalSchema" & keyof DreamInstance]]], "dream:STI">[];
+    defaultScopesToBypass: Exclude<DreamInstance["connectionTypeConfig" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]][number & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]]], "dream:STI">[];
     cascade: boolean;
     skipHooks: boolean;
 };
 export declare function undestroyOptions<DreamInstance extends Dream>(options: DestroyOptions<DreamInstance>): {
-    defaultScopesToBypass: Exclude<DreamInstance["globalSchema" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["globalSchema" & keyof DreamInstance]][number & keyof DreamInstance["globalSchema" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["globalSchema" & keyof DreamInstance]]], "dream:STI">[];
+    defaultScopesToBypass: Exclude<DreamInstance["connectionTypeConfig" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]][number & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]]], "dream:STI">[];
     bypassAllDefaultScopes: boolean;
     cascade: boolean;
     skipHooks: boolean;
 };
 export declare function reallyDestroyOptions<DreamInstance extends Dream>(options: DestroyOptions<DreamInstance>): {
     reallyDestroy: boolean;
-    defaultScopesToBypass: Exclude<DreamInstance["globalSchema" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["globalSchema" & keyof DreamInstance]][number & keyof DreamInstance["globalSchema" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["globalSchema" & keyof DreamInstance]]], "dream:STI">[];
+    defaultScopesToBypass: Exclude<DreamInstance["connectionTypeConfig" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]][number & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]["allDefaultScopeNames" & keyof DreamInstance["connectionTypeConfig" & keyof DreamInstance]]], "dream:STI">[];
     bypassAllDefaultScopes: boolean;
     cascade: boolean;
     skipHooks: boolean;

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

@@ -5,6 +5,7 @@ import { primaryKeyTypes } from '../dream/constants.js';
 import { EncryptOptions } from '../encrypt/index.js';
 import { DbConnectionType } from '../types/db.js';
 import { DreamModelSerializerType, SimpleObjectSerializerType } from '../types/serializer.js';
+import QueryDriverBase from '../dream/QueryDriver/Base.js';
 export default class DreamApp {
     /**
      * initializes a new dream application and caches it for use
@@ -57,7 +58,8 @@ export default class DreamApp {
     private _specialHooks;
     get specialHooks(): DreamAppSpecialHooks;
     private _dbCredentials;
-    get dbCredentials(): DreamDbCredentialOptions;
+    get dbCredentials(): Record<string, DreamDbCredentialOptions>;
+    dbCredentialsFor(connectionName: string): DreamDbCredentialOptions | null;
     private _encryption;
     get encryption(): DreamAppEncryptionOptions;
     private _parallelTests;
@@ -67,7 +69,7 @@ export default class DreamApp {
     private _paginationPageSize;
     get paginationPageSize(): number;
     private _primaryKeyType;
-    get primaryKeyType(): "bigint" | "integer" | "bigserial" | "uuid";
+    get primaryKeyType(): "bigint" | "bigserial" | "uuid" | "integer";
     private _projectRoot;
     get projectRoot(): string;
     private _paths;
@@ -82,17 +84,21 @@ export default class DreamApp {
     get plugins(): ((app: DreamApp) => void | Promise<void>)[];
     private _packageManager;
     get packageManager(): "yarn" | "npm" | "pnpm";
+    private _importExtension;
+    get importExtension(): ".js" | ".ts" | "none";
     protected loadedModels: boolean;
     constructor(opts?: Partial<DreamAppOpts>);
     get models(): Record<string, typeof Dream>;
     get serializers(): Record<string, DreamModelSerializerType | SimpleObjectSerializerType>;
-    dbName(connection: DbConnectionType): string;
-    dbConnectionConfig(connection: DbConnectionType): SingleDbCredential;
-    get hasReplicaConfig(): boolean;
+    dbName(connectionName: string, connection: DbConnectionType): string;
+    dbConnectionConfig(connectionName: string, connection: DbConnectionType): SingleDbCredential;
+    dbConnectionQueryDriverClass<T extends Dream = Dream>(connectionName: string): typeof QueryDriverBase<T>;
+    dbConnectionKeys(): string[];
+    hasReplicaConfig(connectionName: string): boolean;
     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 'db' ? DreamDbCredentialOptions : ApplyOpt extends 'encryption' ? DreamAppEncryptionOptions : ApplyOpt extends 'primaryKeyType' ? (typeof primaryKeyTypes)[number] : 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): void;
+    set<ApplyOpt extends DreamAppSetOption>(applyOption: ApplyOpt, options: 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;
     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';
@@ -105,7 +111,7 @@ export interface DreamAppOpts {
     serializerCasing?: DreamSerializerCasing;
     parallelTests: number | undefined;
 }
-export type DreamAppSetOption = 'db' | 'encryption' | 'inflections' | 'logger' | 'paths' | 'primaryKeyType' | 'projectRoot' | 'serializerCasing' | 'parallelTests' | 'unicodeNormalization' | 'paginationPageSize' | 'packageManager';
+export type DreamAppSetOption = 'db' | 'encryption' | 'inflections' | 'importExtension' | 'logger' | 'paths' | 'primaryKeyType' | 'projectRoot' | 'serializerCasing' | 'parallelTests' | 'unicodeNormalization' | 'paginationPageSize' | 'packageManager';
 export interface DreamDirectoryPaths {
     models?: string;
     serializers?: string;
@@ -118,6 +124,7 @@ export interface DreamDirectoryPaths {
 export interface DreamDbCredentialOptions {
     primary: SingleDbCredential;
     replica?: SingleDbCredential | undefined;
+    queryDriverClass?: typeof QueryDriverBase;
 }
 type UnicodeNormalizationForm = 'NFC' | 'NFD' | 'none';
 export interface SingleDbCredential {
@@ -158,4 +165,6 @@ export interface KyselyLogEvent {
 }
 export declare const DreamAppAllowedPackageManagersEnumValues: readonly ["yarn", "npm", "pnpm"];
 export type DreamAppAllowedPackageManagersEnum = (typeof DreamAppAllowedPackageManagersEnumValues)[number];
+export declare const GeneratorImportStyles: readonly [".js", ".ts", "none"];
+export type GeneratorImportStyle = (typeof GeneratorImportStyles)[number];
 export {};

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

@@ -1,6 +1,10 @@
+import { DreamConst } from '../../dream/constants.js';
 export default class SchemaBuilder {
+    private connectionName;
     hasForeignKeyError: boolean;
+    constructor(connectionName: string);
     build(): Promise<void>;
+    static buildGlobalTypes(): Promise<void>;
     private globalModelNames;
     private buildSchemaContent;
     private getSchemaImports;
@@ -15,3 +19,25 @@ export default class SchemaBuilder {
     private coercedType;
     private loadDbSyncFile;
 }
+export interface SchemaBuilderAssociationData {
+    tables: string[];
+    type: 'BelongsTo' | 'HasOne' | 'HasMany';
+    polymorphic: boolean;
+    optional: boolean | null;
+    foreignKey: string | null;
+    where: Record<string, string | typeof DreamConst.passthrough | typeof DreamConst.required> | null;
+}
+export interface SchemaBuilderColumnData {
+    dbType: string;
+    allowNull: boolean;
+    enumType: string | null;
+    enumValues: string | null;
+    isArray: boolean;
+    foreignKey: string | null;
+}
+export interface SchemaBuilderInformationSchemaRow {
+    columnName: string;
+    udtName: string;
+    dataType: string;
+    isNullable: 'YES' | 'NO';
+}

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

@@ -0,0 +1 @@
+export default function addImportSuffix(filepath: string): string;

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

@@ -2,6 +2,7 @@ export default function generateDream({ fullyQualifiedModelName, columnsWithType
     fullyQualifiedModelName: string;
     columnsWithTypes: string[];
     options: {
+        connectionName: string;
         serializer: boolean;
         stiBaseSerializer: boolean;
         includeAdminSerializers: boolean;

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

@@ -1,7 +1,8 @@
-export default function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, includeAdminSerializers, }: {
+export default function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, includeAdminSerializers, connectionName, }: {
     fullyQualifiedModelName: string;
     columnsWithTypes: string[];
     fullyQualifiedParentName?: string | undefined;
+    connectionName?: string;
     serializer: boolean;
     includeAdminSerializers: boolean;
 }): string;

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

@@ -1,6 +1,7 @@
-export default function generateMigration({ migrationName, columnsWithTypes, fullyQualifiedModelName, fullyQualifiedParentName, }: {
+export default function generateMigration({ migrationName, columnsWithTypes, connectionName, fullyQualifiedModelName, fullyQualifiedParentName, }: {
     migrationName: string;
     columnsWithTypes: string[];
+    connectionName: string;
     fullyQualifiedModelName?: string | undefined;
     fullyQualifiedParentName?: string | undefined;
 }): Promise<void>;

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

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

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

@@ -1 +1 @@
-export default function primaryKeyType(): "bigint" | "integer" | "bigserial" | "uuid";
+export default function primaryKeyType(connectionName: string): void;

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

@@ -19,6 +19,9 @@ export { default as Dream } from './Dream.js';
 export { DreamConst, openapiPrimitiveTypes, openapiShorthandPrimitiveTypes, type primaryKeyTypes, type TRIGRAM_OPERATORS, } from './dream/constants.js';
 export { default as DreamTransaction } from './dream/DreamTransaction.js';
 export { default as Query } from './dream/Query.js';
+export { default as QueryDriverBase } from './dream/QueryDriver/Base.js';
+export { default as KyselyQueryDriver } from './dream/QueryDriver/Kysely.js';
+export { default as PostgresQueryDriver } from './dream/QueryDriver/Postgres.js';
 export { default as Encrypt, type EncryptAlgorithm, type EncryptOptions } from './encrypt/index.js';
 export { default as NonLoadedAssociation } from './errors/associations/NonLoadedAssociation.js';
 export { default as CreateOrFindByFailedToCreateAndFind } from './errors/CreateOrFindByFailedToCreateAndFind.js';

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

@@ -81,9 +81,9 @@ export interface UpdateOrCreateByExtraOpts<T extends typeof Dream> {
 }
 export type TableNameForGlobalModelName<I extends Dream, GMN extends keyof GlobalModelNameTableMap<I>> = GlobalModelNameTableMap<I>[GMN];
 export type GlobalModelNames<I extends Dream> = keyof GlobalModelNameTableMap<I>;
-export type GlobalModelNameTableMap<I extends Dream, GlobalSchema = I['globalSchema'], GlobalNames = GlobalSchema['globalNames' & keyof GlobalSchema]> = GlobalNames['models' & keyof GlobalNames];
+export type GlobalModelNameTableMap<I extends Dream, ConnectionTypeConfig = I['connectionTypeConfig'], GlobalNames = ConnectionTypeConfig['globalNames' & keyof ConnectionTypeConfig]> = GlobalNames['models' & keyof GlobalNames];
 export type GlobalSerializerName<I extends Dream> = GlobalSerializerNames<I>[number];
-type GlobalSerializerNames<I extends Dream, GlobalSchema = I['globalSchema'], GlobalNames = GlobalSchema['globalNames' & keyof GlobalSchema]> = GlobalNames['serializers' & keyof GlobalNames];
+type GlobalSerializerNames<I extends Dream, GlobalTypeConfig = I['globalTypeConfig']> = GlobalTypeConfig['serializers' & keyof GlobalTypeConfig];
 export type DreamSerializers<I extends Dream> = Record<'default', GlobalSerializerName<I>> & Record<string, GlobalSerializerName<I>>;
 export type DreamConstructorType<T extends Dream> = (new (...arguments_: any[]) => T) & typeof Dream;
 export type ViewModel = {
@@ -127,10 +127,10 @@ export interface SimilarityStatement {
     columnName: string;
     opsStatement: OpsStatement<any, any>;
 }
-export type PassthroughColumnNames<DreamConf, GlobalSchema = DreamConf['globalSchema' & keyof DreamConf], PassthroughColumns = GlobalSchema['passthroughColumns' & keyof GlobalSchema]> = PassthroughColumns;
+export type PassthroughColumnNames<DreamConf, ConnectionTypeConfig = DreamConf['connectionTypeConfig' & keyof DreamConf], PassthroughColumns = ConnectionTypeConfig['passthroughColumns' & keyof ConnectionTypeConfig]> = PassthroughColumns;
 export type DefaultScopeName<DreamInstance extends Dream, Schema = DreamInstance['schema'], TableName extends keyof Schema = DreamInstance['table'] & keyof Schema> = DefaultScopeNameForTable<Schema, TableName>;
 export type DefaultScopeNameForTable<Schema, TableName extends keyof Schema, SchemaTable = Schema[TableName], SchemaDefaultScopes extends string[] = SchemaTable['scopes' & keyof SchemaTable]['default' & keyof SchemaTable['scopes' & keyof SchemaTable]] & string[]> = Exclude<SchemaDefaultScopes[number], typeof STI_SCOPE_NAME>;
-export type AllDefaultScopeNames<DreamConf, GlobalSchema = DreamConf['globalSchema' & keyof DreamConf], AllNames = GlobalSchema['allDefaultScopeNames' & keyof GlobalSchema]> = Exclude<AllNames[number & keyof AllNames], typeof STI_SCOPE_NAME>;
+export type AllDefaultScopeNames<DreamConf, ConnectionTypeConfig = DreamConf['connectionTypeConfig' & keyof DreamConf], AllNames = ConnectionTypeConfig['allDefaultScopeNames' & keyof ConnectionTypeConfig]> = Exclude<AllNames[number & keyof AllNames], typeof STI_SCOPE_NAME>;
 export type NamedScopeName<DreamInstance extends Dream, Schema = DreamInstance['schema'], SchemaTable = Schema[DreamInstance['table'] & keyof Schema], SchemaNamedScopes extends string[] = SchemaTable['scopes' & keyof SchemaTable]['named' & keyof SchemaTable['scopes' & keyof SchemaTable]] & string[]> = SchemaNamedScopes[number];
 export type DefaultOrNamedScopeName<DreamInstance extends Dream> = DefaultScopeName<DreamInstance> | NamedScopeName<DreamInstance>;
 export type PluckEachArgs<ColumnNames extends unknown[], CbArgTypes extends unknown[]> = [...fields: ColumnNames] | [...fields: ColumnNames, callback: (...values: CbArgTypes) => void | Promise<void>] | [...fields: ColumnNames, callback: (...values: CbArgTypes) => void | Promise<void>, opts: FindEachOpts];

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

@@ -391,8 +391,8 @@ export type GlobalModelNames<I extends Dream> = keyof GlobalModelNameTableMap<I>
 
 export type GlobalModelNameTableMap<
   I extends Dream,
-  GlobalSchema = I['globalSchema'],
-  GlobalNames = GlobalSchema['globalNames' & keyof GlobalSchema],
+  ConnectionTypeConfig = I['connectionTypeConfig'],
+  GlobalNames = ConnectionTypeConfig['globalNames' & keyof ConnectionTypeConfig],
 > = GlobalNames['models' & keyof GlobalNames]
 // end:Model global names and tables
 
@@ -401,9 +401,8 @@ export type GlobalSerializerName<I extends Dream> = GlobalSerializerNames<I>[num
 
 type GlobalSerializerNames<
   I extends Dream,
-  GlobalSchema = I['globalSchema'],
-  GlobalNames = GlobalSchema['globalNames' & keyof GlobalSchema],
-> = GlobalNames['serializers' & keyof GlobalNames]
+  GlobalTypeConfig = I['globalTypeConfig'],
+> = GlobalTypeConfig['serializers' & keyof GlobalTypeConfig]
 // end:Serializer global names
 
 export type DreamSerializers<I extends Dream> = Record<'default', GlobalSerializerName<I>> &
@@ -551,8 +550,8 @@ export interface SimilarityStatement {
 
 export type PassthroughColumnNames<
   DreamConf,
-  GlobalSchema = DreamConf['globalSchema' & keyof DreamConf],
-  PassthroughColumns = GlobalSchema['passthroughColumns' & keyof GlobalSchema],
+  ConnectionTypeConfig = DreamConf['connectionTypeConfig' & keyof DreamConf],
+  PassthroughColumns = ConnectionTypeConfig['passthroughColumns' & keyof ConnectionTypeConfig],
 > = PassthroughColumns
 
 export type DefaultScopeName<
@@ -574,8 +573,8 @@ export type DefaultScopeNameForTable<
 
 export type AllDefaultScopeNames<
   DreamConf,
-  GlobalSchema = DreamConf['globalSchema' & keyof DreamConf],
-  AllNames = GlobalSchema['allDefaultScopeNames' & keyof GlobalSchema],
+  ConnectionTypeConfig = DreamConf['connectionTypeConfig' & keyof DreamConf],
+  AllNames = ConnectionTypeConfig['allDefaultScopeNames' & keyof ConnectionTypeConfig],
 > =
   // it is not valid to remove the STI scope
   Exclude<AllNames[number & keyof AllNames], typeof STI_SCOPE_NAME>

package/docs/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62bW3PbNhCF/4ue00vSJG3zJslW4oltKZLiPHQ6HZhcSahBgAVBx0wn/70DUhJviwVI982jPec7JAiCIAH/8e/EwJOZvJvMQEaHhOmHyYtJysxh8m4SCZZlkP10Lv14MImYvJg8cBlP3r189dv3F2f/nAmQMdMXzEAf0aySlANED3MlM6MZl+aOK8EMVxIhOpQkXfAFF/BFcwMaQTbLJEcDM7DUCy7jWbFgXEC8VdWvUxnbnxG630RlXjDDtkUKcyXyRNq/bniWMBMd+lFuLZkAkdLMKJ0hxHONJGhgCWK2P3t90zR1WKdp6nXPONJHThWve3595XDPr6+87qskVRrtUa2yl3Ot9gpr+3PNS7jhe13eBR9ApIBeSEzm5W5Acyb4N9CznIvYeao9nZe81UxmLMLv8a6Col3KSBep6UOOBdr7iPkeKc97oe6ZuGUJ3CqzASS4q6Bot0peKxZDPM0yFXHHmIepaKq5zYUgRtGugqIt7/+GyAR0BYeQYn/KQRd9Uvkz5VszuUceN+XPpM+OZ/GtMguVY4N1u06R7pjgcdl2l1orpDU6Aoo1A6HkPtuqjWEGEpCNXsWlAb1jUfk87sra0Fdv3mLD+lzJ8icM2RWRwOOYfCW5Wab2xDKc2deFYJepoXlWQIGONzx1aG0JBbuyJsnEVBb2ORrXvXoNMgad3TBZoBlBzmdFLyWMS15KoIKXKUiW8gvIIs3T9sDRiOnLAqCb6AAJW2mVgjYc8Mvj0I7Abw5KmwNr3uL+nLMpINA28IKDiKtBj4rpSCl494qBdt4VuJSCz1kC1tBoE1Ok5ST9WOi4f/7915dvXjUJKkmUbLVedU7l6WU9Li33pdl3hi1PoIs9/e7138+VlFDOIOw16HE6dT/PqnpnefzZ6z6OYlMh1FeIVyx6YHu4YZLtQWeXMk96YK8jLLOeM9yAYTEzDE/q68L4xmh+nxukZdrlINrcPj0bhzKVMfJQbPApQ3hi9cbkDqjqYTwCNZRiJ5F4szbqQbxrtb+GRxAo7FQMJe2bs782Z9+d7zkoNyoGUY9h6P3p0AXxl/qOw9fSXV7AGvERCjSJdAzNHBQ3PGnFNEs2bAeemw/RDeP7uiEmDEo4nTO7F/iFbwoGE6daM7zZe6pBbPflHH4NawfetI16EO+Oa5MzUV0IHNmW+KjHyfJU7JXm5tB7PnXrPt4HVk59ncN5tx7AW0qgcM2yl1akB5DY9Kiu+BjHqc5UCHSm0CkH0hZKJ8y4YMdqIOs2T+5B08SWJpC70jzhhj/CjGVAnXtfODQhiD6EXE1M0RGjrxjORN5EXHDX+wedYluSZFvBMKKK6aawgsHEsIZoKQdlVG8b+JuIUzgo4fIp1ZBldpIpxHJHhnS0Y3NkEZ5jtSNzlhKCc0rtyJw1hKas4RkZ1U9hHY4yDjoC+/UFmRhjmkFc+52WhFrBQKId4T1MKxlE7X4IQajoB5AQqv9+a+jG8sP6C2YYk+i9sxu6sfxBZ9QyjEj0Podq2Uj6kNNp6Ufk+UfEhm4sf8gJtQ0jEoeEjcs5T7/egwTNIzKoKx6UdD6+IY9kl+nZyd5b2WV6brK/k7pMz01uvkb7Hup++/91NPZb+OhjKc3jjmRQx3e6hmUbzeWeDiolodTTUXleXnu6ofzgV0XCMTpzWN6QrPMij4N+rvt4K5ZFDF2mqSs+xtouXnO5X2mIeNZax6tQPYGPWN8kc5YhHa9b9/J4kgrobhjAvgK7ld4MyR6A73i/JeuKj/E5jZmB8mNhvcSArWJWYI88PC0kIpxbb0XAWrhd9bJOX617mFMhmFB+ZndiyqqP9eUAuv7Gt1C6sxWtYuKqcWz0oAnp8FXOR6a5vb71SucPL9uUX3off8llwjsm8mZHagQEen3x5X5MZ0BZJRDb9dX79fTmr+Xqcj3dLtcbjNQTEUBFfzOsoaiQbG0V+GjpZTgcnjAHkbogqeYJ08VHKJyH1JH4rm497NawXS7LhfPeYkUb9vY1sZEMo3U1BG4NqeARs6tPGKlRJiCb7RVm3myvKJPamQsQYNDgukogouOeCwxwqpH2lBvmBpyqFEIoCRcAqasBWwIalMFUiOZ+iswB7AspsEpS1vyk1EBVJcIc227pPaS+yodcWYSLZIsEAJ5SZrcn8Hm1RxDjdDUEbm/fG5iBzjOvZrUEFKjcsVoG2hXchVbJIhei+JQzUU6TygeyLaEpwW7qELTK01mB8qsSYT6cVugw+7lIALjcga4HHXsK3UV6DB1gCw/NzvayKbvbEQLyPQTyUAzoDDrbsZtBdZ3CZAHPi56IBF4mqUF7xbFEmIVisX0IYO5TjbSrhzwtW25W1Hu6cRoqJeDSLq/as/8seaRilNrVELj09GqIcc5FCrAvNym3Xw8aiLpMQHR7U3ZtLwvdmU7bCnYf+iNcUENsT0QB2/u7G5D+xu6WMTv3yxFDYbCZOoAD03Yqbg4rDTv+hOZ0NBSuetdF76FTjbIrjT6A7e8eGz6aVxWP9fgNv2jttmkzGpJAWPkq48OVIgpomP1/tph/gyH9wusiInNJz/aadRLD/8Ht/B/SZl9x44t73HssEoDH6vMCdPdF1pS2IgC1be8a65O2/V1jb19///M/oRnNyPY4AAA="
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62bUXPjthWF/4uet0l3k2zafZNla+NZ21IlxXnodDoweS0hBgEGhJxlOvnvHZCSSAIXFyCdN4/uOd8hQRIEQPjf/5sZ+Gpmn2ZXILNDwfTL7N2sZOYw+zTLBKsqqL69lL45mELM3s1euMxnn95/+Mef7y7+BRMgc6avmQEf0a+SlANkLwslK6MZl+aRK8EMVxIhBpQkXfAlF/CL5gY0guyXSY4GZmCll1zmV/WScQH5TrW/zmVuf0bocROVec0M29UlLJQ4FtL+dc+rgpns4EeFtWQCZEozo3SFEC81kqCBFYjZ/hz1zcsyYJ2XZdR9xZF75FyJuhd3twH34u426r4tSqXRO2pQjnLu1F5hbX+pRQn3fK+bp+AnECWgFxKTRblb0JwJ/gfoqyMXefBUPV2UvNNMVizDn3FXQdFuZKbr0viQU4H2vmK+V8rzWagnJh5YAQ/KbAEJdhUU7Utdgaj/dQRdX2v+ijWwJ6F4D0reKZZDPq8qlfFAH4qpaKp5OApB9MqugqKtnn6FzCTcWgEhxV6ryuw1VGSLIiKK2ch8SvNz1Nfir1iFvBwdAcXaMLlHCM3PpM/23/mDMkt1xF5OwzpFemSC5821vdFaIa3qCCjWFQgl99VObQ0zUIDsPUVcGtDPLGvGH65sCP3ww0fsNbZQsvkJQ7oiEnh6B91KblalPbEKZ/q6FOyqNDTPCijQqYOjDm0ooWC31iSZmMvajhvy7qnbgMxBV/dM1mhGkvNN0SsJ05JXEqjgVQmSlfwaqkzzctix9WJ8WQJ0mx2gYGutStCGA355AtoJ+O1BaXNg/Uc8nnMxJQTaBl5yEHnbKVMxjpSCu1cMdPCpwKUUfMEKsIZem5i6bCYlp4Lj/vs/f3z/w4c+QRWFkoPWa8+pOb3K49LyWJqdI+14AS72/HvU/7RQUkIzYrLXwOM49TjPqryzPP0cdZ96sbkQ6nfI1yx7YXu4Z5LtQVc38lh44KgjLbMb09yDYTkzDE/ydWl8YzR/OhqkZYblJNrCvj17hzKXOfJS7PEpQ3piO0MMB7T1NB6BGkuxg2a8WXv1JN6d2t/BKwgUdi6mkvb9UeSQs3fHjgHKvcpBdH0Y+nwGdEn8lX7k8Hvjbi5gh/gCNZpEOsZmjoobn7RmmhVb9gyRhw/RjePHbkNMmJRwPmf2JPAL3xeMJs61Znize6pR7PDlHH8NOwfetL16Eu+Ra3Nkor0QOHIoiVFPg+W52CvNzcF7P7n1GO8n1gx9g925W0/grSRQuH45SqvLA0hseNRVYozTUGcuBDpScMqJtKXSBTMh2KmayHo4Fk+gaeJAk8hda15ww1/Bztupc/eFYxOS6GPI7cAU7TF8xXgmMhMJwUPzDzpluJaCsP21lBhR5XRTWMFoYlpDDJSjMtrZBj4TCQpHJdx8LTVUlR1kCrF6JkMc7dQcWafnWO3EnJWE5JxGOzFnA6kpG3hDRvtT2g1HGUcdgV19QQbGmGYU164jk1ArGEm0PXyEaSWjqO5CCEJFF0BSqPHnraebyk+7XzDDlMTok93TTeWPOqOBYUJi9D3UySbSx5zOQD8hL94j9nRT+WNOaGiYkDgmbFrOZfj1GSRonpFBrnhU0uX4xrySQ6Y3J0cf5ZDprcnxmzRkemtyfxode6nH7X/V0di18MnH0pinHcmoGz/oGpdtNJd7OqiRpFLPRxWZvHq6sfzkqSLhmJw5Lm9M1uUjT4B+qcd4a1ZlDP1M01VijI39eM3lfq0h49XgO16L8gQxYveQLFiF3HhuPcrjRSnA3dCArQKHldEMyV6AP3O/JbtKjPFzmTMDzWJh94kB+4rZgiPy9LSUiHRutxUBa+FhNco6r1p7mHMhmdAsswcxTTXG+uUAulvjWyrtbL1rmbhqGhs9aEI6/ivnK9PcXt/uS+ff3g8p33mLv+Rnwkcmjv0bqReQ6I3FN/tPgwFNlUDsNrefN/P7/67WN5v5brXZYiRPRAAVvWbYQVEh2doq8dXiZQQckbAAkbogpeYF0/UXqIOH5EhiV7frdjvY81E2H869jxVD2MfviY1uGM3VELgNlIJnzH59wki9MgHZ7m4x83Z3S5nUs7kGAQYN7qoEIjvtucAA5xppL7lhYcC5SiGEknANUIYacCCgQRXMhejvp6gCQF9IgVVRsv6SUg/Vlghzbm/L6CH5qhhybREhki0SAPhaMrs9gS/aPYIYx9UQuL2dNzADzjuvYw0EFKjZodsE2i+4S62K5VHYTbZMNMOk5oVsS2hKsps6BK2O5VWN8tsSYT6cv9Bh9kuRAHD5DLrrdOwpuB/pMXSCLT20utibpnS3IyTkRwjkoRjQFTjbz/tBXZ3CVAnvC09EAm+K0qB3xalEmIViuX0JYO5zjbSrl2PZtNxV3e1hx2molIBL+3nVnv3PkmcqR6muhsCV56khxrkUKcC+2aQ8nB70EF2ZgOjhpuzO3hTckc7QCnaf/CtcU12sJ6KAw/3dPYi/sXtgrC735YSuMNlMHcCBaTsUN4e1hmf+Fc1xNBSuneuiz9C5RtmVRl/A9veIDe/N20rEelrDrwe7bYaMniQR1kxlYrhGRAENs/+/l/M/YMx9EXURkUdJj/b6dRLDf8Pt/DfSZqe4+fUT7j0VCcBru7wA7r7IjjJUJKB2w11jPmnn7xr7+P2f//k/wkz3GeY5AAA="