@fileverse-dev/ddoc 6.0.0-drop-in.2 → 6.0.0

package/dist/package/types.d.ts

@@ -116,13 +116,6 @@ export interface DocumentStyling {
      */
     customCSS?: string;
 }
-export type DdocStats = {
-    words: number;
-    characters: number;
-    selectedWords: number;
-    /** null until the active tab has been measured. */
-    pages: number | null;
-};
 export interface DdocProps extends CommentAccountProps {
     /**
      * Optional catalog of fonts available to the editor in addition to the
@@ -143,6 +136,15 @@ export interface DdocProps extends CommentAccountProps {
     };
     tabSectionContainer?: HTMLElement;
     isCollabDocumentPublished?: boolean;
+    /**
+     * Storage-agnostic image fetch function. Receives the stored location of an
+     * encrypted image (`url` + `contentRef`, e.g. an IPFS gateway URL + CID or a
+     * Swarm URL + reference) along with its decryption parameters, and returns
+     * the decrypted image. Preferred over the deprecated `ipfsImageFetchFn`;
+     * when both are provided, `imageFetchFn` wins.
+     */
+    imageFetchFn?: ImageFetchFn;
+    /** @deprecated Use the storage-agnostic `imageFetchFn` instead. */
     ipfsImageFetchFn?: (_data: IpfsImageFetchPayload) => Promise<{
         url: string;
         file: File;
@@ -150,8 +152,6 @@ export interface DdocProps extends CommentAccountProps {
     fetchV1ImageFn?: (url: string) => Promise<ArrayBuffer | undefined>;
     disableInlineComment?: boolean;
     commentDrawerOpen?: boolean;
-    onCommentDrawerOpenChange?: (open: boolean) => void;
-    /** @deprecated Use onCommentDrawerOpenChange. */
     setCommentDrawerOpen?: React.Dispatch<SetStateAction<boolean>>;
     initialComments?: IComment[];
     initialCommentAnchors?: SerializedCommentAnchor[];
@@ -165,8 +165,6 @@ export interface DdocProps extends CommentAccountProps {
     onDeleteComment?: (activeCommentId: string, meta?: CommentMutationMeta) => void;
     onDeleteReply?: (activeCommentId: string, replyId: string) => void;
     showTOC?: boolean;
-    onShowTOCChange?: (show: boolean) => void;
-    /** @deprecated Use onShowTOCChange. */
     setShowTOC?: React.Dispatch<SetStateAction<boolean>>;
     extensions?: Record<string, Extension | any>;
     selectedTags?: TagType[];
@@ -176,21 +174,24 @@ export interface DdocProps extends CommentAccountProps {
     inlineCommentData?: InlineCommentData;
     setInlineCommentData?: React.Dispatch<React.SetStateAction<InlineCommentData>>;
     theme?: ThemeKey;
-    /** Defaults to '1' when omitted. */
-    zoomLevel?: string;
-    onZoomLevelChange?: (zoomLevel: string) => void;
-    /** @deprecated Use onZoomLevelChange. */
-    setZoomLevel?: React.Dispatch<SetStateAction<string>>;
-    /** Defaults to true when omitted. */
-    isNavbarVisible?: boolean;
-    onNavbarVisibleChange?: (visible: boolean) => void;
-    /** @deprecated Use onNavbarVisibleChange. */
-    setIsNavbarVisible?: React.Dispatch<SetStateAction<boolean>>;
+    zoomLevel: string;
+    setZoomLevel: React.Dispatch<SetStateAction<string>>;
+    isNavbarVisible: boolean;
+    setIsNavbarVisible: React.Dispatch<SetStateAction<boolean>>;
     editorCanvasClassNames?: string;
     isCommentSectionOpen?: boolean;
-    isPreviewMode?: boolean;
+    isPreviewMode: boolean;
     viewerMode?: 'suggest' | 'view-only';
     ensResolutionUrl?: string;
+    /**
+     * Storage-agnostic image upload function. Encrypts and stores the file on
+     * the host's storage backend (IPFS, Swarm, ...) and returns its location
+     * (`url` + `contentRef`) plus the decryption parameters. Preferred over the
+     * deprecated `ipfsImageUploadFn`; when both are provided, `imageUploadFn`
+     * wins.
+     */
+    imageUploadFn?: ImageUploadFn;
+    /** @deprecated Use the storage-agnostic `imageUploadFn` instead. */
     ipfsImageUploadFn?: (file: File) => Promise<IpfsImageUploadResponse>;
     enableIndexeddbSync?: boolean;
     ddocId?: string;
@@ -204,13 +205,6 @@ export interface DdocProps extends CommentAccountProps {
     walletAddress?: string | null;
     username?: string | null;
     setUsername?: React.Dispatch<SetStateAction<string>>;
-    /**
-     * Host element to render the navbar into. Omit to render it as the editor's
-     * first row. Pass null while the element is not attached yet.
-     */
-    navbarContainer?: HTMLElement | null;
-    /** Show the toolbar's navbar collapse chevron. Default true. */
-    showNavbarToggle?: boolean;
     renderNavbar?: ({ editor, liveEditor, }: {
         /** JSON snapshot — legacy field, unchanged. */
         editor: JSONContent;
@@ -218,6 +212,24 @@ export interface DdocProps extends CommentAccountProps {
         liveEditor: Editor | null;
     }) => JSX.Element;
     onChange?: (updatedDocContent: string | JSONContent, updateChunk: string) => void;
+    /**
+     * Called when the document changes, from the same places as `onChange`
+     * (after typing pauses, on a flushed structural change, and when a
+     * collaborator's update arrives), but with no arguments. A host that passes
+     * this and not `onChange` never pays for encoding the whole document on
+     * every change. A host that keeps the content elsewhere (the package's
+     * y-indexeddb store) only needs to know that an edit happened.
+     */
+    onLocalChange?: () => void;
+    /**
+     * Whether this is a brand-new document. When omitted the editor derives it
+     * as "owner, no collaboration, no `initialContent`". A host that loads an
+     * existing document from the package's y-indexeddb store passes no
+     * `initialContent`, so it must pass `false` here: a new document is stamped
+     * with the preferred schema version, which would relabel an existing older
+     * document.
+     */
+    isNewDocument?: boolean;
     onCollaboratorChange?: (collaborators: undefined | IDocCollabUsers[]) => void;
     onTextSelection?: (data: IEditorSelectionData) => void;
     onCommentInteraction?: (data: IEditorSelectionData) => void;
@@ -230,15 +242,9 @@ export interface DdocProps extends CommentAccountProps {
      */
     enableFanficTemplate?: boolean;
     onError?: (error: string) => void;
-    /** Active-tab stats. Fires with all four fields whenever one changes. */
-    onStatsChange?: (stats: DdocStats) => void;
-    /** @deprecated Use onStatsChange. */
     setCharacterCount?: React.Dispatch<SetStateAction<number>>;
-    /** @deprecated Use onStatsChange. */
     setWordCount?: React.Dispatch<SetStateAction<number>>;
-    /** @deprecated Use onStatsChange. */
     setSelectedWordCount?: React.Dispatch<SetStateAction<number>>;
-    /** @deprecated Use onStatsChange. */
     setPageCount?: React.Dispatch<SetStateAction<number>>;
     tags?: Array<{
         name: string;
@@ -247,17 +253,12 @@ export interface DdocProps extends CommentAccountProps {
     className?: string;
     unFocused?: boolean;
     isPresentationMode?: boolean;
-    onPresentationModeChange?: (active: boolean) => void;
-    /** @deprecated Use onPresentationModeChange. */
     setIsPresentationMode?: React.Dispatch<SetStateAction<boolean>>;
     /** Split View: edit markdown on the left, see the read-only ddoc render on the right. */
     isSplitView?: boolean;
-    onSplitViewChange?: (active: boolean) => void;
-    /** @deprecated Use onSplitViewChange. */
     setIsSplitView?: React.Dispatch<SetStateAction<boolean>>;
     onComment?: () => void;
     onInlineComment?: () => void;
-    /** @deprecated Use onFocusModeChange. Still fires on every change. */
     onFocusMode?: (isFocusMode: boolean) => void;
     /** Controlled focus mode (D6). Omit for the legacy internal-state behavior. */
     isFocusMode?: boolean;
@@ -283,7 +284,6 @@ export interface DdocProps extends CommentAccountProps {
     renderToolbarLeading?: () => React.ReactNode;
     metadataProxyUrl?: string;
     onCopyHeadingLink?: (link: string) => void;
-    /** @deprecated No effect. The host footer sits outside the editor. */
     footerHeight?: string;
     activeModel?: CustomModel;
     maxTokens?: number;
@@ -294,11 +294,23 @@ export interface DdocProps extends CommentAccountProps {
      */
     documentStyling?: DocumentStyling;
     /**
-     * Callback when IndexedDB initialization fails
-     * @description Called when the IndexedDB persistence provider fails to initialize (e.g., private browsing, quota exceeded, corrupted DB). The editor will continue to function without local persistence.
+     * Callback when local saving to IndexedDB has a problem
+     * @description Called when the IndexedDB persistence provider fails to initialize (e.g., private browsing, corrupted DB), when a save is rejected (e.g., quota exceeded), when the browser closes or another tab deletes the database (the editor detaches from it), and when a corrupt store was repaired on load. The editor keeps working in memory; `refreshYjsIndexedDbProvider` attaches again and saves what it holds.
      */
     onIndexedDbError?: (error: Error) => void;
+    /**
+     * Called when the schema-version stamp was refused or reverted
+     * @description The editor stamps brand-new docs with the preferred schema. If the host passed an empty body for a doc that turns out to hold v1 content, the stamp is blocked (or reverted when the content arrived late). Hosts report these to see how often an existing doc is mounted without its body.
+     */
+    onSchemaStampGuard?: (event: SchemaStampGuardEvent) => void;
 }
+export type SchemaStampGuardEvent = {
+    kind: 'blocked';
+    preferredSchemaVersion: number;
+} | {
+    kind: 'reverted';
+    preferredSchemaVersion: number;
+};
 export interface IEditorSelectionData {
     from: number;
     to: number;
@@ -314,6 +326,39 @@ export interface IUser {
     isEns: boolean;
 }
 export { type IComment };
+/**
+ * Storage-agnostic result of an image upload. The editor treats both fields
+ * as opaque: `url` is a fetchable location of the encrypted blob (e.g. an
+ * IPFS gateway URL or a Swarm `/bytes` URL) and `contentRef` is the backend's
+ * content address (IPFS CID, Swarm reference, ...). Both are stored in the
+ * document and handed back verbatim to `imageFetchFn`.
+ */
+export interface StorageImageUploadResponse {
+    encryptionKey: string;
+    nonce: string;
+    authTag: string;
+    url: string;
+    contentRef: string;
+}
+/**
+ * Storage-agnostic payload handed to `imageFetchFn`: the `url`/`contentRef`
+ * returned by `imageUploadFn` at upload time, plus the parameters needed to
+ * decrypt the blob.
+ */
+export interface StorageImageFetchPayload {
+    encryptionKey: string;
+    nonce: string;
+    authTag: string;
+    mimeType: string;
+    url: string;
+    contentRef: string;
+}
+export type ImageUploadFn = (file: File) => Promise<StorageImageUploadResponse>;
+export type ImageFetchFn = (_data: StorageImageFetchPayload) => Promise<{
+    url: string;
+    file: File;
+}>;
+/** @deprecated Use the storage-agnostic {@link StorageImageUploadResponse} instead. */
 export interface IpfsImageUploadResponse {
     encryptionKey: string;
     nonce: string;
@@ -321,6 +366,7 @@ export interface IpfsImageUploadResponse {
     ipfsHash: string;
     authTag: string;
 }
+/** @deprecated Use the storage-agnostic {@link StorageImageFetchPayload} instead. */
 export interface IpfsImageFetchPayload {
     encryptionKey: string;
     nonce: string;

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

@@ -1,12 +1,10 @@
 import { DdocProps } from './types';
 import { Editor } from '@tiptap/react';
 import { DBlockRuntimeState } from './extensions/d-block/dblock-runtime';
-import { EditorWidthStore } from './utils/editor-width-store';
 
-export declare const useDdocEditor: ({ isPreviewMode, viewerMode, initialContent, versionHistoryState, collaboration, onChange, onCollaboratorChange, onCommentInteraction, onError, setCharacterCount, setWordCount, setSelectedWordCount, setPageCount, onStatsChange, ipfsImageUploadFn, ddocId, enableIndexeddbSync, unFocused, isFocusMode, theme, zoomLevel, onInvalidContentError, ignoreCorruptedData, isPresentationMode, metadataProxyUrl, extensions: externalExtensions, onCopyHeadingLink, ipfsImageFetchFn, fetchV1ImageFn, isConnected, activeModel, maxTokens, isAIAgentEnabled, onIndexedDbError, disableInlineComment, initialCommentAnchors, isPreviewEditor, fonts, preferredSchemaVersion, editorWidthStore, ...rest }: Partial<DdocProps> & {
+export declare const useDdocEditor: ({ isPreviewMode, viewerMode, initialContent, versionHistoryState, collaboration, onChange, onLocalChange, isNewDocument, onCollaboratorChange, onCommentInteraction, onError, setCharacterCount, setWordCount, setSelectedWordCount, setPageCount, ipfsImageUploadFn, ddocId, enableIndexeddbSync, unFocused, isFocusMode, theme, zoomLevel, onInvalidContentError, ignoreCorruptedData, isPresentationMode, metadataProxyUrl, extensions: externalExtensions, onCopyHeadingLink, ipfsImageFetchFn, fetchV1ImageFn, isConnected, activeModel, maxTokens, isAIAgentEnabled, onIndexedDbError, disableInlineComment, initialCommentAnchors, isPreviewEditor, fonts, preferredSchemaVersion, onSchemaStampGuard, ...rest }: Partial<DdocProps> & {
     isFocusMode?: boolean;
     isPreviewEditor?: boolean;
-    editorWidthStore?: EditorWidthStore;
 }) => {
     ydoc: import('yjs').Doc;
     awareness: import('y-protocols/awareness.js').Awareness | null;

package/dist/package/utils/focus-mode-canvas-click.d.ts

@@ -0,0 +1,2 @@
+/** Whether a focus-mode mousedown landed on the bare canvas around the page. */
+export declare const isFocusModeCanvasClick: (target: Element, editorContent: Element | null) => boolean;

package/dist/package/utils/responsive.d.ts

@@ -1,6 +1,4 @@
-import { EditorWidthStore } from './editor-width-store';
-
-export declare const useResponsive: (store?: EditorWidthStore) => {
+export declare const useResponsive: () => {
     isBelow1024px: boolean;
     isBelow1280px: boolean;
     isMobileScreen: boolean;

package/dist/package/utils/schema-version.d.ts

@@ -4,3 +4,5 @@ export declare const SCHEMA_VERSION_META_KEY = "schemaVersion";
 export declare const SUPPORTED_SCHEMA_VERSION = 2;
 export declare const getDocSchemaVersion: (doc: Y.Doc) => number;
 export declare const isDocSchemaSupported: (doc: Y.Doc) => boolean;
+export declare const docHasBlockContent: (doc: Y.Doc) => boolean;
+export declare const docHasV1Blocks: (doc: Y.Doc) => boolean;

package/dist/package/utils/storage-adapter.d.ts

@@ -0,0 +1,30 @@
+import { ImageFetchFn, ImageUploadFn, IpfsImageFetchPayload, IpfsImageUploadResponse } from '../types';
+
+/**
+ * Boundary adapters between the storage-agnostic public props
+ * (`imageUploadFn` / `imageFetchFn`) and the IPFS-shaped interface the editor
+ * internals still use. Internals are untouched: a storage-agnostic host
+ * function is wrapped here, at the prop boundary, so that downstream code
+ * keeps seeing the legacy `ipfsUrl` / `ipfsHash` field names regardless of
+ * which backend the host actually stores on.
+ */
+type LegacyImageUploadFn = (file: File) => Promise<IpfsImageUploadResponse>;
+type LegacyImageFetchFn = (_data: IpfsImageFetchPayload) => Promise<{
+    url: string;
+    file: File;
+}>;
+/**
+ * Resolve the upload function to use internally. The storage-agnostic
+ * `imageUploadFn` wins over the deprecated `ipfsImageUploadFn`; its response
+ * is mapped onto the legacy field names (`url` → `ipfsUrl`,
+ * `contentRef` → `ipfsHash`).
+ */
+export declare const resolveImageUploadFn: (imageUploadFn?: ImageUploadFn, ipfsImageUploadFn?: LegacyImageUploadFn) => LegacyImageUploadFn | undefined;
+/**
+ * Resolve the fetch function to use internally. The storage-agnostic
+ * `imageFetchFn` wins over the deprecated `ipfsImageFetchFn`; the legacy
+ * payload built by the internals is mapped onto the agnostic field names
+ * (`ipfsUrl` → `url`, `ipfsHash` → `contentRef`).
+ */
+export declare const resolveImageFetchFn: (imageFetchFn?: ImageFetchFn, ipfsImageFetchFn?: LegacyImageFetchFn) => LegacyImageFetchFn | undefined;
+export {};

package/dist/persistence.d.ts

@@ -0,0 +1 @@
+export * from './package/persistence';

package/dist/persistence.es.js

@@ -0,0 +1,10 @@
+import { D as n, a as o, d as D, g as a, m as r, r as d, b as C } from "./ddoc-persistence-C2ay3lLb.mjs";
+export {
+  n as DDOC_STORE_REPAIRED,
+  o as DEFAULT_DDOC_PERSISTENCE_TIMEOUT_MS,
+  D as deleteDdocContent,
+  a as getDdocContentFingerprint,
+  r as mergeDdocContent,
+  d as readDdocContent,
+  C as repairDdocContent
+};

package/dist/{split-view-toolbar-BnfwwwTs.mjs → split-view-toolbar-CbVFNI6B.mjs}

@@ -1,7 +1,7 @@
 import { jsx as m, jsxs as L } from "react/jsx-runtime";
 import { useRef as D, useState as E, useEffect as A } from "react";
 import { DynamicDropdown as P, Tooltip as O, IconButton as T } from "@fileverse/ui";
-import { a3 as _, a4 as w, c as R } from "./index-8MQH4TSF.mjs";
+import { r as _, u as w, E as R } from "./index-D9uM5S2Y.mjs";
 const p = (e, n, o = n) => {
   const { state: i } = e, l = i.changeByRange((t) => {
     const d = i.sliceDoc(t.from, t.to), r = i.sliceDoc(