discord-message-transcript-base 1.3.2-dev.0.49 → 1.3.2-dev.1.50

package/dist/types/internal/parse.js

@@ -0,0 +1,7 @@
+export const ReturnTypeParse = {
+    Attachment: "attachment",
+    Buffer: "buffer",
+    Stream: "stream",
+    String: "string",
+    Uploadable: "uploadable"
+};

package/dist/types/internal/return.d.ts

@@ -0,0 +1,17 @@
+/**
+ * An enum-like object for the possible transcript formats.
+ */
+export declare const ReturnFormat: {
+    /**
+     * JSON format.
+     */
+    readonly JSON: "JSON";
+    /**
+     * HTML format.
+     */
+    readonly HTML: "HTML";
+};
+/**
+ * A type representing the possible values of `ReturnFormat`.
+ */
+export type ReturnFormat = typeof ReturnFormat[keyof typeof ReturnFormat];

package/dist/types/internal/return.js

@@ -0,0 +1,13 @@
+/**
+ * An enum-like object for the possible transcript formats.
+ */
+export const ReturnFormat = {
+    /**
+     * JSON format.
+     */
+    JSON: "JSON",
+    /**
+     * HTML format.
+     */
+    HTML: "HTML"
+};

package/dist/types/internal/transcript.d.ts

@@ -0,0 +1,91 @@
+import { ReturnFormat } from "./return.js";
+import { LocalDate, TimeZone } from "./util.js";
+import { ReturnType } from "../public/return.js";
+/**
+ * Base options for creating a transcript.
+ */
+export interface TranscriptOptionsBase {
+    /**
+     * The name of the generated file.
+     */
+    fileName: string;
+    /**
+     * Disable all warnings to keep console output clean.
+     * ⚠️ Can hide issues like unsafe URLs or fallback usage.
+     * @default false
+     */
+    disableWarnings: boolean;
+    /**
+     * Whether to include attachments.
+     */
+    includeAttachments: boolean;
+    /**
+     * Whether to include buttons.
+     */
+    includeButtons: boolean;
+    /**
+     * Whether to include other components (like select menus).
+     */
+    includeComponents: boolean;
+    /**
+     * Whether to include empty messages.
+     */
+    includeEmpty: boolean;
+    /**
+     * Whether to include embeds.
+     */
+    includeEmbeds: boolean;
+    /**
+     * Whether to include polls.
+     */
+    includePolls: boolean;
+    /**
+     * Whether to include reactions.
+     */
+    includeReactions: boolean;
+    /**
+     * Whether to include V2 components.
+     */
+    includeV2Components: boolean;
+    /**
+     * The locale for date formatting.
+     */
+    localDate: LocalDate;
+    /**
+     * The number of messages to include.
+     */
+    quantity: number;
+    /**
+     * The format of the transcript (HTML or JSON).
+     */
+    returnFormat: ReturnFormat;
+    /**
+     * The type of the returned value (buffer, string, etc.).
+     */
+    returnType: ReturnType;
+    /**
+     * Enables safe mode, blocking potentially unsafe URLs and content.
+     * Prevents suspicious links, images, or HTML from being included in the final transcript.
+     *
+     * ⚠️ Disabling may allow unsafe content to appear in the transcript.
+     * @default true
+     */
+    safeMode: boolean;
+    /**
+     * Whether to save images as base64.
+     * Only saves images with less than 25mb for safety - 25mb is a good security size to an image
+     */
+    saveImages: boolean;
+    /**
+     * Whether to generate a self-contained HTML file.
+     */
+    selfContained: boolean;
+    /**
+     * The timezone for date formatting.
+     */
+    timeZone: TimeZone;
+    /**
+     * Whether to include the watermark.
+     */
+    watermark: boolean;
+}

package/dist/types/internal/transcript.js

@@ -0,0 +1 @@
+export {};

package/dist/types/internal/util.d.ts

