@syncfusion/ej2-office-common 35.1.37

package/src/features/smart-art/parse-rel-ids.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Parse `dgm:relIds` (`CT_RelIds`) from host graphic-data XML.
+ *
+ * @remarks
+ * Citations: `dml-diagram.xsd` `CT_RelIds` (required `r:dm`/`r:lo`/`r:qs`/`r:cs`);
+ * [MS-ODRAWXML] §3.7.1 sample; [MS-OE376] GraphicData URI → `relIds`.
+ *
+ * Explicit parse APIs throw {@link DiagramPartError} when any required attribute
+ * is missing or empty. Package enumerate (preserve-on-load) skips incomplete
+ * hooks without throwing — see {@link findDiagramRelIds}.
+ *
+ * @public
+ */
+import { DiagramXmlElement } from './diagram-xml';
+import { DiagramRelIds } from './types';
+/**
+ * Reads the four required `CT_RelIds` attributes from a `dgm:relIds` element.
+ *
+ * @returns The ids, or `undefined` when any required attribute is missing/empty
+ * (preserve path for package open).
+ *
+ * @private
+ */
+export declare function tryReadDiagramRelIds(el: DiagramXmlElement): DiagramRelIds | undefined;
+/**
+ * Requires a complete `CT_RelIds` on the element or throws.
+ *
+ * @private
+ */
+export declare function requireDiagramRelIds(el: DiagramXmlElement): DiagramRelIds;
+/**
+ * True when `el` is `a:graphicData` with the diagram GraphicData URI.
+ *
+ * @private
+ */
+export declare function isDiagramGraphicData(el: DiagramXmlElement): boolean;
+/**
+ * Finds complete `dgm:relIds` payloads under diagram `a:graphicData` hooks.
+ *
+ * @remarks
+ * Incomplete `CT_RelIds` (missing/empty required attributes) are skipped — the
+ * preserve-on-load policy for package open. Use {@link parseDiagramRelIds} when
+ * the caller explicitly requires a complete hook.
+ *
+ * When a `relIds` element is nested under `a:graphicData`, only diagram URI
+ * hooks are accepted. A bare `dgm:relIds` document root is always accepted when
+ * complete.
+ *
+ * @param xml - Host part or fragment XML that may contain `a:graphicData` /
+ * `dgm:relIds`.
+ * @returns Zero or more complete {@link DiagramRelIds} values in document order.
+ *
+ * @public
+ */
+export declare function findDiagramRelIds(xml: string): ReadonlyArray<DiagramRelIds>;
+/**
+ * Parses a complete `dgm:relIds` (`CT_RelIds`) from XML.
+ *
+ * @remarks
+ * Accepts a document whose root is `dgm:relIds`, or a larger tree containing
+ * exactly one complete diagram `relIds` hook (as returned by
+ * {@link findDiagramRelIds}). Throws when none or multiple complete hooks are
+ * present, or when the only hook is incomplete.
+ *
+ * @param xml - XML text.
+ * @returns The four relationship id strings.
+ * @throws {DiagramPartError} Incomplete or ambiguous `relIds`.
+ *
+ * @public
+ */
+export declare function parseDiagramRelIds(xml: string): DiagramRelIds;

package/src/features/smart-art/parse-rel-ids.js

