vitepress-plugin-filelist 0.4.0 → 0.5.1

package/dist/client/ssr/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;
@@ -70,6 +72,26 @@ interface FileListLabels {
   previewTooLarge: string;
   /** Preview dialog: only the first `{size}` of a text file is shown. */
   textTruncated: string;
+  /** Refresh button while refreshing. */
+  refreshing: string;
+  /** Refresh failed; the old rows stay. `{message}` */
+  refreshFailed: string;
+  cancel: string;
+  /** Accessible name of a folder's password input. `{name}` */
+  passwordFor: string;
+  /** OpenList cannot tell a wrong password from missing permission. */
+  passwordWrong: string;
+  /** A password remembered in this tab no longer works. */
+  passwordStale: string;
+  /** The key toggle next to a password input. */
+  rememberPassword: string;
+  /** Tag on a folder whose password is remembered. */
+  remembered: string;
+  forgetPassword: string;
+  /** Lock button on a folder that needs a password. `{name}` */
+  unlockFolder: string;
+  /** @deprecated Network failures now append `corsHint`. */
+  networkHint: string;
 }
 interface FileListSource {
   /** OpenList path, directory or single file. */
@@ -96,6 +118,11 @@ interface FileListProps {
   password?: string;
   /** Toolbar title. Falls back to `site_title` from `/api/public/settings`. */
   title?: string;
+  /**
+   * Offer to remember folder passwords in this browser tab (sessionStorage,
+   * cleared when the tab closes). Defaults to `true`; `false` hides the option.
+   */
+  rememberPassword?: boolean;
   /** Built-in locale. Defaults to `zh-CN`. */
   locale?: FileListLocale;
   /** Per-key label overrides on top of the locale preset. */
@@ -120,6 +147,7 @@ declare const _default: import("vue").DefineComponent<FileListProps, {}, {}, {},
   token: string;
   password: string;
   title: string;
+  rememberPassword: boolean;
   locale: FileListLocale;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare global {
@@ -199,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;
 /**
@@ -220,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;
 }
@@ -274,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 };