@pkmn/engine 0.1.0-dev.cbdbb719 → 0.1.0-dev.cdc837af

package/package.json

@@ -1,19 +1,31 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.cbdbb719",
+  "version": "0.1.0-dev.cdc837af",
   "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,15 +39,21 @@
     "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",
     "src/lib/common/js.zig",
-    "src/lib/common/array.zig",
     "src/lib/common/optional.zig",
     "src/lib/common/options.zig",
     "src/lib/common/protocol.zig",
@@ -63,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"
@@ -76,33 +95,38 @@
     "access": "public"
   },
   "dependencies": {
-    "@pkmn/data": "^0.9.11",
-    "@pkmn/protocol": "^0.6.25"
+    "@pkmn/data": "^0.9.17",
+    "@pkmn/protocol": "^0.6.26"
   },
   "devDependencies": {
-    "@pkmn/eslint-config": "^8.1.0",
-    "@pkmn/img": "^0.2.31",
+    "@pkmn/eslint-config": "^8.3.0",
+    "@pkmn/img": "^0.2.32",
     "@pkmn/sets": "^5.1.2",
-    "@pkmn/sim": "0.9.11",
+    "@pkmn/sim": "0.9.17",
+    "@pkmn/smogon": "^0.5.13",
     "@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": "^22.0.2",
+    "@types/node": "^22.5.5",
+    "@types/react": "^18.3.8",
     "@types/semver": "^7.5.8",
-    "@vitest/coverage-v8": "^2.0.5",
-    "binaryen": "^118.0.0",
+    "@types/vscode": "^1.93.0",
+    "@vitest/coverage-v8": "^2.1.1",
+    "@vscode/vsce": "^3.1.0",
+    "binaryen": "^119.0.0",
+    "esbuild": "^0.23.1",
     "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.5.4",
-    "vitest": "^2.0.5"
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1"
   },
   "scripts": {
     "lint": "eslint --cache src --ext ts,js && eslint src/bin/*",
@@ -112,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": {
@@ -125,7 +151,8 @@
       "dist/",
       "node_modules/",
       "examples/zig",
-      "build/"
+      "build/",
+      "extension.js"
     ],
     "env": {
       "es6": true,
@@ -144,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": {
@@ -167,7 +185,7 @@
       },
       {
         "files": [
-          "src/pkg/addon.ts"
+          "src/pkg/addon/node.ts"
         ],
         "rules": {
           "@typescript-eslint/no-var-requires": "off"
@@ -193,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

@@ -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);

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/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.lockStdErr();
-    defer debug.unlockStdErr();
+    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/options.zig

@@ -11,6 +11,7 @@ pub const Options = struct {
     ebc: ?bool = null,
     key: ?bool = null,
     miss: ?bool = null,
+    overwrite: ?bool = null,
     internal: ?bool = null,
 };
 
@@ -27,6 +28,7 @@ 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 {

package/src/lib/common/protocol.zig

@@ -1,18 +1,14 @@
-const std = @import("std");
 const builtin = @import("builtin");
-
-const pkmn = @import("../pkmn.zig");
-
 const data = @import("data.zig");
 const options = @import("options.zig");
+const pkmn = @import("../pkmn.zig");
+const std = @import("std");
 
 const assert = std.debug.assert;
-const print = std.debug.print;
-
 const enabled = options.log;
-
-const Player = data.Player;
 const ID = data.ID;
+const Player = data.Player;
+const print = std.debug.print;
 
 const endian = builtin.cpu.arch.endian();
 const Endian = std.builtin.Endian;

package/src/lib/common/rational.zig

@@ -15,7 +15,9 @@ const ComptimeFloat =
 
 /// Specialization of a rational number used by the engine to compute probabilties.
 /// For performance reasons the rational is only reduced lazily and thus `reduce` must be
-/// invoked explicitly before reading.
+/// invoked explicitly before reading. Note that this laziness means that this implementation
+/// sometimes overflows in places where an eager reduced implementation would not - to achieve
+/// the same behavior as an eager implementation simply call `reduce` after each operation.
 pub fn Rational(comptime T: type) type {
     return extern struct {
         const Self = @This();
@@ -25,10 +27,10 @@ pub fn Rational(comptime T: type) type {
         /// Denominator. Must always be >= 1. Not guaranteed to be reduced in all cases.
         q: T = 1,
 
-        // With floats we can't rely on an overflow bit to let us know when to reduce, so we instead
-        // start reducing when we get sufficiently close to the limit of the mantissa (in our domain
-        // we expect updates to involve numbers < 2**10, so we should be safe not reducing before we
-        // are 2**10 away from "overflowing" the mantissa)
+        // With floats we can't rely on an overflow bit to let us know when to reduce, so we
+        // instead start reducing when we get sufficiently close to the limit of the mantissa
+        // (in our domain we expect updates to involve numbers < 2**10, so we should be safe
+        // not reducing before we are 2**10 away from "overflowing" the mantissa)
         const REDUCE = if (@typeInfo(T) == Float)
             std.math.pow(T, 2, std.math.floatMantissaBits(T) - 10)
         else

package/src/lib/common/rng.zig

@@ -1,10 +1,8 @@
-const std = @import("std");
-
 const options = @import("options.zig");
+const std = @import("std");
 
 const assert = std.debug.assert;
 const expectEqual = std.testing.expectEqual;
-
 const showdown = options.showdown;
 
 pub fn PRNG(comptime gen: comptime_int) type {