discord-html-transcripts-fix 1.1.0 → 1.3.0

package/dist/index.js

@@ -1,136 +1,133 @@
 "use strict";
 /// <reference path="./discord-components.d.ts" />
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p))
+        Object.defineProperty(exports, p, { enumerable: true, get: function() { return m[p]; } });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TranscriptImageDownloader = exports.DiscordMessages = void 0;
 exports.generateFromMessages = generateFromMessages;
 exports.createTranscript = createTranscript;
+const debug_1 = __importDefault(require("debug"));
 const discord_js_1 = require("discord.js");
 const generator_1 = __importDefault(require("./generator"));
 const types_1 = require("./types");
 const images_1 = require("./downloader/images");
-// re-exports
+
+const log = (0, debug_1.default)('discord-html-transcripts-fix');
+
 var transcript_1 = require("./generator/transcript");
 Object.defineProperty(exports, "DiscordMessages", { enumerable: true, get: function () { return __importDefault(transcript_1).default; } });
 var images_2 = require("./downloader/images");
 Object.defineProperty(exports, "TranscriptImageDownloader", { enumerable: true, get: function () { return images_2.TranscriptImageDownloader; } });
-// version check (warn only — never kill the host process from a library)
+
+// Version check — warn only. NEVER kill host process.
 const versionPrefix = discord_js_1.version.split('.')[0];
 if (versionPrefix !== '14' && versionPrefix !== '15') {
-    console.warn(`[discord-html-transcripts-fix] Compatible with discord.js v14.x and v15.x, you are using v${discord_js_1.version}. Continuing — transcripts may render incorrectly.`);
+    console.warn(`[discord-html-transcripts-fix] Compatible with discord.js v14/v15, you are using v${discord_js_1.version}. Continuing anyway.`);
 }
-/**
- *
- * @param messages The messages to generate a transcript from
- * @param channel  The channel the messages are from (used for header and guild name)
- * @param options  The options to use when generating the transcript
- * @returns        The generated transcript
- */
+
 async function generateFromMessages(messages, channel, options = {}) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-    // turn messages into an array
     const transformedMessages = messages instanceof discord_js_1.Collection ? Array.from(messages.values()) : messages;
