@arbidocs/blocks 0.4.111 → 0.4.112

package/dist/docx/references/commands.d.ts

@@ -1,91 +1,5 @@
 /**
- * Insert cross-references, the way Word does.
- *
- * Within the document: a hidden `_Ref…` bookmark on the target paragraph and a `REF` field at the
- * caret — `REF _Ref123 \r \h` for a numbered paragraph (Word's Cross-reference › Numbered item ›
- * Paragraph number), `REF _Ref123 \h` for a heading's text. The field's cached result is the value
- * the editor computes, so it updates live when the clauses are renumbered, and Word updates it
- * with the document's other fields.
- *
- * To another document: a hyperlink with the reference text ("SPA, clause 8.2"), aimed at the app
- * address of that document's passage (so it works from Word too), with a screen tip saying so.
+ * Insert cross-references, the way Word does: shared with the collaboration service, see
+ * `@arbidocs/coedit/commands` (`references.ts`).
  */
-import { type DocPoint } from '../definitions/port';
-import { type BrokenReference, type CrossReferenceMode } from '@arbidocs/coedit/commands';
-import type { CrossReferenceTarget } from './numbering';
-import type { ReferencesPort } from './port';
-export { REF_BOOKMARK_PREFIX, brokenCrossReferences, staleCrossReferences, type BrokenReference, type CrossReferenceMode, type StaleReference, } from '@arbidocs/coedit/commands';
-/** A new `_Ref` bookmark name: Word's shape (`_Ref` and nine digits), not yet in the document. */
-export declare function newRefBookmark(taken: ReadonlySet<string>, random?: () => number): string;
-/**
- * A complex `REF` field with its cached result, every run in the Cross Reference style (Word gives
- * an updated result the formatting of the field's first run).
- */
-export declare function refFieldXml(instruction: string, cached: string): string;
-/** The screen tip of a reference to this document: "Cross-reference to clause 2.2". */
-export declare const refTooltip: (value: string, mode: CrossReferenceMode) => string;
-/**
- * A reference to this document: the `REF` field inside a link to the same bookmark, which carries
- * the screen tip Word shows on hover ("Cross-reference to clause 2.2").
- */
-export declare function crossReferenceXml(bookmark: string, mode: CrossReferenceMode, value: string): string;
-/** The field instruction for a target: its paragraph number, or its text. */
-export declare const refInstruction: (bookmark: string, mode: CrossReferenceMode) => string;
-/** What the reference reads in the text. */
-export declare const refResult: (target: CrossReferenceTarget, mode: CrossReferenceMode) => string;
-/**
- * The `_Ref` bookmark a target carries: an existing one at the paragraph, else a new one. For a
- * paragraph number it is an empty bookmark at the paragraph's start (the number is the
- * paragraph's); for heading text it wraps the heading's runs (REF shows the bookmarked text).
- */
-export declare function ensureTargetBookmark(port: ReferencesPort, target: CrossReferenceTarget, mode: CrossReferenceMode): string;
-/**
- * Mark a cross-reference's target (see {@link ensureTargetBookmark}): what the reference will
- * address and read. A paragraph number falls back to the heading text when it has none. Done as a
- * direct edit even while suggesting — the bookmark is hidden, and a heading's text is put back as
- * it was — so rejecting the reference leaves the target as it was.
- */
-export declare function markCrossReferenceTarget(port: ReferencesPort, target: CrossReferenceTarget, mode: CrossReferenceMode): {
-    bookmark: string;
-    mode: CrossReferenceMode;
-    value: string;
-};
-/**
- * Insert the `REF` field of a marked target at `caret`; the caret ends after it. With a port
- * whose pastes are tracked, the reference is one suggestion.
- */
-export declare function insertCrossReferenceField(port: ReferencesPort, { bookmark, mode, value }: {
-    bookmark: string;
-    mode: CrossReferenceMode;
-    value: string;
-}, caret: DocPoint): {
-    bookmark: string;
-};
-/** Insert a cross-reference to a target of this document at `caret`; the caret ends after it. */
-export declare function insertCrossReference(port: ReferencesPort, target: CrossReferenceTarget, mode: CrossReferenceMode, caret: DocPoint): {
-    bookmark: string;
-};
-/** The screen tip of a reference to another document: "Cross-reference: SPA, clause 8.2 — opens in ARBI". */
-export declare const documentReferenceTooltip: (text: string, appName?: string) => string;
-/**
- * Insert a reference to another document's passage: the reference text in the Cross Reference
- * style, linked to the passage's (absolute) app address, at `caret`.
- */
-export declare function insertDocumentReference(port: ReferencesPort, reference: {
-    text: string;
-    url: string;
-    appName?: string;
-}, caret: DocPoint): void;
-export interface RefreshResult {
-    /** References rewritten with their current number or text. */
-    refreshed: number;
-    /** References whose target is gone, now (or already) marked broken. */
-    broken: BrokenReference[];
-}
-/**
- * Bring every cross-reference up to date: a stale one is replaced by the same reference with its
- * current value (and screen tip); one whose target was deleted becomes its last text in the Cross
- * Reference Broken style — never Word's "Error! Reference source not found." A field directly
- * after another field is left alone: a paste there would land inside the previous field.
- */
-export declare function refreshCrossReferences(port: ReferencesPort): RefreshResult;
+export { REF_BOOKMARK_PREFIX, brokenCrossReferences, crossReferenceXml, documentReferenceTooltip, ensureTargetBookmark, insertCrossReference, insertCrossReferenceField, insertDocumentReference, markCrossReferenceTarget, newRefBookmark, refFieldXml, refInstruction, refResult, refTooltip, refreshCrossReferences, staleCrossReferences, type BrokenReference, type CrossReferenceMode, type RefreshResult, type StaleReference, } from '@arbidocs/coedit/commands';

