@thi.ng/wasm-api 0.16.0 → 0.17.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-10-28T19:08:39Z
+- **Last updated**: 2022-10-30T12:26:06Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,28 @@ 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.
 
+### [0.17.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@0.17.1) (2022-10-30)
+
+#### ♻️ Refactoring
+
+- update zig codegen to ignore uppercase enum config ([3258f91](https://github.com/thi-ng/umbrella/commit/3258f91))
+  - idiomatic zig enums are lowercase
+  - update config docs
+
+## [0.17.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@0.17.0) (2022-10-29)
+
+#### 🚀 Features
+
+- update default value format & handling ([c7752fb](https://github.com/thi-ng/umbrella/commit/c7752fb))
+  - update Field.default to support lang-specific alts
+  - add defaultValue() helper
+  - update zig codegen
+
+#### 🩹 Bug fixes
+
+- fix idempotence checks for self-referential types ([2c3f670](https://github.com/thi-ng/umbrella/commit/2c3f670))
+  - update prepareType()
+
 ## [0.16.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/wasm-api@0.16.0) (2022-10-28)
 
 #### 🚀 Features

package/api.d.ts

@@ -1,4 +1,4 @@
-import type { BigType, FloatType, Fn, Fn2, IDeref, ILength, IObjectOf } from "@thi.ng/api";
+import type { BigType, FloatType, Fn, Fn2, IDeref, ILength, IObjectOf, NumOrString } from "@thi.ng/api";
 import type { Pow2 } from "@thi.ng/binary";
 import type { WasmBridge } from "./bridge.js";
 export declare const PKG_NAME = "@thi.ng/wasm-api";
@@ -224,7 +224,7 @@ export declare type WasmPrim32 = Exclude<WasmPrim, BigType>;
 export declare type ReadonlyWasmString = IDeref<string> & ILength & {
     readonly addr: number;
 };
-export declare type TypeColl = Record<string, TopLevelType>;
+export declare type TypeColl = IObjectOf<TopLevelType>;
 export interface TypeInfo {
     /**
      * Auto-computed size (in bytes)
@@ -370,10 +370,14 @@ export interface Field extends TypeInfo {
      */
     len?: number;
     /**
-     * Currently only supported for {@link ZIG} scalar & string values,
-     * otherwise ignored!
+     * Currently only supported for {@link ZIG}, otherwise ignored!
+     *
+     * @remarks
+     * The object form allows for different default values per language (in
+     * theory). So if given as object, the keys refer to the lang ID and the
+     * values as the defaults for those languages.
      */
-    default?: number;
+    default?: NumOrString | IObjectOf<NumOrString>;
     /**
      * If defined and > 0, the field will be considered for padding purposes
      * only and the value provided is the number of bytes used. All other config

package/codegen/utils.d.ts

@@ -59,6 +59,14 @@ export declare const stringFields: (fields: Field[]) => Field[];
  * @internal
  */
 export declare const enumName: (opts: CodeGenOpts, name: string) => string;
+/**
+ * Returns given field's default value (or undefined). The `lang` ID is required
+ * to obtain the language specific value if the default is given as object.
+ *
+ * @param f
+ * @param lang
+ */
+export declare const defaultValue: (f: Field, lang: string) => import("@thi.ng/api").NumOrString | undefined;
 /**
  * Takes an array of strings or splits given string into lines, word wraps and
  * then prefixes each line with given `width` and `prefix`. Returns array of new

package/codegen/utils.js

@@ -1,4 +1,5 @@
 import { isArray } from "@thi.ng/checks/is-array";
+import { isPlainObject } from "@thi.ng/checks/is-plain-object";
 import { isString } from "@thi.ng/checks/is-string";
 import { split } from "@thi.ng/strings/split";
 import { wordWrapLine, wordWrapLines } from "@thi.ng/strings/word-wrap";
@@ -61,6 +62,18 @@ export const stringFields = (fields) => fields.filter((f) => isWasmString(f.type
  * @internal
  */
 export const enumName = (opts, name) => opts.uppercaseEnums ? name.toUpperCase() : name;
+/**
+ * Returns given field's default value (or undefined). The `lang` ID is required
+ * to obtain the language specific value if the default is given as object.
+ *
+ * @param f
+ * @param lang
+ */
+export const defaultValue = (f, lang) => f.default !== undefined
+    ? isPlainObject(f.default)
+        ? f.default[lang]
+        : f.default
+    : undefined;
 /**
  * Takes an array of strings or splits given string into lines, word wraps and
  * then prefixes each line with given `width` and `prefix`. Returns array of new

package/codegen/zig.js

@@ -1,7 +1,7 @@
-import { isNumber } from "@thi.ng/checks/is-number";
+import { isNumber } from "@thi.ng/checks";
 import { isString } from "@thi.ng/checks/is-string";
 import { unsupported } from "@thi.ng/errors/unsupported";
-import { ensureLines, enumName, isPadding, isStringSlice, isWasmString, prefixLines, withIndentation, } from "./utils.js";
+import { defaultValue, ensureLines, isPadding, isStringSlice, isWasmString, prefixLines, withIndentation, } from "./utils.js";
 /**
  * Zig code generator. Call with options and then pass to {@link generateTypes}
  * (see its docs for further usage).
@@ -28,12 +28,12 @@ export const ZIG = (opts = {}) => {
                 let line;
                 if (!isString(v)) {
                     v.doc && gen.doc(v.doc, lines, opts);
-                    line = enumName(opts, v.name);
+                    line = v.name;
                     if (v.value != null)
                         line += ` = ${v.value}`;
                 }
                 else {
-                    line = enumName(opts, v);
+                    line = v;
                 }
                 lines.push(line + ",");
             }
@@ -109,7 +109,7 @@ export const fieldType = (parent, f, opts) => {
                 ? "[*:0]const u8"
                 : "[*:0]u8"
         : f.type;
-    let defaultVal = "";
+    let defaultVal = defaultValue(f, "zig");
     switch (f.tag) {
         case "array":
             type =
@@ -128,14 +128,16 @@ export const fieldType = (parent, f, opts) => {
             break;
         case "scalar":
         default:
-            if (f.default != undefined) {
-                if (!(isString(f.default) || isNumber(f.default))) {
-                    unsupported(`wrong default value for ${parent.name}.${f.name} (${f.default})`);
+            if (defaultVal != undefined) {
+                if (!(isString(defaultVal) || isNumber(defaultVal))) {
+                    unsupported(`wrong default value for ${parent.name}.${f.name} (${defaultVal})`);
                 }
-                defaultVal = ` = ${JSON.stringify(f.default)}`;
             }
     }
-    return { type, defaultVal };
+    return {
+        type,
+        defaultVal: defaultVal != undefined ? ` = ${defaultVal}` : "",
+    };
 };
 const __packedPadding = (id, n, res) => {
     let i = 0;

package/codegen.js

@@ -113,13 +113,13 @@ const alignOf = defmulti((x) => x.type, {}, {
 });
 const prepareType = defmulti((x) => x.type, {}, {
     [DEFAULT]: (x, types, alignImpl, opts) => {
-        if (x.__align && x.__size)
+        if (x.__align)
             return;
         alignOf(x, types, alignImpl, opts);
         sizeOf(x, types, alignImpl, opts);
     },
     struct: (x, types, align, opts) => {
-        if (x.__align && x.__size)
+        if (x.__align)
             return;
         const struct = x;
         alignOf(struct, types, align, opts);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/wasm-api",
-  "version": "0.16.0",
+  "version": "0.17.1",
   "description": "Generic, modular, extensible API bridge, polyglot glue code and bindings code generators for hybrid JS & WebAssembly projects",
   "type": "module",
   "module": "./index.js",
@@ -141,5 +141,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "41e59c7ad9bf24bb0230a5f60d05715e0fc1c1e6\n"
+  "gitHead": "78682fcd936495fefa1345db5a8dfd709eace2c8\n"
 }