@wasmgroundup/emit 2.0.0 → 2.1.1

package/README.md

@@ -10,6 +10,36 @@ A JavaScript library to emit WebAssembly 1.0 binary modules.
 npm i @wasmgroundup/emit
 ```
 
+## Example
+
+Build a WebAssembly module with an exported `add` function:
+
+```typescript
+import * as w from "@wasmgroundup/emit";
+
+const mod = w.module([
+  w.typesec([w.functype([w.valtype.i32, w.valtype.i32], [w.valtype.i32])]),
+  w.funcsec([w.typeidx(0)]),
+  w.exportsec([w.export_("add", w.exportdesc.func(w.funcidx(0)))]),
+  w.codesec([
+    w.code(
+      w.func(
+        [],
+        w.expr([
+          [w.instr.local.get, ...w.i32(0)],
+          [w.instr.local.get, ...w.i32(1)],
+          w.instr.i32.add,
+        ]),
+      ),
+    ),
+  ]),
+]);
+
+const { instance } = await WebAssembly.instantiate(w.flatten(mod));
+const { add } = instance.exports as { add: (a: number, b: number) => number };
+console.log(add(1, 2)); // 3
+```
+
 ## Features
 
 - Simple API following the [spec](https://www.w3.org/TR/2019/REC-wasm-core-1-20191205/)'s naming conventions

package/index.d.ts

@@ -92,7 +92,7 @@ export function code(func: Fragment): Fragment;
 
 export function func(locals: readonly Fragment[], body: Fragment): Fragment;
 
-export function expr(instrs: readonly Fragment[]): Fragment;
+export function expr(instrs: Fragment): Fragment;
 
 export function codesec(codes: readonly Fragment[]): Fragment;
 
@@ -292,6 +292,8 @@ export const instr: {
 
 export const blocktype: {readonly empty: 0x40} & typeof valtype;
 
+export type blocktype = typeof blocktype.empty | valtype | Fragment;
+
 // Export section
 // --------------
 
@@ -315,6 +317,8 @@ export type WasmModule = Fragment;
 
 export function module(sections: readonly Fragment[]): WasmModule;
 
+export function flatten(fragment: Fragment): Uint8Array<ArrayBuffer>;
+
 // Locals
 // ------
 

package/index.js

@@ -1,5 +1,26 @@
 // WebAssembly 1.0 Module Builder
 // https://wasmgroundup.com/
+
+function byteLength(fragment) {
+  let n = 0;
+  for (const item of fragment) {
+    if (Array.isArray(item)) n += byteLength(item);
+    else n += 1;
+  }
+  return n;
+}
+
+function writeInto(fragment, out, offset) {
+  for (const item of fragment) {
+    if (Array.isArray(item)) {
+      offset = writeInto(item, out, offset);
+    } else {
+      out[offset++] = item;
+    }
+  }
+  return offset;
+}
+
 export function stringToBytes(s) {
   const bytes = new TextEncoder().encode(s);
   return Array.from(bytes);
@@ -86,7 +107,7 @@ export function i32(v) {
 }
 
 export function section(id, contents) {
-  const sizeInBytes = contents.flat(Infinity).length;
+  const sizeInBytes = byteLength(contents);
   return [id, u32(sizeInBytes), contents];
 }
 
@@ -115,7 +136,7 @@ export function funcsec(typeidxs) {
 export const SECTION_ID_CODE = 10;
 
 export function code(func) {
-  const sizeInBytes = func.flat(Infinity).length;
+  const sizeInBytes = byteLength(func);
   return [u32(sizeInBytes), func];
 }
 
@@ -160,6 +181,12 @@ export const exportdesc = {
 export function module(sections) {
   return [magic(), version(), sections];
 }
+
+export function flatten(fragment) {
+  const out = new Uint8Array(byteLength(fragment));
+  writeInto(fragment, out, 0);
+  return out;
+}
 export const valtype = {
   i32: 0x7f,
   i64: 0x7e,
@@ -321,9 +348,8 @@ export function funcnamesubsec(namemap) {
 
 // N:byte
 export function namesubsection(N, B) {
-  const flatB = B.flat(Infinity);
-  const size = u32(flatB.length);
-  return [N, size, flatB];
+  const size = u32(byteLength(B));
+  return [N, size, B];
 }
 
 export function namemap(nameassocs) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wasmgroundup/emit",
   "description": "A library for creating binary-encoded WebAssembly modules",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
@@ -30,13 +30,17 @@
   },
   "homepage": "https://github.com/wasmgroundup/emit#readme",
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@types/node": "^24.10.1",
     "prettier": "^3.6.2",
+    "publint": "^0.3.17",
     "typescript": "^5.9.3"
   },
   "scripts": {
     "build": "tsc",
     "format": "npx prettier '**/*.{ts,js,json}' --write",
+    "lint": "publint && attw --pack . --ignore-rules cjs-resolves-to-esm",
+    "pretest": "node scripts/extract-readme-example.js",
     "test": "node --test",
     "test:watch": "node --test --watch"
   }