react-native-kookit 0.3.5 → 0.3.6

package/ANDROID_SMB_LISTSHARES_FIX.md

@@ -1,100 +0,0 @@
-# Android SMB listShares() 修复说明
-
-## 问题描述
-
-Android构建失败，错误信息：
-
-```
-e: Unresolved reference 'listShares'
-e: Unresolved reference 'name'
-```
-
-## 根本原因
-
-在Android SmbClient.kt中，我尝试使用了SMBJ库中不存在的API：
-
-```kotlin
-s.listShares().map { it.name }  // ❌ SMBJ Session没有listShares()方法
-```
-
-## 解决方案
-
-由于SMBJ库不提供直接的share枚举API，我实现了一个实用的替代方案：
-
-```kotlin
-@Synchronized
-fun listShares(): List<String> {
-    val s = session ?: throw IOException("Not authenticated")
-    return try {
-        // SMBJ doesn't provide direct share enumeration API
-        // We implement a practical approach by testing common share names
-        val availableShares = mutableListOf<String>()
-
-        // Common Windows shares
-        val windowsShares = listOf("C$", "D$", "E$", "ADMIN$", "IPC$")
-        // Common user-defined shares
-        val commonShares = listOf("shared", "public", "data", "home", "Users", "files", "documents", "media")
-
-        val allTestShares = windowsShares + commonShares
-
-        for (shareName in allTestShares) {
-            try {
-                // Try to connect briefly to test if share exists
-                val testShare = s.connectShare(shareName)
-                testShare.close()
-                availableShares.add(shareName)
-            } catch (e: Exception) {
-                // Share doesn't exist, access denied, or other error - ignore
-            }
-        }
-
-        // If no shares found, suggest some common ones
-        if (availableShares.isEmpty()) {
-            return listOf("C$", "shared", "public")
-        }
-
-        availableShares
-    } catch (e: Exception) {
-        // Fallback to common share names if enumeration fails
-        listOf("C$", "shared", "public", "data")
-    }
-}
-```
-
-## 实现逻辑
-
-1. **测试常见shares**: 尝试连接到常见的Windows系统shares（C$、D$等）和用户定义的shares（shared、public等）
-
-2. **快速连接测试**: 对每个share进行快速连接测试，如果成功则添加到可用列表
-
-3. **优雅降级**: 如果无法枚举任何share，返回常见的share名称作为建议
-
-4. **错误处理**: 如果整个过程失败，返回基本的备用列表
-
-## 优势
-
-- ✅ **兼容性**: 适用于SMBJ库的限制
-- ✅ **实用性**: 能发现大多数常见的SMB shares
-- ✅ **健壮性**: 有多层备用机制
-- ✅ **性能**: 只测试常见shares，避免大量无效尝试
-
-## 限制
-
-- 无法发现自定义名称的shares（除非在测试列表中）
-- 依赖于连接测试，可能受权限限制影响
-- 不如真正的RPC share枚举完整
-
-## 构建验证
-
-修复后Android构建成功：
-
-```bash
-./gradlew app:assembleDebug -x lint -x test
-BUILD SUCCESSFUL in 10s
-```
-
-## 相关文件
-
-- `android/src/main/java/expo/modules/kookit/SmbClient.kt` - 修复的Android实现
-- `ios/ReactNativeKookitModule.swift` - iOS使用SMBClient库的真正listShares API
-- `src/SmbClient.ts` - TypeScript接口保持不变

package/API_UNIFICATION.md

