@wfcd/relics 2.0.29 → 2.0.31

package/dist/index.d.cts

@@ -1,17 +1,90 @@
 //#endregion
 //#region src/Types.d.ts
-interface WarframeMarketRoot {
-  data: Array<WarframeMarketItem>;
+type Rarity = 'Common' | 'Legendary' | 'Rare' | 'Uncommon';
+interface TitaniaRelic {
+  /**
+   * Drop Locations for the relics
+   */
+  locations: TitaniaRelicLocation[];
+  /**
+   * Relic Combined Name (Ex: Axi A1)
+   */
+  name: string;
+  /**
+   * Relic Rewards when opened
+   */
+  rewards: TitaniaRelicReward[];
+  /** unique name for corresponding warframe-items Item */
+  uniqueName: string;
+  /**
+   * Relic Vault Information
+   */
+  vaultInfo: TitaniaRelicVaultedInfo;
+  /**
+   * Warframe Market Information
+   *  undefined for untradable
+   */
+  warframeMarket?: TitaniaWFMInfo;
 }
-interface WarframeMarketItem {
+interface TitaniaRelicLocation {
   /**
-   * WFM Item ID
+   * Dropchance in %
+   */
+  chance: number;
+  /** Location Info $planet-$node (Ex: Eris - Phalan) */
+  location: string;
+  /**
+   * Rarity (Uncommon, Rare ?)
+   */
+  rarity: Rarity;
+}
+interface TitaniaRelicReward {
+  /**
+   * Reward Drop Chance in %
+   */
+  chance: number;
+  /**
+   * Item Information
+   */
+  item: TitaniaRelicRewardItem;
+  /**
+   * Relic Rarity (Uncommon,Rare ?)
+   */
+  rarity: 'Rare' | 'Uncommon';
+}
+interface TitaniaRelicRewardItem {
+  /**
+   * Item Name
+   */
+  name: string;
+  /** unique name for corresponding warframe-items Item */
+  uniqueName: string;
+  /**
+   * WarframeMarket Info
+   */
+  warframeMarket?: TitaniaWFMInfo;
+}
+interface TitaniaRelicVaultedInfo {
+  /**
+   * If the relic is vaulted
+   */
+  vaulted: boolean;
+}
+interface TitaniaWFMInfo {
+  /**
+   * Warframe Market ID
    */
   id: string;
   /**
-   * Url name for querying WFM
+   * Warframe market URL parameter
    */
-  slug: string;
+  urlName: string;
+}
+interface WarframeMarketItem {
+  /**
+   * Unique reference name (Lotus path)
+   */
+  gameRef: string;
   /**
    * WFM language object
    */
@@ -30,58 +103,29 @@ interface WarframeMarketItem {
       thumb: string;
     };
   };
-}
-interface WFCDRelic {
   /**
-   * Relic Tier (Axi, Neo, etc.)
-   */
-  tier: string;
-  /**
-   * Relic Name (A1, A10, etc.)
-   */
-  relicName: string;
-  /**
-   * Relic Refinement state
-   */
-  state: 'Intact' | 'Exceptional' | 'Flawless' | 'Radiant';
-  /**
-   * Relic Rewards
+   * WFM Item ID
    */
-  rewards: Array<WFCDRelicReward>;
+  id: string;
   /**
-   * Internal WFCD id
+   * Url name for querying WFM
    */
-  _id: string;
+  slug: string;
 }
-interface WFCDRelicReward {
-  /**
-   * Dropped Item name
-   */
-  itemName: string;
-  /**
-   * Dropchance Rarity (Uncommon/Rare ?)
-   */
-  rarity: 'Uncommon' | 'Rare';
-  /**
-   * Actual Dropchance in %
-   */
-  chance: number;
-  /**
-   * Internal ID
-   */
-  _id: string;
+interface WarframeMarketRoot {
+  data: WarframeMarketItem[];
 }
 interface WFCDItem {
+  /**
+   * Item Drop Location
+   */
+  drops?: WFCDItemDropLocation[];
   /**
    * Item Name
    */
   name: string;
   /** Unique identifying name */
   uniqueName: string;
-  /**
-   * Item Drop Location
-   */
-  drops?: Array<WFCDItemDropLocation>;
 }
 interface WFCDItemDropLocation {
   /**
@@ -101,103 +145,75 @@ interface WFCDItemDropLocation {
    */
   type: string;
 }
-interface TitaniaRelic {
+interface WFCDRelic {
   /**
-   * Relic Combined Name (Ex: Axi A1)
+   * Internal WFCD id
    */
-  name: string;
+  _id: string;
   /**
-   * Relic Rewards when opened
+   * Relic Name (A1, A10, etc.)
    */
-  rewards: Array<TitaniaRelicReward>;
+  relicName: string;
   /**
-   * Drop Locations for the relics
+   * Relic Rewards
    */
-  locations: Array<TitaniaRelicLocation>;
+  rewards: WFCDRelicReward[];
   /**
-   * Warframe Market Information
-   *  undefined for untradable
+   * Relic Refinement state
    */
-  warframeMarket?: TitaniaWFMInfo;
+  state: 'Exceptional' | 'Flawless' | 'Intact' | 'Radiant';
   /**
-   * Relic Vault Information
+   * Relic Tier (Axi, Neo, etc.)
    */
-  vaultInfo: TitaniaRelicVaultedInfo;
-  /** unique name for corresponding warframe-items Item */
-  uniqueName: string;
+  tier: string;
 }
-interface TitaniaRelicReward {
+interface WFCDRelicReward {
   /**
-   * Relic Rarity (Uncommon,Rare ?)
+   * Internal ID
    */
-  rarity: 'Uncommon' | 'Rare';
+  _id: string;
   /**
-   * Reward Drop Chance in %
+   * Actual Dropchance in %
    */
   chance: number;
   /**
-   * Item Information
+   * Dropped Item name
    */
-  item: TitaniaRelicRewardItem;
-}
-interface TitaniaRelicRewardItem {
+  itemName: string;
   /**
-   * Item Name
+   * Dropchance Rarity (Uncommon/Rare ?)
    */
+  rarity: 'Rare' | 'Uncommon';
+}
+interface WFCDSparseComponent {
   name: string;
-  /** unique name for corresponding warframe-items Item */
   uniqueName: string;
-  /**
-   * WarframeMarket Info
-   */
-  warframeMarket?: TitaniaWFMInfo;
 }
-type Rarity = 'Uncommon' | 'Rare' | 'Legendary' | 'Common';
-interface TitaniaRelicLocation {
-  /** Location Info $planet-$node (Ex: Eris - Phalan) */
-  location: string;
-  /**
-   * Rarity (Uncommon, Rare ?)
-   */
-  rarity: Rarity;
-  /**
-   * Dropchance in %
-   */
-  chance: number;
-}
-interface TitaniaWFMInfo {
-  /**
-   * Warframe Market ID
-   */
-  id: string;
-  /**
-   * Warframe market URL parameter
-   */
-  urlName: string;
-}
-interface TitaniaRelicVaultedInfo {
-  /**
-   * If the relic is vaulted
-   */
-  vaulted: boolean;
+/** Sparse warframestat item (name + uniqueName, optional components) */
+interface WFCDSparseItem {
+  components?: WFCDSparseComponent[];
+  name: string;
+  uniqueName: string;
 }
 //#endregion
 //#region src/Generator.d.ts
 declare class Generator {
-  relicsRaw: Array<WFCDRelic> | undefined;
-  wfcdItems: Array<WFCDItem> | undefined;
-  wfmItems: WarframeMarketRoot | undefined;
-  relics: Array<TitaniaRelic>;
+  /** Lowercase item name → uniqueName from sparse warframestat index (+ Blueprint follow-ups) */
+  itemUniqueNames: Map<string, string>;
+  relics: TitaniaRelic[];
+  relicsRaw: undefined | WFCDRelic[];
+  wfcdItems: undefined | WFCDItem[];
+  wfmItems: undefined | WarframeMarketRoot;
   constructor();
-  /**
-   * Main function to fetch and generate the relic data
-   * @returns {Promise<Array<TitaniaRelic>>} The Relics data array
-   */
-  generate(): Promise<Array<TitaniaRelic>>;
   /**
    * Fetches all required data from WFCD and WFM.
    */
   fetchRawData(): Promise<void>;
+  /**
+   * Main function to fetch and generate the relic data
+   * @returns {Promise<Array<TitaniaRelic>>} The Relics data array
+   */
+  generate(): Promise<TitaniaRelic[]>;
   /**
    * Generates the relic data
    *  uses WFCD/warframe-drop-data to check what relics exist,
@@ -211,6 +227,16 @@ declare class Generator {
    * @param {boolean} generateMin True if a minified json should be generated too. Default: true
    */
   writeData(dataDir?: string, fileName?: string, generateMin?: boolean): Promise<void>;
+  /**
+   * Fetch a single warframestat item by name with components for Blueprint resolution.
+   * @param {string} name Item display name
+   * @returns {Promise<WFCDSparseItem|undefined>} Item or undefined on failure
+   */
+  private fetchItemByName;
+  /**
+   * Filters WFCD's relic data to only include Intact variants, since we just need the base.
+   */
+  private filterWFCDRelics;
   /**
    * Generates a single relic from all available data
    * @param {WFCDRelic} rawRelic relic to pull Titania data from
@@ -218,16 +244,22 @@ declare class Generator {
    */
   private generateTitaniaRelic;
   /**
-   * Filters WFCD's relic data to only include Intact variants, since we just need the base.
+   * Index sparse warframestat items by lowercase name, preferring /Lotus/Types/ paths.
+   * @param {Array<WFCDSparseItem>} items Sparse item list from warframestat
    */
-  private filterWFCDRelics;
+  private indexSparseItems;
+  /**
+   * For reward names missing WFM, resolve uniqueNames from sparse index.
+   * Blueprint-suffixed names need a parent item fetch for the Blueprint component.
+   */
+  private resolveSpecialRewardUniqueNames;
 }
 //#endregion
 //#region src/VersionManager.d.ts
 declare class VersionManager {
+  hashPath: string;
   versionPath: string;
   versionRawPath: string;
-  hashPath: string;
   /**
    * Creates a new VersionManager instance.
    * @param {string} dataDir Folder to write version information to.
@@ -245,4 +277,4 @@ declare class VersionManager {
   writeVersion(timestamp: number): Promise<void>;
 }
 //#endregion
-export { Generator, Rarity, TitaniaRelic, TitaniaRelicLocation, TitaniaRelicReward, TitaniaRelicRewardItem, TitaniaRelicVaultedInfo, TitaniaWFMInfo, VersionManager, WFCDItem, WFCDItemDropLocation, WFCDRelic, WFCDRelicReward, WarframeMarketItem, WarframeMarketRoot };
+export { Generator, Rarity, TitaniaRelic, TitaniaRelicLocation, TitaniaRelicReward, TitaniaRelicRewardItem, TitaniaRelicVaultedInfo, TitaniaWFMInfo, VersionManager, WFCDItem, WFCDItemDropLocation, WFCDRelic, WFCDRelicReward, WFCDSparseComponent, WFCDSparseItem, WarframeMarketItem, WarframeMarketRoot };