ngx-material-entity 0.1.2 → 0.1.5

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

@@ -1,5 +1,4 @@
-import { DecoratorTypes } from './decorator-types.enum';
-import { PropertyDecoratorConfigInternal } from './property-decorator-internal.data';
+import { DecoratorType, DecoratorTypes } from './decorator-types.enum';
 /**
  * The base decorator for setting metadata on properties.
  *
@@ -7,4 +6,4 @@ import { PropertyDecoratorConfigInternal } from './property-decorator-internal.d
  * @param type - The type of metadata.
  * @returns The method that sets the metadata.
  */
-export declare function baseProperty(metadata: PropertyDecoratorConfigInternal, type: DecoratorTypes): (target: object, propertyKey: string) => void;
+export declare function baseProperty<T extends DecoratorTypes>(metadata: DecoratorType<T>, type: T): (target: object, propertyKey: string) => void;

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

@@ -1,6 +1,7 @@
-import { Entity } from '../../classes/entity-model.class';
-import { AutocompleteStringChipsArrayDecoratorConfigInternal, EntityArrayDecoratorConfigInternal, StringChipsArrayDecoratorConfigInternal } from '../array/array-decorator-internal.data';
+import { AutocompleteStringChipsArrayDecoratorConfigInternal, EntityArrayDecoratorConfigInternal, DateArrayDecoratorConfigInternal, StringChipsArrayDecoratorConfigInternal, DateTimeArrayDecoratorConfigInternal, DateRangeArrayDecoratorConfigInternal } from '../array/array-decorator-internal.data';
 import { CheckboxBooleanDecoratorConfigInternal, DropdownBooleanDecoratorConfigInternal, ToggleBooleanDecoratorConfigInternal } from '../boolean/boolean-decorator-internal.data';
+import { DateRangeDateDecoratorConfigInternal, DateTimeDateDecoratorConfigInternal, DefaultDateDecoratorConfigInternal } from '../date/date-decorator-internal.data';
+import { DefaultFileDecoratorConfigInternal, ImageFileDecoratorConfigInternal } from '../file/file-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';
@@ -19,10 +20,18 @@ export declare enum DecoratorTypes {
     BOOLEAN_DROPDOWN = "booleanDropdown",
     OBJECT = "object",
     ARRAY = "array",
+    ARRAY_DATE = "arrayDate",
+    ARRAY_DATE_TIME = "arrayDateTime",
+    ARRAY_DATE_RANGE = "arrayDateRange",
     ARRAY_STRING_CHIPS = "arrayStringChips",
-    ARRAY_STRING_AUTOCOMPLETE_CHIPS = "arrayStringAutocompleteChips"
+    ARRAY_STRING_AUTOCOMPLETE_CHIPS = "arrayStringAutocompleteChips",
+    DATE = "date",
+    DATE_RANGE = "dateRange",
+    DATE_TIME = "dateTime",
+    FILE_DEFAULT = "fileDefault",
+    FILE_IMAGE = "fileImage"
 }
 /**
  * Gives the metadata-config Type based on the DecoratorTypes enum.
  */
-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;
+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<any> : T extends DecoratorTypes.ARRAY ? EntityArrayDecoratorConfigInternal<any> : T extends DecoratorTypes.ARRAY_DATE ? DateArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_DATE_TIME ? DateTimeArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_DATE_RANGE ? DateRangeArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_CHIPS ? StringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_AUTOCOMPLETE_CHIPS ? AutocompleteStringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.DATE ? DefaultDateDecoratorConfigInternal : T extends DecoratorTypes.DATE_RANGE ? DateRangeDateDecoratorConfigInternal : T extends DecoratorTypes.DATE_TIME ? DateTimeDateDecoratorConfigInternal : T extends DecoratorTypes.FILE_DEFAULT ? DefaultFileDecoratorConfigInternal : T extends DecoratorTypes.FILE_IMAGE ? ImageFileDecoratorConfigInternal : never;

package/decorators/base/dropdown-value.interface.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The definition for a dropdown value.
+ * Consists of the name to display in the dropdown and the actual value.
+ */
+export interface DropdownValue<T> {
+    /**
+     * The name to display in the dropdown.
+     */
+    displayName: string;
+    /**
+     * The actual value.
+     */
+    value: T;
+}

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

