db-json-cli 1.0.0 → 1.0.1

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 hitorigotoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,108 @@
+# 📦 db-json-cli
+
+> Lightweight local JSON API server with JWT auth + private/public route control  
+> 완전한 로컬 목서버 + 인증/권한 제어 CLI 툴
+
+--------------
+
+## 🚀 설치
+
+npm install -g db-json-cli
+또는 프로젝트 내부에서:
+
+bash
+npm install db-json-cli
+⚙️ 사용법
+1️⃣ 서버 시작
+db-json-cli --db ./db.json --port 4000
+기본 포트는 4000, JSON 파일 경로는 ./db.json
+
+2️⃣ 기본 JSON 구조 예시
+
+{
+"users": [],
+"list": [
+{ "id": 1, "title": "Private item" },
+{ "id": 2, "title": "Visible to authenticated users only" }
+],
+"public": [
+{ "id": 1, "title": "Publicly visible item" }
+],
+"rules": {
+"list": "private",
+"public": "public"
+}
+}
+
+rules 객체에 각 컬렉션의 접근 권한(public / private)을 지정합니다.
+
+### 🔐 엔드포인트
+
+✅ 회원가입
+POST /register
+
+요청 예시
+{
+"email": "user@test.com",
+"password": "1234",
+"name": "tester"
+}
+
+응답 예시
+{
+"accessToken": "xxxxx.yyyyy.zzzzz",
+"refreshToken": "xxxxx.yyyyy.zzzzz"
+}
+
+✅ 로그인
+POST /login
+
+요청 예시
+{
+"email": "user@test.com",
+"password": "1234"
+}
+
+응답 예시
+{
+"accessToken": "xxxxx.yyyyy.zzzzz",
+"refreshToken": "xxxxx.yyyyy.zzzzz"
+}
+
+
+
+#### 🔒 Private 데이터 조회 (인증 필요)
+GET /list
+또는 특정 ID만 조회:
+GET /list/1
+요청 헤더에 JWT 토큰 필요:
+Authorization: Bearer <accessToken>
+
+
+##### 🌐 Public 데이터 조회 (누구나 가능)
+
+GET /public
+또는:
+
+GET /public/1
+
+📨 데이터 추가 (POST)
+POST /list
+POST /public
+
+예시
+{ "id": 3, "title": "New item" }
+
+🧠 CLI 옵션
+
+--db JSON DB 파일 경로 ./db.json
+--port 서버 포트 번호 4000
+--watch 파일 변경 시 자동 리로드 false
+
+📄 예시 실행
+db-json-cli --db ./example.json --port 5000
+/register, /login 인증 지원
+
+/list, /public 접근 제어
+
+실시간 JSON 변경 자동 반영 (watch 옵션 시)

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "db-json-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "license": "MIT",
   "description": "JSON file based backend server with JWT auth and CLI",
   "bin": {
     "db-json-cli": "./bin/db-json-cli.js"

package/src/auth.js

@@ -4,22 +4,22 @@ import bcrypt from "bcryptjs";
 const ACCESS_SECRET = "access-secret";
 const REFRESH_SECRET = "refresh-secret";
 
-export async function hashPassword(password) {
+export const hashPassword = async (password) => {
   const salt = await bcrypt.genSalt(10);
   return bcrypt.hash(password, salt);
-}
+};
 
-export async function comparePassword(password, hash) {
+export const comparePassword = async (password, hash) => {
   return bcrypt.compare(password, hash);
-}
+};
 
-export function generateTokens(payload) {
+export const generateTokens = async (payload) => {
   const accessToken = jwt.sign(payload, ACCESS_SECRET, { expiresIn: "1h" });
   const refreshToken = jwt.sign(payload, REFRESH_SECRET, { expiresIn: "7d" });
   return { accessToken, refreshToken };
-}
+};
 
-export function authMiddleware(req, res, next) {
+export const authMiddleware = async (req, res, next) => {
   const auth = req.headers["authorization"];
   if (!auth) return res.status(401).json({ message: "No token" });
 
@@ -31,115 +31,4 @@ export function authMiddleware(req, res, next) {
   } catch (e) {
     return res.status(401).json({ message: "Invalid token" });
   }
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+};

package/src/server.js

@@ -4,19 +4,18 @@ import bodyParser from "body-parser";
 import cors from "cors";
 import { hashPassword, comparePassword, generateTokens, authMiddleware } from "./auth.js";
 
-export async function startServer(dbPath, port = 4000) {
+export const startServer = async (dbPath, port = 4000) => {
   const app = express();
   app.use(cors());
   app.use(bodyParser.json());
 
-  // 초기 JSON 읽기
-  let db = { users: [], list: [] };
+  // JSON Load
+  let db = { users: [], rules: {} };
   if (fs.existsSync(dbPath)) db = await fs.readJson(dbPath);
 
-  // JSON 저장 함수
   const saveDB = async () => fs.writeJson(dbPath, db, { spaces: 2 });
 
-  // ================== REGISTER ==================
+  // 🔹 REGISTER
   app.post("/register", async (req, res) => {
     const { email, password, name } = req.body;
     if (!email || !password) return res.status(400).json({ message: "Email/password required" });
@@ -34,7 +33,7 @@ export async function startServer(dbPath, port = 4000) {
     res.json(tokens);
   });
 
-  // ================== LOGIN ==================
+  // 🔹 LOGIN
   app.post("/login", async (req, res) => {
     const { email, password } = req.body;
     const user = db.users.find((u) => u.email === email);
@@ -47,10 +46,53 @@ export async function startServer(dbPath, port = 4000) {
     res.json(tokens);
   });
 
-  // ================== GET LIST (Protected) ==================
-  app.get("/list", authMiddleware, (req, res) => {
-    res.json(db.list);
+  // 🔹 AUTO ROUTES
+  Object.keys(db).forEach((key) => {
+    if (["users", "rules"].includes(key)) return;
+    const isPrivate = db.rules?.[key] === "private";
+
+    const route = express.Router();
+
+    // ✅ GET /key
+    route.get("/", async (req, res) => {
+      const { from, to } = req.query;
+      let data = db[key];
+
+      if (from && to) {
+        const fromNum = Number(from);
+        const toNum = Number(to);
+        data = data.filter((item) => item.id >= fromNum && item.id <= toNum);
+      }
+
+      res.json(data);
+    });
+
+    // ✅ GET /key/:id
+    route.get("/:id", async (req, res) => {
+      const id = Number(req.params.id);
+      const item = db[key].find((i) => i.id === id);
+      if (!item) return res.status(404).json({ message: "Not found" });
+      res.json(item);
+    });
+
+    // ✅ POST /key
+    route.post("/", async (req, res) => {
+      const newItem = req.body;
+      if (!newItem || typeof newItem !== "object") return res.status(400).json({ message: "Invalid body" });
+
+      const id = db[key].length ? Math.max(...db[key].map((i) => i.id)) + 1 : 1;
+      const item = { id, ...newItem };
+      db[key].push(item);
+      await saveDB();
+      res.json(item);
+    });
+
+    if (isPrivate) {
+      app.use(`/${key}`, authMiddleware, route);
+    } else {
+      app.use(`/${key}`, route);
+    }
   });
 
-  app.listen(port, () => console.log(`db-json-cli server running on port ${port}`));
-}
+  app.listen(port, () => console.log(`✅ db-json-cli running on http://localhost:${port}`));
+};