@openviking/react 0.1.5 → 0.1.7

package/dist/modules/file-browser/fs-lines.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 与服务端一致的行切分。
+ *
+ * `content/read` 的 `offset` / `limit` 是行号，服务端用 Python 的
+ * `str.splitlines(keepends=True)` 切分。前端自己切行时必须用同一套边界，否则两边
+ * 数出的行数不同：单独一个 `\r` 在 Python 里是一行结束，`split('\n')` 却看不见它；
+ * 而「2000 行、每行以 `\n` 结尾」的文本在 `split('\n')` 下会多出一个末尾空串，被
+ * 当成第 2001 行。
+ *
+ * Line splitting that matches the server.
+ *
+ * `offset` / `limit` on `content/read` are line numbers, and the server splits with
+ * Python's `str.splitlines(keepends=True)`. A client that slices lines itself has to
+ * use the same boundaries or the two disagree on how many lines there are: a lone
+ * `\r` ends a line in Python while `split('\n')` does not see it, and a text of 2000
+ * lines each ending in `\n` gains a trailing empty element under `split('\n')` that
+ * looks like a 2001st line.
+ */
+/**
+ * 按服务端的分隔符切行，每行保留自己的换行符；末尾的换行符不产生额外空行。
+ *
+ * 空串返回空数组，与服务端一致——`''.splitlines()` 也是 `[]`。
+ *
+ * Splits into lines at the server's separators, each line keeping its own terminator;
+ * a trailing terminator produces no extra empty line.
+ *
+ * An empty string yields an empty array, matching the server: `''.splitlines()` is
+ * `[]` too.
+ */
+export declare function splitLines(text: string): string[];
+/**
+ * 把行拼回文本。行自带换行符，直接相连即可，不额外补。
+ * Joins lines back into text. Each line carries its own terminator, so they simply
+ * concatenate without adding any.
+ */
+export declare function joinLines(lines: readonly string[]): string;

package/dist/modules/file-browser/fs-memory-fields.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 记忆文件末尾的 `MEMORY_FIELDS` 注释：服务端写给系统的内部元数据（版本、来源
+ * 追踪 id、记忆类型），不属于正文，也不该出现在预览里。
+ *
+ * 正常读取（`content/read` 不带 `raw`）由服务端先剥掉它再按 offset/limit 切片，
+ * 这里的处理是同一规则的兜底：宿主可能通过自定义传输层或网关让请求带上
+ * `raw=true`，那条路径返回的是原始字节，尾注会原样回来。
+ *
+ * 规则与后端保持一致，而不是「看到同形注释就删」：
+ *
+ * - 只认**位于文件末尾**的那一块（其后只剩空白），正文中间出现的同形注释属于
+ *   内容本身，例如资源文档里举例的这段标记；
+ * - 连续多块尾注一起剥掉；
+ * - 只在记忆命名空间生效，资源与技能文件不经过这一步。
+ *
+ * 空白与「单词字符」都按 Python 的语义判定，不沿用 JS 的 `\s` / `\b` / `trim()`：
+ * 两者集合并不相同，照搬会在默认 `raw=false` 路径上删掉服务端已经保留的正文。
+ * 详见下面两个字符集的说明。
+ *
+ * The `MEMORY_FIELDS` comment at the end of a memory file: internal metadata the
+ * server writes for its own bookkeeping (version, trace ids, memory type). It is not
+ * part of the body and must not reach the preview.
+ *
+ * A normal read (`content/read` without `raw`) has the server strip it before slicing
+ * by offset/limit; the handling here is the same rule as a fallback. A host can make
+ * the request carry `raw=true` through a custom transport or a gateway, and that path
+ * returns the stored bytes with the trailer intact.
+ *
+ * The rule mirrors the backend rather than "delete anything shaped like this":
+ *
+ * - only the block that ends the file counts (nothing but whitespace after it); a
+ *   same-shaped comment in the middle is content, such as one quoted in a resource
+ *   document;
+ * - consecutive trailing blocks are all removed;
+ * - it applies to the memory namespace only — resource and skill files never go
+ *   through it.
+ *
+ * Whitespace and "word characters" follow Python's definitions rather than JS's
+ * `\s` / `\b` / `trim()`. The two sets differ, and copying JS's would delete body text
+ * the server deliberately kept on the default `raw=false` path. Both sets are spelled
+ * out below.
+ */
+/**
+ * 该 URI 是否落在记忆命名空间。`viking://~/memories/...` 这类当前用户别名按
+ * `user/<uid>` 展开后再判断，与请求边界上的解析一致。
+ *
+ * Whether the URI sits in the memory namespace. The `viking://~/memories/...` home
+ * alias is expanded to `user/<uid>` first, matching how the request boundary resolves
+ * it.
+ */
+export declare function isMemoryUri(uri: string): boolean;
+/**
+ * 剥掉文件末尾的 `MEMORY_FIELDS` 尾注；没有尾注时原样返回。
+ *
+ * 每次循环只认「其后全是空白」的最后一块，剥完再判断一次，因为连续多块尾注
+ * 需要逐个处理；正文中间的同形注释因此不会被误删。
+ *
+ * Removes the trailing `MEMORY_FIELDS` blocks; returns the text unchanged when there
+ * is none.
+ *
+ * Each pass takes only the last block that nothing but whitespace follows, then checks
+ * again, because consecutive trailing blocks need one pass each; a same-shaped comment
+ * in the middle of the body is therefore never removed.
+ */
+export declare function stripMemoryFieldsTrailer(text: string): string;

