pm2-token-bucket 1.0.0

package/LICENSE

@@ -0,0 +1,437 @@
+Attribution-NonCommercial-ShareAlike 4.0 International
+
+=======================================================================
+
+Creative Commons Corporation ("Creative Commons") is not a law firm and
+does not provide legal services or legal advice. Distribution of
+Creative Commons public licenses does not create a lawyer-client or
+other relationship. Creative Commons makes its licenses and related
+information available on an "as-is" basis. Creative Commons gives no
+warranties regarding its licenses, any material licensed under their
+terms and conditions, or any related information. Creative Commons
+disclaims all liability for damages resulting from their use to the
+fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and
+conditions that creators and other rights holders may use to share
+original works of authorship and other material subject to copyright
+and certain other rights specified in the public license below. The
+following considerations are for informational purposes only, are not
+exhaustive, and do not form part of our licenses.
+
+     Considerations for licensors: Our public licenses are
+     intended for use by those authorized to give the public
+     permission to use material in ways otherwise restricted by
+     copyright and certain other rights. Our licenses are
+     irrevocable. Licensors should read and understand the terms
+     and conditions of the license they choose before applying it.
+     Licensors should also secure all rights necessary before
+     applying our licenses so that the public can reuse the
+     material as expected. Licensors should clearly mark any
+     material not subject to the license. This includes other CC-
+     licensed material, or material used under an exception or
+     limitation to copyright. More considerations for licensors:
+    wiki.creativecommons.org/Considerations_for_licensors
+
+     Considerations for the public: By using one of our public
+     licenses, a licensor grants the public permission to use the
+     licensed material under specified terms and conditions. If
+     the licensor's permission is not necessary for any reason--for
+     example, because of any applicable exception or limitation to
+     copyright--then that use is not regulated by the license. Our
+     licenses grant only permissions under copyright and certain
+     other rights that a licensor has authority to grant. Use of
+     the licensed material may still be restricted for other
+     reasons, including because others have copyright or other
+     rights in the material. A licensor may make special requests,
+     such as asking that all changes be marked or described.
+     Although not required by our licenses, you are encouraged to
+     respect those requests where reasonable. More considerations
+     for the public:
+    wiki.creativecommons.org/Considerations_for_licensees
+
+=======================================================================
+
+Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
+Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-NonCommercial-ShareAlike 4.0 International Public License
+("Public License"). To the extent this Public License may be
+interpreted as a contract, You are granted the Licensed Rights in
+consideration of Your acceptance of these terms and conditions, and the
+Licensor grants You such rights in consideration of benefits the
+Licensor receives from making the Licensed Material available under
+these terms and conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. BY-NC-SA Compatible License means a license listed at
+     creativecommons.org/compatiblelicenses, approved by Creative
+     Commons as essentially the equivalent of this Public License.
+
+  d. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  e. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  f. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  g. License Elements means the license attributes listed in the name
+     of a Creative Commons Public License. The License Elements of this
+     Public License are Attribution, NonCommercial, and ShareAlike.
+
+  h. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  i. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  j. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  k. NonCommercial means not primarily intended for or directed towards
+     commercial advantage or monetary compensation. For purposes of
+     this Public License, the exchange of the Licensed Material for
+     other material subject to Copyright and Similar Rights by digital
+     file-sharing or similar means is NonCommercial provided there is
+     no payment of monetary compensation in connection with the
+     exchange.
+
+  l. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  m. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  n. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part, for NonCommercial purposes only; and
+
+            b. produce, reproduce, and Share Adapted Material for
+               NonCommercial purposes only.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. Additional offer from the Licensor -- Adapted Material.
+               Every recipient of Adapted Material from You
+               automatically receives an offer from the Licensor to
+               exercise the Licensed Rights in the Adapted Material
+               under the conditions of the Adapter's License You apply.
+
+            c. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties, including when
+          the Licensed Material is used other than for NonCommercial
+          purposes.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+  b. ShareAlike.
+
+     In addition to the conditions in Section 3(a), if You Share
+     Adapted Material You produce, the following conditions also apply.
+
+       1. The Adapter's License You apply must be a Creative Commons
+          license with the same License Elements, this version or
+          later, or a BY-NC-SA Compatible License.
+
+       2. You must include the text of, or the URI or hyperlink to, the
+          Adapter's License You apply. You may satisfy this condition
+          in any reasonable manner based on the medium, means, and
+          context in which You Share Adapted Material.
+
+       3. You may not offer or impose any additional or different terms
+          or conditions on, or apply any Effective Technological
+          Measures to, Adapted Material that restrict exercise of the
+          rights granted under the Adapter's License You apply.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database for NonCommercial purposes
+     only;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material,
+     including for purposes of Section 3(b); and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+
+=======================================================================
+
+Creative Commons is not a party to its public
+licenses. Notwithstanding, Creative Commons may elect to apply one of
+its public licenses to material it publishes and in those instances
+will be considered the “Licensor.” The text of the Creative Commons
+public licenses is dedicated to the public domain under the CC0 Public
+Domain Dedication. Except for the limited purpose of indicating that
+material is shared under a Creative Commons public license or as
+otherwise permitted by the Creative Commons policies published at
+creativecommons.org/policies, Creative Commons does not authorize the
+use of the trademark "Creative Commons" or any other trademark or logo
+of Creative Commons without its prior written consent including,
+without limitation, in connection with any unauthorized modifications
+to any of its public licenses or any other arrangements,
+understandings, or agreements concerning use of licensed material. For
+the avoidance of doubt, this paragraph does not form part of the
+public licenses.
+
+Creative Commons may be contacted at creativecommons.org.

