ngx-material-entity 15.1.9 → 15.2.0

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

@@ -16,7 +16,7 @@ import { DateUtilities } from '../../utilities/date.utilities';
 import { EntityTab, EntityUtilities } from '../../utilities/entity.utilities';
 import { SelectionUtilities } from '../../utilities/selection.utilities';
 import { CreateDialogDataInternal } from '../table/create-dialog/create-dialog-data.builder';
-import { MultiSelectAction } from '../table/table-data';
+import { BaseTableActionInternal, TableActionInternal } from '../table/table-data.builder';
 import * as i0 from "@angular/core";
 /**
  * The default input component. It gets the metadata of the property from the given @Input "entity" and @Input "propertyKey"
@@ -101,7 +101,7 @@ export declare class NgxMatEntityInputComponent<EntityType extends BaseEntityTyp
     displayedHasManyColumns: string[];
     hasManyDataSource: MatTableDataSource<EntityType>;
     hasManySelection: SelectionModel<EntityType>;
-    hasManyImportAction: Omit<MultiSelectAction<EntityType>, 'confirmationDialog'>;
+    hasManyImportAction: BaseTableActionInternal;
     private hasManyEntityService;
     createHasManyDialog: TemplateRef<unknown>;
     createHasManyDialogRef: MatDialogRef<unknown>;
@@ -182,20 +182,20 @@ export declare class NgxMatEntityInputComponent<EntityType extends BaseEntityTyp
      */
     dialogCancelCreateHasMany(): void;
     /**
-     * Runs the MultiAction for all selected entries.
+     * Runs the TableAction for all selected entries.
      * Also handles confirmation with an additional dialog if configured.
      *
-     * @param action - The MultiAction to run.
+     * @param action - The TableAction to run.
      */
-    runHasManyMultiAction(action: MultiSelectAction<EntityType>): void;
-    private confirmRunHasManyMultiAction;
+    runHasManyTableAction(action: TableActionInternal<EntityType>): void;
+    private confirmRunHasManyTableAction;
     /**
-     * Checks if an MultiAction is disabled (e.g. Because no entries have been selected).
+     * Checks if an TableAction is disabled (e.g. Because no entries have been selected).
      *
-     * @param action - The MultiAction to check.
+     * @param action - The TableAction to check.
      * @returns Whether or not the Action can be used.
      */
-    hasManyMultiActionDisabled(action: MultiSelectAction<EntityType>): boolean;
+    hasManyTableActionDisabled(action: TableActionInternal<EntityType>): boolean;
     /**
      * Applies the search input to filter the table entries.
      *

package/components/table/default.actions.d.ts

@@ -1,4 +1,4 @@
-import { BaseEntityType } from '../../public-api';
+import { BaseEntityType } from '../../classes/entity.model';
 /**
  * A multi select action that exports the data as a json file.
  *

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

@@ -2,9 +2,38 @@ import { HttpClient } from '@angular/common/http';
 import { BaseBuilder } from '../../classes/base.builder';
 import { BaseEntityType, EntityClassNewable } from '../../classes/entity.model';
 import { EntityService } from '../../services/entity.service';
+import { ConfirmDialogDataInternal } from '../confirm-dialog/confirm-dialog-data.builder';
 import { CreateDialogDataInternal } from './create-dialog/create-dialog-data.builder';
 import { EditDataInternal } from './edit-dialog/edit-data.builder';
-import { BaseData, DisplayColumn, MultiSelectAction, TableData } from './table-data';
+import { BaseData, BaseTableAction, DisplayColumn, MultiSelectAction, TableData } from './table-data';
+/**
+ * The internal BaseTableAction. Sets default values.
+ */
+export declare class BaseTableActionInternal implements BaseTableAction {
+    type: 'default';
+    displayName: string;
+    action: () => unknown;
+    enabled: (() => boolean);
+    requireConfirmDialog: (() => boolean);
+    confirmDialogData: ConfirmDialogDataInternal;
+    constructor(data: BaseTableAction);
+}
+/**
+ * The internal BaseTableAction. Sets default values.
+ */
+export declare class MultiSelectActionInternal<EntityType extends BaseEntityType<EntityType>> implements MultiSelectAction<EntityType> {
+    type: 'multi-select';
+    displayName: string;
+    action: (selectedEntities: EntityType[]) => unknown;
+    enabled: ((selectedEntities: EntityType[]) => boolean);
+    requireConfirmDialog: ((selectedEntities: EntityType[]) => boolean);
+    confirmDialogData: ConfirmDialogDataInternal;
+    constructor(data: MultiSelectAction<EntityType>);
+}
+/**
+ * The Internal Table Action. Sets default values.
+ */
+export declare type TableActionInternal<EntityType extends BaseEntityType<EntityType>> = BaseTableActionInternal | MultiSelectActionInternal<EntityType>;
 /**
  * The internal TableData. Requires all default values the user can leave out.
  */
@@ -36,15 +65,16 @@ export declare class BaseDataInternal<EntityType extends BaseEntityType<EntityTy
     allowRead: (entity?: EntityType) => boolean;
     allowUpdate: (entity?: EntityType) => boolean;
     allowDelete: (entity?: EntityType) => boolean;
-    multiSelectActions: MultiSelectAction<EntityType>[];
-    multiSelectLabel: string;
+    tableActions: TableActionInternal<EntityType>[];
+    tableActionsLabel: string;
     displayLoadingSpinner: boolean;
     allowJsonImport: boolean;
