tornapi-typescript 0.0.5 → 0.1.0

package/README.md

@@ -15,9 +15,7 @@ These types are generated in the following way:
 
 * load [openapi specification](https://www.torn.com/swagger/openapi.json)
 * clean the specification for better types
-  * remove `type` when `allOf` is present, otherwise the specification is not valid
   * remove `type` when `oneOf` is present, for improved types
-  * mark all fields as required, for improved types
 * convert the specification to Typescript definitions using [typeconv](https://github.com/grantila/typeconv)
 * clean the type definitions
   * remove all "[key: string]: any;", because typeconv adds it everywhere for some reason

package/dist/index.d.ts

@@ -283,6 +283,13 @@ export type FactionApplicationStatusEnum =
 
 export type FactionRankedWarsCategoryEnum = "all" | "ongoing";
 
+export type FactionCrimeUserOutcome =
+    | "Successful"
+    | "Failed"
+    | "Jailed"
+    | "Injured"
+    | "Hospitalized";
+
 export type RaceId = number;
 
 export type RaceTrackId = number;
@@ -326,10 +333,8 @@ export type ForumThreadId = number;
 export type ForumPostId = number;
 
 export interface RequestLinks {
-    next: /** Auto-generated link to get the next set of records. */
-    string /** Auto-generated link to get the next set of records. */ | null;
-    prev: /** Auto-generated link to get the prev set of records. */
-    string /** Auto-generated link to get the prev set of records. */ | null;
+    next: string | null;
+    prev: string | null;
 }
 
 export interface RequestMetadata {
@@ -504,7 +509,7 @@ export interface AttackPlayer {
 
 export interface AttackPlayerSimplified {
     id: UserId;
-    faction_id: FactionId & (number | null);
+    faction_id: FactionId | null;
 }
 
 export interface AttackingFinishingHitEffects {
@@ -561,11 +566,11 @@ export interface ReviveSimplified {
     id: ReviveId;
     reviver: {
         id: UserId;
-        faction_id: FactionId & (number | null);
+        faction_id: FactionId | null;
     };
     target: {
         id: UserId;
-        faction_id: FactionId & (number | null);
+        faction_id: FactionId | null;
         hospital_reason: string;
         early_discharge: boolean;
         last_action: number;
@@ -643,7 +648,7 @@ export interface FactionMember {
     has_early_discharge: boolean;
     last_action: UserLastAction;
     status: UserStatus;
-    life: UserLife;
+    life?: UserLife;
     revive_setting: ReviveSetting;
 }
 
@@ -656,8 +661,8 @@ export interface UserLastAction {
 
 /** Unfortunately, current life value is often shown incorrectly, and the calculation for each member is very resource heavy, so this field is deprecated and will be removed on 1st of May, 2025. */
 export interface UserLife {
-    current: number;
-    maximum: number;
+    current?: number;
+    maximum?: number;
 }
 
 /** Details about a user's status. */
@@ -691,9 +696,7 @@ export interface FactionBasic {
     days_old: number;
     capacity: number;
     members: number;
-    is_enlisted: /** Indicates if the faction is enlisted for ranked wars. Available only with faction AA permissions for your own faction. */
-    | boolean /** Indicates if the faction is enlisted for ranked wars. Available only with faction AA permissions for your own faction. */
-        | null;
+    is_enlisted: boolean | null;
     rank: FactionRank;
     best_chain: number;
 }
@@ -762,7 +765,7 @@ export interface FactionTerritoryWar {
     end: number | null;
     /** The score target of the war. */
     target: number;
-    winner: number | null;
+    winner?: FactionId | null;
     /** The factions involved in the territory war. */
     factions: FactionTerritoryWarParticipant[];
 }
@@ -913,7 +916,7 @@ export interface FactionChainReportAttackerAttacks {
     retaliations: number;
     overseas: number;
     draws: number;
-    escapes: number;
+    escapes?: number;
     losses: number;
     war: number;
     bonuses: number;
@@ -921,6 +924,7 @@ export interface FactionChainReportAttackerAttacks {
 
 export interface FactionCrimeUser {
     id: UserId;
+    outcome: FactionCrimeUserOutcome | null;
     /** The timestamp at which the user joined the slot. */
     joined_at: number;
     /** Current planning progress on the slot. */
@@ -944,23 +948,27 @@ export interface FactionCrimeReward {
     money: number;
     items: FactionCrimeRewardItem[];
     respect: number;
+    scope: number;
     payout: FactionCrimeRewardPayout | null;
 }
 
 export interface FactionCrimeSlot {
     position: string;
     item_requirement: {
-        id?: ItemId;
+        id: ItemId;
         /** Shows if the item is reusable or consumed during the crime. */
-        is_reusable?: boolean;
+        is_reusable: boolean;
         /** Shows if user has the required item. */
-        is_available?: boolean;
+        is_available: boolean;
     } | null;
-    user_id: UserId;
+    user_id?: UserId | null;
     user: FactionCrimeUser | null;
-    /** This field is replaced with 'crime_pass_rate' field and will be removed on 1st of May 2025. */
-    success_chance: number;
-    crime_pass_rate: number;
+    /** This field is replaced with 'checkpoint_pass_rate' field and will be removed on 1st of May 2025. */
+    success_chance?: number;
+    /** This field is replaced with 'checkpoint_pass_rate' field and will be removed on 1st of May 2025. */
+    crime_pass_rate?: number;
+    /** Returns CPR for the player who joined the slot. If the slot is empty (availalbe), it shows your CPR for that slot. This value is 0 for expired crimes. */
+    checkpoint_pass_rate: number;
 }
 
 export interface FactionCrime {
@@ -970,16 +978,11 @@ export interface FactionCrime {
     status: FactionCrimeStatusEnum;
     /** The timestamp at which the crime was created. */
     created_at: number;
-    planning_at: /** The timestamp at which the planning phase for the crime has begun. */
-    | number /** The timestamp at which the planning phase for the crime has begun. */
-        | null;
-    ready_at: /** The timestamp at which the crime will be ready. */
-    number /** The timestamp at which the crime will be ready. */ | null;
+    planning_at: number | null;
+    ready_at: number | null;
     /** The timestamp at which the crime will expire. */
     expired_at: number;
-    executed_at: /** The timestamp at which the crime was executed. <br> Note: this value is null for all crimes executed before January 15th, 2025. */
-    | number /** The timestamp at which the crime was executed. <br> Note: this value is null for all crimes executed before January 15th, 2025. */
-        | null;
+    executed_at: number | null;
     slots: FactionCrimeSlot[];
     rewards: FactionCrimeReward | null;
 }
@@ -1043,12 +1046,12 @@ export interface FactionRankedWarDetails {
     /** Timestamp the war ended at. */
     end: number;
     target: number;
-    winner: FactionId & (number | null);
+    winner: FactionId | null;
     factions: {
-        id?: FactionId;
-        name?: string;
-        score?: number;
-        chain?: number;
+        id: FactionId;
+        name: string;
+        score: number;
+        chain: number;
     }[];
 }
 
@@ -1067,29 +1070,29 @@ export interface FactionRankedWarReportResponse {
         winner: FactionId;
         forfeit: boolean;
         factions: {
-            id?: FactionId;
-            name?: string;
-            score?: number;
-            attacks?: number;
-            rank?: {
-                before?: string;
-                after?: string;
+            id: FactionId;
+            name: string;
+            score: number;
+            attacks: number;
+            rank: {
+                before: string;
+                after: string;
             };
-            rewards?: {
-                respect?: number;
-                points?: number;
-                items?: {
-                    id?: ItemId;
-                    name?: string;
-                    quantity?: number;
+            rewards: {
+                respect: number;
+                points: number;
+                items: {
+                    id: ItemId;
+                    name: string;
+                    quantity: number;
                 }[];
             };
-            members?: {
-                id?: UserId;
-                name?: string;
-                level?: number;
-                attacks?: number;
-                score?: number;
+            members: {
+                id: UserId;
+                name: string;
+                level: number;
+                attacks: number;
+                score: number;
             }[];
         }[];
     };
@@ -1097,10 +1100,10 @@ export interface FactionRankedWarReportResponse {
 
 export interface ForumCategoriesResponse {
     categories: {
-        id?: ForumId;
-        title?: string;
-        acronym?: string;
-        threads?: number;
+        id: ForumId;
+        title: string;
+        acronym: string;
+        threads: number;
     }[];
 }
 
@@ -1130,7 +1133,7 @@ export interface ForumThreadBase {
     /** Total number of times players have opened this thread. */
     views: number;
     author: ForumThreadAuthor;
-    last_poster: ForumThreadAuthor;
+    last_poster: ForumThreadAuthor | null;
     first_post_time: number;
     last_post_time: number | null;
     has_poll: boolean;
@@ -1139,9 +1142,9 @@ export interface ForumThreadBase {
 }
 
 export interface ForumThreadExtended extends ForumThreadBase {
-    content?: string;
-    content_raw?: string;
-    poll?: ForumPoll;
+    content: string;
+    content_raw: string;
+    poll: ForumPoll | null;
 }
 
 export interface ForumPost {
@@ -1154,10 +1157,9 @@ export interface ForumPost {
     is_edited: boolean;
     is_pinned: boolean;
     created_time: number;
-    edited_by: UserId;
+    edited_by: UserId | null;
     has_quote: boolean;
-    quoted_post_id: /** 'quoted_post_id' is null when 'has_quote' is false. */
-    number /** 'quoted_post_id' is null when 'has_quote' is false. */ | null;
+    quoted_post_id: number | null;
     /** depending on the input 'cat' parameter, this will either return raw value (with HTML) or plain text. Legacy posts are returned as is, they can't be stripped of tags. */
     content: string;
     likes: number;
@@ -1165,9 +1167,7 @@ export interface ForumPost {
 }
 
 export interface ForumThreadUserExtended extends ForumThreadBase {
-    new_posts?: /** Available only when requesting data for yourself (no id or your id) with at least 'Minimal' access type key. */
-    | number /** Available only when requesting data for yourself (no id or your id) with at least 'Minimal' access type key. */
-        | null;
+    new_posts: number | null;
 }
 
 export interface ForumSubscribedThreadPostsCount {
@@ -1247,7 +1247,7 @@ export interface ItemMarketListingStackable {
 }
 
 export interface ItemMarketListingItemDetails {
-    uid: number;
+    uid: ItemUid;
     stats: ItemMarketListingItemStats;
     bonuses: ItemMarketListingItemBonus[];
     rarity: ("yellow" | "orange" | "red") | null;
@@ -1256,7 +1256,8 @@ export interface ItemMarketListingItemDetails {
 export interface ItemMarketListingNonstackable {
     price: number;
     amount: number;
-    itemDetails: ItemMarketListingItemDetails;
+    itemDetails?: ItemMarketListingItemDetails;
+    item_details: ItemMarketListingItemDetails;
 }
 
 export interface ItemMarket {
@@ -1357,9 +1358,9 @@ export interface Race {
         end: number | null;
     };
     requirements: {
-        car_class: RaceClassEnum;
-        driver_class: RaceClassEnum;
-        car_item_id: ItemId;
+        car_class: RaceClassEnum | null;
+        driver_class: RaceClassEnum | null;
+        car_item_id: ItemId | null;
         requires_stock_car: boolean;
         requires_password: boolean;
         join_fee: number;
@@ -1392,7 +1393,7 @@ export interface RacerDetails {
 }
 
 export interface RacingRaceDetailsResponse extends Race {
-    results?: RacerDetails[];
+    results: RacerDetails[];
 }
 
 export type RacingSelectionName =
@@ -1427,7 +1428,7 @@ export interface TornCrime {
     id: number;
     name: string;
     category_id: number;
-    category_name: string;
+    category_name?: string;
     enhancer_id: number;
     enhancer_name: string;
     unique_outcomes_count: number;
@@ -1470,14 +1471,9 @@ export interface TornHofResponse {
 }
 
 export interface FactionHofValues {
-    chain: /** Maximum chain achieved by the faction. Null if chosen category is 'rank' or 'respect'. */
-    | number /** Maximum chain achieved by the faction. Null if chosen category is 'rank' or 'respect'. */
-        | null;
-    chain_duration: /** The duration of the chain. Null if chosen category is 'rank' or 'respect'. */
-    | number /** The duration of the chain. Null if chosen category is 'rank' or 'respect'. */
-        | null;
-    respect: /** Null if chosen category is 'chain'. */
-    number /** Null if chosen category is 'chain'. */ | null;
+    chain: number | null;
+    chain_duration: number | null;
+    respect: number | null;
 }
 
 export interface TornFactionHof {
@@ -1517,9 +1513,8 @@ export interface Bounty {
     target_id: UserId;
     target_name: string;
     target_level: number;
-    lister_id: UserId & (number | null);
-    lister_name: /** If the bounty is anonymous this field is null. */
-    string /** If the bounty is anonymous this field is null. */ | null;
+    lister_id: UserId | null;
+    lister_name: string | null;
     reward: number;
     reason: string | null;
     quantity: number;
@@ -1528,14 +1523,9 @@ export interface Bounty {
 }
 
 export interface AttackLogSummary {
-    id: UserId /** Id of the participant, could be null in stealthed attacks. */ &
-        (
-            | number /** Id of the participant, could be null in stealthed attacks. */
-            | null
-        );
+    id: UserId | null;
     name: /** Name of the participant, could be null in stealthed attacks. */
-    | string /** Name of the participant, could be null in stealthed attacks. */
-        | null;
+    string | null;
     hits: number;
     misses: number;
     damage: number;
@@ -1547,23 +1537,20 @@ export interface AttackLog {
     action: AttackActionEnum;
     icon: string;
     attacker: /** This value could be null in stealthed attacks. */
-    | {
-              id: UserId;
-              name: string;
-              item: /** This object could be null if there was no item being used in this turn or during this effect. */
-              | {
-                        id: ItemId;
-                        name: string;
-                    } /** This object could be null if there was no item being used in this turn or during this effect. */
-                  | null;
-          } /** This value could be null in stealthed attacks. */
-        | null;
+    {
+        id: UserId;
+        name: string;
+        item: /** This object could be null if there was no item being used in this turn or during this effect. */
+        {
+            id?: ItemId;
+            name?: string;
+        } | null;
+    } | null;
     defender: /** This value could be null in stealthed attacks. */
-    | {
-              id: number;
-              name: string;
-          } /** This value could be null in stealthed attacks. */
-        | null;
+    {
+        id: UserId;
+        name: string;
+    } | null;
 }
 
 export interface AttackLogResponse {
@@ -1616,7 +1603,7 @@ export interface TornItemWeaponDetails {
     base_stats: TornItemBaseStats;
     category: TornItemWeaponCategoryEnum;
     ammo: {
-        "": AmmoId;
+        id: AmmoId;
         name: string;
         magazine_rounds: number;
         rate_of_fire: {
@@ -1645,7 +1632,7 @@ export interface TornItem {
     requirement: string | null;
     image: string;
     type: TornItemTypeEnum;
-    sub_type: TornItemWeaponTypeEnum & (string | null);
+    sub_type: TornItemWeaponTypeEnum | null;
     is_masked: boolean;
     is_tradable: boolean;
     is_found_in_city: boolean;
@@ -1659,7 +1646,7 @@ export interface TornItem {
         market_price: number;
     };
     circulation: number;
-    details: (TornItemWeaponDetails & TornItemArmorDetails) | null;
+    details: TornItemWeaponDetails | TornItemArmorDetails | null;
 }
 
 export interface TornItemsResponse {
@@ -2134,7 +2121,7 @@ export interface PersonalStatsAttackingPublic {
         elo: number;
         unarmored_wins: number;
         highest_level_beaten: number;
-        escapes: {
+        escapes?: {
             player: number;
             foes: number;
         };
@@ -2650,7 +2637,7 @@ export interface UserCrimeDetailsBootlegging {
         total: number;
         earnings: number;
     };
-    dvds_copied: number;
+    dvds_copied?: number;
 }
 
 export interface UserCrimeDetailsGraffiti {
@@ -2672,8 +2659,8 @@ export interface UserCrimeDetailsCardSkimming {
         sold: number;
         lost: number;
         areas: {
-            id?: number;
-            amount?: number;
+            id: number;
+            amount: number;
         }[];
     };
     skimmers: {
@@ -2807,14 +2794,14 @@ export interface UserRacesResponse {
 }
 
 export interface UserRaceCarDetails extends RaceCar {
-    id?: RaceCarId;
-    name?: string;
-    worth?: number;
-    points_spent?: number;
-    races_entered?: number;
-    races_won?: number;
-    is_removed?: boolean;
-    parts?: RaceCarUpgradeId[];
+    id: RaceCarId;
+    name: string;
+    worth: number;
+    points_spent: number;
+    races_entered: number;
+    races_won: number;
+    is_removed: boolean;
+    parts: RaceCarUpgradeId[];
 }
 
 export interface UserEnlistedCarsResponse {
@@ -2832,7 +2819,7 @@ export interface UserForumThreadsResponse {
 }
 
 export interface UserForumSubscribedThreadsResponse {
-    forumSubscribedThreads: ForumSubscribedThread[];
+    forumSubscribedThreads?: ForumSubscribedThread[];
 }
 
 export interface UserForumFeedResponse {
@@ -2906,7 +2893,7 @@ export interface UserItemMarkeListingItemDetails {
     name: string;
     type: string;
     rarity: ("yellow" | "orange" | "red") | null;
-    uid: number | null;
+    uid: ItemUid | null;
     stats: ItemMarketListingItemStats | null;
     bonuses: ItemMarketListingItemBonus[];
 }
@@ -2944,7 +2931,7 @@ export interface UserList {
     id: UserId;
     name: string;
     level: number;
-    faction_id: FactionId & (number | null);
+    faction_id: FactionId | null;
     last_action: UserLastAction;
     status: UserStatus;
 }