feat: editMessage, refactor message handling and related methods

zaida04 · zaida04 · commit 246a074a2df1 · 2021-07-19T16:13:56.000-04:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -19,12 +19,11 @@ module.exports = {
     plugins: ['simple-import-sort', 'sort-keys-fix'],
     root: true,
     rules: {
-        '@typescript-eslint/no-var-requires': "off",
         '@typescript-eslint/explicit-member-accessibility': 'warn',
         '@typescript-eslint/naming-convention': [
             'warn',
             {
-                format: ['camelCase', 'UPPER_CASE'],
+                format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
                 leadingUnderscore: 'allow',
                 selector: 'default',
                 trailingUnderscore: 'allow',
@@ -51,6 +50,7 @@ module.exports = {
         '@typescript-eslint/no-empty-function': 'off',
         '@typescript-eslint/no-empty-interface': 'warn',
         '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
         'accessor-pairs': 'warn',
         'array-bracket-spacing': 'warn',
         'array-callback-return': 'warn',
diff --git a/.husky/build b/.husky/build
@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run build && npm run lint
+npm run build
diff --git a/.husky/lint-staged b/.husky/lint-staged
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged
diff --git a/package.json b/package.json
@@ -3,6 +3,8 @@
   "version": "0.0.0",
   "description": "Main overarching package utilizing lerna to manage all the @guildedjs packages",
   "private": true,
+  "author": "Zaid \"Nico\"",
+  "license": "MIT",
   "scripts": {
     "build": "npx lerna run build",
     "bootstrap": "npx lerna bootstrap",
@@ -15,12 +17,6 @@
     "changelog": "npx conventional-changelog -p angular -i CHANGELOG.md -s",
     "reset": "cd scripts && node refresh.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zaida04/guilded.js.git"
-  },
-  "author": "Zaid \"Nico\"",
-  "license": "MIT",
   "devDependencies": {
     "@babel/core": "^7.12.17",
     "@babel/generator": "^7.13.0",
@@ -52,6 +48,10 @@
     "typedoc-plugin-remove-references": "0.0.5",
     "typescript": "^4.0.5"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zaida04/guilded.js.git"
+  },
   "bugs": {
     "url": "https://github.com/zaida04/guilded.js/issues"
   },
diff --git a/packages/common/lib/MessageUtil.ts b/packages/common/lib/MessageUtil.ts
@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 /* eslint-disable max-depth */
 import Embed from '@guildedjs/embeds';
-import { APIContent } from '@guildedjs/guilded-api-typings';
+import type { APIContent } from '@guildedjs/guilded-api-typings';
 
 import { CONSTANTS } from './Consts';
 import { generateUUID } from './UUID';
@@ -10,7 +10,10 @@ import { generateUUID } from './UUID';
  * Convert a string or other content to a message suitable to be sent to guilded
  * @internal
  */
-export function convertToMessageFormat(i: string | Embed, e?: Embed): [string, Record<string, any>] {
+export function convertToMessageFormat(
+    i: string | Embed,
+    e?: Embed,
+): [string, { messageId: string; content: APIContent }] {
     let STR_INPUT = '';
     let embed;
 
@@ -19,12 +22,14 @@ export function convertToMessageFormat(i: string | Embed, e?: Embed): [string, R
     if (e) embed = e;
 
     const messageID = generateUUID();
-    const message: { content?: Record<string, any>; messageId: string } = { messageId: messageID };
-    message.content = parseToMessage(STR_INPUT, embed);
+    const message = {
+        content: parseToMessage(STR_INPUT, embed),
+        messageId: messageID,
+    };
     return [messageID, message];
 }
 
-function parseToMessage(input: string | Embed, embed?: Embed) {
+export function parseToMessage(input: string | Embed, embed?: Embed): APIContent {
     return {
         document: {
             data: {},
@@ -242,7 +247,7 @@ export interface MessageDataNode {
  */
 export interface parsedTextResponse {
     type: string;
-    content: any;
+    content: string;
     mention?: unknown;
     reaction?: unknown;
     channel?: unknown;
diff --git a/packages/guilded-api-typings/lib/common/structures/Team.ts b/packages/guilded-api-typings/lib/common/structures/Team.ts
@@ -13,21 +13,21 @@ export interface APITeam {
     bannerImages: unknown;
     baseGroup: APIGroup;
     bio: string | null;
-    bots: any[];
+    bots: unknown[];
     canInviteMembers?: boolean;
     canManageTournaments?: boolean;
     canUpdateTeam?: boolean;
     characteristics: string | null;
     createdAt: string;
     customizationInfo: unknown;
-    deafenedMembers?: any[];
+    deafenedMembers?: unknown[];
     description: string;
     discordGuildId: string | null;
     discordServerName: string | null;
-    flair: any[];
+    flair: unknown[];
     followerCount: number;
     followingGroups: string[] | null;
-    games: any[];
+    games: unknown[];
     homeBannerImageLg: string | null;
     homeBannerImageMd: string | null;
     homeBannerImageSm: string | null;
@@ -45,7 +45,7 @@ export interface APITeam {
     lfmStatusByGameId: unknown;
     measurements: APIMeasurements;
     members: APIMember[];
-    mutedMembers: any[];
+    mutedMembers: string[];
     memberCount?: string;
     membershipRole: string;
     name: string;
@@ -75,7 +75,7 @@ export interface APIPartialTeam {
     id: string;
     name: string;
     subdomain: string;
-    activity: any[];
+    activity: unknown[];
     games: string[] | null[];
     profilePicture: string;
     teamDashImage: string;
@@ -141,7 +141,7 @@ export interface APIMeasurements {
     numFollowers: number;
     numRecentMatches: number;
     numRecentMatchWins: number;
-    matchmakingGameRanks: any[];
+    matchmakingGameRanks: unknown[];
     numFollowersAndMembers: number;
     numMembersAddedInLastDay: number;
     numMembersAddedInLastWeek: number;
diff --git a/packages/guilded-api-typings/lib/common/structures/User.ts b/packages/guilded-api-typings/lib/common/structures/User.ts
@@ -84,13 +84,19 @@ export interface APIUser {
 
 export interface APIClientUser extends APIUser {
     useMinimalNav: boolean;
-    blockedUsers: any[];
-    socialLinks: any[];
+    blockedUsers: unknown[];
+    socialLinks: APIUserSocialLinks[];
     userPresenceStatus: number;
-    badges: any[];
+    badges: string[];
     canRedeemGold: boolean;
     isUnrecoverable: boolean;
     devices: APIDevice[];
-    userChannelNotificationSettings: any[];
+    userChannelNotificationSettings: unknown[];
     upsell: null;
 }
+
+export interface APIUserSocialLinks {
+    type: string;
+    handle: string;
+    additionalInfo: unknown;
+}
diff --git a/packages/guilded-api-typings/lib/rest/Channel.ts b/packages/guilded-api-typings/lib/rest/Channel.ts
@@ -183,6 +183,6 @@ export interface APIPostChannelAnnouncementsBody {
 export interface APIGetTeamChannels {
     channels: APITeamChannel[];
     badgedChannelContentByChannelId: unknown;
-    temporalChannels: any[];
+    temporalChannels: unknown[];
     categories: APITeamChannel[];
 }
diff --git a/packages/guilded-api-typings/lib/rest/User.ts b/packages/guilded-api-typings/lib/rest/User.ts
@@ -67,5 +67,5 @@ export interface APIPostLoginResponse {
 export interface APIGetUserDMChannels {
     channels: APIDMChannel[];
     unreadInfoByChannelId: unknown;
-    users: any[];
+    users: APIUser[];
 }
diff --git a/packages/guilded.js/__tests__/modules/message.js b/packages/guilded.js/__tests__/modules/message.js
@@ -1,14 +1,30 @@
 module.exports = async (client, passed, failed, testText, errorText) => {
     let message;
+    const content = 'TESTING MESSAGE';
+
     try {
         console.log('...sending message');
-        message = await client.channels.sendMessage(process.env.CHANNEL_ID, 'TESTING MESSAGE');
+        message = await client.channels.sendMessage(process.env.CHANNEL_ID, content);
         testText(`Successfully sent message with ID: ${message}!`);
     } catch (e) {
         errorText(`Message sending failed! ${e}`);
         throw e;
     }
 
+    try {
+        console.log('...editing message');
+        const newMessage = await client.channels.editMessage(
+            process.env.CHANNEL_ID,
+            message,
+            'THIS IS AN EDITED TEST MESSAGE',
+        );
+        if (content === newMessage.content) throw new Error('Content is unchanged!');
+        testText(`Successfully edited message ${message} with new content ${newMessage.content}`);
+    } catch (e) {
+        errorText(`Message editing failed! ${e}`);
+        throw e;
+    }
+
     try {
         console.log('...deleting message');
         await client.channels.deleteMessage(process.env.CHANNEL_ID, message);
diff --git a/packages/guilded.js/lib/structures/Channel.ts b/packages/guilded.js/lib/structures/Channel.ts
@@ -92,6 +92,7 @@ export class PartialChannel extends Base<BaseData> {
      * Update the data in this structure.
      * @internal
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     public patch(data: Partial<APITeamChannel | APIDMChannel>): this {
         return this;
     }
diff --git a/packages/guilded.js/lib/structures/Client.ts b/packages/guilded.js/lib/structures/Client.ts
@@ -213,6 +213,7 @@ export class ClientUser extends User {
      * Update the data in this structure
      * @internal
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     public patch(data: APIClientUser): this {
         return this;
     }
diff --git a/packages/guilded.js/lib/structures/Message.ts b/packages/guilded.js/lib/structures/Message.ts
@@ -123,27 +123,19 @@ export class Message extends Base<APIMessage> {
     }
 
     /**
-     * Add a reaction to this message (UNFINISHED)
+     * Add a reaction to this message
      * @hidden
      */
     public react(emoji: string): unknown {
-        return this.client.rest
-            .post(`/channels/${this.channel?.id ?? this.channelID}/messages/${this.id}/reactions/${emoji}`, {})
-            .then(x => {
-                // Add reaction to message object
-            });
+        return this.channel!.messages!.react(this, this.channelID, emoji);
     }
 
     /**
-     * Remove a reaction from this message (UNFINISHED)
+     * Remove a reaction from this message
      * @hidden
      */
     public unreact(emoji: string): unknown {
-        return this.client.rest
-            .delete(`/channels/${this.channel?.id ?? this.channelID}/messages/${this.id}/reactions/${emoji}`, {})
-            .then(x => {
-                // Add reaction to message object
-            });
+        return this.channel!.messages!.unreact(this, this.channelID, emoji);
     }
 
     /**
@@ -154,11 +146,11 @@ export class Message extends Base<APIMessage> {
     }
 
     /**
-     * Edit the content of this message (UNFINISHED)
+     * Edit the content of this message
      * @hidden
      */
-    private edit(content: string) {
-        throw new Error('Method not implemented and not meant to be used.');
+    public edit(content: string): Promise<Message> {
+        return this.channel!.messages!.edit(this, content);
     }
 }
 
diff --git a/packages/guilded.js/lib/structures/Team.ts b/packages/guilded.js/lib/structures/Team.ts
@@ -145,7 +145,7 @@ export class Team extends Base<APITeam | APIPartialTeam> {
     /**
      * The games that this team plays
      */
-    public games: any[];
+    public games: unknown[];
 
     /**
      * The various banner styles belonging to this server
@@ -249,7 +249,7 @@ export class Team extends Base<APITeam | APIPartialTeam> {
     }
 
     /**
-     * Creates a Teamchannel and fires a CreateChannelEvent on success. (UNFINISHED)
+     * Creates a Teamchannel and fires a CreateChannelEvent on success.
      * @hidden
      * @param name The name of the channel.
      * @param contentType The type of the channel.
diff --git a/packages/guilded.js/lib/structures/managers/BaseManager.ts b/packages/guilded.js/lib/structures/managers/BaseManager.ts
@@ -39,7 +39,7 @@ export class BaseManager<K extends BaseData, T extends Base<K>> {
     }
 
     private isConstructorParamsOfHolds(
-        data: ConstructorParameters<constructable<T>> | any,
+        data: ConstructorParameters<constructable<T>> | unknown,
     ): data is ConstructorParameters<constructable<T>> {
         return Array.isArray(data);
     }
diff --git a/packages/guilded.js/lib/structures/managers/ChannelManager.ts b/packages/guilded.js/lib/structures/managers/ChannelManager.ts
@@ -1,7 +1,8 @@
-import { convertToMessageFormat } from '@guildedjs/common';
+import { convertToMessageFormat, parseToMessage } from '@guildedjs/common';
 import Embed from '@guildedjs/embeds';
 import type {
     APIGetChannelMessageResult,
+    APIMessage,
     APIPostChannelMessagesResult,
     APITeamChannel,
 } from '@guildedjs/guilded-api-typings';
@@ -80,7 +81,6 @@ export class ChannelManager extends BaseManager<APITeamChannel, TeamChannel | DM
      */
     public deleteMessage(channel: string | PartialChannel, msg: string | Message): Promise<Message | string> {
         if (!msg) throw new TypeError('Expected a string or message object for message deletion.');
-
         const channelID = ChannelManager.resolve(channel);
         const messageID = MessageManager.resolve(msg);
         return this.client.rest.delete(`/channels/${channelID}/messages/${messageID}`).then(() => {
@@ -93,18 +93,20 @@ export class ChannelManager extends BaseManager<APITeamChannel, TeamChannel | DM
     }
 
     /**
-     * Edit a message (UNFINISHED)
+     * Edit a message
      * @hidden
      */
-    private editMessage(channel: string, msg: string | Message, newContent: string) {
-        throw new Error('Method not implemented and not intended for use yet.');
-        /*
-        Const messageID = MessageManager.resolve(msg);
-        return this.client.rest.put(`/channels/${channel}/messages/${messageID}`).then(x => {
-            const existing = this.cache.get(messageID);
-            if (existing) existing.patch(x);
-            return existing ?? null;
-        });
-        */
+    public editMessage(channel: string | PartialChannel, msg: string | Message, newContent: string): Promise<Message> {
+        const channelID = ChannelManager.resolve(channel);
+        const messageID = MessageManager.resolve(msg);
+        return this.client.rest
+            .put<APIMessage>(`/channels/${channelID}/messages/${messageID}`, { content: parseToMessage(newContent) })
+            .then(x => {
+                const existingChannel = this.client.channels.cache.get(x.channelId);
+                if (!existingChannel) return new Message(this.client, x, null);
+                const existingMessage = existingChannel.messages!.cache.get(x.id);
+                if (existingMessage) return existingMessage.patch(x);
+                return existingChannel.messages!.add(x)!;
+            });
     }
 }
diff --git a/packages/guilded.js/lib/structures/managers/MessageManager.ts b/packages/guilded.js/lib/structures/managers/MessageManager.ts
diff --git a/packages/guilded.js/lib/structures/managers/TeamManager.ts b/packages/guilded.js/lib/structures/managers/TeamManager.ts
diff --git a/prettier.config.js b/prettier.config.js

Original file line number	Diff line number	Diff line change
`@@ -183,6 +183,6 @@ export interface APIPostChannelAnnouncementsBody {`
`183`	`183`	`export interface APIGetTeamChannels {`
`184`	`184`	`channels: APITeamChannel[];`
`185`	`185`	`badgedChannelContentByChannelId: unknown;`
`186`		`- temporalChannels: any[];`
	`186`	`+ temporalChannels: unknown[];`
`187`	`187`	`categories: APITeamChannel[];`
`188`	`188`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,5 +67,5 @@ export interface APIPostLoginResponse {`
`67`	`67`	`export interface APIGetUserDMChannels {`
`68`	`68`	`channels: APIDMChannel[];`
`69`	`69`	`unreadInfoByChannelId: unknown;`
`70`		`- users: any[];`
	`70`	`+ users: APIUser[];`
`71`	`71`	`}`