@pkmn/engine 0.1.0-dev.d716e940 → 0.1.0-dev.d73cd76c

package/src/lib/napi.h

@@ -0,0 +1,2 @@
+#define NAPI_VERSION 8
+#include <node_api.h>

package/src/lib/node.zig

@@ -0,0 +1,14 @@
+const c = @import("napi");
+const js = @import("common/js.zig");
+const node = @import("bindings/node.zig");
+const std = @import("std");
+
+const assert = std.debug.assert;
+
+export fn napi_register_module_v1(env: c.napi_env, exports: c.napi_value) c.napi_value {
+    const properties = [_]c.napi_property_descriptor{
+        js.Property.init("engine", .{ .value = node.register(env) }),
+    };
+    assert(c.napi_define_properties(env, exports, properties.len, &properties) == c.napi_ok);
+    return exports;
+}

package/src/lib/pkmn.zig

@@ -1,4 +1,4 @@
-/// Configurated Options for the pkmn package.
+/// Configured Options for the pkmn package.
 pub const options = @import("common/options.zig");
 /// Configures the behavior of the pkmn package.
 pub const Options = options.Options;
@@ -22,33 +22,188 @@ pub const Choice = @import("common/data.zig").Choice;
 /// considered terminal.
 pub const Result = @import("common/data.zig").Result;
 
+/// Helpers for working with bit-packed arrays of non-powers-of-2 types.
+pub const Array = @import("common/array.zig").Array;
+/// Optimized optional representation which stores the empty None value as a sentinel.
+pub const Optional = @import("common/optional.zig").Optional;
+
 /// Pokémon Showdown's RNG (backed by a Generation V & VI RNG).
 pub const PSRNG = @import("common/rng.zig").PSRNG;
 
 /// Namespace for helpers related to protocol message logging.
