tornapi-typescript 2.0.2 → 3.0.1

package/dist/index.d.ts

@@ -22,6 +22,7 @@ export type UserCrimeUniquesRewardAmmoEnum = "standard" | "special";
 export type RaceStatusEnum = "open" | "in_progress" | "finished";
 export type TornHofCategory = "level" | "busts" | "rank" | "traveltime" | "workstats" | "networth" | "revives" | "defends" | "offences" | "attacks" | "awards" | "racingwins" | "racingpoints" | "racingskill";
 export type TornFactionHofCategory = "respect" | "chains" | "rank";
+export type TornOrganizedCrimePositionId = "P1" | "P2" | "P3" | "P4" | "P5" | "P6";
 export type FactionTerritoryWarResultEnum = "success_assault" | "fail_assault" | "end_with_nap" | "end_with_destroy_attack" | "end_with_destroy_defense" | "end_with_peace_treaty";
 export type FactionAttackResult = "None" | "Attacked" | "Mugged" | "Hospitalized" | "Arrested" | "Looted" | "Lost" | "Stalemate" | "Assist" | "Escape" | "Timeout" | "Special" | "Bounty" | "Interrupted";
 export type RaceCarUpgradeCategory = "Aerodynamics" | "Brakes" | "Engine" | "Exhaust and Induction" | "Fuel" | "Safety" | "Suspension" | "Transmission" | "Weight Reduction" | "Wheels and Tyres";
@@ -359,6 +360,7 @@ export interface UserPropertyDetailsExtendedRented extends UserPropertyBasicDeta
     cost_per_day: number;
     rental_period: number;
     rental_period_remaining: number;
