react-native-kookit 0.3.4 → 0.3.6

package/RELEASE_CHECKLIST.md

@@ -1,115 +0,0 @@
-# React Native Kookit - 发布前检查
-
-## 修复的主要问题
-
-✅ **Plugin undefined 错误**
-
-- 修复了 package.json 中插件配置位置
-- 添加了 @expo/config-plugins 依赖
-- 改进了 app.plugin.js 的错误处理
-
-✅ **插件导出问题**
-
-- 确保插件正确导出为 ConfigPlugin 函数
-- 添加了fallback处理
-
-## 当前文件结构
-
-```
-react-native-kookit/
-├── package.json                 # 主包配置，包含插件配置
-├── app.plugin.js               # 插件入口文件
-├── plugin/                     # 插件源码目录
-│   ├── package.json           # 插件依赖
-│   ├── tsconfig.json          # TypeScript 配置
-│   ├── src/
-│   │   └── withVolumeKeyIntercept.ts  # 插件实现
-│   └── build/                 # 编译后的插件
-│       └── withVolumeKeyIntercept.js
-├── README_NEW.md              # 更新的文档
-├── TROUBLESHOOTING.md         # 故障排除指南
-└── EXPO_PLUGIN_README.md      # 插件详细说明
-```
-
-## 测试步骤
-
-### 1. 本地测试插件加载
-
-```bash
-cd /path/to/react-native-kookit
-node -e "
-const plugin = require('./app.plugin.js');
-console.log('Plugin type:', typeof plugin);
-console.log('Plugin loaded:', typeof plugin === 'function' ? '✅ Success' : '❌ Failed');
-"
-```
-
-### 2. 在测试项目中验证
-
-1. 创建新的 Expo 项目：
-
-```bash
-npx create-expo-app TestKookit
-cd TestKookit
-```
-
-2. 添加本地模块：
-
-```bash
-npm install ../react-native-kookit
-```
-
-3. 配置 app.json：
-
-```json
-{
-  "expo": {
-    "plugins": ["react-native-kookit"]
-  }
-}
-```
-
-4. 预构建：
-
-```bash
-npx expo prebuild --clean
-```
-
-5. 检查生成的 MainActivity 是否包含必要代码
-
-### 3. 发布验证
-
-```bash
-# 构建插件
-npm run build-plugin
-
-# 检查文件
-ls -la plugin/build/
-
-# 发布（测试版本）
-npm publish --tag beta
-```
-
-## 用户使用流程验证
-
-### 正确的用户步骤：
-
-1. ✅ `npm install react-native-kookit`
-2. ✅ 在 app.json 添加 `"plugins": ["react-native-kookit"]`
-3. ✅ `npx expo prebuild --clean`
-4. ✅ `npx expo run:android`
-
-### 预期结果：
-
-- MainActivity 自动包含 VolumeKeyInterceptActivity 接口
-- 音量键监听功能正常工作
-- 无需手动修改原生代码
-
-## 发布清单
-
-- [ ] 插件本地测试通过
-- [ ] 在新项目中端到端测试
-- [ ] 文档更新完成
-- [ ] 版本号更新
-- [ ] README 更新为 README_NEW.md
-- [ ] 发布到 npm

package/SMB_CLIENT_STATIC_METHODS.md

