@hocuspocus/provider 1.0.0-alpha.4 → 1.0.0-alpha.40

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

@@ -1,70 +1,211 @@
 /// <reference types="node" />
 import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
 import { URLSearchParams } from 'url';
-import { Socket } from 'net';
+import { Awareness } from 'y-protocols/awareness';
 import Document from './Document';
+import { Hocuspocus } from './Hocuspocus';
 export declare enum MessageType {
+    Unknown = -1,
     Sync = 0,
-    Awareness = 1
-}
-export declare enum WsReadyStates {
-    Closing = 2,
-    Closed = 3
+    Awareness = 1,
+    Auth = 2,
+    QueryAwareness = 3,
+    SyncReply = 4
 }
 export interface AwarenessUpdate {
     added: Array<any>;
     updated: Array<any>;
     removed: Array<any>;
 }
+export interface ConnectionConfiguration {
+    readOnly: boolean;
+    requiresAuthentication: boolean;
+    isAuthenticated: boolean;
+}
 export interface Extension {
-    onChange(data: onChangePayload): Promise<any>;
-    onConnect(data: onConnectPayload): Promise<any>;
-    onConfigure(data: onConfigurePayload): Promise<any>;
-    onCreateDocument(data: onCreateDocumentPayload): Promise<any>;
-    onDestroy(data: onDestroyPayload): Promise<any>;
-    onDisconnect(data: onDisconnectPayload): Promise<any>;
-    onListen(data: onListenPayload): Promise<any>;
-    onRequest(data: onRequestPayload): Promise<any>;
-    onUpgrade(data: onUpgradePayload): Promise<any>;
+    priority?: number;
+    onConfigure?(data: onConfigurePayload): Promise<any>;
+    onListen?(data: onListenPayload): Promise<any>;
+    onUpgrade?(data: onUpgradePayload): Promise<any>;
+    onConnect?(data: onConnectPayload): Promise<any>;
+    connected?(data: connectedPayload): Promise<any>;
+    onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    /**
+     * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+     */
+    onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    afterLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onChange?(data: onChangePayload): Promise<any>;
+    onStoreDocument?(data: onStoreDocumentPayload): Promise<any>;
+    afterStoreDocument?(data: afterStoreDocumentPayload): Promise<any>;
+    onAwarenessUpdate?(data: onAwarenessUpdatePayload): Promise<any>;
+    onRequest?(data: onRequestPayload): Promise<any>;
+    onDisconnect?(data: onDisconnectPayload): Promise<any>;
+    onDestroy?(data: onDestroyPayload): Promise<any>;
 }
+export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 
+/**
+ * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+ */
+'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
 export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
+    /**
+     * A list of hocuspocus extenions.
+     */
     extensions: Array<Extension>;
+    /**
+     * The port which the server listens on.
+     */
     port: number | null;
+    /**
+     * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
+     */
     timeout: number;
+    /**
+     * Debounces the call of the `onStoreDocument` hook for the given amount of time in ms.
+     * Otherwise every single update would be persisted.
+     */
+    debounce: number;
+    /**
+     * Makes sure to call `onStoreDocument` at least in the given amount of time (ms).
+     */
+    maxDebounce: number;
+    /**
+     * By default, the servers show a start screen. If passed false, the server will start quietly.
+     */
+    quiet: boolean;
+    /**
+     * options to pass to the ydoc document
+     */
+    yDocOptions: {
+        gc: boolean;
+        gcFilter: () => boolean;
+    };
+    /**
+     * Function which returns the (customized) document name based on the request
+     */
+    getDocumentName?(data: getDocumentNamePayload): string | Promise<string>;
+}
+export interface getDocumentNamePayload {
+    documentName: string;
+    request: IncomingMessage;
+    requestParameters: URLSearchParams;
+}
+export interface onAuthenticatePayload {
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    token: string;
+    connection: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     documentName: string;
+    instance: Hocuspocus;
     request: IncomingMessage;
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: {
-        readOnly: boolean;
-    };
+    connection: ConnectionConfiguration;
+}
+export interface connectedPayload {
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+export interface onLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
 }
