@nextcloud/files 3.10.0 → 3.10.2

package/dist/fileListAction.d.ts

@@ -0,0 +1,41 @@
+import { Folder } from './files/folder.ts';
+import { Node } from './files/node.ts';
+import { View } from './navigation/view.ts';
+interface FileListActionData {
+    /** Unique ID */
+    id: string;
+    /** Translated name of the action */
+    displayName: (view: View) => string;
+    /** Raw svg string */
+    iconSvgInline?: (view: View) => string;
+    /** Sort order */
+    order: number;
+    /**
+     * Condition whether this action is shown or not
+     * @param view The current view
+     * @param nodes The nodes in the current directory
+     * @param folder The current folder
+     */
+    enabled?: (view: View, nodes: Node[], folder: Folder) => 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: (view: View, nodes: Node[], folder: Folder) => Promise<boolean | null>;
+}
+export declare class FileListAction {
+    private _action;
+    constructor(action: FileListActionData);
+    get id(): string;
+    get displayName(): (view: View) => string;
+    get iconSvgInline(): ((view: View) => string) | undefined;
+    get order(): number;
+    get enabled(): ((view: View, nodes: Node[], folder: Folder) => boolean) | undefined;
+    get exec(): (view: View, nodes: Node[], folder: Folder) => Promise<boolean | null>;
+    private validateAction;
+}
+export declare const registerFileListAction: (action: FileListAction) => void;
+export declare const getFileListActions: () => FileListAction[];
+export {};

package/dist/fileListFilters.d.ts

@@ -0,0 +1,100 @@
+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;
+    /**
+     * Optional pass a user id to use a user avatar instead of an icon
+     */
+    user?: 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;
+    /**
+     * Filter function to decide if a node is shown.
+     *
+     * @param nodes Nodes to filter
+     * @return Subset of the `nodes` parameter to show
+     */
+    filter(nodes: INode[]): INode[];
+    /**
+     * If the filter needs a visual element for settings it can provide a function to mount it.
+     * @param el The DOM element to mount to
+     */
+    mount?(el: HTMLElement): void;
+    /**
+     * Reset the filter to the initial state.
+     * This is called by the files app.
+     * Implementations should make sure,that if they provide chips they need to emit the `update:chips` event.
+     *
+     * @since 3.10.0
+     */
+    reset?(): void;
+}
+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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,13 @@
+import { FileType } from './fileType';
+import { Node } from './node';
+export declare class File extends Node {
+    get type(): FileType.File;
+    /**
+     * Returns a clone of the file
+     */
+    clone(): File;
+}
+/**
+ * Interface of the File class
+ */
+export type IFile = Pick<File, keyof File>;

package/dist/files/fileType.d.ts

@@ -0,0 +1,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"
+}

package/dist/files/folder.d.ts

@@ -0,0 +1,17 @@
+import { NodeData } from './nodeData';
+import { FileType } from './fileType';
+import { Node } from './node';
+export declare class Folder extends Node {
+    constructor(data: NodeData);
+    get type(): FileType.Folder;
+    get extension(): null;
+    get mime(): 'httpd/unix-directory';
+    /**
+     * Returns a clone of the folder
+     */
+    clone(): Folder;
+}
+/**
+ * Interface of the folder class
+ */
+export type IFolder = Pick<Folder, keyof Folder>;

package/dist/files/node.d.ts

@@ -0,0 +1,177 @@
+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 resource ?
+     */
+    get isDavResource(): boolean;
+    /**
+     * @deprecated use `isDavResource` instead - will be removed in next major version.
+     */
+    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);
+    /**
+     * Get the node data
+     */
+    get data(): NodeData;
+    /**
+     * 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;
+    /**
+     * Returns a clone of the node
+     */
+    abstract clone(): Node;
+}
+/**
+ * Interface of the node class
+ */
+export type INode = Pick<Node, keyof Node>;

package/dist/files/nodeData.d.ts

@@ -0,0 +1,53 @@
+import { Permission } from '../permissions';
+import { NodeStatus } from './node';
+export interface Attribute {
+    [key: string]: any;
+}
+export interface NodeData {
+    /** Unique ID */
+    id?: number;
+    /**
+     * URL to the resource.
+     * 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 resource
+ */
+export declare const isDavResource: (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;