@pkhex-everywhere/engine 0.21.0 → 0.22.0

package/dist/generated/client.d.ts

@@ -1,7 +1,7 @@
-import type { ActionPlacement, AddFromFileOptions, AddedPokemon, Badge, Binary, BoxEntry, CatalogNames, CatalogNamesRequest, Choice, ConvertedPokemon, DeclaredPage, EditablePokemon, EncounterRow, EncounterVersions, ExportedPokemon, ExportedSave, FilePreview, FormatEntry, GameProgress, InstalledPlugIn, ItemHandle, LoadedSave, PlugInAction, PlugInDetails, PlugInFailure, PlugInOutcome, PlugInSetting, PlugInState, PokemonFile, PokemonHandle, PokemonId, PokemonOptions, PokemonPatch, PokemonSummary, Pouch, PublishedVersion, SaveEvents, SaveSummary, SaveVersion, SpeciesEntry, TeamEntry, TeamSlot, TrainerCard, TrainerGender, TransferOffer, TransferPreview, TransferResult, TransferSave, TransferSummary, VersionEntry } from './types';
+import type { ActionPlacement, AddFromFileOptions, AddedPokemon, Badge, Binary, BoxEntry, CatalogNames, CatalogNamesRequest, Choice, ConvertedPokemon, DeclaredPage, EditablePokemon, EncounterRow, EncounterVersions, ExportedPokemon, ExportedSave, FilePreview, FormatEntry, GameProgress, GiftAlbum, GiftEvent, InstalledPlugIn, ItemHandle, LoadedSave, PlugInAction, PlugInDetails, PlugInFailure, PlugInOutcome, PlugInSetting, PlugInState, PokemonFile, PokemonHandle, PokemonId, PokemonOptions, PokemonPatch, PokemonSummary, Pouch, PublishedVersion, SaveEvents, SaveSummary, SaveVersion, SpeciesEntry, TeamEntry, TeamSlot, TrainerCard, TrainerGender, TransferOffer, TransferPreview, TransferResult, TransferSave, TransferSummary, VersionEntry, WonderCardPreview } from './types';
 export type Invoke = <T>(call: CallName, args: unknown[]) => Promise<T>;
-export declare const queries: readonly ['box.get', 'box.list', 'box.previewFile', 'box.showdown', 'catalog.names', 'encounters.search', 'encounters.versions', 'events.flag', 'events.get', 'game.balls', 'game.blankVersions', 'game.formats', 'game.get', 'game.heldItems', 'game.languages', 'game.moves', 'game.natures', 'game.originGames', 'game.progress', 'game.types', 'game.version', 'inventory.get', 'party.get', 'party.showdown', 'plugins.actions', 'plugins.details', 'plugins.failures', 'plugins.installed', 'plugins.isSupported', 'plugins.pageModule', 'plugins.pages', 'plugins.setting', 'plugins.state', 'pokemon.details', 'pokemon.export', 'pokemon.get', 'pokemon.options', 'pokemon.read', 'pokemon.showdown', 'species.list', 'team.get', 'team.list', 'trainer.badges', 'trainer.get', 'transfer.convert', 'transfer.details', 'transfer.export', 'transfer.get', 'transfer.partnerBoxes', 'transfer.preview'];
-export declare const commands: readonly ['box.addEncounter', 'box.addFromFile', 'events.giveTickets', 'events.setFlag', 'events.setWork', 'game.close', 'game.enableFormat', 'game.export', 'game.file', 'game.load', 'game.loadBlank', 'inventory.setItem', 'plugins.dismissFailure', 'plugins.newestCompatible', 'plugins.register', 'plugins.run', 'plugins.setEnabled', 'plugins.setHookEnabled', 'plugins.unregister', 'plugins.updateSetting', 'pokemon.addToBox', 'pokemon.clone', 'pokemon.commit', 'pokemon.edit', 'pokemon.setLevel', 'pokemon.update', 'team.clear', 'team.place', 'trainer.setBadges', 'trainer.setBattlePoints', 'trainer.setGender', 'trainer.setMoney', 'trainer.setName', 'transfer.close', 'transfer.commit', 'transfer.open'];
+export declare const queries: readonly ['box.get', 'box.list', 'box.previewFile', 'box.showdown', 'catalog.names', 'encounters.search', 'encounters.versions', 'events.flag', 'events.get', 'game.balls', 'game.blankVersions', 'game.formats', 'game.get', 'game.heldItems', 'game.languages', 'game.moves', 'game.natures', 'game.originGames', 'game.progress', 'game.types', 'game.version', 'inventory.get', 'mysteryGift.events', 'mysteryGift.previewEvent', 'mysteryGift.previewFile', 'mysteryGift.status', 'party.get', 'party.showdown', 'plugins.actions', 'plugins.details', 'plugins.failures', 'plugins.installed', 'plugins.isSupported', 'plugins.pageModule', 'plugins.pages', 'plugins.setting', 'plugins.state', 'pokemon.details', 'pokemon.export', 'pokemon.get', 'pokemon.options', 'pokemon.read', 'pokemon.showdown', 'species.list', 'team.get', 'team.list', 'trainer.badges', 'trainer.get', 'transfer.convert', 'transfer.details', 'transfer.export', 'transfer.get', 'transfer.partnerBoxes', 'transfer.preview'];
+export declare const commands: readonly ['box.addEncounter', 'box.addFromFile', 'events.giveTickets', 'events.setFlag', 'events.setWork', 'game.close', 'game.enableFormat', 'game.export', 'game.file', 'game.load', 'game.loadBlank', 'inventory.setItem', 'mysteryGift.insertEvent', 'mysteryGift.insertFile', 'mysteryGift.remove', 'mysteryGift.setReceived', 'mysteryGift.setUnlocked', 'plugins.dismissFailure', 'plugins.newestCompatible', 'plugins.register', 'plugins.run', 'plugins.setEnabled', 'plugins.setHookEnabled', 'plugins.unregister', 'plugins.updateSetting', 'pokemon.addToBox', 'pokemon.clone', 'pokemon.commit', 'pokemon.edit', 'pokemon.setLevel', 'pokemon.update', 'team.clear', 'team.place', 'trainer.setBadges', 'trainer.setBattlePoints', 'trainer.setGender', 'trainer.setMoney', 'trainer.setName', 'transfer.close', 'transfer.commit', 'transfer.open'];
 export type QueryName = (typeof queries)[number];
 export type CommandName = (typeof commands)[number];
 export type CallName = QueryName | CommandName;
