@messaia/cdk 19.0.1 → 20.0.0-RC.1

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

@@ -1,502 +0,0 @@
-import { ChangeDetectorRef, OnDestroy } from '@angular/core';
-import { MatPaginator } from '@angular/material/paginator';
-import { MatSort, SortDirection } from '@angular/material/sort';
-import { ActivatedRoute } from '@angular/router';
-import { Subscription } from 'rxjs';
-import { ActionItem } from '../../common/models/action-item';
-import { IEntity } from '../../common/models/entity';
-import { GenericService } from '../../http/services/generic.service';
-import { VdDynamicTableComponent } from '../../table/components/dynamic-table/dynamic-table.component';
-import { TableColumn } from '../../table/models/table-column';
-import { TableConfig } from '../../table/models/table-config';
-import { TableDataSource } from '../../table/table.data-source';
-import { IGenericListComponent } from '../interfaces/igeneric-list-component';
-import { BaseComponent } from './base.component';
-import * as i0 from "@angular/core";
-/**
- * A base list component for components with pagination support
- */
-export declare abstract class GenericListComponent<TEntity extends IEntity | any, TService extends GenericService<TEntity>> extends BaseComponent implements IGenericListComponent<TEntity>, OnDestroy {
-    service: TService;
-    protected route: ActivatedRoute;
-    protected changeDetectorRef: ChangeDetectorRef;
-    classType?: {
-        new (): TEntity;
-    } | undefined;
-    /**
-     * @property paginator
-     * @description A reference to the MatPaginator element.
-     *              This is used for handling pagination in the data table.
-     * @type {MatPaginator | undefined}
-     */
-    paginator?: MatPaginator;
-    /**
-     * @property sort
-     * @description A reference to the MatSort element.
-     *              This is used for handling sorting functionality in the data table.
-     * @type {MatSort | undefined}
-     */
-    sort?: MatSort;
-    /**
-     * @property pageSizeOptions
-     * @description An array of available page size options for the data table.
-     * @type {number[]}
-     */
-    pageSizeOptions: Array<number>;
-    /**
-     * @property includes
-     * @description Specifies the navigations to include when fetching data.
-     * @type {string[]}
-     */
-    includes: Array<string>;
-    /**
-     * @property projection
-     * @description Specifies the projection(s) to apply when fetching data.
-     *              Can be a single string or an array of strings.
-     * @type {string | string[]}
-     */
-    projection: string | string[];
-    /**
-     * @property excludedColumns
-     * @description Specifies the columns to exclude from the data table.
-     * @type {string[]}
-     */
-    excludedColumns: Array<string>;
-    /**
-     * @property query
-     * @description The query parameters for fetching data from the server.
-     * @type {any}
-     */
-    query: any;
-    /**
-     * @property dataSource
-     * @description The data source for the data table, managing the data displayed.
-     * @type {TableDataSource<TEntity, TService> | any}
-     */
-    dataSource?: TableDataSource<TEntity, TService> | any;
-    /**
-     * @property items
-     * @description Initializes the items array as an optional array of entities.
-     * @type {TEntity[]}
-     */
-    items?: TEntity[];
-    /**
-     * @property sortActive
-     * @description The currently active sort column in the data table.
-     * @type {string | undefined}
-     */
-    sortActive?: string;
-    /**
-     * @property sortDirection
-     * @description The current sort direction for the data table. Default is 'asc'.
-     * @type {SortDirection}
-     */
-    sortDirection: SortDirection;
-    /**
-     * @property classInstance
-     * @description An instance of the class used to create the table for a specific type of entity.
-     * @type {any}
-     */
-    classInstance: any;
-    /**
-     * @property columns
-     * @description An array defining the table columns and their configuration.
-     * @type {TableColumn[]}
-     */
-    columns: TableColumn[];
-    /**
-     * @property columnSets
-     * @description Used to display specific columns in the table.
-     *              This array defines sets of columns that can be shown
-     *              based on the active configuration, allowing for dynamic table
-     *              column customization.
-     * @type {string[]}
-     */
-    columnSets?: string[];
-    /**
-     * @property dynamicTable
-     * @description A reference to the dynamic table component.
-     * @type {VdDynamicTableComponent}
-     */
-    dynamicTable?: VdDynamicTableComponent;
-    /**
-     * @property tableConfig
-     * @description Configuration object for the table, including query and column settings.
-     * @type {TableConfig}
-     */
-    tableConfig: TableConfig;
-    /**
-     * @property addDialogType
-     * @description The type of the dialog used for creating new entries in the table.
-     * @type {any}
-     */
-    addDialogType: any;
-    /**
-     * @property selectable
-     * @description If true, show the column 'Checkbox'.
-     * @type {boolean}
-     */
-    selectable: boolean;
-    /**
-     * @property addable
-     * @description If true, show the button 'Add'.
-     * @type {boolean}
-     */
-    addable: boolean;
-    /**
-     * @property editable
-     * @description If true, show the menu 'Edit'.
-     * @type {boolean}
-     */
-    editable: boolean;
-    /**
-     * @property deletable
-     * @description If true, show the menu 'Delete'.
-     * @type {boolean}
-     */
-    deletable: boolean;
-    /**
-     * @property downloadable
-     * @description If true, show the menu 'Download'.
-     * @type {boolean}
-     */
-    downloadable: boolean;
-    /**
-     * @property duplicable
-     * @description If true, show the menu 'Duplicate'.
-     * @type {boolean}
-     */
-    duplicable: boolean;
-    /**
-     * @property configurable
-     * @description If true, show the menu 'Configure table'.
-     * @type {boolean}
-     */
-    configurable: boolean;
-    /**
-     * @property exportable
-     * @description Determines if the table is exportable.
-     * @type {boolean}
-     */
-    exportable?: boolean;
-    /**
-     * @property exportFileName
-     * @description The name of the file to export.
-     * @type {string}
-     */
-    exportFileName?: string;
-    /**
-     * @property sticky
-     * @description Flag to indicate whether the table headers or columns should stick
-     *              to the viewport during scrolling.
-     * @type {boolean}
-     */
-    sticky: boolean;
-    /**
-     * @property tableWidth
-     * @description Defines the overall width of the table.
-     * @type {number}
-     */
-    tableWidth?: number;
-    /**
-     * @property rowNgClass
-     * @description A function to determine the dynamic CSS class for table rows.
-     * @type {(x: TEntity, ctx: any) => any}
-     */
-    rowNgClass?: (x: TEntity, ctx: any) => any;
-    /**
-     * @property rowClick
-     * @description A function to handle row click events.
-     * @type {(x: TEntity, ctx: any) => any}
-     */
-    rowClick?: (x: TEntity, ctx: any) => any;
-    /**
-     * @property onEdit
-     * @description A function to handle edit actions for a row.
-     * @type {(x: TEntity, ctx: any) => any}
-     */
-    onEdit?: (x: TEntity, ctx: any) => any;
-    /**
-     * @property detailsTemplate
-     * @description Template string for displaying row details.
-     * @type {string}
-     */
-    detailsTemplate?: string;
-    /**
-     * @property toolbarActions
-     * @description Array of toolbar action items.
-     * @type {ActionItem[]}
-     */
-    toolbarActions: ActionItem[];
-    /**
-     * @property toolbarMenuItems
-     * @description Array of toolbar menu items for actions.
-     * @type {ActionItem<TEntity>[]}
-     */
-    toolbarMenuItems: ActionItem<TEntity>[];
-    /**
-     * @property rowMenuItems
-     * @description Array of menu items for actions related to table rows.
-     * @type {ActionItem<TEntity>[]}
-     */
-    rowMenuItems: ActionItem<TEntity>[];
-    /**
-     * @property backButton
-     * @description Adds a back button to the toolbar.
-     * @type {boolean}
-     */
-    backButton: boolean;
-    /**
-     * @property dataLoadedSubscription
-     * @description Subscription to the DataLoaded event.
-     * @type {Subscription}
-     */
-    protected dataLoadedSubscription?: Subscription;
-    /**
-     * @property configsKey
-     * @description The key used for storing table configurations.
-     * @type {string}
-     */
-    protected configsKey: string;
-    /**
-     * Constructor for the table component.
-     * @param service The service used for managing table data.
-     * @param route ActivatedRoute for retrieving route information.
-     * @param changeDetectorRef ChangeDetectorRef for managing view updates.
-     * @param classType The class type of the table entity.
-     */
-    constructor(service: TService, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef, classType?: {
-        new (): TEntity;
-    } | undefined);
-    /**
-     * Lifecycle hook that is called after data-bound properties
-     * of a directive are initialized.
-     */
-    ngOnInit(): void;
-    /**
-     * @method connect
-     * @description Connects a collection viewer (such as a data table) to the data source.
-     *              This method initializes the data source with static field filters and an optional path.
-     *              It also subscribes to the data source to update the displayed items in the table.
-     * @param {any} staticFieldFilters - Optional static field filters to apply when connecting the data source.
-     * @param {string} [path] - Optional path for the data source connection.
-     * @returns {void}
-     */
-    connect(staticFieldFilters?: any, path?: string): void;
-    /**
-     * Updates the table columns
-     */
-    updateColumns(loadConfig?: boolean): void;
-    /**
-     * Reloads items
-     */
-    loadList(resetSelection?: boolean): void;
-    /**
-     * Search
-     * @param filter
-     */
-    search(filter: string): void;
-    /**
-     * Navigates to the add page.
-     */
-    add(): void;
-    /**
-     * Navigates to the edit page.
-     * @param entity - The entity to be edited.
-     * @param context - Additional context data.
-     */
-    edit(entity?: TEntity, context?: any): void;
-    /**
-     * Patches the entity
-     * Patches the entity
-     * @param id The ID of the entity
-     * @param fields The fields to patch
-     * @param value The (optional) value to change
-     * @param includes Includes some navigations
-     */
-    patch(id: number, fields: Array<string>, value: any, includes?: any): void;
-    /**
-     * Patches the entity
-     * @param id The ID of the entity
-     * @param fields The fields to patch
-     * @param value The (optional) value to change
-     * @param includes Includes some navigations
-     * @param successCallback A callback function to e called on success
-     */
-    protected _patch(id: number, fields: Array<string>, value: any, includes?: any, successCallback?: Function): void;
-    /**
-     * Deletes an item from the database.
-     */
-    deleteItem(entity?: TEntity): void;
-    /**
-     * Deletes an item from the database.
-     */
-    deleteItems(): void;
-    /**
-     * Toggles a property.
-     * This method supports both direct and nested properties.
-     *
-     * @param item - The object whose property will be toggled.
-     * @param property - The path to the property to toggle, which can be a nested property (e.g., 'profile.name').
-     */
-    toggle(item: TEntity, property?: string): void;
-    /**
-     * Uploads tarnsfers csv files
-     * @param file The file to upload
-     * @param reload If true, reload items
-     */
-    upload(file: File, reload?: boolean): void;
-    /**
-     * Downloads a document
-     * @param entity
-     */
-    download(entity?: TEntity, path?: string): void;
-    /**
-     * Duplicates a record
-     * @param entity
-     */
-    duplicate(entity?: TEntity): void;
-    /**
-     * This informs the table how to uniquely identify rows to
-     * track how the data changes with each update.
-     * @param index
-     * @param item
-     */
-    trackById(_: number, item: any): any;
-    /**
-     * Opens the config dialog
-     */
-    openConfigDialog(): void;
-    /**
-     * Opens the export dialog
-     */
-    openExportDialog(): void;
-    /**
-     * Saves the table config
-     * @param tableConfig
-     */
-    saveConfigs(tableConfig: TableConfig): void;
-    /**
-     * Gets and applies the table column configs
-     */
-    loadColumnConfigs(): void;
-    /**
-     * Includes some navigations
-     * @param inc
-     */
-    protected include(...inc: string[]): void;
-    /**
-     * Add toolbar menu items
-     */
-    protected addToolbarMenuItems(): void;
-    /**
-     * Add row menu items
-     */
-    protected addRowMenuItems(): void;
-    /**
-     * Determines if the given item can be selected.
-     *
-     * An item is considered selectable if:
-     * - It does not have the `selectable` property, or the property is `true`.
-     * - It does not have the `isSelectable` property, or the property is `true`.
-     *
-     * @param entity The item to check.
-     * @returns `true` if the item is selectable; otherwise, `false`.
-     */
-    protected canSelectItem(entity?: TEntity): boolean;
-    /**
-     * Determines if the given item can be deleted.
-     *
-     * An item is considered deletable if:
-     * - The `canDelete` flag is `true`.
-     * - It does not have the `deletable` property, or the property is `true`.
-     * - It does not have the `isDeletable` property, or the property is `true`.
-     *
-     * @param entity The item to check.
-     * @returns `true` if the item is deletable; otherwise, `false`.
-     */
-    protected canDeleteItem(entity?: TEntity): boolean;
-    /**
-     * Determines if the given item can be edited.
-     *
-     * An item is considered editable if:
-     * - The `canUpdate` flag is `true`.
-     * - It does not have the `editable` property, or the property is `true`.
-     * - It does not have the `isEditable` property, or the property is `true`.
-     *
-     * @param entity The item to check.
-     * @returns `true` if the item is editable; otherwise, `false`.
-     */
-    protected canEditItem(entity?: TEntity): boolean;
-    /**
-     * Determines if the given item can be downloaded.
-     *
-     * An item is considered downloadable if:
-     * - It does not have the `downloadable` property, or the property is `true`.
-     * - It does not have the `isDownloadable` property, or the property is `true`.
-     *
-     * @param entity The item to check.
-     * @returns `true` if the item is downloadable; otherwise, `false`.
-     */
-    protected canDownloadItem(entity?: TEntity): boolean;
-    /**
-     * Determines if the given item can be duplicated.
-     *
-     * An item is considered duplicable if:
-     * - It does not have the `duplicable` property, or the property is `true`.
-     * - It does not have the `isDuplicable` property, or the property is `true`.
-     *
-     * @param entity The item to check.
-     * @returns `true` if the item is duplicable; otherwise, `false`.
-     */
-    protected canDuplicateItem(entity?: TEntity): boolean;
-    /**
-     * Returns NgClass object for select column
-     */
-    protected selectRowNgClass(_: TEntity): any;
-    /**
-     * Check if the there any selected row
-     * @returns
-     */
-    protected hasSelectedRows(): boolean;
-    /**
-     * Event emitted when the entity has been deleted.
-     */
-    protected onAfterItemDeleted(item: IEntity): void;
-    /**
-     * Event emitted when the entities has been deleted.
-     */
-    protected onAfterItemsDeleted(ids: number[]): void;
-    /**
-     * Checks if the user can perform multiple operations (Like 'delete selected').
-     * @param action
-     * @returns
-     */
-    protected canExecuteMultipleOperations(action?: Function): boolean;
-    /**
-     * Gets the value of a nested property from an object.
-     *
-     * @param obj - The object to query.
-     * @param path - The path to the property, which can be delimited by a custom character (e.g., dot, slash).
-     * @param delimiter - The delimiter used to separate levels in the property path (default is '.').
-     * @returns - The value of the nested property or undefined if not found.
-     */
-    protected getNestedProperty(obj: any, path: string, delimiter?: string): any;
-    /**
-     * Responds to user-initiated events
-     * @param event
-     */
-    handleKeyboardEvent(event: KeyboardEvent): void;
-    /**
-     * A callback used for any custom cleanup that needs to occur
-     * when the instance is destroyed.
-     */
-    ngOnDestroy(): void;
-    /**
-     * The Symbol.toStringTag well-known symbol is a string valued property that is used
-     * in the creation of the default string description of an object
-     */
-    get [Symbol.toStringTag](): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<GenericListComponent<any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericListComponent<any, any>, never, never, { "backButton": { "alias": "backButton"; "required": false; }; }, {}, never, never, true, never>;
-}

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

