@rvoh/dream 2.6.1-alpha.1 → 2.7.1

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

@@ -62,6 +62,8 @@ export default class DreamBin {
                 includeInternalSerializers: options.internalSerializers ?? false,
                 ...options,
                 stiBaseSerializer: false,
+                // `@SoftDelete()` is incompatible with STI children — never auto-apply.
+                softDelete: false,
             },
             fullyQualifiedParentName,
         });

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

@@ -190,6 +190,7 @@ ${INDENT}  pnpm psy g:model --model-name=GroupDanceLesson Lesson/Dance/Group
 ${INDENT}  # model is named GroupDanceLesson instead of LessonDanceGroup`)
             .option('--admin-serializers', 'also generate AdminSerializer and AdminSummarySerializer variants for admin-facing API endpoints that may expose additional fields', false)
             .option('--internal-serializers', 'also generate InternalSerializer and InternalSummarySerializer variants for internal API endpoints that may expose additional fields', false)
+            .option('--no-soft-delete', `skip generating the @SoftDelete() decorator and the corresponding nullable \`deleted_at\` column. By default, generated models use soft-delete semantics (rows are marked deleted via \`deleted_at\` instead of being removed from the database). Pass this flag when you want records to be hard-deleted.`)
             .argument('<modelName>', `The fully qualified model name, using / for namespacing. This determines the model class name (may be overridden with \`--model-name\`), table name, and file path under src/app/models/.
 ${INDENT}
 ${INDENT}Examples:

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

@@ -9,6 +9,11 @@ import writeGeneratedFile from './writeGeneratedFile.js';
 export default async function generateDream({ fullyQualifiedModelName, columnsWithTypes, options, fullyQualifiedParentName, }) {
     fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
     const modelClassName = modelClassNameFrom(fullyQualifiedModelName, options.modelName);
+    const isSTI = !!fullyQualifiedParentName;
+    // `@SoftDelete()` is incompatible with STI children, so we force-disable
+    // the soft-delete scaffold when generating an STI child regardless of the
+    // caller-provided value.
+    const softDelete = !isSTI && !!options.softDelete;
     await writeGeneratedFile({
         dreamPathKey: 'models',
         fileName: `${fullyQualifiedModelName}.ts`,
@@ -22,6 +27,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             connectionName: options.connectionName,
             tableName: options.tableName,
             modelClassName,
+            softDelete,
         }),
         logLabel: 'dream',
     });
@@ -37,7 +43,6 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             includeInternalSerializers: options.includeInternalSerializers ?? false,
             modelClassName,
         });
-    const isSTI = !!fullyQualifiedParentName;
     if (columnsWithTypes.length || !isSTI) {
         await generateMigration({
             connectionName: options.connectionName,
@@ -47,6 +52,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             fullyQualifiedParentName,
             tableName: options.tableName,
             modelClassName,
+            softDelete,
         });
     }
 }

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

@@ -7,19 +7,47 @@ import absoluteDreamPath from '../path/absoluteDreamPath.js';
 import snakeify from '../snakeify.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
 import uniq from '../uniq.js';
+/**
+ * Column names that are automatically emitted by the model generator (and
+ * the migration generator). When the user passes any of these explicitly,
+ * we filter them out of the attribute loop so the model class and migration
+ * don't end up with duplicate declarations.
+ */
+const AUTO_GENERATED_TIMESTAMP_COLUMN_NAMES = ['created_at', 'updated_at', 'deleted_at'];
+function columnName(columnWithType) {
+    return columnWithType.split(':')[0] ?? '';
+}
+export function hasExplicitColumn(columnsWithTypes, name) {
+    return columnsWithTypes.some(col => columnName(col) === name);
+}
+export function filterAutoGeneratedTimestampColumns(columnsWithTypes) {
+    return columnsWithTypes.filter(col => !AUTO_GENERATED_TIMESTAMP_COLUMN_NAMES.includes(columnName(col)));
+}
 export default function generateDreamContent(options) {
     const config = createModelConfig(options);
-    const baseImports = createImportConfig(config, options);
-    const attributesResult = processAttributes(options.columnsWithTypes, config.modelClassName);
+    // SoftDelete is incompatible with STI children, so it's only applied to
+    // non-STI-child models.
+    const includeSoftDelete = !config.isSTI && !!options.softDelete;
+    const hasExplicitDeletedAt = hasExplicitColumn(options.columnsWithTypes, 'deleted_at');
+    // Filter out timestamp columns that we auto-generate from the attribute
+    // processing loop so we don't double-generate them in the model class.
+    // We only dedupe on non-STI models — STI children don't get auto timestamps.
+    const columnsForAttributes = config.isSTI
+        ? options.columnsWithTypes
+        : filterAutoGeneratedTimestampColumns(options.columnsWithTypes);
+    const baseImports = createImportConfig(config, options, { includeSoftDelete });
+    const attributesResult = processAttributes(columnsForAttributes, config.modelClassName);
     const allImports = {
         ...baseImports,
         modelImportStatements: [...baseImports.modelImportStatements, ...attributesResult.imports],
     };
     const importSection = buildImportSection(allImports);
-    const classDeclaration = buildClassDeclaration(config);
+    const classDeclaration = buildClassDeclaration(config, { includeSoftDelete });
     const tableMethod = buildTableMethod(config);
     const serializersMethod = buildSerializersMethod(config, options);
-    const fieldsSection = buildFieldsSection(config, attributesResult);
+    const fieldsSection = buildFieldsSection(config, attributesResult, {
+        includeDeletedAt: includeSoftDelete || hasExplicitDeletedAt,
+    });
     return `${importSection}
 
 const deco = new Decorators<typeof ${config.modelClassName}>()
@@ -50,7 +78,7 @@ export function createModelConfig(options) {
         tableName,
     };
 }
