@nexterajs/app-kit 0.0.1

package/types/nexterajs-app-kit.d.ts

@@ -0,0 +1,690 @@
+import * as i0 from '@angular/core';
+import { ComponentRef, Signal, PipeTransform, AfterViewInit, ElementRef, Renderer2, TemplateRef, ViewContainerRef, Type } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { Overlay } from '@angular/cdk/overlay';
+import { Observable } from 'rxjs';
+
+interface Paging {
+    pageNo: number;
+    pageSize: number;
+    totalRows: number;
+    totalPages: number;
+}
+interface NxeGridItem {
+    id: string;
+    label: string;
+    dataType?: string;
+    lov?: string;
+    lovDependency?: LovDependency | LovDependency[];
+    pushToRight?: boolean;
+    filterCount?: number;
+    groupIndex?: number;
+    valueExpr?: string;
+    displayExpr?: string;
+    readonly?: boolean;
+    hidden?: boolean;
+    min?: number;
+    max?: number;
+    alignment?: string;
+    readonlyOnCreate?: boolean;
+    readonlyOnModify?: boolean;
+    readonlyCondition?: Condition;
+    hiddenOnCreate?: boolean;
+    hiddenOnModify?: boolean;
+    hiddenOnGrid?: boolean;
+    hiddenCondition?: Condition;
+    shownVariable?: string;
+    link?: LinkDetail;
+    formattedLink?: string;
+    defaultValue?: any;
+    fixedValue?: any;
+    defaultValueDynamic?: {
+        from: string;
+        propertyCode: string;
+    };
+    required?: boolean;
+    gridItems?: NxeGridItem[];
+    gridConfig?: {
+        detailID: string;
+        inlineEditing?: boolean;
+        editable: boolean;
+        deletable: boolean;
+        isPrimaryHeader?: boolean;
+    };
+    dynamicField?: {
+        sourceID: string;
+        sourceTypeKey: string;
+        sourceLovKey: string;
+    };
+    width?: any;
+    format?: string;
+    hiddenConditions?: Condition;
+    onValueChange?: ValueChange[];
+}
+interface LovDependency {
+    dependentTo: string;
+    filterKey: string;
+    preFilter?: boolean;
+}
+interface ValueChange {
+    event?: string;
+    target?: string;
+    value?: any;
+}
+declare class ValueChangeEvent {
+    static readonly ADD_DAYS = "ADD_DAYS";
+    static readonly ADD_MONTHS = "ADD_MONTHS";
+    static readonly ADD_YEARS = "ADD_YEARS";
+    static readonly GET_DEFAULT_VALUE_REINS = "GET_DEFAULT_VALUE_REINS";
+}
+interface ModeState {
+    onCreate: boolean;
+    onModify: boolean;
+}
+interface LinkDetail {
+    url: string;
+    id: string;
+    target?: string;
+}
+interface NxeLayoutItem {
+    id?: string;
+    layoutType?: string;
+    label?: string;
+    className?: string;
+    gridItem?: NxeGridItem;
+    children?: NxeLayoutItem[];
+    gridColumn?: number;
+}
+declare class LayoutType {
+    static readonly DIVIDER = "DIVIDER";
+    static readonly CONTAINER = "CONTAINER";
+    static readonly GRID_ITEM = "GRID_ITEM";
+    static readonly GRID_CONTAINER = "GRID_CONTAINER";
+}
+
+interface ModuleMetadata {
+    section: string;
+    icon: string;
+    entityType: string;
+    accessRight: string;
+    packageCode?: string;
+    webBaseUrl: string;
+    apiBaseUrl: string;
+    apiBaseUrlModifier?: string;
+    uploadUrl: string;
+    id: string;
+    lov: string;
+    lovMapper?: any;
+    isTableMaintenance?: boolean;
+    usePopup?: boolean;
+    listPage?: ListPageMetadata;
+    createPage?: {
+        forms: NxeLayoutItem[];
+    };
+    upsertPage?: UpsertPageMetadata;
+    detailPage?: UpsertPageMetadata;
+}
+interface ListPageMetadata {
+    create: boolean | any;
+    hasSearchBox?: boolean;
+    hasUploadButton?: boolean;
+    selectable?: boolean;
+    actions?: {
+        actionItems: ActionItem[];
+        gridItems?: NxeGridItem[];
+    };
+    tree?: {
+        keyExpr: string;
+        parentIdExpr: string;
+        autoExpandAll: boolean;
+    };
+    filters: NxeGridItem[];
+    gridItems: NxeGridItem[];
+    masterDetail?: {
+        apiUrl: string;
+        gridItems: NxeGridItem[];
+    };
+    summary?: any;
+}
+interface UpsertPageMetadata {
+    subheaders: NxeGridItem[];
+    hasApproval?: boolean;
+    isInlineModify?: boolean;
+    actions?: {
+        actionItems: ActionItem[];
+        gridItems?: NxeGridItem[];
+    };
+    forms: NxeLayoutItem[];
+    tabHeaderLabel?: string;
+    tabContentLabel?: string;
+    tabs?: {
+        label: string;
+        component: any;
+        componentRef?: ComponentRef<any>;
+        hiddenConditions?: Condition;
+    }[];
+}
+interface ActionItem {
+    actionCode: string;
+    overrideActionCode?: string;
+    overrideUrl?: string;
+    redirectAfterSuccessful?: string;
+    disabledConditions?: ActionItemDisabledOn[];
+}
+interface ActionItemDisabledOn {
+    key: string;
+    operator: string;
+    value: any;
+}
+declare class BooleanOperator {
+    static readonly NOT_INCLUDE = "NIN";
+    static readonly INCLUDE = "IN";
+    static readonly EQUALS = "=";
+    static readonly NOT_EQUAL = "!=";
+}
+declare class ValueOperator {
+    static readonly NOT_INCLUDE = "NIN";
+    static readonly INCLUDE = "IN";
+    static readonly EQUALS = "=";
+    static readonly NOT_EQUAL = "!=";
+}
+declare class ConditionType {
+    static readonly GROUP = "GROUP";
+    static readonly SINGLE = "SINGLE";
+}
+declare class ConditionOperator {
+    static readonly AND = "AND";
+    static readonly OR = "OR";
+}
+interface Condition {
+    type: string;
+    children?: Condition[];
+    groupOperator?: string;
+    key?: string;
+    valueOperator?: string;
+    value?: any;
+}
+declare class ConditionEvaluator {
+    static evaluate(data: Record<string, any>, condition: Condition): boolean;
+    private static evaluateSingle;
+    private static evaluateGroup;
+}
+
+interface RequestAction {
+    action: string;
+    id1: string;
+    id2: string;
+    id3: string;
+    param0?: string;
+    param1: string;
+    param2: string;
+    param3: string;
+    param4: string;
+    param5: string;
+    notes: string;
+    processBy: string;
+}
+interface ActionConfig {
+    url?: string;
+    actionCode: string;
+    id?: string;
+    id1?: string;
+    id2?: string;
+    id3?: string;
+    processBy?: string;
+    section?: string;
+    subsection?: string;
+    text?: string;
+    btnYesText?: string;
+    btnNoText?: string;
+    lov?: any;
+    accessRight?: any;
+    disableToast?: boolean;
+    notes?: string;
+    metadata?: ModuleMetadata;
+}
+
+interface Lov {
+    defaultValue: string;
+    isActive: string;
+    lovCode: any;
+    lovName: string;
+    lovType: string;
+    otherValue1: string;
+    otherValue2: string;
+    otherValue3: string;
+    otherValue4: string;
+    otherValue5: string;
+    sequenceNo: number;
+}
+type StringArrayMap<T extends readonly string[]> = {
+    [K in T[number]]?: string[];
+};
+declare class MappedLov<T extends readonly string[]> {
+    private map;
+    constructor(initial?: StringArrayMap<T>);
+    get<K extends T[number]>(key: K): string[];
+    set<K extends T[number]>(key: K, value: string[]): void;
+    has<K extends T[number]>(key: K): boolean;
+    getRawMap(): Required<{
+        [K in T[number]]: string[];
+    }>;
+    constructorKeys: T;
+    get keys(): T[number][];
+}
+
+interface NxeResponse<T> {
+    data: T;
+    paging: any;
+    message: string;
+    returnCode: string;
+}
+
+declare class DataType {
+    static readonly TXT = "TXT";
+    static readonly TXM = "TXM";
+    static readonly NUM = "NUM";
+    static readonly DTE = "DTE";
+    static readonly LNK = "LNK";
+    static readonly TXA = "TXA";
+    static readonly ACT = "ACT";
+    static readonly LOV = "LOV";
+    static readonly LOM = "LOM";
+    static readonly CHK = "CHK";
+    static readonly HTM = "HTM";
+    static readonly GRD = "GRD";
+    static readonly IMG = "IMG";
+    static readonly DRD = "DRD";
+    static readonly DYN = "DYN";
+}
+
+declare class ActionCode {
+    static readonly LIST = "LST";
+    static readonly VIEW = "VIE";
+    static readonly CREATE = "CRT";
+    static readonly VALIDATE = "VAL";
+    static readonly FINALIZE = "FIN";
+    static readonly APPROVAL = "APP";
+    static readonly MODIFY = "MOD";
+    static readonly DELETE = "DEL";
+    static readonly CANCEL = "CAN";
+    static readonly EXTEND_DUE_DATE = "EXD";
+    static readonly CONFIRM = "CON";
+    static readonly BINDING = "BIN";
+    static readonly REVERSE = "REV";
+    static readonly CALCULATE = "CAL";
+    static readonly SEND_FOR_APPROVAL = "STA";
+    static readonly PLACEMENT = "PLA";
+    static readonly DIVIDER = "divider";
+    static readonly RUN = "RUN";
+    static readonly ACTIVATED = "ACT";
+    static readonly TERMINATED = "TRM";
+    static readonly RESET_PASS = "RST";
+    static readonly LOCK = "LOC";
+    static readonly UNLOCK = "UNL";
+    static readonly POSTING = "POS";
+    static readonly UNPOSTING = "UNP";
+    static readonly EXTRACT = "EXT";
+    static readonly BIND = "BND";
+    static readonly NEW = "NEW";
+    static readonly ADD_SUB_TREATY = "ADD_SUB_TREATY";
+    static readonly CORRECTION = "COR";
+    static readonly CONVERT_TO_PROPOSAL = "PRO";
+    static readonly DOWNLOAD = "PRV";
+    static readonly SEND = "SND";
+    static readonly ISSUE = "ISS";
+    static readonly REACTIVATE = "RAC";
+    static readonly PRINT = "PRT";
+    static readonly TERMINATE = "TRM";
+    static readonly ADD_TO_PAYMENT = "ADD_TO_PAYMENT";
+    static readonly ROLLBACK = "ROL";
+}
+declare const ACTION_MAPPER: {
+    CRT: typeof getActionNew;
+    VIE: typeof getActionView;
+    MOD: typeof getActionModify;
+    DEL: typeof getActionDelete;
+    VAL: typeof getActionValidate;
+    EXT: typeof getActionExtract;
+    ADD_TO_PAYMENT: typeof getActionAddToPayment;
+    ACT: typeof getActionActivated;
+    TRM: typeof getActionTerminate;
+    RST: typeof getActionResetPassword;
+    LOC: typeof getActionLock;
+    UNL: typeof getActionUnlock;
+};
+declare function getActionView(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionRollback(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionNew(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionSend(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionAddSubTreaty(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionCorrection(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionConvertToProposal(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionBind(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionPosting(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionExtract(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionUnposting(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionRun(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionValidate(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionAddToPayment(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionIssue(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionReactivate(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionDownload(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionFinalize(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionSendForApproval(disabled?: boolean, text?: string): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionPlacement(disabled?: boolean, text?: string): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionCalculate(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionConfirm(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionBinding(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionReverse(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionDelete(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionCancel(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionExtendDueDate(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionApproval(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionPrint(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionDivider(): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionModify(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionActivated(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionTerminated(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionResetPassword(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionLock(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionUnlock(disabled?: boolean): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+declare function getActionTerminate(disabled?: boolean, text?: string): {
+    value: string;
+    text: string;
+    icon: string;
+    disabled: boolean;
+};
+
+declare class PageMode {
+    static readonly VIEW = "View";
+    static readonly MODIFY = "Modify";
+    static readonly ADD = "New";
+}
+
+declare function extractGridItems(layoutItems: NxeLayoutItem[], existingGridItems?: NxeGridItem[]): NxeGridItem[];
+declare function createFormGroup(gridItems: any[], module: ModuleMetadata, lov: any): FormGroup;
+
+declare function removeEmptyObject(obj: object): object;
+declare function filterQueryParams(obj: Object): {};
+declare function arrayToString(input: string[]): string;
+declare function downloadFile(data: any, fileName?: string): void;
+declare function previewPDF(data: any, fileName?: string): void;
+declare function constructUrlWithQueryParams(baseUrl: string, queryParams: any): string;
+declare function toDateString(date: Date): string;
+
+declare function mapLov(input: any, lov: Lov[]): any;
+declare function mapOriginalLov(lov: Lov[]): any;
+
+declare class ModeSignalHelper {
+    isView: Signal<boolean>;
+    isModify: Signal<boolean>;
+    isAdd: Signal<boolean>;
+    constructor(mode: Signal<string>);
+    /**
+     * Generates computed signals for the provided mode signal.
+     */
+    static createModeSignals(mode: Signal<string>): {
+        isView: Signal<boolean>;
+        isModify: Signal<boolean>;
+        isAdd: Signal<boolean>;
+    };
+}
+
+declare function sortSequence(a: any, b: any): 0 | 1 | -1;
+
+declare function trackChanges(oldArray: any[], newArray: any[], keysToCompare: string[], idKey: string): any[];
+
+declare class ActionCodePipe implements PipeTransform {
+    actionMapper: any;
+    transform(value: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ActionCodePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<ActionCodePipe, "actionCode", true>;
+}
+
+declare class NullPipe implements PipeTransform {
+    transform(value: unknown): unknown;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NullPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<NullPipe, "null", true>;
+}
+
+declare class BadgeDirective implements AfterViewInit {
+    private el;
+    private renderer;
+    nxeBadge: string | number;
+    badgeColor: string;
+    badgePosition: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
+    private badgeElement;
+    constructor(el: ElementRef, renderer: Renderer2);
+    ngOnChanges(): void;
+    private updateBadge;
+    private applyPosition;
+    ngAfterViewInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BadgeDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<BadgeDirective, "[nxeBadge]", never, { "nxeBadge": { "alias": "nxeBadge"; "required": false; }; "badgeColor": { "alias": "badgeColor"; "required": false; }; "badgePosition": { "alias": "badgePosition"; "required": false; }; }, {}, never, never, true, never>;
+}
+
+declare class NxeMenu {
+    private el;
+    private overlay;
+    private viewContainerRef;
+    menuTemplate: TemplateRef<any>;
+    private overlayRef;
+    constructor(el: ElementRef, overlay: Overlay, viewContainerRef: ViewContainerRef);
+    toggleMenu(event: Event): void;
+    onClickOutside(event: Event): void;
+    private openMenu;
+    private closeMenu;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NxeMenu, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NxeMenu, "[nxeMenu]", never, { "menuTemplate": { "alias": "nxeMenu"; "required": false; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * Opens a component in a centred, click-to-dismiss backdrop and resolves when it closes.
+ *
+ * Ported from nextera-library with one required change: `ComponentFactoryResolver` and
+ * `resolveComponentFactory()` are Ivy-era shims that no longer exist in Angular 22, so
+ * instantiation goes through `createComponent()` instead. The behaviour is the same —
+ * the component is created outside any view, attached to the ApplicationRef so it takes
+ * part in change detection, and appended to the backdrop element.
+ *
+ * `data` is assigned onto the instance before the view is attached, so the component sees
+ * its inputs on first render rather than one cycle late.
+ */
+declare class NxeModalService {
+    private readonly injector;
+    private readonly environmentInjector;
+    private readonly applicationRef;
+    private readonly renderer;
+    private componentRef?;
+    private backdropElement?;
+    private closeSubject?;
+    open<T>(component: Type<T>, data?: Record<string, unknown>): Observable<unknown>;
+    close(result?: unknown): void;
+    private createBackdrop;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NxeModalService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NxeModalService>;
+}
+
+export { ACTION_MAPPER, ActionCode, ActionCodePipe, BadgeDirective, BooleanOperator, ConditionEvaluator, ConditionOperator, ConditionType, DataType, LayoutType, MappedLov, ModeSignalHelper, NullPipe, NxeMenu, NxeModalService, PageMode, ValueChangeEvent, ValueOperator, arrayToString, constructUrlWithQueryParams, createFormGroup, downloadFile, extractGridItems, filterQueryParams, getActionActivated, getActionAddSubTreaty, getActionAddToPayment, getActionApproval, getActionBind, getActionBinding, getActionCalculate, getActionCancel, getActionConfirm, getActionConvertToProposal, getActionCorrection, getActionDelete, getActionDivider, getActionDownload, getActionExtendDueDate, getActionExtract, getActionFinalize, getActionIssue, getActionLock, getActionModify, getActionNew, getActionPlacement, getActionPosting, getActionPrint, getActionReactivate, getActionResetPassword, getActionReverse, getActionRollback, getActionRun, getActionSend, getActionSendForApproval, getActionTerminate, getActionTerminated, getActionUnlock, getActionUnposting, getActionValidate, getActionView, mapLov, mapOriginalLov, previewPDF, removeEmptyObject, sortSequence, toDateString, trackChanges };
+export type { ActionConfig, ActionItem, ActionItemDisabledOn, Condition, LinkDetail, ListPageMetadata, Lov, LovDependency, ModeState, ModuleMetadata, NxeGridItem, NxeLayoutItem, NxeResponse, Paging, RequestAction, UpsertPageMetadata, ValueChange };