tornapi-typescript 4.2.0 → 4.2.2

package/dist/index.d.ts

@@ -1278,6 +1278,7 @@ export interface PersonalStatsCrimesV2 {
         cracking: number;
         forgery: number;
         scamming: number;
+        arson: number;
     };
     version: string;
 }
@@ -1623,7 +1624,7 @@ export interface UserPersonalStatsFullPublic {
 }
 export type UserPersonalStatsResponse = UserPersonalStatsFull | UserPersonalStatsFullPublic | UserPersonalStatsPopular | UserPersonalStatsCategory | UserPersonalStatsHistoric;
 export type PersonalStatsCategoryEnum = "all" | "popular" | "attacking" | "battle_stats" | "jobs" | "trading" | "jail" | "hospital" | "finishing_hits" | "communication" | "crimes" | "bounties" | "investments" | "items" | "travel" | "drugs" | "missions" | "racing" | "networth" | "other" | "itemmarketcustomers" | "itemmarketsales" | "itemmarketrevenue" | "itemmarketfees";
-export type PersonalStatsStatName = "attackswon" | "attackslost" | "attacksdraw" | "attacksassisted" | "defendswon" | "defendslost" | "defendsstalemated" | "elo" | "yourunaway" | "theyrunaway" | "unarmoredwon" | "bestkillstreak" | "attackhits" | "attackmisses" | "attackdamage" | "bestdamage" | "onehitkills" | "attackcriticalhits" | "roundsfired" | "specialammoused" | "hollowammoused" | "tracerammoused" | "piercingammoused" | "incendiaryammoused" | "attacksstealthed" | "retals" | "moneymugged" | "largestmug" | "itemslooted" | "highestbeaten" | "respectforfaction" | "rankedwarhits" | "raidhits" | "territoryjoins" | "territoryclears" | "territorytime" | "jobpointsused" | "trainsreceived" | "marketitemsbought" | "auctionswon" | "auctionsells" | "itemssent" | "trades" | "cityitemsbought" | "pointsbought" | "pointssold" | "bazaarcustomers" | "bazaarsales" | "bazaarprofit" | "jailed" | "peoplebusted" | "failedbusts" | "peoplebought" | "peopleboughtspent" | "hospital" | "medicalitemsused" | "bloodwithdrawn" | "reviveskill" | "revives" | "revivesreceived" | "heavyhits" | "machinehits" | "riflehits" | "smghits" | "shotgunhits" | "pistolhits" | "temphits" | "piercinghits" | "slashinghits" | "clubbinghits" | "mechanicalhits" | "h2hhits" | "mailssent" | "friendmailssent" | "factionmailssent" | "companymailssent" | "spousemailssent" | "classifiedadsplaced" | "personalsplaced" | "criminaloffensesold" | "sellillegalgoods" | "theftold" | "autotheftcrime" | "drugdealscrime" | "computercrime" | "fraudold" | "murdercrime" | "othercrime" | "organizedcrimes" | "bountiesplaced" | "totalbountyspent" | "bountiescollected" | "totalbountyreward" | "bountiesreceived" | "receivedbountyvalue" | "cityfinds" | "dumpfinds" | "itemsdumped" | "booksread" | "boostersused" | "consumablesused" | "candyused" | "alcoholused" | "energydrinkused" | "statenhancersused" | "eastereggsfound" | "eastereggsused" | "virusescoded" | "traveltimes" | "timespenttraveling" | "itemsboughtabroad" | "attackswonabroad" | "defendslostabroad" | "argtravel" | "mextravel" | "uaetravel" | "hawtravel" | "japtravel" | "uktravel" | "satravel" | "switravel" | "chitravel" | "cantravel" | "caytravel" | "drugsused" | "overdosed" | "rehabs" | "rehabcost" | "cantaken" | "exttaken" | "kettaken" | "lsdtaken" | "opitaken" | "pcptaken" | "shrtaken" | "spetaken" | "victaken" | "xantaken" | "missionscompleted" | "contractscompleted" | "dukecontractscompleted" | "missioncreditsearned" | "racingskill" | "racingpointsearned" | "racesentered" | "raceswon" | "networth" | "timeplayed" | "activestreak" | "bestactivestreak" | "awards" | "refills" | "nerverefills" | "tokenrefills" | "meritsbought" | "daysbeendonator" | "criminaloffenses" | "vandalism" | "theft" | "counterfeiting" | "fraud" | "illicitservices" | "cybercrime" | "extortion" | "illegalproduction" | "currentkillstreak" | "strength" | "defense" | "speed" | "dexterity" | "totalstats" | "manuallabor" | "intelligence" | "endurance" | "totalworkingstats" | "moneyinvested" | "investedprofit" | "investamount" | "banktimeleft" | "stockprofits" | "stocklosses" | "stockfees" | "stocknetprofits" | "stockpayouts" | "networthwallet" | "networthvault" | "networthbank" | "networthcayman" | "networthpoints" | "networthitems" | "networthdisplaycase" | "networthbazaar" | "networthitemmarket" | "networthproperties" | "networthstockmarket" | "networthauctionhouse" | "networthbookie" | "networthcompany" | "networthenlistedcars" | "networthpiggybank" | "networthpending" | "networthloan" | "networthunpaidfees" | "huntingskill" | "searchforcashskill" | "bootleggingskill" | "graffitiskill" | "shopliftingskill" | "pickpocketingskill" | "cardskimmingskill" | "burglaryskill" | "hustlingskill" | "disposalskill" | "crackingskill" | "forgeryskill" | "scammingskill";
+export type PersonalStatsStatName = "attackswon" | "attackslost" | "attacksdraw" | "attacksassisted" | "defendswon" | "defendslost" | "defendsstalemated" | "elo" | "yourunaway" | "theyrunaway" | "unarmoredwon" | "bestkillstreak" | "attackhits" | "attackmisses" | "attackdamage" | "bestdamage" | "onehitkills" | "attackcriticalhits" | "roundsfired" | "specialammoused" | "hollowammoused" | "tracerammoused" | "piercingammoused" | "incendiaryammoused" | "attacksstealthed" | "retals" | "moneymugged" | "largestmug" | "itemslooted" | "highestbeaten" | "respectforfaction" | "rankedwarhits" | "raidhits" | "territoryjoins" | "territoryclears" | "territorytime" | "jobpointsused" | "trainsreceived" | "marketitemsbought" | "auctionswon" | "auctionsells" | "itemssent" | "trades" | "cityitemsbought" | "pointsbought" | "pointssold" | "bazaarcustomers" | "bazaarsales" | "bazaarprofit" | "jailed" | "peoplebusted" | "failedbusts" | "peoplebought" | "peopleboughtspent" | "hospital" | "medicalitemsused" | "bloodwithdrawn" | "reviveskill" | "revives" | "revivesreceived" | "heavyhits" | "machinehits" | "riflehits" | "smghits" | "shotgunhits" | "pistolhits" | "temphits" | "piercinghits" | "slashinghits" | "clubbinghits" | "mechanicalhits" | "h2hhits" | "mailssent" | "friendmailssent" | "factionmailssent" | "companymailssent" | "spousemailssent" | "classifiedadsplaced" | "personalsplaced" | "criminaloffensesold" | "sellillegalgoods" | "theftold" | "autotheftcrime" | "drugdealscrime" | "computercrime" | "fraudold" | "murdercrime" | "othercrime" | "organizedcrimes" | "bountiesplaced" | "totalbountyspent" | "bountiescollected" | "totalbountyreward" | "bountiesreceived" | "receivedbountyvalue" | "cityfinds" | "dumpfinds" | "itemsdumped" | "booksread" | "boostersused" | "consumablesused" | "candyused" | "alcoholused" | "energydrinkused" | "statenhancersused" | "eastereggsfound" | "eastereggsused" | "virusescoded" | "traveltimes" | "timespenttraveling" | "itemsboughtabroad" | "attackswonabroad" | "defendslostabroad" | "argtravel" | "mextravel" | "uaetravel" | "hawtravel" | "japtravel" | "uktravel" | "satravel" | "switravel" | "chitravel" | "cantravel" | "caytravel" | "drugsused" | "overdosed" | "rehabs" | "rehabcost" | "cantaken" | "exttaken" | "kettaken" | "lsdtaken" | "opitaken" | "pcptaken" | "shrtaken" | "spetaken" | "victaken" | "xantaken" | "missionscompleted" | "contractscompleted" | "dukecontractscompleted" | "missioncreditsearned" | "racingskill" | "racingpointsearned" | "racesentered" | "raceswon" | "networth" | "timeplayed" | "activestreak" | "bestactivestreak" | "awards" | "refills" | "nerverefills" | "tokenrefills" | "meritsbought" | "daysbeendonator" | "criminaloffenses" | "vandalism" | "theft" | "counterfeiting" | "fraud" | "illicitservices" | "cybercrime" | "extortion" | "illegalproduction" | "currentkillstreak" | "strength" | "defense" | "speed" | "dexterity" | "totalstats" | "manuallabor" | "intelligence" | "endurance" | "totalworkingstats" | "moneyinvested" | "investedprofit" | "investamount" | "banktimeleft" | "stockprofits" | "stocklosses" | "stockfees" | "stocknetprofits" | "stockpayouts" | "networthwallet" | "networthvault" | "networthbank" | "networthcayman" | "networthpoints" | "networthitems" | "networthdisplaycase" | "networthbazaar" | "networthitemmarket" | "networthproperties" | "networthstockmarket" | "networthauctionhouse" | "networthbookie" | "networthcompany" | "networthenlistedcars" | "networthpiggybank" | "networthpending" | "networthloan" | "networthunpaidfees" | "huntingskill" | "searchforcashskill" | "bootleggingskill" | "graffitiskill" | "shopliftingskill" | "pickpocketingskill" | "cardskimmingskill" | "burglaryskill" | "hustlingskill" | "disposalskill" | "crackingskill" | "forgeryskill" | "scammingskill" | "arsonskill";
 export interface FactionRaidReport {
     id: RaidWarId;
     start: number;
@@ -2187,7 +2188,7 @@ export interface FactionCrimeSlot {
     position_number: number;
     item_requirement: {
         id: ItemId;
-        /** Shows if the item is reusable or consumed during the crime. */
+        /** Shows if the item is reusable or consumed during the crime.<br><b>Important note: There may be alternative paths which won't consume the item, even if the item is non-reusable.</b> */
         is_reusable: boolean;
         /** Shows if user has the required item. */
         is_available: boolean;
@@ -2466,7 +2467,7 @@ export interface MarketRentalDetails {
     property: BasicProperty;
 }
 export interface MarketRentalsResponse {
-    properties: MarketRentalDetails;
+    rentals: MarketRentalDetails;
     _metadata: RequestMetadataWithLinks;
 }
 export interface MarketPropertyDetails {
@@ -6355,14 +6356,14 @@ export interface UserV2 extends BaseSchema {
             response: UserBasicResponse;
             params: "striptags" | "timestamp";
         };
-        bounties: {
-            response: UserBountiesResponse;
-            params: "timestamp";
-        };
         battlestats: {
             response: UserBattleStatsResponse;
             params: "timestamp";
         };
+        bounties: {
+            response: UserBountiesResponse;
+            params: "timestamp";
+        };
         calendar: {
             response: UserCalendarResponse;
             params: "timestamp";
@@ -6625,11 +6626,11 @@ export interface FactionV2 extends BaseSchema {
         };
         raids: {
             response: FactionRaidsResponse;
-            params: "from" | "to" | "sort" | "timestamp";
+            params: "from" | "to" | "sort" | "limit" | "timestamp";
         };
         rankedwars: {
             response: FactionRankedWarResponse;
-            params: "from" | "to" | "sort" | "timestamp";
+            params: "offset" | "limit" | "from" | "to" | "sort" | "timestamp";
         };
         rankedwarreport: {
             response: FactionRankedWarReportResponse;
@@ -6741,7 +6742,7 @@ export interface MarketV2 extends BaseSchema {
         };
         itemmarket: {
             response: MarketItemMarketResponse;
-            params: "id" | "bonus" | "offset" | "timestamp";
+            params: "id" | "bonus" | "limit" | "offset" | "timestamp";
         };
         properties: {
             response: MarketPropertiesResponse;
@@ -6845,7 +6846,7 @@ export interface TornV2 extends BaseSchema {
         };
         honors: {
             response: TornHonorsResponse;
-            params: "timestamp";
+            params: "limit" | "offset" | "sort" | "timestamp";
         };
         hof: {
             response: TornHofResponse;
@@ -6952,6 +6953,15 @@ export type ParamsV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>> = Sect
 export type ParamsV2<Sec extends SectionV2, Sel extends SelectionV2<Sec>> = SectionsV2Map[Sec]["selections"][Sel] extends {
     params: any;
 } ? SectionsV2Map[Sec]["selections"][Sel]["params"] : never;
+export type CommonArgument = {
+    id?: string | number;
+    key: string;
+    comment?: string;
+};
+export type CommonArgumentV1<Sec extends SectionV1, Sel extends keyof SectionsV1Map[Sec]["selections"]> = {
+    section: Sec;
+    selections?: Sel[];
+} & CommonArgument;
 export type GetArgumentV1<Sec extends SectionV1, Sel extends keyof SectionsV1Map[Sec]["selections"]> = ParamsV1<Sec, Sel> extends never ? {
     section: Sec;
     selections?: Sel[];
@@ -6967,20 +6977,19 @@ export type GetArgumentV1<Sec extends SectionV1, Sel extends keyof SectionsV1Map
     key: string;
     comment?: string;
 };
-export type GetArgumentV2<Sec extends SectionV2, Sel extends keyof SectionsV2Map[Sec]["selections"]> = ParamsV2<Sec, Sel> extends never ? {
+export type CommonArgumentV2<Sec extends SectionV2, Sel extends keyof SectionsV2Map[Sec]["selections"]> = {
     section: Sec;
     selections?: Sel[];
-    id?: string | number;
+} & CommonArgument;
+export type GetArgumentV2<Sec extends SectionV2, Sel extends keyof SectionsV2Map[Sec]["selections"]> = ParamsV2<Sec, Sel> extends never ? {
     params?: never;
-    key: string;
-    comment?: string;
-} : {
-    section: Sec;
-    selections?: Sel[];
-    id?: string | number;
+} & CommonArgumentV2<Sec, Sel> : {
     params?: Partial<Record<ParamsV2<Sec, Sel>, string>>;
-    key: string;
-    comment?: string;
+} & CommonArgumentV2<Sec, Sel>;
+export type AdditionalArguments<CacheType> = {
+    cache?: CacheType;
+    expiry?: number;
+    timeout?: number;
 };
 export type GetResponseSuccessV1<Sec extends SectionV1, Sel extends keyof SectionsV1Map[Sec]["selections"]> = SectionsV1Map[Sec]["selections"][Sel] extends {
     response: any;
@@ -7007,45 +7016,33 @@ export type CacheV2<Sec extends SectionV2, Sel extends keyof SectionsV2Map[Sec][
     set: (key: GetArgumentV2<Sec, Sel>, value: GetResponseV2<Sec, Sel>, expiry: number) => void | Promise<void>;
 };
 type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
-export interface HTTPClient {
-    getJson(url: URL): Promise<any>;
+export type HTTPClientCapabilities = "abort";
+export declare abstract class HTTPClient {
+    abstract getJson(url: URL): Promise<any>;
+    canAbort(): this is AbortableHTTPClient;
+}
+export declare abstract class AbortableHTTPClient extends HTTPClient {
+    abstract getJson(url: URL): Promise<any>;
+    abstract getJson(url: URL, timeout: number): Promise<any>;
+    abstract getJson(url: URL, timeout: number | undefined): Promise<any>;
+    canAbort(): this is AbortableHTTPClient;
 }
-export declare class FetchHTTPClient implements HTTPClient {
-    getJson(url: URL): Promise<any>;
+export declare class FetchHTTPClient extends AbortableHTTPClient {
+    getJson(url: URL, timeout?: number | undefined): Promise<any>;
 }
 interface ClientOptions {
     httpClient?: HTTPClient;
     defaultComment?: string;
+    defaultTimeout?: number;
 }
 export declare class TornApiClient {
     private readonly httpClient;
     private readonly defaultComment?;
+    private readonly defaultTimeout?;
     constructor(options?: ClientOptions);
-    getV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>>({ section, selections, id, params, key, comment, cache, expiry, }: GetArgumentV1<Sec, Sel> & {
-        cache?: CacheV1<Sec, Sel>;
-        expiry?: number;
-    }): Promise<GetResponseV1<Sec, Sel>>;
-    getV2<Sec extends SectionV2, Sel extends SelectionV2<Sec>>({ section, selections, id, params, key, comment, cache, expiry, }: GetArgumentV2<Sec, Sel> & {
-        cache?: CacheV2<Sec, Sel>;
-        expiry?: number;
-    }): Promise<GetResponseV2<Sec, Sel>>;
+    getV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>>({ section, selections, id, params, key, comment, cache, expiry, timeout, }: GetArgumentV1<Sec, Sel> & AdditionalArguments<CacheV1<Sec, Sel>>): Promise<GetResponseV1<Sec, Sel>>;
+    getV2<Sec extends SectionV2, Sel extends SelectionV2<Sec>>({ section, selections, id, params, key, comment, cache, expiry, timeout, }: GetArgumentV2<Sec, Sel> & AdditionalArguments<CacheV2<Sec, Sel>>): Promise<GetResponseV2<Sec, Sel>>;
     private handleError;
     private populateUrl;
 }
-/**
- * @deprecated Move to TornApiClient instead of using this. Will be removed in an upcoming version.
- * @see TornApiClient
- */
-export declare function tornApiGetV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>>(options: GetArgumentV1<Sec, Sel> & {
-    cache?: CacheV1<Sec, Sel>;
-    expiry?: number;
-}): Promise<GetResponseV1<Sec, Sel>>;
-/**
- * @deprecated Move to TornApiClient instead of using this. Will be removed in an upcoming version.
- * @see TornApiClient
- */
-export declare function tornApiGetV2<Sec extends SectionV2, Sel extends SelectionV2<Sec>>(options: GetArgumentV2<Sec, Sel> & {
-    cache?: CacheV2<Sec, Sel>;
-    expiry?: number;
-}): Promise<GetResponseV2<Sec, Sel>>;
 export {};

package/dist/index.js

@@ -34,20 +34,41 @@ export var TornApiError;
     TornApiError[TornApiError["SELECTION_ONLY_AVAILABLE_API_V2"] = 23] = "SELECTION_ONLY_AVAILABLE_API_V2";
     TornApiError[TornApiError["CLOSED_TEMPORARILY"] = 24] = "CLOSED_TEMPORARILY";
 })(TornApiError || (TornApiError = {}));
-export class FetchHTTPClient {
-    async getJson(url) {
-        const response = await fetch(url);
+export class HTTPClient {
+    canAbort() {
+        return false;
+    }
+}
+export class AbortableHTTPClient extends HTTPClient {
+    canAbort() {
+        return true;
+    }
+}
+export class FetchHTTPClient extends AbortableHTTPClient {
+    async getJson(url, timeout = undefined) {
+        let response;
+        if (timeout !== undefined) {
+            const controller = new AbortController();
+            const timeoutId = setTimeout(() => controller.abort(), timeout);
+            response = await fetch(url, { signal: controller.signal });
+            clearTimeout(timeoutId);
+        }
+        else {
+            response = await fetch(url);
+        }
         return await response.json();
     }
 }
 export class TornApiClient {
     httpClient;
     defaultComment;
+    defaultTimeout;
     constructor(options = {}) {
         this.httpClient = options.httpClient ?? new FetchHTTPClient();
         this.defaultComment = options.defaultComment;
+        this.defaultTimeout = options.defaultTimeout;
     }
-    async getV1({ section, selections, id, params = {}, key, comment, cache, expiry, }) {
+    async getV1({ section, selections, id, params = {}, key, comment, cache, expiry, timeout, }) {
         const cached = await cache?.get({
             section,
             selections,
@@ -59,10 +80,18 @@ export class TornApiClient {
             return cached;
         const url = new URL(`https://api.torn.com/${section}/${id ?? ""}`);
         this.populateUrl(url, key, (selections ?? []), comment, params ?? {});
-        return this.httpClient
-            .getJson(url)
-            .then(addToCache)
-            .catch(this.handleError);
+        if (this.httpClient.canAbort() && typeof timeout === "number") {
+            return this.httpClient
+                .getJson(url, timeout)
+                .then(addToCache)
+                .catch(this.handleError);
+        }
+        else {
+            return this.httpClient
+                .getJson(url)
+                .then(addToCache)
+                .catch(this.handleError);
+        }
         function addToCache(response) {
             if ("error" in response)
                 return response;
@@ -76,7 +105,7 @@ export class TornApiClient {
             return response;
         }
     }
-    async getV2({ section, selections, id, params = {}, key, comment, cache, expiry, }) {
+    async getV2({ section, selections, id, params = {}, key, comment, cache, expiry, timeout, }) {
         const cached = await cache?.get({
             section,
             selections,
@@ -88,10 +117,18 @@ export class TornApiClient {
             return cached;
         const url = new URL(`https://api.torn.com/v2/${section}/${id ?? ""}`);
         this.populateUrl(url, key, (selections ?? []), comment, params ?? {});
-        return this.httpClient
-            .getJson(url)
-            .then(addToCache)
-            .catch(this.handleError);
+        if (this.httpClient.canAbort() && typeof timeout === "number") {
+            return this.httpClient
+                .getJson(url, timeout)
+                .then(addToCache)
+                .catch(this.handleError);
+        }
+        else {
+            return this.httpClient
+                .getJson(url)
+                .then(addToCache)
+                .catch(this.handleError);
+        }
         function addToCache(response) {
             if ("error" in response)
                 return response;
@@ -134,18 +171,3 @@ export class TornApiClient {
             .forEach(([key, value]) => url.searchParams.set(key, value));
     }
 }
-const DEFAULT_CLIENT = new TornApiClient();
-/**
- * @deprecated Move to TornApiClient instead of using this. Will be removed in an upcoming version.
- * @see TornApiClient
- */
-export async function tornApiGetV1(options) {
-    return DEFAULT_CLIENT.getV1(options);
-}
-/**
- * @deprecated Move to TornApiClient instead of using this. Will be removed in an upcoming version.
- * @see TornApiClient
- */
-export async function tornApiGetV2(options) {
-    return DEFAULT_CLIENT.getV2(options);
-}

package/dist/index.ts

@@ -6370,6 +6370,7 @@ export interface PersonalStatsCrimesV2 {
         cracking: number;
         forgery: number;
         scamming: number;
+        arson: number;
     };
     version: string;
 }
@@ -7040,7 +7041,8 @@ export type PersonalStatsStatName =
     | "disposalskill"
     | "crackingskill"
     | "forgeryskill"
-    | "scammingskill";
+    | "scammingskill"
+    | "arsonskill";
 
 export interface FactionRaidReport {
     id: RaidWarId;
@@ -7689,7 +7691,7 @@ export interface FactionCrimeSlot {
     position_number: number;
     item_requirement: {
         id: ItemId;
-        /** Shows if the item is reusable or consumed during the crime. */
+        /** Shows if the item is reusable or consumed during the crime.<br><b>Important note: There may be alternative paths which won't consume the item, even if the item is non-reusable.</b> */
         is_reusable: boolean;
         /** Shows if user has the required item. */
         is_available: boolean;
@@ -8007,7 +8009,7 @@ export interface MarketRentalDetails {
 }
 
 export interface MarketRentalsResponse {
-    properties: MarketRentalDetails;
+    rentals: MarketRentalDetails;
     _metadata: RequestMetadataWithLinks;
 }
 
@@ -12067,14 +12069,14 @@ export interface UserV2 extends BaseSchema {
             response: UserBasicResponse;
             params: "striptags" | "timestamp";
         };
-        bounties: {
-            response: UserBountiesResponse;
-            params: "timestamp";
-        };
         battlestats: {
             response: UserBattleStatsResponse;
             params: "timestamp";
         };
+        bounties: {
+            response: UserBountiesResponse;
+            params: "timestamp";
+        };
         calendar: {
             response: UserCalendarResponse;
             params: "timestamp";
@@ -12377,11 +12379,11 @@ export interface FactionV2 extends BaseSchema {
         };
         raids: {
             response: FactionRaidsResponse;
-            params: "from" | "to" | "sort" | "timestamp";
+            params: "from" | "to" | "sort" | "limit" | "timestamp";
         };
         rankedwars: {
             response: FactionRankedWarResponse;
-            params: "from" | "to" | "sort" | "timestamp";
+            params: "offset" | "limit" | "from" | "to" | "sort" | "timestamp";
         };
         rankedwarreport: {
             response: FactionRankedWarReportResponse;
@@ -12514,7 +12516,7 @@ export interface MarketV2 extends BaseSchema {
         };
         itemmarket: {
             response: MarketItemMarketResponse;
-            params: "id" | "bonus" | "offset" | "timestamp";
+            params: "id" | "bonus" | "limit" | "offset" | "timestamp";
         };
         properties: {
             response: MarketPropertiesResponse;
@@ -12628,7 +12630,7 @@ export interface TornV2 extends BaseSchema {
         };
         honors: {
             response: TornHonorsResponse;
-            params: "timestamp";
+            params: "limit" | "offset" | "sort" | "timestamp";
         };
         hof: {
             response: TornHofResponse;
@@ -12750,6 +12752,18 @@ export type ParamsV2<
     ? SectionsV2Map[Sec]["selections"][Sel]["params"]
     : never;
 
+export type CommonArgument = {
+    id?: string | number;
+    key: string;
+    comment?: string;
+};
+export type CommonArgumentV1<
+    Sec extends SectionV1,
+    Sel extends keyof SectionsV1Map[Sec]["selections"],
+> = {
+    section: Sec;
+    selections?: Sel[];
+} & CommonArgument;
 export type GetArgumentV1<
     Sec extends SectionV1,
     Sel extends keyof SectionsV1Map[Sec]["selections"],
@@ -12771,27 +12785,29 @@ export type GetArgumentV1<
               key: string;
               comment?: string;
           };
+export type CommonArgumentV2<
+    Sec extends SectionV2,
+    Sel extends keyof SectionsV2Map[Sec]["selections"],
+> = {
+    section: Sec;
+    selections?: Sel[];
+} & CommonArgument;
 export type GetArgumentV2<
     Sec extends SectionV2,
     Sel extends keyof SectionsV2Map[Sec]["selections"],
 > =
     ParamsV2<Sec, Sel> extends never
         ? {
-              section: Sec;
-              selections?: Sel[];
-              id?: string | number;
               params?: never;
-              key: string;
-              comment?: string;
-          }
+          } & CommonArgumentV2<Sec, Sel>
         : {
-              section: Sec;
-              selections?: Sel[];
-              id?: string | number;
               params?: Partial<Record<ParamsV2<Sec, Sel>, string>>;
-              key: string;
-              comment?: string;
-          };
+          } & CommonArgumentV2<Sec, Sel>;
+export type AdditionalArguments<CacheType> = {
+    cache?: CacheType;
+    expiry?: number;
+    timeout?: number;
+};
 
 export type GetResponseSuccessV1<
     Sec extends SectionV1,
@@ -12860,13 +12876,41 @@ type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (
     ? I
     : never;
 
-export interface HTTPClient {
-    getJson(url: URL): Promise<any>;
+export type HTTPClientCapabilities = "abort";
+
+export abstract class HTTPClient {
+    abstract getJson(url: URL): Promise<any>;
+
+    canAbort(): this is AbortableHTTPClient {
+        return false;
+    }
+}
+
+export abstract class AbortableHTTPClient extends HTTPClient {
+    abstract getJson(url: URL): Promise<any>;
+    abstract getJson(url: URL, timeout: number): Promise<any>;
+    abstract getJson(url: URL, timeout: number | undefined): Promise<any>;
+
+    canAbort(): this is AbortableHTTPClient {
+        return true;
+    }
 }
 
-export class FetchHTTPClient implements HTTPClient {
-    async getJson(url: URL): Promise<any> {
-        const response = await fetch(url);
+export class FetchHTTPClient extends AbortableHTTPClient {
+    async getJson(
+        url: URL,
+        timeout: number | undefined = undefined,
+    ): Promise<any> {
+        let response: Response;
+        if (timeout !== undefined) {
+            const controller = new AbortController();
+            const timeoutId = setTimeout(() => controller.abort(), timeout);
+
+            response = await fetch(url, { signal: controller.signal });
+            clearTimeout(timeoutId);
+        } else {
+            response = await fetch(url);
+        }
 
         return await response.json();
     }
@@ -12875,15 +12919,18 @@ export class FetchHTTPClient implements HTTPClient {
 interface ClientOptions {
     httpClient?: HTTPClient;
     defaultComment?: string;
+    defaultTimeout?: number;
 }
 
 export class TornApiClient {
     private readonly httpClient: HTTPClient;
     private readonly defaultComment?: string;
+    private readonly defaultTimeout?: number;
 
     constructor(options: ClientOptions = {}) {
         this.httpClient = options.httpClient ?? new FetchHTTPClient();
         this.defaultComment = options.defaultComment;
+        this.defaultTimeout = options.defaultTimeout;
     }
 
     async getV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>>({
@@ -12895,10 +12942,11 @@ export class TornApiClient {
         comment,
         cache,
         expiry,
-    }: GetArgumentV1<Sec, Sel> & {
-        cache?: CacheV1<Sec, Sel>;
-        expiry?: number;
-    }): Promise<GetResponseV1<Sec, Sel>> {
+        timeout,
+    }: GetArgumentV1<Sec, Sel> &
+        AdditionalArguments<CacheV1<Sec, Sel>>): Promise<
+        GetResponseV1<Sec, Sel>
+    > {
         const cached = await cache?.get({
             section,
             selections,
@@ -12917,10 +12965,17 @@ export class TornApiClient {
             params ?? {},
         );
 
-        return this.httpClient
-            .getJson(url)
-            .then(addToCache)
-            .catch(this.handleError);
+        if (this.httpClient.canAbort() && typeof timeout === "number") {
+            return (this.httpClient as AbortableHTTPClient)
+                .getJson(url, timeout)
+                .then(addToCache)
+                .catch(this.handleError);
+        } else {
+            return this.httpClient
+                .getJson(url)
+                .then(addToCache)
+                .catch(this.handleError);
+        }
 
         function addToCache(
             response: GetResponseV1<Sec, Sel>,
@@ -12950,10 +13005,11 @@ export class TornApiClient {
         comment,
         cache,
         expiry,
-    }: GetArgumentV2<Sec, Sel> & {
-        cache?: CacheV2<Sec, Sel>;
-        expiry?: number;
-    }): Promise<GetResponseV2<Sec, Sel>> {
+        timeout,
+    }: GetArgumentV2<Sec, Sel> &
+        AdditionalArguments<CacheV2<Sec, Sel>>): Promise<
+        GetResponseV2<Sec, Sel>
+    > {
         const cached = await cache?.get({
             section,
             selections,
@@ -12972,10 +13028,17 @@ export class TornApiClient {
             params ?? {},
         );
 
-        return this.httpClient
-            .getJson(url)
-            .then(addToCache)
-            .catch(this.handleError);
+        if (this.httpClient.canAbort() && typeof timeout === "number") {
+            return (this.httpClient as AbortableHTTPClient)
+                .getJson(url, timeout)
+                .then(addToCache)
+                .catch(this.handleError);
+        } else {
+            return this.httpClient
+                .getJson(url)
+                .then(addToCache)
+                .catch(this.handleError);
+        }
 
         function addToCache(
             response: GetResponseV2<Sec, Sel>,
@@ -13035,37 +13098,3 @@ export class TornApiClient {
             .forEach(([key, value]) => url.searchParams.set(key, value));
     }
 }
-
-const DEFAULT_CLIENT = new TornApiClient();
-
-/**
- * @deprecated Move to TornApiClient instead of using this. Will be removed in an upcoming version.
- * @see TornApiClient
- */
-export async function tornApiGetV1<
-    Sec extends SectionV1,
-    Sel extends SelectionV1<Sec>,
->(
-    options: GetArgumentV1<Sec, Sel> & {
-        cache?: CacheV1<Sec, Sel>;
-        expiry?: number;
-    },
-): Promise<GetResponseV1<Sec, Sel>> {
-    return DEFAULT_CLIENT.getV1(options);
-}
-
-/**
- * @deprecated Move to TornApiClient instead of using this. Will be removed in an upcoming version.
- * @see TornApiClient
- */
-export async function tornApiGetV2<
-    Sec extends SectionV2,
-    Sel extends SelectionV2<Sec>,
->(
-    options: GetArgumentV2<Sec, Sel> & {
-        cache?: CacheV2<Sec, Sel>;
-        expiry?: number;
-    },
-): Promise<GetResponseV2<Sec, Sel>> {
-    return DEFAULT_CLIENT.getV2(options);
-}

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Torn API",
     "description": "\n * The development of Torn's API v2 is still ongoing.\n * If selections remain unaltered, they will default to the API v1 version.\n * Unlike API v1, API v2 accepts both selections and IDs as path and query parameters.\n * If any discrepancies or errors are found, please submit a [bug report](https://www.torn.com/forums.php#/p=forums&f=19&b=0&a=0) on the Torn Forums.\n * In case you're using bots to check for changes on openapi.json file, make sure to specificy a custom user-agent header - CloudFlare sometimes prevents requests from default user-agents.",
-    "version": "4.2.0"
+    "version": "4.2.2"
   },
   "servers": [
     {
@@ -156,7 +156,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/basic": {
@@ -252,14 +252,14 @@
         "x-stability": "Stable"
       }
     },
-    "/user/bounties": {
+    "/user/battlestats": {
       "get": {
         "tags": [
           "User"
         ],
-        "summary": "Get bounties placed on you",
-        "description": "Requires public access key. <br>",
-        "operationId": "c85fd102a25aaec3aa98611d0da6c219",
+        "summary": "Get your battlestats",
+        "description": "Requires limited access key. <br>",
+        "operationId": "b2395a36b6f5668ade16f460a593b236",
         "parameters": [
           {
             "$ref": "#/components/parameters/ApiTimestamp"
@@ -277,7 +277,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/UserBountiesResponse"
+                  "$ref": "#/components/schemas/UserBattleStatsResponse"
                 }
               }
             }
@@ -291,14 +291,14 @@
         "x-stability": "Stable"
       }
     },
-    "/user/battlestats": {
+    "/user/bounties": {
       "get": {
         "tags": [
           "User"
         ],
-        "summary": "Get your battlestats",
-        "description": "Requires limited access key. <br>",
-        "operationId": "b2395a36b6f5668ade16f460a593b236",
+        "summary": "Get bounties placed on you",
+        "description": "Requires public access key. <br>",
+        "operationId": "c85fd102a25aaec3aa98611d0da6c219",
         "parameters": [
           {
             "$ref": "#/components/parameters/ApiTimestamp"
@@ -316,7 +316,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/UserBattleStatsResponse"
+                  "$ref": "#/components/schemas/UserBountiesResponse"
                 }
               }
             }
@@ -453,7 +453,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{id}/competition": {
@@ -501,7 +501,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/cooldowns": {
@@ -540,7 +540,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{crimeId}/crimes": {
@@ -717,7 +717,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/faction": {
@@ -756,7 +756,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{id}/faction": {
@@ -804,7 +804,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/factionbalance": {
@@ -1354,7 +1354,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{id}/icons": {
@@ -1402,7 +1402,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/itemmarket": {
@@ -1483,7 +1483,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{id}/job": {
@@ -1531,7 +1531,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/jobpoints": {
@@ -1869,7 +1869,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/money": {
@@ -1950,7 +1950,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/newmessages": {
@@ -1989,7 +1989,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/notifications": {
@@ -2028,7 +2028,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/organizedcrime": {
@@ -2256,7 +2256,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{id}/profile": {
@@ -2307,7 +2307,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/properties": {
@@ -2637,7 +2637,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/reports": {
@@ -2892,7 +2892,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/virus": {
@@ -2931,7 +2931,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/workstats": {
@@ -4484,6 +4484,9 @@
           {
             "$ref": "#/components/parameters/ApiSortDesc"
           },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
           },
@@ -4532,6 +4535,18 @@
               "$ref": "#/components/schemas/FactionId"
             }
           },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortDesc"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
           },
@@ -4568,17 +4583,26 @@
           "Faction"
         ],
         "summary": "Get ranked wars history for your faction",
-        "description": "Requires public access key. <br>",
+        "description": "Requires public access key. <br> Use offset to get older results which are always ordered descending.",
         "operationId": "4f5d624a86e2d389a7a738b6b3ce8c9e",
         "parameters": [
           {
-            "$ref": "#/components/parameters/ApiFrom"
+            "$ref": "#/components/parameters/ApiOffset"
           },
           {
-            "$ref": "#/components/parameters/ApiTo"
+            "$ref": "#/components/parameters/ApiLimit100Default20"
           },
           {
-            "$ref": "#/components/parameters/ApiSortDesc"
+            "$ref": "#/components/parameters/ApiFrom",
+            "description": "No longer has any impact on results."
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo",
+            "description": "No longer has any impact on results."
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortDesc",
+            "description": "No longer has any impact on results."
           },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
@@ -4616,7 +4640,7 @@
           "Faction"
         ],
         "summary": "Get a faction's ranked wars history",
-        "description": "Requires public access key. <br> ",
+        "description": "Requires public access key. <br> Use offset to get older results which are always ordered descending.",
         "operationId": "5b6646714e5ae1cc397bdec877f55691",
         "parameters": [
           {
@@ -4628,6 +4652,12 @@
               "$ref": "#/components/schemas/FactionId"
             }
           },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
           },
@@ -5174,6 +5204,18 @@
               "$ref": "#/components/schemas/FactionId"
             }
           },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortDesc"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100"
+          },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
           },
@@ -6519,6 +6561,9 @@
               "$ref": "#/components/schemas/WeaponBonusEnum"
             }
           },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
           {
             "$ref": "#/components/parameters/ApiOffset"
           },
@@ -7890,6 +7935,15 @@
         "description": "Requires public access key. <br>",
         "operationId": "4b7322594732b4e263f2e612f648e6a4",
         "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiLimitDefault20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSort"
+          },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
           },
@@ -19868,7 +19922,8 @@
               "disposal",
               "cracking",
               "forgery",
-              "scamming"
+              "scamming",
+              "arson"
             ],
             "properties": {
               "search_for_cash": {
@@ -19918,6 +19973,10 @@
               "scamming": {
                 "type": "integer",
                 "format": "int32"
+              },
+              "arson": {
+                "type": "integer",
+                "format": "int32"
               }
             },
             "type": "object"
@@ -21888,7 +21947,8 @@
           "disposalskill",
           "crackingskill",
           "forgeryskill",
-          "scammingskill"
+          "scammingskill",
+          "arsonskill"
         ]
       },
       "FactionRaidReport": {
@@ -24449,7 +24509,7 @@
                     "$ref": "#/components/schemas/ItemId"
                   },
                   "is_reusable": {
-                    "description": "Shows if the item is reusable or consumed during the crime.",
+                    "description": "Shows if the item is reusable or consumed during the crime.<br><b>Important note: There may be alternative paths which won't consume the item, even if the item is non-reusable.</b>",
                     "type": "boolean"
                   },
                   "is_available": {
@@ -25866,11 +25926,11 @@
       },
       "MarketRentalsResponse": {
         "required": [
-          "properties",
+          "rentals",
           "_metadata"
         ],
         "properties": {
-          "properties": {
+          "rentals": {
             "$ref": "#/components/schemas/MarketRentalDetails"
           },
           "_metadata": {
@@ -29254,6 +29314,17 @@
           "minimum": 1
         }
       },
+      "ApiLimitDefault20": {
+        "name": "limit",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "format": "int32",
+          "default": 20,
+          "minimum": 1
+        }
+      },
       "ApiTarget": {
         "name": "target",
         "in": "query",

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.3.7",
-    "@types/node": "^22.18.6",
+    "@scalar/openapi-types": "^0.4.1",
+    "@types/node": "^22.18.10",
     "prettier": "^3.6.2",
     "typeconv": "^2.3.1",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",