@nextcloud/files 3.9.2 → 3.10.0

package/dist/navigation/navigation.d.ts

@@ -1,74 +0,0 @@
-import { View } from './view';
-import { TypedEventTarget } from 'typescript-event-target';
-
-/**
- * The event is emitted when the navigation view was updated.
- * It contains the new active view in the `detail` attribute.
- */
-interface UpdateActiveViewEvent extends CustomEvent<View | null> {
-    type: 'updateActive';
-}
-/**
- * This event is emitted when the list of registered views is changed
- */
-interface UpdateViewsEvent extends CustomEvent<never> {
-    type: 'update';
-}
-/**
- * The files navigation manages the available and active views
- *
- * 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()
- * navigation.addEventListener('update', () => {
- *     // This will be called whenever a new view is registered or a view is removed
- *     const viewNames = navigation.views.map((view) => view.name)
- *     console.warn('Registered views changed', viewNames)
- * })
- * // Or you can react to changes of the current active view
- * navigation.addEventListener('updateActive', (event) => {
- *     // This will be called whenever the active view changed
- *     const newView = event.detail // you could also use `navigation.active`
- *     console.warn('Active view changed to ' + newView.name)
- * })
- * ```
- */
-export declare class Navigation extends TypedEventTarget<{
-    updateActive: UpdateActiveViewEvent;
-    update: UpdateViewsEvent;
-}> {
-    private _views;
-    private _currentView;
-    /**
-     * Register a new view on the navigation
-     * @param view The view to register
-     * @throws `Error` is thrown if a view with the same id is already registered
-     */
-    register(view: View): void;
-    /**
-     * Remove a registered view
-     * @param id The id of the view to remove
-     */
-    remove(id: string): void;
-    /**
-     * Set the currently active view
-     * @fires UpdateActiveViewEvent
-     * @param view New active view
-     */
-    setActive(view: View | null): void;
-    /**
-     * The currently active files view
-     */
-    get active(): View | null;
-    /**
-     * All registered views
-     */
-    get views(): View[];
-}
-/**
- * Get the current files navigation
- */
-export declare const getNavigation: () => Navigation;
-export {};

package/dist/navigation/view.d.ts

@@ -1,92 +0,0 @@
-import { Folder } from '../files/folder';
-import { Node } from '../files/node';
-import { Column } from './column.js';
-
-export type ContentsWithRoot = {
-    folder: Folder;
-    contents: Node[];
-};
-interface ViewData {
-    /** Unique view ID */
-    id: string;
-    /** Translated view name */
-    name: string;
-    /** Translated accessible description of the view */
-    caption?: string;
-    /** Translated title of the empty view */
-    emptyTitle?: string;
-    /** Translated description of the empty view */
-    emptyCaption?: string;
-    /**
-     * Method return the content of the  provided path
-     * This ideally should be a cancellable promise.
-     * promise.cancel(reason) will be called when the directory
-     * change and the promise is not resolved yet.
-     * You _must_ also return the current directory
-     * information alongside with its content.
-     */
-    getContents: (path: string) => Promise<ContentsWithRoot>;
-    /** The view icon as an inline svg */
-    icon: string;
-    /**
-     * The view order.
-     * If not set will be natural sorted by view name.
-     */
-    order?: number;
-    /**
-     * Custom params to give to the router on click
-     * If defined, will be treated as a dummy view and
-     * will just redirect and not fetch any contents.
-     */
-    params?: Record<string, string>;
-    /**
-     * This view column(s). Name and actions are
-     * by default always included
-     */
-    columns?: Column[];
-    /** The empty view element to render your empty content into */
-    emptyView?: (div: HTMLDivElement) => void;
-    /** The parent unique ID */
-    parent?: string;
-    /** This view is sticky (sent at the bottom) */
-    sticky?: boolean;
-    /**
-     * This view has children and is expanded (by default)
-     * or not. This will be overridden by user config.
-     */
-    expanded?: boolean;
-    /**
-     * Will be used as default if the user
-     * haven't customized their sorting column
-     */
-    defaultSortKey?: string;
-    /**
-     * Method called to load child views if any
-     */
-    loadChildViews?: (view: View) => Promise<void>;
-}
-export declare class View implements ViewData {
-    private _view;
-    constructor(view: ViewData);
-    get id(): string;
-    get name(): string;
-    get caption(): string | undefined;
-    get emptyTitle(): string | undefined;
-    get emptyCaption(): string | undefined;
-    get getContents(): (path: string) => Promise<ContentsWithRoot>;
-    get icon(): string;
-    set icon(icon: string);
-    get order(): number | undefined;
-    set order(order: number | undefined);
-    get params(): Record<string, string> | undefined;
-    set params(params: Record<string, string> | undefined);
-    get columns(): Column[] | undefined;
-    get emptyView(): ((div: HTMLDivElement) => void) | undefined;
-    get parent(): string | undefined;
-    get sticky(): boolean | undefined;
-    get expanded(): boolean | undefined;
-    set expanded(expanded: boolean | undefined);
-    get defaultSortKey(): string | undefined;
-    get loadChildViews(): ((view: View) => Promise<void>) | undefined;
-}
-export {};

package/dist/newFileMenu.d.ts

