@nextcloud/files 4.0.0-beta.7 → 4.0.0-beta.9

package/dist/navigation/index.d.ts

@@ -2,6 +2,6 @@
  * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-export * from './navigation';
-export * from './column';
-export * from './view';
+export * from './navigation.ts';
+export * from './column.ts';
+export * from './view.ts';

package/dist/navigation/navigation.d.ts

@@ -1,4 +1,4 @@
-import { IView } from './view';
+import { IView } from './view.ts';
 import { TypedEventTarget } from 'typescript-event-target';
 /**
  * The event is emitted when the navigation view was updated.
@@ -18,6 +18,7 @@ interface UpdateViewsEvent extends CustomEvent<never> {
  *
  * 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()
@@ -42,6 +43,7 @@ export declare class Navigation extends TypedEventTarget<{
     private _currentView;
     /**
      * Register a new view on the navigation
+     *
      * @param view The view to register
      * @throws {Error} if a view with the same id is already registered
      * @throws {Error} if the registered view is invalid
@@ -49,6 +51,7 @@ export declare class Navigation extends TypedEventTarget<{
     register(view: IView): void;
     /**
      * Remove a registered view
+     *
      * @param id The id of the view to remove
      */
     remove(id: string): void;
@@ -72,5 +75,5 @@ export declare class Navigation extends TypedEventTarget<{
 /**
  * Get the current files navigation
  */
-export declare const getNavigation: () => Navigation;
+export declare function getNavigation(): Navigation;
 export {};

package/dist/navigation/view.d.ts

@@ -38,9 +38,8 @@ export interface IView {
      * This method _must_ also return the current directory
      * information alongside with its content.
      *
-     * An abort signal is provided to be able to
-     * cancel the request if the user change directory
-     * {@see https://developer.mozilla.org/en-US/docs/Web/API/AbortController }.
+     * An [abort signal](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) is provided
+     * to be able to cancel the request if the user change directory.
      */
     getContents(path: string, options: IGetContentsOptions): Promise<ContentsWithRoot>;
     /**

package/dist/newMenu/NewMenu.d.ts

@@ -1,32 +1,36 @@
 import { IFolder, INode } from '../node/index.ts';
-export declare enum NewMenuEntryCategory {
+export declare const NewMenuEntryCategory: Readonly<{
     /**
      * For actions where the user is intended to upload from their device
      */
-    UploadFromDevice = 0,
+    UploadFromDevice: 0;
     /**
      * For actions that create new nodes on the server without uploading
      */
-    CreateNew = 1,
+    CreateNew: 1;
     /**
      * For everything not matching the other categories
      */
-    Other = 2
-}
+    Other: 2;
+}>;
+export type TNewMenuEntryCategory = typeof NewMenuEntryCategory[keyof typeof NewMenuEntryCategory];
 export interface NewMenuEntry {
     /** Unique ID */
     id: string;
     /**
      * Category to put this entry in
      * (supported since Nextcloud 30)
-     * @since 3.3.0
+     *
      * @default NewMenuEntryCategory.CreateNew
+     * @see NewMenuEntryCategory
+     * @since 3.3.0
      */
-    category?: NewMenuEntryCategory;
+    category?: TNewMenuEntryCategory;
     /** Translatable string displayed in the menu */
     displayName: string;
     /**
      * Condition wether this entry is shown or not
+     *
      * @param context the creation context. Usually the current folder
      */
     enabled?: (context: IFolder) => boolean;
@@ -39,6 +43,7 @@ export interface NewMenuEntry {
     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
      */

package/dist/node/file.d.ts

@@ -1,8 +1,8 @@
-import { NodeConstructorData, Node } from './node';
-import { FileType } from './fileType';
+import { NodeConstructorData, Node } from './node.ts';
+import { FileType } from './fileType.ts';
 export declare class File extends Node {
     constructor(...[data, davService]: NodeConstructorData);
-    get type(): FileType.File;
+    get type(): typeof FileType.File;
 }
 /**
  * Interface of the File class

package/dist/node/fileType.d.ts

@@ -2,7 +2,8 @@
  * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-export declare enum FileType {
-    Folder = "folder",
-    File = "file"
-}
+export declare const FileType: Readonly<{
+    Folder: "folder";
+    File: "file";
+}>;
+export type TFileType = typeof FileType[keyof typeof FileType];

package/dist/node/folder.d.ts

@@ -1,8 +1,8 @@
-import { NodeConstructorData, Node } from './node';
-import { FileType } from './fileType';
+import { NodeConstructorData, Node } from './node.ts';
+import { FileType } from './fileType.ts';
 export declare class Folder extends Node {
     constructor(...[data, davService]: NodeConstructorData);
-    get type(): FileType.Folder;
+    get type(): typeof FileType.Folder;
     get extension(): null;
     get mime(): 'httpd/unix-directory';
 }

package/dist/node/node.d.ts

@@ -1,16 +1,16 @@
-import { Permission } from '../permissions';
-import { FileType } from './fileType';
-import { Attribute, NodeData } from './nodeData';
-export declare enum NodeStatus {
+import { TFileType } from './fileType.ts';
+import { Attribute, NodeData } from './nodeData.ts';
+export declare const NodeStatus: Readonly<{
     /** This is a new node and it doesn't exists on the filesystem yet */
-    NEW = "new",
+    NEW: "new";
     /** This node has failed and is unavailable  */
-    FAILED = "failed",
+    FAILED: "failed";
     /** This node is currently loading or have an operation in progress */
-    LOADING = "loading",
+    LOADING: "loading";
     /** This node is locked and cannot be modified */
-    LOCKED = "locked"
-}
+    LOCKED: "locked";
+}>;
+export type TNodeStatus = typeof NodeStatus[keyof typeof NodeStatus];
 export type NodeConstructorData = [NodeData, RegExp?];
 export declare abstract class Node {
     private _attributes;
@@ -63,7 +63,7 @@ export declare abstract class Node {
     /**
      * Is it a file or a folder ?
      */
-    abstract get type(): FileType;
+    abstract get type(): TFileType;
     /**
      * Get the file mime
      */
@@ -102,11 +102,11 @@ export declare abstract class Node {
     /**
      * Get the file permissions
      */
-    get permissions(): Permission;
+    get permissions(): number;
     /**
      * Set the file permissions
      */
-    set permissions(permissions: Permission);
+    set permissions(permissions: number);
     /**
      * Get the file owner
      * There is no setter as the owner is not meant to be changed
@@ -133,15 +133,15 @@ export declare abstract class Node {
     /**
      * Get the node status.
      */
-    get status(): NodeStatus | undefined;
+    get status(): TNodeStatus | undefined;
     /**
      * Set the node status.
      */
-    set status(status: NodeStatus | undefined);
+    set status(status: TNodeStatus | undefined);
     /**
      * Move the node to a new destination
      *
-     * @param {string} destination the new source.
+     * @param destination the new source.
      * e.g. https://cloud.domain.com/remote.php/dav/files/emma/Photos/picture.jpg
      */
     move(destination: string): void;

package/dist/node/nodeData.d.ts

@@ -1,5 +1,4 @@
-import { Permission } from '../permissions';
-import { NodeStatus } from './node';
+import { TNodeStatus } from './node.ts';
 export interface Attribute {
     [key: string]: any;
 }
@@ -26,8 +25,14 @@ export interface NodeData {
     mime?: string;
     /** The node size type */
     size?: number;
-    /** The node permissions */
-    permissions?: Permission;
+    /**
+     * The node permissions.
+     *
+     * A binary mask of `Permission` values.
+     *
+     * @see Permission
+     */
+    permissions?: number;
     /** The owner  UID of this node */
     owner: string | null;
     /** Optional the displayname of this node */
@@ -35,7 +40,7 @@ export interface NodeData {
     /** The node attributes */
     attributes?: Attribute;
     /** The node status */
-    status?: NodeStatus;
+    status?: TNodeStatus;
 }
 /**
  * Check if a node source is from a specific DAV service
@@ -43,7 +48,7 @@ export interface NodeData {
  * @param source The source to check
  * @param davService Pattern to check if source is DAV resource
  */
-export declare const isDavResource: (source: string, davService: RegExp) => boolean;
+export declare function isDavResource(source: string, davService: RegExp): boolean;
 /**
  * Validate Node construct data
  *
@@ -57,10 +62,10 @@ export declare function validateData(data: NodeData, davService: RegExp): void;
  *
  * @param data The internal node data
  */
-export declare const fixDates: (data: NodeData) => void;
+export declare function fixDates(data: NodeData): void;
 /**
  * Fix a RegExp pattern from string or RegExp to RegExp
  *
  * @param pattern The pattern as string or RegExp
  */
-export declare const fixRegExp: (pattern: string | RegExp) => RegExp;
+export declare function fixRegExp(pattern: string | RegExp): RegExp;

package/dist/permissions.d.ts

@@ -5,12 +5,37 @@
 /**
  * Node permissions
  */
-export declare enum Permission {
-    NONE = 0,
-    CREATE = 4,
-    READ = 1,
-    UPDATE = 2,
-    DELETE = 8,
-    SHARE = 16,
-    ALL = 31
-}
+export declare const Permission: Readonly<{
+    /**
+     * No permissions granted
+     */
+    NONE: 0;
+    /**
+     * Can read the file content
+     */
+    READ: 1;
+    /**
+     * Can modify the file itself (move, rename, etc)
+     */
+    UPDATE: 2;
+    /**
+     * Can create new files/folders inside a folder
+     */
+    CREATE: 4;
+    /**
+     * Can change the file content
+     */
+    WRITE: 4;
+    /**
+     * Can delete the node
+     */
+    DELETE: 8;
+    /**
+     * Can share the node
+     */
+    SHARE: 16;
+    /**
+     * All permissions are granted
+     */
+    ALL: 31;
+}>;

package/dist/sidebar/Sidebar.d.ts

@@ -1,3 +1,5 @@
+import { INode } from '../node/node.ts';
+import { ISidebarAction } from './SidebarAction.ts';
 import { ISidebarContext, ISidebarTab } from './SidebarTab.ts';
 export interface ISidebar {
     /**
@@ -8,15 +10,41 @@ export interface ISidebar {
     /**
      * The current open state of the sidebar
      */
-    readonly open: boolean;
+    readonly isOpen: boolean;
     /**
-     * Open or close the sidebar
+     * The currently active sidebar tab id
+     */
+    readonly activeTab?: string;
+    /**
+     * The currently opened node in the sidebar
+     */
+    readonly node?: INode;
+    /**
+     * Open the sidebar for a specific node.
+     *
+     * When the sidebar is fully opened the `files:sidebar:opened` event is emitted,
+     * see also `@nextcloud/event-bus`.
+     *
+     * @param node - The node to open the sidebar for
+     * @param tab - The tab to open by default
+     */
+    open(node: INode, tab?: string): void;
+    /**
+     * Close the sidebar.
+     *
+     * When the sidebar is fully closed the `files:sidebar:closed` event is emitted,
+     * see also `@nextcloud/event-bus`.
+     */
+    close(): void;
+    /**
+     * Set the active sidebar tab
      *
-     * @param open - The new open state
+     * @param tabId - The tab to set active
      */
-    setOpen(open: boolean): void;
+    setActiveTab(tabId: string): void;
     /**
-     * Register a new sidebar tab
+     * Register a new sidebar tab.
+     * This should ideally be done on app initialization using Nextcloud init scripts.
      *
      * @param tab - The sidebar tab to register
      */
@@ -26,6 +54,20 @@ export interface ISidebar {
      * If a node is passed only the enabled tabs are retrieved.
      */
     getTabs(context?: ISidebarContext): ISidebarTab[];
+    /**
+     * Get all registered sidebar actions.
+     *
+     * If a context is provided only the enabled actions are returned.
+     *
+     * @param context - The context
+     */
+    getActions(context?: ISidebarContext): ISidebarAction[];
+    /**
+     * Register a new sidebar action.
+     *
+     * @param action - The action to register
+     */
+    registerAction(action: ISidebarAction): void;
 }
 /**
  * Get a reference to the files sidebar.

package/dist/sidebar/SidebarAction.d.ts

@@ -0,0 +1,51 @@
+import { ISidebarContext } from './SidebarTab.ts';
+/**
+ * Implementation of a custom sidebar tab within the files app.
+ */
+export interface ISidebarAction {
+    /**
+     * Unique id of the sidebar tab.
+     * This has to conform to the HTML id attribute specification.
+     */
+    id: string;
+    /**
+     * The order of this tab.
+     * Use a low number to make this tab ordered in front.
+     */
+    order: number;
+    /**
+     * The localized name of the sidebar tab.
+     *
+     * @param context - The current context of the files app
+     */
+    displayName(context: ISidebarContext): string;
+    /**
+     * The icon, as SVG, of the sidebar tab.
+     *
+     * @param context - The current context of the files app
+     */
+    iconSvgInline(context: ISidebarContext): string;
+    /**
+     * Callback to check if the sidebar tab should be shown for the selected node.
+     *
+     * @param context - The current context of the files app
+     */
+    enabled(context: ISidebarContext): boolean;
+    /**
+     * Handle the sidebar action.
+     *
+     * @param context - The current context of the files app
+     */
+    onClick(context: ISidebarContext): void;
+}
+/**
+ * Register a new sidebar action.
+ *
+ * @param action - The sidebar action to register
+ * @throws {Error} If the provided action is not a valid sidebar action and thus cannot be registered.
+ */
+export declare function registerSidebarAction(action: ISidebarAction): void;
+/**
+ * Get all currently registered sidebar actions.
+ */
+export declare function getSidebarActions(): ISidebarAction[];

package/dist/sidebar/SidebarTab.d.ts

@@ -69,7 +69,7 @@ export interface ISidebarTab {
  * Register a new sidebar tab for the files app.
  *
  * @param tab - The sidebar tab to register
- * @throws If the provided tab is not a valid sidebar tab and thus cannot be registered.
+ * @throws {Error} If the provided tab is not a valid sidebar tab and thus cannot be registered.
  */
 export declare function registerSidebarTab(tab: ISidebarTab): void;
 /**

package/dist/sidebar/index.d.ts

@@ -1,2 +1,3 @@
-export type { ISidebarContext, ISidebarTab, SidebarComponent } from './SidebarTab.ts';
 export * from './Sidebar.ts';
+export * from './SidebarAction.ts';
+export * from './SidebarTab.ts';

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-import { IFolder, INode } from './node/index.ts';
 import { IView } from './navigation/index.ts';
+import { IFolder, INode } from './node/index.ts';
 export type ActionContextSingle = {
     nodes: [INode];
     view: IView;

package/dist/utils/fileSize.d.ts

@@ -18,8 +18,8 @@ export declare function formatFileSize(size: number | string, skipSmallSizes?: b
  * Returns a file size in bytes from a humanly readable string
  * Note: `b` and `B` are both parsed as bytes and not as bit or byte.
  *
- * @param  {string} value file size in human-readable format
- * @param  {boolean} forceBinary for backwards compatibility this allows values to be base 2 (so 2KB means 2048 bytes instead of 2000 bytes)
- * @return {number} or null if string could not be parsed
+ * @param value file size in human-readable format
+ * @param forceBinary for backwards compatibility this allows values to be base 2 (so 2KB means 2048 bytes instead of 2000 bytes)
+ * @return or null if string could not be parsed
  */
 export declare function parseFileSize(value: string, forceBinary?: boolean): number | null;

package/dist/utils/fileSorting.d.ts

@@ -1,33 +1,38 @@
 import { INode } from '../node/node.ts';
 import { SortingOrder } from './sorting.ts';
-export declare enum FilesSortingMode {
-    Name = "basename",
-    Modified = "mtime",
-    Size = "size"
-}
+export declare const FilesSortingMode: Readonly<{
+    Name: "basename";
+    Modified: "mtime";
+    Size: "size";
+}>;
+export type TFilesSortingMode = typeof FilesSortingMode[keyof typeof FilesSortingMode];
 export interface FilesSortingOptions {
     /**
      * They key to order the files by
+     *
      * @default FilesSortingMode.Name
      */
-    sortingMode?: FilesSortingMode | string;
+    sortingMode?: TFilesSortingMode | string;
     /**
      * @default 'asc'
      */
     sortingOrder?: SortingOrder;
     /**
      * If set to true nodes marked as favorites are ordered on top of all other nodes
+     *
      * @default false
      */
     sortFavoritesFirst?: boolean;
     /**
      * If set to true folders are ordered on top of files
+     *
      * @default false
      */
     sortFoldersFirst?: boolean;
 }
 /**
  * Sort files and folders according to the sorting options
+ *
  * @param nodes Nodes to sort
  * @param options Sorting options
  */

package/dist/utils/filename-validation.d.ts

@@ -2,11 +2,12 @@
  * SPDX-FileCopyrightText: Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later or LGPL-3.0-or-later
  */
-export declare enum InvalidFilenameErrorReason {
-    ReservedName = "reserved name",
-    Character = "character",
-    Extension = "extension"
-}
+export declare const InvalidFilenameErrorReason: Readonly<{
+    ReservedName: "reserved name";
+    Character: "character";
+    Extension: "extension";
+}>;
+export type TInvalidFilenameErrorReason = typeof InvalidFilenameErrorReason[keyof typeof InvalidFilenameErrorReason];
 interface InvalidFilenameErrorOptions {
     /**
      * The filename that was validated
@@ -15,7 +16,7 @@ interface InvalidFilenameErrorOptions {
     /**
      * Reason why the validation failed
      */
-    reason: InvalidFilenameErrorReason;
+    reason: TInvalidFilenameErrorReason;
     /**
      * Part of the filename that caused this error
      */
@@ -30,7 +31,7 @@ export declare class InvalidFilenameError extends Error {
     /**
      * Reason why the validation failed
      */
-    get reason(): InvalidFilenameErrorReason;
+    get reason(): TInvalidFilenameErrorReason;
     /**
      * Part of the filename that caused this error
      */
@@ -38,6 +39,7 @@ export declare class InvalidFilenameError extends Error {
 }
 /**
  * Validate a given filename
+ *
  * @param filename The filename to check
  * @throws {InvalidFilenameError}
  */
@@ -45,6 +47,7 @@ export declare function validateFilename(filename: string): void;
 /**
  * Check the validity of a filename
  * This is a convenient wrapper for `checkFilenameValidity` to only return a boolean for the valid
+ *
  * @param filename Filename to check validity
  */
 export declare function isFilenameValid(filename: string): boolean;

package/dist/utils/filename.d.ts

@@ -5,6 +5,7 @@
 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;
@@ -15,10 +16,11 @@ interface UniqueNameOptions {
 }
 /**
  * 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
+ * @return 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/index.d.ts

@@ -3,5 +3,5 @@ export type { FilesSortingOptions } from './fileSorting.ts';
 export * from './filename-validation.ts';
 export { getUniqueName } from './filename.ts';
 export { formatFileSize, parseFileSize } from './fileSize.ts';
-export { sortNodes, FilesSortingMode } from './fileSorting.ts';
+export { FilesSortingMode, sortNodes } from './fileSorting.ts';
 export { orderBy } from './sorting.ts';

package/dist/utils/sorting.d.ts

@@ -1,3 +1,7 @@
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
 type IdentifierFn<T> = (v: T) => unknown;
 export type SortingOrder = 'asc' | 'desc';
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextcloud/files",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.9",
   "description": "Nextcloud files utils",
   "keywords": [
     "nextcloud",
@@ -57,25 +57,25 @@
     "@nextcloud/router": "^3.1.0",
     "@nextcloud/sharing": "^0.3.0",
     "is-svg": "^6.1.0",
-    "typescript-event-target": "^1.1.1",
+    "typescript-event-target": "^1.1.2",
     "webdav": "^5.8.0"
   },
   "devDependencies": {
     "@codecov/vite-plugin": "^1.9.1",
-    "@nextcloud/eslint-config": "^8.4.2",
+    "@nextcloud/eslint-config": "^9.0.0-rc.5",
     "@nextcloud/event-bus": "^3.3.3",
     "@nextcloud/typings": "^1.10.0",
     "@nextcloud/vite-config": "^2.5.2",
-    "@types/node": "^25.0.3",
+    "@types/node": "^25.0.5",
     "@vitest/coverage-istanbul": "^4.0.16",
     "css.escape": "^1.5.1",
     "fast-xml-parser": "^5.3.3",
-    "jsdom": "^27.3.0",
+    "jsdom": "^27.4.0",
     "tslib": "^2.8.1",
     "typedoc": "^0.28.15",
     "typedoc-plugin-missing-exports": "^4.1.2",
     "typescript": "^5.9.3",
-    "vite": "^7.3.0",
+    "vite": "^7.3.1",
     "vitest": "^4.0.14"
   },
   "engines": {