@messaia/cdk 19.0.2 → 20.0.0-RC.2

package/lib/base/components/generic-embedded-list.component.d.ts

@@ -1,102 +0,0 @@
-import { ChangeDetectorRef, Type } from '@angular/core';
-import { FormGroup } from '@angular/forms';
-import { ActivatedRoute } from '@angular/router';
-import { ActionItem, IEntity } from '../../common/common.module';
-import { RxFormBuilder } from '../../form-validators/services/rx-form-builder';
-import { GenericService } from '../../http/http.module';
-import { GenericListComponent } from './generic-list.component';
-import * as i0 from "@angular/core";
-/**
- * @class GenericEmbeddedListComponent
- *
- * A base class for managing a list of embedded items within a form.
- * It provides common functionalities for adding, removing, and managing items.
- */
-export declare abstract class GenericEmbeddedListComponent<TEntity extends IEntity, TParent extends IEntity, TService extends GenericService<TEntity>> extends GenericListComponent<TEntity, TService> {
-    protected entity: Type<TEntity>;
-    service: TService;
-    protected formBuilder: RxFormBuilder;
-    protected route: ActivatedRoute;
-    protected changeDetectorRef: ChangeDetectorRef;
-    /**
-     * The reactive form associated with this component.
-     */
-    form?: FormGroup;
-    /**
-     * The parent entity that this component is associated with.
-     */
-    parent?: TParent;
-    /**
-     * A prefix for hashing purposes, default is an empty string.
-     */
-    hashPrefix: string;
-    /**
-     * Determines whether the list supports pagination.
-     * If true, pagination controls will be available for navigating through the data.
-     */
-    paginable: boolean;
-    /**
-     * @property pageSize
-     * @description The number of items displayed per page in the data-table.
-     * It controls how many records are shown on a single page.
-     * @type {number}
-     */
-    pageSize: number;
-    /**
-     * The name of the property representing the list of items.
-     */
-    protected itemsPropertyName: string;
-    /**
-     * Menu options for managing a list of items, including delete and more options.
-     */
-    itemListMenu: ActionItem<TEntity>[];
-    /**
-     * Constructor for initializing the component.
-     *
-     * @param entity The type of entity being managed.
-     * @param service The service for managing entity operations.
-     * @param formBuilder The builder for creating reactive forms.
-     * @param route The activated route for navigation.
-     * @param changeDetectorRef The change detector for managing view updates.
-     */
-    constructor(entity: Type<TEntity>, service: TService, formBuilder: RxFormBuilder, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
-    /**
-     * Lifecycle hook called after the constructor.
-     * Initializes input properties and sets up data fetching.
-     */
-    ngOnInit(): void;
-    /**
-     * Adds a new item to the current list.
-     *
-     * @param init Optional initial values for the new entity.
-     */
-    addItem(init?: Partial<TEntity>): void;
-    /**
-     * Removes an item from the list and the form.
-     *
-     * @param index The index of the item to remove.
-     */
-    removeItem(index: number): void;
-    /**
-     * Clears all items from the list and the form.
-     */
-    clearItems(): void;
-    /**
-     * Abstract method to fetch data for the list.
-     * Must be implemented by derived classes.
-     */
-    protected abstract getFetchData(): any;
-    /**
-     * Creates a new instance of the TEntity.
-     *
-     * @param init Optional initial values for the entity.
-     * @returns A new instance of TEntity.
-     */
-    protected newInstance(init: Partial<TEntity>): TEntity;
-    /**
-     * Adds menu items to the row options for managing individual items.
-     */
-    protected addRowMenuItems(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<GenericEmbeddedListComponent<any, any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericEmbeddedListComponent<any, any, any>, never, never, { "form": { "alias": "form"; "required": false; }; "parent": { "alias": "parent"; "required": false; }; "hashPrefix": { "alias": "hashPrefix"; "required": false; }; "paginable": { "alias": "paginable"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/base/components/generic-form-base.component.d.ts

@@ -1,424 +0,0 @@
-import { StepperSelectionEvent } from '@angular/cdk/stepper';
-import { HttpHeaders } from '@angular/common/http';
-import { ChangeDetectorRef, OnChanges, SimpleChanges, Type } from '@angular/core';
-import { AbstractControl, FormGroup, NgForm } from '@angular/forms';
-import { MatStepper } from '@angular/material/stepper';
-import { ActivatedRoute } from '@angular/router';
-import { Observable } from 'rxjs';
-import { ActionItem } from '../../common/models/action-item';
-import { IEntity } from '../../common/models/entity';
-import { Permission } from '../../common/models/permission';
-import { SaveAction } from '../../common/models/save-action';
-import { FormDefinition } from '../../forms/models/form-definition';
-import { FormFieldGroupDefinition } from '../../forms/models/form-field-group-definition';
-import { GenericService } from '../../http/services/generic.service';
-import { IGenericFormBaseComponent } from '../interfaces/igeneric-form-base';
-import { BaseComponent } from './base.component';
-import * as i0 from "@angular/core";
-export declare abstract class GenericFormBaseComponent<TEntity extends IEntity, TService extends GenericService<TEntity>> extends BaseComponent implements IGenericFormBaseComponent<TEntity>, OnChanges {
-    entityCtor: Type<TEntity>;
-    protected service: TService;
-    protected route: ActivatedRoute;
-    protected changeDetectorRef: ChangeDetectorRef;
-    /**
- * The action of the form (add | edit).
- */
-    action: string;
-    /**
-     * Indicates if the form is in edit mode.
-     */
-    isEditMode: boolean;
-    /**
-     * Save action enumeration.
-     */
-    SaveAction: typeof SaveAction;
-    /**
-     * Navigation routes.
-     */
-    editSaveAndCloseRoute: string;
-    addSaveAndCloseRoute: string;
-    addSaveAndEditRoute: string;
-    addSaveAndNewRoute: string;
-    listRoute: string;
-    /**
-     * The ID of the item to load.
-     */
-    protected _id?: number | string;
-    /**
-     * The ID of the item to load.
-     */
-    get id(): number | string | undefined;
-    set id(id: number | string | undefined);
-    /**
-     * The current item to add or edit.
-     */
-    protected _item?: TEntity;
-    /**
-     * The current item to add or edit.
-     */
-    get item(): TEntity | undefined;
-    set item(item: TEntity | undefined);
-    /**
-     * Represents the request errors.
-     */
-    errors: Array<string>;
-    /**
-     * Includes fields for query.
-     */
-    includes: string[];
-    /**
-     * Update includes fields for query.
-     */
-    updateIncludes: string[];
-    /**
-     * Projection fields for query.
-     */
-    projection?: string[];
-    /**
-     * Query parameters.
-     */
-    query: any;
-    /**
-     * Read-only flag.
-     */
-    readonly: boolean;
-    /**
-     * Disabled flag.
-     */
-    disabled: boolean;
-    /**
-     * The current date.
-     */
-    currentDate: Date;
-    /**
-     * Date & time input mask.
-     */
-    dateTimeMask: (string | number | RegExp)[];
-    /**
-     * Date input mask.
-     */
-    dateMask: (string | number | RegExp)[];
-    /**
-     * Time input mask.
-     */
-    timeMask: (string | RegExp)[];
-    /**
-     * Date validation pattern.
-     */
-    datePattern: string;
-    /**
-     * Phone prefix validation pattern.
-     */
-    phonePrefixPattern: string;
-    /**
-     * Phone number validation pattern.
-     */
-    phoneNumberPattern: string;
-    /**
-     * Password validation pattern.
-     */
-    passwordPattern: string;
-    /**
-     * Editor options including default modules and toolbar configuration.
-     */
-    editorOptions: {
-        modules: {
-            toolbar: (string[] | {
-                list: string;
-            }[] | {
-                indent: string;
-            }[] | {
-                size: (string | boolean)[];
-            }[] | {
-                header: (number | boolean)[];
-            }[] | ({
-                color: any[];
-                background?: undefined;
-            } | {
-                background: any[];
-                color?: undefined;
-            })[])[];
-            clipboard: {
-                matchVisual: boolean;
-            };
-        };
-    };
-    /**
-     * If true, shows the 'Delete' menu.
-     */
-    deletable: boolean;
-    /**
-     * Toolbar menu items.
-     */
-    toolbarMenuItems: ActionItem[];
-    /**
-     * Toolbar action buttons.
-     */
-    toolbarActions: ActionItem<TEntity, IGenericFormBaseComponent<TEntity>>[];
-    /**
-     * MatStepper reference.
-     */
-    protected matStepper?: MatStepper;
-    /**
-     * Reference to the input elements.
-     */
-    input: any;
-    /**
-     * Form group instance.
-     */
-    _form?: NgForm | FormGroup;
-    /**
-     * Form group.
-     */
-    get form(): NgForm | FormGroup | undefined;
-    set form(form: NgForm | FormGroup | undefined);
-    /**
-     * Gets the form value.
-     */
-    abstract get formValue(): TEntity | any;
-    /**
-     * Form definition.
-     */
-    formDefinition?: FormDefinition;
-    /**
-     * Field groups definition.
-     */
-    fieldGroups?: FormFieldGroupDefinition[];
-    /**
-     * Constructor.
-     * @param service The service to manage the entity.
-     * @param route The activated route.
-     * @param changeDetectorRef The change detector reference.
-     */
-    constructor(entityCtor: Type<TEntity>, service: TService, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
-    /**
-     * Called after the constructor, initializing input properties,
-     * and the first call to ngOnChanges.
-     */
-    ngOnInit(): void;
-    /**
-     * Lifecycle hook that is called after a component's view has been fully initialized.
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Called before any other lifecycle hook. Use it to inject dependencies,
-     * but avoid any serious work here.
-     * @param changes The changes object.
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * Loads an item by ID.
-     * This method fetches the item if the component is in edit mode and the service endpoint is defined.
-     *
-     * @param callback - A function to be called after the item has been successfully loaded.
-     *                   This function will receive the loaded item as an argument.
-     */
-    loadItem(callback?: (item: {
-        entity: TEntity;
-        permissions: Permission;
-    }) => void): void;
-    /**
-     * Loads an item by ID asynchronously.
-     * @returns An Observable of the loaded entity.
-     */
-    loadItemAsync(): Observable<{
-        entity: TEntity;
-        permissions: Permission;
-    }>;
-    /**
-     * Saves data into the database.
-     * This method validates the form, checks if it's valid, and sends data to the server to either update or create a new record.
-     * @param action The save action to perform.
-     * @param form The form to validate and save.
-     */
-    save(action?: SaveAction, form?: NgForm | FormGroup): void;
-    /**
-     * Saves data and navigates to the edit view.
-     */
-    apply(): void;
-    /**
-     * Deletes the current record.
-     * This method shows a confirmation dialog and deletes the record if the user confirms.
-     * @param httpHeaders Optional HTTP headers to include in the delete request.
-     */
-    delete(httpHeaders?: HttpHeaders): void;
-    /**
-     * Initializes the form.
-     * This method sets up the form by extracting query parameters, setting the entity ID, and building the form.
-     */
-    protected init(): void;
-    /**
-     * Builds the form fields.
-     * This method constructs form fields based on the entity's form definition and includes necessary navigation and menu items.
-     */
-    protected buildFields(): void;
-    /**
-     * Builds a new form.
-     * This method should be implemented to construct the form for the specific entity.
-     */
-    protected buildForm(): void;
-    /**
-     * Validates the form.
-     * This method sets the form as submitted, updates its validity, and optionally logs debug information.
-     * @param form The form to validate.
-     */
-    validateForm(form?: NgForm | FormGroup): void;
-    /**
-     * Checks if the form is valid.
-     * This method validates the form, marks invalid controls, and shows error messages if any.
-     * @param form The form to check for validity.
-     * @returns A boolean indicating whether the form is valid.
-     */
-    isFormValid(form?: NgForm | FormGroup): boolean;
-    /**
-     * Resets form controls.
-     * This method marks all controls in the form as pristine, untouched, and updates their validity.
-     * @param form The form to reset.
-     */
-    resetForm(form: NgForm): void;
-    /**
-     * Invalidates controls recursively.
-     * This method marks all controls in the group as dirty and touched if they are invalid.
-     * @param control The control or group of controls to invalidate.
-     */
-    protected invalidateControl(control: AbstractControl): void;
-    /**
-     * Shows form errors.
-     * This method logs form control errors to the console if debugging is enabled.
-     * @param form The form to debug.
-     */
-    protected debugForm(form?: NgForm | FormGroup): void;
-    /**
-     * Adds toolbar menu items.
-     * This method adds the 'Delete' menu item to the toolbar if the entity is deletable.
-     */
-    protected addToolbarMenuItems(): void;
-    /**
-     * Loads the previous URL in the history list.
-     * This method navigates back to the previous URL or performs specific actions based on the save action.
-     * @param action The save action that determines the navigation behavior.
-     */
-    back(action?: SaveAction): void;
-    /**
-     * Sets the return URL.
-     * This method sets the return URL and updates the list route accordingly.
-     * @param returnUrl The URL to return to after the current action is complete.
-     */
-    protected setReturnUrl(returnUrl: string): void;
-    /**
-     * Creates a new instance of TEntity.
-     * This method initializes a new entity using the provided constructor.
-     * @param init Optional partial initialization object.
-     * @returns A new instance of TEntity.
-     */
-    protected newInstance(init?: Partial<TEntity>): TEntity;
-    /**
-     * Creates the entity.
-     * This method sends a request to create a new entity on the server.
-     * @param httpOptions Optional HTTP options for the request.
-     * @param httpHeaders Optional HTTP headers for the request.
-     * @param path A relative path to the action
-     * @returns An Observable of the created TEntity.
-     */
-    protected create<TEntity>(httpOptions?: Object, httpHeaders?: HttpHeaders, path?: string): Observable<TEntity>;
-    /**
-     * Updates the entity.
-     * This method sends a request to update an existing entity on the server.
-     * @param httpOptions Optional HTTP options for the request.
-     * @param httpHeaders Optional HTTP headers for the request.
-     * @returns An Observable of the updated TEntity.
-     */
-    protected update(httpOptions?: Object, httpHeaders?: HttpHeaders): Observable<TEntity>;
-    /**
-     * Includes specified navigations.
-     * This method adds specified navigation properties to the includes array,
-     * optionally adding them to the updateIncludes array as well.
-     * @param inc The navigation property to include.
-     * @param update Whether to include in updateIncludes array.
-     */
-    protected include(inc: string, update?: boolean): void;
-    /**
-     * Checks if the item is deletable.
-     * This method determines if the current item can be deleted based on its properties.
-     * @returns True if the item can be deleted, false otherwise.
-     */
-    protected canDeleteItem(): boolean;
-    /**
-     * Event emitted when the ID is set.
-     * This method triggers the loading of the item when the ID is set.
-     */
-    protected onAfterSetId(): void;
-    /**
-     * Event emitted when the selected step has changed.
-     * This method handles actions to be taken when the stepper selection changes.
-     * @param $event The stepper selection event.
-     */
-    protected onAfterStepChange($event: StepperSelectionEvent): void;
-    /**
-     * Sets the selected step in the stepper based on the URL hash.
-     * Marks all previous steps as completed.
-     */
-    protected selectStepBasedOnUrlHash(): void;
-    /**
-     * Event emitted when the entity has been loaded.
-     * This method handles actions to be taken after the entity is loaded.
-     */
-    protected onAfterItemLoaded(): void;
-    /**
-     * Event emitted before the form is built.
-     * This method allows performing operations before the form is constructed.
-     */
-    protected onBeforeFormBuild(): void;
-    /**
-     * Event emitted when the form has been built.
-     * This method handles actions to be taken after the form is constructed,
-     * such as disabling form controls if the form is set to be disabled.
-     */
-    protected onAfterFormBuild(): void;
-    /**
-     * Event emitted when the entity has been created.
-     */
-    protected onBeforeCreate(): void;
-    /**
-     * Event emitted when the entity has been updated.
-     */
-    protected onBeforeUpdate(): void;
-    /**
-     * Called before data submission.
-     * This method allows performing operations before submitting data.
-     */
-    protected beforeSubmit(_?: SaveAction): void;
-    /**
-     * Event emitted after data submission.
-     * This method handles post-submission actions such as resetting the saving state,
-     * updating the change detector, and navigating back based on the save action.
-     * @param action The save action taken (e.g., SaveAndClose, SaveAndNew).
-     * @param response The response received after submission.
-     */
-    protected onAfterSubmit(action?: SaveAction, response?: any): void;
-    /**
-     * Called after the page is reloaded.
-     * This method reinitializes the item with a new instance and applies any query parameters.
-     */
-    protected afterReload(): void;
-    /**
-     * Sets focus to the first input element.
-     * Ensures the first input element in the form is focused for user convenience.
-     */
-    protected focus(): void;
-    /**
-     * Retrieves the error message for a given native element.
-     * This method navigates through the DOM structure to find error messages associated with form fields.
-     * @param nativeElement The DOM element to check for errors.
-     * @returns The error message associated with the element, or undefined if no error is found.
-     */
-    protected getElementError(nativeElement: any): string | undefined;
-    /**
-     * Responds to user-initiated keyboard events.
-     * This method listens for specific key combinations and triggers save actions or form cancellation.
-     * @param event The keyboard event triggered by the user.
-     */
-    handleKeyboardEvent(event: KeyboardEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<GenericFormBaseComponent<any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericFormBaseComponent<any, any>, never, never, { "id": { "alias": "id"; "required": false; }; "_item": { "alias": "_item"; "required": false; }; "item": { "alias": "item"; "required": false; }; "includes": { "alias": "includes"; "required": false; }; "updateIncludes": { "alias": "updateIncludes"; "required": false; }; "projection": { "alias": "projection"; "required": false; }; "query": { "alias": "query"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "form": { "alias": "form"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/base/components/generic-form.component.d.ts

@@ -1,29 +0,0 @@
-import { ChangeDetectorRef, Type } from '@angular/core';
-import { NgForm } from '@angular/forms';
-import { ActivatedRoute } from '@angular/router';
-import { IEntity } from '../../common/models/entity';
-import { GenericService } from '../../http/services/generic.service';
-import { GenericFormBaseComponent } from './generic-form-base.component';
-import * as i0 from "@angular/core";
-export declare abstract class GenericFormComponent<TEntity extends IEntity, TService extends GenericService<TEntity>> extends GenericFormBaseComponent<TEntity, TService> {
-    entityCtor: Type<TEntity>;
-    protected service: TService;
-    protected route: ActivatedRoute;
-    protected changeDetectorRef: ChangeDetectorRef;
-    /**
-     * Form group
-     */
-    get form(): NgForm;
-    set form(form: NgForm);
-    /**
-     * Gets form value
-     */
-    get formValue(): TEntity | any;
-    /**
-     * Constructor
-     * @param service
-     */
-    constructor(entityCtor: Type<TEntity>, service: TService, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
-    static ɵfac: i0.ɵɵFactoryDeclaration<GenericFormComponent<any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericFormComponent<any, any>, never, never, { "form": { "alias": "form"; "required": false; }; }, {}, never, never, true, never>;
-}