@wiltech-labs/ngx-forms 0.1.0 → 1.0.1

package/types/wiltech-labs-ngx-forms.d.ts

@@ -1,6 +1,7 @@
 import * as i0 from "@angular/core";
-import { InputSignal, WritableSignal } from "@angular/core";
+import { InjectionToken, InputSignal, WritableSignal } from "@angular/core";
 import { FieldTree, Schema } from "@angular/forms/signals";
+import { MatChipInputEvent } from "@angular/material/chips";
 export declare enum FormFieldType {
   TEXT = "text",
   EMAIL = "email",
@@ -11,6 +12,7 @@ export declare enum FormFieldType {
   NUMBER = "number",
   RANGE = "range",
   SELECT = "select",
+  CHIPS = "chips",
   TEXTAREA = "textarea",
   CODE = "code",
   BUSINESS_DATE = "business-date",
@@ -67,16 +69,24 @@ interface SchemaConfig<T extends BaseSchema> {
   fields: FieldDef[];
   initialValue: T;
 }
-/** Renders one Material field component per FieldDef, plus Save and Clear buttons. */
+/**
+ * Renders one Material field component per FieldDef, then right-aligned actions: a text
+ * secondary action ("Clear" by default — label it "Cancel" when it leaves the form) and the filled
+ * primary one ("Save"). Name both after what they do.
+ */
 export declare class DynamicForm<T extends BaseSchema = BaseSchema> {
   metaInfo: InputSignal<FieldDef[]>;
   dynamicForm: InputSignal<FieldTree<T>>;
+  /** Filled primary action. */
+  readonly submitLabel: InputSignal<string>;
+  /** Text secondary action; emits `onFormClear`. */
+  readonly clearLabel: InputSignal<string>;
   onFormSubmit: import("@angular/core").OutputEmitterRef<void>;
   onFormClear: import("@angular/core").OutputEmitterRef<void>;
   protected handleSubmit(): void;
   protected clearForm(): void;
   static ɵfac: i0.ɵɵFactoryDeclaration<DynamicForm<any>, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<DynamicForm<any>, "app-dynamic-form", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<DynamicForm<any>, "ngx-dynamic-form", never, {
     "metaInfo": {
       "alias": "metaInfo";
       "required": true;
@@ -87,6 +97,16 @@ export declare class DynamicForm<T extends BaseSchema = BaseSchema> {
       "required": true;
       "isSignal": true;
     };
+    "submitLabel": {
+      "alias": "submitLabel";
+      "required": false;
+      "isSignal": true;
+    };
+    "clearLabel": {
+      "alias": "clearLabel";
+      "required": false;
+      "isSignal": true;
+    };
   }, {
     "onFormSubmit": "onFormSubmit";
     "onFormClear": "onFormClear";
@@ -102,7 +122,7 @@ export declare class TextField {
   readonly field: import("@angular/core").InputSignal<FieldTree<string> | FieldTree<number>>;
   protected readonly formField: import("@angular/core").Signal<FieldTree<string>>;
   static ɵfac: i0.ɵɵFactoryDeclaration<TextField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<TextField, "app-text-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<TextField, "ngx-text-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -125,7 +145,7 @@ export declare class TextareaField {
   protected readonly isCode: import("@angular/core").Signal<boolean>;
   protected onKeydown(event: KeyboardEvent): void;
   static ɵfac: i0.ɵɵFactoryDeclaration<TextareaField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<TextareaField, "app-textarea-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<TextareaField, "ngx-textarea-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -143,7 +163,7 @@ export declare class CheckboxField {
   readonly fieldDef: import("@angular/core").InputSignal<FieldDef>;
   readonly field: import("@angular/core").InputSignal<FieldTree<boolean>>;
   static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<CheckboxField, "app-checkbox-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<CheckboxField, "ngx-checkbox-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -162,7 +182,7 @@ export declare class RadioField {
   readonly field: import("@angular/core").InputSignal<FieldTree<string | number | boolean>>;
   protected readonly labelId: string;
   static ɵfac: i0.ɵɵFactoryDeclaration<RadioField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<RadioField, "app-radio-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<RadioField, "ngx-radio-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -180,7 +200,34 @@ export declare class SelectField {
   readonly fieldDef: import("@angular/core").InputSignal<FieldDef>;
   readonly field: import("@angular/core").InputSignal<FieldTree<string | number | boolean>>;
   static ɵfac: i0.ɵɵFactoryDeclaration<SelectField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<SelectField, "app-select-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<SelectField, "ngx-select-field", never, {
+    "fieldDef": {
+      "alias": "fieldDef";
+      "required": true;
+      "isSignal": true;
+    };
+    "field": {
+      "alias": "field";
+      "required": true;
+      "isSignal": true;
+    };
+  }, {}, never, never, true, never>;
+}
+/**
+ * Material chip grid for the chips field type: a free-text list of tokens (Eg keywords), typed one
+ * at a time and removable individually. Driven by hand (`state().value.update(...)`), same as the
+ * date/time fields — `[formField]` targets a single control's value, not a token-by-token list.
+ */
+export declare class ChipsField {
+  readonly fieldDef: import("@angular/core").InputSignal<FieldDef>;
+  readonly field: import("@angular/core").InputSignal<FieldTree<string[]>>;
+  private readonly announcer;
+  protected readonly state: import("@angular/core").Signal<import("@angular/forms/signals").FieldState<string[], string | number>>;
+  protected readonly chips: import("@angular/core").Signal<string[]>;
+  protected addChip(event: MatChipInputEvent): void;
+  protected removeChip(chip: string): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<ChipsField, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<ChipsField, "ngx-chips-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -199,7 +246,7 @@ export declare class SliderField {
   readonly field: import("@angular/core").InputSignal<FieldTree<number>>;
   protected readonly labelId: string;
   static ɵfac: i0.ɵɵFactoryDeclaration<SliderField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<SliderField, "app-slider-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<SliderField, "ngx-slider-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -220,6 +267,7 @@ export declare class BusinessDateField {
   readonly fieldDef: import("@angular/core").InputSignal<FieldDef>;
   readonly field: import("@angular/core").InputSignal<FieldTree<string | null>>;
   private readonly dateAdapter;
+  private readonly resolveLocale;
   protected readonly state: import("@angular/core").Signal<import("@angular/forms/signals").FieldState<string | null, string | number>>;
   protected readonly date: import("@angular/core").Signal<Date | null>;
   protected readonly minDate: import("@angular/core").Signal<Date | null>;
@@ -228,7 +276,7 @@ export declare class BusinessDateField {
   constructor();
   protected onDateChange(date: Date | null): void;
   static ɵfac: i0.ɵɵFactoryDeclaration<BusinessDateField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<BusinessDateField, "app-business-date-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<BusinessDateField, "ngx-business-date-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -249,6 +297,7 @@ export declare class BusinessTimeField {
   readonly fieldDef: import("@angular/core").InputSignal<FieldDef>;
   readonly field: import("@angular/core").InputSignal<FieldTree<string | null>>;
   private readonly dateAdapter;
+  private readonly resolveLocale;
   protected readonly state: import("@angular/core").Signal<import("@angular/forms/signals").FieldState<string | null, string | number>>;
   protected readonly time: import("@angular/core").Signal<Date | null>;
   protected readonly minTime: import("@angular/core").Signal<Date | null>;
@@ -257,7 +306,7 @@ export declare class BusinessTimeField {
   constructor();
   protected onTimeChange(time: Date | null): void;
   static ɵfac: i0.ɵɵFactoryDeclaration<BusinessTimeField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<BusinessTimeField, "app-business-time-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<BusinessTimeField, "ngx-business-time-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -280,6 +329,7 @@ export declare class InstantDateTimeField {
   readonly field: import("@angular/core").InputSignal<FieldTree<string | null>>;
   private readonly zonedDateTime;
   private readonly dateAdapter;
+  private readonly resolveLocale;
   /** Explains how a DST gap or overlap was resolved for the last value picked by the user. */
   protected readonly notice: WritableSignal<string | null>;
   protected readonly state: import("@angular/core").Signal<import("@angular/forms/signals").FieldState<string | null, string | number>>;
@@ -297,7 +347,7 @@ export declare class InstantDateTimeField {
   protected onTimeChange(time: Date | null): void;
   private commit;
   static ɵfac: i0.ɵɵFactoryDeclaration<InstantDateTimeField, never>;
-  static ɵcmp: i0.ɵɵComponentDeclaration<InstantDateTimeField, "app-instant-date-time-field", never, {
+  static ɵcmp: i0.ɵɵComponentDeclaration<InstantDateTimeField, "ngx-instant-date-time-field", never, {
     "fieldDef": {
       "alias": "fieldDef";
       "required": true;
@@ -346,6 +396,8 @@ export declare class FormConfigBuilder<T extends BaseSchema> {
   range(name: FieldName<T>, label: string, options?: FieldOptions): this;
   radio(name: FieldName<T>, label: string, choices: FieldOption[], options?: FieldOptions): this;
   select(name: FieldName<T>, label: string, choices: FieldOption[], options?: FieldOptions): this;
+  /** Freeform list of tokens (Eg keywords), typed one at a time. */
+  chips(name: FieldName<T>, label: string, options?: FieldOptions): this;
   /** Calendar date with no timezone, stored as 'YYYY-MM-DD'. */
   businessDate(name: FieldName<T>, label: string, options?: DateTimeFieldOptions): this;
   /** Time of day with no timezone, stored as 'HH:mm'. */
@@ -362,6 +414,25 @@ export declare class FormConfigBuilder<T extends BaseSchema> {
 }
 /** Starts a FormConfigBuilder for schema `T`. */
 export declare function formConfig<T extends BaseSchema>(schemaType: T['schemaType']): FormConfigBuilder<T>;
+/** A plain function the app supplies, read fresh on every call — see `NGX_FORMS_LOCALE`. */
+type FormsLocaleResolver = () => string;
+/**
+ * Which locale a date/time field's picker displays and parses in, when its own `FieldDef`
+ * doesn't set `dateTimeConfig.locale` — an explicit per-field `locale` always wins over this.
+ * Defaults to `DEFAULT_DATE_TIME_LOCALE` ('en-GB'), same as before this token existed, not the
+ * browser's own language: unlike `ngx-dates`' `NGX_DATES_LOCALE` (read-only display text), this
+ * locale also decides which *typed* day/month order `LocaleDateAdapter.parse()` accepts, so
+ * switching it changes user input behaviour, not just wording — an app opts in deliberately:
+ *
+ * ```ts
+ * { provide: NGX_FORMS_LOCALE, useFactory: () => { const translations = inject(TranslationsService); return () => translations.locale(); } }
+ * ```
+ *
+ * A plain function rather than a direct import of `ngx-translations`' `TranslationsService`, so this package
+ * stays buildable and publishable on its own — same reasoning as `ngx-dates`' `NGX_DATES_LOCALE`
+ * (see root `CLAUDE.md`'s "Inter-package deps").
+ */
+export declare const NGX_FORMS_LOCALE: InjectionToken<FormsLocaleResolver>;
 interface ZonedInstantResult {
   instant: string;
   notice: string | null;
@@ -387,4 +458,4 @@ export declare function defineSchema<T extends BaseSchema>(config: SchemaConfig<
 export declare function createEmptyEntity<T extends BaseSchema>(schemaType: T['schemaType'], defaults: Omit<T, 'id' | 'schemaType'>): T;
 /** Turns field definitions into Signals Forms rules. The model can be any object, not just a BaseSchema. */
 export declare function toSchema<T>(meta: FieldDef[]): Schema<T>;
-export type { BaseSchema, DateTimeConfig, DateTimeDisambiguation, DateTimeFieldOptions, FieldDef, FieldName, FieldOption, FieldOptions, SchemaConfig, ZonedInstantResult };
+export type { BaseSchema, DateTimeConfig, DateTimeDisambiguation, DateTimeFieldOptions, FieldDef, FieldName, FieldOption, FieldOptions, FormsLocaleResolver, SchemaConfig, ZonedInstantResult };