@messaia/cdk 18.2.2 → 18.2.3-rc02

package/lib/common/common.module.d.ts

@@ -51,6 +51,7 @@ export { Filter } from './models/filter';
 export { FilterField } from './models/filter-field';
 export { Icon } from './models/icon';
 export { KeyValue } from './models/key-value';
+export { ModifiableEntity } from './models/modifiable-entity';
 export { SaveAction } from './models/save-action';
 export { SuffixButton } from './models/suffix-button';
 export { DataSourcePipe } from './pipes/data-source.pipe';

package/lib/common/models/app-event.d.ts

@@ -1,6 +1,18 @@
 import { AppEventType } from "../enums/app-event-type";
+/**
+ * Represents an application event with a specified type and associated payload.
+ * Used for event-driven communication within the application.
+ *
+ * @template T The type of the payload associated with the event.
+ */
 export declare class AppEvent<T> {
     type: AppEventType;
     payload: T;
+    /**
+     * Constructor to initialize the event type and payload.
+     *
+     * @param type The type of the event, represented by the `AppEventType` enum.
+     * @param payload The data or payload associated with the event.
+     */
     constructor(type: AppEventType, payload: T);
 }

package/lib/common/models/audit-entity.d.ts

@@ -1,24 +1,36 @@
 import { BaseEntity } from "./base-entity";
+/**
+ * Abstract class extending the base entity with audit-related properties.
+ * Includes information about entity creation and updates.
+ */
 export declare abstract class AuditEntity extends BaseEntity {
     /**
-     * @property
+     * @property Created By
+     * @description Specifies the username or identifier of the user who created the entity.
+     * @type {string}
      */
     createdBy?: string;
     /**
-     * @property
+     * @property Created Date
+     * @description Specifies the date and time when the entity was created.
+     * @type {Date}
      */
     createdDate?: Date;
     /**
-     * @property
+     * @property Updated By
+     * @description Specifies the username or identifier of the user who last updated the entity.
+     * @type {string}
      */
     updatedBy?: string;
     /**
-     * @property
+     * @property Updated Date
+     * @description Specifies the date and time when the entity was last updated.
+     * @type {Date}
      */
     updatedDate?: Date;
     /**
-     * constructor
-     * @param init
+     * Constructor to initialize properties of the audit entity.
+     * @param init Partial object containing initial property values.
      */
     constructor(init?: Partial<AuditEntity>);
 }

package/lib/common/models/audit-user.d.ts

@@ -1,14 +1,23 @@
+/**
+ * Represents a user entity with audit-related information such as display name, email, and letter.
+ */
 export declare class AuditUser {
     /**
-     * @property
+     * @property Display Name
+     * @description The full name or preferred display name of the user.
+     * @type {string}
      */
     displayName?: string;
     /**
-     * @property
+     * @property Email
+     * @description The email address of the user.
+     * @type {string}
      */
     email?: string;
     /**
-     * @property
+     * @property Letter
+     * @description The first letter or an abbreviation associated with the user.
+     * @type {string}
      */
     letter?: string;
 }

package/lib/common/models/base-entity.d.ts

@@ -1,16 +1,23 @@
 import { IEntity } from "./entity";
+/**
+ * Abstract class representing a base entity with common properties and functionality.
+ */
 export declare abstract class BaseEntity implements IEntity {
     /**
-     * @property
+     * @property ID
+     * @description Represents the unique identifier of the entity.
+     * @type {number}
      */
     id?: number;
     /**
-     * @property
+     * @property Version
+     * @description Represents the version number of the entity for concurrency control.
+     * @type {number}
      */
     version?: number;
     /**
-     * constructor
-     * @param init
+     * Constructor to initialize properties of the base entity.
+     * @param init Partial object containing initial property values.
      */
     constructor(init?: Partial<BaseEntity>);
 }

package/lib/common/models/common-error.d.ts

@@ -1,15 +1,25 @@
 /**
  * Represents a common error with a code and description.
+ * Typically used to encapsulate error details for consistent error handling.
  */
 export declare class CommonError {
-    /** Error code */
+    /**
+     * @property Code
+     * @description The unique code identifying the type of error.
+     * @type {string}
+     */
     code: string;
-    /** Error description */
+    /**
+     * @property Description
+     * @description A human-readable message providing details about the error.
+     * @type {string}
+     */
     description: string;
     /**
-     * Constructs a new instance of CommonError.
-     * @param code The error code.
-     * @param description The error description.
+     * Constructs a new instance of the `CommonError` class.
+     *
+     * @param code The unique error code.
+     * @param description A descriptive message explaining the error.
      */
     constructor(code: string, description: string);
 }

package/lib/common/models/common-handler-context.d.ts

