@hocuspocus/provider 2.15.2 → 3.0.4-rc.0

package/src/IncomingMessage.ts

@@ -1,20 +1,22 @@
+import type {
+  Decoder} from 'lib0/decoding'
 import {
   createDecoder,
   peekVarString,
   readVarUint,
   readVarUint8Array,
   readVarString,
-  Decoder,
 } from 'lib0/decoding'
+import type {
+  Encoder} from 'lib0/encoding'
 import {
-  Encoder,
   createEncoder,
   writeVarUint,
   writeVarUint8Array,
   writeVarString,
   length,
 } from 'lib0/encoding'
-import { MessageType } from './types.js'
+import type { MessageType } from './types.js'
 
 export class IncomingMessage {
 

package/src/MessageReceiver.ts

@@ -2,8 +2,9 @@ import { readAuthMessage } from '@hocuspocus/common'
 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 type { CloseEvent } from 'ws'
+import type { HocuspocusProvider } from './HocuspocusProvider.js'
+import type { IncomingMessage } from './IncomingMessage.js'
 import { OutgoingMessage } from './OutgoingMessage.js'
 import { MessageType } from './types.js'
 
@@ -11,18 +12,10 @@ export class MessageReceiver {
 
   message: IncomingMessage
 
-  broadcasted = false
-
   constructor(message: IncomingMessage) {
     this.message = message
   }
 
-  public setBroadcasted(value: boolean) {
-    this.broadcasted = value
-
-    return this
-  }
-
   public apply(provider: HocuspocusProvider, emitSynced: boolean) {
     const { message } = this
     const type = message.readVarUint()
@@ -53,21 +46,29 @@ export class MessageReceiver {
       case MessageType.SyncStatus:
         this.applySyncStatusMessage(provider, readVarInt(message.decoder) === 1)
         break
+
+      case MessageType.CLOSE:
+        // eslint-disable-next-line no-case-declarations
+        const event: CloseEvent = {
+          code: 1000,
+          reason: readVarString(message.decoder),
+          // @ts-ignore
+          target: provider.configuration.websocketProvider.webSocket!,
+          type: 'close',
+        }
+        provider.onClose()
+        provider.configuration.onClose({ event })
+        provider.forwardClose(event)
+      break
+
       default:
         throw new Error(`Can’t apply message of unknown type: ${type}`)
     }
 
     // Reply
     if (message.length() > emptyMessageLength + 1) { // length of documentName (considered in emptyMessageLength plus length of yjs sync type, set in applySyncMessage)
-      if (this.broadcasted) {
-        // TODO: Some weird TypeScript error
-        // @ts-ignore
-        provider.broadcast(OutgoingMessage, { encoder: message.encoder })
-      } else {
-        // TODO: Some weird TypeScript error
-        // @ts-ignore
-        provider.send(OutgoingMessage, { encoder: message.encoder })
-      }
+      // @ts-ignore
+      provider.send(OutgoingMessage, { encoder: message.encoder })
     }
   }
 

package/src/MessageSender.ts

@@ -1,6 +1,7 @@
-import { Encoder, toUint8Array } from 'lib0/encoding'
+import type { Encoder} from 'lib0/encoding'
+import { toUint8Array } from 'lib0/encoding'
 import * as bc from 'lib0/broadcastchannel'
-import { ConstructableOutgoingMessage } from './types.js'
+import type { ConstructableOutgoingMessage } from './types.js'
 
 export class MessageSender {
 

package/src/OutgoingMessage.ts

@@ -1,5 +1,6 @@
-import { Encoder, createEncoder, toUint8Array } from 'lib0/encoding'
-import { MessageType, OutgoingMessageArguments, OutgoingMessageInterface } from './types.js'
+import type { Encoder} from 'lib0/encoding'
+import { createEncoder, toUint8Array } from 'lib0/encoding'
+import type { MessageType, OutgoingMessageArguments, OutgoingMessageInterface } from './types.js'
 
 export class OutgoingMessage implements OutgoingMessageInterface {
   encoder: Encoder

package/src/OutgoingMessages/AuthenticationMessage.ts

@@ -1,6 +1,7 @@
 import { writeVarString, writeVarUint } from 'lib0/encoding'
 import { writeAuthentication } from '@hocuspocus/common'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class AuthenticationMessage extends OutgoingMessage {

package/src/OutgoingMessages/AwarenessMessage.ts

@@ -1,6 +1,7 @@
 import * as encoding from 'lib0/encoding'
 import { encodeAwarenessUpdate } from 'y-protocols/awareness'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class AwarenessMessage extends OutgoingMessage {

package/src/OutgoingMessages/CloseMessage.ts

@@ -1,5 +1,6 @@
 import * as encoding from 'lib0/encoding'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class CloseMessage extends OutgoingMessage {

package/src/OutgoingMessages/QueryAwarenessMessage.ts

@@ -1,5 +1,6 @@
 import * as encoding from 'lib0/encoding'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class QueryAwarenessMessage extends OutgoingMessage {

package/src/OutgoingMessages/StatelessMessage.ts

@@ -1,5 +1,6 @@
 import { writeVarString, writeVarUint } from 'lib0/encoding'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class StatelessMessage extends OutgoingMessage {

package/src/OutgoingMessages/SyncStepOneMessage.ts

@@ -1,6 +1,7 @@
 import * as encoding from 'lib0/encoding'
 import * as syncProtocol from 'y-protocols/sync'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class SyncStepOneMessage extends OutgoingMessage {

package/src/OutgoingMessages/SyncStepTwoMessage.ts

@@ -1,6 +1,7 @@
 import * as encoding from 'lib0/encoding'
 import * as syncProtocol from 'y-protocols/sync'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class SyncStepTwoMessage extends OutgoingMessage {

package/src/OutgoingMessages/UpdateMessage.ts

@@ -1,6 +1,7 @@
 import { writeVarString, writeVarUint } from 'lib0/encoding'
 import { writeUpdate } from 'y-protocols/sync'
-import { MessageType, OutgoingMessageArguments } from '../types.js'
+import type { OutgoingMessageArguments } from '../types.js'
+import { MessageType } from '../types.js'
 import { OutgoingMessage } from '../OutgoingMessage.js'
 
 export class UpdateMessage extends OutgoingMessage {

package/src/index.ts

@@ -1,5 +1,3 @@
 export * from './HocuspocusProvider.js'
-export * from './TiptapCollabProvider.js'
-export * from './TiptapCollabProviderWebsocket.js'
 export * from './HocuspocusProviderWebsocket.js'
 export * from './types.js'

package/src/types.ts

@@ -1,16 +1,16 @@
-import { Encoder } from 'lib0/encoding'
+import type { Encoder } from 'lib0/encoding'
 import type { Event, MessageEvent } from 'ws'
-import { Awareness } from 'y-protocols/awareness'
-import * as Y from 'yjs'
-import { CloseEvent } from '@hocuspocus/common'
-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 type { Awareness } from 'y-protocols/awareness'
+import type * as Y from 'yjs'
+import type { CloseEvent } from '@hocuspocus/common'
+import type { IncomingMessage } from './IncomingMessage.js'
+import type { OutgoingMessage } from './OutgoingMessage.js'
+import type { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage.js'
+import type { AwarenessMessage } from './OutgoingMessages/AwarenessMessage.js'
+import type { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage.js'
+import type { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.js'
+import type { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage.js'
+import type { UpdateMessage } from './OutgoingMessages/UpdateMessage.js'
 
 export enum MessageType {
   Sync = 0,

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

@@ -1,161 +0,0 @@
-import type { AbstractType, YArrayEvent } from 'yjs';
-import * as Y from 'yjs';
-import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
-import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
-import { type DeleteCommentOptions, type DeleteThreadOptions, type GetThreadsOptions, type TCollabComment, type TCollabThread, type THistoryVersion } from './types.js';
-export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) & Pick<AdditionalTiptapCollabProviderConfiguration, 'user'> & {
-    /**
-     * Pass `true` if you want to delete a thread when the first comment is deleted.
-     */
-    deleteThreadOnFirstCommentDelete?: boolean;
-};
-export interface AdditionalTiptapCollabProviderConfiguration {
-    /**
-     * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
-     */
-    appId?: string;
-    /**
-     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
-     */
-    baseUrl?: string;
-    websocketProvider?: TiptapCollabProviderWebsocket;
-    user?: string;
-}
-export declare class TiptapCollabProvider extends HocuspocusProvider {
-    tiptapCollabConfigurationPrefix: string;
-    userData?: Y.PermanentUserData;
-    constructor(configuration: TiptapCollabProviderConfiguration);
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    createVersion(name?: string): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    revertToVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     *
-     * The server will reply with a stateless message (THistoryVersionPreviewEvent)
-     */
-    previewVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    getVersions(): THistoryVersion[];
-    watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]): void;
-    unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]): void;
-    isAutoVersioning(): boolean;
-    enableAutoVersioning(): 1;
-    disableAutoVersioning(): 0;
-    /**
-     * Returns all users in the document as Y.Map objects
-     * @returns An array of Y.Map objects
-     */
-    private getYThreads;
-    /**
-     * Finds all threads in the document and returns them as JSON objects
-     * @options Options to control the output of the threads (e.g. include deleted threads)
-     * @returns An array of threads as JSON objects
-     */
-    getThreads<Data, CommentData>(options?: GetThreadsOptions): TCollabThread<Data, CommentData>[];
-    /**
-     * Find the index of a thread by its id
-     * @param id The thread id
-     * @returns The index of the thread or null if not found
-     */
-    private getThreadIndex;
-    /**
-     * Gets a single thread by its id
-     * @param id The thread id
-     * @returns The thread as a JSON object or null if not found
-     */
-    getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null;
-    /**
-     * Gets a single thread by its id as a Y.Map object
-     * @param id The thread id
-     * @returns The thread as a Y.Map object or null if not found
-     */
-    private getYThread;
-    /**
-     * Create a new thread
-     * @param data The thread data
-     * @returns The created thread
-     */
-    createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'deletedAt' | 'comments' | 'deletedComments'>): TCollabThread;
-    /**
-     * Update a specific thread
-     * @param id The thread id
-     * @param data New data for the thread
-     * @returns The updated thread or null if the thread is not found
-     */
-    updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data'> & {
-        resolvedAt: TCollabThread['resolvedAt'] | null;
-    }>): TCollabThread;
-    /**
-     * Handle the deletion of a thread. By default, the thread and it's comments are not deleted, but marked as deleted
-     * via the `deletedAt` property. Forceful deletion can be enabled by setting the `force` option to `true`.
-     *
-     * If you only want to delete the comments of a thread, you can set the `deleteComments` option to `true`.
-     * @param id The thread id
-     * @param options A set of options that control how the thread is deleted
-     * @returns The deleted thread or null if the thread is not found
-     */
-    deleteThread(id: TCollabThread['id'], options?: DeleteThreadOptions): TCollabThread | null | undefined;
-    /**
-     * Tries to restore a deleted thread
-     * @param id The thread id
-     * @returns The restored thread or null if the thread is not found
-     */
-    restoreThread(id: TCollabThread['id']): TCollabThread | null;
-    /**
-     * Returns comments from a thread, either deleted or not
-     * @param threadId The thread id
-     * @param includeDeleted If you want to include deleted comments, defaults to `false`
-     * @returns The comments or null if the thread is not found
-     */
-    getThreadComments(threadId: TCollabThread['id'], includeDeleted?: boolean): TCollabComment[] | null;
-    /**
-     * Get a single comment from a specific thread
-     * @param threadId The thread id
-     * @param commentId The comment id
-     * @param includeDeleted If you want to include deleted comments in the search
-     * @returns The comment or null if not found
-     */
-    getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], includeDeleted?: boolean): TCollabComment | null;
-    /**
-     * Adds a comment to a thread
-     * @param threadId The thread id
-     * @param data The comment data
-     * @returns The updated thread or null if the thread is not found
-     * @example addComment('123', { content: 'Hello world', data: { author: 'Maria Doe' } })
-     */
-    addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread;
-    /**
-     * Update a comment in a thread
-     * @param threadId The thread id
-     * @param commentId The comment id
-     * @param data The new comment data
-     * @returns The updated thread or null if the thread or comment is not found
-     * @example updateComment('123', { content: 'The new content', data: { attachments: ['file1.jpg'] }})
-     */
-    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread;
-    /**
-     * Deletes a comment from a thread
-     * @param threadId The thread id
-     * @param commentId The comment id
-     * @param options A set of options that control how the comment is deleted
-     * @returns The updated thread or null if the thread or comment is not found
-     */
-    deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], options?: DeleteCommentOptions): TCollabThread | null | undefined;
-    /**
-     * Start watching threads for changes
-     * @param callback The callback function to be called when a thread changes
-     */
-    watchThreads(callback: () => void): void;
-    /**
-     * Stop watching threads for changes
-     * @param callback The callback function to be removed
-     */
-    unwatchThreads(callback: () => void): void;
-}

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

@@ -1,19 +0,0 @@
-import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.js';
-export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
-export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
-    /**
-     * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
-     */
-    appId?: string;
-    /**
-     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
-     */
-    baseUrl?: string;
-    /**
-     * Only fill this if you are using Tiptap Collab HA.
-     */
-    shardKey?: string;
-}
-export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
-    constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
-}

package/dist/packages/server/src/Debugger.d.ts

@@ -1,14 +0,0 @@
-export declare class Debugger {
-    logs: any[];
-    listen: boolean;
-    output: boolean;
-    enable(): void;
-    disable(): void;
-    verbose(): void;
-    quiet(): void;
-    log(message: any): this;
-    flush(): this;
-    get(): {
-        logs: any[];
-    };
-}

package/dist/tests/server/getMessageLogs.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/server/requiresAuthentication.d.ts

@@ -1 +0,0 @@
-export {};