unite-lib 1.2.0 → 1.3.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export { Locale, getMapDescription, getMapName, getPokemonName } from './i18n/index.cjs';
+export { Locale, getMapDescription, getMapName, getNeutralName, getPokemonName, getSpawnInfo, getSpawnInfoForSpawn } from './i18n/index.cjs';
 
 /**
  * Battle role in Pokémon Unite (Attacker, Defender, etc.).
@@ -87,6 +87,30 @@ interface Map {
     /** Optional description. */
     description?: string;
 }
+/** Wild/neutral Pokémon or item that can spawn on a map. */
+interface Neutral {
+    id: string;
+    /** Image path (relative to package root or baseUrl). */
+    image: string;
+    /** Display name in English (use getNeutralName for other locales). */
+    name: string;
+    /** Pokédex number (omit for non-Pokémon e.g. berries). */
+    dex?: number;
+}
+/** A single spawn point on a map, linked to a neutral by neutralId. */
+interface MapSpawn {
+    mapId: string;
+    neutralId: string;
+    left: string;
+    top: string;
+    spawnTime: string;
+    respawnTime: number;
+    permanentDelete: boolean;
+    /** Optional HTML description (default locale). Use getSpawnInfo for i18n). */
+    info?: string;
+    /** Optional i18n key for info (spawn.info.<key>). When set, getSpawnInfo uses it. */
+    infoKey?: string;
+}
 
 declare const pokemons: Array<Pokemon>;
 
@@ -94,6 +118,10 @@ declare const moves: Move[];
 
 declare const maps: Map[];
 
