ngx-material-entity 18.2.6 → 20.0.1

package/functions/default-false.function.d.ts

@@ -1,6 +0,0 @@
-/**
- * The default false function.
- * A boolean false is resolved to this.
- * @returns False.
- */
-export declare function defaultFalse(): boolean;

package/functions/default-style-classes.function.d.ts

@@ -1,6 +0,0 @@
-import { DynamicStyleClasses } from '../components/table/table-data';
-/**
- * The default function to retrieve dynamic style classes.
- * Returns an empty array.
- */
-export declare const defaultDynamicStyleClasses: DynamicStyleClasses<any>;

package/functions/default-true.function.d.ts

@@ -1,6 +0,0 @@
-/**
- * The default true function.
- * A boolean true is resolved to this.
- * @returns True.
- */
-export declare function defaultTrue(): boolean;

package/functions/dropdown-values-to-function.function.d.ts

@@ -1,11 +0,0 @@
-import { DropdownValue } from '../decorators/base/dropdown-value.interface';
-/**
- * Generic Type for all possible values that can be provided as dropdown values.
- */
-export type DropdownValues<T> = DropdownValue<T | undefined>[] | ((entity: any) => DropdownValue<T | undefined>[]) | ((entity: any) => Promise<DropdownValue<T | undefined>[]>);
-/**
- * Transforms the given dropdown values to an async function.
- * @param dropdownValues - The dropdown values to transform.
- * @returns An abstract function.
- */
-export declare function dropdownValuesToFunction<T>(dropdownValues: DropdownValues<T>): (entity: any) => Promise<DropdownValue<T | undefined>[]>;

package/functions/get-changes-tooltip-content.function.d.ts

@@ -1,13 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { BaseEntityType } from '../classes/entity.model';
-import { Difference } from '../utilities/entity.utilities';
-/**
- * Provider for the changes tooltip title.
- */
-export declare const NgxChangesTooltipTitle: InjectionToken<string>;
-/**
- * The default function that gets the changes tooltip content.
- * @param changes - All changes for which the tooltip content should be generated.
- * @returns A html string, containing a list of the name of each changed property.
- */
-export declare function getChangesTooltipContent<EntityType extends BaseEntityType<EntityType>>(changes: Difference<EntityType>[]): string;

package/functions/get-config-value.function.d.ts

@@ -1,7 +0,0 @@
-/**
- * Gets either the provided value or the default value, depending on if and what has been provided.
- * @param defaultValue - The default value to fallback when nothing has been provided.
- * @param value - The specific value configured by the user.
- * @returns Value if it is not null and not the CONFIG_NEEDS_UPDATE_KEY, defaultValue otherwise.
- */
-export declare function getConfigValue<ValueType>(defaultValue: ValueType, value?: ValueType): ValueType;

package/functions/get-validation-error-message.function.d.ts

@@ -1,5 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * Provider for the default getValidationErrorMessage.
- */
-export declare const NGX_GET_VALIDATION_ERROR_MESSAGE: InjectionToken<() => string>;

package/functions/get-validation-errors-tooltip-content.function.d.ts

@@ -1,12 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { ValidationError } from '../utilities/validation.utilities';
-/**
- * Provider for the validation errors tooltip title.
- */
-export declare const NgxValidationErrorsTooltipTitle: InjectionToken<string>;
-/**
- * The default function that gets the validation errors tooltip content.
- * @param validationErrors - All validation errors for which the tooltip content should be generated.
- * @returns A html string, containing a list of the name of each invalid property.
- */
-export declare function getValidationErrorsTooltipContent(validationErrors: ValidationError[]): string;

package/functions/is-async-function.function.d.ts

@@ -1,6 +0,0 @@
-/**
- * Checks if the given function is async or not.
- * @param originalFunction - The function to check.
- * @returns True when the constructor name is 'AsyncFunction' and false otherwise.
- */
-export declare function isAsyncFunction(originalFunction: Function): boolean;

package/functions/table-column-value-to-sort-value.function.d.ts

