@rvoh/dream 2.0.4 → 2.1.2

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

@@ -0,0 +1,236 @@
+import ts from 'typescript';
+import { CliFileWriter } from '../../cli/CliFileWriter.js';
+import camelize from '../camelize.js';
+import ASTConnectionBuilder from './ASTConnectionBuilder.js';
+import autogeneratedFileDisclaimer from './autoGeneratedFileDisclaimer.js';
+const f = ts.factory;
+/**
+ * Responsible for enhancing the kysely-codegen output, which can be found at
+ * types/db.ts. If you are leveraging multiple db connections,
+ * then this file will also be responsible for building all variants,
+ * i.e. types/db.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 ASTKyselyCodegenEnhancer extends ASTConnectionBuilder {
+    /**
+     * enhances the kysely codegen output for the given connection name
+     * by reading the relevant db.ts file into AST nodes, then enhancing them
+     * with a variety of transformations necessary to lock this file in with
+     * our other schema files, allowing types to flow correctly throughout the app.
+     */
+    async enhance() {
+        let dbSourceFile = await this.getDbSourceFile();
+        dbSourceFile = this.camelizeKeys(dbSourceFile);
+        dbSourceFile = this.replaceTimestampExport(dbSourceFile);
+        dbSourceFile = this.addMissingImports(dbSourceFile);
+        dbSourceFile = this.replaceInt8Export(dbSourceFile);
+        dbSourceFile = this.sortExportedInterfacesTransformer(dbSourceFile);
+        dbSourceFile = await this.addEnumValueExports(dbSourceFile);
+        dbSourceFile = this.addDeprecatedDbClassExportForBackwardsCompatibility(dbSourceFile);
+        const output = this.printOutput(dbSourceFile);
+        const finalOutput = await this.prettier(`\
+${autogeneratedFileDisclaimer()}
+${output}`);
+        await CliFileWriter.write(this.dbPath(), finalOutput);
+    }
+    addDeprecatedDbClassExportForBackwardsCompatibility(dbSourceFile) {
+        const transformer = () => {
+            return sourceFile => {
+                const dbInterface = this.findDbExport(sourceFile, 'DB');
+                if (!dbInterface)
+                    return sourceFile;
+                const classDec = ts.factory.createClassDeclaration([ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)], ts.factory.createIdentifier('DBClass'), undefined, [], dbInterface.members.filter(ts.isPropertySignature).map(propertySignature => {
+                    return f.createPropertyDeclaration([], propertySignature.name, undefined, propertySignature.type, undefined);
+                }));
+                return ts.factory.updateSourceFile(sourceFile, [...sourceFile.statements, classDec], sourceFile.isDeclarationFile, sourceFile.referencedFiles, sourceFile.typeReferenceDirectives, undefined);
+            };
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
+    /**
+     * @internal
+     *
+     * returns the output of the provided dbSourceFile, ensuring that all exports
+     * have a new line above them.
+     */
+    printOutput(dbSourceFile) {
+        const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
+        const output = printer.printNode(ts.EmitHint.SourceFile, dbSourceFile, dbSourceFile);
+        return output.replace(/export /g, '\nexport ');
+    }
+    /**
+     * @internal
+     *
+     * ensures that the `Timestamp` exported from db.ts points correctly to either
+     * the DateTime or CalendarDate class, depending on the db type.
+     */
+    replaceTimestampExport(dbSourceFile) {
+        const transformer = context => {
+            return rootNode => {
+                const visit = (node) => {
+                    const typeAlias = this.exportedTypeAliasOrNull(node, 'Timestamp');
+                    if (typeAlias) {
+                        const updatedNode = f.updateTypeAliasDeclaration(typeAlias, typeAlias.modifiers, typeAlias.name, typeAlias.typeParameters, f.createTypeReferenceNode('ColumnType', [
+                            f.createUnionTypeNode([
+                                f.createTypeReferenceNode(f.createIdentifier('DateTime')),
+                                f.createTypeReferenceNode(f.createIdentifier('CalendarDate')),
+                            ]),
+                        ]));
+                        return updatedNode;
+                    }
+                    return ts.visitEachChild(node, visit, context);
+                };
+                return ts.visitNode(rootNode, visit);
+            };
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
+    /**
+     * @internal
+     *
+     * massages the `Int8` exported from db.ts to make it more flexible
+     */
+    replaceInt8Export(dbSourceFile) {
+        const transformer = context => {
+            return rootNode => {
+                const visit = (node) => {
+                    const typeAlias = this.exportedTypeAliasOrNull(node, 'Int8');
+                    if (typeAlias) {
+                        return f.updateTypeAliasDeclaration(typeAlias, typeAlias.modifiers, typeAlias.name, typeAlias.typeParameters, f.createTypeReferenceNode('ColumnType', [
+                            f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+                            f.createUnionTypeNode([
+                                f.createKeywordTypeNode(ts.SyntaxKind.BigIntKeyword),
+                                f.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
+                                f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+                            ]),
+                            f.createUnionTypeNode([
+                                f.createKeywordTypeNode(ts.SyntaxKind.BigIntKeyword),
+                                f.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
+                                f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+                            ]),
+                        ]));
+                    }
+                    return ts.visitEachChild(node, visit, context);
+                };
+                return ts.visitNode(rootNode, visit);
+            };
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
+    /**
+     * @internal
+     *
+     * injects missing CalendarDate and DateTime imports from dream
+     */
+    addMissingImports(dbSourceFile) {
+        const transformer = () => {
+            return (sourceFile) => f.updateSourceFile(sourceFile, [...this.dateAndDateTimeImports(), ...sourceFile.statements]);
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
+    /**
+     * @internal
+     *
+     * sorts all exported interfaces and puts them above the DB interface
+     */
+    sortExportedInterfacesTransformer(dbSourceFile) {
+        const transformer = () => {
+            return (sourceFile) => {
+                const sortedInterfaceStatements = [];
+                const finalInterfaceStatements = [];
+                const otherStatements = [];
+                sourceFile.statements.forEach(statement => {
+                    if (ts.isInterfaceDeclaration(statement) &&
+                        statement.modifiers?.some(m => m.kind === ts.SyntaxKind.ExportKeyword)) {
+                        if (statement.name.text !== 'DB') {
+                            sortedInterfaceStatements.push(statement);
+                        }
+                        else {
+                            finalInterfaceStatements.push(statement);
+                        }
+                    }
+                    else {
+                        otherStatements.push(statement);
+                    }
+                });
+                sortedInterfaceStatements.sort((a, b) => a.name.text.localeCompare(b.name.text));
+                return f.updateSourceFile(sourceFile, [...otherStatements, ...sortedInterfaceStatements, ...finalInterfaceStatements], sourceFile.isDeclarationFile, sourceFile.referencedFiles);
+            };
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
+    /**
+     * @internal
+     *
+     * camelizes the keys on all interfaces except the DB interface
+     * (since the DB interface is indexed by table name, which must not be camelized)
+     */
+    camelizeKeys(dbSourceFile) {
+        // @ts-expect-error cannot lock this type down, though implementation is correct
+        const transformer = context => {
+            const visit = node => {
+                const interfaceNode = this.exportedInterfaceOrNull(node);
+                if (interfaceNode &&
+                    !['DB'].includes(interfaceNode.name.text) // Check exclusion list
+                ) {
+                    const updatedMembers = interfaceNode.members.map(member => {
+                        if (ts.isPropertySignature(member) && ts.isIdentifier(member.name)) {
+                            const camelizedKey = camelize(member.name.text);
+                            if (member.name.text !== camelizedKey) {
+                                return f.updatePropertySignature(member, member.modifiers, f.createIdentifier(camelizedKey), member.questionToken, member.type);
+                            }
+                        }
+                        return member;
+                    });
+                    return f.updateInterfaceDeclaration(interfaceNode, interfaceNode.modifiers, interfaceNode.name, interfaceNode.typeParameters, interfaceNode.heritageClauses, updatedMembers);
+                }
+                return ts.visitEachChild(node, visit, context);
+            };
+            return node => ts.visitNode(node, visit);
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
+    /**
+     * @internal
+     *
+     * for each found enum in the app (i.e. LocalizedTextsEnum), this will also
+     * inject below it a `LocalizedTextsEnumValues` const, which can be used
+     * at runtime to grab the actual enum values.
+     */
+    async addEnumValueExports(dbSourceFile) {
+        const enums = await this.getAllEnumValueNames();
+        const enumTypes = enums.map(e => e.enumType);
+        // @ts-expect-error cannot lock this type down, though implementation is correct
+        const transformer = context => {
+            const visit = (node) => {
+                const typeAlias = this.exportedTypeAliasOrNull(node);
+                const isEnum = typeAlias ? enumTypes.includes(typeAlias.name.text) : false;
+                if (typeAlias && isEnum) {
+                    const literals = this.extractStringLiteralTypeNodesFromTypeOrUnion(typeAlias).map(node => node.literal.text);
+                    if (literals.length > 0) {
+                        return [
+                            typeAlias,
+                            f.createVariableStatement([f.createModifier(ts.SyntaxKind.ExportKeyword)], f.createVariableDeclarationList([
+                                f.createVariableDeclaration(f.createIdentifier(`${typeAlias.name.text}Values`), undefined, undefined, f.createAsExpression(f.createArrayLiteralExpression(literals.map(literal => f.createStringLiteral(literal)), true // multiLine
+                                ), f.createKeywordTypeNode(ts.SyntaxKind.ConstKeyword))),
+                            ], ts.NodeFlags.Const)),
+                        ];
+                    }
+                }
+                return ts.visitEachChild(node, visit, context);
+            };
+            return node => ts.visitNode(node, visit);
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[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/cjs/src/helpers/cli/generateDreamContent.js

@@ -94,11 +94,12 @@ export function processAttribute(attribute, modelClassName) {
     if (!attributeType) {
         throw new Error(`must pass a column type for ${attributeName} (i.e. ${attributeName}:string)`);
     }
-    switch (attributeType) {
-        case 'belongs_to':
+    const processedAttrType = camelize(attributeType).toLowerCase();
+    switch (processedAttrType) {
+        case 'belongsto':
             return createBelongsToAttribute(attributeName, descriptors, modelClassName);
-        case 'has_one':
-        case 'has_many':
+        case 'hasone':
+        case 'hasmany':
             return { content: '', imports: [] };
         case 'encrypted':
             return createEncryptedAttribute(attributeName, attribute, modelClassName);

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

@@ -30,8 +30,9 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
             continue;
         if (!attributeType)
             throw new Error(`Must pass a column type for ${attributeName} (i.e. ${attributeName}:string)`);
-        switch (attributeType) {
-            case 'belongs_to': {
+        const safeAttributeType = camelize(attributeType)?.toLowerCase();
+        switch (safeAttributeType) {
+            case 'belongsto': {
                 const attributeVariable = camelize(attributeName.split('/').pop());
                 const fullyQualifiedAssociatedModelName = standardizeFullyQualifiedModelName(attributeName);
                 const associationModelName = globalClassNameFromFullyQualifiedModelName(fullyQualifiedAssociatedModelName);