@airbreather/mod-nodejs-types 0.0.1

package/hooks/spell.d.ts

@@ -0,0 +1,82 @@
+declare global {
+	interface Hooks {
+		['spell:calc-max-duration']: {
+			readonly aura: Acore.Aura;
+			maxDuration: number;
+		};
+		['spell:check-cast']: {
+			readonly spell: Acore.Spell;
+			readonly strict: boolean;
+			result: SpellCastResult;
+		};
+		['spell:can-prepare']: {
+			readonly spell: Acore.Spell;
+			__return: boolean;
+		};
+		['spell:can-scaling-everything']: {
+			readonly spell: Acore.Spell;
+			__return: boolean;
+		};
+		['spell:can-select-spec-talent']: {
+			readonly spell: Acore.Spell;
+			__return: boolean;
+		};
+		['spell:scale-aura-unit-add']: {
+			readonly spell: Acore.Spell;
+			readonly target: Acore.Unit;
+			readonly effectMask: SpellEffIndexMask;
+			readonly checkIfValid: boolean;
+			readonly implicit: boolean;
+			readonly auraScaleMask: SpellEffIndexMask;
+			// targetInfo: TargetInfo;
+		};
+		['spell:remove-aura-scale-targets']: {
+			readonly spell: Acore.Spell;
+			// targetInfo: TargetInfo;
+			readonly auraScaleMask: SpellEffIndexMask;
+			needErase: boolean;
+		};
+		['spell:before-aura-rank-for-level']: {
+			readonly spellInfo: Acore.SpellInfo;
+			// setting this is not working right now because of what looks like a bug in Acore.
+			latestSpellInfo: Acore.SpellInfo;
+			readonly level: number;
+		};
+		['spell:dummy-effect:game-object-target']: {
+			readonly caster: Acore.WorldObject;
+			readonly spellId: number;
+			readonly effIndex: SpellEffIndex;
+			readonly target: Acore.GameObject;
+		};
+		['spell:dummy-effect:creature-target']: {
+			readonly caster: Acore.WorldObject;
+			readonly spellId: number;
+			readonly effIndex: SpellEffIndex;
+			readonly target: Acore.Creature;
+		};
+		['spell:dummy-effect:item-target']: {
+			readonly caster: Acore.WorldObject;
+			readonly spellId: number;
+			readonly effIndex: SpellEffIndex;
+			readonly target: Acore.Item;
+		};
+		['spell:cast-cancel']: {
+			readonly spell: Acore.Spell;
+			readonly caster: Acore.Unit;
+			readonly spellInfo: Acore.SpellInfo;
+			readonly bySelf: boolean;
+		};
+		['spell:cast']: {
+			readonly spell: Acore.Spell;
+			readonly caster: Acore.Unit;
+			readonly spellInfo: Acore.SpellInfo;
+			readonly skipCheck: boolean;
+		};
+		['spell:prepare']: {
+			readonly spell: Acore.Spell;
+			readonly caster: Acore.Unit;
+			readonly spellInfo: Acore.SpellInfo;
+		};
+	}
+}
+export {};

package/hooks/ticket.d.ts

@@ -0,0 +1,10 @@
+declare global {
+	interface Hooks {
+		['ticket:create']: { readonly ticket: Acore.GmTicket; };
+		['ticket:update-last-change']: { readonly ticket: Acore.GmTicket; };
+		['ticket:close']: { readonly ticket: Acore.GmTicket; };
+		['ticket:status-update']: { readonly ticket: Acore.GmTicket; };
+		['ticket:resolve']: { readonly ticket: Acore.GmTicket; };
+	}
+}
+export {};

package/hooks/unit.d.ts

