@thi.ng/wasm-api 1.5.0 → 1.5.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-22T09:56:21Z
+- **Last updated**: 2024-04-23T07:02:17Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -21,7 +21,7 @@
   - [API module auto-initialization](#api-module-auto-initialization)
 - [Object indices & handles](#object-indices--handles)
 - [Using the Zig build system](#using-the-zig-build-system)
-  - [Zig v0.11.0 or newer](#zig-v0110-or-newer)
+  - [Zig v0.12 or newer](#zig-v012-or-newer)
   - [Example projects](#example-projects)
 - [Naming & structural conventions](#naming--structural-conventions)
 - [Status](#status)
@@ -315,11 +315,12 @@ This package provides utilities to simplify using hybrid TS/Zig WASM API modules
 which are distributed as NPM packages. Using these utils, a build file for Zig's
 built-in build system is as simple as:
 
-### Zig v0.11.0 or newer
+### Zig v0.12 or newer
 
 **IMPORTANT:** Due to recent [syntax & build system changes in Zig
-v0.11.0](https://ziglang.org/download/0.11.0/release-notes.html), support for
-older Zig versions had to be removed...
+v0.12.0](https://ziglang.org/download/0.12.0/release-notes.html), older Zig
+versions are not actively unsupported (however build files for v0.10 and v0.11
+are still included)
 
 ```zig
 const std = @import("std");
@@ -470,12 +471,13 @@ scenarios add the supplied .zig file(s) to your `build.zig` and/or source
 folder):
 
 ```bash
-# compile WASM binary
-zig build-lib \
-    --pkg-begin wasm-api node_modules/@thi.ng/wasm-api/zig/lib.zig --pkg-end \
-    -target wasm32-freestanding \
-    -O ReleaseSmall -dynamic -rdynamic \
-    hello.zig
+# compile WASM binary (zig v0.12)
+zig build-exe \
+    -fno-entry -fstrip -OReleaseSmall -target wasm32-freestanding \
+    --name hello -rdynamic --import-symbols \
+    --dep wasm-api \
+    -Mroot=hello.zig \
+    -Mwasm-api=node_modules/@thi.ng/wasm-api/zig/lib.zig
 
 # disassemble WASM
 wasm-dis -o hello.wast hello.wasm
@@ -485,29 +487,24 @@ The resulting WASM:
 
 ```wasm
 (module
- (type $i32_i32_=>_none (func (param i32 i32)))
- (type $none_=>_none (func))
- (type $i32_=>_i32 (func (param i32) (result i32)))
- (import "wasmapi" "_printStr" (func $fimport$0 (param i32 i32)))
- (global $global$0 (mut i32) (i32.const 1048576))
- (memory $0 17)
- (data (i32.const 1048576) "hello world!\00")
- (export "memory" (memory $0))
- (export "start" (func $0))
- (export "_wasm_allocate" (func $1))
- (export "_wasm_free" (func $2))
- (func $0
-  (call $fimport$0
-   (i32.const 1048576)
-   (i32.const 12)
-  )
- )
- (func $1 (param $0 i32) (result i32)
-  (i32.const 0)
- )
- (func $2 (param $0 i32) (param $1 i32)
- )
-)
+  (type $t0 (func (param i32 i32)))
+  (type $t1 (func))
+  (type $t2 (func (param i32) (result i32)))
+  (import "wasmapi" "_printStr" (func $wasmapi._printStr (type $t0)))
+  (func $start (type $t1)
+    (call $wasmapi._printStr
+      (i32.const 1048576)
+      (i32.const 12)))
+  (func $_wasm_allocate (type $t2) (param $p0 i32) (result i32)
+    (i32.const 0))
+  (func $_wasm_free (type $t0) (param $p0 i32) (param $p1 i32))
+  (memory $memory 17)
+  (global $g0 (mut i32) (i32.const 1048576))
+  (export "memory" (memory $memory))
+  (export "start" (func $start))
+  (export "_wasm_allocate" (func $_wasm_allocate))
+  (export "_wasm_free" (func $_wasm_free))
+  (data $d0 (i32.const 1048576) "hello world!\00"))
 ```
 
 ### C version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/wasm-api",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects",
   "type": "module",
   "module": "./index.js",
@@ -27,7 +27,7 @@
     "build": "yarn build:esbuild && yarn build:decl",
     "build:decl": "tsc --declaration --emitDeclarationOnly",
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
-    "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
+    "clean": "bun ../../tools/src/clean-package.ts",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
@@ -37,18 +37,17 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.0",
-    "@thi.ng/arrays": "^2.9.4",
-    "@thi.ng/checks": "^3.6.2",
-    "@thi.ng/errors": "^2.5.5",
-    "@thi.ng/hex": "^2.3.44",
-    "@thi.ng/idgen": "^2.2.39",
-    "@thi.ng/logger": "^3.0.10"
+    "@thi.ng/api": "^8.11.1",
+    "@thi.ng/arrays": "^2.9.5",
+    "@thi.ng/checks": "^3.6.3",
+    "@thi.ng/errors": "^2.5.6",
+    "@thi.ng/hex": "^2.3.45",
+    "@thi.ng/idgen": "^2.2.40",
+    "@thi.ng/logger": "^3.0.11"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.43.0",
     "esbuild": "^0.20.2",
-    "rimraf": "^5.0.5",
     "typedoc": "^0.25.12",
     "typescript": "^5.4.3"
   },
@@ -116,5 +115,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "4e2bf6b12e35192e678b525fa699429370e357d3\n"
+  "gitHead": "5dd66c18a3862a3af69a5b2f49563f7cbdd960c2\n"
 }

package/zig/build-v0.10.zig

@@ -1,8 +1,10 @@
 //! DEPRECATED build helpers for using modules/packages distributed via NPM
 //! Intended for use with https://thi.ng/wasm-api and support packages
 //!
-//! This version of the script is only compatible with Zig v0.10.1 or older
-//! Use build-v0.11.zig (in this same directory) for newer Zig versions
+//! This version of the script is only compatible with:
+//! Zig v0.10.1 or older
+//!
+//! Use other build.zig files in this same directory for newer Zig versions
 
 const std = @import("std");
 

package/zig/build-v0.11.zig

@@ -1,10 +1,10 @@
-//! Build helpers for using modules/packages distributed via NPM
+//! DEPRECATED build helpers for using modules/packages distributed via NPM
 //! Intended for use with https://thi.ng/wasm-api and support packages
 //!
 //! This version of the script is only compatible with:
-//! Zig 0.11.0-dev.3857+7322aa118 or newer
+//! Zig v0.11.0
 //!
-//! Use build.zig (in this same directory) for earlier Zig versions
+//! Use other build.zig files in this same directory for other Zig versions
 
 const std = @import("std");
 const Build = std.Build;

package/zig/build.zig

@@ -2,9 +2,9 @@
 //! Intended for use with https://thi.ng/wasm-api and support packages
 //!
 //! This version of the script is only compatible with:
-//! Zig 0.11.0-dev.3857+7322aa118 or newer
+//! Zig v0.12.0 or newer
 //!
-//! Use build.zig (in this same directory) for earlier Zig versions
+//! Use other build.zig files in this same directory for older Zig versions
 
 const std = @import("std");
 const Build = std.Build;