Prepare for v0.5.0 (#880)

* Prepare for v0.5.0

* Review fix

* Review fix

* Update doc

* Review fix

Author: kigawas

CHANGELOG.md

@@ -4,6 +4,8 @@
 ## 0.4.18
 
 - Bump dependencies
+- Prepare for v0.5.0
+  - API change: Return a Node.js `Buffer` only when available (otherwise a `Uint8Array`)
 
 ## 0.4.17
 

README.md

@@ -56,23 +56,23 @@ See [Configuration](#configuration) to control with more granularity.
 
 ## API
 
-### `encrypt(receiverRawPK: string | Uint8Array, data: Uint8Array): Buffer`
+### `encrypt(receiverRawPK: string | Uint8Array, data: Uint8Array): Uint8Array`
 
 Parameters:
 
 - `receiverRawPK` - Receiver's public key, hex `string` or `Uint8Array`
 - `data` - Data to encrypt
 
-Returns: `Buffer`
+Returns: `Uint8Array`
 
-### `decrypt(receiverRawSK: string | Uint8Array, data: Uint8Array): Buffer`
+### `decrypt(receiverRawSK: string | Uint8Array, data: Uint8Array): Uint8Array`
 
 Parameters:
 
 - `receiverRawSK` - Receiver's private key, hex `string` or `Uint8Array`
 - `data` - Data to decrypt
 
-Returns: `Buffer`
+Returns: `Uint8Array`
 
 ### `PrivateKey`
 
@@ -90,7 +90,7 @@ equals(other: PrivateKey): boolean;
 - Properties
 
 ```typescript
-get secret(): Buffer;
+get secret(): Uint8Array;
 readonly publicKey: PublicKey;
 ```
 
@@ -107,15 +107,6 @@ decapsulate(sk: PrivateKey, compressed?: boolean): Uint8Array;
 equals(other: PublicKey): boolean;
 ```
 
-- Properties
-
-```typescript
-/** @deprecated - use `PublicKey.toBytes(false)` instead. You may also need `Buffer.from`. */
-get uncompressed(): Buffer;
-/** @deprecated - use `PublicKey.toBytes()` instead. You may also need `Buffer.from`. */
-get compressed(): Buffer;
-```
-
 ## Configuration
 
 Following configurations are available.
@@ -190,8 +181,6 @@ Via [`@ecies/ciphers`](https://github.com/ecies/js-ciphers), `node:crypto`'s nat
 
 This library is browser-friendly, check the [`example/browser`](./example/browser) directory for details. You can check [the online demo](https://js-demo.ecies.org/) as well.
 
-Currently it's necessary to polyfill `Buffer` for backward compatibility. From v0.5.0, it can run in browsers as is.
-
 If you want a WASM version to run directly in modern browsers or on some blockchains, you can also try [`ecies-wasm`](https://github.com/ecies/rs-wasm).
 
 ### Bun/Deno

example/browser/package.json

@@ -12,7 +12,6 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "buffer": "^6.0.3",
     "eciesjs": "file:../.."
   },
   "devDependencies": {

example/browser/pnpm-lock.yaml

@@ -1,11 +1,8 @@
-import { Buffer } from "buffer";
 import { bytesToHex } from "@noble/ciphers/utils";
 import { ECIES_CONFIG, PrivateKey, decrypt, encrypt } from "eciesjs";
 
 import "./style.css";
 
-globalThis.Buffer = Buffer; // polyfill manually
-
 ECIES_CONFIG.ellipticCurve = "x25519";
 ECIES_CONFIG.symmetricAlgorithm = "xchacha20";
 
@@ -69,5 +66,5 @@ setup(
   document.querySelector("#text-input"),
   document.querySelector("#text"),
   document.querySelector("#encrypted"),
-  document.querySelector("#decrypted")
+  document.querySelector("#decrypted"),
 );

example/browser/script.js

@@ -11,8 +11,6 @@ export default defineConfig({
             return "noble-ciphers";
           } else if (id.includes("@noble/hashes")) {
             return "noble-hashes";
-          } else if (id.includes("buffer")) {
-            return "buffer";
           }
         },
       },

example/browser/vite.config.ts

@@ -65,7 +65,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.5",
-    "@types/node": "^25.3.3",
+    "@types/node": "^25.3.5",
     "@vitest/coverage-v8": "^4.0.18",
     "typescript": "^5.9.3",
     "undici": "^7.22.0",
@@ -77,5 +77,5 @@
       "esbuild"
     ]
   },
-  "packageManager": "pnpm@10.28.0+sha512.05df71d1421f21399e053fde567cea34d446fa02c76571441bfc1c7956e98e363088982d940465fd34480d4d90a0668bc12362f8aa88000a64e83d0b0e47be48"
+  "packageManager": "pnpm@10.30.3+sha512.c961d1e0a2d8e354ecaa5166b822516668b7f44cb5bd95122d590dd81922f606f5473b6d23ec4a5be05e7fcd18e8488d47d978bbe981872f1145d06e9a740017"
 }