ngx-material-entity 0.1.4 → 1.0.5

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

@@ -1,11 +1,16 @@
 import { CreateDialogData } from '../../components/table/table-data';
-import { EntityClassNewable } from '../../classes/entity.model';
+import { BaseEntityType, EntityClassNewable } from '../../classes/entity.model';
 import { DecoratorTypes } from '../base/decorator-types.enum';
 import { PropertyDecoratorConfig } from '../base/property-decorator.data';
+import { DateFilterFn } from '@angular/material/datepicker';
+import { Time } from '@angular/common';
+import { DropdownValue } from '../base/dropdown-value.interface';
+import { DateRange } from '../date/date-decorator.data';
+import { ConfirmDialogData } from '../../components/confirm-dialog/confirm-dialog-data';
 /**
  * The configuration options for an array property displayed as a table.
  */
-export interface ArrayTableDisplayColumn<EntityType extends object> {
+export interface ArrayTableDisplayColumn<EntityType extends BaseEntityType<EntityType>> {
     /**
      * The name inside the header.
      */
@@ -18,22 +23,27 @@ export interface ArrayTableDisplayColumn<EntityType extends object> {
 /**
  * Interface definition for the @array metadata.
  */
-declare abstract class ArrayDecoratorConfig extends PropertyDecoratorConfig {
-    /**
-     * How to display the string.
-     */
-    displayStyle: 'table' | 'chips';
+export declare abstract class ArrayDecoratorConfig extends PropertyDecoratorConfig {
     /**
      * The type of the items inside the array.
      */
     itemType: DecoratorTypes;
+    /**
+     * Whether or not duplicate values are allowed inside the array.
+     *
+     * @default false
+     */
+    allowDuplicates?: boolean;
+    /**
+     * The error dialog to display when the user tries to add a duplicate entry.
+     */
+    duplicatesErrorDialog?: ConfirmDialogData;
 }
 /**
  * Definition for an array of Entities.
  */
-export interface EntityArrayDecoratorConfig<EntityType extends object> extends ArrayDecoratorConfig {
+export interface EntityArrayDecoratorConfig<EntityType extends BaseEntityType<EntityType>> extends ArrayDecoratorConfig {
     itemType: DecoratorTypes.OBJECT;
-    displayStyle: 'table';
     /**
      * The EntityClass used for generating the create inputs.
      */
@@ -72,12 +82,170 @@ export interface EntityArrayDecoratorConfig<EntityType extends object> extends A
      */
     missingErrorMessage?: string;
 }
+/**
+ * Definition for an array of Dates.
+ */
+export interface DateArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.DATE;
+    /**
+     * 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<Date>[];
+    /**
+     * The label for the add button.
+     *
+     * @default 'Add'
+     */
+    addButtonLabel?: string;
+    /**
+     * The label for the remove button.
+     *
+     * @default 'Remove'
+     */
+    removeButtonLabel?: string;
+    /**
+     * The error-message to display when the array is required but contains no values.
+     */
+    missingErrorMessage?: string;
+    /**
+     * 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>;
+}
+/**
+ * Definition for an array of DateTimes.
+ */
+export interface DateTimeArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.DATE_TIME;
+    /**
+     * 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<Date>[];
+    /**
+     * The label for the add button.
+     *
+     * @default 'Add'
+     */
+    addButtonLabel?: string;
+    /**
+     * The label for the remove button.
+     *
+     * @default 'Remove'
+     */
+    removeButtonLabel?: string;
+    /**
+     * The error-message to display when the array is required but contains no values.
+     */
+    missingErrorMessage?: string;
+    /**
+     * 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);
+}
+/**
+ * Definition for an array of DateRanges.
+ */
+export interface DateRangeArrayDecoratorConfig extends ArrayDecoratorConfig {
+    itemType: DecoratorTypes.DATE_RANGE;
+    /**
+     * 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<DateRange>[];
+    /**
+     * The label for the add button.
+     *
+     * @default 'Add'
+     */
+    addButtonLabel?: string;
+    /**
+     * The label for the remove button.
+     *
+     * @default 'Remove'
+     */
+    removeButtonLabel?: string;
+    /**
+     * The error-message to display when the array is required but contains no values.
+     */
+    missingErrorMessage?: string;
+    /**
+     * 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;
+}
 /**
  * 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.
      *
@@ -102,7 +270,6 @@ export interface StringChipsArrayDecoratorConfig extends ArrayDecoratorConfig {
  */
 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.
      *
@@ -126,4 +293,3 @@ export interface AutocompleteStringChipsArrayDecoratorConfig extends ArrayDecora
      */
     regex?: RegExp;
 }
-export {};

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

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

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, CustomMetadataType extends Record<string, unknown>>(metadata: DecoratorType<T, CustomMetadataType>, type: T): (target: object, propertyKey: string) => void;

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

@@ -1,9 +1,11 @@
-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 { CustomDecoratorConfigInternal } from '../custom/custom-decorator-internal.data';
 import { DateRangeDateDecoratorConfigInternal, DateTimeDateDecoratorConfigInternal, DefaultDateDecoratorConfigInternal } from '../date/date-decorator-internal.data';
-import { DefaultNumberDecoratorConfigInternal, DropdownNumberDecoratorConfigInternal } from '../number/number-decorator-internal.data';
+import { DefaultFileDecoratorConfigInternal, ImageFileDecoratorConfigInternal } from '../file/file-decorator-internal.data';
+import { DefaultNumberDecoratorConfigInternal, DropdownNumberDecoratorConfigInternal, SliderNumberDecoratorConfigInternal } 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';
+import { AutocompleteStringDecoratorConfigInternal, DefaultStringDecoratorConfigInternal, DropdownStringDecoratorConfigInternal, PasswordStringDecoratorConfigInternal, TextboxStringDecoratorConfigInternal } from '../string/string-decorator-internal.data';
 /**
  * The enum Values for all the different DecoratorTypes.
  */
@@ -12,20 +14,28 @@ export declare enum DecoratorTypes {
     STRING_DROPDOWN = "stringDropdown",
     STRING_AUTOCOMPLETE = "stringAutocomplete",
     STRING_TEXTBOX = "stringTextbox",
+    STRING_PASSWORD = "stringPassword",
     NUMBER = "number",
     NUMBER_DROPDOWN = "numberDropdown",
+    NUMBER_SLIDER = "numberSlider",
     BOOLEAN_CHECKBOX = "boolean",
     BOOLEAN_TOGGLE = "booleanToggle",
     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",
     DATE = "date",
     DATE_RANGE = "dateRange",
-    DATE_TIME = "dateTime"
+    DATE_TIME = "dateTime",
+    FILE_DEFAULT = "fileDefault",
+    FILE_IMAGE = "fileImage",
+    CUSTOM = "custom"
 }
 /**
  * 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<object> : T extends DecoratorTypes.ARRAY ? EntityArrayDecoratorConfigInternal<object> : 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 : never;
+export declare type DecoratorType<T, CustomMetadataType extends Record<string, unknown>> = 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.STRING_PASSWORD ? PasswordStringDecoratorConfigInternal : T extends DecoratorTypes.NUMBER ? DefaultNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_DROPDOWN ? DropdownNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_SLIDER ? SliderNumberDecoratorConfigInternal : 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 : T extends DecoratorTypes.CUSTOM ? CustomDecoratorConfigInternal<any, any, CustomMetadataType, any> : never;

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

@@ -0,0 +1,17 @@
+import { Type } from '@angular/core';
+import { BaseEntityType } from '../../classes/entity.model';
+import { NgxMatEntityBaseInputComponent } from '../../components/input/base-input.component';
+import { DecoratorTypes } from '../base/decorator-types.enum';
+import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
+import { CustomDecoratorConfig } from './custom-decorator.data';
+/**
+ * The internal config for the @custom decorator.
+ * Sets default values.
+ */
+export declare class CustomDecoratorConfigInternal<EntityType extends BaseEntityType<EntityType>, ValueType, MetadataType extends BaseEntityType<MetadataType>, ComponentType extends NgxMatEntityBaseInputComponent<EntityType, DecoratorTypes.CUSTOM, MetadataType>> extends PropertyDecoratorConfigInternal implements CustomDecoratorConfig<EntityType, ValueType, MetadataType, ComponentType> {
+    component: Type<ComponentType>;
+    isValid: (value: ValueType, omit: 'create' | 'update') => boolean;
+    isEqual: (value: ValueType, valuePriorChanges: ValueType, metadata: CustomDecoratorConfig<EntityType, ValueType, MetadataType, ComponentType>) => boolean;
+    customMetadata: MetadataType;
+    constructor(data: CustomDecoratorConfig<EntityType, ValueType, MetadataType, ComponentType>);
+}

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

@@ -0,0 +1,37 @@
+import { NgxMatEntityBaseInputComponent } from '../../components/input/base-input.component';
+import { BaseEntityType } from '../../classes/entity.model';
+import { DecoratorTypes } from '../base/decorator-types.enum';
+import { PropertyDecoratorConfig } from '../base/property-decorator.data';
+import { Type } from '@angular/core';
+/**
+ * Definition for a custom property. Use this if the provided decorators don't fit your needs.
+ */
+export interface CustomDecoratorConfig<EntityType extends BaseEntityType<EntityType>, ValueType, MetadataType extends BaseEntityType<MetadataType>, ComponentType extends NgxMatEntityBaseInputComponent<EntityType, DecoratorTypes.CUSTOM, MetadataType>> extends PropertyDecoratorConfig {
+    /**
+     * The component to use for this input.
+     */
+    component: Type<ComponentType>;
+    /**
+     * The function that defines whether or not the value is valid.
+     * Used in addition to default checks like required etc.
+     * Needed for the edit and create dialogs.
+     *
+     * TIP: If you need additional data for checking if the value is valid, you can define them as metadata directly on the value.
+     *
+     * @default () => true
+     */
+    isValid?: (value: ValueType, omit: 'create' | 'update') => boolean;
+    /**
+     * The function that defines whether or not two of your custom values are equal.
+     * Needed for the edit and create dialogs.
+     *
+     * TIP: If you need additional data for checking if the value is valid, you can define them as metadata directly on the values.
+     *
+     * @default (value: ValueType, valuePriorChanges: ValueType) => LodashUtilities.isEqual(value, valuePriorChanges)
+     */
+    isEqual?: (value: ValueType, valuePriorChanges: ValueType, metadata: CustomDecoratorConfig<EntityType, ValueType, MetadataType, ComponentType>) => boolean;
+    /**
+     * Any custom metadata you want to add to the property.
+     */
+    customMetadata: MetadataType;
+}

package/decorators/custom/custom.decorator.d.ts

@@ -0,0 +1,11 @@
+import { BaseEntityType } from '../../classes/entity.model';
+import { NgxMatEntityBaseInputComponent } from '../../components/input/base-input.component';
+import { DecoratorTypes } from '../base/decorator-types.enum';
+import { CustomDecoratorConfig } from './custom-decorator.data';
+/**
+ * Decorator for setting and getting custom property metadata.
+ *
+ * @param metadata - The metadata of the custom property.
+ * @returns The method that defines the metadata.
+ */
+export declare function custom<ValueType, MetadataType extends BaseEntityType<MetadataType>, EntityType extends BaseEntityType<EntityType>>(metadata: CustomDecoratorConfig<EntityType, ValueType, MetadataType, NgxMatEntityBaseInputComponent<EntityType, DecoratorTypes.CUSTOM, MetadataType>>): (target: object, propertyKey: string) => void;

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

@@ -23,8 +23,8 @@ export declare class DateRangeDateDecoratorConfigInternal extends PropertyDecora
     minEnd?: (date?: Date) => Date;
     maxEnd?: (date?: Date) => Date;
     filter?: DateFilterFn<Date>;
-    placeholderStart?: string;
-    placeholderEnd?: string;
+    placeholderStart: string;
+    placeholderEnd: string;
     constructor(data: DateRangeDateDecoratorConfig);
 }
 /**

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,6 +1,6 @@
 import { DropdownValue } from '../base/dropdown-value.interface';
 import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
-import { DefaultNumberDecoratorConfig, DropdownNumberDecoratorConfig } from './number-decorator.data';
+import { DefaultNumberDecoratorConfig, DropdownNumberDecoratorConfig, SliderNumberDecoratorConfig } from './number-decorator.data';
 /**
  * The internal DefaultNumberDecoratorConfig. Sets default values.
  */
@@ -18,3 +18,22 @@ export declare class DropdownNumberDecoratorConfigInternal extends PropertyDecor
     dropdownValues: DropdownValue<number>[];
     constructor(data: DropdownNumberDecoratorConfig);
 }
+/**
+ * The internal SliderNumberDecoratorConfig. Sets default values.
+ */
+export declare class SliderNumberDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements SliderNumberDecoratorConfig {
+    displayStyle: 'slider';
+    min?: number;
+    max?: number;
+    step?: number;
+    formatThumbLabelValue: (value: number) => string | number;
+    tickInterval?: number | 'auto';
+    constructor(data: SliderNumberDecoratorConfig);
+}
+/**
+ * The default function to format values for the number slider thumb label.
+ *
+ * @param value - The value of the slider.
+ * @returns Just the value without any formatting done.
+ */
+export declare function defaultFormatThumbLabelValue(value: number): number;