@adobe/helix-onedrive-support 11.0.6 → 11.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [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)
+
+
+### Features
+
+* support for non-persistent sessions and table filtering ([bba88fc](https://github.com/adobe/helix-onedrive-support/commit/bba88fcc3150490436af2d0944ed54a5c5517502))
+
 ## [11.0.6](https://github.com/adobe/helix-onedrive-support/compare/v11.0.5...v11.0.6) (2023-10-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "11.0.6",
+  "version": "11.1.1",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {

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/OneDriveMock.js

@@ -145,6 +145,18 @@ function handleTable(container, segs, method, body) {
         });
         return null;
       }
+      if ((segs.length >= 3) && (segs[1] === 'filter') && (segs[2] === 'apply')) {
+        if (table.filters) {
+          throw new Error('Only one filter at a time supported currently!');
+        }
+        const { criteria } = JSON.parse(body);
+        if (criteria.filterOn !== 'values') {
+          throw new Error('Only value based filtering supported currently!');
+        }
+        const colName = segs[0];
+        table.filters = { column: colName, criteria };
+        return null;
+      }
       if (body) {
         ({ name, index = table.headerNames.length } = body);
         table.headerNames.splice(index, 0, name);
@@ -180,11 +192,25 @@ function handleTable(container, segs, method, body) {
       };
     }
     case 'range': {
+      if ((segs.length >= 2) && (segs[0] === 'visibleView') && (segs[1] === 'rows')) {
+        const colIdx = table.filters ? table.headerNames.indexOf(table.filters.column) : -1;
+        const result = [{ cellAddresses: [[0]], values: [table.headerNames] }];
+        for (const [i, row] of table.rows.entries()) {
+          if ((!table.filters) || table.filters.criteria.values.includes(row[colIdx])) {
+            result.push({ cellAddresses: [[i + 1]], values: [row] });
+          }
+        }
+        return { value: result };
+      }
       return {
         address: 'sheet!A1:B10',
         addressLocal: 'A1:B10',
       };
     }
+    case 'clearFilters': {
+      table.filters = null;
+      return {};
+    }
     default:
       if (body) {
         table.name = body.name;
@@ -388,7 +414,7 @@ export class OneDriveMock extends OneDrive {
       }
     } else if (segs[0] === 'createSession') {
       return {
-        id: 'test-session-id',
+        id: JSON.parse(body).persistChanges ? 'test-session-id' : 'test-non-persistent-session-id',
       };
     } else if (segs[0] === 'refreshSession' || segs[0] === 'closeSession') {
       return {};

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,6 +152,34 @@ 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._graphAPI.doFetch(`${this.uri}/clearFilters`, true, {
+      method: 'POST',
+    });
+  }
+
+  async applyFilter(column, criteria) {
+    await this._graphAPI.doFetch(`${this.uri}/columns/${column}/filter/apply`, true, {
+      method: 'POST',
+      body: JSON.stringify({ criteria }),
+    });
+  }
+
+  async getVisibleRowsAsObjectsWithAddresses(maxRows = -1) {
+    // +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._graphAPI.doFetch(path);
+    const headers = resp.value.shift().values[0];
+    return resp.value.map((row) => ({
+      cellAddresses: row.cellAddresses[0],
+      data: headers.reduce(
+        (rowObj, colName, colIdx, _) => ({ ...rowObj, [colName]: row.values[0][colIdx] }),
+        {},
+      ),
+    }));
   }
 }

package/src/excel/Workbook.js

@@ -15,21 +15,29 @@ 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;
   }
 
-  async createSession() {
+  async createSession(persistChanges = true) {
     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, {
+    const result = await this._graphAPI.doFetch(uri, false, {
       method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ persistChanges }),
     });
     this._sessionId = result.id;
     return this._sessionId;
@@ -38,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,
@@ -53,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,
@@ -83,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);
   }
 }