@arbidocs/blocks 0.4.98 → 0.4.100

package/dist/docx/layout/caption.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Word's Insert Caption: a paragraph in the `Caption` style reading `Figure 1: text`, whose
+ * number is a `SEQ Figure` field so Word renumbers every caption when fields update.
+ *
+ * The engine has no caption command, but its paste lands an embedded `.docx` fragment intact —
+ * the `w:fldSimple` and the paragraph style, whose definition is merged into the document when
+ * the document has none. The number written as the field's result is the next one in reading
+ * order at insertion; the engine paints a SEQ field's stored result rather than recomputing it.
+ */
+import { type Revision } from '@arbidocs/coedit/template';
+export declare const CAPTION_LABELS: readonly ["Figure", "Table", "Equation"];
+export type CaptionLabel = (typeof CAPTION_LABELS)[number];
+type Node = {
+    id?: string;
+    localName?: string;
+    kind?: string;
+    value?: string;
+    attributes?: readonly {
+        localName: string;
+        value: string;
+    }[];
+    children?: readonly Node[];
+};
+/** The `SEQ` identifier of a field instruction (`SEQ Figure \* ARABIC` -> `Figure`). */
+export declare function seqIdentifier(instruction: string): string | null;
+/**
+ * How many `SEQ <label>` fields the tree holds — simple fields and complex `w:instrText` ones — in
+ * reading order up to and including the paragraph `throughId` (all of them when absent).
+ */
+export declare function countSeqFields(root: Node, label: string, throughId?: string): number;
+/** The caption paragraph: `Label N` with N a SEQ field, then `: text` when there is text. */
+export declare function captionParagraphXml(label: string, number: number, text: string): string;
+/**
+ * Clipboard HTML that pastes the caption as a whole paragraph (the editor's own fragment form),
+ * marked as a tracked insertion by `revision` when one is given.
+ */
+export declare function captionFragmentHtml(label: string, number: number, text: string, revision?: Revision | null): string;
+export {};