package/dist/docx/references/port.d.ts

@@ -5,16 +5,7 @@
  */
 import type { DocxEditorInstance } from '@docx-editor.dev/core';
 import type { Revision } from '@arbidocs/coedit/template';
-import { type DefinitionsPort, type OoxmlNodeLike } from '../definitions/port';
-import type { LevelOf, ListItemInfo } from './numbering';
-export interface ReferencesPort extends DefinitionsPort {
-    /** Each numbered paragraph's list item, by paragraph id. */
-    listItems(): ReadonlyMap<string, ListItemInfo>;
-    levelOf: LevelOf;
-    /** The paragraph's runs as WordprocessingML, or null when it holds more than plain runs. */
-    runsXml(paragraphId: string): string | null;
-}
-/** A paragraph's runs as XML (formatting kept), or null for anything but plain runs. */
-export declare function paragraphRunsXml(paragraph: OoxmlNodeLike): string | null;
+import { type ReferencesPort } from '@arbidocs/coedit/commands';
+export { paragraphRunsXml, type ReferencesPort } from '@arbidocs/coedit/commands';
 /** The port over a live editor; with a `revision`, what it pastes is a tracked insertion by it. */
 export declare function referencesPort(editor: DocxEditorInstance, revision?: Revision | null): ReferencesPort;

package/dist/facts/index.cjs

@@ -9,8 +9,8 @@ var chunkRC25WMVB_cjs = require('../chunk-RC25WMVB.cjs');
 var chunkV4ISCZJ7_cjs = require('../chunk-V4ISCZJ7.cjs');
 var chunk2EI7NCUA_cjs = require('../chunk-2EI7NCUA.cjs');
 var chunkC2CWWEHO_cjs = require('../chunk-C2CWWEHO.cjs');
-var chunk7RGLTF76_cjs = require('../chunk-7RGLTF76.cjs');
 require('../chunk-FX3K6LNZ.cjs');
+var chunk7RGLTF76_cjs = require('../chunk-7RGLTF76.cjs');
 var chunkPPCATBOY_cjs = require('../chunk-PPCATBOY.cjs');
 var chunkMHVNT4J3_cjs = require('../chunk-MHVNT4J3.cjs');
 require('../chunk-C54XEN5T.cjs');

package/dist/facts/index.js

@@ -9,8 +9,8 @@ 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 { GridView } from '../chunk-N5YEF3LC.js';
-import { TabHeader } from '../chunk-4WWM3GQ5.js';
 import '../chunk-SLSBJRWW.js';
+import { TabHeader } from '../chunk-4WWM3GQ5.js';
 import { observeResize } from '../chunk-NPLYHR2E.js';
 import { testIdOr } from '../chunk-7F6CBP3Z.js';
 import '../chunk-76JDDMSP.js';

package/dist/files/index.cjs

@@ -14,8 +14,8 @@ var chunk32HW2Q33_cjs = require('../chunk-32HW2Q33.cjs');
 var chunkV4ISCZJ7_cjs = require('../chunk-V4ISCZJ7.cjs');
 var chunk2EI7NCUA_cjs = require('../chunk-2EI7NCUA.cjs');
 var chunkC2CWWEHO_cjs = require('../chunk-C2CWWEHO.cjs');
-var chunkULWRNGGE_cjs = require('../chunk-ULWRNGGE.cjs');
 require('../chunk-FX3K6LNZ.cjs');
+var chunkULWRNGGE_cjs = require('../chunk-ULWRNGGE.cjs');
 require('../chunk-PPCATBOY.cjs');
 var chunkMHVNT4J3_cjs = require('../chunk-MHVNT4J3.cjs');
 require('../chunk-C54XEN5T.cjs');

package/dist/files/index.js

@@ -15,8 +15,8 @@ export { DEFAULT_SELECTION_BAR_LABELS, SelectionBar, SelectionBarAction } from '
 import { FilterInput } from '../chunk-YU2KUMGE.js';
 import { GridView } from '../chunk-N5YEF3LC.js';
 export { GridView } from '../chunk-N5YEF3LC.js';
-import { ModalSection, ModalSectionTitle, ModalHeader } from '../chunk-TX2ZICS7.js';
 import '../chunk-SLSBJRWW.js';
+import { ModalSection, ModalSectionTitle, ModalHeader } from '../chunk-TX2ZICS7.js';
 import '../chunk-NPLYHR2E.js';
 import { testIdOr, prefixedTestId } from '../chunk-7F6CBP3Z.js';
 import '../chunk-76JDDMSP.js';