@rvoh/dream 0.45.1 → 0.45.3

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

@@ -21,13 +21,17 @@ class DreamBin {
         await Query_js_1.default.dbDriverClass().rollback(opts);
     }
     static async generateDream(fullyQualifiedModelName, columnsWithTypes, options) {
-        await (0, generateDream_js_1.default)({ fullyQualifiedModelName, columnsWithTypes, options });
+        await (0, generateDream_js_1.default)({
+            fullyQualifiedModelName,
+            columnsWithTypes,
+            options: { includeAdminSerializers: false, ...options },
+        });
     }
     static async generateStiChild(fullyQualifiedModelName, fullyQualifiedParentName, columnsWithTypes, options) {
         await (0, generateDream_js_1.default)({
             fullyQualifiedModelName,
             columnsWithTypes,
-            options: { ...options, stiBaseSerializer: false },
+            options: { includeAdminSerializers: false, ...options, stiBaseSerializer: false },
             fullyQualifiedParentName,
         });
     }

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

@@ -6,6 +6,50 @@ 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");
+const INDENT = '                  ';
+const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
+${INDENT}    title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to
+${INDENT}
+${INDENT}all properties default to not nullable; null can be allowed by appending ':optional':
+${INDENT}    subtitle:string:optional
+${INDENT}
+${INDENT}supported types:
+${INDENT}    - citext:
+${INDENT}        case insensitive text (indexes and queries are automatically case insensitive)
+${INDENT}
+${INDENT}    - string:
+${INDENT}        varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional
+${INDENT}
+${INDENT}    - text
+${INDENT}    - date
+${INDENT}    - datetime
+${INDENT}    - integer
+${INDENT}
+${INDENT}    - decimal:
+${INDENT}        scale,precision is required, e.g.: volume:decimal:3,2 or volume:decimal:3,2:optional
+${INDENT}
+${INDENT}    - enum:
+${INDENT}        include the enum name to automatically create the enum:
+${INDENT}          type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional
+${INDENT}
+${INDENT}        omit the enum values to leverage an existing enum (omits the enum type creation):
+${INDENT}          type:enum:room_types or type:enum:room_types:optional`;
+const columnsWithTypesDescription = baseColumnsWithTypesDescription +
+    `
+${INDENT}
+${INDENT}    - belongs_to:
+${INDENT}        not only adds a foreign key to the migration, but also adds a BelongsTo association to the generated model:
+${INDENT}
+${INDENT}        include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
+${INDENT}          Health/Coach:belongs_to`;
+const columnsWithTypesDescriptionForMigration = baseColumnsWithTypesDescription +
+    `
+${INDENT}
+${INDENT}    - belongs_to:
+${INDENT}        adds a foreign key to migration
+${INDENT}
+${INDENT}        include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
+${INDENT}          Health/Coach:belongs_to`;
 class DreamCLI {
     /**
      * use this method for initializing a standalone dream application. If using Psychic and Dream together,
@@ -35,7 +79,7 @@ class DreamCLI {
             .alias('g:migration')
             .description('create a new migration')
             .argument('<migrationName>', 'end with -to-table-name to prepopulate with an alterTable command')
-            .argument('[columnsWithTypes...]', 'properties of the model column1:text/string/enum/etc. column2:text/string/enum/etc. ... columnN:text/string/enum/etc.')
+            .argument('[columnsWithTypes...]', columnsWithTypesDescriptionForMigration)
             .action(async (migrationName, columnsWithTypes) => {
             await initializeDreamApp();
             await index_js_1.default.generateMigration(migrationName, columnsWithTypes);
@@ -47,10 +91,10 @@ class DreamCLI {
             .alias('generate:dream')
             .alias('g:dream')
             .option('--no-serializer')
-            .option('--sti-base-serializer', 'Omits the serializer from the dream model, but does create the serializer so it can be extended by STI children')
+            .option('--sti-base-serializer')
             .description('create a new Dream model')
             .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
-            .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
+            .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (modelName, columnsWithTypes, options) => {
             await initializeDreamApp();
             await index_js_1.default.generateDream(modelName, columnsWithTypes, options);
@@ -62,9 +106,11 @@ class DreamCLI {
             .description('create a new Dream model that extends another Dream model, leveraging STI (single table inheritance)')
             .option('--no-serializer')
             .argument('<childModelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
-            .argument('<extends>', 'just the word extends')
-            .argument('<parentModelName>', 'name of the parent model')
-            .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
+            .argument('<extends>', 'just the word "extends"')
+            .argument('<parentModelName>', `fully qualified name of the parent model, e.g.:
+${INDENT}    to extend the Room model in src/app/models/Room: Room
+${INDENT}    to extend the Coach model in src/app/models/Health/Coach: Health/Coach`)
+            .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (childModelName, extendsWord, parentModelName, columnsWithTypes, options) => {
             await initializeDreamApp();
             if (extendsWord !== 'extends')

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

@@ -20,7 +20,8 @@ async function generateDream({ fullyQualifiedModelName, columnsWithTypes, option
             fullyQualifiedModelName,
             columnsWithTypes,
             fullyQualifiedParentName,
-            serializer: options.serializer && !options.stiBaseSerializer,
+            serializer: options.serializer,
+            includeAdminSerializers: options.includeAdminSerializers,
         }));
     }
     catch (error) {
@@ -40,6 +41,7 @@ async function generateDream({ fullyQualifiedModelName, columnsWithTypes, option
             columnsWithTypes,
             fullyQualifiedParentName,
             stiBaseSerializer: options.stiBaseSerializer,
+            includeAdminSerializers: options.includeAdminSerializers,
         });
     const isSTI = !!fullyQualifiedParentName;
     if (columnsWithTypes.length || !isSTI) {

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

@@ -9,7 +9,7 @@ const relativeDreamPath_js_1 = require("../path/relativeDreamPath.js");
 const snakeify_js_1 = require("../snakeify.js");
 const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
 const uniq_js_1 = require("../uniq.js");
-function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, }) {
+function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, includeAdminSerializers, }) {
     fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
     const modelClassName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
     let parentModelClassName;
@@ -92,7 +92,11 @@ ${isSTI
         ? `  public ${isSTI ? 'override ' : ''}get serializers(): DreamSerializers<${modelClassName}> {
     return {
       default: '${(0, serializerGlobalNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName)}',
-      summary: '${(0, serializerGlobalNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName, 'summary')}',
+      summary: '${(0, serializerGlobalNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName, 'summary')}',${!includeAdminSerializers
+            ? ''
+            : `
+      admin: '${(0, serializerGlobalNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName).replace(/Serializer$/, 'AdminSerializer')}',
+      adminSummary: '${(0, serializerGlobalNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName, 'summary').replace(/SummarySerializer$/, 'AdminSummarySerializer')}',`}
     }
   }
 

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

