ngx-material-entity 15.1.4 → 15.1.6

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

@@ -4,15 +4,14 @@ import { NgModel } from '@angular/forms';
 import { MatDialog, MatDialogRef } from '@angular/material/dialog';
 import { MatTableDataSource } from '@angular/material/table';
 import { BaseEntityType } from '../../classes/entity.model';
-import { EntityArrayDecoratorConfigInternal } from '../../decorators/array/array-decorator-internal.data';
+import { EditArrayItemDialogDataInternal, EntityArrayDecoratorConfigInternal } from '../../decorators/array/array-decorator-internal.data';
 import { DecoratorTypes } from '../../decorators/base/decorator-types.enum';
 import { PropertyDecoratorConfigInternal } from '../../decorators/base/property-decorator-internal.data';
 import { DefaultObjectDecoratorConfigInternal } from '../../decorators/object/object-decorator-internal.data';
 import { DateUtilities } from '../../utilities/date.utilities';
 import { EntityTab, EntityUtilities } from '../../utilities/entity.utilities';
 import { SelectionUtilities } from '../../utilities/selection.utilities';
-import { AddArrayItemDialogData } from './add-array-item-dialog-data';
-import { AddArrayItemDialogDataInternal } from './add-array-item-dialog-data.builder';
+import { CreateDialogDataInternal } from '../table/create-dialog/create-dialog-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"
@@ -66,6 +65,8 @@ export declare class NgxMatEntityInputComponent<EntityType extends BaseEntityTyp
     inputChangeEvent: EventEmitter<void>;
     addArrayItemDialog: TemplateRef<unknown>;
     addArrayItemDialogRef: MatDialogRef<unknown>;
+    editArrayItemDialog: TemplateRef<unknown>;
+    editArrayItemDialogRef: MatDialogRef<unknown>;
     type: DecoratorTypes;
     metadata: PropertyDecoratorConfigInternal;
     metadataDefaultObject: DefaultObjectDecoratorConfigInternal<EntityType>;
@@ -74,16 +75,17 @@ export declare class NgxMatEntityInputComponent<EntityType extends BaseEntityTyp
     metadataEntityArray: EntityArrayDecoratorConfigInternal<EntityType>;
     entityArrayValues: EntityType[];
     arrayItem: EntityType;
-    private arrayItemPriorChanges;
+    arrayItemPriorChanges: EntityType;
     arrayItemInlineTabs: EntityTab<EntityType>[];
     dataSource: MatTableDataSource<EntityType>;
     selection: SelectionModel<EntityType>;
     displayedColumns: string[];
     isArrayItemValid: boolean;
-    dialogInputData: AddArrayItemDialogData<EntityType>;
-    dialogData: AddArrayItemDialogDataInternal<EntityType>;
+    isArrayItemDirty: boolean;
+    indexOfEditedArrayItem: number;
+    addArrayItemDialogData: CreateDialogDataInternal;
     arrayItemDialogTabs: EntityTab<EntityType>[];
-    isDialogArrayItemValid: boolean;
+    editArrayItemDialogData: EditArrayItemDialogDataInternal<EntityType>;
     readonly DecoratorTypes: typeof DecoratorTypes;
     EntityUtilities: typeof EntityUtilities;
     DateUtilities: typeof DateUtilities;
@@ -100,13 +102,17 @@ export declare class NgxMatEntityInputComponent<EntityType extends BaseEntityTyp
     private initEntityArray;
     private initObjectInput;
     /**
-     * Checks if the arrayItem is valid.
+     * Checks whether the array item is valid and if the array item is dirty.
      */
-    checkIsArrayItemValid(): void;
+    checkArrayItem(): void;
     /**
-     * Checks if the arrayItem inside the dialog is valid.
+     * Checks if the array item is dirty.
      */
-    checkIsDialogArrayItemValid(): void;
+    checkIsArrayItemDirty(): Promise<void>;
+    /**
+     * Checks if the arrayItem is valid.
+     */
+    checkIsArrayItemValid(): void;
     /**
      * Emits that a the value has been changed.
      */
@@ -124,7 +130,21 @@ export declare class NgxMatEntityInputComponent<EntityType extends BaseEntityTyp
     /**
      * Cancels adding the array item defined in the dialog.
      */
-    cancelAddArrayItem(): void;
+    closeAddArrayItemDialog(): void;
+    /**
+     * Edits an entity array item.
+     *
+     * @param entity - The entity that has been clicked.
+     */
+    editArrayItem(entity: EntityType): void;
+    /**
+     * Saves changes on the array item in the dialog.
+     */
+    saveArrayItem(): void;
+    /**
+     * Closes the edit array item dialog and resets changes.
+     */
+    closeEditArrayItemDialog(): void;
     /**
      * Removes all selected entries from the entity array.
      */

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

