@a.nemreen/dga-dynamic-form 0.1.7 → 0.1.9

package/types/a.nemreen-dga-dynamic-form.d.ts

@@ -1,14 +1,15 @@
 import * as _angular_core from '@angular/core';
 import { InjectionToken, Type, OnInit, EnvironmentProviders } from '@angular/core';
-import { FormGroup, FormControl, FormBuilder, ValidatorFn, AbstractControl } from '@angular/forms';
+import { FormGroup, FormControl, FormBuilder, ValidatorFn, AbstractControl, ValidationErrors } from '@angular/forms';
 import { DgaStep, DgaSelectOption, DgaToastService } from '@a.nemreen/dga-ui';
 import { Observable } from 'rxjs';
 import { HttpClient } from '@angular/common/http';
 
-/** Bilingual label used across the schema. */
+/** Localized label (en/ar required for schemas; extra locale keys optional). */
 interface DgaFormLabel {
     en: string;
     ar: string;
+    [locale: string]: string;
 }
 interface DgaFormFieldColumns {
     xl?: number;
@@ -24,7 +25,24 @@ interface DgaFormFieldOption {
     disabled?: boolean;
     [key: string]: unknown;
 }
-type DgaFormFieldType = 'text' | 'email' | 'textarea' | 'select' | 'multiselect' | 'checkbox' | 'radio' | 'phone' | 'file' | 'date' | 'chips' | 'toggle' | 'hidden' | 'number' | 'otp';
+type DgaFormFieldType = 'text' | 'email' | 'textarea' | 'select' | 'multiselect' | 'checkbox' | 'radio' | 'phone' | 'file' | 'multifile' | 'multifilestaged' | 'date' | 'chips' | 'toggle' | 'hidden' | 'number' | 'otp' | 'password';
+/** Pre-populated attachment from the server (edit mode). */
+interface DgaExistingAttachment {
+    Id: number;
+    FileName: string;
+    ContentType: string;
+}
+type DgaStagedFileStatus = 'uploading' | 'success' | 'error';
+/** Value shape for `multifilestaged` fields. */
+interface DgaStagedFileRef {
+    fileId: string;
+    fileName: string;
+    sizeBytes?: number;
+    status?: DgaStagedFileStatus;
+    errorMessage?: string;
+    /** Client-only list identity when server reuses fileId. */
+    listKey?: string;
+}
 type DgaInputRestriction = 'numbers' | 'english' | 'arabic';
 type DgaHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
 interface DgaFormField {
@@ -40,10 +58,22 @@ interface DgaFormField {
     hidden?: boolean;
     dependsOn?: string;
     showOnValues?: unknown[];
+    /** Show when selected option English label matches. */
+    showOnTitleEn?: string;
+    /** Show when selected option Arabic label matches. */
+    showOnTitleAr?: string;
+    /** Extra text field shown when selected option has `requiresTextInput`. */
+    extraField?: boolean;
+    /** Trigger field for `extraField` (defaults to `dependsOn`). */
+    extraFieldTrigger?: string;
     showWhenOptionProperty?: {
         property: string;
         value: unknown;
     };
+    /** CMS consent key — fetched from `consentBaseUrl` on the form config. */
+    consentServiceName?: string;
+    /** Keep select dropdown open (DGA select `openMode="always"`). */
+    alwaysOpen?: boolean;
     lookupDomain?: string;
     lookupName?: string;
     lookupFilter?: {
@@ -60,6 +90,11 @@ interface DgaFormField {
     acceptedFileTypes?: string;
     maxFileSize?: number;
     maxFiles?: number;
+    /** POST URL for `multifilestaged` staging uploads. Response: `{ fileId, fileName? }`. */
+    uploadEndpoint?: string;
+    /** DELETE/POST URL for staged file removal. Use `:id` or `:fileId` placeholder. */
+    deleteEndpoint?: string;
+    deleteMethod?: 'DELETE' | 'POST';
     rows?: number;
     minDate?: string;
     maxDate?: string;
@@ -94,7 +129,9 @@ interface DgaFormField {
         required?: boolean;
         min?: number;
         max?: number;
-        errorMessages?: Partial<Record<'required' | 'pattern' | 'minLength' | 'maxLength' | 'email' | 'min' | 'max' | 'minDate' | 'maxDate' | 'maxChips' | 'invalidFormat', DgaFormLabel>>;
+        minDate?: string;
+        maxDate?: string;
+        errorMessages?: Partial<Record<'required' | 'pattern' | 'minLength' | 'maxLength' | 'email' | 'min' | 'max' | 'minDate' | 'maxDate' | 'maxChips' | 'invalidFormat' | 'invalidPrefix' | 'invalidLength' | 'passwordMismatch' | 'endDateAfterStartDate' | 'uploadInProgress' | 'maxFiles', DgaFormLabel>>;
     };
 }
 interface DgaFormStep {
@@ -103,6 +140,8 @@ interface DgaFormStep {
     description?: DgaFormLabel;
     fields: DgaFormField[];
     optional?: boolean;
+    /** Pre-fill values when entering this wizard step. */
+    initialData?: Record<string, unknown>;
 }
 interface DgaWizardConfig {
     enabled: boolean;
@@ -138,8 +177,13 @@ interface DgaDynamicFormConfig {
     idempotencyKey?: string;
     /** When true, HTTP submit is skipped and only `formSubmitted` is emitted. */
     emitOnly?: boolean;
+    /**
+     * Base URL for CMS consent fetch (`consentServiceName` fields).
+     * e.g. `https://cms.example.com/api` → GET `{base}/consents/{name}`.
+     */
+    consentBaseUrl?: string;
 }
-type DgaFormLocale = 'ar' | 'en';
+type DgaFormLocale = string;
 
 interface DgaLookupRequest {
     domain: string;
@@ -173,11 +217,8 @@ interface DgaCaptchaAdapter {
     getToken(action?: string): Observable<string | null>;
 }
 interface DgaFormI18nAdapter {
-    /** Resolve a bilingual label for the active locale. */
-    resolveLabel(label: {
-        en: string;
-        ar: string;
-    }, locale: DgaFormLocale): string;
+    /** Resolve a localized label for the active locale. */
+    resolveLabel(label: DgaFormLabel, locale: DgaFormLocale): string;
     /** Optional free-form key lookup (e.g. ngx-translate). */
     translate?(key: string, locale: DgaFormLocale): string;
 }
@@ -191,6 +232,10 @@ declare const DGA_LOOKUP_ADAPTER: InjectionToken<DgaLookupAdapter>;
 declare const DGA_SUBMIT_ADAPTER: InjectionToken<DgaSubmitAdapter>;
 declare const DGA_FORM_TOAST_ADAPTER: InjectionToken<DgaFormToastAdapter>;
 declare const DGA_CAPTCHA_ADAPTER: InjectionToken<DgaCaptchaAdapter>;
+interface DgaHttpSecurityOptions {
+    allowedOrigins?: string[];
+}
+declare const DGA_HTTP_SECURITY: InjectionToken<DgaHttpSecurityOptions>;
 declare const DGA_FORM_I18N_ADAPTER: InjectionToken<DgaFormI18nAdapter>;
 declare const DGA_DYNAMIC_FORM_FIELD_REGISTRY: InjectionToken<DgaDynamicFieldRenderer[]>;
 /** Context passed into custom field renderer components (optional inject). */
@@ -221,13 +266,15 @@ declare class DgaDynamicFormFieldRegistry {
 
 declare class DgaDynamicForm {
     readonly config: _angular_core.InputSignal<DgaDynamicFormConfig>;
-    readonly localeInput: _angular_core.InputSignal<DgaFormLocale | null>;
+    readonly localeInput: _angular_core.InputSignal<string | null>;
     readonly formSubmitted: _angular_core.OutputEmitterRef<unknown>;
     readonly formError: _angular_core.OutputEmitterRef<unknown>;
     readonly clearButtonClick: _angular_core.OutputEmitterRef<void>;
     readonly draftSaved: _angular_core.OutputEmitterRef<Record<string, unknown>>;
+    readonly fileDownload: _angular_core.OutputEmitterRef<DgaExistingAttachment>;
     private readonly fb;
     private readonly formService;
+    private readonly submitAdapter;
     private readonly toast;
     private readonly i18n;
     private readonly destroyRef;
@@ -239,7 +286,7 @@ declare class DgaDynamicForm {
     readonly submitting: _angular_core.WritableSignal<boolean>;
     readonly optionsMap: _angular_core.WritableSignal<Record<string, DgaFormFieldOption[]>>;
     private readonly formValues;
-    readonly locale: _angular_core.Signal<DgaFormLocale>;
+    readonly locale: _angular_core.Signal<string>;
     readonly wizardEnabled: _angular_core.Signal<boolean>;
     readonly allFields: _angular_core.Signal<DgaFormField[]>;
     readonly currentStepFields: _angular_core.Signal<DgaFormField[]>;
@@ -247,10 +294,7 @@ declare class DgaDynamicForm {
     readonly stepperSteps: _angular_core.Signal<DgaStep[]>;
     readonly descriptionText: _angular_core.Signal<string>;
     constructor();
-    labelOf(label: {
-        en: string;
-        ar: string;
-    } | undefined): string;
+    labelOf(label: DgaFormLabel | undefined): string;
     submitLabel(): string;
     nextLabel(): string;
     previousLabel(): string;
@@ -271,6 +315,7 @@ declare class DgaDynamicForm {
     /** Keep stepper clicks aligned with Next validation / allowSkip rules. */
     readonly canActivateStep: (next: number, current: number) => boolean;
     nextStep(): void;
+    private skipEmptyStepsForward;
     onClear(): void;
     onSaveDraft(): void;
     onSubmit(): void;
@@ -283,21 +328,24 @@ declare class DgaDynamicForm {
     private visibleValid;
     private collectVisibleFieldNames;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DgaDynamicForm, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DgaDynamicForm, "dga-dynamic-form", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; "localeInput": { "alias": "locale"; "required": false; "isSignal": true; }; }, { "formSubmitted": "formSubmitted"; "formError": "formError"; "clearButtonClick": "clearButtonClick"; "draftSaved": "draftSaved"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DgaDynamicForm, "dga-dynamic-form", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; "localeInput": { "alias": "locale"; "required": false; "isSignal": true; }; }, { "formSubmitted": "formSubmitted"; "formError": "formError"; "clearButtonClick": "clearButtonClick"; "draftSaved": "draftSaved"; "fileDownload": "fileDownload"; }, never, never, true, never>;
 }
 
 declare class DgaDynamicFormField implements OnInit {
     readonly field: _angular_core.InputSignal<DgaFormField>;
     readonly form: _angular_core.InputSignal<FormGroup<any>>;
-    readonly locale: _angular_core.InputSignal<DgaFormLocale>;
+    readonly locale: _angular_core.InputSignal<string>;
     readonly required: _angular_core.InputSignalWithTransform<boolean, unknown>;
     readonly error: _angular_core.InputSignal<string>;
     readonly runtimeOptions: _angular_core.InputSignal<DgaFormFieldOption[]>;
+    readonly consentBaseUrl: _angular_core.InputSignal<string | undefined>;
     readonly optionsLoaded: _angular_core.OutputEmitterRef<{
         name: string;
         options: DgaFormFieldOption[];
     }>;
+    readonly fileDownload: _angular_core.OutputEmitterRef<DgaExistingAttachment>;
     private readonly lookup;
+    private readonly http;
     private readonly destroyRef;
     readonly loadedOptions: _angular_core.WritableSignal<DgaFormFieldOption[]>;
     readonly controlId: string;
@@ -308,14 +356,19 @@ declare class DgaDynamicFormField implements OnInit {
     readonly resolvedOptions: _angular_core.Signal<DgaFormFieldOption[]>;
     readonly selectOptions: _angular_core.Signal<DgaSelectOption[]>;
     ngOnInit(): void;
+    private mapExistingFileValue;
+    private fetchConsent;
+    private fetchLookup;
     optionLabel(opt: DgaFormFieldOption): string;
+    isPasswordField(): boolean;
     isChecked(value: unknown): boolean;
     toggleCheckbox(value: unknown, checked: boolean): void;
-    onSelectSearch(_value: string | string[]): void;
+    onSelectSearchQuery(query: string): void;
+    onStagedFileDownload(event: DgaExistingAttachment): void;
     onRestrict(event: Event): void;
     private applyLookupFilter;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DgaDynamicFormField, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DgaDynamicFormField, "dga-dynamic-form-field", never, { "field": { "alias": "field"; "required": true; "isSignal": true; }; "form": { "alias": "form"; "required": true; "isSignal": true; }; "locale": { "alias": "locale"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "runtimeOptions": { "alias": "runtimeOptions"; "required": false; "isSignal": true; }; }, { "optionsLoaded": "optionsLoaded"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DgaDynamicFormField, "dga-dynamic-form-field", never, { "field": { "alias": "field"; "required": true; "isSignal": true; }; "form": { "alias": "form"; "required": true; "isSignal": true; }; "locale": { "alias": "locale"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "runtimeOptions": { "alias": "runtimeOptions"; "required": false; "isSignal": true; }; "consentBaseUrl": { "alias": "consentBaseUrl"; "required": false; "isSignal": true; }; }, { "optionsLoaded": "optionsLoaded"; "fileDownload": "fileDownload"; }, never, never, true, never>;
 }
 
 declare class DgaDynamicFormService {
@@ -354,25 +407,27 @@ declare function dgaFindSelectedOption(field: DgaFormField | undefined, value: u
 /**
  * Whether a field should be visible given the current form values.
  */
-declare function dgaIsFieldVisible(field: DgaFormField, values: Record<string, unknown>, getOptions?: (name: string) => DgaFormFieldOption[] | undefined): boolean;
-declare function dgaIsRequiredWhen(field: DgaFormField, values: Record<string, unknown>, getOptions?: (name: string) => DgaFormFieldOption[] | undefined): boolean;
+declare function dgaIsFieldVisible(field: DgaFormField, values: Record<string, unknown>, getOptions?: (name: string) => DgaFormFieldOption[] | undefined, getField?: (name: string) => DgaFormField | undefined): boolean;
+declare function dgaIsRequiredWhen(field: DgaFormField, values: Record<string, unknown>, getOptions?: (name: string) => DgaFormFieldOption[] | undefined, getField?: (name: string) => DgaFormField | undefined): boolean;
 
-/** Default bilingual label resolver. */
+/** Known start/end date field pairs used by cross-field validators. */
+declare const DGA_DATE_RANGE_PAIRS: ReadonlyArray<[string, string]>;
+declare function dgaPasswordMatchValidator(passwordControl: AbstractControl): ValidatorFn;
+/**
+ * Saudi mobile validation for type: phone fields.
+ * Accepts E.164 (+966…) or national digits (0xxxxxxxx or 5xxxxxxxx).
+ */
+declare function dgaSaudiMobileValidator(control: AbstractControl): ValidationErrors | null;
+/** Wire password match + date-range validators after form group is built. */
+declare function dgaApplyCrossFieldValidators(form: FormGroup, fields: DgaFormField[]): void;
+
+/** Default localized label resolver. */
 declare const defaultFormI18nAdapter: DgaFormI18nAdapter;
 /** No-op captcha (always null token). */
 declare const noopCaptchaAdapter: DgaCaptchaAdapter;
 /** Empty lookup (returns []). Override in the host app. */
 declare const emptyLookupAdapter: DgaLookupAdapter;
-interface DgaHttpAdapterSecurityOptions {
-    /**
-     * Allowed URL origins for schema-driven HTTP (e.g. `https://api.example.com`).
-     * Absolute URLs outside the list are rejected.
-     * Same-origin paths (`/api/...`) are always allowed.
-     *
-     * Strongly recommended for CMS / untrusted schemas. When `requireAllowedOrigins`
-     * is true (see `provideDgaDynamicForm`), omitting this throws at bootstrap.
-     */
-    allowedOrigins?: string[];
+interface DgaHttpAdapterSecurityOptions extends DgaHttpSecurityOptions {
 }
 /**
  * Validates schema-supplied URLs before HttpClient calls.
@@ -407,13 +462,11 @@ interface ProvideDgaDynamicFormOptions {
  */
 declare function provideDgaDynamicForm(options?: ProvideDgaDynamicFormOptions): EnvironmentProviders;
 /** Helper for templates / host apps. */
-declare function resolveFormLabel(label: {
-    en: string;
-    ar: string;
-} | undefined, locale: DgaFormLocale, fallback?: string): string;
+declare function resolveFormLabel(label: DgaFormLabel | undefined, locale: DgaFormLocale, fallback?: string): string;
 
-declare function dgaResolveLabel(label: DgaFormLabel | undefined, locale: DgaFormLocale, fallback?: string): string;
+type LocalizedMap = Partial<Record<string, string>>;
+declare function dgaResolveLabel(label: LocalizedMap | DgaFormLabel | undefined, locale: DgaFormLocale, fallback?: string): string;
 declare function dgaDetectLocale(): DgaFormLocale;
 
-export { DGA_CAPTCHA_ADAPTER, DGA_DYNAMIC_FORM_FIELD_REGISTRY, DGA_FORM_I18N_ADAPTER, DGA_FORM_TOAST_ADAPTER, DGA_LOOKUP_ADAPTER, DGA_SUBMIT_ADAPTER, DgaDynamicForm, DgaDynamicFormField, DgaDynamicFormFieldRegistry, DgaDynamicFormService, createDgaToastAdapter, createHttpLookupAdapter, createHttpSubmitAdapter, defaultFormI18nAdapter, dgaAssertSafeHttpUrl, dgaBuildFormGroup, dgaBuildValidators, dgaCollectFields, dgaCreateControl, dgaDefaultValueForField, dgaDetectLocale, dgaFindSelectedOption, dgaIsFieldVisible, dgaIsRequiredWhen, dgaResolveLabel, dgaSetControlValidators, emptyLookupAdapter, noopCaptchaAdapter, provideDgaDynamicForm, resolveFormLabel };
-export type { DgaCaptchaAdapter, DgaDynamicFieldHostContext, DgaDynamicFieldRenderer, DgaDynamicFormConfig, DgaDynamicFormPayloadTransformer, DgaFormField, DgaFormFieldColumns, DgaFormFieldOption, DgaFormFieldType, DgaFormI18nAdapter, DgaFormLabel, DgaFormLocale, DgaFormStep, DgaFormToastAdapter, DgaHttpAdapterSecurityOptions, DgaHttpMethod, DgaInputRestriction, DgaLookupAdapter, DgaLookupRequest, DgaSubmitAdapter, DgaSubmitRequest, DgaToastVariant, DgaWizardConfig, ProvideDgaDynamicFormOptions };
+export { DGA_CAPTCHA_ADAPTER, DGA_DATE_RANGE_PAIRS, DGA_DYNAMIC_FORM_FIELD_REGISTRY, DGA_FORM_I18N_ADAPTER, DGA_FORM_TOAST_ADAPTER, DGA_HTTP_SECURITY, DGA_LOOKUP_ADAPTER, DGA_SUBMIT_ADAPTER, DgaDynamicForm, DgaDynamicFormField, DgaDynamicFormFieldRegistry, DgaDynamicFormService, createDgaToastAdapter, createHttpLookupAdapter, createHttpSubmitAdapter, defaultFormI18nAdapter, dgaApplyCrossFieldValidators, dgaAssertSafeHttpUrl, dgaBuildFormGroup, dgaBuildValidators, dgaCollectFields, dgaCreateControl, dgaDefaultValueForField, dgaDetectLocale, dgaFindSelectedOption, dgaIsFieldVisible, dgaIsRequiredWhen, dgaPasswordMatchValidator, dgaResolveLabel, dgaSaudiMobileValidator, dgaSetControlValidators, emptyLookupAdapter, noopCaptchaAdapter, provideDgaDynamicForm, resolveFormLabel };
+export type { DgaCaptchaAdapter, DgaDynamicFieldHostContext, DgaDynamicFieldRenderer, DgaDynamicFormConfig, DgaDynamicFormPayloadTransformer, DgaExistingAttachment, DgaFormField, DgaFormFieldColumns, DgaFormFieldOption, DgaFormFieldType, DgaFormI18nAdapter, DgaFormLabel, DgaFormLocale, DgaFormStep, DgaFormToastAdapter, DgaHttpAdapterSecurityOptions, DgaHttpMethod, DgaHttpSecurityOptions, DgaInputRestriction, DgaLookupAdapter, DgaLookupRequest, DgaStagedFileRef, DgaSubmitAdapter, DgaSubmitRequest, DgaToastVariant, DgaWizardConfig, ProvideDgaDynamicFormOptions };