@ng-forge/dynamic-forms-material 0.5.1 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-forge/dynamic-forms-material",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Angular Material integration for @ng-forge/dynamic-forms. Pre-built Material Design form components.",
   "type": "module",
   "license": "MIT",
@@ -32,7 +32,7 @@
     "@angular/core": "~21.1.0",
     "@angular/forms": "~21.1.0",
     "@angular/material": "~21.1.0",
-    "@ng-forge/dynamic-forms": "~0.5.0",
+    "@ng-forge/dynamic-forms": "~0.6.0",
     "rxjs": ">=7.0.0"
   },
   "module": "fesm2022/ng-forge-dynamic-forms-material.mjs",

package/types/ng-forge-dynamic-forms-material.d.ts

@@ -3,7 +3,7 @@ import { CheckboxField, DatepickerField, DatepickerProps, InputMeta, InputField,
 import * as _angular_core from '@angular/core';
 import { InjectionToken, Provider } from '@angular/core';
 import { FieldTree } from '@angular/forms/signals';
-import { DynamicText, CheckedFieldComponent, FieldMeta, ValidationMessages, ValueFieldComponent, ValueType, FieldOption, FormEvent, FieldDef, LogicConfig, FieldComponent, FormEventConstructor, ArrayItemContext, FieldTypeDefinition, NarrowFields, RegisteredFieldTypes, InferFormValue, FormConfig } from '@ng-forge/dynamic-forms';
+import { DynamicText, CheckedFieldComponent, FieldMeta, ValidationMessages, ValueFieldComponent, ValueType, FieldOption, FormEvent, NextPageEvent, PreviousPageEvent, AppendArrayItemEvent, ArrayAllowedChildren, PrependArrayItemEvent, InsertArrayItemEvent, RemoveAtIndexEvent, PopArrayItemEvent, ShiftArrayItemEvent, FieldComponent, FormEventConstructor, ArrayItemContext, FieldTypeDefinition, NarrowFields, RegisteredFieldTypes, InferFormValue, FormConfig } from '@ng-forge/dynamic-forms';
 import { ThemePalette } from '@angular/material/core';
 import * as _angular_material_form_field from '@angular/material/form-field';
 import { MatFormFieldAppearance, SubscriptSizing } from '@angular/material/form-field';
@@ -365,66 +365,97 @@ type MatButtonComponent<TEvent extends FormEvent> = FieldComponent<MatButtonFiel
  * Specific button field types with preconfigured events
  */
 /** Submit button field - automatically disabled when form is invalid */
-interface MatSubmitButtonField extends Omit<FieldDef<MatButtonProps>, 'event'> {
+type MatSubmitButtonField = Omit<MatButtonField<SubmitEvent>, 'event' | 'type' | 'eventArgs'> & {
     type: 'submit';
-    key: string;
-    label: string;
-    disabled?: boolean;
-    className?: string;
-    props?: MatButtonProps;
-    /** Logic rules for dynamic disabled state (overrides form-level defaults) */
-    logic?: LogicConfig[];
-}
+};
 /** Next page button field - with preconfigured NextPageEvent */
-interface MatNextButtonField extends Omit<FieldDef<MatButtonProps>, 'event'> {
+type MatNextButtonField = Omit<MatButtonField<NextPageEvent>, 'event' | 'type' | 'eventArgs'> & {
     type: 'next';
-    key: string;
-    label: string;
-    disabled?: boolean;
-    className?: string;
-    props?: MatButtonProps;
-    /** Logic rules for dynamic disabled state (overrides form-level defaults) */
-    logic?: LogicConfig[];
-}
+};
 /** Previous page button field - with preconfigured PreviousPageEvent */
-interface MatPreviousButtonField extends Omit<FieldDef<MatButtonProps>, 'event'> {
+type MatPreviousButtonField = Omit<MatButtonField<PreviousPageEvent>, 'event' | 'type' | 'eventArgs'> & {
     type: 'previous';
-    key: string;
-    label: string;
-    disabled?: boolean;
-    className?: string;
-    props?: MatButtonProps;
-}
-/** Add array item button field - with preconfigured AddArrayItemEvent */
-interface AddArrayItemButtonField extends Omit<FieldDef<MatButtonProps>, 'event'> {
+};
+/** Add array item button field - dispatches AppendArrayItemEvent */
+type AddArrayItemButtonField = Omit<MatButtonField<AppendArrayItemEvent>, 'event' | 'type' | 'eventArgs'> & {
     type: 'addArrayItem';
-    key: string;
-    label: string;
-    disabled?: boolean;
-    className?: string;
-    props?: MatButtonProps;
     /**
      * The key of the array field to add items to.
      * Required when the button is placed outside the array.
      * When inside an array, this is automatically determined from context.
      */
     arrayKey?: string;
-}
-/** Remove array item button field - with preconfigured RemoveArrayItemEvent */
-interface RemoveArrayItemButtonField extends Omit<FieldDef<MatButtonProps>, 'event'> {
+    /**
+     * Template for the new array item. REQUIRED.
+     * - Single field (ArrayAllowedChildren): Creates a primitive item (field's value is extracted directly)
+     * - Array of fields (ArrayAllowedChildren[]): Creates an object item (fields merged into object)
+     */
+    template: ArrayAllowedChildren | readonly ArrayAllowedChildren[];
+};
+/** Prepend array item button field - dispatches PrependArrayItemEvent (adds at beginning) */
+type PrependArrayItemButtonField = Omit<MatButtonField<PrependArrayItemEvent>, 'event' | 'type' | 'eventArgs'> & {
+    type: 'prependArrayItem';
+    /**
+     * The key of the array field to prepend items to.
+     * Required when the button is placed outside the array.
+     * When inside an array, this is automatically determined from context.
+     */
+    arrayKey?: string;
+    /**
+     * Template for the new array item. REQUIRED.
+     * - Single field (ArrayAllowedChildren): Creates a primitive item (field's value is extracted directly)
+     * - Array of fields (ArrayAllowedChildren[]): Creates an object item (fields merged into object)
+     */
+    template: ArrayAllowedChildren | readonly ArrayAllowedChildren[];
+};
+/** Insert array item button field - dispatches InsertArrayItemEvent (adds at specific index) */
+type InsertArrayItemButtonField = Omit<MatButtonField<InsertArrayItemEvent>, 'event' | 'type' | 'eventArgs'> & {
+    type: 'insertArrayItem';
+    /**
+     * The key of the array field to insert items into.
+     * Required when the button is placed outside the array.
+     * When inside an array, this is automatically determined from context.
+     */
+    arrayKey?: string;
+    /**
+     * The index at which to insert the new item.
+     */
+    index: number;
+    /**
+     * Template for the new array item. REQUIRED.
+     * - Single field (ArrayAllowedChildren): Creates a primitive item (field's value is extracted directly)
+     * - Array of fields (ArrayAllowedChildren[]): Creates an object item (fields merged into object)
+     */
+    template: ArrayAllowedChildren | readonly ArrayAllowedChildren[];
+};
+/** Remove array item button field - dispatches RemoveAtIndexEvent or PopArrayItemEvent */
+type RemoveArrayItemButtonField = Omit<MatButtonField<RemoveAtIndexEvent>, 'event' | 'type' | 'eventArgs'> & {
     type: 'removeArrayItem';
-    key: string;
-    label: string;
-    disabled?: boolean;
-    className?: string;
-    props?: MatButtonProps;
     /**
      * The key of the array field to remove items from.
      * Required when the button is placed outside the array.
      * When inside an array, this is automatically determined from context.
      */
     arrayKey?: string;
-}
+};
+/** Pop array item button field - dispatches PopArrayItemEvent (removes last item) */
+type PopArrayItemButtonField = Omit<MatButtonField<PopArrayItemEvent>, 'event' | 'type' | 'eventArgs'> & {
+    type: 'popArrayItem';
+    /**
+     * The key of the array field to remove the last item from.
+     * REQUIRED - must specify which array to pop from.
+     */
+    arrayKey: string;
+};
+/** Shift array item button field - dispatches ShiftArrayItemEvent (removes first item) */
+type ShiftArrayItemButtonField = Omit<MatButtonField<ShiftArrayItemEvent>, 'event' | 'type' | 'eventArgs'> & {
+    type: 'shiftArrayItem';
+    /**
+     * The key of the array field to remove the first item from.
+     * REQUIRED - must specify which array to shift from.
+     */
+    arrayKey: string;
+};
 
 declare class MatButtonFieldComponent<TEvent extends FormEvent> implements MatButtonComponent<TEvent> {
     private readonly eventBus;
@@ -672,7 +703,11 @@ declare const MatField: {
     readonly Next: "next";
     readonly Previous: "previous";
     readonly AddArrayItem: "addArrayItem";
+    readonly PrependArrayItem: "prependArrayItem";
+    readonly InsertArrayItem: "insertArrayItem";
     readonly RemoveArrayItem: "removeArrayItem";
+    readonly PopArrayItem: "popArrayItem";
+    readonly ShiftArrayItem: "shiftArrayItem";
     readonly Textarea: "textarea";
     readonly Radio: "radio";
     readonly MultiCheckbox: "multi-checkbox";
@@ -743,7 +778,11 @@ declare module '@ng-forge/dynamic-forms' {
         next: MatNextButtonField;
         previous: MatPreviousButtonField;
         addArrayItem: AddArrayItemButtonField;
+        prependArrayItem: PrependArrayItemButtonField;
+        insertArrayItem: InsertArrayItemButtonField;
         removeArrayItem: RemoveArrayItemButtonField;
+        popArrayItem: PopArrayItemButtonField;
+        shiftArrayItem: ShiftArrayItemButtonField;
         textarea: MatTextareaField;
         radio: MatRadioField<unknown>;
         'multi-checkbox': MatMultiCheckboxField<unknown>;
@@ -820,4 +859,4 @@ declare module '@ng-forge/dynamic-forms' {
 }
 
 export { MATERIAL_CONFIG, MATERIAL_FIELD_TYPES, MatButtonFieldComponent, MatCheckboxFieldComponent, MatDatepickerFieldComponent, MatField, MatInputFieldComponent, MatMultiCheckboxFieldComponent, MatRadioFieldComponent, MatSelectFieldComponent, MatSliderFieldComponent, MatTextareaFieldComponent, MatToggleFieldComponent, withMaterialFields };
-export type { AddArrayItemButtonField, MatButtonField, MatButtonProps, MatCheckboxComponent, MatCheckboxField, MatCheckboxProps, MatDatepickerComponent, MatDatepickerField, MatDatepickerProps, MatFieldType, MatFormConfig, MatFormProps, MatInputComponent, MatInputField, MatInputProps, MatMultiCheckboxComponent, MatMultiCheckboxField, MatMultiCheckboxProps, MatNextButtonField, MatPreviousButtonField, MatRadioComponent, MatRadioField, MatRadioProps, MatSelectComponent, MatSelectField, MatSelectProps, MatSliderComponent, MatSliderField, MatSliderProps, MatSubmitButtonField, MatTextareaComponent, MatTextareaField, MatTextareaProps, MatToggleComponent, MatToggleField, MatToggleProps, MaterialConfig, RemoveArrayItemButtonField };
+export type { AddArrayItemButtonField, InsertArrayItemButtonField, MatButtonField, MatButtonProps, MatCheckboxComponent, MatCheckboxField, MatCheckboxProps, MatDatepickerComponent, MatDatepickerField, MatDatepickerProps, MatFieldType, MatFormConfig, MatFormProps, MatInputComponent, MatInputField, MatInputProps, MatMultiCheckboxComponent, MatMultiCheckboxField, MatMultiCheckboxProps, MatNextButtonField, MatPreviousButtonField, MatRadioComponent, MatRadioField, MatRadioProps, MatSelectComponent, MatSelectField, MatSelectProps, MatSliderComponent, MatSliderField, MatSliderProps, MatSubmitButtonField, MatTextareaComponent, MatTextareaField, MatTextareaProps, MatToggleComponent, MatToggleField, MatToggleProps, MaterialConfig, PopArrayItemButtonField, PrependArrayItemButtonField, RemoveArrayItemButtonField, ShiftArrayItemButtonField };