ngx-dynamic-entity 1.2.0 → 1.4.0

package/lib/field-types/number-field.component.d.ts

@@ -1,16 +0,0 @@
-import { AbstractControl } from '@angular/forms';
-import type { NestedFieldConfig } from '@dynamic-entity/core';
-import * as i0 from "@angular/core";
-export declare class NumberFieldComponent {
-    private readonly messages;
-    field: NestedFieldConfig;
-    control: AbstractControl;
-    language: string;
-    readonly: boolean;
-    masked: boolean;
-    get label(): string;
-    get placeholder(): string;
-    get errorMessage(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NumberFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NumberFieldComponent, "ngx-number-field", never, { "field": { "alias": "field"; "required": false; }; "control": { "alias": "control"; "required": false; }; "language": { "alias": "language"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "masked": { "alias": "masked"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/field-types/password-field.component.d.ts

@@ -1,17 +0,0 @@
-import { AbstractControl } from '@angular/forms';
-import type { NestedFieldConfig } from '@dynamic-entity/core';
-import * as i0 from "@angular/core";
-/** Password field: masked input with show/hide eye toggle. */
-export declare class PasswordFieldComponent {
-    field: NestedFieldConfig;
-    control: AbstractControl;
-    language: string;
-    readonly: boolean;
-    masked: boolean;
-    readonly visible: import("@angular/core").WritableSignal<boolean>;
-    get label(): string;
-    get placeholder(): string;
-    toggleVisibility(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PasswordFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<PasswordFieldComponent, "ngx-password-field", never, { "field": { "alias": "field"; "required": false; }; "control": { "alias": "control"; "required": false; }; "language": { "alias": "language"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "masked": { "alias": "masked"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/field-types/radio-field.component.d.ts

@@ -1,33 +0,0 @@
-import { AbstractControl } from '@angular/forms';
-import type { NestedFieldConfig } from '@dynamic-entity/core';
-import * as i0 from "@angular/core";
-/** Radio field: a group of radio buttons built from field.options. */
-export declare class RadioFieldComponent {
-    private readonly lookups;
-    private _field;
-    private _language;
-    /** Setter-based so options resolve however the input is set — see `refreshChoiceOptions`. */
-    set field(value: NestedFieldConfig);
-    get field(): NestedFieldConfig;
-    set language(value: string);
-    get language(): string;
-    control: AbstractControl;
-    readonly: boolean;
-    masked: boolean;
-    /** Inline `options`, or the field's named list resolved through the registry (§6.3). */
-    readonly options: import("@angular/core").WritableSignal<DropdownOption[]>;
-    get label(): string;
-    getOptStoredVal(option: any): any;
-    /**
-     * Stable DOM id for one radio, so the <label for> association works.
-     * Slugified because the option text is the value now — "On Leave" must not put a space
-     * into an id attribute.
-     */
-    getRadioId(option: any): string;
-    getOptVal(option: any): any;
-    getOptLabel(option: any): string;
-    /** Read-only display — synchronous, per §6.2. See `DropdownFieldComponent.getLabel`. */
-    getSelectedLabel(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RadioFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<RadioFieldComponent, "ngx-radio-field", never, { "field": { "alias": "field"; "required": false; }; "language": { "alias": "language"; "required": false; }; "control": { "alias": "control"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "masked": { "alias": "masked"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/field-types/text-field.component.d.ts

@@ -1,23 +0,0 @@
-import { OnDestroy } from '@angular/core';
-import { AbstractControl } from '@angular/forms';
-import type { NestedFieldConfig } from '@dynamic-entity/core';
-import * as i0 from "@angular/core";
-export declare class TextFieldComponent implements OnDestroy {
-    private readonly messages;
-    private displaySub?;
-    field: NestedFieldConfig;
-    set control(value: AbstractControl);
-    get control(): AbstractControl;
-    private _control;
-    language: string;
-    readonly: boolean;
-    masked: boolean;
-    /** Readonly markup reads this signal so an external patch (autoPatch) is visible under OnPush. */
-    readonly displayValue: import("@angular/core").WritableSignal<unknown>;
-    ngOnDestroy(): void;
-    get label(): string;
-    get placeholder(): string;
-    get errorMessage(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TextFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TextFieldComponent, "ngx-text-field", never, { "field": { "alias": "field"; "required": false; }; "control": { "alias": "control"; "required": false; }; "language": { "alias": "language"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "masked": { "alias": "masked"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/field-types/textarea-field.component.d.ts

@@ -1,14 +0,0 @@
-import { AbstractControl } from '@angular/forms';
-import type { NestedFieldConfig } from '@dynamic-entity/core';
-import * as i0 from "@angular/core";
-export declare class TextareaFieldComponent {
-    field: NestedFieldConfig;
-    control: AbstractControl;
-    language: string;
-    readonly: boolean;
-    masked: boolean;
-    get label(): string;
-    get placeholder(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TextareaFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TextareaFieldComponent, "ngx-textarea-field", never, { "field": { "alias": "field"; "required": false; }; "control": { "alias": "control"; "required": false; }; "language": { "alias": "language"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "masked": { "alias": "masked"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/form/dynamic-field/dynamic-field.component.d.ts

@@ -1,78 +0,0 @@
-import { OnChanges, OnDestroy, SimpleChanges } from '@angular/core';
-import { AbstractControl } from '@angular/forms';
-import type { NestedFieldConfig, EntityFormConfig } from '@dynamic-entity/core';
-import * as i0 from "@angular/core";
-/**
- * DynamicFieldComponent — mounts the correct field component for a given NestedFieldConfig.
- * Uses ViewContainerRef.createComponent() and passes inputs via setInput(); see
- * DynamicFieldComponentContract for the five inputs every field component receives.
- * Never add field-type-specific logic here — this component must remain generic.
- *
- * The 5 inputs (field, control, language, readonly, masked) are passed to every mounted
- * component uniformly — no special-casing per type.
- */
-export declare class DynamicFieldComponent implements OnChanges, OnDestroy {
-    field: NestedFieldConfig;
-    control: AbstractControl;
-    config: EntityFormConfig;
-    currentTabId?: string;
-    language: string;
-    readonly: boolean;
-    userRoles: string[];
-    private readonly fieldHost;
-    private readonly fieldRegistry;
-    private readonly rbacService;
-    /**
-     * Passed into `createComponent` so a hosted field sees this host's injector — including
-     * `DynamicFormComponent`'s scoped `EntityRefSelectionService`. Without it, a standalone
-     * field resolves the root bus and `autoPatch` never runs.
-     */
-    private readonly injector;
-    private componentRef;
-    ngOnChanges(_changes: SimpleChanges): void;
-    private mountField;
-    /**
-     * Field types are opt-in (see `provideFieldTypes` / `provideBuiltInFieldTypes`), so an
-     * unregistered type renders nothing. Say so once per type in dev builds rather than
-     * leaving a silently blank slot.
-     */
-    private warnUnresolved;
-    private static readonly warnedTypes;
-    /**
-     * Re-check the hosted field component.
-     *
-     * The field components are OnPush, so they re-render on an input change, an event from
-     * their own template, or a signal they read. `form.markAllAsTouched()` is none of those —
-     * it flips `touched` from outside, and every field's error message depends on it. Without
-     * this, a blocked submit would mark the form touched and no error would appear.
-     */
-    refresh(): void;
-    /**
-     * Re-check the hosted component whenever its control changes from outside.
-     *
-     * The field components are OnPush, so they re-render on an input change or an event from
-     * their own template. A control mutated externally is neither — and that is not an edge
-     * case: patchForm, reset, autoPatch and patchOnTrue all do exactly that. Without this, a
-     * field patched from a record would keep rendering its previous value.
-     *
-     * `detectChanges()` rather than `markForCheck()`: a selection that arrives from a native
-     * `change` event (or Playwright) may not be followed by another Angular tick, so a dirty
-     * flag would never be flushed. Running CD on the hosted component now is the copy showing up.
-     *
-     * Done here rather than in each of the eighteen field components: the host owns the
-     * component reference, so one subscription covers every type including custom ones.
-     */
-    private watchControl;
-    private controlSub?;
-    ngOnDestroy(): void;
-    /**
-     * Pass all 5 contract inputs via ComponentRef.setInput() — uniform for all types.
-     * The public shape is DynamicFieldComponentContract.
-     * Must use setInput(), not property assignment: the field components declare inputs with
-     * definite assignment and no initializer, and the lib compiles with
-     * useDefineForClassFields:false, so `'field' in instance` is false until first set.
-     */
-    private setInputs;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DynamicFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DynamicFieldComponent, "ngx-dynamic-field", never, { "field": { "alias": "field"; "required": false; }; "control": { "alias": "control"; "required": false; }; "config": { "alias": "config"; "required": false; }; "currentTabId": { "alias": "currentTabId"; "required": false; }; "language": { "alias": "language"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "userRoles": { "alias": "userRoles"; "required": false; }; }, {}, never, never, true, never>;
-}

package/lib/form/dynamic-form.component.d.ts

@@ -1,291 +0,0 @@
-import { EventEmitter, OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
-import { AbstractControl, FormArray, FormGroup } from '@angular/forms';
-import type { EntityFormConfig, FormRule, NestedFieldConfig, NestedTabConfig } from '@dynamic-entity/core';
-import { RbacService } from '../services/rbac.service';
-import * as i0 from "@angular/core";
-/**
- * DynamicFormComponent — the main form component.
- * Renders a reactive form from EntityFormConfig with tab support, responsive 12-col grid,
- * rules evaluation, conditional visibility, autoPatch/patchOnTrue, criticalField locking,
- * keyboard shortcuts (Ctrl+S, Esc), and RBAC-gated submission.
- */
-export declare class DynamicFormComponent implements OnInit, OnChanges, OnDestroy {
-    /**
-     * The schema to render.
-     *
-     * An accessor pair rather than a plain field: `ngOnChanges` normalises the option shape,
-     * and that result is kept here instead of being written back over the input. Reassigning
-     * an `@Input` works, but it mutates what the parent handed us — and a parent using OnPush
-     * or signals would never observe the replacement anyway.
-     *
-     * Reads of `this.config` get the normalised copy once it exists, so every internal caller
-     * is unaffected.
-     */
-    set config(value: EntityFormConfig);
-    get config(): EntityFormConfig;
-    private rawConfig;
-    private normalizedConfig?;
-    rules?: FormRule[];
-    initialData?: Record<string, any>;
-    /** Session-original values for `VALUE_CHANGED` rules. Captured from the first build when omitted. */
-    originalData?: Record<string, any>;
-    userRoles: string[];
-    language: string;
-    readonly: boolean;
-    /** Field ids forced read-only while the rest of the form stays editable. */
-    readOnlyFields: string[];
-    /**
-     * Render rule `info` banners inline. The record editor sets this false and renders its
-     * own dismissible versions, so the two do not double up.
-     */
-    showInfoBanners: boolean;
-    loading: boolean;
-    error: string | null;
-    /**
-     * Milliseconds to debounce `formChange`. The reference debounces at 300ms so a consumer
-     * re-rendering on every value change is not driven per keystroke. Zero emits
-     * synchronously, which the record editor relies on for its own bookkeeping.
-     */
-    changeDebounceMs: number;
-    /**
-     * Preview mode: seed one empty row per `array` field so the structure is visible, then
-     * disable the form. Used by the builder's live preview.
-     */
-    preview: boolean;
-    formSubmit: EventEmitter<Record<string, any>>;
-    formChange: EventEmitter<Record<string, any>>;
-    formReset: EventEmitter<void>;
-    /** The visible tab changed. Lets a host track it without reaching into this component. */
-    activeTabChange: EventEmitter<string>;
-    /**
-     * Emitted when a `beforeSave` hook aborted the save — by returning false or throwing.
-     * `formSubmit` does not fire in that case.
-     */
-    saveRejected: EventEmitter<{
-        reason: string;
-        error?: unknown;
-    }>;
-    private readonly fb;
-    private readonly validatorRegistry;
-    private readonly hookRegistry;
-    private readonly rbacService;
-    private readonly rulesEvaluation;
-    private readonly entityRefSelection;
-    private readonly commonModulesRegistry;
-    private readonly migrations;
-    protected readonly Object: ObjectConstructor;
-    readonly activeTab: import("@angular/core").WritableSignal<string>;
-    readonly activeSubTab: import("@angular/core").WritableSignal<string>;
-    readonly isSaving: import("@angular/core").WritableSignal<boolean>;
-    readonly formValues: import("@angular/core").WritableSignal<Record<string, any>>;
-    /** Baseline captured at first build, used when `originalData` is not supplied. */
-    readonly sessionBaseline: import("@angular/core").WritableSignal<Record<string, any>>;
-    /** Critical fields the user has explicitly unlocked for editing. */
-    readonly unlockedFields: import("@angular/core").WritableSignal<ReadonlySet<string>>;
-    /** The active tab's field panel, focused after a tab switch. */
-    private formPanel?;
-    /** The hosted field components, so an external control-state change can reach them. */
-    private fieldHosts?;
-    form: FormGroup;
-    private valueSub?;
-    private selectionSub?;
-    /** Previous values, for detecting `patchOnTrue` false→true transitions. */
-    private previousValues;
-    handleKeyboardEvent(event: KeyboardEvent): void;
-    readonly ruleResult: import("@angular/core").Signal<RuleEvaluationResult>;
-    /**
-     * Critical fields whose value differs from the session baseline.
-     * These drive the deferred `VALUE_CHANGED` banner — a critical edit is announced once,
-     * against the value the record had when the session started, not per keystroke.
-     */
-    readonly changedCriticalFields: import("@angular/core").Signal<NestedFieldConfig[]>;
-    get tabs(): NestedTabConfig[];
-    get visibleTabs(): NestedTabConfig[];
-    get activeTabConfig(): NestedTabConfig | null;
-    get visibleSubTabs(): NestedTabConfig[];
-    get activeSubTabConfig(): NestedTabConfig | null;
-    get activeTabModuleComponent(): any | null;
-    get fieldsForActiveTab(): NestedFieldConfig[];
-    /**
-     * Entity-level permissions for the current roles.
-     *
-     * Cached rather than recomputed: this is read from the template several times per change
-     * detection pass, and a fresh object each time is both wasted allocation and a new
-     * identity for anything comparing by reference. Invalidated in `ngOnChanges` when
-     * `config` or `userRoles` change, which are its only inputs.
-     */
-    get permissions(): ReturnType<RbacService['getPermissions']>;
-    private permissionsCache;
-    /**
-     * Whether the current roles may see this record at all.
-     *
-     * `permissions.view` used to be computed and thrown away — a user whose roles failed it
-     * still received the complete form with every value in the DOM. It is honoured now.
-     *
-     * As with masking, this is presentational: it stops the browser rendering data, it does
-     * not stop the data reaching the browser. Authorize on the server.
-     */
-    get canView(): boolean;
-    /**
-     * Whether the current roles may delete this record.
-     *
-     * The library ships no delete affordance, so this is surfaced for the consumer to gate
-     * their own — exposed rather than dropped, because a permission the schema declares
-     * should be answerable.
-     */
-    get canDelete(): boolean;
-    get canSubmit(): boolean;
-    /**
-     * Errors raised by `validation` rules, keyed by the target they point at.
-     *
-     * A rule can declare the record invalid independently of Angular's validators, so form
-     * validity alone is not the whole picture. `DynamicRecordFormComponent.saveSection()`
-     * has always honoured these; `submit()` did not, which meant the same rule blocked one
-     * save path and merely painted a banner on the other — and anything wiring
-     * `(formSubmit)` to persistence wrote records the rules engine had already rejected.
-     */
-    get ruleValidationErrors(): Record<string, string>;
-    /** True when a `validation` rule is currently blocking submission. */
-    get hasRuleErrors(): boolean;
-    /**
-     * True while an async validator is still running.
-     *
-     * Angular reports a control with an outstanding async check as `pending`, and `invalid` is
-     * false until it settles — so without this a form could be submitted in the gap before a
-     * uniqueness check came back.
-     */
-    get isValidating(): boolean;
-    /** Single source of truth for both the submit guard and the button's disabled state. */
-    get submitBlocked(): boolean;
-    ngOnInit(): void;
-    ngOnChanges(changes: SimpleChanges): void;
-    ngOnDestroy(): void;
-    setActiveTab(tabId: string): void;
-    setActiveSubTab(subTabId: string): void;
-    getFieldSpan(field: NestedFieldConfig): string;
-    /** A critical field stays read-only until the user deliberately unlocks it. */
-    isFieldLocked(field: NestedFieldConfig): boolean;
-    /**
-     * Whether this field renders read-only, from any of the four reasons: the whole form,
-     * the field's own flag, a caller-supplied `readOnlyFields` entry, or a criticalField lock.
-     */
-    isFieldReadonly(field: NestedFieldConfig): boolean;
-    toggleFieldLock(field: NestedFieldConfig): void;
-    resolveFieldLabel(field: NestedFieldConfig): string;
-    private buildForm;
-    private buildFieldControl;
-    /** One row of an `array` field: a FormGroup when the field declares columns, else a bare control. */
-    /**
-     * The `FormArray` behind an `array` field, for callers that manage rows themselves —
-     * the record editor's inline row drawer.
-     */
-    getArrayControl(fieldId: string, tabId?: string): FormArray | null;
-    /**
-     * Build one detached row for an `array` field, with the field's own validators applied.
-     * Exposed so a row can be edited outside the form and pushed on save.
-     */
-    createArrayRow(field: NestedFieldConfig, value?: unknown): AbstractControl;
-    private buildArrayRow;
-    /**
-     * Mark every control touched, then re-check the field components.
-     *
-     * They are OnPush and `touched` is flipped from outside their own template, so the second
-     * half is what makes the error messages actually appear.
-     */
-    private markAllTouched;
-    /**
-     * Bring a record up to the config's `version` before it reaches the form.
-     *
-     * Done here because this is the one place a record enters the renderer, so a consumer
-     * cannot forget it. Migration is a no-op unless the consumer registered steps *and* the
-     * record is behind — an unstamped record is deliberately left alone (see `migrateRecord`).
-     *
-     * A missing or broken step throws from core. That is not swallowed: rendering a
-     * half-understood record would write it back in a shape matching neither schema.
-     */
-    private upgradeRecord;
-    private patchForm;
-    /**
-     * A record is nested by tab id (`{ tabId: { fieldId: value } }`) unless the tab sets
-     * `flatData: true`. Handing a flat record to a nested tab finds nothing, so the fields
-     * stay empty — with no error and no clue. That silent miss is the most expensive way to
-     * lose an hour with this library, so name it in dev builds.
-     *
-     * Only top-level keys that match a known field id are reported: anything else is assumed
-     * to be the consumer's own record metadata (ids, timestamps, `_configVersion`) and is not
-     * our business.
-     */
-    private warnUnconsumedInitialData;
-    /** Warn once per key per form instance — patchForm re-runs on every initialData change. */
-    private readonly warnedUnconsumedKeys;
-    /** Assemble full nested record from per-tab FormGroups, respecting flatData, refererField & arrays. */
-    extractRecord(): Record<string, any>;
-    private flattenFormValues;
-    private getTabGroup;
-    /**
-     * `autoPatch` — copy mapped fields out of the record the user just selected in an
-     * entity-ref field into the configured target tab's controls.
-     */
-    private runAutoPatch;
-    /**
-     * `patchOnTrue` — when a boolean/checkbox field transitions to `true`,
-     * copy `from` → `to` within the current record.
-     */
-    private runPatchOnTrue;
-    /** Prefer a control declared on the configured target tab; fall back to a top-level control. */
-    private resolveTargetControl;
-    /**
-     * The fields the render filter operates on — a tab's own fields, at every tab depth.
-     * Deliberately not `allFields()`: `group` and `array` children are shown or hidden with
-     * their parent, and toggling a child's state independently would fight the parent's.
-     */
-    private tabFields;
-    /**
-     * Keep a hidden field's control out of form validity.
-     *
-     * A field hidden by a rule or a `showWhen` condition is filtered out of the render, but
-     * its validators stay attached — so a hidden *required* field holds `form.invalid` true
-     * forever, permanently disabling Save with nothing on screen to explain why.
-     *
-     * Disabling is the fix rather than stripping validators: Angular excludes disabled
-     * controls from validity, and the field's own validators survive intact for when it
-     * comes back. Values are untouched — `flattenFormValues` and `extractRecord` both read
-     * `control.value`, which a disabled control still carries, so rule evaluation and the
-     * emitted record see exactly what they saw before. That also keeps this from feeding
-     * back on itself: hiding a field cannot change the values the rules are evaluated over.
-     *
-     * The visibility predicate is the same one `fieldsForActiveTab` filters with, so what is
-     * rendered and what counts toward validity cannot drift apart.
-     */
-    private syncHiddenFieldState;
-    /** Every field in the config, including `group`/`array` children. */
-    private allFields;
-    /** An empty `originalData` counts as "not supplied" — fall back to the captured baseline. */
-    private baseline;
-    private sameValue;
-    getControl(fieldId: string, currentTabId?: string): AbstractControl | null;
-    /**
-     * Move focus into the newly shown panel.
-     *
-     * Activating a tab replaces everything below it while focus stays on the tab button, so a
-     * screen-reader or keyboard user is given no indication that the content changed and must
-     * tab back through the strip to reach it. Deferred a frame because the panel's contents
-     * are rendered by the change detection this call is part of.
-     */
-    private focusActivePanel;
-    /** Accessible name for the field panel — it is the tabpanel for the active tab. */
-    get activeTabLabel(): string;
-    /**
-     * Why a referenced field is flagged.
-     *
-     * `hasDrift` was written by the builder and read by nothing at runtime, so a field whose
-     * source definition had changed since it was linked looked entirely normal to the person
-     * filling the form in.
-     */
-    driftHint(field: NestedFieldConfig): string;
-    resolveTabLabel(tab: NestedTabConfig): string;
-    submit(): Promise<void>;
-    reset(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DynamicFormComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DynamicFormComponent, "ngx-dynamic-form", never, { "config": { "alias": "config"; "required": false; }; "rules": { "alias": "rules"; "required": false; }; "initialData": { "alias": "initialData"; "required": false; }; "originalData": { "alias": "originalData"; "required": false; }; "userRoles": { "alias": "userRoles"; "required": false; }; "language": { "alias": "language"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "readOnlyFields": { "alias": "readOnlyFields"; "required": false; }; "showInfoBanners": { "alias": "showInfoBanners"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "error": { "alias": "error"; "required": false; }; "changeDebounceMs": { "alias": "changeDebounceMs"; "required": false; }; "preview": { "alias": "preview"; "required": false; }; }, { "formSubmit": "formSubmit"; "formChange": "formChange"; "formReset": "formReset"; "activeTabChange": "activeTabChange"; "saveRejected": "saveRejected"; }, never, never, true, never>;
-}