discord-html-transcripts-v2 3.3.1 → 3.3.2

package/README.md

@@ -33,104 +33,3 @@ This module can format the following:
 Styles from [@derockdev/discord-components](https://github.com/ItzDerock/discord-components).
 Behind the scenes, this package uses React SSR to generate a static site.
 
-## 👋 Support
-
-Please do not DM me requesting support with this package, I will not respond.
-Instead, please open a thread on [this](https://discord.gg/MZQN8QMJg8) server.
-
-## 🖨️ Example Output
-
-![output](https://derock.media/r/6G6FIl.gif)
-
-## 📝 Usage
-
-### Example usage using the built in message fetcher.
-
-```js
-const discordTranscripts = require('discord-html-transcripts-v2');
-// or (if using typescript) import * as discordTranscripts from 'discord-html-transcripts-v2';
-
-const channel = message.channel; // or however you get your TextChannel
-
-// Must be awaited
-const attachment = await discordTranscripts.createTranscript(channel);
-
-channel.send({
-  files: [attachment],
-});
-```
-
-### Or if you prefer, you can pass in your own messages.
-
-```js
-const discordTranscripts = require('discord-html-transcripts-v2');
-// or (if using typescript) import * as discordTranscripts from 'discord-html-transcripts-v2';
-
-const messages = someWayToGetMessages(); // Must be Collection<string, Message> or Message[]
-const channel = someWayToGetChannel(); // Used for ticket name, guild icon, and guild name
-
-// Must be awaited
-const attachment = await discordTranscripts.generateFromMessages(messages, channel);
-
-channel.send({
-  files: [attachment],
-});
-```
-
-## ⚙️ Configuration
-
-Both methods of generating a transcript allow for an option object as the last parameter.
-**All configuration options are optional!**
-
-### Built in Message Fetcher
-
-```js
-const attachment = await discordTranscripts.createTranscript(channel, {
-    limit: -1, // Max amount of messages to fetch. `-1` recursively fetches.
-    returnType: 'attachment', // Valid options: 'buffer' | 'string' | 'attachment' Default: 'attachment' OR use the enum ExportReturnType
-    filename: 'transcript.html', // Only valid with returnType is 'attachment'. Name of attachment.
-    saveImages: false, // Download all images and include the image data in the HTML (allows viewing the image even after it has been deleted) (! WILL INCREASE FILE SIZE !)
-    footerText: "Exported {number} message{s}", // Change text at footer, don't forget to put {number} to show how much messages got exported, and {s} for plural
-    callbacks: {
-      // register custom callbacks for the following:
-      resolveChannel: (channelId: string) => Awaitable<Channel | null>,
-      resolveUser: (userId: string) => Awaitable<User | null>,
-      resolveRole: (roleId: string) => Awaitable<Role | null>,
-      resolveImageSrc: (
-        attachment: APIAttachment,
-        message: APIMessage
-      ) => Awaitable<string | null | undefined>
-    },
-    poweredBy: true, // Whether to include the "Powered by discord-html-transcripts-v2" footer
-    hydrate: true, // Whether to hydrate the html server-side
-    filter: (message) => true // Filter messages, e.g. (message) => !message.author.bot
-});
-```
-
-### Providing your own messages
-
-```js
-const attachment = await discordTranscripts.generateFromMessages(messages, channel, {
-  // Same as createTranscript, except no limit or filter
-});
-```
-
-### Compressing images
-
-If `saveImages` is set to `true`, all images will be downloaded and stored in the file _as-is_. You can optionally enable compression by installing the `sharp` module and setting the following options:
-
-```js
-callbacks: {
-  resolveImageSrc: new TranscriptImageDownloader()
-    .withMaxSize(5120) // 5MB in KB
-    .withCompression(40, true) // 40% quality, convert to webp
-    .build(),
-},
-```
-
-Note that, in a more advanced setup, you could store a copy of the files and return an entirely new URL pointing to your own image hosting site by implementing a custom `resolveImageSrc` function.
-
-## 🤝 Enjoy the package?
-
-Give it a star ⭐ and/or support me on [ko-fi](https://ko-fi.com/derock)
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-html-transcripts-v2",
-  "version": "3.3.1",
+  "version": "3.3.2",
   "description": "A nicely formatted html transcript generator for discord.js.",
   "main": "dist/index.js",
   "homepage": "https://github.com/Exodo0/discord-html-transcripts-v2",
@@ -38,18 +38,18 @@
     "dist/**/*.js.map"
   ],
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.3",
-    "@eslint/js": "^9.39.3",
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^9.39.4",
     "@types/debug": "^4.1.12",
-    "@types/node": "^24.10.13",
+    "@types/node": "^24.12.0",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
-    "@typescript-eslint/eslint-plugin": "^8.56.0",
-    "@typescript-eslint/parser": "^8.56.0",
+    "@typescript-eslint/eslint-plugin": "^8.57.0",
+    "@typescript-eslint/parser": "^8.57.0",
     "debug": "^4.4.3",
     "discord.js": "^14.25.1",
     "dotenv": "^17.3.1",
-    "eslint": "^9.39.3",
+    "eslint": "^9.39.4",
     "globals": "^16.5.0",
     "husky": "^9.1.7",
     "prettier": "^3.8.1",
@@ -66,7 +66,7 @@
     "react-dom": "19.1.1",
     "simple-markdown": "^0.7.3",
     "twemoji": "^14.0.2",
-    "undici": "^7.22.0"
+    "undici": "^7.24.4"
   },
   "peerDependencies": {
     "discord.js": "^14.0.0 || ^15.0.0"