transcriptify 1.0.0

package/dist/src/web/types/message.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/web/types/poll.d.ts

@@ -0,0 +1,11 @@
+export interface Poll {
+    question?: string;
+    options?: PollOption[];
+    totalVotes?: number;
+    closed?: boolean;
+    endsAt?: string;
+}
+export interface PollOption {
+    label: string;
+    count?: number;
+}

package/dist/src/web/types/poll.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/web/types/props.d.ts

@@ -0,0 +1,155 @@
+import type React from "react";
+import type { TranscriptThemes } from "./theme";
+import type { MessageProps, ResolvedUsers, ResolvedRoles } from "./message";
+import type { Author } from "./author";
+import type { Reaction } from "./reaction";
+import type { Poll } from "./poll";
+import type { Attachment } from "./attachment";
+import type { Interaction } from "./interaction";
+import type { ChannelInfo } from "./channel";
+export interface TranscriptProps {
+    channel?: ChannelInfo;
+    messages?: unknown[];
+    className?: string;
+    theme?: TranscriptThemes;
+    allowThemeSwitching?: boolean;
+    allowThemeSwitchingPersist?: boolean;
+    poweredBy?: boolean | string;
+    resolvedUsers?: Record<string, unknown>;
+    resolvedRoles?: Record<string, unknown>;
+    resolvedChannels?: Record<string, {
+        name?: string | null;
+        guildId?: string | null;
+    }>;
+    exportedAt?: string;
+}
+export interface ThemeSwitcherProps {
+    currentTheme: TranscriptThemes;
+    onThemeChange: (theme: TranscriptThemes) => void;
+}
+export interface ReplyProps {
+    replyTo: any;
+    onReplyClick: (ev: React.MouseEvent) => void;
+    defaultAvatar: string;
+    resolvedUsers?: Record<string, unknown>;
+    resolvedRoles?: Record<string, unknown>;
+    resolvedChannels?: Record<string, {
+        name?: string | null;
+        guildId?: string | null;
+    }>;
+}
+export interface ForwardedMessageProps {
+    message: Partial<MessageProps>;
+    brokenImages: Set<string>;
+    onImageError: (url: string) => void;
+    renderContent: (content: unknown) => React.ReactNode;
+    defaultAvatar: string;
+}
+export interface PollEndMessageProps {
+    id: string;
+    author: Author;
+    embeds: unknown[];
+    replyTo?: unknown;
+    timeAgoDisplay: string;
+}
+export interface MessageStickersProps {
+    stickers: {
+        url: string;
+        name?: string;
+    }[];
+}
+export interface MessageSelectsProps {
+    selects: unknown[];
+}
+export interface MessageReactionsProps {
+    reactions: Reaction[];
+}
+export interface MessagePollProps {
+    poll: Poll;
+}
+export interface MessageHeaderProps {
+    author: Author;
+    timestamp?: string;
+    editedAt?: string | null;
+    relativeTimestamp: string;
+    tagDate: string;
+    pinned?: boolean;
+}
+export interface MessageEmbedsProps {
+    embeds: unknown[];
+    resolvedUsers?: ResolvedUsers;
+    resolvedRoles?: ResolvedRoles;
+    resolvedChannels?: Record<string, {
+        name?: string | null;
+        guildId?: string | null;
+    }>;
+    channelGuildId?: string | null;
+    interaction?: Interaction;
+}
+export interface MessageContentProps {
+    content: React.ReactNode;
+}
+export interface MessageButtonsProps {
+    buttons: unknown[];
+}
+export interface MessageAvatarProps {
+    avatar: string;
+    bot?: boolean;
+    hasReply?: boolean;
+    hasInteraction?: boolean;
+}
+export interface MessageAttachmentsProps {
+    attachments: Attachment[];
+    brokenImages: Set<string>;
+    onImageError: (url: string) => void;
+}
+export interface CompactMessageContentProps {
+    timestamp?: string;
+    hover: boolean;
+    content: React.ReactNode;
+}
+export interface CommandLineProps {
+    interaction: Interaction;
+    resolvedUsers?: ResolvedUsers;
+    defaultAvatar: string;
+}
+export interface PollEndContent {
+    question?: string;
+    options?: Array<{
+        label?: string;
+        count?: number;
+    }>;
+}
+export interface UseMessageContentParams {
+    content: any;
+    attachments?: Attachment[];
+    embeds?: unknown[];
+    emojiUrls?: Record<string, string>;
+    resolvedUsers?: ResolvedUsers;
+    resolvedRoles?: ResolvedRoles;
+    resolvedChannels?: Record<string, {
+        name?: string | null;
+        guildId?: string | null;
+    }>;
+    channelGuildId?: string | null;
+}
+export interface TranscriptSSRProps {
+    channel: ChannelInfo;
+    messages: any[];
+    theme: TranscriptThemes;
+    allowThemeSwitching: boolean;
+    allowThemeSwitchingPersist: boolean;
+    poweredBy: boolean | string;
+    className?: string;
+    resolvedUsers?: Record<string, unknown>;
+    resolvedRoles?: Record<string, unknown>;
+    resolvedChannels?: Record<string, {
+        name?: string | null;
+        guildId?: string | null;
+    }>;
+    exportedAt?: string;
+}
+export interface TranscriptCdnConfig {
+    cdnBase?: string;
+    mediaBase?: string;
+}

