@hocuspocus/extension-redis 3.0.6-rc.0 → 3.0.8-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/extension-redis",
-  "version": "3.0.6-rc.0",
+  "version": "3.0.8-rc.0",
   "description": "Scale Hocuspocus horizontally with Redis",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -33,7 +33,7 @@
     "@types/redlock": "^4.0.3"
   },
   "dependencies": {
-    "@hocuspocus/server": "^3.0.6-rc.0",
+    "@hocuspocus/server": "^3.0.8-rc.0",
     "ioredis": "^4.28.2",
     "kleur": "^4.1.4",
     "lodash.debounce": "^4.0.8",