@rvoh/dream 2.0.4 → 2.1.0

package/dist/cjs/src/helpers/cli/ASTSchemaBuilder.js

@@ -0,0 +1,304 @@
+import ts from 'typescript';
+import { CliFileWriter } from '../../cli/CliFileWriter.js';
+import { DreamConst } from '../../dream/constants.js';
+import compact from '../compact.js';
+import uniq from '../uniq.js';
+import ASTConnectionBuilder from './ASTConnectionBuilder.js';
+import autogeneratedFileDisclaimer from './autoGeneratedFileDisclaimer.js';
+const f = ts.factory;
+/**
+ * Responsible for building dream schema, which can be found at
+ * types/dream.ts. If you are leveraging multiple db connections,
+ * then this file will also be responsible for building all variants,
+ * i.e. types/dream.alternateConnection.ts, etc...
+ *
+ * This class leverages internal AST building mechanisms built into
+ * typescript to manually build up object literals and interfaces
+ * for our app to consume.
+ */
+export default class ASTSchemaBuilder extends ASTConnectionBuilder {
+    /**
+     * builds the new contents for the dream schema file (i.e. types/dream.ts
+     * for default connection), and writes it to the file. This is automatically
+     * done anytime the sync cli command is called, which happens when migrating,
+     * rolling back, and when manually calling the sync command via CLI.
+     */
+    async build() {
+        // build a new, blank source file to populate with our output
+        const sourceFile = ts.createSourceFile('', '', ts.ScriptTarget.Latest, false, ts.ScriptKind.TS);
+        const { importedTypes, importedVariables, schemaConst, passthroughColumns, allDefaultScopeNames } = await this.buildSchemaConst();
+        const output = await this.prettier(this.printStatements([
+            ...this.dateAndDateTimeImports(),
+            this.dbImports(importedTypes, importedVariables),
+            this.newLine(),
+            schemaConst,
+            this.newLine(),
+            this.buildConnectionTypeConfigConst(passthroughColumns, allDefaultScopeNames),
+        ], sourceFile));
+        await CliFileWriter.write(this.schemaPath(), output);
+    }
+    /**
+     * @internal
+     *
+     * builds up the `export const schema = ...` statement within the dream.ts
+     * file. It does this by leveraging low-level AST utils built into typescript
+     * to manually build up an object literal, cast it as a const, and write it to
+     * an exported variable.
+     */
+    async buildSchemaConst() {
+        const schemaData = await this.getSchemaData();
+        const importedTypes = [];
+        const importedVariables = [];
+        let passthroughColumns = [];
+        let allDefaultScopeNames = [];
+        const dbSourceFile = await this.getDbSourceFile();
+        const schemaObjectLiteral = f.createObjectLiteralExpression(Object.keys(schemaData).map(tableName => {
+            const tableData = schemaData[tableName];
+            allDefaultScopeNames = [...allDefaultScopeNames, ...tableData.scopes.default];
+            return f.createPropertyAssignment(f.createIdentifier(tableName), f.createObjectLiteralExpression([
+                f.createPropertyAssignment(f.createIdentifier('serializerKeys'), f.createArrayLiteralExpression([...(tableData?.serializerKeys || [])].sort().map(key => f.createStringLiteral(key)))),
+                f.createPropertyAssignment(f.createIdentifier('scopes'), f.createObjectLiteralExpression([
+                    f.createPropertyAssignment(f.createIdentifier('default'), f.createArrayLiteralExpression((tableData?.scopes.default).sort().map(key => f.createStringLiteral(key)))),
+                    f.createPropertyAssignment(f.createIdentifier('named'), f.createArrayLiteralExpression((tableData?.scopes.named).sort().map(key => f.createStringLiteral(key)))),
+                ], true // multiline
+                )),
+                f.createPropertyAssignment(f.createIdentifier('nonJsonColumnNames'), f.createArrayLiteralExpression(Object.keys(tableData?.columns || {})
+                    .filter(columnName => !['json', 'jsonb', 'json[]', 'jsonb[]'].includes(tableData.columns[columnName].dbType))
+                    .sort()
+                    .map(key => f.createStringLiteral(key)))),
+                f.createPropertyAssignment(f.createIdentifier('columns'), f.createObjectLiteralExpression(Object.keys(tableData?.columns || {})
+                    .sort()
+                    .map(columnName => {
+                    const columnData = tableData.columns[columnName];
+                    // any enums for these columns will need to be imported
+                    // from the db.ts file in the same folder, so as we detect
+                    // them, we push them into the importedModules array.
+                    if (columnData.enumType) {
+                        importedTypes.push(columnData.enumType);
+                        importedVariables.push(columnData.enumType + 'Values');
+                    }
+                    const enumTypeNode = columnData.enumType
+                        ? f.createTypeReferenceNode(f.createIdentifier(columnData.enumType), undefined // No type arguments needed here
+                        )
+                        : null;
+                    const enumValuesNode = columnData.enumType
+                        ? f.createIdentifier(columnData.enumType + 'Values')
+                        : f.createNull();
+                    const coercedType = this.getCoercedTypeForTableColumn(dbSourceFile, tableName, columnName, tableData, importedTypes);
+                    return f.createPropertyAssignment(f.createIdentifier(columnName), f.createObjectLiteralExpression([
+                        f.createPropertyAssignment(f.createIdentifier('coercedType'), f.createAsExpression(f.createObjectLiteralExpression(), coercedType)),
+                        f.createPropertyAssignment(f.createIdentifier('enumType'), enumTypeNode
+                            ? f.createAsExpression(f.createObjectLiteralExpression(), enumTypeNode)
+                            : f.createNull()),
+                        f.createPropertyAssignment(f.createIdentifier('enumArrayType'), enumTypeNode
+                            ? f.createAsExpression(f.createArrayLiteralExpression(), f.createArrayTypeNode(enumTypeNode))
+                            : f.createNull()),
+                        f.createPropertyAssignment(f.createIdentifier('enumValues'), enumValuesNode),
+                        f.createPropertyAssignment(f.createIdentifier('dbType'), f.createStringLiteral(columnData.dbType)),
+                        f.createPropertyAssignment(f.createIdentifier('allowNull'), columnData.allowNull ? f.createTrue() : f.createFalse()),
+                        f.createPropertyAssignment(f.createIdentifier('isArray'), columnData.isArray ? f.createTrue() : f.createFalse()),
+                    ], true // multiline
+                    ));
+                }), true // multiline
+                )),
+                f.createPropertyAssignment(f.createIdentifier('virtualColumns'), f.createArrayLiteralExpression(tableData?.virtualColumns
+                    ?.sort()
+                    ?.map(columnName => f.createStringLiteral(columnName)))),
+                f.createPropertyAssignment(f.createIdentifier('associations'), f.createObjectLiteralExpression(Object.keys(tableData?.associations || {})
+                    .sort()
+                    .map(associationName => {
+                    const associationMetadata = tableData.associations[associationName];
+                    const andStatement = associationMetadata.and;
+                    const requiredAndClauses = andStatement === null
+                        ? []
+                        : Object.keys(andStatement).filter(column => andStatement[column] === DreamConst.required);
+                    const passthroughAndClauses = andStatement === null
+                        ? []
+                        : Object.keys(andStatement).filter(column => andStatement[column] === DreamConst.passthrough);
+                    passthroughColumns = [...passthroughColumns, ...passthroughAndClauses];
+                    return f.createPropertyAssignment(f.createIdentifier(associationName), f.createObjectLiteralExpression([
+                        f.createPropertyAssignment(f.createIdentifier('type'), f.createStringLiteral(associationMetadata.type)),
+                        f.createPropertyAssignment(f.createIdentifier('foreignKey'), associationMetadata.foreignKey
+                            ? f.createStringLiteral(associationMetadata.foreignKey)
+                            : f.createNull()),
+                        f.createPropertyAssignment(f.createIdentifier('foreignKeyTypeColumn'), associationMetadata.foreignKeyTypeColumn
+                            ? f.createStringLiteral(associationMetadata.foreignKeyTypeColumn)
+                            : f.createNull()),
+                        f.createPropertyAssignment(f.createIdentifier('tables'), f.createArrayLiteralExpression(associationMetadata.tables.sort().map(table => f.createStringLiteral(table)))),
+                        f.createPropertyAssignment(f.createIdentifier('optional'), associationMetadata.optional === null
+                            ? f.createNull()
+                            : associationMetadata.optional
+                                ? f.createTrue()
+                                : f.createFalse()),
+                        f.createPropertyAssignment(f.createIdentifier('requiredAndClauses'), requiredAndClauses.length === 0
+                            ? f.createNull()
+                            : f.createArrayLiteralExpression(requiredAndClauses.sort().map(clause => f.createStringLiteral(clause)))),
+                        f.createPropertyAssignment(f.createIdentifier('passthroughAndClauses'), passthroughAndClauses.length === 0
+                            ? f.createNull()
+                            : f.createArrayLiteralExpression(passthroughAndClauses.sort().map(clause => f.createStringLiteral(clause)))),
+                    ], true // multiline
+                    ));
+                }), true // multiline
+                )),
+            ], true // multiline
+            ));
+        }), true // multiLine
+        );
+        // add "as const" to the end of the schema object we
+        // have built before returning it
+        const constAssertion = f.createAsExpression(schemaObjectLiteral, f.createKeywordTypeNode(ts.SyntaxKind.ConstKeyword));
+        const schemaConst = f.createVariableStatement([f.createModifier(ts.SyntaxKind.ExportKeyword)], f.createVariableDeclarationList([f.createVariableDeclaration(f.createIdentifier('schema'), undefined, undefined, constAssertion)], ts.NodeFlags.Const));
+        return {
+            schemaConst,
+            importedTypes: uniq(importedTypes).sort(),
+            importedVariables: uniq(importedVariables).sort(),
+            passthroughColumns: uniq(passthroughColumns).sort(),
+            allDefaultScopeNames: uniq(allDefaultScopeNames).sort(),
+        };
+    }
+    /**
+     * @internal
+     *
+     * builds up the `export const connectionTypeConfig = ...` statement within the dream.ts
+     * file. It does this by leveraging low-level AST utils built into typescript
+     * to manually build up an object literal, cast it as a const, and write it to
+     * an exported variable.
+     */
+    buildConnectionTypeConfigConst(passthroughColumns, allDefaultScopeNames) {
+        const connectionTypeConfigObjectLiteral = f.createObjectLiteralExpression([
+            f.createPropertyAssignment(f.createIdentifier('passthroughColumns'), f.createArrayLiteralExpression(passthroughColumns.sort().map(column => f.createStringLiteral(column)), true // multiline
+            )),
+            f.createPropertyAssignment(f.createIdentifier('allDefaultScopeNames'), f.createArrayLiteralExpression(allDefaultScopeNames.sort().map(column => f.createStringLiteral(column)), true // multiline
+            )),
+            f.createPropertyAssignment(f.createIdentifier('globalNames'), f.createObjectLiteralExpression([
+                f.createPropertyAssignment(f.createIdentifier('models'), f.createObjectLiteralExpression(this.globalModelNames()
+                    .sort()
+                    .map(([globalName, tableName]) => f.createPropertyAssignment(f.createStringLiteral(globalName), f.createStringLiteral(tableName))), true // multiline
+                )),
+            ], true // multiline
+            )),
+        ], true // multiline
+        );
+        // add "as const" to the end of the schema object we
+        // have built before returning it
+        const constAssertion = f.createAsExpression(connectionTypeConfigObjectLiteral, f.createKeywordTypeNode(ts.SyntaxKind.ConstKeyword));
+        const connectionTypeConfigObjectLiteralConst = f.createVariableStatement([f.createModifier(ts.SyntaxKind.ExportKeyword)], f.createVariableDeclarationList([
+            f.createVariableDeclaration(f.createIdentifier('connectionTypeConfig'), undefined, undefined, constAssertion),
+        ], ts.NodeFlags.Const));
+        return connectionTypeConfigObjectLiteralConst;
+    }
+    /**
+     * @internal
+     *
+     * writes the compiled statements to string. Will also manually inject new lines
+     * into the import statements, since otherwise, they are forced into a single line
+     * and are completely unreadable that way.
+     *
+     * prettier is used in a later step to optimize output, but the user may not have
+     * prettier installed, in which case it will do nothing, and we don't want to leave
+     * the imports unformatted in those cases.
+     */
+    printStatements(statements, sourceFile) {
+        const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed, omitTrailingSemicolon: true });
+        const result = printer.printList(ts.ListFormat.SourceFileStatements, f.createNodeArray(statements), sourceFile);
+        // manually replace single-line db imports with multi-line import
+        const output = result
+            .replace(/import\s*{\s*([^}]+)\s*}\s*from\s*"\.\/db.js"/, (_, names) => {
+            // Split items, trim them, and rejoin with newlines + indentation
+            const formatted = names
+                .split(',')
+                .map((n) => n.trim())
+                .map((n) => `  ${n},`)
+                .join('\n');
+            return `import {\n${formatted}\n} from "./db.js"`;
+        })
+            .replaceAll(/from ([^;]*);/g, 'from $1');
+        return `\
+${autogeneratedFileDisclaimer()}
+${output}`;
+    }
+    /**
+     * @internal
+     *
+     * builds up an AST statement representing the DB imports that the dream.ts
+     * file will need in order to render without import errors. It takes the aggregated
+     * list of imported types and imported variables built up as the schema was being
+     * built, and uses them to build AST import nodes, which can be rendered into the
+     * schema source file.
+     */
+    dbImports(importedTypes, importedVariables) {
+        const namedImports = f.createNamedImports([
+            ...importedTypes.map(importName => f.createImportSpecifier(true, undefined, f.createIdentifier(importName))),
+            ...importedVariables.map(importName => f.createImportSpecifier(false, undefined, f.createIdentifier(importName))),
+        ]);
+        const importClause = f.createImportClause(false, undefined, namedImports);
+        const importDeclaration = f.createImportDeclaration(undefined, importClause, f.createStringLiteral('./db.js'), undefined);
+        return importDeclaration;
+    }
+    /**
+     * @internal
+     *
+     * given a column and table, this method returns the coerced type representation
+     * of whatever type was found in the db.ts file. In most cases, it will simply
+     * return the same type as was found, but in some cases it will perform coercion
+     * to provide consistent and useful types to the underlying application.
+     *
+     * Amongst other things, it will convert Numeric -> number, Int8 -> string, etc...
+     * Timestamp will be carefully converted to either CalendarDate or DateTime, depending
+     * on if the type set in the db is a date or datetime field.
+     */
+    getCoercedTypeForTableColumn(dbSourceFile, tableName, columnName, tableData, importedModules) {
+        const columnData = tableData.columns[columnName];
+        const tableNode = this.getTableInterfaceDeclaration(dbSourceFile, tableName);
+        const propertyNode = this.getPropertyFromInterface(tableNode, columnName);
+        const coercedTypes = this.coercedType(dbSourceFile, propertyNode, columnData.dbType, importedModules);
+        return coercedTypes.length === 1 ? coercedTypes[0] : f.createUnionTypeNode(coercedTypes);
+    }
+    /**
+     * @internal
+     *
+     * used by the getCoercedTypeForTableColumn to get the specific type for a column
+     * if no coercion is necessary, the original type node will be returned
+     */
+    coercedType(dbSourceFile, propertySignature, dbType, importedModules) {
+        const extractedPropertyTypes = this.extractTypeNodesFromTypeOrUnion(propertySignature);
+        const isDate = /^date[[\]]*$/.test(dbType);
+        const types = compact(extractedPropertyTypes.map(typeNode => {
+            const typeText = typeNode.getText(dbSourceFile);
+            let defaultReturnNode = /^Generated/.test(typeText) ? this.getFirstGenericType(typeNode) : typeNode;
+            const modifiedText = defaultReturnNode.getText(dbSourceFile);
+            defaultReturnNode = /^ArrayType/.test(modifiedText)
+                ? f.createArrayTypeNode(this.getFirstGenericType(defaultReturnNode))
+                : defaultReturnNode;
+            const sanitized = typeText
+                .replace(/\s/g, '')
+                .replace(/Generated<(.*)>/g, '$1')
+                .replace(/ArrayType<(.*)>/g, '$1[]');
+            if (sanitized === '')
+                return null;
+            switch (sanitized) {
+                case 'Numeric':
+                    return f.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
+                case 'Numeric[]':
+                    return f.createArrayTypeNode(f.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword));
+                case 'Timestamp':
+                    return isDate ? f.createTypeReferenceNode('CalendarDate') : f.createTypeReferenceNode('DateTime');
+                case 'Timestamp[]':
+                    return isDate
+                        ? f.createArrayTypeNode(f.createTypeReferenceNode('CalendarDate'))
+                        : f.createArrayTypeNode(f.createTypeReferenceNode('DateTime'));
+                case 'Int8':
+                    return f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);
+                case 'Int8[]':
+                    return f.createArrayTypeNode(f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword));
+                case 'Json':
+                case 'Json[]':
+                    importedModules.push('Json');
+                    return defaultReturnNode;
+                default:
+                    return defaultReturnNode;
+            }
+        }));
+        return types;
+    }
+}