package/dist/src/web/types/props.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/web/types/reaction.d.ts

@@ -0,0 +1,6 @@
+export interface Reaction {
+    emoji: string;
+    emojiUrl?: string;
+    count?: number;
+    me?: boolean;
+}

package/dist/src/web/types/reaction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/web/types/theme.d.ts

@@ -0,0 +1,14 @@
+export type TranscriptThemes = "light" | "ash" | "dark" | "onyx" | "system" | "mint_apple" | "citrus_sherbert" | "retro_raincloud" | "hanami" | "sunrise" | "cotton_candy" | "lofi_vibes" | "desert_khaki" | "sunset" | "chroma_glow" | "forest" | "crimson_moon" | "midnight_blurple" | "mars" | "dusk" | "under_the_sea" | "retro_storm" | "neon_nights" | "strawberry_lemonade" | "aurora" | "sepia" | "blurple_twilight";
+export interface ThemeColors {
+    bg: string;
+    text: string;
+    header: string;
+    border: string;
+    subtext: string;
+    accent: string;
+}
+export interface ThemePreview {
+    primary: string;
+    secondary?: string;
+    gradient?: boolean;
+}

package/dist/src/web/types/theme.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/web/types/ui.d.ts

@@ -0,0 +1,10 @@
+import type React from "react";
+export type ButtonVariant = "primary" | "secondary" | "success" | "danger" | "link";
+export interface ButtonProps {
+    label: string;
+    url?: string;
+    variant?: ButtonVariant;
+    disabled?: boolean;
+    emoji?: string;
+    onClick?: React.MouseEventHandler<HTMLButtonElement>;
+}

package/dist/src/web/types/ui.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/download.d.ts

@@ -0,0 +1,12 @@
+import type { APIAttachment, APIMessage, Awaitable } from "discord.js";
+import type { WebpOptions } from "sharp";
+export type ResolveImageCallback = (attachment: APIAttachment, message: APIMessage) => Awaitable<string | null | undefined>;
+export type ImageCompression = {
+    quality: number;
+    convertToWebP?: boolean;
+    options?: Omit<WebpOptions, "quality" | "force">;
+};
+export type DownloaderOptions = {
+    maxFileSizeKB?: number;
+    compression?: ImageCompression;
+};

package/dist/types/download.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/exportableTranscript.d.ts

