@postxl/generator 0.74.2 → 1.0.1

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

@@ -1,466 +0,0 @@
-import { EnumAttributes, FieldAttributes, ModelAttributes } from '../attributes';
-import { Prettify } from '../utils/types';
-import * as Types from './types';
-/**
- * A shared configuration of the schema.
- *
- * NOTE: This may be accessed in every model, field and enumerator.
- */
-export type SchemaConfig = {
-    paths: {
-        /**
-         * Path to the directory containing actions.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference actions using `@backend/actions` import.
-         */
-        actionsPath: Types.FilePath;
-        /**
-         * Path to the directory containing business view logic.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference mock data using `@backend/view` import.
-         */
-        businessViewLogicPath: Types.FilePath;
-        /**
-         * Path to the directory containing business update logic.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference mock data using `@backend/update` import.
-         */
-        businessUpdateLogicPath: Types.FilePath;
-        /**
-         * Path to the directory containing Playwright project.
-         */
-        playwrightPath: Types.FilePath;
-        /**
-         * Path to the directory containing e2e tests.
-         */
-        e2eLibPath: Types.FilePath;
-        /**
-         * Path to the directory containing data library definitions.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference data library using `@backend/data` import.
-         */
-        dataLibPath: Types.FilePath;
-        /**
-         * Path to the directory containing db library definitions.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference data library using `@backend/db` import.
-         */
-        dbLibPath: Types.FilePath;
-        /**
-         * Path to the directory containing import module.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference import using `@backend/import` import.
-         */
-        importPath: Types.FilePath;
-        /**
-         * Path to the directory containing export module.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference export using `@backend/export` import.
-         */
-        exportPath: Types.FilePath;
-        /**
-         * Path to the directory containing Prisma migrations.
-         */
-        prismaMigrationsFolderPath: Types.FilePath;
-        /**
-         * Path to the directory containing model type definitions.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference type definitions using `@backend/types` import.
-         */
-        modelTypeDefinitionsPath: Types.FilePath;
-        /**
-         * Path to the directory containing React components.
-         *
-         * NOTE: Metadata assumes that the project is set up so that React components
-         * may be referenced using `@backend/react` import.
-         */
-        reactFolderPath: Types.FilePath;
-        /**
-         * Path to the directory containing seed module.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference mock data using `@backend/seed` import.
-         */
-        seedLibPath: Types.FilePath;
-        /**
-         * Path to the directory containing mock data samples.
-         *
-         * NOTE: Metadata assumes that project is set up so that certain parts of the code
-         * may reference mock data using `@backend/seed-data` import.
-         */
-        seedDataPath: Types.FilePath;
-        /**
-         * Path to the directory containing trpc routes.
-         */
-        trpcRoutesFolderPath: Types.FilePath;
-        /**
-         * Path to the directory containing admin pages.
-         */
-        adminPagesFolderPath: Types.FilePath;
-    };
-    /**
-     * Whether the generator should overwrite existing files.
-     */
-    force: boolean;
-    /**
-     * Name of the User type
-     */
-    userType: Types.TypeName;
-};
-export type Model = Prettify<ModelCore & ModelFields>;
-/**
- * The model's core properties (i.e. without fields)
- */
-export type ModelCore = {
-    /**
-     * Name of the model (e.g. Aggregation)
-     */
-    name: Types.ModelName;
-    /**
-     * Description of the model, ideally providing business background and detailed information
-     */
-    description?: string;
-    /**
-     * Name of the models type (e.g. Aggregation)
-     */
-    typeName: Types.TypeName;
-    /**
-     * Name of the model in the source, e.g. in the database (e.g. aggregation)
-     *
-     * Note: Should be only relevant to repository and DB migration generators
-     * @internal
-     */
-    sourceName: string;
-    /**
-     * Name of the schema in the source, (e.g. Configuration)
-     *
-     * Note: Should be only relevant to DB migration generator
-     * @internal
-     */
-    sourceSchemaName?: string;
-    /**
-     * Type of the ID field that is specific to this model, e.g. `AggregationId`.
-     */
-    brandedIdType: Types.TypeName;
-    /**
-     * Attributes of the model
-     * @see ModelAttributes
-     */
-    attributes: ModelAttributes;
-    /**
-     * A global schema configuration.
-     */
-    schemaConfig: SchemaConfig;
-};
-export type ModelFields = {
-    /**
-     * The id field of the model
-     */
-    idField: FieldId;
-    /**
-     * The field of the model that identifies when the entry was created.
-     */
-    createdAtField?: FieldScalar;
-    /**
-     * The field of the model that identifies when the entry was last updated.
-     */
-    updatedAtField?: FieldScalar;
-    /**
-     * The property of the model that identifies the default row.
-     */
-    defaultField?: Field;
-    /**
-     * The property of the model that is used to define the name/label
-     *
-     * By default, this is maps to the `name` field (with `id` field used as fallback in case no `name` field exists).
-     * Using the `@@Label()` attribute, other fields can be used.
-     */
-    nameField: Field;
-    /**
-     * All fields of the model
-     */
-    fields: Field[];
-    /**
-     * A list of models that reference this model in their relations.
-     */
-    references: {
-        /**
-         * The name of the field in the referencing model that references this model.
-         */
-        referencingField: FieldRelation;
-        /**
-         * The model that references this model.
-         */
-        referencingModel: ModelCore;
-    }[];
-};
-/**
- * A field of a model.
- * Note: Different field types are represented as discriminant unions.
- */
-export type Field = FieldId | FieldScalar | FieldRelation | FieldEnum;
-/**
- * The properties shared by all field types.
- */
-export type FieldCore = {
-    /**
-     * Name of the field and variable (e.g. name)
-     *
-     * Note: The type of the name is narrowed by each field type.
-     */
-    name: Types.FieldName;
-    /**
-     * Description of the field, ideally providing business background and detailed information
-     */
-    description?: string;
-    /**
-     * Tells whether there's a NOT NULL constraint on the field.
-     */
-    isRequired: boolean;
-    /**
-     * Tells whether there's a unique constraint on the field.
-     */
-    isUnique: boolean;
-    /**
-     * A dictionary of potential attributes the field can have.
-     */
-    attributes: FieldAttributes;
-    /**
-     * Name of the field in the source e.g. in the database (e.g. Id)
-     */
-    sourceName: string;
-    /**
-     * The type of the field as it appears in the schema (e.g. `Int`, `Float`, `String`).
-     */
-    schemaType: string;
-    /**
-     * Validation rule for the field.
-     */
-    validation?: Validation;
-    /**
-     * A global schema configuration.
-     */
-    schemaConfig: SchemaConfig;
-};
-export type Validation = {
-    type: 'int';
-} | {
-    type: 'float';
-};
-/**
- * A scalar field, i.e. a string, number, boolean, Date
- */
-export type FieldScalar = Prettify<Omit<FieldCore, 'name'> & {
-    kind: 'scalar';
-    /**
-     * Name of the field and variable (e.g. name)
-     */
-    name: Types.FieldName;
-    /**
-     * Name of the scalar TypeScript type, e.g. string
-     */
-    tsTypeName: Types.TypeName;
-    /**
-     * If true, each element is unique.
-     * Note: This is ensured by the repository/database
-     */
-    isUnique: boolean;
-    /**
-     * True if the id field is an autoIncremented field.
-     */
-    isGenerated: boolean;
-}>;
-/**
- * The id field of a model. A model can only have one id field.
- */
-export type FieldId = Prettify<Omit<FieldCore, 'name'> & {
-    kind: 'id';
-    /**
-     * Name of the field and variable (must be `id`)
-     */
-    name: Types.IdFieldName;
-    /**
-     * Model that this ID field identifies.
-     */
-    model: ModelCore;
-    /**
-     * If true, each element is unique.
-     * Note: This is ensured by the repository/database
-     */
-    isUnique: boolean;
-    /**
-     * True if the id field is an autoIncremented field.
-     */
-    isGenerated: boolean;
-    /**
-     * Name of the unbranded TypeScript type of the id field, e.g. string
-     *
-     * Note: This should only be used in the type generator - all other generators
-     * should use the branded type "tsTypeName"!
-     */
-    unbrandedTypeName: Types.TypeName;
-}>;
-/**
- * Utility function to check if a field is an id field.
- */
-export declare const isFieldId: (field: Field) => field is Prettify<Omit<FieldCore, "name"> & {
-    kind: 'id';
-    /**
-     * Name of the field and variable (must be `id`)
-     */
-    name: Types.IdFieldName;
-    /**
-     * Model that this ID field identifies.
-     */
-    model: ModelCore;
-    /**
-     * If true, each element is unique.
-     * Note: This is ensured by the repository/database
-     */
-    isUnique: boolean;
-    /**
-     * True if the id field is an autoIncremented field.
-     */
-    isGenerated: boolean;
-    /**
-     * Name of the unbranded TypeScript type of the id field, e.g. string
-     *
-     * Note: This should only be used in the type generator - all other generators
-     * should use the branded type "tsTypeName"!
-     */
-    unbrandedTypeName: Types.TypeName;
-}>;
-/**
- * A relation field, representing a "to-relation" in the schema.
- */
-export type FieldRelation = Prettify<Omit<FieldCore, 'name'> & {
-    kind: 'relation';
-    /**
-     * Name of the field and variable (e.g. aggregationId)
-     */
-    name: Types.FieldName;
-    /**
-     * Name of the relation field in the model.
-     *
-     * NOTE: This does not reference the database column name, but the field name
-     *  in the model (e.g. not `aggregationId`, but `aggregation`).
-     */
-    relationFieldName: Types.FieldName;
-    /**
-     * Name of the unbranded TypeScript type of the field, e.g. string
-     *
-     * Note: This should only be used in the type generator - all other generators
-     * should use the branded type "typeName"!
-     *
-     * @internal
-     */
-    unbrandedTypeName: Types.TypeName;
-    /**
-     * The referenced model.
-     */
-    relationToModel: ModelCore;
-}>;
-/**
- * Utility function to check if a field is an relation field.
- */
-export declare const isFieldRelation: (field: Field) => field is Prettify<Omit<FieldCore, "name"> & {
-    kind: 'relation';
-    /**
-     * Name of the field and variable (e.g. aggregationId)
-     */
-    name: Types.FieldName;
-    /**
-     * Name of the relation field in the model.
-     *
-     * NOTE: This does not reference the database column name, but the field name
-     *  in the model (e.g. not `aggregationId`, but `aggregation`).
-     */
-    relationFieldName: Types.FieldName;
-    /**
-     * Name of the unbranded TypeScript type of the field, e.g. string
-     *
-     * Note: This should only be used in the type generator - all other generators
-     * should use the branded type "typeName"!
-     *
-     * @internal
-     */
-    unbrandedTypeName: Types.TypeName;
-    /**
-     * The referenced model.
-     */
-    relationToModel: ModelCore;
-}>;
-/**
- * An enum field, e.g. a field that can only have a value of a specific enum.
- */
-export type FieldEnum = Prettify<Omit<FieldCore, 'name'> & {
-    kind: 'enum';
-    /**
-     * Name of the field and variable (e.g. language)
-     */
-    name: Types.FieldName;
-    /**
-     * Name of the TypeScript type of the field, e.g. Language
-     */
-    typeName: Types.TypeName;
-    /**
-     * Enum definition of the field.
-     */
-    enumerator: Enum;
-}>;
-/**
- * Utility function to check if a field is an enum field.
- */
-export declare const isFieldEnum: (field: Field) => field is Prettify<Omit<FieldCore, "name"> & {
-    kind: 'enum';
-    /**
-     * Name of the field and variable (e.g. language)
-     */
-    name: Types.FieldName;
-    /**
-     * Name of the TypeScript type of the field, e.g. Language
-     */
-    typeName: Types.TypeName;
-    /**
-     * Enum definition of the field.
-     */
-    enumerator: Enum;
-}>;
-/**
- * Definition of an enum, consisting of a name and a list of enum members.
- */
-export type Enum = {
-    name: Types.EnumName;
-    /**
-     * Description of the enum, ideally providing business background and detailed information
-     */
-    description?: string;
-    /**
-     * TypeScript type that should be used to reference an enumerator.
-     */
-    tsTypeName: Types.TypeName;
-    /**
-     * Object containing all optional attributes of the enum.
-     */
-    attributes: EnumAttributes;
-    /**
-     * Name of the enum as it appears in the source (e.g. in the Prisma file).
-     */
-    sourceName: string;
-    /**
-     * List of enum members, e.g. [EN, DE]
-     */
-    values: string[];
-    /**
-     * A global schema configuration.
-     */
-    schemaConfig: SchemaConfig;
-};

