@microsoft/connected-workbooks 2.1.24-beta → 2.1.25

package/dist/tests/tableUtils.test.js

@@ -0,0 +1,63 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../src/utils");
+const mocks_1 = require("./mocks");
+describe("Table Utils tests", () => {
+    test("tests workbookXML contains initial data dimensions", () => {
+        const defaultString = '<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="x15 xr xr6 xr10 xr2" xmlns:x15="http://schemas.microsoft.com/office/spreadsheetml/2010/11/main" xmlns:xr="http://schemas.microsoft.com/office/spreadsheetml/2014/revision" xmlns:xr6="http://schemas.microsoft.com/office/spreadsheetml/2016/revision6" xmlns:xr10="http://schemas.microsoft.com/office/spreadsheetml/2016/revision10" xmlns:xr2="http://schemas.microsoft.com/office/spreadsheetml/2015/revision2"><fileVersion appName="xl" lastEdited="7" lowestEdited="7" rupBuild="24729"/><workbookPr codeName="ThisWorkbook" defaultThemeVersion="166925"/><mc:AlternateContent><mc:Choice Requires="x15"><x15ac:absPath url="C:Usersv-ahmadsbeihDesktop" xmlns:x15ac="http://schemas.microsoft.com/office/spreadsheetml/2010/11/ac"/></mc:Choice></mc:AlternateContent><xr:revisionPtr revIDLastSave="0" documentId="13_ncr:1_{93EF201C-7856-4B60-94D4-65DDB8F3F16A}" xr6:coauthVersionLast="47" xr6:coauthVersionMax="47" xr10:uidLastSave="{00000000-0000-0000-0000-000000000000}"/><bookViews><workbookView xWindow="28680" yWindow="-120" windowWidth="29040" windowHeight="15990" xr2:uid="{DB915CB9-8DD9-492A-A471-C61E61200113}"/></bookViews><sheets><sheet name="Query1" sheetId="2" r:id="rId1"/><sheet name="Sheet1" sheetId="1" r:id="rId2"/></sheets><definedNames><definedName name="ExternalData_1" localSheetId="0" hidden="1">Sheet1!$A$1:$B$2</definedName></definedNames><calcPr calcId="191029"/><extLst><ext uri="{140A7094-0E35-4892-8432-C4D2E57EDEB5}"><x15:workbookPr chartTrackingRefBase="1"/></ext><ext uri="{B58B0392-4F1F-4190-BB64-5DF3571DCE5F}" xmlns:xcalcf="http://schemas.microsoft.com/office/spreadsheetml/2018/calcfeatures"><xcalcf:calcFeatures><xcalcf:feature name="microsoft.com:RD"/><xcalcf:feature name="microsoft.com:FV"/><xcalcf:feature name="microsoft.com:LET_WF"/><xcalcf:feature name="microsoft.com:LAMBDA_WF"/></xcalcf:calcFeatures></ext></extLst></workbook>';
+        const worksheetXml = utils_1.tableUtils.updateWorkbookInitialData(defaultString, {
+            columnNames: ["Column1", "Column2"],
+            rows: [["1", "2"]],
+        });
+        expect(worksheetXml).toContain(mocks_1.workbookXmlMock);
+    });
+    test("tests Pivot Tables contain initial data", () => {
+        const defaultString = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\r\n<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="xr xr3" xmlns:xr="http://schemas.microsoft.com/office/spreadsheetml/2014/revision" xmlns:xr3="http://schemas.microsoft.com/office/spreadsheetml/2016/revision3" id="1" xr:uid="{D8539CF6-04E5-464D-9950-5A36C5A1FCFE}" name="Query1" displayName="Query1" ref="A1:A2" tableType="queryTable" totalsRowShown="0"><autoFilter ref="A1:A2" xr:uid="{D8539CF6-04E5-464D-9950-5A36C5A1FCFE}"/><tableColumns count="1"><tableColumn id="1" xr3:uid="{D1084858-8AE5-4728-A9BE-FE78821CDFFF}" uniqueName="1" name="Query1" queryTableFieldId="1" dataDxfId="0"/></tableColumns><tableStyleInfo name="TableStyleMedium7" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/></table>';
+        const tableXmlSheet = utils_1.tableUtils.updateTablesInitialData(defaultString, {
+            columnNames: ["Column1", "Column2"],
+            rows: [["1", "2"]],
+        }, true);
+        expect(tableXmlSheet).toContain('count="2"');
+        expect(tableXmlSheet).toContain('ref="A1:B2');
+        expect(tableXmlSheet).toContain('uniqueName="1"');
+        expect(tableXmlSheet).toContain('name="Column1"');
+        expect(tableXmlSheet).toContain('queryTableFieldId="1"');
+        expect(tableXmlSheet).toContain('uniqueName="2"');
+        expect(tableXmlSheet).toContain('name="Column2"');
+        expect(tableXmlSheet).toContain('queryTableFieldId="2"');
+    });
+    test("tests blank Table contain initial data", () => {
+        const defaultString = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\r\n<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="xr xr3" xmlns:xr="http://schemas.microsoft.com/office/spreadsheetml/2014/revision" xmlns:xr3="http://schemas.microsoft.com/office/spreadsheetml/2016/revision3" id="1" xr:uid="{D8539CF6-04E5-464D-9950-5A36C5A1FCFE}" name="Query1" displayName="Query1" ref="A1:A2" tableType="queryTable" totalsRowShown="0"><autoFilter ref="A1:A2" xr:uid="{D8539CF6-04E5-464D-9950-5A36C5A1FCFE}"/><tableColumns count="1"><tableColumn id="1" xr3:uid="{D1084858-8AE5-4728-A9BE-FE78821CDFFF}" uniqueName="1" name="Query1" queryTableFieldId="1" dataDxfId="0"/></tableColumns><tableStyleInfo name="TableStyleMedium7" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/></table>';
+        const tableXmlSheet = utils_1.tableUtils.updateTablesInitialData(defaultString, {
+            columnNames: ["Column1", "Column2"],
+            rows: [["1", "2"]],
+        }, false);
+        expect(tableXmlSheet).toContain('count="2"');
+        expect(tableXmlSheet).toContain('ref="A1:B2');
+        expect(tableXmlSheet).toContain('name="Column2"');
+        expect(tableXmlSheet).toContain('name="Column1"');
+        // Not contains query table metadata.
+        expect(tableXmlSheet).not.toContain('uniqueName="1"');
+        expect(tableXmlSheet).not.toContain('queryTableFieldId="1"');
+        expect(tableXmlSheet).not.toContain('uniqueName="2"');
+        expect(tableXmlSheet).not.toContain('queryTableFieldId="2"');
+    });
+    test("test valid initial data in SheetsXML", () => {
+        const defaultString = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="x14ac xr xr2 xr3" xmlns:x14ac="http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac" xmlns:xr="http://schemas.microsoft.com/office/spreadsheetml/2014/revision" xmlns:xr2="http://schemas.microsoft.com/office/spreadsheetml/2015/revision2" xmlns:xr3="http://schemas.microsoft.com/office/spreadsheetml/2016/revision3" xr:uid="{EDF0138E-D216-4CD1-8EFA-1396A1BB4478}"><sheetPr codeName="Sheet1"/><dimension ref="A1:A2"/><sheetViews><sheetView tabSelected="1" workbookViewId="0"/></sheetViews><sheetFormatPr defaultRowHeight="14.4" x14ac:dyDescent="0.3"/><cols><col min="1" max="1" width="9.6640625" bestFit="1" customWidth="1"/></cols><sheetData><row r="1" spans="1:1" x14ac:dyDescent="0.3"><c r="A1" t="s"><v>0</v></c></row><row r="2" spans="1:1" x14ac:dyDescent="0.3"><c r="A2" t="s"><v>1</v></c></row></sheetData><pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3" footer="0.3"/><tableParts count="1"><tablePart r:id="rId1"/></tableParts></worksheet>';
+        const sheetsXmlString = utils_1.tableUtils.updateSheetsInitialData(defaultString, {
+            columnNames: ["Column1", "Column2"],
+            rows: [["1", "2"]],
+        });
+        expect(sheetsXmlString).toContain(mocks_1.sheetsXmlMock);
+    });
+    test("tests Query Tables contain initial data", () => {
+        const defaultString = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\r\n<queryTable xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="xr16" xmlns:xr16="http://schemas.microsoft.com/office/spreadsheetml/2017/revision16" name="ExternalData_1" connectionId="1" xr16:uid="{24C17B89-3CD3-4AA5-B84F-9FF5F35245D7}" autoFormatId="16" applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="0"><queryTableRefresh nextId="2"><queryTableFields count="1"><queryTableField id="1" name="Query1" tableColumnId="1"/></queryTableFields></queryTableRefresh></queryTable>';
+        const queryTableXmlSheet = utils_1.tableUtils.updateQueryTablesInitialData(defaultString, {
+            columnNames: ["Column1", "Column2"],
+            rows: [["1", "2"]],
+        });
+        expect(queryTableXmlSheet).toContain(mocks_1.queryTableMock);
+    });
+});

