mirror of
https://github.com/BetterCorp/BetterFrame.git
synced 2026-05-26 20:16:35 +00:00
533412a826
- Cells own position directly (row/col/row_span/col_span) - Drop regions JSON from layouts (cells ARE the regions) - Drop is_default from layouts (display.default_layout_id owns) - Drop grid_cols/grid_rows from layouts (computed from cells) - Layout new form: name, description, priority, resets_idle_timer only - Layout edit: visual grid builder, + buttons on cell edges, click cell to assign content - Bundle cells now carry position directly - Rust kiosk attaches widgets using cell position - Migration v0.4: backfills cell positions from old region map
369 lines
15 KiB
TypeScript
369 lines
15 KiB
TypeScript
/**
|
|
* Database migrations.
|
|
*
|
|
* Idempotent — `service-store.init()` runs ALL of these on every startup,
|
|
* inside one transaction. SQLite tolerates `IF NOT EXISTS` everywhere we
|
|
* need it. When schemas change non-additively, we'll graduate to a real
|
|
* versioned migrator; for v0.1 this is sufficient.
|
|
*
|
|
* NOTE on datetimes: stored as TEXT in ISO-8601 UTC ("YYYY-MM-DDTHH:MM:SS.sssZ").
|
|
* Application code uses `new Date().toISOString()` for writes and
|
|
* `new Date(value)` for reads. No tz-aware datetime gotcha because TEXT is
|
|
* pure string round-trip. (Old python build hit a pain point with
|
|
* SQLAlchemy's DateTime adapter — we avoid the whole class of issue here.)
|
|
*/
|
|
|
|
/**
|
|
* A migration entry: either a plain SQL string or a function receiving the DB.
|
|
* Functions are used for ALTER TABLE which lacks IF NOT EXISTS in SQLite.
|
|
*/
|
|
import type { DatabaseSync } from "node:sqlite";
|
|
export type MigrationEntry = string | ((db: DatabaseSync) => void);
|
|
|
|
function addColumnIfNotExists(
|
|
db: DatabaseSync,
|
|
table: string,
|
|
column: string,
|
|
definition: string,
|
|
): void {
|
|
const cols = db.prepare(`PRAGMA table_info("${table}")`).all() as Array<{ name: string }>;
|
|
if (cols.some((c) => c.name === column)) return;
|
|
db.exec(`ALTER TABLE "${table}" ADD COLUMN ${column} ${definition}`);
|
|
}
|
|
|
|
export const MIGRATIONS: readonly MigrationEntry[] = [
|
|
// ---- users ---------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS users (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
username TEXT NOT NULL UNIQUE,
|
|
password_hash TEXT NOT NULL,
|
|
role TEXT NOT NULL DEFAULT 'operator' CHECK(role IN ('admin', 'operator')),
|
|
is_active INTEGER NOT NULL DEFAULT 1,
|
|
totp_enabled INTEGER NOT NULL DEFAULT 0,
|
|
totp_secret_encrypted TEXT,
|
|
recovery_codes_hashed TEXT NOT NULL DEFAULT '[]',
|
|
must_change_password INTEGER NOT NULL DEFAULT 0,
|
|
failed_login_count INTEGER NOT NULL DEFAULT 0,
|
|
locked_until TEXT,
|
|
last_login_at TEXT,
|
|
created_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now'))
|
|
) STRICT`,
|
|
|
|
// ---- sessions ------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS sessions (
|
|
id TEXT PRIMARY KEY,
|
|
user_id INTEGER NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
|
csrf_token TEXT NOT NULL,
|
|
totp_pending INTEGER NOT NULL DEFAULT 0,
|
|
user_agent TEXT,
|
|
ip_address TEXT,
|
|
issued_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),
|
|
last_seen_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),
|
|
expires_at TEXT NOT NULL,
|
|
revoked_at TEXT
|
|
) STRICT`,
|
|
|
|
`CREATE INDEX IF NOT EXISTS idx_sessions_user ON sessions(user_id)`,
|
|
`CREATE INDEX IF NOT EXISTS idx_sessions_active
|
|
ON sessions(expires_at)
|
|
WHERE revoked_at IS NULL`,
|
|
|
|
// ---- api_keys ------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS api_keys (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL,
|
|
key_hash TEXT NOT NULL,
|
|
key_prefix TEXT NOT NULL,
|
|
scopes TEXT NOT NULL DEFAULT '[]',
|
|
expires_at TEXT,
|
|
last_used_at TEXT,
|
|
last_used_ip TEXT,
|
|
created_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),
|
|
revoked_at TEXT
|
|
) STRICT`,
|
|
|
|
`CREATE INDEX IF NOT EXISTS idx_api_keys_prefix ON api_keys(key_prefix)`,
|
|
|
|
// ---- setup_state (singleton row, id=1) -----------------------------------
|
|
`CREATE TABLE IF NOT EXISTS setup_state (
|
|
id INTEGER PRIMARY KEY CHECK(id = 1),
|
|
is_complete INTEGER NOT NULL DEFAULT 0,
|
|
cluster_key_provisioned INTEGER NOT NULL DEFAULT 0,
|
|
nodered_flows_deployed INTEGER NOT NULL DEFAULT 0,
|
|
completed_at TEXT,
|
|
extras TEXT NOT NULL DEFAULT '{}'
|
|
) STRICT`,
|
|
`INSERT OR IGNORE INTO setup_state (id) VALUES (1)`,
|
|
|
|
// ---- displays ------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS displays (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL,
|
|
"index" INTEGER NOT NULL UNIQUE,
|
|
is_primary INTEGER NOT NULL DEFAULT 0,
|
|
width_px INTEGER NOT NULL DEFAULT 1920,
|
|
height_px INTEGER NOT NULL DEFAULT 1080,
|
|
default_layout_id INTEGER,
|
|
idle_timeout_seconds INTEGER NOT NULL DEFAULT 600,
|
|
sleep_timeout_seconds INTEGER NOT NULL DEFAULT 1800,
|
|
cec_enabled INTEGER NOT NULL DEFAULT 1,
|
|
cec_device_path TEXT,
|
|
cec_logical_address INTEGER,
|
|
desired_power_state TEXT NOT NULL DEFAULT 'follow_layout'
|
|
CHECK(desired_power_state IN ('follow_layout', 'on', 'standby')),
|
|
state_check_enabled INTEGER NOT NULL DEFAULT 0,
|
|
state_check_interval_seconds INTEGER NOT NULL DEFAULT 60
|
|
) STRICT`,
|
|
|
|
// ---- cameras -------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS cameras (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL UNIQUE,
|
|
type TEXT NOT NULL CHECK(type IN ('rtsp', 'onvif')),
|
|
rtsp_url TEXT,
|
|
onvif_host TEXT,
|
|
onvif_port INTEGER,
|
|
onvif_username TEXT,
|
|
onvif_password TEXT,
|
|
capabilities TEXT NOT NULL DEFAULT '[]',
|
|
stream_policy TEXT NOT NULL DEFAULT 'auto'
|
|
CHECK(stream_policy IN ('auto', 'always_main', 'always_sub')),
|
|
enabled INTEGER NOT NULL DEFAULT 1,
|
|
last_seen_at TEXT,
|
|
created_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now'))
|
|
) STRICT`,
|
|
|
|
`CREATE TABLE IF NOT EXISTS camera_streams (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
camera_id INTEGER NOT NULL REFERENCES cameras(id) ON DELETE CASCADE,
|
|
role TEXT NOT NULL CHECK(role IN ('main', 'sub', 'other')),
|
|
name TEXT NOT NULL,
|
|
profile_token TEXT,
|
|
rtsp_uri TEXT NOT NULL,
|
|
width INTEGER,
|
|
height INTEGER,
|
|
encoding TEXT,
|
|
framerate REAL,
|
|
bitrate_kbps INTEGER,
|
|
is_discovered INTEGER NOT NULL DEFAULT 0
|
|
) STRICT`,
|
|
|
|
`CREATE INDEX IF NOT EXISTS idx_camera_streams_camera ON camera_streams(camera_id)`,
|
|
|
|
// ---- layout templates + layouts + cells ----------------------------------
|
|
`CREATE TABLE IF NOT EXISTS layout_templates (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL UNIQUE,
|
|
description TEXT,
|
|
regions TEXT NOT NULL DEFAULT '[]',
|
|
grid_cols INTEGER NOT NULL DEFAULT 12,
|
|
grid_rows INTEGER NOT NULL DEFAULT 12,
|
|
is_builtin INTEGER NOT NULL DEFAULT 0
|
|
) STRICT`,
|
|
|
|
`CREATE TABLE IF NOT EXISTS layouts (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL UNIQUE,
|
|
description TEXT,
|
|
template_id INTEGER NOT NULL REFERENCES layout_templates(id),
|
|
display_id INTEGER NOT NULL REFERENCES displays(id),
|
|
priority TEXT NOT NULL DEFAULT 'normal' CHECK(priority IN ('hot', 'normal', 'cold')),
|
|
cooling_timeout_seconds INTEGER,
|
|
preload_camera_ids TEXT NOT NULL DEFAULT '[]',
|
|
is_default INTEGER NOT NULL DEFAULT 0,
|
|
resets_idle_timer INTEGER NOT NULL DEFAULT 1
|
|
) STRICT`,
|
|
|
|
`CREATE TABLE IF NOT EXISTS layout_cells (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
layout_id INTEGER NOT NULL REFERENCES layouts(id) ON DELETE CASCADE,
|
|
region_name TEXT NOT NULL,
|
|
content_type TEXT NOT NULL CHECK(content_type IN ('camera', 'web', 'html')),
|
|
camera_id INTEGER REFERENCES cameras(id) ON DELETE SET NULL,
|
|
stream_selector TEXT NOT NULL DEFAULT 'auto'
|
|
CHECK(stream_selector IN ('auto', 'main', 'sub')),
|
|
web_url TEXT,
|
|
html_content TEXT,
|
|
cooling_timeout_seconds INTEGER,
|
|
options TEXT NOT NULL DEFAULT '{}'
|
|
) STRICT`,
|
|
|
|
`CREATE INDEX IF NOT EXISTS idx_layout_cells_layout ON layout_cells(layout_id)`,
|
|
|
|
// ---- kiosks --------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS kiosks (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL UNIQUE,
|
|
description TEXT,
|
|
key_hash TEXT NOT NULL,
|
|
key_prefix TEXT NOT NULL,
|
|
capabilities TEXT NOT NULL DEFAULT '[]',
|
|
hardware_model TEXT,
|
|
os_version TEXT,
|
|
kiosk_app_version TEXT,
|
|
enabled INTEGER NOT NULL DEFAULT 1,
|
|
paired_at TEXT,
|
|
last_seen_at TEXT,
|
|
last_bundle_version TEXT,
|
|
display_id INTEGER REFERENCES displays(id) ON DELETE SET NULL,
|
|
created_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now'))
|
|
) STRICT`,
|
|
|
|
`CREATE INDEX IF NOT EXISTS idx_kiosks_prefix ON kiosks(key_prefix)`,
|
|
|
|
// ---- labels --------------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS labels (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
name TEXT NOT NULL UNIQUE,
|
|
description TEXT,
|
|
color TEXT,
|
|
created_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now'))
|
|
) STRICT`,
|
|
|
|
`CREATE TABLE IF NOT EXISTS kiosk_labels (
|
|
kiosk_id INTEGER NOT NULL REFERENCES kiosks(id) ON DELETE CASCADE,
|
|
label_id INTEGER NOT NULL REFERENCES labels(id) ON DELETE CASCADE,
|
|
role TEXT NOT NULL CHECK(role IN ('consume', 'operate')),
|
|
PRIMARY KEY (kiosk_id, label_id, role)
|
|
) STRICT`,
|
|
|
|
`CREATE TABLE IF NOT EXISTS camera_labels (
|
|
camera_id INTEGER NOT NULL REFERENCES cameras(id) ON DELETE CASCADE,
|
|
label_id INTEGER NOT NULL REFERENCES labels(id) ON DELETE CASCADE,
|
|
PRIMARY KEY (camera_id, label_id)
|
|
) STRICT`,
|
|
|
|
`CREATE TABLE IF NOT EXISTS layout_labels (
|
|
layout_id INTEGER NOT NULL REFERENCES layouts(id) ON DELETE CASCADE,
|
|
label_id INTEGER NOT NULL REFERENCES labels(id) ON DELETE CASCADE,
|
|
PRIMARY KEY (layout_id, label_id)
|
|
) STRICT`,
|
|
|
|
// ---- pairing_codes -------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS pairing_codes (
|
|
code TEXT PRIMARY KEY,
|
|
kiosk_proposed_name TEXT,
|
|
kiosk_hardware_model TEXT,
|
|
kiosk_capabilities TEXT NOT NULL DEFAULT '[]',
|
|
issued_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),
|
|
expires_at TEXT NOT NULL,
|
|
consumed_at TEXT,
|
|
consumed_by_kiosk_id INTEGER REFERENCES kiosks(id) ON DELETE SET NULL,
|
|
extras TEXT NOT NULL DEFAULT '{}'
|
|
) STRICT`,
|
|
|
|
// ---- event_log -----------------------------------------------------------
|
|
`CREATE TABLE IF NOT EXISTS event_log (
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
source_kiosk_id INTEGER REFERENCES kiosks(id) ON DELETE SET NULL,
|
|
source_camera_id INTEGER REFERENCES cameras(id) ON DELETE SET NULL,
|
|
source_type TEXT NOT NULL CHECK(source_type IN ('onvif', 'gpio', 'synthetic', 'system')),
|
|
topic TEXT NOT NULL,
|
|
property_op TEXT,
|
|
payload TEXT NOT NULL DEFAULT '{}',
|
|
received_at TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),
|
|
forwarded_to_nodered INTEGER NOT NULL DEFAULT 0
|
|
) STRICT`,
|
|
|
|
`CREATE INDEX IF NOT EXISTS idx_event_log_received ON event_log(received_at DESC)`,
|
|
`CREATE INDEX IF NOT EXISTS idx_event_log_topic ON event_log(topic, received_at DESC)`,
|
|
|
|
// ---- v0.2: flatten layout_templates into layouts, display→kiosk inversion ---
|
|
(db: DatabaseSync) => {
|
|
addColumnIfNotExists(db, "layouts", "regions", "TEXT NOT NULL DEFAULT '[]'");
|
|
addColumnIfNotExists(db, "layouts", "grid_cols", "INTEGER NOT NULL DEFAULT 1");
|
|
addColumnIfNotExists(db, "layouts", "grid_rows", "INTEGER NOT NULL DEFAULT 1");
|
|
|
|
// Copy template data into layouts (idempotent — only updates rows where regions is still '[]')
|
|
db.exec(`UPDATE layouts SET
|
|
regions = COALESCE((SELECT lt.regions FROM layout_templates lt WHERE lt.id = layouts.template_id), '[]'),
|
|
grid_cols = COALESCE((SELECT lt.grid_cols FROM layout_templates lt WHERE lt.id = layouts.template_id), 1),
|
|
grid_rows = COALESCE((SELECT lt.grid_rows FROM layout_templates lt WHERE lt.id = layouts.template_id), 1)
|
|
WHERE regions = '[]' AND template_id IS NOT NULL`);
|
|
|
|
addColumnIfNotExists(db, "displays", "kiosk_id", "INTEGER REFERENCES kiosks(id) ON DELETE SET NULL");
|
|
},
|
|
`CREATE INDEX IF NOT EXISTS idx_displays_kiosk ON displays(kiosk_id)`,
|
|
|
|
// ---- v0.3: decouple layouts from displays via join table -------------------
|
|
// Layouts become standalone entities; displays maintain a list of available
|
|
// layouts via display_layouts. Old layouts.display_id column is kept (SQLite
|
|
// can't drop columns) but no longer used by the application.
|
|
`CREATE TABLE IF NOT EXISTS display_layouts (
|
|
display_id INTEGER NOT NULL REFERENCES displays(id) ON DELETE CASCADE,
|
|
layout_id INTEGER NOT NULL REFERENCES layouts(id) ON DELETE CASCADE,
|
|
PRIMARY KEY (display_id, layout_id)
|
|
) STRICT`,
|
|
`CREATE INDEX IF NOT EXISTS idx_display_layouts_layout ON display_layouts(layout_id)`,
|
|
(db: DatabaseSync) => {
|
|
// Backfill: every existing layout that has display_id gets attached to
|
|
// that display via the new join table. Idempotent via INSERT OR IGNORE.
|
|
const cols = db.prepare(`PRAGMA table_info("layouts")`).all() as Array<{ name: string }>;
|
|
if (!cols.some((c) => c.name === "display_id")) return;
|
|
const rows = db
|
|
.prepare(`SELECT id, display_id FROM layouts WHERE display_id IS NOT NULL`)
|
|
.all() as Array<{ id: number; display_id: number | null }>;
|
|
const ins = db.prepare(
|
|
`INSERT OR IGNORE INTO display_layouts (display_id, layout_id) VALUES (?, ?)`,
|
|
);
|
|
for (const r of rows) {
|
|
if (r.display_id != null) ins.run(r.display_id, r.id);
|
|
}
|
|
},
|
|
|
|
// ---- v0.4: cells own their position; drop regions/grid_*/is_default ----------
|
|
// layout_cells now have row/col/row_span/col_span columns directly. Existing
|
|
// cells get backfilled by parsing layouts.regions JSON and matching on
|
|
// region_name. The old columns (regions, grid_cols, grid_rows, is_default,
|
|
// region_name) are kept on the row (SQLite can't drop columns) but no longer
|
|
// used by the application.
|
|
(db: DatabaseSync) => {
|
|
addColumnIfNotExists(db, "layout_cells", "row", "INTEGER NOT NULL DEFAULT 0");
|
|
addColumnIfNotExists(db, "layout_cells", "col", "INTEGER NOT NULL DEFAULT 0");
|
|
addColumnIfNotExists(db, "layout_cells", "row_span", "INTEGER NOT NULL DEFAULT 1");
|
|
addColumnIfNotExists(db, "layout_cells", "col_span", "INTEGER NOT NULL DEFAULT 1");
|
|
|
|
// Backfill: parse each layout's regions JSON, match cells by region_name,
|
|
// copy row/col/rowSpan/colSpan onto the cell row. Only update cells that
|
|
// still have the default 0,0,1,1 (idempotent re-runs become no-ops once the
|
|
// operator has edited cells through the new UI).
|
|
const cellCols = db.prepare(`PRAGMA table_info("layout_cells")`).all() as Array<{ name: string }>;
|
|
const hasRegionName = cellCols.some((c) => c.name === "region_name");
|
|
const layoutCols = db.prepare(`PRAGMA table_info("layouts")`).all() as Array<{ name: string }>;
|
|
const hasRegions = layoutCols.some((c) => c.name === "regions");
|
|
if (!hasRegionName || !hasRegions) return;
|
|
|
|
const layouts = db
|
|
.prepare(`SELECT id, regions FROM layouts WHERE regions IS NOT NULL AND regions != '[]'`)
|
|
.all() as Array<{ id: number; regions: string }>;
|
|
const updateCell = db.prepare(
|
|
`UPDATE layout_cells
|
|
SET row = ?, col = ?, row_span = ?, col_span = ?
|
|
WHERE id = ?
|
|
AND row = 0 AND col = 0 AND row_span = 1 AND col_span = 1`,
|
|
);
|
|
for (const l of layouts) {
|
|
let regions: Array<{ name: string; row: number; col: number; rowSpan: number; colSpan: number }>;
|
|
try {
|
|
regions = JSON.parse(l.regions);
|
|
} catch {
|
|
continue;
|
|
}
|
|
if (!Array.isArray(regions)) continue;
|
|
const cells = db
|
|
.prepare(`SELECT id, region_name FROM layout_cells WHERE layout_id = ?`)
|
|
.all(l.id) as Array<{ id: number; region_name: string }>;
|
|
for (const c of cells) {
|
|
const r = regions.find((reg) => reg.name === c.region_name);
|
|
if (!r) continue;
|
|
updateCell.run(
|
|
Number(r.row) || 0,
|
|
Number(r.col) || 0,
|
|
Number(r.rowSpan) || 1,
|
|
Number(r.colSpan) || 1,
|
|
c.id,
|
|
);
|
|
}
|
|
}
|
|
},
|
|
];
|