vitepress-plugin-filelist 0.3.1 → 0.5.0

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

@@ -32,6 +32,7 @@ interface FileListLabels {
   demoPreview: string;
   demoBatch: string;
   downloadFailed: string;
+  /** @deprecated Preview errors are shown in the dialog (`previewUnavailable`). */
   previewFailed: string;
   batchFailed: string;
   defaultZip: string;
@@ -52,6 +53,43 @@ interface FileListLabels {
   expand: string;
   /** Accessible name of the collapse button, `{name}`. */
   collapse: string;
+  /** Preview dialog: close button. */
+  close: string;
+  /** Preview dialog: previous / next previewable file. */
+  previous: string;
+  next: string;
+  /** Preview dialog: rotate image by 90°. */
+  rotate: string;
+  /** Preview dialog: toggle the image between fit-to-window and actual size. */
+  actualSize: string;
+  /** Preview dialog: file type that is not previewed (Office and others). */
+  previewUnsupported: string;
+  /** Preview dialog: preview failed (network, CORS, unsupported codec). */
+  previewUnavailable: string;
+  /** Preview dialog: PDF larger than the in-page limit, `{size}`. */
+  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;
+  /** Placeholder / 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;
+  /** Appended to failure toasts for browser network errors (usually CORS). */
+  networkHint: string;
 }
 interface FileListSource {
   /** OpenList path, directory or single file. */
@@ -78,6 +116,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. */
@@ -102,6 +145,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 {
@@ -213,6 +257,32 @@ 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 {
+  label: string;
+  scheme: string;
+}
+/**
+ * Viewers from OpenList's public `iframe_previews` setting that match a file,
+ * in the order OpenList lists them. Keys are comma-separated extensions or a
+ * `/regex/flags` tested against the extension, as in OpenList's frontend.
+ */
+export declare function iframePreviewsFor(name: string, setting: string | undefined): IframePreview[];
+/**
+ * Fill an OpenList preview scheme: `$name`, `$url` (raw URL) and `$durl`
+ * (signed download URL), each optionally prefixed with `e` (URI-encode) or
+ * `b` (base64), e.g. `$e_url`, `$b_url`, `$e_durl`.
+ */
+export declare function fillPreviewUrl(scheme: string, args: {
+  name: string;
+  rawUrl: string;
+  downloadUrl: string;
+}): string;
 /**
  * Register `<FileList>` and `<VPFileList>` globally.
  *