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

package/dist/packages/extension-database/src/Database.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server';
+export interface DatabaseConfiguration {
+    /**
+     * Pass a Promise to retrieve updates from your database. The Promise should resolve to
+     * an array of items with Y.js-compatible binary data.
+     */
+    fetchUpdates: ({ documentName }: {
+        documentName: string;
+    }) => Promise<Uint8Array[]>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    storeUpdate: ({ update, documentName }: {
+        update: Buffer;
+        documentName: string;
+    }) => void;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onChange({ document, documentName }: onChangePayload): Promise<void>;
+}

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

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

package/dist/packages/extension-sqlite/src/SQLite.d.ts

@@ -0,0 +1,26 @@
+import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database';
+import sqlite3 from 'sqlite3';
+export interface SQLiteConfiguration extends DatabaseConfiguration {
+    /**
+     * Valid values are filenames, ":memory:" for an anonymous in-memory database and an empty
+     * string for an anonymous disk-based database. Anonymous databases are not persisted and
+     * when closing the database handle, their contents are lost.
+     *
+     * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback
+     */
+    database: string;
+    /**
+     * The database schema to create.
+     */
+    schema: string;
+}
+export declare class SQLite extends Database {
+    db?: sqlite3.Database;
+    configuration: SQLiteConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<SQLiteConfiguration>);
+    onListen(): Promise<void>;
+    onConfigure(): Promise<void>;
+}

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

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

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

@@ -42,7 +42,7 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<AxiosResponse<unknown, any>>;
+    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any, any>>;
     /**
      * onChange hook
      */

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

@@ -130,7 +130,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     get awareness(): Awareness;
     checkConnection(): void;
     forceSync(): void;
-    registerBeforeUnloadEventListener(): void;
+    registerEventListeners(): void;
     documentUpdateHandler(update: Uint8Array, origin: any): void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
     permissionDeniedHandler(reason: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.27",
+  "version": "1.0.0-alpha.28",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,10 +28,10 @@
     "dist"
   ],
   "dependencies": {
-    "@lifeomic/attempt": "^3.0.0",
-    "lib0": "^0.2.42",
+    "@lifeomic/attempt": "^3.0.1",
+    "lib0": "^0.2.43",
     "y-protocols": "^1.0.5",
-    "yjs": "^13.5.0"
+    "yjs": "^13.5.22"
   },
-  "gitHead": "1bbb2df1f2be4046ca7e5415cd975e469ec16145"
+  "gitHead": "8ffe8d8f4d10ba33f4f203806bd1d4415bef5dc3"
 }

package/src/HocuspocusProvider.ts

@@ -223,7 +223,7 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.document.on('update', this.documentUpdateHandler.bind(this))
     this.awareness.on('update', this.awarenessUpdateHandler.bind(this))
-    this.registerBeforeUnloadEventListener()
+    this.registerEventListeners()
 
     this.intervals.connectionChecker = setInterval(
       this.checkConnection.bind(this),
@@ -358,11 +358,12 @@ export class HocuspocusProvider extends EventEmitter {
     this.send(SyncStepOneMessage, { document: this.document })
   }
 
-  registerBeforeUnloadEventListener() {
+  registerEventListeners() {
     if (typeof window === 'undefined') {
       return
     }
 
+    window.addEventListener('online', this.connect.bind(this))
     window.addEventListener('beforeunload', () => {
       removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload')
     })
@@ -580,6 +581,12 @@ export class HocuspocusProvider extends EventEmitter {
     this.document.off('update', this.documentUpdateHandler)
 
     this.removeAllListeners()
+
+    if (typeof window === 'undefined') {
+      return
+    }
+
+    window.removeEventListener('online', this.connect.bind(this))
   }
 
   get broadcastChannel() {