@hocuspocus/extension-throttle 1.0.0-alpha.31 → 1.0.0-alpha.35

package/dist/packages/extension-logger/src/Logger.d.ts

@@ -0,0 +1,68 @@
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+export interface LoggerConfiguration {
+    /**
+     * Prepend all logging message with a string.
+     *
+     * @deprecated
+     */
+    prefix: null | string;
+    /**
+     * Whether to log something for the `onLoadDocument` hook.
+     */
+    onLoadDocument: boolean;
+    /**
+     * Whether to log something for the `onChange` hook.
+     */
+    onChange: boolean;
+    /**
+     * Whether to log something for the `onConnect` hook.
+     */
+    onConnect: boolean;
+    /**
+     * Whether to log something for the `onDisconnect` hook.
+     */
+    onDisconnect: boolean;
+    /**
+     * Whether to log something for the `onUpgrade` hook.
+     */
+    onUpgrade: boolean;
+    /**
+     * Whether to log something for the `onRequest` hook.
+     */
+    onRequest: boolean;
+    /**
+     * Whether to log something for the `onListen` hook.
+     */
+    onListen: boolean;
+    /**
+     * Whether to log something for the `onDestroy` hook.
+     */
+    onDestroy: boolean;
+    /**
+     * Whether to log something for the `onConfigure` hook.
+     */
+    onConfigure: boolean;
+    /**
+     * A log function, if none is provided output will go to console
+     */
+    log: (...args: any[]) => void;
+}
+export declare class Logger implements Extension {
+    name: string | null;
+    configuration: LoggerConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<LoggerConfiguration>);
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    onChange(data: onChangePayload): Promise<void>;
+    onConnect(data: onConnectPayload): Promise<void>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onUpgrade(data: onUpgradePayload): Promise<void>;
+    onRequest(data: onRequestPayload): Promise<void>;
+    onListen(data: onListenPayload): Promise<void>;
+    onDestroy(data: onDestroyPayload): Promise<void>;
+    onConfigure(data: onConfigurePayload): Promise<void>;
+    private logRawText;
+    private log;
+}

package/dist/packages/extension-logger/src/index.d.ts

@@ -0,0 +1 @@
+export * from './Logger';