package/dist/cjs/src/helpers/cli/DBClassDeprecation.js

@@ -0,0 +1,60 @@
+import * as fsSync from 'node:fs';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import DreamCLI from '../../cli/index.js';
+import DreamApp from '../../dream-app/index.js';
+/**
+ * Originally, psychic-workers tapped into the types produced by psychic,
+ * modifying the psychicTypes to include type configurations for workers
+ * as well. Since Psychic no longer supports this method of augmenting
+ * types, psychic-workers has been refactored to produce its own types
+ * file.
+ *
+ * This service is responsible for identifying applications that are still
+ * reliant on the types produced by psychic, and refactoring them so that their
+ * imports are now in the correct places.
+ */
+export default class DBClassDeprecation {
+    async deprecate() {
+        const dreamApp = DreamApp.getOrFail();
+        if (dreamApp.bypassDeprecationChecks)
+            return;
+        const files = [
+            path.join(process.cwd(), DreamApp.system.dreamPath('models'), 'ApplicationModel.ts'),
+            path.join(process.cwd(), DreamApp.system.dreamPath('models'), 'ApplicationBackgroundedModel.ts'),
+        ];
+        try {
+            for (const file of files) {
+                const exists = fsSync.existsSync(file);
+                if (!exists)
+                    continue;
+                const fileContent = (await fs.readFile(file)).toString();
+                if (fileContent.includes('DBClass')) {
+                    await DreamCLI.logger.logProgress(`[dream] patching deprecated DBClass type for ${file.split(path.sep).at(-1)}`, async () => {
+                        await fs.writeFile(file, fileContent.replace(/DBClass/g, 'DB'));
+                    });
+                }
+            }
+        }
+        catch (err) {
+            console.error(err);
+            console.log(`
+ATTENTION: 
+
+The dream package has formally deprecated the DBClass export from all dream schema files. Any usage
+of the DBClass export throughout your app should be replaced with the "DB" export, which provides an
+identical structure to the original DBClass export.
+
+An automated script is meant to manually catch and fix this for you any time you sync, but for some
+reason it failed. Make sure to replace all DBClass imports throughout your app with the DB export, like so:
+
+import { DB } from '@src/types/db.js'
+
+export default class ApplicationModel extends Dream {
+  declare public DB: DB
+  ...
+}
+`);
+        }
+    }
+}