@@ -1,31 +1,40 @@
 import { CommonError } from "./common-error";
 import { ICommonHandlerContext } from "./icommon-handler-context";
 /**
- * Represents the context of a handler operation, including results and errors.
- * @typeparam TResult The type of the result.
+ * Represents the context of a handler operation, including the operation result, success status, and associated errors.
+ *
+ * @typeparam TResult The type of the result encapsulated by the context.
  */
 export declare class CommonHandlerContext<TResult> implements ICommonHandlerContext<TResult> {
     /**
-     * A list of errors that occurred during the operation.
+     * @property Errors
+     * @description A collection of errors that occurred during the operation. Empty if the operation succeeded.
+     * @type {CommonError[]}
      */
     errors: CommonError[];
     /**
-     * The result of the operation.
+     * @property Result
+     * @description The result of the operation. Its value depends on the success or failure of the operation.
+     * @type {TResult}
      */
     result: TResult;
     /**
-     * Indicates if the operation was successful.
+     * @property Has Succeeded
+     * @description Indicates whether the operation was successful. Defaults to `true`.
+     * @type {boolean}
      */
     hasSucceeded: boolean;
     /**
-     * Constructs a new instance of CommonHandlerContext.
-     * @param result The result of the operation.
+     * Constructs a new instance of the `CommonHandlerContext` class.
+     *
+     * @param result The initial result of the operation.
      */
     constructor(result: TResult);
     /**
-     * Marks the operation as failed and sets the provided errors.
-     * @param errors An optional array of CommonError instances indicating why the operation failed.
-     * @returns The current instance of CommonHandlerContext with errors set.
+     * Marks the operation as failed and appends the provided errors to the `errors` property.
+     *
+     * @param errors An optional array of `CommonError` instances that provide details about why the operation failed.
+     * @returns The current instance of `CommonHandlerContext` with the failure status and errors updated.
      */
     fail(...errors: CommonError[]): this;
 }

package/lib/common/models/displayname-number-projection.d.ts

@@ -1,14 +1,26 @@
+/**
+ * Represents a projection of an entity with display name, number, and ID properties.
+ * This class is typically used to define how these properties are displayed and filtered in a table/grid.
+ */
 export declare class DisplayNameNumberProjection {
     /**
-     * @property
+     * @property Display Name
+     * @description The name to display in the grid or UI. It is optional and localized using `@Display`.
+     * @type {string}
      */
     displayName?: string;
     /**
-     * @property
+     * @property Number
+     * @description A numeric value associated with the entity, displayed in the grid.
+     * Includes filtering options and a medium grid display configuration.
+     * @type {number}
      */
     number?: number;
     /**
-     * @property
+     * @property ID
+     * @description The unique identifier for the entity. Configured for filtering and sorting.
+     * The arrowBefore property ensures proper column sorting behavior in grids.
+     * @type {number}
      */
     id?: number;
 }

package/lib/common/models/displayname-projection.d.ts

@@ -1,10 +1,19 @@
+/**
+ * Represents a projection for displaying an entity's name and ID properties.
+ * This class is typically used in grid or table views to manage how these properties are displayed and filtered.
+ */
 export declare class DisplayNameProjection {
     /**
-     * @property
+     * @property Display Name
+     * @description The name to display in the grid or UI. This property is localized using `@Display`.
+     * @type {string}
      */
     displayName?: string;
     /**
-     * @property
+     * @property ID
+     * @description The unique identifier for the entity. Configured for filtering and sorting.
+     * The `arrowBefore` property ensures proper sorting behavior in grids.
+     * @type {number}
      */
     id?: number;
 }

package/lib/common/models/entity.d.ts

@@ -1,6 +1,11 @@
+/**
+ * Represents a generic entity with a unique identifier.
+ */
 export interface IEntity {
     /**
-     * @property
+     * @property id
+     * @description Optional unique identifier for the entity.
+     * @type {number}
      */
     id?: number;
 }

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

@@ -1,22 +1,33 @@
 import { Icon } from "./icon";
 /**
- * Interface representing an item in an enum, providing ID and name properties.
+ * Interface representing an item in an enum, including its ID, name, and optional properties such as an associated icon and text color.
+ * This interface can be used to provide detailed metadata for enum items, especially when displayed in a UI context.
+ *
+ * @typeparam E The enum type that the item belongs to.
  */
 export interface EnumItem<E> {
     /**
-     * The ID of the enum item, which is typically its value.
+     * @property ID
+     * @description The ID of the enum item, which is typically its value. This serves as a unique identifier for the item.
+     * @type {E}
      */
     id: E;
     /**
-     * The name of the enum item, which is typically one of its keys.
+     * @property Name
+     * @description The name of the enum item, which is typically one of its keys. This is used for display or labeling purposes.
+     * @type {keyof E}
      */
     name: keyof E;
     /**
-     * Optional icon associated with the enum value.
+     * @property Icon
+     * @description An optional icon associated with the enum item. Useful for providing visual representation.
+     * @type {Icon<any, any>}
      */
     icon?: Icon<any, any>;
     /**
-     * Optional text color associated with the enum value.
+     * @property Text Color
+     * @description An optional text color associated with the enum item. This allows customization of the item's appearance.
+     * @type {string}
      */
     textColor?: string;
 }

