@rvoh/dream 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,11 +1,23 @@
-# 1.0.1
+## 1.0.5
 
-- [bug] fix preloading STI model via polymporhic association (polymorphic type was being altered to the STI child rather than left as the STI base)
+- Support HasOne/Many through polymorphic BelongsTo (trick is that it uses the associated model from the HasOne/Many to limit the BelongsTo to a single associated class / table)
 
-## 1.0.2
+- Fix HasOne/Many through source type
 
-- stop computing foreign keys in schema builder when building schema for through associations
+- sync process is now fail-safe, leveraging a utility which caches old copies of files before writing to them. If an exception is thrown at any point during the process, dream will revert all files written using the new `CliFileWriter` class
+
+## 1.0.4
+
+- properly exclude type from `DreamParamSafeColumnNames`
 
 ## 1.0.3
 
 - exclude type from `DreamParamSafeColumnNames`
+
+## 1.0.2
+
+- stop computing foreign keys in schema builder when building schema for through associations
+
+## 1.0.1
+
+- [bug] fix preloading STI model via polymporhic association (polymorphic type was being altered to the STI child rather than left as the STI base)

package/dist/cjs/src/bin/helpers/sync.js

@@ -12,11 +12,13 @@ const EnvInternal_js_1 = require("../../helpers/EnvInternal.js");
 const dreamPath_js_1 = require("../../helpers/path/dreamPath.js");
 const snakeify_js_1 = require("../../helpers/snakeify.js");
 const sspawn_js_1 = require("../../helpers/sspawn.js");
