@rvoh/dream 2.0.4 → 2.1.0

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

@@ -0,0 +1,277 @@
+import * as path from 'node:path';
+import ts from 'typescript';
+import DreamApp from '../../dream-app/index.js';
+import EnvInternal from '../EnvInternal.js';
+const f = ts.factory;
+/**
+ * @internal
+ *
+ * This is a base class, which is inherited by the ASTSchemaBuilder,
+ * the ASTKyselyCodegenEnhancer, and the ASTGlobalSchemaBuilder,
+ * each of which is responsible for building up the output of the various
+ * type files consumed by dream internally.
+ *
+ * This base class is just a container for common methods used by all
+ * classes.
+ */
+export default class ASTBuilder {
+    /**
+     * @internal
+     *
+     * builds a new line, useful for injecting new lines into AST statements
+     */
+    newLine() {
+        return f.createIdentifier('\n');
+    }
+    /**
+     * @internal
+     *
+     * given an interface declaration, it will extrace the relevant property statement
+     * by the given property name.
+     */
+    getPropertyFromInterface(interfaceNode, propertyName) {
+        for (const member of interfaceNode.members) {
+            if (ts.isPropertySignature(member)) {
+                if (ts.isIdentifier(member.name) && member.name.text === propertyName) {
+                    return member;
+                }
+            }
+        }
+        return null;
+    }
+    /**
+     * @internal
+     *
+     * returns an array of string type literals which were extracted from
+     * either a type or type union, depending on what is provided
+     * for the typeAlias. this allows you to safely and easily collect
+     * an array of types given an alias
+     */
+    extractStringLiteralTypeNodesFromTypeOrUnion(typeAlias) {
+        const literals = [];
+        if (ts.isUnionTypeNode(typeAlias.type)) {
+            typeAlias.type.types.forEach(typeNode => {
+                if (ts.isLiteralTypeNode(typeNode) && ts.isStringLiteral(typeNode.literal)) {
+                    literals.push(typeNode);
+                }
+            });
+        }
+        else if (ts.isLiteralTypeNode(typeAlias.type) && ts.isStringLiteral(typeAlias.type.literal)) {
+            literals.push(typeAlias.type);
+        }
+        return literals;
+    }
+    /**
+     * @internal
+     *
+     * returns an array of type literals which were extracted from
+     * either a type or type union, depending on what is provided
+     * for the typeAlias. this allows you to safely and easily collect
+     * an array of types given an alias
+     */
+    extractTypeNodesFromTypeOrUnion(typeAlias) {
+        const literals = [];
+        if (typeAlias.type && ts.isUnionTypeNode(typeAlias.type)) {
+            typeAlias.type.types.forEach(typeNode => {
+                literals.push(typeNode);
+            });
+        }
+        else if (typeAlias.type) {
+            literals.push(typeAlias.type);
+        }
+        return literals;
+    }
+    /**
+     * @internal
+     *
+     * returns the provided node iff
+     *   a.) the node is an exported type alias
+     *   b.) the exported name matches the provided name (or else there was no name provided)
+     *
+     *  otherwise, returns null
+     */
+    exportedTypeAliasOrNull(node, exportName) {
+        if (ts.isTypeAliasDeclaration(node) &&
+            node?.modifiers?.some(m => m.kind === ts.SyntaxKind.ExportKeyword) &&
+            (!exportName ? true : node.name.text === exportName))
+            return node;
+        return null;
+    }
+    /**
+     * @internal
+     *
+     * returns the provided node iff
+     *   a.) the node is an exported interface
+     *   b.) the exported name matches the provided name (or else there was no name provided)
+     *
+     *  otherwise, returns null
+     */
+    exportedInterfaceOrNull(node, exportName) {
+        if (ts.isInterfaceDeclaration(node) &&
+            node?.modifiers?.some(m => m.kind === ts.SyntaxKind.ExportKeyword) &&
+            (!exportName ? true : node.name.text === exportName))
+            return node;
+        return null;
+    }
+    /**
+     * @internal
+     *
+     * extracts the exportName from the provided dbSourceFile
+     */
+    findDbExport(dbSourceFile, exportName) {
+        let foundNode;
+        ts.forEachChild(dbSourceFile, node => {
+            const hasModifiers = ts.isFunctionDeclaration(node) ||
+                ts.isClassDeclaration(node) ||
+                ts.isInterfaceDeclaration(node) ||
+                ts.isVariableStatement(node) ||
+                ts.isTypeAliasDeclaration(node);
+            if (hasModifiers) {
+                const isExported = node.modifiers?.some(modifier => modifier.kind === ts.SyntaxKind.ExportKeyword);
+                if (isExported && ts.isVariableStatement(node)) {
+                    const declarations = node.declarationList.declarations;
+                    const name = declarations?.[0]?.name;
+                    if (declarations.length > 0 && ts.isIdentifier(name) && name?.text === exportName) {
+                        foundNode = node;
+                        return true; // Stop traversal
+                    }
+                }
+                const declarationWithName = node;
+                if (isExported &&
+                    declarationWithName.name &&
+                    ts.isIdentifier(declarationWithName.name) &&
+                    declarationWithName.name.text === exportName) {
+                    foundNode = node;
+                    return true; // Stop traversal
+                }
+            }
+        });
+        return foundNode;
+    }
+    /**
+     * @internal
+     *
+     * returns the path to the dream.globals.ts file
+     */
+    globalSchemaPath() {
+        const dreamApp = DreamApp.getOrFail();
+        return path.join(dreamApp.projectRoot, dreamApp.paths.types, 'dream.globals.ts');
+    }
+    /**
+     * @internal
+     *
+     * safely runs prettier against the provided output. If prettier
+     * is not installed, then the original output is returned
+     */
+    async prettier(output) {
+        try {
+            // dynamically, safely bring in prettier.
+            // ini the event that it fails, we will return the
+            // original output, unformatted, since prettier
+            // is technically not a real dependency of dream,
+            // though psychic and dream apps are provisioned
+            // with prettier by default, so this should usually work
+            const prettier = (await import('prettier')).default;
+            const results = await prettier.format(output, {
+                parser: 'typescript',
+                semi: false,
+                singleQuote: true,
+                tabWidth: 2,
+                lineWidth: 80,
+            });
+            return typeof results === 'string' ? results : output;
+        }
+        catch {
+            // intentional noop, we don't want to raise if prettier
+            // fails, since it is possible for the end user to not
+            // want to use prettier, and it is not a required peer
+            // dependency of dream
+            return output;
+        }
+    }
+    /**
+     * @internal
+     *
+     * given a type node, it will send back the first found generic
+     * provided to that type.
+     */
+    getFirstGenericType(node) {
+        if (ts.isTypeReferenceNode(node)) {
+            if (node.typeArguments && node.typeArguments.length > 0) {
+                return node.typeArguments[0];
+            }
+        }
+        else if (ts.isCallExpression(node)) {
+            if (node.typeArguments && node.typeArguments.length > 0) {
+                return node.typeArguments[0];
+            }
+        }
+        return null;
+    }
+    /**
+     * @internal
+     *
+     * returns the DateTime and CalendarDate imports. This is fairly
+     * tricky, since it considers whether or not we are in the dream
+     * internals (i.e. when testing dream). If we are, it will return
+     * valid internal import paths to those files. Otherwise, it will
+     * import them both from @rvoh/dream.
+     */
+    dateAndDateTimeImports() {
+        if (EnvInternal.boolean('DREAM_CORE_DEVELOPMENT')) {
+            const calendarImport = ts.factory.createImportClause(true, f.createIdentifier('CalendarDate'), undefined);
+            const calendarImportDeclaration = ts.factory.createImportDeclaration(undefined, calendarImport, ts.factory.createStringLiteral('../../src/helpers/CalendarDate.js'));
+            const dateTimeNamedImports = ts.factory.createNamedImports([
+                f.createImportSpecifier(true, undefined, ts.factory.createIdentifier('DateTime')),
+            ]);
+            const dateTimeImportClause = ts.factory.createImportClause(false, // isTypeOnly: false for the clause itself if not all imports are type only
+            undefined, // name: undefined for default import
+            dateTimeNamedImports // namedBindings
+            );
+            const dateTimeImportDeclaration = ts.factory.createImportDeclaration(undefined, dateTimeImportClause, ts.factory.createStringLiteral('../../src/helpers/DateTime.js'));
+            return [calendarImportDeclaration, dateTimeImportDeclaration];
+        }
+        else {
+            const namedImports = ts.factory.createNamedImports(['CalendarDate', 'DateTime'].map(importName => f.createImportSpecifier(true, undefined, ts.factory.createIdentifier(importName))));
+            const importClause = ts.factory.createImportClause(false, // isTypeOnly: false for the clause itself if not all imports are type only
+            undefined, // name: undefined for default import
+            namedImports // namedBindings
+            );
+            const importDeclaration = ts.factory.createImportDeclaration(undefined, // modifiers: e.g., 'export' or 'declare'
+            importClause, ts.factory.createStringLiteral('@rvoh/dream'));
+            return [importDeclaration];
+        }
+    }
+    /**
+     * @internal
+     *
+     * for a given table name (i.e. balloon_lines), it will return the exported
+     * `BalloonLines` interface within the dbSourceFile
+     */
+    getTableInterfaceDeclaration(dbSourceFile, tableName) {
+        const DB = this.findDbExport(dbSourceFile, 'DB');
+        let targetProperty = null;
+        for (const member of DB.members) {
+            if (ts.isPropertySignature(member) && member.name.getText(dbSourceFile) === tableName) {
+                targetProperty = member;
+                break;
+            }
+        }
+        const tableInterfaceName = (targetProperty?.type)
+            .typeName?.escapedText;
+        if (!tableInterfaceName)
+            throw new Error(`failed to find table interface for table: ${tableName}`);
+        const tableInterface = this.findDbExport(dbSourceFile, tableInterfaceName);
+        return tableInterface;
+    }
+    /**
+     * @internal
+     *
+     * returns an array of global names for all serializers in the app
+     */
+    globalSerializerNames() {
+        const dreamApp = DreamApp.getOrFail();
+        const serializers = dreamApp.serializers;
+        return Object.keys(serializers);
+    }
+}

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

