@thi.ng/wasm-api - npm Package Compare versions

Comparing version 1.3.2 to 1.4.0

CHANGELOG.md

 # Change Log
 
-- **Last updated**: 2023-02-10T14:03:11Z
+- **Last updated**: 2023-02-17T20:06:13Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
@@ -12,2 +12,15 @@
 
+## [1.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@1.4.0) (2023-02-17)
+
+#### 🚀 Features
+
+- add build script for Zig v0.11.0-dev ([4c8abcb](https://github.com/thi-ng/umbrella/commit/4c8abcb))
+
+#### ♻️ Refactoring
+
+- update build-v0.11.zig build script ([fe7c24c](https://github.com/thi-ng/umbrella/commit/fe7c24c))
+  - single source of truth for core module names
+  - rename .mode => .optimize (as per new zig nomenclature)
+  - add autodoc generation option
+
 ## [1.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@1.3.0) (2023-02-05)
@@ -14,0 +27,0 @@

package.json

 {
   "name": "@thi.ng/wasm-api",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects",
@@ -39,3 +39,3 @@ "type": "module",
     "@thi.ng/api": "^8.7.2",
-    "@thi.ng/arrays": "^2.5.4",
+    "@thi.ng/arrays": "^2.5.5",
     "@thi.ng/checks": "^3.3.9",
@@ -119,3 +119,3 @@ "@thi.ng/errors": "^2.2.11",
   },
-  "gitHead": "cafa4ecea90fb681949dc3885a5bd6ddefa38b51\n"
+  "gitHead": "7896250248d960109253215c75b115c46626293e\n"
 }

README.md

@@ -19,2 +19,5 @@ <!-- This file is generated - DO NOT EDIT! -->
 - [Using the Zig build system](#using-the-zig-build-system)
+  - [Zig v0.10.1 or older](#zig-v0101-or-older)
+  - [Zig v0.11.0-dev or newer](#zig-v0110-dev-or-newer)
+  - [Example projects](#example-projects)
 - [Naming & structural conventions](#naming--structural-conventions)
@@ -313,2 +316,4 @@ - [Status](#status)
 
+### Zig v0.10.1 or older
+
 ```zig
@@ -340,7 +345,42 @@ const std = @import("std");
 
+### Zig v0.11.0-dev or newer
+
+(Note: Several new build options have been added, e.g. initial/max memory
+config, autodoc generation)
+
+```zig
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    // obtain a standard std.Build.CompileStep, pre-configured w/ given options
+    // see source comments in imported build-v0.11.zig for further details...
+    var lib = @import("node_modules/@thi.ng/wasm-api/zig/build-v0.11.zig").wasmLib(b, .{
+        // Declare extra WASM API modules to use
+        // Each can also declare dependencies to other modules
+        // (`wasm-api` and `wasm-api-bindgen` are made available everywhere)
+        .modules = &.{
+            .{ .name = "wasm-api-dom", .path = "@thi.ng/wasm-api-dom/zig/lib.zig" },
+            .{ .name = "wasm-api-schedule", .path = "@thi.ng/wasm-api-schedule/zig/lib.zig" },
+        },
+        // (optional) optimization mode override
+        // if commented out, we can pass CLI args to choose mode (default: .Debug)
+        .optimize = .ReleaseSmall,
+    });
+    // optionally, add further custom configuration
+    // ...
+
+    // finally trigger build
+    lib.install();
+}
+```
+
+### Example projects
+
 All bundled example projects (see [list below](#usage-examples)) are being built
 via this script. **Please find more details/options in the commented source
 code:**
-[`/zig/build.zig`](https://github.com/thi-ng/umbrella/blob/develop/packages/wasm-api/zig/build.zig)
 
+- [`/zig/build.zig`](https://github.com/thi-ng/umbrella/blob/develop/packages/wasm-api/zig/build.zig)
+- [`/zig/build-v0.11.zig`](https://github.com/thi-ng/umbrella/blob/develop/packages/wasm-api/zig/build-v0.11.zig)
+
 ## Naming & structural conventions
@@ -347,0 +387,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

140431

increased by5.41%

Number of downloads

105

increased by208.82%

Number of package files

21

increased by5%

Number of lines in readme file

578

increased by7.43%

Dependency changes

• [e-mail]/arrays@^2.5.5