@masterteam/forms 0.0.51 → 0.0.53

package/types/masterteam-forms-client-form.d.ts

@@ -23,13 +23,30 @@ type ProcessFormMode = 'Approval' | 'Direct';
 type ProcessFormSubmitStatus = 'PendingApproval' | 'Executed';
 type OperationType = 'FormOperation' | 'ActionOperation';
 type ProcessFormSource = 'Step' | 'None';
+type ClientFormResolvedRenderMode = 'form' | 'steps' | 'tabs';
+type ClientFormFooterActionMode = 'loading' | 'steps' | 'submit';
+interface ClientFormFooterState {
+    loading: boolean;
+    isLoaded: boolean;
+    renderMode: ClientFormResolvedRenderMode;
+    actionMode: ClientFormFooterActionMode;
+    stepNavigationEnabled: boolean;
+    sectionNavigationEnabled: boolean;
+    currentStep: number;
+    stepCount: number;
+    canGoToPreviousStep: boolean;
+    canGoToNextStep: boolean;
+    showPreviousStep: boolean;
+    showNextStep: boolean;
+    showSubmit: boolean;
+}
 interface ProcessFormLoadRequest {
     moduleKey: string;
     operationKey: string;
-    moduleId?: number;
-    levelId?: number;
-    levelDataId?: number;
-    moduleDataId?: number;
+    moduleId?: number | string;
+    levelId?: number | string;
+    levelDataId?: number | string;
+    moduleDataId?: number | string;
     requestSchemaId?: number;
     draftProcessId?: number;
     preview?: boolean;
@@ -50,15 +67,20 @@ interface ProcessFormLoadResponse {
 interface ProcessFormSubmitRequest {
     moduleKey: string;
     operationKey: string;
-    moduleId?: number;
-    levelId?: number;
-    levelDataId?: number;
-    moduleDataId?: number;
-    recordId?: number;
+    moduleId?: number | string;
+    levelId?: number | string;
+    levelDataId?: number | string;
+    moduleDataId?: number | string;
+    recordId?: number | string;
     requestSchemaId?: number;
     returnUrl?: string;
     fields: ProcessFormSubmitField[];
 }
+interface ClientFormSubmitRequestMapperContext {
+    formValue: Record<string, any>;
+    loadResponse: ProcessFormLoadResponse;
+}
+type ClientFormSubmitRequestMapper = (request: ProcessFormSubmitRequest, context: ClientFormSubmitRequestMapperContext) => ProcessFormSubmitRequest;
 interface ProcessFormSubmitField {
     requestPropertyId?: number;
     propertyKey: string;
@@ -157,6 +179,7 @@ interface ClientFormField {
 interface ClientPropertyItem {
     key: string;
     propertyId?: number;
+    isCalculated?: boolean;
     name: string | {
         display?: string;
         en?: string;
@@ -266,13 +289,26 @@ declare class ClientFormStateService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<ClientFormStateService>;
 }
 
+type StepTimelineState = 'completed' | 'current' | 'upcoming';
+interface StepTimelineItem {
+    key: string;
+    label: string;
+    value: number;
+    state: StepTimelineState;
+    selected: boolean;
+    beforeLineActive: boolean;
+    afterLineActive: boolean;
+}
 /**
  * Client Form — Runtime process form component.
  *
  * Self-contained, signal-based (no NGXS). Each instance manages its own state
  * via a component-scoped `ClientFormStateService`.
  *
- * **No action buttons in template.** Parent controls all actions via `viewChild()`:
+ * Submit and reset actions stay external. Step navigation buttons are optional
+ * and can be hidden with `showInternalStepActions`.
+ *
+ * Parent can control actions via `viewChild()`:
  *
  * ```html
  * <mt-client-form #processForm [moduleKey]="'Risk'" [operationKey]="'CloseRisk'" />
@@ -292,7 +328,9 @@ declare class ClientForm implements OnDestroy {
     protected readonly state: ClientFormStateService;
     private loadSub?;
     private submitSub?;
+    private readonly hasStartedLoad;
     readonly runtimeMessages: _angular_core.WritableSignal<FormulaRuntimeMessage[]>;
+    private readonly translocoService;
     readonly submitting: _angular_core.Signal<boolean>;
     readonly submitError: _angular_core.Signal<string | null>;
     readonly isSubmitted: _angular_core.Signal<boolean>;
@@ -305,27 +343,30 @@ declare class ClientForm implements OnDestroy {
     readonly currentStep: _angular_core.WritableSignal<number>;
     readonly moduleKey: _angular_core.InputSignal<string>;
     readonly operationKey: _angular_core.InputSignal<string>;
-    readonly moduleId: _angular_core.InputSignal<number | undefined>;
-    readonly levelId: _angular_core.InputSignal<number | undefined>;
-    readonly levelDataId: _angular_core.InputSignal<number | undefined>;
-    readonly moduleDataId: _angular_core.InputSignal<number | undefined>;
+    readonly moduleId: _angular_core.InputSignal<string | number | undefined>;
+    readonly levelId: _angular_core.InputSignal<string | number | undefined>;
+    readonly levelDataId: _angular_core.InputSignal<string | number | undefined>;
+    readonly moduleDataId: _angular_core.InputSignal<string | number | undefined>;
     readonly requestSchemaId: _angular_core.InputSignal<number | undefined>;
     readonly draftProcessId: _angular_core.InputSignal<number | undefined>;
     readonly preview: _angular_core.InputSignal<boolean>;
     readonly returnUrl: _angular_core.InputSignal<string | undefined>;
+    readonly submitRequestMapper: _angular_core.InputSignal<ClientFormSubmitRequestMapper | null>;
     readonly readonly: _angular_core.InputSignal<boolean>;
     readonly autoLoad: _angular_core.InputSignal<boolean>;
     readonly formMode: _angular_core.InputSignal<"create" | "edit">;
-    readonly renderMode: _angular_core.InputSignal<"steps" | "tabs" | "form" | undefined>;
+    readonly renderMode: _angular_core.InputSignal<"form" | "steps" | "tabs" | undefined>;
     readonly showInternalStepActions: _angular_core.InputSignal<boolean>;
-    readonly lang: _angular_core.InputSignal<"en" | "ar">;
+    readonly lang: _angular_core.WritableSignal<"en" | "ar">;
     readonly lookups: _angular_core.InputSignal<ClientLookup[]>;
     readonly ignoredFieldKeys: _angular_core.InputSignal<string[]>;
+    readonly rtl: _angular_core.Signal<boolean>;
     readonly loaded: _angular_core.OutputEmitterRef<ProcessFormLoadResponse>;
     readonly submitted: _angular_core.OutputEmitterRef<ProcessFormSubmitResponse>;
     readonly errored: _angular_core.OutputEmitterRef<string>;
     readonly modeDetected: _angular_core.OutputEmitterRef<ProcessFormMode>;
     readonly formSourceDetected: _angular_core.OutputEmitterRef<ProcessFormSource>;
+    readonly footerStateChanged: _angular_core.OutputEmitterRef<ClientFormFooterState>;
     readonly formControl: FormControl<Record<string, any> | null>;
     readonly formConfig: _angular_core.Signal<DynamicFormConfig | null>;
     readonly initialValues: _angular_core.Signal<Record<string, any>>;
@@ -336,14 +377,17 @@ declare class ClientForm implements OnDestroy {
     readonly editableFormConfig: _angular_core.Signal<DynamicFormConfig | null>;
     readonly stepSections: _angular_core.Signal<_masterteam_components.SectionConfig[]>;
     readonly hasEditableFormSections: _angular_core.Signal<boolean>;
-    readonly effectiveRenderMode: _angular_core.Signal<"steps" | "tabs" | "form">;
+    readonly effectiveRenderMode: _angular_core.Signal<"form" | "steps" | "tabs">;
     readonly stepsEnabled: _angular_core.Signal<boolean>;
     readonly tabsEnabled: _angular_core.Signal<boolean>;
     readonly sectionNavigationEnabled: _angular_core.Signal<boolean>;
     readonly tabOptions: _angular_core.Signal<OptionItem[]>;
+    readonly stepTimeline: _angular_core.Signal<StepTimelineItem[]>;
     readonly visibleSectionKeys: _angular_core.Signal<string[] | null>;
     readonly forcedHiddenFieldKeys: _angular_core.Signal<string[]>;
     readonly effectiveForcedHiddenFieldKeys: _angular_core.Signal<string[]>;
+    readonly footerLoading: _angular_core.Signal<boolean>;
+    readonly footerState: _angular_core.Signal<ClientFormFooterState>;
     constructor();
     /**
      * Load form configuration from the API.
@@ -384,11 +428,16 @@ declare class ClientForm implements OnDestroy {
     getCurrentStep(): number;
     getStepCount(): number;
     isStepNavigationEnabled(): boolean;
+    isSectionNavigationEnabled(): boolean;
+    isFooterLoading(): boolean;
+    getResolvedRenderMode(): ClientFormResolvedRenderMode;
+    getFooterState(): ClientFormFooterState;
     ngOnDestroy(): void;
     private buildLoadRequest;
     private buildSubmitRequest;
+    private resolveStepTimelineState;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ClientForm, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ClientForm, "mt-client-form", never, { "moduleKey": { "alias": "moduleKey"; "required": true; "isSignal": true; }; "operationKey": { "alias": "operationKey"; "required": true; "isSignal": true; }; "moduleId": { "alias": "moduleId"; "required": false; "isSignal": true; }; "levelId": { "alias": "levelId"; "required": false; "isSignal": true; }; "levelDataId": { "alias": "levelDataId"; "required": false; "isSignal": true; }; "moduleDataId": { "alias": "moduleDataId"; "required": false; "isSignal": true; }; "requestSchemaId": { "alias": "requestSchemaId"; "required": false; "isSignal": true; }; "draftProcessId": { "alias": "draftProcessId"; "required": false; "isSignal": true; }; "preview": { "alias": "preview"; "required": false; "isSignal": true; }; "returnUrl": { "alias": "returnUrl"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "autoLoad": { "alias": "autoLoad"; "required": false; "isSignal": true; }; "formMode": { "alias": "formMode"; "required": false; "isSignal": true; }; "renderMode": { "alias": "renderMode"; "required": false; "isSignal": true; }; "showInternalStepActions": { "alias": "showInternalStepActions"; "required": false; "isSignal": true; }; "lang": { "alias": "lang"; "required": false; "isSignal": true; }; "lookups": { "alias": "lookups"; "required": false; "isSignal": true; }; "ignoredFieldKeys": { "alias": "ignoredFieldKeys"; "required": false; "isSignal": true; }; }, { "loaded": "loaded"; "submitted": "submitted"; "errored": "errored"; "modeDetected": "modeDetected"; "formSourceDetected": "formSourceDetected"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ClientForm, "mt-client-form", never, { "moduleKey": { "alias": "moduleKey"; "required": true; "isSignal": true; }; "operationKey": { "alias": "operationKey"; "required": true; "isSignal": true; }; "moduleId": { "alias": "moduleId"; "required": false; "isSignal": true; }; "levelId": { "alias": "levelId"; "required": false; "isSignal": true; }; "levelDataId": { "alias": "levelDataId"; "required": false; "isSignal": true; }; "moduleDataId": { "alias": "moduleDataId"; "required": false; "isSignal": true; }; "requestSchemaId": { "alias": "requestSchemaId"; "required": false; "isSignal": true; }; "draftProcessId": { "alias": "draftProcessId"; "required": false; "isSignal": true; }; "preview": { "alias": "preview"; "required": false; "isSignal": true; }; "returnUrl": { "alias": "returnUrl"; "required": false; "isSignal": true; }; "submitRequestMapper": { "alias": "submitRequestMapper"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "autoLoad": { "alias": "autoLoad"; "required": false; "isSignal": true; }; "formMode": { "alias": "formMode"; "required": false; "isSignal": true; }; "renderMode": { "alias": "renderMode"; "required": false; "isSignal": true; }; "showInternalStepActions": { "alias": "showInternalStepActions"; "required": false; "isSignal": true; }; "lookups": { "alias": "lookups"; "required": false; "isSignal": true; }; "ignoredFieldKeys": { "alias": "ignoredFieldKeys"; "required": false; "isSignal": true; }; }, { "loaded": "loaded"; "submitted": "submitted"; "errored": "errored"; "modeDetected": "modeDetected"; "formSourceDetected": "formSourceDetected"; "footerStateChanged": "footerStateChanged"; }, never, never, true, never>;
 }
 
 /**
@@ -421,7 +470,7 @@ declare class ClientFormApiService {
  * @param mode     'create' or 'edit' — filters hidden fields accordingly
  * @param lookups  Available lookup definitions for resolving Lookup/LookupMultiSelect options
  */
-declare function mapToDynamicFormConfig(config: ClientFormConfiguration, lang?: 'en' | 'ar', mode?: 'create' | 'edit', lookups?: ClientLookup[]): DynamicFormConfig;
+declare function mapToDynamicFormConfig(config: ClientFormConfiguration, lang?: 'en' | 'ar', mode?: 'create' | 'edit', lookups?: ClientLookup[], context?: ProcessFormContext | null): DynamicFormConfig;
 /**
  * Convert API property values into a flat key-value object
  * suitable for `formControl.patchValue()`.
@@ -440,4 +489,4 @@ declare function getPreviewOnlyFieldKeys(config: ClientFormConfiguration, mode?:
 declare function mapPreviewFieldsToEntities(config: ClientFormConfiguration, values: ProcessFormValue[], mode?: 'create' | 'edit'): EntityData[];
 
 export { ClientForm, ClientFormApiService, ClientFormStateService, getPreviewOnlyFieldKeys, isFormRequiredInterception, mapFormValueToSubmitFields, mapPreviewFieldsToEntities, mapToDynamicFormConfig, mapValuesToFormValue };
-export type { ClientFieldWidth, ClientFormConfiguration, ClientFormField, ClientFormRenderMode, ClientFormSection, ClientLookup, ClientLookupItem, ClientPropertyItem, ClientValidationRule, FormRequiredInterception, OperationType, ProcessFormContext, ProcessFormLoadRequest, ProcessFormLoadResponse, ProcessFormMode, ProcessFormSource, ProcessFormSubmitField, ProcessFormSubmitRecord, ProcessFormSubmitRecordField, ProcessFormSubmitRequest, ProcessFormSubmitResponse, ProcessFormSubmitStatus, ProcessFormSubmitValue, ProcessFormValue, ProcessFormValueMetadata, Response };
+export type { ClientFieldWidth, ClientFormConfiguration, ClientFormField, ClientFormFooterActionMode, ClientFormFooterState, ClientFormRenderMode, ClientFormResolvedRenderMode, ClientFormSection, ClientFormSubmitRequestMapper, ClientFormSubmitRequestMapperContext, ClientLookup, ClientLookupItem, ClientPropertyItem, ClientValidationRule, FormRequiredInterception, OperationType, ProcessFormContext, ProcessFormLoadRequest, ProcessFormLoadResponse, ProcessFormMode, ProcessFormSource, ProcessFormSubmitField, ProcessFormSubmitRecord, ProcessFormSubmitRecordField, ProcessFormSubmitRequest, ProcessFormSubmitResponse, ProcessFormSubmitStatus, ProcessFormSubmitValue, ProcessFormValue, ProcessFormValueMetadata, Response };