@ng-forge/dynamic-forms-ionic 0.10.0-next.4 → 1.0.0-rc.2

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

@@ -1,7 +1,7 @@
 import * as _ng_forge_dynamic_forms from '@ng-forge/dynamic-forms';
-import { FormEvent, NextPageEvent, PreviousPageEvent, AppendArrayItemEvent, ArrayAllowedChildren, PrependArrayItemEvent, InsertArrayItemEvent, RemoveAtIndexEvent, PopArrayItemEvent, ShiftArrayItemEvent, DynamicText, BaseAddon, DynamicValue, AddonActionPreset, RegisteredActionRef, TextAddon, TemplateAddon, ValueType, FieldOption, NarrowFields, RegisteredFieldTypes, InferFormValue, FormConfig } from '@ng-forge/dynamic-forms';
+import { FormEvent, FormSubmitEvent, NextPageEvent, PreviousPageEvent, AppendArrayItemEvent, ArrayAllowedChildren, PrependArrayItemEvent, InsertArrayItemEvent, RemoveAtIndexEvent, PopArrayItemEvent, ShiftArrayItemEvent, DynamicText, BaseAddon, DynamicValue, AddonActionPreset, RegisteredActionRef, TextAddon, TemplateAddon, ValueType, FieldOption, NarrowFields, RegisteredFieldTypes, InferFormValue, FormConfig } from '@ng-forge/dynamic-forms';
 import * as i1 from '@ng-forge/dynamic-forms/integration';
-import { ButtonField, CheckboxField, CheckedFieldComponent, DatepickerField, DatepickerProps, ValueFieldComponent, AddonActionHandler, InputField, InputProps, WrapperFieldInputs, MultiCheckboxField, RadioField, SelectField, SelectProps, SliderField, TextareaField, TextareaProps, ToggleField, FieldTypeDefinition } from '@ng-forge/dynamic-forms/integration';
+import { ButtonField, CheckboxField, DatepickerField, DatepickerProps, AddonActionHandler, InputField, InputProps, WrapperFieldInputs, MultiCheckboxField, RadioField, SelectField, SelectProps, SliderField, TextareaField, TextareaProps, ToggleField, FieldTypeDefinition } from '@ng-forge/dynamic-forms/integration';
 import * as _angular_core from '@angular/core';
 import { InjectionToken, Provider, WritableSignal } from '@angular/core';
 import * as _ng_forge_dynamic_forms_ionic from '@ng-forge/dynamic-forms-ionic';
