@nextcloud/files 3.0.0-beta.4 → 3.0.0-beta.6

package/dist/files/file.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+import { FileType } from './fileType';
+import Node from './node';
+export declare class File extends Node {
+    get type(): FileType;
+}

package/dist/files/fileType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+export declare enum FileType {
+    Folder = "folder",
+    File = "file"
+}

package/dist/files/folder.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+import { FileType } from './fileType';
+import Node from './node';
+import NodeData from './nodeData';
+export declare class Folder extends Node {
+    constructor(data: NodeData);
+    get type(): FileType;
+    get extension(): string | null;
+    get mime(): string;
+}

package/dist/files/node.d.ts

@@ -0,0 +1,69 @@
+import { Permission } from '../permissions';
+import { FileType } from './fileType';
+import NodeData, { Attribute } from './nodeData';
+export default abstract class Node {
+    private _data;
+    private _attributes;
+    private _knownDavService;
+    constructor(data: NodeData, davService?: RegExp);
+    /**
+     * Get the source url to this object
+     */
+    get source(): string;
+    /**
+     * Get this object name
+     */
+    get basename(): string;
+    /**
+     * Get this object's extension
+     */
+    get extension(): string | null;
+    /**
+     * Get the directory path leading to this object
+     */
+    get dirname(): string;
+    /**
+     * Is it a file or a folder ?
+     */
+    abstract get type(): FileType;
+    /**
+     * Get the file mime
+     */
+    get mime(): string | undefined;
+    /**
+     * Get the file size
+     */
+    get size(): number | undefined;
+    /**
+     * Get the file attribute
+     */
+    get attributes(): Attribute;
+    /**
+     * Get the file permissions
+     */
+    get permissions(): Permission;
+    /**
+     * Get the file owner
+     */
+    get owner(): string | null;
+    /**
+     * Is this a dav-related ressource ?
+     */
+    get isDavRessource(): boolean;
+    /**
+     * Get the dav root of this object
+     */
+    get root(): string | null;
+    /**
+     * Move the node to a new destination
+     *
+     * @param {string} destination the new source.
+     * e.g. https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg
+     */
+    move(destination: string): void;
+    /**
+     * Rename the node
+     * This aliases the move method for easier usage
+     */
+    rename(basename: any): void;
+}

package/dist/files/nodeData.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+import { Permission } from "../permissions";
+export interface Attribute {
+    [key: string]: any;
+}
+export default interface NodeData {
+    /** Unique ID */
+    id?: number;
+    /** URL to the ressource
+     * e.g. https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg
+     * or https://domain.com/Photos/picture.jpg
+     */
+    source: string;
+    /** Last modified time */
+    mtime?: Date;
+    /** Creation time */
+    crtime?: Date;
+    /** The mime type */
+    mime?: string;
+    /** The node size type */
+    size?: number;
+    /** The node permissions */
+    permissions?: Permission;
+    /** The owner  UID of this node */
+    owner: string | null;
+    attributes?: Attribute;
+}
+/**
+ * Validate Node construct data
+ */
+export declare const validateData: (data: NodeData) => void;

package/dist/humanfilesize.d.ts

@@ -26,4 +26,4 @@
  * @param size in bytes
  * @param skipSmallSizes avoid rendering tiny sizes and return '< 1 KB' instead
  */
-export declare function formatFileSize(size: number | string, skipSmallSizes?: boolean): string;
+export declare function formatFileSize(size: number | string, skipSmallSizes?: boolean, binaryPrefixes?: boolean): string;

package/dist/index.d.ts

@@ -23,6 +23,10 @@
 export { formatFileSize } from './humanfilesize';
 export { type Entry } from './newFileMenu';
 import { type Entry, NewFileMenu } from './newFileMenu';
