@microsoft/connected-workbooks 3.4.1 → 3.4.2

package/README.md

@@ -10,7 +10,11 @@
 **Open your data directly in Excel for the Web with zero installation** - A JavaScript library that converts web tables and data into interactive Excel workbooks with Power Query integration and custom branded templates
 
 <div align="center">
-<img src="./assets/template example.gif" alt="Connected Workbooks Demo" >
+<a href="https://aka.ms/OpenInExcelREADME" target="_blank">
+  <img src="./assets/template example.gif" alt="Connected Workbooks Demo - Click to watch video" >
+  <br/>
+  <strong>📺 Watch the video tutorial</strong>
+</a>
 </div>
 
 
@@ -79,8 +83,15 @@ const blob = await workbookManager.generateTableWorkbookFromHtml(
   document.querySelector('table') as HTMLTableElement
 );
 
-// Open in Excel for the Web with editing enabled
-workbookManager.openInExcelWeb(blob, "QuickExport.xlsx", true);
+// Open in Excel for the Web
+// Edit mode with full editing capabilities (default)
+workbookManager.openInExcelWeb(blob, "QuickExport.xlsx");
+
+// View mode with typing disabled
+workbookManager.openInExcelWeb(blob, "QuickExport.xlsx", false, false);
+
+// View mode with typing enabled
+workbookManager.openInExcelWeb(blob, "QuickExport.xlsx", true, false);
 ```
 
 ### 📊 **Smart Data Formatting**
@@ -309,9 +320,9 @@ Open workbooks directly in Excel for the Web.
 
 ```typescript
 async function openInExcelWeb(
-  blob: Blob, 
-  filename?: string, 
-  allowTyping?: boolean
+  blob: Blob,
+  filename?: string,
+  allowEdit?: boolean
 ): Promise<void>
 ```
 
@@ -319,7 +330,7 @@ async function openInExcelWeb(
 |-----------|------|----------|-------------|
 | `blob` | `Blob` | ✅ **Required** | Generated workbook |
 | `filename` | `string` |  Optional | Custom filename |
-| `allowTyping` | `boolean` |  Optional | Enable editing (default: false) |
+| `allowEdit` | `boolean` |  Optional | Open in edit mode with full editing capabilities (default: **true**) |
 
 #### 💾 `downloadWorkbook()`
 Trigger browser download of the workbook.
@@ -328,17 +339,23 @@ Trigger browser download of the workbook.
 function downloadWorkbook(file: Blob, filename: string): void
 ```
 
-#### 🔗 `getExcelForWebWorkbookUrl()` 
+#### 🔗 `getExcelForWebWorkbookUrl()`
 Get the Excel for Web URL without opening (useful for custom integrations).
 
 ```typescript
 async function getExcelForWebWorkbookUrl(
-  file: Blob, 
-  filename?: string, 
-  allowTyping?: boolean
+  file: Blob,
+  filename?: string,
+  allowEdit?: boolean
 ): Promise<string>
 ```
 
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `file` | `Blob` | ✅ **Required** | Generated workbook |
+| `filename` | `string` |  Optional | Custom filename |
+| `allowEdit` | `boolean` |  Optional | Use edit URL with full editing capabilities (default: **true**) |
+
 ---
 
 ## 🔧 Type Definitions

package/dist/utils/constants.js

@@ -190,8 +190,8 @@ exports.headers = {
 };
 exports.OFU = {
     ViewUrl: "https://view.officeapps.live.com/op/view.aspx?src=http://connectedWorkbooks.excel/",
+    editUrl: "https://view.officeapps.live.com/op/edit.aspx?app=x&src=http://connectedWorkbooks.excel/",
     PostUrl: "https://view.officeapps.live.com/op/viewpost.aspx?src=http://connectedWorkbooks.excel/",
-    AllowTyping: "AllowTyping",
     WdOrigin: "wdOrigin",
     OpenInExcelOririgin: "OpenInExcel",
 };

