@adobe/helix-onedrive-support 7.1.3 → 8.0.1

package/src/{Workbook.d.ts → excel/Workbook.d.ts}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Adobe. All rights reserved.
+ * 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
@@ -11,7 +11,7 @@
  */
 import { Table } from './Table';
 import { Worksheet } from './Worksheet';
-import { GraphResult } from './OneDrive';
+import { GraphResult } from '../OneDrive';
 import { NamedItem } from './NamedItem';
 
 /**

package/src/{Workbook.js → excel/Workbook.js}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Adobe. All rights reserved.
+ * 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
@@ -9,14 +9,11 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import { NamedItemContainer } from './NamedItemContainer.js';
+import { Table } from './Table.js';
+import { Worksheet } from './Worksheet.js';
 
-'use strict';
-
-const NamedItemContainer = require('./NamedItemContainer.js');
-const Table = require('./Table.js');
-const Worksheet = require('./Worksheet.js');
-
-class Workbook extends NamedItemContainer {
+export class Workbook extends NamedItemContainer {
   constructor(oneDrive, uri, log) {
     super(oneDrive);
 
@@ -58,5 +55,3 @@ class Workbook extends NamedItemContainer {
     return this._log;
   }
 }
-
-module.exports = Workbook;

package/src/{Worksheet.d.ts → excel/Worksheet.d.ts}

@@ -1,16 +1,16 @@
 /*
- * Copyright 2019 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the 'License');
+ * 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
+ * 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.
  */
 import { NamedItem } from './NamedItem';
-import { GraphResult } from './OneDrive';
+import { GraphResult } from '../OneDrive';
 import { Table } from './Table';
 import { Range } from './Range';
 

package/src/{Worksheet.js → excel/Worksheet.js}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Adobe. All rights reserved.
+ * 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
@@ -9,14 +9,11 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import { NamedItemContainer } from './NamedItemContainer.js';
+import { Table } from './Table.js';
+import { Range } from './Range.js';
 