@@ -0,0 +1,51 @@
+import { JsonMessageMentionsChannels, JsonMessageMentionsRoles, JsonMessageMentionsUsers } from "./message/messageItens.js";
+/**
+ * A hexColor type
+ */
+export type hexColor = `#${string}`;
+/**
+ * A union of all possible timestamp styles for formatting dates and times in Discord.
+ */
+export type StyleTimeStampKey = "t" | "T" | "d" | "D" | "f" | "F";
+/**
+ * Represents a BCP 47 language tag for date/time formatting.
+ */
+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 & {});
+/**
+ * Represents an IANA time zone name for date/time formatting.
+ */
+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 & {});
+/**
+ * Structure containing arrays of all mentions found in the transcript.
+ */
+export interface ArrayMentions {
+    /**
+     * An array of mentioned channels.
+     */
+    channels: JsonMessageMentionsChannels[];
+    /**
+     * An array of mentioned roles.
+     */
+    roles: JsonMessageMentionsRoles[];
+    /**
+     * An array of mentioned users.
+     */
+    users: JsonMessageMentionsUsers[];
+}
+/**
+ * Represents an object that can be uploaded.
+ */
+export interface Uploadable {
+    /**
+     * The content to be uploaded.
+     */
+    content: string;
+    /**
+     * The MIME type of the content.
+     */
+    contentType: "application/json" | "text/html";
+    /**
+     * The name of the file.
+     */
+    fileName: string;
+}

package/dist/types/internal/util.js

@@ -0,0 +1 @@
+export {};

package/dist/types/public/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./return.js";
+export * from "./transcript.js";

package/dist/types/public/index.js

@@ -0,0 +1,2 @@
+export * from "./return.js";
+export * from "./transcript.js";

package/dist/types/public/return.d.ts

@@ -0,0 +1,25 @@
+/**
+ * An enum-like object for the possible return types, excluding 'attachment'.
+ */
+export declare const ReturnType: {
+    /**
+     * Returns a `Buffer`.
+     */
+    readonly Buffer: "buffer";
+    /**
+     * Returns a `Stream.Readable`.
+     */
+    readonly Stream: "stream";
+    /**
+     * Returns a `string`.
+     */
+    readonly String: "string";
+    /**
+     * Returns an `Uploadable` object.
+     */
+    readonly Uploadable: "uploadable";
+};
+/**
+ * A type representing the possible values of `ReturnTypeBase`.
+ */
+export type ReturnType = typeof ReturnType[keyof typeof ReturnType];

package/dist/types/public/return.js

@@ -0,0 +1,21 @@
+/**
+ * An enum-like object for the possible return types, excluding 'attachment'.
+ */
+export const ReturnType = {
+    /**
+     * Returns a `Buffer`.
+     */
+    Buffer: "buffer",
+    /**
+     * Returns a `Stream.Readable`.
+     */
+    Stream: "stream",
+    /**
+     * Returns a `string`.
+     */
+    String: "string",
+    /**
+     * Returns an `Uploadable` object.
+     */
+    Uploadable: "uploadable"
+};

package/dist/types/public/transcript.d.ts

@@ -0,0 +1,25 @@
+import { ReturnType } from "./return.js";
+/**
+ * Options for converting a JSON transcript to HTML.
+ */
+export type ConvertTranscriptOptions<T extends ReturnType> = Partial<{
+    /**
+     * The desired output type for the transcript.
+     * - 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;
+}>;

package/dist/types/public/transcript.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-message-transcript-base",
-  "version": "1.3.2-dev.0.49",
+  "version": "1.3.2-dev.1.50",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,6 +8,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./internal": {
+      "types": "./dist/internalIndex.d.ts",
+      "import": "./dist/internalIndex.js"
     }
   },
   "files": [
@@ -33,6 +37,6 @@
   },
   "scripts": {
     "clean": "rimraf dist",
-    "build": "pnpm run clean && node scripts/updateHashTranscript.js && tsc -b && node scripts/copy.js"
+    "build": "pnpm run clean && node scripts/updateHashTranscript.js && tsc && tsc-alias && node scripts/copy.js"
   }
 }