electerm-data-tool 2.1.8 → 2.1.9

package/README.md

@@ -51,39 +51,13 @@ Available commands:
 - `--help` - Show help information
 - `--version` - Show version number
 
-Available options:
+### Global Options
 
+- `--app-type <type>` - Specify application type (`desktop` or `web`)
+  - `desktop` (default): Standard Electerm desktop application
+  - `web`: Electerm web application with different path structure
 - `-d, --data-path <path>` - Custom path to electerm data directory (for portable installations)
 
-### Custom Data Path (Portable Support)
-
-For portable installations where Electerm data is stored in a custom location, use the `--data-path` option:
-
-```bash
-# Export data from custom location
-electerm-data-tool --data-path /path/to/portable/electerm export backup.json
-
-# Migrate data in custom location
-electerm-data-tool --data-path /path/to/portable/electerm migrate
-
-# Check info for custom location
-electerm-data-tool --data-path /path/to/portable/electerm info
-```
-
-**Examples:**
-```bash
-# Windows portable installation
-electerm-data-tool --data-path "C:\PortableApps\Electerm\Data" export backup.json
-
-# macOS custom installation
-electerm-data-tool --data-path "/Volumes/USB/electerm-data" migrate
-
-# Linux custom installation
-electerm-data-tool --data-path "/opt/electerm/data" info
-```
-
-The tool will validate that the specified path exists before proceeding.
-
 ### 1. Database Migration
 
 Migrate your Electerm database from v1 (NeDB) to v2 (SQLite):
