react-native-kookit 0.3.5 → 0.3.6

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 客户端示例应用更加实用和用户友好，提供了完整的文件管理体验。

package/FTP_README.md

@@ -1,322 +0,0 @@
-# React Native Kookit - FTP Client
-
-A React Native Expo module that provides volume key interception and FTP client functionality for iOS and Android.
-
-## Features
-
-### Volume Key Interception
-
-- Intercept volume up/down button presses
-- Works on both iOS and Android
-- Prevent default volume behavior (optional)
-
-### FTP Client
-
-- Connect to FTP servers
-- List files and directories
-- Download files from FTP server
-- Upload files to FTP server
-- Delete files and directories
-- Create directories
-- Navigate directories
-- Progress monitoring for uploads/downloads
-
-## Installation
-
-```bash
-npm install react-native-kookit
-```
-
-### iOS Setup
-
-For iOS, no additional setup is required. The module works out of the box.
-
-### Android Setup
-
-For Android, your MainActivity must implement the `VolumeKeyInterceptActivity` interface:
-
-```kotlin
-import expo.modules.kookit.VolumeKeyInterceptActivity
-
-class MainActivity : ReactActivity(), VolumeKeyInterceptActivity {
-    // ... existing code ...
-}
-```
-
-## Usage
-
-### Basic Import
-
-```typescript
-import ReactNativeKookitModule, {
-  FtpConnectionConfig,
-  FtpFileInfo,
-  FtpProgressInfo,
-} from "react-native-kookit";
-```
-
-### Volume Key Interception
-
-```typescript
-import { useEffect } from "react";
-
-useEffect(() => {
-  // Set up volume key listener
-  const subscription = ReactNativeKookitModule.addListener(
-    "onVolumeButtonPressed",
-    (event) => {
-      console.log("Volume button pressed:", event.key); // 'up' or 'down'
-    }
-  );
-
-  // Enable volume key interception
-  ReactNativeKookitModule.enableVolumeKeyInterception();
-
-  return () => {
-    // Clean up
-    ReactNativeKookitModule.disableVolumeKeyInterception();
-    subscription.remove();
-  };
-}, []);
-```
-
-### FTP Client Usage
-
-#### 1. Connect to FTP Server
-
-```typescript
-const config: FtpConnectionConfig = {
-  host: "ftp.example.com",
-  port: 21, // optional, defaults to 21
-  username: "your-username",
-  password: "your-password",
-  passive: true, // optional, defaults to true
-  timeout: 30000, // optional, defaults to 30000ms
-};
-
-try {
-  await ReactNativeKookitModule.ftpConnect(config);
-  console.log("Connected to FTP server");
-} catch (error) {
-  console.error("Failed to connect:", error);
-}
-```
-
-#### 2. List Files and Directories
-
-```typescript
-try {
-  const files: FtpFileInfo[] = await ReactNativeKookitModule.ftpList();
-  files.forEach((file) => {
-    console.log(
-      `${file.isDirectory ? "DIR" : "FILE"}: ${file.name} (${file.size} bytes)`
-    );
-  });
-} catch (error) {
-  console.error("Failed to list files:", error);
-}
-```
-
-#### 3. Download Files
-
-```typescript
-try {
-  const remotePath = "remote-file.txt";
-  const localPath = "/path/to/local/file.txt";
-
-  await ReactNativeKookitModule.ftpDownload(remotePath, localPath);
-  console.log("File downloaded successfully");
-} catch (error) {
-  console.error("Download failed:", error);
-}
-```
-
-#### 4. Upload Files
-
-```typescript
-try {
-  const localPath = "/path/to/local/file.txt";
-  const remotePath = "remote-file.txt";
-
-  await ReactNativeKookitModule.ftpUpload(localPath, remotePath);
-  console.log("File uploaded successfully");
-} catch (error) {
-  console.error("Upload failed:", error);
-}
-```
-
-#### 5. Progress Monitoring
-
-```typescript
-useEffect(() => {
-  const progressListener = ReactNativeKookitModule.addListener(
-    "onFtpProgress",
-    (progress: FtpProgressInfo) => {
-      console.log(
-        `Progress: ${progress.percentage}% (${progress.transferred}/${progress.total} bytes)`
-      );
-    }
-  );
-
-  const completeListener = ReactNativeKookitModule.addListener(
-    "onFtpComplete",
-    () => {
-      console.log("Operation completed");
-    }
-  );
-
-  const errorListener = ReactNativeKookitModule.addListener(
-    "onFtpError",
-    (error) => {
-      console.error("FTP Error:", error.error);
-    }
-  );
-
-  return () => {
-    progressListener.remove();
-    completeListener.remove();
-    errorListener.remove();
-  };
-}, []);
-```
-
-#### 6. Directory Operations
-
-```typescript
-// Create directory
-await ReactNativeKookitModule.ftpCreateDirectory("new-directory");
-
-// Change directory
-await ReactNativeKookitModule.ftpChangeDirectory("some-directory");
-
-// Get current directory
-const currentDir = await ReactNativeKookitModule.ftpGetCurrentDirectory();
-console.log("Current directory:", currentDir);
-
-// Delete file or directory
-await ReactNativeKookitModule.ftpDelete("file.txt", false); // false for file
-await ReactNativeKookitModule.ftpDelete("directory", true); // true for directory
-```
-
-#### 7. Disconnect
-
-```typescript
-try {
-  await ReactNativeKookitModule.ftpDisconnect();
-  console.log("Disconnected from FTP server");
-} catch (error) {
-  console.error("Failed to disconnect:", error);
-}
-```
-
-## API Reference
-
-### 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 FtpProgressInfo {
-  transferred: number;
-  total: number;
-  percentage: number;
-}
-```
-
-### Methods
-
-#### Volume Key Methods
-
-- `enableVolumeKeyInterception()`: Enable volume key interception
-- `disableVolumeKeyInterception()`: Disable volume key interception
-
-#### FTP Methods
-
-- `ftpConnect(config: FtpConnectionConfig): Promise<void>`
-- `ftpDisconnect(): Promise<void>`
-- `ftpList(path?: string): Promise<FtpFileInfo[]>`
-- `ftpDownload(remotePath: string, localPath: string): Promise<void>`
-- `ftpUpload(localPath: string, remotePath: string): Promise<void>`
-- `ftpDelete(remotePath: string, isDirectory?: boolean): Promise<void>`
-- `ftpCreateDirectory(remotePath: string): Promise<void>`
-- `ftpChangeDirectory(remotePath: string): Promise<void>`
-- `ftpGetCurrentDirectory(): Promise<string>`
-
-### Events
-
-#### Volume Key Events
-
-- `onVolumeButtonPressed`: Fired when volume button is pressed
-  ```typescript
-  {
-    key: "up" | "down";
-  }
-  ```
-
-#### FTP Events
-
-- `onFtpProgress`: Fired during file transfer operations
-
-  ```typescript
-  { transferred: number, total: number, percentage: number }
-  ```
-
-- `onFtpComplete`: Fired when an operation completes successfully
-
-- `onFtpError`: Fired when an error occurs
-  ```typescript
-  {
-    error: string;
-  }
-  ```
-
-## Platform Support
-
-- ✅ iOS 15.1+
-- ✅ Android API 21+
-- ❌ Web (FTP operations are not supported due to browser security restrictions)
-
-## Example
-
-See the [FtpExample.tsx](./example/FtpExample.tsx) file for a complete working example.
-
-## Security Considerations
-
-- FTP credentials are transmitted in plain text. Use FTPS or SFTP for secure file transfers when possible.
-- Ensure proper file path validation to prevent directory traversal attacks.
-- Consider implementing connection pooling and timeout handling for production use.
-
-## Troubleshooting
-
-### Android
-
-- Make sure your MainActivity implements `VolumeKeyInterceptActivity`
-- Check that you have INTERNET permission in your AndroidManifest.xml
-
-### iOS
-
-- Ensure your app has network permissions
-- For file operations, make sure your app has appropriate file system permissions
-
-## Contributing
-
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-
-## License
-
-MIT

package/README_NEW.md

@@ -1,143 +0,0 @@
-# React Native Kookit - 零配置音量键拦截
-
-🎉 **现在支持零配置安装！** 使用 Expo 插件自动处理所有原生代码修改。
-
-## 快速开始
-
-### 方法一：自动安装（推荐 - Expo 项目）
-
-```bash
-# 1. 安装
-npm install react-native-kookit
-
-# 2. 添加到 app.json
-{
-  "expo": {
-    "plugins": ["react-native-kookit"]
-  }
-}
-
-# 3. 预构建
-npx expo prebuild --clean
-
-# 4. 运行
-npx expo run:android
-```
-
-### 方法二：手动安装（React Native CLI 项目）
-
-如果不使用 Expo，请按照 [ANDROID_SETUP.md](./ANDROID_SETUP.md) 手动修改 MainActivity。
-
-## 使用示例
-
-```javascript
-import React, { useEffect } from "react";
-import { View, Text, Alert } from "react-native";
-import ReactNativeKookit from "react-native-kookit";
-
-export default function App() {
-  useEffect(() => {
-    // 添加音量键监听器
-    const subscription = ReactNativeKookit.addListener(
-      "onVolumeButtonPressed",
-      (event) => {
-        Alert.alert(
-          "音量键按下",
-          `按下了${event.key === "up" ? "音量+" : "音量-"}键`,
-          [{ text: "确定" }]
-        );
-      }
-    );
-
-    // 启用音量键拦截
-    ReactNativeKookit.enableVolumeKeyInterception();
-
-    // 清理函数
-    return () => {
-      subscription.remove();
-      ReactNativeKookit.disableVolumeKeyInterception();
-    };
-  }, []);
-
-  return (
-    <View style={{ flex: 1, justifyContent: "center", alignItems: "center" }}>
-      <Text style={{ fontSize: 18, textAlign: "center", margin: 20 }}>
-        音量键拦截已启用{"\n"}
-        请按音量键测试功能
-      </Text>
-    </View>
-  );
-}
-```
-
-## API 文档
-
-### `enableVolumeKeyInterception()`
-
-启用音量键拦截功能。
-
-### `disableVolumeKeyInterception()`
-
-禁用音量键拦截功能。
-
-### `addListener(eventName, callback)`
-
-添加事件监听器。
-
-**参数：**
-
-- `eventName`: `'onVolumeButtonPressed'`
-- `callback`: `(event: {key: 'up' | 'down'}) => void`
-
-**返回：** 订阅对象，调用 `.remove()` 方法可取消监听。
-
-## 功能特性
-
-- ✅ **零配置**：Expo 插件自动修改原生代码
-- ✅ **跨平台**：支持 iOS 和 Android
-- ✅ **高性能**：原生实现，无性能损耗
-- ✅ **类型安全**：完整 TypeScript 支持
-- ✅ **兼容性强**：支持新架构和旧架构
-
-## 支持的平台
-
-- iOS 9.0+
-- Android API 21+
-- Expo SDK 49+
-- React Native 0.70+
-
-## 常见问题
-
-### Q: 为什么需要 `npx expo prebuild --clean`？
-
-A: 插件需要修改原生 Android 代码，prebuild 会应用所有插件修改。
-
-### Q: 遇到 "Plugin is an unexpected type: undefined" 错误怎么办？
-
-A:
-
-1. 确保已正确安装：`npm install react-native-kookit`
-2. 清理重装：`rm -rf node_modules && npm install`
-3. 重新预构建：`npx expo prebuild --clean`
-
-详细故障排除请查看 [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
-
-### Q: 音量键无响应怎么办？
-
-A:
-
-1. 确认已调用 `enableVolumeKeyInterception()`
-2. 检查是否正确添加了事件监听器
-3. 在 Android 上确认 MainActivity 已被正确修改
-
-### Q: 支持 React Native CLI 项目吗？
-
-A: 支持，但需要手动修改 MainActivity，请参考 [ANDROID_SETUP.md](./ANDROID_SETUP.md)。
-
-### Q: 会影响系统音量调节吗？
-
-A: 当启用拦截时，会阻止系统音量调节。禁用拦截后恢复正常。
-
-## License
-
-MIT © [troyeguo](https://github.com/troyeguo)