@@ -1,9 +0,0 @@
-import { TableColumnValue } from '../components/table/table-data';
-/**
- * Converts the given table column value to a string/number for sorting.
- * This also supports string dates, if you eg. Needed to format them.
- * @param value - The value to convert.
- * @returns A string or a number to sort by.
- * @throws When a value with an unknown type has been provided.
- */
-export declare function tableColumnValueToSortValue(value: TableColumnValue): string | number;

package/global-configuration-values.d.ts

@@ -1,205 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * All configurable default values.
- */
-export interface NgxGlobalDefaultValues {
-    /**
-     * The label for create buttons.
-     * @default 'Create'
-     */
-    createLabel: string;
-    /**
-     * The label for edit buttons.
-     * @default 'Edit'
-     */
-    editLabel: string;
-    /**
-     * The label for save buttons.
-     * @default 'Save'
-     */
-    saveLabel: string;
-    /**
-     * The label for cancel buttons.
-     * @default 'Cancel'
-     */
-    cancelLabel: string;
-    /**
-     * The label for add buttons.
-     * @default 'Add'
-     */
-    addLabel: string;
-    /**
-     * The label for delete buttons.
-     * @default 'Delete'
-     */
-    deleteLabel: string;
-    /**
-     * The label for back buttons.
-     * @default 'Back'
-     */
-    backLabel: string;
-    /**
-     * The label for actions.
-     * @default 'Actions'
-     */
-    actionsLabel: string;
-    /**
-     * The label for searches.
-     * @default 'Search'
-     */
-    searchLabel: string;
-    /**
-     * The display value for the "true" value in dropdowns.
-     * @default 'Yes'
-     */
-    dropdownTrue: string;
-    /**
-     * The display value for the "false" value in dropdowns.
-     * @default 'No'
-     */
-    dropdownFalse: string;
-    /**
-     * The label for confirm buttons.
-     * @default 'Confirm'
-     */
-    confirmLabel: string;
-    /**
-     * The title for a confirm dialog.
-     * @default 'Confirmation'
-     */
-    defaultConfirmDialogTitle: string;
-    /**
-     * The text for a confirm dialog.
-     * @default ['Do you really want to do this?']
-     */
-    defaultConfirmDialogText: string[];
-    /**
-     * The text for confirming a save action.
-     * @default ['Do you really want to save all changes?']
-     */
-    confirmSaveText: string[];
-    /**
-     * The text for confirming a delete action.
-     * @default ['Do you really want to delete this entity?']
-     */
-    confirmDeleteText: string[];
-    /**
-     * The label for the button to leave without changes.
-     * @default 'Leave'
-     */
-    confirmUnsavedChangesLabel: string;
-    /**
-     * The label for the button to close a dialog without changes.
-     * @default 'Close'
-     */
-    confirmUnsavedChangesDialogLabel: string;
-    /**
-     * The title for confirming to leave without changes.
-     * @default 'Unsaved Changes'
-     */
-    confirmUnsavedChangesTitle: string;
-    /**
-     * The text for confirming to leave a page without changes.
-     * @default ['You have unsaved changes that will be deleted when you leave this page.', 'Continue?']
-     */
-    confirmUnsavedChangesText: string[];
-    /**
-     * The text for confirming to leave a dialog without changes.
-     * @default ['You have unsaved changes that will be deleted when you close this dialog.', 'Continue?']
-     */
-    confirmUnsavedChangesDialogText: string[];
-    /**
-     * The title for the add array item dialog.
-     * @default 'Add to array'
-     */
-    addArrayItemTitle: string;
-    /**
-     * The text for confirming a create action.
-     * @default ['Do you really want to create this entity?']
-     */
-    confirmCreateText: string[];
-    /**
-     * The text for confirming a multi select action.
-     * @default selectedEntries => [`Do you really want to run this action on ${selectedEntries.length} entries?`]
-     */
-    confirmMultiSelectActionText: (selectedEntries: unknown[]) => string[];
-    /**
-     * The text for confirming a base action.
-     * @default ['Do you really want to run this action?']
-     */
-    confirmBaseActionText: string[];
-    /**
-     * The text for confirming the json import.
-     * @default ['Do you really want to import entities from the provided file?']
-     */
-    confirmImportJsonText: string[];
-    /**
-     * How table entities are edited by default.
-     * @default 'dialog'
-     */
-    defaultEditMethod: 'dialog' | 'page';
-    /**
-     * How table entities are created by default.
-     * @default 'dialog'
-     */
-    defaultCreateMethod: 'dialog' | 'page';
-    /**
-     * The error message to display when an array property is required and empty.
-     * @default 'Needs to contain at least one value'
-     */
-    emptyArrayErrorMessage: string;
-    /**
-     * The label for remove actions.
-     * @default 'Remove'
-     */
-    removeLabel: string;
-    /**
-     * The label for time values.
-     * Mainly used inside date properties.
-     * @default 'Time'
-     */
-    timeLabel: string;
-    /**
-     * The label for the date range start.
-     * @default 'Start'
-     */
-    startLabel: string;
-    /**
-     * The label for the date range end.
-     * @default 'End'
-     */
-    endLabel: string;
-    /**
-     * The error text for duplicate entries inside an array.
-     * @default ['Adding duplicate entries to the array is not allowed.']
-     */
-    duplicateErrorText: string[];
-    /**
-     * The error title for duplicate entries inside an array.
-     * @default 'Error adding duplicate item'
-     */
-    duplicateErrorTitle: string;
-    /**
-     * The title for editing an entities.
-     * @default () => 'Edit'
-     */
-    editTitle: (entity: unknown) => string;
-    /**
-     * The label for an select action, eg. Dropdowns.
-     * @default 'Select'
-     */
-    selectLabel: string;
-    /**
-     * The label for an "Add all" button.
-     * @default 'Add all'
-     */
-    addAllLabel: string;
-}
-/**
- * The provider for global configuration values.
- */
-export declare const NGX_GLOBAL_DEFAULT_VALUES: InjectionToken<Partial<NgxGlobalDefaultValues>>;
-/**
- * The internal values consisting of default ones and values provided by the user in NGX_GLOBAL_DEFAULT_VALUES.
- */
-export declare const NGX_COMPLETE_GLOBAL_DEFAULT_VALUES: InjectionToken<NgxGlobalDefaultValues>;

