@pkmn/engine 0.1.0-dev.c5fe6d07 → 0.1.0-dev.ce4c0b2a

package/package.json

@@ -1,19 +1,28 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.c5fe6d07",
+  "version": "0.1.0-dev.ce4c0b2a",
   "description": "A minimal, complete, Pokémon battle simulation engine optimized for performance",
   "repository": "github:pkmn/engine",
   "license": "MIT",
   "sideEffects": false,
   "main": "build/pkg/index.js",
   "types": "build/pkg/index.d.ts",
+  "browser": {
+    "./build/pkg/addon/node.js": "./build/pkg/addon/browser.js"
+  },
   "files": [
     "build.zig",
-    "build/pkg/data.d.ts",
-    "build/pkg/data.js.map",
     "build/pkg/addon.d.ts",
     "build/pkg/addon.js.map",
     "build/pkg/addon.js",
+    "build/pkg/addon/browser.d.ts",
+    "build/pkg/addon/browser.js.map",
+    "build/pkg/addon/browser.js",
+    "build/pkg/addon/node.d.ts",
+    "build/pkg/addon/node.js.map",
+    "build/pkg/addon/node.js",
+    "build/pkg/data.d.ts",
+    "build/pkg/data.js.map",
     "build/pkg/data.js",
     "build/pkg/data/ids.json",
     "build/pkg/data/layout.json",
@@ -27,13 +36,17 @@
     "build/pkg/protocol.d.ts",
     "build/pkg/protocol.js.map",
     "build/pkg/protocol.js",
-    "build/test/display.js.map",
-    "build/test/display.js",
     "build/tools/debug.js.map",
     "build/tools/debug.js",
-    "src/bin/install-pkmn-engine",
-    "src/lib/binding/node.zig",
-    "src/lib/binding/wasm.zig",
+    "build/tools/display/index.js.map",
+    "build/tools/display/index.js",
+    "build/tools/display/debug.jsx.map",
+    "build/tools/display/debug.jsx",
+    "build/tools/display/ui.jsx.map",
+    "build/tools/display/ui.jsx",
+    "build/tools/display/util.js.map",
+    "build/tools/display/util.js",
+    "src/lib/common/array.zig",
     "src/lib/common/battle.zig",
     "src/lib/common/data.zig",
     "src/lib/common/debug.zig",
@@ -52,15 +65,21 @@
     "src/lib/gen1/data/types.zig",
     "src/lib/gen1/helpers.zig",
     "src/lib/gen1/mechanics.zig",
+    "src/lib/gen2/calc.zig",
+    "src/lib/gen2/chance.zig",
     "src/lib/gen2/data.zig",
     "src/lib/gen2/data/items.zig",
     "src/lib/gen2/data/moves.zig",
     "src/lib/gen2/data/species.zig",
     "src/lib/gen2/data/types.zig",
+    "src/lib/gen2/generated.zig",
     "src/lib/gen2/helpers.zig",
     "src/lib/gen2/mechanics.zig",
+    "src/lib/node.zig",
     "src/lib/pkmn.zig",
-    "src/test/display/pkmn.html.tmpl"
+    "src/lib/wasm.zig",
+    "src/tools/display/dom.ts",
+    "src/tools/display/ui.css"
   ],
   "engines": {
     "node": ">=16.0.0"
@@ -73,30 +92,35 @@
     "access": "public"
   },
   "dependencies": {
-    "@pkmn/data": "^0.7.46",
-    "@pkmn/protocol": "^0.6.12"
+    "@pkmn/data": "^0.9.13",
+    "@pkmn/protocol": "^0.6.26"
   },
   "devDependencies": {
-    "@pkmn/eslint-config": "^5.0.0",
-    "@pkmn/img": "^0.2.13",
-    "@pkmn/sets": "^5.0.4",
-    "@pkmn/sim": "0.7.46",
-    "@types/html-minifier": "^4.0.2",
-    "@types/jest": "^29.5.3",
-    "@types/minimist": "^1.2.2",
-    "@types/mustache": "^4.2.2",
-    "@types/node": "^20.4.2",
-    "@vitest/coverage-c8": "^0.33.0",
-    "binaryen": "^114.0.0",
-    "eslint": "^8.44.0",
+    "@pkmn/eslint-config": "^8.3.0",
+    "@pkmn/img": "^0.2.32",
+    "@pkmn/sets": "^5.1.2",
+    "@pkmn/sim": "0.9.13",
+    "@types/html-minifier": "^4.0.5",
+    "@types/jest": "^29.5.12",
+    "@types/minimist": "^1.2.5",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^22.5.3",
+    "@types/react": "^18.2.45",
+    "@types/semver": "^7.5.8",
+    "@vitest/coverage-v8": "^2.0.5",
+    "binaryen": "^118.0.0",
+    "esbuild": "^0.23.1",
+    "eslint": "<=8",
     "html-minifier": "^4.0.0",
-    "json-stringify-pretty-compact": "3.0.0",
+    "json-stringify-pretty-compact": "4.0.0",
     "minimist": "^1.2.8",
     "mustache": "^4.2.0",
+    "semver": "^7.6.3",
     "source-map-support": "^0.5.21",
+    "table": "^6.8.2",
     "trakr": "^0.2.0",
-    "typescript": "^5.1.6",
-    "vitest": "^0.33.0"
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5"
   },
   "scripts": {
     "lint": "eslint --cache src --ext ts,js && eslint src/bin/*",
@@ -106,6 +130,7 @@
     "test": "vitest src/pkg",
     "test:integration": "vitest src/test",
     "debug": "npm run compile && node build/tools/debug",
+    "demo": "npm run compile && node build/tools/demo",
     "fuzz": "npm run compile && node build/test/fuzz",
     "generate": "npm run compile && node build/tools/generate",
     "release": "npm run compile && node build/tools/release",
@@ -118,7 +143,7 @@
     "ignorePatterns": [
       "dist/",
       "node_modules/",
-      "src/examples/zig",
+      "examples/zig",
       "build/"
     ],
     "env": {
@@ -134,14 +159,13 @@
         "parserOptions": {
           "project": [
             "./tsconfig.json",
-            "./src/examples/js/tsconfig.json"
+            "./examples/js/tsconfig.json"
           ]
         }
       },
       {
         "files": [
           "src/pkg/index.ts",
-          "src/test/display.ts",
           "src/test/integration.ts"
         ],
         "rules": {
@@ -153,7 +177,7 @@
       },
       {
         "files": [
-          "src/pkg/addon.ts"
+          "src/pkg/addon/node.ts"
         ],
         "rules": {
           "@typescript-eslint/no-var-requires": "off"
@@ -168,6 +192,15 @@
           "@typescript-eslint/no-redundant-type-constituents": "off"
         }
       },
+      {
+        "files": [
+          "src/pkg/protocol.test.ts"
+        ],
+        "rules": {
+          "jest/no-standalone-expect": "off",
+          "jest/no-conditional-expect": "off"
+        }
+      },
       {
         "files": [
           "src/test/*.test.ts",

package/src/bin/install-pkmn-engine

@@ -163,8 +163,10 @@ const install = async () => {
   }
 
   const index = JSON.parse(await fetch(INDEX));
-  const version = Object.keys(index)[+!ZIG_VERSION.dev];
-  const release = index[version][`${arch}-${platform}`];
+  // TODO: ziglang/zig#17768
+  // const version = Object.keys(index)[+!ZIG_VERSION.dev];
+  const version = VERSION;
+  const release = index[VERSION][`${arch}-${platform}`];
   const url = release.tarball;
 
   let base = path.basename(url);
@@ -283,19 +285,19 @@ const downloadImportLib = async () => {
   let error = false;
   for (let i = 2; i < process.argv.length; i++) {
     switch (process.argv[i]) {
-    case "--silent": {
-      SILENT = true;
-      break;
-    }
-    case "--zig": {
-      if (options || only) error = true;
-      only = true;
-      break;
-    }
-    default: {
-      if (options || only || !process.argv[i].startsWith('--options=')) error = true;
-      options = process.argv[i].slice(10).split(' ');
-    }
+      case "--silent": {
+        SILENT = true;
+        break;
+      }
+      case "--zig": {
+        if (options || only) error = true;
+        only = true;
+        break;
+      }
+      default: {
+        if (options || only || !process.argv[i].startsWith('--options=')) error = true;
+        options = process.argv[i].slice(10).split(' ');
+      }
     }
   }
   if (error) {
@@ -370,8 +372,10 @@ const downloadImportLib = async () => {
     const args = ['build', '-p', 'build', ...opts];
     if (!process.env.DEBUG_PKMN_ENGINE) args.push('-Doptimize=ReleaseFast', '-Dstrip');
     if (config.type === 'node') {
-      args.push(`-Dnode-headers=${headers}`);
-      if (process.platform === 'win32') args.push(`-Dnode-import-library=${lib}`);
+      args.push(`-Dnode-headers=${path.relative(ROOT, headers)}`);
+      if (process.platform === 'win32') {
+        args.push(`-Dnode-import-library=${path.relative(ROOT, lib)}`);
+      }
     } else {
       args.push('-Dwasm');
     }
@@ -386,8 +390,14 @@ const downloadImportLib = async () => {
       const prefix = process.platform === 'win32' ? '' : 'lib';
       const ext = process.platform === 'darwin'
         ? 'dylib' : process.platform === 'win32' ? 'dll' : 'so';
-      const actual = path.join('build', 'lib', `${prefix}pkmn${suffix}.node.${ext}`);
-      fs.renameSync(path.join(ROOT, actual), path.join(ROOT, artifact));
+      try {
+        const actual = path.join(ROOT, 'build', 'lib', `${prefix}pkmn${suffix}.node.${ext}`);
+        fs.renameSync(actual, artifact);
+      } catch (err) {
+        // ziglang/zig#19743 changed this path
+        const actual = path.join(ROOT, 'build', 'bin', `${prefix}pkmn${suffix}.node.${ext}`);
+        fs.renameSync(actual, artifact);
+      }
     }
   }
 })().catch(e => {

package/src/bin/pkmn-debug

@@ -15,7 +15,7 @@ const ROOT = resolve(__dirname, '..', '..');
 const packageJSON = JSON.parse(readFileSync(join(ROOT, 'package.json'), 'utf8'));
 
 const missing = [];
-for (const dep of ['@pkmn/img', 'html-minifier', 'mustache']) {
+for (const dep of ['@pkmn/img', 'html-minifier', 'esbuild']) {
   try {
     require.resolve(dep);
   } catch (e) {

package/src/lib/common/array.zig

@@ -0,0 +1,77 @@
+const std = @import("std");
+
+const expectEqual = std.testing.expectEqual;
+const assert = std.debug.assert;
+
+const Int = if (@hasField(std.builtin.Type, "int")) .int else .Int;
+const Enum = if (@hasField(std.builtin.Type, "enum")) .@"enum" else .Enum;
+
+/// Helpers for working with bit-packed arrays of non-powers-of-2 types.
+/// NOTE: ziglang/zig#12547
+pub fn Array(comptime n: comptime_int, comptime U: type) type {
+    return struct {
+        const size = @bitSizeOf(U);
+        const options = .{ .signedness = .unsigned, .bits = size * n };
+        pub const T = @Type(if (@hasField(std.builtin.Type, "int"))
+            .{ .int = options }
+        else
+            .{ .Int = options });
+
+        /// Returns the value stored at index `i` in the array `a`.
+        pub fn get(a: T, i: usize) U {
+            assert(i < n);
+            const shift = i * size;
+            const mask: T = (1 << size) - 1;
+            const result = (a >> @intCast(shift)) & mask;
+            return switch (@typeInfo(U)) {
+                Enum => @enumFromInt(result),
+                Int => @intCast(result),
+                else => unreachable,
+            };
+        }
+
+        /// Sets the value at index `i` to `val` in the array `a`.
+        pub fn set(a: T, i: usize, val: U) T {
+            assert(i < n);
+            const v: T = switch (@typeInfo(U)) {
+                Enum => @intFromEnum(val),
+                Int => @intCast(val),
+                else => unreachable,
+            };
+            const shift = i * size;
+            const mask: T = @as(T, @intCast((1 << size) - 1)) << @intCast(shift);
+            const result: T = a & ~mask;
+            return result | (v << @intCast(shift));
+        }
+    };
+}
+
+test Array {
+    const A = Array(5, u8);
+    var a: A.T = 0;
+    try expectEqual(u40, @TypeOf(a));
+
+    a = A.set(a, 4, 241);
+    try expectEqual(@as(u8, 241), A.get(a, 4));
+    a = A.set(a, 4, 1);
+    try expectEqual(@as(u8, 1), A.get(a, 4));
+
+    for (0..5) |i| a = A.set(a, i, @intCast(i));
+    for (0..5) |i| try expectEqual(@as(u8, @intCast(i)), A.get(a, i));
+
+    const Optional = @import("optional.zig").Optional;
+
+    const B = Array(4, Optional(bool));
+    var b: B.T = 0;
+    try expectEqual(u8, @TypeOf(b));
+
+    b = B.set(b, 2, .true);
+    try expectEqual(Optional(bool).None, B.get(b, 1));
+    try expectEqual(Optional(bool).true, B.get(b, 2));
+    try expectEqual(@as(u8, 0b00100000), b);
+    b = B.set(b, 2, .None);
+    b = B.set(b, 0, .false);
+    try expectEqual(Optional(bool).None, B.get(b, 2));
+    try expectEqual(Optional(bool).false, B.get(b, 0));
+    try expectEqual(@as(u8, 0b0000001), b);
+}

package/src/lib/common/data.zig

@@ -9,12 +9,12 @@ pub const Player = enum(u1) {
     P2,
 
     /// Returns a player's opponent.
-    pub inline fn foe(self: Player) Player {
+    pub fn foe(self: Player) Player {
         return @enumFromInt(~@intFromEnum(self));
     }
 
     /// Return's an identifier for the player's Pokémon at the one-indexed `id`.
-    pub inline fn ident(self: Player, id: u3) ID {
+    pub fn ident(self: Player, id: u3) ID {
         assert(id > 0 and id <= 6);
         return .{ .id = id, .player = self };
     }
@@ -27,24 +27,20 @@ test Player {
 }
 
 /// An identifier for a specific Pokémon in battle.
-pub const ID = packed struct {
+pub const ID = packed struct(u8) {
     /// The one-indexed team slot of the Pokémon
     id: u3 = 0,
     /// The Pokémon's trainer.
     player: Player = .P1,
     _: u4 = 0,
 
-    comptime {
-        assert(@sizeOf(ID) == 1);
-    }
-
     /// Converts the identifier into a number.
-    pub inline fn int(self: ID) u4 {
+    pub fn int(self: ID) u4 {
         return @intCast(@as(u8, @bitCast(self)));
     }
 
     /// Decodes the identifier from a number.
-    pub inline fn from(id: u4) ID {
+    pub fn from(id: u4) ID {
         return @bitCast(@as(u8, id));
     }
 };
@@ -52,12 +48,12 @@ pub const ID = packed struct {
 test ID {
     try expectEqual(@as(u8, 0b0001), @as(u8, @bitCast(ID{ .player = .P1, .id = 1 })));
     try expectEqual(@as(u8, 0b1101), @as(u8, @bitCast(ID{ .player = .P2, .id = 5 })));
-    const id = ID{ .player = .P2, .id = 4 };
+    const id: ID = .{ .player = .P2, .id = 4 };
     try expectEqual(id, ID.from(id.int()));
 }
 
 /// A choice made by a player during battle.
-pub const Choice = packed struct {
+pub const Choice = packed struct(u8) {
     /// The choice type.
     type: Choice.Type = .Pass,
     /// The choice data:
@@ -73,10 +69,6 @@ pub const Choice = packed struct {
         Move,
         Switch,
     };
-
-    comptime {
-        assert(@sizeOf(Choice) == 1);
-    }
 };
 
 test Choice {
@@ -84,12 +76,12 @@ test Choice {
     const p2: Choice = .{ .type = .Switch, .data = 5 };
     try expectEqual(5, p2.data);
     try expectEqual(Choice.Type.Move, p1.type);
-    try expectEqual(0b0001_0001, @as(u8, @bitCast(p1)));
-    try expectEqual(0b0001_0110, @as(u8, @bitCast(p2)));
+    try expectEqual(@as(u8, 0b0001_0001), @as(u8, @bitCast(p1)));
+    try expectEqual(@as(u8, 0b0001_0110), @as(u8, @bitCast(p2)));
 }
 
 /// The result of the battle - all results other than 'None' should be considered terminal.
-pub const Result = packed struct {
+pub const Result = packed struct(u8) {
     /// The type of result from the perspective of Player 1.
     /// `Error` is not possible when in Pokémon Showdown compatibility mode.
     type: Result.Type = .None,
@@ -117,13 +109,9 @@ pub const Result = packed struct {
     pub const Error: Result = .{ .type = .Error };
     /// The default result.
     pub const Default: Result = .{ .p1 = .Move, .p2 = .Move };
-
-    comptime {
-        assert(@sizeOf(Result) == 1);
-    }
 };
 
 test Result {
-    try expectEqual(0b0101_0000, @as(u8, @bitCast(Result.Default)));
-    try expectEqual(0b1000_0000, @as(u8, @bitCast(Result{ .p2 = .Switch })));
+    try expectEqual(@as(u8, 0b0101_0000), @as(u8, @bitCast(Result.Default)));
+    try expectEqual(@as(u8, 0b1000_0000), @as(u8, @bitCast(Result{ .p2 = .Switch })));
 }

package/src/lib/common/debug.zig

@@ -3,9 +3,14 @@ const std = @import("std");
 const debug = std.debug;
 const io = std.io;
 
+const Array = if (@hasField(std.builtin.Type, "array")) .array else .Array;
+const Optional = if (@hasField(std.builtin.Type, "optional")) .optional else .Optional;
+const Pointer = if (@hasField(std.builtin.Type, "pointer")) .pointer else .Pointer;
+const Struct = if (@hasField(std.builtin.Type, "struct")) .@"struct" else .Struct;
+
 pub fn print(value: anytype) void {
-    debug.getStderrMutex().lock();
-    defer debug.getStderrMutex().unlock();
+    debug.lockStdErr();
+    defer debug.unlockStdErr();
     const stderr = io.getStdErr().writer();
 
     nosuspend {
@@ -19,7 +24,7 @@ pub fn print(value: anytype) void {
             }) catch return;
         } else {
             switch (@typeInfo(@TypeOf(value))) {
-                .Struct => |info| {
+                Struct => |info| {
                     if (info.is_tuple) {
                         inline for (info.fields, 0..) |f, i| {
                             inspect(@field(value, f.name));
@@ -42,11 +47,11 @@ fn inspect(value: anytype) void {
     nosuspend {
         const err = "Unable to format type '" ++ @typeName(@TypeOf(value)) ++ "'";
         switch (@typeInfo(@TypeOf(value))) {
-            .Array => |info| {
+            Array => |info| {
                 if (info.child == u8) return stderr.print("{s}", .{value}) catch return;
                 @compileError(err);
             },
-            .Pointer => |ptr_info| switch (ptr_info.size) {
+            Pointer => |ptr_info| switch (ptr_info.size) {
                 .One => switch (@typeInfo(ptr_info.child)) {
                     .Array => |info| {
                         if (info.child == u8) return stderr.print("{s}", .{value}) catch return;
@@ -67,7 +72,7 @@ fn inspect(value: anytype) void {
                     @compileError(err);
                 },
             },
-            .Optional => stderr.print("{?}", .{value}) catch return,
+            Optional => stderr.print("{?}", .{value}) catch return,
             else => stderr.print("{}", .{value}) catch return,
         }
     }

package/src/lib/common/js.zig

@@ -2,6 +2,8 @@ const std = @import("std");
 
 const assert = std.debug.assert;
 
+const Int = if (@hasField(std.builtin.Type, "int")) .int else .Int;
+
 const c = @cImport({
     @cDefine("NAPI_VERSION", "8");
     @cInclude("node_api.h");
@@ -35,7 +37,7 @@ pub const Number = struct {
         const T = @TypeOf(value);
         var result: c.napi_value = undefined;
         assert(c.napi_ok == switch (@typeInfo(T)) {
-            .Int => |info| switch (info.bits) {
+            Int => |info| switch (info.bits) {
                 0...32 => switch (info.signedness) {
                     .signed => c.napi_create_int32(env, @as(i32, value), &result),
                     .unsigned => c.napi_create_uint32(env, @as(u32, value), &result),
@@ -50,7 +52,7 @@ pub const Number = struct {
 
     pub fn get(env: c.napi_env, value: c.napi_value, comptime T: type) T {
         switch (@typeInfo(T)) {
-            .Int => |info| switch (info.bits) {
+            Int => |info| switch (info.bits) {
                 0...32 => switch (info.signedness) {
                     .signed => {
                         var result: i32 = undefined;

package/src/lib/common/optional.zig

@@ -3,10 +3,12 @@ const std = @import("std");
 const expect = std.testing.expect;
 const assert = std.debug.assert;
 
+const Bool = if (@hasField(std.builtin.Type, "bool")) .bool else .Bool;
+
 // TODO: ziglang/zig#104
 pub fn Optional(comptime T: type) type {
     const fields = std.meta.fields(switch (@typeInfo(T)) {
-        .Bool => enum { false, true },
+        Bool => enum { false, true },
         else => T,
     });
 
@@ -14,6 +16,7 @@ pub fn Optional(comptime T: type) type {
     var decls = [_]std.builtin.Type.Declaration{};
 
     enumFields[0] = .{ .name = "None", .value = 0 };
+
     inline for (fields, 1..) |field, i| {
         assert(!std.mem.eql(u8, field.name, "None"));
         enumFields[i] = .{
@@ -22,14 +25,16 @@ pub fn Optional(comptime T: type) type {
         };
     }
 
-    return @Type(.{
-        .Enum = .{
-            .tag_type = std.math.IntFittingRange(0, fields.len + 1),
-            .fields = &enumFields,
-            .decls = &decls,
-            .is_exhaustive = true,
-        },
-    });
+    const options = .{
+        .tag_type = std.math.IntFittingRange(0, fields.len),
+        .fields = &enumFields,
+        .decls = &decls,
+        .is_exhaustive = true,
+    };
+    return @Type(if (@hasField(std.builtin.Type, "enum"))
+        .{ .@"enum" = options }
+    else
+        .{ .Enum = options });
 }
 
 test Optional {
@@ -45,7 +50,7 @@ test Optional {
     try expect(b != .true);
     try expect(b != .false);
 
-    const Player = @import("./data.zig").Player;
+    const Player = @import("data.zig").Player;
     try expect(@bitSizeOf(Optional(Player)) == 2);
 
     const p: Optional(Player) = .P2;
@@ -57,4 +62,10 @@ test Optional {
     try expect(q == .None);
     try expect(q != .P1);
     try expect(q != .P2);
+
+    const Three = enum(u2) { A, B, C };
+    try expect(@bitSizeOf(Optional(Three)) == 2);
+
+    const Four = enum(u2) { A, B, C, D };
+    try expect(@bitSizeOf(Optional(Four)) == 3);
 }

package/src/lib/common/options.zig

@@ -10,6 +10,8 @@ pub const Options = struct {
     advance: ?bool = null,
     ebc: ?bool = null,
     key: ?bool = null,
+    miss: ?bool = null,
+    overwrite: ?bool = null,
     internal: ?bool = null,
 };
 
@@ -25,6 +27,8 @@ pub const calc = get("calc", false);
 pub const advance = get("advance", true);
 pub const ebc = get("ebc", true);
 pub const key = get("key", false);
+pub const miss = get("miss", true);
+pub const overwrite = get("overwrite", true);
 pub const internal = get("internal", false);
 
 fn get(comptime name: []const u8, default: bool) bool {