@rvoh/dream 0.29.1

package/dist/cjs/src/helpers/benchmark.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const luxon_1 = require("luxon");
+const EnvInternal_js_1 = require("./EnvInternal.js");
+class Benchmark {
+    _start;
+    start() {
+        this._start = luxon_1.DateTime.now();
+    }
+    mark(message, level = 'log') {
+        if (EnvInternal_js_1.default.isTest && !EnvInternal_js_1.default.boolean('ALLOW_BENCHMARKS'))
+            return;
+        if (!this._start)
+            this.start();
+        console[level](message, luxon_1.DateTime.now().diff(this._start, 'milliseconds').milliseconds);
+    }
+}
+exports.default = Benchmark;

package/dist/cjs/src/helpers/camelize.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = camelize;
+exports.camelizeString = camelizeString;
+const stringCasing_js_1 = require("./stringCasing.js");
+const uncapitalize_js_1 = require("./uncapitalize.js");
+function camelize(target) {
+    return (0, stringCasing_js_1.default)(target, camelizeString);
+}
+function camelizeString(str) {
+    return (0, uncapitalize_js_1.default)(str
+        .replace(/[ _-]+/g, '_')
+        .replace(/(^_|_$)/g, '')
+        .replace(/_(.)/g, (_, x) => x.toUpperCase()));
+}

package/dist/cjs/src/helpers/capitalize.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = capitalize;
+function capitalize(str) {
+    return str.slice(0, 1).toUpperCase() + str.slice(1);
+}

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

