discord-message-transcript 1.0.0

package/dist/renderers/html/js.js

@@ -0,0 +1,174 @@
+export function script(options) {
+    return `
+document.addEventListener('DOMContentLoaded', () => {
+    const transcriptDataElement = document.getElementById('authorData');
+    if (!transcriptDataElement) {
+        console.error('Missing author data element.');
+        return;
+    }
+
+    const data = JSON.parse(transcriptDataElement.textContent);
+    const authorMap = new Map((data.authors || []).map(author => [author.id, author]));
+
+    document.querySelectorAll('.messageDiv[data-author-id]').forEach(messageDiv => {
+        const authorId = messageDiv.dataset.authorId;
+        const author = authorMap.get(authorId);
+
+        if (!author) return;
+
+        const avatarImg = messageDiv.querySelector('.messageImg');
+        if (avatarImg) avatarImg.src = author.avatarURL;
+
+        const username = messageDiv.querySelector('.messageUsername');
+        if (username) {
+            username.textContent = author.member?.displayName ?? author.displayName;
+            username.style.color = author.member?.displayHexColor ?? '#dbdee1';
+        }
+
+        const badgesDiv = messageDiv.querySelector('.badges');
+        if (badgesDiv) {
+            badgesDiv.innerHTML = '';
+            if (author.bot) {
+                const badge = document.createElement('p');
+                badge.className = 'badge';
+                badge.textContent = 'APP';
+                badgesDiv.appendChild(badge);
+            }
+            if (author.system) {
+                const badge = document.createElement('p');
+                badge.className = 'badge';
+                badge.textContent = 'SYSTEM';
+                badgesDiv.appendChild(badge);
+            }
+            if (author.guildTag) {
+                const badge = document.createElement('p');
+                badge.className = 'badgeTag';
+                badge.textContent = author.guildTag;
+                badgesDiv.appendChild(badge);
+            }
+        }
+    });
+
+    document.querySelectorAll('.messageReply[data-id]').forEach(replyDiv => {
+        const repliedToId = replyDiv.dataset.id;
+        if (!repliedToId) return;
+
+        const repliedToMessageDiv = document.getElementById(repliedToId);
+        if (!repliedToMessageDiv) return; 
+
+        const repliedToAuthorId = repliedToMessageDiv.dataset.authorId;
+        const repliedToAuthor = authorMap.get(repliedToAuthorId);
+
+        if (repliedToAuthor) {
+            const replyImg = replyDiv.querySelector('.messageReplyImg');
+            if (replyImg) replyImg.src = repliedToAuthor.avatarURL;
+            
+            const replyBadgesDiv = replyDiv.querySelector('.replyBadges');
+            if (replyBadgesDiv) {
+                replyBadgesDiv.innerHTML = '';
+                if (repliedToAuthor.bot) {
+                    const badge = document.createElement('p');
+                    badge.className = 'badge';
+                    badge.textContent = 'APP';
+                    replyBadgesDiv.appendChild(badge);
+                }
+                if (repliedToAuthor.system) {
+                    const badge = document.createElement('p');
+                    badge.className = 'badge';
+                    badge.textContent = 'SYSTEM';
+                    replyBadgesDiv.appendChild(badge);
+                }
+                if (repliedToAuthor.guildTag) {
+                    const badge = document.createElement('p');
+                    badge.className = 'badgeTag';
+                    badge.textContent = repliedToAuthor.guildTag;
+                    replyBadgesDiv.appendChild(badge);
+                }
+            }
+        }
+
+        const replyTextDiv = replyDiv.querySelector('.messageReplyText');
+        if (replyTextDiv) {
+            const originalContent = repliedToMessageDiv.querySelector('.messageContent');
+            if (originalContent) {
+                let content = originalContent.textContent || '';
+                if (content.length > 100) {
+                    content = content.substring(0, 100).trim() + '...';
+                }
+                
+                const authorName = repliedToAuthor?.member?.displayName ?? repliedToAuthor?.displayName ?? 'Unknown';
+                const authorColor = repliedToAuthor?.member?.displayHexColor ?? 'inherit';
+                
+                const authorNameSpan = \`<span style="color: \${authorColor};">\${authorName}</span>\`;
+                replyTextDiv.innerHTML = authorNameSpan + " " + content;
+            }
+        }
+    });
+
+    document.addEventListener('click', function (event) {
+        const spoiler = event.target.closest('.spoilerMsg, .spoilerAttachment');
+        if (spoiler && !spoiler.classList.contains('revealed')) {
+            event.preventDefault();
+            event.stopPropagation();
+            spoiler.classList.add('revealed');
+        }
+
+        const replyDiv = event.target.closest('.messageReply');
+        if (replyDiv) {
+            event.preventDefault();
+            const messageId = replyDiv.dataset.id;
+            if (!messageId) return;
+
+            const message = document.getElementById(messageId);
+            if (message) {
+                message.scrollIntoView({ behavior: 'smooth', block: 'center' });
+                message.classList.add('highlight');
+                setTimeout(() => {
+                    message.classList.remove('highlight');
+                }, 1500);
+            }
+        }
+
+        ${options.includeComponents ? SELECTOR_JS : ""}
+
+        ${options.includePolls ? POLL_JS : ""}
+    });
+    
+    if (window.hljs) {
+        hljs.highlightAll();
+    }
+});
+`;
+}
+export const POLL_JS = `
+const pollDiv = event.target.closest('.pollResultEmbedButton');
+if (pollDiv) {
+    event.preventDefault();
+    const messageId = pollDiv.dataset.id;
+    if (!messageId || messageId == "") return;
+    const message = document.getElementById(messageId);
+
+    if (message) {
+        message.scrollIntoView({ behavior: 'smooth', block: 'center' });
+        message.classList.add('highlight');
+        setTimeout(() => {
+            message.classList.remove('highlight');
+        }, 1500);
+    }
+}
+`;
+export const SELECTOR_JS = `
+const selectorInput = event.target.closest('.selectorInput');
+document.querySelectorAll('.selector').forEach(selector => {
+    if (!selector.contains(event.target)) {
+        selector.classList.remove('active');
+    }
+});
+
+if (selectorInput) {
+    const selector = selectorInput.closest('.selector');
+    if (selector) {
+        selector.classList.toggle('active');
+    }
+}
+`;

