react-native-kookit 0.3.5 → 0.3.7

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)

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