@postxl/generator 0.74.2 → 1.0.3

package/dist/lib/meta.d.ts

@@ -1,1191 +0,0 @@
-import * as Schema from './schema/schema';
-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: {
-        auth: {
-            /**
-             * Path that may be used to import the auth backend module.
-             */
-            importPath: Types.BackendModulePath;
-        };
-        db: {
-            /**
-             * Name of the module class
-             */
-            moduleName: Types.ClassName;
-            /**
-             * Path that may be used to import the db backend module.
-             */
-            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.
-             */
-            moduleImportPath: Types.BackendModulePath;
-        };
-        i18n: {
-            /**
-             * Path that may be used to import the i18n backend module.
-             */
-            moduleImportPath: Types.BackendModulePath;
-        };
-        s3: {
-            /**
-             * Path that may be used to import the s3 backend module.
-             */
-            moduleImportPath: Types.BackendModulePath;
-        };
-        upload: {
-            /**
-             * Path that may be used to import the upload backend module.
-             */
-            moduleImportPath: Types.BackendModulePath;
-        };
-        xlport: {
-            /**
-             * Path that may be used to import the xlport backend module.
-             */
-            moduleImportPart: Types.BackendModulePath;
-        };
-    };
-    actions: {
-        /**
-         * The name of the Module class
-         */
-        moduleName: Types.ClassName;
-        /**
-         * Path that may be used to import the action module.
-         */
-        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;
-            /**
-             * Path that may be used to import the action execution interface.
-             */
-            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.
-             */
-            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.
-             */
-            schema: Types.TypeName;
-            /**
-             * The generated payload of the defined actions.
-             */
-            payload: Types.TypeName;
-            /**
-             * The generated result of the defined actions.
-             */
-            result: Types.TypeName;
-            /**
-             * The transformer type that converts action definitions into results dictionary.
-             */
-            resultDict: Types.TypeName;
-        };
-    };
-    /**
-     * Meta data for the data generators
-     */
-    data: {
-        /**
-         * The name of the Module class
-         */
-        moduleName: Types.ClassName;
-        /**
-         * Location of the module class
-         */
-        moduleLocation: Types.ModuleLocation;
-        repository: {
-            /**
-             * Path to the file containing the repository type definition.
-             */
-            typeFilePath: Types.FilePath;
-            /**
-             * Name of the repository type.
-             */
-            typeName: Types.TypeName;
-            /**
-             * Path to the file containing the array with all repositories.
-             */
-            constFilePath: Types.FilePath;
-            /**
-             * Path to the file containing the index file for the repositories.
-             */
-            indexFilePath: Types.FilePath;
-        };
-        types: {
-            /**
-             * Path to the types definition.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the BulkMutation type.
-             */
-            bulkMutation: Types.TypeName;
-            /**
-             * The name of the generic BulkMutation type for a model
-             */
-            bulkMutationForModel: Types.TypeName;
-        };
-        dataService: {
-            /**
-             * Path to the file containing data service class definitions.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the data service class.
-             */
-            class: Types.ClassName;
-            /**
-             * Name of the function that performs BulkMutations.
-             */
-            executeBulkMutations: Types.FunctionName;
-            /**
-             * Name of the function that performs BulkMutation.
-             */
-            executeBulkMutation: Types.FunctionName;
-        };
-        /**
-         * Path to the file containing the testDataService class definition.
-         */
-        testDataServiceFilePath: Types.FilePath;
-        /**
-         * Path to the file containing the index file for the subs.
-         */
-        stubIndexFilePath: Types.FilePath;
-    };
-    /**
-     * Meta data for import operations.
-     */
-    import: {
-        /**
-         * Path that may be used to import from the import module.
-         */
-        moduleLocation: Types.ModuleLocation;
-        /**
-         * Meta data for decoder functions.
-         */
-        decoder: {
-            /**
-             * Path to the file containing the data decoder
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the data decoder function
-             */
-            fullDecoderName: Types.FunctionName;
-            /**
-             * Name of the type that represents the data in the PXL model format
-             */
-            decodedPXLModelDataTypeName: Types.TypeName;
-        };
-        importService: {
-            /**
-             * Path to the file containing the import service class.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the import service class.
-             */
-            name: Types.ClassName;
-            /**
-             * Name of the instantiated import service as used in other services.
-             *
-             * Background: Normally, NestJS's dependency injection would be used to inject the import service into other services.
-             * However, due to a circular dependency between the import service and the dispatcher service, this is not possible.
-             * Instead, the dispatcher service has a public instance of the import service, which is set in the constructor of the import service.
-             * The `sharedName` is the name of this public instance.
-             */
-            sharedName: Types.VariableName;
-        };
-        /**
-         * Meta data for functions that handle the import of Excel data.
-         */
-        converterFunctions: {
-            /**
-             * Path to the file containing the import function.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the function that convert import data to BulkMutations.
-             */
-            importedDataToBulkMutations: Types.FunctionName;
-            /**
-             * Name of the function that converts a delta to BulkMutations.
-             */
-            deltaToBulkMutations: Types.FunctionName;
-        };
-        /**
-         * Meta data for the import export types file.
-         */
-        types: {
-            /**
-             * Path to the types definition.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the type that represents the delta of all models.
-             */
-            delta: Types.TypeName;
-            delta_Model: {
-                /**
-                 * The name of the type that represents the delta of a model.
-                 */
-                type: Types.TypeName;
-                create: {
-                    /**
-                     * The name of the type that represents the items of a model that should be created.
-                     */
-                    type: Types.TypeName;
-                    /**
-                     * The discriminant for the delta of a model that should be created.
-                     */
-                    discriminant: Types.DiscriminantName;
-                    /**
-                     * The name of the type guard function that checks if a delta item is a create delta.
-                     */
-                    typeGuard: Types.FunctionName;
-                };
-                update: {
-                    /**
-                     * The name of the type that represents the delta of existing model items that should be updated.
-                     */
-                    type: Types.TypeName;
-                    /**
-                     * The discriminant for the delta of existing model items that should be updated.
-                     */
-                    discriminant: Types.DiscriminantName;
-                    /**
-                     * The name of the type guard function that checks if a delta item is an update delta.
-                     */
-                    typeGuard: Types.FunctionName;
-                };
-                delete: {
-                    /**
-                     * The name of the type that represents the items of a model that should be deleted.
-                     */
-                    type: Types.TypeName;
-                    /**
-                     * The discriminant for the delta of a model that should be deleted.
-                     */
-                    discriminant: Types.DiscriminantName;
-                    /**
-                     * The name of the type that represents the items of a model that should be deleted.
-                     */
-                    typeGuard: Types.FunctionName;
-                };
-                unchanged: {
-                    /**
-                     * The name of the type that represents unchanged items of model.
-                     */
-                    type: Types.TypeName;
-                    /**
-                     * The discriminant for unchanged items of a model.
-                     */
-                    discriminant: Types.DiscriminantName;
-                    /**
-                     * The name of the type that represents unchanged items of a model.
-                     */
-                    typeGuard: Types.FunctionName;
-                };
-                errors: {
-                    /**
-                     * The name of the type that represents the items of a model that contain errors.
-                     */
-                    type: Types.TypeName;
-                    /**
-                     * The discriminant for the items of a model that contain errors.
-                     */
-                    discriminant: Types.DiscriminantName;
-                    /**
-                     * The name of the type guard function that checks if a delta item is an error.
-                     */
-                    typeGuard: Types.FunctionName;
-                    /**
-                     * Meta data for the model error type for a missing field.
-                     */
-                    missingField: {
-                        /**
-                         * The name of the type that represents the error of missing fields.
-                         */
-                        type: Types.TypeName;
-                        /**
-                         * The discriminant for the error of missing fields.
-                         */
-                        discriminant: Types.DiscriminantName;
-                    };
-                    /**
-                     * Meta data for the model error type for an invalid reference.
-                     */
-                    invalidReference: {
-                        /**
-                         * The name of the type that represents the error of invalid references.
-                         */
-                        type: Types.TypeName;
-                        /**
-                         * The discriminant for the error of invalid references.
-                         */
-                        discriminant: Types.DiscriminantName;
-                    };
-                    /**
-                     * Meta data for the model error type for non-unique fields.
-                     */
-                    nonUnique: {
-                        /**
-                         * The name of the type that represents the error of non-unique fields.
-                         */
-                        type: Types.TypeName;
-                        /**
-                         * The discriminant for the error of non-unique fields.
-                         */
-                        discriminant: Types.DiscriminantName;
-                    };
-                    /**
-                     * Meta data for the model error type for invalid types.
-                     */
-                    invalidType: {
-                        /**
-                         * The name of the type that represents the error of invalid types.
-                         */
-                        type: Types.TypeName;
-                        /**
-                         * The discriminant for the error of invalid types.
-                         */
-                        discriminant: Types.DiscriminantName;
-                    };
-                    /**
-                     * Meta data for the model error type where the item is a required dependency of another item.
-                     */
-                    isRequiredDependency: {
-                        /**
-                         * The name of the type that represents an item to be deleted that is a required dependency of another item.
-                         */
-                        type: Types.TypeName;
-                        /**
-                         * The discriminant for the error of missing required dependencies.
-                         */
-                        discriminant: Types.DiscriminantName;
-                    };
-                };
-            };
-            /**
-             * The name of the type representing modified fields of a model.
-             */
-            delta_Fields: Types.TypeName;
-        };
-    };
-    /**
-     * Meta data for export operations.
-     */
-    export: {
-        /**
-         * Path that may be used to import from the export module.
-         */
-        moduleLocation: Types.ModuleLocation;
-        /**
-         * Meta data for the exporter class.
-         */
-        exporterClass: {
-            /**
-             * Path to the file containing the exporter class.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the exporter class.
-             */
-            name: Types.ClassName;
-        };
-        exportService: {
-            /**
-             * Path to the file containing the export service class.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the export service class.
-             */
-            name: Types.ClassName;
-        };
-        /**
-         * Meta data for decoder functions.
-         */
-        encoder: {
-            /**
-             * Path to the file containing the data encoder
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the data encoder function
-             */
-            fullEncoderFunctionName: Types.FunctionName;
-            /**
-             * Name of the type that represents the data in encoded Excel format
-             */
-            encodedExcelDataTypeName: Types.TypeName;
-        };
-    };
-    view: {
-        /**
-         * The name of the module class
-         */
-        moduleName: Types.ClassName;
-        /**
-         * Path that may be used to import from the view module.
-         */
-        moduleLocation: Types.ModuleLocation;
-        /**
-         * 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.
-         */
-        serviceLocation: Types.ModuleLocation;
-    };
-    /**
-     * Settings for the update module
-     */
-    update: {
-        /**
-         * The name of the module class
-         */
-        moduleName: Types.ClassName;
-        /**
-         * Path that may be used to import from the update module.
-         */
-        moduleLocation: Types.ModuleLocation;
-        /**
-         * 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.
-         */
-        serviceLocation: Types.ModuleLocation;
-        /**
-         * Path to the file containing the overall action types
-         */
-        actionTypesFilePath: Types.FilePath;
-    };
-    seedData: {
-        /**
-         * Location of the initial seed data migration
-         */
-        initialMigrationLocation: Types.ModuleLocation;
-        /**
-         * Path to seed Excel template file.
-         */
-        templateExcelFilePath: Types.FilePath;
-    };
-    seed: {
-        /**
-         * The name of the SeedService class.
-         */
-        serviceClassName: Types.ClassName;
-        /**
-         * Path that may be used in the import statement.
-         */
-        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;
-    };
-    types: {
-        /**
-         * Path to the index file for the types package.
-         */
-        indexFilePath: Types.FilePath;
-        /**
-         * Path that may be used to import the type definitions package.
-         */
-        importPath: Types.BackendModulePath;
-        /**
-         * Index of all branded ID types associated with the models.
-         *
-         * @example
-         * ```
-         * type SchemaIdTypes = {
-         *   Post: PostId
-         *   Comment: CommentId
-         * }
-         * ```
-         */
-        idTypesIndex: Types.TypeName;
-        /**
-         * Path and type names for the Data Transfer Objects (DTOs).
-         */
-        dto: {
-            /**
-             * Path to the file containing DTO type definitions.
-             */
-            path: Types.FilePath;
-            /**
-             * Type for generic models
-             */
-            genericModel: Types.TypeName;
-            /**
-             * Generic type for an ID.
-             */
-            idType: Types.TypeName;
-            /**
-             * 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;
-        };
-    };
-    /**
-     * Meta data for the e2e generators.
-     */
-    e2e: {
-        /**
-         * Path to the file containing component test ids for e2e tests.
-         */
-        testIdsFilePath: Types.FilePath;
-    };
-    /**
-     * Path to the directory containing Prisma migrations.
-     */
-    prismaMigrationsPath: Types.FilePath;
-    /**
-     * The schema configuration for reference.
-     */
-    config: Schema.SchemaConfig;
-};
-/**
- * Returns a collection of metadata relevant in the global schema context.
- */
-export declare function getSchemaMetadata({ config }: {
-    config: Schema.SchemaConfig;
-}): SchemaMetaData;
-/**
- * Collection of values that might be referenced by different generators.
- */
-export type ModelMetaData = {
-    /**
-     * A user friendly name
-     *
-     * 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.
-     *
-     * NOTE: This name is meant to be used in internal variables only.
-     *       For any variables, class names, etc. that are exposed, please use a more specific name.
-     *       (e.g. `reactCreateModalComponentName`)
-     */
-    internalSingularName: Types.VariableName;
-    /**
-     * The name of the capitalized model in singular form.
-     *
-     * NOTE: This name is meant to be used in internal types only.
-     *       For any types, class names, etc. that are exposed, please use a more specific name.
-     */
-    internalSingularNameCapitalized: Types.VariableName;
-    /**
-     * The name of the model in plural form.
-     *
-     * NOTE: This name is meant to be used in internal variables only.
-     *       For any variables, class names, etc. that are exposed, please use a more specific name.
-     *       (e.g. `reactCreateModalComponentName`)
-     */
-    internalPluralName: Types.VariableName;
-    /**
-     * The name of the capitalized model in plural form.
-     *
-     * NOTE: This name is meant to be used in internal types only.
-     *       For any variables, class names, etc. that are exposed, please use a more specific name.
-     */
-    internalPluralNameCapitalized: Types.VariableName;
-    /**
-     * Properties provided by the `actions` generators.
-     */
-    actions: {
-        /**
-         * Each model defines its own action scope as a discriminant for the action execution. (e.g. `aggregation`)
-         */
-        actionScopeConstType: Types.TypeName;
-    };
-    /**
-     * Properties provided by the `data` generators.
-     */
-    data: {
-        /**
-         * Path that may be used to import definitions of this model.
-         */
-        importPath: Types.BackendModulePath;
-        /**
-         * The name of the MockData's property that contains the mock data for this model. (e.g. aggregations)
-         */
-        mockDataPropertyName: Types.VariableName;
-        /**
-         * The path to the file containing stub definitions of this model.
-         */
-        stubLocation: Types.ModuleLocation;
-        /**
-         * The name of the TypeScript constant that contains default values for all fields.
-         */
-        defaultStubConstantName: Types.VariableName;
-        /**
-         * The name of the function that adds missing values to the partially populated model value.
-         */
-        stubGenerationFnName: Types.FunctionName;
-        /**
-         * The name by which the repository is exposed in the dataService/context. (e.g. aggregations)
-         */
-        dataServiceName: Types.VariableName;
-        /**
-         * The name for internal use of modelIds in data mocker
-         */
-        dataServiceIdName: Types.VariableName;
-        repository: {
-            /**
-             * Location of the file containing the repository definition for this model.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the class for the repository definition of this model (e.g. AggregationRepository).
-             */
-            className: Types.ClassName;
-            /**
-             * The name of the function that decodes a source (database) object to a fully typed object (e.g. `toAggregation`.)
-             */
-            decoderFnName: Types.FunctionName;
-            /**
-             * The name of the method that should be used to get objects from the database (e.g. `aggregations`.)
-             */
-            getMethodFnName: Types.FunctionName;
-        };
-    };
-    /**
-     *  Properties provided by the `import` generators
-     */
-    import: {
-        /**
-         * The name of the export Excel table (e.g. `Aggregations`).
-         */
-        tableName: string;
-        /**
-         * Name of the model specific error type
-         */
-        delta_Model_Errors: Types.TypeName;
-        /**
-         * Meta data of the model's Excel decoders
-         */
-        decoder: {
-            /**
-             * Location of the file containing the model's Excel decoders.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the decoder function that represents the Excel table import type (e.g. `aggregationExcelTableDecoder`.)
-             */
-            tableDecoder: Types.FunctionName;
-            /**
-             * Name of the array in the decoded data containing all entities of this model (e.g. `aggregations`.)
-             */
-            decodedModelArrayName: Types.VariableName;
-            /**
-             * Name of the function that decodes a model Excel row (not blank!) to a fully typed object
-             */
-            rowDecoderName: Types.FunctionName;
-        };
-    };
-    /**
-     *  Properties provided by the `export` generators
-     */
-    export: {
-        /**
-         * Name of the data exports model property (e.g. `Aggregations`).
-         */
-        exportDataPropertyName: Types.VariableName;
-        /**
-         * Name of the data exports model in the full export (e.g. `aggregations`).
-         */
-        exportDataFullPropertyName: Types.VariableName;
-        /**
-         * Name of the data export type (e.g. `Aggregations_Export`).
-         */
-        exportDataTypeName: Types.TypeName;
-        /**
-         * Name of the function that adds an instance of this model to the exporter (e.g. `addAggregation`.)
-         */
-        exportAddFunctionName: Types.FunctionName;
-        /**
-         * The name of the export Excel table (e.g. `Aggregations`).
-         */
-        tableName: string;
-        /**
-         * Meta data of the model's Excel decoders
-         */
-        encoder: {
-            /**
-             * Location of the file containing the model's Excel encoders.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the type that represents the model in Excel import/export (e.g. `Aggregation_EncodedExcelData`.)
-             */
-            encodedExcelType: Types.TypeName;
-            /**
-             * Name of the function that converts a model item to the Excel format (e.g. `encodeAggregation`.)
-             */
-            itemEncoderFunctionName: Types.FunctionName;
-            /**
-             * Name of the function that converts an array of model items to the Excel format (e.g. `encodeAggregations`.)
-             */
-            arrayEncoderFunctionName: Types.FunctionName;
-        };
-    };
-    /**
-     * Properties provided by the `business logic` generator.
-     */
-    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
-         * whatever makes sense to put into a single business logic service - e.g. "approval" (for MCA) or "calculation" (for LA360).
-         */
-        scopeName: Types.VariableName;
-        /**
-         * 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;
-        /**
-         * Path to the view service for this model.
-         */
-        serviceLocation: Types.ModuleLocation;
-        /**
-         * The name of the variable that defines the filter operator decoder for the current model.
-         */
-        filterOperatorDecoder: Types.VariableName;
-        /**
-         * The name of the variable that defines the cursor decoder for the current model.
-         */
-        cursorDecoder: 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;
-        /**
-         * The name of the function that decodes a Create object to a fully typed object (e.g. `aggregationCreateDecoder`.)
-         */
-        createInputDecoder: Types.VariableName;
-        /**
-         * The name of the function that decodes an Update object to a fully typed object (e.g. `aggregationUpdateDecoder`.)
-         */
-        updateInputDecoder: Types.VariableName;
-        /**
-         * The name of the function that decodes an Upsert object to a fully typed object (e.g. `aggregationUpsertDecoder`.)
-         */
-        upsertInputDecoder: Types.VariableName;
-    };
-    /**
-     * Properties provided by the `seed` generators.
-     */
-    seed: {
-        /**
-         * The name of the constant containing seed data of this model (e.g. `aggregations`).
-         */
-        constantName: Types.VariableName;
-        /**
-         * Path to the file containing the seed data for this model (e.g. `aggregations.ts`).
-         */
-        location: Types.ModuleLocation;
-    };
-    /**
-     * Properties provided by the `react` generators.
-     */
-    react: {
-        /**
-         * Name of the folder that contains React components for this model.
-         */
-        folderName: Types.FolderName;
-        /**
-         * The path to the folder that contains React components for this model.
-         */
-        folderPath: Types.FilePath;
-        /**
-         * Globally accessible import path for the model's React components.
-         */
-        importPath: Types.FilePath;
-        context: {
-            /**
-             * Name of the function that should be used as React hook (e.g. `useAggregationContext`).
-             */
-            hookFnName: Types.FunctionName;
-            /**
-             * Name of the function that may be used to get a single instance of this model (e.g. `useAggregation`).
-             */
-            instanceGetterHookFnName: Types.FunctionName;
-        };
-        /**
-         * Names of React components that should be generated for this model.
-         *
-         * NOTE: You can assume that these components exist.
-         */
-        components: {
-            modals: {
-                createComponentName: Types.VariableName;
-                editComponentName: Types.VariableName;
-                deleteComponentName: Types.VariableName;
-            };
-            forms: {
-                selectInputName: Types.VariableName;
-                selectFieldName: Types.VariableName;
-                menuSelectInputName: Types.VariableName;
-                menuSelectFieldName: Types.VariableName;
-                searchInputName: Types.VariableName;
-                searchFieldName: Types.VariableName;
-                tableSelectInputName: Types.VariableName;
-                tableSelectFieldName: Types.VariableName;
-            };
-            /**
-             * React component that may be used to list all model instances.
-             */
-            libraryComponentName: Types.VariableName;
-            /**
-             * Name of the generic component containing basic information about a single model instance.
-             */
-            cardComponentName: Types.VariableName;
-        };
-    };
-    /**
-     * Properties provided by the `trpc` generators.
-     */
-    trpc: {
-        /**
-         * The absolute path of the file that contains the router definition for this model.
-         */
-        routerFilePath: Types.FilePath;
-        /**
-         * The name of the router that should be used for this model (e.g. `aggregation`).
-         */
-        routerName: Types.VariableName;
-        getMap: {
-            /**
-             * The name of the TRPC getMap method (e.g. `getMap` or `getMapAggregation`).
-             */
-            methodName: Types.VariableName;
-            /**
-             * The full method name of the React Query method (e.g. `aggregations.getMap`).
-             */
-            reactQueryMethod: Types.FunctionName;
-        };
-        create: {
-            /**
-             * The name of the TRPC create method (e.g. `create` or `createAggregation`).
-             */
-            methodName: Types.VariableName;
-            /**
-             * The full method name of the React Query method (e.g. `aggregations.create`).
-             */
-            reactQueryMethod: Types.FunctionName;
-        };
-        update: {
-            /**
-             * The name of the TRPC update method (e.g. `update` or `updateAggregation`).
-             */
-            methodName: Types.VariableName;
-            /**
-             * The full method name of the React Query method (e.g. `aggregations.update`).
-             */
-            reactQueryMethod: Types.FunctionName;
-        };
-        delete: {
-            /**
-             * The name of the TRPC delete method (e.g. `delete` or `deleteAggregation`).
-             */
-            methodName: Types.VariableName;
-            /**
-             * The full method name of the React Query method (e.g. `aggregations.delete`).
-             */
-            reactQueryMethod: Types.FunctionName;
-        };
-    };
-    /**
-     * Properties provided by the `admin.page` generators.
-     */
-    admin: {
-        /**
-         * The absolute file path of the admin page for this model.
-         */
-        filePath: Types.FilePath;
-    };
-    /**
-     * Properties provided by the `types` generators.
-     */
-    types: {
-        /**
-         * The absolute path of the file that contains the type definition for this model.
-         */
-        filePath: Types.FilePath;
-        /**
-         * Path that may be used to import the types of this model.
-         */
-        importPath: Types.BackendModulePath;
-        /**
-         * The name of the type that represents a branded ID (e.g. `AggregationId`.)
-         */
-        brandedIdType: Types.TypeName;
-        /**
-         * Function that may be used to convert a scalar value to a branded ID type,
-         * e.g. `toAggregationId`.
-         */
-        toBrandedIdTypeFnName: Types.FunctionName;
-        zodDecoderFnNames: {
-            /**
-             * The name of the function that decodes a scalar value to a branded ID type (e.g. `aggregationIdDecoder`.)
-             */
-            id: Types.FunctionName;
-            /**
-             * The name of the function that decodes a source (database) object to a fully typed object (e.g. `aggregationDatabaseDecoder`.)
-             */
-            fromDatabase: Types.FunctionName;
-        };
-        /**
-         * Type definitions for the different Data Transfer Objects (DTOs).
-         */
-        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 type that represents a DTO for cloning an existing object (e.g. `AggregationCloneDTO`.)
-             */
-            clone: Types.TypeName;
-        };
-        /**
-         * The name of the file containing type definitions (e.g. `aggregation.type`).
-         */
-        typeDefFileName: Types.FileName;
-        /**
-         * The name of the type that represents a fully typed, flat object (e.g. `Aggregation`.)
-         * This type only refers to related types by their branded ID.
-         */
-        typeName: Types.TypeName;
-        /**
-         * The name of the type that represents a fully typed object (e.g. `AggregationFull`.)
-         * This type refers to relations by linking to the (flat) types.
-         */
-        linkedTypeName: Types.TypeName;
-        /**
-         * The name of the type that represents a source (i.e. database) object (e.g. `Aggregation`.)
-         */
-        sourceType: Types.TypeName;
-    };
-};
-/**
- * Returns metadata related to the given model.
- */
-export declare function getModelMetadata({ model }: {
-    model: Schema.ModelCore;
-}): ModelMetaData;
-export type FieldMetaData = {
-    /**
-     * Name of the field as it should appear in the "exposed" properties of the generated type.
-     */
-    tsFieldName: Types.VariableName;
-    /**
-     * The name of the method that should be used to get all child objects for a given item (e.g. `getItemsForAggregation`.)
-     */
-    getByForeignKeyMethodFnName: Types.FunctionName;
-    /**
-     * The name of the method that should be used to get all child Ids for a given item (e.g. `getIdsForAggregation`.)
-     */
-    getByForeignKeyIdsMethodFnName: Types.FunctionName;
-    /**
-     * The name of the column in the seed Excel table (e.g. `Aggregation`.)
-     */
-    excelColumnName: string;
-};
-/**
- * A collection of hardcoded values shared across multiple generators related to the given field in the model.
- */
-export declare function getFieldMetadata({ field }: {
-    field: Schema.Field;
-}): FieldMetaData;
-export type EnumMetaData = {
-    react: {
-        /**
-         * Name of the folder that contains React components for this model.
-         */
-        folderName: Types.FolderName;
-        /**
-         * The path to the folder that contains React components for this model.
-         */
-        folderPath: Types.FilePath;
-        /**
-         * Relative path to the file or a package that contains the React components for this model.
-         */
-        importPath: Types.BackendModulePath;
-        selectInputName: Types.VariableName;
-        selectFieldName: Types.VariableName;
-        switcherInputName: Types.VariableName;
-        switcherFieldName: Types.VariableName;
-        menuInputName: Types.VariableName;
-        menuFieldName: Types.VariableName;
-    };
-    types: {
-        /**
-         * Variable that holds a list of all enum members (e.g. `aggregationGroupMembers`).
-         */
-        membersList: Types.VariableName;
-        /**
-         * Variable that holds a map of all enum members (e.g. `aggregationGroup`).
-         */
-        membersMap: Types.VariableName;
-        /**
-         * Relative path to the file that contains the enum's types (e.g. `./aggregation.type`.)
-         */
-        filePath: Types.FilePath;
-        /**
-         * Path that should be used to import enum type definitions.
-         */
-        importPath: Types.BackendModulePath;
-        /**
-         * Name of the enum as it appears in the source file (e.g. in Prisma schema).
-         */
-        sourceName: string;
-    };
-};
-/**
- * Returns string values that may be used across multiple generators related to the given enum.
- */
-export declare function getEnumMetadata({ enumerator: { name, schemaConfig: config }, }: {
-    enumerator: Schema.Enum;
-}): EnumMetaData;