ngx-material-entity 16.0.4 → 16.0.6

package/README.md

@@ -573,7 +573,7 @@ export interface EntityArrayDecoratorConfig<EntityType extends object> extends A
      * The data for the add-item-dialog.
      * Can be omitted when adding items inline.
      */
-    createDialogData?: CreateDialogData,
+    createDialogData?: CreateData,
 
     /**
      * Whether or not the form for adding items to the array
@@ -1083,7 +1083,7 @@ export interface BaseData<EntityType extends object> {
      * 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>,
+    EntityServiceClass: EntityServiceClassNewable<EntityType>,
     /**
      * The Class of the entities to manage.
      */
@@ -1148,7 +1148,7 @@ export interface BaseData<EntityType extends object> {
 /**
  * The data of the default create-dialog.
  */
-export interface CreateDialogData {
+export interface CreateData {
     /**
      * The title of the default create-dialog.
      */
@@ -1224,7 +1224,7 @@ export interface TableData<EntityType extends object> {
      * The data for the default create-dialog.
      * Can be omitted when specifying a custom "create" method inside the baseData.
      */
-    createDialogData?: CreateDialogData,
+    createDialogData?: CreateData,
     /**
      * The data for the default edit-dialog.
      * Can be omitted when specifying a custom "edit" method inside the baseData.

package/classes/base.builder.d.ts

@@ -13,20 +13,17 @@ export declare abstract class BaseBuilder<InternalType extends InputType, InputT
     protected constructor(globalConfig: NgxGlobalDefaultValues, data?: InputType);
     /**
      * Generates the internal data from the given user inputs.
-     *
      * @param data - The input from the user.
      * @returns The internal data.
      */
     protected abstract generateBaseData(data?: InputType): InternalType;
     /**
      * Used to validate the user input in the constructor.
-     *
      * @param data - The user input.
      */
     protected validateInput(data?: InputType): void;
     /**
      * Sets the value for the given key if no user value was provided.
-     *
      * @param key - The key to set the default value for.
      * @param value - The value to set when nothing was provided.
      * @returns The Builder.
@@ -34,7 +31,6 @@ export declare abstract class BaseBuilder<InternalType extends InputType, InputT
     withDefault(key: keyof InputType, value: Omit<InternalType[keyof InputType], 'undefined'>): BaseBuilder<InternalType, InputType>;
     /**
      * Method used to get the final build value after applying all chaining.
-     *
      * @returns The build value.
      */
     getResult(): InternalType;

package/classes/entity.model.d.ts

@@ -1,7 +1,14 @@
+import { HttpClient } from '@angular/common/http';
+import { EnvironmentInjector } from '@angular/core';
+import { EntityService } from '../services/entity.service';
 /**
  * The newable type used whenever an entity class is passed to create an entity and initialize its metadata.
  */
 export type EntityClassNewable<EntityType extends BaseEntityType<EntityType>> = new (data?: EntityType) => EntityType;
+/**
+ * The newable type used whenever an entity service class is passed.
+ */
+export type EntityServiceClassNewable<EntityType extends BaseEntityType<EntityType>> = new (http: HttpClient, injector: EnvironmentInjector) => EntityService<EntityType>;
 /**
  * The Generic Base EntityType.
  */

package/components/confirm-dialog/confirm-dialog-data.d.ts

@@ -24,13 +24,11 @@ export interface ConfirmDialogData {
     /**
      * The label of the button that confirms the dialog.
      * In case of the 'delete' Dialog this is the string that is shown on the delete-button.
-     *
      * @default 'Confirm' or 'Delete', depending on the type
      */
     confirmButtonLabel?: string;
     /**
      * The label of the button that closes the dialog without doing anything.
-     *
      * @default 'Cancel'
      */
     cancelButtonLabel?: string;
@@ -40,7 +38,6 @@ export interface ConfirmDialogData {
     title?: string;
     /**
      * Whether or not a checkbox needs to be selected before the user can confirm the dialog.
-     *
      * @default false
      */
     requireConfirmation?: boolean;

package/components/confirm-dialog/confirm-dialog.component.d.ts

@@ -13,7 +13,13 @@ export declare class NgxMatEntityConfirmDialogComponent implements OnInit {
     private readonly dialogRef;
     private readonly inputData;
     protected readonly globalConfig: NgxGlobalDefaultValues;
+    /**
+     * Whether or not the user needs to tick a checkbox to enable the confirm button.
+     */
     confirm: boolean;
+    /**
+     * The configuration data of the dialog.
+     */
     data: ConfirmDialogDataInternal;
     constructor(dialogRef: MatDialogRef<NgxMatEntityConfirmDialogComponent>, inputData: ConfirmDialogData, globalConfig: NgxGlobalDefaultValues);
     ngOnInit(): void;

package/components/create-page/create-data.route.d.ts

@@ -0,0 +1,16 @@
+import { EnvironmentProviders, Provider, Type } from '@angular/core';
+import { DefaultExport, Route } from '@angular/router';
+import { Observable } from 'rxjs';
+/**
+ * The definition for a route to use with the "NgxMatEntityCreatePageComponent".
+ */
+export interface CreateDataRoute extends Route {
+    loadComponent: () => Type<unknown> | Observable<Type<unknown> | DefaultExport<Type<unknown>>> | Promise<Type<unknown> | DefaultExport<Type<unknown>>>;
+    providers: (Provider | EnvironmentProviders)[];
+    title: string;
+    path: string;
+}
+/**
+ * The default data for a create route.
+ */
+export declare const defaultCreateDataRoute: Omit<CreateDataRoute, 'providers'>;

package/components/create-page/create-page.component.d.ts

@@ -0,0 +1,147 @@
+import { Location } from '@angular/common';
+import { HttpClient } from '@angular/common/http';
+import { ElementRef, EnvironmentInjector, InjectionToken, OnInit, Renderer2 } from '@angular/core';
+import { MatDialog } from '@angular/material/dialog';
+import { Observable } from 'rxjs';
+import { BaseEntityType, EntityClassNewable } from '../../classes/entity.model';
+import { NgxGlobalDefaultValues } from '../../global-configuration-values';
+import { EntityService } from '../../services/entity.service';
+import { EntityTab, EntityUtilities } from '../../utilities/entity.utilities';
+import { ValidationError } from '../../utilities/validation.utilities';
+import { ConfirmDialogData } from '../confirm-dialog/confirm-dialog-data';
+import { CreateEntityData } from '../table/create-dialog/create-entity-dialog-data';
+import { CreateData } from '../table/table-data';
+import { PageCreateDataInternal } from './page-create-data.builder';
+import * as i0 from "@angular/core";
+/**
+ * The data that needs to be provided for a route to be able to create a entity.
+ */
+export type PageCreateData<EntityType extends BaseEntityType<EntityType>> = Omit<CreateEntityData<EntityType>, 'entity' | 'EntityServiceClass'> & {
+    /**
+     * Whether or not to display a loading spinner while the data for the page is loaded.
+     * @default true
+     */
+    displayLoadingSpinner?: boolean;
+    /**
+     * The data of the default create page.
+     */
+    createData?: CreateData & {
+        /**
+         * The data for the dialog when the user tries to leave the site with unsaved changes.
+         */
+        confirmUnsavedChangesDialogData?: ConfirmDialogData;
+        /**
+         * Whether or not leaving with unsaved changes should require a confirm dialog.
+         * @default true
+         */
+        unsavedChangesRequireConfirmDialog?: boolean;
+    };
+};
+/**
+ * The entity service that needs to be provided in the providers array of the create page route.
+ */
+export declare const NGX_CREATE_DATA_ENTITY_SERVICE: InjectionToken<EntityService<any>>;
+/**
+ * The entity class that needs to be provided in the providers array of the create page route.
+ */
+export declare const NGX_CREATE_DATA_ENTITY: InjectionToken<EntityClassNewable<any>>;
+/**
+ * The configuration that needs to be provided in the providers array of the create page route.
+ */
+export declare const NGX_CREATE_DATA: InjectionToken<PageCreateData<any>>;
+/**
+ * A generic page that allows you to create a specific entity.
+ * For this to work you need to provide some data for the route.
+ */
+export declare class NgxMatEntityCreatePageComponent<EntityType extends BaseEntityType<EntityType>> implements OnInit {
+    private readonly dialog;
+    private readonly location;
+    private readonly injector;
+    readonly entityService: EntityService<EntityType>;
+    private readonly EntityClass;
+    private readonly inputData;
+    private readonly http;
+    private readonly el;
+    private readonly renderer;
+    protected readonly globalConfig: NgxGlobalDefaultValues;
+    /**
+     * Contains HelperMethods around handling Entities and their property-metadata.
+     */
+    EntityUtilities: typeof EntityUtilities;
+    /**
+     * The tabs to display.
+     */
+    entityTabs: EntityTab<EntityType>[];
+    /**
+     * The entity to create.
+     */
+    entity: EntityType;
+    /**
+     * The entity before any changes have been made.
+     * This is used to determine if leaving the page is possible without interruption.
+     */
+    entityPriorChanges: EntityType;
+    /**
+     * Configuration data for this component.
+     */
+    data: PageCreateDataInternal<EntityType>;
+    /**
+     * All validation errors of the entity.
+     */
+    validationErrors: ValidationError[];
+    /**
+     * Whether or not the entity is valid.
+     */
+    isEntityValid: boolean;
+    /**
+     * Whether or not the entity is dirty.
+     */
+    isEntityDirty: boolean;
+    /**
+     * What to display inside the tooltip.
+     */
+    tooltipContent: string;
+    private inConfirmNavigation;
+    get hasUnsavedChanges(): boolean;
+    constructor(dialog: MatDialog, location: Location, injector: EnvironmentInjector, entityService: EntityService<EntityType>, EntityClass: EntityClassNewable<EntityType>, inputData: PageCreateData<EntityType>, http: HttpClient, el: ElementRef, renderer: Renderer2, globalConfig: NgxGlobalDefaultValues);
+    ngOnInit(): void;
+    /**
+     * Whether the page can be left without confirmation (of unsaved changes).
+     * @returns Whether or not the page can be left without confirmation.
+     */
+    canDeactivate(): boolean;
+    /**
+     * Checks if the bottom row should be displayed as fixed.
+     */
+    checkOffset(): void;
+    /**
+     * Checks if the entity has become invalid or dirty.
+     */
+    checkEntity(): Promise<void>;
+    private checkIsEntityValid;
+    /**
+     * Tries create the entity and navigate back afterwards.
+     * Also handles the confirmation if required.
+     */
+    create(): void;
+    private confirmCreate;
+    /**
+     * Tries to navigate back.
+     */
+    navigateBack(): void;
+    /**
+     * Opens the confirm dialog for navigating with unsaved changes.
+     * This is exposed because the UnsavedChangesGuard needs to access this.
+     * @returns The first observable result of the confirm dialog.
+     */
+    openConfirmNavigationDialog(): Observable<boolean>;
+    private confirmNavigateBack;
+    /**
+     * Checks if the input with the given key is readonly.
+     * @param key - The key for the input to check.
+     * @returns Whether or not the input for the key is read only.
+     */
+    isReadOnly(key: keyof EntityType): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxMatEntityCreatePageComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityCreatePageComponent<any>, "ngx-mat-entity-create-page", never, {}, {}, never, never, true, never>;
+}

package/components/create-page/page-create-data.builder.d.ts

@@ -0,0 +1,18 @@
+import { BaseBuilder } from '../../classes/base.builder';
+import { BaseEntityType } from '../../classes/entity.model';
+import { NgxGlobalDefaultValues } from '../../global-configuration-values';
+import { ConfirmDialogDataInternal } from '../confirm-dialog/confirm-dialog-data.builder';
+import { CreateDataInternal } from '../table/create-dialog/create-data.builder';
+import { CreateEntityDataInternal } from '../table/create-dialog/create-entity-dialog-data.builder';
+import { PageCreateData } from './create-page.component';
+export type PageCreateDataInternal<EntityType extends BaseEntityType<EntityType>> = Omit<CreateEntityDataInternal<EntityType>, 'entity' | 'EntityServiceClass'> & {
+    displayLoadingSpinner: boolean;
+    createData: CreateDataInternal & {
+        confirmUnsavedChangesDialogData: ConfirmDialogDataInternal;
+        unsavedChangesRequireConfirmDialog: boolean;
+    };
+};
+export declare class PageCreateDataBuilder<EntityType extends BaseEntityType<EntityType>> extends BaseBuilder<PageCreateDataInternal<EntityType>, PageCreateData<EntityType>> {
+    constructor(data: PageCreateData<EntityType>, globalConfig: NgxGlobalDefaultValues);
+    protected generateBaseData(data: PageCreateData<EntityType>): PageCreateDataInternal<EntityType>;
+}

package/components/edit-page/edit-data.route.d.ts

@@ -10,4 +10,7 @@ export interface EditDataRoute extends Route {
     title: string;
     path: string;
 }
+/**
+ * The default data for a edit route.
+ */
 export declare const defaultEditDataRoute: Omit<EditDataRoute, 'providers'>;

package/components/edit-page/edit-page.component.d.ts

@@ -21,7 +21,6 @@ import * as i0 from "@angular/core";
 export type PageEditData<EntityType extends BaseEntityType<EntityType>> = Omit<EditEntityData<EntityType>, 'entity' | 'EntityServiceClass'> & {
     /**
      * Whether or not to display a loading spinner while the entity for the page is loaded.
-     *
      * @default true
      */
     displayLoadingSpinner?: boolean;
@@ -35,7 +34,6 @@ export type PageEditData<EntityType extends BaseEntityType<EntityType>> = Omit<E
         confirmUnsavedChangesDialogData?: ConfirmDialogData;
         /**
          * Whether or not leaving with unsaved changes should require a confirm dialog.
-         *
          * @default true
          */
         unsavedChangesRequireConfirmDialog?: boolean;
@@ -69,23 +67,55 @@ export declare class NgxMatEntityEditPageComponent<EntityType extends BaseEntity
     private readonly el;
     private readonly renderer;
     protected readonly globalConfig: NgxGlobalDefaultValues;
+    /**
+     * Contains HelperMethods around handling Entities and their property-metadata.
+     */
     EntityUtilities: typeof EntityUtilities;
+    /**
+     * The tabs to display.
+     */
     entityTabs: EntityTab<EntityType>[];
+    /**
+     * The entity that is being edited.
+     */
     entity: EntityType;
+    /**
+     * The entity before any changes have been made.
+     */
     entityPriorChanges: EntityType;
+    /**
+     * Configuration data for the component.
+     */
     data: PageEditDataInternal<EntityType>;
+    /**
+     * All validation errors of the entity.
+     */
     validationErrors: ValidationError[];
+    /**
+     * Whether or not the entity is valid.
+     */
     isEntityValid: boolean;
+    /**
+     * Whether or not the entity is dirty.
+     */
     isEntityDirty: boolean;
+    /**
+     * What to display inside the tooltip.
+     */
     tooltipContent: string;
+    /**
+     * Whether or not the entity is readonly.
+     */
     isEntityReadOnly: boolean;
+    /**
+     * Whether or not the current user is allowed to delete the entity.
+     */
     allowDelete: boolean;
     private inConfirmNavigation;
     get hasUnsavedChanges(): boolean;
     constructor(dialog: MatDialog, location: Location, route: ActivatedRoute, injector: EnvironmentInjector, entityService: EntityService<EntityType>, EntityClass: EntityClassNewable<EntityType>, inputData: PageEditData<EntityType>, http: HttpClient, el: ElementRef, renderer: Renderer2, globalConfig: NgxGlobalDefaultValues);
     /**
      * Checks if the input with the given key is readonly.
-     *
      * @param key - The key for the input to check.
      * @returns Whether or not the input for the key is read only.
      */
@@ -94,11 +124,9 @@ export declare class NgxMatEntityEditPageComponent<EntityType extends BaseEntity
     /**
      * Checks if the bottom row should be displayed as fixed.
      */
-    onScroll(): void;
-    private checkOffset;
+    checkOffset(): void;
     /**
      * Whether the page can be left without confirmation (of unsaved changes).
-     *
      * @returns Whether or not the page can be left without confirmation.
      */
     canDeactivate(): boolean;
@@ -126,21 +154,18 @@ export declare class NgxMatEntityEditPageComponent<EntityType extends BaseEntity
     /**
      * Opens the confirm dialog for navigating with unsaved changes.
      * This is exposed because the UnsavedChangesGuard needs to access this.
-     *
      * @returns The first observable result of the confirm dialog.
      */
     openConfirmNavigationDialog(): Observable<boolean>;
     private confirmNavigateBack;
     /**
      * Runs the edit action on the entity.
-     *
      * @param action - The action to run.
      */
     runEditAction(action: EditActionInternal<EntityType>): void;
     private confirmRunEditAction;
     /**
      * Checks if an EditAction is disabled (e.g. Because the current entry doesn't fullfil the requirements).
-     *
      * @param action - The EditAction to check.
      * @returns Whether or not the Action can be used.
      */

package/components/input/array/array-string-autocomplete-chips/array-string-autocomplete-chips.component.d.ts

@@ -1,22 +1,22 @@
 import { OnInit } from '@angular/core';
 import { MatAutocompleteSelectedEvent } from '@angular/material/autocomplete';
 import { BaseEntityType } from '../../../../classes/entity.model';
+import { AutocompleteStringChipsArrayDecoratorConfigInternal } from '../../../../decorators/array/array-decorator-internal.data';
 import { ArrayStringChipsInputComponent } from '../array-string-chips-input/array-string-chips-input.component';
 import * as i0 from "@angular/core";
 export declare class ArrayStringAutocompleteChipsComponent<EntityType extends BaseEntityType<EntityType>> extends ArrayStringChipsInputComponent<EntityType> implements OnInit {
     filteredAutocompleteStrings: string[];
-    get autocompleteValues(): string[];
+    get autocompleteStrings(): string[];
+    get autocompleteMetadata(): AutocompleteStringChipsArrayDecoratorConfigInternal;
     ngOnInit(): void;
     /**
      * Handles adding a string to the array when an autocomplete value has been selected.
-     *
      * @param event - The autocomplete selected event.
      * @param chipsInput - The element where the user typed the value.
      */
     selected(event: MatAutocompleteSelectedEvent, chipsInput: HTMLInputElement): void;
     /**
      * Dynamically filters the Autocomplete options when the user inputs something.
-     *
      * @param input - The input of the user.
      */
     filterAutocompleteStrings(input: unknown): void;

package/components/input/array/array-string-chips-input/array-string-chips-input.component.d.ts

@@ -15,7 +15,6 @@ export declare class ArrayStringChipsInputComponent<EntityType extends BaseEntit
      * mat-error. As the only validation for the array is whether or not
      * it contains values, we can set it to undefined when the last element is removed
      * (removeStringChipArrayValue). That way we can use the "required" validator.
-     *
      * @param event - The event that fires when a new chip is completed.
      */
     addStringChipArrayValue(event: MatChipInputEvent): void;
@@ -26,7 +25,6 @@ export declare class ArrayStringChipsInputComponent<EntityType extends BaseEntit
      * and the contents of the array. And we need a way to display an
      * mat-error. As the only validation for the array is whether or not
      * it is empty, setting it to undefined here enables us to use the "required" validator.
-     *
      * @param value - The string to remove from the array.
      */
     removeStringChipArrayValue(value: string): void;

package/components/input/array/array-table.class.d.ts

@@ -27,7 +27,6 @@ export declare abstract class ArrayTableComponent<ValueType, EntityType extends
     /**
      * Gets the value to display in the column.
      * Runs in environment context to enable injection.
-     *
      * @param entity - The entity to get the value from.
      * @param displayColumn - The display column to get the value from.
      * @returns The value of the display column.

package/components/input/base-input.component.d.ts

@@ -36,6 +36,9 @@ export declare abstract class NgxMatEntityBaseInputComponent<EntityType extends
      * In that case it is disabled, but most of the disabled-styling is overridden.
      */
     isReadOnly: boolean;
+    /**
+     * Emits when the property value has changed.
+     */
     inputChangeEvent: EventEmitter<void>;
     /**
      * The property value of entity[key] correctly typed.
@@ -48,9 +51,9 @@ export declare abstract class NgxMatEntityBaseInputComponent<EntityType extends
      */
     metadata: DecoratorType<Type, CustomMetadataType>;
     /**
-     * A uuid that is used to specify unique name values for inputs.
+     * A unique name for inputs. Includes a uuid.
      */
-    uuid: string;
+    name: string;
     ngOnInit(): void;
     /**
      * Should emit when the input has changed. This is needed to trigger validation and dirty checks.

package/components/input/boolean/boolean-checkbox-input/boolean-checkbox-input.component.d.ts

@@ -4,7 +4,6 @@ import { DecoratorTypes } from '../../../../decorators/base/decorator-types.enum
 import { NgxMatEntityBaseInputComponent } from '../../base-input.component';
 import * as i0 from "@angular/core";
 export declare class BooleanCheckboxInputComponent<EntityType extends BaseEntityType<EntityType>> extends NgxMatEntityBaseInputComponent<EntityType, DecoratorTypes.BOOLEAN_CHECKBOX, boolean> implements OnInit {
-    ngOnInit(): void;
     updatePropertyValue(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BooleanCheckboxInputComponent<any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BooleanCheckboxInputComponent<any>, "boolean-checkbox-input", never, {}, {}, never, never, false, never>;

package/components/input/boolean/boolean-toggle-input/boolean-toggle-input.component.d.ts

@@ -4,7 +4,6 @@ import { DecoratorTypes } from '../../../../decorators/base/decorator-types.enum
 import { NgxMatEntityBaseInputComponent } from '../../base-input.component';
 import * as i0 from "@angular/core";
 export declare class BooleanToggleInputComponent<EntityType extends BaseEntityType<EntityType>> extends NgxMatEntityBaseInputComponent<EntityType, DecoratorTypes.BOOLEAN_TOGGLE, boolean> implements OnInit {
-    ngOnInit(): void;
     updatePropertyValue(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BooleanToggleInputComponent<any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BooleanToggleInputComponent<any>, "boolean-toggle-input", never, {}, {}, never, never, false, never>;

package/components/input/date/date-range-input/date-range-input.component.d.ts

@@ -8,12 +8,8 @@ import { NgxMatEntityBaseInputComponent } from '../../base-input.component';
 import * as i0 from "@angular/core";
 export declare class DateRangeInputComponent<EntityType extends BaseEntityType<EntityType>> extends NgxMatEntityBaseInputComponent<EntityType, DecoratorTypes.DATE_RANGE, DateRange> implements OnInit {
     private readonly globalConfig;
-    get dateRange(): DateRange;
-    set dateRange(value: DateRange);
-    get dateRangeStart(): Date | undefined;
-    set dateRangeStart(value: Date | undefined);
-    get dateRangeEnd(): Date | undefined;
-    set dateRangeEnd(value: Date | undefined);
+    dateRangeStart?: Date;
+    dateRangeEnd?: Date;
     defaultDateFilter: DateFilterFn<Date | null | undefined>;
     constructor(globalConfig: NgxGlobalDefaultValues);
     ngOnInit(): void;

package/components/input/date/date-time-input/date-time-input.component.d.ts

@@ -19,7 +19,6 @@ export declare class DateTimeInputComponent<EntityType extends BaseEntityType<En
     ngOnInit(): void;
     /**
      * Checks if two times are equal. Is needed for the dropdown.
-     *
      * @param time1 - The first time to compare.
      * @param time2 - The second time to compare.
      * @returns Whether or not the time objects are the same.

package/components/input/file/file-input/file-input.component.d.ts

@@ -20,6 +20,7 @@ export declare class FileInputComponent<EntityType extends BaseEntityType<Entity
     getValidationErrorMessage: (model: NgModel) => string;
     isReadOnly: boolean;
     fileDataChangeEvent: EventEmitter<FileData | FileData[]>;
+    acceptString: string;
     constructor(dialog: MatDialog, http: HttpClient);
     ngOnInit(): Promise<void>;
     private initMultiFile;