@thi.ng/wasm-api 1.4.69 → 1.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-20T14:42:45Z
+- **Last updated**: 2024-04-22T09:56:21Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,21 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [1.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@1.5.0) (2024-04-22)
+
+#### 🚀 Features
+
+- update build script for zig v0.12.0 (incomplete) ([99a1916](https://github.com/thi-ng/umbrella/commit/99a1916))
+  - store existing script as build-v0.11.zig
+
+#### 🩹 Bug fixes
+
+- re-add -rdynamic flag in build.zig ([f509d1e](https://github.com/thi-ng/umbrella/commit/f509d1e))
+
+#### ♻️ Refactoring
+
+- minor zig v0.12.0 updates ([4a0751c](https://github.com/thi-ng/umbrella/commit/4a0751c))
+
 ### [1.4.69](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@1.4.69) (2024-04-20)
 
 #### ♻️ Refactoring

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/wasm-api",
-  "version": "1.4.69",
+  "version": "1.5.0",
   "description": "Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects",
   "type": "module",
   "module": "./index.js",
@@ -116,5 +116,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "8339d05ecc857e529c7325a9839c0063b89e728d\n"
+  "gitHead": "4e2bf6b12e35192e678b525fa699429370e357d3\n"
 }

package/zig/build-v0.11.zig

@@ -0,0 +1,126 @@
+//! 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
+//!
+//! Use build.zig (in this same directory) for earlier Zig versions
+
+const std = @import("std");
+const Build = std.Build;
+
+/// Config options
+pub const WasmLibOpts = struct {
+    /// Base path to common node_modules directory under which
+    /// all to be imported modules are located
+    base: []const u8 = "node_modules",
+    /// Relative path to root source file
+    root: []const u8 = "zig/main.zig",
+    /// Additional WASM API support modules.
+    /// Only need to specify custom/extra modules
+    /// `wasm-api` and `wasm-api-bindgen` are auto-added as dependency for all...
+    modules: ?[]const ModuleSpec = null,
+    /// Build mode override (else allows config via CLI args)
+    optimize: ?std.builtin.Mode = null,
+    /// Additional WASM target features, e.g. `.simd128` to enable SIMD
+    features: ?[]const std.Target.wasm.Feature = null,
+    /// Initial memory (in bytes, MUST be multiple of 0x10000)
+    initialMemory: ?u64 = null,
+    /// Max memory (in bytes, MUST be multiple of 0x10000)
+    maxMemory: ?u64 = null,
+    // If true, build will also generate docs
+    // docs: bool = false,
+};
+
+/// WASM API sub-module declaration
+pub const ModuleSpec = struct {
+    /// module import name/ID
+    name: []const u8,
+    /// Relative path to configured base path
+    path: []const u8,
+    /// Module IDs of other modules this module depends on
+    /// Only need to specify custom/extra modules
+    /// `wasm-api` and `wasm-api-bindgen` are auto-added as dependency for all...
+    dependencies: ?[]const []const u8 = null,
+};
+
+const wasmapi = "wasm-api";
+const wasmbind = "wasm-api-bindgen";
+
+/// Creates and returns a build step to build a dynamic WASM library, configured
+/// with given options and package declarations. The given package specs will be inserted
+pub fn wasmLib(b: *Build, opts: WasmLibOpts) *Build.Step.Compile {
+    const lib = b.addSharedLibrary(.{
+        .name = "main",
+        .root_source_file = .{ .path = opts.root },
+        .target = .{
+            .cpu_arch = .wasm32,
+            .os_tag = .freestanding,
+            .cpu_features_add = if (opts.features) |features| std.Target.wasm.featureSet(features) else std.Target.Cpu.Feature.Set.empty,
+        },
+        .optimize = if (opts.optimize) |m| m else b.standardOptimizeOption(.{}),
+    });
+    if (lib.optimize == .ReleaseSmall or lib.optimize == .ReleaseFast) lib.strip = true;
+
+    // build flags
+    lib.rdynamic = true;
+    lib.import_symbols = true;
+    lib.initial_memory = opts.initialMemory;
+    lib.max_memory = opts.maxMemory;
+
+    // add default dependencies
+    lib.addModule(
+        wasmapi,
+        b.createModule(.{
+            .source_file = modulePath(b.allocator, opts.base, "@thi.ng/wasm-api/zig/lib.zig"),
+        }),
+    );
+    lib.addModule(
+        wasmbind,
+        b.createModule(.{
+            .source_file = modulePath(b.allocator, opts.base, "@thi.ng/wasm-api-bindgen/zig/lib.zig"),
+        }),
+    );
+    if (opts.modules) |modules| {
+        for (modules) |mod| {
+            register(lib, mod, opts);
+        }
+    }
+    return lib;
+}
+
+/// Registers a single package and its deps (also injects core wasm-api deps)
+pub fn register(step: *Build.Step.Compile, mod: ModuleSpec, opts: WasmLibOpts) void {
+    const num = if (mod.dependencies) |ids| ids.len else 0;
+    var dpkgs = step.step.owner.allocator.alloc(Build.ModuleDependency, num + 2) catch unreachable;
+    dpkgs[0] = if (step.modules.get(wasmapi)) |m| .{ .name = wasmapi, .module = m } else unreachable;
+    dpkgs[1] = if (step.modules.get(wasmbind)) |m| .{ .name = wasmbind, .module = m } else unreachable;
+    var i: usize = 2;
+    if (mod.dependencies) |ids| {
+        for (ids) |id| {
+            if (step.modules.get(id)) |m| {
+                if (isDuplicateId(dpkgs[0..i], id)) {
+                    std.log.info("ignoring duplicate dependency: {s}", .{id});
+                    continue;
+                }
+                dpkgs[i] = .{ .name = id, .module = m };
+                i += 1;
+            } else @panic("unknown dependency");
+        }
+    }
+    step.addModule(mod.name, step.step.owner.createModule(.{
+        .source_file = modulePath(step.step.owner.allocator, opts.base, mod.path),
+        .dependencies = dpkgs[0..i],
+    }));
+}
+
+fn isDuplicateId(deps: []Build.ModuleDependency, name: []const u8) bool {
+    for (deps) |d| {
+        if (std.mem.eql(u8, d.name, name)) return true;
+    }
+    return false;
+}
+
+fn modulePath(allocator: std.mem.Allocator, base: []const u8, path: []const u8) Build.FileSource {
+    return .{ .path = std.fs.path.join(allocator, &.{ base, path }) catch unreachable };
+}

package/zig/build.zig

@@ -50,55 +50,59 @@ const wasmbind = "wasm-api-bindgen";
 /// Creates and returns a build step to build a dynamic WASM library, configured
 /// with given options and package declarations. The given package specs will be inserted
 pub fn wasmLib(b: *Build, opts: WasmLibOpts) *Build.Step.Compile {
-    const lib = b.addSharedLibrary(.{
+    const optimize = if (opts.optimize) |m| m else b.standardOptimizeOption(.{});
+    const lib = b.addExecutable(.{
         .name = "main",
         .root_source_file = .{ .path = opts.root },
-        .target = .{
-            .cpu_arch = .wasm32,
-            .os_tag = .freestanding,
-            .cpu_features_add = if (opts.features) |features| std.Target.wasm.featureSet(features) else std.Target.Cpu.Feature.Set.empty,
-        },
-        .optimize = if (opts.optimize) |m| m else b.standardOptimizeOption(.{}),
+        .target = b.resolveTargetQuery(
+            .{
+                .cpu_arch = .wasm32,
+                .os_tag = .freestanding,
+                .cpu_features_add = if (opts.features) |features| std.Target.wasm.featureSet(features) else std.Target.Cpu.Feature.Set.empty,
+            },
+        ),
+        .optimize = optimize,
+        .strip = (optimize == .ReleaseSmall or optimize == .ReleaseFast),
     });
-    if (lib.optimize == .ReleaseSmall or lib.optimize == .ReleaseFast) lib.strip = true;
 
     // build flags
+    // https://github.com/ziglang/zig/pull/17815
+    lib.entry = .disabled;
     lib.rdynamic = true;
     lib.import_symbols = true;
     lib.initial_memory = opts.initialMemory;
     lib.max_memory = opts.maxMemory;
 
     // add default dependencies
-    lib.addModule(
+    // https://ziggit.dev/t/what-happened-to-addmodule/2908/3
+    _ = lib.root_module.addImport(
         wasmapi,
         b.createModule(.{
-            .source_file = modulePath(b.allocator, opts.base, "@thi.ng/wasm-api/zig/lib.zig"),
+            .root_source_file = modulePath(b.allocator, opts.base, "@thi.ng/wasm-api/zig/lib.zig"),
         }),
     );
-    lib.addModule(
+    _ = lib.root_module.addImport(
         wasmbind,
         b.createModule(.{
-            .source_file = modulePath(b.allocator, opts.base, "@thi.ng/wasm-api-bindgen/zig/lib.zig"),
+            .root_source_file = modulePath(b.allocator, opts.base, "@thi.ng/wasm-api-bindgen/zig/lib.zig"),
         }),
     );
     if (opts.modules) |modules| {
-        for (modules) |mod| {
-            register(lib, mod, opts);
-        }
+        for (modules) |mod| register(lib, mod, opts);
     }
     return lib;
 }
 
 /// Registers a single package and its deps (also injects core wasm-api deps)
-pub fn register(step: *Build.Step.Compile, mod: ModuleSpec, opts: WasmLibOpts) void {
+pub fn register(lib: *Build.Step.Compile, mod: ModuleSpec, opts: WasmLibOpts) void {
     const num = if (mod.dependencies) |ids| ids.len else 0;
-    var dpkgs = step.step.owner.allocator.alloc(Build.ModuleDependency, num + 2) catch unreachable;
-    dpkgs[0] = if (step.modules.get(wasmapi)) |m| .{ .name = wasmapi, .module = m } else unreachable;
-    dpkgs[1] = if (step.modules.get(wasmbind)) |m| .{ .name = wasmbind, .module = m } else unreachable;
+    var dpkgs = lib.step.owner.allocator.alloc(Build.Module.Import, num + 2) catch unreachable;
+    dpkgs[0] = if (lib.root_module.import_table.get(wasmapi)) |m| .{ .name = wasmapi, .module = m } else unreachable;
+    dpkgs[1] = if (lib.root_module.import_table.get(wasmbind)) |m| .{ .name = wasmbind, .module = m } else unreachable;
     var i: usize = 2;
     if (mod.dependencies) |ids| {
         for (ids) |id| {
-            if (step.modules.get(id)) |m| {
+            if (lib.root_module.import_table.get(id)) |m| {
                 if (isDuplicateId(dpkgs[0..i], id)) {
                     std.log.info("ignoring duplicate dependency: {s}", .{id});
                     continue;
@@ -108,19 +112,19 @@ pub fn register(step: *Build.Step.Compile, mod: ModuleSpec, opts: WasmLibOpts) v
             } else @panic("unknown dependency");
         }
     }
-    step.addModule(mod.name, step.step.owner.createModule(.{
-        .source_file = modulePath(step.step.owner.allocator, opts.base, mod.path),
-        .dependencies = dpkgs[0..i],
+    _ = lib.root_module.addImport(mod.name, lib.step.owner.createModule(.{
+        .root_source_file = modulePath(lib.step.owner.allocator, opts.base, mod.path),
+        .imports = dpkgs[0..i],
     }));
 }
 
-fn isDuplicateId(deps: []Build.ModuleDependency, name: []const u8) bool {
+fn isDuplicateId(deps: []Build.Module.Import, name: []const u8) bool {
     for (deps) |d| {
         if (std.mem.eql(u8, d.name, name)) return true;
     }
     return false;
 }
 
-fn modulePath(allocator: std.mem.Allocator, base: []const u8, path: []const u8) Build.FileSource {
+fn modulePath(allocator: std.mem.Allocator, base: []const u8, path: []const u8) Build.LazyPath {
     return .{ .path = std.fs.path.join(allocator, &.{ base, path }) catch unreachable };
 }

package/zig/lib.zig

@@ -51,7 +51,7 @@ pub inline fn allocator() ?std.mem.Allocator {
 /// Note: For SIMD compatibility all allocations are aligned to 16 bytes
 pub export fn _wasm_allocate(numBytes: usize) usize {
     if (allocator()) |alloc| {
-        var mem = alloc.alignedAlloc(u8, 16, numBytes) catch return 0;
+        const mem = alloc.alignedAlloc(u8, 16, numBytes) catch return 0;
         return @intFromPtr(mem.ptr);
     }
     return 0;

package/zig/managed-index.zig

@@ -200,7 +200,7 @@ test "ManagedIndex" {
     list.remove(1);
     list.remove(2);
 
-    var ids = try list.freeIndicesAsSlice(allocator);
+    const ids = try list.freeIndicesAsSlice(allocator);
     defer allocator.free(ids);
     try expectEqualSlices(u8, &[_]u8{ 2, 1 }, ids);
 
@@ -224,7 +224,7 @@ test "ManagedIndex" {
     list.remove(2);
     list.remove(1);
 
-    var ids2 = try list.freeIndicesAsSlice(allocator);
+    const ids2 = try list.freeIndicesAsSlice(allocator);
     defer allocator.free(ids2);
     try expectEqualSlices(u8, &[_]u8{ 1, 2, 0 }, ids2);
 }

package/zig/zig-cache/o/20f8f8362ac39302905d03992fa818bc/dependencies.zig

@@ -0,0 +1,2 @@
+pub const packages = struct {};
+pub const root_deps: []const struct { []const u8, []const u8 } = &.{};