@nextcloud/files 3.3.1 → 3.4.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { Entry } from './newFileMenu';
 import { Folder } from './files/folder';
 
-export { formatFileSize, parseFileSize } from './humanfilesize';
 export { FileAction, getFileActions, registerFileAction, DefaultType } from './fileAction';
 export { Header, getFileListHeaders, registerFileListHeaders } from './fileListHeaders';
 export { type Entry, NewMenuEntryCategory } from './newFileMenu';
@@ -13,7 +12,10 @@ export { FileType } from './files/fileType';
 export { File } from './files/file';
 export { Folder } from './files/folder';
 export { Node, NodeStatus } from './files/node';
-export { isFilenameValid } from './filename';
+export { isFilenameValid } from './utils/filename';
+export { formatFileSize, parseFileSize } from './utils/fileSize';
+export { orderBy } from './utils/sorting';
+export { sortNodes, FilesSortingMode, type FilesSortingOptions } from './utils/fileSorting';
 export * from './navigation/navigation';
 export * from './navigation/column';
 export * from './navigation/view';

package/dist/index.mjs

@@ -1,11 +1,11 @@
 import { getCurrentUser, onRequestTokenUpdate, getRequestToken } from "@nextcloud/auth";
 import { getLoggerBuilder } from "@nextcloud/logger";
-import { getCanonicalLocale } from "@nextcloud/l10n";
 import { join, basename, extname, dirname } from "path";
 import { encodePath } from "@nextcloud/paths";
 import { generateRemoteUrl } from "@nextcloud/router";
 import { createClient, getPatcher } from "webdav";
 import { CancelablePromise } from "cancelable-promise";
