@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/comments/comment-extensions.d.ts

@@ -0,0 +1,157 @@
+import { OpcPackage } from '../../core/opc/package';
+import { PartName } from '../../core/opc/part-name';
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.2 commentsExtended relationship. */
+export declare const COMMENTS_EXTENDED_RELATIONSHIP_TYPE = "http://schemas.microsoft.com/office/2011/relationships/commentsExtended";
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.3 people relationship. */
+export declare const PEOPLE_RELATIONSHIP_TYPE = "http://schemas.microsoft.com/office/2011/relationships/people";
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.4 commentsIds relationship. */
+export declare const COMMENTS_IDS_RELATIONSHIP_TYPE = "http://schemas.microsoft.com/office/2016/09/relationships/commentsIds";
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.5 commentsExtensible relationship. */
+export declare const COMMENTS_EXTENSIBLE_RELATIONSHIP_TYPE = "http://schemas.microsoft.com/office/2018/08/relationships/commentsExtensible";
+/**
+ * @private
+ * `[MS-DOCX]` §2.5.1.5 commentsExtended root namespace. */
+export declare const COMMENTS_EXTENDED_NAMESPACE = "http://schemas.microsoft.com/office/word/2012/wordml";
+/**
+ * @private
+ * `[MS-DOCX]` §2.8 commentsIds root namespace. */
+export declare const COMMENTS_IDS_NAMESPACE = "http://schemas.microsoft.com/office/word/2016/wordml/cid";
+/**
+ * @private
+ * `[MS-DOCX]` §2.10 commentsExtensible root namespace. */
+export declare const COMMENTS_EXTENSIBLE_NAMESPACE = "http://schemas.microsoft.com/office/word/2018/wordml/cex";
+/**
+ * @private
+ */
+export declare const COMMENTS_EXTENDED_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml";
+/**
+ * @private
+ */
+export declare const PEOPLE_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.people+xml";
+/**
+ * @private
+ */
+export declare const COMMENTS_IDS_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsIds+xml";
+/**
+ * @private
+ */
+export declare const COMMENTS_EXTENSIBLE_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtensible+xml";
+/**
+ * One `w15:commentEx` row from `commentsExtended` (`[MS-DOCX]` CT_CommentEx).
+ *
+ * @private
+ */
+export interface CommentExEntry {
+    /** `commentEx/@paraId` — last body paragraph paraId of the associated comment. */
+    readonly paraId: string;
+    /** `commentEx/@paraIdParent` — last body paragraph paraId of the parent comment, when a reply. */
+    readonly paraIdParent: string | undefined;
+    /**
+     * `commentEx/@done` when present.
+     * `false` only when the attribute is `"0"` (DocIO-aligned); otherwise `true` when present.
+     */
+    readonly done: boolean | undefined;
+}
+interface ExtensionPartState {
+    readonly extendedEntryCount: number;
+    readonly extendedEntries: ReadonlyArray<CommentExEntry>;
+    readonly peopleCount: number;
+    readonly peopleAuthors: ReadonlyArray<string>;
+    readonly idsEntryCount: number;
+    readonly extensibleEntryCount: number;
+}
+/**
+ * @private
+ */
+export interface ExtensionMetadata {
+    readonly extended: ExtensionPartState | undefined;
+    readonly people: ExtensionPartState | undefined;
+    readonly ids: ExtensionPartState | undefined;
+    readonly extensible: ExtensionPartState | undefined;
+}
+export declare const EMPTY_EXTENSION_METADATA: ExtensionMetadata;
+/**
+ * @private
+ */
+export declare function loadCommentExtensionMetadata(pkg: OpcPackage, mainPartName: PartName): ExtensionMetadata;
+/**
+ * MS-DOCX comment extension parts linked from the Main Document.
+ *
+ * @private
+ */
+export declare class CommentExtensionParts {
+    private readonly metadata;
+    /**
+     * @private
+     */
+    constructor(metadata: ExtensionMetadata);
+    /**
+     * Whether a `commentsExtended` part (`commentsEx` root) was found.
+     *
+     * @private
+     */
+    extendedPresent(): boolean;
+    /**
+     * Count of `commentEx` entries under `commentsEx`.
+     *
+     * @private
+     */
+    extendedEntryCount(): number;
+    /**
+     * Parsed `commentEx` rows with a non-empty `paraId` (order preserved).
+     *
+     * @private
+     */
+    extendedEntries(): ReadonlyArray<CommentExEntry>;
+    /**
+     * Whether a `people` part was found.
+     *
+     * @private
+     */
+    peoplePresent(): boolean;
+    /**
+     * Count of `person` entries under `people`.
+     *
+     * @private
+     */
+    peopleCount(): number;
+    /**
+     * `person/@author` values in document order.
+     *
+     * @private
+     */
+    peopleAuthors(): ReadonlyArray<string>;
+    /**
+     * Whether a `commentsIds` part was found.
+     *
+     * @private
+     */
+    idsPresent(): boolean;
+    /**
+     * Count of `commentId` entries under `commentsIds`.
+     *
+     * @private
+     */
+    idsEntryCount(): number;
+    /**
+     * Whether a `commentsExtensible` part was found.
+     *
+     * @private
+     */
+    extensiblePresent(): boolean;
+    /**
+     * Count of `commentExtensible` entries under `commentsExtensible`.
+     *
+     * @private
+     */
+    extensibleEntryCount(): number;
+}
+export {};

