oasis-editor 0.0.153 → 0.0.154

package/dist/core/commands/builtinCommands.d.ts

@@ -1,2 +1,2 @@
-export declare const OASIS_BUILTIN_COMMANDS: readonly ["selectAll", "insertFootnote", "insertText", "insertEquation", "updateEquation", "insertTableOfContents", "updateTableOfContents", "pastePlainText", "bold", "italic", "underline", "strike", "superscript", "subscript", "link", "unlink", "alignLeft", "alignCenter", "alignRight", "alignJustify", "orderedList", "bulletList", "find", "replace", "toggleTrackChanges", "acceptRevisions", "rejectRevisions", "toggleShowMargins", "toggleShowParagraphMarks", "togglePreciseFonts", "undo", "redo", "pageBreak", "lineBreak", "splitBlock", "setFontFamily", "setFontSize", "increaseFontSize", "decreaseFontSize", "changeTextCase", "clearFormatting", "setColor", "setHighlight", "setTextShading", "setStyleId", "setCharacterStyleId", "setUnderlineStyle", "documentStyles", "print", "copy", "newDocument", "exportDocx", "exportPdf", "importDocument", "insertImage", "editImageAlt", "insertImageCaption", "imageContext", "imageWidthCm", "imageHeightCm", "imageCrop", "imageCropAspect", "imageCropShape", "imageCropFill", "imageCropFit", "imageCropReset", "imageBorder", "outdent", "indent", "togglePageBreakBefore", "toggleKeepWithNext", "setSpacingAfter", "setSpacingBefore", "setIndentLeft", "setIndentRight", "setIndentFirstLine", "setIndentHanging", "setSpecialIndent", "setParagraphShading", "applyParagraphBorders", "setLineHeight", "setListFormat", "setListStartAt", "toggleOrientation", "setOrientation", "sectionBreakNextPage", "sectionBreakContinuous", "setPageMargins", "tableContext", "tableMerge", "tableSplit", "tableInsertColumnBefore", "tableInsertColumnAfter", "tableDeleteColumn", "tableInsertRowBefore", "tableInsertRowAfter", "tableDeleteRow", "tableCellShading", "tableCellBorders", "tableCellNoBorders", "tableApplyBorderPreset", "toggleTableDrawBorders", "toggleTableGridlines", "tableWidth100", "tableAlignLeft", "tableAlignCenter", "tableAlignRight", "tableSetCellWidth", "tableToggleHeaderRow", "tableToggleTotalRow", "tableToggleBandedRows", "tableToggleFirstColumn", "tableToggleLastColumn", "tableToggleBandedColumns", "setTableStyle", "tableToggleAutoFit", "tableDistributeColumns", "tableDistributeRows", "insertTable", "insertShape", "openSymbolDialog", "openEquationDialog"];
+export declare const OASIS_BUILTIN_COMMANDS: readonly ["selectAll", "insertFootnote", "insertText", "insertEquation", "updateEquation", "insertTableOfContents", "updateTableOfContents", "pastePlainText", "bold", "italic", "underline", "strike", "superscript", "subscript", "link", "unlink", "alignLeft", "alignCenter", "alignRight", "alignJustify", "orderedList", "bulletList", "find", "replace", "toggleTrackChanges", "acceptRevisions", "rejectRevisions", "toggleShowMargins", "toggleShowParagraphMarks", "togglePreciseFonts", "undo", "redo", "pageBreak", "lineBreak", "splitBlock", "setFontFamily", "setFontSize", "increaseFontSize", "decreaseFontSize", "changeTextCase", "clearFormatting", "setColor", "setHighlight", "setTextShading", "setStyleId", "setCharacterStyleId", "setUnderlineStyle", "documentStyles", "print", "copy", "newDocument", "exportDocx", "exportPdf", "importDocument", "insertImage", "editImageAlt", "insertImageCaption", "imageContext", "imageWidthCm", "imageHeightCm", "imageCrop", "imageCropAspect", "imageCropShape", "imageCropFill", "imageCropFit", "imageCropReset", "imageBorder", "outdent", "indent", "togglePageBreakBefore", "toggleKeepWithNext", "setSpacingAfter", "setSpacingBefore", "setIndentLeft", "setIndentRight", "setIndentFirstLine", "setIndentHanging", "setSpecialIndent", "setParagraphShading", "applyParagraphBorders", "setLineHeight", "setListFormat", "setListStartAt", "toggleOrientation", "setOrientation", "sectionBreakNextPage", "sectionBreakContinuous", "setPageMargins", "applyDocumentTheme", "setDocumentColorScheme", "setDocumentFontScheme", "setDocumentParagraphSpacing", "setDocumentEffects", "setDocumentPageColor", "setDocumentWatermark", "setDocumentPageBorder", "setDocumentDesignDefault", "tableContext", "tableMerge", "tableSplit", "tableInsertColumnBefore", "tableInsertColumnAfter", "tableDeleteColumn", "tableInsertRowBefore", "tableInsertRowAfter", "tableDeleteRow", "tableCellShading", "tableCellBorders", "tableCellNoBorders", "tableApplyBorderPreset", "toggleTableDrawBorders", "toggleTableGridlines", "tableWidth100", "tableAlignLeft", "tableAlignCenter", "tableAlignRight", "tableSetCellWidth", "tableToggleHeaderRow", "tableToggleTotalRow", "tableToggleBandedRows", "tableToggleFirstColumn", "tableToggleLastColumn", "tableToggleBandedColumns", "setTableStyle", "tableToggleAutoFit", "tableDistributeColumns", "tableDistributeRows", "insertTable", "insertShape", "openSymbolDialog", "openEquationDialog"];
 export type OasisBuiltinCommand = (typeof OASIS_BUILTIN_COMMANDS)[number];

