@blizzard-api/hs 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -1,10 +1,18 @@
 import { Locales, Resource } from '@blizzard-api/core';
 
+type GameMode$1 = 'arena' | 'battlegrounds' | 'classic' | 'constructed' | 'duels' | 'mercenaries' | 'standard';
+type SearchSortOption = `${SortOptions}:${SortDirection}`;
 type SortDirection = 'asc' | 'desc';
 type SortOptions = 'attack' | 'class' | 'dataAdded' | 'groupByClass' | 'health' | 'manaCost' | 'name';
-type SearchSortOption = `${SortOptions}:${SortDirection}`;
-type GameMode$1 = 'arena' | 'battlegrounds' | 'classic' | 'constructed' | 'duels' | 'mercenaries' | 'standard';
 
+interface CardBackSearchParameters {
+    cardBackCategory?: 'achieve' | 'base' | 'blizzard' | 'esports' | 'events' | 'fireside' | 'game_license' | 'golden' | 'heroes' | 'legend' | 'pre_purchase' | 'promotion' | 'season';
+    locale?: Locales;
+    page?: number;
+    pageSize?: number;
+    sort?: SearchSortOption;
+    textFilter?: string;
+}
 interface CardBackSearchResponse {
     cardBacks: Array<SingleCardBackSearchResponse>;
     cardCount: number;
@@ -19,26 +27,64 @@ interface SingleCardBackSearchResponse {
     sortCategory: number;
     text: Record<Locales, string> | string;
 }
-interface CardBackSearchParameters {
-    cardBackCategory?: 'achieve' | 'base' | 'blizzard' | 'esports' | 'events' | 'fireside' | 'game_license' | 'golden' | 'heroes' | 'legend' | 'pre_purchase' | 'promotion' | 'season';
-    locale?: Locales;
-    page?: number;
-    pageSize?: number;
-    sort?: SearchSortOption;
-    textFilter?: string;
-}
 
 declare function cardBackSearch(options: CardBackSearchParameters): Resource<CardBackSearchResponse, CardBackSearchParameters>;
 declare function fetchOneCardBack(id: string, locale?: Locales): Resource<SingleCardBackSearchResponse, {
     locale?: Locales;
 }>;
 
+interface BlizzardCardSearchParameters extends BaseSearchParameters {
+    attack?: string;
+    defaultMercenary?: string;
+    health?: string;
+    mercenaryId?: string;
+}
+interface CardSearchParameters extends BaseSearchParameters {
+    attack?: Array<number> | number;
+    defaultMercenary?: Array<number> | number;
+    health?: Array<number> | number;
+    mercenaryId?: Array<number> | number;
+}
 interface CardSearchResponse {
     cardCount: number;
     cards: Array<Card$1>;
     page: number;
     pageCount: number;
 }
+interface FetchOneCardResponse {
+    artistName: string;
+    attack: number;
+    cardSetId: number;
+    cardTypeId: number;
+    classId: number;
+    collectible: number;
+    cropImage: string;
+    flavorText: Record<Locales, string> | string;
+    health: number;
+    id: number;
+    image: Record<Locales, string> | string;
+    imageGold: Record<Locales, string> | string;
+    isZilliaxCosmeticModule: boolean;
+    isZilliaxFunctionalModule: boolean;
+    keywordIds: Array<number>;
+    manaCost: number;
+    multiClassIds: Array<number>;
+    name: Record<Locales, string> | string;
+    rarityId: number;
+    slug: string;
+    text: Record<Locales, string> | string;
+}
+interface BaseSearchParameters {
+    gameMode?: GameMode$1;
+    locale?: Locales;
+    mercenaryRole?: string;
+    minionType?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: 'attack:asc' | 'attack:desc' | 'health:asc' | 'health:desc' | 'name:asc' | 'name:desc' | 'tier:asc' | 'tier:desc';
+    textFilter?: string;
+    tier?: 1 | 2 | 3 | 4 | 5 | 6 | 'hero';
+}
 interface Card$1 {
     artistName: null | string;
     attack: number;
@@ -78,52 +124,6 @@ interface StatsByLevel {
     attack: number;
     health: number;
 }
-interface CardSearchParameters extends BaseSearchParameters {
-    attack?: Array<number> | number;
-    defaultMercenary?: Array<number> | number;
-    health?: Array<number> | number;
-    mercenaryId?: Array<number> | number;
-}
-interface BlizzardCardSearchParameters extends BaseSearchParameters {
-    attack?: string;
-    defaultMercenary?: string;
-    health?: string;
-    mercenaryId?: string;
-}
-interface BaseSearchParameters {
-    gameMode?: GameMode$1;
-    locale?: Locales;
-    mercenaryRole?: string;
-    minionType?: string;
-    page?: number;
-    pageSize?: number;
-    sort?: 'attack:asc' | 'attack:desc' | 'health:asc' | 'health:desc' | 'name:asc' | 'name:desc' | 'tier:asc' | 'tier:desc';
-    textFilter?: string;
-    tier?: 'hero' | 1 | 2 | 3 | 4 | 5 | 6;
-}
-interface FetchOneCardResponse {
-    artistName: string;
-    attack: number;
-    cardSetId: number;
-    cardTypeId: number;
-    classId: number;
-    collectible: number;
-    cropImage: string;
-    flavorText: Record<Locales, string> | string;
-    health: number;
-    id: number;
-    image: Record<Locales, string> | string;
-    imageGold: Record<Locales, string> | string;
-    isZilliaxCosmeticModule: boolean;
-    isZilliaxFunctionalModule: boolean;
-    keywordIds: Array<number>;
-    manaCost: number;
-    multiClassIds: Array<number>;
-    name: Record<Locales, string> | string;
-    rarityId: number;
-    slug: string;
-    text: Record<Locales, string> | string;
-}
 
 declare function cardSearch(options: CardSearchParameters): Resource<CardSearchResponse, BlizzardCardSearchParameters>;
 declare function fetchOneCard(id: string, options?: {
@@ -134,12 +134,6 @@ declare function fetchOneCard(id: string, options?: {
     locale?: Locales;
 }>;
 
-type DeckSearchParameters = {
-    code: string;
-} | {
-    hero?: string;
-    ids: string;
-};
 interface DeckResponse {
     cardCount: number;
     cards: Array<Card>;
@@ -150,6 +144,12 @@ interface DeckResponse {
     heroPower: Hero;
     version: number;
 }
+type DeckSearchParameters = {
+    code: string;
+} | {
+    hero?: string;
+    ids: string;
+};
 interface Card {
     armor?: number;
     artistName: string;
@@ -239,9 +239,15 @@ interface AllMetadataResponse {
     spellSchools: Array<GameMode>;
     types: Array<GameMode>;
 }
-interface GameMode extends NameId {
-    gameModes?: Array<number>;
+interface SpecificMetadataResponse extends NameId {
+    aliasSetIds?: Array<number>;
+    collectibleCount: number;
+    collectibleRevealedCount: number;
+    hyped: boolean;
+    nonCollectibleCount: number;
+    nonCollectibleRevealedCount: number;
     slug: string;
+    type: SetType;
 }
 interface Class {
     alternateHeroCardIds?: Array<number>;
@@ -251,6 +257,10 @@ interface Class {
     name: string;
     slug: string;
 }
+interface GameMode extends NameId {
+    gameModes?: Array<number>;
+    slug: string;
+}
 interface Keyword extends NameId {
     gameModes: Array<number>;
     refText: string;
@@ -262,17 +272,6 @@ interface Rarity extends NameId {
     dustValue: Array<null | number>;
     slug: string;
 }
-interface SetGroup {
-    cardSets: Array<string>;
-    icon?: string;
-    name: string;
-    slug: string;
-    standard?: boolean;
-    svg?: null | string;
-    year?: number;
-    yearRange?: string;
-}
-type SetType = '' | 'adventure' | 'base' | 'expansion';
 interface Set extends NameId {
     aliasSetIds?: Array<number>;
     collectibleCount: number;
@@ -283,16 +282,17 @@ interface Set extends NameId {
     slug: string;
     type: SetType;
 }
-interface SpecificMetadataResponse extends NameId {
-    aliasSetIds?: Array<number>;
-    collectibleCount: number;
-    collectibleRevealedCount: number;
-    hyped: boolean;
-    nonCollectibleCount: number;
-    nonCollectibleRevealedCount: number;
+interface SetGroup {
+    cardSets: Array<string>;
+    icon?: string;
+    name: string;
     slug: string;
-    type: SetType;
+    standard?: boolean;
+    svg?: null | string;
+    year?: number;
+    yearRange?: string;
 }
+type SetType = '' | 'adventure' | 'base' | 'expansion';
 
 declare function allMetadata(): Resource<AllMetadataResponse>;
 declare function specificMetadata(type: 'classes' | 'keywords' | 'minionTypes' | 'rarities' | 'setGroups' | 'sets' | 'types'): Resource<SpecificMetadataResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/hs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Hearthstone Blizzard API",
@@ -32,10 +32,10 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@blizzard-api/core": "2.0.0"
+    "@blizzard-api/core": "2.0.1"
   },
   "devDependencies": {
-    "@blizzard-api/core": "2.0.0"
+    "@blizzard-api/core": "2.0.1"
   },
   "scripts": {
     "build": "tsup",