package/dist/esm/src/bin/index.js

@@ -1,6 +1,7 @@
 import DreamCLI from '../cli/index.js';
 import DreamApp from '../dream-app/index.js';
 import Query from '../dream/Query.js';
+import DBClassDeprecation from '../helpers/cli/DBClassDeprecation.js';
 import generateDream from '../helpers/cli/generateDream.js';
 import sspawn from '../helpers/sspawn.js';
 export default class DreamBin {
@@ -9,6 +10,7 @@ export default class DreamBin {
         for (const connectionName of Object.keys(dreamApp.dbCredentials)) {
             await Query.dbDriverClass(connectionName).sync(connectionName, onSync, options);
         }
+        await new DBClassDeprecation().deprecate();
     }
     static async dbCreate() {
         const dreamApp = DreamApp.getOrFail();

package/dist/esm/src/db/helpers/dreamSchemaTypesFilenameForConnection.js

@@ -0,0 +1,3 @@
+export default function dreamSchemaTypesFilenameForConnection(connectionName) {
+    return connectionName === 'default' ? 'dream.ts' : `dream.${connectionName}.ts`;
+}

package/dist/esm/src/db/helpers/syncDbTypesFiles.js

@@ -1,14 +1,10 @@
-import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 import { CliFileWriter } from '../../cli/CliFileWriter.js';
 import DreamCLI from '../../cli/index.js';
 import colorize from '../../cli/logger/loggable/colorize.js';
 import DreamApp from '../../dream-app/index.js';
-import autogeneratedFileDisclaimer from '../../helpers/cli/autoGeneratedFileDisclaimer.js';
-import compact from '../../helpers/compact.js';
-import EnvInternal from '../../helpers/EnvInternal.js';
+import ASTKyselyCodegenEnhancer from '../../helpers/cli/ASTKyselyCodegenEnhancer.js';
 import dreamPath from '../../helpers/path/dreamPath.js';
-import snakeify from '../../helpers/snakeify.js';
 import sspawn from '../../helpers/sspawn.js';
 import dbTypesFilenameForConnection from './dbTypesFilenameForConnection.js';
 export default async function syncDbTypesFiles(connectionName) {
@@ -26,88 +22,5 @@ export default async function syncDbTypesFiles(connectionName) {
             });
         },
     });
