@adobe/helix-onedrive-support 7.1.4 → 8.0.0

package/.eslintrc.cjs

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 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.
+ */
+
+module.exports = {
+  root: true,
+  extends: '@adobe/helix',
+  env: {
+    node: true,
+    es6: true,
+  },
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2020,
+  },
+  rules: {
+    'import/extensions': [2, 'ignorePackages'],
+    'import/prefer-default-export': 0,
+    'no-param-reassign': ['error', { props: false }],
+  },
+  globals: {
+    __rootdir: true,
+    __testdir: true,
+  },
+};

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/.jsdoc.json

@@ -1,5 +1,7 @@
 {
-  "plugins": [],
+  "plugins": [
+    "node_modules/jsdoc-tsimport-plugin/index.js"
+  ],
   "recurseDepth": 10,
   "source": {
       "includePattern": ".+\\.js(doc|x)?$",
@@ -14,4 +16,4 @@
       "cleverLinks": false,
       "monospaceLinks": false
   }
-}
+}

package/.nycrc.json

@@ -4,7 +4,8 @@
     "text"
   ],
   "check-coverage": true,
-  "lines": 83,
-  "branches": 77,
-  "statements": 83
+  "statements": 87,
+  "branches": 80,
+  "functions": 87,
+  "lines": 87
 }

