nuvra 0.6.0 → 0.7.0

package/dist/components/document-editor.vue.d.ts

@@ -5,7 +5,7 @@ import { type EditorLocaleInput } from '../core/labels';
 import { type DocumentViewMode, type PageSettings } from '../core/page';
 import type { SlashCommand } from '../core/slash-commands';
 import type { TemplateVariable } from '../core/templates';
-import type { DocumentImageUploadHandler } from '../core/types';
+import type { DocumentImageUploadHandler, ToolbarTool } from '../core/types';
 import { type EditorUiState } from '../core/ui-state';
 import '../styles/document-content.css';
 import '../styles/editor-ui.css';
@@ -44,6 +44,11 @@ interface Props {
     ruler?: boolean;
     /** Used as the print title and the exported file name. */
     title?: string;
+    /**
+     * Toolbar tools to show, such as `['history', 'marks', 'lists', 'link']`; every tool without a list. Keyboard
+     * shortcuts, the `/` menu and the right-click menu are not affected.
+     */
+    tools?: readonly ToolbarTool[];
     /** Uploads an inserted image and resolves with its URL; without it images are embedded as data URLs. */
     uploadImage?: DocumentImageUploadHandler;
     /** Template variables the user can insert; typing `{{name}}` of one of them inserts it as well. */
@@ -120,13 +125,14 @@ declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {
     height: CssSize;
     locale: EditorLocaleInput;
     ruler: boolean;
+    variables: readonly TemplateVariable[];
     placeholder: string;
     disabled: boolean;
     minHeight: CssSize;
     collaborators: readonly Collaborator[];
     maxHeight: CssSize;
     maxLength: number;
-    variables: readonly TemplateVariable[];
+    tools: readonly ToolbarTool[];
     author: string;
     autofocus: boolean;
     canvasPadding: CssSize;

package/dist/components/editor-toolbar.vue.d.ts

@@ -1,7 +1,7 @@
 import type { DocumentEngine } from '../core/engine/engine';
 import { type PageSettings } from '../core/page';
 import type { TemplateVariable } from '../core/templates';
-import type { DocumentMenuAction } from '../core/types';
+import { type DocumentMenuAction, type ToolbarTool } from '../core/types';
 import { type EditorUiState } from '../core/ui-state';
 interface Props {
     /** Read-only document: every editing control is disabled. */
@@ -36,6 +36,8 @@ interface Props {
     uploading: boolean;
     /** Template variables offered by the variable menu; the menu is hidden without any. */
     variables: ReadonlyArray<TemplateVariable>;
+    /** Tools to show; every tool without a list. */
+    tools: readonly ToolbarTool[] | undefined;
 }
 declare var __VLS_626: {};
 type __VLS_Slots = {} & {

package/dist/core/collaboration.d.ts

@@ -10,16 +10,16 @@ export interface SelectionOffsets {
     /** Where the caret is. */
     focus: number;
 }
-/** Someone else editing the same document. */
+/** Someone else edits the same document. */
 export interface Collaborator {
     /** Stable id of the person or connection. */
     id: string;
     /** Name shown next to the caret. */
     name: string;
-    /** CSS colour of the caret and the selection; one is picked from the id when it is left out. */
+    /** CSS color of the caret and the selection; one is picked from the id when it is left out. */
     color?: string;
     /** Where the person's caret or selection is, or `null` while they are not in the document. */
     selection: SelectionOffsets | null;
 }
-/** The colour of a collaborator: their own, or a stable one derived from the id. */
+/** The color of a collaborator: their own, or a stable one derived from the id. */
 export declare const collaboratorColor: (collaborator: Pick<Collaborator, "id" | "color">) => string;

package/dist/core/docx/import.d.ts

@@ -8,7 +8,7 @@ import { type PageSettings } from '../page';
 export interface DocxImport {
     /** Document content as HTML. */
     html: string;
-    /** Page setup of the document's last section. */
+    /** Page setup of the document's first section; later sections are section breaks in the HTML. */
     page: PageSettings;
 }
 /**

package/dist/core/engine/clipboard.d.ts

@@ -15,7 +15,7 @@ export declare const imageFiles: (content: TransferContent) => File[];
 export declare const singleUrl: (content: TransferContent) => string | null;
 /** Converts plain text into paragraphs, one per line; a final line break does not add an empty paragraph. */
 export declare const textToFragment: (text: string) => DocumentFragment;
-/** Converts a payload into editor blocks, preferring sanitised HTML over plain text; `null` when it has neither. */
+/** Converts a payload into editor blocks, preferring sanitized HTML over plain text; `null` when it has neither. */
 export declare const transferToFragment: (content: TransferContent) => DocumentFragment | null;
 /** Clean HTML and plain text of a selection, as put on the clipboard by copy, cut and drag. */
 export declare const selectionClipboardData: (root: HTMLElement, range: Range) => {

package/dist/core/engine/schema.d.ts

@@ -6,6 +6,12 @@ export declare const VARIABLE_LABEL_ATTRIBUTE = "data-label";
 export declare const ROTATED_ATTRIBUTE = "data-doc-rotated";
 /** Attribute pagination writes on blocks it moved to the next sheet; editor-only. */
 export declare const GAP_ATTRIBUTE = "data-doc-gap";
+/** Attribute pagination writes on table rows it moved down to the next sheet, with the shift in pixels; editor-only. */
+export declare const ROW_SHIFT_ATTRIBUTE = "data-doc-row-shift";
+/** Attribute pagination writes on tables split over sheets, with the space their moved rows add; editor-only. */
+export declare const TABLE_SHIFT_ATTRIBUTE = "data-doc-table-shift";
+/** Attribute pagination sets on the editable root while the document is laid out on sheets; editor-only. */
+export declare const PAGED_ATTRIBUTE = "data-doc-paged";
 /** Class marking table cells in a drag selection; editor-only. */
 export declare const SELECTED_CELL_CLASS = "doc-cell-selected";
 /** Attribute holding the space a paragraph keeps before it, in points. */

package/dist/core/types.d.ts

@@ -1,3 +1,10 @@
 /** Uploads an image and resolves with its public URL. Without a handler, images are embedded as data URLs. */
 export type DocumentImageUploadHandler = (file: File) => Promise<string>;
 export type DocumentMenuAction = 'source' | 'print' | 'exportHtml' | 'exportWord' | 'exportPdf' | 'importWord' | 'formattingMarks' | 'ruler' | 'outline' | 'tableOfContents' | 'comments' | 'addComment' | 'footnote' | 'trackChanges' | 'changes' | 'fullscreen';
+/**
+ * Tools of the editor toolbar, in the order they appear. Pass a list of them as the `tools` prop to show only those;
+ * keyboard shortcuts, the `/` menu and the right-click menu keep working either way.
+ */
+export declare const TOOLBAR_TOOLS: readonly ["history", "formatPainter", "blockStyle", "fontFamily", "fontSize", "marks", "textCase", "color", "highlight", "align", "lineHeight", "direction", "lists", "indent", "link", "image", "table", "specialCharacters", "variables", "signature", "insert", "review", "search", "templates", "headerFooter", "pageSetup", "more"];
+/** A tool of the editor toolbar; see {@link TOOLBAR_TOOLS}. */
+export type ToolbarTool = (typeof TOOLBAR_TOOLS)[number];

package/dist/editor.vue.d.ts

@@ -1,6 +1,6 @@
 import type { EditorLocaleInput } from './core/labels';
 import type { TemplateVariable } from './core/templates';
-import type { DocumentImageUploadHandler } from './core/types';
+import type { DocumentImageUploadHandler, ToolbarTool } from './core/types';
 interface Props {
     /** Places the caret at the end of the content once the editor is ready. */
     autofocus?: boolean;
@@ -20,6 +20,8 @@ interface Props {
     minHeight?: number | string;
     /** Text shown while the field is empty. */
     placeholder?: string;
+    /** Toolbar tools to show; every tool without a list. */
+    tools?: readonly ToolbarTool[];
     /** Uploads an image and resolves with its URL; without it images are embedded as data URLs. */
     uploadImage?: DocumentImageUploadHandler;
     /** Template variables the user can insert; typing `{{name}}` of one of them inserts it as well. */
@@ -43,12 +45,13 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {},
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }>, {
     locale: EditorLocaleInput;
+    variables: readonly TemplateVariable[];
     placeholder: string;
     disabled: boolean;
     minHeight: number | string;
     maxHeight: number | string;
     maxLength: number;
-    variables: readonly TemplateVariable[];
+    tools: readonly ToolbarTool[];
     autofocus: boolean;
     canvasPadding: number | string;
     maxImageSizeMb: number;

package/dist/form.vue.d.ts

@@ -32,8 +32,8 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {
     "onUpdate:modelValue"?: ((value: Record<string, string>) => any) | undefined;
 }>, {
     locale: EditorLocaleInput;
-    readonly: boolean;
     variables: readonly TemplateVariable[];
+    readonly: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/index.d.ts

@@ -32,7 +32,8 @@ export type { FillTemplateOptions, TemplateValues, TemplateVariable } from './co
 export { fillTemplate, getTemplateVariables } from './core/templates';
 export type { TransliterationDirection } from './core/transliterate';
 export { transliterate } from './core/transliterate';
-export type { DocumentImageUploadHandler } from './core/types';
+export type { DocumentImageUploadHandler, ToolbarTool } from './core/types';
+export { TOOLBAR_TOOLS } from './core/types';
 export type { EditorUiState } from './core/ui-state';
 export { default as Editor } from './editor.vue';
 export { default as DocumentForm } from './form.vue';