+    rented_by: BasicUser;
 }
 export interface UserPropertyDetailsExtendedForRent extends UserPropertyBasicDetails {
     used_by: BasicUser[];
@@ -1807,6 +1809,8 @@ export interface FactionCrimeReward {
 }
 export interface FactionCrimeSlot {
     position: string;
+    position_id: TornOrganizedCrimePositionId;
+    position_number: number;
     item_requirement: {
         id: ItemId;
         /** Shows if the item is reusable or consumed during the crime. */
@@ -2048,6 +2052,11 @@ export interface KeyInfoResponse {
             forum: ForumSelectionName[];
             key: KeySelectionName[];
         };
+        user: {
+            faction_id: FactionId | null;
+            company_id: CompanyId | null;
+            id: UserId;
+        };
         access: {
             level: number;
             type: ApiKeyAccessTypeEnum;
@@ -2339,7 +2348,7 @@ export interface TornOrganizedCrimeScope {
     return: number;
 }
 export interface TornOrganizedCrimeSlot {
-    id: string;
+    id: TornOrganizedCrimePositionId;
     name: string;
     required_item: TornOrganizedCrimeRequiredItem | null;
 }
@@ -2444,7 +2453,7 @@ export interface TornCalendarResponse {
         events: TornCalendarActivity[];
     };
 }
-export interface TornHof {
+export interface TornHofBasic {
     id: UserId;
     username: string;
     faction_id: FactionId;
@@ -2458,6 +2467,10 @@ export interface TornHof {
     value: number | string | number;
     rank: string;
 }
+export interface TornHofWithOffenses extends TornHofBasic {
+    criminal_offenses: number;
+}
+export type TornHof = TornHofBasic | TornHofWithOffenses;
 export interface TornHofResponse {
     hof: TornHof[];
     _metadata: RequestMetadataWithLinks;
@@ -3297,6 +3310,10 @@ export interface UserV1 extends BaseSchema {
                     bazaarcustomers: number;
                     bazaarprofit: number;
                     bazaarsales: number;
+                    itemmarketsales: number;
+                    itemmarketcustomers: number;
+                    itemmarketrevenue: number;
+                    itemmarketfees: number;
                     bestactivestreak: number;
                     bestdamage: number;
                     bestkillstreak: number;
@@ -6398,10 +6415,10 @@ export type SectionV1 = keyof SectionsV1Map;
 export type SectionV2 = keyof SectionsV2Map;
 export type SelectionV1<Sec extends SectionV1> = keyof SectionsV1Map[Sec]["selections"];
 export type SelectionV2<Sec extends SectionV2> = keyof SectionsV2Map[Sec]["selections"];
-export type ParamsV1<Sec extends SectionV1, Sel extends keyof SectionsV1Map[Sec]["selections"]> = SectionsV1Map[Sec]["selections"][Sel] extends {
+export type ParamsV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>> = SectionsV1Map[Sec]["selections"][Sel] extends {
     params: any;
 } ? SectionsV1Map[Sec]["selections"][Sel]["params"] : never;
-export type ParamsV2<Sec extends SectionV2, Sel extends keyof SectionsV2Map[Sec]["selections"]> = SectionsV2Map[Sec]["selections"][Sel] extends {
+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 GetArgumentV1<Sec extends SectionV1, Sel extends keyof SectionsV1Map[Sec]["selections"]> = ParamsV1<Sec, Sel> extends never ? {
@@ -6459,11 +6476,44 @@ 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 declare function tornApiGetV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>>({ section, selections, id, params, key, comment, cache, expiry, }: GetArgumentV1<Sec, Sel> & {
+export interface HTTPClient {
+    getJson(url: URL): Promise<any>;
+}
+export declare class FetchHTTPClient implements HTTPClient {
+    getJson(url: URL): Promise<any>;
+}
+interface ClientOptions {
+    httpClient?: HTTPClient;
+    defaultComment?: string;
+}
+export declare class TornApiClient {
+    private readonly httpClient;
+    private readonly defaultComment?;
+    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>>;
+    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>>;
-export declare function tornApiGetV2<Sec extends SectionV2, Sel extends SelectionV2<Sec>>({ section, selections, id, params, key, comment, cache, expiry, }: GetArgumentV2<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>>;

package/dist/index.js

@@ -34,81 +34,80 @@ 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 async function tornApiGetV1({ section, selections, id, params = {}, key, comment, cache, expiry, }) {
-    const cached = await cache?.get({
-        section,
-        selections,
-        id,
-        params,
-        key,
-    });
-    if (cached)
-        return cached;
-    const url = new URL(`https://api.torn.com/${section}/${id ?? ""}`);
-    selections?.length &&
-        url.searchParams.set("selections", selections.join(","));
-    url.searchParams.set("key", key);
-    if (comment)
-        url.searchParams.set("comment", comment);
-    Object.entries(params).forEach(([k, v]) => url.searchParams.set(k, v));
-    return await fetch(url)
-        .then((res) => res.json())
-        .then(addToCache)
-        .catch(handleError);
-    function handleError(e) {
-        console.error(e);
-        return { error: { code: -1, error: generateErrorString(e) } };
-        function generateErrorString(e) {
-            switch (typeof e) {
-                case "string":
-                    return e;
-                case "object": {
-                    if (e instanceof Error)
-                        return e.message;
-                    return JSON.stringify(e);
-                }
-                default:
-                    return e.toString();
-            }
-        }
+export class FetchHTTPClient {
+    async getJson(url) {
+        const response = await fetch(url);
+        return await response.json();
     }
-    function addToCache(response) {
-        if ("error" in response)
+}
+export class TornApiClient {
+    httpClient;
+    defaultComment;
+    constructor(options = {}) {
+        this.httpClient = options.httpClient ?? new FetchHTTPClient();
+        this.defaultComment = options.defaultComment;
+    }
+    async getV1({ section, selections, id, params = {}, key, comment, cache, expiry, }) {
+        const cached = await cache?.get({
+            section,
+            selections,
+            id,
+            params,
+            key,
+        });
+        if (cached)
+            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);
+        function addToCache(response) {
+            if ("error" in response)
+                return response;
+            cache?.set({
+                section,
+                selections,
+                id,
+                params,
+                key,
+            }, response, expiry ?? Date.now() + 30_000);
             return response;
-        cache?.set({
+        }
+    }
+    async getV2({ section, selections, id, params = {}, key, comment, cache, expiry, }) {
+        const cached = await cache?.get({
             section,
             selections,
             id,
             params,
             key,
-        }, response, expiry ?? Date.now() + 30_000);
-        return response;
+        });
+        if (cached)
+            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);
+        function addToCache(response) {
+            if ("error" in response)
+                return response;
+            cache?.set({
+                section,
+                selections,
+                id,
+                params,
+                key,
+            }, response, expiry ?? Date.now() + 30_000);
+            return response;
+        }
     }
-}
-export async function tornApiGetV2({ section, selections, id, params = {}, key, comment, cache, expiry, }) {
-    const cached = await cache?.get({
-        section,
-        selections,
-        id,
-        params,
-        key,
-    });
-    if (cached)
-        return cached;
-    const url = new URL(`https://api.torn.com/v2/${section}/${id ?? ""}`);
-    selections?.length &&
-        url.searchParams.set("selections", selections.join(","));
-    url.searchParams.set("key", key);
-    if (comment)
-        url.searchParams.set("comment", comment);
-    Object.entries(params).forEach(([k, v]) => url.searchParams.set(k, v));
-    return await fetch(url)
-        .then((res) => res.json())
-        .then(addToCache)
-        .catch(handleError);
-    function handleError(e) {
-        console.error(e);
-        return { error: { code: -1, error: generateErrorString(e) } };
+    handleError(error) {
+        console.error(error);
+        return { error: { code: -1, error: generateErrorString(error) } };
         function generateErrorString(e) {
             switch (typeof e) {
                 case "string":
@@ -123,16 +122,30 @@ export async function tornApiGetV2({ section, selections, id, params = {}, key,
             }
         }
     }
-    function addToCache(response) {
-        if ("error" in response)
-            return response;
-        cache?.set({
-            section,
-            selections,
-            id,
-            params,
+    populateUrl(url, key, selections, comment, params) {
+        const allParams = {
             key,
-        }, response, expiry ?? Date.now() + 30_000);
-        return response;
+            comment: comment ?? this.defaultComment,
+            selections: selections.length ? selections.join(",") : undefined,
+            ...params,
+        };
+        Object.entries(allParams)
+            .filter((entry) => !!entry[1])
+            .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

@@ -4303,6 +4303,14 @@ export type TornHofCategory =
 
 export type TornFactionHofCategory = "respect" | "chains" | "rank";
 
+export type TornOrganizedCrimePositionId =
+    | "P1"
+    | "P2"
+    | "P3"
+    | "P4"
+    | "P5"
+    | "P6";
+
 export type FactionTerritoryWarResultEnum =
     | "success_assault"
     | "fail_assault"
@@ -5109,6 +5117,7 @@ export interface UserPropertyDetailsExtendedRented
     cost_per_day: number;
     rental_period: number;
     rental_period_remaining: number;
+    rented_by: BasicUser;
 }
 
 export interface UserPropertyDetailsExtendedForRent
@@ -7050,6 +7059,8 @@ export interface FactionCrimeReward {
 
 export interface FactionCrimeSlot {
     position: string;
+    position_id: TornOrganizedCrimePositionId;
+    position_number: number;
     item_requirement: {
         id: ItemId;
         /** Shows if the item is reusable or consumed during the crime. */
@@ -7325,6 +7336,11 @@ export interface KeyInfoResponse {
             forum: ForumSelectionName[];
             key: KeySelectionName[];
         };
+        user: {
+            faction_id: FactionId | null;
+            company_id: CompanyId | null;
+            id: UserId;
+        };
         access: {
             level: number;
             type: ApiKeyAccessTypeEnum;
@@ -7668,7 +7684,7 @@ export interface TornOrganizedCrimeScope {
 }
 
 export interface TornOrganizedCrimeSlot {
-    id: string;
+    id: TornOrganizedCrimePositionId;
     name: string;
     required_item: TornOrganizedCrimeRequiredItem | null;
 }
@@ -7791,7 +7807,7 @@ export interface TornCalendarResponse {
     };
 }
 
-export interface TornHof {
+export interface TornHofBasic {
     id: UserId;
     username: string;
     faction_id: FactionId;
@@ -7806,6 +7822,12 @@ export interface TornHof {
     rank: string;
 }
 
+export interface TornHofWithOffenses extends TornHofBasic {
+    criminal_offenses: number;
+}
+
+export type TornHof = TornHofBasic | TornHofWithOffenses;
+
 export interface TornHofResponse {
     hof: TornHof[];
     _metadata: RequestMetadataWithLinks;
@@ -8668,6 +8690,10 @@ export interface UserV1 extends BaseSchema {
                     bazaarcustomers: number;
                     bazaarprofit: number;
                     bazaarsales: number;
+                    itemmarketsales: number;
+                    itemmarketcustomers: number;
+                    itemmarketrevenue: number;
+                    itemmarketfees: number;
                     bestactivestreak: number;
                     bestdamage: number;
                     bestkillstreak: number;
@@ -11902,16 +11928,21 @@ export type SelectionV2<Sec extends SectionV2> =
 
 export type ParamsV1<
     Sec extends SectionV1,
-    Sel extends keyof SectionsV1Map[Sec]["selections"],
-> = SectionsV1Map[Sec]["selections"][Sel] extends { params: any }
+    Sel extends SelectionV1<Sec>,
+> = SectionsV1Map[Sec]["selections"][Sel] extends {
+    params: any;
+}
     ? SectionsV1Map[Sec]["selections"][Sel]["params"]
     : never;
 export type ParamsV2<
     Sec extends SectionV2,
-    Sel extends keyof SectionsV2Map[Sec]["selections"],
-> = SectionsV2Map[Sec]["selections"][Sel] extends { params: any }
+    Sel extends SelectionV2<Sec>,
+> = SectionsV2Map[Sec]["selections"][Sel] extends {
+    params: any;
+}
     ? SectionsV2Map[Sec]["selections"][Sel]["params"]
     : never;
+
 export type GetArgumentV1<
     Sec extends SectionV1,
     Sel extends keyof SectionsV1Map[Sec]["selections"],
@@ -12022,123 +12053,145 @@ type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (
     ? I
     : never;
 
-export async function tornApiGetV1<
-    Sec extends SectionV1,
-    Sel extends SelectionV1<Sec>,
->({
-    section,
-    selections,
-    id,
-    params = {} as any,
-    key,
-    comment,
-    cache,
-    expiry,
-}: GetArgumentV1<Sec, Sel> & {
-    cache?: CacheV1<Sec, Sel>;
-    expiry?: number;
-}): Promise<GetResponseV1<Sec, Sel>> {
-    const cached = await cache?.get({
+export interface HTTPClient {
+    getJson(url: URL): Promise<any>;
+}
+
+export class FetchHTTPClient implements HTTPClient {
+    async getJson(url: URL): Promise<any> {
+        const response = await fetch(url);
+
+        return await response.json();
+    }
+}
+
+interface ClientOptions {
+    httpClient?: HTTPClient;
+    defaultComment?: string;
+}
+
+export class TornApiClient {
+    private readonly httpClient: HTTPClient;
+    private readonly defaultComment?: string;
+
+    constructor(options: ClientOptions = {}) {
+        this.httpClient = options.httpClient ?? new FetchHTTPClient();
+        this.defaultComment = options.defaultComment;
+    }
+
+    async getV1<Sec extends SectionV1, Sel extends SelectionV1<Sec>>({
         section,
         selections,
         id,
-        params,
+        params = {} as any,
         key,
-    } as GetArgumentV1<Sec, Sel>);
-    if (cached) return cached;
-
-    const url = new URL(`https://api.torn.com/${section}/${id ?? ""}`);
-    selections?.length &&
-        url.searchParams.set("selections", selections.join(","));
-    url.searchParams.set("key", key);
-    if (comment) url.searchParams.set("comment", comment);
-    Object.entries<string>(params as any).forEach(([k, v]) =>
-        url.searchParams.set(k, v),
-    );
-
-    return await fetch(url)
-        .then((res) => res.json())
-        .then(addToCache)
-        .catch(handleError);
-
-    function handleError(e: unknown) {
-        console.error(e);
-        return { error: { code: -1, error: generateErrorString(e) } };
+        comment,
+        cache,
+        expiry,
+    }: GetArgumentV1<Sec, Sel> & {
+        cache?: CacheV1<Sec, Sel>;
+        expiry?: number;
+    }): Promise<GetResponseV1<Sec, Sel>> {
+        const cached = await cache?.get({
+            section,
+            selections,
+            id,
+            params,
+            key,
+        } as GetArgumentV1<Sec, Sel>);
+        if (cached) return cached;
+
+        const url = new URL(`https://api.torn.com/${section}/${id ?? ""}`);
+        this.populateUrl(
+            url,
+            key,
+            (selections ?? []) as string[],
+            comment,
+            params ?? {},
+        );
 
-        function generateErrorString(e: unknown): string {
-            switch (typeof e) {
-                case "string":
-                    return e;
-                case "object": {
-                    if (e instanceof Error) return e.message;
-                    return JSON.stringify(e);
-                }
-                default:
-                    return (e as any).toString();
-            }
+        return this.httpClient
+            .getJson(url)
+            .then(addToCache)
+            .catch(this.handleError);
+
+        function addToCache(
+            response: GetResponseV1<Sec, Sel>,
+        ): GetResponseV1<Sec, Sel> {
+            if ("error" in (response as any)) return response;
+            cache?.set(
+                {
+                    section,
+                    selections,
+                    id,
+                    params,
+                    key,
+                } as GetArgumentV1<Sec, Sel>,
+                response,
+                expiry ?? Date.now() + 30_000,
+            );
+            return response;
         }
     }
 
-    function addToCache(
-        response: GetResponseV1<Sec, Sel>,
-    ): GetResponseV1<Sec, Sel> {
-        if ("error" in (response as any)) return response;
-        cache?.set(
-            {
-                section,
-                selections,
-                id,
-                params,
-                key,
-            } as GetArgumentV1<Sec, Sel>,
-            response,
-            expiry ?? Date.now() + 30_000,
-        );
-        return response;
-    }
-}
-export async function tornApiGetV2<
-    Sec extends SectionV2,
-    Sel extends SelectionV2<Sec>,
->({
-    section,
-    selections,
-    id,
-    params = {} as any,
-    key,
-    comment,
-    cache,
-    expiry,
-}: GetArgumentV2<Sec, Sel> & {
-    cache?: CacheV2<Sec, Sel>;
-    expiry?: number;
-}): Promise<GetResponseV2<Sec, Sel>> {
-    const cached = await cache?.get({
+    async getV2<Sec extends SectionV2, Sel extends SelectionV2<Sec>>({
         section,
         selections,
         id,
-        params,
+        params = {} as any,
         key,
-    } as GetArgumentV2<Sec, Sel>);
-    if (cached) return cached;
-
-    const url = new URL(`https://api.torn.com/v2/${section}/${id ?? ""}`);
-    selections?.length &&
-        url.searchParams.set("selections", selections.join(","));
-    url.searchParams.set("key", key);
-    if (comment) url.searchParams.set("comment", comment);
-    Object.entries<string>(params as any).forEach(([k, v]) =>
-        url.searchParams.set(k, v),
-    );
-
-    return await fetch(url)
-        .then((res) => res.json())
-        .then(addToCache)
-        .catch(handleError);
-
-    function handleError(e: unknown) {
-        console.error(e);
-        return { error: { code: -1, error: generateErrorString(e) } };
+        comment,
+        cache,
+        expiry,
+    }: GetArgumentV2<Sec, Sel> & {
+        cache?: CacheV2<Sec, Sel>;
+        expiry?: number;
+    }): Promise<GetResponseV2<Sec, Sel>> {
+        const cached = await cache?.get({
+            section,
+            selections,
+            id,
+            params,
+            key,
+        } as GetArgumentV2<Sec, Sel>);
+        if (cached) return cached;
+
+        const url = new URL(`https://api.torn.com/v2/${section}/${id ?? ""}`);
+        this.populateUrl(
+            url,
+            key,
+            (selections ?? []) as string[],
+            comment,
+            params ?? {},
+        );
+
+        return this.httpClient
+            .getJson(url)
+            .then(addToCache)
+            .catch(this.handleError);
+
+        function addToCache(
+            response: GetResponseV2<Sec, Sel>,
+        ): GetResponseV2<Sec, Sel> {
+            if ("error" in (response as any)) return response;
+            cache?.set(
+                {
+                    section,
+                    selections,
+                    id,
+                    params,
+                    key,
+                } as GetArgumentV2<Sec, Sel>,
+                response,
+                expiry ?? Date.now() + 30_000,
+            );
+            return response;
+        }
+    }
+
+    private handleError(error: unknown) {
+        console.error(error);
+        return { error: { code: -1, error: generateErrorString(error) } };
 
         function generateErrorString(e: unknown): string {
             switch (typeof e) {
@@ -12154,21 +12207,58 @@ export async function tornApiGetV2<
         }
     }
 
-    function addToCache(
-        response: GetResponseV2<Sec, Sel>,
-    ): GetResponseV2<Sec, Sel> {
-        if ("error" in (response as any)) return response;
-        cache?.set(
-            {
-                section,
-                selections,
-                id,
-                params,
-                key,
-            } as GetArgumentV2<Sec, Sel>,
-            response,
-            expiry ?? Date.now() + 30_000,
-        );
-        return response;
+    private populateUrl(
+        url: URL,
+        key: string,
+        selections: string[],
+        comment: string | undefined,
+        params: Record<string, string | undefined>,
+    ): void {
+        const allParams: Record<string, string | undefined> = {
+            key,
+            comment: comment ?? this.defaultComment,
+            selections: selections.length ? selections.join(",") : undefined,
+            ...params,
+        };
+
+        Object.entries(allParams)
+            .filter<[string, string]>(
+                (entry): entry is [string, string] => !!entry[1],
+            )
+            .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": "2.0.2"
+    "version": "3.0.1"
   },
   "servers": [
     {
@@ -11585,6 +11585,17 @@
           "rank"
         ]
       },
+      "TornOrganizedCrimePositionId": {
+        "type": "string",
+        "enum": [
+          "P1",
+          "P2",
+          "P3",
+          "P4",
+          "P5",
+          "P6"
+        ]
+      },
       "FactionTerritoryWarResultEnum": {
         "type": "string",
         "enum": [
@@ -13559,6 +13570,7 @@
           {
             "required": [
               "status",
+              "rented_by",
               "used_by",
               "cost",
               "cost_per_day",
@@ -13593,6 +13605,9 @@
               "rental_period_remaining": {
                 "type": "integer",
                 "format": "int32"
+              },
+              "rented_by": {
+                "$ref": "#/components/schemas/BasicUser"
               }
             },
             "type": "object"
@@ -20724,6 +20739,8 @@
       "FactionCrimeSlot": {
         "required": [
           "position",
+          "position_id",
+          "position_number",
           "item_requirement",
           "user",
           "checkpoint_pass_rate"
@@ -20732,6 +20749,13 @@
           "position": {
             "type": "string"
           },
+          "position_id": {
+            "$ref": "#/components/schemas/TornOrganizedCrimePositionId"
+          },
+          "position_number": {
+            "type": "integer",
+            "format": "int32"
+          },
           "item_requirement": {
             "description": "Details of item required for the slot, if applicable.",
             "oneOf": [
@@ -21896,7 +21920,8 @@
           "info": {
             "required": [
               "selections",
-              "access"
+              "access",
+              "user"
             ],
             "properties": {
               "selections": {
@@ -21969,6 +21994,41 @@
                 },
                 "type": "object"
               },
+              "user": {
+                "required": [
+                  "id",
+                  "faction_id",
+                  "company_id"
+                ],
+                "properties": {
+                  "faction_id": {
+                    "description": "Null only if the user is not in a faction.",
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/FactionId"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "company_id": {
+                    "description": "Null only if the user is not in a company.",
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/CompanyId"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "id": {
+                    "$ref": "#/components/schemas/UserId"
+                  }
+                },
+                "type": "object"
+              },
               "access": {
                 "required": [
                   "level",
@@ -21988,6 +22048,8 @@
                     "type": "boolean"
                   },
                   "faction_id": {
+                    "description": "This field is replaced with 'user'.'faction_id' field and will be removed on 1st of September 2025. Populated only if 'faction' field is true.",
+                    "deprecated": true,
                     "oneOf": [
                       {
                         "$ref": "#/components/schemas/FactionId"
@@ -22001,6 +22063,8 @@
                     "type": "boolean"
                   },
                   "company_id": {
+                    "description": "This field is replaced with 'user'.'company_id' field and will be removed on 1st of September 2025. Populated only if 'company' field is true.",
+                    "deprecated": true,
                     "oneOf": [
                       {
                         "$ref": "#/components/schemas/CompanyId"
@@ -23476,7 +23540,7 @@
         ],
         "properties": {
           "id": {
-            "type": "string"
+            "$ref": "#/components/schemas/TornOrganizedCrimePositionId"
           },
           "name": {
             "type": "string"
@@ -23982,7 +24046,7 @@
         },
         "type": "object"
       },
-      "TornHof": {
+      "TornHofBasic": {
         "required": [
           "id",
           "username",
@@ -24056,6 +24120,35 @@
         },
         "type": "object"
       },
+      "TornHofWithOffenses": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/TornHofBasic"
+          },
+          {
+            "required": [
+              "criminal_offenses"
+            ],
+            "properties": {
+              "criminal_offenses": {
+                "type": "integer",
+                "format": "int32"
+              }
+            },
+            "type": "object"
+          }
+        ]
+      },
+      "TornHof": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/TornHofBasic"
+          },
+          {
+            "$ref": "#/components/schemas/TornHofWithOffenses"
+          }
+        ]
+      },
       "TornHofResponse": {
         "required": [
           "hof",

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "2.0.2",
+  "version": "3.0.1",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.3.5",
-    "@types/node": "^22.16.0",
+    "@scalar/openapi-types": "^0.3.6",
+    "@types/node": "^22.16.5",
     "prettier": "^3.6.2",
     "typeconv": "^2.3.1",
     "typescript": "^5.8.3"