Add type definitions to allow editor autocompletion / intellisense

.npmignore

@@ -4,4 +4,6 @@
 !LICENSE.txt
 !src/*
 !index.js
+!index.d.ts
+!types/*
 !package*

index.d.ts

@@ -0,0 +1,104 @@
+export { Account, AccountConfig } from './types/Account';
+export { AccountManager } from './types/AccountManager';
+export { Area } from './types/Area';
+export { AreaAudience } from './types/AreaAudience';
+export { AreaFactory } from './types/AreaFactory';
+export { AreaFloor } from './types/AreaFloor';
+export { AreaManager } from './types/AreaManager';
+export { AreaOfEffectDamage } from './types/AreaOfEffectDamage';
+export { AreaOfEffectHeal } from './types/AreaOfEffectHeal';
+export { Attribute, AttributeFormula } from './types/Attribute';
+export { AttributeFactory } from './types/AttributeFactory';
+export { Attributes } from './types/Attributes';
+export { BehaviorManager } from './types/BehaviorManager';
+export { Broadcast, Broadcastable } from './types/Broadcast';
+export { BundleManager } from './types/BundleManager';
+export {
+  ChannelConfig,
+  Channel,
+  NoMessageError,
+  NoPartyError,
+  NoRecipientError,
+} from './types/Channel';
+export { AudienceOptions, ChannelAudience } from './types/ChannelAudience';
+export { ChannelManager } from './types/ChannelManager';
+export { Character, CharacterConfig } from './types/Character';
+export { CommandManager } from './types/CommandManager';
+export { CommandExecutable, CommandQueue } from './types/CommandQueue';
+export { CommandType } from './types/CommandType';
+export { Config } from './types/Config';
+export { Command } from './types/Command';
+export { Damage } from './types/Damage';
+export { Data } from './types/Data';
+export { DataSourceRegistry } from './types/DataSourceRegistry';
+export { DataSource } from './types/DataSource';
+export { Effect, EffectConfig, EffectModifiers } from './types/Effect';
+export { EffectableEntity } from './types/EffectableEntity';
+export {
+  EffectConfig as EffectFactoryType,
+  EffectFactory,
+} from './types/EffectFactory';
+export { EffectFlag } from './types/EffectFlag';
+export { EffectList } from './types/EffectList';
+export { EntityFactory } from './types/EntityFactory';
+export { EntityLoader } from './types/EntityLoader';
+export { EntityLoaderRegistry } from './types/EntityLoaderRegistry';
+export { EntityReference } from './types/EntityReference';
+export { EventManager } from './types/EventManager';
+export { EventUtil } from './types/EventUtil';
+export {
+  EquipAlreadyEquippedError,
+  EquipSlotTakenError,
+} from './types/EquipErrors';
+export { GameEntity } from './types/GameEntity';
+export { GameServer } from './types/GameServer';
+export { GameState } from './types/GameState';
+export { Heal } from './types/Heal';
+export { Helpfile, HelpfileOptions } from './types/Helpfile';
+export { HelpManager } from './types/HelpManager';
+export { Item } from './types/Item';
+export { ItemManager } from './types/ItemManager';
+export { Inventory, InventoryFullError } from './types/Inventory';
+export { ItemFactory } from './types/ItemFactory';
+export { Logger } from './types/Logger';
+export { Metadatable, MetadatableClass } from './types/Metadatable';
+export { MobFactory } from './types/MobFactory';
+export { MobManager } from './types/MobManager';
+export { Npc } from './types/Npc';
+export { Party } from './types/Party';
+export { PartyManager } from './types/PartyManager';
+export { PartyAudience } from './types/PartyAudience';
+export { Player } from './types/Player';
+export { PlayerManager } from './types/PlayerManager';
+export { PlayerRoles } from './types/PlayerRoles';
+export { PrivateAudience } from './types/PrivateAudience';
+export { Quest, QuestConfig } from './types/Quest';
+export { QuestFactory } from './types/QuestFactory';
+export {
+  QuestGoal,
+  QuestGoalConfig,
+  QuestGoalProgress,
+  QuestGoalSerialized,
+} from './types/QuestGoal';
+export { QuestGoalManager } from './types/QuestGoalManager';
+export { QuestReward, QuestRewardConfig } from './types/QuestReward';
+export { QuestRewardManager } from './types/QuestRewardManager';
+export { QuestTracker, SerializedQuestTracker } from './types/QuestTracker';
+export { RoleAudience} from './types/RoleAudience';
+export { Room, Door, Exit } from './types/Room';
+export { RoomAudience } from './types/RoomAudience';
+export { RoomFactory } from './types/RoomFactory';
+export { RoomManager } from './types/RoomManager';
+export { Scriptable, ScriptableClass } from './types/Scriptable';
+export { Skill } from './types/Skill';
+export {
+  CooldownError,
+  NotEnoughResourcesError,
+  PassiveError,
+} from './types/SkillErrors';
+export { SkillFlag } from './types/SkillFlag';
+export { SkillManager } from './types/SkillManager';
+export { SkillType } from './types/SkillType';
+export { TransportStream } from './types/TransportStream';
+export { Util } from './types/Util';
+export { WorldAudience } from './types/WorldAudience';

package.json

@@ -15,6 +15,7 @@
     "coverage": "nyc report --reporter=text-lcov | coveralls"
   },
   "main": "index.js",
+  "types": "index.d.ts",
   "dependencies": {
     "bcryptjs": "^2.4.0",
     "js-yaml": "^3.12.0",
@@ -29,6 +30,8 @@
   "devDependencies": {
     "coveralls": "^3.0.2",
     "mocha": "^5.2.0",
-    "nyc": "^13.1.0"
+    "nyc": "^13.1.0",
+    "@types/node": "^10.12",
+    "typescript": "4.1.2"
   }
 }

src/Area.js

@@ -146,7 +146,7 @@ class Area extends GameEntity {
    * This method is automatically called every N milliseconds where N is defined in the
    * `setInterval` call to `GameState.AreaMAnager.tickAll` in the `ranvier` executable. It, in turn,
    * will fire the `updateTick` event on all its rooms and npcs
-   * 
+   *
    * @param {GameState} state
    * @fires Room#updateTick
    * @fires Npc#updateTick

src/Attribute.js

@@ -22,8 +22,8 @@ class Attribute {
    * @param {object} metadata={}
    */
   constructor(name, base, delta = 0, formula = null, metadata = {}) {
-    if (isNaN(base)) { 
-      throw new TypeError(`Base attribute must be a number, got ${base}.`); 
+    if (isNaN(base)) {
+      throw new TypeError(`Base attribute must be a number, got ${base}.`);
     }
     if (isNaN(delta)) {
       throw new TypeError(`Attribute delta must be a number, got ${delta}.`);
@@ -66,7 +66,7 @@ class Attribute {
 
   /**
    * Bypass raise/lower, directly setting the delta
-   * @param {amount}
+   * @param {number} amount
    */
   setDelta(amount) {
     this.delta = Math.min(amount, 0);

src/AttributeFactory.js

@@ -46,6 +46,7 @@ class AttributeFactory {
 
   /**
    * @param {string} name
+   * @param {number} base
    * @param {number} delta
    * @return {Attribute}
    */

src/BehaviorManager.js

@@ -31,6 +31,7 @@ class BehaviorManager {
 
   /**
    * @param {string}   behaviorName
+   * @param {string}   event
    * @param {Function} listener
    */
   addListener(behaviorName, event, listener) {

src/BundleManager.js

@@ -26,6 +26,7 @@ const srcPath = __dirname + '/';
  */
 class BundleManager {
   /**
+   * @param {string} path
    * @param {GameState} state
    */
   constructor(path, state) {
@@ -41,6 +42,7 @@ class BundleManager {
 
   /**
    * Load in all bundles
+   * @param {boolean} distribute
    */
   async loadBundles(distribute = true) {
     Logger.verbose('LOAD: BUNDLES');
@@ -317,7 +319,7 @@ class BundleManager {
    * @param {string} areaName
    * @param {string} type
    * @param {EntityFactory} factory
-   * @return {Array<entityReference>}
+   * @return {Array<string>}
    */
   async loadEntities(bundle, areaName, type, factory) {
     const loader = this.loaderRegistry.get(type);
@@ -355,7 +357,7 @@ class BundleManager {
 
   /**
    * @param {EntityFactory} factory Instance of EntityFactory that the item/npc will be loaded into
-   * @param {EntityReference} entityRef
+   * @param {string} entityRef
    * @param {string} scriptPath
    */
   loadEntityScript(factory, entityRef, scriptPath) {
@@ -369,9 +371,9 @@ class BundleManager {
   }
 
   /**
+   * @param {string} bundle
    * @param {string} areaName
-   * @param {string} questsFile
-   * @return {Promise<Array<entityReference>>}
+   * @return {Promise<Array<string>>}
    */
   async loadQuests(bundle, areaName) {
     const loader = this.loaderRegistry.get('quests');
@@ -455,7 +457,6 @@ class BundleManager {
 
   /**
    * @param {string} bundle
-   * @param {string} helpDir
    */
   async loadHelp(bundle) {
     Logger.verbose(`\tLOAD: Help...`);

src/Channel.js

@@ -122,6 +122,7 @@ class Channel {
    * How to render the message the player just sent to the channel
    * E.g., you may want "chat" to say "You chat, 'message here'"
    * @param {Player} sender
+   * @param {Player} target
    * @param {string} message
    * @param {Function} colorify
    * @return {string}

src/CommandQueue.js

@@ -26,6 +26,7 @@ class CommandQueue {
   /**
    * @param {CommandExecutable} executable Thing to run with an execute and a queue label
    * @param {number} lag Amount of lag to apply to the queue after the command is run
+   * @returns {number}
    */
   enqueue(executable, lag) {
     let newIndex = this.commands.push(Object.assign(executable, { lag })) - 1;
@@ -100,7 +101,6 @@ class CommandQueue {
   /**
    * For a given command index find how many seconds until it will run
    * @param {number} commandIndex
-   * @param {boolean} milliseconds
    * @return {number}
    */
   getTimeTilRun(commandIndex) {

src/Effect.js

@@ -109,7 +109,7 @@ class Effect extends EventEmitter {
    * Elapsed time in milliseconds since event was activated
    * @type {number}
    */
-  get elapsed () {
+  get elapsed() {
     if (!this.startedAt) {
       return null;
     }

src/Item.js

@@ -5,8 +5,7 @@ const uuid = require('uuid/v4');
 const GameEntity = require('./GameEntity');
 const ItemType = require('./ItemType');
 const Logger = require('./Logger');
-const Metadatable = require('./Metadatable');
-const Player = require('./Player');
+
 const { Inventory, InventoryFullError } = require('./Inventory');
 
 /**

src/PlayerManager.js

@@ -83,11 +83,11 @@ class PlayerManager extends EventEmitter {
   }
 
   /**
-   * @param {Function} fn Filter function
-   * @return {array}
+   * @param {Function} predicate Filter function
+   * @return {array},
    */
-  filter(fn) {
-    return this.getPlayersAsArray().filter(fn);
+  filter(predicate) {
+    return this.getPlayersAsArray().filter(predicate);
   }
 
   /**