@@ -1,180 +0,0 @@
-# iOS与Android API接口统一更新
-
-本文档记录了为统一iOS和Android FTP客户端API接口命名所做的更改。
-
-## 问题描述
-
-之前iOS和Android的FTP API方法命名不一致：
-
-### 修改前的命名差异
-
-| 功能           | iOS方法名                   | Android方法名                  |
-| -------------- | --------------------------- | ------------------------------ |
-| 连接           | `ftpConnect`                | `ftpClientConnect`             |
-| 断开连接       | `ftpDisconnect`             | `ftpClientDisconnect`          |
-| 文件列表       | `ftpList`                   | `ftpClientList`                |
-| 下载文件       | `ftpDownload`               | `ftpClientDownload`            |
-| 上传文件       | `ftpUpload`                 | `ftpClientUpload`              |
-| 删除文件       | `ftpDelete`                 | `ftpClientDelete`              |
-| 创建目录       | `ftpCreateDirectory`        | `ftpClientCreateDirectory`     |
-| 切换目录       | `ftpChangeDirectory`        | `ftpClientChangeDirectory`     |
-| 获取当前目录   | `ftpGetCurrentDirectory`    | `ftpClientGetCurrentDirectory` |
-| 获取客户端状态 | `getFtpClientStatus` (同步) | `getFtpClientStatus` (异步)    |
-| 列出所有客户端 | `listFtpClients` (同步)     | `listFtpClients` (异步)        |
-
-## 解决方案
-
-统一使用`ftpClient*`命名模式，并确保所有方法都是异步的。
-
-### 修改后的统一命名
-
-| 功能           | 统一方法名                     | 参数                                                            |
-| -------------- | ------------------------------ | --------------------------------------------------------------- |
-| 创建客户端     | `createFtpClient`              | `(clientId: String)`                                            |
-| 释放客户端     | `disposeFtpClient`             | `(clientId: String)`                                            |
-| 连接           | `ftpClientConnect`             | `(clientId: String, config: Object)`                            |
-| 断开连接       | `ftpClientDisconnect`          | `(clientId: String)`                                            |
-| 文件列表       | `ftpClientList`                | `(clientId: String, path?: String)`                             |
-| 下载文件       | `ftpClientDownload`            | `(clientId: String, remotePath: String, localPath: String)`     |
-| 上传文件       | `ftpClientUpload`              | `(clientId: String, localPath: String, remotePath: String)`     |
-| 删除文件       | `ftpClientDelete`              | `(clientId: String, remotePath: String, isDirectory?: Boolean)` |
-| 创建目录       | `ftpClientCreateDirectory`     | `(clientId: String, remotePath: String)`                        |
-| 切换目录       | `ftpClientChangeDirectory`     | `(clientId: String, remotePath: String)`                        |
-| 获取当前目录   | `ftpClientGetCurrentDirectory` | `(clientId: String)`                                            |
-| 获取客户端状态 | `getFtpClientStatus`           | `(clientId: String)`                                            |
-| 列出所有客户端 | `listFtpClients`               | `()`                                                            |
-
-## iOS代码更改详情
-
-### 主要FTP操作方法
-
-```swift
-// 连接
-AsyncFunction("ftpClientConnect") { (clientId: String, config: [String: Any], promise: Promise) in
-
-// 断开连接
-AsyncFunction("ftpClientDisconnect") { (clientId: String, promise: Promise) in
-
-// 文件列表
-AsyncFunction("ftpClientList") { (clientId: String, path: String?, promise: Promise) in
-
-// 下载文件
-AsyncFunction("ftpClientDownload") { (clientId: String, remotePath: String, localPath: String, promise: Promise) in
-
-// 上传文件
-AsyncFunction("ftpClientUpload") { (clientId: String, localPath: String, remotePath: String, promise: Promise) in
-
-// 删除文件
-AsyncFunction("ftpClientDelete") { (clientId: String, remotePath: String, isDirectory: Bool?, promise: Promise) in
-
-// 创建目录
-AsyncFunction("ftpClientCreateDirectory") { (clientId: String, remotePath: String, promise: Promise) in
-
-// 切换目录
-AsyncFunction("ftpClientChangeDirectory") { (clientId: String, remotePath: String, promise: Promise) in
-
-// 获取当前目录
-AsyncFunction("ftpClientGetCurrentDirectory") { (clientId: String, promise: Promise) in
-```
-
-### 客户端管理方法
-
-```swift
-// 获取客户端状态 - 改为异步
-AsyncFunction("getFtpClientStatus") { (clientId: String, promise: Promise) in
-  guard let ftpClient = self.ftpClients[clientId] else {
-    promise.resolve([
-      "exists": false,
-      "connected": false
-    ])
-    return
-  }
-
-  promise.resolve([
-    "exists": true,
-    "connected": ftpClient.isConnected
-  ])
-}
-
-// 列出所有客户端 - 改为异步
-AsyncFunction("listFtpClients") { (promise: Promise) in
-  let clientsInfo = self.ftpClients.mapValues { client in
-    [
-      "connected": client.isConnected
-    ]
-  }
-
-  promise.resolve([
-    "clients": clientsInfo,
-    "count": self.ftpClients.count
-  ])
-}
-```
-
-## 兼容性说明
-
-### 完全统一
-
-现在iOS和Android的API接口完全统一：
-
-- ✅ 方法名称一致
-- ✅ 参数顺序一致
-- ✅ 返回值格式一致
-- ✅ 所有方法都是异步的
-- ✅ 错误处理方式一致
-
-### TypeScript类型定义
-
-TypeScript模块定义(`ReactNativeKookitModule.ts`)已经使用了统一的命名，无需修改。
-
-### FtpClient包装类
-
-`FtpClient.ts`中的方法调用已经更新为使用统一的方法名。
-
-## 影响范围
-
-### 不影响的部分
-
-- TypeScript客户端API保持不变
-- 示例应用代码无需修改
-- 用户使用的高级API (`FtpClient` 类) 保持不变
-
-### 改进的部分
-
-- 跨平台开发时API行为完全一致
-- 调试时方法名称在两个平台上相同
-- 内部native方法调用逻辑统一
-
-## 验证结果
-
-### 构建测试
-
-- ✅ TypeScript编译：0错误
-- ✅ iOS Swift编译：通过
-- ✅ Android Kotlin编译：通过
-
-### API一致性验证
-
-```typescript
-// 现在这些调用在iOS和Android上完全一致
-await ReactNativeKookitModule.createFtpClient(clientId);
-await ReactNativeKookitModule.ftpClientConnect(clientId, config);
-await ReactNativeKookitModule.ftpClientList(clientId, path);
-await ReactNativeKookitModule.ftpClientDownload(
-  clientId,
-  remotePath,
-  localPath
-);
-// ... 所有其他方法
-```
-
-## 总结
-
-通过这次统一更新：
-
-1. **解决了命名不一致问题**：iOS方法名更新为与Android一致
-2. **统一了异步模式**：所有方法都使用AsyncFunction模式
-3. **简化了维护工作**：两个平台使用相同的API接口
-4. **提高了开发体验**：跨平台开发时无需记忆不同的方法名
-
-现在iOS和Android的FTP客户端API完全统一，为开发者提供了一致的跨平台体验。

