@hocuspocus/provider 2.2.2 → 2.3.0

package/src/MessageReceiver.ts

@@ -1,11 +1,11 @@
-import * as awarenessProtocol from 'y-protocols/awareness'
-import { readSyncMessage, messageYjsSyncStep2, messageYjsUpdate } from 'y-protocols/sync'
 import { readAuthMessage } from '@hocuspocus/common'
-import { readVarString } from 'lib0/decoding'
-import { MessageType } from './types.js'
+import { readVarInt, readVarString } from 'lib0/decoding'
+import * as awarenessProtocol from 'y-protocols/awareness'
+import { messageYjsSyncStep2, readSyncMessage } from 'y-protocols/sync'
 import { HocuspocusProvider } from './HocuspocusProvider.js'
 import { IncomingMessage } from './IncomingMessage.js'
 import { OutgoingMessage } from './OutgoingMessage.js'
+import { MessageType } from './types.js'
 
 export class MessageReceiver {
 
@@ -23,7 +23,7 @@ export class MessageReceiver {
     return this
   }
 
-  public apply(provider: HocuspocusProvider, emitSynced = true) {
+  public apply(provider: HocuspocusProvider, emitSynced: boolean) {
     const { message } = this
     const type = message.readVarUint()
 
@@ -50,6 +50,9 @@ export class MessageReceiver {
         provider.receiveStateless(readVarString(message.decoder))
         break
 
+      case MessageType.SyncStatus:
+        this.applySyncStatusMessage(provider, readVarInt(message.decoder) === 1)
+        break
       default:
         throw new Error(`Can’t apply message of unknown type: ${type}`)
     }
@@ -85,11 +88,11 @@ export class MessageReceiver {
     if (emitSynced && syncMessageType === messageYjsSyncStep2) {
       provider.synced = true
     }
+  }
 
-    if (syncMessageType === messageYjsUpdate || syncMessageType === messageYjsSyncStep2) {
-      if (provider.unsyncedChanges > 0) {
-        provider.updateUnsyncedChanges(-1)
-      }
+  applySyncStatusMessage(provider: HocuspocusProvider, applied: boolean) {
+    if (applied) {
+      provider.decrementUnsyncedChanges()
     }
   }
 

package/src/TiptapCollabProvider.ts

@@ -1,3 +1,4 @@
+import type { AbstractType, YArrayEvent } from 'yjs'
 import {
   HocuspocusProvider,
   HocuspocusProviderConfiguration,
@@ -20,7 +21,15 @@ export interface AdditionalTiptapCollabProviderConfiguration {
   websocketProvider?: TiptapCollabProviderWebsocket
 }
 
+export type AuditHistoryVersion = {
+  name?: string;
+  version: number;
+  date: number;
+}
+
 export class TiptapCollabProvider extends HocuspocusProvider {
+  tiptapCollabConfigurationPrefix = '__tiptapcollab__'
+
   constructor(configuration: TiptapCollabProviderConfiguration) {
     if (!configuration.websocketProvider) {
       configuration.websocketProvider = new TiptapCollabProviderWebsocket({ appId: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>).appId })
@@ -32,4 +41,45 @@ export class TiptapCollabProvider extends HocuspocusProvider {
 
     super(configuration as HocuspocusProviderConfiguration)
   }
+
+  createVersion(name?: string) {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.sendStateless(JSON.stringify({ action: 'version.create', name }))
+  }
+
+  revertToVersion(targetVersion: number) {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.sendStateless(JSON.stringify({ action: 'version.revert', version: targetVersion }))
+  }
+
+  getVersions(): AuditHistoryVersion[] {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.configuration.document.getArray<AuditHistoryVersion>(`${this.tiptapCollabConfigurationPrefix}versions`).toArray()
+  }
+
+  watchVersions(callback: Parameters<AbstractType<YArrayEvent<AuditHistoryVersion>>['observe']>[0]) {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.configuration.document.getArray<AuditHistoryVersion>('__tiptapcollab__versions').observe(callback)
+  }
+
+  unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<AuditHistoryVersion>>['unobserve']>[0]) {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.configuration.document.getArray<AuditHistoryVersion>('__tiptapcollab__versions').unobserve(callback)
+  }
+
+  isAutoVersioning(): boolean {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return !!this.configuration.document.getMap<number>(`${this.tiptapCollabConfigurationPrefix}config`).get('autoVersioning')
+  }
+
+  enableAutoVersioning() {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.configuration.document.getMap<number>(`${this.tiptapCollabConfigurationPrefix}config`).set('autoVersioning', 1)
+  }
+
+  disableAutoVersioning() {
+    console.error('This doesnt work yet! If you want to join as a beta tester, send an email to humans@tiptap.dev')
+    return this.configuration.document.getMap<number>(`${this.tiptapCollabConfigurationPrefix}config`).set('autoVersioning', 0)
+  }
+
 }

package/src/types.ts

@@ -1,15 +1,15 @@
+import { Encoder } from 'lib0/encoding'
+import type { CloseEvent, Event, MessageEvent } from 'ws'
 import { Awareness } from 'y-protocols/awareness'
 import * as Y from 'yjs'
-import { Encoder } from 'lib0/encoding'
-import type { Event, CloseEvent, MessageEvent } from 'ws'
+import { IncomingMessage } from './IncomingMessage.js'
+import { OutgoingMessage } from './OutgoingMessage.js'
 import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage.js'
 import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage.js'
 import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage.js'
 import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.js'
 import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage.js'
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage.js'
-import { IncomingMessage } from './IncomingMessage.js'
-import { OutgoingMessage } from './OutgoingMessage.js'
 
 export enum MessageType {
   Sync = 0,
@@ -18,6 +18,7 @@ export enum MessageType {
   QueryAwareness = 3,
   Stateless = 5,
   CLOSE = 7,
+  SyncStatus = 8,
 }
 
 export enum WebSocketStatus {