@adobe/helix-onedrive-support 11.1.3 → 11.3.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [11.3.0](https://github.com/adobe/helix-onedrive-support/compare/v11.2.0...v11.3.0) (2023-12-15)
+
+
+### Features
+
+* add workbook.application ([#475](https://github.com/adobe/helix-onedrive-support/issues/475)) ([782aa5f](https://github.com/adobe/helix-onedrive-support/commit/782aa5ffae19bfe08a02d7e7fb0218c1ccf09878))
+
+# [11.2.0](https://github.com/adobe/helix-onedrive-support/compare/v11.1.3...v11.2.0) (2023-12-15)
+
+
+### Features
+
+* introduce Range.getRowCount ([#474](https://github.com/adobe/helix-onedrive-support/issues/474)) ([593d3c1](https://github.com/adobe/helix-onedrive-support/commit/593d3c1a685444493fafa78d594e9c1e6bf58f85))
+
 ## [11.1.3](https://github.com/adobe/helix-onedrive-support/compare/v11.1.2...v11.1.3) (2023-12-09)
 
 

package/package.json

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

package/src/OneDriveMock.js

@@ -224,12 +224,17 @@ function handleTable(container, segs, method, body) {
  * @param {object} range The mock range
  * @param {string} method Request method
  * @param {object} body Request body
+ * @param {string} query query to select values
  * @returns {object} The response value
  */
-function handleRange(range, method, body) {
+function handleRange(range, method, body, query) {
   if (method === 'PATCH') {
     range.values = body;
   }
+  if (method === 'GET' && query) {
+    const property = new URLSearchParams(query).get('$select');
+    return { [property]: range[property] };
+  }
   return range;
 }
 
@@ -424,11 +429,13 @@ export class OneDriveMock extends OneDrive {
     const type = segs.shift();
     switch (type) {
       case 'usedRange':
-        return handleRange(sheet.usedRange, method, body);
+        return handleRange(sheet.usedRange, method, body, query);
       case 'tables':
         return handleTable(sheet, segs, method, body);
       case 'names':
         return handleNamedItems(sheet, segs, method, body);
+      case 'application':
+        return { calculate: () => {} };
       default:
         if (type?.startsWith('range(address=') && sheet.usedRange?.values) {
           const address = type.match(/range\(address='([^)]+)'\)/)[1];

package/src/excel/Application.d.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/**
+ * Excel Workbook Application
+ */
+export declare interface Application {
+  /**
+   * Calculate formulas in the workbook.
+   * @param {string} calculationType calculation type
+   */
+  calculate(calculationType: 'Recalculate' | 'Full' | 'FullRebuild'): Promise<void>;
+}

package/src/excel/Application.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2022 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 class Application {
+  /**
+   * Create a new instance of this class.
+   * @param {import('../GraphAPI.js').GraphAPI} graphAPI graph API
+   * @param {string} uri uri for this application
+   * @param {any} log logger
+   */
+  constructor(graphAPI, uri, log) {
+    this._graphAPI = graphAPI;
+    this._uri = uri;
+    this._log = log;
+  }
+
+  async calculate(calculationType) {
+    return this._graphAPI.doFetch(`${this.uri}/calculate`, false, {
+      method: 'POST',
+      body: { calculationType },
+      headers: { 'content-type': 'application/json' },
+    });
+  }
+
+  get uri() {
+    return this._uri;
+  }
+}

package/src/excel/Range.d.ts

@@ -48,6 +48,11 @@ export declare interface Range {
    */
   getRowsAsObjects(opts?:FormatOptions): Promise<Array<object>>;
 
+  /**
+   * Returns the row count.
+   */
+  getRowCount(): Promise<number>;
+
   /**
    * Returns the values of the range.
    */
@@ -63,15 +68,15 @@ export declare interface Range {
 
   /**
    * Deletes the cells associated with the range.
-   * @param shiftValue Specifies which way to shift the cells. 
+   * @param shiftValue Specifies which way to shift the cells.
    *                   The possible values are: Up, Left.
    */
   delete(shiftValue: string): Promise<void>;
 
   /**
-   * Inserts a cell or a range of cells into the worksheet in place of this range, 
+   * Inserts a cell or a range of cells into the worksheet in place of this range,
    * and shifts the other cells to make space.
-   * @param shiftValue Specifies which way to shift the cells. 
+   * @param shiftValue Specifies which way to shift the cells.
    *                   The possible values are: Down, Right.
    */
   insert(shiftValue: string): Promise<void>;

package/src/excel/Range.js

@@ -71,6 +71,14 @@ export class Range {
     return rows;
   }
 
+  async getRowCount() {
+    if (this._data) {
+      return this._data.rowCount;
+    }
+    const { rowCount } = await this._graphAPI.doFetch(`${this.uri}?$select=rowCount`);
+    return rowCount;
+  }
+
   async getValues() {
     if (!this._values) {
       if (this._data) {

package/src/excel/Workbook.d.ts

@@ -13,6 +13,7 @@ import { Table } from './Table';
 import { Worksheet } from './Worksheet';
 import { GraphResult } from '../OneDrive';
 import { NamedItem } from './NamedItem';
+import { Application } from './Application';
 
 /**
  * Excel Work book
@@ -120,4 +121,9 @@ export declare interface Workbook {
    * @param {string} sessionId session id
    */
   setSessionId(sessionId: string): void;
+
+  /**
+   * Return the workbook application
+   */
+  application(): Application;
 }

package/src/excel/Workbook.js

@@ -13,6 +13,7 @@ import { NamedItemContainer } from './NamedItemContainer.js';
 import { StatusCodeError } from '../StatusCodeError.js';
 import { Table } from './Table.js';
 import { Worksheet } from './Worksheet.js';
+import { Application } from './Application.js';
 
 export class Workbook extends NamedItemContainer {
   /**
@@ -158,6 +159,10 @@ export class Workbook extends NamedItemContainer {
     return table;
   }
 
+  application() {
+    return new Application(this, `${this._uri}/application`, this._log);
+  }
+
   get uri() {
     return this._uri;
   }