koishi-plugin-warframe 1.15.1 → 1.16.1

package/README.md

@@ -58,9 +58,11 @@ Toolkit for Warframe. Provides Warframe Market prices, fissures, arbitrations, r
 
 | Command        | Arguments                                                    | Aliases                         | Description                                                                                                                                                                                     |
 | -------------- | ------------------------------------------------------------ | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `riven`        | `<img:image>`                                                |                                 | Analyze riven stats from a screenshot using OCR.                                                                                                                                                |
+| `riven`        | `<img:image>`                                                |                                 | Analyze traditional and spliced riven stats from a screenshot using OCR. Kitguns require `-v primary` or `-v secondary`.                                                                                                                                                |
 | `riven-weekly` | `[minPrice:number]`                                          | `weeklyriven`, `周紫卡`, `周卡` | Query weekly high-value riven reference (unrolled median prices).                                                                                                                               |
-| `riven-stat`   | `<weaponType:string> <statType:string> <disposition:number>` | `rivenstat`, `紫卡数值`         | Query riven stat ranges by weapon type, stat type, and disposition.<br>Weapon types: 步枪(rifle), 手枪(pistol), 霰弹枪(shotgun), 近战(melee), Archwing枪械(archgun)<br>Stat types: 2, 3, 21, 31 |
+| `riven-stat`   | `<weaponType:string> <statType:string> <disposition:number>` | `rivenstat`, `紫卡数值`         | Query riven stat ranges by weapon type, stat type, and disposition.<br>Weapon types: 步枪(rifle), 手枪(pistol), 霰弹枪(shotgun), 近战(melee), Archwing枪械(archgun), Kitgun(组合枪), Zaw(组合近战)<br>Stat types: 2, 3, 21, 31 |
+
+Riven calculations use a bundled official Public Export snapshot. See [data sources and refresh instructions](docs/riven-data.md).
 
 ### Kuva/Tenet/Coda (In Development)
 

package/lib/index.d.ts

@@ -34,7 +34,7 @@ declare module "warframe/types/ocr" {
     }
 }
 declare module "warframe/types/warframe-result" {
-    export const warframeErrorCodes: readonly ["common.fetchFailed", "relic.invalidName", "relic.dataLoading", "relic.notFound", "arbitration.invalidDayRange", "bounty.unavailable", "invasion.unavailable", "alert.unavailable", "event.unavailable", "calendar.unavailable", "steelEssence.unavailable", "nightwave.unavailable", "sortie.unavailable", "voidTrader.drifting", "voidTrader.arriving", "riven.imageFetchFailed", "riven.imageParseFailed", "riven.weaponNotFound", "riven.dispositionError", "riven.weaponTypeError", "riven.statTypeError", "wfm.inputItemName", "wfm.itemNotFound", "wfm.itemAmbiguous", "wfm.orderFetchFailed", "wfm.noOnlineSeller", "wfm.rivenWeaponNotFound", "wfm.rivenOrderFetchFailed", "wfm.noOnlineRivenSeller", "miscs.hotRiven.noData", "miscs.hotRiven.fetchFailed"];
+    export const warframeErrorCodes: readonly ["common.fetchFailed", "relic.invalidName", "relic.dataLoading", "relic.notFound", "arbitration.invalidDayRange", "bounty.unavailable", "invasion.unavailable", "alert.unavailable", "event.unavailable", "calendar.unavailable", "steelEssence.unavailable", "nightwave.unavailable", "sortie.unavailable", "voidTrader.drifting", "voidTrader.arriving", "riven.imageFetchFailed", "riven.imageParseFailed", "riven.weaponNotFound", "riven.dispositionError", "riven.weaponTypeError", "riven.statTypeError", "riven.unverifiedStat", "riven.variantRequired", "riven.variantError", "wfm.inputItemName", "wfm.itemNotFound", "wfm.itemAmbiguous", "wfm.orderFetchFailed", "wfm.noOnlineSeller", "wfm.rivenWeaponNotFound", "wfm.rivenOrderFetchFailed", "wfm.noOnlineRivenSeller", "miscs.hotRiven.noData", "miscs.hotRiven.fetchFailed"];
     export type WarframeErrorCode = typeof warframeErrorCodes[number];
     export type WarframeErrorParams = Record<string, string | number>;
     export interface WarframeError {
@@ -472,10 +472,59 @@ declare module "warframe/types/wfm" {
         };
     };
 }
