web-doc 0.9.0 → 0.11.0

package/THIRD_PARTY_NOTICES.md

@@ -49,5 +49,19 @@ The release artifact contains or depends on the following principal components.
   `packages/viewer/src/edit/pptx/`, `packages/viewer/src/edit/docx/` and
   `packages/viewer/src/edit/ai/` are web-doc's own; no GenOffice code is
   included.
+- [Adobe Glyph List and Adobe Glyph List For New Fonts](https://github.com/adobe-type-tools/agl-aglfn) — BSD-3-Clause; the glyph names and code points in `packages/viewer/src/edit/pdf/engine/glyph-names.ts` (AGLFN 1.7 and nine AGL 2.0 entries), which give an embedded CFF font a Unicode cmap. The ISOAdobe glyph names in `packages/viewer/src/edit/pdf/engine/cff.ts` are the standard strings of the CFF specification (Adobe Technical Note 5176). Their license:
+
+  > Copyright 2002-2019 Adobe (http://www.adobe.com/).
+
+  > Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+  > Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+  > Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+  > Neither the name of Adobe nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+  > THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 - [Noto Sans](https://github.com/notofonts/noto-fonts) and [Noto Sans CJK](https://github.com/notofonts/noto-cjk) subset fonts — SIL Open Font License 1.1. The font manifest, complete OFL text, pinned source commits and SHA-256 hashes are included in `dist/fonts/`.
   No Microsoft proprietary font or copyleft runtime component is bundled. Transitive notices and license expressions are verified by `npm run licenses`.

package/dist/adapters/office.js

@@ -32,7 +32,7 @@ export class OfficeDocumentAdapter {
             : (await import("../edit/pptx/provider.js")).loadPptxEditEngine(original, context, this.#options.edit ?? {}),
         createSession: (core, access) => core.format === "docx"
             ? new DocxSession(core, access)
-            : new PptxSession(core),
+            : new PptxSession(core, access),
     };
     formats = [...MODERN_FORMATS, ...LEGACY_FORMATS];
     #options;
@@ -86,7 +86,6 @@ export class OfficeDocumentAdapter {
             useGoogleFonts: false,
             maxZipEntryBytes: context.limits.maxZipEntryBytes,
             mode: "main",
-            ...(reopening ? { progressiveLayout: true } : {}),
         };
         try {
             const kind = kindFor(format);
@@ -113,7 +112,10 @@ export class OfficeDocumentAdapter {
             }
             const buffer = exactArrayBuffer(data);
             if (kind === "presentation") {
-                const backend = await this.#loadPptx(buffer, engineOptions);
+                const backend = await this.#loadPptx(buffer, {
+                    ...engineOptions,
+                    ...(reopening ? { progressiveLayout: true } : {}),
+                });
                 throwIfAborted(context.signal, backend);
                 context.reportProgress({
                     phase: "parsing",
@@ -309,6 +311,7 @@ export class OfficeDocumentAdapter {
                 y: run.shapeY + run.inShapeY,
                 width: run.w,
                 height: run.h,
+                shapeOrigin: { x: run.shapeX, y: run.shapeY },
                 ...safeHyperlink(run.hyperlink, (ref) => handle.backend.resolveInternalTarget?.(ref, pageIndex)),
                 direction: textDirection(run.text),
             }));

package/dist/contracts.d.ts

@@ -195,6 +195,15 @@ export interface TextRun {
      * source paragraph.
      */
     readonly paragraphId?: string;
+    /**
+     * PPTX: the top-left corner of the frame of the shape the run was laid out
+     * in, in the run coordinate space (slide CSS pixels). Text a shape paints
+     * past its frame, wrapped below a short box, still names its shape.
+     */
+    readonly shapeOrigin?: {
+        readonly x: number;
+        readonly y: number;
+    };
 }
 export type HyperlinkTarget = {
     readonly kind: "external";

package/dist/edit/docx/engine.d.ts

@@ -3,10 +3,12 @@ import type { BatchMode, EditEngine, EngineBatch, EngineChange, MaterializedDocu
 import { OoxmlPackage } from "../ooxml/package.js";
 import type { EditFindOptions, EditOperation, ElementQuery, OperationIssue, PagePoint, TextTarget } from "../types.js";
 import { DocxModel, type AnyRecord } from "./model.js";
-import type { DocxElement, DocxRevision } from "./types.js";
+import type { DocxElement, DocxRevision, DocxTextStyle } from "./types.js";
+import { type TextSpan } from "../range-style.js";
 /** Reads the DOCX session adds on top of the core, served by the engine and the worker client alike. */
 export interface DocxEngineReads {
     revisions(id: string, signal: AbortSignal): Promise<readonly DocxRevision[]>;
+    textStyle(id: string, span: TextSpan | undefined, signal: AbortSignal): Promise<Partial<DocxTextStyle> | undefined>;
 }
 export declare class DocxEditEngine implements EditEngine, DocxEngineReads {
     #private;
@@ -25,6 +27,12 @@ export declare class DocxEditEngine implements EditEngine, DocxEngineReads {
     apply(input: EngineBatch | readonly EditOperation[], signal: AbortSignal): Promise<EngineChange>;
     /** The revisions of a paragraph; none for another element or an unknown id. */
     revisions(id: string, signal: AbortSignal): Promise<readonly DocxRevision[]>;
+    /**
+     * The style a span of a paragraph shows: what every run it covers shares;
+     * the paragraph mark's for an empty paragraph. None for another element,
+     * an unknown id or a span past the text.
+     */
+    textStyle(id: string, span: TextSpan | undefined, signal: AbortSignal): Promise<Partial<DocxTextStyle> | undefined>;
     materialize(purposeOrSignal?: "show" | "save" | AbortSignal, options?: MaterializeOptions, signal?: AbortSignal): Promise<Uint8Array>;
     /**
      * `save` is the package as the session changed it: ids written only on

package/dist/edit/docx/engine.js

@@ -7,9 +7,11 @@ import { NO_PAGE, toElement } from "./elements.js";
 import { docxHandlers } from "./handlers.js";
 import { freshParagraphId, paragraphsOf } from "./ids.js";
 import { DocxModel } from "./model.js";
+import { resolveTextStyle } from "./style.js";
 import { issueCollector, } from "./operations.js";
 import { docxOperationSchemas } from "./schemas.js";
 import { revisionsOf } from "./tracked.js";
+import { runsCovering, sharedStyle, spanFits, } from "../range-style.js";
 import { attributeProblem, namespacePatches } from "./write.js";
 /*
  * The DOCX edit engine: the package layer under a block index of the body
@@ -303,6 +305,26 @@ export class DocxEditEngine {
             return [];
         return revisionsOf(model.document, record.node);
     }
+    /**
+     * The style a span of a paragraph shows: what every run it covers shares;
+     * the paragraph mark's for an empty paragraph. None for another element,
+     * an unknown id or a span past the text.
+     */
+    async textStyle(id, span, signal) {
+        const model = await this.model(signal);
+        const record = model.byId.get(id);
+        if (!record || record.kind !== "paragraph")
+            return undefined;
+        const { text, items } = record.text;
+        const range = span ?? { start: 0, end: text.length };
+        if (!spanFits(range, text.length))
+            return undefined;
+        const covered = runsCovering(items, range);
+        const mark = record.pPr?.children.find((child) => child.local === "rPr");
+        return sharedStyle(covered.length > 0
+            ? covered.map((item) => resolveTextStyle(model.styles, record.pPr, item.rPr))
+            : [resolveTextStyle(model.styles, record.pPr, mark)]);
+    }
     async materialize(purposeOrSignal = "show", options = {}, signal = new AbortController().signal) {
         return (await this.materializeDocument(purposeOrSignal, options, signal))
             .bytes;

package/dist/edit/docx/provider.d.ts

@@ -2,7 +2,8 @@ import type { EditEngineContext } from "../engine.js";
 import { type OoxmlEditProviderOptions } from "../ooxml/worker.js";
 import { WorkerEngineClient } from "../worker-engine.js";
 import type { DocxEngineReads } from "./engine.js";
-import type { DocxRevision } from "./types.js";
+import type { TextSpan } from "../range-style.js";
+import type { DocxRevision, DocxTextStyle } from "./types.js";
 export type DocxEditProviderOptions = OoxmlEditProviderOptions;
 /**
  * Starts the OOXML edit worker for `original` as a DOCX engine. Loaded
@@ -12,5 +13,6 @@ export declare function loadDocxEditEngine(original: Uint8Array, context: EditEn
 export declare class DocxEditEngineClient extends WorkerEngineClient implements DocxEngineReads {
     readonly schemas: import("../types.js").OperationSchemaSet;
     revisions(id: string, signal: AbortSignal): Promise<readonly DocxRevision[]>;
+    textStyle(id: string, span: TextSpan | undefined, signal: AbortSignal): Promise<Partial<DocxTextStyle> | undefined>;
     start(original: Uint8Array): Promise<void>;
 }

package/dist/edit/docx/provider.js

@@ -24,6 +24,9 @@ export class DocxEditEngineClient extends WorkerEngineClient {
     revisions(id, signal) {
         return this.request("edit-docx-revisions", { id }, signal);
     }
+    textStyle(id, span, signal) {
+        return this.request("edit-docx-text-style", { id, span }, signal);
+    }
     async start(original) {
         const data = original.slice().buffer;
         const open = {

package/dist/edit/docx/session.d.ts

@@ -1,7 +1,7 @@
 import type { DescribeOptions, DocumentDescription, EditCheckpoint, OutlineOptions, OutlineResult, TargetCandidate, TargetQuery, ToolCall, ToolCallOptions, ToolResult, ToolSet } from "../ai/types.js";
 import type { EditSessionAccess, EditSessionCore } from "../engine.js";
-import type { ApplyOptions, AssetOptions, EditFindOptions, EditOperation, EditReceipt, EditState, ElementQuery, HistoryOptions, OperationSchemaSet, PagePoint, PageRect, ReadItem, ReadOptions, ReadResult, SavedDocument, TextTarget } from "../types.js";
-import type { DocxDeleteElementOperation, DocxEditSession, DocxElement, DocxFields, DocxInsertImageOperation, DocxInsertParagraphOperation, DocxInsertTableOperation, DocxMoveElementOperation, DocxOperation, DocxReplaceTextOperation, DocxRevision, DocxSaveOptions, DocxSetParagraphStyleOperation, DocxSetTableCellOperation, DocxSetTextStyleOperation } from "./types.js";
+import type { ApplyOptions, AssetOptions, EditFindOptions, EditOperation, EditReceipt, EditState, ElementQuery, HistoryOptions, OperationSchemaSet, PagePoint, PageRect, ReadItem, ReadOptions, ReadResult, SavedDocument, TextRange, TextTarget } from "../types.js";
+import type { DocxDeleteElementOperation, DocxEditSession, DocxElement, DocxFields, DocxInsertImageOperation, DocxInsertParagraphOperation, DocxInsertTableOperation, DocxMoveElementOperation, DocxOperation, DocxReplaceTextOperation, DocxRevision, DocxSaveOptions, DocxSetParagraphStyleOperation, DocxSetTableCellOperation, DocxSetTextStyleOperation, DocxTextStyle } from "./types.js";
 /** Per paragraph id (eight hex digits), the union of its runs per page. */
 type Placement = ReadonlyMap<string, ReadonlyMap<number, PageRect>>;
 export declare class DocxSession implements DocxEditSession {
@@ -33,6 +33,10 @@ export declare class DocxSession implements DocxEditSession {
     get tools(): ToolSet;
     callTool(call: ToolCall, options?: ToolCallOptions): Promise<ToolResult>;
     getRevisions(elementId: string, options?: ReadOptions): Promise<ReadResult<DocxRevision>>;
+    getTextStyle(fields: {
+        readonly target: string;
+        readonly range?: TextRange;
+    }, options?: ReadOptions): Promise<ReadItem<Partial<DocxTextStyle>>>;
     replaceText(fields: DocxFields<DocxReplaceTextOperation>, options?: ApplyOptions): Promise<EditReceipt>;
     setTextStyle(fields: DocxFields<DocxSetTextStyleOperation>, options?: ApplyOptions): Promise<EditReceipt>;
     setParagraphStyle(fields: DocxFields<DocxSetParagraphStyleOperation>, options?: ApplyOptions): Promise<EditReceipt>;

package/dist/edit/docx/session.js

@@ -2,6 +2,7 @@ import { readDescription, readOutline } from "../ai/outline.js";
 import { resolveTargets } from "../ai/targets.js";
 import { buildToolSet, callTool as runTool } from "../ai/tools.js";
 import { ViewerError } from "../../errors.js";
+import { spanOnTarget } from "../range-style.js";
 export class DocxSession {
     format = "docx";
     #core;
@@ -134,6 +135,10 @@ export class DocxSession {
     getRevisions(elementId, options) {
         return this.#core.readItems(options, (engine, signal) => docxReads(engine).revisions(elementId, signal));
     }
+    async getTextStyle(fields, options) {
+        const span = spanOnTarget(fields.target, fields.range);
+        return this.#core.readItem(options, (engine, signal) => docxReads(engine).textStyle(fields.target, span, signal));
+    }
     replaceText(fields, options) {
         return this.apply([{ op: "replaceText", ...fields }], options);
     }
@@ -461,7 +466,8 @@ function matchesQuery(element, query) {
 }
 function docxReads(engine) {
     const candidate = engine;
-    if (typeof candidate.revisions !== "function")
+    if (typeof candidate.revisions !== "function" ||
+        typeof candidate.textStyle !== "function")
         throw new ViewerError("edit-unsupported", "The engine does not provide the DOCX reads", { details: { format: "docx", reason: "no-reads" } });
     return candidate;
 }

package/dist/edit/docx/style.d.ts

@@ -34,7 +34,7 @@ export declare class DocxStyles {
     /** A style and the styles it is based on, nearest first; cycles stop. */
     chain(id: string | undefined): StyleRecord[];
 }
-/** `w:b`, `w:i`, `w:default`-style toggles: present without a value means on. */
+/** `w:b`/`w:i` toggle values: a present element without `w:val` means on. */
 export declare function isOn(value: string | undefined): boolean;
 /** The run property holders in resolution order for a run of a paragraph. */
 export declare function runPropertySources(styles: DocxStyles, pPr: XmlElement | undefined, rPr: XmlElement | undefined): readonly XmlElement[];

package/dist/edit/docx/style.js

@@ -95,11 +95,12 @@ export class DocxStyles {
             if (!id)
                 continue;
             const basedOn = part.attribute(node.children.find((child) => child.local === "basedOn") ?? node, "w:val");
+            const defaultAttribute = part.attribute(node, "w:default");
             const record = {
                 id,
                 type: part.attribute(node, "w:type") ?? "paragraph",
                 ...(basedOn && basedOn !== id ? { basedOn } : {}),
-                isDefault: isOn(part.attribute(node, "w:default")),
+                isDefault: defaultAttribute !== undefined && isOn(defaultAttribute),
                 ...pick(node, "rPr", "pPr"),
             };
             styles.set(id, record);
@@ -175,7 +176,7 @@ async function readTheme(pkg, themePart, signal) {
         return none;
     }
 }
-/** `w:b`, `w:i`, `w:default`-style toggles: present without a value means on. */
+/** `w:b`/`w:i` toggle values: a present element without `w:val` means on. */
 export function isOn(value) {
     return value === undefined || !/^(0|false|off)$/i.test(value);
 }

package/dist/edit/docx/types.d.ts

@@ -1,4 +1,4 @@
-import type { ApplyOptions, BinaryData, EditColor, EditElement, EditReceipt, EditSessionBase, ReadOptions, ReadResult, SavedDocument, SaveOptions, TextRange } from "../types.js";
+import type { ApplyOptions, BinaryData, EditColor, EditElement, EditReceipt, EditSessionBase, ReadItem, ReadOptions, ReadResult, SavedDocument, SaveOptions, TextRange } from "../types.js";
 export type DocxElementKind = "paragraph" | "table" | "image" | "other";
 export type DocxTextAlign = "left" | "center" | "right" | "justify";
 /** Word's sixteen highlight colours (`w:highlight/@w:val`). */
@@ -193,6 +193,16 @@ export interface DocxEditSession extends EditSessionBase<DocxOperation, DocxElem
     save(options?: DocxSaveOptions): Promise<SavedDocument>;
     /** The tracked changes a paragraph holds, in document order; empty for other elements. */
     getRevisions(elementId: string, options?: ReadOptions): Promise<ReadResult<DocxRevision>>;
+    /**
+     * The text style a range of a paragraph shows: each property every run it
+     * covers shares, a property they differ on left out. Without a range, the
+     * whole text; a collapsed range reads the run before it, whose style text
+     * typed there takes. `undefined` for an element without text.
+     */
+    getTextStyle(fields: {
+        readonly target: string;
+        readonly range?: TextRange;
+    }, options?: ReadOptions): Promise<ReadItem<Partial<DocxTextStyle>>>;
     /** Replaces the whole text of a paragraph, or the part a range covers. */
     replaceText(fields: DocxFields<DocxReplaceTextOperation>, options?: ApplyOptions): Promise<EditReceipt>;
     /** Changes run properties; unspecified ones keep their bytes. */

package/dist/edit/pdf/engine/cff.d.ts

@@ -0,0 +1,28 @@
+/** What a browser font is built from. */
+export interface CffFont {
+    /** The font's PostScript name, a subset tag included. */
+    readonly name: string;
+    /** CID-keyed: glyphs are numbered, not named, and only the PDF's CMap says what they draw. */
+    readonly cid: boolean;
+    /** Glyph names by glyph id; `undefined` where the name is not one this reader knows. */
+    readonly glyphNames: readonly (string | undefined)[];
+    /** Advance widths by glyph id, in font units. */
+    readonly widths: readonly number[];
+    readonly bbox: readonly [number, number, number, number];
+    readonly unitsPerEm: number;
+}
+/**
+ * The code point a glyph name stands for: an Adobe Glyph List name, or
+ * `uniXXXX` or `uXXXX[XX]` for one code point. Ligatures of several code
+ * points, suffixed variants such as `a.sc`, and noncharacters stand for none.
+ */
+export declare function glyphUnicode(name: string | undefined): number | undefined;
+/** Reads a CFF font program, or `undefined` when it is not one this reader can use. */
+export declare function readCff(bytes: Uint8Array): CffFont | undefined;
+/**
+ * A copy of the program whose font name holds only what a browser's font
+ * sanitizer accepts in a CFF table: printable ASCII without
+ * `[](){}<>/%` or a space, each other byte becoming `_`; `undefined` past
+ * the 127 characters it accepts or for a program that is not one font.
+ */
+export declare function cffWithSafeName(bytes: Uint8Array): Uint8Array | undefined;