packages/docs-core/lib/State/DocumentState.ts

   1 import type { ConnectionCloseReason } from '@proton/docs-proto'
   2 import { BasePropertiesState } from '@proton/docs-shared'
   3 import type {
   4   DocumentRole,
   5   BroadcastSource,
   6   DecryptedMessage,
   7   DocTrashState,
   8   DocumentMetaInterface,
   9   RtsMessagePayload,
  10 } from '@proton/docs-shared'
  11 import type { DecryptedCommit } from '../Models/DecryptedCommit'
  12 import type { DocumentEntitlements, PublicDocumentEntitlements } from '../Types/DocumentEntitlements'
  13 import type { DecryptedNode } from '@proton/drive-store/lib'
  14
  15 export type DocumentEvent =
  16   | {
  17       name: 'RealtimeConnectionClosed'
  18       payload: ConnectionCloseReason
  19     }
  20   | {
  21       name: 'RealtimeFailedToConnect'
  22       payload: undefined
  23     }
  24   | {
  25       name: 'RealtimeAttemptingToSendUpdateThatIsTooLarge'
  26       payload: undefined
  27     }
  28   | {
  29       name: 'RealtimeReceivedDocumentUpdate'
  30       payload: DecryptedMessage
  31     }
  32   | {
  33       name: 'RealtimeRequestingClientToBroadcastItsState'
  34       payload: undefined
  35     }
  36   | {
  37       name: 'RealtimeReceivedOtherClientPresenceState'
  38       payload: Uint8Array
  39     }
  40   | {
  41       name: 'EditorRequestsPropagationOfUpdate'
  42       payload: {
  43         message: RtsMessagePayload
  44         debugSource: BroadcastSource
  45       }
  46     }
  47   | {
  48       name: 'DriveFileConversionToDocBegan'
  49       payload: undefined
  50     }
  51   | {
  52       name: 'DriveFileConversionToDocSucceeded'
  53       payload: undefined
  54     }
  55   | {
  56       name: 'DebugMenuRequestingCommitWithRTS'
  57       payload: DocumentEntitlements
  58     }
  59   | {
  60       name: 'EditorIsReadyToBeShown'
  61       payload: undefined
  62     }
  63
  64 export interface DocumentStateValues {
  65   documentName: string
  66   currentCommitId: string | undefined
  67   userRole: DocumentRole
  68   documentTrashState: DocTrashState
  69   baseCommit: DecryptedCommit | undefined
  70   documentMeta: DocumentMetaInterface
  71   decryptedNode: DecryptedNode
  72   entitlements: DocumentEntitlements
  73
  74   editorReady: boolean
  75   editorHasRenderingIssue: boolean
  76
  77   /** Public documents may not support realtime depending on feature configuration */
  78   realtimeEnabled: boolean
  79   /** Is set to true after the connection connects AND the server informs us its ready to receive updates */
  80   realtimeReadyToBroadcast: boolean
  81   /** Is set to true if we are unable to form a connection with the RTS server in a reasonable time */
  82   realtimeConnectionTimedOut: boolean
  83   realtimeStatus: 'connected' | 'connecting' | 'disconnected'
  84   realtimeIsExperiencingErroredSync: boolean
  85   realtimeIsLockedDueToSizeContraint: boolean
  86   realtimeIsParticipantLimitReached: boolean
  87 }
  88
  89 const DefaultValues: Pick<
  90   DocumentStateValues,
  91   | 'documentName'
  92   | 'currentCommitId'
  93   | 'baseCommit'
  94   | 'editorReady'
  95   | 'editorHasRenderingIssue'
  96   | 'realtimeEnabled'
  97   | 'realtimeReadyToBroadcast'
  98   | 'realtimeConnectionTimedOut'
  99   | 'realtimeStatus'
 100   | 'realtimeIsExperiencingErroredSync'
 101   | 'realtimeIsLockedDueToSizeContraint'
 102   | 'realtimeIsParticipantLimitReached'
 103 > = {
 104   documentName: '',
 105   currentCommitId: undefined,
 106   baseCommit: undefined,
 107
 108   editorReady: false,
 109   editorHasRenderingIssue: false,
 110   realtimeEnabled: true,
 111   realtimeConnectionTimedOut: false,
 112   realtimeReadyToBroadcast: false,
 113   realtimeStatus: 'disconnected',
 114   realtimeIsExperiencingErroredSync: false,
 115   realtimeIsLockedDueToSizeContraint: false,
 116   realtimeIsParticipantLimitReached: false,
 117 }
 118
 119 export function isDocumentState(state: DocumentState | PublicDocumentState): state is DocumentState {
 120   return state instanceof DocumentState
 121 }
 122
 123 /**
 124  * Manages the state of a fully resolved document (has nodeMeta, documentMeta, etc)
 125  */
 126 export class DocumentState extends BasePropertiesState<DocumentStateValues, DocumentEvent> {
 127   static readonly defaults: typeof DefaultValues = DefaultValues
 128 }
 129
 130 /**
 131  * Same as DocumentState but entitlements are of type PublicDocumentEntitlements
 132  */
 133 export class PublicDocumentState extends BasePropertiesState<
 134   Omit<DocumentStateValues, 'entitlements'> & { entitlements: PublicDocumentEntitlements },
 135   DocumentEvent
 136 > {
 137   static readonly defaults: typeof DefaultValues = DefaultValues
 138 }