@arbidocs/blocks 0.4.96 → 0.4.98

package/dist/databases/linkCells.d.ts

@@ -34,15 +34,17 @@ export declare function PersonCell({ value, titles }: {
     value: unknown;
     titles?: Record<string, string>;
 }): import("react").JSX.Element | null;
-export declare function LinkChipsCell({ value, titles, kind, onOpenDocument, }: {
+export declare function LinkChipsCell({ value, titles, kind, onOpenDocument, wrap, }: {
     value: unknown;
     titles?: Record<string, string>;
     kind: 'document' | 'relation';
     onOpenDocument?: (id: string) => void;
+    wrap?: boolean;
 }): import("react").JSX.Element | null;
 /** A lookup's values: related rows and documents as chips, anything else as quiet tags. */
-export declare function LookupCell({ value, titles, locale, }: {
+export declare function LookupCell({ value, titles, locale, wrap, }: {
     value: unknown;
     titles?: Record<string, string>;
     locale?: string;
+    wrap?: boolean;
 }): import("react").JSX.Element | null;

package/dist/docx/NativeDocxEditor.d.ts

@@ -3,6 +3,7 @@ import React from 'react';
 import { type FontConfiguration } from '@docx-editor.dev/react';
 import type { DocxCollaborationSession } from '@arbidocs/coedit';
 import type { DefinitionSource } from '../tags/definitions';
+import { type HouseTemplateHost } from './template/HouseTemplate';
 /**
  * The editor path of a document's DOCX bytes. A version reference (`doc-…@v2`, a read-only
  * snapshot of an older version) reads that version; a plain id the current one.
@@ -44,6 +45,12 @@ export interface NativeDocxAdapter {
      * Defined term and Update definitions, and typing `@@` in the body opens the term type-ahead.
      */
     definitions?: () => Promise<DefinitionSource[]>;
+    /**
+     * The workspace's house template. Present: a blank note starts from it (its styles, numbering,
+     * page setup, headers and footers), Insert offers its Quick Parts, and the Design tab and the
+     * style box show where the document's styles differ from it.
+     */
+    houseTemplate?: HouseTemplateHost;
 }
 export interface NativeDocxEditorProps {
     adapter: NativeDocxAdapter;

package/dist/docx/RibbonMenu.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+/**
+ * A ribbon button that opens a panel under the ribbon (Font, More formatting, the style gallery).
+ * Pressing the trigger never takes the caret out of the document; the panel closes on Escape or a
+ * press outside it. `children` may be a function that receives `close`, for panels that close
+ * themselves once the user has picked something.
+ */
+export declare function RibbonMenu({ label, icon, children, className, testId, title, }: {
+    label: string;
+    /** Tooltip; defaults to `label`. */
+    title?: string;
+    /** Trigger content: an icon, or a short text label with a `className` that widens it. */
+    icon: React.ReactNode;
+    children: React.ReactNode | ((close: () => void) => React.ReactNode);
+    className?: string;
+    testId?: string;
+}): React.JSX.Element;

package/dist/docx/StyleGallery.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Word's Styles group for the native editor's Home tab: a box showing the current paragraph's
+ * style that opens a gallery of the document's own paragraph styles (from its `styles.xml`, so a
+ * firm template's styles appear beside the built-ins), each drawn in its own face, with Normal,
+ * Title and Headings 1-3 as quick picks. Applying a style writes `w:pStyle`.
+ */
+import React from 'react';
+/** The Home tab's style box: the current paragraph style, opening the gallery. */
+export declare function StyleGallery(): React.JSX.Element;

package/dist/docx/WordReferences.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Footnotes and endnotes for the native editor's References tab, and Word's keyboard shortcuts
+ * for notes and paragraph styles.
+ *
+ * The engine owns notes end to end: Insert footnote writes a `w:footnoteReference` at the caret
+ * and its note in `footnotes.xml` (creating the part on a document that has none), moves the caret
+ * into the note so the user types it straight away, numbers notes in document order, and lays
+ * them out at the foot of the page, where an existing note is edited in place. What it leaves out
+ * is Word's note paragraph style, so a new note is given the document's "footnote text" (or
+ * "endnote text") style when it defines one.
+ */
+import React, { type RefObject } from 'react';
+/** References tab: Insert footnote, Insert endnote. */
+export declare function NoteButtons(): React.JSX.Element;
+/**
+ * Binds Word's note and style shortcuts to key presses inside `scope` (the editor's page area),
+ * ahead of the editor's own handling. Renders nothing; mount it inside `DocxEditor.Root`.
+ */
+export declare function WordShortcuts({ scope }: {
+    scope: RefObject<HTMLElement | null>;
+}): null;

package/dist/docx/index.cjs

@@ -1,8 +1,8 @@
 "use client";
 'use strict';
 
-var chunkSC33PQTQ_cjs = require('../chunk-SC33PQTQ.cjs');
-var chunk7RI3G5BO_cjs = require('../chunk-7RI3G5BO.cjs');
+var chunkMUYZP5FB_cjs = require('../chunk-MUYZP5FB.cjs');
+var chunkMIMVRMKC_cjs = require('../chunk-MIMVRMKC.cjs');
 require('../chunk-AOFATOT3.cjs');
 require('../chunk-RC25WMVB.cjs');
 require('../chunk-7UTB4PHM.cjs');
@@ -60,7 +60,7 @@ function NativeDocxComparison({
   if (!documentId)
     return /* @__PURE__ */ jsxRuntime.jsx("div", { className: "native-docx-error", role: "status", children: "Comparing Word documents\u2026" });
   return /* @__PURE__ */ jsxRuntime.jsx(
-    chunk7RI3G5BO_cjs.NativeDocxEditor,
+    chunkMIMVRMKC_cjs.NativeDocxEditor,
     {
       adapter,
       documentId,
@@ -72,87 +72,115 @@ function NativeDocxComparison({
 
 Object.defineProperty(exports, "StreamedWordArtifact", {
   enumerable: true,
-  get: function () { return chunkSC33PQTQ_cjs.StreamedWordArtifact; }
+  get: function () { return chunkMUYZP5FB_cjs.StreamedWordArtifact; }
+});
+Object.defineProperty(exports, "BUILTIN_TEMPLATE_NAME", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.BUILTIN_TEMPLATE_NAME; }
 });
 Object.defineProperty(exports, "DEFAULT_DEFINED_TERMS_LABELS", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DEFAULT_DEFINED_TERMS_LABELS; }
+  get: function () { return chunkMIMVRMKC_cjs.DEFAULT_DEFINED_TERMS_LABELS; }
 });
 Object.defineProperty(exports, "DEFINED_TERM_TRIGGER", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DEFINED_TERM_TRIGGER; }
+  get: function () { return chunkMIMVRMKC_cjs.DEFINED_TERM_TRIGGER; }
 });
 Object.defineProperty(exports, "DefinedTermsProvider", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DefinedTermsProvider; }
+  get: function () { return chunkMIMVRMKC_cjs.DefinedTermsProvider; }
 });
 Object.defineProperty(exports, "DocxCommentActivity", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DocxCommentActivity; }
+  get: function () { return chunkMIMVRMKC_cjs.DocxCommentActivity; }
 });
 Object.defineProperty(exports, "DocxEditorReview", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DocxEditorReview; }
