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

package/dist/core/assetResolver/base64/imageToBase64.d.ts

@@ -1,2 +1,2 @@
-import { safeUrlReturn } from '@/types';
+import { safeUrlReturn } from '../../../types/private/network.js';
 export declare function imageToBase64(safeUrlObject: safeUrlReturn, disableWarnings: boolean): Promise<string>;

package/dist/core/assetResolver/base64/imageToBase64.js

@@ -1,8 +1,8 @@
-import { CustomWarn } from 'discord-message-transcript-base';
+import { CustomWarn } from 'discord-message-transcript-base/internal';
 import { getBase64Limiter } from '../limiter.js';
 import https from 'https';
 import http from 'http';
-import { createLookup } from '@/networkSecurity';
+import { createLookup } from '../../networkSecurity/index.js';
 import { USER_AGENT } from '../contants.js';
 const MAX_BYTES = 25 * 1024 * 1024; // 25MB
 export async function imageToBase64(safeUrlObject, disableWarnings) {

package/dist/core/assetResolver/cdn/cdnCustomError.js

@@ -1,4 +1,4 @@
-import { CustomWarn } from "discord-message-transcript-base";
+import { CustomWarn } from "discord-message-transcript-base/internal";
 export class CDNProviderError extends Error {
     provider;
     code;

package/dist/core/assetResolver/cdn/cdnResolver.d.ts

@@ -1,3 +1,4 @@
-import { CDNOptions, safeUrlReturn } from "@/types/types.js";
-import { TranscriptOptionsBase } from "discord-message-transcript-base";
+import { TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { safeUrlReturn } from "../../../types/private/network.js";
+import { CDNOptions } from "../../../types/private/cdn.js";
 export declare function cdnResolver(safeUrlObject: safeUrlReturn, options: TranscriptOptionsBase, cdnOptions: CDNOptions): Promise<string>;

package/dist/core/assetResolver/cdn/cdnResolver.js

@@ -1,6 +1,6 @@
-import { CustomWarn } from "discord-message-transcript-base";
+import { CustomWarn } from "discord-message-transcript-base/internal";
 import { getCDNLimiter } from "../limiter.js";
-import { createLookup } from "@/networkSecurity";
+import { createLookup } from "../../networkSecurity/index.js";
 import https from 'https';
 import http from 'http';
 import { uploadCareCdnResolver } from "./uploadCareCdnResolver.js";

package/dist/core/assetResolver/cdn/uploadCareCdnResolver.js

@@ -1,4 +1,4 @@
-import { sleep } from "@/utils/sleep.js";
+import { sleep } from "../../../utils/sleep.js";
 import { CDNProviderError, warnCdnError } from "./cdnCustomError.js";
 import { USER_AGENT } from "../contants.js";
 // https://uploadcare.com/api-refs/upload-api/#tag/Upload/operation/fromURLUpload

package/dist/core/assetResolver/cdn/validateCdnUrl.js

@@ -1,4 +1,4 @@
-import { CustomWarn } from "discord-message-transcript-base";
+import { CustomWarn } from "discord-message-transcript-base/internal";
 export function validateCdnUrl(url, disableWarnings) {
     if (url.includes('"') || url.includes('<') || url.includes('>')) {
         CustomWarn(`Unsafe URL received from CDN, using fallback.\nURL: ${url}`, disableWarnings);

package/dist/core/assetResolver/index.d.ts

@@ -1,6 +1,7 @@
-import { Json } from "@/renderers/json/json.js";
-import { CDNOptions, Maps } from "@/types/types.js";
-import { TranscriptOptionsBase } from "discord-message-transcript-base";
+import { Json } from "../../renderers/json/json.js";
+import { TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { Maps } from "../../types/private/maps.js";
+import { CDNOptions } from "../../types/private/cdn.js";
 export * from "./limiter.js";
 export * from "./url/imageUrlResolver.js";
 export * from "./url/urlResolver.js";

package/dist/core/assetResolver/url/authorUrlResolver.d.ts

@@ -1,3 +1,3 @@
-import { JsonAuthor, TranscriptOptionsBase } from "discord-message-transcript-base";
-import { CDNOptions } from "@/types/types.js";
+import { JsonAuthor, TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { CDNOptions } from "../../../types/private/cdn.js";
 export declare function authorUrlResolver(authors: Map<string, JsonAuthor>, options: TranscriptOptionsBase, cdnOptions: CDNOptions | null, urlCache: Map<string, Promise<string>>): Promise<JsonAuthor[]>;

package/dist/core/assetResolver/url/imageUrlResolver.d.ts

@@ -1,4 +1,4 @@
-import { JsonAttachment, TranscriptOptionsBase } from "discord-message-transcript-base";
-import { safeUrlReturn } from "@/types";
+import { JsonAttachment, TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { safeUrlReturn } from "../../../types/private/network.js";
 export declare function imageUrlResolver(url: string, options: TranscriptOptionsBase, canReturnNull: false, attachments?: JsonAttachment[]): Promise<safeUrlReturn>;
 export declare function imageUrlResolver(url: string | null, options: TranscriptOptionsBase, canReturnNull: true, attachments?: JsonAttachment[]): Promise<safeUrlReturn | null>;

package/dist/core/assetResolver/url/imageUrlResolver.js

@@ -1,5 +1,5 @@
-import { FALLBACK_PIXEL } from "discord-message-transcript-base";
-import { isSafeForHTML } from "@/networkSecurity";
+import { FALLBACK_PIXEL } from "discord-message-transcript-base/internal";
+import { isSafeForHTML } from "../../networkSecurity/index.js";
 export async function imageUrlResolver(url, options, canReturnNull, attachments) {
     if (!url)
         return null;

package/dist/core/assetResolver/url/messageUrlResolver.d.ts

@@ -1,3 +1,3 @@
-import { CDNOptions } from "@/types/types.js";
-import { JsonMessage, TranscriptOptionsBase } from "discord-message-transcript-base";
+import { JsonMessage, TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { CDNOptions } from "../../../types/private/cdn.js";
 export declare function messagesUrlResolver(messages: JsonMessage[], options: TranscriptOptionsBase, cdnOptions: CDNOptions | null, urlCache: Map<string, Promise<string>>): Promise<JsonMessage[]>;

package/dist/core/assetResolver/url/messageUrlResolver.js

@@ -1,8 +1,8 @@
-import { JsonComponentType } from "discord-message-transcript-base";
+import { JsonComponentType } from "discord-message-transcript-base/internal";
 import { imageUrlResolver } from "./imageUrlResolver.js";
-import { isSafeForHTML } from "@/networkSecurity";
+import { isSafeForHTML } from "../../networkSecurity/index.js";
 import { urlResolver } from "./urlResolver.js";
-import { isJsonComponentInContainer } from "@/core/discordParser/componentToJson.js";
+import { isJsonComponentInContainer } from "../../discordParser/componentToJson.js";
 export async function messagesUrlResolver(messages, options, cdnOptions, urlCache) {
     return await Promise.all(messages.map(async (message) => {
         // Needs to wait for resolve correct when used attachment://

package/dist/core/assetResolver/url/urlResolver.d.ts

@@ -1,3 +1,4 @@
-import { CDNOptions, safeUrlReturn } from "@/types/types.js";
-import { TranscriptOptionsBase } from "discord-message-transcript-base";
+import { TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { safeUrlReturn } from "../../../types/private/network.js";
+import { CDNOptions } from "../../../types/private/cdn.js";
 export declare function urlResolver(safeUrlObject: safeUrlReturn, options: TranscriptOptionsBase, cdnOptions: CDNOptions | null, urlCache: Map<string, Promise<string>>): Promise<string>;

package/dist/core/assetResolver/url/urlResolver.js

@@ -1,4 +1,4 @@
-import { FALLBACK_PIXEL } from "discord-message-transcript-base";
+import { FALLBACK_PIXEL } from "discord-message-transcript-base/internal";
 import { cdnResolver } from "../cdn/cdnResolver.js";
 import { imageToBase64 } from "../base64/imageToBase64.js";
 export async function urlResolver(safeUrlObject, options, cdnOptions, urlCache) {

package/dist/core/discordParser/componentToJson.d.ts

@@ -1,4 +1,4 @@
 import { TopLevelComponent } from "discord.js";
-import { JsonTopLevelComponent, TranscriptOptionsBase, JsonComponentInContainer } from "discord-message-transcript-base";
+import { JsonTopLevelComponent, TranscriptOptionsBase, JsonComponentInContainer } from "discord-message-transcript-base/internal";
 export declare function componentsToJson(components: TopLevelComponent[], options: TranscriptOptionsBase): Promise<JsonTopLevelComponent[]>;
 export declare function isJsonComponentInContainer(component: JsonTopLevelComponent): component is JsonComponentInContainer;

package/dist/core/discordParser/componentToJson.js

@@ -1,7 +1,6 @@
 import { ComponentType } from "discord.js";
 import { mapButtonStyle, mapSelectorType, mapSeparatorSpacing } from "../mappers.js";
-import { JsonComponentType } from "discord-message-transcript-base";
-import { isValidHexColor } from "discord-message-transcript-base";
+import { JsonComponentType, isValidHexColor } from "discord-message-transcript-base/internal";
 export async function componentsToJson(components, options) {
     const filtered = components.filter(c => options.includeV2Components || c.type === ComponentType.ActionRow);
     const processed = await Promise.all(filtered.map(c => convertComponent(c, options)));

package/dist/core/discordParser/fetchMessages.d.ts

@@ -1,5 +1,5 @@
-import { JsonMessage } from "discord-message-transcript-base";
-import { FetchMessagesContext } from "@/types";
+import { JsonMessage } from "discord-message-transcript-base/internal";
+import { FetchMessagesContext } from "../../types/private/discordParser.js";
 export declare function fetchMessages(ctx: FetchMessagesContext): Promise<{
     messages: JsonMessage[];
     end: boolean;

package/dist/core/discordParser/fetchMessages.js

@@ -1,6 +1,6 @@
 import { EmbedType } from "discord.js";
 import { componentsToJson } from "./componentToJson.js";
-import { isValidHexColor, sanitize } from "discord-message-transcript-base";
+import { isValidHexColor, sanitize } from "discord-message-transcript-base/internal";
 import { getMentions } from "./getMentions.js";
 export async function fetchMessages(ctx) {
     const { channel, options, transcriptState, lastMessageId } = ctx;

package/dist/core/discordParser/getMentions.d.ts

@@ -1,3 +1,3 @@
 import { Message } from "discord.js";
-import { MapMentions } from "@/types";
+import { MapMentions } from "../../types/private/maps.js";
 export declare function getMentions(message: Message, mentions: MapMentions): Promise<void>;

package/dist/core/discordParser/getMentions.js

@@ -1,5 +1,5 @@
 import { ChannelType } from "discord.js";
-import { isValidHexColor, sanitize } from "discord-message-transcript-base";
+import { isValidHexColor, sanitize } from "discord-message-transcript-base/internal";
 export async function getMentions(message, mentions) {
     message.mentions.channels.forEach(channel => {
         if (!mentions.channels.has(channel.id)) {

package/dist/core/discordParser/index.d.ts

@@ -1,4 +1,5 @@
-import { CDNOptions, ReturnDiscordParser } from "@/types/types.js";
-import { TranscriptOptionsBase } from "discord-message-transcript-base";
+import { TranscriptOptionsBase } from "discord-message-transcript-base/internal";
 import { TextBasedChannel } from "discord.js";
+import { ReturnDiscordParser } from "../../types/private/discordParser.js";
+import { CDNOptions } from "../../types/private/cdn.js";
 export declare function discordParser(channel: TextBasedChannel, options: TranscriptOptionsBase, cdnOptions: CDNOptions | null): Promise<ReturnDiscordParser>;

package/dist/core/discordParser/index.js

@@ -1,5 +1,5 @@
 import { fetchMessages } from "./fetchMessages.js";
-import { Json } from "@/renderers/json/json.js";
+import { Json } from "../../renderers/json/json.js";
 export async function discordParser(channel, options, cdnOptions) {
     const urlCache = new Map();
     const authors = new Map();

package/dist/core/mappers.d.ts

@@ -1,6 +1,7 @@
 import { ButtonStyle, ComponentType, SeparatorSpacingSize } from "discord.js";
-import { JsonButtonStyle, JsonComponentType, JsonSeparatorSpacingSize, ReturnTypeBase } from "discord-message-transcript-base";
-import { ReturnType } from "@/types";
+import { JsonButtonStyle, JsonComponentType, JsonSeparatorSpacingSize } from "discord-message-transcript-base/internal";
+import { ReturnType } from "../types/public/return.js";
+import { ReturnType as ReturnTypeBase } from "discord-message-transcript-base";
 export declare function mapButtonStyle(style: ButtonStyle): JsonButtonStyle;
 export declare function mapSeparatorSpacing(spacing: SeparatorSpacingSize): JsonSeparatorSpacingSize;
 export declare function mapComponentType(componentType: ComponentType): JsonComponentType;

package/dist/core/mappers.js

@@ -1,6 +1,7 @@
 import { ButtonStyle, ComponentType, SeparatorSpacingSize } from "discord.js";
-import { CustomError, JsonButtonStyle, JsonComponentType, JsonSeparatorSpacingSize, ReturnTypeBase } from "discord-message-transcript-base";
-import { ReturnType } from "@/types";
+import { CustomError, JsonButtonStyle, JsonComponentType, JsonSeparatorSpacingSize } from "discord-message-transcript-base/internal";
+import { ReturnType } from "../types/public/return.js";
+import { ReturnType as ReturnTypeBase } from "discord-message-transcript-base";
 export function mapButtonStyle(style) {
     switch (style) {
         case ButtonStyle.Primary:

package/dist/core/networkSecurity/dns.d.ts

@@ -1,2 +1,2 @@
-import { LookupResult } from "@/types";
+import { LookupResult } from "../../types/private/network.js";
 export declare function resolveAllIps(host: string): Promise<LookupResult[]>;

package/dist/core/networkSecurity/urlSafety.d.ts

@@ -1,3 +1,3 @@
-import { TranscriptOptionsBase } from "discord-message-transcript-base";
-import { safeUrlReturn } from "@/types";
+import { TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+import { safeUrlReturn } from "../../types/private/network.js";
 export declare function isSafeForHTML(url: string, options: TranscriptOptionsBase): Promise<safeUrlReturn>;

package/dist/core/networkSecurity/urlSafety.js

@@ -1,4 +1,4 @@
-import { CustomWarn } from "discord-message-transcript-base";
+import { CustomWarn } from "discord-message-transcript-base/internal";
 import { TRUSTED_DISCORD_HOSTS } from "./constants.js";
 import { isPrivateIp } from "./ip.js";
 import { resolveAllIps } from "./dns.js";

package/dist/core/output.d.ts

@@ -1,4 +1,4 @@
 import { AttachmentBuilder } from "discord.js";
 import Stream from 'stream';
-import { JsonData, Uploadable } from "discord-message-transcript-base";
+import { JsonData, Uploadable } from "discord-message-transcript-base/internal";
 export declare function output(json: JsonData): Promise<string | Stream | AttachmentBuilder | Buffer | Uploadable>;

package/dist/core/output.js

@@ -1,5 +1,5 @@
 import { Readable } from 'stream';
-import { outputBase, CustomError } from "discord-message-transcript-base";
+import { outputBase, CustomError } from "discord-message-transcript-base/internal";
 export async function output(json) {
     const stringJSON = JSON.stringify(json);
     if (json.options.returnFormat == "JSON") {

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-export { CreateTranscriptOptions, ConvertTranscriptOptions, TranscriptOptions, ReturnType, CDNOptions, MimeType } from "@/types";
-export { ReturnFormat, LocalDate, TimeZone } from "discord-message-transcript-base";
-export { setBase64Concurrency, setCDNConcurrency } from '@/assetResolver';
+export * from "./types/index.js";
+export { setBase64Concurrency, setCDNConcurrency } from './core/assetResolver/index.js';
 import { TextBasedChannel } from "discord.js";
-import { ConvertTranscriptOptions, CreateTranscriptOptions, OutputType, ReturnType } from "@/types";
+import { OutputType, ReturnType } from "./types/public/return.js";
+import { ConvertTranscriptOptions, CreateTranscriptOptions } from "./types/public/createAndConvertTranscript.js";
 /**
  * Creates a transcript of a Discord channel's messages.
  * Depending on the `returnType` option, this function can return an `AttachmentBuilder`,

package/dist/index.js

@@ -1,13 +1,13 @@
-export { ReturnType } from "@/types";
-export { ReturnFormat } from "discord-message-transcript-base";
-export { setBase64Concurrency, setCDNConcurrency } from '@/assetResolver';
+export * from "./types/index.js";
+export { setBase64Concurrency, setCDNConcurrency } from './core/assetResolver/index.js';
 import { AttachmentBuilder } from "discord.js";
-import { ReturnType } from "@/types";
-import { output } from "@/core/output.js";
-import { ReturnTypeBase, ReturnFormat, outputBase, CustomError, CustomWarn } from "discord-message-transcript-base";
-import { returnTypeMapper } from "@/core/mappers.js";
-import { jsonAssetResolver } from "@/assetResolver";
+import { output } from "./core/output.js";
+import { ReturnFormat, outputBase, CustomError, CustomWarn } from "discord-message-transcript-base/internal";
+import { ReturnType as ReturnTypeBase } from "discord-message-transcript-base";
+import { returnTypeMapper } from "./core/mappers.js";
+import { jsonAssetResolver } from "./core/assetResolver/index.js";
 import { discordParser } from "./core/discordParser/index.js";
+import { ReturnType } from "./types/public/return.js";
 /**
  * Creates a transcript of a Discord channel's messages.
  * Depending on the `returnType` option, this function can return an `AttachmentBuilder`,

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

@@ -1,6 +1,6 @@
 import { Guild, TextBasedChannel } from "discord.js";
-import { ArrayMentions, JsonAuthor, JsonMessage, TranscriptOptionsBase, JsonData } from "discord-message-transcript-base";
-import { CDNOptions } from "@/types";
+import { ArrayMentions, JsonAuthor, JsonMessage, TranscriptOptionsBase, JsonData } from "discord-message-transcript-base/internal";
+import { CDNOptions } from "../../types/private/cdn.js";
 export declare class Json {
     private guild;
     private channel;

package/dist/renderers/json/json.js

@@ -1,5 +1,5 @@
 import { BaseGuildTextChannel, DMChannel } from "discord.js";
-import { imageUrlResolver, urlResolver } from "@/assetResolver";
+import { imageUrlResolver, urlResolver } from "../../core/assetResolver/index.js";
 export class Json {
     guild;
     channel;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export { ReturnFormat } from "discord-message-transcript-base/internal";
+export * from "./public/return.js";
+export * from "./public/createAndConvertTranscript.js";

package/dist/types/index.js

@@ -0,0 +1,3 @@
+export { ReturnFormat } from "discord-message-transcript-base/internal";
+export * from "./public/return.js";
+export * from "./public/createAndConvertTranscript.js";

package/dist/types/private/cdn.d.ts

@@ -0,0 +1,89 @@
+import { MimeType } from "./others.js";
+/**
+ * Base options applicable to all CDN providers.
+ */
+export type CDNBase = Partial<{
+    /**
+     * Whether to upload audio files to the CDN.
+     * @default true
+     */
+    includeAudio: boolean;
+    /**
+     * Whether to upload image files (excluding GIFs) to the CDN.
+     * @default true
+     */
+    includeImage: boolean;
+    /**
+     * Whether to upload video files (and GIFs) to the CDN.
+     * @default true
+     */
+    includeVideo: boolean;
+    /**
+     * Whether to upload any other file types to the CDN.
+     * @default true
+     */
+    includeOthers: boolean;
+}>;
+/**
+ * A discriminated union of all possible CDN configurations.
+ */
+export type CDNOptions = (CDNBase & CDNOptionsCustom<any>) | (CDNBase & CDNOptionsCloudinary) | (CDNBase & CDNOptionsUploadcare);
+/**
+ * Configuration for using a custom, user-provided CDN resolver function.
+ */
+export type CDNOptionsCustom<T = unknown> = {
+    /** Specifies the use of a custom CDN resolver. */
+    provider: "CUSTOM";
+    /**
+     * An async function that takes a URL and returns a new URL.
+     * @param url The original Discord asset URL.
+     * @param contentType The MIME type of the asset.
+     * @param customData Any additional data you want to pass to your resolver.
+     * @returns The new URL of the asset on your CDN.
+     */
+    resolver: (url: string, contentType: MimeType | null, customData: T) => Promise<string> | string;
+    /**
+     * Any custom data you wish to make available within your resolver function.
+     */
+    customData: T;
+};
+/**
+ * Configuration for using Cloudinary as the CDN.
+ */
+export type CDNOptionsCloudinary = {
+    /**
+     * Specifies the use of the built-in Cloudinary provider.
+     */
+    provider: "CLOUDINARY";
+    /**
+     * Your Cloudinary cloud name.
+     */
+    cloudName: string;
+    /**
+     * Your Cloudinary API key.
+     * */
+    apiKey: string;
+    /**
+     * Your Cloudinary API secret.
+    */
+    apiSecret: string;
+};
+/**
+ * Configuration for using Uploadcare as the CDN.
+ */
+export type CDNOptionsUploadcare = {
+    /**
+     * Specifies the use of the built-in Uploadcare provider.
+     */
+    provider: "UPLOADCARE";
+    /**
+     * Your Uploadcare public key.
+     */
+    publicKey: string;
+    /**
+     * Your Uploadcare CDN domain.
+     * Example: "aaa111aaa1.ucarecd.net".
+     * DO NOT INCLUDE https://
+     */
+    cdnDomain: string;
+};

package/dist/types/private/cdn.js

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

package/dist/types/private/discordParser.d.ts

@@ -0,0 +1,18 @@
+import { Json } from "../../renderers/json/json.js";
+import { MapMentions, Maps } from "./maps.js";
+import { TextBasedChannel } from "discord.js";
+import { JsonAuthor, TranscriptOptionsBase } from "discord-message-transcript-base/internal";
+export type ReturnDiscordParser = [
+    json: Json,
+    maps: Maps
+];
+export type FetchMessagesContext = {
+    channel: TextBasedChannel;
+    options: TranscriptOptionsBase;
+    transcriptState: TranscriptState;
+    lastMessageId: string | undefined;
+};
+export type TranscriptState = {
+    authors: Map<string, JsonAuthor>;
+    mentions: MapMentions;
+};

package/dist/types/private/discordParser.js

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

package/dist/types/private/maps.d.ts

@@ -0,0 +1,17 @@
+import { JsonAuthor, JsonMessageMentionsChannels, JsonMessageMentionsRoles, JsonMessageMentionsUsers } from "discord-message-transcript-base/internal";
+export type MapAuthors = Map<string, JsonAuthor>;
+export type MapCache = Map<string, Promise<string>>;
+/**
+ * Defines the structure for storing discovered mentions (users, roles, channels) during transcript creation.
+ * Uses Maps for efficient lookups.
+ */
+export interface MapMentions {
+    channels: Map<string, JsonMessageMentionsChannels>;
+    roles: Map<string, JsonMessageMentionsRoles>;
+    users: Map<string, JsonMessageMentionsUsers>;
+}
+export type Maps = {
+    authors: MapAuthors;
+    mentions: MapMentions;
+    urlCache: MapCache;
+};

package/dist/types/private/maps.js

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

package/dist/types/private/network.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Result from dns.lookup
+ */
+export type LookupResult = {
+    address: string;
+    family: 4 | 6;
+};
+export interface safeUrlReturn {
+    safe: boolean;
+    safeIps: string[];
+    url: string;
+}

package/dist/types/private/network.js

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

package/dist/types/private/others.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A string template type for representing a MIME type (e.g., 'image/png', 'application/json').
+ */
+export type MimeType = `${string}/${string}`;

package/dist/types/private/others.js

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

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

@@ -0,0 +1,123 @@
+import { LocalDate, ReturnFormat, TimeZone } from "discord-message-transcript-base/internal";
+import { CDNOptions } from "./cdn.js";
+import { ReturnType } from "../public/return.js";
+/**
+ * Defines the complete set of options for creating a transcript.
+ */
+export interface TranscriptOptions<T extends ReturnType> {
+    /**
+     * Configuration for uploading attachments and other assets to a CDN.
+     */
+    cdnOptions: CDNOptions;
+    /**
+     * Disable all warnings to keep console output clean.
+     * ⚠️ Can hide issues like unsafe URLs or fallback usage.
+     * @default false
+     */
+    disableWarnings: boolean;
+    /**
+     * The name of the generated file (without extension).
+     * @default `Transcript-channel-name-channel-id`
+     */
+    fileName: string;
+    /**
+     * Whether to include attachments in the transcript.
+     * @default true
+     */
+    includeAttachments: boolean;
+    /**
+     * Whether to include message component buttons in the transcript.
+     * @default true
+     */
+    includeButtons: boolean;
+    /**
+     * Whether to include non-button message components (like select menus) in the transcript.
+     * @default true
+     */
+    includeComponents: boolean;
+    /**
+     * Whether to include messages that have no content.
+     * @default false
+     */
+    includeEmpty: boolean;
+    /**
+     * Whether to include embeds in the transcript.
+     * @default true
+     */
+    includeEmbeds: boolean;
+    /**
+     * Whether to include polls in the transcript.
+     * @default true
+     */
+    includePolls: boolean;
+    /**
+     * Whether to include message reactions in the transcript.
+     * @default true
+     */
+    includeReactions: boolean;
+    /**
+     * Whether to include newer (V2) components like `Container`, `MediaGallery`, etc.
+     * @default true
+     */
+    includeV2Components: boolean;
+    /**
+     * The locale to use for formatting dates (e.g., 'en-US', 'pt-BR').
+     * Must be a valid BCP 47 language tag.
+     * @default 'en-GB'
+     */
+    localDate: LocalDate;
+    /**
+     * The maximum number of messages to fetch. Set to `0` to fetch all messages in the channel.
+     * @default 0
+     */
+    quantity: number;
+    /**
+     * The format of the returned transcript.
+     * - ReturnFormat.HTML - Returns the transcript as HTML
+     * - ReturnFormat.JSON - Returns the transcript as JSON
+     * @default ReturnFormat.HTML
+     */
+    returnFormat: ReturnFormat;
+    /**
+     * The desired output type for the transcript.
+     * - ReturnType.Attachment - The transcript content as a `Attachment`
+     * - 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.Attachment
+     */
+    returnType: T;
+    /**
+     * 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 data directly in the transcript.
+     * This is an alternative to using a CDN and results in larger file sizes.
+     * Will not work if using CDN.
+     * @default false
+     */
+    saveImages: boolean;
+    /**
+     * Whether the generated HTML should have its CSS and JS embedded directly in the file.
+     * Only applicable if `returnFormat` is `HTML`.
+     * @default false
+     */
+    selfContained: boolean;
+    /**
+     * The timezone to use for formatting dates (e.g., 'UTC', 'America/New_York').
+     * Must be a valid IANA time zone name.
+     * @default 'UTC'
+     */
+    timeZone: TimeZone;
+    /**
+     * Whether to include the 'Generated with discord-message-transcript' watermark in the footer.
+     * @default true
+     */
+    watermark: boolean;
+}

package/dist/types/private/transcript.js

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

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

@@ -0,0 +1,32 @@
+import { ReturnType } from "../public/return.js";
+import { TranscriptOptions } from "../private/transcript.js";
+/**
+ * Options for creating a transcript, with all properties being optional.
+ * @see TranscriptOptions
+ */
+export type CreateTranscriptOptions<T extends ReturnType> = Partial<TranscriptOptions<T>>;
+/**
+ * Options for converting a JSON transcript to an HTML transcript.
+ */
+export type ConvertTranscriptOptions<T extends ReturnType> = Partial<{
+    /**
+     * The desired output type for the transcript.
+     * - ReturnType.Attachment - The transcript content as a `Attachment`
+     * - 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.Attachment
+     */
+    returnType: T;
+    /**
+     * Whether the generated HTML should have its CSS and JS embedded directly in the file.
+     * @default false
+     */
+    selfContained: boolean;
+    /**
+     * Whether to include the 'Generated with discord-message-transcript' watermark in the footer.
+     * @default true
+     */
+    watermark: boolean;
+}>;

package/dist/types/public/createAndConvertTranscript.js

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

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

@@ -0,0 +1,37 @@
+import { Uploadable } from "discord-message-transcript-base/internal";
+import { AttachmentBuilder } from "discord.js";
+import Stream from 'stream';
+/**
+ * An enum-like object providing the possible return types for the transcript functions.
+ */
+export declare const ReturnType: {
+    /**
+     * Returns a `discord.js` AttachmentBuilder.
+     */
+    readonly Attachment: "attachment";
+    /**
+     * Returns a `Buffer`.
+     */
+    readonly Buffer: "buffer";
+    /**
+     * Returns a `Stream.Readable`.
+     * */
+    readonly Stream: "stream";
+    /**
+     * Returns a `string`.
+     * */
+    readonly String: "string";
+    /**
+     * Returns an `Uploadable` object with content, contentType, and fileName.
+     */
+    readonly Uploadable: "uploadable";
+};
+/**
+ * The type representing the possible values of the `ReturnType` enum.
+ */
+export type ReturnType = typeof ReturnType[keyof typeof ReturnType];
+/**
+ * A conditional type that maps the `ReturnType` string literal to the actual TypeScript type returned by the function.
+ * @template T The `ReturnType` literal.
+ */
+export type OutputType<T extends ReturnType> = T extends typeof ReturnType.Buffer ? Buffer : T extends typeof ReturnType.Stream ? Stream : T extends typeof ReturnType.String ? string : T extends typeof ReturnType.Uploadable ? Uploadable : AttachmentBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-message-transcript",
-  "version": "1.3.2-dev.0.49",
+  "version": "1.3.2-dev.1.50",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,7 +45,7 @@
   },
   "homepage": "https://github.com/HenriqueMairesse/discord-message-transcript#readme",
   "dependencies": {
-    "discord-message-transcript-base": "1.3.2-dev.0.49"
+    "discord-message-transcript-base": "1.3.2-dev.1.50"
   },
   "peerDependencies": {
     "discord.js": ">=14.19.0 <15"
@@ -55,6 +55,6 @@
   },
   "scripts": {
     "clean": "pnpm exec rimraf dist",
-    "build": "pnpm run clean && tsc"
+    "build": "pnpm run clean && tsc && tsc-alias"
   }
 }

package/dist/types/types.d.ts

@@ -1,322 +0,0 @@
-import { Json } from "@/renderers/json/json.js";
-import { JsonMessageMentionsChannels, JsonMessageMentionsRoles, JsonMessageMentionsUsers, LocalDate, TimeZone, Uploadable, ReturnFormat, TranscriptOptionsBase, JsonAuthor } from "discord-message-transcript-base";
-import { AttachmentBuilder, TextBasedChannel } from "discord.js";
-import Stream from 'stream';
-/**
- * An enum-like object providing the possible return types for the transcript functions.
- */
-export declare const ReturnType: {
-    /**
-     * Returns a `discord.js` AttachmentBuilder.
-     */
-    readonly Attachment: "attachment";
-    /**
-     * Returns a `Buffer`.
-     */
-    readonly Buffer: "buffer";
-    /**
-     * Returns a `Stream.Readable`.
-     * */
-    readonly Stream: "stream";
-    /**
-     * Returns a `string`.
-     * */
-    readonly String: "string";
-    /**
-     * Returns an `Uploadable` object with content, contentType, and fileName.
-     */
-    readonly Uploadable: "uploadable";
-};
-/**
- * The type representing the possible values of the `ReturnType` enum.
- */
-export type ReturnType = typeof ReturnType[keyof typeof ReturnType];
-/**
- * A conditional type that maps the `ReturnType` string literal to the actual TypeScript type returned by the function.
- * @template T The `ReturnType` literal.
- */
-export type OutputType<T extends ReturnType> = T extends typeof ReturnType.Buffer ? Buffer : T extends typeof ReturnType.Stream ? Stream : T extends typeof ReturnType.String ? string : T extends typeof ReturnType.Uploadable ? Uploadable : AttachmentBuilder;
-/**
- * Options for creating a transcript, with all properties being optional.
- * @see TranscriptOptions
- */
-export type CreateTranscriptOptions<T extends ReturnType> = Partial<TranscriptOptions<T>>;
-/**
- * Options for converting a JSON transcript to an HTML transcript.
- */
-export type ConvertTranscriptOptions<T extends ReturnType> = Partial<{
-    /**
-     * The desired output type for the transcript.
-     * - ReturnType.Attachment - The transcript content as a `Attachment`
-     * - 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.Attachment
-     */
-    returnType: T;
-    /**
-     * Whether the generated HTML should have its CSS and JS embedded directly in the file.
-     * @default false
-     */
-    selfContained: boolean;
-    /**
-     * Whether to include the 'Generated with discord-message-transcript' watermark in the footer.
-     * @default true
-     */
-    watermark: boolean;
-}>;
-/**
- * Defines the complete set of options for creating a transcript.
- */
-export interface TranscriptOptions<T extends ReturnType> {
-    /**
-     * Configuration for uploading attachments and other assets to a CDN.
-     */
-    cdnOptions: CDNOptions;
-    /**
-     * Disable all warnings to keep console output clean.
-     * ⚠️ Can hide issues like unsafe URLs or fallback usage.
-     * @default false
-     */
-    disableWarnings: boolean;
-    /**
-     * The name of the generated file (without extension).
-     * @default `Transcript-channel-name-channel-id`
-     */
-    fileName: string;
-    /**
-     * Whether to include attachments in the transcript.
-     * @default true
-     */
-    includeAttachments: boolean;
-    /**
-     * Whether to include message component buttons in the transcript.
-     * @default true
-     */
-    includeButtons: boolean;
-    /**
-     * Whether to include non-button message components (like select menus) in the transcript.
-     * @default true
-     */
-    includeComponents: boolean;
-    /**
-     * Whether to include messages that have no content.
-     * @default false
-     */
-    includeEmpty: boolean;
-    /**
-     * Whether to include embeds in the transcript.
-     * @default true
-     */
-    includeEmbeds: boolean;
-    /**
-     * Whether to include polls in the transcript.
-     * @default true
-     */
-    includePolls: boolean;
-    /**
-     * Whether to include message reactions in the transcript.
-     * @default true
-     */
-    includeReactions: boolean;
-    /**
-     * Whether to include newer (V2) components like `Container`, `MediaGallery`, etc.
-     * @default true
-     */
-    includeV2Components: boolean;
-    /**
-     * The locale to use for formatting dates (e.g., 'en-US', 'pt-BR').
-     * Must be a valid BCP 47 language tag.
-     * @default 'en-GB'
-     */
-    localDate: LocalDate;
-    /**
-     * The maximum number of messages to fetch. Set to `0` to fetch all messages in the channel.
-     * @default 0
-     */
-    quantity: number;
-    /**
-     * The format of the returned transcript.
-     * - ReturnFormat.HTML - Returns the transcript as HTML
-     * - ReturnFormat.JSON - Returns the transcript as JSON
-     * @default ReturnFormat.HTML
-     */
-    returnFormat: ReturnFormat;
-    /**
-     * The desired output type for the transcript.
-     * - ReturnType.Attachment - The transcript content as a `Attachment`
-     * - 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.Attachment
-     */
-    returnType: T;
-    /**
-     * 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 data directly in the transcript.
-     * This is an alternative to using a CDN and results in larger file sizes.
-     * Will not work if using CDN.
-     * @default false
-     */
-    saveImages: boolean;
-    /**
-     * Whether the generated HTML should have its CSS and JS embedded directly in the file.
-     * Only applicable if `returnFormat` is `HTML`.
-     * @default false
-     */
-    selfContained: boolean;
-    /**
-     * The timezone to use for formatting dates (e.g., 'UTC', 'America/New_York').
-     * Must be a valid IANA time zone name.
-     * @default 'UTC'
-     */
-    timeZone: TimeZone;
-    /**
-     * Whether to include the 'Generated with discord-message-transcript' watermark in the footer.
-     * @default true
-     */
-    watermark: boolean;
-}
-/**
- * Defines the structure for storing discovered mentions (users, roles, channels) during transcript creation.
- * Uses Maps for efficient lookups.
- */
-export interface MapMentions {
-    channels: Map<string, JsonMessageMentionsChannels>;
-    roles: Map<string, JsonMessageMentionsRoles>;
-    users: Map<string, JsonMessageMentionsUsers>;
-}
-/**
- * A string template type for representing a MIME type (e.g., 'image/png', 'application/json').
- */
-export type MimeType = `${string}/${string}`;
-/**
- * Base options applicable to all CDN providers.
- */
-export type CDNBase = Partial<{
-    /**
-     * Whether to upload audio files to the CDN.
-     * @default true
-     */
-    includeAudio: boolean;
-    /**
-     * Whether to upload image files (excluding GIFs) to the CDN.
-     * @default true
-     */
-    includeImage: boolean;
-    /**
-     * Whether to upload video files (and GIFs) to the CDN.
-     * @default true
-     */
-    includeVideo: boolean;
-    /**
-     * Whether to upload any other file types to the CDN.
-     * @default true
-     */
-    includeOthers: boolean;
-}>;
-/**
- * A discriminated union of all possible CDN configurations.
- */
-export type CDNOptions = (CDNBase & CDNOptionsCustom<any>) | (CDNBase & CDNOptionsCloudinary) | (CDNBase & CDNOptionsUploadcare);
-/**
- * Configuration for using a custom, user-provided CDN resolver function.
- */
-export type CDNOptionsCustom<T = unknown> = {
-    /** Specifies the use of a custom CDN resolver. */
-    provider: "CUSTOM";
-    /**
-     * An async function that takes a URL and returns a new URL.
-     * @param url The original Discord asset URL.
-     * @param contentType The MIME type of the asset.
-     * @param customData Any additional data you want to pass to your resolver.
-     * @returns The new URL of the asset on your CDN.
-     */
-    resolver: (url: string, contentType: MimeType | null, customData: T) => Promise<string> | string;
-    /**
-     * Any custom data you wish to make available within your resolver function.
-     */
-    customData: T;
-};
-/**
- * Configuration for using Cloudinary as the CDN.
- */
-export type CDNOptionsCloudinary = {
-    /**
-     * Specifies the use of the built-in Cloudinary provider.
-     */
-    provider: "CLOUDINARY";
-    /**
-     * Your Cloudinary cloud name.
-     */
-    cloudName: string;
-    /**
-     * Your Cloudinary API key.
-     * */
-    apiKey: string;
-    /**
-     * Your Cloudinary API secret.
-    */
-    apiSecret: string;
-};
-/**
- * Configuration for using Uploadcare as the CDN.
- */
-export type CDNOptionsUploadcare = {
-    /**
-     * Specifies the use of the built-in Uploadcare provider.
-     */
-    provider: "UPLOADCARE";
-    /**
-     * Your Uploadcare public key.
-     */
-    publicKey: string;
-    /**
-     * Your Uploadcare CDN domain.
-     * Example: "aaa111aaa1.ucarecd.net".
-     * DO NOT INCLUDE https://
-     */
-    cdnDomain: string;
-};
-/**
- * Result from dns.lookup
- */
-export type LookupResult = {
-    address: string;
-    family: 4 | 6;
-};
-export interface safeUrlReturn {
-    safe: boolean;
-    safeIps: string[];
-    url: string;
-}
-export type FetchMessagesContext = {
-    channel: TextBasedChannel;
-    options: TranscriptOptionsBase;
-    transcriptState: TranscriptState;
-    lastMessageId: string | undefined;
-};
-export type TranscriptState = {
-    authors: Map<string, JsonAuthor>;
-    mentions: MapMentions;
-};
-export type ReturnDiscordParser = [
-    json: Json,
-    maps: Maps
-];
-export type MapAuthors = Map<string, JsonAuthor>;
-export type MapCache = Map<string, Promise<string>>;
-export type Maps = {
-    authors: MapAuthors;
-    mentions: MapMentions;
-    urlCache: MapCache;
-};