@solazah/solazah-runtime 0.0.157 → 0.0.159

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 (2) hide show
  1. package/package.json +1 -1
  2. package/types/File.d.ts +16 -16
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@solazah/solazah-runtime",
3
- "version": "0.0.157",
3
+ "version": "0.0.159",
4
4
  "main": "index.cjs",
5
5
  "module": "index.js",
6
6
  "types": "types/index.d.ts",
package/types/File.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { default as IpcRenderer } from './IpcRenderer';
2
- export type WorkspaceCategory = "document" | "image" | "audio" | "video" | "resource";
2
+ export type WorkspaceCategory = "document" | "image" | "audio" | "video" | "blob";
3
3
  export interface FileEntry {
4
4
  name: string;
5
5
  path: string;
@@ -33,7 +33,7 @@ export default class File {
33
33
  /**
34
34
  * 读取分类目录下某个文本文件的全部内容(UTF-8)。
35
35
  *
36
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
36
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
37
37
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
38
38
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
39
39
  * @returns 文件的 UTF-8 文本内容。
@@ -43,7 +43,7 @@ export default class File {
43
43
  /**
44
44
  * 把文本内容写入分类目录下的相对路径，父目录不存在则自动创建(UTF-8 覆盖写)。
45
45
  *
46
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
46
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
47
47
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
48
48
  * @param content 要写入的 UTF-8 文本内容。
49
49
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
@@ -54,7 +54,7 @@ export default class File {
54
54
  /**
55
55
  * 读取分类目录下某个文件的二进制内容。
56
56
  *
57
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
57
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
58
58
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
59
59
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
60
60
  * @returns 文件的二进制内容(Buffer)。
@@ -64,7 +64,7 @@ export default class File {
64
64
  /**
65
65
  * 把二进制数据写入分类目录下的相对路径，父目录不存在则自动创建(覆盖写)。
66
66
  *
67
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
67
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
68
68
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
69
69
  * @param data 要写入的二进制数据(Uint8Array)。
70
70
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
@@ -75,7 +75,7 @@ export default class File {
75
75
  /**
76
76
  * 列出分类目录(或其下子目录)的直接子项；软链会被跳过。
77
77
  *
78
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
78
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
79
79
  * @param relPath 相对该分类目录的子目录路径，`/` 分隔；默认 `""` 即分类根目录。越界会被拦截。
80
80
  * @param options 可选配置：`recursive` 为 `true` 时深度展开所有后代；`workspaceId` 指定工作空间。
81
81
  * @returns 子项列表(FileEntry[])，目录不存在时返回空数组。
@@ -85,7 +85,7 @@ export default class File {
85
85
  /**
86
86
  * 取某个文件或目录的元信息(是否目录、大小、修改时间、创建时间)。
87
87
  *
88
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
88
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
89
89
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
90
90
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
91
91
  * @returns 文件元信息(FileStat)；文件/目录不存在时返回 `null`。
@@ -95,7 +95,7 @@ export default class File {
95
95
  /**
96
96
  * 判断分类目录下的文件或目录是否存在。
97
97
  *
98
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
98
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
99
99
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
100
100
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
101
101
  * @returns 存在返回 `true`，否则返回 `false`。
@@ -105,7 +105,7 @@ export default class File {
105
105
  /**
106
106
  * 在分类目录下创建目录(递归创建缺失的父级)。
107
107
  *
108
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
108
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
109
109
  * @param relPath 相对该分类目录的路径，`/` 分隔；越界会被拦截。
110
110
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
111
111
  * @returns 无返回。
@@ -115,7 +115,7 @@ export default class File {
115
115
  /**
116
116
  * 删除分类目录下的文件或目录(递归、强制)。
117
117
  *
118
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
118
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
119
119
  * @param relPath 相对该分类目录的路径，`/` 分隔；**不能为空**，否则拒绝删除分类根目录。
120
120
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
121
121
  * @returns 无返回。
@@ -125,7 +125,7 @@ export default class File {
125
125
  /**
126
126
  * 在同一分类目录内把文件或目录从 fromRel 移至 toRel(自动创建目标父目录)。
127
127
  *
128
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
128
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
129
129
  * @param fromRel 源路径，相对该分类目录，`/` 分隔；越界会被拦截。
130
130
  * @param toRel 目标路径，相对该分类目录，`/` 分隔；越界会被拦截。
131
131
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
@@ -136,7 +136,7 @@ export default class File {
136
136
  /**
137
137
  * 把「分类 + 相对路径」解析成宿主机上的绝对路径。
138
138
  *
139
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
139
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
140
140
  * @param relPath 相对该分类目录的路径，`/` 分隔；默认 `""` 即分类根目录。越界会被拦截。
141
141
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
142
142
  * @returns 宿主机绝对路径。
@@ -146,7 +146,7 @@ export default class File {
146
146
  /**
147
147
  * 把「分类 + 相对路径」解析成 `file://` URL，供 `<img>` / `<video>` 等直接引用。
148
148
  *
149
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
149
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
150
150
  * @param relPath 相对该分类目录的路径，`/` 分隔；默认 `""` 即分类根目录。越界会被拦截。
151
151
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
152
152
  * @returns `file://` 协议 URL 字符串。
@@ -156,9 +156,9 @@ export default class File {
156
156
  /**
157
157
  * 计算从 fromRel(目录)到 toRel 的相对路径(`/` 分隔)，跨分类可用——用于笔记内引用附件算可移植的相对引用。
158
158
  *
159
- * @param fromCategory 源分类目录：`document` / `image` / `audio` / `video` / `resource`。
159
+ * @param fromCategory 源分类目录：`document` / `image` / `audio` / `video` / `blob`。
160
160
  * @param fromRel 源路径(目录)，相对 fromCategory，`/` 分隔；越界会被拦截。
161
- * @param toCategory 目标分类目录：`document` / `image` / `audio` / `video` / `resource`。
161
+ * @param toCategory 目标分类目录：`document` / `image` / `audio` / `video` / `blob`。
162
162
  * @param toRel 目标路径，相对 toCategory，`/` 分隔；越界会被拦截。
163
163
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
164
164
  * @returns `/` 分隔的相对路径字符串。
@@ -170,7 +170,7 @@ export default class File {
170
170
  * 建立订阅后，目录内任何文件/子目录的增删改都会通过 IPC 频道 `file.watch.<watchId>` 推送给调用方所在渲染进程；
171
171
  * 同一 watchId 重复订阅时先关闭旧 watcher。渲染进程销毁时自动关闭其所有 watcher。
172
172
  *
173
- * @param category 分类目录：`document` / `image` / `audio` / `video` / `resource`。
173
+ * @param category 分类目录：`document` / `image` / `audio` / `video` / `blob`。
174
174
  * @param watchId 订阅标识，用于后续 `file.unwatch` 取消订阅；也作为推送频道名的一部分。
175
175
  * @param workspaceId 目标工作空间；省略则用当前默认工作空间。
176
176
  * @returns 无返回(Promise resolve 表示订阅已建立)。