-    // figure out how the user wants images saved
-    let resolveImageSrc = (_b = (_a = options.callbacks) === null || _a === void 0 ? void 0 : _a.resolveImageSrc) !== null && _b !== void 0 ? _b : ((attachment) => attachment.url);
+
+    // Image-src resolution
+    let resolveImageSrc = options.callbacks?.resolveImageSrc ?? ((attachment) => attachment.url);
     if (options.saveImages) {
-        if ((_c = options.callbacks) === null || _c === void 0 ? void 0 : _c.resolveImageSrc) {
-            console.warn(`[discord-html-transcripts] You have specified both saveImages and resolveImageSrc, please only specify one. resolveImageSrc will be used.`);
-        }
-        else {
+        if (options.callbacks?.resolveImageSrc) {
+            log('saveImages + resolveImageSrc both set — resolveImageSrc wins');
+        } else {
             resolveImageSrc = new images_1.TranscriptImageDownloader().build();
-            console.log('Using default downloader');
+            log('using default image downloader');
         }
     }
-    // render the messages
-    const html = await (0, generator_1.default)({
+
+    // Pre-build resolution maps from messages so mentions resolve to a name even
+    // when the user/role/channel isn't in client cache and can't be fetched.
+    const userIndex = new Map();
+    const roleIndex = new Map();
+    const channelIndex = new Map();
+    for (const m of transformedMessages) {
+        if (m.author) userIndex.set(m.author.id, m.author);
+        if (m.member?.user) userIndex.set(m.member.user.id, m.member.user);
+        if (m.interaction?.user) userIndex.set(m.interaction.user.id, m.interaction.user);
+        if (m.mentions) {
+            if (m.mentions.users) for (const [id, u] of m.mentions.users) userIndex.set(id, u);
+            if (m.mentions.roles) for (const [id, r] of m.mentions.roles) roleIndex.set(id, r);
+            if (m.mentions.channels) for (const [id, c] of m.mentions.channels) channelIndex.set(id, c);
+        }
+    }
+    if (!channel.isDMBased() && channel.guild) {
+        // pre-warm every role we can see (cheap — cache only)
+        for (const [id, r] of channel.guild.roles.cache) roleIndex.set(id, r);
+    }
+
+    const callbacks = Object.assign({
+        resolveImageSrc,
+        resolveChannel: async (id) => channelIndex.get(id) || channel.client.channels.fetch(id).catch(() => null),
+        resolveUser: async (id) => userIndex.get(id) || channel.client.users.fetch(id).catch(() => null),
+        resolveRole: channel.isDMBased()
+            ? () => null
+            : async (id) => roleIndex.get(id) || channel.guild?.roles.fetch(id).catch(() => null),
+    }, options.callbacks ?? {});
+
+    const rendered = await (0, generator_1.default)({
         messages: transformedMessages,
         channel,
-        saveImages: (_d = options.saveImages) !== null && _d !== void 0 ? _d : false,
-        callbacks: Object.assign({ resolveImageSrc, resolveChannel: async (id) => channel.client.channels.fetch(id).catch(() => null), resolveUser: async (id) => channel.client.users.fetch(id).catch(() => null), resolveRole: channel.isDMBased() ? () => null : async (id) => { var _a; return (_a = channel.guild) === null || _a === void 0 ? void 0 : _a.roles.fetch(id).catch(() => null); } }, ((_e = options.callbacks) !== null && _e !== void 0 ? _e : {})),
-        poweredBy: (_f = options.poweredBy) !== null && _f !== void 0 ? _f : true,
-        footerText: (_g = options.footerText) !== null && _g !== void 0 ? _g : 'Exported {number} message{s}.',
-        favicon: (_h = options.favicon) !== null && _h !== void 0 ? _h : 'guild',
-        hydrate: (_j = options.hydrate) !== null && _j !== void 0 ? _j : false,
+        saveImages: options.saveImages ?? false,
+        callbacks,
+        poweredBy: options.poweredBy ?? true,
+        footerText: options.footerText ?? 'Exported {number} message{s}.',
+        favicon: options.favicon ?? 'guild',
+        hydrate: options.hydrate ?? false,
+        language: options.language ?? 'en',
+        i18n: options.i18n ?? undefined,
+        stream: options.returnType === 'stream' || options.stream === true,
+        returnType: options.returnType,
     });
-    // get the time it took to render the messages
-    // const renderTime = process.hrtime(startTime);
-    // console.log(
-    //   `[discord-html-transcripts] Rendered ${transformedMessages.length} messages in ${renderTime[0]}s ${
-    //     renderTime[1] / 1000000
-    //   }ms`
-    // );
-    // return the html in the specified format
+
+    // Stream pass-through
+    if (options.returnType === 'stream' || options.stream === true) {
+        return rendered; // Node readable stream
+    }
+
     if (options.returnType === types_1.ExportReturnType.Buffer) {
-        return Buffer.from(html);
+        return Buffer.from(rendered);
     }
     if (options.returnType === types_1.ExportReturnType.String) {
-        return html;
+        return rendered;
     }
-    return new discord_js_1.AttachmentBuilder(Buffer.from(html), {
-        name: (_k = options.filename) !== null && _k !== void 0 ? _k : `transcript-${channel.id}.html`,
+    return new discord_js_1.AttachmentBuilder(Buffer.from(rendered), {
+        name: options.filename ?? `transcript-${channel.id}.html`,
     });
 }
-/**
- *
- * @param channel The channel to create a transcript from
- * @param options The options to use when creating the transcript
- * @returns       The generated transcript
- */
+
 async function createTranscript(channel, options = {}) {
-    // validate type
     if (!channel.isTextBased()) {
-        // @ts-expect-error(2339): run-time check
         throw new TypeError(`Provided channel must be text-based, received ${channel.type}`);
     }
-    // fetch messages
     let allMessages = [];
     let lastMessageId;
     const { limit, filter } = options;
     const resolvedLimit = typeof limit === 'undefined' || limit === -1 ? Infinity : limit;
-    // until there are no more messages, keep fetching
     while (true) {
-        // create fetch options
         const fetchLimitOptions = { limit: 100, before: lastMessageId };
-        if (!lastMessageId)
-            delete fetchLimitOptions.before;
-        // fetch messages
+        if (!lastMessageId) delete fetchLimitOptions.before;
         const messages = await channel.messages.fetch(fetchLimitOptions);
         const filteredMessages = typeof filter === 'function' ? messages.filter(filter) : messages;
-        // add the messages to the array
-        allMessages.push(...filteredMessages.values());
-        // Get the last key of 'messages', not 'filteredMessages' because you will be refetching the same messages
+        for (const m of filteredMessages.values()) allMessages.push(m);
         lastMessageId = messages.lastKey();
-        // if there are no more messages, break
-        if (messages.size < 100)
-            break;
-        // if the limit has been reached, break
-        if (allMessages.length >= resolvedLimit)
-            break;
+        if (messages.size < 100) break;
+        if (allMessages.length >= resolvedLimit) break;
+    }
+    if (resolvedLimit < allMessages.length) {
+        allMessages = allMessages.slice(0, resolvedLimit);
     }
-    if (resolvedLimit < allMessages.length)
-        allMessages = allMessages.slice(0, limit);
-    // generate the transcript
     return generateFromMessages(allMessages.reverse(), channel, options);
 }
-exports.default = {
-    createTranscript,
-    generateFromMessages,
-};
+
+exports.default = { createTranscript, generateFromMessages };
 __exportStar(require("./types"), exports);
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map