applications/drive/src/app/store/_documents/useOpenDocument.ts

   1 import { useAuthentication } from '@proton/components';
   2 import { getAppHref } from '@proton/shared/lib/apps/helper';
   3 import { APPS } from '@proton/shared/lib/constants';
   4
   5 /**
   6  * When coming back from the account sign up or sign in, we are usually coming back after the user initiated the auth
   7  * by pressing Bookmark or Make Copy button. The `action` param in the URL will tell us where to pick back up once
   8  * we're back in Docs.
   9  */
  10 enum RedirectAction {
  11     Bookmark = 'bookmark',
  12     MakeCopy = 'make-copy',
  13 }
  14
  15 type DocumentAction =
  16     | {
  17           mode: 'open' | 'convert' | 'download' | 'history';
  18           linkId: string;
  19           volumeId: string;
  20       }
  21     | {
  22           mode: 'create';
  23           parentLinkId: string;
  24           volumeId: string;
  25       }
  26     | {
  27           mode: 'open-url';
  28           action?: RedirectAction;
  29           linkId: string;
  30           token: string;
  31           urlPassword: string;
  32       }
  33     | {
  34           /**
  35            * Reauth occurs when a user is first in a public context (viewing a public doc), then selects an option that
  36            * redirects them to sign up / sign in. Instead of redirecting back to the public context immediately on
  37            * sign up, we first need to redirect to the private docs context, so that the the user's session can be persisted.
  38            * Then we redirect back to the public context where the user can be correctly loaded.
  39            */
  40           mode: 'open-url-reauth';
  41           action?: RedirectAction;
  42           linkId: string;
  43           token: string;
  44       }
  45     | {
  46           /** Make a copy of a public document */
  47           mode: 'copy-public';
  48       };
  49
  50 export const useOpenDocument = () => {
  51     const { getLocalID } = useAuthentication();
  52
  53     /**
  54      * Opens a document in a new window.
  55      *
  56      * In the Drive application, this should not be used directly, prefer `useDocumentActions`.
  57      */
  58     const openDocumentWindow = (action: DocumentAction & { window: Window }) => {
  59         const { mode, window } = action;
  60
  61         const href = getAppHref(`/doc`, APPS.PROTONDOCS, getLocalID());
  62         const url = new URL(href);
  63
  64         url.searchParams.append('mode', mode);
  65
  66         if ('volumeId' in action && action.volumeId) {
  67             url.searchParams.append('volumeId', action.volumeId);
  68         } else if ('token' in action && action.token) {
  69             url.searchParams.append('token', action.token);
  70         }
  71
  72         if ('linkId' in action && action.linkId) {
  73             url.searchParams.append('linkId', action.linkId);
  74         } else if ('parentLinkId' in action && action.parentLinkId) {
  75             url.searchParams.append('parentLinkId', action.parentLinkId);
  76         }
  77
  78         if ('urlPassword' in action && action.urlPassword) {
  79             url.hash = action.urlPassword;
  80         }
  81
  82         window.location.assign(url);
  83     };
  84
  85     return {
  86         openDocumentWindow,
  87     };
  88 };