@pkhex-everywhere/react 0.2.3 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @pkhex-everywhere/react
 
+## 0.3.0
+
+### Patch Changes
+
+- c6812ee: `game.formats()` lists the save formats PKHeX doesn't know, such as ROM hacks, by id and name. `game.load()` takes an optional `formatId` that loads the save with that format and skips detection. An unknown id fails with `not-found`. Client methods and hook commands now carry the engine's doc comments, and `useLoadedGame().load()` takes `formatId` too.
+- Updated dependencies [c6812ee]
+- Updated dependencies [79bb0ce]
+- Updated dependencies [cb21c83]
+- Updated dependencies [dde2b58]
+- Updated dependencies [f11f9a8]
+- Updated dependencies [670a8ed]
+  - @pkhex-everywhere/engine@0.3.0
+
 ## 0.2.3
 
 ### Patch Changes

package/dist/generated/hooks.d.ts

@@ -22,7 +22,14 @@ export declare function useLoadedGame(): {
     /** Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
     export: () => Promise<import("@pkhex-everywhere/engine").ExportedSave>;
     file: () => Promise<import("@pkhex-everywhere/engine").LoadedSave | null>;
-    load: (data: Binary, fileName?: string | null) => Promise<void>;
+    /**
+     * Loads a save file, replacing the one loaded before.
+     *
+     * @param data The save file's bytes.
+     * @param fileName The file name to export the save with. Defaults to the name of a `File`, or `save.sav`.
+     * @param formatId The id of a save format from `game.formats()` to load the save with, skipping detection. Pass `pkhex` to load it with PKHeX's own detection. An unknown id fails with `not-found`, and a save the format can't read fails with `invalid-save`. Without it, a save that might be in one of the formats fails with `format-choice-required`, whose `candidates` list them.
+     */
+    load: (data: Binary, fileName?: string | null, formatId?: string | null) => Promise<void>;
     loadBlank: (version: number) => Promise<void>;
     game: import("@pkhex-everywhere/engine").SaveSummary | null;
 };

package/dist/index.js

@@ -165,7 +165,14 @@ function useLoadedGame() {
 			/** Requires a loaded save; throws `no-save` otherwise. Wrap in `<RequireGame>`. */
 			export: () => engine.game.export(),
 			file: () => engine.game.file(),
-			load: (data, fileName) => engine.game.load(data, fileName),
+			/**
+			* Loads a save file, replacing the one loaded before.
+			*
+			* @param data The save file's bytes.
+			* @param fileName The file name to export the save with. Defaults to the name of a `File`, or `save.sav`.
+			* @param formatId The id of a save format from `game.formats()` to load the save with, skipping detection. Pass `pkhex` to load it with PKHeX's own detection. An unknown id fails with `not-found`, and a save the format can't read fails with `invalid-save`. Without it, a save that might be in one of the formats fails with `format-choice-required`, whose `candidates` list them.
+			*/
+			load: (data, fileName, formatId) => engine.game.load(data, fileName, formatId),
 			loadBlank: (version) => engine.game.loadBlank(version)
 		}), [engine])
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkhex-everywhere/react",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "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.2.3",
+    "@pkhex-everywhere/engine": "^0.3.0",
     "react": "^19.0.0"
   },
   "devDependencies": {