@hocuspocus/extension-logger 2.1.0-alpha.0 → 2.1.0

package/dist/hocuspocus-logger.cjs

@@ -2,88 +2,88 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-class Logger {
-    /**
-     * Constructor
-     */
-    constructor(configuration) {
-        this.name = null;
-        this.configuration = {
-            prefix: null,
-            onLoadDocument: true,
-            onChange: true,
-            onStoreDocument: true,
-            onConnect: true,
-            onDisconnect: true,
-            onUpgrade: true,
-            onRequest: true,
-            onDestroy: true,
-            onConfigure: true,
-            log: console.log, // eslint-disable-line
-        };
-        this.configuration = {
-            ...this.configuration,
-            ...configuration,
-        };
-    }
-    async onConfigure(data) {
-        this.name = data.instance.configuration.name;
-        if (!this.configuration.onConfigure) {
-            return;
-        }
-        if (this.configuration.prefix) {
-            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
-        }
-    }
-    async onLoadDocument(data) {
-        if (this.configuration.onLoadDocument) {
-            this.log(`Loaded document "${data.documentName}".`);
-        }
-    }
-    async onChange(data) {
-        if (this.configuration.onChange) {
-            this.log(`Document "${data.documentName}" changed.`);
-        }
-    }
-    async onStoreDocument(data) {
-        if (this.configuration.onStoreDocument) {
-            this.log(`Store "${data.documentName}".`);
-        }
-    }
-    async onConnect(data) {
-        if (this.configuration.onConnect) {
-            this.log(`New connection to "${data.documentName}".`);
-        }
-    }
-    async onDisconnect(data) {
-        if (this.configuration.onDisconnect) {
-            this.log(`Connection to "${data.documentName}" closed.`);
-        }
-    }
-    async onUpgrade(data) {
-        if (this.configuration.onUpgrade) {
-            this.log('Upgrading connection …');
-        }
-    }
-    async onRequest(data) {
-        if (this.configuration.onRequest) {
-            this.log(`Incoming HTTP Request to ${data.request.url}`);
-        }
-    }
-    async onDestroy(data) {
-        if (this.configuration.onDestroy) {
-            this.log('Shut down.');
-        }
-    }
-    log(message) {
-        const date = (new Date()).toISOString();
-        let meta = `${date}`;
-        if (this.name) {
-            meta = `${this.name} ${meta}`;
-        }
-        message = `[${meta}] ${message}`;
-        this.configuration.log(message);
-    }
+class Logger {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
+        this.name = null;
+        this.configuration = {
+            prefix: null,
+            onLoadDocument: true,
+            onChange: true,
+            onStoreDocument: true,
+            onConnect: true,
+            onDisconnect: true,
+            onUpgrade: true,
+            onRequest: true,
+            onDestroy: true,
+            onConfigure: true,
+            log: console.log, // eslint-disable-line
+        };
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+    }
+    async onConfigure(data) {
+        this.name = data.instance.configuration.name;
+        if (!this.configuration.onConfigure) {
+            return;
+        }
+        if (this.configuration.prefix) {
+            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
+        }
+    }
+    async onLoadDocument(data) {
+        if (this.configuration.onLoadDocument) {
+            this.log(`Loaded document "${data.documentName}".`);
+        }
+    }
+    async onChange(data) {
+        if (this.configuration.onChange) {
+            this.log(`Document "${data.documentName}" changed.`);
+        }
+    }
+    async onStoreDocument(data) {
+        if (this.configuration.onStoreDocument) {
+            this.log(`Store "${data.documentName}".`);
+        }
+    }
+    async onConnect(data) {
+        if (this.configuration.onConnect) {
+            this.log(`New connection to "${data.documentName}".`);
+        }
+    }
+    async onDisconnect(data) {
+        if (this.configuration.onDisconnect) {
+            this.log(`Connection to "${data.documentName}" closed.`);
+        }
+    }
+    async onUpgrade(data) {
+        if (this.configuration.onUpgrade) {
+            this.log('Upgrading connection …');
+        }
+    }
+    async onRequest(data) {
+        if (this.configuration.onRequest) {
+            this.log(`Incoming HTTP Request to ${data.request.url}`);
+        }
+    }
+    async onDestroy(data) {
+        if (this.configuration.onDestroy) {
+            this.log('Shut down.');
+        }
+    }
+    log(message) {
+        const date = (new Date()).toISOString();
+        let meta = `${date}`;
+        if (this.name) {
+            meta = `${this.name} ${meta}`;
+        }
+        message = `[${meta}] ${message}`;
+        this.configuration.log(message);
+    }
 }
 
 exports.Logger = Logger;

package/dist/hocuspocus-logger.esm.js

