@microsoft/connected-workbooks 3.1.3-beta → 3.2.0-beta

package/dist/src/utils/constants.js

@@ -151,5 +151,7 @@ exports.headers = {
 exports.OFU = {
     ViewUrl: "https://view.officeapps.live.com/op/view.aspx?src=http://connectedWorkbooks.excel/",
     PostUrl: "https://view.officeapps.live.com/op/viewpost.aspx?src=http://connectedWorkbooks.excel/",
-    allowTyping: "AllowTyping",
+    AllowTyping: "AllowTyping",
+    WdOrigin: "wdOrigin",
+    OpenInExcelOririgin: "OpenInExcel",
 };

package/dist/src/utils/pqUtils.js

@@ -124,11 +124,13 @@ var getCustomXmlFile = function (zip, url) { return __awaiter(void 0, void 0, vo
                     return [3 /*break*/, 5];
                 }
                 buffer = buffer_1.Buffer.from(xmlValue);
-                encoding = detectEncodingFromBOM(buffer);
-                if (null === encoding) {
-                    throw new Error("Unsupported encoding");
+                encoding = detectEncoding(xmlValue);
+                if (!encoding) {
+                    throw new Error("Failed to detect xml encoding");
                 }
-                xmlString = buffer.toString(encoding).replace(/^\ufeff/, "");
+                xmlString = buffer
+                    .toString(encoding)
+                    .replace(/^\ufeff/, "");
                 doc = parser.parseFromString(xmlString, "text/xml");
                 found = ((_b = doc === null || doc === void 0 ? void 0 : doc.documentElement) === null || _b === void 0 ? void 0 : _b.namespaceURI) === url;
                 if (found) {
@@ -167,27 +169,22 @@ var validateQueryName = function (queryName) {
         throw new Error(constants_1.EmptyQueryNameErr);
     }
 };
-function detectEncodingFromBOM(uint8Array) {
-    // Not enough data to determine encoding
-    if (!uint8Array || uint8Array.length < 2) {
+var detectEncoding = function (xmlBytes) {
+    if (!xmlBytes) {
         return null;
     }
-    // Check for UTF-8 BOM
-    if (uint8Array[0] === 0xef && uint8Array[1] === 0xbb && uint8Array[2] === 0xbf) {
-        return "UTF-8";
+    if (xmlBytes.length >= 3 && xmlBytes[0] === 0xEF && xmlBytes[1] === 0xBB && xmlBytes[2] === 0xBF) {
+        return 'utf-8';
     }
-    else if (uint8Array[0] === 0xfe && uint8Array[1] === 0xff) {
-        return "UTF-16b";
+    if (xmlBytes.length >= 3 && xmlBytes[0] === 0xFF && xmlBytes[1] === 0xFE) {
+        return 'utf-16le';
     }
-    else if (uint8Array[0] === 0xff && uint8Array[1] === 0xfe) {
-        return "UTF-16le";
+    if (xmlBytes.length >= 3 && xmlBytes[0] === 0xFE && xmlBytes[1] === 0xFF) {
+        return 'utf-16be';
     }
-    else {
-        // No BOM, reutrn UTF-8 as default
-        return "utf8";
-    }
-    return null;
-}
+    // Default to utf-8, that not required a BOM for encoding.
+    return 'utf-8';
+};
 exports.default = {
     getBase64: getBase64,
     setBase64: setBase64,

package/dist/utils/pqUtils.js

@@ -97,52 +97,54 @@ var getDataMashupFile = function (zip) { return __awaiter(void 0, void 0, void 0
         }
     });
 }); };
-var getCustomXmlFile = function (zip, url, encoding) {
-    if (encoding === void 0) { encoding = "utf16le"; }
-    return __awaiter(void 0, void 0, void 0, function () {
-        var parser, itemsArray, found, path, xmlString, value, i, xmlValue, doc;
-        var _a, _b;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    parser = new xmldom_qsa_1.DOMParser();
-                    return [4 /*yield*/, zip.file(/customXml\/item\d.xml/)];
-                case 1:
-                    itemsArray = _c.sent();
-                    if (!itemsArray || itemsArray.length === 0) {
-                        throw new Error("No customXml files were found!");
-                    }
-                    found = false;
-                    value = null;
-                    i = 1;
-                    _c.label = 2;
-                case 2:
-                    if (!(i <= itemsArray.length)) return [3 /*break*/, 5];
-                    path = (0, generators_1.generateCustomXmlFilePath)(i);
-                    return [4 /*yield*/, ((_a = zip.file(path)) === null || _a === void 0 ? void 0 : _a.async("uint8array"))];
-                case 3:
-                    xmlValue = _c.sent();
-                    if (xmlValue === undefined) {
-                        return [3 /*break*/, 5];
-                    }
-                    xmlString = buffer_1.Buffer.from(xmlValue)
-                        .toString(encoding)
-                        .replace(/^\ufeff/, "");
-                    doc = parser.parseFromString(xmlString, "text/xml");
-                    found = ((_b = doc === null || doc === void 0 ? void 0 : doc.documentElement) === null || _b === void 0 ? void 0 : _b.namespaceURI) === url;
-                    if (found) {
-                        value = doc.documentElement.textContent;
-                        return [3 /*break*/, 5];
-                    }
-                    _c.label = 4;
-                case 4:
-                    i++;
-                    return [3 /*break*/, 2];
-                case 5: return [2 /*return*/, { found: found, path: path, xmlString: xmlString, value: value }];
-            }
-        });
+var getCustomXmlFile = function (zip, url) { return __awaiter(void 0, void 0, void 0, function () {
+    var parser, itemsArray, found, path, xmlString, value, i, xmlValue, buffer, encoding, doc;
+    var _a, _b;
+    return __generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                parser = new xmldom_qsa_1.DOMParser();
+                return [4 /*yield*/, zip.file(/customXml\/item\d.xml/)];
+            case 1:
+                itemsArray = _c.sent();
+                if (!itemsArray || itemsArray.length === 0) {
+                    throw new Error("No customXml files were found!");
+                }
+                found = false;
+                value = null;
+                i = 1;
+                _c.label = 2;
+            case 2:
+                if (!(i <= itemsArray.length)) return [3 /*break*/, 5];
+                path = (0, generators_1.generateCustomXmlFilePath)(i);
+                return [4 /*yield*/, ((_a = zip.file(path)) === null || _a === void 0 ? void 0 : _a.async("uint8array"))];
+            case 3:
+                xmlValue = _c.sent();
+                if (xmlValue === undefined) {
+                    return [3 /*break*/, 5];
+                }
+                buffer = buffer_1.Buffer.from(xmlValue);
+                encoding = detectEncoding(xmlValue);
+                if (!encoding) {
+                    throw new Error("Failed to detect xml encoding");
+                }
+                xmlString = buffer
+                    .toString(encoding)
+                    .replace(/^\ufeff/, "");
+                doc = parser.parseFromString(xmlString, "text/xml");
+                found = ((_b = doc === null || doc === void 0 ? void 0 : doc.documentElement) === null || _b === void 0 ? void 0 : _b.namespaceURI) === url;
+                if (found) {
+                    value = doc.documentElement.textContent;
+                    return [3 /*break*/, 5];
+                }
+                _c.label = 4;
+            case 4:
+                i++;
+                return [3 /*break*/, 2];
+            case 5: return [2 /*return*/, { found: found, path: path, xmlString: xmlString, value: value }];
+        }
     });
-};
+}); };
 var queryNameHasInvalidChars = function (queryName) {
     var invalidQueryNameChars = ['"', "."];
     // Control characters as defined in Unicode
@@ -167,6 +169,22 @@ var validateQueryName = function (queryName) {
         throw new Error(constants_1.EmptyQueryNameErr);
     }
 };
