@postxl/generator 0.60.7 → 0.61.0

package/dist/lib/meta.d.ts

@@ -42,46 +42,60 @@ export type SchemaMetaData = {
             importPath: Types.BackendModulePath;
         };
         db: {
+            /**
+             * Name of the module class
+             */
+            moduleName: Types.ClassName;
             /**
              * Path that may be used to import the db backend module.
              */
-            importPath: Types.BackendModulePath;
+            moduleLocation: Types.ModuleLocation;
+            /**
+             * Path that may be used to import the db types.
+             *
+             * NOTE: While we avoid index.ts files in all other modules, here we leverage it as we re-export the native Prisma types!
+             */
+            typesImportPath: Types.BackendModulePath;
             databaseService: {
                 /**
                  * The name of the DB service class.
                  */
                 name: Types.ClassName;
+                /**
+                 * Path that may be used to import the database service.
+                 */
+                location: Types.ModuleLocation;
             };
         };
         http: {
             /**
              * Path that may be used to import the http backend module.
              */
-            importPath: Types.BackendModulePath;
+            moduleImportPath: Types.BackendModulePath;
         };
         i18n: {
             /**
              * Path that may be used to import the i18n backend module.
              */
-            importPath: Types.BackendModulePath;
+            moduleImportPath: Types.BackendModulePath;
         };
         s3: {
             /**
              * Path that may be used to import the s3 backend module.
              */
-            importPath: Types.BackendModulePath;
+            moduleImportPath: Types.BackendModulePath;
         };
         upload: {
             /**
              * Path that may be used to import the upload backend module.
              */
-            importPath: Types.BackendModulePath;
+            moduleImportPath: Types.BackendModulePath;
         };
         xlport: {
             /**
              * Path that may be used to import the xlport backend module.
              */
-            importPath: Types.BackendModulePath;
+            moduleImportPart: Types.BackendModulePath;
         };
     };
     actions: {
@@ -90,38 +104,58 @@ export type SchemaMetaData = {
          */
         moduleName: Types.ClassName;
         /**
-         * Path that may be used to import from the action module.
+         * Path that may be used to import the action module.
          */
-        importPath: Types.BackendModulePath;
+        moduleLocation: Types.ModuleLocation;
         execution: {
+            /**
+             * The name of the class that handles the action execution.
+             */
+            class: Types.ClassName;
+            /**
+             * Path that may be used to import the action execution class.
+             */
+            classLocation: Types.ModuleLocation;
             /**
              * The name of the interface that handles the action execution.
              */
             interface: Types.ClassName;
             /**
-             * The name of the class that handles the action execution.
+             * Path that may be used to import the action execution interface.
              */
-            class: Types.ClassName;
+            interfaceLocation: Types.ModuleLocation;
             /**
              * The name of the mock for the actionExecution class.
              */
             mock: Types.ClassName;
+            /**
+             * Path the  may be used to import the action mock class
+             */
+            mockLocation: Types.ModuleLocation;
         };
         dispatcher: {
             /**
              * Path to the file containing the dispatcher service class definition.
              */
-            filePath: Types.FilePath;
+            classLocation: Types.ModuleLocation;
             /**
              * The name of the dispatcher service class.
              */
             class: Types.ClassName;
+            /**
+             * Path to the file containing the dispatcher interface
+             */
+            definitionLocation: Types.ModuleLocation;
             /**
              * The definition type that may be used to create a dispatcher conforming class.
              */
             definition: Types.TypeName;
         };
         definition: {
+            /**
+             * Path that may be used to import the definition utils.
+             */
+            importPath: Types.BackendModulePath;
             /**
              * The schema type to define action definitions.
              */
@@ -149,21 +183,13 @@ export type SchemaMetaData = {
          */
         moduleName: Types.ClassName;
         /**
-         * Path that may be used to import from the data module.
-         */
-        importPath: Types.BackendModulePath;
-        /**
-         * Path to the file containing the data module class definition.
+         * Location of the module class
          */
-        dataModuleFilePath: Types.FilePath;
+        moduleLocation: Types.ModuleLocation;
         /**
          * Path to the file containing the data module class definition.
          */
         emptyDbCommandFilePath: Types.FilePath;
-        /**
-         * Path to the file containing the mock data for the database.
-         */
-        dataMockModuleFilePath: Types.FilePath;
         repository: {
             /**
              * Path to the file containing the repository type definition.
@@ -186,7 +212,7 @@ export type SchemaMetaData = {
             /**
              * Path to the types definition.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the BulkMutation type.
              */
@@ -196,10 +222,16 @@ export type SchemaMetaData = {
              */
             bulkMutationForModel: Types.TypeName;
         };
-        /**
-         * Name of the mock data module class.
-         */
-        dataMockModuleName: Types.ClassName;
+        mockModule: {
+            /**
+             * Path to the file containing the mock data for the database.
+             */
+            location: Types.ModuleLocation;
+            /**
+             * Name of the mock data module class.
+             */
+            name: Types.ClassName;
+        };
         /**
          * Name of the data mock type/interface.
          */
@@ -208,7 +240,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing data service class definitions.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * Name of the data service class.
              */
@@ -238,19 +270,15 @@ export type SchemaMetaData = {
         /**
          * Path that may be used to import from the import-export module.
          */
-        importPath: Types.BackendModulePath;
+        moduleLocation: Types.ModuleLocation;
         /**
          * Meta data for decoder functions.
          */
         decoder: {
-            /**
-             * Path to the file containing the import-export decoder index.
-             */
-            indexFilePath: Types.FilePath;
             /**
              * Path to the file containing the data decoder
              */
-            fullDecoderFilePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * Name of the data decoder function
              */
@@ -275,7 +303,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the exporter class.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the exporter class.
              */
@@ -285,7 +313,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the export service class.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the export service class.
              */
@@ -295,7 +323,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the import service class.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the import service class.
              */
@@ -317,7 +345,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the import function.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * Name of the function that convert import data to BulkMutations.
              */
@@ -338,7 +366,7 @@ export type SchemaMetaData = {
             /**
              * Path to the types definition.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the type that represents the delta of all models.
              */
@@ -490,107 +518,66 @@ export type SchemaMetaData = {
             delta_Fields: Types.TypeName;
         };
     };
-    businessLogic: {
+    view: {
         /**
-         * The name of the Module class
+         * The name of the module class
          */
         moduleName: Types.ClassName;
         /**
-         * Path that may be used to import from the business logic module.
+         * Path that may be used to import from the view module.
          */
-        importPath: Types.BackendModulePath;
+        moduleLocation: Types.ModuleLocation;
         /**
-         * Path to the file containing the business logic index.
+         * The name of the central view service class, containing all model view services.
          */
-        indexFilePath: Types.FilePath;
+        serviceClassName: Types.ClassName;
         /**
-         * Path to the file containing the business logic module definition.
+         * Path to the file containing the view service class definition.
          */
-        moduleFilePath: Types.FilePath;
+        serviceLocation: Types.ModuleLocation;
+    };
+    /**
+     * Settings for the update module
+     */
+    update: {
         /**
-         * Settings for the view sub-module
+         * The name of the module class
          */
-        view: {
-            /**
-             * The name of the module class
-             */
-            moduleName: Types.ClassName;
-            /**
-             * Path that may be used to import from the view module.
-             */
-            importPath: Types.BackendModulePath;
-            /**
-             * Path to the file containing the view index.
-             */
-            indexFilePath: Types.FilePath;
-            /**
-             * Path to the file containing the view module definition.
-             */
-            moduleFilePath: Types.FilePath;
-            /**
-             * 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.FilePath;
-        };
+        moduleName: Types.ClassName;
         /**
-         * Settings for the update sub-module
+         * Path that may be used to import from the update module.
          */
-        update: {
-            /**
-             * The name of the module class
-             */
-            moduleName: Types.ClassName;
-            /**
-             * Path that may be used to import from the update module.
-             */
-            importPath: Types.BackendModulePath;
-            /**
-             * Path to the file containing the update index.
-             */
-            indexFilePath: Types.FilePath;
-            /**
-             * Path to the file containing the update module definition.
-             */
-            moduleFilePath: Types.FilePath;
-            /**
-             * 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.FilePath;
-            /**
-             * Path to the file containing the overall action types
-             */
-            actionTypesFilePath: Types.FilePath;
-            /**
-             * Path to the file containing the clone context
-             */
-            cloneContextFilePath: Types.FilePath;
-            /**
-             * The name of the clone context type
-             */
-            cloneContextType: Types.TypeName;
-            /**
-             * The name of the function that creates a clone context
-             */
-            cloneContextCreateMethod: Types.FunctionName;
-        };
-    };
-    seedData: {
+        moduleLocation: Types.ModuleLocation;
         /**
-         * Path that may be used in the import statement.
+         * The name of the central update service class, containing all model update services.
          */
-        importPath: Types.BackendModulePath;
+        serviceClassName: Types.ClassName;
+        /**
+         * Path to the file containing the update service class definition.
+         */
+        serviceLocation: Types.ModuleLocation;
+        /**
+         * Path to the file containing the overall action types
+         */
+        actionTypesFilePath: Types.FilePath;
+        /**
+         * Path to the file containing the clone context
+         */
+        cloneContextFilePath: Types.FilePath;
+        /**
+         * The name of the clone context type
+         */
+        cloneContextType: Types.TypeName;
+        /**
+         * The name of the function that creates a clone context
+         */
+        cloneContextCreateMethod: Types.FunctionName;
+    };
+    seedData: {
         /**
          * Location of the initial seed data migration
          */
-        initialMigrationFilePath: Types.FilePath;
+        initialMigrationLocation: Types.ModuleLocation;
         /**
          * Path to seed Excel template file.
          */
@@ -604,17 +591,17 @@ export type SchemaMetaData = {
         /**
          * Path that may be used in the import statement.
          */
-        importPath: Types.BackendModulePath;
+        serviceLocation: Types.ModuleLocation;
+        /**
+         * Path that may be used in the import statement.
+         */
+        actionsLocation: Types.ModuleLocation;
     };
     trpc: {
         /**
          * Path to the file that contains the trpc routes object.
          */
         routesFilePath: Types.FilePath;
-        /**
-         * Path that may be used to import the trpc routes object.
-         */
-        importPath: Types.BackendModulePath;
     };
     types: {
         /**
@@ -659,20 +646,10 @@ export type SchemaMetaData = {
      * Meta data for the e2e generators.
      */
     e2e: {
-        dataMocker: {
-            /**
-             * Path to the file containing data mocker class definitions.
-             */
-            filePath: Types.FilePath;
-            /**
-             * Path to the file containing data mocker class definitions.
-             */
-            stubIndexFilePath: Types.FilePath;
-            /**
-             * Path that may be used to import the data mocker stubs.
-             */
-            stubImportPath: Types.FilePath;
-        };
+        /**
+         * Path to the file containing data mocker class definitions.
+         */
+        dataMockerLocation: Types.ModuleLocation;
         /**
          * Path to the file containing component selectors for e2e tests.
          */
@@ -769,7 +746,7 @@ export type ModelMetaData = {
         /**
          * The path to the file containing stub definitions of this model.
          */
-        stubFilePath: Types.FilePath;
+        stubLocation: Types.ModuleLocation;
         /**
          * The name of the TypeScript constant that contains default values for all fields.
          */
@@ -788,13 +765,9 @@ export type ModelMetaData = {
         dataServiceIdName: Types.VariableName;
         repository: {
             /**
-             * Name of the file containing the repository definition for this model.
+             * Location of the file containing the repository definition for this model.
              */
-            fileName: Types.FileName;
-            /**
-             * Path to the file containing the repository definition.
-             */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the class for the repository definition of this model (e.g. AggregationRepository).
              */
@@ -809,14 +782,10 @@ export type ModelMetaData = {
             getMethodFnName: Types.FunctionName;
         };
         mockRepository: {
-            /**
-             * Name of the file containing the mock repository definition for this model.
-             */
-            fileName: Types.FileName;
             /**
              * Path to the file containing the mock repository definition.
              */
-            filePath: Types.FilePath;
+            location: Types.ModuleLocation;
             /**
              * The name of the class for the in-memory mock repository definition of this model (e.g. MockAggregationRepository).
              */
@@ -825,9 +794,13 @@ export type ModelMetaData = {
     };
     e2e: {
         /**
-         * The path to the file containing stub definitions for the data mocker of this model.
+         * The path to the file containing stub definitions of this model.
+         */
+        stubLocation: Types.ModuleLocation;
+        /**
+         * The name of the function that adds missing values to the partially populated model value.
          */
-        dataMockerStubFilePath: Types.FilePath;
+        stubGenerationFnName: Types.FunctionName;
     };
     /**
      *  Properties provided by the `importExport` generators
@@ -894,7 +867,7 @@ export type ModelMetaData = {
     /**
      * Properties provided by the `business logic` generator.
      */
-    businessLogic: {
+    view: {
         /**
          * 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
@@ -902,93 +875,82 @@ export type ModelMetaData = {
          */
         scopeName: Types.VariableName;
         /**
-         * Path that may be used to import definitions of this model.
+         * The name by which the model's view class is exposed in the viewService/context. (e.g. aggregations)
          */
-        importPath: Types.BackendModulePath;
+        serviceClassName: Types.ClassName;
         /**
-         * The definitions for the view service of a model
+         * The name by which the model's service is exposed in the viewService/context. (e.g. aggregations)
          */
-        view: {
-            /**
-             * Path that may be used to import the types of this model.
-             */
-            importPath: Types.BackendModulePath;
-            /**
-             * 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.FilePath;
-        };
+        serviceVariableName: Types.VariableName;
         /**
-         * The definitions for the update service of a model
+         * Path to the view service for this model.
          */
-        update: {
-            /**
-             * Path that may be used to import the types of this model.
-             */
-            importPath: Types.BackendModulePath;
-            /**
-             * The name by which the model's update class is exposed in the updateService/context. (e.g. AggregationUpdateService)
-             */
-            serviceClassName: Types.ClassName;
-            /**
-             * The name of the interface that represents the update service for this model. (e.g. IAggregationUpdateService)
-             */
-            serviceInterfaceName: Types.TypeName;
+        serviceLocation: Types.ModuleLocation;
+        /**
+         * The name of the variable that holds the repository instance for the current model
+         */
+        dataRepositoryVariableName: Types.VariableName;
+    };
+    /**
+     * The definitions for the update service of a model
+     */
+    update: {
+        /**
+         * 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).
+         */
+        scopeName: Types.VariableName;
+        /**
+         * Path that may be used to import the types of this model.
+         */
+        moduleLocation: Types.ModuleLocation;
+        /**
+         * The name by which the model's update class is exposed in the updateService/context. (e.g. AggregationUpdateService)
+         */
+        serviceClassName: Types.ClassName;
+        /**
+         * Location of the file containing the update service class for this model.
+         */
+        serviceClassLocation: Types.ModuleLocation;
+        /**
+         * The name of the interface that represents the update service for this model. (e.g. IAggregationUpdateService)
+         */
+        serviceInterfaceName: Types.TypeName;
+        /**
+         * The name by which the model's service is exposed in the updateService/context. (e.g. aggregations)
+         */
+        serviceVariableName: Types.VariableName;
+        /**
+         * The name of the model used as a discriminant for the action execution. (e.g. `aggregation`)
+         */
+        actionModelDiscriminantName: Types.VariableName;
+        decoders: {
             /**
-             * The name by which the model's service is exposed in the updateService/context. (e.g. aggregations)
+             * The name of the variable that holds the decoders for the model. (e.g. `aggregationDecoders`)
              */
-            serviceVariableName: Types.VariableName;
+            name: Types.VariableName;
             /**
-             * Name of the file containing the update service for this model.
+             * The name of the function that decodes a Create object to a fully typed object (e.g. `aggregationCreateDecoder`.)
              */
-            serviceFileName: Types.FileName;
+            create: Types.FunctionName;
             /**
-             * Path to the file containing the update service.
+             * The name of the function that decodes an Update object to a fully typed object (e.g. `aggregationUpdateDecoder`.)
              */
-            serviceFilePath: Types.FilePath;
+            update: Types.FunctionName;
             /**
-             * The name of the model used as a discriminant for the action execution. (e.g. `aggregation`)
+             * The name of the function that decodes an Upsert object to a fully typed object (e.g. `aggregationUpsertDecoder`.)
              */
-            actionModelDiscriminantName: Types.VariableName;
-            decoders: {
-                /**
-                 * The name of the variable that holds the decoders for the model. (e.g. `aggregationDecoders`)
-                 */
-                name: Types.VariableName;
-                /**
-                 * The name of the function that decodes a Create object to a fully typed object (e.g. `aggregationCreateDecoder`.)
-                 */
-                create: Types.FunctionName;
-                /**
-                 * The name of the function that decodes an Update object to a fully typed object (e.g. `aggregationUpdateDecoder`.)
-                 */
-                update: Types.FunctionName;
-                /**
-                 * The name of the function that decodes an Upsert object to a fully typed object (e.g. `aggregationUpsertDecoder`.)
-                 */
-                upsert: Types.FunctionName;
-                /**
-                 * The name of the function that clones an object (e.g. `aggregationCloneDecoder`.)
-                 */
-                clone: Types.FunctionName;
-            };
+            upsert: Types.FunctionName;
             /**
-             * The name of the map variable in the clone context that holds the cloned items of this model (e.g. `aggregation`)
+             * The name of the function that clones an object (e.g. `aggregationCloneDecoder`.)
              */
-            cloneContextMap: Types.VariableName;
+            clone: Types.FunctionName;
         };
+        /**
+         * The name of the map variable in the clone context that holds the cloned items of this model (e.g. `aggregation`)
+         */
+        cloneContextMap: Types.VariableName;
         /**
          * Name by which the business logic service exposes the data service.
          */
@@ -1005,11 +967,7 @@ export type ModelMetaData = {
         /**
          * Path to the file containing the seed data for this model (e.g. `aggregations.ts`).
          */
-        filePath: Types.FilePath;
-        /**
-         * The file or package name that contains the seed data for this model (e.g. `@d2i/aggregations`).
-         */
-        importPath: Types.BackendModulePath;
+        location: Types.ModuleLocation;
     };
     /**
      * Properties provided by the `react` generators.