@postxl/generator 0.34.0 → 0.35.0

package/dist/lib/meta.d.ts

@@ -4,6 +4,36 @@ import * as Types from './schema/types';
  * Collection of "global", schema-related values that might be referenced by different generators.
  */
 export type SchemaMetaData = {
+    actions: {
+        /**
+         * The name of the Module class
+         */
+        moduleName: Types.ClassName;
+        /**
+         * Path that may be used to import from the action module.
+         */
+        importPath: Types.Path;
+        /**
+         * Path to the file containing the execution interface definition.
+         */
+        actionExecutionInterfaceFilePath: Types.Path;
+        /**
+         * The name of the interface that handles the action execution.
+         */
+        actionExecutionInterface: Types.ClassName;
+        /**
+         * The name of the class that handles the action execution.
+         */
+        actionExecutionClass: Types.ClassName;
+        /**
+         * The name of the mock for the actionExecution class.
+         */
+        actionExecutionMock: Types.ClassName;
+        /**
+         * Path to the file containing the dispatcher service class definition.
+         */
+        dispatcherServiceFilePath: Types.Path;
+    };
     data: {
         /**
          * The name of the Module class
@@ -25,6 +55,14 @@ export type SchemaMetaData = {
          * Path to the file containing data service class definitions.
          */
         dataServiceFilePath: Types.Path;
+        /**
+         * Path to the file containing the repository type definition.
+         */
+        repositoryTypeFilePath: Types.Path;
+        /**
+         * Name of the repository type.
+         */
+        repositoryTypeName: Types.TypeName;
         /**
          * Path to the file containing data mocker class definitions.
          */
@@ -37,10 +75,6 @@ export type SchemaMetaData = {
          * Path that may be used to import the data mocker stubs.
          */
         dataMockerStubImportPath: Types.Path;
-        /**
-         * Path to the file containing test data service definition.
-         */
-        testDataServiceFilePath: Types.Path;
         /**
          * Path to the file containing the array with all repositories.
          */
@@ -72,43 +106,107 @@ export type SchemaMetaData = {
          */
         moduleFilePath: Types.Path;
         /**
-         * The name of the business logic service class.
+         * Settings for the view sub-module
          */
-        serviceClassName: Types.ClassName;
+        view: {
+            /**
+             * The name of the module class
+             */
+            moduleName: Types.ClassName;
+            /**
+             * Path that may be used to import from the view module.
+             */
+            importPath: Types.Path;
+            /**
+             * Path to the file containing the view index.
+             */
+            indexFilePath: Types.Path;
+            /**
+             * Path to the file containing the view module definition.
+             */
+            moduleFilePath: Types.Path;
+            /**
+             * The name of the central view service class, containing all model view services.
+             */
+            serviceClassName: Types.ClassName;
+            /**
+             * Path to the file containing the view service class definition.
+             */
+            serviceFilePath: Types.Path;
+        };
         /**
-         * Path to the file containing the business logic service class definition.
+         * Settings for the update sub-module
          */
-        serviceFilePath: Types.Path;
+        update: {
+            /**
+             * The name of the module class
+             */
+            moduleName: Types.ClassName;
+            /**
+             * Path that may be used to import from the update module.
+             */
+            importPath: Types.Path;
+            /**
+             * Path to the file containing the update index.
+             */
+            indexFilePath: Types.Path;
+            /**
+             * Path to the file containing the update module definition.
+             */
+            moduleFilePath: Types.Path;
+            /**
+             * The name of the central update service class, containing all model update services.
+             */
+            serviceClassName: Types.ClassName;
+            /**
+             * Path to the file containing the update service class definition.
+             */
+            serviceFilePath: Types.Path;
+            /**
+             * Path to the file containing the overall action types
+             */
+            actionTypesFilePath: Types.Path;
+        };
     };
-    seed: {
+    seedData: {
         /**
-         * Path to the index file for the seed package.
+         * Path that may be used in the import statement.
          */
-        indexFilePath: Types.Path;
+        importPath: Types.Path;
         /**
-         * Path to the SeedService file.
+         * Location of the initial seed data migration
          */
-        serviceFilePath: Types.Path;
+        initialMigrationFilePath: Types.Path;
         /**
          * Path to seed Excel template file.
          */
         templateExcelFilePath: Types.Path;
         /**
-         * Path to template decoder file.
+         * Path to template decoder **
          */
         templateDecoderFilePath: Types.Path;
         /**
          * The name of the template decoder function.
          */
         templateDecoderName: Types.Fnction;
+    };
+    seed: {
         /**
-         * Path that may be used in the import statement.
+         * Path to the seed data type.
          */
-        importPath: Types.Path;
+        seedDataTypeFilePath: Types.Path;
+        /**
+         * Path to the SeedService file.
+         */
+        serviceFilePath: Types.Path;
+        /**
+         * The name of the SeedService class.
+         */
+        serviceClassName: Types.ClassName;
         /**
-         * Random seed value to use for seeding faker.
+         * Path that may be used in the import statement.
          */
-        randomSeed: number;
+        importPath: Types.Path;
     };
     trpc: {
         /**
@@ -129,6 +227,27 @@ export type SchemaMetaData = {
          * Path that may be used to import the type definitions package.
          */
         importPath: Types.Path;
+        /**
+         * Path and type names for the Data Transfer Objects (DTOs).
+         */
+        dto: {
+            /**
+             * Path to the file containing DTO type definitions.
+             */
+            path: Types.Path;
+            /**
+             * Generic type for a Create DTO.
+             */
+            create: Types.TypeName;
+            /**
+             * Generic type for an Update DTO.
+             */
+            update: Types.TypeName;
+            /**
+             * Generic type for an Upsert DTO.
+             */
+            upsert: Types.TypeName;
+        };
     };
     /**
      * Path to the directory containing migrations.
@@ -152,12 +271,21 @@ export type ModelMetaData = {
     /**
      * A user friendly name
      *
-     * NOTE: User friendly name is very generic and  meant to be used in log messages, errors -
-     *       and any other places where the user shall read about it!
+     * NOTE: User friendly name is very generic and  meant to be used in log messages, comments,
+     *       errors - and any other places where the user shall read about it!
      *       It is not meant to be used for variables, class names, etc. In code, you should
      *       use a more specific name for your purposes (e.g. `reactCreateModalComponentName`).
      */
     userFriendlyName: string;
+    /**
+     * A user friendly name in plural form
+     *
+     * NOTE: User friendly name is very generic and  meant to be used in log messages, comments,
+     *       errors - and any other places where the user shall read about it!
+     *       It is not meant to be used for variables, class names, etc. In code, you should
+     *       use a more specific name for your purposes (e.g. `reactCreateModalComponentName`).
+     */
+    userFriendlyNamePlural: string;
     /**
      * The name of the model in singular form.
      *
@@ -174,6 +302,15 @@ export type ModelMetaData = {
      *       (e.g. `reactCreateModalComponentName`)
      */
     internalPluralName: Types.VariableName;
+    /**
+     * Properties provided by the `actions` generators.
+     */
+    actions: {
+        /**
+         * Each model defines its own action scope as a discriminator for the action execution. (e.g. `aggregation`)
+         */
+        actionScopeConstType: Types.TypeName;
+    };
     /**
      * Properties provided by the `data` generators.
      */
@@ -254,25 +391,106 @@ export type ModelMetaData = {
      */
     businessLogic: {
         /**
-         * Path that may be used to import definitions of this model.
-         */
-        importPath: Types.Path;
-        /**
-         * The name by which the model's class is exposed in the businessLogicService/context. (e.g. aggregations)
+         * The const type that represents the scope of the business logic service. (e.g. `aggregation`)
+         * The scope is typically a model. However, in a more complex business logic, this could also be
+         * whatever makes sense to put into a single business logic service - e.g. "approval" (for MCA) or "calculation" (for LA360).
          */
-        serviceClassName: Types.ClassName;
+        scopeName: Types.VariableName;
         /**
-         * The name by which the model's class is exposed in the businessLogicService/context. (e.g. aggregations)
+         * Path that may be used to import definitions of this model.
          */
-        serviceVariableName: Types.VariableName;
+        importPath: Types.Path;
         /**
-         * Name of the file containing the service for this model.
+         * The definitions for the view service of a model
          */
-        serviceFileName: Types.FileName;
+        view: {
+            /**
+             * The name by which the model's view class is exposed in the viewService/context. (e.g. aggregations)
+             */
+            serviceClassName: Types.ClassName;
+            /**
+             * The name by which the model's service is exposed in the viewService/context. (e.g. aggregations)
+             */
+            serviceVariableName: Types.VariableName;
+            /**
+             * Name of the file containing the view service for this model.
+             */
+            serviceFileName: Types.FileName;
+            /**
+             * Path to the file containing the view service.
+             */
+            serviceFilePath: Types.Path;
+        };
         /**
-         * Path to the file containing the service.
+         * The definitions for the update service of a model
          */
-        serviceFilePath: Types.Path;
+        update: {
+            /**
+             * The name by which the model's update class is exposed in the updateService/context. (e.g. aggregations)
+             */
+            serviceClassName: Types.ClassName;
+            /**
+             * The name by which the model's service is exposed in the updateService/context. (e.g. aggregations)
+             */
+            serviceVariableName: Types.VariableName;
+            /**
+             * Name of the file containing the update service for this model.
+             */
+            serviceFileName: Types.FileName;
+            /**
+             * Path to the file containing the update service.
+             */
+            serviceFilePath: Types.Path;
+            /**
+             * The name of the model used as a discriminator for the action execution. (e.g. `aggregation`)
+             */
+            actionModelDiscriminantName: Types.VariableName;
+            /**
+             * Name of the model's aggregated action type. (e.g. `Action_Aggregation`)
+             */
+            actionName: Types.VariableName;
+            /**
+             * Name of the model's aggregated action result type. (e.g. `ActionResult_Aggregation`)
+             */
+            actionResultName: Types.VariableName;
+            /**
+             * The model's name that is used to build the different action types.
+             * (e.g. `Aggregation` which will be used to build `Action_Aggregation_Create`)
+             */
+            actionNameModelPart: Types.VariableName;
+            /**
+             * Name of the function that creates a `create` action for the model (e.g. `createActionAggregationCreate`)
+             */
+            createActionFunctionNameCreate: Types.Fnction;
+            /**
+             * Name of the function that creates a `createMany` action for the model (e.g. `createActionAggregationCreateMany`)
+             */
+            createActionFunctionNameCreateMany: Types.Fnction;
+            /**
+             * Name of the function that creates a `update` action for the model (e.g. `createActionAggregationUpdate`)
+             */
+            createActionFunctionNameUpdate: Types.Fnction;
+            /**
+             * Name of the function that creates a `updateMany` action for the model (e.g. `createActionAggregationUpdateMany`)
+             */
+            createActionFunctionNameUpdateMany: Types.Fnction;
+            /**
+             * Name of the function that creates a `upsert` action for the model (e.g. `createActionAggregationUpsert`)
+             */
+            createActionFunctionNameUpsert: Types.Fnction;
+            /**
+             * Name of the function that creates a `upsertMany` action for the model (e.g. `createActionAggregationUpsertMany`)
+             */
+            createActionFunctionNameUpsertMany: Types.Fnction;
+            /**
+             * Name of the function that creates a `delete` action for the model (e.g. `createActionAggregationDelete`)
+             */
+            createActionFunctionNameDelete: Types.Fnction;
+            /**
+             * Name of the function that creates a `deleteMany` action for the model (e.g. `createActionAggregationDeleteMany`)
+             */
+            createActionFunctionNameDeleteMany: Types.Fnction;
+        };
         /**
          * Name by which the business logic service exposes the data service.
          */
@@ -450,10 +668,45 @@ export type ModelMetaData = {
          * e.g. `toAggregationId`.
          */
         toBrandedIdTypeFnName: Types.Fnction;
+        zodDecoderFnNames: {
+            /**
+             * The name of the function that decodes a scalar value to a branded ID type, e.g. `aggregationIdDecoder`.
+             */
+            id: Types.Fnction;
+            /**
+             * The name of the function that decodes a source (database) object to a fully typed object, e.g. `aggregationDatabaseDecoder`.
+             */
+            fromDatabase: Types.Fnction;
+            /**
+             * The name of the function that decodes a Create object to a fully typed object, e.g. `aggregationCreateDecoder`.
+             */
+            createObject: Types.Fnction;
+            /**
+             * The name of the function that decodes an Update object to a fully typed object, e.g. `aggregationUpdateDecoder`.
+             */
+            updateObject: Types.Fnction;
+            /**
+             * The name of the function that decodes an Upsert object to a fully typed object, e.g. `aggregationUpsertDecoder`.
+             */
+            upsertObject: Types.Fnction;
+        };
         /**
-         * The name of the function that decodes a source (database) object to a fully typed object, e.g. `aggregationDecoder`.
+         * Type definitions for the different Data Transfer Objects (DTOs).
          */
-        zodDecoderFnName: Types.Fnction;
+        dto: {
+            /**
+             * The name of the type that represents a DTO for creating a new object, e.g. `AggregationCreateDTO`.
+             */
+            create: Types.TypeName;
+            /**
+             * The name of the type that represents a DTO for updating an existing object, e.g. `AggregationUpdateDTO`.
+             */
+            update: Types.TypeName;
+            /**
+             * The name of the type that represents a DTO for upserting an existing object, e.g. `AggregationUpsertDTO`.
+             */
+            upsert: Types.TypeName;
+        };
         /**
          * The name of the file containing type definitions (e.g. `aggregation.type`).
          */

package/dist/lib/meta.js

@@ -31,13 +31,23 @@ const string_1 = require("./utils/string");
  */
 function getSchemaMetadata({ config }) {
     return {
+        actions: {
+            moduleName: Types.toClassName(`ActionModule`),
+            importPath: Types.toPath(`@${config.project}/actions`),
+            actionExecutionInterfaceFilePath: Types.toPath(`@${config.project}/actions/actionExecution.class`),
+            actionExecutionInterface: Types.toClassName(`IActionExecution`),
+            actionExecutionClass: Types.toClassName(`ActionExecution`),
+            actionExecutionMock: Types.toClassName(`MockActionExecution`),
+            dispatcherServiceFilePath: Types.toPath(`${config.paths.actionsPath}dispatcher.service`),
+        },
         data: {
             moduleName: Types.toClassName(`DataModule`),
             importPath: Types.toPath(`@${config.project}/data`),
             dataModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.module`),
             dataMockModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.mock.module`),
-            testDataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}test-data.service`),
             dataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}data.service`),
+            repositoryTypeFilePath: Types.toPath(`${config.paths.dataLibPath}repository.type`),
+            repositoryTypeName: Types.toTypeName(`Repository`),
             dataMockerFilePath: Types.toPath(`${config.paths.cypressPath}support/data-mocker.class`),
             dataMockerStubImportPath: Types.toPath(`${config.paths.cypressPath}support/stubs`),
             dataMockerStubIndexFilePath: Types.toPath(`${config.paths.cypressPath}support/stubs/index`),
@@ -50,25 +60,50 @@ function getSchemaMetadata({ config }) {
             importPath: Types.toPath(`@${config.project}/business-logic`),
             indexFilePath: Types.toPath(`${config.paths.businessLogicPath}index`),
             moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}business-logic.module`),
-            serviceClassName: Types.toClassName(`BusinessLogicService`),
-            serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}business-logic.service`),
+            view: {
+                moduleName: Types.toClassName(`ViewModule`),
+                importPath: Types.toPath(`@${config.project}/business-logic/view`),
+                indexFilePath: Types.toPath(`${config.paths.businessLogicPath}view/index`),
+                moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}view/view.module`),
+                serviceClassName: Types.toClassName(`ViewService`),
+                serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}view/view.service`),
+            },
+            update: {
+                moduleName: Types.toClassName(`UpdateModule`),
+                importPath: Types.toPath(`@${config.project}/business-logic/update`),
+                indexFilePath: Types.toPath(`${config.paths.businessLogicPath}update/index`),
+                moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}update/update.module`),
+                serviceClassName: Types.toClassName(`UpdateService`),
+                serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}update/update.service`),
+                actionTypesFilePath: Types.toPath(`${config.paths.businessLogicPath}update/actions.types`),
+            },
         },
         trpc: {
             routesFilePath: Types.toPath(`${config.paths.trpcRoutesFolderPath}index`),
             importPath: Types.toPath(`@${config.project}/trpc`),
         },
-        seed: {
-            indexFilePath: Types.toPath(`${config.paths.seedPath}data/index`),
-            serviceFilePath: Types.toPath(`${config.paths.seedPath}seed.service`),
-            templateExcelFilePath: Types.toPath(`${config.paths.seedPath}template.xlsx`),
-            templateDecoderFilePath: Types.toPath(`${config.paths.seedPath}seed.decoder`),
+        seedData: {
+            importPath: Types.toPath(`@${config.project}/seed-data`),
+            initialMigrationFilePath: Types.toPath(`${config.paths.seedDataPath}001-base-data/001-seed.migration`),
+            templateExcelFilePath: Types.toPath(`${config.paths.seedDataPath}002-excel-example/template.xlsx`),
+            templateDecoderFilePath: Types.toPath(`${config.paths.seedDataPath}002-excel-example/template.decoder`),
             templateDecoderName: Types.toFunction(`seedTemplateDecoder`),
+        },
+        seed: {
+            seedDataTypeFilePath: Types.toPath(`${config.paths.seedLibPath}seed-data.type`),
+            serviceFilePath: Types.toPath(`${config.paths.seedLibPath}seed.service`),
+            serviceClassName: Types.toClassName(`SeedService`),
             importPath: Types.toPath(`@${config.project}/seed`),
-            randomSeed: config.randomSeed,
         },
         types: {
             indexFilePath: Types.toPath(`${config.paths.modelTypeDefinitionsPath}index`),
             importPath: Types.toPath(`@${config.project}/types`),
+            dto: {
+                path: Types.toPath(`${config.paths.modelTypeDefinitionsPath}dto.types`),
+                create: Types.toTypeName(`CreateDTO`),
+                update: Types.toTypeName(`UpdateDTO`),
+                upsert: Types.toTypeName(`UpsertDTO`),
+            },
         },
         migrationsPath: Types.toPath(`${config.paths.migrationsFolderPath}`),
         config,
@@ -83,8 +118,12 @@ function getModelMetadata({ model }) {
     const { PascalCase, camelCase, pluralized, uncapitalizedPlural, uncapitalized, capitalizedPlural } = (0, string_1.conjugateNames)(name);
     return {
         userFriendlyName: PascalCase,
+        userFriendlyNamePlural: capitalizedPlural,
         internalSingularName: Types.toVariableName(camelCase),
         internalPluralName: Types.toVariableName(uncapitalizedPlural),
+        actions: {
+            actionScopeConstType: Types.toTypeName(`${camelCase}`),
+        },
         data: {
             mockDataPropertyName: Types.toVariableName(`${uncapitalizedPlural}`),
             defaultStubConstantName: Types.toVariableName(`${camelCase}DefaultStub`),
@@ -107,15 +146,36 @@ function getModelMetadata({ model }) {
             },
         },
         businessLogic: {
-            importPath: Types.toPath(`@${config.project}/businessLogic`),
-            serviceClassName: Types.toClassName(`${PascalCase}Service`),
-            serviceVariableName: Types.toVariableName(`${uncapitalizedPlural}`),
-            serviceFileName: Types.toFileName(`${camelCase}.service`),
-            serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}${camelCase}.service`),
+            scopeName: Types.toVariableName(`${camelCase}`),
+            importPath: Types.toPath(`@${config.project}/business-logic`),
+            view: {
+                serviceClassName: Types.toClassName(`${PascalCase}ViewService`),
+                serviceVariableName: Types.toVariableName(`${uncapitalizedPlural}`),
+                serviceFileName: Types.toFileName(`${camelCase}.view.service`),
+                serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}view/${camelCase}.view.service`),
+            },
+            update: {
+                serviceClassName: Types.toClassName(`${PascalCase}UpdateService`),
+                serviceVariableName: Types.toVariableName(`${uncapitalizedPlural}`),
+                serviceFileName: Types.toFileName(`${camelCase}.update.service`),
+                serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}update/${camelCase}.update.service`),
+                actionModelDiscriminantName: Types.toVariableName(`${camelCase}`),
+                actionName: Types.toVariableName(`Action_${PascalCase}`),
+                actionNameModelPart: Types.toVariableName(`${PascalCase}`),
+                actionResultName: Types.toVariableName(`ActionResult_${PascalCase}`),
+                createActionFunctionNameCreate: Types.toFunction(`createAction${PascalCase}Create`),
+                createActionFunctionNameCreateMany: Types.toFunction(`createAction${PascalCase}CreateMany`),
+                createActionFunctionNameUpdate: Types.toFunction(`createAction${PascalCase}Update`),
+                createActionFunctionNameUpdateMany: Types.toFunction(`createAction${PascalCase}UpdateMany`),
+                createActionFunctionNameUpsert: Types.toFunction(`createAction${PascalCase}Upsert`),
+                createActionFunctionNameUpsertMany: Types.toFunction(`createAction${PascalCase}UpsertMany`),
+                createActionFunctionNameDelete: Types.toFunction(`createAction${PascalCase}Delete`),
+                createActionFunctionNameDeleteMany: Types.toFunction(`createAction${PascalCase}DeleteMany`),
+            },
             dataRepositoryVariableName: Types.toVariableName(`data`),
         },
         seed: {
-            filePath: Types.toPath(`${config.paths.seedPath}data/${uncapitalizedPlural}`),
+            filePath: Types.toPath(`${config.paths.seedDataPath}001-base-data/${uncapitalizedPlural}.seed`),
             constantName: Types.toVariableName(`${uncapitalizedPlural}`),
             importPath: Types.toPath(`@${config.project}/seed`),
             excel: {
@@ -181,7 +241,18 @@ function getModelMetadata({ model }) {
             filePath: Types.toPath(`${config.paths.modelTypeDefinitionsPath}${camelCase}.type`),
             brandedIdType: Types.toTypeName(`${PascalCase}Id`),
             toBrandedIdTypeFnName: Types.toFunction(`to${PascalCase}Id`),
-            zodDecoderFnName: Types.toFunction(`${camelCase}Decoder`),
+            zodDecoderFnNames: {
+                id: Types.toFunction(`${camelCase}IdDecoder`),
+                fromDatabase: Types.toFunction(`${camelCase}DatabaseDecoder`),
+                createObject: Types.toFunction(`${camelCase}CreateDecoder`),
+                updateObject: Types.toFunction(`${camelCase}UpdateDecoder`),
+                upsertObject: Types.toFunction(`${camelCase}UpsertDecoder`),
+            },
+            dto: {
+                create: Types.toTypeName(`${PascalCase}CreateDTO`),
+                update: Types.toTypeName(`${PascalCase}UpdateDTO`),
+                upsert: Types.toTypeName(`${PascalCase}UpsertDTO`),
+            },
             typeName: Types.toTypeName(`${PascalCase}`),
             linkedTypeName: Types.toTypeName(`${PascalCase}Linked`),
             typeDefFileName: Types.toFileName(`${camelCase}.type`),

package/dist/lib/schema/schema.d.ts

@@ -23,6 +23,10 @@ export type SchemaConfig = {
          * If true, data module will not be generated.
          */
         data: boolean;
+        /**
+         * If true, actions module will not be generated.
+         */
+        actions: boolean;
         /**
          * If true, business logic module will not be generated.
          */
@@ -59,6 +63,13 @@ export type SchemaConfig = {
          * Path to the directory containing Cypress project.
          */
         cypressPath: Types.Path;
+        /**
+         * Path to the directory containing actions.
+         *
+         * NOTE: Metadata assumes that project is set up so that certain parts of the code
+         * may reference actions using `@project/actions` import.
+         */
+        actionsPath: Types.Path;
         /**
          * Path to the directory containing business logic.
          *
@@ -67,12 +78,19 @@ export type SchemaConfig = {
          */
         businessLogicPath: Types.Path;
         /**
-         * Path to the directory containing mock data samples.
+         * Path to the directory containing seed module.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference mock data using `@project/seed` import.
          */
-        seedPath: Types.Path;
+        seedLibPath: Types.Path;
+        /**
+         * Path to the directory containing mock data samples.
+         *
+         * NOTE: Metadata assumes that project is set up so that certain parts of the code
+         * may reference mock data using `@project/seed-data` import.
+         */
+        seedDataPath: Types.Path;
         /**
          * Path to the directory containing React components.
          *
@@ -89,14 +107,14 @@ export type SchemaConfig = {
          */
         migrationsFolderPath: Types.Path;
     };
-    /**
-     * Seed to use for random generation.
-     */
-    randomSeed: number;
     /**
      * Whether the generator should overwrite existing files.
      */
     force: boolean;
+    /**
+     * Name of the User type
+     */
+    userType: Types.TypeName;
 };
 export type Model = Prettify<ModelCore & ModelFields>;
 /**

package/dist/lib/schema/types.d.ts

@@ -70,3 +70,7 @@ export type Path = string & {
  * Converts a string to a branded FileName.
  */
 export declare const toPath: (t: string) => Path;
+/**
+ * Branded string values that can be used as import statement values in the generators
+ */
+export type ImportableTypes = Fnction | ClassName | TypeName | VariableName;

package/dist/lib/utils/jsdoc.d.ts

@@ -1,4 +1,4 @@
 /**
  * Returns a string of JSDoc comments from an array of lines.
  */
-export declare function jsDocComment(lines: string[]): string;
+export declare function toJsDocComment(comments: string[] | undefined): string;