+export { FileType } from './files/fileType';
+export { File } from './files/file';
+export { Folder } from './files/folder';
+export { Permission, parseWebdavPermissions } from './permissions';
 declare global {
     interface Window {
         OC: any;

package/dist/index.esm.js

@@ -1,6 +1,7 @@
 import { getCanonicalLocale } from '@nextcloud/l10n';
 import { getCurrentUser } from '@nextcloud/auth';
 import { getLoggerBuilder } from '@nextcloud/logger';
+import { basename, extname, dirname } from 'path';
 
 /**
  * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
@@ -24,30 +25,32 @@ import { getLoggerBuilder } from '@nextcloud/logger';
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-const humanList = ['B', 'KB', 'MB', 'GB', 'TB'];
+const humanList = ['B', 'KB', 'MB', 'GB', 'TB', 'PB'];
+const humanListBinary = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB'];
 /**
  * Format a file size in a human-like format. e.g. 42GB
  *
  * @param size in bytes
  * @param skipSmallSizes avoid rendering tiny sizes and return '< 1 KB' instead
  */
-function formatFileSize(size, skipSmallSizes = false) {
+function formatFileSize(size, skipSmallSizes = false, binaryPrefixes = false) {
     if (typeof size === 'string') {
         size = Number(size);
     }
-    // Calculate Log with base 1024: size = 1024 ** order
-    let order = size > 0 ? Math.floor(Math.log(size) / Math.log(1024)) : 0;
+    /*
+    * @note This block previously used Log base 1024, per IEC 80000-13;
+    * however, the wrong prefix was used. Now we use decimal calculation
+    * with base 1000 per the SI. Base 1024 calculation with binary
+    * prefixes is optional, but has yet to be added to the UI.
+    */
+    // Calculate Log with base 1024 or 1000: size = base ** order
+    let order = size > 0 ? Math.floor(Math.log(size) / Math.log(binaryPrefixes ? 1024 : 1000)) : 0;
     // Stay in range of the byte sizes that are defined
-    order = Math.min(humanList.length - 1, order);
-    const readableFormat = humanList[order];
-    let relativeSize = (size / Math.pow(1024, order)).toFixed(1);
+    order = Math.min((binaryPrefixes ? humanListBinary.length : humanList.length) - 1, order);
+    const readableFormat = binaryPrefixes ? humanListBinary[order] : humanList[order];
+    let relativeSize = (size / Math.pow(binaryPrefixes ? 1024 : 1000, order)).toFixed(1);
     if (skipSmallSizes === true && order === 0) {
-        if (relativeSize !== '0.0') {
-            return '< 1 KB';
-        }
-        else {
-            return '0 KB';
-        }
+        return (relativeSize !== '0.0' ? '< 1 ' : '0 ') + (binaryPrefixes ? humanListBinary[1] : humanList[1]);
     }
     if (order < 2) {
         relativeSize = parseFloat(relativeSize).toFixed(0);
@@ -181,6 +184,348 @@ const getNewFileMenu = function () {
     return window._nc_newfilemenu;
 };
 
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+var FileType;
+(function (FileType) {
+    FileType["Folder"] = "folder";
+    FileType["File"] = "file";
+})(FileType || (FileType = {}));
+
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+var Permission;
+(function (Permission) {
+    Permission[Permission["NONE"] = 0] = "NONE";
+    Permission[Permission["CREATE"] = 4] = "CREATE";
+    Permission[Permission["READ"] = 1] = "READ";
+    Permission[Permission["UPDATE"] = 2] = "UPDATE";
+    Permission[Permission["DELETE"] = 8] = "DELETE";
+    Permission[Permission["SHARE"] = 16] = "SHARE";
+    Permission[Permission["ALL"] = 31] = "ALL";
+})(Permission || (Permission = {}));
+/**
+ * Parse the webdav permission string to a permission enum
+ * @see https://github.com/nextcloud/server/blob/71f698649f578db19a22457cb9d420fb62c10382/lib/public/Files/DavUtil.php#L58-L88
+ */
+const parseWebdavPermissions = function (permString = '') {
+    let permissions = Permission.NONE;
+    if (!permString)
+        return permissions;
+    if (permString.includes('C') || permString.includes('K'))
+        permissions |= Permission.CREATE;
+    if (permString.includes('G'))
+        permissions |= Permission.READ;
+    if (permString.includes('W') || permString.includes('N') || permString.includes('V'))
+        permissions |= Permission.UPDATE;
+    if (permString.includes('D'))
+        permissions |= Permission.DELETE;
+    if (permString.includes('R'))
+        permissions |= Permission.SHARE;
+    return permissions;
+};
+
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+/**
+ * Validate Node construct data
+ */
+const validateData = (data) => {
+    if ('id' in data && (typeof data.id !== 'number' || data.id < 0)) {
+        throw new Error('Invalid id type of value');
+    }
+    if (!data.source) {
+        throw new Error('Missing mandatory source');
+    }
+    if (!data.source.startsWith('http')) {
+        throw new Error('Invalid source format');
+    }
+    if ('mtime' in data && !(data.mtime instanceof Date)) {
+        throw new Error('Invalid mtime type');
+    }
+    if ('crtime' in data && !(data.crtime instanceof Date)) {
+        throw new Error('Invalid crtime type');
+    }
+    if (!data.mime || typeof data.mime !== 'string'
+        || !data.mime.match(/^[-\w.]+\/[-+\w.]+$/gi)) {
+        throw new Error('Missing or invalid mandatory mime');
+    }
+    if ('size' in data && typeof data.size !== 'number') {
+        throw new Error('Invalid size type');
+    }
+    if ('permissions' in data && !(typeof data.permissions === 'number'
+        && data.permissions >= Permission.NONE
+        && data.permissions <= Permission.ALL)) {
+        throw new Error('Invalid permissions');
+    }
+    if ('owner' in data
+        && data.owner !== null
+        && typeof data.owner !== 'string') {
+        throw new Error('Invalid owner type');
+    }
+    if ('attributes' in data && typeof data.attributes !== 'object') {
+        throw new Error('Invalid attributes format');
+    }
+};
+
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+class Node {
+    _data;
+    _attributes;
+    _knownDavService = /(remote|public)\.php\/(web)?dav/i;
+    constructor(data, davService) {
+        // Validate data
+        validateData(data);
+        this._data = data;
+        this._attributes = data.attributes || {};
+        delete this._data.attributes;
+        if (davService) {
+            this._knownDavService = davService;
+        }
+    }
+    /**
+     * Get the source url to this object
+     */
+    get source() {
+        // strip any ending slash
+        return this._data.source.replace(/\/$/i, '');
+    }
+    /**
+     * Get this object name
+     */
+    get basename() {
+        return basename(this.source);
+    }
+    /**
+     * Get this object's extension
+     */
+    get extension() {
+        return extname(this.source);
+    }
+    /**
+     * Get the directory path leading to this object
+     */
+    get dirname() {
+        return dirname(this.source);
+    }
+    /**
+     * Get the file mime
+     */
+    get mime() {
+        return this._data.mime;
+    }
+    /**
+     * Get the file size
+     */
+    get size() {
+        return this._data.size;
+    }
+    /**
+     * Get the file attribute
+     */
+    get attributes() {
+        return this._attributes;
+    }
+    /**
+     * Get the file permissions
+     */
+    get permissions() {
+        // If this is not a dav ressource, we can only read it
+        if (this.owner === null && !this.isDavRessource) {
+            return Permission.READ;
+        }
+        return this._data.permissions || Permission.READ;
+    }
+    /**
+     * Get the file owner
+     */
+    get owner() {
+        // Remote ressources have no owner
+        if (!this.isDavRessource) {
+            return null;
+        }
+        return this._data.owner;
+    }
+    /**
+     * Is this a dav-related ressource ?
+     */
+    get isDavRessource() {
+        return this.source.match(this._knownDavService) !== null;
+    }
+    /**
+     * Get the dav root of this object
+     */
+    get root() {
+        if (this.isDavRessource) {
+            return this.dirname.split(this._knownDavService).pop() || null;
+        }
+        return null;
+    }
+    /**
+     * Move the node to a new destination
+     *
+     * @param {string} destination the new source.
+     * e.g. https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg
+     */
+    move(destination) {
+        this._data.source = destination;
+    }
+    /**
+     * Rename the node
+     * This aliases the move method for easier usage
+     */
+    rename(basename) {
+        if (basename.includes('/')) {
+            throw new Error('Invalid basename');
+        }
+        this.move(this.dirname + '/' + basename);
+    }
+}
+
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+class File extends Node {
+    get type() {
+        return FileType.File;
+    }
+}
+
+/**
+ * @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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/>.
+ *
+ */
+class Folder extends Node {
+    constructor(data) {
+        // enforcing mimes
+        super({
+            ...data,
+            mime: 'httpd/unix-directory'
+        });
+    }
+    get type() {
+        return FileType.Folder;
+    }
+    get extension() {
+        return null;
+    }
+    get mime() {
+        return 'httpd/unix-directory';
+    }
+}
+
 /**
  * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
  *
@@ -227,5 +572,5 @@ const getNewFileMenuEntries = function (context) {
     return newFileMenu.getEntries(context);
 };
 
-export { addNewFileMenuEntry, formatFileSize, getNewFileMenuEntries, removeNewFileMenuEntry };
+export { File, FileType, Folder, Permission, addNewFileMenuEntry, formatFileSize, getNewFileMenuEntries, parseWebdavPermissions, removeNewFileMenuEntry };
 //# sourceMappingURL=index.esm.js.map