package/mocks/placeholder-data.png.d.ts

@@ -1 +0,0 @@
-export declare const PLACEHOLDER: string;

package/public-api.d.ts

@@ -1,60 +0,0 @@
-/**
- * Public API Surface of ngx-material-entity.
- */
-export * from './classes/entity.model';
-export * from './components/confirm-dialog/confirm-dialog-data';
-export * from './components/confirm-dialog/confirm-dialog.component';
-export * from './components/create-page/create-data.route';
-export * from './components/create-page/create-page.component';
-export * from './components/edit-page/edit-data.route';
-export * from './components/edit-page/edit-page.component';
-export * from './components/input/base-input.component';
-export * from './components/input/input.component';
-export * from './components/table/create-dialog/create-entity-data';
-export * from './components/table/create-dialog/create-entity-dialog.component';
-export * from './components/table/default.actions';
-export * from './components/table/display-column-value/base-display-column-value.component';
-export * from './components/table/edit-dialog/edit-entity-data';
-export * from './components/table/edit-dialog/edit-entity-dialog.component';
-export * from './components/table/table-data';
-export * from './components/table/table.component';
-export * from './components/tooltip/tooltip.component';
-export * from './decorators/array/array-decorator.data';
-export * from './decorators/array/array.decorator';
-export * from './decorators/base/decorator-types.enum';
-export * from './decorators/base/dropdown-value.interface';
-export { Col, Position } from './decorators/base/property-decorator.data';
-export * from './decorators/boolean/boolean-decorator.data';
-export * from './decorators/boolean/boolean.decorator';
-export * from './decorators/custom/custom-decorator.data';
-export * from './decorators/custom/custom.decorator';
-export * from './decorators/date/date-decorator.data';
-export * from './decorators/date/date.decorator';
-export * from './decorators/file/file-decorator.data';
-export * from './decorators/file/file.decorator';
-export * from './decorators/has-many/has-many-decorator.data';
-export * from './decorators/has-many/has-many.decorator';
-export * from './decorators/number/number-decorator.data';
-export * from './decorators/number/number.decorator';
-export * from './decorators/object/object-decorator.data';
-export * from './decorators/object/object.decorator';
-export * from './decorators/references-many/references-many-decorator.data';
-export * from './decorators/references-many/references-many.decorator';
-export * from './decorators/references-one/references-one-decorator.data';
-export * from './decorators/references-one/references-one.decorator';
-export * from './decorators/string/string-decorator.data';
-export * from './decorators/string/string.decorator';
-export * from './directives/dynamic-style-class.directive';
-export * from './directives/included-in.directive';
-export * from './directives/number.directive';
-export * from './directives/tooltip.directive';
-export * from './functions/get-validation-error-message.function';
-export * from './functions/get-validation-errors-tooltip-content.function';
-export * from './functions/get-changes-tooltip-content.function';
-export * from './services/entity.service';
-export * from './services/unsaved-changes.guard';
-export * from './utilities/date.utilities';
-export * from './utilities/entity.utilities';
-export * from './utilities/file.utilities';
-export * from './utilities/validation.utilities';
-export * from './global-configuration-values';

