@mosaicoo/form-angular 0.3.0 → 0.5.0

package/types/mosaicoo-form-angular.d.ts

@@ -1,70 +1,10 @@
 import * as _angular_core from '@angular/core';
 import { Type, InjectionToken, EnvironmentProviders } from '@angular/core';
 import * as _mosaicoo_form_core from '@mosaicoo/form-core';
-import { FormSchema, OptionsProviderRegistry, MessageResolver, SubmitResult, ImportWarning, FormEngine, ContainerField, FieldError, FieldNode, FieldOption, InputField, RemoteOptionsFetcher } from '@mosaicoo/form-core';
-
-/**
- * `<mform-renderer>` — renders a form at runtime from a `FormSchema` (or any
- * definition a registered importer understands) and manages its lifecycle:
- * values, validation, conditional visibility and submission. Wizard schemas
- * (`settings.display: 'wizard'`) render as steps with per-step validation.
- *
- * Theming: every visual primitive reads a `--mform-*` CSS custom property
- * with a self-contained fallback, so the component looks finished on its own
- * and adopts the host design system when the host overrides the tokens.
- */
-declare class FormRendererComponent {
-    /** Native schema input. Takes precedence over `source`. */
-    readonly schema: _angular_core.InputSignal<FormSchema | null>;
-    /** Foreign definition (object or JSON string) resolved via importers. */
-    readonly source: _angular_core.InputSignal<unknown>;
-    /** Initial data merged over schema defaults. */
-    readonly initialData: _angular_core.InputSignal<Record<string, unknown> | null>;
-    /** Named providers resolving `optionsSource: provider` fields. */
-    readonly optionsProviders: _angular_core.InputSignal<OptionsProviderRegistry>;
-    /** Host-supplied message resolver (localization of validation messages). */
-    readonly messages: _angular_core.InputSignal<MessageResolver | null>;
-    /** Fixed renderer texts (override to localize). `{{count}}` in `summary`. */
-    readonly labels: _angular_core.InputSignalWithTransform<{
-        previous: string;
-        next: string;
-        submit: string;
-        summary: string;
-    }, Partial<{
-        previous: string;
-        next: string;
-        submit: string;
-        summary: string;
-    }>>;
-    summaryTitle(): string;
-    /** Fired on submit; `ok` is false when validation failed. */
-    readonly submitted: _angular_core.OutputEmitterRef<SubmitResult>;
-    /** Fired on every value change with the full data snapshot. */
-    readonly valueChanged: _angular_core.OutputEmitterRef<Record<string, unknown>>;
-    /** Bumped on every engine event; nodes read it to refresh. */
-    readonly tick: _angular_core.WritableSignal<number>;
-    /** Active wizard step index. */
-    readonly currentStep: _angular_core.WritableSignal<number>;
-    private readonly resolved;
-    /** Import degradations for the current `source`, if any. */
-    readonly importWarnings: _angular_core.Signal<ImportWarning[]>;
-    readonly engine: _angular_core.Signal<FormEngine | null>;
-    readonly isWizard: _angular_core.Signal<boolean>;
-    /** Wizard pages: the top-level containers of the schema. */
-    readonly steps: _angular_core.Signal<ContainerField[]>;
-    readonly errorSummary: _angular_core.WritableSignal<FieldError[]>;
-    constructor();
-    previousStep(): void;
-    nextStep(): void;
-    onSubmit(event: Event): void;
-    /** Finds the wizard step that owns a (possibly row-indexed) data path. */
-    private stepIndexForPath;
-    private readonly documentRef;
-    private focusFirstError;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormRendererComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormRendererComponent, "mform-renderer", never, { "schema": { "alias": "schema"; "required": false; "isSignal": true; }; "source": { "alias": "source"; "required": false; "isSignal": true; }; "initialData": { "alias": "initialData"; "required": false; "isSignal": true; }; "optionsProviders": { "alias": "optionsProviders"; "required": false; "isSignal": true; }; "messages": { "alias": "messages"; "required": false; "isSignal": true; }; "labels": { "alias": "labels"; "required": false; "isSignal": true; }; }, { "submitted": "submitted"; "valueChanged": "valueChanged"; }, never, never, true, never>;
-}
+import { FieldNode, FormEngine, OptionsProviderRegistry, FieldOption, InputField, ContainerField, FormSchema, MessageResolver, ValidatorRegistry, SubmitResult, ImportWarning, FieldError, RemoteOptionsFetcher } from '@mosaicoo/form-core';
 