package/dist/modules/file-browser/fs-model.d.ts

@@ -12,6 +12,9 @@ export interface FsEntry {
     size?: number;
     modTime?: string;
     abstract?: string;
+    tags?: readonly string[];
+    access?: 'denied' | 'container';
+    permission?: 'read' | 'write' | 'manage';
 }
 /** 一个目录已加载的子节点与分页状态。 */
 export interface DirState {
@@ -54,16 +57,25 @@ export declare function nameFromUri(uri: string): string;
  * `index` is for search results: one URI can appear in two categories, and row
  * ids must be unique or selection and scroll targeting hit the wrong row.
  */
-export declare function toEntryRow(entry: FsEntry, depth: number, expanded: boolean, index?: number, busy?: boolean): FileTreeEntryRow;
+export declare function toEntryRow(entry: FsEntry, depth: number, expanded: boolean, index?: number, busy?: boolean): FileTreeEntryRow & {
+    tags?: readonly string[];
+};
 /**
  * 一个文件的预览页签。行数达到上限时按截断处理——接口不返回总行数，只能由
  * 「读满了」推断出「可能还有」。
  *
+ * 调用方自己切过行时用 `truncated` 说明结果，因为「正文行数等于上限」既可能是
+ * 正好读完，也可能是切掉了一部分，只有切的人知道是哪一种。
+ *
  * A preview tab for one file. Reaching the line cap is reported as truncation:
  * the API returns no total, so "the cap was filled" is the only signal that more
  * content may exist.
+ *
+ * A caller that sliced the lines itself states the outcome through `truncated`:
+ * "the body has exactly the cap" can mean the file ended there or that the rest was
+ * cut, and only the caller knows which.
  */
-export declare function toFileTab(entry: FsEntry, content: string, maxLines: number, icon?: ReactNode, openParent?: (uri: string) => Promise<void>): FilePreviewFileTab;
+export declare function toFileTab(entry: FsEntry, content: string, maxLines: number, icon?: ReactNode, openParent?: (uri: string) => Promise<void>, truncated?: boolean): FilePreviewFileTab;
 /**
  * 目录的预览页签：两级摘要各自成一级，走 `directory` 页签，而不是文件页签。
  *
@@ -103,4 +115,4 @@ export declare function flattenTree(uri: string, depth: number, dirs: Record<str
 /** 请求被取消时不需要写回状态。A cancelled request has no state to write. */
 export declare function isAbort(error: unknown): boolean;
 /** 把任意抛出物归一成 Error。Normalises a thrown value into an Error. */
-export declare function toError(cause: unknown): Error;
+export declare const toError: (cause: unknown) => Error;

package/dist/modules/file-browser/fs-read-file.d.ts

@@ -0,0 +1,14 @@
+import type { OvClient, OvRequestOptions } from '../../client/types.js';
+import type { FilePreviewFileTab } from '../../components/file-preview/index.js';
+/** 读取正文的行数上限；读满即按截断处理。The line cap; a full read counts as truncated. */
+export declare const MAX_LINES = 2000;
+/**
+ * 读文件并包装成页签。文本走 `content/read`，二进制走 `content/download` 取原始
+ * 字节——前者把内容当文本返回，二进制文件经过它只会得到一串乱码，图片与 PDF
+ * 因此永远渲染不出来。
+ *
+ * Reads a file into a tab. Text goes through `content/read` and binary files
+ * through `content/download` for the raw bytes: the former returns content as
+ * text, so a binary file only yields mojibake and images or PDFs never render.
+ */
+export declare function readFile(client: OvClient, uri: string, options: OvRequestOptions, openParent?: (uri: string) => Promise<void>): Promise<FilePreviewFileTab>;

package/dist/modules/file-browser/index.d.ts

@@ -1,3 +1,4 @@
 export { FileBrowser } from './file-browser.js';
-export { useFileBrowser } from './use-file-browser.js';
-export type { FileBrowserActions, FileBrowserApi, FileBrowserLabels, FileBrowserProps, } from './types.js';
+export type { FileBrowserLabels, FileBrowserDashboardLabels, FileBrowserProps, } from './types.js';
+export type { FileBrowserDashboard } from './dashboard-model.js';
+export type { FileBrowserAclLevel, FileBrowserAclEntry, FileBrowserAclReport, FileBrowserAclContext, FileBrowserAclPrincipalPage, FileBrowserAclOptions, FileBrowserAclLabels, } from './acl-types.js';

package/dist/modules/file-browser/locales/en-US.d.ts

@@ -1,10 +1,15 @@
 declare const messages: {
     formatCharacterCount: (count: number) => string;
+    accessDenied: string;
+    traverseOnly: string;
     empty: string;
     error: string;
     retry: string;
     refresh: string;
     searchPlaceholder: string;
+    searchTitle: string;
+    searchAction: string;
+    searchHint: string;
     searchEmpty: string;
     searchFailed: string;
     loading: string;

package/dist/modules/file-browser/locales/zh-CN.d.ts

@@ -1,10 +1,15 @@
 declare const messages: {
     formatCharacterCount: (count: number) => string;
+    accessDenied: string;
+    traverseOnly: string;
     empty: string;
     error: string;
     retry: string;
     refresh: string;
     searchPlaceholder: string;
+    searchTitle: string;
+    searchAction: string;
+    searchHint: string;
     searchEmpty: string;
     searchFailed: string;
     loading: string;