@erlcjs/core 1.0.3 → 1.1.0

package/dist/index.d.mts

@@ -292,7 +292,7 @@ interface RawServerData {
     /**
      * Server staff lists.
      */
-    Staff?: RawStaffData[];
+    Staff?: RawStaffData;
     /**
      * Server join/leave logs.
      */
@@ -1069,6 +1069,82 @@ declare class ModCallManager {
     updateCache(rawCommands: RawModCall[]): Map<string, ModCall>;
 }
 
+/**
+ * Represents a staff member.
+ * @public
+ */
+declare class Staff extends Base {
+    /**
+     * The staff members user id.
+     */
+    id: number;
+    /**
+     * The staff members username.
+     */
+    username: string;
+    /**
+     * Whether or not the staff member is online.
+     */
+    online: boolean;
+    /**
+     * The player instance of the staff member if they are online.
+     */
+    player?: Player;
+    /**
+     * Creates an instance of Staff.
+     * @param client - The ERLCApi client.
+     * @param userId - The user id.
+     * @param username - The username.
+     */
+    constructor(client: Client, userId: string, username: string);
+    /**
+     * Patches the Staff structure with new raw data.
+     * @param userId - The user id.
+     * @param username - The username.
+     * @returns This staff instance.
+     */
+    _patch(userId: string, username: string): this;
+}
+
+/**
+ * Manager responsible for fetching, caching, and updating Vehicle structures.
+ * @public
+ */
+declare class StaffManager {
+    private readonly client;
+    /**
+     * Map cache of admins, keyed by their userId.
+     */
+    admins: Map<number, Staff>;
+    /**
+     * Map cache of mods, keyed by their userId.
+     */
+    mods: Map<number, Staff>;
+    /**
+     * Map cache of helpers, keyed by their userId.
+     */
+    helpers: Map<number, Staff>;
+    /**
+     * Creates an instance of StaffManager.
+     * @param client - The ERLCApi client.
+     */
+    constructor(client: Client);
+    /**
+     * Fetches all staff members.
+     * Updates the staff cache.
+     * @returns A promise resolving to a Map of active Vehicles.
+     */
+    fetchAll(): Promise<Map<string, Map<number, Staff>>>;
+    /**
+     * Re-synchronizes the cache with the raw staff list from the API.
+     * Emits staffAdd and staffRemove events.
+     * @param rawStaff - Raw staff list payload.
+     * @returns The updated staff cache Map.
+     */
+    updateCache(rawStaff: RawStaffData): Map<string, Map<number, Staff>>;
+    private _updateCache;
+}
+
 /**
  * Event names emitted by the ERLCApi Client.
  * @public
@@ -1103,7 +1179,11 @@ declare enum ERLCEvents {
     /** Emitted when an emergency call is cleared. */
     emergencyCallRemove = "EMERGENCY_CALL_REMOVE",
     /** Emitted when an emergency call is updated. */
-    emergencyCallUpdate = "EMERGENCY_CALL_UPDATE"
+    emergencyCallUpdate = "EMERGENCY_CALL_UPDATE",
+    /** Emitted when a staff member is added */
+    staffAdd = "STAFF_ADD",
+    /** Emitted when a staff member is removed */
+    staffRemove = "STAFF_REMOVE"
 }
 /**
  * Interface mapping client event names to their callback parameters.
@@ -1140,6 +1220,8 @@ interface ClientEvents {
     [ERLCEvents.emergencyCallRemove]: [call: EmergencyCall];
     /** Emitted when an emergency call is updated. */
     [ERLCEvents.emergencyCallUpdate]: [oldCall: EmergencyCall | null, newCall: EmergencyCall];
+    [ERLCEvents.staffAdd]: [staff: Staff, type: 'Admin' | 'Mod' | 'Helper'];
+    [ERLCEvents.staffRemove]: [staff: Staff, type: 'Admin' | 'Mod' | 'Helper'];
     /** Emitted when an error is caught during polling or gateway operations. */
     error: [error: unknown];
 }