@@ -0,0 +1,233 @@
+/**
+ * Parse `dgm:relIds` (`CT_RelIds`) from host graphic-data XML.
+ *
+ * @remarks
+ * Citations: `dml-diagram.xsd` `CT_RelIds` (required `r:dm`/`r:lo`/`r:qs`/`r:cs`);
+ * [MS-ODRAWXML] §3.7.1 sample; [MS-OE376] GraphicData URI → `relIds`.
+ *
+ * Explicit parse APIs throw {@link DiagramPartError} when any required attribute
+ * is missing or empty. Package enumerate (preserve-on-load) skips incomplete
+ * hooks without throwing — see {@link findDiagramRelIds}.
+ *
+ * @public
+ */
+var __values = (this && this.__values) || function (o) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator], i = 0;
+    if (m) return m.call(o);
+    return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+};
+import { elementChildren, findChild, getAttribute, parseDiagramXml, } from './diagram-xml';
+import { DiagramPartError } from './errors';
+import { DIAGRAM_GRAPHIC_DATA_URI, DIAGRAM_NAMESPACE, DRAWINGML_MAIN_NAMESPACE, OFFICE_DOCUMENT_RELATIONSHIPS_NAMESPACE, } from './namespaces';
+function readRelIdAttr(el, localName) {
+    var value = getAttribute(el, localName, OFFICE_DOCUMENT_RELATIONSHIPS_NAMESPACE);
+    if (value === undefined) {
+        return undefined;
+    }
+    var trimmed = value.trim();
+    return trimmed.length > 0 ? trimmed : undefined;
+}
+/**
+ * Reads the four required `CT_RelIds` attributes from a `dgm:relIds` element.
+ *
+ * @returns The ids, or `undefined` when any required attribute is missing/empty
+ * (preserve path for package open).
+ *
+ * @private
+ */
+export function tryReadDiagramRelIds(el) {
+    if (el.localName !== 'relIds' || el.namespaceUri !== DIAGRAM_NAMESPACE) {
+        return undefined;
+    }
+    var dm = readRelIdAttr(el, 'dm');
+    var lo = readRelIdAttr(el, 'lo');
+    var qs = readRelIdAttr(el, 'qs');
+    var cs = readRelIdAttr(el, 'cs');
+    if (dm === undefined || lo === undefined || qs === undefined || cs === undefined) {
+        return undefined;
+    }
+    return { dm: dm, lo: lo, qs: qs, cs: cs };
+}
+/**
+ * Requires a complete `CT_RelIds` on the element or throws.
+ *
+ * @private
+ */
+export function requireDiagramRelIds(el) {
+    var ids = tryReadDiagramRelIds(el);
+    if (ids === undefined) {
+        throw new DiagramPartError('dgm:relIds requires non-empty r:dm, r:lo, r:qs, and r:cs (CT_RelIds)');
+    }
+    return ids;
+}
+function collectRelIdsElements(root, out) {
+    var e_1, _a;
+    if (root.localName === 'relIds' && root.namespaceUri === DIAGRAM_NAMESPACE) {
+        out.push(root);
+    }
+    try {
+        for (var _b = __values(elementChildren(root)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            collectRelIdsElements(child, out);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+}
+/**
+ * True when `el` is `a:graphicData` with the diagram GraphicData URI.
+ *
+ * @private
+ */
+export function isDiagramGraphicData(el) {
+    if (el.localName !== 'graphicData' || el.namespaceUri !== DRAWINGML_MAIN_NAMESPACE) {
+        return false;
+    }
+    var uri = getAttribute(el, 'uri', '');
+    return uri === DIAGRAM_GRAPHIC_DATA_URI;
+}
+function findPath(node, target, path) {
+    var e_2, _a;
+    path.push(node);
+    if (node === target) {
+        return true;
+    }
+    try {
+        for (var _b = __values(elementChildren(node)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            if (findPath(child, target, path)) {
+                return true;
+            }
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_2) throw e_2.error; }
+    }
+    path.pop();
+    return false;
+}
+function findOwningGraphicData(root, target) {
+    var path = [];
+    if (!findPath(root, target, path)) {
+        return undefined;
+    }
+    for (var i = path.length - 1; i >= 0; i -= 1) {
+        var node = path[i];
+        if (node !== undefined &&
+            node.localName === 'graphicData' &&
+            node.namespaceUri === DRAWINGML_MAIN_NAMESPACE) {
+            return node;
+        }
+    }
+    return undefined;
+}
+/**
+ * Finds complete `dgm:relIds` payloads under diagram `a:graphicData` hooks.
+ *
+ * @remarks
+ * Incomplete `CT_RelIds` (missing/empty required attributes) are skipped — the
+ * preserve-on-load policy for package open. Use {@link parseDiagramRelIds} when
+ * the caller explicitly requires a complete hook.
+ *
+ * When a `relIds` element is nested under `a:graphicData`, only diagram URI
+ * hooks are accepted. A bare `dgm:relIds` document root is always accepted when
+ * complete.
+ *
+ * @param xml - Host part or fragment XML that may contain `a:graphicData` /
+ * `dgm:relIds`.
+ * @returns Zero or more complete {@link DiagramRelIds} values in document order.
+ *
+ * @public
+ */
+export function findDiagramRelIds(xml) {
+    var e_3, _a;
+    var root = parseDiagramXml(xml);
+    var elements = [];
+    collectRelIdsElements(root, elements);
+    var accepted = [];
+    try {
+        for (var elements_1 = __values(elements), elements_1_1 = elements_1.next(); !elements_1_1.done; elements_1_1 = elements_1.next()) {
+            var el = elements_1_1.value;
+            var ids = tryReadDiagramRelIds(el);
+            if (ids === undefined) {
+                continue;
+            }
+            if (el === root) {
+                accepted.push(ids);
+                continue;
+            }
+            var owner = findOwningGraphicData(root, el);
+            if (owner === undefined || isDiagramGraphicData(owner)) {
+                accepted.push(ids);
+            }
+        }
+    }
+    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+    finally {
+        try {
+            if (elements_1_1 && !elements_1_1.done && (_a = elements_1.return)) _a.call(elements_1);
+        }
+        finally { if (e_3) throw e_3.error; }
+    }
+    return accepted;
+}
+/**
+ * Parses a complete `dgm:relIds` (`CT_RelIds`) from XML.
+ *
+ * @remarks
+ * Accepts a document whose root is `dgm:relIds`, or a larger tree containing
+ * exactly one complete diagram `relIds` hook (as returned by
+ * {@link findDiagramRelIds}). Throws when none or multiple complete hooks are
+ * present, or when the only hook is incomplete.
+ *
+ * @param xml - XML text.
+ * @returns The four relationship id strings.
+ * @throws {DiagramPartError} Incomplete or ambiguous `relIds`.
+ *
+ * @public
+ */
+export function parseDiagramRelIds(xml) {
+    var root = parseDiagramXml(xml);
+    if (root.localName === 'relIds' && root.namespaceUri === DIAGRAM_NAMESPACE) {
+        return requireDiagramRelIds(root);
+    }
+    // Single graphicData → relIds convenience (MS-ODRAWXML sample shape).
+    if (isDiagramGraphicData(root)) {
+        var child = findChild(root, 'relIds', DIAGRAM_NAMESPACE);
+        if (child === undefined) {
+            throw new DiagramPartError('a:graphicData (diagram) is missing dgm:relIds');
+        }
+        return requireDiagramRelIds(child);
+    }
+    var found = findDiagramRelIds(xml);
+    if (found.length === 0) {
+        var elements = [];
+        collectRelIdsElements(root, elements);
+        if (elements.length > 0) {
+            throw new DiagramPartError('dgm:relIds requires non-empty r:dm, r:lo, r:qs, and r:cs (CT_RelIds)');
+        }
+        throw new DiagramPartError('No dgm:relIds element found');
+    }
+    if (found.length > 1) {
+        throw new DiagramPartError('parseDiagramRelIds expects exactly one dgm:relIds hook');
+    }
+    var only = found[0];
+    if (only === undefined) {
+        throw new DiagramPartError('No dgm:relIds element found');
+    }
+    return only;
+}

package/src/features/smart-art/parse-style.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Parse Diagram Style part (`dgm:styleDef` / `CT_StyleDefinition`).
+ *
+ * @remarks
+ * Citations: Transitional `dml-diagram.xsd` (`CT_StyleDefinition`);
+ * ECMA-376 Part 1 §14.2.6. v1: optional `uniqueId` + opaque root preserve.
+ *
+ * @public
+ */
+import { DiagramStylePart } from './types';
+/**
+ * Parses a Diagram Style part XML document into a {@link DiagramStylePart}.
+ *
+ * @param xml - UTF-8 XML for a single `dgm:styleDef` root.
+ * @throws {DiagramPartError} Malformed XML or wrong root element.
+ *
+ * @public
+ */
+export declare function parseDiagramStyle(xml: string): DiagramStylePart;

package/src/features/smart-art/parse-style.js

@@ -0,0 +1,39 @@
+/**
+ * Parse Diagram Style part (`dgm:styleDef` / `CT_StyleDefinition`).
+ *
+ * @remarks
+ * Citations: Transitional `dml-diagram.xsd` (`CT_StyleDefinition`);
+ * ECMA-376 Part 1 §14.2.6. v1: optional `uniqueId` + opaque root preserve.
+ *
+ * @public
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { cloneElement, getAttribute, parseDiagramXml } from './diagram-xml';
+import { DiagramPartError } from './errors';
+import { DIAGRAM_NAMESPACE } from './namespaces';
+/**
+ * Parses a Diagram Style part XML document into a {@link DiagramStylePart}.
+ *
+ * @param xml - UTF-8 XML for a single `dgm:styleDef` root.
+ * @throws {DiagramPartError} Malformed XML or wrong root element.
+ *
+ * @public
+ */
+export function parseDiagramStyle(xml) {
+    var root = parseDiagramXml(xml);
+    if (root.localName !== 'styleDef' || root.namespaceUri !== DIAGRAM_NAMESPACE) {
+        throw new DiagramPartError("Expected dgm:styleDef root, got " + root.qName + " in ns \"" + root.namespaceUri + "\"");
+    }
+    var uniqueId = getAttribute(root, 'uniqueId');
+    return __assign({ kind: 'diagramStyle' }, (uniqueId !== undefined ? { uniqueId: uniqueId } : {}), { root: cloneElement(root) });
+}

package/src/features/smart-art/point-text.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Common plain-text and structure query APIs for DrawingML diagram points.
+ *
+ * @remarks
+ * Text lives under `dgm:pt/dgm:t` as DrawingML `a:CT_TextBody` (`dml-main.xsd`:
+ * required `bodyPr`, optional `lstStyle`, one or more `p`). Plain text is the
+ * concatenation of `a:t` under each paragraph, with paragraphs joined by `\n`.
+ * Write rebuilds a minimal schema-valid text body while preserving other `pt`
+ * children and any existing `bodyPr` / `lstStyle`. Citations: `dml-diagram.xsd`
+ * `CT_Pt`; `dml-main.xsd` `CT_TextBody` / `CT_TextParagraph`; ECMA-376 Part 1
+ * §14.2.4. Structure add/remove of points and connections is deferred (no
+ * schema-valid factory beyond enumerate in this task).
+ *
+ * @public
+ */
+import { DiagramConnection, DiagramDataPart, DiagramPoint } from './types';
+/**
+ * Returns the points of a Diagram Data part (structure enumerate).
+ *
+ * @param data - Parsed {@link DiagramDataPart}.
+ * @returns The part's `points` array (same reference; treat as read-only).
+ *
+ * @public
+ */
+export declare function listDiagramPoints(data: DiagramDataPart): ReadonlyArray<DiagramPoint>;
+/**
+ * Returns the connections of a Diagram Data part (structure enumerate).
+ *
+ * @param data - Parsed {@link DiagramDataPart}.
+ * @returns The part's `connections` array (same reference; treat as read-only).
+ *
+ * @public
+ */
+export declare function listDiagramConnections(data: DiagramDataPart): ReadonlyArray<DiagramConnection>;
+/**
+ * Finds a point by `modelId`.
+ *
+ * @param data - Parsed {@link DiagramDataPart}.
+ * @param modelId - `dgm:pt@modelId` value.
+ * @returns The matching {@link DiagramPoint}, or `undefined` when absent.
+ *
+ * @public
+ */
+export declare function diagramPoint(data: DiagramDataPart, modelId: string): DiagramPoint | undefined;
+/**
+ * Reads plain text from a diagram point's `dgm:t` DrawingML text body.
+ *
+ * @remarks
+ * Walks `a:p` paragraphs in document order. Within each paragraph, concatenates
+ * text from `a:t` descendants (including under `a:r` and `a:fld`). Paragraphs
+ * are joined with `\n`. Missing `dgm:t` yields an empty string.
+ *
+ * @param point - Modeled point (from parse or {@link listDiagramPoints}).
+ * @returns Plain text; empty string when the point has no text body or no `a:t`.
+ *
+ * @public
+ */
+export declare function diagramPointText(point: DiagramPoint): string;
+/**
+ * Returns a new {@link DiagramDataPart} with plain text written to the named point.
+ *
+ * @remarks
+ * Does not mutate `data`. Rebuilds `dgm:t` as a minimal valid `a:CT_TextBody`
+ * (`bodyPr` + one `p`/`r`/`t` per line). When a text body already exists,
+ * `bodyPr` and `lstStyle` (if present) are preserved; paragraph children are
+ * replaced. Other `dgm:pt` siblings and package root extensions are preserved
+ * via root rewrite + reparse. Unknown `modelId` throws.
+ *
+ * Prefer this name over a `set*` verb (API-RULES R1.1 content-mutation ban on
+ * `set*` / free-function `set*` patterns).
+ *
+ * @param data - Source data part (immutable).
+ * @param modelId - Target `dgm:pt@modelId`.
+ * @param text - Plain text; `\n` splits paragraphs.
+ * @returns New data part with updated point text and synced root.
+ * @throws {DiagramPartError} When no point matches `modelId`.
+ *
+ * @public
+ */
+export declare function withDiagramPointText(data: DiagramDataPart, modelId: string, text: string): DiagramDataPart;