@adobe/helix-onedrive-support 10.8.4 → 11.0.0

package/.circleci/config.yml

@@ -5,7 +5,7 @@ executors:
       - image: cimg/node:18.18
 
 orbs:
-  codecov: codecov/codecov@3.2.5
+  codecov: codecov/codecov@3.3.0
 
 commands:
   setup:

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [11.0.0](https://github.com/adobe/helix-onedrive-support/compare/v10.8.5...v11.0.0) (2023-10-14)
+
+
+* fix(excel)!: store session in workbook (#450) ([f7e3abc](https://github.com/adobe/helix-onedrive-support/commit/f7e3abc433d6a1209b3abec58cefedc8066701b3)), closes [#450](https://github.com/adobe/helix-onedrive-support/issues/450)
+
+
+### BREAKING CHANGES
+
+* semantics of setting sessions changed
+
+* fix: add getSessionId
+
+## [10.8.5](https://github.com/adobe/helix-onedrive-support/compare/v10.8.4...v10.8.5) (2023-10-08)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-tokencache to v1.3.11 ([#449](https://github.com/adobe/helix-onedrive-support/issues/449)) ([c3fd78f](https://github.com/adobe/helix-onedrive-support/commit/c3fd78fe037fea6f7d8b69563f341ca3cf805939))
+
 ## [10.8.4](https://github.com/adobe/helix-onedrive-support/compare/v10.8.3...v10.8.4) (2023-09-29)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "10.8.4",
+  "version": "11.0.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {
@@ -28,20 +28,20 @@
   "homepage": "https://github.com/adobe/helix-onedrive-support#readme",
   "dependencies": {
     "@adobe/fetch": "4.1.0",
-    "@adobe/helix-shared-tokencache": "1.3.10",
-    "@azure/msal-node": "2.1.0",
-    "jose": "4.14.6"
+    "@adobe/helix-shared-tokencache": "1.3.11",
+    "@azure/msal-node": "2.2.0",
+    "jose": "4.15.2"
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.3",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@aws-sdk/client-s3": "3.418.0",
+    "@aws-sdk/client-s3": "3.427.0",
     "ajv": "8.12.0",
     "c8": "8.0.1",
     "codecov": "3.8.3",
     "dotenv": "16.3.1",
-    "eslint": "8.50.0",
+    "eslint": "8.51.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.28.1",
     "husky": "8.0.3",
@@ -53,8 +53,8 @@
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "nock": "13.3.3",
-    "npm": "10.1.0",
-    "semantic-release": "22.0.4"
+    "npm": "10.2.0",
+    "semantic-release": "22.0.5"
   },
   "lint-staged": {
     "*.js": "eslint"

package/src/OneDrive.js

@@ -116,14 +116,6 @@ export class OneDrive {
     return this._log;
   }
 
-  get workbookSessionId() {
-    return this._sessionId;
-  }
-
-  setWorkbookSessionId(workbookSessionId) {
-    this._sessionId = workbookSessionId;
-  }
-
   /**
    */
   async doFetch(relUrl, rawResponseBody = false, options = {}) {
@@ -134,9 +126,6 @@ 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/excel/Workbook.d.ts

@@ -28,7 +28,7 @@ export declare interface Workbook {
    * Create the worksheet with given name in the workbook.
    * @param {string} sheetName sheet name
    * @returns Worksheet
-   * 
+   *
    */
   createWorksheet(sheetName: string): Worksheet;
 
@@ -109,9 +109,15 @@ export declare interface Workbook {
    */
   refreshSession(): Promise<void>;
 
+  /**
+   * Returns the sessionId of the workbook
+   * @returns {string} sessionId or null
+   */
+  getSessionId(): string;
+
   /**
    * Sets the sessionId of the workbook
-   * @param sessionId 
+   * @param {string} sessionId session id
    */
   setSessionId(sessionId: string): void;
 }

package/src/excel/Workbook.js

@@ -23,65 +23,87 @@ export class Workbook extends NamedItemContainer {
     this._log = log;
   }
 
-  async getData() {
-    const result = await this._oneDrive.doFetch(this._uri);
-    return result.value;
-  }
-
-  async getWorksheetNames() {
-    this.log.debug(`get worksheet names from ${this._uri}/worksheets`);
-    const result = await this._oneDrive.doFetch(`${this._uri}/worksheets`);
-    return result.value.map((v) => v.name);
-  }
-
-  worksheet(name) {
-    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;
+    if (this._sessionId) {
+      throw new StatusCodeError('This workbook is already associated with a session', 400);
     }
+    const uri = `${this.uri}/createSession`;
+    const result = await this._oneDrive.doFetch(uri, false, {
+      method: 'POST',
+    });
+    this._sessionId = result.id;
+    return this._sessionId;
   }
 
   async closeSession() {
-    if (this._oneDrive.workbookSessionId) {
+    if (this._sessionId) {
       const uri = `${this.uri}/closeSession`;
       await this._oneDrive.doFetch(uri, false, {
         method: 'POST',
+        headers: {
+          'Workbook-Session-Id': this._sessionId,
+        },
       });
-      this._oneDrive.setWorkbookSessionId(null);
-    } else {
-      throw new StatusCodeError('Please create a session first!', 400);
+      this._sessionId = null;
+      return;
     }
+    throw new StatusCodeError('No session associated with workbook', 400);
   }
 
   async refreshSession() {
-    if (this._oneDrive.workbookSessionId) {
+    if (this._sessionId) {
       const uri = `${this.uri}/refreshSession`;
       await this._oneDrive.doFetch(uri, false, {
         method: 'POST',
+        headers: {
+          'Workbook-Session-Id': this._sessionId,
+        },
       });
-    } else {
-      throw new StatusCodeError('Please create a session first!', 400);
+      return;
     }
+    throw new StatusCodeError('No session associated with workbook', 400);
+  }
+
+  getSessionId() {
+    return this._sessionId;
   }
 
   setSessionId(sessionId) {
-    this._oneDrive.setWorkbookSessionId(sessionId);
+    if (this._sessionId) {
+      throw new StatusCodeError('This workbook is already associated with a session', 400);
+    }
+    this._sessionId = sessionId;
+  }
+
+  async doFetch(relUrl, rawResponseBody, options) {
+    const opts = { ...options };
+    if (!opts.headers) {
+      opts.headers = {};
+    }
+    if (this._sessionId) {
+      opts.headers['Workbook-Session-Id'] = this._sessionId;
+    }
+    return this._oneDrive.doFetch(relUrl, rawResponseBody, opts);
+  }
+
+  async getData() {
+    const result = await this.doFetch(this._uri);
+    return result.value;
+  }
+
+  async getWorksheetNames() {
+    this.log.debug(`get worksheet names from ${this._uri}/worksheets`);
+    const result = await this.doFetch(`${this._uri}/worksheets`);
+    return result.value.map((v) => v.name);
+  }
+
+  worksheet(name) {
+    return new Worksheet(this, `${this._uri}/worksheets`, name, this._log);
   }
 
   async createWorksheet(sheetName) {
     const uri = `${this.uri}/worksheets`;
-    await this._oneDrive.doFetch(uri, false, {
+    await this.doFetch(uri, false, {
       method: 'POST',
       body: { name: sheetName },
       headers: { 'content-type': 'application/json' },
@@ -91,7 +113,7 @@ export class Workbook extends NamedItemContainer {
 
   async deleteWorksheet(sheetName) {
     const uri = `${this.uri}/worksheets/${sheetName}`;
-    await this._oneDrive.doFetch(uri, false, {
+    await this.doFetch(uri, false, {
       method: 'DELETE',
       headers: { 'content-type': 'application/json' },
     });
@@ -99,12 +121,12 @@ export class Workbook extends NamedItemContainer {
 
   async getTableNames() {
     this.log.debug(`get table names from ${this._uri}/tables`);
-    const result = await this._oneDrive.doFetch(`${this._uri}/tables`);
+    const result = await this.doFetch(`${this._uri}/tables`);
     return result.value.map((v) => v.name);
   }
 
   table(name) {
-    return new Table(this._oneDrive, `${this._uri}/tables`, name, this._log);
+    return new Table(this, `${this._uri}/tables`, name, this._log);
   }
 
   async addTable(address, hasHeaders, name) {
@@ -114,7 +136,7 @@ export class Workbook extends NamedItemContainer {
         throw new StatusCodeError(`Table name already exists: ${name}`, 409);
       }
     }
-    const result = await this._oneDrive.doFetch(`${this.uri}/tables/add`, false, {
+    const result = await this.doFetch(`${this.uri}/tables/add`, false, {
       method: 'POST',
       body: {
         address,