ngx-material-entity 18.2.5 → 20.0.0

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

@@ -1,102 +0,0 @@
-import { CreateDataInternal } from './create-dialog/create-data.builder';
-import { EditDataInternal } from './edit-dialog/edit-data.builder';
-import { BaseData, BaseTableAction, DisplayColumn, DynamicStyleClasses, MultiSelectAction, TableData } from './table-data';
-import { BaseBuilder } from '../../classes/base.builder';
-import { BaseEntityType, EntityClassNewable, EntityServiceClassNewable } from '../../classes/entity.model';
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-import { ConfirmDialogDataInternal } from '../confirm-dialog/confirm-dialog-data.builder';
-/**
- * The internal BaseTableAction. Sets default values.
- */
-export declare class BaseTableActionInternal implements BaseTableAction {
-    protected readonly globalConfig: NgxGlobalDefaultValues;
-    type: 'default';
-    displayName: string;
-    action: () => Promise<unknown>;
-    enabled: (() => boolean);
-    requireConfirmDialog: (() => boolean);
-    confirmDialogData: ConfirmDialogDataInternal;
-    constructor(data: BaseTableAction, globalConfig: NgxGlobalDefaultValues);
-    private functionToAsync;
-}
-/**
- * The internal BaseTableAction. Sets default values.
- */
-export declare class MultiSelectActionInternal<EntityType extends BaseEntityType<EntityType>> implements MultiSelectAction<EntityType> {
-    protected readonly globalConfig: NgxGlobalDefaultValues;
-    type: 'multi-select';
-    displayName: string;
-    action: (selectedEntities: EntityType[]) => Promise<unknown>;
-    enabled: ((selectedEntities: EntityType[]) => boolean);
-    requireConfirmDialog: ((selectedEntities: EntityType[]) => boolean);
-    confirmDialogData: ConfirmDialogDataInternal;
-    constructor(data: MultiSelectAction<EntityType>, globalConfig: NgxGlobalDefaultValues);
-    private functionToAsync;
-}
-/**
- * The Internal Table Action. Sets default values.
- */
-export type TableActionInternal<EntityType extends BaseEntityType<EntityType>> = BaseTableActionInternal | MultiSelectActionInternal<EntityType>;
-/**
- * The internal TableData. Requires all default values the user can leave out.
- */
-export declare class TableDataInternal<EntityType extends BaseEntityType<EntityType>> implements TableData<EntityType> {
-    baseData: BaseDataInternal<EntityType>;
-    createData: CreateDataInternal;
-    editData: EditDataInternal<EntityType>;
-    constructor(baseData: BaseDataInternal<EntityType>, createData: CreateDataInternal, editData: EditDataInternal<EntityType>);
-}
-/**
- * The Builder for the table BaseData. Sets default values.
- */
-export declare class BaseDataBuilder<EntityType extends BaseEntityType<EntityType>> extends BaseBuilder<BaseDataInternal<EntityType>, BaseData<EntityType>> {
-    constructor(data: BaseData<EntityType>, globalConfig: NgxGlobalDefaultValues);
-    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 BaseEntityType<EntityType>> implements BaseData<EntityType> {
-    protected readonly globalConfig: NgxGlobalDefaultValues;
-    title: string;
-    displayColumns: DisplayColumn<EntityType>[];
-    EntityServiceClass: EntityServiceClassNewable<EntityType>;
-    searchLabel: string;
-    createButtonLabel: string;
-    defaultEdit: 'dialog' | 'page';
-    defaultCreate: 'dialog' | 'page';
-    searchString: (entity: EntityType) => string;
-    allowCreate: () => boolean;
-    allowRead: (entity?: EntityType) => boolean;
-    allowUpdate: (entity?: EntityType) => boolean;
-    allowDelete: (entity?: EntityType) => boolean;
-    tableActions: TableActionInternal<EntityType>[];
-    tableActionsLabel: string;
-    displayLoadingSpinner: boolean;
-    allowJsonImport: boolean;
-    importActionData: Omit<BaseTableActionInternal, 'action'>;
-    dynamicRowStyleClasses: DynamicStyleClasses<EntityType>;
-    EntityClass?: EntityClassNewable<EntityType>;
-    edit?: (entity: EntityType) => unknown;
-    create?: (entity: EntityType) => unknown;
-    constructor(data: BaseData<EntityType>, globalConfig: NgxGlobalDefaultValues);
-    private buildImportActionData;
-    private allowDataToFunction;
-}
-/**
- * The Builder for the complete TableData. Sets default values and validates user input.
- */
-export declare class TableDataBuilder<EntityType extends BaseEntityType<EntityType>> extends BaseBuilder<TableDataInternal<EntityType>, TableData<EntityType>> {
-    constructor(globalConfig: NgxGlobalDefaultValues, data: TableData<EntityType>);
-    protected generateBaseData(data: TableData<EntityType>): TableDataInternal<EntityType>;
-    protected validateInput(data: TableData<EntityType>): void;
-}
-/**
- * The default search function taken from googles mat table.
- * This will be used if no custom search function is provided by the configuration.
- *
- * It generates a string from an entity which is then used to compare it to the search input.
- * @param entity - An entity that is in the search.
- * @returns The generated string of the given entity used for comparison with the search input.
- */
-export declare function defaultSearchFunction<EntityType extends BaseEntityType<EntityType>>(entity: EntityType): string;

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

@@ -1,340 +0,0 @@
-import { Type } from '@angular/core';
-import { NgxMatEntityBaseDisplayColumnValueComponent } from './display-column-value/base-display-column-value.component';
-import { BaseEntityType, EntityClassNewable, EntityServiceClassNewable } from '../../classes/entity.model';
-import { ConfirmDialogData } from '../confirm-dialog/confirm-dialog-data';
-/**
- * The value that can be displayed inside a table column.
- */
-export type TableColumnValue = string | number | Date;
-/**
- * The Definition of a Column inside the table.
- */
-export interface DisplayColumn<T> {
-    /**
-     * The name inside the header.
-     */
-    displayName: string;
-    /**
-     * What to display inside the row.
-     */
-    value: (value: T) => TableColumnValue;
-    /**
-     * A custom component to use instead of the value.
-     * You still need to provide a value function for the sorting by header to work.
-     */
-    Component?: Type<NgxMatEntityBaseDisplayColumnValueComponent<T>>;
-    /**
-     * Whether or not the click event should be disabled.
-     * This can be useful if your component has a custom way to handle clicks.
-     */
-    disableClick?: boolean;
-}
-/**
- * Dynamic css class that should be applied based on a condition.
- */
-export type DynamicStyleClasses<T> = (value: T) => string[];
-/**
- * A table action that will run regardless if something has been selected in the table.
- */
-export interface BaseTableAction {
-    /**
-     * The type of the table action to distinct between base and multi-select actions.
-     */
-    type: 'default';
-    /**
-     * The name of the action.
-     */
-    displayName: string;
-    /**
-     * The action itself.
-     */
-    action: (() => unknown) | (() => Promise<unknown>);
-    /**
-     * A method that defines whether or not the action can be used.
-     * @default () => true
-     */
-    enabled?: () => boolean;
-    /**
-     * A method that defines whether or not a confirm dialog is needed to run the action.
-     * @default false
-     */
-    requireConfirmDialog?: () => boolean;
-    /**
-     * The data used to generate a confirmation dialog for the table action.
-     */
-    confirmDialogData?: ConfirmDialogData;
-}
-/**
- * The Definition of an Action that can be run on multiple selected entities.
- */
-export interface MultiSelectAction<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The type of the table action to distinct between base and multi-select actions.
-     */
-    type: 'multi-select';
-    /**
-     * The name of the action.
-     */
-    displayName: string;
-    /**
-     * The action itself.
-     */
-    action: ((selectedEntities: EntityType[]) => unknown) | ((selectedEntities: EntityType[]) => Promise<unknown>);
-    /**
-     * A method that defines whether or not the action can be used.
-     * @default (selectedEntities: EntityType[]) => !!selectedEntities.length
-     */
-    enabled?: (selectedEntities: EntityType[]) => boolean;
-    /**
-     * A method that defines whether or not a confirm dialog is needed to run the action.
-     * @default false
-     */
-    requireConfirmDialog?: (selectedEntities: EntityType[]) => boolean;
-    /**
-     * The data used to generate a confirmation dialog for the table action.
-     */
-    confirmDialogData?: ConfirmDialogData;
-}
-/**
- * An action for the table. Can either be independent or run on the selected entities in the table.
- */
-export type TableAction<EntityType extends BaseEntityType<EntityType>> = BaseTableAction | MultiSelectAction<EntityType>;
-/**
- * The base data of the ngx-mat-entity-table.
- */
-export interface BaseData<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The title of the table.
-     */
-    title: string;
-    /**
-     * 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: DisplayColumn<EntityType>[];
-    /**
-     * The Class of the service that handles the entities.
-     * Needs to be injectable and an extension of the "EntityService"-Class.
-     */
-    EntityServiceClass: EntityServiceClassNewable<EntityType>;
-    /**
-     * The Class of the entities to manage.
-     */
-    EntityClass?: EntityClassNewable<EntityType>;
-    /**
-     * The label on the search bar. Defaults to "Search".
-     */
-    searchLabel?: string;
-    /**
-     * The label on the button for adding new entities. Defaults to "Create".
-     */
-    createButtonLabel?: string;
-    /**
-     * Whether editing happens in a dialog or a separate page.
-     */
-    defaultEdit?: 'dialog' | 'page';
-    /**
-     * Whether creating happens in a dialog or a separate page.
-     */
-    defaultCreate?: 'dialog' | 'page';
-    /**
-     * Takes a custom edit method which runs when you click on a entity.
-     * If you don't need any special editing of entries you can also omit this.
-     * In that case a default edit dialog is generated.
-     */
-    edit?: (entity: EntityType) => unknown;
-    /**
-     * Takes a method to run when you click on the new button.
-     * If you don't need anything special you can also omit this.
-     * In that case a default create dialog is generated.
-     */
-    create?: (entity: EntityType) => unknown;
-    /**
-     * Defines how the search string of entities is generated.
-     */
-    searchString?: (entity: EntityType) => string;
-    /**
-     * Defines whether or not the user can add new entities.
-     * @default () => true
-     */
-    allowCreate?: boolean | (() => boolean);
-    /**
-     * Defines whether or not the user can view the specific entity.
-     * @default () => true
-     */
-    allowRead?: boolean | ((entity?: EntityType) => boolean);
-    /**
-     * Defines whether or not the user can edit the specific entity.
-     * @default () => true
-     */
-    allowUpdate?: boolean | ((entity?: EntityType) => boolean);
-    /**
-     * Whether or not the user can delete this specific entity.
-     * @default () => true
-     */
-    allowDelete?: boolean | ((entity?: EntityType) => boolean);
-    /**
-     * All Actions that you want to run on the table can be defined here.
-     * (e.g. Download as zip-file, import or mass delete).
-     */
-    tableActions?: TableAction<EntityType>[];
-    /**
-     * The Label for the button that opens all table-actions.
-     */
-    tableActionsLabel?: string;
-    /**
-     * Whether or not to display a loading spinner while the entities of the table are loaded.
-     * @default true
-     */
-    displayLoadingSpinner?: boolean;
-    /**
-     * Whether or not JSON imports are allowed.
-     * This adds an table select action.
-     * @default false
-     */
-    allowJsonImport?: boolean;
-    /**
-     * Data to customize the json import action.
-     */
-    importActionData?: Omit<BaseTableAction, 'action' | 'requireConfirmDialog' | 'type'>;
-    /**
-     * 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<EntityType>;
-}
-/**
- * The data of the default create-dialog.
- */
-export interface CreateData {
-    /**
-     * The title of the default create-dialog.
-     */
-    title?: string;
-    /**
-     * The label on the create-button of the default create-dialog. Defaults to "Create".
-     */
-    createButtonLabel?: string;
-    /**
-     * The label on the cancel-button for the default create-dialog. Defaults to "Cancel".
-     */
-    cancelButtonLabel?: string;
-    /**
-     * Whether or not the creation of an entry should require a confirm dialog.
-     */
-    createRequiresConfirmDialog?: boolean;
-    /**
-     * The data used to generate a confirmation dialog for the create action.
-     */
-    confirmCreateDialogData?: ConfirmDialogData;
-    /**
-     * Whether or not cancelling with unsaved changes should require a confirm dialog.
-     */
-    unsavedChangesRequireConfirmDialog?: boolean;
-    /**
-     * The data used to generate a confirmation dialog for the cancel with unsaved changes action.
-     */
-    confirmUnsavedChangesDialogData?: ConfirmDialogData;
-}
-/**
- * An action that can be run from inside the edit dialog or page.
- */
-export interface EditAction<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The name of the action.
-     */
-    displayName: string;
-    /**
-     * The action itself.
-     */
-    action: ((entity: EntityType, entityPriorChanges: EntityType) => unknown) | ((entity: EntityType, entityPriorChanges: EntityType) => Promise<unknown>);
-    /**
-     * A method that defines whether or not the action can be used.
-     * @default () => true
-     */
-    enabled?: (e: EntityType) => boolean;
-    /**
-     * A method that defines whether or not a confirm dialog is needed to run the action.
-     * @default false
-     */
-    requireConfirmDialog?: (e: EntityType) => boolean;
-    /**
-     * The data used to generate a confirmation dialog for the action.
-     */
-    confirmDialogData?: ConfirmDialogData;
-}
-/**
- * The data of the default edit-dialog or page.
- */
-export interface EditData<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The title of the default edit-dialog.
-     */
-    title?: (entity: EntityType) => string;
-    /**
-     * The label on the confirm-button of the default edit-dialog or page. Defaults to "Save".
-     */
-    confirmButtonLabel?: string;
-    /**
-     * The label on the delete-button of the default edit-dialog or page. Defaults to "Delete".
-     */
-    deleteButtonLabel?: string;
-    /**
-     * The label on the cancel-button for the default edit-dialog or page. Defaults to "Cancel".
-     */
-    cancelButtonLabel?: string;
-    /**
-     * Whether or not the deletion of an entry should require a confirm dialog.
-     */
-    deleteRequiresConfirmDialog?: boolean;
-    /**
-     * Whether or not the editing of an entry should require a confirm dialog.
-     */
-    editRequiresConfirmDialog?: boolean;
-    /**
-     * The data used to generate a confirmation dialog for the delete action.
-     */
-    confirmDeleteDialogData?: ConfirmDialogData;
-    /**
-     * The data used to generate a confirmation dialog for the edit action.
-     */
-    confirmEditDialogData?: ConfirmDialogData;
-    /**
-     * Whether or not cancelling with unsaved changes should require a confirm dialog.
-     */
-    unsavedChangesRequireConfirmDialog?: boolean;
-    /**
-     * The data used to generate a confirmation dialog for the cancel with unsaved changes action.
-     */
-    confirmUnsavedChangesDialogData?: ConfirmDialogData;
-    /**
-     * The label of the actions button.
-     */
-    actionsLabel?: string;
-    /**
-     * All actions of the edit page/dialog.
-     */
-    actions?: EditAction<EntityType>[];
-}
-/**
- * All the configuration data required to display a ngx-mat-entity-table.
- */
-export interface TableData<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The base data for the table-component.
-     * Includes stuff like the title for the table, what to display inside the rows etc.
-     */
-    baseData: BaseData<EntityType>;
-    /**
-     * The data for the default create-dialog.
-     * Can be omitted when specifying a custom "create" method inside the baseData.
-     */
-    createData?: CreateData;
-    /**
-     * The data for the default edit-dialog.
-     * Can be omitted when specifying a custom "edit" method inside the baseData.
-     */
-    editData?: EditData<EntityType>;
-}

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

