@pkmn/engine 0.1.0-dev.5570b5c5 → 0.1.0-dev.565de616

package/package.json

@@ -1,19 +1,31 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.5570b5c5",
+  "version": "0.1.0-dev.565de616",
   "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/addon/wasm.d.ts",
+    "build/pkg/addon/wasm.js.map",
+    "build/pkg/addon/wasm.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,10 +39,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",
+    "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",
@@ -62,7 +81,8 @@
     "src/lib/node.zig",
     "src/lib/pkmn.zig",
     "src/lib/wasm.zig",
-    "src/test/display/pkmn.html.tmpl"
+    "src/tools/display/dom.ts",
+    "src/tools/display/ui.css"
   ],
   "engines": {
     "node": ">=16.0.0"
@@ -75,31 +95,38 @@
     "access": "public"
   },
   "dependencies": {
-    "@pkmn/data": "^0.9.7",
-    "@pkmn/protocol": "^0.6.25"
+    "@pkmn/data": "^0.9.19",
+    "@pkmn/protocol": "^0.6.26"
   },
   "devDependencies": {
-    "@pkmn/eslint-config": "^7.4.0",
-    "@pkmn/img": "^0.2.29",
+    "@pkmn/eslint-config": "^8.4.0",
+    "@pkmn/img": "^0.2.32",
     "@pkmn/sets": "^5.1.2",
-    "@pkmn/sim": "0.9.7",
+    "@pkmn/sim": "0.9.19",
+    "@pkmn/smogon": "^0.5.14",
     "@types/html-minifier": "^4.0.5",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.13",
     "@types/minimist": "^1.2.5",
     "@types/mustache": "^4.2.5",
-    "@types/node": "^20.14.5",
-    "@vitest/coverage-v8": "^1.6.0",
-    "binaryen": "^117.0.0",
+    "@types/node": "^22.7.4",
+    "@types/react": "^18.3.10",
+    "@types/semver": "^7.5.8",
+    "@types/vscode": "^1.93.0",
+    "@vitest/coverage-v8": "^2.1.1",
+    "@vscode/vsce": "^3.1.1",
+    "binaryen": "^119.0.0",
+    "esbuild": "^0.24.0",
     "eslint": "<=8",
     "html-minifier": "^4.0.0",
-    "json-stringify-pretty-compact": "4.0.0",
+    "json-stringify-pretty-compact": "3.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.4.5",
-    "vitest": "^1.6.0"
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1"
   },
   "scripts": {
     "lint": "eslint --cache src --ext ts,js && eslint src/bin/*",
@@ -109,11 +136,13 @@
     "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",
     "benchmark": "npm run compile && node build/test/benchmark",
     "integration": "npm run compile && node build/test/integration",
+    "extension": "npm -C src/tools/vscode run build",
     "postinstall": "node src/bin/install-pkmn-engine"
   },
   "eslintConfig": {
@@ -122,7 +151,8 @@
       "dist/",
       "node_modules/",
       "examples/zig",
-      "build/"
+      "build/",
+      "extension.js"
     ],
     "env": {
       "es6": true,
@@ -141,18 +171,9 @@
           ]
         }
       },
