@pkmn/engine 0.1.0-dev.6ef582f1 → 0.1.0-dev.72514829

package/LICENSE

@@ -1,6 +1,4 @@
-The MIT License (MIT)
-
-Copyright (c) 2021-2023 pkmn contributors
+Copyright (c) 2021-2026 pkmn contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -3,7 +3,7 @@
   <br />
   <br />
   <a href="https://github.com/pkmn/engine/actions/workflows/test.yml">
-    <img alt="Test Status" src="https://github.com/pkmn/engine/workflows/Tests/badge.svg" />
+    <img alt="Test Status" src="https://github.com/pkmn/engine/actions/workflows/test.yml/badge.svg" />
   </a>
   <a href="#status">
     <img alt="WIP" src="https://img.shields.io/badge/status-WIP-red.svg" />
@@ -12,6 +12,12 @@
     <img alt="License" src="https://img.shields.io/badge/License-MIT-blue.svg" />
   </a>
 </p>
+
+> [!WARNING]
+> **This project is under heavy development** and currently the `main` branch contains numerous breaking
+> changes which may not work and which are not fully documented. Please **wait for the forthcoming
+> initial v0.1 release** before depending on this project.
+
 <hr />
 
 A minimal, complete, Pokémon battle simulation engine optimized for performance and
@@ -49,9 +55,9 @@ $ zig build --prefix /usr/local -Doptimize=ReleaseFast
 ```
 
 The Zig website has [installation instructions](https://ziglang.org/learn/getting-started/) which
-walk through how to install Zig on each platform - the engine code should work on Zig v0.11.0 dev
-build 3859 or greater, though tracks Zig's master branch so this may change in the future if
-breaking language changes are introduced:
+walk through how to install Zig on each platform - the engine code should work on Zig v0.16.0,
+though tracks Zig's master branch so this may change in the future if breaking language changes are
+introduced.
 
 `libpkmn` can be built with `-Dshowdown` to instead produce the Pokémon Showdown compatible
 `libpkmn-showdown` library. Furthermore, protocol message logging can be enabled through `-Dlog`.
@@ -74,30 +80,57 @@ lifecycle script](https://docs.npmjs.com/cli/v8/using-npm/scripts) runs
 it can't find one, as well as looking for (and downloading, if necessary) the required Node headers
 needed to successfully build the addons natively.
 
-**If you have configured `npm` to `--ignore-scripts` you must either run `npx install-pkmn-engine`
-directly or build the addons manually and place the artifacts in the expected paths.**
+> [!IMPORTANT]
+> If you have configured `npm` to `--ignore-scripts` (or are using [npm v12+ and have not
+> approved](https://github.blog/changelog/2026-06-09-upcoming-breaking-changes-for-npm-v12/)
+> `@pkmn/engine` via `npm approve-scripts @pkmn/engine`) **you must either run `npx install-pkmn-engine`
+> directly or build the addons manually and place the artifacts in the expected paths.**
 
 ### `pkmn`
 
-Until the [Zig package manager](https://github.com/ziglang/zig/projects/4) is completed, the
-recommended way of using the `pkmn` package in Zig is by either copying this repository into your
-project or by using [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) and then
-adding the following to your `build.zig`:
+To include `pkmn`, add it as a dependency in your project's
+[`build.zig.zon`](https://github.com/ziglang/zig/blob/master/doc/build.zig.zon.md) using [Zig's
+Package Management
+system](https://ziglang.org/download/0.11.0/release-notes.html#Package-Management):
+
+```zig
+.dependencies = .{
+    .pkmn = .{
+        .url = "https://github.com/pkmn/engine/archive/RELEASE.tar.gz",
+    },
+},
+```
+
+Replace `RELEASE` with the tag for the [release](https://github.com/pkmn/engine/releases) you wish
+to use (e.g. `0.1.0` or `nightly`) or the specific hash of any commit. Next, run `zig build` and
+copy the expected hash from the error message into your `build.zig.zon` alongside the `.url`:
+
+```sh
+$ zig build
+error: dependency is missing hash field
+            .url = "https://github.com/pkmn/engine/archive/nightly.tar.gz",
+                   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+note: expected .hash = "122056b93b403033cb7d9bed96a02c2eb8cc1275515976167726ada6eb4207e8ef8a",
+```
+
+Note that this hash is **not** going to be the same as the commit hash. After adding the hash to
+your `build.zig.zon` you will be able to import the `pkmn` package's build helpers into your
+`build.zig`:
 
 ```zig
 const std = @import("std");