package/dist/tests/workbookQueryTemplate.test.js

@@ -0,0 +1,64 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../src/utils");
+const constants_1 = require("../src/utils/constants");
+const mashupDocumentParser_1 = require("../src/utils/mashupDocumentParser");
+const workbookTemplate_1 = require("../src/workbookTemplate");
+const mocks_1 = require("./mocks");
+const jszip_1 = __importDefault(require("jszip"));
+const getZip = (template) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield jszip_1.default.loadAsync(template, {
+        base64: true,
+    });
+});
+describe("Single query template tests", () => {
+    const singleQueryDefaultTemplate = workbookTemplate_1.SIMPLE_QUERY_WORKBOOK_TEMPLATE;
+    let defaultZipFile;
+    beforeAll(() => __awaiter(void 0, void 0, void 0, function* () {
+        expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield getZip(singleQueryDefaultTemplate); })).not.toThrow();
+        defaultZipFile = yield getZip(singleQueryDefaultTemplate);
+    }));
+    test("Default template is a valid zip file", () => __awaiter(void 0, void 0, void 0, function* () {
+        expect(defaultZipFile).toBeTruthy();
+    }));
+    test("DataMashup XML exists, and valid PQ Base64 can be extracted", () => __awaiter(void 0, void 0, void 0, function* () {
+        expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield utils_1.pqUtils.getDataMashupFile(defaultZipFile); })).not.toThrowError();
+        const { found, path, value } = yield utils_1.pqUtils.getDataMashupFile(defaultZipFile);
+        expect(found).toBeTruthy();
+        expect(value).toEqual(mocks_1.pqEmptySingleQueryBase64);
+        expect(path).toEqual(mocks_1.item1Path);
+    }));
+    test("ConnectedWorkbook XML exists as item1.xml", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { found, path, xmlString } = yield utils_1.pqUtils.getCustomXmlFile(defaultZipFile, constants_1.URLS.CONNECTED_WORKBOOK, "utf-8");
+        expect(found).toBeTruthy();
+        expect(xmlString).toEqual(mocks_1.connectedWorkbookXmlMock);
+        expect(path).toEqual(mocks_1.item2Path);
+    }));
+    test("A single blank query named Query1 exists", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const base64Str = yield utils_1.pqUtils.getBase64(defaultZipFile);
+        const { packageOPC } = (0, mashupDocumentParser_1.getPackageComponents)(base64Str);
+        const packageZip = yield jszip_1.default.loadAsync(packageOPC);
+        const section1m = yield ((_a = packageZip.file(constants_1.section1mPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType));
+        if (section1m == undefined) {
+            throw new Error("section1m is undefined");
+        }
+        const hasQuery1 = section1m.includes("Query1");
+        expect(hasQuery1).toBeTruthy();
+        expect(section1m).toEqual(mocks_1.section1mBlankQueryMock);
+    }));
+});

