Updated for SPT v3.2.4

.github/ISSUE_TEMPLATE/GENERAL.yml

@@ -30,7 +30,8 @@ body:
       label: SPT Version
       description: What version of SPT are you running?
       options:
-        - 3.2.3 (latest)
+        - 3.2.4 (latest)
+        - 3.2.3
         - 3.2.2
         - 3.2.1
         - 3.2.0

.nvmrc

@@ -1 +1 @@
-v14.15.3
+v16.17.0

config/config.json

@@ -1,6 +1,6 @@
 {
     "_comment": "Enables the use of the mod. [true/false]",
-    "mod_enabled": true,
+    "mod_enabled": false,
 
     "_comment": "Verbose logging. [true/false]",
     "debug": false,

package.json

@@ -1,10 +1,10 @@
 {
     "name": "CustomStamina",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "main": "src/mod.js",
     "license": "MIT",
     "author": "Refringe",
-    "akiVersion": "3.2.3",
+    "akiVersion": "3.2.4",
     "scripts": {
         "setup": "npm i",
         "build": "node ./packageBuild.ts"

types/ErrorHandler.d.ts

@@ -0,0 +1,6 @@
+export declare class ErrorHandler {
+    private logger;
+    private readLine;
+    constructor();
+    handleCriticalError(err: any): void;
+}

types/Program.d.ts

@@ -1,4 +1,5 @@
 export declare class Program {
+    private errorHandler;
     constructor();
     start(): void;
 }

types/callbacks/BundleCallbacks.d.ts

@@ -1,17 +1,17 @@
 import { BundleLoader } from "../loaders/BundleLoader";
 import { IHttpConfig } from "../models/spt/config/IHttpConfig";
-import { IHttpServer } from "../models/spt/server/IHttpServer";
 import { ILogger } from "../models/spt/utils/ILogger";
 import { ConfigServer } from "../servers/ConfigServer";
+import { HttpFileUtil } from "../utils/HttpFileUtil";
 import { HttpResponseUtil } from "../utils/HttpResponseUtil";
 export declare class BundleCallbacks {
     protected logger: ILogger;
     protected httpResponse: HttpResponseUtil;
-    protected httpServer: IHttpServer;
+    protected httpFileUtil: HttpFileUtil;
     protected bundleLoader: BundleLoader;
     protected configServer: ConfigServer;
     protected httpConfig: IHttpConfig;
-    constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpServer: IHttpServer, bundleLoader: BundleLoader, configServer: ConfigServer);
+    constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpFileUtil: HttpFileUtil, bundleLoader: BundleLoader, configServer: ConfigServer);
     sendBundle(sessionID: string, req: any, resp: any, body: any): any;
     getBundles(url: string, info: any, sessionID: string): string;
     getBundle(url: string, info: any, sessionID: string): string;

types/callbacks/HttpCallbacks.d.ts

@@ -1,8 +1,8 @@
 import { OnLoad } from "../di/OnLoad";
-import { IHttpServer } from "../models/spt/server/IHttpServer";
+import { HttpServer } from "../servers/HttpServer";
 export declare class HttpCallbacks extends OnLoad {
-    protected httpServer: IHttpServer;
-    constructor(httpServer: IHttpServer);
+    protected httpServer: HttpServer;
+    constructor(httpServer: HttpServer);
     onLoad(): void;
     getRoute(): string;
     getImage(): string;

types/callbacks/ModCallbacks.d.ts

@@ -1,18 +1,18 @@
 import { OnLoad } from "../di/OnLoad";
 import { PostAkiModLoader } from "../loaders/PostAkiModLoader";
 import { IHttpConfig } from "../models/spt/config/IHttpConfig";
-import { IHttpServer } from "../models/spt/server/IHttpServer";
 import { ILogger } from "../models/spt/utils/ILogger";
 import { ConfigServer } from "../servers/ConfigServer";
+import { HttpFileUtil } from "../utils/HttpFileUtil";
 import { HttpResponseUtil } from "../utils/HttpResponseUtil";
 declare class ModCallbacks extends OnLoad {
     protected logger: ILogger;
     protected httpResponse: HttpResponseUtil;
-    protected httpServer: IHttpServer;
+    protected httpFileUtil: HttpFileUtil;
     protected postAkiModLoader: PostAkiModLoader;
     protected configServer: ConfigServer;
     protected httpConfig: IHttpConfig;
-    constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpServer: IHttpServer, postAkiModLoader: PostAkiModLoader, configServer: ConfigServer);
+    constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpFileUtil: HttpFileUtil, postAkiModLoader: PostAkiModLoader, configServer: ConfigServer);
     onLoad(): void;
     getRoute(): string;
     sendBundle(sessionID: string, req: any, resp: any, body: any): void;

types/callbacks/RepairCallbacks.d.ts

@@ -6,6 +6,20 @@ import { ITraderRepairActionDataRequest } from "../models/eft/repair/ITraderRepa
 export declare class RepairCallbacks {
     protected repairController: RepairController;
     constructor(repairController: RepairController);
+    /**
+     * use trader to repair item
+     * @param pmcData
+     * @param body
+     * @param sessionID
+     * @returns
+     */
     traderRepair(pmcData: IPmcData, body: ITraderRepairActionDataRequest, sessionID: string): IItemEventRouterResponse;
+    /**
+     * Use repair kit to repair item
+     * @param pmcData
+     * @param body
+     * @param sessionID
+     * @returns
+     */
     repair(pmcData: IPmcData, body: IRepairActionDataRequest, sessionID: string): IItemEventRouterResponse;
 }

types/controllers/BotController.d.ts

@@ -1,3 +1,4 @@
+import { ApplicationContext } from "../context/ApplicationContext";
 import { BotGenerator } from "../generators/BotGenerator";
 import { BotHelper } from "../helpers/BotHelper";
 import { IGenerateBotsRequestData } from "../models/eft/bot/IGenerateBotsRequestData";
@@ -18,8 +19,9 @@ export declare class BotController {
     protected pmcAiService: PmcAiService;
     protected botGenerationCacheService: BotGenerationCacheService;
     protected configServer: ConfigServer;
+    protected applicationContext: ApplicationContext;
     protected botConfig: IBotConfig;
-    constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, pmcAiService: PmcAiService, botGenerationCacheService: BotGenerationCacheService, configServer: ConfigServer);
+    constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, pmcAiService: PmcAiService, botGenerationCacheService: BotGenerationCacheService, configServer: ConfigServer, applicationContext: ApplicationContext);
     /**
      * Return the number of bot loadout varieties to be generated
      * @param type bot Type we want the loadout gen count for
@@ -36,6 +38,17 @@ export declare class BotController {
      */
     getBotDifficulty(type: string, difficulty: string): Difficulty;
     protected getPmcDifficultySettings(pmcType: "bear" | "usec", difficulty: string, usecType: string, bearType: string): Difficulty;
+    /**
+     * Generate bot profiles and store in cache
+     * @param sessionId Session id
+     * @param info bot generation request info
+     * @returns IBotBase array
+     */
     generate(sessionId: string, info: IGenerateBotsRequestData): IBotBase[];
+    /**
+     * Get the max number of bots allowed on a map
+     * Looks up location player is entering when getting cap value
+     * @returns cap number
+     */
     getBotCap(): number;
 }

