@rvoh/dream 0.31.0 → 0.31.2

package/README.md

@@ -42,22 +42,22 @@ const user = await User.where({ email: ops.like('%fred@%') })
 
 class Composition {
   ...
-  @Deco.BeforeCreate()
+  @deco.BeforeCreate()
   public setDefaultContent() {
     if (!this.content) this.content = 'default content'
   }
 
-  @Deco.AfterCreate()
+  @deco.AfterCreate()
   public conditionallyChangeContentOnCreate() {
     if (this.content === 'change me after create') this.content = 'changed after create'
   }
 
-  @Deco.AfterUpdate()
+  @deco.AfterUpdate()
   public conditionallyChangeContentOnUpdate() {
     if (this.content === 'change me after update') this.content = 'changed after update'
   }
 
-  @Deco.AfterSave()
+  @deco.AfterSave()
   public conditionallyChangeContentOnSave() {
     if (this.content === 'change me after save') this.content = 'changed after save'
   }
@@ -73,11 +73,11 @@ class Composition {
 ```ts
 export default class User extends Dream {
   ...
-  @Deco.Validates('contains', '@')
-  @Deco.Validates('presence')
+  @deco.Validates('contains', '@')
+  @deco.Validates('presence')
   public email: string
 
-  @Deco.Validates('length', { min: 4, max: 18 })
+  @deco.Validates('length', { min: 4, max: 18 })
   public password: string
   ...
 }
@@ -97,13 +97,13 @@ export default class User extends Dream {
 // models/user.ts
 class User {
   ...
-  @Deco.HasMany('Composition')
+  @deco.HasMany('Composition')
   public compositions: Composition[]
 
-  @Deco.HasOne('Composition')
+  @deco.HasOne('Composition')
   public mainComposition: Composition
 
-  @Deco.HasMany('CompositionAsset', {
+  @deco.HasMany('CompositionAsset', {
     through: 'compositions',
   })
   public compositionAssets: CompositionAsset[]
@@ -112,14 +112,14 @@ class User {
 // models/composition.ts
 export default class Composition extends Dream {
   ...
-  @Deco.BelongsTo('User')
+  @deco.BelongsTo('User')
   public user: User
 }
 
 // models/composition-asset.ts
 export default class CompositionAsset extends Dream {
   ...
-  @Deco.BelongsTo('Composition')
+  @deco.BelongsTo('Composition')
   public composition: Composition
   ...
 }
@@ -136,13 +136,13 @@ export default class CompositionAsset extends Dream {
 
 ```ts
 class User {
-  @Deco.Scope()
+  @deco.Scope()
   public static withFunnyName(query: Query<User>) {
     return query.where({ name: 'Chalupas jr' })
   }
 
   // this will always fire whenever queries are run against the model
-  @Deco.Scope({ default: true })
+  @deco.Scope({ default: true })
   public static hideDeleted(query: Query<User>) {
     return query.where({ deleted_at: null })
   }
@@ -354,18 +354,18 @@ const pets = await user
 ```ts
 @STI(A)
 class B extends A {
-  @Deco.HasMany('X')
+  @deco.HasMany('X')
   public xx: X[]
 }
 
 @STI(A)
 class C extends A {
-  @Deco.HasMany('X', { on: { something: true } })
+  @deco.HasMany('X', { on: { something: true } })
   public xx: X[]
 }
 
 class Z extends Dream {
-  @Deco.HasMany('A')
+  @deco.HasMany('A')
   public aa: A[]
 }
 

package/dist/cjs/src/Dream.js

@@ -163,9 +163,9 @@ 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 = (0, shared_js_1.blankAssociationsFactory)(this, {
         freeze: true,
@@ -371,9 +371,8 @@ 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
      */
@@ -1136,7 +1135,7 @@ class Dream {
      *
      * ```ts
      * class Post extends ApplicationModel {
-     *   @Deco.Sortable({ scope: ['user']})
+     *   @deco.Sortable({ scope: ['user']})
      *   public position: DreamColumn<User, 'position'>
      * }
      *
@@ -1166,7 +1165,7 @@ class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Scope()
+     *   @deco.Scope()
      *   public visible(query: Query<User>) {
      *     return query.where({ hidden: false })
      *   }
@@ -1291,10 +1290,10 @@ 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
@@ -1634,7 +1633,7 @@ class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Validates('presence')
+     *   @deco.Validates('presence')
      *   public email: DreamColumn<User, 'email'>
      * }
      * const user = User.new()
@@ -1680,7 +1679,7 @@ class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Validates('presence')
+     *   @deco.Validates('presence')
      *   public email: DreamColumn<User, 'email'>
      * }
      *
@@ -2071,7 +2070,7 @@ 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')
@@ -2699,10 +2698,10 @@ 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
@@ -2999,7 +2998,7 @@ class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.BeforeDestroy()
+     *   @deco.BeforeDestroy()
      *   public softDelete() {
      *     await this.update({ deletedAt: DateTime.now() })
      *     this.preventDeletion()
@@ -3020,13 +3019,13 @@ 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/cjs/src/bin/helpers/sync.js

@@ -12,18 +12,25 @@ 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 index_js_2 = require("../../cli/index.js");
+const colorize_js_1 = require("../../cli/logger/loggable/colorize.js");
 async function writeSyncFile() {
     const dbConf = new ConnectionConfRetriever_js_1.default().getConnectionConf('primary');
     const dreamApp = index_js_1.default.getOrFail();
     const dbSyncFilePath = path.join((0, dreamPath_js_1.default)('types'), 'db.ts');
     const absoluteDbSyncPath = path.join(dreamApp.projectRoot, dbSyncFilePath);
-    await (0, sspawn_js_1.default)(`kysely-codegen --url=postgres://${dbConf.user}:${dbConf.password}@${dbConf.host}:${dbConf.port}/${dbConf.name} --out-file=${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_2.default.logger.logContinueProgress((0, colorize_js_1.default)(`[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);
-    index_js_1.default.log('done writing dream sync file!');
 }
 // begin: schema helpers
 function enhanceSchema(file) {
@@ -58,8 +65,8 @@ export type Timestamp = ColumnType<DateTime | CalendarDate>`);
 }
 function addCustomImports(file) {
     const customImports = EnvInternal_js_1.default.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 `${(0, autogeneratedFileMessage_js_1.default)()}${customImports}
 ${file}`;
 }

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

@@ -15,20 +15,25 @@ const sspawn_js_1 = require("../helpers/sspawn.js");
 const sync_js_1 = require("./helpers/sync.js");
 class DreamBin {
     static async sync(onSync) {
+        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...');
         await this.buildDreamSchema();
+        index_js_1.default.logger.logEndProgress();
+        index_js_1.default.logger.logStartProgress('running sync hooks...');
         await onSync();
+        index_js_1.default.logger.logEndProgress();
     }
     static async buildDreamSchema() {
-        const spinner = index_js_1.default.logger.log('writing dream schema...', { spinner: true });
         await new SchemaBuilder_js_1.default().build();
-        spinner.stop();
     }
     static async dbCreate() {
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = index_js_1.default.logger.log(`creating ${primaryDbConf.name}...`, { spinner: true });
+        index_js_1.default.logger.logStartProgress(`creating ${primaryDbConf.name}...`);
         await (0, createDb_js_1.default)('primary');
+        index_js_1.default.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.
@@ -37,13 +42,13 @@ class DreamBin {
         //   console.log(`creating ${process.env[replicaDbConf.name]}`)
         //   await createDb('replica')
         // }
-        spinner.stop();
     }
     static async dbDrop() {
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = index_js_1.default.logger.log(`dropping ${primaryDbConf.name}...`, { spinner: true });
+        index_js_1.default.logger.logStartProgress(`dropping ${primaryDbConf.name}...`);
         await (0, dropDb_js_1.default)('primary');
+        index_js_1.default.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.
@@ -52,27 +57,26 @@ class DreamBin {
         //   console.log(`dropping ${process.env[replicaDbConf.name]}`)
         //   await _dropDb('replica')
         // }
-        spinner.stop();
     }
     static async dbMigrate() {
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = index_js_1.default.logger.log(`migrating ${primaryDbConf.name}...`, { spinner: true });
+        index_js_1.default.logger.logStartProgress(`migrating ${primaryDbConf.name}...`);
         await (0, runMigration_js_1.default)({ mode: 'migrate' });
         await this.duplicateDatabase();
-        spinner.stop();
+        index_js_1.default.logger.logEndProgress();
     }
     static async dbRollback(opts) {
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        const spinner = index_js_1.default.logger.log(`rolling back ${primaryDbConf.name}...`, { spinner: true });
+        index_js_1.default.logger.logStartProgress(`rolling back ${primaryDbConf.name}...`);
         let step = opts.steps;
         while (step > 0) {
             await (0, runMigration_js_1.default)({ mode: 'rollback' });
             step -= 1;
         }
         await this.duplicateDatabase();
-        spinner.stop();
+        index_js_1.default.logger.logEndProgress();
     }
     static async generateDream(fullyQualifiedModelName, columnsWithTypes, options) {
         await (0, generateDream_js_1.default)({ fullyQualifiedModelName, columnsWithTypes, options });
@@ -87,8 +91,9 @@ 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() {
-        index_js_1.default.logger.log('generating docs...');
+        index_js_1.default.logger.logStartProgress('generating docs...');
         await (0, sspawn_js_1.default)('yarn typedoc src/index.ts --tsconfig ./tsconfig.esm.build.json --out docs');
+        index_js_1.default.logger.logEndProgress();
     }
     static async duplicateDatabase() {
         const parallelTests = index_js_2.default.getOrFail().parallelTests;
@@ -99,22 +104,16 @@ class DreamBin {
         const client = await (0, loadPgClient_js_1.default)({ useSystemDb: true });
         if (process.env.DREAM_CORE_DEVELOPMENT === '1') {
             const replicaTestWorkerDatabaseName = `replica_test_${dbConf.name}`;
-            const spinner = index_js_1.default.logger.log(`creating fake replica test database ${replicaTestWorkerDatabaseName}...`, {
-                spinner: true,
-            });
+            index_js_1.default.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 = index_js_1.default.logger.log(`creating duplicate test database ${workerDatabaseName} for concurrent tests...`, {
-                spinner: true,
-            });
+            index_js_1.default.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/cjs/src/cli/logger/DreamCliLogger.js

@@ -1,57 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const DreamCliLoggableSpinner_js_1 = require("./loggable/DreamCliLoggableSpinner.js");
 const DreamCliLoggableText_js_1 = require("./loggable/DreamCliLoggableText.js");
 class DreamCliLogger {
-    logs = [];
-    log(text, { permanent = false, spinner = false, logPrefix, logPrefixColor, logPrefixBgColor, spinnerPrefixColor = 'greenBright', spinnerPrefixBgColor, } = {}) {
-        const loggable = spinner
-            ? new DreamCliLoggableSpinner_js_1.default({
-                text,
-                permanent: false,
-                spinner: 'noise',
-                color: spinnerPrefixColor,
-                bgColor: spinnerPrefixBgColor,
-            })
-            : new DreamCliLoggableText_js_1.default(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_js_1.default(text, {
+            logPrefix,
+            logPrefixColor: logPrefixColor || 'green',
+            logPrefixBgColor,
         });
+        loggable.render();
     }
-    get spinners() {
-        return this.logs.filter(log => log instanceof DreamCliLoggableSpinner_js_1.default);
+    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 });
     }
 }
 exports.default = DreamCliLogger;

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

@@ -2,12 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const colorize_js_1 = require("./colorize.js");
 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/cjs/src/cli/logger/loggable/DreamCliLoggableText.js

@@ -6,8 +6,8 @@ class DreamCliLoggableText extends DreamCliLoggable_js_1.default {
     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;