ngx-material-entity 20.0.3 → 20.0.5

package/index.d.ts

@@ -10,6 +10,7 @@ import { DateFilterFn } from '@angular/material/datepicker';
 import { NgModel, Validator, AbstractControl, ValidationErrors } from '@angular/forms';
 import { SelectionModel } from '@angular/cdk/collections';
 import { MatTableDataSource } from '@angular/material/table';
+import { MatTabChangeEvent } from '@angular/material/tabs';
 
 /**
  * A generic EntityService class.
@@ -1240,6 +1241,7 @@ interface DateTimeDateDecoratorConfig extends DateDecoratorConfig<Date> {
 }
 
 type StringDropdownValues = DropdownValue<string | undefined>[] | ((entity: any) => DropdownValue<string | undefined>[]) | ((entity: any) => Promise<DropdownValue<string | undefined>[]>);
+type RequiredStringDropdownValues = DropdownValue<string>[] | ((entity: any) => DropdownValue<string>[]) | ((entity: any) => Promise<DropdownValue<string>[]>);
 type StringAutocompleteValues = string[] | ((entity: any) => string[]) | ((entity: any) => Promise<string[]>);
 /**
  * Definition for the @string metadata.
@@ -1593,6 +1595,17 @@ interface AutocompleteStringChipsArrayDecoratorConfig extends ArrayDecoratorConf
      */
     restrictToOptions?: boolean;
 }
+/**
+ * Definition for an array of strings displayed in a dropdown.
+ */
+interface StringDropdownArrayDecoratorConfig extends ArrayDecoratorConfig<string[]> {
+    itemType: DecoratorTypes.STRING_DROPDOWN;
+    /**
+     * The values of the dropdown, consisting of a name to display and the actual value
+     * Can also receive a function to determine the values.
+     */
+    dropdownValues: RequiredStringDropdownValues;
+}
 
 /**
  * The internal Position. Sets default values and validates user input.
@@ -1751,6 +1764,14 @@ declare class AutocompleteStringChipsArrayDecoratorConfigInternal extends Proper
     constructor(data: AutocompleteStringChipsArrayDecoratorConfig, globalConfig: NgxGlobalDefaultValues);
     private autocompleteValuesToFunction;
 }
+/**
+ * The internal StringDropdownArrayDecoratorConfig. Sets default values.
+ */
+declare class StringDropdownArrayDecoratorConfigInternal extends PropertyDecoratorConfigInternal<string[]> implements StringDropdownArrayDecoratorConfig {
+    itemType: DecoratorTypes.STRING_DROPDOWN;
+    dropdownValues: (entity: any) => Promise<DropdownValue<string>[]>;
+    constructor(data: StringDropdownArrayDecoratorConfig);
+}
 
 /**
  * The Definition for the @boolean metadata.
@@ -2628,6 +2649,7 @@ declare enum DecoratorTypes {
     ARRAY_DATE_RANGE = "arrayDateRange",
     ARRAY_STRING_CHIPS = "arrayStringChips",
     ARRAY_STRING_AUTOCOMPLETE_CHIPS = "arrayStringAutocompleteChips",
+    ARRAY_STRING_DROPDOWN = "arrayStringDropdown",
     DATE = "date",
     DATE_RANGE = "dateRange",
     DATE_TIME = "dateTime",
@@ -2641,7 +2663,7 @@ declare enum DecoratorTypes {
 /**
  * Gives the metadata-config Type based on the DecoratorTypes enum.
  */
