scdb-web 1.0.0

package/README.md

@@ -0,0 +1,60 @@
+# Secure DB
+
+A secure SQLite-based database with a web panel, terminal CLI, and Node.js client. Uses **sql.js** (no native build). Features authentication, RBAC, and audit logging.
+
+## Structure
+
+- **packages/core** – sql.js DB, parameterized queries, auth, audit
+- **packages/api** – HTTP API (exportable `createApp`) + serves web panel
+- **packages/web** – One-line embed: `import { init } from 'scdb-web'; init(env);`
+- **packages/lib** – Node.js client (`createClient`, `query`, `execute`)
+- **packages/web-panel** – Panel assets (HTML/CSS/JS) served by API
+- **packages/cli** – Terminal CLI (interactive + one-shot)
+
+## Setup
+
+1. Copy `.env.example` to `.env` and set `DATABASE_PATH` and `SESSION_SECRET`.
+2. Run `npm install` in the project root.
+3. Start the server: `npm start` (API + panel at http://localhost:3000).
+4. First time: open http://localhost:3000 and use **First-time setup** to create an admin user, then log in.
+5. Create an API key (for CLI/lib): as admin, call `POST /api-keys` with body `{ "name": "cli", "role": "readwrite" }`. Use the returned `key` in `SECURE_DB_API_KEY`.
+
+## Usage
+
+- **Web panel**: Open http://localhost:3000 — Tables, SQL editor, Audit log (admin).
+- **CLI**: `SECURE_DB_API_KEY=yourkey npm run cli` for interactive mode; `npm run cli -- run "SELECT 1"` or `npm run cli -- run -f query.sql` for one-shot.
+- **Node.js**: `import { createClient } from 'scdb-lib'; const client = createClient({ url: 'http://localhost:3000', apiKey: '...' }); const rows = await client.query('SELECT * FROM users', []);`
+
+## Integrating in other Node.js projects
+
+- **Web (API + panel)**  
+  Install and start the server with one call:
+  ```bash
+  npm install scdb-web
+  ```
+  ```js
+  import { init } from 'scdb-web';
+  init({ port: 3000, databasePath: './data/app.sqlite', sessionSecret: 'your-secret' });
+  ```
+  Optional `env` keys: `port`, `host`, `databasePath`, `sessionSecret`, `docsDir`.
+
+- **CLI**  
+  Install and run with env (or add to your `package.json` scripts):
+  ```bash
+  npm install scdb-cli
+  SECURE_DB_API_KEY=xxx SECURE_DB_API_URL=http://localhost:3000 npx secure-db
+  SECURE_DB_API_KEY=xxx npx secure-db run "SELECT 1"
+  SECURE_DB_API_KEY=xxx npx secure-db run -f script.sql
+  ```
+
+## Security
+
+- Auth: API keys and/or username/password; passwords hashed with bcrypt.
+- RBAC: admin, readwrite, readonly.
+- All queries are parameterized; audit log records who ran what and when.
+- Use HTTPS in production.
+
+## Documentation
+
+- **Admin guide**: operational steps, creating users and API keys, using the web panel, backups, and security notes – see `docs/ADMIN_GUIDE.md`.
+- **User/developer guide**: how to use the CLI and Node.js client, and how roles affect what you can do – see `docs/USER_GUIDE.md`.

package/index.js

@@ -0,0 +1,60 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { createRequire } from 'module';
+import { createApp } from 'scdb-api';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+
+/**
+ * Resolve the directory containing the web panel static assets (from scdb-web-panel).
+ * Works when this package is installed in another project (hoisted or nested).
+ */
+function getStaticDir() {
+  try {
+    const pkgPath = require.resolve('scdb-web-panel/package.json');
+    return path.join(path.dirname(pkgPath), 'public');
+  } catch {
+    return path.join(__dirname, 'node_modules', 'scdb-web-panel', 'public');
+  }
+}
+
+/**
+ * Start the Secure DB server (API + web panel). Returns the HTTP server.
+ * @param {{
+ *   port?: number;
+ *   host?: string;
+ *   databasePath?: string;
+ *   sessionSecret?: string;
+ *   docsDir?: string | null;
+ * }} env - Optional. port (default 3000), host (default '0.0.0.0'), databasePath, sessionSecret, docsDir.
+ * @returns {import('http').Server} The listening HTTP server.
+ */
+export function init(env = {}) {
+  const port = env.port ?? Number(process.env.PORT) ?? 3000;
+  const host = env.host ?? process.env.HOST ?? '0.0.0.0';
+  const staticDir = getStaticDir();
+  const app = createApp({
+    databasePath: env.databasePath,
+    sessionSecret: env.sessionSecret,
+    staticDir,
+    docsDir: env.docsDir,
+    port: port,
+  });
+  const server = app.listen(port, host, () => {
+    console.log(`Secure DB listening on http://${host}:${port}`);
+  });
+  return server;
+}
+
+const isMain =
+  process.argv[1] && path.resolve(process.argv[1]) === path.resolve(fileURLToPath(import.meta.url));
+if (isMain) {
+  init({
+    port: process.env.PORT ? Number(process.env.PORT) : undefined,
+    host: process.env.HOST,
+    databasePath: process.env.DATABASE_PATH,
+    sessionSecret: process.env.SESSION_SECRET,
+    docsDir: process.env.DOCS_DIR ?? null,
+  });
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "scdb-web",
+  "version": "1.0.0",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "scdb-api": "1.0.0",
+    "scdb-web-panel": "1.0.0"
+  }
+}