package/README.md

@@ -0,0 +1,211 @@
+# PM2 Token Bucket
+ 
+Token bucket server for API throttling shared between instances using [PM2](https://pm2.keymetrics.io/) clusters.
+
+## Why?
+
+When running a Node.js application in PM2 cluster mode, each instance operates independently.  
+If your app calls a rate-limited external API, every instance competes for the same quota — easily exceeding limits.
+
+**PM2 Token Bucket** solves this by running a dedicated token server as a separate PM2 process.  
+All cluster instances request tokens from this central server via PM2's built-in IPC bus, ensuring a single, shared rate limit across your entire cluster.
+
+```
+┌──────────────────────────────────────────┐
+│              PM2 Ecosystem               │
+│                                          │
+│   ┌──────────────────────────────────┐   │
+│   │    TokenManager (server.js app)  │   │
+│   │    Manages the shared bucket     │   │
+│   └──────────────────────────────────┘   │
+│              ▲                           │
+│              │                           │
+│              │ PM2 IPC Bus               │
+│              │                           │
+│     ┌────────┼────────┐                  │
+│     ▼        ▼        ▼                  │
+│  ┌──────┐ ┌──────┐ ┌──────┐              │
+│  │ App  │ │ App  │ │ App  │              │
+│  │ #0   │ │ #1   │ │ #2   │  (cluster)   │
+│  └──────┘ └──────┘ └──────┘              │
+└──────────────────────────────────────────┘
+```
+
+## Installation
+
+```bash
+npm install pm2-token-bucket
+```
+
+> **Peer dependency:** `pm2 >= 6.0.0`
+
+## Quick Start
+
+You can see an example in the `example` directory of this repo, but here’s a quick overview of how to set it up:
+
+### 1. Create the Token Server
+
+Create a dedicated PM2 process that manages the shared token bucket.
+
+```js
+// server.js
+const { TokenManager } = require('pm2-token-bucket');
+
+const tokenManager = new TokenManager({
+    capacity: 10,          // Max tokens in the bucket
+    refillRate: 1,         // Tokens added per refill
+    refillInterval: 3000   // Refill every 3 seconds
+});
+
+tokenManager.start((err) => {
+    if (err) {
+        console.error("Failed to start TokenManager:", err);
+    }
+});
+```
+
+### 2. Consume Tokens in Your App
+
+In your cluster application instances, use `TokenClient` to request tokens before making API calls.
+
+```js
+// app.js
+const express = require('express');
+const { TokenClient } = require('pm2-token-bucket');
+
+const app = express();
+const tokenClient = new TokenClient();
+
+app.use(async (req, res, next) => {
+    try {
+        if (await tokenClient.consume(1)) {
+            next(); // Token granted — proceed
+        } else {
+            res.status(429).send('Too many requests');
+        }
+    } catch (err) {
+        next(); // Fallback: allow on error
+    }
+});
+
+app.get('/', (req, res) => {
+    res.sendStatus(200);
+});
+
+app.listen(process.env.PORT || 3000);
+```
+
+### 3. Configure PM2 Ecosystem
+
+Launch you app X times in cluster mode, and add 1 token server as a separate process.
+
+```js
+// ecosystem.config.js
+module.exports = {
+    apps: [{
+        name: "tokenServer",
+        script: "./server.js"
+    }, {
+        name: "clientApp",
+        script: "./app.js",
+        instances: 3,
+        exec_mode: "cluster"
+    }]
+};
+```
+
+### 4. Start Everything
+
+```bash
+pm2 start ecosystem.config.js
+```
+
+## API Reference
+
+### `TokenManager`
+
+The server-side class that manages the token bucket.  
+Run this in a separate, single PM2 process.
+
+#### `new TokenManager(options?)`
+
+| Option           | Type     | Default | Description                              |
+| ---------------- | -------- | ------- | ---------------------------------------- |
+| `capacity`       | `number` | `100`   | Maximum number of tokens in the bucket   |
+| `refillRate`     | `number` | `10`    | Number of tokens added per refill cycle  |
+| `refillInterval` | `number` | `1000`  | Milliseconds between each refill cycle   |
+
+#### `tokenManager.start(errCallback?)`
+
+Connects to the PM2 bus and starts listening for token requests from cluster instances.
+
+- `errCallback` *(optional)* — Called with an `Error` if the PM2 bus connection fails.
+
+#### `tokenManager.getStatus()`
+
+Returns the current state of the bucket:
+
+```js
+{
+    tokens: 8,           // Current available tokens
+    capacity: 10,        // Maximum capacity
+    refillRate: 1,       // Tokens per refill
+    refillInterval: 3000 // Refill interval in ms
+}
+```
+
+---
+
+### `TokenClient`
+
+The client-side class used within your cluster instances to request tokens.
+
+#### `new TokenClient()`
+
+Creates a new client and starts listening for responses from the `TokenManager`.
+
+#### `tokenClient.consume(amount?)`
+
+Requests tokens from the `TokenManager`.
+
+| Parameter | Type     | Default | Description                     |
+| --------- | -------- | ------- | ------------------------------- |
+| `amount`  | `number` | `1`     | Number of tokens to consume     |
+
+**Returns:** `Promise<boolean>`
+
+- `true` — tokens were granted
+- `false` — not enough tokens available (rate limited)
+- `true` *(on timeout)* — if the `TokenManager` doesn't respond within 500ms, the request is allowed as a safety fallback
+
+> **Note:** If the process is not running under PM2 (i.e. `process.send` is unavailable), `consume()` always resolves to `true`, making it safe to use in development without PM2.
+
+## How It Works
+
+1. The TokenManager runs as a standalone PM2 process and holds a token bucket that refills at a configurable rate.
+2. Each TokenClient instance (in your clustered app) sends a token request over PM2's IPC bus.
+3. The TokenManager checks the bucket, deducts tokens if available, and sends back an `allowed` / `denied` response.
+4. The TokenClient resolves its `consume()` promise accordingly.
+
+All communication happens through PM2's built-in inter-process messaging — no external dependencies like Redis or HTTP servers required.
+
+## Running the Example
+
+```bash
+# Clone the repo and install dependencies
+npm install
+
+# Build the TypeScript source
+npm run build
+
+# Start the example with PM2 and run a load test
+cd example
+pm2 start ecosystem.config.js
+npx loadtest -n 30 -c 10 http://localhost:3000/
+```
+
+## License
+
+This project is licensed under CC BY-NC-SA.
+
+![CC BY-NC-SA](https://mirrors.creativecommons.org/presskit/buttons/88x31/png/by-nc-sa.png)

package/dist/Bucket.d.ts

@@ -0,0 +1,41 @@
+export default class Bucket {
+    private capacity;
+    private refillRate;
+    private refillInterval;
+    private tokens;
+    private lastRefill;
+    /**
+     * Create a new bucket
+     * @param capacity - Maximum tokens in the bucket and the initial quantity (ex: 100)
+     * @param refillRate - Number of tokens added at each refill (ex: 10)
+     * @param refillInterval - Time in milliseconds between each refill (ex: 1000 for 1 second)
+     */
+    constructor(capacity: number, refillRate: number, refillInterval: number);
+    /**
+     * Refill the bucket based on the time elapsed since the last refill
+     */
+    private _refill;
+    /**
+     * Try to remove a certain number of tokens from the bucket
+     * @param count - Number of tokens to remove (default: 1)
+     * @returns True if the tokens were removed, false otherwise
+     */
+    tryRemove(count?: number): boolean;
+    /**
+     * Get the current number of tokens
+     */
+    getTokens(): number;
+    /**
+     * Get the capacity of the bucket
+     */
+    getCapacity(): number;
+    /**
+     * Get the refill rate
+     */
+    getRefillRate(): number;
+    /**
+     * Get the refill interval
+     */
+    getRefillInterval(): number;
+}
+//# sourceMappingURL=Bucket.d.ts.map

package/dist/Bucket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bucket.d.ts","sourceRoot":"","sources":["../src/Bucket.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM;IAQxE;;OAEG;IACH,OAAO,CAAC,OAAO;IAOf;;;;OAIG;IACH,SAAS,CAAC,KAAK,GAAE,MAAU,GAAG,OAAO;IASrC;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,WAAW,IAAI,MAAM;IAIrB;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,iBAAiB,IAAI,MAAM;CAG9B"}

package/dist/Bucket.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Bucket {
+    /**
+     * Create a new bucket
+     * @param capacity - Maximum tokens in the bucket and the initial quantity (ex: 100)
+     * @param refillRate - Number of tokens added at each refill (ex: 10)
+     * @param refillInterval - Time in milliseconds between each refill (ex: 1000 for 1 second)
+     */
+    constructor(capacity, refillRate, refillInterval) {
+        this.capacity = capacity;
+        this.refillRate = refillRate;
+        this.refillInterval = refillInterval;
+        this.tokens = capacity;
+        this.lastRefill = Date.now();
+    }
+    /**
+     * Refill the bucket based on the time elapsed since the last refill
+     */
+    _refill() {
+        const now = Date.now();
+        const delta = (now - this.lastRefill) / this.refillInterval;
+        this.tokens = Math.min(this.capacity, this.tokens + Math.round(delta * this.refillRate));
+        this.lastRefill = now;
+    }
+    /**
+     * Try to remove a certain number of tokens from the bucket
+     * @param count - Number of tokens to remove (default: 1)
+     * @returns True if the tokens were removed, false otherwise
+     */
+    tryRemove(count = 1) {
+        this._refill();
+        if (this.tokens >= count) {
+            this.tokens -= count;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Get the current number of tokens
+     */
+    getTokens() {
+        return this.tokens;
+    }
+    /**
+     * Get the capacity of the bucket
+     */
+    getCapacity() {
+        return this.capacity;
+    }
+    /**
+     * Get the refill rate
+     */
+    getRefillRate() {
+        return this.refillRate;
+    }
+    /**
+     * Get the refill interval
+     */
+    getRefillInterval() {
+        return this.refillInterval;
+    }
+}
+exports.default = Bucket;
+//# sourceMappingURL=Bucket.js.map

package/dist/Bucket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bucket.js","sourceRoot":"","sources":["../src/Bucket.ts"],"names":[],"mappings":";;AAAA,MAAqB,MAAM;IAOvB;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,UAAkB,EAAE,cAAsB;QACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,OAAO;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACzF,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAgB,CAAC;QACvB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC;YACrB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,aAAa;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,iBAAiB;QACb,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;CACJ;AAxED,yBAwEC"}

package/dist/Client.d.ts

@@ -0,0 +1,20 @@
+/**
+ * TokenClient class that allows PM2 processes to request tokens from the TokenManager
+ * running in the PM2 cluster. It handles sending requests and receiving responses
+ * asynchronously using Promises.
+ */
+export default class TokenClient {
+    private pendingRequests;
+    constructor();
+    /**
+     * Method to consume tokens by sending a request to the TokenManager and returning a Promise
+     * @param amount - The number of tokens to consume (default is 1)
+     * @returns Resolves to true if tokens are granted, false if denied, or true on timeout/fallback
+     */
+    consume(amount?: number): Promise<boolean>;
+    /**
+     * Listen for responses from the manager and resolve the corresponding promises
+     */
+    private _listen;
+}
+//# sourceMappingURL=Client.d.ts.map

package/dist/Client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../src/Client.ts"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC5B,OAAO,CAAC,eAAe,CAA2C;;IAOlE;;;;OAIG;IACH,OAAO,CAAC,MAAM,GAAE,MAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAqC7C;;OAEG;IACH,OAAO,CAAC,OAAO;CAalB"}

package/dist/Client.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = __importDefault(require("crypto"));
+const config_1 = __importDefault(require("./config"));
+/**
+ * TokenClient class that allows PM2 processes to request tokens from the TokenManager
+ * running in the PM2 cluster. It handles sending requests and receiving responses
+ * asynchronously using Promises.
+ */
+class TokenClient {
+    constructor() {
+        this.pendingRequests = new Map();
+        this._listen();
+    }
+    /**
+     * Method to consume tokens by sending a request to the TokenManager and returning a Promise
+     * @param amount - The number of tokens to consume (default is 1)
+     * @returns Resolves to true if tokens are granted, false if denied, or true on timeout/fallback
+     */
+    consume(amount = 1) {
+        return new Promise((resolve) => {
+            // Handle the case where PM2 is not available
+            if (!process.send) {
+                return resolve(true);
+            }
+            // Get a unique ID for this request
+            const requestID = crypto_1.default.randomUUID();
+            // Security timeout to prevent hanging if the token manager doesn't respond
+            const timeout = setTimeout(() => {
+                console.warn("Request timed out ! ID:", requestID);
+                if (this.pendingRequests.has(requestID)) {
+                    resolve(true);
+                    this.pendingRequests.delete(requestID);
+                }
+            }, config_1.default.DEFAULT_TIMEOUT);
+            // Store the resolve function in the pendingRequests Map with the request ID
+            this.pendingRequests.set(requestID, (response) => {
+                clearTimeout(timeout);
+                resolve(response);
+            });
+            // Send a message to the TokenManager with the request details
+            process.send({
+                type: 'process:msg',
+                data: {
+                    topic: config_1.default.TOPIC_ASK,
+                    id: requestID,
+                    amount
+                }
+            });
+        });
+    }
+    /**
+     * Listen for responses from the manager and resolve the corresponding promises
+     */
+    _listen() {
+        process.on('message', (packet) => {
+            if (packet.data && packet.data.topic === config_1.default.TOPIC_RESPONSE) {
+                const requestId = packet.data.id;
+                const allowed = packet.data.allowed;
+                const resolve = this.pendingRequests.get(requestId);
+                if (resolve) {
+                    resolve(allowed);
+                    this.pendingRequests.delete(requestId);
+                }
+            }
+        });
+    }
+}
+exports.default = TokenClient;
+//# sourceMappingURL=Client.js.map

package/dist/Client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../src/Client.ts"],"names":[],"mappings":";;;;;AAAA,oDAA4B;AAC5B,sDAA8B;AAU9B;;;;GAIG;AACH,MAAqB,WAAW;IAG5B;QACI,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,SAAiB,CAAC;QACtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,6CAA6C;YAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBAChB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;YAED,mCAAmC;YACnC,MAAM,SAAS,GAAG,gBAAM,CAAC,UAAU,EAAE,CAAC;YAEtC,2EAA2E;YAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,CAAC;gBACnD,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;oBACtC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACd,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3C,CAAC;YACL,CAAC,EAAE,gBAAM,CAAC,eAAe,CAAC,CAAC;YAE3B,4EAA4E;YAC5E,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,QAAiB,EAAE,EAAE;gBACtD,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,8DAA8D;YAC9D,OAAO,CAAC,IAAI,CAAC;gBACT,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE;oBACF,KAAK,EAAE,gBAAM,CAAC,SAAS;oBACvB,EAAE,EAAE,SAAS;oBACb,MAAM;iBACT;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,OAAO;QACX,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,MAAiB,EAAE,EAAE;YACxC,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,gBAAM,CAAC,cAAc,EAAE,CAAC;gBAC7D,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACpD,IAAI,OAAO,EAAE,CAAC;oBACV,OAAO,CAAC,OAAO,CAAC,CAAC;oBACjB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3C,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAlED,8BAkEC"}

package/dist/Manager.d.ts

@@ -0,0 +1,40 @@
+interface TokenManagerOptions {
+    /** Maximum tokens in the bucket (default: 100) */
+    capacity?: number;
+    /** Tokens added per refill (default: 10) */
+    refillRate?: number;
+    /** Time in milliseconds between each refill (default: 1000) */
+    refillInterval?: number;
+}
+interface BucketStatus {
+    tokens: number;
+    capacity: number;
+    refillRate: number;
+    refillInterval: number;
+}
+/**
+ * TokenManager class that manages the token bucket and handles communication with PM2 processes
+ */
+export default class TokenManager {
+    private bucket;
+    constructor(options?: TokenManagerOptions);
+    /**
+     * Start the TokenManager and connect to PM2 bus to listen for token requests
+     * @param errCallback - Optional callback for handling connection errors
+     */
+    start(errCallback?: (err: Error) => void): void;
+    /**
+     * Handle incoming messages from PM2 processes
+     */
+    private _handleMessage;
+    /**
+     * Send a response back to the requesting process in the PM2 cluster
+     */
+    private _sendResponse;
+    /**
+     * Get the current status of the token bucket
+     */
+    getStatus(): BucketStatus;
+}
+export {};
+//# sourceMappingURL=Manager.d.ts.map

package/dist/Manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Manager.d.ts","sourceRoot":"","sources":["../src/Manager.ts"],"names":[],"mappings":"AAIA,UAAU,mBAAmB;IACzB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAaD,UAAU,YAAY;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC7B,OAAO,CAAC,MAAM,CAAS;gBAEX,OAAO,GAAE,mBAAwB;IAQ7C;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI;IAa/C;;OAEG;IACH,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,OAAO,CAAC,aAAa;IAiBrB;;OAEG;IACH,SAAS,IAAI,YAAY;CAQ5B"}

package/dist/Manager.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const pm2_1 = __importDefault(require("pm2"));
+const Bucket_1 = __importDefault(require("./Bucket"));
+const config_1 = __importDefault(require("./config"));
+/**
+ * TokenManager class that manages the token bucket and handles communication with PM2 processes
+ */
+class TokenManager {
+    constructor(options = {}) {
+        this.bucket = new Bucket_1.default(options.capacity ?? config_1.default.DEFAULT_CAPACITY, options.refillRate ?? config_1.default.DEFAULT_REFILL_RATE, options.refillInterval ?? config_1.default.DEFAULT_REFILL_INTERVAL);
+    }
+    /**
+     * Start the TokenManager and connect to PM2 bus to listen for token requests
+     * @param errCallback - Optional callback for handling connection errors
+     */
+    start(errCallback) {
+        pm2_1.default.launchBus((err, bus) => {
+            if (err) {
+                if (errCallback)
+                    errCallback(err);
+                return;
+            }
+            bus.on('process:msg', (packet) => {
+                this._handleMessage(packet);
+            });
+        });
+    }
+    /**
+     * Handle incoming messages from PM2 processes
+     */
+    _handleMessage(packet) {
+        if (packet.data.topic === config_1.default.TOPIC_ASK) {
+            const requestId = packet.data.id;
+            const amount = packet.data.amount || 1;
+            const allowed = this.bucket.tryRemove(amount);
+            this._sendResponse(packet.process.pm_id, requestId, allowed);
+        }
+    }
+    /**
+     * Send a response back to the requesting process in the PM2 cluster
+     */
+    _sendResponse(processId, requestId, allowed) {
+        pm2_1.default.sendDataToProcessId(processId, {
+            id: processId,
+            type: 'process:msg',
+            topic: config_1.default.TOPIC_RESPONSE,
+            data: {
+                topic: config_1.default.TOPIC_RESPONSE,
+                id: requestId,
+                allowed: allowed
+            }
+        }, (err) => {
+            if (err) {
+                console.error('[PM2 Token Bucket] send response error', err);
+            }
+        });
+    }
+    /**
+     * Get the current status of the token bucket
+     */
+    getStatus() {
+        return {
+            tokens: this.bucket.getTokens(),
+            capacity: this.bucket.getCapacity(),
+            refillRate: this.bucket.getRefillRate(),
+            refillInterval: this.bucket.getRefillInterval()
+        };
+    }
+}
+exports.default = TokenManager;
+//# sourceMappingURL=Manager.js.map

package/dist/Manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Manager.js","sourceRoot":"","sources":["../src/Manager.ts"],"names":[],"mappings":";;;;;AAAA,8CAAsB;AACtB,sDAA8B;AAC9B,sDAA8B;AA6B9B;;GAEG;AACH,MAAqB,YAAY;IAG7B,YAAY,UAA+B,EAAE;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CACpB,OAAO,CAAC,QAAQ,IAAI,gBAAM,CAAC,gBAAgB,EAC3C,OAAO,CAAC,UAAU,IAAI,gBAAM,CAAC,mBAAmB,EAChD,OAAO,CAAC,cAAc,IAAI,gBAAM,CAAC,uBAAuB,CAC3D,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAkC;QACpC,aAAG,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACvB,IAAI,GAAG,EAAE,CAAC;gBACN,IAAI,WAAW;oBAAE,WAAW,CAAC,GAAG,CAAC,CAAC;gBAClC,OAAO;YACX,CAAC;YAED,GAAG,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,MAAoB,EAAE,EAAE;gBAC3C,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,MAAoB;QACvC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,gBAAM,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;YACvC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACjE,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,SAAiB,EAAE,SAAiB,EAAE,OAAgB;QACxE,aAAG,CAAC,mBAAmB,CAAC,SAAS,EAAE;YAC/B,EAAE,EAAE,SAAS;YACb,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,gBAAM,CAAC,cAAc;YAC5B,IAAI,EAAE;gBACF,KAAK,EAAE,gBAAM,CAAC,cAAc;gBAC5B,EAAE,EAAE,SAAS;gBACb,OAAO,EAAE,OAAO;aACnB;SACG,EAAE,CAAC,GAAG,EAAE,EAAE;YACd,IAAI,GAAG,EAAE,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,GAAG,CAAC,CAAC;YACjE,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,SAAS;QACL,OAAO;YACH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC/B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;YACnC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YACvC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;SAClD,CAAC;IACN,CAAC;CACJ;AAvED,+BAuEC"}

package/dist/config.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    TOPIC_ASK: string;
+    TOPIC_RESPONSE: string;
+    DEFAULT_CAPACITY: number;
+    DEFAULT_REFILL_RATE: number;
+    DEFAULT_REFILL_INTERVAL: number;
+    DEFAULT_TIMEOUT: number;
+};
+export default _default;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;;;;AAEA,wBAOE"}

package/dist/config.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const TOPIC_PREFIX = 'pm2TokenBucket';
+exports.default = {
+    TOPIC_ASK: `${TOPIC_PREFIX}:ask`,
+    TOPIC_RESPONSE: `${TOPIC_PREFIX}:response`,
+    DEFAULT_CAPACITY: 100,
+    DEFAULT_REFILL_RATE: 10,
+    DEFAULT_REFILL_INTERVAL: 1000,
+    DEFAULT_TIMEOUT: 500,
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAAA,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAEtC,kBAAe;IACX,SAAS,EAAE,GAAG,YAAY,MAAM;IAChC,cAAc,EAAE,GAAG,YAAY,WAAW;IAC1C,gBAAgB,EAAE,GAAG;IACrB,mBAAmB,EAAE,EAAE;IACvB,uBAAuB,EAAE,IAAI;IAC7B,eAAe,EAAE,GAAG;CACvB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import TokenClient from "./Client";
+import TokenManager from "./Manager";
+export { TokenClient, TokenManager };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,UAAU,CAAC;AACnC,OAAO,YAAY,MAAM,WAAW,CAAC;AAErC,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenManager = exports.TokenClient = void 0;
+const Client_1 = __importDefault(require("./Client"));
+exports.TokenClient = Client_1.default;
+const Manager_1 = __importDefault(require("./Manager"));
+exports.TokenManager = Manager_1.default;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAmC;AAG3B,sBAHD,gBAAW,CAGC;AAFnB,wDAAqC;AAEhB,uBAFd,iBAAY,CAEc"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "pm2-token-bucket",
+  "version": "1.0.0",
+  "description": "Token bucket server for API throttling shared between instances using PM2 clusters.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Higink/pm2-token-bucket"
+  },
+  "license": "CC BY-NC-SA",
+  "author": "Higink <higink@gmail.com>",
+  "keywords": [
+    "token bucket",
+    "rate limiting",
+    "API throttling",
+    "PM2",
+    "PM2 clusters"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "prepublishOnly": "npm run build && npm test",
+    "example": "npm install && npm run build && cd example && pm2 start && loadtest -n 30 -c 10 http://localhost:3000/ && pm2 logs"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.0.0",
+    "express": "^5.2.1",
+    "ts-jest": "^29.4.6",
+    "jest": "^30.2.0",
+    "loadtest": "^8.2.1",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "pm2": "^6.0.0"
+  }
+}