react-native-kookit 0.3.5 → 0.3.7

package/FTP_CLIENT_API.md

@@ -1,301 +0,0 @@
-# FTP Client API
-
-This document describes the new FTP Client API that provides an object-oriented approach to FTP operations.
-
-## Overview
-
-The new FTP API allows you to create multiple FTP client instances, each maintaining its own connection and state. This is more flexible than the previous global FTP functions.
-
-## Basic Usage
-
-### Creating an FTP Client
-
-```typescript
-import { FtpClient } from "react-native-kookit";
-
-// Method 1: Using static create method (recommended)
-const ftpClient = await FtpClient.create("my-client-id");
-
-// Method 2: Manual initialization
-const ftpClient = new FtpClient("my-client-id");
-await ftpClient.initialize();
-```
-
-### Setting up Event Handlers
-
-```typescript
-ftpClient.setEventHandlers({
-  onProgress: (progress) => {
-    console.log(`Progress: ${progress.percentage}%`);
-    console.log(`Transferred: ${progress.transferred}/${progress.total} bytes`);
-  },
-  onComplete: () => {
-    console.log("Operation completed successfully!");
-  },
-  onError: (error) => {
-    console.error("FTP Error:", error.message);
-  },
-});
-```
-
-### Connecting to FTP Server
-
-```typescript
-await ftpClient.connect({
-  host: "192.168.1.100",
-  port: 21, // optional, defaults to 21
-  username: "your-username",
-  password: "your-password",
-  passive: true, // optional, defaults to true
-  timeout: 30, // optional, defaults to 30 seconds
-});
-```
-
-## FTP Operations
-
-### Directory Operations
-
-```typescript
-// Get current directory
-const currentDir = await ftpClient.getCurrentDirectory();
-console.log("Current directory:", currentDir);
-
-// Change directory
-await ftpClient.changeDirectory("/path/to/directory");
-
-// Create directory
-await ftpClient.createDirectory("/path/to/new-directory");
-
-// List files and directories
-const files = await ftpClient.list(); // List current directory
-const filesInPath = await ftpClient.list("/specific/path"); // List specific path
-
-files.forEach((file) => {
-  console.log(
-    `${file.name} - ${file.isDirectory ? "DIR" : "FILE"} - ${file.size} bytes`
-  );
-});
-```
-
-### File Operations
-
-```typescript
-// Download file
-await ftpClient.download("/remote/path/file.txt", "/local/path/file.txt");
-
-// Upload file
-await ftpClient.upload("/local/path/file.txt", "/remote/path/file.txt");
-
-// Delete file
-await ftpClient.delete("/remote/path/file.txt");
-
-// Delete directory
-await ftpClient.delete("/remote/path/directory", true); // true for directory
-```
-
-### Client Management
-
-```typescript
-// Check client status
-const status = ftpClient.getStatus();
-console.log("Client exists:", status.exists);
-console.log("Client connected:", status.connected);
-
-// Check if connected (convenience method)
-if (ftpClient.isConnected()) {
-  console.log("Client is ready for operations");
-}
-
-// Get client ID
-const clientId = ftpClient.getClientId();
-console.log("Client ID:", clientId);
-
-// Disconnect from server
-await ftpClient.disconnect();
-
-// Dispose client and clean up resources
-await ftpClient.dispose();
-```
-
-## Advanced Usage
-
-### Multiple FTP Clients
-
-```typescript
-import { FtpClient } from "react-native-kookit";
-
-// Create multiple clients for different servers
-const client1 = await FtpClient.create("server1");
-const client2 = await FtpClient.create("server2");
-
-// Connect to different servers
-await client1.connect({
-  host: "ftp1.example.com",
-  username: "user1",
-  password: "pass1",
-});
-
-await client2.connect({
-  host: "ftp2.example.com",
-  username: "user2",
-  password: "pass2",
-});
-
-// Perform operations on different servers simultaneously
-const [files1, files2] = await Promise.all([client1.list(), client2.list()]);
-
-// Clean up
-await Promise.all([client1.dispose(), client2.dispose()]);
-```
-
-### Managing All Clients
-
-```typescript
-// List all active FTP clients
-const clientsInfo = FtpClient.listClients();
-console.log("Active clients:", clientsInfo.count);
-console.log("Clients details:", clientsInfo.clients);
-
-// Example output:
-// {
-//   clients: {
-//     'client-1': { connected: true },
-//     'client-2': { connected: false }
-//   },
-//   count: 2
-// }
-```
-
-### Error Handling
-
-```typescript
-try {
-  const ftpClient = await FtpClient.create();
-
-  await ftpClient.connect({
-    host: "ftp.example.com",
-    username: "user",
-    password: "pass",
-  });
-
-  await ftpClient.download("/remote/file.txt", "/local/file.txt");
-} catch (error) {
-  console.error("FTP operation failed:", error.message);
-} finally {
-  // Always dispose to clean up resources
-  if (ftpClient) {
-    await ftpClient.dispose();
-  }
-}
-```
-
-## API Reference
-
-### FtpClient Class
-
-#### Constructor
-
-- `new FtpClient(clientId?: string)` - Create a new FTP client instance
-
-#### Static Methods
-
-- `FtpClient.create(clientId?: string): Promise<FtpClient>` - Create and initialize a new FTP client
-- `FtpClient.listClients()` - Get information about all active FTP clients
-
-#### Instance Methods
-
-**Lifecycle:**
-
-- `initialize(): Promise<void>` - Initialize the client (called automatically by `create()`)
-- `dispose(): Promise<void>` - Dispose client and clean up resources
-
-**Connection:**
-
-- `connect(config: FtpConnectionConfig): Promise<void>` - Connect to FTP server
-- `disconnect(): Promise<void>` - Disconnect from FTP server
-- `isConnected(): boolean` - Check if client is connected
-
-**Directory Operations:**
-
-- `list(path?: string): Promise<FtpFileInfo[]>` - List files and directories
-- `getCurrentDirectory(): Promise<string>` - Get current working directory
-- `changeDirectory(path: string): Promise<void>` - Change working directory
-- `createDirectory(path: string): Promise<void>` - Create a directory
-
-**File Operations:**
-
-- `download(remotePath: string, localPath: string): Promise<void>` - Download a file
-- `upload(localPath: string, remotePath: string): Promise<void>` - Upload a file
-- `delete(remotePath: string, isDirectory?: boolean): Promise<void>` - Delete a file or directory
-
-**Utility:**
-
-- `getStatus()` - Get client status information
-- `getClientId(): string` - Get the client ID
-- `setEventHandlers(handlers: FtpClientEventHandlers): void` - Set event handlers
-
-### Types
-
-```typescript
-interface FtpConnectionConfig {
-  host: string;
-  port?: number;
-  username: string;
-  password: string;
-  passive?: boolean;
-  timeout?: number;
-}
-
-interface FtpFileInfo {
-  name: string;
-  isDirectory: boolean;
-  size: number;
-  lastModified: string;
-  permissions?: string;
-}
-
-interface FtpClientEventHandlers {
-  onProgress?: (progress: {
-    transferred: number;
-    total: number;
-    percentage: number;
-  }) => void;
-  onComplete?: () => void;
-  onError?: (error: Error) => void;
-}
-```
-
-## Migration from Old API
-
-If you're migrating from the old global FTP functions, here's how to update your code:
-
-### Old API:
-
-```typescript
-import ReactNativeKookitModule from "react-native-kookit";
-
-await ReactNativeKookitModule.ftpConnect(config);
-const files = await ReactNativeKookitModule.ftpList();
-await ReactNativeKookitModule.ftpDownload(remotePath, localPath);
-await ReactNativeKookitModule.ftpDisconnect();
-```
-
-### New API:
-
-```typescript
-import { FtpClient } from "react-native-kookit";
-
-const ftpClient = await FtpClient.create();
-await ftpClient.connect(config);
-const files = await ftpClient.list();
-await ftpClient.download(remotePath, localPath);
-await ftpClient.dispose(); // This disconnects and cleans up
-```
-
-## Best Practices
-
-1. **Always dispose clients**: Call `dispose()` when you're done to clean up resources
-2. **Use try-finally blocks**: Ensure disposal happens even if operations fail
-3. **Handle events**: Set up progress, completion, and error handlers for better UX
-4. **Use meaningful client IDs**: This helps with debugging and client management
-5. **Check connection status**: Use `isConnected()` before performing operations

