@microsoft/connected-workbooks 3.3.2-beta → 3.4.0

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 () {
@@ -116,17 +133,18 @@ var clearLabelInfo = function (zip) { return __awaiter(void 0, void 0, void 0, f
             case 1:
                 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);
+                checkParserError(doc, constants_1.Errors.relsParse);
                 relationshipsList = doc.getElementsByTagName(constants_1.element.relationships);
                 if (!relationshipsList || relationshipsList.length === 0) {
-                    throw new Error(constants_1.relationshipErr);
+                    throw new Error(constants_1.Errors.relationship);
                 }
                 relationships = relationshipsList[0];
                 if (!relationships) {
-                    throw new Error(constants_1.relationshipErr);
+                    throw new Error(constants_1.Errors.relationship);
                 }
                 removeLabelInfoRelationship(doc, relationships);
                 updateRelationshipIds(doc);
@@ -143,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);
@@ -154,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 };
 };
@@ -162,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;
@@ -202,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;
@@ -267,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*/];
         }
@@ -279,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) {
@@ -294,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) {
@@ -315,12 +338,13 @@ function getSheetPathFromXlRelId(zip, rId) {
                 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);
+                    checkParserError(relsDoc, constants_1.Errors.workbookRelsParse);
                     relationships = relsDoc.getElementsByTagName("Relationship");
                     target = null;
                     for (i = 0; i < relationships.length; i++) {
@@ -348,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) {
@@ -375,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")
         }
@@ -393,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 }); }));
@@ -407,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,
@@ -428,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,6 +47,72 @@ 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 () {
@@ -100,6 +166,9 @@ var updateWorkbookDataAndConfigurations = function (zip, fileConfigs, tableData,
                     _c.label = 9;
                 case 9: return [4 /*yield*/, tableUtils_1.default.updateTableInitialDataIfNeeded(zip, cellRangeRef, sheetPath, tablePath, sheetPath, tableData, updateQueryTable)];
                 case 10:
+                    _c.sent();
+                    return [4 /*yield*/, addCustomXMLToWorkbook(zip)];
+                case 11:
                     _c.sent();
                     return [2 /*return*/];
             }
@@ -114,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:
@@ -135,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);
@@ -143,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);
@@ -158,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);
@@ -175,4 +244,5 @@ exports.default = {
     updateWorkbookDataAndConfigurations: updateWorkbookDataAndConfigurations,
     updateWorkbookPowerQueryDocument: updateWorkbookPowerQueryDocument,
     updateWorkbookSingleQueryAttributes: updateWorkbookSingleQueryAttributes,
+    addCustomXMLToWorkbook: addCustomXMLToWorkbook
 };

package/dist/workbookManager.js

