@sofereditor/react 0.5.0 → 0.7.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { RefObject, JSX, ReactNode } from 'react';
-import { EditorDocument, EditorHistory, SerializedDocument, Selection, MarkName, MarkAttrs, BlockType, BlockAttrs, AlignValue, TableBorderPreset, ListKind, PageSettings, TableLocation, AnswerLineSpacing, TableRect, ImageEmbed, EmbedLoc, SerializedBlock, DeltaOp, Position } from '@sofereditor/core';
+import { EditorDocument, EditorHistory, SerializedDocument, Selection, MarkName, MarkAttrs, BlockType, BlockAttrs, AlignValue, TableBorderPreset, ListKind, PageSettings, TableLocation, AnswerLineSpacing, TableRect, ImageEmbed, EmbedLoc, SerializedBlock, DeltaOp, Position, ClipboardSlice } from '@sofereditor/core';
 
 /**
  * Subconjunto mínimo da Awareness do y-protocols que o overlay usa. Tipar assim
@@ -264,6 +264,15 @@ interface UseEditorResult {
         cellIndex?: number;
         embed: ImageEmbed;
     } | null;
+    /**
+     * Passthrough of `UseEditorOptions.uploadImage` — `undefined` when not
+     * configured. Exposed so callers with the editor instance but not the
+     * original options (the `<Editor>` component's paste handler, notably) can
+     * upload an image without going through `insertImageFromFile` (which also
+     * inserts it — not always what's wanted, e.g. resolving `data:` embeds
+     * already inside a pasted slice before `insertSlice`).
+     */
+    uploadImage?: (file: File) => Promise<string>;
 }
 declare function useEditor(opts?: UseEditorOptions): UseEditorResult;
 
@@ -440,4 +449,38 @@ declare function selectionsEqual(a: Selection, b: Selection): boolean;
 declare function isTableRectSelection(sel: Selection): boolean;
 declare function applyDomSelection(root: HTMLElement, modelSel: Selection): void;
 