@@ -0,0 +1,169 @@
+export type SerializableAuthor = {
+    id: string;
+    username: string;
+    tag?: string;
+    guildTag?: {
+        name?: string | null;
+        iconUrl?: string | null;
+    } | null;
+    nickname?: string | null;
+    avatar?: string | null;
+    bot?: boolean;
+    color?: string | null;
+    verified?: boolean | null;
+};
+export type SerializableAttachment = {
+    id: string;
+    filename: string;
+    url: string;
+    proxyURL?: string | null;
+    contentType?: string | null;
+    size?: number;
+    width?: number | null;
+    height?: number | null;
+};
+export type SerializableEmbedField = {
+    name: string;
+    value: string;
+    inline?: boolean;
+};
+export type SerializableEmbed = {
+    title?: string | null;
+    description?: string | null;
+    url?: string | null;
+    timestamp?: string | null;
+    color?: string | null;
+    footer?: {
+        text?: string | null;
+        iconUrl?: string | null;
+    } | null;
+    image?: {
+        url?: string | null;
+    } | null;
+    thumbnail?: {
+        url?: string | null;
+    } | null;
+    author?: {
+        name?: string | null;
+        url?: string | null;
+        iconUrl?: string | null;
+    } | null;
+    fields?: SerializableEmbedField[];
+};
+export type SerializableButton = {
+    type?: number;
+    customId?: string | null;
+    label?: string | null;
+    style?: number | null;
+    emoji?: {
+        id?: string | null;
+        name?: string | null;
+    } | null;
+    url?: string | null;
+    disabled?: boolean | null;
+};
+export type SerializableSelect = {
+    customId?: string | null;
+    placeholder?: string | null;
+    minValues?: number | null;
+    maxValues?: number | null;
+    options?: {
+        label: string;
+        value: string;
+        description?: string | null;
+        default?: boolean;
+    }[];
+};
+export type SerializableComponent = {
+    type: number;
+    components?: (SerializableButton | SerializableSelect | any)[];
+};
+export type SerializableSticker = {
+    id: string;
+    name?: string | null;
+    tags?: string | null;
+    format?: string | null;
+};
+export type SerializableReaction = {
+    emoji: {
+        id?: string | null;
+        name?: string | null;
+        animated?: boolean | null;
+    };
+    count: number;
+    me?: boolean | null;
+};
+export type SerializablePollOption = {
+    id?: string | null;
+    label?: string | null;
+    count?: number | null;
+    voters?: string[] | null;
+};
+export type SerializablePoll = {
+    type: "reactions" | "buttons" | "selects" | "embed" | "native";
+    question?: string | null;
+    options: SerializablePollOption[];
+    totalVotes?: number | null;
+    endsAt?: string | null;
+};
+export type SerializableInteraction = {
+    id?: string | null;
+    type?: number | null;
+    name?: string | null;
+    user?: {
+        id: string;
+        username: string;
+    } | null;
+};
+export type SerializableMessage = {
+    id: string;
+    content: string;
+    author: string | null;
+    createdAt: string;
+    messageType?: string | number;
+    embeds?: SerializableEmbed[];
+    actionRows?: SerializableComponent[];
+    buttons?: SerializableButton[];
+    selects?: SerializableSelect[];
+    stickers?: SerializableSticker[];
+    reactions?: SerializableReaction[];
+    editedAt?: string | null;
+    attachments: SerializableAttachment[];
+    pinned: boolean;
+    interaction?: SerializableInteraction | null;
+    referencedMessageId?: string | null;
+    poll?: SerializablePoll | null;
+    forwarded?: {
+        fromMessageId?: string | null;
+        fromChannelId?: string | null;
+        fromGuildId?: string | null;
+        original?: {
+            id?: string;
+            content?: string;
+            author?: string | null;
+            createdAt?: string | null;
+            embeds?: SerializableEmbed[];
+            attachments?: SerializableAttachment[];
+            stickers?: SerializableSticker[];
+        } | null;
+    } | null;
+};
+export type ExportableTranscript = {
+    meta: {
+        channelId: string;
+        channelName?: string | null;
+        guildId?: string | null;
+        generatedAt: string;
+        messageCount: number;
+    };
+    messages: SerializableMessage[];
+    resolvedUsers?: Record<string, Omit<SerializableAuthor, "id">>;
+    resolvedRoles?: Record<string, {
+        name: string;
+        color: string | null;
+    }>;
+    resolvedChannels?: Record<string, {
+        name?: string | null;
+        guildId?: string | null;
+    }>;
+};

package/dist/types/exportableTranscript.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/general.d.ts

