@rvoh/dream 2.3.3 → 2.4.0

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

@@ -48,6 +48,7 @@ export default class DreamBin {
             columnsWithTypes,
             options: {
                 includeAdminSerializers: options.adminSerializers ?? false,
+                includeInternalSerializers: options.internalSerializers ?? false,
                 ...options,
             },
         });
@@ -58,6 +59,7 @@ export default class DreamBin {
             columnsWithTypes,
             options: {
                 includeAdminSerializers: options.adminSerializers ?? false,
+                includeInternalSerializers: options.internalSerializers ?? false,
                 ...options,
                 stiBaseSerializer: false,
             },

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

@@ -23,6 +23,9 @@ ${INDENT}    - citext:
 ${INDENT}    - citext[]:
 ${INDENT}        case insensitive text (indexes and queries are automatically case insensitive)
 ${INDENT}
+${INDENT}    - encrypted:
+${INDENT}        encrypted text (used in conjunction with the @deco.Encrypted decorator)
+${INDENT}
 ${INDENT}    - string:
 ${INDENT}    - string[]:
 ${INDENT}        varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional
@@ -135,6 +138,7 @@ export default class DreamCLI {
             .option('--table-name <tableName>', 'explicit table name to use instead of the auto-generated one (useful when model namespaces produce long names)')
             .option('--model-name <modelName>', 'explicit model class name to use instead of the auto-generated one (e.g. --model-name=Kitchen for Room/Kitchen)')
             .option('--admin-serializers', 'generate admin serializer variants (AdminSerializer and AdminSummarySerializer) in addition to the default serializers')
+            .option('--internal-serializers', 'generate internal serializer variants (InternalSerializer and InternalSummarySerializer) in addition to the default serializers')
             .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
             .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (modelName, columnsWithTypes, options) => {
@@ -150,6 +154,7 @@ export default class DreamCLI {
             .option('--connection-name', 'the db connection you want this model attached to (defaults to the default connection)', 'default')
             .option('--model-name <modelName>', 'explicit model class name to use instead of the auto-generated one (e.g. --model-name=Kitchen for Room/Kitchen)')
             .option('--admin-serializers', 'generate admin serializer variants (AdminSerializer and AdminSummarySerializer) in addition to the default serializers')
+            .option('--internal-serializers', 'generate internal serializer variants (InternalSerializer and InternalSummarySerializer) in addition to the default serializers')
             .argument('<childModelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
             .argument('<extends>', 'just the word "extends"')
             .argument('<parentModelName>', `fully qualified name of the parent model, e.g.:

package/dist/cjs/src/dream-app/helpers/globalModelKeyFromPath.js

@@ -1,7 +1,8 @@
+import * as path from 'node:path';
 import normalizeFilePath from './normalizeFilePath.js';
 export default function (filepath, dirPath) {
-    const normalizedDirPath = normalizeFilePath(dirPath);
-    const normalizedFilepath = normalizeFilePath(filepath);
+    const normalizedDirPath = normalizeFilePath(path.resolve(dirPath));
+    const normalizedFilepath = normalizeFilePath(path.resolve(filepath));
     const prefixPath = normalizedDirPath;
     return normalizedFilepath
         .replace(prefixPath, '')

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

@@ -18,6 +18,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             fullyQualifiedParentName,
             serializer: options.serializer,
             includeAdminSerializers: options.includeAdminSerializers,
+            includeInternalSerializers: options.includeInternalSerializers ?? false,
             connectionName: options.connectionName,
             tableName: options.tableName,
             modelClassName,
@@ -33,6 +34,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             fullyQualifiedParentName,
             stiBaseSerializer: options.stiBaseSerializer,
             includeAdminSerializers: options.includeAdminSerializers,
+            includeInternalSerializers: options.includeInternalSerializers ?? false,
             modelClassName,
         });
     const isSTI = !!fullyQualifiedParentName;

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

@@ -125,9 +125,10 @@ public ${associationForeignKey}: DreamColumn<${modelClassName}, '${associationNa
     };
 }
 export function createEncryptedAttribute(attributeName, attribute, modelClassName) {
+    const encryptedColumnName = camelize(`encrypted_${attributeName}`);
     const content = `
 @deco.Encrypted()
-public ${camelize(attributeName)}: ${getAttributeType(attribute, modelClassName)}`;
+public ${camelize(attributeName)}: DreamColumn<${modelClassName}, '${encryptedColumnName}'>`;
     return {
         content,
         imports: [],
@@ -177,10 +178,18 @@ function buildSerializersMethod(config, options) {
       admin: '${adminSerializer}',
       adminSummary: '${adminSummarySerializer}',`;
     }
+    let internalSerializers = '';
+    if (options.includeInternalSerializers) {
+        const internalSerializer = defaultSerializer.replace(/Serializer$/, 'InternalSerializer');
+        const internalSummarySerializer = summarySerializer.replace(/SummarySerializer$/, 'InternalSummarySerializer');
+        internalSerializers = `
+      internal: '${internalSerializer}',
+      internalSummary: '${internalSummarySerializer}',`;
+    }
     return `  public ${overrideKeyword}get serializers(): DreamSerializers<${config.modelClassName}> {
     return {
       default: '${defaultSerializer}',
-      summary: '${summarySerializer}',${adminSerializers}
+      summary: '${summarySerializer}',${adminSerializers}${internalSerializers}
     }
   }
 

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

@@ -1,4 +1,5 @@
 import camelize from '../camelize.js';
+import hyphenize from '../hyphenize.js';
 import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFullyQualifiedModelName.js';
 import absoluteDreamPath from '../path/absoluteDreamPath.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
@@ -45,10 +46,17 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
                 associationCreationStatements.push(`${attributeVariable}: attrs.${attributeVariable} ? null : await create${associationModelName}(),`);
                 break;
             }
+            case 'encrypted':
             case 'string':
             case 'text':
             case 'citext':
-                attributeDefaults.push(`${attributeVariable}: \`${fullyQualifiedModelName} ${attributeVariable} ${counterVariableIncremented ? '${counter}' : '${++counter}'}\`,`);
+                if (/email$/i.test(attributeVariable)) {
+                    const hyphenized = hyphenize(attributeVariable);
+                    attributeDefaults.push(`${attributeVariable}: \`${hyphenized}-${counterVariableIncremented ? '${counter}' : '${++counter}'}@example.com\`,`);
+                }
+                else {
+                    attributeDefaults.push(`${attributeVariable}: \`${fullyQualifiedModelName} ${attributeVariable} ${counterVariableIncremented ? '${counter}' : '${++counter}'}\`,`);
+                }
                 counterVariableIncremented = true;
                 break;
             case 'string[]':

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

@@ -1,6 +1,6 @@
 import generateSerializerContent from './generateSerializerContent.js';
 import writeGeneratedFile from './writeGeneratedFile.js';
-export default async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, modelClassName, }) {
+export default async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, includeInternalSerializers, modelClassName, }) {
     await writeGeneratedFile({
         dreamPathKey: 'serializers',
         fileName: `${fullyQualifiedModelName}Serializer.ts`,
@@ -10,6 +10,7 @@ export default async function generateSerializer({ fullyQualifiedModelName, colu
             fullyQualifiedParentName,
             stiBaseSerializer,
             includeAdminSerializers,
+            includeInternalSerializers: includeInternalSerializers ?? false,
             modelClassName,
         }),
         logLabel: 'serializer',

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

@@ -4,7 +4,7 @@ import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFu
 import absoluteDreamPath from '../path/absoluteDreamPath.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
 import uniq from '../uniq.js';
-export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, modelClassName, }) {
+export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, includeInternalSerializers, modelClassName, }) {
     fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
     const additionalImports = [];
     const dreamImports = [];
@@ -35,6 +35,10 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
     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 additionalModelImports = [];
     const dreamImport = dreamImports.length
         ? `import { ${uniq(dreamImports).join(', ')} } from '@rvoh/dream'\n`
@@ -62,7 +66,13 @@ ${defaultSerializer}${!includeAdminSerializers
 
 ${summarySerializer.replace(summarySerializerClassName, adminSummarySerializerClassName)}
 
-${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}
+${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}${!includeInternalSerializers
+        ? ''
+        : `
+
+${summarySerializer.replace(summarySerializerClassName, internalSummarySerializerClassName)}
+
+${defaultSerializer.replace(serializerClassName, internalSerializerClassName).replace(summarySerializerClassName, internalSummarySerializerClassName)}`}
 `;
 }
 function attribute(modelClassName, name, type, attr, stiBaseSerializer) {

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

@@ -48,6 +48,7 @@ export default class DreamBin {
             columnsWithTypes,
             options: {
                 includeAdminSerializers: options.adminSerializers ?? false,
+                includeInternalSerializers: options.internalSerializers ?? false,
                 ...options,
             },
         });
@@ -58,6 +59,7 @@ export default class DreamBin {
             columnsWithTypes,
             options: {
                 includeAdminSerializers: options.adminSerializers ?? false,
+                includeInternalSerializers: options.internalSerializers ?? false,
                 ...options,
                 stiBaseSerializer: false,
             },

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

@@ -23,6 +23,9 @@ ${INDENT}    - citext:
 ${INDENT}    - citext[]:
 ${INDENT}        case insensitive text (indexes and queries are automatically case insensitive)
 ${INDENT}
+${INDENT}    - encrypted:
+${INDENT}        encrypted text (used in conjunction with the @deco.Encrypted decorator)
+${INDENT}
 ${INDENT}    - string:
 ${INDENT}    - string[]:
 ${INDENT}        varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional
@@ -135,6 +138,7 @@ export default class DreamCLI {
             .option('--table-name <tableName>', 'explicit table name to use instead of the auto-generated one (useful when model namespaces produce long names)')
             .option('--model-name <modelName>', 'explicit model class name to use instead of the auto-generated one (e.g. --model-name=Kitchen for Room/Kitchen)')
             .option('--admin-serializers', 'generate admin serializer variants (AdminSerializer and AdminSummarySerializer) in addition to the default serializers')
+            .option('--internal-serializers', 'generate internal serializer variants (InternalSerializer and InternalSummarySerializer) in addition to the default serializers')
             .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
             .argument('[columnsWithTypes...]', columnsWithTypesDescription)
             .action(async (modelName, columnsWithTypes, options) => {
@@ -150,6 +154,7 @@ export default class DreamCLI {
             .option('--connection-name', 'the db connection you want this model attached to (defaults to the default connection)', 'default')
             .option('--model-name <modelName>', 'explicit model class name to use instead of the auto-generated one (e.g. --model-name=Kitchen for Room/Kitchen)')
             .option('--admin-serializers', 'generate admin serializer variants (AdminSerializer and AdminSummarySerializer) in addition to the default serializers')
+            .option('--internal-serializers', 'generate internal serializer variants (InternalSerializer and InternalSummarySerializer) in addition to the default serializers')
             .argument('<childModelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
             .argument('<extends>', 'just the word "extends"')
             .argument('<parentModelName>', `fully qualified name of the parent model, e.g.:

package/dist/esm/src/dream-app/helpers/globalModelKeyFromPath.js

@@ -1,7 +1,8 @@
+import * as path from 'node:path';
 import normalizeFilePath from './normalizeFilePath.js';
 export default function (filepath, dirPath) {
-    const normalizedDirPath = normalizeFilePath(dirPath);
-    const normalizedFilepath = normalizeFilePath(filepath);
+    const normalizedDirPath = normalizeFilePath(path.resolve(dirPath));
+    const normalizedFilepath = normalizeFilePath(path.resolve(filepath));
     const prefixPath = normalizedDirPath;
     return normalizedFilepath
         .replace(prefixPath, '')

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

@@ -18,6 +18,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             fullyQualifiedParentName,
             serializer: options.serializer,
             includeAdminSerializers: options.includeAdminSerializers,
+            includeInternalSerializers: options.includeInternalSerializers ?? false,
             connectionName: options.connectionName,
             tableName: options.tableName,
             modelClassName,
@@ -33,6 +34,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
             fullyQualifiedParentName,
             stiBaseSerializer: options.stiBaseSerializer,
             includeAdminSerializers: options.includeAdminSerializers,
+            includeInternalSerializers: options.includeInternalSerializers ?? false,
             modelClassName,
         });
     const isSTI = !!fullyQualifiedParentName;

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

@@ -125,9 +125,10 @@ public ${associationForeignKey}: DreamColumn<${modelClassName}, '${associationNa
     };
 }
 export function createEncryptedAttribute(attributeName, attribute, modelClassName) {
+    const encryptedColumnName = camelize(`encrypted_${attributeName}`);
     const content = `
 @deco.Encrypted()
-public ${camelize(attributeName)}: ${getAttributeType(attribute, modelClassName)}`;
+public ${camelize(attributeName)}: DreamColumn<${modelClassName}, '${encryptedColumnName}'>`;
     return {
         content,
         imports: [],
@@ -177,10 +178,18 @@ function buildSerializersMethod(config, options) {
       admin: '${adminSerializer}',
       adminSummary: '${adminSummarySerializer}',`;
     }
+    let internalSerializers = '';
+    if (options.includeInternalSerializers) {
+        const internalSerializer = defaultSerializer.replace(/Serializer$/, 'InternalSerializer');
+        const internalSummarySerializer = summarySerializer.replace(/SummarySerializer$/, 'InternalSummarySerializer');
+        internalSerializers = `
+      internal: '${internalSerializer}',
+      internalSummary: '${internalSummarySerializer}',`;
+    }
     return `  public ${overrideKeyword}get serializers(): DreamSerializers<${config.modelClassName}> {
     return {
       default: '${defaultSerializer}',
-      summary: '${summarySerializer}',${adminSerializers}
+      summary: '${summarySerializer}',${adminSerializers}${internalSerializers}
     }
   }
 

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

@@ -1,4 +1,5 @@
 import camelize from '../camelize.js';
+import hyphenize from '../hyphenize.js';
 import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFullyQualifiedModelName.js';
 import absoluteDreamPath from '../path/absoluteDreamPath.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
@@ -45,10 +46,17 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
                 associationCreationStatements.push(`${attributeVariable}: attrs.${attributeVariable} ? null : await create${associationModelName}(),`);
                 break;
             }
+            case 'encrypted':
             case 'string':
             case 'text':
             case 'citext':
-                attributeDefaults.push(`${attributeVariable}: \`${fullyQualifiedModelName} ${attributeVariable} ${counterVariableIncremented ? '${counter}' : '${++counter}'}\`,`);
+                if (/email$/i.test(attributeVariable)) {
+                    const hyphenized = hyphenize(attributeVariable);
+                    attributeDefaults.push(`${attributeVariable}: \`${hyphenized}-${counterVariableIncremented ? '${counter}' : '${++counter}'}@example.com\`,`);
+                }
+                else {
+                    attributeDefaults.push(`${attributeVariable}: \`${fullyQualifiedModelName} ${attributeVariable} ${counterVariableIncremented ? '${counter}' : '${++counter}'}\`,`);
+                }
                 counterVariableIncremented = true;
                 break;
             case 'string[]':

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

@@ -1,6 +1,6 @@
 import generateSerializerContent from './generateSerializerContent.js';
 import writeGeneratedFile from './writeGeneratedFile.js';
-export default async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, modelClassName, }) {
+export default async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, includeInternalSerializers, modelClassName, }) {
     await writeGeneratedFile({
         dreamPathKey: 'serializers',
         fileName: `${fullyQualifiedModelName}Serializer.ts`,
@@ -10,6 +10,7 @@ export default async function generateSerializer({ fullyQualifiedModelName, colu
             fullyQualifiedParentName,
             stiBaseSerializer,
             includeAdminSerializers,
+            includeInternalSerializers: includeInternalSerializers ?? false,
             modelClassName,
         }),
         logLabel: 'serializer',

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

@@ -4,7 +4,7 @@ import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFu
 import absoluteDreamPath from '../path/absoluteDreamPath.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
 import uniq from '../uniq.js';
-export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, modelClassName, }) {
+export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, includeInternalSerializers, modelClassName, }) {
     fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
     const additionalImports = [];
     const dreamImports = [];
@@ -35,6 +35,10 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
     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 additionalModelImports = [];
     const dreamImport = dreamImports.length
         ? `import { ${uniq(dreamImports).join(', ')} } from '@rvoh/dream'\n`
@@ -62,7 +66,13 @@ ${defaultSerializer}${!includeAdminSerializers
 
 ${summarySerializer.replace(summarySerializerClassName, adminSummarySerializerClassName)}
 
-${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}
+${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}${!includeInternalSerializers
+        ? ''
+        : `
+
+${summarySerializer.replace(summarySerializerClassName, internalSummarySerializerClassName)}
+
+${defaultSerializer.replace(serializerClassName, internalSerializerClassName).replace(summarySerializerClassName, internalSummarySerializerClassName)}`}
 `;
 }
 function attribute(modelClassName, name, type, attr, stiBaseSerializer) {

package/dist/types/src/bin/index.d.ts

@@ -15,12 +15,14 @@ export default class DreamBin {
         connectionName: string;
         tableName?: string;
         adminSerializers?: boolean;
+        internalSerializers?: boolean;
         modelName?: string;
     }): Promise<void>;
     static generateStiChild(fullyQualifiedModelName: string, fullyQualifiedParentName: string, columnsWithTypes: string[], options: {
         serializer: boolean;
         connectionName: string;
         adminSerializers?: boolean;
+        internalSerializers?: boolean;
         modelName?: string;
     }): Promise<void>;
     static generateMigration(migrationName: string, columnsWithTypes: string[], connectionName: string): Promise<void>;

package/dist/types/src/cli/index.d.ts

@@ -3,7 +3,7 @@ import { Command } from 'commander';
 import DreamApp, { DreamAppInitOptions } from '../dream-app/index.js';
 import DreamCliLogger from './logger/DreamCliLogger.js';
 export declare const CLI_INDENT = "                  ";
-export declare const baseColumnsWithTypesDescription = "space separated snake-case (except for belongs_to model name) properties like this:\n                      title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to\n                  \n                  all properties default to not nullable; null can be allowed by appending ':optional':\n                      subtitle:string:optional\n                  \n                  supported types:\n                      - uuid:\n                      - uuid[]:\n                          a column optimized for storing UUIDs\n                  \n                      - citext:\n                      - citext[]:\n                          case insensitive text (indexes and queries are automatically case insensitive)\n                  \n                      - string:\n                      - string[]:\n                          varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional\n                  \n                      - text\n                      - text[]\n                      - date\n                      - date[]\n                      - datetime\n                      - datetime[]\n                      - time\n                      - time[]\n                      - timetz\n                      - timetz[]\n                      - integer\n                      - integer[]\n                  \n                      - decimal:\n                      - decimal[]:\n                          precision,scale is required, e.g.: volume:decimal:3,2 or volume:decimal:3,2:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: volume:decimal[]:3,2\n                  \n                      - enum:\n                      - enum[]:\n                          include the enum name to automatically create the enum:\n                            type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional\n                  \n                          omit the enum values to leverage an existing enum (omits the enum type creation):\n                            type:enum:room_types or type:enum:room_types:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: type:enum[]:room_types:bathroom,kitchen,bedroom";
+export declare const baseColumnsWithTypesDescription = "space separated snake-case (except for belongs_to model name) properties like this:\n                      title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to\n                  \n                  all properties default to not nullable; null can be allowed by appending ':optional':\n                      subtitle:string:optional\n                  \n                  supported types:\n                      - uuid:\n                      - uuid[]:\n                          a column optimized for storing UUIDs\n                  \n                      - citext:\n                      - citext[]:\n                          case insensitive text (indexes and queries are automatically case insensitive)\n                  \n                      - encrypted:\n                          encrypted text (used in conjunction with the @deco.Encrypted decorator)\n                  \n                      - string:\n                      - string[]:\n                          varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional\n                  \n                      - text\n                      - text[]\n                      - date\n                      - date[]\n                      - datetime\n                      - datetime[]\n                      - time\n                      - time[]\n                      - timetz\n                      - timetz[]\n                      - integer\n                      - integer[]\n                  \n                      - decimal:\n                      - decimal[]:\n                          precision,scale is required, e.g.: volume:decimal:3,2 or volume:decimal:3,2:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: volume:decimal[]:3,2\n                  \n                      - enum:\n                      - enum[]:\n                          include the enum name to automatically create the enum:\n                            type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional\n                  \n                          omit the enum values to leverage an existing enum (omits the enum type creation):\n                            type:enum:room_types or type:enum:room_types:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: type:enum[]:room_types:bathroom,kitchen,bedroom";
 export default class DreamCLI {
     /**
      * Starts the Dream console
@@ -31,6 +31,7 @@ export default class DreamCLI {
             serializer: boolean;
             stiBaseSerializer: boolean;
             includeAdminSerializers: boolean;
+            includeInternalSerializers?: boolean;
             tableName?: string | undefined;
             /**
              * Optional model class name override. If provided, generators use it

package/dist/types/src/helpers/EnvInternal.d.ts

@@ -2,5 +2,5 @@ import Env from './Env.js';
 declare const EnvInternal: Env<{
     string: "DREAM_CORE_DEVELOPMENT" | "TZ";
     boolean: "ALLOW_BENCHMARKS" | "DREAM_BYPASS_PACKAGE_MANAGER_CHECK" | "DREAM_CORE_DEVELOPMENT" | "DREAM_CORE_SPEC_RUN" | "PSYCHIC_CORE_DEVELOPMENT";
-}, "TZ" | "DREAM_CORE_DEVELOPMENT", never, "DREAM_CORE_DEVELOPMENT" | "ALLOW_BENCHMARKS" | "DREAM_BYPASS_PACKAGE_MANAGER_CHECK" | "DREAM_CORE_SPEC_RUN" | "PSYCHIC_CORE_DEVELOPMENT">;
+}, "DREAM_CORE_DEVELOPMENT" | "TZ", never, "DREAM_CORE_DEVELOPMENT" | "ALLOW_BENCHMARKS" | "DREAM_BYPASS_PACKAGE_MANAGER_CHECK" | "DREAM_CORE_SPEC_RUN" | "PSYCHIC_CORE_DEVELOPMENT">;
 export default EnvInternal;

package/dist/types/src/helpers/cli/generateDream.d.ts

@@ -3,6 +3,7 @@ export interface GenerateDreamOptions {
     serializer: boolean;
     stiBaseSerializer: boolean;
     includeAdminSerializers: boolean;
+    includeInternalSerializers?: boolean;
     tableName?: string | undefined;
     modelName?: string | undefined;
 }

package/dist/types/src/helpers/cli/generateDreamContent.d.ts

@@ -5,6 +5,7 @@ interface GenerateDreamContentOptions {
     connectionName?: string;
     serializer: boolean;
     includeAdminSerializers: boolean;
+    includeInternalSerializers?: boolean;
     tableName?: string | undefined;
     /** Model class name, computed once via modelClassNameFrom in the orchestrator. */
     modelClassName: string;

package/dist/types/src/helpers/cli/generateSerializer.d.ts

@@ -1,8 +1,9 @@
-export default function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, modelClassName, }: {
+export default function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, includeInternalSerializers, modelClassName, }: {
     fullyQualifiedModelName: string;
     columnsWithTypes: string[];
     fullyQualifiedParentName?: string | undefined;
     stiBaseSerializer: boolean;
     includeAdminSerializers: boolean;
+    includeInternalSerializers?: boolean;
     modelClassName: string;
 }): Promise<void>;

package/dist/types/src/helpers/cli/generateSerializerContent.d.ts

@@ -1,9 +1,10 @@
-export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, modelClassName, }: {
+export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, includeInternalSerializers, modelClassName, }: {
     fullyQualifiedModelName: string;
     columnsWithTypes?: string[] | undefined;
     fullyQualifiedParentName?: string | undefined;
     stiBaseSerializer: boolean;
     includeAdminSerializers: boolean;
+    includeInternalSerializers?: boolean;
     /** Model class name, computed once via modelClassNameFrom in the orchestrator. */
     modelClassName: string;
 }): string;

package/dist/types/src/helpers/path/windowsSafePath.d.ts

@@ -9,12 +9,12 @@ declare const windowsSafePath: {
     dirname(path: string): string;
     basename(path: string, suffix?: string): string;
     extname(path: string): string;
-    sep: "\\" | "/";
-    delimiter: ";" | ":";
     parse(path: string): path.ParsedPath;
     format(pathObject: path.FormatInputPathObject): string;
     toNamespacedPath(path: string): string;
-    posix: path.PlatformPath;
-    win32: path.PlatformPath;
+    sep: "\\" | "/";
+    delimiter: ";" | ":";
+    posix: typeof path;
+    win32: typeof path;
 };
 export default windowsSafePath;

package/dist/types/src/helpers/sspawn.d.ts

@@ -4,4 +4,4 @@ export default function sspawn(command: string, opts?: SpawnOptions & {
 }): Promise<unknown>;
 export declare function ssspawn(command: string, opts?: SpawnOptions & {
     onStdout?: (str: string) => void;
-}): import("child_process").ChildProcess;
+}): import("node:child_process").ChildProcess;

package/dist/types/src/types/openapi.d.ts

@@ -74,7 +74,7 @@ export type OpenapiSchemaObjectBase = CommonOpenapiSchemaObjectFields<{
     minProperties?: number;
     maxProperties?: number;
     properties?: OpenapiSchemaProperties | OpenapiSchemaExpressionOneOf | OpenapiSchemaExpressionAnyOf | OpenapiSchemaExpressionAllOf;
-    additionalProperties?: OpenapiSchemaObject | OpenapiSchemaExpressionOneOf | OpenapiSchemaExpressionAnyOf | OpenapiSchemaExpressionAllOf;
+    additionalProperties?: OpenapiSchemaObject | OpenapiSchemaExpressionOneOf | OpenapiSchemaExpressionAnyOf | OpenapiSchemaExpressionAllOf | false;
 }>;
 export type OpenapiSchemaObjectOneOf = CommonOpenapiSchemaObjectFields<{
     oneOf?: OpenapiSchemaBody[];
@@ -90,7 +90,7 @@ export type OpenapiSchemaObjectBaseShorthand = CommonOpenapiSchemaObjectFields<{
     minProperties?: number;
     maxProperties?: number;
     properties?: OpenapiSchemaPropertiesShorthand | OpenapiSchemaShorthandExpressionOneOf | OpenapiSchemaShorthandExpressionAnyOf | OpenapiSchemaShorthandExpressionAllOf | OpenapiSchemaShorthandExpressionSerializerRef | OpenapiSchemaShorthandExpressionSerializableRef;
-    additionalProperties?: OpenapiShorthandPrimitiveTypes | OpenapiSchemaBodyShorthand | OpenapiSchemaShorthandExpressionOneOf | OpenapiSchemaShorthandExpressionAnyOf | OpenapiSchemaShorthandExpressionAllOf | OpenapiSchemaShorthandExpressionSerializerRef | OpenapiSchemaShorthandExpressionSerializableRef;
+    additionalProperties?: OpenapiShorthandPrimitiveTypes | OpenapiSchemaBodyShorthand | OpenapiSchemaShorthandExpressionOneOf | OpenapiSchemaShorthandExpressionAnyOf | OpenapiSchemaShorthandExpressionAllOf | OpenapiSchemaShorthandExpressionSerializerRef | OpenapiSchemaShorthandExpressionSerializableRef | false;
 }>;
 export type OpenapiSchemaObjectOneOfShorthand = CommonOpenapiSchemaObjectFields<{
     oneOf?: OpenapiSchemaBodyShorthand[];

package/dist/types/src/types/openapi.ts

@@ -131,6 +131,7 @@ export type OpenapiSchemaObjectBase = CommonOpenapiSchemaObjectFields<{
     | OpenapiSchemaExpressionOneOf
     | OpenapiSchemaExpressionAnyOf
     | OpenapiSchemaExpressionAllOf
+    | false
 }>
 
 export type OpenapiSchemaObjectOneOf = CommonOpenapiSchemaObjectFields<{
@@ -169,6 +170,7 @@ export type OpenapiSchemaObjectBaseShorthand = CommonOpenapiSchemaObjectFields<{
     | OpenapiSchemaShorthandExpressionAllOf
     | OpenapiSchemaShorthandExpressionSerializerRef
     | OpenapiSchemaShorthandExpressionSerializableRef
+    | false
 }>
 
 export type OpenapiSchemaObjectOneOfShorthand = CommonOpenapiSchemaObjectFields<{

package/docs/assets/hierarchy.js

@@ -0,0 +1 @@
+window.hierarchyData = "eJyVks1uAiEURt/lrtE6P+LIspomTVPbJk27MC5w5tohMmCAsZkY372hbqi1HdwAIffjHOAewGjtLLBlQtOcTEcrAgY3EksntLLADjAd+VHxBoHBS4ummxuxR3PLLQKBrVAVsCQtCLRGAoNScmvR3lTr4Vn1sHaNBHKqAAbOVgMfH5w2CJS1kJVBBWyZZpPVkUCaTQL6Q2dRdsGpPfxf9dcYJBktvIKfA4dnbd2HQRtvcSHR4+Gp4yKkzmostzOtrDNcKPcmtOT+h/5DozHa2OFf0QgHOqKhg5Zto572aDZSf8aQfwRieGke8Obc8XtV6mbHnVhLfBeu9ntrbvFOoKwiFHrPuKojxkVB/KOQhOYZSShNvhuE5tmZ9mu3w9Pt/epR2Ia7so70vRyOeT6aBB4L7RatlNe0ynmkj3k8fgGG6267"