package/dist/renderers/json/json.d.ts

@@ -0,0 +1,16 @@
+import { Guild, TextBasedChannel } from "discord.js";
+import { ArrayMentions, JsonAuthor, JsonMessage, TranscriptOptionsBase, JsonData } from "discord-message-transcript-base";
+export declare class Json {
+    guild: Guild | null;
+    channel: TextBasedChannel;
+    authors: JsonAuthor[];
+    messages: JsonMessage[];
+    options: TranscriptOptionsBase;
+    mentions: ArrayMentions;
+    constructor(guild: Guild | null, channel: TextBasedChannel, options: TranscriptOptionsBase);
+    addMessages(messages: JsonMessage[]): void;
+    sliceMessages(size: number): void;
+    setAuthors(authors: JsonAuthor[]): void;
+    setMentions(mentions: ArrayMentions): void;
+    toJson(): Promise<JsonData>;
+}

package/dist/renderers/json/json.js

@@ -0,0 +1,55 @@
+import { BaseGuildTextChannel, DMChannel } from "discord.js";
+export class Json {
+    guild;
+    channel;
+    authors;
+    messages;
+    options;
+    mentions;
+    constructor(guild, channel, options) {
+        this.guild = guild;
+        this.channel = channel;
+        this.messages = [];
+        this.options = options;
+        this.authors = [];
+        this.mentions = { channels: [], roles: [], users: [] };
+    }
+    addMessages(messages) {
+        this.messages.push(...messages);
+    }
+    sliceMessages(size) {
+        if (size > this.messages.length || size == 0) {
+            return;
+        }
+        this.messages = this.messages.slice(0, size - 1);
+    }
+    setAuthors(authors) {
+        this.authors = authors;
+    }
+    setMentions(mentions) {
+        this.mentions = mentions;
+    }
+    async toJson() {
+        const channel = await this.channel.fetch();
+        const guild = !channel.isDMBased() ? this.guild : null;
+        const guildJson = !guild ? null : {
+            name: guild.name,
+            id: guild.id,
+            icon: guild.iconURL(),
+        };
+        return {
+            options: this.options,
+            guild: guildJson,
+            channel: {
+                name: channel instanceof DMChannel ? channel.recipient?.displayName ?? "DM" : channel.isDMBased() ? channel.name ?? channel.recipients.join(", ") : channel.name,
+                parent: channel.isDMBased() ? null : (channel.parent ? { name: channel.parent.name, id: channel.parent.id } : null),
+                topic: (channel instanceof BaseGuildTextChannel) ? channel.topic : null,
+                id: channel.id,
+                img: channel instanceof DMChannel ? channel.recipient?.displayAvatarURL() ?? "cdn.discordapp.com/embed/avatars/4.png" : channel.isDMBased() ? channel.iconURL() ?? (await channel.fetchOwner()).displayAvatarURL() : null,
+            },
+            authors: this.authors,
+            messages: this.messages.reverse(),
+            mentions: this.mentions
+        };
+    }
+}

