@a3s-lab/office 0.46.0 → 0.47.0

package/dist/internal/features/work/work-document-field-node.d.ts

@@ -1,10 +1,10 @@
 import { Node } from '@tiptap/core';
-import { type WorkDocumentFieldKind, type WorkDocumentFieldRefreshOptions } from './work-document-fields';
+import { type WorkDocumentFieldInsertOptions, type WorkDocumentFieldKind, type WorkDocumentFieldRefreshOptions } from './work-document-fields';
 import type { WorkDocumentContent } from './work-types';
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         documentField: {
-            insertDocumentField: (kind: WorkDocumentFieldKind) => ReturnType;
+            insertDocumentField: (kind: WorkDocumentFieldKind, options?: WorkDocumentFieldInsertOptions) => ReturnType;
             refreshDocumentFields: (content: WorkDocumentContent, options?: WorkDocumentFieldRefreshOptions) => ReturnType;
         };
     }

package/dist/internal/features/work/work-document-fields.d.ts

@@ -1,9 +1,17 @@
-export type WorkDocumentFieldKind = 'page' | 'numPages' | 'section' | 'sectionPages' | 'date' | 'time';
+export type WorkDocumentFieldKind = 'page' | 'numPages' | 'section' | 'sectionPages' | 'date' | 'time' | 'wordCount' | 'characterCount' | 'pageReference';
 export interface WorkDocumentFieldContext {
     pageNumber: number;
     totalPages: number;
     sectionNumber: number;
     sectionPages: number;
+    /** Number of visible body words, excluding generated field results. */
+    wordCount?: number;
+    /** Number of visible body characters, including spaces. */
+    characterCount?: number;
+    /** Page number resolved for a PAGEREF target, when the target is present. */
+    referencePageNumber?: number | null;
+    /** Page numbers keyed by `id:<bookmark-id>` or `name:<bookmark-name>`. */
+    bookmarkPageNumbers?: ReadonlyMap<string, number>;
     now?: Date;
 }
 export type WorkDocumentFieldContextResolver = (position: number) => WorkDocumentFieldContext | null;
@@ -13,10 +21,36 @@ export interface WorkDocumentFieldRefreshOptions {
     addToHistory?: boolean;
     updateClock?: boolean;
 }
+export interface WorkDocumentFieldInsertOptions {
+    /** Bookmark identity used to keep a page reference stable across renames. */
+    targetId?: string;
+    /** Bookmark name emitted in the native PAGEREF instruction. */
+    targetName?: string;
+}
 export declare function documentFieldKind(value: string | undefined): WorkDocumentFieldKind | null;
 export declare function docxDocumentFieldKind(instruction: string): WorkDocumentFieldKind | null;
-export declare function documentFieldInstruction(kind: WorkDocumentFieldKind): string;
+export declare function documentFieldInstruction(kind: WorkDocumentFieldKind, options?: WorkDocumentFieldInsertOptions): string;
+/** Builds a stable PAGEREF instruction while retaining the supported switches. */
+export declare function documentPageReferenceInstruction(targetName: unknown, source?: string, defaultHyperlink?: boolean): string;
 export declare function documentFieldLabel(kind: WorkDocumentFieldKind): string;
 export declare function documentFieldDisplay(kind: WorkDocumentFieldKind, context: WorkDocumentFieldContext, instruction?: string, cachedValue?: string): string;
 export declare function normalizeDocumentFieldsHtml(source: string): string;
 export declare function resolveDocumentFieldsHtml(source: string, context: WorkDocumentFieldContext): string;
+/** Returns the bookmark name used by a bounded PAGEREF instruction. */
+export declare function docxDocumentFieldTarget(instruction: string): string | null;
+/**
+ * The editor intentionally accepts only switches whose result can be
+ * represented by one deterministic inline atom.  Unknown switches remain
+ * cached text instead of being presented as an editable field with altered
+ * semantics.
+ */
+export declare function supportedDocxDocumentFieldInstruction(instruction: string): boolean;
+export declare function documentFieldStatisticsFromText(source: string): {
+    wordCount: number;
+    characterCount: number;
+};
+/** Computes bounded body statistics while excluding generated field results. */
+export declare function documentFieldStatisticsFromHtml(source: string): {
+    wordCount: number;
+    characterCount: number;
+};

package/dist/internal/features/work/work-docx-bookmark-import.d.ts

@@ -2,7 +2,7 @@ export interface ImportedDocxBookmarkMarkers {
     bookmarks: ImportedDocxBookmarkMarker[];
     references: ImportedDocxBookmarkReferenceMarker[];
 }
-interface ImportedDocxBookmarkMarker {
+export interface ImportedDocxBookmarkMarker {
     start: string;
     end: string;
     id: string;

package/dist/internal/features/work/work-docx-field-import.d.ts

@@ -1,4 +1,5 @@
 import { type WorkDocumentFieldKind } from './work-document-fields';
+import type { ImportedDocxBookmarkMarker } from './work-docx-bookmark-import';
 export interface ImportedDocxFieldMarkers {
     fields: ImportedDocxFieldMarker[];
 }
@@ -9,8 +10,11 @@ interface ImportedDocxFieldMarker {
     kind: WorkDocumentFieldKind;
     instruction: string;
     display: string;
+    targetId?: string;
+    targetName?: string;
+    orphaned?: boolean;
 }
-export declare function markDocxBodyFields(document: Document): ImportedDocxFieldMarkers;
+export declare function markDocxBodyFields(document: Document, bookmarks?: readonly ImportedDocxBookmarkMarker[]): ImportedDocxFieldMarkers;
 export declare function applyImportedDocxFieldMarkers(document: Document, markers: ImportedDocxFieldMarkers): void;
 export declare function hasImportedDocxFieldMarkers(markers: ImportedDocxFieldMarkers): boolean;
 export {};

package/dist/internal/features/work/work-docx-import.d.ts

@@ -6,7 +6,6 @@ import { type ImportedDocxCommentMarkers } from './work-docx-comment-import';
 import { type ImportedDocxEquationMarkers } from './work-docx-equation-import';
 import { type ImportedDocxFieldMarkers } from './work-docx-field-import';
 import { type ImportedDocxImageLayoutMarkers } from './work-docx-image-layout-import';
-import { type ImportedDocxTextBoxMarkers } from './work-docx-text-box-import';
 import { type ImportedDocxIndexMarkers } from './work-docx-index-import';
 import { type ImportedDocxListMarkers } from './work-docx-list-import';
 import { type ImportedDocxNumberingChangeMarkers } from './work-docx-numbering-change-import';
@@ -25,6 +24,7 @@ import { type ImportedDocxTableCellMarkers } from './work-docx-table-cell-import
 import { type ImportedDocxTableOfContentsMarkers } from './work-docx-table-of-contents-import';
 import { type ImportedDocxTableRowMarkers } from './work-docx-table-row-import';
 import { type ImportedDocxTableSizingMarkers } from './work-docx-table-sizing-import';
+import { type ImportedDocxTextBoxMarkers } from './work-docx-text-box-import';
 import { OoxmlPackage } from './work-ooxml-package';
 import type { WorkDocumentContent, WorkDocumentSectionLayout } from './work-types';
 type ImportedDocumentLayout = Omit<WorkDocumentContent, 'type' | 'html'>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@a3s-lab/office",
-  "version": "0.46.0",
+  "version": "0.47.0",
   "description": "Open-source collaborative browser editors for documents, Markdown, spreadsheets, presentations, and PDFs.",
   "keywords": [
     "office",