@stll/folio-core 0.37.1 → 0.37.3

package/dist/docx/paragraphPropertySource.d.ts

@@ -1,14 +1,45 @@
 import { document_d_exports } from "../types/document.js";
 import { Transaction } from "prosemirror-state";
-import { Fragment, Mark, Node } from "prosemirror-model";
+import { Fragment, Mark, Node, NodeType } from "prosemirror-model";
 //#region src/docx/paragraphPropertySource.d.ts
 type ParagraphPropertySource = {
   xml: string;
   formattingJson: string;
 };
+declare const PROSE_PARAGRAPH_SOURCE_TOKEN_ATTR = "_docxParagraphSourceToken";
+declare const PROSE_PARAGRAPH_SOURCE_CONTRACT_ATTR = "_docxParagraphSourceContract";
+/** Durable identity nested inside opaque collapsed-cell ProseMirror attrs; stripped on restore. */
+declare const TABLE_CELL_PARAGRAPH_SOURCE_BINDING_ATTR = "_docxParagraphSourceBinding";
+declare const PARAGRAPH_PROPERTY_SOURCE_VALIDATION_CODES: readonly ["contract_mismatch", "duplicate_token", "invalid_token", "unknown_token"];
+type ParagraphPropertySourceValidationCode = (typeof PARAGRAPH_PROPERTY_SOURCE_VALIDATION_CODES)[number];
+declare const TABLE_CELL_PARAGRAPH_SOURCE_PAYLOAD_ERROR_CLASSIFICATIONS: readonly ["complexity_limit", "cyclic_or_aliased_graph", "depth_limit", "expected_array", "expected_block", "expected_cell", "expected_inline_content", "expected_paragraph", "expected_record", "expected_row", "invalid_binding", "invalid_block_type", "invalid_cell_type", "invalid_graph_value", "invalid_inline_content_type", "invalid_paragraph_type", "invalid_row_type", "malformed_source_token"];
+type TableCellParagraphSourcePayloadErrorClassification = (typeof TABLE_CELL_PARAGRAPH_SOURCE_PAYLOAD_ERROR_CLASSIFICATIONS)[number];
+declare const ParagraphPropertySourceValidationError_base: import("better-result").TaggedErrorClass<"ParagraphPropertySourceValidationError">;
+declare class ParagraphPropertySourceValidationError extends ParagraphPropertySourceValidationError_base<{
+  code: ParagraphPropertySourceValidationCode;
+  classification?: TableCellParagraphSourcePayloadErrorClassification;
+  message: string;
+  path?: string;
+}> {}
+declare const isParagraphPropertySourceToken: (token: unknown) => token is string;
+/** True only for a body-story token derived from the exact source contract. */
+declare const paragraphPropertySourceTokenMatchesContract: (token: unknown, contract: string) => token is string;
+/** Visit the v1 provenance scope in canonical OOXML body-story order. */
+declare const visitDocumentStoryParagraphs: (content: document_d_exports.Document["package"]["document"]["content"], visit: (paragraph: document_d_exports.Paragraph) => void) => void;
 declare const assignParagraphPropertySource: (paragraph: document_d_exports.Paragraph, source: ParagraphPropertySource) => void;
 declare const getParagraphPropertySource: (paragraph: document_d_exports.Paragraph) => ParagraphPropertySource | undefined;
+/** Copy the captured `w:pPr` without claiming the source paragraph's durable identity. */
+declare const copyParagraphPropertyCapture: (target: document_d_exports.Paragraph, source: document_d_exports.Paragraph) => void;
 declare const copyParagraphPropertySource: (target: document_d_exports.Paragraph, source: document_d_exports.Paragraph) => void;
