@adobe/helix-onedrive-support 10.3.7 → 10.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [10.5.0](https://github.com/adobe/helix-onedrive-support/compare/v10.4.0...v10.5.0) (2023-09-01)
+
+
+### Features
+
+* added excel workbook functionalities ([8782e56](https://github.com/adobe/helix-onedrive-support/commit/8782e560593b02e56dcb33595256089ffaa35132))
+
+# [10.4.0](https://github.com/adobe/helix-onedrive-support/compare/v10.3.7...v10.4.0) (2023-08-28)
+
+
+### Features
+
+* add log fields for API call logging ([#425](https://github.com/adobe/helix-onedrive-support/issues/425)) ([36f88db](https://github.com/adobe/helix-onedrive-support/commit/36f88db697db73a7fc24da062f66d66aeab32bc0))
+
 ## [10.3.7](https://github.com/adobe/helix-onedrive-support/compare/v10.3.6...v10.3.7) (2023-08-21)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "10.3.7",
+  "version": "10.5.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {
@@ -36,12 +36,12 @@
     "@adobe/eslint-config-helix": "2.0.3",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@aws-sdk/client-s3": "3.395.0",
+    "@aws-sdk/client-s3": "3.400.0",
     "ajv": "8.12.0",
     "c8": "8.0.1",
     "codecov": "3.8.3",
     "dotenv": "16.3.1",
-    "eslint": "8.47.0",
+    "eslint": "8.48.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.28.1",
     "husky": "8.0.3",
@@ -49,12 +49,12 @@
     "jsdoc-to-markdown": "8.0.0",
     "jsdoc-tsimport-plugin": "1.0.5",
     "junit-report-builder": "3.0.1",
-    "lint-staged": "14.0.0",
+    "lint-staged": "14.0.1",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "nock": "13.3.3",
     "npm": "9.8.1",
-    "semantic-release": "21.0.7"
+    "semantic-release": "21.1.1"
   },
   "lint-staged": {
     "*.js": "eslint"

package/src/OneDrive.d.ts

@@ -149,6 +149,14 @@ export declare class OneDrive extends EventEmitter {
    */
   getDriveItem(folderItem: DriveItem, relPath?: string, download?: boolean): Promise<GraphResult>;
 
+
+  /**
+   * Returns the parentdrive item for the given driveItem
+   *
+   * @param {DriveItem} driveItem Drive Item.
+   */
+  getParentDriveItem(driveItem: DriveItemn): Promise<GraphResult>;
+
   /**
    * Tries to get the drive items for the given folder and relative path, by loading the files of
    * the respective directory and returning the item with the best matching filename. Please note,

package/src/OneDrive.js

@@ -125,14 +125,19 @@ export class OneDrive {
       opts.headers = {};
     }
     opts.headers.authorization = `Bearer ${accessToken}`;
+
+    const { log, auth: { logFields, tenant } } = this;
     const url = `https://graph.microsoft.com/v1.0${relUrl}`;
+    const method = opts.method || 'GET';
+
     try {
       const { fetch } = this.fetchContext;
       const resp = await fetch(url, opts);
-      const rateLimit = RateLimit.fromHeaders(resp.headers);
+      log.info(`OneDrive API [tenant:${tenant}] ${logFields}: ${method} ${relUrl} ${resp.status}`);
 
+      const rateLimit = RateLimit.fromHeaders(resp.headers);
       if (rateLimit) {
-        this.log.warn({ sharepointRateLimit: { tenant: this.auth.tenant, ...rateLimit.toJSON() } });
+        log.warn({ sharepointRateLimit: { tenant, ...rateLimit.toJSON() } });
       }
 
       if (!resp.ok) {
@@ -157,6 +162,7 @@ export class OneDrive {
       if (!(e instanceof StatusCodeError)) {
         err = StatusCodeError.fromError(e);
       }
+      log.info(`OneDrive API [tenant:${tenant}] ${logFields}: ${method} ${relUrl} ${e.statusCode}`);
       throw err;
     }
   }
@@ -347,6 +353,13 @@ export class OneDrive {
     return download ? this.doFetch(`${uri}:/content`, true) : this.doFetch(uri);
   }
 
+  /**
+   */
+  async getParentDriveItem(driveItem) {
+    const parentURI = `/drives/${driveItem.parentReference.driveId}/items/${driveItem.parentReference.id}`;
+    return this.doFetch(parentURI, false);
+  }
+
   /**
    */
   async downloadDriveItem(driveItem) {

package/src/OneDriveAuth.d.ts

@@ -28,6 +28,11 @@ export declare interface OneDriveAuthOptions {
   acquireMethod?: AcquireMethod;
   accessToken?: string;
 
+  /**
+   * Optional log fields, as key-value object.
+   */
+  logFields?: object;
+
   /**
    * use cache plugin instead for default (global) token cache.
    */

package/src/OneDriveAuth.js

@@ -76,6 +76,8 @@ export class OneDriveAuth {
     this.scopes = opts.scopes || DEFAULT_SCOPES;
     this.onCode = opts.onCode;
     this.acquireMethod = opts.acquireMethod || '';
+    this.logFields = Object.entries(opts.logFields || {})
+      .map(([key, value]) => `[${key}:${value}]`).join(' ');
 
     const validAcquireMethods = Array.from(Object.values(AcquireMethod));
     if (this.acquireMethod && !validAcquireMethods.includes(this.acquireMethod)) {

package/src/OneDriveMock.js

@@ -355,6 +355,10 @@ export class OneDriveMock extends OneDrive {
       segs.shift();
       if (segs[0]) {
         const sheetName = segs.shift();
+        if (method === 'DELETE' && segs.length === 0) {
+          data.sheets = data.sheets.filter((s) => (s.name !== sheetName));
+          return data.sheets;
+        }
         sheet = data.sheets.find((s) => (s.name === sheetName));
         if (!sheet) {
           throw new StatusCodeError(sheetName, 404);
@@ -363,6 +367,11 @@ export class OneDriveMock extends OneDrive {
           // if no more segments, return the sheet data
           return { value: sheet };
         }
+      } else if (method === 'POST') {
+        data.sheets.push({
+          name: body.name,
+        });
+        return { value: data.sheets.map((st) => ({ name: st.name })) };
       } else {
         return { value: data.sheets.map((st) => ({ name: st.name })) };
       }

package/src/excel/Workbook.d.ts

@@ -24,6 +24,20 @@ export declare interface Workbook {
    */
   getWorksheetNames(): Promise<string[]>;
 
+  /**
+   * Create the worksheet with given name in the workbook.
+   * @param {string} sheetName sheet name
+   * @returns Worksheet
+   * 
+   */
+  createWorksheet(sheetName: string): Worksheet;
+
+  /**
+   * Delete the worksheet with given name in the workbook.
+   * @param {string} sheetName sheet name
+   */
+  deleteWorksheet(sheetName: string): Promise<void>;
+
   /**
    * Return a new `Worksheet` instance given its name
    * @param name work sheet name

package/src/excel/Workbook.js

@@ -38,6 +38,24 @@ export class Workbook extends NamedItemContainer {
     return new Worksheet(this._oneDrive, `${this._uri}/worksheets`, name, this._log);
   }
 
+  async createWorksheet(sheetName) {
+    const uri = `${this.uri}/worksheets`;
+    await this._oneDrive.doFetch(uri, false, {
+      method: 'POST',
+      body: { name: sheetName },
+      headers: { 'content-type': 'application/json' },
+    });
+    return this.worksheet(sheetName);
+  }
+
+  async deleteWorksheet(sheetName) {
+    const uri = `${this.uri}/worksheets/${sheetName}`;
+    await this._oneDrive.doFetch(uri, false, {
+      method: 'DELETE',
+      headers: { 'content-type': 'application/json' },
+    });
+  }
+
   async getTableNames() {
     this.log.debug(`get table names from ${this._uri}/tables`);
     const result = await this._oneDrive.doFetch(`${this._uri}/tables`);