@@ -89,6 +89,47 @@ export interface EngineClient {
         /** Requires a loaded save; throws `no-save` otherwise. */
         setItem(at: ItemHandle, count: number): Promise<void>;
     };
+    mysteryGift: {
+        /** Lists the events from PKHeX's event database that the save's game can receive, in every language. Requires a loaded save; throws `no-save` otherwise. */
+        events(): Promise<GiftEvent[]>;
+        /**
+         * Puts an event's card in the album as the game does when it receives one, and marks its card number received. The player collects the gift from the delivery person in the game: in Generation 4 it waits in the delivery queue, and in Generation 5 the card isn't collected yet. A filled slot is replaced. A slot past the filled ones puts the card in the first empty slot, so the album never has a gap. Mystery Gift stays as locked or unlocked as it was; call `setUnlocked` to show it. Fails with `not-found` for an id `mysteryGift.events` doesn't list, `out-of-range` for a slot outside the album, and `no-slot` when eight Generation 4 gifts already wait for the delivery person. Requires a loaded save; throws `no-save` otherwise.
+         *
+         * @param id The event's id, from `mysteryGift.events`.
+         * @param slot Zero-based album slot.
+         */
+        insertEvent(id: string, slot: number): Promise<number>;
+        /**
+         * Puts a Wonder Card file in the album, as `insertEvent` does. A card PKHeX doesn't know still goes in. Fails with `unparseable` and `wrong-generation` as `previewFile` does, `not-supported` for the Lock Capsule card, which doesn't go in the album, and `out-of-range` and `no-slot` as `insertEvent` does. Requires a loaded save; throws `no-save` otherwise.
+         *
+         * @param slot Zero-based album slot.
+         */
+        insertFile(bytes: Binary, slot: number): Promise<number>;
+        /**
+         * Shows an event's card as the save would receive it. Nothing is written. Fails with `not-found` for an id `mysteryGift.events` doesn't list. Requires a loaded save; throws `no-save` otherwise.
+         *
+         * @param id The event's id, from `mysteryGift.events`.
+         */
+        previewEvent(id: string): Promise<WonderCardPreview>;
+        /** Shows a Wonder Card file as the save would receive it. Nothing is written. Takes `.pgt`, `.pcd` and `.wc4` files for Generation 4 saves and `.pgf` files for Generation 5 saves. Fails with `unparseable` when the bytes aren't a card, and `wrong-generation` for a card of another generation. Requires a loaded save; throws `no-save` otherwise. */
+        previewFile(bytes: Binary): Promise<WonderCardPreview>;
+        /**
+         * Empties an album slot. The cards after it move up, so the album never has a gap. In Generation 4, a gift still waiting for the delivery person goes with its card. Removing from an empty slot does nothing. Fails with `out-of-range` for a slot outside the album. Requires a loaded save; throws `no-save` otherwise.
+         *
+         * @param slot Zero-based album slot.
+         */
+        remove(slot: number): Promise<void>;
+        /**
+         * Sets or clears the save's mark that it received a card number. Fails with `out-of-range` for a number the save has no mark for. Requires a loaded save; throws `no-save` otherwise.
+         *
+         * @param cardId The card's number, as `cardId` reports it.
+         */
+        setReceived(cardId: number, value: boolean): Promise<void>;
+        /** Shows or hides Mystery Gift in a Generation 4 game's menu. Fails with `not-supported` in Generation 5, which has no unlock of its own. Requires a loaded save; throws `no-save` otherwise. */
+        setUnlocked(value: boolean): Promise<void>;
+        /** The save's Wonder Card album and whether Mystery Gift is unlocked. Only Generation 4 and 5 saves have an album, which `game.get` reports as `hasMysteryGift`. The `mysteryGift` calls fail with `not-supported` on any other save. Requires a loaded save; throws `no-save` otherwise. */
+        status(): Promise<GiftAlbum>;
+    };
     party: {
         /** Requires a loaded save; throws `no-save` otherwise. */
         get(): Promise<PokemonSummary[]>;

package/dist/generated/errors.d.ts

@@ -1,2 +1,2 @@
-export declare const errorCodes: readonly ['no-save', 'invalid-save', 'format-choice-required', 'not-found', 'out-of-range', 'pouch-full', 'box-full', 'unparseable', 'conversion-failed', 'not-in-game', 'unknown-species', 'invalid-patch', 'draft-not-allowed', 'no-slot', 'no-draft', 'unknown-call', 'bad-arguments', 'plugin-failed', 'not-supported', 'no-transfer', 'transfer-refused', 'bad-checksum', 'unexpected'];
+export declare const errorCodes: readonly ['no-save', 'invalid-save', 'format-choice-required', 'not-found', 'out-of-range', 'pouch-full', 'box-full', 'unparseable', 'conversion-failed', 'not-in-game', 'unknown-species', 'invalid-patch', 'draft-not-allowed', 'no-slot', 'no-draft', 'unknown-call', 'bad-arguments', 'plugin-failed', 'not-supported', 'no-transfer', 'transfer-refused', 'bad-checksum', 'wrong-generation', 'unexpected'];
 export type ErrorCode = (typeof errorCodes)[number];

package/dist/generated/topics.d.ts

@@ -1,4 +1,4 @@
 import type { QueryName } from './client';
-export declare const topics: readonly ['*', 'game', 'party', 'box', 'inventory', 'events', 'trainer', 'draft', 'plugins', 'transfer', 'team'];
+export declare const topics: readonly ['*', 'game', 'party', 'box', 'inventory', 'events', 'trainer', 'draft', 'plugins', 'transfer', 'team', 'mysteryGift'];
 export type Topic = (typeof topics)[number] | `${(typeof topics)[number]}/${string}`;
 export declare const queryTopics: Record<QueryName, readonly Topic[]>;

package/dist/generated/types.d.ts

@@ -21,6 +21,13 @@ export interface AddedPokemon {
     /** The empty box slot it was placed in. */
     at: PokemonHandle;
 }
+/** A slot in the save's Wonder Card album. */
+export interface AlbumSlot {
+    /** Zero-based slot, as `mysteryGift.insertEvent` and `mysteryGift.remove` take it. */
+    index: number;
+    /** The card in the slot, or null when it's empty. */
+    card: WonderCardEntry | null;
+}
 /** A gym badge, as `trainer.badges` lists it. */
 export interface Badge {
     /** The badge's English name without "Badge", such as `Boulder`. */
@@ -309,6 +316,39 @@ export interface GameProgress {
     /** The Pokédex counts, or null when the save has no Pokédex or the engine can't read it. */
     pokedex: PokedexCount | null;
 }
+/** The save's Wonder Card album, returned by `mysteryGift.status`. */
+export interface GiftAlbum {
+    /** Whether the game shows Mystery Gift in its menu. Null in Generation 5, where the menu shows it once the player has the Pokédex. */
+    unlocked: boolean | null;
+    /** Every slot in order, empty ones included: 3 in Generation 4, 12 in Generation 5. The filled slots come first. */
+    slots: AlbumSlot[];
+}
+/** An event from PKHeX's event database that the save's game can receive, as `mysteryGift.events` lists it. */
+export interface GiftEvent {
+    /** The event's id, to pass to `mysteryGift.previewEvent` and `mysteryGift.insertEvent`. Made from the card's bytes, so it stays the same across releases. */
+    id: string;
+    /** The title the card shows in the game. */
+    title: string;
+    kind: GiftKind;
+    /** The species of the Pokémon the card gives, or null when it gives none. */
+    species: SpeciesEntry | null;
+    /** The item the card gives, or null when it gives none. */
+    item: GiftItem | null;
+    /** The language code the card is for, such as `ENG`. Null when the card doesn't say, as Generation 4 item cards don't. */
+    language: string | null;
+    /** The card's number. Distributions in several languages often share it. */
+    cardId: number;
+    /** The save is marked as having received a card with this number. */
+    received: boolean;
+}
+/** An item a Wonder Card gives. */
+export interface GiftItem {
+    /** PKHeX item id. */
+    id: number;
+    name: string;
+}
+/** What a Wonder Card gives. */
+export type GiftKind = 'pokemon' | 'item' | 'other';
 /** The type and power of a Pokémon's Hidden Power. */
 export interface HiddenPower {
     /** Type name. */
@@ -826,6 +866,8 @@ export interface SaveSummary {
     generation: number;
     /** Whether the save has event flags and work to edit. When false, `events.get` returns null, or fails with `not-supported` when the save doesn't support `events`. */
     hasEvents: boolean;
+    /** Whether the save has a Wonder Card album: Generation 4 and 5 saves do. When false, the `mysteryGift` calls fail with `not-supported`. */
+    hasMysteryGift: boolean;
     /** The save format the save loaded through, or null for a save PKHeX reads on its own. */
     format: SaveFormat | null;
     /** What the save supports. A save from PKHeX supports all of them. Calls behind a capability that's missing fail with `not-supported`. */
@@ -1021,6 +1063,38 @@ export interface VersionEntry {
     id: number;
     name: string;
 }
+/** A Wonder Card in the save's album. */
+export interface WonderCardEntry {
+    /** The title the card shows in the game. */
+    title: string;
+    kind: GiftKind;
+    /** The species of the Pokémon the card gives, or null when it gives none. */
+    species: SpeciesEntry | null;
+    /** The item the card gives, or null when it gives none. */
+    item: GiftItem | null;
+    /** The language code the card is for, such as `ENG`, `JPN` or `FRE`. Null when the card doesn't say, as Generation 4 item cards don't. */
+    language: string | null;
+    /** The card's number, which the save's received marks go by. */
+    cardId: number;
+    /** The card matches an event in PKHeX's event database. */
+    known: boolean;
+}
+/** A Wonder Card as the save would receive it, returned by `mysteryGift.previewEvent` and `mysteryGift.previewFile`. */
+export interface WonderCardPreview {
+    /** The title the card shows in the game. */
+    title: string;
+    kind: GiftKind;
+    /** The Pokémon as the delivery person would hand it to the save's trainer, or null when the card gives none. A random PID or IVs differ from what the game rolls. */
+    pokemon: PokemonPreview | null;
+    /** The item the card gives, or null when it gives none. */
+    item: GiftItem | null;
+    /** The language code the card is for, such as `ENG`. Null when the card doesn't say. */
+    language: string | null;
+    /** The card's number. A `.pgt` file has no card, so it reads 0. */
+    cardId: number;
+    /** The card matches an event in PKHeX's event database. Unknown cards still insert. */
+    known: boolean;
+}
 /** A known value for an event work entry, with its label. */
 export interface WorkOption {
     name: string;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { a as createEngine, n as topics, o as wasmHost, r as EngineError } from "./topics-BLLnioZB.js";
+import { a as createEngine, n as topics, o as wasmHost, r as EngineError } from "./topics-DWCwlDfO.js";
 //#region src/generated/errors.ts
 var errorCodes = [
 	"no-save",
@@ -23,6 +23,7 @@ var errorCodes = [
 	"no-transfer",
 	"transfer-refused",
 	"bad-checksum",
+	"wrong-generation",
 	"unexpected"
 ];
 //#endregion

package/dist/internal.js

@@ -1,2 +1,2 @@
-import { i as call, s as affects, t as queryTopics } from "./topics-BLLnioZB.js";
+import { i as call, s as affects, t as queryTopics } from "./topics-DWCwlDfO.js";
 export { affects, call, queryTopics };

package/dist/{topics-BLLnioZB.js → topics-DWCwlDfO.js}

@@ -87,6 +87,17 @@ function createClient(invoke) {
 			get: () => invoke("inventory.get", []),
 			setItem: (at, count) => invoke("inventory.setItem", [at, count])
 		},
+		mysteryGift: {
+			events: () => invoke("mysteryGift.events", []),
+			insertEvent: (id, slot) => invoke("mysteryGift.insertEvent", [id, slot]),
+			insertFile: async (bytes, slot) => invoke("mysteryGift.insertFile", [await toBase64(bytes), slot]),
+			previewEvent: (id) => invoke("mysteryGift.previewEvent", [id]),
+			previewFile: async (bytes) => invoke("mysteryGift.previewFile", [await toBase64(bytes)]),
+			remove: (slot) => invoke("mysteryGift.remove", [slot]),
+			setReceived: (cardId, value) => invoke("mysteryGift.setReceived", [cardId, value]),
+			setUnlocked: (value) => invoke("mysteryGift.setUnlocked", [value]),
+			status: () => invoke("mysteryGift.status", [])
+		},
 		party: {
 			get: () => invoke("party.get", []),
 			showdown: () => invoke("party.showdown", [])
@@ -172,7 +183,7 @@ var overlaps = (a, b) => covers(a, b) || covers(b, a);
 var affects = (changed, read) => changed.some((c) => read.some((r) => overlaps(c, r)));
 //#endregion
 //#region package.json
-var version = "0.21.0";
+var version = "0.22.0";
 //#endregion
 //#region src/crypto.ts
 var modes = {
@@ -417,7 +428,8 @@ var topics = [
 	"draft",
 	"plugins",
 	"transfer",
-	"team"
+	"team",
+	"mysteryGift"
 ];
 var queryTopics = {
 	"box.get": ["box"],
@@ -447,6 +459,10 @@ var queryTopics = {
 	"game.types": ["game"],
 	"game.version": ["game"],
 	"inventory.get": ["inventory"],
+	"mysteryGift.events": ["mysteryGift"],
+	"mysteryGift.previewEvent": ["trainer"],
+	"mysteryGift.previewFile": ["trainer"],
+	"mysteryGift.status": ["mysteryGift"],
 	"party.get": ["party"],
 	"party.showdown": ["party"],
 	"plugins.actions": ["*"],

package/notices.json

@@ -2,7 +2,7 @@
   {
     "name": "ICU",
     "license": "Unicode-3.0",
-    "source": "https://github.com/dotnet/dotnet/blob/95017c711e6afc1085133d440e42b4bd78155701/src/runtime/eng/Version.Details.xml"
+    "source": "https://github.com/dotnet/dotnet/blob/4099f83977f4d29604a9aeb971fb0a7bc1d5f699/src/runtime/eng/Version.Details.xml"
   },
   {
     "name": "Microsoft.Extensions.DependencyInjection",
@@ -18,9 +18,9 @@
   },
   {
     "name": "Microsoft.NETCore.App.Runtime.Mono.browser-wasm",
-    "version": "10.0.12",
+    "version": "10.0.13",
     "license": "MIT",
-    "source": "https://github.com/dotnet/dotnet/tree/95017c711e6afc1085133d440e42b4bd78155701"
+    "source": "https://github.com/dotnet/dotnet/tree/4099f83977f4d29604a9aeb971fb0a7bc1d5f699"
   },
   {
     "name": "PKHeX",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkhex-everywhere/engine",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "PKHeX in the browser: load, read and edit Pokémon save files.",
   "license": "GPL-3.0-or-later",
   "homepage": "https://docs.pkhex-everywhere.fyi/docs/",