@@ -0,0 +1,21 @@
+import { BaseEntityType } from '../../public-api';
+/**
+ * A multi select action that exports the data as a json file.
+ *
+ * @param selectedEntities - The selected entities to export.
+ */
+export declare function exportAsJsonMultiAction<EntityType extends BaseEntityType<EntityType>>(selectedEntities: EntityType[]): void;
+/**
+ * A multi select action that exports the data as a csv file.
+ * Object values get stringified.
+ *
+ * @param selectedEntities - The selected entities to export.
+ */
+export declare function exportAsCsvMultiAction<EntityType extends BaseEntityType<EntityType>>(selectedEntities: EntityType[]): void;
+/**
+ * A multi select action that exports the data as a xml file.
+ * Object values get stringified.
+ *
+ * @param selectedEntities - The selected entities to export.
+ */
+export declare function exportAsXmlMultiAction<EntityType extends BaseEntityType<EntityType>>(selectedEntities: EntityType[]): void;

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

@@ -39,10 +39,12 @@ export declare class BaseDataInternal<EntityType extends BaseEntityType<EntityTy
     multiSelectActions: MultiSelectAction<EntityType>[];
     multiSelectLabel: string;
     displayLoadingSpinner: boolean;
+    allowJsonImport: boolean;
+    importActionData: Omit<MultiSelectAction<EntityType>, 'action' | 'requireConfirmDialog'>;
     EntityClass?: EntityClassNewable<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, defaultEdit: 'dialog' | 'page', searchString: (entity: EntityType) => string, allowCreate: () => boolean, allowRead: (entity: EntityType) => boolean, allowUpdate: (entity: EntityType) => boolean, allowDelete: (entity: EntityType) => boolean, multiSelectActions: MultiSelectAction<EntityType>[], multiSelectLabel: string, displayLoadingSpinner: boolean, EntityClass?: EntityClassNewable<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, defaultEdit: 'dialog' | 'page', searchString: (entity: EntityType) => string, allowCreate: () => boolean, allowRead: (entity: EntityType) => boolean, allowUpdate: (entity: EntityType) => boolean, allowDelete: (entity: EntityType) => boolean, multiSelectActions: MultiSelectAction<EntityType>[], multiSelectLabel: string, displayLoadingSpinner: boolean, allowJsonImport: boolean, importActionData: Omit<MultiSelectAction<EntityType>, 'action' | 'requireConfirmDialog'>, EntityClass?: EntityClassNewable<EntityType>, edit?: (entity: EntityType) => unknown, create?: (entity: EntityType) => unknown);
 }
 /**
  * The Builder for the complete TableData. Sets default values and validates user input.

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

@@ -133,6 +133,17 @@ export interface BaseData<EntityType extends BaseEntityType<EntityType>> {
      * @default true
      */
     displayLoadingSpinner?: boolean;
+    /**
+     * Whether or not JSON imports are allowed.
+     * This adds an multi select action.
+     *
+     * @default false
+     */
+    allowJsonImport?: boolean;
+    /**
+     * Data to customize the json import action.
+     */
+    importActionData?: Omit<MultiSelectAction<EntityType>, 'action' | 'requireConfirmDialog'>;
 }
 /**
  * The data of the default create-dialog.

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

@@ -35,11 +35,14 @@ export declare class NgxMatEntityTableComponent<EntityType extends BaseEntityTyp
     dataSource: MatTableDataSource<EntityType>;
     selection: SelectionModel<EntityType>;
     SelectionUtilities: typeof SelectionUtilities;
+    importAction: Omit<MultiSelectAction<EntityType>, 'confirmationDialog'>;
     constructor(dialog: MatDialog, injector: Injector, router: Router);
     /**
      * Sets up all the configuration for the table and the EntityService.
      */
     ngOnInit(): void;
+    private startImportJson;
+    private importJson;
     /**
      * Edits an entity. This either calls the edit-Method provided by the user or uses a default edit-dialog.
      *

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

@@ -7,7 +7,17 @@ import { DecoratorTypes } from '../base/decorator-types.enum';
 import { DropdownValue } from '../base/dropdown-value.interface';
 import { PropertyDecoratorConfigInternal } from '../base/property-decorator-internal.data';
 import { DateRange } from '../date/date-decorator.data';
-import { AutocompleteStringChipsArrayDecoratorConfig, DateArrayDecoratorConfig, DateRangeArrayDecoratorConfig, DateTimeArrayDecoratorConfig, EntityArrayDecoratorConfig, StringChipsArrayDecoratorConfig } from './array-decorator.data';
+import { AutocompleteStringChipsArrayDecoratorConfig, DateArrayDecoratorConfig, DateRangeArrayDecoratorConfig, DateTimeArrayDecoratorConfig, EditArrayItemDialogData, EntityArrayDecoratorConfig, StringChipsArrayDecoratorConfig } from './array-decorator.data';
+/**
+ * The internal dialog data for the entities array edit dialog.
+ * Sets default values.
+ */
+export declare class EditArrayItemDialogDataInternal<EntityType extends BaseEntityType<EntityType>> implements EditArrayItemDialogData<EntityType> {
+    title: (entity: EntityType) => string;
+    confirmButtonLabel: string;
+    cancelButtonLabel: string;
+    constructor(data?: EditArrayItemDialogData<EntityType>);
+}
 /**
  * The internal EntityArrayDecoratorConfig. Sets default values.
  */