@@ -1,65 +0,0 @@
-import { ChangeDetectorRef, Type } from '@angular/core';
-import { FormGroup } from '@angular/forms';
-import { ActivatedRoute } from '@angular/router';
-import { IEntity } from '../../common/common.module';
-import { FormBuilderConfiguration } from '../../form-validators/models';
-import { PropValidationConfig } from '../../form-validators/models/prop-validation-config';
-import { RxFormBuilder } from '../../form-validators/public_api';
-import { GenericService } from '../../http/http.module';
-import { IGenericReactiveFormBaseComponent } from '../interfaces/igeneric-reactive-form-base';
-import { GenericFormBaseComponent } from './generic-form-base.component';
-import * as i0 from "@angular/core";
-export declare abstract class GenericReactiveFormComponent<TEntity extends IEntity, TService extends GenericService<TEntity>> extends GenericFormBaseComponent<TEntity, TService> implements IGenericReactiveFormBaseComponent<TEntity> {
-    entityCtor: Type<TEntity>;
-    protected service: TService;
-    protected route: ActivatedRoute;
-    protected changeDetectorRef: ChangeDetectorRef;
-    /**
-     * Form group
-     */
-    get form(): FormGroup;
-    set form(form: FormGroup | undefined);
-    /**
-     * Form builder
-     */
-    protected formBuilder: RxFormBuilder;
-    /**
-     * formBuilderConfig: FormBuilderConfiguration
-     */
-    protected formBuilderConfig: FormBuilderConfiguration;
-    /**
-     * Gets form value
-     */
-    get formValue(): TEntity | any;
-    /**
-     * formValidation: any
-     */
-    formValidation?: {
-        [key: string]: PropValidationConfig;
-    };
-    /**
-     * buildFieldGroups: boolean
-     * Builds field groups, if true
-     */
-    buildFieldGroups: boolean;
-    /**
-     * Constructor
-     * @param service
-     */
-    constructor(entityCtor: Type<TEntity>, service: TService, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
-    /**
-     * Builds a new form
-     */
-    protected buildForm(): void;
-    /**
-     * Event emitted when the form has built.
-     */
-    protected onAfterFormBuild(): void;
-    /**
-     * Shows form errors
-     * @param form
-     */
-    protected debugForm(form?: FormGroup): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<GenericReactiveFormComponent<any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericReactiveFormComponent<any, any>, never, never, { "form": { "alias": "form"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/base/components/task-dialog/task-dialog.component.d.ts

@@ -1,63 +0,0 @@
-import { AfterViewInit, OnDestroy } from '@angular/core';
-import { MatDialogRef } from '@angular/material/dialog';
-import { TaskDialogData } from '../../models/task-dialog-data';
-import * as i0 from "@angular/core";
-export declare class VdTaskDialogComponent implements AfterViewInit, OnDestroy {
-    private dialogRef;
-    protected data: TaskDialogData<any>;
-    /**
-     * The message content displayed within the dialog.
-     * @type {string | undefined}
-     */
-    content?: string;
-    /**
-     * The result of the task, if available.
-     * @type {any}
-     */
-    result?: any;
-    /**
-     * Indicates whether the task is currently in progress.
-     * @type {boolean}
-     */
-    inProgress: boolean;
-    /**
-     * Indicates if the task completed successfully.
-     * @type {boolean}
-     */
-    succeeded: boolean;
-    /**
-     * Subject to manage task cancellation and component cleanup.
-     * @type {Subject<void>}
-     */
-    private unsubscribe;
-    /**
-     * Constructor
-     * @param {MatDialogRef<VdTaskDialogComponent>} dialogRef - Reference to the dialog instance.
-     * @param {TaskDialogData<any>} data - Data passed into the dialog.
-     */
-    constructor(dialogRef: MatDialogRef<VdTaskDialogComponent>, data: TaskDialogData<any>);
-    /**
-     * Lifecycle hook after view initialization.
-     * Subscribes to the task observable and handles success or error callbacks.
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Cancels the task and closes the dialog without any result.
-     */
-    cancel(): void;
-    /**
-     * Closes the dialog without any result.
-     */
-    close(): void;
-    /**
-     * Closes the dialog and returns the task result on success.
-     */
-    success(): void;
-    /**
-     * Lifecycle hook for component cleanup on destruction.
-     * Ensures that any ongoing task is cancelled.
-     */
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<VdTaskDialogComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<VdTaskDialogComponent, "vd-task-dialog", never, {}, {}, never, never, false, never>;
-}

package/lib/base/constants/common.d.ts

@@ -1,12 +0,0 @@
-import { InjectionToken } from "@angular/core";
-export declare const EXPORT_DIALOG_COMPONENT: InjectionToken<string>;
-export declare const Common: {
-    allowedExtensions: string[];
-    editorPlugins: string;
-    editorToolbar: string;
-    months: {
-        name: string;
-        id: number;
-    }[];
-    postalCodePattern: (country: string) => RegExp | "";
-};

package/lib/base/constants/global-roles.d.ts

@@ -1,8 +0,0 @@
-export declare const GlobalRoles: {
-    Administrator: string;
-    SystemAdministrator: string;
-    SystemSupervisor: string;
-    ClientAdministrator: string;
-    DepartmentAdministrator: string;
-    ExternalAPI: string;
-};

package/lib/base/enums/message-type.d.ts

@@ -1,5 +0,0 @@
-export declare enum MessageType {
-    Success = 0,
-    Warning = 1,
-    Error = 2
-}

package/lib/base/helpers/auth-helper.d.ts

@@ -1,26 +0,0 @@
-import { AuthUser } from "../models/auth-user";
-export declare class AuthHelper {
-    /**
-     * Authenticated user
-     */
-    static user: AuthUser;
-    /**
-     * Checks if the current user is authenticated
-     */
-    static isAuthenticated(): boolean;
-    /**
-     * Checks if the user has the specified permission
-     * @param permission The permission to check
-     */
-    static isPermitted(...permissions: string[]): boolean;
-    /**
-     * Checks if the current user has on of the specified roles
-     * @param roles
-     */
-    static hasRole(...roles: string[]): boolean;
-    /**
-     * Checks if the specified variable is a string
-     * @param str
-     */
-    static isString(str: any): str is string | String;
-}