ngx-material-entity 0.1.0

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

@@ -0,0 +1,184 @@
+import { HttpClient } from '@angular/common/http';
+import { Entity } from '../../classes/entity-model.class';
+import { EntityService } from '../../classes/entity-service.class';
+import { ConfirmDialogData } from '../confirm-dialog/confirm-dialog-data';
+/**
+ * The Definition of a Column inside the table.
+ */
+export interface DisplayColumn<EntityType extends Entity> {
+    /**
+     * The name inside the header.
+     */
+    displayName: string;
+    /**
+     * 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
+ */
+export interface MultiSelectAction<EntityType extends Entity> {
+    /**
+     * The name of the action
+     */
+    displayName: string;
+    /**
+     * 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
+     * @default false
+     */
+    requireConfirmDialog?: (selectedEntities: EntityType[]) => boolean;
+    /**
+     * The data used to generate a confirmation dialog for the multiselect action.
+     */
+    confirmDialogData?: ConfirmDialogData;
+}
+export interface BaseData<EntityType extends Entity> {
+    /**
+     * 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
+     */
+    displayColumns: DisplayColumn<EntityType>[];
+    /**
+     * The label on the search bar. Defaults to "Search".
+     */
+    searchLabel?: string;
+    /**
+     * The label on the button for adding new entities. Defaults to "Create".
+     */
+    createButtonLabel?: string;
+    /**
+     * The Class of the entities to manage
+     */
+    EntityClass: new (entity?: EntityType) => EntityType;
+    /**
+     * The Class of the service that handles the entities.
+     * Needs to be injectable and an extension of the "EntityService"-Class
+     */
+    EntityServiceClass: new (httpClient: HttpClient) => EntityService<EntityType>;
+    /**
+     * 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.
+     * In that case a default edit dialog is generated.
+     */
+    edit?: (entity: EntityType) => unknown;
+    /**
+     * Takes a method to run when you click on the new button.
+     * If you don't need anything special you can also omit this.
+     * In that case a default create dialog is generated.
+     */
+    create?: (entity: EntityType) => unknown;
+    /**
+     * Defines how the search string of entities is generated.
+     */
+    searchString?: (enity: 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
+     */
+    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)
+     */
+    multiSelectActions?: MultiSelectAction<EntityType>[];
+    /**
+     * The Label for the button that opens all multi-actions.
+     */
+    multiSelectLabel?: string;
+}
+export interface CreateDialogData {
+    /**
+     * The title of the default create-dialog.
+     */
+    title: string;
+    /**
+     * The label on the create-button of the default create-dialog. Defaults to "Create".
+     */
+    createButtonLabel?: string;
+    /**
+     * The label on the cancel-button for the default create-dialog. Defaults to "Cancel".
+     */
+    cancelButtonLabel?: string;
+    /**
+     * Whether or not the creation of an entry should require a confirm dialog.
+     */
+    createRequiresConfirmDialog?: boolean;
+    /**
+     * The data used to generate a confirmation dialog for the create action.
+     */
+    confirmCreateDialogData?: ConfirmDialogData;
+}
+export interface EditDialogData<EntityType extends Entity> {
+    /**
+     * The title of the default edit-dialog.
+     */
+    title: (entity: EntityType) => string;
+    /**
+     * The label on the confirm-button of the default edit-dialog. Defaults to "Save".
+     */
+    confirmButtonLabel?: string;
+    /**
+     * The label on the delete-button of the default edit-dialog. Defaults to "Delete".
+     */
+    deleteButtonLabel?: string;
+    /**
+     * The label on the cancel-button for the default edit-dialog. Defaults to "Cancel".
+     */
+    cancelButtonLabel?: string;
+    /**
+     * Whether or not the deletion of an entry should require a confirm dialog.
+     */
+    deleteRequiresConfirmDialog?: boolean;
+    /**
+     * Whether or not the editing of an entry should require a confirm dialog.
+     */
+    editRequiresConfirmDialog?: boolean;
+    /**
+     * The data used to generate a confirmation dialog for the delete action.
+     */
+    confirmDeleteDialogData?: ConfirmDialogData;
+    /**
+     * The data used to generate a confirmation dialog for the delete action.
+     */
+    confirmEditDialogData?: ConfirmDialogData;
+}
+export interface EntitiesData<EntityType extends Entity> {
+    /**
+     * The base data for the entities-component.
+     * Includes stuff like the title for the table, what to display inside the rows etc.
+     */
+    baseData: BaseData<EntityType>;
+    /**
+     * The data for the default create-dialog.
+     * Can be omitted when specifying a custom "create" method inside the baseData.
+     */
+    createDialogData?: CreateDialogData;
+    /**
+     * The data for the default edit-dialog.
+     * Can be omitted when specifying a custom "edit" method inside the baseData.
+     */
+    editDialogData?: EditDialogData<EntityType>;
+}

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

@@ -0,0 +1,41 @@
+import { Injector, OnDestroy, OnInit } from '@angular/core';
+import { MatPaginator } from '@angular/material/paginator';
+import { MatSort } from '@angular/material/sort';
+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 * as i0 from "@angular/core";
+export declare class NgxMatEntityTableComponent<EntityType extends Entity> implements OnInit, OnDestroy {
+    private readonly dialog;
+    private readonly injector;
+    /**
+     * The configuration for the entities-component
+     */
+    entitiesData: EntitiesData<EntityType>;
+    private entityService;
+    private readonly onDestroy;
+    paginator: MatPaginator;
+    sort: MatSort;
+    filter: string;
+    displayedColumns: string[];
+    dataSource: MatTableDataSource<EntityType>;
+    selection: SelectionModel<EntityType>;
+    constructor(dialog: MatDialog, injector: Injector);
+    ngOnInit(): void;
+    private validateInput;
+    editEntity(entity: EntityType): void;
+    private editDefault;
+    createEntity(): void;
+    private createDefault;
+    runMultiAction(action: MultiSelectAction<EntityType>): void;
+    private confirmRunMultiAction;
+    multiActionDisabled(action: MultiSelectAction<EntityType>): boolean;
+    masterToggle(): void;
+    isAllSelected(): boolean;
+    ngOnDestroy(): void;
+    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>;
+}

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

@@ -0,0 +1,17 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./table.component";
+import * as i2 from "@angular/common";
+import * as i3 from "@angular/material/input";
+import * as i4 from "@angular/forms";
+import * as i5 from "@angular/material/form-field";
+import * as i6 from "@angular/material/checkbox";
+import * as i7 from "@angular/material/table";
+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";
+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 ɵinj: i0.ɵɵInjectorDeclaration<NgxMatEntityTableModule>;
+}