@@ -1167,6 +1249,8 @@ declare class Client extends EventEmitter<ClientEvents> {
     killLogs: KillLogManager;
     /** Manager for moderator call logs. */
     modCalls: ModCallManager;
+    /** Manager for staff members. */
+    staff: StaffManager;
     /** Webhook Gateway server instance, if enabled. */
     private readonly gateway?;
     /**
@@ -1215,4 +1299,4 @@ declare class InvalidServerKeyError extends Error {
     constructor(message?: string);
 }
 
-export { Base, Client, type ClientEvents, type ClientOptions, CommandLog, CommandLogManager, CommandManager, ERLCEvents, EmergencyCall, EmergencyCallManager, InvalidServerKeyError, KillLog, KillLogManager, ModCall, ModCallManager, Player, PlayerManager, type RawCommandLog, type RawEmergencyCall, type RawJoinLog, type RawKillLog, type RawModCall, type RawPlayerData, type RawServerData, type RawStaffData, type RawVehicle, RestManager, Server, ServerManager, Vehicle, VehicleManager, WebhookServer };
+export { Base, Client, type ClientEvents, type ClientOptions, CommandLog, CommandLogManager, CommandManager, ERLCEvents, EmergencyCall, EmergencyCallManager, InvalidServerKeyError, KillLog, KillLogManager, ModCall, ModCallManager, Player, PlayerManager, type RawCommandLog, type RawEmergencyCall, type RawJoinLog, type RawKillLog, type RawModCall, type RawPlayerData, type RawServerData, type RawStaffData, type RawVehicle, RestManager, Server, ServerManager, Staff, StaffManager, Vehicle, VehicleManager, WebhookServer };

package/dist/index.d.ts

@@ -292,7 +292,7 @@ interface RawServerData {
     /**
      * Server staff lists.
      */
-    Staff?: RawStaffData[];
+    Staff?: RawStaffData;
     /**
      * Server join/leave logs.
      */
@@ -1069,6 +1069,82 @@ declare class ModCallManager {
     updateCache(rawCommands: RawModCall[]): Map<string, ModCall>;
 }
 
+/**
+ * Represents a staff member.
+ * @public
+ */
+declare class Staff extends Base {
+    /**
+     * The staff members user id.
+     */
+    id: number;
+    /**
+     * The staff members username.
+     */
+    username: string;
+    /**
+     * Whether or not the staff member is online.
+     */
+    online: boolean;
+    /**
+     * The player instance of the staff member if they are online.
+     */
+    player?: Player;
+    /**
+     * Creates an instance of Staff.
+     * @param client - The ERLCApi client.
+     * @param userId - The user id.
+     * @param username - The username.
+     */
+    constructor(client: Client, userId: string, username: string);
+    /**
+     * Patches the Staff structure with new raw data.
+     * @param userId - The user id.
+     * @param username - The username.
+     * @returns This staff instance.
+     */
+    _patch(userId: string, username: string): this;
+}
+
+/**
+ * Manager responsible for fetching, caching, and updating Vehicle structures.
+ * @public
+ */
+declare class StaffManager {
+    private readonly client;
+    /**
+     * Map cache of admins, keyed by their userId.
+     */
+    admins: Map<number, Staff>;
+    /**
+     * Map cache of mods, keyed by their userId.
+     */
+    mods: Map<number, Staff>;
+    /**
+     * Map cache of helpers, keyed by their userId.
+     */
+    helpers: Map<number, Staff>;
+    /**
+     * Creates an instance of StaffManager.
+     * @param client - The ERLCApi client.
+     */
+    constructor(client: Client);
+    /**
+     * Fetches all staff members.
+     * Updates the staff cache.
+     * @returns A promise resolving to a Map of active Vehicles.
+     */
+    fetchAll(): Promise<Map<string, Map<number, Staff>>>;
+    /**
+     * Re-synchronizes the cache with the raw staff list from the API.
+     * Emits staffAdd and staffRemove events.
+     * @param rawStaff - Raw staff list payload.
+     * @returns The updated staff cache Map.
+     */
+    updateCache(rawStaff: RawStaffData): Map<string, Map<number, Staff>>;
+    private _updateCache;
+}
+
 /**
  * Event names emitted by the ERLCApi Client.
  * @public
@@ -1103,7 +1179,11 @@ declare enum ERLCEvents {
     /** Emitted when an emergency call is cleared. */
     emergencyCallRemove = "EMERGENCY_CALL_REMOVE",
     /** Emitted when an emergency call is updated. */
-    emergencyCallUpdate = "EMERGENCY_CALL_UPDATE"
+    emergencyCallUpdate = "EMERGENCY_CALL_UPDATE",
+    /** Emitted when a staff member is added */
+    staffAdd = "STAFF_ADD",
+    /** Emitted when a staff member is removed */
+    staffRemove = "STAFF_REMOVE"
 }
 /**
  * Interface mapping client event names to their callback parameters.
@@ -1140,6 +1220,8 @@ interface ClientEvents {
     [ERLCEvents.emergencyCallRemove]: [call: EmergencyCall];
     /** Emitted when an emergency call is updated. */
     [ERLCEvents.emergencyCallUpdate]: [oldCall: EmergencyCall | null, newCall: EmergencyCall];
