ngx-material-entity 18.2.6 → 20.0.0

package/utilities/entity.utilities.d.ts

@@ -1,236 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { EnvironmentInjector } from '@angular/core';
-import { BaseEntityType } from '../classes/entity.model';
-import { DecoratorType, DecoratorTypes } from '../decorators/base/decorator-types.enum';
-import { PropertyDecoratorConfigInternal } from '../decorators/base/property-decorator-internal.data';
-/**
- * Shows information about differences between two entities.
- */
-export interface Difference<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The key where the two entities have different values.
-     */
-    key: keyof EntityType;
-    /**
-     * The value before any changes.
-     */
-    before: unknown;
-    /**
-     * The current value after changes.
-     */
-    after: unknown;
-}
-/**
- * Contains HelperMethods around handling Entities and their property-metadata.
- */
-export declare abstract class EntityUtilities {
-    /**
-     * The key for all keys of metadata that should be set to undefined when the entity gets reset.
-     */
-    static readonly METADATA_KEYS_TO_RESET_KEY: string;
-    /**
-     * The key for the metadata that saves the single preview image value on image properties.
-     */
-    static readonly SINGLE_PREVIEW_IMAGE_KEY: string;
-    /**
-     * The key for the metadata that saves the multi preview images value on image properties.
-     */
-    static readonly MULTI_PREVIEW_IMAGES_KEY: string;
-    /**
-     * The key for the metadata that saves the filenames value on file properties.
-     */
-    static readonly FILENAMES_KEY: string;
-    /**
-     * The key for the metadata that saves the confirm password value on password properties.
-     */
-    static readonly CONFIRM_PASSWORD_KEY: string;
-    /**
-     * The key for the metadata that saves the time value on date time properties.
-     */
-    static readonly TIME_KEY: string;
-    /**
-     * Gets the properties to omit when updating the entity.
-     * @param entity - The entity to get the properties which should be left out for updating from.
-     * @returns The properties which should be left out for updating an Entity.
-     */
-    static getOmitForUpdate<EntityType extends BaseEntityType<EntityType>>(entity: EntityType): (keyof EntityType)[];
-    /**
-     * Gets the properties to omit when creating new entities.
-     * @param entity - The entity to get the properties which should be left out for creating from.
-     * @returns The properties which should be left out for creating a new Entity.
-     */
-    static getOmitForCreate<EntityType extends BaseEntityType<EntityType>>(entity: EntityType): (keyof EntityType)[];
-    /**
-     * Returns the given entity without the values that should be omitted for creation.
-     * @param entity - The entity with all its values.
-     * @returns The reduced entity object.
-     */
-    static getWithoutOmitCreateValues<EntityType extends BaseEntityType<EntityType>>(entity: EntityType): Partial<EntityType>;
-    /**
-     * Returns the given entity without the values that should be omitted for updating.
-     * This also handles omitting keys for @object or @array values and removes values that haven't been changed by default.
-     * @param entity - The entity with all its values.
-     * @param entityPriorChanges - The entity before any changes were applied.
-     * @param http - The angular HttpClient. Used to fetch files.
-     * @param injector - An angular environment injector.
-     * @returns The reduced entity object.
-     */
-    static getWithoutOmitUpdateValues<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, entityPriorChanges: EntityType, http: HttpClient, injector: EnvironmentInjector): Promise<Partial<EntityType>>;
-    /**
-     * Sets all default values on the given entity.
-     * @param entity - The entity to set the default values on.
-     */
-    static setDefaultValues<EntityType extends BaseEntityType<EntityType>>(entity: EntityType): void;
-    /**
-     * Gets all properties on the given entity which are files.
-     * @param entity - The entity to check for file properties.
-     * @param omit - Whether to leave out values that are omitted for create or delete.
-     * @returns The keys of all file properties on the given entity.
-     */
-    static getFileProperties<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, omit?: 'create' | 'update'): (keyof EntityType)[];
-    /**
-     * Gets the metadata included in an property.
-     * @param entity - The entity with the property to get the metadata from.
-     * @param propertyKey - The property on the given Entity to get the metadata from.
-     * @param type - For secure Typing, defines the returned PropertyConfig.
-     * @returns The metadata of the property.
-     * @throws When no metadata can be found for the given property.
-     */
-    static getPropertyMetadata<EntityType extends BaseEntityType<EntityType>, T extends DecoratorTypes, CustomMetadataType extends Record<string, unknown>>(entity: EntityType, propertyKey: keyof EntityType, type?: T): DecoratorType<T, CustomMetadataType> | undefined;
-    /**
-     * Gets the type of the property-metadata.
-     * @param entity - The entity with the property to get the type from.
-     * @param propertyKey - The property on the given Entity to get the type from.
-     * @returns The type of the metadata.
-     * @throws Will throw an error if no metadata can be found for the given property.
-     */
-    static getPropertyType<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, propertyKey: keyof EntityType): DecoratorTypes | undefined;
-    /**
-     * Sets all property values based on a given entity data-object.
-     * @param target - The target object that needs to be constructed (if called inside an Entity constructor its usually this).
-     * @param entity - The data object to get the property values from.
-     * @alias new
-     * @alias build
-     * @alias construct
-     */
-    static new<EntityType extends BaseEntityType<EntityType>>(target: EntityType, entity?: EntityType): void;
-    static construct: typeof EntityUtilities.new;
-    static build: typeof EntityUtilities.new;
-    /**
-     * Checks if an entity is "dirty" (if its values have changed).
-     * @param entity - The entity after all changes.
-     * @param entityPriorChanges - The entity before the changes.
-     * @param http - The angular HttpClient. Used to fetch files.
-     * @param injector - An angular environment injector.
-     * @returns Whether or not the entity is dirty.
-     */
-    static isDirty<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, entityPriorChanges: EntityType, http: HttpClient, injector: EnvironmentInjector): Promise<boolean>;
-    /**
-     * Gets the differences between the two given entities. Only checks properties which are decorated.
-     * @param entity - The entity as is.
-     * @param entityPriorChanges - The entity before any changes have been made.
-     * @param http - The angular http client, is needed to check if files are equal.
-     * @param injector - An angular environment injector.
-     * @returns The differences as an array consisting of key, before and after.
-     */
-    static getDifferencesBetweenEntities<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, entityPriorChanges: EntityType, http: HttpClient, injector: EnvironmentInjector): Promise<Difference<EntityType>[]>;
-    /**
-     * Checks if two given values are equal.
-     * It uses the isEqual method from LodashUtilities and extends it with functionality regarding Dates.
-     * @param value - The updated value.
-     * @param valuePriorChanges - The value before any changes.
-     * @param metadata - The metadata of the property.
-     * @param type - The type of the property.
-     * @param http - The angular HttpClient. Used to fetch files.
-     * @returns Whether or not the given values are equal.
-     */
-    static isEqual(value: unknown, valuePriorChanges: unknown, metadata: PropertyDecoratorConfigInternal<unknown> | undefined, type: DecoratorTypes | undefined, http: HttpClient): Promise<boolean>;
-    private static differenceIsUndefinedAndEmptyString;
-    private static differenceIsUndefinedAndEmptyArray;
-    private static isEqualArrayString;
-    private static isEqualArrayDate;
-    private static isEqualArrayDateRange;
-    private static isEqualDateTime;
-    private static isEqualDate;
-    private static isEqualDateRange;
-    private static isEqualFile;
-    private static isEqualCustom;
-    /**
-     * Compare function for sorting entity keys by their order value.
-     * @param a - First key of entity.
-     * @param b - Second key of entity.
-     * @param entity - Current entity (used to get metadata of entity keys).
-     * @returns 0 if both values have the same order, a negative value if 'a' comes before 'b', a positive value if 'a' comes behind 'b'.
-     */
-    static compareOrder<EntityType extends BaseEntityType<EntityType>>(a: keyof EntityType, b: keyof EntityType, entity: EntityType): number;
-    /**
-     * Gets the responsive column classes for "lg", "md" and "sm".
-     * @param entity - Entity to get the responsive column classes for.
-     * @param key - Key of the property to get the responsive column classes from.
-     * @returns Responsive column classes for large, middle and small displays.
-     * @throws When no metadata for the given key was found.
-     */
-    static getWidthClasses<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, key: keyof EntityType): string;
-    /**
-     * Resets all changes on an entity.
-     * @param entity - The entity to reset.
-     * @param entityPriorChanges - The entity before any changes.
-     */
-    static resetChangesOnEntity<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, entityPriorChanges: EntityType): void;
-    private static getEntityRows;
-    /**
-     * Gets the tabs that are used to display the given entity.
-     * @param entity - The entity to get the rows from.
-     * @param injector - An angular environment injector.
-     * @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.
-     * @param additionalOmitKeys - Additional omit values.
-     * @returns The sorted Tabs containing the rows and the keys to display in that row.
-     */
-    static getEntityTabs<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, injector: EnvironmentInjector, hideOmitForCreate?: boolean, hideOmitForEdit?: boolean, additionalOmitKeys?: (keyof EntityType)[]): EntityTab<EntityType>[];
-    private static getKeysForRow;
-    private static getNumberOfRows;
-    private static getNumberOfTabs;
-    private static getTabName;
-    private static getFirstTabName;
-    /**
-     * Gets the keys of the provided entity correctly typed.
-     * @param entity - The entity to get the keys of.
-     * @param injector - An angular environment injector.
-     * @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 An array of keys of the entity.
-     */
-    static keysOf<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, injector: EnvironmentInjector, hideOmitForCreate?: boolean, hideOmitForEdit?: boolean): (keyof EntityType)[];
-    private static getDontDisplayKeys;
-}
-/**
- * A row that contains information about how to display an entity.
- */
-export interface EntityRow<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The row in which this should be displayed.
-     */
-    row: number;
-    /**
-     * The keys of the values that should be displayed in that row.
-     */
-    keys: (keyof EntityType)[];
-}
-/**
- * A tab that contains all the information about how to display an entity.
- */
-export interface EntityTab<EntityType extends BaseEntityType<EntityType>> {
-    /**
-     * The tab in which the rows should be displayed.
-     */
-    tab: number;
-    /**
-     * The name to display inside the tab.
-     */
-    tabName: string;
-    /**
-     * The rows that should be displayed inside this tab,.
-     */
-    rows: EntityRow<EntityType>[];
-}