@@ -133,10 +107,91 @@ electerm-data-tool info
 ```
 
 This will show:
+
 - Database type (v1 NeDB or v2 SQLite)
 - Number of records in each table
 - Migration recommendations if applicable
 
+## Application Types
+
+The tool supports two application types with different path structures:
+
+### Desktop Application (Default)
+
+Standard Electerm desktop application using the default path structure:
+
+```bash
+electerm-data-tool info
+# or explicitly specify desktop type
+electerm-data-tool info --app-type desktop
+```
+
+**Default paths:**
+- NeDB files: `{APP_PATH}/electerm/users/default_user/electerm.*.nedb`
+- SQLite files: `{APP_PATH}/electerm/users/default_user/electerm*.db`
+
+### Web Application
+
+Electerm web application with customized path structure:
+
+```bash
+electerm-data-tool info --app-type web
+```
+
+**Web paths:**
+- NeDB files: `{APP_PATH}/nedb-database/users/default_user/electerm.*.nedb`
+- SQLite files: `{APP_PATH}/sqlite/electerm*.db`
+
+### Custom Data Directory
+
+You can specify a custom data directory using the `APP_PATH` environment variable:
+
+```bash
+# Example for web application
+export APP_PATH="/path/to/your/data"
+electerm-data-tool migrate --app-type web
+
+# Example for desktop application  
+export APP_PATH="/custom/path"
+electerm-data-tool export backup.json --app-type desktop
+```
+
+**Complete web application example:**
+```bash
+# Set custom data directory
+export APP_PATH="/Users/username/my-electerm-data"
+
+# Check database status
+electerm-data-tool info --app-type web
+
+# Export data
+electerm-data-tool export backup.json --app-type web
+
+# Migrate from NeDB to SQLite
+electerm-data-tool migrate --app-type web
+```
+
+### Portable Installations
+
+For portable installations or custom data directories, use the `--data-path` option:
+
+```bash
+# Using --data-path option (recommended for portable installations)
+electerm-data-tool info --data-path "/path/to/portable/electerm" --app-type desktop
+electerm-data-tool export backup.json --data-path "/path/to/portable/electerm" --app-type desktop
+electerm-data-tool migrate --data-path "/path/to/portable/electerm" --app-type desktop
+
+# Web application with custom data path
+electerm-data-tool info --data-path "/custom/data/directory" --app-type web
+electerm-data-tool export backup.json --data-path "/custom/data/directory" --app-type web
+electerm-data-tool migrate --data-path "/custom/data/directory" --app-type web
+```
+
+**Path Priority:**
+1. `--data-path` option (highest priority)
+2. `APP_PATH` environment variable  
+3. Default system-specific path (lowest priority)
+
 ## Database Detection
 
 The tool automatically detects whether you're using:
@@ -178,39 +233,6 @@ The exported JSON follows this structure:
 - The `passwordEncrypted` flag is removed from exported data
 - Exported passwords are human-readable for backup purposes
 
-## Environment Variables
-
-The tool supports the following environment variables for configuration:
-
-### `APP_PATH` (Legacy)
-
-Sets the base application data directory. This is the legacy method still supported for backward compatibility.
-
-```bash
-APP_PATH=/custom/path electerm-data-tool info
-```
-
-### Data Path Priority
-
-The tool uses the following priority order for determining the data path:
-
-1. **`--data-path` option** (highest priority) - Command-line argument
-2. **`APP_PATH` environment variable** - Legacy support
-3. **Default platform path** (lowest priority) - System default
-
-**Examples:**
-```bash
-# Using command-line option (recommended)
-electerm-data-tool --data-path /path/to/data info
-
-# Using environment variable (legacy)
-APP_PATH=/path/to/data electerm-data-tool info
-
-# Command-line option overrides environment variable
-APP_PATH=/path/one electerm-data-tool --data-path /path/two info
-# Will use /path/two
-```
-
 ## Requirements
 
 - **Node.js**: 16.0.0 or higher

package/README.zh-CN.md

@@ -51,38 +51,12 @@ electerm-data-tool [command] [options]
 - `--help` - 显示帮助信息
 - `--version` - 显示版本号
 
-可用选项：
+### 全局选项
 
-- `-d, --data-path <路径>` - 指定 Electerm 数据目录（便携版/自定义路径支持）
-
-### 自定义数据路径（便携版支持）
-
-对于便携版或 Electerm 数据存储在自定义位置的情况，可通过 `--data-path` 选项指定数据目录：
-
-```bash
-# 从自定义目录导出数据
-electerm-data-tool --data-path /path/to/portable/electerm export backup.json
-
-# 迁移自定义目录数据
-electerm-data-tool --data-path /path/to/portable/electerm migrate
-
-# 查看自定义目录信息
-electerm-data-tool --data-path /path/to/portable/electerm info
-```
-
-**示例：**
-```bash
-# Windows 便携版
-electerm-data-tool --data-path "C:\\PortableApps\\Electerm\\Data" export backup.json
-
-# macOS U 盘
-electerm-data-tool --data-path "/Volumes/USB/electerm-data" migrate
-
-# Linux 自定义安装
-electerm-data-tool --data-path "/opt/electerm/data" info
-```
-
-工具会校验指定路径是否存在。
+- `--app-type <type>` - 指定应用类型（`desktop` 或 `web`）
+  - `desktop`（默认）：标准 Electerm 桌面应用
+  - `web`：Electerm Web 应用，使用不同的路径结构
+- `-d, --data-path <path>` - 自定义 Electerm 数据目录路径（用于便携安装）
 
 ### 1. 数据库迁移
 
@@ -122,10 +96,94 @@ electerm-data-tool info
 ```
 
 将显示：
+
 - 数据库类型（v1 NeDB 或 v2 SQLite）
 - 各表数据条数
 - 如需迁移会有提示
 
