@adobe/helix-onedrive-support 10.6.4 → 10.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [10.7.0](https://github.com/adobe/helix-onedrive-support/compare/v10.6.5...v10.7.0) (2023-09-14)
+
+
+### Features
+
+* add row at index and workbook session upport ([bba1aab](https://github.com/adobe/helix-onedrive-support/commit/bba1aab486ed1f12bc08de43c66e44d08e521a05))
+
+## [10.6.5](https://github.com/adobe/helix-onedrive-support/compare/v10.6.4...v10.6.5) (2023-09-13)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/fetch to v4.1.0 ([a2237b4](https://github.com/adobe/helix-onedrive-support/commit/a2237b43f769b494ff50e65bb0c755532c698863))
+
 ## [10.6.4](https://github.com/adobe/helix-onedrive-support/compare/v10.6.3...v10.6.4) (2023-09-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "10.6.4",
+  "version": "10.7.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/adobe/helix-onedrive-support#readme",
   "dependencies": {
-    "@adobe/fetch": "4.0.13",
+    "@adobe/fetch": "4.1.0",
     "@adobe/helix-shared-tokencache": "1.3.7",
     "@azure/msal-node": "2.1.0",
     "jose": "4.14.6"

package/src/OneDrive.js

@@ -116,6 +116,14 @@ export class OneDrive {
     return this._log;
   }
 
+  get workbookSessionId() {
+    return this._sessionId;
+  }
+
+  setWorkbookSessionId(workbookSessionId) {
+    this._sessionId = workbookSessionId;
+  }
+
   /**
    */
   async doFetch(relUrl, rawResponseBody = false, options = {}) {
@@ -126,6 +134,9 @@ export class OneDrive {
     }
     opts.headers.authorization = `Bearer ${accessToken}`;
 
+    if (this._sessionId) {
+      opts.headers['Workbook-Session-Id'] = this._sessionId;
+    }
     const { log, auth: { logFields, tenant } } = this;
     const url = `https://graph.microsoft.com/v1.0${relUrl}`;
     const method = opts.method || 'GET';

package/src/OneDriveMock.js

@@ -111,8 +111,13 @@ function handleTable(container, segs, method, body) {
       }
       const subCommand = segs.shift();
       if (subCommand === 'add') {
-        table.rows.push(...body.values);
-        return { index: table.rows.length - 1 };
+        if (body.index && body.index >= 0) {
+          table.rows.splice(body.index, 0, ...body.values);
+          return { index: body.index };
+        } else {
+          table.rows.push(...body.values);
+          return { index: table.rows.length - 1 };
+        }
       }
       index = parseInt(subCommand.replace(/itemAt\(index=([0-9]+)\)/, '$1'), 10);
       if (index < 0 || index >= table.rows.length) {
@@ -375,6 +380,12 @@ export class OneDriveMock extends OneDrive {
       } else {
         return { value: data.sheets.map((st) => ({ name: st.name })) };
       }
+    } else if (segs[0] === 'createSession') {
+      return {
+        id: 'test-session-id',
+      };
+    } else if (segs[0] === 'refreshSession' || segs[0] === 'closeSession') {
+      return {};
     }
 
     // handle the operations on the workbook / worksheet

package/src/excel/Table.d.ts

@@ -56,9 +56,10 @@ export declare interface Table {
   /**
    * Add a row to the table
    * @param values values for new row
+   * @param index zero-based index or missing to add at end
    * @returns zero-based index of new row
    */
-  addRow(values: string[]): Promise<number>;
+  addRow(values: string[], index?: number): Promise<number>;
 
   /**
    * Replace a row in the table

package/src/excel/Table.js

@@ -71,16 +71,16 @@ export class Table {
     return result.values[0];
   }
 
-  async addRow(values) {
-    const result = await this.addRows([values]);
+  async addRow(values, index = null) {
+    const result = await this.addRows([values], index);
     return result;
   }
 
-  async addRows(values) {
+  async addRows(values, index = null) {
     const result = await this._oneDrive.doFetch(`${this.uri}/rows/add`, false, {
       method: 'POST',
       body: {
-        index: null,
+        index,
         values,
       },
     });

package/src/excel/Workbook.d.ts

@@ -93,4 +93,25 @@ export declare interface Workbook {
    * @param name name
    */
   deleteNamedItem(name: string): Promise<void>;
+
+  /**
+   * creates a new session
+   */
+  createSession(): Promise<string>;
+
+  /**
+   * closes the session
+   */
+  closeSession(): Promise<void>;
+
+   /**
+   * refreshes the session
+   */
+  refreshSession(): Promise<void>;
+
+  /**
+   * Sets the sessionId of the workbook
+   * @param sessionId 
+   */
+  setSessionId(sessionId: string): void;
 }

package/src/excel/Workbook.js

@@ -38,6 +38,47 @@ export class Workbook extends NamedItemContainer {
     return new Worksheet(this._oneDrive, `${this._uri}/worksheets`, name, this._log);
   }
 
+  async createSession() {
+    const sessionId = this._oneDrive.workbookSessionId;
+    if (sessionId) {
+      return sessionId;
+    } else {
+      const uri = `${this.uri}/createSession`;
+      const result = await this._oneDrive.doFetch(uri, false, {
+        method: 'POST',
+      });
+      this._oneDrive.setWorkbookSessionId(result.id);
+      return result.id;
+    }
+  }
+
+  async closeSession() {
+    if (this._oneDrive.workbookSessionId) {
+      const uri = `${this.uri}/closeSession`;
+      await this._oneDrive.doFetch(uri, false, {
+        method: 'POST',
+      });
+      this._oneDrive.setWorkbookSessionId(null);
+    } else {
+      throw new StatusCodeError('Please create a session first!', 400);
+    }
+  }
+
+  async refreshSession() {
+    if (this._oneDrive.workbookSessionId) {
+      const uri = `${this.uri}/refreshSession`;
+      await this._oneDrive.doFetch(uri, false, {
+        method: 'POST',
+      });
+    } else {
+      throw new StatusCodeError('Please create a session first!', 400);
+    }
+  }
+
+  setSessionId(sessionId) {
+    this._oneDrive.setWorkbookSessionId(sessionId);
+  }
+
   async createWorksheet(sheetName) {
     const uri = `${this.uri}/worksheets`;
     await this._oneDrive.doFetch(uri, false, {