-    importActionData: Omit<MultiSelectAction<EntityType>, 'action' | 'requireConfirmDialog'>;
+    importActionData: Omit<BaseTableActionInternal, 'action'>;
     EntityClass?: EntityClassNewable<EntityType>;
     edit?: (entity: EntityType) => unknown;
     create?: (entity: EntityType) => unknown;
     constructor(data: BaseData<EntityType>);
+    private buildImportActionData;
     private allowDataToFunction;
 }
 /**

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

@@ -15,10 +15,47 @@ export interface DisplayColumn<EntityType extends BaseEntityType<EntityType>> {
      */
     value: (entity: EntityType) => 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;
+    /**
+     * 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.
      */
@@ -30,7 +67,7 @@ export interface MultiSelectAction<EntityType extends BaseEntityType<EntityType>
     /**
      * A method that defines whether or not the action can be used.
      *
-     * @default true
+     * @default (selectedEntities: EntityType[]) => !!selectedEntities.length
      */
     enabled?: (selectedEntities: EntityType[]) => boolean;
     /**
@@ -40,10 +77,14 @@ export interface MultiSelectAction<EntityType extends BaseEntityType<EntityType>
      */
     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 table action.
      */
     confirmDialogData?: ConfirmDialogData;
 }
+/**
+ * An action for the table. Can either be independent or run on the selected entities in the table.
+ */
+export declare type TableAction<EntityType extends BaseEntityType<EntityType>> = BaseTableAction | MultiSelectAction<EntityType>;
 /**
  * The base data of the ngx-mat-entity-table.
  */
@@ -119,14 +160,14 @@ export interface BaseData<EntityType extends BaseEntityType<EntityType>> {
      */
     allowDelete?: boolean | ((entity?: EntityType) => boolean);
     /**
-     * All Actions that you want to run on multiple entities can be defined here.
-     * (e.g. Download as zip-file or mass delete).
+     * All Actions that you want to run on the table can be defined here.
+     * (e.g. Download as zip-file, import or mass delete).
      */
-    multiSelectActions?: MultiSelectAction<EntityType>[];
+    tableActions?: TableAction<EntityType>[];
     /**
-     * The Label for the button that opens all multi-actions.
+     * The Label for the button that opens all table-actions.
      */
-    multiSelectLabel?: string;
+    tableActionsLabel?: string;
     /**
      * Whether or not to display a loading spinner while the entities of the table are loaded.
      *
@@ -135,7 +176,7 @@ export interface BaseData<EntityType extends BaseEntityType<EntityType>> {
     displayLoadingSpinner?: boolean;
     /**
      * Whether or not JSON imports are allowed.
-     * This adds an multi select action.
+     * This adds an table select action.
      *
      * @default false
      */
@@ -143,7 +184,7 @@ export interface BaseData<EntityType extends BaseEntityType<EntityType>> {
     /**
      * Data to customize the json import action.
      */
-    importActionData?: Omit<MultiSelectAction<EntityType>, 'action' | 'requireConfirmDialog'>;
+    importActionData?: Omit<BaseTableAction, 'action' | 'requireConfirmDialog' | 'type'>;
 }
 /**
  * The data of the default create-dialog.

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

@@ -7,8 +7,8 @@ import { MatTableDataSource } from '@angular/material/table';
 import { Router } from '@angular/router';
 import { BaseEntityType, Entity } from '../../classes/entity.model';
 import { SelectionUtilities } from '../../utilities/selection.utilities';
-import { MultiSelectAction, TableData } from './table-data';
-import { TableDataInternal } from './table-data.builder';
+import { TableData } from './table-data';
+import { BaseTableActionInternal, TableActionInternal, TableDataInternal } from './table-data.builder';
 import * as i0 from "@angular/core";
 /**
  * Generates a fully functional table for displaying, creating, updating and deleting entities
@@ -35,7 +35,7 @@ export declare class NgxMatEntityTableComponent<EntityType extends BaseEntityTyp
     dataSource: MatTableDataSource<EntityType>;
     selection: SelectionModel<EntityType>;
     SelectionUtilities: typeof SelectionUtilities;
-    importAction: Omit<MultiSelectAction<EntityType>, 'confirmationDialog'>;
+    importAction: BaseTableActionInternal;
     constructor(dialog: MatDialog, injector: Injector, router: Router);
     /**
      * Sets up all the configuration for the table and the EntityService.
@@ -60,20 +60,20 @@ export declare class NgxMatEntityTableComponent<EntityType extends BaseEntityTyp
     createEntity(): void;
     private createDefault;
     /**
-     * Runs the MultiAction for all selected entries.
+     * Runs the TableAction for all selected entries.
      * Also handles confirmation with an additional dialog if configured.
      *
-     * @param action - The MultiAction to run.
+     * @param action - The TableAction to run.
      */
-    runMultiAction(action: MultiSelectAction<EntityType>): void;
-    private confirmRunMultiAction;
+    runTableAction(action: TableActionInternal<EntityType>): void;
+    private confirmRunTableAction;
     /**
-     * Checks if an MultiAction is disabled (e.g. Because no entries have been selected).
+     * Checks if an TableAction is disabled (e.g. Because no entries have been selected).
      *
-     * @param action - The MultiAction to check.
+     * @param action - The TableAction to check.
      * @returns Whether or not the Action can be used.
      */
-    multiActionDisabled(action: MultiSelectAction<EntityType>): boolean;
+    tableActionDisabled(action: TableActionInternal<EntityType>): boolean;
     ngOnDestroy(): void;
     /**
      * Applies the search input to filter the table entries.