@@ -6,6 +6,7 @@ const globalClassNameFromFullyQualifiedModelName_js_1 = require("../globalClassN
 const relativeDreamPath_js_1 = require("../path/relativeDreamPath.js");
 const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
 const uniq_js_1 = require("../uniq.js");
+const generateMigrationContent_js_1 = require("./generateMigrationContent.js");
 function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, }) {
     fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
     const dreamImports = ['UpdateableProperties'];
@@ -13,37 +14,58 @@ function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, })
     const belongsToNames = [];
     const belongsToTypedNames = [];
     const associationCreationStatements = [];
-    const stringAttributes = [];
-    let firstStringAttr = true;
+    const attributeDefaults = [];
+    let counterVariableIncremented = false;
     for (const attribute of columnsWithTypes) {
         const [attributeName, attributeType, ...descriptors] = attribute.split(':');
         if (attributeName === undefined)
             continue;
-        const fullyQualifiedAssociatedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(attributeName);
-        const associationModelName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedAssociatedModelName);
-        const associationFactoryImportStatement = `import create${associationModelName} from '${(0, relativeDreamPath_js_1.default)('factories', 'factories', fullyQualifiedModelName, fullyQualifiedAssociatedModelName)}'`;
-        const associationName = (0, camelize_js_1.default)(associationModelName);
-        if (attributeName === undefined)
+        if (attributeType === undefined)
+            continue;
+        const optional = (0, generateMigrationContent_js_1.optionalFromDescriptors)(descriptors);
+        if (optional)
             continue;