package/decorators/array.decorator.d.ts

@@ -0,0 +1,125 @@
+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-config.interface';
+/**
+ * Decorator for setting and getting array propery metadata
+ * @param metadata The metadata of the array property
+ */
+export declare function array<EntityType extends Entity>(metadata: EntityArrayDecoratorConfig<EntityType> | StringChipsArrayDecoratorConfig | AutocompleteStringChipsArrayDecoratorConfig): (target: object, propertyKey: string) => void;
+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;
+    /**
+     * The error-message to display when the array is required but contains no values
+     */
+    missingErrorMessage?: string;
+}
+/**
+ * Definition for an array of Entities
+ */
+export declare class 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;
+    constructor(metadata: EntityArrayDecoratorConfig<EntityType>);
+}
+/**
+ * Definition for an array of strings displayed as a chips list
+ */
+export declare class StringChipsArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.STRING;
+    displayStyle: 'chips';
+    /**
+     * The html inside the delete-button.
+     * Please note that custom tags such as <mat-icon></mat-icon>
+     * need to be defined as known elements, otherwise the sanitizer will remove them.
+     * You can however work around this by using `<span class="material-icons"></span>`
+     * @default <mat-icon>cancel</mat-icon>
+     */
+    deleteHtml?: string;
+    /**
+     * (optional) The minimum required length of the string
+     */
+    minLength?: number;
+    /**
+     * (optional) The maximum required length of the string
+     */
+    maxLength?: number;
+    /**
+     * (optional) A regex used for validation
+     */
+    regex?: RegExp;
+    constructor(metadata: StringChipsArrayDecoratorConfig);
+}
+/**
+ * Definition for an array of autocomplete strings displayed as a chips list
+ */
+export declare class AutocompleteStringChipsArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.STRING_AUTOCOMPLETE;
+    displayStyle: 'chips';
+    /**
+     * The html inside the delete-button.
+     * Please note that custom tags such as <mat-icon></mat-icon>
+     * need to be defined as known elements, otherwise the sanitizer will remove them.
+     * You can however work around this by using `<span class="material-icons"></span>`
+     * @default <mat-icon>cancel</mat-icon>
+     */
+    deleteHtml?: string;
+    /**
+     * The autocomplete values
+     */
+    autocompleteValues: string[];
+    /**
+     * (optional) The minimum required length of the string
+     */
+    minLength?: number;
+    /**
+     * (optional) The maximum required length of the string
+     */
+    maxLength?: number;
+    /**
+     * (optional) A regex used for validation
+     */
+    regex?: RegExp;
+    constructor(metadata: AutocompleteStringChipsArrayDecoratorConfig);
+}
+export {};

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