package/utilities/file.utilities.d.ts

@@ -1,67 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { FileDataWithFile } from '../decorators/file/file-decorator-internal.data';
-import { FileData } from '../decorators/file/file-decorator.data';
-/**
- * Provides functionality regarding files.
- */
-export declare abstract class FileUtilities {
-    /**
-     * Gets the accept value for the html input.
-     * @param mimeTypes - The mimeTypes to get the accept string from.
-     * @returns A comma separated string of all the provided mime types.
-     */
-    static getAcceptString(mimeTypes?: string[]): string;
-    /**
-     * Reads a url to display the given file.
-     * @param file - The file to get the url from.
-     * @returns A promise of the url. Undefined if no file was provided.
-     */
-    static getDataURLFromFile(file?: Blob): Promise<string | undefined>;
-    /**
-     * Gets a file from the given url.
-     * @param url - The url to get the file from.
-     * @param http - The angular HttpClient. Used to fetch files.
-     * @returns A promise of the File.
-     */
-    private static getFileFromUrl;
-    /**
-     * Gets the file data with the blob from the given File Data.
-     * @param data - The File Data to get the file data with blob from.
-     * @param http - The angular HttpClient. Used to fetch files.
-     * @returns FileDataWithFile.
-     */
-    static getFileData(data: FileData, http: HttpClient): 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 a blob.
-     * @param blob - The blob to download.
-     * @param name - The name of the downloaded file.
-     */
-    static downLoadBlob(blob: Blob, name?: string): 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.
-     * @param http - The angular HttpClient. Used to fetch files.
-     */
-    static downloadMultipleFiles(name: string, multiFileData: FileData[], http: HttpClient): Promise<void>;
-    /**
-     * Checks if the given file has a valid mime type.
-     * @param type - The type of the file to check.
-     * @param allowedMimeTypes - The allowed mime types.
-     * @returns Whether or not the given file has a valid mime type.
-     */
-    static isMimeTypeValid(type: string, allowedMimeTypes: string[]): boolean;
-    /**
-     * Transform the given value to Megabytes.
-     * @param value - The original value.
-     * @param unit - If the value is B, KB or GB.
-     * @returns The given value as bytes.
-     */
-    static transformToMegaBytes(value: number, unit: 'B' | 'KB' | 'GB'): number;
-    private static transformToBytes;
-}