package/services/entity.service.d.ts

@@ -1,146 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { EnvironmentInjector } from '@angular/core';
-import { BehaviorSubject } from 'rxjs';
-import { BaseEntityType } from '../classes/entity.model';
-/**
- * A generic EntityService class.
- * Offers basic CRUD-functionality.
- * You should create a service for every Entity you have.
- * If you extend from this you need to make sure that the extended Service can be injected.
- */
-export declare abstract class EntityService<EntityType extends BaseEntityType<EntityType>> {
-    protected readonly http: HttpClient;
-    protected readonly injector: EnvironmentInjector;
-    /**
-     * The base url used for api requests. If u want to have more control over this,
-     * you can override the create, read, update and delete methods.
-     *
-     * Create Sends a POST-Request to baseUrl.
-     *
-     * Read Sends a GET-Request to baseUrl.
-     *
-     * Update Sends a PATCH-Request to baseUrl/{id}.
-     *
-     * Delete Sends a DEL-Request to baseUrl/{id}.
-     */
-    abstract readonly baseUrl: string;
-    /**
-     * The default route segment that comes before the id when editing an entity in a separate page, if no extra route has been provided.
-     */
-    readonly editBaseRoute: string;
-    /**
-     * The complete route that is used to create an entity in a separate page, if no extra route has been provided.
-     */
-    readonly createBaseRoute: string;
-    /**
-     * The key which holds the id value.
-     * @default 'id'
-     */
-    readonly idKey: keyof EntityType;
-    /**
-     * A subject of all the entity values.
-     * Can be subscribed to when you want to do a specific thing whenever the entities change.
-     */
-    readonly entitiesSubject: BehaviorSubject<EntityType[]>;
-    /**
-     * When frequently trying to find a single entity by an id (eg. When nesting relations)
-     * you might send a lot of unnecessary requests.
-     * Therefore the findById method tries to look in the already existing entities first,
-     * IF the entities have been requested in the last READ_EXPIRATION_IN_MS milliseconds.
-     * @default 900000 (5 minutes)
-     */
-    protected readonly READ_EXPIRATION_IN_MS: number;
-    /**
-     * Gets the entities in an array from the internal entitiesSubject.
-     * @returns The current entities in form of an array.
-     */
-    get entities(): EntityType[];
-    /**
-     * The last time that the entities have been requested from the api.
-     */
-    lastRead?: Date;
-    constructor(http: HttpClient, injector: EnvironmentInjector);
-    /**
-     * Creates a new Entity and pushes it to the entities array.
-     * @param entity - The data of the entity to create.
-     * All values that should be omitted will be removed from it inside this method.
-     * @param baseUrl - The base url to send the post request to.
-     * This can be used if you want to create an entity belonging to another, like "customers/{id}/invoices".
-     * @returns A Promise of the created entity.
-     */
-    create(entity: EntityType, baseUrl?: string): Promise<EntityType>;
-    /**
-     * Imports everything from the provided json file.
-     * @param file - The json file to import from.
-     * @returns All entities that have been imported.
-     */
-    import(file: File): Promise<EntityType[]>;
-    /**
-     * Creates the entity with form data when the entity contains files in contrast to creating it with a normal json body.
-     * All file values are stored inside their respective property key and their name.
-     * Form data is able to handle setting multiple files to the same key.
-     * @param body - The body Of the request.
-     * @param filePropertyKeys - All property keys that are files and need to be added to the form data.
-     * @param entity - The entity to create. This is needed in addition to the body because the body doesn't contain any metadata.
-     * @param baseUrl - The base url to send the post request to.
-     * This can be used if you want to create an entity belonging to another, like "customers/{id}/invoices".
-     * @returns The created entity from the server.
-     */
-    protected createWithFormData(body: Partial<EntityType>, filePropertyKeys: (keyof EntityType)[], entity: EntityType, baseUrl?: string): Promise<EntityType>;
-    /**
-     * Creates the entity with a normal json body in contrast to creating it with form data when the entity contains files.
-     * @param body - The body Of the request.
-     * @param baseUrl - The base url to send the post request to.
-     * This can be used if you want to create an entity belonging to another, like "customers/{id}/invoices".
-     * @returns The created entity from the server.
-     */
-    protected createWithJson(body: Partial<EntityType>, baseUrl?: string): Promise<EntityType>;
-    /**
-     * Gets all existing entities and pushes them to the entities array.
-     * @param baseUrl - The base url for the request. Defaults to the baseUrl on the service.
-     * @returns A Promise of all received Entities.
-     */
-    read(baseUrl?: string): Promise<EntityType[]>;
-    /**
-     * Tries to find an entity with the given id.
-     * @param id - The id of the entity to find.
-     * @returns The found entity.
-     */
-    findById(id: EntityType[keyof EntityType]): Promise<EntityType>;
-    /**
-     * Updates a specific Entity.
-     * @param entity - The updated Entity
-     * All values that should be omitted will be removed from it inside this method.
-     * @param entityPriorChanges - The current Entity.
-     * It Is used to get changed values and only update them instead of sending the whole entity data.
-     */
-    update(entity: EntityType, entityPriorChanges: EntityType): Promise<void>;
-    /**
-     * Builds the update request body from the given entity before and after its changes.
-     * @param entity - The entity with changed values.
-     * @param entityPriorChanges - The entity before any changes.
-     * @returns A partial of only the changed values.
-     */
-    protected entityToUpdateRequestBody(entity: EntityType, entityPriorChanges: EntityType): Promise<Partial<EntityType>>;
-    /**
-     * Updates the entity with form data when the entity contains files in contrast to creating it with a normal json body.
-     * All file values are stored inside their respective property key and their name.
-     * Form data is able to handle setting multiple files to the same key.
-     * @param body - The request body. Already contains only properties that have changed.
-     * @param filePropertyKeys - The keys of all properties which are files and need to separately be appended to the form data.
-     * @param entity - The original entity. Is needed to get the metadata of all the files.
-     * @param id - The id of the entity to update.
-     */
-    protected updateWithFormData(body: Partial<EntityType>, filePropertyKeys: (keyof EntityType)[], entity: EntityType, id: EntityType[keyof EntityType]): Promise<void>;
-    /**
-     * Updates the entity with a normal json body in contrast to updating it with form data when the entity contains files.
-     * @param body - The body of the Request. Has already removed all unnecessary values.
-     * @param id - The id of the entity to update.
-     */
-    protected updateWithJson(body: Partial<EntityType>, id: EntityType[keyof EntityType]): Promise<void>;
-    /**
-     * Deletes a specific Entity.
-     * @param entity - The entity to delete.
-     */
-    delete(entity: EntityType): Promise<void>;
-}

