@adobe/helix-onedrive-support 5.2.1 → 6.1.0

package/.mocha-multi.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec,xunit",
+    "xunitReporterOptions": {
+        "output": "junit/test-results.xml"
+    }
+}

package/.nycrc.json

@@ -0,0 +1,10 @@
+{
+  "reporter": [
+    "lcov",
+    "text"
+  ],
+  "check-coverage": true,
+  "lines": 15,
+  "branches": 19,
+  "statements": 15
+}

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [6.1.0](https://github.com/adobe/helix-onedrive-support/compare/v6.0.1...v6.1.0) (2022-01-28)
+
+
+### Features
+
+* add API for SP API ([#227](https://github.com/adobe/helix-onedrive-support/issues/227)) ([6ce5938](https://github.com/adobe/helix-onedrive-support/commit/6ce59387a777d4549964a8fb90b2e0ca2a4fd86e))
+
+## [6.0.1](https://github.com/adobe/helix-onedrive-support/compare/v6.0.0...v6.0.1) (2021-10-18)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-fetch to v3 ([#202](https://github.com/adobe/helix-onedrive-support/issues/202)) ([1b0b586](https://github.com/adobe/helix-onedrive-support/commit/1b0b58661458550a3d6b782ada364f2f48d69fb0))
+
+# [6.0.0](https://github.com/adobe/helix-onedrive-support/compare/v5.2.2...v6.0.0) (2021-10-08)
+
+
+* Support conflict behaviour (#197) ([b4a5c72](https://github.com/adobe/helix-onedrive-support/commit/b4a5c72ed76062c558ea175aaedff3475e892c34)), closes [#197](https://github.com/adobe/helix-onedrive-support/issues/197)
+
+
+### BREAKING CHANGES
+
+* uploadDriveItem return value changed
+
+* fix: test behaviour values
+
+## [5.2.2](https://github.com/adobe/helix-onedrive-support/compare/v5.2.1...v5.2.2) (2021-10-08)
+
+
+### Bug Fixes
+
+* trim object names and values ([#196](https://github.com/adobe/helix-onedrive-support/issues/196)) ([f117175](https://github.com/adobe/helix-onedrive-support/commit/f117175f63316ed8a3b60f4e74870114134b9ef7))
+
 ## [5.2.1](https://github.com/adobe/helix-onedrive-support/compare/v5.2.0...v5.2.1) (2021-10-07)
 
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "5.2.1",
+  "version": "6.1.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "scripts": {
-    "test": " nyc --reporter=text --reporter=lcov --check-coverage --branches 19 --statements 15 --lines 15 mocha",
-    "test-ci": "nyc --reporter=text --reporter=lcov --check-coverage --branches 19 --statements 15 --lines 15 mocha --reporter xunit --reporter-options output=./junit/test-results.xml && codecov",
+    "test": "nyc mocha",
+    "test-ci": "nyc mocha && codecov",
     "lint": "./node_modules/.bin/eslint .",
     "semantic-release": "semantic-release",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
@@ -23,28 +23,29 @@
   },
   "homepage": "https://github.com/adobe/helix-onedrive-support#readme",
   "dependencies": {
-    "@adobe/helix-fetch": "2.4.2",
+    "@adobe/helix-fetch": "3.0.0",
     "adal-node": "https://github.com/adobe-rnd/azure-activedirectory-library-for-nodejs.git#adobe"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "1.2.0",
-    "@semantic-release/changelog": "6.0.0",
-    "@semantic-release/git": "10.0.0",
-    "ajv": "8.6.3",
+    "@adobe/eslint-config-helix": "1.3.2",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "ajv": "8.9.0",
     "codecov": "3.8.3",
     "commitizen": "4.2.4",
     "cz-conventional-changelog": "3.3.0",
-    "dotenv": "10.0.0",
-    "eslint": "7.32.0",
+    "dotenv": "14.2.0",
+    "eslint": "8.7.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.24.2",
-    "jsdoc-to-markdown": "7.0.1",
+    "eslint-plugin-import": "2.25.4",
+    "jsdoc-to-markdown": "7.1.0",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "11.1.2",
-    "mocha": "9.1.2",
-    "nock": "13.1.3",
+    "lint-staged": "12.3.1",
+    "mocha": "9.1.4",
+    "mocha-multi-reporters": "1.5.1",
+    "nock": "13.2.2",
     "nyc": "15.1.0",
-    "semantic-release": "18.0.0"
+    "semantic-release": "19.0.2"
   },
   "lint-staged": {
     "*.js": "eslint"
@@ -56,5 +57,11 @@
     "ghooks": {
       "pre-commit": "npx lint-staged"
     }
+  },
+  "mocha": {
+    "spec": "test/**/*.test.js",
+    "require": "test/setup-env.js",
+    "reporter": "mocha-multi-reporters",
+    "reporter-options": "configFile=.mocha-multi.json"
   }
 }

package/src/OneDrive.d.ts

@@ -60,6 +60,36 @@ export declare interface SubscriptionOptions {
   expiresIn?: number;
 }
 
+export declare interface SharePointSite {
+  /**
+   * Return a file's properties.
+   * @param file file name
+   * @returns file properties
+   */
+  getFile(file: string): Promise<GraphResult>;
+
+  /**
+   * Return a folder's properties.
+   * @param folder folder name
+   * @returns folder properties
+   */
+  getFolder(folder: string): Promise<GraphResult>;
+
+  /**
+   * Return a file's contents, as a binary buffer.
+   * @param file file name
+   * @returns file contents
+   */
+  getFileContents(file: string): Promise<Buffer>;
+
+  /**
+   * Returns a list of children items in a folder
+   * @param folder folder name
+   * @returns list of files and folders
+   */
+  getFilesAndFolders(folder: string): Promise<GraphResult>;
+}
+
 /**
  * Helper class that facilitates accessing one drive.
  */
@@ -203,7 +233,15 @@ export declare class OneDrive extends EventEmitter {
 
   deleteSubscription(id: string): Promise<GraphResult>;
 
-  uploadDriveItem(buffer: Buffer, driveItem: string, relPath?: string);
+  /**
+   * Uploads a drive item.
+   *
+   * @param buffer contents of file
+   * @param driveItem parent item in combination with relPath or item itself
+   * @param relPath relative path
+   * @param conflictBehaviour replace, rename or fail, default is replace
+   */
+  uploadDriveItem(buffer: Buffer, driveItem: string, relPath?: string, conflictBehaviour?: string);
 
   /**
    * Returns the root item for a drive given its id.
@@ -220,4 +258,11 @@ export declare class OneDrive extends EventEmitter {
    * @returns {Promise<Array>} A return object with the values and a `@odata.deltaLink`.
    */
   fetchChanges(resource: string, token?: string);
+
+  /**
+   * Returns a site object exposing the SharePoint API (now called Graph API V1).
+   * @param siteURL site URL, in the format https://<tenant>.sharepoint.com/sites/<site>
+   * @return {Promise<SharePointSite} site object
+   */
+  getSite(siteURL: string): Promise<SharePointSite>;
 }

package/src/OneDrive.js

@@ -20,6 +20,7 @@ const Workbook = require('./Workbook.js');
 const StatusCodeError = require('./StatusCodeError.js');
 const { driveItemFromURL, driveItemToURL } = require('./utils.js');
 const { splitByExtension, sanitize, editDistance } = require('./fuzzy-helper.js');
+const SharePointSite = require('./SharePointSite.js');
 
 const { fetch, reset } = process.env.HELIX_FETCH_FORCE_HTTP1
   ? fetchAPI.context({
@@ -204,18 +205,26 @@ class OneDrive extends EventEmitter {
       if (this.refreshToken) {
         log.debug('acquire token with refresh token.');
         const resp = await context.acquireTokenWithRefreshToken(
-          this.refreshToken, this.clientId, this.clientSecret, AZ_RESOURCE,
+          this.refreshToken,
+          this.clientId,
+          this.clientSecret,
+          AZ_RESOURCE,
         );
         return await this.augmentAndCacheResponse(resp);
       } else if (this.username && this.password) {
         log.debug('acquire token with ROPC.');
         return await context.acquireTokenWithUsernamePassword(
-          AZ_RESOURCE, this.username, this.password, this.clientId,
+          AZ_RESOURCE,
+          this.username,
+          this.password,
+          this.clientId,
         );
       } else if (this.clientSecret) {
         log.debug('acquire token with client credentials.');
         return await context.acquireTokenWithClientCredentials(
-          AZ_RESOURCE, this.clientId, this.clientSecret,
+          AZ_RESOURCE,
+          this.clientId,
+          this.clientSecret,
         );
       } else {
         const err = new StatusCodeError('No valid authentication credentials supplied.');
@@ -259,7 +268,11 @@ class OneDrive extends EventEmitter {
     const { log, authContext: context } = this;
     try {
       const resp = await context.acquireTokenWithAuthorizationCode(
-        code, redirectUri, AZ_RESOURCE, this.clientId, this.clientSecret,
+        code,
+        redirectUri,
+        AZ_RESOURCE,
+        this.clientId,
+        this.clientSecret,
       );
       return await this.augmentAndCacheResponse(resp);
     } catch (e) {
@@ -489,7 +502,15 @@ class OneDrive extends EventEmitter {
   /**
    * @see https://docs.microsoft.com/en-us/graph/api/driveitem-put-content?view=graph-rest-1.0&tabs=http
    */
-  async uploadDriveItem(buffer, driveItem, relPath = '') {
+  async uploadDriveItem(buffer, driveItem, relPath = '', conflictBehaviour = 'replace') {
+    const validConflictBehaviours = [
+      'replace',
+      'rename',
+      'fail',
+    ];
+    if (!validConflictBehaviours.includes(conflictBehaviour)) {
+      throw new Error(`Bad confict behaviour: ${conflictBehaviour}, must be one of: ${validConflictBehaviours.join('/')}`);
+    }
     // eslint-disable-next-line no-param-reassign
     relPath = relPath.replace(/\/+$/, '');
     if (relPath) {
@@ -498,7 +519,7 @@ class OneDrive extends EventEmitter {
     }
 
     // PUT /drives/{drive-id}/items/{parent-id}:/{filename}:/content
-    const uri = `/drives/${driveItem.parentReference.driveId}/items/${driveItem.id}${relPath}/content`;
+    const uri = `/drives/${driveItem.parentReference.driveId}/items/${driveItem.id}${relPath}/content?@microsoft.graph.conflictBehavior=${conflictBehaviour}`;
     const opts = {
       method: 'PUT',
       body: buffer,
@@ -506,7 +527,7 @@ class OneDrive extends EventEmitter {
         'Content-Type': 'application/octet-stream',
       },
     };
-    return this.doFetch(uri, true, opts);
+    return this.doFetch(uri, false, opts);
   }
 
   /**
@@ -603,6 +624,35 @@ class OneDrive extends EventEmitter {
       }
     }
   }
+
+  async getSite(siteURL) {
+    this.log.debug(`getting site: (${siteURL})`);
+
+    const match = siteURL.match(/^https:\/\/(\S+).sharepoint.com\/sites\/([^/]+)\/(\S+)$/);
+    if (!match) {
+      throw new Error(`Site URL does not match (*.sharepoint.com/sites/.*): ${match}`);
+    }
+    const [, owner, site, root] = match;
+
+    try {
+      const accessToken = await this.getAccessToken();
+      return new SharePointSite({
+        owner,
+        site,
+        root,
+        clientId: this.clientId,
+        tenantId: accessToken.tenantId,
+        refreshToken: accessToken.refreshToken,
+        log: this.log,
+      });
+    } catch (e) {
+      if (e.statusCode === 401) {
+        // an inexistant share returns 401, we prefer to just say it wasn't found
+        throw new StatusCodeError(e.message, 404, e.details);
+      }
+      throw e;
+    }
+  }
 }
 
 module.exports = Object.assign(OneDrive, {

package/src/Range.d.ts

@@ -11,6 +11,7 @@
  */
 
 import { GraphResult, Logger } from './OneDrive'
+import { FormatOptions } from "./Table";
 
 /**
  * Excel Range
@@ -45,7 +46,7 @@ export declare interface Range {
    * Returns the rows as a list of objects. the rows have the columns names as property names
    * and the row values as value.
    */
-  getRowsAsObjects(): Promise<Array<object>>;
+  getRowsAsObjects(opts?:FormatOptions): Promise<Array<object>>;
 
   /**
    * Returns the values of the range.

package/src/Range.js

@@ -9,6 +9,8 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+const { superTrim } = require('./utils.js');
+
 class Range {
   constructor(oneDrive, uri, log) {
     this._oneDrive = oneDrive;
@@ -44,13 +46,18 @@ class Range {
     return (await this.getData()).values[0];
   }
 
-  async getRowsAsObjects() {
+  async getRowsAsObjects({ trim = false } = {}) {
     const values = await this.getValues();
 
     const columnNames = values[0];
     const rows = values.map((row) => columnNames.reduce((obj, name, index) => {
-      // eslint-disable-next-line no-param-reassign
-      obj[name] = row[index];
+      if (trim) {
+        // eslint-disable-next-line no-param-reassign
+        obj[superTrim(name)] = superTrim(row[index]);
+      } else {
+        // eslint-disable-next-line no-param-reassign
+        obj[name] = row[index];
+      }
       return obj;
     }, {}));
     // discard first row

package/src/SharePointSite.js

@@ -0,0 +1,139 @@
+/*
+ * Copyright 2021 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.
+ */
+
+const fetchAPI = require('@adobe/helix-fetch');
+const StatusCodeError = require('./StatusCodeError.js');
+
+/* istanbul ignore next */
+const { fetch } = process.env.HELIX_FETCH_FORCE_HTTP1
+  ? fetchAPI.context({
+    alpnProtocols: [fetchAPI.ALPN_HTTP1_1],
+    userAgent: 'helix-fetch', // static user agent for test recordings
+  })
+  /* istanbul ignore next */
+  : fetchAPI;
+
+/**
+ * Helper class accessing folders and files using the SharePoint V1 API.
+ */
+class SharePointSite {
+  constructor(opts) {
+    this._owner = opts.owner;
+    this._site = opts.site;
+    this._clientId = opts.clientId;
+    this._tenantId = opts.tenantId;
+    this._refreshToken = opts.refreshToken;
+    this._root = opts.root || '';
+    this._log = opts.log || console;
+  }
+
+  async getAccessToken() {
+    const { log } = this;
+    if (!this._accessToken || Date.now() >= this._expires) {
+      const url = `https://login.microsoftonline.com/${this._tenantId}/oauth2/v2.0/token`;
+      const resp = await fetch(url, {
+        method: 'POST',
+        body: new URLSearchParams({
+          client_id: this._clientId,
+          refresh_token: this._refreshToken,
+          grant_type: 'refresh_token',
+          scope: `https://${this._owner}.sharepoint.com/Sites.ReadWrite.All`,
+        }),
+      });
+      if (!resp.ok) {
+        const text = await resp.text();
+        log.error(`Error while getting a SharePoint API token: ${text}}`);
+        throw new StatusCodeError(text, resp.status);
+      }
+      const json = await resp.json();
+      this._accessToken = json.access_token;
+      this._expires = Date.now() + json.expires_in * 1000;
+    }
+    return this._accessToken;
+  }
+
+  _splitDirAndBase(file) {
+    const idx = file.lastIndexOf('/');
+    const [dir, base] = (idx < 0)
+      ? ['', file]
+      : [file.substring(0, idx), file.substring(idx + 1)];
+    return dir ? [`${this._root}/${dir}`, base] : [this._root, base];
+  }
+
+  _getRelativePath(folder) {
+    return folder ? `${this._root}/${folder}` : this._root;
+  }
+
+  async getFile(file) {
+    const [dir, base] = this._splitDirAndBase(file);
+    return this.doFetch(`/GetFolderByServerRelativeUrl('${dir}')/Files('${base}')?$expand=ModifiedBy`);
+  }
+
+  async getFolder(folder) {
+    const dir = this._getRelativePath(folder);
+    return this.doFetch(`/GetFolderByServerRelativeUrl('${dir}')`);
+  }
+
+  async getFileContents(file) {
+    const [dir, base] = this._splitDirAndBase(file);
+    return this.doFetch(`/GetFolderByServerRelativeUrl('${dir}')/Files('${base}')/$value`, true);
+  }
+
+  async getFilesAndFolders(folder) {
+    const dir = this._getRelativePath(folder);
+    return this.doFetch(`/GetFolderByServerRelativeUrl('${dir}')?$expand=Files/ModifiedBy,Folders`);
+  }
+
+  async doFetch(relUrl, rawResponseBody = false) {
+    const opts = { headers: {} };
+    const accessToken = await this.getAccessToken();
+    opts.headers.authorization = `Bearer ${accessToken}`;
+    if (!rawResponseBody) {
+      opts.headers.accept = 'application/json;odata=verbose';
+    }
+
+    const url = `https://${this._owner}.sharepoint.com/sites/${this._site}/_api/web${relUrl}`;
+    try {
+      const resp = await fetch(url, opts);
+      if (!resp.ok) {
+        const text = await resp.text();
+        let err;
+        try {
+          // try to parse json
+          err = StatusCodeError.fromErrorResponse(JSON.parse(text), resp.status);
+        } catch {
+          err = new StatusCodeError(text, resp.status);
+        }
+        throw err;
+      }
+      // check content type before trying to parse a response body as JSON
+      const contentType = resp.headers.get('content-type');
+      const json = contentType && contentType.startsWith('application/json');
+
+      // await result in order to be able to catch any error
+      return await (rawResponseBody || !json ? resp.buffer() : resp.json());
+    } catch (e) {
+      /* istanbul ignore else */
+      if (e instanceof StatusCodeError) {
+        throw e;
+      }
+      /* istanbul ignore next */
+      throw StatusCodeError.fromError(e);
+    }
+  }
+
+  get log() {
+    return this._log;
+  }
+}
+
+module.exports = SharePointSite;

package/src/StatusCodeError.js

@@ -58,7 +58,7 @@ class StatusCodeError extends Error {
    * @param {object} details underlying error
    */
   constructor(msg, statusCode, details) {
-    super(msg);
+    super(msg?.value ?? msg);
     this.statusCode = statusCode;
     this.details = details;
   }

package/src/Table.d.ts

@@ -9,7 +9,14 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { GraphResult } from './OneDrive';
+import {DriveItem, GraphResult} from './OneDrive';
+
+export declare interface FormatOptions {
+  /**
+   * Trims the object names and values and strips zero-width unicode characters.
+   */
+  trim?:boolean;
+}
 
 /**
  * Excel Table
@@ -37,7 +44,7 @@ export declare interface Table {
    * Returns the rows as a list of objects. the rows have the columns names as property names
    * and the row values as value.
    */
-  getRowsAsObjects(): Promise<Array<object>>;
+  getRowsAsObjects(opts?:FormatOptions): Promise<Array<object>>;
 
   /**
    * Return a row given its index
@@ -85,5 +92,5 @@ export declare interface Table {
    * @param index zero-based index or missing to add at end
    * @returns new column
    */
-   addColumn(name, index?): Promise<DriveItem>;
+   addColumn(name:string, index?:number): Promise<DriveItem>;
 }

package/src/Table.js

@@ -9,6 +9,8 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+const { superTrim } = require('./utils.js');
+
 class Table {
   constructor(oneDrive, prefix, name, log) {
     this._oneDrive = oneDrive;
@@ -39,7 +41,7 @@ class Table {
     return result.value.map((v) => v.values[0]);
   }
 
-  async getRowsAsObjects() {
+  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`);
@@ -49,8 +51,13 @@ class Table {
     const rowValues = result.value[0].values
       .map((_, rownum) => columnNames.reduce((row, name, column) => {
         const [value] = result.value[column].values[rownum];
-        // eslint-disable-next-line no-param-reassign
-        row[name] = value;
+        if (trim) {
+          // eslint-disable-next-line no-param-reassign
+          row[superTrim(name)] = superTrim(value);
+        } else {
+          // eslint-disable-next-line no-param-reassign
+          row[name] = value;
+        }
         return row;
       }, {}));
 

package/src/utils.js

@@ -10,6 +10,23 @@
  * governing permissions and limitations under the License.
  */
 
+/**
+ * Trims the string at both ends and removes the zero width unicode chars:
+ *
+ * - U+200B zero width space
+ * - U+200C zero width non-joiner Unicode code point
+ * - U+200D zero width joiner Unicode code point
+ * - U+FEFF zero width no-break space Unicode code point
+ *
+ * @param {string} str input string
+ * @return {string} trimmed and stripped string
+ */
+function superTrim(str) {
+  return String(str)
+    .replace(/[\u200B-\u200D\uFEFF]/g, '')
+    .trim();
+}
+
 /**
  * Returns a onedrive uri for the given drive item. the uri has the format:
  * `onedrive:/drives/<driveId>/items/<itemId>`
@@ -55,4 +72,5 @@ function driveItemFromURL(url) {
 module.exports = {
   driveItemFromURL,
   driveItemToURL,
+  superTrim,
 };