ngx-material-entity 18.2.5 → 20.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-material-entity",
-  "version": "18.2.5",
+  "version": "20.0.0",
   "license": "MIT",
   "keywords": [
     "angular",
@@ -9,21 +9,21 @@
     "entity"
   ],
   "peerDependencies": {
-    "@angular/animations": "18",
-    "@angular/cdk": "18",
-    "@angular/common": "18",
-    "@angular/core": "18",
-    "@angular/forms": "18",
-    "@angular/material": "18",
+    "@angular/animations": "20",
+    "@angular/cdk": "20",
+    "@angular/common": "20",
+    "@angular/core": "20",
+    "@angular/forms": "20",
+    "@angular/material": "20",
     "js2xmlparser": "^5.0.0",
     "jszip": "^3.10.1",
     "lodash": "4",
     "uuid": "9",
-    "@fortawesome/angular-fontawesome": "^0.15",
-    "@fortawesome/free-solid-svg-icons": "^6"
+    "@fortawesome/angular-fontawesome": "^3",
+    "@fortawesome/free-solid-svg-icons": "^7"
   },
   "dependencies": {
-    "tslib": "^2.6.2"
+    "tslib": "^2.8.1"
   },
   "module": "fesm2022/ngx-material-entity.mjs",
   "typings": "index.d.ts",
@@ -33,8 +33,6 @@
     },
     ".": {
       "types": "./index.d.ts",
-      "esm2022": "./esm2022/ngx-material-entity.mjs",
-      "esm": "./esm2022/ngx-material-entity.mjs",
       "default": "./fesm2022/ngx-material-entity.mjs"
     }
   },

package/classes/base.builder.d.ts