package/services/unsaved-changes.guard.d.ts

@@ -1,23 +0,0 @@
-import { CanDeactivateFn } from '@angular/router';
-/**
- * Interface definition for a page that can work with the UnsavedChangesGuard.
- */
-export interface UnsavedChangesPage {
-    /**
-     * Whether the page can be left without confirmation of unsaved changes.
-     * @returns Whether or not the page can be left without confirmation.
-     */
-    canDeactivate: () => boolean;
-    /**
-     * Opens the confirm dialog for navigating with unsaved changes.
-     * @returns The the promise boolean result of the confirm dialog.
-     */
-    openConfirmNavigationDialog: () => Promise<boolean>;
-}
-/**
- * A guard that checks if the user has unsaved changes and then prompts a confirmation from him.
- * Is used by the ngx-material-entity edit and create pages.
- * @param component - The component, can be either an edit or create page.
- * @returns An observable containing whether or not the user can continue.
- */
-export declare const UnsavedChangesGuard: CanDeactivateFn<UnsavedChangesPage>;

package/utilities/date.utilities.d.ts

@@ -1,92 +0,0 @@
-import { DateFilterFn } from '@angular/material/datepicker';
-import { DropdownValue } from '../decorators/base/dropdown-value.interface';
-/**
- * Helper type for hours and minutes.
- */
-type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
-/**
- * Helper type for hours and minutes.
- */
-type Range<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>;
-/**
- * The possible hour values. Ranges from 0 to 23.
- */
-export type Hour = Range<0, 24>;
-/**
- * The possible minute values. Ranges from 0 to 59.
- */
-export type Minute = Range<0, 60>;
-/**
- * Represents a time value with hours and minutes.
- */
-export type Time = {
-    /**
-     * The hours in the 24 hour format.
-     */
-    hours: Hour;
-    /**
-     * The minutes of the time.
-     */
-    minutes: Minute;
-};
-/**
- * Valid steps from one time value to the next. Needs to be able to divide 60 minutes without remainder.
- */
-type MinuteSteps = 1 | 2 | 3 | 4 | 5 | 6 | 10 | 12 | 15 | 20 | 30 | 60;
-/**
- * Contains Helper Functions for handling date properties.
- */
-export declare abstract class DateUtilities {
-    /**
-     * The default filter function to user when none was provided by the user.
-     */
-    static defaultDateFilter: DateFilterFn<Date | null | undefined>;
-    /**
-     * Gets the given value as a date value.
-     * @param value - The value to get as a date.
-     * @returns The given value as a date.
-     */
-    static asDate(value: unknown): Date;
-    /**
-     * Gets the default times used by the DateTime picker when nothing is specified by the user.
-     * @param format - The time format. Defaults to 24.
-     * @param minuteSteps - The steps from one time value to the next. Defaults to 30.
-     * @returns Times in the 24 hour format from 0:00 until 23:30 in 30 minute steps.
-     */
-    static getDefaultTimes(format?: 12 | 24, minuteSteps?: MinuteSteps): DropdownValue<Time>[];
-    private static getTimeDropdownValue;
-    private static getFormattedHour;
-    private static getFormattedMinute;
-    /**
-     * Gets the Time object from the given date.
-     * @param value - The date to get the time object from.
-     * @returns The Time object build from the date value.
-     */
-    static getTimeFromDate(value?: Date): Time | undefined;
-    /**
-     * Gets the dates between the two given gates. Does additional filtering based on the provided DateRange metadata.
-     * @param startDate - The start date.
-     * @param endDate - The end date.
-     * @param filter - The custom filter from the metadata.
-     * @returns All dates between the two provided dates. Includes start and end date.
-     */
-    static getDatesBetween(startDate: Date, endDate: Date, filter?: DateFilterFn<Date>): Date[];
-    /**
-     * Get all valid times for the dropdown of a datetime property.
-     * @param times - All given times to filter.
-     * @param date - The date of the datetime.
-     * @param min - The function that defines the minimum time.
-     * @param max - The function that defines the maximum time.
-     * @param filter - A filter function to do more specific time filtering. This could be e.g. The removal of lunch breaks.
-     * @returns All valid dropdown values for the datetime property.
-     */
-    static getValidTimesForDropdown(times: DropdownValue<Time | undefined>[], date?: Date, min?: (date?: Date) => Time, max?: (date?: Date) => Time, filter?: ((time: Time) => boolean) | (() => boolean)): DropdownValue<Time | undefined>[];
-    /**
-     * Checks if the time object has processable hours and minutes properties.
-     * Doesn't check custom validators like min/max from the metadata configuration.
-     * @param time - The time to check.
-     * @returns Whether or not the time object is unprocessable.
-     */
-    static timeIsUnprocessable(time?: Time): boolean;
-}
-export {};