@@ -1,85 +1,85 @@
-class Logger {
-    /**
-     * Constructor
-     */
-    constructor(configuration) {
-        this.name = null;
-        this.configuration = {
-            prefix: null,
-            onLoadDocument: true,
-            onChange: true,
-            onStoreDocument: true,
-            onConnect: true,
-            onDisconnect: true,
-            onUpgrade: true,
-            onRequest: true,
-            onDestroy: true,
-            onConfigure: true,
-            log: console.log, // eslint-disable-line
-        };
-        this.configuration = {
-            ...this.configuration,
-            ...configuration,
-        };
-    }
-    async onConfigure(data) {
-        this.name = data.instance.configuration.name;
-        if (!this.configuration.onConfigure) {
-            return;
-        }
-        if (this.configuration.prefix) {
-            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
-        }
-    }
-    async onLoadDocument(data) {
-        if (this.configuration.onLoadDocument) {
-            this.log(`Loaded document "${data.documentName}".`);
-        }
-    }
-    async onChange(data) {
-        if (this.configuration.onChange) {
-            this.log(`Document "${data.documentName}" changed.`);
-        }
-    }
-    async onStoreDocument(data) {
-        if (this.configuration.onStoreDocument) {
-            this.log(`Store "${data.documentName}".`);
-        }
-    }
-    async onConnect(data) {
-        if (this.configuration.onConnect) {
-            this.log(`New connection to "${data.documentName}".`);
-        }
-    }
-    async onDisconnect(data) {
-        if (this.configuration.onDisconnect) {
-            this.log(`Connection to "${data.documentName}" closed.`);
-        }
-    }
-    async onUpgrade(data) {
-        if (this.configuration.onUpgrade) {
-            this.log('Upgrading connection …');
-        }
-    }
-    async onRequest(data) {
-        if (this.configuration.onRequest) {
-            this.log(`Incoming HTTP Request to ${data.request.url}`);
-        }
-    }
-    async onDestroy(data) {
-        if (this.configuration.onDestroy) {
-            this.log('Shut down.');
-        }
-    }
-    log(message) {
-        const date = (new Date()).toISOString();
-        let meta = `${date}`;
-        if (this.name) {
-            meta = `${this.name} ${meta}`;
-        }
-        message = `[${meta}] ${message}`;
-        this.configuration.log(message);
-    }
+class Logger {
+    /**
+     * Constructor
+     */
+    constructor(configuration) {
+        this.name = null;
+        this.configuration = {
+            prefix: null,
+            onLoadDocument: true,
+            onChange: true,
+            onStoreDocument: true,
+            onConnect: true,
+            onDisconnect: true,
+            onUpgrade: true,
+            onRequest: true,
+            onDestroy: true,
+            onConfigure: true,
+            log: console.log, // eslint-disable-line
+        };
+        this.configuration = {
+            ...this.configuration,
+            ...configuration,
+        };
+    }
+    async onConfigure(data) {
+        this.name = data.instance.configuration.name;
+        if (!this.configuration.onConfigure) {
+            return;
+        }
+        if (this.configuration.prefix) {
+            console.warn('[hocuspocus warn] The Logger \'prefix\' is deprecated. Pass a \'name\' to the Hocuspocus configuration instead.');
+        }
+    }
+    async onLoadDocument(data) {
+        if (this.configuration.onLoadDocument) {
+            this.log(`Loaded document "${data.documentName}".`);
+        }
+    }
+    async onChange(data) {
+        if (this.configuration.onChange) {
+            this.log(`Document "${data.documentName}" changed.`);
+        }
+    }
+    async onStoreDocument(data) {
+        if (this.configuration.onStoreDocument) {
+            this.log(`Store "${data.documentName}".`);
+        }
+    }
+    async onConnect(data) {
+        if (this.configuration.onConnect) {
+            this.log(`New connection to "${data.documentName}".`);
+        }
+    }
+    async onDisconnect(data) {
+        if (this.configuration.onDisconnect) {
+            this.log(`Connection to "${data.documentName}" closed.`);
+        }
+    }
+    async onUpgrade(data) {
+        if (this.configuration.onUpgrade) {
+            this.log('Upgrading connection …');
+        }
+    }
+    async onRequest(data) {
+        if (this.configuration.onRequest) {
+            this.log(`Incoming HTTP Request to ${data.request.url}`);
+        }
+    }
+    async onDestroy(data) {
+        if (this.configuration.onDestroy) {
+            this.log('Shut down.');
+        }
+    }
+    log(message) {
+        const date = (new Date()).toISOString();
+        let meta = `${date}`;
+        if (this.name) {
+            meta = `${this.name} ${meta}`;
+        }
+        message = `[${meta}] ${message}`;
+        this.configuration.log(message);
+    }
 }
 
 export { Logger };

package/dist/packages/common/src/CloseEvents.d.ts

@@ -1,29 +1,29 @@
-export interface CloseEvent {
-    code: number;
-    reason: string;
-}
-/**
- * The server is terminating the connection because a data frame was received
- * that is too large.
- * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
- */
-export declare const MessageTooBig: CloseEvent;
-/**
- * The server successfully processed the request, asks that the requester reset
- * its document view, and is not returning any content.
- */
-export declare const ResetConnection: CloseEvent;
-/**
- * Similar to Forbidden, but specifically for use when authentication is required and has
- * failed or has not yet been provided.
- */
-export declare const Unauthorized: CloseEvent;
-/**
- * The request contained valid data and was understood by the server, but the server
- * is refusing action.
- */
-export declare const Forbidden: CloseEvent;
-/**
- * The server timed out waiting for the request.
- */
-export declare const ConnectionTimeout: CloseEvent;
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}
+/**
+ * The server is terminating the connection because a data frame was received
+ * that is too large.
+ * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
+ */
+export declare const MessageTooBig: CloseEvent;
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export declare const ResetConnection: CloseEvent;
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export declare const Unauthorized: CloseEvent;
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export declare const Forbidden: CloseEvent;
+/**
+ * The server timed out waiting for the request.
+ */
+export declare const ConnectionTimeout: CloseEvent;