+/** Rendering mode: `readonly` hides actions, `disabled` grays everything. */
+type FormMode = 'edit' | 'readonly' | 'disabled';
 /**
  * Renders one schema node (input, container or static) and recurses into
  * children. State lives in the headless engine — this component only projects
@@ -82,14 +22,34 @@ declare class FormNodeComponent {
     readonly bare: _angular_core.InputSignal<boolean>;
     /** Host-registered providers for `optionsSource: provider` fields. */
     readonly providers: _angular_core.InputSignal<OptionsProviderRegistry>;
+    /** Rendering mode inherited from the renderer. */
+    readonly mode: _angular_core.InputSignal<FormMode>;
+    /** Renderer-supplied refresh hook for async completions (zoneless-safe). */
+    readonly notify: _angular_core.InputSignal<() => void>;
     readonly activeTab: _angular_core.WritableSignal<number>;
     /** DI-registered custom field components (maps merge; later wins). */
     private readonly componentMaps;
     /** Host transport for remote options; plain fetch when absent. */
     private readonly remoteFetcher;
+    /** Host-owned upload for `file` fields. */
+    private readonly uploader;
+    /**
+     * Async resolutions (debounce timers, provider promises) finish outside
+     * any template event — explicitly schedule the refresh for zoneless apps.
+     */
+    private readonly changeDetector;
+    readonly uploading: _angular_core.WritableSignal<boolean>;
+    /** Effective disabled state: mode, schema flag or calculated field. */
+    controlDisabled(): boolean;
+    interactive(): boolean;
+    pending(): boolean;
     /** Custom component registered for this field type, if any. */
     customComponent(): Type<unknown> | null;
-    /** Inputs handed to a custom component (MformFieldComponent contract). */
+    /**
+     * Inputs handed to a custom component (MformFieldComponent contract).
+     * Only inputs the component actually declares are passed, so optional
+     * contract members (`mode`) never break third-party components.
+     */
     customInputs(): Record<string, unknown>;
     /** Options resolved from a dynamic source (provider or remote URL). */
     private readonly resolvedOptions;