@@ -0,0 +1,378 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs/promises");
+const kysely_1 = require("kysely");
+const path = require("path");
+const dataTypes_js_1 = require("../../db/dataTypes.js");
+const index_js_1 = require("../../db/index.js");
+const index_js_2 = require("../../dream-application/index.js");
+const types_js_1 = require("../../dream/types.js");
+const FailedToIdentifyAssociation_js_1 = require("../../errors/schema-builder/FailedToIdentifyAssociation.js");
+const autogeneratedFileMessage_js_1 = require("../../global-cli/helpers/autogeneratedFileMessage.js");
+const camelize_js_1 = require("../camelize.js");
+const EnvInternal_js_1 = require("../EnvInternal.js");
+const pascalize_js_1 = require("../pascalize.js");
+const sortBy_js_1 = require("../sortBy.js");
+const uniq_js_1 = require("../uniq.js");
+class SchemaBuilder {
+    async build() {
+        const { schemaConstContent, passthroughColumns, allDefaultScopeNames } = await this.buildSchemaContent();
+        const imports = await this.getSchemaImports(schemaConstContent);
+        const importStr = imports.length
+            ? `\
+import {
+  ${imports.sort().join(',\n  ')}
+} from './db'`
+            : '';
+        const calendarDateImportStatement = EnvInternal_js_1.default.boolean('DREAM_CORE_DEVELOPMENT')
+            ? "import CalendarDate from '../../src/helpers/CalendarDate'"
+            : "import { CalendarDate } from '@rvohealth/dream'";
+        const dreamApp = index_js_2.default.getOrFail();
+        const newSchemaFileContents = `\
+${(0, autogeneratedFileMessage_js_1.default)()}
+${calendarDateImportStatement}
+import { DateTime } from 'luxon'
+${importStr}
+
+${schemaConstContent}
+
+export const globalSchema = {
+  passthroughColumns: ${stringifyArray((0, uniq_js_1.default)(passthroughColumns.sort()), { indent: 4 })},
+  allDefaultScopeNames: ${stringifyArray((0, uniq_js_1.default)(allDefaultScopeNames.sort()), { indent: 4 })},
+  globalNames: {
+    models: ${this.globalModelNames()},
+    serializers: ${stringifyArray(Object.keys(dreamApp.serializers || {}).sort(), { indent: 6 })},
+  },
+} as const
+`;
+        // const newSchemaFileContents = `\
+        // ${schemaConstContent}
+        // `
+        const schemaPath = path.join(dreamApp.projectRoot, dreamApp.paths.types, 'dream.ts');
+        await fs.writeFile(schemaPath, newSchemaFileContents);
+    }
+    globalModelNames() {
+        const dreamApp = index_js_2.default.getOrFail();
+        return `{
+      ${Object.keys(dreamApp.models)
+            .map(key => `'${key}': '${dreamApp.models[key].prototype.table}'`)
+            .join(',\n      ')}
+    }`;
+    }
+    async buildSchemaContent() {
+        let passthroughColumns = [];
+        let allDefaultScopeNames = [];
+        const schemaData = await this.getSchemaData();
+        const fileContents = await this.loadDbSyncFile();
+        const schemaConstContent = `\
+export const schema = {
+  ${Object.keys(schemaData)
+            .map(tableName => {
+            const tableData = schemaData[tableName];
+            const defaultScopeNames = tableData.scopes.default;
+            const namedScopeNames = tableData.scopes.named;
+            allDefaultScopeNames = [...allDefaultScopeNames, ...defaultScopeNames];
+            return `\
+${tableName}: {
+    primaryKey: '${tableData.primaryKey}',
+    createdAtField: '${tableData.createdAtField}',
+    updatedAtField: '${tableData.updatedAtField}',
+    deletedAtField: '${tableData.deletedAtField}',
+    serializerKeys: ${stringifyArray(tableData.serializerKeys)},
+    scopes: {
+      default: ${stringifyArray(defaultScopeNames)},
+      named: ${stringifyArray(namedScopeNames)},
+    },
+    columns: {
+      ${Object.keys(schemaData[tableName].columns)
+                .sort()
+                .map(columnName => {
+                const columnData = tableData.columns[columnName];
+                const kyselyType = this.kyselyType(tableName, columnName, fileContents);
+                return `${columnName}: {
+        coercedType: {} as ${this.coercedType(kyselyType, columnData.dbType)},
+        enumType: ${columnData.enumType ? `{} as ${columnData.enumType}` : 'null'},
+        enumArrayType: ${columnData.enumType ? `[] as ${columnData.enumType}[]` : 'null'},
+        enumValues: ${columnData.enumValues ?? 'null'},
+        dbType: '${columnData.dbType}',
+        allowNull: ${columnData.allowNull},
+        isArray: ${columnData.isArray},
+      },`;
+            })
+                .join('\n      ')}
+    },
+    virtualColumns: ${stringifyArray(schemaData[tableName].virtualColumns)},
+    associations: {
+      ${Object.keys(schemaData[tableName].associations)
+                .sort()
+                .map(associationName => {
+                const associationMetadata = tableData.associations[associationName];
+                const whereStatement = associationMetadata.where;
+                const requiredOnClauses = whereStatement === null
+                    ? []
+                    : Object.keys(whereStatement).filter(column => whereStatement[column] === types_js_1.DreamConst.required);
+                passthroughColumns =
+                    whereStatement === null
+                        ? passthroughColumns
+                        : [
+                            ...passthroughColumns,
+                            ...Object.keys(whereStatement).filter(column => whereStatement[column] === types_js_1.DreamConst.passthrough),
+                        ];
+                return `${associationName}: {
+        type: '${associationMetadata.type}',
+        foreignKey: ${associationMetadata.foreignKey ? `'${associationMetadata.foreignKey}'` : 'null'},
+        tables: ${stringifyArray(associationMetadata.tables)},
+        optional: ${associationMetadata.optional},
+        requiredOnClauses: ${requiredOnClauses.length === 0 ? 'null' : stringifyArray(requiredOnClauses)},
+      },`;
+            })
+                .join('\n      ')}
+    },
+  },\
+`;
+        })
+            .join('\n  ')}
+} as const`;
+        return { schemaConstContent, passthroughColumns, allDefaultScopeNames };
+    }
+    async getSchemaImports(schemaContent) {
+        const allExports = await this.getExportedModulesFromDbSync();
+        const schemaContentWithoutImports = schemaContent.replace(/import {[^}]*}/gm, '');
+        return allExports.filter(exportedModule => {
+            if (new RegExp(`coercedType: {} as ${exportedModule}`).test(schemaContentWithoutImports))
+                return true;
+            if (new RegExp(`coercedType: {} as ArrayType<${exportedModule}`).test(schemaContentWithoutImports))
+                return true;
+            if (new RegExp(`enumType: {} as ${exportedModule}`).test(schemaContentWithoutImports))
+                return true;
+            if (new RegExp(`enumValues: ${exportedModule}`).test(schemaContentWithoutImports))
+                return true;
+            return false;
+        });
+    }
+    async tableData(tableName) {
+        const dreamApp = index_js_2.default.getOrFail();
+        const models = Object.values(dreamApp.models);
+        const model = models.find(model => model.table === tableName);
+        if (!model)
+            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 associationData = this.getAssociationData(tableName);
+        let serializers;
+        try {
+            serializers =
+                model?.prototype?.['serializers'] || {};
+        }
+        catch {
+            serializers = {};
+        }
+        return {
+            primaryKey: model.prototype.primaryKey,
+            createdAtField: model.prototype.createdAtField,
+            updatedAtField: model.prototype.updatedAtField,
+            deletedAtField: model.prototype.deletedAtField,
+            scopes: {
+                default: model['scopes'].default.map(scopeStatement => scopeStatement.method),
+                named: model['scopes'].named.map(scopeStatement => scopeStatement.method),
+            },
+            columns: await this.getColumnData(tableName, associationData),
+            virtualColumns: this.getVirtualColumns(tableName),
+            associations: associationData,
+            serializerKeys: Object.keys(serializers),
+        };
+    }
+    async getColumnData(tableName, associationData) {
+        const db = (0, index_js_1.default)('primary');
+        const sqlQuery = (0, kysely_1.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);
+        const rows = columnToDBTypeMap.rows;
+        const columnData = {};
+        rows.forEach(row => {
+            const isEnum = ['USER-DEFINED', 'ARRAY'].includes(row.dataType) && !(0, dataTypes_js_1.isPrimitiveDataType)(row.udtName);
+            const isArray = ['ARRAY'].includes(row.dataType);
+            const associationMetadata = associationData[row.columnName];
+            columnData[(0, camelize_js_1.default)(row.columnName)] = {
+                dbType: row.udtName,
+                allowNull: row.isNullable === 'YES',
+                enumType: isEnum ? this.enumType(row) : null,
+                enumValues: isEnum ? `${this.enumType(row)}Values` : null,
+                isArray,
+                foreignKey: associationMetadata?.foreignKey || null,
+            };
+        });
+        return Object.keys(columnData)
+            .sort()
+            .reduce((acc, key) => {
+            acc[key] = columnData[key];
+            return acc;
+        }, {});
+    }
+    enumType(row) {
+        const enumName = (0, pascalize_js_1.default)(row.udtName.replace(/\[\]$/, ''));
+        return enumName;
+    }
+    getVirtualColumns(tableName) {
+        const dreamApp = index_js_2.default.getOrFail();
+        const models = (0, sortBy_js_1.default)(Object.values(dreamApp.models), m => m.table);
+        const model = models.find(model => model.table === tableName);
+        return model?.['virtualAttributes']?.map(prop => prop.property) || [];
+    }
+    async getSchemaData() {
+        const tables = await this.getTables();
+        const schemaData = {};
+        for (const table of tables) {
+            schemaData[table] = await this.tableData(table);
+        }
+        return schemaData;
+    }
+    getAssociationData(tableName, targetAssociationType) {
+        const dreamApp = index_js_2.default.getOrFail();
+        const models = (0, sortBy_js_1.default)(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 (targetAssociationType && associationMetaData.type !== targetAssociationType)
+                    continue;
+                const dreamClassOrClasses = associationMetaData.modelCB();
+                if (!dreamClassOrClasses)
+                    throw new FailedToIdentifyAssociation_js_1.default(model, associationMetaData.type, associationName, associationMetaData.globalAssociationNameOrNames);
+                const optional = associationMetaData.type === 'BelongsTo' ? associationMetaData.optional === true : null;
+                const where = associationMetaData.type === 'HasMany' || associationMetaData.type === 'HasOne'
+                    ? associationMetaData.on || null
+                    : null;
+                // NOTE
+                // this try-catch is here because the SchemaBuilder 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 _foreignKey = associationMetaData.foreignKey();
+                    foreignKey = _foreignKey;
+                }
+                catch {
+                    // noop
+                }
+                tableAssociationData[associationName] ||= {
+                    tables: [],
+                    type: associationMetaData.type,
+                    polymorphic: associationMetaData.polymorphic,
+                    foreignKey,
+                    optional,
+                    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),
+                ];
+            }
+        }
+        return Object.keys(tableAssociationData)
+            .sort()
+            .reduce((acc, key) => {
+            acc[key] = tableAssociationData[key];
+            return acc;
+        }, {});
+    }
+    async getExportedModulesFromDbSync() {
+        const fileContents = await this.loadDbSyncFile();
+        const exportedConsts = [...fileContents.matchAll(/export\s+const\s+([a-zA-Z0-9_]+)/g)].map(res => res[1]);
+        const exportedTypes = [...fileContents.matchAll(/export\s+type\s+([a-zA-Z0-9_]+)/g)].map(res => res[1]);
+        const exportedInterfaces = [...fileContents.matchAll(/export\s+interface\s+([a-zA-Z0-9_]+)/g)].map(res => res[1]);
+        const allExports = [...exportedConsts, ...exportedTypes, ...exportedInterfaces];
+        return allExports;
+    }
+    async getTables() {
+        const fileContents = await this.loadDbSyncFile();
+        const tableLines = /export interface DB {([^}]*)}/.exec(fileContents)[1];
+        const tables = tableLines
+            .split('\n')
+            .map(line => line.split(':')[0].replace(/\s*/, ''))
+            .filter(line => !!line);
+        return tables;
+    }
+    kyselyType(tableName, columnName, fileContents) {
+        const tableLines = /export interface DB {([^}]*)}/.exec(fileContents)[1];
+        const interfaceName = tableLines
+            .split('\n')
+            .filter(line => !!line)
+            .filter(line => new RegExp(`^  ${tableName}:`).test(line))[0]
+            .split(':')[1]
+            ?.replace(/[\s;]*/g, '');
+        const interfaceLines = new RegExp(`export interface ${interfaceName} {([^}]*)}`).exec(fileContents)[1];
+        const kyselyType = interfaceLines
+            .split('\n')
+            .filter(line => !!line)
+            .filter(line => new RegExp(`  ${columnName}:`).test(line))[0]
+            .split(':')[1]
+            ?.replace(/[\s;]*/g, '');
+        return kyselyType;
+    }
+    coercedType(kyselyType, dbType) {
+        const postfix = /\[\]$/.test(dbType) ? '[]' : '';
+        return kyselyType
+            .replace(/\s/g, '')
+            .replace(/Generated<(.*)>/g, '$1')
+            .replace(/ArrayType<(.*)>/g, '$1[]')
+            .split('|')
+            .map(individualType => {
+            switch (individualType) {
+                case 'Numeric':
+                case 'Numeric[]':
+                    return `number${postfix}`;
+                case 'Timestamp':
+                case 'Timestamp[]':
+                    return /^date[[\]]*$/.test(dbType) ? `CalendarDate${postfix}` : `DateTime${postfix}`;
+                case 'Int8':
+                case 'Int8[]':
+                    return `IdType${postfix}`;
+                default:
+                    return individualType;
+            }
+        })
+            .join(' | ');
+    }
+    async loadDbSyncFile() {
+        const dreamApp = index_js_2.default.getOrFail();
+        const dbSyncPath = path.join(dreamApp.projectRoot, dreamApp.paths.types, 'db.ts');
+        return (await fs.readFile(dbSyncPath)).toString();
+    }
+}
+exports.default = SchemaBuilder;
+function stringifyArray(arr = [], { indent } = {}) {
+    if (indent && arr.length > 3) {
+        let spaces = '';
+        for (let i = 0; i < indent; i++) {
+            spaces = `${spaces} `;
+        }
+        return `[
+${spaces}${[...arr]
+            .sort()
+            .map(val => `'${val}'`)
+            .join(`,\n${spaces}`)}
+${spaces.replace(/\s{2}$/, '')}]`;
+    }
+    else {
+        return `[${[...arr]
+            .sort()
+            .map(val => `'${val}'`)
+            .join(', ')}]`;
+    }
+}

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

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generateDream;
+const fs = require("fs/promises");
+const dreamFileAndDirPaths_js_1 = require("../path/dreamFileAndDirPaths.js");
+const dreamPath_js_1 = require("../path/dreamPath.js");
+const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
+const generateDreamContent_js_1 = require("./generateDreamContent.js");
+const generateFactory_js_1 = require("./generateFactory.js");
+const generateMigration_js_1 = require("./generateMigration.js");
+const generateSerializer_js_1 = require("./generateSerializer.js");
+const generateUnitSpec_js_1 = require("./generateUnitSpec.js");
+async function generateDream({ fullyQualifiedModelName, columnsWithTypes, options, fullyQualifiedParentName, }) {
+    fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
+    const { relFilePath, absDirPath, absFilePath } = (0, dreamFileAndDirPaths_js_1.default)((0, dreamPath_js_1.default)('models'), `${fullyQualifiedModelName}.ts`);
+    try {
+        console.log(`generating dream: ${relFilePath}`);
+        await fs.mkdir(absDirPath, { recursive: true });
+        await fs.writeFile(absFilePath, (0, generateDreamContent_js_1.default)({
+            fullyQualifiedModelName,
+            columnsWithTypes,
+            fullyQualifiedParentName,
+            serializer: options.serializer,
+        }));
+    }
+    catch (error) {
+        throw new Error(`
+      Something happened while trying to create the Dream file:
+        ${relFilePath}
+
+      Does this file already exist? Here is the error that was raised:
+        ${error.message}
+    `);
+    }
+    await (0, generateUnitSpec_js_1.default)({ fullyQualifiedModelName });
+    await (0, generateFactory_js_1.default)({ fullyQualifiedModelName, columnsWithTypes });
+    if (options.serializer)
+        await (0, generateSerializer_js_1.default)({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName });
+    const isSTI = !!fullyQualifiedParentName;
+    if (columnsWithTypes.length || !isSTI) {
+        await (0, generateMigration_js_1.default)({
+            migrationName: fullyQualifiedModelName,
+            columnsWithTypes,
+            fullyQualifiedModelName,
+            fullyQualifiedParentName,
+        });
+    }
+}

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

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generateDreamContent;
+const pluralize_esm_1 = require("pluralize-esm");
+const camelize_js_1 = require("../camelize.js");
+const globalClassNameFromFullyQualifiedModelName_js_1 = require("../globalClassNameFromFullyQualifiedModelName.js");
+const relativeDreamPath_js_1 = require("../path/relativeDreamPath.js");
+const serializerNameFromFullyQualifiedModelName_js_1 = require("../serializerNameFromFullyQualifiedModelName.js");
+const snakeify_js_1 = require("../snakeify.js");
+const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
+const uniq_js_1 = require("../uniq.js");
+function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, }) {
+    fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
+    const modelClassName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
+    let parentModelClassName;
+    const dreamImports = ['Decorators', 'DreamColumn'];
+    if (serializer)
+        dreamImports.push('DreamSerializers');
+    const isSTI = !!fullyQualifiedParentName;
+    if (isSTI) {
+        fullyQualifiedParentName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedParentName);
+        parentModelClassName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedParentName);
+        dreamImports.push('STI');
+    }
+    const idTypescriptType = `DreamColumn<${modelClassName}, 'id'>`;
+    const modelImportStatements = isSTI
+        ? [importStatementForModel(fullyQualifiedModelName, fullyQualifiedParentName)]
+        : [importStatementForModel(fullyQualifiedModelName, 'ApplicationModel')];
+    const attributeStatements = columnsWithTypes.map(attribute => {
+        const [attributeName, attributeType, ...descriptors] = attribute.split(':');
+        const fullyQualifiedAssociatedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(attributeName);
+        const associationModelName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedAssociatedModelName);
+        const associationImportStatement = importStatementForModel(fullyQualifiedModelName, fullyQualifiedAssociatedModelName);
+        const associationName = (0, camelize_js_1.default)(associationModelName);
+        if (!attributeType)
+            throw new Error(`must pass a column type for ${attributeName} (i.e. ${attributeName}:string)`);
+        switch (attributeType) {
+            case 'belongs_to':
+                modelImportStatements.push(associationImportStatement);
+                return `
+@Deco.BelongsTo('${fullyQualifiedAssociatedModelName}'${descriptors.includes('optional') ? ', { optional: true }' : ''})
+public ${associationName}: ${associationModelName}${descriptors.includes('optional') ? ' | null' : ''}
+public ${associationName}Id: DreamColumn<${modelClassName}, '${associationName}Id'>
+`;
+            case 'has_one':
+            case 'has_many':
+                return '';
+            case 'encrypted':
+                dreamImports.push('Encrypted');
+                return `
+@Encrypted()
+public ${(0, camelize_js_1.default)(attributeName)}: ${getAttributeType(attribute, modelClassName)}\
+`;
+            default:
+                return `
+public ${(0, camelize_js_1.default)(attributeName)}: ${getAttributeType(attribute, modelClassName)}\
+`;
+        }
+    });
+    const formattedFields = attributeStatements
+        .filter(attr => !/^\n@/.test(attr))
+        .map(s => s.split('\n').join('\n  '))
+        .join('');
+    const formattedDecorators = attributeStatements
+        .filter(attr => /^\n@/.test(attr))
+        .map(s => s.split('\n').join('\n  '))
+        .join('\n  ')
+        .replace(/\n {2}$/, '');
+    let timestamps = `
+  public createdAt: DreamColumn<${modelClassName}, 'createdAt'>
+  public updatedAt: DreamColumn<${modelClassName}, 'updatedAt'>
+`;
+    if (!formattedDecorators.length)
+        timestamps = timestamps.replace(/\n$/, '');
+    const tableName = (0, snakeify_js_1.default)((0, pluralize_esm_1.default)(fullyQualifiedModelName.replace(/\//g, '_')));
+    return `\
+import { ${(0, uniq_js_1.default)(dreamImports).join(', ')} } from '@rvohealth/dream'${(0, uniq_js_1.default)(modelImportStatements).join('')}
+
+const Deco = new Decorators<InstanceType<typeof ${modelClassName}>>()
+
+${isSTI ? `\n@STI(${parentModelClassName})` : ''}
+export default class ${modelClassName} extends ${isSTI ? parentModelClassName : 'ApplicationModel'} {
+${isSTI
+        ? ''
+        : `  public get table() {
+    return '${tableName}' as const
+  }
+
+`}${serializer
+        ? `  public get serializers(): DreamSerializers<${modelClassName}> {
+    return {
+      default: '${(0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName)}',
+      summary: '${(0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName, 'summary')}',
+    }
+  }
+
+`
+        : ''}${isSTI ? formattedFields : `  public id: ${idTypescriptType}${formattedFields}${timestamps}`}${formattedDecorators}
+}
+`.replace(/^\s*$/gm, '');
+}
+function getAttributeType(attribute, modelClassName) {
+    return `DreamColumn<${modelClassName}, '${(0, camelize_js_1.default)(attribute.split(':')[0])}'>`;
+}
+function importStatementForModel(originModelName, destinationModelName = originModelName) {
+    return `\nimport ${(0, globalClassNameFromFullyQualifiedModelName_js_1.default)(destinationModelName)} from '${(0, relativeDreamPath_js_1.default)('models', 'models', originModelName, destinationModelName)}'`;
+}

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generateFactory;
+const fs = require("fs/promises");
+const dreamFileAndDirPaths_js_1 = require("../path/dreamFileAndDirPaths.js");
+const dreamPath_js_1 = require("../path/dreamPath.js");
+const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
+const generateFactoryContent_js_1 = require("./generateFactoryContent.js");
+async function generateFactory({ fullyQualifiedModelName, columnsWithTypes, }) {
+    fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
+    const { relFilePath, absDirPath, absFilePath } = (0, dreamFileAndDirPaths_js_1.default)((0, dreamPath_js_1.default)('factories'), `${fullyQualifiedModelName}Factory.ts`);
+    try {
+        console.log(`generating factory: ${relFilePath}`);
+        await fs.mkdir(absDirPath, { recursive: true });
+        await fs.writeFile(absFilePath, (0, generateFactoryContent_js_1.default)({ fullyQualifiedModelName, columnsWithTypes }));
+    }
+    catch (error) {
+        throw new Error(`
+      Something happened while trying to create the spec file:
+        ${relFilePath}
+
+      Does this file already exist? Here is the error that was raised:
+        ${error.message}
+    `);
+    }
+}

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

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generateFactoryContent;
+const camelize_js_1 = require("../camelize.js");
+const globalClassNameFromFullyQualifiedModelName_js_1 = require("../globalClassNameFromFullyQualifiedModelName.js");
+const relativeDreamPath_js_1 = require("../path/relativeDreamPath.js");
+const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
+const uniq_js_1 = require("../uniq.js");
+function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, }) {
+    fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
+    const dreamImports = ['UpdateableProperties'];
+    const additionalImports = [];
+    const belongsToNames = [];
+    const belongsToTypedNames = [];
+    const associationCreationStatements = [];
+    const stringAttributes = [];
+    let firstStringAttr = true;
+    for (const attribute of columnsWithTypes) {
+        const [attributeName, attributeType, ...descriptors] = attribute.split(':');
+        const fullyQualifiedAssociatedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(attributeName);
+        const associationModelName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedAssociatedModelName);
+        const associationFactoryImportStatement = `import create${associationModelName} from '${(0, relativeDreamPath_js_1.default)('factories', 'factories', fullyQualifiedModelName, fullyQualifiedAssociatedModelName)}'`;
+        const associationName = (0, camelize_js_1.default)(associationModelName);
+        if (/_type$/.test(attributeName))
+            continue;
+        if (!attributeType)
+            throw new Error(`Must pass a column type for ${fullyQualifiedAssociatedModelName} (i.e. ${fullyQualifiedAssociatedModelName}:string)`);
+        switch (attributeType) {
+            case 'belongs_to':
+                belongsToNames.push(associationName);
+                belongsToTypedNames.push(`${associationName}: ${associationModelName}`);
+                additionalImports.push(associationFactoryImportStatement);
+                associationCreationStatements.push(`attrs.${associationName} ||= await create${associationModelName}()`);
+                break;
+            case 'string':
+            case 'text':
+            case 'citext':
+                stringAttributes.push(`attrs.${(0, camelize_js_1.default)(attributeName)} ||= \`${fullyQualifiedModelName} ${(0, camelize_js_1.default)(attributeName)} ${firstStringAttr ? '${++counter}' : '${counter}'}\``);
+                firstStringAttr = false;
+                break;
+            case 'enum':
+                stringAttributes.push(`attrs.${(0, camelize_js_1.default)(attributeName)} ||= '${(descriptors[descriptors.length - 1] || '<tbd>').split(',')[0]}'`);
+                break;
+            default:
+            // noop
+        }
+    }
+    const relativePath = (0, relativeDreamPath_js_1.default)('factories', 'models', fullyQualifiedModelName);
+    const modelClassName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
+    return `\
+import { ${(0, uniq_js_1.default)(dreamImports).join(', ')} } from '@rvohealth/dream'
+import ${modelClassName} from '${relativePath}'${additionalImports.length ? '\n' + (0, uniq_js_1.default)(additionalImports).join('\n') : ''}
+${stringAttributes.length ? '\nlet counter = 0\n' : ''}
+export default async function create${modelClassName}(attrs: UpdateableProperties<${modelClassName}> = {}) {
+  ${associationCreationStatements.length ? associationCreationStatements.join('\n  ') + '\n  ' : ''}${stringAttributes.length ? stringAttributes.join('\n  ') + '\n  ' : ''}return await ${modelClassName}.create(attrs)
+}
+`;
+}