@postxl/generator 0.44.3 → 0.44.5

package/dist/lib/meta.d.ts

@@ -4,6 +4,80 @@ import * as Types from './schema/types';
  * Collection of "global", schema-related values that might be referenced by different generators.
  */
 export type SchemaMetaData = {
+    /**
+     * Static meta data for the backend modules that are not generated
+     */
+    backendModules: {
+        common: {
+            /**
+             * Path that may be used to import the common backend module.
+             */
+            importPath: Types.BackendModulePath;
+            /**
+             * Names of the functions that are provided by the common backend module.
+             */
+            functions: {
+                format: Types.FunctionName;
+                pluralize: Types.FunctionName;
+                uncapitalizeKeys: Types.FunctionName;
+                capitalizeKeys: Types.FunctionName;
+                nullOrBlankDecoder: Types.FunctionName;
+                excelStringNullableDecoder: Types.FunctionName;
+                excelStringDecoder: Types.FunctionName;
+                excelDateNullableDecoder: Types.FunctionName;
+                excelDateDecoder: Types.FunctionName;
+                excelBooleanDecoder: Types.FunctionName;
+            };
+        };
+        auth: {
+            /**
+             * Path that may be used to import the auth backend module.
+             */
+            importPath: Types.BackendModulePath;
+        };
+        db: {
+            /**
+             * Path that may be used to import the db backend module.
+             */
+            importPath: Types.BackendModulePath;
+            dbService: {
+                /**
+                 * The name of the DB service class.
+                 */
+                name: Types.ClassName;
+            };
+        };
+        http: {
+            /**
+             * Path that may be used to import the http backend module.
+             */
+            importPath: Types.BackendModulePath;
+        };
+        i18n: {
+            /**
+             * Path that may be used to import the i18n backend module.
+             */
+            importPath: Types.BackendModulePath;
+        };
+        s3: {
+            /**
+             * Path that may be used to import the s3 backend module.
+             */
+            importPath: Types.BackendModulePath;
+        };
+        upload: {
+            /**
+             * Path that may be used to import the upload backend module.
+             */
+            importPath: Types.BackendModulePath;
+        };
+        xlport: {
+            /**
+             * Path that may be used to import the xlport backend module.
+             */
+            importPath: Types.BackendModulePath;
+        };
+    };
     actions: {
         /**
          * The name of the Module class
@@ -12,12 +86,8 @@ export type SchemaMetaData = {
         /**
          * Path that may be used to import from the action module.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         actionExecution: {
-            /**
-             * Path to the file containing the execution interface definition.
-             */
-            filePath: Types.Path;
             /**
              * The name of the interface that handles the action execution.
              */
@@ -35,7 +105,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the dispatcher service class definition.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the dispatcher service class.
              */
@@ -53,20 +123,20 @@ export type SchemaMetaData = {
         /**
          * Path that may be used to import from the data module.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * Path to the file containing the data module class definition.
          */
-        dataModuleFilePath: Types.Path;
+        dataModuleFilePath: Types.FilePath;
         /**
          * Path to the file containing the mock data for the database.
          */
-        dataMockModuleFilePath: Types.Path;
+        dataMockModuleFilePath: Types.FilePath;
         repository: {
             /**
              * Path to the file containing the repository type definition.
              */
-            typeFilePath: Types.Path;
+            typeFilePath: Types.FilePath;
             /**
              * Name of the repository type.
              */
@@ -74,17 +144,17 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the array with all repositories.
              */
-            constFilePath: Types.Path;
+            constFilePath: Types.FilePath;
             /**
              * Path to the file containing the index file for the repositories.
              */
-            indexFilePath: Types.Path;
+            indexFilePath: Types.FilePath;
         };
         types: {
             /**
              * Path to the types definition.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the BulkMutation type.
              */
@@ -106,7 +176,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing data service class definitions.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * Name of the data service class.
              */
@@ -120,30 +190,14 @@ export type SchemaMetaData = {
              */
             executeBulkMutation: Types.FunctionName;
         };
-        /**
-         * Path to the file containing data mocker class definitions.
-         */
-        dataMockerFilePath: Types.Path;
-        /**
-         * Path to the file containing component selectors for e2e tests.
-         */
-        selectorsFilePath: Types.Path;
         /**
          * Path to the file containing the testDataService class definition.
          */
-        testDataServiceFilePath: Types.Path;
-        /**
-         * Path to the file containing data mocker class definitions.
-         */
-        dataMockerStubIndexFilePath: Types.Path;
-        /**
-         * Path that may be used to import the data mocker stubs.
-         */
-        dataMockerStubImportPath: Types.Path;
+        testDataServiceFilePath: Types.FilePath;
         /**
          * Path to the file containing the index file for the subs.
          */
-        stubIndexFilePath: Types.Path;
+        stubIndexFilePath: Types.FilePath;
     };
     /**
      * Meta data for import/export operations.
@@ -152,7 +206,7 @@ export type SchemaMetaData = {
         /**
          * Path that may be used to import from the import-export module.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * Meta data for decoder functions.
          */
@@ -160,11 +214,11 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the import-export decoder index.
              */
-            indexFilePath: Types.Path;
+            indexFilePath: Types.FilePath;
             /**
              * Path to the file containing the data decoder
              */
-            fullDecoderFilePath: Types.Path;
+            fullDecoderFilePath: Types.FilePath;
             /**
              * Name of the data decoder function
              */
@@ -189,7 +243,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the exporter class.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the exporter class.
              */
@@ -199,7 +253,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the export service class.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the export service class.
              */
@@ -209,7 +263,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the import service class.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the import service class.
              */
@@ -231,7 +285,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the import function.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * Name of the function that convert import data to BulkMutations.
              */
@@ -252,7 +306,7 @@ export type SchemaMetaData = {
             /**
              * Path to the types definition.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the type that represents the delta of all models.
              */
@@ -412,15 +466,15 @@ export type SchemaMetaData = {
         /**
          * Path that may be used to import from the business logic module.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * Path to the file containing the business logic index.
          */
-        indexFilePath: Types.Path;
+        indexFilePath: Types.FilePath;
         /**
          * Path to the file containing the business logic module definition.
          */
-        moduleFilePath: Types.Path;
+        moduleFilePath: Types.FilePath;
         /**
          * Settings for the view sub-module
          */
@@ -432,15 +486,15 @@ export type SchemaMetaData = {
             /**
              * Path that may be used to import from the view module.
              */
-            importPath: Types.Path;
+            importPath: Types.BackendModulePath;
             /**
              * Path to the file containing the view index.
              */
-            indexFilePath: Types.Path;
+            indexFilePath: Types.FilePath;
             /**
              * Path to the file containing the view module definition.
              */
-            moduleFilePath: Types.Path;
+            moduleFilePath: Types.FilePath;
             /**
              * The name of the central view service class, containing all model view services.
              */
@@ -448,7 +502,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the view service class definition.
              */
-            serviceFilePath: Types.Path;
+            serviceFilePath: Types.FilePath;
         };
         /**
          * Settings for the update sub-module
@@ -461,15 +515,15 @@ export type SchemaMetaData = {
             /**
              * Path that may be used to import from the update module.
              */
-            importPath: Types.Path;
+            importPath: Types.BackendModulePath;
             /**
              * Path to the file containing the update index.
              */
-            indexFilePath: Types.Path;
+            indexFilePath: Types.FilePath;
             /**
              * Path to the file containing the update module definition.
              */
-            moduleFilePath: Types.Path;
+            moduleFilePath: Types.FilePath;
             /**
              * The name of the central update service class, containing all model update services.
              */
@@ -477,26 +531,26 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing the update service class definition.
              */
-            serviceFilePath: Types.Path;
+            serviceFilePath: Types.FilePath;
             /**
              * Path to the file containing the overall action types
              */
-            actionTypesFilePath: Types.Path;
+            actionTypesFilePath: Types.FilePath;
         };
     };
     seedData: {
         /**
          * Path that may be used in the import statement.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * Location of the initial seed data migration
          */
-        initialMigrationFilePath: Types.Path;
+        initialMigrationFilePath: Types.FilePath;
         /**
          * Path to seed Excel template file.
          */
-        templateExcelFilePath: Types.Path;
+        templateExcelFilePath: Types.FilePath;
     };
     seed: {
         /**
@@ -506,27 +560,27 @@ export type SchemaMetaData = {
         /**
          * Path that may be used in the import statement.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
     };
     trpc: {
         /**
          * Path to the file that contains the trpc routes object.
          */
-        routesFilePath: Types.Path;
+        routesFilePath: Types.FilePath;
         /**
          * Path that may be used to import the trpc routes object.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
     };
     types: {
         /**
          * Path to the index file for the types package.
          */
-        indexFilePath: Types.Path;
+        indexFilePath: Types.FilePath;
         /**
          * Path that may be used to import the type definitions package.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * Path and type names for the Data Transfer Objects (DTOs).
          */
@@ -534,7 +588,7 @@ export type SchemaMetaData = {
             /**
              * Path to the file containing DTO type definitions.
              */
-            path: Types.Path;
+            path: Types.FilePath;
             /**
              * Type for generic models
              */
@@ -557,10 +611,33 @@ export type SchemaMetaData = {
             upsert: Types.TypeName;
         };
     };
+    /**
+     * 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 component selectors for e2e tests.
+         */
+        selectorsFilePath: Types.FilePath;
+    };
     /**
      * Path to the directory containing migrations.
      */
-    migrationsPath: Types.Path;
+    migrationsPath: Types.FilePath;
     /**
      * The schema configuration for reference.
      */
@@ -640,7 +717,7 @@ export type ModelMetaData = {
         /**
          * Path that may be used to import definitions of this model.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * The name of the MockData's property that contains the mock data for this model. (e.g. aggregations)
          */
@@ -648,11 +725,7 @@ export type ModelMetaData = {
         /**
          * The path to the file containing stub definitions of this model.
          */
-        stubFilePath: Types.Path;
-        /**
-         * The path to the file containing stub definitions for the data mocker of this model.
-         */
-        dataMockerStubFilePath: Types.Path;
+        stubFilePath: Types.FilePath;
         /**
          * The name of the TypeScript constant that contains default values for all fields.
          */
@@ -677,7 +750,7 @@ export type ModelMetaData = {
             /**
              * Path to the file containing the repository definition.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the class for the repository definition of this model (e.g. AggregationRepository).
              */
@@ -699,13 +772,19 @@ export type ModelMetaData = {
             /**
              * Path to the file containing the mock repository definition.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * The name of the class for the in-memory mock repository definition of this model (e.g. MockAggregationRepository).
              */
             className: Types.ClassName;
         };
     };
+    e2e: {
+        /**
+         * The path to the file containing stub definitions for the data mocker of this model.
+         */
+        dataMockerStubFilePath: Types.FilePath;
+    };
     /**
      *  Properties provided by the `importExport` generators
      */
@@ -745,7 +824,7 @@ export type ModelMetaData = {
             /**
              * Path to the file containing the model's Excel decoders.
              */
-            filePath: Types.Path;
+            filePath: Types.FilePath;
             /**
              * Name of the type that represents the model in Excel import/export, e.g. `Aggregation_EncodedExcelData`.
              */
@@ -781,7 +860,7 @@ export type ModelMetaData = {
         /**
          * Path that may be used to import definitions of this model.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * The definitions for the view service of a model
          */
@@ -801,7 +880,7 @@ export type ModelMetaData = {
             /**
              * Path to the file containing the view service.
              */
-            serviceFilePath: Types.Path;
+            serviceFilePath: Types.FilePath;
         };
         /**
          * The definitions for the update service of a model
@@ -822,7 +901,7 @@ export type ModelMetaData = {
             /**
              * Path to the file containing the update service.
              */
-            serviceFilePath: Types.Path;
+            serviceFilePath: Types.FilePath;
             /**
              * The name of the model used as a discriminant for the action execution. (e.g. `aggregation`)
              */
@@ -889,11 +968,11 @@ export type ModelMetaData = {
         /**
          * Path to the file containing the seed data for this model (e.g. `aggregations.ts`).
          */
-        filePath: Types.Path;
+        filePath: Types.FilePath;
         /**
          * The file or package name that contains the seed data for this model (e.g. `@d2i/aggregations`).
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
     };
     /**
      * Properties provided by the `react` generators.
@@ -906,7 +985,7 @@ export type ModelMetaData = {
         /**
          * The path to the folder that contains React components for this model.
          */
-        folderPath: Types.Path;
+        folderPath: Types.FilePath;
         context: {
             /**
              * Name of the function that should be used as React hook (e.g. `useAggregationContext`).
@@ -952,14 +1031,10 @@ export type ModelMetaData = {
      * Properties provided by the `trpc` generators.
      */
     trpc: {
-        /**
-         * The path to the file that contains the router definition for this model.
-         */
-        importPath: Types.Path;
         /**
          * The absolute path of the file that contains the router definition for this model.
          */
-        routerFilePath: Types.Path;
+        routerFilePath: Types.FilePath;
         /**
          * The name of the router that should be used for this model (e.g. `aggregation`).
          */
@@ -1012,11 +1087,11 @@ export type ModelMetaData = {
         /**
          * The absolute path of the file that contains the type definition for this model.
          */
-        filePath: Types.Path;
+        filePath: Types.FilePath;
         /**
          * Path that may be used to import the types of this model.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * The name of the type that represents a branded ID, e.g. `AggregationId`.
          */
@@ -1124,11 +1199,11 @@ export type EnumMetaData = {
         /**
          * The path to the folder that contains React components for this model.
          */
-        folderPath: Types.Path;
+        folderPath: Types.FilePath;
         /**
          * Relative path to the file or a package that contains the React components for this model.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         selectInputName: Types.VariableName;
         selectFieldName: Types.VariableName;
         switcherInputName: Types.VariableName;
@@ -1148,11 +1223,11 @@ export type EnumMetaData = {
         /**
          * Relative path to the file that contains the enum's types, e.g. `./aggregation.type`.
          */
-        filePath: Types.Path;
+        filePath: Types.FilePath;
         /**
          * Path that should be used to import enum type definitions.
          */
-        importPath: Types.Path;
+        importPath: Types.BackendModulePath;
         /**
          * Name of the enum as it appears in the source file (e.g. in Prisma schema).
          */