discord-html-transcripts-fix 1.8.2 → 2.0.0

package/README.md

@@ -1,16 +1,26 @@
 # `discord-html-transcripts-fix`
 
+[![npm version](https://img.shields.io/npm/v/discord-html-transcripts-fix.svg)](https://www.npmjs.com/package/discord-html-transcripts-fix)
+[![license](https://img.shields.io/npm/l/discord-html-transcripts-fix.svg)](./LICENSE)
+[![node](https://img.shields.io/node/v/discord-html-transcripts-fix.svg)](https://nodejs.org)
+
 A nicely formatted HTML transcript generator for [discord.js](https://discord.js.org/) with full **Components V2** support, an **interactive viewer**, and **hardened security**.
 
 Forked from [discord-html-transcripts](https://github.com/ItzDerock/discord-html-transcripts).
 
+## Requirements
+
+- **Node.js ≥ 20** — the image downloader uses `undici` v7.
+- **discord.js v14 or v15** — required peer dependency.
+- **[`sharp`](https://sharp.pixelplumbing.com/)** — *optional* peer dependency, only needed if you use `.withCompression()` to compress / convert transcript images to WebP.
+
 ## Install
 
 ```bash
 npm install discord-html-transcripts-fix
 ```
 
-Only `discord.js` is a peer dependency; everything else (React, Lit SSR, markdown parser, etc.) is auto-installed.
+`discord.js` is the only **required** peer dependency — React, Lit SSR, the markdown parser, etc. are installed automatically. `sharp` is an optional peer (image compression only).
 
 ## Quick start
 
@@ -18,11 +28,28 @@ Only `discord.js` is a peer dependency; everything else (React, Lit SSR, markdow
 const { createTranscript } = require('discord-html-transcripts-fix');
 
 const attachment = await createTranscript(channel, {
-    limit: -1,
+    limit: -1,        // fetch every message
     saveImages: false,
 });
 
-channel.send({ files: [attachment] });
+await channel.send({ files: [attachment] });
+```
+
+### TypeScript
+
+In TypeScript, use the `ExportReturnType` enum for `returnType` (the return value is typed accordingly):
+
+```ts
+import { createTranscript, ExportReturnType } from 'discord-html-transcripts-fix';
+
+const html = await createTranscript(channel, {
+    returnType: ExportReturnType.String, // => Promise<string>
+    language: 'de',
+});
+
+const stream = await createTranscript(channel, {
+    returnType: ExportReturnType.Stream, // => Promise<Readable>, ideal for huge tickets
+});
 ```
 
 ## Options
@@ -31,7 +58,7 @@ channel.send({ files: [attachment] });
 |---|---|---|---|
 | `limit` | `number` | `-1` | Max messages to fetch. `-1` = recursive (all). |
 | `filter` | `(m) => boolean` | `() => true` | Predicate to filter messages. |
-| `returnType` | `'attachment'` \| `'buffer'` \| `'string'` \| `'stream'` | `'attachment'` | Return value shape. `'stream'` is best for 5k+ message exports. |
+| `returnType` | `'attachment'` \| `'buffer'` \| `'string'` \| `'stream'` | `'attachment'` | Return value shape. In TypeScript pass the `ExportReturnType` enum. `'stream'` returns a Node `Readable` and is best for 5k+ message exports. |
 | `filename` | `string` | `transcript-{channel-id}.html` | Output filename when returning as attachment. |
 | `saveImages` | `boolean` | `false` | Download images and inline them as base64 data URLs. |
 | `favicon` | `'guild'` \| `string` | `'guild'` | Page favicon — `'guild'` uses the server icon, or pass a URL. |
@@ -39,9 +66,9 @@ channel.send({ files: [attachment] });
 | `language` | `'en'` \| `'de'` | `'en'` | UI language for participant labels, filter strings, etc. |
 | `i18n` | `Partial<Record<lang, Record<key,string>>>` | — | Override individual strings per language. |
 | `statsFooter` | `false` \| `{ enabled?, template? }` | `{ enabled: true }` | Bottom stats line. See below. |
-| `footerText` | `string` | — | Legacy "Exported X messages" line. Only renders when `statsFooter` is disabled. |
-| `poweredBy` | `boolean` | `false` | Show the original "Powered by discord-html-transcripts" credit link. |
-| `callbacks` | `{ resolveUser, resolveRole, resolveChannel }` | — | Custom resolvers for mentions. |
+| `footerText` | `string` | `Exported {number} message{s}.` | Legacy "Exported X messages" line. Only renders when `statsFooter` is disabled. |
+| `poweredBy` | `boolean` | `false` | Show the original "Powered by discord-html-transcripts" credit link. Only renders when `statsFooter` is disabled. |
+| `callbacks` | `{ resolveUser, resolveRole, resolveChannel, resolveImageSrc }` | — | Custom resolvers for mentions / image URLs. |
 
 ### Configurable stats footer
 
@@ -58,6 +85,23 @@ await createTranscript(channel, { statsFooter: false });
 
 Placeholders: `{messages}`, `{participants}`, `{images}`, `{from}`, `{to}`, `{span}`.
 
+### Image compression (optional)
+
+`saveImages: true` inlines images as base64 without any extra dependency. To additionally
+compress them (and optionally convert to WebP), install `sharp` and build a custom downloader:
+
+```js
+const { createTranscript, TranscriptImageDownloader } = require('discord-html-transcripts-fix');
+
+const resolveImageSrc = new TranscriptImageDownloader()
+    .withMaxSize(2048)            // KB per image
+    .withConcurrency(8)           // parallel downloads (default 6)
+    .withCompression(80, true)    // quality 80, convert to WebP — requires `sharp`
+    .build();
+
+await createTranscript(channel, { saveImages: true, callbacks: { resolveImageSrc } });
+```
+
 ### Optional edit history
 
 If your bot tracks edits, attach them to the message *before* rendering:
@@ -130,6 +174,7 @@ In addition to plain text, replies, embeds, and attachments, the viewer supports
 - **Fix** `parseDiscordEmoji` no longer throws on deleted reactions with `emoji.name === null`
 - **Fix** `formatBytes(null/undefined/NaN)` no longer returns `NaN undefined`
 - **Fix** `createTranscript` slice uses the resolved limit instead of the raw `limit`
+- **Fix** `statsFooter` (custom template / `false`) is now forwarded end-to-end — it used to be silently ignored by `createTranscript`/`generateFromMessages`
 - **Fix** embed fields render through a proper async component (was an inline `async` arrow inside `.map()`)
 - **Fix** `JoinMessage` text is deterministic per message id — re-rendering the same channel always yields the same join line
 - **Fix** random `console.log` calls in production paths replaced by the `debug` namespace
@@ -153,8 +198,23 @@ In addition to plain text, replies, embeds, and attachments, the viewer supports
 ### DX
 
 - **`react`, `react-dom`, `debug` moved into regular dependencies** so users don't install them manually (`debug` was actually a missing runtime dep in the original — `images.js` requires it)
-- TypeScript declarations cover all new options
-- `discord.js` remains the only peer dependency
+- **`sharp` declared as an optional peer dependency** — needed only for `.withCompression()`, no longer a hidden requirement
+- **TypeScript declarations match runtime** — `ExportReturnType.Stream`, `language`, `i18n`, `stream`, and `withConcurrency()` are now exposed in the types
+- `discord.js` remains the only **required** peer dependency
+
+## API
+
+| Export | Description |
+|---|---|
+| `createTranscript(channel, options?)` | Fetch a channel's messages and render a transcript. |
+| `generateFromMessages(messages, channel, options?)` | Render a transcript from a message array/collection you already have. |
+| `ExportReturnType` | Enum: `Attachment` \| `Buffer` \| `String` \| `Stream`. |
+| `TranscriptImageDownloader` | Builder for a custom image-saving callback (`withMaxSize`, `withConcurrency`, `withCompression`, `build`). |
+| `DiscordMessages` | The underlying React component, for advanced/custom rendering. |
+
+## License
+
+[Apache-2.0](./LICENSE) — same as the original package.
 
 ## Credits
 

package/dist/downloader/images.d.ts

@@ -1,5 +1,24 @@
 import type { APIAttachment, APIMessage, Awaitable } from 'discord.js';
-import type { WebpOptions } from 'sharp';
+/**
+ * Subset of sharp's `WebpOptions`. `sharp` is an OPTIONAL peer dependency — it is
+ * only needed for `.withCompression(..., convertToWebP)`. Typing it locally (instead
+ * of `import('sharp')`) means consumers who don't use compression are not forced to
+ * install sharp and don't get a "Cannot find module 'sharp'" error when type-checking.
+ */
+export interface WebpOptions {
+    quality?: number;
+    alphaQuality?: number;
+    lossless?: boolean;
+    nearLossless?: boolean;
+    smartSubsample?: boolean;
+    effort?: number;
+    loop?: number;
+    delay?: number | number[];
+    minSize?: boolean;
+    mixed?: boolean;
+    force?: boolean;
+    [option: string]: unknown;
+}
 /**
  * Callback used to save an image attachment.
  * The returned string is the URL that will be used in the transcript.
@@ -22,6 +41,11 @@ export declare class TranscriptImageDownloader {
      * @param size The maximum file size in kilobytes
      */
     withMaxSize(size: number): this;
+    /**
+     * Sets the maximum number of images downloaded concurrently.
+     * @param n Concurrency (default 6)
+     */
+    withConcurrency(n: number): this;
     /**
      * Sets the compression quality for each image. This requires `sharp` to be installed.
      * Optionally, images can be converted to WebP format which is smaller in size.

package/dist/index.js

@@ -78,8 +78,9 @@ async function generateFromMessages(messages, channel, options = {}) {
         channel,
         saveImages: options.saveImages ?? false,
         callbacks,
-        poweredBy: options.poweredBy ?? true,
+        poweredBy: options.poweredBy ?? false,
         footerText: options.footerText ?? 'Exported {number} message{s}.',
+        statsFooter: options.statsFooter,
         favicon: options.favicon ?? 'guild',
         hydrate: options.hydrate ?? false,
         language: options.language ?? 'en',

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { AttachmentBuilder, Message } from 'discord.js';
 import type { RenderMessageContext } from './generator';
+import type { Readable } from 'stream';
 export declare enum AttachmentTypes {
     Audio = 0,
     Video = 1,
@@ -9,9 +10,10 @@ export declare enum AttachmentTypes {
 export declare enum ExportReturnType {
     Buffer = "buffer",
     String = "string",
-    Attachment = "attachment"
+    Attachment = "attachment",
+    Stream = "stream"
 }
-export type ObjectType<T extends ExportReturnType> = T extends ExportReturnType.Buffer ? Buffer : T extends ExportReturnType.String ? string : AttachmentBuilder;
+export type ObjectType<T extends ExportReturnType> = T extends ExportReturnType.Buffer ? Buffer : T extends ExportReturnType.String ? string : T extends ExportReturnType.Stream ? Readable : AttachmentBuilder;
 export type GenerateFromMessagesOptions<T extends ExportReturnType> = Partial<{
     /**
      * The type of object to return
@@ -33,8 +35,9 @@ export type GenerateFromMessagesOptions<T extends ExportReturnType> = Partial<{
      */
     filename: string;
     /**
-     * Whether to include the "Powered by discord-html-transcripts" footer
-     * @default true
+     * Whether to include the "Powered by discord-html-transcripts" credit link.
+     * Only renders when the stats footer is disabled (`statsFooter: false`).
+     * @default false
      */
     poweredBy: boolean;
     /**
@@ -68,6 +71,22 @@ export type GenerateFromMessagesOptions<T extends ExportReturnType> = Partial<{
         enabled?: boolean;
         template?: string;
     };
+    /**
+     * UI language for the built-in strings (participant labels, filter UI, stats footer, …).
+     * @default 'en'
+     */
+    language: 'en' | 'de';
+    /**
+     * Override individual built-in strings per language. Merged over the defaults.
+     * Keys are the string ids used internally (e.g. `statsMessages`, `statsParticipants`).
+     */
+    i18n: Partial<Record<'en' | 'de', Record<string, string>>>;
+    /**
+     * Return a Node `Readable` stream of the rendered HTML instead of buffering it.
+     * Equivalent to `returnType: ExportReturnType.Stream`. Best for very large exports.
+     * @default false
+     */
+    stream: boolean;
 }>;
 export type CreateTranscriptOptions<T extends ExportReturnType> = Partial<GenerateFromMessagesOptions<T> & {
     /**

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "discord-html-transcripts-fix",
-  "version": "1.8.2",
+  "version": "2.0.0",
   "description": "A nicely formatted html transcript generator for discord.js. Bugfix fork with support for the latest discord.js and Components v2.",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
+  "author": "Developer-Sven (https://github.com/Developer-Sven)",
+  "homepage": "https://github.com/Developer-Sven/discord-html-transcripts-fix#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Developer-Sven/discord-html-transcripts-fix.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Developer-Sven/discord-html-transcripts-fix/issues"
+  },
   "keywords": [
     "discord",
     "discord.js",
@@ -34,7 +43,16 @@
     "undici": "^7.16.0"
   },
   "peerDependencies": {
-    "discord.js": "^14.0.0 || ^15.0.0"
+    "discord.js": "^14.0.0 || ^15.0.0",
+    "sharp": ">=0.30.0"
+  },
+  "peerDependenciesMeta": {
+    "sharp": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20"
   },
   "scripts": {
     "prepublishOnly": "node -e \"require('fs').accessSync('dist/index.js'); require('fs').accessSync('dist/index.d.ts');\" || (echo 'dist/index.js or dist/index.d.ts missing — refusing to publish' && exit 1)"