+/** Bind parsed body paragraphs to one exact source package. */
+declare const assignDocumentParagraphPropertySourceContract: (document: document_d_exports.Document, sourceDigest: string) => void;
+declare const getDocumentParagraphPropertySourceContract: (document: document_d_exports.Document) => string | undefined;
+declare const copyDocumentParagraphPropertySources: (document: document_d_exports.Document) => Map<string, document_d_exports.Paragraph> | undefined;
+declare const paragraphPropertySourceBelongsToDocument: (paragraph: document_d_exports.Paragraph, document: document_d_exports.Document) => boolean;
+declare const getProseDocumentParagraphPropertySourceContract: (document: Node) => string | null;
+declare const getProseParagraphPropertySourceToken: (paragraph: Node) => unknown;
+declare const copyDocumentParagraphPropertySourceContract: (target: document_d_exports.Document, source: document_d_exports.Document) => void;
+declare const getParagraphPropertySourceToken: (paragraph: document_d_exports.Paragraph) => string | undefined;
 type ParagraphCloneOverrides = Omit<Partial<document_d_exports.Paragraph>, "type">;
 /** Clone a paragraph while deliberately retaining its parsed `w:pPr` owner. */
 declare const cloneParagraphWithPropertySource: (paragraph: document_d_exports.Paragraph, overrides: ParagraphCloneOverrides) => document_d_exports.Paragraph;
