npm - vvvfs - Versions diffs - 0.1.4 → 0.1.5 - Mend

vvvfs 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -86,6 +86,10 @@ const vvvfs = new VVVFS("vvvfs", {
 ## 更新日志
+### 0.1.5
+- 重新 `lock` 和 `unlock` 方法
 ### 0.1.4
 - 使用 AI 优化代码

package/index.html CHANGED Viewed

@@ -9,37 +9,7 @@
 </head>
 <body>
-    <script>
-        (async () => {
-            try {
-                globalThis.vvvfs = new VVVFS();
-                vvvfs.options.throwError = true;
-                await vvvfs.reset();
-                await vvvfs.init("IFTC");
-                console.log(vvvfs);
-                vvvfs.watch("/test.txt", (type) => {
-                    console.log(type);
-                    // return true;
-                });
-                console.log("创建文件", await vvvfs.createFile("/test.txt"));
-                console.log("写入文件", await vvvfs.writeText("/test.txt", "Hello World"));
-                console.log("追加文件", await vvvfs.appendText("/test.txt", " - Appended"));
-                // await vvvfs.lock("/test.txt");
-                console.log("文件是否存在", await vvvfs.exists("/test.txt"));
-                console.log("文件是否存在", await vvvfs.exists("/test2.txt"));
-                console.log("读取文件", await vvvfs.readText("/test.txt"));
-                console.log("读取文件块", await vvvfs.readTextChunk("/test.txt", 0, 5));
-                console.log("复制文件", await vvvfs.copy("/test.txt", "/test2.txt"));
-                console.log("搜索文件", await vvvfs.search("/", "t"));
-                console.log("移动文件", await vvvfs.move("/test2.txt", "/test3.txt"));
-                console.log("删除文件", await vvvfs.delete("/test.txt"));
-                const file = new VVVFS.File("test.txt");
-                console.log("写入文件", await file.writeText("Hello World"));
-            } catch (error) {
-                console.error(error);
-            }
-        })();
-    </script>
+    <script src="index.js"></script>
 </body>
 </html>

package/index.js ADDED Viewed

@@ -0,0 +1,34 @@
+/// <reference path="./types/index.d.ts" />
+/**
+ * @class VVVFS
+ * @description VVVFS 虚拟文件系统
+ */
+(async () => {
+    try {
+        globalThis.vvvfs = new VVVFS();
+        vvvfs.options.throwError = true;
+        await vvvfs.reset();
+        await vvvfs.init("IFTC");
+        console.log(vvvfs);
+        vvvfs.watch("/test.txt", (type) => {
+            console.log(type);
+            // return true;
+        });
+        console.log("创建文件", await vvvfs.createFile("/test.txt"));
+        console.log("写入文件", await vvvfs.writeText("/test.txt", "Hello World"));
+        console.log("追加文件", await vvvfs.appendText("/test.txt", " - Appended"));
+        // await vvvfs.lock("/test.txt");
+        console.log("文件是否存在", await vvvfs.exists("/test.txt"));
+        console.log("文件是否存在", await vvvfs.exists("/test2.txt"));
+        console.log("读取文件", await vvvfs.readText("/test.txt"));
+        console.log("读取文件块", await vvvfs.readTextChunk("/test.txt", 0, 5));
+        console.log("复制文件", await vvvfs.copy("/test.txt", "/test2.txt"));
+        console.log("搜索文件", await vvvfs.search("/", "t"));
+        console.log("移动文件", await vvvfs.move("/test2.txt", "/test3.txt"));
+        console.log("删除文件", await vvvfs.delete("/test.txt"));
+        const file = new VVVFS.File("test.txt");
+        console.log("写入文件", await file.writeText("Hello World"));
+    } catch (error) {
+        console.error(error);
+    }
+})();

package/index.ts CHANGED Viewed

@@ -15,6 +15,7 @@ import mime from "mime";
  * @param path 文件路径
  * @param type 文件类型(file或dir)
  * @param file 文件对象
+ * @param locked 是否锁定
  */
 export interface FileRecord {
     id?: number;
@@ -22,6 +23,7 @@ export interface FileRecord {
     path: string;
     type: string;
     file: File | null;
+    locked?: boolean;
 }
 /**
@@ -264,6 +266,12 @@ class VVVFSFile {
     async unlock() {
         return await this._vvvfs.unlock(this._path);
     }
+    /**
+     * 判断文件是否已锁定
+     */
+    async isLocked() {
+        return await this._vvvfs.isLocked(this._path);
+    }
 }
 const version = packageJson.version;
@@ -284,10 +292,6 @@ class VVVFS {
      * 虚拟文件系统监听器
      */
     #watchers: Record<string, Array<(type: string) => Promise<boolean>>> = {};
-    /**
-     * 锁定的文件
-     */
-    #lockedFiles: Record<string, boolean> = {};
     /**
      * 检查文件访问权限（监听器和锁定状态）
@@ -309,7 +313,7 @@ class VVVFS {
                 }
             }
         }
-        if (this.#lockedFiles[path]) {
+        if (await this.#isLocked(path)) {
             if (this.options.throwError) {
                 throw new VVVFSError(
                     operation.charAt(0).toUpperCase() + operation.slice(1),
@@ -321,6 +325,15 @@ class VVVFS {
         return true;
     }
+    /**
+     * 内部判断是否锁定（跳过错误包装）
+     */
+    async #isLocked(path: string): Promise<boolean> {
+        const { name, parent } = parsePath(path);
+        const fileRecord = await this.#db.files.where({ name, path: parent }).first();
+        return !!fileRecord?.locked;
+    }
     /**
      * 错误处理包装器
      * @param operation 操作名称
@@ -364,6 +377,15 @@ class VVVFS {
             this.#db.version(1).stores({
                 files: "++id, name, path, type, file, [name+path+type]",
             });
+            this.#db.version(2).stores({
+                files: "++id, name, path, type, file, locked, [name+path+type]",
+            }).upgrade(async (tx) => {
+                await tx.table("files").toCollection().modify((file: FileRecord) => {
+                    if (file.locked === undefined) {
+                        file.locked = false;
+                    }
+                });
+            });
         } catch (error) {
             console.error("创建数据库失败", error);
             throw new VVVFSError("CreateDatabase", "创建数据库失败");
@@ -384,12 +406,14 @@ class VVVFS {
             path: "/",
             type: "dir" as const,
             file: new File([], name),
+            locked: false,
         }));
         linuxInitFiles.push({
             name: user || "root",
             path: "/home",
             type: "dir" as const,
             file: new File([], "home"),
+            locked: false,
         });
         try {
             for (const file of linuxInitFiles) {
@@ -411,6 +435,9 @@ class VVVFS {
             this.#db.version(1).stores({
                 files: "++id, name, path, type, file, [name+path+type]",
             });
+            this.#db.version(2).stores({
+                files: "++id, name, path, type, file, locked, [name+path+type]",
+            });
         } catch (error) {
             console.error("重置数据库失败", error);
             throw new VVVFSError("ResetDatabase", "重置数据库失败" + error);
@@ -439,6 +466,7 @@ class VVVFS {
                 file: new File([], name, {
                     type: mime.getType(targetPath) || "application/octet-stream",
                 }),
+                locked: false,
             });
             return true;
         }, false);
@@ -463,6 +491,7 @@ class VVVFS {
                         path: "/",
                         type: "dir",
                         file: new File([], ""),
+                        locked: false,
                     });
                     if (name === "") return true;
                 } else {
@@ -474,6 +503,7 @@ class VVVFS {
                 path: parent,
                 type: "dir",
                 file: new File([], name),
+                locked: false,
             });
             return true;
         }, false);
@@ -862,6 +892,7 @@ class VVVFS {
                     path: newParent,
                     type: fileRecord.type,
                     file: fileRecord.file,
+                    locked: false,
                 });
                 return true;
             }
@@ -922,16 +953,22 @@ class VVVFS {
      */
     async lock(path: string) {
         return this.#withErrorHandling("lock", async () => {
-            path = joinPath(path);
-            if (!(await this.exists(path))) {
+            const targetPath = joinPath(path);
+            if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 return false;
             }
-            if (this.#lockedFiles[path]) {
+            if (await this.#isLocked(targetPath)) {
                 console.warn("文件已被锁定");
                 return false;
             }
-            this.#lockedFiles[path] = true;
+            const { name, parent } = parsePath(targetPath);
+            const fileRecord = await this.#db.files.where({ name, path: parent }).first();
+            if (!fileRecord?.id) {
+                console.warn("文件记录未找到");
+                return false;
+            }
+            await this.#db.files.update(fileRecord.id, { locked: true });
             return true;
         }, false);
     }
@@ -941,19 +978,38 @@ class VVVFS {
      */
     async unlock(path: string) {
         return this.#withErrorHandling("unlock", async () => {
-            path = joinPath(path);
-            if (!(await this.exists(path))) {
+            const targetPath = joinPath(path);
+            if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 return false;
             }
-            if (!this.#lockedFiles[path]) {
+            if (!(await this.#isLocked(targetPath))) {
                 console.warn("文件未被锁定");
                 return false;
             }
-            delete this.#lockedFiles[path];
+            const { name, parent } = parsePath(targetPath);
+            const fileRecord = await this.#db.files.where({ name, path: parent }).first();
+            if (!fileRecord?.id) {
+                console.warn("文件记录未找到");
+                return false;
+            }
+            await this.#db.files.update(fileRecord.id, { locked: false });
             return true;
         }, false);
     }
+    /**
+     * 判断文件是否已锁定
+     * @param path 文件路径
+     */
+    async isLocked(path: string) {
+        return this.#withErrorHandling("isLocked", async () => {
+            const targetPath = joinPath(path);
+            if (!(await this.exists(targetPath))) {
+                return false;
+            }
+            return await this.#isLocked(targetPath);
+        }, false);
+    }
 }
 /**
  * 解析路径

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "vvvfs",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "一个使用IndexDB实现的虚拟文件系统",
   "keywords": [
     "Virtual",

package/types/index.d.ts ADDED Viewed

@@ -0,0 +1,396 @@
+import { Dexie, Table } from "dexie";
+/**
+ * 虚拟文件系统
+ */
+declare global {
+    // 扩展 Window 接口
+    interface window {
+        VVVFS: typeof VVVFS; // 如果 VVFS 是个类，这里可能需要调整，或者直接定义 vvfs 实例
+    }
+    // 扩展 GlobalThis (针对你在 index.js 里的 globalThis.vvfs 写法)
+    // 注意：GlobalThis 和 Window 往往指向同一个对象，但在 TS 类型中有时需要分别处理
+    // var VVVFS: typeof VVVFS;
+}
+/**
+ * 文件记录
+ * @param id 文件id
+ * @param name 文件名
+ * @param path 文件路径
+ * @param type 文件类型(file或dir)
+ * @param file 文件对象
+ * @param locked 是否锁定
+ */
+declare interface FileRecord {
+    id?: number;
+    name: string;
+    path: string;
+    type: string;
+    file: File | null;
+    locked?: boolean;
+}
+/**
+ * 虚拟文件系统数据库
+ * @param files 文件存储数据表
+ */
+declare interface VVVFSDatabase extends Dexie {
+    files: Table<FileRecord, number>;
+}
+/**
+ * 虚拟文件系统配置项
+ * @param throwError 是否抛出错误
+ */
+declare interface VVVFSOptions {
+    throwError: boolean;
+}
+/**
+ * 虚拟文件系统错误类
+ */
+declare class VVVFSError extends Error {
+    /**
+     * @param type 错误类型
+     * @param message 错误信息
+     */
+    constructor(type: string, message: string);
+}
+/**
+ * 虚拟文件系统文件类
+ * @param path 文件路径
+ */
+declare class VVVFSFile {
+    /**
+     * 获取文件路径
+     */
+    get path(): string;
+    /**
+     * 设置文件路径
+     * @param path 文件路径
+     */
+    set path(path: string);
+    /**
+     * 设置数据库名称
+     * @param dbname 数据库名称
+     */
+    set dbname(dbname: string);
+    /**
+     * 获取数据库名称
+     */
+    get dbname(): string;
+    set options(options: VVVFSOptions);
+    get options(): VVVFSOptions;
+    /**
+     * 构造函数
+     * @param paths 文件路径
+     */
+    constructor(...paths: string[]);
+    /**
+     * 读取文件
+     */
+    read(): Promise<File | null>;
+    /**
+     * 读取文件文本内容
+     */
+    readText(): Promise<string | null>;
+    /**
+     * 读取文件JSON内容
+     */
+    readJSON(): Promise<Record<string, unknown> | null>;
+    /**
+     * 读取文件内容
+     * @param start 起始位置
+     * @param end 结束位置
+     */
+    readChunk(start: number, end: number): Promise<Blob | null>;
+    /**
+     * 读取文件内容
+     * @param start 起始位置
+     * @param end 结束位置
+     */
+    readTextChunk(start: number, end: number): Promise<string | null>;
+    /**
+     * 写入文件
+     * @param file 文件对象
+     */
+    write(file: Blob): Promise<boolean>;
+    /**
+     * 写入文件文本内容
+     * @param text 文件文本内容
+     */
+    writeText(text: string): Promise<boolean>;
+    /**
+     * 写入文件JSON内容
+     * @param json 文件JSON内容
+     */
+    writeJSON(json: Record<string, unknown>, format?: boolean): Promise<boolean>;
+    /**
+     * 追加文件内容
+     * @param file 文件对象
+     */
+    append(file: Blob): Promise<boolean>;
+    /**
+     * 追加文件文本内容
+     * @param text 文件文本内容
+     */
+    appendText(text: string): Promise<boolean>;
+    /**
+     * 创建文件
+     */
+    createFile(): Promise<boolean>;
+    /**
+     * 创建文件夹
+     */
+    createDir(): Promise<boolean>;
+    /**
+     * 删除文件
+     */
+    delete(): Promise<boolean>;
+    /**
+     * 判断文件是否存在
+     */
+    exists(): Promise<boolean>;
+    /**
+     * 获取文件大小
+     */
+    isFile(): Promise<boolean>;
+    /**
+     * 判断文件是否是文件夹
+     */
+    isDir(): Promise<boolean>;
+    /**
+     * 列出文件
+     */
+    list(): Promise<string[]>;
+    /**
+     * 重命名文件
+     */
+    rename(newName: string): Promise<boolean>;
+    /**
+     * 移动文件
+     */
+    move(newPath: string): Promise<boolean>;
+    /**
+     * 复制文件
+     */
+    copy(newPath: string): Promise<boolean>;
+    /**
+     * 搜索文件
+     */
+    search(query: string): Promise<string[] | null>;
+    /**
+     * 监听文件
+     */
+    watch(handler: (type: string) => Promise<boolean>): void;
+    /**
+     * 锁定文件
+     */
+    lock(): Promise<boolean>;
+    /**
+     * 解锁文件
+     */
+    unlock(): Promise<boolean>;
+    /**
+     * 判断文件是否已锁定
+     */
+    isLocked(): Promise<boolean>;
+}
+/**
+ * 虚拟文件系统
+ * @author IFTC
+ * @description 虚拟文件系统
+ */
+declare class VVVFS {
+    static defaultDBName: string;
+    /**
+     * 虚拟文件系统版本
+     */
+    static readonly version: string;
+    /**
+     * 虚拟文件系统作者
+     */
+    static readonly author: string;
+    /**
+     * 虚拟文件系统文件类
+     */
+    static File: typeof VVVFSFile;
+    options: VVVFSOptions;
+    /**
+     * 创建虚拟文件系统
+     * @param name 虚拟文件系统名称
+     * @param options 配置项
+     */
+    constructor(name?: string, options?: VVVFSOptions);
+    /**
+     * 初始化虚拟文件系统
+     * @description 将Linux的系统初始文件初始化到数据库中
+     */
+    init(user?: string): Promise<void>;
+    /**
+     * 重置虚拟文件系统
+     */
+    reset(): Promise<void>;
+    /**
+     * 创建文件
+     * @param path 文件路径
+     */
+    createFile(path: string): Promise<boolean>;
+    /**
+     * 创建目录
+     * @param path 目录路径
+     */
+    createDir(path: string): Promise<boolean>;
+    /**
+     * 判断文件是否存在
+     * @param path 文件路径
+     */
+    exists(path: string): Promise<boolean>;
+    /**
+     * 读取文件内容
+     * @param path 文件路径
+     */
+    read(path: string): Promise<File | null>;
+    /**
+     * 读取文件文本内容
+     * @param path 文件路径
+     */
+    readText(path: string): Promise<string | null>;
+    /**
+     * 读取JSON内容
+     * @param path 文件路径
+     */
+    readJson(path: string): Promise<Record<string, unknown> | null>;
+    /**
+     * 写入文件
+     * @param path 文件路径
+     * @param content 文件内容
+     */
+    write(path: string, content: Blob): Promise<boolean>;
+    /**
+     * 写入文本内容
+     * @param path 文件路径
+     * @param content 文本内容
+     */
+    writeText(path: string, content: string): Promise<boolean>;
+    /**
+     * 写入JSON内容
+     * @param path 文件路径
+     * @param content JSON内容
+     * @param format 是否格式化
+     */
+    writeJson(path: string, content: Record<string, unknown>, format?: boolean): Promise<boolean>;
+    /**
+     * 追加内容
+     * @param path 文件路径
+     * @param content 追加内容
+     */
+    append(path: string, content: Blob): Promise<boolean>;
+    /**
+     * 追加文本内容
+     * @param path 文件路径
+     * @param content 追加内容
+     */
+    appendText(path: string, content: string): Promise<boolean>;
+    /**
+     * 读取文件内容
+     * @param path 文件路径
+     * @param start 开始位置
+     * @param end 结束位置
+     */
+    readChunk(path: string, start: number, end: number): Promise<Blob | null>;
+    /**
+     * 读取文件内容
+     * @param path 文件路径
+     * @param start 读取开始位置
+     * @param end 读取结束位置
+     */
+    readTextChunk(path: string, start: number, end: number): Promise<string | null>;
+    /**
+     * 判断是否是文件
+     * @param path 文件路径
+     */
+    isFile(path: string): Promise<boolean>;
+    /**
+     * 判断是否是目录
+     * @param path 文件路径
+     */
+    isDir(path: string): Promise<boolean>;
+    /**
+     * 列出目录下的文件
+     * @param path 目录路径
+     */
+    list(path: string): Promise<string[]>;
+    /**
+     * 重命名文件
+     * @param path 文件路径
+     * @param newName 新文件名
+     */
+    rename(path: string, newName: string): Promise<boolean>;
+    /**
+     * 删除文件
+     * @param path 文件路径
+     */
+    delete(path: string): Promise<boolean>;
+    /**
+     * 移动文件
+     * @param path 文件路径
+     * @param newPath 新路径
+     */
+    move(path: string, newPath: string): Promise<boolean>;
+    /**
+     * 复制文件
+     * @param path 文件路径
+     * @param newPath 新路径
+     */
+    copy(path: string, newPath: string): Promise<boolean>;
+    /**
+     * 搜索文件
+     * @param basePath 基础路径
+     * @param query 查询字符串
+     */
+    search(basePath: string, query: string): Promise<string[] | null>;
+    /**
+     * 监听文件
+     * @param path 文件路径
+     * @param handler 监听器
+     */
+    watch(path: string, handler: (type: string) => Promise<boolean>): void;
+    /**
+     * 锁定文件
+     * @param path 文件路径
+     */
+    lock(path: string): Promise<boolean>;
+    /**
+     * 解锁文件
+     * @param path 文件路径
+     */
+    unlock(path: string): Promise<boolean>;
+    /**
+     * 判断文件是否已锁定
+     * @param path 文件路径
+     */
+    isLocked(path: string): Promise<boolean>;
+}
+/**
+ * 解析路径
+ * @param path 路径
+ */
+declare function parsePath(path: string): { name: string; parent: string };
+/**
+ * 合并路径
+ * @param paths 路径
+ */
+declare function joinPath(...paths: string[]): string;