+var detectEncoding = function (xmlBytes) {
+    if (!xmlBytes) {
+        return null;
+    }
+    if (xmlBytes.length >= 3 && xmlBytes[0] === 0xEF && xmlBytes[1] === 0xBB && xmlBytes[2] === 0xBF) {
+        return 'utf-8';
+    }
+    if (xmlBytes.length >= 3 && xmlBytes[0] === 0xFF && xmlBytes[1] === 0xFE) {
+        return 'utf-16le';
+    }
+    if (xmlBytes.length >= 3 && xmlBytes[0] === 0xFE && xmlBytes[1] === 0xFF) {
+        return 'utf-16be';
+    }
+    // Default to utf-8, that not required a BOM for encoding.
+    return 'utf-8';
+};
 exports.default = {
     getBase64: getBase64,
     setBase64: setBase64,

package/dist/workbookManager.d.ts

@@ -4,3 +4,4 @@ export declare const generateTableWorkbookFromHtml: (htmlTable: HTMLTableElement
 export declare const generateTableWorkbookFromGrid: (grid: Grid, fileConfigs?: FileConfigs) => Promise<Blob>;
 export declare const downloadWorkbook: (file: Blob, filename: string) => void;
 export declare const openInExcelWeb: (file: Blob, filename?: string, allowTyping?: boolean) => Promise<void>;
+export declare const getExcelForWebWorkbookUrl: (file: Blob, filename?: string, allowTyping?: boolean) => Promise<string>;

package/dist/workbookManager.js

@@ -41,7 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openInExcelWeb = exports.downloadWorkbook = exports.generateTableWorkbookFromGrid = exports.generateTableWorkbookFromHtml = exports.generateSingleQueryWorkbook = void 0;
+exports.getExcelForWebWorkbookUrl = exports.openInExcelWeb = exports.downloadWorkbook = exports.generateTableWorkbookFromGrid = exports.generateTableWorkbookFromHtml = exports.generateSingleQueryWorkbook = void 0;
 var jszip_1 = __importDefault(require("jszip"));
 var utils_1 = require("./utils");
 var workbookTemplate_1 = require("./workbookTemplate");
@@ -170,11 +170,34 @@ var downloadWorkbook = function (file, filename) {
 };
 exports.downloadWorkbook = downloadWorkbook;
 var openInExcelWeb = function (file, filename, allowTyping) { return __awaiter(void 0, void 0, void 0, function () {
-    var fileContent, fileNameGuid, allowTypingParam, response, error_1;
+    var url, error_1;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
-                if (!(file.size > 0)) return [3 /*break*/, 4];
+                _a.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, (0, exports.getExcelForWebWorkbookUrl)(file, filename, allowTyping)];
+            case 1:
+                url = _a.sent();
+                window.open(url, "_blank");
+                return [3 /*break*/, 3];
+            case 2:
+                error_1 = _a.sent();
+                console.error("An error occurred:", error_1);
+                return [3 /*break*/, 3];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+exports.openInExcelWeb = openInExcelWeb;
+var getExcelForWebWorkbookUrl = function (file, filename, allowTyping) { return __awaiter(void 0, void 0, void 0, function () {
+    var fileContent, fileNameGuid, allowTypingParam, response, error_2;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                // Check if the file exists
+                if (file.size < 0) {
+                    throw new Error("File is empty");
+                }
                 fileContent = file;
                 fileNameGuid = new Date().getTime().toString() + (filename ? "_" + filename : "") + ".xlsx";
                 allowTypingParam = allowTyping ? 1 : 0;
@@ -191,18 +214,17 @@ var openInExcelWeb = function (file, filename, allowTyping) { return __awaiter(v
                 // Check if the response is successful
                 if (response.ok) {
                     // if upload was successful - open the file in a new tab
-                    window.open("".concat(constants_1.OFU.ViewUrl).concat(fileNameGuid, "&").concat(constants_1.OFU.AllowTyping, "=").concat(allowTypingParam, "&").concat(constants_1.OFU.WdOrigin, "=").concat(constants_1.OFU.OpenInExcelOririgin), "_blank");
+                    return [2 /*return*/, "".concat(constants_1.OFU.ViewUrl).concat(fileNameGuid, "&").concat(constants_1.OFU.AllowTyping, "=").concat(allowTypingParam, "&").concat(constants_1.OFU.WdOrigin, "=").concat(constants_1.OFU.OpenInExcelOririgin)];
                 }
                 else {
                     throw new Error("File upload failed. Status code: ".concat(response.status));
                 }
                 return [3 /*break*/, 4];
             case 3:
-                error_1 = _a.sent();
-                console.error("An error occurred:", error_1);
-                return [3 /*break*/, 4];
+                error_2 = _a.sent();
+                throw new Error("An error occurred: ".concat(error_2));
             case 4: return [2 /*return*/];
         }
     });
 }); };
-exports.openInExcelWeb = openInExcelWeb;
+exports.getExcelForWebWorkbookUrl = getExcelForWebWorkbookUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/connected-workbooks",
-  "version": "3.1.3-beta",
+  "version": "3.2.0-beta",
   "description": "Microsoft backed, Excel advanced xlsx workbook generation JavaScript library",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",