package/dist/tests/workbookTableTemplate.test.js

@@ -0,0 +1,54 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const workbookTemplate_1 = require("../src/workbookTemplate");
+const utils_1 = require("../src/utils");
+const constants_1 = require("../src/utils/constants");
+const jszip_1 = __importDefault(require("jszip"));
+const getZip = (template) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield jszip_1.default.loadAsync(template, {
+        base64: true,
+    });
+});
+describe("Single blank table template tests", () => {
+    const simpleTableDefaultTemplate = workbookTemplate_1.SIMPLE_BLANK_TABLE_TEMPLATE;
+    let defaultZipFile;
+    beforeAll(() => __awaiter(void 0, void 0, void 0, function* () {
+        expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield getZip(simpleTableDefaultTemplate); })).not.toThrow();
+        defaultZipFile = yield getZip(simpleTableDefaultTemplate);
+    }));
+    test("Default template is a valid zip file", () => {
+        expect(defaultZipFile).toBeTruthy();
+    });
+    test("DataMashup XML doesn't exists", () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            yield utils_1.pqUtils.getDataMashupFile(defaultZipFile);
+        }
+        catch (error) {
+            expect(error).toBeTruthy();
+        }
+    }));
+    test("A single blank table exists", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const tableXml = yield ((_a = defaultZipFile.file(constants_1.tableXmlPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType));
+        expect(tableXml).toContain('name="Table1" displayName="Table1" ref="A1:A2"');
+    }));
+    test("Does not contains query table", () => __awaiter(void 0, void 0, void 0, function* () {
+        var _b;
+        const queryTableXml = yield ((_b = defaultZipFile.file(constants_1.queryTableXmlPath)) === null || _b === void 0 ? void 0 : _b.async(constants_1.textResultType));
+        expect(queryTableXml).toBeFalsy();
+    }));
+});

package/dist/tests/xmlInnerPartsUtils.test.js

