@a3s-lab/office 0.29.0 → 0.31.0

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

@@ -5,6 +5,8 @@ import { type ImportedDocxCitationMarkers } from './work-docx-citation-import';
 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 ImportedDocxIndexMarkers } from './work-docx-index-import';
+import { type ImportedDocxTableOfContentsMarkers } from './work-docx-table-of-contents-import';
 import { type ImportedDocxImageLayoutMarkers } from './work-docx-image-layout-import';
 import { type ImportedDocxListMarkers } from './work-docx-list-import';
 import { type ImportedDocxParagraphAlignmentMarkers } from './work-docx-paragraph-alignment-import';
@@ -36,6 +38,8 @@ export interface PreparedDocxImport {
     changeMarkers: ImportedDocxChangeMarkers;
     commentMarkers: ImportedDocxCommentMarkers;
     fieldMarkers: ImportedDocxFieldMarkers;
+    tableOfContentsMarkers: ImportedDocxTableOfContentsMarkers;
+    indexMarkers: ImportedDocxIndexMarkers;
     equationMarkers: ImportedDocxEquationMarkers;
     citationMarkers: ImportedDocxCitationMarkers;
     listMarkers: ImportedDocxListMarkers;
@@ -58,6 +62,6 @@ export interface PreparedDocxImport {
     trackChanges: boolean;
 }
 export declare function prepareDocxImport(buffer: ArrayBuffer, sourcePackage?: OoxmlPackage): Promise<PreparedDocxImport>;
-export declare function applyDocxSectionsToHtml(html: string, sections: PreparedDocxImport['sections'], captionMarkers?: ImportedDocxCaptionMarkers, bookmarkMarkers?: ImportedDocxBookmarkMarkers, changeMarkers?: ImportedDocxChangeMarkers, commentMarkers?: ImportedDocxCommentMarkers, fieldMarkers?: ImportedDocxFieldMarkers, equationMarkers?: ImportedDocxEquationMarkers, citationMarkers?: ImportedDocxCitationMarkers, listMarkers?: ImportedDocxListMarkers, imageLayoutMarkers?: ImportedDocxImageLayoutMarkers, paragraphIdentityMarkers?: ImportedDocxParagraphIdentityMarkers, paragraphFormattingChangeMarkers?: ImportedDocxParagraphFormattingChangeMarkers, paragraphAlignmentMarkers?: ImportedDocxParagraphAlignmentMarkers, runFormattingMarkers?: ImportedDocxRunFormattingMarkers, paragraphDirectionMarkers?: ImportedDocxParagraphDirectionMarkers, paragraphIndentMarkers?: ImportedDocxParagraphIndentMarkers, paragraphSpacingMarkers?: ImportedDocxParagraphSpacingMarkers, paragraphBorderMarkers?: ImportedDocxParagraphBorderMarkers, paragraphShadingMarkers?: ImportedDocxParagraphShadingMarkers, paragraphPaginationMarkers?: ImportedDocxParagraphPaginationMarkers, bibliography?: WorkDocumentContent['bibliography'], tabStopMarkers?: ImportedDocxParagraphTabStopMarkers, tableCellMarkers?: ImportedDocxTableCellMarkers, tableRowMarkers?: ImportedDocxTableRowMarkers, tableSizingMarkers?: ImportedDocxTableSizingMarkers): string;
+export declare function applyDocxSectionsToHtml(html: string, sections: PreparedDocxImport['sections'], captionMarkers?: ImportedDocxCaptionMarkers, bookmarkMarkers?: ImportedDocxBookmarkMarkers, changeMarkers?: ImportedDocxChangeMarkers, commentMarkers?: ImportedDocxCommentMarkers, fieldMarkers?: ImportedDocxFieldMarkers, tableOfContentsMarkers?: ImportedDocxTableOfContentsMarkers, indexMarkers?: ImportedDocxIndexMarkers, equationMarkers?: ImportedDocxEquationMarkers, citationMarkers?: ImportedDocxCitationMarkers, listMarkers?: ImportedDocxListMarkers, imageLayoutMarkers?: ImportedDocxImageLayoutMarkers, paragraphIdentityMarkers?: ImportedDocxParagraphIdentityMarkers, paragraphFormattingChangeMarkers?: ImportedDocxParagraphFormattingChangeMarkers, paragraphAlignmentMarkers?: ImportedDocxParagraphAlignmentMarkers, runFormattingMarkers?: ImportedDocxRunFormattingMarkers, paragraphDirectionMarkers?: ImportedDocxParagraphDirectionMarkers, paragraphIndentMarkers?: ImportedDocxParagraphIndentMarkers, paragraphSpacingMarkers?: ImportedDocxParagraphSpacingMarkers, paragraphBorderMarkers?: ImportedDocxParagraphBorderMarkers, paragraphShadingMarkers?: ImportedDocxParagraphShadingMarkers, paragraphPaginationMarkers?: ImportedDocxParagraphPaginationMarkers, bibliography?: WorkDocumentContent['bibliography'], tabStopMarkers?: ImportedDocxParagraphTabStopMarkers, tableCellMarkers?: ImportedDocxTableCellMarkers, tableRowMarkers?: ImportedDocxTableRowMarkers, tableSizingMarkers?: ImportedDocxTableSizingMarkers): string;
 export declare function readDocxLayout(buffer: ArrayBuffer): Promise<ImportedDocumentLayout>;
 export {};

package/dist/internal/features/work/work-docx-index-export.d.ts

@@ -0,0 +1,14 @@
+import type { FileChild, ParagraphChild } from 'docx';
+import { type WorkDocumentIndexGeneratedEntry, type WorkDocumentIndexOptions } from './work-document-index';
+export interface DocxIndexPatch {
+    marker: string;
+    options: WorkDocumentIndexOptions;
+    entries: WorkDocumentIndexGeneratedEntry[];
+}
+export declare class DocxIndexPatchCollector {
+    readonly patches: DocxIndexPatch[];
+    add(element: HTMLElement): DocxIndexPatch;
+}
+export declare function docxDocumentIndex(element: HTMLElement, docx: typeof import('docx'), collector: DocxIndexPatchCollector): FileChild[];
+export declare function docxIndexEntryRun(element: HTMLElement, docx: typeof import('docx')): ParagraphChild | null;
+export declare function patchDocxIndexes(buffer: ArrayBuffer, patches: readonly DocxIndexPatch[]): Promise<ArrayBuffer>;

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

@@ -0,0 +1,23 @@
+import { type WorkDocumentIndexEntryDraft, type WorkDocumentIndexGeneratedEntry, type WorkDocumentIndexOptions } from './work-document-index';
+import { type DocxFieldOccurrence } from './work-docx-field-instructions';
+export interface ImportedDocxIndexMarkers {
+    entries: ImportedDocxIndexEntryMarker[];
+    indexes: ImportedDocxIndexMarker[];
+}
+export interface ImportedDocxIndexEntryMarker {
+    start: string;
+    end: string;
+    id: string;
+    value: WorkDocumentIndexEntryDraft;
+}
+export interface ImportedDocxIndexMarker {
+    marker: string;
+    id: string;
+    options: WorkDocumentIndexOptions;
+    entries: WorkDocumentIndexGeneratedEntry[];
+}
+export declare function markDocxIndexes(document: Document): ImportedDocxIndexMarkers;
+export declare function applyImportedDocxIndexMarkers(document: Document, markers: ImportedDocxIndexMarkers): void;
+export declare function hasImportedDocxIndexMarkers(markers: ImportedDocxIndexMarkers): boolean;
+export declare function supportedDocxIndexEntryField(field: DocxFieldOccurrence): boolean;
+export declare function supportedDocxIndexField(field: DocxFieldOccurrence): boolean;

package/dist/internal/features/work/work-docx-proofing-diagnostics.d.ts

@@ -0,0 +1,3 @@
+import { type OoxmlPackage } from './work-ooxml-package';
+import type { WorkCompatibilityIssue } from './work-types';
+export declare function diagnoseDocxProofing(archive: OoxmlPackage, document: Document): Promise<WorkCompatibilityIssue[]>;

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

@@ -0,0 +1,38 @@
+import { type WorkDocumentProofingLanguages } from './work-document-proofing';
+export interface DocxProofingLanguageOptions {
+    value?: string;
+    eastAsia?: string;
+    bidirectional?: string;
+}
+export type DocxProofingLanguagesInspection = {
+    status: 'absent';
+    spoofedCount: number;
+} | {
+    status: 'invalid';
+    spoofedCount: number;
+} | {
+    status: 'valid';
+    value: WorkDocumentProofingLanguages;
+    spoofedCount: number;
+};
+export type DocxNoProofInspection = {
+    status: 'absent';
+    spoofedCount: number;
+} | {
+    status: 'invalid';
+    spoofedCount: number;
+} | {
+    status: 'valid';
+    value: boolean;
+    spoofedCount: number;
+};
+export interface ResolvedDocxProofing {
+    languages: WorkDocumentProofingLanguages | undefined;
+    noProof: boolean | undefined;
+    invalidCount: number;
+    spoofedCount: number;
+}
+export declare function inspectDocxProofingLanguages(properties: Element | null | undefined): DocxProofingLanguagesInspection;
+export declare function inspectDocxNoProof(properties: Element | null | undefined): DocxNoProofInspection;
+export declare function resolveDocxProofing(propertySources: readonly Element[]): ResolvedDocxProofing;
+export declare function documentProofingLanguageDocxOptions(source: unknown): DocxProofingLanguageOptions | undefined;

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

@@ -8,6 +8,9 @@ import { type WorkDocumentUnderlineFormatting } from './work-document-underline'
 import { type WorkDocumentStrikeFormatting } from './work-document-strike';
 import { type WorkDocumentScriptFontSlot, type WorkDocumentScriptFonts } from './work-document-script-fonts';
 import { type DocumentRunBorder } from './work-document-run-border';
+import { type DocumentRunShading } from './work-document-run-shading';
+import { type WorkDocumentHighlight } from './work-document-highlight';
+import { type WorkDocumentProofingLanguages } from './work-document-proofing';
 export interface ImportedDocxRunFormatting {
     bold?: boolean;
     italic?: boolean;
@@ -33,10 +36,14 @@ export interface ImportedDocxRunFormatting {
     fontSize?: number;
     color?: string;
     backgroundColor?: string;
+    highlight?: WorkDocumentHighlight;
     themeColor?: DocxThemeColorReference;
     themeFill?: DocxThemeColorReference;
     textCase?: WorkDocumentTextCase;
     runBorder?: DocumentRunBorder;
+    runShading?: DocumentRunShading;
+    proofingLanguages?: WorkDocumentProofingLanguages;
+    noProof?: boolean;
 }
 export interface ImportedDocxRunFormattingMarker {
     startMarker: string;

package/dist/internal/features/work/work-docx-run-shading-diagnostics.d.ts

@@ -0,0 +1,3 @@
+import { type OoxmlPackage } from './work-ooxml-package';
+import type { WorkCompatibilityIssue } from './work-types';
+export declare function diagnoseDocxRunShading(archive: OoxmlPackage, document: Document): Promise<WorkCompatibilityIssue[]>;

package/dist/internal/features/work/work-docx-run-shading-export.d.ts

@@ -0,0 +1,17 @@
+import type { IRunOptions } from 'docx';
+import { type DocumentRunShading } from './work-document-run-shading';
+export interface DocxRunShadingPatch {
+    marker: string;
+    shading: DocumentRunShading;
+}
+export declare class DocxRunShadingPatchCollector {
+    readonly patches: DocxRunShadingPatch[];
+    private nextMarker;
+    private readonly usedColors;
+    constructor(sourceHtml: string);
+    marker(source: unknown): string | null;
+    hasMarker(value: string | null | undefined): value is string;
+}
+export declare function documentRunShadingDocxOptions(source: unknown, collector: DocxRunShadingPatchCollector): Pick<IRunOptions, 'shading'>;
+export declare function patchDocxRunShading(buffer: ArrayBuffer, patches: readonly DocxRunShadingPatch[]): Promise<ArrayBuffer>;
+export declare function setDocxRunShadingAttributes(document: Document, element: Element, source: unknown): boolean;

package/dist/internal/features/work/work-docx-run-shading.d.ts

@@ -0,0 +1,20 @@
+import type { DocumentRunShading } from './work-document-run-shading';
+import { type DocxThemeSource } from './work-docx-theme';
+export type DocxRunShadingInspection = {
+    status: 'absent';
+    spoofedCount: number;
+} | {
+    status: 'invalid';
+    spoofedCount: number;
+} | {
+    status: 'valid';
+    value: DocumentRunShading;
+    spoofedCount: number;
+};
+export interface ResolvedDocxRunShading {
+    shading: DocumentRunShading | undefined;
+    invalidCount: number;
+    spoofedCount: number;
+}
+export declare function inspectDocxRunShading(properties: Element | null | undefined, themeSource?: DocxThemeSource): DocxRunShadingInspection;
+export declare function resolveDocxRunShading(propertySources: readonly Element[], themeSource?: DocxThemeSource): ResolvedDocxRunShading;

package/dist/internal/features/work/work-docx-table-of-contents-export.d.ts

@@ -0,0 +1,11 @@
+import { type WorkDocumentTableOfContentsEntry, type WorkDocumentTableOfContentsOptions } from './work-document-table-of-contents';
+export interface DocxTableOfContentsPatch {
+    options: WorkDocumentTableOfContentsOptions;
+    entries: WorkDocumentTableOfContentsEntry[];
+}
+export declare class DocxTableOfContentsPatchCollector {
+    readonly patches: DocxTableOfContentsPatch[];
+    add(element: HTMLElement): DocxTableOfContentsPatch;
+}
+export declare function docxTableOfContents(element: HTMLElement, docx: typeof import('docx'), collector: DocxTableOfContentsPatchCollector): InstanceType<typeof docx.TableOfContents>;
+export declare function patchDocxTableOfContents(buffer: ArrayBuffer, patches: readonly DocxTableOfContentsPatch[]): Promise<ArrayBuffer>;

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

@@ -0,0 +1,15 @@
+import { type WorkDocumentTableOfContentsEntry, type WorkDocumentTableOfContentsOptions } from './work-document-table-of-contents';
+import { type DocxFieldOccurrence } from './work-docx-field-instructions';
+export interface ImportedDocxTableOfContentsMarkers {
+    tables: ImportedDocxTableOfContentsMarker[];
+}
+export interface ImportedDocxTableOfContentsMarker {
+    marker: string;
+    id: string;
+    options: WorkDocumentTableOfContentsOptions;
+    entries: WorkDocumentTableOfContentsEntry[];
+}
+export declare function markDocxTablesOfContents(document: Document): ImportedDocxTableOfContentsMarkers;
+export declare function applyImportedDocxTableOfContentsMarkers(document: Document, markers: ImportedDocxTableOfContentsMarkers): void;
+export declare function hasImportedDocxTableOfContentsMarkers(markers: ImportedDocxTableOfContentsMarkers): boolean;
+export declare function supportedDocxTableOfContentsField(field: DocxFieldOccurrence): boolean;

package/dist/internal/features/work/work-spreadsheet-data-validation.d.ts

@@ -1,2 +1,9 @@
+import type { WorkSpreadsheetDataValidationErrorStyle } from './work-types';
+export declare const SPREADSHEET_DATA_VALIDATION_TITLE_LIMIT = 32;
+export declare const SPREADSHEET_DATA_VALIDATION_HINT_LIMIT = 255;
+export declare const SPREADSHEET_DATA_VALIDATION_ERROR_LIMIT = 225;
+export declare const SPREADSHEET_DATA_VALIDATION_ERROR_STYLES: readonly ["stop", "warning", "information"];
+export declare function normalizeSpreadsheetDataValidationErrorStyle(value: unknown): WorkSpreadsheetDataValidationErrorStyle;
+export declare function boundedSpreadsheetDataValidationText(value: unknown, limit: number): string;
 export declare function normalizeSpreadsheetDateValidationBoundary(value: string, uses1904DateSystem?: boolean): string | null;
 export declare function spreadsheetDateValidationFormula(value: string): string;

package/dist/internal/features/work/work-types.d.ts

@@ -196,6 +196,7 @@ export interface WorkSpreadsheetCellRange {
     row: [number, number];
     column: [number, number];
 }
+export type WorkSpreadsheetDataValidationErrorStyle = 'information' | 'stop' | 'warning';
 export interface WorkSpreadsheetDataValidationItem {
     type: string;
     type2: string;
@@ -204,8 +205,16 @@ export interface WorkSpreadsheetDataValidationItem {
     value2: string;
     validity: string;
     remote: boolean;
+    /** Defaults to true for legacy A3S artifacts. */
+    allowBlank?: boolean;
+    /** Product semantic; OOXML stores the inverse in `showDropDown`. */
+    showDropdownArrow?: boolean;
     prohibitInput: boolean;
+    errorStyle?: WorkSpreadsheetDataValidationErrorStyle;
+    errorTitle?: string;
+    errorMessage?: string;
     hintShow: boolean;
+    hintTitle?: string;
     hintValue: string;
     checked?: boolean;
 }

package/dist/internal/kernel/office-kernel-protocol.d.ts

@@ -140,6 +140,7 @@ export interface OfficeKernelTextLayoutRun {
     fallbackFontIds?: string[];
     fontSize: number;
     lineHeight: number;
+    language?: string;
     letterSpacing?: number;
     ligatures?: boolean;
     kerning?: boolean;