packages/docs-core/lib/VersionHistory/NativeVersionHistory.ts

   1 import { BatchDocumentUpdates } from './BatchDocumentUpdates'
   2 import { mergeUpdates } from 'yjs'
   3 import type { VersionHistoryBatch, VersionHistoryUpdate } from './VersionHistoryBatch'
   4 import { DateFormatter } from './DateFormatter'
   5
   6 /**
   7  * How many DUs should make up a presentable revision in the history viewer. If the threshold is 10 and a
   8  * document has 100 DUs, the UI will show 10 revisions.
   9  */
  10 const BatchThreshold = 10
  11
  12 export class NativeVersionHistory {
  13   private versionHistoryBatches: VersionHistoryBatch[] = []
  14   private _batchDocumentUpdates = new BatchDocumentUpdates()
  15   private dateFormatter = new DateFormatter()
  16
  17   constructor(updates: VersionHistoryUpdate[]) {
  18     this.versionHistoryBatches = this._batchDocumentUpdates.execute(updates, BatchThreshold).getValue()
  19   }
  20
  21   get batches() {
  22     return this.versionHistoryBatches
  23   }
  24
  25   public getTimestampForBatch(batch: VersionHistoryBatch) {
  26     const lastUpdate = batch[batch.length - 1]
  27     return lastUpdate.timestamp
  28   }
  29
  30   public getFormattedDateAndTimeForBatch(batch: VersionHistoryBatch) {
  31     const timestamp = this.getTimestampForBatch(batch)
  32     const date = new Date(timestamp)
  33     return date.toLocaleString()
  34   }
  35
  36   public getShortFormattedDateAndTimeForBatch(batch: VersionHistoryBatch) {
  37     const timestamp = this.getTimestampForBatch(batch)
  38     const date = new Date(timestamp)
  39     return date.toLocaleString('en-US', {
  40       year: '2-digit',
  41       month: '2-digit',
  42       day: '2-digit',
  43       hour: '2-digit',
  44       minute: '2-digit',
  45     })
  46   }
  47
  48   public getFormattedDateForBatch(batch: VersionHistoryBatch) {
  49     return this.dateFormatter.formatDate(this.getTimestampForBatch(batch))
  50   }
  51
  52   public isCurrentBatchIndex(index: number) {
  53     return index === this.batches.length - 1
  54   }
  55
  56   public getFormattedTimeForBatch(batch: VersionHistoryBatch) {
  57     const timestamp = this.getTimestampForBatch(batch)
  58     return this.dateFormatter.formatTime(timestamp)
  59   }
  60
  61   public getFormattedBatchGroups() {
  62     const formattedBatchGroups: {
  63       formattedDate: string
  64       batchIndexes: { batchIndex: number; formattedTime: string }[]
  65     }[] = []
  66     let lastGroupKey = ''
  67     this.batches.forEach((batch, batchIndex) => {
  68       const formattedDate = this.getFormattedDateForBatch(batch)
  69       const formattedTime = this.getFormattedTimeForBatch(batch)
  70
  71       if (lastGroupKey === formattedDate) {
  72         formattedBatchGroups[0].batchIndexes.unshift({ batchIndex, formattedTime })
  73       } else {
  74         formattedBatchGroups.unshift({ formattedDate, batchIndexes: [{ batchIndex, formattedTime }] })
  75       }
  76
  77       lastGroupKey = formattedDate
  78     })
  79     return formattedBatchGroups
  80   }
  81
  82   public getMergedUpdateForBatchIndex(index: number): Uint8Array {
  83     const flattenedBatches = this.versionHistoryBatches.slice(0, index + 1).flat()
  84     const updates = flattenedBatches.map((du) => du.content)
  85     const merged = mergeUpdates(updates)
  86     return merged
  87   }
  88 }