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

package/README.md

@@ -374,9 +374,9 @@ Advanced customization options.
 
 ```typescript
 interface FileConfigs {
-  templateFile?: File;              // Custom Excel template
-  docProps?: DocProps;              // Document metadata
-  hostName?: string;                // Creator application name
+  templateFile?: File | Buffer;        // Custom Excel template
+  docProps?: DocProps;                 // Document metadata
+  hostName?: string;                   // Creator application name
   TempleteSettings?: TempleteSettings; // Template-specific settings
 }
 

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 export interface QueryInfo {
     refreshOnOpen: boolean;
     queryMashup: string;
@@ -29,7 +30,7 @@ export interface GridConfig {
     adjustColumnNames?: boolean;
 }
 export interface FileConfigs {
-    templateFile?: File;
+    templateFile?: File | Buffer;
     docProps?: DocProps;
     hostName?: string;
     templateSettings?: TemplateSettings;

package/dist/utils/constants.js

@@ -1,52 +1,8 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customXML = exports.OFU = exports.headers = exports.URLS = exports.defaults = exports.elementAttributesValues = exports.dataTypeKind = exports.elementAttributes = exports.element = exports.Errors = exports.customXmlXmlPath = exports.contentTypesXmlPath = exports.docPropsAppXmlPath = exports.labelInfoXmlPath = exports.workbookRelsXmlPath = exports.docPropsRootElement = exports.docMetadataXmlPath = exports.relsXmlPath = exports.docPropsCoreXmlPath = exports.section1mPath = exports.pivotCachesPath = exports.tablesFolderPath = exports.queryTablesPath = exports.workbookXmlPath = exports.queryTableXmlPath = exports.tableXmlPath = exports.sheetsXmlPath = exports.sharedStringsXmlPath = exports.connectionsXmlPath = exports.maxCellCharacters = 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 = void 0;
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trueValue = exports.pivotCachesPathPrefix = exports.xmlTextResultType = exports.textResultType = exports.application = exports.uint8ArrayType = exports.blobFileType = exports.columnIndexOutOfRangeErr = exports.xlRelsNotFoundErr = exports.relsNotFoundErr = exports.arrayIsntMxNErr = exports.unexpectedErr = exports.promotedHeadersCannotBeUsedWithoutAdjustingColumnNamesErr = exports.InvalidColumnNameErr = exports.stylesNotFoundErr = exports.EmptyQueryNameErr = exports.QueryNameInvalidCharsErr = exports.QueryNameMaxLengthErr = exports.invalidDataTypeErr = exports.headerNotFoundErr = exports.invalidValueInColumnErr = exports.tableReferenceNotFoundErr = exports.tableNotFoundErr = exports.queryTableNotFoundErr = exports.templateWithInitialDataErr = exports.formulaSectionNotFoundErr = exports.queryConnectionNotFoundErr = exports.queryAndPivotTableNotFoundErr = exports.queryNameNotFoundErr = exports.emptyQueryMashupErr = exports.base64NotFoundErr = exports.sheetsNotFoundErr = exports.WorkbookNotFoundERR = exports.connectionsNotFoundErr = exports.sharedStringsNotFoundErr = exports.workbookRelsXmlPath = exports.docPropsRootElement = exports.docMetadataXmlPath = exports.relsXmlPath = exports.docPropsCoreXmlPath = exports.section1mPath = exports.pivotCachesPath = exports.tablesFolderPath = exports.queryTablesPath = exports.workbookXmlPath = exports.queryTableXmlPath = exports.tableXmlPath = exports.sheetsXmlPath = exports.sharedStringsXmlPath = exports.connectionsXmlPath = void 0;
-exports.OFU = exports.headers = exports.URLS = 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 = void 0;
-exports.connectionsXmlPath = "xl/connections.xml";
-exports.sharedStringsXmlPath = "xl/sharedStrings.xml";
-exports.sheetsXmlPath = "xl/worksheets/sheet1.xml";
-exports.tableXmlPath = "xl/tables/table1.xml";
-exports.queryTableXmlPath = "xl/queryTables/queryTable1.xml";
-exports.workbookXmlPath = "xl/workbook.xml";
-exports.queryTablesPath = "xl/queryTables/";
-exports.tablesFolderPath = "xl/tables/";
-exports.pivotCachesPath = "xl/pivotCache/";
-exports.section1mPath = "Formulas/Section1.m";
-exports.docPropsCoreXmlPath = "docProps/core.xml";
-exports.relsXmlPath = "_rels/.rels";
-exports.docMetadataXmlPath = "docMetadata";
-exports.docPropsRootElement = "cp:coreProperties";
-exports.workbookRelsXmlPath = "xl/_rels/workbook.xml.rels";
-exports.sharedStringsNotFoundErr = "SharedStrings were not found in template";
-exports.connectionsNotFoundErr = "Connections were not found in template";
-exports.WorkbookNotFoundERR = "workbook was not found in template";
-exports.sheetsNotFoundErr = "Sheets were not found in template";
-exports.base64NotFoundErr = "Base64 was not found in template";
-exports.emptyQueryMashupErr = "Query mashup is empty";
-exports.queryNameNotFoundErr = "Query name was not found";
-exports.queryAndPivotTableNotFoundErr = "No such query found in Query Table or Pivot Table found in given template";
-exports.queryConnectionNotFoundErr = "No connection found for query";
-exports.formulaSectionNotFoundErr = "Formula section wasn't found in template";
-exports.templateWithInitialDataErr = "Cannot use a template file with initial data";
-exports.queryTableNotFoundErr = "Query table wasn't found in template";
-exports.tableNotFoundErr = "Table wasn't found in template";
-exports.tableReferenceNotFoundErr = "Reference not found in the table XML.";
-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.relsNotFoundErr = ".rels were not found in template";
-exports.xlRelsNotFoundErr = "workbook.xml.rels were not found xl";
-exports.columnIndexOutOfRangeErr = "Column index out of range";
 exports.blobFileType = "blob";
 exports.uint8ArrayType = "uint8array";
 exports.application = "application/xlsx";
@@ -62,6 +18,72 @@ exports.maxQueryLength = 80;
 exports.trueStr = "true";
 exports.falseStr = "false";
 exports.BOM = "\ufeff";
+exports.maxCellCharacters = 32767;
+exports.connectionsXmlPath = "xl/connections.xml";
+exports.sharedStringsXmlPath = "xl/sharedStrings.xml";
+exports.sheetsXmlPath = "xl/worksheets/sheet1.xml";
+exports.tableXmlPath = "xl/tables/table1.xml";
+exports.queryTableXmlPath = "xl/queryTables/queryTable1.xml";
+exports.workbookXmlPath = "xl/workbook.xml";
+exports.queryTablesPath = "xl/queryTables/";
+exports.tablesFolderPath = "xl/tables/";
+exports.pivotCachesPath = "xl/pivotCache/";
+exports.section1mPath = "Formulas/Section1.m";
+exports.docPropsCoreXmlPath = "docProps/core.xml";
+exports.relsXmlPath = "_rels/.rels";
+exports.docMetadataXmlPath = "docMetadata";
+exports.docPropsRootElement = "cp:coreProperties";
+exports.workbookRelsXmlPath = "xl/_rels/workbook.xml.rels";
+exports.labelInfoXmlPath = "docMetadata/LabelInfo.xml";
+exports.docPropsAppXmlPath = "docProps/app.xml";
+exports.contentTypesXmlPath = "[Content_Types].xml";
+exports.customXmlXmlPath = "customXml";
+exports.Errors = {
+    sharedStringsNotFound: "SharedStrings were not found in template",
+    connectionsNotFound: "Connections were not found in template",
+    workbookNotFound: "workbook was not found in template",
+    sheetsNotFound: "Sheets were not found in template",
+    base64NotFound: "Base64 was not found in template",
+    emptyQueryMashup: "Query mashup is empty",
+    queryNameNotFound: "Query name was not found",
+    queryAndPivotTableNotFound: "No such query found in Query Table or Pivot Table found in given template",
+    queryConnectionNotFound: "No connection found for query",
+    formulaSectionNotFound: "Formula section wasn't found in template",
+    templateWithInitialData: "Cannot use a template file with initial data",
+    queryTableNotFound: "Query table wasn't found in template",
+    tableNotFound: "Table wasn't found in template",
+    tableReferenceNotFound: "Reference not found in the table XML.",
+    invalidValueInColumn: "Invalid cell value in column",
+    headerNotFound: "Invalid JSON file, header is missing",
+    invalidDataType: "Invalid JSON file, invalid data type",
+    queryNameMaxLength: "Query names are limited to 80 characters",
+    queryNameInvalidChars: 'Query names cannot contain periods or quotation marks. (. ")',
+    emptyQueryName: "Query name cannot be empty",
+    stylesNotFound: "Styles were not found in template",
+    invalidColumnName: "Invalid column name",
+    promotedHeadersCannotBeUsedWithoutAdjustingColumnNames: "Headers cannot be promoted without adjusting column names",
+    unexpected: "Unexpected error",
+    arrayIsntMxN: "Array isn't MxN",
+    relsNotFound: ".rels were not found in template",
+    xlRelsNotFound: "workbook.xml.rels were not found xl",
+    columnIndexOutOfRange: "Column index out of range",
+    relationship: "Relationship not found",
+    contentTypesNotFound: "contentTypes was not found in file",
+    contentTypesParse: "Failed to parse [Content_Types].xml: Invalid XML structure",
+    contentTypesElementNotFound: "contentTypes element was not found in parsed document",
+    workbookRelsParse: "Failed to parse workbook relationships XML: Invalid XML structure",
+    xmlParse: "Failed to parse XML: Parser error detected",
+    relsParse: "Failed to parse .rels XML",
+    connectionsParse: "Failed to parse connections XML",
+    sharedStringsParse: "Failed to parse shared strings XML",
+    worksheetParse: "Failed to parse worksheet XML",
+    queryTableParse: "Failed to parse query table XML",
+    pivotTableParse: "Failed to parse pivot table XML",
+    workbookParse: "Failed to parse workbook XML",
+    tableParse: "Failed to parse table XML",
+    tablePathParse: "Failed to parse table XML for",
+    invalidCellValueErr: "Cell content exceeds maximum length of " + exports.maxCellCharacters + " characters",
+};
 exports.element = {
     sharedStringTable: "sst",
     text: "t",
@@ -91,6 +113,9 @@ exports.element = {
     selection: "selection",
     kindCell: "c",
     sheet: "sheet",
+    override: "Override",
+    relationship: "Relationship",
+    relationships: "Relationships",
 };
 exports.elementAttributes = {
     connection: "connection",
@@ -104,7 +129,11 @@ exports.elementAttributes = {
     name: "name",
     description: "description",
     id: "id",
+    Id: "Id",
     relationId: "r:id",
+    relationId1: "RId1",
+    relationId2: "RId2",
+    relationId3: "RId3",
     type: "Type",
     value: "Value",
     relationshipInfo: "RelationshipInfoContainer",
@@ -125,6 +154,9 @@ exports.elementAttributes = {
     xr3uid: "xr3:uid",
     space: "xml:space",
     target: "Target",
+    partName: "PartName",
+    contentType: "ContentType",
+    relationshipIdPrefix: "rId",
 };
 exports.dataTypeKind = {
     string: "str",
@@ -135,7 +167,7 @@ exports.elementAttributesValues = {
     connectionName: function (queryName) { return "Query - ".concat(queryName); },
     connectionDescription: function (queryName) { return "Connection to the '".concat(queryName, "' query in the workbook."); },
     connection: function (queryName) { return "Provider=Microsoft.Mashup.OleDb.1;Data Source=$Workbook$;Location=\"".concat(queryName, "\";"); },
-    connectionCommand: function (queryName) { return "SELECT * FROM [".concat(queryName, "]"); },
+    connectionCommand: function (queryName) { return "SELECT * FROM [".concat(queryName.replace(/]/g, ']]'), "]"); },
     tableResultType: function () { return "sTable"; },
 };
 exports.defaults = {
@@ -164,3 +196,18 @@ exports.OFU = {
     WdOrigin: "wdOrigin",
     OpenInExcelOririgin: "OpenInExcel",
 };
+exports.customXML = {
+    customXMLItemContent: "<?xml version=\"1.0\" encoding=\"utf-8\"?><ConnectedWorkbook xmlns=\"http://schemas.microsoft.com/ConnectedWorkbook\" version=\"1.0.0\"></ConnectedWorkbook>",
+    customXMLItemPropsContent: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<ds:datastoreItem ds:itemID=\"{0B384C3C-E1D4-401B-8CF4-6285949D7671}\" xmlns:ds=\"http://schemas.openxmlformats.org/officeDocument/2006/customXml\"><ds:schemaRefs><ds:schemaRef ds:uri=\"http://schemas.microsoft.com/ConnectedWorkbook\"/></ds:schemaRefs></ds:datastoreItem>",
+    connectedWorkbookTag: '<ConnectedWorkbook',
+    itemNumberPattern: /item(\d+)\.xml$/,
+    itemFilePattern: /^item\d+\.xml$/,
+    itemPropsPartNameTemplate: function (itemIndex) { return "/customXml/itemProps".concat(itemIndex, ".xml"); },
+    contentType: "application/vnd.openxmlformats-officedocument.customXmlProperties+xml",
+    itemPathTemplate: function (itemNumber) { return "customXml/item".concat(itemNumber, ".xml"); },
+    itemPropsPathTemplate: function (itemNumber) { return "customXml/itemProps".concat(itemNumber, ".xml"); },
+    itemRelsPathTemplate: function (itemNumber) { return "customXml/_rels/item".concat(itemNumber, ".xml.rels"); },
+    customXMLRelationships: function (itemNumber) { return "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<Relationships xmlns=\"http://schemas.openxmlformats.org/package/2006/relationships\"><Relationship Id=\"rId1\" Type=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXmlProps\" Target=\"itemProps".concat(itemNumber, ".xml\"/></Relationships>"); },
+    relationshipType: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml",
+    relativeItemPathTemplate: function (itemNumber) { return "../customXml/item".concat(itemNumber, ".xml"); },
+};

package/dist/utils/documentUtils.js

@@ -87,7 +87,7 @@ var getCellReferenceRelative = function (col, row) {
 };
 var convertToExcelColumn = function (index) {
     if (index >= 16384) {
-        throw new Error(constants_1.columnIndexOutOfRangeErr);
+        throw new Error(constants_1.Errors.columnIndexOutOfRange);
     }
     var columnStr = "";
     var base = 26; // number of letters in the alphabet
@@ -104,7 +104,7 @@ var convertToExcelColumn = function (index) {
  * @returns Object with numeric row and column.
  */
 var GetStartPosition = function (cellRangeRef) {
-    var match = cellRangeRef.toUpperCase().match(/^([A-Z]+)(\d+):/);
+    var match = cellRangeRef.toUpperCase().match(/^([A-Z]+)(\d+)/);
     if (!match) {
         return { row: 0, column: 0 };
     }

package/dist/utils/gridUtils.js

@@ -64,15 +64,15 @@ var correctGrid = function (grid) {
 var validateGrid = function (grid) {
     validateDataArrayDimensions(grid.data);
     if (grid.config.promoteHeaders && grid.config.adjustColumnNames === false && !validateUniqueAndValidDataArray(grid.data[0])) {
-        throw new Error(constants_1.promotedHeadersCannotBeUsedWithoutAdjustingColumnNamesErr);
+        throw new Error(constants_1.Errors.promotedHeadersCannotBeUsedWithoutAdjustingColumnNames);
     }
 };
 var validateDataArrayDimensions = function (arr) {
     if (arr.length === 0 || arr[0].length === 0) {
-        throw new Error(constants_1.unexpectedErr);
+        throw new Error(constants_1.Errors.unexpected);
     }
     if (!arr.every(function (innerArr) { return innerArr.length === arr[0].length; })) {
-        throw new Error(constants_1.arrayIsntMxNErr);
+        throw new Error(constants_1.Errors.arrayIsntMxN);
     }
 };
 var validateUniqueAndValidDataArray = function (arr) {
@@ -84,7 +84,7 @@ var validateUniqueAndValidDataArray = function (arr) {
 };
 var getAdjustedColumnNames = function (columnNames) {
     if (columnNames === undefined) {
-        throw new Error(constants_1.unexpectedErr);
+        throw new Error(constants_1.Errors.unexpected);
     }
     var i = 1;
     // replace empty column names with default names, can still conflict if columns exist, but we handle that later

package/dist/utils/mashupDocumentParser.js

@@ -126,7 +126,7 @@ var editSingleQueryPackage = function (packageOPC, queryMashupDoc) { return __aw
 var setSection1m = function (queryMashupDoc, zip) {
     var _a;
     if (!((_a = zip.file(constants_1.section1mPath)) === null || _a === void 0 ? void 0 : _a.async(constants_1.textResultType))) {
-        throw new Error(constants_1.formulaSectionNotFoundErr);
+        throw new Error(constants_1.Errors.formulaSectionNotFound);
     }
     var newSection1m = queryMashupDoc;
     zip.file(constants_1.section1mPath, newSection1m, {

package/dist/utils/pqUtils.js

@@ -159,14 +159,14 @@ var queryNameHasInvalidChars = function (queryName) {
 var validateQueryName = function (queryName) {
     if (queryName) {
         if (queryName.length > constants_1.maxQueryLength) {
-            throw new Error(constants_1.QueryNameMaxLengthErr);
+            throw new Error(constants_1.Errors.queryNameMaxLength);
         }
         if (queryNameHasInvalidChars(queryName)) {
-            throw new Error(constants_1.QueryNameInvalidCharsErr);
+            throw new Error(constants_1.Errors.queryNameInvalidChars);
         }
     }
     if (!queryName.trim()) {
-        throw new Error(constants_1.EmptyQueryNameErr);
+        throw new Error(constants_1.Errors.emptyQueryName);
     }
 };
 var detectEncoding = function (xmlBytes) {

package/dist/utils/tableUtils.js

@@ -68,7 +68,7 @@ var updateTableInitialDataIfNeeded = function (zip, cellRangeRef, sheetPath, tab
             case 1:
                 sheetsXmlString = _e.sent();
                 if (sheetsXmlString === undefined) {
-                    throw new Error(constants_1.sheetsNotFoundErr);
+                    throw new Error(constants_1.Errors.sheetsNotFound);
                 }
                 newSheet = updateSheetsInitialData(sheetsXmlString, tableData, cellRangeRef);
                 zip.file(sheetPath, newSheet);
@@ -77,7 +77,7 @@ var updateTableInitialDataIfNeeded = function (zip, cellRangeRef, sheetPath, tab
             case 2:
                 queryTableXmlString = _e.sent();
                 if (queryTableXmlString === undefined) {
-                    throw new Error(constants_1.queryTableNotFoundErr);
+                    throw new Error(constants_1.Errors.queryTableNotFound);
                 }
                 return [4 /*yield*/, updateQueryTablesInitialData(queryTableXmlString, tableData)];
             case 3:
@@ -87,7 +87,7 @@ var updateTableInitialDataIfNeeded = function (zip, cellRangeRef, sheetPath, tab
             case 4:
                 workbookXmlString = _e.sent();
                 if (workbookXmlString === undefined) {
-                    throw new Error(constants_1.sheetsNotFoundErr);
+                    throw new Error(constants_1.Errors.workbookNotFound);
                 }
                 newWorkbook = updateWorkbookInitialData(workbookXmlString, sheetName + GenerateReferenceFromString(cellRangeRef));
                 zip.file(constants_1.workbookXmlPath, newWorkbook);
@@ -96,7 +96,7 @@ var updateTableInitialDataIfNeeded = function (zip, cellRangeRef, sheetPath, tab
             case 6:
                 tableXmlString = _e.sent();
                 if (tableXmlString === undefined) {
-                    throw new Error(constants_1.tableNotFoundErr);
+                    throw new Error(constants_1.Errors.tableNotFound);
                 }
                 newTable = updateTablesInitialData(tableXmlString, tableData, cellRangeRef, updateQueryTable);
                 zip.file(tablePath, newTable);
@@ -189,6 +189,7 @@ var updateSheetsInitialData = function (sheetsXmlString, tableData, cellRangeRef
     columnRow.setAttribute(constants_1.elementAttributes.spans, column + ":" + (column + tableData.columnNames.length - 1));
     columnRow.setAttribute(constants_1.elementAttributes.x14acDyDescent, "0.3");
     tableData.columnNames.forEach(function (col, colIndex) {
+        validateCellContentLength(col);
         columnRow.appendChild(documentUtils_1.default.createCell(sheetsDoc, colIndex + column - 1, row - 1, col));
     });
     sheetData.appendChild(columnRow);
@@ -199,6 +200,7 @@ var updateSheetsInitialData = function (sheetsXmlString, tableData, cellRangeRef
         newRow.setAttribute(constants_1.elementAttributes.spans, column + ":" + (column + tableData.columnNames.length - 1));
         newRow.setAttribute(constants_1.elementAttributes.x14acDyDescent, "0.3");
         _row.forEach(function (cellContent, colIndex) {
+            validateCellContentLength(cellContent);
             newRow.appendChild(documentUtils_1.default.createCell(sheetsDoc, colIndex + column - 1, row - 1, cellContent));
         });
         sheetData.appendChild(newRow);
@@ -208,6 +210,11 @@ var updateSheetsInitialData = function (sheetsXmlString, tableData, cellRangeRef
     sheetsDoc.getElementsByTagName(constants_1.element.selection)[0].setAttribute(constants_1.elementAttributes.sqref, cellRangeRef);
     return serializer.serializeToString(sheetsDoc);
 };
+var validateCellContentLength = function (cellContent) {
+    if (cellContent.length > constants_1.maxCellCharacters) {
+        throw new Error(constants_1.Errors.invalidCellValueErr);
+    }
+};
 /**
  * Add Excel-style dollar signs and a '!' prefix to a cell range.
  * Converts "A1:B2" into "!$A$1:$B$2".