panel-free 1.0.2 → 1.0.3

package/README.md

@@ -1,19 +1,5 @@
 # panel-free
 
-Reusable SQLite + Express + EJS web panel for student exam projects.
+A free, simple web panel template for small projects. Built with Node.js, TypeScript, Express, EJS, and SQLite.
 
-## Version 1.0.2 fixes
-
-- Home/data/reports/admin data are preserved during EJS rendering.
-- Consumer TypeScript projects receive the required Express and better-sqlite3 type packages.
-- Public `Db` declaration is compatible with common TypeScript module settings.
-- CLI fallback remains available through `exports.default`.
-
-Main exam usage:
-
-```powershell
-npm install panel-free
-npx panel-free
-```
-
-The CLI starts `main.ts` from the current directory.
+Created by Alex Maksimov.

package/dist/main.md

@@ -0,0 +1,194 @@
+import { num, panel, sqlite, type RequestBody } from "panel-free";
+import { Service } from "./Service.js";
+
+const db = sqlite("project.db");
+
+db.exec(`
+  CREATE TABLE IF NOT EXISTS categories (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    name TEXT NOT NULL UNIQUE
+  );
+
+  CREATE TABLE IF NOT EXISTS users (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    name TEXT NOT NULL,
+    login TEXT NOT NULL UNIQUE,
+    password TEXT NOT NULL,
+    role TEXT NOT NULL CHECK (role IN ('user', 'manager', 'admin'))
+  );
+
+  CREATE TABLE IF NOT EXISTS records (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    title TEXT NOT NULL,
+    status TEXT NOT NULL,
+    category_id INTEGER NOT NULL,
+    user_id INTEGER NOT NULL,
+    FOREIGN KEY (category_id) REFERENCES categories(id),
+    FOREIGN KEY (user_id) REFERENCES users(id)
+  );
+`);
+
+const categoryCount = db.prepare("SELECT COUNT(*) AS total FROM categories").get() as { total: number };
+if (categoryCount.total === 0) {
+  db.exec(`
+    INSERT INTO categories (name) VALUES ('Категория 1'), ('Категория 2');
+  `);
+}
+
+const userCount = db.prepare("SELECT COUNT(*) AS total FROM users").get() as { total: number };
+if (userCount.total === 0) {
+  db.exec(`
+    INSERT INTO users (name, login, password, role) VALUES
+      ('Пользователь', 'user', 'user', 'user'),
+      ('Менеджер', 'manager', 'manager', 'manager'),
+      ('Администратор', 'admin', 'admin', 'admin');
+  `);
+}
+
+const recordCount = db.prepare("SELECT COUNT(*) AS total FROM records").get() as { total: number };
+if (recordCount.total === 0) {
+  const userId = db.prepare("SELECT id FROM users WHERE login = 'user'").get() as { id: number };
+  const managerId = db.prepare("SELECT id FROM users WHERE login = 'manager'").get() as { id: number };
+  db.exec(`
+    INSERT INTO records (title, status, category_id, user_id) VALUES
+      ('Пример заявки пользователя', 'new', 1, ${userId.id}),
+      ('Пример заявки менеджера', 'done', 2, ${managerId.id});
+  `);
+}
+
+const service = new Service(db);
+panel({
+  title: "Описание проекта",
+  port: 3000,
+  db,
+  logger: true,
+  labels: {
+    home: "Главная",
+    data: "Данные",
+    reports: "Аналитика",
+    reportsTitle: "Аналитические SQL-запросы",
+    empty: "Нет данных",
+    defaultSubmit: "Сохранить",
+    login: "Вход",
+    register: "Регистрация",
+    logout: "Выйти",
+    admin: "Админ-панель",
+    myRecords: "Мои заявки",
+    allRecords: "Все заявки"
+  },
+  auth: {
+    onLogin: (body: RequestBody) => service.login(String(body.login ?? ""), String(body.password ?? "")),
+    onRegister: (body: RequestBody) => service.register(
+      String(body.name ?? ""),
+      String(body.login ?? ""),
+      String(body.password ?? "")
+    )
+  },
+  records: {
+    listSql: (user) => user.role === "user"
+      ? `
+          SELECT r.id, r.title, r.status, c.name AS category
+          FROM records r
+          JOIN categories c ON c.id = r.category_id
+          WHERE r.user_id = ${user.id}
+          ORDER BY r.id DESC
+        `
+      : `
+          SELECT r.id, r.title, r.status, c.name AS category, u.name AS user
+          FROM records r
+          JOIN categories c ON c.id = r.category_id
+          JOIN users u ON u.id = r.user_id
+          ORDER BY r.id DESC
+        `,
+    form: {
+      title: "Добавить заявку",
+      action: "/create",
+      submit: "Добавить",
+      fields: {
+        title: { type: "text", label: "Название" },
+        categoryId: {
+          type: "select",
+          label: "Категория",
+          sql: "SELECT id, name FROM categories ORDER BY id"
+        },
+        userId: {
+          type: "select",
+          label: "Пользователь",
+          sql: "SELECT id, name FROM users ORDER BY id",
+          adminOnly: true
+        }
+      },
+      onSubmit: (body: RequestBody, user) => {
+        const ownerId = user.role === "admin" ? num(body.userId) : user.id;
+        service.create(String(body.title ?? ""), num(body.categoryId), ownerId);
+      }
+    },
+    admin: {
+      listSql: `
+        SELECT r.id,
+               r.title,
+               r.status,
+               r.category_id AS categoryId,
+               r.user_id AS userId
+        FROM records r
+        ORDER BY r.id DESC
+      `,
+      fields: {
+        title: { type: "text", label: "Название" },
+        status: {
+          type: "select",
+          label: "Статус",
+          sql: `
+            SELECT 'new' AS id, 'Новая' AS name
+            UNION ALL SELECT 'in_progress', 'В работе'
+            UNION ALL SELECT 'done', 'Завершена'
+            UNION ALL SELECT 'cancelled', 'Отменена'
+          `
+        },
+        categoryId: {
+          type: "select",
+          label: "Категория",
+          sql: "SELECT id, name FROM categories ORDER BY id"
+        },
+        userId: {
+          type: "select",
+          label: "Пользователь",
+          sql: "SELECT id, name FROM users ORDER BY id"
+        }
+      },
+      onUpdate: (id, body) => service.update(
+        id,
+        String(body.title ?? ""),
+        String(body.status ?? ""),
+        num(body.categoryId),
+        num(body.userId)
+      ),
+      onDelete: (id) => service.delete(id)
+    }
+  },
+  reports: {
+    "JOIN — связанные записи": `
+      SELECT r.title, c.name AS category, u.name AS user
+      FROM records r
+      JOIN categories c ON c.id = r.category_id
+      JOIN users u ON u.id = r.user_id
+    `,
+    "GROUP BY — количество по статусам": `
+      SELECT status, COUNT(*) AS total
+      FROM records
+      GROUP BY status
+    `,
+    "HAVING — статусы с количеством больше 1": `
+      SELECT status, COUNT(*) AS total
+      FROM records
+      GROUP BY status
+      HAVING COUNT(*) > 1
+    `,
+    "LEFT JOIN — категории без заявок": `
+      SELECT c.name AS category
+      FROM categories c
+      LEFT JOIN records r ON r.category_id = c.id
+      WHERE r.id IS NULL
+    `
+  }
+});