package/dist/packages/common/src/auth.d.ts

@@ -1,6 +1,6 @@
-import * as encoding from 'lib0/encoding';
-import * as decoding from 'lib0/decoding';
-export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
-export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
-export declare const writeAuthenticated: (encoder: encoding.Encoder) => void;
-export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: () => void) => void;
+import * as encoding from 'lib0/encoding';
+import * as decoding from 'lib0/decoding';
+export declare const writeAuthentication: (encoder: encoding.Encoder, auth: string) => void;
+export declare const writePermissionDenied: (encoder: encoding.Encoder, reason: string) => void;
+export declare const writeAuthenticated: (encoder: encoding.Encoder, scope: 'readonly' | 'read-write') => void;
+export declare const readAuthMessage: (decoder: decoding.Decoder, permissionDeniedHandler: (reason: string) => void, authenticatedHandler: (scope: string) => void) => void;

package/dist/packages/common/src/awarenessStatesToArray.d.ts

@@ -1,3 +1,3 @@
-export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
-    clientId: number;
-}[];
+export declare const awarenessStatesToArray: (states: Map<number, Record<string, any>>) => {
+    clientId: number;
+}[];

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

@@ -1,4 +1,4 @@
-export * from './auth';
-export * from './CloseEvents';
-export * from './awarenessStatesToArray';
-export * from './types';
+export * from './auth.js';
+export * from './CloseEvents.js';
+export * from './awarenessStatesToArray.js';
+export * from './types.js';

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

@@ -1,10 +1,10 @@
-/**
- * State of the WebSocket connection.
- * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
- */
-export declare enum WsReadyStates {
-    Connecting = 0,
-    Open = 1,
-    Closing = 2,
-    Closed = 3
-}
+/**
+ * State of the WebSocket connection.
+ * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
+ */
+export declare enum WsReadyStates {
+    Connecting = 0,
+    Open = 1,
+    Closing = 2,
+    Closed = 3
+}

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

@@ -1,30 +1,30 @@
-import { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } 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.
-     */
-    fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
-    /**
-     * Pass a function to store updates in your database.
-     */
-    store: (data: storePayload) => void;
-}
-export declare class Database implements Extension {
-    /**
-     * Default configuration
-     */
-    configuration: DatabaseConfiguration;
-    /**
-     * Constructor
-     */
-    constructor(configuration: Partial<DatabaseConfiguration>);
-    /**
-     * Get stored data from the database.
-     */
-    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
-    /**
-     * Store new updates in the database.
-     */
-    onStoreDocument(data: onChangePayload): Promise<void>;
-}
+import { Extension, onChangePayload, onLoadDocumentPayload, storePayload, fetchPayload } 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.
+     */
+    fetch: (data: fetchPayload) => Promise<Uint8Array | null>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    store: (data: storePayload) => void;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onStoreDocument(data: onChangePayload): Promise<void>;
+}

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

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

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

@@ -1,67 +1,67 @@
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, 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 `onStoreDocument` hook.
-     */
-    onStoreDocument: 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 `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>);
-    onConfigure(data: onConfigurePayload): Promise<void>;
-    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
-    onChange(data: onChangePayload): Promise<void>;
-    onStoreDocument(data: onDisconnectPayload): Promise<void>;
-    onConnect(data: onConnectPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onUpgrade(data: onUpgradePayload): Promise<void>;
-    onRequest(data: onRequestPayload): Promise<void>;
-    onDestroy(data: onDestroyPayload): Promise<void>;
-    private log;
-}
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, 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 `onStoreDocument` hook.
+     */
+    onStoreDocument: 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 `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>);
+    onConfigure(data: onConfigurePayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    onChange(data: onChangePayload): Promise<void>;
+    onStoreDocument(data: onDisconnectPayload): Promise<void>;
+    onConnect(data: onConnectPayload): Promise<void>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onUpgrade(data: onUpgradePayload): Promise<void>;
+    onRequest(data: onRequestPayload): Promise<void>;
+    onDestroy(data: onDestroyPayload): Promise<void>;
+    private log;
+}

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

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