cloud-function-cli 1.0.0

package/README.md

@@ -0,0 +1,299 @@
+# Cloud Function CLI
+
+一个强大的命令行工具，用于管理云函数系统 API 的创建、部署和版本控制。
+
+[![npm version](https://badge.fury.io/js/cloud-function-cli.svg)](https://www.npmjs.com/package/cloud-function-cli)
+[![License](https://img.shields.io/npm/l/cloud-function-cli.svg)](LICENSE)
+
+## ✨ 特性
+
+- 🚀 快速创建 API 接口模板
+- 📤 一键部署到服务器
+- 📥 从服务器拉取 API 代码
+- 📜 版本历史查看
+- 🔄 版本回滚
+- 🔐 安全的 JWT 认证
+- 🎯 支持多环境（dev/prod）
+
+## 📦 安装
+
+```bash
+# 全局安装
+npm install -g cloud-function-cli
+
+# 或使用 yarn
+yarn global add cloud-function-cli
+
+# 或使用 pnpm
+pnpm add -g cloud-function-cli
+```
+
+## 🚀 快速开始
+
+### 1. 登录
+
+```bash
+cf login
+```
+
+输入你的用户名和密码。
+
+### 2. 创建 API
+
+```bash
+# 创建单个 API
+cf create user/hello
+
+# 创建 group 目录下的 API
+cf create user/profile
+```
+
+这将在当前目录生成 `api/group/name.js` 文件，包含完整的 API 模板。
+
+### 3. 编辑 API
+
+```bash
+# 编辑生成的文件
+nano api/user/hello.js
+# 或使用你喜欢的编辑器
+code api/user/hello.js
+```
+
+### 4. 保存到服务器
+
+```bash
+# 保存单个 API 到开发环境
+cf save user/hello --env dev
+
+# 保存整个 group 的所有 API
+cf save user --env dev
+
+# 保存到生产环境
+cf save user/hello --env prod
+```
+
+### 5. 调用 API
+
+```bash
+# 假设后端运行在 localhost:3000
+curl http://localhost:3000/api/user/hello
+```
+
+## 📚 命令详解
+
+### `cf login`
+
+登录系统，保存认证信息到本地配置文件。
+
+```bash
+cf login
+```
+
+登录成功后，配置文件保存在：
+- Windows: `C:\Users\<你>\.cloud-function\config.json`
+- macOS/Linux: `~/.cloud-function/config.json`
+
+### `cf create <name>`
+
+创建新的 API 接口文件。
+
+```bash
+# 语法
+cf create <group>/<name>
+
+# 示例
+cf create user/login
+cf create product/list
+cf create order/create
+```
+
+生成的文件位于 `api/<group>/<name>.js`
+
+### `cf save <name>`
+
+保存 API 到服务器。
+
+```bash
+# 保存单个 API
+cf save <group>/<name> --env <env>
+
+# 保存整个 group
+cf save <group> --env <env>
+
+# 示例
+cf save user/login --env dev
+cf save user --env prod
+```
+
+参数：
+- `-e, --env <env>`: 环境选择（dev/prod，默认 dev）
+
+### `cf get <name>`
+
+从服务器拉取 API 代码。
+
+```bash
+# 拉取单个 API
+cf get <group>/<name> --env <env>
+
+# 拉取整个 group
+cf get <group> --env <env>
+
+# 示例
+cf get user/login --env dev
+```
+
+参数：
+- `-e, --env <env>`: 环境选择（dev/prod，默认 dev）
+
+### `cf history <name>`
+
+查看 API 的版本历史。
+
+```bash
+cf history <group>/<name> --env <env>
+
+# 示例
+cf history user/login --env dev
+```
+
+参数：
+- `-e, --env <env>`: 环境选择（dev/prod，默认 dev）
+
+输出示例：
+```
+┌──────┬─────────────────────┬────────────────────┬─────────┐
+│ 版本 │    创建时间         │      作者          │  备注   │
+├──────┼─────────────────────┼────────────────────┼─────────┤
+│   1  │ 2025-01-23 14:30:00 │ admin             │ 初始版本 │
+│   2  │ 2025-01-23 15:20:00 │ admin             │ 修复bug  │
+│   3  │ 2025-01-23 16:10:00 │ admin             │ 新增功能 │
+└──────┴─────────────────────┴────────────────────┴─────────┘
+```
+
+### `cf rollback <name> <version>`
+
+回滚 API 到指定版本。
+
+```bash
+cf rollback <group>/<name> <version> --env <env>
+
+# 示例
+cf rollback user/login 2 --env dev
+```
+
+参数：
+- `<version>`: 目标版本号
+- `-e, --env <env>`: 环境选择（dev/prod，默认 dev）
+
+## ⚙️ 配置
+
+登录后，配置文件会自动创建在用户目录下的 `.cloud-function/config.json`：
+
+```json
+{
+  "apiBaseUrl": "http://localhost:3000",
+  "token": "your-jwt-token-here",
+  "username": "admin",
+  "environment": "dev"
+}
+```
+
+### 自定义后端地址
+
+如果你的后端不在 `localhost:3000`，可以手动修改配置文件：
+
+```json
+{
+  "apiBaseUrl": "https://your-server.com"
+}
+```
+
+或使用环境变量：
+```bash
+export CLOUD_FUNCTION_API_BASE_URL="https://your-server.com"
+```
+
+## 🏗️ API 模板结构
+
+生成的 API 文件包含以下结构：
+
+```javascript
+async function handler(context) {
+  // context 包含：
+  // - request: Express Request 对象
+  // - query: 查询参数
+  // - body: 请求体
+  // - headers: 请求头
+  // - params: 路径参数
+  // - env: 环境变量
+
+  const { request, query, body } = context;
+
+  // 你的业务逻辑
+  const result = {
+    success: true,
+    message: 'Hello from Cloud Function!',
+    data: query
+  };
+
+  return result;
+}
+
+module.exports = { handler };
+```
+
+## 🔐 安全性
+
+- 使用 JWT Token 认证
+- Token 自动附加到请求头
+- Token 过期自动提示重新登录
+- 支持 HTTPS 连接
+
+## 🐛 故障排查
+
+### cf: command not found
+
+如果提示命令找不到，请执行：
+
+```bash
+# 重新安装
+npm uninstall -g cloud-function-cli
+npm install -g cloud-function-cli
+
+# 或重新打开终端（刷新环境变量）
+hash -r  # Unix/Linux/Mac
+refreshenv  # Windows PowerShell
+```
+
+### Token 过期
+
+如果提示 Token 过期，重新登录：
+
+```bash
+cf login
+```
+
+### 连接超时
+
+如果遇到连接超时，检查配置文件中的 `apiBaseUrl` 是否正确。
+
+```bash
+# 查看配置文件路径
+# Windows: C:\Users\<你>\.cloud-function\config.json
+# Mac/Linux: ~/.cloud-function/config.json
+```
+
+## 📝 许可证
+
+MIT License
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 🔗 相关链接
+
+- [云函数系统 GitHub 仓库](https://github.com/your-username/cloud-function)
+- [后端服务](https://github.com/your-username/cloud-function-backend)
+- [Web 管理界面](https://github.com/your-username/cloud-function-web)

package/dist/cli/create.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("../utils/logger");
+const api_template_1 = require("../template/api-template");
+const create = async (name) => {
+    const parts = name.split('/');
+    let group, api;
+    if (parts.length === 1) {
+        group = parts[0];
+        api = 'index';
+    }
+    else {
+        group = parts[0];
+        api = parts[1];
+    }
+    const apiRootDir = path_1.default.join(process.cwd(), 'api');
+    const groupDir = path_1.default.join(apiRootDir, group);
+    if (!fs_1.default.existsSync(groupDir)) {
+        fs_1.default.mkdirSync(groupDir, { recursive: true });
+        logger_1.logger.success(`Created group: ${group}`);
+    }
+    const apiPath = path_1.default.join(groupDir, `${api}.js`);
+    if (fs_1.default.existsSync(apiPath)) {
+        logger_1.logger.warn(`API ${group}/${api}.js already exists`);
+        return;
+    }
+    fs_1.default.writeFileSync(apiPath, api_template_1.apiTemplate);
+    logger_1.logger.success(`Created API: api/${group}/${api}.js`);
+};
+exports.create = create;

package/dist/cli/get.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const apiClient_1 = require("../services/apiClient");
+const config_1 = require("../utils/config");
+const logger_1 = require("../utils/logger");
+const get = async (name, options) => {
+    const cfg = config_1.config.get();
+    const environment = options.env || cfg.environment || 'dev';
+    const parts = name.split('/');
+    const group = parts[0];
+    const apiRootDir = path_1.default.join(process.cwd(), 'api');
+    if (parts.length === 1) {
+        try {
+            const res = await apiClient_1.apiClient.get(`/api/management/list/${group}`, { environment });
+            const apis = res.data;
+            if (apis.length === 0) {
+                logger_1.logger.warn(`No APIs found in group ${group}`);
+                return;
+            }
+            for (const apiDoc of apis) {
+                await getFile(apiRootDir, group, apiDoc.api, environment);
+            }
+            logger_1.logger.success('All APIs retrieved successfully!');
+        }
+        catch (error) {
+            logger_1.logger.error(`Failed to list APIs: ${error.response?.data?.error || error.message}`);
+        }
+    }
+    else {
+        const api = parts[1];
+        await getFile(apiRootDir, group, api, environment);
+    }
+};
+exports.get = get;
+const getFile = async (apiRootDir, group, api, environment) => {
+    try {
+        const res = await apiClient_1.apiClient.get(`/api/management/get/${group}/${api}`, { environment });
+        const groupDir = path_1.default.join(apiRootDir, group);
+        if (!fs_1.default.existsSync(groupDir)) {
+            fs_1.default.mkdirSync(groupDir, { recursive: true });
+        }
+        const filePath = path_1.default.join(groupDir, `${api}.js`);
+        fs_1.default.writeFileSync(filePath, res.data.handler);
+        logger_1.logger.success(`${group}/${api}.js ← Retrieved (Version: ${res.data.version})`);
+    }
+    catch (error) {
+        logger_1.logger.error(`Failed to get ${group}/${api}: ${error.response?.data?.error || error.message}`);
+    }
+};

package/dist/cli/history.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.history = void 0;
+const apiClient_1 = require("../services/apiClient");
+const config_1 = require("../utils/config");
+const logger_1 = require("../utils/logger");
+const history = async (name, options) => {
+    const cfg = config_1.config.get();
+    const environment = options.env || cfg.environment || 'dev';
+    const parts = name.split('/');
+    if (parts.length < 2) {
+        logger_1.logger.error('Please specify API: group/api');
+        return;
+    }
+    const group = parts[0];
+    const api = parts[1];
+    try {
+        const res = await apiClient_1.apiClient.get(`/api/management/history/${group}/${api}`, { environment });
+        logger_1.logger.info(`History for ${group}/${api} (${environment}):`);
+        res.data.forEach((item) => {
+            const active = item.isActive ? ' (Active)' : '';
+            logger_1.logger.info(`  v${item.version}${active} - ${new Date(item.createdAt).toLocaleString()} - by ${item.author}`);
+        });
+    }
+    catch (error) {
+        logger_1.logger.error(`Failed to get history: ${error.response?.data?.error || error.message}`);
+    }
+};
+exports.history = history;

package/dist/cli/login.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.login = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const apiClient_1 = require("../services/apiClient");
+const config_1 = require("../utils/config");
+const logger_1 = require("../utils/logger");
+const login = async () => {
+    const answers = await inquirer_1.default.prompt([
+        {
+            type: 'input',
+            name: 'username',
+            message: 'Username:'
+        },
+        {
+            type: 'password',
+            name: 'password',
+            message: 'Password:'
+        }
+    ]);
+    try {
+        const res = await apiClient_1.apiClient.post('/api/auth/login', answers);
+        config_1.config.set({
+            token: res.data.accessToken,
+            username: res.data.user.username
+        });
+        logger_1.logger.success('Login successful!');
+    }
+    catch (error) {
+        logger_1.logger.error(`Login failed: ${error.response?.data?.error || error.message}`);
+    }
+};
+exports.login = login;

package/dist/cli/rollback.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rollback = void 0;
+const apiClient_1 = require("../services/apiClient");
+const config_1 = require("../utils/config");
+const logger_1 = require("../utils/logger");
+const rollback = async (name, version, options) => {
+    const cfg = config_1.config.get();
+    const environment = options.env || cfg.environment || 'dev';
+    const parts = name.split('/');
+    if (parts.length < 2) {
+        logger_1.logger.error('Please specify API: group/api');
+        return;
+    }
+    const group = parts[0];
+    const api = parts[1];
+    try {
+        const res = await apiClient_1.apiClient.post('/api/management/rollback', {
+            group,
+            api,
+            version: parseInt(version),
+            environment
+        });
+        logger_1.logger.success(`Rollback successful! New version: ${res.data.version}`);
+    }
+    catch (error) {
+        logger_1.logger.error(`Failed to rollback: ${error.response?.data?.error || error.message}`);
+    }
+};
+exports.rollback = rollback;

package/dist/cli/save.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.save = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const apiClient_1 = require("../services/apiClient");
+const config_1 = require("../utils/config");
+const logger_1 = require("../utils/logger");
+const save = async (name, options) => {
+    const cfg = config_1.config.get();
+    const environment = options.env || cfg.environment || 'dev';
+    const parts = name.split('/');
+    const group = parts[0];
+    const apiRootDir = path_1.default.join(process.cwd(), 'api');
+    // If only group provided, save all in group
+    if (parts.length === 1) {
+        const groupDir = path_1.default.join(apiRootDir, group);
+        if (!fs_1.default.existsSync(groupDir)) {
+            logger_1.logger.error(`Group directory api/${group} not found`);
+            return;
+        }
+        const files = fs_1.default.readdirSync(groupDir).filter(f => f.endsWith('.js'));
+        for (const file of files) {
+            await saveFile(apiRootDir, group, file.replace('.js', ''), environment);
+        }
+        logger_1.logger.success('All APIs saved successfully!');
+    }
+    else {
+        // Save specific API
+        const api = parts[1];
+        await saveFile(apiRootDir, group, api, environment);
+    }
+};
+exports.save = save;
+const saveFile = async (apiRootDir, group, api, environment) => {
+    const filePath = path_1.default.join(apiRootDir, group, `${api}.js`);
+    if (!fs_1.default.existsSync(filePath)) {
+        logger_1.logger.error(`File ${filePath} not found`);
+        return;
+    }
+    const handler = fs_1.default.readFileSync(filePath, 'utf-8');
+    try {
+        const res = await apiClient_1.apiClient.post('/api/management/save', {
+            group,
+            api,
+            handler,
+            environment
+        });
+        logger_1.logger.success(`${group}/${api}.js -> Saved (Version: ${res.data.version})`);
+    }
+    catch (error) {
+        logger_1.logger.error(`Failed to save ${group}/${api}: ${error.response?.data?.error || error.message}`);
+    }
+};

package/dist/index.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const login_1 = require("./cli/login");
+const create_1 = require("./cli/create");
+const save_1 = require("./cli/save");
+const get_1 = require("./cli/get");
+const history_1 = require("./cli/history");
+const rollback_1 = require("./cli/rollback");
+const program = new commander_1.Command();
+program
+    .name('cf')
+    .description('Cloud Function CLI')
+    .version('1.0.0');
+program
+    .command('login')
+    .description('Login to the system')
+    .action(login_1.login);
+program
+    .command('create <name>')
+    .description('Create a new API (e.g., group/api)')
+    .action(create_1.create);
+program
+    .command('save <name>')
+    .description('Save API to server')
+    .option('-e, --env <env>', 'Environment (dev/prod)')
+    .action(save_1.save);
+program
+    .command('get <name>')
+    .description('Get API from server')
+    .option('-e, --env <env>', 'Environment (dev/prod)')
+    .action(get_1.get);
+program
+    .command('history <name>')
+    .description('Show version history')
+    .option('-e, --env <env>', 'Environment (dev/prod)')
+    .action(history_1.history);
+program
+    .command('rollback <name> <version>')
+    .description('Rollback to a specific version')
+    .option('-e, --env <env>', 'Environment (dev/prod)')
+    .action(rollback_1.rollback);
+program.parse(process.argv);

package/dist/services/apiClient.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const config_1 = require("../utils/config");
+const logger_1 = require("../utils/logger");
+const getClient = () => {
+    const cfg = config_1.config.get();
+    const client = axios_1.default.create({
+        baseURL: cfg.apiBaseUrl,
+        timeout: 10000
+    });
+    client.interceptors.request.use((req) => {
+        const cfg = config_1.config.get();
+        if (cfg.token) {
+            req.headers.Authorization = `Bearer ${cfg.token}`;
+        }
+        return req;
+    });
+    client.interceptors.response.use((res) => res, (error) => {
+        if (error.response?.status === 401) {
+            logger_1.logger.error('Token expired or invalid. Please login again.');
+        }
+        return Promise.reject(error);
+    });
+    return client;
+};
+exports.apiClient = {
+    get: (url, params) => getClient().get(url, { params }),
+    post: (url, data) => getClient().post(url, data),
+    put: (url, data) => getClient().put(url, data),
+    delete: (url) => getClient().delete(url)
+};

package/dist/template/api-template.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiTemplate = void 0;
+exports.apiTemplate = `async function handler(context) {
+  const { log, cacher, options, utils, mongo, http, https, request, response } = context
+
+  let query = request.query
+  let data = request.body
+
+  return { code: 1, data: data || query }
+}
+`;

package/dist/utils/config.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const CONFIG_DIR = path_1.default.join(os_1.default.homedir(), '.cloud-function');
+const CONFIG_FILE = path_1.default.join(CONFIG_DIR, 'config.json');
+const defaultConfig = {
+    apiBaseUrl: 'http://localhost:3000',
+    environment: 'dev'
+};
+exports.config = {
+    get: () => {
+        if (!fs_1.default.existsSync(CONFIG_FILE)) {
+            return defaultConfig;
+        }
+        try {
+            return { ...defaultConfig, ...JSON.parse(fs_1.default.readFileSync(CONFIG_FILE, 'utf-8')) };
+        }
+        catch {
+            return defaultConfig;
+        }
+    },
+    set: (newConfig) => {
+        if (!fs_1.default.existsSync(CONFIG_DIR)) {
+            fs_1.default.mkdirSync(CONFIG_DIR, { recursive: true });
+        }
+        const current = exports.config.get();
+        fs_1.default.writeFileSync(CONFIG_FILE, JSON.stringify({ ...current, ...newConfig }, null, 2));
+    },
+    clear: () => {
+        if (fs_1.default.existsSync(CONFIG_FILE)) {
+            fs_1.default.unlinkSync(CONFIG_FILE);
+        }
+    }
+};

package/dist/utils/logger.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+exports.logger = {
+    info: (msg) => console.log(chalk_1.default.blue(msg)),
+    success: (msg) => console.log(chalk_1.default.green('✓ ' + msg)),
+    warn: (msg) => console.log(chalk_1.default.yellow('⚠️  ' + msg)),
+    error: (msg) => console.log(chalk_1.default.red('✗ ' + msg)),
+    debug: (msg) => {
+        if (process.env.DEBUG)
+            console.log(chalk_1.default.gray(msg));
+    }
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "cloud-function-cli",
+  "version": "1.0.0",
+  "description": "CLI for Cloud Function System - Create, deploy, and manage serverless functions",
+  "main": "dist/index.js",
+  "bin": {
+    "cf": "dist/index.js"
+  },
+  "scripts": {
+    "start": "node dist/index.js",
+    "cf": "node dist/index.js",
+    "dev": "ts-node src/index.ts",
+    "cli": "ts-node src/index.ts",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"No tests yet\" && exit 0"
+  },
+  "keywords": [
+    "cli",
+    "cloud-function",
+    "serverless",
+    "api",
+    "function",
+    "deploy",
+    "deploy-tool",
+    "cloud",
+    "aws-lambda",
+    "azure-functions"
+  ],
+  "author": "Your Name <your.email@example.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-username/cloud-function.git"
+  },
+  "homepage": "https://github.com/your-username/cloud-function#readme",
+  "bugs": {
+    "url": "https://github.com/your-username/cloud-function/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "axios": "^1.6.7",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "dotenv": "^16.4.1",
+    "inquirer": "^8.2.6"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^20.11.16",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}