@hocuspocus/provider 1.0.0-alpha.26 → 1.0.0-alpha.27

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

@@ -1,4 +1,4 @@
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
 export interface LoggerConfiguration {
     /**
      * Prepend all logging message with a string.
@@ -30,10 +30,6 @@ export interface LoggerConfiguration {
      * 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.
      */
@@ -54,15 +50,13 @@ export declare class Logger implements Extension {
      * Constructor
      */
     constructor(configuration?: Partial<LoggerConfiguration>);
+    onConfigure(data: onConfigurePayload): Promise<void>;
     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/provider/src/HocuspocusCloudProvider.d.ts

@@ -0,0 +1,10 @@
+import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider';
+export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
+    /**
+     * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+     */
+    key: string;
+}
+export declare class HocuspocusCloudProvider extends HocuspocusProvider {
+    constructor(options: HocuspocusCloudProviderOptions);
+}

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

@@ -1,3 +1,4 @@
 export * from './HocuspocusProvider';
+export * from './HocuspocusCloudProvider';
 export * from './types';
 export * from './utils';

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

@@ -3,13 +3,15 @@ import WebSocket, { WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import { Configuration, Hook } from './types';
 import { MessageLogger } from './Debugger';
+import { onListenPayload } from '.';
 export declare const defaultConfiguration: {
     name: null;
     port: number;
     timeout: number;
+    quiet: boolean;
 };
 /**
- * Hocuspocus server
+ * Hocuspocus Server
  */
 export declare class Hocuspocus {
     configuration: Configuration;
@@ -25,7 +27,8 @@ export declare class Hocuspocus {
     /**
      * Start the server
      */
-    listen(): Promise<void>;
+    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any): Promise<void>;
+    private showStartScreen;
     /**
      * Get the total number of active documents
      */
@@ -75,7 +78,7 @@ export declare class Hocuspocus {
      * Get document name by the given request
      * @private
      */
-    private static getDocumentName;
+    private getDocumentNameFromRequest;
     enableDebugging(): void;
     enableMessageLogging(): void;
     disableLogging(): void;

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

@@ -67,6 +67,18 @@ export interface Configuration extends Extension {
      * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
      */
     timeout: number;
+    /**
+     * By default, the servers show a start screen. If passed false, the server will start quietly.
+     */
+    quiet: boolean;
+    /**
+     * Function which returns the (customized) document name based on the request
+     */
+    getDocumentName?(data: {
+        documentName: string;
+        request: IncomingMessage;
+        requestParameters: URLSearchParams;
+    }): string | Promise<string>;
 }
 export interface onAuthenticatePayload {
     documentName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.26",
+  "version": "1.0.0-alpha.27",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -33,5 +33,5 @@
     "y-protocols": "^1.0.5",
     "yjs": "^13.5.0"
   },
-  "gitHead": "0d060abd95ec14eb7e404270e1e2338b2a0db332"
+  "gitHead": "1bbb2df1f2be4046ca7e5415cd975e469ec16145"
 }

package/src/HocuspocusCloudProvider.ts

@@ -0,0 +1,26 @@
+import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider'
+
+export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
+  /**
+   * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+   */
+  key: string,
+}
+
+export class HocuspocusCloudProvider extends HocuspocusProvider {
+  constructor(options: HocuspocusCloudProviderOptions) {
+    if (!options.url) {
+      options.url = 'wss://connect.hocuspocus.cloud'
+    }
+
+    if (options.key) {
+      if (!options.parameters) {
+        options.parameters = {}
+      }
+
+      options.parameters.key = options.key
+    }
+
+    super(options as HocuspocusProviderOptions)
+  }
+}

package/src/HocuspocusProvider.ts

@@ -195,6 +195,7 @@ export class HocuspocusProvider extends EventEmitter {
     super()
     this.setOptions(options)
 
+    this.options.document = options.document ? options.document : new Y.Doc()
     this.options.awareness = options.awareness ? options.awareness : new Awareness(this.document)
     this.options.WebSocketPolyfill = options.WebSocketPolyfill ? options.WebSocketPolyfill : WebSocket
 

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './HocuspocusProvider'
+export * from './HocuspocusCloudProvider'
 export * from './types'
 export * from './utils'