package/.releaserc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", {
+      "changelogFile": "CHANGELOG.md",
+    }],
+    "@semantic-release/npm",
+    ["@semantic-release/git", {
+      "assets": ["package.json", "CHANGELOG.md"],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }],
+    ["@semantic-release/github", {}]
+  ],
+  branches: ['main']
+};

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [8.0.0](https://github.com/adobe/helix-onedrive-support/compare/v7.1.4...v8.0.0) (2022-05-03)
+
+
+### Features
+
+* use msal-node ([a6dca62](https://github.com/adobe/helix-onedrive-support/commit/a6dca6215af57d9ea5ad830003d0192a67b91bff)), closes [#180](https://github.com/adobe/helix-onedrive-support/issues/180)
+
+
+### BREAKING CHANGES
+
+* Major refactoring
+- ESM only
+- new OneDriveAuth class handling all authentication
+- OneDrive no longer takes auth specific options; use OneDriveAuth instead
+- username/password authentication no longer supported
+
+Feature:
+
+- Authentication cache (store) is now pluggable
+- Memory, Filesystem and S3 based cache plugins available
+
 ## [7.1.4](https://github.com/adobe/helix-onedrive-support/compare/v7.1.3...v7.1.4) (2022-04-30)
 
 

package/docs/API.md

@@ -4,18 +4,38 @@
 <dt><a href="#OneDrive">OneDrive</a></dt>
 <dd><p>Helper class that facilitates accessing one drive.</p>
 </dd>
+<dt><a href="#OneDriveAuth">OneDriveAuth</a></dt>
+<dd><p>Helper class that facilitates accessing one drive.</p>
+</dd>
 <dt><a href="#OneDriveMock">OneDriveMock</a></dt>
 <dd><p>Mock OneDrive client that supports some of the operations the <code>OneDrive</code> class does.</p>
 </dd>
+<dt><a href="#SharePointSite">SharePointSite</a></dt>
+<dd><p>Helper class accessing folders and files using the SharePoint V1 API.</p>
+</dd>
+</dl>
+
+## Constants
+
+<dl>
+<dt><a href="#globalTenantCache">globalTenantCache</a> : <code>Map.&lt;string, string&gt;</code></dt>
+<dd><p>map that caches the tenant ids</p>
+</dd>
 </dl>
 
 ## Functions
 
 <dl>
+<dt><a href="#handleNamedItems">handleNamedItems(sheet, segs, method, body)</a> ⇒ <code>object</code></dt>
+<dd><p>Handle the <code>namedItems</code> operation on a workbook / worksheet</p>
+</dd>
+<dt><a href="#handleTable">handleTable(sheet, segs, method, body)</a> ⇒ <code>object</code></dt>
+<dd><p>Handle the <code>table</code> operation on a workbook / worksheet</p>
+</dd>
 <dt><a href="#splitByExtension">splitByExtension(name)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
 <dd><p>Splits the given name at the last &#39;.&#39;, returning the extension and the base name.</p>
 </dd>
-<dt><a href="#sanitize">sanitize(name)</a> ⇒ <code>string</code></dt>
+<dt><a href="#sanitizeName">sanitizeName(name)</a> ⇒ <code>string</code></dt>
 <dd><p>Sanitizes the given string by :</p>
 <ul>
 <li>convert to lower case</li>
@@ -25,320 +45,77 @@
 <li>remove all leading and trailing dashes</li>
 </ul>
 </dd>
+<dt><a href="#sanitizePath">sanitizePath(filepath, opts)</a> ⇒ <code>string</code></dt>
+<dd><p>Sanitizes the file path by:</p>
+<ul>
+<li>convert to lower case</li>
+<li>normalize all unicode characters</li>
+<li>replace all non-alphanumeric characters with a dash</li>
+<li>remove all consecutive dashes</li>
+<li>remove all leading and trailing dashes</li>
+</ul>
+<p>Note that only the basename of the file path is sanitized. i.e. The ancestor path and the
+extension is not affected.</p>
+</dd>
 <dt><a href="#editDistance">editDistance(s0, s1)</a> ⇒ <code>number</code> | <code>*</code></dt>
 <dd><p>Compute the edit distance using a recursive algorithm. since we only expect to have relative
 short filenames, the algorithm shouldn&#39;t be too expensive.</p>
 </dd>
-<dt><a href="#handleNamedItems">handleNamedItems(sheet, segs, method, body)</a> ⇒ <code>object</code></dt>
-<dd><p>Handle the <code>namedItems</code> operation on a workbook / worksheet</p>
-</dd>
-<dt><a href="#handleTable">handleTable(sheet, segs, method, body)</a> ⇒ <code>object</code></dt>
-<dd><p>Handle the <code>table</code> operation on a workbook / worksheet</p>
-</dd>
-<dt><a href="#driveItemToURL">driveItemToURL(driveItem)</a> ⇒ <code>URL</code></dt>
-<dd><p>Returns a onedrive uri for the given drive item. the uri has the format:
-<code>onedrive:/drives/&lt;driveId&gt;/items/&lt;itemId&gt;</code></p>
-</dd>
-<dt><a href="#driveItemFromURL">driveItemFromURL(url)</a> ⇒ <code>DriveItem</code></dt>
-<dd><p>Returns a partial drive item from the given url. The urls needs to have the format:
-<code>onedrive:/drives/&lt;driveId&gt;/items/&lt;itemId&gt;</code>. if the url does not start with the correct
-protocol, {@code null} is returned.</p>
+<dt><a href="#superTrim">superTrim(str)</a> ⇒ <code>string</code></dt>
+<dd><p>Trims the string at both ends and removes the zero width unicode chars:</p>
+<ul>
+<li>U+200B zero width space</li>
+<li>U+200C zero width non-joiner Unicode code point</li>
+<li>U+200D zero width joiner Unicode code point</li>
+<li>U+FEFF zero width no-break space Unicode code point</li>
+</ul>
 </dd>
 </dl>
 
-<a name="OneDrive"></a>
-
-## OneDrive
-Helper class that facilitates accessing one drive.
-
-**Kind**: global class  
-
-* [OneDrive](#OneDrive)
-    * [new OneDrive(opts)](#new_OneDrive_new)
-    * _instance_
-        * [.log](#OneDrive+log)
-        * [.authenticated](#OneDrive+authenticated) ⇒ <code>boolean</code>
-        * [.dispose()](#OneDrive+dispose)
-        * [.loadTokenCache(entries)](#OneDrive+loadTokenCache) ⇒
-        * [.login()](#OneDrive+login) ⇒ <code>Promise.&lt;TokenResponse&gt;</code>
-        * [.getAccessToken()](#OneDrive+getAccessToken)
-        * [.createLoginUrl()](#OneDrive+createLoginUrl)
-        * [.acquireToken()](#OneDrive+acquireToken)
-        * [.doFetch()](#OneDrive+doFetch)
-        * [.resolveShareLink()](#OneDrive+resolveShareLink)
-        * [.getDriveRootItem()](#OneDrive+getDriveRootItem)
-        * [.getDriveItemFromShareLink()](#OneDrive+getDriveItemFromShareLink)
-        * [.listChildren()](#OneDrive+listChildren)
-        * [.fuzzyGetDriveItem(folderItem, relPath)](#OneDrive+fuzzyGetDriveItem) ⇒ <code>Promise.&lt;Array.&lt;DriveItem&gt;&gt;</code>
-        * [.getDriveItem()](#OneDrive+getDriveItem)
-        * [.downloadDriveItem()](#OneDrive+downloadDriveItem)
-        * [.uploadDriveItem()](#OneDrive+uploadDriveItem)
-        * [.getWorkbook()](#OneDrive+getWorkbook)
-        * [.listSubscriptions()](#OneDrive+listSubscriptions)
-        * [.createSubscription()](#OneDrive+createSubscription)
-        * [.refreshSubscription()](#OneDrive+refreshSubscription)
-        * [.deleteSubscription()](#OneDrive+deleteSubscription)
-        * [.fetchChanges(resource, [token])](#OneDrive+fetchChanges) ⇒ <code>Promise.&lt;Array&gt;</code>
-    * _static_
-        * [.MAX_SUBSCRIPTION_EXPIRATION_TIME](#OneDrive.MAX_SUBSCRIPTION_EXPIRATION_TIME)
-        * [.encodeSharingUrl(sharingUrl)](#OneDrive.encodeSharingUrl) ⇒ <code>string</code>
-
-<a name="new_OneDrive_new"></a>
-
-### new OneDrive(opts)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| opts | <code>OneDriveOptions</code> | Options |
-| opts.clientId | <code>string</code> | The client id of the app |
-| [opts.clientSecret] | <code>string</code> | The client secret of the app |
-| [opts.refreshToken] | <code>string</code> | The refresh token. |
-| [opts.accessToken] | <code>string</code> | The access token. |
-| [opts.username] | <code>string</code> | Username for username/password authentication. |
-| [opts.password] | <code>string</code> | Password for username/password authentication. |
-| [opts.expiresOn] | <code>number</code> | Expiration time. |
-| [opts.log] | <code>Logger</code> | A logger. |
-
-<a name="OneDrive+log"></a>
-
-### oneDrive.log
-**Kind**: instance property of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+authenticated"></a>
-
-### oneDrive.authenticated ⇒ <code>boolean</code>
-**Kind**: instance property of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+dispose"></a>
-
-### oneDrive.dispose()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+loadTokenCache"></a>
-
-### oneDrive.loadTokenCache(entries) ⇒
-Adds entries to the token cache
-
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-**Returns**: this;  
-
-| Param | Type |
-| --- | --- |
-| entries | <code>Array.&lt;TokenResponse&gt;</code> | 
-
-<a name="OneDrive+login"></a>
-
-### oneDrive.login() ⇒ <code>Promise.&lt;TokenResponse&gt;</code>
-Performs a login using an interactive flow which prompts the user to open a browser window and
-enter the authorization code.
-
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-**Params**: <code>function</code> [onCode] - optional function that gets invoked after code was retrieved.  
-<a name="OneDrive+getAccessToken"></a>
-
-### oneDrive.getAccessToken()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+createLoginUrl"></a>
-
-### oneDrive.createLoginUrl()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+acquireToken"></a>
-
-### oneDrive.acquireToken()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+doFetch"></a>
-
-### oneDrive.doFetch()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+resolveShareLink"></a>
-
-### oneDrive.resolveShareLink()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+getDriveRootItem"></a>
-
-### oneDrive.getDriveRootItem()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+getDriveItemFromShareLink"></a>
-
-### oneDrive.getDriveItemFromShareLink()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+listChildren"></a>
-
-### oneDrive.listChildren()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+fuzzyGetDriveItem"></a>
-
-### oneDrive.fuzzyGetDriveItem(folderItem, relPath) ⇒ <code>Promise.&lt;Array.&lt;DriveItem&gt;&gt;</code>
-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,
-that only the files are matched 'fuzzily' but not the folders. The rules for transforming the
-filenames to the name segment of the `relPath` are:
-- convert to lower case
-- replace all non-alphanumeric characters with a dash
-- remove all consecutive dashes
-- extensions are ignored, if the given path doesn't have one
-
-The result is an array of drive items that match the given path. They are ordered by the edit
-distance to the original name and then alphanumerically.
-
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-
-| Param | Type |
-| --- | --- |
-| folderItem | <code>DriveItem</code> | 
-| relPath | <code>string</code> | 
-
-<a name="OneDrive+getDriveItem"></a>
-
-### oneDrive.getDriveItem()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+downloadDriveItem"></a>
-
-### oneDrive.downloadDriveItem()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+uploadDriveItem"></a>
-
-### oneDrive.uploadDriveItem()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-**See**: https://docs.microsoft.com/en-us/graph/api/driveitem-put-content?view=graph-rest-1.0&tabs=http  
-<a name="OneDrive+getWorkbook"></a>
-
-### oneDrive.getWorkbook()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+listSubscriptions"></a>
-
-### oneDrive.listSubscriptions()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+createSubscription"></a>
-
-### oneDrive.createSubscription()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+refreshSubscription"></a>
-
-### oneDrive.refreshSubscription()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+deleteSubscription"></a>
-
-### oneDrive.deleteSubscription()
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-<a name="OneDrive+fetchChanges"></a>
-
-### oneDrive.fetchChanges(resource, [token]) ⇒ <code>Promise.&lt;Array&gt;</code>
-Fetches the changes from the respective resource using the provided delta token.
-Use an empty token to fetch the initial state or `latest` to fetch the latest state.
-
-**Kind**: instance method of [<code>OneDrive</code>](#OneDrive)  
-**Returns**: <code>Promise.&lt;Array&gt;</code> - An object with an array of changes and a delta token.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| resource | <code>string</code> | OneDrive resource path. |
-| [token] | <code>string</code> | Delta token. |
-
-<a name="OneDrive.MAX_SUBSCRIPTION_EXPIRATION_TIME"></a>
-
-### OneDrive.MAX\_SUBSCRIPTION\_EXPIRATION\_TIME
-the maximum subscription time in milliseconds
-
-**Kind**: static constant of [<code>OneDrive</code>](#OneDrive)  
-**See**: https://docs.microsoft.com/en-us/graph/api/resources/subscription?view=graph-rest-1.0#maximum-length-of-subscription-per-resource-type  
-<a name="OneDrive.encodeSharingUrl"></a>
-
-### OneDrive.encodeSharingUrl(sharingUrl) ⇒ <code>string</code>
-Encodes the sharing url into a token that can be used to access drive items.
-
-**Kind**: static method of [<code>OneDrive</code>](#OneDrive)  
-**Returns**: <code>string</code> - an id for a shared item.  
-**See**: https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/shares_get?view=odsp-graph-online#encoding-sharing-urls  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| sharingUrl | <code>string</code> | A sharing URL from OneDrive |
+## Typedefs
 
-<a name="OneDriveMock"></a>
-
-## OneDriveMock
-Mock OneDrive client that supports some of the operations the `OneDrive` class does.
-
-**Kind**: global class  
-
-* [OneDriveMock](#OneDriveMock)
-    * [.registerWorkbook(driveId, itemId, data)](#OneDriveMock+registerWorkbook) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-    * [.registerDriveItem(driveId, itemId, data)](#OneDriveMock+registerDriveItem) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-    * [.registerDriveItemChildren(driveId, itemId, data)](#OneDriveMock+registerDriveItemChildren) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-    * [.registerShareLink(uri, driveId, itemId)](#OneDriveMock+registerShareLink) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-    * [.getDriveItemFromShareLink()](#OneDriveMock+getDriveItemFromShareLink)
-    * [.getWorkbook()](#OneDriveMock+getWorkbook)
-    * [.doFetch()](#OneDriveMock+doFetch)
-
-<a name="OneDriveMock+registerWorkbook"></a>
-
-### oneDriveMock.registerWorkbook(driveId, itemId, data) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-Register a mock workbook.
-
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**Returns**: [<code>OneDriveMock</code>](#OneDriveMock) - this  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| driveId | <code>string</code> | The drive id |
-| itemId | <code>string</code> | the item id |
-| data | <code>object</code> | Mock workbook data |
-
-<a name="OneDriveMock+registerDriveItem"></a>
-
-### oneDriveMock.registerDriveItem(driveId, itemId, data) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-Registers a mock drive item
+<dl>
+<dt><a href="#AuthenticationResult">AuthenticationResult</a> : <code>module:@azure/msal-node~AuthenticationResult</code></dt>
+<dd><p>aliases</p>
+</dd>
+</dl>
 
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**Returns**: [<code>OneDriveMock</code>](#OneDriveMock) - this  
+<a name="globalTenantCache"></a>
 
-| Param | Type | Description |
-| --- | --- | --- |
-| driveId | <code>string</code> | The drive id |
-| itemId | <code>string</code> | the item id |
-| data | <code>object</code> | Mock item data |
+## globalTenantCache : <code>Map.&lt;string, string&gt;</code>
+map that caches the tenant ids
 
-<a name="OneDriveMock+registerDriveItemChildren"></a>
+**Kind**: global constant  
+<a name="handleNamedItems"></a>
 
-### oneDriveMock.registerDriveItemChildren(driveId, itemId, data) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-Registers a mock drive item child list
+## handleNamedItems(sheet, segs, method, body) ⇒ <code>object</code>
+Handle the `namedItems` operation on a workbook / worksheet
 
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**Returns**: [<code>OneDriveMock</code>](#OneDriveMock) - this  
+**Kind**: global function  
+**Returns**: <code>object</code> - The response value  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| driveId | <code>string</code> | The drive id |
-| itemId | <code>string</code> | the item id |
-| data | <code>object</code> | Mock item data |
+| sheet | <code>object</code> | The mock data |
+| segs | <code>Array.&lt;string&gt;</code> | Array of path segments |
+| method | <code>string</code> | Request method |
+| body | <code>object</code> | Request body |
 
-<a name="OneDriveMock+registerShareLink"></a>
+<a name="handleTable"></a>
 
-### oneDriveMock.registerShareLink(uri, driveId, itemId) ⇒ [<code>OneDriveMock</code>](#OneDriveMock)
-Register a mock sharelink.
+## handleTable(sheet, segs, method, body) ⇒ <code>object</code>
+Handle the `table` operation on a workbook / worksheet
 
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**Returns**: [<code>OneDriveMock</code>](#OneDriveMock) - this;  
+**Kind**: global function  
+**Returns**: <code>object</code> - The response value  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| uri | <code>string</code> | The sharelink uri |
-| driveId | <code>string</code> | The drive id |
-| itemId | <code>string</code> | The the item id |
-
-<a name="OneDriveMock+getDriveItemFromShareLink"></a>
-
-### oneDriveMock.getDriveItemFromShareLink()
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**See**: OneDrive#getDriveItemFromShareLink  
-<a name="OneDriveMock+getWorkbook"></a>
-
-### oneDriveMock.getWorkbook()
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**See**: OneDrive#getWorkbook  
-<a name="OneDriveMock+doFetch"></a>
+| sheet | <code>object</code> | The mock data |
+| segs | <code>Array.&lt;string&gt;</code> | Array of path segments |
+| method | <code>string</code> | Request method |
+| body | <code>object</code> | Request body |
 
-### oneDriveMock.doFetch()
-**Kind**: instance method of [<code>OneDriveMock</code>](#OneDriveMock)  
-**See**: OneDrive#doFetch  
 <a name="splitByExtension"></a>
 
 ## splitByExtension(name) ⇒ <code>Array.&lt;string&gt;</code>
@@ -351,9 +128,9 @@ Splits the given name at the last '.', returning the extension and the base name
 | --- | --- | --- |
 | name | <code>string</code> | Filename |
 
-<a name="sanitize"></a>
+<a name="sanitizeName"></a>
 
-## sanitize(name) ⇒ <code>string</code>
+## sanitizeName(name) ⇒ <code>string</code>
 Sanitizes the given string by :
 - convert to lower case
 - normalize all unicode characters
@@ -368,73 +145,61 @@ Sanitizes the given string by :
 | --- | --- |
 | name | <code>string</code> | 
 
-<a name="editDistance"></a>
-
-## editDistance(s0, s1) ⇒ <code>number</code> \| <code>\*</code>
-Compute the edit distance using a recursive algorithm. since we only expect to have relative
-short filenames, the algorithm shouldn't be too expensive.
-
-**Kind**: global function  
+<a name="sanitizePath"></a>
 
-| Param | Type | Description |
-| --- | --- | --- |
-| s0 | <code>string</code> | Input string |
-| s1 | <code>string</code> | Input string |
-
-<a name="handleNamedItems"></a>
+## sanitizePath(filepath, opts) ⇒ <code>string</code>
+Sanitizes the file path by:
+- convert to lower case
+- normalize all unicode characters
+- replace all non-alphanumeric characters with a dash
+- remove all consecutive dashes
+- remove all leading and trailing dashes
 
-## handleNamedItems(sheet, segs, method, body) ⇒ <code>object</code>
-Handle the `namedItems` operation on a workbook / worksheet
+Note that only the basename of the file path is sanitized. i.e. The ancestor path and the
+extension is not affected.
 
 **Kind**: global function  
-**Returns**: <code>object</code> - The response value  
+**Returns**: <code>string</code> - sanitized file path  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| sheet | <code>object</code> | The mock data |
-| segs | <code>Array.&lt;string&gt;</code> | Array of path segments |
-| method | <code>string</code> | Request method |
-| body | <code>object</code> | Request body |
+| filepath | <code>string</code> | the file path |
+| opts | <code>object</code> | Options |
+| [opts.ignoreExtension] | <code>boolean</code> | if {@code true} ignores the extension |
 
-<a name="handleTable"></a>
+<a name="editDistance"></a>
 
-## handleTable(sheet, segs, method, body) ⇒ <code>object</code>
-Handle the `table` operation on a workbook / worksheet
+## editDistance(s0, s1) ⇒ <code>number</code> \| <code>\*</code>
+Compute the edit distance using a recursive algorithm. since we only expect to have relative
+short filenames, the algorithm shouldn't be too expensive.
 
 **Kind**: global function  
-**Returns**: <code>object</code> - The response value  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| sheet | <code>object</code> | The mock data |
-| segs | <code>Array.&lt;string&gt;</code> | Array of path segments |
-| method | <code>string</code> | Request method |
-| body | <code>object</code> | Request body |
-
-<a name="driveItemToURL"></a>
-
-## driveItemToURL(driveItem) ⇒ <code>URL</code>
-Returns a onedrive uri for the given drive item. the uri has the format:
-`onedrive:/drives/<driveId>/items/<itemId>`
-
-**Kind**: global function  
-**Returns**: <code>URL</code> - An url representing the drive item  
+| s0 | <code>string</code> | Input string |
+| s1 | <code>string</code> | Input string |
 
-| Param | Type |
-| --- | --- |
-| driveItem | <code>DriveItem</code> | 
+<a name="superTrim"></a>
 
-<a name="driveItemFromURL"></a>
+## superTrim(str) ⇒ <code>string</code>
+Trims the string at both ends and removes the zero width unicode chars:
 
-## driveItemFromURL(url) ⇒ <code>DriveItem</code>
-Returns a partial drive item from the given url. The urls needs to have the format:
-`onedrive:/drives/<driveId>/items/<itemId>`. if the url does not start with the correct
-protocol, {@code null} is returned.
+- 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
 
 **Kind**: global function  
-**Returns**: <code>DriveItem</code> - A (partial) drive item.  
+**Returns**: <code>string</code> - trimmed and stripped string  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| url | <code>URL</code> \| <code>string</code> | The url of the drive item. |
+| str | <code>string</code> | input string |
+
+<a name="AuthenticationResult"></a>
+
+## AuthenticationResult : <code>module:@azure/msal-node~AuthenticationResult</code>
+aliases
 
+**Kind**: global typedef