@@ -1,175 +0,0 @@
-# SMB Client 静态方法使用示例
-
-SmbClient新增了多个静态方法来管理多个客户端实例：
-
-## 新增的静态方法
-
-### 1. `SmbClient.disposeClient(clientId: string)`
-
-销毁指定客户端ID的客户端实例
-
-```typescript
-// 销毁特定的客户端
-const disposed = await SmbClient.disposeClient("my_client_id");
-console.log("Client disposed:", disposed); // true/false
-```
-
-### 2. `SmbClient.getClientStatus(clientId: string)`
-
-获取指定客户端ID的状态信息
-
-```typescript
-// 获取客户端状态
-const status = SmbClient.getClientStatus("my_client_id");
-console.log("Client status:", status);
-// 返回: {
-//   exists: true,
-//   isConnected: true,
-//   currentShare: 'C$',
-//   isDisposed: false
-// }
-```
-
-### 3. `SmbClient.getAllClientsStatus()`
-
-获取所有活跃客户端的状态
-
-```typescript
-// 获取所有客户端状态
-const allStatus = SmbClient.getAllClientsStatus();
-allStatus.forEach((status, clientId) => {
-  console.log(`Client ${clientId}:`, status);
-});
-```
-
-### 4. `SmbClient.getInstance(clientId: string)`
-
-获取指定客户端ID的实例对象
-
-```typescript
-// 获取现有的客户端实例
-const existingClient = SmbClient.getInstance("my_client_id");
-if (existingClient) {
-  await existingClient.listFiles("/");
-}
-```
-
-### 5. `SmbClient.disposeAllClients()`
-
-销毁所有客户端实例
-
-```typescript
-// 清理所有客户端
-const disposedCount = await SmbClient.disposeAllClients();
-console.log(`Disposed ${disposedCount} clients`);
-```
-
-## 使用示例
-
-```typescript
-import SmbClient from "react-native-kookit";
-
-export class SmbManager {
-  private clients: Map<string, SmbClient> = new Map();
-
-  // 创建命名客户端
-  async createNamedClient(
-    name: string,
-    config: SmbConnectionConfig
-  ): Promise<SmbClient> {
-    const client = await SmbClient.create(name);
-    await client.connect(config);
-    this.clients.set(name, client);
-    return client;
-  }
-
-  // 检查客户端是否存在且连接
-  isClientReady(name: string): boolean {
-    const status = SmbClient.getClientStatus(name);
-    return status.exists && status.isConnected && !status.isDisposed;
-  }
-
-  // 安全获取客户端
-  getClient(name: string): SmbClient | null {
-    if (this.isClientReady(name)) {
-      return SmbClient.getInstance(name);
-    }
-    return null;
-  }
-
-  // 销毁指定客户端
-  async removeClient(name: string): Promise<boolean> {
-    this.clients.delete(name);
-    return await SmbClient.disposeClient(name);
-  }
-
-  // 获取所有客户端状态报告
-  getStatusReport(): Record<string, any> {
-    const report: Record<string, any> = {};
-    const allStatus = SmbClient.getAllClientsStatus();
-
-    allStatus.forEach((status, clientId) => {
-      report[clientId] = {
-        ...status,
-        managed: this.clients.has(clientId),
-      };
-    });
-
-    return report;
-  }
-
-  // 清理所有资源
-  async cleanup(): Promise<void> {
-    this.clients.clear();
-    await SmbClient.disposeAllClients();
-  }
-}
-
-// 使用示例
-const smbManager = new SmbManager();
-
-// 创建多个客户端
-const client1 = await smbManager.createNamedClient("server1", {
-  host: "192.168.1.100",
-  username: "user1",
-  password: "pass1",
-});
-
-const client2 = await smbManager.createNamedClient("server2", {
-  host: "192.168.1.101",
-  username: "user2",
-  password: "pass2",
-});
-
-// 检查状态
-console.log("Status report:", smbManager.getStatusReport());
-
-// 使用特定客户端
-const client = smbManager.getClient("server1");
-if (client) {
-  const files = await client.listFiles("/");
-  console.log("Files:", files);
-}
-
-// 清理资源
-await smbManager.cleanup();
-```
-
-## 类型定义
-
-```typescript
-export interface SmbClientStatus {
-  exists: boolean;
-  isConnected: boolean;
-  currentShare: string | null;
-  isDisposed: boolean;
-}
-
-export interface SmbClientInfo {
-  isConnected: boolean;
-  currentShare: string | null;
-  isDisposed: boolean;
-}
-```
-
-这些静态方法使得SmbClient的多实例管理变得更加简单和安全。

package/SMB_COMPLETE_GUIDE.md

