@imtf/dms-core 1.0.0-beta.1

package/core/providers/Inodes/actions.d.ts

@@ -0,0 +1,612 @@
+import { CancelToken } from "axios";
+import { SupportedItem } from "../App/types";
+import { UploadContextType } from "../Uploader/Context";
+import { Inode, InodeTypeRef, StateMachineAction, StateMachineActionResult } from "./types";
+/**
+ * Load an iterable of inode's oid
+ * @param {Array.<string>} oids
+ */
+export declare function get(oids: Inode["oid"][]): {
+    type: string;
+    payload: {
+        oids: string[];
+    };
+};
+/**
+ * Load an iterable of inode's oid
+ * @param {Iterable.<object>} inodes
+ */
+export declare function getSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function getError(error: unknown, payload: {
+    oids: Inode["oid"][];
+}): {
+    type: string;
+    payload: {
+        oids: Inode["oid"][];
+    };
+    error: unknown;
+};
+export declare function load(oid: Inode["oid"]): {
+    type: string;
+    payload: {
+        oid: string;
+    };
+};
+export declare function loadSuccess(inode: Inode): {
+    type: string;
+    payload: {
+        inode: Inode;
+    };
+};
+export declare function loadAllChildren(oid: Inode["oid"], params: Record<string, unknown>): {
+    type: string;
+    payload: {
+        oid: string;
+        params: Record<string, unknown>;
+    };
+};
+export declare function loadAllChildrenSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function loadAllChildrenError(error: unknown, oid: Inode["oid"]): {
+    type: string;
+    payload: {
+        oid: string;
+    };
+    error: unknown;
+};
+export declare function loadError(error: unknown, oid: Inode["oid"]): {
+    type: string;
+    payload: {
+        oid: string;
+    };
+    error: unknown;
+};
+/**
+ *
+ * @param {string[]} oids
+ * @param {Record<any,any>} params
+ * @param {Record<any,any>} queryParams
+ * @returns
+ */
+export declare function loadChildren(oids: Inode["oid"][], params: Record<string, unknown>, queryParams: Record<string, unknown>): {
+    type: string;
+    payload: {
+        oids: string[];
+        queryParams: Record<string, unknown>;
+    };
+};
+export declare function loadChildrenSuccess(inodeCollections: Record<Inode["oid"], Inode>, params: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodeCollections: Record<string, Inode>;
+    };
+};
+export declare function loadChildrenError(error: unknown, payload: {
+    oids: Inode["oid"][];
+    params: Record<string, unknown>;
+    queryParams: Record<string, unknown>;
+}): {
+    type: string;
+    error: unknown;
+    payload: {
+        oids: Inode["oid"][];
+        params: Record<string, unknown>;
+        queryParams: Record<string, unknown>;
+    };
+};
+export declare function save(inodes: Inode[], params: Record<string, unknown>, mergeOnNameConflict?: boolean): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        params: Record<string, unknown>;
+        mergeOnNameConflict: boolean;
+    };
+};
+export declare function saveSuccess(inodes: Inode[], params: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        params: Record<string, unknown>;
+    };
+};
+export declare function saveError(error: unknown, payload: {
+    inodes: Inode[];
+    params: Record<string, unknown>;
+    mergeOnNameConflict: boolean;
+}): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        params: Record<string, unknown>;
+        mergeOnNameConflict: boolean;
+    };
+    error: unknown;
+};
+export declare function saveConfiguration(inode: Inode, data: {
+    childrenAllowedTypes: Inode["childrenAllowedTypes"];
+    childrenAllowedTemplates: Inode["childrenAllowedTemplates"];
+}, meta: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inode: Inode;
+        data: {
+            childrenAllowedTypes: Inode["childrenAllowedTypes"];
+            childrenAllowedTemplates: Inode["childrenAllowedTemplates"];
+        };
+    };
+    meta: Record<string, unknown>;
+};
+export declare function saveConfigurationSuccess(inode: Inode): {
+    type: string;
+    payload: {
+        inode: Inode;
+    };
+};
+export declare function saveConfigurationError(error: unknown, inode: Inode, data: {
+    childrenAllowedTypes: Inode["childrenAllowedTypes"];
+    childrenAllowedTemplates: Inode["childrenAllowedTemplates"];
+}): {
+    type: string;
+    payload: {
+        inode: Inode;
+        data: {
+            childrenAllowedTypes: Inode["childrenAllowedTypes"];
+            childrenAllowedTemplates: Inode["childrenAllowedTemplates"];
+        };
+    };
+    error: unknown;
+};
+export declare function loadTrash(queryParams: Record<string, unknown>): {
+    type: string;
+    payload: {
+        queryParams: Record<string, unknown>;
+    };
+};
+export declare function loadTrashSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function loadTrashError(error: unknown, queryParams: Record<string, unknown>): {
+    type: string;
+    payload: {
+        queryParams: Record<string, unknown>;
+    };
+    error: unknown;
+};
+export declare function trashSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function addInodes(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+/**
+ * Remove (trash) inodes from folder manager
+ * @param {iterable.<Inode>} inodes List of inode to remove
+ */
+export declare function willRemoveInodes(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function removeInodes(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function upload(targetOid: Inode["oid"], files: File[], fileInodes: Inode[], serviceConfig: {
+    onUploadProgress: (progressEvent: any) => void;
+    cancelToken: CancelToken;
+}): {
+    type: string;
+    payload: {
+        targetOid: string;
+        files: File[];
+        fileInodes: Inode[];
+        serviceConfig: {
+            onUploadProgress: (progressEvent: any) => void;
+            cancelToken: CancelToken;
+        };
+    };
+};
+export declare function uploadSuccess(targetOid: Inode["oid"], inodes: Inode[]): {
+    type: string;
+    payload: {
+        targetOid: string;
+        inodes: Inode[];
+    };
+};
+export declare function uploadError(error: unknown, payload: {
+    targetOid: Inode["oid"];
+    files: File[];
+    fileInodes: Inode[];
+    serviceConfig: {
+        onUploadProgress: (progressEvent: any) => void;
+        cancelToken: CancelToken;
+    };
+}): {
+    type: string;
+    payload: {
+        targetOid: Inode["oid"];
+        files: File[];
+        fileInodes: Inode[];
+        serviceConfig: {
+            onUploadProgress: (progressEvent: any) => void;
+            cancelToken: CancelToken;
+        };
+    };
+    error: unknown;
+};
+/**
+ * This action has to be used in conjonction with `createPromiseAction`. Promise will be then resolved with proper types.
+ * @param {Object} params Params object
+ * @param {Iterable} params.inodes List of inodes to check the type of. If you set this parameter, you can't set files parameter
+ * @param {Iterable} params.files List of files to check the type of. If you set this parameter, you can't set inodes parameter
+ * @param {Iterable} params.targetTypes List of acceptable types. If you set this parameter, you can't set targetInodeOid parameter
+ * @param {string} params.targetInodeOid Target inode oid. If you set this parameter, you can't set targetTypes or forceChildrenWithType parameters
+ * @param {boolean} params.forceChildrenWithType If true, inodes will be forced to have a type.
+ * @param {boolean} params.sort If true, inodes will be sorted by name in types capture modal.
+ * @param {boolean} params.enablePropertiesUpload If true, the AssignTypeAndPropertiesModal modal will be shown.
+ * @returns
+ */
+export declare function checkAndGetType(params: {
+    inodes: Inode[];
+    files: File[];
+    targetTypes: InodeTypeRef[];
+    forceChildrenWithType: boolean;
+    targetInodeOid: Inode["oid"];
+    sort: string;
+    fileProps: Record<string, unknown>;
+    enablePropertiesUpload: boolean;
+}): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        files: File[];
+        targetInodeOid: string;
+        targetTypes: InodeTypeRef[];
+        forceChildrenWithType: boolean;
+        sort: string;
+        fileProps: Record<string, unknown>;
+        enablePropertiesUpload: boolean;
+    };
+};
+export declare function updateBinary(oid: Inode["oid"], file: File, serviceConfig?: Record<string, unknown>): {
+    type: string;
+    payload: {
+        oid: string;
+        file: File;
+        serviceConfig: Record<string, unknown> | undefined;
+    };
+};
+export declare function updateBinarySuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function updateBinaryError(error: unknown, payload: {
+    oid: Inode["oid"];
+    file: File;
+    item: Inode;
+    serviceConfig: Record<string, unknown>;
+}): {
+    type: string;
+    error: unknown;
+    payload: {
+        oid: Inode["oid"];
+        file: File;
+        item: Inode;
+        serviceConfig: Record<string, unknown>;
+    };
+};
+export declare function toggleFavoriteSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function toggleWatchSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function createFolderSuccess(inode: Inode): {
+    type: string;
+    payload: {
+        inode: Inode;
+    };
+};
+export declare function copy(inodes: Inode[], targetInodeOrOid: Inode | Inode["oid"], params?: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        targetInodeOrOid: string | Inode;
+        params: Record<string, unknown> | undefined;
+    };
+};
+export declare function copySuccess(inodes: Inode[], params: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        params: Record<string, unknown>;
+    };
+};
+export declare function copyError(error: unknown, payload: {
+    inodes: Inode[];
+    targetInodeOrOid: Inode | Inode["oid"];
+    params: Record<string, unknown>;
+}): {
+    type: string;
+    error: unknown;
+    payload: {
+        inodes: Inode[];
+        targetInodeOrOid: Inode | Inode["oid"];
+        params: Record<string, unknown>;
+    };
+};
+export declare function linkSuccess(inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+};
+export declare function download(inodes: SupportedItem[]): {
+    type: string;
+    payload: {
+        inodes: SupportedItem[];
+    };
+};
+export declare function editModal(inode: Inode): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function scanModal(inode: Inode): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+/**
+ *
+ * @param {import("./types").StateMachineAction} action State action to apply
+ * @param {import("../Actions/types").Items} inodes A collection to inodes to apply state action
+ * @param {boolean} force If true, the action will be done even if inode is editing or saving without validation
+ */
+export declare function stateAction(action: StateMachineAction, inodes: Inode[], force?: boolean): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        action: StateMachineAction;
+        force: boolean;
+    };
+};
+/**
+ *
+ * @param {import("immutable").Map} actionResult Action result object
+ * @param {Inode[]} inodes from action result (handled by reducer)
+ */
+export declare function stateActionSuccess(actionResult: StateMachineActionResult, inodes: Inode[]): {
+    type: string;
+    payload: {
+        actionResult: StateMachineActionResult;
+        inodes: Inode[];
+    };
+};
+export declare function stateActionError(error: unknown, inodes: Inode[], action: StateMachineAction): {
+    type: string;
+    error: unknown;
+    payload: {
+        inodes: Inode[];
+        action: StateMachineAction;
+    };
+};
+export declare function assignTypesAndProperties(inodes: Inode[], correlationId: string): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        correlationId: string;
+    };
+};
+export declare function move(sourceInodes: Inode[], targetInode: Inode, params?: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        params: {
+            targetInode: Inode;
+            inodeOriginals: Inode[];
+        };
+    };
+};
+/**
+ *
+ * @param {Set} oids Set of oids to keep upon cleaning
+ * @return {Object} FSA Compliant action
+ */
+export declare function clean(oids: Inode["oid"][]): {
+    type: string;
+    payload: {
+        oids: string[];
+    };
+};
+export declare function renameInodeModal(inode: Inode): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function createFolderModal(inode: Inode): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function assignTypeModal(sourceInodes: Inode[], childrenAllowedTypes: Inode["childrenAllowedTypes"], forceChildrenWithType: Inode["forceChildrenWithType"], sort: string, correlationId: string): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function nameConflictModal(payload: {
+    permissions: Inode["permissions"];
+    callback: (action: "RENAME" | "UPDATE", inodeName: Inode["name"], uploadContext: UploadContextType) => void;
+    name: string;
+    isPlural: boolean;
+    shouldCheckForExtensionRename: boolean;
+}): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function restoreInodes(inodes: Inode[], targetInode?: Inode, params?: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        targetInode: Inode | undefined;
+        params: Record<string, unknown> | undefined;
+    };
+};
+export declare function restoreInodesSuccess(inodes: Inode[], params: Record<string, unknown>): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+        params: Record<string, unknown>;
+    };
+};
+export declare function restoreInodesError(error: unknown, inodes: Inode[]): {
+    type: string;
+    payload: {
+        inodes: Inode[];
+    };
+    error: unknown;
+};
+export declare function createNewTaskInodeModal(inodes: Inode[]): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function showTimelineModal(inode: Inode): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};
+export declare function assignTypeAndPropertiesModal(sourceInodes: Inode[], childrenAllowedTypes: Inode["childrenAllowedTypes"], forceChildrenWithType: Inode["forceChildrenWithType"], correlationId: string): {
+    payload: {
+        type: string;
+        props: Partial<{
+            [key: string]: unknown;
+            disableEscapeKeyDown: boolean;
+            disableBackdropClick: boolean;
+            correlationId: string;
+            fullWidth: boolean;
+            maxWidth: import("@mui/material").DialogProps["maxWidth"];
+            blocker: boolean;
+            onClose: () => void;
+        }> | undefined;
+    };
+    type: "modal/showModal";
+};