package/utilities/selection.utilities.d.ts

@@ -1,28 +0,0 @@
-import { SelectionModel } from '@angular/cdk/collections';
-import { MatTableDataSource } from '@angular/material/table';
-/**
- * Provides functionality around material selections inside of tables.
- */
-export declare abstract class SelectionUtilities {
-    /**
-     * Checks if all items in the table have been selected.
-     * This is needed to display the "masterToggle"-checkbox correctly.
-     * @param selection - The selection to check.
-     * @param dataSource - The dataSource of the selection.
-     * @returns Whether or not all items in the table have been selected.
-     */
-    static isAllSelected(selection: SelectionModel<any>, dataSource: MatTableDataSource<any>): boolean;
-    /**
-     * Toggles all items in the table.
-     * @param selection - The selection to toggle.
-     * @param dataSource - The dataSource of the selection.
-     */
-    static masterToggle(selection: SelectionModel<any>, dataSource: MatTableDataSource<any>): void;
-    /**
-     * Removes all selected entries from the array.
-     * @param selection - The selection containing the items to remove.
-     * @param values - The values of the dataSource.
-     * @param dataSource - The dataSource.
-     */
-    static remove(selection: SelectionModel<any>, values: any[], dataSource: MatTableDataSource<any>): void;
-}

package/utilities/validation.utilities.d.ts