@@ -0,0 +1,116 @@
+declare global {
+	interface Hooks {
+		['unit:heal']: {
+			readonly healer: Acore.Unit;
+			readonly receiver: Acore.Unit;
+			amount: number;
+		};
+		['unit:damage']: {
+			readonly attacker: Acore.Unit;
+			readonly victim: Acore.Unit;
+			amount: number;
+		};
+		['unit:modify-periodic-damage-auras-tick']: {
+			readonly target: Acore.Unit;
+			readonly attacker: Acore.Unit;
+			amount: number;
+			readonly spellInfo: Acore.SpellInfo;
+		};
+		['unit:modify-melee-damage']: {
+			readonly target: Acore.Unit;
+			readonly attacker: Acore.Unit;
+			amount: number;
+		};
+		['unit:modify-spell-damage-taken']: {
+			readonly target: Acore.Unit;
+			readonly attacker: Acore.Unit;
+			amount: number;
+			readonly spellInfo: Acore.SpellInfo;
+		};
+		['unit:modify-heal-received']: {
+			readonly target: Acore.Unit;
+			readonly healer: Acore.Unit;
+			amount: number;
+			readonly spellInfo: Acore.SpellInfo;
+		};
+		['unit:deal-damage']: {
+			readonly attacker: Acore.Unit;
+			readonly victim: Acore.Unit;
+			readonly damage: number;
+			readonly damageType: DamageEffectType;
+			__return: number;
+		};
+		['unit:before-roll-melee-outcome-against']: {
+			readonly attacker: Acore.Unit;
+			readonly victim: Acore.Unit;
+			readonly attType: WeaponAttackType;
+			attackerMaxSkillValueForLevel: number;
+			victimMaxSkillValueForLevel: number;
+			attackerWeaponSkill: number;
+			victimDefenseSkill: number;
+			critChance: number;
+			missChance: number;
+			dodgeChance: number;
+			parryChance: number;
+			blockChance: number;
+		};
+		['unit:aura-apply']: {
+			readonly unit: Acore.Unit;
+			readonly aura: Acore.Aura;
+		};
+		['unit:aura-remove']: {
+			readonly unit: Acore.Unit;
+			readonly aurApp: Acore.AuraApplication;
+			readonly mode: AuraRemoveMode;
+		};
+		['unit:if-normal-reaction']: {
+			readonly unit: Acore.Unit;
+			readonly target: Acore.Unit;
+			repRank: ReputationRank;
+			__return: boolean;
+		};
+		['unit:can-set-phase-mask']: {
+			readonly unit: Acore.Unit;
+			readonly newPhaseMask: number;
+			readonly update: boolean;
+			__return: boolean;
+		};
+		['unit:should-track-values-update-pos-by-index']: {
+			readonly unit: Acore.Unit;
+			readonly updateType: OBJECT_UPDATE_TYPE;
+			readonly index: number;
+			__return: boolean;
+		};
+		['unit:patch-values-update']: {
+			readonly unit: Acore.Unit;
+			// valuesUpdateBuf: Acore.ByteBuffer;
+			// posPointers: Acore.BuildValuesCachePosPointers;
+			readonly target: Acore.Player;
+		};
+		['unit:update']: {
+			readonly unit: Acore.Unit;
+			readonly diff: Temporal.Duration;
+		};
+		['unit:display-id-change']: {
+			readonly unit: Acore.Unit;
+			readonly displayId: number;
+		};
+		['unit:enter-evade-mode']: {
+			readonly unit: Acore.Unit;
+			readonly evadeReason: EvadeReason;
+		};
+		['unit:enter-combat']: {
+			readonly unit: Acore.Unit;
+			readonly victim: Acore.Unit;
+		};
+		['unit:death']: {
+			readonly unit: Acore.Unit;
+			readonly killer: Acore.Unit | undefined;
+		};
+		['unit:set-shapeshift-form']: {
+			readonly unit: Acore.Unit;
+			readonly form: ShapeshiftForm;
+		};
+	}
+}
+export {};

package/hooks/vehicle.d.ts

@@ -0,0 +1,21 @@
+declare global {
+	interface Hooks {
+		['vehicle:install']: { readonly vehicle: Acore.Vehicle; };
+		['vehicle:uninstall']: { readonly vehicle: Acore.Vehicle; };
+		['vehicle:reset']: { readonly vehicle: Acore.Vehicle; };
+		['vehicle:install-accessory']: {
+			readonly vehicle: Acore.Vehicle;
+			readonly accessory: Acore.Creature;
+		};
+		['vehicle:add-passenger']: {
+			readonly vehicle: Acore.Vehicle;
+			readonly passenger: Acore.Unit;
+			readonly seatId: number;
+		};
+		['vehicle:remove-passenger']: {
+			readonly vehicle: Acore.Vehicle;
+			readonly passenger: Acore.Unit;
+		};
+	}
+}
+export {};

