@thi.ng/wasm-api 1.2.7 → 1.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-01-10T15:20:19Z
+- **Last updated**: 2023-02-05T14:42:22Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ 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.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@1.3.0) (2023-02-05)
+
+#### 🚀 Features
+
+- add ManagedIndex.initCapacity() ([788dfa2](https://github.com/thi-ng/umbrella/commit/788dfa2))
+- add WasmType.instanceArray(), add docs ([2adf65f](https://github.com/thi-ng/umbrella/commit/2adf65f))
+
 ## [1.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@1.2.0) (2022-12-01)
 
 #### 🚀 Features

package/api.d.ts

@@ -17,9 +17,29 @@ export interface WasmTypeBase {
     readonly __bytes: Uint8Array;
 }
 export interface WasmType<T> {
+    /**
+     * Type alignment (in bytes)
+     */
     readonly align: number;
+    /**
+     * Type size (in bytes)
+     */
     readonly size: number;
-    instance: Fn<number, T>;
+    /**
+     * Takes a start address and number of items. Returns an array of memory
+     * mapped type instances (see {@link WasmType.instance}).
+     *
+     * @param base
+     * @param num
+     * @returns
+     */
+    instanceArray: (base: number, num: number) => T[];
+    /**
+     * Returns a memory-mapped type instance for given start address.
+     *
+     * @param base
+     */
+    instance: (base: number) => T;
 }
 export type WasmTypeConstructor<T> = Fn<IWasmMemoryAccess, WasmType<T>>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/wasm-api",
-  "version": "1.2.7",
+  "version": "1.3.0",
   "description": "Generic, modular, extensible API bridge and infrastructure for hybrid JS & WebAssembly projects",
   "type": "module",
   "module": "./index.js",
@@ -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.6.3",
-    "@thi.ng/arrays": "^2.5.1",
-    "@thi.ng/checks": "^3.3.7",
-    "@thi.ng/errors": "^2.2.8",
-    "@thi.ng/hex": "^2.3.4",
-    "@thi.ng/idgen": "^2.1.24",
-    "@thi.ng/logger": "^1.4.7"
+    "@thi.ng/api": "^8.7.0",
+    "@thi.ng/arrays": "^2.5.2",
+    "@thi.ng/checks": "^3.3.8",
+    "@thi.ng/errors": "^2.2.9",
+    "@thi.ng/hex": "^2.3.5",
+    "@thi.ng/idgen": "^2.1.25",
+    "@thi.ng/logger": "^1.4.8"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.9",
-    "rimraf": "^3.0.2",
+    "@microsoft/api-extractor": "^7.34.2",
+    "@thi.ng/testament": "^0.3.10",
+    "rimraf": "^4.1.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.22",
-    "typescript": "^4.9.4"
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.5"
   },
   "keywords": [
     "allocator",
@@ -115,5 +115,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "3f0b3e2a7c82aefc7e46fb4338369836b5e1b8cf\n"
+  "gitHead": "50ba9c87676fac60c46d2bc0e4d2c7711a374a68\n"
 }

package/zig/managed-index.zig

@@ -42,6 +42,13 @@ pub fn ManagedIndex(comptime T: type, comptime I: type) type {
             };
         }
 
+        /// Initializes the underlying array list with given initial capacity
+        pub fn initCapacity(allocator: Allocator, num: usize) !Self {
+            return .{
+                .list = try std.ArrayList(Item).initCapacity(allocator, num),
+            };
+        }
+
         /// De-initializes the underlying array list
         pub fn deinit(self: *Self) void {
             self.list.deinit();
@@ -89,7 +96,7 @@ pub fn ManagedIndex(comptime T: type, comptime I: type) type {
         }
 
         /// Returns true if given `id` is valid, i.e. is referring to a
-        /// currently used item (and isn't part of the list of free slots).
+        /// currently used item and isn't part of the list of free slots.
         pub fn has(self: *const Self, id: I) bool {
             if (id >= self.list.items.len) return false;
             var freeID = self.freeID;
@@ -112,7 +119,7 @@ pub fn ManagedIndex(comptime T: type, comptime I: type) type {
                 return .{ .parent = parent };
             }
 
-            pub fn next(self: *@This()) ?T {
+            pub inline fn next(self: *@This()) ?T {
                 const items = self.parent.list.items;
                 if (self.i >= items.len) return null;
                 while (self.i < items.len) {
@@ -155,8 +162,8 @@ pub fn ManagedIndex(comptime T: type, comptime I: type) type {
             while (i < slice.len) {
                 if (freeID) |fid| {
                     slice[i] = fid;
-                    i += 1;
                     freeID = self.list.items[fid].id;
+                    i += 1;
                 } else {
                     break;
                 }