-        if (/_type$/.test(attributeName))
+        const attributeVariable = (0, camelize_js_1.default)(attributeName.replace(/\//g, ''));
+        if (/(_type|_id)$/.test(attributeName))
             continue;
         if (!attributeType)
-            throw new Error(`Must pass a column type for ${fullyQualifiedAssociatedModelName} (i.e. ${fullyQualifiedAssociatedModelName}:string)`);
+            throw new Error(`Must pass a column type for ${attributeName} (i.e. ${attributeName}:string)`);
         switch (attributeType) {
-            case 'belongs_to':
-                belongsToNames.push(associationName);
-                belongsToTypedNames.push(`${associationName}: ${associationModelName}`);
+            case 'belongs_to': {
+                const fullyQualifiedAssociatedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(attributeName);
+                const associationModelName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedAssociatedModelName);
+                const associationFactoryImportStatement = `import create${associationModelName} from '${(0, relativeDreamPath_js_1.default)('factories', 'factories', fullyQualifiedModelName, fullyQualifiedAssociatedModelName)}'`;
+                belongsToNames.push(attributeVariable);
+                belongsToTypedNames.push(`${attributeVariable}: ${associationModelName}`);
                 additionalImports.push(associationFactoryImportStatement);
-                associationCreationStatements.push(`${associationName}: await create${associationModelName}(),`);
+                associationCreationStatements.push(`${attributeVariable}: attrs.${attributeVariable} ? null : await create${associationModelName}(),`);
                 break;
+            }
             case 'string':
             case 'text':
             case 'citext':
-                stringAttributes.push(`${(0, camelize_js_1.default)(attributeName)}: \`${fullyQualifiedModelName} ${(0, camelize_js_1.default)(attributeName)} ${firstStringAttr ? '${++counter}' : '${counter}'}\`,`);
-                firstStringAttr = false;
+                attributeDefaults.push(`${attributeVariable}: \`${fullyQualifiedModelName} ${attributeVariable} ${counterVariableIncremented ? '${counter}' : '${++counter}'}\`,`);
+                counterVariableIncremented = true;
                 break;
             case 'enum':
-                stringAttributes.push(`${(0, camelize_js_1.default)(attributeName)}: '${(descriptors.at(-1) || '<tbd>').split(',')[0]}',`);
+                attributeDefaults.push(`${attributeVariable}: '${(descriptors.at(-1) || '<tbd>').split(',')[0]}',`);
+                break;
+            case 'integer':
+                attributeDefaults.push(`${attributeVariable}: 1,`);
+                break;
+            case 'bigint':
+                attributeDefaults.push(`${attributeVariable}: '11111111111111111',`);
+                break;
+            case 'decimal':
+                attributeDefaults.push(`${attributeVariable}: 1.1,`);
+                break;
+            case 'date':
+                dreamImports.push('CalendarDate');
+                attributeDefaults.push(`${attributeVariable}: CalendarDate.today(),`);
+                break;
+            case 'datetime':
+                dreamImports.push('DateTime');
+                attributeDefaults.push(`${attributeVariable}: DateTime.now(),`);
                 break;
             default:
             // noop
@@ -54,10 +76,10 @@ function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, })
     return `\
 import { ${(0, uniq_js_1.default)(dreamImports).join(', ')} } from '@rvoh/dream'
 import ${modelClassName} from '${relativePath}'${additionalImports.length ? '\n' + (0, uniq_js_1.default)(additionalImports).join('\n') : ''}
-${stringAttributes.length ? '\nlet counter = 0\n' : ''}
+${counterVariableIncremented ? '\nlet counter = 0\n' : ''}
 export default async function create${modelClassName}(attrs: UpdateableProperties<${modelClassName}> = {}) {
   return await ${modelClassName}.create({
-    ${associationCreationStatements.length ? associationCreationStatements.join('\n    ') + '\n    ' : ''}${stringAttributes.length ? stringAttributes.join('\n    ') + '\n    ' : ''}...attrs,
+    ${associationCreationStatements.length ? associationCreationStatements.join('\n    ') + '\n    ' : ''}${attributeDefaults.length ? attributeDefaults.join('\n    ') + '\n    ' : ''}...attrs,
   })
 }
 `;

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