package/hooks/world-object.d.ts

@@ -0,0 +1,16 @@
+declare global {
+	interface Hooks {
+		['world-object:install']: { readonly obj: Acore.WorldObject; };
+		['world-object:create']: { readonly obj: Acore.WorldObject; };
+		['world-object:set-map']: {
+			readonly obj: Acore.WorldObject;
+			readonly map: Acore.ACMap;
+		};
+		['world-object:reset-map']: { readonly obj: Acore.WorldObject; };
+		['world-object:update']: {
+			readonly obj: Acore.WorldObject;
+			readonly diff: Temporal.Duration;
+		};
+	}
+}
+export {};

package/hooks/world.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	interface Hooks {
+		['world:startup']: object;
+		['world:shutdown']: object;
+	}
+}
+export {};

package/package.json

@@ -0,0 +1,37 @@
+{
+	"name": "@airbreather/mod-nodejs-types",
+	"version": "0.0.1",
+	"description": "Type declarations (only) for the mod-nodejs AzerothCore module.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/airbreather/mod-nodejs",
+		"directory": "typescript"
+	},
+	"license": "AGPL-3.0-only",
+	"contributors": [
+		{
+			"name": "airbreather"
+		}
+	],
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./index.d.ts",
+			"types": "./index.d.ts"
+		}
+	},
+	"types": "./index.d.ts",
+	"files": [
+		"./acore.d.ts",
+		"./classes",
+		"./enums",
+		"./hooks",
+		"./records"
+	],
+	"devDependencies": {
+		"eslint": "^10.8.0",
+		"eslint-plugin-package-json": "^1.6.2",
+		"typescript": "^7.0.2"
+	}
+}

package/records/AchievementEntry.d.ts

@@ -0,0 +1,14 @@
+declare global {
+	interface AchievementEntry {
+		id: number;
+		requiredFaction: number;
+		mapId: number;
+		name: string[];
+		categoryId: number;
+		points: number;
+		flags: AchievementFlags;
+		count: number;
+		refAchievement: number;
+	}
+}
+export {};

package/records/BattlegroundScore.d.ts

@@ -0,0 +1,58 @@
+declare global {
+	interface BattlegroundScoreBase {
+		playerGuid: ObjectGuidNative;
+		killingBlows: number;
+		damageDone: number;
+		healingDone: number;
+		deaths: number;
+		honorableKills: number;
+		bonusHonor: number;
+	}
+
+	interface BattlegroundScoreAB extends BattlegroundScoreBase {
+		type: 'AB';
+		basesAssaulted: number;
+		basesDefended: number;
+	}
+
+	interface BattlegroundScoreAV extends BattlegroundScoreBase {
+		type: 'AV';
+		graveyardsAssaulted: number;
+		graveyardsDefended: number;
+		towersAssaulted: number;
+		towersDefended: number;
+		minesCaptured: number;
+	}
+
+	interface BattlegroundScoreEY extends BattlegroundScoreBase {
+		type: 'EY';
+		flagCaptures: number;
+	}
+
+	interface BattlegroundScoreIC extends BattlegroundScoreBase {
+		type: 'IC';
+		basesAssaulted: number;
+		basesDefended: number;
+	}
+
+	interface BattlegroundScoreSA extends BattlegroundScoreBase {
+		type: 'SA';
+		demolishersDestroyed: number;
+		gatesDestroyed: number;
+	}
+
+	interface BattlegroundScoreWG extends BattlegroundScoreBase {
+		type: 'WG';
+		flagCaptures: number;
+		flagReturns: number;
+	}
+
+	type BattlegroundScore =
+		| BattlegroundScoreAB
+		| BattlegroundScoreAV
+		| BattlegroundScoreEY
+		| BattlegroundScoreIC
+		| BattlegroundScoreSA
+		| BattlegroundScoreWG;
+}
+export {};

package/records/Box.d.ts

@@ -0,0 +1,6 @@
+declare global {
+	interface Box<T> {
+		boxed: T;
+	}
+}
+export {};