@@ -0,0 +1,9 @@
+import { DecoratorTypes } from './decorator-types.enum';
+import { PropertyDecoratorConfig } from './property-decorator-config.interface';
+/**
+ * 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
+ */
+export declare function baseProperty(metadata: PropertyDecoratorConfig, type: DecoratorTypes): (target: object, propertyKey: string) => void;

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

@@ -0,0 +1,28 @@
+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';
+/**
+ * The enum Values for all the different DecoratorTypes.
+ */
+export declare enum DecoratorTypes {
+    STRING = "string",
+    STRING_DROPDOWN = "stringDropdown",
+    STRING_AUTOCOMPLETE = "stringAutocomplete",
+    STRING_TEXTBOX = "stringTextbox",
+    NUMBER = "number",
+    NUMBER_DROPDOWN = "numberDropdown",
+    BOOLEAN_CHECKBOX = "boolean",
+    BOOLEAN_TOGGLE = "booleanToggle",
+    BOOLEAN_DROPDOWN = "booleanDropdown",
+    OBJECT = "object",
+    ARRAY = "array",
+    ARRAY_STRING_CHIPS = "arrayStringChips",
+    ARRAY_STRING_AUTOCOMPLETE_CHIPS = "arrayStringAutocompleteChips"
+}
+/**
+ * Gives the metadata-config Type based ont 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;

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

@@ -0,0 +1,50 @@
+declare type cols = 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.
+     * @var firstValue: col-lg-{{firstValue}}
+     * @var secondValue: col-md-{{secondValue}}
+     * @var thirdValue: col-sm-{{thirdValue}}
+     */
+    defaultWidths?: [cols, cols, cols];
+    /**
+     * Specifies order of the input property when used inside the default create or edit dialog.
+     * Ordering is ascending
+     * @default -1 (sets this property at the end)
+     */
+    order?: number;
+    /**
+     * Defines, Whether or not there should be a line break after this input.
+     * Is used inside the default create and edit dialogs.
+     */
+    constructor(displayName: string, display?: boolean, required?: boolean, omitForCreate?: boolean, omitForUpdate?: boolean, defaultWidths?: [cols, cols, cols], order?: number);
+}
+export {};

package/decorators/boolean.decorator.d.ts

@@ -0,0 +1,42 @@
+import { PropertyDecoratorConfig } from './base/property-decorator-config.interface';
+/**
+ * Decorator for setting and getting string propery metadata
+ * @param metadata The metadata of the string property
+ */
+export declare function boolean(metadata: CheckboxBooleanDecoratorConfig | ToggleBooleanDecoratorConfig | DropdownBooleanDecoratorConfig): (target: object, propertyKey: string) => void;
+/**
+ * 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';
+}
+export declare class DropdownBooleanDecoratorConfig extends BooleanDecoratorConfig {
+    displayStyle: 'dropdown';
+    /**
+     * The name of the true value if displayStyle dropdown is used.
+     * Can also receive a function to determine the name.
+     */
+    dropdownTrue: string | {
+        (args: unknown): string;
+    };
+    /**
+     * The name of the false value if displayStyle dropdown is used.
+     * Can also receive a function to determine the name,
+     */
+    dropdownFalse: string | {
+        (args: unknown): string;
+    };
+    constructor(metadata: DropdownBooleanDecoratorConfig);
+}
+export declare class CheckboxBooleanDecoratorConfig extends BooleanDecoratorConfig {
+    displayStyle: 'checkbox';
+    constructor(metadata: CheckboxBooleanDecoratorConfig);
+}
+export declare class ToggleBooleanDecoratorConfig extends BooleanDecoratorConfig {
+    displayStyle: 'toggle';
+    constructor(metadata: ToggleBooleanDecoratorConfig);
+}
+export {};

