Add dist Test Setup / Some Developer Docs (#24)

* Add possibility to run dist tests

* Add some developer docs (AI, shortened, proof-read)

* Fix browser tests

Author: holgerd77

README.md

@@ -126,3 +126,87 @@ type KZGProofWithCells = {
     cells: string[]  // Array of 128 cells, each 2048 bytes
 }
 ```
+
+## Development
+
+### Build Process
+
+This section outlines the build scripts included in this repository to create distributable JavaScript/TypeScript packages from the WASM compilation.
+
+#### Prerequisites
+
+Ensure you have the following installed:
+- **Node.js** (v16+)
+- **npm** 
+- **TypeScript** (installed as dev dependency)
+- **Babel** (installed as dev dependency)
+
+#### Build Scripts Overview
+
+The repository includes the following build scripts:
+
+1. **`build`** - Main build command
+2. **`build:ts`** - TypeScript compilation to multiple targets
+3. **`transpileCJS`** - Babel transpilation for CommonJS compatibility
+4. **`fixRequire`** - Fix dynamic require statements
+5. **`fixWasmDirInNode`** - Fix WASM paths for Node.js builds
+6. **`fixWasmDirInWeb`** - Fix WASM paths for browser builds
+
+#### Script Details
+
+**`build:ts`** (`scripts/ts-build.sh`)
+- Copies WASM file to `dist/wasm/`
+- Compiles TypeScript to CommonJS (`dist/cjs/`)
+- Compiles TypeScript to ESM (`dist/esm/`)
+- Creates browser build (`dist/browser/`)
+
+**`transpileCJS`**
+- Uses Babel to transpile `src/kzg.js` to `dist/cjs/`
+- Ensures CommonJS compatibility
+
+**`fixRequire`**
+- Fixes dynamic require statements in CommonJS build
+- Replaces `\_require('url')` with `require('url')`
+
+**`fixWasmDirInNode`**
+- Updates WASM file paths in Node.js builds
+- Changes `kzg-node.wasm` → `kzg.wasm` → `../wasm/kzg.wasm`
+
+**`fixWasmDirInWeb`**
+- Updates WASM file paths in browser builds
+- Changes `kzg-web.wasm` → `../wasm/kzg.wasm`
+
+#### Build Output Structure
+
+```
+dist/
+├── cjs/           # CommonJS build for Node.js
+│   ├── index.js
+│   ├── kzg.js
+│   ├── loader.cjs
+│   └── package.json
+├── esm/           # ES Modules build
+│   ├── index.js
+│   ├── kzg.js
+│   ├── loader.mjs
+│   └── package.json
+├── browser/       # Browser build
+│   ├── index.js
+│   ├── kzg.js
+│   └── package.json
+└── wasm/          # WASM binary
+    └── kzg.wasm
+```
+
+#### Testing Builds
+
+```bash
+# Test all builds
+npm test
+
+# Test specific builds
+npm run test:dist    # Test distribution build
+npm run test:src     # Test source code
+npm run test:browser # Test browser environment
+```
+

package.json

@@ -3,14 +3,16 @@
   "version": "1.0.0",
   "description": "a WASM compilation of c-kzg-4844",
   "scripts": {
-    "build": "npm run build:ts && npm run transpileCJS && npm run fixRequire ",
+    "build": "rm -rf dist && npm run build:ts && npm run transpileCJS && npm run fixRequire ",
     "build:ts": "scripts/ts-build.sh",
     "transpileCJS": "rm dist/cjs/kzg.js && babel src/kzg.js -d dist/cjs",
     "fixRequire": "sed -i.bak \"s/\\_require('url')/require('url')/g\" dist/cjs/kzg.js && rm dist/cjs/kzg.js.bak",
     "fixWasmDirInNode": "sed -i.bak 's#kzg-node.wasm#kzg.wasm#g' src/kzg.js && rm src/kzg.js.bak && sed -i.bak 's#kzg.wasm#../wasm/kzg.wasm#g' src/kzg.js && rm src/kzg.js.bak",
     "fixWasmDirInWeb": "sed -i.bak 's#kzg-web.wasm#../wasm/kzg.wasm#g' browser/kzg.js && rm browser/kzg.js.bak",
     "clean": "rm -rf dist && rm -rf node_modules",
-    "test": "vitest run test/*",
+    "test": "npm run test:dist && npm run test:src",
+    "test:dist": "npm run build && TYPE=DIST npx vitest run test/*",
+    "test:src": "TYPE=SRC npx vitest run test/*",
     "test:browser": "npx vitest run -c vitest.config.browser.ts test/*",
     "prepare": "npm run build"
   },

test/index.spec.ts

@@ -1,6 +1,13 @@
 import { describe, it, assert, beforeAll } from 'vitest'
-import { loadKZG } from '../src/index.js'
-import { bytesToHex, hexToBytes } from '../src/util.js'
+import { bytesToHex } from '../src/util.js'
+
+// Conditional imports based on TYPE environment variable
+const TYPE = (typeof process !== 'undefined' && process.env?.TYPE) || 'SRC'
+
+// Dynamic imports based on TYPE
+const { loadKZG } = TYPE === 'SRC' 
+  ? await import('../src/index.js')
+  : await import('../dist/esm/index.js')
 
 const BYTES_PER_FIELD_ELEMENT = 32
 const FIELD_ELEMENTS_PER_BLOB = 4096