-      {
-        "files": [
-          "src/test/display.ts"
-        ],
-        "rules": {
-          "@typescript-eslint/no-unnecessary-type-assertion": "off"
-        }
-      },
       {
         "files": [
           "src/pkg/index.ts",
-          "src/test/display.ts",
           "src/test/integration.ts"
         ],
         "rules": {
@@ -164,7 +185,7 @@
       },
       {
         "files": [
-          "src/pkg/addon.ts"
+          "src/pkg/addon/node.ts"
         ],
         "rules": {
           "@typescript-eslint/no-var-requires": "off"
@@ -190,8 +211,7 @@
       },
       {
         "files": [
-          "src/test/*.test.ts",
-          "src/test/regression/*.test.ts"
+          "src/test/*.test.ts"
         ],
         "rules": {
           "jest/no-standalone-expect": "off"

package/src/bin/install-pkmn-engine

@@ -10,7 +10,7 @@ const path = require('path');
 const {pipeline} = require('stream/promises');
 const tty = require('tty');
 
-const ZIG_VERSION = {major: 0, minor: 13, patch: 0};
+const ZIG_VERSION = {major: 0, minor: 11, patch: 0};
 const DEV = ZIG_VERSION.dev ? `-dev.${ZIG_VERSION.dev}` : '';
 const VERSION = `${ZIG_VERSION.major}.${ZIG_VERSION.minor}.${ZIG_VERSION.patch}${DEV}`;
 const INDEX = 'https://ziglang.org/download/index.json';
@@ -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);
@@ -255,7 +257,7 @@ const downloadImportLib = async () => {
   }
 
   const dir = path.join(ROOT, 'build', 'lib');
-  const url = new URL('./win-x64/node.lib', process.release.headersUrl).href;
+  const url = process.release.libUrl;
   const dest = path.join(dir, path.basename(url));
   if (fs.existsSync(path.join(dest))) {
     log('Node import library:', dest);
@@ -389,11 +391,11 @@ const downloadImportLib = async () => {
       const ext = process.platform === 'darwin'
         ? 'dylib' : process.platform === 'win32' ? 'dll' : 'so';
       try {
-        const actual = path.join('build', 'lib', `${prefix}pkmn${suffix}.node.${ext}`);
+        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('build', 'bin', `${prefix}pkmn${suffix}.node.${ext}`);
+        const actual = path.join(ROOT, 'build', 'bin', `${prefix}pkmn${suffix}.node.${ext}`);
         fs.renameSync(actual, artifact);
       }
     }

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

@@ -22,8 +22,8 @@ pub const Player = enum(u1) {
 
 test Player {
     try expectEqual(Player.P2, Player.P1.foe());
-    try expectEqual(0b0001, @as(u8, @bitCast(Player.P1.ident(1))));
-    try expectEqual(0b1101, @as(u8, @bitCast(Player.P2.ident(5))));
+    try expectEqual(@as(u8, 0b0001), @as(u8, @bitCast(Player.P1.ident(1))));
+    try expectEqual(@as(u8, 0b1101), @as(u8, @bitCast(Player.P2.ident(5))));
 }
 
 /// An identifier for a specific Pokémon in battle.
@@ -46,8 +46,8 @@ pub const ID = packed struct(u8) {
 };
 
 test ID {
-    try expectEqual(0b0001, @as(u8, @bitCast(ID{ .player = .P1, .id = 1 })));
-    try expectEqual(0b1101, @as(u8, @bitCast(ID{ .player = .P2, .id = 5 })));
+    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 };
     try expectEqual(id, ID.from(id.int()));
 }
@@ -76,8 +76,8 @@ 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.
@@ -112,6 +112,6 @@ pub const Result = packed struct(u8) {
 };
 
 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,19 @@ const std = @import("std");
 const debug = std.debug;
 const io = std.io;
 
+const Array = if (@hasField(std.builtin.Type, "array")) .array else .Array;
+const Enum = if (@hasField(std.builtin.Type, "enum")) .@"enum" else .Enum;
+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;
+const Union = if (@hasField(std.builtin.Type, "union")) .@"union" else .Union;
+
 pub fn print(value: anytype) void {
-    debug.getStderrMutex().lock();
-    defer debug.getStderrMutex().unlock();
+    if (@hasDecl(debug, "lockStdErr")) debug.lockStdErr() else debug.getStderrMutex().lock();
+    defer if (@hasDecl(debug, "unlockStdErr"))
+        debug.unlockStdErr()
+    else
+        debug.getStderrMutex().unlock();
     const stderr = io.getStdErr().writer();
 
     nosuspend {
@@ -19,7 +29,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,17 +52,17 @@ 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| {
+                    Array => |info| {
                         if (info.child == u8) return stderr.print("{s}", .{value}) catch return;
                         @compileError(err);
                     },
-                    .Enum, .Union, .Struct => return inspect(value.*),
+                    Enum, Union, Struct => return inspect(value.*),
                     else => @compileError(err),
                 },
                 .Many, .C => {
@@ -67,8 +77,29 @@ 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,
         }
     }
 }
+
+const showdown = @import("./options.zig").showdown;
+const Result = @import("./data.zig").Result;
+const Choice = @import("./data.zig").Choice;
+
+pub fn dump(gen: u8, battle: anytype, frame: ?struct { Result, Choice, Choice }) void {
+    const file = std.fs.cwd().createFile("logs/dump.bin", .{}) catch return;
+    defer file.close();
+    var w = file.writer();
+    w.writeByte(@intFromBool(showdown)) catch return;
+    w.writeByte(gen) catch return;
+    w.writeInt(i16, 0, .little) catch return;
+    w.writeInt(i32, 0, .little) catch return;
+    w.writeStruct(battle) catch return;
+    w.writeStruct(battle) catch return;
+    if (frame) |f| {
+        w.writeStruct(f[0]) catch return;
+        w.writeStruct(f[1]) catch return;
+        w.writeStruct(f[2]) 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,
     });
 
@@ -23,14 +25,16 @@ pub fn Optional(comptime T: type) type {
         };
     }
 
-    return @Type(.{
-        .Enum = .{
-            .tag_type = std.math.IntFittingRange(0, fields.len),
-            .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 {

package/src/lib/common/options.zig

@@ -7,9 +7,12 @@ pub const Options = struct {
     log: ?bool = null,
     chance: ?bool = null,
     calc: ?bool = null,
+    mod: ?bool = null,
     advance: ?bool = null,
     ebc: ?bool = null,
     key: ?bool = null,
+    miss: ?bool = null,
+    overwrite: ?bool = null,
     internal: ?bool = null,
 };
 
@@ -22,9 +25,12 @@ pub const chance = get("chance", false);
 /// Whether or not damage calculator support is enabled.
 pub const calc = get("calc", false);
 
+pub const mod = showdown or get("mod", 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 {