packages/drive-store/lib/useDriveCompat.tsx

   1 import type { ReactNode } from 'react';
   2
   3 import type { PublicKeyReference } from '@proton/crypto/lib';
   4 import type { SHARE_MEMBER_PERMISSIONS } from '@proton/shared/lib/drive/permissions';
   5 import { getNewWindow } from '@proton/shared/lib/helpers/window';
   6
   7 import { useLinkSharingModal } from '../components/modals/ShareLinkModal/ShareLinkModal';
   8 import { useDriveCrypto } from '../store/_crypto';
   9 import type { DocumentAction } from '../store/_documents';
  10 import { useDriveDocsFeatureFlag, useOpenDocument } from '../store/_documents';
  11 import type { PathItem } from '../store/_views/useLinkPath';
  12 import type { DocumentKeys, DocumentNodeMeta } from './_documents';
  13 import { useDocuments } from './_documents';
  14 import type { DecryptedNode } from './_nodes/interface';
  15 import useNode from './_nodes/useNode';
  16 import useNodes from './_nodes/useNodes';
  17 import { useMyFiles, useResolveShareId } from './_shares';
  18 import type { NodeMeta } from './interface';
  19
  20 export interface DriveCompat {
  21     /**
  22      * Whether or not Docs is enabled. Only uses feature flags, not context aware.
  23      */
  24     isDocsEnabled: boolean;
  25
  26     /**
  27      * Gets whether or not Docs can be used, with awareness of the context.
  28      */
  29     canUseDocs: (meta: NodeMeta) => Promise<boolean>;
  30
  31     /**
  32      * Gets a node, either from cache or fetched.
  33      */
  34     getNode: (meta: NodeMeta) => Promise<DecryptedNode>;
  35
  36     getNodes: (ids: { linkId: string; shareId: string }[]) => Promise<DecryptedNode[]>;
  37
  38     getShareId: (meta: NodeMeta) => Promise<string>;
  39
  40     /**
  41      * Gets the contents of a node.
  42      */
  43     getNodeContents: (meta: NodeMeta) => Promise<{ contents: Uint8Array; node: DecryptedNode }>;
  44
  45     /**
  46      * Gets permissions associated to a specific node.
  47      */
  48     getNodePermissions: (meta: NodeMeta) => Promise<SHARE_MEMBER_PERMISSIONS>;
  49
  50     /**
  51      * Finds an available name for a new node.
  52      *
  53      * @param parentMeta The parent node where the new node will be located.
  54      */
  55     findAvailableNodeName: (parentMeta: NodeMeta, desiredName: string) => Promise<string>;
  56
  57     /**
  58      * Creates an empty document node (document shell).
  59      *
  60      * @param parentMeta The parent node where the new node will be located.
  61      */
  62     createDocumentNode: (parentMeta: NodeMeta, name: string) => Promise<DocumentNodeMeta>;
  63
  64     /**
  65      * Gets the keys for a given document node.
  66      */
  67     getDocumentKeys: (meta: NodeMeta) => Promise<DocumentKeys>;
  68
  69     /**
  70      * Renames a document node.
  71      */
  72     renameDocument: (meta: NodeMeta, newName: string) => Promise<void>;
  73
  74     trashDocument: (meta: NodeMeta, parentLinkId: string) => Promise<void>;
  75     restoreDocument: (meta: NodeMeta, parentLinkId: string) => Promise<void>;
  76     /**
  77      * Gets the URL for a given document.
  78      */
  79     getDocumentUrl: (meta: NodeMeta) => URL;
  80
  81     getNodePaths: (ids: { linkId: string; shareId: string }[]) => Promise<PathItem[][]>;
  82     getNodesAreShared: (ids: { linkId: string; shareId: string }[]) => Promise<boolean[]>;
  83     /**
  84      * Opens a document's sharing modal.
  85      */
  86     openDocumentSharingModal: (meta: NodeMeta) => void;
  87
  88     /**
  89      * Opens a document in a new window.
  90      */
  91     openDocument: (meta: NodeMeta) => void;
  92     openDocumentWindow: (
  93         action: DocumentAction & {
  94             window: Window;
  95         }
  96     ) => void;
  97
  98     /**
  99      * Gets the key used to verify signatures.
 100      */
 101     getVerificationKey: (email: string) => Promise<PublicKeyReference[]>;
 102
 103     /**
 104      * Gets the node identifier for My Files.
 105      *
 106      * Temporary utility function, subject to change :)
 107      */
 108     getMyFilesNodeMeta: () => Promise<NodeMeta>;
 109
 110     /**
 111      * Modals that should be included in the DOM tree.
 112      */
 113     modals: ReactNode;
 114 }
 115
 116 export const useDriveCompat = (): DriveCompat => {
 117     const { withResolve } = useResolveShareId();
 118
 119     const { createDocumentNode, getDocumentKeys, renameDocument, getDocumentUrl, trashDocument, restoreDocument } =
 120         useDocuments();
 121     const { getNode, getNodeContents, getNodePermissions, findAvailableNodeName } = useNode();
 122     const { getNodes, getNodePaths, getNodesAreShared } = useNodes();
 123     const { getMyFilesNodeMeta } = useMyFiles();
 124     const { openDocumentWindow } = useOpenDocument();
 125     const { getVerificationKey } = useDriveCrypto();
 126     const { isDocsEnabled, canUseDocs } = useDriveDocsFeatureFlag();
 127
 128     const [linkSharingModal, showLinkSharingModal] = useLinkSharingModal();
 129
 130     const openDocument = (meta: NodeMeta) =>
 131         openDocumentWindow({ ...meta, mode: 'open', window: getNewWindow().handle });
 132
 133     return {
 134         isDocsEnabled,
 135         canUseDocs: withResolve(({ shareId }) => canUseDocs(shareId)),
 136         createDocumentNode: withResolve(createDocumentNode),
 137         getDocumentKeys: withResolve(getDocumentKeys),
 138         getNodePaths,
 139         getNodesAreShared,
 140         getNode: withResolve(getNode),
 141         getNodeContents: withResolve(getNodeContents),
 142         getNodePermissions: withResolve(getNodePermissions),
 143         getNodes,
 144         getShareId: withResolve(({ shareId }) => shareId),
 145         findAvailableNodeName: withResolve(findAvailableNodeName),
 146         renameDocument: withResolve(renameDocument),
 147         trashDocument: withResolve(trashDocument),
 148         restoreDocument: withResolve(restoreDocument),
 149         getDocumentUrl,
 150         openDocument,
 151         openDocumentWindow,
 152         openDocumentSharingModal: withResolve(showLinkSharingModal),
 153         getMyFilesNodeMeta,
 154         getVerificationKey,
 155         // This should be changed to a fragment if more modals are added
 156         modals: linkSharingModal,
 157     };
 158 };