package/decorators/number.decorator.d.ts

@@ -0,0 +1,40 @@
+import { PropertyDecoratorConfig } from './base/property-decorator-config.interface';
+/**
+ * Decorator for setting and getting string propery metadata
+ * @param metadata The metadata of the string property
+ */
+export declare function number(metadata: DefaultNumberDecoratorConfig | DropdownNumberDecoratorConfig): (target: object, propertyKey: string) => void;
+/**
+ * Interface definition for the @number metadata
+ */
+declare abstract class NumberDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * Whether to display the number in a single line or as a dropdown
+     */
+    displayStyle: 'line' | 'dropdown';
+}
+export declare class DefaultNumberDecoratorConfig extends NumberDecoratorConfig {
+    displayStyle: 'line';
+    /**
+     * (optional) The minimum value of the number
+     */
+    min?: number;
+    /**
+     * (optional) The maximum value of the number
+     */
+    max?: number;
+    constructor(metadata: DefaultNumberDecoratorConfig);
+}
+export declare class DropdownNumberDecoratorConfig extends NumberDecoratorConfig {
+    displayStyle: 'dropdown';
+    /**
+     * The values of the dropdown, consisting of a name to display and the actual value
+     * Can also receive a function to determine the values
+     */
+    dropdownValues?: {
+        displayName: string;
+        value: number;
+    }[];
+    constructor(metadata: DropdownNumberDecoratorConfig);
+}
+export {};

package/decorators/object.decorator.d.ts

@@ -0,0 +1,27 @@
+import { PropertyDecoratorConfig } from './base/property-decorator-config.interface';
+import { Entity } from '../classes/entity-model.class';
+/**
+ * Decorator for setting and getting object propery metadata.
+ * @param metadata The metadata of the object property
+ */
+export declare function object(metadata: DefaultObjectDecoratorConfig): (target: object, propertyKey: string) => void;
+/**
+ * Interface definition for the @object metadata
+ */
+declare abstract class ObjectDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * The entity type of the object
+     */
+    type: typeof Entity;
+    /**
+     * How to display the object.
+     * @inline The objects properties are added as input fields in an section of the entity.
+     * Useful if the object only contains a few properties (e.g. a address on a user).
+     */
+    displayStyle: 'inline';
+}
+export declare class DefaultObjectDecoratorConfig extends ObjectDecoratorConfig {
+    displayStyle: 'inline';
+    constructor(metadata: DefaultObjectDecoratorConfig);
+}
+export {};

package/decorators/string.decorator.d.ts