+## 应用类型
+
+工具支持两种应用类型，使用不同的路径结构：
+
+### 桌面应用（默认）
+
+标准 Electerm 桌面应用使用默认路径结构：
+
+```bash
+electerm-data-tool info
+# 或明确指定桌面类型
+electerm-data-tool info --app-type desktop
+```
+
+**默认路径：**
+
+- NeDB 文件：`{APP_PATH}/electerm/users/default_user/electerm.*.nedb`
+- SQLite 文件：`{APP_PATH}/electerm/users/default_user/electerm*.db`
+
+### Web 应用
+
+Electerm Web 应用使用自定义路径结构：
+
+```bash
+electerm-data-tool info --app-type web
+```
+
+**Web 路径：**
+
+- NeDB 文件：`{APP_PATH}/nedb-database/users/default_user/electerm.*.nedb`
+- SQLite 文件：`{APP_PATH}/sqlite/electerm*.db`
+
+### 自定义数据目录
+
+可以使用 `APP_PATH` 环境变量指定自定义数据目录：
+
+```bash
+# Web 应用示例
+export APP_PATH="/path/to/your/data"
+electerm-data-tool migrate --app-type web
+
+# 桌面应用示例
+export APP_PATH="/custom/path"
+electerm-data-tool export backup.json --app-type desktop
+```
+
+**完整 Web 应用示例：**
+```bash
+# 设置自定义数据目录
+export APP_PATH="/Users/username/my-electerm-data"
+
+# 检查数据库状态
+electerm-data-tool info --app-type web
+
+# 导出数据
+electerm-data-tool export backup.json --app-type web
+
+# 从 NeDB 迁移到 SQLite
+electerm-data-tool migrate --app-type web
+```
+
+### 便携安装
+
+对于便携安装或自定义数据目录，使用 `--data-path` 选项：
+
+```bash
+# 使用 --data-path 选项（推荐用于便携安装）
+electerm-data-tool info --data-path "/path/to/portable/electerm" --app-type desktop
+electerm-data-tool export backup.json --data-path "/path/to/portable/electerm" --app-type desktop
+electerm-data-tool migrate --data-path "/path/to/portable/electerm" --app-type desktop
+
+# Web 应用自定义数据路径
+electerm-data-tool info --data-path "/custom/data/directory" --app-type web
+electerm-data-tool export backup.json --data-path "/custom/data/directory" --app-type web
+electerm-data-tool migrate --data-path "/custom/data/directory" --app-type web
+```
+
+**路径优先级：**
+
+1. `--data-path` 选项（最高优先级）
+2. `APP_PATH` 环境变量
+3. 默认系统路径（最低优先级）
+
 ## 数据库自动检测
 
 工具会自动检测当前数据库类型：
@@ -181,41 +239,6 @@ electerm-data-tool info
 迁移时 NeDB 文件会自动备份为：
 - `electerm.bookmarks.nedb-{timestamp}.bak`
 
