@hocuspocus/common 3.0.0-rc.0 → 3.0.6-rc.0

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

@@ -0,0 +1,2 @@
+import type { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
+export declare const SocketContext: 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/utils/index.d.ts

@@ -1,9 +1,9 @@
-export * from './createDirectory.js';
-export * from './flushRedis.js';
-export * from './newHocuspocus.js';
-export * from './newHocuspocusProvider.js';
-export * from './newHocuspocusProviderWebsocket.js';
-export * from './randomInteger.js';
-export * from './redisConnectionSettings.js';
-export * from './removeDirectory.js';
-export * from './sleep.js';
+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/newHocuspocusProvider.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/common",
   "description": "shared code for multiple Hocuspocus packages",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.6-rc.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus"
@@ -13,7 +13,7 @@
   "types": "dist/packages/common/src/index.d.ts",
   "exports": {
     "source": {
-      "import": "./src"
+      "import": "./src/index.ts"
     },
     "default": {
       "import": "./dist/hocuspocus-common.esm.js",

package/src/index.ts

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

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

@@ -1,64 +0,0 @@
-import type { AbstractType, YArrayEvent } from 'yjs';
-import * as Y from 'yjs';
-import type { HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
-import { HocuspocusProvider } from './HocuspocusProvider.js';
-import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
-import type { TCollabComment, TCollabThread, THistoryVersion } from './types.js';
-export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) & Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>;
-export interface AdditionalTiptapCollabProviderConfiguration {
-    /**
-     * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
-     */
-    appId?: string;
-    /**
-     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
-     */
-    baseUrl?: string;
-    websocketProvider?: TiptapCollabProviderWebsocket;
-    user?: string;
-}
-export declare class TiptapCollabProvider extends HocuspocusProvider {
-    tiptapCollabConfigurationPrefix: string;
-    userData?: Y.PermanentUserData;
-    constructor(configuration: TiptapCollabProviderConfiguration);
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    createVersion(name?: string): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    revertToVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     *
-     * The server will reply with a stateless message (THistoryVersionPreviewEvent)
-     */
-    previewVersion(targetVersion: number): void;
-    /**
-     * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
-     */
-    getVersions(): THistoryVersion[];
-    watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]): void;
-    unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]): void;
-    isAutoVersioning(): boolean;
-    enableAutoVersioning(): 1;
-    disableAutoVersioning(): 0;
-    private getYThreads;
-    getThreads<Data, CommentData>(): TCollabThread<Data, CommentData>[];
-    private getThreadIndex;
-    getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null;
-    private getYThread;
-    createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'comments'>): TCollabThread;
-    updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data'> & {
-        resolvedAt: TCollabThread['resolvedAt'] | null;
-    }>): TCollabThread;
-    deleteThread(id: TCollabThread['id']): void;
-    getThreadComments(threadId: TCollabThread['id']): TCollabComment[] | null;
-    getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabComment | null;
-    addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread;
-    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread;
-    deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabThread | null | undefined;
-    watchThreads(callback: () => void): void;
-    unwatchThreads(callback: () => void): void;
-}

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

@@ -1,20 +0,0 @@
-import type { CompleteHocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket.js';
-import { HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.js';
-export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
-export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
-    /**
-     * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
-     */
-    appId?: string;
-    /**
-     * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
-     */
-    baseUrl?: string;
-    /**
-     * Only fill this if you are using Tiptap Collab HA.
-     */
-    shardKey?: string;
-}
-export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
-    constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
-}

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

@@ -1,14 +0,0 @@
-export declare class Debugger {
-    logs: any[];
-    listen: boolean;
-    output: boolean;
-    enable(): void;
-    disable(): void;
-    verbose(): void;
-    quiet(): void;
-    log(message: any): this;
-    flush(): this;
-    get(): {
-        logs: any[];
-    };
-}

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

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;

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

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

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

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