@@ -130,16 +90,106 @@ declare class FormNodeComponent {
     setChecked(event: Event): void;
     toggleMap(option: string, event: Event): void;
     setFiles(event: Event): void;
+    /** Names shown under a `file` control (refs or plain names). */
+    fileNames(): string[];
     prefix(): string | null;
     suffix(): string | null;
     tagValues(): string[];
     addTag(event: Event): void;
     removeTag(index: number): void;
     touch(): void;
+    readonly refOptions: _angular_core.WritableSignal<FieldOption[]>;
+    readonly refOpen: _angular_core.WritableSignal<boolean>;
+    private refTimer;
+    /** Label of the chosen option (falls back to the raw value). */
+    readonly refLabel: _angular_core.WritableSignal<string | null>;
+    refDisplay(): string;
+    refSearch(event: Event): void;
+    private refResolve;
+    refPick(option: FieldOption): void;
+    refBlur(): void;
     addRow(): void;
     removeRow(index: number): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormNodeComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormNodeComponent, "mform-node", never, { "node": { "alias": "node"; "required": true; "isSignal": true; }; "engine": { "alias": "engine"; "required": true; "isSignal": true; }; "tick": { "alias": "tick"; "required": true; "isSignal": true; }; "scope": { "alias": "scope"; "required": false; "isSignal": true; }; "bare": { "alias": "bare"; "required": false; "isSignal": true; }; "providers": { "alias": "providers"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormNodeComponent, "mform-node", never, { "node": { "alias": "node"; "required": true; "isSignal": true; }; "engine": { "alias": "engine"; "required": true; "isSignal": true; }; "tick": { "alias": "tick"; "required": true; "isSignal": true; }; "scope": { "alias": "scope"; "required": false; "isSignal": true; }; "bare": { "alias": "bare"; "required": false; "isSignal": true; }; "providers": { "alias": "providers"; "required": false; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "notify": { "alias": "notify"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * `<mform-renderer>` — renders a form at runtime from a `FormSchema` (or any
+ * definition a registered importer understands) and manages its lifecycle:
+ * values, validation, conditional visibility and submission. Wizard schemas
+ * (`settings.display: 'wizard'`) render as steps with per-step validation.
+ *
+ * Theming: every visual primitive reads a `--mform-*` CSS custom property
+ * with a self-contained fallback, so the component looks finished on its own
+ * and adopts the host design system when the host overrides the tokens.
+ */
+declare class FormRendererComponent {
+    /** Native schema input. Takes precedence over `source`. */
+    readonly schema: _angular_core.InputSignal<FormSchema | null>;
+    /** Foreign definition (object or JSON string) resolved via importers. */
+    readonly source: _angular_core.InputSignal<unknown>;
+    /** Initial data merged over schema defaults. */
+    readonly initialData: _angular_core.InputSignal<Record<string, unknown> | null>;
+    /** Named providers resolving `optionsSource: provider` fields. */
+    readonly optionsProviders: _angular_core.InputSignal<OptionsProviderRegistry>;
+    /** Host-supplied message resolver (localization of validation messages). */
+    readonly messages: _angular_core.InputSignal<MessageResolver | null>;
+    /** Named custom validators (sync or async — Promises get pending states). */
+    readonly validators: _angular_core.InputSignal<ValidatorRegistry | null>;
+    /** `edit` (default), `readonly` (no actions) or `disabled`. */
+    readonly mode: _angular_core.InputSignal<FormMode>;
+    /**
+     * Optional host submission: called after a VALID submit with the result;
+     * rejections surface as the submission error state. Persistence transport
+     * stays entirely on the host side.
+     */
+    readonly submitHandler: _angular_core.InputSignal<((result: SubmitResult) => Promise<void>) | null>;
+    /** True while async validation or the submit handler is running. */
+    readonly submitting: _angular_core.WritableSignal<boolean>;
+    /** Message when the host submission rejected. */
+    readonly submitError: _angular_core.WritableSignal<string | null>;
+    /** Fixed renderer texts (override to localize). `{{count}}` in `summary`. */
+    readonly labels: _angular_core.InputSignalWithTransform<{
+        previous: string;
+        next: string;
+        submit: string;
+        summary: string;
+    }, Partial<{
+        previous: string;
+        next: string;
+        submit: string;
+        summary: string;
+    }>>;
+    summaryTitle(): string;
+    /** Fired on submit; `ok` is false when validation failed. */
+    readonly submitted: _angular_core.OutputEmitterRef<SubmitResult>;
+    /** Fired on every value change with the full data snapshot. */
+    readonly valueChanged: _angular_core.OutputEmitterRef<Record<string, unknown>>;
+    /** Bumped on every engine event; nodes read it to refresh. */
+    readonly tick: _angular_core.WritableSignal<number>;
+    /** Handed to nodes so async completions re-render (zoneless-safe). */
+    readonly bumpTick: () => void;
+    /** Active wizard step index. */
+    readonly currentStep: _angular_core.WritableSignal<number>;
+    private readonly resolved;
+    /** Import degradations for the current `source`, if any. */
+    readonly importWarnings: _angular_core.Signal<ImportWarning[]>;
+    readonly engine: _angular_core.Signal<FormEngine | null>;
+    readonly isWizard: _angular_core.Signal<boolean>;
+    /** Wizard pages: the top-level containers of the schema. */
+    readonly steps: _angular_core.Signal<ContainerField[]>;
+    readonly errorSummary: _angular_core.WritableSignal<FieldError[]>;
+    constructor();
+    previousStep(): void;
+    nextStep(): void;
+    onSubmit(event: Event): Promise<void>;
+    /** Finds the wizard step that owns a (possibly row-indexed) data path. */
+    private stepIndexForPath;
+    private readonly documentRef;
+    private focusFirstError;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormRendererComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormRendererComponent, "mform-renderer", never, { "schema": { "alias": "schema"; "required": false; "isSignal": true; }; "source": { "alias": "source"; "required": false; "isSignal": true; }; "initialData": { "alias": "initialData"; "required": false; "isSignal": true; }; "optionsProviders": { "alias": "optionsProviders"; "required": false; "isSignal": true; }; "messages": { "alias": "messages"; "required": false; "isSignal": true; }; "validators": { "alias": "validators"; "required": false; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "submitHandler": { "alias": "submitHandler"; "required": false; "isSignal": true; }; "labels": { "alias": "labels"; "required": false; "isSignal": true; }; }, { "submitted": "submitted"; "valueChanged": "valueChanged"; }, never, never, true, never>;
 }
 
 /**
@@ -165,6 +215,8 @@ interface MformFieldComponent {
     path: () => string;
     /** Bumped on every engine event; read it to stay in sync. */
     tick: () => number;
+    /** Rendering mode of the surrounding form (optional input). */
+    mode?: () => 'edit' | 'readonly' | 'disabled';
 }
 /** Map of field `type` → component implementing {@link MformFieldComponent}. */
 type FieldComponentMap = Record<string, Type<unknown>>;
@@ -176,11 +228,31 @@ declare const MFORM_FIELD_COMPONENTS: InjectionToken<FieldComponentMap[]>;
  * base URLs, caching). Without it, a plain `fetch` is used.
  */
 declare const MFORM_REMOTE_FETCHER: InjectionToken<RemoteOptionsFetcher>;
+/** Reference the host returns after uploading one file. */
+interface UploadedFileRef {
+    name: string;
+    id?: string;
+    url?: string;
+    size?: number;
+    [extra: string]: unknown;
+}
+/**
+ * Host-owned file upload: receives each selected file, delivers it wherever
+ * the host decides (API, bucket, queue) and returns the reference stored in
+ * the form data. Without it, `file` fields keep only file names.
+ */
+type FileUploadFn = (file: File, context: {
+    field: InputField;
+    path: string;
+}) => Promise<UploadedFileRef>;
+declare const MFORM_UPLOAD: InjectionToken<FileUploadFn>;
 interface MosaicooFormConfig {
     /** Custom/override field components, keyed by field `type`. */
     components?: FieldComponentMap;
     /** Host transport for remote options sources. */
     remoteFetcher?: RemoteOptionsFetcher;
+    /** Host-owned file upload for `file` fields. */
+    uploadFiles?: FileUploadFn;
 }
 /**
  * Registers renderer extensions at any injector level:
@@ -198,5 +270,5 @@ interface MosaicooFormConfig {
  */
 declare function provideMosaicooForm(config: MosaicooFormConfig): EnvironmentProviders;
 
-export { FormNodeComponent, FormRendererComponent, MFORM_FIELD_COMPONENTS, MFORM_REMOTE_FETCHER, provideMosaicooForm };
-export type { FieldComponentMap, MformFieldComponent, MosaicooFormConfig };
+export { FormNodeComponent, FormRendererComponent, MFORM_FIELD_COMPONENTS, MFORM_REMOTE_FETCHER, MFORM_UPLOAD, provideMosaicooForm };
+export type { FieldComponentMap, FileUploadFn, FormMode, MformFieldComponent, MosaicooFormConfig, UploadedFileRef };