@@ -1,11 +1,24 @@
-import { cols, PropertyDecoratorConfig } from './property-decorator.data';
+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: [cols, cols, cols];
-    order: number;
+    defaultWidths: [Col, Col, Col];
+    position: PositionInternal;
     constructor(data: PropertyDecoratorConfig);
 }
+export {};

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

@@ -1,4 +1,7 @@
-export declare type cols = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+/**
+ * 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.
  */
@@ -34,16 +37,34 @@ export declare abstract class PropertyDecoratorConfig {
     /**
      * 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 screensize lg, the second for md and the third for sm.
+     * 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?: [cols, cols, cols];
+    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 when used inside the default create or edit dialog.
+     * Specifies order of the input property inside the specified row.
      * Ordering is ascending.
      *
-     * @default -1 (sets this property at the end)
+     * @default -1 (sets this property at the end of the row)
      */
     order?: number;
 }

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

@@ -1,15 +1,24 @@
 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

@@ -8,6 +8,9 @@ declare abstract class BooleanDecoratorConfig extends PropertyDecoratorConfig {
      */
     displayStyle: 'checkbox' | 'dropdown' | 'toggle';
 }
+/**
+ * The configuration options for a boolean property displayed in a dropdown.
+ */
 export interface DropdownBooleanDecoratorConfig extends BooleanDecoratorConfig {
     displayStyle: 'dropdown';
     /**
@@ -19,9 +22,15 @@ export interface DropdownBooleanDecoratorConfig extends BooleanDecoratorConfig {
      */
     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';
 }

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

@@ -1,6 +1,6 @@
 import { CheckboxBooleanDecoratorConfig, DropdownBooleanDecoratorConfig, ToggleBooleanDecoratorConfig } from './boolean-decorator.data';
 /**
- * Decorator for setting and getting boolean propery metadata.
+ * Decorator for setting and getting boolean property metadata.
  *
  * @param metadata - The metadata of the boolean property.
  * @returns The method that defines the metadata.

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

@@ -0,0 +1,44 @@
+import { Time } from '@angular/common';
+import { DateFilterFn } from '@angular/material/datepicker';
+import { DropdownValue } from '../base/dropdown-value.interface';
+import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
+import { DateRangeDateDecoratorConfig, DateTimeDateDecoratorConfig, DefaultDateDecoratorConfig } from './date-decorator.data';
+/**
+ * The internal DefaultDateDecoratorConfig. Sets default values.
+ */
+export declare class DefaultDateDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DefaultDateDecoratorConfig {
+    displayStyle: 'date';
+    min?: (date?: Date) => Date;
+    max?: (date?: Date) => Date;
+    filter?: DateFilterFn<Date | null | undefined>;
+    constructor(data: DefaultDateDecoratorConfig);
+}
+/**
+ * The internal DateRangeDateDecoratorConfig. Sets default values.
+ */
+export declare class DateRangeDateDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DateRangeDateDecoratorConfig {
+    displayStyle: 'daterange';
+    minStart?: (date?: Date) => Date;
+    maxStart?: (date?: Date) => Date;
+    minEnd?: (date?: Date) => Date;
+    maxEnd?: (date?: Date) => Date;
+    filter?: DateFilterFn<Date>;
+    placeholderStart: string;
+    placeholderEnd: string;
+    constructor(data: DateRangeDateDecoratorConfig);
+}
+/**
+ * The internal DateTimeDateDecoratorConfig. Sets default values.
+ */
+export declare class DateTimeDateDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DateTimeDateDecoratorConfig {
+    displayStyle: 'datetime';
+    times: DropdownValue<Time>[];
+    timeDisplayName: string;
+    minDate?: (date?: Date) => Date;
+    maxDate?: (date?: Date) => Date;
+    filterDate?: DateFilterFn<Date | null | undefined>;
+    minTime?: (date?: Date) => Time;
+    maxTime?: (date?: Date) => Time;
+    filterTime?: ((time: Time) => boolean) | (() => boolean);
+    constructor(data: DateTimeDateDecoratorConfig);
+}

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

