ngx-material-entity 0.1.0 → 0.1.3

package/components/table/table-data.d.ts

@@ -11,64 +11,69 @@ export interface DisplayColumn<EntityType extends Entity> {
      */
     displayName: string;
     /**
-     * A method to get the value inside an row
+     * A method to get the value inside an row.
      */
     value: (entity: EntityType) => string;
 }
 /**
- * The Definition of an Action that can be run on multiple selected entities
+ * The Definition of an Action that can be run on multiple selected entities.
  */
 export interface MultiSelectAction<EntityType extends Entity> {
     /**
-     * The name of the action
+     * The name of the action.
      */
     displayName: string;
     /**
-     * The action itself
+     * The action itself.
      */
     action: (selectedEntities: EntityType[]) => unknown;
     /**
      * A method that defines whether or not the action can be used.
+     *
      * @default true
      */
     enabled?: (selectedEntities: EntityType[]) => boolean;
     /**
-     * A method that defines whether or not a confirm dialog is needed to run the action
+     * A method that defines whether or not a confirm dialog is needed to run the action.
+     *
      * @default false
      */
     requireConfirmDialog?: (selectedEntities: EntityType[]) => boolean;
     /**
-     * The data used to generate a confirmation dialog for the multiselect action.
+     * The data used to generate a confirmation dialog for the multiSelect action.
      */
     confirmDialogData?: ConfirmDialogData;
 }
+/**
+ * The base data of the ngx-mat-entity-table.
+ */
 export interface BaseData<EntityType extends Entity> {
     /**
-     * The title of the table
+     * The title of the table.
      */
     title: string;
     /**
      * The definition of the columns to display. Consists of the displayName to show in the header of the row
-     * and the value, which is a function that generates the value to display inside a column
+     * and the value, which is a function that generates the value to display inside a column.
      */
     displayColumns: DisplayColumn<EntityType>[];
     /**
-     * The label on the search bar. Defaults to "Search".
+     * The Class of the service that handles the entities.
+     * Needs to be injectable and an extension of the "EntityService"-Class.
      */
-    searchLabel?: string;
+    EntityServiceClass: new (httpClient: HttpClient) => EntityService<EntityType>;
     /**
-     * The label on the button for adding new entities. Defaults to "Create".
+     * The Class of the entities to manage.
      */
-    createButtonLabel?: string;
+    EntityClass?: new (entity?: EntityType) => EntityType;
     /**
-     * The Class of the entities to manage
+     * The label on the search bar. Defaults to "Search".
      */
-    EntityClass: new (entity?: EntityType) => EntityType;
+    searchLabel?: string;
     /**
-     * The Class of the service that handles the entities.
-     * Needs to be injectable and an extension of the "EntityService"-Class
+     * The label on the button for adding new entities. Defaults to "Create".
      */
-    EntityServiceClass: new (httpClient: HttpClient) => EntityService<EntityType>;
+    createButtonLabel?: string;
     /**
      * Takes a custom edit method which runs when you click on a entity.
      * If you don't need any special editing of entries you can also omit this.
@@ -84,24 +89,26 @@ export interface BaseData<EntityType extends Entity> {
     /**
      * Defines how the search string of entities is generated.
      */
-    searchString?: (enity: EntityType) => string;
+    searchString?: (entity: EntityType) => string;
     /**
      * Defines whether or not the user can add new entities.
+     *
      * @default true
      */
     allowCreate?: boolean;
     /**
      * Defines whether or not the user can edit entities.
+     *
      * @default () => true
      */
     allowEdit?: (entity: EntityType) => boolean;
     /**
-     * Whether or not the user can delete this specific entity
+     * Whether or not the user can delete this specific entity.
      */
     allowDelete?: (entity: EntityType) => boolean;
     /**
      * All Actions that you want to run on multiple entities can be defined here.
-     * (e.g. download as zip-file or mass delete)
+     * (e.g. Download as zip-file or mass delete).
      */
     multiSelectActions?: MultiSelectAction<EntityType>[];
     /**
@@ -109,11 +116,14 @@ export interface BaseData<EntityType extends Entity> {
      */
     multiSelectLabel?: string;
 }