+  get: function () { return chunkMIMVRMKC_cjs.DocxEditorReview; }
 });
 Object.defineProperty(exports, "DocxMentions", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DocxMentions; }
+  get: function () { return chunkMIMVRMKC_cjs.DocxMentions; }
 });
 Object.defineProperty(exports, "DocxParticipants", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DocxParticipants; }
+  get: function () { return chunkMIMVRMKC_cjs.DocxParticipants; }
 });
 Object.defineProperty(exports, "DocxRibbon", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.DocxRibbon; }
+  get: function () { return chunkMIMVRMKC_cjs.DocxRibbon; }
+});
+Object.defineProperty(exports, "HouseTemplateProvider", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.HouseTemplateProvider; }
 });
 Object.defineProperty(exports, "NativeDocxEditor", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.NativeDocxEditor; }
+  get: function () { return chunkMIMVRMKC_cjs.NativeDocxEditor; }
+});
+Object.defineProperty(exports, "builtinHouseTemplate", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.builtinHouseTemplate; }
+});
+Object.defineProperty(exports, "contentPath", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.contentPath; }
 });
 Object.defineProperty(exports, "editorPort", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.editorPort; }
+  get: function () { return chunkMIMVRMKC_cjs.editorPort; }
 });
 Object.defineProperty(exports, "findDefinitionsSection", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.findDefinitionsSection; }