@@ -1,119 +0,0 @@
-import { EnvironmentInjector, EventEmitter, OnInit } from '@angular/core';
-import { MatDialog } from '@angular/material/dialog';
-import { Router } from '@angular/router';
-import { DisplayColumn, TableData } from './table-data';
-import { BaseTableActionInternal, TableActionInternal, TableDataInternal } from './table-data.builder';
-import { BaseEntityType, Entity } from '../../classes/entity.model';
-import { NgxGlobalDefaultValues } from '../../global-configuration-values';
-import { CustomTableConfiguration } from '../custom-table/custom-table-configuration.model';
-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 BaseEntityType<Entity>> implements OnInit {
-    private readonly dialog;
-    private readonly injector;
-    private readonly router;
-    private readonly globalConfig;
-    /**
-     * The configuration for the component.
-     */
-    tableData: TableData<EntityType>;
-    /**
-     * Emits when there are unsaved changes on either the create or update dialog.
-     */
-    readonly unsavedDialogChanges: EventEmitter<boolean>;
-    /**
-     * The internal TableData.
-     */
-    data: TableDataInternal<EntityType>;
-    /**
-     * Configuration for the table.
-     */
-    tableConfig: CustomTableConfiguration<EntityType>;
-    /**
-     * The entities to display inside the table.
-     */
-    entities: EntityType[];
-    /**
-     * A search string for filtering table results.
-     */
-    searchString: string;
-    /**
-     * The currently selected entities.
-     */
-    selected: EntityType[];
-    /**
-     * Whether or not the table content is currently loading.
-     */
-    isLoading: boolean;
-    /**
-     * Whether or not the current user is allowed to create entries for the table.
-     */
-    allowCreate: boolean;
-    private entityService;
-    /**
-     * The internal BaseTableAction. Sets default values.
-     */
-    importAction: BaseTableActionInternal;
-    constructor(dialog: MatDialog, injector: EnvironmentInjector, router: Router, globalConfig: NgxGlobalDefaultValues);
-    /**
-     * Sets up all the configuration for the table and the EntityService.
-     */
-    ngOnInit(): void;
-    /**
-     * 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.
-     */
-    getDisplayColumnValue(entity: EntityType, displayColumn: DisplayColumn<EntityType>): unknown;
-    private startImportJson;
-    private importJson;
-    /**
-     * 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;
-    /**
-     * Whether updating the provided entity is allowed.
-     * @param entity - The entity that the user wants to edit.
-     * @returns True when the user can edit the provided entity and false otherwise.
-     */
-    allowUpdate(entity: EntityType): boolean;
-    /**
-     * Whether viewing the provided entity is allowed.
-     * @param entity - The entity that the user wants to view.
-     * @returns True when the user can view the provided entity and false otherwise.
-     */
-    allowRead(entity: EntityType): boolean;
-    private editDefaultPage;
-    private editDefaultDialog;
-    /**
-     * 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 createDefaultPage;
-    private createDefaultDialog;
-    /**
-     * Runs the TableAction for all selected entries.
-     * Also handles confirmation with an additional dialog if configured.
-     * @param action - The TableAction to run.
-     */
-    runTableAction(action: TableActionInternal<EntityType>): Promise<void>;
-    private confirmRunTableAction;
-    /**
-     * Checks if an TableAction is disabled (e.g. Because no entries have been selected).
-     * @param action - The TableAction to check.
-     * @returns Whether or not the Action can be used.
-     */
-    tableActionDisabled(action: TableActionInternal<EntityType>): boolean;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxMatEntityTableComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityTableComponent<any>, "ngx-mat-entity-table", never, { "tableData": { "alias": "tableData"; "required": true; }; }, { "unsavedDialogChanges": "unsavedDialogChanges"; }, never, never, true, never>;
-}

package/components/tooltip/tooltip.component.d.ts

@@ -1,14 +0,0 @@
-import { IconDefinition } from '@fortawesome/angular-fontawesome';
-import * as i0 from "@angular/core";
-/**
- * A component that displays an info-symbol and a tooltip when it is hovered/clicked.
- */
-export declare class TooltipComponent {
-    faInfo: IconDefinition;
-    /**
-     * What to display inside the tooltip.
-     */
-    tooltipContent: string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TooltipComponent, "ngx-mat-entity-tooltip", never, { "tooltipContent": { "alias": "tooltipContent"; "required": true; }; }, {}, never, never, true, never>;
-}