+/**
+ * The data of the default create-dialog.
+ */
 export interface CreateDialogData {
     /**
      * The title of the default create-dialog.
      */
-    title: string;
+    title?: string;
     /**
      * The label on the create-button of the default create-dialog. Defaults to "Create".
      */
@@ -131,11 +141,14 @@ export interface CreateDialogData {
      */
     confirmCreateDialogData?: ConfirmDialogData;
 }
+/**
+ * The data of the default edit-dialog.
+ */
 export interface EditDialogData<EntityType extends Entity> {
     /**
      * The title of the default edit-dialog.
      */
-    title: (entity: EntityType) => string;
+    title?: (entity: EntityType) => string;
     /**
      * The label on the confirm-button of the default edit-dialog. Defaults to "Save".
      */
@@ -165,9 +178,12 @@ export interface EditDialogData<EntityType extends Entity> {
      */
     confirmEditDialogData?: ConfirmDialogData;
 }
-export interface EntitiesData<EntityType extends Entity> {
+/**
+ * All the configuration data required to display a ngx-mat-entity-table.
+ */
+export interface TableData<EntityType extends Entity> {
     /**
-     * The base data for the entities-component.
+     * The base data for the table-component.
      * Includes stuff like the title for the table, what to display inside the rows etc.
      */
     baseData: BaseData<EntityType>;

package/components/table/table.component.d.ts

@@ -5,15 +5,23 @@ import { MatTableDataSource } from '@angular/material/table';
 import { Entity } from '../../classes/entity-model.class';
 import { SelectionModel } from '@angular/cdk/collections';
 import { MatDialog } from '@angular/material/dialog';
-import { MultiSelectAction, EntitiesData } from './table-data';
+import { MultiSelectAction, TableData } from './table-data';
+import { TableDataInternal } from './table-data.builder';
 import * as i0 from "@angular/core";
+/**
+ * Generates a fully functional table for displaying, creating, updating and deleting entities
+ * based on the configuration passed in the @Input "tableData".
+ *
+ * It offers a lot of customization options which can be found in "TableData".
+ */
 export declare class NgxMatEntityTableComponent<EntityType extends Entity> implements OnInit, OnDestroy {
     private readonly dialog;
     private readonly injector;
     /**
-     * The configuration for the entities-component
+     * The configuration for the component.
      */
-    entitiesData: EntitiesData<EntityType>;
+    tableData: TableData<EntityType>;
+    data: TableDataInternal<EntityType>;
     private entityService;
     private readonly onDestroy;
     paginator: MatPaginator;
@@ -23,19 +31,58 @@ export declare class NgxMatEntityTableComponent<EntityType extends Entity> imple
     dataSource: MatTableDataSource<EntityType>;
     selection: SelectionModel<EntityType>;
     constructor(dialog: MatDialog, injector: Injector);
+    /**
+     * Sets up all the configuration for the table and the EntityService.
+     */
     ngOnInit(): void;
-    private validateInput;
+    /**
+     * Edits an entity. This either calls the edit-Method provided by the user or uses a default edit-dialog.
+     *
+     * @param entity - The entity that should be updated.
+     * @throws When no EntityClass was provided, as a new call is needed to initialize metadata.
+     */
     editEntity(entity: EntityType): void;
     private editDefault;
+    /**
+     * Creates a new Entity. This either calls the create-Method provided by the user or uses a default create-dialog.
+     *
+     * @throws When no EntityClass was provided, as a new call is needed to initialize metadata.
+     */
     createEntity(): void;
     private createDefault;
+    /**
+     * Runs the MultiAction for all selected entries.
+     * Also handles confirmation with an additional dialog if configured.
+     *
+     * @param action - The MultiAction to run.
+     */
     runMultiAction(action: MultiSelectAction<EntityType>): void;
     private confirmRunMultiAction;
+    /**
+     * Checks if an MultiAction is disabled (e.g. Because no entries have been selected).
+     *
+     * @param action - The MultiAction to check.
+     * @returns Whether or not the Action can be used.
+     */
     multiActionDisabled(action: MultiSelectAction<EntityType>): boolean;
+    /**
+     * Toggles all entries in the table.
+     */
     masterToggle(): void;
+    /**
+     * Checks if all entries in the table have been selected.
+     * This is needed to display the "masterToggle"-checkbox correctly.
+     *
+     * @returns Whether or not all entries in the table have been selected.
+     */
     isAllSelected(): boolean;
     ngOnDestroy(): void;
+    /**
+     * Applies the search input to filter the table entries.
+     *
+     * @param event - The keyup-event which contains the search-string of the user.
+     */
     applyFilter(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxMatEntityTableComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityTableComponent<any>, "ngx-mat-entity-table", never, { "entitiesData": "entitiesData"; }, {}, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityTableComponent<any>, "ngx-mat-entity-table", never, { "tableData": "tableData"; }, {}, never, never>;
 }

package/components/table/table.module.d.ts

@@ -10,8 +10,10 @@ import * as i8 from "@angular/material/paginator";
 import * as i9 from "@angular/material/button";
 import * as i10 from "@angular/material/menu";
 import * as i11 from "@angular/material/dialog";
+import * as i12 from "./create-dialog/create-entity-dialog.module";
+import * as i13 from "./edit-dialog/edit-entity-dialog.module";
 export declare class NgxMatEntityTableModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxMatEntityTableModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxMatEntityTableModule, [typeof i1.NgxMatEntityTableComponent], [typeof i2.CommonModule, typeof i3.MatInputModule, typeof i4.FormsModule, typeof i5.MatFormFieldModule, typeof i6.MatCheckboxModule, typeof i7.MatTableModule, typeof i8.MatPaginatorModule, typeof i9.MatButtonModule, typeof i10.MatMenuModule, typeof i11.MatDialogModule], [typeof i1.NgxMatEntityTableComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxMatEntityTableModule, [typeof i1.NgxMatEntityTableComponent], [typeof i2.CommonModule, typeof i3.MatInputModule, typeof i4.FormsModule, typeof i5.MatFormFieldModule, typeof i6.MatCheckboxModule, typeof i7.MatTableModule, typeof i8.MatPaginatorModule, typeof i9.MatButtonModule, typeof i10.MatMenuModule, typeof i11.MatDialogModule, typeof i12.NgxMatEntityCreateDialogModule, typeof i13.NgxMatEntityEditDialogModule], [typeof i1.NgxMatEntityTableComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<NgxMatEntityTableModule>;
 }

package/decorators/array/array-decorator-internal.data.d.ts

@@ -0,0 +1,45 @@
+import { Entity } from '../../classes/entity-model.class';
+import { CreateDialogData } from '../../components/table/table-data';
+import { DecoratorTypes } from '../base/decorator-types.enum';
+import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
+import { ArrayTableDisplayColumn, AutocompleteStringChipsArrayDecoratorConfig, EntityArrayDecoratorConfig, StringChipsArrayDecoratorConfig } from './array-decorator.data';
+/**
+ * The internal EntityArrayDecoratorConfig. Sets default values.
+ */
+export declare class EntityArrayDecoratorConfigInternal<EntityType extends Entity> extends PropertyDecoratorConfigInternal implements EntityArrayDecoratorConfig<EntityType> {
+    itemType: DecoratorTypes.OBJECT;
+    displayStyle: 'table';
+    EntityClass: new (entity?: EntityType) => EntityType;
+    displayColumns: ArrayTableDisplayColumn<EntityType>[];
+    createDialogData?: CreateDialogData;
+    createInline: boolean;
+    missingErrorMessage: string;
+    addButtonLabel: string;
+    removeButtonLabel: string;
+    constructor(data: EntityArrayDecoratorConfig<EntityType>);
+}
+/**
+ * The internal StringChipsArrayDecoratorConfig. Sets default values.
+ */
+export declare class StringChipsArrayDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements StringChipsArrayDecoratorConfig {
+    itemType: DecoratorTypes.STRING;
+    displayStyle: 'chips';
+    deleteIcon: string;
+    minLength?: number;
+    maxLength?: number;
+    regex?: RegExp;
+    constructor(data: StringChipsArrayDecoratorConfig);
+}
+/**
+ * The internal AutocompleteStringChipsArrayDecoratorConfig. Sets default values.
+ */
+export declare class AutocompleteStringChipsArrayDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements AutocompleteStringChipsArrayDecoratorConfig {
+    autocompleteValues: string[];
+    itemType: DecoratorTypes.STRING_AUTOCOMPLETE;
+    displayStyle: 'chips';
+    deleteIcon: string;
+    minLength?: number;
+    maxLength?: number;
+    regex?: RegExp;
+    constructor(data: AutocompleteStringChipsArrayDecoratorConfig);
+}

package/decorators/array/array-decorator.data.d.ts

@@ -0,0 +1,129 @@
+import { Entity } from '../../classes/entity-model.class';
+import { CreateDialogData } from '../../components/table/table-data';
+import { DecoratorTypes } from '../base/decorator-types.enum';
+import { PropertyDecoratorConfig } from '../base/property-decorator.data';
+/**
+ * The configuration options for an array property displayed as a table.
+ */
+export interface ArrayTableDisplayColumn<EntityType extends Entity> {
+    /**
+     * The name inside the header.
+     */
+    displayName: string;
+    /**
+     * A method to get the value inside an row.
+     */
+    value: (entity: EntityType) => string;
+}
+/**
+ * Interface definition for the @array metadata.
+ */
+declare abstract class ArrayDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * How to display the string.
+     */
+    displayStyle: 'table' | 'chips';
+    /**
+     * The type of the items inside the array.
+     */
+    itemType: DecoratorTypes;
+}
+/**
+ * Definition for an array of Entities.
+ */
+export interface EntityArrayDecoratorConfig<EntityType extends Entity> extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.OBJECT;
+    displayStyle: 'table';
+    /**
+     * The EntityClass used for generating the create inputs.
+     */
+    EntityClass: new (entity?: EntityType) => EntityType;
+    /**
+     * The definition of the columns to display. Consists of the displayName to show in the header of the row
+     * and the value, which is a function that generates the value to display inside a column.
+     */
+    displayColumns: ArrayTableDisplayColumn<EntityType>[];
+    /**
+     * The data for the add-item-dialog.
+     * Can be omitted when adding items inline.
+     */
+    createDialogData?: CreateDialogData;
+    /**
+     * Whether or not the form for adding items to the array
+     * should be displayed inline.
+     *
+     * @default true
+     */
+    createInline?: boolean;
+    /**
+     * The label for the add button when createInline is true.
+     *
+     * @default 'Add'
+     */
+    addButtonLabel?: string;
+    /**
+     * The label for the remove button when createInline is true.
+     *
+     * @default 'Remove'
+     */
+    removeButtonLabel?: string;
+    /**
+     * The error-message to display when the array is required but contains no values.
+     */
+    missingErrorMessage?: string;
+}
+/**
+ * Definition for an array of strings displayed as a chips list.
+ */
+export interface StringChipsArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.STRING;
+    displayStyle: 'chips';
+    /**
+     * The class for the <i> tag used to remove an entry from the array.
+     *
+     * @default 'fas fa-circle-minus'
+     */
+    deleteIcon?: string;
+    /**
+     * The minimum required length of the string.
+     */
+    minLength?: number;
+    /**
+     * The maximum required length of the string.
+     */
+    maxLength?: number;
+    /**
+     * A regex used for validation.
+     */
+    regex?: RegExp;
+}
+/**
+ * Definition for an array of autocomplete strings displayed as a chips list.
+ */
+export interface AutocompleteStringChipsArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.STRING_AUTOCOMPLETE;
+    displayStyle: 'chips';
+    /**
+     * The class for the <i> tag used to remove an entry from the array.
+     *
+     * @default 'fas fa-circle-minus'
+     */
+    deleteIcon?: string;
+    /**
+     * The autocomplete values.
+     */
+    autocompleteValues: string[];
+    /**
+     * The minimum required length of the string.
+     */
+    minLength?: number;
+    /**
+     * The maximum required length of the string.
+     */
+    maxLength?: number;
+    /**
+     * A regex used for validation.
+     */
+    regex?: RegExp;
+}
+export {};

package/decorators/array/array.decorator.d.ts

@@ -0,0 +1,10 @@
+import { Entity } from '../../classes/entity-model.class';
+import { AutocompleteStringChipsArrayDecoratorConfig, EntityArrayDecoratorConfig, StringChipsArrayDecoratorConfig } from './array-decorator.data';
+/**
+ * Decorator for setting and getting array property metadata.
+ *
+ * @param metadata - The metadata of the array property.
+ * @returns The method that defines the metadata.
+ * @throws When the given type of the array-items is unknown.
+ */
+export declare function array<EntityType extends Entity>(metadata: EntityArrayDecoratorConfig<EntityType> | StringChipsArrayDecoratorConfig | AutocompleteStringChipsArrayDecoratorConfig): (target: object, propertyKey: string) => void;

package/decorators/base/base-property.decorator.d.ts

@@ -1,9 +1,10 @@
 import { DecoratorTypes } from './decorator-types.enum';
-import { PropertyDecoratorConfig } from './property-decorator-config.interface';
+import { PropertyDecoratorConfigInternal } from './property-decorator-internal.data';
 /**
- * The base decorator for setting metadata on properties
- * @param metadata The metadata to define
- * @param type The type of metadata
- * @returns The function that sets the metadata
+ * The base decorator for setting metadata on properties.
+ *
+ * @param metadata - The metadata to define.
+ * @param type - The type of metadata.
+ * @returns The method that sets the metadata.
  */
-export declare function baseProperty(metadata: PropertyDecoratorConfig, type: DecoratorTypes): (target: object, propertyKey: string) => void;
+export declare function baseProperty(metadata: PropertyDecoratorConfigInternal, type: DecoratorTypes): (target: object, propertyKey: string) => void;

package/decorators/base/decorator-types.enum.d.ts

@@ -1,9 +1,9 @@
-import { StringChipsArrayDecoratorConfig, EntityArrayDecoratorConfig, AutocompleteStringChipsArrayDecoratorConfig } from '../array.decorator';
 import { Entity } from '../../classes/entity-model.class';
-import { CheckboxBooleanDecoratorConfig, DropdownBooleanDecoratorConfig } from '../boolean.decorator';
-import { DefaultNumberDecoratorConfig, DropdownNumberDecoratorConfig } from '../number.decorator';
-import { DefaultObjectDecoratorConfig } from '../object.decorator';
-import { DefaultStringDecoratorConfig, DropdownStringDecoratorConfig, AutocompleteStringDecoratorConfig, TextboxStringDecoratorConfig } from '../string.decorator';
+import { AutocompleteStringChipsArrayDecoratorConfigInternal, EntityArrayDecoratorConfigInternal, StringChipsArrayDecoratorConfigInternal } from '../array/array-decorator-internal.data';
+import { CheckboxBooleanDecoratorConfigInternal, DropdownBooleanDecoratorConfigInternal, ToggleBooleanDecoratorConfigInternal } from '../boolean/boolean-decorator-internal.data';
+import { DefaultNumberDecoratorConfigInternal, DropdownNumberDecoratorConfigInternal } from '../number/number-decorator-internal.data';
+import { DefaultObjectDecoratorConfigInternal } from '../object/object-decorator-internal.data';
+import { AutocompleteStringDecoratorConfigInternal, DefaultStringDecoratorConfigInternal, DropdownStringDecoratorConfigInternal, TextboxStringDecoratorConfigInternal } from '../string/string-decorator-internal.data';
 /**
  * The enum Values for all the different DecoratorTypes.
  */
@@ -23,6 +23,6 @@ export declare enum DecoratorTypes {
     ARRAY_STRING_AUTOCOMPLETE_CHIPS = "arrayStringAutocompleteChips"
 }
 /**
- * Gives the metadata-config Type based ont the DecoratorTypes enum
+ * Gives the metadata-config Type based on the DecoratorTypes enum.
  */
-export declare type DecoratorType<T> = T extends DecoratorTypes.STRING ? DefaultStringDecoratorConfig : T extends DecoratorTypes.STRING_TEXTBOX ? TextboxStringDecoratorConfig : T extends DecoratorTypes.STRING_DROPDOWN ? DropdownStringDecoratorConfig : T extends DecoratorTypes.STRING_AUTOCOMPLETE ? AutocompleteStringDecoratorConfig : T extends DecoratorTypes.NUMBER ? DefaultNumberDecoratorConfig : T extends DecoratorTypes.NUMBER_DROPDOWN ? DropdownNumberDecoratorConfig : T extends DecoratorTypes.BOOLEAN_CHECKBOX ? CheckboxBooleanDecoratorConfig : T extends DecoratorTypes.BOOLEAN_TOGGLE ? CheckboxBooleanDecoratorConfig : T extends DecoratorTypes.BOOLEAN_DROPDOWN ? DropdownBooleanDecoratorConfig : T extends DecoratorTypes.OBJECT ? DefaultObjectDecoratorConfig : T extends DecoratorTypes.ARRAY ? EntityArrayDecoratorConfig<Entity> : T extends DecoratorTypes.ARRAY_STRING_CHIPS ? StringChipsArrayDecoratorConfig : T extends DecoratorTypes.ARRAY_STRING_AUTOCOMPLETE_CHIPS ? AutocompleteStringChipsArrayDecoratorConfig : never;
+export declare type DecoratorType<T> = T extends DecoratorTypes.STRING ? DefaultStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_TEXTBOX ? TextboxStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_DROPDOWN ? DropdownStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_AUTOCOMPLETE ? AutocompleteStringDecoratorConfigInternal : T extends DecoratorTypes.NUMBER ? DefaultNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_DROPDOWN ? DropdownNumberDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_CHECKBOX ? CheckboxBooleanDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_TOGGLE ? ToggleBooleanDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_DROPDOWN ? DropdownBooleanDecoratorConfigInternal : T extends DecoratorTypes.OBJECT ? DefaultObjectDecoratorConfigInternal<Entity> : T extends DecoratorTypes.ARRAY ? EntityArrayDecoratorConfigInternal<Entity> : T extends DecoratorTypes.ARRAY_STRING_CHIPS ? StringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_AUTOCOMPLETE_CHIPS ? AutocompleteStringChipsArrayDecoratorConfigInternal : never;

package/decorators/base/property-decorator-internal.data.d.ts

@@ -0,0 +1,24 @@
+import { Col, Position, PropertyDecoratorConfig } from './property-decorator.data';
+/**
+ * The internal Position. Sets default values and validates user input.
+ */
+declare class PositionInternal implements Position {
+    row: number;
+    order: number;
+    constructor(data?: Position);
+    private validateInput;
+}
+/**
+ * The internal PropertyDecoratorConfig. Sets default values.
+ */
+export declare abstract class PropertyDecoratorConfigInternal implements PropertyDecoratorConfig {
+    display: boolean;
+    displayName: string;
+    required: boolean;
+    omitForCreate: boolean;
+    omitForUpdate: boolean;
+    defaultWidths: [Col, Col, Col];
+    position: PositionInternal;
+    constructor(data: PropertyDecoratorConfig);
+}
+export {};

package/decorators/base/property-decorator.data.d.ts

@@ -0,0 +1,70 @@
+/**
+ * A bootstrap column value (a range from 1 - 12).
+ */
+export declare type Col = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+/**
+ * The base options for all propertyDecorators.
+ */
+export declare abstract class PropertyDecoratorConfig {
+    /**
+     * Whether or not the Property is displayed at all.
+     *
+     * @default true
+     */
+    display?: boolean;
+    /**
+     * The name of the property used as a label for form fields.
+     */
+    displayName: string;
+    /**
+     * Whether or not the Property is required.
+     *
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * Whether or not the property gets omitted when creating new Entities.
+     *
+     * @default false
+     */
+    omitForCreate?: boolean;
+    /**
+     * Whether or not the property gets omitted when updating Entities.
+     *
+     * @default false
+     */
+    omitForUpdate?: boolean;
+    /**
+     * Defines the width of the input property when used inside the default create or edit dialog.
+     * Has 3 bootstrap values for different breakpoints for simple responsive design.
+     * The first value sets the columns for the screen size lg, the second for md and the third for sm.
+     *
+     * @default [6, 6, 12]
+     */
+    defaultWidths?: [Col, Col, Col];
+    /**
+     * Specifies the how to position this property when using default create/edit dialogs.
+     *
+     * @default { row: -1,  order: -1} (Adds the property at the end)
+     */
+    position?: Position;
+}
+/**
+ * The options for positioning a property when using default create/edit dialogs.
+ */
+export interface Position {
+    /**
+     * Specifies the (bootstrap)-row in which this property is displayed.
+     * Ordering is ascending.
+     *
+     * @default -1 (sets this property after the last row)
+     */
+    row?: number;
+    /**
+     * Specifies order of the input property inside the specified row.
+     * Ordering is ascending.
+     *
+     * @default -1 (sets this property at the end of the row)
+     */
+    order?: number;
+}

package/decorators/boolean/boolean-decorator-internal.data.d.ts

@@ -0,0 +1,25 @@
+import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
+import { CheckboxBooleanDecoratorConfig, DropdownBooleanDecoratorConfig, ToggleBooleanDecoratorConfig } from './boolean-decorator.data';
+/**
+ * The internal DropdownBooleanDecoratorConfig. Sets default values.
+ */
+export declare class DropdownBooleanDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DropdownBooleanDecoratorConfig {
+    displayStyle: 'dropdown';
+    dropdownTrue: string;
+    dropdownFalse: string;
+    constructor(data: DropdownBooleanDecoratorConfig);
+}
+/**
+ * The internal CheckboxBooleanDecoratorConfig. Sets default values.
+ */
+export declare class CheckboxBooleanDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements CheckboxBooleanDecoratorConfig {
+    displayStyle: 'checkbox';
+    constructor(data: CheckboxBooleanDecoratorConfig);
+}
+/**
+ * The internal ToggleBooleanDecoratorConfig. Sets default values.
+ */
+export declare class ToggleBooleanDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements ToggleBooleanDecoratorConfig {
+    displayStyle: 'toggle';
+    constructor(data: ToggleBooleanDecoratorConfig);
+}

package/decorators/boolean/boolean-decorator.data.d.ts

@@ -0,0 +1,37 @@
+import { PropertyDecoratorConfig } from '../base/property-decorator.data';
+/**
+ * The Definition for the @boolean metadata.
+ */
+declare abstract class BooleanDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * Whether to display the booleans as a checkbox, a toggle button or as a dropdown.
+     */
+    displayStyle: 'checkbox' | 'dropdown' | 'toggle';
+}
+/**
+ * The configuration options for a boolean property displayed in a dropdown.
+ */
+export interface DropdownBooleanDecoratorConfig extends BooleanDecoratorConfig {
+    displayStyle: 'dropdown';
+    /**
+     * The name of the true value if displayStyle dropdown is used.
+     */
+    dropdownTrue: string;
+    /**
+     * The name of the false value if displayStyle dropdown is used.
+     */
+    dropdownFalse: string;
+}
+/**
+ * The configuration options for a boolean property displayed as a checkbox.
+ */
+export interface CheckboxBooleanDecoratorConfig extends BooleanDecoratorConfig {
+    displayStyle: 'checkbox';
+}
+/**
+ * The configuration options for a boolean property displayed as a mat-toggle.
+ */
+export interface ToggleBooleanDecoratorConfig extends BooleanDecoratorConfig {
+    displayStyle: 'toggle';
+}
+export {};

package/decorators/boolean/boolean.decorator.d.ts

@@ -0,0 +1,8 @@
+import { CheckboxBooleanDecoratorConfig, DropdownBooleanDecoratorConfig, ToggleBooleanDecoratorConfig } from './boolean-decorator.data';
+/**
+ * Decorator for setting and getting boolean property metadata.
+ *
+ * @param metadata - The metadata of the boolean property.
+ * @returns The method that defines the metadata.
+ */
+export declare function boolean(metadata: CheckboxBooleanDecoratorConfig | ToggleBooleanDecoratorConfig | DropdownBooleanDecoratorConfig): (target: object, propertyKey: string) => void;