package/dist/quality.md

@@ -0,0 +1,26 @@
+```mermaid
+erDiagram
+    USERS ||--o{ RECORDS : creates
+    CATEGORIES ||--o{ RECORDS : classifies
+
+    USERS {
+        INTEGER id PK
+        TEXT name
+        TEXT login UK
+        TEXT password
+        TEXT role
+    }
+
+    CATEGORIES {
+        INTEGER id PK
+        TEXT name UK
+    }
+
+    RECORDS {
+        INTEGER id PK
+        TEXT title
+        TEXT status
+        INTEGER category_id FK
+        INTEGER user_id FK
+    }
+```

package/dist/ser.md

@@ -0,0 +1,85 @@
+import { fail, type Db, type PanelUser, type RequestBody } from "panel-free";
+
+type Row = { id: number };
+
+export class Service {
+  constructor(private db: Db) {}
+
+  login(login: string, password: string): PanelUser | null {
+    const row = this.db.prepare(`
+      SELECT id, name, login, role
+      FROM users
+      WHERE login = ? AND password = ?
+    `).get(login.trim(), password) as PanelUser | undefined;
+    return row ?? null;
+  }
+
+  register(name: string, login: string, password: string): PanelUser {
+    const cleanName = name.trim();
+    const cleanLogin = login.trim();
+    if (!cleanName) fail("Имя обязательно");
+    if (!cleanLogin) fail("Логин обязателен");
+    if (!password) fail("Пароль обязателен");
+
+    const exists = this.db.prepare("SELECT id FROM users WHERE login = ?").get(cleanLogin) as Row | undefined;
+    if (exists) fail("Такой логин уже занят");
+
+    const result = this.db
+      .prepare("INSERT INTO users (name, login, password, role) VALUES (?, ?, ?, 'user')")
+      .run(cleanName, cleanLogin, password);
+
+    return {
+      id: Number(result.lastInsertRowid),
+      name: cleanName,
+      login: cleanLogin,
+      role: "user"
+    };
+  }
+
+  create(title: string, categoryId: number, userId: number) {
+    if (typeof title !== "string" || !title.trim()) {
+      fail("Название обязательно");
+    }
+    const category = this.db
+      .prepare("SELECT id FROM categories WHERE id = ?")
+      .get(categoryId) as Row | undefined;
+    if (!category) fail("Категория не найдена");
+
+    const user = this.db
+      .prepare("SELECT id FROM users WHERE id = ?")
+      .get(userId) as Row | undefined;
+    if (!user) fail("Пользователь не найден");
+
+    this.db
+      .prepare("INSERT INTO records (title, status, category_id, user_id) VALUES (?, 'new', ?, ?)")
+      .run(title.trim(), categoryId, userId);
+  }
+
+  createForUser(body: RequestBody, user: PanelUser) {
+    this.create(String(body.title ?? ""), Number(body.categoryId), user.id);
+  }
+
+  update(id: number, title: string, status: string, categoryId: number, userId: number) {
+    if (!Number.isInteger(id) || id <= 0) fail("Некорректный ID записи");
+    if (!title.trim()) fail("Название обязательно");
+    if (!['new', 'in_progress', 'done', 'cancelled'].includes(status)) fail("Некорректный статус");
+
+    const record = this.db.prepare("SELECT id FROM records WHERE id = ?").get(id) as Row | undefined;
+    if (!record) fail("Запись не найдена");
+
+    const category = this.db.prepare("SELECT id FROM categories WHERE id = ?").get(categoryId) as Row | undefined;
+    if (!category) fail("Категория не найдена");
+
+    const user = this.db.prepare("SELECT id FROM users WHERE id = ?").get(userId) as Row | undefined;
+    if (!user) fail("Пользователь не найден");
+
+    this.db
+      .prepare("UPDATE records SET title = ?, status = ?, category_id = ?, user_id = ? WHERE id = ?")
+      .run(title.trim(), status, categoryId, userId, id);
+  }
+
+  delete(id: number) {
+    if (!Number.isInteger(id) || id <= 0) fail("Некорректный ID записи");
+    this.db.prepare("DELETE FROM records WHERE id = ?").run(id);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "panel-free",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Small reusable SQLite + Express + EJS web panel for student projects.",
   "type": "module",
   "main": "dist/index.js",