@adobe/helix-onedrive-support 8.1.3 → 8.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [8.2.0](https://github.com/adobe/helix-onedrive-support/compare/v8.1.3...v8.2.0) (2022-07-29)
+
+
+### Features
+
+* add table ([#288](https://github.com/adobe/helix-onedrive-support/issues/288)) ([fd02048](https://github.com/adobe/helix-onedrive-support/commit/fd020486af2d355cf31e61a190bcf522031a15c2))
+
 ## [8.1.3](https://github.com/adobe/helix-onedrive-support/compare/v8.1.2...v8.1.3) (2022-07-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "8.1.3",
+  "version": "8.2.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {
@@ -10,8 +10,8 @@
   "type": "module",
   "types": "src/index.d.ts",
   "scripts": {
-    "test": "c8 mocha",
-    "test-ci": "c8 mocha && codecov",
+    "test": "c8 mocha --spec=test/**/*.test.js",
+    "test-ci": "c8 mocha  --spec=test/**/*.test.js && codecov",
     "lint": "./node_modules/.bin/eslint .",
     "semantic-release": "semantic-release",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
@@ -60,7 +60,6 @@
     "*.js": "eslint"
   },
   "mocha": {
-    "spec": "test/**/*.test.js",
     "require": "test/setup-env.js",
     "reporter": "mocha-multi-reporters",
     "reporter-options": "configFile=.mocha-multi.json"

package/src/OneDriveMock.js

@@ -60,79 +60,84 @@ function handleNamedItems(sheet, segs, method, body) {
  * @returns {object} The response value
  */
 function handleTable(sheet, segs, method, body) {
+  const first = segs.shift();
+  if (!first) {
+    return { value: sheet.tables.map((table) => ({ name: table.name })) };
+  }
+  if (first === 'add') {
+    const len = sheet.tables.push({
+      name: `Table${sheet.tables.length + 1}`,
+    });
+    return sheet.tables[len - 1];
+  }
+  const table = sheet.tables.find((t) => t.name === first);
+  if (!table) {
+    throw new StatusCodeError(first, 404);
+  }
+  let command;
+  let name;
   if (segs[0]) {
-    const tableName = segs.shift();
-    const table = sheet.tables.find((t) => t.name === tableName);
-    if (!table) {
-      throw new StatusCodeError(tableName, 404);
-    }
-    let command;
-    let name;
-    if (segs[0]) {
-      [, command, , name] = segs.shift().match(/([^?(]+)(\('([^)]+)'\))?(\?(.+))?/);
-    }
-    switch (command) {
-      case 'dataBodyRange':
-        return { rowCount: table.rows.length };
-      case 'headerRowRange':
-        return { values: [table.headerNames] };
-      case 'rows': {
-        if (!segs[0]) {
-          return { value: table.rows.map((row) => ({ values: [row] })) };
-        }
-        const subCommand = segs.shift();
-        if (subCommand === 'add') {
-          table.rows.push(...body.values);
-          return { index: table.rows.length - 1 };
-        }
-        const index = parseInt(subCommand.replace(/itemAt\(index=([0-9]+)\)/, '$1'), 10);
-        if (index < 0 || index >= table.rows.length) {
-          throw new StatusCodeError(`Index out of range: ${index}`, 400);
-        }
-        if (method === 'DELETE') {
-          table.rows.splice(index, 1);
-          return null;
-        }
-        if (body) {
-          [table.rows[index]] = body.values;
-        }
-        return { values: [table.rows[index]] };
+    [, command, , name] = segs.shift().match(/([^?(]+)(\('([^)]+)'\))?(\?(.+))?/);
+  }
+  switch (command) {
+    case 'dataBodyRange':
+      return { rowCount: table.rows.length };
+    case 'headerRowRange':
+      return { values: [table.headerNames] };
+    case 'rows': {
+      if (!segs[0]) {
+        return { value: table.rows.map((row) => ({ values: [row] })) };
+      }
+      const subCommand = segs.shift();
+      if (subCommand === 'add') {
+        table.rows.push(...body.values);
+        return { index: table.rows.length - 1 };
+      }
+      const index = parseInt(subCommand.replace(/itemAt\(index=([0-9]+)\)/, '$1'), 10);
+      if (index < 0 || index >= table.rows.length) {
+        throw new StatusCodeError(`Index out of range: ${index}`, 400);
       }
-      case 'columns': {
-        if (!name) {
-          const cols = table.headerNames.map((n) => ({
-            name: n,
-            values: [[n]],
-          }));
-          table.rows.forEach((row) => {
-            row.forEach((value, idx) => {
-              cols[idx].values.push([value]);
-            });
+      if (method === 'DELETE') {
+        table.rows.splice(index, 1);
+        return null;
+      }
+      if (body) {
+        [table.rows[index]] = body.values;
+      }
+      return { values: [table.rows[index]] };
+    }
+    case 'columns': {
+      if (!name) {
+        const cols = table.headerNames.map((n) => ({
+          name: n,
+          values: [[n]],
+        }));
+        table.rows.forEach((row) => {
+          row.forEach((value, idx) => {
+            cols[idx].values.push([value]);
           });
-          return {
-            value: cols,
-          };
-        }
-        const columnName = name;
-        const index = table.headerNames.findIndex((n) => n === columnName);
-        if (index === -1) {
-          throw new StatusCodeError(`Column name not found: ${columnName}`, 400);
-        }
+        });
         return {
-          values: [
-            [table.headerNames[index]],
-            ...table.rows.map((row) => [row[index]]),
-          ],
+          value: cols,
         };
       }
-      default:
-        if (body) {
-          table.name = body.name;
-        }
-        return { values: table.name };
+      const columnName = name;
+      const index = table.headerNames.findIndex((n) => n === columnName);
+      if (index === -1) {
+        throw new StatusCodeError(`Column name not found: ${columnName}`, 400);
+      }
+      return {
+        values: [
+          [table.headerNames[index]],
+          ...table.rows.map((row) => [row[index]]),
+        ],
+      };
     }
-  } else {
-    return { value: sheet.tables.map((table) => ({ name: table.name })) };
+    default:
+      if (body) {
+        table.name = body.name;
+      }
+      return { values: table.name };
   }
 }
 
@@ -309,7 +314,8 @@ export class OneDriveMock extends OneDrive {
     }
 
     // handle the operations on the workbook / worksheet
-    switch (segs.shift()) {
+    const type = segs.shift();
+    switch (type) {
       case 'usedRange':
         return sheet.usedRange;
       case 'tables':
@@ -317,6 +323,11 @@ export class OneDriveMock extends OneDrive {
       case 'names':
         return handleNamedItems(sheet, segs, method, body);
       default:
+        if (type && type.startsWith('range(address=')) {
+          return {
+            address: type.match(/range\(address='([^)]+)'\)/)[1],
+          };
+        }
         // default return the data
         return { value: data };
     }

package/src/excel/Table.js

@@ -125,6 +125,10 @@ export class Table {
     });
   }
 
+  get name() {
+    return this._name;
+  }
+
   get uri() {
     return `${this._prefix}/${this._name}`;
   }

package/src/excel/Workbook.d.ts

@@ -42,6 +42,17 @@ export declare interface Workbook {
    */
   table(name: string): Table;
 
+  /**
+   * Add a table to a workbook. If a name is passed that is not
+   * identical to one automatically given, the table gets
+   * automatically renamed.
+   *
+   * @param address address of table, e.g. Sheet1!A1:C1
+   * @param hasHeaders whether the table has headers
+   * @param name optional name
+   */
+   addTable(address: string, hasHeaders: boolean, name?: string): Promise<Table>;
+
   /**
    * Return the named items in a work book
    * @returns array of named items when resolved

package/src/excel/Workbook.js

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { NamedItemContainer } from './NamedItemContainer.js';
+import { StatusCodeError } from '../StatusCodeError.js';
 import { Table } from './Table.js';
 import { Worksheet } from './Worksheet.js';
 
@@ -47,6 +48,27 @@ export class Workbook extends NamedItemContainer {
     return new Table(this._oneDrive, `${this._uri}/tables`, name, this._log);
   }
 
+  async addTable(address, hasHeaders, name) {
+    if (name) {
+      const names = await this.getTableNames();
+      if (names.includes(name)) {
+        throw new StatusCodeError(`Table name already exists: ${name}`, 409);
+      }
+    }
+    const result = await this._oneDrive.doFetch(`${this.uri}/tables/add`, false, {
+      method: 'POST',
+      body: {
+        address,
+        hasHeaders,
+      },
+    });
+    const table = this.table(result.name);
+    if (name && name !== table.name) {
+      await table.rename(name);
+    }
+    return table;
+  }
+
   get uri() {
     return this._uri;
   }

package/src/excel/Worksheet.d.ts

@@ -57,6 +57,17 @@ export declare interface Worksheet {
    */
   table(name: string): Table;
 
+  /**
+   * Add a table to a workbook. If a name is passed that is not
+   * identical to one automatically given, the table gets
+   * automatically renamed.
+   *
+   * @param address address of table in sheet, e.g. A1:C1
+   * @param hasHeaders whether the table has headers
+   * @param name optional name
+   */
+  addTable(address: string, hasHeaders: boolean, name?: string): Promise<Table>;
+
   /**
    * Returns the use name.
    */

package/src/excel/Worksheet.js

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { NamedItemContainer } from './NamedItemContainer.js';
+import { StatusCodeError } from '../StatusCodeError.js';
 import { Table } from './Table.js';
 import { Range } from './Range.js';
 
@@ -46,6 +47,27 @@ export class Worksheet extends NamedItemContainer {
     return new Table(this._oneDrive, `${this._uri}/tables`, name, this._log);
   }
 
+  async addTable(address, hasHeaders, name) {
+    if (name) {
+      const names = await this.getTableNames();
+      if (names.includes(name)) {
+        throw new StatusCodeError(`Table name already exists: ${name}`, 409);
+      }
+    }
+    const result = await this._oneDrive.doFetch(`${this.uri}/tables/add`, false, {
+      method: 'POST',
+      body: {
+        address,
+        hasHeaders,
+      },
+    });
+    const table = this.table(result.name);
+    if (name && name !== table.name) {
+      await table.rename(name);
+    }
+    return table;
+  }
+
   usedRange() {
     return new Range(this._oneDrive, `${this._uri}/usedRange`, this._log);
   }