@hocuspocus/extension-s3 3.2.4

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

@@ -0,0 +1,328 @@
+import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from "node:http";
+import type { URLSearchParams } from "node:url";
+import type { Awareness } from "y-protocols/awareness";
+import type Connection from "./Connection.ts";
+import type Document from "./Document.ts";
+import type { Hocuspocus } from "./Hocuspocus.ts";
+export declare enum MessageType {
+    Unknown = -1,
+    Sync = 0,
+    Awareness = 1,
+    Auth = 2,
+    QueryAwareness = 3,
+    SyncReply = 4,// same as Sync, but won't trigger another 'SyncStep1'
+    Stateless = 5,
+    BroadcastStateless = 6,
+    CLOSE = 7,
+    SyncStatus = 8
+}
+export interface AwarenessUpdate {
+    added: Array<any>;
+    updated: Array<any>;
+    removed: Array<any>;
+}
+export interface ConnectionConfiguration {
+    readOnly: boolean;
+    isAuthenticated: boolean;
+}
+export interface Extension {
+    priority?: number;
+    extensionName?: string;
+    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>;
+    onCreateDocument?(data: onCreateDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
+    afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
+    beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
+    beforeSync?(data: beforeSyncPayload): 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>;
+    beforeUnloadDocument?(data: beforeUnloadDocumentPayload): Promise<any>;
+    afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
+    onDestroy?(data: onDestroyPayload): Promise<any>;
+}
+export type HookName = "onConfigure" | "onListen" | "onUpgrade" | "onConnect" | "connected" | "onAuthenticate" | "onCreateDocument" | "onLoadDocument" | "afterLoadDocument" | "beforeHandleMessage" | "beforeBroadcastStateless" | "beforeSync" | "onStateless" | "onChange" | "onStoreDocument" | "afterStoreDocument" | "onAwarenessUpdate" | "onRequest" | "onDisconnect" | "beforeUnloadDocument" | "afterUnloadDocument" | "onDestroy";
+export type HookPayloadByName = {
+    onConfigure: onConfigurePayload;
+    onListen: onListenPayload;
+    onUpgrade: onUpgradePayload;
+    onConnect: onConnectPayload;
+    connected: connectedPayload;
+    onAuthenticate: onAuthenticatePayload;
+    onCreateDocument: onCreateDocumentPayload;
+    onLoadDocument: onLoadDocumentPayload;
+    afterLoadDocument: afterLoadDocumentPayload;
+    beforeHandleMessage: beforeHandleMessagePayload;
+    beforeBroadcastStateless: beforeBroadcastStatelessPayload;
+    beforeSync: beforeSyncPayload;
+    onStateless: onStatelessPayload;
+    onChange: onChangePayload;
+    onStoreDocument: onStoreDocumentPayload;
+    afterStoreDocument: afterStoreDocumentPayload;
+    onAwarenessUpdate: onAwarenessUpdatePayload;
+    onRequest: onRequestPayload;
+    onDisconnect: onDisconnectPayload;
+    afterUnloadDocument: afterUnloadDocumentPayload;
+    beforeUnloadDocument: beforeUnloadDocumentPayload;
+    onDestroy: onDestroyPayload;
+};
+export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
+    /**
+     * A list of hocuspocus extensions.
+     */
+    extensions: Array<Extension>;
+    /**
+     * 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;
+    /**
+     * If set to false, respects the debounce time of `onStoreDocument` before unloading a document.
+     * Otherwise, the document will be unloaded immediately.
+     *
+     * This prevents a client from DOSing the server by repeatedly connecting and disconnecting when
+     * your onStoreDocument is rate-limited.
+     */
+    unloadImmediately: boolean;
+    /**
+     * options to pass to the ydoc document
+     */
+    yDocOptions: {
+        gc: boolean;
+        gcFilter: () => boolean;
+    };
+}
+export interface onStatelessPayload {
+    connection: Connection;
+    documentName: string;
+    document: Document;
+    payload: string;
+}
+export interface onAuthenticatePayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    request: IncomingMessage;
+    socketId: string;
+    token: string;
+    connectionConfig: ConnectionConfiguration;
+}
+export interface onCreateDocumentPayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connectionConfig: ConnectionConfiguration;
+}
+export interface onConnectPayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connectionConfig: ConnectionConfiguration;
+}
+export interface connectedPayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    request: IncomingMessage;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connectionConfig: ConnectionConfiguration;
+    connection: Connection;
+}
+export interface onLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connectionConfig: ConnectionConfiguration;
+}
+export interface afterLoadDocumentPayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connectionConfig: ConnectionConfiguration;
+}
+export interface onChangePayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    update: Uint8Array;
+    socketId: string;
+    transactionOrigin: any;
+}
+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 beforeSyncPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    connection: Connection;
+    /**
+     * The y-protocols/sync message type
+     * @example
+     * 0: SyncStep1
+     * 1: SyncStep2
+     * 2: YjsUpdate
+     *
+     * @see https://github.com/yjs/y-protocols/blob/master/sync.js#L13-L40
+     */
+    type: number;
+    /**
+     * The payload of the y-sync message.
+     */
+    payload: Uint8Array;
+}
+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;
+    transactionOrigin?: any;
+}
+export interface afterStoreDocumentPayload extends onStoreDocumentPayload {
+}
+export interface onAwarenessUpdatePayload {
+    context: any;
+    document: Document;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    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;
+    connectionConfig: 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 afterUnloadDocumentPayload {
+    instance: Hocuspocus;
+    documentName: string;
+}
+export interface beforeUnloadDocumentPayload {
+    instance: Hocuspocus;
+    documentName: string;
+    document: Document;
+}
+export interface DirectConnection {
+    transact(transaction: (document: Document) => void): Promise<void>;
+    disconnect(): void;
+}

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

@@ -0,0 +1,5 @@
+export declare const useDebounce: () => {
+    debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => any;
+    isDebounced: (id: string) => boolean;
+    executeNow: (id: string) => any;
+};

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

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

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

@@ -0,0 +1,11 @@
+import { Doc } from "yjs";
+import { Schema } from "@tiptap/pm/model";
+import type { Transformer } from "./types.ts";
+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

@@ -0,0 +1,10 @@
+import type { Doc } from "yjs";
+import type { Extensions } from "@tiptap/core";
+import type { Transformer } from "./types.ts";
+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

@@ -0,0 +1,3 @@
+export * from "./Prosemirror.ts";
+export * from "./Tiptap.ts";
+export * from "./types.ts";

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

@@ -0,0 +1,5 @@
+import type { 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/playground/frontend/app/SocketContext1.d.ts

@@ -0,0 +1,2 @@
+import type { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
+export declare const SocketContext1: import("react").Context<HocuspocusProviderWebsocket | null>;

package/dist/playground/frontend/app/SocketContext2.d.ts

@@ -0,0 +1,2 @@
+import type { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
+export declare const SocketContext2: import("react").Context<HocuspocusProviderWebsocket | null>;

package/dist/playground/frontend/next.config.d.ts

@@ -0,0 +1,3 @@
+import type { NextConfig } from "next";
+declare const nextConfig: NextConfig;
+export default nextConfig;

package/dist/tests/extension-database/fetch.d.ts

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

package/dist/tests/extension-logger/onListen.d.ts

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

package/dist/tests/extension-redis/onAwarenessChange.d.ts

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

package/dist/tests/extension-redis/onChange.d.ts

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

package/dist/tests/extension-redis/onStateless.d.ts

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

package/dist/tests/extension-redis/onStoreDocument.d.ts

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

package/dist/tests/extension-s3/fetch.d.ts

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

package/dist/tests/extension-throttle/banning.d.ts

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

package/dist/tests/extension-throttle/configuration.d.ts

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

package/dist/tests/provider/hasUnsyncedChanges.d.ts

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

package/dist/tests/provider/observe.d.ts

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

package/dist/tests/provider/observeDeep.d.ts

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

package/dist/tests/provider/onAuthenticated.d.ts

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

package/dist/tests/provider/onAuthenticationFailed.d.ts

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

package/dist/tests/provider/onAwarenessChange.d.ts

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

package/dist/tests/provider/onAwarenessUpdate.d.ts

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

package/dist/tests/provider/onClose.d.ts

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

package/dist/tests/provider/onConnect.d.ts

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

package/dist/tests/provider/onDisconnect.d.ts

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

package/dist/tests/provider/onMessage.d.ts

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

package/dist/tests/provider/onOpen.d.ts

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

package/dist/tests/provider/onStateless.d.ts

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

package/dist/tests/provider/onSynced.d.ts

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

package/dist/tests/providerwebsocket/configuration.d.ts

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

package/dist/tests/server/address.d.ts

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

package/dist/tests/server/afterLoadDocument.d.ts

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

package/dist/tests/server/afterStoreDocument.d.ts

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

package/dist/tests/server/afterUnloadDocument.d.ts

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

package/dist/tests/server/beforeBroadcastStateless.d.ts

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

package/dist/tests/server/beforeHandleMessage.d.ts

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

package/dist/tests/server/beforeSync.d.ts

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

package/dist/tests/server/beforeUnloadDocument.d.ts

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

package/dist/tests/server/closeConnections.d.ts

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

package/dist/tests/server/getConnectionsCount.d.ts

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

package/dist/tests/server/getDocumentsCount.d.ts

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

package/dist/tests/server/listen.d.ts

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

package/dist/tests/server/onAuthenticate.d.ts

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

package/dist/tests/server/onAwarenessUpdate.d.ts

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

package/dist/tests/server/onChange.d.ts

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

package/dist/tests/server/onClose.d.ts

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

package/dist/tests/server/onConfigure.d.ts

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

package/dist/tests/server/onConnect.d.ts

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

package/dist/tests/server/onDestroy.d.ts

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

package/dist/tests/server/onDisconnect.d.ts

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

package/dist/tests/server/onListen.d.ts

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

package/dist/tests/server/onLoadDocument.d.ts

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

package/dist/tests/server/onRequest.d.ts

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

package/dist/tests/server/onStateless.d.ts

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

package/dist/tests/server/onStoreDocument.d.ts

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

package/dist/tests/server/onUpgrade.d.ts

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

package/dist/tests/server/openDirectConnection.d.ts

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

package/dist/tests/server/websocketError.d.ts

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

package/dist/tests/transformer/TiptapTransformer.d.ts

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

package/dist/tests/utils/createDirectory.d.ts

@@ -0,0 +1 @@
+export declare const createDirectory: (dir: string) => void;

package/dist/tests/utils/flushRedis.d.ts

@@ -0,0 +1 @@
+export declare const flushRedis: () => Promise<string>;

package/dist/tests/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './createDirectory.ts';
+export * from './flushRedis.ts';
+export * from './newHocuspocus.ts';
+export * from './newHocuspocusProvider.ts';
+export * from './newHocuspocusProviderWebsocket.ts';
+export * from './randomInteger.ts';
+export * from './redisConnectionSettings.ts';
+export * from './removeDirectory.ts';
+export * from './sleep.ts';

package/dist/tests/utils/newHocuspocus.d.ts

@@ -0,0 +1,2 @@
+import type { ServerConfiguration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<ServerConfiguration>) => Promise<import("@hocuspocus/server").Hocuspocus>;

package/dist/tests/utils/newHocuspocusProvider.d.ts

@@ -0,0 +1,3 @@
+import { HocuspocusProvider, type HocuspocusProviderConfiguration, type HocuspocusProviderWebsocket, type HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import type { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>, websocketProvider?: HocuspocusProviderWebsocket) => HocuspocusProvider;

package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts

@@ -0,0 +1,4 @@
+import type { HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import { HocuspocusProviderWebsocket } from '@hocuspocus/provider';
+import type { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProviderWebsocket: (hocuspocus: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, "url">>) => HocuspocusProviderWebsocket;

package/dist/tests/utils/randomInteger.d.ts

@@ -0,0 +1 @@
+export declare const randomInteger: (min: number, max: number) => number;