package/EXPO_PLUGIN_README.md

@@ -1,136 +0,0 @@
-# React Native Kookit - Expo Plugin
-
-这个插件可以自动修改您的 MainActivity 以支持音量键拦截功能，无需手动编写代码。
-
-## 自动安装（推荐）
-
-### 1. 安装模块
-
-```bash
-npm install react-native-kookit
-# 或
-yarn add react-native-kookit
-```
-
-### 2. 配置 Expo 插件
-
-在您的 `app.json` 或 `app.config.js` 中添加插件：
-
-```json
-{
-  "expo": {
-    "plugins": ["react-native-kookit"]
-  }
-}
-```
-
-### 3. 预构建项目
-
-```bash
-npx expo prebuild --clean
-```
-
-### 4. 构建和运行
-
-```bash
-npx expo run:android
-```
-
-就这样！插件会自动修改您的 MainActivity 以支持音量键拦截。
-
-## 使用方法
-
-```javascript
-import ReactNativeKookit from "react-native-kookit";
-
-// 添加监听器
-const subscription = ReactNativeKookit.addListener(
-  "onVolumeButtonPressed",
-  (event) => {
-    console.log("Volume button pressed:", event.key); // "up" 或 "down"
-  }
-);
-
-// 启用音量键拦截
-ReactNativeKookit.enableVolumeKeyInterception();
-
-// 测试：按音量键，应该在控制台看到日志
-
-// 清理
-subscription.remove();
-ReactNativeKookit.disableVolumeKeyInterception();
-```
-
-## 插件做了什么
-
-插件会自动：
-
-1. **添加必要的导入语句**：
-   - `import android.view.KeyEvent`
-   - `import expo.modules.kookit.VolumeKeyInterceptActivity`
-   - `import expo.modules.kookit.handleVolumeKeyEvent`
-
-2. **修改类声明**：
-
-   ```kotlin
-   class MainActivity : ReactActivity(), VolumeKeyInterceptActivity
-   ```
-
-3. **添加必要的属性和方法**：
-
-   ```kotlin
-   private var volumeKeyListener: ((Int) -> Unit)? = null
-   private var isVolumeKeyInterceptEnabled = false
-
-   override fun setVolumeKeyListener(listener: ((Int) -> Unit)?) {
-       volumeKeyListener = listener
-   }
-
-   override fun setVolumeKeyInterceptEnabled(enabled: Boolean) {
-       isVolumeKeyInterceptEnabled = enabled
-   }
-
-   override fun dispatchKeyEvent(event: KeyEvent): Boolean {
-       if (isVolumeKeyInterceptEnabled && handleVolumeKeyEvent(event)) {
-           return true
-       }
-       return super.dispatchKeyEvent(event)
-   }
-   ```
-
-## 兼容性
-
-- ✅ Expo SDK 49+
-- ✅ React Native 0.70+
-- ✅ 支持 Kotlin 和 Java MainActivity
-- ✅ 支持新架构（Fabric）
-
-## 手动安装（如果不使用 Expo）
-
-如果您不使用 Expo，请参考 [ANDROID_SETUP.md](./ANDROID_SETUP.md) 手动修改 MainActivity。
-
-## 故障排除
-
-### 插件未生效
-
-1. 确保运行了 `npx expo prebuild --clean`
-2. 检查 `android/app/src/main/java/.../MainActivity.kt` 是否包含了修改
-3. 清理并重新构建：`cd android && ./gradlew clean && cd .. && npx expo run:android`
-
-### 构建错误
-
-1. 确保您的 MainActivity 文件格式正确
-2. 检查是否有语法错误
-3. 如果插件修改失败，可以手动按照 ANDROID_SETUP.md 进行修改
-
-## 开发插件
-
-如果您需要修改插件，可以：
-
-```bash
-cd plugin
-npm install
-npm run build
-```
-
-然后重新运行 `npx expo prebuild --clean`。

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