@imtf/dms-core 6.5.7-natwest.0 → 7.4.0

package/core/providers/Plugins/pluginRegistry.d.ts

@@ -1,8 +1,8 @@
 import { ListmakerFormatter } from "@imtf/panache";
-import { NoContent, ViewMoreCard } from "../../../vendor/@imtf/react-components";
 import { OperatorEvaluator } from "json-rules-engine";
 import React, { ElementType } from "react";
 import { useIntl } from "react-intl";
+import { useSWRConfig } from "swr";
 import { Action, ActionDefinition } from "../Actions/types";
 import useReloader from "../Search/hooks/useReloader";
 import { Action as FormAction } from "../../../core/components/JsonForm/types";
@@ -10,18 +10,22 @@ import { api } from "../../../core/services/settings";
 import { TRIGGER_TARGET } from "../Actions/constants";
 import { SupportedItem } from "../App/types";
 import { Case } from "../Cases/types";
+import { useInodesByOids } from "../Inodes/hooks/useInodesByOids";
 import { Inode } from "../Inodes/types";
 import { InspectorProps } from "../Inspectors/types";
 import { Task } from "../Tasks/types";
 import { TYPES } from "./constants";
-import useInodesByOids from "./hooks/inodes/useInodesByOids";
 import { useTaskCompletionDisabling } from "./hooks/tasks/useTaskCompletionDisabling";
