@hocuspocus/provider 3.0.6-rc.0 → 3.0.7-rc.0

package/dist/packages/provider/src/HocuspocusProvider.d.ts

@@ -4,7 +4,7 @@ import * as Y from 'yjs';
 import EventEmitter from './EventEmitter.ts';
 import type { CompleteHocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket.ts';
 import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.ts';
-import type { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onSyncedParameters } from './types.ts';
+import type { ConstructableOutgoingMessage, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onSyncedParameters, onUnsyncedChangesParameters } from './types.ts';
 export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> | Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>);
 export interface CompleteHocuspocusProviderConfiguration {
     /**
@@ -36,7 +36,7 @@ export interface CompleteHocuspocusProviderConfiguration {
      * Force syncing the document in the defined interval.
      */
     forceSyncInterval: false | number;
-    onAuthenticated: () => void;
+    onAuthenticated: (data: onAuthenticatedParameters) => void;
     onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
     onOpen: (data: onOpenParameters) => void;
     onConnect: () => void;
@@ -49,6 +49,7 @@ export interface CompleteHocuspocusProviderConfiguration {
     onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
     onAwarenessChange: (data: onAwarenessChangeParameters) => void;
     onStateless: (data: onStatelessParameters) => void;
+    onUnsyncedChanges: (data: onUnsyncedChangesParameters) => void;
 }
 export declare class AwarenessError extends Error {
     code: number;
@@ -60,7 +61,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     isAuthenticated: boolean;
     authorizedScope: string | undefined;
     manageSocket: boolean;
-    private isAttached;
+    private _isAttached;
     intervals: any;
     constructor(configuration: HocuspocusProviderConfiguration);
     boundDocumentUpdateHandler: (update: Uint8Array, origin: any) => void;
@@ -74,6 +75,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     forwardDestroy: (e: any) => this;
     setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
     get document(): Y.Doc;
+    get isAttached(): boolean;
     get awareness(): Awareness | null;
     get hasUnsyncedChanges(): boolean;
     private resetUnsyncedChanges;
@@ -94,7 +96,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     get synced(): boolean;
     set synced(state: boolean);
     receiveStateless(payload: string): void;
-    connect(): Promise<void>;
+    connect(): Promise<unknown>;
     disconnect(): void;
     onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;

package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts

@@ -95,9 +95,7 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     } | null;
     constructor(configuration: HocuspocusProviderWebsocketConfiguration);
     receivedOnOpenPayload?: Event | undefined;
-    receivedOnStatusPayload?: onStatusParameters | undefined;
     onOpen(event: Event): Promise<void>;
-    onStatus(data: onStatusParameters): Promise<void>;
     attach(provider: HocuspocusProvider): void;
     detach(provider: HocuspocusProvider): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderWebsocketConfiguration>): void;

package/dist/packages/provider/src/types.d.ts

@@ -49,6 +49,9 @@ export type ConstructableOutgoingMessage = Constructable<AuthenticationMessage>
 export type onAuthenticationFailedParameters = {
     reason: string;
 };
+export type onAuthenticatedParameters = {
+    scope: 'read-write' | 'readonly';
+};
 export type onOpenParameters = {
     event: Event;
 };
