discord-message-transcript-base 1.0.0

package/dist/types/types.d.ts

@@ -0,0 +1,341 @@
+import Stream from "stream";
+export type JsonComponentInContainer = JsonActionRow | JsonFileComponent | JsonMediaGalleryComponent | JsonSectionComponent | JsonSeparatorComponent | JsonTextDisplayComponent;
+export type JsonSelectMenu = JsonSelectMenuOthers | JsonSelectMenuString;
+export type JsonTopLevelComponent = JsonActionRow | JsonButtonComponent | JsonSelectMenu | JsonV2Component;
+export type JsonV2Component = JsonContainerComponent | JsonFileComponent | JsonMediaGalleryComponent | JsonSectionComponent | JsonSeparatorComponent | JsonTextDisplayComponent | JsonThumbnailComponent;
+export type StyleTimeStampKey = "t" | "T" | "d" | "D" | "f" | "F";
+export type LocalDate = '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' | (string & {});
+export type TimeZone = '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' | (string & {});
+export type OutputTypeBase<T extends ReturnTypeBase> = T extends typeof ReturnTypeBase.Buffer ? Buffer : T extends typeof ReturnTypeBase.Stream ? Stream : T extends typeof ReturnTypeBase.Uploadable ? Uploadable : string;
+export declare const ReturnTypeBase: {
+    readonly Buffer: "buffer";
+    readonly Stream: "stream";
+    readonly String: "string";
+    readonly Uploadable: "uploadable";
+};
+export type ReturnTypeBase = typeof ReturnTypeBase[keyof typeof ReturnTypeBase];
+export declare enum ReturnTypeParse {
+    Attachment = "attachment",
+    Buffer = "buffer",
+    Stream = "stream",
+    String = "string",
+    Uploadable = "uploadable"
+}
+export declare const ReturnFormat: {
+    readonly JSON: "JSON";
+    readonly HTML: "HTML";
+};
+export type ReturnFormat = typeof ReturnFormat[keyof typeof ReturnFormat];
+export interface TranscriptOptionsBase {
+    fileName: string;
+    includeAttachments: boolean;
+    includeButtons: boolean;
+    includeComponents: boolean;
+    includeEmpty: boolean;
+    includeEmbeds: boolean;
+    includePolls: boolean;
+    includeReactions: boolean;
+    includeV2Components: boolean;
+    localDate: LocalDate;
+    quantity: number;
+    returnFormat: ReturnFormat;
+    returnType: ReturnTypeBase;
+    saveImages: boolean;
+    selfContained: boolean;
+    timeZone: TimeZone;
+    watermark: boolean;
+}
+export interface TranscriptOptionsParse {
+    fileName: string;
+    includeAttachments: boolean;
+    includeButtons: boolean;
+    includeComponents: boolean;
+    includeEmpty: boolean;
+    includeEmbeds: boolean;
+    includePolls: boolean;
+    includeReactions: boolean;
+    includeV2Components: boolean;
+    localDate: LocalDate;
+    quantity: number;
+    returnFormat: ReturnFormat;
+    returnType: ReturnTypeParse;
+    saveImages: boolean;
+    selfContained: boolean;
+    timeZone: TimeZone;
+    watermark: boolean;
+}
+/**
+ * Options for converting a JSON transcript to HTML.
+ */
+export type ConvertTranscriptOptions<T extends ReturnTypeBase> = Partial<{
+    /**
+     * The type of the returned value.
+     * - ReturnType.String - The transcript content as a string.
+     * - ReturnType.Buffer - The transcript content as a `Buffer`.
+     * - ReturnType.Stream - The transcript content as a `Stream`.
+     * - ReturnType.Uploadable` - An object with `content`, `contentType` and `fileName`.
+     * @default ReturnType.String
+     */
+    returnType: T;
+    /**
+     * Whether the generated HTML should be self-contained (CSS and JS in HTML).
+     * @default false
+     */
+    selfContained: boolean;
+    /**
+     * If you want to include the watermark.
+     * @default true
+     */
+    watermark: boolean;
+}>;
+export interface ArrayMentions {
+    channels: JsonMessageMentionsChannels[];
+    roles: JsonMessageMentionsRoles[];
+    users: JsonMessageMentionsUsers[];
+}
+export interface JsonActionRow {
+    components: (JsonButtonComponent | JsonSelectMenu)[];
+    type: JsonComponentType.ActionRow;
+}
+export interface JsonAttachment {
+    contentType: string | null;
+    name: string;
+    size: number;
+    spoiler: boolean;
+    url: string;
+}
+export interface JsonAuthor {
+    avatarURL: string;
+    bot: boolean;
+    displayName: string;
+    guildTag: string | null;
+    id: string;
+    member: {
+        displayHexColor: string;
+        displayName: string;
+    } | null;
+    system: boolean;
+}
+export interface JsonButtonComponent {
+    disabled: boolean;
+    emoji: string | null;
+    label: string | null;
+    style: JsonButtonStyle;
+    type: JsonComponentType.Button;
+    url: string | null;
+}
+export interface JsonContainerComponent {
+    components: JsonComponentInContainer[];
+    hexAccentColor: string | null;
+    spoiler: boolean;
+    type: JsonComponentType.Container;
+}
+export interface JsonData {
+    authors: JsonAuthor[];
+    channel: JsonDataChannel;
+    guild: JsonDataGuild | null;
+    messages: JsonMessage[];
+    options: TranscriptOptionsBase;
+    mentions: ArrayMentions;
+}
+export interface JsonDataParse {
+    authors: JsonAuthor[];
+    channel: JsonDataChannel;
+    guild: JsonDataGuild | null;
+    messages: JsonMessage[];
+    options: TranscriptOptionsParse;
+    mentions: ArrayMentions;
+}
+export interface JsonDataChannel {
+    id: string;
+    img: string | null;
+    name: string;
+    parent: {
+        name: string;
+        id: string;
+    } | null;
+    topic: string | null;
+}
+export interface JsonDataGuild {
+    icon: string | null;
+    id: string;
+    name: 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 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 JsonMessage {
+    attachments: JsonAttachment[];
+    authorId: string;
+    components: JsonTopLevelComponent[];
+    content: string;
+    createdTimestamp: number;
+    embeds: JsonEmbed[];
+    id: string;
+    mentions: boolean;
+    poll: JsonPoll | null;
+    reactions: JsonReaction[];
+    references: {
+        messageId: string | null;
+    } | null;
+    system: boolean;
+}
+export interface JsonMessageMentions {
+    channels: JsonMessageMentionsChannels[];
+    roles: JsonMessageMentionsRoles[];
+    users: JsonMessageMentionsUsers[];
+}
+export interface JsonMessageMentionsChannels {
+    id: string;
+    name: string | null;
+}
+export interface JsonMessageMentionsRoles {
+    id: string;
+    name: string;
+    color: string;
+}
+export interface JsonMessageMentionsUsers {
+    id: string;
+    name: string;
+    color: string | null;
+}
+export interface JsonPoll {
+    answers: JsonPollAnswer[];
+    expiry: string | 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 JsonReaction {
+    count: number;
+    emoji: string;
+}
+export interface JsonSectionComponent {
+    accessory: JsonButtonComponent | JsonThumbnailComponent;
+    components: JsonTextDisplayComponent[];
+    type: JsonComponentType.Section;
+}
+export interface JsonSelectOption {
+    description: string | null;
+    emoji: {
+        id: string | null;
+        name: string | null;
+        animated: boolean;
+    } | null;
+    label: string;
+}
+export interface JsonSeparatorComponent {
+    divider: boolean;
+    spacing: JsonSeparatorSpacingSize;
+    type: JsonComponentType.Separator;
+}
+export interface JsonTextDisplayComponent {
+    content: string;
+    type: JsonComponentType.TextDisplay;
+}
+export interface JsonThumbnailComponent {
+    media: {
+        url: string;
+    };
+    spoiler: boolean;
+    type: JsonComponentType.Thumbnail;
+}
+export interface Uploadable {
+    content: string;
+    contentType: "application/json" | "text/html";
+    fileName: string;
+}
+export declare enum JsonButtonStyle {
+    Primary = 1,
+    Secondary = 2,
+    Success = 3,
+    Danger = 4,
+    Link = 5,
+    Premium = 6
+}
+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
+}
+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 {};

package/dist/types/types.js

@@ -0,0 +1,54 @@
+export const ReturnTypeBase = {
+    Buffer: "buffer",
+    Stream: "stream",
+    String: "string",
+    Uploadable: "uploadable"
+};
+export var ReturnTypeParse;
+(function (ReturnTypeParse) {
+    ReturnTypeParse["Attachment"] = "attachment";
+    ReturnTypeParse["Buffer"] = "buffer";
+    ReturnTypeParse["Stream"] = "stream";
+    ReturnTypeParse["String"] = "string";
+    ReturnTypeParse["Uploadable"] = "uploadable";
+})(ReturnTypeParse || (ReturnTypeParse = {}));
+;
+export const ReturnFormat = {
+    JSON: "JSON",
+    HTML: "HTML"
+};
+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 = {}));
+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 = {}));

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "discord-message-transcript-base",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./*": {
+      "import": "./dist/*.js",
+      "require": "./dist/*.js",
+      "types": "./dist/*.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc && node scripts/copy.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HenriqueMairesse/discord-message-transcript.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/HenriqueMairesse/discord-message-transcript/issues"
+  },
+  "homepage": "https://github.com/HenriqueMairesse/discord-message-transcript#readme",
+  "devDependencies": {
+    "@types/node": "^25.0.6",
+    "typescript": "^5.9.3"
+  }
+}