-export interface onCreateDocumentPayload {
+export interface afterLoadDocumentPayload {
     context: any;
     document: Document;
     documentName: string;
+    instance: Hocuspocus;
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
+    connection: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
     context: any;
     document: Document;
     documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+}
+export interface onStoreDocumentPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+}
+export interface afterStoreDocumentPayload extends onStoreDocumentPayload {
+}
+export interface onAwarenessUpdatePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     update: Uint8Array;
     socketId: string;
+    added: number[];
+    updated: number[];
+    removed: number[];
+    awareness: Awareness;
+    states: StatesArray;
+}
+export declare type StatesArray = {
+    clientId: number;
+    [key: string | number]: any;
+}[];
+export interface fetchPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+export interface storePayload extends onStoreDocumentPayload {
+    state: Buffer;
 }
 export interface onDisconnectPayload {
     clientsCount: number;
     context: any;
     document: Document;
     documentName: string;
+    instance: Hocuspocus;
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
@@ -72,23 +213,24 @@ export interface onDisconnectPayload {
 export interface onRequestPayload {
     request: IncomingMessage;
     response: ServerResponse;
+    instance: Hocuspocus;
 }
 export interface onUpgradePayload {
-    head: any;
     request: IncomingMessage;
-    socket: Socket;
+    socket: any;
+    head: any;
+    instance: Hocuspocus;
 }
 export interface onListenPayload {
+    instance: Hocuspocus;
+    configuration: Configuration;
     port: number;
 }
 export interface onDestroyPayload {
+    instance: Hocuspocus;
 }
 export interface onConfigurePayload {
+    instance: Hocuspocus;
     configuration: Configuration;
     version: string;
-    yjsVersion: string;
-}
-export interface CloseEvent {
-    code: number;
-    reason: string;
 }

package/dist/playground/backend/src/slow.d.ts

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

package/dist/playground/backend/src/webhook.d.ts

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

package/dist/tests/extension-database/fetch.d.ts

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

package/dist/tests/extension-logger/onListen.d.ts

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

package/dist/tests/extension-redis/closeConnections.d.ts

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

package/dist/tests/extension-redis/getConnectionCount.d.ts

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

package/dist/tests/extension-redis/getDocumentsCount.d.ts

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

package/dist/tests/extension-redis/onAwarenessChange.d.ts

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

package/dist/tests/extension-redis/onChange.d.ts

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

package/dist/tests/extension-redis/onStoreDocument.d.ts

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

package/dist/tests/extension-throttle/configuration.d.ts

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

package/dist/tests/provider/configuration.d.ts

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

package/dist/tests/provider/observe.d.ts

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

package/dist/tests/provider/observeDeep.d.ts

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

package/dist/tests/provider/onAuthenticated.d.ts

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

package/dist/tests/provider/onAuthenticationFailed.d.ts

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

package/dist/tests/provider/onAwarenessChange.d.ts

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

package/dist/tests/provider/onAwarenessUpdate.d.ts

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

package/dist/tests/provider/onClose.d.ts

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

package/dist/tests/provider/onConnect.d.ts

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

package/dist/tests/provider/onDisconnect.d.ts

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

package/dist/tests/provider/onMessage.d.ts

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

package/dist/tests/provider/onOpen.d.ts

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

package/dist/tests/provider/onSynced.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/tests/transformer/TiptapTransformer.d.ts

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

package/dist/tests/utils/createDirectory.d.ts

@@ -0,0 +1 @@
+export declare const createDirectory: (dir: string) => void;

package/dist/tests/utils/flushRedis.d.ts

@@ -0,0 +1 @@
+export declare const flushRedis: () => Promise<string>;

package/dist/tests/utils/index.d.ts

@@ -0,0 +1,8 @@
+export * from './createDirectory';
+export * from './flushRedis';
+export * from './newHocuspocus';
+export * from './newHocuspocusProvider';
+export * from './randomInteger';
+export * from './redisConnectionSettings';
+export * from './removeDirectory';
+export * from './sleep';

package/dist/tests/utils/newHocuspocus.d.ts

@@ -0,0 +1,2 @@
+import { Hocuspocus, Configuration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Hocuspocus;

package/dist/tests/utils/newHocuspocusProvider.d.ts

@@ -0,0 +1,3 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from '@hocuspocus/provider';
+import { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderConfiguration, 'url'>>) => HocuspocusProvider;

package/dist/tests/utils/randomInteger.d.ts

@@ -0,0 +1 @@
+export declare const randomInteger: (min: number, max: number) => number;

package/dist/tests/utils/redisConnectionSettings.d.ts

@@ -0,0 +1,4 @@
+export declare const redisConnectionSettings: {
+    host: string;
+    port: number;
+};

package/dist/tests/utils/removeDirectory.d.ts

@@ -0,0 +1 @@
+export declare const removeDirectory: (dir: string) => void;

package/dist/tests/utils/retryableAssertion.d.ts

@@ -0,0 +1,2 @@
+import { ExecutionContext } from 'ava';
+export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;

package/dist/tests/utils/sleep.d.ts

@@ -0,0 +1 @@
+export declare const sleep: (time: number) => Promise<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.40",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -11,24 +11,28 @@
   ],
   "license": "MIT",
   "type": "module",
-  "main": "dist/hocuspocus-provider.esm.js",
+  "main": "dist/hocuspocus-provider.cjs",
   "module": "dist/hocuspocus-provider.esm.js",
-  "types": "dist/packages/logger/src/index.d.ts",
+  "types": "dist/packages/provider/src/index.d.ts",
   "exports": {
-    "import": "./dist/hocuspocus-provider.esm.js",
-    "require": "./dist/hocuspocus-provider.js"
+    "source": {
+      "import": "./src"
+    },
+    "default": {
+      "import": "./dist/hocuspocus-provider.esm.js",
+      "require": "./dist/hocuspocus-provider.cjs"
+    }
   },
   "files": [
     "src",
     "dist"
   ],
   "dependencies": {
-    "lib0": "^0.2.42",
+    "@hocuspocus/common": "^1.0.0-alpha.12",
+    "@lifeomic/attempt": "^3.0.2",
+    "lib0": "^0.2.46",
     "y-protocols": "^1.0.5",
-    "yjs": "^13.5.8"
+    "yjs": "^13.5.29"
   },
-  "gitHead": "9e1f9b46ab3c1dbbe2f42384f91751bc5c56c5b8",
-  "publishConfig": {
-    "access": "public"
-  }
+  "gitHead": "6865794352a68372a54c579040513e45aac422d1"
 }

package/src/EventEmitter.ts

@@ -36,7 +36,7 @@ export default class EventEmitter {
     return this
   }
 
-  protected removeAllListeners(): void {
+  removeAllListeners(): void {
     this.callbacks = {}
   }
 }

package/src/HocuspocusCloudProvider.ts

@@ -0,0 +1,34 @@
+import {
+  HocuspocusProvider,
+  HocuspocusProviderConfiguration,
+} from './HocuspocusProvider'
+
+export type HocuspocusCloudProviderConfiguration =
+  Required<Pick<HocuspocusProviderConfiguration, 'name'>> &
+  Partial<HocuspocusProviderConfiguration> &
+  AdditionalHocuspocusCloudProviderConfiguration
+
+export interface AdditionalHocuspocusCloudProviderConfiguration {
+  /**
+   * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+   */
+  key: string,
+}
+
+export class HocuspocusCloudProvider extends HocuspocusProvider {
+  constructor(configuration: HocuspocusCloudProviderConfiguration) {
+    if (!configuration.url) {
+      configuration.url = 'wss://connect.hocuspocus.cloud'
+    }
+
+    if (configuration.key) {
+      if (!configuration.parameters) {
+        configuration.parameters = {}
+      }
+
+      configuration.parameters.key = configuration.key
+    }
+
+    super(configuration as HocuspocusProviderConfiguration)
+  }
+}