package/dist/types/types copy.d.ts

@@ -0,0 +1,284 @@
+export type ReturnFormat = "HTML" | "JSON";
+export type ReturnType = "string" | "attachment" | "uploadable" | "stream" | "buffer";
+export type StyleTimeStampKey = "t" | "T" | "d" | "D" | "f" | "F";
+export interface CreateTranscriptOptions {
+    fileName?: string;
+    includeAttachments?: boolean;
+    includeButtons?: boolean;
+    includeComponents?: boolean;
+    includeEmpty?: boolean;
+    includeEmbeds?: boolean;
+    includePolls?: boolean;
+    includeReactions?: boolean;
+    includeV2Components?: boolean;
+    localDate?: Locale;
+    quantity?: number;
+    returnFormat?: ReturnFormat;
+    returnType?: ReturnType;
+    saveImages?: boolean;
+    timeZone?: TimeZone;
+}
+export interface TranscriptOptions {
+    fileName: string;
+    includeAttachments: boolean;
+    includeButtons: boolean;
+    includeComponents: boolean;
+    includeEmpty: boolean;
+    includeEmbeds: boolean;
+    includePolls: boolean;
+    includeReactions: boolean;
+    includeV2Components: boolean;
+    localDate: Locale;
+    quantity: number;
+    returnFormat: ReturnFormat;
+    returnType: ReturnType;
+    saveImages: boolean;
+    timeZone: TimeZone;
+}
+export interface Uploadable {
+    content: string;
+    contentType: "application/json" | "text/html";
+    fileName: string;
+}
+export interface JsonMessage {
+    attachments: JsonAttachment[];
+    authorId: string;
+    components: JsonTopLevelComponent[];
+    content: string;
+    createdTimestamp: number;
+    embeds: JsonEmbed[];
+    id: string;
+    mentions: JsonMessageMentions;
+    poll: JsonPoll | null;
+    reactions: JsonReaction[];
+    references: {
+        messageId: string | null;
+    } | null;
+    system: boolean;
+}
+export interface JsonReaction {
+    count: number;
+    emoji: string;
+}
+export interface JsonPoll {
+    answers: JsonPollAnswer[];
+    expiry: number | null;
+    isFinalized: boolean;
+    question: string;
+}
+export interface JsonPollAnswer {
+    count: number;
+    emoji: {
+        id: string | null;
+        name: string | null;
+        animated: boolean;
+    } | null;
+    id: number;
+    text: string;
+}
+export interface JsonAttachment {
+    contentType: string | null;
+    name: string;
+    size: number;
+    spoiler: boolean;
+    url: string;
+}
+export interface JsonEmbed {
+    author: {
+        name: string;
+        url: string | null;
+        iconURL: string | null;
+    } | null;
+    description: string | null;
+    fields: {
+        inline: boolean | null;
+        name: string;
+        value: string;
+    }[];
+    footer: {
+        iconURL: string | null;
+        text: string;
+    } | null;
+    hexColor: string | null;
+    image: {
+        url: string;
+    } | null;
+    thumbnail: {
+        url: string;
+    } | null;
+    timestamp: string | null;
+    title: string | null;
+    type: string;
+    url: string | null;
+}
+export interface JsonMessageMentions {
+    channels: {
+        id: string;
+        name: string | null;
+    }[];
+    everyone: boolean;
+    roles: {
+        id: string;
+        name: string;
+        color: string;
+    }[];
+    users: {
+        id: string;
+        name: string;
+        color: string | null;
+    }[];
+}
+export type JsonTopLevelComponent = JsonActionRow | JsonButtonComponent | JsonSelectMenu | JsonV2Component;
+export interface JsonActionRow {
+    components: (JsonButtonComponent | JsonSelectMenu)[];
+    type: JsonComponentType.ActionRow;
+}
+export interface JsonButtonComponent {
+    disabled: boolean;
+    emoji: {
+        id: string | null;
+        name: string | null;
+        animated: boolean;
+    } | null;
+    label: string | null;
+    style: JsonButtonStyle;
+    type: JsonComponentType.Button;
+    url: string | null;
+}
+export type JsonSelectMenu = JsonSelectMenuOthers | JsonSelectMenuString;
+interface JsonSelectMenuOthers {
+    disabled: boolean;
+    placeholder: string | null;
+    type: JsonComponentType.UserSelect | JsonComponentType.RoleSelect | JsonComponentType.MentionableSelect | JsonComponentType.ChannelSelect;
+}
+interface JsonSelectMenuString {
+    disabled: boolean;
+    options: JsonSelectOption[];
+    placeholder: string | null;
+    type: JsonComponentType.StringSelect;
+}
+export interface JsonSelectOption {
+    description: string | null;
+    emoji: {
+        id: string | null;
+        name: string | null;
+        animated: boolean;
+    } | null;
+    label: string;
+}
+export type JsonV2Component = JsonContainerComponent | JsonFileComponent | JsonMediaGalleryComponent | JsonSectionComponent | JsonSeparatorComponent | JsonTextDisplayComponent | JsonThumbnailComponent;
+export type JsonComponentInContainer = JsonActionRow | JsonFileComponent | JsonMediaGalleryComponent | JsonSectionComponent | JsonSeparatorComponent | JsonTextDisplayComponent;
+export interface JsonContainerComponent {
+    components: JsonComponentInContainer[];
+    hexAccentColor: string | null;
+    spoiler: boolean;
+    type: JsonComponentType.Container;
+}
+export interface JsonFileComponent {
+    fileName: string | null;
+    size: number;
+    spoiler: boolean;
+    type: JsonComponentType.File;
+    url: string;
+}
+export interface JsonMediaGalleryComponent {
+    items: {
+        media: {
+            url: string;
+        };
+        spoiler: boolean;
+    }[];
+    type: JsonComponentType.MediaGallery;
+}
+export interface JsonSectionComponent {
+    accessory: JsonButtonComponent | JsonThumbnailComponent;
+    components: JsonTextDisplayComponent[];
+    type: JsonComponentType.Section;
+}
+export interface JsonSeparatorComponent {
+    divider: boolean;
+    spacing: JsonSeparatorSpacingSize | null;
+    type: JsonComponentType.Separator;
+}
+export interface JsonTextDisplayComponent {
+    content: string;
+    type: JsonComponentType.TextDisplay;
+}
+export interface JsonThumbnailComponent {
+    media: {
+        url: string;
+    };
+    spoiler: boolean;
+    type: JsonComponentType.Thumbnail;
+}
+export interface JsonData {
+    authors: JsonAuthor[];
+    channel: JsonDataChannel;
+    guild: JsonDataGuild | null;
+    messages: JsonMessage[];
+    options: TranscriptOptions;
+}
+export interface JsonAuthor {
+    avatarURL: string;
+    bot: boolean;
+    displayName: string;
+    guildTag: string | null;
+    id: string;
+    member: {
+        displayHexColor: string;
+        displayName: string;
+    } | null;
+    system: boolean;
+}
+export interface JsonDataGuild {
+    icon: string | null;
+    id: string;
+    name: string;
+}
+export interface JsonDataChannel {
+    id: string;
+    img: string | null;
+    name: string;
+    parent: {
+        name: string;
+        id: string;
+    } | null;
+    topic: string | null;
+}
+export type Locale = CommonLocales | (string & {});
+export type TimeZone = CommonTimeZones | (string & {});
+type CommonLocales = 'ar-EG' | 'ar-SA' | 'bn-BD' | 'bn-IN' | 'cs-CZ' | 'da-DK' | 'de-AT' | 'de-CH' | 'de-DE' | 'el-GR' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IN' | 'en-US' | 'es-AR' | 'es-CO' | 'es-ES' | 'es-MX' | 'fa-IR' | 'fi-FI' | 'fr-BE' | 'fr-CA' | 'fr-FR' | 'he-IL' | 'hi-IN' | 'hu-HU' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'ms-MY' | 'nl-BE' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'sv-SE' | 'th-TH' | 'tr-TR' | 'uk-UA' | 'ur-PK' | 'vi-VN' | 'zh-CN' | 'zh-HK' | 'zh-TW';
+type CommonTimeZones = 'Africa/Cairo' | 'Africa/Johannesburg' | 'Africa/Lagos' | 'America/Argentina/Buenos_Aires' | 'America/Bogota' | 'America/Los_Angeles' | 'America/Mexico_City' | 'America/New_York' | 'America/Sao_Paulo' | 'America/Toronto' | 'America/Vancouver' | 'Asia/Bangkok' | 'Asia/Dhaka' | 'Asia/Dubai' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Istanbul' | 'Asia/Jakarta' | 'Asia/Jerusalem' | 'Asia/Karachi' | 'Asia/Kolkata' | 'Asia/Kuala_Lumpur' | 'Asia/Manila' | 'Asia/Riyadh' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Taipei' | 'Asia/Tehran' | 'Asia/Tokyo' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'Europe/Amsterdam' | 'Europe/Athens' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Budapest' | 'Europe/Copenhagen' | 'Europe/Helsinki' | 'Europe/Kyiv' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Madrid' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Rome' | 'Europe/Stockholm' | 'Europe/Warsaw' | 'Pacific/Auckland' | 'UTC';
+export declare enum JsonComponentType {
+    ActionRow = 1,
+    Button = 2,
+    StringSelect = 3,
+    TextInput = 4,
+    UserSelect = 5,
+    RoleSelect = 6,
+    MentionableSelect = 7,
+    ChannelSelect = 8,
+    Section = 9,
+    TextDisplay = 10,
+    Thumbnail = 11,
+    MediaGallery = 12,
+    File = 13,
+    Separator = 14,
+    ContentInventoryEntry = 16,
+    Container = 17,
+    Label = 18,
+    FileUpload = 19
+}
+export declare enum JsonSeparatorSpacingSize {
+    Small = 1,
+    Large = 2
+}
+export declare enum JsonButtonStyle {
+    Primary = 1,
+    Secondary = 2,
+    Success = 3,
+    Danger = 4,
+    Link = 5,
+    Premium = 6
+}
+export {};

