Merge pull request #350 from open-rpc/feat/esm

Feat/esm

Author: zcstarr

.circleci/config.yml

@@ -22,18 +22,28 @@ aliases:
     branches:
       only:  /^(pull|dependabot|fix|feat)\/.*$/
 
+  # -------------------------
+  #  ALIASES: Bun Install
+  # -------------------------
+  - &install-bun
+    name: Install Bun
+    command: |
+      curl -fsSL https://bun.sh/install | bash -s "bun-v1.3.1"
+      echo 'export PATH="$HOME/.bun/bin:$PATH"' >> $BASH_ENV
+
 defaults: &defaults
   working_directory: ~/client-js
   docker:
-    - image: cimg/node:20.11.0
+    - image: cimg/node:24.10.0
 
 jobs:
   test:
     <<: *defaults
     steps:
       - checkout
+      - run: *install-bun
       - restore_cache: *restore-deps-cache
-      - run: npm install
+      - run: bun install
       - run: npm install codecov
       - run: npm test
       - run: ./node_modules/.bin/codecov
@@ -43,18 +53,20 @@ jobs:
     <<: *defaults
     steps:
       - checkout
+      - run: *install-bun
       - restore_cache: *restore-deps-cache
-      - run: npm install
-      - run: npm run build
+      - run: bun install
+      - run: bun run build
       - save_cache: *save-deps-cache
 
   release:
     <<: *defaults
     steps:
       - checkout
+      - run: *install-bun
       - restore_cache: *restore-deps-cache
-      - run: npm install
-      - run: npm run build
+      - run: bun install
+      - run: bun run build
       - run: npm install semantic-release @semantic-release/changelog @semantic-release/git @semantic-release/github @semantic-release/npm @semantic-release/commit-analyzer @semantic-release/release-notes-generator @qiwi/semantic-release-gh-pages-plugin
       - run: git checkout .
       - run: ./node_modules/.bin/semantic-release

.gitignore

@@ -4,3 +4,4 @@ build
 .DS_Store
 node_modules
 coverage
+dist

.prettierc

@@ -0,0 +1,12 @@
+{
+  "endOfLine": "lf",
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "useTabs": false,
+  "tabWidth": 2,
+  "printWidth": 100,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "semi": true
+}

README.md

@@ -20,12 +20,11 @@ A browser-compatible JSON-RPC client with multiple transports:
 - PostMessageWindow
 - PostMessageIframe
 
-
 ```javascript
 import { RequestManager, HTTPTransport, Client } from "@open-rpc/client-js";
 const transport = new HTTPTransport("http://localhost:8545");
 const client = new Client(new RequestManager([transport]));
-const result = await client.request({method: "addition", params: [2, 2]});
+const result = await client.request({ method: "addition", params: [2, 2] });
 // => { jsonrpc: '2.0', id: 1, result: 4 }
 ```
 
@@ -36,7 +35,11 @@ const result = await client.request({method: "addition", params: [2, 2]});
 
 ```javascript
 import { EventEmitter } from "events";
-import { RequestManager, EventEmitterTransport, Client } from "@open-rpc/client-js";
+import {
+  RequestManager,
+  EventEmitterTransport,
+  Client,
+} from "@open-rpc/client-js";
 
 const chan1 = "chan1";
 const chan2 = "chan2";
@@ -57,7 +60,7 @@ emitter.on(chan1, (jsonrpcRequest) => {
 });
 
 const main = async () => {
-  const result = await client.request({method: "addition", params: [2, 2]});
+  const result = await client.request({ method: "addition", params: [2, 2] });
   console.log(result);
 };
 
@@ -68,7 +71,6 @@ main().then(() => {
 
 </details>
 
-
 <details>
   <summary>HTTP</summary>
 
@@ -80,7 +82,7 @@ const requestManager = new RequestManager([transport]);
 const client = new Client(requestManager);
 
 const main = async () => {
-  const result = await client.request({method: "addition", params: [2, 2]});
+  const result = await client.request({ method: "addition", params: [2, 2] });
   console.log(result);
 };
 
@@ -91,31 +93,43 @@ main().then(() => {
 
 </details>
 
-
 <details>
   <summary>WebSocket</summary>
 
 ```javascript
-import { RequestManager, Client, WebSocketTransport } from "@open-rpc/client-js";
+import {
+  RequestManager,
+  Client,
+  WebSocketTransport,
+} from "@open-rpc/client-js";
 
 const transport = new WebSocketTransport("ws://localhost:3333");
 const requestManager = new RequestManager([transport]);
 const client = new Client(requestManager);
 
 const main = async () => {
-  const result = await client.request({method: "addition", params: [2, 2]});
+  const result = await client.request({ method: "addition", params: [2, 2] });
   console.log(result);
 };
 
 main().then(() => {
   console.log("DONE");
   client.close();
 });
-
 ```
 
 </details>
 
+### Building
+
+```sh
+# Install bun
+curl -fsSL https://bun.sh/install | bash
+
+# Build the repo
+bun install
+bun run build
+```
 
 ### Contributing
 

build.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env bun
+import { $ } from "bun";
+
+const baseConfig = {
+  entrypoints: ["./src/index.ts"],
+  sourcemap: "external",
+  minify: false,
+  splitting: false,
+};
+
+
+await Bun.build({
+  ...baseConfig,
+  outdir: "./dist",
+  target: "node",
+  format: "esm",
+  external: ["ws", "isomorphic-ws"],
+});
+
+await Bun.build({
+  ...baseConfig,
+  outdir: "./dist/browser",
+  target: "browser",
+  format: "esm",
+});