ngx-material-entity 1.0.6 → 1.1.0

package/capsulation/jszip.utilities.d.ts

@@ -0,0 +1,12 @@
+import * as JSZipType from 'jszip';
+/**
+ * Encapsulates JSZip functionality.
+ */
+export declare abstract class JSZipUtilities {
+    /**
+     * Generates a new JSZip object that is correctly typed.
+     *
+     * @returns A new JSZip object.
+     */
+    static new(): JSZipType;
+}

package/classes/entity.utilities.d.ts

@@ -146,15 +146,6 @@ export declare abstract class EntityUtilities {
      * @param entityPriorChanges - The entity before any changes.
      */
     static resetChangesOnEntity<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, entityPriorChanges: EntityType): void;
-    /**
-     * Gets the rows that are used to display the given entity.
-     *
-     * @param entity - The entity to get the rows from.
-     * @param tab - The tab number for which the rows should be returned.
-     * @param hideOmitForCreate - Whether or not keys with the metadata omitForCreate should be filtered out.
-     * @param hideOmitForEdit - Whether or not keys with the metadata omitForUpdate should be filtered out.
-     * @returns The sorted Rows containing the row number and the keys to display in that row.
-     */
     private static getEntityRows;
     /**
      * Gets the tabs that are used to display the given entity.

package/classes/file.utilities.d.ts

@@ -32,6 +32,19 @@ export declare abstract class FileUtilities {
      * @returns FileDataWithFile.
      */
     static getFileData(data: FileData): Promise<FileDataWithFile>;
