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

package/src/types.ts

@@ -3,14 +3,14 @@ import type { Event, MessageEvent } from 'ws'
 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'
+import type { IncomingMessage } from './IncomingMessage.ts'
+import type { OutgoingMessage } from './OutgoingMessage.ts'
+import type { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage.ts'
+import type { AwarenessMessage } from './OutgoingMessages/AwarenessMessage.ts'
+import type { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage.ts'
+import type { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.ts'
+import type { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage.ts'
+import type { UpdateMessage } from './OutgoingMessages/UpdateMessage.ts'
 
 export enum MessageType {
   Sync = 0,
@@ -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>
-}

package/dist/playground/frontend/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;