@adobe/helix-onedrive-support 11.1.0 → 11.1.2

package/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2.1
 executors:
   node18:
     docker:
-      - image: cimg/node:18.18
+      - image: cimg/node:18.19
 
 orbs:
   codecov: codecov/codecov@3.3.0

package/.renovaterc.json5

@@ -10,7 +10,7 @@
       packageNames: [
         '@azure/msal-node'
       ],
-      allowedVersions: '!/2\\.3\\.0/'
+      allowedVersions: '2.2.0'
     },
   ]
 }

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [11.1.2](https://github.com/adobe/helix-onedrive-support/compare/v11.1.1...v11.1.2) (2023-12-07)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-tokencache to v1.3.15 ([#471](https://github.com/adobe/helix-onedrive-support/issues/471)) ([ae091e1](https://github.com/adobe/helix-onedrive-support/commit/ae091e1cb958efdfc4b6eb53374e6c710c2f31bd))
+
+## [11.1.1](https://github.com/adobe/helix-onedrive-support/compare/v11.1.0...v11.1.1) (2023-11-03)
+
+
+### Bug Fixes
+
+* add interface for doFetch ([#464](https://github.com/adobe/helix-onedrive-support/issues/464)) ([43eb52d](https://github.com/adobe/helix-onedrive-support/commit/43eb52d8cde7ce1580dad3af8218032bc7d65ecc))
+
 # [11.1.0](https://github.com/adobe/helix-onedrive-support/compare/v11.0.6...v11.1.0) (2023-10-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "11.1.0",
+  "version": "11.1.2",
   "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.1",
-    "@adobe/helix-shared-tokencache": "1.3.14",
+    "@adobe/helix-shared-tokencache": "1.3.15",
     "@azure/msal-node": "2.2.0",
-    "jose": "5.0.1"
+    "jose": "5.1.3"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.4",
+    "@adobe/eslint-config-helix": "2.0.5",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@aws-sdk/client-s3": "3.438.0",
+    "@aws-sdk/client-s3": "3.465.0",
     "ajv": "8.12.0",
     "c8": "8.0.1",
     "codecov": "3.8.3",
     "dotenv": "16.3.1",
-    "eslint": "8.52.0",
+    "eslint": "8.55.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.0",
     "husky": "8.0.3",
@@ -49,12 +49,12 @@
     "jsdoc-to-markdown": "8.0.0",
     "jsdoc-tsimport-plugin": "1.0.5",
     "junit-report-builder": "3.1.0",
-    "lint-staged": "15.0.2",
+    "lint-staged": "15.1.0",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
-    "nock": "13.3.6",
-    "npm": "10.2.1",
-    "semantic-release": "22.0.5"
+    "nock": "13.4.0",
+    "npm": "10.2.4",
+    "semantic-release": "22.0.8"
   },
   "lint-staged": {
     "*.js": "eslint"

package/src/GraphAPI.d.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+export declare interface GraphAPI {
+  doFetch(relUrl: string, rawResponseBody: boolean, options: any): Promise<any>;
+}

package/src/excel/NamedItemContainer.js

@@ -12,12 +12,16 @@
 import { StatusCodeError } from '../StatusCodeError.js';
 
 export class NamedItemContainer {
-  constructor(oneDrive) {
-    this._oneDrive = oneDrive;
+  /**
+   * Create a new instance of this class.
+   * @param {import('../GraphAPI.js').GraphAPI} graphAPI graph API
+   */
+  constructor(graphAPI) {
+    this._graphAPI = graphAPI;
   }
 
   async getNamedItems() {
-    const result = await this._oneDrive.doFetch(`${this.uri}/names`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/names`);
     return result.value.map((v) => ({
       name: v.name,
       value: v.value,
@@ -28,7 +32,7 @@ export class NamedItemContainer {
   async getNamedItem(name) {
     try {
       // await result in order to be able to catch errors
-      return await this._oneDrive.doFetch(`${this.uri}/names/${name}`);
+      return await this._graphAPI.doFetch(`${this.uri}/names/${name}`);
     } catch (e) {
       if (e.statusCode === 404) {
         return null;
@@ -40,7 +44,7 @@ export class NamedItemContainer {
   async addNamedItem(name, reference, comment) {
     try {
       // await result in order to be able to catch errors
-      return await this._oneDrive.doFetch(`${this.uri}/names/add`, false, {
+      return await this._graphAPI.doFetch(`${this.uri}/names/add`, false, {
         method: 'POST',
         body: {
           name,
@@ -59,7 +63,7 @@ export class NamedItemContainer {
   async deleteNamedItem(name) {
     try {
       // await result in order to be able to catch errors
-      return await this._oneDrive.doFetch(`${this.uri}/names/${name}`, true, {
+      return await this._graphAPI.doFetch(`${this.uri}/names/${name}`, true, {
         method: 'DELETE',
       });
     } catch (e) {

package/src/excel/Range.js

@@ -12,8 +12,14 @@
 import { superTrim } from '../utils.js';
 
 export class Range {
-  constructor(oneDrive, uri, log) {
-    this._oneDrive = oneDrive;
+  /**
+   * Create a new instance of this class.
+   * @param {import('../GraphAPI.js').GraphAPI} graphAPI graph API
+   * @param {string} uri URI of this range
+   * @param {any} log logger
+   */
+  constructor(graphAPI, uri, log) {
+    this._graphAPI = graphAPI;
     this._uri = uri;
     this._log = log;
   }
@@ -29,7 +35,7 @@ export class Range {
   async getData() {
     if (!this._data) {
       this.log.debug(`get range data from ${this.uri}`);
-      this._data = await this._oneDrive.doFetch(this.uri);
+      this._data = await this._graphAPI.doFetch(this.uri);
     }
     return this._data;
   }
@@ -72,14 +78,14 @@ export class Range {
       } else {
         // optimization: ask for the values, only, not the complete range object
         this.log.debug(`get range values from ${this.uri}`);
-        this._values = (await this._oneDrive.doFetch(`${this.uri}?$select=values`)).values;
+        this._values = (await this._graphAPI.doFetch(`${this.uri}?$select=values`)).values;
       }
     }
     return this._values;
   }
 
   async update(newValues) {
-    const result = await this._oneDrive.doFetch(this.uri, false, {
+    const result = await this._graphAPI.doFetch(this.uri, false, {
       method: 'PATCH',
       body: newValues,
     });
@@ -87,7 +93,7 @@ export class Range {
   }
 
   async delete(shift = 'Up') {
-    await this._oneDrive.doFetch(`${this.uri}/delete`, false, {
+    await this._graphAPI.doFetch(`${this.uri}/delete`, false, {
       method: 'POST',
       body: { shift },
     });
@@ -96,7 +102,7 @@ export class Range {
   }
 
   async insert(shift = 'Down') {
-    const result = await this._oneDrive.doFetch(`${this.uri}/insert`, false, {
+    const result = await this._graphAPI.doFetch(`${this.uri}/insert`, false, {
       method: 'POST',
       body: { shift },
     });

package/src/excel/Table.js

@@ -13,8 +13,15 @@ import { superTrim } from '../utils.js';
 import { Range } from './Range.js';
 
 export class Table {
-  constructor(oneDrive, prefix, name, log) {
-    this._oneDrive = oneDrive;
+  /**
+   * Create a new instance of this class.
+   * @param {import('../GraphAPI.js').GraphAPI} graphAPI graph API
+   * @param {string} prefix URI prefix for this table
+   * @param {string} name table name
+   * @param {any} log logger
+   */
+  constructor(graphAPI, prefix, name, log) {
+    this._graphAPI = graphAPI;
     this._prefix = prefix;
     this._name = name;
     this._log = log;
@@ -22,7 +29,7 @@ export class Table {
 
   async rename(name) {
     // TODO: check name for allowed characters and length
-    const result = await this._oneDrive.doFetch(this.uri, false, {
+    const result = await this._graphAPI.doFetch(this.uri, false, {
       method: 'PATCH',
       body: {
         name,
@@ -33,19 +40,19 @@ export class Table {
   }
 
   async getHeaderNames() {
-    const result = await this._oneDrive.doFetch(`${this.uri}/headerRowRange`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/headerRowRange`);
     return result.values[0];
   }
 
   async getRows() {
-    const result = await this._oneDrive.doFetch(`${this.uri}/rows`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/rows`);
     return result.value.map((v) => v.values[0]);
   }
 
   async getRowsAsObjects({ trim = false } = {}) {
     const { log } = this;
     this.log.debug(`get columns from ${this.uri}/columns`);
-    const result = await this._oneDrive.doFetch(`${this.uri}/columns`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/columns`);
     const columnNames = result.value.map(({ name }) => name);
     log.debug(`got column names: ${columnNames}`);
 
@@ -68,7 +75,7 @@ export class Table {
   }
 
   async getRow(index) {
-    const result = await this._oneDrive.doFetch(`${this.uri}/rows/itemAt(index=${index})`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/rows/itemAt(index=${index})`);
     return result.values[0];
   }
 
@@ -78,7 +85,7 @@ export class Table {
   }
 
   async addRows(values, index = null) {
-    const result = await this._oneDrive.doFetch(`${this.uri}/rows/add`, false, {
+    const result = await this._graphAPI.doFetch(`${this.uri}/rows/add`, false, {
       method: 'POST',
       body: {
         index,
@@ -89,7 +96,7 @@ export class Table {
   }
 
   async replaceRow(index, values) {
-    return this._oneDrive.doFetch(`${this.uri}/rows/itemAt(index=${index})`, false, {
+    return this._graphAPI.doFetch(`${this.uri}/rows/itemAt(index=${index})`, false, {
       method: 'PATCH',
       body: {
         values: [values],
@@ -98,18 +105,18 @@ export class Table {
   }
 
   async deleteRow(index) {
-    return this._oneDrive.doFetch(`${this.uri}/rows/itemAt(index=${index})`, true, {
+    return this._graphAPI.doFetch(`${this.uri}/rows/itemAt(index=${index})`, true, {
       method: 'DELETE',
     });
   }
 
   async getRowCount() {
-    const result = await this._oneDrive.doFetch(`${this.uri}/dataBodyRange?$select=rowCount`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/dataBodyRange?$select=rowCount`);
     return result.rowCount;
   }
 
   async getColumn(name) {
-    const result = await this._oneDrive.doFetch(`${this.uri}/columns('${name}')`);
+    const result = await this._graphAPI.doFetch(`${this.uri}/columns('${name}')`);
     return result.values;
   }
 
@@ -120,14 +127,14 @@ export class Table {
     if (index !== undefined) {
       body.index = index;
     }
-    return this._oneDrive.doFetch(`${this.uri}/columns`, false, {
+    return this._graphAPI.doFetch(`${this.uri}/columns`, false, {
       method: 'POST',
       body,
     });
   }
 
   async deleteColumn(name) {
-    return this._oneDrive.doFetch(`${this.uri}/columns/${name}`, true, {
+    return this._graphAPI.doFetch(`${this.uri}/columns/${name}`, true, {
       method: 'DELETE',
     });
   }
@@ -145,17 +152,17 @@ export class Table {
   }
 
   range() {
-    return new Range(this._oneDrive, `${this.uri}/range`, this._log);
+    return new Range(this._graphAPI, `${this.uri}/range`, this._log);
   }
 
   async clearFilters() {
-    await this._oneDrive.doFetch(`${this.uri}/clearFilters`, true, {
+    await this._graphAPI.doFetch(`${this.uri}/clearFilters`, true, {
       method: 'POST',
     });
   }
 
   async applyFilter(column, criteria) {
-    await this._oneDrive.doFetch(`${this.uri}/columns/${column}/filter/apply`, true, {
+    await this._graphAPI.doFetch(`${this.uri}/columns/${column}/filter/apply`, true, {
       method: 'POST',
       body: JSON.stringify({ criteria }),
     });
@@ -165,7 +172,7 @@ export class Table {
     // +1 to maxRows since result is inclusive of header
     const pathSuffix = maxRows !== -1 ? `?$top=${maxRows + 1}` : '';
     const path = `${this.uri}/range/visibleView/rows${pathSuffix}`;
-    const resp = await this._oneDrive.doFetch(path);
+    const resp = await this._graphAPI.doFetch(path);
     const headers = resp.value.shift().values[0];
     return resp.value.map((row) => ({
       cellAddresses: row.cellAddresses[0],

package/src/excel/Workbook.js

@@ -15,10 +15,16 @@ import { Table } from './Table.js';
 import { Worksheet } from './Worksheet.js';
 
 export class Workbook extends NamedItemContainer {
-  constructor(oneDrive, uri, log) {
-    super(oneDrive);
-
-    this._oneDrive = oneDrive;
+  /**
+   * Create a new instance of this class.
+   * @param {import('../GraphAPI.js').GraphAPI} graphAPI graph API
+   * @param {string} uri relative URI
+   * @param {any} log logger
+   */
+  constructor(graphAPI, uri, log) {
+    super(graphAPI);
+
+    this._graphAPI = graphAPI;
     this._uri = uri;
     this._log = log;
   }
@@ -28,7 +34,7 @@ export class Workbook extends NamedItemContainer {
       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, {
+    const result = await this._graphAPI.doFetch(uri, false, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify({ persistChanges }),
@@ -40,7 +46,7 @@ export class Workbook extends NamedItemContainer {
   async closeSession() {
     if (this._sessionId) {
       const uri = `${this.uri}/closeSession`;
-      await this._oneDrive.doFetch(uri, false, {
+      await this._graphAPI.doFetch(uri, false, {
         method: 'POST',
         headers: {
           'Workbook-Session-Id': this._sessionId,
@@ -55,7 +61,7 @@ export class Workbook extends NamedItemContainer {
   async refreshSession() {
     if (this._sessionId) {
       const uri = `${this.uri}/refreshSession`;
-      await this._oneDrive.doFetch(uri, false, {
+      await this._graphAPI.doFetch(uri, false, {
         method: 'POST',
         headers: {
           'Workbook-Session-Id': this._sessionId,
@@ -85,7 +91,7 @@ export class Workbook extends NamedItemContainer {
     if (this._sessionId) {
       opts.headers['Workbook-Session-Id'] = this._sessionId;
     }
-    return this._oneDrive.doFetch(relUrl, rawResponseBody, opts);
+    return this._graphAPI.doFetch(relUrl, rawResponseBody, opts);
   }
 
   async getData() {

package/src/excel/Worksheet.js

@@ -15,10 +15,17 @@ import { Table } from './Table.js';
 import { Range } from './Range.js';
 
 export class Worksheet extends NamedItemContainer {
-  constructor(oneDrive, prefix, name, log) {
-    super(oneDrive);
+  /**
+   * Create a new instance of this class.
+   * @param {import('../GraphAPI.js').GraphAPI} graphAPI graph API
+   * @param {string} prefix URI prefix for this sheet
+   * @param {string} name sheet name
+   * @param {any} log logger
+   */
+  constructor(graphAPI, prefix, name, log) {
+    super(graphAPI);
 
-    this._oneDrive = oneDrive;
+    this._graphAPI = graphAPI;
     this._uri = `${prefix}/${name}`;
     this._name = name;
     this._log = log;
@@ -33,18 +40,18 @@ export class Worksheet extends NamedItemContainer {
   }
 
   async getData() {
-    const result = await this._oneDrive.doFetch(this._uri);
+    const result = await this._graphAPI.doFetch(this._uri);
     return result.value;
   }
 
   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._graphAPI.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._graphAPI, `${this._uri}/tables`, name, this._log);
   }
 
   async addTable(address, hasHeaders, name) {
@@ -54,7 +61,7 @@ export class Worksheet 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._graphAPI.doFetch(`${this.uri}/tables/add`, false, {
       method: 'POST',
       body: {
         address,
@@ -69,10 +76,10 @@ export class Worksheet extends NamedItemContainer {
   }
 
   usedRange() {
-    return new Range(this._oneDrive, `${this._uri}/usedRange`, this._log);
+    return new Range(this._graphAPI, `${this._uri}/usedRange`, this._log);
   }
 
   range(address) {
-    return new Range(this._oneDrive, `${this._uri}/range(address='${address}')`, this._log);
+    return new Range(this._graphAPI, `${this._uri}/range(address='${address}')`, this._log);
   }
 }