-const pkmn = @import("lib/pkmn/build.zig");
 
 pub fn build(b: *std.Build) void {
     ...
-    exe.addModule("pkmn", pkmn.module(b, .{ .showdown = true, .log = true }));
+    const pkmn = b.dependency("pkmn", .{ .showdown = true, .log = true });
+    exe.root_module.addImport("pkmn", pkmn.module("pkmn"));
     ...
 }
 ```
 
-The engine's `build.zig` exposes a `module` function that takes an options structure to allow for
-configuring whether or not Pokémon Showdown compatibility mode or protocol message logging should be
-enabled. Alternatively, you may set options via a `pkmn_options` [root source file
+The `pkmn` package can be configured with various options such as whether or not Pokémon Showdown
+compatibility mode or protocol message logging should be enabled. Alternatively, you may set options
+via a `pkmn_options` [root source file
 declaration](https://ziglang.org/documentation/master/#Root-Source-File). There are several
 undocumented internal options that can be tweaked as well via build or root options, though these
 options aren't officially supported, affect correctness, and may change meaning or behavior without
@@ -134,7 +167,7 @@ documentation](docs/PROTOCOL.md) goes into greater detail on the specifics of up
 potential logs that may result.
 
 *The snippets below are meant to merely illustrate in broad strokes how the pkmn engine can be used
-\- the [`examples`](src/examples) directory contains fully commented and runnable code.*
+\- the [`examples`](examples) directory contains fully commented and runnable code.*
 
 ### C
 
@@ -159,7 +192,7 @@ while (!pkmn_result_type(result = pkmn_battle_update(&battle, c1, c2, &options))
 if (pkmn_error(result)) exit(1);
 ```
 
