@nextcloud/files 3.0.0-beta.9 → 3.0.0

package/dist/navigation/view.d.ts

@@ -0,0 +1,103 @@
+/**
+ * @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 type { Folder, Node } from '@nextcloud/files';
+import { Column } from './column.js';
+export type ContentsWithRoot = {
+    folder: Folder;
+    contents: Node[];
+};
+interface ViewData {
+    /** Unique view ID */
+    id: string;
+    /** Translated view name */
+    name: string;
+    /** Translated accessible description of the view */
+    caption?: string;
+    /** Translated title of the empty view */
+    emptyTitle?: string;
+    /** Translated description of the empty view */
+    emptyCaption?: string;
+    /**
+     * Method return the content of the  provided path
+     * This ideally should be a cancellable promise.
+     * promise.cancel(reason) will be called when the directory
+     * change and the promise is not resolved yet.
+     * You _must_ also return the current directory
+     * information alongside with its content.
+     */
+    getContents: (path: string) => Promise<ContentsWithRoot>;
+    /** The view icon as an inline svg */
+    icon: string;
+    /** The view order */
+    order: number;
+    /**
+     * Custom params to give to the router on click
+     * If defined, will be treated as a dummy view and
+     * will just redirect and not fetch any contents.
+     */
+    params?: Record<string, string>;
+    /**
+     * This view column(s). Name and actions are
+     * by default always included
+     */
+    columns?: Column[];
+    /** The empty view element to render your empty content into */
+    emptyView?: (div: HTMLDivElement) => void;
+    /** The parent unique ID */
+    parent?: string;
+    /** This view is sticky (sent at the bottom) */
+    sticky?: boolean;
+    /**
+     * This view has children and is expanded (by default)
+     * or not. This will be overridden by user config.
+     */
+    expanded?: boolean;
+    /**
+     * Will be used as default if the user
+     * haven't customized their sorting column
+     */
+    defaultSortKey?: string;
+}
+export declare class View implements ViewData {
+    private _view;
+    constructor(view: ViewData);
+    get id(): string;
+    get name(): string;
+    get caption(): string | undefined;
+    get emptyTitle(): string | undefined;
+    get emptyCaption(): string | undefined;
+    get getContents(): (path: string) => Promise<ContentsWithRoot>;
+    get icon(): string;
+    set icon(icon: string);
+    get order(): number;
+    set order(order: number);
+    get params(): Record<string, string> | undefined;
+    set params(params: Record<string, string> | undefined);
+    get columns(): Column[] | undefined;
+    get emptyView(): ((div: HTMLDivElement) => void) | undefined;
+    get parent(): string | undefined;
+    get sticky(): boolean | undefined;
+    get expanded(): boolean | undefined;
+    set expanded(expanded: boolean | undefined);
+    get defaultSortKey(): string | undefined;
+}
+export {};

package/dist/newFileMenu.d.ts

