@rvoh/dream 0.31.1 → 0.31.2

package/dist/cjs/src/decorators/Decorators.js

@@ -29,13 +29,13 @@ class Decorators {
      *
      * ```ts
      * class UserSettings extends ApplicationModel {
-     *   @Deco.BelongsTo('User')
+     *   @deco.BelongsTo('User')
      *   public user: User
      *   public userId: DreamColumn<UserSettings, 'userId'>
      * }
      *
      * class User extends ApplicationModel {
-     *   @Deco.HasOne('UserSettings')
+     *   @deco.HasOne('UserSettings')
      *   public userSettings: UserSettings
      * }
      * ```
@@ -57,12 +57,12 @@ class Decorators {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.HasMany('Post')
+     *   @deco.HasMany('Post')
      *   public posts: Post[]
      * }
      *
      * class Post extends ApplicationModel {
-     *   @Deco.BelongsTo('User')
+     *   @deco.BelongsTo('User')
      *   public user: User
      *   public userId: DreamColumn<Post, 'userId'>
      * }
@@ -82,12 +82,12 @@ class Decorators {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.HasOne('UserSettings')
+     *   @deco.HasOne('UserSettings')
      *   public userSettings: UserSettings
      * }
      *
      * class UserSettings extends ApplicationModel {
-     *   @Deco.BelongsTo('User')
+     *   @deco.BelongsTo('User')
      *   public user: User
      *   public userId: DreamColumn<UserSettings, 'userId'>
      * }
@@ -110,14 +110,14 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.Encrypted()
+     *   @deco.Encrypted()
      *   // automatically sets `encryptedSsn` to the encrypted value that
      *   // `ssn` is set to in new/create/update, e.g., `await user.update({ ssn })`
      *   public ssn: string
      *
      *   // automatically sets `myEncryptedPhone` to the encrypted value that
      *   // `phone` is set to new/create/update, e.g., `await user.update({ phone })`
-     *   @Deco.Encrypted('myEncryptedPhone)
+     *   @deco.Encrypted('myEncryptedPhone)
      *   public phone: string
      * }
      * ```
@@ -134,7 +134,7 @@ class Decorators {
      *
      * ```ts
      * class Collar {
-     *   @Deco.Scope({ default: true })
+     *   @deco.Scope({ default: true })
      *   public static hideHiddenCollars(query: Query<Collar>) {
      *     return query.where({ hidden: false })
      *   }
@@ -156,7 +156,7 @@ class Decorators {
      *
      * ```ts
      * class Balloon {
-     *   @Deco.Sortable({ scope: 'user' })
+     *   @deco.Sortable({ scope: 'user' })
      *   public position: DreamColumn<Balloon, 'position'>
      * }
      * ```
@@ -174,7 +174,7 @@ class Decorators {
      *
      * ```ts
      * class Sandbag {
-     *   @Deco.Validate()
+     *   @deco.Validate()
      *   public validateWeight(this: Sandbag) {
      *     if (!this.weight) return
      *
@@ -199,7 +199,7 @@ class Decorators {
      *
      * ```ts
      * class Balloon {
-     *   @Deco.Validates('numericality', { min: 0, max: 100 })
+     *   @deco.Validates('numericality', { min: 0, max: 100 })
      *   public volume: DreamColumn<Balloon, 'volume'>
      * }
      * ```
@@ -233,7 +233,7 @@ class Decorators {
      *
      * ```ts
      * class BodyMeasurement {
-     *   @Deco.Virtual()
+     *   @deco.Virtual()
      *   public get lbs() {
      *     const self: User = this
      *     return gramsToLbs(self.getAttribute('grams') ?? 0)
@@ -244,7 +244,7 @@ class Decorators {
      *     self.setAttribute('grams', lbsToGrams(lbs))
      *   }
      *
-     *   @Deco.Virtual()
+     *   @deco.Virtual()
      *   public get kilograms() {
      *     const self: User = this
      *     return gramsToKilograms(self.getAttribute('grams') ?? 0)
@@ -260,10 +260,10 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.Virtual()
+     *   @deco.Virtual()
      *   public password: string
      *
-     *   @Deco.BeforeSave()
+     *   @deco.BeforeSave()
      *   public hasPassword() {
      *     this.setAttribute('hashedPassword', preferredHashingAlgorithm(this.password))
      *   }
@@ -280,7 +280,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.BeforeCreate()
+     *   @deco.BeforeCreate()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -298,7 +298,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.BeforeSave()
+     *   @deco.BeforeSave()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -316,7 +316,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.BeforeUpdate()
+     *   @deco.BeforeUpdate()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -334,7 +334,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.BeforeDestroy()
+     *   @deco.BeforeDestroy()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -351,7 +351,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterCreate()
+     *   @deco.AfterCreate()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -369,7 +369,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterCreateCommit()
+     *   @deco.AfterCreateCommit()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -386,7 +386,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterSave()
+     *   @deco.AfterSave()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -404,7 +404,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterSaveCommit()
+     *   @deco.AfterSaveCommit()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -422,7 +422,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterUpdate()
+     *   @deco.AfterUpdate()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -440,7 +440,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterUpdateCommit()
+     *   @deco.AfterUpdateCommit()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -458,7 +458,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterDestroy()
+     *   @deco.AfterDestroy()
      *   public doSomething() {
      *     console.log('hi!')
      *   }
@@ -476,7 +476,7 @@ class Decorators {
      *
      * ```ts
      * class User {
-     *   @Deco.AfterDestroyCommit()
+     *   @deco.AfterDestroyCommit()
      *   public doSomething() {
      *     console.log('hi!')
      *   }

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

@@ -11,13 +11,13 @@ const shared_js_1 = require("./shared.js");
  *
  * ```ts
  * class UserSettings extends ApplicationModel {
- *   @Deco.BelongsTo('User')
+ *   @deco.BelongsTo('User')
  *   public user: User
  *   public userId: DreamColumn<UserSettings, 'userId'>
  * }
  *
  * class User extends ApplicationModel {
- *   @Deco.HasOne('UserSettings')
+ *   @deco.HasOne('UserSettings')
  *   public userSettings: UserSettings
  * }
  * ```

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

@@ -10,12 +10,12 @@ const shared_js_1 = require("./shared.js");
  *
  * ```ts
  * class User extends ApplicationModel {
- *   @Deco.HasMany('Post')
+ *   @deco.HasMany('Post')
  *   public posts: Post[]
  * }
  *
  * class Post extends ApplicationModel {
- *   @Deco.BelongsTo('User')
+ *   @deco.BelongsTo('User')
  *   public user: User
  *   public userId: DreamColumn<Post, 'userId'>
  * }

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

@@ -10,12 +10,12 @@ const shared_js_1 = require("./shared.js");
  *
  * ```ts
  * class User extends ApplicationModel {
- *   @Deco.HasOne('UserSettings')
+ *   @deco.HasOne('UserSettings')
  *   public userSettings: UserSettings
  * }
  *
  * class UserSettings extends ApplicationModel {
- *   @Deco.BelongsTo('User')
+ *   @deco.BelongsTo('User')
  *   public user: User
  *   public userId: DreamColumn<UserSettings, 'userId'>
  * }

package/dist/cjs/src/decorators/field/lifecycle/AfterCreateCommit.js

@@ -12,7 +12,7 @@ const shared_js_1 = require("./shared.js");
  * is complete.
  *
  * class User extends ApplicationModel {
- *   @Deco.AfterCreateCommit()
+ *   @deco.AfterCreateCommit()
  *   public doSomething() {
  *     ...
  *   }

package/dist/cjs/src/decorators/field/lifecycle/AfterDestroyCommit.js

@@ -12,7 +12,7 @@ const shared_js_1 = require("./shared.js");
  * is complete.
  *
  * class User extends ApplicationModel {
- *   @Deco.AfterDestroyCommit()
+ *   @deco.AfterDestroyCommit()
  *   public doSomething() {
  *     ...
  *   }

package/dist/cjs/src/decorators/field/lifecycle/AfterSaveCommit.js

@@ -12,7 +12,7 @@ const shared_js_1 = require("./shared.js");
  * is complete.
  *
  * class User extends ApplicationModel {
- *   @Deco.AfterSaveCommit()
+ *   @deco.AfterSaveCommit()
  *   public doSomething() {
  *     ...
  *   }

package/dist/cjs/src/decorators/field/lifecycle/AfterUpdateCommit.js

@@ -12,7 +12,7 @@ const shared_js_1 = require("./shared.js");
  * is complete.
  *
  * class User extends ApplicationModel {
- *   @Deco.AfterUpdateCommit()
+ *   @deco.AfterUpdateCommit()
  *   public doSomething() {
  *     ...
  *   }

package/dist/cjs/src/decorators/field/validation/Validates.js

@@ -56,7 +56,7 @@ function extractValidationOptionsFromArgs(type, args) {
           When validating using "length", the second argument must be a number representing
           the min length, or else an object expressing both min and max length, like so:
 
-          @Deco.Validates('length', { min: 4, max: 32 })
+          @deco.Validates('length', { min: 4, max: 32 })
         `);
             }
         case 'requiredBelongsTo':

package/dist/cjs/src/dream/DreamClassTransactionBuilder.js

@@ -515,10 +515,10 @@ class DreamClassTransactionBuilder {
      *
      * ```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

package/dist/cjs/src/dream/Query.js

@@ -763,10 +763,10 @@ class Query extends ConnectedToDB_js_1.default {
      *
      * ```ts
      * class Post {
-     *   @Deco.HasMany('LocalizedText')
+     *   @deco.HasMany('LocalizedText')
      *   public localizedTexts: LocalizedText[]
      *
-     *   @Deco.HasOne('LocalizedText', {
+     *   @deco.HasOne('LocalizedText', {
      *     on: { locale: DreamConst.passthrough },
      *   })
      *   public currentLocalizedText: LocalizedText

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

@@ -38,7 +38,7 @@ function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fully
             case 'belongs_to':
                 modelImportStatements.push(associationImportStatement);
                 return `
-@Deco.BelongsTo('${fullyQualifiedAssociatedModelName}'${descriptors.includes('optional') ? ', { optional: true }' : ''})
+@deco.BelongsTo('${fullyQualifiedAssociatedModelName}'${descriptors.includes('optional') ? ', { optional: true }' : ''})
 public ${associationName}: ${associationModelName}${descriptors.includes('optional') ? ' | null' : ''}
 public ${associationName}Id: DreamColumn<${modelClassName}, '${associationName}Id'>
 `;
@@ -76,7 +76,7 @@ public ${(0, camelize_js_1.default)(attributeName)}: ${getAttributeType(attribut
     return `\
 import { ${(0, uniq_js_1.default)(dreamImports).join(', ')} } from '@rvoh/dream'${(0, uniq_js_1.default)(modelImportStatements).join('')}
 
-const Deco = new Decorators<InstanceType<typeof ${modelClassName}>>()
+const deco = new Decorators<InstanceType<typeof ${modelClassName}>>()
 
 ${isSTI ? `\n@STI(${parentModelClassName})` : ''}
 export default class ${modelClassName} extends ${isSTI ? parentModelClassName : 'ApplicationModel'} {

package/dist/cjs/src/helpers/db/runMigration.js

@@ -89,14 +89,14 @@ function migratedActionPastTense(mode) {
 function logResults(results, mode) {
     results?.forEach(it => {
         if (it.status === 'Success') {
-            index_js_3.default.logger.log((0, colorize_js_1.default)(`[db]`, { color: 'cyan' }) +
-                ` migration "${it.migrationName}" was ${migratedActionPastTense(mode)} successfully`, { permanent: true, logPrefix: '├', logPrefixColor: 'cyan' });
+            index_js_3.default.logger.logContinueProgress((0, colorize_js_1.default)(`[db]`, { color: 'cyan' }) +
+                ` migration "${it.migrationName}" was ${migratedActionPastTense(mode)} successfully`, { logPrefixColor: 'cyan' });
         }
         else if (it.status === 'Error') {
-            index_js_3.default.logger.log(JSON.stringify(it, null, 2), { permanent: true });
-            index_js_3.default.logger.log((0, colorize_js_1.default)(`failed to ${migratedActionCurrentTense(mode)} migration "${it.migrationName}"`, {
+            index_js_3.default.logger.logContinueProgress(JSON.stringify(it, null, 2));
+            index_js_3.default.logger.logContinueProgress((0, colorize_js_1.default)(`failed to ${migratedActionCurrentTense(mode)} migration "${it.migrationName}"`, {
                 color: 'redBright',
-            }), { permanent: true });
+            }));
         }
     });
 }

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/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/esm/src/Dream.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,
@@ -1133,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'>
      * }
      *
@@ -1163,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 })
      *   }
@@ -1288,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
@@ -1631,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()
@@ -1677,7 +1677,7 @@ export default class Dream {
      *
      * ```ts
      * class User extends ApplicationModel {
-     *   @Deco.Validates('presence')
+     *   @deco.Validates('presence')
      *   public email: DreamColumn<User, 'email'>
      * }
      *
@@ -2068,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')
@@ -2696,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
@@ -2996,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()
@@ -3017,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) {