capacitor-advanced-file-manager
Version:
Advanced file manager plugin for Capacitor with comprehensive file system operations including browse, create, edit, delete, move, copy, and search files and directories.
309 lines (308 loc) • 8.88 kB
TypeScript
export interface FileInfo {
name: string;
path: string;
size: number;
type: 'file' | 'directory';
mtime: number;
ctime: number;
permissions?: string;
isHidden?: boolean;
}
export interface ListDirectoryOptions {
path: string;
showHidden?: boolean;
sortBy?: 'name' | 'size' | 'mtime' | 'type';
sortOrder?: 'asc' | 'desc';
}
export interface ListDirectoryResult {
files: FileInfo[];
totalCount: number;
}
export interface FileOperationOptions {
path: string;
}
export interface CreateFileOptions {
path: string;
content?: string;
encoding?: 'utf8' | 'base64';
}
export interface ReadFileOptions {
path: string;
encoding?: 'utf8' | 'base64';
}
export interface ReadFileResult {
content: string;
encoding: string;
}
export interface WriteFileOptions {
path: string;
content: string;
encoding?: 'utf8' | 'base64';
append?: boolean;
}
export interface MoveFileOptions {
sourcePath: string;
destinationPath: string;
}
export interface CopyFileOptions {
sourcePath: string;
destinationPath: string;
overwrite?: boolean;
}
export interface RenameFileOptions {
path: string;
newName: string;
}
export interface CreateDirectoryOptions {
path: string;
recursive?: boolean;
}
export interface SearchFilesOptions {
directory: string;
query: string;
searchType?: 'name' | 'content' | 'both';
fileTypes?: string[];
maxResults?: number;
recursive?: boolean;
}
export interface SearchFilesResult {
files: FileInfo[];
totalFound: number;
}
/**
* 内容搜索匹配项
*/
export interface ContentMatch {
/** 匹配的行号 (1-based) */
lineNumber: number;
/** 匹配的行内容 */
lineContent: string;
/** 匹配的上下文（带高亮标记位置） */
context: string;
/** 匹配开始位置（在 context 中） */
matchStart: number;
/** 匹配结束位置（在 context 中） */
matchEnd: number;
}
/**
* 单个文件的内容搜索结果
*/
export interface ContentSearchFileResult {
/** 文件路径 */
path: string;
/** 文件名 */
name: string;
/** 匹配类型 */
matchType: 'filename' | 'content' | 'both';
/** 匹配列表 */
matches: ContentMatch[];
/** 相关性评分 */
score: number;
}
/**
* 内容搜索选项
*/
export interface SearchContentOptions {
/** 搜索目录 */
directory: string;
/** 搜索关键词 */
keyword: string;
/** 是否区分大小写 */
caseSensitive?: boolean;
/** 文件扩展名过滤（如 ['.md', '.txt']） */
fileExtensions?: string[];
/** 最大搜索文件数 */
maxFiles?: number;
/** 最大文件大小（字节），超过的文件将被跳过 */
maxFileSize?: number;
/** 每个文件最大匹配数 */
maxMatchesPerFile?: number;
/** 上下文长度（匹配前后的字符数） */
contextLength?: number;
/** 最大递归深度 */
maxDepth?: number;
/** 是否递归搜索子目录 */
recursive?: boolean;
}
/**
* 内容搜索结果
*/
export interface SearchContentResult {
/** 搜索结果列表 */
results: ContentSearchFileResult[];
/** 总匹配文件数 */
totalFiles: number;
/** 总匹配数 */
totalMatches: number;
/** 搜索耗时（毫秒） */
duration: number;
/** 被跳过的文件数（因文件过大等原因） */
skippedFiles: number;
}
export interface ReadFileRangeOptions {
path: string;
/** 起始行号 (1-based) */
startLine: number;
/** 结束行号 (1-based, 包含) */
endLine: number;
/** 编码方式 */
encoding?: 'utf8' | 'base64';
}
export interface ReadFileRangeResult {
/** 读取到的内容 */
content: string;
/** 文件总行数 */
totalLines: number;
/** 实际读取的起始行 */
startLine: number;
/** 实际读取的结束行 */
endLine: number;
/** 内容哈希（用于冲突检测） */
rangeHash: string;
}
export interface InsertContentOptions {
path: string;
/** 插入位置的行号 (1-based)，内容将插入到该行之前 */
line: number;
/** 要插入的内容 */
content: string;
}
export interface ReplaceInFileOptions {
path: string;
/** 要查找的字符串或正则表达式 */
search: string;
/** 替换为的内容 */
replace: string;
/** 是否使用正则表达式 */
isRegex?: boolean;
/** 是否替换所有匹配项 */
replaceAll?: boolean;
/** 是否区分大小写 */
caseSensitive?: boolean;
}
export interface ReplaceInFileResult {
/** 替换的次数 */
replacements: number;
/** 是否有修改 */
modified: boolean;
}
export interface ApplyDiffOptions {
path: string;
/** Unified diff 格式的补丁内容 */
diff: string;
/** 是否创建备份 */
createBackup?: boolean;
}
export interface ApplyDiffResult {
/** 是否成功应用 */
success: boolean;
/** 修改的行数 */
linesChanged: number;
/** 添加的行数 */
linesAdded: number;
/** 删除的行数 */
linesDeleted: number;
/** 备份文件路径（如果创建了备份） */
backupPath?: string;
}
export interface GetFileHashOptions {
path: string;
/** 哈希算法 */
algorithm?: 'md5' | 'sha256';
}
export interface GetFileHashResult {
/** 文件哈希值 */
hash: string;
/** 使用的算法 */
algorithm: string;
}
export interface GetLineCountResult {
/** 文件行数 */
lines: number;
}
export interface PermissionResult {
granted: boolean;
message?: string;
}
export interface SystemFilePickerOptions {
/** 选择类型 */
type: 'file' | 'directory' | 'both';
/** 是否允许多选 */
multiple?: boolean;
/** 文件类型过滤 */
accept?: string[];
/** 起始目录 */
startDirectory?: string;
/** 标题 */
title?: string;
}
export interface SelectedFileInfo {
/** 文件名 */
name: string;
/** 文件路径（可能是真实路径或URI） */
path: string;
/** 原始URI（移动端） */
uri?: string;
/** 文件大小 */
size: number;
/** 文件类型 */
type: 'file' | 'directory';
/** MIME类型 */
mimeType: string;
/** 修改时间 */
mtime: number;
/** 创建时间 */
ctime: number;
}
export interface SystemFilePickerResult {
/** 选择的文件信息列表 */
files: SelectedFileInfo[];
/** 选择的目录信息列表 */
directories: SelectedFileInfo[];
/** 是否被用户取消 */
cancelled: boolean;
}
export interface AdvancedFileManagerPlugin {
requestPermissions(): Promise<PermissionResult>;
checkPermissions(): Promise<PermissionResult>;
openSystemFilePicker(options: SystemFilePickerOptions): Promise<SystemFilePickerResult>;
openSystemFileManager(path?: string): Promise<void>;
openFileWithSystemApp(filePath: string, mimeType?: string): Promise<void>;
listDirectory(options: ListDirectoryOptions): Promise<ListDirectoryResult>;
createDirectory(options: CreateDirectoryOptions): Promise<void>;
deleteDirectory(options: FileOperationOptions): Promise<void>;
createFile(options: CreateFileOptions): Promise<void>;
readFile(options: ReadFileOptions): Promise<ReadFileResult>;
writeFile(options: WriteFileOptions): Promise<void>;
deleteFile(options: FileOperationOptions): Promise<void>;
moveFile(options: MoveFileOptions): Promise<void>;
copyFile(options: CopyFileOptions): Promise<void>;
renameFile(options: RenameFileOptions): Promise<void>;
getFileInfo(options: FileOperationOptions): Promise<FileInfo>;
exists(options: FileOperationOptions): Promise<{
exists: boolean;
}>;
searchFiles(options: SearchFilesOptions): Promise<SearchFilesResult>;
/**
* 原生层内容搜索（避免 OOM）
* 在原生层执行搜索，只返回匹配结果，不返回完整文件内容
*/
searchContent(options: SearchContentOptions): Promise<SearchContentResult>;
/** 读取文件指定行范围 */
readFileRange(options: ReadFileRangeOptions): Promise<ReadFileRangeResult>;
/** 在指定行插入内容 */
insertContent(options: InsertContentOptions): Promise<void>;
/** 查找并替换文件内容 */
replaceInFile(options: ReplaceInFileOptions): Promise<ReplaceInFileResult>;
/** 应用 diff 补丁 */
applyDiff(options: ApplyDiffOptions): Promise<ApplyDiffResult>;
/** 获取文件哈希值 */
getFileHash(options: GetFileHashOptions): Promise<GetFileHashResult>;
/** 获取文件行数 */
getLineCount(options: FileOperationOptions): Promise<GetLineCountResult>;
echo(options: {
value: string;
}): Promise<{
value: string;
}>;
}