@nextcloud/files 3.4.0 → 3.5.0

package/dist/navigation/column.d.ts

@@ -1,5 +1,5 @@
-import { View } from './view';
 import { Node } from '../files/node';
+import { View } from './view';
 
 interface ColumnData {
     /** Unique column ID */

package/dist/navigation/navigation.d.ts

@@ -1,12 +1,74 @@
 import { View } from './view';
+import { TypedEventTarget } from 'typescript-event-target';
 
-export declare class Navigation {
+/**
+ * The event is emitted when the navigation view was updated.
+ * It contains the new active view in the `detail` attribute.
+ */
+interface UpdateActiveViewEvent extends CustomEvent<View | null> {
+    type: 'updateActive';
+}
+/**
+ * This event is emitted when the list of registered views is changed
+ */
+interface UpdateViewsEvent extends CustomEvent<never> {
+    type: 'update';
+}
+/**
+ * The files navigation manages the available and active views
+ *
+ * Custom views for the files app can be registered (examples are the favorites views or the shared-with-you view).
+ * It is also possible to listen on changes of the registered views or when the current active view is changed.
+ * @example
+ * ```js
+ * const navigation = getNavigation()
+ * navigation.addEventListener('update', () => {
+ *     // This will be called whenever a new view is registered or a view is removed
+ *     const viewNames = navigation.views.map((view) => view.name)
+ *     console.warn('Registered views changed', viewNames)
+ * })
+ * // Or you can react to changes of the current active view
+ * navigation.addEventListener('updateActive', (event) => {
+ *     // This will be called whenever the active view changed
+ *     const newView = event.detail // you could also use `navigation.active`
+ *     console.warn('Active view changed to ' + newView.name)
+ * })
+ * ```
+ */
+export declare class Navigation extends TypedEventTarget<{
+    updateActive: UpdateActiveViewEvent;
+    update: UpdateViewsEvent;
+}> {
     private _views;
     private _currentView;
+    /**
+     * Register a new view on the navigation
+     * @param view The view to register
+     * @throws `Error` is thrown if a view with the same id is already registered
+     */
     register(view: View): void;
+    /**
+     * Remove a registered view
+     * @param id The id of the view to remove
+     */
     remove(id: string): void;
-    get views(): View[];
+    /**
+     * Set the currently active view
+     * @fires UpdateActiveViewEvent
+     * @param view New active view
+     */
     setActive(view: View | null): void;
+    /**
+     * The currently active files view
+     */
     get active(): View | null;
+    /**
+     * All registered views
+     */
+    get views(): View[];
 }
+/**
+ * Get the current files navigation
+ */
 export declare const getNavigation: () => Navigation;
+export {};

package/dist/permissions.d.ts

@@ -1,23 +1,6 @@
 /**
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 /**
  * Node permissions

package/dist/utils/fileSize.d.ts

@@ -1,24 +1,6 @@
 /**
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 /**
  * Format a file size in a human-like format. e.g. 42GB

package/dist/utils/fileSorting.d.ts

@@ -1,4 +1,4 @@
-import { Node } from '../files/node';
+import { INode } from '../files/node';
 
 export declare enum FilesSortingMode {
     Name = "basename",
@@ -31,4 +31,4 @@ export interface FilesSortingOptions {
  * @param nodes Nodes to sort
  * @param options Sorting options
  */
-export declare function sortNodes(nodes: Node[], options?: FilesSortingOptions): Node[];
+export declare function sortNodes(nodes: readonly INode[], options?: FilesSortingOptions): INode[];

package/dist/utils/filename.d.ts

@@ -8,3 +8,23 @@
  * @param filename Filename to check validity
  */
 export declare function isFilenameValid(filename: string): boolean;
+interface UniqueNameOptions {
+    /**
+     * A function that takes an index and returns a suffix to add to the file name, defaults to '(index)'
+     * @param index The current index to add
+     */
+    suffix?: (index: number) => string;
+    /**
+     * Set to true to ignore the file extension when adding the suffix (when getting a unique directory name)
+     */
+    ignoreFileExtension?: boolean;
+}
+/**
+ * Create an unique file name
+ * @param name The initial name to use
+ * @param otherNames Other names that are already used
+ * @param options Optional parameters for tuning the behavior
+ * @return {string} Either the initial name, if unique, or the name with the suffix so that the name is unique
+ */
+export declare function getUniqueName(name: string, otherNames: string[], options?: UniqueNameOptions): string;
+export {};

package/dist/utils/logger.d.ts

@@ -1,23 +1,6 @@
 /**
- * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 declare const _default: import('@nextcloud/logger').ILogger;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextcloud/files",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Nextcloud files utils",
   "type": "module",
   "main": "dist/index.cjs",
@@ -51,18 +51,18 @@
   },
   "homepage": "https://github.com/nextcloud-libraries/nextcloud-files",
   "devDependencies": {
-    "@codecov/vite-plugin": "^0.0.1-beta.8",
+    "@codecov/vite-plugin": "^0.0.1-beta.9",
     "@nextcloud/eslint-config": "^8.4.1",
     "@nextcloud/typings": "^1.8.0",
-    "@nextcloud/vite-config": "^2.0.0",
-    "@types/node": "^20.12.12",
+    "@nextcloud/vite-config": "^2.0.2",
+    "@types/node": "^20.14.2",
     "@vitest/coverage-istanbul": "^1.6.0",
     "fast-xml-parser": "^4.4.0",
-    "jsdom": "^24.0.0",
-    "tslib": "^2.6.2",
+    "jsdom": "^24.1.0",
+    "tslib": "^2.6.3",
     "typedoc": "^0.25.13",
     "typescript": "^5.4.5",
-    "vite": "^5.2.11",
+    "vite": "^5.3.1",
     "vitest": "^1.3.0"
   },
   "dependencies": {
@@ -73,6 +73,7 @@
     "@nextcloud/router": "^3.0.1",
     "cancelable-promise": "^4.3.1",
     "is-svg": "^5.0.1",
+    "typescript-event-target": "^1.1.1",
     "webdav": "^5.6.0"
   }
 }