+declare const neutrals: Neutral[];
+
+declare const spawns: MapSpawn[];
+
 interface GetImageUrlOptions {
     /** Base URL for assets (e.g. CDN). No trailing slash. */
     baseUrl?: string;
@@ -108,14 +136,28 @@ declare function getImageUrl(pokemon: Pokemon, imageKey: keyof PokemonImages, op
  * Falls back to map.image when resolution is omitted or not available.
  */
 declare function getMapImageUrl(map: Map, resolution?: MapResolution, options?: GetImageUrlOptions): string;
+/**
+ * Returns spawns for a given map id (e.g. "map-groudon", "map-kyogre", "map-rayquaza").
+ */
+declare function getSpawnsByMap(mapId: string): MapSpawn[];
+/**
+ * Returns the neutral by id, or undefined if not found.
+ */
+declare function getNeutralById(id: string): Neutral | undefined;
+/**
+ * Returns the image URL for a neutral (wild Pokémon or item).
+ */
+declare function getNeutralImageUrl(neutral: Neutral, options?: GetImageUrlOptions): string;
 declare function getPokemonByName(name: string): Pokemon | undefined;
 declare function getPokemonByDex(dex: number): Pokemon | undefined;
 /**
  * Slug from roster image: "pokemons/roster-venusaur.png" -> "venusaur"
+ * Use this slug with getPokemonName(id, locale) for i18n.
  */
+declare function getPokemonSlug(pokemon: Pokemon): string;
 declare function getPokemonBySlug(slug: string): Pokemon | undefined;
 declare function getPokemonsByBattleType(battleType: BattleType): Pokemon[];
 declare function getPokemonsByTag(tag: Tag): Pokemon[];
 declare function getActivePokemons(): Pokemon[];
 
-export { BattleType, type GetImageUrlOptions, type Map, type MapResolution, type Move, type MoveSlotId, type Pokemon, type PokemonImages, type PokemonStats, Tag, getActivePokemons, getImageUrl, getMapImageUrl, getPokemonByDex, getPokemonByName, getPokemonBySlug, getPokemonsByBattleType, getPokemonsByTag, maps, moves, pokemons };
+export { BattleType, type GetImageUrlOptions, type Map, type MapResolution, type MapSpawn, type Move, type MoveSlotId, type Neutral, type Pokemon, type PokemonImages, type PokemonStats, Tag, getActivePokemons, getImageUrl, getMapImageUrl, getNeutralById, getNeutralImageUrl, getPokemonByDex, getPokemonByName, getPokemonBySlug, getPokemonSlug, getPokemonsByBattleType, getPokemonsByTag, getSpawnsByMap, maps, moves, neutrals, pokemons, spawns };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { Locale, getMapDescription, getMapName, getPokemonName } from './i18n/index.js';
+export { Locale, getMapDescription, getMapName, getNeutralName, getPokemonName, getSpawnInfo, getSpawnInfoForSpawn } from './i18n/index.js';
 
 /**
  * Battle role in Pokémon Unite (Attacker, Defender, etc.).
@@ -87,6 +87,30 @@ interface Map {
     /** Optional description. */
     description?: string;
 }
+/** Wild/neutral Pokémon or item that can spawn on a map. */
+interface Neutral {
+    id: string;
+    /** Image path (relative to package root or baseUrl). */
+    image: string;
+    /** Display name in English (use getNeutralName for other locales). */
+    name: string;
+    /** Pokédex number (omit for non-Pokémon e.g. berries). */
+    dex?: number;
+}
+/** A single spawn point on a map, linked to a neutral by neutralId. */
+interface MapSpawn {
+    mapId: string;
+    neutralId: string;
+    left: string;
+    top: string;
+    spawnTime: string;
+    respawnTime: number;
+    permanentDelete: boolean;
+    /** Optional HTML description (default locale). Use getSpawnInfo for i18n). */
+    info?: string;
+    /** Optional i18n key for info (spawn.info.<key>). When set, getSpawnInfo uses it. */
+    infoKey?: string;
+}
 
 declare const pokemons: Array<Pokemon>;
 
@@ -94,6 +118,10 @@ declare const moves: Move[];
 
 declare const maps: Map[];
 
+declare const neutrals: Neutral[];
+
+declare const spawns: MapSpawn[];
+
 interface GetImageUrlOptions {
     /** Base URL for assets (e.g. CDN). No trailing slash. */
     baseUrl?: string;
@@ -108,14 +136,28 @@ declare function getImageUrl(pokemon: Pokemon, imageKey: keyof PokemonImages, op
  * Falls back to map.image when resolution is omitted or not available.
  */
 declare function getMapImageUrl(map: Map, resolution?: MapResolution, options?: GetImageUrlOptions): string;
+/**
+ * Returns spawns for a given map id (e.g. "map-groudon", "map-kyogre", "map-rayquaza").
+ */
+declare function getSpawnsByMap(mapId: string): MapSpawn[];
+/**
+ * Returns the neutral by id, or undefined if not found.
+ */
+declare function getNeutralById(id: string): Neutral | undefined;
+/**
+ * Returns the image URL for a neutral (wild Pokémon or item).
+ */
+declare function getNeutralImageUrl(neutral: Neutral, options?: GetImageUrlOptions): string;
 declare function getPokemonByName(name: string): Pokemon | undefined;
 declare function getPokemonByDex(dex: number): Pokemon | undefined;
 /**
  * Slug from roster image: "pokemons/roster-venusaur.png" -> "venusaur"
+ * Use this slug with getPokemonName(id, locale) for i18n.
  */
+declare function getPokemonSlug(pokemon: Pokemon): string;
 declare function getPokemonBySlug(slug: string): Pokemon | undefined;
 declare function getPokemonsByBattleType(battleType: BattleType): Pokemon[];
 declare function getPokemonsByTag(tag: Tag): Pokemon[];
 declare function getActivePokemons(): Pokemon[];
 
-export { BattleType, type GetImageUrlOptions, type Map, type MapResolution, type Move, type MoveSlotId, type Pokemon, type PokemonImages, type PokemonStats, Tag, getActivePokemons, getImageUrl, getMapImageUrl, getPokemonByDex, getPokemonByName, getPokemonBySlug, getPokemonsByBattleType, getPokemonsByTag, maps, moves, pokemons };
+export { BattleType, type GetImageUrlOptions, type Map, type MapResolution, type MapSpawn, type Move, type MoveSlotId, type Neutral, type Pokemon, type PokemonImages, type PokemonStats, Tag, getActivePokemons, getImageUrl, getMapImageUrl, getNeutralById, getNeutralImageUrl, getPokemonByDex, getPokemonByName, getPokemonBySlug, getPokemonSlug, getPokemonsByBattleType, getPokemonsByTag, getSpawnsByMap, maps, moves, neutrals, pokemons, spawns };