## What's New

**v6.0.3**

- Add the new battlebots policy thread to the README.

**v6.0.2**

- Fixes `addUser` leaving a stale `status` when it should be cleared.

**v6.0.1**

- Fixes a reconnect bug where the bot would get stuck under a guest username.

**v6.0.0**

- Datacenter files are no longer shipped in the package or tracked in git. Use `Tools.fetch` to load data from play.pokemonshowdown.com at runtime.
- `Tools.HSL` now accepts `{ original?, customColors? }` instead of a boolean `original` argument; pass `customColors` from `fetch('colors')` when you need PS custom name colours.

**v5.4.0**

- `Client#getUser` now returns `undefined` instead of `false` when the user is not tracked.

**v5.3.1**

- Avoid using groupchats to send HTML.

**v5.3.0**

- Implements reconnect backoffs (doubles the time before each reconnection attempt).

**v5.2.0**

- Supports the new `Species#isCosmeticForme` prop on Pokédex Species.
- Fixes some JSDoc default value mismatches. [#37](https://github.com/PartMan7/PS-Client/pull/37) by [@singiamtel](https://github.com/singiamtel)
- Removes the unused dotenv dependency. [#38](https://github.com/PartMan7/PS-Client/pull/38) by [@singiamtel](https://github.com/singiamtel)

**v5.1.2**

- Checks `null` cases for `Client.status` in methods like `Client#send` when the client might be forcefully disconnected.

**v5.1.1**

- Initializes Room/User instances with roomid/userid as well as id.
- Fixed Message inspection title.

**v5.1.0**

Pushing this as a minor change instead of a major one; just pretend this was shipped with 5.0.0.

- `autoReconnectDelay` was merged into `autoReconnect`.
- Improved docs for client events, `Message` and other stuff.
- Added missing props (eg: `message.command`).
- `Message` is now a generic that accepts `'chat'` or `'pm'` to disambiguate between the types. Defaults to `'chat'`.
- Initializers added for props on `Room` (eg: `users=[]`) so there aren't any errors before the room is hydrated.
- A lot of helpers that previously returned `false` now return `null` instead to represent the error state.
- Some internal code cleanup.

**v5.0.1**

- Fixes `reconnect` handling (rejoins rooms, updates avatar, etc).

**v5.0.0.**

- Adds `scrollback` as a client option.
  - Clients will now be opted out of scrollback by default! Set to true to opt back in.

**v4.5.3**

- Use `sendQueue` over `send` for `rooms` to auto-join.
- Add types for `Tools.toRoomId`.

**v4.5.2**

- Fixes update path logic for `Tools.update` (uses \_\_dirname instead of relative fs resolutions).

**v4.5.1**

- Fixes types for `Tools.update`.

**v4.5.0**

- Adds `Tools.toRoomID` for getting room IDs from text.
- Uses `toRoomID` over `toID` for rooms in `Client#joinRoom` and `Client#getRoom`, supporting joining groupchats.

**v4.4.1**

- Bugfixes for `Message#replyHTML` not working in DMs.

**v4.4.0**

- Adds a `sparse` option for clients. Sparse clients will fetch userdetails and roominfo minimally.
- Adds a `packet` event for logging all websocket packets.

**v4.3.0**

- Adds `Room#pmHTML` and `Room#pageHTML`.
- Adds support for sending HTML to multiple users simultaneously via `Room#pageHTML` and `Room#privateHTML`.
- Updates documentation and JSDoc comments.

**v4.2.0**

- Adds handling for `/botmsg` PMs as regular PMs with the relevant command.
- Adds an `isHidden` property on `Message` if the type is `pm`.

**v4.1.0**

- Includes `type: secret` rooms while determining viable rooms to send HTML to users from.
- Adds `opts.room` to HTMLOpts, to allow specifying the room for `User#HTML` methods.

**v4.0.4**

- Fixes bug with TypeScript not inferring across Message's discriminating type union for `type`.

**v4.0.3**

- Fixes type exports for Message (previously, TypeScript was told it only exported the type and not the value).

**v4.0.2**

- Fixes notransform logic (was inverted).

**v4.0.1**

- Fixes types for `*HTML` methods to use `any`.

**v4.0.0**

- Minimum version is bumped up to 18.0.0 from 14.0.0.
- Removes `axios` and replaces all calls with `fetch`.
- Removes default `inline-css` HTML processing logic. You may instead pass your own logic to options under `transformHTML`.
- Removes `*RawHTML()` methods from all classes. Use `HTMLopts.notransform` instead.
- `User#pageHTML` now uses `HTMLopts` instead of just `name`.

**v3.8.2**

- Fixes isTrusted logic and adds an 'activate' event.

**v3.8.1**

- Adds missing void return values to JSDoc and fixes some parameters.

**v3.8.0**

- Adds types for `ps-client/data`. Holy shit, this was painful.

**v3.7.0**

- Adds raw variants for all HTML methods to bypass formatting with inlineCss.

**v3.6.2**

- Adds optional types for `chat.js` (which shouldn't be directly imported).

**v3.6.1**

- Fixes invalid time values for `|c:|` messages.

**v3.6.0**

- Adds config option to use `ws` while connecting over `wss`. [#20](https://github.com/PartMan7/PS-Client/pull/20) by [@singiamtel](https://github.com/singiamtel)

**v3.5.3**

- Fixes connection logic to work after PS API changes.

**v3.5.2**

- Added more files to `.npmignore`.

**v3.5.1**

- Updated types for `room.auth` potentially being undefined, as well as types for namecolour.

**v3.5.0**

- Allowed specifying the full URL in `opts.server` if `opts.port` is not specified.

**v3.4.3**

- Fixed a bug in `Room#sendHTML`.

**v3.4.2**

- Fixed a bug in client typings.

**v3.4.1**

- Added proper split typings to Message for narrowing in TypeScript.

**v3.4.0**

- Added `update` methods to Users and Rooms.
- Restructured type definitions, added JSDoc-style comments, moved Message, User, and Room to root-level imports.

**v3.3.3**

- Added missing type definitions for `Message#msgRank`.
- Fix message types and remove extra messages from queue. [#12](https://github.com/PartMan7/PS-Client/pull/12) by [d3nsh1n](https://github.com/d3nsh1n)

**v3.3.2**

- Addressed a bug in `User#sendHTML`.

**v3.3.1**

- Updated typings on the classes to correctly include all return values and optional fields.

**v3.3.0**

- Added a `Tools#formatText` function to format chat text accordingly!

**v3.2.1**

- Made `Client#on('name')` also emit an isIntro event.

**v3.2.0**

- Added a `noFailMessages` option in config to prevent messages throwing errors; defaults to true.

**v3.1.1**

- Fixed minor lint errors.
- Added Husky to make sure this doesn't happen again.

**v3.1.0**

- Made `Message#privateReply` send a DM to the author if the client does not have permissions to send private HTML in the room.

**v3.0.0**

- Type definitions for all custom events added.
- The 'chaterror' event was renamed to 'chatError' to be in line with other event names.

**v2.1.1**

- Fixed the d.ts files to actually work.
- Moved the changelog to be lower in the README.

**v2.1.0**

- Added in a `Message#msgRank` field for much easier rank parsing.

**v2.0.0**

- I suck and forgot to document this; `rooms` has been used in place of `autoJoin` in the config now for automatically joining rooms.

**v1.7.1**

- Fixed the crash when a user used `/hidelines` or a similar `&`-sent message.
- Accidentally skipped 1.7.0.

**v1.6.1**

- Cleaned up unit tests and removed unnecessary PartProfessor mentions.

**v1.6.0**

- PS-Client now uses both customcolor sources (the same way the actual client does) to read namecolors.
- Added unit tests.

**v1.5.0**

- Fix status not being sent while logging in. [#2](https://github.com/PartMan7/PS-Client/pull/2) by [Dirain1700](https://github.com/Dirain1700)
- Add `*.d.ts` files for method documentation.
- Update descriptions in the README.
- `Client#users` and `Client#rooms` are now Maps instead of objects.
- Updated the util.inspect entries for Client/Room/User/Message.
- Massive code cleanup.

**v1.4.1**

- User#sendHTML and User#pageHTML now work correctly.

**v1.4.0**

- Multi-line messages now resolve at the time of the final line being successfully sent, instead of never resolving.
- Some datacenters now use JSON.

**v1.3.0**

- Added various HTML methods to the Message, Room, and User classes.
- Messages that successfully resolve a waitFor promise now have the `awaited` flag set.
- Various properties of the Client, Room, and User classes have now been privatized.
- Additions to Tools, including escapeHTML, unescapeHTML, and parseMessage.