-### 数据路径优先级
-
-Electerm 数据工具会按如下优先级查找数据目录：
-
-1. `--data-path` 命令行参数（最高优先级）
-2. `APP_PATH` 环境变量（兼容旧用法）
-3. 默认平台路径（最低优先级）
-
-**示例：**
-```bash
-# 推荐：命令行参数
-electerm-data-tool --data-path /path/to/data info
-
-# 兼容旧用法：环境变量
-APP_PATH=/path/to/data electerm-data-tool info
-
-# 命令行参数优先生效
-APP_PATH=/path/one electerm-data-tool --data-path /path/two info
-# 实际使用 /path/two
-```
-
-## 环境变量
-
-工具支持如下环境变量进行配置：
-
-### `APP_PATH`（兼容旧用法）
-
-设置应用数据目录（旧用法，仍然兼容）：
-
-```bash
-APP_PATH=/custom/path electerm-data-tool info
-```
-
-如需便携/自定义目录，推荐使用 `--data-path` 选项。
-
 ## 示例流程
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electerm-data-tool",
-  "version": "2.1.8",
+  "version": "2.1.9",
   "description": "electerm data export/migrate tool",
   "main": "src/index.js",
   "bin": {

package/src/common/app-props.js

@@ -28,12 +28,25 @@ function getElectermDataPath () {
   return process.env.APP_PATH || getAppPath()
 }
 
+// Global appType variable to store the application type
+let globalAppType = 'desktop'
+
+function setAppType (appType) {
+  globalAppType = appType || 'desktop'
+}
+
+function getAppType () {
+  return globalAppType
+}
+
 // Use a getter to ensure we always get the current path
 Object.defineProperty(exports, 'appPath', {
   get: getElectermDataPath
 })
 
 exports.defaultUserName = 'default_user'
+exports.setAppType = setAppType
+exports.getAppType = getAppType
 exports.packInfo = {
   version
 }

package/src/index.js

@@ -27,6 +27,7 @@ program
   .name('electerm-data-tool')
   .description('CLI tool for electerm data migration and export')
   .version(pkg.version)
+  .option('--app-type <type>', 'Application type (desktop or web)', 'desktop')
   .option('-d, --data-path <path>', 'Custom path to electerm data directory (for portable installations)')
   .hook('preAction', (thisCommand) => {
     // Set custom data path if provided
@@ -56,6 +57,10 @@ program
   .description('Migrate electerm database from v1 (NeDB) to v2 (SQLite)')
   .action(async () => {
     try {
+      // Set appType from command line options
+      const { setAppType } = require('./common/app-props')
+      setAppType(program.opts().appType)
+
       // Check Node.js version requirement for SQLite
       const majorVersion = getNodeMajorVersion()
 
@@ -92,6 +97,10 @@ program
   .argument('<output-path>', 'Path to the output JSON file')
   .action(async (outputPath) => {
     try {
+      // Set appType from command line options
+      const { setAppType } = require('./common/app-props')
+      setAppType(program.opts().appType)
+
       log.info('Starting data export...')
 
       // Show the data path being used
@@ -201,6 +210,10 @@ program
   .description('Display information about the current electerm data')
   .action(async () => {
     try {
+      // Set appType from command line options
+      const { setAppType } = require('./common/app-props')
+      setAppType(program.opts().appType)
+
       // Show the data path being used
       const { appPath } = require('./common/app-props')
       console.log('📊 Electerm Data Information')

package/src/migrate/migrate-1-to-2.js

@@ -4,11 +4,20 @@
 
 const { resolve } = require('path')
 const { existsSync, renameSync } = require('fs')
-const { appPath, defaultUserName } = require('../common/app-props')
+const { appPath, defaultUserName, getAppType } = require('../common/app-props')
 const log = require('../common/log')
 
 const reso = (name) => {
-  return resolve(appPath, 'electerm', 'users', defaultUserName, `electerm.${name}.nedb`)
+  const appType = getAppType()
+  let basePath
+
+  if (appType === 'web') {
+    basePath = resolve(appPath, 'nedb-database', 'users', defaultUserName)
+  } else {
+    basePath = resolve(appPath, 'electerm', 'users', defaultUserName)
+  }
+
+  return resolve(basePath, `electerm.${name}.nedb`)
 }
 
 const tables = [

package/src/nedb.js

@@ -2,13 +2,22 @@
  * nedb api wrapper
  */
 
-const { appPath, defaultUserName } = require('./common/app-props')
+const { appPath, defaultUserName, getAppType } = require('./common/app-props')
 const { resolve } = require('path')
 const Datastore = require('@yetzt/nedb')
 const db = {}
 
 const reso = (name) => {
-  return resolve(appPath, 'electerm', 'users', defaultUserName, `electerm.${name}.nedb`)
+  const appType = getAppType()
+  let basePath
+
+  if (appType === 'web') {
+    basePath = resolve(appPath, 'nedb-database', 'users', defaultUserName)
+  } else {
+    basePath = resolve(appPath, 'electerm', 'users', defaultUserName)
+  }
+
+  return resolve(basePath, `electerm.${name}.nedb`)
 }
 const tables = [
   'bookmarks',

package/src/sqlite.js

@@ -3,14 +3,30 @@
  * Updated to use two database files: one for 'data' table, one for others
  */
 
-const { appPath, defaultUserName } = require('./common/app-props')
+const { appPath, defaultUserName, getAppType } = require('./common/app-props')
 const { resolve } = require('path')
 const uid = require('./common/uid')
 const { DatabaseSync } = require('node:sqlite')
 
-// Define paths for two database files
-const mainDbPath = resolve(appPath, 'electerm', 'users', defaultUserName, 'electerm.db')
-const dataDbPath = resolve(appPath, 'electerm', 'users', defaultUserName, 'electerm_data.db')
+// Define paths for two database files based on appType
+function getDbPaths () {
+  const appType = getAppType()
+  let basePath
+
+  if (appType === 'web') {
+    // For web type, SQLite files go directly in sqlite folder
+    basePath = resolve(appPath, 'sqlite')
+  } else {
+    basePath = resolve(appPath, 'electerm', 'users', defaultUserName)
+  }
+
+  return {
+    mainDbPath: resolve(basePath, 'electerm.db'),
+    dataDbPath: resolve(basePath, 'electerm_data.db')
+  }
+}
+
+const { mainDbPath, dataDbPath } = getDbPaths()
 
 // Create two database instances
 const mainDb = new DatabaseSync(mainDbPath)