package/src/features/comments/comment-extensions.js

@@ -0,0 +1,356 @@
+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);
+};
+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 { partByName, relationshipsForPart } from '../../core/opc/package';
+import { resolveInternalTarget } from '../../core/opc/part-name';
+import { TargetMode } from '../../core/opc/relationships';
+import { parseXml } from '../../core/xml/index';
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.2 commentsExtended relationship. */
+export var COMMENTS_EXTENDED_RELATIONSHIP_TYPE = 'http://schemas.microsoft.com/office/2011/relationships/commentsExtended';
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.3 people relationship. */
+export var PEOPLE_RELATIONSHIP_TYPE = 'http://schemas.microsoft.com/office/2011/relationships/people';
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.4 commentsIds relationship. */
+export var COMMENTS_IDS_RELATIONSHIP_TYPE = 'http://schemas.microsoft.com/office/2016/09/relationships/commentsIds';
+/**
+ * @private
+ * `[MS-DOCX]` §2.1.5 commentsExtensible relationship. */
+export var COMMENTS_EXTENSIBLE_RELATIONSHIP_TYPE = 'http://schemas.microsoft.com/office/2018/08/relationships/commentsExtensible';
+/**
+ * @private
+ * `[MS-DOCX]` §2.5.1.5 commentsExtended root namespace. */
+export var COMMENTS_EXTENDED_NAMESPACE = 'http://schemas.microsoft.com/office/word/2012/wordml';
+/**
+ * @private
+ * `[MS-DOCX]` §2.8 commentsIds root namespace. */
+export var COMMENTS_IDS_NAMESPACE = 'http://schemas.microsoft.com/office/word/2016/wordml/cid';
+/**
+ * @private
+ * `[MS-DOCX]` §2.10 commentsExtensible root namespace. */
+export var COMMENTS_EXTENSIBLE_NAMESPACE = 'http://schemas.microsoft.com/office/word/2018/wordml/cex';
+/**
+ * @private
+ */
+export var COMMENTS_EXTENDED_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml';
+/**
+ * @private
+ */
+export var PEOPLE_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.people+xml';
+/**
+ * @private
+ */
+export var COMMENTS_IDS_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.commentsIds+xml';
+/**
+ * @private
+ */
+export var COMMENTS_EXTENSIBLE_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtensible+xml';
+var utf8Decoder = new TextDecoder('utf-8');
+var EMPTY_PART_COUNTS = {
+    extendedEntryCount: 0,
+    extendedEntries: [],
+    peopleCount: 0,
+    peopleAuthors: [],
+    idsEntryCount: 0,
+    extensibleEntryCount: 0,
+};
+export var EMPTY_EXTENSION_METADATA = {
+    extended: undefined,
+    people: undefined,
+    ids: undefined,
+    extensible: undefined,
+};
+function isNamespace(element, namespaceUri, localName) {
+    return element.namespaceUri === namespaceUri && element.localName === localName;
+}
+function childElements(element) {
+    return element.children.filter(function (child) { return child.kind === 'element'; });
+}
+function namespacedAttribute(element, namespaceUri, localName) {
+    var found = element.attributes.find(function (attribute) { return attribute.localName === localName &&
+        (attribute.namespaceUri === namespaceUri || attribute.namespaceUri === ''); });
+    return found == null ? undefined : found.value;
+}
+/**
+ * DocIO-aligned `done` parse: attribute absent → `undefined`; `"0"` → `false`; any other value → `true`.
+ */
+function parseCommentExDone(raw) {
+    if (raw === undefined) {
+        return undefined;
+    }
+    return raw !== '0';
+}
+function parseCommentExEntries(root) {
+    var e_1, _a;
+    var count = 0;
+    var entries = [];
+    try {
+        for (var _b = __values(childElements(root)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            if (!isNamespace(child, COMMENTS_EXTENDED_NAMESPACE, 'commentEx')) {
+                continue;
+            }
+            count += 1;
+            var paraId = namespacedAttribute(child, COMMENTS_EXTENDED_NAMESPACE, 'paraId');
+            if (paraId === undefined || paraId.length === 0) {
+                continue;
+            }
+            var paraIdParent = namespacedAttribute(child, COMMENTS_EXTENDED_NAMESPACE, 'paraIdParent');
+            entries.push({
+                paraId: paraId,
+                paraIdParent: paraIdParent !== undefined && paraIdParent.length > 0 ? paraIdParent : undefined,
+                done: parseCommentExDone(namespacedAttribute(child, COMMENTS_EXTENDED_NAMESPACE, 'done')),
+            });
+        }
+    }
+    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; }
+    }
+    return { count: count, entries: entries };
+}
+function parseExtensionPartMetadata(bytes) {
+    var e_2, _a, e_3, _b, e_4, _c;
+    if (bytes.byteLength === 0) {
+        return undefined;
+    }
+    try {
+        var root = parseXml(utf8Decoder.decode(bytes));
+        if (isNamespace(root, COMMENTS_EXTENDED_NAMESPACE, 'commentsEx')) {
+            var parsed = parseCommentExEntries(root);
+            return __assign({}, EMPTY_PART_COUNTS, { extendedEntryCount: parsed.count, extendedEntries: parsed.entries });
+        }
+        if (isNamespace(root, COMMENTS_EXTENDED_NAMESPACE, 'people')) {
+            var authors = [];
+            var count = 0;
+            try {
+                for (var _d = __values(childElements(root)), _e = _d.next(); !_e.done; _e = _d.next()) {
+                    var child = _e.value;
+                    if (!isNamespace(child, COMMENTS_EXTENDED_NAMESPACE, 'person')) {
+                        continue;
+                    }
+                    count += 1;
+                    var author = namespacedAttribute(child, COMMENTS_EXTENDED_NAMESPACE, 'author');
+                    if (author !== undefined && author.length > 0) {
+                        authors.push(author);
+                    }
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_e && !_e.done && (_a = _d.return)) _a.call(_d);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+            return __assign({}, EMPTY_PART_COUNTS, { peopleCount: count, peopleAuthors: authors });
+        }
+        if (isNamespace(root, COMMENTS_IDS_NAMESPACE, 'commentsIds')) {
+            var count = 0;
+            try {
+                for (var _f = __values(childElements(root)), _g = _f.next(); !_g.done; _g = _f.next()) {
+                    var child = _g.value;
+                    if (isNamespace(child, COMMENTS_IDS_NAMESPACE, 'commentId')) {
+                        count += 1;
+                    }
+                }
+            }
+            catch (e_3_1) { e_3 = { error: e_3_1 }; }
+            finally {
+                try {
+                    if (_g && !_g.done && (_b = _f.return)) _b.call(_f);
+                }
+                finally { if (e_3) throw e_3.error; }
+            }
+            return __assign({}, EMPTY_PART_COUNTS, { idsEntryCount: count });
+        }
+        if (isNamespace(root, COMMENTS_EXTENSIBLE_NAMESPACE, 'commentsExtensible')) {
+            var count = 0;
+            try {
+                for (var _h = __values(childElements(root)), _j = _h.next(); !_j.done; _j = _h.next()) {
+                    var child = _j.value;
+                    if (isNamespace(child, COMMENTS_EXTENSIBLE_NAMESPACE, 'commentExtensible')) {
+                        count += 1;
+                    }
+                }
+            }
+            catch (e_4_1) { e_4 = { error: e_4_1 }; }
+            finally {
+                try {
+                    if (_j && !_j.done && (_c = _h.return)) _c.call(_h);
+                }
+                finally { if (e_4) throw e_4.error; }
+            }
+            return __assign({}, EMPTY_PART_COUNTS, { extensibleEntryCount: count });
+        }
+    }
+    catch (_k) {
+        return __assign({}, EMPTY_PART_COUNTS);
+    }
+    return undefined;
+}
+function firstRelatedPartBytes(pkg, source, relationshipType) {
+    var e_5, _a;
+    try {
+        for (var _b = __values(relationshipsForPart(pkg, source).items), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var rel = _c.value;
+            if (rel.type !== relationshipType || rel.targetMode === TargetMode.External) {
+                continue;
+            }
+            var target = resolveInternalTarget(rel.target, source);
+            var part = partByName(pkg, target);
+            if (part !== undefined) {
+                return part.data;
+            }
+        }
+    }
+    catch (e_5_1) { e_5 = { error: e_5_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_5) throw e_5.error; }
+    }
+    return undefined;
+}
+/**
+ * @private
+ */
+export function loadCommentExtensionMetadata(pkg, mainPartName) {
+    var extendedBytes = firstRelatedPartBytes(pkg, mainPartName, COMMENTS_EXTENDED_RELATIONSHIP_TYPE);
+    var peopleBytes = firstRelatedPartBytes(pkg, mainPartName, PEOPLE_RELATIONSHIP_TYPE);
+    var idsBytes = firstRelatedPartBytes(pkg, mainPartName, COMMENTS_IDS_RELATIONSHIP_TYPE);
+    var extensibleBytes = firstRelatedPartBytes(pkg, mainPartName, COMMENTS_EXTENSIBLE_RELATIONSHIP_TYPE);
+    return {
+        extended: extendedBytes === undefined ? undefined : parseExtensionPartMetadata(extendedBytes),
+        people: peopleBytes === undefined ? undefined : parseExtensionPartMetadata(peopleBytes),
+        ids: idsBytes === undefined ? undefined : parseExtensionPartMetadata(idsBytes),
+        extensible: extensibleBytes === undefined ? undefined : parseExtensionPartMetadata(extensibleBytes),
+    };
+}
+/**
+ * MS-DOCX comment extension parts linked from the Main Document.
+ *
+ * @private
+ */
+var CommentExtensionParts = /** @class */ (function () {
+    /**
+     * @private
+     */
+    function CommentExtensionParts(metadata) {
+        this.metadata = metadata;
+    }
+    /**
+     * Whether a `commentsExtended` part (`commentsEx` root) was found.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.extendedPresent = function () {
+        return this.metadata.extended !== undefined;
+    };
+    /**
+     * Count of `commentEx` entries under `commentsEx`.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.extendedEntryCount = function () {
+        var __ts33_0;
+        return ((__ts33_0 = this.metadata.extended == null ? undefined : this.metadata.extended.extendedEntryCount), __ts33_0 != null ? __ts33_0 : 0);
+    };
+    /**
+     * Parsed `commentEx` rows with a non-empty `paraId` (order preserved).
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.extendedEntries = function () {
+        var __ts33_1;
+        return ((__ts33_1 = this.metadata.extended == null ? undefined : this.metadata.extended.extendedEntries), __ts33_1 != null ? __ts33_1 : []);
+    };
+    /**
+     * Whether a `people` part was found.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.peoplePresent = function () {
+        return this.metadata.people !== undefined;
+    };
+    /**
+     * Count of `person` entries under `people`.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.peopleCount = function () {
+        var __ts33_2;
+        return ((__ts33_2 = this.metadata.people == null ? undefined : this.metadata.people.peopleCount), __ts33_2 != null ? __ts33_2 : 0);
+    };
+    /**
+     * `person/@author` values in document order.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.peopleAuthors = function () {
+        var __ts33_3;
+        return ((__ts33_3 = this.metadata.people == null ? undefined : this.metadata.people.peopleAuthors), __ts33_3 != null ? __ts33_3 : []);
+    };
+    /**
+     * Whether a `commentsIds` part was found.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.idsPresent = function () {
+        return this.metadata.ids !== undefined;
+    };
+    /**
+     * Count of `commentId` entries under `commentsIds`.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.idsEntryCount = function () {
+        var __ts33_4;
+        return ((__ts33_4 = this.metadata.ids == null ? undefined : this.metadata.ids.idsEntryCount), __ts33_4 != null ? __ts33_4 : 0);
+    };
+    /**
+     * Whether a `commentsExtensible` part was found.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.extensiblePresent = function () {
+        return this.metadata.extensible !== undefined;
+    };
+    /**
+     * Count of `commentExtensible` entries under `commentsExtensible`.
+     *
+     * @private
+     */
+    CommentExtensionParts.prototype.extensibleEntryCount = function () {
+        var __ts33_5;
+        return ((__ts33_5 = this.metadata.extensible == null ? undefined : this.metadata.extensible.extensibleEntryCount), __ts33_5 != null ? __ts33_5 : 0);
+    };
+    return CommentExtensionParts;
+}());
+export { CommentExtensionParts };