@@ -53,13 +53,13 @@ var generateSingleQueryWorkbook = function (query, initialDataGrid, fileConfigs)
         switch (_b.label) {
             case 0:
                 if (!query.queryMashup) {
-                    throw new Error(constants_1.emptyQueryMashupErr);
+                    throw new Error(constants_1.Errors.emptyQueryMashup);
                 }
                 if (!query.queryName) {
                     query.queryName = constants_1.defaults.queryName;
                 }
                 if ((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) !== undefined && initialDataGrid !== undefined) {
-                    throw new Error(constants_1.templateWithInitialDataErr);
+                    throw new Error(constants_1.Errors.templateWithInitialData);
                 }
                 utils_1.pqUtils.validateQueryName(query.queryName);
                 if (!((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) === undefined)) return [3 /*break*/, 2];
@@ -110,7 +110,7 @@ var generateTableWorkbookFromGrid = function (grid, fileConfigs) { return __awai
                 zip = _a;
                 tableData = utils_1.gridUtils.parseToTableData(grid);
                 if (tableData === undefined) {
-                    throw new Error(constants_1.tableNotFoundErr);
+                    throw new Error(constants_1.Errors.tableNotFound);
                 }
                 return [4 /*yield*/, utils_1.xmlPartsUtils.updateWorkbookDataAndConfigurations(zip, fileConfigs, tableData)];
             case 5:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/connected-workbooks",
-  "version": "3.3.2-beta",
+  "version": "3.4.0",
   "description": "Microsoft backed, Excel advanced xlsx workbook generation JavaScript library",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,8 +14,12 @@
     "build": "tsc",
     "build-webpack-prod": "webpack --mode=production --node-env=production",
     "build-webpack-dev": "webpack --mode=development --node-env=development",
-    "test": "tsc --project tsconfig.test.json && jest",
-    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\" --config .prettierrc"
+    "clean": "jest --clearCache",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\" --config .prettierrc",
+    "test:clean": "npm run clean && npm run test",
+    "test:node": "tsc && jest --config jest.config.node.js",
+    "test:jsdom": "tsc && jest --config jest.config.jsdom.js",
+    "test": "npm run test:jsdom && npm run test:node"
   },
   "repository": {
     "type": "git",

package/dist/src/generators.js

@@ -1,15 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCustomXmlFilePath = exports.generateSingleQueryMashup = exports.generateMashupXMLTemplate = void 0;
-var generateMashupXMLTemplate = function (base64) {
-    return "<?xml version=\"1.0\" encoding=\"utf-16\"?><DataMashup xmlns=\"http://schemas.microsoft.com/DataMashup\">".concat(base64, "</DataMashup>");
-};
-exports.generateMashupXMLTemplate = generateMashupXMLTemplate;
-var generateSingleQueryMashup = function (queryName, query) {
-    return "section Section1;\n    \n    shared #\"".concat(queryName, "\" = \n    ").concat(query, ";");
-};
-exports.generateSingleQueryMashup = generateSingleQueryMashup;
-var generateCustomXmlFilePath = function (i) { return "customXml/item".concat(i, ".xml"); };
-exports.generateCustomXmlFilePath = generateCustomXmlFilePath;

package/dist/src/types.js

@@ -1,28 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocPropsAutoUpdatedElements = exports.DocPropsModifiableElements = exports.DataTypes = void 0;
-var DataTypes;
-(function (DataTypes) {
-    DataTypes[DataTypes["null"] = 0] = "null";
-    DataTypes[DataTypes["string"] = 1] = "string";
-    DataTypes[DataTypes["number"] = 2] = "number";
-    DataTypes[DataTypes["boolean"] = 3] = "boolean";
-})(DataTypes = exports.DataTypes || (exports.DataTypes = {}));
-var DocPropsModifiableElements;
-(function (DocPropsModifiableElements) {
-    DocPropsModifiableElements["title"] = "dc:title";
-    DocPropsModifiableElements["subject"] = "dc:subject";
-    DocPropsModifiableElements["keywords"] = "cp:keywords";
-    DocPropsModifiableElements["createdBy"] = "dc:creator";
-    DocPropsModifiableElements["description"] = "dc:description";
-    DocPropsModifiableElements["lastModifiedBy"] = "cp:lastModifiedBy";
-    DocPropsModifiableElements["category"] = "cp:category";
-    DocPropsModifiableElements["revision"] = "cp:revision";
-})(DocPropsModifiableElements = exports.DocPropsModifiableElements || (exports.DocPropsModifiableElements = {}));
-var DocPropsAutoUpdatedElements;
-(function (DocPropsAutoUpdatedElements) {
-    DocPropsAutoUpdatedElements["created"] = "dcterms:created";
-    DocPropsAutoUpdatedElements["modified"] = "dcterms:modified";
-})(DocPropsAutoUpdatedElements = exports.DocPropsAutoUpdatedElements || (exports.DocPropsAutoUpdatedElements = {}));

package/dist/src/utils/arrayUtils.js

@@ -1,51 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArrayReader = void 0;
-var ArrayReader = /** @class */ (function () {
-    function ArrayReader(array) {
-        this._array = array;
-        this._position = 0;
-    }
-    ArrayReader.prototype.getInt32 = function () {
-        var retVal = new DataView(this._array, this._position, 4).getInt32(0, true);
-        this._position += 4;
-        return retVal;
-    };
-    ArrayReader.prototype.getBytes = function (bytes) {
-        var retVal = this._array.slice(this._position, bytes ? bytes + this._position : bytes);
-        this._position += retVal.byteLength;
-        return new Uint8Array(retVal);
-    };
-    ArrayReader.prototype.reset = function () {
-        this._position = 0;
-    };
-    return ArrayReader;
-}());
-exports.ArrayReader = ArrayReader;
-function getInt32Buffer(val) {
-    var packageSizeBuffer = new ArrayBuffer(4);
-    new DataView(packageSizeBuffer).setInt32(0, val, true);
-    return new Uint8Array(packageSizeBuffer);
-}
-function concatArrays() {
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    var size = 0;
-    args.forEach(function (arr) { return (size += arr.byteLength); });
-    var retVal = new Uint8Array(size);
-    var position = 0;
-    args.forEach(function (arr) {
-        retVal.set(arr, position);
-        position += arr.byteLength;
-    });
-    return retVal;
-}
-exports.default = {
-    ArrayReader: ArrayReader,
-    getInt32Buffer: getInt32Buffer,
-    concatArrays: concatArrays,
-};