package/dist/types/types copy.js

@@ -0,0 +1,35 @@
+export var JsonComponentType;
+(function (JsonComponentType) {
+    JsonComponentType[JsonComponentType["ActionRow"] = 1] = "ActionRow";
+    JsonComponentType[JsonComponentType["Button"] = 2] = "Button";
+    JsonComponentType[JsonComponentType["StringSelect"] = 3] = "StringSelect";
+    JsonComponentType[JsonComponentType["TextInput"] = 4] = "TextInput";
+    JsonComponentType[JsonComponentType["UserSelect"] = 5] = "UserSelect";
+    JsonComponentType[JsonComponentType["RoleSelect"] = 6] = "RoleSelect";
+    JsonComponentType[JsonComponentType["MentionableSelect"] = 7] = "MentionableSelect";
+    JsonComponentType[JsonComponentType["ChannelSelect"] = 8] = "ChannelSelect";
+    JsonComponentType[JsonComponentType["Section"] = 9] = "Section";
+    JsonComponentType[JsonComponentType["TextDisplay"] = 10] = "TextDisplay";
+    JsonComponentType[JsonComponentType["Thumbnail"] = 11] = "Thumbnail";
+    JsonComponentType[JsonComponentType["MediaGallery"] = 12] = "MediaGallery";
+    JsonComponentType[JsonComponentType["File"] = 13] = "File";
+    JsonComponentType[JsonComponentType["Separator"] = 14] = "Separator";
+    JsonComponentType[JsonComponentType["ContentInventoryEntry"] = 16] = "ContentInventoryEntry";
+    JsonComponentType[JsonComponentType["Container"] = 17] = "Container";
+    JsonComponentType[JsonComponentType["Label"] = 18] = "Label";
+    JsonComponentType[JsonComponentType["FileUpload"] = 19] = "FileUpload";
+})(JsonComponentType || (JsonComponentType = {}));
+export var JsonSeparatorSpacingSize;
+(function (JsonSeparatorSpacingSize) {
+    JsonSeparatorSpacingSize[JsonSeparatorSpacingSize["Small"] = 1] = "Small";
+    JsonSeparatorSpacingSize[JsonSeparatorSpacingSize["Large"] = 2] = "Large";
+})(JsonSeparatorSpacingSize || (JsonSeparatorSpacingSize = {}));
+export var JsonButtonStyle;
+(function (JsonButtonStyle) {
+    JsonButtonStyle[JsonButtonStyle["Primary"] = 1] = "Primary";
+    JsonButtonStyle[JsonButtonStyle["Secondary"] = 2] = "Secondary";
+    JsonButtonStyle[JsonButtonStyle["Success"] = 3] = "Success";
+    JsonButtonStyle[JsonButtonStyle["Danger"] = 4] = "Danger";
+    JsonButtonStyle[JsonButtonStyle["Link"] = 5] = "Link";
+    JsonButtonStyle[JsonButtonStyle["Premium"] = 6] = "Premium";
+})(JsonButtonStyle || (JsonButtonStyle = {}));