@rvoh/dream 2.36.0 → 2.37.0

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

@@ -1,380 +0,0 @@
-import ts from 'typescript';
-import { CliFileWriter } from '../../cli/CliFileWriter.js';
-import camelize from '../camelize.js';
-import snakeify from '../snakeify.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.removeIgnoredColumns(dbSourceFile);
-        dbSourceFile = this.replaceTimestampExport(dbSourceFile);
-        dbSourceFile = await this.replaceTimeFieldsInInterfaces(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
-     *
-     * Replaces string types with TimeWithZone or TimeWithoutZone for TIME columns
-     * based on the schema metadata from dream.ts
-     */
-    async replaceTimeFieldsInInterfaces(dbSourceFile) {
-        const schemaData = await this.getSchemaData();
-        const transformer = context => {
-            return sourceFile => {
-                const visitor = (node) => {
-                    if (ts.isInterfaceDeclaration(node) && node.name.text !== 'DB') {
-                        const tableName = snakeify(node.name.text);
-                        const tableSchema = schemaData[tableName];
-                        if (!tableSchema) {
-                            return ts.visitEachChild(node, visitor, context);
-                        }
-                        const updatedMembers = node.members.map(member => {
-                            if (ts.isPropertySignature(member) && ts.isIdentifier(member.name)) {
-                                const columnName = member.name.text;
-                                const columnSchema = tableSchema.columns[columnName];
-                                if (!columnSchema)
-                                    return member;
-                                const dbType = columnSchema.dbType;
-                                // Check if this is a TIME field that's currently typed as string
-                                if (this.isTimeDbType(dbType) && member.type) {
-                                    const isTimeTz = this.isTimeWithTimeZoneDbType(dbType);
-                                    const newType = this.replaceStringWithClockTimeType(member.type, sourceFile, isTimeTz);
-                                    if (newType !== member.type) {
-                                        return f.updatePropertySignature(member, member.modifiers, member.name, member.questionToken, newType);
-                                    }
-                                }
-                            }
-                            return member;
-                        });
-                        return f.updateInterfaceDeclaration(node, node.modifiers, node.name, node.typeParameters, node.heritageClauses, updatedMembers);
-                    }
-                    return ts.visitEachChild(node, visitor, context);
-                };
-                return ts.visitNode(sourceFile, visitor);
-            };
-        };
-        const result = ts.transform(dbSourceFile, [transformer]);
-        return result.transformed[0];
-    }
-    /**
-     * @internal
-     *
-     * Helper to replace string type references with ClockTime or ClockTimeTz type references
-     */
-    replaceStringWithClockTimeType(typeNode, sourceFile, isTimeTz) {
-        const toTimeType = () => f.createTypeReferenceNode(f.createIdentifier(isTimeTz ? 'ClockTimeTz' : 'ClockTime'));
-        // Handle union types (e.g., string | null)
-        if (ts.isUnionTypeNode(typeNode)) {
-            const updatedTypes = typeNode.types.map(t => this.replaceStringWithClockTimeType(t, sourceFile, isTimeTz));
-            return f.createUnionTypeNode(updatedTypes);
-        }
-        // Handle array syntax (e.g., string[])
-        if (ts.isArrayTypeNode(typeNode)) {
-            const elementType = this.isStringLikeType(typeNode.elementType, sourceFile)
-                ? toTimeType()
-                : this.replaceStringWithClockTimeType(typeNode.elementType, sourceFile, isTimeTz);
-            return f.createArrayTypeNode(elementType);
-        }
-        // Handle generic array syntax (e.g., Array<string>)
-        if (ts.isTypeReferenceNode(typeNode) &&
-            typeNode.typeName.getText(sourceFile) === 'Array' &&
-            typeNode.typeArguments?.length === 1) {
-            const arg = typeNode.typeArguments?.[0];
-            if (!arg)
-                return typeNode;
-            const nextArg = this.isStringLikeType(arg, sourceFile)
-                ? toTimeType()
-                : this.replaceStringWithClockTimeType(arg, sourceFile, isTimeTz);
-            return f.createTypeReferenceNode(f.createIdentifier('Array'), [nextArg]);
-        }
-        // Handle direct string type
-        if (this.isStringLikeType(typeNode, sourceFile)) {
-            return toTimeType();
-        }
-        return typeNode;
-    }
-    /**
-     * @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
-     *
-     * removes columns declared in model `ignoredColumns` getters from the
-     * table interfaces generated by kysely-codegen. This is what removes
-     * ignored columns from the generated db types file: every column-name
-     * level type (`DreamColumnNames`, `UpdateableProperties`, where-clause
-     * statements) derives from the Kysely `DB` interface, so filtering here
-     * turns any remaining code reference to an ignored column into a type
-     * error. Runs after camelizeKeys so that member names align with the
-     * camelCase column names models declare in ignoredColumns.
-     */
-    removeIgnoredColumns(dbSourceFile) {
-        const dbInterface = this.findDbExport(dbSourceFile, 'DB');
-        if (!dbInterface)
-            return dbSourceFile;
-        // the DB interface maps table names to table interfaces (e.g.
-        // `collars: Collars`), so it provides the table name each table
-        // interface corresponds to
-        const ignoredColumnsByInterfaceName = {};
-        dbInterface.members.forEach(member => {
-            if (!ts.isPropertySignature(member))
-                return;
-            if (!member.type || !ts.isTypeReferenceNode(member.type))
-                return;
-            if (!ts.isIdentifier(member.type.typeName))
-                return;
-            const tableName = ts.isIdentifier(member.name)
-                ? member.name.text
-                : ts.isStringLiteral(member.name)
-                    ? member.name.text
-                    : null;
-            if (!tableName)
-                return;
-            const ignoredColumns = this.ignoredColumnsForTable(tableName);
-            if (ignoredColumns.size)
-                ignoredColumnsByInterfaceName[member.type.typeName.text] = ignoredColumns;
-        });
-        if (!Object.keys(ignoredColumnsByInterfaceName).length)
-            return dbSourceFile;
-        // @ts-expect-error cannot lock this type down, though implementation is correct
-        const transformer = context => {
-            const visit = node => {
-                const interfaceNode = this.exportedInterfaceOrNull(node);
-                const ignoredColumns = interfaceNode
-                    ? ignoredColumnsByInterfaceName[interfaceNode.name.text]
-                    : undefined;
-                if (interfaceNode && ignoredColumns) {
-                    return f.updateInterfaceDeclaration(interfaceNode, interfaceNode.modifiers, interfaceNode.name, interfaceNode.typeParameters, interfaceNode.heritageClauses, interfaceNode.members.filter(member => !(ts.isPropertySignature(member) &&
-                        (ts.isIdentifier(member.name) || ts.isStringLiteral(member.name)) &&
-                        ignoredColumns.has(member.name.text))));
-                }
-                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/types/src/db/helpers/syncDbTypesFiles.d.ts

@@ -1 +0,0 @@
-export default function syncDbTypesFiles(connectionName: string): Promise<void>;

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

@@ -1,94 +0,0 @@
-import ASTConnectionBuilder from './ASTConnectionBuilder.js';
-/**
- * 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.
-     */
-    enhance(): Promise<void>;
-    private addDeprecatedDbClassExportForBackwardsCompatibility;
-    /**
-     * @internal
-     *
-     * returns the output of the provided dbSourceFile, ensuring that all exports
-     * have a new line above them.
-     */
-    private printOutput;
-    /**
-     * @internal
-     *
-     * ensures that the `Timestamp` exported from db.ts points correctly to either
-     * the DateTime or CalendarDate class, depending on the db type.
-     */
-    private replaceTimestampExport;
-    /**
-     * @internal
-     *
-     * Replaces string types with TimeWithZone or TimeWithoutZone for TIME columns
-     * based on the schema metadata from dream.ts
-     */
-    private replaceTimeFieldsInInterfaces;
-    /**
-     * @internal
-     *
-     * Helper to replace string type references with ClockTime or ClockTimeTz type references
-     */
-    private replaceStringWithClockTimeType;
-    /**
-     * @internal
-     *
-     * massages the `Int8` exported from db.ts to make it more flexible
-     */
-    private replaceInt8Export;
-    /**
-     * @internal
-     *
-     * injects missing CalendarDate and DateTime imports from dream
-     */
-    private addMissingImports;
-    /**
-     * @internal
-     *
-     * sorts all exported interfaces and puts them above the DB interface
-     */
-    private sortExportedInterfacesTransformer;
-    /**
-     * @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)
-     */
-    private camelizeKeys;
-    /**
-     * @internal
-     *
-     * removes columns declared in model `ignoredColumns` getters from the
-     * table interfaces generated by kysely-codegen. This is what removes
-     * ignored columns from the generated db types file: every column-name
-     * level type (`DreamColumnNames`, `UpdateableProperties`, where-clause
-     * statements) derives from the Kysely `DB` interface, so filtering here
-     * turns any remaining code reference to an ignored column into a type
-     * error. Runs after camelizeKeys so that member names align with the
-     * camelCase column names models declare in ignoredColumns.
-     */
-    private removeIgnoredColumns;
-    /**
-     * @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.
-     */
-    private addEnumValueExports;
-}