@nextcloud/files 3.9.2 → 3.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextcloud/files",
-  "version": "3.9.2",
+  "version": "3.10.0",
   "description": "Nextcloud files utils",
   "type": "module",
   "main": "dist/index.cjs",
@@ -11,6 +11,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
+    },
+    "./dav": {
+      "types": "./dist/dav.d.ts",
+      "import": "./dist/dav.mjs",
+      "require": "./dist/dav.cjs"
     }
   },
   "files": [
@@ -29,7 +34,7 @@
   ],
   "scripts": {
     "build": "vite --mode production build",
-    "build:doc": "typedoc && touch dist/doc/.nojekyll",
+    "build:doc": "typedoc --out dist/doc lib/dav/index.ts lib/index.ts && touch dist/doc/.nojekyll",
     "dev": "vite --mode development build",
     "watch": "vite --mode development build --watch",
     "lint": "eslint .",
@@ -51,19 +56,19 @@
   },
   "homepage": "https://github.com/nextcloud-libraries/nextcloud-files",
   "devDependencies": {
-    "@codecov/vite-plugin": "^0.0.1-beta.12",
+    "@codecov/vite-plugin": "^1.2.1",
     "@nextcloud/eslint-config": "^8.4.1",
     "@nextcloud/event-bus": "^3.3.1",
     "@nextcloud/typings": "^1.9.1",
     "@nextcloud/vite-config": "^2.2.2",
-    "@types/node": "^22.5.4",
-    "@vitest/coverage-istanbul": "^2.0.5",
+    "@types/node": "^22.9.0",
+    "@vitest/coverage-istanbul": "^2.1.4",
     "fast-xml-parser": "^4.5.0",
-    "jsdom": "^25.0.0",
-    "tslib": "^2.7.0",
-    "typedoc": "^0.26.6",
-    "typescript": "^5.5.4",
-    "vite": "^5.4.3",
+    "jsdom": "^25.0.1",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.26.11",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.10",
     "vitest": "^2.0.2"
   },
   "dependencies": {

package/dist/dav/dav.d.ts

@@ -1,56 +0,0 @@
-import { FileStat, WebDAVClient } from 'webdav';
-import { Node } from '../files/node';
-import { CancelablePromise } from 'cancelable-promise';
-
-/**
- * Get the DAV root path for the current user or public share
- */
-export declare function davGetRootPath(): string;
-/**
- * The DAV root path for the current user
- * This is a cached version of `davGetRemoteURL`
- */
-export declare const davRootPath: string;
-/**
- * Get the DAV remote URL used as base URL for the WebDAV client
- * It also handles public shares
- */
-export declare function davGetRemoteURL(): string;
-/**
- * The DAV remote URL used as base URL for the WebDAV client
- * This is a cached version of `davGetRemoteURL`
- */
-export declare const davRemoteURL: string;
-/**
- * Get a WebDAV client configured to include the Nextcloud request token
- *
- * @param remoteURL The DAV server remote URL
- * @param headers Optional additional headers to set for every request
- */
-export declare const davGetClient: (remoteURL?: string, headers?: Record<string, string>) => WebDAVClient;
-/**
- * Use WebDAV to query for favorite Nodes
- *
- * @param davClient The WebDAV client to use for performing the request
- * @param path Base path for the favorites, if unset all favorites are queried
- * @param davRoot The root path for the DAV user (defaults to `davRootPath`)
- * @example
- * ```js
- * import { davGetClient, davRootPath, getFavoriteNodes } from '@nextcloud/files'
- *
- * const client = davGetClient()
- * // query favorites for the root
- * const favorites = await getFavoriteNodes(client)
- * // which is the same as writing:
- * const favorites = await getFavoriteNodes(client, '/', davRootPath)
- * ```
- */
-export declare const getFavoriteNodes: (davClient: WebDAVClient, path?: string, davRoot?: string) => CancelablePromise<Node[]>;
-/**
- * Covert DAV result `FileStat` to `Node`
- *
- * @param node The DAV result
- * @param filesRoot The DAV files root path
- * @param remoteURL The DAV server remote URL (same as on `davGetClient`)
- */
-export declare const davResultToNode: (node: FileStat, filesRoot?: string, remoteURL?: string) => Node;

package/dist/dav/davPermissions.d.ts

@@ -1,6 +0,0 @@
-/**
- * Parse the webdav permission string to a permission enum
- *
- * @param permString The DAV permission string
- */
-export declare const davParsePermissions: (permString?: string) => number;

package/dist/dav/davProperties.d.ts

@@ -1,57 +0,0 @@
-export type DavProperty = {
-    [key: string]: string;
-};
-export declare const defaultDavProperties: string[];
-export declare const defaultDavNamespaces: {
-    d: string;
-    nc: string;
-    oc: string;
-    ocs: string;
-};
-/**
- * Register custom DAV properties
- *
- * Can be used if your app introduces custom DAV properties, so e.g. the files app can make use of it.
- *
- * @param prop The property
- * @param namespace The namespace of the property
- */
-export declare const registerDavProperty: (prop: string, namespace?: DavProperty) => boolean;
-/**
- * Get the registered dav properties
- */
-export declare const getDavProperties: () => string;
-/**
- * Get the registered dav namespaces
- */
-export declare const getDavNameSpaces: () => string;
-/**
- * Get the default PROPFIND request body
- */
-export declare const davGetDefaultPropfind: () => string;
-/**
- * Get the REPORT body to filter for favorite nodes
- */
-export declare const davGetFavoritesReport: () => string;
-/**
- * Get the SEARCH body to search for recently modified files
- *
- * @param lastModified Oldest timestamp to include (Unix timestamp)
- * @example
- * ```ts
- * // SEARCH for recent files need a different DAV endpoint
- * const client = davGetClient(generateRemoteUrl('dav'))
- * // Timestamp of last week
- * const lastWeek = Math.round(Date.now() / 1000) - (60 * 60 * 24 * 7)
- * const contentsResponse = await client.getDirectoryContents(path, {
- *     details: true,
- *     data: davGetRecentSearch(lastWeek),
- *     headers: {
- *         method: 'SEARCH',
- *         'Content-Type': 'application/xml; charset=utf-8',
- *     },
- *     deep: true,
- * }) as ResponseDataDetailed<FileStat[]>
- * ```
- */
-export declare const davGetRecentSearch: (lastModified: number) => string;

package/dist/fileAction.d.ts

@@ -1,79 +0,0 @@
-import { Node } from './files/node';
-import { View } from './navigation/view';
-
-export declare enum DefaultType {
-    DEFAULT = "default",
-    HIDDEN = "hidden"
-}
-interface FileActionData {
-    /** Unique ID */
-    id: string;
-    /** Translatable string displayed in the menu */
-    displayName: (files: Node[], view: View) => string;
-    /** Translatable title for of the action */
-    title?: (files: Node[], view: View) => string;
-    /** Svg as inline string. <svg><path fill="..." /></svg> */
-    iconSvgInline: (files: Node[], view: View) => string;
-    /** Condition wether this action is shown or not */
-    enabled?: (files: Node[], view: View) => boolean;
-    /**
-     * Function executed on single file action
-     * @return true if the action was executed successfully,
-     * false otherwise and null if the action is silent/undefined.
-     * @throws Error if the action failed
-     */
-    exec: (file: Node, view: View, dir: string) => Promise<boolean | null>;
-    /**
-     * Function executed on multiple files action
-     * @return true if the action was executed successfully,
-     * false otherwise and null if the action is silent/undefined.
-     * @throws Error if the action failed
-     */
-    execBatch?: (files: Node[], view: View, dir: string) => Promise<(boolean | null)[]>;
-    /** This action order in the list */
-    order?: number;
-    /**
-     * This action's parent id in the list.
-     * If none found, will be displayed as a top-level action.
-     */
-    parent?: string;
-    /**
-     * Make this action the default.
-     * If multiple actions are default, the first one
-     * will be used. The other ones will be put as first
-     * entries in the actions menu iff DefaultType.Hidden is not used.
-     * A DefaultType.Hidden action will never be shown
-     * in the actions menu even if another action takes
-     * its place as default.
-     */
-    default?: DefaultType;
-    /**
-     * If true, the renderInline function will be called
-     */
-    inline?: (file: Node, view: View) => boolean;
-    /**
-     * If defined, the returned html element will be
-     * appended before the actions menu.
-     */
-    renderInline?: (file: Node, view: View) => Promise<HTMLElement | null>;
-}
-export declare class FileAction {
-    private _action;
-    constructor(action: FileActionData);
-    get id(): string;
-    get displayName(): (files: Node[], view: View) => string;
-    get title(): ((files: Node[], view: View) => string) | undefined;
-    get iconSvgInline(): (files: Node[], view: View) => string;
-    get enabled(): ((files: Node[], view: View) => boolean) | undefined;
-    get exec(): (file: Node, view: View, dir: string) => Promise<boolean | null>;
-    get execBatch(): ((files: Node[], view: View, dir: string) => Promise<(boolean | null)[]>) | undefined;
-    get order(): number | undefined;
-    get parent(): string | undefined;
-    get default(): DefaultType | undefined;
-    get inline(): ((file: Node, view: View) => boolean) | undefined;
-    get renderInline(): ((file: Node, view: View) => Promise<HTMLElement | null>) | undefined;
-    private validateAction;
-}
-export declare const registerFileAction: (action: FileAction) => void;
-export declare const getFileActions: () => FileAction[];
-export {};

package/dist/fileListFilters.d.ts

@@ -1,86 +0,0 @@
-import { TypedEventTarget } from 'typescript-event-target';
-import { INode } from './files/node';
-
-/**
- * Active filters can provide one or more "chips" to show the currently active state.
- * Must at least provide a text representing the filters state and a callback to unset that state (disable this filter).
- */
-export interface IFileListFilterChip {
-    /**
-     * Text of the chip
-     */
-    text: string;
-    /**
-     * Optional icon to be used on the chip (inline SVG as string)
-     */
-    icon?: string;
-    /**
-     * Handler to be called on click
-     */
-    onclick: () => void;
-}
-/**
- * This event is emitted when the the filter value changed and the file list needs to be updated
- */
-export interface FilterUpdateEvent extends CustomEvent<never> {
-    type: 'update:filter';
-}
-/**
- * This event is emitted when the the filter value changed and the file list needs to be updated
- */
-export interface FilterUpdateChipsEvent extends CustomEvent<IFileListFilterChip[]> {
-    type: 'update:chips';
-}
-interface IFileListFilterEvents {
-    [name: string]: CustomEvent;
-    'update:filter': FilterUpdateEvent;
-    'update:chips': FilterUpdateChipsEvent;
-}
-export interface IFileListFilter extends TypedEventTarget<IFileListFilterEvents> {
-    /**
-     * Unique ID of this filter
-     */
-    readonly id: string;
-    /**
-     * Order of the filter
-     *
-     * Use a low number to make this filter ordered in front.
-     */
-    readonly order: number;
-    /**
-     * If the filter needs a visual element for settings it can provide a function to mount it.
-     */
-    readonly mount?: (el: HTMLElement) => void;
-    /**
-     * Filter function to decide if a node is shown
-     * @return The nodes to be shown
-     */
-    filter(node: INode[]): INode[];
-}
-export declare class FileListFilter extends TypedEventTarget<IFileListFilterEvents> implements IFileListFilter {
-    id: string;
-    order: number;
-    constructor(id: string, order?: number);
-    filter(nodes: INode[]): INode[];
-    protected updateChips(chips: IFileListFilterChip[]): void;
-    protected filterUpdated(): void;
-}
-/**
- * Register a new filter on the file list
- *
- * This only must be called once to register the filter,
- * when the filter state changes you need to call `filterUpdated` on the filter instead.
- *
- * @param filter The filter to register on the file list
- */
-export declare function registerFileListFilter(filter: IFileListFilter): void;
-/**
- * Remove a registered filter from the file list
- * @param filterId The unique ID of the filter to remove
- */
-export declare function unregisterFileListFilter(filterId: string): void;
-/**
- * Get all registered file list filters
- */
-export declare function getFileListFilters(): IFileListFilter[];
-export {};

package/dist/fileListHeaders.d.ts

@@ -1,27 +0,0 @@
-import { Folder } from './files/folder';
-import { View } from './navigation/view';
-
-export interface HeaderData {
-    /** Unique ID */
-    id: string;
-    /** Order */
-    order: number;
-    /** Condition wether this header is shown or not */
-    enabled?: (folder: Folder, view: View) => boolean;
-    /** Executed when file list is initialized */
-    render: (el: HTMLElement, folder: Folder, view: View) => void;
-    /** Executed when root folder changed */
-    updated(folder: Folder, view: View): any;
-}
-export declare class Header {
-    private _header;
-    constructor(header: HeaderData);
-    get id(): string;
-    get order(): number;
-    get enabled(): ((folder: Folder, view: View) => boolean) | undefined;
-    get render(): (el: HTMLElement, folder: Folder, view: View) => void;
-    get updated(): (folder: Folder, view: View) => any;
-    private validateHeader;
-}
-export declare const registerFileListHeaders: (header: Header) => void;
-export declare const getFileListHeaders: () => Header[];

package/dist/files/file.d.ts

@@ -1,12 +0,0 @@
-import { FileType } from './fileType';
-import { INode, Node } from './node';
-
-export declare class File extends Node {
-    get type(): FileType;
-}
-/**
- * Interface of the File class
- */
-export interface IFile extends INode {
-    readonly type: FileType.File;
-}

package/dist/files/fileType.d.ts

@@ -1,8 +0,0 @@
-/**
- * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
-export declare enum FileType {
-    Folder = "folder",
-    File = "file"
-}

package/dist/files/folder.d.ts

@@ -1,18 +0,0 @@
-import { FileType } from './fileType';
-import { INode, 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;
-}
-/**
- * Interface of the folder class
- */
-export interface IFolder extends INode {
-    readonly type: FileType.Folder;
-    readonly extension: null;
-    readonly mime: 'httpd/unix-directory';
-}

package/dist/files/node.d.ts

@@ -1,166 +0,0 @@
-import { Permission } from '../permissions';
-import { FileType } from './fileType';
-import { Attribute, NodeData } from './nodeData';
-
-export declare enum NodeStatus {
-    /** This is a new node and it doesn't exists on the filesystem yet */
-    NEW = "new",
-    /** This node has failed and is unavailable  */
-    FAILED = "failed",
-    /** This node is currently loading or have an operation in progress */
-    LOADING = "loading",
-    /** This node is locked and cannot be modified */
-    LOCKED = "locked"
-}
-export declare abstract class Node {
-    private _data;
-    private _attributes;
-    private _knownDavService;
-    private readonlyAttributes;
-    private handler;
-    constructor(data: NodeData, davService?: RegExp);
-    /**
-     * Get the source url to this object
-     * There is no setter as the source is not meant to be changed manually.
-     * You can use the rename or move method to change the source.
-     */
-    get source(): string;
-    /**
-     * Get the encoded source url to this object for requests purposes
-     */
-    get encodedSource(): string;
-    /**
-     * Get this object name
-     * There is no setter as the source is not meant to be changed manually.
-     * You can use the rename or move method to change the source.
-     */
-    get basename(): string;
-    /**
-     * The nodes displayname
-     * By default the display name and the `basename` are identical,
-     * but it is possible to have a different name. This happens
-     * on the files app for example for shared folders.
-     */
-    get displayname(): string;
-    /**
-     * Set the displayname
-     */
-    set displayname(displayname: string);
-    /**
-     * Get this object's extension
-     * There is no setter as the source is not meant to be changed manually.
-     * You can use the rename or move method to change the source.
-     */
-    get extension(): string | null;
-    /**
-     * Get the directory path leading to this object
-     * Will use the relative path to root if available
-     *
-     * There is no setter as the source is not meant to be changed manually.
-     * You can use the rename or move method to change the source.
-     */
-    get dirname(): string;
-    /**
-     * Is it a file or a folder ?
-     */
-    abstract get type(): FileType;
-    /**
-     * Get the file mime
-     * There is no setter as the mime is not meant to be changed
-     */
-    get mime(): string | undefined;
-    /**
-     * Get the file modification time
-     */
-    get mtime(): Date | undefined;
-    /**
-     * Set the file modification time
-     */
-    set mtime(mtime: Date | undefined);
-    /**
-     * Get the file creation time
-     * There is no setter as the creation time is not meant to be changed
-     */
-    get crtime(): Date | undefined;
-    /**
-     * Get the file size
-     */
-    get size(): number | undefined;
-    /**
-     * Set the file size
-     */
-    set size(size: number | undefined);
-    /**
-     * Get the file attribute
-     * This contains all additional attributes not provided by the Node class
-     */
-    get attributes(): Attribute;
-    /**
-     * Get the file permissions
-     */
-    get permissions(): Permission;
-    /**
-     * Set the file permissions
-     */
-    set permissions(permissions: Permission);
-    /**
-     * Get the file owner
-     * There is no setter as the owner is not meant to be changed
-     */
-    get owner(): string | null;
-    /**
-     * Is this a dav-related ressource ?
-     */
-    get isDavRessource(): boolean;
-    /**
-     * Get the dav root of this object
-     * There is no setter as the root is not meant to be changed
-     */
-    get root(): string | null;
-    /**
-     * Get the absolute path of this object relative to the root
-     */
-    get path(): string;
-    /**
-     * Get the node id if defined.
-     * There is no setter as the fileid is not meant to be changed
-     */
-    get fileid(): number | undefined;
-    /**
-     * Get the node status.
-     */
-    get status(): NodeStatus | undefined;
-    /**
-     * Set the node status.
-     */
-    set status(status: NodeStatus | undefined);
-    /**
-     * 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
-     *
-     * @param basename The new name of the node
-     */
-    rename(basename: string): void;
-    /**
-     * Update the mtime if exists
-     */
-    updateMtime(): void;
-    /**
-     * Update the attributes of the node
-     * Warning, updating attributes will NOT automatically update the mtime.
-     *
-     * @param attributes The new attributes to update on the Node attributes
-     */
-    update(attributes: Attribute): void;
-}
-/**
- * Interface of the node class
- */
-export type INode = Pick<Node, keyof Node>;

package/dist/files/nodeData.d.ts

@@ -1,54 +0,0 @@
-import { Permission } from '../permissions';
-import { NodeStatus } from './node';
-
-export interface Attribute {
-    [key: string]: any;
-}
-export 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 Optional for folders only */
-    mime?: string;
-    /** The node size type */
-    size?: number;
-    /** The node permissions */
-    permissions?: Permission;
-    /** The owner  UID of this node */
-    owner: string | null;
-    /** Optional the displayname of this node */
-    displayname?: string;
-    /** The node attributes */
-    attributes?: Attribute;
-    /**
-     * The absolute root of the home relative to the service.
-     * It is highly recommended to provide that information.
-     * e.g. /files/emma
-     */
-    root?: string;
-    /** The node status */
-    status?: NodeStatus;
-}
-/**
- * Check if a node source is from a specific DAV service
- *
- * @param source The source to check
- * @param davService Pattern to check if source is DAV ressource
- */
-export declare const isDavRessource: (source: string, davService: RegExp) => boolean;
-/**
- * Validate Node construct data
- *
- * @param data The node data
- * @param davService Pattern to check if source is DAV ressource
- */
-export declare const validateData: (data: NodeData, davService: RegExp) => void;

package/dist/navigation/column.d.ts

@@ -1,28 +0,0 @@
-import { Node } from '../files/node';
-import { View } from './view';
-
-interface ColumnData {
-    /** Unique column ID */
-    id: string;
-    /** Translated column title */
-    title: string;
-    /** The content of the cell. The element will be appended within */
-    render: (node: Node, view: View) => HTMLElement;
-    /** Function used to sort Nodes between them */
-    sort?: (nodeA: Node, nodeB: Node) => number;
-    /**
-     * Custom summary of the column to display at the end of the list.
-     * Will not be displayed if  nothing is provided
-     */
-    summary?: (node: Node[], view: View) => string;
-}
-export declare class Column implements ColumnData {
-    private _column;
-    constructor(column: ColumnData);
-    get id(): string;
-    get title(): string;
-    get render(): (node: Node, view: View) => HTMLElement;
-    get sort(): ((nodeA: Node, nodeB: Node) => number) | undefined;
-    get summary(): ((node: Node[], view: View) => string) | undefined;
-}
-export {};

package/dist/navigation/index.d.ts

@@ -1,7 +0,0 @@
-/*!
- * 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';