@thi.ng/wasm-api 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-01T18:02:30Z
+- **Last updated**: 2022-12-06T17:16:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -56,8 +56,8 @@ WebGL, WebGPU, WebAudio etc. is being actively worked on.
    defining glue code for the TypeScript [core
    API](https://docs.thi.ng/umbrella/wasm-api/interfaces/CoreAPI.html) defined
    by this package
-7. [Zig build files]() to simplify using hybrid TS/Zig packages with the
-   built-in build system
+7. [Zig build files](#using-the-zig-build-system) to simplify using hybrid
+   TS/Zig packages with the built-in build system
 8. Extensible shared [datatype code generator
    infrastructure](https://github.com/thi-ng/umbrella/tree/develop/packages/wasm-api-bindgen/)
    for (currently) Zig & TypeScript and C11. For TS fully type checked and
@@ -305,22 +305,33 @@ packages this is used to manage Zig-side event listeners.
 
 ## Using the Zig build system
 
-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:
+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
 const std = @import("std");
 
 pub fn build(b: *std.build.Builder) void {
-    @import("node_modules/@thi.ng/wasm-api/zig/build.zig").wasmLib(b, .{
+	// obtain a standard std.build.LibExeObjStep, pre-configured w/ given options
+	// see source comments in imported build.zig for further details...
+    var lib = @import("node_modules/@thi.ng/wasm-api/zig/build.zig").wasmLib(b, .{
         // Declare extra WASM API packages to use
-		// Each package can also declare its dependencies
+        // Each package can also declare dependencies to other such packages
+        // (wasm-api and wasm-api-bindgen are made available everywhere)
         .packages = &.{
             .{ .id = "wasm-api-dom", .path = "@thi.ng/wasm-api-dom/zig/lib.zig" },
             .{ .id = "wasm-api-schedule", .path = "@thi.ng/wasm-api-schedule/zig/lib.zig" },
         },
         // (optional) build mode override
+		// if commented out, we can pass CLI args to choose build mode (default: .Debug)
         .mode = .ReleaseSmall,
-    }).install();
+    });
+	// optionally, add further custom configuration
+	// ...
+
+	// finally trigger build
+	lib.install();
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/wasm-api",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects",
   "type": "module",
   "module": "./index.js",
@@ -55,19 +55,24 @@
     "allocator",
     "api",
     "bindings",
+    "bigint",
     "browser",
     "c",
     "event",
+    "hex",
     "interop",
     "logger",
     "memory",
     "modular",
+    "polyglot",
+    "shared-memory",
     "string",
     "typedarray",
     "typescript",
     "utf8",
     "wasm",
     "webassembly",
+    "zig",
     "ziglang"
   ],
   "publishConfig": {
@@ -110,5 +115,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "199dcde33bf3d0b0bbd205d3b870dff43b735b22\n"
+  "gitHead": "54c5f22520162bac0d58426a3f86ca636e797f71\n"
 }