-type DecoratorType<T, CustomMetadataType extends Record<string, unknown>> = T extends DecoratorTypes.STRING ? DefaultStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_TEXTBOX ? TextboxStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_DROPDOWN ? DropdownStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_AUTOCOMPLETE ? AutocompleteStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_PASSWORD ? PasswordStringDecoratorConfigInternal : T extends DecoratorTypes.NUMBER ? DefaultNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_DROPDOWN ? DropdownNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_SLIDER ? SliderNumberDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_CHECKBOX ? CheckboxBooleanDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_TOGGLE ? ToggleBooleanDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_DROPDOWN ? DropdownBooleanDecoratorConfigInternal : T extends DecoratorTypes.OBJECT ? DefaultObjectDecoratorConfigInternal<any> : T extends DecoratorTypes.OBJECT_DROPDOWN ? DropdownObjectDecoratorConfigInternal<any> : T extends DecoratorTypes.ARRAY ? EntityArrayDecoratorConfigInternal<any> : T extends DecoratorTypes.ARRAY_DATE ? DateArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_DATE_TIME ? DateTimeArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_DATE_RANGE ? DateRangeArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_CHIPS ? StringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_AUTOCOMPLETE_CHIPS ? AutocompleteStringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.DATE ? DefaultDateDecoratorConfigInternal : T extends DecoratorTypes.DATE_RANGE ? DateRangeDateDecoratorConfigInternal : T extends DecoratorTypes.DATE_TIME ? DateTimeDateDecoratorConfigInternal : T extends DecoratorTypes.FILE_DEFAULT ? DefaultFileDecoratorConfigInternal : T extends DecoratorTypes.FILE_IMAGE ? ImageFileDecoratorConfigInternal : T extends DecoratorTypes.REFERENCES_MANY ? ReferencesManyDecoratorConfigInternal<any> : T extends DecoratorTypes.REFERENCES_ONE ? ReferencesOneDecoratorConfigInternal<any> : T extends DecoratorTypes.HAS_MANY ? HasManyDecoratorConfigInternal<any, any> : T extends DecoratorTypes.CUSTOM ? CustomDecoratorConfigInternal<any, any, CustomMetadataType, any> : never;
+type DecoratorType<T, CustomMetadataType extends Record<string, unknown>> = T extends DecoratorTypes.STRING ? DefaultStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_TEXTBOX ? TextboxStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_DROPDOWN ? DropdownStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_AUTOCOMPLETE ? AutocompleteStringDecoratorConfigInternal : T extends DecoratorTypes.STRING_PASSWORD ? PasswordStringDecoratorConfigInternal : T extends DecoratorTypes.NUMBER ? DefaultNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_DROPDOWN ? DropdownNumberDecoratorConfigInternal : T extends DecoratorTypes.NUMBER_SLIDER ? SliderNumberDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_CHECKBOX ? CheckboxBooleanDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_TOGGLE ? ToggleBooleanDecoratorConfigInternal : T extends DecoratorTypes.BOOLEAN_DROPDOWN ? DropdownBooleanDecoratorConfigInternal : T extends DecoratorTypes.OBJECT ? DefaultObjectDecoratorConfigInternal<any> : T extends DecoratorTypes.OBJECT_DROPDOWN ? DropdownObjectDecoratorConfigInternal<any> : T extends DecoratorTypes.ARRAY ? EntityArrayDecoratorConfigInternal<any> : T extends DecoratorTypes.ARRAY_DATE ? DateArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_DATE_TIME ? DateTimeArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_DATE_RANGE ? DateRangeArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_CHIPS ? StringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_AUTOCOMPLETE_CHIPS ? AutocompleteStringChipsArrayDecoratorConfigInternal : T extends DecoratorTypes.ARRAY_STRING_DROPDOWN ? StringDropdownArrayDecoratorConfigInternal : T extends DecoratorTypes.DATE ? DefaultDateDecoratorConfigInternal : T extends DecoratorTypes.DATE_RANGE ? DateRangeDateDecoratorConfigInternal : T extends DecoratorTypes.DATE_TIME ? DateTimeDateDecoratorConfigInternal : T extends DecoratorTypes.FILE_DEFAULT ? DefaultFileDecoratorConfigInternal : T extends DecoratorTypes.FILE_IMAGE ? ImageFileDecoratorConfigInternal : T extends DecoratorTypes.REFERENCES_MANY ? ReferencesManyDecoratorConfigInternal<any> : T extends DecoratorTypes.REFERENCES_ONE ? ReferencesOneDecoratorConfigInternal<any> : T extends DecoratorTypes.HAS_MANY ? HasManyDecoratorConfigInternal<any, any> : T extends DecoratorTypes.CUSTOM ? CustomDecoratorConfigInternal<any, any, CustomMetadataType, any> : never;
 
 /**
  * Shows information about differences between two entities.
@@ -2651,6 +2673,10 @@ interface Difference<EntityType extends BaseEntityType<EntityType>> {
      * The key where the two entities have different values.
      */
     key: keyof EntityType;
