@rvoh/dream 0.44.8 → 0.45.0

package/dist/cjs/src/Dream.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const yoctocolors_1 = require("yoctocolors");
 const errors_js_1 = require("./db/errors.js");
 const index_js_1 = require("./db/index.js");
 const associationToGetterSetterProp_js_1 = require("./decorators/field/association/associationToGetterSetterProp.js");
@@ -47,7 +48,10 @@ const cloneDeepSafe_js_1 = require("./helpers/cloneDeepSafe.js");
 const DateTime_js_1 = require("./helpers/DateTime.js");
 const cachedTypeForAttribute_js_1 = require("./helpers/db/cachedTypeForAttribute.js");
 const isJsonColumn_js_1 = require("./helpers/db/types/isJsonColumn.js");
+const indent_js_1 = require("./helpers/indent.js");
 const notEqual_js_1 = require("./helpers/notEqual.js");
+const inferSerializerFromDreamOrViewModel_js_1 = require("./serializer/helpers/inferSerializerFromDreamOrViewModel.js");
+const serializerForAssociatedClass_js_1 = require("./serializer/helpers/serializerForAssociatedClass.js");
 class Dream {
     DB;
     /**
@@ -104,6 +108,46 @@ class Dream {
     get globalSchema() {
         throw new DreamMissingRequiredOverride_js_1.default(this.constructor, 'globalSchema');
     }
+    /**
+     * Determines if the provided Dream class is the same as or a subclass of this Dream class.
+     * This method is particularly useful for runtime type checking and works with STI (Single Table Inheritance) classes.
+     *
+     * For regular Dream classes, this checks if the provided class is exactly the same class.
+     * For STI classes, this checks inheritance relationships - a child STI class will return true
+     * when compared against its parent class.
+     *
+     * ```ts
+     * // Regular class comparison
+     * User.typeof(User)    // true
+     * User.typeof(Pet)     // false
+     *
+     * // STI inheritance checking
+     * class Balloon extends ApplicationModel {
+     *   // base STI class
+     * }
+     *
+     * class Mylar extends Balloon {
+     *   // STI child class
+     * }
+     *
+     * Balloon.typeof(Balloon) // true
+     * Balloon.typeof(Mylar)   // false
+     * Mylar.typeof(Balloon)   // true (child recognizes parent)
+     * Mylar.typeof(Mylar)     // true
+     *
+     * // Runtime type checking with variables
+     * const dreamClass: typeof Dream = getRandomDreamClass()
+     * if (dreamClass.typeof(Pet)) {
+     *   // dreamClass is Pet or a subclass of Pet
+     * }
+     * ```
+     *
+     * @param dreamClass - The Dream class to compare against this class
+     * @returns `true` if the provided class is the same as this class or if this class is a subclass of the provided class (STI inheritance), `false` otherwise
+     */
+    static typeof(dreamClass) {
+        return this.new() instanceof dreamClass;
+    }
     /**
      * Shadows #primaryKey, a getter which can be overwritten to customize the id field
      * for a given model.
@@ -423,6 +467,65 @@ class Dream {
     static setGlobalName(globalName) {
         this._globalName = globalName;
     }
+    static serializationMap(serializerKey) {
+        const key = serializerKey || 'default';
+        const serializer = (0, inferSerializerFromDreamOrViewModel_js_1.inferSerializersFromDreamClassOrViewModelClass)(this, key)[0] ?? null;
+        if (!serializer)
+            throw new Error(`unable to find serializer with key: ${key}`);
+        return this.recursiveSerializationMap(serializer);
+    }
+    static displaySerialization(serializerKey) {
+        const key = serializerKey || 'default';
+        const serializer = (0, inferSerializerFromDreamOrViewModel_js_1.inferSerializersFromDreamClassOrViewModelClass)(this, key)[0] ?? null;
+        if (!serializer)
+            throw new Error(`unable to find serializer with key: ${key}`);
+        console.log(yoctocolors_1.default.cyan(this.sanitizedName));
+        console.log(yoctocolors_1.default.gray(serializer.globalName));
+        return this.recursiveSerializationMap(serializer, {
+            forDisplay: true,
+        });
+    }
+    static recursiveSerializationMap(serializer, { forDisplay = false, forDisplayDepth = 0, } = {}) {
+        const serializerBuilder = serializer(undefined, undefined);
+        const serializerAssociations = serializerBuilder['attributes'].filter(attribute => ['rendersOne', 'rendersMany', 'delegatedAttribute'].includes(attribute.type));
+        return serializerAssociations.reduce((acc, serializerAssociation) => {
+            const serializerAssociationName = serializerAssociation.targetName ??
+                serializerAssociation.name;
+            const serializerAssociationType = serializerAssociation.type;
+            const association = this['getAssociationMetadata'](serializerAssociationName);
+            if (!association)
+                return acc;
+            const associatedClasses = association.modelCB();
+            const associatedClass = Array.isArray(associatedClasses) ? associatedClasses[0] : associatedClasses;
+            if (!associatedClass)
+                throw new Error(`No class defined on ${serializerAssociationName} association on ${this.sanitizedName}`);
+            const associationSerializer = (0, serializerForAssociatedClass_js_1.serializerForAssociatedClass)(this.prototype, serializerAssociationName, serializerAssociation.options);
+            if (!associationSerializer)
+                throw new Error(`No serializer found to render ${serializerAssociationName} on ${this.sanitizedName}`);
+            if (forDisplay && serializerAssociationType !== 'delegatedAttribute') {
+                const hierarchyLine = '└───';
+                const indentation = (0, indent_js_1.indent)((hierarchyLine.length + 1) * forDisplayDepth, {
+                    tabWidth: 1,
+                });
+                const prefix = `${hierarchyLine} `;
+                const nestedAssociationDisplay = indentation + `${prefix}${serializerAssociationType} ${yoctocolors_1.default.cyan(serializerAssociationName)}`;
+                console.log(nestedAssociationDisplay);
+                console.log(yoctocolors_1.default.gray(indentation +
+                    (0, indent_js_1.indent)(prefix.length, { tabWidth: 1 }) +
+                    associationSerializer.globalName));
+            }
+            acc[association.as] = {
+                parentDreamClass: this,
+                nestedSerializerInfo: serializerAssociation.type === 'delegatedAttribute'
+                    ? {}
+                    : associatedClass['recursiveSerializationMap'](associationSerializer, {
+                        forDisplay,
+                        forDisplayDepth: forDisplayDepth + 1,
+                    }),
+            };
+            return acc;
+        }, {});
+    }
     /**
      * Returns the column names for the given model
      *
@@ -624,12 +727,14 @@ class Dream {
      * // 2
      * ```
      *
+     * @param opts - Pagination options
      * @param opts.page - the page number that you want to fetch results for
      * @param opts.pageSize - the number of results per page (optional)
-     * @returns results.recordCount - A number representing the total number of records matching your query
-     * @returns results.pageCount - The number of pages needed to encapsulate all the matching records
-     * @returns results.currentPage - The current page (same as what is provided in the paginate args)
-     * @returns results.results - An array of records matching the current record
+     * @returns A paginated result object containing:
+     * - `recordCount` - A number representing the total number of records matching your query
+     * - `pageCount` - The number of pages needed to encapsulate all the matching records
+     * - `currentPage` - The current page (same as what is provided in the paginate args)
+     * - `results` - An array of records matching the current record
      */
     static async paginate(opts) {
         return await this.query().paginate(opts);
@@ -697,7 +802,8 @@ class Dream {
      * ```
      *
      * @param attributes - attributes or belongs to associations you wish to set on this model before persisting
-     * @param opts.skipHooks - if true, will skip applying model hooks. Defaults to false
+     * @param __namedParameters - optional parameters
+     * @param __namedParameters.skipHooks - if true, will skip applying model hooks. Defaults to false
      * @returns A newly persisted dream instance
      */
     static async create(attributes, { skipHooks } = {}) {
@@ -721,6 +827,7 @@ class Dream {
      * ```
      *
      * @param attributes - The base attributes to persist, but also the attributes to use to find when create fails
+     * @param extraOpts - Additional options
      * @param extraOpts.createWith - additional attributes to persist when creating, but not used for finding
      * @returns A dream instance
      */
@@ -753,6 +860,7 @@ class Dream {
      * ```
      *
      * @param attributes - The base attributes for finding which record to update, also used when creating
+     * @param extraOpts - Additional options
      * @param extraOpts.with - additional attributes to persist when updating and creating, but not used for finding
      * @param extraOpts.skipHooks - if true, will skip applying model hooks. Defaults to false
      * @returns A dream instance
@@ -773,6 +881,7 @@ class Dream {
      * at least one of the provided attributes
      *
      * @param attributes - The base attributes for finding which record to update, also used when creating
+     * @param extraOpts - Additional options
      * @param extraOpts.with - additional attributes to persist when updating and creating, but not used for finding
      * @param extraOpts.skipHooks - if true, will skip applying model hooks. Defaults to false
      * @returns A dream instance
@@ -862,6 +971,7 @@ class Dream {
      * ```
      *
      * @param cb - The callback to call for each found record
+     * @param opts - Optional parameters for batch processing
      * @param opts.batchSize - the batch size you wish to collect records in. If not provided, it will default to 1000
      * @returns void
      */
@@ -946,6 +1056,7 @@ class Dream {
      * ```
      *
      * @param attributes - The base attributes for finding, but also the attributes to use when creating
+     * @param extraOpts - Additional options
      * @param extraOpts.createWith - additional attributes to persist when creating, but not used for finding
      * @returns A dream instance
      */
@@ -973,10 +1084,10 @@ class Dream {
     }
     /**
      * Load each specified association using a single SQL query.
-     * See {@link #preload} for preloading in separate queries.
+     * See {@link Dream.preload} for preloading in separate queries.
      *
      * Note: since leftJoinPreload loads via single query, it has
-     * some downsides and that may be avoided using {@link #preload}:
+     * some downsides and that may be avoided using {@link Dream.preload}:
      * 1. `limit` and `offset` will be automatically removed
      * 2. `through` associations will bring additional namespaces into the query that can conflict with through associations from other associations, creating an invalid query
      * 3. each nested association will result in an additional record which duplicates data from the outer record. E.g., given `.leftJoinPreload('a', 'b', 'c')`, if each `a` has 10 `b` and each `b` has 10 `c`, then for one `a`, 100 records will be returned, each of which has all of the columns of `a`. `.preload('a', 'b', 'c')` would perform three separate SQL queries, but the data for a single `a` would only be returned once.
@@ -1017,6 +1128,116 @@ class Dream {
     static preload(...args) {
         return this.query().preload(...args);
     }
+    /**
+     * Recursively preloads all Dream associations referenced by `rendersOne` and `rendersMany`
+     * in a DreamSerializer. This traverses the entire content tree of serializers to automatically
+     * load all necessary associations, eliminating N+1 query problems and removing the need to
+     * manually remember which associations to preload for serialization.
+     *
+     * This method decouples data loading code from data rendering code by having the serializer
+     * (rendering code) inform the query (loading code) about which associations are needed.
+     * As serializers evolve over time - adding new `rendersOne` and `rendersMany` calls or
+     * modifying existing ones - the loading code automatically adapts without requiring
+     * corresponding modifications to preload statements.
+     *
+     * This method analyzes the serializer (specified by `serializerKey` or 'default') and
+     * automatically preloads all associations that will be needed during serialization.
+     *
+     * ```ts
+     * // Instead of manually specifying all associations:
+     * await User.preload('posts', 'comments', 'replies').all()
+     *
+     * // Automatically preload everything needed for serialization:
+     * await User.preloadForSerialization({ serializerKey: 'summary' }).all()
+     *
+     * // Add where conditions to specific associations during preloading:
+     * await User.preloadForSerialization({
+     *   serializerKey: 'detailed',
+     *   modifierFn: (dreamClass, associationName) => {
+     *     if (dreamClass.typeof(Post) && associationName === 'comments') {
+     *       return { and: { published: true } }
+     *     }
+     *   }
+     * }).all()
+     *
+     * // Skip preloading specific associations to handle them manually:
+     * await User.preloadForSerialization({
+     *   serializerKey: 'summary',
+     *   modifierFn: (dreamClass, associationName) => {
+     *     if (dreamClass.typeof(User) && associationName === 'posts') {
+     *       return 'omit' // Handle posts preloading separately with custom logic
+     *     }
+     *   }
+     * })
+     * .preload('posts', { and: { featured: true } }) // Custom preloading
+     * .all()
+     * ```
+     *
+     * @param opts - Configuration options for serialization preloading
+     * @param opts.serializerKey - The serializer key to use for determining which associations to preload. Defaults to 'default'
+     * @param opts.modifierFn - Optional callback function to modify or omit specific associations during preloading. Called for each association with the Dream class and association name. Return an object with `and`, `andAny`, or `andNot` properties to add where conditions, return 'omit' to skip preloading that association (useful when you want to handle it manually), or return undefined to use default preloading
+     * @returns A Query with all serialization associations preloaded
+     */
+    static preloadForSerialization(opts = {}) {
+        return this.query().preloadForSerialization(opts);
+    }
+    /**
+     * Recursively preloads all Dream associations referenced by `rendersOne` and `rendersMany`
+     * in a DreamSerializer using left join preloading. This traverses the entire content tree
+     * of serializers to automatically load all necessary associations in a single query,
+     * eliminating N+1 query problems and removing the need to manually remember which
+     * associations to preload for serialization.
+     *
+     * This method decouples data loading code from data rendering code by having the serializer
+     * (rendering code) inform the query (loading code) about which associations are needed.
+     * As serializers evolve over time - adding new `rendersOne` and `rendersMany` calls or
+     * modifying existing ones - the loading code automatically adapts without requiring
+     * corresponding modifications to left join preload statements.
+     *
+     * This method analyzes the serializer (specified by `serializerKey` or 'default') and
+     * automatically left join preloads all associations that will be needed during serialization.
+     *
+     * Note: Left join preloading loads all data in a single SQL query but has trade-offs compared
+     * to regular preloading. See {@link Dream.leftJoinPreload} for details about limitations.
+     *
+     * ```ts
+     * // Instead of manually specifying all associations:
+     * await User.leftJoinPreload('posts', 'comments', 'replies').all()
+     *
+     * // Automatically left join preload everything needed for serialization:
+     * await User.leftJoinPreloadForSerialization({ serializerKey: 'summary' }).all()
+     *
+     * // Add where conditions to specific associations during left join preloading:
+     * await User.leftJoinPreloadForSerialization({
+     *   serializerKey: 'detailed',
+     *   modifierFn: (dreamClass, associationName) => {
+     *     if (dreamClass.typeof(Post) && associationName === 'comments') {
+     *       return { and: { published: true } }
+     *     }
+     *   }
+     * }).all()
+     *
+     * // Skip left join preloading specific associations to handle them manually:
+     * await User.leftJoinPreloadForSerialization({
+     *   serializerKey: 'summary',
+     *   modifierFn: (dreamClass, associationName) => {
+     *     if (dreamClass.typeof(User) && associationName === 'posts') {
+     *       return 'omit' // Handle posts preloading separately with custom logic
+     *     }
+     *   }
+     * })
+     * .preload('posts', { and: { featured: true } }) // Custom preloading instead
+     * .all()
+     * ```
+     *
+     * @param opts - Configuration options for serialization preloading
+     * @param opts.serializerKey - The serializer key to use for determining which associations to preload. Defaults to 'default'
+     * @param opts.modifierFn - Optional callback function to modify or omit specific associations during preloading. Called for each association with the Dream class and association name. Return an object with `and`, `andAny`, or `andNot` properties to add where conditions, return 'omit' to skip preloading that association (useful when you want to handle it manually), or return undefined to use default preloading
+     * @returns A Query with all serialization associations left join preloaded
+     */
+    static leftJoinPreloadForSerialization(opts = {}) {
+        return this.query().leftJoinPreloadForSerialization(opts);
+    }
     /**
      * Returns a new Query instance with the provided
      * inner join statement attached
@@ -1213,7 +1434,7 @@ class Dream {
      * // 3
      * ```
      *
-     * @param fields - a list of fields to pluck, followed by a callback function to call for each set of found fields
+     * @param args - a list of fields to pluck, followed by a callback function to call for each set of found fields
      * @returns void
      */
     static async pluckEach(...args) {
@@ -1422,7 +1643,7 @@ class Dream {
      * // [User{email: 'how@yadoin'}, User{name: 'fred'}, User{name: 'fred'}]
      * ```
      *
-     * @param whereStatements - a list of where statements to `OR` together
+     * @param statements - a list of where statements to `OR` together
      * @returns A Query for this model with the whereAny clause applied
      */
     static whereAny(statements) {
@@ -1437,7 +1658,7 @@ class Dream {
      * // User{email: 'hello@world'}
      * ```
      *
-     * @param whereStatement - A where statement to negate and apply to the Query
+     * @param attributes - A where statement to negate and apply to the Query
      * @returns A Query for this model with the whereNot clause applied
      */
     static whereNot(attributes) {
@@ -2377,7 +2598,7 @@ class Dream {
      * // 'dog'
      * ```
      *
-     * @param columName - The column name you want the previous value for
+     * @param columnName - The column name you want the previous value for
      * @returns Returns the previous value for an attribute
      */
     previousValueForAttribute(columnName) {
@@ -2403,7 +2624,7 @@ class Dream {
      * Returns true if the columnName provided has
      * changes that have not yet been persisted.
      *
-     * @param columnName - the column name to check
+     * @param attribute - the column name to check
      * @returns A boolean
      */
     willSaveChangeToAttribute(attribute) {
@@ -2840,7 +3061,7 @@ class Dream {
     /**
      * Loads the requested associations upon execution
      *
-     * NOTE: {@link #preload} is often a preferrable way of achieving the
+     * NOTE: {@link Dream.preload} is often a preferrable way of achieving the
      * same goal.
      *
      * ```ts
@@ -2864,18 +3085,17 @@ class Dream {
     }
     /**
      * Load each specified association using a single SQL query.
-     * See {@link #load} for loading in separate queries.
+     * See {@link Dream.load} for loading in separate queries.
      *
-     * Note: since leftJoinPreload loads via single query, it has
-     * some downsides and that may be avoided using {@link #load}:
+     * Note: since leftJoinLoad loads via single query, it has
+     * some downsides and that may be avoided using {@link Dream.load}:
      * 1. `limit` and `offset` will be automatically removed
      * 2. `through` associations will bring additional namespaces into the query that can conflict with through associations from other associations, creating an invalid query
-     * 3. each nested association will result in an additional record which duplicates data from the outer record. E.g., given `.leftJoinPreload('a', 'b', 'c')`, if each `a` has 10 `b` and each `b` has 10 `c`, then for one `a`, 100 records will be returned, each of which has all of the columns of `a`. `.load('a', 'b', 'c')` would perform three separate SQL queries, but the data for a single `a` would only be returned once.
+     * 3. each nested association will result in an additional record which duplicates data from the outer record. E.g., given `.leftJoinLoad('a', 'b', 'c')`, if each `a` has 10 `b` and each `b` has 10 `c`, then for one `a`, 100 records will be returned, each of which has all of the columns of `a`. `.load('a', 'b', 'c')` would perform three separate SQL queries, but the data for a single `a` would only be returned once.
      * 4. the individual query becomes more complex the more associations are included
      * 5. associations loading associations loading associations could result in exponential amounts of data; in those cases, `.load(...).findEach(...)` avoids instantiating massive amounts of data at once
-     * Loads the requested associations upon execution
      *
-     * NOTE: {@link #leftJoinPreload} is often a preferrable way of achieving the
+     * NOTE: {@link Dream.leftJoinPreload} is often a preferrable way of achieving the
      * same goal.
      *
      * ```ts
@@ -3009,7 +3229,8 @@ class Dream {
      * user.type // 'User'
      * ```
      *
-     * @param opts.skipHooks - if true, will skip applying model hooks. Defaults to false
+     * @param __namedParameters - optional parameters
+     * @param __namedParameters.skipHooks - if true, will skip applying model hooks. Defaults to false
      * @returns void
      */
     async save({ skipHooks } = {}) {
@@ -3049,7 +3270,8 @@ class Dream {
      * ```
      *
      * @param attributes - the attributes to set on the model
-     * @param opts.skipHooks - if true, will skip applying model hooks. Defaults to false
+     * @param __namedParameters - optional parameters
+     * @param __namedParameters.skipHooks - if true, will skip applying model hooks. Defaults to false
      * @returns void
      */
     async update(attributes, { skipHooks } = {}) {
@@ -3076,7 +3298,8 @@ class Dream {
      * ```
      *
      * @param attributes - The attributes to update on this instance
-     * @param opts.skipHooks - if true, will skip applying model hooks. Defaults to false
+     * @param __namedParameters - optional parameters
+     * @param __namedParameters.skipHooks - if true, will skip applying model hooks. Defaults to false
      * @returns - void
      */
     async updateAttributes(attributes, { skipHooks } = {}) {
@@ -3109,7 +3332,7 @@ class Dream {
      * Flags a dream model so that it allows
      * deletion once again.
      *
-     * Undoes {@link Dream.(preventDeletion:instance) | preventDeletion}
+     * Undoes {@link Dream.preventDeletion}
      *
      * ```ts
      * class User extends ApplicationModel {

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const index_js_1 = require("../bin/index.js");
+const index_js_2 = require("../dream-app/index.js");
 const EnvInternal_js_1 = require("../helpers/EnvInternal.js");
 const sspawn_js_1 = require("../helpers/sspawn.js");
 const DreamCliLogger_js_1 = require("./logger/DreamCliLogger.js");
@@ -141,6 +142,21 @@ class DreamCLI {
             await seedDb();
             process.exit();
         });
+        program
+            .command('inspect:serialization')
+            .alias('i:serialization')
+            .description('displays a serialization map to help understand the rendering logic for a particular model')
+            .argument('<globalName>', 'the global name of the model you want to look up')
+            .argument('[serializerKey]', 'the serializer key you wish to use')
+            .action(async (globalName, serializerKey) => {
+            await initializeDreamApp();
+            const dreamApp = index_js_2.default.getOrFail();
+            const modelClass = dreamApp.models[globalName];
+            if (!modelClass)
+                throw new Error(`failed to locate model by global name: ${globalName}`);
+            modelClass['displaySerialization'](serializerKey);
+            process.exit();
+        });
     }
     /*
      * the default spawn provided by node:child_process is incompatible

package/dist/cjs/src/db/migration-helpers/DreamMigrationHelpers.js

@@ -11,8 +11,9 @@ class DreamMigrationHelpers {
      *
      * @param db - The Kysely database object passed into the migration up/down function
      * @param constraintName - The name of the constraint to create
-     * @param opts.table - The name of the table
-     * @param opts.columns[] - The names of the columns to include in the constraint
+     * @param options - Configuration options
+     * @param options.table - The name of the table
+     * @param options.columns - The names of the columns to include in the constraint
      *
      */
     static async addDeferrableUniqueConstraint(db, constraintName, { table, columns, }) {
@@ -30,9 +31,9 @@ class DreamMigrationHelpers {
      * Note that this always includes "IF NOT EXISTS", so is safe to re-run multiple times.
      *
      * @param db - The Kysely database object passed into the migration up/down function
-     * @param opt.enumName - The name of the enum to modify
-     * @param opt.value - The name of the value to add to the enum
-     *
+     * @param __namedParameters - The options for adding the enum value
+     * @param __namedParameters.enumName - The name of the enum to modify
+     * @param __namedParameters.value - The name of the value to add to the enum
      */
     static async addEnumValue(db, { enumName, value }) {
         await (0, kysely_1.sql) `ALTER TYPE ${kysely_1.sql.raw(enumName)} ADD VALUE IF NOT EXISTS '${kysely_1.sql.raw(value)}';`.execute(db);
@@ -50,8 +51,9 @@ class DreamMigrationHelpers {
      *
      * @param db - The Kysely database object passed into the migration up/down function
      * @param extensionName - The name of the database extension to add
-     * @param opt.ifNotExists - Only add the extension if it doesn't already exist
-     * @param opt.publicSchema - Create using the public schema
+     * @param options - Configuration options
+     * @param options.ifNotExists - Only add the extension if it doesn't already exist
+     * @param options.publicSchema - Create using the public schema
      *
      */
     static async createExtension(db, extensionName, { ifNotExists = true, publicSchema = true } = {}) {
@@ -66,8 +68,9 @@ class DreamMigrationHelpers {
      *
      * @param db - The Kysely database object passed into the migration up/down function
      * @param indexName - The name of the constraint to create
-     * @param opts.table - The name of the table
-     * @param opts.column - The name of the column to index
+     * @param options - Configuration options
+     * @param options.table - The name of the table
+     * @param options.column - The name of the column to index
      *
      */
     static async createGinIndex(db, indexName, { table, column }) {
@@ -82,7 +85,8 @@ class DreamMigrationHelpers {
      *
      * @param db - The Kysely database object passed into the migration up/down function
      * @param constraintName - The name of the constraint to create
-     * @param opts.table - The name of the table
+     * @param options - Configuration options
+     * @param options.table - The name of the table
      *
      */
     static async dropConstraint(db, constraintName, { table }) {
@@ -94,10 +98,10 @@ class DreamMigrationHelpers {
      * Drop a value from an enum and replace it (or optionally remove it from array columns)
      *
      * @param db - The Kysely database object passed into the migration up/down function
-     * @param opt.enumName - The name of the enum to modify
-     * @param opt.value - The name of the value to drop from the enum
-     * @param opt.replacements[] - Details about which table and column to change and which value to replace the dropped value with (or remove it if the column is an array)
-     *
+     * @param __namedParameters - The options for dropping the enum value
+     * @param __namedParameters.enumName - The name of the enum to modify
+     * @param __namedParameters.value - The name of the value to drop from the enum
+     * @param __namedParameters.replacements - Details about which table and column to change and which value to replace the dropped value with (or remove it if the column is an array)
      */
     static async dropEnumValue(db, { enumName, value, replacements }) {
         // temporarily set all table columns depending on this enum to an acceptable alternate type

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

@@ -161,7 +161,8 @@ class Decorators {
      * }
      * ```
      *
-     * @param scope - The column, association, or combination there-of which you would like to restrict the incrementing logic to
+     * @param opts - Configuration options for the sortable decorator
+     * @param opts.scope - The column, association, or combination thereof which you would like to restrict the incrementing logic to. Can be a single column name, a single belongs-to association name, or an array of column/association names
      * @returns A Sortable decorator
      */
     Sortable(opts) {