@@ -65,6 +68,9 @@ export type onStatusParameters = {
 export type onSyncedParameters = {
     state: boolean;
 };
+export type onUnsyncedChangesParameters = {
+    number: number;
+};
 export type onDisconnectParameters = {
     event: CloseEvent;
 };
@@ -84,103 +90,3 @@ export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];
-export type TCollabThread<Data = any, CommentData = any> = {
-    id: string;
-    createdAt: number;
-    updatedAt: number;
-    deletedAt: number | null;
-    resolvedAt?: string;
-    comments: TCollabComment<CommentData>[];
-    deletedComments: TCollabComment<CommentData>[];
-    data: Data;
-};
-export type TCollabComment<Data = any> = {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    deletedAt?: string;
-    data: Data;
-    content: any;
-};
-export type THistoryVersion = {
-    name?: string;
-    version: number;
-    date: number;
-};
-export type THistoryConfiguration = {
-    autoVersioning: boolean;
-    currentVersion: number;
-    stateCaptured: number;
-};
-export type THistoryAction = THistoryDocumentRevertAction | THistoryVersionCreateAction | THistoryVersionPreviewAction;
-export type THistoryDocumentRevertAction = {
-    action: 'document.revert';
-    /**
-     * if changes haven't been persisted to a version yet, we'll create one with the specified name,
-     * expect when `false` is passed.
-     */
-    currentVersionName?: string | false;
-    /**
-     * Name of the version that is created after the revert. Pass `false` to avoid generating a new version.
-     */
-    newVersionName?: string | false;
-};
-export type THistoryVersionCreateAction = {
-    action: 'version.create';
-    name?: string;
-};
-export type THistoryVersionPreviewAction = {
-    action: 'version.preview';
-    version: number;
-};
-export type THistoryEvent = THistoryVersionPreviewEvent | THistoryVersionCreatedEvent | THistoryDocumentRevertedEvent;
-export type THistoryVersionCreatedEvent = {
-    event: 'version.created';
-    version: number;
-};
-export type THistoryVersionPreviewEvent = {
-    event: 'version.preview';
-    version: number;
-    ydoc: string;
-};
-export type THistoryDocumentRevertedEvent = {
-    event: 'document.reverted';
-    version: number;
-};
-export type DeleteCommentOptions = {
-    /**
-     * If `true`, the thread will also be deleted if the deleted comment was the first comment in the thread.
-     */
-    deleteThread?: boolean;
-    /**
-     * If `true`, will remove the content of the deleted comment
-     */
-    deleteContent?: boolean;
-};
-export type DeleteThreadOptions = {
-    /**
-     * If `true`, will remove the comments on the thread,
-     * otherwise will only mark the thread as deleted
-     * and keep the comments
-     * @default false
-     */
-    deleteComments?: boolean;
-    /**
-     * If `true`, will forcefully remove the thread and all comments,
-     * otherwise will only mark the thread as deleted
-     * and keep the comments
-     * @default false
-     */
-    force?: boolean;
-};
-/**
- * The type of thread
- */
-export type ThreadType = 'archived' | 'unarchived';
-export type GetThreadsOptions = {
-    /**
-     * The types of threads to get
-     * @default ['unarchived']
-     */
-    types?: Array<ThreadType>;
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "3.0.6-rc.0",
+  "version": "3.0.7-rc.0",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^3.0.6-rc.0",
+    "@hocuspocus/common": "^3.0.7-rc.0",
     "@lifeomic/attempt": "^3.0.2",
     "lib0": "^0.2.87",
     "ws": "^8.17.1"

package/src/HocuspocusProvider.ts

@@ -18,6 +18,7 @@ import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.ts'
 import { UpdateMessage } from './OutgoingMessages/UpdateMessage.ts'
 import type {
   ConstructableOutgoingMessage,
+  onAuthenticatedParameters,
   onAuthenticationFailedParameters,
   onAwarenessChangeParameters,
   onAwarenessUpdateParameters,
@@ -25,8 +26,10 @@ import type {
   onDisconnectParameters,
   onMessageParameters,
   onOpenParameters,
-  onOutgoingMessageParameters, onStatelessParameters,
+  onOutgoingMessageParameters,
+  onStatelessParameters,
   onSyncedParameters,
+  onUnsyncedChangesParameters,
 } from './types.ts'
 
 export type HocuspocusProviderConfiguration =
@@ -71,7 +74,7 @@ export interface CompleteHocuspocusProviderConfiguration {
    */
   forceSyncInterval: false | number,
 
-  onAuthenticated: () => void,
+  onAuthenticated: (data: onAuthenticatedParameters) => void,
   onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void,
   onOpen: (data: onOpenParameters) => void,
   onConnect: () => void,
@@ -84,6 +87,7 @@ export interface CompleteHocuspocusProviderConfiguration {
   onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void,
   onAwarenessChange: (data: onAwarenessChangeParameters) => void,
   onStateless: (data: onStatelessParameters) => void
+  onUnsyncedChanges: (data: onUnsyncedChangesParameters) => void
 }
 
 export class AwarenessError extends Error {
@@ -112,6 +116,7 @@ export class HocuspocusProvider extends EventEmitter {
     onAwarenessUpdate: () => null,
     onAwarenessChange: () => null,
     onStateless: () => null,
+    onUnsyncedChanges: () => null,
   }
 
   isSynced = false
@@ -125,7 +130,7 @@ export class HocuspocusProvider extends EventEmitter {
   // @internal
   manageSocket = false
 
-  private isAttached = false
+  private _isAttached = false
 
   intervals: any = {
     forceSync: null,
@@ -146,6 +151,7 @@ export class HocuspocusProvider extends EventEmitter {
     this.on('awarenessUpdate', this.configuration.onAwarenessUpdate)
     this.on('awarenessChange', this.configuration.onAwarenessChange)
     this.on('stateless', this.configuration.onStateless)
+    this.on('unsyncedChanges', this.configuration.onUnsyncedChanges)
 
     this.on('authenticated', this.configuration.onAuthenticated)
     this.on('authenticationFailed', this.configuration.onAuthenticationFailed)
@@ -190,8 +196,6 @@ export class HocuspocusProvider extends EventEmitter {
 
   forwardConnect = (e: any) => this.emit('connect', e)
 
-  // forwardOpen = (e: any) => this.emit('open', e)
-
   forwardClose = (e: any) => this.emit('close', e)
 
   forwardDisconnect = (e: any) => this.emit('disconnect', e)
@@ -214,6 +218,10 @@ export class HocuspocusProvider extends EventEmitter {
     return this.configuration.document
   }
 
+  public get isAttached() {
+    return this._isAttached
+  }
+
   get awareness() {
     return this.configuration.awareness
   }
@@ -224,12 +232,12 @@ export class HocuspocusProvider extends EventEmitter {
 
   private resetUnsyncedChanges() {
     this.unsyncedChanges = 1
-    this.emit('unsyncedChanges', this.unsyncedChanges)
+    this.emit('unsyncedChanges', { number: this.unsyncedChanges })
   }
 
   incrementUnsyncedChanges() {
     this.unsyncedChanges += 1
-    this.emit('unsyncedChanges', this.unsyncedChanges)
+    this.emit('unsyncedChanges', { number: this.unsyncedChanges })
   }
 
   decrementUnsyncedChanges() {
@@ -241,7 +249,7 @@ export class HocuspocusProvider extends EventEmitter {
       this.synced = true
     }
 
-    this.emit('unsyncedChanges', this.unsyncedChanges)
+    this.emit('unsyncedChanges', { number: this.unsyncedChanges })
   }
 
   forceSync() {
@@ -315,10 +323,18 @@ export class HocuspocusProvider extends EventEmitter {
 
   // not needed, but provides backward compatibility with e.g. lexical/yjs
   async connect() {
+    if( this.manageSocket ) {
+      return this.configuration.websocketProvider.connect()
+    }
+
     console.warn('HocuspocusProvider::connect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.')
   }
 
   disconnect() {
+    if( this.manageSocket ) {
+      return this.configuration.websocketProvider.disconnect()
+    }
+
     console.warn('HocuspocusProvider::disconnect() is deprecated and does not do anything. Please connect/disconnect on the websocketProvider, or attach/deattach providers.')
   }
 
@@ -367,6 +383,8 @@ export class HocuspocusProvider extends EventEmitter {
   }
 
   send(message: ConstructableOutgoingMessage, args: any) {
+    if( !this._isAttached ) return;
+
     const messageSender = new MessageSender(message, args)
 
     this.emit('outgoingMessage', { message: messageSender.message })
@@ -443,11 +461,11 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.configuration.websocketProvider.detach(this)
 
-    this.isAttached = false
+    this._isAttached = false
   }
 
   attach() {
-    if( this.isAttached ) return
+    if( this._isAttached ) return
 
     this.configuration.websocketProvider.on('connect', this.configuration.onConnect)
     this.configuration.websocketProvider.on('connect', this.forwardConnect)
@@ -466,7 +484,7 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.configuration.websocketProvider.attach(this)
 
-    this.isAttached = true
+    this._isAttached = true
   }
 
   permissionDeniedHandler(reason: string) {
@@ -478,7 +496,7 @@ export class HocuspocusProvider extends EventEmitter {
     this.isAuthenticated = true
     this.authorizedScope = scope
 
-    this.emit('authenticated')
+    this.emit('authenticated', { scope })
   }
 
   setAwarenessField(key: string, value: any) {

package/src/HocuspocusProviderWebsocket.ts

@@ -173,7 +173,6 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     this.on('message', this.configuration.onMessage)
     this.on('outgoingMessage', this.configuration.onOutgoingMessage)
     this.on('status', this.configuration.onStatus)
-    this.on('status', this.onStatus.bind(this))
     this.on('disconnect', this.configuration.onDisconnect)
     this.on('close', this.configuration.onClose)
     this.on('destroy', this.configuration.onDestroy)
@@ -201,26 +200,20 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
 
   receivedOnOpenPayload?: Event | undefined = undefined
 
-  receivedOnStatusPayload?: onStatusParameters | undefined = undefined
 
   async onOpen(event: Event) {
     this.cancelWebsocketRetry = undefined
     this.receivedOnOpenPayload = event
   }
 
-  async onStatus(data: onStatusParameters) {
-    this.receivedOnStatusPayload = data
-  }
-
   attach(provider: HocuspocusProvider) {
-    let connectPromise: Promise<any> | undefined
     this.configuration.providerMap.set(provider.configuration.name, provider)
 
     if (this.status === WebSocketStatus.Disconnected && this.shouldConnect) {
-      connectPromise = this.connect()
+      this.connect()
     }
 
-    if (this.receivedOnOpenPayload) {
+    if (this.receivedOnOpenPayload && this.status === WebSocketStatus.Connected) {
       provider.onOpen(this.receivedOnOpenPayload)
     }
   }
@@ -252,7 +245,6 @@ export class HocuspocusProviderWebsocket extends EventEmitter {
     }
 
     this.receivedOnOpenPayload = undefined
-    this.receivedOnStatusPayload = undefined
     this.shouldConnect = true
 
     const abortableRetry = () => {

package/src/types.ts

@@ -61,6 +61,10 @@ export type onAuthenticationFailedParameters = {
   reason: string,
 }
 
+export type onAuthenticatedParameters = {
+  scope: 'read-write' | 'readonly',
+}
+
 export type onOpenParameters = {
   event: Event,
 }
@@ -82,6 +86,10 @@ export type onSyncedParameters = {
   state: boolean,
 }
 
+export type onUnsyncedChangesParameters = {
+  number: number,
+}
+
 export type onDisconnectParameters = {
   event: CloseEvent,
 }
@@ -103,129 +111,3 @@ export type onStatelessParameters = {
 }
 
 export type StatesArray = { clientId: number, [key: string | number]: any }[]
-
-// hocuspocus-pro types
-
-export type TCollabThread<Data = any, CommentData = any> = {
-  id: string;
-  createdAt: number;
-  updatedAt: number;
-  deletedAt: number | null;
-  resolvedAt?: string; // (new Date()).toISOString()
-  comments: TCollabComment<CommentData>[];
-  deletedComments: TCollabComment<CommentData>[];
-  data: Data
-}
-
-export type TCollabComment<Data = any> = {
-  id: string;
-  createdAt: string;
-  updatedAt: string;
-  deletedAt?: string;
-  data: Data
-  content: any
-}
-
-export type THistoryVersion = {
-  name?: string;
-  version: number;
-  date: number;
-};
-
-export type THistoryConfiguration = {
-  autoVersioning: boolean;
-  currentVersion: number;
-  stateCaptured: number; // indicates whether changes have been made since the last version
-};
-
-export type THistoryAction =
-  | THistoryDocumentRevertAction
-  | THistoryVersionCreateAction
-  | THistoryVersionPreviewAction;
-
-export type THistoryDocumentRevertAction = {
-  action: 'document.revert';
-  /**
-   * if changes haven't been persisted to a version yet, we'll create one with the specified name,
-   * expect when `false` is passed.
-   */
-  currentVersionName?: string | false;
-  /**
-   * Name of the version that is created after the revert. Pass `false` to avoid generating a new version.
-   */
-  newVersionName?: string | false;
-};
-
-export type THistoryVersionCreateAction = {
-  action: 'version.create';
-  name?: string;
-};
-
-export type THistoryVersionPreviewAction = {
-  action: 'version.preview';
-  version: number;
-};
-
-export type THistoryEvent =
-  | THistoryVersionPreviewEvent
-  | THistoryVersionCreatedEvent
-  | THistoryDocumentRevertedEvent;
-
-export type THistoryVersionCreatedEvent = {
-  event: 'version.created';
-  version: number;
-};
-
-export type THistoryVersionPreviewEvent = {
-  event: 'version.preview';
-  version: number;
-  ydoc: string; // base64-encoded Uint8Array
-};
-
-export type THistoryDocumentRevertedEvent = {
-  event: 'document.reverted';
-  version: number;
-};
-
-export type DeleteCommentOptions = {
-  /**
-   * If `true`, the thread will also be deleted if the deleted comment was the first comment in the thread.
-   */
-  deleteThread?: boolean
-
-  /**
-   * If `true`, will remove the content of the deleted comment
-   */
-  deleteContent?: boolean
-}
-
-export type DeleteThreadOptions = {
-  /**
-   * If `true`, will remove the comments on the thread,
-   * otherwise will only mark the thread as deleted
-   * and keep the comments
-   * @default false
-   */
-  deleteComments?: boolean
-
-  /**
-   * If `true`, will forcefully remove the thread and all comments,
-   * otherwise will only mark the thread as deleted
-   * and keep the comments
-   * @default false
-   */
-  force?: boolean,
-}
-
-/**
- * The type of thread
- */
-export type ThreadType = 'archived' | 'unarchived'
-
-export type GetThreadsOptions = {
-  /**
-   * The types of threads to get
-   * @default ['unarchived']
-   */
-  types?: Array<ThreadType>
-}