-export { A4_PAGE, type BlockFragment, type CaptionAlign, Editor, type EditorProps, EditorProvider, type EditorProviderProps, ImageCaptionDialog, type ImageCaptionRequest, type ImageCaptionResult, LinkDialog, type LinkRequest, NodeView, type NodeViewFragment, PageConfigDialog, type PageConfigRequest, type PageEntry, type PageGeometry, type PageLayout, type PageLayoutResult, type PageRenderContext, type PageRenderProp, type PageSlot, type PaginationPhase, type PendingMarks, RemoteCursorsOverlay, type TableRowFragment, Toolbar, type ToolbarProps, type UseEditorOptions, type UseEditorResult, applyDomSelection, contentHeight, contentWidth, defaultPageLayout, deltaLength, findBlockIndex, getBlockElement, getCellElement, getFragmentForOffset, isTableRectSelection, locatePoint, readDomSelection, renderInline, selectionsEqual, sliceDelta, textOffsetWithin, useEditor, useEditorContext, usePageLayout, usePageSettings };
+/**
+ * Converte o HTML do clipboard (Word / Google Docs / navegador) num
+ * `ClipboardSlice` que o editor já sabe inserir via `insertSlice`.
+ *
+ * Sempre bloco-inteiro: `openStart`/`openEnd` são `false` e `blockLevel` é
+ * `true` — o conteúdo colado de fora não é um fragmento de um dos blocos do
+ * editor, é uma sequência de blocos novos. `blockLevel: true` é o que diz a
+ * `insertSlice` (em `@sofereditor/core`) para adotar type/attrs do bloco
+ * colado em vez de tratá-lo como fragmento de seleção — ver o comentário em
+ * `ClipboardSlice.blockLevel`.
+ *
+ * Retorna `null` quando não sobra nada aproveitável, para o chamador (`Editor.tsx`)
+ * cair no ramo de texto puro em vez de engolir a colagem.
+ *
+ * Duas armadilhas reais que este módulo trata explicitamente (ver testes):
+ *  - Google Docs embrulha o documento inteiro num `<b style="font-weight:normal"
+ *    id="docs-internal-guid-...">` — uma tag inline por fora de blocos inteiros.
+ *    `hasBlockDescendant` detecta isso e trata o wrapper como transparente
+ *    (propaga as marcas resolvidas, mas não achata os blocos internos).
+ *  - Word não usa `<ul>/<ol>/<li>` — usa `<p style="mso-list:l0 level1 ...">`
+ *    com o marcador (número/símbolo) como texto literal dentro de um span
+ *    `mso-list:Ignore`. `parseWordListLevel` + a exclusão desse span tratam isso.
+ *
+ * fontFamily é deliberadamente NUNCA emitida: a escola padroniza Arial e cada
+ * documento tem sua própria tipografia (mesma decisão de `import-docx`, que
+ * descarta `w:rFonts`). fontSize É preservado (ver `parseFontSizePt`): o
+ * modelo já suporta a mark, a barra já tem controle de tamanho, e descartar o
+ * tamanho perdia informação real (título de 37.5pt colado do Google Docs saía
+ * do tamanho do corpo). Unidades que dependem do contexto de herança do
+ * documento de origem (em/rem/%/larger/smaller/medium) não são resolvíveis
+ * aqui e por isso não emitem marca — sem tamanho é melhor que tamanho errado.
+ */
+declare function htmlToSlice(html: string): ClipboardSlice | null;
+
+export { A4_PAGE, type BlockFragment, type CaptionAlign, Editor, type EditorProps, EditorProvider, type EditorProviderProps, ImageCaptionDialog, type ImageCaptionRequest, type ImageCaptionResult, LinkDialog, type LinkRequest, NodeView, type NodeViewFragment, PageConfigDialog, type PageConfigRequest, type PageEntry, type PageGeometry, type PageLayout, type PageLayoutResult, type PageRenderContext, type PageRenderProp, type PageSlot, type PaginationPhase, type PendingMarks, RemoteCursorsOverlay, type TableRowFragment, Toolbar, type ToolbarProps, type UseEditorOptions, type UseEditorResult, applyDomSelection, contentHeight, contentWidth, defaultPageLayout, deltaLength, findBlockIndex, getBlockElement, getCellElement, getFragmentForOffset, htmlToSlice, isTableRectSelection, locatePoint, readDomSelection, renderInline, selectionsEqual, sliceDelta, textOffsetWithin, useEditor, useEditorContext, usePageLayout, usePageSettings };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { RefObject, JSX, ReactNode } from 'react';
-import { EditorDocument, EditorHistory, SerializedDocument, Selection, MarkName, MarkAttrs, BlockType, BlockAttrs, AlignValue, TableBorderPreset, ListKind, PageSettings, TableLocation, AnswerLineSpacing, TableRect, ImageEmbed, EmbedLoc, SerializedBlock, DeltaOp, Position } from '@sofereditor/core';
+import { EditorDocument, EditorHistory, SerializedDocument, Selection, MarkName, MarkAttrs, BlockType, BlockAttrs, AlignValue, TableBorderPreset, ListKind, PageSettings, TableLocation, AnswerLineSpacing, TableRect, ImageEmbed, EmbedLoc, SerializedBlock, DeltaOp, Position, ClipboardSlice } from '@sofereditor/core';
 
 /**
  * Subconjunto mínimo da Awareness do y-protocols que o overlay usa. Tipar assim
@@ -264,6 +264,15 @@ interface UseEditorResult {
         cellIndex?: number;
         embed: ImageEmbed;
     } | null;
+    /**
+     * Passthrough of `UseEditorOptions.uploadImage` — `undefined` when not
+     * configured. Exposed so callers with the editor instance but not the
+     * original options (the `<Editor>` component's paste handler, notably) can
+     * upload an image without going through `insertImageFromFile` (which also
+     * inserts it — not always what's wanted, e.g. resolving `data:` embeds
+     * already inside a pasted slice before `insertSlice`).
+     */
+    uploadImage?: (file: File) => Promise<string>;
 }
 declare function useEditor(opts?: UseEditorOptions): UseEditorResult;
 
@@ -440,4 +449,38 @@ declare function selectionsEqual(a: Selection, b: Selection): boolean;
 declare function isTableRectSelection(sel: Selection): boolean;
 declare function applyDomSelection(root: HTMLElement, modelSel: Selection): void;
 
