Compare commits

...

11 Commits

Author SHA1 Message Date
54709a898b updated api 2022-03-06 11:20:36 -06:00
d6d75abd87 removed extra comment 2022-02-24 10:41:15 -06:00
0ff3a57747 updated readme 2022-02-15 16:05:16 -06:00
9fb3bf6941 renamed index to main lol 2022-02-15 16:01:08 -06:00
2956e24684 comments 2022-02-15 15:50:36 -06:00
c2447b180e fixed type definition errors 2022-02-15 15:24:45 -06:00
a3103f73c3 removed debugger 2022-02-15 15:09:27 -06:00
5348ab487b separated type definitions and util functions 2022-02-15 15:06:34 -06:00
513a9d1582 added more strings 2022-02-14 14:56:47 -06:00
458d3f3d76 added embed support to lang 2022-02-14 14:37:10 -06:00
28fb9ed3c8 deleted empty files 2022-02-14 12:13:50 -06:00
25 changed files with 889 additions and 238 deletions

View File

@@ -5,7 +5,7 @@
"plugin:@typescript-eslint/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": { "project": ["./tsconfig.json"] },
"parserOptions": { "project": ["./tsconfig.eslint.json"] },
"plugins": [
"@typescript-eslint"
],
@@ -17,6 +17,7 @@
"allowNumber" : false
}
],
/* important */
"prefer-const": "error",
"quotes": ["error", "single"],

View File