-'use strict';
-
-const NamedItemContainer = require('./NamedItemContainer.js');
-const Table = require('./Table.js');
-const Range = require('./Range.js');
-
-class Worksheet extends NamedItemContainer {
+export class Worksheet extends NamedItemContainer {
   constructor(oneDrive, prefix, name, log) {
     super(oneDrive);
 
@@ -57,5 +54,3 @@ class Worksheet extends NamedItemContainer {
     return new Range(this._oneDrive, `${this._uri}/range(address='${address}')`, this._log);
   }
 }
-
-module.exports = Worksheet;

package/src/index.d.ts

@@ -10,8 +10,17 @@
  * governing permissions and limitations under the License.
  */
 export * from './OneDrive';
-export * from './Workbook';
-export * from './Worksheet';
-export * from './NamedItem';
-export * from './Table';
-export * from './Range';
+export * from './OneDriveAuth';
+export * from './OneDriveMock';
+export * from './StatusCodeError';
+export * from './excel/Workbook';
+export * from './excel/Worksheet';
+export * from './excel/NamedItem';
+export * from './excel/Table';
+export * from './excel/Range';
+
+export * from './cache/FSCacheManager';
+export * from './cache/FSCachePlugin';
+export * from './cache/MemCachePlugin';
+export * from './cache/S3CacheManager';
+export * from './cache/S3CachePlugin';

package/src/index.js

@@ -9,10 +9,19 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const OneDrive = require('./OneDrive.js');
-const OneDriveMock = require('./OneDriveMock.js');
+export { OneDrive } from './OneDrive.js';
+export { OneDriveAuth } from './OneDriveAuth.js';
 
-module.exports = {
-  OneDrive,
-  OneDriveMock,
-};
+export { FSCachePlugin } from './cache/FSCachePlugin.js';
+export { FSCacheManager } from './cache/FSCacheManager.js';
+export { MemCachePlugin } from './cache/MemCachePlugin.js';
+export { S3CachePlugin } from './cache/S3CachePlugin.js';
+export { S3CacheManager } from './cache/S3CacheManager.js';
+export { OneDriveMock } from './OneDriveMock.js';
+export { StatusCodeError } from './StatusCodeError.js';
+
+export { NamedItemContainer } from './excel/NamedItemContainer.js';
+export { Range } from './excel/Range.js';
+export { Table } from './excel/Table.js';
+export { Workbook } from './excel/Workbook.js';
+export { Worksheet } from './excel/Worksheet.js';

package/src/package.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+module.exports = require('../package.json');

package/src/utils.js

@@ -11,66 +11,116 @@
  */
 
 /**
- * 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
+ * Splits the given name at the last '.', returning the extension and the base name.
+ * @param {string} name Filename
+ * @returns {string[]} Returns an array containing the base name and extension.
+ */
+export function splitByExtension(name) {
+  const idx = name.lastIndexOf('.');
+  const baseName = idx > 0 && idx < name.length - 1 ? name.substring(0, idx) : name;
+  const ext = idx > 0 && idx < name.length - 1 ? name.substring(idx + 1).toLowerCase() : '';
+  return [baseName, ext];
+}
+
+/**
+ * Sanitizes the given string 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
  *
- * @param {string} str input string
- * @return {string} trimmed and stripped string
+ * @param {string} name
+ * @returns {string} sanitized name
  */
-function superTrim(str) {
-  return String(str)
-    .replace(/[\u200B-\u200D\uFEFF]/g, '')
-    .trim();
+export function sanitizeName(name) {
+  return name
+    .toLowerCase()
+    .normalize('NFD')
+    .replace(/[\u0300-\u036f]/g, '')
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-|-$/g, '');
 }
 
 /**
- * Returns a onedrive uri for the given drive item. the uri has the format:
- * `onedrive:/drives/<driveId>/items/<itemId>`
+ * 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
  *
- * @param {DriveItem} driveItem
- * @returns {URL} An url representing the drive item
+ * Note that only the basename of the file path is sanitized. i.e. The ancestor path and the
+ * extension is not affected.
+ *
+ * @param {string} filepath the file path
+ * @param {object} opts Options
+ * @param {boolean} [opts.ignoreExtension] if {@code true} ignores the extension
+ * @returns {string} sanitized file path
  */
-function driveItemToURL(driveItem) {
-  return new URL(`onedrive:/drives/${driveItem.parentReference.driveId}/items/${driveItem.id}`);
+export function sanitizePath(filepath, opts = {}) {
+  const idx = filepath.lastIndexOf('/') + 1;
+  const extIdx = opts.ignoreExtension ? -1 : filepath.lastIndexOf('.');
+  const pfx = filepath.substring(0, idx);
+  const basename = extIdx < idx ? filepath.substring(idx) : filepath.substring(idx, extIdx);
+  const ext = extIdx < idx ? '' : filepath.substring(extIdx);
+  const name = sanitizeName(basename);
+  return `${pfx}${name}${ext}`;
 }
 
 /**
- * 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.
+ * Compute the edit distance using a recursive algorithm. since we only expect to have relative
+ * short filenames, the algorithm shouldn't be too expensive.
  *
- * @param {URL|string} url The url of the drive item.
- * @return {DriveItem} A (partial) drive item.
+ * @param {string} s0 Input string
+ * @param {string} s1 Input string
+ * @returns {number|*}
  */
-function driveItemFromURL(url) {
-  if (!(url instanceof URL)) {
+export function editDistance(s0, s1) {
+  // make sure that s0 length is greater than s1 length
+  if (s0.length < s1.length) {
+    const t = s1;
     // eslint-disable-next-line no-param-reassign
-    url = new URL(String(url));
-  }
-  if (url.protocol !== 'onedrive:') {
-    return null;
+    s1 = s0;
+    // eslint-disable-next-line no-param-reassign
+    s0 = t;
   }
-  const [drives, driveId, items, itemId] = url.pathname.split('/').filter((s) => !!s);
-  if (drives !== 'drives') {
-    throw new Error(`URI not supported (missing 'drives' segment): ${url}`);
+  const l0 = s0.length;
+  const l1 = s1.length;
+
+  // init first row
+  const resultMatrix = [[]];
+  for (let c = 0; c < l1 + 1; c += 1) {
+    resultMatrix[0][c] = c;
   }
-  if (items !== 'items') {
-    throw new Error(`URI not supported (missing 'items' segment): ${url}`);
+  // fill out the distance matrix and find the best path
+  for (let i = 1; i < l0 + 1; i += 1) {
+    resultMatrix[i] = [i];
+    for (let j = 1; j < l1 + 1; j += 1) {
+      const replaceCost = (s0.charAt(i - 1) === s1.charAt(j - 1)) ? 0 : 1;
+      resultMatrix[i][j] = Math.min(
+        resultMatrix[i - 1][j] + 1, // insert
+        resultMatrix[i][j - 1] + 1, // remove
+        resultMatrix[i - 1][j - 1] + replaceCost,
+      );
+    }
   }
-  return {
-    id: itemId,
-    parentReference: {
-      driveId,
-    },
-  };
+  return resultMatrix[l0][l1];
 }
 
-module.exports = {
-  driveItemFromURL,
-  driveItemToURL,
-  superTrim,
-};
+/**
+ * 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
+ */
+export function superTrim(str) {
+  return String(str)
+    .replace(/[\u200B-\u200D\uFEFF]/g, '')
+    .trim();
+}

package/src/fuzzy-helper.js

@@ -1,89 +0,0 @@
-/*
- * Copyright 2020 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.
- */
-
-/**
- * Splits the given name at the last '.', returning the extension and the base name.
- * @param {string} name Filename
- * @returns {string[]} Returns an array containing the base name and extension.
- */
-function splitByExtension(name) {
-  const idx = name.lastIndexOf('.');
-  const baseName = idx > 0 && idx < name.length - 1 ? name.substring(0, idx) : name;
-  const ext = idx > 0 && idx < name.length - 1 ? name.substring(idx + 1).toLowerCase() : '';
-  return [baseName, ext];
-}
-
-/**
- * Sanitizes the given string 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
- *
- * @param {string} name
- * @returns {string} sanitized name
- */
-function sanitize(name) {
-  return name
-    .toLowerCase()
-    .normalize('NFD')
-    .replace(/[\u0300-\u036f]/g, '')
-    .replace(/[^a-z0-9]+/g, '-')
-    .replace(/^-|-$/g, '');
-}
-
-/**
- * Compute the edit distance using a recursive algorithm. since we only expect to have relative
- * short filenames, the algorithm shouldn't be too expensive.
- *
- * @param {string} s0 Input string
- * @param {string} s1 Input string
- * @returns {number|*}
- */
-function editDistance(s0, s1) {
-  // make sure that s0 length is greater than s1 length
-  if (s0.length < s1.length) {
-    const t = s1;
-    // eslint-disable-next-line no-param-reassign
-    s1 = s0;
-    // eslint-disable-next-line no-param-reassign
-    s0 = t;
-  }
-  const l0 = s0.length;
-  const l1 = s1.length;
-
-  // init first row
-  const resultMatrix = [[]];
-  for (let c = 0; c < l1 + 1; c += 1) {
-    resultMatrix[0][c] = c;
-  }
-  // fill out the distance matrix and find the best path
-  for (let i = 1; i < l0 + 1; i += 1) {
-    resultMatrix[i] = [i];
-    for (let j = 1; j < l1 + 1; j += 1) {
-      const replaceCost = (s0.charAt(i - 1) === s1.charAt(j - 1)) ? 0 : 1;
-      resultMatrix[i][j] = Math.min(
-        resultMatrix[i - 1][j] + 1, // insert
-        resultMatrix[i][j - 1] + 1, // remove
-        resultMatrix[i - 1][j - 1] + replaceCost,
-      );
-    }
-  }
-  return resultMatrix[l0][l1];
-}
-
-module.exports = {
-  splitByExtension,
-  sanitize,
-  editDistance,
-};