-export function createImportConfig(config, options) {
+export function createImportConfig(config, options, { includeSoftDelete }) {
     const dreamTypeImports = ['DreamColumn'];
     const dreamImports = ['Decorators'];
     if (options.serializer) {
@@ -59,6 +87,9 @@ export function createImportConfig(config, options) {
     if (config.isSTI) {
         dreamImports.push('STI');
     }
+    if (includeSoftDelete) {
+        dreamImports.push('SoftDelete');
+    }
     const baseModelName = config.isSTI ? options.fullyQualifiedParentName : config.applicationModelName;
     const modelImportStatements = [importStatementForModel(baseModelName)];
     return {
@@ -150,10 +181,11 @@ function buildImportSection(imports) {
     const modelImports = uniq(imports.modelImportStatements).join('');
     return `${dreamImportLine}${typeImportLine}${modelImports}`;
 }
-function buildClassDeclaration(config) {
+function buildClassDeclaration(config, { includeSoftDelete }) {
     const stiDecorator = config.isSTI ? `@STI(${config.parentModelClassName})\n` : '';
+    const softDeleteDecorator = includeSoftDelete ? '@SoftDelete()\n' : '';
     const extendsClause = config.isSTI ? config.parentModelClassName : config.applicationModelName;
-    return `${stiDecorator}export default class ${config.modelClassName} extends ${extendsClause} {`;
+    return `${stiDecorator}${softDeleteDecorator}export default class ${config.modelClassName} extends ${extendsClause} {`;
 }
 function buildTableMethod(config) {
     if (config.isSTI)
@@ -195,14 +227,17 @@ function buildSerializersMethod(config, options) {
 
 `;
 }
-function buildFieldsSection(config, attributes) {
+function buildFieldsSection(config, attributes, { includeDeletedAt }) {
     if (config.isSTI) {
         return `${attributes.formattedFields}${attributes.formattedDecorators}`;
     }
     const idField = `  public id: DreamColumn<${config.modelClassName}, 'id'>`;
+    const deletedAtLine = includeDeletedAt
+        ? `\n  public deletedAt: DreamColumn<${config.modelClassName}, 'deletedAt'>`
+        : '';
     let timestamps = `
   public createdAt: DreamColumn<${config.modelClassName}, 'createdAt'>
-  public updatedAt: DreamColumn<${config.modelClassName}, 'updatedAt'>
+  public updatedAt: DreamColumn<${config.modelClassName}, 'updatedAt'>${deletedAtLine}
 `;
     if (!attributes.formattedDecorators.length) {
         timestamps = timestamps.replace(/\n$/, '');

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

@@ -9,7 +9,7 @@ import dreamPath from '../path/dreamPath.js';
 import snakeify from '../snakeify.js';
 import generateStiMigrationContent from './generateStiMigrationContent.js';
 import writeGeneratedFile from './writeGeneratedFile.js';
-export default async function generateMigration({ migrationName, columnsWithTypes, connectionName, fullyQualifiedModelName, fullyQualifiedParentName, tableName: explicitTableName, modelClassName, }) {
+export default async function generateMigration({ migrationName, columnsWithTypes, connectionName, fullyQualifiedModelName, fullyQualifiedParentName, tableName: explicitTableName, modelClassName, softDelete = false, }) {
     const migrationsBasePath = connectionName === 'default'
         ? path.join(dreamPath('db'), 'migrations')
         : path.join(dreamPath('db'), 'migrations', connectionName);
@@ -29,6 +29,7 @@ export default async function generateMigration({ migrationName, columnsWithType
             table: explicitTableName || snakeify(pluralize(pascalizePath(fullyQualifiedModelName))),
             columnsWithTypes,
             primaryKeyType: primaryKeyType(connectionName),
+            softDelete,
         });
     }
     else {

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

@@ -9,11 +9,23 @@ import snakeify from '../snakeify.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
 const STI_TYPE_COLUMN_NAME = 'type';
 const COLUMNS_TO_INDEX = [STI_TYPE_COLUMN_NAME];
-export default function generateMigrationContent({ connectionName = 'default', table, columnsWithTypes = [], primaryKeyType = 'bigserial', createOrAlter = 'create', stiChildClassName, } = {}) {
+export default function generateMigrationContent({ connectionName = 'default', table, columnsWithTypes = [], primaryKeyType = 'bigserial', createOrAlter = 'create', stiChildClassName, softDelete = false, } = {}) {
     const altering = createOrAlter === 'alter';
     let requireCitextExtension = false;
     const checkConstraints = [];
-    const { columnDefs, columnDrops, indexDefs, indexDrops } = columnsWithTypes.reduce((acc, attributeDeclaration) => {
+    // When creating a new table, we automatically emit `created_at`,
+    // `updated_at`, and (when soft delete is on) `deleted_at` columns. Filter
+    // these out of the user-supplied column list so we don't emit duplicate
+    // `.addColumn(...)` calls if the user also specified them explicitly.
+    const userExplicitlyPassedDeletedAt = !altering && columnsWithTypes.some(col => (col.split(':')[0] ?? '') === 'deleted_at');
+    const processedColumnsWithTypes = altering
+        ? columnsWithTypes
+        : columnsWithTypes.filter(col => {
+            const name = col.split(':')[0] ?? '';
+            return name !== 'created_at' && name !== 'updated_at' && name !== 'deleted_at';
+        });
+    const emitDeletedAtColumn = !altering && (softDelete || userExplicitlyPassedDeletedAt);
+    const { columnDefs, columnDrops, indexDefs, indexDrops } = processedColumnsWithTypes.reduce((acc, attributeDeclaration) => {
         const { columnDefs, columnDrops, indexDefs, indexDrops } = acc;
         const [nonStandardAttributeName, _attributeType, ...descriptors] = attributeDeclaration.split(':');
         if (!nonStandardAttributeName)
@@ -143,18 +155,20 @@ export async function down(db: Kysely<any>): Promise<void> {
     const columnDropLines = columnDrops.length
         ? newlineDoubleIndent + columnDrops.join(newlineDoubleIndent) + newlineDoubleIndent
         : '';
+    const timestampColumnLines = altering
+        ? ''
+        : newlineDoubleIndent +
+            ".addColumn('created_at', 'timestamp', col => col.notNull())" +
+            newlineDoubleIndent +
+            ".addColumn('updated_at', 'timestamp', col => col.notNull())" +
+            (emitDeletedAtColumn ? newlineDoubleIndent + ".addColumn('deleted_at', 'timestamp')" : '');
     return `\
 ${dreamDbImports.length ? `import { ${dreamDbImports.join(', ')} } from '@rvoh/dream/db'\n` : ''}import { ${kyselyImports.join(', ')} } from 'kysely'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function up(db: Kysely<any>): Promise<void> {
 ${citextExtension}${generateEnumStatements(columnsWithTypes)}  await db.schema
-    .${altering ? 'alterTable' : 'createTable'}('${table}')${altering ? '' : newlineDoubleIndent + generateIdStr({ primaryKeyType })}${columnDefLines}${altering
-        ? ''
-        : newlineDoubleIndent +
-            ".addColumn('created_at', 'timestamp', col => col.notNull())" +
-            newlineDoubleIndent +
-            ".addColumn('updated_at', 'timestamp', col => col.notNull())"}
+    .${altering ? 'alterTable' : 'createTable'}('${table}')${altering ? '' : newlineDoubleIndent + generateIdStr({ primaryKeyType })}${columnDefLines}${timestampColumnLines}
     .execute()${indexDefs.length ? `\n${newlineIndent}` : ''}${indexDefs.join(doubleNewlineIndent)}${checkConstraints.join('')}
 }
 
@@ -184,7 +198,10 @@ function getAttributeType(attributeType, descriptors) {
 }
 function enumAttributeType(descriptors, asArray = false) {
     const suffix = asArray ? '[]' : '';
-    return `sql\`${descriptors[0]}_enum${suffix}\``;
+    return `sql\`${appendEnumSuffix(descriptors[0])}${suffix}\``;
+}
+function appendEnumSuffix(name) {
+    return name?.endsWith('_enum') ? name : `${name}_enum`;
 }
 const ENUM_OR_ENUM_ARRAY_REGEX = /:enum:.*:|:enum\[\]:.*:/;
 function generateEnumStatements(columnsWithTypes) {
@@ -197,7 +214,7 @@ function generateEnumStatements(columnsWithTypes) {
             return;
         const columnsWithTypes = columnsWithTypesString.split(/,\s{0,}/);
         return `  await db.schema
-    .createType('${enumName}_enum')
+    .createType('${appendEnumSuffix(enumName)}')
     .asEnum([
       ${columnsWithTypes.map(attr => `'${attr}'`).join(',\n      ')}
     ])
@@ -213,7 +230,7 @@ function generateEnumDropStatements(columnsWithTypes) {
         const columnsWithTypesString = descriptors[0];
         if (columnsWithTypesString === undefined)
             return;
-        return `await db.schema.dropType('${enumName}_enum').execute()`;
+        return `await db.schema.dropType('${appendEnumSuffix(enumName)}').execute()`;
     }));
     return finalStatements.length ? '\n\n  ' + finalStatements.join('\n  ') : '';
 }

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

@@ -1,4 +1,3 @@
-import serializerNameFromFullyQualifiedModelName from '../../serializer/helpers/serializerNameFromFullyQualifiedModelName.js';
 import camelize from '../camelize.js';
 import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFullyQualifiedModelName.js';
 import absoluteDreamPath from '../path/absoluteDreamPath.js';
@@ -9,9 +8,18 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
     const additionalImports = [];
     const dreamImports = [];
     const isSTI = !!fullyQualifiedParentName;
+    // Variants that should be emitted in this file. Each variant generates a
+    // matching summary + default serializer pair; STI children import the
+    // corresponding variant from the parent module so the inheritance chain
+    // stays within the same variant (admin → admin, internal → internal).
+    const variantSuffixes = [''];
+    if (includeAdminSerializers)
+        variantSuffixes.push('Admin');
+    if (includeInternalSerializers)
+        variantSuffixes.push('Internal');
     if (isSTI) {
         fullyQualifiedParentName = standardizeFullyQualifiedModelName(fullyQualifiedParentName);
-        additionalImports.push(importStatementForSerializer(fullyQualifiedModelName, fullyQualifiedParentName));
+        additionalImports.push(importStatementForSerializer(fullyQualifiedModelName, fullyQualifiedParentName, variantSuffixes));
     }
     else {
         dreamImports.push('DreamSerializer');
@@ -23,58 +31,50 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
         : `(${modelInstanceName}: ${modelClassName})`;
     const modelSerializerArgs = `${modelInstanceName}`;
     const dreamSerializerArgs = `${stiBaseSerializer ? `StiChildClass ?? ${modelClassName}` : modelClassName}, ${modelInstanceName}`;
-    const serializerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
-    const summarySerializerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName), 'summary');
-    const defaultSerializerExtends = isSTI
-        ? `${serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName))}(${modelClassName}, ${modelSerializerArgs})`
-        : `${summarySerializerClassName}(${stiBaseSerializer ? 'StiChildClass, ' : ''}${modelSerializerArgs})`;
-    const summarySerializerExtends = isSTI
-        ? `${serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName), 'summary')}(${modelClassName}, ${modelSerializerArgs})`
-        : `DreamSerializer(${dreamSerializerArgs})`;
-    // Admin variants
-    const adminSerializerClassName = serializerClassName.replace(/Serializer$/, 'AdminSerializer');
-    const adminSummarySerializerClassName = summarySerializerClassName.replace(/SummarySerializer$/, 'AdminSummarySerializer');
-    // end:Admin variants
-    // Internal variants
-    const internalSerializerClassName = serializerClassName.replace(/Serializer$/, 'InternalSerializer');
-    const internalSummarySerializerClassName = summarySerializerClassName.replace(/SummarySerializer$/, 'InternalSummarySerializer');
-    // end:Internal variants
+    const localSerializerBase = fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName);
+    const parentSerializerBase = isSTI
+        ? fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName)
+        : '';
     const additionalModelImports = [];
     const dreamImport = dreamImports.length
         ? `import { ${uniq(dreamImports).join(', ')} } from '@rvoh/dream'\n`
         : '';
     const additionalImportsStr = uniq(additionalImports).join('');
-    const summarySerializer = `export const ${summarySerializerClassName} = ${modelSerializerSignature} =>
-  ${summarySerializerExtends}${isSTI ? '' : `\n    .attribute('id')`}`;
-    const defaultSerializer = `export const ${serializerClassName} = ${modelSerializerSignature} =>
-  ${defaultSerializerExtends}${columnsWithTypes
-        .map(attr => {
-        const [name, type] = attr.split(':');
-        if (name === undefined)
-            return '';
-        if (['belongsto', 'hasone', 'hasmany'].includes(camelize(type)?.toLowerCase()))
-            return '';
-        return `\n    ${attribute(modelClassName, name, type, attr, stiBaseSerializer)}`;
-    })
-        .join('')}`;
+    const buildSerializerPair = (variantSuffix) => {
+        const summaryName = variantSerializerClassName(localSerializerBase, variantSuffix, 'summary');
+        const defaultName = variantSerializerClassName(localSerializerBase, variantSuffix, 'default');
+        const summaryExtends = isSTI
+            ? `${variantSerializerClassName(parentSerializerBase, variantSuffix, 'summary')}(${modelClassName}, ${modelSerializerArgs})`
+            : `DreamSerializer(${dreamSerializerArgs})`;
+        const defaultExtends = isSTI
+            ? `${variantSerializerClassName(parentSerializerBase, variantSuffix, 'default')}(${modelClassName}, ${modelSerializerArgs})`
+            : `${summaryName}(${stiBaseSerializer ? 'StiChildClass, ' : ''}${modelSerializerArgs})`;
+        const summary = `export const ${summaryName} = ${modelSerializerSignature} =>
+  ${summaryExtends}${isSTI ? '' : `\n    .attribute('id')`}`;
+        const defaultBody = columnsWithTypes
+            .map(attr => {
+            const [name, type] = attr.split(':');
+            if (name === undefined)
+                return '';
+            if (['belongsto', 'hasone', 'hasmany'].includes(camelize(type)?.toLowerCase()))
+                return '';
+            return `\n    ${attribute(modelClassName, name, type, attr, stiBaseSerializer)}`;
+        })
+            .join('');
+        const def = `export const ${defaultName} = ${modelSerializerSignature} =>
+  ${defaultExtends}${defaultBody}`;
+        return `${summary}\n\n${def}`;
+    };
+    const serializerBlocks = variantSuffixes.map(buildSerializerPair).join('\n\n');
     return `${dreamImport}${additionalImportsStr}${relatedModelImport}${additionalModelImports.join('')}
-${summarySerializer}
-
-${defaultSerializer}${!includeAdminSerializers
-        ? ''
-        : `
-
-${summarySerializer.replace(summarySerializerClassName, adminSummarySerializerClassName)}
-
-${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}${!includeInternalSerializers
-        ? ''
-        : `
-
-${summarySerializer.replace(summarySerializerClassName, internalSummarySerializerClassName)}
-
-${defaultSerializer.replace(serializerClassName, internalSerializerClassName).replace(summarySerializerClassName, internalSummarySerializerClassName)}`}
+${serializerBlocks}
 `;
 }
+function variantSerializerClassName(serializerBase, variantSuffix, kind) {
+    return kind === 'summary'
+        ? `${serializerBase}${variantSuffix}SummarySerializer`
+        : `${serializerBase}${variantSuffix}Serializer`;
+}
 function attribute(modelClassName, name, type, attr, stiBaseSerializer) {
     if (name === 'type' && stiBaseSerializer) {
         return `.attribute('type', { openapi: { type: 'string', enum: [(StiChildClass ?? ${modelClassName}).sanitizedName] } })`;
@@ -97,11 +97,14 @@ function attributeOptionsSpecifier(type, attr) {
             return '';
     }
 }
-function importStatementForSerializer(originModelName, destinationModelName) {
-    const defaultSerializer = globalClassNameFromFullyQualifiedModelName(serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(destinationModelName)));
-    const summarySerializer = globalClassNameFromFullyQualifiedModelName(serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(destinationModelName), 'summary'));
+function importStatementForSerializer(originModelName, destinationModelName, variantSuffixes) {
+    const base = fullyQualifiedModelNameToSerializerBaseName(destinationModelName);
+    const names = variantSuffixes.flatMap(suffix => [
+        globalClassNameFromFullyQualifiedModelName(variantSerializerClassName(base, suffix, 'default')),
+        globalClassNameFromFullyQualifiedModelName(variantSerializerClassName(base, suffix, 'summary')),
+    ]);
     const importFrom = absoluteDreamPath('serializers', destinationModelName);
-    return `import { ${defaultSerializer}, ${summarySerializer} } from '${importFrom}'\n`;
+    return `import { ${names.join(', ')} } from '${importFrom}'\n`;
 }
 function importStatementForModel(modelClassName, fullyQualifiedModelName) {
     const importFrom = absoluteDreamPath('models', fullyQualifiedModelName);