+    [ERLCEvents.staffAdd]: [staff: Staff, type: 'Admin' | 'Mod' | 'Helper'];
+    [ERLCEvents.staffRemove]: [staff: Staff, type: 'Admin' | 'Mod' | 'Helper'];
     /** Emitted when an error is caught during polling or gateway operations. */
     error: [error: unknown];
 }
@@ -1167,6 +1249,8 @@ declare class Client extends EventEmitter<ClientEvents> {
     killLogs: KillLogManager;
     /** Manager for moderator call logs. */
     modCalls: ModCallManager;
+    /** Manager for staff members. */
+    staff: StaffManager;
     /** Webhook Gateway server instance, if enabled. */
     private readonly gateway?;
     /**
@@ -1215,4 +1299,4 @@ declare class InvalidServerKeyError extends Error {
     constructor(message?: string);
 }
 
-export { Base, Client, type ClientEvents, type ClientOptions, CommandLog, CommandLogManager, CommandManager, ERLCEvents, EmergencyCall, EmergencyCallManager, InvalidServerKeyError, KillLog, KillLogManager, ModCall, ModCallManager, Player, PlayerManager, type RawCommandLog, type RawEmergencyCall, type RawJoinLog, type RawKillLog, type RawModCall, type RawPlayerData, type RawServerData, type RawStaffData, type RawVehicle, RestManager, Server, ServerManager, Vehicle, VehicleManager, WebhookServer };
+export { Base, Client, type ClientEvents, type ClientOptions, CommandLog, CommandLogManager, CommandManager, ERLCEvents, EmergencyCall, EmergencyCallManager, InvalidServerKeyError, KillLog, KillLogManager, ModCall, ModCallManager, Player, PlayerManager, type RawCommandLog, type RawEmergencyCall, type RawJoinLog, type RawKillLog, type RawModCall, type RawPlayerData, type RawServerData, type RawStaffData, type RawVehicle, RestManager, Server, ServerManager, Staff, StaffManager, Vehicle, VehicleManager, WebhookServer };

package/dist/index.js

@@ -21,7 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   Base: () => Base,
-  Client: () => Client18,
+  Client: () => Client20,
   CommandLog: () => CommandLog,
   CommandLogManager: () => CommandLogManager,
   CommandManager: () => CommandManager,
@@ -38,6 +38,8 @@ __export(index_exports, {
   RestManager: () => RestManager,
   Server: () => Server,
   ServerManager: () => ServerManager,
+  Staff: () => Staff,
+  StaffManager: () => StaffManager,
   Vehicle: () => Vehicle,
   VehicleManager: () => VehicleManager,
   WebhookServer: () => WebhookServer
@@ -1210,6 +1212,118 @@ var ModCallManager = class {
   }
 };
 
+// src/structures/staff.ts
+var Staff = class extends Base {
+  /**
+   * The staff members user id.
+   */
+  id;
+  /**
+   * The staff members username.
+   */
+  username;
+  /**
+   * Whether or not the staff member is online.
+   */
+  online;
+  /**
+   * The player instance of the staff member if they are online.
+   */
+  player;
+  /**
+   * Creates an instance of Staff.
+   * @param client - The ERLCApi client.
+   * @param userId - The user id.
+   * @param username - The username.
+   */
+  constructor(client, userId, username) {
+    super(client);
+    this._patch(userId, username);
+  }
+  /**
+   * Patches the Staff structure with new raw data.
+   * @param userId - The user id.
+   * @param username - The username.
+   * @returns This staff instance.
+   */
+  _patch(userId, username) {
+    this.id = Number(userId);
+    this.username = username;
+    this.online = this.client.players.cache.has(this.id);
+    this.player = void 0;
+    if (this.online === true) this.player = this.client.players.cache.get(this.id);
+    return this;
+  }
+};
+
+// src/managers/staffmanager.ts
+var StaffManager = class {
+  /**
+   * Creates an instance of StaffManager.
+   * @param client - The ERLCApi client.
+   */
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Map cache of admins, keyed by their userId.
+   */
+  admins = /* @__PURE__ */ new Map();
+  /**
+   * Map cache of mods, keyed by their userId.
+   */
+  mods = /* @__PURE__ */ new Map();
+  /**
+   * Map cache of helpers, keyed by their userId.
+   */
+  helpers = /* @__PURE__ */ new Map();
+  /**
+   * Fetches all staff members.
+   * Updates the staff cache.
+   * @returns A promise resolving to a Map of active Vehicles.
+   */
+  async fetchAll() {
+    const rawServer = await this.client.rest.request("GET", "/v2/server?Staff=true");
+    const rawVehicles = rawServer.Staff;
+    return this.updateCache(rawVehicles);
+  }
+  /**
+   * Re-synchronizes the cache with the raw staff list from the API.
+   * Emits staffAdd and staffRemove events.
+   * @param rawStaff - Raw staff list payload.
+   * @returns The updated staff cache Map.
+   */
+  updateCache(rawStaff) {
+    this._updateCache(rawStaff.Admins, "Admin");
+    this._updateCache(rawStaff.Mods, "Mod");
+    this._updateCache(rawStaff.Helpers, "Helper");
+    return (/* @__PURE__ */ new Map()).set("Admins", this.admins).set("Mods", this.mods).set("Helpers", this.helpers);
+  }
+  _updateCache(data, type) {
+    const activeUserIds = /* @__PURE__ */ new Set();
+    const types = `${type}s`;
+    let cache;
+    if (type === "Admin") cache = this.admins;
+    else if (type === "Mod") cache = this.mods;
+    else cache = this.helpers;
+    for (const [userId, username] of Object.entries(data)) {
+      activeUserIds.add(Number(userId));
+      const cachedUser = cache.get(Number(userId));
+      if (cachedUser) return;
+      const newStaff = new Staff(this.client, userId, username);
+      cache.set(Number(userId), newStaff);
+      this.client.emit("STAFF_ADD" /* staffAdd */, newStaff, type);
+    }
+    for (const cachedId of this.admins.keys()) {
+      if (!activeUserIds.has(cachedId)) {
+        this.client.emit("STAFF_REMOVE" /* staffRemove */, cache.get(cachedId), type);
+        cache.delete(cachedId);
+      }
+    }
+  }
+};
+
 // src/client/client.ts
 var ERLCEvents = /* @__PURE__ */ ((ERLCEvents2) => {
   ERLCEvents2["poll"] = "POLL";
@@ -1227,9 +1341,11 @@ var ERLCEvents = /* @__PURE__ */ ((ERLCEvents2) => {
   ERLCEvents2["emergencyCallAdd"] = "EMERGENCY_CALL_ADD";
   ERLCEvents2["emergencyCallRemove"] = "EMERGENCY_CALL_REMOVE";
   ERLCEvents2["emergencyCallUpdate"] = "EMERGENCY_CALL_UPDATE";
+  ERLCEvents2["staffAdd"] = "STAFF_ADD";
+  ERLCEvents2["staffRemove"] = "STAFF_REMOVE";
   return ERLCEvents2;
 })(ERLCEvents || {});
-var Client18 = class extends import_node_events.EventEmitter {
+var Client20 = class extends import_node_events.EventEmitter {
   /**
    * Creates an instance of Client.
    * @param options - The ClientOptions configuration.
@@ -1246,6 +1362,7 @@ var Client18 = class extends import_node_events.EventEmitter {
     this.emergencyCalls = new EmergencyCallManager(this);
     this.killLogs = new KillLogManager(this);
     this.modCalls = new ModCallManager(this);
+    this.staff = new StaffManager(this);
     if (options.webhook?.enabled) {
       this.gateway = new WebhookServer(this);
       this.gateway.listen();
@@ -1273,6 +1390,8 @@ var Client18 = class extends import_node_events.EventEmitter {
   killLogs;
   /** Manager for moderator call logs. */
   modCalls;
+  /** Manager for staff members. */
+  staff;
   /** Webhook Gateway server instance, if enabled. */
   gateway;
   /**
@@ -1289,6 +1408,7 @@ var Client18 = class extends import_node_events.EventEmitter {
         if (server.EmergencyCalls) this.emergencyCalls.updateCache(server.EmergencyCalls);
         if (server.KillLogs) this.killLogs.updateCache(server.KillLogs);
         if (server.ModCalls) this.modCalls.updateCache(server.ModCalls);
+        if (server.Staff) this.staff.updateCache(server.Staff);
       } catch (err) {
         this.emit("error", err);
       }
@@ -1315,6 +1435,8 @@ var Client18 = class extends import_node_events.EventEmitter {
   RestManager,
   Server,
   ServerManager,
+  Staff,
+  StaffManager,
   Vehicle,
   VehicleManager,
   WebhookServer

package/dist/index.mjs

@@ -1164,6 +1164,118 @@ var ModCallManager = class {
   }
 };
 
+// src/structures/staff.ts
+var Staff = class extends Base {
+  /**
+   * The staff members user id.
+   */
+  id;
+  /**
+   * The staff members username.
+   */
+  username;
+  /**
+   * Whether or not the staff member is online.
+   */
+  online;
+  /**
+   * The player instance of the staff member if they are online.
+   */
+  player;
+  /**
+   * Creates an instance of Staff.
+   * @param client - The ERLCApi client.
+   * @param userId - The user id.
+   * @param username - The username.
+   */
+  constructor(client, userId, username) {
+    super(client);
+    this._patch(userId, username);
+  }
+  /**
+   * Patches the Staff structure with new raw data.
+   * @param userId - The user id.
+   * @param username - The username.
+   * @returns This staff instance.
+   */
+  _patch(userId, username) {
+    this.id = Number(userId);
+    this.username = username;
+    this.online = this.client.players.cache.has(this.id);
+    this.player = void 0;
+    if (this.online === true) this.player = this.client.players.cache.get(this.id);
+    return this;
+  }
+};
+
+// src/managers/staffmanager.ts
+var StaffManager = class {
+  /**
+   * Creates an instance of StaffManager.
+   * @param client - The ERLCApi client.
+   */
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Map cache of admins, keyed by their userId.
+   */
+  admins = /* @__PURE__ */ new Map();
+  /**
+   * Map cache of mods, keyed by their userId.
+   */
+  mods = /* @__PURE__ */ new Map();
+  /**
+   * Map cache of helpers, keyed by their userId.
+   */
+  helpers = /* @__PURE__ */ new Map();
+  /**
+   * Fetches all staff members.
+   * Updates the staff cache.
+   * @returns A promise resolving to a Map of active Vehicles.
+   */
+  async fetchAll() {
+    const rawServer = await this.client.rest.request("GET", "/v2/server?Staff=true");
+    const rawVehicles = rawServer.Staff;
+    return this.updateCache(rawVehicles);
+  }
+  /**
+   * Re-synchronizes the cache with the raw staff list from the API.
+   * Emits staffAdd and staffRemove events.
+   * @param rawStaff - Raw staff list payload.
+   * @returns The updated staff cache Map.
+   */
+  updateCache(rawStaff) {
+    this._updateCache(rawStaff.Admins, "Admin");
+    this._updateCache(rawStaff.Mods, "Mod");
+    this._updateCache(rawStaff.Helpers, "Helper");
+    return (/* @__PURE__ */ new Map()).set("Admins", this.admins).set("Mods", this.mods).set("Helpers", this.helpers);
+  }
+  _updateCache(data, type) {
+    const activeUserIds = /* @__PURE__ */ new Set();
+    const types = `${type}s`;
+    let cache;
+    if (type === "Admin") cache = this.admins;
+    else if (type === "Mod") cache = this.mods;
+    else cache = this.helpers;
+    for (const [userId, username] of Object.entries(data)) {
+      activeUserIds.add(Number(userId));
+      const cachedUser = cache.get(Number(userId));
+      if (cachedUser) return;
+      const newStaff = new Staff(this.client, userId, username);
+      cache.set(Number(userId), newStaff);
+      this.client.emit("STAFF_ADD" /* staffAdd */, newStaff, type);
+    }
+    for (const cachedId of this.admins.keys()) {
+      if (!activeUserIds.has(cachedId)) {
+        this.client.emit("STAFF_REMOVE" /* staffRemove */, cache.get(cachedId), type);
+        cache.delete(cachedId);
+      }
+    }
+  }
+};
+
 // src/client/client.ts
 var ERLCEvents = /* @__PURE__ */ ((ERLCEvents2) => {
   ERLCEvents2["poll"] = "POLL";
@@ -1181,9 +1293,11 @@ var ERLCEvents = /* @__PURE__ */ ((ERLCEvents2) => {
   ERLCEvents2["emergencyCallAdd"] = "EMERGENCY_CALL_ADD";
   ERLCEvents2["emergencyCallRemove"] = "EMERGENCY_CALL_REMOVE";
   ERLCEvents2["emergencyCallUpdate"] = "EMERGENCY_CALL_UPDATE";
+  ERLCEvents2["staffAdd"] = "STAFF_ADD";
+  ERLCEvents2["staffRemove"] = "STAFF_REMOVE";
   return ERLCEvents2;
 })(ERLCEvents || {});
-var Client18 = class extends EventEmitter {
+var Client20 = class extends EventEmitter {
   /**
    * Creates an instance of Client.
    * @param options - The ClientOptions configuration.
@@ -1200,6 +1314,7 @@ var Client18 = class extends EventEmitter {
     this.emergencyCalls = new EmergencyCallManager(this);
     this.killLogs = new KillLogManager(this);
     this.modCalls = new ModCallManager(this);
+    this.staff = new StaffManager(this);
     if (options.webhook?.enabled) {
       this.gateway = new WebhookServer(this);
       this.gateway.listen();
@@ -1227,6 +1342,8 @@ var Client18 = class extends EventEmitter {
   killLogs;
   /** Manager for moderator call logs. */
   modCalls;
+  /** Manager for staff members. */
+  staff;
   /** Webhook Gateway server instance, if enabled. */
   gateway;
   /**
@@ -1243,6 +1360,7 @@ var Client18 = class extends EventEmitter {
         if (server.EmergencyCalls) this.emergencyCalls.updateCache(server.EmergencyCalls);
         if (server.KillLogs) this.killLogs.updateCache(server.KillLogs);
         if (server.ModCalls) this.modCalls.updateCache(server.ModCalls);
+        if (server.Staff) this.staff.updateCache(server.Staff);
       } catch (err) {
         this.emit("error", err);
       }
@@ -1251,7 +1369,7 @@ var Client18 = class extends EventEmitter {
 };
 export {
   Base,
-  Client18 as Client,
+  Client20 as Client,
   CommandLog,
   CommandLogManager,
   CommandManager,
@@ -1268,6 +1386,8 @@ export {
   RestManager,
   Server,
   ServerManager,
+  Staff,
+  StaffManager,
   Vehicle,
   VehicleManager,
   WebhookServer

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@erlcjs/core",
   "description": "ERLC API Wrapper Core",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",