@messaia/cdk 20.1.2 → 20.2.1

package/index.d.ts

@@ -5022,6 +5022,10 @@ interface IGenericFormBaseComponent<TEntity extends IEntity | any> extends IBase
      * Gets form value
      */
     get formValue(): TEntity | any;
+    /**
+     * Array of field sets that organize related fields.
+     */
+    fieldSets?: string[];
     /**
      * Loads an item by ID
      */
@@ -5579,9 +5583,15 @@ declare class FormFieldDefinition<TEntity = any, TProperty = any> {
     required?: ((x?: TEntity, f?: FormGroup, ctx?: IGenericFormBaseComponent<TEntity>) => boolean | boolean);
     /**
      * The row number indicating the display position of the field.
+     * Can be a fixed number or a callback returning a number.
+     *
+     * @param x The entity associated with the field.
+     * @param f The FormGroup containing this field.
+     * @param ctx The context of the generic form component.
+     * @returns The row number for display.
      * Defaults to 1.
      */
-    row: number;
+    row: number | ((x?: TEntity, f?: FormGroup, ctx?: IGenericFormBaseComponent<TEntity>) => number);
     /**
      * The number of rows for multi-line input fields (e.g., text area).
      */
@@ -5927,6 +5937,13 @@ declare abstract class GenericFormBaseComponent<TEntity extends IEntity, TServic
      */
     get form(): NgForm | FormGroup | undefined;
     set form(form: NgForm | FormGroup | undefined);
+    /**
+     * @property List of field sets.
+     * @description The `fieldSets` array is used to filter and group form fields based on specific sets,
+     * allowing dynamic field rendering.
+     * @type {string[]}
+     */
+    fieldSets?: string[];
     /**
      * Gets the form value.
      */
@@ -6175,7 +6192,7 @@ declare abstract class GenericFormBaseComponent<TEntity extends IEntity, TServic
      */
     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>;
+    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; }; "fieldSets": { "alias": "fieldSets"; "required": false; }; }, {}, never, never, true, never>;
 }
 
 declare abstract class GenericFormComponent<TEntity extends IEntity, TService extends GenericService<TEntity>> extends GenericFormBaseComponent<TEntity, TService> {
@@ -10587,24 +10604,51 @@ declare function Form<T = any>(formDefinition?: Partial<FormDefinition<T>>): Fun
  */
 declare function FormField<TEntity = any, TProperty = any>(args: Partial<FormFieldDefinition<TEntity, TProperty>>): Function;
 /**
- * Property decorator to create form fields
- * @param args
- * @returns
+ * Property decorator to create and register form field groups.
+ *
+ * This decorator can be applied to a class property to automatically
+ * generate and register form groups based on the provided type and arguments.
+ *
+ * @param type The class type whose decorated properties will be grouped.
+ * @param args Optional partial configuration to customize the resulting FormFieldGroupDefinition.
+ * @param context Optional context object to influence form group generation, e.g., for conditional fields.
+ * @returns A property decorator function.
  */
-declare function FormFieldGroup<T = any>(type: Type$1<T>, args?: Partial<FormFieldGroupDefinition<T>>): Function;
+declare function FormFieldGroup<T = any>(type: Type$1<T>, args?: Partial<FormFieldGroupDefinition<T>>, context?: any): Function;
 
 /**
- * Gets classes decoarated with @Form
- * @param origin
- * @returns
+ * Retrieves the form definition for a given object decorated with @Form.
+ *
+ * This function reads metadata defined via decorators on the class
+ * to build a FormDefinition instance, including field groups and
+ * an optional API endpoint.
+ *
+ * @template TEntity The type of the entity associated with the form.
+ * @param origin The entity instance for which to retrieve the form definition. Must not be undefined.
+ * @param form Optional NgForm or FormGroup associated with the entity.
+ * @param context Optional context object to customize form definition generation,
+ *                e.g., for conditional fields or groups.
+ * @returns The FormDefinition object containing field groups and endpoint metadata.
+ * @throws Error if the `origin` argument is not provided.
  */
-declare function getFormDefinition(origin?: object): FormDefinition;
+declare function getFormDefinition<TEntity>(origin: TEntity, form?: FormGroup, context?: any): FormDefinition;
 /**
- * Gets poperties decoarated with @FormField grouped by row
- * @param instance
- * @returns
+ * Retrieves properties decorated with @FormField, grouped by row.
+ *
+ * This function reads metadata from the instance (or type) to generate
+ * an array of FormFieldGroupDefinition objects. It can use additional
+ * arguments, the form instance, or a context object to customize group creation.
+ *
+ * @template TEntity The type of the entity associated with the form fields.
+ * @param instance The instance of the object containing decorated properties.
+ * @param type Optional constructor of the class; used if instance is not provided.
+ * @param args Optional partial configuration to customize the resulting FormFieldGroupDefinition.
+ * @param form Optional NgForm or FormGroup associated with the entity, for dynamic field logic.
+ * @param context Optional context object for conditional logic or dynamic modifications
+ *                when generating form groups.
+ * @returns An array of FormFieldGroupDefinition objects representing the grouped form fields.
  */
-declare function getFormGroups<T = any>(instance?: T, type?: Type$1<T>, args?: Partial<FormFieldGroupDefinition<T>>): FormFieldGroupDefinition[];
+declare function getFormGroups<TEntity = any>(instance?: TEntity, type?: Type$1<TEntity>, args?: Partial<FormFieldGroupDefinition<TEntity>>, form?: FormGroup, context?: any): FormFieldGroupDefinition[];
 
 declare abstract class AbstractSelectFormField<T> extends AbstractMatFormField<T> implements OnInit {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@messaia/cdk",
-  "version": "20.1.2",
+  "version": "20.2.1",
   "peerDependencies": {
     "@angular/common": "^20.0.0",
     "@angular/core": "^20.0.0"