package/dist/core/commands/design.d.ts

@@ -0,0 +1,11 @@
+import { EditorDocumentDesign, EditorPageBorder, EditorState, EditorWatermark } from '../model.js';
+
+export type DesignThemeId = NonNullable<EditorDocumentDesign["themeId"]>;
+export declare function setDocumentDesign(state: EditorState, patch: Partial<EditorDocumentDesign>): EditorState;
+export declare function setDocumentFontScheme(state: EditorState, value: string): EditorState;
+export declare function setDocumentParagraphSpacing(state: EditorState, value: NonNullable<EditorDocumentDesign["paragraphSpacingId"]>): EditorState;
+export declare function applyDocumentTheme(state: EditorState, theme: DesignThemeId): EditorState;
+export declare function setDocumentColorScheme(state: EditorState, value: string): EditorState;
+export declare function setDocumentPageColor(state: EditorState, color: string | null): EditorState;
+export declare function setDocumentWatermark(state: EditorState, watermark: EditorWatermark | null): EditorState;
+export declare function setDocumentPageBorder(state: EditorState, border: EditorPageBorder | null): EditorState;

package/dist/core/commands/publicCommandTypes.d.ts

@@ -1,7 +1,8 @@
 import { CommandRef } from './CommandRef.js';
-import { EditorPageMargins, EditorMathExpression } from '../model.js';
+import { EditorPageMargins, EditorMathExpression, EditorPageBorder, EditorWatermark } from '../model.js';
 import { TextCaseMode } from './text.js';
 import { TableBorderPreset } from './table.js';