-import { CategoryFilterProps, EntitiesWrapperProps, EntityDocumentsDocumentLabelProps, EntityDocumentsDocumentProps, EntityDocumentsTypeLabelProps, EntityEditModalEditForm, MdmEditorEntityRowActionsProps } from "./types/componentPlugins";
+import { useTaskProcessing } from "./hooks/tasks/useTaskProcessing";
+import { CategoryFilterProps, EntitiesWrapperProps, EntityDocumentsComponentProps, EntityDocumentsDocumentLabelProps, EntityDocumentsDocumentProps, EntityDocumentsTypeLabelProps, EntityEditModalEditForm, MdmEditorEntityRowActionsProps } from "./types/componentPlugins";
 type PLUGIN_TYPES = (typeof TYPES)[keyof typeof TYPES];
 declare const plugins: {
     [key in Exclude<PLUGIN_TYPES, "INSPECTOR" | "CONTEXT_MENU_ACTION">]: Record<string, Record<string, any>>;
 };
 declare class PluginRegistry {
+    private getActions;
+    private triggerItems;
+    private _uploadFiles;
     TYPES: Readonly<{
         QUESTIONNAIRE_PART: "QUESTIONNAIRE_PART";
         FORM_WIDGET: "FORM_WIDGET";
@@ -40,14 +44,14 @@ declare class PluginRegistry {
     ENVIRONNEMENT: string;
     service: {
         service: {
-            get: <T = any, R = import("axios").AxiosResponse<T, any>, D = any>(url: string, config?: import("axios").AxiosRequestConfig<D>) => Promise<R> & {
+            get: <T = any, R = import("axios").AxiosResponse<T, any, {}>, D = any>(url: string, config?: import("axios").AxiosRequestConfig<D>) => Promise<R> & {
                 "@@redux-saga/CANCEL_PROMISE"?: import("axios").Canceler;
             };
-            post: <T = any, Data = any>(url: string, data?: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<T, any>>;
-            put: <T = any, Data = any>(url: string, data?: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<T, any>>;
-            patch: <T = any, Data = any>(url: string, data: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<T, any>>;
-            delete: <Data = any>(url: string, data?: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
-            head: (url: string, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any>>;
+            post: <T = any, Data = any>(url: string, data?: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<T, any, {}>>;
+            put: <T = any, Data = any>(url: string, data?: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<T, any, {}>>;
+            patch: <T = any, Data = any>(url: string, data: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<T, any, {}>>;
+            delete: <Data = any>(url: string, data?: Data, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+            head: (url: string, config?: import("axios").AxiosRequestConfig) => Promise<import("axios").AxiosResponse<any, any, {}>>;
         };
         api: typeof api;
         CancelToken: import("axios").CancelTokenStatic;
@@ -57,8 +61,6 @@ declare class PluginRegistry {
             inode: Inode;
         }) => import("react/jsx-runtime").JSX.Element>;
         CountryFlag: any;
-        ViewMoreCard: typeof ViewMoreCard;
-        NoContent: typeof NoContent;
     };
     hooks: {
         app: {
@@ -70,17 +72,23 @@ declare class PluginRegistry {
             }>) => import("swr").SWRResponse<import("../Definitions/types").Codetypes, any, any>;
             useIntl: typeof useIntl;
             useNotification: () => {
-                notify: (message: import("react-toastify").ToastContent, options: import("react-toastify").ToastOptions) => import("react-toastify").Id;
-                updateNotification: (tastId: import("react-toastify").Id, options: import("react-toastify").UpdateOptions) => void;
+                notify: (message: (() => React.ReactNode) | React.ReactNode, options: import("sonner").ToasterProps & {
+                    type: "normal" | "action" | "success" | "info" | "warning" | "error" | "loading" | "default";
+                }) => string | number;
+                updateNotification: (toastId: string, options: (import("sonner").ToasterProps & {
+                    type: "normal" | "action" | "success" | "info" | "warning" | "error" | "loading" | "default";
+                }) & {
+                    message: (() => React.ReactNode) | React.ReactNode;
+                }) => string | number;
             };
-            useParameter: <T>(key: "translations" | "language" | "contentType" | "locales" | "enableCaseCreation" | "shouldReloadResults" | "reloadResultsIntervals" | "userInactivitySessionTimeout" | "showDropzone" | "theme" | "productNameInSidebar" | "disableTaskAutoClaim" | "useRelativeDateWheneverPossible" | "customerRelatedEntitiesTemplates" | "documentTaskSearchContextName" | "canOpenRelatedAlertFromInspector" | "propertyPanelOverrides" | "additionalTransactionsColumns" | "millisecondsToHideUploadProgress" | "inodeTimelineExportLimit" | "searchExportLimit" | "customStamps" | "openEachInodeInNewTabOrWindowLimit" | "useSolrDocumentIcons" | "loadFirstFromQuickSearch" | "enableDossierCreation" | "enableBarcodeProcessing" | "enablePropertiesUpload" | "navigateOnCaseCreation" | "navigateOnTaskCompletion" | "authenticationWorkflow" | "hitListLimit" | "inodeListLimit" | "appBarColor" | "displayEnvironmentName" | "autosaveDebounce" | "displayFullnameInDocuments" | "enableDigitalSignatureVerification" | "certificateRevocationListProxyServerUrl" | "companionScanDPIResolution", defaultValue?: T) => T | undefined; /**
+            useParameter: <T>(key: "translations" | "language" | "navigateOnTaskCompletion" | "contentType" | "locales" | "enableCaseCreation" | "shouldReloadResults" | "reloadResultsIntervals" | "userInactivitySessionTimeout" | "showDropzone" | "theme" | "productNameInSidebar" | "disableTaskAutoClaim" | "useRelativeDateWheneverPossible" | "customerRelatedEntitiesTemplates" | "documentTaskFilterFoldersByFileType" | "canOpenRelatedAlertFromInspector" | "propertyPanelOverrides" | "additionalTransactionsColumns" | "millisecondsToHideUploadProgress" | "inodeTimelineExportLimit" | "searchExportLimit" | "customStamps" | "openEachInodeInNewTabOrWindowLimit" | "useSolrDocumentIcons" | "loadFirstFromQuickSearch" | "enableDossierCreation" | "enableBarcodeProcessing" | "enablePropertiesUpload" | "navigateOnCaseCreation" | "authenticationWorkflow" | "hitListLimit" | "inodeListLimit" | "appBarColor" | "displayEnvironmentName" | "autosaveDebounce" | "displayFullnameInDocuments" | "enableDigitalSignatureVerification" | "certificateRevocationListProxyServerUrl" | "companionScanDPIResolution" | "enableCommentLinks" | "companionMultipleEditionLimit" | "enableCompanionDefaultDuplex" | "enableCompanionDefaultColor" | "disableNotifications" | "openViewerCommentsByDefault" | "enableStampsCreation" | "enableStandardStamps" | "hideDisabledPropertiesAtUpload" | "displaySearchBarInToolbar" | "restrictAnnotationEditingToOwner" | "displayUnauthorizedItems" | "propertiesBySearchContext" | "signatureWidth", defaultValue?: T) => T | undefined;
+            /**
              * @deprecated
              */
             useReloader: typeof useReloader;
             useSWR: import("swr").SWRHook;
             useSWRImmutable: import("swr").SWRHook;
-            useSWRMutation: import("swr/mutation").SWRMutationHook;
-            useSWRConfig: () => import("swr/_internal").FullConfiguration;
+            useSWRConfig: typeof useSWRConfig;
             useUserDetails: () => import("../User/types").User | undefined;
         };
         case: {
@@ -88,10 +96,6 @@ declare class PluginRegistry {
                 createFiles: (entityOid: any, inodes: any) => void;
             };
             useCase: (item: Case) => import("swr").SWRResponse<Case, any, any>;
-            usePayload: (item: unknown) => import("swr").SWRResponse<{
-                kind: "acm.CasePayload";
-                payload: import("../Cases/types").CasePayload;
-            }, any, any>;
             useData: <E = import("../Ccm/types").EntityType>(params: {
                 caseOid: string | undefined;
                 entitiesSelector?: {
@@ -108,6 +112,10 @@ declare class PluginRegistry {
                 mutate: () => void;
             };
             useDocumentTypes: (item: string | Case | Task) => import("swr").SWRResponse<import("../Cases/hooks/useCaseDocumentTypes").CaseDocumentType[], any, any>;
+            usePayload: (item: unknown) => import("swr").SWRResponse<{
+                kind: "acm.CasePayload";
+                payload: import("../Cases/types").CasePayload;
+            }, any, any>;
         };
         task: {
             useActions: (taskOid: any) => {
@@ -123,8 +131,8 @@ declare class PluginRegistry {
                         inodes: any;
                     };
                 };
-                reloadQuestionnaire: () => Promise<any>;
-                reloadData: () => Promise<any>;
+                reloadQuestionnaire: () => void;
+                reloadData: () => void;
             };
             useData: <EntityType extends import("../MdmGraph/types").Entity>(taskOid: string | undefined, config?: import("swr").SWRConfiguration) => import("swr").SWRResponse<import("../Tasks/types").TaskData<EntityType>, any, import("swr").SWRConfiguration<import("../Tasks/types").TaskData<EntityType>, any, import("swr").BareFetcher<import("../Tasks/types").TaskData<EntityType>>> | undefined>;
             useEntitiesMutate: (taskOid: string) => import("swr/mutation").SWRMutationResponse<{
@@ -138,7 +146,6 @@ declare class PluginRegistry {
                 trigger: (entity: import("../MdmGraph/types").Entity, patchData?: import("../MdmGraph/types").EntityData, params?: import("../Tasks/hooks/useEntityMutate").Params) => Promise<void>;
                 isMutating: boolean;
                 reset: () => void;
-                error: import("axios").AxiosError<unknown, any> | undefined;
                 data: {
                     entity?: import("../MdmGraph/types").Entity & {
                         __creationOid?: string;
@@ -146,6 +153,7 @@ declare class PluginRegistry {
                     relation?: import("../MdmGraph/types").Relation;
                     params?: import("../Tasks/hooks/useEntityMutate").Params | undefined;
                 } | undefined;
+                error: import("axios").AxiosError<unknown, any> | undefined;
             };
             useEntityDelete: (taskOid: string) => {
                 deleteEntity: (entityOid: string, params: Omit<{
@@ -162,11 +170,12 @@ declare class PluginRegistry {
                     entityOid: string;
                 }>;
                 reset: () => void;
-                error: import("axios").AxiosError<unknown, any> | undefined;
                 data: string | undefined;
+                error: import("axios").AxiosError<unknown, any> | undefined;
             };
             useTask: (taskOid: string | undefined) => import("swr").SWRResponse<Task, any, any>;
             useTaskCompletionDisabling: typeof useTaskCompletionDisabling;
+            useTaskProcessing: typeof useTaskProcessing;
         };
         mdm: {
             useEntity: (taskOid: any, entityOid: any) => {
@@ -185,42 +194,26 @@ declare class PluginRegistry {
                 } & {
                     result: import("../Inodes/types").InodeList | undefined;
                 }>;
-                update: (inodes: any) => void;
+                update: (inodes: any) => Promise<({
+                    inodes: Inode[];
+                    targetInode?: Inode;
+                    originalInodes?: Inode[];
+                    mergeOnNameConflict?: boolean;
+                    moveMode?: "FORCE_MOVE";
+                } & {
+                    newInodes: Inode[];
+                }) | undefined>;
+                checkAndGetWithType: (inodes: any, targetTypes: any, forceChildrenWithType: any) => Promise<Inode[] | null>;
                 stateAction: (inodes: any, action: any) => void;
                 updateProperties: (newProperties: any, oid: any) => void;
-                checkAndGetWithType: (inodes: any, targetTypes: any, forceChildrenWithType: any, sort: any) => Promise<any>;
             };
             useInodesByOids: typeof useInodesByOids;
         };
     };
-    private triggerItems;
-    private uploadFiles;
-    upload: {
-        promptIcosUpload: (params: {
-            multiple?: boolean;
-            accept?: string;
-            caseOid?: string;
-            taskOid?: string;
-            entityOid?: string;
-            type?: import("../Inodes/types").InodeType;
-            properties?: any;
-            types?: import("../Inodes/types").InodeType[];
-        }) => Promise<null>;
-        uploadIcosFiles: (params: {
-            files: File[];
-            caseOid?: string;
-            taskOid?: string;
-            entityOid?: string;
-            fileProps?: Record<string, any>;
-            fileInodes?: Inode[];
-            types: import("../Inodes/types").InodeType[];
-        }) => Promise<null>;
-        updateBinary: (inodeOid: string, file: File, getUpdatedItem?: (file: File) => File) => Promise<null>;
-    };
     setDeps({ getActions, triggerItems, upload, }: {
         getActions: typeof PluginRegistry.prototype.getActions;
         triggerItems: typeof PluginRegistry.prototype.triggerItems;
-        upload: typeof PluginRegistry.prototype.uploadFiles;
+        upload: typeof PluginRegistry.prototype._uploadFiles;
     }): void;
     register(type: typeof TYPES.FORM_WIDGET | typeof TYPES.FORM_FIELD | typeof TYPES.RENDERER | typeof TYPES.CONTEXT_MENU_ACTION | typeof TYPES.EXTERNAL_MODULE | typeof TYPES.QUESTIONNAIRE_PART | typeof TYPES.PROVIDER, name: string, plugin: (...args: any[]) => React.ReactNode, options?: {
         condition?: (item: unknown) => boolean;
@@ -244,6 +237,9 @@ declare class PluginRegistry {
     register(type: typeof TYPES.COMPONENT, name: "documentUpload/Filters", plugin: React.FC<CategoryFilterProps>, params?: {
         condition?: (props: CategoryFilterProps) => boolean;
     }): void;
+    register(type: typeof TYPES.COMPONENT, name: "entityDocuments/Section", plugin: React.FC<EntityDocumentsComponentProps>, params?: {
+        condition?: (props: EntityDocumentsComponentProps) => boolean;
+    }): void;
     register(type: typeof TYPES.COMPONENT, name: "entityDocuments/TypeLabel", plugin: React.FC<EntityDocumentsTypeLabelProps>, params?: {
         condition?: (props: EntityDocumentsTypeLabelProps) => boolean;
     }): void;
@@ -259,7 +255,37 @@ declare class PluginRegistry {
         object: ElementType;
     } | undefined;
     getAll(type: keyof typeof plugins): Record<string, Record<string, any>>;
-    private getActions;
+    upload: {
+        promptIcosUpload: (params: {
+            multiple?: boolean;
+            accept?: string;
+            caseOid?: string;
+            taskOid?: string;
+            entityOid?: string;
+            type?: import("../Inodes/types").InodeType;
+            properties?: any;
+            types?: import("../Inodes/types").InodeType[];
+        }) => Promise<import("../Inodes/types").UploadResult[]>;
+        promptUpdateBinary: (params: {
+            accept?: string;
+            target: string;
+            updateInodeName?: boolean;
+        }) => Promise<import("../Inodes/types").UploadResult[]>;
+        uploadIcosFiles: (params: {
+            files: File[];
+            caseOid?: string;
+            taskOid?: string;
+            entityOid?: string;
+            fileProps?: Record<string, any>;
+            fileInodes?: Inode[];
+            types: import("../Inodes/types").InodeType[];
+        }) => Promise<import("../Inodes/types").UploadResult[]>;
+        updateBinary: (inodeOid: string, file: File, updateInodeName?: boolean | undefined) => Promise<import("../Inodes/types").UploadResult[]>;
+    };
+    /**
+     * As `getActions` and `triggerItems` as redefined after class instantiation,
+     * we need to expose them as a function to be able to use them in the actions object.
+     */
     actions: {
         getActions: (items: SupportedItem[], extraActions?: ActionDefinition[], extraActionParams?: Record<string, any>) => Action[];
         triggerItems: (items: SupportedItem[], target?: keyof typeof TRIGGER_TARGET) => void;
@@ -313,13 +339,14 @@ declare class PluginRegistry {
                 readonly ADD_FILE: "INODE_ADD_FILE";
                 readonly ADD_FOLDER: "INODE_ADD_FOLDER";
                 readonly ADD_COMMENT: "INODE_ADD_COMMENT";
+                readonly VIEW_COMMENTS: "INODE_VIEW_COMMENTS";
                 readonly RESTORE: "INODE_RESTORE";
                 readonly COMPOSE: "INODE_COMPOSE";
                 readonly QUICK_LOOK: "INODE_QUICK_LOOK";
                 readonly QUICK_LOOK_MERGE: "INODE_QUICK_LOOK_MERGE";
                 readonly CREATE_CASE: "INODE_CREATE_CASE";
                 readonly MERGE_PDF: "INODE_MERGE_PDF";
-                readonly CREATE_NEW_TASK: "INODE_CREATE_NEW_TASK";
+                readonly CREATE_TASK_OR_CASE: "INODE_CREATE_TASK_OR_CASE";
                 readonly DELETE: "INODES_DELETE";
                 readonly ADD_TO_DROP_ZONE: "INODES_ADD_TO_DROP_ZONE";
                 readonly LINK_FROM_DROP_ZONE: "INODES_LINK_FROM_DROP_ZONE";

package/core/providers/Plugins/types/componentPlugins.d.ts

@@ -1,9 +1,11 @@
-import { ReactNode } from "react";
+import { ReactElement, ReactNode } from "react";
 import { FormDefinition, MdmEditorDefinition } from "../../Definitions/types";
 import { Inode } from "../../Inodes/types";
 import { Entity } from "../../MdmGraph/types";
+import type { EntityDocumentsComponentProps as EntityDocumentsComponentCoreProps } from "../../../../core/containers/EntityDocuments/EntityDocumentsComponent";
+import { FileType } from "../../../../core/containers/EntityDocuments/types";
 export type ComponentPluginProps<P> = P & {
-    defaultRender: (props?: Partial<P>) => JSX.Element;
+    defaultRender: (props?: Partial<P>) => ReactElement;
 };
 export type MdmEditorEntityRowActionsProps = ComponentPluginProps<{
     isDisabled: boolean;
@@ -18,17 +20,14 @@ export type EntityEditModalEditForm = ComponentPluginProps<{
     entity: Entity;
     children: ReactNode;
 }>;
-export type EntityDocumentsDocumentProps = ComponentPluginProps<{
-    document: Inode<"dms-core.File">;
-    disabled: boolean;
+export type EntityDocumentsComponentProps = ComponentPluginProps<Pick<EntityDocumentsComponentCoreProps, "entity" | "canDrop" | "onDrop" | "documentsByType" | "typesFromDefinition" | "documentUploadButton" | "disabled"> & {
     identifier?: string;
     taskOid?: string;
     caseOid?: string;
     entityOid?: string;
 }>;
-export type EntityDocumentsDocumentLabelProps = ComponentPluginProps<{
+export type EntityDocumentsDocumentProps = ComponentPluginProps<{
     document: Inode<"dms-core.File">;
-    canDrag: boolean;
     disabled: boolean;
     identifier?: string;
     taskOid?: string;
@@ -51,7 +50,18 @@ export type EntityDocumentsTypeLabelProps = ComponentPluginProps<{
     taskOid?: string;
     caseOid?: string;
     entityOid?: string;
-    type: string;
+    type: FileType;
+    documents: Inode<"dms-core.File">[];
+}>;
+export type EntityDocumentsDocumentLabelProps = ComponentPluginProps<{
+    document: Inode<"dms-core.File">;
+    canDrag: boolean;
+    disabled: boolean;
+    identifier?: string;
+    taskOid?: string;
+    caseOid?: string;
+    entityOid?: string;
+    type: FileType;
     documents: Inode<"dms-core.File">[];
 }>;
 export type EntitiesWrapperProps = ComponentPluginProps<{

package/core/providers/Plugins/withComponentPlugin.d.ts

@@ -0,0 +1,27 @@
+import { ElementType } from "react";
+/**
+ * This component can be used to replace a component
+ * but from the "consumer" side (i.e. the side that uses the component)
+ */
+export declare const WithComponentPlugin: <P extends Record<string, unknown>>(props: {
+    component: ElementType;
+    /**
+     * The identifier of the component. It must be unique.
+     * First segment is the type of the component
+     * Second segment is the name of the component
+     */
+    identifier: `${string}/${string}`;
+    /**
+     * Exhausive list of the props that should be forwarded to the component.
+     * By default none are forwarded.
+     */
+    forwardedProps?: (keyof P)[];
+    /**
+     * Extra props that should be passed to the component
+     */
+    extraProps?: Record<string, unknown>;
+    /**
+     * Function to alter the props before passing them to the component
+     */
+    alterProps?: (propName: keyof P, propValue: P[keyof P]) => P[keyof P];
+} & P) => import("react/jsx-runtime").JSX.Element;

package/core/providers/Search/reducer.d.ts

@@ -1,19 +1,21 @@
 import { AnyAction } from "@reduxjs/toolkit";
-import { TableRow, TreeViewField } from "../../../core/containers/TreeView/types";
+import { ColumnDefinition } from "../../../core/containers/DataGrid/types";
+import { TableRow } from "../../../core/containers/SearchDataGrid/types";
 import { SearchMask } from "../Definitions/types";
-import { SearchResultCapabilities } from "./types";
+import { SearchResultAlert, SearchResultCapabilities } from "./types";
 export type SearchState = {
     loading: boolean;
     error: any;
     results: {
         contextName: string | undefined;
         count: number | null;
-        head: TreeViewField[];
+        head: ColumnDefinition[];
         mask: SearchMask | null;
         rows: TableRow[];
         hasUnknowCount: boolean;
         timestamp: number | undefined;
         capabilities: SearchResultCapabilities;
+        alerts?: SearchResultAlert[];
     };
 };
 export default function searchReducer(state: SearchState | undefined, action: AnyAction): {
@@ -22,11 +24,12 @@ export default function searchReducer(state: SearchState | undefined, action: An
     results: {
         contextName: string | undefined;
         count: number | null;
-        head: TreeViewField[];
+        head: ColumnDefinition[];
         mask: SearchMask | null;
         rows: TableRow[];
         hasUnknowCount: boolean;
         timestamp: number | undefined;
         capabilities: SearchResultCapabilities;
+        alerts?: SearchResultAlert[];
     };
 };