zen-fs-webdav 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,278 @@
+/**
+ * WebDAV 文件系统配置选项
+ */
+interface WebDAVOptions {
+    /**
+     * WebDAV 服务器的基础 URL
+     */
+    baseUrl: string;
+    /**
+     * 认证用户名（可选）
+     */
+    username?: string;
+    /**
+     * 认证密码（可选）
+     */
+    password?: string;
+    /**
+     * 认证令牌（可选，如果提供则优先使用）
+     */
+    token?: string;
+    /**
+     * 自定义请求头（可选）
+     */
+    headers?: Record<string, string>;
+    /**
+     * 请求超时时间，单位毫秒（可选，默认 30000）
+     */
+    timeout?: number;
+}
+/**
+ * WebDAV 请求选项
+ */
+interface WebDAVRequestOptions {
+    /**
+     * 请求方法
+     */
+    method: string;
+    /**
+     * 请求头
+     */
+    headers?: Record<string, string>;
+    /**
+     * 请求体
+     */
+    body?: string | ArrayBuffer | null;
+    /**
+     * 请求超时时间，单位毫秒
+     */
+    timeout?: number;
+}
+/**
+ * 文件或目录条目
+ */
+interface FileEntry {
+    /**
+     * 文件或目录名称
+     */
+    name: string;
+    /**
+     * 是否为目录
+     */
+    isDirectory: boolean;
+    /**
+     * 文件大小（字节）
+     */
+    size?: number;
+    /**
+     * 最后修改时间
+     */
+    lastModified?: Date;
+    /**
+     * 创建时间
+     */
+    createdAt?: Date;
+    /**
+     * 文件或目录的完整路径
+     */
+    path: string;
+}
+/**
+ * 文件或目录统计信息
+ */
+interface Stats {
+    /**
+     * 是否为目录
+     */
+    isDirectory: boolean;
+    /**
+     * 是否为文件
+     */
+    isFile: boolean;
+    /**
+     * 文件大小（字节）
+     */
+    size: number;
+    /**
+     * 最后修改时间
+     */
+    lastModified?: Date;
+    /**
+     * 创建时间
+     */
+    createdAt?: Date;
+    /**
+     * 文件或目录名称
+     */
+    name: string;
+    /**
+     * 文件或目录的完整路径
+     */
+    path: string;
+    /**
+     * 文件的 MIME 类型
+     */
+    mimeType?: string;
+    /**
+     * 文件的 ETag
+     */
+    etag?: string;
+}
+/**
+ * 读取文件选项
+ */
+interface ReadFileOptions {
+    /**
+     * 响应类型
+     */
+    responseType?: 'text' | 'arraybuffer';
+    /**
+     * 编码（仅当 responseType 为 'text' 时有效）
+     */
+    encoding?: string;
+    headers?: Record<string, string>;
+}
+/**
+ * 写入文件选项
+ */
+interface WriteFileOptions {
+    /**
+     * 是否覆盖现有文件
+     */
+    overwrite?: boolean;
+    /**
+     * 文件的 MIME 类型
+     */
+    contentType?: string;
+}
+/**
+ * 创建目录选项
+ */
+interface MkdirOptions {
+    /**
+     * 是否递归创建目录
+     */
+    recursive?: boolean;
+}
+/**
+ * 删除目录选项
+ */
+interface RmdirOptions {
+    /**
+     * 是否递归删除目录及其内容
+     */
+    recursive?: boolean;
+}
+/**
+ * 读取目录选项
+ */
+interface ReaddirOptions {
+    /**
+     * 是否包含详细信息
+     */
+    withFileTypes?: boolean;
+    /**
+     * 深度，1 表示只列出当前目录，大于 1 表示递归列出子目录
+     */
+    depth?: number;
+    includeHidden?: boolean;
+    headers?: Record<string, string>;
+    recursive?: boolean;
+}
+/**
+ * 复制选项
+ */
+interface CopyOptions {
+    /**
+     * 是否覆盖目标位置的现有文件
+     */
+    overwrite?: boolean;
+    /**
+     * 是否递归复制目录
+     */
+    recursive?: boolean;
+}
+/**
+ * 移动选项
+ */
+interface MoveOptions {
+    /**
+     * 是否覆盖目标位置的现有文件
+     */
+    overwrite?: boolean;
+}
+/**
+ * WebDAV操作结果
+ */
+interface WebDAVResult {
+    /**
+     * 操作是否成功
+     */
+    success: boolean;
+    /**
+     * HTTP状态码
+     */
+    statusCode: number;
+    /**
+     * 操作结果消息（可选）
+     */
+    message?: string;
+    /**
+     * 操作返回的数据（可选）
+     */
+    data?: unknown;
+}
+
+interface WebDAVFileSystem {
+    readFile(path: string, options?: ReadFileOptions): Promise<Buffer | string>;
+    writeFile(path: string, data: Buffer | string, options?: WriteFileOptions): Promise<WebDAVResult>;
+    deleteFile(path: string): Promise<WebDAVResult>;
+    readDir(path: string, options?: ReaddirOptions): Promise<Stats[]>;
+    mkdir(path: string, options?: MkdirOptions): Promise<void>;
+    rm(path: string, options?: {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    rmdir(path: string, options?: boolean | {
+        recursive?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    stat(path: string): Promise<Stats>;
+    exists(path: string): Promise<boolean>;
+    copy(source: string, destination: string, overwrite?: boolean): Promise<WebDAVResult>;
+    move(source: string, destination: string, overwrite?: boolean): Promise<WebDAVResult>;
+    unlink(path: string): Promise<void>;
+}
+
+/**
+ * 创建 WebDAV 文件系统实例（工厂函数）
+ * @param options WebDAV 配置选项
+ * @returns WebDAVFileSystem 实例
+ */
+declare function createWebDAVFileSystem(options: WebDAVOptions): WebDAVFileSystem;
+
+/**
+ * WebDAV文件系统库的错误类型定义
+ */
+/**
+ * WebDAV错误基类
+ */
+declare class WebDAVError extends Error {
+    /**
+     * HTTP状态码
+     */
+    status?: number;
+    /**
+     * 原始错误对象（如果有）
+     */
+    cause?: unknown;
+    constructor(message: string, status?: number, cause?: unknown);
+    toString(): string;
+    static fromResponse(response: {
+        status: number;
+        statusText: string;
+    }, message?: string): WebDAVError;
+    static fromError(error: unknown): WebDAVError;
+}
+
+export { type CopyOptions, type FileEntry, type MkdirOptions, type MoveOptions, type ReadFileOptions, type ReaddirOptions, type RmdirOptions, type Stats, WebDAVError, type WebDAVFileSystem, type WebDAVOptions, type WebDAVRequestOptions, type WriteFileOptions, createWebDAVFileSystem };