@@ -20,7 +51,50 @@ declare const cloneParagraphWithoutPropertySource: (paragraph: document_d_export
  * mismatch is an internal invariant failure rather than a position heuristic.
  */
 declare const cloneDocumentWithParagraphPropertySources: (document: document_d_exports.Document) => document_d_exports.Document;
+type TableCellParagraphPropertySourceBinding = Readonly<{
+  type: "authored";
+}> | Readonly<{
+  token: string;
+  type: "source";
+}>;
+declare const decodedTableCellParagraphSourcePayloadBrand: unique symbol;
+type DecodedTableCellParagraphSourcePayload = Readonly<{
+  [decodedTableCellParagraphSourcePayloadBrand]: true;
+  cells: readonly document_d_exports.TableCell[];
+}>;
+/** Decode and freeze the opaque collapsed-cell wire payload before typed use. */
+declare const decodeTableCellParagraphSourcePayload: (value: unknown) => DecodedTableCellParagraphSourcePayload;
+/** Prepare opaque continuation cells for ProseMirror and Yjs transport. */
+declare const transportTableCellsWithParagraphPropertySources: (cells: document_d_exports.TableCell[]) => document_d_exports.TableCell[];
+/** Restore decoded identities privately and remove them from the document model. */
+declare const restoreTableCellsWithParagraphPropertySources: (payload: DecodedTableCellParagraphSourcePayload) => document_d_exports.TableCell[];
+/** Visit every transported hidden paragraph in canonical cell-story order. */
+declare const visitTableCellParagraphPropertySourceBindings: (payload: DecodedTableCellParagraphSourcePayload, visit: (binding: TableCellParagraphPropertySourceBinding, path: string) => void) => void;
+/**
+ * Clone package-crossing vertical-merge payloads with their captured `w:pPr`,
+ * but without the durable paragraph tokens owned by the source package.
+ */
+declare const cloneTableCellsWithParagraphPropertyCaptures: (payload: DecodedTableCellParagraphSourcePayload) => document_d_exports.TableCell[];
 declare const linkProseParagraphPropertySource: (proseParagraph: Node, sourceParagraph: document_d_exports.Paragraph) => void;
+type CreateProseParagraphOptions = {
+  attrs?: Node["attrs"];
+  content?: Fragment | Node | readonly Node[] | null;
+  marks?: readonly Mark[];
+};
+/** Create a parsed paragraph with both its same-process owner and durable body token. */
+declare const createProseParagraphWithPropertySource: (nodeType: NodeType | undefined, sourceParagraph: document_d_exports.Paragraph, options?: CreateProseParagraphOptions) => Node;
+type ParagraphPropertySourceTransfer = {
+  displacedToken: string | null;
+  selectedToken: string | null;
+};
+type JoinProseParagraphsWithRightPropertySourceOptions = {
+  attrs: Node["attrs"];
+  pos: number;
+  transaction: Transaction;
+};
+/** Join adjacent paragraphs when revision semantics deliberately select the right owner. */
+declare const joinProseParagraphsWithRightPropertySource: ({ attrs, pos, transaction }: JoinProseParagraphsWithRightPropertySourceOptions) => Transaction;
+declare const getExplicitParagraphPropertySourceTransfers: (transaction: Transaction) => readonly ParagraphPropertySourceTransfer[];
 type RecreateProseNodeOptions = {
   attrs?: Node["attrs"];
   content?: Fragment | Node | readonly Node[] | null;
@@ -28,6 +102,12 @@ type RecreateProseNodeOptions = {
 };
 /** Rebuild a PM node and retain paragraph provenance when the node is one. */
 declare const recreateProseNodeWithParagraphPropertySource: (source: Node, options?: RecreateProseNodeOptions) => Node;
+/**
+ * Rebuild a PM node that is crossing from another package: retain its
+ * same-process paragraph-property capture, but detach the durable token that
+ * can only name a paragraph in the package it came from.
+ */
+declare const recreateProseNodeWithDetachedParagraphPropertySource: (source: Node, options?: RecreateProseNodeOptions) => Node;
 type SetProseParagraphMarkupOptions = {
   attrs: Node["attrs"];
   ownership: "preserve" | "transfer-allocated-id";
@@ -46,4 +126,4 @@ declare const linkParagraphPropertySourceCandidate: (target: document_d_exports.
 declare const getParagraphPropertySourceCandidate: (paragraph: document_d_exports.Paragraph) => document_d_exports.Paragraph | undefined;
 declare const getParagraphPropertySourceTransferId: (paragraph: document_d_exports.Paragraph) => string | undefined;
 //#endregion
-export { assignParagraphPropertySource, cloneDocumentWithParagraphPropertySources, cloneParagraphWithPropertySource, cloneParagraphWithoutPropertySource, copyParagraphPropertySource, getParagraphPropertySource, getParagraphPropertySourceCandidate, getParagraphPropertySourceTransferId, linkParagraphPropertySourceCandidate, linkProseParagraphPropertySource, recreateProseNodeWithParagraphPropertySource, setProseParagraphMarkupWithPropertySource, transferProseParagraphPropertySource };
+export { DecodedTableCellParagraphSourcePayload, PARAGRAPH_PROPERTY_SOURCE_VALIDATION_CODES, PROSE_PARAGRAPH_SOURCE_CONTRACT_ATTR, PROSE_PARAGRAPH_SOURCE_TOKEN_ATTR, ParagraphPropertySourceValidationCode, ParagraphPropertySourceValidationError, TABLE_CELL_PARAGRAPH_SOURCE_BINDING_ATTR, TABLE_CELL_PARAGRAPH_SOURCE_PAYLOAD_ERROR_CLASSIFICATIONS, TableCellParagraphPropertySourceBinding, TableCellParagraphSourcePayloadErrorClassification, assignDocumentParagraphPropertySourceContract, assignParagraphPropertySource, cloneDocumentWithParagraphPropertySources, cloneParagraphWithPropertySource, cloneParagraphWithoutPropertySource, cloneTableCellsWithParagraphPropertyCaptures, copyDocumentParagraphPropertySourceContract, copyDocumentParagraphPropertySources, copyParagraphPropertyCapture, copyParagraphPropertySource, createProseParagraphWithPropertySource, decodeTableCellParagraphSourcePayload, getDocumentParagraphPropertySourceContract, getExplicitParagraphPropertySourceTransfers, getParagraphPropertySource, getParagraphPropertySourceCandidate, getParagraphPropertySourceToken, getParagraphPropertySourceTransferId, getProseDocumentParagraphPropertySourceContract, getProseParagraphPropertySourceToken, isParagraphPropertySourceToken, joinProseParagraphsWithRightPropertySource, linkParagraphPropertySourceCandidate, linkProseParagraphPropertySource, paragraphPropertySourceBelongsToDocument, paragraphPropertySourceTokenMatchesContract, recreateProseNodeWithDetachedParagraphPropertySource, recreateProseNodeWithParagraphPropertySource, restoreTableCellsWithParagraphPropertySources, setProseParagraphMarkupWithPropertySource, transferProseParagraphPropertySource, transportTableCellsWithParagraphPropertySources, visitDocumentStoryParagraphs, visitTableCellParagraphPropertySourceBindings };