-pub const protocol = if (options.internal) struct {
-    pub usingnamespace @import("common/protocol.zig");
-} else struct {
-    /// Logs protocol information to its `Writer` during a battle update when
+pub const protocol = if (options.internal) @import("common/protocol.zig") else struct {
+    /// Logs protocol information to its `WriterT` during a battle update when
     /// `options.log` is enabled.
     pub const Log = @import("common/protocol.zig").Log;
-    /// Stripped down version of `std.io.FixedBufferStream` optimized for
-    /// efficiently writing the individual protocol bytes. Note that the
-    /// `ByteStream.Writer` is **not** a `std.io.Writer` and should not be
-    /// used for general purpose writing.
-    pub const ByteStream = @import("common/protocol.zig").ByteStream;
-    /// `Log` type backed by the optimized `ByteStream.Writer`. Intended to be
-    /// intialized with a `LOGS_SIZE`-sized buffer.
+    /// `Log` type backed by the optimized `Writer`. Intended to be intialized with
+    /// a `LOGS_SIZE`-sized buffer.
     pub const FixedLog = @import("common/protocol.zig").FixedLog;
-    /// Null object pattern implementation of `Log` backed by a
-    /// `std.io.null_writer`. Ignores anything sent to it, though protocol
-    /// logging should additionally be turned off entirely with `options.log`.
+    /// Minimal logging helper optimized for efficiently writing the individual
+    /// protocol bytes into a fixed buffer. Note that this is **not** a
+    /// `std.Io.Writer` and should not be used for general purpose writing.
+    pub const Writer = @import("common/protocol.zig").Writer;
+    /// Null object pattern implementation of `Log` backed by a null writer.
+    /// Ignores anything sent to it, though protocol logging should additionally
+    /// be turned off entirely with `options.log`.
     pub const NULL = @import("common/protocol.zig").NULL;
 };
 
-/// Namespace for Generation I Pokémon
+/// Specialization of a rational number used by the engine to compute probabilties.
+pub const Rational = @import("common/rational.zig").Rational;
+
+/// Namespace for cross-generation battle-related types.
+pub const battle = @import("common/battle.zig");
+
+/// Namespace for Generation I Pokémon.
 pub const gen1 = struct {
-    pub usingnamespace @import("gen1/data.zig");
+    const data = @import("gen1/data.zig");
+    /// The minimum size in bytes required to hold all Generation I choice options.
+    pub const MAX_CHOICES = data.MAX_CHOICES;
+    /// The maximum number of bytes possibly logged by a single Generation I update.
+    pub const MAX_LOGS = data.MAX_LOGS;
+    /// The optimal size in bytes required to hold all Generation I choice options.
+    /// At least as large as MAX_CHOICES.
+    pub const CHOICES_SIZE = data.CHOICES_SIZE;
+    /// The optimal size in bytes required to hold the largest amount of log data possible from a
+    /// single Generation I update. At least as large as MAX_LOGS.
+    pub const LOGS_SIZE = data.LOGS_SIZE;
+    ///  Null object pattern implementation of pkmn.battle.Options for Generation I.
+    pub const NULL = data.NULL;
+    /// The pseudo random number generator used by Generation I.
+    pub const PRNG = data.PRNG;
+    /// Representation of a Generation I battle.
+    pub const Battle = data.Battle;
+    /// Representation of one side of a Generation I Pokémon battle.
+    pub const Side = data.Side;
+    /// Representation of the state for single Generation I Pokémon while active in battle.
+    pub const ActivePokemon = data.ActivePokemon;
+    /// Representation of the state for single Generation I Pokémon while inactive in the party.
+    pub const Pokemon = data.Pokemon;
+    /// Representation of a Generation I Pokémon's move slot in a battle.
+    pub const MoveSlot = data.MoveSlot;
+    /// Details required to detect desyncs based on the move last selected/executed by players.
+    pub const MoveDetails = data.MoveDetails;
+    /// Bitfield representation of a Generation I & II Pokémon's major status condition.
+    pub const Status = data.Status;
+    /// Bitfield representation of volatile statuses and associated data in Generation I.
+    pub const Volatiles = data.Volatiles;
+    /// Representation of a Pokémon's stats in Generation I.
+    pub const Stats = data.Stats;
+    /// Representation of a Pokémon's boosts in Generation I.
+    pub const Boosts = data.Boosts;
+    /// Representation of a Generation I Pokémon move.
+    pub const Move = data.Move;
+    /// Representation of a Generation I Pokémon species.
+    pub const Species = data.Species;
+    /// Representation of a Generation I type in Pokémon.
+    pub const Type = data.Type;
+    /// Representation of a Generation I Pokémon's typing.
+    pub const Types = data.Types;
+    /// Modifiers for the effectiveness of a type vs. another type in Pokémon.
+    pub const Effectiveness = data.Effectiveness;
+    /// Representation of a Generation I Pokémon's determinant values.
+    pub const DVs = data.DVs;
+
+    /// Tracks chance actions and their associated probability during a
+    /// Generation I battle update when `options.chance` is enabled.
+    pub const Chance = @import("gen1/chance.zig").Chance;
+    /// Namespace for types associated with tracking Generation I Pokémon chance outcomes.
+    pub const chance = struct {
+        /// Actions taken by a hypothetical "chance player" that convey
+        /// information about which RNG events were observed during a Generation
+        /// I battle `update`. This can additionally be provided as input to the
+        /// `update` call via the `Calc` when `options.calc` is enabled to
+        /// override the normal behavior of the RNG in order to force specific
+        /// outcomes.
+        pub const Actions = @import("gen1/chance.zig").Actions;
+        /// Information about the RNG that was observed during a Generation I
+        /// battle `update` for a single player.
+        pub const Action = @import("gen1/chance.zig").Action;
+        /// TODO
+        pub const Durations = @import("gen1/chance.zig").Durations;
+        /// TODO
+        pub const Duration = @import("gen1/chance.zig").Duration;
+        /// Null object pattern implementation of Generation I `Chance` which
+        /// does nothing, though chance tracking should additionally be turned
+        /// off entirely via `options.chance`.
+        pub const NULL = @import("gen1/chance.zig").NULL;
+    };
+    /// Allows for forcing the value of specific RNG events during a Generation I battle `update`
+    /// via `overrides` and tracks `summaries` of information relevant to damage calculation.
+    pub const Calc = @import("gen1/calc.zig").Calc;
+    /// Namespace for types associated with supported Generation I Pokémon damage calc features.
+    pub const calc = if (options.internal) @import("gen1/calc.zig") else struct {
+        /// Information relevant to damage calculation that occured during a Generation I
+        /// battle `update`.
+        pub const Summaries = @import("gen1/calc.zig").Summaries;
+        /// Information relevant to damage calculation that occured during a Generation I
+        /// battle `update` for a single player.
+        pub const Summary = @import("gen1/calc.zig").Summary;
+        /// Null object pattern implementation of Generation I `Calc` which does nothing,
+        /// though damage calculator support should additionally be turned off
+        /// entirely via `options.calc`.
+        pub const NULL = @import("gen1/calc.zig").NULL;
+        /// TODO
+        pub const MAX_FRONTIER = @import("gen1/calc.zig").MAX_FRONTIER;
+        /// TODO
+        pub const Rolls = @import("gen1/calc.zig").Rolls;
+    };
     /// Provides helpers for initializing Generation I Pokémon battles.
     pub const helpers = @import("gen1/helpers.zig");
 };
+
+/// TODO
+pub const gen2 = struct {
+    const data = @import("gen2/data.zig");
+    pub const MAX_CHOICES = data.MAX_CHOICES;
+    pub const MAX_LOGS = data.MAX_LOGS;
+    pub const CHOICES_SIZE = data.CHOICES_SIZE;
+    pub const LOGS_SIZE = data.LOGS_SIZE;
+    pub const NULL = data.NULL;
+    pub const PRNG = data.PRNG;
+    pub const Battle = data.Battle;
+    pub const Field = data.Field;
+    pub const Weather = data.Weather;
+    pub const Side = data.Side;
+    pub const ActivePokemon = data.ActivePokemon;
+    pub const Pokemon = data.Pokemon;
+    pub const Gender = data.Gender;
+    pub const DVs = data.DVs;
+    pub const MoveSlot = data.MoveSlot;
+    pub const Status = data.Status;
+    pub const TriAttack = data.TriAttack;
+    pub const Volatiles = data.Volatiles;
+    pub const Stats = data.Stats;
+    pub const Boosts = data.Boosts;
+    pub const Item = data.Item;
+    pub const Move = data.Move;
+    pub const Species = data.Species;
+    pub const Type = data.Type;
+    pub const Types = data.Types;
+    pub const Effectiveness = data.Effectiveness;
+
+    pub const Chance = @import("gen2/chance.zig").Chance;
+    pub const chance = struct {
+        pub const Actions = @import("gen2/chance.zig").Actions;
+        pub const Action = @import("gen2/chance.zig").Action;
+        pub const Durations = @import("gen2/chance.zig").Durations;
+        pub const Duration = @import("gen2/chance.zig").Duration;
+        pub const NULL = @import("gen2/chance.zig").NULL;
+    };
+    pub const Calc = @import("gen2/calc.zig").Calc;
+    pub const calc = if (options.internal) @import("gen2/calc.zig") else struct {
+        pub const Summaries = @import("gen2/calc.zig").Summaries;
+        pub const Summary = @import("gen2/calc.zig").Summary;
+        pub const NULL = @import("gen2/calc.zig").NULL;
+    };
+    pub const helpers = @import("gen2/helpers.zig");
+};
+
+// Internal APIs used by other pkmn libraries, not actually part of the public API.
+pub const js = if (options.internal) @import("common/js.zig") else {};
+pub const util = if (options.internal) @import("common/util.zig") else {};
+pub const bindings = if (options.internal) struct {
+    pub const c = @import("bindings/c.zig");
+    pub const node = @import("bindings/node.zig");
+    pub const wasm = @import("bindings/wasm.zig");
+} else {};

package/src/lib/wasm.zig

@@ -0,0 +1,13 @@
+const std = @import("std");
+const wasm = @import("bindings/wasm.zig");
+
+export const SHOWDOWN = wasm.options.showdown;
+export const LOG = wasm.options.log;
+export const CHANCE = wasm.options.chance;
+export const CALC = wasm.options.calc;
+
+export const GEN1_CHOICES_SIZE = wasm.gen(1).CHOICES_SIZE;
+export const GEN1_LOGS_SIZE = wasm.gen(1).LOGS_SIZE;
+
+export const GEN1_update = wasm.gen(1).update;
+export const GEN1_choices = wasm.gen(1).choices;

package/src/tools/display/dom.ts

@@ -0,0 +1,108 @@
+/** @license MIT modified from Vadim Demedes's https://github.com/vadimdemedes/dom-chef */
+
+declare global {
+  namespace JSX {
+    type Element = HTMLElement | DocumentFragment;
+    interface IntrinsicElements {
+      [elemName: string]: Record<string, unknown>;
+    }
+  }
+}
+
+type Child = Node | string | number | boolean | null | undefined | Child[];
+
+type DocumentFragmentFunction = (props?: any) => DocumentFragment;
+type ElementFunction = (props?: any) => HTMLElement;
+
+// https://github.com/preactjs/preact/blob/1bbd687c/src/constants.js#L3
+const IS_NON_DIMENSIONAL = /acit|ex(?:s|g|n|p|$)|rph|grid|ows|mnc|ntw|ine[ch]|zoo|^ord|itera/i;
+
+const setCSSProps = (element: HTMLElement, style: CSSStyleDeclaration) => {
+  for (const [name, value] of Object.entries(style)) {
+    if (name.startsWith('-')) {
+      element.style.setProperty(name, value);
+    } else if (typeof value === 'number' && !IS_NON_DIMENSIONAL.test(name)) {
+      element.style[name as any] = `${value as string}px`;
+    } else {
+      element.style[name as any] = value;
+    }
+  }
+};
+
+const setAttribute = (element: HTMLElement, name: string, value: string) => {
+  if (value !== undefined && value !== null) element.setAttribute(name, value);
+};
+
+const addChildren = (parent: Node, children: Child[]) => {
+  for (const child of children) {
+    if (child instanceof Node) {
+      parent.appendChild(child);
+    } else if (Array.isArray(child)) {
+      addChildren(parent, child);
+    } else if (typeof child !== 'boolean' && typeof child !== 'undefined' && child !== null) {
+      parent.appendChild(document.createTextNode(String(child)));
+    }
+  }
+};
+
+// https://github.com/facebook/react/blob/3f899089/packages/react-dom/src/shared/DOMProperty.js#L288-L322
+const FALSIFIABLE_ATTRIBUTES = ['contentEditable', 'draggable', 'spellCheck', 'value'];
+
+export function h<K extends keyof HTMLElementTagNameMap>(
+  type: K,
+  attributes?: any,
+  ...children: Child[]
+): HTMLElementTagNameMap[K];
+export function h(
+  type: DocumentFragmentFunction,
+  attributes?: any,
+  ...children: Child[]
+): DocumentFragment;
+export function h<T extends HTMLElement>(
+  type: (props: any) => T,
+  attributes?: any,
+  ...children: Child[]
+): T;
+export function h(
+  type: string,
+  attributes?: any,
+  ...children: Child[]
+): HTMLElement;
+export function h(
+  type: DocumentFragmentFunction | ElementFunction | string,
+  attributes?: any,
+  ...children: Child[]
+): JSX.Element {
+  if (typeof type !== 'string') {
+    const element = type(attributes);
+    addChildren(element, children);
+    return element;
+  }
+
+  const element = document.createElement(type);
+  addChildren(element, children);
+  if (!attributes) return element;
+
+  for (let [name, value] of Object.entries(attributes)) {
+    if (name === 'htmlFor') name = 'for';
+
+    if (name === 'class' || name === 'className') {
+      const existingClassname = element.getAttribute('class') ?? '';
+      setAttribute(element, 'class', (existingClassname + ' ' + String(value)).trim());
+    } else if (name === 'style') {
+      setCSSProps(element, value as CSSStyleDeclaration);
+    } else if (name.startsWith('on')) {
+      const eventName = name.slice(2).toLowerCase().replace(/^-/, '');
+      element.addEventListener(eventName, value as EventListenerOrEventListenerObject);
+    } else if (name === 'dangerouslySetInnerHTML' && value && (value as any).__html) {
+      element.innerHTML = (value as any).__html;
+    } else if (name !== 'key' && (FALSIFIABLE_ATTRIBUTES.includes(name) || value !== false)) {
+      setAttribute(element, name, value === true ? '' : String(value));
+    }
+  }
+
+  return element;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const Fragment = (unused?: any) => document.createDocumentFragment();

package/src/tools/display/ui.css

@@ -0,0 +1,354 @@
+body {
+  background: white;
+  color: black;
+}
+code {
+  background: white;
+  color: black;
+}
+#content {
+  font-family: "Roboto", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
+  margin: 4em auto;
+  max-width: 1300px;
+  line-height: 1.4em;
+  --hp-bar: 151px;
+  --hp-text: 32px;
+  --radius: 10px;
+}
+details > summary {
+  list-style: none;
+}
+details > summary::-webkit-details-marker {
+  display: none;
+}
+.battle > .details {
+  background: #eee;
+  border-bottom: 3px solid black;
+  border-radius: var(--radius) var(--radius) 0 0;
+  padding: 0 1em;
+  display: flex;
+  justify-content: space-between;
+}
+.inner {
+  display: flex;
+  justify-content: center;
+  flex-direction: column;
+}
+.side > .details {
+  padding: 0.5em 1em;
+  display: flex;
+  justify-content: space-between;
+  text-align: center;
+  flex: 0 1 auto;
+}
+.active {
+  flex: 1 1 auto;
+}
+details {
+  flex: 0 1 auto;
+}
+.sides {
+  display: flex;
+}
+.side {
+  flex: 1;
+  display: flex;
+  flex-flow: column;
+}
+.side.p1 {
+  border-right: 1px solid black;
+}
+.battle {
+  border: 3px solid black;
+  border-radius: var(--radius);
+}
+summary {
+  border-top: 1px solid #eee;
+  text-align: center;
+  padding: 0.25em;
+}
+.good {
+  color: green;
+}
+.bad {
+  color: red;
+}
+.pokemon {
+  position: relative;
+  padding: 0.5em 1em;
+  border-top: 1px solid black;
+  display: flex;
+}
+.active > .pokemon {
+  border-top: 1px solid #eee;
+}
+table {
+  border-collapse: collapse;
+  border-style: hidden;
+  border-spacing: 0px;
+  line-height: 1.5em;
+}
+th, td {
+  border: 1px solid black;
+  padding: 0 0.5em;
+}
+.statbar {
+  display: none;
+  width: calc(var(--hp-bar) + var(--hp-text));
+  padding: 2px 0;
+  line-height: normal;
+}
+.statbar .name {
+  display: block;
+  text-align: center;
+  line-height: 1.25em;
+}
+.statbar strong {
+  color: #222222;
+  text-shadow:
+    #FFFFFF 1px 1px 0, #FFFFFF 1px -1px 0,
+    #FFFFFF -1px 1px 0, #FFFFFF -1px -1px 0;
+}
+.statbar strong small {
+  font-weight: normal;
+}
+.statbar .hpbar {
+  position: relative;
+  border: 1px solid #777777;
+  background: #FCFEFF;
+  padding: 1px;
+  height: 8px;
+  margin: 0 0 0 0;
+  width: calc(var(--hp-bar) + var(--hp-text) + 1px);
+  border-radius: 4px;
+}
+.statbar .hpbar .hp {
+  height: 4px;
+  border-top: 2px solid #00dd60;
+  background: #00bb51;
+  border-bottom: 2px solid #007734;
+  border-right: 1px solid #007734;
+  border-radius: 3px;
+}
+.statbar .hpbar .hp-yellow {
+  border-top-color: #f8e379;
+  background-color: #f5d538;
+  border-bottom-color: #be9f0a;
+  border-right-color: #be9f0a;
+}
+.statbar .hpbar .hp-red {
+  border-top-color: #f37f67;
+  background-color: #ee4928;
+  border-bottom-color: #a3260d;
+  border-right-color: #a3260d;
+}
+.statbar .hpbar .prevhp {
+  background: #BBEECC;
+  height: 8px;
+  border-radius: 3px;
+}
+.statbar .hpbar .prevhp-yellow {
+  background-color: #fcf4ca;
+}
+.statbar .hpbar .prevhp-red {
+  background-color: #facec5;
+}
+.statbar .hpbar .hptext {
+  position: absolute;
+  background: #777777;
+  color: #EEEEEE;
+  text-shadow: #000000 0 1px 0;
+  font-size: 10px;
+  width: 32px;
+  height: 12px;
+  top: -1px;
+  text-align: center;
+}
+.status, .volatile {
+  padding: 0px 1px;
+  border: 1px solid #FF4400;
+  border-radius: 3px;
+}
+.status {
+  min-height: 10px;
+  font-size: 7pt;
+  vertical-align: middle;
+  padding: 1px 2px;
+  border: 0;
+  border-radius: 3px;
+  text-transform: uppercase;
+  margin: 0 2px;
+}
+.status.brn {
+  background: #EE5533;
+  color: #FFFFFF;
+}
+.status.psn {
+  background: #A4009A;
+  color: #FFFFFF;
+}
+.status.par {
+  background: #9AA400;
+  color: #FFFFFF;
+}
+.status.slp {
+  background: #AA77AA;
+  color: #FFFFFF;
+}
+.status.frz {
+  background: #009AA4;
+  color: #FFFFFF;
+}
+.volatile {
+  display: inline-block;
+  padding: 0 5px;
+  margin: 2px
+}
+.volatile.bad {
+  background: #FFE5E0;
+  color: #FF4400;
+  border-color: #FF4400;
+}
+.volatile.good {
+  background: #E5FFE0;
+  color: #33AA00;
+  border-color: #33AA00;
+}
+.volatile.neutral {
+  background: #F0F0F0;
+  color: #555555;
+  border-color: #555555;
+}
+.rstatbar .hpbar .hptext {
+  right: 0px;
+  border-radius: 0 4px 4px 0;
+}
+.moves ul {
+  display: grid;
+  grid-template-columns: repeat(2, auto);
+  gap: 0 2em;
+}
+.left {
+  padding-right: 32px;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+}
+.stats {
+  display: flex;
+  padding: 0 1em;
+  justify-content: space-between;
+  text-align: center;
+  width: 100%;
+}
+.boosts {
+  margin: 0 5px;
+}
+.types {
+  display: inherit;
+}
+.disabled {
+  color: #AAAAAA;
+}
+.position {
+  position: absolute;
+  right: 10px;
+  color: #AAAAAA;
+}
+.left .position {
+  display: none;
+}
+.right .position {
+  display: block;
+}
+.teamicons {
+  display: inline-block;
+}
+@media(max-width: 1300px) {
+  #content {
+    font-size: 0.85em;
+    max-width: 95%;
+    margin: 2em auto;
+  }
+}
+@media(max-width: 1200px) {
+  .moves ul {
+    grid-template-columns: repeat(1, auto);
+  }
+}
+@media(max-width: 1100px) {
+  .pokemon {
+    flex-direction: column;
+  }
+  .stats {
+    justify-content: center;
+    padding: 0;
+  }
+  .moves ul {
+    grid-template-columns: repeat(2, auto);
+  }
+  .left {
+    padding-right: 0;
+  }
+  .right {
+    padding-top: 1em;
+  }
+  .volatiles {
+    display: flex;
+    justify-content: center;
+    flex-wrap: wrap;
+  }
+  .left .position {
+    display: block;
+  }
+  .right .position {
+    display: none;
+  }
+}
+@media(max-width: 800px) {
+  .moves {
+    display: flex;
+    justify-content: center;
+  }
+  .moves ul {
+    display: inline-block;
+    padding: 0;
+  }
+}
+@media(max-width: 680px) {
+  .stats {
+    flex-direction: column;
+    padding: 0;
+  }
+  .boosts {
+    display: flex;
+    justify-content: space-between;
+    margin: 0.5em 0 0 0;
+  }
+}
+@media(max-width: 550px) {
+  #content {
+    font-size: 0.65em;
+    max-width: 95%;
+    margin: 1em auto;
+    --hp-bar: 101px;
+  }
+}
+@media(max-width: 425px) {
+  .stats {
+    font-size: 0.9em;
+  }
+}
+h1 {
+  text-align: center;
+}
+.error {
+  overflow: auto;
+  scrollbar-width: none;
+  padding: 10px 20px;
+  border: 3px solid #DD4422;
+  background: #FFF8F2;
+}
+.error::-webkit-scrollbar {
+  display: none;
+}