@@ -0,0 +1,129 @@
+import { Time } from '@angular/common';
+import { DateFilterFn } from '@angular/material/datepicker';
+import { DropdownValue } from '../base/dropdown-value.interface';
+import { PropertyDecoratorConfig } from '../base/property-decorator.data';
+/**
+ * This is the needed type for an property that should be displayed as a date range.
+ */
+export interface DateRange {
+    /**
+     * The start date of the range.
+     */
+    start: Date;
+    /**
+     * The end date of the range.
+     */
+    end: Date;
+    /**
+     * The actual Date values. These are needed if the date range might contain some values that are disabled.
+     * E.g. When you build a tool to request vacation you may want the user to select 3 weeks in the range picker
+     * but don't want the weekend dates in the final result.
+     */
+    values?: Date[];
+}
+/**
+ * Definition for the @date metadata.
+ */
+declare abstract class DateDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * How to display the date.
+     */
+    displayStyle: 'date' | 'datetime' | 'daterange';
+}
+/**
+ * The configuration options for a date property displayed as a default single date picker.
+ */
+export interface DefaultDateDecoratorConfig extends DateDecoratorConfig {
+    displayStyle: 'date';
+    /**
+     * A function to get the minimum value of the date.
+     */
+    min?: (date?: Date) => Date;
+    /**
+     * A function to get the maximum value of the date.
+     */
+    max?: (date?: Date) => Date;
+    /**
+     * A filter function to do more specific filtering. This could be the removal of e.g. All weekends.
+     */
+    filter?: DateFilterFn<Date | null | undefined>;
+}
+/**
+ * The configuration options for a date property displayed as a date range.
+ */
+export interface DateRangeDateDecoratorConfig extends DateDecoratorConfig {
+    displayStyle: 'daterange';
+    /**
+     * A function to get the minimum value of the start date.
+     */
+    minStart?: (date?: Date) => Date;
+    /**
+     * A function to get the maximum value of the start date.
+     */
+    maxStart?: (date?: Date) => Date;
+    /**
+     * A function to get the minimum value of the end date.
+     */
+    minEnd?: (date?: Date) => Date;
+    /**
+     * A function to get the maximum value of the end date.
+     */
+    maxEnd?: (date?: Date) => Date;
+    /**
+     * A filter function to do more specific filtering on the disallowed end date values. This could be the removal of e.g. All weekends.
+     */
+    filter?: DateFilterFn<Date>;
+    /**
+     * The placeholder for the start date of the date range picker.
+     *
+     * @default "Start"
+     */
+    placeholderStart?: string;
+    /**
+     * The placeholder for the end date of the date range picker.
+     *
+     * @default "End"
+     */
+    placeholderEnd?: string;
+}
+/**
+ * The configuration options for a date property displayed as date time.
+ */
+export interface DateTimeDateDecoratorConfig extends DateDecoratorConfig {
+    displayStyle: 'datetime';
+    /**
+     * The selectable times.
+     */
+    times?: DropdownValue<Time>[];
+    /**
+     * The name to use as a label for the time form field.
+     *
+     * @default 'Time'
+     */
+    timeDisplayName?: string;
+    /**
+     * A function to get the minimum value of the date.
+     */
+    minDate?: (date?: Date) => Date;
+    /**
+     * A function to get the maximum value of the date.
+     */
+    maxDate?: (date?: Date) => Date;
+    /**
+     * A filter function to do more specific date filtering. This could be the removal of e.g. All weekends.
+     */
+    filterDate?: DateFilterFn<Date | null | undefined>;
+    /**
+     * A function to get the minimum value of the time.
+     */
+    minTime?: (date?: Date) => Time;
+    /**
+     * A function to get the maximum value of the time.
+     */
+    maxTime?: (date?: Date) => Time;
+    /**
+     * A filter function to do more specific time filtering. This could be e.g. The removal of lunch breaks.
+     */
+    filterTime?: ((time: Time) => boolean) | (() => boolean);
+}
+export {};

package/decorators/date/date.decorator.d.ts

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

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

