@genshin-db/tcg/types/folders/weapons.d.ts

Genshin Impact Trading Card Game JSON data with an API for searching the data in all in-game languages.

declare module "@genshin-db/tcg" {
	export interface Weapon {
		id: number;
		name: string;
		dupealias?: string; // Prized Isshin Blade (which isn't obtainable)

		description: string;
		descriptionRaw: string;

		weaponType: 'WEAPON_BOW' | 'WEAPON_CATALYST' | 'WEAPON_CLAYMORE' | 'WEAPON_POLE' | 'WEAPON_SWORD_ONE_HAND'; // enum
		weaponText: string; // translated

		rarity: 1 | 2 | 3 | 4 | 5;
		story: string; // empty string if no story

		baseAtkValue: number; // not rounded
		mainStatType?: 'FIGHT_PROP_ATTACK_PERCENT' | 'FIGHT_PROP_CHARGE_EFFICIENCY' | 'FIGHT_PROP_CRITICAL' | 'FIGHT_PROP_CRITICAL_HURT' | 'FIGHT_PROP_DEFENSE_PERCENT' | 'FIGHT_PROP_ELEMENT_MASTERY' | 'FIGHT_PROP_HP_PERCENT' | 'FIGHT_PROP_PHYSICAL_ADD_HURT'; // enum. low rarity weapons dont have this
		mainStatText?: string; // translated. low rarity weapons dont have this
		baseStatText: string; // as shown in-game. low rarity weapons dont have this

		effectName?: string; // low rarity weapons dont have this
		effectTemplateRaw?: string; // low rarity weapons dont have this
		r1?: WeaponRefine; // for example dull blade doesn't have any refinement
		r2?: WeaponRefine;
		r3?: WeaponRefine;
		r4?: WeaponRefine;
		r5?: WeaponRefine;

		costs: {
			"ascend1": Items[];
			"ascend2": Items[];
			"ascend3": Items[];
			"ascend4": Items[];
			"ascend5"?: Items[]; // 1 and 2 star weapons only have 4 ascensions
			"ascend6"?: Items[]; // 1 and 2 star weapons only have 4 ascensions
		};
		images: {
			filename_icon: string;
			filename_awakenIcon: string;
			filename_gacha: string;
			mihoyo_icon?: string; // hoyolab. they're missing some images unfortunately.
			mihoyo_awakenIcon?: string; // hoyolab. they're missing some images unfortunately.
		};
		// url: { // deprecated
		// 	fandom: string;
		// };
		stats: StatFunction;
		version: string;
	}

	export interface WeaponRefine {
		description: string; // sanitized with removeColorHTML, replaceNonBreakSpace, removeHashtag, replaceGenderM
		values: string[];
	}

	//#endregion

	//#region WeaponMaterial
	//deprecated
	// export interface WeaponMaterial { // English only
	// 	name: string;
	// 	"2starname": string;
	// 	"3starname": string;
	// 	"4starname": string;
	// 	"5starname": string;
	// 	day: string[];
	// 	location: string;
	// 	region: string;
	// 	domainofforgery: string;
	// }
}