@@ -0,0 +1,284 @@
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import ts from 'typescript';
+import dbTypesFilenameForConnection from '../../db/helpers/dbTypesFilenameForConnection.js';
+import dreamSchemaTypesFilenameForConnection from '../../db/helpers/dreamSchemaTypesFilenameForConnection.js';
+import DreamApp from '../../dream-app/index.js';
+import Query from '../../dream/Query.js';
+import { ExplicitForeignKeyRequired, InvalidComputedForeignKey, } from '../../errors/associations/InvalidComputedForeignKey.js';
+import FailedToIdentifyAssociation from '../../errors/schema-builder/FailedToIdentifyAssociation.js';
+import intersection from '../intersection.js';
+import sortBy from '../sortBy.js';
+import uniq from '../uniq.js';
+import ASTBuilder from './ASTBuilder.js';
+/**
+ * @internal
+ *
+ * This is a base class, which is inherited by the ASTSchemaBuilder and
+ * the ASTKyselyCodegenEnhancer, both of which is responsible for building
+ * up the output of the various type files consumed by dream internally.
+ *
+ * This base class is just a container for common methods used by both
+ * classes. It requires a connectionName to be provided, unlike the underlying
+ * ASTBuilder class, and provides methods which leverage the connectionName
+ *
+ */
+export default class ASTConnectionBuilder extends ASTBuilder {
+    connectionName;
+    hasForeignKeyError = false;
+    constructor(connectionName) {
+        super();
+        this.connectionName = connectionName;
+    }
+    /**
+     * @internal
+     *
+     * returns the path from project root to the dream.ts file
+     * for the particular connection. If the connectionName is anything
+     * other than default, the path will represent that by injecting
+     * the connectionName into the file name, i.e. dream.alternate.ts
+     */
+    schemaPath() {
+        const dreamApp = DreamApp.getOrFail();
+        return path.join(dreamApp.projectRoot, dreamApp.paths.types, dreamSchemaTypesFilenameForConnection(this.connectionName));
+    }
+    /**
+     * @internal
+     *
+     * returns the path from project root to the db.ts file
+     * for the particular connection. If the connectionName is anything
+     * other than default, the path will represent that by injecting
+     * the connectionName into the file name, i.e. db.alternate.ts
+     */
+    dbPath() {
+        const dreamApp = DreamApp.getOrFail();
+        return path.join(dreamApp.projectRoot, dreamApp.paths.types, dbTypesFilenameForConnection(this.connectionName));
+    }
+    /**
+     * @internal
+     *
+     * returns the db source file for the given connectionName, injecting
+     * the source file with the actual file contents, so that AST nodes
+     * can be built through ingesting.
+     */
+    async getDbSourceFile() {
+        const fileContent = await this.loadDbSyncFile();
+        return ts.createSourceFile('./db.js', fileContent, ts.ScriptTarget.Latest, true);
+    }
+    /**
+     * @internal
+     *
+     * reads the db source file for the given connection, returning the contents
+     * as a raw string
+     */
+    async loadDbSyncFile() {
+        return (await fs.readFile(this.dbPath())).toString();
+    }
+    /**
+     * @internal
+     *
+     * builds up the schema data for every table into an object, which
+     * can be read and injected into AST nodes.
+     */
+    async getSchemaData() {
+        const tables = await this.getTables();
+        const schemaData = {};
+        for (const table of tables) {
+            schemaData[table] = await this.tableData(table);
+        }
+        return schemaData;
+    }
+    /**
+     * @internal
+     *
+     * used by getSchemaData to build up all table data
+     */
+    async getTables() {
+        const fileContents = await this.loadDbSyncFile();
+        const tableLines = /export interface DB {([^}]*)}/.exec(fileContents)[1];
+        if (tableLines === undefined)
+            return [];
+        const tables = tableLines
+            .split('\n')
+            .map(line => {
+            const stingArray = line.split(':');
+            const substring = stingArray[0];
+            if (substring === undefined)
+                return '';
+            return substring.replace(/\s*/, '');
+        })
+            .filter(line => !!line);
+        return tables;
+    }
+    /**
+     * @internal
+     *
+     * finds all enums used by the app, and returns information
+     * about those enums that can be used for type generating purpposes
+     */
+    async getAllEnumValueNames() {
+        const schemaData = await this.getSchemaData();
+        const enumValueNames = Object.values(schemaData)
+            .map(tableData => Object.keys(tableData.columns)
+            .filter(columnName => !!tableData.columns[columnName]?.enumValues)
+            .map(columnName => ({
+            enumValues: tableData.columns[columnName].enumValues,
+            enumType: tableData.columns[columnName].enumType,
+        })))
+            .flat();
+        return enumValueNames;
+    }
+    /**
+     * @internal
+     *
+     * returns a tuple, where the first value is the global name, and the second value
+     * is the table that that global name points to. Used to build up our global
+     * model name exports within type files.
+     */
+    globalModelNames() {
+        const dreamApp = DreamApp.getOrFail();
+        const models = dreamApp.models;
+        return Object.keys(models)
+            .filter(key => models[key]?.prototype?.connectionName === this.connectionName)
+            .map(key => [key, models[key].prototype.table]);
+    }
+    /**
+     * @internal
+     *
+     * retrieves useful association data for a given association and table, which
+     * can be used to build up types
+     */
+    getAssociationData(tableName, targetAssociationType) {
+        const dreamApp = DreamApp.getOrFail();
+        const models = sortBy(Object.values(dreamApp.models), m => m.table);
+        const tableAssociationData = {};
+        for (const model of models.filter(model => model.table === tableName)) {
+            for (const associationName of model.associationNames) {
+                const associationMetaData = model['associationMetadataMap']()[associationName];
+                if (associationMetaData === undefined)
+                    continue;
+                if (targetAssociationType && associationMetaData.type !== targetAssociationType)
+                    continue;
+                const dreamClassOrClasses = associationMetaData.modelCB();
+                if (!dreamClassOrClasses)
+                    throw new FailedToIdentifyAssociation(model, associationMetaData.type, associationName, associationMetaData.globalAssociationNameOrNames);
+                const optional = associationMetaData.type === 'BelongsTo' ? associationMetaData.optional === true : null;
+                const where = associationMetaData.type === 'HasMany' || associationMetaData.type === 'HasOne'
+                    ? associationMetaData.and || null
+                    : null;
+                // NOTE
+                // this try-catch is here because the ASTSchemaBuilder currently needs to be run twice to generate foreignKey
+                // correctly. The first time will raise, since calling Dream.columns is dependant on the schema const to
+                // introspect columns during a foreign key check. This will be repaired once kysely types have been successfully
+                // split off into a separate file from the types we diliver in types/dream.ts
+                let foreignKey = null;
+                try {
+                    const isThroughAssociation = associationMetaData.through;
+                    if (!isThroughAssociation) {
+                        const _foreignKey = associationMetaData.foreignKey();
+                        foreignKey = _foreignKey;
+                    }
+                }
+                catch (err) {
+                    this.hasForeignKeyError = true;
+                }
+                try {
+                    tableAssociationData[associationName] ||= {
+                        tables: [],
+                        type: associationMetaData.type,
+                        polymorphic: associationMetaData.polymorphic,
+                        foreignKey,
+                        foreignKeyTypeColumn: associationMetaData.polymorphic
+                            ? associationMetaData?.foreignKeyTypeField?.() || null
+                            : null,
+                        optional,
+                        and: where,
+                    };
+                    if (foreignKey)
+                        tableAssociationData[associationName]['foreignKey'] = foreignKey;
+                    if (Array.isArray(dreamClassOrClasses)) {
+                        const tables = dreamClassOrClasses.map(dreamClass => dreamClass.table);
+                        tableAssociationData[associationName].tables = [
+                            ...tableAssociationData[associationName].tables,
+                            ...tables,
+                        ];
+                    }
+                    else {
+                        tableAssociationData[associationName].tables.push(dreamClassOrClasses.table);
+                    }
+                    // guarantee unique
+                    tableAssociationData[associationName].tables = [
+                        ...new Set(tableAssociationData[associationName].tables),
+                    ];
+                }
+                catch (error) {
+                    if (!(error instanceof ExplicitForeignKeyRequired || error instanceof InvalidComputedForeignKey))
+                        throw error;
+                }
+            }
+        }
+        return Object.keys(tableAssociationData)
+            .sort()
+            .reduce((acc, key) => {
+            if (tableAssociationData[key] === undefined)
+                return acc;
+            acc[key] = tableAssociationData[key];
+            return acc;
+        }, {});
+    }
+    /**
+     * @internal
+     *
+     * retrieves the table data for an individual table.
+     * Can be used to build up types
+     */
+    async tableData(tableName) {
+        const dreamApp = DreamApp.getOrFail();
+        const models = Object.values(dreamApp.models).filter(model => model.table === tableName);
+        const maybeModel = models[0];
+        if (!maybeModel)
+            throw new Error(`
+Could not find a Dream model with table "${tableName}".
+
+If you recently changed the name of a table in a migration, you
+may need to update the table getter in the corresponding Dream.
+`);
+        const baseModel = maybeModel['stiBaseClassOrOwnClass'];
+        const associationData = this.getAssociationData(tableName);
+        const allStiChildren = models.filter(model => model['isSTIChild']);
+        const modelsToCheck = allStiChildren.length ? allStiChildren : [baseModel];
+        // If a table is STI, then we look only at the serializers attached to
+        // all STI children (not the STI base model because the base model may not have any serializers)
+        const eachModelSerializerKeys = modelsToCheck.map(model => {
+            let serializers = {};
+            try {
+                serializers = model?.prototype?.['serializers'] || {};
+            }
+            catch {
+                // no-op
+            }
+            return Object.keys(serializers);
+        });
+        const serializerKeys = intersection(...eachModelSerializerKeys).sort();
+        return {
+            scopes: {
+                default: uniq(models.flatMap(model => model['scopes'].default.map(scopeStatement => scopeStatement.method))),
+                named: uniq(models.flatMap(model => model['scopes'].named.map(scopeStatement => scopeStatement.method))),
+            },
+            columns: await this.getColumnData(tableName, associationData),
+            virtualColumns: uniq(models.flatMap(model => model['virtualAttributes'].map(prop => prop.property) || [])),
+            associations: associationData,
+            serializerKeys,
+        };
+    }
+    /**
+     * @internal
+     *
+     * retrieves the column data for an individual table and association.
+     * Can be used to build up types
+     */
+    async getColumnData(tableName, allTableAssociationData) {
+        const dbDriverClass = Query.dbDriverClass(this.connectionName);
+        return await dbDriverClass.getColumnData(this.connectionName, tableName, allTableAssociationData);
+    }
+}

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