+const CliFileWriter_js_1 = require("../../cli/CliFileWriter.js");
 async function writeSyncFile() {
     const dreamApp = index_js_2.default.getOrFail();
     const dbConf = dreamApp.dbConnectionConfig('primary');
     const dbSyncFilePath = path.join((0, dreamPath_js_1.default)('types'), 'db.ts');
     const absoluteDbSyncPath = path.join(dreamApp.projectRoot, dbSyncFilePath);
+    await CliFileWriter_js_1.CliFileWriter.cache(absoluteDbSyncPath);
     await (0, sspawn_js_1.default)(`kysely-codegen --dialect=postgres --url=postgres://${dbConf.user}:${dbConf.password}@${dbConf.host}:${dbConf.port}/${dbConf.name} --out-file=${absoluteDbSyncPath}`, {
         onStdout: message => {
             index_js_1.default.logger.logContinueProgress((0, colorize_js_1.default)(`[db]`, { color: 'cyan' }) + ' ' + message, {
@@ -28,7 +30,7 @@ async function writeSyncFile() {
     // from the dist folder, whereas dirname here is pointing to true src folder.
     const file = (await fs.readFile(absoluteDbSyncPath)).toString();
     const enhancedSchema = enhanceSchema(file);
-    await fs.writeFile(absoluteDbSyncPath, enhancedSchema);
+    await CliFileWriter_js_1.CliFileWriter.write(absoluteDbSyncPath, enhancedSchema);
 }
 // begin: schema helpers
 function enhanceSchema(file) {

package/dist/cjs/src/cli/CliFileWriter.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliFileWriter = void 0;
+const fs = require("node:fs/promises");
+const index_js_1 = require("./index.js");
+class CliFileWriter {
+    static async write(filepath, contents) {
+        await cliFileWriter.write(filepath, contents);
+    }
+    static async revert() {
+        await cliFileWriter.revert();
+    }
+    static async cache(filepath) {
+        await cliFileWriter.cache(filepath);
+    }
+    fileCache = {};
+    async write(filepath, contents) {
+        // if we have manually backed up this file, or else this file
+        // has been written to twice in one CLI session, we want
+        // to preserve the original backup, so we do not attempt
+        // to cache a second time
+        if (!this.fileCache[filepath])
+            await this.cache(filepath);
+        await fs.writeFile(filepath, contents);
+    }
+    async revert() {
+        const filepaths = Object.keys(this.fileCache);
+        for (const filepath of filepaths) {
+            index_js_1.default.logger.logContinueProgress(`reverting ${filepath}`);
+            await fs.writeFile(filepath, this.fileCache[filepath]);
+        }
+    }
+    async cache(filepath) {
+        const originalContents = (await fs.readFile(filepath)).toString();
+        this.fileCache[filepath] = originalContents;
+    }
+}
+exports.CliFileWriter = CliFileWriter;
+const cliFileWriter = new CliFileWriter();

package/dist/cjs/src/cli/logger/DreamCliLogger.js

@@ -10,6 +10,11 @@ class DreamCliLogger {
         });
         loggable.render();
     }
+    async logProgress(text, cb, { logPrefix = '✺ ┌', logPrefixColor, logPrefixBgColor } = {}) {
+        this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
+        await cb();
+        this.logEndProgress();
+    }
     logStartProgress(text, { logPrefix = '✺ ┌', logPrefixColor, logPrefixBgColor } = {}) {
         this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
     }

package/dist/cjs/src/decorators/field/association/shared.js

@@ -98,12 +98,12 @@ function applyGetterAndSetter(target, partialAssociation, { foreignKeyBase, isBe
 function associationPrimaryKeyAccessors(partialAssociation, dreamClass) {
     return {
         ...partialAssociation,
-        primaryKey(associationInstance) {
+        primaryKey(associationInstance, { associatedClassOverride } = {}) {
             if (this.primaryKeyOverride)
                 return this.primaryKeyOverride;
             if (associationInstance)
                 return associationInstance.primaryKey;
-            const associationClass = this.modelCB();
+            const associationClass = associatedClassOverride ?? this.modelCB();
             if (Array.isArray(associationClass)) {
                 throw new Error(`
 Cannot lookup primaryKey on polymorphic association:

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

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const kysely_1 = require("kysely");
 const pluralize_esm_1 = require("pluralize-esm");
 const sync_js_1 = require("../../bin/helpers/sync.js");
+const CliFileWriter_js_1 = require("../../cli/CliFileWriter.js");
 const index_js_1 = require("../../cli/index.js");
 const index_js_2 = require("../../db/index.js");
 const associationToGetterSetterProp_js_1 = require("../../decorators/field/association/associationToGetterSetterProp.js");
 const PackageManager_js_1 = require("../../dream-app/helpers/PackageManager.js");
 const index_js_3 = require("../../dream-app/index.js");
-const CannotAssociateThroughPolymorphic_js_1 = require("../../errors/associations/CannotAssociateThroughPolymorphic.js");
+const ArrayTargetsIncompatibleWithThroughAssociation_js_1 = require("../../errors/associations/ArrayTargetsIncompatibleWithThroughAssociation.js");
+const CannotAssociateThroughMultiplePolymorphics_js_1 = require("../../errors/associations/CannotAssociateThroughMultiplePolymorphics.js");
 const CannotJoinPolymorphicBelongsToError_js_1 = require("../../errors/associations/CannotJoinPolymorphicBelongsToError.js");
 const JoinAttemptedOnMissingAssociation_js_1 = require("../../errors/associations/JoinAttemptedOnMissingAssociation.js");
 const MissingRequiredAssociationAndClause_js_1 = require("../../errors/associations/MissingRequiredAssociationAndClause.js");
@@ -94,33 +96,41 @@ class KyselyQueryDriver extends Base_js_1.default {
         await (0, generateMigration_js_1.default)({ migrationName, columnsWithTypes });
     }
     static async sync(onSync, options = {}) {
-        if (!options?.schemaOnly) {
-            index_js_1.default.logger.logStartProgress('writing db schema...');
-            await (0, sync_js_1.default)();
-            index_js_1.default.logger.logEndProgress();
-        }
-        index_js_1.default.logger.logStartProgress('building dream schema...');
-        const schemaBuilder = new SchemaBuilder_js_1.default();
-        await schemaBuilder.build();
-        index_js_1.default.logger.logEndProgress();
-        if (schemaBuilder.hasForeignKeyError && !options?.schemaOnly) {
-            index_js_1.default.logger.logStartProgress('triggering resync to correct for foreign key errors...');
-            // TODO: make this customizable to enable dream apps to separate
-            const cliCmd = EnvInternal_js_1.default.boolean('DREAM_CORE_DEVELOPMENT') ? 'dream' : 'psy';
-            await index_js_1.default.spawn(PackageManager_js_1.default.runCmd(`${cliCmd} sync --schema-only`), {
-                onStdout: str => {
-                    index_js_1.default.logger.logContinueProgress(`${str}`, {
-                        logPrefix: '  ├ [resync]',
-                        logPrefixColor: 'blue',
-                    });
-                },
+        try {
+            if (!options?.schemaOnly) {
+                await index_js_1.default.logger.logProgress('writing db schema...', async () => {
+                    await (0, sync_js_1.default)();
+                });
+            }
+            const schemaBuilder = new SchemaBuilder_js_1.default();
+            await index_js_1.default.logger.logProgress('building dream schema...', async () => {
+                await schemaBuilder.build();
             });
-            index_js_1.default.logger.logEndProgress();
+            if (schemaBuilder.hasForeignKeyError && !options?.schemaOnly) {
+                await index_js_1.default.logger.logProgress('triggering resync to correct for foreign key errors...', async () => {
+                    // TODO: make this customizable to enable dream apps to separate
+                    const cliCmd = EnvInternal_js_1.default.boolean('DREAM_CORE_DEVELOPMENT') ? 'dream' : 'psy';
+                    await index_js_1.default.spawn(PackageManager_js_1.default.runCmd(`${cliCmd} sync --schema-only`), {
+                        onStdout: str => {
+                            index_js_1.default.logger.logContinueProgress(`${str}`, {
+                                logPrefix: '  ├ [resync]',
+                                logPrefixColor: 'blue',
+                            });
+                        },
+                    });
+                });
+            }
+            if (!options?.schemaOnly) {
+                // intentionally leaving logs off here, since it allows other
+                // onSync handlers to determine their own independent logging approach
+                await onSync();
+            }
         }
-        if (!options?.schemaOnly) {
-            // intentionally leaving logs off here, since it allows other
-            // onSync handlers to determine their own independent logging approach
-            await onSync();
+        catch (error) {
+            console.error(error);
+            await index_js_1.default.logger.logProgress('sync failed, reverting file contents...', async () => {
+                await CliFileWriter_js_1.CliFileWriter.revert();
+            });
         }
     }
     /**
@@ -1089,6 +1099,8 @@ class KyselyQueryDriver extends Base_js_1.default {
                 currentAssociationTableOrAlias,
                 joinAndStatements,
                 joinType,
+                baseThroughAssociation: undefined,
+                polymorphicCount: { count: 0 },
             });
             query = results.query;
             const association = results.association;
@@ -1284,7 +1296,7 @@ class KyselyQueryDriver extends Base_js_1.default {
      * the `through` association are only added when the recursion returns
      * back to the association that kicked off the through associations.
      */
-    joinsBridgeThroughAssociations({ query, dreamClass, association, previousAssociationTableOrAlias, throughAssociations, joinType, }) {
+    joinsBridgeThroughAssociations({ query, dreamClass, association, previousAssociationTableOrAlias, throughAssociations, joinType, baseThroughAssociation, polymorphicCount, }) {
         if (association.type === 'BelongsTo' || !association.through) {
             return {
                 query,
@@ -1307,6 +1319,8 @@ class KyselyQueryDriver extends Base_js_1.default {
                 currentAssociationTableOrAlias: association.through,
                 throughAssociations,
                 joinType,
+                baseThroughAssociation,
+                polymorphicCount,
             });
             // The through association has both a `through` and a `source`. The `source`
             // is the association on the model that has now been joined. In our example,
@@ -1322,6 +1336,8 @@ class KyselyQueryDriver extends Base_js_1.default {
                     previousAssociationTableOrAlias: throughAssociation.as,
                     throughAssociations,
                     joinType,
+                    baseThroughAssociation,
+                    polymorphicCount,
                 });
             }
             else {
@@ -1351,7 +1367,7 @@ class KyselyQueryDriver extends Base_js_1.default {
             });
         const throughClass = throughAssociation.modelCB();
         if (Array.isArray(throughClass))
-            throw new CannotAssociateThroughPolymorphic_js_1.default({
+            throw new ArrayTargetsIncompatibleWithThroughAssociation_js_1.default({
                 dreamClass,
                 association,
             });
@@ -1375,18 +1391,23 @@ class KyselyQueryDriver extends Base_js_1.default {
      * the `through` association are only added when the recursion returns
      * back to the association that kicked off the through associations.
      */
-    applyOneJoin({ query, dreamClass, previousAssociationTableOrAlias, currentAssociationTableOrAlias, joinAndStatements = {}, throughAssociations = [], joinType, }) {
+    applyOneJoin({ query, dreamClass, previousAssociationTableOrAlias, currentAssociationTableOrAlias, joinAndStatements = {}, throughAssociations = [], joinType, baseThroughAssociation, polymorphicCount, }) {
         const { name, alias } = (0, extractAssociationMetadataFromAssociationName_js_1.default)(currentAssociationTableOrAlias);
         const joinAndStatement = joinAndStatements[currentAssociationTableOrAlias];
         previousAssociationTableOrAlias = (0, extractAssociationMetadataFromAssociationName_js_1.default)(previousAssociationTableOrAlias).alias;
         currentAssociationTableOrAlias = alias;
         let association = dreamClass['getAssociationMetadata'](name);
+        if (association?.polymorphic)
+            polymorphicCount.count++;
         if (!association) {
             throw new JoinAttemptedOnMissingAssociation_js_1.default({
                 dreamClass,
                 associationName: currentAssociationTableOrAlias,
             });
         }
+        baseThroughAssociation ??= association.through
+            ? association
+            : undefined;
         const results = this.joinsBridgeThroughAssociations({
             query,
             dreamClass,
@@ -1394,11 +1415,23 @@ class KyselyQueryDriver extends Base_js_1.default {
             previousAssociationTableOrAlias,
             throughAssociations,
             joinType,
+            baseThroughAssociation,
+            polymorphicCount,
         });
         query = results.query;
         dreamClass = results.dreamClass;
         association = results.association;
+        if (association?.polymorphic)
+            polymorphicCount.count++;
         const timeToApplyThroughAssociations = throughAssociations.length && throughAssociations[0]?.source === association.as;
+        const baseThroughAssociationToApply = association.polymorphic ? baseThroughAssociation : undefined;
+        if (baseThroughAssociationToApply && polymorphicCount.count > 1)
+            throw new CannotAssociateThroughMultiplePolymorphics_js_1.default({
+                dreamClass,
+                association,
+                innerJoinStatements: this.query['innerJoinStatements'],
+                leftJoinStatements: this.query['leftJoinStatements'],
+            });
         const originalPreviousAssociationTableOrAlias = previousAssociationTableOrAlias;
         previousAssociationTableOrAlias = results.previousAssociationTableOrAlias;
         const throughClass = results.throughClass;
@@ -1436,19 +1469,34 @@ class KyselyQueryDriver extends Base_js_1.default {
             });
         }
         if (association.type === 'BelongsTo') {
-            if (Array.isArray(association.modelCB()))
+            if (!baseThroughAssociationToApply && Array.isArray(association.modelCB()))
                 throw new CannotJoinPolymorphicBelongsToError_js_1.default({
                     dreamClass,
                     association,
                     innerJoinStatements: this.query['innerJoinStatements'],
                     leftJoinStatements: this.query['leftJoinStatements'],
                 });
-            const to = association.modelCB().table;
+            const to = (baseThroughAssociationToApply ?? association).modelCB().table;
             const joinTableExpression = currentAssociationTableOrAlias === to
                 ? currentAssociationTableOrAlias
                 : `${to} as ${currentAssociationTableOrAlias}`;
             query = query[(joinType === 'inner' ? 'innerJoin' : 'leftJoin')](joinTableExpression, (join) => {
-                join = join.onRef(this.namespaceColumn(association.foreignKey(), previousAssociationTableOrAlias), '=', this.namespaceColumn(association.primaryKey(), currentAssociationTableOrAlias));
+                join = join.onRef(this.namespaceColumn(association.foreignKey(), previousAssociationTableOrAlias), '=', this.namespaceColumn(association.primaryKey(undefined, {
+                    associatedClassOverride: baseThroughAssociationToApply?.modelCB(),
+                }), currentAssociationTableOrAlias));
+                if (baseThroughAssociationToApply) {
+                    /**
+                     * At this point, all `through` associations have been bridged and a
+                     * real association has been reached that is a polymorphic BelongsTo (it
+                     * is polymorphic and has an array of target models). Join with that
+                     * table conditionally based on the polymorphic foreign key type,
+                     * namespaced to the name of that association (which we know from the
+                     * target of the final `through` association)
+                     */
+                    join = join.on((eb) => this.whereStatementToExpressionWrapper(eb, this.aliasWhereStatement({
+                        [association.foreignKeyTypeField()]: baseThroughAssociationToApply.modelCB().sanitizedName,
+                    }, throughAssociations.at(-1).through)));
+                }
                 if (timeToApplyThroughAssociations) {
                     throughAssociations.forEach((throughAssociation) => {
                         join = this.applyAssociationAndStatementsToJoinStatement({
@@ -1464,6 +1512,7 @@ class KyselyQueryDriver extends Base_js_1.default {
                     join,
                     tableNameOrAlias: currentAssociationTableOrAlias,
                     association,
+                    throughAssociatedClassOverride: baseThroughAssociationToApply?.modelCB(),
                 });
                 join = this.applyJoinAndStatement(join, joinAndStatement, currentAssociationTableOrAlias);
                 return join;
@@ -1505,6 +1554,7 @@ class KyselyQueryDriver extends Base_js_1.default {
                     join,
                     tableNameOrAlias: currentAssociationTableOrAlias,
                     association,
+                    throughAssociatedClassOverride: baseThroughAssociationToApply?.modelCB(),
                 });
                 join = this.applyJoinAndStatement(join, joinAndStatement, currentAssociationTableOrAlias);
                 return join;
@@ -1594,9 +1644,9 @@ class KyselyQueryDriver extends Base_js_1.default {
         if (missingRequiredWhereStatements.length)
             throw new MissingRequiredAssociationAndClause_js_1.default(association, missingRequiredWhereStatements[0]);
     }
-    conditionallyApplyDefaultScopesDependentOnAssociation({ join, tableNameOrAlias, association, }) {
+    conditionallyApplyDefaultScopesDependentOnAssociation({ join, tableNameOrAlias, association, throughAssociatedClassOverride, }) {
         let scopesQuery = new Query_js_1.default(this.dreamInstance);
-        const associationClass = association.modelCB();
+        const associationClass = throughAssociatedClassOverride ?? association.modelCB();
         const associationScopes = associationClass['scopes'].default;
         for (const scope of associationScopes) {
             if (!(0, shouldBypassDefaultScope_js_1.default)(scope.method, {

package/dist/cjs/src/errors/associations/ArrayTargetsIncompatibleWithThroughAssociation.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ArrayTargetsIncompatibleWithThroughAssociation extends Error {
+    dreamClass;
+    association;
+    constructor({ dreamClass, association, }) {
+        super();
+        this.dreamClass = dreamClass;
+        this.association = association;
+    }
+    get message() {
+        return `
+Through associations may not define an array of targets:
+Dream class: ${this.dreamClass.sanitizedName}
+Association: ${this.association.as}
+`;
+    }
+}
+exports.default = ArrayTargetsIncompatibleWithThroughAssociation;

package/dist/cjs/src/errors/associations/CannotAssociateThroughMultiplePolymorphics.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class CannotAssociateThroughMultiplePolymorphics extends Error {
+    dreamClass;
+    association;
+    innerJoinStatements;
+    leftJoinStatements;
+    constructor({ dreamClass, association, innerJoinStatements, leftJoinStatements, }) {
+        super();
+        this.dreamClass = dreamClass;
+        this.association = association;
+        this.innerJoinStatements = innerJoinStatements;
+        this.leftJoinStatements = leftJoinStatements;
+    }
+    get message() {
+        return `
+Cannot associate through multiple polymorphic associations if one of them is a BelongsTo:
+Dream class: ${this.dreamClass.sanitizedName}
+Association: ${this.association.as}
+Inner Join statements:
+${JSON.stringify(this.innerJoinStatements, null, 2)}
+Left Join statements:
+${JSON.stringify(this.leftJoinStatements, null, 2)}
+    `;
+    }
+}
+exports.default = CannotAssociateThroughMultiplePolymorphics;

package/dist/cjs/src/errors/associations/MissingThroughAssociationSource.js

@@ -16,7 +16,7 @@ class MissingThroughAssociationSource extends Error {
 
 \`${this.dreamClass.sanitizedName}\` association \`${this.association.through}\` points to \`${this.throughClass.sanitizedName}\`.
 
-Dream expects association \`${this.association.source}\` to be defiend on \`${this.throughClass.sanitizedName}\`, but \`${this.throughClass.sanitizedName}\` does not define association \`${this.association.source}\`.
+Dream expects association \`${this.association.source}\` to be defined on \`${this.throughClass.sanitizedName}\`, but \`${this.throughClass.sanitizedName}\` does not define association \`${this.association.source}\`.
 
 There are two possible fixes:
 

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const kysely_1 = require("kysely");
 const fs = require("node:fs/promises");
 const path = require("node:path");
+const CliFileWriter_js_1 = require("../../cli/CliFileWriter.js");
 const dataTypes_js_1 = require("../../db/dataTypes.js");
 const index_js_1 = require("../../db/index.js");
 const index_js_2 = require("../../dream-app/index.js");
@@ -51,7 +52,7 @@ export const globalSchema = {
         // ${schemaConstContent}
         // `
         const schemaPath = path.join(dreamApp.projectRoot, dreamApp.paths.types, 'dream.ts');
-        await fs.writeFile(schemaPath, newSchemaFileContents);
+        await CliFileWriter_js_1.CliFileWriter.write(schemaPath, newSchemaFileContents);
     }
     globalModelNames() {
         const dreamApp = index_js_2.default.getOrFail();

package/dist/cjs/src/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sharedPathPrefix = exports.relativeDreamPath = exports.dreamPath = exports.pascalize = exports.normalizeUnicode = exports.loadRepl = exports.isEmpty = exports.intersection = exports.hyphenize = exports.groupBy = exports.globalClassNameFromFullyQualifiedModelName = exports.Env = exports.DreamLogos = exports.DateTime = exports.compact = exports.cloneDeepSafe = exports.generateDream = exports.capitalize = exports.camelize = exports.CalendarDate = exports.Benchmark = exports.ValidationError = exports.RecordNotFound = exports.GlobalNameNotSet = exports.CreateOrFindByFailedToCreateAndFind = exports.NonLoadedAssociation = exports.Encrypt = exports.Query = exports.DreamTransaction = exports.openapiShorthandPrimitiveTypes = exports.openapiPrimitiveTypes = exports.DreamConst = exports.Dream = exports.DreamAppAllowedPackageManagersEnumValues = exports.DreamApp = exports.lookupClassByGlobalName = exports.DreamImporter = exports.Decorators = exports.STI = exports.SoftDelete = exports.ReplicaSafe = exports.validateTable = exports.validateColumn = exports.DreamMigrationHelpers = exports.untypedDb = exports.pgErrorType = exports.dreamDbConnections = exports.closeAllDbConnections = exports.DreamCLI = exports.DreamBin = void 0;
-exports.ObjectSerializerBuilder = exports.DreamSerializerBuilder = exports.ObjectSerializer = exports.DreamSerializer = exports.serializerNameFromFullyQualifiedModelName = exports.isDreamSerializer = exports.inferSerializersFromDreamClassOrViewModelClass = exports.inferSerializerFromDreamOrViewModel = exports.ops = exports.uniq = exports.uncapitalize = exports.expandStiClasses = exports.standardizeFullyQualifiedModelName = exports.sortObjectByValue = exports.sortObjectByKey = exports.sortBy = exports.sort = exports.snakeify = exports.round = exports.range = exports.Range = void 0;
+exports.relativeDreamPath = exports.dreamPath = exports.pascalize = exports.normalizeUnicode = exports.loadRepl = exports.isEmpty = exports.intersection = exports.hyphenize = exports.groupBy = exports.globalClassNameFromFullyQualifiedModelName = exports.Env = exports.DreamLogos = exports.DateTime = exports.compact = exports.cloneDeepSafe = exports.generateDream = exports.capitalize = exports.camelize = exports.CalendarDate = exports.Benchmark = exports.ValidationError = exports.RecordNotFound = exports.GlobalNameNotSet = exports.CreateOrFindByFailedToCreateAndFind = exports.NonLoadedAssociation = exports.Encrypt = exports.Query = exports.DreamTransaction = exports.openapiShorthandPrimitiveTypes = exports.openapiPrimitiveTypes = exports.DreamConst = exports.Dream = exports.DreamAppAllowedPackageManagersEnumValues = exports.DreamApp = exports.lookupClassByGlobalName = exports.DreamImporter = exports.Decorators = exports.STI = exports.SoftDelete = exports.ReplicaSafe = exports.validateTable = exports.validateColumn = exports.DreamMigrationHelpers = exports.untypedDb = exports.pgErrorType = exports.dreamDbConnections = exports.closeAllDbConnections = exports.DreamCLI = exports.CliFileWriter = exports.DreamBin = void 0;
+exports.ObjectSerializerBuilder = exports.DreamSerializerBuilder = exports.ObjectSerializer = exports.DreamSerializer = exports.serializerNameFromFullyQualifiedModelName = exports.isDreamSerializer = exports.inferSerializersFromDreamClassOrViewModelClass = exports.inferSerializerFromDreamOrViewModel = exports.ops = exports.uniq = exports.uncapitalize = exports.expandStiClasses = exports.standardizeFullyQualifiedModelName = exports.sortObjectByValue = exports.sortObjectByKey = exports.sortBy = exports.sort = exports.snakeify = exports.round = exports.range = exports.Range = exports.sharedPathPrefix = void 0;
 var index_js_1 = require("./bin/index.js");
 Object.defineProperty(exports, "DreamBin", { enumerable: true, get: function () { return index_js_1.default; } });
+var CliFileWriter_js_1 = require("./cli/CliFileWriter.js");
+Object.defineProperty(exports, "CliFileWriter", { enumerable: true, get: function () { return CliFileWriter_js_1.CliFileWriter; } });
 var index_js_2 = require("./cli/index.js");
 Object.defineProperty(exports, "DreamCLI", { enumerable: true, get: function () { return index_js_2.default; } });
 var DreamDbConnection_js_1 = require("./db/DreamDbConnection.js");

package/dist/esm/src/bin/helpers/sync.js

@@ -9,11 +9,13 @@ import EnvInternal from '../../helpers/EnvInternal.js';
 import dreamPath from '../../helpers/path/dreamPath.js';
 import snakeify from '../../helpers/snakeify.js';
 import sspawn from '../../helpers/sspawn.js';
+import { CliFileWriter } from '../../cli/CliFileWriter.js';
 export default async function writeSyncFile() {
     const dreamApp = DreamApp.getOrFail();
     const dbConf = dreamApp.dbConnectionConfig('primary');
     const dbSyncFilePath = path.join(dreamPath('types'), 'db.ts');
     const absoluteDbSyncPath = path.join(dreamApp.projectRoot, dbSyncFilePath);
+    await CliFileWriter.cache(absoluteDbSyncPath);
     await sspawn(`kysely-codegen --dialect=postgres --url=postgres://${dbConf.user}:${dbConf.password}@${dbConf.host}:${dbConf.port}/${dbConf.name} --out-file=${absoluteDbSyncPath}`, {
         onStdout: message => {
             DreamCLI.logger.logContinueProgress(colorize(`[db]`, { color: 'cyan' }) + ' ' + message, {
@@ -25,7 +27,7 @@ export default async function writeSyncFile() {
     // from the dist folder, whereas dirname here is pointing to true src folder.
     const file = (await fs.readFile(absoluteDbSyncPath)).toString();
     const enhancedSchema = enhanceSchema(file);
-    await fs.writeFile(absoluteDbSyncPath, enhancedSchema);
+    await CliFileWriter.write(absoluteDbSyncPath, enhancedSchema);
 }
 // begin: schema helpers
 function enhanceSchema(file) {

package/dist/esm/src/cli/CliFileWriter.js

@@ -0,0 +1,35 @@
+import * as fs from 'node:fs/promises';
+import DreamCLI from './index.js';
+export class CliFileWriter {
+    static async write(filepath, contents) {
+        await cliFileWriter.write(filepath, contents);
+    }
+    static async revert() {
+        await cliFileWriter.revert();
+    }
+    static async cache(filepath) {
+        await cliFileWriter.cache(filepath);
+    }
+    fileCache = {};
+    async write(filepath, contents) {
+        // if we have manually backed up this file, or else this file
+        // has been written to twice in one CLI session, we want
+        // to preserve the original backup, so we do not attempt
+        // to cache a second time
+        if (!this.fileCache[filepath])
+            await this.cache(filepath);
+        await fs.writeFile(filepath, contents);
+    }
+    async revert() {
+        const filepaths = Object.keys(this.fileCache);
+        for (const filepath of filepaths) {
+            DreamCLI.logger.logContinueProgress(`reverting ${filepath}`);
+            await fs.writeFile(filepath, this.fileCache[filepath]);
+        }
+    }
+    async cache(filepath) {
+        const originalContents = (await fs.readFile(filepath)).toString();
+        this.fileCache[filepath] = originalContents;
+    }
+}
+const cliFileWriter = new CliFileWriter();

package/dist/esm/src/cli/logger/DreamCliLogger.js

@@ -8,6 +8,11 @@ export default class DreamCliLogger {
         });
         loggable.render();
     }
+    async logProgress(text, cb, { logPrefix = '✺ ┌', logPrefixColor, logPrefixBgColor } = {}) {
+        this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
+        await cb();
+        this.logEndProgress();
+    }
     logStartProgress(text, { logPrefix = '✺ ┌', logPrefixColor, logPrefixBgColor } = {}) {
         this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
     }

package/dist/esm/src/decorators/field/association/shared.js

@@ -89,12 +89,12 @@ export function applyGetterAndSetter(target, partialAssociation, { foreignKeyBas
 export function associationPrimaryKeyAccessors(partialAssociation, dreamClass) {
     return {
         ...partialAssociation,
-        primaryKey(associationInstance) {
+        primaryKey(associationInstance, { associatedClassOverride } = {}) {
             if (this.primaryKeyOverride)
                 return this.primaryKeyOverride;
             if (associationInstance)
                 return associationInstance.primaryKey;
-            const associationClass = this.modelCB();
+            const associationClass = associatedClassOverride ?? this.modelCB();
             if (Array.isArray(associationClass)) {
                 throw new Error(`
 Cannot lookup primaryKey on polymorphic association: