@adobe/helix-onedrive-support 11.0.6 → 11.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [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.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {

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

@@ -147,4 +147,32 @@ export class Table {
   range() {
     return new Range(this._oneDrive, `${this.uri}/range`, this._log);
   }
+
+  async clearFilters() {
+    await this._oneDrive.doFetch(`${this.uri}/clearFilters`, true, {
+      method: 'POST',
+    });
+  }
+
+  async applyFilter(column, criteria) {
+    await this._oneDrive.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._oneDrive.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

@@ -23,13 +23,15 @@ export class Workbook extends NamedItemContainer {
     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, {
       method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({ persistChanges }),
     });
     this._sessionId = result.id;
     return this._sessionId;