+  get: function () { return chunkMIMVRMKC_cjs.findDefinitionsSection; }
 });
 Object.defineProperty(exports, "insertDefinedTerm", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.insertDefinedTerm; }
+  get: function () { return chunkMIMVRMKC_cjs.insertDefinedTerm; }
 });
 Object.defineProperty(exports, "loadDocxFonts", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.loadDocxFonts; }
+  get: function () { return chunkMIMVRMKC_cjs.loadDocxFonts; }
 });
 Object.defineProperty(exports, "normalizeDocxExport", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.normalizeDocxExport; }
+  get: function () { return chunkMIMVRMKC_cjs.normalizeDocxExport; }
+});
+Object.defineProperty(exports, "resolveHouseTemplate", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.resolveHouseTemplate; }
 });
 Object.defineProperty(exports, "reviewModule", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.reviewModule; }
+  get: function () { return chunkMIMVRMKC_cjs.reviewModule; }
+});
+Object.defineProperty(exports, "templateFileName", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.templateFileName; }
 });
 Object.defineProperty(exports, "updateDefinitions", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.updateDefinitions; }
+  get: function () { return chunkMIMVRMKC_cjs.updateDefinitions; }
 });
 Object.defineProperty(exports, "useDefinedTerms", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.useDefinedTerms; }
+  get: function () { return chunkMIMVRMKC_cjs.useDefinedTerms; }
+});
+Object.defineProperty(exports, "useHouseTemplate", {
+  enumerable: true,
+  get: function () { return chunkMIMVRMKC_cjs.useHouseTemplate; }
 });
 Object.defineProperty(exports, "useReview", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.useReview; }
+  get: function () { return chunkMIMVRMKC_cjs.useReview; }
 });
 Object.defineProperty(exports, "useReviewItem", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.useReviewItem; }
