chore: finish ESM migration

Author: Lemmmy

.idea/krist.js.iml

@@ -11,15 +11,17 @@
   "license": "GPL-3.0",
   "private": false,
   "type": "module",
+  "main": "lib/cjs/src/node.js",
   "exports": {
     ".": {
-      "import": "./lib/src/node.js",
-      "default": "./lib/src/node.js",
+      "import": "./lib/esm/src/node.js",
+      "default": "./lib/esm/src/node.js",
+      "require": "./lib/cjs/src/node.js",
       "browser": "./lib/browser.js",
-      "und": "./lib/browser.js"
+      "umd": "./lib/browser.js"
     }
   },
-  "types": "lib/src/node.d.ts",
+  "types": "lib/esm/src/node.d.ts",
   "files": [
     "lib/**/*.{ts,js}",
     "README.md",
@@ -33,8 +35,9 @@
   },
   "scripts": {
     "clean": "rimraf lib",
-    "build": "yarn run clean && yarn run build:node && yarn run build:browser",
-    "build:node": "tsc -p tsconfig.json",
+    "build": "yarn run clean && yarn run build:node-esm && yarn run build:node-cjs && yarn run build:browser",
+    "build:node-esm": "tsc -p tsconfig.json",
+    "build:node-cjs": "tsc -p tsconfig.cjs.json",
     "build:browser": "rollup --config rollup.config.js",
     "test": "cross-env TSX_TSCONFIG_PATH='./tsconfig.test.json' NODE_ENV=test mocha",
     "test:coverage": "nyc yarn run test",
@@ -46,8 +49,7 @@
     "@aws-crypto/sha256-js": "^5.2.0",
     "axios": "^1.6.7",
     "buffer": "^6.0.3",
-    "limiter": "^2.1.0",
-    "limiter-es6-compat": "^2.1.2",
+    "rate-limiter-flexible": "^4.0.1",
     "tiny-typed-emitter": "^2.1.0",
     "ws": "^8.16.0",
     "wspromisify": "^2.4.4"

package.json

@@ -56,7 +56,7 @@ export default [
   },
   {
     // Declarations: browser.d.ts
-    input: "lib/src/browser.d.ts",
+    input: "lib/esm/src/browser.d.ts",
     output: [{ file: "lib/browser.d.ts", format: "es" }],
     plugins: [pluginDts()]
   },

rollup.config.js

@@ -19,12 +19,11 @@
  * For more project information, see <https://github.com/tmpim/Krist.js>.
  */
 
-import rateLimiter from "limiter";
+import RateLimiterMemory from "rate-limiter-flexible/lib/RateLimiterMemory.js";
 import os from "os";
 
 import { KristApiResponse } from "../types/index.js";
 
-import packageJson from "../../package.json" with { "type": "json" };
 import { coerceKristError, KristErrorRateLimit } from "../errors/index.js";
 import { argObject, argStringNonEmpty } from "../util/argValidation.js";
 import { isNil } from "../util/internalUtil.js";
@@ -74,10 +73,10 @@ export const buildBody = (value: any): RequestInit => ({
 });
 
 // Global rate limiter so that multiple KristApi instances will share this
-const limiter = new rateLimiter.RateLimiter({
+const limiter = new RateLimiterMemory({
   // Slightly lower than server to account for timing differences
-  tokensPerInterval: 300,
-  interval: "minute"
+  points: 300, // 300 requests per minute
+  duration: 60
 });
 
 /** Client class for the Krist API. {@link KristApiOptions | Options} may be
@@ -97,7 +96,7 @@ export class KristApi {
    */
   constructor({
     syncNode = "https://krist.dev/",
-    userAgent = "krist.js/" + packageJson.version,
+    userAgent = "krist.js",
   }: KristApiOptions = {}) {
     argStringNonEmpty(syncNode, "syncNode");
     argStringNonEmpty(userAgent, "userAgent");
@@ -139,10 +138,10 @@ export class KristApi {
     const url = new URL(endpoint.replace(/^\//, "") + qss, this.syncNode);
 
     // Apply rate limiting
-    await limiter.removeTokens(1);
+    await limiter.consume("krist-api", 1);
 
     const browserHeaders: any = typeof window !== "undefined" ? {
-      "Library-Agent": "krist.js/" + packageJson.version,
+      "Library-Agent": "krist.js",
     } : {};
     const nodeHeaders: any = typeof window === "undefined" ? {
       "Library-Agent": `${this.userAgent} (${os.platform()} ${os.release()}; Node ${process.version})`,
@@ -151,7 +150,7 @@ export class KristApi {
     const res = await fetch(url.toString(), {
       method,
       headers: {
-        "Library-Agent": "krist.js/" + packageJson.version,
+        "Library-Agent": "krist.js",
         "Accept": "application/json",
         ...browserHeaders,
         ...nodeHeaders,

src/api/KristApi.ts

@@ -40,7 +40,7 @@ import { getWork } from "./routes/wsWork.js";
 import NodeWebSocket from "ws";
 
 import { TypedEmitter } from "tiny-typed-emitter";
-import rateLimiter from "limiter";
+import RateLimiterMemory from "rate-limiter-flexible/lib/RateLimiterMemory.js";
 
 import { KristWalletFormatName } from "../../util/walletFormats.js";
 import { Sha256Fn } from "../../util/internalCrypto.js";
@@ -122,9 +122,9 @@ export interface KristWsClientOptions extends KristWsClientOptionsPassword,
 }
 
 // Global rate limiter so that multiple KristApi instances will share this
-const limiter = new rateLimiter.RateLimiter({
-  tokensPerInterval: 120,
-  interval: "minute"
+const limiter = new RateLimiterMemory({
+  points: 120, // 120 requests per minute
+  duration: 60
 });
 
 /**
@@ -415,7 +415,7 @@ export class KristWsClient extends TypedEmitter<KristWsClientEvents> {
     if (typeof msg.id !== "number") return;
 
     // Apply rate limiting
-    await limiter.removeTokens(1);
+    await limiter.consume("krist-ws", 1);
 
     // TODO: Catch here
     this.ws?.send(JSON.stringify(msg));

src/api/ws/KristWsClient.ts

@@ -32,10 +32,10 @@ export type KristWalletFormatName = "kristwallet"
   | "jwalelset" | "api";
 
 export const KRIST_WALLET_FORMATS: Record<KristWalletFormatName, KristWalletFormat> = {
-  "kristwallet": async (sha256Fn = sha256, password) =>
+  "kristwallet": async (sha256Fn, password) =>
     await sha256Fn("KRISTWALLET" + password) + "-000",
 
-  "kristwallet_username_appendhashes": async (sha256Fn = sha256, password, username) =>
+  "kristwallet_username_appendhashes": async (sha256Fn, password, username) =>
     await sha256Fn(
       "KRISTWALLETEXTENSION"
       + await sha256Fn(
@@ -45,14 +45,14 @@ export const KRIST_WALLET_FORMATS: Record<KristWalletFormatName, KristWalletForm
       )
     ) + "-000",
 
-  "kristwallet_username": async (sha256Fn = sha256, password, username) =>
+  "kristwallet_username": async (sha256Fn, password, username) =>
     await sha256Fn(
       await sha256Fn(username || "")
       + "^"
       + await sha256Fn(password)
     ),
 
-  "jwalelset": async (sha256Fn = sha256, password) =>
+  "jwalelset": async (sha256Fn, password) =>
     await sha256Fn(await sha256Fn(await sha256Fn(await sha256Fn(
       await sha256Fn(await sha256Fn(await sha256Fn(await sha256Fn(
         await sha256Fn(await sha256Fn(await sha256Fn(await sha256Fn(

src/util/walletFormats.ts

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": false,
+    "outDir": "lib/cjs"
+  }
+}

tsconfig.cjs.json

@@ -16,10 +16,10 @@
     "downlevelIteration": true,
     "resolveJsonModule": true,
     "stripInternal": true,
-    "outDir": "lib",
+    "outDir": "lib/esm",
     "rootDir": "."
   },
   "include": [
-    "src/**/*"
+    "src/**/*", "typings/**/*"
   ]
 }

tsconfig.json

@@ -5,6 +5,7 @@
   },
   "include": [
     "src/**/*",
+    "typings/**/*",
     "test/**/*.ts"
   ]
 }

tsconfig.test.json

@@ -2248,16 +2248,6 @@ just-extend@^6.2.0:
   resolved "https://registry.yarnpkg.com/just-extend/-/just-extend-6.2.0.tgz#b816abfb3d67ee860482e7401564672558163947"
   integrity sha512-cYofQu2Xpom82S6qD778jBDpwvvy39s1l/hrYij2u9AMdQcGRpaBu6kY4mVhuno5kJVi1DAz4aiphA2WI1/OAw==
 
-[email protected]:
-  version "4.3.2"
-  resolved "https://registry.yarnpkg.com/just-performance-es6-compat/-/just-performance-es6-compat-4.3.2.tgz#7877f34cbe25fd994bc2265d0c919bf728dcc42e"
-  integrity sha512-bNPuqRaV8PrqYVivdN8FsKi0rmXaQ0Y63oasFUQFJooJPH0r26LdfBAfoodhUQI6I6cek9yNo+tnGiF0R3pIHw==
-
-[email protected]:
-  version "4.3.0"
-  resolved "https://registry.yarnpkg.com/just-performance/-/just-performance-4.3.0.tgz#cc2bc8c9227f09e97b6b1df4cd0de2df7ae16db1"
-  integrity sha512-L7RjvtJsL0QO8xFs5wEoDDzzJwoiowRw6Rn/GnvldlchS2JQr9wFYPiwZcDfrbbujEKqKN0tvENdbjXdYhDp5Q==
-
 keyv@^4.5.3:
   version "4.5.4"
   resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93"
@@ -2273,20 +2263,6 @@ levn@^0.4.1:
     prelude-ls "^1.2.1"
     type-check "~0.4.0"
 
-limiter-es6-compat@^2.1.2:
-  version "2.1.2"
-  resolved "https://registry.yarnpkg.com/limiter-es6-compat/-/limiter-es6-compat-2.1.2.tgz#93fdc5fadf5f220f81ffdfc4f8b2b976cc876f98"
-  integrity sha512-rAi6LCOubXfnojSePboCylTSJWi9m0hlnZJ6AYsBv0clRFr4PJAZd8DtDVhXSN5Ed5nXa6pULHu9sJxoxpWWww==
-  dependencies:
-    just-performance-es6-compat "4.3.2"
-
-limiter@^2.1.0:
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/limiter/-/limiter-2.1.0.tgz#d38d7c5b63729bb84fb0c4d8594b7e955a5182a2"
-  integrity sha512-361TYz6iay6n+9KvUUImqdLuFigK+K79qrUtBsXhJTLdH4rIt/r1y8r1iozwh8KbZNpujbFTSh74mJ7bwbAMOw==
-  dependencies:
-    just-performance "4.3.0"
-
 locate-path@^5.0.0:
   version "5.0.0"
   resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0"
@@ -2827,6 +2803,11 @@ randombytes@^2.1.0:
   dependencies:
     safe-buffer "^5.1.0"
 
+rate-limiter-flexible@^4.0.1:
+  version "4.0.1"
+  resolved "https://registry.yarnpkg.com/rate-limiter-flexible/-/rate-limiter-flexible-4.0.1.tgz#79b0ce111abe9c5da41d6fddf7cca93cedd3a8fc"
+  integrity sha512-2/dGHpDFpeA0+755oUkW+EKyklqLS9lu0go9pDsbhqQjZcxfRyJ6LA4JI0+HAdZ2bemD/oOjUeZQB2lCZqXQfQ==
+
 react-is@^16.13.1:
   version "16.13.1"
   resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4"