package/records/ChaseAngle.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	type ChaseAngle =
+		| number
+		| { angle: number; tolerance?: number; }
+		;
+}
+export {};

package/records/ChaseRange.d.ts

@@ -0,0 +1,8 @@
+declare global {
+	type ChaseRange =
+		| number
+		| { minRange: number; maxRange: number; }
+		| { minRange: number; maxRange: number; minTolerance: number; maxTolerance: number }
+		;
+}
+export {};

package/records/CreatureModel.d.ts

@@ -0,0 +1,8 @@
+declare global {
+	interface CreatureModel {
+		creatureDisplayId: number;
+		displayScale: number;
+		probability: number;
+	}
+}
+export {};

package/records/CreatureMovementData.d.ts

@@ -0,0 +1,12 @@
+declare global {
+	interface CreatureMovementData {
+		ground: CreatureGroundMovementType;
+		flight: CreatureFlightMovementType;
+		swim: boolean;
+		rooted: boolean;
+		chase: CreatureChaseMovementType;
+		random: CreatureRandomMovementType;
+		interactionPauseTimer: Temporal.Instant;
+	}
+}
+export {};

package/records/GlyphPropertiesEntry.d.ts

@@ -0,0 +1,9 @@
+declare global {
+	interface GlyphPropertiesEntry {
+		id: number;
+		spellId: number;
+		typeFlags: number;
+		// spellIconID: number;                                      // GlyphIconId (SpellIcon.dbc)
+	}
+}
+export {};

package/records/GroupMember.d.ts

@@ -0,0 +1,9 @@
+declare global {
+	interface GroupMember {
+		guid: ObjectGuidNative;
+		name: string;
+		roles: LfgRoles;
+		flags: GroupMemberFlags;
+	}
+}
+export {};

package/records/GroupQueueInfo.d.ts

@@ -0,0 +1,22 @@
+declare global {
+	interface GroupQueueInfo {
+		players: ObjectGuidNative[];
+		teamId: TeamId;
+		realTeamID: TeamId; // TODO: consistent casing plz
+		bgTypeId: BattlegroundTypeId;
+		isRated: boolean;
+		arenaType: ArenaType;
+		arenaTeamId: number;
+		joinTime: number;
+		removeInviteTime: number;
+		isInvitedToBGInstanceGUID: number; // TODO: consistent casing plz
+		arenaTeamRating: number;
+		arenaMatchmakerRating: number;
+		opponentsTeamRating: number;
+		opponentsMatchmakerRating: number;
+		previousOpponentsTeamId: number;
+		bracketId: number; // C++ enum BattlegroundBracketId just documents that this value is in [0,16)
+		groupType: BattlegroundQueueGroupTypes;
+	}
+}
+export {};

package/records/Homebind.d.ts

@@ -0,0 +1,10 @@
+declare global {
+	interface Homebind {
+		mapId: number;
+		areaId: number;
+		x: number;
+		y: number;
+		z: number;
+	}
+}
+export {};

package/records/ImmunityInfo.d.ts

@@ -0,0 +1,12 @@
+declare global {
+	interface ImmunityInfo {
+		schoolImmuneMask: SpellSchoolMask;
+		applyHarmfulAuraImmuneMask: SpellSchoolMask;
+		mechanicImmuneMask: number;
+		dispelImmuneMask: DispelType; // doesn't seem so much of a "mask", really...
+		damageSchoolMask: SpellSchoolMask;
+		auraTypeImmune: Set<AuraType>;
+		spellEffectImmune: Set<SpellEffects>;
+	}
+}
+export {};

package/records/ItemDamage.d.ts

@@ -0,0 +1,8 @@
+declare global {
+	interface ItemDamage {
+		damageType: SpellSchools;
+		damageMin: number;
+		damageMax: number;
+	}
+}
+export {};

package/records/ItemSocket.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	interface ItemSocket {
+		color: SocketColor;
+		content: number;
+	}
+}
+export {};

package/records/ItemSpell.d.ts

