@nextcloud/files 3.5.1 → 3.7.0

package/README.md

@@ -5,7 +5,9 @@
 # @nextcloud/files
 [![npm last version](https://img.shields.io/npm/v/@nextcloud/files.svg?style=flat-square)](https://www.npmjs.com/package/@nextcloud/files) [![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-files)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-files) [![Code coverage](https://img.shields.io/codecov/c/github/nextcloud-libraries/nextcloud-files?style=flat-square)](https://app.codecov.io/gh/nextcloud-libraries/nextcloud-files) [![Project documentation](https://img.shields.io/badge/documentation-online-blue?style=flat-square)](https://nextcloud-libraries.github.io/nextcloud-files/)
 
-Nextcloud Files helpers for Nextcloud apps and libraries
+Nextcloud Files helpers for Nextcloud apps and libraries.
+
+The `davGetClient` exported function returns a webDAV client that's a wrapper around [webdav's webDAV client](https://www.npmjs.com/package/webdav); All its methods are available here.
 
 ## Usage example
 
@@ -57,3 +59,18 @@ const nodes = results.data.map((result) => davResultToNode(r, myRoot))
 const nodes = results.data.map((result) => davResultToNode(r, myRoot, myRemoteURL))
 
 ```
+
+### Using WebDAV to get a Node from a file's name
+
+```ts
+	import { davGetClient, davGetDefaultPropfind, davResultToNode, davRootPath } from '@nextcloud/files'
+	import { emit } from '@nextcloud/event-bus'
+	const client = davGetClient()
+	client.stat(`${davRootPath}${filename}`, {
+		details: true,
+		data: davGetDefaultPropfind(),
+	}).then((result) => {
+		const node = davResultToNode(result.data)
+		emit('files:node:updated', node)
+	})
+```

package/dist/fileListFilters.d.ts

@@ -0,0 +1,86 @@
+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/files/node.d.ts

@@ -35,6 +35,17 @@ export declare abstract class Node {
      * 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.

package/dist/files/nodeData.d.ts

@@ -25,6 +25,8 @@ export interface NodeData {
     permissions?: Permission;
     /** The owner  UID of this node */
     owner: string | null;
+    /** Optional the displayname of this node */
+    displayname?: string;
     /** The node attributes */
     attributes?: Attribute;
     /**