@@ -18,7 +18,7 @@ interface IonicButtonProps {
 type IonicButtonField<TEvent extends FormEvent> = ButtonField<IonicButtonProps, TEvent>;
 /** Specific button field types with preconfigured events */
 /** Submit button field - automatically disabled when form is invalid */
-type IonicSubmitButtonField = Omit<IonicButtonField<SubmitEvent>, 'event' | 'type' | 'eventArgs'> & {
+type IonicSubmitButtonField = Omit<IonicButtonField<FormSubmitEvent>, 'event' | 'type' | 'eventArgs'> & {
     type: 'submit';
 };
 /** Next page button field - with preconfigured NextPageEvent */
@@ -126,8 +126,6 @@ interface IonicCheckboxProps {
     hint?: DynamicText;
 }
 type IonicCheckboxField = CheckboxField<IonicCheckboxProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicCheckboxComponent = CheckedFieldComponent<IonicCheckboxField>;
 
 declare class IonicCheckboxFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<boolean>;
@@ -151,8 +149,6 @@ interface IonicDatepickerProps extends DatepickerProps {
     hint?: DynamicText;
 }
 type IonicDatepickerField = DatepickerField<IonicDatepickerProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicDatepickerComponent = ValueFieldComponent<IonicDatepickerField>;
 
 declare class IonicDatepickerFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<Date | null>;
@@ -172,7 +168,7 @@ declare class IonicDatepickerFieldComponent {
 
 /** Decorative icon addon for Ion fields. */
 interface IonIconAddon extends BaseAddon {
-    readonly kind: 'ion-icon';
+    readonly type: 'ion-icon';
     /** Ionons name (e.g., `'search-outline'`, `'close-outline'`). */
     readonly icon: string;
     /** Accessible label for icons that convey meaning. */
@@ -187,7 +183,7 @@ type IonButtonFill = 'clear' | 'outline' | 'solid' | 'default';
  * participate in either XOR axis.
  */
 interface IonButtonBase extends BaseAddon {
-    readonly kind: 'ion-button';
+    readonly type: 'ion-button';
     /** Ion button colour. */
     readonly color?: IonButtonColor;
     /** Ion button fill style. */
@@ -208,7 +204,7 @@ type IonButtonClickPreset = {
 };
 /**
  * Value type for the `actionRef` slot. When no actions have been registered
- * via `provideAddonActions(...)`, `RegisteredActionRef` resolves to `never` —
+ * via `withAddonActions(...)`, `RegisteredActionRef` resolves to `never` —
  * which would make this variant uninhabitable and break `addon.actionRef`
  * narrowing in the renderer. Fall back to `string` so the variant stays
  * usable; once the user augments `DynamicFormActionRegistry`, autocomplete
@@ -217,14 +213,14 @@ type IonButtonClickPreset = {
 type IonButtonActionRef = [RegisteredActionRef] extends [never] ? string : RegisteredActionRef;
 type IonButtonClickActionRef = {
     readonly preset?: never;
-    /** Reference to a handler registered via `provideAddonActions(...)`. JSON-safe. */
+    /** Reference to a handler registered via `withAddonActions(...)`. JSON-safe. */
     readonly actionRef: IonButtonActionRef;
     readonly action?: never;
 };
 type IonButtonClickAction = {
     readonly preset?: never;
     readonly actionRef?: never;
-    /** Inline handler — code-only; dropped from JSON-derived configs. Matches the generic `AddonActionHandler` shape used by `provideAddonActions(...)`. */
+    /** Inline handler — code-only; dropped from JSON-derived configs. Matches the generic `AddonActionHandler` shape used by `withAddonActions(...)`. */
     readonly action: AddonActionHandler;
 };
 type IonButtonClickNone = {
@@ -256,7 +252,7 @@ type IonButtonContentDecorative = {
 type IonButtonContent = IonButtonContentIconOnly | IonButtonContentLabeled | IonButtonContentDecorative;
 /** Interactive button addon for Ion fields. */
 type IonButtonAddon = IonButtonBase & IonButtonContent & IonButtonClick;
-/** Union of all Ion-shipped addon kinds. */
+/** Union of all Ion-shipped addon types. */
 type IonAddon = IonIconAddon | IonButtonAddon;
 declare module '@ng-forge/dynamic-forms' {
     interface DynamicFormAddonRegistry {
@@ -276,19 +272,17 @@ interface IonicInputProps extends InputProps {
     clearInput?: boolean;
 }
 /**
- * Module-augmentable seam for adding custom addon kinds to `ion-input` at
+ * Module-augmentable seam for adding custom addon types to `ion-input` at
  * the type level. Pair with `withCustomAddon(...)` for the runtime side:
  */
 interface IonAddonExtensions {
 }
 type IonAddonExtension = IonAddonExtensions[keyof IonAddonExtensions];
-/** Addon kinds accepted by `ion-input`. */
+/** Addon types accepted by `ion-input`. */
 type IonInputAddon = IonIconAddon | IonButtonAddon | TextAddon | TemplateAddon | IonAddonExtension;
 type IonicInputField = InputField<IonicInputProps> & {
     addons?: ReadonlyArray<IonInputAddon>;
 };
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicInputComponent = ValueFieldComponent<IonicInputField>;
 
 declare class IonicInputFieldComponent {
     private readonly elementRef;
@@ -311,10 +305,10 @@ declare class IonicInputFieldComponent {
     protected readonly color: _angular_core.Signal<"primary" | "secondary" | "tertiary" | "success" | "warning" | "danger" | "light" | "medium" | "dark" | undefined>;
     /** Override (set by `toggle-password-visibility` preset) wins over `props().type`. */
     protected readonly type: _angular_core.Signal<string>;
-    /** Per-kind split: ion-button addons render inline via the attribute-
+    /** Per-type split: ion-button addons render inline via the attribute-
      *  selector inline component (so the slotted element is a native
      *  <ion-button> Ionic can style); everything else (icon/text/template/
-     *  component kinds) goes through the universal <df-addon-slot> dispatcher
+     *  component types) goes through the universal <df-addon-slot> dispatcher
      *  wrapped in <span slot="start|end"> for safe shadow-DOM projection. */
     protected readonly buttonPrefixAddons: _angular_core.Signal<_ng_forge_dynamic_forms_ionic.IonButtonAddon[]>;
     protected readonly buttonSuffixAddons: _angular_core.Signal<_ng_forge_dynamic_forms_ionic.IonButtonAddon[]>;
@@ -334,8 +328,6 @@ interface IonicMultiCheckboxProps {
     hint?: DynamicText;
 }
 type IonicMultiCheckboxField<T> = MultiCheckboxField<T, IonicMultiCheckboxProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicMultiCheckboxComponent = ValueFieldComponent<IonicMultiCheckboxField<ValueType>>;
 
 declare class IonicMultiCheckboxFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<ValueType[]>;
@@ -358,8 +350,6 @@ interface IonicRadioProps {
     hint?: DynamicText;
 }
 type IonicRadioField<T> = RadioField<T, IonicRadioProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicRadioComponent = ValueFieldComponent<IonicRadioField<ValueType>>;
 
 declare class IonicRadioFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<ValueType>;
@@ -384,8 +374,6 @@ interface IonicSelectProps extends SelectProps {
     hint?: DynamicText;
 }
 type IonicSelectField<T> = SelectField<T, IonicSelectProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicSelectComponent = ValueFieldComponent<IonicSelectField<ValueType>>;
 
 declare class IonicSelectFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<ValueType>;
@@ -422,8 +410,6 @@ interface IonicSliderProps {
     hint?: DynamicText;
 }
 type IonicSliderField = SliderField<IonicSliderProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicSliderComponent = ValueFieldComponent<IonicSliderField>;
 
 declare class IonicSliderFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<number>;
@@ -445,8 +431,6 @@ interface IonicTextareaProps extends TextareaProps {
     color?: 'primary' | 'secondary' | 'tertiary' | 'success' | 'warning' | 'danger' | 'light' | 'medium' | 'dark';
 }
 type IonicTextareaField = TextareaField<IonicTextareaProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicTextareaComponent = ValueFieldComponent<IonicTextareaField>;
 
 declare class IonicTextareaFieldComponent {
     private readonly elementRef;
@@ -465,8 +449,6 @@ interface IonicToggleProps {
     hint?: DynamicText;
 }
 type IonicToggleField = ToggleField<IonicToggleProps>;
-/** @deprecated Scheduled for removal in v1. Use `injectNgForgeField<T>()` for typed access to a field component's directive instance. */
-type IonicToggleComponent = CheckedFieldComponent<IonicToggleField>;
 
 declare class IonicToggleFieldComponent {
     protected readonly ngf: i1.TypedNgForgeField<boolean>;
@@ -615,7 +597,7 @@ type IonicFieldsWithAddons = [...IonicFieldTypes, IonicAddonsFeature];
 type IonicFieldsWithConfig = [...IonicFieldTypes, IonicAddonsFeature, IonicConfigFeature];
 /**
  * Provides Ionic field type definitions for the dynamic form system,
- * with Ionic-shipped addon kinds (`ion-icon`, `ion-button`) auto-included
+ * with Ionic-shipped addon types (`ion-icon`, `ion-button`) auto-included
  * so addons work out of the box.
  *
  * @param config - Optional global configuration for Ionic form fields
@@ -626,18 +608,18 @@ declare function withIonicFields(): IonicFieldsWithAddons;
 declare function withIonicFields(config: IonicConfig): IonicFieldsWithConfig;
 declare function withIonicFields(config: IonicConfig | undefined): IonicFieldsWithAddons | IonicFieldsWithConfig;
 /**
- * Feature kind discriminant for the Ionic addons feature. Matches core's
- * `'addons'` kind so providers flow through the standard addon-kind pipeline
+ * Feature type discriminant for the Ionic addons feature. Matches core's
+ * `'addons'` type so providers flow through the standard addon-type pipeline
  * in `provideDynamicForm`.
  */
 type IonicAddonsFeature = {
     ɵkind: 'addons';
     ɵproviders: Provider[];
 };
-/** Register Ionic-shipped addon kinds (`ion-icon`, `ion-button`) standalone. */
+/** Register Ionic-shipped addon types (`ion-icon`, `ion-button`) standalone. */
 declare function withIonicAddons(): IonicAddonsFeature;
 
-/** Renderer for the `ion-button` addon kind. */
+/** Renderer for the `ion-button` addon type. */
 declare class IonButtonAddonComponent {
     protected readonly action: i1.TypedNgForgeAddonAction<IonButtonAddon>;
     /** Re-exposed for template binding — same signal stored on the directive. */
@@ -660,10 +642,10 @@ declare class IonButtonAddonComponent {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<IonButtonAddonComponent, "df-ion-button-addon", never, {}, {}, never, never, true, [{ directive: typeof i1.NgForgeAddonAction; inputs: {}; outputs: {}; }]>;
 }
 
-/** Renderer for the `ion-icon` addon kind. */
+/** Renderer for the `ion-icon` addon type. */
 declare class IonIconAddonComponent {
     readonly addon: _angular_core.InputSignal<IonIconAddon>;
-    /** Accepted for contract uniformity — `NgComponentOutlet` setInput is strict; every kind must declare it. */
+    /** Accepted for contract uniformity — `NgComponentOutlet` setInput is strict; every type must declare it. */
     readonly fieldInputs: _angular_core.InputSignal<WrapperFieldInputs | undefined>;
     protected readonly iconName: _angular_core.Signal<string>;
     protected readonly ariaLabel: _angular_core.Signal<_ng_forge_dynamic_forms.DynamicText | undefined>;
@@ -676,4 +658,4 @@ declare class IonIconAddonComponent {
 declare const IONIC_INPUT_TYPE_OVERRIDE: InjectionToken<WritableSignal<string | undefined>>;
 
 export { IONIC_CONFIG, IONIC_FIELD_TYPES, IONIC_INPUT_TYPE_OVERRIDE, IonButtonAddonComponent, IonIconAddonComponent, IonicButtonFieldComponent, IonicCheckboxFieldComponent, IonicDatepickerFieldComponent, IonicField, IonicInputFieldComponent, IonicMultiCheckboxFieldComponent, IonicRadioFieldComponent, IonicSelectFieldComponent, IonicSliderFieldComponent, IonicTextareaFieldComponent, IonicToggleFieldComponent, withIonicAddons, withIonicFields };
-export type { AddArrayItemButtonField, InsertArrayItemButtonField, IonAddon, IonAddonExtensions, IonButtonAddon, IonIconAddon, IonInputAddon, IonicButtonField, IonicButtonProps, IonicCheckboxComponent, IonicCheckboxField, IonicCheckboxProps, IonicConfig, IonicDatepickerComponent, IonicDatepickerField, IonicDatepickerProps, IonicFieldType, IonicFormConfig, IonicFormProps, IonicInputComponent, IonicInputField, IonicInputProps, IonicMultiCheckboxComponent, IonicMultiCheckboxField, IonicMultiCheckboxProps, IonicNextButtonField, IonicPreviousButtonField, IonicRadioComponent, IonicRadioField, IonicRadioProps, IonicSelectComponent, IonicSelectField, IonicSelectProps, IonicSliderComponent, IonicSliderField, IonicSliderProps, IonicSubmitButtonField, IonicTextareaComponent, IonicTextareaField, IonicTextareaProps, IonicToggleComponent, IonicToggleField, IonicToggleProps, PopArrayItemButtonField, PrependArrayItemButtonField, RemoveArrayItemButtonField, ShiftArrayItemButtonField };
+export type { AddArrayItemButtonField, InsertArrayItemButtonField, IonAddon, IonAddonExtensions, IonButtonAddon, IonIconAddon, IonInputAddon, IonicButtonField, IonicButtonProps, IonicCheckboxField, IonicCheckboxProps, IonicConfig, IonicDatepickerField, IonicDatepickerProps, IonicFieldType, IonicFormConfig, IonicFormProps, IonicInputField, IonicInputProps, IonicMultiCheckboxField, IonicMultiCheckboxProps, IonicNextButtonField, IonicPreviousButtonField, IonicRadioField, IonicRadioProps, IonicSelectField, IonicSelectProps, IonicSliderField, IonicSliderProps, IonicSubmitButtonField, IonicTextareaField, IonicTextareaProps, IonicToggleField, IonicToggleProps, PopArrayItemButtonField, PrependArrayItemButtonField, RemoveArrayItemButtonField, ShiftArrayItemButtonField };