ngx-material-entity 0.1.2 → 0.1.3

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

@@ -4,24 +4,33 @@ import { CreateDialogDataInternal } from './create-dialog/create-dialog-data.bui
 import { EditDialogDataInternal } from './edit-dialog/edit-dialog-data.builder';
 import { BaseData, DisplayColumn, MultiSelectAction, TableData } from './table-data';
 import { HttpClient } from '@angular/common/http';
+import { BaseBuilder } from '../../classes/base-builder.class';
+/**
+ * The internal TableData. Requires all default values the user can leave out.
+ */
 export declare class TableDataInternal<EntityType extends Entity> implements TableData<EntityType> {
     baseData: BaseDataInternal<EntityType>;
     createDialogData: CreateDialogDataInternal;
     editDialogData: EditDialogDataInternal<EntityType>;
     constructor(baseData: BaseDataInternal<EntityType>, createDialogData: CreateDialogDataInternal, editDialogData: EditDialogDataInternal<EntityType>);
 }
-export declare class BaseDataBuilder<EntityType extends Entity> {
-    baseData: BaseDataInternal<EntityType>;
-    private readonly dataInput;
+/**
+ * The Builder for the table BaseData. Sets default values.
+ */
+export declare class BaseDataBuilder<EntityType extends Entity> extends BaseBuilder<BaseDataInternal<EntityType>, BaseData<EntityType>> {
     constructor(data: BaseData<EntityType>);
+    protected generateBaseData(data: BaseData<EntityType>): BaseDataInternal<EntityType>;
 }
+/**
+ * The internal TableData. Requires all default values the user can leave out.
+ */
 export declare class BaseDataInternal<EntityType extends Entity> implements BaseData<EntityType> {
     title: string;
     displayColumns: DisplayColumn<EntityType>[];
     EntityServiceClass: new (httpClient: HttpClient) => EntityService<EntityType>;
     searchLabel: string;
     createButtonLabel: string;
-    searchString: (enity: EntityType) => string;
+    searchString: (entity: EntityType) => string;
     allowCreate: boolean;
     allowEdit: (entity: EntityType) => boolean;
     allowDelete: (entity: EntityType) => boolean;
@@ -30,11 +39,13 @@ export declare class BaseDataInternal<EntityType extends Entity> implements Base
     EntityClass?: new (entity?: EntityType) => EntityType;
     edit?: (entity: EntityType) => unknown;
     create?: (entity: EntityType) => unknown;
-    constructor(title: string, displayColumns: DisplayColumn<EntityType>[], EntityServiceClass: new (httpClient: HttpClient) => EntityService<EntityType>, searchLabel: string, createButtonLabel: string, searchString: (enity: EntityType) => string, allowCreate: boolean, allowEdit: (entity: EntityType) => boolean, allowDelete: (entity: EntityType) => boolean, multiSelectActions: MultiSelectAction<EntityType>[], multiSelectLabel: string, EntityClass?: new (entity?: EntityType) => EntityType, edit?: (entity: EntityType) => unknown, create?: (entity: EntityType) => unknown);
+    constructor(title: string, displayColumns: DisplayColumn<EntityType>[], EntityServiceClass: new (httpClient: HttpClient) => EntityService<EntityType>, searchLabel: string, createButtonLabel: string, searchString: (entity: EntityType) => string, allowCreate: boolean, allowEdit: (entity: EntityType) => boolean, allowDelete: (entity: EntityType) => boolean, multiSelectActions: MultiSelectAction<EntityType>[], multiSelectLabel: string, EntityClass?: new (entity?: EntityType) => EntityType, edit?: (entity: EntityType) => unknown, create?: (entity: EntityType) => unknown);
 }
-export declare class TableDataBuilder<EntityType extends Entity> {
-    tableData: TableDataInternal<EntityType>;
-    private readonly dataInput;
+/**
+ * The Builder for the complete TableData. Sets default values and validates user input.
+ */
+export declare class TableDataBuilder<EntityType extends Entity> extends BaseBuilder<TableDataInternal<EntityType>, TableData<EntityType>> {
     constructor(data: TableData<EntityType>);
-    private validateInput;
+    protected generateBaseData(data: TableData<EntityType>): TableDataInternal<EntityType>;
+    protected validateInput(data: TableData<EntityType>): void;
 }

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

@@ -40,10 +40,13 @@ export interface MultiSelectAction<EntityType extends Entity> {
      */
     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.
@@ -86,7 +89,7 @@ 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.
      *
@@ -113,6 +116,9 @@ 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.
@@ -135,6 +141,9 @@ 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.
@@ -169,6 +178,9 @@ export interface EditDialogData<EntityType extends Entity> {
      */
     confirmEditDialogData?: ConfirmDialogData;
 }
+/**
+ * All the configuration data required to display a ngx-mat-entity-table.
+ */
 export interface TableData<EntityType extends Entity> {
     /**
      * The base data for the table-component.

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

@@ -8,6 +8,12 @@ import { MatDialog } from '@angular/material/dialog';
 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;
@@ -25,17 +31,57 @@ 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;
+    /**
+     * 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, { "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

@@ -3,6 +3,9 @@ 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';
@@ -11,22 +14,30 @@ export declare class EntityArrayDecoratorConfigInternal<EntityType extends Entit
     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';
-    deleteHtml?: string;
+    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';
-    deleteHtml?: string;
+    deleteIcon: string;
     minLength?: number;
     maxLength?: number;
     regex?: RegExp;

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

@@ -2,6 +2,9 @@ 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.
@@ -52,6 +55,18 @@ export interface EntityArrayDecoratorConfig<EntityType extends Entity> extends A
      * @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.
      */
@@ -64,14 +79,11 @@ export interface 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>`.
+     * The class for the <i> tag used to remove an entry from the array.
      *
-     * @default <mat-icon>cancel</mat-icon>
+     * @default 'fas fa-circle-minus'
      */
-    deleteHtml?: string;
+    deleteIcon?: string;
     /**
      * The minimum required length of the string.
      */
@@ -92,14 +104,11 @@ export interface AutocompleteStringChipsArrayDecoratorConfig extends ArrayDecora
     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>`.
+     * The class for the <i> tag used to remove an entry from the array.
      *
-     * @default <mat-icon>cancel</mat-icon>
+     * @default 'fas fa-circle-minus'
      */
-    deleteHtml?: string;
+    deleteIcon?: string;
     /**
      * The autocomplete values.
      */

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

@@ -1,7 +1,7 @@
 import { Entity } from '../../classes/entity-model.class';
 import { AutocompleteStringChipsArrayDecoratorConfig, EntityArrayDecoratorConfig, StringChipsArrayDecoratorConfig } from './array-decorator.data';
 /**
- * Decorator for setting and getting array propery metadata.
+ * Decorator for setting and getting array property metadata.
  *
  * @param metadata - The metadata of the array property.
  * @returns The method that defines the metadata.

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/number/number-decorator-internal.data.d.ts

@@ -1,11 +1,17 @@
 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: {

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

@@ -8,6 +8,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,6 +22,9 @@ 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';
     /**

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

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

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

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

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

@@ -16,6 +16,9 @@ declare abstract class ObjectDecoratorConfig<EntityType extends Entity> extends
      */
     displayStyle: 'inline';
 }
+/**
+ * The configuration options for a object property.
+ */
 export interface DefaultObjectDecoratorConfig<EntityType extends Entity> extends ObjectDecoratorConfig<EntityType> {
     displayStyle: 'inline';
 }

package/decorators/object/object.decorator.d.ts

@@ -1,7 +1,7 @@
 import { Entity } from '../../classes/entity-model.class';
 import { DefaultObjectDecoratorConfig } from './object-decorator.data';
 /**
- * Decorator for setting and getting object propery metadata.
+ * Decorator for setting and getting object property metadata.
  *
  * @param metadata - The metadata of the object property.
  * @returns The method that defines the metadata.

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

@@ -1,5 +1,8 @@
 import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
 import { AutocompleteStringDecoratorConfig, DefaultStringDecoratorConfig, DropdownStringDecoratorConfig, TextboxStringDecoratorConfig } from './string-decorator.data';
+/**
+ * The internal DropdownStringDecoratorConfig. Sets default values.
+ */
 export declare class DropdownStringDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DropdownStringDecoratorConfig {
     displayStyle: 'dropdown';
     dropdownValues: {
@@ -8,6 +11,9 @@ export declare class DropdownStringDecoratorConfigInternal extends PropertyDecor
     }[];
     constructor(data: DropdownStringDecoratorConfig);
 }
+/**
+ * The internal DefaultStringDecoratorConfig. Sets default values.
+ */
 export declare class DefaultStringDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements DefaultStringDecoratorConfig {
     displayStyle: 'line';
     minLength?: number;
@@ -15,12 +21,18 @@ export declare class DefaultStringDecoratorConfigInternal extends PropertyDecora
     regex?: RegExp;
     constructor(data: DefaultStringDecoratorConfig);
 }
+/**
+ * The internal TextboxStringDecoratorConfig. Sets default values.
+ */
 export declare class TextboxStringDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements TextboxStringDecoratorConfig {
     displayStyle: 'textbox';
     minLength?: number;
     maxLength?: number;
     constructor(data: TextboxStringDecoratorConfig);
 }
+/**
+ * The internal AutocompleteStringDecoratorConfig. Sets default values.
+ */
 export declare class AutocompleteStringDecoratorConfigInternal extends PropertyDecoratorConfigInternal implements AutocompleteStringDecoratorConfig {
     displayStyle: 'autocomplete';
     autocompleteValues: string[];

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

@@ -8,6 +8,9 @@ declare abstract class StringDecoratorConfig extends PropertyDecoratorConfig {
      */
     displayStyle: 'line' | 'textbox' | 'autocomplete' | 'dropdown';
 }
+/**
+ * The configuration options for a string property displayed as a dropdown.
+ */
 export interface DropdownStringDecoratorConfig extends StringDecoratorConfig {
     displayStyle: 'dropdown';
     /**
@@ -19,6 +22,9 @@ export interface DropdownStringDecoratorConfig extends StringDecoratorConfig {
         value: string;
     }[];
 }
+/**
+ * The configuration options for a string property displayed in a default text input.
+ */
 export interface DefaultStringDecoratorConfig extends StringDecoratorConfig {
     displayStyle: 'line';
     /**
@@ -34,6 +40,9 @@ export interface DefaultStringDecoratorConfig extends StringDecoratorConfig {
      */
     regex?: RegExp;
 }
+/**
+ * The configuration options for a string property displayed in a textbox input.
+ */
 export interface TextboxStringDecoratorConfig extends StringDecoratorConfig {
     displayStyle: 'textbox';
     /**
@@ -45,6 +54,9 @@ export interface TextboxStringDecoratorConfig extends StringDecoratorConfig {
      */
     maxLength?: number;
 }
+/**
+ * The configuration options for a string property displayed in a mat-autocomplete input.
+ */
 export interface AutocompleteStringDecoratorConfig extends StringDecoratorConfig {
     displayStyle: 'autocomplete';
     /**

package/decorators/string/string.decorator.d.ts

@@ -1,6 +1,6 @@
 import { AutocompleteStringDecoratorConfig, DefaultStringDecoratorConfig, DropdownStringDecoratorConfig, TextboxStringDecoratorConfig } from './string-decorator.data';
 /**
- * Decorator for setting and getting string propery metadata.
+ * Decorator for setting and getting string Property metadata.
  *
  * @param metadata - The metadata of the string property.
  * @returns The method that defines the metadata.