@@ -1,66 +0,0 @@
-import { Folder, Node } from './index';
-
-export declare enum NewMenuEntryCategory {
-    /**
-     * For actions where the user is intended to upload from their device
-     */
-    UploadFromDevice = 0,
-    /**
-     * For actions that create new nodes on the server without uploading
-     */
-    CreateNew = 1,
-    /**
-     * For everything not matching the other categories
-     */
-    Other = 2
-}
-export interface Entry {
-    /** Unique ID */
-    id: string;
-    /**
-     * Category to put this entry in
-     * (supported since Nextcloud 30)
-     * @since 3.3.0
-     * @default NewMenuEntryCategory.CreateNew
-     */
-    category?: NewMenuEntryCategory;
-    /** 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: Folder) => boolean;
-    /**
-     * Either iconSvgInline or iconClass must be defined
-     * Svg as inline string. <svg><path fill="..." /></svg>
-     */
-    iconSvgInline?: string;
-    /**
-     * Existing icon css class
-     * @deprecated use iconSvgInline instead
-     */
-    iconClass?: string;
-    /** Order of the entry in the menu */
-    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
-     */
-    handler: (context: Folder, content: Node[]) => void;
-}
-export declare class NewFileMenu {
-    private _entries;
-    registerEntry(entry: Entry): void;
-    unregisterEntry(entry: Entry | string): void;
-    /**
-     * Get the list of registered entries
-     *
-     * @param {Folder} context the creation context. Usually the current folder
-     */
-    getEntries(context?: Folder): Array<Entry>;
-    private getEntryIndex;
-    private validateEntry;
-}
-export declare const getNewFileMenu: () => NewFileMenu;

package/dist/permissions.d.ts

@@ -1,16 +0,0 @@
-/**
- * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
-/**
- * Node permissions
- */
-export declare enum Permission {
-    NONE = 0,
-    CREATE = 4,
-    READ = 1,
-    UPDATE = 2,
-    DELETE = 8,
-    SHARE = 16,
-    ALL = 31
-}

package/dist/utils/fileSize.d.ts

@@ -1,25 +0,0 @@
-/**
- * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
-/**
- * Format a file size in a human-like format. e.g. 42GB
- *
- * The default for Nextcloud is like Windows using binary sizes but showing decimal units,
- * meaning 1024 bytes will show as 1KB instead of 1KiB or like on Apple 1.02 KB
- *
- * @param size in bytes
- * @param skipSmallSizes avoid rendering tiny sizes and return '< 1 KB' instead
- * @param binaryPrefixes True if size binary prefixes like `KiB` should be used as per IEC 80000-13
- * @param base1000 Set to true to use base 1000 as per SI or used by Apple (default is base 1024 like Linux or Windows)
- */
-export declare function formatFileSize(size: number | string, skipSmallSizes?: boolean, binaryPrefixes?: boolean, base1000?: boolean): string;
-/**
- * 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
- */
-export declare function parseFileSize(value: string, forceBinary?: boolean): number | null;

package/dist/utils/fileSorting.d.ts

@@ -1,35 +0,0 @@
-import { INode } from '../files/node';
-import { SortingOrder } from './sorting';
-
-export declare enum FilesSortingMode {
-    Name = "basename",
-    Modified = "mtime",
-    Size = "size"
-}
-export interface FilesSortingOptions {
-    /**
-     * They key to order the files by
-     * @default FilesSortingMode.Name
-     */
-    sortingMode?: FilesSortingMode;
-    /**
-     * @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
- */
-export declare function sortNodes(nodes: readonly INode[], options?: FilesSortingOptions): INode[];

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

@@ -1,51 +0,0 @@
-/**
- * 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"
-}
-interface InvalidFilenameErrorOptions {
-    /**
-     * The filename that was validated
-     */
-    filename: string;
-    /**
-     * Reason why the validation failed
-     */
-    reason: InvalidFilenameErrorReason;
-    /**
-     * Part of the filename that caused this error
-     */
-    segment: string;
-}
-export declare class InvalidFilenameError extends Error {
-    constructor(options: InvalidFilenameErrorOptions);
-    /**
-     * The filename that was validated
-     */
-    get filename(): string;
-    /**
-     * Reason why the validation failed
-     */
-    get reason(): InvalidFilenameErrorReason;
-    /**
-     * Part of the filename that caused this error
-     */
-    get segment(): string;
-}
-/**
- * Validate a given filename
- * @param filename The filename to check
- * @throws {InvalidFilenameError}
- */
-export declare function validateFilename(filename: string): void;
-/**
- * Check the validity of a filename
- * This is a convinient wrapper for `checkFilenameValidity` to only return a boolean for the valid
- * @param filename Filename to check validity
- */
-export declare function isFilenameValid(filename: string): boolean;
-export {};

package/dist/utils/filename.d.ts

@@ -1,24 +0,0 @@
-/**
- * SPDX-FileCopyrightText: Ferdinand Thiessen <opensource@fthiessen.de>
- * SPDX-License-Identifier: AGPL-3.0-or-later or LGPL-3.0-or-later
- */
-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;
-    /**
-     * Set to true to ignore the file extension when adding the suffix (when getting a unique directory name)
-     */
-    ignoreFileExtension?: boolean;
-}
-/**
- * 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
- */
-export declare function getUniqueName(name: string, otherNames: string[], options?: UniqueNameOptions): string;
-export {};

package/dist/utils/logger.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import('@nextcloud/logger').ILogger;
-export default _default;

package/dist/utils/sorting.d.ts

@@ -1,12 +0,0 @@
-type IdentifierFn<T> = (v: T) => unknown;
-export type SortingOrder = 'asc' | 'desc';
-/**
- * Natural order a collection
- * You can define identifiers as callback functions, that get the element and return the value to sort.
- *
- * @param collection The collection to order
- * @param identifiers An array of identifiers to use, by default the identity of the element is used
- * @param orders Array of orders, by default all identifiers are sorted ascening
- */
-export declare function orderBy<T>(collection: readonly T[], identifiers?: IdentifierFn<T>[], orders?: SortingOrder[]): T[];
-export {};