Merge 5117caa into e17b744

package.json

@@ -80,6 +80,7 @@
     "typescript-docs-verifier": "^2.5.0",
     "vite-plugin-node-polyfills": "^0.21.0",
     "vite-plugin-top-level-await": "^1.4.1",
+    "vite-plugin-dts": "^3.8.3",
     "vite": "^5.2.9",
     "vitest": "^1.5.0",
     "vitest-when": "^0.3.1",

packages/api/src/beacon/index.ts

@@ -2,7 +2,8 @@ import type {Api} from "./routes/index.js";
 
 // NOTE: Don't export server here so it's not bundled to all consumers
 
-export * as routes from "./routes/index.js";
+import * as routes from "./routes/index.js";
+export {routes};
 export {getClient} from "./client/index.js";
 export type {Api};
 

packages/api/src/beacon/routes/beacon/index.ts

@@ -12,11 +12,7 @@ import * as rewards from "./rewards.js";
 
 // NOTE: We choose to split the block, pool, and state namespaces so the files are not too big.
 // However, for a consumer all these methods are within the same service "beacon"
-
-export * as block from "./block.js";
-export * as pool from "./pool.js";
-export * as state from "./state.js";
-export * as rewards from "./rewards.js";
+export {block, pool, state, rewards};
 export {BroadcastValidation} from "./block.js";
 export type {BlockId, BlockHeaderResponse} from "./block.js";
 export type {AttestationFilters} from "./pool.js";

packages/api/src/beacon/routes/index.ts

@@ -8,15 +8,16 @@ import {Api as NodeApi} from "./node.js";
 import {Api as ProofApi} from "./proof.js";
 import {Api as ValidatorApi} from "./validator.js";
 
-export * as beacon from "./beacon/index.js";
-export * as config from "./config.js";
-export * as debug from "./debug.js";
-export * as events from "./events.js";
-export * as lightclient from "./lightclient.js";
-export * as lodestar from "./lodestar.js";
-export * as node from "./node.js";
-export * as proof from "./proof.js";
-export * as validator from "./validator.js";
+import * as beacon from "./beacon/index.js";
+import * as config from "./config.js";
+import * as debug from "./debug.js";
+import * as events from "./events.js";
+import * as lightclient from "./lightclient.js";
+import * as lodestar from "./lodestar.js";
+import * as node from "./node.js";
+import * as proof from "./proof.js";
+import * as validator from "./validator.js";
+export {beacon, config, debug, events, lightclient, lodestar, node, proof, validator};
 
 export type Api = {
   beacon: BeaconApi;

packages/light-client/README.md

@@ -120,6 +120,10 @@ NOTE: Due to `top-level-await` used in one of dependent library, the package wil
     }, 50);
   });
 </script>
+
+**Typescript support** The web bundle comes with the types support. Unfortunately due to following
+[issue](https://github.com/microsoft/rushstack/issues/1128#issuecomment-2066257538) we can't bundle all types. A
+workaround would be to add `@chainsafe/as-sha256` as a devDependency to your project.
 ```
 
 ## Contributors

packages/light-client/package.json

@@ -60,7 +60,7 @@
     "build:watch": "yarn run build --watch",
     "build:release": "yarn clean && yarn run build && yarn run build:dist",
     "check-build": "node -e \"(async function() { await import('./lib/index.js') })()\"",
-    "check-types": "tsc",
+    "check-types": "yarn run build:dist && tsc",
     "lint": "eslint --color --ext .ts src/ test/",
     "lint:fix": "yarn run lint --fix",
     "test": "yarn test:unit",

packages/light-client/src/index.ts

@@ -320,6 +320,7 @@ export class Lightclient {
 }
 
 // To export these name spaces to the bundle JS
-export * as utils from "./utils.js";
-export * as validation from "./validation.js";
-export * as transport from "./transport.js";
+import * as utils from "./utils.js";
+import * as validation from "./validation.js";
+import * as transport from "./transport.js";
+export {utils, validation, transport};

packages/light-client/test/unit/webEsmBundle.browser.test.ts

@@ -1,21 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call */
-import {expect, describe, it, beforeEach, vi} from "vitest";
-import "../../dist/lightclient.min.mjs";
+import {expect, describe, it, vi} from "vitest";
+import {Lightclient, LightclientEvent, utils, transport} from "../../dist/lightclient.min.mjs";
 
 describe("web bundle for lightclient", () => {
   vi.setConfig({testTimeout: 20_000});
 
-  let lightclient: any;
-
-  beforeEach(() => {
-    lightclient = (window as any)["lodestar"]["lightclient"];
-  });
-
   it("should have a global interface", () => {
-    expect(lightclient).toBeDefined();
+    expect((window as any)["lodestar"]["lightclient"]).toBeDefined();
   });
 
   it("should have all relevant exports", () => {
+    const lightclient = (window as any)["lodestar"]["lightclient"];
     expect(lightclient).toHaveProperty("Lightclient");
     expect(lightclient).toHaveProperty("LightclientEvent");
     expect(lightclient).toHaveProperty("RunStatusCode");
@@ -29,8 +24,6 @@ describe("web bundle for lightclient", () => {
   });
 
   it("should start the lightclient and sync", async () => {
-    const {Lightclient, LightclientEvent, transport, utils} = lightclient;
-
     const logger = utils.getConsoleLogger({logDebug: true});
     const config = utils.getChainForkConfigFromNetwork("mainnet");
 

packages/light-client/vite.config.ts

@@ -1,11 +1,26 @@
+import path from "node:path";
+import fs from "node:fs/promises";
 import {defineConfig, mergeConfig} from "vite";
+import dts from "vite-plugin-dts";
 import {getBaseViteConfig} from "../../vite.base.config.js";
 
 import pkgJSON from "./package.json";
 
 export default mergeConfig(
   getBaseViteConfig(pkgJSON, {libName: "LightClient", entry: "src/index.ts"}),
   defineConfig({
+    plugins: [
+      dts({
+        rollupTypes: true,
+        bundledPackages: ["@lodestar/*", "@chainsafe/persistent-merkle-tree", "@chainsafe/bls", "@chainsafe/ssz"],
+        async afterBuild() {
+          await fs.rename(
+            path.join(import.meta.dirname, "dist", "index.d.ts"),
+            path.join(import.meta.dirname, "dist", "lightclient.min.d.mts")
+          );
+        },
+      }),
+    ],
     build: {
       rollupOptions: {
         output: {

packages/types/src/allForks/index.ts

@@ -1,3 +1,7 @@
 export * from "./types.js";
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+
+// We have to use import->export because of the limitation in `@microsoft/api-extractor`
+// which is used to bundle the package types
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};

packages/types/src/altair/index.ts

@@ -1,3 +1,4 @@
 export * from "./types.js";
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};

packages/types/src/bellatrix/index.ts

@@ -1,3 +1,4 @@
 export * from "./types.js";
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};

packages/types/src/capella/index.ts

@@ -1,3 +1,4 @@
 export * from "./types.js";
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};

packages/types/src/deneb/index.ts

@@ -1,3 +1,4 @@
 export * from "./types.js";
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};

packages/types/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ssz from "./sszTypes.js";
+export {ssz};
 // Typeguards
 export * from "./utils/typeguards.js";
 // String type

packages/types/src/phase0/index.ts

@@ -1,3 +1,4 @@
 export * from "./types.js";
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};

packages/types/src/primitive/index.ts

@@ -1,2 +1,3 @@
-export * as ts from "./types.js";
-export * as ssz from "./sszTypes.js";
+import * as ts from "./types.js";
+import * as ssz from "./sszTypes.js";
+export {ts, ssz};