package/dist/docx/layout/presets.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Word's Layout presets — Margins, Size and Orientation — as page-setup updates in twips, the
+ * unit `w:pgSz`/`w:pgMar` and the engine's `setPageSetup` use. Pure, so the ribbon's choices and
+ * the preset a section already matches are tested without an editor.
+ */
+import type { PageSetup } from '@docx-editor.dev/react';
+export declare const TWIPS_PER_INCH = 1440;
+export interface MarginPreset {
+    id: string;
+    label: string;
+    /** Twips. */
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+/** Word's Margins gallery (Mirrored is a binding option the engine does not write). */
+export declare const MARGIN_PRESETS: readonly MarginPreset[];
+export interface PaperSize {
+    id: string;
+    label: string;
+    /** Portrait width and height, in twips. */
+    width: number;
+    height: number;
+}
+/** Word's Size gallery: the paper sizes people actually pick. */
+export declare const PAPER_SIZES: readonly PaperSize[];
+/** The margin preset the section matches, if any (the gallery marks it as current). */
+export declare function matchMargins(setup: PageSetup | null): string | null;
+/** The paper size the section matches in either orientation, if any. */
+export declare function matchPaper(setup: PageSetup | null): string | null;
+/** A paper size's dimensions laid the way the section is turned, so picking a size keeps it. */
+export declare function orientedSize(paper: PaperSize, orientation: PageSetup['orientation'] | undefined): {
+    pageWidthTwips: number;
+    pageHeightTwips: number;
+};
+/** `1440` -> `1"`, `1080` -> `0.75"`: how the gallery describes a margin. */
+export declare function inches(twips: number): string;
+/** `Letter` -> `8.5" × 11"`. */
+export declare function paperDescription(paper: PaperSize): string;

package/dist/docx/structural/trackedOrNoted.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Structural inserts (a defined term, a cross-reference, a Quick Part…) in Suggesting mode.
+ *
+ * The engine pastes rich fragments only with direct editing, so a suggesting editor switches for
+ * the paste and back. Done naively the insert then lands untracked. The rule here:
+ *  - not suggesting: insert as before;
+ *  - suggesting: insert the fragment as a tracked insertion (`insert` receives the revision to
+ *    mark it with, see `trackInsertion` in `@arbidocs/coedit/template`), so it shows in the
+ *    review pane and accept/reject takes all of it;
+ *  - if no tracked change by that revision came out of it, attach an attributed comment to the
+ *    inserted range instead ("Inserted defined term: Shares"), so the insert is still reviewable.
+ *
+ * Written against a small port, not the React editor, so the collaboration service's headless
+ * path can apply the same rule.
+ */
+import type { DocxEditorInstance } from '@docx-editor.dev/core';
+import type { Revision } from '@arbidocs/coedit/template';
+import type { DocPoint } from '../definitions/port';
+export type { Revision };
+export type EditingMode = 'editing' | 'suggesting' | 'viewing';
+/** What the rule needs from an editor. */
+export interface StructuralPort {
+    mode(): EditingMode;
+    setMode(mode: EditingMode): void;
+    caret(): DocPoint | null;
+    /** How many tracked changes in the document carry exactly this author and date. */
+    trackedBy(revision: Revision): number;
+    /** Comment on the range between two points as the editor's author; false when refused. */
+    comment(from: DocPoint, to: DocPoint, text: string): boolean;
+}
+export interface StructuralInsert<T> {
+    /** What the comment says when the insert could not be tracked: "Inserted Quick Part: Execution". */
+    label: string;
+    /** The author tracked changes are attributed to. */
+    author: string;
+    /** Do the insert, marking it with `revision` when one is given. */
+    insert: (revision: Revision | null) => T;
+    /** Whether `insert`'s result means something was inserted (default: truthy). */
+    inserted?: (result: T) => boolean;
+}
+export interface StructuralOutcome<T> {
+    result: T;
+    /** `direct`: not suggesting; `tracked`: a suggestion; `noted`: inserted with a comment on it. */
+    how: 'direct' | 'tracked' | 'noted';
+}
+/** `w:date` as Word writes it: UTC, to the second. */
+export declare const revisionDate: (at?: Date) => string;
+/** Insert a structural fragment so that, while suggesting, it is reviewable. Throws when read only. */
+export declare function trackedOrNoted<T>(port: StructuralPort, { label, author, insert, inserted }: StructuralInsert<T>): StructuralOutcome<T>;
+/** The port over a live editor. */
+export declare function structuralPort(editor: DocxEditorInstance): StructuralPort;

package/dist/docx/structural/useTrackedOrNoted.d.ts

@@ -0,0 +1,5 @@
+import { type StructuralInsert, type StructuralOutcome } from './trackedOrNoted';
+/** The name the editor attributes changes to (`DocxEditor.Root`'s `author`), for the ribbon's inserts. */
+export declare const DocxAuthorContext: import("react").Context<string>;
+/** `trackedOrNoted` bound to the editor in context and its author; undefined before it is ready. */
+export declare function useTrackedOrNoted(): <T>(spec: Omit<StructuralInsert<T>, "author">) => StructuralOutcome<T> | undefined;

package/dist/facts/index.cjs

@@ -8,8 +8,8 @@ var chunkRC25WMVB_cjs = require('../chunk-RC25WMVB.cjs');
 var chunk7RGLTF76_cjs = require('../chunk-7RGLTF76.cjs');
 var chunkV4ISCZJ7_cjs = require('../chunk-V4ISCZJ7.cjs');
 var chunk2EI7NCUA_cjs = require('../chunk-2EI7NCUA.cjs');
-var chunkPPCATBOY_cjs = require('../chunk-PPCATBOY.cjs');
 require('../chunk-C54XEN5T.cjs');
+var chunkPPCATBOY_cjs = require('../chunk-PPCATBOY.cjs');
 var chunkKDG6FER6_cjs = require('../chunk-KDG6FER6.cjs');
 var chunkIXALYQT7_cjs = require('../chunk-IXALYQT7.cjs');
 require('../chunk-FX3K6LNZ.cjs');

package/dist/facts/index.js

@@ -8,8 +8,8 @@ import { TabHeader } from '../chunk-4WWM3GQ5.js';
 import { SelectionBar, SelectionBarAction } from '../chunk-NUNKSZKU.js';
 import { FilterInput } from '../chunk-YU2KUMGE.js';
 export { DEFAULT_FILTER_INPUT_LABELS as DEFAULT_FACTS_FILTER_INPUT_LABELS, DEFAULT_FILTER_FIELDS as FACTS_SEARCH_FIELD_OPTIONS, FilterInput as FactsFilterInput } from '../chunk-YU2KUMGE.js';
-import { observeResize } from '../chunk-NPLYHR2E.js';
 import '../chunk-76JDDMSP.js';
+import { observeResize } from '../chunk-NPLYHR2E.js';
 import { initials } from '../chunk-OXF2IFXG.js';
 import { GridView } from '../chunk-ZPLG7QYF.js';
 import '../chunk-SLSBJRWW.js';

package/dist/files/index.cjs

@@ -12,8 +12,8 @@ var chunk32HW2Q33_cjs = require('../chunk-32HW2Q33.cjs');
 var chunkV4ISCZJ7_cjs = require('../chunk-V4ISCZJ7.cjs');
 var chunk2EI7NCUA_cjs = require('../chunk-2EI7NCUA.cjs');
 var chunkOB5F4577_cjs = require('../chunk-OB5F4577.cjs');
-require('../chunk-PPCATBOY.cjs');
 require('../chunk-C54XEN5T.cjs');
+require('../chunk-PPCATBOY.cjs');
 var chunkKDG6FER6_cjs = require('../chunk-KDG6FER6.cjs');
 var chunkVLCY46K6_cjs = require('../chunk-VLCY46K6.cjs');
 var chunkULWRNGGE_cjs = require('../chunk-ULWRNGGE.cjs');

package/dist/files/index.js

@@ -12,8 +12,8 @@ import { SelectionBar, SelectionBarAction } from '../chunk-NUNKSZKU.js';
 export { DEFAULT_SELECTION_BAR_LABELS, SelectionBar, SelectionBarAction } from '../chunk-NUNKSZKU.js';
 import { FilterInput } from '../chunk-YU2KUMGE.js';
 import { ActionLink } from '../chunk-S7PSMMRG.js';
-import '../chunk-NPLYHR2E.js';
 import '../chunk-76JDDMSP.js';
+import '../chunk-NPLYHR2E.js';
 import { formatCount } from '../chunk-OXF2IFXG.js';
 import { ShareControl } from '../chunk-K4BGOPGG.js';
 import { ModalSection, ModalSectionTitle, ModalHeader } from '../chunk-TX2ZICS7.js';

package/dist/home/index.cjs

@@ -6,8 +6,8 @@ var chunkPCB2BPN3_cjs = require('../chunk-PCB2BPN3.cjs');
 var chunkZ5VUZ6YD_cjs = require('../chunk-Z5VUZ6YD.cjs');
 var chunk7D737FLE_cjs = require('../chunk-7D737FLE.cjs');
 var chunkOB5F4577_cjs = require('../chunk-OB5F4577.cjs');
-require('../chunk-PPCATBOY.cjs');
 require('../chunk-C54XEN5T.cjs');
+require('../chunk-PPCATBOY.cjs');
 require('../chunk-KDG6FER6.cjs');
 var chunkMHVNT4J3_cjs = require('../chunk-MHVNT4J3.cjs');
 require('../chunk-DES3K4SD.cjs');

package/dist/home/index.js

@@ -5,8 +5,8 @@ import { SectionHeader, EmptyStrip, QuickActionDialogHeader } from '../chunk-DDF
 export { AddFilesFirst, DEFAULT_ADD_FILES_FIRST_LABELS, DEFAULT_SCOPE_PICKER_LABELS, EmptyStrip, QuickActionDialogHeader, ScopePicker, SectionHeader, SectionLabel, StartTiles, useScopeSelection } from '../chunk-DDF5GPIJ.js';
 export { FoldSection } from '../chunk-XD2M6LIG.js';
 import { ActionLink } from '../chunk-S7PSMMRG.js';
-import '../chunk-NPLYHR2E.js';
 import '../chunk-76JDDMSP.js';
+import '../chunk-NPLYHR2E.js';
 import '../chunk-OXF2IFXG.js';
 import { testIdOr, prefixedTestId } from '../chunk-7F6CBP3Z.js';
 import '../chunk-VUNV25KB.js';