diff --git a/types/callbacks/DataCallbacks.d.ts b/types/callbacks/DataCallbacks.d.ts index a9bc1d6..26f5899 100644 --- a/types/callbacks/DataCallbacks.d.ts +++ b/types/callbacks/DataCallbacks.d.ts @@ -65,5 +65,10 @@ export declare class DataCallbacks { * Handle client/hideout/qte/list */ getQteList(url: string, info: IEmptyRequestData, sessionID: string): string; + /** + * Handle client/items/prices/ + * Called when viewing a traders assorts + * TODO - fully implement this + */ getItemPrices(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; } diff --git a/types/callbacks/DialogueCallbacks.d.ts b/types/callbacks/DialogueCallbacks.d.ts index 862c029..63d7163 100644 --- a/types/callbacks/DialogueCallbacks.d.ts +++ b/types/callbacks/DialogueCallbacks.d.ts @@ -21,7 +21,7 @@ import { DialogueInfo } from "../models/eft/profile/IAkiProfile"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { TimeUtil } from "../utils/TimeUtil"; -export declare class DialogueCallbacks extends OnUpdate { +export declare class DialogueCallbacks implements OnUpdate { protected hashUtil: HashUtil; protected timeUtil: TimeUtil; protected httpResponse: HttpResponseUtil; diff --git a/types/callbacks/HandbookCallbacks.d.ts b/types/callbacks/HandbookCallbacks.d.ts index 1bb6241..6bd3909 100644 --- a/types/callbacks/HandbookCallbacks.d.ts +++ b/types/callbacks/HandbookCallbacks.d.ts @@ -1,6 +1,6 @@ import { HandbookController } from "../controllers/HandbookController"; import { OnLoad } from "../di/OnLoad"; -export declare class HandbookCallbacks extends OnLoad { +export declare class HandbookCallbacks implements OnLoad { protected handbookController: HandbookController; constructor(handbookController: HandbookController); onLoad(): Promise; diff --git a/types/callbacks/HideoutCallbacks.d.ts b/types/callbacks/HideoutCallbacks.d.ts index 1d44bcc..d0247f9 100644 --- a/types/callbacks/HideoutCallbacks.d.ts +++ b/types/callbacks/HideoutCallbacks.d.ts @@ -2,7 +2,7 @@ import { HideoutController } from "../controllers/HideoutController"; import { OnUpdate } from "../di/OnUpdate"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IHandleQTEEventRequestData } from "../models/eft/hideout/IHandleQTEEventRequestData"; -import { IHideoutContinousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinuousProductionStartRequestData"; import { IHideoutImproveAreaRequestData } from "../models/eft/hideout/IHideoutImproveAreaRequestData"; import { IHideoutPutItemInRequestData } from "../models/eft/hideout/IHideoutPutItemInRequestData"; import { IHideoutScavCaseStartRequestData } from "../models/eft/hideout/IHideoutScavCaseStartRequestData"; @@ -16,7 +16,7 @@ import { IRecordShootingRangePoints } from "../models/eft/hideout/IRecordShootin import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IHideoutConfig } from "../models/spt/config/IHideoutConfig"; import { ConfigServer } from "../servers/ConfigServer"; -export declare class HideoutCallbacks extends OnUpdate { +export declare class HideoutCallbacks implements OnUpdate { protected hideoutController: HideoutController; protected configServer: ConfigServer; protected hideoutConfig: IHideoutConfig; @@ -24,34 +24,18 @@ export declare class HideoutCallbacks extends OnUpdate { configServer: ConfigServer); /** * Handle HideoutUpgrade - * @param pmcData - * @param body - * @param sessionID - * @returns */ upgrade(pmcData: IPmcData, body: IHideoutUpgradeRequestData, sessionID: string): IItemEventRouterResponse; /** * Handle HideoutUpgradeComplete - * @param pmcData - * @param body - * @param sessionID - * @returns */ upgradeComplete(pmcData: IPmcData, body: IHideoutUpgradeCompleteRequestData, sessionID: string): IItemEventRouterResponse; /** * Handle HideoutPutItemsInAreaSlots - * @param pmcData - * @param body - * @param sessionID - * @returns */ putItemsInAreaSlots(pmcData: IPmcData, body: IHideoutPutItemInRequestData, sessionID: string): IItemEventRouterResponse; /** * Handle HideoutTakeItemsFromAreaSlots - * @param pmcData - * @param body - * @param sessionID - * @returns */ takeItemsFromAreaSlots(pmcData: IPmcData, body: IHideoutTakeItemOutRequestData, sessionID: string): IItemEventRouterResponse; /** @@ -69,7 +53,7 @@ export declare class HideoutCallbacks extends OnUpdate { /** * Handle HideoutContinuousProductionStart */ - continuousProductionStart(pmcData: IPmcData, body: IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + continuousProductionStart(pmcData: IPmcData, body: IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** * Handle HideoutTakeProduction */ diff --git a/types/callbacks/HttpCallbacks.d.ts b/types/callbacks/HttpCallbacks.d.ts index 299a32c..10794fa 100644 --- a/types/callbacks/HttpCallbacks.d.ts +++ b/types/callbacks/HttpCallbacks.d.ts @@ -1,6 +1,6 @@ import { OnLoad } from "../di/OnLoad"; import { HttpServer } from "../servers/HttpServer"; -export declare class HttpCallbacks extends OnLoad { +export declare class HttpCallbacks implements OnLoad { protected httpServer: HttpServer; constructor(httpServer: HttpServer); onLoad(): Promise; diff --git a/types/callbacks/InsuranceCallbacks.d.ts b/types/callbacks/InsuranceCallbacks.d.ts index 11aef4a..aea0756 100644 --- a/types/callbacks/InsuranceCallbacks.d.ts +++ b/types/callbacks/InsuranceCallbacks.d.ts @@ -10,7 +10,7 @@ import { IInsuranceConfig } from "../models/spt/config/IInsuranceConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { InsuranceService } from "../services/InsuranceService"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -export declare class InsuranceCallbacks extends OnUpdate { +export declare class InsuranceCallbacks implements OnUpdate { protected insuranceController: InsuranceController; protected insuranceService: InsuranceService; protected httpResponse: HttpResponseUtil; diff --git a/types/callbacks/ModCallbacks.d.ts b/types/callbacks/ModCallbacks.d.ts index 9ebb750..d1ec7f7 100644 --- a/types/callbacks/ModCallbacks.d.ts +++ b/types/callbacks/ModCallbacks.d.ts @@ -6,7 +6,7 @@ import { ConfigServer } from "../servers/ConfigServer"; import { LocalisationService } from "../services/LocalisationService"; import { HttpFileUtil } from "../utils/HttpFileUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -declare class ModCallbacks extends OnLoad { +declare class ModCallbacks implements OnLoad { protected logger: ILogger; protected httpResponse: HttpResponseUtil; protected httpFileUtil: HttpFileUtil; @@ -17,8 +17,5 @@ declare class ModCallbacks extends OnLoad { constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpFileUtil: HttpFileUtil, postAkiModLoader: PostAkiModLoader, localisationService: LocalisationService, configServer: ConfigServer); onLoad(): Promise; getRoute(): string; - sendBundle(sessionID: string, req: any, resp: any, body: any): void; - getBundles(url: string, info: any, sessionID: string): string; - getBundle(url: string, info: any, sessionID: string): string; } export { ModCallbacks }; diff --git a/types/callbacks/PresetCallbacks.d.ts b/types/callbacks/PresetCallbacks.d.ts index 681bb99..37bf4e8 100644 --- a/types/callbacks/PresetCallbacks.d.ts +++ b/types/callbacks/PresetCallbacks.d.ts @@ -1,6 +1,6 @@ import { PresetController } from "../controllers/PresetController"; import { OnLoad } from "../di/OnLoad"; -export declare class PresetCallbacks extends OnLoad { +export declare class PresetCallbacks implements OnLoad { protected presetController: PresetController; constructor(presetController: PresetController); onLoad(): Promise; diff --git a/types/callbacks/RagfairCallbacks.d.ts b/types/callbacks/RagfairCallbacks.d.ts index de46b37..97713e7 100644 --- a/types/callbacks/RagfairCallbacks.d.ts +++ b/types/callbacks/RagfairCallbacks.d.ts @@ -1,5 +1,6 @@ +import { OnLoad } from "../di/OnLoad"; +import { OnUpdate } from "../di/OnUpdate"; import { RagfairController } from "../controllers/RagfairController"; -import { OnLoadOnUpdate } from "../di/OnLoadOnUpdate"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; @@ -21,7 +22,7 @@ import { JsonUtil } from "../utils/JsonUtil"; /** * Handle ragfair related callback events */ -export declare class RagfairCallbacks extends OnLoadOnUpdate { +export declare class RagfairCallbacks implements OnLoad, OnUpdate { protected httpResponse: HttpResponseUtil; protected jsonUtil: JsonUtil; protected ragfairServer: RagfairServer; diff --git a/types/callbacks/SaveCallbacks.d.ts b/types/callbacks/SaveCallbacks.d.ts index ab29ddc..93ffd96 100644 --- a/types/callbacks/SaveCallbacks.d.ts +++ b/types/callbacks/SaveCallbacks.d.ts @@ -1,6 +1,7 @@ -import { OnLoadOnUpdate } from "../di/OnLoadOnUpdate"; +import { OnLoad } from "../di/OnLoad"; +import { OnUpdate } from "../di/OnUpdate"; import { SaveServer } from "../servers/SaveServer"; -export declare class SaveCallbacks extends OnLoadOnUpdate { +export declare class SaveCallbacks implements OnLoad, OnUpdate { protected saveServer: SaveServer; constructor(saveServer: SaveServer); onLoad(): Promise; diff --git a/types/callbacks/TradeCallbacks.d.ts b/types/callbacks/TradeCallbacks.d.ts index 272ae46..4291da8 100644 --- a/types/callbacks/TradeCallbacks.d.ts +++ b/types/callbacks/TradeCallbacks.d.ts @@ -6,6 +6,9 @@ import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRag export declare class TradeCallbacks { protected tradeController: TradeController; constructor(tradeController: TradeController); + /** + * Handle client/game/profile/items/moving TradingConfirm + */ processTrade(pmcData: IPmcData, body: IProcessBaseTradeRequestData, sessionID: string): IItemEventRouterResponse; processRagfairTrade(pmcData: IPmcData, body: IProcessRagfairTradeRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/callbacks/TraderCallbacks.d.ts b/types/callbacks/TraderCallbacks.d.ts index 1efde87..8df1049 100644 --- a/types/callbacks/TraderCallbacks.d.ts +++ b/types/callbacks/TraderCallbacks.d.ts @@ -1,10 +1,11 @@ +import { OnLoad } from "../di/OnLoad"; +import { OnUpdate } from "../di/OnUpdate"; import { TraderController } from "../controllers/TraderController"; -import { OnLoadOnUpdate } from "../di/OnLoadOnUpdate"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IBarterScheme, ITraderAssort, ITraderBase } from "../models/eft/common/tables/ITrader"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -export declare class TraderCallbacks extends OnLoadOnUpdate { +export declare class TraderCallbacks implements OnLoad, OnUpdate { protected httpResponse: HttpResponseUtil; protected traderController: TraderController; constructor(httpResponse: HttpResponseUtil, traderController: TraderController); diff --git a/types/controllers/BotController.d.ts b/types/controllers/BotController.d.ts index a80aaed..1d7eb9d 100644 --- a/types/controllers/BotController.d.ts +++ b/types/controllers/BotController.d.ts @@ -3,7 +3,6 @@ import { BotGenerator } from "../generators/BotGenerator"; import { BotDifficultyHelper } from "../helpers/BotDifficultyHelper"; import { BotHelper } from "../helpers/BotHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; -import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { IGenerateBotsRequestData } from "../models/eft/bot/IGenerateBotsRequestData"; import { IBotBase } from "../models/eft/common/tables/IBotBase"; import { IBotCore } from "../models/eft/common/tables/IBotCore"; @@ -23,14 +22,13 @@ export declare class BotController { protected botDifficultyHelper: BotDifficultyHelper; protected botGenerationCacheService: BotGenerationCacheService; protected localisationService: LocalisationService; - protected weightedRandomHelper: WeightedRandomHelper; protected profileHelper: ProfileHelper; protected configServer: ConfigServer; protected applicationContext: ApplicationContext; protected jsonUtil: JsonUtil; protected botConfig: IBotConfig; static readonly pmcTypeLabel = "PMC"; - constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, botGenerationCacheService: BotGenerationCacheService, localisationService: LocalisationService, weightedRandomHelper: WeightedRandomHelper, profileHelper: ProfileHelper, configServer: ConfigServer, applicationContext: ApplicationContext, jsonUtil: JsonUtil); + constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, botGenerationCacheService: BotGenerationCacheService, localisationService: LocalisationService, profileHelper: ProfileHelper, configServer: ConfigServer, applicationContext: ApplicationContext, jsonUtil: JsonUtil); /** * Return the number of bot loadout varieties to be generated * @param type bot Type we want the loadout gen count for diff --git a/types/controllers/GameController.d.ts b/types/controllers/GameController.d.ts index a153072..44264dc 100644 --- a/types/controllers/GameController.d.ts +++ b/types/controllers/GameController.d.ts @@ -11,10 +11,13 @@ import { IServerDetails } from "../models/eft/game/IServerDetails"; import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { ICoreConfig } from "../models/spt/config/ICoreConfig"; import { IHttpConfig } from "../models/spt/config/IHttpConfig"; +import { ILocationConfig } from "../models/spt/config/ILocationConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { CustomLocationWaveService } from "../services/CustomLocationWaveService"; import { LocalisationService } from "../services/LocalisationService"; +import { OpenZoneService } from "../services/OpenZoneService"; import { ProfileFixerService } from "../services/ProfileFixerService"; import { SeasonalEventService } from "../services/SeasonalEventService"; import { TimeUtil } from "../utils/TimeUtil"; @@ -28,13 +31,30 @@ export declare class GameController { protected profileHelper: ProfileHelper; protected profileFixerService: ProfileFixerService; protected localisationService: LocalisationService; + protected customLocationWaveService: CustomLocationWaveService; + protected openZoneService: OpenZoneService; protected seasonalEventService: SeasonalEventService; protected applicationContext: ApplicationContext; protected configServer: ConfigServer; protected httpConfig: IHttpConfig; protected coreConfig: ICoreConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, timeUtil: TimeUtil, preAkiModLoader: PreAkiModLoader, httpServerHelper: HttpServerHelper, hideoutHelper: HideoutHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, localisationService: LocalisationService, seasonalEventService: SeasonalEventService, applicationContext: ApplicationContext, configServer: ConfigServer); + protected locationConfig: ILocationConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, timeUtil: TimeUtil, preAkiModLoader: PreAkiModLoader, httpServerHelper: HttpServerHelper, hideoutHelper: HideoutHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, localisationService: LocalisationService, customLocationWaveService: CustomLocationWaveService, openZoneService: OpenZoneService, seasonalEventService: SeasonalEventService, applicationContext: ApplicationContext, configServer: ConfigServer); gameStart(_url: string, _info: IEmptyRequestData, sessionID: string, startTimeStampMS: number): void; + /** + * When player logs in, iterate over all active effects and reduce timer + * TODO - add body part HP regen + * @param pmcProfile + */ + protected updateProfileHealthValues(pmcProfile: IPmcData): void; + /** + * Waves with an identical min/max values spawn nothing, the number of bots that spawn is the difference between min and max + */ + protected fixBrokenOfflineMapWaves(): void; + /** + * Make Rogues spawn later to allow for scavs to spawn first instead of rogues filling up all spawn positions + */ + protected fixRoguesSpawningInstantlyOnLighthouse(): void; /** * Get a list of installed mods and save their details to the profile being used * @param fullProfile Profile to add mod details to diff --git a/types/controllers/HealthController.d.ts b/types/controllers/HealthController.d.ts index 5e6d8ff..7c149cc 100644 --- a/types/controllers/HealthController.d.ts +++ b/types/controllers/HealthController.d.ts @@ -2,25 +2,27 @@ import { HealthHelper } from "../helpers/HealthHelper"; import { InventoryHelper } from "../helpers/InventoryHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { IWorkoutData } from "../models/eft/health/IWorkoutData"; import { IHealthTreatmentRequestData } from "../models/eft/health/IHealthTreatmentRequestData"; import { IOffraidEatRequestData } from "../models/eft/health/IOffraidEatRequestData"; import { IOffraidHealRequestData } from "../models/eft/health/IOffraidHealRequestData"; import { ISyncHealthRequestData } from "../models/eft/health/ISyncHealthRequestData"; +import { IWorkoutData } from "../models/eft/health/IWorkoutData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { ILogger } from "../models/spt/utils/ILogger"; import { EventOutputHolder } from "../routers/EventOutputHolder"; import { LocalisationService } from "../services/LocalisationService"; import { PaymentService } from "../services/PaymentService"; +import { JsonUtil } from "../utils/JsonUtil"; export declare class HealthController { protected logger: ILogger; + protected jsonUtil: JsonUtil; protected eventOutputHolder: EventOutputHolder; protected itemHelper: ItemHelper; protected paymentService: PaymentService; protected inventoryHelper: InventoryHelper; protected localisationService: LocalisationService; protected healthHelper: HealthHelper; - constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, itemHelper: ItemHelper, paymentService: PaymentService, inventoryHelper: InventoryHelper, localisationService: LocalisationService, healthHelper: HealthHelper); + constructor(logger: ILogger, jsonUtil: JsonUtil, eventOutputHolder: EventOutputHolder, itemHelper: ItemHelper, paymentService: PaymentService, inventoryHelper: InventoryHelper, localisationService: LocalisationService, healthHelper: HealthHelper); /** * stores in-raid player health * @param pmcData Player profile @@ -37,6 +39,13 @@ export declare class HealthController { * @returns */ offraidHeal(pmcData: IPmcData, body: IOffraidHealRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Consume food/water outside of a raid + * @param pmcData Player profile + * @param body request Object + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ offraidEat(pmcData: IPmcData, body: IOffraidEatRequestData, sessionID: string): IItemEventRouterResponse; /** * Occurs on post-raid healing page @@ -54,10 +63,11 @@ export declare class HealthController { */ applyWorkoutChanges(pmcData: IPmcData, info: IWorkoutData, sessionId: string): void; /** - * iterate over treatment request diff and find effects to remove from player limbs + * Iterate over treatment request diff and find effects to remove from player limbs * @param sessionId * @param profile Profile to update * @param treatmentRequest client request + * @param output response to send to client */ - protected removeEffectsAfterPostRaidHeal(sessionId: string, profile: IPmcData, treatmentRequest: IHealthTreatmentRequestData): void; + protected removeEffectsAfterPostRaidHeal(sessionId: string, profile: IPmcData, treatmentRequest: IHealthTreatmentRequestData, output: IItemEventRouterResponse): void; } diff --git a/types/controllers/HideoutController.d.ts b/types/controllers/HideoutController.d.ts index 802207b..e6e0243 100644 --- a/types/controllers/HideoutController.d.ts +++ b/types/controllers/HideoutController.d.ts @@ -8,7 +8,7 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { HideoutArea, Product } from "../models/eft/common/tables/IBotBase"; import { HideoutUpgradeCompleteRequestData } from "../models/eft/hideout/HideoutUpgradeCompleteRequestData"; import { IHandleQTEEventRequestData } from "../models/eft/hideout/IHandleQTEEventRequestData"; -import { IHideoutContinousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinuousProductionStartRequestData"; import { IHideoutImproveAreaRequestData } from "../models/eft/hideout/IHideoutImproveAreaRequestData"; import { IHideoutProduction } from "../models/eft/hideout/IHideoutProduction"; import { IHideoutPutItemInRequestData } from "../models/eft/hideout/IHideoutPutItemInRequestData"; @@ -27,6 +27,7 @@ import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; +import { FenceService } from "../services/FenceService"; import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; import { HashUtil } from "../utils/HashUtil"; @@ -53,12 +54,28 @@ export declare class HideoutController { protected localisationService: LocalisationService; protected configServer: ConfigServer; protected jsonUtil: JsonUtil; + protected fenceService: FenceService; protected static nameBackendCountersCrafting: string; protected hideoutConfig: IHideoutConfig; - constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, inventoryHelper: InventoryHelper, saveServer: SaveServer, playerService: PlayerService, presetHelper: PresetHelper, paymentHelper: PaymentHelper, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, hideoutHelper: HideoutHelper, scavCaseRewardGenerator: ScavCaseRewardGenerator, localisationService: LocalisationService, configServer: ConfigServer, jsonUtil: JsonUtil); - upgrade(pmcData: IPmcData, body: IHideoutUpgradeRequestData, sessionID: string): IItemEventRouterResponse; - upgradeComplete(pmcData: IPmcData, body: HideoutUpgradeCompleteRequestData, sessionID: string): IItemEventRouterResponse; + constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, inventoryHelper: InventoryHelper, saveServer: SaveServer, playerService: PlayerService, presetHelper: PresetHelper, paymentHelper: PaymentHelper, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, hideoutHelper: HideoutHelper, scavCaseRewardGenerator: ScavCaseRewardGenerator, localisationService: LocalisationService, configServer: ConfigServer, jsonUtil: JsonUtil, fenceService: FenceService); /** + * Start a hideout area upgrade + * @param pmcData Player profile + * @param request upgrade start request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + startUpgrade(pmcData: IPmcData, request: IHideoutUpgradeRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Complete a hideout area upgrade + * @param pmcData Player profile + * @param request Completed upgrade request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + upgradeComplete(pmcData: IPmcData, request: HideoutUpgradeCompleteRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutPutItemsInAreaSlots * Create item in hideout slot item array, remove item from player inventory * @param pmcData Profile data * @param addItemToHideoutRequest reqeust from client to place item in area slot @@ -66,7 +83,14 @@ export declare class HideoutController { * @returns IItemEventRouterResponse object */ putItemsInAreaSlots(pmcData: IPmcData, addItemToHideoutRequest: IHideoutPutItemInRequestData, sessionID: string): IItemEventRouterResponse; - takeItemsFromAreaSlots(pmcData: IPmcData, body: IHideoutTakeItemOutRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Remove item from hideout area and place into player inventory + * @param pmcData Player profile + * @param request Take item out of area request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + takeItemsFromAreaSlots(pmcData: IPmcData, request: IHideoutTakeItemOutRequestData, sessionID: string): IItemEventRouterResponse; /** * Find resource item in hideout area, add copy to player inventory, remove Item from hideout slot * @param sessionID Session id @@ -77,7 +101,21 @@ export declare class HideoutController { * @returns IItemEventRouterResponse response */ protected removeResourceFromArea(sessionID: string, pmcData: IPmcData, removeResourceRequest: IHideoutTakeItemOutRequestData, output: IItemEventRouterResponse, hideoutArea: HideoutArea): IItemEventRouterResponse; - toggleArea(pmcData: IPmcData, body: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Toggle area on/off + * @param pmcData Player profile + * @param request Toggle area request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + toggleArea(pmcData: IPmcData, request: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Start production for an item from hideout area + * @param pmcData Player profile + * @param body Start prodution of single item request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ singleProductionStart(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** * Handles event after clicking 'start' on the scav case hideout page @@ -87,6 +125,14 @@ export declare class HideoutController { * @returns item event router response */ scavCaseProductionStart(pmcData: IPmcData, body: IHideoutScavCaseStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Adjust scav case time based on fence standing + * + * @param pmcData Player profile + * @param productionTime Time to complete scav case in seconds + * @returns Adjusted scav case time in seconds + */ + protected getScavCaseTime(pmcData: IPmcData, productionTime: number): number; /** * Add generated scav case rewards to player profile * @param pmcData player profile to add rewards to @@ -94,19 +140,49 @@ export declare class HideoutController { * @param recipieId recipie id to save into Production dict */ protected addScavCaseRewardsToProfile(pmcData: IPmcData, rewards: Product[], recipieId: string): void; - continuousProductionStart(pmcData: IPmcData, body: IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; - takeProduction(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; - protected handleRecipie(sessionID: string, recipe: IHideoutProduction, pmcData: IPmcData, body: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; + /** + * Start production of continuously created item + * @param pmcData Player profile + * @param request Continious production request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + continuousProductionStart(pmcData: IPmcData, request: IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Take completed item out of hideout area and place into player inventory + * @param pmcData Player profile + * @param request Remove production from area request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + takeProduction(pmcData: IPmcData, request: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Take recipie-type production out of hideout area and place into player inventory + * @param sessionID Session id + * @param recipe Completed recipie of item + * @param pmcData Player profile + * @param request Remove production from area request + * @param output Output object to update + * @returns IItemEventRouterResponse + */ + protected handleRecipie(sessionID: string, recipe: IHideoutProduction, pmcData: IPmcData, request: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; /** * Handles giving rewards stored in player profile to player after clicking 'get rewards' - * @param sessionID - * @param pmcData - * @param body - * @param output - * @returns + * @param sessionID Session id + * @param pmcData Player profile + * @param request Get rewards from scavcase craft request + * @param output Output object to update + * @returns IItemEventRouterResponse */ - protected handleScavCase(sessionID: string, pmcData: IPmcData, body: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; - registerProduction(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData | IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + protected handleScavCase(sessionID: string, pmcData: IPmcData, request: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; + /** + * Start area production for item + * @param pmcData Player profile + * @param request Start production request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + registerProduction(pmcData: IPmcData, request: IHideoutSingleProductionStartRequestData | IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** * Get quick time event list for hideout * // TODO - implement this @@ -137,5 +213,8 @@ export declare class HideoutController { * @param request improve area request data */ improveArea(sessionId: string, pmcData: IPmcData, request: IHideoutImproveAreaRequestData): IItemEventRouterResponse; + /** + * Function called every x seconds as part of onUpdate event + */ update(): void; } diff --git a/types/controllers/InsuranceController.d.ts b/types/controllers/InsuranceController.d.ts index 54f31b5..af6e68d 100644 --- a/types/controllers/InsuranceController.d.ts +++ b/types/controllers/InsuranceController.d.ts @@ -31,13 +31,23 @@ export declare class InsuranceController { protected configServer: ConfigServer; protected insuranceConfig: IInsuranceConfig; constructor(logger: ILogger, randomUtil: RandomUtil, eventOutputHolder: EventOutputHolder, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileHelper: ProfileHelper, dialogueHelper: DialogueHelper, paymentService: PaymentService, insuranceService: InsuranceService, configServer: ConfigServer); + /** + * Process insurance items prior to being given to player in mail + */ processReturn(): void; + /** + * Add insurance to an item + * @param pmcData Player profile + * @param body Insurance request + * @param sessionID Session id + * @returns IItemEventRouterResponse object to send to client + */ insure(pmcData: IPmcData, body: IInsureRequestData, sessionID: string): IItemEventRouterResponse; /** * Calculate insurance cost * @param info request object * @param sessionID session id - * @returns response object to send to client + * @returns IGetInsuranceCostResponseData object to send to client */ cost(info: IGetInsuranceCostRequestData, sessionID: string): IGetInsuranceCostResponseData; } diff --git a/types/controllers/MatchController.d.ts b/types/controllers/MatchController.d.ts index e732dfd..cb0c755 100644 --- a/types/controllers/MatchController.d.ts +++ b/types/controllers/MatchController.d.ts @@ -17,9 +17,7 @@ import { ConfigServer } from "../servers/ConfigServer"; import { SaveServer } from "../servers/SaveServer"; import { BotGenerationCacheService } from "../services/BotGenerationCacheService"; import { BotLootCacheService } from "../services/BotLootCacheService"; -import { CustomLocationWaveService } from "../services/CustomLocationWaveService"; import { MatchLocationService } from "../services/MatchLocationService"; -import { OpenZoneService } from "../services/OpenZoneService"; import { ProfileSnapshotService } from "../services/ProfileSnapshotService"; export declare class MatchController { protected logger: ILogger; @@ -30,14 +28,12 @@ export declare class MatchController { protected botLootCacheService: BotLootCacheService; protected configServer: ConfigServer; protected profileSnapshotService: ProfileSnapshotService; - protected customLocationWaveService: CustomLocationWaveService; - protected openZoneService: OpenZoneService; protected botGenerationCacheService: BotGenerationCacheService; protected applicationContext: ApplicationContext; protected matchConfig: IMatchConfig; protected inraidConfig: IInRaidConfig; protected botConfig: IBotConfig; - constructor(logger: ILogger, saveServer: SaveServer, profileHelper: ProfileHelper, matchLocationService: MatchLocationService, traderHelper: TraderHelper, botLootCacheService: BotLootCacheService, configServer: ConfigServer, profileSnapshotService: ProfileSnapshotService, customLocationWaveService: CustomLocationWaveService, openZoneService: OpenZoneService, botGenerationCacheService: BotGenerationCacheService, applicationContext: ApplicationContext); + constructor(logger: ILogger, saveServer: SaveServer, profileHelper: ProfileHelper, matchLocationService: MatchLocationService, traderHelper: TraderHelper, botLootCacheService: BotLootCacheService, configServer: ConfigServer, profileSnapshotService: ProfileSnapshotService, botGenerationCacheService: BotGenerationCacheService, applicationContext: ApplicationContext); getEnabled(): boolean; getProfile(info: IGetProfileRequestData): IPmcData[]; createGroup(sessionID: string, info: ICreateGroupRequestData): any; diff --git a/types/controllers/QuestController.d.ts b/types/controllers/QuestController.d.ts index 3f8f96f..fe1754d 100644 --- a/types/controllers/QuestController.d.ts +++ b/types/controllers/QuestController.d.ts @@ -102,6 +102,13 @@ export declare class QuestController { * @param questRewards Rewards given to player */ protected sendSuccessDialogMessageOnQuestComplete(sessionID: string, pmcData: IPmcData, completedQuestId: string, questRewards: Reward[]): void; + /** + * Look for newly available quests after completing a quest with a requirement to wait x minutes (time-locked) before being available and add data to profile + * @param pmcData Player profile to update + * @param quests Quests to look for wait conditions in + * @param completedQuestId Quest just completed + */ + protected addTimeLockedQuestsToProfile(pmcData: IPmcData, quests: IQuest[], completedQuestId: string): void; /** * Returns a list of quests that should be failed when a quest is completed * @param completedQuestId quest completed id diff --git a/types/controllers/RepeatableQuestController.d.ts b/types/controllers/RepeatableQuestController.d.ts index 2e443b9..dd8dc40 100644 --- a/types/controllers/RepeatableQuestController.d.ts +++ b/types/controllers/RepeatableQuestController.d.ts @@ -1,3 +1,4 @@ +import { HandbookHelper } from "../helpers/HandbookHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; @@ -65,6 +66,7 @@ export declare class RepeatableQuestController { protected presetHelper: PresetHelper; protected profileHelper: ProfileHelper; protected profileFixerService: ProfileFixerService; + protected handbookHelper: HandbookHelper; protected ragfairServerHelper: RagfairServerHelper; protected eventOutputHolder: EventOutputHolder; protected localisationService: LocalisationService; @@ -73,7 +75,7 @@ export declare class RepeatableQuestController { protected itemFilterService: ItemFilterService; protected configServer: ConfigServer; protected questConfig: IQuestConfig; - constructor(timeUtil: TimeUtil, logger: ILogger, randomUtil: RandomUtil, httpResponse: HttpResponseUtil, mathUtil: MathUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, itemHelper: ItemHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, ragfairServerHelper: RagfairServerHelper, eventOutputHolder: EventOutputHolder, localisationService: LocalisationService, paymentService: PaymentService, objectId: ObjectId, itemFilterService: ItemFilterService, configServer: ConfigServer); + constructor(timeUtil: TimeUtil, logger: ILogger, randomUtil: RandomUtil, httpResponse: HttpResponseUtil, mathUtil: MathUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, itemHelper: ItemHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, handbookHelper: HandbookHelper, ragfairServerHelper: RagfairServerHelper, eventOutputHolder: EventOutputHolder, localisationService: LocalisationService, paymentService: PaymentService, objectId: ObjectId, itemFilterService: ItemFilterService, configServer: ConfigServer); /** * This is the method reached by the /client/repeatalbeQuests/activityPeriods endpoint * Returns an array of objects in the format of repeatable quests to the client. @@ -115,17 +117,18 @@ export declare class RepeatableQuestController { /** * Just for debug reasons. Draws dailies a random assort of dailies extracted from dumps */ - generateDebugDailies(dailiesPool: any, factory: any, number: any): any; + generateDebugDailies(dailiesPool: any, factory: any, number: number): any; /** * Generates the base object of quest type format given as templates in assets/database/templates/repeatableQuests.json * The templates include Elimination, Completion and Extraction quest types * * @param {string} type quest type: "Elimination", "Completion" or "Extraction" * @param {string} traderId trader from which the quest will be provided + * @param {string} side scav daily or pmc daily/weekly quest * @returns {object} a object which contains the base elements for repeatable quests of the requests type * (needs to be filled with reward and conditions by called to make a valid quest) */ - generateRepeatableTemplate(type: string, traderId: string): IRepeatableQuest; + generateRepeatableTemplate(type: string, traderId: string, side: string): IRepeatableQuest; /** * Generates a valid Exploration quest * @@ -236,7 +239,7 @@ export declare class RepeatableQuestController { generateRewardItem(tpl: string, value: number, index: number, preset?: any): IReward; debugLogRepeatableQuestIds(pmcData: IPmcData): void; probabilityObjectArray(configArrayInput: ProbabilityObject[]): ProbabilityObjectArray; - changeRepeatableQuest(pmcDataIn: IPmcData, body: IRepeatableQuestChangeRequest, sessionID: string): IItemEventRouterResponse; + changeRepeatableQuest(pmcData: IPmcData, body: IRepeatableQuestChangeRequest, sessionID: string): IItemEventRouterResponse; /** * Picks rewardable items from items.json. This means they need to fit into the inventory and they shouldn't be keys (debatable) * @param repeatableQuestConfig config file diff --git a/types/controllers/TradeController.d.ts b/types/controllers/TradeController.d.ts index 6c35d66..dc7de19 100644 --- a/types/controllers/TradeController.d.ts +++ b/types/controllers/TradeController.d.ts @@ -1,22 +1,30 @@ -import { RagfairServer } from "../servers/RagfairServer"; +import { ItemHelper } from "../helpers/ItemHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { TradeHelper } from "../helpers/TradeHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRagfairTradeRequestData"; -import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { Upd } from "../models/eft/common/tables/IItem"; +import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IProcessBaseTradeRequestData } from "../models/eft/trade/IProcessBaseTradeRequestData"; -import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRagfairTradeRequestData"; +import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { ConfigServer } from "../servers/ConfigServer"; +import { RagfairServer } from "../servers/RagfairServer"; +import { LocalisationService } from "../services/LocalisationService"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; declare class TradeController { protected logger: ILogger; protected eventOutputHolder: EventOutputHolder; protected tradeHelper: TradeHelper; + protected itemHelper: ItemHelper; protected profileHelper: ProfileHelper; protected ragfairServer: RagfairServer; protected httpResponse: HttpResponseUtil; - constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, tradeHelper: TradeHelper, profileHelper: ProfileHelper, ragfairServer: RagfairServer, httpResponse: HttpResponseUtil); + protected localisationService: LocalisationService; + protected configServer: ConfigServer; + protected ragfairConfig: IRagfairConfig; + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, tradeHelper: TradeHelper, itemHelper: ItemHelper, profileHelper: ProfileHelper, ragfairServer: RagfairServer, httpResponse: HttpResponseUtil, localisationService: LocalisationService, configServer: ConfigServer); confirmTrading(pmcData: IPmcData, body: IProcessBaseTradeRequestData, sessionID: string, foundInRaid?: boolean, upd?: Upd): IItemEventRouterResponse; confirmRagfairTrading(pmcData: IPmcData, body: IProcessRagfairTradeRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/controllers/WishlistController.d.ts b/types/controllers/WishlistController.d.ts index 83be4b3..60c4a15 100644 --- a/types/controllers/WishlistController.d.ts +++ b/types/controllers/WishlistController.d.ts @@ -1,7 +1,7 @@ import { EventOutputHolder } from "../routers/EventOutputHolder"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { IWishlistActionData } from "../models/eft/wishlist/IWishlistActionData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +import { IWishlistActionData } from "../models/eft/wishlist/IWishlistActionData"; export declare class WishlistController { protected eventOutputHolder: EventOutputHolder; constructor(eventOutputHolder: EventOutputHolder); diff --git a/types/di/OnLoad.d.ts b/types/di/OnLoad.d.ts index 4a28f13..a5cdea3 100644 --- a/types/di/OnLoad.d.ts +++ b/types/di/OnLoad.d.ts @@ -1,4 +1,4 @@ -export declare class OnLoad { +export interface OnLoad { onLoad(): Promise; getRoute(): string; } diff --git a/types/di/OnLoadOnUpdate.d.ts b/types/di/OnLoadOnUpdate.d.ts deleted file mode 100644 index eaa297c..0000000 --- a/types/di/OnLoadOnUpdate.d.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { OnLoad } from "./OnLoad"; -import { OnUpdate } from "./OnUpdate"; -export declare class OnLoadOnUpdate implements OnLoad, OnUpdate { - onUpdate(timeSinceLastRun: number): Promise; - onLoad(): Promise; - getRoute(): string; -} diff --git a/types/di/OnUpdate.d.ts b/types/di/OnUpdate.d.ts index 6839719..e1ce375 100644 --- a/types/di/OnUpdate.d.ts +++ b/types/di/OnUpdate.d.ts @@ -1,4 +1,4 @@ -export declare class OnUpdate { +export interface OnUpdate { onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/generators/BotEquipmentModGenerator.d.ts b/types/generators/BotEquipmentModGenerator.d.ts index 5b937ca..6703a36 100644 --- a/types/generators/BotEquipmentModGenerator.d.ts +++ b/types/generators/BotEquipmentModGenerator.d.ts @@ -145,7 +145,7 @@ export declare class BotEquipmentModGenerator { * @param modToAdd template of mod to check * @param itemSlot slot the item will be placed in * @param modSlot slot the mod will fill - * @param parentTemplate tempalte of the mods parent item + * @param parentTemplate template of the mods parent item * @returns true if valid */ protected isModValidForSlot(modToAdd: [boolean, ITemplateItem], itemSlot: Slot, modSlot: string, parentTemplate: ITemplateItem): boolean; diff --git a/types/generators/BotGenerator.d.ts b/types/generators/BotGenerator.d.ts index 2675146..9581259 100644 --- a/types/generators/BotGenerator.d.ts +++ b/types/generators/BotGenerator.d.ts @@ -2,7 +2,7 @@ import { BotDifficultyHelper } from "../helpers/BotDifficultyHelper"; import { BotHelper } from "../helpers/BotHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; -import { Health as PmcHealth, IBotBase, Skills } from "../models/eft/common/tables/IBotBase"; +import { Health as PmcHealth, IBotBase, Info, Skills } from "../models/eft/common/tables/IBotBase"; import { Health, IBotType } from "../models/eft/common/tables/IBotType"; import { BotGenerationDetails } from "../models/spt/bots/BotGenerationDetails"; import { IBotConfig } from "../models/spt/config/IBotConfig"; @@ -90,6 +90,13 @@ export declare class BotGenerator { */ protected generateId(bot: IBotBase): IBotBase; protected generateInventoryID(profile: IBotBase): IBotBase; + /** + * Randomise a bots game version and account category + * Chooses from all the game versions (standard, eod etc) + * Chooses account type (default, Sherpa, etc) + * @param botInfo bot info object to update + */ + protected getRandomisedGameVersionAndCategory(botInfo: Info): void; /** * Add a side-specific (usec/bear) dogtag item to a bots inventory * @param bot bot to add dogtag to diff --git a/types/generators/BotLootGenerator.d.ts b/types/generators/BotLootGenerator.d.ts index 6273a11..a4ce4e0 100644 --- a/types/generators/BotLootGenerator.d.ts +++ b/types/generators/BotLootGenerator.d.ts @@ -1,6 +1,7 @@ import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper"; import { BotWeaponGeneratorHelper } from "../helpers/BotWeaponGeneratorHelper"; import { HandbookHelper } from "../helpers/HandbookHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; import { Inventory as PmcInventory } from "../models/eft/common/tables/IBotBase"; import { Chances, Inventory, ItemMinMax, ModsChances } from "../models/eft/common/tables/IBotType"; import { Item } from "../models/eft/common/tables/IItem"; @@ -18,6 +19,7 @@ export declare class BotLootGenerator { protected logger: ILogger; protected hashUtil: HashUtil; protected randomUtil: RandomUtil; + protected itemHelper: ItemHelper; protected databaseServer: DatabaseServer; protected handbookHelper: HandbookHelper; protected botGeneratorHelper: BotGeneratorHelper; @@ -27,7 +29,7 @@ export declare class BotLootGenerator { protected localisationService: LocalisationService; protected configServer: ConfigServer; protected botConfig: IBotConfig; - constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, botGeneratorHelper: BotGeneratorHelper, botWeaponGenerator: BotWeaponGenerator, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botLootCacheService: BotLootCacheService, localisationService: LocalisationService, configServer: ConfigServer); + constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, botGeneratorHelper: BotGeneratorHelper, botWeaponGenerator: BotWeaponGenerator, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botLootCacheService: BotLootCacheService, localisationService: LocalisationService, configServer: ConfigServer); /** * Add loot to bots containers * @param sessionId Session id diff --git a/types/generators/BotWeaponGenerator.d.ts b/types/generators/BotWeaponGenerator.d.ts index 71a2c5e..a68b82f 100644 --- a/types/generators/BotWeaponGenerator.d.ts +++ b/types/generators/BotWeaponGenerator.d.ts @@ -102,6 +102,13 @@ export declare class BotWeaponGenerator { * @param botRole The bot type we're getting generating extra mags for */ addExtraMagazinesToInventory(generatedWeaponResult: GenerateWeaponResult, magCounts: MinMax, inventory: PmcInventory, botRole: string): void; + /** + * Add Grendaes for UBGL to bots vest and secure container + * @param weaponMods Weapon array with mods + * @param generatedWeaponResult result of weapon generation + * @param inventory bot inventory to add grenades to + */ + protected addUbglGrenadesToBotInventory(weaponMods: Item[], generatedWeaponResult: GenerateWeaponResult, inventory: PmcInventory): void; /** * Add ammo to the secure container * @param stackCount How many stacks of ammo to add @@ -138,6 +145,13 @@ export declare class BotWeaponGenerator { * @param ammoTpl */ protected fillExistingMagazines(weaponMods: Item[], magazine: Item, ammoTpl: string): void; + /** + * Add desired ammo tpl as item to weaponmods array, placed as child to UBGL + * @param weaponMods + * @param ubglMod + * @param ubglAmmoTpl + */ + protected fillUbgl(weaponMods: Item[], ubglMod: Item, ubglAmmoTpl: string): void; /** * Add cartridge item to weapon Item array, if it already exists, update * @param weaponMods Weapon items array to amend diff --git a/types/generators/LocationGenerator.d.ts b/types/generators/LocationGenerator.d.ts index a80ae3c..a617048 100644 --- a/types/generators/LocationGenerator.d.ts +++ b/types/generators/LocationGenerator.d.ts @@ -49,7 +49,8 @@ export declare class LocationGenerator { * Add forced spawn point loot into loot parameter array * @param loot array to add forced loot to * @param forcedSpawnPoints forced loot to add + * @param name of map currently generating forced loot for */ - protected addForcedLoot(loot: SpawnpointTemplate[], forcedSpawnPoints: SpawnpointsForced[]): void; + protected addForcedLoot(loot: SpawnpointTemplate[], forcedSpawnPoints: SpawnpointsForced[], locationName: string): void; protected createItem(tpl: string, staticAmmoDist: Record, parentId?: string): IContainerItem; } diff --git a/types/generators/PMCLootGenerator.d.ts b/types/generators/PMCLootGenerator.d.ts index b9f2a83..10918e3 100644 --- a/types/generators/PMCLootGenerator.d.ts +++ b/types/generators/PMCLootGenerator.d.ts @@ -3,6 +3,7 @@ import { IBotConfig } from "../models/spt/config/IBotConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { ItemFilterService } from "../services/ItemFilterService"; +import { SeasonalEventService } from "../services/SeasonalEventService"; /** * Handle the generation of dynamic PMC loot in pockets and backpacks * and the removal of blacklisted items @@ -12,10 +13,19 @@ export declare class PMCLootGenerator { protected databaseServer: DatabaseServer; protected configServer: ConfigServer; protected itemFilterService: ItemFilterService; + protected seasonalEventService: SeasonalEventService; protected pocketLootPool: string[]; protected backpackLootPool: string[]; protected botConfig: IBotConfig; - constructor(itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer, itemFilterService: ItemFilterService); + constructor(itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer, itemFilterService: ItemFilterService, seasonalEventService: SeasonalEventService); + /** + * Create an array of loot items a PMC can have in their pockets + * @returns string array of tpls + */ generatePMCPocketLootPool(): string[]; + /** + * Create an array of loot items a PMC can have in their backpack + * @returns string array of tpls + */ generatePMCBackpackLootPool(): string[]; } diff --git a/types/generators/PlayerScavGenerator.d.ts b/types/generators/PlayerScavGenerator.d.ts index 9fee88b..3641268 100644 --- a/types/generators/PlayerScavGenerator.d.ts +++ b/types/generators/PlayerScavGenerator.d.ts @@ -1,4 +1,7 @@ +import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper"; import { BotHelper } from "../helpers/BotHelper"; +import { BotWeaponGeneratorHelper } from "../helpers/BotWeaponGeneratorHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { Skills, Stats } from "../models/eft/common/tables/IBotBase"; @@ -11,11 +14,18 @@ import { SaveServer } from "../servers/SaveServer"; import { BotLootCacheService } from "../services/BotLootCacheService"; import { FenceService } from "../services/FenceService"; import { LocalisationService } from "../services/LocalisationService"; +import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; import { BotGenerator } from "./BotGenerator"; export declare class PlayerScavGenerator { protected logger: ILogger; + protected randomUtil: RandomUtil; protected databaseServer: DatabaseServer; + protected hashUtil: HashUtil; + protected itemHelper: ItemHelper; + protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + protected botGeneratorHelper: BotGeneratorHelper; protected saveServer: SaveServer; protected profileHelper: ProfileHelper; protected botHelper: BotHelper; @@ -26,7 +36,7 @@ export declare class PlayerScavGenerator { protected botGenerator: BotGenerator; protected configServer: ConfigServer; protected playerScavConfig: IPlayerScavConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, botHelper: BotHelper, jsonUtil: JsonUtil, fenceService: FenceService, botLootCacheService: BotLootCacheService, localisationService: LocalisationService, botGenerator: BotGenerator, configServer: ConfigServer); + constructor(logger: ILogger, randomUtil: RandomUtil, databaseServer: DatabaseServer, hashUtil: HashUtil, itemHelper: ItemHelper, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botGeneratorHelper: BotGeneratorHelper, saveServer: SaveServer, profileHelper: ProfileHelper, botHelper: BotHelper, jsonUtil: JsonUtil, fenceService: FenceService, botLootCacheService: BotLootCacheService, localisationService: LocalisationService, botGenerator: BotGenerator, configServer: ConfigServer); /** * Update a player profile to include a new player scav profile * @param sessionID session id to specify what profile is updated diff --git a/types/generators/RagfairAssortGenerator.d.ts b/types/generators/RagfairAssortGenerator.d.ts index db4811d..630e863 100644 --- a/types/generators/RagfairAssortGenerator.d.ts +++ b/types/generators/RagfairAssortGenerator.d.ts @@ -4,6 +4,7 @@ import { Item } from "../models/eft/common/tables/IItem"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { SeasonalEventService } from "../services/SeasonalEventService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; export declare class RagfairAssortGenerator { @@ -11,10 +12,11 @@ export declare class RagfairAssortGenerator { protected hashUtil: HashUtil; protected itemHelper: ItemHelper; protected databaseServer: DatabaseServer; + protected seasonalEventService: SeasonalEventService; protected configServer: ConfigServer; protected generatedAssortItems: Item[]; protected ragfairConfig: IRagfairConfig; - constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer); + constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, seasonalEventService: SeasonalEventService, configServer: ConfigServer); /** * Get an array of unique items that can be sold on the flea * @returns array of unique items diff --git a/types/generators/ScavCaseRewardGenerator.d.ts b/types/generators/ScavCaseRewardGenerator.d.ts index f9ac623..394eeb0 100644 --- a/types/generators/ScavCaseRewardGenerator.d.ts +++ b/types/generators/ScavCaseRewardGenerator.d.ts @@ -2,7 +2,6 @@ import { ItemHelper } from "../helpers/ItemHelper"; import { Product } from "../models/eft/common/tables/IBotBase"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { IHideoutScavCase } from "../models/eft/hideout/IHideoutScavCase"; -import { IHideoutScavCaseStartRequestData } from "../models/eft/hideout/IHideoutScavCaseStartRequestData"; import { IScavCaseConfig } from "../models/spt/config/IScavCaseConfig"; import { RewardCountAndPriceDetails, ScavCaseRewardCountsAndPrices } from "../models/spt/hideout/ScavCaseRewardCountsAndPrices"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -28,10 +27,10 @@ export declare class ScavCaseRewardGenerator { constructor(logger: ILogger, randomUtil: RandomUtil, hashUtil: HashUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, ragfairPriceService: RagfairPriceService, itemFilterService: ItemFilterService, configServer: ConfigServer); /** * Create an array of rewards that will be given to the player upon completing their scav case build - * @param body client request + * @param recipeId recipe of the scav case craft * @returns Product array */ - generate(body: IHideoutScavCaseStartRequestData): Product[]; + generate(recipeId: string): Product[]; /** * Get all db items that are not blacklisted in scavcase config * @returns filtered array of db items diff --git a/types/generators/weapongen/implementations/UbglExternalMagGen.d.ts b/types/generators/weapongen/implementations/UbglExternalMagGen.d.ts new file mode 100644 index 0000000..75395be --- /dev/null +++ b/types/generators/weapongen/implementations/UbglExternalMagGen.d.ts @@ -0,0 +1,10 @@ +import { BotWeaponGeneratorHelper } from "../../../helpers/BotWeaponGeneratorHelper"; +import { IInventoryMagGen } from "../IInventoryMagGen"; +import { InventoryMagGen } from "../InventoryMagGen"; +export declare class UbglExternalMagGen implements IInventoryMagGen { + protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + constructor(botWeaponGeneratorHelper: BotWeaponGeneratorHelper); + getPriority(): number; + canHandleInventoryMagGen(inventoryMagGen: InventoryMagGen): boolean; + process(inventoryMagGen: InventoryMagGen): void; +} diff --git a/types/helpers/AssortHelper.d.ts b/types/helpers/AssortHelper.d.ts index de8b5bf..13512b2 100644 --- a/types/helpers/AssortHelper.d.ts +++ b/types/helpers/AssortHelper.d.ts @@ -17,15 +17,16 @@ export declare class AssortHelper { * @param pmcProfile player profile * @param traderId traders id * @param assort assort items from a trader + * @param mergedQuestAssorts An object of quest assort to quest id unlocks for all traders * @returns assort items minus locked quest assorts */ - stripLockedQuestAssort(pmcProfile: IPmcData, traderId: string, assort: ITraderAssort, flea?: boolean): ITraderAssort; + stripLockedQuestAssort(pmcProfile: IPmcData, traderId: string, assort: ITraderAssort, mergedQuestAssorts: Record>, flea?: boolean): ITraderAssort; /** * Remove assorts from a trader that have not been unlocked yet * @param pmcProfile player profile * @param traderId traders id * @param assort traders assorts - * @returns traders assorts minus locked loyality assorts + * @returns traders assorts minus locked loyalty assorts */ stripLockedLoyaltyAssort(pmcProfile: IPmcData, traderId: string, assort: ITraderAssort): ITraderAssort; /** diff --git a/types/helpers/BotDifficultyHelper.d.ts b/types/helpers/BotDifficultyHelper.d.ts index a58ebdb..df2c269 100644 --- a/types/helpers/BotDifficultyHelper.d.ts +++ b/types/helpers/BotDifficultyHelper.d.ts @@ -20,7 +20,7 @@ export declare class BotDifficultyHelper { getPmcDifficultySettings(pmcType: "bear" | "usec", difficulty: string, usecType: string, bearType: string): Difficulty; /** * Get difficulty settings for desired bot type, if not found use assault bot types - * @param type bot type to retreive difficulty of + * @param type bot type to retrieve difficulty of * @param difficulty difficulty to get settings for (easy/normal etc) * @returns Difficulty object */ diff --git a/types/helpers/BotGeneratorHelper.d.ts b/types/helpers/BotGeneratorHelper.d.ts index d9ce968..c7dd606 100644 --- a/types/helpers/BotGeneratorHelper.d.ts +++ b/types/helpers/BotGeneratorHelper.d.ts @@ -23,7 +23,7 @@ export declare class BotGeneratorHelper { * Adds properties to an item * e.g. Repairable / HasHinge / Foldable / MaxDurability * @param itemTemplate Item extra properties are being generated for - * @param botRole Used by weapons to randomise the durability values. Null for non-equipped items + * @param botRole Used by weapons to randomize the durability values. Null for non-equipped items * @returns Item Upd object with extra properties */ generateExtraPropertiesForItem(itemTemplate: ITemplateItem, botRole?: string): { @@ -53,10 +53,10 @@ export declare class BotGeneratorHelper { protected generateArmorRepairableProperties(itemTemplate: ITemplateItem, botRole: string): Repairable; /** * Can item be added to another item without conflict - * @param items Items to check compatiblilities with + * @param items Items to check compatibilities with * @param tplToCheck Tpl of the item to check for incompatibilities * @param equipmentSlot Slot the item will be placed into - * @returns false if no incompatibilties, also has incompatibility reason + * @returns false if no incompatibilities, also has incompatibility reason */ isItemIncompatibleWithCurrentItems(items: Item[], tplToCheck: string, equipmentSlot: string): { incompatible: boolean; diff --git a/types/helpers/BotHelper.d.ts b/types/helpers/BotHelper.d.ts index 9a43b8e..3b49501 100644 --- a/types/helpers/BotHelper.d.ts +++ b/types/helpers/BotHelper.d.ts @@ -23,11 +23,11 @@ export declare class BotHelper { */ getBotTemplate(role: string): IBotType; /** - * Randomise the chance the PMC will attack their own side + * Randomize the chance the PMC will attack their own side * Look up value in bot.json/chanceSameSideIsHostilePercent * @param difficultySettings pmc difficulty settings */ - randomisePmcHostility(difficultySettings: Difficulty): void; + randomizePmcHostility(difficultySettings: Difficulty): void; /** * Is the passed in bot role a PMC (usec/bear/pmc) * @param botRole bot role to check @@ -63,26 +63,26 @@ export declare class BotHelper { rollChanceToBePmc(role: string, botConvertMinMax: MinMax): boolean; botRoleIsPmc(botRole: string): boolean; /** - * Get randomisation settings for bot from config/bot.json + * Get randomization settings for bot from config/bot.json * @param botLevel level of bot * @param botEquipConfig bot equipment json * @returns RandomisationDetails */ - getBotRandomisationDetails(botLevel: number, botEquipConfig: EquipmentFilters): RandomisationDetails; + getBotRandomizationDetails(botLevel: number, botEquipConfig: EquipmentFilters): RandomisationDetails; /** * Choose between sptBear and sptUsec at random based on the % defined in botConfig.pmc.isUsec * @returns pmc role */ - getRandomisedPmcRole(): string; + getRandomizedPmcRole(): string; /** - * Get the corrisponding side when sptBear or sptUsec is passed in + * Get the corresponding side when sptBear or sptUsec is passed in * @param botRole role to get side for * @returns side (usec/bear) */ getPmcSideByRole(botRole: string): string; /** - * Get a randomised PMC side based on bot config value 'isUsec' + * Get a randomized PMC side based on bot config value 'isUsec' * @returns pmc side as string */ - protected getRandomisedPmcSide(): string; + protected getRandomizedPmcSide(): string; } diff --git a/types/helpers/BotWeaponGeneratorHelper.d.ts b/types/helpers/BotWeaponGeneratorHelper.d.ts index b087fa9..cefc3bd 100644 --- a/types/helpers/BotWeaponGeneratorHelper.d.ts +++ b/types/helpers/BotWeaponGeneratorHelper.d.ts @@ -2,6 +2,7 @@ import { MinMax } from "../models/common/MinMax"; import { Inventory } from "../models/eft/common/tables/IBotBase"; import { Item } from "../models/eft/common/tables/IItem"; import { Grid, ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { EquipmentSlots } from "../models/enums/EquipmentSlots"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocalisationService } from "../services/LocalisationService"; @@ -21,18 +22,18 @@ export declare class BotWeaponGeneratorHelper { protected containerHelper: ContainerHelper; constructor(logger: ILogger, databaseServer: DatabaseServer, itemHelper: ItemHelper, randomUtil: RandomUtil, hashUtil: HashUtil, inventoryHelper: InventoryHelper, localisationService: LocalisationService, containerHelper: ContainerHelper); /** - * Get a randomised number of bullets for a specific magazine + * Get a randomized number of bullets for a specific magazine * @param magCounts min and max count of magazines * @param magTemplate magazine to generate bullet count for * @returns bullet count number */ - getRandomisedBulletCount(magCounts: MinMax, magTemplate: ITemplateItem): number; + getRandomizedBulletCount(magCounts: MinMax, magTemplate: ITemplateItem): number; /** - * Get a randomised count of magazines + * Get a randomized count of magazines * @param magCounts min and max value returned value can be between - * @returns numberical value of magazine count + * @returns numerical value of magazine count */ - getRandomisedMagazineCount(magCounts: MinMax): number; + getRandomizedMagazineCount(magCounts: MinMax): number; /** * Is this magazine cylinder related (revolvers and grenade launchers) * @param magazineParentName the name of the magazines parent @@ -48,12 +49,13 @@ export declare class BotWeaponGeneratorHelper { */ createMagazine(magazineTpl: string, ammoTpl: string, magTemplate: ITemplateItem): Item[]; /** - * Add a specific number of cartrdiges to a bots inventory (vest/pocket) + * Add a specific number of cartridges to a bots inventory (defaults to vest and pockets) * @param ammoTpl Ammo tpl to add to vest/pockets * @param cartridgeCount number of cartridges to add to vest/pockets * @param inventory bot inventory to add cartridges to + * @param equipmentSlotsToAddTo what equipment slots should bullets be added into */ - addBulletsToVestAndPockets(ammoTpl: string, cartridgeCount: number, inventory: Inventory): void; + addAmmoIntoEquipmentSlots(ammoTpl: string, cartridgeCount: number, inventory: Inventory, equipmentSlotsToAddTo?: EquipmentSlots[]): void; /** * Get a weapons default magazine template id * @param weaponTemplate weapon to get default magazine for @@ -61,7 +63,8 @@ export declare class BotWeaponGeneratorHelper { */ getWeaponsDefaultMagazineTpl(weaponTemplate: ITemplateItem): string; /** - * Adds an item with all its childern into specified equipmentSlots, wherever it fits. + * TODO - move into BotGeneratorHelper, this is not the class for it + * Adds an item with all its children into specified equipmentSlots, wherever it fits. * @param equipmentSlots * @param parentId * @param parentTpl diff --git a/types/helpers/DurabilityLimitsHelper.d.ts b/types/helpers/DurabilityLimitsHelper.d.ts index 61c3478..7122376 100644 --- a/types/helpers/DurabilityLimitsHelper.d.ts +++ b/types/helpers/DurabilityLimitsHelper.d.ts @@ -9,10 +9,10 @@ export declare class DurabilityLimitsHelper { protected configServer: ConfigServer; protected botConfig: IBotConfig; constructor(randomUtil: RandomUtil, botHelper: BotHelper, configServer: ConfigServer); - getRandomisedMaxWeaponDurability(itemTemplate: ITemplateItem, botRole: string): number; - getRandomisedMaxArmorDurability(itemTemplate: ITemplateItem, botRole: string): number; - getRandomisedWeaponDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; - getRandomisedArmorDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; + getRandomizedMaxWeaponDurability(itemTemplate: ITemplateItem, botRole: string): number; + getRandomizedMaxArmorDurability(itemTemplate: ITemplateItem, botRole: string): number; + getRandomizedWeaponDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; + getRandomizedArmorDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; protected generateMaxWeaponDurability(botRole: string): number; protected generateMaxPmcArmorDurability(itemMaxDurability: number): number; protected getLowestMaxWeaponFromConfig(botRole: string): number; diff --git a/types/helpers/HealthHelper.d.ts b/types/helpers/HealthHelper.d.ts index d9b6434..7a6d41d 100644 --- a/types/helpers/HealthHelper.d.ts +++ b/types/helpers/HealthHelper.d.ts @@ -1,7 +1,6 @@ import { IPmcData } from "../models/eft/common/IPmcData"; -import { Effect } from "../models/eft/health/Effect"; import { ISyncHealthRequestData } from "../models/eft/health/ISyncHealthRequestData"; -import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; +import { Effects, IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { IHealthConfig } from "../models/spt/config/IHealthConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; @@ -17,7 +16,7 @@ export declare class HealthHelper { protected healthConfig: IHealthConfig; constructor(jsonUtil: JsonUtil, logger: ILogger, timeUtil: TimeUtil, saveServer: SaveServer, configServer: ConfigServer); /** - * Resets the profiles vitality/healh and vitality/effects properties to their defaults + * Resets the profiles vitality/health and vitality/effects properties to their defaults * @param sessionID Session Id * @returns updated profile */ @@ -25,22 +24,27 @@ export declare class HealthHelper { /** * Update player profile with changes from request object * @param pmcData Player profile - * @param info Request object + * @param request Heal request * @param sessionID Session id * @param addEffects Should effects be added or removed (default - add) */ - saveVitality(pmcData: IPmcData, info: ISyncHealthRequestData, sessionID: string, addEffects?: boolean, deleteExistingEffects?: boolean): void; + saveVitality(pmcData: IPmcData, request: ISyncHealthRequestData, sessionID: string, addEffects?: boolean, deleteExistingEffects?: boolean): void; + /** + * Adjust hydration/energy/temperate and body part hp values in player profile to values in profile.vitality + * @param pmcData Profile to update + * @param sessionId Session id + */ protected saveHealth(pmcData: IPmcData, sessionID: string): void; /** * Save effects to profile * Works by removing all effects and adding them back from profile * Removes empty 'Effects' objects if found * @param pmcData Player profile - * @param sessionID Session id + * @param sessionId Session id + * @param bodyPartsWithEffects dict of body parts with effects that should be added to profile * @param addEffects Should effects be added back to profile - * @returns */ - protected saveEffects(pmcData: IPmcData, sessionID: string, addEffects: boolean, deleteExistingEffects?: boolean): void; + protected saveEffects(pmcData: IPmcData, sessionId: string, bodyPartsWithEffects: Effects, deleteExistingEffects?: boolean): void; /** * Add effect to body part in profile * @param pmcData Player profile @@ -48,6 +52,6 @@ export declare class HealthHelper { * @param effectType Effect to add to body part * @param duration How long the effect has left in seconds (-1 by default, no duration). */ - protected addEffect(pmcData: IPmcData, effectBodyPart: string, effectType: Effect, duration?: number): void; + protected addEffect(pmcData: IPmcData, effectBodyPart: string, effectType: string, duration?: number): void; protected isEmpty(map: any): boolean; } diff --git a/types/helpers/HideoutHelper.d.ts b/types/helpers/HideoutHelper.d.ts index 7e86f92..a5849e3 100644 --- a/types/helpers/HideoutHelper.d.ts +++ b/types/helpers/HideoutHelper.d.ts @@ -1,8 +1,9 @@ import { IPmcData } from "../models/eft/common/IPmcData"; -import { Common, HideoutArea, Production, Productive } from "../models/eft/common/tables/IBotBase"; +import { Common, HideoutArea, IHideoutImprovement, Production, Productive } from "../models/eft/common/tables/IBotBase"; import { Upd } from "../models/eft/common/tables/IItem"; import { StageBonus } from "../models/eft/hideout/IHideoutArea"; -import { IHideoutContinousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinuousProductionStartRequestData"; +import { IHideoutProduction } from "../models/eft/hideout/IHideoutProduction"; import { IHideoutSingleProductionStartRequestData } from "../models/eft/hideout/IHideoutSingleProductionStartRequestData"; import { IHideoutTakeProductionRequestData } from "../models/eft/hideout/IHideoutTakeProductionRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; @@ -15,7 +16,6 @@ import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; import { InventoryHelper } from "./InventoryHelper"; import { ProfileHelper } from "./ProfileHelper"; @@ -23,7 +23,6 @@ export declare class HideoutHelper { protected logger: ILogger; protected hashUtil: HashUtil; protected timeUtil: TimeUtil; - protected randomUtil: RandomUtil; protected databaseServer: DatabaseServer; protected eventOutputHolder: EventOutputHolder; protected httpResponse: HttpResponseUtil; @@ -37,11 +36,12 @@ export declare class HideoutHelper { static bitcoin: string; static expeditionaryFuelTank: string; static maxSkillPoint: number; + private static generatorOffMultipler; protected hideoutConfig: IHideoutConfig; - constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, inventoryHelper: InventoryHelper, playerService: PlayerService, localisationService: LocalisationService, configServer: ConfigServer); - registerProduction(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData | IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, inventoryHelper: InventoryHelper, playerService: PlayerService, localisationService: LocalisationService, configServer: ConfigServer); + registerProduction(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData | IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** - * This convinience function intialies new Production Object + * This convenience function initializes new Production Object * with all the constants. */ initProduction(recipeId: string, productionTime: number): Production; @@ -82,6 +82,26 @@ export declare class HideoutHelper { isGeneratorOn: boolean; waterCollectorHasFilter: boolean; }): void; + /** + * Update a productions progress value based on the amount of time that has passed + * @param pmcData Player profile + * @param prodId Production id being crafted + * @param recipe Recipe data being crafted + * @param hideoutProperties + */ + protected updateProductionProgress(pmcData: IPmcData, prodId: string, recipe: IHideoutProduction, hideoutProperties: { + btcFarmCGs?: number; + isGeneratorOn: boolean; + waterCollectorHasFilter?: boolean; + }): void; + /** + * Check if a productions progress value matches its corresponding recipes production time value + * @param pmcData Player profile + * @param prodId Production id + * @param recipe Recipe being crafted + * @returns progress matches productionTime from recipe + */ + protected doesProgressMatchProductionTime(pmcData: IPmcData, prodId: string): boolean; /** * Update progress timer for scav case * @param pmcData Profile to update @@ -106,7 +126,7 @@ export declare class HideoutHelper { * Adjust water filter objects resourceValue or delete when they reach 0 resource * @param waterFilterArea water filter area to update * @param production production object - * @param isGeneratorOn is generatory enabled + * @param isGeneratorOn is generator enabled * @param pmcData Player profile * @returns Updated HideoutArea object */ @@ -114,6 +134,11 @@ export declare class HideoutHelper { protected getAreaUpdObject(stackCount: number, resourceValue: number, resourceUnitsConsumed: number): Upd; protected updateAirFilters(airFilterArea: HideoutArea, pmcData: IPmcData): void; protected updateBitcoinFarm(pmcData: IPmcData, btcFarmCGs: number, isGeneratorOn: boolean): Production; + /** + * Get a count of how many BTC can be gathered by the profile + * @param pmcData Profile to look up + * @returns coin slot count + */ protected getBTCSlots(pmcData: IPmcData): number; protected getManagementSkillsSlots(): number; protected hasManagementSkillSlots(pmcData: IPmcData): boolean; @@ -133,12 +158,26 @@ export declare class HideoutHelper { */ protected getCraftingSkillProductionTimeReduction(pmcData: IPmcData, productionTime: number): number; isProduction(productive: Productive): productive is Production; - getBTC(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Gather crafted BTC from hideout area and add to inventory + * Reset production start timestamp if hideout area at full coin capacity + * @param pmcData Player profile + * @param request Take production request + * @param sessionId Session id + * @returns IItemEventRouterResponse + */ + getBTC(pmcData: IPmcData, request: IHideoutTakeProductionRequestData, sessionId: string): IItemEventRouterResponse; /** * Upgrade hideout wall from starting level to interactable level if enough time has passed * @param pmcProfile Profile to upgrade wall in */ unlockHideoutWallInProfile(pmcProfile: IPmcData): void; + /** + * Hideout improvement is flagged as complete + * @param improvement hideout improvement object + * @returns true if complete + */ + protected hideoutImprovementIsComplete(improvement: IHideoutImprovement): boolean; /** * Iterate over hideout improvements not completed and check if they need to be adjusted * @param pmcProfile Profile to adjust diff --git a/types/helpers/InRaidHelper.d.ts b/types/helpers/InRaidHelper.d.ts index 4b32ac0..c69a810 100644 --- a/types/helpers/InRaidHelper.d.ts +++ b/types/helpers/InRaidHelper.d.ts @@ -40,7 +40,7 @@ export declare class InRaidHelper { * Remove Labs keycard * @param profileData Profile to update * @param saveProgressRequest post raid save data request data - * @param sessionID Sessino id + * @param sessionID Session id * @returns Reset profile object */ updateProfileBaseStats(profileData: IPmcData, saveProgressRequest: ISaveProgressRequestData, sessionID: string): IPmcData; @@ -66,7 +66,7 @@ export declare class InRaidHelper { * Adds SpawnedInSession property to items found in a raid * Removes SpawnedInSession for non-scav players if item was taken into raid with SpawnedInSession = true * @param preRaidProfile profile to update - * @param postRaidProfile profile to upate inventory contents of + * @param postRaidProfile profile to update inventory contents of * @param isPlayerScav Was this a p scav raid * @returns */ diff --git a/types/helpers/InventoryHelper.d.ts b/types/helpers/InventoryHelper.d.ts index 8c44dc6..8855d1e 100644 --- a/types/helpers/InventoryHelper.d.ts +++ b/types/helpers/InventoryHelper.d.ts @@ -52,7 +52,7 @@ export declare class InventoryHelper { * @param sessionID Session id * @param callback Code to execute later (function) * @param foundInRaid Will results added to inventory be set as found in raid - * @param addUpd Additional upd propertys for items being added to inventory + * @param addUpd Additional upd properties for items being added to inventory * @returns IItemEventRouterResponse */ addItem(pmcData: IPmcData, request: IAddItemRequestData, output: IItemEventRouterResponse, sessionID: string, callback: { diff --git a/types/helpers/ItemHelper.d.ts b/types/helpers/ItemHelper.d.ts index 9639923..de424d2 100644 --- a/types/helpers/ItemHelper.d.ts +++ b/types/helpers/ItemHelper.d.ts @@ -30,7 +30,7 @@ declare class ItemHelper { /** * Checks if an id is a valid item. Valid meaning that it's an item that be stored in stash * @param {string} tpl the template id / tpl - * @returns boolean; true for items that may be in player posession and not quest items + * @returns boolean; true for items that may be in player possession and not quest items */ isValidItem(tpl: string, invalidBaseTypes?: string[]): boolean; /** @@ -42,7 +42,7 @@ declare class ItemHelper { */ isOfBaseclass(tpl: string, baseClassTpl: string): boolean; /** - * Check if item has any of the supplied base clases + * Check if item has any of the supplied base classes * @param tpl Item to check base classes of * @param baseClassTpls base classes to check for * @returns true if any supplied base classes match @@ -165,7 +165,7 @@ declare class ItemHelper { */ getChildId(item: Item): string; /** - * Can the pased in item be stacked + * Can the passed in item be stacked * @param tpl item to check * @returns true if it can be stacked */ @@ -192,7 +192,7 @@ declare class ItemHelper { */ replaceIDs(pmcData: IPmcData, items: Item[], insuredItems?: InsuredItem[], fastPanel?: any): any[]; /** - * WARNING, SLOW. Recursivly loop down through an items hierarchy to see if any of the ids match the supplied list, return true if any do + * WARNING, SLOW. Recursively loop down through an items hierarchy to see if any of the ids match the supplied list, return true if any do * @param {string} tpl * @param {Array} tplsToCheck * @returns boolean @@ -220,7 +220,15 @@ declare class ItemHelper { createRandomMagCartridges(magTemplate: ITemplateItem, parentId: string, staticAmmoDist: Record, caliber?: string): Item; protected getRandomValidCaliber(magTemplate: ITemplateItem): string; protected drawAmmoTpl(caliber: string, staticAmmoDist: Record): string; - createCartidges(parentId: string, ammoTpl: string, stackCount: number): Item; + /** + * + * @param parentId container cartridges will be placed in + * @param ammoTpl Cartridge to insert + * @param stackCount Count of cartridges inside parent + * @param location Location inside parent (e.g. 0, 1) + * @returns Item + */ + createCartridges(parentId: string, ammoTpl: string, stackCount: number, location: number): Item; /** * Get the size of a stack, return 1 if no stack object count property found * @param item Item to get stack size of diff --git a/types/helpers/NotificationSendHelper.d.ts b/types/helpers/NotificationSendHelper.d.ts index 014ac95..c80f22d 100644 --- a/types/helpers/NotificationSendHelper.d.ts +++ b/types/helpers/NotificationSendHelper.d.ts @@ -6,7 +6,7 @@ export declare class NotificationSendHelper { protected notificationService: NotificationService; constructor(webSocketServer: WebSocketServer, notificationService: NotificationService); /** - * Send notification message to the appropiate channel + * Send notification message to the appropriate channel */ sendMessage(sessionID: string, notificationMessage: INotification): void; } diff --git a/types/helpers/ProfileHelper.d.ts b/types/helpers/ProfileHelper.d.ts index 7c1b12a..79652ad 100644 --- a/types/helpers/ProfileHelper.d.ts +++ b/types/helpers/ProfileHelper.d.ts @@ -44,7 +44,7 @@ export declare class ProfileHelper { /** * Add experience to a PMC inside the players profile * @param sessionID Session id - * @param experienceToAdd Experiecne to add to PMC character + * @param experienceToAdd Experience to add to PMC character */ addExperienceToPmc(sessionID: string, experienceToAdd: number): void; getProfileByPmcId(pmcId: string): IPmcData; diff --git a/types/helpers/QuestHelper.d.ts b/types/helpers/QuestHelper.d.ts index dacc7be..de7cba2 100644 --- a/types/helpers/QuestHelper.d.ts +++ b/types/helpers/QuestHelper.d.ts @@ -1,8 +1,9 @@ import { IPmcData } from "../models/eft/common/IPmcData"; +import { Quest } from "../models/eft/common/tables/IBotBase"; import { AvailableForConditions, AvailableForProps, IQuest, Reward } from "../models/eft/common/tables/IQuest"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IAcceptQuestRequestData } from "../models/eft/quests/IAcceptQuestRequestData"; -import { ICompleteQuestRequestData } from "../models/eft/quests/ICompleteQuestRequestData"; +import { IFailQuestRequestData } from "../models/eft/quests/IFailQuestRequestData"; import { QuestStatus } from "../models/enums/QuestStatus"; import { IQuestConfig } from "../models/spt/config/IQuestConfig"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -42,7 +43,7 @@ export declare class QuestHelper { * Get status of a quest by quest id * @param pmcData Profile to search * @param questID Quest id to look up - * @returns QuestStauts enum + * @returns QuestStatus enum */ getQuestStatus(pmcData: IPmcData, questID: string): QuestStatus; /** @@ -54,7 +55,7 @@ export declare class QuestHelper { doesPlayerLevelFulfilCondition(playerLevel: number, condition: AvailableForConditions): boolean; /** * Get the quests found in both arrays (inner join) - * @param before Array of qeusts #1 + * @param before Array of quests #1 * @param after Array of quests #2 * @returns Reduction of cartesian product between two quest arrays */ @@ -63,11 +64,10 @@ export declare class QuestHelper { * Increase skill points of a skill on player profile * @param sessionID Session id * @param pmcData Player profile - * @param output output object to send back to client * @param skillName Name of skill to increase skill points of * @param progressAmount Amount of skill points to add to skill */ - rewardSkillPoints(sessionID: string, pmcData: IPmcData, output: IItemEventRouterResponse, skillName: string, progressAmount: number): void; + rewardSkillPoints(sessionID: string, pmcData: IPmcData, skillName: string, progressAmount: number): void; /** * Get quest name by quest id * @param questId id to get @@ -75,10 +75,10 @@ export declare class QuestHelper { */ getQuestNameFromLocale(questId: string): string; /** - * Check if trader has sufficient loyalty to fullfill quest requirement + * Check if trader has sufficient loyalty to fulfill quest requirement * @param questProperties Quest props * @param profile Player profile - * @returns true if loyalty is high enough to fulfil quest requirement + * @returns true if loyalty is high enough to fulfill quest requirement */ traderStandingRequirementCheck(questProperties: AvailableForProps, profile: IPmcData): boolean; protected processReward(reward: Reward): Reward[]; @@ -90,12 +90,12 @@ export declare class QuestHelper { */ getQuestRewardItems(quest: IQuest, state: QuestStatus): Reward[]; /** - * Update player profile with quest status (e.g. Fail/Success) - * @param pmcData profile to add quest to - * @param newState state the new quest should be in when added - * @param acceptedQuest Details of quest being added + * Look up quest in db by accepted quest id and construct a profile-ready object ready to store in profile + * @param pmcData Player profile + * @param newState State the new quest should be in when returned + * @param acceptedQuest Details of accepted quest from client */ - addQuestToPMCData(pmcData: IPmcData, newState: QuestStatus, acceptedQuest: IAcceptQuestRequestData): void; + getQuestReadyForProfile(pmcData: IPmcData, newState: QuestStatus, acceptedQuest: IAcceptQuestRequestData): Quest; /** * TODO: what is going on here * @param acceptedQuestId Quest to add to profile @@ -111,12 +111,12 @@ export declare class QuestHelper { */ failedUnlocked(failedQuestId: string, sessionID: string): IQuest[]; /** - * Adjust quest money rewards by passed in multipler + * Adjust quest money rewards by passed in multiplier * @param quest Quest to multiple money rewards - * @param multipler Value to adjust money rewards by + * @param multiplier Value to adjust money rewards by * @returns Updated quest */ - applyMoneyBoost(quest: IQuest, multipler: number): IQuest; + applyMoneyBoost(quest: IQuest, multiplier: number): IQuest; /** * Sets the item stack to new value, or delete the item if value <= 0 * // TODO maybe merge this function and the one from customization @@ -127,12 +127,6 @@ export declare class QuestHelper { * @param output ItemEvent router response */ changeItemStack(pmcData: IPmcData, itemId: string, newStackSize: number, sessionID: string, output: IItemEventRouterResponse): void; - /** - * Get List of All Quests from db - * NOT CLONED - * @returns Array of IQuest objects - */ - getQuestsFromDb(): IQuest[]; /** * Get quests, strip all requirement conditions except level * @param quests quests to process @@ -147,45 +141,62 @@ export declare class QuestHelper { getQuestWithOnlyLevelRequirementStartCondition(quest: IQuest): IQuest; /** * Fail a quest in a player profile - * @param pmcData Profile - * @param failRequest fail quest request data + * @param pmcData Player profile + * @param failRequest Fail quest request data * @param sessionID Session id * @returns Item event router response */ - failQuest(pmcData: IPmcData, failRequest: any, sessionID: string): IItemEventRouterResponse; + failQuest(pmcData: IPmcData, failRequest: IFailQuestRequestData, sessionID: string): IItemEventRouterResponse; /** - * Get quest by id from database - * @param questId questid to look for - * @param pmcData player profile + * Get List of All Quests from db + * NOT CLONED + * @returns Array of IQuest objects + */ + getQuestsFromDb(): IQuest[]; + /** + * Get quest by id from database (repeatables are stored in profile, check there if questId not found) + * @param questId Id of quest to find + * @param pmcData Player profile * @returns IQuest object */ getQuestFromDb(questId: string, pmcData: IPmcData): IQuest; /** * Get the locale Id from locale db for a quest message - * @param questMessageId Quest mesage id to look up + * @param questMessageId Quest message id to look up * @returns Locale Id from locale db */ getQuestLocaleIdFromDb(questMessageId: string): string; /** - * Alter a quests state + Add a record to tis status timers object + * Alter a quests state + Add a record to its status timers object * @param pmcData Profile to update - * @param newQuestState new state the qeust should be in - * @param questId id of the quest to alter the status of + * @param newQuestState New state the quest should be in + * @param questId Id of the quest to alter the status of */ updateQuestState(pmcData: IPmcData, newQuestState: QuestStatus, questId: string): void; /** - * Give player quest rewards - Skills/exp/trader standing/items/assort unlocks + * Give player quest rewards - Skills/exp/trader standing/items/assort unlocks - Returns reward items player earned * @param pmcData Player profile - * @param body complete quest request - * @param state State of the quest now its complete - * @param sessionID Seession id - * @returns array of reward objects + * @param questId questId of quest to get rewards for + * @param state State of the quest to get rewards for + * @param sessionId Session id + * @param questResponse Response to send back to client + * @returns Array of reward objects */ - applyQuestReward(pmcData: IPmcData, body: ICompleteQuestRequestData, state: QuestStatus, sessionID: string): Reward[]; + applyQuestReward(pmcData: IPmcData, questId: string, state: QuestStatus, sessionId: string, questResponse: IItemEventRouterResponse): Reward[]; /** - * Get the intel center bonus a player has + * WIP - Find hideout craft id and add to unlockedProductionRecipe array in player profile + * also update client response recipeUnlocked array with craft id + * @param pmcData Player profile + * @param craftUnlockReward Reward item from quest with craft unlock details + * @param questDetails Quest with craft unlock reward + * @param sessionID Session id + * @param response Response to send back to client + */ + protected findAndAddHideoutProductionIdToProfile(pmcData: IPmcData, craftUnlockReward: Reward, questDetails: IQuest, sessionID: string, response: IItemEventRouterResponse): void; + /** + * Get players intel center bonus from profile * @param pmcData player profile - * @returns bonus in percent + * @returns bonus as a percent */ protected getIntelCenterRewardBonus(pmcData: IPmcData): number; /** @@ -195,7 +206,7 @@ export declare class QuestHelper { */ getFindItemIdForQuestHandIn(itemTpl: string): string; /** - * Add All quests to a profile with the provided statuses + * Add all quests to a profile with the provided statuses * @param pmcProfile profile to update * @param statuses statuses quests should have */ diff --git a/types/helpers/RagfairOfferHelper.d.ts b/types/helpers/RagfairOfferHelper.d.ts index 95be986..3d0d570 100644 --- a/types/helpers/RagfairOfferHelper.d.ts +++ b/types/helpers/RagfairOfferHelper.d.ts @@ -48,6 +48,12 @@ export declare class RagfairOfferHelper { constructor(logger: ILogger, timeUtil: TimeUtil, hashUtil: HashUtil, eventOutputHolder: EventOutputHolder, databaseServer: DatabaseServer, traderHelper: TraderHelper, saveServer: SaveServer, dialogueHelper: DialogueHelper, itemHelper: ItemHelper, paymentHelper: PaymentHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, ragfairServerHelper: RagfairServerHelper, ragfairSortHelper: RagfairSortHelper, ragfairHelper: RagfairHelper, ragfairOfferService: RagfairOfferService, localeService: LocaleService, configServer: ConfigServer); getValidOffers(searchRequest: ISearchRequestData, itemsToAdd: string[], traderAssorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; getOffersForBuild(info: ISearchRequestData, itemsToAdd: string[], assorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + /** + * Has a traders offer ran out of stock to sell to player + * @param offer Offer to check stock of + * @returns true if out of stock + */ + protected traderOutOfStock(offer: IRagfairOffer): boolean; /** * Check if trader offers' BuyRestrictionMax value has been reached * @param offer offer to check restriction properties of diff --git a/types/helpers/RagfairSellHelper.d.ts b/types/helpers/RagfairSellHelper.d.ts index 60809b5..bf7aeb6 100644 --- a/types/helpers/RagfairSellHelper.d.ts +++ b/types/helpers/RagfairSellHelper.d.ts @@ -30,7 +30,7 @@ export declare class RagfairSellHelper { * Determine if the offer being listed will be sold * @param sellChancePercent chance item will sell * @param itemSellCount count of items to sell - * @returns Array of purchases of item(s) lsited + * @returns Array of purchases of item(s) listed */ rollForSale(sellChancePercent: number, itemSellCount: number): SellResult[]; } diff --git a/types/helpers/RagfairSortHelper.d.ts b/types/helpers/RagfairSortHelper.d.ts index 4669ce6..6a06528 100644 --- a/types/helpers/RagfairSortHelper.d.ts +++ b/types/helpers/RagfairSortHelper.d.ts @@ -7,7 +7,7 @@ export declare class RagfairSortHelper { protected localeService: LocaleService; constructor(databaseServer: DatabaseServer, localeService: LocaleService); /** - * Sort a list of ragfair offers by something (id/rating/offer name/price/expirty time) + * Sort a list of ragfair offers by something (id/rating/offer name/price/expiry time) * @param offers Offers to sort * @param type How to sort it * @param direction Ascending/descending diff --git a/types/helpers/RepairHelper.d.ts b/types/helpers/RepairHelper.d.ts index 9983d4d..0d0257a 100644 --- a/types/helpers/RepairHelper.d.ts +++ b/types/helpers/RepairHelper.d.ts @@ -24,7 +24,12 @@ export declare class RepairHelper { * @param applyMaxDurabilityDegradation should item have max durability reduced */ updateItemDurability(itemToRepair: Item, itemToRepairDetails: ITemplateItem, isArmor: boolean, amountToRepair: number, useRepairKit: boolean, traderQualityMultipler: number, applyMaxDurabilityDegradation?: boolean): void; - protected getRandomisedArmorRepairDegredationValue(armorMaterial: string, isRepairKit: boolean, armorMax: number, traderQualityMultipler: number): number; - protected getRandomisedWeaponRepairDegredationValue(itemProps: Props, isRepairKit: boolean, weaponMax: number, traderQualityMultipler: number): number; + protected getRandomisedArmorRepairDegradationValue(armorMaterial: string, isRepairKit: boolean, armorMax: number, traderQualityMultipler: number): number; + protected getRandomisedWeaponRepairDegradationValue(itemProps: Props, isRepairKit: boolean, weaponMax: number, traderQualityMultipler: number): number; + /** + * Is the supplied tpl a weapon + * @param tpl tplId to check is a weapon + * @returns true if tpl is a weapon + */ isWeaponTemplate(tpl: string): boolean; } diff --git a/types/helpers/TradeHelper.d.ts b/types/helpers/TradeHelper.d.ts index 0c7aa7b..6811dd1 100644 --- a/types/helpers/TradeHelper.d.ts +++ b/types/helpers/TradeHelper.d.ts @@ -45,7 +45,7 @@ export declare class TradeHelper { sellItem(pmcData: IPmcData, sellRequest: IProcessSellTradeRequestData, sessionID: string): IItemEventRouterResponse; /** * Increment the assorts buy count by number of items purchased - * Show error on screen if player attepts to buy more than what the buy max allows + * Show error on screen if player attempts to buy more than what the buy max allows * @param assortBeingPurchased assort being bought * @param itemsPurchasedCount number of items being bought */ diff --git a/types/helpers/TraderAssortHelper.d.ts b/types/helpers/TraderAssortHelper.d.ts index c3915c6..a0294a1 100644 --- a/types/helpers/TraderAssortHelper.d.ts +++ b/types/helpers/TraderAssortHelper.d.ts @@ -35,6 +35,8 @@ export declare class TraderAssortHelper { protected fenceService: FenceService; protected configServer: ConfigServer; protected traderConfig: ITraderConfig; + protected mergedQuestAssorts: Record>; + protected createdMergedQuestAssorts: boolean; constructor(logger: ILogger, jsonUtil: JsonUtil, mathUtil: MathUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, profileHelper: ProfileHelper, assortHelper: AssortHelper, paymentHelper: PaymentHelper, ragfairAssortGenerator: RagfairAssortGenerator, ragfairOfferGenerator: RagfairOfferGenerator, traderAssortService: TraderAssortService, localisationService: LocalisationService, traderPurchasePersisterService: TraderPurchasePersisterService, traderHelper: TraderHelper, fenceService: FenceService, configServer: ConfigServer); /** * Get a traders assorts @@ -45,6 +47,10 @@ export declare class TraderAssortHelper { * @returns a traders' assorts */ getAssort(sessionId: string, traderId: string, flea?: boolean): ITraderAssort; + /** + * Create a dict of all assort id = quest id mappings used to work out what items should be shown to player based on the quests they've started/completed/failed + */ + protected hydrateMergedQuestAssorts(): void; /** * Reset a traders assorts and move nextResupply value to future * Flag trader as needing a flea offer reset to be picked up by flea update() function @@ -61,7 +67,7 @@ export declare class TraderAssortHelper { * Iterate over all assorts barter_scheme values, find barters selling for money and multiply by multipler in config * @param traderAssort Assorts to multiple price of */ - protected multiplyItemPricesByConfigMultipler(traderAssort: ITraderAssort): void; + protected multiplyItemPricesByConfigMultiplier(traderAssort: ITraderAssort): void; /** * Get an array of pristine trader items prior to any alteration by player (as they were on server start) * @param traderId trader id diff --git a/types/helpers/TraderHelper.d.ts b/types/helpers/TraderHelper.d.ts index e69c593..49aea28 100644 --- a/types/helpers/TraderHelper.d.ts +++ b/types/helpers/TraderHelper.d.ts @@ -29,6 +29,8 @@ export declare class TraderHelper { protected timeUtil: TimeUtil; protected configServer: ConfigServer; protected traderConfig: ITraderConfig; + /** Dictionary of item tpl and the highest trader rouble price */ + protected highestTraderPriceItems: Record; constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, paymentHelper: PaymentHelper, itemHelper: ItemHelper, handbookHelper: HandbookHelper, playerService: PlayerService, localisationService: LocalisationService, fenceService: FenceService, timeUtil: TimeUtil, configServer: ConfigServer); getTrader(traderID: string, sessionID: string): ITraderBase; getTraderAssortsById(traderId: string): ITraderAssort; @@ -41,11 +43,11 @@ export declare class TraderHelper { resetTrader(sessionID: string, traderID: string): void; /** * Alter a traders unlocked status - * @param traderID Trader to alter + * @param traderId Trader to alter * @param status New status to use - * @param sessionID Session id + * @param sessionId Session id */ - setTraderUnlockedState(traderID: string, status: boolean, sessionID: string): void; + setTraderUnlockedState(traderId: string, status: boolean, sessionId: string): void; /** * Get a list of items and their prices from player inventory that can be sold to a trader * @param traderID trader id being traded with @@ -77,7 +79,7 @@ export declare class TraderHelper { protected getTraderDurabiltyPurchaseThreshold(traderId: string): number; /** * Get the price of passed in item and all of its attached children (mods) - * Take into account bonuses/adjsutments e.g. discounts + * Take into account bonuses/adjustments e.g. discounts * @param pmcData profile data * @param item item to calculate price of * @param buyPriceCoefficient @@ -104,11 +106,11 @@ export declare class TraderHelper { protected getTraderDiscount(trader: ITraderBase, buyPriceCoefficient: number, fenceInfo: FenceLevel): number; /** * Add standing to a trader and level them up if exp goes over level threshold - * @param sessionID Session id - * @param traderId traders id + * @param sessionId Session id + * @param traderId Traders id * @param standingToAdd Standing value to add to trader */ - addStandingToTrader(sessionID: string, traderId: string, standingToAdd: number): void; + addStandingToTrader(sessionId: string, traderId: string, standingToAdd: number): void; /** * Calculate traders level based on exp amount and increments level if over threshold * @param traderID trader to process @@ -147,4 +149,10 @@ export declare class TraderHelper { }[]; tid: string; }): void; + /** + * Get the highest rouble price for an item from traders + * @param tpl Item to look up highest pride for + * @returns highest rouble cost for item + */ + getHighestTraderPriceRouble(tpl: string): number; } diff --git a/types/loaders/BundleLoader.d.ts b/types/loaders/BundleLoader.d.ts index 06ad698..b88723c 100644 --- a/types/loaders/BundleLoader.d.ts +++ b/types/loaders/BundleLoader.d.ts @@ -19,4 +19,11 @@ export declare class BundleLoader { getBundle(key: string, local: boolean): BundleInfo; addBundles(modpath: string): void; } +export interface BundleManifest { + manifest: Array; +} +export interface BundleManifestEntry { + key: string; + path: string; +} export {}; diff --git a/types/loaders/ModTypeCheck.d.ts b/types/loaders/ModTypeCheck.d.ts new file mode 100644 index 0000000..e907341 --- /dev/null +++ b/types/loaders/ModTypeCheck.d.ts @@ -0,0 +1,43 @@ +import { IPostAkiLoadMod } from "../models/external/IPostAkiLoadMod"; +import { IPostAkiLoadModAsync } from "../models/external/IPostAkiLoadModAsync"; +import { IPostDBLoadMod } from "../models/external/IPostDBLoadMod"; +import { IPostDBLoadModAsync } from "../models/external/IPostDBLoadModAsync"; +import { IPreAkiLoadMod } from "../models/external/IPreAkiLoadMod"; +import { IPreAkiLoadModAsync } from "../models/external/IPreAkiLoadModAsync"; +export declare class ModTypeCheck { + /** + * Use defined safe guard to check if the mod is a IPreAkiLoadMod + * @returns boolean + */ + isPreAkiLoad(mod: any): mod is IPreAkiLoadMod; + /** + * Use defined safe guard to check if the mod is a IPostAkiLoadMod + * @returns boolean + */ + isPostAkiLoad(mod: any): mod is IPostAkiLoadMod; + /** + * Use defined safe guard to check if the mod is a IPostDBLoadMod + * @returns boolean + */ + isPostDBAkiLoad(mod: any): mod is IPostDBLoadMod; + /** + * Use defined safe guard to check if the mod is a IPreAkiLoadModAsync + * @returns boolean + */ + isPreAkiLoadAsync(mod: any): mod is IPreAkiLoadModAsync; + /** + * Use defined safe guard to check if the mod is a IPostAkiLoadModAsync + * @returns boolean + */ + isPostAkiLoadAsync(mod: any): mod is IPostAkiLoadModAsync; + /** + * Use defined safe guard to check if the mod is a IPostDBLoadModAsync + * @returns boolean + */ + isPostDBAkiLoadAsync(mod: any): mod is IPostDBLoadModAsync; + /** + * Checks for mod to be compatible with 3.X+ + * @returns boolean + */ + isPostV3Compatible(mod: any): boolean; +} diff --git a/types/loaders/PostAkiModLoader.d.ts b/types/loaders/PostAkiModLoader.d.ts index edc6e5d..5df8c6c 100644 --- a/types/loaders/PostAkiModLoader.d.ts +++ b/types/loaders/PostAkiModLoader.d.ts @@ -1,21 +1,17 @@ import { DependencyContainer } from "tsyringe"; -import { HandbookController } from "../controllers/HandbookController"; import { IModLoader } from "../models/spt/mod/IModLoader"; -import { ModCompilerService } from "../services/ModCompilerService"; import { VFS } from "../utils/VFS"; import { BundleLoader } from "./BundleLoader"; +import { ModTypeCheck } from "./ModTypeCheck"; import { PreAkiModLoader } from "./PreAkiModLoader"; export declare class PostAkiModLoader implements IModLoader { protected bundleLoader: BundleLoader; - protected handbookController: HandbookController; protected vfs: VFS; - protected modCompilerService: ModCompilerService; protected preAkiModLoader: PreAkiModLoader; - constructor(bundleLoader: BundleLoader, handbookController: HandbookController, vfs: VFS, modCompilerService: ModCompilerService, preAkiModLoader: PreAkiModLoader); - getBundles(local: boolean): string; - getBundle(key: string, local: boolean): void; + protected modTypeCheck: ModTypeCheck; + constructor(bundleLoader: BundleLoader, vfs: VFS, preAkiModLoader: PreAkiModLoader, modTypeCheck: ModTypeCheck); getModPath(mod: string): string; - load(): void; - protected executeMods(container: DependencyContainer): void; + load(): Promise; + protected executeMods(container: DependencyContainer): Promise; protected addBundles(): void; } diff --git a/types/loaders/PostDBModLoader.d.ts b/types/loaders/PostDBModLoader.d.ts index 87b60f9..c4cda5c 100644 --- a/types/loaders/PostDBModLoader.d.ts +++ b/types/loaders/PostDBModLoader.d.ts @@ -1,11 +1,13 @@ import { DependencyContainer } from "tsyringe"; import { OnLoad } from "../di/OnLoad"; +import { ModTypeCheck } from "./ModTypeCheck"; import { PreAkiModLoader } from "./PreAkiModLoader"; export declare class PostDBModLoader implements OnLoad { protected preAkiModLoader: PreAkiModLoader; - constructor(preAkiModLoader: PreAkiModLoader); + protected modTypeCheck: ModTypeCheck; + constructor(preAkiModLoader: PreAkiModLoader, modTypeCheck: ModTypeCheck); onLoad(): Promise; getRoute(): string; getModPath(mod: string): string; - protected executeMods(container: DependencyContainer): void; + protected executeMods(container: DependencyContainer): Promise; } diff --git a/types/loaders/PreAkiModLoader.d.ts b/types/loaders/PreAkiModLoader.d.ts index 38595f1..1949696 100644 --- a/types/loaders/PreAkiModLoader.d.ts +++ b/types/loaders/PreAkiModLoader.d.ts @@ -1,9 +1,5 @@ import { DependencyContainer } from "tsyringe"; -import { IPostAkiLoadMod } from "../models/external/IPostAkiLoadMod"; -import { IPostDBLoadMod } from "../models/external/IPostDBLoadMod"; -import { IPreAkiLoadMod } from "../models/external/IPreAkiLoadMod"; import { ICoreConfig } from "../models/spt/config/ICoreConfig"; -import { ModLoader } from "../models/spt/mod/IMod"; import { IModLoader } from "../models/spt/mod/IModLoader"; import { IPackageJsonData } from "../models/spt/mod/IPackageJsonData"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -13,6 +9,7 @@ import { ModCompilerService } from "../services/ModCompilerService"; import { JsonUtil } from "../utils/JsonUtil"; import { VFS } from "../utils/VFS"; import { BundleLoader } from "./BundleLoader"; +import { ModTypeCheck } from "./ModTypeCheck"; export declare class PreAkiModLoader implements IModLoader { protected logger: ILogger; protected vfs: VFS; @@ -21,24 +18,22 @@ export declare class PreAkiModLoader implements IModLoader { protected bundleLoader: BundleLoader; protected localisationService: LocalisationService; protected configServer: ConfigServer; + protected modTypeCheck: ModTypeCheck; protected static container: DependencyContainer; protected readonly basepath = "user/mods/"; protected readonly modOrderPath = "user/mods/order.json"; protected order: Record; - protected imported: Record; + protected imported: Record; protected akiConfig: ICoreConfig; - constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, modCompilerService: ModCompilerService, bundleLoader: BundleLoader, localisationService: LocalisationService, configServer: ConfigServer); + constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, modCompilerService: ModCompilerService, bundleLoader: BundleLoader, localisationService: LocalisationService, configServer: ConfigServer, modTypeCheck: ModTypeCheck); load(container: DependencyContainer): Promise; - getBundles(local: boolean): string; - getBundle(key: string, local: boolean): void; /** * Returns a list of mods with preserved load order * @returns Array of mod names in load order */ getImportedModsNames(): string[]; - getImportedModDetails(): Record; + getImportedModDetails(): Record; getModPath(mod: string): string; - protected importClass(name: string, filepath: string, container: DependencyContainer): void; protected importMods(): Promise; /** * Check for duplciate mods loaded, show error if duplicate mod found @@ -63,29 +58,8 @@ export declare class PreAkiModLoader implements IModLoader { * @returns dictionary */ protected getModsPackageData(mods: string[]): Record; - /** - * Use defined safe guard to check if the mod is a IPreAkiLoadMod - * @returns boolean - */ - protected isPreAkiLoad(mod: any): mod is IPreAkiLoadMod; - /** - * Use defined safe guard to check if the mod is a IPostAkiLoadMod - * @returns boolean - */ - protected isPostAkiLoad(mod: any): mod is IPostAkiLoadMod; - /** - * Use defined safe guard to check if the mod is a IPostDBLoadMod - * @returns boolean - */ - protected isPostDBAkiLoad(mod: any): mod is IPostDBLoadMod; - /** - * Check that the mod is compatible with SPT 3.X.X - * @param mod the mod to check - * @returns boolean - */ - protected isModSpt3XXCompatible(mod: any): boolean; protected isModCombatibleWithAki(mod: IPackageJsonData): boolean; - protected executeMods(container: DependencyContainer): void; + protected executeMods(container: DependencyContainer): Promise; sortModsLoadOrder(): string[]; protected addMod(mod: string): Promise; protected areModDependenciesFulfilled(pkg: IPackageJsonData, loadedMods: Record): boolean; @@ -97,6 +71,6 @@ export declare class PreAkiModLoader implements IModLoader { */ protected validMod(modName: string): boolean; protected getLoadOrderRecursive(mod: string, result: Record, visited: Record): void; - protected getLoadOrder(mods: Record): Record; + protected getLoadOrder(mods: Record): Record; getContainer(): DependencyContainer; } diff --git a/types/models/eft/common/IGlobals.d.ts b/types/models/eft/common/IGlobals.d.ts index 60cdf5b..b5ed401 100644 --- a/types/models/eft/common/IGlobals.d.ts +++ b/types/models/eft/common/IGlobals.d.ts @@ -31,6 +31,7 @@ export interface Config { TimeBeforeDeployLocal: number; TradingSetting: number; TradingSettings: ITradingSettings; + ItemsCommonSettings: IItemsCommonSettings; LoadTimeSpeedProgress: number; BaseLoadTime: number; BaseUnloadTime: number; @@ -84,12 +85,16 @@ export interface Config { TestValue: number; Inertia: Inertia; Ballistic: Ballistic; + RepairSettings: RepairSettings; } export interface IBufferZone { CustomerAccessTime: number; CustomerCriticalTimeStart: number; CustomerKickNotifTime: number; } +export interface IItemsCommonSettings { + ItemRemoveAfterInterruptionTime: number; +} export interface ITradingSettings { BuyoutRestrictions: IBuyoutRestrictions; } diff --git a/types/models/eft/common/ILocationBase.d.ts b/types/models/eft/common/ILocationBase.d.ts index 9b97d7e..1c3a2fa 100644 --- a/types/models/eft/common/ILocationBase.d.ts +++ b/types/models/eft/common/ILocationBase.d.ts @@ -180,6 +180,7 @@ export interface Exit { EntryPoints: string; ExfiltrationTime: number; ExfiltrationType: string; + RequiredSlot?: string; Id: string; MaxTime: number; MinTime: number; diff --git a/types/models/eft/common/tables/IBotBase.d.ts b/types/models/eft/common/tables/IBotBase.d.ts index c991b2d..dd7c478 100644 --- a/types/models/eft/common/tables/IBotBase.d.ts +++ b/types/models/eft/common/tables/IBotBase.d.ts @@ -104,7 +104,10 @@ export interface BodyPartsHealth { } export interface BodyPartHealth { Health: CurrentMax; - Effects?: Record; + Effects?: Record; +} +export interface BodyPartEffectProperties { + Time: number; } export interface CurrentMax { Current: number; @@ -124,7 +127,6 @@ export interface FastPanel { export interface Skills { Common: Common[]; Mastering: Mastering[]; - Bonuses?: any[]; Points: number; } export interface Common { @@ -270,6 +272,7 @@ export interface Hideout { Production: Record; Areas: HideoutArea[]; Improvements: Record; + sptUpdateLastRunTimestamp: number; } export interface IHideoutImprovement { completed: boolean; @@ -277,9 +280,15 @@ export interface IHideoutImprovement { } export interface Productive { Products: Product[]; + /** Seconds passed of production */ Progress?: number; + /** Is craft in some state of being worked on by client (crafting/ready to pick up) */ inProgress?: boolean; StartTimestamp?: number; + SkipTime?: number; + /** Seconds needed to fully craft */ + ProductionTime?: number; + sptIsScavCase?: boolean; } export interface Production extends Productive { RecipeId: string; diff --git a/types/models/eft/common/tables/IItem.d.ts b/types/models/eft/common/tables/IItem.d.ts index 0a6d6fc..ce00ae9 100644 --- a/types/models/eft/common/tables/IItem.d.ts +++ b/types/models/eft/common/tables/IItem.d.ts @@ -7,6 +7,7 @@ export interface Item { upd?: Upd; } export interface Upd { + Buff?: Buff; OriginalStackObjectsCount?: number; Togglable?: Togglable; Map?: Map; @@ -16,6 +17,7 @@ export interface Upd { StackObjectsCount?: number; UnlimitedCount?: boolean; Repairable?: Repairable; + RecodableComponent?: RecodableComponent; FireMode?: FireMode; SpawnedInSession?: boolean; Light?: Light; @@ -31,6 +33,12 @@ export interface Upd { SideEffect?: SideEffect; RepairKit?: RepairKit; } +export interface Buff { + rarity: string; + buffType: string; + value: number; + thresholdDurability?: number; +} export interface Togglable { On: boolean; } @@ -52,6 +60,9 @@ export interface Repairable { Durability: number; MaxDurability: number; } +export interface RecodableComponent { + IsEncoded: boolean; +} export interface MedKit { HpResource: number; } diff --git a/types/models/eft/common/tables/IQuest.d.ts b/types/models/eft/common/tables/IQuest.d.ts index cc77367..5c939e1 100644 --- a/types/models/eft/common/tables/IQuest.d.ts +++ b/types/models/eft/common/tables/IQuest.d.ts @@ -2,7 +2,7 @@ import { QuestRewardType } from "../../../enums/QuestRewardType"; import { QuestStatus } from "../../../enums/QuestStatus"; import { Item } from "./IItem"; export interface IQuest { - QuestName: string; + QuestName?: string; _id: string; canShowNotificationsInGame: boolean; conditions: Conditions; @@ -23,7 +23,7 @@ export interface IQuest { successMessageText: string; templateId: string; rewards: Rewards; - status: string; + status: string | number; KeyQuest: boolean; changeQuestMessageText: string; side: string; @@ -51,6 +51,8 @@ export interface AvailableForProps { visibilityConditions?: VisibilityCondition[]; target?: string | string[]; status?: QuestStatus[]; + availableAfter?: number; + dispersion?: number; onlyFoundInRaid?: boolean; oneSessionOnly?: boolean; doNotResetIfCounterCompleted?: boolean; diff --git a/types/models/eft/common/tables/IRepeatableQuests.d.ts b/types/models/eft/common/tables/IRepeatableQuests.d.ts index 6a02958..3a33f2e 100644 --- a/types/models/eft/common/tables/IRepeatableQuests.d.ts +++ b/types/models/eft/common/tables/IRepeatableQuests.d.ts @@ -47,6 +47,7 @@ export interface IRepeatableQuest { canShowNotificationsInGame: boolean; rewards: IRewards; conditions: IConditions; + side: string; name: string; note: string; description: string; diff --git a/types/models/eft/common/tables/ITemplateItem.d.ts b/types/models/eft/common/tables/ITemplateItem.d.ts index b59a277..cbad0a6 100644 --- a/types/models/eft/common/tables/ITemplateItem.d.ts +++ b/types/models/eft/common/tables/ITemplateItem.d.ts @@ -159,7 +159,7 @@ export interface Props { RigLayoutName?: string; MaxDurability?: number; armorZone?: string[]; - armorClass?: any; + armorClass?: string | number; mousePenalty?: number; weaponErgonomicPenalty?: number; BluntThroughput?: number; diff --git a/types/models/eft/hideout/IHideoutContinousProductionStartRequestData.d.ts b/types/models/eft/hideout/IHideoutContinuousProductionStartRequestData.d.ts similarity index 59% rename from types/models/eft/hideout/IHideoutContinousProductionStartRequestData.d.ts rename to types/models/eft/hideout/IHideoutContinuousProductionStartRequestData.d.ts index dba83eb..3ef00c6 100644 --- a/types/models/eft/hideout/IHideoutContinousProductionStartRequestData.d.ts +++ b/types/models/eft/hideout/IHideoutContinuousProductionStartRequestData.d.ts @@ -1,4 +1,4 @@ -export interface IHideoutContinousProductionStartRequestData { +export interface IHideoutContinuousProductionStartRequestData { Action: "HideoutContinuousProductionStart"; recipeId: string; timestamp: number; diff --git a/types/models/eft/itemEvent/IItemEventRouterBase.d.ts b/types/models/eft/itemEvent/IItemEventRouterBase.d.ts index 99d4bfe..dbf6330 100644 --- a/types/models/eft/itemEvent/IItemEventRouterBase.d.ts +++ b/types/models/eft/itemEvent/IItemEventRouterBase.d.ts @@ -1,4 +1,5 @@ -import { Skills } from "../common/tables/IBotBase"; +import { QuestStatus } from "../../../models/enums/QuestStatus"; +import { Health, Productive, Skills, TraderInfo } from "../common/tables/IBotBase"; import { Item, Upd } from "../common/tables/IItem"; import { IQuest } from "../common/tables/IQuest"; import { IPmcDataRepeatableQuest } from "../common/tables/IRepeatableQuests"; @@ -21,12 +22,23 @@ export interface ProfileChange { ragFairOffers: IRagfairOffer[]; builds: BuildChange[]; items: ItemChanges; - production: Record; + production: Record; /** Hideout area improvement id */ improvements: Record; skills: Skills; - traderRelations: Record; + health: Health; + traderRelations: Record; repeatableQuests?: IPmcDataRepeatableQuest[]; + recipeUnlocked: Record; + questsStatus: QuestStatusChange[]; +} +export interface QuestStatusChange { + qid: string; + startTime: number; + status: QuestStatus; + statusTimers: Record; + completedConditions: string[]; + availableAfter: number; } export interface BuildChange { id: string; @@ -39,14 +51,6 @@ export interface ItemChanges { change: Product[]; del: Product[]; } -export interface Production { - Progress: number; - StartTimestamp: number; - ProductionTime: number; - inProgress: boolean; - RecipeId: string; - Products: Product[]; -} export interface Improvement { completed: boolean; improveCompleteTimestamp: number; @@ -65,10 +69,3 @@ export interface ItemChangeLocation { r: number; isSearched?: boolean; } -export interface TraderRelations { - salesSum?: number; - standing?: number; - loyalty?: number; - unlocked?: boolean; - disabled?: boolean; -} diff --git a/types/models/eft/match/IJoinMatchResult.d.ts b/types/models/eft/match/IJoinMatchResult.d.ts index df695f4..81c9055 100644 --- a/types/models/eft/match/IJoinMatchResult.d.ts +++ b/types/models/eft/match/IJoinMatchResult.d.ts @@ -6,6 +6,8 @@ export interface IJoinMatchResult { port: number; version: string; location: string; - gamemode: string; + raidMode: string; + mode: string; shortid: string; + additional_info: any[]; } diff --git a/types/models/eft/profile/GetProfileStatusResponseData.d.ts b/types/models/eft/profile/GetProfileStatusResponseData.d.ts index cb7368c..1228c2e 100644 --- a/types/models/eft/profile/GetProfileStatusResponseData.d.ts +++ b/types/models/eft/profile/GetProfileStatusResponseData.d.ts @@ -6,7 +6,13 @@ export interface ProfileData { profileid: string; profileToken: string; status: string; - sid: string; ip: string; port: number; + sid: string; + version?: string; + location?: string; + raidMode?: string; + mode?: string; + shortId?: string; + additional_info?: any[]; } diff --git a/types/models/eft/quests/IFailQuestRequestData.d.ts b/types/models/eft/quests/IFailQuestRequestData.d.ts new file mode 100644 index 0000000..5881d91 --- /dev/null +++ b/types/models/eft/quests/IFailQuestRequestData.d.ts @@ -0,0 +1,5 @@ +export interface IFailQuestRequestData { + Action: "QuestComplete"; + qid: string; + removeExcessItems: boolean; +} diff --git a/types/models/eft/ragfair/IRagfairOffer.d.ts b/types/models/eft/ragfair/IRagfairOffer.d.ts index 792ec7d..6b28718 100644 --- a/types/models/eft/ragfair/IRagfairOffer.d.ts +++ b/types/models/eft/ragfair/IRagfairOffer.d.ts @@ -23,6 +23,7 @@ export interface IRagfairOffer { summaryCost: number; user: IRagfairOfferUser; notAvailable: boolean; + /** TODO - implement this value - not currently used */ CurrentItemCount: number; priority: boolean; } diff --git a/types/models/enums/BaseClasses.d.ts b/types/models/enums/BaseClasses.d.ts index 1081661..c6e880a 100644 --- a/types/models/enums/BaseClasses.d.ts +++ b/types/models/enums/BaseClasses.d.ts @@ -1,5 +1,6 @@ export declare enum BaseClasses { WEAPON = "5422acb9af1c889c16000029", + UBGL = "55818b014bdc2ddc698b456b", ARMOR = "5448e54d4bdc2dcc718b4568", ARMOREDEQUIPMENT = "57bef4c42459772e8d35a53b", HEADWEAR = "5a341c4086f77401f2541505", diff --git a/types/models/enums/QuestRewardType.d.ts b/types/models/enums/QuestRewardType.d.ts index 16f7e39..ff8c5f4 100644 --- a/types/models/enums/QuestRewardType.d.ts +++ b/types/models/enums/QuestRewardType.d.ts @@ -4,5 +4,6 @@ export declare enum QuestRewardType { TRADER_STANDING = "TraderStanding", TRADER_UNLOCK = "TraderUnlock", ITEM = "Item", - ASSORTMENT_UNLOCK = "AssortmentUnlock" + ASSORTMENT_UNLOCK = "AssortmentUnlock", + PRODUCTIONS_SCHEME = "ProductionScheme" } diff --git a/types/models/enums/QuestStatus.d.ts b/types/models/enums/QuestStatus.d.ts index ba65933..e706c05 100644 --- a/types/models/enums/QuestStatus.d.ts +++ b/types/models/enums/QuestStatus.d.ts @@ -7,5 +7,6 @@ export declare enum QuestStatus { Fail = 5, FailRestartable = 6, MarkedAsFailed = 7, - Expired = 8 + Expired = 8, + AvailableAfter = 9 } diff --git a/types/models/external/IPostAkiLoadModAsync.d.ts b/types/models/external/IPostAkiLoadModAsync.d.ts new file mode 100644 index 0000000..073ce6e --- /dev/null +++ b/types/models/external/IPostAkiLoadModAsync.d.ts @@ -0,0 +1,4 @@ +import { DependencyContainer } from "./tsyringe"; +export interface IPostAkiLoadModAsync { + postAkiLoadAsync(container: DependencyContainer): Promise; +} diff --git a/types/models/external/IPostDBLoadModAsync.d.ts b/types/models/external/IPostDBLoadModAsync.d.ts new file mode 100644 index 0000000..b23825a --- /dev/null +++ b/types/models/external/IPostDBLoadModAsync.d.ts @@ -0,0 +1,4 @@ +import { DependencyContainer } from "./tsyringe"; +export interface IPostDBLoadModAsync { + postDBLoadAsync(container: DependencyContainer): Promise; +} diff --git a/types/models/external/IPreAkiLoadModAsync.d.ts b/types/models/external/IPreAkiLoadModAsync.d.ts new file mode 100644 index 0000000..1249ff1 --- /dev/null +++ b/types/models/external/IPreAkiLoadModAsync.d.ts @@ -0,0 +1,4 @@ +import { DependencyContainer } from "./tsyringe"; +export interface IPreAkiLoadModAsync { + preAkiLoadAsync(container: DependencyContainer): Promise; +} diff --git a/types/models/spt/bots/GenerateWeaponResult.d.ts b/types/models/spt/bots/GenerateWeaponResult.d.ts index f099752..56fa481 100644 --- a/types/models/spt/bots/GenerateWeaponResult.d.ts +++ b/types/models/spt/bots/GenerateWeaponResult.d.ts @@ -3,7 +3,8 @@ import { Item } from "../../eft/common/tables/IItem"; import { ITemplateItem } from "../../eft/common/tables/ITemplateItem"; export declare class GenerateWeaponResult { weapon: Item[]; - chosenAmmo: string; + chosenAmmoTpl: string; + chosenUbglAmmoTpl: string; weaponMods: Mods; weaponTemplate: ITemplateItem; } diff --git a/types/models/spt/callbacks/IHideoutCallbacks.d.ts b/types/models/spt/callbacks/IHideoutCallbacks.d.ts index e9badb6..ad2af48 100644 --- a/types/models/spt/callbacks/IHideoutCallbacks.d.ts +++ b/types/models/spt/callbacks/IHideoutCallbacks.d.ts @@ -6,7 +6,7 @@ import { IHideoutPutItemInRequestData } from "../../eft/hideout/IHideoutPutItemI import { IHideoutTakeItemOutRequestData } from "../../eft/hideout/IHideoutTakeItemOutRequestData"; import { IHideoutToggleAreaRequestData } from "../../eft/hideout/IHideoutToggleAreaRequestData"; import { IHideoutSingleProductionStartRequestData } from "../../eft/hideout/IHideoutSingleProductionStartRequestData"; -import { IHideoutContinousProductionStartRequestData } from "../../eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../../eft/hideout/IHideoutContinuousProductionStartRequestData"; import { IHideoutTakeProductionRequestData } from "../../eft/hideout/IHideoutTakeProductionRequestData"; import { IItemEventRouterResponse } from "../../eft/itemEvent/IItemEventRouterResponse"; export interface IHideoutCallbacks { @@ -17,7 +17,7 @@ export interface IHideoutCallbacks { toggleArea(pmcData: IPmcData, body: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; singleProductionStart(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData, sessionID: string): IItemEventRouterResponse; scavCaseProductionStart(pmcData: IPmcData, body: IHideoutScavCaseStartRequestData, sessionID: string): IItemEventRouterResponse; - continuousProductionStart(pmcData: IPmcData, body: IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + continuousProductionStart(pmcData: IPmcData, body: IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; takeProduction(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; update(timeSinceLastRun: number): boolean; } diff --git a/types/models/spt/config/IBotConfig.d.ts b/types/models/spt/config/IBotConfig.d.ts index 895a30e..fcbc179 100644 --- a/types/models/spt/config/IBotConfig.d.ts +++ b/types/models/spt/config/IBotConfig.d.ts @@ -25,6 +25,7 @@ export interface IBotConfig extends IBaseConfig { showTypeInNickname: boolean; /** Max number of bots that can be spawned in a raid at any one time */ maxBotCap: Record; + chanceAssaultScavHasPlayerScavName: number; /** How many stacks of secret ammo should a bot have in its bot secure container */ secureContainerAmmoStackCount: number; /** Batch generation size when type not available in cache */ diff --git a/types/models/spt/config/ICoreConfig.d.ts b/types/models/spt/config/ICoreConfig.d.ts index cfcaf61..b2819a4 100644 --- a/types/models/spt/config/ICoreConfig.d.ts +++ b/types/models/spt/config/ICoreConfig.d.ts @@ -4,4 +4,5 @@ export interface ICoreConfig extends IBaseConfig { akiVersion: string; projectName: string; compatibleTarkovVersion: string; + commit: string; } diff --git a/types/models/spt/config/IHideoutConfig.d.ts b/types/models/spt/config/IHideoutConfig.d.ts index 5e878ff..0785f1e 100644 --- a/types/models/spt/config/IHideoutConfig.d.ts +++ b/types/models/spt/config/IHideoutConfig.d.ts @@ -3,10 +3,5 @@ export interface IHideoutConfig extends IBaseConfig { kind: "aki-hideout"; runIntervalSeconds: number; hoursForSkillCrafting: number; - generatorSpeedWithoutFuel: number; - generatorFuelFlowRate: number; - airFilterUnitFlowRate: number; - /** SEE HIDEOUTHELPER BEFORE CHANGING CONFIG */ - gpuBoostRate: number; hideoutWallAppearTimeSeconds: number; } diff --git a/types/models/spt/config/IInsuranceConfig.d.ts b/types/models/spt/config/IInsuranceConfig.d.ts index b27e753..fd498bc 100644 --- a/types/models/spt/config/IInsuranceConfig.d.ts +++ b/types/models/spt/config/IInsuranceConfig.d.ts @@ -5,5 +5,6 @@ export interface IInsuranceConfig extends IBaseConfig { returnChancePercent: Record; blacklistedEquipment: string[]; slotIdsWithChanceOfNotReturning: string[]; + returnTimeOverrideSeconds: number; runIntervalSeconds: number; } diff --git a/types/models/spt/config/ILocationConfig.d.ts b/types/models/spt/config/ILocationConfig.d.ts index a012fae..f808ad8 100644 --- a/types/models/spt/config/ILocationConfig.d.ts +++ b/types/models/spt/config/ILocationConfig.d.ts @@ -2,11 +2,16 @@ import { BossLocationSpawn, Wave } from "../../../models/eft/common/ILocationBas import { IBaseConfig } from "./IBaseConfig"; export interface ILocationConfig extends IBaseConfig { kind: "aki-location"; + fixEmptyBotWaves: boolean; + fixRoguesTakingAllSpawnsOnLighthouse: boolean; + lighthouseRogueSpawnTimeSeconds: number; looseLootMultiplier: LootMultiplier; staticLootMultiplier: LootMultiplier; customWaves: CustomWaves; /** Open zones to add to map */ openZones: Record; + /** Key = map id, value = item tpls that should only have one forced loot spawn position */ + forcedLootSingleSpawnById: Record; } export interface CustomWaves { boss: Record; diff --git a/types/models/spt/config/IPlayerScavConfig.d.ts b/types/models/spt/config/IPlayerScavConfig.d.ts index 5ac3966..3a65e83 100644 --- a/types/models/spt/config/IPlayerScavConfig.d.ts +++ b/types/models/spt/config/IPlayerScavConfig.d.ts @@ -9,6 +9,7 @@ export interface KarmaLevel { modifiers: Modifiers; itemLimits: ItemLimits; equipmentBlacklist: Record; + labsAccessCardChancePercent: number; } export interface Modifiers { equipment: Record; diff --git a/types/models/spt/config/IQuestConfig.d.ts b/types/models/spt/config/IQuestConfig.d.ts index 951f1a7..9adfaba 100644 --- a/types/models/spt/config/IQuestConfig.d.ts +++ b/types/models/spt/config/IQuestConfig.d.ts @@ -3,13 +3,24 @@ import { IBaseConfig } from "./IBaseConfig"; export interface IQuestConfig extends IBaseConfig { kind: "aki-quest"; redeemTime: number; + questTemplateIds: IPlayerTypeQuestIds; repeatableQuests: IRepeatableQuestConfig[]; locationIdMap: Record; bearOnlyQuests: string[]; usecOnlyQuests: string[]; } +export interface IPlayerTypeQuestIds { + pmc: IQuestTypeIds; + scav: IQuestTypeIds; +} +export interface IQuestTypeIds { + Elimination: string; + Completion: string; + Exploration: string; +} export interface IRepeatableQuestConfig { name: string; + side: string; types: string[]; resetTime: number; numQuests: number; @@ -17,11 +28,12 @@ export interface IRepeatableQuestConfig { rewardScaling: IRewardScaling; locations: Record; traderWhitelist: ITraderWhitelist[]; - questConfig: IQuestConfig; + questConfig: IRepeatableQuestTypesConfig; /** Item base types to block when generating rewards */ rewardBaseTypeBlacklist: string[]; /** Item tplIds to ignore when generating rewards */ rewardBlacklist: string[]; + rewardAmmoStackMinSize: number; } export interface IRewardScaling { levels: number[]; @@ -35,7 +47,7 @@ export interface ITraderWhitelist { traderId: string; questTypes: string[]; } -export interface IQuestConfig { +export interface IRepeatableQuestTypesConfig { Exploration: IExploration; Completion: ICompletion; Elimination: IElimination; diff --git a/types/models/spt/config/IRagfairConfig.d.ts b/types/models/spt/config/IRagfairConfig.d.ts index 6786417..3fa04de 100644 --- a/types/models/spt/config/IRagfairConfig.d.ts +++ b/types/models/spt/config/IRagfairConfig.d.ts @@ -16,7 +16,7 @@ export interface Sell { } export interface Chance { base: number; - overprices: number; + overpriced: number; underpriced: number; } export interface Time { @@ -29,6 +29,7 @@ export interface Reputation { loss: number; } export interface Dynamic { + purchasesAreFoundInRaid: boolean; barter: Barter; offerAdjustment: OfferAdjustment; expiredOfferThreshold: number; @@ -43,9 +44,10 @@ export interface Dynamic { rating: MinMax; currencies: Record; showAsSingleStack: string[]; + removeSeasonalItemsWhenNotInEvent: boolean; blacklist: Blacklist; } -export declare class Barter { +export interface Barter { enable: boolean; chancePercent: number; itemCountMin: number; @@ -54,7 +56,7 @@ export declare class Barter { minRoubleCostToBecomeBarter: number; itemTypeBlacklist: string[]; } -export declare class OfferAdjustment { +export interface OfferAdjustment { maxPriceDifferenceBelowHandbookPercent: number; handbookPriceMultipier: number; priceThreshholdRub: number; diff --git a/types/models/spt/config/IRepairConfig.d.ts b/types/models/spt/config/IRepairConfig.d.ts index 8f6945c..b6db332 100644 --- a/types/models/spt/config/IRepairConfig.d.ts +++ b/types/models/spt/config/IRepairConfig.d.ts @@ -1,3 +1,4 @@ +import { MinMax } from "../../../models/common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface IRepairConfig extends IBaseConfig { kind: "aki-repair"; @@ -5,4 +6,20 @@ export interface IRepairConfig extends IBaseConfig { applyRandomizeDurabilityLoss: boolean; weaponSkillRepairGain: number; armorKitSkillPointGainPerRepairPointMultiplier: number; + repairKit: RepairKit; +} +export interface RepairKit { + armor: BonusSettings; + weapon: BonusSettings; +} +export interface BonusSettings { + rarityWeight: Record; + bonusTypeWeight: Record; + common: Record; + rare: Record; +} +export interface BonusValues { + valuesMinMax: MinMax; + /** What dura is buff active between (min max of current max) */ + activeDurabilityPercentMinMax: MinMax; } diff --git a/types/models/spt/mod/IMod.d.ts b/types/models/spt/mod/IMod.d.ts deleted file mode 100644 index e6eec79..0000000 --- a/types/models/spt/mod/IMod.d.ts +++ /dev/null @@ -1,10 +0,0 @@ -export declare namespace ModLoader { - interface IMod { - name: string; - version: string; - main?: string; - author?: string; - license: string; - dependencies?: Record; - } -} diff --git a/types/models/spt/mod/IModLoader.d.ts b/types/models/spt/mod/IModLoader.d.ts index 40a5e19..9a71f61 100644 --- a/types/models/spt/mod/IModLoader.d.ts +++ b/types/models/spt/mod/IModLoader.d.ts @@ -1,7 +1,5 @@ import { DependencyContainer } from "tsyringe"; export interface IModLoader { load(container: DependencyContainer): void; - getBundles(local: boolean): string; - getBundle(key: string, local: boolean): void; getModPath(mod: string): string; } diff --git a/types/models/spt/mod/IPackageJsonData.d.ts b/types/models/spt/mod/IPackageJsonData.d.ts index 99e4ef9..06f7454 100644 --- a/types/models/spt/mod/IPackageJsonData.d.ts +++ b/types/models/spt/mod/IPackageJsonData.d.ts @@ -1,6 +1,6 @@ export interface IPackageJsonData { incompatibilities?: string[]; - dependencies?: string[]; + dependencies?: Record; modDependencies?: Record; name: string; author: string; @@ -8,5 +8,6 @@ export interface IPackageJsonData { akiVersion: string; licence: string; main: string; + isBundleMod: boolean; contributors: string[]; } diff --git a/types/models/spt/server/IDatabaseTables.d.ts b/types/models/spt/server/IDatabaseTables.d.ts index ad8f729..582d9e2 100644 --- a/types/models/spt/server/IDatabaseTables.d.ts +++ b/types/models/spt/server/IDatabaseTables.d.ts @@ -42,8 +42,6 @@ export interface IDatabaseTables { items: Record; quests: Record; repeatableQuests: IRepeatableQuestDatabase; - /** DEPRECATED - Items file found in the client, massivly out of date compared to templates.items, try not to use this, remove ASAP*/ - clientItems: Record; handbook: IHandbookBase; customization: Record; /** The profile templates listed in the launcher on profile creation, split by account type (e.g. Standard) then side (e.g. bear/usec) */ diff --git a/types/models/spt/server/ISettingsBase.d.ts b/types/models/spt/server/ISettingsBase.d.ts index 625ad5c..2870cfb 100644 --- a/types/models/spt/server/ISettingsBase.d.ts +++ b/types/models/spt/server/ISettingsBase.d.ts @@ -10,6 +10,7 @@ export interface Config { FirstCycleDelaySeconds: number; FramerateLimit: FramerateLimit; GroupStatusInterval: number; + GroupStatusButtonInterval: number; KeepAliveInterval: number; LobbyKeepAliveInterval: number; Mark502and504AsNonImportant: boolean; diff --git a/types/routers/EventOutputHolder.d.ts b/types/routers/EventOutputHolder.d.ts index 7a2387b..9a34219 100644 --- a/types/routers/EventOutputHolder.d.ts +++ b/types/routers/EventOutputHolder.d.ts @@ -1,11 +1,41 @@ -import { JsonUtil } from "../utils/JsonUtil"; import { ProfileHelper } from "../helpers/ProfileHelper"; +import { IPmcData } from "../models/eft/common/IPmcData"; +import { IHideoutImprovement, Productive } from "../models/eft/common/tables/IBotBase"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +import { JsonUtil } from "../utils/JsonUtil"; +import { TimeUtil } from "../utils/TimeUtil"; export declare class EventOutputHolder { protected jsonUtil: JsonUtil; protected profileHelper: ProfileHelper; - constructor(jsonUtil: JsonUtil, profileHelper: ProfileHelper); + protected timeUtil: TimeUtil; + /** What has client been informed of this game session */ + protected clientActiveSessionStorage: Record; + constructor(jsonUtil: JsonUtil, profileHelper: ProfileHelper, timeUtil: TimeUtil); protected output: IItemEventRouterResponse; getOutput(sessionID: string): IItemEventRouterResponse; + /** + * Reset the response object to a default state + * Occurs prior to event being handled by server + * @param sessionID Players id + */ resetOutput(sessionID: string): void; + /** + * Update output object with most recent values from player profile + * @param sessionId Session id + */ + updateOutputProperties(sessionId: string): void; + /** + * Return all hideout Improvements from player profile, adjust completed Improvements' completed property to be true + * @param pmcData Player profile + * @returns dictionary of hideout improvements + */ + protected getImprovementsFromProfileAndFlagComplete(pmcData: IPmcData): Record; + /** + * Return productions from player profile except those completed crafts the client has already seen + * @param pmcData Player profile + * @returns dictionary of hideout productions + */ + protected getProductionsFromProfileAndFlagComplete(productions: Record): Record; } diff --git a/types/routers/ItemEventRouter.d.ts b/types/routers/ItemEventRouter.d.ts index a9338ab..9c7f70e 100644 --- a/types/routers/ItemEventRouter.d.ts +++ b/types/routers/ItemEventRouter.d.ts @@ -12,5 +12,11 @@ export declare class ItemEventRouter { protected localisationService: LocalisationService; protected eventOutputHolder: EventOutputHolder; constructor(logger: ILogger, profileHelper: ProfileHelper, itemEventRouters: ItemEventRouterDefinition[], localisationService: LocalisationService, eventOutputHolder: EventOutputHolder); + /** + * + * @param info Event request + * @param sessionID Session id + * @returns Item response + */ handleEvents(info: IItemEventRouterRequest, sessionID: string): IItemEventRouterResponse; } diff --git a/types/routers/item_events/CustomizationItemEventRouter.d.ts b/types/routers/item_events/CustomizationItemEventRouter.d.ts index e78445e..32519b1 100644 --- a/types/routers/item_events/CustomizationItemEventRouter.d.ts +++ b/types/routers/item_events/CustomizationItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { CustomizationCallbacks } from "../../callbacks/CustomizationCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class CustomizationItemEventRouter extends ItemEventRouterDefinition { protected customizationCallbacks: CustomizationCallbacks; constructor(customizationCallbacks: CustomizationCallbacks); diff --git a/types/routers/item_events/HealthItemEventRouter.d.ts b/types/routers/item_events/HealthItemEventRouter.d.ts index 99847c6..2b2b91d 100644 --- a/types/routers/item_events/HealthItemEventRouter.d.ts +++ b/types/routers/item_events/HealthItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { HealthCallbacks } from "../../callbacks/HealthCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class HealthItemEventRouter extends ItemEventRouterDefinition { protected healthCallbacks: HealthCallbacks; constructor(healthCallbacks: HealthCallbacks); diff --git a/types/routers/item_events/InsuranceItemEventRouter.d.ts b/types/routers/item_events/InsuranceItemEventRouter.d.ts index a922cc0..3b6ae8c 100644 --- a/types/routers/item_events/InsuranceItemEventRouter.d.ts +++ b/types/routers/item_events/InsuranceItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { InsuranceCallbacks } from "../../callbacks/InsuranceCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class InsuranceItemEventRouter extends ItemEventRouterDefinition { protected insuranceCallbacks: InsuranceCallbacks; constructor(insuranceCallbacks: InsuranceCallbacks); diff --git a/types/routers/item_events/NoteItemEventRouter.d.ts b/types/routers/item_events/NoteItemEventRouter.d.ts index 59bf598..71ed5d4 100644 --- a/types/routers/item_events/NoteItemEventRouter.d.ts +++ b/types/routers/item_events/NoteItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { NoteCallbacks } from "../../callbacks/NoteCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class NoteItemEventRouter extends ItemEventRouterDefinition { protected noteCallbacks: NoteCallbacks; constructor(noteCallbacks: NoteCallbacks); diff --git a/types/routers/item_events/PresetBuildItemEventRouter.d.ts b/types/routers/item_events/PresetBuildItemEventRouter.d.ts index 277db44..f2a7bf3 100644 --- a/types/routers/item_events/PresetBuildItemEventRouter.d.ts +++ b/types/routers/item_events/PresetBuildItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { PresetBuildCallbacks } from "../../callbacks/PresetBuildCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class PresetBuildItemEventRouter extends ItemEventRouterDefinition { protected presetBuildCallbacks: PresetBuildCallbacks; constructor(presetBuildCallbacks: PresetBuildCallbacks); diff --git a/types/routers/item_events/RagfairItemEventRouter.d.ts b/types/routers/item_events/RagfairItemEventRouter.d.ts index 9216cc5..986d9e7 100644 --- a/types/routers/item_events/RagfairItemEventRouter.d.ts +++ b/types/routers/item_events/RagfairItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { RagfairCallbacks } from "../../callbacks/RagfairCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class RagfairItemEventRouter extends ItemEventRouterDefinition { protected ragfairCallbacks: RagfairCallbacks; constructor(ragfairCallbacks: RagfairCallbacks); diff --git a/types/routers/item_events/RepairItemEventRouter.d.ts b/types/routers/item_events/RepairItemEventRouter.d.ts index 5196ba9..1c2768c 100644 --- a/types/routers/item_events/RepairItemEventRouter.d.ts +++ b/types/routers/item_events/RepairItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { RepairCallbacks } from "../../callbacks/RepairCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class RepairItemEventRouter extends ItemEventRouterDefinition { protected repairCallbacks: RepairCallbacks; constructor(repairCallbacks: RepairCallbacks); diff --git a/types/routers/item_events/TradeItemEventRouter.d.ts b/types/routers/item_events/TradeItemEventRouter.d.ts index a43bb0a..5d84559 100644 --- a/types/routers/item_events/TradeItemEventRouter.d.ts +++ b/types/routers/item_events/TradeItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { TradeCallbacks } from "../../callbacks/TradeCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class TradeItemEventRouter extends ItemEventRouterDefinition { protected tradeCallbacks: TradeCallbacks; constructor(tradeCallbacks: TradeCallbacks); diff --git a/types/routers/item_events/WishlistItemEventRouter.d.ts b/types/routers/item_events/WishlistItemEventRouter.d.ts index 38497fb..9e3c2a0 100644 --- a/types/routers/item_events/WishlistItemEventRouter.d.ts +++ b/types/routers/item_events/WishlistItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { WishlistCallbacks } from "../../callbacks/WishlistCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class WishlistItemEventRouter extends ItemEventRouterDefinition { protected wishlistCallbacks: WishlistCallbacks; constructor(wishlistCallbacks: WishlistCallbacks); diff --git a/types/routers/save_load/HealthSaveLoadRouter.d.ts b/types/routers/save_load/HealthSaveLoadRouter.d.ts index 114f5b2..26cb07a 100644 --- a/types/routers/save_load/HealthSaveLoadRouter.d.ts +++ b/types/routers/save_load/HealthSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class HealthSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/save_load/InraidSaveLoadRouter.d.ts b/types/routers/save_load/InraidSaveLoadRouter.d.ts index 4c00b40..40f388e 100644 --- a/types/routers/save_load/InraidSaveLoadRouter.d.ts +++ b/types/routers/save_load/InraidSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class InraidSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/save_load/InsuranceSaveLoadRouter.d.ts b/types/routers/save_load/InsuranceSaveLoadRouter.d.ts index 30ce98e..22d645e 100644 --- a/types/routers/save_load/InsuranceSaveLoadRouter.d.ts +++ b/types/routers/save_load/InsuranceSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class InsuranceSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/save_load/ProfileSaveLoadRouter.d.ts b/types/routers/save_load/ProfileSaveLoadRouter.d.ts index 16c7619..f60af15 100644 --- a/types/routers/save_load/ProfileSaveLoadRouter.d.ts +++ b/types/routers/save_load/ProfileSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class ProfileSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/serializers/ImageSerializer.d.ts b/types/routers/serializers/ImageSerializer.d.ts index 7f15bcf..5de48ff 100644 --- a/types/routers/serializers/ImageSerializer.d.ts +++ b/types/routers/serializers/ImageSerializer.d.ts @@ -1,7 +1,7 @@ /// +import { IncomingMessage, ServerResponse } from "http"; import { Serializer } from "../../di/Serializer"; import { ImageRouter } from "../ImageRouter"; -import { IncomingMessage, ServerResponse } from "http"; export declare class ImageSerializer extends Serializer { protected imageRouter: ImageRouter; constructor(imageRouter: ImageRouter); diff --git a/types/servers/SaveServer.d.ts b/types/servers/SaveServer.d.ts index 4dca514..402befc 100644 --- a/types/servers/SaveServer.d.ts +++ b/types/servers/SaveServer.d.ts @@ -14,17 +14,71 @@ export declare class SaveServer { protected logger: ILogger; protected profileFilepath: string; protected profiles: {}; - protected onSave: {}; + protected onBeforeSaveCallbacks: {}; protected saveMd5: {}; constructor(vfs: VFS, saveLoadRouters: SaveLoadRouter[], jsonUtil: JsonUtil, hashUtil: HashUtil, localisationService: LocalisationService, logger: ILogger); + /** + * Add callback to occur prior to saving profile changes + * @param id Id for save callback + * @param callback Callback to execute prior to running SaveServer.saveProfile() + */ + addBeforeSaveCallback(id: string, callback: (profile: Partial) => Partial): void; + /** + * Remove a callback from being executed prior to saving profile in SaveServer.saveProfile() + * @param id Id of callback to remove + */ + removeBeforeSaveCallback(id: string): void; + /** + * Load all profiles in /user/profiles folder into memory (this.profiles) + */ load(): void; + /** + * Save changes for each profile from memory into user/profiles json + */ save(): void; + /** + * Get a player profile from memory + * @param sessionId Session id + * @returns IAkiProfile + */ getProfile(sessionId: string): IAkiProfile; + /** + * Get all profiles from memory + * @returns Dictionary of IAkiProfile + */ getProfiles(): Record; + /** + * Delete a profile by id + * @param sessionID Id of profile to remove + * @returns true when deleted, false when profile not found + */ deleteProfileById(sessionID: string): boolean; + /** + * Create a new profile in memory with empty pmc/scav objects + * @param profileInfo Basic profile data + */ createProfile(profileInfo: Info): void; + /** + * Add full profile in memory by key (info.id) + * @param profileDetails Profile to save + */ addProfile(profileDetails: IAkiProfile): void; + /** + * Look up profile json in user/profiles by id and store in memory + * Execute saveLoadRouters callbacks after being loaded into memory + * @param sessionID Id of profile to store in memory + */ loadProfile(sessionID: string): void; + /** + * Save changes from in-memory profile to user/profiles json + * Execute onBeforeSaveCallbacks callbacks prior to being saved to json + * @param sessionID profile id (user/profiles/id.json) + */ saveProfile(sessionID: string): void; + /** + * Remove a physical profile json from user/profiles + * @param sessionID Profile id to remove + * @returns true if file no longer exists + */ removeProfile(sessionID: string): boolean; } diff --git a/types/servers/http/AkiHttpListener.d.ts b/types/servers/http/AkiHttpListener.d.ts index e4d7110..d02861e 100644 --- a/types/servers/http/AkiHttpListener.d.ts +++ b/types/servers/http/AkiHttpListener.d.ts @@ -13,17 +13,18 @@ export declare class AkiHttpListener implements IHttpListener { protected httpRouter: HttpRouter; protected serializers: Serializer[]; protected logger: ILogger; + protected requestsLogger: ILogger; protected jsonUtil: JsonUtil; protected httpResponse: HttpResponseUtil; protected localisationService: LocalisationService; protected httpBufferHandler: HttpBufferHandler; constructor(httpRouter: HttpRouter, // TODO: delay required - serializers: Serializer[], logger: ILogger, jsonUtil: JsonUtil, httpResponse: HttpResponseUtil, localisationService: LocalisationService, httpBufferHandler: HttpBufferHandler); + serializers: Serializer[], logger: ILogger, requestsLogger: ILogger, jsonUtil: JsonUtil, httpResponse: HttpResponseUtil, localisationService: LocalisationService, httpBufferHandler: HttpBufferHandler); canHandle(_: string, req: IncomingMessage): boolean; handle(sessionId: string, req: IncomingMessage, resp: ServerResponse): void; sendResponse(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: Buffer, output: string): void; getResponse(sessionID: string, req: IncomingMessage, body: Buffer): string; - protected getBodyInfo(body: Buffer): string; - sendJson(resp: ServerResponse, output: any, sessionID: string): void; - sendZlibJson(resp: ServerResponse, output: any, sessionID: string): void; + protected getBodyInfo(body: Buffer): any; + sendJson(resp: ServerResponse, output: string, sessionID: string): void; + sendZlibJson(resp: ServerResponse, output: string, sessionID: string): void; } diff --git a/types/services/BotEquipmentFilterService.d.ts b/types/services/BotEquipmentFilterService.d.ts index db41a8c..089cfb5 100644 --- a/types/services/BotEquipmentFilterService.d.ts +++ b/types/services/BotEquipmentFilterService.d.ts @@ -58,14 +58,14 @@ export declare class BotEquipmentFilterService { */ protected getBotEquipmentWhitelist(botRole: string, playerLevel: number): EquipmentFilterDetails; /** - * Retreive clothing weighting adjustments from bot.json config + * Retrieve clothing weighting adjustments from bot.json config * @param botRole Bot type to get adjustments for * @param playerLevel level of player * @returns Weighting adjustments for bots clothing */ protected getBotClothingAdjustments(botRole: string, playerLevel: number): WeightingAdjustmentDetails; /** - * Retreive item weighting adjustments from bot.json config + * Retrieve item weighting adjustments from bot.json config * @param botRole Bot type to get adjustments for * @param playerLevel level of player * @returns Weighting adjustments for bot items @@ -73,7 +73,7 @@ export declare class BotEquipmentFilterService { protected getBotWeightingAdjustments(botRole: string, playerLevel: number): WeightingAdjustmentDetails; /** * Filter bot equipment based on blacklist and whitelist from config/bot.json - * Prioritises whitelist first, if one is found blacklist is ignored + * Prioritizes whitelist first, if one is found blacklist is ignored * @param baseBotNode bot .json file to update * @param blacklist equipment blacklist * @returns Filtered bot file @@ -81,10 +81,10 @@ export declare class BotEquipmentFilterService { protected filterEquipment(baseBotNode: IBotType, blacklist: EquipmentFilterDetails, whitelist: EquipmentFilterDetails): void; /** * Filter bot cartridges based on blacklist and whitelist from config/bot.json - * Prioritises whitelist first, if one is found blacklist is ignored + * Prioritizes whitelist first, if one is found blacklist is ignored * @param baseBotNode bot .json file to update * @param blacklist equipment on this list should be excluded from the bot - * @param whitelist equipment on this list should be used exclusivly + * @param whitelist equipment on this list should be used exclusively * @returns Filtered bot file */ protected filterCartridges(baseBotNode: IBotType, blacklist: EquipmentFilterDetails, whitelist: EquipmentFilterDetails): void; diff --git a/types/services/FenceService.d.ts b/types/services/FenceService.d.ts index 4e3cab2..d143380 100644 --- a/types/services/FenceService.d.ts +++ b/types/services/FenceService.d.ts @@ -33,12 +33,22 @@ export declare class FenceService { protected itemFilterService: ItemFilterService; protected localisationService: LocalisationService; protected configServer: ConfigServer; + /** Main assorts you see at all rep levels */ protected fenceAssort: ITraderAssort; + /** Assorts shown on a separte tab when you max out fence rep */ protected fenceDiscountAssort: ITraderAssort; protected traderConfig: ITraderConfig; protected nextMiniRefreshTimestamp: number; constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, timeUtil: TimeUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, itemHelper: ItemHelper, presetHelper: PresetHelper, itemFilterService: ItemFilterService, localisationService: LocalisationService, configServer: ConfigServer); + /** + * Replace main fence assort with new assort + * @param assort New assorts to replace old with + */ protected setFenceAssort(assort: ITraderAssort): void; + /** + * Replace high rep level fence assort with new assort + * @param assort New assorts to replace old with + */ protected setFenceDiscountAssort(assort: ITraderAssort): void; /** * Get assorts player can purchase @@ -131,9 +141,9 @@ export declare class FenceService { /** * Add preset weapons to fence presets * @param assortCount how many assorts to add to assorts - * @param defaultWeaponPresets + * @param defaultWeaponPresets a dictionary of default weapon presets * @param assorts object to add presets to - * @param loyaltyLevel + * @param loyaltyLevel loyalty level to requre item at */ protected addPresets(desiredPresetCount: number, defaultWeaponPresets: Record, assorts: ITraderAssort, loyaltyLevel: number): void; /** diff --git a/types/services/InsuranceService.d.ts b/types/services/InsuranceService.d.ts index 9328b54..886a298 100644 --- a/types/services/InsuranceService.d.ts +++ b/types/services/InsuranceService.d.ts @@ -1,3 +1,4 @@ +import { ITraderBase } from "../models/eft/common/tables/ITrader"; import { DialogueHelper } from "../helpers/DialogueHelper"; import { HandbookHelper } from "../helpers/HandbookHelper"; import { SecureContainerHelper } from "../helpers/SecureContainerHelper"; @@ -49,6 +50,13 @@ export declare class InsuranceService { * @param mapId Id of the map player died/exited that caused the insurance to be issued on */ sendInsuredItems(pmcData: IPmcData, sessionID: string, mapId: string): void; + /** + * Get a timestamp of what insurance items should be sent to player based on the type of trader used to insure + * @param pmcData Player profile + * @param trader Trader used to insure items + * @returns Timestamp to return items to player in seconds + */ + protected getInsuranceReturnTimestamp(pmcData: IPmcData, trader: ITraderBase): number; /** * Store lost gear post-raid inside profile * @param pmcData player profile to store gear in diff --git a/types/services/PaymentService.d.ts b/types/services/PaymentService.d.ts index 9517f13..ac131ea 100644 --- a/types/services/PaymentService.d.ts +++ b/types/services/PaymentService.d.ts @@ -25,12 +25,12 @@ export declare class PaymentService { constructor(logger: ILogger, httpResponse: HttpResponseUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, traderHelper: TraderHelper, itemHelper: ItemHelper, inventoryHelper: InventoryHelper, localisationService: LocalisationService, paymentHelper: PaymentHelper); /** * Take money and insert items into return to server request - * @param {Object} pmcData - * @param {Object} body + * @param {IPmcData} pmcData Player profile + * @param {IProcessBuyTradeRequestData} request * @param {string} sessionID * @returns Object */ - payMoney(pmcData: IPmcData, body: IProcessBuyTradeRequestData, sessionID: string, output: IItemEventRouterResponse): IItemEventRouterResponse; + payMoney(pmcData: IPmcData, request: IProcessBuyTradeRequestData, sessionID: string, output: IItemEventRouterResponse): IItemEventRouterResponse; /** * Receive money back after selling * @param {IPmcData} pmcData diff --git a/types/services/PlayerService.d.ts b/types/services/PlayerService.d.ts index 2f364d5..1195b93 100644 --- a/types/services/PlayerService.d.ts +++ b/types/services/PlayerService.d.ts @@ -1,5 +1,4 @@ import { IPmcData } from "../models/eft/common/IPmcData"; -import { IPlayerIncrementSkillLevelRequestData } from "../models/eft/player/IPlayerIncrementSkillLevelRequestData"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocalisationService } from "./LocalisationService"; @@ -11,11 +10,10 @@ export declare class PlayerService { /** * increases the profile skill and updates any output * @param {Object} pmcData - * @param {Object} output * @param {String} skillName * @param {Number} amount */ - incrementSkillLevel(pmcData: IPmcData, output: IPlayerIncrementSkillLevelRequestData, skillName: string, amount: number): void; + incrementSkillLevel(pmcData: IPmcData, skillName: string, amount: number): void; /** * @param {Object} pmcData * @returns number diff --git a/types/services/ProfileFixerService.d.ts b/types/services/ProfileFixerService.d.ts index 5130dc0..8d23ebc 100644 --- a/types/services/ProfileFixerService.d.ts +++ b/types/services/ProfileFixerService.d.ts @@ -35,6 +35,7 @@ export declare class ProfileFixerService { */ removeDanglingConditionCounters(pmcProfile: IPmcData): void; addLighthouseKeeperIfMissing(pmcProfile: IPmcData): void; + protected addUnlockedInfoObjectIfMissing(pmcProfile: IPmcData): void; protected removeDanglingBackendCounters(pmcProfile: IPmcData): void; protected getActiveRepeatableQuests(repeatableQuests: IPmcDataRepeatableQuest[]): IRepeatableQuest[]; protected fixNullTraderSalesSums(pmcProfile: IPmcData): void; @@ -48,6 +49,11 @@ export declare class ProfileFixerService { protected updateProfileQuestDataValues(pmcProfile: IPmcData): void; protected addMissingRepeatableQuestsProperty(pmcProfile: IPmcData): void; protected addMissingWorkbenchWeaponSkills(pmcProfile: IPmcData): void; + /** + * Some profiles have hideout maxed and therefore no improvements + * @param pmcProfile Profile to add improvement data to + */ + protected addMissingWallImprovements(pmcProfile: IPmcData): void; /** * A new property was added to slot items "locationIndex", if this is missing, the hideout slot item must be removed * @param pmcProfile Profile to find and remove slots from @@ -98,4 +104,9 @@ export declare class ProfileFixerService { * @param fullProfile Profile to update */ addMissingHideoutAreasToProfile(fullProfile: IAkiProfile): void; + /** + * These used to be used for storing scav case rewards, rewards are now generated on pickup + * @param pmcProfile Profile to update + */ + removeLegacyScavCaseProductionCrafts(pmcProfile: IPmcData): void; } diff --git a/types/services/RagfairLinkedItemService.d.ts b/types/services/RagfairLinkedItemService.d.ts index 6c34ee0..51511f9 100644 --- a/types/services/RagfairLinkedItemService.d.ts +++ b/types/services/RagfairLinkedItemService.d.ts @@ -1,10 +1,21 @@ -import { DatabaseServer } from "../servers/DatabaseServer"; +import { ItemHelper } from "../helpers/ItemHelper"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { DatabaseServer } from "../servers/DatabaseServer"; export declare class RagfairLinkedItemService { protected databaseServer: DatabaseServer; + protected itemHelper: ItemHelper; protected linkedItemsCache: Record>; - constructor(databaseServer: DatabaseServer); + constructor(databaseServer: DatabaseServer, itemHelper: ItemHelper); getLinkedItems(linkedSearchId: string): Iterable; + /** + * Create Dictionary of every item and the items associated with it + */ protected buildLinkedItemTable(): void; + /** + * Add ammo to revolvers linked item dictionary + * @param cylinder Revolvers cylinder + * @param applyLinkedItems + */ + protected addRevolverCylinderAmmoToLinkedItems(cylinder: ITemplateItem, applyLinkedItems: (items: string[]) => void): void; protected getFilters(item: ITemplateItem, slot: string): string[]; } diff --git a/types/services/RagfairOfferService.d.ts b/types/services/RagfairOfferService.d.ts index 133e6a7..fc08d39 100644 --- a/types/services/RagfairOfferService.d.ts +++ b/types/services/RagfairOfferService.d.ts @@ -1,4 +1,3 @@ -import { RagfairOfferHolder } from "../utils/RagfairOfferHolder"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { RagfairServerHelper } from "../helpers/RagfairServerHelper"; import { Item } from "../models/eft/common/tables/IItem"; @@ -11,6 +10,7 @@ import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +import { RagfairOfferHolder } from "../utils/RagfairOfferHolder"; import { TimeUtil } from "../utils/TimeUtil"; import { LocalisationService } from "./LocalisationService"; import { RagfairCategoriesService } from "./RagfairCategoriesService"; @@ -53,8 +53,17 @@ export declare class RagfairOfferService { * @returns offer exists - true */ doesOfferExist(offerId: string): boolean; + /** + * Remove an offer from ragfair by offer id + * @param offerId Offer id to remove + */ removeOfferById(offerId: string): void; - removeOfferStack(offerID: string, amount: number): void; + /** + * Reduce size of an offer stack by specified amount + * @param offerId Offer to adjust stack size of + * @param amount How much to deduct from offers stack size + */ + removeOfferStack(offerId: string, amount: number): void; removeAllOffersByTrader(traderId: string): void; /** * Do the trader offers on flea need to be refreshed @@ -64,6 +73,10 @@ export declare class RagfairOfferService { traderOffersNeedRefreshing(traderID: string): boolean; addPlayerOffers(): void; expireStaleOffers(): void; + /** + * Remove stale offer from flea + * @param staleOffer Stale offer to process + */ protected processStaleOffer(staleOffer: IRagfairOffer): void; protected returnPlayerOffer(offer: IRagfairOffer): IItemEventRouterResponse; } diff --git a/types/services/RagfairPriceService.d.ts b/types/services/RagfairPriceService.d.ts index 50d349d..8b68bc4 100644 --- a/types/services/RagfairPriceService.d.ts +++ b/types/services/RagfairPriceService.d.ts @@ -1,6 +1,8 @@ +import { OnLoad } from "../di/OnLoad"; import { HandbookHelper } from "../helpers/HandbookHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; +import { TraderHelper } from "../helpers/TraderHelper"; import { Preset } from "../models/eft/common/IGlobals"; import { Item } from "../models/eft/common/tables/IItem"; import { IBarterScheme } from "../models/eft/common/tables/ITrader"; @@ -10,7 +12,6 @@ import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { RandomUtil } from "../utils/RandomUtil"; -import { OnLoad } from "../di/OnLoad"; /** * Stores flea prices for items as well as methods to interact with them */ @@ -20,13 +21,14 @@ export declare class RagfairPriceService implements OnLoad { protected logger: ILogger; protected itemHelper: ItemHelper; protected presetHelper: PresetHelper; + protected traderHelper: TraderHelper; protected randomUtil: RandomUtil; protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; protected generatedDynamicPrices: boolean; protected generatedStaticPrices: boolean; protected prices: IRagfairServerPrices; - constructor(handbookHelper: HandbookHelper, databaseServer: DatabaseServer, logger: ILogger, itemHelper: ItemHelper, presetHelper: PresetHelper, randomUtil: RandomUtil, configServer: ConfigServer); + constructor(handbookHelper: HandbookHelper, databaseServer: DatabaseServer, logger: ILogger, itemHelper: ItemHelper, presetHelper: PresetHelper, traderHelper: TraderHelper, randomUtil: RandomUtil, configServer: ConfigServer); /** * Generate static (handbook) and dynamic (prices.json) flea prices, store inside class as dictionaries */ @@ -41,7 +43,7 @@ export declare class RagfairPriceService implements OnLoad { */ protected generateDynamicPrices(): void; /** - * Get the dynamic price for an item. If value doesn't exist, use static (handbook0) value. + * Get the dynamic price for an item. If value doesn't exist, use static (handbook) value. * if no static value, return 1 * @param tplId Item tpl id to get price for * @returns price in roubles @@ -108,11 +110,20 @@ export declare class RagfairPriceService implements OnLoad { * @returns */ protected getWeaponPresetPrice(item: Item, items: Item[], existingPrice: number): number; + /** + * Get the highest price for an item that is stored in handbook or trader assorts + * @param itemTpl Item to get highest price of + * @returns rouble cost + */ + protected getHighestHandbookOrTraderPriceAsRouble(itemTpl: string): number; /** * Attempt to get the default preset for a weapon, failing that get the first preset in the array * (assumes default = has encyclopedia entry) * @param presets weapon presets to choose from * @returns Default preset object */ - protected getDefaultWeaponPreset(presets: Preset[], weapon: Item): Preset; + protected getWeaponPreset(presets: Preset[], weapon: Item): { + isDefault: boolean; + preset: Preset; + }; } diff --git a/types/services/RepairService.d.ts b/types/services/RepairService.d.ts index c2d9088..a3c6c7a 100644 --- a/types/services/RepairService.d.ts +++ b/types/services/RepairService.d.ts @@ -2,28 +2,32 @@ import { ItemHelper } from "../helpers/ItemHelper"; import { QuestHelper } from "../helpers/QuestHelper"; import { RepairHelper } from "../helpers/RepairHelper"; import { TraderHelper } from "../helpers/TraderHelper"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { Item } from "../models/eft/common/tables/IItem"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { RepairKitsInfo } from "../models/eft/repair/IRepairActionDataRequest"; import { RepairItem } from "../models/eft/repair/ITraderRepairActionDataRequest"; -import { IRepairConfig } from "../models/spt/config/IRepairConfig"; +import { BonusSettings, IRepairConfig } from "../models/spt/config/IRepairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { RandomUtil } from "../utils/RandomUtil"; import { PaymentService } from "./PaymentService"; export declare class RepairService { protected logger: ILogger; protected databaseServer: DatabaseServer; protected questHelper: QuestHelper; + protected randomUtil: RandomUtil; protected itemHelper: ItemHelper; protected traderHelper: TraderHelper; + protected weightedRandomHelper: WeightedRandomHelper; protected paymentService: PaymentService; protected repairHelper: RepairHelper; protected configServer: ConfigServer; - repairConfig: IRepairConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, questHelper: QuestHelper, itemHelper: ItemHelper, traderHelper: TraderHelper, paymentService: PaymentService, repairHelper: RepairHelper, configServer: ConfigServer); + protected repairConfig: IRepairConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, questHelper: QuestHelper, randomUtil: RandomUtil, itemHelper: ItemHelper, traderHelper: TraderHelper, weightedRandomHelper: WeightedRandomHelper, paymentService: PaymentService, repairHelper: RepairHelper, configServer: ConfigServer); /** * Use trader to repair an items durability * @param sessionID Session id @@ -48,9 +52,8 @@ export declare class RepairService { * @param sessionId Session id * @param repairDetails details of item repaired, cost/item * @param pmcData Profile to add points to - * @param output IItemEventRouterResponse */ - addRepairSkillPoints(sessionId: string, repairDetails: RepairDetails, pmcData: IPmcData, output: IItemEventRouterResponse): void; + addRepairSkillPoints(sessionId: string, repairDetails: RepairDetails, pmcData: IPmcData): void; /** * * @param sessionId Session id @@ -61,12 +64,60 @@ export declare class RepairService { * @returns Details of repair, item/price */ repairItemByKit(sessionId: string, pmcData: IPmcData, repairKits: RepairKitsInfo[], itemToRepairId: string, output: IItemEventRouterResponse): RepairDetails; + /** + * Calculate value repairkit points need to be divided by to get the durability points to be added to an item + * @param itemToRepairDetails Item to repair details + * @param isArmor Is the item being repaired armor + * @param pmcData Player profile + * @returns Number to divide kit points by + */ + protected getKitDivisor(itemToRepairDetails: ITemplateItem, isArmor: boolean, pmcData: IPmcData): number; + /** + * Get the bonus multiplier for a skill from a player profile + * @param skillBonusName Name of bonus to get multipler of + * @param pmcData Player profile to look in for skill + * @returns Multiplier value + */ + protected getBonusMultiplierValue(skillBonusName: string, pmcData: IPmcData): number; /** * Update repair kits Resource object if it doesn't exist * @param repairKitDetails Repair kit details from db * @param repairKitInInventory Repair kit to update */ protected addMaxResourceToKitIfMissing(repairKitDetails: ITemplateItem, repairKitInInventory: Item): void; + /** + * Chance to apply buff to an item (Armor/weapon) if repaired by armor kit + * @param repairDetails Repair details of item + * @param pmcData Player profile + */ + addBuffToItem(repairDetails: RepairDetails, pmcData: IPmcData): void; + /** + * Add buff to item + * @param itemConfig weapon/armor config + * @param repairDetails Details for item to repair + */ + protected addBuff(itemConfig: BonusSettings, repairDetails: RepairDetails): void; + /** + * Check if item should be buffed by checking the item type and relevant player skill level + * @param repairDetails Item that was repaired + * @param itemTpl tpl of item to be buffed + * @param pmcData Player profile + * @returns True if item should have buff applied + */ + protected shouldBuffItem(repairDetails: RepairDetails, pmcData: IPmcData): boolean; + /** + * Based on item, what underlying skill does this item use for buff settings + * @param itemTemplate Item to check for skill + * @returns Skill name + */ + protected getItemSkillType(itemTemplate: ITemplateItem): string; + /** + * Ensure multiplier is between 1 and 0.01 + * @param receiveDurabilityMaxPercent Max durabiltiy percent + * @param receiveDurabilityPercent current durability percent + * @returns durability multipler value + */ + protected getDurabilityMultiplier(receiveDurabilityMaxPercent: number, receiveDurabilityPercent: number): number; } export declare class RepairDetails { repairCost?: number; diff --git a/types/services/SeasonalEventService.d.ts b/types/services/SeasonalEventService.d.ts index d280332..7474018 100644 --- a/types/services/SeasonalEventService.d.ts +++ b/types/services/SeasonalEventService.d.ts @@ -16,17 +16,51 @@ export declare class SeasonalEventService { constructor(logger: ILogger, databaseServer: DatabaseServer, localisationService: LocalisationService, botHelper: BotHelper, configServer: ConfigServer); protected get events(): Record; protected get christmasEventItems(): string[]; + protected get halloweenEventItems(): string[]; /** * Get an array of christmas items found in bots inventories as loot * @returns array */ getChristmasEventItems(): string[]; - itemIsChristmasRelated(itemId: string): boolean; + /** + * Get an array of halloween items found in bots inventories as loot + * @returns array + */ + getHalloweenEventItems(): string[]; + itemIsChristmasRelated(itemTpl: string): boolean; + itemIsHalloweenRelated(itemTpl: string): boolean; + /** + * Check if item id exists in christmas or halloween event arrays + * @param itemTpl item tpl to check for + * @returns + */ + itemIsSeasonalRelated(itemTpl: string): boolean; + /** + * Get an array of items that appear during a seasonal event + * returns multiple seasonal event items if they are both active + * @returns array of tpl strings + */ + getAllSeasonalEventItems(): string[]; + /** + * Get an array of seasonal items that should be blocked as seasonal is not active + * @returns Array of tpl strings + */ + getSeasonalEventItemsToBlock(): string[]; + /** + * Is a seasonal event currently active + * @returns true if event is active + */ + seasonalEventEnabled(): boolean; /** * is christmas event active * @returns true if active */ christmasEventEnabled(): boolean; + /** + * is christmas event active + * @returns true if active + */ + halloweenEventEnabled(): boolean; /** * Is detection of seasonal events enabled (halloween / christmas) * @returns true if seasonal events should be checked for @@ -67,7 +101,7 @@ export declare class SeasonalEventService { * Read in data from seasonalEvents.json and add found equipment items to bots * @param eventName Name of the event to read equipment in from config */ - protected addEventGearToScavs(eventName: string): void; + protected addEventGearToBots(eventName: string): void; protected addPumpkinsToScavBackpacks(): void; /** * Set Khorovod(dancing tree) chance to 100% on all maps that support it diff --git a/types/services/mod/onLoad/OnLoadMod.d.ts b/types/services/mod/onLoad/OnLoadMod.d.ts index 82909c3..a4b58b5 100644 --- a/types/services/mod/onLoad/OnLoadMod.d.ts +++ b/types/services/mod/onLoad/OnLoadMod.d.ts @@ -1,5 +1,5 @@ import { OnLoad } from "../../../di/OnLoad"; -export declare class OnLoadMod extends OnLoad { +export declare class OnLoadMod implements OnLoad { private onLoadOverride; private getRouteOverride; constructor(onLoadOverride: () => void, getRouteOverride: () => string); diff --git a/types/services/mod/onUpdate/OnUpdateMod.d.ts b/types/services/mod/onUpdate/OnUpdateMod.d.ts index edd2a2c..8dfe6dd 100644 --- a/types/services/mod/onUpdate/OnUpdateMod.d.ts +++ b/types/services/mod/onUpdate/OnUpdateMod.d.ts @@ -1,5 +1,5 @@ import { OnUpdate } from "../../../di/OnUpdate"; -export declare class OnUpdateMod extends OnUpdate { +export declare class OnUpdateMod implements OnUpdate { private onUpdateOverride; private getRouteOverride; constructor(onUpdateOverride: (timeSinceLastRun: number) => boolean, getRouteOverride: () => string); diff --git a/types/utils/DatabaseImporter.d.ts b/types/utils/DatabaseImporter.d.ts index 0c39aa8..c09d63a 100644 --- a/types/utils/DatabaseImporter.d.ts +++ b/types/utils/DatabaseImporter.d.ts @@ -1,37 +1,35 @@ import { OnLoad } from "../di/OnLoad"; -import { IDatabaseTables } from "../models/spt/server/IDatabaseTables"; import { ILogger } from "../models/spt/utils/ILogger"; import { ImageRouter } from "../routers/ImageRouter"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocalisationService } from "../services/LocalisationService"; +import { EncodingUtil } from "./EncodingUtil"; +import { HashUtil } from "./HashUtil"; +import { ImporterUtil } from "./ImporterUtil"; import { JsonUtil } from "./JsonUtil"; import { VFS } from "./VFS"; -export declare class DatabaseImporter extends OnLoad { +export declare class DatabaseImporter implements OnLoad { protected logger: ILogger; protected vfs: VFS; protected jsonUtil: JsonUtil; protected localisationService: LocalisationService; protected databaseServer: DatabaseServer; protected imageRouter: ImageRouter; - constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, localisationService: LocalisationService, databaseServer: DatabaseServer, imageRouter: ImageRouter); + protected encodingUtil: EncodingUtil; + protected hashUtil: HashUtil; + protected importerUtil: ImporterUtil; + private hashedFile; + private valid; + private filepath; + constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, localisationService: LocalisationService, databaseServer: DatabaseServer, imageRouter: ImageRouter, encodingUtil: EncodingUtil, hashUtil: HashUtil, importerUtil: ImporterUtil); onLoad(): Promise; /** * Read all json files in database folder and map into a json object * @param filepath path to database folder */ protected hydrateDatabase(filepath: string): Promise; + private onReadValidate; getRoute(): string; - /** - * Load files into js objects recursively (asynchronous) - * @param filepath Path to folder with files - * @returns - */ - loadRecursiveAsync(filepath: string): Promise; - /** - * Load files into js objects recursively (synchronous) - * @param filepath Path to folder with files - * @returns - */ - loadRecursive(filepath: string): IDatabaseTables; + private validateFile; loadImages(filepath: string): void; } diff --git a/types/utils/EncodingUtil.d.ts b/types/utils/EncodingUtil.d.ts new file mode 100644 index 0000000..dabb97a --- /dev/null +++ b/types/utils/EncodingUtil.d.ts @@ -0,0 +1,15 @@ +export declare class EncodingUtil { + encode(value: string, encode: EncodeType): string; + decode(value: string, encode: EncodeType): string; + fromBase64(value: string): string; + toBase64(value: string): string; + fromHex(value: string): string; + toHex(value: string): string; +} +export declare enum EncodeType { + BASE64 = "base64", + HEX = "hex", + ASCII = "ascii", + BINARY = "binary", + UTF8 = "utf8" +} diff --git a/types/utils/ImporterUtil.d.ts b/types/utils/ImporterUtil.d.ts new file mode 100644 index 0000000..75aaf54 --- /dev/null +++ b/types/utils/ImporterUtil.d.ts @@ -0,0 +1,21 @@ +import { JsonUtil } from "./JsonUtil"; +import { VFS } from "./VFS"; +export declare class ImporterUtil { + protected vfs: VFS; + protected jsonUtil: JsonUtil; + constructor(vfs: VFS, jsonUtil: JsonUtil); + /** + * Load files into js objects recursively (asynchronous) + * @param filepath Path to folder with files + * @returns Promise return T type associated with this class + */ + loadRecursiveAsync(filepath: string, onReadCallback?: (fileWithPath: string, data: string) => void, onObjectDeserialized?: (fileWithPath: string, object: any) => void): Promise; + /** + * Load files into js objects recursively (synchronous) + * @param filepath Path to folder with files + * @returns + */ + loadRecursive(filepath: string, onReadCallback?: (fileWithPath: string, data: string) => void, onObjectDeserialized?: (fileWithPath: string, object: any) => void): T; + loadAsync(filepath: string, strippablePath?: string, onReadCallback?: (fileWithPath: string, data: string) => void, onObjectDeserialized?: (fileWithPath: string, object: any) => void): Promise; + protected placeObject(fileDeserialized: any, strippedFilePath: string, result: T, strippablePath: string): void; +} diff --git a/types/utils/JsonUtil.d.ts b/types/utils/JsonUtil.d.ts index 2591142..229dc26 100644 --- a/types/utils/JsonUtil.d.ts +++ b/types/utils/JsonUtil.d.ts @@ -14,13 +14,14 @@ export declare class JsonUtil { * @param prettify Should output be prettified? * @returns string */ - serialize(data: any, prettify?: boolean): string; + serialize(data: T, prettify?: boolean): string; /** * From string to object * @param jsonString json string to turn into object * @returns object */ - deserialize(jsonString: string): any; - deserializeWithCacheCheck(jsonString: string, filePath: string): string; + deserialize(jsonString: string, filename?: string): T; + deserializeWithCacheCheckAsync(jsonString: string, filePath: string): Promise; + deserializeWithCacheCheck(jsonString: string, filePath: string): T; clone(data: T): T; } diff --git a/types/utils/RandomUtil.d.ts b/types/utils/RandomUtil.d.ts index aa556e3..fc0b05d 100644 --- a/types/utils/RandomUtil.d.ts +++ b/types/utils/RandomUtil.d.ts @@ -110,6 +110,7 @@ export declare class RandomUtil { getIntEx(max: number): number; getFloat(min: number, max: number): number; getBool(): boolean; + getPercentOfValue(percent: number, number: number, toFixed?: number): number; /** * Check if number passes a check out of 100 * @param chancePercent value check needs to be above diff --git a/types/utils/UUidGenerator.d.ts b/types/utils/UUidGenerator.d.ts index 000b719..ed1ffa6 100644 --- a/types/utils/UUidGenerator.d.ts +++ b/types/utils/UUidGenerator.d.ts @@ -1,4 +1,4 @@ import { IUUidGenerator } from "../models/spt/utils/IUuidGenerator"; export declare class UUidGenerator implements IUUidGenerator { - generate: () => string; + generate(): string; } diff --git a/types/utils/VFS.d.ts b/types/utils/VFS.d.ts index 0dee5bd..267b10f 100644 --- a/types/utils/VFS.d.ts +++ b/types/utils/VFS.d.ts @@ -1,7 +1,7 @@ /// /// -import "reflect-metadata"; import fs from "fs"; +import "reflect-metadata"; import { IAsyncQueue } from "../models/spt/utils/IAsyncQueue"; import { IUUidGenerator } from "../models/spt/utils/IUuidGenerator"; export declare class VFS { @@ -32,8 +32,9 @@ export declare class VFS { createDirAsync(filepath: string): Promise; copyDir(filepath: string, target: string, fileExtensions?: string | string[]): void; copyDirAsync(filepath: string, target: string, fileExtensions: string | string[]): Promise; - readFile(...args: Parameters): any; - readFileAsync(filepath: string): Promise; + readFile(...args: Parameters): string; + readFileAsync(path: fs.PathLike): Promise; + private isBuffer; writeFile(filepath: any, data?: string, append?: boolean, atomic?: boolean): void; writeFileAsync(filepath: any, data?: string, append?: boolean, atomic?: boolean): Promise; getFiles(filepath: string): string[]; diff --git a/types/utils/collections/queue/Queue.d.ts b/types/utils/collections/queue/Queue.d.ts new file mode 100644 index 0000000..645d462 --- /dev/null +++ b/types/utils/collections/queue/Queue.d.ts @@ -0,0 +1,12 @@ +export declare class Queue { + private elements; + private head; + private tail; + constructor(); + enqueue(element: T): void; + enqueueAll(elements: T[]): void; + dequeue(): T; + peek(): T; + getLength(): number; + isEmpty(): boolean; +} diff --git a/types/utils/decorators/Singleton.d.ts b/types/utils/decorators/Singleton.d.ts deleted file mode 100644 index 7e89026..0000000 --- a/types/utils/decorators/Singleton.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -import type constructor from "./constructor"; -import { InjectionToken } from "tsyringe"; -declare function singleton(token?: InjectionToken): (target: constructor) => void; -export default singleton; diff --git a/types/utils/decorators/constructor.d.ts b/types/utils/decorators/constructor.d.ts deleted file mode 100644 index 416f354..0000000 --- a/types/utils/decorators/constructor.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -declare type constructor = { - new (...args: any[]): T; -}; -export default constructor; diff --git a/types/utils/Logger.d.ts b/types/utils/logging/AbstractWinstonLogger.d.ts similarity index 70% rename from types/utils/Logger.d.ts rename to types/utils/logging/AbstractWinstonLogger.d.ts index 1088701..1ae1100 100644 --- a/types/utils/Logger.d.ts +++ b/types/utils/logging/AbstractWinstonLogger.d.ts @@ -1,19 +1,17 @@ /// import fs from "fs"; import winston from "winston"; -import { Daum } from "../models/eft/itemEvent/IItemEventRouterRequest"; -import { LogBackgroundColor } from "../models/spt/logging/LogBackgroundColor"; -import { LogTextColor } from "../models/spt/logging/LogTextColor"; -import { SptLogger } from "../models/spt/logging/SptLogger"; -import { IAsyncQueue } from "../models/spt/utils/IAsyncQueue"; -import { ILogger } from "../models/spt/utils/ILogger"; -import { IUUidGenerator } from "../models/spt/utils/IUuidGenerator"; -export declare class WinstonLogger implements ILogger { +import { Daum } from "../../models/eft/itemEvent/IItemEventRouterRequest"; +import { LogBackgroundColor } from "../../models/spt/logging/LogBackgroundColor"; +import { LogTextColor } from "../../models/spt/logging/LogTextColor"; +import { SptLogger } from "../../models/spt/logging/SptLogger"; +import { IAsyncQueue } from "../../models/spt/utils/IAsyncQueue"; +import { ILogger } from "../../models/spt/utils/ILogger"; +import { IUUidGenerator } from "../../models/spt/utils/IUuidGenerator"; +export declare abstract class AbstractWinstonLogger implements ILogger { protected asyncQueue: IAsyncQueue; protected uuidGenerator: IUUidGenerator; protected showDebugInConsole: boolean; - protected folderPath: string; - protected file: string; protected filePath: string; protected logLevels: { levels: { @@ -47,6 +45,13 @@ export declare class WinstonLogger implements ILogger { protected logger: winston.Logger & SptLogger; protected writeFilePromisify: (path: fs.PathLike, data: string, options?: any) => Promise; constructor(asyncQueue: IAsyncQueue, uuidGenerator: IUUidGenerator); + protected abstract isLogToFile(): boolean; + protected abstract isLogToConsole(): boolean; + protected abstract isLogExceptions(): boolean; + protected abstract getFilePath(): string; + protected abstract getFileName(): string; + protected getLogMaxSize(): string; + protected getLogMaxFiles(): string; writeToLogFile(data: string | Daum): Promise; log(data: string | Error | Record, color: string, backgroundColor?: string): Promise; error(data: string | Record): Promise; diff --git a/types/utils/logging/WinstonMainLogger.d.ts b/types/utils/logging/WinstonMainLogger.d.ts new file mode 100644 index 0000000..3c67902 --- /dev/null +++ b/types/utils/logging/WinstonMainLogger.d.ts @@ -0,0 +1,13 @@ +import { IAsyncQueue } from "../../models/spt/utils/IAsyncQueue"; +import { IUUidGenerator } from "../../models/spt/utils/IUuidGenerator"; +import { AbstractWinstonLogger } from "./AbstractWinstonLogger"; +export declare class WinstonMainLogger extends AbstractWinstonLogger { + protected asyncQueue: IAsyncQueue; + protected uuidGenerator: IUUidGenerator; + constructor(asyncQueue: IAsyncQueue, uuidGenerator: IUUidGenerator); + protected isLogExceptions(): boolean; + protected isLogToFile(): boolean; + protected isLogToConsole(): boolean; + protected getFilePath(): string; + protected getFileName(): string; +} diff --git a/types/utils/logging/WinstonRequestLogger.d.ts b/types/utils/logging/WinstonRequestLogger.d.ts new file mode 100644 index 0000000..1475e43 --- /dev/null +++ b/types/utils/logging/WinstonRequestLogger.d.ts @@ -0,0 +1,14 @@ +import { IAsyncQueue } from "../../models/spt/utils/IAsyncQueue"; +import { IUUidGenerator } from "../../models/spt/utils/IUuidGenerator"; +import { AbstractWinstonLogger } from "./AbstractWinstonLogger"; +export declare class WinstonRequestLogger extends AbstractWinstonLogger { + protected asyncQueue: IAsyncQueue; + protected uuidGenerator: IUUidGenerator; + constructor(asyncQueue: IAsyncQueue, uuidGenerator: IUUidGenerator); + protected isLogExceptions(): boolean; + protected isLogToFile(): boolean; + protected isLogToConsole(): boolean; + protected getFilePath(): string; + protected getFileName(): string; + protected getLogMaxSize(): string; +}