@isettingkit/business-rules 2.2.14 → 2.2.16

package/dist/index.es.d.ts

@@ -1,5 +1,5 @@
 import { IButton } from '@inubekit/inubekit';
-import { ICondition } from '@isettingkit/input';
+import { ICondition as ICondition_2 } from '@isettingkit/input';
 import { IDecision } from '@isettingkit/input';
 import { IOption } from '@inubekit/inubekit';
 import { IRuleDecision } from '@isettingkit/input';
@@ -80,7 +80,7 @@ export declare const formatDecisionForBackend: (props: {
     businessRuleId?: string;
     conditionDataType?: ValueDataType[keyof ValueDataType];
     conditionName?: string;
-    conditionGroups?: ICondition[];
+    conditionGroups?: ICondition_2[];
     decision?: IDecision;
     decisions?: IDecision[];
     decisionDataType?: ValueDataType[keyof ValueDataType];
@@ -107,6 +107,20 @@ export declare const groupsRecordToArrayNew: (record: Record<string, any[]>) =>
     conditionsThatEstablishesTheDecision: any[];
 }[];
 
+declare interface IAttributesGridItem<TData> {
+    id: string;
+    label: string;
+    render?: (value: unknown, ctx: IRenderCtx<TData>) => React.ReactNode;
+    value: IPath<TData>;
+    withTag?: boolean;
+}
+
+declare interface IAttributesGridNode<TData> extends INodeBase<TData> {
+    items: IAttributesGridItem<TData>[];
+    layout?: ILayout;
+    type: "attributesGrid";
+}
+
 export declare interface IBackAndNextButton extends Omit<IButton, "onClick" | "path" | "children"> {
     handleBack: () => void;
     handleNext: () => void;
@@ -219,6 +233,10 @@ export declare interface ICheckpickerField {
 
 export declare type IClientLabel = string;
 
+export declare interface ICondition<TData> {
+    (data: TData): boolean;
+}
+
 export declare interface IDragAndDropBoxes {
     group?: string;
     left: IDragAndDropColumn;
@@ -259,6 +277,7 @@ export declare interface IDropdownMenu {
     headerPath?: string;
     links: TLinkItem[];
     onClick: () => void;
+    onBeforeNavigate?: (to: string, link: TLinkItem) => Promise<boolean> | boolean;
     title: string;
     activeId?: string;
 }
@@ -267,6 +286,7 @@ export declare interface IDropdownMenuContainer {
     collapseOnNavigate?: boolean;
     defaultOpenId?: string | null;
     groups: IDropdownMenuGroup[];
+    onBeforeNavigate?: (to: string, link: TLinkItem) => Promise<boolean> | boolean;
 }
 
 export declare interface IDropdownMenuGroup {
@@ -276,6 +296,15 @@ export declare interface IDropdownMenuGroup {
     path?: string;
 }
 
+declare interface IEntriesGridNode<TData, TEntry> extends INodeBase<TData> {
+    entries: IPath<TData>;
+    keyOf: (entry: TEntry) => string;
+    labelOf: (entry: TEntry) => string;
+    layout?: ILayout;
+    type: "entriesGrid";
+    valueOf: (entry: TEntry) => string;
+}
+
 export declare interface IFilter {
     appliedFilters?: IFilterTag[];
     onClear: () => void;
@@ -300,6 +329,25 @@ export declare interface IFormFilter {
     noFiltersLabel?: string;
 }
 
+declare interface IGroupNode<TData> extends INodeBase<TData> {
+    children: Array<TSchemaNode<TData, any>>;
+    type: "group";
+}
+
+declare interface IJsonNode<TData> extends INodeBase<TData> {
+    type: "json";
+    value: IPath<TData>;
+}
+
+declare interface ILayout {
+    columns?: {
+        desktop: string;
+        mobile: string;
+    };
+    gapToken?: string;
+    variant?: "lightCard" | "none";
+}
+
 declare type IListSide = "left" | "right";
 
 declare interface IModalRules {
@@ -310,6 +358,27 @@ declare interface IModalRules {
     description?: string;
 }
 
+declare interface INodeBase<TData> {
+    id: string;
+    when?: ICondition<TData>;
+}
+
+export declare type IPath<TData> = string | IPathFn<TData>;
+
+declare interface IPathFn<TData> {
+    (data: TData): unknown;
+}
+
+export declare interface IRenderCtx<TData> {
+    data: TData;
+    isMobile: boolean;
+    isTablet: boolean;
+}
+
+declare interface IRenderer<TData> {
+    (node: TSchemaNode<TData, any>, ctx: IRenderCtx<TData>): React.ReactNode;
+}
+
 declare interface IRevertSortedData {
     decisionTemplate?: IRuleDecision;
     dataDecision?: IRuleDecision;
@@ -381,11 +450,32 @@ declare interface IRulesFormTextValues_3 {
     validUntil?: string;
 }
 
+export declare interface IStepSchema<TData> {
+    id: string;
+    name: string;
+    nodes: Array<TSchemaNode<TData, any>>;
+    onBack?: (ctx: {
+        stepId: string;
+    }) => void;
+}
+
 declare interface ITranslateOptions {
     url: string;
     apiKey: string;
 }
 
+declare interface IVerificationEngine<TData> {
+    data: TData;
+    isMobile: boolean;
+    isTablet: boolean;
+    onBackStep?: (stepId: string) => void;
+    schema?: IVerificationSchema<TData>;
+}
+
+export declare interface IVerificationSchema<TData> {
+    steps: IStepSchema<TData>[];
+}
+
 export declare const mapByGroupNew: (raw: any, mapFn: (condition: any) => any) => Record<string, any[]>;
 
 export declare const ModalRules: (props: IModalRules) => ReactPortal;
@@ -398,11 +488,11 @@ export declare const parseRangeFromString: (value: string | number | string[] |
 } | undefined;
 
 export declare const revertSortedDataSampleSwitchPlaces: (props: IRevertSortedData) => {
-    conditionsThatEstablishesTheDecision: ICondition[];
+    conditionsThatEstablishesTheDecision: ICondition_2[];
     businessRuleId?: string;
     conditionDataType?: ValueDataType[keyof ValueDataType];
     conditionName?: string;
-    conditionGroups?: ICondition[];
+    conditionGroups?: ICondition_2[];
     decision?: IDecision;
     decisions?: IDecision[];
     decisionDataType?: ValueDataType[keyof ValueDataType];
@@ -432,8 +522,8 @@ export declare const sortDisplayDataSampleSwitchPlaces: (props: IRevertSortedDat
     businessRuleId?: string;
     conditionDataType?: ValueDataType[keyof ValueDataType];
     conditionName?: string;
-    conditionGroups?: ICondition[];
-    conditionsThatEstablishesTheDecision?: ICondition[];
+    conditionGroups?: ICondition_2[];
+    conditionsThatEstablishesTheDecision?: ICondition_2[];
     decision?: IDecision;
     decisions?: IDecision[];
     decisionDataType?: ValueDataType[keyof ValueDataType];
@@ -465,4 +555,10 @@ export declare const translateObject: (data: Record<string, any>, targetLang: st
 
 export declare const translateText: (text: string, targetLang: string, { url, apiKey }: ITranslateOptions) => Promise<string>;
 
+export declare type TRegistry<TData> = Record<TSchemaNode<TData, any>["type"], IRenderer<TData>>;
+
+export declare type TSchemaNode<TData, TEntry> = IAttributesGridNode<TData> | IEntriesGridNode<TData, TEntry> | IGroupNode<TData> | IJsonNode<TData>;
+
+export declare function Verification<TData>(props: IVerificationEngine<TData>): JSX.Element;
+
 export { }