@@ -0,0 +1,51 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mocks_1 = require("./mocks");
+const utils_1 = require("../src/utils");
+describe("Workbook Manager tests", () => {
+    const mockConnectionString = `<connections xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:xr16="http://schemas.microsoft.com/office/spreadsheetml/2017/revision16" mc:Ignorable="xr16">
+        <connection id="1" xr16:uid="{86BA784C-6640-4989-A85E-EB4966B9E741}" keepAlive="1" name="Query - Query1" description="Connection to the 'Query1' query in the workbook." type="5" refreshedVersion="7" background="1" saveData="1">
+        <dbPr connection="Provider=Microsoft.Mashup.OleDb.1;Data Source=$Workbook$;Location=Query1;" command="SELECT * FROM [Query1]"/></connection></connections>`;
+    test("Connection XML attributes contain new query name", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { connectionXmlFileString } = yield utils_1.xmlInnerPartsUtils.updateConnections(mockConnectionString, "newQueryName", true);
+        expect(connectionXmlFileString.replace(/ /g, "")).toContain('command="SELECT * FROM [newQueryName]'.replace(/ /g, ""));
+        expect(connectionXmlFileString.replace(/ /g, "")).toContain('name="Query - newQueryName"'.replace(/ /g, ""));
+        expect(connectionXmlFileString.replace(/ /g, "")).toContain(`description="Connection to the 'newQueryName' query in the workbook."`.replace(/ /g, ""));
+    }));
+    test("Connection XML attributes contain refreshOnLoad value", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { connectionXmlFileString } = yield utils_1.xmlInnerPartsUtils.updateConnections(mockConnectionString, "newQueryName", true);
+        expect(connectionXmlFileString.replace(/ /g, "")).toContain('refreshOnLoad="1"');
+    }));
+    test("SharedStrings XML contains new query name", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { newSharedStrings } = yield utils_1.xmlInnerPartsUtils.updateSharedStrings('<sst xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" count="1" uniqueCount="1"><si><t>Query1</t></si><si><t/></si></sst>', "newQueryName");
+        expect(newSharedStrings.replace(/ /g, "")).toContain(mocks_1.sharedStringsXmlMock.replace(/ /g, ""));
+    }));
+    test("Tests SharedStrings update when XML contains query name", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { newSharedStrings } = yield utils_1.xmlInnerPartsUtils.updateSharedStrings('<sst xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" count="1" uniqueCount="1"><si><t>newQueryName</t></si><si><t/></si></sst>', "newQueryName");
+        expect(newSharedStrings.replace(/ /g, "")).toContain(mocks_1.existingSharedStringsXmlMock.replace(/ /g, ""));
+    }));
+    test("SharedStrings XML returns new index", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { sharedStringIndex } = yield utils_1.xmlInnerPartsUtils.updateSharedStrings('<sst xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" count="1" uniqueCount="1"><si><t>Query1</t></si><si><t/></si></sst>', "newQueryName");
+        expect(sharedStringIndex).toEqual(2);
+    }));
+    test("SharedStrings XML returns existing index", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { sharedStringIndex } = yield utils_1.xmlInnerPartsUtils.updateSharedStrings('<sst xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" count="1" uniqueCount="1"><si><t>newQueryName</t></si><si><t/></si></sst>', "newQueryName");
+        expect(sharedStringIndex).toEqual(1);
+    }));
+    test("Table XML contains refrshonload value", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { sharedStringIndex, newSharedStrings } = yield utils_1.xmlInnerPartsUtils.updateSharedStrings('<sst xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" count="1" uniqueCount="1"><si><t>Query1</t></si><si><t/></si></sst>', "newQueryName");
+        expect(sharedStringIndex).toEqual(2);
+        expect(newSharedStrings.replace(/ /g, "")).toContain(mocks_1.sharedStringsXmlMock.replace(/ /g, ""));
+    }));
+});

package/dist/types.d.ts