@@ -1,58 +0,0 @@
-import { EnvironmentInjector } from '@angular/core';
-import { BaseEntityType } from '../classes/entity.model';
-/**
- * A validation error reported by the validation utilities.
- * Consists of the property name where the error originated from and a message.
- */
-export interface ValidationError {
-    /**
-     * The property name on which the error occurred. This is the displayName value.
-     */
-    property: string;
-    /**
-     * The validation error message.
-     */
-    message: string;
-}
-/**
- * Contains HelperMethods around handling Validation of entities and properties.
- */
-export declare abstract class ValidationUtilities {
-    /**
-     * Checks if the values on an entity are valid.
-     * Also checks all the validators given by the metadata ("required", "maxLength" etc.).
-     * @param entity - The entity to validate.
-     * @param injector - An angular environment injector.
-     * @param omit - Whether to check for creating or editing validity.
-     * @returns Whether or not the entity is valid.
-     */
-    static isEntityValid<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, injector: EnvironmentInjector, omit?: 'create' | 'update'): Promise<boolean>;
-    /**
-     * Gets all validation errors on the given entity.
-     * @param entity - The entity to validate.
-     * @param injector - An angular environment injector.
-     * @param omit - What keys not to check. An empty value means no keys are omitted.
-     * @returns An array of validation errors on the provided entity.
-     */
-    static getEntityValidationErrors<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, injector: EnvironmentInjector, omit?: 'create' | 'update'): Promise<ValidationError[]>;
-    /**
-     * Validates the property on the given entity with the given key.
-     * @param entity - The entity on which the property to check is.
-     * @param key - The key of the property to validate.
-     * @param omit - What keys not to check. An empty value means no keys are omitted.
-     * @returns A validation error when the property is not valid, undefined otherwise.
-     * @throws When the type of the property is not known.
-     */
-    static getPropertyValidationError<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, key: keyof EntityType, omit?: 'create' | 'update'): Promise<ValidationError | undefined>;
-    private static getArrayStringAutocompleteChipsValidationError;
-    private static getBooleanValidationError;
-    private static getStringValidationError;
-    private static getAutocompleteStringValidationError;
-    private static getTextboxValidationError;
-    private static getPasswordValidationError;
-    private static getNumberValidationError;
-    private static getDateValidationError;
-    private static getDateRangeValidationError;
-    private static getDateTimeValidationError;
-    private static getFileDataValidationError;
-}