-[(full code)](src/examples/c/example.c)
+[(full code)](examples/c/example.c)
 
 The C API doesn't export any helpers for creating or accessing the opaque battle objects - it's
 instead intended to be used as the foundation for more ergonomic bindings in [other
@@ -177,24 +210,25 @@ protocol via `Log.parse`.
 ```ts
 import {Dex} from '@pkmn/dex';
 import {Generations} from '@pkmn/data';
-import {Battle} from '@pkmn/engine';
+import {Battle, Choice} from '@pkmn/engine';
 
 const gens = new Generations(Dex);
 const battle = Battle.create(...);
 
-const choose = (n: number) => Math.random() * n;
+const choose = (choices: Choice[]) =>
+  choices[Math.floor(Math.random() * choices.length)];
 
 let result: Result;
 let c1: Choice, c2: Choice;
 while (!(result = battle.update(c1, c2)).type) {
-  c1 = battle.choose('p1', result, choose);
-  c2 = battle.choose('p2', result, choose);
+  c1 = choose(battle.choices('p1', result));
+  c2 = choose(battle.choices('p2', result));
 }
 
 console.log(result);
 ```
 
-[(full code)](src/examples/js/example.ts)
+[(full code)](examples/js/example.ts)
 
 By default, the `@pkmn/engine` package compiles the engine with `-Dshowdown`, though by running
 `install-pkmn-engine` directly and passing in `--options` you can override this default and build
@@ -206,7 +240,7 @@ library should be seamless.
 
 Despite relying on the native engine code, the `@pkmn/engine` code is designed to also work in
 browsers which support [WebAssembly](https://webassembly.org/). Running `npm run start:web` from the
-[`examples`](src/examples/js) directory starts a server that can be used to demonstrate the engine
+[`examples`](examples/js) directory starts a server that can be used to demonstrate the engine
 running in the browser.
 
 ### Zig
@@ -218,14 +252,15 @@ be used when logging is enabled to allow for easily printing e.g. to standard ou
 const std = @import("std");
 const pkmn = @import("pkmn");
 
-var random = std.rand.DefaultPrng.init(seed).random();
+var prng: std.Random.DefaultPrng = .init(seed);
+var random = prng.random();
 var choices: [pkmn.CHOICES_SIZE]pkmn.Choice = undefined;
 
 var battle = ...
 var options = pkmn.battle.options(...);
 
-var c1 = pkmn.Choice{};
-var c2 = pkmn.Choice{};
+var c1: pkmn.Choice = .{};
+var c2: pkmn.Choice = .{};
 
 var result = try battle.update(c1, c2, &options);
 while (result.type == .None) : (result = try battle.update(c1, c2, &options)) {
@@ -236,7 +271,7 @@ while (result.type == .None) : (result = try battle.update(c1, c2, &options)) {
 std.debug.print("{}\n", .{result.type});
 ```
 
-[(full code)](src/examples/zig/example.zig)
+[(full code)](examples/zig/example.zig)
 
 The Zig package also supports some APIs which are difficult to expose elsewhere such as the
 `FixedRNG` which allows you to fully specify the exact RNG frames (which can be useful for ensuring
@@ -286,6 +321,13 @@ instead:
 $ pkmn-debug <file> > index.html
 ```
 
+Finally, `pkmn-debug` also supports a `--json` flag which causes the decoded data to be dumped as
+JSON instead of HTML:
+
+```sh
+$ pkmn-debug --json <file> > index.json
+```
+
 ## Status
 
 The engine is currently expected to be developed over multiple stages:
@@ -298,7 +340,7 @@ The engine is currently expected to be developed over multiple stages:
 | ***3*** | *modern generations*                            |
 
 Currently, most of the foundational work from stage 0 is done:
-  
+
 - [benchmark and integration testing](src/test) infrastructure
 - [documentation](docs) about design, research, methodology, etc
 - definition and implementation of the [protocol](docs/PROTOCOL.md) that's used by the engine

package/build/pkg/addon/browser.d.ts

@@ -0,0 +1,3 @@
+import type { Argument } from '../addon';
+export declare function load(showdown: boolean, addon?: Argument): Promise<import("../addon").Bindings<boolean>>;
+export declare function loadSync(): void;

package/build/pkg/addon/browser.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.load = load;
+exports.loadSync = loadSync;
+const wasm_1 = require("./wasm");
+async function load(showdown, addon) {
+    if (typeof addon === 'string' && addon !== 'wasm') {
+        throw new Error('Unable to load native addons in the browser!');
+    }
+    let wasm;
+    if (addon instanceof WebAssembly.Instance) {
+        wasm = addon;
+    }
+    else if (addon instanceof WebAssembly.Module) {
+        try {
+            wasm = (await WebAssembly.instantiate(addon));
+        }
+        catch (err) {
+            if (!(err instanceof Error))
+                throw err;
+            throw new Error(`Could not instantiate WASM module!\n${err.message}`);
+        }
+    }
+    else {
+        const name = `pkmn${showdown ? '-showdown' : ''}.wasm`;
+        try {
+            const response = !addon || addon === 'wasm' ? fetch(name)
+                : addon instanceof URL ? fetch(addon) : addon;
+            wasm = (await WebAssembly.instantiateStreaming(response)).instance;
+        }
+        catch (err) {
+            if (!(err instanceof Error))
+                throw err;
+            const message = !addon || addon === 'wasm'
+                ? `Could not find ${name} - did you run \`npx install-pkmn-engine\`?`
+                : addon instanceof URL
+                    ? `Could not fetch WASM module from '${addon.href}'!`
+                    : 'Could not instantiate WASM module!';
+            throw new Error(`${message}\n${err.message}`);
+        }
+    }
+    return (0, wasm_1.toBindings)(wasm.exports);
+}
+function loadSync() {
+    throw new Error('You must `initialize` the WASM addon before using the engine!');
+}
+//# sourceMappingURL=browser.js.map

package/build/pkg/addon/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/pkg/addon/browser.ts"],"names":[],"mappings":";;AAKA,oBAiCC;AAED,4BAEC;AAvCD,iCAAkC;AAE3B,KAAK,UAAU,IAAI,CAAC,QAAiB,EAAE,KAAgB;IAC5D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,IAA0B,CAAC;IAC/B,IAAI,KAAK,YAAY,WAAW,CAAC,QAAQ,EAAE,CAAC;QAC1C,IAAI,GAAG,KAAK,CAAC;IACf,CAAC;SAAM,IAAI,KAAK,YAAY,WAAW,CAAC,MAAM,EAAE,CAAC;QAC/C,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,MAAM,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;gBAAE,MAAM,GAAG,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,GAAG,OAAO,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;gBACvD,CAAC,CAAE,KAAiC,YAAY,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC7E,IAAI,GAAG,CAAC,MAAM,WAAW,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;gBAAE,MAAM,GAAG,CAAC;YACvC,MAAM,OAAO,GAAG,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM;gBACxC,CAAC,CAAC,kBAAkB,IAAI,6CAA6C;gBACrE,CAAC,CAAE,KAAiC,YAAY,GAAG;oBACjD,CAAC,CAAC,qCAAsC,KAAa,CAAC,IAAI,IAAI;oBAC9D,CAAC,CAAC,oCAAoC,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,SAAgB,QAAQ;IACtB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;AACnF,CAAC"}

package/build/pkg/addon/node.d.ts

@@ -0,0 +1,3 @@
+import type { Argument } from '../addon';
+export declare function load(showdown: boolean, addon?: Argument): Promise<any>;
+export declare function loadSync(showdown: boolean): any;

package/build/pkg/addon/node.js

@@ -0,0 +1,110 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.load = load;
+exports.loadSync = loadSync;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const wasm_1 = require("./wasm");
+const ROOT = path.join(__dirname, '..', '..', '..');
+const LIB = path.join(ROOT, 'build', 'lib');
+const NODE = [path.join(LIB, 'pkmn.node'), path.join(LIB, 'pkmn-showdown.node')];
+const WASM = [path.join(LIB, 'pkmn.wasm'), path.join(LIB, 'pkmn-showdown.wasm')];
+async function load(showdown, addon) {
+    if (addon === undefined || typeof addon === 'string' && addon !== 'wasm') {
+        try {
+            return require(!addon || addon === 'node' ? NODE[+showdown] : addon).engine;
+        }
+        catch (err) {
+            if (!(err instanceof Error))
+                return err;
+            if (addon && addon !== 'node') {
+                throw new Error(`Unable to load native addon: '${addon}'\n${err.message}`);
+            }
+            else {
+                throw error(NODE[+showdown], err);
+            }
+        }
+    }
+    let wasm;
+    if (addon === 'wasm') {
+        try {
+            wasm = (await WebAssembly.instantiate(fs.readFileSync(WASM[+showdown]))).instance;
+        }
+        catch (err) {
+            throw error(WASM[+showdown], err);
+        }
+    }
+    else if (addon instanceof WebAssembly.Instance) {
+        wasm = addon;
+    }
+    else if (addon instanceof WebAssembly.Module) {
+        try {
+            wasm = (await WebAssembly.instantiate(addon));
+        }
+        catch (err) {
+            if (!(err instanceof Error))
+                throw err;
+            throw new Error(`Could not instantiate WASM module!\n${err.message}`);
+        }
+    }
+    else {
+        try {
+            const response = addon instanceof Promise ? addon : fetch(addon);
+            wasm = (await WebAssembly.instantiateStreaming(response)).instance;
+        }
+        catch (err) {
+            if (!(err instanceof Error))
+                throw err;
+            throw new Error(`Could not instantiate WASM module!\n${err.message}`);
+        }
+    }
+    return (0, wasm_1.toBindings)(wasm.exports);
+}
+function loadSync(showdown) {
+    try {
+        return require(NODE[+showdown]).engine;
+    }
+    catch {
+        return undefined;
+    }
+}
+function error(file, err) {
+    if (!(err instanceof Error))
+        return err;
+    const message = `Could not find ${path.basename(file)} addon`;
+    return new Error(`${message} - did you run \`npx install-pkmn-engine\`?\n${err.message}`);
+}
+//# sourceMappingURL=node.js.map

package/build/pkg/addon/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../../../src/pkg/addon/node.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA,oBAyCC;AAED,4BAMC;AA9DD,uCAAyB;AACzB,2CAA6B;AAI7B,iCAAkC;AAElC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AACpD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAE5C,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAC;AACjF,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAC;AAE1E,KAAK,UAAU,IAAI,CAAC,QAAiB,EAAE,KAAgB;IAC5D,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACzE,IAAI,CAAC;YACH,OAAO,OAAO,CAAC,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;QAC9E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;gBAAE,OAAO,GAAG,CAAC;YACxC,IAAI,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7E,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,IAA0B,CAAC;IAC/B,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,MAAM,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACpF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,YAAY,WAAW,CAAC,QAAQ,EAAE,CAAC;QACjD,IAAI,GAAG,KAAK,CAAC;IACf,CAAC;SAAM,IAAI,KAAK,YAAY,WAAW,CAAC,MAAM,EAAE,CAAC;QAC/C,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,MAAM,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;gBAAE,MAAM,GAAG,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,MAAM,QAAQ,GAAI,KAAiC,YAAY,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9F,IAAI,GAAG,CAAC,MAAM,WAAW,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;gBAAE,MAAM,GAAG,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,SAAgB,QAAQ,CAAC,QAAiB;IACxC,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,GAAY;IACvC,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IACxC,MAAM,OAAO,GAAG,kBAAkB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC9D,OAAO,IAAI,KAAK,CAAC,GAAG,OAAO,gDAAgD,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;AAC5F,CAAC"}

package/build/pkg/addon/wasm.d.ts

@@ -0,0 +1,2 @@
+import type { Bindings } from '../addon';
+export declare function toBindings<T extends boolean>(w: WebAssembly.Exports): Bindings<T>;

package/build/pkg/addon/wasm.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBindings = toBindings;
+const data_1 = require("../data");
+function toBindings(w) {
+    const memory = new Uint8Array(w.memory.buffer);
+    return {
+        options: {
+            showdown: !!memory[w.SHOWDOWN.valueOf()],
+            log: !!memory[w.LOG.valueOf()],
+            chance: !!memory[w.CHANCE.valueOf()],
+            calc: !!memory[w.CALC.valueOf()],
+        },
+        bindings: [toBinding(1, w)],
+    };
+}
+function toBinding(gen, w) {
+    const prefix = `GEN${gen}`;
+    const buf = w.memory.buffer;
+    const constants = new Uint32Array(buf);
+    const CHOICES_SIZE = constants[w[`${prefix}_CHOICES_SIZE`].valueOf() / 4];
+    const LOGS_SIZE = constants[w[`${prefix}_LOGS_SIZE`].valueOf() / 4];
+    const size = data_1.LAYOUT[gen - 1].sizes.Battle;
+    const update = w[`${prefix}_update`];
+    const choices = w[`${prefix}_choices`];
+    const memory = new Uint8Array(buf);
+    return {
+        CHOICES_SIZE,
+        LOGS_SIZE,
+        update(battle, c1, c2, log) {
+            const bytes = new Uint8Array(battle);
+            memory.set(bytes, 0);
+            let result;
+            if (log) {
+                result = update(0, c1, c2, size);
+                new Uint8Array(log).set(memory.subarray(size, size + LOGS_SIZE));
+            }
+            else {
+                result = update(0, c1, c2, 0);
+            }
+            bytes.set(memory.subarray(0, size));
+            return result;
+        },
+        choices(battle, player, request, options) {
+            const opts = new Uint8Array(options);
+            memory.set(new Uint8Array(battle));
+            const n = choices(0, player, request, size);
+            opts.set(memory.subarray(size, size + n));
+            return n;
+        },
+    };
+}
+//# sourceMappingURL=wasm.js.map

package/build/pkg/addon/wasm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wasm.js","sourceRoot":"","sources":["../../../src/pkg/addon/wasm.ts"],"names":[],"mappings":";;AAGA,gCAWC;AAbD,kCAA+B;AAE/B,SAAgB,UAAU,CAAoB,CAAsB;IAClE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAE,CAAC,CAAC,MAA6B,CAAC,MAAM,CAAC,CAAC;IACvE,OAAO;QACL,OAAO,EAAE;YACP,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAM;YAC7C,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;SACjC;QACD,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAC5B,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,GAAW,EAAE,CAAsB;IACpD,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;IAC3B,MAAM,GAAG,GAAI,CAAC,CAAC,MAA6B,CAAC,MAAM,CAAC;IAEpD,MAAM,SAAS,GAAG,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,eAAe,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1E,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,YAAY,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAEpE,MAAM,IAAI,GAAG,aAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;IAC1C,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,SAAS,CAAqB,CAAC;IACzD,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,MAAM,UAAU,CAAqB,CAAC;IAC3D,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAEnC,OAAO;QACL,YAAY;QACZ,SAAS;QACT,MAAM,CACJ,MAAuB,EACvB,EAAU,EACV,EAAU,EACV,GAAgC;YAEhC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;YACrC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAErB,IAAI,MAAc,CAAC;YACnB,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;gBACjC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;YACnE,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;YAED,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;YACpC,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,CACL,MAAuB,EACvB,MAAc,EACd,OAAe,EACf,OAAwB;YAExB,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;YAC1C,OAAO,CAAC,CAAC;QACX,CAAC;KACF,CAAC;AACJ,CAAC"}

package/build/pkg/addon.d.ts

@@ -1,7 +1,29 @@
-import { Choice, Player, Result } from '.';
+import { Choice, Player, Result } from './common';
+export type Argument = string | URL | WebAssembly.Module | WebAssembly.Instance | Promise<Response>;
+export interface Bindings<T extends boolean> {
+    /**
+     * The compile-time options the bindings were built with. showdown is special
+     * cased because it changes the name of addon.
+     */
+    options: {
+        showdown: T;
+        log: boolean;
+        chance: boolean;
+        calc: boolean;
+    };
+    /** Bindings are per-generation, Generation I is index 0. */
+    bindings: Binding[];
+}
+export interface Binding {
+    CHOICES_SIZE: number;
+    LOGS_SIZE: number;
+    update(battle: ArrayBufferLike, c1: number, c2: number, log: ArrayBufferLike | undefined): number;
+    choices(battle: ArrayBufferLike, player: number, request: number, out: ArrayBufferLike): number;
+}
+/** TODO */
+export declare function initialize(showdown: boolean, addon?: Argument): Promise<void | undefined>;
 export declare function check(showdown: boolean): void;
 export declare function supports(showdown: boolean, log?: boolean): boolean;
-export declare function update(index: number, showdown: boolean, battle: ArrayBuffer, c1?: Choice, c2?: Choice, log?: ArrayBuffer): Result;
-export declare function choices(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer): Choice[];
-export declare function choose(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer, fn: (n: number) => number): Choice;
+export declare function update(index: number, showdown: boolean, battle: ArrayBufferLike, c1?: Choice, c2?: Choice, log?: ArrayBufferLike): Result;
+export declare function choices(index: number, showdown: boolean, battle: ArrayBufferLike, player: Player, choice: Choice['type'], out: Uint8Array): Choice[];
 export declare function size(index: number, type: 'choices' | 'log'): number;

package/build/pkg/addon.js

@@ -1,78 +1,58 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.size = exports.choose = exports.choices = exports.update = exports.supports = exports.check = void 0;
-const path = __importStar(require("path"));
-const _1 = require(".");
-const ROOT = path.join(__dirname, '..', '..');
-let ADDON = undefined;
-function load() {
-    if (ADDON)
-        return ADDON;
-    let pkmn = undefined;
-    let showdown = undefined;
-    try {
-        pkmn = require(path.join(ROOT, 'build', 'lib', 'pkmn.node')).engine;
-    }
-    catch { }
-    try {
-        showdown =
-            require(path.join(ROOT, 'build', 'lib', 'pkmn-showdown.node')).engine;
-    }
-    catch { }
-    if (!pkmn && !showdown) {
-        throw new Error('Could not find native addons - did you run `npx install-pkmn-engine`?');
+exports.initialize = initialize;
+exports.check = check;
+exports.supports = supports;
+exports.update = update;
+exports.choices = choices;
+exports.size = size;
+const node_1 = require("./addon/node");
+const common_1 = require("./common");
+const ADDONS = [];
+const loading = [];
+/** TODO */
+async function initialize(showdown, addon) {
+    if (loading[+showdown]) {
+        throw new Error(`Cannot call initialize more than once with showdown=${showdown}`);
     }
-    return (ADDON = [pkmn, showdown]);
+    loading[+showdown] = (0, node_1.load)(showdown, addon);
+    loading[+showdown].then(a => {
+        ADDONS[+showdown] = a;
+    }).catch(() => {
+        loading[+showdown] = undefined;
+    });
+    return loading[+showdown]?.then(() => { });
 }
 function check(showdown) {
-    if (!load()[+showdown]) {
-        const opts = ADDON[+!showdown].options.log ? ['-log'] : [];
+    if (!addons(showdown)[+showdown]) {
+        const opts = ADDONS[+!showdown].options.log ? ['-log'] : [];
         if (showdown)
             opts.push('-Dshowdown');
         throw new Error(`@pkmn/engine has ${showdown ? 'not' : 'only'} been configured to support Pokémon Showdown.` +
             `\n(running \`npx install-pkmn-engine --options='${opts.join(' ')}'\` can fix this issue).`);
     }
 }
-exports.check = check;
 function supports(showdown, log) {
-    if (!load()[+showdown])
+    if (!addons(showdown)[+showdown])
         return false;
     if (log === undefined)
         return true;
-    return ADDON[+showdown].options.log === log;
+    return ADDONS[+showdown].options.log === log;
+}
+function addons(showdown) {
+    if (ADDONS[+showdown])
+        return ADDONS;
+    // If we havem't been initialized attempt to autoload if we're on Node
+    ADDONS[+showdown] = (0, node_1.loadSync)(showdown);
+    return ADDONS;
 }
-exports.supports = supports;
 function update(index, showdown, battle, c1, c2, log) {
-    return _1.Result.decode(ADDON[+showdown].bindings[index]
-        .update(battle, _1.Choice.encode(c1), _1.Choice.encode(c2), log));
+    return common_1.Result.decode(ADDONS[+showdown].bindings[index]
+        .update(battle, common_1.Choice.encode(c1), common_1.Choice.encode(c2), log));
 }
-exports.update = update;
-function choices(index, showdown, battle, player, choice, buf) {
+function choices(index, showdown, battle, player, choice, out) {
     const request = choice[0] === 'p' ? 0 : choice[0] === 'm' ? 1 : 2;
-    const n = ADDON[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, buf);
+    const n = ADDONS[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, out.buffer);
     // The top-level API signature means our hands our tied with respect to
     // writing really fast bindings here. The simplest approach would be to return
     // the ArrayBuffer the bindings populate as well as its size and only decode a
@@ -87,26 +67,14 @@ function choices(index, showdown, battle, player, choice, buf) {
     // choices function for each generation within node.zig. We could do something
     // really galaxy-brained and return some sort of frankenstein subclass of
     // Array backed by ArrayBuffer which would lazily decode the Choice on access,
-    // but thats ultimately not worth the effort. You can't have both a high-level
-    // idiomatic API and performance here, hence why the choose function below
-    // exists.
+    // but thats ultimately not worth the effort.
     const options = new Array(n);
-    const data = new Uint8Array(buf);
     for (let i = 0; i < n; i++)
-        options[i] = _1.Choice.decode(data[i]);
+        options[i] = common_1.Choice.decode(out[i]);
     return options;
 }
-exports.choices = choices;
-function choose(index, showdown, battle, player, choice, buf, fn) {
-    const request = choice[0] === 'p' ? 0 : choice[0] === 'm' ? 1 : 2;
-    const n = ADDON[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, buf);
-    const data = new Uint8Array(buf);
-    return _1.Choice.decode(data[fn(n)]);
-}
-exports.choose = choose;
 function size(index, type) {
-    const bindings = (ADDON[1] ?? ADDON[0]).bindings[index];
+    const bindings = (ADDONS[1] ?? ADDONS[0]).bindings[index];
     return type[0] === 'c' ? bindings.CHOICES_SIZE : bindings.LOGS_SIZE;
 }
-exports.size = size;
 //# sourceMappingURL=addon.js.map