@@ -18,6 +28,7 @@ export declare class EntityArrayDecoratorConfigInternal<EntityType extends BaseE
     EntityClass: EntityClassNewable<EntityType>;
     displayColumns: DisplayColumn<EntityType>[];
     createDialogData?: CreateDialogData;
+    editDialogData: EditArrayItemDialogDataInternal<EntityType>;
     createInline: boolean;
     missingErrorMessage: string;
     addButtonLabel: string;

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

@@ -1,12 +1,12 @@
-import { CreateDialogData, DisplayColumn } from '../../components/table/table-data';
+import { Time } from '@angular/common';
+import { DateFilterFn } from '@angular/material/datepicker';
 import { BaseEntityType, EntityClassNewable } from '../../classes/entity.model';
+import { ConfirmDialogData } from '../../components/confirm-dialog/confirm-dialog-data';
+import { CreateDialogData, DisplayColumn } from '../../components/table/table-data';
 import { DecoratorTypes } from '../base/decorator-types.enum';
-import { PropertyDecoratorConfig } from '../base/property-decorator.data';
-import { DateFilterFn } from '@angular/material/datepicker';
-import { Time } from '@angular/common';
 import { DropdownValue } from '../base/dropdown-value.interface';
+import { PropertyDecoratorConfig } from '../base/property-decorator.data';
 import { DateRange } from '../date/date-decorator.data';
-import { ConfirmDialogData } from '../../components/confirm-dialog/confirm-dialog-data';
 /**
  * Interface definition for the @array metadata.
  */
@@ -26,6 +26,23 @@ export declare abstract class ArrayDecoratorConfig extends PropertyDecoratorConf
      */
     duplicatesErrorDialog?: ConfirmDialogData;
 }
+/**
+ * The dialog data for the entities array edit dialog.
+ */
+export interface EditArrayItemDialogData<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 cancel-button for the default edit-dialog or page. Defaults to "Cancel".
+     */
+    cancelButtonLabel?: string;
+}
 /**
  * Definition for an array of Entities.
  */
@@ -45,6 +62,11 @@ export interface EntityArrayDecoratorConfig<EntityType extends BaseEntityType<En
      * Can be omitted when adding items inline.
      */
     createDialogData?: CreateDialogData;
+    /**
+     * The data for the edit-item-dialog.
+     * Can be omitted when adding items inline.
+     */
+    editDialogData?: EditArrayItemDialogData<EntityType>;
     /**
      * Whether or not the form for adding items to the array
      * should be displayed inline.

package/encapsulation/js-2-xml.utilities.d.ts

@@ -0,0 +1,15 @@
+import * as js2xml from 'js2xmlparser';
+/**
+ * Encapsulates functionality of the js2xml package.
+ */
+export declare abstract class Js2XmlUtilities {
+    /**
+     * Returns a XML string representation of the specified object using the specified options.
+     *
+     * @param root - Name of the xml root element.
+     * @param value - The json value to convert. Will be a child of root.
+     * @param options - Additional options for the conversion.
+     * @returns The converted xml string.
+     */
+    static parse(root: string, value: unknown, options?: js2xml.IOptions): string;
+}

package/encapsulation/jszip.utilities.d.ts

@@ -1,4 +1,5 @@
-import * as JSZipType from 'jszip';
+import JSZip from 'jszip';
+export declare type Zip = JSZip;
 /**
  * Encapsulates JSZip functionality.
  */
@@ -8,5 +9,5 @@ export declare abstract class JSZipUtilities {
      *
      * @returns A new JSZip object.
      */
-    static new(): JSZipType;
+    static new(): Zip;
 }

package/encapsulation/lodash.utilities.d.ts

@@ -59,4 +59,11 @@ export declare abstract class LodashUtilities {
      * @returns Returns true if value is correctly classified, else false.
      */
     static isArray(value?: unknown): value is unknown[];
+    /**
+     * Checks if value is classified as an object that is not an array.
+     *
+     * @param value - The value to check.
+     * @returns Returns true if value is correctly classified, else false.
+     */
+    static isObject(value?: unknown): value is object;
 }