-export { A4_PAGE, type BlockFragment, type CaptionAlign, Editor, type EditorProps, EditorProvider, type EditorProviderProps, ImageCaptionDialog, type ImageCaptionRequest, type ImageCaptionResult, LinkDialog, type LinkRequest, NodeView, type NodeViewFragment, PageConfigDialog, type PageConfigRequest, type PageEntry, type PageGeometry, type PageLayout, type PageLayoutResult, type PageRenderContext, type PageRenderProp, type PageSlot, type PaginationPhase, type PendingMarks, RemoteCursorsOverlay, type TableRowFragment, Toolbar, type ToolbarProps, type UseEditorOptions, type UseEditorResult, applyDomSelection, contentHeight, contentWidth, defaultPageLayout, deltaLength, findBlockIndex, getBlockElement, getCellElement, getFragmentForOffset, isTableRectSelection, locatePoint, readDomSelection, renderInline, selectionsEqual, sliceDelta, textOffsetWithin, useEditor, useEditorContext, usePageLayout, usePageSettings };
+/**
+ * Converte o HTML do clipboard (Word / Google Docs / navegador) num
+ * `ClipboardSlice` que o editor já sabe inserir via `insertSlice`.
+ *
+ * Sempre bloco-inteiro: `openStart`/`openEnd` são `false` e `blockLevel` é
+ * `true` — o conteúdo colado de fora não é um fragmento de um dos blocos do
+ * editor, é uma sequência de blocos novos. `blockLevel: true` é o que diz a
+ * `insertSlice` (em `@sofereditor/core`) para adotar type/attrs do bloco
+ * colado em vez de tratá-lo como fragmento de seleção — ver o comentário em
+ * `ClipboardSlice.blockLevel`.
+ *
+ * Retorna `null` quando não sobra nada aproveitável, para o chamador (`Editor.tsx`)
+ * cair no ramo de texto puro em vez de engolir a colagem.
+ *
+ * Duas armadilhas reais que este módulo trata explicitamente (ver testes):
+ *  - Google Docs embrulha o documento inteiro num `<b style="font-weight:normal"
+ *    id="docs-internal-guid-...">` — uma tag inline por fora de blocos inteiros.
+ *    `hasBlockDescendant` detecta isso e trata o wrapper como transparente
+ *    (propaga as marcas resolvidas, mas não achata os blocos internos).
+ *  - Word não usa `<ul>/<ol>/<li>` — usa `<p style="mso-list:l0 level1 ...">`
+ *    com o marcador (número/símbolo) como texto literal dentro de um span
+ *    `mso-list:Ignore`. `parseWordListLevel` + a exclusão desse span tratam isso.
+ *
+ * fontFamily é deliberadamente NUNCA emitida: a escola padroniza Arial e cada
+ * documento tem sua própria tipografia (mesma decisão de `import-docx`, que
+ * descarta `w:rFonts`). fontSize É preservado (ver `parseFontSizePt`): o
+ * modelo já suporta a mark, a barra já tem controle de tamanho, e descartar o
+ * tamanho perdia informação real (título de 37.5pt colado do Google Docs saía
+ * do tamanho do corpo). Unidades que dependem do contexto de herança do
+ * documento de origem (em/rem/%/larger/smaller/medium) não são resolvíveis
+ * aqui e por isso não emitem marca — sem tamanho é melhor que tamanho errado.
+ */
+declare function htmlToSlice(html: string): ClipboardSlice | null;
+
+export { A4_PAGE, type BlockFragment, type CaptionAlign, Editor, type EditorProps, EditorProvider, type EditorProviderProps, ImageCaptionDialog, type ImageCaptionRequest, type ImageCaptionResult, LinkDialog, type LinkRequest, NodeView, type NodeViewFragment, PageConfigDialog, type PageConfigRequest, type PageEntry, type PageGeometry, type PageLayout, type PageLayoutResult, type PageRenderContext, type PageRenderProp, type PageSlot, type PaginationPhase, type PendingMarks, RemoteCursorsOverlay, type TableRowFragment, Toolbar, type ToolbarProps, type UseEditorOptions, type UseEditorResult, applyDomSelection, contentHeight, contentWidth, defaultPageLayout, deltaLength, findBlockIndex, getBlockElement, getCellElement, getFragmentForOffset, htmlToSlice, isTableRectSelection, locatePoint, readDomSelection, renderInline, selectionsEqual, sliceDelta, textOffsetWithin, useEditor, useEditorContext, usePageLayout, usePageSettings };