@@ -0,0 +1,92 @@
+import { ConfirmDialogData } from '../../components/confirm-dialog/confirm-dialog-data';
+import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
+import { DefaultFileDecoratorConfig, ImageFileDecoratorConfig } from './file-decorator.data';
+/**
+ * Contains data about a file property where a blob exists.
+ */
+export interface FileDataWithFile {
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The file data itself in form of a blob.
+     */
+    file: Blob;
+    /**
+     * The mime type of the file.
+     * This is needed to increase performance when checking if the provided file is valid.
+     */
+    type: string;
+    /**
+     * The size of the file in bytes.
+     * This is needed to increase performance when checking if the provided file is valid.
+     */
+    size: number;
+    /**
+     * The url where the blob is saved.
+     */
+    url?: string;
+}
+/**
+ * Contains data about a file property where no blob exists.
+ */
+export interface FileDataWithUrl {
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The file data itself in form of a blob.
+     */
+    file?: Blob;
+    /**
+     * The mime type of the file.
+     * This is needed to increase performance when checking if the provided file is valid.
+     */
+    type: string;
+    /**
+     * The size of the file in bytes.
+     * This is needed to increase performance when checking if the provided file is valid.
+     */
+    size: number;
+    /**
+     * The url where the blob is saved.
+     */
+    url: string;
+}
+/**
+ * The internal DefaultFileDecoratorConfig. Sets default values.
+ */
+export declare class DefaultFileDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DefaultFileDecoratorConfig {
+    type: 'other';
+    preview: false;
+    multiple: boolean;
+    allowedMimeTypes: string[];
+    deleteIcon: string;
+    maxSize: number;
+    maxSizeTotal: number;
+    mimeTypeErrorDialog: ConfirmDialogData;
+    maxSizeErrorDialog: ConfirmDialogData;
+    maxSizeTotalErrorDialog: ConfirmDialogData;
+    dragAndDrop: boolean;
+    constructor(data: DefaultFileDecoratorConfig);
+}
+/**
+ * The internal ImageFileDecoratorConfig. Sets default values.
+ */
+export declare class ImageFileDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements ImageFileDecoratorConfig {
+    type: 'image';
+    allowedMimeTypes: string[];
+    multiple: boolean;
+    preview: boolean;
+    previewPlaceholderUrl?: string;
+    deleteIcon: string;
+    maxSize: number;
+    maxSizeTotal: number;
+    mimeTypeErrorDialog: ConfirmDialogData;
+    maxSizeErrorDialog: ConfirmDialogData;
+    maxSizeTotalErrorDialog: ConfirmDialogData;
+    dragAndDrop: boolean;
+    constructor(data: ImageFileDecoratorConfig);
+}

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

@@ -0,0 +1,92 @@
+import { ConfirmDialogData } from '../../components/confirm-dialog/confirm-dialog-data';
+import { PropertyDecoratorConfig } from '../base/property-decorator.data';
+import { FileDataWithFile, FileDataWithUrl } from './file-decorator-internal.data';
+/**
+ * The type of a property annotated with @file.
+ */
+export declare type FileData = FileDataWithFile | FileDataWithUrl;
+/**
+ * Definition for the @file metadata.
+ */
+declare abstract class FileDecoratorConfig extends PropertyDecoratorConfig {
+    /**
+     * Specifies whether or not the decorated property can have multiple files.
+     */
+    multiple: boolean;
+    /**
+     * The type of the upload.
+     */
+    type: 'image' | 'other';
+    /**
+     * The class for the <i> tag used to remove a file from the input.
+     *
+     * @default 'fas fa-circle-minus'
+     */
+    deleteIcon?: string;
+    /**
+     * Whether or not the file should be displayed inside a preview.
+     *
+     * @default true
+     */
+    preview?: boolean;
+    /**
+     * Specifies allowed File types like 'image/jpg' etc.
+     * Allows every file type if not set.
+     */
+    allowedMimeTypes?: string[];
+    /**
+     * The error dialog to display when the user inputs files that are not of the allowed mime types.
+     */
+    mimeTypeErrorDialog?: ConfirmDialogData;
+    /**
+     * The maximum allowed size of a single file in MB.
+     *
+     * @default 10
+     */
+    maxSize?: number;
+    /**
+     * The error dialog to display when the user inputs a single file that is bigger than the 'maxSize' value.
+     */
+    maxSizeErrorDialog?: ConfirmDialogData;
+    /**
+     * The maximum allowed size of all files in MB.
+     *
+     * @default 100
+     */
+    maxSizeTotal?: number;
+    /**
+     * The error dialog to display when the user inputs files which are in total bigger than the 'maxSizeTotal' value.
+     */
+    maxSizeTotalErrorDialog?: ConfirmDialogData;
+    /**
+     * Defines whether or not a dropdown box is displayed.
+     *
+     * @default true // when multiple is set to true.
+     * false // when multiple is set to false.
+     */
+    dragAndDrop?: boolean;
+}
+/**
+ * Definition for a default file.
+ */
+export interface DefaultFileDecoratorConfig extends FileDecoratorConfig {
+    type: 'other';
+    preview?: false;
+}
+/**
+ * Definition for a image file.
+ */
+export interface ImageFileDecoratorConfig extends FileDecoratorConfig {
+    type: 'image';
+    /**
+     * Specifies allowed File types like image/jpg etc. In a comma separated string.
+     *
+     * @default ['image/*']
+     */
+    allowedMimeTypes?: string[];
+    /**
+     * Url to the file that gets displayed in the preview when no file has been selected yet.
+     */
+    previewPlaceholderUrl?: string;
+}
+export {};

