@messaia/cdk 18.1.0-rc21 → 18.1.0-rc23

package/lib/base/components/base.component.d.ts

@@ -18,198 +18,208 @@ import { AuthUser } from '../models/auth-user';
 import { VdTaskDialogComponent } from './task-dialog/task-dialog.component';
 import * as i0 from "@angular/core";
 /**
- * A base list component for components with pagination support
+ * A base list component for components with pagination support.
  */
 export declare abstract class BaseComponent implements IBaseComponent, OnInit, AfterViewInit {
     protected route: ActivatedRoute;
     protected changeDetectorRef: ChangeDetectorRef;
     /**
-     * App settings
+     * Application settings.
      */
     appSetting: AppSetting;
     /**
-     * settings: Any
+     * General configuration settings, with a flexible type to accommodate different configurations.
      */
     settings: any;
     /**
-     * Menu items
+     * Menu items for navigation.
      */
     menu?: Menu;
     /**
-     * The name of the project
+     * Name of the project, used for display or logging purposes.
      */
     projectName?: string;
     /**
-     * The title of the current page
+     * Title of the current page, displayed in the page header.
      */
     title?: string;
     /**
-     * The subtitle of the current outlet
+     * Subtitle of the current outlet, used for additional page context.
      */
     subtitle?: string;
     /**
-     * If true, use some dummy data and show debug logs
+     * If true, dummy data is used for testing, and debug logs are enabled.
      */
     debug: boolean;
     /**
-     * Loading status
+     * Indicates whether a loading process is active, often used to show a loading spinner.
      */
     isLoading: boolean;
     /**
-     * handleExpansionPanelChanges: boolean
+     * Determines whether to handle changes in expansion panels.
      */
     handleExpansionPanelChanges: boolean;
     /**
-     * Saving status
+     * Indicates whether a save operation is currently in progress.
      */
     _isSaving: boolean;
     get isSaving(): boolean;
     set isSaving(isSaving: boolean);
     /**
-     * A flag eindicates that the editor is inited
+     * Indicates whether the editor has been initialized.
      */
-    isEditorInitialzed: boolean;
+    isEditorInitialized: boolean;
     /**
-     * Represents the request errors
+     * Stores any errors encountered during requests or operations.
      */
     errors: Array<string>;
     /**
-     * Used to evaluate whether a given media query is true or false given the current device's screen / window size.
+     * Utility to evaluate media queries based on the current screen or window size.
      */
     media: VdMediaService;
     /**
-     * Allowed file extensions
+     * List of permitted file extensions for upload or selection.
      */
     allowedExtensions: string[];
     /**
-     * tinyMCE plugins
+     * Plugins enabled in the TinyMCE editor.
      */
     editorPlugins: string;
     /**
-     * tinyMCE editor
+     * Toolbar configuration for TinyMCE editor.
      */
     editorToolbar: string;
     /**
-     * Editor configuration
+     * Additional configuration settings for the editor.
      */
     editorConfig: any;
     /**
-     * Provides the navigation and url manipulation capabilities.
+     * Service for navigation and URL manipulation.
      */
     router: Router;
     /**
-     * urlHash: string
+     * Optional hash value appended to URLs for bookmarking or state management.
      */
     urlHash?: string;
     /**
-     * Class name
+     * CSS class name(s) applied to the component.
      */
     className?: string;
     /**
-     * Create permission
+     * Permission flag for creating new entries.
      */
     canCreate: boolean;
     /**
-     * Update permission
+     * Permission flag for updating existing entries.
      */
     canUpdate: boolean;
     /**
-     * Delete permission
+     * Permission flag for deleting entries.
      */
     canDelete: boolean;
     /**
-     * Current route
+     * Full path of the current route.
      */
     currentRoute?: string;
     /**
-     * Current base route
+     * Base path of the current route, excluding specific parameters or sub-paths.
      */
     currentBaseRoute?: string;
     /**
-     * A url to return to after save
+     * URL to navigate back to after saving changes.
      */
     returnUrl?: string;
     /**
-     * Current user object
+     * Object representing the current authenticated user.
      */
     currentUser: AuthUser;
     /**
-     * Is the current user a client admin
+     * Indicates if the current user has admin privileges.
      */
     isAdmin: boolean;
     /**
-     * Is the current user a client admin
+     * Indicates if the current user has client admin privileges.
      */
     isClientAdmin: boolean;
     /**
-     * Is the current user a department admin
+     * Indicates if the current user has department admin privileges.
      */
     isDepartmentAdmin: boolean;
     /**
-     * reload?: function
+     * Event emitter for reload actions, useful for refreshing data.
      */
     reload: EventEmitter<any>;
     /**
-     * A service that can be used to get and set the title of a current HTML document.
+     * Service for setting the document's title.
      */
     protected titleService: Title;
     /**
-     * A service to dispatch Material Design snack bar messages.
+     * Service for displaying snack bar notifications.
      */
     protected snackBarService: MatSnackBar;
     /**
-     * A service to show conirm and prompt dialogs.
+     * Service for displaying confirmation and prompt dialogs.
      */
     protected dialogService: VdDialogService;
     /**
-     * A service to show conirm and prompt dialogs.
+     * Service for opening modal dialogs.
      */
     protected dialog: MatDialog;
     /**
-     * location: Location
+     * Service for managing browser location and history.
      */
     protected location: Location;
     /**
-     * If true, set url hash
+     * If true, sets a URL hash for navigation state.
      */
     protected setUrlHash: boolean;
     /**
-     * MatExpansionPanel ref
+     * Query list for accessing expansion panel elements as DOM references.
      */
     protected matExpansionPanelElementQueryList?: QueryList<ElementRef>;
     /**
-     * MatExpansionPanel ref
+     * Query list for accessing MatExpansionPanel component references.
      */
     protected matExpansionPanelQueryList?: QueryList<MatExpansionPanel>;
     /**
-     * matExpansionPanelSubscriptions: Subscription[]
+     * Subscriptions for expansion panel changes, managed to avoid memory leaks.
      */
     protected matExpansionPanelSubscriptions: Subscription[];
     /**
-     * Constructor
+     * Initializes services and application settings, sets up context helpers,
+     * and initializes the editor with default configurations.
+     *
+     * @param route - ActivatedRoute instance for accessing route parameters and data.
+     * @param changeDetectorRef - ChangeDetectorRef instance for manually triggering change detection.
      */
     constructor(route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
     /**
-     * Lifecycle hook that is called after data-bound properties
-     * of a directive are initialized.
+     * Lifecycle hook that is called after data-bound properties of a directive are initialized
      */
     ngOnInit(): void;
     /**
-     * Lifecycle hook that is called after a component's view has been fully initialized.
+     * Lifecycle hook that is called after a component's view has been fully initialized
      */
     ngAfterViewInit(): void;
     /**
-     * Refreshs this page/component
+     * Reloads the current page or component.
+     *
+     * This method navigates temporarily to the root URL and then
+     * navigates back to the current URL to effectively refresh the page or component.
+     *
+     * @param callback - A function to be called after the navigation is successful,
+     *                   receives the current URL as an argument.
      */
-    reloadPage(): void;
+    reloadPage(callback?: (currentUrl: string) => void): void;
     /**
-     * Navigates back to return url
+     * Navigates back to the return URL if it exists.
      */
     navigateToReturnUrl(): void;
     detectChanges(): void;
     /**
-     * Sets return url
-     * @param returnUrl
+     * Sets the return URL after decoding it.
+     *
+     * @param returnUrl - The encoded return URL to set.
      */
     protected setReturnUrl(returnUrl: string): void;
     /**
@@ -225,16 +235,23 @@ export declare abstract class BaseComponent implements IBaseComponent, OnInit, A
      */
     protected getService<T>(token: Type<T>): T;
     /**
-     * Gets base route
-     * @param snapshot
+     * Gets the main route from the given snapshot by traversing up to the parent routes
+     * if the current snapshot does not have a menu defined.
+     *
+     * @param snapshot - The activated route snapshot to evaluate.
+     * @returns The main route snapshot that has a menu defined.
      */
     protected getMainRoute(snapshot: ActivatedRouteSnapshot): ActivatedRouteSnapshot;
     /**
-     * Shows a confirm dialog to delete an item
+     * Shows a confirm dialog to delete a single item.
+     *
+     * @returns An observable that emits the result of the dialog after it is closed.
      */
     protected showDeleteItemDialog(): Observable<any>;
     /**
-     * Shows a confirm dialog to delete multiple items
+     * Shows a confirm dialog to delete multiple selected items.
+     *
+     * @returns An observable that emits the result of the dialog after it is closed.
      */
     protected showDeleteItemsDialog(): Observable<any>;
     /**

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

@@ -208,8 +208,11 @@ export declare abstract class GenericFormBaseComponent<TEntity extends IEntity,
     /**
      * 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(): void;
+    loadItem(callback?: (item: any) => void): void;
     /**
      * Loads an item by ID asynchronously.
      * @returns An Observable of the loaded entity.

package/lib/common/models/action-item.d.ts

@@ -26,6 +26,11 @@ export declare class ActionItem<TEntity = any, TContext = any> {
      * @type {((x?: TEntity, ctx?: TContext) => any) | string}
      */
     iconClass?: ((x?: TEntity, ctx?: TContext) => any) | string;
+    /**
+     * The color for the icon, which can be set as a string (e.g., hex, rgb).
+     * @type {string}
+     */
+    iconColor?: string;
     /**
      * Event handler to execute when the action item is triggered.
      * @param {x} The entity associated with the action item.
@@ -56,6 +61,11 @@ export declare class ActionItem<TEntity = any, TContext = any> {
      * @type {number}
      */
     index?: number;
+    /**
+     * The text color for the action item, specified as a hex string or a color name.
+     * @type {string}
+     */
+    textColor?: string;
     /**
      * Constructor to initialize an ActionItem instance with optional properties.
      * @param init - Partial properties to initialize the action item.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@messaia/cdk",
-  "version": "18.1.0-rc21",
+  "version": "18.1.0-rc23",
   "peerDependencies": {
     "@angular/common": "^18.2.7",
     "@angular/core": "^18.2.7"