@@ -1,19 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = generateMigrationContent;
+exports.optionalFromDescriptors = optionalFromDescriptors;
 const pluralize_esm_1 = require("pluralize-esm");
 const InvalidDecimalFieldPassedToGenerator_js_1 = require("../../errors/InvalidDecimalFieldPassedToGenerator.js");
+const compact_js_1 = require("../compact.js");
 const foreignKeyTypeFromPrimaryKey_js_1 = require("../db/foreignKeyTypeFromPrimaryKey.js");
 const snakeify_js_1 = require("../snakeify.js");
 const STI_TYPE_COLUMN_NAME = 'type';
 const COLUMNS_TO_INDEX = [STI_TYPE_COLUMN_NAME];
-const NOT_NULL_COLUMNS = [STI_TYPE_COLUMN_NAME];
 function generateMigrationContent({ table, columnsWithTypes = [], primaryKeyType = 'bigserial', createOrAlter = 'create', } = {}) {
     const altering = createOrAlter === 'alter';
     let requireCitextExtension = false;
     const { columnDefs, columnDrops, indexDefs, indexDrops } = columnsWithTypes.reduce((acc, attribute) => {
         const { columnDefs, columnDrops, indexDefs, indexDrops } = acc;
         const [nonStandardAttributeName, attributeType, ...descriptors] = attribute.split(':');
+        const optional = optionalFromDescriptors(descriptors);
+        const sqlAttributeType = getAttributeType(attributeType, descriptors);
         let attributeName = (0, snakeify_js_1.default)(nonStandardAttributeName);
         if (attributeName === undefined)
             return acc;
@@ -21,30 +24,29 @@ function generateMigrationContent({ table, columnsWithTypes = [], primaryKeyType
             return acc;
         if (attributeType === 'citext')
             requireCitextExtension = true;
-        const coercedAttributeType = getAttributeType(attribute);
         switch (attributeType) {
             case 'belongs_to':
                 columnDefs.push(generateBelongsToStr(attributeName, {
                     primaryKeyType,
-                    optional: descriptors.includes('optional'),
+                    optional,
                 }));
                 attributeName = associationNameToForeignKey(attributeName);
                 break;
             case 'enum':
-                columnDefs.push(generateEnumStr(attribute));
+                columnDefs.push(generateEnumStr(attributeName, { descriptors, optional }));
                 break;
             case 'decimal':
-                columnDefs.push(generateDecimalStr(attribute));
+                columnDefs.push(generateDecimalStr(attributeName, { descriptors, optional }));
                 break;
             case 'boolean':
-                columnDefs.push(generateBooleanStr(attributeName));
+                columnDefs.push(generateBooleanStr(attributeName, { optional }));
                 break;
             case 'encrypted':
-                columnDefs.push(generateColumnStr(`encrypted_${attributeName}`, 'text', descriptors));
+                columnDefs.push(generateColumnStr(`encrypted_${attributeName}`, 'text', descriptors, { optional }));
                 break;
             default:
-                if (coercedAttributeType !== undefined) {
-                    columnDefs.push(generateColumnStr(attributeName, coercedAttributeType, descriptors));
+                if (sqlAttributeType !== undefined) {
+                    columnDefs.push(generateColumnStr(attributeName, sqlAttributeType, descriptors, { optional }));
                 }
                 break;
         }
@@ -109,31 +111,29 @@ export async function down(db: Kysely<any>): Promise<void> {
 }\
 `;
 }
-function getAttributeType(attribute) {
-    const [, attributeType, ...descriptors] = attribute.split(':');
-    if (attributeType === 'enum') {
-        return enumAttributeType(attribute)[0];
-    }
+function getAttributeType(attributeType, descriptors) {
     switch (attributeType) {
-        case 'datetime':
-            return 'timestamp';
         case 'string':
             return `varchar(${descriptors[0] || 255})`;
+        case 'enum':
+            return enumAttributeType(descriptors);
+        case 'datetime':
+            return 'timestamp';
         default:
             return attributeType;
     }
 }
-function enumAttributeType(attribute) {
-    const [, , ...descriptors] = attribute.split(':');
+function enumAttributeType(descriptors) {
     return `sql\`${descriptors[0]}_enum\``;
 }
 function generateEnumStatements(columnsWithTypes) {
     const enumStatements = columnsWithTypes.filter(attribute => /:enum:.*:/.test(attribute));
-    const finalStatements = enumStatements.map(statement => {
-        const enumName = statement.split(':')[2];
-        const columnsWithTypesString = statement.split(':')[3];
+    const finalStatements = (0, compact_js_1.default)(enumStatements.map(statement => {
+        const [, , enumName, ...descriptors] = statement.split(':');
+        optionalFromDescriptors(descriptors);
+        const columnsWithTypesString = descriptors[0];
         if (columnsWithTypesString === undefined)
-            return '';
+            return;
         const columnsWithTypes = columnsWithTypesString.split(/,\s{0,}/);
         return `  await db.schema
     .createType('${enumName}_enum')
@@ -141,40 +141,41 @@ function generateEnumStatements(columnsWithTypes) {
       ${columnsWithTypes.map(attr => `'${attr}'`).join(',\n      ')}
     ])
     .execute()`;
-    });
+    }));
     return finalStatements.length ? finalStatements.join('\n\n') + '\n\n' : '';
 }
 function generateEnumDropStatements(columnsWithTypes) {
     const enumStatements = columnsWithTypes.filter(attribute => /:enum:.*:/.test(attribute));
-    const finalStatements = enumStatements.map(statement => {
-        const enumName = statement.split(':')[2];
+    const finalStatements = (0, compact_js_1.default)(enumStatements.map(statement => {
+        const [, , enumName, ...descriptors] = statement.split(':');
+        optionalFromDescriptors(descriptors);
+        const columnsWithTypesString = descriptors[0];
+        if (columnsWithTypesString === undefined)
+            return;
         return `await db.schema.dropType('${enumName}_enum').execute()`;
-    });
+    }));
     return finalStatements.length ? '\n\n  ' + finalStatements.join('\n  ') : '';
 }
-function generateBooleanStr(attributeName) {
-    return `.addColumn('${attributeName}', 'boolean', col => col.notNull().defaultTo(false))`;
+function generateBooleanStr(attributeName, { optional }) {
+    return `.addColumn('${attributeName}', 'boolean'${optional ? '' : ', col => col.notNull().defaultTo(false)'})`;
 }
-function generateEnumStr(attribute) {
-    const computedAttributeType = enumAttributeType(attribute);
-    const attributeName = attribute.split(':')[0];
+function generateEnumStr(attributeName, { descriptors, optional }) {
+    const computedAttributeType = enumAttributeType(descriptors);
     if (attributeName === undefined)
         return '';
-    const notNull = NOT_NULL_COLUMNS.includes(attributeName);
-    return `.addColumn('${attributeName}', ${computedAttributeType}${notNull ? ', col => col.notNull()' : ''})`;
+    return `.addColumn('${attributeName}', ${computedAttributeType}${optional ? '' : ', col => col.notNull()'})`;
 }
-function generateDecimalStr(attribute) {
-    const [, , ...descriptors] = attribute.split(':');
+function generateDecimalStr(attributeName, { descriptors, optional }) {
     const [scale, precision] = descriptors[0]?.split(',') || [null, null];
     if (!scale || !precision)
-        throw new InvalidDecimalFieldPassedToGenerator_js_1.default(attribute);
-    return `.addColumn('${attribute.split(':')[0]}', 'decimal(${scale}, ${precision})')`;
+        throw new InvalidDecimalFieldPassedToGenerator_js_1.default(attributeName);
+    return `.addColumn('${attributeName}', 'decimal(${scale}, ${precision})'${optional ? '' : ', col => col.notNull()'})`;
 }
-function generateColumnStr(attributeName, attributeType, descriptors) {
+function generateColumnStr(attributeName, attributeType, descriptors, { optional }) {
     let returnStr = `.addColumn('${attributeName}', ${attributeTypeString(attributeType)}`;
     const providedDefaultArg = descriptors.find(d => /^default\(/.test(d));
     const providedDefault = providedDefaultArg?.replace(/^default\(/, '')?.replace(/\)$/, '');
-    const notNull = NOT_NULL_COLUMNS.includes(attributeName);
+    const notNull = !optional;
     const hasExtraValues = providedDefault || notNull;
     if (hasExtraValues)
         returnStr += ', col => col';
@@ -226,3 +227,9 @@ function generateIdStr({ primaryKeyType }) {
 function associationNameToForeignKey(associationName) {
     return (0, snakeify_js_1.default)(associationName.replace(/\//g, '_').replace(/_id$/, '') + '_id');
 }
+function optionalFromDescriptors(descriptors) {
+    const optional = descriptors.at(-1) === 'optional';
+    if (optional)
+        descriptors.pop();
+    return optional;
+}

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

@@ -6,7 +6,7 @@ const dreamFileAndDirPaths_js_1 = require("../path/dreamFileAndDirPaths.js");
 const dreamPath_js_1 = require("../path/dreamPath.js");
 const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
 const generateSerializerContent_js_1 = require("./generateSerializerContent.js");
-async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, }) {
+async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, }) {
     fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
     const { relFilePath, absDirPath, absFilePath } = (0, dreamFileAndDirPaths_js_1.default)((0, dreamPath_js_1.default)('serializers'), `${fullyQualifiedModelName}Serializer.ts`);
     try {
@@ -17,6 +17,7 @@ async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, f
             columnsWithTypes,
             fullyQualifiedParentName,
             stiBaseSerializer,
+            includeAdminSerializers,
         }));
     }
     catch (error) {

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

@@ -7,7 +7,7 @@ const globalClassNameFromFullyQualifiedModelName_js_1 = require("../globalClassN
 const relativeDreamPath_js_1 = require("../path/relativeDreamPath.js");
 const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
 const uniq_js_1 = require("../uniq.js");
-function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer = false, }) {
+function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, }) {
     fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
     const additionalImports = [];
     const dreamImports = [];
@@ -26,8 +26,8 @@ function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes =
         ? `<T extends ${modelClassName}>(StiChildClass: typeof ${modelClassName}, ${modelInstanceName}: T)`
         : `(${modelInstanceName}: ${modelClassName})`;
     const modelSerializerArgs = `${modelInstanceName}`;
-    const dreamSerializerArgs = `${stiBaseSerializer ? 'StiChildClass' : modelClassName}, ${modelInstanceName}`;
-    const serialzerClassName = (0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
+    const dreamSerializerArgs = `${stiBaseSerializer ? `StiChildClass ?? ${modelClassName}` : modelClassName}, ${modelInstanceName}`;
+    const serializerClassName = (0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
     const summarySerializerClassName = (0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName), 'summary');
     const defaultSerializerExtends = isSTI
         ? `${(0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName))}(${modelClassName}, ${modelSerializerArgs})`
@@ -35,16 +35,18 @@ function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes =
     const summarySerializerExtends = isSTI
         ? `${(0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName), 'summary')}(${modelClassName}, ${modelSerializerArgs})`
         : `DreamSerializer(${dreamSerializerArgs})`;
+    // Admin variants
+    const adminSerializerClassName = serializerClassName.replace(/Serializer$/, 'AdminSerializer');
+    const adminSummarySerializerClassName = summarySerializerClassName.replace(/SummarySerializer$/, 'AdminSummarySerializer');
+    // end:Admin variants
     const additionalModelImports = [];
     const dreamImport = dreamImports.length
         ? `import { ${(0, uniq_js_1.default)(dreamImports).join(', ')} } from '@rvoh/dream'\n`
         : '';
     const additionalImportsStr = (0, uniq_js_1.default)(additionalImports).join('');
-    return `${dreamImport}${additionalImportsStr}${relatedModelImport}${additionalModelImports.join('')}
-export const ${summarySerializerClassName} = ${modelSerializerSignature} =>
-  ${summarySerializerExtends}${isSTI ? '' : `\n    .attribute('id')`}
-
-export const ${serialzerClassName} = ${modelSerializerSignature} =>
+    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(':');
@@ -54,7 +56,17 @@ export const ${serialzerClassName} = ${modelSerializerSignature} =>
             return '';
         return `\n    ${attribute(name, type, attr)}`;
     })
-        .join('\n\n  ')}
+        .join('')}`;
+    return `${dreamImport}${additionalImportsStr}${relatedModelImport}${additionalModelImports.join('')}
+${summarySerializer}
+
+${defaultSerializer}${!includeAdminSerializers
+        ? ''
+        : `
+
+${summarySerializer.replace(summarySerializerClassName, adminSummarySerializerClassName)}
+
+${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}
 `;
 }
 function attribute(name, type, attr) {
@@ -80,7 +92,7 @@ function importStatementForSerializer(originModelName, destinationModelName) {
     const defaultSerializer = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)((0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(destinationModelName)));
     const summarySerializer = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)((0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(destinationModelName), 'summary'));
     const importFrom = (0, relativeDreamPath_js_1.default)('serializers', 'serializers', originModelName, destinationModelName);
-    return `import ${defaultSerializer}, { ${summarySerializer} } from '${importFrom}'\n`;
+    return `import { ${defaultSerializer}, ${summarySerializer} } from '${importFrom}'\n`;
 }
 function importStatementForModel(originModelName, destinationModelName = originModelName) {
     const modelName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(destinationModelName);

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

@@ -19,13 +19,17 @@ export default class DreamBin {
         await Query.dbDriverClass().rollback(opts);
     }
     static async generateDream(fullyQualifiedModelName, columnsWithTypes, options) {
-        await generateDream({ fullyQualifiedModelName, columnsWithTypes, options });
+        await generateDream({
+            fullyQualifiedModelName,
+            columnsWithTypes,
+            options: { includeAdminSerializers: false, ...options },
+        });
     }
     static async generateStiChild(fullyQualifiedModelName, fullyQualifiedParentName, columnsWithTypes, options) {
         await generateDream({
             fullyQualifiedModelName,
             columnsWithTypes,
-            options: { ...options, stiBaseSerializer: false },
+            options: { includeAdminSerializers: false, ...options, stiBaseSerializer: false },
             fullyQualifiedParentName,
         });
     }

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

@@ -4,6 +4,50 @@ import DreamApp from '../dream-app/index.js';
 import EnvInternal from '../helpers/EnvInternal.js';
 import sspawn from '../helpers/sspawn.js';
 import DreamCliLogger from './logger/DreamCliLogger.js';
+const INDENT = '                  ';
+const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
+${INDENT}    title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to
+${INDENT}
+${INDENT}all properties default to not nullable; null can be allowed by appending ':optional':
+${INDENT}    subtitle:string:optional
+${INDENT}
+${INDENT}supported types:
+${INDENT}    - citext:
+${INDENT}        case insensitive text (indexes and queries are automatically case insensitive)
+${INDENT}
+${INDENT}    - string:
+${INDENT}        varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional
+${INDENT}
+${INDENT}    - text
+${INDENT}    - date
+${INDENT}    - datetime
+${INDENT}    - integer
+${INDENT}
+${INDENT}    - decimal:
+${INDENT}        scale,precision is required, e.g.: volume:decimal:3,2 or volume:decimal:3,2:optional
+${INDENT}
+${INDENT}    - enum:
+${INDENT}        include the enum name to automatically create the enum:
+${INDENT}          type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional
+${INDENT}
+${INDENT}        omit the enum values to leverage an existing enum (omits the enum type creation):
+${INDENT}          type:enum:room_types or type:enum:room_types:optional`;
+const columnsWithTypesDescription = baseColumnsWithTypesDescription +
+    `
+${INDENT}
+${INDENT}    - belongs_to:
+${INDENT}        not only adds a foreign key to the migration, but also adds a BelongsTo association to the generated model:
+${INDENT}
+${INDENT}        include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
+${INDENT}          Health/Coach:belongs_to`;
+const columnsWithTypesDescriptionForMigration = baseColumnsWithTypesDescription +
+    `
+${INDENT}
+${INDENT}    - belongs_to:
+${INDENT}        adds a foreign key to migration
+${INDENT}
+${INDENT}        include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
+${INDENT}          Health/Coach:belongs_to`;
 export default class DreamCLI {
     /**
      * use this method for initializing a standalone dream application. If using Psychic and Dream together,
@@ -33,7 +77,7 @@ export default class DreamCLI {
             .alias('g:migration')
             .description('create a new migration')
             .argument('<migrationName>', 'end with -to-table-name to prepopulate with an alterTable command')
-            .argument('[columnsWithTypes...]', 'properties of the model column1:text/string/enum/etc. column2:text/string/enum/etc. ... columnN:text/string/enum/etc.')
+            .argument('[columnsWithTypes...]', columnsWithTypesDescriptionForMigration)
             .action(async (migrationName, columnsWithTypes) => {
             await initializeDreamApp();
             await DreamBin.generateMigration(migrationName, columnsWithTypes);
@@ -45,10 +89,10 @@ export default class DreamCLI {
             .alias('generate:dream')
             .alias('g:dream')
             .option('--no-serializer')
-            .option('--sti-base-serializer', 'Omits the serializer from the dream model, but does create the serializer so it can be extended by STI children')
+            .option('--sti-base-serializer')
             .description('create a new Dream model')
             .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
-            .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
+            .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (modelName, columnsWithTypes, options) => {
             await initializeDreamApp();
             await DreamBin.generateDream(modelName, columnsWithTypes, options);
@@ -60,9 +104,11 @@ export default class DreamCLI {
             .description('create a new Dream model that extends another Dream model, leveraging STI (single table inheritance)')
             .option('--no-serializer')
             .argument('<childModelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
-            .argument('<extends>', 'just the word extends')
-            .argument('<parentModelName>', 'name of the parent model')
-            .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
+            .argument('<extends>', 'just the word "extends"')
+            .argument('<parentModelName>', `fully qualified name of the parent model, e.g.:
+${INDENT}    to extend the Room model in src/app/models/Room: Room
+${INDENT}    to extend the Coach model in src/app/models/Health/Coach: Health/Coach`)
+            .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (childModelName, extendsWord, parentModelName, columnsWithTypes, options) => {
             await initializeDreamApp();
             if (extendsWord !== 'extends')

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

@@ -17,7 +17,8 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             fullyQualifiedModelName,
             columnsWithTypes,
             fullyQualifiedParentName,
-            serializer: options.serializer && !options.stiBaseSerializer,
+            serializer: options.serializer,
+            includeAdminSerializers: options.includeAdminSerializers,
         }));
     }
     catch (error) {
@@ -37,6 +38,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             columnsWithTypes,
             fullyQualifiedParentName,
             stiBaseSerializer: options.stiBaseSerializer,
+            includeAdminSerializers: options.includeAdminSerializers,
         });
     const isSTI = !!fullyQualifiedParentName;
     if (columnsWithTypes.length || !isSTI) {