Prepare for ESM (#9)

Author: kigawas

.github/workflows/ci.yml

@@ -75,6 +75,7 @@ jobs:
       - name: check main.js
         run: |
           ./scripts/check-runtime.sh example/main.js
+          ./scripts/check-runtime.sh example/quick-start.js
 
       - name: check main.js on mininum supported node version
         run: |

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## 0.2.5
+
+- Bump dependencies
+- Prepare for ESM
+
 ## 0.2.4
 
 - Bump dependencies

README.md

@@ -28,11 +28,12 @@ Otherwise (e.g. browser, react native), it'll use [`@noble/ciphers`](https://git
 >
 > This library is tree-shakeable, unused code will be excluded by bundlers.
 
-Check the [example](./example/) folder for bun/deno usage.
+Check the [example](./example/) folder for more usages.
 
 ## Quick start
 
 ```js
+// example/quick-start.js
 import { aes256gcm } from "@ecies/ciphers/aes";
 import { randomBytes } from "@noble/ciphers/webcrypto";
 
@@ -61,10 +62,10 @@ The API follows `@noble/ciphers`'s API for ease of use, you can check their [exa
 - `xchacha20-poly1305`
   - Nonce is always 24 bytes.
 
-If key is fixed and nonce is less than 16 bytes, avoid randomly generated nonce.
+If key is fixed and nonce is less than 16 bytes, **avoid randomly generated nonce**.
 
 ## Known limitations
 
 - `xchacha20-poly1305` is implemented with pure JS [`hchacha20`](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-xchacha#section-2.2) function and `node:crypto`'s `chacha20-poly1305` on node.
-- Currently (Mar 2025), `node:crypto`'s `chacha20-poly1305` is not supported on deno and [bun](https://github.com/oven-sh/bun/issues/8072), `@noble/ciphers`'s implementation is used on both platforms instead.
-- Some old versions of `deno` [do not support](https://github.com/denoland/deno/discussions/17964#discussioncomment-10917259) **indirect** conditional exports. If you use this library to build another library, client code of your library may fall back to the `node:crypto` implementation and not work properly, specifically `aes-256-gcm` (16 bytes nonce) and `chacha20-poly1305`. If you found such a problem, you need to upgrade deno and run with `--conditions deno` (>=2.4.0) or `--unstable-node-conditions deno`(>=2.3.6,<2.4.0).
+- Currently (Nov 2025), `node:crypto`'s `chacha20-poly1305` is neither supported on [deno](https://github.com/denoland/deno/issues/28411) nor [bun](https://github.com/oven-sh/bun/issues/8072), `@noble/ciphers`'s implementation is used on both platforms instead.
+- Some old versions of `deno` [did not support](https://github.com/denoland/deno/discussions/17964#discussioncomment-10917259) **indirect** conditional exports. If you used this library to build another library, client code of your library might have fell back to the `node:crypto` implementation and would not work properly, specifically `aes-256-gcm` (16 bytes nonce) and `chacha20-poly1305`. If you found such a problem, upgrade deno and run with `--conditions deno` (>=2.4.0) or `--unstable-node-conditions deno`(>=2.3.6,<2.4.0).

biome.jsonc

@@ -15,7 +15,7 @@
   "formatter": {
     "enabled": true,
     "indentStyle": "space",
-    "lineWidth": 90
+    "lineWidth": 92
   },
   "assist": {
     "actions": {

example/quick-start.js

@@ -0,0 +1,12 @@
+import { aes256gcm } from "@ecies/ciphers/aes";
+import { randomBytes } from "@noble/ciphers/webcrypto";
+
+const TEXT = "hello world🌍!";
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+const msg = encoder.encode(TEXT);
+
+const key = randomBytes();
+const nonce = randomBytes(16);
+const cipher = aes256gcm(key, nonce);
+console.log("decrypted:", decoder.decode(cipher.decrypt(cipher.encrypt(msg))));

package.json

@@ -62,9 +62,9 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.3.2",
-    "@types/node": "^24.9.2",
+    "@types/node": "^24.10.0",
     "@vitest/coverage-v8": "^4.0.6",
-    "typescript": "^5.8.3",
+    "typescript": "^5.9.3",
     "vitest": "^4.0.6"
   },
   "pnpm": {