discord-html-transcripts-fix 2.2.0 → 2.3.1

package/dist/utils/utils.js

@@ -9,13 +9,49 @@ exports.parseDiscordEmoji = parseDiscordEmoji;
 exports.streamToString = streamToString;
 exports.safeJsonForScript = safeJsonForScript;
 exports.safeHref = safeHref;
+exports.safeImageSrc = safeImageSrc;
+exports.safeLinkHref = safeLinkHref;
+exports.describeError = describeError;
+exports.truncateText = truncateText;
 exports.safeColor = safeColor;
 exports.safeImageMime = safeImageMime;
 exports.escapeHtml = escapeHtml;
 exports.resolveTimestampFormat = resolveTimestampFormat;
 exports.formatMessageTimestamp = formatMessageTimestamp;
+exports.isForwardReference = isForwardReference;
+exports.isForwardMessage = isForwardMessage;
+exports.isLibraryStructure = isLibraryStructure;
+const discord_js_1 = require("discord.js");
 const twemoji_1 = __importDefault(require("twemoji"));
 
+// MessageReferenceType.Forward. Spelled as the API value on purpose: the enum only
+// exists from discord.js 14.16, and reading it on an older 14.x throws for every
+// message that has a reference.
+const MESSAGE_REFERENCE_TYPE_FORWARD = 1;
+// MessageFlags.HasSnapshot, for the same reason.
+const MESSAGE_FLAG_HAS_SNAPSHOT = 1 << 14;
+
+function isForwardReference(reference) {
+    return !!reference && reference.type === MESSAGE_REFERENCE_TYPE_FORWARD;
+}
+
+// Before 14.16, discord.js dropped the reference type and the snapshots, so a
+// forward looked exactly like a reply. The message flags are kept raw by every
+// 14.x and still tell the two apart.
+function isForwardMessage(message) {
+    if (!message) return false;
+    if (isForwardReference(message.reference)) return true;
+    const flags = typeof message.flags === 'number' ? message.flags : message.flags?.bitfield;
+    return typeof flags === 'number' && (flags & MESSAGE_FLAG_HAS_SNAPSHOT) !== 0;
+}
+
+// True for anything discord.js built, as opposed to plain objects a caller passed
+// in. Every structure carries its client; the second check also holds when a
+// second copy of discord.js is installed and `instanceof` fails.
+function isLibraryStructure(value) {
+    return value instanceof discord_js_1.Base || (value !== null && typeof value === 'object' && 'client' in value);
+}
+
 const DEFAULT_TIMESTAMP_FORMAT = { dateFormat: 'dd/mm/yyyy', timeFormat: '24h' };
 
 function pad2(n) {
@@ -25,11 +61,27 @@ function pad2(n) {
 // Normalizes the user-facing options once, at render start, so every renderer
 // shares one reference "now" — otherwise a transcript rendered across midnight
 // could label the same day both "today" and with a full date.
+// Accepts the documented values case-insensitively ('12H', 'MM/DD/YYYY'); anything
+// else falls back to the default and is reported once per value instead of silently.
+const warnedChoices = new Set();
+function resolveChoice(name, value, allowed, fallback) {
+    if (value === undefined || value === null) return fallback;
+    const normalized = typeof value === 'string' ? value.trim().toLowerCase() : value;
+    if (allowed.includes(normalized)) return normalized;
+    const key = name + ':' + String(value);
+    if (!warnedChoices.has(key)) {
+        warnedChoices.add(key);
+        console.warn(`[discord-html-transcripts-fix] ${name} must be one of ${allowed.map((a) => `'${a}'`).join(', ')} ` +
+            `(got ${typeof value === 'string' ? JSON.stringify(value) : String(value)}); using '${fallback}'.`);
+    }
+    return fallback;
+}
+
 function resolveTimestampFormat(options) {
     const o = options || {};
     return {
-        dateFormat: o.dateFormat === 'mm/dd/yyyy' ? 'mm/dd/yyyy' : DEFAULT_TIMESTAMP_FORMAT.dateFormat,
-        timeFormat: o.timeFormat === '12h' ? '12h' : DEFAULT_TIMESTAMP_FORMAT.timeFormat,
+        dateFormat: resolveChoice('dateFormat', o.dateFormat, ['dd/mm/yyyy', 'mm/dd/yyyy'], DEFAULT_TIMESTAMP_FORMAT.dateFormat),
+        timeFormat: resolveChoice('timeFormat', o.timeFormat, ['24h', '12h'], DEFAULT_TIMESTAMP_FORMAT.timeFormat),
         now: o.now instanceof Date ? o.now : new Date(),
     };
 }
@@ -144,6 +196,59 @@ function safeHref(url) {
     }
 }
 
+// For URLs that end up as an image source or a file link inside a component, which
+// renders them unchecked: web URLs, inline images, and Discord's attachment://
+// references. Anything else — javascript:, other data: — becomes undefined.
+function safeImageSrc(url) {
+    if (typeof url !== 'string' || !url) return undefined;
+    const trimmed = url.trim();
+    if (/^data:image\//i.test(trimmed) || /^attachment:\/\//i.test(trimmed)) return url;
+    try {
+        const proto = new URL(trimmed, 'https://example.invalid').protocol.toLowerCase();
+        return proto === 'http:' || proto === 'https:' ? url : undefined;
+    } catch (_e) {
+        return undefined;
+    }
+}
+
+// For links a component renders without checking them: what safeHref allows, plus
+// the two Discord schemes such links legitimately carry — discord: (link buttons into
+// the client) and attachment:// (file components). Neither runs anything.
+function safeLinkHref(url) {
+    if (typeof url !== 'string' || !url) return undefined;
+    const trimmed = url.trim();
+    if (/^attachment:\/\//i.test(trimmed)) return url;
+    if (/^discord:/i.test(trimmed)) {
+        try {
+            new URL(trimmed);
+            return url;
+        } catch (_e) {
+            return '#';
+        }
+    }
+    return safeHref(url);
+}
+
+// Cuts `text` to at most `max` UTF-16 code units without cutting through a surrogate
+// pair. Half of a pair cannot be encoded: it ends up as U+FFFD in the page.
+function truncateText(text, max) {
+    if (typeof text !== 'string' || text.length <= max) return text;
+    let end = max;
+    const last = text.charCodeAt(end - 1);
+    if (last >= 0xd800 && last <= 0xdbff) end--; // a first half: leave it out with its second half
+    return text.slice(0, end);
+}
+
+// An error for a log line: its message and stack only. A whole error object can
+// carry what a caller's HTTP client attached to it, request headers included.
+function describeError(err) {
+    try {
+        return err instanceof Error ? (err.stack || err.message) : String(err);
+    } catch (_e) {
+        return 'an error that cannot be printed';
+    }
+}
+
 function safeColor(c, fallback = '#5865F2') {
     if (typeof c !== 'string') return fallback;
     return /^#[0-9a-fA-F]{3,8}$/.test(c) ? c : fallback;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-html-transcripts-fix",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "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",
@@ -31,7 +31,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@skyra/discord-components-core": "^4.0.2",
+    "@skyra/discord-components-core": "4.0.2",
     "debug": "^4.4.3",
     "discord-markdown-parser": "~1.3.0",
     "highlight.js": "^11.11.1",
@@ -39,7 +39,10 @@
     "react-dom": "^19.2.3",
     "simple-markdown": "^0.7.3",
     "twemoji": "^14.0.2",
-    "undici": "^7.29.0"
+    "undici": "^7.29.1"
+  },
+  "devDependencies": {
+    "discord.js": "14.27.0"
   },
   "peerDependencies": {
     "discord.js": "^14.0.0 || ^15.0.0",
@@ -54,6 +57,8 @@
     "node": ">=20"
   },
   "scripts": {
+    "test": "node --test",
+    "test:update": "node --test tests/golden.test.js",
     "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)"
   },
   "publishConfig": {