@@ -1,37 +0,0 @@
-import { BaseEntityType } from './entity.model';
-import { NgxGlobalDefaultValues } from '../global-configuration-values';
-/**
- * The abstract BaseBuilder class.
- */
-export declare abstract class BaseBuilder<InternalType extends InputType, InputType extends BaseEntityType<InputType>> {
-    private readonly data;
-    private readonly inputData?;
-    /**
-     * The global configuration, is used for providing default values to fallback to.
-     */
-    protected readonly globalConfig: NgxGlobalDefaultValues;
-    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.
-     */
-    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,27 +0,0 @@
-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.
- */
-export type BaseEntityType<T> = {
-    [K in keyof T]: unknown;
-};
-/**
- * A base Entity class with a builtin id.
- */
-export declare abstract class Entity {
-    /**
-     * A unique identifier for the Entity.
-     */
-    readonly id: string;
-    constructor(entity?: Entity);
-}

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

@@ -1,24 +0,0 @@
-import { ConfirmDialogData, ConfirmDialogTypes } from './confirm-dialog-data';
-import { BaseBuilder } from '../../classes/base.builder';
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-/**
- * The internal ConfirmDialogData. Requires all default values the user can leave out.
- */
-export declare class ConfirmDialogDataInternal implements ConfirmDialogData {
-    text: string[];
-    type: ConfirmDialogTypes;
-    confirmButtonLabel: string;
-    cancelButtonLabel: string;
-    title: string;
-    requireConfirmation: boolean;
-    confirmationText?: string;
-    constructor(text: string[], type: ConfirmDialogTypes, confirmButtonLabel: string, cancelButtonLabel: string, title: string, requireConfirmation: boolean, confirmationText?: string);
-}
-/**
- * The Builder for the ConfirmDialogData. Sets default values.
- */
-export declare class ConfirmDialogDataBuilder extends BaseBuilder<ConfirmDialogDataInternal, ConfirmDialogData> {
-    constructor(globalConfig: NgxGlobalDefaultValues, data?: ConfirmDialogData);
-    protected generateBaseData(data?: ConfirmDialogData): ConfirmDialogDataInternal;
-    protected validateInput(data?: ConfirmDialogData): void;
-}

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

@@ -1,48 +0,0 @@
-/**
- * The different types of a confirm dialog.
- * Is used for displaying different buttons accordingly.
- */
-export type ConfirmDialogTypes = 'default' | 'delete' | 'info-only';
-/**
- * The Definition of the Confirm Dialog Data.
- */
-export interface ConfirmDialogData {
-    /**
-     * An array of paragraphs to display inside the dialog body.
-     */
-    text?: string[];
-    /**
-     * The type of the Confirm Dialog. Changes the button layout. Can be either:
-     *
-     * 'default': A confirm- and a cancel-button.
-     *
-     * 'delete': Like default but the confirm-button is red.
-     *
-     * 'info-only': Only a cancel-button.
-     */
-    type?: ConfirmDialogTypes;
-    /**
-     * 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;
-    /**
-     * The title of the dialog.
-     */
-    title?: string;
-    /**
-     * Whether or not a checkbox needs to be selected before the user can confirm the dialog.
-     * @default false
-     */
-    requireConfirmation?: boolean;
-    /**
-     * The text to display on the checkbox if 'requireConfirmation' is set to true.
-     */
-    confirmationText?: string;
-}

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

@@ -1,36 +0,0 @@
-import { OnInit } from '@angular/core';
-import { MatDialogRef } from '@angular/material/dialog';
-import { ConfirmDialogData } from './confirm-dialog-data';
-import { ConfirmDialogDataInternal } from './confirm-dialog-data.builder';
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-import * as i0 from "@angular/core";
-/**
- * The Dialog used whenever confirmation by the user is required (e.g. When the user tries to delete an entity).
- *
- * Can be customized with the MAT_DIALOG_DATA "inputData". Customization options are defined in "ConfirmDialogData".
- */
-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;
-    /**
-     * Closes the dialog with true to signal that the action should be run.
-     */
-    confirmAction(): void;
-    /**
-     * Closes the dialog.
-     */
-    cancel(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxMatEntityConfirmDialogComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityConfirmDialogComponent, "ngx-mat-entity-confirm-dialog", never, {}, {}, never, never, true, never>;
-}

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

@@ -1,16 +0,0 @@
-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

@@ -1,141 +0,0 @@
-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 { IconDefinition } from '@fortawesome/angular-fontawesome';
-import { PageCreateDataInternal } from './page-create-data.builder';
-import { BaseEntityType, EntityClassNewable } from '../../classes/entity.model';
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-import { EntityService } from '../../services/entity.service';
-import { UnsavedChangesPage } from '../../services/unsaved-changes.guard';
-import { 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-data';
-import { CreateData } from '../table/table-data';
-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, UnsavedChangesPage {
-    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;
-    faChevronLeft: IconDefinition;
-    faWarning: IconDefinition;
-    /**
-     * Contains HelperMethods around handling Entities and their property-metadata.
-     */
-    EntityUtilities: typeof EntityUtilities;
-    /**
-     * 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;
-    /**
-     * Whether or not the page has been loaded.
-     */
-    isLoaded: boolean;
-    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;
-    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(): Promise<void>;
-    private confirmCreate;
-    /**
-     * Tries to navigate back.
-     */
-    navigateBack(): Promise<void>;
-    openConfirmNavigationDialog(): Promise<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

@@ -1,18 +0,0 @@
-import { PageCreateData } from './create-page.component';
-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-data.builder';
-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/custom-table/custom-table-configuration.model.d.ts

@@ -1,65 +0,0 @@
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-import { DisplayColumn, DynamicStyleClasses } from '../table/table-data';
-/**
- * Configuration for the custom table.
- */
-export interface CustomTableConfiguration<T = unknown> {
-    /**
-     * Configuration for css classes that should be applied to table rows based on a condition.
-     * This could be used to eg. Set the background color to green when an item has the status completed etc.
-     * INFO: You need to use ng-deep or apply the styling in the styles.scss.
-     * @default () => []
-     */
-    dynamicRowStyleClasses?: DynamicStyleClasses<T>;
-    /**
-     * The columns to display inside the custom table.
-     */
-    displayColumns: DisplayColumn<T>[];
-    /**
-     * Whether or not a loading spinner should be shown.
-     * Only works when you provide the "loading" input to the custom table.
-     * @default true
-     */
-    displayLoadingSpinner?: boolean;
-    /**
-     * Whether or not the select column should be enabled.
-     * @default true
-     */
-    withSelection: boolean;
-    /**
-     * A function that resolves a row value to a string that can be searched for.
-     * By default this uses a built in search filter.
-     */
-    searchStringForRow?: (value: T) => string;
-    /**
-     * Whether or not the user is allowed to click on entries in the custom table.
-     * @default () => true
-     */
-    allowClick?: (value: T) => boolean;
-    /**
-     * An error message to show when the table contains no entries.
-     * Also applies styling to the table.
-     */
-    emptyErrorMessage?: string;
-    /**
-     * Resolves the given id for an entity.
-     * This is used for the referencesMany input,
-     * where you want to show values of the entity in the table rows and not the id.
-     */
-    resolveToReferencedEntity?: (id: unknown) => unknown;
-}
-/**
- * Internal configuration for the custom table.
- * Provides default values.
- */
-export declare class InternalCustomTableConfiguration<T = unknown> implements CustomTableConfiguration<T> {
-    dynamicRowStyleClasses: DynamicStyleClasses<T>;
-    displayColumns: DisplayColumn<T>[];
-    displayLoadingSpinner: boolean;
-    withSelection: boolean;
-    searchStringForRow: (value: T) => string;
-    allowClick: (value: T) => boolean;
-    emptyErrorMessage: string;
-    resolveToReferencedEntity?: (id: unknown) => unknown;
-    constructor(globalConfig: NgxGlobalDefaultValues, configuration: CustomTableConfiguration<T>);
-}

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

@@ -1,111 +0,0 @@
-import { SelectionModel } from '@angular/cdk/collections';
-import { EnvironmentInjector, EventEmitter, OnInit } from '@angular/core';
-import { MatCheckboxChange } from '@angular/material/checkbox';
-import { MatTableDataSource } from '@angular/material/table';
-import { CustomTableConfiguration, InternalCustomTableConfiguration } from './custom-table-configuration.model';
-import { BaseEntityType } from '../../classes/entity.model';
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-import { SelectionUtilities } from '../../utilities/selection.utilities';
-import { DisplayColumn, TableColumnValue } from '../table/table-data';
-import * as i0 from "@angular/core";
-/**
- * The event for clicking on a table cell.
- */
-export type CellClickedEvent<T> = {
-    /**
-     * The column that was clicked.
-     */
-    displayColumn: DisplayColumn<T>;
-    /**
-     * The value of the row that was clicked.
-     */
-    value: T;
-};
-/**
- * A custom table that has things like sorting and pagination already built in.
- */
-export declare class CustomTableComponent<T, EntityType extends BaseEntityType<EntityType>> implements OnInit {
-    private readonly injector;
-    private readonly globalConfig;
-    SelectionUtilities: typeof SelectionUtilities;
-    /**
-     * Updates the table entries.
-     */
-    set data(value: T[]);
-    /**
-     * Applies the given string as a filter to the table.
-     */
-    set searchString(value: string);
-    set required(value: boolean);
-    /**
-     * Whether or not the table should show an error message when the table is empty.
-     */
-    shouldShowMissingError: boolean;
-    /**
-     * Whether or not the table data is currently loading.
-     */
-    isLoading: boolean;
-    /**
-     * The configuration of the table.
-     */
-    configuration: CustomTableConfiguration<T>;
-    internalConfiguration: InternalCustomTableConfiguration<T>;
-    /**
-     * Emits when a cell is clicked that is neither disabled nor disallowed to be clicked.
-     */
-    readonly cellClicked: EventEmitter<CellClickedEvent<T>>;
-    /**
-     * Emits when the selected values change.
-     */
-    readonly selectionChanged: EventEmitter<T[]>;
-    /**
-     * The paginator from the html.
-     */
-    private readonly paginator;
-    /**
-     * The sort from the html.
-     */
-    private readonly sort;
-    /**
-     * The data source for the table.
-     */
-    dataSource: MatTableDataSource<T>;
-    /**
-     * The selection of the table.
-     */
-    selection: SelectionModel<T>;
-    /**
-     * The columns of the table.
-     */
-    displayedColumns: string[];
-    constructor(injector: EnvironmentInjector, globalConfig: NgxGlobalDefaultValues);
-    ngOnInit(): void;
-    private setupDataSource;
-    /**
-     * Emits a cellClicked event when the clicked column is enabled and clicking is allowed by the configuration.
-     * @param value - The value of the row that was clicked.
-     * @param dCol - The display column of the row that was clicked.
-     */
-    clickCell(value: T, dCol: DisplayColumn<T>): void;
-    /**
-     * Toggles a single table row.
-     * @param value - The value of the row that was clicked.
-     * @param event - The change event from the checkbox.
-     */
-    toggle(value: T, event?: MatCheckboxChange): void;
-    /**
-     * Toggles all table rows.
-     * @param event - The change event from the checkbox.
-     */
-    masterToggle(event?: MatCheckboxChange): void;
-    /**
-     * Gets the value to display in the column.
-     * Runs in environment context to enable injection.
-     * @param value - The column value to get the display string from.
-     * @param displayColumn - The display column to get the value from.
-     * @returns The value of the display column.
-     */
-    getDisplayColumnValue(value: T, displayColumn: DisplayColumn<T>): TableColumnValue;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CustomTableComponent<any, any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CustomTableComponent<any, any>, "custom-table", never, { "data": { "alias": "data"; "required": true; }; "searchString": { "alias": "searchString"; "required": false; }; "required": { "alias": "required"; "required": false; }; "isLoading": { "alias": "isLoading"; "required": false; }; "configuration": { "alias": "configuration"; "required": true; }; }, { "cellClicked": "cellClicked"; "selectionChanged": "selectionChanged"; }, never, never, true, never>;
-}

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

@@ -1,16 +0,0 @@
-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 "NgxMatEntityEditPageComponent".
- */
-export interface EditDataRoute 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 edit route.
- */
-export declare const defaultEditDataRoute: Omit<EditDataRoute, 'providers'>;