@libstermynal/transcript-v2 3.3.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,134 @@
+# `discord-html-transcripts`
+
+[![Discord](https://img.shields.io/discord/555474311637499955?label=discord)](https://discord.gg/rf5qN7C)
+[![npm](https://img.shields.io/npm/dw/discord-html-transcripts)](http://npmjs.org/package/discord-html-transcripts)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/ItzDerock/discord-html-transcripts)
+![GitHub Repo stars](https://img.shields.io/github/stars/ItzDerock/discord-html-transcripts?style=social)
+
+Discord HTML Transcripts is a node.js module to generate nice looking HTML transcripts. Processes discord markdown like **bold**, _italics_, ~~strikethroughs~~, and more. Nicely formats attachments and embeds. Built in XSS protection, preventing users from inserting arbitrary html tags.
+
+This module can format the following:
+
+- Discord flavored markdown
+  - Uses [discord-markdown-parser](https://github.com/ItzDerock/discord-markdown-parser)
+  - Allows for complex markdown syntax to be parsed properly
+- Embeds
+- System messages
+  - Join messages
+  - Message Pins
+  - Boost messages
+- Slash commands
+  - Will show the name of the command in the same style as Discord
+- Buttons
+- Reactions
+- Attachments
+  - Images, videos, audio, and generic files
+- Replies
+- Mentions
+- Threads
+
+**This module is designed to work with [discord.js](https://discord.js.org/#/) v14/v15 _only_. If you need v13 support, roll back to v2.X.X**
+
+Styles from [@derockdev/discord-components](https://github.com/ItzDerock/discord-components).
+Behind the scenes, this package uses React SSR to generate a static site.
+
+## 👋 Support
+
+Please do not DM me requesting support with this package, I will not respond.
+Instead, please open a thread on [this](https://discord.gg/MZQN8QMJg8) server.
+
+## 🖨️ Example Output
+
+![output](https://derock.media/r/6G6FIl.gif)
+
+## 📝 Usage
+
+### Example usage using the built in message fetcher.
+
+```js
+const discordTranscripts = require('discord-html-transcripts');
+// or (if using typescript) import * as discordTranscripts from 'discord-html-transcripts';
+
+const channel = message.channel; // or however you get your TextChannel
+
+// Must be awaited
+const attachment = await discordTranscripts.createTranscript(channel);
+
+channel.send({
+  files: [attachment],
+});
+```
+
+### Or if you prefer, you can pass in your own messages.
+
+```js
+const discordTranscripts = require('discord-html-transcripts');
+// or (if using typescript) import * as discordTranscripts from 'discord-html-transcripts';
+
+const messages = someWayToGetMessages(); // Must be Collection<string, Message> or Message[]
+const channel = someWayToGetChannel(); // Used for ticket name, guild icon, and guild name
+
+// Must be awaited
+const attachment = await discordTranscripts.generateFromMessages(messages, channel);
+
+channel.send({
+  files: [attachment],
+});
+```
+
+## ⚙️ Configuration
+
+Both methods of generating a transcript allow for an option object as the last parameter.
+**All configuration options are optional!**
+
+### Built in Message Fetcher
+
+```js
+const attachment = await discordTranscripts.createTranscript(channel, {
+    limit: -1, // Max amount of messages to fetch. `-1` recursively fetches.
+    returnType: 'attachment', // Valid options: 'buffer' | 'string' | 'attachment' Default: 'attachment' OR use the enum ExportReturnType
+    filename: 'transcript.html', // Only valid with returnType is 'attachment'. Name of attachment.
+    saveImages: false, // Download all images and include the image data in the HTML (allows viewing the image even after it has been deleted) (! WILL INCREASE FILE SIZE !)
+    footerText: "Exported {number} message{s}", // Change text at footer, don't forget to put {number} to show how much messages got exported, and {s} for plural
+    callbacks: {
+      // register custom callbacks for the following:
+      resolveChannel: (channelId: string) => Awaitable<Channel | null>,
+      resolveUser: (userId: string) => Awaitable<User | null>,
+      resolveRole: (roleId: string) => Awaitable<Role | null>,
+      resolveImageSrc: (
+        attachment: APIAttachment,
+        message: APIMessage
+      ) => Awaitable<string | null | undefined>
+    },
+    poweredBy: true, // Whether to include the "Powered by discord-html-transcripts" footer
+    hydrate: true, // Whether to hydrate the html server-side
+    filter: (message) => true // Filter messages, e.g. (message) => !message.author.bot
+});
+```
+
+### Providing your own messages
+
+```js
+const attachment = await discordTranscripts.generateFromMessages(messages, channel, {
+  // Same as createTranscript, except no limit or filter
+});
+```
+
+### Compressing images
+
+If `saveImages` is set to `true`, all images will be downloaded and stored in the file _as-is_. You can optionally enable compression by installing the `sharp` module and setting the following options:
+
+```js
+callbacks: {
+  resolveImageSrc: new TranscriptImageDownloader()
+    .withMaxSize(5120) // 5MB in KB
+    .withCompression(40, true) // 40% quality, convert to webp
+    .build(),
+},
+```
+
+Note that, in a more advanced setup, you could store a copy of the files and return an entirely new URL pointing to your own image hosting site by implementing a custom `resolveImageSrc` function.
+
+## 🤝 Enjoy the package?
+
+Give it a star ⭐ and/or support me on [ko-fi](https://ko-fi.com/derock)

package/dist/downloader/images.d.ts

@@ -0,0 +1,36 @@
+import type { APIAttachment, APIMessage, Awaitable } from 'discord.js';
+import type { WebpOptions } from 'sharp';
+/**
+ * Callback used to save an image attachment.
+ * The returned string is the URL that will be used in the transcript.
+ *
+ * `undefined` indicates to use the original attachment URL.
+ * `null` indicates to not include the attachment in the transcript.
+ * `string` indicates to use the returned URL as the attachment URL (base64 or remote image).
+ */
+export type ResolveImageCallback = (attachment: APIAttachment, message: APIMessage) => Awaitable<string | null | undefined>;
+/**
+ * Builder to build a image saving callback.
+ */
+export declare class TranscriptImageDownloader {
+    private static log;
+    private log;
+    private maxFileSize?;
+    private compression?;
+    /**
+     * Sets the maximum file size for *each* individual image.
+     * @param size The maximum file size in kilobytes
+     */
+    withMaxSize(size: number): this;
+    /**
+     * Sets the compression quality for each image. This requires `sharp` to be installed.
+     * Optionally, images can be converted to WebP format which is smaller in size.
+     * @param quality The quality of the image (1 lowest - 100 highest). Lower quality means smaller file size.
+     * @param convertToWebP Whether to convert the image to WebP format
+     */
+    withCompression(quality?: number, convertToWebP?: boolean, options?: Omit<WebpOptions, 'quality' | 'force'>): this;
+    /**
+     * Builds the image saving callback.
+     */
+    build(): ResolveImageCallback;
+}

package/dist/downloader/images.js

@@ -0,0 +1,114 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranscriptImageDownloader = void 0;
+const undici_1 = require("undici");
+const debug_1 = __importDefault(require("debug"));
+/**
+ * Builder to build a image saving callback.
+ */
+class TranscriptImageDownloader {
+    constructor() {
+        this.log = TranscriptImageDownloader.log;
+    }
+    /**
+     * Sets the maximum file size for *each* individual image.
+     * @param size The maximum file size in kilobytes
+     */
+    withMaxSize(size) {
+        this.maxFileSize = size;
+        return this;
+    }
+    /**
+     * Sets the compression quality for each image. This requires `sharp` to be installed.
+     * Optionally, images can be converted to WebP format which is smaller in size.
+     * @param quality The quality of the image (1 lowest - 100 highest). Lower quality means smaller file size.
+     * @param convertToWebP Whether to convert the image to WebP format
+     */
+    withCompression(quality = 80, convertToWebP = false, options = {}) {
+        if (quality < 1 || quality > 100)
+            throw new Error('Quality must be between 1 and 100');
+        // try and import sharp
+        Promise.resolve().then(() => __importStar(require('sharp'))).catch((err) => {
+            console.error(err);
+            console.error(`[discord-html-transcripts] Failed to import 'sharp'. Image compression requires the 'sharp' package to be installed. Either install sharp or remove the compression options.`);
+        });
+        this.compression = { quality, convertToWebP, options };
+        return this;
+    }
+    /**
+     * Builds the image saving callback.
+     */
+    build() {
+        return async (attachment) => {
+            // if the attachment is not an image, return null
+            if (!attachment.width || !attachment.height)
+                return undefined;
+            // if the max file size is set, check if the file size is within the limit
+            if (this.maxFileSize && attachment.size > this.maxFileSize * 1024)
+                return undefined;
+            // fetch the image
+            this.log(`Fetching attachment ${attachment.id}: ${attachment.url}`);
+            const response = await (0, undici_1.request)(attachment.url).catch((err) => {
+                console.error(`[discord-html-transcripts] Failed to download image for transcript: `, err);
+                return null;
+            });
+            if (!response)
+                return undefined;
+            const mimetype = response.headers['content-type'];
+            const buffer = await response.body.arrayBuffer().then((res) => Buffer.from(res));
+            this.log(`Finished fetching ${attachment.id} (${buffer.length} bytes)`);
+            // if the compression options are set, compress the image
+            if (this.compression) {
+                const sharp = await Promise.resolve().then(() => __importStar(require('sharp')));
+                this.log(`Compressing ${attachment.id} with 'sharp'`);
+                const sharpbuf = await sharp
+                    .default(buffer)
+                    .webp(Object.assign({ quality: this.compression.quality, force: this.compression.convertToWebP, effort: 2 }, this.compression.options))
+                    .toBuffer({ resolveWithObject: true });
+                this.log(`Finished compressing ${attachment.id} (${sharpbuf.info.size} bytes)`);
+                return `data:image/${sharpbuf.info.format};base64,${sharpbuf.data.toString('base64')}`;
+            }
+            // return the base64 string
+            return `data:${mimetype};base64,${buffer.toString('base64')}`;
+        };
+    }
+}
+exports.TranscriptImageDownloader = TranscriptImageDownloader;
+TranscriptImageDownloader.log = (0, debug_1.default)('discord-html-transcripts:TranscriptImageDownloader');
+//# sourceMappingURL=images.js.map

package/dist/downloader/images.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../../src/downloader/images.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,mCAAiC;AACjC,kDAA0B;AAe1B;;GAEG;AACH,MAAa,yBAAyB;IAAtC;QAEU,QAAG,GAAG,yBAAyB,CAAC,GAAG,CAAC;IAsF9C,CAAC;IA7EC;;;OAGG;IACH,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,OAAO,GAAG,EAAE,EAAE,aAAa,GAAG,KAAK,EAAE,UAAkD,EAAE;QACvG,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAEvF,uBAAuB;QACvB,kDAAO,OAAO,IAAE,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,CAAC,KAAK,CACX,8KAA8K,CAC/K,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,KAAK,EAAE,UAAU,EAAE,EAAE;YAC1B,iDAAiD;YACjD,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM;gBAAE,OAAO,SAAS,CAAC;YAE9D,0EAA0E;YAC1E,IAAI,IAAI,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI;gBAAE,OAAO,SAAS,CAAC;YAEpF,kBAAkB;YAClB,IAAI,CAAC,GAAG,CAAC,uBAAuB,UAAU,CAAC,EAAE,KAAK,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC;YACpE,MAAM,QAAQ,GAAG,MAAM,IAAA,gBAAO,EAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3D,OAAO,CAAC,KAAK,CAAC,sEAAsE,EAAE,GAAG,CAAC,CAAC;gBAC3F,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ;gBAAE,OAAO,SAAS,CAAC;YAEhC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACjF,IAAI,CAAC,GAAG,CAAC,qBAAqB,UAAU,CAAC,EAAE,KAAK,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;YAExE,yDAAyD;YACzD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAG,wDAAa,OAAO,GAAC,CAAC;gBAEpC,IAAI,CAAC,GAAG,CAAC,eAAe,UAAU,CAAC,EAAE,eAAe,CAAC,CAAC;gBACtD,MAAM,QAAQ,GAAG,MAAM,KAAK;qBACzB,OAAO,CAAC,MAAM,CAAC;qBACf,IAAI,iBACH,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EACjC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,aAAa,EACrC,MAAM,EAAE,CAAC,IACN,IAAI,CAAC,WAAW,CAAC,OAAO,EAC3B;qBACD,QAAQ,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;gBACzC,IAAI,CAAC,GAAG,CAAC,wBAAwB,UAAU,CAAC,EAAE,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC;gBAEhF,OAAO,cAAc,QAAQ,CAAC,IAAI,CAAC,MAAM,WAAW,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzF,CAAC;YAED,2BAA2B;YAC3B,OAAO,QAAQ,QAAQ,WAAW,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;;AAvFH,8DAwFC;AAvFgB,6BAAG,GAAG,IAAA,eAAK,EAAC,oDAAoD,CAAC,AAA9D,CAA+D"}

package/dist/generator/index.d.ts

@@ -0,0 +1,18 @@
+import { type Awaitable, type Channel, type Message, type Role, type User } from 'discord.js';
+import type { ResolveImageCallback } from '../downloader/images';
+export type RenderMessageContext = {
+    messages: Message[];
+    channel: Channel;
+    callbacks: {
+        resolveImageSrc: ResolveImageCallback;
+        resolveChannel: (channelId: string) => Awaitable<Channel | null>;
+        resolveUser: (userId: string) => Awaitable<User | null>;
+        resolveRole: (roleId: string) => Awaitable<Role | null>;
+    };
+    poweredBy?: boolean;
+    footerText?: string;
+    saveImages: boolean;
+    favicon: 'guild' | string;
+    hydrate: boolean;
+};
+export default function render({ messages, channel, callbacks, ...options }: RenderMessageContext): Promise<string>;

package/dist/generator/index.js

@@ -0,0 +1,71 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = render;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const static_1 = require("react-dom/static");
+const buildProfiles_1 = require("../utils/buildProfiles");
+const client_1 = require("../static/client");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const ssr_1 = require("@lit-labs/ssr");
+const transcript_1 = __importDefault(require("./transcript"));
+const utils_1 = require("../utils/utils");
+const render_result_1 = require("@lit-labs/ssr/lib/render-result");
+const styles_1 = require("./renderers/components/styles");
+const DiscordImage_1 = require("./renderers/components/DiscordImage");
+const DiscordHighlightedCode_1 = require("./renderers/components/DiscordHighlightedCode");
+// read the package.json file and get the @derockdev/discord-components-core version
+let discordComponentsVersion = '^4.0.2';
+try {
+    const packagePath = path_1.default.join(__dirname, '..', '..', 'package.json');
+    const packageJSON = JSON.parse((0, fs_1.readFileSync)(packagePath, 'utf8'));
+    discordComponentsVersion = (_a = packageJSON.dependencies['@skyra/discord-components-core']) !== null && _a !== void 0 ? _a : discordComponentsVersion;
+    // eslint-disable-next-line no-empty
+}
+catch (_b) { } // ignore errors
+async function render(_a) {
+    var _b;
+    var { messages, channel, callbacks } = _a, options = __rest(_a, ["messages", "channel", "callbacks"]);
+    const profiles = (0, buildProfiles_1.buildProfiles)(messages);
+    const { prelude } = await (0, static_1.prerenderToNodeStream)((0, jsx_runtime_1.jsxs)("html", { children: [(0, jsx_runtime_1.jsxs)("head", { children: [(0, jsx_runtime_1.jsx)("meta", { charSet: "utf-8" }), (0, jsx_runtime_1.jsx)("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }), (0, jsx_runtime_1.jsx)("link", { rel: "preconnect", href: "https://cdn.jsdelivr.net/" }), (0, jsx_runtime_1.jsx)("link", { rel: "preconnect", href: "https://cdn.discordapp.com" }), (0, jsx_runtime_1.jsx)("style", { dangerouslySetInnerHTML: { __html: client_1.ggSansFont } }), (0, jsx_runtime_1.jsx)("style", { dangerouslySetInnerHTML: { __html: styles_1.globalStyles } }), (0, jsx_runtime_1.jsx)("style", { dangerouslySetInnerHTML: { __html: DiscordImage_1.DiscordAttachmentStyles } }), (0, jsx_runtime_1.jsx)("style", { dangerouslySetInnerHTML: { __html: DiscordHighlightedCode_1.DiscordHighlightStyles } }), (0, jsx_runtime_1.jsx)("link", { rel: "icon", type: "image/png", href: options.favicon === 'guild'
+                            ? channel.isDMBased()
+                                ? undefined
+                                : ((_b = channel.guild.iconURL({ size: 16, extension: 'png' })) !== null && _b !== void 0 ? _b : undefined)
+                            : options.favicon }), (0, jsx_runtime_1.jsx)("title", { children: channel.isDMBased() ? 'Direct Messages' : channel.name }), (0, jsx_runtime_1.jsx)("script", { dangerouslySetInnerHTML: {
+                            __html: client_1.scrollToMessage,
+                        } }), !options.hydrate && ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("script", { dangerouslySetInnerHTML: {
+                                    __html: `globalThis.$discordMessage={profiles:${JSON.stringify(await profiles)}}`,
+                                } }), (0, jsx_runtime_1.jsx)("script", { type: "module", src: `https://cdn.jsdelivr.net/npm/@skyra/discord-components-core@${discordComponentsVersion}/+esm` })] }))] }), (0, jsx_runtime_1.jsx)("body", { style: {
+                    margin: 0,
+                    minHeight: '100vh',
+                }, children: (0, jsx_runtime_1.jsx)(transcript_1.default, Object.assign({ messages: messages, channel: channel, callbacks: callbacks }, options)) }), options.hydrate && (0, jsx_runtime_1.jsx)("script", { dangerouslySetInnerHTML: { __html: client_1.revealSpoiler } })] }));
+    const markup = await (0, utils_1.streamToString)(prelude);
+    if (options.hydrate) {
+        const result = (0, ssr_1.render)(markup);
+        // const result = await renderToString(markup, {
+        //   beforeHydrate: async (document) => {
+        //     document.defaultView.$discordMessage = {
+        //       profiles: await profiles,
+        //     };
+        //   },
+        // });
+        return await (0, render_result_1.collectResult)(result);
+    }
+    return markup;
+}
+//# sourceMappingURL=index.js.map

package/dist/generator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generator/index.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA2CA,yBAuFC;;AAjID,6CAAyD;AACzD,0DAAuD;AACvD,6CAA8E;AAC9E,2BAAkC;AAClC,gDAAwB;AACxB,uCAAoD;AACpD,8DAA2C;AAE3C,0CAAgD;AAChD,mEAAgE;AAChE,0DAA6D;AAC7D,sEAA8E;AAC9E,0FAAuF;AAEvF,oFAAoF;AACpF,IAAI,wBAAwB,GAAG,QAAQ,CAAC;AAExC,IAAI,CAAC;IACH,MAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IACrE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,wBAAwB,GAAG,MAAA,WAAW,CAAC,YAAY,CAAC,gCAAgC,CAAC,mCAAI,wBAAwB,CAAC;IAClH,oCAAoC;AACtC,CAAC;AAAC,WAAM,CAAC,CAAA,CAAC,CAAC,gBAAgB;AAoBZ,KAAK,UAAU,MAAM,CAAC,EAAkE;;QAAlE,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,OAAoC,EAA/B,OAAO,cAA1C,oCAA4C,CAAF;IAC7E,MAAM,QAAQ,GAAG,IAAA,6BAAa,EAAC,QAAQ,CAAC,CAAC;IAEzC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,8BAAqB,EAC7C,6CACE,6CACE,iCAAM,OAAO,EAAC,OAAO,GAAG,EACxB,iCAAM,IAAI,EAAC,UAAU,EAAC,OAAO,EAAC,qCAAqC,GAAG,EACtE,iCAAM,GAAG,EAAC,YAAY,EAAC,IAAI,EAAC,2BAA2B,GAAG,EAC1D,iCAAM,GAAG,EAAC,YAAY,EAAC,IAAI,EAAC,4BAA4B,GAAG,EAE3D,kCAAO,uBAAuB,EAAE,EAAE,MAAM,EAAE,mBAAU,EAAE,GAAI,EAC1D,kCAAO,uBAAuB,EAAE,EAAE,MAAM,EAAE,qBAAY,EAAE,GAAI,EAC5D,kCAAO,uBAAuB,EAAE,EAAE,MAAM,EAAE,sCAAuB,EAAE,GAAI,EACvE,kCAAO,uBAAuB,EAAE,EAAE,MAAM,EAAE,+CAAsB,EAAE,GAAI,EAGtE,iCACE,GAAG,EAAC,MAAM,EACV,IAAI,EAAC,WAAW,EAChB,IAAI,EACF,OAAO,CAAC,OAAO,KAAK,OAAO;4BACzB,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE;gCACnB,CAAC,CAAC,SAAS;gCACX,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,mCAAI,SAAS,CAAC;4BACxE,CAAC,CAAC,OAAO,CAAC,OAAO,GAErB,EAGF,4CAAQ,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,GAAS,EAGvE,mCACE,uBAAuB,EAAE;4BACvB,MAAM,EAAE,wBAAe;yBACxB,GACD,EAED,CAAC,OAAO,CAAC,OAAO,IAAI,CACnB,6DAEE,mCACE,uBAAuB,EAAE;oCACvB,MAAM,EAAE,wCAAwC,IAAI,CAAC,SAAS,CAAC,MAAM,QAAQ,CAAC,GAAG;iCAClF,GACO,EAEV,mCACE,IAAI,EAAC,QAAQ,EACb,GAAG,EAAE,+DAA+D,wBAAwB,OAAO,GAC3F,IACT,CACJ,IACI,EAEP,iCACE,KAAK,EAAE;oBACL,MAAM,EAAE,CAAC;oBACT,SAAS,EAAE,OAAO;iBACnB,YAED,uBAAC,oBAAe,kBAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,IAAM,OAAO,EAAI,GACvF,EAGN,OAAO,CAAC,OAAO,IAAI,mCAAQ,uBAAuB,EAAE,EAAE,MAAM,EAAE,sBAAa,EAAE,GAAW,IACpF,CACR,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAc,EAAC,OAAO,CAAC,CAAC;IAE7C,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,IAAA,YAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,gDAAgD;QAChD,yCAAyC;QACzC,+CAA+C;QAC/C,kCAAkC;QAClC,SAAS;QACT,OAAO;QACP,MAAM;QAEN,OAAO,MAAM,IAAA,6BAAa,EAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/generator/renderers/attachment.d.ts

@@ -0,0 +1,21 @@
+import type { Attachment as AttachmentType, Message } from 'discord.js';
+import type { RenderMessageContext } from '..';
+/**
+ * Renders all attachments for a message
+ * @param message
+ * @param context
+ * @returns
+ */
+export declare function Attachments(props: {
+    message: Message;
+    context: RenderMessageContext;
+}): Promise<import("react/jsx-runtime").JSX.Element | import("react/jsx-runtime").JSX.Element[]>;
+/**
+ * Renders one Discord Attachment
+ * @param props - the attachment and rendering context
+ */
+export declare function Attachment({ attachment, context, message, }: {
+    attachment: AttachmentType;
+    context: RenderMessageContext;
+    message: Message;
+}): Promise<import("react/jsx-runtime").JSX.Element>;