5 | Tools for interacting with the Guilded.gg API.
6 |7 |
8 | 
9 | 
10 | 
11 |
32 |
33 | **Recommended that you use node v12+**
34 |
35 | - `npm install @guildedjs/guilded.js`
36 | - `yarn add @guildedjs/guilded.js`
37 |
38 | ## ⚡ Usage
39 |
40 | You can find extra examples [here](https://github.com/zaida04/guilded.js-selfbot/tree/main/examples)
41 |
42 | ```ts
43 | const { Client } = require("@guildedjs/guilded.js");
44 |
45 | /*
46 | * ES6:
47 | * import { Client } from "@guildedjs/guilded.js";
48 | */
49 |
50 | const client = new Client();
51 |
52 | client.on("ready", () => console.log(`Bot is successfully logged in`));
53 |
54 | client.on("messageCreate", (message) => {
55 | if (message.content === "poggers") {
56 | return message.channel.send("poggers indeed");
57 | }
58 | });
59 |
60 | client.login({
61 | email: "email",
62 | password: "password",
63 | });
64 | ```
65 |
66 | ## 📃 Documentation
67 |
68 | Documentation is viewable here: https://zaida04.github.io/guildedjs-selfbot-docs
69 |
70 |
71 |
72 | ## ✋ Contributing
73 |
74 | Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
75 |
76 | **Please run `npm run bootstrap` after running npm install in your local environment.**
77 | **Please ensure your commits pass the test, lint, and build scripts.**
78 |
79 | **We make use of [lerna](https://lerna.js.org/) to manage our monorepo. The main commands used are below**
80 |
81 | - `lerna add
40 |
41 | **Recommended that you use node v12+**
42 |
43 | - `npm install @guildedjs/guilded.js`
44 | - `yarn add @guildedjs/guilded.js`
45 |
46 | ## 📃 Documentation
47 |
48 | Documentation is located [here](https://zaida04.github.io/guildedjs-selfbot-docs)
49 |
50 | ## 📦 Dependencies
51 |
52 | - [`@guildedjs/guilded-api-typings`](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/guilded-api-typings) (dev dep): used for typing the REST and WS payloads
53 | - [`@guildedjs/common`](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/common): Utilities between `@guildedjs` packages
54 | - [`@guildedjs/rest`](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/rest): Rest structure for `@guildedjs` packages
55 | - [`@guildedjs/embeds`](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/embeds): Embed builder/utility
56 | - [`@guildedjs/webhook-client`](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/webhook-client): Webhook Client
57 | - `@discordjs/collection`: Map utility
58 | - `ws`: WebSocket interaction
59 |
60 | ## ✋ Contributing
61 |
62 | Please see the main [README.md](https://github.com/zaida04/guilded.js-selfbot) for info on how to contribute to this package or the other `@guildedjs` packages.
63 |
64 | ## 🤝 Acknowledgements
65 |
66 | - [`Discord.js`](https://discord.js.org/#/) - Inspiration and caching strategy
67 |
68 | ## ⚖️ LICENSING
69 |
70 | Licensed under the [MIT License](https://github.com/zaida04/guilded.js-selfbot/blob/main/LICENSE)
71 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/colors.js:
--------------------------------------------------------------------------------
1 | exports.COLORS = {
2 | CYAN: '\u001B[36m',
3 | GREEN: '\u001B[32m',
4 | RED: '\u001B[31m',
5 | RESET: '\u001B[0m',
6 | UNDERSCORE: '\u001B[4m',
7 | WHITE: '\u001B[37m',
8 | YELLOW: '\u001B[33m',
9 | };
10 |
11 | exports.testText = str => console.log(`\n${exports.COLORS.YELLOW} ---${str}--- ${exports.COLORS.RESET}`);
12 | exports.successText = str => console.log(`${exports.COLORS.GREEN} ${str} ${exports.COLORS.RESET}`);
13 | exports.errorText = str => console.log(`\n${exports.COLORS.RED} ${str} ${exports.COLORS.RESET}\n`);
14 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/index.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable @typescript-eslint/no-var-requires */
2 | const { config } = require('dotenv');
3 | const { join } = require('path');
4 | const { COLORS, testText, errorText, successText } = require('./colors.js');
5 | const Guilded = require('..');
6 |
7 | config({
8 | path: join(__dirname, '..', '..', '..', '.env'),
9 | });
10 |
11 | if (!process.env.EMAIL) throw new Error('Must supply email for testing');
12 | if (!process.env.PASSWORD) throw new Error('Must supply password for testing');
13 | if (!process.env.TEAM_ID) throw new Error('Must provide a testing team ID');
14 | if (!process.env.ROLE_ID) throw new Error('Must provide a testing role ID');
15 | if (!process.env.GUINEAPIG_ID) throw new Error('Must provide a testing user ID');
16 | if (!process.env.GROUP_ID) throw new Error('Must provide a testing group ID');
17 | if (!process.env.CHANNEL_ID) throw new Error('Must provide a testing channel ID');
18 |
19 | const client = new Guilded.Client({
20 | ws: {
21 | heartbeatInterval: 15000,
22 | },
23 | });
24 | const prefix = 'gg!';
25 |
26 | // client.on('raw', console.log);
27 | // client.on('debug', console.log);
28 |
29 | client.on(Guilded.events.MESSAGE_REACTION_ADD, a => console.log(`REACTION ADDED: ${a.id}`));
30 | client.on(Guilded.events.MESSAGE_REACTION_DELETE, a => console.log(`REACTION REMOVED: ${a.id}`));
31 |
32 | /**
33 | * Testing login
34 | */
35 | client.once(Guilded.events.READY, async () => {
36 | let passed = 0;
37 | let failed = 0;
38 |
39 | console.log(
40 | `Successfully logged in as ${client.user.id}. Currently in ${client.teams.cache.size} Teams and serving ${client.users.cache.size} users with ${client.channels.cache.size} channels.`,
41 | );
42 |
43 | testText('Role adding/Removal');
44 | await require('./modules/role')(client, passed, failed, successText, errorText)
45 | .then(() => passed++)
46 | .catch(() => failed++);
47 |
48 | testText('Client Disconnection/Reconnection');
49 | try {
50 | require('./modules/connection')(client, passed, failed, successText, errorText);
51 | passed++;
52 | } catch {
53 | failed++;
54 | }
55 |
56 | testText('Message Sending/Editing/Deletion/Fetching');
57 | await require('./modules/message')(client, passed, failed, successText, errorText)
58 | .then(() => passed++)
59 | .catch(() => failed++);
60 |
61 | testText('Active WS connection');
62 | try {
63 | require('./modules/ws')(client, passed, failed, successText, errorText);
64 | passed++;
65 | } catch {
66 | failed++;
67 | }
68 |
69 | testText('Invite Creation/Deletion');
70 | await require('./modules/invite')(client, passed, failed, successText, errorText)
71 | .then(() => passed++)
72 | .catch(() => failed++);
73 |
74 | testText('Embed sending');
75 | await require('./modules/embed')(client, passed, failed, successText, errorText)
76 | .then(() => passed++)
77 | .catch(() => failed++);
78 |
79 | console.log(`\n\n${COLORS.GREEN} ${passed} tests passed.${COLORS.RED} ${failed} tests failed. ${COLORS.RESET}`);
80 | });
81 |
82 | client.on(Guilded.events.MESSAGE_CREATE, message => {
83 | if (message.teamID !== process.env.TEAM_ID) return;
84 | if (!message.content.startsWith(prefix)) return;
85 | const args = message.content.split(/ /g);
86 | const command = args.shift().slice(prefix.length);
87 |
88 | switch (command) {
89 | case 'eval': {
90 | if (message.authorID !== client.user.id) return message.channel.send('**NICE TRY**');
91 | const code = args.join(' ');
92 | const evaled = eval(`(async () => {${code}})()`);
93 | message.channel.send(`
94 | 📥 **Input**
95 | \`\`\`${code}\`\`\`
96 | 📤 **Output**
97 | \`\`\`${evaled}\`\`\`
98 | `);
99 | break;
100 | }
101 | case 'ping': {
102 | return message.channel.send('HI!');
103 | }
104 | }
105 | });
106 |
107 | client.login({
108 | email: process.env.EMAIL,
109 | password: process.env.PASSWORD,
110 | });
111 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/modules/connection.js:
--------------------------------------------------------------------------------
1 | module.exports = (client, passed, failed, testText, errorText) => {
2 | try {
3 | client.destroy(true);
4 | testText('Successfully disconnected!');
5 | } catch (e) {
6 | errorText(`Client disconnected failed! ${e}`);
7 | throw e;
8 | }
9 | };
10 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/modules/embed.js:
--------------------------------------------------------------------------------
1 | // eslint-disable-next-line @typescript-eslint/no-var-requires
2 | const { Embed } = require('@guildedjs/embeds');
3 | const iconURL = 'https://cdn.discordapp.com/avatars/500765481788112916/0c12c135aeeae527f46e9f737e6ca937.png';
4 |
5 | module.exports = async (client, passed, failed, testText, errorText) => {
6 | try {
7 | console.log('...sending embed');
8 | message = await client.channels.sendMessage(
9 | process.env.CHANNEL_ID,
10 | new Embed()
11 | .setTitle('TESTING EMBED!')
12 | .setAuthor('Joe Mama', iconURL, 'https://google.com')
13 | .setDescription('This is a test description')
14 | .setFooter('This is a footer', iconURL)
15 | .setTimestamp(new Date().getTime())
16 | .setURL('https://google.com')
17 | .setImage(iconURL),
18 | );
19 | testText(`Successfully sent embed message with ID: ${message}!`);
20 | } catch (e) {
21 | errorText(`Message sending failed! ${e}`);
22 | throw e;
23 | }
24 | };
25 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/modules/invite.js:
--------------------------------------------------------------------------------
1 | module.exports = async (client, passed, failed, testText, errorText) => {
2 | let invite;
3 | try {
4 | console.log('...creating Invite');
5 | invite = await client.teams.createInvite(process.env.TEAM_ID);
6 | testText(`Successfully created invite! id: ${invite.id}`);
7 | } catch (e) {
8 | errorText(`Creating invite failed! ${e}`);
9 | console.log(e);
10 | throw e;
11 | }
12 |
13 | try {
14 | console.log('...deleting Invite');
15 | const responseID = await client.teams.deleteInvite(process.env.TEAM_ID, invite.id);
16 | testText(`Successfully deleted invite! response-id ${responseID}`);
17 | } catch (e) {
18 | errorText(`Deleting invite failed! ${e}`);
19 | console.log(e);
20 | throw e;
21 | }
22 | };
23 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/modules/message.js:
--------------------------------------------------------------------------------
1 | module.exports = async (client, passed, failed, testText, errorText) => {
2 | let message;
3 | const content = 'TESTING MESSAGE';
4 |
5 | try {
6 | console.log('...sending message');
7 | message = await client.channels.sendMessage(process.env.CHANNEL_ID, content);
8 | testText(`Successfully sent message with ID: ${message}!`);
9 | } catch (e) {
10 | errorText(`Message sending failed! ${e}`);
11 | throw e;
12 | }
13 |
14 | try {
15 | console.log('...editing message');
16 | const newMessage = await client.channels.editMessage(
17 | process.env.CHANNEL_ID,
18 | message,
19 | 'THIS IS AN EDITED TEST MESSAGE',
20 | );
21 | if (content === newMessage.content) throw new Error('Content is unchanged!');
22 | testText(`Successfully edited message ${message} with new content ${newMessage.content}`);
23 | } catch (e) {
24 | errorText(`Message editing failed! ${e}`);
25 | throw e;
26 | }
27 |
28 | try {
29 | console.log('...deleting message');
30 | await client.channels.deleteMessage(process.env.CHANNEL_ID, message);
31 | testText('Successfully deleted message!');
32 | } catch (e) {
33 | errorText(`Message deletion failed! ${e}`);
34 | throw e;
35 | }
36 |
37 | try {
38 | console.log('...fetching 5 messages');
39 | const messages = await client.channels.cache.random().messages.fetch(5);
40 | testText(`Successfully fetched messages!`);
41 | } catch (e) {
42 | errorText(`Message fetching failed! ${e}`);
43 | throw e;
44 | }
45 | };
46 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/modules/role.js:
--------------------------------------------------------------------------------
1 | module.exports = async (client, passed, failed, testText, errorText) => {
2 | try {
3 | console.log('...adding role');
4 | await client.teams.addRoleToMember(process.env.TEAM_ID, process.env.GUINEAPIG_ID, process.env.ROLE_ID);
5 | testText('Role successfully added.');
6 | } catch (e) {
7 | errorText(`Role adding failed! ${e}`);
8 | throw e;
9 | }
10 |
11 | try {
12 | console.log('...removing role');
13 | await client.teams.removeRoleFromMember(process.env.TEAM_ID, process.env.GUINEAPIG_ID, process.env.ROLE_ID);
14 | testText('Role successfully removed.');
15 | } catch (e) {
16 | errorText(`Role removal failed! ${e}`);
17 | throw e;
18 | }
19 | };
20 |
--------------------------------------------------------------------------------
/packages/guilded.js/__tests__/modules/ws.js:
--------------------------------------------------------------------------------
1 | // eslint-disable-next-line @typescript-eslint/no-var-requires
2 | const webSocket = require('ws');
3 |
4 | module.exports = (client, passed, failed, testText, errorText) => {
5 | try {
6 | console.log('...testing connection');
7 | if (client.gateway.ws.readyState !== webSocket.OPEN) throw new Error('WS NOT OPEN!');
8 | client.gateway.ws.send('2');
9 | testText('WS message sent!');
10 | } catch (e) {
11 | errorText(`WS connection failed! ${e}`);
12 | throw e;
13 | }
14 | };
15 |
--------------------------------------------------------------------------------
/packages/guilded.js/lib/index.ts:
--------------------------------------------------------------------------------
1 | export { Client } from './structures/Client';
2 | export * from './structures';
3 | export * from './typings';
4 | export * from '@guildedjs/common';
5 | export * from '@guildedjs/rest';
6 |
--------------------------------------------------------------------------------
/packages/guilded.js/lib/structures/Base.ts:
--------------------------------------------------------------------------------
1 | import type { BaseData } from '../typings';
2 | import type { Client } from './Client';
3 |
4 | /**
5 | * The base of all structures
6 | *
7 | * @param T The minimum amount of data required to construct this structure
8 | */
9 | export abstract class Base