types/controllers/DialogueController.d.ts

@@ -2,24 +2,77 @@ import { DialogueHelper } from "../helpers/DialogueHelper";
 import { IGetAllAttachmentsResponse } from "../models/eft/dialog/IGetAllAttachmentsResponse";
 import { IGetFriendListDataResponse } from "../models/eft/dialog/IGetFriendListDataResponse";
 import { IGetMailDialogViewResponseData } from "../models/eft/dialog/IGetMailDialogViewResponseData";
-import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData";
 import { DialogueInfo, Message } from "../models/eft/profile/IAkiProfile";
 import { SaveServer } from "../servers/SaveServer";
-import { HttpResponseUtil } from "../utils/HttpResponseUtil";
+import { TimeUtil } from "../utils/TimeUtil";
 export declare class DialogueController {
-    protected httpResponse: HttpResponseUtil;
     protected saveServer: SaveServer;
+    protected timeUtil: TimeUtil;
     protected dialogueHelper: DialogueHelper;
-    constructor(httpResponse: HttpResponseUtil, saveServer: SaveServer, dialogueHelper: DialogueHelper);
+    constructor(saveServer: SaveServer, timeUtil: TimeUtil, dialogueHelper: DialogueHelper);
+    update(): void;
     getFriendList(sessionID: string): IGetFriendListDataResponse;
-    generateDialogueList(sessionID: string): IGetBodyResponseData<DialogueInfo[]>;
+    /**
+     * Create array holding trader dialogs and mail interactions with player
+     * Set the content of the dialogue on the list tab.
+     * @param sessionID Session Id
+     * @returns array of dialogs
+     */
+    generateDialogueList(sessionID: string): DialogueInfo[];
+    /**
+     * Get the content of a dialogue
+     * @param dialogueID Dialog id
+     * @param sessionID Session Id
+     * @returns
+     */
     getDialogueInfo(dialogueID: string, sessionID: string): DialogueInfo;
+    /**
+     * Set the content of the dialogue on the details panel, showing all the messages
+     * for the specified dialogue.
+     * @param dialogueID Dialog id
+     * @param sessionID Session id
+     * @returns IGetMailDialogViewResponseData object
+     */
     generateDialogueView(dialogueID: string, sessionID: string): IGetMailDialogViewResponseData;
+    /**
+     * Get a count of messages with attachments from a particular dialog
+     * @param sessionID Session id
+     * @param dialogueID Dialog id
+     * @returns Count of messages with attachments
+     */
+    protected getUnreadMessagesWithAttachmentsCount(sessionID: string, dialogueID: string): number;
+    /**
+     * Does array have messages with uncollected rewards (includes expired rewards)
+     * @param messages Messages to check
+     * @returns true if uncollected rewards found
+     */
+    protected messagesHaveUncollectedRewards(messages: Message[]): boolean;
     removeDialogue(dialogueID: string, sessionID: string): void;
     setDialoguePin(dialogueID: string, shouldPin: boolean, sessionID: string): void;
     setRead(dialogueIDs: string[], sessionID: string): void;
+    /**
+     * Get all uncollected items attached to mail in a particular dialog
+     * @param dialogueID Dialog to get mail attachments from
+     * @param sessionID Session id
+     * @returns
+     */
     getAllAttachments(dialogueID: string, sessionID: string): IGetAllAttachmentsResponse;
-    protected messagesHaveUncollectedRewards(messages: Message[]): boolean;
+    /**
+     * Get messages from a specific dialog that have items not expired
+     * @param sessionId Session id
+     * @param dialogueId Dialog to get mail attachments from
+     * @returns Message array
+     */
+    protected getActiveMessagesFromDialog(sessionId: string, dialogueId: string): Message[];
+    /**
+     * Return array of messages with uncollected items (includes expired)
+     * @param messages Messages to parse
+     * @returns messages with items to collect
+     */
+    protected getMessagesWithAttachments(messages: Message[]): Message[];
+    /**
+     * Delete expired items. triggers when updating traders.
+     * @param sessionID Session id
+     */
     protected removeExpiredItems(sessionID: string): void;
-    update(): void;
 }

