[Fix] Epic moved the Chat system from xmpp to eos connect and its own api

index.ts

@@ -24,6 +24,7 @@ export { default as InviterFriendshipsLimitExceededError } from './src/exception
 export { default as MatchNotFoundError } from './src/exceptions/MatchNotFoundError';
 export { default as OfferNotFoundError } from './src/exceptions/OfferNotFoundError';
 export { default as PartyAlreadyJoinedError } from './src/exceptions/PartyAlreadyJoinedError';
+export { default as PartyChatConversationNotFound } from './src/exceptions/PartyChatConversationNotFound';
 export { default as PartyInvitationExpiredError } from './src/exceptions/PartyInvitationExpiredError';
 export { default as PartyMaxSizeReachedError } from './src/exceptions/PartyMaxSizeReachedError';
 export { default as PartyMemberNotFoundError } from './src/exceptions/PartyMemberNotFoundError';

resources/structs.ts

@@ -1478,7 +1478,7 @@ export interface AuthSessionStore<K, V> extends Collection<K, V> {
  */
 export interface ChatMessagePayload {
   /**
-   * The message body, should not be empty and not exceeed the limit of 256 characters
+   * The message body, should not be empty and not exceed the limit of 256 characters. Please note that emojis count as 2 characters.
    */
   body: string;
 }
@@ -1563,4 +1563,3 @@ export type EOSConnectMessage =
   | EOSConnectChatNewMsgMessage
   | EOSConnectChatMemberLeftMessage
   | EOSConnectChatNewWhisperMessage;
-

src/Client.ts

@@ -48,7 +48,7 @@ import type {
 } from '../resources/structs';
 
 /**
- * Represets the main client
+ * Represents the main client
  */
 class Client extends EventEmitter {
   /**
@@ -771,7 +771,6 @@ class Client extends EventEmitter {
     }, newPrivacy.deleted);
 
     this.partyLock.unlock();
-    await this.party.chat.join();
     return undefined;
   }
 

src/exceptions/CreativeIslandNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a creative island does not exist
+ * Represents an error thrown because a creative island does not exist
  */
 class CreativeIslandNotFoundError extends Error {
   /**

src/exceptions/CreatorCodeNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a creator code does not exist
+ * Represents an error thrown because a creator code does not exist
  */
 class CreatorCodeNotFoundError extends Error {
   /**

src/exceptions/DuplicateFriendshipError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a friendship already exists
+ * Represents an error thrown because a friendship already exists
  */
 class DuplicateFriendshipError extends Error {
   /**

src/exceptions/EpicgamesAPIError.ts

@@ -2,7 +2,7 @@ import type { AxiosRequestConfig } from 'axios';
 import type { EpicgamesAPIErrorData } from '../../resources/httpResponses';
 
 /**
- * Represets an HTTP error from the Epicgames API
+ * Represents an HTTP error from the Epicgames API
  */
 class EpicgamesAPIError extends Error {
   /**

src/exceptions/EventTimeoutError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because an event timeout was exceeded
+ * Represents an error thrown because an event timeout was exceeded
  */
 class EventTimeoutError extends Error {
   /**

src/exceptions/FriendNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a friend does not exist
+ * Represents an error thrown because a friend does not exist
  */
 class FriendNotFoundError extends Error {
   /**

src/exceptions/FriendshipRequestAlreadySentError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a friendship request has already been sent
+ * Represents an error thrown because a friendship request has already been sent
  */
 class FriendshipRequestAlreadySentError extends Error {
   /**

src/exceptions/InviteeFriendshipRequestLimitExceededError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because the friendship invitee reached their friendship requests limit
+ * Represents an error thrown because the friendship invitee reached their friendship requests limit
  */
 class InviteeFriendshipRequestLimitExceededError extends Error {
   /**

src/exceptions/InviteeFriendshipSettingsError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because the friendship invitee does disabled friendship requests
+ * Represents an error thrown because the friendship invitee does disabled friendship requests
  */
 class InviteeFriendshipSettingsError extends Error {
   /**

src/exceptions/InviteeFriendshipsLimitExceededError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because the friendship invitee reached their friendships limit
+ * Represents an error thrown because the friendship invitee reached their friendships limit
  */
 class InviteeFriendshipsLimitExceededError extends Error {
   /**

src/exceptions/InviterFriendshipsLimitExceededError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because the client reached its friendships limit
+ * Represents an error thrown because the client reached its friendships limit
  */
 class InviterFriendshipsLimitExceededError extends Error {
   /**

src/exceptions/MatchNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a match does not exist
+ * Represents an error thrown because a match does not exist
  */
 class MatchNotFoundError extends Error {
   /**

src/exceptions/OfferNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because an offer does not exist (anymore)
+ * Represents an error thrown because an offer does not exist (anymore)
  */
 class OfferNotFoundError extends Error {
   /**

src/exceptions/PartyAlreadyJoinedError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a member (or the client) already joined a party
+ * Represents an error thrown because a member (or the client) already joined a party
  */
 class PartyAlreadyJoinedError extends Error {
   constructor() {

src/exceptions/PartyChatConversationNotFound.ts

@@ -0,0 +1,12 @@
+/**
+ * Represents an error thrown because you tried to send a party chat message, but there is no chat yet, because you are the only person in the party
+ */
+class PartyChatConversationNotFound extends Error {
+  constructor() {
+    super();
+    this.name = 'PartyChatConversationNotFound';
+    this.message = 'There is no party chat conversation yet. You cannot send party chat messages when you are the only party member.';
+  }
+}
+
+export default PartyChatConversationNotFound;

src/exceptions/PartyInvitationExpiredError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because the client does not have permission to perform a certain action
+ * Represents an error thrown because the client does not have permission to perform a certain action
  */
 class PartyInvitationExpiredError extends Error {
   constructor() {

src/exceptions/PartyMaxSizeReachedError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a party already reached its max member count
+ * Represents an error thrown because a party already reached its max member count
  */
 class PartyMaxSizeReachedError extends Error {
   constructor() {

src/exceptions/PartyMemberNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a party member does not exist
+ * Represents an error thrown because a party member does not exist
  */
 class PartyMemberNotFoundError extends Error {
   /**

src/exceptions/PartyNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a party does not exist
+ * Represents an error thrown because a party does not exist
  */
 class PartyNotFoundError extends Error {
   constructor() {

src/exceptions/PartyPermissionError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because the client does not have permission to perform a certain party related action
+ * Represents an error thrown because the client does not have permission to perform a certain party related action
  */
 class PartyPermissionError extends Error {
   constructor() {

src/exceptions/SendMessageError.ts

@@ -3,7 +3,7 @@ import type ClientParty from '../structures/party/ClientParty';
 import type Friend from '../structures/friend/Friend';
 
 /**
- * Represets an error thrown because a user does not exist
+ * Represents an error thrown because a user does not exist
  */
 class SendMessageError extends Error {
   /**

src/exceptions/StatsPrivacyError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a user set their stats to private
+ * Represents an error thrown because a user set their stats to private
  */
 class StatsPrivacyError extends Error {
   /**

src/exceptions/UserNotFoundError.ts

@@ -1,5 +1,5 @@
 /**
- * Represets an error thrown because a user does not exist
+ * Represents an error thrown because a user does not exist
  */
 class UserNotFoundError extends Error {
   /**

src/managers/ChatManager.ts

@@ -3,6 +3,7 @@
 import { AuthSessionStoreKey } from '../../resources/enums';
 import Base from '../Base';
 import UserNotFoundError from '../exceptions/UserNotFoundError';
+import EpicgamesAPIError from '../exceptions/EpicgamesAPIError';
 import type { ChatMessagePayload } from '../../resources/structs';
 
 // private scope
@@ -24,6 +25,8 @@
    * @param user the account id or displayname
    * @param message the message object
    * @returns the message id
+   * @throws {UserNotFoundError} When the specified user was not found
+   * @throws {EpicgamesAPIError} When the api request failed
    */
   public async whisperUser(user: string, message: ChatMessagePayload) {
     const accountId = await this.client.user.resolveId(user);
@@ -55,6 +58,7 @@
    * @param message the message object
    * @param allowedRecipients the account ids, that should receive the message
    * @returns the message id
+   * @throws {EpicgamesAPIError} When the api request failed
    */
   public async sendMessageInConversation(conversationId: string, message: ChatMessagePayload, allowedRecipients: string[]) {
     const correlationId = generateCustomCorrelationId();

src/stomp/EOSConnect.ts

@@ -51,6 +51,9 @@ class EOSConnect extends Base {
 
   /**
    * connect to the eos connect stomp server
+   * @throws {AuthenticationMissingError} When there is no eos auth to use for stomp auth
+   * @throws {StompConnectionError} When the connection failed for any reason
+   * @throws {Error} When there was an error with the underlying websocket
    */
   public async connect() {
     if (!this.client.auth.sessions.has(AuthSessionStoreKey.FortniteEOS)) {

src/structures/party/ClientParty.ts

@@ -1,5 +1,6 @@
 import { Collection } from '@discordjs/collection';
 import { AsyncQueue } from '@sapphire/async-queue';
+import { deprecate } from 'util';
 import Endpoints from '../../../resources/Endpoints';
 import FriendNotFoundError from '../../exceptions/FriendNotFoundError';
 import PartyAlreadyJoinedError from '../../exceptions/PartyAlreadyJoinedError';
@@ -21,6 +22,8 @@ import type {
 import type PartyMember from './PartyMember';
 import type Friend from '../friend/Friend';
 
+const deprecationNotOverXmppAnymore = 'Party Chat is not done over XMPP anymore, this function will be removed in a future version';
+
 /**
  * Represents a party that the client is a member of
  */
@@ -86,8 +89,6 @@ class ClientParty extends Party {
   public async leave(createNew = true) {
     this.client.partyLock.lock();
 
-    if (this.chat.isConnected) await this.chat.leave();
-
     try {
       await this.client.http.epicgamesRequest({
         method: 'DELETE',
@@ -262,9 +263,13 @@ class ClientParty extends Party {
   /**
    * Ban a member from this party chat
    * @param member The member that should be banned
+   * @deprecated This feature has been deprecated since epic moved chatting away from xmpp
    */
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
   public async chatBan(member: string) {
-    return this.chat.ban(member);
+    const deprecatedFn = deprecate(() => { }, deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 
   /**

src/structures/party/PartyChat.ts

@@ -1,36 +1,40 @@
+import { deprecate } from 'util';
 import Base from '../../Base';
 import AsyncLock from '../../util/AsyncLock';
 import PartyMessage from './PartyMessage';
+import PartyChatConversationNotFound from '../../exceptions/PartyChatConversationNotFound';
 import type Client from '../../Client';
 import type ClientParty from './ClientParty';
 import type ClientPartyMember from './ClientPartyMember';
 
+const deprecationNotOverXmppAnymore = 'Party Chat is not done over XMPP anymore, this function will be removed in a future version';
+
 /**
  * Represents a party's conversation
  */
 class PartyChat extends Base {
   /**
    * The chat room's JID
-   * @deprecated since chat is not done over xmpp anymore, this property will always be an empty string
+   * @deprecated since chat is not done over xmpp anymore, this property will always be an empty string and will be removed in a future version
    */
   public jid: string;
 
   /**
-   * the party chats conversation id
+   * the party chat's conversation id
    */
   public get conversationId() {
     return `p-${this.party.id}`;
   }
 
   /**
    * The client's chat room nickname
-   * @deprecated since chat is not done over xmpp anymore, this property will always be an empty string
+   * @deprecated since chat is not done over xmpp anymore, this property will always be an empty string  and will be removed in a future version
    */
   public nick: string;
 
   /**
    * The chat room's join lock
-   * @deprecated since chat is not done over xmpp anymore, this is not used anymore
+   * @deprecated since chat is not done over xmpp anymore, this is not used anymore and will be removed in a future version
    */
   public joinLock: AsyncLock;
 
@@ -41,15 +45,10 @@ class PartyChat extends Base {
 
   /**
    * Whether the client is connected to the party chat
-   * @deprecated since chat is not done over xmpp anymore, this property will always be true
+   * @deprecated since chat is not done over xmpp anymore, this property will always be true and will be removed in a future version
    */
   public isConnected: boolean;
 
-  /**
-   * Holds the account ids, which will not receive party messages anymore from the currently logged in user
-   */
-  public bannedAccountIds: Set<string>;
-
   /**
    * @param client The main client
    * @param party The chat room's party
@@ -64,21 +63,24 @@ class PartyChat extends Base {
     this.isConnected = true;
 
     this.party = party;
-    this.bannedAccountIds = new Set<string>();
   }
 
   /**
    * Sends a message to this party chat
    * @param content The message that will be sent
+   * @throws {PartyChatConversationNotFound} When the client is the only party member
    */
   public async send(content: string) {
+    if (this.party.members.size < 2) {
+      throw new PartyChatConversationNotFound();
+    }
+
     const messageId = await this.client.chat.sendMessageInConversation(
       this.conversationId,
       {
         body: content,
       },
       this.party.members
-        .filter((x) => !this.bannedAccountIds.has(x.id))
         .map((x) => x.id),
     );
 
@@ -92,32 +94,36 @@ class PartyChat extends Base {
 
   /**
    * Joins this party chat
-   * @deprecated since chat is not done over xmpp anymore, this function will do nothing
+   * @deprecated since chat is not done over xmpp anymore, this function will do nothing and will be removed in a future version
    */
-  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-empty-function
-  public async join() { }
+  // eslint-disable-next-line class-methods-use-this
+  public async join() {
+    const deprecatedFn = deprecate(() => { }, deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
+  }
 
   /**
    * Leaves this party chat
-   * @deprecated since chat is not done over xmpp anymore, this function will do nothing
+   * @deprecated since chat is not done over xmpp anymore, this function will do nothing and will be removed in a future version
    */
-  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-empty-function
-  public async leave() { }
+  // eslint-disable-next-line class-methods-use-this
+  public async leave() {
+    const deprecatedFn = deprecate(() => { }, deprecationNotOverXmppAnymore);
 
-  /**
-   * Ban a member from receiving party messages from the logged in user
-   * @param member The member that should be banned
-   */
-  public async ban(member: string) {
-    this.bannedAccountIds.add(member);
+    return deprecatedFn();
   }
 
   /**
-   * Unban a member from receiving party messages from the logged in user
-   * @param member The member that should be unbanned
-   */
-  public async unban(member: string) {
-    this.bannedAccountIds.delete(member);
+    * Ban a member from this party chat
+    * @param member The member that should be banned
+    * @deprecated since chat is not done over xmpp anymore, this function will do nothing and will be removed in a future version
+    */
+  // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+  public async ban(member: string) {
+    const deprecatedFn = deprecate(() => { }, deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 }
 

src/xmpp/XMPP.ts

@@ -1,5 +1,7 @@
+/* eslint-disable max-len */
 import { createClient as createStanzaClient } from 'stanza';
 import crypto from 'crypto';
+import { deprecate } from 'util';
 import Base from '../Base';
 import Endpoints from '../../resources/Endpoints';
 import PartyMessage from '../structures/party/PartyMessage';
@@ -27,6 +29,8 @@ import XMPPConnectionError from '../exceptions/XMPPConnectionError';
 import type { Stanzas, Agent, Constants } from 'stanza';
 import type Client from '../Client';
 
+const deprecationNotOverXmppAnymore = 'Chatting is not done over XMPP anymore, this function will be removed in a future version';
+
 /**
  * Represents the client's XMPP manager
  * @private
@@ -671,24 +675,26 @@ class XMPP extends Base {
    * @param to The message receiver's JID
    * @param content The message that will be sent
    * @param type The message type (eg "chat" or "groupchat")
-   * @deprecated this is useless now, since chat messages are handeled via an rest api now see {@link Client#chat}
+   * @deprecated this doesn't work anymore, since chat messages are handled via an rest api now see {@link Client#chat}. This function will be removed in a future version
    */
   public async sendMessage(to: string, content: string, type: Constants.MessageType = 'chat') {
-    return this.waitForSentMessage(this.connection!.sendMessage({
+    const deprecatedFn = deprecate(async () => this.waitForSentMessage(this.connection!.sendMessage({
       to,
       body: content,
       type,
-    }));
+    })), deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 
   /**
    * Wait until a message is sent
    * @param id The message id
    * @param timeout How long to wait for the message
-   * @deprecated this is useless now, since chat messages are handeled via an rest api now see {@link Client#chat}
+   * @deprecated this doesn't work anymore, since chat messages are handled via an rest api now see {@link Client#chat}. This function will be removed in a future version
    */
   public waitForSentMessage(id: string, timeout = 1000) {
-    return new Promise<Stanzas.Message | undefined>((res) => {
+    const deprecatedFn = deprecate(async () => new Promise<Stanzas.Message | undefined>((res) => {
       // eslint-disable-next-line no-undef
       let messageTimeout: NodeJS.Timeout;
 
@@ -705,36 +711,44 @@ class XMPP extends Base {
         res(undefined);
         this.connection!.removeListener('message:sent', listener);
       }, timeout);
-    });
+    }), deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 
   /**
    * Joins a multi user chat room (MUC)
    * @param jid The room's JID
    * @param nick The client's nickname
-   * @deprecated this is useless now, since chat messages are handeled via an rest api now see {@link Client#chat}
+   * @deprecated this doesn't work anymore, since chat messages are handled via an rest api now see {@link Client#chat}. This function will be removed in a future version
    */
   public async joinMUC(jid: string, nick: string) {
-    return this.connection!.joinRoom(jid, nick);
+    const deprecatedFn = deprecate(async () => this.connection!.joinRoom(jid, nick), deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 
   /**
    * Leaves a multi user chat room (MUC)
    * @param jid The room's JID
    * @param nick The client's nickname
-   * @deprecated this is useless now, since chat messages are handeled via an rest api now see {@link Client#chat}
+   * @deprecated this doesn't work anymore, since chat messages are handled via an rest api now see {@link Client#chat}. This function will be removed in a future version
    */
   public async leaveMUC(jid: string, nick: string) {
-    return this.connection!.leaveRoom(jid, nick);
+    const deprecatedFn = deprecate(async () => this.connection!.leaveRoom(jid, nick), deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 
   /**
    * Bans a member from a multi user chat room
    * @param member The member that should be banned
-   * @deprecated this is useless now, since chat messages are handeled via an rest api now see {@link Client#chat}
+   * @deprecated this doesn't work anymore, since chat messages are handled via an rest api now see {@link Client#chat}. This function will be removed in a future version
    */
   public async ban(jid: string, member: string) {
-    return this.connection!.ban(jid, `${member}@${Endpoints.EPIC_PROD_ENV}`);
+    const deprecatedFn = deprecate(async () => this.connection!.ban(jid, `${member}@${Endpoints.EPIC_PROD_ENV}`), deprecationNotOverXmppAnymore);
+
+    return deprecatedFn();
   }
 }