@@ -19,22 +19,35 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
+import type { Folder, Node } from './index';
 export interface Entry {
     /** Unique ID */
     id: string;
     /** Translatable string displayed in the menu */
     displayName: string;
-    templateName?: string;
-    if?: (context: Object) => Boolean;
+    /**
+     * Condition wether this entry is shown or not
+     * @param context the creation context. Usually the current folder
+     */
+    enabled?: (context: Folder) => boolean;
     /**
      * Either iconSvgInline or iconClass must be defined
      * Svg as inline string. <svg><path fill="..." /></svg>
      */
     iconSvgInline?: string;
-    /** Existing icon css class */
+    /**
+     * Existing icon css class
+     * @deprecated use iconSvgInline instead
+     */
     iconClass?: string;
-    /** Function to be run after creation */
-    handler?: Function;
+    /** Order of the entry in the menu */
+    order?: number;
+    /**
+     * Function to be run after creation
+     * @param context the creation context. Usually the current folder
+     * @param content list of file/folders present in the context folder
+     */
+    handler: (context: Folder, content: Node[]) => void;
 }
 export declare class NewFileMenu {
     private _entries;
@@ -43,9 +56,9 @@ export declare class NewFileMenu {
     /**
      * Get the list of registered entries
      *
-     * @param {FileInfo} context the creation context. Usually the current folder FileInfo
+     * @param {Folder} context the creation context. Usually the current folder
      */
-    getEntries(context?: Object): Array<Entry>;
+    getEntries(context?: Folder): Array<Entry>;
     private getEntryIndex;
     private validateEntry;
 }

package/dist/permissions.d.ts

@@ -19,6 +19,9 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
+/**
+ * Node permissions
+ */
 export declare enum Permission {
     NONE = 0,
     CREATE = 4,
@@ -28,8 +31,3 @@ export declare enum Permission {
     SHARE = 16,
     ALL = 31
 }
-/**
- * Parse the webdav permission string to a permission enum
- * @see https://github.com/nextcloud/server/blob/71f698649f578db19a22457cb9d420fb62c10382/lib/public/Files/DavUtil.php#L58-L88
- */
-export declare const parseWebdavPermissions: (permString?: string) => number;

package/dist/utils/logger.d.ts

@@ -19,5 +19,5 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-declare const _default: any;
+declare const _default: import("@nextcloud/logger").ILogger;
 export default _default;

package/dist/vendor.LICENSE.txt

@@ -0,0 +1,13 @@
+Included dependencies:
+
+fast-xml-parser
+version: 4.3.2
+license: MIT
+
+is-svg
+version: 5.0.0
+license: MIT
+
+strnum
+version: 1.0.5
+license: MIT

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@nextcloud/files",
-  "version": "3.0.0-beta.9",
+  "version": "3.0.0",
   "description": "Nextcloud files utils",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
-      "require": "./dist/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
   },
   "files": [
@@ -16,7 +18,8 @@
   ],
   "author": "Christoph Wurst <christoph@winzerhof-wurst.at>",
   "contributors": [
-    "John Molakvoæ <skjnldsv@protonmail.com>"
+    "John Molakvoæ <skjnldsv@protonmail.com>",
+    "Ferdinand Thiessen <opensource@fthiessen.de>"
   ],
   "license": "AGPL-3.0-or-later",
   "keywords": [
@@ -25,49 +28,53 @@
     "library"
   ],
   "scripts": {
-    "build": "rollup --config rollup.config.mjs",
+    "build": "vite --mode production build",
     "build:doc": "typedoc --out dist/doc lib && touch dist/doc/.nojekyll",
-    "dev": "echo 'No dev build available, production only' && npm run build",
-    "watch": "rollup --config rollup.config.mjs --watch",
-    "test": "jest",
-    "test:watch": "jest --watchAll --verbose true",
-    "test:coverage": "jest --coverage"
+    "dev": "vite --mode development build",
+    "watch": "vite --mode development build --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/nextcloud/nextcloud-files.git"
+    "url": "https://github.com/nextcloud-libraries/nextcloud-files.git"
   },
   "bugs": {
-    "url": "https://github.com/nextcloud/nextcloud-files/issues"
+    "url": "https://github.com/nextcloud-libraries/nextcloud-files/issues"
   },
   "engines": {
-    "node": "^16.0.0",
-    "npm": "^7.0.0 || ^8.0.0"
+    "node": "^20.0.0",
+    "npm": "^9.0.0"
   },
-  "homepage": "https://github.com/nextcloud/nextcloud-files",
+  "homepage": "https://github.com/nextcloud-libraries/nextcloud-files",
   "devDependencies": {
-    "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.18.5",
-    "@babel/preset-env": "^7.18.2",
-    "@babel/preset-typescript": "^7.17.12",
-    "@nextcloud/typings": "^1.6.0",
-    "@rollup-extras/plugin-clean": "^1.2.3",
-    "@rollup/plugin-commonjs": "^24.0.1",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-typescript": "^11.0.0",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^18.11.18",
-    "jest": "^29.4.0",
-    "jest-environment-jsdom": "^29.4.0",
-    "rollup": "^3.20.2",
-    "ts-jest": "^29.0.5",
-    "tslib": "^2.4.1",
-    "typedoc": "^0.24.1",
-    "typescript": "^5.0.3"
+    "@nextcloud/eslint-config": "^8.3.0",
+    "@nextcloud/typings": "^1.7.0",
+    "@nextcloud/vite-config": "^1.1.0",
+    "@rollup-extras/plugin-clean": "^1.3.9",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/node": "^20.8.10",
+    "@vitest/coverage-istanbul": "^0.34.6",
+    "fast-xml-parser": "^4.3.2",
+    "rollup": "^4.3.0",
+    "tslib": "^2.6.2",
+    "typedoc": "^0.25.3",
+    "typescript": "^5.2.2",
+    "vite": "^4.5.0",
+    "vitest": "^0.34.6"
   },
   "dependencies": {
-    "@nextcloud/auth": "^2.0.0",
-    "@nextcloud/l10n": "^2.1.0",
-    "@nextcloud/logger": "^2.5.0"
+    "@nextcloud/auth": "^2.2.1",
+    "@nextcloud/l10n": "^2.2.0",
+    "@nextcloud/logger": "^2.7.0",
+    "@nextcloud/paths": "^2.1.0",
+    "@nextcloud/router": "^2.2.0",
+    "is-svg": "^5.0.0",
+    "webdav": "^5.3.0"
   }
 }