+  get: function () { return chunkMIMVRMKC_cjs.useReviewItem; }
 });
 Object.defineProperty(exports, "withDirectEditing", {
   enumerable: true,
-  get: function () { return chunk7RI3G5BO_cjs.withDirectEditing; }
+  get: function () { return chunkMIMVRMKC_cjs.withDirectEditing; }
 });
 Object.defineProperty(exports, "DocxEditor", {
   enumerable: true,

package/dist/docx/index.d.ts

@@ -12,3 +12,5 @@ export { NativeDocxComparison, type NativeDocxComparisonProps } from './NativeDo
 export { DefinedTermsProvider, useDefinedTerms, DEFINED_TERM_TRIGGER, DEFAULT_DEFINED_TERMS_LABELS, type DefinedTermsProviderProps, type DefinedTermsLabels, } from './definitions/DefinedTerms';
 export { insertDefinedTerm, updateDefinitions, findDefinitionsSection, type UpdateDefinitionsResult, } from './definitions/commands';
 export { editorPort, withDirectEditing, type DefinitionsPort } from './definitions/port';
+export { contentPath } from './NativeDocxEditor';
+export { HouseTemplateProvider, useHouseTemplate, builtinHouseTemplate, resolveHouseTemplate, templateFileName, BUILTIN_TEMPLATE_NAME, type HouseTemplate, type HouseTemplateHost, type HouseTemplateSource, } from './template/HouseTemplate';

package/dist/docx/index.js

@@ -1,7 +1,7 @@
 "use client";
-export { StreamedWordArtifact } from '../chunk-Y52CEKVD.js';
-import { NativeDocxEditor } from '../chunk-K27SDLLN.js';
-export { DEFAULT_DEFINED_TERMS_LABELS, DEFINED_TERM_TRIGGER, DefinedTermsProvider, DocxCommentActivity, DocxEditorReview, DocxMentions, DocxParticipants, DocxRibbon, NativeDocxEditor, editorPort, findDefinitionsSection, insertDefinedTerm, loadDocxFonts, normalizeDocxExport, reviewModule, updateDefinitions, useDefinedTerms, useReview, useReviewItem, withDirectEditing } from '../chunk-K27SDLLN.js';
+export { StreamedWordArtifact } from '../chunk-6B2AWE3I.js';
+import { NativeDocxEditor } from '../chunk-FIEAWH4K.js';
+export { BUILTIN_TEMPLATE_NAME, DEFAULT_DEFINED_TERMS_LABELS, DEFINED_TERM_TRIGGER, DefinedTermsProvider, DocxCommentActivity, DocxEditorReview, DocxMentions, DocxParticipants, DocxRibbon, HouseTemplateProvider, NativeDocxEditor, builtinHouseTemplate, contentPath, editorPort, findDefinitionsSection, insertDefinedTerm, loadDocxFonts, normalizeDocxExport, resolveHouseTemplate, reviewModule, templateFileName, updateDefinitions, useDefinedTerms, useHouseTemplate, useReview, useReviewItem, withDirectEditing } from '../chunk-FIEAWH4K.js';
 import '../chunk-D3QPYKZG.js';
 import '../chunk-AF6RDAJF.js';
 import '../chunk-AA3PT6KR.js';

package/dist/docx/template/HouseTemplate.d.ts

@@ -0,0 +1,64 @@
+/**
+ * The house template inside the Word editor: which template applies (the workspace's, else the
+ * deployment's, else ARBI's built-in legal template), its Quick Parts, and where this document's
+ * styles have drifted from it. Mount `HouseTemplateProvider` inside `DocxEditor.Root`; the ribbon's
+ * Quick Parts, Design tab and the style box read it from context.
+ */
+import React from 'react';
+import { type LinkedLevel, type BuildingBlockInfo, type StyleDivergence } from '@arbidocs/coedit/template';
+export type HouseTemplateSource = 'workspace' | 'deployment' | 'builtin';
+export interface HouseTemplate {
+    /** The .dotx/.docx bytes. */
+    bytes: Uint8Array;
+    /** What to call it: its filename, or "ARBI legal template". */
+    name: string;
+    source: HouseTemplateSource;
+    /** The workspace document it is, when it is one. */
+    documentId?: string;
+}
+/** How the host stores and resolves house templates. */
+export interface HouseTemplateHost {
+    /** The template that applies in this workspace. Falls back to the built-in one when it fails. */
+    load: () => Promise<HouseTemplate>;
+    /**
+     * Make a workspace document the workspace's house template. Present only when the user may
+     * (a workspace owner) and the server stores house templates.
+     */
+    setFromDocument?: (documentId: string) => Promise<void>;
+}
+export declare const BUILTIN_TEMPLATE_NAME = "ARBI legal template";
+/** The file name a document records as its attached template (`w:attachedTemplate`). */
+export declare const templateFileName: (t: Pick<HouseTemplate, "name">) => string;
+/** ARBI's built-in UK legal template, with its Quick Parts. */
+export declare function builtinHouseTemplate(): HouseTemplate;
+/** The template a host resolves, or the built-in one when there is no host or it fails. */
+export declare function resolveHouseTemplate(host?: HouseTemplateHost): Promise<HouseTemplate>;
+interface HouseTemplateContextValue {
+    template: HouseTemplate;
+    blocks: readonly BuildingBlockInfo[];
+    /** Null until measured (or for a document that cannot be read). */
+    divergence: StyleDivergence | null;
+    /** The document was started from this template (it records it as attached). */
+    basedOnTemplate: boolean;
+    /** Outline levels linked to styles in this document (Level 1 → Level 2 …), by style id. */
+    levels: Readonly<Record<string, LinkedLevel>>;
+    /** Insert a Quick Part at the caret, with the styles, numbering and pictures it uses. */
+    insertBlock: (name: string) => boolean;
+    /** Measure the divergence again (after something brought styles in). */
+    refresh: () => void;
+    /** Present when this document may become the workspace's house template. */
+    setAsHouseTemplate?: () => Promise<void>;
+    editable: boolean;
+}
+export declare const useHouseTemplate: () => HouseTemplateContextValue | null;
+export declare function HouseTemplateProvider({ host, documentId, editable, notify, enabled, children, }: {
+    /** False for a generating draft: no template chrome, no measuring. */
+    enabled?: boolean;
+    host?: HouseTemplateHost;
+    /** The stored document this editor shows; absent for an unsaved note. */
+    documentId?: string;
+    editable: boolean;
+    notify?: (message: string, kind: 'success' | 'error') => void;
+    children: React.ReactNode;
+}): React.JSX.Element;
+export {};

package/dist/docx/template/HouseTemplatePanel.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Design › House template: which template new documents start from, whether this document's
+ * styles still match it, and — for a workspace owner — making this document the house template.
+ */
+import React from 'react';
+export declare function HouseTemplatePanel(): React.JSX.Element | null;

package/dist/docx/template/QuickParts.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Insert › Quick Parts: the house template's building blocks (execution blocks, document markings,
+ * document skeletons) by category, each with a preview of its text; picking one inserts it at the
+ * caret with the styles, numbering and pictures it uses.
+ */
+import React from 'react';
+export declare function QuickParts(): React.JSX.Element | null;

package/dist/docx/wordStyles.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Word's paragraph-style vocabulary for the native editor's chrome: finding a built-in style in
+ * the document's own list, showing its name the way Word does, and Word's keyboard shortcuts for
+ * styles and notes.
+ */
+import type { ParagraphStyleOption } from '@docx-editor.dev/react';
+import type { StyleDivergence } from '@arbidocs/coedit/template';
+/** Word's quick picks, by the built-in style names `styles.xml` gives them. */
+export declare const QUICK_STYLES: readonly ["Normal", "Title", "heading 1", "heading 2", "heading 3"];
+/**
+ * The style `name` names, matched the way Word matches built-in names (case-insensitively), with
+ * the conventional id (`Heading1` for "heading 1") as a fallback for documents that name their
+ * styles differently but keep Word's ids.
+ */
+export declare function findStyle(options: readonly ParagraphStyleOption[], name: string): ParagraphStyleOption | undefined;
+/** A style's name as Word shows it: built-in names are stored lower-case ("heading 1"). */
+export declare function styleLabel(name: string): string;
+/**
+ * Word's shortcut for a keydown, or null. Ctrl+Alt (Cmd+Option on a Mac) with F, D or 1-3, and
+ * Ctrl+Shift+N; read from `code` so a keyboard layout cannot move them.
+ */
+export declare function wordShortcut(event: Pick<KeyboardEvent, 'ctrlKey' | 'metaKey' | 'altKey' | 'shiftKey' | 'code'>): 'footnote' | 'endnote' | 'heading 1' | 'heading 2' | 'heading 3' | 'Normal' | null;
+/** A summary of how the document differs, for a tooltip; null when it matches. */
+export declare function divergenceSummary(divergence: StyleDivergence | null): string | null;