@@ -0,0 +1,76 @@
+import { PropertyDecoratorConfig } from './base/property-decorator-config.interface';
+/**
+ * Decorator for setting and getting string propery metadata
+ * @param metadata The metadata of the string property
+ */
+export declare function string(metadata: DropdownStringDecoratorConfig | AutocompleteStringDecoratorConfig | DefaultStringDecoratorConfig | TextboxStringDecoratorConfig): (target: object, propertyKey: string) => void;
+/**
+ * Interface definition for the @string metadata
+ */
+declare abstract class StringDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * How to display the string
+     */
+    displayStyle: 'line' | 'textbox' | 'autocomplete' | 'dropdown';
+}
+export declare class DropdownStringDecoratorConfig extends StringDecoratorConfig {
+    displayStyle: 'dropdown';
+    /**
+     * The values of the dropdown, consisting of a name to display and the actual value
+     * Can also receive a function to determine the values
+     */
+    dropdownValues: {
+        displayName: string;
+        value: string;
+    }[];
+    constructor(metadata: DropdownStringDecoratorConfig);
+}
+export declare class DefaultStringDecoratorConfig extends StringDecoratorConfig {
+    displayStyle: 'line';
+    /**
+     * (optional) The minimum required length of the string
+     */
+    minLength?: number;
+    /**
+     * (optional) The maximum required length of the string
+     */
+    maxLength?: number;
+    /**
+     * (optional) A regex used for validation
+     */
+    regex?: RegExp;
+    constructor(metadata: DefaultStringDecoratorConfig);
+}
+export declare class TextboxStringDecoratorConfig extends StringDecoratorConfig {
+    displayStyle: 'textbox';
+    /**
+     * (optional) The minimum required length of the string
+     */
+    minLength?: number;
+    /**
+     * (optional) The maximum required length of the string
+     */
+    maxLength?: number;
+    constructor(metadata: TextboxStringDecoratorConfig);
+}
+export declare class AutocompleteStringDecoratorConfig extends StringDecoratorConfig {
+    displayStyle: 'autocomplete';
+    /**
+     * The autocomplete values
+     */
+    autocompleteValues: string[];
+    /**
+     * (optional) The minimum required length of the string
+     */
+    minLength?: number;
+    /**
+     * (optional) The maximum required length of the string
+     */
+    maxLength?: number;
+    /**
+     * (optional) A regex used for validation
+     */
+    regex?: RegExp;
+    constructor(metadata: AutocompleteStringDecoratorConfig);
+}
+export {};

package/esm2020/classes/entity-model.class.mjs

@@ -0,0 +1,19 @@
+import { __decorate, __metadata } from "tslib";
+import { string } from '../decorators/string.decorator';
+/**
+ * The base Entity class.
+ */
+export class Entity {
+}
+__decorate([
+    string({
+        omitForCreate: true,
+        omitForUpdate: true,
+        display: false,
+        displayStyle: 'line',
+        displayName: 'ID',
+        required: true
+    }),
+    __metadata("design:type", String)
+], Entity.prototype, "id", void 0);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW50aXR5LW1vZGVsLmNsYXNzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcHJvamVjdHMvbmd4LW1hdGVyaWFsLWVudGl0eS9zcmMvY2xhc3Nlcy9lbnRpdHktbW9kZWwuY2xhc3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUV4RDs7R0FFRztBQUNILE1BQU0sT0FBZ0IsTUFBTTtDQWEzQjtBQURHO0lBUkMsTUFBTSxDQUFDO1FBQ0osYUFBYSxFQUFFLElBQUk7UUFDbkIsYUFBYSxFQUFFLElBQUk7UUFDbkIsT0FBTyxFQUFFLEtBQUs7UUFDZCxZQUFZLEVBQUUsTUFBTTtRQUNwQixXQUFXLEVBQUUsSUFBSTtRQUNqQixRQUFRLEVBQUUsSUFBSTtLQUNqQixDQUFDOztrQ0FDVSIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IHN0cmluZyB9IGZyb20gJy4uL2RlY29yYXRvcnMvc3RyaW5nLmRlY29yYXRvcic7XG5cbi8qKlxuICogVGhlIGJhc2UgRW50aXR5IGNsYXNzLlxuICovXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgRW50aXR5IHtcbiAgICAvKipcbiAgICAgKiBBIHVuaXF1ZSBpZGVudGlmaWVyIGZvciB0aGUgRW50aXR5XG4gICAgICovXG4gICAgQHN0cmluZyh7XG4gICAgICAgIG9taXRGb3JDcmVhdGU6IHRydWUsXG4gICAgICAgIG9taXRGb3JVcGRhdGU6IHRydWUsXG4gICAgICAgIGRpc3BsYXk6IGZhbHNlLFxuICAgICAgICBkaXNwbGF5U3R5bGU6ICdsaW5lJyxcbiAgICAgICAgZGlzcGxheU5hbWU6ICdJRCcsXG4gICAgICAgIHJlcXVpcmVkOiB0cnVlXG4gICAgfSlcbiAgICBpZCE6IHN0cmluZztcbn0iXX0=