@@ -2,10 +2,6 @@
# 1800queue
## Invite info
needs: create commands/send messages
## Prerequirements
Download and install [Node.js](https://nodejs.org/en/)
@@ -48,6 +44,8 @@ Download and install [Node.js](https://nodejs.org/en/)
## Starting
**Important**: the bot's invite needs permission to `Create Commands` and `Send Messages`
1. Open the `scripts` folder
2. Open the folder that corresponds with your operating system
3. Run the `start` file

36
dist/api.js vendored
View File

@@ -25,9 +25,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
exports.getPlayerInteraction = exports.getPlayer = void 0;
/*eslint prefer-const: "error"*/
const cheerio = __importStar(require("cheerio"));
const discord_js_1 = require("discord.js");
const https_1 = __importDefault(require("https"));
const util_1 = require("./util");
const main_1 = require("./util/main");
const Lang = __importStar(require("./lang"));
const uniteApiRegex = {
//$1 = name, $2 = id
ogtitle: /unite api - (.+) \((.*)\)/i,
@@ -109,7 +109,7 @@ function readHTML(html) {
extraLines.push(line);
}
if (lines.length === 0)
throw (0, util_1.emsg)('Unable to read data, please try again');
throw (0, main_1.emsg)('Unable to read data, please try again');
//bring the first lines removed back into the data
lines = [
...lines,
@@ -122,7 +122,7 @@ function readHTML(html) {
if (regex[0].test(line)) { //is master/has elo
const regexData = line.match(regex[0]);
if (!regexData || regexData.length < 4)
throw (0, util_1.emsg)('Unable to read data, please try again');
throw (0, main_1.emsg)('Unable to read data, please try again');
foundData.level = regexData[1];
foundData.rank = regexData[2];
foundData.elo = regexData[3];
@@ -130,7 +130,7 @@ function readHTML(html) {
else { //is not master/has a class
const regexData = line.match(regex[1]);
if (!regexData || regexData.length < 4)
throw (0, util_1.emsg)('Unable to read data, please try again');
throw (0, main_1.emsg)('Unable to read data, please try again');
foundData.level = regexData[1];
foundData.rank = regexData[2];
foundData.class = regexData[3];
@@ -187,18 +187,18 @@ async function sendPlayerEmbed(interaction, data) {
eloStr = `(${data.elo})`;
else
eloStr = `Class ${data.class}`;
const embed = new discord_js_1.MessageEmbed()
.setTitle(`${data.name} (${data.id})`)
.setURL(`https://uniteapi.dev/p/${encodeURIComponent(data.name)}`)
.setTimestamp()
.setThumbnail(data.avatar)
.setDescription(`Level ${data.level}
${data.rank} ${eloStr}
**Battles** ${data.battles}
**Wins** ${data.wins}
**Win Rate** ${data.winrate}`);
await interaction.editReply({ embeds: [embed] });
await interaction.editReply(Lang.getEmbed('api.player', {
name: data.name,
id: data.id,
nameEncoded: encodeURIComponent(data.name),
avatar: data.avatar,
level: data.level,
rank: data.rank,
elo: eloStr,
battles: data.battles,
wins: data.wins,
winrate: data.winrate
}));
}
/**
* calls getPlayer() with the name from the interaction
@@ -210,7 +210,7 @@ async function getPlayerInteraction(interaction) {
await interaction.deferReply();
const data = await getPlayer(username);
if (data === null)
throw (0, util_1.emsg)('api.noUser');
throw (0, main_1.emsg)('api.noUser');
else
sendPlayerEmbed(interaction, data);
}

94
dist/lang.js vendored
View File

@@ -1,6 +1,7 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.get = exports.setLang = void 0;
exports.getEmbed = exports.get = exports.setLang = void 0;
const lang_1 = require("./util/lang");
const LANG = {
en: {
main: {
@@ -11,7 +12,44 @@ const LANG = {
create: 'A queue for teams of {teamsize} has been created',
close: 'Queue has been closed',
join: 'Joined the queue',
leave: 'Left the queue'
leave: 'Left the queue',
team: {
embed: true,
title: 'Team',
description: '{team}'
},
queue: {
embed: true,
title: 'Active Queue',
fields: [
{
name: 'Team Size',
value: '{teamsize}'
},
{
name: 'Players Joined',
value: '{playercount}'
}
],
footer: 'type `/join`'
}
},
api: {
player: {
embed: true,
title: '{name} ({id})',
url: 'https://uniteapi.dev/p/{nameEncoded}',
timestamp: true,
thumbnail: '{avatar}',
description: [
'Level {level}',
'{rank} {elo}',
'',
'**Battles** {battles}',
'**Wins** {wins}',
'**Win Rate** {winrate}'
]
}
},
error: {
main: {
@@ -35,6 +73,7 @@ const LANG = {
}
}
};
/* MAIN */
let LANGID = 'en';
if (!(LANGID in LANG))
throw 'language id does not exist';
@@ -45,17 +84,10 @@ function setLang(langid) {
throw 'language id does not exist';
}
exports.setLang = setLang;
function template(str, args) {
return str.replace(/{\w+}/g, str => {
const key = str.substring(1, str.length - 1);
if (key in args)
return args[key];
return key;
});
}
/**
* reads language json
* reads language json (just strings)
* @param id ex: discord.error.noActiveQueue
* @param args list of key/value pairs to represent template values
* @returns language value, defaults to `id` parameter
*/
function get(id, args = {}) {
@@ -65,7 +97,9 @@ function get(id, args = {}) {
if (key in finding) {
const found = finding[key];
if (typeof found === 'string')
return template(found, args);
return (0, lang_1.template)(found, args);
if (found.embed === true)
return (0, lang_1.embedObjStr)(found, args, id);
finding = found;
}
else
@@ -74,3 +108,39 @@ function get(id, args = {}) {
return id;
}
exports.get = get;
/**
* reads language json as an object (could be embed or just string)
* @param id ex: discord.error.noActiveQueue
* @param args list of key/value pairs to represent template values
* @param otherOptions values to be passed through to the return value
* @returns language value, defaults to `id` parameter
*/
function getEmbed(id, args = {}, otherOptions = {}) {
const embedData = {
...otherOptions,
embeds: []
};
const keySpl = id.split('.').map(k => k.trim()).filter(k => k);
let finding = LANG[LANGID];
for (const key of keySpl) {
if (key in finding) {
const found = finding[key];
if (typeof found === 'string') {
embedData.content = (0, lang_1.template)(found, args);
break;
}
if (found.embed === true) {
const embedObj = found, { content } = embedObj, embed = (0, lang_1.embedObjEmbed)(embedObj, args);
embedData.embeds.push(embed);
if (content !== undefined)
embedData.content = content;
return embedData;
}
finding = found;
}
else
break;
}
return embedData;
}
exports.getEmbed = getEmbed;

View File

@@ -25,7 +25,7 @@ const api_1 = require("./api");
const discord_1 = require("./discord");
const Lang = __importStar(require("./lang"));
const queue_1 = require("./queue");
const util_1 = require("./util");
const main_1 = require("./util/main");
const CLIENT = new discord_js_1.Client({ intents: [discord_js_1.Intents.FLAGS.GUILDS] });
//init logs with a timestamp
console.log(new Date().toISOString() + '\n\n');
@@ -76,7 +76,7 @@ CLIENT.on('interactionCreate', async (interaction) => {
}
}
catch (e) {
if (e instanceof util_1.errorMessage) {
if (e instanceof main_1.errorMessage) {
if (interaction.deferred || interaction.replied)
interaction.editReply(e.msg);
else

41
dist/queue.js vendored
View File

@@ -26,9 +26,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
exports.QueueCommands = exports.queueContains = exports.discordInit = exports.queueRemove = exports.queueCreate = void 0;
const discord_js_1 = require("discord.js");
const fs = __importStar(require("fs"));
const util_1 = require("./util");
const Lang = __importStar(require("./lang"));
//load queues from file
const discord_1 = require("./util/discord");
const main_1 = require("./util/main");
//load queues from file`
if (!fs.existsSync('./queues.json'))
fs.writeFileSync('./queues.json', '{}');
const _QUEUE = fs.readFileSync('./queues.json').toString(), QUEUE = new Map();
@@ -55,11 +56,7 @@ async function checkQueue(channel) {
return;
if (info.players.length >= info.teamsize) {
const team = info.players.splice(0, info.teamsize).map(m => m.toString());
//TODO add embeds to lang.ts
const embed = new discord_js_1.MessageEmbed()
.setTitle('Team')
.setDescription(team.join('\n'));
await channel.send({ embeds: [embed] });
await channel.send(Lang.getEmbed('discord.team', { team: team.join('\n') }));
}
}
function queueCreate(channelId, teamsize) {
@@ -80,7 +77,7 @@ SaveQueue();
async function discordInit(client) {
for (const channelId of QUEUE.keys()) {
const info = QUEUE.get(channelId), channel = await client.channels.fetch(channelId);
if (!info) { //no idea what could cause this but TS complains
if (!info) {
queueRemove(channelId);
continue;
}
@@ -105,7 +102,7 @@ exports.discordInit = discordInit;
function getInfo(interaction) {
const info = QUEUE.get(interaction.channelId);
if (!info)
throw (0, util_1.emsg)('discord.noQueue');
throw (0, main_1.emsg)('discord.noQueue');
return info;
}
/**
@@ -115,8 +112,8 @@ function getInfo(interaction) {
* @returns object containing each
*/
const getAll = (interaction) => ({
member: (0, util_1.getMember)(interaction),
channel: (0, util_1.getChannel)(interaction),
member: (0, discord_1.getMember)(interaction),
channel: (0, discord_1.getChannel)(interaction),
info: getInfo(interaction)
});
/**
@@ -137,11 +134,11 @@ exports.queueContains = queueContains;
* @throws errorMessage class if it cannot be left
*/
function open(interaction) {
(0, util_1.memberIsModThrow)(interaction);
(0, discord_1.memberIsModThrow)(interaction);
const { channelId } = interaction, teamsize = interaction.options.getInteger('teamsize', true);
const existing = QUEUE.get(channelId);
if (existing)
throw (0, util_1.emsg)(Lang.get('error.discord.noCreate', {
throw (0, main_1.emsg)(Lang.get('error.discord.noCreate', {
teamsize: existing.teamsize.toString()
}));
queueCreate(channelId, teamsize);
@@ -155,7 +152,7 @@ function open(interaction) {
* @throws errorMessage class if it cannot be joined
*/
async function close(interaction) {
(0, util_1.memberIsModThrow)(interaction);
(0, discord_1.memberIsModThrow)(interaction);
QUEUE.delete(interaction.channelId);
await interaction.reply(Lang.get('discord.close'));
}
@@ -166,12 +163,12 @@ async function close(interaction) {
*/
async function queue(interaction) {
const info = getInfo(interaction);
const embed = new discord_js_1.MessageEmbed()
.setTitle('Active Queue')
.addField('Team Size', info.teamsize.toString(), true)
.addField('Players Joined', info.players.length.toString(), true)
.setFooter({ text: 'type /join' }); //TODO
await interaction.reply({ embeds: [embed], ephemeral: true });
await interaction.reply(Lang.getEmbed('discord.queue', {
teamsize: info.teamsize.toString(),
playercount: info.players.length.toString(),
}, {
ephemeral: true
}));
}
/**
* joins a queue
@@ -181,7 +178,7 @@ async function queue(interaction) {
async function join(interaction) {
const { member, info, channel } = getAll(interaction);
if (queueContains(interaction))
throw (0, util_1.emsg)('discord.inQueue');
throw (0, main_1.emsg)('discord.inQueue');
info.players.push(member);
QUEUE.set(interaction.channelId, info);
await interaction.reply(Lang.get('discord.join'));
@@ -195,7 +192,7 @@ async function join(interaction) {
async function leave(interaction) {
const { member, info } = getAll(interaction);
if (!queueContains(interaction))
throw (0, util_1.emsg)('discord.notInQueue');
throw (0, main_1.emsg)('discord.notInQueue');
info.players.splice(info.players.indexOf(member), 1);
QUEUE.set(interaction.channelId, info);
await interaction.reply(Lang.get('discord.leave'));

View File

@@ -1 +0,0 @@
"use strict";

45
dist/util/discord.js vendored Normal file
View File

@@ -0,0 +1,45 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.memberIsModThrow = exports.memberIsMod = exports.getChannel = exports.getMember = void 0;
const discord_js_1 = require("discord.js");
const main_1 = require("./main");
/**
* get the GuildMember of an interaction
* @throws errorMessage class if it cannot be read
*/
function getMember(interaction) {
const member = interaction.member;
if (!(member instanceof discord_js_1.GuildMember))
throw (0, main_1.emsg)('general.noMember');
return member;
}
exports.getMember = getMember;
/**
* get the TextChannel of an interaction
* @throws errorMessage class if it cannot be read
*/
function getChannel(interaction) {
const channel = interaction.channel;
if (!(channel instanceof discord_js_1.TextChannel))
throw (0, main_1.emsg)('general.noChannel');
return channel;
}
exports.getChannel = getChannel;
/**
* get the TextChannel of an interaction
* @throws errorMessage class if the Member cannot be read
*/
function memberIsMod(interaction) {
const member = getMember(interaction);
return member.permissionsIn(interaction.channelId).has('MANAGE_MESSAGES');
}
exports.memberIsMod = memberIsMod;
/**
* get the TextChannel of an interaction
* @throws errorMessage class if the Member cannot be read or if Member is not a mod
*/
function memberIsModThrow(interaction) {
if (!memberIsMod(interaction))
throw (0, main_1.emsg)('discord.notMod');
}
exports.memberIsModThrow = memberIsModThrow;

119
dist/util/lang.js vendored Normal file
View File

@@ -0,0 +1,119 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.embedObjEmbed = exports.embedObjStr = exports.resolveColor = exports.bigString = exports.template = void 0;
const discord_js_1 = require("discord.js");
/**
*
* @param str
* @param args
* @returns
*/
function template(str, args) {
return str.replace(/{\w+}/g, str => {
const key = str.substring(1, str.length - 1);
if (key in args)
return args[key];
return key;
});
}
exports.template = template;
/**
* converts bigString to string
*/
function bigString(bigStr) {
if (Array.isArray(bigStr))
return bigStr.join('\n');
return bigStr;
}
exports.bigString = bigString;
/**
* converts Hex Color string to an RGB array
*/
function resolveColor(color) {
color = color.replace(/[^0-9a-f]/gi, '');
const colorNum = [0, 0, 0];
if (color.length === 3 || color.length === 6) {
const colorSpl = /([0-9a-f]{1,2})([0-9a-f]{1,2})([0-9a-f]{1,2})/.exec(color);
if (!colorSpl)
return colorNum;
for (let i = 0; i < colorSpl.length && i < colorNum.length; i++)
colorNum[i] = parseInt(colorSpl[i], 16);
}
return colorNum;
}
exports.resolveColor = resolveColor;
/**
* converts embedObj to a string if applicable
* @param fallback the string to use if no valid strings can be found
*/
function embedObjStr(embedObj, args = {}, fallback = '') {
if (embedObj.content !== undefined)
return template(bigString(embedObj.content), args);
if (embedObj.description !== undefined)
return template(bigString(embedObj.description), args);
return fallback;
}
exports.embedObjStr = embedObjStr;
/**
* converts embedObj to Discord.MessageEmbed
*/
function embedObjEmbed(embedObj, args = {}) {
const embed = new discord_js_1.MessageEmbed(), { author, color, description, fields, footer, image, thumbnail, timestamp, title, url } = embedObj;
if (author !== undefined) {
let authorFix;
if (typeof author === 'string')
authorFix = {
name: template(author, args)
};
else {
const { name, icon, url } = author;
authorFix = {
name: template(name, args)
};
if (icon !== undefined)
authorFix.icon = template(icon, args);
if (url !== undefined)
authorFix.url = template(url, args);
}
embed.setAuthor(authorFix);
}
if (footer !== undefined) {
let footerFix;
if (typeof footer === 'string')
footerFix = {
text: template(footer, args)
};
else {
const { text, icon } = footer;
footerFix = {
text: template(text, args)
};
if (icon !== undefined)
footerFix.icon = template(icon, args);
}
embed.setFooter(footerFix);
}
if (color !== undefined)
embed.setColor(resolveColor(template(color, args)));
if (description !== undefined)
embed.setDescription(template(bigString(description), args));
if (image !== undefined)
embed.setImage(template(image, args));
if (thumbnail !== undefined)
embed.setThumbnail(template(thumbnail, args));
if (title !== undefined)
embed.setTitle(template(title, args));
if (url !== undefined)
embed.setURL(template(url, args));
if (timestamp === true)
embed.setTimestamp();
else if (typeof timestamp === 'string')
embed.setTimestamp(new Date(template(timestamp, args)));
else if (timestamp !== false)
embed.setTimestamp(timestamp);
fields?.forEach(field => {
embed.addField(template(field.name, args), template(bigString(field.value), args), field.inline);
});
return embed;
}
exports.embedObjEmbed = embedObjEmbed;

63
dist/util/main.js vendored Normal file
View File

@@ -0,0 +1,63 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.emsg = exports.errorMessage = exports.shuffle = void 0;
const Lang = __importStar(require("../lang"));
/**
* shuffles an array
* https://stackoverflow.com/a/2450976/2856416
* @param array an array
* @returns an array but shuffled
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function shuffle(array) {
let currentIndex = array.length, randomIndex;
// While there remain elements to shuffle...
while (currentIndex != 0) {
// Pick a remaining element...
randomIndex = Math.floor(Math.random() * currentIndex);
currentIndex--;
// And swap it with the current element.
[array[currentIndex], array[randomIndex]] = [
array[randomIndex], array[currentIndex]
];
}
return array;
}
exports.shuffle = shuffle;
/**
* use the emsg() function instead
*/
class errorMessage {
constructor(msg, ephemeral = true) {
this.msg = msg;
this.ephemeral = ephemeral;
}
}
exports.errorMessage = errorMessage;
/**
* a simple class to contain an error message and related data
* @param msg error message
* @param ephemeral (default=true)
* @returns new errorMessage
*/
const emsg = (msg, ephemeral = true) => new errorMessage(Lang.get(`error.${msg}`), ephemeral);
exports.emsg = emsg;

View File

@@ -2,7 +2,7 @@
"name": "1800queue",
"version": "1.0.0",
"description": "",
"main": "dist/index.js",
"main": "dist/main.js",
"scripts": {
"build": "tsc",
"start": "node .",

View File

@@ -1,9 +1,9 @@
/*eslint prefer-const: "error"*/
import * as cheerio from 'cheerio';
import { CommandInteraction, MessageEmbed } from 'discord.js';
import { IncomingMessage } from 'http';
import http from 'https';
import { emsg } from './util';
import { CommandInteraction } from 'discord.js';
import http, { IncomingMessage } from 'http';
import { emsg } from './util/main';
import * as Lang from './lang';
const uniteApiRegex = {
//$1 = name, $2 = id
@@ -15,20 +15,6 @@ const uniteApiRegex = {
]
};
type uniteApiData = {
name: string,
id: string,
avatar: string,
level: string,
rank: string,
class: string|null,
elo: string|null,
battles: string,
wins: string,
winrate: string
}
/**
* gets the html of the uniteApi page for the player
* @param name name of player
@@ -40,8 +26,8 @@ function getHTML(name: string): Promise<string> {
return new Promise((resolve, reject) => {
const init = {
host: 'uniteapi.dev',
const opts = {
host: '147.182.215.216',
path: `/p/${encodeURIComponent(name)}`,
method: 'GET',
};
@@ -63,7 +49,7 @@ function getHTML(name: string): Promise<string> {
});
};
const req = http.request(init, callback);
const req = http.request(opts, callback);
req.end();
});
@@ -91,6 +77,7 @@ function readHTML(html: string): uniteApiData {
wins: '',
winrate: ''
};
let metaElems = $('meta').toArray();
//filter down to just ones named "og:..."
@@ -227,19 +214,18 @@ async function sendPlayerEmbed(interaction: CommandInteraction, data: uniteApiDa
else
eloStr = `Class ${data.class}`;
const embed = new MessageEmbed()
.setTitle(`${data.name} (${data.id})`)
.setURL(`https://uniteapi.dev/p/${encodeURIComponent(data.name)}`)
.setTimestamp()
.setThumbnail(data.avatar)
.setDescription(`Level ${data.level}
${data.rank} ${eloStr}
**Battles** ${data.battles}
**Wins** ${data.wins}
**Win Rate** ${data.winrate}`);
await interaction.editReply({embeds: [embed]});
await interaction.editReply(Lang.getEmbed('api.player', {
name: data.name,
id: data.id,
nameEncoded: encodeURIComponent(data.name),
avatar: data.avatar,
level: data.level,
rank: data.rank,
elo: eloStr,
battles: data.battles,
wins: data.wins,
winrate: data.winrate
}));
}
/**

View File

@@ -1,5 +1,4 @@
type LangObj = { [keys:string]: LangObj | string }
type LangObjWhole = { [langid:string]: LangObj }
import { embedObjEmbed, embedObjStr, template } from './util/lang';
const LANG: LangObjWhole = {
@@ -14,7 +13,46 @@ const LANG: LangObjWhole = {
create: 'A queue for teams of {teamsize} has been created',
close: 'Queue has been closed',
join: 'Joined the queue',
leave: 'Left the queue'
leave: 'Left the queue',
team: {
embed: true,
title: 'Team',
description: '{team}'
},
queue: {
embed: true,
title: 'Active Queue',
fields: [
{
name: 'Team Size',
value: '{teamsize}'
},
{
name: 'Players Joined',
value: '{playercount}'
}
],
footer: 'type `/join`'
}
},
api: {
player: {
embed: true,
title: '{name} ({id})',
url: 'https://uniteapi.dev/p/{nameEncoded}',
timestamp: true,
thumbnail: '{avatar}',
description: [
'Level {level}',
'{rank} {elo}',
'',
'**Battles** {battles}',
'**Wins** {wins}',
'**Win Rate** {winrate}'
]
}
},
error: {
@@ -47,6 +85,7 @@ const LANG: LangObjWhole = {
};
/* MAIN */
let LANGID = 'en';
if (!(LANGID in LANG))
@@ -59,27 +98,13 @@ export function setLang(langid: string) {
throw 'language id does not exist';
}
function template(str: string, args: {[keys: string]: string}): string {
return str.replace(/{\w+}/g, str => {
const key = str.substring(1, str.length-1);
if (key in args)
return args[key];
return key;
});
}
/**
* reads language json
* reads language json (just strings)
* @param id ex: discord.error.noActiveQueue
* @param args list of key/value pairs to represent template values
* @returns language value, defaults to `id` parameter
*/
export function get(id: string, args: {[keys: string]: string} = {}): string {//discord.error.noActiveQueue
export function get(id: string, args: basicObjectStr = {}): string {
const keySpl = id.split('.').map(k => k.trim()).filter(k => k);
@@ -94,7 +119,10 @@ export function get(id: string, args: {[keys: string]: string} = {}): string {//
if (typeof found === 'string')
return template(found, args);
finding = found;
if (found.embed === true)
return embedObjStr(found as embedObj, args, id);
finding = found as LangObj;
} else
break;
@@ -103,3 +131,55 @@ export function get(id: string, args: {[keys: string]: string} = {}): string {//
return id;
}
/**
* reads language json as an object (could be embed or just string)
* @param id ex: discord.error.noActiveQueue
* @param args list of key/value pairs to represent template values
* @param otherOptions values to be passed through to the return value
* @returns language value, defaults to `id` parameter
*/
export function getEmbed(id: string, args: basicObjectStr = {}, otherOptions: basicObject = {}): embedData {
const embedData: embedData = {
...otherOptions,
embeds: []
};
const keySpl = id.split('.').map(k => k.trim()).filter(k => k);
let finding = LANG[LANGID];
for (const key of keySpl) {
if (key in finding) {
const found = finding[key];
if (typeof found === 'string') {
embedData.content = template(found, args);
break;
}
if (found.embed === true) {
const embedObj = found as embedObj,
{content} = embedObj,
embed = embedObjEmbed(embedObj, args);
embedData.embeds.push(embed);
if (content !== undefined)
embedData.content = content;
return embedData;
}
finding = found as LangObj;
} else
break;
}
return embedData;
}

View File

@@ -5,7 +5,7 @@ import { getPlayerInteraction } from './api';
import { registerCommands } from './discord';
import * as Lang from './lang';
import { discordInit, QueueCommands } from './queue';
import { errorMessage } from './util';
import { errorMessage } from './util/main';
const CLIENT = new Client({ intents: [Intents.FLAGS.GUILDS] });
//init logs with a timestamp

View File

@@ -1,14 +1,10 @@
/* TODO
join message should contain your current position in the queue, editing it to keep it current
*/
import { Client, CommandInteraction, MessageEmbed, TextChannel } from 'discord.js';
import { Client, CommandInteraction, TextChannel } from 'discord.js';
import * as fs from 'fs';
import { emsg, getChannel, getMember, memberIsModThrow, queueInfo, queueInfoBase } from './util';
import * as Lang from './lang';
import { getChannel, getMember, memberIsModThrow } from './util/discord';
import { emsg } from './util/main';
//load queues from file
//load queues from file`
if (!fs.existsSync('./queues.json'))
fs.writeFileSync('./queues.json', '{}');
@@ -51,12 +47,7 @@ async function checkQueue(channel: TextChannel) {
const team = info.players.splice(0, info.teamsize).map(m => m.toString());
//TODO add embeds to lang.ts
const embed = new MessageEmbed()
.setTitle('Team')
.setDescription(team.join('\n'));
await channel.send({embeds: [embed]});
await channel.send(Lang.getEmbed('discord.team', { team: team.join('\n') }));
}
@@ -86,7 +77,7 @@ export async function discordInit(client: Client) {
const info = QUEUE.get(channelId),
channel = await client.channels.fetch(channelId);
if (!info) { //no idea what could cause this but TS complains
if (!info) {
queueRemove(channelId);
continue;
}
@@ -198,13 +189,12 @@ async function queue(interaction: CommandInteraction) {
const info = getInfo(interaction);
const embed = new MessageEmbed()
.setTitle('Active Queue')
.addField('Team Size', info.teamsize.toString(), true)
.addField('Players Joined', info.players.length.toString(), true)
.setFooter({text: 'type /join'}); //TODO
await interaction.reply({embeds: [embed], ephemeral: true});
await interaction.reply(Lang.getEmbed('discord.queue', {
teamsize: info.teamsize.toString(),
playercount: info.players.length.toString(),
}, {
ephemeral: true
}));
}

View File

16
src/types/api.d.ts vendored Normal file
View File

@@ -0,0 +1,16 @@
/**
* data taken from UniteAPI
*/
interface uniteApiData {
name: string,
id: string,
avatar: string,
level: string,
rank: string,
class: string|null,
elo: string|null,
battles: string,
wins: string,
winrate: string
}

104
src/types/lang.d.ts vendored Normal file
View File

@@ -0,0 +1,104 @@
/**
* any indexable object
*/
//this is a generic type, and needs 'any'
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type basicObject = {[keys: string]: any};
/**
* any indexable object with string values
*/
type basicObjectStr = {[keys: string]: string};
/**
* an abstract version of strings
*/
type bigString = string | string[];
/**
* an object that contains embeds and can be passed directly to methods like `Discord.TextChannel.send()`
*/
interface embedData {
content?: string,
embeds: MessageEmbed[]
}
/**
* a representation of an author in the LANG object
*
* `LANG > Language > Embed > Field`
*/
interface embedField {
name: string,
value: bigString,
inline?: boolean
}
/**
* a representation of an author in the LANG object
*
* `LANG > Language > Embed > Author`
*/
interface authorData {
name: string,
url?: string,
icon?: string
}
/**
* a representation of a footer in the LANG object
*
* `LANG > Language > Embed > Footer`
*/
interface footerData {
text: string,
icon?: string
}
/**
* a representation of an embed in the LANG object
*
* `LANG > Language > Embed`
*/
interface embedObj {
embed: true,
content?: string,
title?: string,
description?: bigString,
/**
* URL
*/
url?: string,
/**
* #FFFFFF
*/
color?: string,
footer?: string | footerData,
thumbnail?: string,
/**
* URL
*/
image?: string,
/**
* URL
*/
author?: string | authorData,
fields?: embedField[],
timestamp?: boolean | string | number
}
/**
* a specific language in the LANG object
*
* `LANG > Language`
*/
type LangObj = { [keys:string]: LangObj | embedObj | string }
/**
* the entire LANG object
*
* `LANG`
*/
type LangObjWhole = { [langid:string]: LangObj }

6
src/types/queue.d.ts vendored Normal file
View File

@@ -0,0 +1,6 @@
interface queueInfoBase {
teamsize: number
}
interface queueInfo extends queueInfoBase {
players: GuildMember[]
}

View File

@@ -1,97 +0,0 @@
import { CommandInteraction, GuildMember, TextChannel } from 'discord.js';
import * as Lang from './lang';
/**
* shuffles an array
* https://stackoverflow.com/a/2450976/2856416
* @param array an array
* @returns an array but shuffled
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function shuffle(array: any[]) {
let currentIndex = array.length, randomIndex;
// While there remain elements to shuffle...
while (currentIndex != 0) {
// Pick a remaining element...
randomIndex = Math.floor(Math.random() * currentIndex);
currentIndex--;
// And swap it with the current element.
[array[currentIndex], array[randomIndex]] = [
array[randomIndex], array[currentIndex]];
}
return array;
}
export class errorMessage {
public msg: string;
public ephemeral: boolean;
constructor(msg: string, ephemeral = true) {
this.msg = msg;
this.ephemeral = ephemeral;
}
}
/**
* a simple class to contain an error message and related data
* @param msg error message
* @param ephemeral (default=true)
* @returns new errorMessage
*/
export const emsg = (msg: string, ephemeral = true) => new errorMessage(Lang.get(`error.${msg}`), ephemeral);
export interface queueInfoBase {
teamsize: number
}
export interface queueInfo extends queueInfoBase{
players: GuildMember[]
}
/**
* get the GuildMember of an interaction
* @param interaction
* @throws errorMessage class if it cannot be read
* @returns member
*/
export function getMember(interaction: CommandInteraction): GuildMember {
const member = interaction.member;
if (!(member instanceof GuildMember))
throw emsg('general.noMember');
return member;
}
/**
* get the TextChannel of an interaction
* @param interaction
* @throws errorMessage class if it cannot be read
* @returns member
*/
export function getChannel(interaction: CommandInteraction): TextChannel {
const channel = interaction.channel;
if (!(channel instanceof TextChannel))
throw emsg('general.noChannel');
return channel;
}
export function memberIsMod(interaction: CommandInteraction): boolean {
const member = getMember(interaction);
return member.permissionsIn(interaction.channelId).has('MANAGE_MESSAGES');
}
export function memberIsModThrow(interaction: CommandInteraction) {
if (!memberIsMod(interaction))
throw emsg('discord.notMod');
}

46
src/util/discord.ts Normal file
View File

@@ -0,0 +1,46 @@
import { CommandInteraction, GuildMember, TextChannel } from 'discord.js';
import { emsg } from './main';
/**
* get the GuildMember of an interaction
* @throws errorMessage class if it cannot be read
*/
export function getMember(interaction: CommandInteraction): GuildMember {
const member = interaction.member;
if (!(member instanceof GuildMember))
throw emsg('general.noMember');
return member;
}
/**
* get the TextChannel of an interaction
* @throws errorMessage class if it cannot be read
*/
export function getChannel(interaction: CommandInteraction): TextChannel {
const channel = interaction.channel;
if (!(channel instanceof TextChannel))
throw emsg('general.noChannel');
return channel;
}
/**
* get the TextChannel of an interaction
* @throws errorMessage class if the Member cannot be read
*/
export function memberIsMod(interaction: CommandInteraction): boolean {
const member = getMember(interaction);
return member.permissionsIn(interaction.channelId).has('MANAGE_MESSAGES');
}
/**
* get the TextChannel of an interaction
* @throws errorMessage class if the Member cannot be read or if Member is not a mod
*/
export function memberIsModThrow(interaction: CommandInteraction) {
if (!memberIsMod(interaction))
throw emsg('discord.notMod');
}

162
src/util/lang.ts Normal file
View File

@@ -0,0 +1,162 @@
import { MessageEmbed } from 'discord.js';
/**
*
* @param str
* @param args
* @returns
*/
export function template(str: string, args: basicObject): string {
return str.replace(/{\w+}/g, str => {
const key = str.substring(1, str.length-1);
if (key in args)
return args[key];
return key;
});
}
/**
* converts bigString to string
*/
export function bigString(bigStr: bigString): string {
if (Array.isArray(bigStr))
return bigStr.join('\n');
return bigStr;
}
/**
* converts Hex Color string to an RGB array
*/
export function resolveColor(color: string): [number, number, number] {
color = color.replace(/[^0-9a-f]/gi, '');
const colorNum: [number, number, number] = [0, 0, 0];
if (color.length === 3 || color.length === 6) {
const colorSpl = /([0-9a-f]{1,2})([0-9a-f]{1,2})([0-9a-f]{1,2})/.exec(color);
if (!colorSpl)
return colorNum;
for (let i = 0; i < colorSpl.length && i < colorNum.length; i++)
colorNum[i] = parseInt(colorSpl[i], 16);
}
return colorNum;
}
/**
* converts embedObj to a string if applicable
* @param fallback the string to use if no valid strings can be found
*/
export function embedObjStr(embedObj: embedObj, args: basicObjectStr = {}, fallback = ''): string {
if (embedObj.content !== undefined)
return template(bigString(embedObj.content), args);
if (embedObj.description !== undefined)
return template(bigString(embedObj.description), args);
return fallback;
}
/**
* converts embedObj to Discord.MessageEmbed
*/
export function embedObjEmbed(embedObj: embedObj, args: basicObjectStr = {}): MessageEmbed {
const embed = new MessageEmbed(),
{ author, color, description, fields, footer, image, thumbnail, timestamp, title, url } = embedObj;
if (author !== undefined) {
let authorFix: authorData;
if (typeof author === 'string')
authorFix = {
name: template(author, args)
};
else {
const {name, icon, url} = author;
authorFix = {
name: template(name, args)
};
if (icon !== undefined)
authorFix.icon = template(icon, args);
if (url !== undefined)
authorFix.url = template(url, args);
}
embed.setAuthor(authorFix);
}
if (footer !== undefined) {
let footerFix: footerData;
if (typeof footer === 'string')
footerFix = {
text: template(footer, args)
};
else {
const {text, icon} = footer;
footerFix = {
text: template(text, args)
};
if (icon !== undefined)
footerFix.icon = template(icon, args);
}
embed.setFooter(footerFix);
}
if (color !== undefined)
embed.setColor(resolveColor(template(color, args)));
if (description !== undefined)
embed.setDescription(template(bigString(description), args));
if (image !== undefined)
embed.setImage(template(image, args));
if (thumbnail !== undefined)
embed.setThumbnail(template(thumbnail, args));
if (title !== undefined)
embed.setTitle(template(title, args));
if (url !== undefined)
embed.setURL(template(url, args));
if (timestamp === true)
embed.setTimestamp();
else if (typeof timestamp === 'string')
embed.setTimestamp(new Date(template(timestamp, args)));
else if (timestamp !== false)
embed.setTimestamp(timestamp);
fields?.forEach(field => {
embed.addField(template(field.name, args), template(bigString(field.value), args), field.inline);
});
return embed;
}

49
src/util/main.ts Normal file
View File

@@ -0,0 +1,49 @@
import * as Lang from '../lang';
/**
* shuffles an array
* https://stackoverflow.com/a/2450976/2856416
* @param array an array
* @returns an array but shuffled
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function shuffle(array: any[]) {
let currentIndex = array.length, randomIndex;
// While there remain elements to shuffle...
while (currentIndex != 0) {
// Pick a remaining element...
randomIndex = Math.floor(Math.random() * currentIndex);
currentIndex--;
// And swap it with the current element.
[array[currentIndex], array[randomIndex]] = [
array[randomIndex], array[currentIndex]];
}
return array;
}
/**
* use the emsg() function instead
*/
export class errorMessage {
public msg: string;
public ephemeral: boolean;
constructor(msg: string, ephemeral = true) {
this.msg = msg;
this.ephemeral = ephemeral;
}
}
/**
* a simple class to contain an error message and related data
* @param msg error message
* @param ephemeral (default=true)
* @returns new errorMessage
*/
export const emsg = (msg: string, ephemeral = true) => new errorMessage(Lang.get(`error.${msg}`), ephemeral);

11
tsconfig.eslint.json Normal file
View File

@@ -0,0 +1,11 @@
// Special typescript project file, used by eslint only.
{
"extends": "./tsconfig.json",
"include": [
// repeated from base config's "include" setting
"src",
// these are the eslint-only inclusions
".eslintrc.json",
]
}

View File

@@ -11,5 +11,11 @@
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
}
"typeRoots": [
"./src/types/"
]
},
"include": [
"src"
]
}