@microsoft/connected-workbooks 2.1.25 → 3.1.1-beta.1

package/README.md

@@ -1,5 +1,4 @@
 # Connected Workbooks
-[![Build Status](https://obilshield.visualstudio.com/ConnectedWorkbooks/_apis/build/status/microsoft.connected-workbooks?branchName=main)](https://obilshield.visualstudio.com/ConnectedWorkbooks/_build/latest?definitionId=14&branchName=main)
 [![License](https://img.shields.io/github/license/microsoft/connected-workbooks)](https://github.com/microsoft/connected-workbooks/blob/master/LICENSE)
 
 A pure JS library, Microsoft backed, that provides xlsx workbook generation capabilities, allowing for:
@@ -26,7 +25,7 @@ Connected Workbooks allows you to avoid "data dumps" in CSV form, providing a ri
 import workbookManager from '@microsoft/connected-workbooks';
 
 const blob = await workbookManager.generateTableWorkbookFromHtml(document.querySelector('table') as HTMLTableElement);    
-workbookManager.downloadWorkbook(blob, "MyTable.xlsx");
+workbookManager.openInExcelWeb(blob, "MyTable.xlsx", true /*allowTyping*/);
 ```
 
 ### 2. Export a table from raw data:
@@ -34,7 +33,7 @@ workbookManager.downloadWorkbook(blob, "MyTable.xlsx");
 import workbookManager from '@microsoft/connected-workbooks';
 
 const grid = {
-  config: { promoteHeaders:true, adjustColumnNames:true }
+  config: { promoteHeaders:true, adjustColumnNames:true },
   data: [
       ["Product", "Price", "InStock", "Category", "Date"],
       ["Widget A", 19.99, true, "Electronics", "10/26/2024"],
@@ -45,17 +44,23 @@ const grid = {
   ]
 };
 const blob = await workbookManager.generateTableWorkbookFromGrid(grid);    
-workbookManager.downloadWorkbook(blob, "MyTable.xlsx");
+workbookManager.openInExcelWeb(blob, "MyTable.xlsx", true /*allowTyping*/);
 ```
 <img width="281" alt="image" src="https://github.com/microsoft/connected-workbooks/assets/7674478/b91e5d69-8444-4a19-a4b0-3fd721e5576f">
 
 ### 3. Control Document Properties:
 ```typescript
-    const blob = await workbookManager.generateTableWorkbookFromHtml(
-      document.querySelector('table') as HTMLTableElement, 
-      {createdBy: 'John Doe', lastModifiedBy: 'Jane Doe', description: 'This is a sample table'});
+const blob = await workbookManager.generateTableWorkbookFromHtml(
+  document.querySelector('table') as HTMLTableElement, {
+    docProps: { 
+      createdBy: 'John Doe',
+      lastModifiedBy: 'Jane Doe',
+      description: 'This is a sample table'
+    }
+  }
+);
     
-    workbookManager.downloadWorkbook(blob, "MyTable.xlsx");
+workbookManager.downloadWorkbook(blob, "MyTable.xlsx");
 ```
 ![image](https://github.com/microsoft/connected-workbooks/assets/7674478/c267c9eb-6367-419d-832d-5a835c7683f9)
 
@@ -68,7 +73,9 @@ const blob = await workbookManager.generateSingleQueryWorkbook({
                     Source = {1..10} \
                 in \
                     Source',
-  refreshOnOpen: true});
+  refreshOnOpen: true
+});
+
 workbookManager.downloadWorkbook(blob, "MyConnectedWorkbook.xlsx");
 ```
 ![image](https://github.com/microsoft/connected-workbooks/assets/7674478/57bd986c-6309-4963-8d86-911ccf496c3f)
@@ -126,7 +133,7 @@ async function `generateTableWorkbookFromHtml`: `Promise<Blob>`
 |Parameter   | Type   | Required   | Description   |
 |---      |---    |---          |---            |
 | htmlTable  | HTMLTableElement   | __required__   | Initial data loaded to workbook  | 
-| docProps  | [DocProps](#docprops)   | optional  | Custom workbook properties |
+| fileConfigs  | [FileConfigs](#fileconfigs)   | optional  | Custom file configurations |
 
 #### 3. Generate a table workbook with raw data
 ```typescript
@@ -136,7 +143,20 @@ async function `generateTableWorkbookFromGrid`: `Promise<Blob>`
 |Parameter   | Type   | Required   | Description   |
 |---      |---    |---          |---            |
 | grid  | [Grid](#grid)   | __required__   | Initial data loaded to workbook  | 
-| docProps  | [DocProps](#docprops)   | optional  | Custom workbook properties |
+| fileConfigs  | [FileConfigs](#fileconfigs)   | optional  | Custom file configurations |
+
+#### 3. Open the created workbook in excel for the web
+```typescript
+async function `openInExcelWeb`: `Promise<void>`
+```
+
+⭐ This API is supported only for an HTTPS domain.
+
+|Parameter   | Type   | Required   | Description   |
+|---      |---    |---          |---            |
+| blob  | [Blob](https://developer.mozilla.org/docs/Web/API/Blob)   | __required__   | Initial data loaded to workbook  | 
+| filename  |  string  | optional  | Custom the opened file name |
+| allowTyping  |  boolean  | optional  | allow user editing (typing) |
 </br>
 
 ### Types
@@ -165,6 +185,7 @@ async function `generateTableWorkbookFromGrid`: `Promise<Blob>`
 |---|---|---|---|
 | templateFile | File | optional   | Custom Excel workbook  |
 | docProps  | [DocProps](#docprops)   | optional  | Custom workbook properties |
+| hostName  | string | optional  | specify the host creator name |
 
 #### DocProps
 |Parameter   | Type   | Required  

package/dist/generators.js

@@ -1,14 +1,9 @@
-"use strict";
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCustomXmlFilePath = exports.generateSingleQueryMashup = exports.generateMashupXMLTemplate = void 0;
-const generateMashupXMLTemplate = (base64) => `<?xml version="1.0" encoding="utf-16"?><DataMashup xmlns="http://schemas.microsoft.com/DataMashup">${base64}</DataMashup>`;
-exports.generateMashupXMLTemplate = generateMashupXMLTemplate;
-const generateSingleQueryMashup = (queryName, query) => `section Section1;
-    
-    shared #"${queryName}" = 
-    ${query};`;
-exports.generateSingleQueryMashup = generateSingleQueryMashup;
-const generateCustomXmlFilePath = (i) => `customXml/item${i}.xml`;
-exports.generateCustomXmlFilePath = generateCustomXmlFilePath;
+export var generateMashupXMLTemplate = function (base64) {
+    return "<?xml version=\"1.0\" encoding=\"utf-16\"?><DataMashup xmlns=\"http://schemas.microsoft.com/DataMashup\">".concat(base64, "</DataMashup>");
+};
+export var generateSingleQueryMashup = function (queryName, query) {
+    return "section Section1;\n    \n    shared #\"".concat(queryName, "\" = \n    ").concat(query, ";");
+};
+export var generateCustomXmlFilePath = function (i) { return "customXml/item".concat(i, ".xml"); };

package/dist/index.js

@@ -1,32 +1,6 @@
-"use strict";
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataTypes = void 0;
-const workbookManager = __importStar(require("./workbookManager"));
-const types_1 = require("./types");
-Object.defineProperty(exports, "DataTypes", { enumerable: true, get: function () { return types_1.DataTypes; } });
-exports.default = workbookManager;
+import * as workbookManager from "./workbookManager";
+import { DataTypes } from "./types";
+export { DataTypes };
+export default workbookManager;