discord-transcriptify 0.0.0-stage → 1.0.0

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/NOTICE

@@ -0,0 +1,8 @@
+discord-transcriptify
+Copyright 2024-2026 cauahzz
+
+This product includes software developed as "discord-html-transcripts"
+(https://github.com/ItzDerock/discord-html-transcripts),
+Copyright Derock, licensed under the Apache License, Version 2.0.
+
+The source files have been modified from that work.

package/README.md

@@ -1,3 +1,291 @@
-# Temporary Holding Version
+# discord-transcriptify
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm version](https://img.shields.io/npm/v/discord-transcriptify)](https://www.npmjs.com/package/discord-transcriptify)
+[![npm downloads](https://img.shields.io/npm/dw/discord-transcriptify)](https://www.npmjs.com/package/discord-transcriptify)
+[![license](https://img.shields.io/npm/l/discord-transcriptify)](./LICENSE)
+
+Turn a Discord channel into a single HTML file that looks like Discord: same colours, same message
+grouping, same components. Built for [discord.js](https://discord.js.org) v14 and v15.
+
+```shell
+npm install discord-transcriptify
+```
+
+```js
+const { createTranscript } = require('discord-transcriptify');
+
+const attachment = await createTranscript(channel);
+await channel.send({ files: [attachment] });
+```
+
+![A support ticket exported with discord-transcriptify: an embed with buttons and a select menu, a reply with a quote and reactions, a code block and a poll](./.github/assets/conversation.png)
+
+## What it renders
+
+- **Messages** — Discord markdown (bold, quotes, code blocks, spoilers, timestamps), mentions in their
+  role colour, replies, edits, reactions, slash command headers, and consecutive messages from the
+  same author grouped under one header.
+- **Embeds** — every field, including author, footer, thumbnail and image.
+- **Components V2** — container (accent colour, spoiler), text display, section with a thumbnail or
+  button accessory, media gallery, file, separator, checkbox and radio group.
+- **Buttons and select menus** — all styles, link buttons, emoji and the disabled state. A select
+  menu opens on a click and lists its options, with their emoji and descriptions.
+- **Attachments** — images, videos and audio inline; several images as one grid; any other file as a
+  card with its name, size and a download link.
+- **Voice messages** — waveform, duration and a play button.
+- **Polls** — answers, vote bars and the poll result message. The closing time is shown as a date,
+  never as time left.
+- **Forwarded messages** — content, attachments, embeds and components of the forwarded snapshot.
+- **Threads** — the "started a thread" message with its preview, and optionally every message inside
+  the thread.
+- **Stickers** — PNG, APNG and GIF as images. Lottie stickers show a placeholder with the sticker
+  name, since they need a player script.
+- **System messages** — joins, pins, boosts and thread creation.
+- **Server tags** next to author names.
+
+![A Components V2 container with a section, a thumbnail, a media gallery and buttons, followed by a voice message, a file card and a thread preview](./.github/assets/components.png)
+
+The file also carries a small interface for whoever reads it: message search, a member list with
+message counts, a list of pinned messages, a list of the saved threads, a full-screen image preview
+and a side panel that opens a thread next to the channel. All of it can be [switched off](#interactive-ui).
+
+## Requirements
+
+- Node.js 18.17 or newer
+- discord.js v14 or v15
+- [`sharp`](https://sharp.pixelplumbing.com/) is optional. Install it only if you want embedded
+  images resized or compressed.
+
+## Usage
+
+### From a channel
+
+`createTranscript` fetches the messages for you.
+
+```js
+const { createTranscript } = require('discord-transcriptify');
+
+const attachment = await createTranscript(channel, {
+  limit: -1, // every message in the channel
+  saveImages: true, // embed images so the file does not depend on Discord's CDN
+});
+
+await channel.send({ files: [attachment] });
+```
+
+### From messages you already have
+
+```js
+const { generateFromMessages } = require('discord-transcriptify');
+
+const attachment = await generateFromMessages(messages, channel);
+```
+
+`messages` is an array or a discord.js `Collection` of messages.
+
+### Getting a string or a buffer
+
+```js
+const { createTranscript, ExportReturnType } = require('discord-transcriptify');
+
+const html = await createTranscript(channel, { returnType: ExportReturnType.String });
+```
+
+`returnType` accepts `'attachment'` (the default), `'buffer'` and `'string'`.
+
+## Options
+
+Every option is optional. All of them work with both functions, except `limit` and `filter`, which
+belong to `createTranscript`.
+
+| Option               | Default                            | What it does                                                                                                                 |
+| -------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `limit`              | `-1`                               | How many messages to fetch. `-1` fetches the whole channel.                                                                  |
+| `filter`             | none                               | `(message) => boolean`. Messages that return `false` are left out, thread messages included.                                 |
+| `returnType`         | `'attachment'`                     | `'attachment'`, `'buffer'` or `'string'`.                                                                                    |
+| `filename`           | `'transcript-{channel name}.html'` | File name of the attachment.                                                                                                 |
+| `saveImages`         | `false`                            | Download images and embed them in the file. See [Embedding images](#embedding-images).                                       |
+| `saveVoiceMessages`  | `false`                            | Download voice messages and embed them. Accepts `{ maxSizeKb, maxTotalSizeKb }`. See [Memory use](#memory-use).              |
+| `saveThreadMessages` | `false`                            | Fetch the messages of each thread and show them under its preview. Accepts `{ limit }`, default `500` per thread.            |
+| `fetchMembers`       | `true`                             | Ask Discord for the members behind the authors, so names show in their role colour. See [Role colours](#role-colours).       |
+| `ui`                 | `true`                             | The interactive interface. `false` removes it; an object switches single features. See [Interactive UI](#interactive-ui).    |
+| `hydrate`            | `false`                            | `true` renders the components on the server. With `false` the page loads the component scripts from a CDN when it is opened. |
+| `footerText`         | `'Exported {number} message{s}.'`  | Text of the footer.                                                                                                          |
+| `poweredBy`          | `true`                             | Show the "Powered by discord-transcriptify" line in the footer.                                                              |
+| `favicon`            | `'guild'`                          | `'guild'` uses the server icon; any other string is used as the icon URL.                                                    |
+| `callbacks`          | built in                           | Your own `resolveChannel`, `resolveUser`, `resolveRole`, `resolveImageSrc` and `resolveVoiceSrc`.                            |
+
+### Threads
+
+`saveThreadMessages` covers both kinds of thread: one started from a message and one created on its
+own, which the channel shows as a "started a thread" line. Each thread costs one extra API request
+per 100 messages. Up to three
+threads are fetched at a time. When a thread is longer than the limit, the most recent messages are
+kept and the transcript says how many were left out. A limit below `1` means no limit.
+
+### Role colours
+
+Messages fetched from a channel arrive without their member, and the role colour of an author lives
+on the member. With `fetchMembers` on, the uncached authors are requested from the gateway, 100 per
+request. If a request fails, the transcript is still generated and those names stay uncoloured. Pass
+`fetchMembers: false` to send no request at all.
+
+### Interactive UI
+
+By default the file includes a small amount of JavaScript. Each feature has its own switch:
+
+```js
+await createTranscript(channel, {
+  ui: {
+    imagePreview: true, // click an image to see it full-screen
+    search: true, // search the messages
+    memberList: true, // members and how many messages each one sent
+    pinnedMessages: true, // list of pinned messages
+    voicePlayer: true, // play button and waveform on voice messages
+    threadModal: true, // open a thread in a panel beside the channel, and list the saved threads in the header
+    serverTags: true, // server tag next to the author's name
+    selectMenus: true, // close an open select menu on a click elsewhere or Escape
+  },
+});
+```
+
+`ui: false` removes all of it. The transcript stays complete without scripts: voice messages fall
+back to the browser's audio controls and thread messages to a collapsible block. Select menus
+still open and close on a click.
+
+The scripts are self-contained: none is loaded from another site and none sends data anywhere. The
+server tag badge is an image served by Discord, like an avatar. Server tags do not appear with
+`hydrate: true`, because a server-rendered page carries no profile data for the script to read.
+
+### Embedding images
+
+With `saveImages: true`, images are downloaded and written into the file as data URLs. This covers
+image attachments, embed images, thumbnails, author and footer icons, and Components V2 media
+galleries and thumbnails. By default:
+
+- images are resized to fit 800×800 and compressed at 75% quality (JPEG and WebP; PNG stays lossless), if `sharp` is installed; without
+  it they are embedded untouched
+- files over 10 MB are skipped and keep their original URL
+- once the embedded images add up to 50 MB, the remaining ones keep their original URL
+- four images are downloaded at a time
+- GIF and SVG files are embedded as they are
+- videos are not embedded
+
+Pass an object to change the limits:
+
+```js
+saveImages: {
+  maxSizeKb: 5120, // per image
+  maxTotalSizeKb: 20480, // all images together
+  concurrency: 2, // downloads at the same time
+  quality: 60,
+  maxWidth: 1200,
+  maxHeight: 1200,
+},
+```
+
+For full control, give `resolveImageSrc` your own function. It is called once per image and returns
+a string to use as the image source, `undefined` to keep the original URL, or `null` to leave the
+image out of the transcript.
+
+The built-in downloader can also be configured and passed in:
+
+```js
+const { createTranscript, TranscriptImageDownloader } = require('discord-transcriptify');
+
+await createTranscript(channel, {
+  callbacks: {
+    resolveImageSrc: new TranscriptImageDownloader()
+      .withMaxSize(5120) // in KB, checked against the bytes actually received
+      .withMaxTotalSize(20480) // in KB, all images together
+      .withConcurrency(2) // downloads at the same time
+      .withMaxDimensions(1200, 1200) // resize to fit, needs sharp
+      .withCompression(60, true) // 60% quality, convert to webp, needs sharp
+      .withTimeout(10_000, 30_000) // headers and body timeouts, in ms
+      .build(),
+  },
+});
+```
+
+If neither `.withCompression()` nor `.withMaxDimensions()` is called, `sharp` is never loaded. The
+total set with `.withMaxTotalSize()` belongs to the function `.build()` returns, so build one per
+transcript.
+
+### Memory use
+
+Everything a transcript embeds is held in memory until the file is written, so a channel with many
+images can use more memory than a small bot has. Three limits keep that bounded, and all of them
+apply by default when `saveImages` is on:
+
+| Limit                       | Option                      | Default         |
+| --------------------------- | --------------------------- | --------------- |
+| Size of one image           | `saveImages.maxSizeKb`      | `10240` (10 MB) |
+| Size of all images together | `saveImages.maxTotalSizeKb` | `51200` (50 MB) |
+| Downloads running at once   | `saveImages.concurrency`    | `4`             |
+
+Voice messages have their own pair: `saveVoiceMessages.maxSizeKb` (default `25600`) and
+`saveVoiceMessages.maxTotalSizeKb` (default `51200`).
+
+The totals are counted on what ends up in the file, after compression. When a total is reached, the
+transcript is still generated: the remaining images or voice messages keep their Discord URL
+instead of being embedded. Zero or less turns a total, or the concurrency limit, off.
+
+On a bot with little memory, lower the totals and install `sharp`, which shrinks each image before
+it is embedded:
+
+```js
+await createTranscript(channel, {
+  saveImages: { maxTotalSizeKb: 10240, maxSizeKb: 2048, concurrency: 2 },
+});
+```
+
+The file itself is also built in memory, so expect a peak of a few times the size of the finished
+transcript. If that is still too much, do not embed at all: give `resolveImageSrc` a function that
+uploads the image to your own storage and returns its URL.
+
+## Security
+
+A transcript is built from content that anyone in the channel can write, so the library treats all
+of it as untrusted.
+
+**Markup is escaped.** Message content, names and every other value from Discord are rendered
+through React, so HTML in a message is shown as text and never executed.
+
+**Downloads are guarded.** A Components V2 gallery, a thumbnail or an embed can point at any URL,
+not only at Discord's CDN. When `saveImages` or `saveVoiceMessages` is on, the built-in downloader
+refuses:
+
+- any scheme other than `http:` and `https:`
+- loopback, private, link-local and reserved addresses, including the cloud metadata address
+  `169.254.169.254`. This applies to addresses written literally and to hostnames that resolve to
+  one, and it is checked when the connection is made, so DNS rebinding does not get past it
+- redirects
+- responses over the size limit, measured on the bytes received and not on the size the message
+  claims
+
+If your images really live on an internal host, opt out with
+`new TranscriptImageDownloader().withAllowPrivateNetwork()`. Only the address rule is relaxed. Do
+this only if you trust everyone who can post in the channel.
+
+A `resolveImageSrc` or `resolveVoiceSrc` function of your own gets none of these checks: validating
+the URLs it receives is up to you.
+
+## Development
+
+```shell
+npm install
+npm run build
+npm test
+```
+
+`npm test` needs no bot and no network. [tests/README.md](./tests/README.md) describes the rest.
+
+## Credits
+
+discord-transcriptify started from
+[discord-html-transcripts](https://github.com/ItzDerock/discord-html-transcripts), used under the
+Apache-2.0 license.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE).

package/dist/downloader/budget.d.ts

@@ -0,0 +1,26 @@
+/**
+ * A running total with a ceiling. Everything a transcript embeds stays in
+ * memory until the file is written, so the sum is what has to be bounded, not
+ * only each download.
+ */
+export declare class ByteBudget {
+    private readonly maxBytes;
+    private used;
+    private closed;
+    /** @param maxBytes Ceiling in bytes; zero or less means no ceiling. */
+    constructor(maxBytes: number);
+    private get limited();
+    get exhausted(): boolean;
+    /**
+     * Claims `bytes` if they still fit, and says whether they did. The first
+     * claim that does not fit closes the budget: looking for a smaller item that
+     * still fits would mean downloading every remaining one just to measure it.
+     */
+    take(bytes: number): boolean;
+}
+/**
+ * Runs at most `concurrency` tasks at a time and queues the rest, so the
+ * buffers of every download in a large transcript are not alive at once.
+ * Zero or less means no limit.
+ */
+export declare function createLimiter(concurrency: number): <T>(task: () => Promise<T>) => Promise<T>;

package/dist/downloader/budget.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByteBudget = void 0;
+exports.createLimiter = createLimiter;
+/**
+ * A running total with a ceiling. Everything a transcript embeds stays in
+ * memory until the file is written, so the sum is what has to be bounded, not
+ * only each download.
+ */
+class ByteBudget {
+    /** @param maxBytes Ceiling in bytes; zero or less means no ceiling. */
+    constructor(maxBytes) {
+        this.maxBytes = maxBytes;
+        this.used = 0;
+        this.closed = false;
+    }
+    get limited() {
+        return this.maxBytes > 0;
+    }
+    get exhausted() {
+        return this.closed;
+    }
+    /**
+     * Claims `bytes` if they still fit, and says whether they did. The first
+     * claim that does not fit closes the budget: looking for a smaller item that
+     * still fits would mean downloading every remaining one just to measure it.
+     */
+    take(bytes) {
+        if (this.closed)
+            return false;
+        if (this.limited && this.used + bytes > this.maxBytes) {
+            this.closed = true;
+            return false;
+        }
+        this.used += bytes;
+        return true;
+    }
+}
+exports.ByteBudget = ByteBudget;
+/**
+ * Runs at most `concurrency` tasks at a time and queues the rest, so the
+ * buffers of every download in a large transcript are not alive at once.
+ * Zero or less means no limit.
+ */
+function createLimiter(concurrency) {
+    if (!(concurrency > 0))
+        return (task) => task();
+    let running = 0;
+    const waiting = [];
+    return async (task) => {
+        // a finished task hands its slot straight to the next in line, so a newcomer cannot take it in between
+        if (running >= concurrency)
+            await new Promise((resolve) => waiting.push(resolve));
+        else
+            running++;
+        try {
+            return await task();
+        }
+        finally {
+            const next = waiting.shift();
+            if (next)
+                next();
+            else
+                running--;
+        }
+    };
+}
+//# sourceMappingURL=budget.js.map

package/dist/downloader/budget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"budget.js","sourceRoot":"","sources":["../../src/downloader/budget.ts"],"names":[],"mappings":";;;AAyCA,sCAkBC;AA3DD;;;;GAIG;AACH,MAAa,UAAU;IAIrB,uEAAuE;IACvE,YAA6B,QAAgB;QAAhB,aAAQ,GAAR,QAAQ,CAAQ;QAJrC,SAAI,GAAG,CAAC,CAAC;QACT,WAAM,GAAG,KAAK,CAAC;IAGyB,CAAC;IAEjD,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,KAAa;QAChB,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAC9B,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7BD,gCA6BC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,WAAmB;IAC/C,IAAI,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC;QAAE,OAAO,CAAI,IAAsB,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;IAErE,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,MAAM,OAAO,GAAmB,EAAE,CAAC;IAEnC,OAAO,KAAK,EAAK,IAAsB,EAAc,EAAE;QACrD,uGAAuG;QACvG,IAAI,OAAO,IAAI,WAAW;YAAE,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;;YACnF,OAAO,EAAE,CAAC;QACf,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,IAAI;gBAAE,IAAI,EAAE,CAAC;;gBACZ,OAAO,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/downloader/fetch.d.ts

@@ -0,0 +1,22 @@
+export type GuardedFetchOptions = {
+    /** Largest body to accept, in bytes. */
+    maxBytes: number;
+    /** Lifts the internal-address rule; the protocol check always applies. @default false */
+    allowPrivateNetwork?: boolean;
+    /** Time to wait for response headers, in milliseconds. @default 10000 */
+    headersTimeout?: number;
+    /** Time to wait for the response body, in milliseconds. @default 30000 */
+    bodyTimeout?: number;
+};
+export type GuardedFetchResult = {
+    buffer: Buffer;
+    contentType: string | undefined;
+};
+/**
+ * Downloads a URL with the SSRF guard and a size cap that holds regardless of
+ * what the server (or the message) claims. Every network fetch in this package
+ * goes through here.
+ *
+ * Resolves to null whenever the download is refused, fails or is too big.
+ */
+export declare function fetchGuarded(url: string, options: GuardedFetchOptions): Promise<GuardedFetchResult | null>;