@hocuspocus/extension-database 2.0.0-beta.0 → 2.0.1

package/README.md

@@ -5,10 +5,10 @@
 [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
 
 ## Introduction
-hocuspocus is an opinionated collaborative editing backend for [Tiptap](https://github.com/ueberdosis/tiptap) – based on [Y.js](https://github.com/yjs/yjs), a CRDT framework with a powerful abstraction of shared data.
+Hocuspocus is an opinionated collaborative editing backend for [Tiptap](https://github.com/ueberdosis/tiptap) – based on [Y.js](https://github.com/yjs/yjs), a CRDT framework with a powerful abstraction of shared data.
 
 ## Offical Documentation
 Documentation can be found in the [GitHub repository](https://github.com/ueberdosis/hocuspocus).
 
 ## License
-hocuspocus is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/hocuspocus/blob/main/LICENSE.md).
+Hocuspocus is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/hocuspocus/blob/main/LICENSE.md).

package/dist/packages/extension-monitor/src/Dashboard.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingMessage, ServerResponse } from 'http';
 import { Socket } from 'net';
 import WebSocket, { WebSocketServer } from 'ws';

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -1,7 +1,7 @@
 import RedisClient, { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
 import Redlock from 'redlock';
 import { Document, Extension, afterLoadDocumentPayload, afterStoreDocumentPayload, onDisconnectPayload, onStoreDocumentPayload, onAwarenessUpdatePayload, onChangePayload, Debugger, onConfigurePayload, onListenPayload, beforeBroadcastStatelessPayload } from '@hocuspocus/server';
-export declare type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
+export type RedisInstance = RedisClient.Cluster | RedisClient.Redis;
 export interface Configuration {
     /**
      * Redis port

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

@@ -1,6 +1,6 @@
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
 import { HocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket';
-export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
+export type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
 export interface AdditionalHocuspocusCloudProviderConfiguration {
     /**
      * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/

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

@@ -6,7 +6,7 @@ import EventEmitter from './EventEmitter';
 import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
 import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
 import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> | Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>);
+export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> | Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>);
 export interface CompleteHocuspocusProviderConfiguration {
     /**
      * The identifier/name of your document

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

@@ -4,7 +4,7 @@ import { Event } from 'ws';
 import EventEmitter from './EventEmitter';
 import { onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, WebSocketStatus } from './types';
 import { HocuspocusProvider, onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
-export declare type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
+export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
 export interface CompleteHocuspocusProviderWebsocketConfiguration {
     /**
      * URL of your @hocuspocus/server instance

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

@@ -0,0 +1,11 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
+export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalTiptapCollabProviderConfiguration;
+export interface AdditionalTiptapCollabProviderConfiguration {
+    /**
+     * A Hocuspocus Cloud App ID, get one here: https://collab.tiptap.dev
+     */
+    appId: string;
+}
+export declare class TiptapCollabProvider extends HocuspocusProvider {
+    constructor(configuration: TiptapCollabProviderConfiguration);
+}

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

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

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

@@ -43,42 +43,42 @@ export interface OutgoingMessageArguments {
 export interface Constructable<T> {
     new (...args: any): T;
 }
-export declare type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
-export declare type onAuthenticationFailedParameters = {
+export type ConstructableOutgoingMessage = Constructable<AuthenticationMessage> | Constructable<AwarenessMessage> | Constructable<QueryAwarenessMessage> | Constructable<SyncStepOneMessage> | Constructable<SyncStepTwoMessage> | Constructable<UpdateMessage>;
+export type onAuthenticationFailedParameters = {
     reason: string;
 };
-export declare type onOpenParameters = {
+export type onOpenParameters = {
     event: Event;
 };
-export declare type onMessageParameters = {
+export type onMessageParameters = {
     event: MessageEvent;
     message: IncomingMessage;
 };
-export declare type onOutgoingMessageParameters = {
+export type onOutgoingMessageParameters = {
     message: OutgoingMessage;
 };
-export declare type onStatusParameters = {
+export type onStatusParameters = {
     status: WebSocketStatus;
 };
-export declare type onSyncedParameters = {
+export type onSyncedParameters = {
     state: boolean;
 };
-export declare type onDisconnectParameters = {
+export type onDisconnectParameters = {
     event: CloseEvent;
 };
-export declare type onCloseParameters = {
+export type onCloseParameters = {
     event: CloseEvent;
 };
-export declare type onAwarenessUpdateParameters = {
+export type onAwarenessUpdateParameters = {
     states: StatesArray;
 };
-export declare type onAwarenessChangeParameters = {
+export type onAwarenessChangeParameters = {
     states: StatesArray;
 };
-export declare type onStatelessParameters = {
+export type onStatelessParameters = {
     payload: string;
 };
-export declare type StatesArray = {
+export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingMessage as HTTPIncomingMessage } from 'http';
 import AsyncLock from 'async-lock';
 import WebSocket from 'ws';
@@ -23,7 +24,7 @@ export declare class Connection {
      * Constructor.
      */
     constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly: boolean | undefined, logger: Debugger);
-    boundClose: (event?: CloseEvent | undefined) => void;
+    boundClose: (event?: CloseEvent) => void;
     boundHandleMessage: (data: Uint8Array) => void;
     boundHandlePong: () => void;
     handlePong(): void;

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import WebSocket, { AddressInfo, WebSocketServer } from 'ws';
 import { Configuration, HookName, HookPayload, onListenPayload } from './types';

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

@@ -1,4 +1,6 @@
 /// <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';
@@ -47,8 +49,8 @@ export interface Extension {
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export declare type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'onDestroy';
-export declare type HookPayload = onConfigurePayload | onListenPayload | onUpgradePayload | onConnectPayload | connectedPayload | onAuthenticatePayload | onLoadDocumentPayload | onStatelessPayload | beforeHandleMessagePayload | beforeBroadcastStatelessPayload | onChangePayload | onStoreDocumentPayload | afterStoreDocumentPayload | onAwarenessUpdatePayload | onRequestPayload | onDisconnectPayload | onDestroyPayload;
+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.
@@ -208,7 +210,7 @@ export interface onAwarenessUpdatePayload {
     awareness: Awareness;
     states: StatesArray;
 }
-export declare type StatesArray = {
+export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];

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

@@ -1,2 +1,2 @@
 import { Hocuspocus, Configuration } from '@hocuspocus/server';
-export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Promise<Hocuspocus>;
+export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-database",
   "description": "a generic Hocuspocus persistence driver for the database",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.1",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -26,7 +26,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^2.0.0-beta.0"
+    "@hocuspocus/server": "^2.0.1"
   },
   "peerDependencies": {
     "yjs": "^13.5.29"