@microsoft/connected-workbooks 3.3.1-beta → 3.4.0-beta

package/dist/utils/xmlInnerPartsUtils.js

@@ -45,6 +45,23 @@ var types_1 = require("../types");
 var constants_1 = require("./constants");
 var documentUtils_1 = __importDefault(require("./documentUtils"));
 var xmldom_qsa_1 = require("xmldom-qsa");
+/**
+ * Helper function to check for XML parser errors without using querySelector
+ * @param doc - The parsed XML document
+ * @param context - Context string for error message
+ * @throws {Error} If parser error is detected
+ */
+var checkParserError = function (doc, context) {
+    if (!doc || !doc.documentElement) {
+        throw new Error("".concat(context, ": ").concat(constants_1.Errors.xmlParse));
+    }
+    // Check for parsererror elements using getElementsByTagName
+    var errorElements = doc.getElementsByTagName("parsererror");
+    if (errorElements && errorElements.length > 0) {
+        var errorText = errorElements[0].textContent || "Unknown parser error";
+        throw new Error("".concat(context, ": ").concat(errorText));
+    }
+};
 var updateDocProps = function (zip, docProps) {
     if (docProps === void 0) { docProps = {}; }
     return __awaiter(void 0, void 0, void 0, function () {
@@ -76,33 +93,61 @@ var updateDocProps = function (zip, docProps) {
         });
     });
 };