package/dist/packages/{monitor → extension-monitor}/src/Collector.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Configuration, onConnectPayload, onDisconnectPayload, onCreateDocumentPayload, onChangePayload } from '@hocuspocus/server';
+import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPayload, onChangePayload } from '@hocuspocus/server';
 export declare class Collector {
     serverConfiguration: Partial<Configuration>;
     version: string;
@@ -30,7 +30,7 @@ export declare class Collector {
     connectionCount(): {
         count: string | number;
     };
-    createDocument(data: onCreateDocumentPayload): {
+    createDocument(data: onLoadDocumentPayload): {
         action: string;
         document: any;
         documentName: string;

package/dist/packages/{monitor → extension-monitor}/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onCreateDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
 import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
 import { Storage } from './Storage';
@@ -32,7 +32,7 @@ export declare class Monitor implements Extension {
     onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
     onConnect(data: onConnectPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;
     onConfigure(data: onConfigurePayload): Promise<void>;
 }

package/dist/packages/{redis → extension-redis}/src/Redis.d.ts

@@ -1,5 +1,5 @@
 import { RedisPersistence } from 'y-redis';
-import { Extension, onConnectPayload, onCreateDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import { Extension, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
 export interface Configuration {
 }
 export declare class Redis implements Extension {
@@ -10,7 +10,7 @@ export declare class Redis implements Extension {
      * Constructor
      */
     constructor(configuration?: Partial<Configuration>);
-    onCreateDocument(data: onCreateDocumentPayload): Promise<import("yjs").Doc | undefined>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<import("yjs").Doc | undefined>;
     onConnect(data: onConnectPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
 }

package/dist/packages/{rocksdb → extension-rocksdb}/src/index.d.ts

@@ -1,4 +1,4 @@
-import { Extension, onCreateDocumentPayload } from '@hocuspocus/server';
+import { Extension, onLoadDocumentPayload } from '@hocuspocus/server';
 import { LeveldbPersistence } from 'y-leveldb';
 export interface Configuration {
     options: object | undefined;
@@ -12,9 +12,9 @@ export declare class RocksDB implements Extension {
      */
     constructor(configuration?: Partial<Configuration>);
     /**
-     * onCreateDocument hook
+     * onLoadDocument hook
      */
-    onCreateDocument(data: onCreateDocumentPayload): Promise<any>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
     /**
      * store updates in y-leveldb persistence
      */

package/dist/packages/{webhook → extension-webhook}/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConnectPayload, onCreateDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
 import { Doc } from 'yjs';
 import { Transformer } from '@hocuspocus/transformer';
 import { AxiosResponse } from 'axios';
@@ -48,9 +48,9 @@ export declare class Webhook implements Extension {
      */
     onChange(data: onChangePayload): Promise<void>;
     /**
-     * onCreateDocument hook
+     * onLoadDocument hook
      */
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     /**
      * onConnect hook
      */

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

@@ -108,7 +108,7 @@ export interface HocuspocusProviderOptions {
 export declare class HocuspocusProvider extends EventEmitter {
     options: HocuspocusProviderOptions;
     subscribedToBroadcastChannel: boolean;
-    webSocket: any;
+    webSocket: WebSocket | null;
     shouldConnect: boolean;
     status: WebSocketStatus;
     isSynced: boolean;

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

@@ -4,6 +4,7 @@ import { IncomingMessage, Server as HTTPServer } from 'http';
 import { Configuration } from './types';
 import { MessageLogger } from './Debugger';
 export declare const defaultConfiguration: {
+    name: null;
     port: number;
     timeout: number;
 };

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

@@ -6,5 +6,5 @@ export declare class MessageReceiver {
     debugger: MessageLogger;
     constructor(message: IncomingMessage);
     apply(connection: Connection): void;
-    readSyncMessage(message: IncomingMessage, connection: Connection): 0 | 1 | 2;
+    readSyncMessage(message: IncomingMessage, connection: Connection): 0 | 2 | 1;
 }

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

@@ -34,7 +34,11 @@ export interface Extension {
     onChange?(data: onChangePayload): Promise<any>;
     onConnect?(data: onConnectPayload): Promise<any>;
     onConfigure?(data: onConfigurePayload): Promise<any>;
-    onCreateDocument?(data: onCreateDocumentPayload): Promise<any>;
+    /**
+     * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+     */
+    onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onListen?(data: onListenPayload): Promise<any>;
@@ -42,6 +46,10 @@ export interface Extension {
     onUpgrade?(data: onUpgradePayload): Promise<any>;
 }
 export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
     /**
      * A list of hocuspocus extenions.
      */
@@ -73,7 +81,7 @@ export interface onConnectPayload {
     socketId: string;
     connection: ConnectionConfig;
 }
-export interface onCreateDocumentPayload {
+export interface onLoadDocumentPayload {
     context: any;
     document: Document;
     documentName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-throttle",
-  "version": "1.0.0-alpha.31",
+  "version": "1.0.0-alpha.35",
   "description": "hocuspocus throttle extension",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -12,17 +12,22 @@
   "type": "module",
   "main": "dist/hocuspocus-throttle.esm.js",
   "module": "dist/hocuspocus-throttle.esm.js",
-  "types": "dist/packages/throttle/src/index.d.ts",
+  "types": "dist/packages/extension-throttle/src/index.d.ts",
   "exports": {
-    "import": "./dist/hocuspocus-throttle.esm.js",
-    "require": "./dist/hocuspocus-throttle.cjs"
+    "development": {
+      "import": "./src"
+    },
+    "default": {
+      "import": "./dist/hocuspocus-throttle.esm.js",
+      "require": "./dist/hocuspocus-throttle.cjs"
+    }
   },
   "files": [
     "src",
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^1.0.0-alpha.75"
+    "@hocuspocus/server": "^1.0.0-alpha.79"
   },
-  "gitHead": "49a520f1b6be37139f5c7243a484dc413640869c"
+  "gitHead": "f9f5acf828d4a1f5ae4df8188000b5c3873e18cf"
 }

package/dist/packages/logger/src/index.d.ts

@@ -1,13 +0,0 @@
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onCreateDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
-export declare class Logger implements Extension {
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
-    onChange(data: onChangePayload): Promise<void>;
-    onConnect(data: onConnectPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onUpgrade(data: onUpgradePayload): Promise<void>;
-    onRequest(data: onRequestPayload): Promise<void>;
-    onListen(data: onListenPayload): Promise<void>;
-    onDestroy(data: onDestroyPayload): Promise<void>;
-    onConfigure(data: onConfigurePayload): Promise<void>;
-    private static log;
-}