+declare module "warframe/types/wf/riven-export" {
+    export interface RivenExportEntry {
+        tag: string;
+        prefixTag?: string;
+        suffixTag?: string;
+        upgradeValues: {
+            value: number;
+            locTag?: string;
+            reverseValueSymbol?: boolean;
+        }[];
+    }
+    export interface RivenExportDefinition {
+        uniqueName: string;
+        upgradeEntries: RivenExportEntry[];
+    }
+    export interface RivenExportWeapon {
+        uniqueName: string;
+        name: string;
+        productCategory: string;
+        omegaAttenuation: number;
+        primeOmegaAttenuation?: number;
+        slot?: number;
+    }
+    export interface RivenPublicExport {
+        schemaVersion: number;
+        downloadedAt: string;
+        sources: Record<string, {
+            url: string;
+            sha256: string;
+            bytes: number;
+        }>;
+        upgrades: RivenExportDefinition[];
+        upgradesZh: RivenExportDefinition[];
+        weapons: RivenExportWeapon[];
+        weaponNamesZh: Record<string, string>;
+    }
+}
 declare module "warframe/types/wf/riven" {
-    import type { IWeapon } from 'warframe-public-export-plus';
     import type { RivenAttributeUnit } from "warframe/types/wfm";
-    export type RivenWeaponType = 'Rifle' | 'Shotgun' | 'Pistol' | 'Archgun' | 'Melee';
+    import type { RivenExportWeapon } from "warframe/types/wf/riven-export";
+    export type RivenWeaponType = 'Rifle' | 'Shotgun' | 'Pistol' | 'Archgun' | 'Melee' | 'Kitgun' | 'Zaw';
+    export interface RivenCalculationAttribute {
+        gameRef?: string;
+        unit?: RivenAttributeUnit;
+        i18n?: {
+            'en'?: {
+                name?: string;
+            };
+            'zh-hans'?: {
+                name?: string;
+            };
+        };
+    }
     export type RivenStatCountType = '31' | '2' | '21' | '3';
     export interface RivenStatFixFactor {
         buffFactor: number;
@@ -493,6 +542,7 @@ declare module "warframe/types/wf/riven" {
         min: number;
     }
     export interface RivenStatAnalyzeResult {
+        notes?: string[];
         name: string;
         disposition: number;
         buffs: RivenStatAnalyzsis[];
@@ -509,9 +559,10 @@ declare module "warframe/types/wf/riven" {
             texture: string;
             riventype: string;
         };
-        weapon: IWeapon;
+        weapon: RivenExportWeapon;
     }
     export interface RivenStatResult {
+        notes?: string[];
         positive: Record<string, {
             name: string;
             max: number;
@@ -716,7 +767,7 @@ declare module "warframe/services/miscs-service" {
     export function getHotRivenWeapons(): Promise<WarframeResult<RivenWeaponItem[]>>;
 }
 declare module "warframe/assets/index" {
-    import type { RivenWeaponDisposition } from "warframe/types/index";
+    import type { RivenPublicExport } from "warframe/types/wf/riven-export";
     export interface BaroParsedItem {
         name: string;
         last: string;
@@ -724,10 +775,7 @@ declare module "warframe/assets/index" {
     }
     export type ArbyRewards = Record<string, number>;
     export const incarnons: string[][], warframes: string[][];
-    export const rivenAttrValues: Record<string, Record<string, number>>;
-    export const rivenCalc: {
-        weapons: RivenWeaponDisposition["calc"][];
-    };
+    export const rivenPublicExport: RivenPublicExport;
     export const dictEnExtra: Record<string, string>;
     export const dictZhExtra: Record<string, string>;
     export const arbitrationScheduleText: string;
@@ -970,15 +1018,37 @@ declare module "warframe/services/wf-service/wf-service.relic" {
     import type { Relic, WarframeResult } from "warframe/types/index";
     export function getRelic(input: string): Promise<WarframeResult<Relic>>;
 }
+declare module "warframe/infrastructure/wf/riven-export-adapter" {
+    import type { RivenCalculationAttribute, RivenWeaponType } from "warframe/types/wf/riven";
+    import type { RivenExportDefinition } from "warframe/types/wf/riven-export";
+    import type { RivenAttributeUnit } from "warframe/types/wfm";
+    export const rivenDefinitionTypes: Record<string, RivenWeaponType>;
+    export interface RivenCalculationStat extends RivenCalculationAttribute {
+        gameRef: string;
+        key: string;
+        name: string;
+        englishName: string;
+        baseValue: number;
+        unit: RivenAttributeUnit;
+        spliced: boolean;
+        canBeBuff: boolean;
+        canBeCurse: boolean;
+        verified: boolean;
+        aliases: string[];
+    }
+    export function cleanRivenTemplate(template: string): string | undefined;
+    export function adaptRivenDefinitions(definitions: RivenExportDefinition[]): Record<string, RivenCalculationStat[]>;
+}
 declare module "warframe/data/wf/rivenBaseValues" {
     export type RivenAttrValueDict = Record<string, Record<string, number>>;
-    export function buildRivenAttrValueDict(source: RivenAttrValueDict): RivenAttrValueDict;
+    export const rivenStatsByType: Record<string, import("warframe/infrastructure/wf/riven-export-adapter").RivenCalculationStat[]>;
+    export const rivenAttributes: import("warframe/infrastructure/wf/riven-export-adapter").RivenCalculationStat[];
     export const rivenAttrValueDict: RivenAttrValueDict;
 }
 declare module "warframe/data/wf/rivenDisposition" {
-    import type { IWeapon } from 'warframe-public-export-plus';
     import type { RivenWeaponDisposition } from "warframe/types/index";
-    export function buildWeaponRivenDispositionDict(calcWeapons: RivenWeaponDisposition['calc'][], exportWeapons: Record<string, IWeapon>, dictEn: Record<string, string>, dictZh: Record<string, string>): Record<string, RivenWeaponDisposition>;
+    import type { RivenExportWeapon } from "warframe/types/wf/riven-export";
+    export function buildWeaponRivenDispositionDict(weapons: RivenExportWeapon[], namesZh: Record<string, string>, types: Record<string, string>): Record<string, RivenWeaponDisposition>;
     export const weaponRivenDispositionDict: Record<string, RivenWeaponDisposition>;
 }
 declare module "warframe/data/wf/rivenStatData" {
@@ -1074,23 +1144,6 @@ declare module "warframe/infrastructure/wfm-client" {
         setAccessToken: (token: string | undefined) => void;
     };
 }
-declare module "warframe/data/wfm/globalRivenAttribute" {
-    import type { AsyncCache, RivenAttribute } from "warframe/types/index";
-    export function globalRivenAttributeFactory(rivenAttributeData?: RivenAttribute[]): Promise<{
-        globalRivenAttributeList: RivenAttribute[];
-        globalRivenAttributeDict: Record<string, RivenAttribute>;
-    }>;
-    export let globalRivenAttribute: AsyncCache<{
-        globalRivenAttributeList: RivenAttribute[];
-        globalRivenAttributeDict: Record<string, RivenAttribute>;
-    }>;
-    export function overrideGlobalRivenAttribute(cache: AsyncCache<{
-        globalRivenAttributeList: RivenAttribute[];
-        globalRivenAttributeDict: {
-            [key: string]: RivenAttribute;
-        };
-    }>): void;
-}
 declare module "warframe/data/wfm/globalRivenItem" {
     import type { AsyncCache, RivenItem } from "warframe/types/index";
     export interface GlobalRivenItemWordPrefixCandidate {
@@ -1123,9 +1176,10 @@ declare module "warframe/infrastructure/ocr-api" {
 }
 declare module "warframe/services/wf-service/wf-service.riven" {
     import type { WeeklyRiven } from 'warframe-weekly-rivens';
-    import type { OcrAPISecret, RivenAttribute, RivenStatAnalyzeResult, RivenStatResult, WarframeResult } from "warframe/types/index";
+    import type { OcrAPISecret, RivenStatAnalyzeResult, RivenStatResult, WarframeResult } from "warframe/types/index";
+    import type { RivenCalculationAttribute } from "warframe/types/wf/riven";
     import { weaponRivenDispositionDict } from "warframe/data/wf/rivenDisposition";
-    export function getAnalyzedRiven(secret: OcrAPISecret, url: string): Promise<WarframeResult<RivenStatAnalyzeResult>>;
+    export function getAnalyzedRiven(secret: OcrAPISecret, url: string, variant?: string): Promise<WarframeResult<RivenStatAnalyzeResult>>;
     export function filterWeeklyRivens(data: WeeklyRiven[], minPrice: number, minPop?: number): WeeklyRiven[];
     export function getWeeklyRivens(minPrice: number): Promise<WeeklyRiven[]>;
     export function getStaticRivenStats(weaponType: string, statType: string, disposition: number): Promise<WarframeResult<RivenStatResult>>;
@@ -1133,7 +1187,7 @@ declare module "warframe/services/wf-service/wf-service.riven" {
     export function parseOCRResult(ocrResult: string[]): Promise<{
         name: string;
         attributes: {
-            attr: RivenAttribute;
+            attr: RivenCalculationAttribute;
             value: number;
             prefix: string;
         }[];
@@ -1141,11 +1195,11 @@ declare module "warframe/services/wf-service/wf-service.riven" {
     export function analyzeRivenStat(parseResult: {
         name: string;
         attributes: {
-            attr: RivenAttribute;
+            attr: RivenCalculationAttribute;
             value: number;
             prefix: string;
         }[];
-    }): WarframeResult<RivenStatAnalyzeResult>;
+    }, variant?: string): WarframeResult<RivenStatAnalyzeResult>;
 }
 declare module "warframe/data/wf/sortie" {
     export function getSortieModeName(): string;
@@ -1311,6 +1365,23 @@ declare module "warframe/data/wfm/globalDucatnator" {
     export let globalDucatnatorIDDict: AsyncCache<Record<string, Ducatnator> | undefined>;
     export function overrideGlobalDucatnatorIDDict(cache: AsyncCache<Record<string, Ducatnator> | undefined>): void;
 }
+declare module "warframe/data/wfm/globalRivenAttribute" {
+    import type { AsyncCache, RivenAttribute } from "warframe/types/index";
+    export function globalRivenAttributeFactory(rivenAttributeData?: RivenAttribute[]): Promise<{
+        globalRivenAttributeList: RivenAttribute[];
+        globalRivenAttributeDict: Record<string, RivenAttribute>;
+    }>;
+    export let globalRivenAttribute: AsyncCache<{
+        globalRivenAttributeList: RivenAttribute[];
+        globalRivenAttributeDict: Record<string, RivenAttribute>;
+    }>;
+    export function overrideGlobalRivenAttribute(cache: AsyncCache<{
+        globalRivenAttributeList: RivenAttribute[];
+        globalRivenAttributeDict: {
+            [key: string]: RivenAttribute;
+        };
+    }>): void;
+}
 declare module "warframe/services/wfm-service/wfm-service.riven-item-matcher" {
     import type { GlobalRivenItemWordPrefixCandidate } from "warframe/data/wfm/globalRivenItem";
     import type { RivenItem } from "warframe/types/index";
@@ -1433,6 +1504,9 @@ declare module "i18n" {
         readonly 'riven.dispositionError': "裂罅倾向错误";
         readonly 'riven.weaponTypeError': "武器类型错误";
         readonly 'riven.statTypeError': "词条类型错误";
+        readonly 'riven.unverifiedStat': "{stat}的显示换算尚未确认，暂不提供数值分析。";
+        readonly 'riven.variantRequired': "组合枪的主副武器倾向不同，请使用 riven -v primary 或 riven -v secondary 指定形态。";
+        readonly 'riven.variantError': "组合枪形态应为 primary（主武器）或 secondary（副武器）。";
         readonly 'riven.invalidParams': "请输入正确参数";
         readonly 'riven.noWeeklyData': "没有找到符合条件的紫卡参考数据";
         readonly 'wfm.inputItemName': "请输入物品名称";
@@ -1520,7 +1594,9 @@ declare module "commands/wf" {
         steelPathFissureCommand: (_action: Argv) => Promise<string>;
         railjackFissureCommand: (_action: Argv) => Promise<string>;
         relicCommand: (_action: Argv, input: string) => Promise<string>;
-        rivenCommand: (_action: Argv, input: Dict) => Promise<string>;
+        rivenCommand: (_action: Argv<never, never, unknown[], {
+            variant?: string;
+        }>, input: Dict) => Promise<string>;
         rivenStatCommand: (_action: Argv, weaponType: string, statType: string, disposition: number) => Promise<string>;
         weeklyCommand: (_action: Argv) => Promise<string>;
         nightwaveCommand: (_action: Argv) => Promise<string>;