+var removeLabelInfoRelationship = function (doc, relationships) {
+    // Find and remove LabelInfo.xml relationship
+    var relationshipElements = doc.getElementsByTagName(constants_1.element.relationship);
+    for (var i = 0; i < relationshipElements.length; i++) {
+        var rel = relationshipElements[i];
+        if (rel.getAttribute(constants_1.elementAttributes.target) === constants_1.labelInfoXmlPath) {
+            relationships.removeChild(rel);
+            break;
+        }
+    }
+};
+var updateRelationshipIds = function (doc) {
+    // Update relationship IDs
+    var relationshipElements = doc.getElementsByTagName(constants_1.element.relationship);
+    for (var i = 0; i < relationshipElements.length; i++) {
+        var rel = relationshipElements[i];
+        var target = rel.getAttribute(constants_1.elementAttributes.target);
+        if (target === constants_1.workbookXmlPath) {
+            rel.setAttribute(constants_1.elementAttributes.Id, constants_1.elementAttributes.relationId1);
+        }
+        else if (target === constants_1.docPropsCoreXmlPath) {
+            rel.setAttribute(constants_1.elementAttributes.Id, constants_1.elementAttributes.relationId2);
+        }
+        else if (target === constants_1.docPropsAppXmlPath) {
+            rel.setAttribute(constants_1.elementAttributes.Id, constants_1.elementAttributes.relationId3);
+        }
+    }
+};
 var clearLabelInfo = function (zip) { return __awaiter(void 0, void 0, void 0, function () {
-    var relsString, parser, doc, relationships, element, serializer, newDoc;
-    var _a, _b, _c, _d;
-    return __generator(this, function (_e) {
-        switch (_e.label) {
+    var relsString, parser, doc, relationshipsList, relationships, serializer, newDoc;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
             case 0:
                 // remove docMetadata folder that contains only LabelInfo.xml in template file.
                 zip.remove(constants_1.docMetadataXmlPath);
                 return [4 /*yield*/, ((_a = zip.file(constants_1.relsXmlPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType))];
             case 1:
-                relsString = _e.sent();
+                relsString = _b.sent();
                 if (relsString === undefined) {
-                    throw new Error(constants_1.relsNotFoundErr);
+                    throw new Error(constants_1.Errors.relsNotFound);
                 }
                 parser = new xmldom_qsa_1.DOMParser();
                 doc = parser.parseFromString(relsString, constants_1.xmlTextResultType);
-                relationships = doc.querySelector("Relationships");
-                if (relationships === null) {
-                    throw new Error(constants_1.unexpectedErr);
+                checkParserError(doc, constants_1.Errors.relsParse);
+                relationshipsList = doc.getElementsByTagName(constants_1.element.relationships);
+                if (!relationshipsList || relationshipsList.length === 0) {
+                    throw new Error(constants_1.Errors.relationship);
                 }
-                element = relationships.querySelector('Relationship[Target="docMetadata/LabelInfo.xml"]');
-                if (element) {
-                    relationships.removeChild(element);
+                relationships = relationshipsList[0];
+                if (!relationships) {
+                    throw new Error(constants_1.Errors.relationship);
                 }
-                (_b = relationships.querySelector('Relationship[Target="xl/workbook.xml"]')) === null || _b === void 0 ? void 0 : _b.setAttribute("Id", "rId1");
-                (_c = relationships.querySelector('Relationship[Target="docProps/core.xml"]')) === null || _c === void 0 ? void 0 : _c.setAttribute("Id", "rId2");
-                (_d = relationships.querySelector('Relationship[Target="docProps/app.xml"]')) === null || _d === void 0 ? void 0 : _d.setAttribute("Id", "rId3");
+                removeLabelInfoRelationship(doc, relationships);
+                updateRelationshipIds(doc);
                 serializer = new xmldom_qsa_1.XMLSerializer();
                 newDoc = serializer.serializeToString(doc);
                 zip.file(constants_1.relsXmlPath, newDoc);
@@ -116,6 +161,7 @@ var updateConnections = function (connectionsXmlString, queryName, refreshOnOpen
     var serializer = new xmldom_qsa_1.XMLSerializer();
     var refreshOnLoadValue = refreshOnOpen ? constants_1.trueValue : constants_1.falseValue;
     var connectionsDoc = parser.parseFromString(connectionsXmlString, constants_1.xmlTextResultType);
+    checkParserError(connectionsDoc, constants_1.Errors.connectionsParse);
     var connectionsProperties = connectionsDoc.getElementsByTagName(constants_1.element.databaseProperties);
     var dbPr = connectionsProperties[0];
     dbPr.setAttribute(constants_1.elementAttributes.refreshOnLoad, refreshOnLoadValue);
@@ -127,7 +173,7 @@ var updateConnections = function (connectionsXmlString, queryName, refreshOnOpen
     var connectionId = (_c = dbPr.parentNode) === null || _c === void 0 ? void 0 : _c.getAttribute(constants_1.elementAttributes.id);
     var connectionXmlFileString = serializer.serializeToString(connectionsDoc);
     if (connectionId === null) {
-        throw new Error(constants_1.connectionsNotFoundErr);
+        throw new Error(constants_1.Errors.connectionsNotFound);
     }
     return { connectionId: connectionId, connectionXmlFileString: connectionXmlFileString };
 };
@@ -135,9 +181,10 @@ var updateSharedStrings = function (sharedStringsXmlString, queryName) {
     var parser = new xmldom_qsa_1.DOMParser();
     var serializer = new xmldom_qsa_1.XMLSerializer();
     var sharedStringsDoc = parser.parseFromString(sharedStringsXmlString, constants_1.xmlTextResultType);
+    checkParserError(sharedStringsDoc, constants_1.Errors.sharedStringsParse);
     var sharedStringsTable = sharedStringsDoc.getElementsByTagName(constants_1.element.sharedStringTable)[0];
     if (!sharedStringsTable) {
-        throw new Error(constants_1.sharedStringsNotFoundErr);
+        throw new Error(constants_1.Errors.sharedStringsNotFound);
     }
     var textElementCollection = sharedStringsDoc.getElementsByTagName(constants_1.element.text);
     var textElement = null;
@@ -175,6 +222,7 @@ var updateWorksheet = function (sheetsXmlString, sharedStringIndex) {
     var parser = new xmldom_qsa_1.DOMParser();
     var serializer = new xmldom_qsa_1.XMLSerializer();
     var sheetsDoc = parser.parseFromString(sheetsXmlString, constants_1.xmlTextResultType);
+    checkParserError(sheetsDoc, constants_1.Errors.worksheetParse);
     sheetsDoc.getElementsByTagName(constants_1.element.cellValue)[0].innerHTML = sharedStringIndex.toString();
     var newSheet = serializer.serializeToString(sheetsDoc);
     return newSheet;
@@ -240,7 +288,7 @@ var updatePivotTablesandQueryTables = function (zip, queryName, refreshOnOpen, c
                     }
                 });
                 if (!found) {
-                    throw new Error(constants_1.queryAndPivotTableNotFoundErr);
+                    throw new Error(constants_1.Errors.queryAndPivotTableNotFound);
                 }
                 return [2 /*return*/];
         }
@@ -252,6 +300,7 @@ var updateQueryTable = function (tableXmlString, connectionId, refreshOnOpen) {
     var parser = new xmldom_qsa_1.DOMParser();
     var serializer = new xmldom_qsa_1.XMLSerializer();
     var queryTableDoc = parser.parseFromString(tableXmlString, constants_1.xmlTextResultType);
+    checkParserError(queryTableDoc, constants_1.Errors.queryTableParse);
     var queryTable = queryTableDoc.getElementsByTagName(constants_1.element.queryTable)[0];
     var newQueryTable = constants_1.emptyValue;
     if (queryTable.getAttribute(constants_1.elementAttributes.connectionId) == connectionId) {
@@ -267,6 +316,7 @@ var updatePivotTable = function (tableXmlString, connectionId, refreshOnOpen) {
     var parser = new xmldom_qsa_1.DOMParser();
     var serializer = new xmldom_qsa_1.XMLSerializer();
     var pivotCacheDoc = parser.parseFromString(tableXmlString, constants_1.xmlTextResultType);
+    checkParserError(pivotCacheDoc, constants_1.Errors.pivotTableParse);
     var cacheSource = pivotCacheDoc.getElementsByTagName(constants_1.element.cacheSource)[0];
     var newPivotTable = constants_1.emptyValue;
     if (cacheSource.getAttribute(constants_1.elementAttributes.connectionId) == connectionId) {
@@ -282,25 +332,30 @@ var updatePivotTable = function (tableXmlString, connectionId, refreshOnOpen) {
  */
 function getSheetPathFromXlRelId(zip, rId) {
     return __awaiter(this, void 0, void 0, function () {
-        var relsFile, relsString, relsDoc, relationship, target;
+        var relsFile, relsString, relsDoc, relationships, target, i, el;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     relsFile = zip.file(constants_1.workbookRelsXmlPath);
                     if (!relsFile) {
-                        throw new Error(constants_1.xlRelsNotFoundErr);
+                        throw new Error(constants_1.Errors.xlRelsNotFound);
                     }
                     return [4 /*yield*/, relsFile.async(constants_1.textResultType)];
                 case 1:
                     relsString = _a.sent();
                     relsDoc = new xmldom_qsa_1.DOMParser().parseFromString(relsString, constants_1.xmlTextResultType);
-                    relationship = relsDoc.querySelector("Relationship[Id=\"".concat(rId, "\"]"));
-                    if (!relationship) {
-                        throw new Error("Relationship not found for Id: ".concat(rId));
+                    checkParserError(relsDoc, constants_1.Errors.workbookRelsParse);
+                    relationships = relsDoc.getElementsByTagName("Relationship");
+                    target = null;
+                    for (i = 0; i < relationships.length; i++) {
+                        el = relationships[i];
+                        if (el && el.getAttribute && el.getAttribute("Id") === rId) {
+                            target = el.getAttribute(constants_1.elementAttributes.target);
+                            break;
+                        }
                     }
-                    target = relationship.getAttribute(constants_1.elementAttributes.target);
                     if (!target) {
-                        throw new Error("Target not found for Relationship Id: ".concat(rId));
+                        throw new Error("Relationship not found or missing Target for Id: ".concat(rId));
                     }
                     return [2 /*return*/, target];
             }
@@ -317,10 +372,11 @@ var getSheetPathByNameFromZip = function (zip, sheetName) { return __awaiter(voi
             case 1:
                 workbookXmlString = _b.sent();
                 if (!workbookXmlString) {
-                    throw new Error(constants_1.WorkbookNotFoundERR);
+                    throw new Error(constants_1.Errors.workbookNotFound);
                 }
                 parser = new xmldom_qsa_1.DOMParser();
                 doc = parser.parseFromString(workbookXmlString, constants_1.xmlTextResultType);
+                checkParserError(doc, constants_1.Errors.workbookParse);
                 sheetElements = doc.getElementsByTagName(constants_1.element.sheet);
                 for (i = 0; i < sheetElements.length; i++) {
                     if (sheetElements[i].getAttribute(constants_1.elementAttributes.name) === sheetName) {
@@ -344,14 +400,15 @@ var getReferenceFromTable = function (zip, tablePath) { return __awaiter(void 0,
             case 1:
                 tableXmlString = _c.sent();
                 if (!tableXmlString) {
-                    throw new Error(constants_1.WorkbookNotFoundERR);
+                    throw new Error(constants_1.Errors.workbookNotFound);
                 }
                 parser = new xmldom_qsa_1.DOMParser();
                 doc = parser.parseFromString(tableXmlString, constants_1.xmlTextResultType);
+                checkParserError(doc, constants_1.Errors.tableParse);
                 tableElements = doc.getElementsByTagName(constants_1.element.table);
                 reference = (_b = tableElements[0]) === null || _b === void 0 ? void 0 : _b.getAttribute(constants_1.elementAttributes.reference);
                 if (!reference) {
-                    throw new Error(constants_1.tableReferenceNotFoundErr);
+                    throw new Error(constants_1.Errors.tableReferenceNotFound);
                 }
                 return [2 /*return*/, reference.split(":")[0]]; // Return the start cell reference (e.g., "A1" from "A1:B10")
         }
@@ -362,9 +419,9 @@ var findTablePathFromZip = function (zip, targetTableName) { return __awaiter(vo
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
-                tablesFolder = zip.folder("xl/tables");
+                tablesFolder = zip.folder(constants_1.tablesFolderPath);
                 if (!tablesFolder)
-                    return [2 /*return*/, ""];
+                    return [2 /*return*/, constants_1.emptyValue];
                 tableFilePromises = [];
                 tablesFolder.forEach(function (relativePath, file) {
                     tableFilePromises.push(file.async(constants_1.textResultType).then(function (content) { return ({ path: relativePath, content: content }); }));
@@ -376,15 +433,216 @@ var findTablePathFromZip = function (zip, targetTableName) { return __awaiter(vo
                 for (_i = 0, tableFiles_1 = tableFiles; _i < tableFiles_1.length; _i++) {
                     _a = tableFiles_1[_i], path = _a.path, content = _a.content;
                     doc = parser.parseFromString(content, constants_1.xmlTextResultType);
+                    checkParserError(doc, "".concat(constants_1.Errors.tablePathParse, " ").concat(path));
                     tableElem = doc.getElementsByTagName(constants_1.element.table)[0];
                     if (tableElem && tableElem.getAttribute(constants_1.elementAttributes.name) === targetTableName) {
                         return [2 /*return*/, path];
                     }
                 }
-                throw new Error(constants_1.tableNotFoundErr);
+                throw new Error(constants_1.Errors.tableNotFound);
+        }
+    });
+}); };
+/**
+ * Determines the next available item number for a custom XML item in the Excel workbook.
+ * Scans the customXml folder to find existing item files and returns the next sequential number.
+ *
+ * @param zip - The JSZip instance containing the Excel workbook structure
+ * @returns Promise resolving to the next available item number (starting from 1 if no items exist)
+ *
+ * @example
+ * // If customXml folder contains item1.xml, item2.xml, returns 3
+ * const nextNumber = await getCustomXmlItemNumber(zip);
+ */
+var getCustomXmlItemNumber = function (zip) { return __awaiter(void 0, void 0, void 0, function () {
+    var customXmlFolder, re, matches, max, _i, matches_1, f, m, n;
+    return __generator(this, function (_a) {
+        customXmlFolder = zip.folder(constants_1.customXmlXmlPath);
+        if (!customXmlFolder) {
+            return [2 /*return*/, 1]; // start from 1 if folder doesn't exist
+        }
+        re = new RegExp("^".concat(constants_1.customXmlXmlPath, "/").concat(constants_1.customXML.itemNumberPattern.source, "$"));
+        matches = zip.file(re);
+        max = 0;
+        // Iterate through all matching files to find the highest item number
+        for (_i = 0, matches_1 = matches; _i < matches_1.length; _i++) {
+            f = matches_1[_i];
+            m = f.name.match(constants_1.customXML.itemNumberPattern);
+            if (m) {
+                n = parseInt(m[1], 10);
+                if (!Number.isNaN(n) && n > max) {
+                    max = n;
+                }
+            }
+        }
+        return [2 /*return*/, max + 1]; // Return next available number
+    });
+}); };
+/**
+ * Checks if a custom XML item with connected-workbooks already exists in the Excel workbook.
+ * Searches through all custom XML files in the customXml folder to find a match with the expected content.
+ *
+ * @param zip - The JSZip instance containing the Excel workbook structure
+ * @returns Promise resolving to true if the custom XML item exists, false otherwise
+ *
+ * @example
+ * const exists = await isCustomXmlExists(zip);
+ * if (!exists) {
+ *   // Add new custom XML item
+ * }
+ */
+var isCustomXmlExists = function (zip) { return __awaiter(void 0, void 0, void 0, function () {
+    var customXmlFolder, customXmlFiles, _i, customXmlFiles_1, file, content, error_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                customXmlFolder = zip.folder(constants_1.customXmlXmlPath);
+                if (!customXmlFolder) {
+                    return [2 /*return*/, false]; // customXml folder does not exist
+                }
+                customXmlFiles = customXmlFolder.file(constants_1.customXML.itemFilePattern);
+                _i = 0, customXmlFiles_1 = customXmlFiles;
+                _a.label = 1;
+            case 1:
+                if (!(_i < customXmlFiles_1.length)) return [3 /*break*/, 6];
+                file = customXmlFiles_1[_i];
+                _a.label = 2;
+            case 2:
+                _a.trys.push([2, 4, , 5]);
+                return [4 /*yield*/, file.async(constants_1.textResultType)];
+            case 3:
+                content = _a.sent();
+                if (content.includes(constants_1.customXML.connectedWorkbookTag)) {
+                    return [2 /*return*/, true]; // Found matching custom XML item
+                }
+                return [3 /*break*/, 5];
+            case 4:
+                error_1 = _a.sent();
+                // Skip files that can't be read and continue with the next file
+                return [3 /*break*/, 5];
+            case 5:
+                _i++;
+                return [3 /*break*/, 1];
+            case 6: return [2 /*return*/, false]; // No matching custom XML item found
         }
     });
 }); };
+/**
+ * Adds a content type override entry to the [Content_Types].xml file for a custom XML item.
+ * This registration is required for Excel to recognize and process the custom XML item.
+ *
+ * @param zip - The JSZip instance containing the Excel workbook structure
+ * @param itemIndex - The index/number of the custom XML item to register
+ * @throws {Error} When the [Content_Types].xml file is not found or cannot be parsed
+ *
+ * @example
+ * await addToContentType(zip, "1"); // Registers customXml/item1.xml in content types
+ */
+var addToContentType = function (zip, itemIndex) { return __awaiter(void 0, void 0, void 0, function () {
+    var contentTypesXmlString, parser, doc, partName, contentTypeValue, typesElement, ns, overrideEl, serializer, newDoc;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, ((_a = zip.file(constants_1.contentTypesXmlPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType))];
+            case 1:
+                contentTypesXmlString = _b.sent();
+                if (!contentTypesXmlString) {
+                    throw new Error(constants_1.Errors.contentTypesNotFound);
+                }
+                parser = new xmldom_qsa_1.DOMParser();
+                doc = parser.parseFromString(contentTypesXmlString, constants_1.xmlTextResultType);
+                checkParserError(doc, constants_1.Errors.contentTypesParse);
+                partName = constants_1.customXML.itemPropsPartNameTemplate(itemIndex);
+                contentTypeValue = constants_1.customXML.contentType;
+                typesElement = doc.documentElement;
+                if (!typesElement) {
+                    throw new Error(constants_1.Errors.contentTypesElementNotFound);
+                }
+                ns = doc.documentElement.namespaceURI;
+                overrideEl = ns ? doc.createElementNS(ns, constants_1.element.override) : doc.createElement(constants_1.element.override);
+                overrideEl.setAttribute(constants_1.elementAttributes.partName, partName);
+                overrideEl.setAttribute(constants_1.elementAttributes.contentType, contentTypeValue);
+                typesElement.appendChild(overrideEl);
+                serializer = new xmldom_qsa_1.XMLSerializer();
+                newDoc = serializer.serializeToString(doc);
+                zip.file(constants_1.contentTypesXmlPath, newDoc);
+                return [2 /*return*/];
+        }
+    });
+}); };
+/**
+ * Adds a relationship entry to the workbook relationships file for a custom XML item.
+ * Creates a new relationship that links the workbook to the custom XML item.
+ *
+ * @param zip - The JSZip instance containing the Excel workbook structure
+ * @param itemIndex - The index/number of the custom XML item to create a relationship for
+ * @throws {Error} When the workbook relationships file is not found or cannot be parsed
+ *
+ * @example
+ * await addCustomXmlToRels(zip, "1"); // Creates relationship to customXml/item1.xml
+ */
+var addCustomXmlToRels = function (zip, itemIndex) { return __awaiter(void 0, void 0, void 0, function () {
+    var relsXmlString, parser, doc, relationshipsElements, relationshipsElement, highestRid, newRid, target, type, ns, relationshipEl, serializer, newDoc;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, ((_a = zip.file(constants_1.workbookRelsXmlPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType))];
+            case 1:
+                relsXmlString = _b.sent();
+                if (!relsXmlString) {
+                    throw new Error(constants_1.Errors.relsNotFound);
+                }
+                parser = new xmldom_qsa_1.DOMParser();
+                doc = parser.parseFromString(relsXmlString, constants_1.xmlTextResultType);
+                checkParserError(doc, constants_1.Errors.workbookRelsParse);
+                relationshipsElements = doc.getElementsByTagName(constants_1.element.relationships);
+                if (!relationshipsElements || relationshipsElements.length === 0) {
+                    throw new Error(constants_1.Errors.relationship);
+                }
+                relationshipsElement = relationshipsElements[0];
+                highestRid = getHighestRelationshipId(relationshipsElement);
+                newRid = "".concat(constants_1.elementAttributes.relationshipIdPrefix).concat(highestRid + 1);
+                target = constants_1.customXML.relativeItemPathTemplate(itemIndex);
+                type = constants_1.customXML.relationshipType;
+                ns = doc.documentElement.namespaceURI;
+                relationshipEl = ns ? doc.createElementNS(ns, constants_1.element.relationship) : doc.createElement(constants_1.element.relationship);
+                relationshipEl.setAttribute(constants_1.elementAttributes.Id, newRid);
+                relationshipEl.setAttribute(constants_1.elementAttributes.type, type);
+                relationshipEl.setAttribute(constants_1.elementAttributes.target, target);
+                relationshipsElement.appendChild(relationshipEl);
+                serializer = new xmldom_qsa_1.XMLSerializer();
+                newDoc = serializer.serializeToString(doc);
+                zip.file(constants_1.workbookRelsXmlPath, newDoc);
+                return [2 /*return*/];
+        }
+    });
+}); };
+/**
+ * Finds the highest relationship ID number from existing relationships in a relationships element.
+ * Scans all relationship elements and extracts the numeric part from rId attributes.
+ *
+ * @param relationshipsElement - The relationships XML element containing relationship elements
+ * @returns The highest relationship ID number found, or 0 if none exist
+ *
+ * @example
+ * // If relationships contain rId1, rId3, rId7, returns 7
+ * const highestRid = getHighestRelationshipId(relationshipsElement);
+ */
+var getHighestRelationshipId = function (relationshipsElement) {
+    var relationships = relationshipsElement.getElementsByTagName(constants_1.element.relationship);
+    var highestRid = 0;
+    for (var i = 0; i < relationships.length; i++) {
+        var idAttr = relationships[i].getAttribute(constants_1.elementAttributes.Id);
+        if (idAttr && idAttr.startsWith(constants_1.elementAttributes.relationshipIdPrefix)) {
+            // Extract numeric part from rId (e.g., "rId5" -> 5, "rId123" -> 123)
+            var ridNumber = parseInt(idAttr.substring(constants_1.elementAttributes.relationshipIdPrefix.length), 10);
+            if (!isNaN(ridNumber) && ridNumber > highestRid) {
+                highestRid = ridNumber;
+            }
+        }
+    }
+    return highestRid;
+};
 exports.default = {
     updateDocProps: updateDocProps,
     clearLabelInfo: clearLabelInfo,
@@ -397,4 +655,9 @@ exports.default = {
     getSheetPathByNameFromZip: getSheetPathByNameFromZip,
     getReferenceFromTable: getReferenceFromTable,
     findTablePathFromZip: findTablePathFromZip,
+    getCustomXmlItemNumber: getCustomXmlItemNumber,
+    isCustomXmlExists: isCustomXmlExists,
+    addToContentType: addToContentType,
+    addCustomXmlToRels: addCustomXmlToRels,
+    checkParserError: checkParserError,
 };

package/dist/utils/xmlPartsUtils.js

@@ -47,12 +47,78 @@ var pqUtils_1 = __importDefault(require("./pqUtils"));
 var tableUtils_1 = __importDefault(require("./tableUtils"));
 var xmlInnerPartsUtils_1 = __importDefault(require("./xmlInnerPartsUtils"));
 var documentUtils_1 = __importDefault(require("./documentUtils"));
+var addCustomXMLToWorkbook = function (zip) { return __awaiter(void 0, void 0, void 0, function () {
+    var customXmlItemNumber, backupData, contentTypesPath, workbookRelsPath, _a, _b, _c, _d, error_1, _i, _e, _f, filePath, content;
+    var _g, _h;
+    return __generator(this, function (_j) {
+        switch (_j.label) {
+            case 0: return [4 /*yield*/, xmlInnerPartsUtils_1.default.isCustomXmlExists(zip)];
+            case 1:
+                if (_j.sent()) {
+                    return [2 /*return*/, true];
+                }
+                return [4 /*yield*/, xmlInnerPartsUtils_1.default.getCustomXmlItemNumber(zip)];
+            case 2:
+                customXmlItemNumber = _j.sent();
+                backupData = {};
+                contentTypesPath = "[Content_Types].xml";
+                workbookRelsPath = "xl/_rels/workbook.xml.rels";
+                _j.label = 3;
+            case 3:
+                _j.trys.push([3, 8, , 9]);
+                // Backup existing files
+                _a = backupData;
+                _b = contentTypesPath;
+                return [4 /*yield*/, ((_g = zip.file(contentTypesPath)) === null || _g === void 0 ? void 0 : _g.async("text"))];
+            case 4:
+                // Backup existing files
+                _a[_b] = (_j.sent()) || null;
+                _c = backupData;
+                _d = workbookRelsPath;
+                return [4 /*yield*/, ((_h = zip.file(workbookRelsPath)) === null || _h === void 0 ? void 0 : _h.async("text"))];
+            case 5:
+                _c[_d] = (_j.sent()) || null;
+                // Perform modifications
+                return [4 /*yield*/, xmlInnerPartsUtils_1.default.addToContentType(zip, customXmlItemNumber.toString())];
+            case 6:
+                // Perform modifications
+                _j.sent();
+                return [4 /*yield*/, xmlInnerPartsUtils_1.default.addCustomXmlToRels(zip, customXmlItemNumber.toString())];
+            case 7:
+                _j.sent();
+                // Adding the custom XML files
+                zip.file(constants_1.customXML.itemPathTemplate(customXmlItemNumber), constants_1.customXML.customXMLItemContent);
+                zip.file(constants_1.customXML.itemPropsPathTemplate(customXmlItemNumber), constants_1.customXML.customXMLItemPropsContent);
+                zip.file(constants_1.customXML.itemRelsPathTemplate(customXmlItemNumber), constants_1.customXML.customXMLRelationships(customXmlItemNumber));
+                return [3 /*break*/, 9];
+            case 8:
+                error_1 = _j.sent();
+                // Rollback: restore backed up files
+                for (_i = 0, _e = Object.entries(backupData); _i < _e.length; _i++) {
+                    _f = _e[_i], filePath = _f[0], content = _f[1];
+                    if (content !== null) {
+                        zip.file(filePath, content);
+                    }
+                    else {
+                        // If file didn't exist before, remove it
+                        zip.remove(filePath);
+                    }
+                }
+                // Remove any custom XML files that might have been added
+                zip.remove(constants_1.customXML.itemPathTemplate(customXmlItemNumber));
+                zip.remove(constants_1.customXML.itemPropsPathTemplate(customXmlItemNumber));
+                zip.remove(constants_1.customXML.itemRelsPathTemplate(customXmlItemNumber));
+                return [2 /*return*/, false];
+            case 9: return [2 /*return*/, true];
+        }
+    });
+}); };
 var updateWorkbookDataAndConfigurations = function (zip, fileConfigs, tableData, updateQueryTable) {
     if (updateQueryTable === void 0) { updateQueryTable = false; }
     return __awaiter(void 0, void 0, void 0, function () {
-        var sheetName, tablePath, sheetPath, templateSettings, sheetLocation, _a, cellRangeRef;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var sheetName, tablePath, sheetPath, templateSettings, sheetLocation, _a, cellRangeRef, _b, row, column, endColumn, endRow;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
                 case 0:
                     sheetName = constants_1.defaults.sheetName;
                     tablePath = constants_1.tableXmlPath;
@@ -62,41 +128,48 @@ var updateWorkbookDataAndConfigurations = function (zip, fileConfigs, tableData,
                     if (!((templateSettings === null || templateSettings === void 0 ? void 0 : templateSettings.sheetName) !== undefined)) return [3 /*break*/, 2];
                     return [4 /*yield*/, xmlInnerPartsUtils_1.default.getSheetPathByNameFromZip(zip, templateSettings.sheetName)];
                 case 1:
-                    sheetLocation = _b.sent();
+                    sheetLocation = _c.sent();
                     sheetName = templateSettings.sheetName;
                     sheetPath = "xl/" + sheetLocation;
-                    _b.label = 2;
+                    _c.label = 2;
                 case 2:
                     if (!((templateSettings === null || templateSettings === void 0 ? void 0 : templateSettings.tableName) !== undefined)) return [3 /*break*/, 4];
                     _a = constants_1.tablesFolderPath;
                     return [4 /*yield*/, xmlInnerPartsUtils_1.default.findTablePathFromZip(zip, templateSettings === null || templateSettings === void 0 ? void 0 : templateSettings.tableName)];
                 case 3:
-                    tablePath = _a + (_b.sent());
-                    _b.label = 4;
+                    tablePath = _a + (_c.sent());
+                    _c.label = 4;
                 case 4:
                     cellRangeRef = "A1";
-                    if (!((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) != null)) return [3 /*break*/, 6];
+                    if (!((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) !== undefined)) return [3 /*break*/, 6];
                     return [4 /*yield*/, xmlInnerPartsUtils_1.default.getReferenceFromTable(zip, tablePath)];
                 case 5:
-                    cellRangeRef = _b.sent();
-                    _b.label = 6;
+                    cellRangeRef = _c.sent();
+                    _c.label = 6;
                 case 6:
                     if (tableData) {
-                        cellRangeRef += ":".concat(documentUtils_1.default.getCellReferenceRelative(tableData.columnNames.length - 1, tableData.rows.length + 1));
+                        _b = documentUtils_1.default.GetStartPosition(cellRangeRef), row = _b.row, column = _b.column;
+                        endColumn = column - 1 + tableData.columnNames.length;
+                        endRow = row - 1 + tableData.rows.length;
+                        // Extend the cell range to include the entire table span
+                        cellRangeRef += ":".concat(documentUtils_1.default.getCellReferenceRelative(endColumn - 1, endRow + 1));
                     }
                     return [4 /*yield*/, xmlInnerPartsUtils_1.default.updateDocProps(zip, fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.docProps)];
                 case 7:
-                    _b.sent();
+                    _c.sent();
                     if (!((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) === undefined)) return [3 /*break*/, 9];
                     // If we are using our base template, we need to clear label info
                     return [4 /*yield*/, xmlInnerPartsUtils_1.default.clearLabelInfo(zip)];
                 case 8:
                     // If we are using our base template, we need to clear label info
-                    _b.sent();
-                    _b.label = 9;
+                    _c.sent();
+                    _c.label = 9;
                 case 9: return [4 /*yield*/, tableUtils_1.default.updateTableInitialDataIfNeeded(zip, cellRangeRef, sheetPath, tablePath, sheetPath, tableData, updateQueryTable)];
                 case 10:
-                    _b.sent();
+                    _c.sent();
+                    return [4 /*yield*/, addCustomXMLToWorkbook(zip)];
+                case 11:
+                    _c.sent();
                     return [2 /*return*/];
             }
         });
@@ -110,7 +183,7 @@ var updateWorkbookPowerQueryDocument = function (zip, queryName, queryMashupDoc)
             case 1:
                 old_base64 = _a.sent();
                 if (!old_base64) {
-                    throw new Error(constants_1.base64NotFoundErr);
+                    throw new Error(constants_1.Errors.base64NotFound);
                 }
                 return [4 /*yield*/, (0, mashupDocumentParser_1.replaceSingleQuery)(old_base64, queryName, queryMashupDoc)];
             case 2:
@@ -131,7 +204,7 @@ var updateWorkbookSingleQueryAttributes = function (zip, queryName, refreshOnOpe
             case 1:
                 connectionsXmlString = _f.sent();
                 if (connectionsXmlString === undefined) {
-                    throw new Error(constants_1.connectionsNotFoundErr);
+                    throw new Error(constants_1.Errors.connectionsNotFound);
                 }
                 _a = xmlInnerPartsUtils_1.default.updateConnections(connectionsXmlString, queryName, refreshOnOpen), connectionId = _a.connectionId, connectionXmlFileString = _a.connectionXmlFileString;
                 zip.file(constants_1.connectionsXmlPath, connectionXmlFileString);
@@ -139,7 +212,7 @@ var updateWorkbookSingleQueryAttributes = function (zip, queryName, refreshOnOpe
             case 2:
                 sharedStringsXmlString = _f.sent();
                 if (sharedStringsXmlString === undefined) {
-                    throw new Error(constants_1.sharedStringsNotFoundErr);
+                    throw new Error(constants_1.Errors.sharedStringsNotFound);
                 }
                 _b = xmlInnerPartsUtils_1.default.updateSharedStrings(sharedStringsXmlString, queryName), sharedStringIndex = _b.sharedStringIndex, newSharedStrings = _b.newSharedStrings;
                 zip.file(constants_1.sharedStringsXmlPath, newSharedStrings);
@@ -154,7 +227,7 @@ var updateWorkbookSingleQueryAttributes = function (zip, queryName, refreshOnOpe
             case 5:
                 sheetsXmlString = _f.sent();
                 if (sheetsXmlString === undefined) {
-                    throw new Error(constants_1.sheetsNotFoundErr);
+                    throw new Error(constants_1.Errors.sheetsNotFound);
                 }
                 worksheetString = xmlInnerPartsUtils_1.default.updateWorksheet(sheetsXmlString, sharedStringIndex.toString());
                 zip.file(sheetPath, worksheetString);
@@ -171,4 +244,5 @@ exports.default = {
     updateWorkbookDataAndConfigurations: updateWorkbookDataAndConfigurations,
     updateWorkbookPowerQueryDocument: updateWorkbookPowerQueryDocument,
     updateWorkbookSingleQueryAttributes: updateWorkbookSingleQueryAttributes,
+    addCustomXMLToWorkbook: addCustomXMLToWorkbook
 };