ngx-material-entity 16.0.5 → 16.0.6

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

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

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

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

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

@@ -1,6 +1,5 @@
 /**
  * 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.

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

@@ -1,2 +1,5 @@
 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.ts.d.ts

@@ -1,9 +1,11 @@
 import { InjectionToken } from '@angular/core';
 import { ValidationError } from '../utilities/validation.utilities';
-export declare const NGX_VALIDATION_ERRORS_TOOLTIP_TITLE: InjectionToken<string>;
+/**
+ * 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.
  */

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

@@ -1,6 +1,5 @@
 /**
  * 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.
  */

package/global-configuration-values.d.ts

@@ -5,212 +5,187 @@ import { InjectionToken } from '@angular/core';
 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 title for confirming to leave without changes.
-     *
      * @default 'Unsaved Changes'
      */
     confirmUnsavedChangesTitle: string;
     /**
      * The text for confirming to leave without changes.
-     *
      * @default ['You have unsaved changes that will be deleted when you leave this page.', 'Continue?']
      */
     confirmUnsavedChangesText: 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>>;

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

@@ -1 +1 @@
-export declare const placeholder: string;
+export declare const PLACEHOLDER: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-material-entity",
-  "version": "16.0.5",
+  "version": "16.0.6",
   "license": "MIT",
   "keywords": [
     "angular",
@@ -8,6 +8,7 @@
     "crud",
     "entity"
   ],
+  "type": "module",
   "peerDependencies": {
     "@angular/animations": "16",
     "@angular/cdk": "16",

package/public-api.d.ts

@@ -4,6 +4,8 @@
 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';

package/services/entity.service.d.ts

@@ -1,4 +1,5 @@
 import { HttpClient } from '@angular/common/http';
+import { EnvironmentInjector } from '@angular/core';
 import { BehaviorSubject } from 'rxjs';
 import { BaseEntityType } from '../classes/entity.model';
 /**
@@ -9,6 +10,7 @@ import { BaseEntityType } from '../classes/entity.model';
  */
 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.
@@ -23,12 +25,15 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
      */
     abstract readonly baseUrl: string;
     /**
-     * The route segment that comes before the id when editing an entity in a separate page.
+     * 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;
@@ -42,21 +47,21 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
      * 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);
+    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.
@@ -66,7 +71,6 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
     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.
      */
@@ -75,7 +79,6 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
      * 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.
@@ -86,7 +89,6 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
     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".
@@ -95,21 +97,18 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
     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.
@@ -118,7 +117,6 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
     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.
@@ -128,7 +126,6 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
      * 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.
@@ -137,14 +134,12 @@ export declare abstract class EntityService<EntityType extends BaseEntityType<En
     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,4 +1,16 @@
 import { UrlTree } from '@angular/router';
 import { Observable } from 'rxjs';
+import { NgxMatEntityCreatePageComponent } from '../components/create-page/create-page.component';
 import { NgxMatEntityEditPageComponent } from '../components/edit-page/edit-page.component';
-export declare function UnsavedChangesGuard(component: NgxMatEntityEditPageComponent<any>): Observable<boolean | UrlTree>;
+/**
+ * Can be either an edit or an create page.
+ */
+type PageComponent = NgxMatEntityEditPageComponent<any> | NgxMatEntityCreatePageComponent<any>;
+/**
+ * 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 function UnsavedChangesGuard(component: PageComponent): Observable<boolean | UrlTree>;
+export {};

package/utilities/date.utilities.d.ts

@@ -15,14 +15,12 @@ export declare abstract class DateUtilities {
     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.
@@ -33,14 +31,12 @@ export declare abstract class DateUtilities {
     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.
@@ -49,7 +45,6 @@ export declare abstract class DateUtilities {
     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.
@@ -61,7 +56,6 @@ export declare abstract class DateUtilities {
     /**
      * 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.
      */