dashboard v1

This commit is contained in:
Char committed 2026-05-16 15:10:27 +01:00
1 parent 57d420a9f4
commit 22c33c0f7a
66 files changed
+6100 -465

No files matched your search

+270
View File
@@ -0,0 +1,270 @@
const fs = require("fs");
const path = require("path");
const axios = require("axios");
const { withTimeout } = require("./asyncTimeout.js");
const ADDONS_REPO = "Emerald-Services/Addons";
const ADDONS_BRANCH = "main";
const GITHUB_API = `https://api.github.com/repos/${ADDONS_REPO}/contents`;
const GITHUB_RAW = `https://raw.githubusercontent.com/${ADDONS_REPO}/${ADDONS_BRANCH}`;
const README_PATTERN = /^readme\.md$/i;
function ensureAddonDirs() {
if (!fs.existsSync("./Addons")) {
fs.mkdirSync("./Addons", { recursive: true });
}
if (!fs.existsSync("./Addons/Configs")) {
fs.mkdirSync("./Addons/Configs", { recursive: true });
}
}
async function githubList(dirPath = "") {
const url = dirPath
? `${GITHUB_API}/${encodeURIComponent(dirPath)}?ref=${ADDONS_BRANCH}`
: `${GITHUB_API}?ref=${ADDONS_BRANCH}`;
const res = await withTimeout(
axios.get(url, {
headers: { Accept: "application/vnd.github+json" },
timeout: 15_000,
}),
18_000,
"GitHub API request timed out",
);
return res.data;
}
async function listCatalogAddons() {
const root = await githubList("");
const dirs = root.filter((entry) => entry.type === "dir");
const addons = [];
for (const dir of dirs) {
const summary = await summarizeAddon(dir.name);
if (summary) addons.push(summary);
}
return addons.sort((a, b) => a.name.localeCompare(b.name));
}
async function summarizeAddon(name) {
const files = await listAddonRepoFiles(name);
const jsFiles = files.filter((f) => f.name.endsWith(".js"));
if (jsFiles.length === 0) return null;
const configFiles = files
.filter((f) => f.relativePath.startsWith("Configs/"))
.map((f) => f.name);
const readme = files.find((f) => README_PATTERN.test(f.name));
return {
id: name,
name,
description: readme
? `Community addon from Emerald-Services/Addons`
: `Addon from ${name}`,
repositoryUrl: `https://github.com/${ADDONS_REPO}/tree/${ADDONS_BRANCH}/${name}`,
jsFiles: jsFiles.map((f) => f.name),
configFiles,
fileCount: files.length,
};
}
async function listAddonRepoFiles(addonName) {
const files = [];
const queue = [addonName];
while (queue.length) {
const dir = queue.shift();
const entries = await githubList(dir);
for (const entry of entries) {
if (entry.type === "dir") {
queue.push(entry.path);
continue;
}
if (entry.type !== "file") continue;
if (README_PATTERN.test(entry.name)) continue;
const relativePath = entry.path.slice(`${addonName}/`.length);
files.push({
name: entry.name,
path: entry.path,
relativePath,
downloadUrl: entry.download_url,
size: entry.size,
});
}
}
return files;
}
function mapRepoFileToLocal(addonName, relativePath) {
const parts = relativePath.split("/").filter(Boolean);
if (parts[0] === "Configs") {
return path.join("Addons", "Configs", ...parts.slice(1));
}
if (parts.length === 1 && parts[0].endsWith(".js")) {
return path.join("Addons", parts[0]);
}
return path.join("Addons", ...parts);
}
async function downloadFile(url) {
const res = await withTimeout(
axios.get(url, { responseType: "arraybuffer", timeout: 30_000 }),
35_000,
"Addon file download timed out",
);
return Buffer.from(res.data);
}
function listLocalAddonJs() {
ensureAddonDirs();
return fs
.readdirSync("./Addons")
.filter((f) => f.endsWith(".js") && f !== "addon.js");
}
function listLocalAddonConfigs() {
ensureAddonDirs();
const dir = "./Addons/Configs";
if (!fs.existsSync(dir)) return [];
return fs
.readdirSync(dir)
.filter((f) => f.endsWith(".yml") || f.endsWith(".yaml") || f.endsWith(".json"));
}
function isAddonInstalled(catalogEntry) {
const localJs = listLocalAddonJs();
return catalogEntry.jsFiles.every((file) => localJs.includes(file));
}
async function listInstalledAddons(catalog) {
const localJs = listLocalAddonJs();
const installed = [];
for (const entry of catalog) {
const allPresent = entry.jsFiles.every((file) => localJs.includes(file));
if (allPresent) {
installed.push({
id: entry.id,
name: entry.name,
jsFiles: entry.jsFiles,
configFiles: entry.configFiles.filter((f) => {
const local = listLocalAddonConfigs();
return local.includes(f);
}),
});
}
}
const orphanJs = localJs.filter(
(file) => !installed.some((a) => a.jsFiles.includes(file)),
);
for (const file of orphanJs) {
installed.push({
id: file.replace(/\.js$/, ""),
name: file.replace(/\.js$/, ""),
jsFiles: [file],
configFiles: [],
custom: true,
});
}
return installed;
}
async function installAddonFromCatalog(addonName) {
const safeName = String(addonName).replace(/[^a-zA-Z0-9_-]/g, "");
if (!safeName) {
throw new Error("Invalid addon name");
}
const summary = await summarizeAddon(safeName);
if (!summary) {
throw new Error(`Addon "${safeName}" was not found in the catalog`);
}
const files = await listAddonRepoFiles(safeName);
if (files.length === 0) {
throw new Error(`Addon "${safeName}" has no installable files`);
}
ensureAddonDirs();
const written = [];
for (const file of files) {
const localPath = mapRepoFileToLocal(safeName, file.relativePath);
const dir = path.dirname(localPath);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
}
const content = await downloadFile(file.downloadUrl);
fs.writeFileSync(localPath, content);
written.push(localPath.replace(/\\/g, "/"));
}
return {
addon: summary,
filesWritten: written,
};
}
function readAddonConfig(filename) {
const safe = path.basename(filename);
if (!/^[a-zA-Z0-9_.-]+\.(yml|yaml|json)$/.test(safe)) {
throw new Error("Invalid config filename");
}
const filePath = path.join("./Addons/Configs", safe);
if (!fs.existsSync(filePath)) {
throw new Error("Addon config not found");
}
const raw = fs.readFileSync(filePath, "utf8");
if (safe.endsWith(".json")) {
return { filename: safe, format: "json", data: JSON.parse(raw), raw };
}
const yaml = require("js-yaml");
return { filename: safe, format: "yaml", data: yaml.load(raw) || {}, raw };
}
function writeAddonConfig(filename, data) {
const safe = path.basename(filename);
if (!/^[a-zA-Z0-9_.-]+\.(yml|yaml|json)$/.test(safe)) {
throw new Error("Invalid config filename");
}
ensureAddonDirs();
const filePath = path.join("./Addons/Configs", safe);
let content;
if (safe.endsWith(".json")) {
content = `${JSON.stringify(data, null, 2)}\n`;
} else {
const yaml = require("js-yaml");
content = yaml.dump(data, { lineWidth: 120, noRefs: true });
}
fs.writeFileSync(filePath, content);
return { filename: safe, path: filePath.replace(/\\/g, "/") };
}
module.exports = {
ADDONS_REPO,
listCatalogAddons,
listInstalledAddons,
isAddonInstalled,
installAddonFromCatalog,
listLocalAddonConfigs,
readAddonConfig,
writeAddonConfig,
mapRepoFileToLocal,
};
+6
View File
@@ -0,0 +1,6 @@
function getBotInviteUrl(clientId) {
if (!clientId) return null;
return `https://discord.com/api/oauth2/authorize?client_id=${clientId}&permissions=8&scope=bot%20applications.commands`;
}
module.exports = { getBotInviteUrl };
+150
View File
@@ -0,0 +1,150 @@
const fs = require("fs");
const path = require("path");
const configStore = require("./ConfigStore.js");
const { getPrimaryGuild } = require("./GuildManager.js");
const {
applyPresence,
runBotReady,
logSlashCommandsRegistered,
} = require("./BotStartup.js");
function walk(dir, ext = ".js", fileList = []) {
if (!fs.existsSync(dir)) return fileList;
for (const file of fs.readdirSync(dir)) {
const full = path.join(dir, file);
if (fs.statSync(full).isDirectory()) {
walk(full, ext, fileList);
} else if (file.endsWith(ext)) {
fileList.push(full.replace(/\\/g, "/"));
}
}
return fileList;
}
async function refreshSlashCommands(client) {
if (!client?.application) return { count: 0 };
const cmdconfig = configStore.commands;
const commandFiles = walk("./Commands");
client.commands.clear();
for (const file of commandFiles) {
const resolved = path.resolve(file);
if (require.cache[resolved]) {
delete require.cache[resolved];
}
}
let count = 0;
for (const file of commandFiles) {
const command = require(path.resolve(file));
const matchingConfig = Object.values(cmdconfig).find(
(entry) =>
entry &&
typeof entry === "object" &&
entry.Command &&
String(entry.Command).toLowerCase() ===
String(command.name).toLowerCase(),
);
if (matchingConfig && matchingConfig.Enabled === false) {
continue;
}
client.commands.set(command.name, command);
count++;
}
const payload = client.commands.map((cmd) => cmd.data ?? cmd);
for (const guild of client.guilds.cache.values()) {
await guild.commands.set(payload);
}
return { count };
}
async function reloadBot(client, options = {}) {
const { fileKey, refreshCommands = true } = options;
let reloaded;
if (fileKey) {
configStore.reloadFile(fileKey);
reloaded = [fileKey];
} else {
reloaded = configStore.reloadBotConfigs();
}
applyPresence(client);
let commands = null;
if (refreshCommands && (!fileKey || fileKey === "commands")) {
commands = await refreshSlashCommands(client);
}
return {
reloaded,
commands,
};
}
/**
* Reload configs from disk, reconnect the Discord session, and refresh presence/commands.
* API and dashboard keep running on the same process.
*/
async function restartDiscordBot(client) {
if (!client) {
const err = new Error("Bot client not available");
err.code = "NO_CLIENT";
throw err;
}
const reloaded = configStore.reloadBotConfigs();
const token = configStore.supportbot?.General?.Token;
if (!token || String(token).trim() === "" || token === "BOT_TOKEN") {
const err = new Error("Invalid or missing bot token in supportbot.yml");
err.code = "INVALID_TOKEN";
throw err;
}
console.log("[BotReload] Restarting Discord bot after config change…");
client.__restarting = true;
if (client.user) {
try {
await client.destroy();
} catch (destroyErr) {
console.warn("[BotReload] destroy:", destroyErr.message);
}
}
client.__explicitStartup = true;
try {
try {
await client.login(token);
} catch (loginErr) {
console.error("[BotReload] login failed:", loginErr.message);
const err = new Error(`Could not start bot: ${loginErr.message}`);
err.code = "LOGIN_FAILED";
throw err;
}
// clientReady does not fire again after destroy()+login() — run startup explicitly
await runBotReady(client, { clearConsole: true, logCommands: false });
const commands = await refreshSlashCommands(client);
logSlashCommandsRegistered(client);
console.log("[BotReload] Bot restarted successfully");
return { restarted: true, reloaded, commands };
} finally {
client.__explicitStartup = false;
client.__restarting = false;
}
}
module.exports = {
applyPresence,
refreshSlashCommands,
reloadBot,
restartDiscordBot,
};
+174
View File
@@ -0,0 +1,174 @@
const Discord = require("discord.js");
const configStore = require("./ConfigStore.js");
const {
getPrimaryGuild,
syncGuildHealth,
} = require("./GuildManager.js");
const ACTIVITY_TYPES = {
PLAYING: Discord.ActivityType.Playing,
WATCHING: Discord.ActivityType.Watching,
LISTENING: Discord.ActivityType.Listening,
COMPETING: Discord.ActivityType.Competing,
STREAMING: Discord.ActivityType.Streaming,
};
function applyPresence(client) {
if (!client?.user) return;
const activity = configStore.supportbot?.Activity;
const typeKey = activity?.Type?.toUpperCase();
const type = ACTIVITY_TYPES[typeKey] ?? Discord.ActivityType.Playing;
const name = activity?.Status || "Online";
const activityPayload = { name, type };
if (typeKey === "STREAMING" && activity?.StreamingURL) {
activityPayload.url = activity.StreamingURL;
}
client.user.setPresence({
activities: [activityPayload],
status: "online",
});
}
const c = {
reset: "\x1b[0m",
gray: "\x1b[90m",
green: "\x1b[32m",
yellow: "\x1b[33m",
bold: "\x1b[1m",
white: "\x1b[37m",
};
function line() {
console.log(
`${c.gray}────────────────────────────────────────────────────────${c.reset}`,
);
}
function section(title) {
console.log(`\n${c.green}${title}${c.reset}`);
console.log(`${c.gray}${"-".repeat(title.length)}${c.reset}`);
}
function info(label, value) {
console.log(`${c.gray}${label.padEnd(14)}${c.reset} ${value}`);
}
function status(label, ok, details = "") {
const icon = ok ? `${c.green}✓${c.reset}` : `${c.yellow}!${c.reset}`;
console.log(` ${icon} ${label}${details ? ` (${details})` : ""}`);
}
async function logStartup(client, options = {}) {
const { clearConsole = true } = options;
const supportbot = configStore.supportbot;
if (clearConsole) {
console.clear();
}
const botName = supportbot?.General?.Name || "SupportBot";
const botVersion = supportbot?.SupportBot_Version || "Unknown";
const { getBotInviteUrl } = require("./BotInvite.js");
const inviteUrl = getBotInviteUrl(client.user.id);
line();
console.log(`${c.bold}${c.green}SupportBot${c.reset}`);
console.log(`${c.gray}Emerald Services${c.reset}`);
line();
section("System");
info("Bot Name", botName);
info("Version", botVersion);
info("Node.js", process.version);
info("Discord.js", `v${Discord.version}`);
info("Logged in as", client.user.tag);
info("Guilds", `${client.guilds.cache.size}`);
section("Links");
info("Docs", "https://emerald-services.gitbook.io/");
info("Discord", "https://dsc.gg/emerald-dev");
info("Invite", inviteUrl);
console.log("");
}
async function checkConfigs(client) {
const supportbot = configStore.supportbot;
const health = syncGuildHealth(client);
if (health.status !== "ok") {
section("Guild");
status("Guild setup", false, health.message || health.status);
console.log("");
}
const guild = getPrimaryGuild(client);
if (!guild) return;
section("Config Check");
const roles = [
supportbot?.Roles?.StaffMember?.Admin,
supportbot?.Roles?.StaffMember?.Staff,
supportbot?.Roles?.AutoRole?.Role,
].filter(Boolean);
const channels = [supportbot?.Ticket?.TicketHome].filter(Boolean);
const [roleResults, channelResults] = await Promise.all([
Promise.all(roles.map((role) => client.getRole(role, guild))),
Promise.all(channels.map((channel) => client.getChannel(channel, guild))),
]);
const missingRoles = roles.filter((_, i) => !roleResults[i]);
const missingChannels = channels.filter((_, i) => !channelResults[i]);
if (!missingRoles.length && !missingChannels.length) {
status("All configurations validated successfully", true);
} else {
if (missingRoles.length) {
status("Missing roles", false, missingRoles.join(", "));
}
if (missingChannels.length) {
status("Missing channels", false, missingChannels.join(", "));
}
}
console.log("");
}
function logSlashCommandsRegistered(client) {
const guild = getPrimaryGuild(client);
if (!guild) return;
console.log(
`\n${c.green}✓${c.reset} ${c.white}Slash Commands Registered${c.reset} ${c.gray}for ${guild.name}${c.reset}`,
);
}
/**
* Same work as Events/ready.js — safe to call after config reload reconnects.
*/
async function runBotReady(client, options = {}) {
const { clearConsole = true, logCommands = false } = options;
syncGuildHealth(client);
applyPresence(client);
await logStartup(client, { clearConsole });
await checkConfigs(client);
if (logCommands) {
logSlashCommandsRegistered(client);
}
}
module.exports = {
applyPresence,
logStartup,
checkConfigs,
logSlashCommandsRegistered,
runBotReady,
};
+10 -9
View File
@@ -2,11 +2,12 @@ const fs = require("fs");
const path = require("path");
const Discord = require("discord.js");
const { GatewayIntentBits, Partials } = require("discord.js");
const yaml = require("js-yaml");
const { Command, Event } = require("./Addon.js");
const configStore = require("./ConfigStore.js");
const { getPrimaryGuild } = require("./GuildManager.js");
const supportbot = yaml.load(fs.readFileSync("./Configs/supportbot.yml", "utf8"));
const cmdconfig = yaml.load(fs.readFileSync("./Configs/commands.yml", "utf8"));
const supportbot = configStore.supportbot;
const cmdconfig = configStore.commands;
const c = {
reset: "\x1b[0m",
@@ -158,12 +159,12 @@ class Client extends Discord.Client {
});
}
this.once("clientReady", async () => {
await this.guilds.cache.first()?.commands.set(this.commands);
console.log(
`\n${c.green}✓${c.reset} ${c.white}Slash Commands Registered${c.reset} ${c.gray}for ${this.guilds.cache.first().name}${c.reset}`,
);
this.on("clientReady", async () => {
const guild = getPrimaryGuild(this);
if (!guild) return;
await guild.commands.set(this.commands);
const { logSlashCommandsRegistered } = require("./BotStartup.js");
logSlashCommandsRegistered(this);
});
section("Events");
+89
View File
@@ -0,0 +1,89 @@
// Live config objects — reload mutates in place so existing references stay valid.
const fs = require("fs");
const path = require("path");
const yaml = require("js-yaml");
const CONFIG_DIR = path.join(__dirname, "../Configs");
const FILE_KEYS = [
"supportbot",
"commands",
"messages",
"ticket-panel",
"supportbot-ai",
"api",
];
function readConfig(name) {
return yaml.load(fs.readFileSync(path.join(CONFIG_DIR, `${name}.yml`), "utf8"));
}
function deepAssign(target, source) {
if (!target || typeof target !== "object" || Array.isArray(target)) {
return source;
}
if (!source || typeof source !== "object" || Array.isArray(source)) {
return source;
}
for (const key of Object.keys(source)) {
const next = source[key];
if (
next &&
typeof next === "object" &&
!Array.isArray(next) &&
target[key] &&
typeof target[key] === "object" &&
!Array.isArray(target[key])
) {
deepAssign(target[key], next);
} else {
target[key] = next;
}
}
for (const key of Object.keys(target)) {
if (!(key in source)) {
delete target[key];
}
}
return target;
}
const store = {};
for (const name of FILE_KEYS) {
store[name] = readConfig(name);
}
function reloadFile(fileKey) {
if (!FILE_KEYS.includes(fileKey)) {
throw new Error(`Unknown config: ${fileKey}`);
}
const fresh = readConfig(fileKey);
deepAssign(store[fileKey], fresh);
return store[fileKey];
}
function reloadBotConfigs() {
const reloaded = [];
for (const name of FILE_KEYS) {
if (name === "api") continue;
reloadFile(name);
reloaded.push(name);
}
return reloaded;
}
module.exports = {
supportbot: store.supportbot,
commands: store.commands,
messages: store.messages,
ticketPanel: store["ticket-panel"],
supportbotAi: store["supportbot-ai"],
api: store.api,
store,
reloadFile,
reloadBotConfigs,
readConfig,
};
+57
View File
@@ -0,0 +1,57 @@
const { fullPermissions, hasPermission, canAccessConfig } = require("./DashboardPermissions.js");
function grantServiceAccess(req) {
req.dashboardService = true;
req.dashboardPermissions = fullPermissions();
req.dashboardRole = "service";
req.dashboardIsOwner = true;
}
function forbid(res, message = "Forbidden") {
return res.status(403).json({ success: false, error: message });
}
function createPermissionMiddleware(getPermissions) {
return function requirePermission(permission) {
return (req, res, next) => {
if (req.dashboardService) return next();
const perms = getPermissions(req) || req.dashboardPermissions;
if (hasPermission(perms, permission)) return next();
return forbid(res);
};
};
}
function createConfigMiddleware(getPermissions) {
return function requireConfigAccess(mode = "view") {
return (req, res, next) => {
if (req.dashboardService) return next();
const perms = getPermissions(req) || req.dashboardPermissions;
const file = req.params?.file || req.body?.filename;
if (!file) return next();
if (!canAccessConfig(perms, file, mode)) return forbid(res);
return next();
};
};
}
function assertConfigFilesEditable(permissions, files, res) {
if (!permissions) return forbid(res);
for (const file of files) {
if (!canAccessConfig(permissions, file, "edit")) {
return forbid(res, `No permission to edit ${file}.yml`);
}
}
return null;
}
module.exports = {
grantServiceAccess,
forbid,
createPermissionMiddleware,
createConfigMiddleware,
assertConfigFilesEditable,
fullPermissions,
hasPermission,
canAccessConfig,
};
+134
View File
@@ -0,0 +1,134 @@
const CONFIG_FILES = [
"supportbot",
"ticket-panel",
"commands",
"messages",
"supportbot-ai",
];
const ROLES = ["owner", "admin", "moderator", "editor", "viewer", "custom"];
function configMap(view, edit) {
const configs = {};
for (const file of CONFIG_FILES) {
configs[file] = { view: Boolean(view), edit: Boolean(edit) };
}
return configs;
}
function fullPermissions() {
return {
overview: true,
logs: true,
transcripts: true,
settings: { view: true, update: true },
configs: configMap(true, true),
users: { view: true, manage: true },
};
}
function permissionsFromRole(role, customPermissions) {
switch (role) {
case "owner":
case "admin":
return fullPermissions();
case "moderator":
return {
overview: true,
logs: true,
transcripts: true,
settings: { view: true, update: false },
configs: configMap(true, false),
users: { view: false, manage: false },
};
case "editor":
return {
overview: true,
logs: true,
transcripts: false,
settings: { view: true, update: false },
configs: configMap(true, true),
users: { view: false, manage: false },
};
case "viewer":
return {
overview: true,
logs: true,
transcripts: true,
settings: { view: true, update: false },
configs: configMap(true, false),
users: { view: false, manage: false },
};
case "custom":
return normalizePermissions(customPermissions);
default:
return permissionsFromRole("viewer");
}
}
function normalizePermissions(input) {
const base = permissionsFromRole("viewer");
if (!input || typeof input !== "object") return base;
return {
overview: input.overview ?? base.overview,
logs: input.logs ?? base.logs,
transcripts: input.transcripts ?? base.transcripts,
settings: {
view: input.settings?.view ?? base.settings.view,
update: input.settings?.update ?? base.settings.update,
},
configs: CONFIG_FILES.reduce((acc, file) => {
acc[file] = {
view: input.configs?.[file]?.view ?? base.configs[file].view,
edit: input.configs?.[file]?.edit ?? base.configs[file].edit,
};
return acc;
}, {}),
users: {
view: input.users?.view ?? base.users.view,
manage: input.users?.manage ?? base.users.manage,
},
};
}
function hasPermission(permissions, check) {
if (!permissions) return false;
if (check === "overview") return Boolean(permissions.overview);
if (check === "logs") return Boolean(permissions.logs);
if (check === "transcripts") return Boolean(permissions.transcripts);
if (check === "settings.view") return Boolean(permissions.settings?.view);
if (check === "settings.update") return Boolean(permissions.settings?.update);
if (check === "users.view") return Boolean(permissions.users?.view);
if (check === "users.manage") return Boolean(permissions.users?.manage);
const configView = check.match(/^configs\.([a-z0-9-]+)\.view$/);
if (configView) {
const file = configView[1];
return Boolean(permissions.configs?.[file]?.view);
}
const configEdit = check.match(/^configs\.([a-z0-9-]+)\.edit$/);
if (configEdit) {
const file = configEdit[1];
return Boolean(permissions.configs?.[file]?.edit);
}
return false;
}
function canAccessConfig(permissions, file, mode = "view") {
if (!CONFIG_FILES.includes(file)) return false;
return hasPermission(permissions, `configs.${file}.${mode}`);
}
module.exports = {
CONFIG_FILES,
ROLES,
fullPermissions,
permissionsFromRole,
normalizePermissions,
hasPermission,
canAccessConfig,
};
+71
View File
@@ -0,0 +1,71 @@
const crypto = require("crypto");
const SESSION_COOKIE = "sb_dashboard";
const SESSION_MAX_AGE_MS = 7 * 24 * 60 * 60 * 1000;
function signSession(payload, secret) {
const body = Buffer.from(JSON.stringify(payload)).toString("base64url");
const sig = crypto
.createHmac("sha256", secret)
.update(body)
.digest("base64url");
return `${body}.${sig}`;
}
function verifySession(token, secret) {
if (!token || typeof token !== "string") return null;
const dot = token.lastIndexOf(".");
if (dot <= 0) return null;
const body = token.slice(0, dot);
const sig = token.slice(dot + 1);
const expected = crypto
.createHmac("sha256", secret)
.update(body)
.digest("base64url");
if (sig.length !== expected.length) return null;
if (!crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected))) {
return null;
}
try {
const payload = JSON.parse(
Buffer.from(body, "base64url").toString("utf8"),
);
if (!payload?.userId || !payload?.exp) return null;
if (Date.now() > payload.exp) return null;
return payload;
} catch {
return null;
}
}
function createSessionPayload(user) {
return {
userId: user.id,
username: user.username,
globalName: user.global_name || null,
avatar: user.avatar || null,
exp: Date.now() + SESSION_MAX_AGE_MS,
};
}
function sessionCookieOptions(maxAgeMs = SESSION_MAX_AGE_MS) {
return {
httpOnly: true,
secure: process.env.NODE_ENV === "production",
sameSite: "lax",
maxAge: maxAgeMs,
path: "/",
};
}
module.exports = {
SESSION_COOKIE,
SESSION_MAX_AGE_MS,
signSession,
verifySession,
createSessionPayload,
sessionCookieOptions,
};
+291
View File
@@ -0,0 +1,291 @@
const fs = require("fs");
const path = require("path");
const {
CONFIG_FILES,
ROLES,
fullPermissions,
permissionsFromRole,
normalizePermissions,
hasPermission,
canAccessConfig,
} = require("./DashboardPermissions.js");
const { discordAvatarUrl } = require("./DiscordOAuth.js");
const STORE_PATH = path.join(__dirname, "../Data/dashboard-users.json");
function ensureDataDir() {
const dir = path.dirname(STORE_PATH);
if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
}
function emptyStore() {
return { version: 1, users: {} };
}
function readStore() {
ensureDataDir();
if (!fs.existsSync(STORE_PATH)) return emptyStore();
try {
const raw = JSON.parse(fs.readFileSync(STORE_PATH, "utf8"));
if (!raw.users || typeof raw.users !== "object") return emptyStore();
return raw;
} catch {
return emptyStore();
}
}
function writeStore(store) {
ensureDataDir();
fs.writeFileSync(STORE_PATH, JSON.stringify(store, null, 2), "utf8");
}
function getOwnerIds(oauth) {
const owners = new Set();
for (const id of oauth?.OwnerUserIds || []) owners.add(String(id));
for (const id of oauth?.AllowedUserIds || []) owners.add(String(id));
return owners;
}
function isYamlOwner(userId, oauth) {
return getOwnerIds(oauth).has(String(userId));
}
function bootstrapFromOAuth(oauth) {
const store = readStore();
const owners = getOwnerIds(oauth);
let changed = false;
for (const id of owners) {
if (!store.users[id]) {
store.users[id] = {
id,
username: null,
globalName: null,
avatar: null,
role: "owner",
permissions: null,
enabled: true,
createdAt: Date.now(),
updatedAt: Date.now(),
createdBy: "system",
};
changed = true;
}
}
if (changed) writeStore(store);
return store;
}
function syncDiscordProfile(userId, profile) {
const store = readStore();
const entry = store.users[userId];
if (!entry) return;
entry.username = profile.username ?? entry.username;
entry.globalName = profile.globalName ?? entry.globalName;
entry.avatar = profile.avatar ?? entry.avatar;
entry.updatedAt = Date.now();
writeStore(store);
}
function resolvePermissions(entry, oauth, userId) {
if (isYamlOwner(userId, oauth)) {
return { permissions: fullPermissions(), role: "owner", isOwner: true };
}
if (!entry?.enabled) return null;
const role = entry.role || "viewer";
const permissions =
role === "custom"
? permissionsFromRole("custom", entry.permissions)
: permissionsFromRole(role);
return { permissions, role, isOwner: false };
}
function getAccess(userId, oauth) {
bootstrapFromOAuth(oauth);
const store = readStore();
const id = String(userId);
if (isYamlOwner(id, oauth)) {
const entry = store.users[id];
return {
entry: entry || { id, role: "owner" },
permissions: fullPermissions(),
role: "owner",
isOwner: true,
yamlOwner: true,
};
}
const entry = store.users[id];
const resolved = resolvePermissions(entry, oauth, id);
if (!resolved) return null;
return {
entry,
permissions: resolved.permissions,
role: resolved.role,
isOwner: false,
yamlOwner: false,
};
}
function canLogin(userId, oauth) {
return Boolean(getAccess(userId, oauth));
}
function formatPublicUser(entry, access, discordProfile) {
const id = String(entry?.id || discordProfile?.id);
const avatarHash = entry?.avatar ?? discordProfile?.avatar ?? null;
return {
id,
username: entry?.username || discordProfile?.username || "Unknown",
globalName: entry?.globalName ?? discordProfile?.global_name ?? null,
avatar: avatarHash
? discordAvatarUrl({ id, avatar: avatarHash })
: discordProfile
? discordAvatarUrl(discordProfile)
: discordAvatarUrl({ id, avatar: null }),
role: access.role,
isOwner: access.isOwner,
permissions: access.permissions,
};
}
function listUsers(oauth) {
bootstrapFromOAuth(oauth);
const store = readStore();
const yamlOwners = getOwnerIds(oauth);
return Object.values(store.users).map((entry) => {
const access = resolvePermissions(entry, oauth, entry.id) || {
permissions: permissionsFromRole("viewer"),
role: entry.role,
isOwner: false,
};
return {
id: entry.id,
username: entry.username,
globalName: entry.globalName,
avatar: entry.avatar
? discordAvatarUrl({ id: entry.id, avatar: entry.avatar })
: discordAvatarUrl({ id: entry.id, avatar: null }),
role: yamlOwners.has(String(entry.id)) ? "owner" : entry.role,
permissions:
entry.role === "custom"
? normalizePermissions(entry.permissions)
: access.permissions,
enabled: entry.enabled !== false,
isOwner: yamlOwners.has(String(entry.id)),
yamlOwner: yamlOwners.has(String(entry.id)),
createdAt: entry.createdAt,
updatedAt: entry.updatedAt,
};
});
}
function addUser(payload, actorId, oauth) {
const id = String(payload.id || "").trim();
if (!/^\d{17,20}$/.test(id)) {
throw new Error("Invalid Discord user ID");
}
const role = payload.role || "viewer";
if (!ROLES.includes(role)) throw new Error("Invalid role");
if (role === "owner" && !isYamlOwner(actorId, oauth)) {
throw new Error("Only api.yml owners can assign the owner role");
}
const store = readStore();
if (store.users[id]) throw new Error("User already exists");
store.users[id] = {
id,
username: payload.username || null,
globalName: payload.globalName || null,
avatar: null,
role,
permissions:
role === "custom" ? normalizePermissions(payload.permissions) : null,
enabled: payload.enabled !== false,
createdAt: Date.now(),
updatedAt: Date.now(),
createdBy: String(actorId),
};
writeStore(store);
return listUsers(oauth).find((u) => u.id === id);
}
function updateUser(id, payload, actorId, oauth) {
const store = readStore();
const entry = store.users[String(id)];
if (!entry) throw new Error("User not found");
if (isYamlOwner(id, oauth) && payload.enabled === false) {
throw new Error("Cannot disable an owner defined in api.yml");
}
if (payload.role) {
if (!ROLES.includes(payload.role)) throw new Error("Invalid role");
if (payload.role === "owner" && !isYamlOwner(actorId, oauth)) {
throw new Error("Only api.yml owners can assign the owner role");
}
if (isYamlOwner(id, oauth) && payload.role !== "owner") {
throw new Error("Cannot change role of an api.yml owner");
}
entry.role = payload.role;
}
if (payload.enabled !== undefined) entry.enabled = Boolean(payload.enabled);
if (payload.username !== undefined) entry.username = payload.username;
if (payload.globalName !== undefined) entry.globalName = payload.globalName;
if (payload.permissions !== undefined) {
entry.permissions = normalizePermissions(payload.permissions);
if (entry.role !== "custom") entry.role = "custom";
}
if (entry.role === "custom" && payload.permissions === undefined && payload.role !== "custom") {
entry.permissions = null;
}
entry.updatedAt = Date.now();
writeStore(store);
return listUsers(oauth).find((u) => u.id === String(id));
}
function removeUser(id, oauth) {
if (isYamlOwner(id, oauth)) {
throw new Error("Remove this user from OwnerUserIds in api.yml instead");
}
const store = readStore();
if (!store.users[String(id)]) throw new Error("User not found");
delete store.users[String(id)];
writeStore(store);
}
module.exports = {
CONFIG_FILES,
STORE_PATH,
getOwnerIds,
isYamlOwner,
bootstrapFromOAuth,
syncDiscordProfile,
getAccess,
canLogin,
formatPublicUser,
listUsers,
addUser,
updateUser,
removeUser,
hasPermission,
canAccessConfig,
ROLES,
};
+106
View File
@@ -0,0 +1,106 @@
const crypto = require("crypto");
const axios = require("axios");
const DISCORD_API = "https://discord.com/api";
const OAUTH_STATE_COOKIE = "sb_oauth_state";
const OAUTH_STATE_MAX_AGE_MS = 10 * 60 * 1000;
function discordAvatarUrl(user) {
if (user.avatar) {
const ext = user.avatar.startsWith("a_") ? "gif" : "png";
return `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}.${ext}?size=128`;
}
const index = Number((BigInt(user.id) >> 22n) % 6n);
return `https://cdn.discordapp.com/embed/avatars/${index}.png`;
}
function buildAuthorizeUrl(oauth, state) {
const params = new URLSearchParams({
client_id: oauth.ClientId,
redirect_uri: oauth.RedirectUri,
response_type: "code",
scope: "identify",
state,
prompt: "none",
});
return `${DISCORD_API}/oauth2/authorize?${params.toString()}`;
}
async function exchangeCode(oauth, code) {
const body = new URLSearchParams({
client_id: oauth.ClientId,
client_secret: oauth.ClientSecret,
grant_type: "authorization_code",
code,
redirect_uri: oauth.RedirectUri,
});
const { data } = await axios.post(`${DISCORD_API}/oauth2/token`, body, {
headers: { "Content-Type": "application/x-www-form-urlencoded" },
timeout: 15000,
});
return data.access_token;
}
async function fetchDiscordUser(accessToken) {
const { data } = await axios.get(`${DISCORD_API}/users/@me`, {
headers: { Authorization: `Bearer ${accessToken}` },
timeout: 15000,
});
return data;
}
function createOAuthState() {
return crypto.randomBytes(24).toString("hex");
}
function oauthStateCookieOptions() {
return {
httpOnly: true,
secure: process.env.NODE_ENV === "production",
sameSite: "lax",
maxAge: OAUTH_STATE_MAX_AGE_MS,
path: "/",
};
}
function isOAuthConfigured(oauth) {
return Boolean(
oauth?.Enabled &&
oauth.ClientId &&
oauth.ClientSecret &&
oauth.RedirectUri,
);
}
function isUserAllowed(userId, oauth) {
const allowed = oauth?.AllowedUserIds;
if (!Array.isArray(allowed) || allowed.length === 0) {
return false;
}
return allowed.map(String).includes(String(userId));
}
function formatPublicUser(user) {
return {
id: user.id,
username: user.username,
globalName: user.global_name || null,
avatar: discordAvatarUrl(user),
};
}
module.exports = {
OAUTH_STATE_COOKIE,
OAUTH_STATE_MAX_AGE_MS,
buildAuthorizeUrl,
exchangeCode,
fetchDiscordUser,
createOAuthState,
oauthStateCookieOptions,
isOAuthConfigured,
isUserAllowed,
formatPublicUser,
discordAvatarUrl,
};
+246
View File
@@ -0,0 +1,246 @@
const { ChannelType } = require("discord.js");
const configStore = require("./ConfigStore.js");
const { withTimeout } = require("./asyncTimeout.js");
const RESOURCES_CACHE_MS = 90 * 1000;
let resourcesCache = { guildId: null, data: null, at: 0 };
let resourcesInflight = null;
function getConfiguredGuildId() {
const id = configStore.supportbot?.General?.GuildId;
if (!id || id === "GUILD_ID" || String(id).trim() === "") return null;
return String(id).trim();
}
function setConfiguredGuildId(guildId) {
if (!configStore.supportbot.General) {
configStore.supportbot.General = {};
}
configStore.supportbot.General.GuildId = guildId ? String(guildId) : "";
}
function getPrimaryGuild(client) {
if (!client) return null;
const configuredId = getConfiguredGuildId();
if (configuredId) {
const match = client.guilds.cache.get(configuredId);
if (match) return match;
}
return client.guilds.cache.first() || null;
}
function evaluateGuildHealth(client) {
const configuredId = getConfiguredGuildId();
const guilds = [...client.guilds.cache.values()];
if (!configuredId) {
return {
status: "missing_config",
configuredGuildId: null,
message:
"No guild ID is set. Add your Discord server ID under Bot config → General.",
configuredGuild: null,
extraGuilds: guilds.map(formatGuildSummary),
};
}
const configuredGuild = client.guilds.cache.get(configuredId) || null;
const extraGuilds = guilds
.filter((g) => g.id !== configuredId)
.map(formatGuildSummary);
if (!configuredGuild) {
return {
status: "not_in_guild",
configuredGuildId: configuredId,
message: `The bot is not in the configured server (${configuredId}). Invite it or update the guild ID.`,
configuredGuild: null,
extraGuilds: guilds.map(formatGuildSummary),
};
}
if (extraGuilds.length > 0) {
return {
status: "extra_guilds",
configuredGuildId: configuredId,
message: `The bot is in ${extraGuilds.length} extra server(s). Leave them so only your configured server remains.`,
configuredGuild: formatGuildSummary(configuredGuild),
extraGuilds,
};
}
return {
status: "ok",
configuredGuildId: configuredId,
message: null,
configuredGuild: formatGuildSummary(configuredGuild),
extraGuilds: [],
};
}
function formatGuildSummary(guild) {
return {
id: guild.id,
name: guild.name,
memberCount: guild.memberCount ?? null,
icon: guild.iconURL?.({ size: 128 }) ?? null,
};
}
function syncGuildHealth(client) {
if (!client?.user) {
client.guildHealth = {
status: "offline",
configuredGuildId: getConfiguredGuildId(),
message: "Bot is not connected to Discord.",
configuredGuild: null,
extraGuilds: [],
};
return client.guildHealth;
}
client.guildHealth = evaluateGuildHealth(client);
return client.guildHealth;
}
function logGuildWarning(client, message) {
const name = client?.user?.username || "Bot";
console.warn(`\x1b[33m[Guild]\x1b[0m ${name}: ${message}`);
}
async function leaveGuild(client, guildId) {
const guild = client.guilds.cache.get(String(guildId));
if (!guild) {
throw new Error("Bot is not in that server.");
}
const configuredId = getConfiguredGuildId();
if (configuredId && guild.id === configuredId) {
throw new Error("Cannot leave the configured server. Change the guild ID first.");
}
await guild.leave();
syncGuildHealth(client);
return syncGuildHealth(client);
}
function buildResourcesFromGuild(guild) {
const roles = [...guild.roles.cache.values()]
.filter((r) => r.id !== guild.id)
.sort((a, b) => b.position - a.position)
.map((r) => ({
id: r.id,
name: r.name,
color: r.hexColor || null,
}));
const channels = [...guild.channels.cache.values()]
.filter(
(c) =>
c.type === ChannelType.GuildText ||
c.type === ChannelType.GuildVoice ||
c.type === ChannelType.GuildAnnouncement ||
c.type === ChannelType.GuildStageVoice ||
c.type === ChannelType.GuildForum,
)
.sort((a, b) => a.name.localeCompare(b.name))
.map((c) => ({
id: c.id,
name: c.name,
type: c.type,
}));
const categories = [...guild.channels.cache.values()]
.filter((c) => c.type === ChannelType.GuildCategory)
.sort((a, b) => a.name.localeCompare(b.name))
.map((c) => ({
id: c.id,
name: c.name,
}));
return {
guildId: guild.id,
guildName: guild.name,
roles,
channels,
categories,
};
}
async function fetchGuildResourcesFromDiscord(client, guildId) {
const id = guildId || getConfiguredGuildId();
if (!id) return null;
const guild = client.guilds.cache.get(id);
if (!guild) return null;
try {
await withTimeout(
Promise.all([guild.channels.fetch(), guild.roles.fetch()]),
12_000,
"Discord channel/role fetch timed out",
);
} catch (err) {
console.warn("[Guild] Failed to fetch channels/roles:", err.message);
if (guild.roles.cache.size === 0 && guild.channels.cache.size === 0) {
return null;
}
}
return buildResourcesFromGuild(guild);
}
async function fetchGuildResources(client, guildId) {
const id = guildId || getConfiguredGuildId();
if (!id || !client?.user) return null;
const now = Date.now();
if (
resourcesCache.data &&
resourcesCache.guildId === id &&
now - resourcesCache.at < RESOURCES_CACHE_MS
) {
return resourcesCache.data;
}
if (resourcesInflight) {
try {
return await resourcesInflight;
} catch {
/* fall through to retry */
}
}
resourcesInflight = (async () => {
const data = await fetchGuildResourcesFromDiscord(client, id);
if (data) {
resourcesCache = { guildId: id, data, at: Date.now() };
}
return data;
})();
try {
return await resourcesInflight;
} finally {
resourcesInflight = null;
}
}
function clearGuildResourcesCache() {
resourcesCache = { guildId: null, data: null, at: 0 };
resourcesInflight = null;
}
module.exports = {
getConfiguredGuildId,
setConfiguredGuildId,
getPrimaryGuild,
evaluateGuildHealth,
syncGuildHealth,
logGuildWarning,
leaveGuild,
fetchGuildResources,
clearGuildResourcesCache,
};
+181
View File
@@ -0,0 +1,181 @@
const fs = require("fs");
const path = require("path");
const LOG_ROOT = path.resolve(__dirname, "../Logs");
const LOG_TYPES = ["Output", "Warn", "Error"];
function todayDate() {
return new Date().toISOString().split("T")[0];
}
function getLogPath(type, date = todayDate()) {
return path.join(LOG_ROOT, type, `${type}-${date}.log`);
}
/** Prefer today's file; fall back to the newest log in the folder. */
function resolveLogPath(type) {
const todayPath = getLogPath(type);
if (fs.existsSync(todayPath)) return todayPath;
const dir = path.join(LOG_ROOT, type);
if (!fs.existsSync(dir)) return todayPath;
const files = fs
.readdirSync(dir)
.filter((f) => f.endsWith(".log"))
.sort()
.reverse();
if (!files.length) return todayPath;
return path.join(dir, files[0]);
}
function stripAnsi(text) {
return String(text).replace(/\x1b\[[0-9;]*m/g, "");
}
function parseLogLine(line, type) {
const trimmed = line.trimEnd();
if (!trimmed) return null;
const match = trimmed.match(/^\[([^\]]+)\]\s?(.*)$/);
if (match) {
return {
type,
timestamp: match[1],
message: stripAnsi(match[2]),
};
}
return {
type,
timestamp: null,
message: stripAnsi(trimmed),
};
}
function readFromByte(filePath, fromByte) {
if (!fs.existsSync(filePath)) {
return { lines: [], position: 0 };
}
const stat = fs.statSync(filePath);
if (stat.size === 0) {
return { lines: [], position: 0 };
}
const start = Math.max(0, Math.min(fromByte, stat.size));
if (start >= stat.size) {
return { lines: [], position: stat.size };
}
const fd = fs.openSync(filePath, "r");
const buffer = Buffer.alloc(stat.size - start);
fs.readSync(fd, buffer, 0, buffer.length, start);
fs.closeSync(fd);
const text = buffer.toString("utf8");
const lines = text.split(/\r?\n/).filter((l) => l.length > 0);
return { lines, position: stat.size };
}
function readLastLines(filePath, maxLines) {
if (!fs.existsSync(filePath)) {
return { lines: [], position: 0 };
}
const stat = fs.statSync(filePath);
if (stat.size === 0) {
return { lines: [], position: 0 };
}
const chunkSize = Math.min(stat.size, 512 * 1024);
const start = Math.max(0, stat.size - chunkSize);
const fd = fs.openSync(filePath, "r");
const buffer = Buffer.alloc(chunkSize);
fs.readSync(fd, buffer, 0, chunkSize, start);
fs.closeSync(fd);
const lines = buffer
.toString("utf8")
.split(/\r?\n/)
.filter((l) => l.length > 0);
const slice = lines.slice(-maxLines);
return { lines: slice, position: stat.size };
}
/**
* @param {string[]} types
* @param {Record<string, number>} cursor byte offsets per type
* @param {number} initialLines lines to load when cursor is empty
*/
function fetchLogs(types, cursor = {}, initialLines = 300) {
const validTypes = types.filter((t) => LOG_TYPES.includes(t));
const entries = [];
const nextCursor = { ...cursor };
for (const type of validTypes) {
const filePath = resolveLogPath(type);
const prevPos = cursor[type] ?? 0;
let lines = [];
let position = 0;
if (!fs.existsSync(filePath)) {
nextCursor[type] = 0;
continue;
}
if (prevPos === 0 && initialLines > 0) {
const tail = readLastLines(filePath, initialLines);
lines = tail.lines;
position = tail.position;
} else if (prevPos > 0) {
const chunk = readFromByte(filePath, prevPos);
lines = chunk.lines;
position = chunk.position;
} else {
// No tail requested and no cursor — skip content, anchor at EOF
position = fs.statSync(filePath).size;
}
nextCursor[type] = position;
for (const line of lines) {
const entry = parseLogLine(line, type);
if (entry) entries.push(entry);
}
}
entries.sort((a, b) => {
const ta = a.timestamp ? Date.parse(a.timestamp) : 0;
const tb = b.timestamp ? Date.parse(b.timestamp) : 0;
return ta - tb;
});
return { entries, cursor: nextCursor };
}
function getLogMeta() {
const date = todayDate();
return LOG_TYPES.map((type) => {
const filePath = resolveLogPath(type);
const exists = fs.existsSync(filePath) && fs.statSync(filePath).size > 0;
return {
type,
date,
file: exists ? path.basename(filePath) : null,
size: exists ? fs.statSync(filePath).size : 0,
};
});
}
module.exports = {
LOG_ROOT,
LOG_TYPES,
fetchLogs,
getLogMeta,
getLogPath,
resolveLogPath,
};
+269
View File
@@ -0,0 +1,269 @@
const fs = require("fs");
const path = require("path");
const PLACEHOLDER_PATTERNS = [
/ROLE_ID/i,
/CHANNEL_ID/i,
/CATEGORY_ID/i,
/TAG_ID/i,
/FORUM_CHANNEL_ID/i,
/BOT_TOKEN/i,
/MODEL_API_KEY/i,
/PASTEBIN_API_KEY/i,
/YOUR_/i,
/PUT_RANDOM_STRING/i,
/example\.com/i,
];
function isEmpty(value) {
if (value == null) return true;
if (typeof value === "boolean") return false;
if (typeof value === "number") return false;
return String(value).trim() === "";
}
function isPlaceholder(value) {
if (isEmpty(value)) return true;
const s = String(value).trim();
return PLACEHOLDER_PATTERNS.some((p) => p.test(s));
}
function isDiscordId(value) {
return /^\d{17,20}$/.test(String(value).trim());
}
function isConfiguredId(value) {
return isDiscordId(value) && !isPlaceholder(value);
}
function isValidToken(value) {
if (isPlaceholder(value)) return false;
const s = String(value).trim();
return s.length >= 50 && s.includes(".");
}
function scoreChecks(checks) {
const total = checks.length;
const passed = checks.filter((c) => c.ok).length;
if (total === 0) {
return { status: "done", subtitle: "Ready", passed: 0, total: 0 };
}
if (passed === 0) {
const hint = checks.find((c) => !c.ok)?.hint ?? "Not configured yet";
return { status: "todo", subtitle: hint, passed, total };
}
if (passed === total) {
return { status: "done", subtitle: "Configured and ready", passed, total };
}
const next = checks.find((c) => !c.ok);
return {
status: "progress",
subtitle: next?.hint ?? `${passed} of ${total} steps complete`,
passed,
total,
};
}
function evaluateTickets(supportbot, ticketPanel) {
const ticket = supportbot?.Ticket ?? {};
const ticketType = String(ticket.TicketType || "channels").toLowerCase();
return scoreChecks([
{
ok: ticketPanel?.Panel === true,
hint: "Enable the ticket panel",
},
{
ok: isConfiguredId(ticket.TicketHome),
hint: "Set TicketHome channel ID",
},
{
ok:
ticketType !== "channels" ||
isConfiguredId(ticket.TicketChannelsCategory),
hint: "Set ticket category ID",
},
{
ok: !isPlaceholder(ticketPanel?.Button?.Text),
hint: "Configure panel button text",
},
]);
}
function evaluateSupportbot(supportbot) {
const roles = supportbot?.Roles?.StaffMember ?? {};
const welcome = supportbot?.Welcome ?? {};
return scoreChecks([
{ ok: isValidToken(supportbot?.General?.Token), hint: "Add your bot token" },
{
ok:
isConfiguredId(roles.Staff) ||
isConfiguredId(roles.Admin) ||
isConfiguredId(roles.Moderator),
hint: "Set staff role IDs",
},
{
ok: !welcome.Enabled || isConfiguredId(welcome.Channel),
hint: "Set welcome channel ID",
},
{
ok: !isPlaceholder(supportbot?.Activity?.Status),
hint: "Set bot activity status",
},
]);
}
function evaluateTranscripts(supportbot, transcriptCount) {
const ticketReady = isConfiguredId(supportbot?.Ticket?.TicketHome);
if (!ticketReady) {
return {
status: "todo",
subtitle: "Set up tickets first",
passed: 0,
total: 2,
};
}
if (transcriptCount > 0) {
return {
status: "done",
subtitle: `${transcriptCount} transcript${transcriptCount === 1 ? "" : "s"} saved`,
passed: 2,
total: 2,
};
}
return {
status: "progress",
subtitle: "Close tickets to generate transcripts",
passed: 1,
total: 2,
};
}
function evaluateSuggestions(supportbot) {
const sug = supportbot?.Suggestions ?? {};
const mode = String(sug.Mode || "Channel").toLowerCase();
const channelOk =
mode === "forum"
? isConfiguredId(sug.ForumChannel)
: isConfiguredId(sug.Channel);
return scoreChecks([
{
ok: channelOk,
hint:
mode === "forum"
? "Set suggestions forum channel"
: "Set suggestions channel ID",
},
{
ok: !isPlaceholder(sug.UpvoteEmoji) && !isPlaceholder(sug.DownvoteEmoji),
hint: "Configure voting emojis",
},
]);
}
function evaluateAi(supportbotAi) {
if (supportbotAi?.Enabled !== true) {
return {
status: "progress",
subtitle: "AI is disabled in config",
passed: 0,
total: 3,
};
}
return scoreChecks([
{
ok: !isPlaceholder(supportbotAi?.General?.Model_API_Key),
hint: "Add your model API key",
},
{
ok: isConfiguredId(supportbotAi?.Channels?.AIChannel),
hint: "Set AI channel ID",
},
{
ok: !isPlaceholder(supportbotAi?.General?.Model),
hint: "Choose an AI model",
},
]);
}
function evaluateCommands(commands) {
const entries = Object.entries(commands || {}).filter(
([, v]) => v && typeof v === "object" && "Enabled" in v,
);
if (!entries.length) {
return { status: "todo", subtitle: "No commands configured", passed: 0, total: 0 };
}
const enabled = entries.filter(([, v]) => v.Enabled !== false).length;
const total = entries.length;
const ratio = enabled / total;
if (ratio >= 0.85) {
return {
status: "done",
subtitle: `${enabled} of ${total} commands enabled`,
passed: enabled,
total,
};
}
if (enabled === 0) {
return {
status: "todo",
subtitle: "Enable slash commands",
passed: 0,
total,
};
}
return {
status: "progress",
subtitle: `${enabled} of ${total} commands enabled`,
passed: enabled,
total,
};
}
function countTranscripts() {
const dir = path.resolve(__dirname, "../Data/Transcripts");
if (!fs.existsSync(dir)) return 0;
return fs
.readdirSync(dir)
.filter((f) => f.endsWith("-transcript.html")).length;
}
function evaluateAllModules(configStore, options = {}) {
const supportbot = configStore.supportbot;
const ticketPanel = configStore.ticketPanel;
const supportbotAi = configStore.supportbotAi;
const commands = configStore.commands;
const transcriptCount =
options.transcriptCount ?? countTranscripts();
return {
tickets: evaluateTickets(supportbot, ticketPanel),
supportbot: evaluateSupportbot(supportbot),
transcripts: evaluateTranscripts(supportbot, transcriptCount),
suggestions: evaluateSuggestions(supportbot),
ai: evaluateAi(supportbotAi),
commands: evaluateCommands(commands),
};
}
module.exports = {
evaluateAllModules,
isPlaceholder,
isConfiguredId,
};
+63
View File
@@ -0,0 +1,63 @@
const notificationStore = require("./NotificationStore.js");
const { fetchUpdateInfo } = require("./UpdateChecker.js");
function notifyBotRestart(success, errorMessage) {
if (success) {
return notificationStore.add({
type: "bot",
title: "Bot restarted",
message:
"Discord bot reconnected with your latest config. API and dashboard stayed online.",
});
}
return notificationStore.add({
type: "error",
title: "Bot failed to restart",
message: errorMessage || "Check the logs for details.",
href: "/logs",
});
}
function notifyUpdateAvailable(info) {
return notificationStore.add({
id: "update-available",
type: "update",
title: "Update available",
message: `Version ${info.latest} is ready (you are on ${info.current}).`,
href: "/settings",
});
}
function notifyUpdateInstalled(message) {
return notificationStore.add({
type: "update",
title: "Update installed",
message:
message ||
"Files were updated. Restart your server (npm start) to finish applying changes.",
href: "/settings",
});
}
function clearUpdateAvailable() {
notificationStore.dismiss("update-available");
}
async function runUpdateCheck() {
const info = await fetchUpdateInfo();
if (info.updateAvailable) {
notifyUpdateAvailable(info);
} else {
clearUpdateAvailable();
}
return info;
}
module.exports = {
notifyBotRestart,
notifyUpdateAvailable,
notifyUpdateInstalled,
clearUpdateAvailable,
runUpdateCheck,
};
+86
View File
@@ -0,0 +1,86 @@
const MAX_NOTIFICATIONS = 50;
/** @type {Map<string, object>} */
const byId = new Map();
/** @type {string[]} */
let order = [];
/**
* @param {object} input
* @param {string} [input.id] Stable id replaces existing (e.g. update-available)
*/
function add(input) {
const id =
input.id ||
`n-${Date.now()}-${Math.random().toString(36).slice(2, 8)}`;
const item = {
id,
type: input.type || "info",
title: input.title || "Notification",
message: input.message || "",
href: input.href || null,
createdAt: input.createdAt || Date.now(),
read: false,
};
if (byId.has(id)) {
order = order.filter((x) => x !== id);
}
byId.set(id, item);
order.unshift(id);
while (order.length > MAX_NOTIFICATIONS) {
const removed = order.pop();
if (removed) byId.delete(removed);
}
return item;
}
function list() {
return order.map((id) => byId.get(id)).filter(Boolean);
}
function unreadCount() {
let n = 0;
for (const item of byId.values()) {
if (!item.read) n++;
}
return n;
}
function markRead(ids) {
if (ids === "all") {
for (const item of byId.values()) {
item.read = true;
}
return;
}
for (const id of ids) {
const item = byId.get(id);
if (item) item.read = true;
}
}
function dismiss(id) {
if (!byId.has(id)) return false;
byId.delete(id);
order = order.filter((x) => x !== id);
return true;
}
function clear() {
byId.clear();
order = [];
}
module.exports = {
add,
list,
unreadCount,
markRead,
dismiss,
clear,
};
+2 -2
View File
@@ -4,8 +4,8 @@ const Discord = require("discord.js");
const yaml = require("js-yaml");
const db = require("./Database.js");
const supportbot = yaml.load(fs.readFileSync("./Configs/supportbot.yml", "utf8"));
const msgconfig = yaml.load(fs.readFileSync("./Configs/messages.yml", "utf8"));
const supportbot = require("./ConfigStore").supportbot;
const msgconfig = require("./ConfigStore").messages;
function escapeHtml(str = "") {
return String(str)
+55
View File
@@ -0,0 +1,55 @@
const fs = require("fs");
const path = require("path");
const UPDATE_REPO = "C-h-a-r/SupportBot-Dashboard";
const UPDATE_BRANCH = "release";
function compareVersions(a, b) {
const pa = String(a)
.replace(/^v/i, "")
.split(".")
.map((n) => parseInt(n, 10) || 0);
const pb = String(b)
.replace(/^v/i, "")
.split(".")
.map((n) => parseInt(n, 10) || 0);
for (let i = 0; i < Math.max(pa.length, pb.length); i++) {
if ((pa[i] || 0) > (pb[i] || 0)) return 1;
if ((pa[i] || 0) < (pb[i] || 0)) return -1;
}
return 0;
}
async function fetchUpdateInfo() {
const axios = require("axios");
const pkgPath = path.join(__dirname, "../package.json");
const currentPkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
const current = currentPkg.version;
const remoteRes = await axios.get(
`https://raw.githubusercontent.com/${UPDATE_REPO}/${UPDATE_BRANCH}/package.json`,
{
timeout: 15000,
headers: { "User-Agent": "SupportBot-Dashboard" },
},
);
const latest = remoteRes.data?.version || current;
const updateAvailable = compareVersions(latest, current) > 0;
return {
current,
latest,
updateAvailable,
repository: `https://github.com/${UPDATE_REPO}`,
branch: UPDATE_BRANCH,
zipUrl: `https://github.com/${UPDATE_REPO}/archive/refs/heads/${UPDATE_BRANCH}.zip`,
};
}
module.exports = {
compareVersions,
fetchUpdateInfo,
UPDATE_REPO,
UPDATE_BRANCH,
};
+14
View File
@@ -0,0 +1,14 @@
function withTimeout(promise, ms, message) {
let timer;
const timeout = new Promise((_, reject) => {
timer = setTimeout(() => {
reject(new Error(message || `Timed out after ${ms}ms`));
}, ms);
});
return Promise.race([promise, timeout]).finally(() => {
clearTimeout(timer);
});
}
module.exports = { withTimeout };