types/controllers/GameController.d.ts

@@ -1,27 +1,40 @@
+import { GameEventHelper } from "../helpers/GameEventHelper";
 import { HttpServerHelper } from "../helpers/HttpServerHelper";
 import { ProfileHelper } from "../helpers/ProfileHelper";
 import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData";
+import { Config } from "../models/eft/common/IGlobals";
 import { IGameConfigResponse } from "../models/eft/game/IGameConfigResponse";
 import { IAkiProfile } from "../models/eft/profile/IAkiProfile";
 import { ICoreConfig } from "../models/spt/config/ICoreConfig";
 import { IHttpConfig } from "../models/spt/config/IHttpConfig";
+import { ISeasonalEvent } from "../models/spt/config/ISeasonalEventConfig";
 import { ILogger } from "../models/spt/utils/ILogger";
 import { ConfigServer } from "../servers/ConfigServer";
+import { DatabaseServer } from "../servers/DatabaseServer";
 import { LocaleService } from "../services/LocaleService";
 import { ProfileFixerService } from "../services/ProfileFixerService";
 import { Watermark } from "../utils/Watermark";
 export declare class GameController {
     protected logger: ILogger;
+    protected databaseServer: DatabaseServer;
     protected watermark: Watermark;
     protected httpServerHelper: HttpServerHelper;
     protected localeService: LocaleService;
     protected profileHelper: ProfileHelper;
     protected profileFixerService: ProfileFixerService;
+    protected gameEventHelper: GameEventHelper;
     protected configServer: ConfigServer;
     protected httpConfig: IHttpConfig;
     protected coreConfig: ICoreConfig;
-    constructor(logger: ILogger, watermark: Watermark, httpServerHelper: HttpServerHelper, localeService: LocaleService, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, configServer: ConfigServer);
+    constructor(logger: ILogger, databaseServer: DatabaseServer, watermark: Watermark, httpServerHelper: HttpServerHelper, localeService: LocaleService, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, gameEventHelper: GameEventHelper, configServer: ConfigServer);
     gameStart(_url: string, _info: IEmptyRequestData, sessionID: string): void;
+    protected checkForAndEnableSeasonalEvents(seasonalEvents: ISeasonalEvent[]): void;
+    protected updateGlobalEvents(globalConfig: Config, eventName: string): void;
+    protected enableDancingTree(): void;
+    /**
+     * Make non-trigger-spawned raiders spawn earlier + always
+     */
+    protected adjustLabsRaiderSpawnRate(): void;
     protected logProfileDetails(fullProfile: IAkiProfile): void;
     getGameConfig(sessionID: string): IGameConfigResponse;
     getServer(): any[];

types/controllers/MatchController.d.ts

@@ -9,6 +9,7 @@ import { IGetProfileRequestData } from "../models/eft/match/IGetProfileRequestDa
 import { IJoinMatchRequestData } from "../models/eft/match/IJoinMatchRequestData";
 import { IJoinMatchResult } from "../models/eft/match/IJoinMatchResult";
 import { IStartOfflineRaidRequestData } from "../models/eft/match/IStartOffineRaidRequestData";
+import { BotDifficulty } from "../models/enums/BotDifficulty";
 import { IBotConfig } from "../models/spt/config/IBotConfig";
 import { IInRaidConfig } from "../models/spt/config/IInRaidConfig";
 import { IMatchConfig } from "../models/spt/config/IMatchConfig";
@@ -44,5 +45,11 @@ export declare class MatchController {
     protected getMatch(location: string): any;
     getGroupStatus(info: IGetGroupStatusRequestData): any;
     startOfflineRaid(info: IStartOfflineRaidRequestData, sessionID: string): void;
+    /**
+     * Convert a difficulty value from pre-raid screen to a bot difficulty
+     * @param botDifficulty dropdown difficulty
+     * @returns bot difficulty
+     */
+    protected convertDifficultyDropdownIntoBotDifficulty(botDifficulty: BotDifficulty): string;
     endOfflineRaid(info: IEndOfflineRaidRequestData, sessionID: string): void;
 }

types/controllers/RagfairController.d.ts

@@ -12,6 +12,7 @@ import { RagfairTaxHelper } from "../helpers/RagfairTaxHelper";
 import { TraderHelper } from "../helpers/TraderHelper";
 import { IPmcData } from "../models/eft/common/IPmcData";
 import { Item } from "../models/eft/common/tables/IItem";
+import { ITraderAssort } from "../models/eft/common/tables/ITrader";
 import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse";
 import { IAkiProfile } from "../models/eft/profile/IAkiProfile";
 import { IAddOfferRequestData, Requirement } from "../models/eft/ragfair/IAddOfferRequestData";
@@ -65,6 +66,35 @@ export declare class RagfairController {
     protected ragfairConfig: IRagfairConfig;
     constructor(logger: ILogger, timeUtil: TimeUtil, httpResponse: HttpResponseUtil, itemEventRouter: ItemEventRouter, ragfairServer: RagfairServer, ragfairPriceService: RagfairPriceService, databaseServer: DatabaseServer, itemHelper: ItemHelper, saveServer: SaveServer, ragfairSellHelper: RagfairSellHelper, ragfairTaxHelper: RagfairTaxHelper, ragfairSortHelper: RagfairSortHelper, ragfairOfferHelper: RagfairOfferHelper, profileHelper: ProfileHelper, paymentService: PaymentService, handbookHelper: HandbookHelper, paymentHelper: PaymentHelper, inventoryHelper: InventoryHelper, traderHelper: TraderHelper, ragfairHelper: RagfairHelper, ragfairOfferService: RagfairOfferService, ragfairRequiredItemsService: RagfairRequiredItemsService, ragfairOfferGenerator: RagfairOfferGenerator, configServer: ConfigServer);
     getOffers(sessionID: string, info: ISearchRequestData): IGetOffersResult;
+    /**
+     * Get offers for the client based on type of search being performed
+     * @param searchRequest Client search request data
+     * @param itemsToAdd
+     * @param assorts
+     * @param pmcProfile Player profile
+     * @returns array of offers
+     */
+    protected getOffersForSearchType(searchRequest: ISearchRequestData, itemsToAdd: string[], assorts: Record<string, ITraderAssort>, pmcProfile: IPmcData): IRagfairOffer[];
+    /**
+     * Get categories for the type of search being performed, linked/required/all
+     * @param searchRequest Client search request data
+     * @param offers ragfair offers to get categories for
+     * @returns record with tpls + counts
+     */
+    protected getSpecificCategories(searchRequest: ISearchRequestData, offers: IRagfairOffer[]): Record<string, number>;
+    /**
+     * Add Required offers to offers result
+     * @param searchRequest Client search request data
+     * @param assorts
+     * @param pmcProfile Player profile
+     * @param result Result object being sent back to client
+     */
+    protected addRequiredOffersToResult(searchRequest: ISearchRequestData, assorts: Record<string, ITraderAssort>, pmcProfile: IPmcData, result: IGetOffersResult): void;
+    /**
+     * Add index to all offers passed in (0-indexed)
+     * @param offers Offers to add index value to
+     */
+    protected addIndexValueToOffers(offers: IRagfairOffer[]): void;
     /**
      * Update a trader flea offer with buy restrictions stored in the traders assort
      * @param offer flea offer to update

types/controllers/RepairController.d.ts

@@ -8,9 +8,9 @@ import { ITraderRepairActionDataRequest } from "../models/eft/repair/ITraderRepa
 import { IRepairConfig } from "../models/spt/config/IRepairConfig";
 import { ILogger } from "../models/spt/utils/ILogger";
 import { ItemEventRouter } from "../routers/ItemEventRouter";
-import { ConfigServer } from "../servers/ConfigServer";
 import { DatabaseServer } from "../servers/DatabaseServer";
 import { PaymentService } from "../services/PaymentService";
+import { RepairService } from "../services/RepairService";
 export declare class RepairController {
     protected logger: ILogger;
     protected itemEventRouter: ItemEventRouter;
@@ -19,23 +19,23 @@ export declare class RepairController {
     protected traderHelper: TraderHelper;
     protected paymentService: PaymentService;
     protected repairHelper: RepairHelper;
-    protected configServer: ConfigServer;
+    protected repairService: RepairService;
     protected repairConfig: IRepairConfig;
-    constructor(logger: ILogger, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, questHelper: QuestHelper, traderHelper: TraderHelper, paymentService: PaymentService, repairHelper: RepairHelper, configServer: ConfigServer);
+    constructor(logger: ILogger, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, questHelper: QuestHelper, traderHelper: TraderHelper, paymentService: PaymentService, repairHelper: RepairHelper, repairService: RepairService);
     /**
      * Repair with trader
-     * @param pmcData player profile
-     * @param body endpoint request data
      * @param sessionID session id
+     * @param body endpoint request data
+     * @param pmcData player profile
      * @returns item event router action
      */
-    traderRepair(pmcData: IPmcData, body: ITraderRepairActionDataRequest, sessionID: string): IItemEventRouterResponse;
+    traderRepair(sessionID: string, body: ITraderRepairActionDataRequest, pmcData: IPmcData): IItemEventRouterResponse;
     /**
      * Repair with repair kit
-     * @param pmcData player profile
-     * @param body endpoint request data
      * @param sessionID session id
+     * @param body endpoint request data
+     * @param pmcData player profile
      * @returns item event router action
      */
-    repairWithKit(pmcData: IPmcData, body: IRepairActionDataRequest, sessionID: string): IItemEventRouterResponse;
+    repairWithKit(sessionID: string, body: IRepairActionDataRequest, pmcData: IPmcData): IItemEventRouterResponse;
 }