@@ -0,0 +1,57 @@
+import ts from 'typescript';
+import { CliFileWriter } from '../../cli/CliFileWriter.js';
+import ASTBuilder from './ASTBuilder.js';
+import autogeneratedFileDisclaimer from './autoGeneratedFileDisclaimer.js';
+const f = ts.factory;
+/**
+ * Responsible for building dream globals, which can be found at
+ * types/dream.globals.ts.
+ *
+ * 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 ASTGlobalSchemaBuilder extends ASTBuilder {
+    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 output = await this.prettier(this.printStatements([this.buildGlobalTypeConfigConst()], sourceFile));
+        await CliFileWriter.write(this.globalSchemaPath(), output);
+    }
+    /**
+     * @internal
+     *
+     * builds up the `export const globalTypeConfig = ...` statement within the dream.globals.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.
+     */
+    buildGlobalTypeConfigConst() {
+        const globalTypeConfigObjectLiteral = f.createObjectLiteralExpression([
+            f.createPropertyAssignment(f.createIdentifier('serializers'), f.createArrayLiteralExpression(this.globalSerializerNames()
+                .sort()
+                .map(key => f.createStringLiteral(key)))),
+        ], true // multiline
+        );
+        // add "as const" to the end of the schema object we
+        // have built before returning it
+        const constAssertion = f.createAsExpression(globalTypeConfigObjectLiteral, f.createKeywordTypeNode(ts.SyntaxKind.ConstKeyword));
+        const globalTypeConfigObjectLiteralConst = f.createVariableStatement([f.createModifier(ts.SyntaxKind.ExportKeyword)], f.createVariableDeclarationList([
+            f.createVariableDeclaration(f.createIdentifier('globalTypeConfig'), undefined, undefined, constAssertion),
+        ], ts.NodeFlags.Const));
+        return globalTypeConfigObjectLiteralConst;
+    }
+    /**
+     * @internal
+     *
+     * writes the compiled statements to string.
+     *
+     */
+    printStatements(statements, sourceFile) {
+        const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed, omitTrailingSemicolon: true });
+        const result = printer.printList(ts.ListFormat.SourceFileStatements, f.createNodeArray(statements), sourceFile);
+        return `\
+${autogeneratedFileDisclaimer()}
+${result}`;
+    }
+}