@@ -1,308 +0,0 @@
-# SMB Client Implementation
-
-This document provides comprehensive documentation for the SMB client functionality in react-native-kookit.
-
-## Overview
-
-The SMB client provides object-oriented access to SMB/CIFS file shares, supporting both Android and iOS platforms with a unified API.
-
-## Features
-
-- **Object-oriented design**: Create multiple SMB client instances
-- **Cross-platform**: Works on both Android and iOS
-- **Progress tracking**: Real-time upload/download progress events
-- **Full file operations**: List, download, upload, delete, create directories
-- **Authentication**: Supports username/password and domain authentication
-- **Share management**: Connect to different shares on the same server
-
-## Platform Support
-
-### Android
-
-- Uses SMBJ library (version 0.13.0)
-- Supports SMB2/3 protocols
-- Full authentication and file operations
-
-### iOS
-
-- Uses SMBClient library (version 0.3.1)
-- Supports SMB2 protocol
-- Async/await Swift implementation
-
-## API Reference
-
-### Creating an SMB Client
-
-```typescript
-import { SmbClient } from "react-native-kookit";
-
-// Create and initialize a new SMB client
-const client = await SmbClient.create();
-
-// Or create with custom client ID
-const client = await SmbClient.create("my-smb-client");
-```
-
-### Connection Configuration
-
-```typescript
-interface SmbConnectionConfig {
-  host: string; // SMB server IP or hostname
-  port?: number; // Port (default: 445)
-  username: string; // Username for authentication
-  password: string; // Password for authentication
-  domain?: string; // Domain name (optional)
-  share?: string; // Share name to connect to (optional)
-  timeout?: number; // Connection timeout in milliseconds (default: 10000)
-}
-```
-
-### Event Handlers
-
-```typescript
-client.setEventHandlers({
-  onProgress: (progress: {
-    transferred: number;
-    total: number;
-    percentage: number;
-  }) => {
-    console.log(`Progress: ${progress.percentage}%`);
-  },
-  onComplete: () => {
-    console.log("Operation completed");
-  },
-  onError: (error: Error) => {
-    console.error("SMB error:", error.message);
-  },
-});
-```
-
-### Connection Methods
-
-```typescript
-// Connect to SMB server
-await client.connect({
-  host: "192.168.1.100",
-  username: "admin",
-  password: "password",
-  domain: "WORKGROUP",
-  share: "shared",
-  timeout: 15000,
-});
-
-// Connect to a different share on the same server
-await client.connectShare("documents");
-
-// Disconnect from server
-await client.disconnect();
-
-// Dispose of the client (cleanup resources)
-await client.dispose();
-```
-
-### File Operations
-
-```typescript
-// List files and directories
-const files = await client.list("/path/to/directory");
-console.log(files); // Array of SmbFileInfo objects
-
-// Download a file
-await client.download("/remote/file.txt", "/local/path/file.txt");
-
-// Upload a file
-await client.upload("/local/path/file.txt", "/remote/file.txt");
-
-// Delete a file
-await client.delete("/remote/file.txt");
-
-// Delete a directory
-await client.delete("/remote/directory", true);
-
-// Create a directory
-await client.createDirectory("/remote/new_directory");
-```
-
-### File Information Structure
-
-```typescript
-interface SmbFileInfo {
-  name: string; // File/directory name
-  isDirectory: boolean; // Whether it's a directory
-  size: number; // File size in bytes
-  lastModified: string; // Last modification date
-  attributes?: string; // File attributes (platform-specific)
-}
-```
-
-### Client Management
-
-```typescript
-// Get client status
-const status = await SmbClient.getClientStatus("client-id");
-console.log(status); // { exists: boolean, connected: boolean }
-
-// List all clients
-const clients = await SmbClient.listClients();
-console.log(clients); // { clients: Record<string, { connected: boolean }>, count: number }
-```
-
-## Usage Examples
-
-### Basic Connection and File Listing
-
-```typescript
-import { SmbClient } from "react-native-kookit";
-
-async function basicExample() {
-  const client = await SmbClient.create();
-
-  try {
-    await client.connect({
-      host: "192.168.1.100",
-      username: "admin",
-      password: "password",
-      share: "shared",
-    });
-
-    const files = await client.list();
-    files.forEach((file) => {
-      console.log(
-        `${file.isDirectory ? "📁" : "📄"} ${file.name} (${file.size} bytes)`
-      );
-    });
-  } catch (error) {
-    console.error("Error:", error.message);
-  } finally {
-    await client.dispose();
-  }
-}
-```
-
-### File Upload with Progress
-
-```typescript
-async function uploadWithProgress() {
-  const client = await SmbClient.create();
-
-  client.setEventHandlers({
-    onProgress: (progress) => {
-      console.log(`Upload progress: ${progress.percentage}%`);
-    },
-    onComplete: () => {
-      console.log("Upload completed!");
-    },
-    onError: (error) => {
-      console.error("Upload failed:", error.message);
-    },
-  });
-
-  try {
-    await client.connect({
-      host: "192.168.1.100",
-      username: "admin",
-      password: "password",
-      share: "uploads",
-    });
-
-    await client.upload("/local/document.pdf", "/remote/backup/document.pdf");
-  } finally {
-    await client.dispose();
-  }
-}
-```
-
-### Multiple Share Access
-
-```typescript
-async function multiShareExample() {
-  const client = await SmbClient.create();
-
-  try {
-    // Connect to server
-    await client.connect({
-      host: "192.168.1.100",
-      username: "admin",
-      password: "password",
-    });
-
-    // Connect to documents share
-    await client.connectShare("documents");
-    const docFiles = await client.list();
-    console.log("Documents:", docFiles.length, "files");
-
-    // Switch to media share
-    await client.connectShare("media");
-    const mediaFiles = await client.list();
-    console.log("Media:", mediaFiles.length, "files");
-  } finally {
-    await client.dispose();
-  }
-}
-```
-
-## Error Handling
-
-The SMB client throws specific errors for different scenarios:
-
-```typescript
-try {
-  await client.connect(config);
-} catch (error) {
-  if (error.message.includes("SMB_CONNECT_ERROR")) {
-    // Handle connection errors
-  } else if (error.message.includes("SMB_AUTH_ERROR")) {
-    // Handle authentication errors
-  } else {
-    // Handle other errors
-  }
-}
-```
-
-## Common Error Codes
-
-- `SMB_CLIENT_EXISTS`: Client with the same ID already exists
-- `SMB_CLIENT_NOT_FOUND`: Client ID not found
-- `SMB_CONNECT_ERROR`: Connection failed
-- `SMB_LIST_ERROR`: Failed to list directory
-- `SMB_DOWNLOAD_ERROR`: Download operation failed
-- `SMB_UPLOAD_ERROR`: Upload operation failed
-- `SMB_DELETE_ERROR`: Delete operation failed
-- `SMB_CREATE_DIR_ERROR`: Directory creation failed
-
-## Best Practices
-
-1. **Always dispose clients**: Use `try/finally` blocks to ensure proper cleanup
-2. **Handle connection timeouts**: Set appropriate timeout values based on network conditions
-3. **Use progress events**: Provide user feedback for long-running operations
-4. **Error handling**: Implement comprehensive error handling for network operations
-5. **Connection pooling**: Reuse client instances when possible to reduce overhead
-
-## Troubleshooting
-
-### Connection Issues
-
-- Verify SMB server is accessible and SMB service is running
-- Check firewall settings (default port 445)
-- Ensure correct username/password credentials
-- Try connecting without specifying a share first
-
-### Authentication Problems
-
-- Verify domain name is correct (or omit if not using domain)
-- Check user permissions on the target share
-- Some servers require specific SMB protocol versions
-
-### File Operation Errors
-
-- Ensure the share is properly connected before file operations
-- Check file/directory permissions
-- Verify paths use forward slashes (/) as separators
-- Some special characters in filenames may cause issues
-
-## Performance Considerations
-
-- File operations are async and don't block the UI thread
-- Large file transfers will trigger progress events for better UX
-- Multiple concurrent operations on the same client are queued
-- Consider using separate clients for parallel operations on different shares