commons-shared-web-ui 0.0.17 → 0.0.19

package/index.d.ts

@@ -1469,6 +1469,12 @@ interface FormSchema {
     sectionConfig?: SectionConfig;
     stepperConfig?: StepperConfig;
     submitConfig?: SubmitConfig;
+    /**
+     * Configures the action bar shown at the bottom of the form.
+     * Supports Cancel, Save as Draft, and Submit buttons with flexible layout.
+     * If omitted, the default Submit (and stepper Prev/Next) behaviour is unchanged.
+     */
+    actionBarConfig?: ActionBarConfig;
     showActions?: boolean;
     /** Full token string passed to all library API calls (e.g. "Bearer eyJ…") */
     token?: string;
@@ -1502,6 +1508,71 @@ interface SubmitConfig {
         showCloseButton?: boolean;
     };
 }
+/**
+ * Describes what happens when an action bar button is clicked.
+ * One ActionConfig shape works for every button.
+ */
+interface ActionConfig {
+    /**
+     * Action kind.
+     * 'submit'   -> Validates and submits form using submitConfig/editConfig.
+     * 'draft'    -> Saves form data without full validation.
+     * 'navigate' -> Navigates to redirectUrl.
+     * 'api'      -> Fires an API call then optionally navigates.
+     * 'emit'     -> Emits actionClick event for custom handling.
+     * 'next'     -> Advances to next step (stepper only).
+     * 'prev'     -> Goes back to previous step (stepper only).
+     */
+    kind: 'submit' | 'draft' | 'navigate' | 'api' | 'emit' | 'next' | 'prev';
+    /** URL for 'navigate' or 'api' callbacks. */
+    redirectUrl?: string;
+    /** API endpoint for 'api' actions. */
+    apiUrl?: string;
+    /** HTTP method for 'api' actions. @default 'POST' */
+    method?: 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    /** Static extra payload merged into 'api' or 'draft' requests. */
+    extraPayload?: {
+        [key: string]: any;
+    };
+    /** Snackbar messages for 'api' or 'submit'/'draft' actions. */
+    successMessage?: string;
+    errorMessage?: string;
+    snackbarConfig?: {
+        duration?: number;
+        horizontalPosition?: 'start' | 'center' | 'end' | 'left' | 'right';
+        verticalPosition?: 'top' | 'bottom';
+        showCloseButton?: boolean;
+    };
+}
+/**
+ * Button configuration focusing on visuals and layout.
+ * All logic is delegated to the 'action' property.
+ */
+interface ActionButtonConfig {
+    /** Unique identifier for the button. */
+    id: string;
+    /** Label (i18n key or text). */
+    label?: string;
+    /** Button style variant. */
+    variant?: ButtonVariant | string;
+    /** Bar alignment. @default 'right' */
+    alignment?: 'left' | 'right';
+    /** Display order (lower = first). */
+    order?: number;
+    /** Visibility. @default false */
+    hidden?: boolean;
+    /** State. @default false */
+    disabled?: boolean;
+    /** Action logic. */
+    action: ActionConfig;
+}
+/**
+ * Action bar configuration.
+ */
+interface ActionBarConfig {
+    /** Flexibly ordered list of action buttons. */
+    buttons: ActionButtonConfig[];
+}
 interface EditConfig {
     loadApiUrl: string;
     submitApiUrl: string;
@@ -1884,6 +1955,7 @@ declare class SmartFormComponent implements OnInit, OnChanges, OnDestroy {
     private expressionService;
     private http;
     private snackbarService;
+    private router;
     formJson: string;
     initialValues?: {
         [key: string]: any;
@@ -1900,13 +1972,25 @@ declare class SmartFormComponent implements OnInit, OnChanges, OnDestroy {
         [key: string]: any;
     }>;
     draftSave: EventEmitter<string>;
+    /**
+     * Emitted when a button with a custom `type` (not 'cancel', 'draft', or
+     * 'submit') is clicked. Payload contains the button `id` and the current
+     * form data snapshot.
+     */
+    actionClick: EventEmitter<{
+        id: string;
+        formData: {
+            [key: string]: any;
+        };
+    }>;
     formSchema: FormSchema;
     formGroup: FormGroup;
     fieldList: FieldConfig[];
     isStepper: boolean;
     currentStep: number;
     isLoading: boolean;
-    constructor(fb: FormBuilder, controller: SmartFormController, expressionService: ExpressionService, http: HttpClient, snackbarService: SnackbarService);
+    isDraftLoading: boolean;
+    constructor(fb: FormBuilder, controller: SmartFormController, expressionService: ExpressionService, http: HttpClient, snackbarService: SnackbarService, router: Router);
     ngOnInit(): void;
     loadEditData(): void;
     ngOnChanges(changes: SimpleChanges): void;
@@ -1915,6 +1999,12 @@ declare class SmartFormComponent implements OnInit, OnChanges, OnDestroy {
     initializeForm(): void;
     collectFields(fields: FieldConfig[]): void;
     handleSubmit(): void;
+    /**
+     * Universal action handler for any button click.
+     * One handler decides how to process based on action.kind.
+     */
+    handleButtonClick(btn: ActionButtonConfig): void;
+    private fireActionApiCall;
     /**
      * Constructs nested payload by checking field properties on form controls.
      */
@@ -1930,7 +2020,7 @@ declare class SmartFormComponent implements OnInit, OnChanges, OnDestroy {
     private extractGroupValue;
     validate(): boolean;
     scrollToFirstInvalidControl(): void;
-    submitToApi(formData: any): void;
+    submitToApi(formData: any, actionType?: 'submit' | 'draft', btn?: ActionButtonConfig): void;
     showAlert(type: 'success' | 'error' | 'warning' | 'info', message: string, customConfig?: any): void;
     /** Builds HttpHeaders from the token stored in the controller (sourced from configJSON). */
     getHeaders(): HttpHeaders;
@@ -1942,8 +2032,17 @@ declare class SmartFormComponent implements OnInit, OnChanges, OnDestroy {
     get nextLabel(): string;
     get submitLabel(): string;
     get previousLabel(): string;
+    get actionBarConfig(): ActionBarConfig | undefined;
+    /**
+     * Returns buttons for a given alignment, sorted by `order` (stable).
+     */
+    getButtonsForAlignment(alignment: 'left' | 'right'): ActionButtonConfig[];
+    getButtonLabel(btn: ActionButtonConfig): string;
+    isButtonDisabled(btn: ActionButtonConfig): boolean;
+    private getButtonByActionKind;
+    private navigateTo;
     static ɵfac: i0.ɵɵFactoryDeclaration<SmartFormComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SmartFormComponent, "lib-smart-form", never, { "formJson": { "alias": "formJson"; "required": false; }; "initialValues": { "alias": "initialValues"; "required": false; }; "enableDraftAutoSave": { "alias": "enableDraftAutoSave"; "required": false; }; "labels": { "alias": "labels"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; }, { "submit": "submit"; "draftSave": "draftSave"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SmartFormComponent, "lib-smart-form", never, { "formJson": { "alias": "formJson"; "required": false; }; "initialValues": { "alias": "initialValues"; "required": false; }; "enableDraftAutoSave": { "alias": "enableDraftAutoSave"; "required": false; }; "labels": { "alias": "labels"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; }, { "submit": "submit"; "draftSave": "draftSave"; "actionClick": "actionClick"; }, never, never, false, never>;
 }
 
 declare class FormSectionComponent implements OnInit, OnDestroy {
@@ -2278,6 +2377,10 @@ declare class SideNavComponent implements OnChanges {
     showTooltips: boolean;
     /** Position of the tooltip */
     tooltipPosition: TooltipPosition;
+    /** Optional dictionary for label translation */
+    labels?: {
+        [key: string]: string;
+    };
     itemClicked: EventEmitter<SideNavItem>;
     /** Emits whenever the collapsed state changes (supports two-way binding via [(collapsed)]) */
     collapsedChange: EventEmitter<boolean>;
@@ -2285,14 +2388,14 @@ declare class SideNavComponent implements OnChanges {
     get isHostCollapsed(): boolean;
     filteredSections: SideNavSection[];
     ngOnChanges(changes: SimpleChanges): void;
-    private filterSections;
+    private filterAndMapSections;
     onItemClick(item: SideNavItem, event: Event): void;
     toggleCollapse(): void;
     get customStyles(): {
         [key: string]: string;
     };
     static ɵfac: i0.ɵɵFactoryDeclaration<SideNavComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SideNavComponent, "lib-side-nav", never, { "sections": { "alias": "sections"; "required": false; }; "userRoles": { "alias": "userRoles"; "required": false; }; "activeId": { "alias": "activeId"; "required": false; }; "styleConfig": { "alias": "styleConfig"; "required": false; }; "collapsed": { "alias": "collapsed"; "required": false; }; "width": { "alias": "width"; "required": false; }; "collapsedWidth": { "alias": "collapsedWidth"; "required": false; }; "showCollapseToggle": { "alias": "showCollapseToggle"; "required": false; }; "hideIconsWhenExpanded": { "alias": "hideIconsWhenExpanded"; "required": false; }; "showTooltips": { "alias": "showTooltips"; "required": false; }; "tooltipPosition": { "alias": "tooltipPosition"; "required": false; }; }, { "itemClicked": "itemClicked"; "collapsedChange": "collapsedChange"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SideNavComponent, "lib-side-nav", never, { "sections": { "alias": "sections"; "required": false; }; "userRoles": { "alias": "userRoles"; "required": false; }; "activeId": { "alias": "activeId"; "required": false; }; "styleConfig": { "alias": "styleConfig"; "required": false; }; "collapsed": { "alias": "collapsed"; "required": false; }; "width": { "alias": "width"; "required": false; }; "collapsedWidth": { "alias": "collapsedWidth"; "required": false; }; "showCollapseToggle": { "alias": "showCollapseToggle"; "required": false; }; "hideIconsWhenExpanded": { "alias": "hideIconsWhenExpanded"; "required": false; }; "showTooltips": { "alias": "showTooltips"; "required": false; }; "tooltipPosition": { "alias": "tooltipPosition"; "required": false; }; "labels": { "alias": "labels"; "required": false; }; }, { "itemClicked": "itemClicked"; "collapsedChange": "collapsedChange"; }, never, never, false, never>;
 }
 
 declare class SideNavModule {
@@ -2497,6 +2600,8 @@ interface TableFilter {
     type: 'select' | 'text' | 'date';
     options?: TableOption[];
     apiUrl?: string;
+    apiMethod?: 'GET' | 'POST';
+    apiPayload?: any;
     labelKey?: string;
     valueKey?: string;
     labelPath?: string;
@@ -2563,6 +2668,8 @@ interface QueryParamsConfig {
 interface TableConfig {
     columns: TableColumn[];
     apiUrl: string;
+    apiMethod?: 'GET' | 'POST';
+    apiPayload?: any;
     dataResponsePath?: string;
     filters?: TableFilter[];
     filterData?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commons-shared-web-ui",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "peerDependencies": {
     "@angular/animations": "20.3.15",
     "@angular/cdk": "20.2.14",