+    /**
+     * Downloads a single file from the given File Data.
+     *
+     * @param fileData - The file data. Needs to contain a blob.
+     */
+    static downloadSingleFile(fileData: FileDataWithFile): void;
+    /**
+     * Downloads multiple files as a zip with the given name.
+     *
+     * @param name - The name of the zip file to generate.
+     * @param multiFileData - The file data array to put in the zip.
+     */
+    static downloadMultipleFiles(name: string, multiFileData: FileData[]): Promise<void>;
     /**
      * Checks if the given file has a valid mime type.
      *

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

@@ -8,7 +8,7 @@ import { OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
 declare type ArrayTableType = DecoratorTypes.ARRAY | DecoratorTypes.ARRAY_DATE | DecoratorTypes.ARRAY_DATE_RANGE | DecoratorTypes.ARRAY_DATE_TIME;
 /**
- * The base data needed for all arrays that are displayed as a table.
+ * The base component needed for all arrays that are displayed as a table.
  */
 export declare abstract class ArrayTableComponent<ValueType, EntityType extends BaseEntityType<EntityType>, ArrayType extends ArrayTableType> extends NgxMatEntityBaseInputComponent<EntityType, ArrayType, ValueType[]> implements OnInit {
     private readonly matDialog;

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

@@ -1,6 +1,6 @@
 import { EventEmitter, OnInit } from '@angular/core';
 import { NgModel } from '@angular/forms';
-import { DefaultFileDecoratorConfigInternal } from '../../../../decorators/file/file-decorator-internal.data';
+import { DefaultFileDecoratorConfigInternal, ImageFileDecoratorConfigInternal } from '../../../../decorators/file/file-decorator-internal.data';
 import { FileUtilities } from '../../../../classes/file.utilities';
 import { FileData } from '../../../../decorators/file/file-decorator.data';
 import { MatDialog } from '@angular/material/dialog';
@@ -8,16 +8,13 @@ import { BaseEntityType } from '../../../../classes/entity.model';
 import * as i0 from "@angular/core";
 export declare class FileInputComponent<EntityType extends BaseEntityType<EntityType>> implements OnInit {
     private readonly dialog;
-    singleFileData?: FileData;
-    multiFileData?: FileData[];
     filenames?: string[];
     FileUtilities: typeof FileUtilities;
-    entity: EntityType;
-    key: keyof EntityType;
+    propertyValue: FileData | FileData[] | undefined;
+    metadata: DefaultFileDecoratorConfigInternal | ImageFileDecoratorConfigInternal;
     getValidationErrorMessage: (model: NgModel) => string;
     isReadOnly: boolean;
     fileDataChangeEvent: EventEmitter<FileData | FileData[]>;
-    metadata: DefaultFileDecoratorConfigInternal;
     constructor(dialog: MatDialog);
     ngOnInit(): Promise<void>;
     private initMultiFile;
@@ -28,6 +25,9 @@ export declare class FileInputComponent<EntityType extends BaseEntityType<Entity
     private setMultiFile;
     private setSingleFile;
     removeFile(name: string): void;
+    downloadFile(name: string): Promise<void>;
+    downloadAllEnabled(): boolean;
+    downloadAll(): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<FileInputComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FileInputComponent<any>, "file-input", never, { "entity": "entity"; "key": "key"; "getValidationErrorMessage": "getValidationErrorMessage"; "isReadOnly": "isReadOnly"; }, { "fileDataChangeEvent": "fileDataChangeEvent"; }, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FileInputComponent<any>, "file-input", never, { "propertyValue": "propertyValue"; "metadata": "metadata"; "getValidationErrorMessage": "getValidationErrorMessage"; "isReadOnly": "isReadOnly"; }, { "fileDataChangeEvent": "fileDataChangeEvent"; }, never, never>;
 }

package/components/table/edit-dialog/edit-entity-dialog.component.d.ts

@@ -23,11 +23,14 @@ export declare class NgxMatEntityEditDialogComponent<EntityType extends BaseEnti
     entityPriorChanges: EntityType;
     data: EditEntityDialogDataInternal<EntityType>;
     isEntityValid: boolean;
-    isEntityDirty: Promise<boolean>;
+    isEntityDirty: boolean;
     isReadOnly: boolean;
     constructor(inputData: EditEntityDialogData<EntityType>, dialogRef: MatDialogRef<NgxMatEntityEditDialogComponent<EntityType>>, injector: Injector, dialog: MatDialog);
     ngOnInit(): void;
-    checkEntity(): void;
+    /**
+     * Checks if the entity has become invalid or dirty.
+     */
+    checkEntity(): Promise<void>;
     /**
      * Tries to save the changes and close the dialog afterwards.
      * Also handles the confirmation if required.

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

@@ -70,6 +70,7 @@ export declare class DefaultFileDecoratorConfigInternal extends PropertyDecorato
     maxSizeErrorDialog: ConfirmDialogData;
     maxSizeTotalErrorDialog: ConfirmDialogData;
     dragAndDrop: boolean;
+    downloadAllButtonLabel: string;
     constructor(data: DefaultFileDecoratorConfig);
 }
 /**
@@ -88,5 +89,6 @@ export declare class ImageFileDecoratorConfigInternal extends PropertyDecoratorC
     maxSizeErrorDialog: ConfirmDialogData;
     maxSizeTotalErrorDialog: ConfirmDialogData;
     dragAndDrop: boolean;
+    downloadAllButtonLabel: string;
     constructor(data: ImageFileDecoratorConfig);
 }

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

@@ -61,10 +61,18 @@ declare abstract class FileDecoratorConfig extends PropertyDecoratorConfig {
     /**
      * Defines whether or not a dropdown box is displayed.
      *
-     * @default true // when multiple is set to true.
+     * @default
+     * true // when multiple is set to true.
      * false // when multiple is set to false.
      */
     dragAndDrop?: boolean;
+    /**
+     * The label of the button to download all files.
+     * Is only shown when the property contains multiple files.
+     *
+     * @default 'Download All'
+     */
+    downloadAllButtonLabel?: string;
 }
 /**
  * Definition for a default file.

package/esm2020/capsulation/jszip.utilities.mjs

@@ -0,0 +1,18 @@
+import JSZip from 'jszip';
+// TODO: Find a way to use blobs with jest
+/* istanbul ignore next */
+/**
+ * Encapsulates JSZip functionality.
+ */
+export class JSZipUtilities {
+    /**
+     * Generates a new JSZip object that is correctly typed.
+     *
+     * @returns A new JSZip object.
+     */
+    static new() {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+        return new JSZip();
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoianN6aXAudXRpbGl0aWVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcHJvamVjdHMvbmd4LW1hdGVyaWFsLWVudGl0eS9zcmMvY2Fwc3VsYXRpb24vanN6aXAudXRpbGl0aWVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxNQUFNLE9BQU8sQ0FBQztBQUkxQiwwQ0FBMEM7QUFDMUMsMEJBQTBCO0FBQzFCOztHQUVHO0FBQ0gsTUFBTSxPQUFnQixjQUFjO0lBQ2hDOzs7O09BSUc7SUFDSCxNQUFNLENBQUMsR0FBRztRQUNOLDZEQUE2RDtRQUM3RCxPQUFPLElBQUksS0FBSyxFQUFlLENBQUM7SUFDcEMsQ0FBQztDQUNKIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IEpTWmlwIGZyb20gJ2pzemlwJztcbi8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBuby1kdXBsaWNhdGUtaW1wb3J0c1xuaW1wb3J0ICogYXMgSlNaaXBUeXBlIGZyb20gJ2pzemlwJzsgLy8gPC0tIFRoaXMgaXMgbmVlZGVkIHRvIHByb3ZpZGUgdHlwZSBzYWZldHkuXG5cbi8vIFRPRE86IEZpbmQgYSB3YXkgdG8gdXNlIGJsb2JzIHdpdGggamVzdFxuLyogaXN0YW5idWwgaWdub3JlIG5leHQgKi9cbi8qKlxuICogRW5jYXBzdWxhdGVzIEpTWmlwIGZ1bmN0aW9uYWxpdHkuXG4gKi9cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBKU1ppcFV0aWxpdGllcyB7XG4gICAgLyoqXG4gICAgICogR2VuZXJhdGVzIGEgbmV3IEpTWmlwIG9iamVjdCB0aGF0IGlzIGNvcnJlY3RseSB0eXBlZC5cbiAgICAgKlxuICAgICAqIEByZXR1cm5zIEEgbmV3IEpTWmlwIG9iamVjdC5cbiAgICAgKi9cbiAgICBzdGF0aWMgbmV3KCk6IEpTWmlwVHlwZSB7XG4gICAgICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW5zYWZlLWNhbGxcbiAgICAgICAgcmV0dXJuIG5ldyBKU1ppcCgpIGFzIEpTWmlwVHlwZTtcbiAgICB9XG59Il19