@nextcloud/files 3.4.0 → 3.5.0

package/README.md

@@ -1,5 +1,9 @@
+<!--
+  - SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors
+  - SPDX-License-Identifier: AGPL-3.0-or-later
+-->
 # @nextcloud/files
-[![npm last version](https://img.shields.io/npm/v/@nextcloud/files.svg?style=flat-square)](https://www.npmjs.com/package/@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/)
+[![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
 

package/dist/files/file.d.ts

@@ -1,6 +1,12 @@
 import { FileType } from './fileType';
-import { Node } from './node';
+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,23 +1,6 @@
 /**
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 export declare enum FileType {
     Folder = "folder",

package/dist/files/folder.d.ts

@@ -1,5 +1,5 @@
 import { FileType } from './fileType';
-import { Node } from './node';
+import { INode, Node } from './node';
 import { NodeData } from './nodeData';
 
 export declare class Folder extends Node {
@@ -8,3 +8,11 @@ export declare class Folder extends Node {
     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

@@ -60,10 +60,12 @@ export declare abstract class Node {
     get mime(): string | undefined;
     /**
      * Get the file modification time
-     * There is no setter as the modification time is not meant to be changed manually.
-     * It will be automatically updated when the attributes are changed.
      */
     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
@@ -136,13 +138,18 @@ export declare abstract class Node {
      */
     rename(basename: string): void;
     /**
-     * Update the mtime if exists.
+     * Update the mtime if exists
      */
-    private updateMtime;
+    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>;