-    // intentionally bypassing helpers here, since they often end up referencing
-    // from the dist folder, whereas dirname here is pointing to true src folder.
-    const file = (await fs.readFile(absoluteDbSyncPath)).toString();
-    const enhancedSchema = enhanceSchema(file);
-    await CliFileWriter.write(absoluteDbSyncPath, enhancedSchema);
-}
-// begin: schema helpers
-function enhanceSchema(file) {
-    file = removeUnwantedExports(file);
-    file = replaceInt8Type(file);
-    file = replaceJsonType(file);
-    const interfaces = file.split(/export interface /g);
-    const results = interfaces.slice(1, interfaces.length);
-    const dbInterface = results.find(str => /^DB \{/.test(str));
-    const camelDbInterface = camelcasify(dbInterface);
-    file = camelcasify(file);
-    file = file.replace(camelDbInterface, dbInterface);
-    file = addCustomImports(file);
-    const transformedNames = compact(results.map(result => transformName(result)));
-    const fileWithCoercedTypes = exportedEnumTypesToExportedTypeValues(file);
-    // BEGIN FILE CONTENTS BUILDING
-    const newFileContents = `${fileWithCoercedTypes}
-
-export class DBClass {
-  ${transformedNames
-        .map(name => `${snakeify(name)}: ${name}`)
-        .sort()
-        .join('\n  ')}
-}
-`;
-    const sortedFileContents = alphaSortInterfaceProperties(newFileContents);
-    return sortedFileContents;
-}
-function removeUnwantedExports(file) {
-    return file.replace(/\nexport type Timestamp = ColumnType<.*/, `export type Timestamp = ColumnType<DateTime | CalendarDate>`);
-}
-function addCustomImports(file) {
-    const customImports = EnvInternal.boolean('DREAM_CORE_DEVELOPMENT')
-        ? "import type CalendarDate from '../../src/helpers/CalendarDate.js'\nimport { type DateTime } from '../../src/helpers/DateTime.js'"
-        : "import { type CalendarDate, type DateTime } from '@rvoh/dream'";
-    return `${autogeneratedFileDisclaimer()}${customImports}
-${file}`;
-}
-function replaceInt8Type(str) {
-    return str.replace('export type Int8 = ColumnType<string, bigint | number | string>', 'export type Int8 = ColumnType<string, bigint | number | string, bigint | number | string>');
-}
-function replaceJsonType(str) {
-    return str.replace('export type Json = ColumnType<JsonValue, string, string>', 'export type Json = ColumnType<JsonValue, string | JsonValue, string | JsonValue>');
-}
-function camelcasify(str) {
-    return _camelcasify(str);
-}
-function _camelcasify(str) {
-    const camelString = str.replace(/([( .])([a-z][a-zA-Z0-9]*)_([a-z0-9])([a-z0-9]*)/g, (match, p1, p2, p3, p4) => `${p1}${p2}${p3.toUpperCase()}${p4}`);
-    return camelString === str ? camelString : _camelcasify(camelString);
-}
-function alphaSortInterfaceProperties(str) {
-    return str.replace(/(export interface [^\n{]+){\n([^}]+)\n}/g, (_match, interfaceDeclaration, lines) => {
-        const props = lines.split(/\n/);
-        return `${interfaceDeclaration}{
-${props.sort().join('\n')}
-}`;
-    });
-}
-function exportedEnumTypesToExportedTypeValues(str) {
-    const ommitedTypes = ['Generated<T>', 'Json', 'JsonArray', 'JsonObject', 'JsonPrimitive', 'JsonValue'];
-    return str.replace(/export type ([^=]*) = ((?!ColumnType)[^;\n]*);/g, (_match, typeDeclaration, types) => {
-        const originalType = `export type ${typeDeclaration} = ${types};`;
-        if (ommitedTypes.some(type => type === typeDeclaration)) {
-            return originalType;
-        }
-        return `\
-${originalType}
-export const ${typeDeclaration}Values = [
-  ${types.split(' | ').join(',\n  ')}
-] as const
-`;
-    });
-}
-function transformName(str) {
-    const name = str.split(' {')[0]?.replace(/\s/g, '');
-    if (name === undefined || name === 'DB')
-        return null;
-    return name;
+    await new ASTKyselyCodegenEnhancer(connectionName).enhance();
 }

package/dist/esm/src/dream/QueryDriver/Base.js

@@ -90,7 +90,7 @@ export default class QueryDriverBase {
      *    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()`,
+     *    one. This is normally done using the ASTSchemaBuilder
      *    but this will likely need to be overridden to tailor to your custom
      *    database engine.
      */
@@ -172,7 +172,7 @@ export default class QueryDriverBase {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     tableName, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    associationData) {
+    allTableAssociationData) {
         throw new Error('implement getColumnData in child class');
     }
     static serializeDbType(type, val) {

package/dist/esm/src/dream/QueryDriver/Kysely.js

@@ -34,8 +34,9 @@ import NotNullViolation from '../../errors/db/NotNullViolation.js';
 import UnexpectedUndefined from '../../errors/UnexpectedUndefined.js';
 import CalendarDate from '../../helpers/CalendarDate.js';
 import camelize from '../../helpers/camelize.js';
+import ASTGlobalSchemaBuilder from '../../helpers/cli/ASTGlobalSchemaBuilder.js';
+import ASTSchemaBuilder from '../../helpers/cli/ASTSchemaBuilder.js';
 import generateMigration from '../../helpers/cli/generateMigration.js';
-import SchemaBuilder from '../../helpers/cli/SchemaBuilder.js';
 import compact from '../../helpers/compact.js';
 import { DateTime } from '../../helpers/DateTime.js';
 import EnvInternal from '../../helpers/EnvInternal.js';
@@ -158,31 +159,20 @@ export default class KyselyQueryDriver extends QueryDriverBase {
     /**
      * 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 async sync(connectionName, onSync, options = {}) {
         try {
             if (!options?.schemaOnly) {
                 await DreamCLI.logger.logProgress(`introspecting db for connection: ${connectionName}...`, async () => {
+                    // this calls kysely-codegen under the hood
                     await syncDbTypesFiles(connectionName);
                 });
             }
-            const schemaBuilder = new SchemaBuilder(connectionName);
+            const newSchemaBuilder = new ASTSchemaBuilder(connectionName);
             await DreamCLI.logger.logProgress(`building dream schema for connection ${connectionName}...`, async () => {
-                await schemaBuilder.build();
+                await newSchemaBuilder.build();
             });
-            if (schemaBuilder.hasForeignKeyError && !options?.schemaOnly) {
+            if (newSchemaBuilder.hasForeignKeyError && !options?.schemaOnly) {
                 await DreamCLI.logger.logProgress('triggering resync to correct for foreign key errors...', async () => {
                     // TODO: make this customizable to enable dream apps to separate
                     const cliCmd = EnvInternal.boolean('DREAM_CORE_DEVELOPMENT') ? 'dream' : 'psy';
@@ -196,7 +186,7 @@ export default class KyselyQueryDriver extends QueryDriverBase {
                     });
                 });
             }
-            await SchemaBuilder.buildGlobalTypes();
+            await new ASTGlobalSchemaBuilder().build();
             if (!options?.schemaOnly) {
                 // intentionally leaving logs off here, since it allows other
                 // onSync handlers to determine their own independent logging approach
@@ -205,7 +195,7 @@ export default class KyselyQueryDriver extends QueryDriverBase {
         }
         catch (error) {
             console.error(error);
-            await DreamCLI.logger.logProgress('sync failed, reverting file contents...', async () => {
+            await DreamCLI.logger.logProgress('[dream] sync failed, reverting file contents...', async () => {
                 await CliFileWriter.revert();
             });
         }

package/dist/esm/src/dream/QueryDriver/Postgres.js

@@ -111,7 +111,7 @@ export default class PostgresQueryDriver extends KyselyQueryDriver {
      * this is used by the SchemaBuilder to store column data permanently
      * within the types/dream.ts file.
      */
-    static async getColumnData(connectionName, tableName, associationData) {
+    static async getColumnData(connectionName, tableName, allTableAssociationData) {
         const db = this.dbFor(connectionName, 'primary');
         const sqlQuery = sql `SELECT column_name, udt_name::regtype, is_nullable, data_type FROM information_schema.columns WHERE table_name = ${tableName}`;
         const columnToDBTypeMap = await sqlQuery.execute(db);
@@ -120,7 +120,7 @@ export default class PostgresQueryDriver extends KyselyQueryDriver {
         rows.forEach(row => {
             const isEnum = ['USER-DEFINED', 'ARRAY'].includes(row.dataType) && !isPrimitiveDataType(row.udtName);
             const isArray = ['ARRAY'].includes(row.dataType);
-            const associationMetadata = associationData[row.columnName];
+            const associationMetadata = allTableAssociationData[row.columnName];
             columnData[camelize(row.columnName)] = {
                 dbType: row.udtName,
                 allowNull: row.isNullable === 'YES',

package/dist/esm/src/dream-app/index.js

@@ -6,6 +6,7 @@ import Encrypt from '../encrypt/index.js';
 import DreamAppInitMissingCallToLoadModels from '../errors/dream-app/DreamAppInitMissingCallToLoadModels.js';
 import DreamAppInitMissingMissingProjectRoot from '../errors/dream-app/DreamAppInitMissingMissingProjectRoot.js';
 import CalendarDate from '../helpers/CalendarDate.js';
+import autogeneratedFileDisclaimer from '../helpers/cli/autoGeneratedFileDisclaimer.js';
 import { DateTime, Settings } from '../helpers/DateTime.js';
 import EnvInternal from '../helpers/EnvInternal.js';
 import globalClassNameFromFullyQualifiedModelName from '../helpers/globalClassNameFromFullyQualifiedModelName.js';
@@ -92,6 +93,7 @@ export default class DreamApp {
             inferSerializersFromDreamClassOrViewModelClass,
             isDreamSerializer,
             serializerNameFromFullyQualifiedModelName,
+            autogeneratedFileDisclaimer,
         };
     }
     /**
@@ -233,6 +235,16 @@ Try setting it to something valid, like:
     get importExtension() {
         return this._importExtension;
     }
+    /**
+     * if set to true, it will bypass deprecation checks that run
+     * during the sync hook. Defaults to false, we only recommend
+     * overriding this if you are having issues with the deprecation
+     * check.
+     */
+    _bypassDeprecationChecks = false;
+    get bypassDeprecationChecks() {
+        return this._bypassDeprecationChecks;
+    }
     loadedModels = false;
     constructor(opts) {
         if (opts?.db)
@@ -317,6 +329,9 @@ Try setting it to something valid, like:
     }
     set(applyOption, options, secondaryOptions) {
         switch (applyOption) {
+            case 'bypassDeprecationChecks':
+                this._bypassDeprecationChecks = options;
+                break;
             case 'db':
                 if (typeof options === 'string') {
                     this._dbCredentials[options] = secondaryOptions;