@rvoh/dream 0.31.0 → 0.31.2

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

@@ -2,6 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnsupportedValueFromComparisonFunction = void 0;
 exports.default = sortBy;
+/**
+ * Returns a copy of the array, sorted by the value returned by calling the function in the second argument on each element in the array
+ * Returns a copy of the array sorted by the return value of the function passed as the second argument.
+ * ```ts
+ * import { sortBy } from '@rvoh/dream'
+ *
+ * sortBy(['aaa', 'a', 'aa'], (str: string) => str.length)
+ * // ['a', 'aa', 'aaa']
+ *
+ * sortBy(['aaa', 'a', 'aa'], (str: string) => -str.length)
+ * // ['aaa', 'aa', 'a']
+ *
+ * sortBy([5, 3, 7], (num: number) => num)
+ * // [3, 5, 7]
+ *
+ * sortBy([5, 3, 7], (num: number) => -num)
+ * // [7, 5, 3]
+ * ```
+ */
 function sortBy(array, valueToCompare) {
     const arrayClone = [...array];
     return arrayClone.sort((a, b) => {
@@ -11,8 +30,6 @@ function sortBy(array, valueToCompare) {
             return aPrime.localeCompare(bPrime);
         if (typeof aPrime === 'number' && typeof bPrime === 'number')
             return aPrime - bPrime;
-        if (typeof aPrime === 'bigint' && typeof bPrime === 'bigint')
-            return aPrime.toString().localeCompare(bPrime.toString());
         throw new UnsupportedValueFromComparisonFunction(aPrime, bPrime);
     });
 }

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

@@ -7,15 +7,41 @@ function sspawn(command, opts = {}) {
     return new Promise((accept, reject) => {
         ssspawn(command, opts).on('close', code => {
             if (code !== 0)
-                reject(new Error(code?.toString()));
+                reject(code);
             accept({});
         });
     });
 }
 function ssspawn(command, opts = {}) {
-    return (0, child_process_1.spawn)(command, {
-        stdio: 'inherit',
+    const proc = (0, child_process_1.spawn)(command, {
+        // even though github security scans want to remove this,
+        // it is necessary to allow the cli util to run as the current
+        // user. This is only done to provision a new psychic application,
+        // so it is safe from unknown execution contexts.
         shell: true,
         ...opts,
     });
+    // NOTE: adding this stdout spy so that
+    // when this cli utility runs node commands,
+    // it can properly hijack the stdout from the command
+    proc.stdout.on('data', chunk => {
+        const txt = chunk?.toString()?.trim();
+        if (typeof txt !== 'string' || !txt)
+            return;
+        if (opts?.onStdout) {
+            opts?.onStdout?.(txt);
+        }
+        else {
+            console.log(txt);
+        }
+    });
+    proc.stdout.on('error', err => {
+        console.log('sspawn error!');
+        console.error(err);
+    });
+    proc.on('error', err => {
+        console.log('sspawn error!');
+        console.error(err);
+    });
+    return proc;
 }

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

@@ -4,17 +4,18 @@ exports.default = uniq;
 function uniq(arr, toKey = undefined) {
     if (toKey)
         return uniqWith(arr, toKey);
-    else if (arr[0]?.isDreamInstance)
-        return uniqWith(arr, dreamKey);
-    else
-        return Array.from(new Set(arr));
+    return uniqWith(arr, a => String(a));
 }
 function dreamKey(dream) {
     return `${dream.constructor.globalName}:${dream.primaryKeyValue}`;
 }
 function uniqWith(arr, toKey) {
     const map = arr.reduce((acc, val) => {
-        acc[toKey(val)] ||= val;
+        // Prefix with underscore to ensure that the values cannot be interpreted as integers.
+        // If they can be interpreted as integers, then the keys are ordered not by the
+        // order in which they were added, but in ascending numerical order.
+        const key = val?.isDreamInstance ? dreamKey(val) : `_${toKey(val)}`;
+        acc[key] ||= val;
         return acc;
     }, {});
     return Object.values(map);

package/dist/cjs/src/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.round = exports.range = exports.Range = exports.sharedPathPrefix = exports.relativeDreamPath = exports.dreamPath = exports.pascalize = exports.loadRepl = exports.isEmpty = exports.inferSerializerFromDreamOrViewModel = exports.inferSerializerFromDreamClassOrViewModelClass = exports.hyphenize = exports.globalClassNameFromFullyQualifiedModelName = exports.Env = exports.DreamGlam = exports.debug = exports.DateTime = exports.compact = exports.generateDream = exports.capitalize = exports.camelize = exports.CalendarDate = exports.Benchmark = exports.ValidationError = exports.RecordNotFound = exports.GlobalNameNotSet = exports.CreateOrFindByFailedToCreateAndFind = exports.NonLoadedAssociation = exports.Encrypt = exports.DreamConst = exports.Query = exports.DreamTransaction = exports.Dream = exports.DreamApplication = exports.lookupClassByGlobalName = exports.DreamImporter = exports.Decorators = exports.STI = exports.SoftDelete = exports.ReplicaSafe = exports.validateTable = exports.validateColumn = exports.DreamMigrationHelpers = exports.db = exports.pgErrorType = exports.dreamDbConnections = exports.DreamDbConnection = exports.closeAllDbConnections = exports.DreamCLI = exports.DreamBin = void 0;
-exports.DreamSerializer = exports.Attribute = exports.RendersOne = exports.RendersMany = exports.ops = exports.openapiShorthandPrimitiveTypes = exports.openapiPrimitiveTypes = exports.uniq = exports.uncapitalize = exports.standardizeFullyQualifiedModelName = exports.sortBy = exports.snakeify = exports.serializerNameFromFullyQualifiedModelName = void 0;
+exports.Range = exports.sharedPathPrefix = exports.relativeDreamPath = exports.dreamPath = exports.pascalize = exports.loadRepl = exports.isEmpty = exports.inferSerializerFromDreamOrViewModel = exports.inferSerializerFromDreamClassOrViewModelClass = exports.hyphenize = exports.globalClassNameFromFullyQualifiedModelName = exports.Env = exports.DreamGlam = exports.debug = exports.DateTime = exports.compact = 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.DreamApplication = exports.lookupClassByGlobalName = exports.DreamImporter = exports.Decorators = exports.STI = exports.SoftDelete = exports.ReplicaSafe = exports.validateTable = exports.validateColumn = exports.DreamMigrationHelpers = exports.db = exports.pgErrorType = exports.dreamDbConnections = exports.DreamDbConnection = exports.closeAllDbConnections = exports.DreamCLI = exports.DreamBin = void 0;
+exports.DreamSerializer = exports.Attribute = exports.RendersOne = exports.RendersMany = exports.ops = exports.uniq = exports.uncapitalize = exports.standardizeFullyQualifiedModelName = exports.sortBy = exports.sort = exports.snakeify = exports.serializerNameFromFullyQualifiedModelName = exports.round = exports.range = void 0;
 var index_js_1 = require("./bin/index.js");
 Object.defineProperty(exports, "DreamBin", { enumerable: true, get: function () { return index_js_1.default; } });
 var index_js_2 = require("./cli/index.js");
@@ -36,12 +36,14 @@ var index_js_4 = require("./dream-application/index.js");
 Object.defineProperty(exports, "DreamApplication", { enumerable: true, get: function () { return index_js_4.default; } });
 var Dream_js_1 = require("./Dream.js");
 Object.defineProperty(exports, "Dream", { enumerable: true, get: function () { return Dream_js_1.default; } });
+var constants_js_1 = require("./dream/constants.js");
+Object.defineProperty(exports, "DreamConst", { enumerable: true, get: function () { return constants_js_1.DreamConst; } });
+Object.defineProperty(exports, "openapiPrimitiveTypes", { enumerable: true, get: function () { return constants_js_1.openapiPrimitiveTypes; } });
+Object.defineProperty(exports, "openapiShorthandPrimitiveTypes", { enumerable: true, get: function () { return constants_js_1.openapiShorthandPrimitiveTypes; } });
 var DreamTransaction_js_1 = require("./dream/DreamTransaction.js");
 Object.defineProperty(exports, "DreamTransaction", { enumerable: true, get: function () { return DreamTransaction_js_1.default; } });
 var Query_js_1 = require("./dream/Query.js");
 Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return Query_js_1.default; } });
-var types_js_1 = require("./dream/types.js");
-Object.defineProperty(exports, "DreamConst", { enumerable: true, get: function () { return types_js_1.DreamConst; } });
 var index_js_5 = require("./encrypt/index.js");
 Object.defineProperty(exports, "Encrypt", { enumerable: true, get: function () { return index_js_5.default; } });
 var NonLoadedAssociation_js_1 = require("./errors/associations/NonLoadedAssociation.js");
@@ -102,6 +104,8 @@ var serializerNameFromFullyQualifiedModelName_js_1 = require("./helpers/serializ
 Object.defineProperty(exports, "serializerNameFromFullyQualifiedModelName", { enumerable: true, get: function () { return serializerNameFromFullyQualifiedModelName_js_1.default; } });
 var snakeify_js_1 = require("./helpers/snakeify.js");
 Object.defineProperty(exports, "snakeify", { enumerable: true, get: function () { return snakeify_js_1.default; } });
+var sort_js_1 = require("./helpers/sort.js");
+Object.defineProperty(exports, "sort", { enumerable: true, get: function () { return sort_js_1.default; } });
 var sortBy_js_1 = require("./helpers/sortBy.js");
 Object.defineProperty(exports, "sortBy", { enumerable: true, get: function () { return sortBy_js_1.default; } });
 var standardizeFullyQualifiedModelName_js_1 = require("./helpers/standardizeFullyQualifiedModelName.js");
@@ -110,9 +114,6 @@ var uncapitalize_js_1 = require("./helpers/uncapitalize.js");
 Object.defineProperty(exports, "uncapitalize", { enumerable: true, get: function () { return uncapitalize_js_1.default; } });
 var uniq_js_1 = require("./helpers/uniq.js");
 Object.defineProperty(exports, "uniq", { enumerable: true, get: function () { return uniq_js_1.default; } });
-var types_js_2 = require("./openapi/types.js");
-Object.defineProperty(exports, "openapiPrimitiveTypes", { enumerable: true, get: function () { return types_js_2.openapiPrimitiveTypes; } });
-Object.defineProperty(exports, "openapiShorthandPrimitiveTypes", { enumerable: true, get: function () { return types_js_2.openapiShorthandPrimitiveTypes; } });
 var index_js_6 = require("./ops/index.js");
 Object.defineProperty(exports, "ops", { enumerable: true, get: function () { return index_js_6.default; } });
 var RendersMany_js_1 = require("./serializer/decorators/associations/RendersMany.js");

package/dist/cjs/src/ops/ops-statement.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const types_js_1 = require("../dream/types.js");
+const constants_js_1 = require("../dream/constants.js");
 const ScoreMustBeANormalNumber_js_1 = require("../errors/ops/ScoreMustBeANormalNumber.js");
 class OpsStatement {
     operator;
@@ -24,10 +24,10 @@ class OpsStatement {
         return true;
     }
     get shouldBypassWhereStatement() {
-        return types_js_1.TRIGRAM_OPERATORS.includes(this.operator);
+        return constants_js_1.TRIGRAM_OPERATORS.includes(this.operator);
     }
     get minTrigramScore() {
-        if (types_js_1.TRIGRAM_OPERATORS.includes(this.operator)) {
+        if (constants_js_1.TRIGRAM_OPERATORS.includes(this.operator)) {
             return this.extraArgs?.score;
         }
         else {

package/dist/cjs/src/serializer/decorators/associations/RendersMany.js

@@ -16,12 +16,12 @@ const shared_js_1 = require("./shared.js");
  *
  * ```ts
  * class User extends ApplicationModel {
- *   @Deco.HasOne('Settings')
+ *   @deco.HasOne('Settings')
  *   public settings: Settings
  * }
  *
  * class Post extends ApplicationModel {
- *   @Deco.BelongsTo('User')
+ *   @deco.BelongsTo('User')
  *   public user: User
  * }
  *

package/dist/cjs/src/serializer/decorators/associations/RendersOne.js

@@ -16,12 +16,12 @@ const shared_js_1 = require("./shared.js");
  *
  * ```ts
  * class User extends ApplicationModel {
- *   @Deco.HasOne('Settings')
+ *   @deco.HasOne('Settings')
  *   public settings: Settings
  * }
  *
  * class Settings extends ApplicationModel {
- *   @Deco.BelongsTo('User')
+ *   @deco.BelongsTo('User')
  *   public user: User
  * }
  *

package/dist/cjs/src/serializer/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_js_1 = require("../dream-application/index.js");
-const types_js_1 = require("../dream/types.js");
+const constants_js_1 = require("../dream/constants.js");
 const GlobalNameNotSet_js_1 = require("../errors/dream-application/GlobalNameNotSet.js");
 const MissingSerializersDefinition_js_1 = require("../errors/MissingSerializersDefinition.js");
 const FailedToRenderThroughAssociationForSerializer_js_1 = require("../errors/serializers/FailedToRenderThroughAssociationForSerializer.js");
@@ -213,7 +213,7 @@ class DreamSerializer {
         return new SerializerClass(associatedData).absorbPassthrough(this).render();
     }
     associatedData(associationStatement) {
-        const delegateToPassthroughData = associationStatement.source === types_js_1.DreamConst.passthrough;
+        const delegateToPassthroughData = associationStatement.source === constants_js_1.DreamConst.passthrough;
         let self = (delegateToPassthroughData ? this.$passthroughData : this.$data);
         if (associationStatement.through) {
             const throughField = associationStatement.through;

package/dist/esm/src/Dream.js

@@ -1,7 +1,7 @@
 import { pgErrorType } from './db/errors.js';
 import db from './db/index.js';
 import associationToGetterSetterProp from './decorators/field/association/associationToGetterSetterProp.js';
-import { blankAssociationsFactory, } from './decorators/field/association/shared.js';
+import { blankAssociationsFactory } from './decorators/field/association/shared.js';
 import { blankHooksFactory } from './decorators/field/lifecycle/shared.js';
 import resortAllRecords from './decorators/field/sortable/helpers/resortAllRecords.js';
 import DreamClassTransactionBuilder from './dream/DreamClassTransactionBuilder.js';
@@ -161,9 +161,9 @@ export default class Dream {
      * @internal
      *
      * Model storage for association metadata, set when using the association decorators like:
-     *   @Deco.HasOne
-     *   @Deco.HasMany
-     *   @Deco.BelongsTo
+     *   @deco.HasOne
+     *   @deco.HasMany
+     *   @deco.BelongsTo
      */
     static associationMetadataByType = blankAssociationsFactory(this, {
         freeze: true,
@@ -369,9 +369,8 @@ export default class Dream {
         return this.constructor.stiBaseClassOrOwnClassName;
     }
     /**
-     * @internal
-     *
-     * Shadows .sanitizedName. Returns a string
+     * this.constructor.name may be prefixed with an underscore during conversion to Javascript.
+     * This method returns the constructor name without a leading underscore.
      *
      * @returns A string
      */
@@ -1134,7 +1133,7 @@ export default class Dream {
      *
      * ```ts
      * class Post extends ApplicationModel {
-     *   @Deco.Sortable({ scope: ['user']})
+     *   @deco.Sortable({ scope: ['user']})
      *   public position: DreamColumn<User, 'position'>
      * }
      *
@@ -1164,7 +1163,7 @@ export default class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Scope()
+     *   @deco.Scope()
      *   public visible(query: Query<User>) {
      *     return query.where({ hidden: false })
      *   }
@@ -1289,10 +1288,10 @@ export default class Dream {
      *
      * ```ts
      * class Post {
-     *   @Deco.HasMany('LocalizedText')
+     *   @deco.HasMany('LocalizedText')
      *   public localizedTexts: LocalizedText[]
      *
-     *   @Deco.HasOne('LocalizedText', {
+     *   @deco.HasOne('LocalizedText', {
      *     where: { locale: DreamConst.passthrough },
      *   })
      *   public currentLocalizedText: LocalizedText
@@ -1632,7 +1631,7 @@ export default class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Validates('presence')
+     *   @deco.Validates('presence')
      *   public email: DreamColumn<User, 'email'>
      * }
      * const user = User.new()
@@ -1678,7 +1677,7 @@ export default class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Validates('presence')
+     *   @deco.Validates('presence')
      *   public email: DreamColumn<User, 'email'>
      * }
      *
@@ -2069,7 +2068,7 @@ export default class Dream {
      * ```ts
      *  class User extends ApplicationModel {
      *    ...
-     *    @Deco.Validate()
+     *    @deco.Validate()
      *    public async validateName() {
      *      if (typeof this.name === 'number')
      *        this.addError('name', 'name cannot be a number')
@@ -2697,10 +2696,10 @@ export default class Dream {
      *
      * ```ts
      * class Post {
-     *   @Deco.HasMany('LocalizedText')
+     *   @deco.HasMany('LocalizedText')
      *   public localizedTexts: LocalizedText[]
      *
-     *   @Deco.HasOne('LocalizedText', {
+     *   @deco.HasOne('LocalizedText', {
      *     where: { locale: DreamConst.passthrough },
      *   })
      *   public currentLocalizedText: LocalizedText
@@ -2997,7 +2996,7 @@ export default class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.BeforeDestroy()
+     *   @deco.BeforeDestroy()
      *   public softDelete() {
      *     await this.update({ deletedAt: DateTime.now() })
      *     this.preventDeletion()
@@ -3018,13 +3017,13 @@ export default class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.BeforeDestroy()
+     *   @deco.BeforeDestroy()
      *   public async softDelete() {
      *     await this.update({ deletedAt: DateTime.now() })
      *     this.preventDeletion()
      *   }
      *
-     *   @Deco.BeforeDestroy()
+     *   @deco.BeforeDestroy()
      *   public async undoSoftDelete() {
      *     await this.update({ deletedAt: null })
      *     this.unpreventDeletion()

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

@@ -9,18 +9,25 @@ 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 DreamCLI from '../../cli/index.js';
+import colorize from '../../cli/logger/loggable/colorize.js';
 export default async function writeSyncFile() {
     const dbConf = new ConnectionConfRetriever().getConnectionConf('primary');
     const dreamApp = DreamApplication.getOrFail();
     const dbSyncFilePath = path.join(dreamPath('types'), 'db.ts');
     const absoluteDbSyncPath = path.join(dreamApp.projectRoot, dbSyncFilePath);
-    await sspawn(`kysely-codegen --url=postgres://${dbConf.user}:${dbConf.password}@${dbConf.host}:${dbConf.port}/${dbConf.name} --out-file=${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, {
+                logPrefixColor: 'cyan',
+            });
+        },
+    });
     // intentionally bypassing helpers here, since they often end up referencing
     // 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);
-    DreamApplication.log('done writing dream sync file!');
 }
 // begin: schema helpers
 function enhanceSchema(file) {
@@ -55,8 +62,8 @@ export type Timestamp = ColumnType<DateTime | CalendarDate>`);
 }
 function addCustomImports(file) {
     const customImports = EnvInternal.boolean('DREAM_CORE_DEVELOPMENT')
-        ? "import CalendarDate from '../../src/helpers/CalendarDate.js'\nimport { DateTime } from '../../src/helpers/DateTime.js'"
-        : "import { CalendarDate, DateTime } from '@rvoh/dream'";
+        ? "import type CalendarDate from '../../src/helpers/CalendarDate.js'\nimport { type DateTime } from '../../src/helpers/DateTime.js'"
+        : "import { type CalendarDate, type DateTime } from '@rvoh/dream'";
     return `${autogeneratedFileDisclaimer()}${customImports}
 ${file}`;
 }

package/dist/esm/src/bin/index.js

@@ -13,20 +13,25 @@ import sspawn from '../helpers/sspawn.js';
 import writeSyncFile from './helpers/sync.js';
 export default class DreamBin {
     static async sync(onSync) {
+        DreamCLI.logger.logStartProgress('writing db schema...');
         await writeSyncFile();
+        DreamCLI.logger.logEndProgress();
+        DreamCLI.logger.logStartProgress('building dream schema...');
         await this.buildDreamSchema();
+        DreamCLI.logger.logEndProgress();
+        DreamCLI.logger.logStartProgress('running sync hooks...');
         await onSync();
+        DreamCLI.logger.logEndProgress();
     }
     static async buildDreamSchema() {
-        const spinner = DreamCLI.logger.log('writing dream schema...', { spinner: true });
         await new SchemaBuilder().build();
-        spinner.stop();
     }
     static async dbCreate() {
         const connectionRetriever = new ConnectionConfRetriever();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = DreamCLI.logger.log(`creating ${primaryDbConf.name}...`, { spinner: true });
+        DreamCLI.logger.logStartProgress(`creating ${primaryDbConf.name}...`);
         await createDb('primary');
+        DreamCLI.logger.logEndProgress();
         // TODO: add support for creating replicas. Began doing it below, but it is very tricky,
         // and we don't need it at the moment, so kicking off for future development when we have more time
         // to flesh this out.
@@ -35,13 +40,13 @@ export default class DreamBin {
         //   console.log(`creating ${process.env[replicaDbConf.name]}`)
         //   await createDb('replica')
         // }
-        spinner.stop();
     }
     static async dbDrop() {
         const connectionRetriever = new ConnectionConfRetriever();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = DreamCLI.logger.log(`dropping ${primaryDbConf.name}...`, { spinner: true });
+        DreamCLI.logger.logStartProgress(`dropping ${primaryDbConf.name}...`);
         await _dropDb('primary');
+        DreamCLI.logger.logEndProgress();
         // TODO: add support for dropping replicas. Began doing it below, but it is very tricky,
         // and we don't need it at the moment, so kicking off for future development when we have more time
         // to flesh this out.
@@ -50,27 +55,26 @@ export default class DreamBin {
         //   console.log(`dropping ${process.env[replicaDbConf.name]}`)
         //   await _dropDb('replica')
         // }
-        spinner.stop();
     }
     static async dbMigrate() {
         const connectionRetriever = new ConnectionConfRetriever();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = DreamCLI.logger.log(`migrating ${primaryDbConf.name}...`, { spinner: true });
+        DreamCLI.logger.logStartProgress(`migrating ${primaryDbConf.name}...`);
         await runMigration({ mode: 'migrate' });
         await this.duplicateDatabase();
-        spinner.stop();
+        DreamCLI.logger.logEndProgress();
     }
     static async dbRollback(opts) {
         const connectionRetriever = new ConnectionConfRetriever();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = DreamCLI.logger.log(`rolling back ${primaryDbConf.name}...`, { spinner: true });
+        DreamCLI.logger.logStartProgress(`rolling back ${primaryDbConf.name}...`);
         let step = opts.steps;
         while (step > 0) {
             await runMigration({ mode: 'rollback' });
             step -= 1;
         }
         await this.duplicateDatabase();
-        spinner.stop();
+        DreamCLI.logger.logEndProgress();
     }
     static async generateDream(fullyQualifiedModelName, columnsWithTypes, options) {
         await generateDream({ fullyQualifiedModelName, columnsWithTypes, options });
@@ -85,8 +89,9 @@ export default class DreamBin {
     // It is only made private so that people don't mistakenly try
     // to use it to generate docs for their apps.
     static async buildDocs() {
-        DreamCLI.logger.log('generating docs...');
+        DreamCLI.logger.logStartProgress('generating docs...');
         await sspawn('yarn typedoc src/index.ts --tsconfig ./tsconfig.esm.build.json --out docs');
+        DreamCLI.logger.logEndProgress();
     }
     static async duplicateDatabase() {
         const parallelTests = DreamApplication.getOrFail().parallelTests;
@@ -97,22 +102,16 @@ export default class DreamBin {
         const client = await loadPgClient({ useSystemDb: true });
         if (process.env.DREAM_CORE_DEVELOPMENT === '1') {
             const replicaTestWorkerDatabaseName = `replica_test_${dbConf.name}`;
-            const spinner = DreamCLI.logger.log(`creating fake replica test database ${replicaTestWorkerDatabaseName}...`, {
-                spinner: true,
-            });
+            DreamCLI.logger.logContinueProgress(`creating fake replica test database ${replicaTestWorkerDatabaseName}...`);
             await client.query(`DROP DATABASE IF EXISTS ${replicaTestWorkerDatabaseName};`);
             await client.query(`CREATE DATABASE ${replicaTestWorkerDatabaseName} TEMPLATE ${dbConf.name};`);
-            spinner.stop();
         }
         for (let i = 2; i <= parallelTests; i++) {
             const workerDatabaseName = `${dbConf.name}_${i}`;
             console.log(`creating duplicate test database ${workerDatabaseName} for concurrent tests`);
-            const spinner = DreamCLI.logger.log(`creating duplicate test database ${workerDatabaseName} for concurrent tests...`, {
-                spinner: true,
-            });
+            DreamCLI.logger.logContinueProgress(`creating duplicate test database ${workerDatabaseName} for concurrent tests...`);
             await client.query(`DROP DATABASE IF EXISTS ${workerDatabaseName};`);
             await client.query(`CREATE DATABASE ${workerDatabaseName} TEMPLATE ${dbConf.name};`);
-            spinner.stop();
         }
         await client.end();
     }

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

@@ -1,54 +1,20 @@
-import DreamCliLoggableSpinner from './loggable/DreamCliLoggableSpinner.js';
 import DreamCliLoggableText from './loggable/DreamCliLoggableText.js';
 export default class DreamCliLogger {
-    logs = [];
-    log(text, { permanent = false, spinner = false, logPrefix, logPrefixColor, logPrefixBgColor, spinnerPrefixColor = 'greenBright', spinnerPrefixBgColor, } = {}) {
-        const loggable = spinner
-            ? new DreamCliLoggableSpinner({
-                text,
-                permanent: false,
-                spinner: 'noise',
-                color: spinnerPrefixColor,
-                bgColor: spinnerPrefixBgColor,
-            })
-            : new DreamCliLoggableText(text, {
-                permanent,
-                logPrefix,
-                logPrefixColor: logPrefixColor || (permanent ? 'green' : 'yellow'),
-                logPrefixBgColor,
-            });
-        this.logs.push(loggable);
-        // re-render everything
-        this.render();
-        return loggable;
-    }
-    render() {
-        this.clear();
-        let skipNext = false;
-        this.logs.forEach(loggable => {
-            if (skipNext) {
-                skipNext = false;
-                return;
-            }
-            loggable.render();
+    log(text, { logPrefix, logPrefixColor, logPrefixBgColor } = {}) {
+        const loggable = new DreamCliLoggableText(text, {
+            logPrefix,
+            logPrefixColor: logPrefixColor || 'green',
+            logPrefixBgColor,
         });
+        loggable.render();
     }
-    get spinners() {
-        return this.logs.filter(log => log instanceof DreamCliLoggableSpinner);
+    logStartProgress(text, { logPrefix = '✺ ┌', logPrefixColor, logPrefixBgColor } = {}) {
+        this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
     }
-    /*
-     * remove all logs that are not marked permanent,
-     * then clear STDOUT and re-render with only
-     * the permanent logs remaining.
-     */
-    purge() {
-        this.logs = this.logs.filter(log => log.permanent);
-        this.render();
+    logContinueProgress(text, { logPrefix = '✺ ├', logPrefixColor, logPrefixBgColor } = {}) {
+        this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
     }
-    clear() {
-        console.clear();
-        // @ts-expect-error this works fine with no args provided
-        process.stdout.clearLine?.();
-        process.stdout.cursorTo?.(0);
+    logEndProgress(text = 'complete', { logPrefix = '✺ └', logPrefixColor, logPrefixBgColor } = {}) {
+        this.log(text, { logPrefix, logPrefixColor, logPrefixBgColor });
     }
 }

package/dist/esm/src/cli/logger/loggable/DreamCliLoggable.js

@@ -1,11 +1,9 @@
 import colorize from './colorize.js';
 export default class DreamCliLoggable {
-    permanent;
     logPrefix;
     logPrefixColor;
     logPrefixBgColor;
-    constructor({ permanent, logPrefix = '✺', logPrefixColor, logPrefixBgColor, }) {
-        this.permanent = permanent;
+    constructor({ logPrefix = '✺', logPrefixColor, logPrefixBgColor, }) {
         this.logPrefix = logPrefix;
         this.logPrefixColor = logPrefixColor;
         this.logPrefixBgColor = logPrefixBgColor;

package/dist/esm/src/cli/logger/loggable/DreamCliLoggableText.js

@@ -4,8 +4,8 @@ export default class DreamCliLoggableText extends DreamCliLoggable {
     text;
     color;
     bgColor;
-    constructor(text, { permanent, logPrefix, color, bgColor, logPrefixColor, logPrefixBgColor, }) {
-        super({ permanent, logPrefix });
+    constructor(text, { logPrefix, color, bgColor, logPrefixColor, logPrefixBgColor, }) {
+        super({ logPrefix });
         this.text = text;
         this.color = color;
         this.bgColor = bgColor;