File size: 15,808 Bytes
6111b2b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 | /**
* gamification.ts β DB domain module for the Gamification & Leaderboard system.
*
* Manages leaderboards, XP/levels, badges, token ledger, invite tokens,
* and community server connections.
*/
import { getDbInstance } from "./core";
import { calculateLevel } from "../gamification/xp";
// ββββββββββββββββ Types ββββββββββββββββ
export interface LeaderboardRow {
apiKeyId: string;
scope: string;
score: number;
updatedAt: string;
}
export interface UserLevelRow {
apiKeyId: string;
totalXp: number;
currentLevel: number;
updatedAt: string;
}
export interface BadgeDefinition {
id: string;
name: string;
description: string | null;
icon: string | null;
category: string | null;
rarity: string;
criteria: string | null;
hidden: number;
createdAt: string;
}
export interface UserBadge {
apiKeyId: string;
badgeId: string;
unlockedAt: string;
badgeName?: string;
badgeDescription?: string | null;
badgeIcon?: string | null;
badgeCategory?: string | null;
badgeRarity?: string;
}
export interface XpAuditLogEntry {
id: number;
apiKeyId: string;
action: string;
xpEarned: number;
metadata: string | null;
createdAt: string;
}
export interface TokenLedgerEntry {
id: number;
fromApiKeyId: string;
toApiKeyId: string;
amount: number;
reason: string | null;
idempotencyKey: string | null;
createdAt: string;
}
export interface InviteToken {
id: string;
code: string;
tokenHash: string;
createdBy: string;
usedBy: string | null;
serverUrl: string | null;
maxUses: number;
useCount: number;
expiresAt: string | null;
revokedAt: string | null;
createdAt: string;
}
export interface CommunityServer {
id: string;
name: string;
url: string;
apiKeyHash: string;
connectedAt: string;
lastSyncAt: string | null;
status: string;
errorMessage: string | null;
}
// ββββββββββββββββ Helper ββββββββββββββββ
interface StatementLike<TRow = unknown> {
all: (...params: unknown[]) => TRow[];
get: (...params: unknown[]) => TRow | undefined;
run: (...params: unknown[]) => { changes: number };
}
interface DbLike {
prepare: <TRow = unknown>(sql: string) => StatementLike<TRow>;
}
function db(): DbLike {
return getDbInstance() as unknown as DbLike;
}
// ββββββββββββββββ Leaderboard ββββββββββββββββ
export function updateScore(apiKeyId: string, scope: string, points: number): void {
db()
.prepare(
`INSERT INTO leaderboard (api_key_id, scope, score, updated_at)
VALUES (?, ?, ?, datetime('now'))
ON CONFLICT(api_key_id, scope)
DO UPDATE SET score = score + excluded.score, updated_at = datetime('now')`
)
.run(apiKeyId, scope, points);
}
export function getRank(apiKeyId: string, scope: string): number {
const row = db()
.prepare(`SELECT score FROM leaderboard WHERE api_key_id = ? AND scope = ?`)
.get(apiKeyId, scope) as { score: number } | undefined;
if (!row) return 0;
const rankRow = db()
.prepare(`SELECT COUNT(*) + 1 AS rank FROM leaderboard WHERE scope = ? AND score > ?`)
.get(scope, row.score) as { rank: number };
return rankRow.rank;
}
export function getTopN(scope: string, limit: number, offset: number = 0): LeaderboardRow[] {
const rows = db()
.prepare(
`SELECT api_key_id, scope, score, updated_at FROM leaderboard
WHERE scope = ? ORDER BY score DESC LIMIT ? OFFSET ?`
)
.all(scope, limit, offset) as Array<{
api_key_id: string;
scope: string;
score: number;
updated_at: string;
}>;
return rows.map((r) => ({
apiKeyId: r.api_key_id,
scope: r.scope,
score: r.score,
updatedAt: r.updated_at,
}));
}
// ββββββββββββββββ XP & Levels ββββββββββββββββ
export function addXp(apiKeyId: string, action: string, amount: number, metadata?: string): void {
db()
.prepare(
`INSERT INTO xp_audit_log (api_key_id, action, xp_earned, metadata)
VALUES (?, ?, ?, ?)`
)
.run(apiKeyId, action, amount, metadata ?? null);
db()
.prepare(
`INSERT INTO user_levels (api_key_id, total_xp, current_level, updated_at)
VALUES (?, ?, ?, datetime('now'))
ON CONFLICT(api_key_id)
DO UPDATE SET total_xp = total_xp + excluded.total_xp, updated_at = datetime('now')`
)
.run(apiKeyId, amount, calculateLevel(amount));
}
export function getXp(apiKeyId: string): UserLevelRow | null {
const row = db()
.prepare(
`SELECT api_key_id, total_xp, current_level, updated_at FROM user_levels WHERE api_key_id = ?`
)
.get(apiKeyId) as
| {
api_key_id: string;
total_xp: number;
current_level: number;
updated_at: string;
}
| undefined;
if (!row) return null;
return {
apiKeyId: row.api_key_id,
totalXp: row.total_xp,
currentLevel: row.current_level,
updatedAt: row.updated_at,
};
}
export function updateLevel(apiKeyId: string, level: number): void {
db()
.prepare(
`INSERT INTO user_levels (api_key_id, total_xp, current_level, updated_at)
VALUES (?, 0, ?, datetime('now'))
ON CONFLICT(api_key_id)
DO UPDATE SET current_level = ?, updated_at = datetime('now')`
)
.run(apiKeyId, level, level);
}
// ββββββββββββββββ Badges ββββββββββββββββ
export function unlockBadge(apiKeyId: string, badgeId: string): void {
db()
.prepare(`INSERT OR IGNORE INTO user_badges (api_key_id, badge_id) VALUES (?, ?)`)
.run(apiKeyId, badgeId);
}
export function getBadges(apiKeyId: string): UserBadge[] {
const rows = db()
.prepare(
`SELECT ub.api_key_id, ub.badge_id, ub.unlocked_at,
bd.name, bd.description, bd.icon, bd.category, bd.rarity
FROM user_badges ub
JOIN badge_definitions bd ON bd.id = ub.badge_id
WHERE ub.api_key_id = ?`
)
.all(apiKeyId) as Array<{
api_key_id: string;
badge_id: string;
unlocked_at: string;
name: string;
description: string | null;
icon: string | null;
category: string | null;
rarity: string;
}>;
return rows.map((r) => ({
apiKeyId: r.api_key_id,
badgeId: r.badge_id,
unlockedAt: r.unlocked_at,
badgeName: r.name,
badgeDescription: r.description,
badgeIcon: r.icon,
badgeCategory: r.category,
badgeRarity: r.rarity,
}));
}
export function getBadgeDefinitions(category?: string): BadgeDefinition[] {
const sql = category
? `SELECT * FROM badge_definitions WHERE category = ?`
: `SELECT * FROM badge_definitions`;
const rows = (category ? db().prepare(sql).all(category) : db().prepare(sql).all()) as Array<{
id: string;
name: string;
description: string | null;
icon: string | null;
category: string | null;
rarity: string;
criteria: string | null;
hidden: number;
created_at: string;
}>;
return rows.map((r) => ({
id: r.id,
name: r.name,
description: r.description,
icon: r.icon,
category: r.category,
rarity: r.rarity,
criteria: r.criteria,
hidden: r.hidden,
createdAt: r.created_at,
}));
}
// ββββββββββββββββ Token Ledger ββββββββββββββββ
export function transferTokens(
fromId: string,
toId: string,
amount: number,
reason: string,
idempotencyKey: string
): { success: boolean; error?: string } {
// Atomic transaction: balance check + insert
const instance = getDbInstance();
const txn = instance.transaction(() => {
// Check for duplicate
const existing = instance
.prepare(`SELECT id FROM token_ledger WHERE idempotency_key = ?`)
.get(idempotencyKey) as { id: number } | undefined;
if (existing) return { success: true };
// Balance check (inside transaction to prevent race)
const balance = getBalance(fromId);
if (balance < amount) {
return { success: false, error: "insufficient_balance" };
}
instance
.prepare(
`INSERT INTO token_ledger (from_api_key_id, to_api_key_id, amount, reason, idempotency_key)
VALUES (?, ?, ?, ?, ?)`
)
.run(fromId, toId, amount, reason, idempotencyKey);
return { success: true };
});
return txn();
}
export function getBalance(apiKeyId: string): number {
const received = db()
.prepare(`SELECT COALESCE(SUM(amount), 0) AS total FROM token_ledger WHERE to_api_key_id = ?`)
.get(apiKeyId) as { total: number };
const sent = db()
.prepare(`SELECT COALESCE(SUM(amount), 0) AS total FROM token_ledger WHERE from_api_key_id = ?`)
.get(apiKeyId) as { total: number };
return received.total - sent.total;
}
export function getHistory(apiKeyId: string, limit: number): TokenLedgerEntry[] {
const rows = db()
.prepare(
`SELECT * FROM token_ledger
WHERE from_api_key_id = ? OR to_api_key_id = ?
ORDER BY created_at DESC LIMIT ?`
)
.all(apiKeyId, apiKeyId, limit) as Array<{
id: number;
from_api_key_id: string;
to_api_key_id: string;
amount: number;
reason: string | null;
idempotency_key: string | null;
created_at: string;
}>;
return rows.map((r) => ({
id: r.id,
fromApiKeyId: r.from_api_key_id,
toApiKeyId: r.to_api_key_id,
amount: r.amount,
reason: r.reason,
idempotencyKey: r.idempotency_key,
createdAt: r.created_at,
}));
}
// ββββββββββββββββ Invite Tokens ββββββββββββββββ
export function createInviteToken(
id: string,
code: string,
tokenHash: string,
createdBy: string,
serverUrl?: string,
maxUses?: number
): void {
db()
.prepare(
`INSERT INTO invite_tokens (id, code, token_hash, created_by, server_url, max_uses)
VALUES (?, ?, ?, ?, ?, ?)`
)
.run(id, code, tokenHash, createdBy, serverUrl ?? null, maxUses ?? 1);
}
export function getInviteByCode(code: string): InviteToken | null {
const row = db().prepare(`SELECT * FROM invite_tokens WHERE code = ?`).get(code) as
| {
id: string;
code: string;
token_hash: string;
created_by: string;
used_by: string | null;
server_url: string | null;
max_uses: number;
use_count: number;
expires_at: string | null;
revoked_at: string | null;
created_at: string;
}
| undefined;
if (!row) return null;
return {
id: row.id,
code: row.code,
tokenHash: row.token_hash,
createdBy: row.created_by,
usedBy: row.used_by,
serverUrl: row.server_url,
maxUses: row.max_uses,
useCount: row.use_count,
expiresAt: row.expires_at,
revokedAt: row.revoked_at,
createdAt: row.created_at,
};
}
export function redeemInvite(code: string, usedBy: string): boolean {
const result = db()
.prepare(
`UPDATE invite_tokens
SET use_count = use_count + 1, used_by = ?
WHERE code = ? AND revoked_at IS NULL
AND use_count < max_uses
AND (expires_at IS NULL OR expires_at > datetime('now'))`
)
.run(usedBy, code);
return result.changes > 0;
}
export function revokeInvite(id: string): void {
db().prepare(`UPDATE invite_tokens SET revoked_at = datetime('now') WHERE id = ?`).run(id);
}
// ββββββββββββββββ Community Servers ββββββββββββββββ
export function connectServer(id: string, name: string, url: string, apiKeyHash: string): void {
db()
.prepare(
`INSERT OR REPLACE INTO community_servers (id, name, url, api_key_hash)
VALUES (?, ?, ?, ?)`
)
.run(id, name, url, apiKeyHash);
}
export function disconnectServer(id: string): void {
db().prepare(`UPDATE community_servers SET status = 'disconnected' WHERE id = ?`).run(id);
}
/** List community servers (excludes api_key_hash for security). */
export function listServers(): Omit<CommunityServer, "apiKeyHash">[] {
const rows = db()
.prepare(
`SELECT id, name, url, connected_at, last_sync_at, status, error_message FROM community_servers`
)
.all() as Array<{
id: string;
name: string;
url: string;
connected_at: string;
last_sync_at: string | null;
status: string;
error_message: string | null;
}>;
return rows.map((r) => ({
id: r.id,
name: r.name,
url: r.url,
connectedAt: r.connected_at,
lastSyncAt: r.last_sync_at,
status: r.status,
errorMessage: r.error_message,
}));
}
/**
* Get neighbors around a user on the leaderboard.
*/
export function getLeaderboardNeighbors(
apiKeyId: string,
scope: string,
radius: number = 5
): {
above: Array<{ apiKeyId: string; score: number }>;
below: Array<{ apiKeyId: string; score: number }>;
} {
const d = db();
const scoreRow = d
.prepare("SELECT score FROM leaderboard WHERE api_key_id = ? AND scope = ?")
.get(apiKeyId, scope) as { score: number } | undefined;
if (!scoreRow) return { above: [], below: [] };
const above = d
.prepare(
`SELECT api_key_id, score FROM leaderboard
WHERE scope = ? AND score > ?
ORDER BY score ASC LIMIT ?`
)
.all(scope, scoreRow.score, radius) as Array<{ api_key_id: string; score: number }>;
const below = d
.prepare(
`SELECT api_key_id, score FROM leaderboard
WHERE scope = ? AND score < ?
ORDER BY score DESC LIMIT ?`
)
.all(scope, scoreRow.score, radius) as Array<{ api_key_id: string; score: number }>;
return {
above: above.reverse().map((r) => ({ apiKeyId: r.api_key_id, score: r.score })),
below: below.map((r) => ({ apiKeyId: r.api_key_id, score: r.score })),
};
}
/**
* Rotate weekly/monthly scopes. Archive old data, reset current.
* Uses two-step approach (SELECT then parameterized INSERT) to avoid SQL injection.
* Skips if archive scope already has data for this period (double-run protection).
*/
export function rotateLeaderboardScope(scope: "weekly" | "monthly"): void {
const d = db();
const archiveSuffix =
scope === "weekly"
? `week_${new Date().toISOString().slice(0, 10)}`
: `month_${new Date().toISOString().slice(0, 7)}`;
// Double-run protection: skip if archive scope already has data
const existing = d
.prepare("SELECT COUNT(*) AS cnt FROM leaderboard WHERE scope = ?")
.get(archiveSuffix) as { cnt: number };
if (existing.cnt > 0) return;
// Step 1: SELECT rows into memory
const rows = d
.prepare("SELECT api_key_id, score, updated_at FROM leaderboard WHERE scope = ?")
.all(scope) as Array<{ api_key_id: string; score: number; updated_at: string }>;
// Step 2: INSERT with parameters (no string interpolation)
if (rows.length > 0) {
const insert = d.prepare(
"INSERT OR IGNORE INTO leaderboard (api_key_id, scope, score, updated_at) VALUES (?, ?, ?, ?)"
);
for (const row of rows) {
insert.run(row.api_key_id, archiveSuffix, row.score, row.updated_at);
}
}
d.prepare("DELETE FROM leaderboard WHERE scope = ?").run(scope);
}
|