package/dist/workbookManager.d.ts

@@ -3,5 +3,5 @@ export declare const generateSingleQueryWorkbook: (query: QueryInfo, initialData
 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;
-export declare const openInExcelWeb: (file: Blob, filename?: string, allowTyping?: boolean) => Promise<void>;
-export declare const getExcelForWebWorkbookUrl: (file: Blob, filename?: string, allowTyping?: boolean) => Promise<string>;
+export declare const openInExcelWeb: (file: Blob, filename?: string, allowEdit?: boolean) => Promise<void>;
+export declare const getExcelForWebWorkbookUrl: (file: Blob, filename?: string, allowEdit?: boolean) => Promise<string>;

package/dist/workbookManager.js

@@ -166,62 +166,68 @@ var downloadWorkbook = function (file, filename) {
     }
 };
 exports.downloadWorkbook = downloadWorkbook;
-var openInExcelWeb = function (file, filename, allowTyping) { return __awaiter(void 0, void 0, void 0, function () {
-    var url, error_1;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                _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*/];
-        }
+var openInExcelWeb = function (file, filename, allowEdit) {
+    if (allowEdit === void 0) { allowEdit = true; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        var url, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, (0, exports.getExcelForWebWorkbookUrl)(file, filename, allowEdit)];
+                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;
-                _a.label = 1;
-            case 1:
-                _a.trys.push([1, 3, , 4]);
-                return [4 /*yield*/, fetch("".concat(constants_1.OFU.PostUrl).concat(fileNameGuid, "&").concat(constants_1.OFU.WdOrigin, "=").concat(constants_1.OFU.OpenInExcelOririgin), {
-                        method: "POST",
-                        headers: constants_1.headers,
-                        body: fileContent,
-                    })];
-            case 2:
-                response = _a.sent();
-                // Check if the response is successful
-                if (response.ok) {
-                    // if upload was successful - open the file in a new tab
-                    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_2 = _a.sent();
-                throw new Error("An error occurred: ".concat(error_2));
-            case 4: return [2 /*return*/];
-        }
+var getExcelForWebWorkbookUrl = function (file, filename, allowEdit) {
+    if (allowEdit === void 0) { allowEdit = true; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        var fileContent, fileNameGuid, baseUrl, 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";
+                    baseUrl = allowEdit ? constants_1.OFU.editUrl : constants_1.OFU.ViewUrl;
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, fetch("".concat(constants_1.OFU.PostUrl).concat(fileNameGuid, "&").concat(constants_1.OFU.WdOrigin, "=").concat(constants_1.OFU.OpenInExcelOririgin), {
+                            method: "POST",
+                            headers: constants_1.headers,
+                            body: fileContent,
+                        })];
+                case 2:
+                    response = _a.sent();
+                    // Check if the response is successful
+                    if (response.ok) {
+                        // if upload was successful - return the URL
+                        return [2 /*return*/, "".concat(baseUrl).concat(fileNameGuid, "&").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_2 = _a.sent();
+                    throw new Error("An error occurred: ".concat(error_2));
+                case 4: return [2 /*return*/];
+            }
+        });
     });
-}); };
+};
 exports.getExcelForWebWorkbookUrl = getExcelForWebWorkbookUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/connected-workbooks",
-  "version": "3.4.1",
+  "version": "3.4.2",
   "description": "Microsoft backed, Excel advanced xlsx workbook generation JavaScript library",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -57,11 +57,11 @@
     "@types/jszip": "^3.4.1",
     "@types/uuid": "^9.0.2",
     "@types/webpack-bundle-analyzer": "^4.6.0",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
     "@webpack-cli/generators": "^3.0.7",
     "babel-jest": "^27.0.6",
-    "eslint": "^7.30.0",
+    "eslint": "^9.39.2",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-jest": "^24.3.6",
     "eslint-plugin-prettier": "^3.4.0",