package/FTP_FILE_LIST_ENHANCEMENT.md

@@ -1,186 +0,0 @@
-# FTP 文件列表功能增强
-
-本文档描述了对 FTP 客户端示例应用中文件列表功能的增强。
-
-## 新增功能
-
-### 🗂️ 增强的文件列表显示
-
-**文件信息显示：**
-
-- 📁 文件夹图标 / 📄 文件图标
-- 文件/文件夹名称
-- 文件大小（字节）
-- 最后修改时间
-- 文件权限信息
-
-**交互功能：**
-
-- 点击文件夹：直接进入该文件夹
-- 点击文件：显示文件操作菜单
-- 点击菜单按钮(⋮)：显示详细操作选项
-
-### 📂 目录导航功能
-
-**导航按钮：**
-
-- **Refresh（刷新）**: 重新加载当前目录的文件列表
-- **Up（向上）**: 返回父目录
-- **Root（根目录）**: 直接跳转到根目录
-- **New Folder（新建文件夹）**: 创建新文件夹
-
-**当前路径显示：**
-
-- 实时显示当前所在的目录路径
-- 便于用户了解当前位置
-
-### 📄 文件操作菜单
-
-**对于文件：**
-
-- **Download（下载）**: 下载文件到本地临时目录
-- **Delete（删除）**: 删除远程服务器上的文件
-- **Cancel（取消）**: 关闭操作菜单
-
-**对于文件夹：**
-
-- **Open Directory（打开目录）**: 进入该文件夹
-- **Delete（删除）**: 删除整个文件夹及其内容
-- **Cancel（取消）**: 关闭操作菜单
-
-### 📁 新建文件夹功能
-
-**操作流程：**
-
-1. 点击 "New Folder" 按钮
-2. 在弹出的对话框中输入文件夹名称
-3. 点击 "Create" 创建文件夹
-4. 自动刷新文件列表显示新创建的文件夹
-
-### 🔒 安全确认
-
-**删除确认：**
-
-- 删除任何文件或文件夹前都会弹出确认对话框
-- 防止误删除重要数据
-- 显示将要删除的项目名称
-
-## 用户界面改进
-
-### 📱 响应式设计
-
-**文件列表项：**
-
-- 更大的点击区域，便于触摸操作
-- 清晰的视觉层次，信息一目了然
-- 文件夹和文件使用不同的颜色和样式区分
-
-**模态对话框：**
-
-- 半透明背景，专注于当前操作
-- 居中显示，适合各种屏幕尺寸
-- 清晰的按钮布局，操作直观
-
-### 🎨 视觉优化
-
-**图标系统：**
-
-- 📁 文件夹图标：蓝色文本，便于识别
-- 📄 文件图标：常规颜色
-- ⋮ 菜单图标：灰色，表示更多操作
-
-**信息层次：**
-
-- 文件名：主要信息，字体较大
-- 文件大小：次要信息，字体中等
-- 修改时间：辅助信息，字体较小，灰色
-
-## 操作流程示例
-
-### 典型文件浏览流程
-
-1. **连接 FTP 服务器**
-
-   ```
-   创建客户端 → 输入连接信息 → 点击连接
-   ```
-
-2. **浏览文件**
-
-   ```
-   查看文件列表 → 点击文件夹进入 → 查看文件详情
-   ```
-
-3. **文件操作**
-
-   ```
-   选择文件 → 选择操作（下载/删除） → 确认操作
-   ```
-
-4. **目录管理**
-   ```
-   新建文件夹 → 输入名称 → 创建 → 查看结果
-   ```
-
-### 下载文件示例
-
-```typescript
-// 用户点击文件 → 选择下载 → 自动执行下载
-const downloadFile = async (file: any) => {
-  const localPath = `/tmp/${file.name}`;
-  await ftpClient.download(file.name, localPath);
-  // 显示成功消息和本地路径
-};
-```
-
-### 创建文件夹示例
-
-```typescript
-// 用户输入文件夹名 → 点击创建 → 自动刷新列表
-const createFolder = async () => {
-  await ftpClient.createDirectory(newFolderName);
-  await listFiles(); // 刷新文件列表
-};
-```
-
-## 错误处理
-
-### 网络错误
-
-- 连接超时：显示友好的错误消息
-- 认证失败：提示检查用户名和密码
-- 权限不足：显示权限相关的错误信息
-
-### 文件操作错误
-
-- 下载失败：显示具体的失败原因
-- 删除失败：可能是权限问题或文件正在使用
-- 创建文件夹失败：可能是名称冲突或权限不足
-
-### 用户输入错误
-
-- 空文件夹名：禁用创建按钮
-- 无效字符：提示输入有效的文件夹名称
-
-## 技术实现要点
-
-### 状态管理
-
-- `files`: 当前目录的文件列表
-- `selectedFile`: 当前选中的文件
-- `showFileModal`: 文件操作模态框显示状态
-- `showCreateFolder`: 创建文件夹模态框显示状态
-
-### 事件处理
-
-- 文件点击：区分文件和文件夹的不同处理逻辑
-- 模态框管理：正确的显示和隐藏逻辑
-- 异步操作：proper async/await 处理和错误捕获
-
-### 用户体验优化
-
-- 操作反馈：每个操作都有相应的日志记录
-- 进度显示：下载和上传操作显示进度
-- 状态保持：操作完成后自动刷新相关状态
-
-这些增强功能使得 FTP 客户端示例应用更加实用和用户友好，提供了完整的文件管理体验。