package/lib/common/models/enum-metadata.d.ts

@@ -1,31 +1,42 @@
 import { Icon } from "./icon";
 /**
- * Metadata class for enum values, containing display information and ordering.
+ * Metadata class for enum values, containing display information, ordering, and other optional properties.
+ * This class provides additional metadata for enum items, useful for customizing their presentation and behavior in the UI.
  */
 export declare class EnumMetadata {
     /**
-     * Optional display string associated with the enum value.
+     * @property Display
+     * @description An optional display string associated with the enum value. This string can be used for user-friendly display in the UI.
+     * @type {string}
      */
     display?: string;
     /**
-     * Optional icon associated with the enum value.
+     * @property Icon
+     * @description An optional icon associated with the enum value. This can be used to visually represent the enum value in the UI.
+     * @type {Icon<any, any>}
      */
     icon?: Icon<any, any>;
     /**
-     * Optional text color associated with the enum value.
+     * @property Text Color
+     * @description An optional text color associated with the enum value. This allows customization of the appearance of the value in the UI.
+     * @type {string}
      */
     textColor?: string;
     /**
-     * Optional order number used for sorting enum values.
+     * @property Order
+     * @description An optional order number used for sorting enum values. This helps in controlling the order in which enum items are displayed.
+     * @type {number}
      */
     order?: number;
     /**
-     * Flag indicating whether the enum value should be hidden from the UI.
+     * @property Hidden
+     * @description A flag indicating whether the enum value should be hidden from the UI. This can be useful for conditionally hiding enum items.
+     * @type {boolean}
      */
     hidden?: boolean;
     /**
-     * Constructor to initialize the EnumMetadata class.
-     * @param init
+     * Constructor to initialize the EnumMetadata class with optional values.
+     * @param init An optional partial object to initialize the properties of EnumMetadata.
      */
     constructor(init?: Partial<EnumMetadata>);
 }

package/lib/common/models/modifiable-entity.d.ts

@@ -0,0 +1,21 @@
+import { AuditEntity } from "./audit-entity";
+/**
+ * Represents an entity that can be modified, extending from the AuditEntity class.
+ * This class adds additional properties to manage whether the entity is deletable or editable.
+ */
+export declare class ModifiableEntity extends AuditEntity {
+    /**
+     * @property isDeletable
+     * @description A flag indicating whether the entity can be deleted.
+     * This property helps determine if the entity is deletable in the UI or business logic.
+     * @type {boolean}
+     */
+    isDeletable?: boolean;
+    /**
+     * @property isEditable
+     * @description A flag indicating whether the entity can be edited.
+     * This property helps determine if the entity is editable in the UI or business logic.
+     * @type {boolean}
+     */
+    isEditable?: boolean;
+}

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

@@ -4,7 +4,6 @@ import { FormGroup } from '@angular/forms';
 import { MatAutocompleteSelectedEvent } from '@angular/material/autocomplete';
 import { MatChipInputEvent } from '@angular/material/chips';
 import { MatCalendar, MatDatepicker } from '@angular/material/datepicker';
-import { Icon } from '../../../common/models/icon';
 import { VdGenericFormCustomFieldDirective } from '../../directives/vd-generic-form-custom-field.directive';
 import { FormFieldType } from '../../enums/form-field-type';
 import { FormDefinition } from '../../models/form-definition';
@@ -204,7 +203,6 @@ export declare class VdGenericFormComponent implements OnInit {
      * @param optionalParams
      */
     log(message: any, ...optionalParams: any[]): void;
-    myFunction(func: Function, option: any): Icon<any, any>;
     static ɵfac: i0.ɵɵFactoryDeclaration<VdGenericFormComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<VdGenericFormComponent, "vd-generic-form", never, { "formGroup": { "alias": "formGroup"; "required": false; }; "classType": { "alias": "classType"; "required": false; }; "formDefinition": { "alias": "formDefinition"; "required": false; }; "fieldGroups": { "alias": "fieldGroups"; "required": false; }; "groupName": { "alias": "groupName"; "required": false; }; "fieldSets": { "alias": "fieldSets"; "required": false; }; "context": { "alias": "context"; "required": false; }; "debugValue": { "alias": "debugValue"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "separatorKeysCodes": { "alias": "separatorKeysCodes"; "required": false; }; }, {}, ["editorTemplate", "codeTemplate", "fileTemplate", "customTemplate", "bottom", "customFields", "customFieldsTemplates"], never, false, never>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@messaia/cdk",
-  "version": "18.2.2",
+  "version": "18.2.3-rc02",
   "peerDependencies": {
     "@angular/common": "^18.2.7",
     "@angular/core": "^18.2.7"