@microsoft/connected-workbooks 2.1.24-beta → 3.0.0

package/dist/utils/xmlInnerPartsUtils.js

@@ -1,4 +1,6 @@
 "use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -37,7 +39,33 @@ const updateDocProps = (zip, docProps = {}) => __awaiter(void 0, void 0, void 0,
     const newDoc = serializer.serializeToString(doc);
     zip.file(constants_1.docPropsCoreXmlPath, newDoc);
 });
-const updateConnections = (connectionsXmlString, queryName, refreshOnOpen) => __awaiter(void 0, void 0, void 0, function* () {
+const clearLabelInfo = (zip) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d;
+    // remove docMetadata folder that contains only LabelInfo.xml in template file.
+    zip.remove(constants_1.docMetadataXmlPath);
+    // fix rels
+    const relsString = yield ((_a = zip.file(constants_1.relsXmlPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType));
+    if (relsString === undefined) {
+        throw new Error(constants_1.relsNotFoundErr);
+    }
+    const parser = new DOMParser();
+    const doc = parser.parseFromString(relsString, constants_1.xmlTextResultType);
+    const relationships = doc.querySelector("Relationships");
+    if (relationships === null) {
+        throw new Error(constants_1.unexpectedErr);
+    }
+    const element = relationships.querySelector('Relationship[Target="docMetadata/LabelInfo.xml"]');
+    if (element) {
+        relationships.removeChild(element);
+    }
+    (_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");
+    const serializer = new XMLSerializer();
+    const newDoc = serializer.serializeToString(doc);
+    zip.file(constants_1.relsXmlPath, newDoc);
+});
+const updateConnections = (connectionsXmlString, queryName, refreshOnOpen) => {
     var _a, _b, _c;
     const parser = new DOMParser();
     const serializer = new XMLSerializer();
@@ -57,8 +85,8 @@ const updateConnections = (connectionsXmlString, queryName, refreshOnOpen) => __
         throw new Error(constants_1.connectionsNotFoundErr);
     }
     return { connectionId, connectionXmlFileString };
-});
-const updateSharedStrings = (sharedStringsXmlString, queryName) => __awaiter(void 0, void 0, void 0, function* () {
+};
+const updateSharedStrings = (sharedStringsXmlString, queryName) => {
     const parser = new DOMParser();
     const serializer = new XMLSerializer();
     const sharedStringsDoc = parser.parseFromString(sharedStringsXmlString, constants_1.xmlTextResultType);
@@ -97,21 +125,21 @@ const updateSharedStrings = (sharedStringsXmlString, queryName) => __awaiter(voi
     }
     const newSharedStrings = serializer.serializeToString(sharedStringsDoc);
     return { sharedStringIndex, newSharedStrings };
-});
-const updateWorksheet = (sheetsXmlString, sharedStringIndex) => __awaiter(void 0, void 0, void 0, function* () {
+};
+const updateWorksheet = (sheetsXmlString, sharedStringIndex) => {
     const parser = new DOMParser();
     const serializer = new XMLSerializer();
     const sheetsDoc = parser.parseFromString(sheetsXmlString, constants_1.xmlTextResultType);
     sheetsDoc.getElementsByTagName(constants_1.element.cellValue)[0].innerHTML = sharedStringIndex.toString();
     const newSheet = serializer.serializeToString(sheetsDoc);
     return newSheet;
-});
+};
 const updatePivotTablesandQueryTables = (zip, queryName, refreshOnOpen, connectionId) => __awaiter(void 0, void 0, void 0, function* () {
-    var _d, _e;
+    var _e, _f;
     // Find Query Table
     let found = false;
     const queryTablePromises = [];
-    (_d = zip.folder(constants_1.queryTablesPath)) === null || _d === void 0 ? void 0 : _d.forEach((relativePath, queryTableFile) => __awaiter(void 0, void 0, void 0, function* () {
+    (_e = zip.folder(constants_1.queryTablesPath)) === null || _e === void 0 ? void 0 : _e.forEach((relativePath, queryTableFile) => __awaiter(void 0, void 0, void 0, function* () {
         queryTablePromises.push((() => {
             return queryTableFile.async(constants_1.textResultType).then((queryTableString) => {
                 return {
@@ -133,7 +161,7 @@ const updatePivotTablesandQueryTables = (zip, queryName, refreshOnOpen, connecti
     }
     // Find Pivot Table
     const pivotCachePromises = [];
-    (_e = zip.folder(constants_1.pivotCachesPath)) === null || _e === void 0 ? void 0 : _e.forEach((relativePath, pivotCacheFile) => __awaiter(void 0, void 0, void 0, function* () {
+    (_f = zip.folder(constants_1.pivotCachesPath)) === null || _f === void 0 ? void 0 : _f.forEach((relativePath, pivotCacheFile) => __awaiter(void 0, void 0, void 0, function* () {
         if (relativePath.startsWith(constants_1.pivotCachesPathPrefix)) {
             pivotCachePromises.push((() => {
                 return pivotCacheFile.async(constants_1.textResultType).then((pivotCacheString) => {
@@ -189,6 +217,7 @@ const updatePivotTable = (tableXmlString, connectionId, refreshOnOpen) => {
 };
 exports.default = {
     updateDocProps,
+    clearLabelInfo,
     updateConnections,
     updateSharedStrings,
     updateWorksheet,

package/dist/utils/xmlPartsUtils.js

@@ -1,4 +1,6 @@
 "use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -17,8 +19,12 @@ const mashupDocumentParser_1 = require("./mashupDocumentParser");
 const pqUtils_1 = __importDefault(require("./pqUtils"));
 const xmlInnerPartsUtils_1 = __importDefault(require("./xmlInnerPartsUtils"));
 const tableUtils_1 = __importDefault(require("./tableUtils"));
-const updateWorkbookInitialDataIfNeeded = (zip, docProps, tableData, updateQueryTable = false) => __awaiter(void 0, void 0, void 0, function* () {
-    yield xmlInnerPartsUtils_1.default.updateDocProps(zip, docProps);
+const updateWorkbookDataAndConfigurations = (zip, fileConfigs, tableData, updateQueryTable = false) => __awaiter(void 0, void 0, void 0, function* () {
+    yield xmlInnerPartsUtils_1.default.updateDocProps(zip, fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.docProps);
+    if ((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) === undefined) {
+        // If we are using our base template, we need to clear label info
+        yield xmlInnerPartsUtils_1.default.clearLabelInfo(zip);
+    }
     yield tableUtils_1.default.updateTableInitialDataIfNeeded(zip, tableData, updateQueryTable);
 });
 const updateWorkbookPowerQueryDocument = (zip, queryName, queryMashupDoc) => __awaiter(void 0, void 0, void 0, function* () {
@@ -36,27 +42,27 @@ const updateWorkbookSingleQueryAttributes = (zip, queryName, refreshOnOpen) => _
     if (connectionsXmlString === undefined) {
         throw new Error(constants_1.connectionsNotFoundErr);
     }
-    const { connectionId, connectionXmlFileString } = yield xmlInnerPartsUtils_1.default.updateConnections(connectionsXmlString, queryName, refreshOnOpen);
+    const { connectionId, connectionXmlFileString } = xmlInnerPartsUtils_1.default.updateConnections(connectionsXmlString, queryName, refreshOnOpen);
     zip.file(constants_1.connectionsXmlPath, connectionXmlFileString);
     // Update sharedStrings
     const sharedStringsXmlString = yield ((_b = zip.file(constants_1.sharedStringsXmlPath)) === null || _b === void 0 ? void 0 : _b.async(constants_1.textResultType));
     if (sharedStringsXmlString === undefined) {
         throw new Error(constants_1.sharedStringsNotFoundErr);
     }
-    const { sharedStringIndex, newSharedStrings } = yield xmlInnerPartsUtils_1.default.updateSharedStrings(sharedStringsXmlString, queryName);
+    const { sharedStringIndex, newSharedStrings } = xmlInnerPartsUtils_1.default.updateSharedStrings(sharedStringsXmlString, queryName);
     zip.file(constants_1.sharedStringsXmlPath, newSharedStrings);
     // Update sheet
     const sheetsXmlString = yield ((_c = zip.file(constants_1.sheetsXmlPath)) === null || _c === void 0 ? void 0 : _c.async(constants_1.textResultType));
     if (sheetsXmlString === undefined) {
         throw new Error(constants_1.sheetsNotFoundErr);
     }
-    const worksheetString = yield xmlInnerPartsUtils_1.default.updateWorksheet(sheetsXmlString, sharedStringIndex.toString());
+    const worksheetString = xmlInnerPartsUtils_1.default.updateWorksheet(sheetsXmlString, sharedStringIndex.toString());
     zip.file(constants_1.sheetsXmlPath, worksheetString);
     // Update tables
     yield xmlInnerPartsUtils_1.default.updatePivotTablesandQueryTables(zip, queryName, refreshOnOpen, connectionId);
 });
 exports.default = {
-    updateWorkbookInitialDataIfNeeded,
+    updateWorkbookDataAndConfigurations,
     updateWorkbookPowerQueryDocument,
     updateWorkbookSingleQueryAttributes,
 };

package/dist/workbookManager.d.ts

@@ -1,5 +1,5 @@
-import { DocProps, QueryInfo, Grid, FileConfigs } from "./types";
+import { QueryInfo, Grid, FileConfigs } from "./types";
 export declare const generateSingleQueryWorkbook: (query: QueryInfo, initialDataGrid?: Grid, fileConfigs?: FileConfigs) => Promise<Blob>;
-export declare const generateTableWorkbookFromHtml: (htmlTable: HTMLTableElement, docProps?: DocProps) => Promise<Blob>;
-export declare const generateTableWorkbookFromGrid: (grid: Grid, docProps?: DocProps) => Promise<Blob>;
+export declare const generateTableWorkbookFromHtml: (htmlTable: HTMLTableElement, fileConfigs?: FileConfigs) => Promise<Blob>;
+export declare const generateTableWorkbookFromGrid: (grid: Grid, fileConfigs?: FileConfigs) => Promise<Blob>;
 export declare const downloadWorkbook: (file: Blob, filename: string) => void;

package/dist/workbookManager.js

@@ -20,8 +20,6 @@ const utils_1 = require("./utils");
 const workbookTemplate_1 = require("./workbookTemplate");
 const constants_1 = require("./utils/constants");
 const generators_1 = require("./generators");
-const htmlUtils_1 = require("./utils/htmlUtils");
-const GridParser_1 = require("./GridParser");
 const generateSingleQueryWorkbook = (query, initialDataGrid, fileConfigs) => __awaiter(void 0, void 0, void 0, function* () {
     if (!query.queryMashup) {
         throw new Error(constants_1.emptyQueryMashupErr);
@@ -34,45 +32,42 @@ const generateSingleQueryWorkbook = (query, initialDataGrid, fileConfigs) => __a
         throw new Error(constants_1.templateWithInitialDataErr);
     }
     utils_1.pqUtils.validateQueryName(query.queryName);
-    const zip = templateFile === undefined
-        ? yield jszip_1.default.loadAsync(workbookTemplate_1.SIMPLE_QUERY_WORKBOOK_TEMPLATE, { base64: true })
-        : yield jszip_1.default.loadAsync(templateFile);
-    const tableData = yield parseInitialDataGrid(initialDataGrid);
-    return yield generateSingleQueryWorkbookFromZip(zip, query, fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.docProps, tableData);
+    const zip = templateFile === undefined ? yield jszip_1.default.loadAsync(workbookTemplate_1.SIMPLE_QUERY_WORKBOOK_TEMPLATE, { base64: true }) : yield jszip_1.default.loadAsync(templateFile);
+    const tableData = initialDataGrid ? utils_1.gridUtils.parseToTableData(initialDataGrid) : undefined;
+    return yield generateSingleQueryWorkbookFromZip(zip, query, fileConfigs, tableData);
 });
 exports.generateSingleQueryWorkbook = generateSingleQueryWorkbook;
-const generateTableWorkbookFromHtml = (htmlTable, docProps) => __awaiter(void 0, void 0, void 0, function* () {
-    const gridData = (0, htmlUtils_1.extractTableValues)(htmlTable);
-    return yield (0, exports.generateTableWorkbookFromGrid)({ data: gridData, promoteHeaders: false }, docProps);
+const generateTableWorkbookFromHtml = (htmlTable, fileConfigs) => __awaiter(void 0, void 0, void 0, function* () {
+    if ((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) !== undefined) {
+        throw new Error(constants_1.templateFileNotSupportedErr);
+    }
+    const gridData = utils_1.htmlUtils.extractTableValues(htmlTable);
+    return yield (0, exports.generateTableWorkbookFromGrid)({ data: gridData, config: { promoteHeaders: true } }, fileConfigs);
 });
 exports.generateTableWorkbookFromHtml = generateTableWorkbookFromHtml;
-const generateTableWorkbookFromGrid = (grid, docProps) => __awaiter(void 0, void 0, void 0, function* () {
+const generateTableWorkbookFromGrid = (grid, fileConfigs) => __awaiter(void 0, void 0, void 0, function* () {
+    if ((fileConfigs === null || fileConfigs === void 0 ? void 0 : fileConfigs.templateFile) !== undefined) {
+        throw new Error(constants_1.templateFileNotSupportedErr);
+    }
     const zip = yield jszip_1.default.loadAsync(workbookTemplate_1.SIMPLE_BLANK_TABLE_TEMPLATE, { base64: true });
-    const tableData = yield parseInitialDataGrid(grid);
+    const tableData = utils_1.gridUtils.parseToTableData(grid);
     if (tableData === undefined) {
         throw new Error(constants_1.tableNotFoundErr);
     }
-    yield utils_1.xmlPartsUtils.updateWorkbookInitialDataIfNeeded(zip, docProps, tableData);
+    yield utils_1.xmlPartsUtils.updateWorkbookDataAndConfigurations(zip, fileConfigs, tableData);
     return yield zip.generateAsync({
         type: constants_1.blobFileType,
         mimeType: constants_1.application,
     });
 });
 exports.generateTableWorkbookFromGrid = generateTableWorkbookFromGrid;
-const parseInitialDataGrid = (grid) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!grid) {
-        return undefined;
-    }
-    const tableData = (0, GridParser_1.parseToTableData)(grid);
-    return tableData;
-});
-const generateSingleQueryWorkbookFromZip = (zip, query, docProps, tableData) => __awaiter(void 0, void 0, void 0, function* () {
+const generateSingleQueryWorkbookFromZip = (zip, query, fileConfigs, tableData) => __awaiter(void 0, void 0, void 0, function* () {
     if (!query.queryName) {
         query.queryName = constants_1.defaults.queryName;
     }
     yield utils_1.xmlPartsUtils.updateWorkbookPowerQueryDocument(zip, query.queryName, (0, generators_1.generateSingleQueryMashup)(query.queryName, query.queryMashup));
     yield utils_1.xmlPartsUtils.updateWorkbookSingleQueryAttributes(zip, query.queryName, query.refreshOnOpen);
-    yield utils_1.xmlPartsUtils.updateWorkbookInitialDataIfNeeded(zip, docProps, tableData, true /*updateQueryTable*/);
+    yield utils_1.xmlPartsUtils.updateWorkbookDataAndConfigurations(zip, fileConfigs, tableData, true /*updateQueryTable*/);
     return yield zip.generateAsync({
         type: constants_1.blobFileType,
         mimeType: constants_1.application,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/connected-workbooks",
-  "version": "2.1.24-beta",
+  "version": "3.0.0",
   "description": "Microsoft backed, Excel advanced xlsx workbook generation JavaScript library",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,7 +14,7 @@
     "build": "tsc",
     "build-webpack-prod": "webpack --mode=production --node-env=production",
     "build-webpack-dev": "webpack --mode=development --node-env=development",
-    "test": "jest",
+    "test": "tsc --project tsconfig.test.json && jest",
     "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\" --config .prettierrc"
   },
   "repository": {
@@ -38,7 +38,9 @@
   "homepage": "https://github.com/microsoft/connected-workbooks#readme",
   "dependencies": {
     "base64-js": "^1.5.1",
-    "jszip": "^3.5.0"
+    "buffer": "^6.0.3",
+    "jszip": "^3.5.0",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.14.6",