@@ -0,0 +1,90 @@
+export type TranscriptThemes = "light" | "ash" | "dark" | "onyx" | "system" | "mint_apple" | "citrus_sherbert" | "retro_raincloud" | "hanami" | "sunrise" | "cotton_candy" | "lofi_vibes" | "desert_khaki" | "sunset" | "chroma_glow" | "forest" | "crimson" | "midnight_blurple" | "mars" | "dusk" | "under_the_sea" | "retro_storm" | "neon_nights" | "strawberry_lemonade" | "aurora" | "sepia";
+export type TranscriptCreateOptions = {
+    /**
+     * @description The maximum number of messages to include in the transcript. Set to undefined to include all messages.
+     * @default undefined
+     */
+    limit?: number;
+    /**
+     * @description Download all attachments and store locally in an assets directory (default "assets").
+     * @default false
+     */
+    saveAssets?: boolean | {
+        /**
+         * @description Optional image compression level (1-100). Requires external image processing library.
+         * Vanilla Node.js does not support image compression/conversion.
+         * @default undefined (no compression)
+         */
+        compression?: number;
+        /**
+         * @description Optional assets output directory.
+         * @default "assets"
+         */
+        dir?: string;
+    };
+    /**
+     * @description The Filename of the generated transcript
+     * @default "transcript-{channelID}-{timestamp}.html"
+     */
+    filename?: string;
+    /**
+     * @description The 'PoweredBy dcTranscriptify' text at the bottom of the transcript
+     * @default true
+     */
+    poweredBy?: boolean;
+    /**
+     * @description Allow users to switch the theme of the transcript
+     * @default true
+     */
+    allowThemeSwitching?: boolean;
+    /**
+     * @description Default theme of the transcript
+     * @default dark/light based on system preference
+     */
+    theme?: TranscriptThemes;
+    /**
+     * @description Ignore options for the transcript generation
+     */
+    ignore?: {
+        /**
+         * @description Ignore messages from bot accounts when generating the transcript
+         * @default false
+         */
+        bots?: boolean;
+        /**
+         * @description Array of user IDs to ignore when generating the transcript. Only strings are allowed.
+         * @default []
+         */
+        userIDs?: string[];
+        /**
+         * @description Attachment ignore options
+         */
+        attachments?: {
+            /**
+             * @description Ignore image attachments (png, jpg, gif, etc.)
+             * @default false
+             */
+            images?: boolean;
+            /**
+             * @description Ignore video attachments (mp4, mov, etc.)
+             * @default false
+             */
+            videos?: boolean;
+            /**
+             * @description Ignore audio attachments (mp3, wav, etc.)
+             * @default false
+             */
+            audio?: boolean;
+            /**
+             * @description Ignore other file attachments (pdf, zip, etc.)
+             * @default false
+             */
+            files?: boolean;
+        };
+        /**
+         * @description Ignore guild badges
+         * @default false
+         */
+        guildBadges?: boolean;
+    };
+};

package/dist/types/general.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "transcriptify",
+	"version": "1.0.0",
+	"description": "Generate beautiful, secure HTML transcripts from Discord channels.",
+	"main": "dist/index.cjs",
+	"types": "dist/index.d.ts",
+	"private": false,
+	"files": ["dist"],
+	"scripts": {
+		"build": "tsc --outDir dist --declaration --module commonjs",
+		"prepare": "npm run build",
+		"format": "npx @biomejs/biome format --write"
+	},
+	"dependencies": {
+		"discord.js": "^14.25.1",
+		"dotenv": "^17.2.3",
+		"react": "^18.3.1",
+		"react-dom": "^18.3.1",
+		"sharp": "^0.34.5"
+	},
+	"devDependencies": {
+		"@types/node": "^20.0.0",
+		"@types/react": "^18.2.21",
+		"@types/react-dom": "^18.2.7",
+		"@vitejs/plugin-react": "^4.0.0",
+		"autoprefixer": "^10.4.23",
+		"esbuild": "^0.27.2",
+		"highlight.js": "^11.11.1",
+		"postcss": "^8.5.6",
+		"tailwindcss": "^3.4.19",
+		"typescript": "^5.0.0",
+		"vite": "^5.0.0"
+	},
+	"keywords": ["discord.js", "discord.js-transcripts", "html-transcripts", "ticket-transcripts"],
+	"author": "the_unknown_dud3 & anditv21",
+	"license": "MIT",
+	"type": "commonjs",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/dev-hoehle/transcriptify.git"
+	},
+	"bugs": {
+		"url": "https://github.com/dev-hoehle/transcriptify/issues"
+	},
+	"homepage": "https://github.com/dev-hoehle/transcriptify#readme"
+}