@fileverse-dev/ddoc 1.8.0 → 1.8.2

package/dist/packages/ddoc/use-ddoc-editor.d.ts

@@ -1,9 +1,8 @@
 import { DdocProps } from './types';
 
-import * as Y from 'yjs';
 export declare const useDdocEditor: ({ isPreviewMode, initialContent, enableCollaboration, collaborationId, walletAddress, username, onChange, onCollaboratorChange, onCommentInteraction, onTextSelection, ensResolutionUrl, onError, setCharacterCount, setWordCount, }: Partial<DdocProps>) => {
     editor: import('@tiptap/react').Editor | null;
     ref: import('react').RefObject<HTMLDivElement>;
-    connect: (username: string | null | undefined, isEns?: boolean) => () => void;
-    ydoc: Y.Doc;
+    connect: (username: string | null | undefined, _isEns?: boolean) => void;
+    ydoc: import('yjs').Doc;
 };

package/dist/packages/ddoc/utils/CollaborationCursor.d.ts

@@ -0,0 +1,83 @@
+import { Extension } from '@tiptap/core';
+
+type CollaborationCursorStorage = {
+    users: {
+        clientId: number;
+        [key: string]: any;
+    }[];
+};
+export interface CollaborationCursorOptions {
+    /**
+     * The Hocuspocus provider instance. This can also be a TiptapCloudProvider instance.
+     * @type {HocuspocusProvider | TiptapCloudProvider}
+     * @example new HocuspocusProvider()
+     */
+    provider: any;
+    /**
+     * The user details object – feel free to add properties to this object as needed
+     * @example { name: 'John Doe', color: '#305500' }
+     */
+    user: Record<string, any>;
+    /**
+     * A function that returns a DOM element for the cursor.
+     * @param user The user details object
+     * @example
+     * render: user => {
+     *  const cursor = document.createElement('span')
+     *  cursor.classList.add('collaboration-cursor__caret')
+     *  cursor.setAttribute('style', `border-color: ${user.color}`)
+     *
+     *  const label = document.createElement('div')
+     *  label.classList.add('collaboration-cursor__label')
+     *  label.setAttribute('style', `background-color: ${user.color}`)
+     *  label.insertBefore(document.createTextNode(user.name), null)
+     *
+     *  cursor.insertBefore(label, null)
+     *  return cursor
+     * }
+     */
+    render(user: Record<string, any>): HTMLElement;
+    /**
+     * A function that returns a ProseMirror DecorationAttrs object for the selection.
+     * @param user The user details object
+     * @example
+     * selectionRender: user => {
+     * return {
+     *  nodeName: 'span',
+     *  class: 'collaboration-cursor__selection',
+     *  style: `background-color: ${user.color}`,
+     *  'data-user': user.name,
+     * }
+     */
+    selectionRender(user: Record<string, any>): any;
+    /**
+     * @deprecated The "onUpdate" option is deprecated. Please use `editor.storage.collaborationCursor.users` instead. Read more: https://tiptap.dev/api/extensions/collaboration-cursor
+     */
+    onUpdate: (users: {
+        clientId: number;
+        [key: string]: any;
+    }[]) => null;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        collaborationCursor: {
+            /**
+             * Update details of the current user
+             * @example editor.commands.updateUser({ name: 'John Doe', color: '#305500' })
+             */
+            updateUser: (attributes: Record<string, any>) => ReturnType;
+            /**
+             * Update details of the current user
+             *
+             * @deprecated The "user" command is deprecated. Please use "updateUser" instead. Read more: https://tiptap.dev/api/extensions/collaboration-cursor
+             */
+            user: (attributes: Record<string, any>) => ReturnType;
+        };
+    }
+}
+/**
+ * This extension allows you to add collaboration cursors to your editor.
+ * @see https://tiptap.dev/api/extensions/collaboration-cursor
+ */
+export declare const CollaborationCursor: Extension<CollaborationCursorOptions, CollaborationCursorStorage>;
+export {};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@fileverse-dev/ddoc",
   "private": false,
   "description": "DDoc",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "main": "dist/index.umd.js",
   "module": "dist/index.es.js",
   "exports": {
@@ -28,6 +28,7 @@
   },
   "dependencies": {
     "@_ueberdosis/prosemirror-tables": "^1.1.3",
+    "@fileverse-dev/fileverse-sync": "^0.0.4",
     "@radix-ui/react-focus-scope": "^1.1.0",
     "@radix-ui/react-popover": "^1.0.7",
     "@tippyjs/react": "^4.2.6",
@@ -76,8 +77,7 @@
     "vaul": "^0.9.1",
     "vite-plugin-dts": "^3.6.3",
     "y-prosemirror": "^1.2.5",
-    "y-webrtc": "^10.3.0",
-    "yjs": "^13.6.15"
+    "y-webrtc": "^10.3.0"
   },
   "devDependencies": {
     "@types/dompurify": "^3.0.5",