@thi.ng/wasm-api 1.2.1 → 1.2.3

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-02T14:13:34Z
+- **Last updated**: 2022-12-16T12:52:25Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![wasm-api](https://media.thi.ng/umbrella/banners-20220914/thing-wasm-api.svg?be328da7)
+# ![@thi.ng/wasm-api](https://media.thi.ng/umbrella/banners-20220914/thing-wasm-api.svg?be328da7)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/wasm-api.svg)](https://www.npmjs.com/package/@thi.ng/wasm-api)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/wasm-api.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -31,7 +31,7 @@ This project is part of the
 
 ## About
 
-Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects.
+Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects
 
 This package provides the following:
 
@@ -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,13 +305,17 @@ 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 dependencies to other such packages
         // (wasm-api and wasm-api-bindgen are made available everywhere)
@@ -320,9 +324,14 @@ pub fn build(b: *std.build.Builder) void {
             .{ .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)
+        // 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();
 }
 ```
 
@@ -365,11 +374,8 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const wasmApi = await import("@thi.ng/wasm-api");
+```js
+const wasmApi = await import("@thi.ng/wasm-api");
 ```
 
 Package sizes (brotli'd, pre-treeshake): ESM: 2.47 KB
@@ -512,7 +518,7 @@ emcc -Os -Inode_modules/@thi.ng/wasm-api/include \
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -527,4 +533,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2022 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -2,8 +2,8 @@ import type { Fn, IDeref, ILength } from "@thi.ng/api";
 import type { WasmBridge } from "./bridge.js";
 export declare const EVENT_MEMORY_CHANGED = "memory-changed";
 export declare const EVENT_PANIC = "panic";
-export declare type BigIntArray = bigint[] | BigInt64Array | BigUint64Array;
-export declare type ReadonlyWasmString = IDeref<string> & ILength & {
+export type BigIntArray = bigint[] | BigInt64Array | BigUint64Array;
+export type ReadonlyWasmString = IDeref<string> & ILength & {
     readonly addr: number;
 };
 export interface WasmTypeBase {
@@ -21,7 +21,7 @@ export interface WasmType<T> {
     readonly size: number;
     instance: Fn<number, T>;
 }
-export declare type WasmTypeConstructor<T> = Fn<IWasmMemoryAccess, WasmType<T>>;
+export type WasmTypeConstructor<T> = Fn<IWasmMemoryAccess, WasmType<T>>;
 /**
  * Common interface for WASM/JS child APIs which will be used in combination
  * with a parent {@link WasmBridge}.
@@ -111,7 +111,7 @@ export interface WasmExports {
      */
     _wasm_free(addr: number, numBytes: number): void;
 }
-export declare type MemorySlice = [addr: number, len: number];
+export type MemorySlice = [addr: number, len: number];
 export interface IWasmMemoryAccess {
     i8: Int8Array;
     u8: Uint8Array;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/wasm-api",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/wasm-api#readme",
+  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/wasm-api#readme",
   "funding": [
     {
       "type": "github",
@@ -21,7 +21,7 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -35,21 +35,21 @@
     "test:build-zig": "zig build-lib -O ReleaseSmall -target wasm32-freestanding -dynamic --strip --pkg-begin wasmapi zig/lib.zig --pkg-end test/custom.zig && wasm-dis -o custom.wast custom.wasm && cp custom.wasm test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/arrays": "^2.4.4",
-    "@thi.ng/checks": "^3.3.4",
-    "@thi.ng/errors": "^2.2.5",
-    "@thi.ng/hex": "^2.3.1",
-    "@thi.ng/idgen": "^2.1.20",
-    "@thi.ng/logger": "^1.4.4"
+    "@thi.ng/api": "^8.6.0",
+    "@thi.ng/arrays": "^2.4.5",
+    "@thi.ng/checks": "^3.3.5",
+    "@thi.ng/errors": "^2.2.6",
+    "@thi.ng/hex": "^2.3.2",
+    "@thi.ng/idgen": "^2.1.21",
+    "@thi.ng/logger": "^1.4.5"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "allocator",
@@ -115,5 +115,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "7d1e314f207299ff3c1a782d287ad99120b40b85\n"
+  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
 }