+import { DesignThemeId } from './design.js';
 
 /** Payload for the `insertTable` command. */
 export interface InsertTablePayload {
@@ -118,6 +119,15 @@ export interface OasisCommandPayloads {
     sectionBreakNextPage: undefined;
     sectionBreakContinuous: undefined;
     setPageMargins: SetPageMarginsPayload;
+    applyDocumentTheme: DesignThemeId;
+    setDocumentColorScheme: string;
+    setDocumentFontScheme: string;
+    setDocumentParagraphSpacing: "compact" | "tight" | "open" | "relaxed";
+    setDocumentEffects: string;
+    setDocumentPageColor: string | null;
+    setDocumentWatermark: EditorWatermark | null;
+    setDocumentPageBorder: EditorPageBorder | null;
+    setDocumentDesignDefault: undefined;
     tableContext: undefined;
     tableMerge: undefined;
     tableSplit: undefined;

package/dist/core/model/index.d.ts

@@ -18,7 +18,7 @@ export type { EditorEndnote } from './types/documentEndnotes.js';
 export type { EditorBookmark, EditorBookmarkAnchor, EditorBookmarks, } from './types/documentBookmarks.js';
 export type { EditorComment, EditorCommentAnchor, EditorComments, } from './types/documentComments.js';
 export type { EditorOpcPartKind, EditorOpcPartEncoding, EditorOpcRelationship, EditorOpcContentTypes, EditorOpcPart, EditorDocxDiagnostic, EditorDocxSourcePackage, } from './types/docxSourcePackage.js';
-export type { EditorPageMargins, EditorPageSettings, EditorColumnsSettings, EditorSection, EditorPageNumbering, EditorSectionVerticalAlign, EditorFontInfo, EditorFootnoteSettings, EditorFootnotes, EditorEndnoteSettings, EditorEndnotes, EditorDocument, } from './types/document.js';
+export type { EditorPageMargins, EditorPageSettings, EditorColumnsSettings, EditorSection, EditorPageNumbering, EditorSectionVerticalAlign, EditorFontInfo, EditorFootnoteSettings, EditorFootnotes, EditorEndnoteSettings, EditorEndnotes, EditorDocumentDesign, EditorThemeData, EditorWatermark, EditorPageBorder, EditorDocument, } from './types/document.js';
 export type { EditorPosition, EditorSelection, EditorEditingZone, } from './types/selection.js';
 export type { EditorCaretSlot, EditorLayoutFragmentChar, EditorLayoutFragment, EditorLayoutLine, EditorLayoutParagraph, EditorLayoutBlock, TableCellBlockPosition, EditorLayoutPage, EditorLayoutDocument, } from './types/layout.js';
 export type { EditorState } from './editorState.js';

package/dist/core/model/types/document.d.ts

@@ -42,6 +42,47 @@ export interface EditorPageSettings {
     margins: EditorPageMargins;
     columns?: EditorColumnsSettings;
 }
+/** Document-wide visual design selected from the Design ribbon. */
+export interface EditorDocumentDesign {
+    themeId?: "oasis" | "office" | "facet" | "integral" | "ion" | "retrospect";
+    colorSchemeId?: string;
+    fontSchemeId?: string;
+    paragraphSpacingId?: "compact" | "tight" | "open" | "relaxed";
+    effectsId?: string;
+    /** Concrete OOXML theme data used to rebuild theme1.xml. */
+    themeData?: EditorThemeData;
+    pageColor?: string | null;
+    watermark?: EditorWatermark | null;
+}
+export interface EditorThemeData {
+    name?: string;
+    colors?: Record<string, string>;
+    fonts?: {
+        major?: Record<string, string>;
+        minor?: Record<string, string>;
+    };
+    /** Theme format/effect markup retained for features not rendered by Oasis. */
+    effectsXml?: string;
+    /** Original theme XML, used until the user explicitly changes theme data. */
+    sourceXml?: string;
+}
+export interface EditorWatermark {
+    kind: "text" | "image";
+    text?: string;
+    src?: string;
+    color?: string;
+    opacity?: number;
+    rotation?: number;
+    scale?: number;
+    fontFamily?: string;
+    fontSize?: number;
+}
+export interface EditorPageBorder {
+    style: "single" | "double" | "dashed" | "dotted";
+    color: string;
+    width: number;
+    distance?: number;
+}
 /**
  * Page numbering settings for a section (`w:pgNumType`). Preserved for
  * round-trip; `start` is intended to seed PAGE-field numbering in a future
@@ -68,6 +109,7 @@ export interface EditorSection {
     id: string;
     blocks: EditorBlockNode[];
     pageSettings: EditorPageSettings;
+    pageBorder?: EditorPageBorder | null;
     header?: EditorBlockNode[];
     firstPageHeader?: EditorBlockNode[];
     evenPageHeader?: EditorBlockNode[];
@@ -143,6 +185,7 @@ export interface EditorDocument {
     schemaVersion?: number;
     id: string;
     pageSettings?: EditorPageSettings;
+    design?: EditorDocumentDesign;
     sections?: EditorSection[];
     styles?: Record<string, EditorNamedStyle>;
     settings?: {

package/dist/core/model/types/layout.d.ts

@@ -93,6 +93,8 @@ export interface TableCellBlockPosition {
 export interface EditorLayoutPage {
     id: string;
     index: number;
+    /** Source section used for page-level design decorations. */
+    sectionIndex?: number;
     height: number;
     maxHeight: number;
     blocks: EditorLayoutBlock[];

package/dist/core/pluginUiTypes.d.ts

@@ -1,4 +1,4 @@
-export declare const RIBBON_TABS: readonly ["file", "home", "insert", "draw", "layout", "references", "collaboration", "protection", "view", "tableDesign", "tableLayout", "imageFormat", "plugins", "ai"];
+export declare const RIBBON_TABS: readonly ["file", "home", "insert", "design", "draw", "layout", "references", "collaboration", "protection", "view", "tableDesign", "tableLayout", "imageFormat", "plugins", "ai"];
 export type RibbonTabId = (typeof RIBBON_TABS)[number];
 /**
  * Contextual tabs are hidden from the tab strip unless their gating command

package/dist/export/docx/docxDocumentXml.d.ts

@@ -2,4 +2,4 @@ import { EditorBlockNode, EditorDocument, EditorNamedStyle } from '../../core/mo
 import { DocContext, SectionReferenceDefinition } from './docxTypes.js';
 
 export declare function buildDocumentXml(document: EditorDocument, context: DocContext, sectionReferences: SectionReferenceDefinition[]): string;
-export declare function buildHeaderFooterXml(kind: "header" | "footer", blocks: EditorBlockNode[], context: DocContext, styles: Record<string, EditorNamedStyle> | undefined): string;
+export declare function buildHeaderFooterXml(kind: "header" | "footer", blocks: EditorBlockNode[], context: DocContext, styles: Record<string, EditorNamedStyle> | undefined, watermark?: import('../../core/model.js').EditorWatermark | null): string;

package/dist/export/docx/docxPackageXml.d.ts

@@ -1,9 +1,9 @@
 import { EditorFontInfo, EditorFootnoteSettings } from '../../core/model.js';
 import { DocContext, PartDefinition } from './docxTypes.js';
 
-export declare function buildContentTypesXml(hasNumbering: boolean, imageExtensions: Iterable<string>, hasSettings: boolean, parts: PartDefinition[], hasFootnotes: boolean, hasEndnotes: boolean, hasStyles: boolean, hasComments: boolean, hasFontTable: boolean): string;
+export declare function buildContentTypesXml(hasNumbering: boolean, imageExtensions: Iterable<string>, hasSettings: boolean, parts: PartDefinition[], hasFootnotes: boolean, hasEndnotes: boolean, hasStyles: boolean, hasComments: boolean, hasFontTable: boolean, hasTheme?: boolean): string;
 export declare function buildRootRelationshipsXml(): string;
-export declare function buildDocumentRelationshipsXml(hasNumbering: boolean, hasSettings: boolean, images: DocContext["images"], hyperlinks: DocContext["hyperlinks"], parts: PartDefinition[], hasFootnotes: boolean, hasEndnotes: boolean, hasStyles: boolean, hasComments: boolean, hasFontTable: boolean): string;
+export declare function buildDocumentRelationshipsXml(hasNumbering: boolean, hasSettings: boolean, images: DocContext["images"], hyperlinks: DocContext["hyperlinks"], parts: PartDefinition[], hasFootnotes: boolean, hasEndnotes: boolean, hasStyles: boolean, hasComments: boolean, hasFontTable: boolean, hasTheme?: boolean): string;
 /**
  * Serialize the document's font declarations to `word/fontTable.xml`. Mirrors the
  * structured {@link EditorFontInfo} back to `<w:font>` entries (substitution

package/dist/export/docx/themeXml.d.ts

@@ -0,0 +1,3 @@
+import { EditorDocumentDesign } from '../../core/model.js';
+
+export declare function buildThemeXml(design?: EditorDocumentDesign): string;

package/dist/export/pdf/OasisPdfWriter.d.ts

@@ -19,6 +19,7 @@ export declare class OasisPdfWriter {
     drawPath(pageIndex: number, options: OasisPdfPathOptions): void;
     saveGraphicsState(pageIndex: number): void;
     restoreGraphicsState(pageIndex: number): void;
+    setOpacity(pageIndex: number, opacity: number): void;
     rotateAbout(pageIndex: number, centerX: number, centerY: number, degrees: number): void;
     clipRect(pageIndex: number, x: number, y: number, width: number, height: number): void;
     clipPath(pageIndex: number, segments: OasisPdfPathSegment[]): void;

package/dist/export/pdf/draw/drawPageBackground.d.ts

@@ -1,3 +1,4 @@
 import { OasisPdfWriter } from '../OasisPdfWriter.js';
+import { EditorDocument, EditorDocumentDesign, EditorPageBorder } from '../../../core/model.js';
 
-export declare function drawPageBackground(writer: OasisPdfWriter, pageIndex: number, width: number, height: number): void;
+export declare function drawPageBackground(writer: OasisPdfWriter, pageIndex: number, width: number, height: number, design?: EditorDocumentDesign, pageBorder?: EditorPageBorder | null, document?: EditorDocument): Promise<void>;

package/dist/export/pdf/writer/PdfContentStream.d.ts

@@ -20,6 +20,7 @@ export declare class PdfContentStream {
     drawPath(options: OasisPdfPathOptions): void;
     saveGraphicsState(): void;
     restoreGraphicsState(): void;
+    setOpacity(opacity: number): void;
     rotateAbout(centerX: number, centerY: number, degrees: number): void;
     clipRect(x: number, y: number, width: number, height: number): void;
     /** Intersects the current clip with an arbitrary top-left-origin path. */

package/dist/export/pdf/writer/pdfTypes.d.ts

@@ -14,6 +14,7 @@ export interface OasisPdfPage {
     imageResourceNames: Set<string>;
     shadingResourceNames: Set<string>;
     annotations: OasisPdfAnnotation[];
+    graphicsStateOpacities?: Map<string, number>;
 }
 /**
  * A clickable link annotation. The rect is given in the writer's top-left point

package/dist/i18n/locales/en.d.ts

@@ -392,6 +392,7 @@ export declare const en: {
     "ribbon.tab.file": string;
     "ribbon.tab.home": string;
     "ribbon.tab.insert": string;
+    "ribbon.tab.design": string;
     "ribbon.tab.draw": string;
     "ribbon.tab.layout": string;
     "ribbon.tab.references": string;
@@ -426,6 +427,31 @@ export declare const en: {
     "ribbon.group.alignment": string;
     "ribbon.group.size": string;
     "ribbon.group.imageStyles": string;
+    "ribbon.group.documentFormatting": string;
+    "ribbon.group.pageBackground": string;
+    "design.themes": string;
+    "design.colors": string;
+    "design.fonts": string;
+    "design.spacing": string;
+    "design.effects": string;
+    "design.setDefault": string;
+    "design.watermark": string;
+    "design.pageColor": string;
+    "design.pageBorders": string;
+    "design.text": string;
+    "design.applyText": string;
+    "design.useImage": string;
+    "design.remove": string;
+    "design.apply": string;
+    "design.color": string;
+    "design.opacity": string;
+    "design.scale": string;
+    "design.rotation": string;
+    "design.fontFamily": string;
+    "design.fontSize": string;
+    "design.borderStyle": string;
+    "design.borderWidth": string;
+    "design.distance": string;
     "image.crop": string;
     "image.cropToShape": string;
     "image.cropAspectRatio": string;

package/dist/i18n/locales/pt-BR.d.ts

@@ -392,6 +392,7 @@ export declare const ptBR: {
     "ribbon.tab.file": string;
     "ribbon.tab.home": string;
     "ribbon.tab.insert": string;
+    "ribbon.tab.design": string;
     "ribbon.tab.draw": string;
     "ribbon.tab.layout": string;
     "ribbon.tab.references": string;
@@ -426,6 +427,31 @@ export declare const ptBR: {
     "ribbon.group.alignment": string;
     "ribbon.group.size": string;
     "ribbon.group.imageStyles": string;
+    "ribbon.group.documentFormatting": string;
+    "ribbon.group.pageBackground": string;
+    "design.themes": string;
+    "design.colors": string;
+    "design.fonts": string;
+    "design.spacing": string;
+    "design.effects": string;
+    "design.setDefault": string;
+    "design.watermark": string;
+    "design.pageColor": string;
+    "design.pageBorders": string;
+    "design.text": string;
+    "design.applyText": string;
+    "design.useImage": string;
+    "design.remove": string;
+    "design.apply": string;
+    "design.color": string;
+    "design.opacity": string;
+    "design.scale": string;
+    "design.rotation": string;
+    "design.fontFamily": string;
+    "design.fontSize": string;
+    "design.borderStyle": string;
+    "design.borderWidth": string;
+    "design.distance": string;
     "image.crop": string;
     "image.cropToShape": string;
     "image.cropAspectRatio": string;

package/dist/import/docx/sectionProperties.d.ts

@@ -1,9 +1,10 @@
 import { Element as XmlElement } from '@xmldom/xmldom';
-import { EditorBlockNode, EditorNamedStyle, EditorPageNumbering, EditorPageSettings, EditorParagraphNode, EditorSectionVerticalAlign } from '../../core/model.js';
+import { EditorBlockNode, EditorNamedStyle, EditorPageNumbering, EditorPageSettings, EditorPageBorder, EditorParagraphNode, EditorSectionVerticalAlign } from '../../core/model.js';
 import { DocxSettings } from './settings.js';
 
 export interface SectionProperties {
     pageSettings?: EditorPageSettings;
+    pageBorder?: EditorPageBorder;
     headerRIds: Partial<Record<"default" | "first" | "even", string>>;
     footerRIds: Partial<Record<"default" | "first" | "even", string>>;
     docGridLinePitchPx?: number;

package/dist/import/docx/theme.d.ts

@@ -1,3 +1,4 @@
+import { EditorThemeData } from '../../core/model.js';
 import { ThemeFontMap } from './themeFonts.js';
 import { ThemeColorMap } from './themeColors.js';
 
@@ -8,6 +9,7 @@ import { ThemeColorMap } from './themeColors.js';
 export interface DocxImportTheme {
     fonts: ThemeFontMap;
     colors: ThemeColorMap;
+    data?: EditorThemeData;
 }
 /**
  * Parses `word/theme/theme1.xml` once and extracts both font and color scheme