package/decorators/file/file.decorator.d.ts

@@ -0,0 +1,9 @@
+import { DefaultFileDecoratorConfig, ImageFileDecoratorConfig } from './file-decorator.data';
+/**
+ * Decorator for setting and getting file property metadata.
+ *
+ * @param metadata - The metadata of the file property.
+ * @returns The method that defines the metadata.
+ * @throws When an unknown metadata type was provided.
+ */
+export declare function file(metadata: DefaultFileDecoratorConfig | ImageFileDecoratorConfig): (target: object, propertyKey: string) => void;

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

@@ -1,16 +1,20 @@
+import { DropdownValue } from '../base/dropdown-value.interface';
 import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
 import { DefaultNumberDecoratorConfig, DropdownNumberDecoratorConfig } from './number-decorator.data';
+/**
+ * The internal DefaultNumberDecoratorConfig. Sets default values.
+ */
 export declare class DefaultNumberDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DefaultNumberDecoratorConfig {
     displayStyle: 'line';
     min?: number;
     max?: number;
     constructor(data: DefaultNumberDecoratorConfig);
 }
+/**
+ * The internal DropdownNumberDecoratorConfig. Sets default values.
+ */
 export declare class DropdownNumberDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DropdownNumberDecoratorConfig {
     displayStyle: 'dropdown';
-    dropdownValues: {
-        displayName: string;
-        value: number;
-    }[];
+    dropdownValues: DropdownValue<number>[];
     constructor(data: DropdownNumberDecoratorConfig);
 }

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

@@ -1,3 +1,4 @@
+import { DropdownValue } from '../base/dropdown-value.interface';
 import { PropertyDecoratorConfig } from '../base/property-decorator.data';
 /**
  * Definition for the @number metadata.
@@ -8,6 +9,9 @@ declare abstract class NumberDecoratorConfig extends PropertyDecoratorConfig {
      */
     displayStyle: 'line' | 'dropdown';
 }
+/**
+ * The configuration options for a number property displayed in a default number input.
+ */
 export interface DefaultNumberDecoratorConfig extends NumberDecoratorConfig {
     displayStyle: 'line';
     /**
@@ -19,14 +23,14 @@ export interface DefaultNumberDecoratorConfig extends NumberDecoratorConfig {
      */
     max?: number;
 }
+/**
+ * The configuration options for a number property displayed in a dropdown.
+ */
 export interface DropdownNumberDecoratorConfig extends NumberDecoratorConfig {
     displayStyle: 'dropdown';
     /**
      * The values of the dropdown, consisting of a name to display and the actual value.
      */
-    dropdownValues: {
-        displayName: string;
-        value: number;
-    }[];
+    dropdownValues: DropdownValue<number>[];
 }
 export {};

package/decorators/number/number.decorator.d.ts

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

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

@@ -1,8 +1,11 @@
-import { Entity } from '../../classes/entity-model.class';
+import { BaseEntityType, EntityClassNewable } from '../../classes/entity.model';
 import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
 import { DefaultObjectDecoratorConfig } from './object-decorator.data';
-export declare class DefaultObjectDecoratorConfigInternal<EntityType extends Entity> extends PropertyDecoratorConfigInternal implements DefaultObjectDecoratorConfig<EntityType> {
+/**
+ * The internal DefaultObjectDecoratorConfig. Sets default values.
+ */
+export declare class DefaultObjectDecoratorConfigInternal<EntityType extends BaseEntityType<EntityType>> extends PropertyDecoratorConfigInternal implements DefaultObjectDecoratorConfig<EntityType> {
     displayStyle: 'inline';
-    type: new (entity?: EntityType) => EntityType;
+    EntityClass: EntityClassNewable<EntityType>;
     constructor(data: DefaultObjectDecoratorConfig<EntityType>);
 }