@nextcloud/files 3.0.0-beta.1 → 3.0.0-beta.11

package/dist/fileAction.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @copyright Copyright (c) 2021 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/>.
+ *
+ */
+import { Node } from "./files/node";
+interface FileActionData {
+    /** Unique ID */
+    id: string;
+    /** Translatable string displayed in the menu */
+    displayName: (files: Node[], view: any) => string;
+    /** Svg as inline string. <svg><path fill="..." /></svg> */
+    iconSvgInline: (files: Node[], view: any) => string;
+    /** Condition wether this action is shown or not */
+    enabled?: (files: Node[], view: any) => boolean;
+    /**
+     * Function executed on single file action
+     * @returns 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: any, dir: string) => Promise<boolean | null>;
+    /**
+     * Function executed on multiple files action
+     * @returns 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: any, dir: string) => Promise<(boolean | null)[]>;
+    /** This action order in the list */
+    order?: number;
+    /** Make this action the default */
+    default?: boolean;
+    /**
+     * If true, the renderInline function will be called
+     */
+    inline?: (file: Node, view: any) => boolean;
+    /**
+     * If defined, the returned html element will be
+     * appended before the actions menu.
+     */
+    renderInline?: (file: Node, view: any) => HTMLElement;
+}
+export declare class FileAction {
+    private _action;
+    constructor(action: FileActionData);
+    get id(): string;
+    get displayName(): (files: Node[], view: any) => string;
+    get iconSvgInline(): (files: Node[], view: any) => string;
+    get enabled(): ((files: Node[], view: any) => boolean) | undefined;
+    get exec(): (file: Node, view: any, dir: string) => Promise<boolean | null>;
+    get execBatch(): ((files: Node[], view: any, dir: string) => Promise<(boolean | null)[]>) | undefined;
+    get order(): number | undefined;
+    get default(): boolean | undefined;
+    get inline(): ((file: Node, view: any) => boolean) | undefined;
+    get renderInline(): ((file: Node, view: any) => HTMLElement) | undefined;
+    private validateAction;
+}
+export declare const registerFileAction: (action: FileAction) => void;
+export declare const getFileActions: () => FileAction[];
+export {};

package/dist/files/file.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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/>.
+ *
+ */
+import { FileType } from './fileType';
+import { Node } from './node';
+export declare class File extends Node {
+    get type(): FileType;
+}

package/dist/files/fileType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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/>.
+ *
+ */
+export declare enum FileType {
+    Folder = "folder",
+    File = "file"
+}

package/dist/files/folder.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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/>.
+ *
+ */
+import { FileType } from './fileType';
+import { 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;
+}

package/dist/files/node.d.ts

@@ -0,0 +1,87 @@
+import { Permission } from '../permissions';
+import { FileType } from './fileType';
+import NodeData, { Attribute } from './nodeData';
+export declare abstract class Node {
+    private _data;
+    private _attributes;
+    private _knownDavService;
+    constructor(data: NodeData, davService?: RegExp);
+    /**
+     * Get the source url to this object
+     */
+    get source(): string;
+    /**
+     * Get this object name
+     */
+    get basename(): string;
+    /**
+     * Get this object's extension
+     */
+    get extension(): string | null;
+    /**
+     * Get the directory path leading to this object
+     * Will use the relative path to root if available
+     */
+    get dirname(): string;
+    /**
+     * Is it a file or a folder ?
+     */
+    abstract get type(): FileType;
+    /**
+     * Get the file mime
+     */
+    get mime(): string | undefined;
+    /**
+     * Get the file modification time
+     */
+    get mtime(): Date | undefined;
+    /**
+     * Get the file creation time
+     */
+    get crtime(): Date | undefined;
+    /**
+     * Get the file size
+     */
+    get size(): number | undefined;
+    /**
+     * Get the file attribute
+     */
+    get attributes(): Attribute;
+    /**
+     * Get the file permissions
+     */
+    get permissions(): Permission;
+    /**
+     * Get the file owner
+     */
+    get owner(): string | null;
+    /**
+     * Is this a dav-related ressource ?
+     */
+    get isDavRessource(): boolean;
+    /**
+     * Get the dav root of this object
+     */
+    get root(): string | null;
+    /**
+     * Get the absolute path of this object relative to the root
+     */
+    get path(): string;
+    /**
+     * Get the node id if defined.
+     * Will look for the fileid in attributes if undefined.
+     */
+    get fileid(): number | 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
+     */
+    rename(basename: any): void;
+}

package/dist/files/nodeData.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @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/>.
+ *
+ */
+import { Permission } from "../permissions";
+export interface Attribute {
+    [key: string]: any;
+}
+export default 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 */
+    mime?: string;
+    /** The node size type */
+    size?: number;
+    /** The node permissions */
+    permissions?: Permission;
+    /** The owner  UID of this node */
+    owner: string | null;
+    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;
+}
+export declare const isDavRessource: (source: string, davService: RegExp) => boolean;
+/**
+ * Validate Node construct data
+ */
+export declare const validateData: (data: NodeData, davService: RegExp) => void;

package/dist/humanfilesize.d.ts

@@ -26,4 +26,4 @@
  * @param size in bytes
  * @param skipSmallSizes avoid rendering tiny sizes and return '< 1 KB' instead
  */
-export declare function formatFileSize(size: number | string, skipSmallSizes?: boolean): string;
+export declare function formatFileSize(size: number | string, skipSmallSizes?: boolean, binaryPrefixes?: boolean): string;

package/dist/index.d.ts

@@ -21,14 +21,14 @@
  *
  */
 export { formatFileSize } from './humanfilesize';
-export { FileType, type Entry } from './newFileMenu';
-import { type Entry, NewFileMenu } from './newFileMenu';
-declare global {
-    interface Window {
-        OC: any;
-        _nc_newfilemenu: NewFileMenu;
-    }
-}
+export { type Entry } from './newFileMenu';
+import { type Entry } from './newFileMenu';
+export { FileType } from './files/fileType';
+export { File } from './files/file';
+export { Folder } from './files/folder';
+export { Node } from './files/node';
+export { Permission, parseWebdavPermissions } from './permissions';
+export { FileAction, registerFileAction, getFileActions } from './fileAction';
 /**
  * Add a new menu entry to the upload manager menu
  */
@@ -39,5 +39,7 @@ export declare const addNewFileMenuEntry: (entry: Entry) => void;
 export declare const removeNewFileMenuEntry: (entry: Entry | string) => void;
 /**
  * Get the list of registered entries from the upload menu
+ *
+ * @param {FileInfo} context the creation context. Usually the current folder FileInfo
  */
-export declare const getNewFileMenuEntries: () => Entry[];
+export declare const getNewFileMenuEntries: (context?: Object) => Entry[];