+    /**
+     * The display name resolved from metadata.
+     */
+    name: string | undefined;
     /**
      * The value before any changes.
      */
@@ -2920,6 +2946,7 @@ declare abstract class ValidationUtilities {
      */
     static getPropertyValidationError<EntityType extends BaseEntityType<EntityType>>(entity: EntityType, key: keyof EntityType, omit?: 'create' | 'update'): Promise<ValidationError | undefined>;
     private static getArrayStringAutocompleteChipsValidationError;
+    private static getArrayStringDropdownValidationError;
     private static getBooleanValidationError;
     private static getStringValidationError;
     private static getAutocompleteStringValidationError;
@@ -4230,6 +4257,66 @@ declare class NgxMatEntityTableComponent<EntityType extends BaseEntityType<Entit
     static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityTableComponent<any>, "ngx-mat-entity-table", never, { "tableData": { "alias": "tableData"; "required": true; }; }, { "unsavedDialogChanges": "unsavedDialogChanges"; }, never, never, true, never>;
 }
 
+/**
+ * A form component based on the ngx-material-entity framework.
+ */
+declare class NgxMatEntityFormComponent<EntityType extends BaseEntityType<EntityType>> implements OnInit {
+    private readonly injector;
+    EntityUtilities: typeof EntityUtilities;
+    /**
+     * The entity that should be represented by the form.
+     */
+    entity: EntityType;
+    /**
+     * The tabs to display.
+     */
+    entityTabs: EntityTab<EntityType>[];
+    /**
+     * Whether or not the entity is readonly.
+     * @default false
+     */
+    isEntityReadOnly: boolean;
+    /**
+     * Whether to hide a value if it is omitted for creation.
+     * Is used internally for the object property.
+     * @default false
+     */
+    hideOmitForCreate?: boolean;
+    /**
+     * Whether to hide a value if it is omitted for editing.
+     * Is used internally for the object property.
+     * @default false
+     */
+    hideOmitForEdit?: boolean;
+    /**
+     * Additional keys that should be omitted.
+     */
+    additionalOmitKeys?: (keyof EntityType)[];
+    /**
+     * Fires whenever an input of the form changes.
+     */
+    readonly formChange: EventEmitter<void>;
+    /**
+     * Fires when the selected tab has been changed.
+     */
+    readonly selectedTabChange: EventEmitter<MatTabChangeEvent>;
+    constructor(injector: EnvironmentInjector);
+    ngOnInit(): void;
+    /**
+     * Checks if the input with the given key is readonly.
+     * @param key - The key for the input to check.
+     * @returns Whether or not the input for the key is read only.
+     */
+    isReadOnly(key: keyof EntityType): boolean;
+    /**
+     * What happens when an input changes its value.
+     * This refreshes the entity tabs to check if there are now different inputs to display and emits the form change.
+     */
+    inputChange(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxMatEntityFormComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgxMatEntityFormComponent<any>, "ngx-mat-entity-form", never, { "entity": { "alias": "entity"; "required": true; }; "isEntityReadOnly": { "alias": "isEntityReadOnly"; "required": false; }; "hideOmitForCreate": { "alias": "hideOmitForCreate"; "required": false; }; "hideOmitForEdit": { "alias": "hideOmitForEdit"; "required": false; }; "additionalOmitKeys": { "alias": "additionalOmitKeys"; "required": false; }; }, { "formChange": "formChange"; "selectedTabChange": "selectedTabChange"; }, never, never, true, never>;
+}
+
 /**
  * A component that displays an info-symbol and a tooltip when it is hovered/clicked.
  */
@@ -4249,7 +4336,7 @@ declare class TooltipComponent {
  * @returns The method that defines the metadata.
  * @throws When the given type of the array-items is unknown.
  */
-declare function array<EntityType extends BaseEntityType<EntityType>>(metadata: EntityArrayDecoratorConfig<EntityType> | StringChipsArrayDecoratorConfig | AutocompleteStringChipsArrayDecoratorConfig | DateArrayDecoratorConfig | DateTimeArrayDecoratorConfig | DateRangeArrayDecoratorConfig): (target: object, propertyKey: string) => void;
+declare function array<EntityType extends BaseEntityType<EntityType>>(metadata: EntityArrayDecoratorConfig<EntityType> | StringChipsArrayDecoratorConfig | AutocompleteStringChipsArrayDecoratorConfig | StringDropdownArrayDecoratorConfig | DateArrayDecoratorConfig | DateTimeArrayDecoratorConfig | DateRangeArrayDecoratorConfig): (target: object, propertyKey: string) => void;
 
 /**
  * Decorator for setting and getting boolean property metadata.
@@ -4506,5 +4593,5 @@ declare abstract class FileUtilities {
     private static transformToBytes;
 }
 
-export { ArrayDecoratorConfig, DateUtilities, DecoratorTypes, DynamicStyleClassDirective, Entity, EntityService, EntityUtilities, FileUtilities, IncludedInValidatorDirective, NGX_COMPLETE_GLOBAL_DEFAULT_VALUES, NGX_CREATE_DATA, NGX_CREATE_DATA_ENTITY, NGX_CREATE_DATA_ENTITY_SERVICE, NGX_EDIT_DATA, NGX_EDIT_DATA_ENTITY, NGX_EDIT_DATA_ENTITY_SERVICE, NGX_GET_VALIDATION_ERROR_MESSAGE, NGX_GLOBAL_DEFAULT_VALUES, NgxChangesTooltipTitle, NgxMatEntityBaseDisplayColumnValueComponent, NgxMatEntityBaseInputComponent, NgxMatEntityConfirmDialogComponent, NgxMatEntityCreateDialogComponent, NgxMatEntityCreatePageComponent, NgxMatEntityEditDialogComponent, NgxMatEntityEditPageComponent, NgxMatEntityInputComponent, NgxMatEntityTableComponent, NgxValidationErrorsTooltipTitle, NumberDirective, TooltipComponent, TooltipDirective, UnsavedChangesGuard, ValidationUtilities, array, boolean, custom, date, defaultCreateDataRoute, defaultEditDataRoute, exportAsCsvMultiAction, exportAsJsonMultiAction, exportAsXmlMultiAction, file, getChangesTooltipContent, getValidationErrorsTooltipContent, hasMany, importFromJsonMultiAction, number, object, referencesMany, referencesOne, string };
-export type { AutocompleteStringChipsArrayDecoratorConfig, AutocompleteStringDecoratorConfig, BaseData, BaseEntityType, BaseTableAction, CheckboxBooleanDecoratorConfig, Col, ConfirmDialogData, ConfirmDialogTypes, CreateData, CreateDataRoute, CreateEntityData, CustomDecoratorConfig, DateArrayDecoratorConfig, DateRange, DateRangeArrayDecoratorConfig, DateRangeDateDecoratorConfig, DateTimeArrayDecoratorConfig, DateTimeDateDecoratorConfig, DecoratorType, DefaultDateDecoratorConfig, DefaultFileDecoratorConfig, DefaultNumberDecoratorConfig, DefaultObjectDecoratorConfig, DefaultStringDecoratorConfig, Difference, DisplayColumn, DropdownBooleanDecoratorConfig, DropdownNumberDecoratorConfig, DropdownObjectDecoratorConfig, DropdownStringDecoratorConfig, DropdownValue, DynamicStyleClasses, EditAction, EditArrayItemDialogData, EditData, EditDataRoute, EditEntityData, EntityArrayDecoratorConfig, EntityClassNewable, EntityRow, EntityServiceClassNewable, EntityTab, FileData, HasManyDecoratorConfig, Hour, ImageFileDecoratorConfig, Minute, MultiSelectAction, NgxGlobalDefaultValues, NumberDropdownValues, ObjectDropdownValues, PageCreateData, PageEditData, PasswordStringDecoratorConfig, Position, ReferencesManyDecoratorConfig, ReferencesOneDecoratorConfig, SliderNumberDecoratorConfig, StringAutocompleteValues, StringChipsArrayDecoratorConfig, StringDropdownValues, TableAction, TableColumnValue, TableData, TextboxStringDecoratorConfig, Time, ToggleBooleanDecoratorConfig, UnsavedChangesPage, ValidationError };
+export { ArrayDecoratorConfig, DateUtilities, DecoratorTypes, DynamicStyleClassDirective, Entity, EntityService, EntityUtilities, FileUtilities, IncludedInValidatorDirective, NGX_COMPLETE_GLOBAL_DEFAULT_VALUES, NGX_CREATE_DATA, NGX_CREATE_DATA_ENTITY, NGX_CREATE_DATA_ENTITY_SERVICE, NGX_EDIT_DATA, NGX_EDIT_DATA_ENTITY, NGX_EDIT_DATA_ENTITY_SERVICE, NGX_GET_VALIDATION_ERROR_MESSAGE, NGX_GLOBAL_DEFAULT_VALUES, NgxChangesTooltipTitle, NgxMatEntityBaseDisplayColumnValueComponent, NgxMatEntityBaseInputComponent, NgxMatEntityConfirmDialogComponent, NgxMatEntityCreateDialogComponent, NgxMatEntityCreatePageComponent, NgxMatEntityEditDialogComponent, NgxMatEntityEditPageComponent, NgxMatEntityFormComponent, NgxMatEntityInputComponent, NgxMatEntityTableComponent, NgxValidationErrorsTooltipTitle, NumberDirective, TooltipComponent, TooltipDirective, UnsavedChangesGuard, ValidationUtilities, array, boolean, custom, date, defaultCreateDataRoute, defaultEditDataRoute, exportAsCsvMultiAction, exportAsJsonMultiAction, exportAsXmlMultiAction, file, getChangesTooltipContent, getValidationErrorsTooltipContent, hasMany, importFromJsonMultiAction, number, object, referencesMany, referencesOne, string };
+export type { AutocompleteStringChipsArrayDecoratorConfig, AutocompleteStringDecoratorConfig, BaseData, BaseEntityType, BaseTableAction, CheckboxBooleanDecoratorConfig, Col, ConfirmDialogData, ConfirmDialogTypes, CreateData, CreateDataRoute, CreateEntityData, CustomDecoratorConfig, DateArrayDecoratorConfig, DateRange, DateRangeArrayDecoratorConfig, DateRangeDateDecoratorConfig, DateTimeArrayDecoratorConfig, DateTimeDateDecoratorConfig, DecoratorType, DefaultDateDecoratorConfig, DefaultFileDecoratorConfig, DefaultNumberDecoratorConfig, DefaultObjectDecoratorConfig, DefaultStringDecoratorConfig, Difference, DisplayColumn, DropdownBooleanDecoratorConfig, DropdownNumberDecoratorConfig, DropdownObjectDecoratorConfig, DropdownStringDecoratorConfig, DropdownValue, DynamicStyleClasses, EditAction, EditArrayItemDialogData, EditData, EditDataRoute, EditEntityData, EntityArrayDecoratorConfig, EntityClassNewable, EntityRow, EntityServiceClassNewable, EntityTab, FileData, HasManyDecoratorConfig, Hour, ImageFileDecoratorConfig, Minute, MultiSelectAction, NgxGlobalDefaultValues, NumberDropdownValues, ObjectDropdownValues, PageCreateData, PageEditData, PasswordStringDecoratorConfig, Position, ReferencesManyDecoratorConfig, ReferencesOneDecoratorConfig, RequiredStringDropdownValues, SliderNumberDecoratorConfig, StringAutocompleteValues, StringChipsArrayDecoratorConfig, StringDropdownArrayDecoratorConfig, StringDropdownValues, TableAction, TableColumnValue, TableData, TextboxStringDecoratorConfig, Time, ToggleBooleanDecoratorConfig, UnsavedChangesPage, ValidationError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-material-entity",
-  "version": "20.0.3",
+  "version": "20.0.5",
   "license": "MIT",
   "keywords": [
     "angular",
@@ -8,6 +8,9 @@
     "crud",
     "entity"
   ],
+  "repository": {
+    "url": "https://github.com/Service-Soft/ngx-material-entity"
+  },
   "peerDependencies": {
     "@angular/animations": "20",
     "@angular/cdk": "20",