+import { getCanonicalLocale, getLanguage } from "@nextcloud/l10n";
 /**
  * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
  *
@@ -121,72 +121,6 @@ const getNewFileMenu = function() {
   }
   return window._nc_newfilemenu;
 };
-/**
- * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author John Molakvoæ <skjnldsv@protonmail.com>
- *
- * @license AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
-const humanList = ["B", "KB", "MB", "GB", "TB", "PB"];
-const humanListBinary = ["B", "KiB", "MiB", "GiB", "TiB", "PiB"];
-function formatFileSize(size, skipSmallSizes = false, binaryPrefixes = false, base1000 = false) {
-  binaryPrefixes = binaryPrefixes && !base1000;
-  if (typeof size === "string") {
-    size = Number(size);
-  }
-  let order = size > 0 ? Math.floor(Math.log(size) / Math.log(base1000 ? 1e3 : 1024)) : 0;
-  order = Math.min((binaryPrefixes ? humanListBinary.length : humanList.length) - 1, order);
-  const readableFormat = binaryPrefixes ? humanListBinary[order] : humanList[order];
-  let relativeSize = (size / Math.pow(base1000 ? 1e3 : 1024, order)).toFixed(1);
-  if (skipSmallSizes === true && order === 0) {
-    return (relativeSize !== "0.0" ? "< 1 " : "0 ") + (binaryPrefixes ? humanListBinary[1] : humanList[1]);
-  }
-  if (order < 2) {
-    relativeSize = parseFloat(relativeSize).toFixed(0);
-  } else {
-    relativeSize = parseFloat(relativeSize).toLocaleString(getCanonicalLocale());
-  }
-  return relativeSize + " " + readableFormat;
-}
-function parseFileSize(value, forceBinary = false) {
-  try {
-    value = `${value}`.toLocaleLowerCase().replaceAll(/\s+/g, "").replaceAll(",", ".");
-  } catch (e) {
-    return null;
-  }
-  const match = value.match(/^([0-9]*(\.[0-9]*)?)([kmgtp]?)(i?)b?$/);
-  if (match === null || match[1] === "." || match[1] === "") {
-    return null;
-  }
-  const bytesArray = {
-    "": 0,
-    k: 1,
-    m: 2,
-    g: 3,
-    t: 4,
-    p: 5,
-    e: 6
-  };
-  const decimalString = `${match[1]}`;
-  const base = match[4] === "i" || forceBinary ? 1024 : 1e3;
-  return Math.round(Number.parseFloat(decimalString) * base ** bytesArray[match[3]]);
-}
 /**
  * @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
  *
@@ -759,23 +693,37 @@ class Node {
   _data;
   _attributes;
   _knownDavService = /(remote|public)\.php\/(web)?dav/i;
+  readonlyAttributes = Object.entries(Object.getOwnPropertyDescriptors(Node.prototype)).filter((e) => typeof e[1].get === "function" && e[0] !== "__proto__").map((e) => e[0]);
   handler = {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     set: (target, prop, value) => {
+      if (this.readonlyAttributes.includes(prop)) {
+        return false;
+      }
       this.updateMtime();
       return Reflect.set(target, prop, value);
     },
     deleteProperty: (target, prop) => {
+      if (this.readonlyAttributes.includes(prop)) {
+        return false;
+      }
       this.updateMtime();
       return Reflect.deleteProperty(target, prop);
+    },
+    // TODO: This is deprecated and only needed for files v3
+    get: (target, prop, receiver) => {
+      if (this.readonlyAttributes.includes(prop)) {
+        logger.warn(`Accessing "Node.attributes.${prop}" is deprecated, access it directly on the Node instance.`);
+        return Reflect.get(this, prop);
+      }
+      return Reflect.get(target, prop, receiver);
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
   };
   constructor(data, davService) {
     validateData(data, davService || this._knownDavService);
-    this._data = data;
-    this._attributes = new Proxy(this.cleanAttributes(data.attributes || {}), this.handler);
-    delete this._data.attributes;
+    this._data = { ...data, attributes: {} };
+    this._attributes = new Proxy(this._data.attributes, this.handler);
+    this.update(data.attributes ?? {});
+    this._data.mtime = data.mtime;
     if (davService) {
       this._knownDavService = davService;
     }
@@ -868,6 +816,7 @@ class Node {
   }
   /**
    * Get the file attribute
+   * This contains all additional attributes not provided by the Node class
    */
   get attributes() {
     return this._attributes;
@@ -986,22 +935,23 @@ class Node {
   /**
    * Update the attributes of the node
    *
-   * @param attributes The new attributes to update
+   * @param attributes The new attributes to update on the Node attributes
    */
   update(attributes) {
-    this._attributes = new Proxy(this.cleanAttributes(attributes), this.handler);
-  }
-  cleanAttributes(attributes) {
-    const getters = Object.entries(Object.getOwnPropertyDescriptors(Node.prototype)).filter((e) => typeof e[1].get === "function" && e[0] !== "__proto__").map((e) => e[0]);
-    const clean = {};
-    for (const key in attributes) {
-      if (getters.includes(key)) {
-        logger.debug(`Discarding protected attribute ${key}`, { node: this, attributes });
-        continue;
+    for (const [name, value] of Object.entries(attributes)) {
+      try {
+        if (value === void 0) {
+          delete this.attributes[name];
+        } else {
+          this.attributes[name] = value;
+        }
+      } catch (e) {
+        if (e instanceof TypeError) {
+          continue;
+        }
+        throw e;
       }
-      clean[key] = attributes[key];
     }
-    return clean;
   }
 }
 /**
@@ -1179,6 +1129,142 @@ function isFilenameValid(filename) {
   }
   return true;
 }
+/**
+ * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+const humanList = ["B", "KB", "MB", "GB", "TB", "PB"];
+const humanListBinary = ["B", "KiB", "MiB", "GiB", "TiB", "PiB"];
+function formatFileSize(size, skipSmallSizes = false, binaryPrefixes = false, base1000 = false) {
+  binaryPrefixes = binaryPrefixes && !base1000;
+  if (typeof size === "string") {
+    size = Number(size);
+  }
+  let order = size > 0 ? Math.floor(Math.log(size) / Math.log(base1000 ? 1e3 : 1024)) : 0;
+  order = Math.min((binaryPrefixes ? humanListBinary.length : humanList.length) - 1, order);
+  const readableFormat = binaryPrefixes ? humanListBinary[order] : humanList[order];
+  let relativeSize = (size / Math.pow(base1000 ? 1e3 : 1024, order)).toFixed(1);
+  if (skipSmallSizes === true && order === 0) {
+    return (relativeSize !== "0.0" ? "< 1 " : "0 ") + (binaryPrefixes ? humanListBinary[1] : humanList[1]);
+  }
+  if (order < 2) {
+    relativeSize = parseFloat(relativeSize).toFixed(0);
+  } else {
+    relativeSize = parseFloat(relativeSize).toLocaleString(getCanonicalLocale());
+  }
+  return relativeSize + " " + readableFormat;
+}
+function parseFileSize(value, forceBinary = false) {
+  try {
+    value = `${value}`.toLocaleLowerCase().replaceAll(/\s+/g, "").replaceAll(",", ".");
+  } catch (e) {
+    return null;
+  }
+  const match = value.match(/^([0-9]*(\.[0-9]*)?)([kmgtp]?)(i?)b?$/);
+  if (match === null || match[1] === "." || match[1] === "") {
+    return null;
+  }
+  const bytesArray = {
+    "": 0,
+    k: 1,
+    m: 2,
+    g: 3,
+    t: 4,
+    p: 5,
+    e: 6
+  };
+  const decimalString = `${match[1]}`;
+  const base = match[4] === "i" || forceBinary ? 1024 : 1e3;
+  return Math.round(Number.parseFloat(decimalString) * base ** bytesArray[match[3]]);
+}
+function stringify(value) {
+  if (value instanceof Date) {
+    return value.toISOString();
+  }
+  return String(value);
+}
+function orderBy(collection, identifiers, orders) {
+  identifiers = identifiers ?? [(value) => value];
+  orders = orders ?? [];
+  const sorting = identifiers.map((_, index) => (orders[index] ?? "asc") === "asc" ? 1 : -1);
+  const collator = Intl.Collator(
+    [getLanguage(), getCanonicalLocale()],
+    {
+      // handle 10 as ten and not as one-zero
+      numeric: true,
+      usage: "sort"
+    }
+  );
+  return [...collection].sort((a, b) => {
+    for (const [index, identifier] of identifiers.entries()) {
+      const value = collator.compare(stringify(identifier(a)), stringify(identifier(b)));
+      if (value !== 0) {
+        return value * sorting[index];
+      }
+    }
+    return 0;
+  });
+}
+var FilesSortingMode = /* @__PURE__ */ ((FilesSortingMode2) => {
+  FilesSortingMode2["Name"] = "basename";
+  FilesSortingMode2["Modified"] = "mtime";
+  FilesSortingMode2["Size"] = "size";
+  return FilesSortingMode2;
+})(FilesSortingMode || {});
+function sortNodes(nodes, options = {}) {
+  const sortingOptions = {
+    // Default to sort by name
+    sortingMode: "basename",
+    // Default to sort ascending
+    sortingOrder: "asc",
+    ...options
+  };
+  const identifiers = [
+    // 1: Sort favorites first if enabled
+    ...sortingOptions.sortFavoritesFirst ? [(v) => v.attributes?.favorite !== 1] : [],
+    // 2: Sort folders first if sorting by name
+    ...sortingOptions.sortFoldersFirst ? [(v) => v.type !== "folder"] : [],
+    // 3: Use sorting mode if NOT basename (to be able to use displayName too)
+    ...sortingOptions.sortingMode !== "basename" ? [(v) => v[sortingOptions.sortingMode]] : [],
+    // 4: Use displayName if available, fallback to name
+    (v) => v.attributes?.displayName || v.basename,
+    // 5: Finally, use basename if all previous sorting methods failed
+    (v) => v.basename
+  ];
+  const orders = [
+    // (for 1): always sort favorites before normal files
+    ...sortingOptions.sortFavoritesFirst ? ["asc"] : [],
+    // (for 2): always sort folders before files
+    ...sortingOptions.sortFoldersFirst ? ["asc"] : [],
+    // (for 3): Reverse if sorting by mtime as mtime higher means edited more recent -> lower
+    ...sortingOptions.sortingMode === "mtime" ? [sortingOptions.sortingOrder === "asc" ? "desc" : "asc"] : [],
+    // (also for 3 so make sure not to conflict with 2 and 3)
+    ...sortingOptions.sortingMode !== "mtime" && sortingOptions.sortingMode !== "basename" ? [sortingOptions.sortingOrder] : [],
+    // for 4: use configured sorting direction
+    sortingOptions.sortingOrder,
+    // for 5: use configured sorting direction
+    sortingOptions.sortingOrder
+  ];
+  return orderBy(nodes, identifiers, orders);
+}
 /**
  * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
  *
@@ -1419,6 +1505,8 @@ validator$2.validate = function(xmlData, options) {
             return getErrorObject("InvalidTag", "Closing tag '" + tagName + "' doesn't have proper closing.", getLineNumberForPosition(xmlData, i));
           } else if (attrStr.trim().length > 0) {
             return getErrorObject("InvalidTag", "Closing tag '" + tagName + "' can't have attributes or invalid starting.", getLineNumberForPosition(xmlData, tagStartPos));
+          } else if (tags.length === 0) {
+            return getErrorObject("InvalidTag", "Closing tag '" + tagName + "' has not been opened.", getLineNumberForPosition(xmlData, tagStartPos));
           } else {
             const otg = tags.pop();
             if (tagName !== otg.tagName) {
@@ -2172,6 +2260,13 @@ const parseXml = function(xmlData) {
         if (this.isItStopNode(this.options.stopNodes, jPath, tagName)) {
           let tagContent = "";
           if (tagExp.length > 0 && tagExp.lastIndexOf("/") === tagExp.length - 1) {
+            if (tagName[tagName.length - 1] === "/") {
+              tagName = tagName.substr(0, tagName.length - 1);
+              jPath = jPath.substr(0, jPath.length - 1);
+              tagExp = tagName;
+            } else {
+              tagExp = tagExp.substr(0, tagExp.length - 1);
+            }
             i = result.closeIndex;
           } else if (this.options.unpairedTags.indexOf(tagName) !== -1) {
             i = result.closeIndex;
@@ -3123,6 +3218,7 @@ export {
   File,
   FileAction,
   FileType,
+  FilesSortingMode,
   Folder,
   Header,
   Navigation,
@@ -3151,9 +3247,11 @@ export {
   getNavigation,
   getNewFileMenuEntries,
   isFilenameValid,
+  orderBy,
   parseFileSize,
   registerDavProperty,
   registerFileAction,
   registerFileListHeaders,
-  removeNewFileMenuEntry
+  removeNewFileMenuEntry,
+  sortNodes
 };