vitepress-plugin-filelist 0.5.0 → 0.5.1

package/README.md

@@ -203,7 +203,7 @@ import { fileListLocales, formatLabel, resolveLabels } from 'vitepress-plugin-fi
 | 入口 | 内容 |
 | --- | --- |
 | `vitepress-plugin-filelist` | `fileList` 插件（默认导出） |
-| `vitepress-plugin-filelist/client` | `FileList`、`VPFileList`、`enhanceAppWithFileList`、类型 |
+| `vitepress-plugin-filelist/client` | `FileList`、`VPFileList`、`enhanceAppWithFileList`、文案工具（`fileListLocales`、`formatLabel`、`resolveLabels`）、格式与文件类型工具（`formatSize`、`formatDate`、`fileKind`、`previewKind` 等）、类型 |
 | `vitepress-plugin-filelist/style.css` | 组件样式 |
 
 ## 兼容性
@@ -237,11 +237,25 @@ Deno 可以安装 npm 依赖，但目前用 Deno 构建 VitePress 会在 rolldow
 ```bash
 pnpm install
 pnpm run build       # 生成 dist/node、dist/client/ssr、dist/client/browser、style.css
-pnpm run typecheck
-pnpm test            # Vitest：utils、locale helpers、FileList 组件
+pnpm run typecheck   # vue-tsc，包含 .vue 模板与测试
+pnpm test            # Vitest：工具函数、密码、下载、FileList 组件
 pnpm run pack:check
 ```
 
+源码结构（`src/client`）：
+
+| 文件 | 职责 |
+| --- | --- |
+| `FileList.vue` | 组件：把下列模块接到界面 |
+| `api.ts` | OpenList 接口、文件地址缓存、错误判断 |
+| `demo.ts` | 演示数据（与 `api.ts` 同一接口） |
+| `tree.ts` | 树节点、排序、目录统计 |
+| `usePasswords.ts` / `passwords.ts` | 目录密码的选择顺序 / 标签页内记住 |
+| `download.ts` | 单文件下载、批量 ZIP |
+| `PreviewDialog.vue` | 预览弹窗 |
+| `Icon.vue` / `icons.ts` | 图标 |
+| `utils.ts` | 路径、格式化、文件类型表 |
+
 仓库统一使用 pnpm（`pnpm-lock.yaml`），CI 与发布流程执行 `pnpm install --frozen-lockfile`。
 
 `demo/` 下的演示站通过 `file:..` 安装本地包：

package/dist/client/browser/index.d.ts

@@ -18,6 +18,8 @@ interface FileListLabels {
   loading: string;
   loadFailed: string;
   guestHint: string;
+  /** Shown (and appended to toasts) for browser network errors, usually CORS. */
+  /** Shown (and appended to toasts) for browser network errors, usually CORS. */
   corsHint: string;
   retry: string;
   empty: string;
@@ -75,7 +77,7 @@ interface FileListLabels {
   /** Refresh failed; the old rows stay. `{message}` */
   refreshFailed: string;
   cancel: string;
-  /** Placeholder / accessible name of a folder's password input. `{name}` */
+  /** Accessible name of a folder's password input. `{name}` */
   passwordFor: string;
   /** OpenList cannot tell a wrong password from missing permission. */
   passwordWrong: string;
@@ -88,7 +90,7 @@ interface FileListLabels {
   forgetPassword: string;
   /** Lock button on a folder that needs a password. `{name}` */
   unlockFolder: string;
-  /** Appended to failure toasts for browser network errors (usually CORS). */
+  /** @deprecated Network failures now append `corsHint`. */
   networkHint: string;
 }
 interface FileListSource {
@@ -225,13 +227,13 @@ declare global {
 export declare const fileListLocales: Record<FileListLocale, FileListLabels>;
 export declare function formatLabel(template: string, values?: Record<string, string | number>): string;
 export declare function resolveLabels(locale?: FileListLocale, overrides?: Partial<FileListLabels>): FileListLabels;
-export interface SortableNode {
+interface SortableNode {
   name: string;
   size: number;
   is_dir: boolean;
   modified: string;
 }
-export type SortKey = 'name' | 'size' | 'modified';
+type SortKey = 'name' | 'size' | 'modified';
 export declare function joinPath(parent: string, name: string): string;
 export declare function encodePath(path: string): string;
 /**
@@ -246,24 +248,26 @@ export declare function zipEntryName(segments: string[]): string;
  * The suffix goes before the extension of the last segment. Adds the result to `used`.
  */
 export declare function uniqueEntryName(name: string, used: Set<string>): string;
+/** Human-readable size. `0` reads `0 B`; missing, negative or invalid sizes read `-`. */
 export declare function formatSize(size: number): string;
 export declare function formatDate(iso: string): string;
+/** Upper-case extension for the type badge, e.g. `PDF`. */
 export declare function extOf(name: string): string;
-export type FileKind = 'doc' | 'sheet' | 'slide' | 'pdf' | 'image' | 'media' | 'archive' | 'code' | 'other';
+type FileKind = 'doc' | 'sheet' | 'slide' | 'pdf' | 'image' | 'media' | 'archive' | 'code' | 'other';
+type PreviewKind = 'image' | 'video' | 'audio' | 'text' | 'pdf' | 'none';
 /** Rough file family, used to colour the type badge. */
 export declare function fileKind(name: string): FileKind;
-/** Sum of the `size` of the given entries, ignoring missing or invalid sizes. */
-export declare function totalSize(items: Array<{
-  size?: number;
-}>): number;
-export declare function compareNodes(a: SortableNode, b: SortableNode, key: SortKey, ascending?: boolean): number;
-export type PreviewKind = 'image' | 'video' | 'audio' | 'text' | 'pdf' | 'none';
 /**
  * How a file is shown in the preview dialog. Office documents and anything
  * else the browser cannot render are `none` (info + download).
  */
 export declare function previewKind(name: string): PreviewKind;
-export interface IframePreview {
+/** Sum of the `size` of the given entries, ignoring missing or invalid sizes. */
+export declare function totalSize(items: Array<{
+  size?: number;
+}>): number;
+export declare function compareNodes(a: SortableNode, b: SortableNode, key: SortKey, ascending?: boolean): number;
+interface IframePreview {
   label: string;
   scheme: string;
 }
@@ -300,4 +304,4 @@ export declare function fillPreviewUrl(scheme: string, args: {
  * ```
  */
 export declare function enhanceAppWithFileList({ app }: EnhanceAppContext): void;
-export { _default as FileList, _default as VPFileList, type FileListLabels, type FileListLocale, type FileListProps, type FileListSource, type OpenListEntry };
+export { type FileKind, _default as FileList, _default as VPFileList, type FileListLabels, type FileListLocale, type FileListProps, type FileListSource, type IframePreview, type OpenListEntry, type PreviewKind, type SortKey, type SortableNode };