create-entity-server 0.0.9

package/bin/create.js

@@ -0,0 +1,280 @@
+#!/usr/bin/env node
+/**
+ * create-entity-server
+ *
+ * CRA / create-vite 와 동일한 UX 로 entity-server 프로젝트를 초기화합니다.
+ *
+ * 사용법:
+ *   npx create-entity-server            → ./entity-server/ 생성
+ *   npx create-entity-server my-api     → ./my-api/ 생성
+ *   npm create entity-server my-api     → 동일
+ */
+
+"use strict";
+
+const https = require("https");
+const http = require("http");
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
+
+// ─── 버전 / 설정 ──────────────────────────────────────────────────────────────
+
+const pkg = require("../package.json");
+const VERSION = pkg.version;
+const REPO = "ehfuse/entity-server";
+const isWin = process.platform === "win32";
+const binExt = isWin ? ".exe" : "";
+
+const PLATFORM_MAP = { linux: "linux", darwin: "darwin", win32: "windows" };
+const ARCH_MAP = { x64: "x64", arm64: "arm64" };
+const platform = PLATFORM_MAP[os.platform()];
+const arch = ARCH_MAP[os.arch()];
+
+// ─── 도움말 ───────────────────────────────────────────────────────────────────
+
+function printHelp() {
+    console.log(`
+create-entity-server v${VERSION}
+
+사용법:
+  npx create-entity-server [폴더명]
+  npm create entity-server [폴더명]
+
+예시:
+  npx create-entity-server             # → ./entity-server/
+  npx create-entity-server my-api      # → ./my-api/
+  npx create-entity-server ./projects/order-api
+
+옵션:
+  --skip-binary    바이너리 다운로드 건너뜀 (나중에 수동 추가)
+  --help, -h       이 도움말 출력
+`);
+}
+
+// ─── 헬퍼 ─────────────────────────────────────────────────────────────────────
+
+function copyFile(src, dest, mode) {
+    if (!fs.existsSync(src)) return false;
+    fs.mkdirSync(path.dirname(dest), { recursive: true });
+    fs.copyFileSync(src, dest);
+    if (mode != null) {
+        try {
+            fs.chmodSync(dest, mode);
+        } catch (_) {}
+    }
+    return true;
+}
+
+function copyDir(src, dest) {
+    if (!fs.existsSync(src)) return;
+    fs.mkdirSync(dest, { recursive: true });
+    for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+        const s = path.join(src, entry.name);
+        const d = path.join(dest, entry.name);
+        if (entry.isDirectory()) copyDir(s, d);
+        else fs.copyFileSync(s, d);
+    }
+}
+
+/** HTTP/HTTPS 리다이렉트를 따라가며 파일을 다운로드합니다. */
+function download(url, dest, redirectCount = 0) {
+    return new Promise((resolve, reject) => {
+        if (redirectCount > 5) return reject(new Error("너무 많은 리다이렉트"));
+
+        const client = url.startsWith("https") ? https : http;
+        const req = client.get(url, (res) => {
+            if (
+                res.statusCode >= 300 &&
+                res.statusCode < 400 &&
+                res.headers.location
+            ) {
+                return download(res.headers.location, dest, redirectCount + 1)
+                    .then(resolve)
+                    .catch(reject);
+            }
+            if (res.statusCode !== 200) {
+                // 응답 body 를 버려야 소켓이 정리됨
+                res.resume();
+                return reject(new Error(`HTTP ${res.statusCode}: ${url}`));
+            }
+
+            const tmp = dest + ".tmp";
+            const file = fs.createWriteStream(tmp);
+            res.pipe(file);
+            file.on("finish", () => {
+                file.close(() => {
+                    fs.renameSync(tmp, dest);
+                    resolve();
+                });
+            });
+            file.on("error", (err) => {
+                try {
+                    fs.unlinkSync(tmp);
+                } catch (_) {}
+                reject(err);
+            });
+        });
+
+        req.on("error", reject);
+        req.setTimeout(120_000, () => {
+            req.destroy();
+            reject(new Error("다운로드 타임아웃 (120s)"));
+        });
+    });
+}
+
+// ─── 메인 ─────────────────────────────────────────────────────────────────────
+
+async function run() {
+    const argv = process.argv.slice(2);
+    const skipBinary = argv.includes("--skip-binary");
+    const filtered = argv.filter((a) => !a.startsWith("-"));
+
+    if (argv.includes("--help") || argv.includes("-h")) {
+        printHelp();
+        process.exit(0);
+    }
+
+    // 대상 폴더 결정
+    const dirName = filtered[0] ?? "entity-server";
+    const targetDir = path.resolve(process.cwd(), dirName);
+
+    // 이미 비어있지 않은 폴더면 중단
+    if (fs.existsSync(targetDir)) {
+        const entries = fs.readdirSync(targetDir);
+        if (entries.length > 0) {
+            console.error(
+                `\n오류: '${dirName}' 폴더가 이미 존재하고 비어있지 않습니다.`,
+            );
+            console.error(`다른 이름을 사용하거나 빈 폴더를 지정하세요.\n`);
+            process.exit(1);
+        }
+    }
+
+    const templateDir = path.resolve(__dirname, "..", "template");
+
+    console.log(`\n  create-entity-server v${VERSION}`);
+    console.log(`  폴더 생성 중: ${targetDir}\n`);
+
+    // ── 1. 템플릿 파일 복사 ────────────────────────────────────────────────────
+
+    // scripts/ — OS별 파일만 복사
+    //   Windows    : .ps1 만 (쉘 스크립트 제외)
+    //   Linux/macOS: .sh  만 (PowerShell 제외)
+    const scriptsSrc = path.join(templateDir, "scripts");
+    const scriptsDest = path.join(targetDir, "scripts");
+    if (fs.existsSync(scriptsSrc)) {
+        fs.mkdirSync(scriptsDest, { recursive: true });
+        for (const f of fs.readdirSync(scriptsSrc)) {
+            if (isWin && !f.endsWith(".ps1")) continue;
+            if (!isWin && !f.endsWith(".sh")) continue;
+            fs.copyFileSync(
+                path.join(scriptsSrc, f),
+                path.join(scriptsDest, f),
+            );
+        }
+        // Linux/macOS: 실행 권한 부여
+        if (!isWin) {
+            for (const f of fs.readdirSync(scriptsDest)) {
+                try {
+                    fs.chmodSync(path.join(scriptsDest, f), 0o755);
+                } catch (_) {}
+            }
+        }
+    }
+
+    // configs/
+    copyDir(path.join(templateDir, "configs"), path.join(targetDir, "configs"));
+
+    // entities/ (샘플 스키마)
+    copyDir(
+        path.join(templateDir, "entities"),
+        path.join(targetDir, "entities"),
+    );
+
+    // .env.example 복사 + .env 생성 (없을 때만)
+    copyFile(
+        path.join(templateDir, ".env.example"),
+        path.join(targetDir, ".env.example"),
+    );
+    if (!fs.existsSync(path.join(targetDir, ".env"))) {
+        copyFile(
+            path.join(templateDir, ".env.example"),
+            path.join(targetDir, ".env"),
+        );
+    }
+
+    console.log("  ✓ 설정 파일 복사 완료");
+
+    // ── 2. 바이너리 다운로드 ──────────────────────────────────────────────────
+
+    if (!skipBinary) {
+        if (!platform || !arch) {
+            console.warn(
+                `\n  경고: 미지원 플랫폼 (${os.platform()}/${os.arch()})`,
+            );
+            console.warn(
+                `  --skip-binary 옵션 후 수동으로 바이너리를 복사하세요.`,
+            );
+            console.warn(`  https://github.com/${REPO}/releases\n`);
+        } else {
+            for (const bin of ["entity-server", "entity-cli"]) {
+                const ext = platform === "windows" ? ".exe" : "";
+                const fileName = `${bin}-${platform}-${arch}${ext}`;
+                const url = `https://github.com/${REPO}/releases/download/v${VERSION}/${fileName}`;
+                const dest = path.join(targetDir, bin + ext);
+
+                process.stdout.write(`  ↓ ${fileName} 다운로드 중...`);
+                try {
+                    await download(url, dest);
+                    fs.chmodSync(dest, 0o755);
+                    console.log(" ✓");
+                } catch (err) {
+                    console.log(" ✗ 실패");
+                    console.warn(`    ${err.message}`);
+                    console.warn(`    나중에 수동으로 다운로드하세요: ${url}`);
+                }
+            }
+        }
+    } else {
+        console.log("  ↷ 바이너리 건너뜀 (--skip-binary)");
+    }
+
+    // ── 3. 완료 안내 ─────────────────────────────────────────────────────────
+
+    const relDir = path.relative(process.cwd(), targetDir) || dirName;
+    const serverExe = isWin ? ".\\entity-server.exe" : "./entity-server";
+    const cliExe = isWin ? ".\\entity-cli.exe" : "./entity-cli";
+    const runScript = isWin
+        ? ".\\scripts\\run.ps1 start"
+        : "./scripts/run.sh start";
+    const cdCmd = relDir !== "." ? `cd ${relDir}` : "";
+
+    console.log(`
+  ✓ 완료!
+
+  ${relDir}/
+  ├── entity-server${binExt}   ← 서버 바이너리
+  ├── entity-cli${binExt}      ← CLI 도구
+  ├── .env                ← 환경 변수 설정 (여기를 먼저 수정하세요)
+  ├── configs/            ← CORS, JWT 등 서버 설정
+  ├── entities/           ← 엔티티 스키마 JSON (샘플 포함)
+  └── scripts/            ← 운영 스크립트
+
+  다음 단계:
+${cdCmd ? `    ${cdCmd}` : ""}
+    nano .env             # PORT, DB_PATH, 암호화 키 설정
+    ${serverExe}          # 서버 실행
+
+  서버마다 .env 의 PORT 와 DB_PATH 를 다르게 설정하면
+  같은 머신에서 여러 프로젝트를 동시에 운영할 수 있습니다.
+
+  문서: https://github.com/${REPO}#readme
+`);
+}
+
+run().catch((err) => {
+    console.error(`\n오류: ${err.message}\n`);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "create-entity-server",
+  "version": "0.0.9",
+  "description": "Create a new entity-server project in one command — like create-react-app or create-vite.",
+  "keywords": [
+    "entity-server",
+    "create",
+    "scaffold",
+    "api-server",
+    "crud",
+    "rest-api",
+    "schema-driven"
+  ],
+  "homepage": "https://github.com/ehfuse/entity-server",
+  "bugs": {
+    "url": "https://github.com/ehfuse/entity-server/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ehfuse/entity-server.git"
+  },
+  "license": "MIT",
+  "bin": {
+    "create-entity-server": "bin/create.js"
+  },
+  "files": [
+    "bin/create.js",
+    "template/"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "linux",
+    "darwin",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ]
+}

package/template/.env.example

@@ -0,0 +1,14 @@
+# Entity Server 환경변수 설정 예시
+# 실제 사용시 이 파일을 .env로 복사하고 값을 변경하세요: cp .env.example .env
+
+# 기본 암복호화 키 (license 엔티티 등 공통 fallback 키)
+# 32자 16진수 문자열 (128bit AES-CTR 키)
+ENCRYPTION_KEY=your-32-char-hex-encryption-key-here
+
+# JWT 서명 키 (HS256)
+# 운영에서는 충분히 긴 랜덤 시크릿을 사용하세요.
+JWT_SECRET=your-jwt-secret-here
+
+# Database passwords (database.json의 password_env와 매핑)
+DB_PASSWORD_DEVELOPMENT=your-development-db-password
+DB_PASSWORD_PRODUCTION=your-production-db-password

package/template/configs/cache.json

@@ -0,0 +1,22 @@
+{
+    "description": "전역 캐시 설정. driver는 memory | file | memcached(memcache) | redis 지원. 엔티티별 설정(cache)은 이 기본값을 override.",
+    "defaults": {
+        "enabled": true,
+        "driver": "memory",
+        "ttl_seconds": 60
+    },
+    "drivers": {
+        "file": {
+            "dir": ".cache/entity"
+        },
+        "memcached": {
+            "servers": ["127.0.0.1:11211"]
+        },
+        "redis": {
+            "addr": "127.0.0.1:6379",
+            "password": "",
+            "db": 0,
+            "prefix": "entity_cache:"
+        }
+    }
+}

package/template/configs/cors.json

@@ -0,0 +1,7 @@
+{
+    "cors_enabled": true,
+    "cors_allow_credentials": false,
+    "cors_allow_headers": "Origin,Content-Type,Accept,Authorization,X-API-Key,X-Signature,X-Timestamp,X-Nonce,X-Transaction-ID",
+    "cors_allow_methods": "GET,POST,PUT,PATCH,DELETE,OPTIONS",
+    "cors_allow_origins": "*"
+}

package/template/configs/database.json

@@ -0,0 +1,23 @@
+{
+    "default": "development",
+    "groups": {
+        "development": {
+            "driver": "mysql",
+            "host": "127.0.0.1",
+            "port": 3306,
+            "database": "entity_server",
+            "user": "root",
+            "password": "${DB_PASSWORD_DEVELOPMENT}",
+            "maxOpenConns": 20
+        },
+        "production": {
+            "driver": "mysql",
+            "host": "127.0.0.1",
+            "port": 3306,
+            "database": "entity_server",
+            "user": "entity_user",
+            "password": "${DB_PASSWORD_PRODUCTION}",
+            "maxOpenConns": 50
+        }
+    }
+}

package/template/configs/jwt.json

@@ -0,0 +1,7 @@
+{
+    "secret": "${JWT_SECRET}",
+    "access_ttl_sec": 3600,
+    "refresh_ttl_sec": 1209600,
+    "issuer": "entity-server",
+    "algorithm": "HS256"
+}

package/template/configs/logging.json

@@ -0,0 +1,45 @@
+{
+    "level": "INFO",
+    "directory": "logs",
+    "access": {
+        "enabled": true,
+        "filename": "access.log",
+        "max_size_mb": 100,
+        "max_backups": 7,
+        "max_age_days": 14,
+        "compress": true
+    },
+    "error": {
+        "enabled": true,
+        "filename": "error.log",
+        "max_size_mb": 100,
+        "max_backups": 7,
+        "max_age_days": 30,
+        "compress": true
+    },
+    "cli": {
+        "enabled": true,
+        "filename": "cli.log",
+        "max_size_mb": 100,
+        "max_backups": 7,
+        "max_age_days": 14,
+        "compress": true
+    },
+    "slow": {
+        "enabled": true,
+        "filename": "slow.log",
+        "max_size_mb": 100,
+        "max_backups": 7,
+        "max_age_days": 14,
+        "compress": true,
+        "threshold_ms": 1000
+    },
+    "environments": {
+        "development": {
+            "level": "DEBUG",
+            "slow": {
+                "threshold_ms": 300
+            }
+        }
+    }
+}

package/template/configs/security.json

@@ -0,0 +1,21 @@
+{
+    "enable_hmac": false,
+    "enable_rbac": true,
+    "enable_packet_encryption": false,
+    "packet_magic_len": 4,
+    "timestamp_skew_sec": 300,
+    "nonce_ttl_sec": 300,
+    "nonce_store": {
+        "driver": "redis",
+        "memcache_servers": ["localhost:11211"],
+        "redis_addr": "localhost:6379",
+        "redis_password": "",
+        "redis_db": 0,
+        "redis_prefix": "nonce:"
+    },
+    "environments": {
+        "production": {
+            "enable_packet_encryption": true
+        }
+    }
+}

package/template/configs/server.json

@@ -0,0 +1,10 @@
+{
+    "namespace": "entity-prod",
+    "default_email_domain": "example.com",
+    "language": "ko",
+    "environment": "production",
+    "port": 47200,
+    "enable_auto_schema_sync": true,
+    "global_license_scope": true,
+    "global_optimistic_lock": false
+}

package/template/entities/Account/account_audit.json

@@ -0,0 +1,17 @@
+{
+    "name": "account_audit",
+    "description": "account_audit Entity",
+    "index": {
+        "account_seq": {
+            "comment": "계정 seq",
+            "type": "bigint",
+            "required": true
+        },
+        "action": {
+            "comment": "작업 유형",
+            "type": ["INSERT", "UPDATE", "DELETE", "LOGIN", "LOGOUT"],
+            "required": true
+        }
+    },
+    "license_scope": false
+}

package/template/entities/Auth/account.json

@@ -0,0 +1,60 @@
+{
+    "name": "account",
+    "description": "JWT 로그인/인증 계정 예제",
+    "index": {
+        "user_seq": {
+            "comment": "사용자번호"
+        },
+        "email": {
+            "comment": "이메일",
+            "type": "email",
+            "required": true,
+            "unique": true
+        },
+        "status": {
+            "comment": "상태",
+            "type": ["active", "inactive", "blocked"],
+            "default": "active"
+        },
+        "rbac_role": {
+            "comment": "RBAC 역할 (JWT 인증/인가에 사용)",
+            "type": ["admin", "editor", "viewer", "auditor", "user"],
+            "default": "user"
+        }
+    },
+    "fk": {
+        "user_seq": "user.seq"
+    },
+    "reset_defaults": [
+        {
+            "email": "admin@example.com",
+            "passwd": "admin12345",
+            "rbac_role": "admin",
+            "status": "active"
+        }
+    ],
+    "hooks": {
+        "before_insert": [
+            {
+                "type": "submit",
+                "entity": "user",
+                "match": {
+                    "email": "${new.email}"
+                },
+                "data": {
+                    "email": "${new.email}",
+                    "status": "active"
+                },
+                "assign_seq_to": "user_seq"
+            }
+        ],
+        "after_insert": [
+            {
+                "type": "sql",
+                "query": "INSERT INTO account_audit (account_seq, action, email, created_time) VALUES (?, ?, ?, NOW())",
+                "params": ["${new.seq}", "INSERT", "${new.email}"],
+                "async": false
+            }
+        ]
+    }
+}

package/template/entities/Auth/api_keys.json

@@ -0,0 +1,26 @@
+{
+    "name": "api_keys",
+    "license_scope": false,
+    "description": "API 키 및 HMAC 시크릿 관리",
+    "index": {
+        "key_value": {
+            "comment": "API 키 값 (해시 저장)",
+            "required": true,
+            "unique": true,
+            "hash": true
+        },
+        "enabled": {
+            "comment": "활성 여부",
+            "type": "bool",
+            "default": true
+        },
+        "user_seq": {
+            "comment": "발급 대상 사용자 seq (nullable, user 엔티티 참조)"
+        }
+    },
+    "types": {
+        "hmac_secret": "text",
+        "entities": "text"
+    },
+    "hard_delete": true
+}

package/template/entities/Auth/license.json

@@ -0,0 +1,36 @@
+{
+    "name": "license",
+    "description": "license Entity",
+    "index": {
+        "name": {
+            "comment": "라이선스명",
+            "required": true,
+            "unique": true
+        },
+        "contract_date": {
+            "comment": "계약일"
+        },
+        "expire_date": {
+            "comment": "만료일"
+        },
+        "status": {
+            "comment": "상태",
+            "type": ["active", "expired", "suspended"],
+            "default": "active"
+        }
+    },
+    "defaults": {
+        "max_users": 100
+    },
+    "types": {},
+    "reset_defaults": [
+        {
+            "name": "Trial License",
+            "contract_date": "2026-01-01",
+            "expire_date": "2026-12-31",
+            "status": "active",
+            "max_users": 10,
+            "contact_email": "trial@example.com"
+        }
+    ]
+}