@hocuspocus/extension-sqlite 2.1.0-alpha.0 → 2.2.0

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

@@ -1,264 +1,270 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
-import { URLSearchParams } from 'url';
-import { Awareness } from 'y-protocols/awareness';
-import Document from './Document';
-import { Hocuspocus } from './Hocuspocus';
-import Connection from './Connection';
-export declare enum MessageType {
-    Unknown = -1,
-    Sync = 0,
-    Awareness = 1,
-    Auth = 2,
-    QueryAwareness = 3,
-    SyncReply = 4,
-    Stateless = 5,
-    BroadcastStateless = 6,
-    CLOSE = 7
-}
-export interface AwarenessUpdate {
-    added: Array<any>;
-    updated: Array<any>;
-    removed: Array<any>;
-}
-export interface ConnectionConfiguration {
-    readOnly: boolean;
-    requiresAuthentication: boolean;
-    isAuthenticated: boolean;
-}
-export interface Extension {
-    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>;
-    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
-    afterLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
-    beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
-    beforeBroadcastStateless?(data: beforeBroadcastStatelessPayload): Promise<any>;
-    onStateless?(payload: onStatelessPayload): 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 type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
-export type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onStatelessPayload | beforeHandleMessagePayload | beforeBroadcastStatelessPayload | 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;
-    /**
-     * The address which the server listens on.
-     */
-    address?: string;
-    /**
-     * 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 onStatelessPayload {
-    connection: Connection;
-    documentName: string;
-    document: Document;
-    payload: string;
-}
-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: 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 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 beforeHandleMessagePayload {
-    clientsCount: number;
-    context: any;
-    document: Document;
-    documentName: string;
-    instance: Hocuspocus;
-    requestHeaders: IncomingHttpHeaders;
-    requestParameters: URLSearchParams;
-    update: Uint8Array;
-    socketId: string;
-    connection: Connection;
-}
-export interface beforeBroadcastStatelessPayload {
-    document: Document;
-    documentName: string;
-    payload: 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 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;
-}
-export interface onRequestPayload {
-    request: IncomingMessage;
-    response: ServerResponse;
-    instance: Hocuspocus;
-}
-export interface onUpgradePayload {
-    request: IncomingMessage;
-    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;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
+import { URLSearchParams } from 'url';
+import { Awareness } from 'y-protocols/awareness';
+import Document from './Document.js';
+import { Hocuspocus } from './Hocuspocus.js';
+import Connection from './Connection.js';
+export declare enum MessageType {
+    Unknown = -1,
+    Sync = 0,
+    Awareness = 1,
+    Auth = 2,
+    QueryAwareness = 3,
+    SyncReply = 4,
+    Stateless = 5,
+    BroadcastStateless = 6,
+    CLOSE = 7
+}
+export interface AwarenessUpdate {
+    added: Array<any>;
+    updated: Array<any>;
+    removed: Array<any>;
+}
+export interface ConnectionConfiguration {
+    readOnly: boolean;
+    requiresAuthentication: boolean;
+    isAuthenticated: boolean;
+}
+export interface Extension {
+    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>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    afterLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
+    beforeBroadcastStateless?(data: beforeBroadcastStatelessPayload): Promise<any>;
+    onStateless?(payload: onStatelessPayload): 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 type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
+export type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onStatelessPayload | beforeHandleMessagePayload | beforeBroadcastStatelessPayload | 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;
+    /**
+     * The address which the server listens on.
+     */
+    address?: string;
+    /**
+     * 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 onStatelessPayload {
+    connection: Connection;
+    documentName: string;
+    document: Document;
+    payload: string;
+}
+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: ConnectionConfiguration;
+}
+export interface connectedPayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+    connectionInstance: Connection;
+}
+export interface onLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
+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 beforeHandleMessagePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+    connection: Connection;
+}
+export interface beforeBroadcastStatelessPayload {
+    document: Document;
+    documentName: string;
+    payload: 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 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;
+}
+export interface onRequestPayload {
+    request: IncomingMessage;
+    response: ServerResponse;
+    instance: Hocuspocus;
+}
+export interface onUpgradePayload {
+    request: IncomingMessage;
+    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;
+}
+export interface DirectConnection {
+    transact(transaction: (document: Document) => void): Promise<void>;
+    disconnect(): void;
+}

package/dist/packages/server/src/util/getParameters.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingMessage } from 'http';
+import { URLSearchParams } from 'url';
+/**
+   * Get parameters by the given request
+   */
+export declare function getParameters(request?: Pick<IncomingMessage, 'url'>): URLSearchParams;

package/dist/packages/transformer/src/Prosemirror.d.ts

@@ -1,11 +1,11 @@
-import { Doc } from 'yjs';
-import { Schema } from '@tiptap/pm/model';
-import { Transformer } from './types';
-declare class Prosemirror implements Transformer {
-    defaultSchema: Schema;
-    schema(schema: Schema): Prosemirror;
-    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
-    toYdoc(document: any, fieldName?: string | Array<string>, schema?: Schema): Doc;
-}
-export declare const ProsemirrorTransformer: Prosemirror;
-export {};
+import { Doc } from 'yjs';
+import { Schema } from '@tiptap/pm/model';
+import { Transformer } from './types.js';
+declare class Prosemirror implements Transformer {
+    defaultSchema: Schema;
+    schema(schema: Schema): Prosemirror;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, schema?: Schema): Doc;
+}
+export declare const ProsemirrorTransformer: Prosemirror;
+export {};

package/dist/packages/transformer/src/Tiptap.d.ts

@@ -1,10 +1,10 @@
-import { Doc } from 'yjs';
-import { Extensions } from '@tiptap/core';
-import { Transformer } from './types';
-export declare class Tiptap implements Transformer {
-    defaultExtensions: Extensions;
-    extensions(extensions: Extensions): Tiptap;
-    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
-    toYdoc(document: any, fieldName?: string | Array<string>, extensions?: Extensions): Doc;
-}
-export declare const TiptapTransformer: Tiptap;
+import { Doc } from 'yjs';
+import { Extensions } from '@tiptap/core';
+import { Transformer } from './types.js';
+export declare class Tiptap implements Transformer {
+    defaultExtensions: Extensions;
+    extensions(extensions: Extensions): Tiptap;
+    fromYdoc(document: Doc, fieldName?: string | Array<string>): any;
+    toYdoc(document: any, fieldName?: string | Array<string>, extensions?: Extensions): Doc;
+}
+export declare const TiptapTransformer: Tiptap;

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

@@ -1,3 +1,3 @@
-export * from './Prosemirror';
-export * from './Tiptap';
-export * from './types';
+export * from './Prosemirror.js';
+export * from './Tiptap.js';
+export * from './types.js';

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

@@ -1,5 +1,5 @@
-import { Doc } from 'yjs';
-export interface Transformer {
-    fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
-    toYdoc: (document: any, fieldName: string) => Doc;
-}
+import { Doc } from 'yjs';
+export interface Transformer {
+    fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
+    toYdoc: (document: any, fieldName: string) => Doc;
+}

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

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

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

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

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

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

package/dist/playground/backend/src/load-document.d.ts

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

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

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

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

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

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

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

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

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

package/dist/playground/frontend/src/main.d.ts

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