package/dist/lib/schema/schema.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFieldEnum = exports.isFieldRelation = exports.isFieldId = void 0;
-/**
- * Utility function to check if a field is an id field.
- */
-const isFieldId = (field) => field.kind === 'id';
-exports.isFieldId = isFieldId;
-/**
- * Utility function to check if a field is an relation field.
- */
-const isFieldRelation = (field) => field.kind === 'relation';
-exports.isFieldRelation = isFieldRelation;
-/**
- * Utility function to check if a field is an enum field.
- */
-const isFieldEnum = (field) => field.kind === 'enum';
-exports.isFieldEnum = isFieldEnum;

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

@@ -1,201 +0,0 @@
-/**
- * The name of a class, e.g. "AggregationRepository".
- */
-export type ClassName = string & {
-    readonly ___type: 'ClassName';
-};
-/**
- * Converts a raw string to a branded ClassName.
- */
-export declare const toClassName: (t: string) => ClassName;
-/**
- * Name of a "Discriminant" in a "Discriminated Union".
- *
- * (Background)[https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions]:
- * A "discriminated union" in TypeScript is a union type with a common, singleton type property — the discriminant.
- * E.g.:
- * ```ts
- * type Shape = Square | Rectangle | Circle
- * type Square = { kind: "square"; size: number }
- * type Rectangle = { kind: "rectangle"; width: number; height: number }
- * type Circle = { kind: "circle"; radius: number }
- * ```
- * In the above example, the `kind` property is the discriminant.
- */
-export type DiscriminantName = string & {
-    readonly ___type: 'DiscriminantName';
-};
-/**
- * Brands a raw string as a discriminant.
- */
-export declare const toDiscriminantName: (t: string) => DiscriminantName;
-/**
- * The name of a model, e.g. "Aggregation".
- */
-export type ModelName = string & {
-    readonly ___type: 'ModelName';
-};
-/**
- * Brands a raw string to a ModelName identifier.
- */
-export declare const toModelName: (t: string) => ModelName;
-/**
- * Name of a Typescript type, e.g. "Aggregation".
- */
-export type TypeName = string & {
-    readonly ___type: 'TypeName';
-};
-/**
- * Brands a raw string to a TypeScript Type identifier.
- */
-export declare const toTypeName: (t: string) => TypeName;
-/**
- * A TypeName that is annotated with the kind of the type.
- * Note: This is used when distinguishing between kinds is required at runtime.
- */
-export type AnnotatedTypeName = {
-    typeName: TypeName;
-    kind: 'TypeName';
-};
-/**
- * Converts a branded string to a branded TypeName.
- */
-export declare const toAnnotatedTypeName: (name: TypeName) => AnnotatedTypeName;
-/**
- * Type guard to check if a given type is an AnnotatedTypeName.
- */
-export declare const isAnnotatedTypeName: (t: string | AnnotatedTypeName) => t is AnnotatedTypeName;
-/**
- * The name of a model field, e.g. "name".
- */
-export type FieldName = string & {
-    readonly ___type: 'FieldName';
-};
-/**
- * Brands a raw string to an IdFieldName identifier.
- */
-export declare const ID_FIELD_NAME: IdFieldName;
-/**
- * The name of the id field. Must be `id`.
- */
-export type IdFieldName = 'id' & {
-    readonly ___type: 'FieldName';
-};
-/**
- * Brands a raw string to a FieldName identifier.
- */
-export declare const toFieldName: (t: string) => FieldName;
-/**
- * The name of an Enum, e.g. "Language".
- */
-export type EnumName = string & {
-    readonly ___type: 'EnumName';
-};
-/**
- * Brands a raw string to an EnumName identifier.
- */
-export declare const toEnumName: (t: string) => EnumName;
-/**
- * The name of a function (e.g. "toAggregation").
- */
-export type FunctionName = string & {
-    readonly ___type: 'FunctionName';
-};
-/**
- * Converts a string to a branded function name.
- */
-export declare const toFunctionName: (t: string) => FunctionName;
-/**
- * The name of a variable or a property in the generated code.
- */
-export type VariableName = string & {
-    readonly ___type: 'VariableName';
-};
-/**
- * Converts a string to a branded VariableName.
- */
-export declare const toVariableName: (t: string) => VariableName;
-/**
- * A name of the file without a file extension, e.g. "aggregation.type".
- */
-export type FileName = string & {
-    readonly ___type: 'FileName';
-};
-/**
- * Lets you brand a string value as a name of the file.
- *
- * NOTE: THIS SHOULD NOT BE A PATH!
- */
-export declare const toFileName: (t: string) => FileName;
-/**
- * A name of the folder without the trailing and leading slash (e.g. "aggregation").
- */
-export type FolderName = string & {
-    readonly ___type: 'FolderName';
-};
-/**
- * Converts a string to a branded FolderName.
- */
-export declare const toFolderName: (t: string) => FolderName;
-/**
- * A relative or absolute path to a file or folder.
- */
-export type FilePath = string & {
-    readonly ___type: 'FilePath';
-};
-/**
- * The combination of a file path and the import path to the file in a module.
- */
-export type ModuleLocation = {
-    /**
-     * The path to the file, e.g. `/backend/libs/update/src/update.module`.
-     */
-    path: FilePath;
-    /**
-     * The import path to the file, e.g. `@backend/update/update.module`.
-     */
-    import: BackendModulePath;
-};
-/**
- * Converts a absolute module file path and a module name to a concrete location.
- *
- * @example
- *
- * ```ts
- * toModuleLocation(`actions`, `./backend/libs/actions/src/dispatcher.service`)
- * //  {
- * //    path: '/backend/libs/actions/src/dispatcher.service',
- * //    import: '@backend/actions/dispatcher.service'
- * //  }
- * ```
- */
-export declare const toModuleLocation: (moduleName: string, absoluteFilePath: string) => ModuleLocation;
-/**
- * Converts a string to a branded BackendModulePath.
- */
-export declare const toBackendModulePath: (t: `@backend/${string}`) => BackendModulePath;
-/**
- * A relative or absolute path to a backend file or folder.
- */
-export type BackendModulePath = `@backend/${string}` & {
-    readonly ___type: 'BackendModulePath';
-};
-/**
- * Converts a string to a branded PAth.
- */
-export declare const toPath: (t: string) => FilePath;
-/**
- * The name of an NPM package (e.g. "@postxl/runtime").
- */
-export type PackageName = string & {
-    readonly ___type: 'PackageName';
-};
-export declare const toPackageName: (t: string) => PackageName;
-/**
- * Branded string values that can be used as import statement values in the generators
- */
-export type ImportableTypes = FunctionName | ClassName | TypeName | AnnotatedTypeName | VariableName | EnumName;
-/**
- * Branded string values that can be used as paths in import statements
- */
-export type ImportPaths = BackendModulePath | FilePath | PackageName;