@@ -0,0 +1,12 @@
+declare global {
+	interface ItemSpell {
+		spellId: number;
+		spellTrigger: ItemSpelltriggerType;
+		spellCharges: number;
+		spellPPMRate: number;
+		spellCooldown: Temporal.Duration;
+		spellCategory: number;
+		spellCategoryCooldown: Temporal.Duration;
+	}
+}
+export {};

package/records/ItemStat.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	interface ItemStat {
+		itemStatType: ItemModType;
+		itemStatValue: number;
+	}
+}
+export {};

package/records/LootItem.d.ts

@@ -0,0 +1,12 @@
+declare global {
+	interface LootItem {
+		itemid: number;
+		index: number;
+		count: number;
+		needs_quest: boolean;
+		is_looted: boolean;
+		randomSuffix: number;
+		randomPropertyId: number;
+	}
+}
+export {};

package/records/ObjectGuid.d.ts

@@ -0,0 +1,10 @@
+declare const __opaque : unique symbol;
+
+declare global {
+	type ObjectGuidNative = {
+		[__opaque]: 'This type is opaque. Use Acore.decodeGuid() if you need its sub-components.',
+	}
+	type ObjectGuidDecoded = [type: HighGuid, entry: number, counter: number];
+	type ObjectGuid = ObjectGuidNative | ObjectGuidDecoded;
+}
+export {};

package/records/PetInfo.d.ts

@@ -0,0 +1,20 @@
+declare global {
+	interface PetInfo {
+		name: string;
+		actionBar: string;
+		petNumber: number;
+		creatureId: number;
+		displayId: number;
+		experience: number;
+		health: number;
+		mana: number;
+		happiness: number;
+		lastSaveTime: Temporal.Instant;
+		createdBySpellId: number;
+		level: number;
+		reactState: ReactStates;
+		type: PetType;
+		wasRenamed: boolean;
+	}
+}
+export {};

package/records/Position.d.ts

@@ -0,0 +1,9 @@
+declare global {
+	interface Position {
+		x: number;
+		y: number;
+		z: number;
+		o: number;
+	}
+}
+export {};

package/records/PvPDifficultyEntry.d.ts

@@ -0,0 +1,10 @@
+declare global {
+	interface PvPDifficultyEntry {
+		mapId: number;
+		bracketId: number;
+		minLevel: number;
+		maxLevel: number;
+		difficulty: number; // probably NOT the Difficulty enum, if I had to guess.
+	}
+}
+export {};

package/records/SpellCastTimesEntry.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	interface SpellCastTimesEntry {
+		id: number;
+		castTime: Temporal.Duration;
+	}
+}
+export {};

package/records/SpellCategoryEntry.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	interface SpellCategoryEntry {
+		id: number;
+		flags: SpellCategoryFlags;
+	}
+}
+export {};

package/records/SpellDurationEntry.d.ts

@@ -0,0 +1,7 @@
+declare global {
+	interface SpellDurationEntry {
+		id: number;
+		duration: Temporal.Duration[];
+	}
+}
+export {};

package/records/SpellModifier.d.ts

@@ -0,0 +1,11 @@
+declare global {
+	interface SpellModifier {
+		op: SpellModOp;
+		type: SpellModType;
+		value: number;
+		mask: bigint;
+		spellId: number;
+		ownerAura: Acore.Aura;
+	}
+}
+export {};

package/records/SpellRadiusEntry.d.ts

@@ -0,0 +1,9 @@
+declare global {
+	interface SpellRadiusEntry {
+		id: number;
+		radiusMin: number;
+		radiusPerLevel: number;
+		radiusMax: number;
+	}
+}
+export {};

package/records/SpellRangeEntry.d.ts

@@ -0,0 +1,11 @@
+declare global {
+	interface SpellRangeEntry {
+		id: number;
+		minHostile: number;
+		minFriendly: number;
+		maxHostile: number;
+		maxFriendly: number;
+		flags: SpellRangeFlag;
+	}
+}
+export {};

package/records/SummonPropertiesEntry.d.ts

@@ -0,0 +1,11 @@
+declare global {
+	interface SummonPropertiesEntry {
+		id: number;
+		category: SummonCategory;
+		faction: number;
+		type: SummonType;
+		slot: number;
+		flags: SummonPropFlags;
+	}
+}
+export {};