@@ -19,11 +19,14 @@ export interface Metadata {
 export interface TableData {
     columnNames: string[];
     rows: string[][];
-    columnwidth?: number;
 }
 export interface Grid {
     data: (string | number | boolean)[][];
+    config?: GridConfig;
+}
+export interface GridConfig {
     promoteHeaders?: boolean;
+    adjustColumnNames?: boolean;
 }
 export interface FileConfigs {
     templateFile?: File;

package/dist/utils/constants.js

@@ -2,8 +2,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaults = exports.elementAttributesValues = exports.dataTypeKind = exports.elementAttributes = exports.element = exports.BOM = exports.falseStr = exports.trueStr = exports.maxQueryLength = exports.divider = exports.section1PathPrefix = exports.emptyValue = exports.falseValue = exports.trueValue = exports.pivotCachesPathPrefix = exports.xmlTextResultType = exports.textResultType = exports.application = exports.uint8ArrayType = exports.blobFileType = exports.stylesNotFoundErr = exports.EmptyQueryNameErr = exports.QueryNameMaxLengthErr = exports.invalidDataTypeErr = exports.headerNotFoundErr = exports.invalidValueInColumnErr = exports.gridNotFoundErr = exports.tableNotFoundErr = exports.queryTableNotFoundErr = exports.templateWithInitialDataErr = exports.formulaSectionNotFoundErr = exports.queryConnectionNotFoundErr = exports.queryAndPivotTableNotFoundErr = exports.queryNameNotFoundErr = exports.emptyQueryMashupErr = exports.base64NotFoundErr = exports.sheetsNotFoundErr = exports.connectionsNotFoundErr = exports.sharedStringsNotFoundErr = exports.docPropsRootElement = exports.docPropsCoreXmlPath = exports.section1mPath = exports.pivotCachesPath = exports.queryTablesPath = exports.workbookXmlPath = exports.queryTableXmlPath = exports.tableXmlPath = exports.sheetsXmlPath = exports.sharedStringsXmlPath = exports.connectionsXmlPath = void 0;
-exports.URLS = void 0;
+exports.element = exports.BOM = exports.falseStr = exports.trueStr = exports.maxQueryLength = exports.divider = exports.section1PathPrefix = exports.emptyValue = exports.falseValue = exports.trueValue = exports.pivotCachesPathPrefix = exports.xmlTextResultType = exports.textResultType = exports.application = exports.uint8ArrayType = exports.blobFileType = exports.arrayIsntMxNErr = exports.unexpectedErr = exports.promotedHeadersCannotBeUsedWithoutAdjustingColumnNamesErr = exports.InvalidColumnNameErr = exports.stylesNotFoundErr = exports.EmptyQueryNameErr = exports.QueryNameInvalidCharsErr = exports.QueryNameMaxLengthErr = exports.invalidDataTypeErr = exports.headerNotFoundErr = exports.invalidValueInColumnErr = exports.tableNotFoundErr = exports.queryTableNotFoundErr = exports.templateWithInitialDataErr = exports.formulaSectionNotFoundErr = exports.queryConnectionNotFoundErr = exports.queryAndPivotTableNotFoundErr = exports.queryNameNotFoundErr = exports.emptyQueryMashupErr = exports.base64NotFoundErr = exports.sheetsNotFoundErr = exports.connectionsNotFoundErr = exports.sharedStringsNotFoundErr = exports.docPropsRootElement = exports.docPropsCoreXmlPath = exports.section1mPath = exports.pivotCachesPath = exports.queryTablesPath = exports.workbookXmlPath = exports.queryTableXmlPath = exports.tableXmlPath = exports.sheetsXmlPath = exports.sharedStringsXmlPath = exports.connectionsXmlPath = void 0;
+exports.URLS = exports.defaults = exports.elementAttributesValues = exports.dataTypeKind = exports.elementAttributes = void 0;
 exports.connectionsXmlPath = "xl/connections.xml";
 exports.sharedStringsXmlPath = "xl/sharedStrings.xml";
 exports.sheetsXmlPath = "xl/worksheets/sheet1.xml";
@@ -27,13 +27,17 @@ exports.formulaSectionNotFoundErr = "Formula section wasn't found in template";
 exports.templateWithInitialDataErr = "Cannot receive template file with initial data";
 exports.queryTableNotFoundErr = "Query table wasn't found in template";
 exports.tableNotFoundErr = "Table wasn't found in template";
-exports.gridNotFoundErr = "Invalid JSON file, grid data is missing";
 exports.invalidValueInColumnErr = "Invalid cell value in column";
 exports.headerNotFoundErr = "Invalid JSON file, header is missing";
 exports.invalidDataTypeErr = "Invalid JSON file, invalid data type";
 exports.QueryNameMaxLengthErr = "Query names are limited to 80 characters";
+exports.QueryNameInvalidCharsErr = 'Query names cannot contain periods or quotation marks. (. ")';
 exports.EmptyQueryNameErr = "Query name cannot be empty";
 exports.stylesNotFoundErr = "Styles were not found in template";
+exports.InvalidColumnNameErr = "Invalid column name";
+exports.promotedHeadersCannotBeUsedWithoutAdjustingColumnNamesErr = "Headers cannot be promoted without adjusting column names";
+exports.unexpectedErr = "Unexpected error";
+exports.arrayIsntMxNErr = "Array isn't MxN";
 exports.blobFileType = "blob";
 exports.uint8ArrayType = "uint8array";
 exports.application = "application/xlsx";
@@ -48,7 +52,7 @@ exports.divider = "/";
 exports.maxQueryLength = 80;
 exports.trueStr = "true";
 exports.falseStr = "false";
-exports.BOM = '\ufeff';
+exports.BOM = "\ufeff";
 exports.element = {
     sharedStringTable: "sst",
     text: "t",
@@ -75,7 +79,8 @@ exports.element = {
     sheetData: "sheetData",
     row: "row",
     dimension: "dimension",
-    kindCell: "c"
+    selection: "selection",
+    kindCell: "c",
 };
 exports.elementAttributes = {
     connection: "connection",
@@ -100,6 +105,7 @@ exports.elementAttributes = {
     uniqueName: "uniqueName",
     queryTableFieldId: "queryTableFieldId",
     reference: "ref",
+    sqref: "sqref",
     tableColumnId: "tableColumnId",
     nextId: "nextId",
     row: "r",
@@ -115,13 +121,14 @@ exports.dataTypeKind = {
 exports.elementAttributesValues = {
     connectionName: (queryName) => `Query - ${queryName}`,
     connectionDescription: (queryName) => `Connection to the '${queryName}' query in the workbook.`,
-    connection: (queryName) => `Provider=Microsoft.Mashup.OleDb.1;Data Source=$Workbook$;Location=${queryName};`,
+    connection: (queryName) => `Provider=Microsoft.Mashup.OleDb.1;Data Source=$Workbook$;Location="${queryName}";`,
     connectionCommand: (queryName) => `SELECT * FROM [${queryName}]`,
-    tableResultType: () => "sTable"
+    tableResultType: () => "sTable",
 };
 exports.defaults = {
     queryName: "Query1",
-    sheetName: "Sheet1"
+    sheetName: "Sheet1",
+    columnName: "Column",
 };
 exports.URLS = {
     PQ: [

package/dist/utils/documentUtils.js

@@ -59,12 +59,12 @@ const createCellElement = (doc, colIndex, rowIndex, data) => {
     const cell = doc.createElementNS(doc.documentElement.namespaceURI, constants_1.element.kindCell);
     cell.setAttribute(constants_1.elementAttributes.row, getCellReferenceRelative(colIndex, rowIndex + 1));
     const cellData = doc.createElementNS(doc.documentElement.namespaceURI, constants_1.element.cellValue);
-    updateCellData(data, cell, cellData);
+    updateCellData(data, cell, cellData, rowIndex === 0);
     cell.appendChild(cellData);
     return cell;
 };
-const updateCellData = (data, cell, cellData) => {
-    switch (resolveType(data)) {
+const updateCellData = (data, cell, cellData, rowHeader) => {
+    switch (resolveType(data, rowHeader)) {
         case types_1.DataTypes.string:
             cell.setAttribute(constants_1.element.text, constants_1.dataTypeKind.string);
             break;
@@ -77,11 +77,15 @@ const updateCellData = (data, cell, cellData) => {
     }
     cellData.textContent = data;
 };
-const resolveType = (originalData) => {
+const resolveType = (originalData, rowHeader) => {
     const data = originalData;
+    if (rowHeader) {
+        // Headers should be string by default.
+        return types_1.DataTypes.string;
+    }
     let dataType = isNaN(Number(data)) ? types_1.DataTypes.string : types_1.DataTypes.number;
     if (dataType == types_1.DataTypes.string) {
-        if (data.toLowerCase().trim() == constants_1.trueStr || data.toLowerCase().trim() == constants_1.falseStr) {
+        if (data.trim() == constants_1.trueStr || data.trim() == constants_1.falseStr) {
             dataType = types_1.DataTypes.boolean;
         }
     }

package/dist/utils/gridUtils.js

@@ -0,0 +1,103 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../utils/constants");
+const parseToTableData = (grid) => {
+    var _a, _b, _c, _d;
+    if (grid === null || grid === undefined) {
+        grid = { data: [] };
+    }
+    if (grid.data === null || grid.data === undefined) {
+        grid.data = [];
+    }
+    const mergedGrid = {
+        config: {
+            promoteHeaders: (_b = (_a = grid.config) === null || _a === void 0 ? void 0 : _a.promoteHeaders) !== null && _b !== void 0 ? _b : false,
+            adjustColumnNames: (_d = (_c = grid.config) === null || _c === void 0 ? void 0 : _c.adjustColumnNames) !== null && _d !== void 0 ? _d : true,
+        },
+        data: grid.data.map((row) => row.map((value) => { var _a; return (_a = value === null || value === void 0 ? void 0 : value.toString()) !== null && _a !== void 0 ? _a : ""; })),
+    };
+    correctGrid(mergedGrid);
+    validateGrid(mergedGrid);
+    let columnNames = [];
+    if (mergedGrid.config.promoteHeaders && mergedGrid.config.adjustColumnNames) {
+        columnNames = getAdjustedColumnNames(mergedGrid.data.shift());
+    }
+    else if (mergedGrid.config.promoteHeaders && !mergedGrid.config.adjustColumnNames) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        columnNames = mergedGrid.data.shift();
+    }
+    else {
+        columnNames = Array.from({ length: mergedGrid.data[0].length }, (_, index) => `${constants_1.defaults.columnName} ${index + 1}`);
+    }
+    return { columnNames: columnNames, rows: mergedGrid.data };
+};
+const correctGrid = (grid) => {
+    if (grid.data.length === 0) {
+        // empty grid fix
+        grid.config.promoteHeaders = false;
+        grid.data.push([""]);
+        return;
+    }
+    const getEmptyArray = (n) => Array.from({ length: n }, () => "");
+    if (grid.data[0].length === 0) {
+        grid.data[0] = [""];
+    }
+    // replace empty rows
+    grid.data.forEach((row, index) => {
+        if (row.length === 0) {
+            grid.data[index] = getEmptyArray(grid.data[0].length);
+        }
+    });
+    if (grid.config.promoteHeaders && grid.data.length === 1) {
+        // table in Excel should have at least 2 rows
+        grid.data.push(getEmptyArray(grid.data[0].length));
+    }
+};
+/*
+ * Validates the grid, throws an error if the grid is invalid.
+ * A valid grid has:
+ * - MxN structure.
+ * - If promoteHeaders is true - has at least 1 row, and in case adjustColumnNames is false, first row is unique and non empty.
+ */
+const validateGrid = (grid) => {
+    validateDataArrayDimensions(grid.data);
+    if (grid.config.promoteHeaders && grid.config.adjustColumnNames === false && !validateUniqueAndValidDataArray(grid.data[0])) {
+        throw new Error(constants_1.promotedHeadersCannotBeUsedWithoutAdjustingColumnNamesErr);
+    }
+};
+const validateDataArrayDimensions = (arr) => {
+    if (arr.length === 0 || arr[0].length === 0) {
+        throw new Error(constants_1.unexpectedErr);
+    }
+    if (!arr.every((innerArr) => innerArr.length === arr[0].length)) {
+        throw new Error(constants_1.arrayIsntMxNErr);
+    }
+};
+const validateUniqueAndValidDataArray = (arr) => {
+    if (arr.some((element) => element === "")) {
+        return false; // Array contains empty elements
+    }
+    const uniqueSet = new Set(arr);
+    return uniqueSet.size === arr.length;
+};
+const getAdjustedColumnNames = (columnNames) => {
+    if (columnNames === undefined) {
+        throw new Error(constants_1.unexpectedErr);
+    }
+    let i = 1;
+    // replace empty column names with default names, can still conflict if columns exist, but we handle that later
+    columnNames = columnNames.map((columnName) => columnName || `${constants_1.defaults.columnName} ${i++}`);
+    const uniqueNames = new Set();
+    return columnNames.map((name) => {
+        let uniqueName = name;
+        i = 1;
+        while (uniqueNames.has(uniqueName)) {
+            uniqueName = `${name} (${i++})`;
+        }
+        uniqueNames.add(uniqueName);
+        return uniqueName;
+    });
+};
+exports.default = { parseToTableData };

package/dist/utils/htmlUtils.js

@@ -1,8 +1,8 @@
 "use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractTableValues = void 0;
 const extractTableValues = (table) => {
-    const headers = [];
     const rows = [];
     // Extract values from each row
     for (let i = 0; i < table.rows.length; i++) {
@@ -16,4 +16,4 @@ const extractTableValues = (table) => {
     }
     return rows;
 };
-exports.extractTableValues = extractTableValues;
+exports.default = { extractTableValues };

package/dist/utils/index.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tableUtils = exports.xmlInnerPartsUtils = exports.xmlPartsUtils = exports.documentUtils = exports.arrayUtils = exports.pqUtils = void 0;
+exports.gridUtils = exports.htmlUtils = exports.tableUtils = exports.xmlInnerPartsUtils = exports.xmlPartsUtils = exports.documentUtils = exports.arrayUtils = exports.pqUtils = void 0;
 var pqUtils_1 = require("./pqUtils");
 Object.defineProperty(exports, "pqUtils", { enumerable: true, get: function () { return __importDefault(pqUtils_1).default; } });
 var arrayUtils_1 = require("./arrayUtils");
@@ -18,3 +18,7 @@ var xmlInnerPartsUtils_1 = require("./xmlInnerPartsUtils");
 Object.defineProperty(exports, "xmlInnerPartsUtils", { enumerable: true, get: function () { return __importDefault(xmlInnerPartsUtils_1).default; } });
 var tableUtils_1 = require("./tableUtils");
 Object.defineProperty(exports, "tableUtils", { enumerable: true, get: function () { return __importDefault(tableUtils_1).default; } });
+var htmlUtils_1 = require("./htmlUtils");
+Object.defineProperty(exports, "htmlUtils", { enumerable: true, get: function () { return __importDefault(htmlUtils_1).default; } });
+var gridUtils_1 = require("./gridUtils");
+Object.defineProperty(exports, "gridUtils", { enumerable: true, get: function () { return __importDefault(gridUtils_1).default; } });

package/dist/utils/mashupDocumentParser.js

@@ -37,17 +37,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceSingleQuery = void 0;
+exports.editSingleQueryMetadata = exports.getPackageComponents = exports.replaceSingleQuery = void 0;
 const base64 = __importStar(require("base64-js"));
 const jszip_1 = __importDefault(require("jszip"));
 const constants_1 = require("./constants");
 const _1 = require(".");
 const replaceSingleQuery = (base64Str, queryName, queryMashupDoc) => __awaiter(void 0, void 0, void 0, function* () {
-    const { version, packageOPC, permissionsSize, permissions, metadata, endBuffer } = getPackageComponents(base64Str);
+    const { version, packageOPC, permissionsSize, permissions, metadata, endBuffer } = (0, exports.getPackageComponents)(base64Str);
     const newPackageBuffer = yield editSingleQueryPackage(packageOPC, queryMashupDoc);
     const packageSizeBuffer = _1.arrayUtils.getInt32Buffer(newPackageBuffer.byteLength);
     const permissionsSizeBuffer = _1.arrayUtils.getInt32Buffer(permissionsSize);
-    const newMetadataBuffer = editSingleQueryMetadata(metadata, { queryName });
+    const newMetadataBuffer = (0, exports.editSingleQueryMetadata)(metadata, { queryName });
     const metadataSizeBuffer = _1.arrayUtils.getInt32Buffer(newMetadataBuffer.byteLength);
     const newMashup = _1.arrayUtils.concatArrays(version, packageSizeBuffer, newPackageBuffer, permissionsSizeBuffer, permissions, metadataSizeBuffer, newMetadataBuffer, endBuffer);
     return base64.fromByteArray(newMashup);
@@ -73,6 +73,7 @@ const getPackageComponents = (base64Str) => {
         endBuffer,
     };
 };
+exports.getPackageComponents = getPackageComponents;
 const editSingleQueryPackage = (packageOPC, queryMashupDoc) => __awaiter(void 0, void 0, void 0, function* () {
     const packageZip = yield jszip_1.default.loadAsync(packageOPC);
     setSection1m(queryMashupDoc, packageZip);
@@ -89,7 +90,6 @@ const setSection1m = (queryMashupDoc, zip) => {
     });
 };
 const editSingleQueryMetadata = (metadataArray, metadata) => {
-    var _a;
     //extract metadataXml
     const mashupArray = new _1.arrayUtils.ArrayReader(metadataArray.buffer);
     const metadataVersion = mashupArray.getBytes(4);
@@ -110,7 +110,7 @@ const editSingleQueryMetadata = (metadataArray, metadata) => {
             const content = itemPath.innerHTML;
             if (content.includes(constants_1.section1PathPrefix)) {
                 const strArr = content.split(constants_1.divider);
-                strArr[1] = metadata.queryName;
+                strArr[1] = encodeURIComponent(metadata.queryName);
                 const newContent = strArr.join(constants_1.divider);
                 itemPath.textContent = newContent;
             }
@@ -125,28 +125,9 @@ const editSingleQueryMetadata = (metadataArray, metadata) => {
             const entryProp = entryAttributesArr.find((prop) => {
                 return (prop === null || prop === void 0 ? void 0 : prop.name) === constants_1.elementAttributes.type;
             });
-            if ((entryProp === null || entryProp === void 0 ? void 0 : entryProp.nodeValue) == constants_1.elementAttributes.relationshipInfo) {
-                const newValue = (_a = entry
-                    .getAttribute(constants_1.elementAttributes.value)) === null || _a === void 0 ? void 0 : _a.replace(/Query1/g, metadata.queryName);
-                if (newValue) {
-                    entry.setAttribute(constants_1.elementAttributes.value, newValue);
-                }
-            }
             if ((entryProp === null || entryProp === void 0 ? void 0 : entryProp.nodeValue) == constants_1.elementAttributes.resultType) {
                 entry.setAttribute(constants_1.elementAttributes.value, constants_1.elementAttributesValues.tableResultType());
             }
-            if ((entryProp === null || entryProp === void 0 ? void 0 : entryProp.nodeValue) == constants_1.elementAttributes.fillColumnNames) {
-                const oldValue = entry.getAttribute(constants_1.elementAttributes.value);
-                if (oldValue) {
-                    entry.setAttribute(constants_1.elementAttributes.value, oldValue.replace(constants_1.defaults.queryName, metadata.queryName));
-                }
-            }
-            if ((entryProp === null || entryProp === void 0 ? void 0 : entryProp.nodeValue) == constants_1.elementAttributes.fillTarget) {
-                const oldValue = entry.getAttribute(constants_1.elementAttributes.value);
-                if (oldValue) {
-                    entry.setAttribute(constants_1.elementAttributes.value, oldValue.replace(constants_1.defaults.queryName, metadata.queryName));
-                }
-            }
             if ((entryProp === null || entryProp === void 0 ? void 0 : entryProp.nodeValue) == constants_1.elementAttributes.fillLastUpdated) {
                 const nowTime = new Date().toISOString();
                 entry.setAttribute(constants_1.elementAttributes.value, (constants_1.elementAttributes.day + nowTime).replace(/Z/, "0000Z"));
@@ -161,3 +142,4 @@ const editSingleQueryMetadata = (metadataArray, metadata) => {
     const newMetadataArray = _1.arrayUtils.concatArrays(metadataVersion, newMetadataXmlSize, newMetadataXml, endBuffer);
     return newMetadataArray;
 };
+exports.editSingleQueryMetadata = editSingleQueryMetadata;