@pkhex-everywhere/react 0.7.2 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @pkhex-everywhere/react
 
+## 0.8.1
+
+### Patch Changes
+
+- 45aa5c8: New `trade` calls move Pokémon between the loaded save and a partner save, the way link trades, the Time Capsule, Pal Park and Poké Transfer do. `trade.open()` loads the partner and reports the routes and empty box slots, `trade.preview()` shows what each Pokémon arrives as and refuses what the games refuse, and `trade.commit()` moves them and returns both saves. New `useTrade()` hook and `trade` topic.
+- Updated dependencies [45aa5c8]
+  - @pkhex-everywhere/engine@0.8.1
+
+## 0.8.0
+
+### Patch Changes
+
+- Updated dependencies [c5cd974]
+- Updated dependencies [d03bb1c]
+- Updated dependencies [5bfab1b]
+- Updated dependencies [d8b8e64]
+- Updated dependencies [74c1996]
+- Updated dependencies [e6f46d6]
+  - @pkhex-everywhere/engine@0.8.0
+
 ## 0.7.2
 
 ### Patch Changes

package/dist/generated/hooks.d.ts

@@ -1,4 +1,4 @@
-import type { Binary, ItemHandle, PokemonHandle, PokemonPatch, TrainerGender } from '@pkhex-everywhere/engine';
+import type { Binary, ItemHandle, PokemonHandle, PokemonPatch, TradeOffer, TrainerGender } from '@pkhex-everywhere/engine';
 /** Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
 export declare function useBox(): {
     /** Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
@@ -65,6 +65,21 @@ export declare function usePokemon(at: PokemonHandle): {
     update: (patch: PokemonPatch) => Promise<void>;
     pokemon: import("@pkhex-everywhere/engine").PokemonSummary;
 };
+export declare function useTrade(): {
+    /** Closes the open trade, dropping the partner save. Closing with no trade open does nothing. */
+    close: () => Promise<void>;
+    /** Moves the offered Pokémon: each leaves its slot and lands in the first empty box slots of the other save. Fails with `trade-refused`, writing nothing, when `trade.preview()` refuses any of them. Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
+    commit: (offer: TradeOffer) => Promise<import("@pkhex-everywhere/engine").TradeResult>;
+    /**
+     * Opens a partner save next to the loaded one, to move Pokémon between them. It replaces the partner opened before, and stays open until `trade.close()`, even when another save is loaded. Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`.
+     *
+     * @param data The partner save file's bytes.
+     * @param fileName The file name to export the partner with. Defaults to the name of a `File`, or `partner.sav`.
+     * @param formatId The id of a save format from `game.formats()` to load the partner with, as in `game.load()`.
+     */
+    open: (data: Binary, fileName?: string | null, formatId?: string | null) => Promise<import("@pkhex-everywhere/engine").TradeSummary>;
+    trade: import("@pkhex-everywhere/engine").TradeSummary | null;
+};
 /** Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
 export declare function useTrainer(): {
     /** Sets which gym badges the trainer has, one value per badge in the order `trainer.badges` lists them. Throws `not-supported` when `trainer.badges` returns null, and `out-of-range` when the number of values doesn't match. Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */

package/dist/index.js

@@ -220,6 +220,26 @@ function usePokemon(at) {
 		}), [engine, key])
 	};
 }
+function useTrade() {
+	const engine = useEngine();
+	return {
+		trade: useQuery("trade.get"),
+		...useMemo(() => ({
+			/** Closes the open trade, dropping the partner save. Closing with no trade open does nothing. */
+			close: () => engine.trade.close(),
+			/** Moves the offered Pokémon: each leaves its slot and lands in the first empty box slots of the other save. Fails with `trade-refused`, writing nothing, when `trade.preview()` refuses any of them. Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
+			commit: (offer) => engine.trade.commit(offer),
+			/**
+			* Opens a partner save next to the loaded one, to move Pokémon between them. It replaces the partner opened before, and stays open until `trade.close()`, even when another save is loaded. Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`.
+			*
+			* @param data The partner save file's bytes.
+			* @param fileName The file name to export the partner with. Defaults to the name of a `File`, or `partner.sav`.
+			* @param formatId The id of a save format from `game.formats()` to load the partner with, as in `game.load()`.
+			*/
+			open: (data, fileName, formatId) => engine.trade.open(data, fileName, formatId)
+		}), [engine])
+	};
+}
 /** Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
 function useTrainer() {
 	const engine = useEngine();
@@ -259,4 +279,4 @@ function usePokemonDetails(at) {
 	};
 }
 //#endregion
-export { EngineProvider, RequireGame, useBox, useEngine, useEngineStatus, useEvents, useInventory, useLoadedGame, useParty, usePokemon, usePokemonDetails, useQuery, useTrainer };
+export { EngineProvider, RequireGame, useBox, useEngine, useEngineStatus, useEvents, useInventory, useLoadedGame, useParty, usePokemon, usePokemonDetails, useQuery, useTrade, useTrainer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkhex-everywhere/react",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "description": "React hooks for @pkhex-everywhere/engine.",
   "license": "GPL-3.0-or-later",
   "homepage": "https://docs.pkhex-everywhere.fyi/docs/",
@@ -30,7 +30,7 @@
     "test": "vitest run"
   },
   "peerDependencies": {
-    "@pkhex-everywhere/engine": "^0.7.2",
+    "@pkhex-everywhere/engine": "^0.8.1",
     "react": "^19.0.0"
   },
   "devDependencies": {