npm - tornapi-typescript - Versions diffs - 4.2.4 → 4.3.1 - Mend

tornapi-typescript 4.2.4 → 4.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -5,6 +5,9 @@
  *  - {@link https://github.com/grantila/typeconv}
  */
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
+export type MissionDifficultyEnum = "Very easy" | "Easy" | "Medium" | "Hard" | "Very hard" | "Expert";
+export type MissionStatusEnum = "Accepted" | "Available" | "Failed" | "Completed";
+export type MissionRewardUpgrade = "Item" | "Ammo" | "Upgrade";
 export type UserDonatorStatusEnum = "Donator" | "Subscriber";
 export type UserMessageTypeEnum = "Company newsletter" | "Faction newsletter" | "Warning" | "User message";
 export type JobTypeEnum = "Army" | "Casino" | "Education" | "Grocer" | "Law" | "Medical";
@@ -353,6 +356,50 @@ export interface ReportsResponse {
     _metadata: RequestMetadataWithLinks;
 }
 export type SelectionCategoryEnum = ReportTypeEnum | UserListEnum | PersonalStatsCategoryEnum | RacingRaceTypeEnum;
+export interface MissionRewardDetailsAmmo {
+    id: AmmoId;
+    name: string;
+    type: TornItemAmmoTypeEnum;
+}
+export interface MissionRewardDetailsUpgrade {
+    id: ItemModId;
+    name: string;
+}
+export interface MissionRewardDetailsItem {
+    id: ItemId;
+    name: string;
+    type: TornItemTypeEnum;
+    sub_type: TornItemWeaponTypeEnum | null;
+}
+export interface UserMissionsResponse {
+    missions: {
+        credits: number;
+        givers: {
+            id: UserId;
+            name: string;
+            contracts: {
+                title: string;
+                difficulty: MissionDifficultyEnum;
+                status: MissionStatusEnum;
+                created_at: number;
+                started_at: number | null;
+                expires_at: number | null;
+                completed_at: number | null;
+                rewards: {
+                    money: number;
+                    credits: number;
+                } | null;
+            }[];
+        }[];
+        rewards: {
+            type: MissionRewardUpgrade;
+            details: MissionRewardDetailsAmmo | MissionRewardDetailsUpgrade | MissionRewardDetailsItem;
+            amount: number;
+            cost: number;
+            expires_at: number;
+        }[];
+    };
+}
 export interface UserVirus {
     item: {
         id: ItemId;
@@ -1010,7 +1057,7 @@ export interface UserListResponse {
     list: UserList[];
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','missions','networth','perks','stocks','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -6469,6 +6516,10 @@ export interface UserV2 extends BaseSchema {
             response: UserMessagesResponse;
             params: "limit" | "from" | "to" | "sort" | "timestamp";
         };
+        missions: {
+            response: UserMissionsResponse;
+            params: "timestamp";
+        };
         money: {
             response: UserMoneyResponse;
             params: "timestamp";

package/dist/index.ts CHANGED Viewed

@@ -9,6 +9,22 @@
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
+export type MissionDifficultyEnum =
+    | "Very easy"
+    | "Easy"
+    | "Medium"
+    | "Hard"
+    | "Very hard"
+    | "Expert";
+export type MissionStatusEnum =
+    | "Accepted"
+    | "Available"
+    | "Failed"
+    | "Completed";
+export type MissionRewardUpgrade = "Item" | "Ammo" | "Upgrade";
 export type UserDonatorStatusEnum = "Donator" | "Subscriber";
 export type UserMessageTypeEnum =
@@ -5298,6 +5314,57 @@ export type SelectionCategoryEnum =
     | PersonalStatsCategoryEnum
     | RacingRaceTypeEnum;
+export interface MissionRewardDetailsAmmo {
+    id: AmmoId;
+    name: string;
+    type: TornItemAmmoTypeEnum;
+}
+export interface MissionRewardDetailsUpgrade {
+    id: ItemModId;
+    name: string;
+}
+export interface MissionRewardDetailsItem {
+    id: ItemId;
+    name: string;
+    type: TornItemTypeEnum;
+    sub_type: TornItemWeaponTypeEnum | null;
+}
+export interface UserMissionsResponse {
+    missions: {
+        credits: number;
+        givers: {
+            id: UserId;
+            name: string;
+            contracts: {
+                title: string;
+                difficulty: MissionDifficultyEnum;
+                status: MissionStatusEnum;
+                created_at: number;
+                started_at: number | null;
+                expires_at: number | null;
+                completed_at: number | null;
+                rewards: {
+                    money: number;
+                    credits: number;
+                } | null;
+            }[];
+        }[];
+        rewards: {
+            type: MissionRewardUpgrade;
+            details:
+                | MissionRewardDetailsAmmo
+                | MissionRewardDetailsUpgrade
+                | MissionRewardDetailsItem;
+            amount: number;
+            cost: number;
+            expires_at: number;
+        }[];
+    };
+}
 export interface UserVirus {
     item: {
         id: ItemId;
@@ -6083,7 +6150,7 @@ export interface UserListResponse {
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','missions','networth','perks','stocks','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
@@ -12197,6 +12264,10 @@ export interface UserV2 extends BaseSchema {
             response: UserMessagesResponse;
             params: "limit" | "from" | "to" | "sort" | "timestamp";
         };
+        missions: {
+            response: UserMissionsResponse;
+            params: "timestamp";
+        };
         money: {
             response: UserMoneyResponse;
             params: "timestamp";

package/dist/openapi.json CHANGED Viewed

@@ -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.4"
+    "version": "4.3.1"
   },
   "servers": [
     {
@@ -1872,6 +1872,45 @@
         "x-stability": "Stable"
       }
     },
+    "/user/missions": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your current missions information",
+        "description": "Requires minimal access key. <br>",
+        "operationId": "98a38ba406509483a08bde6bee6f676c",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyMinimal"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserMissionsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/money": {
       "get": {
         "tags": [
@@ -3268,6 +3307,9 @@
                     {
                       "$ref": "#/components/schemas/UserListResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserMissionsResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserPersonalStatsResponse"
                     },
@@ -9010,6 +9052,34 @@
           "E"
         ]
       },
+      "MissionDifficultyEnum": {
+        "type": "string",
+        "enum": [
+          "Very easy",
+          "Easy",
+          "Medium",
+          "Hard",
+          "Very hard",
+          "Expert"
+        ]
+      },
+      "MissionStatusEnum": {
+        "type": "string",
+        "enum": [
+          "Accepted",
+          "Available",
+          "Failed",
+          "Completed"
+        ]
+      },
+      "MissionRewardUpgrade": {
+        "type": "string",
+        "enum": [
+          "Item",
+          "Ammo",
+          "Upgrade"
+        ]
+      },
       "UserDonatorStatusEnum": {
         "type": "string",
         "enum": [
@@ -15518,6 +15588,247 @@
           }
         ]
       },
+      "MissionRewardDetailsAmmo": {
+        "required": [
+          "id",
+          "name",
+          "type"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/AmmoId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "type": {
+            "$ref": "#/components/schemas/TornItemAmmoTypeEnum"
+          }
+        },
+        "type": "object"
+      },
+      "MissionRewardDetailsUpgrade": {
+        "required": [
+          "id",
+          "name"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/ItemModId"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "MissionRewardDetailsItem": {
+        "required": [
+          "id",
+          "name",
+          "type",
+          "sub_type"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/ItemId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "type": {
+            "$ref": "#/components/schemas/TornItemTypeEnum"
+          },
+          "sub_type": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/TornItemWeaponTypeEnum"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "UserMissionsResponse": {
+        "required": [
+          "missions"
+        ],
+        "properties": {
+          "missions": {
+            "required": [
+              "credits",
+              "givers",
+              "rewards"
+            ],
+            "properties": {
+              "credits": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "givers": {
+                "type": "array",
+                "items": {
+                  "required": [
+                    "id",
+                    "name",
+                    "contracts"
+                  ],
+                  "properties": {
+                    "id": {
+                      "$ref": "#/components/schemas/UserId"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "contracts": {
+                      "type": "array",
+                      "items": {
+                        "required": [
+                          "title",
+                          "difficulty",
+                          "status",
+                          "created_at",
+                          "started_at",
+                          "expires_at",
+                          "completed_at",
+                          "rewards"
+                        ],
+                        "properties": {
+                          "title": {
+                            "type": "string"
+                          },
+                          "difficulty": {
+                            "$ref": "#/components/schemas/MissionDifficultyEnum"
+                          },
+                          "status": {
+                            "$ref": "#/components/schemas/MissionStatusEnum"
+                          },
+                          "created_at": {
+                            "type": "integer",
+                            "format": "int32"
+                          },
+                          "started_at": {
+                            "description": "Null if the status is 'Available'.",
+                            "oneOf": [
+                              {
+                                "type": "integer",
+                                "format": "int32"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ]
+                          },
+                          "expires_at": {
+                            "description": "Null if the status is not 'Accepted'.",
+                            "oneOf": [
+                              {
+                                "type": "integer",
+                                "format": "int32"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ]
+                          },
+                          "completed_at": {
+                            "description": "Null if the status is not 'Failed' or 'Completed'.",
+                            "oneOf": [
+                              {
+                                "type": "integer",
+                                "format": "int32"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ]
+                          },
+                          "rewards": {
+                            "description": "Null if the status is not 'Completed'.",
+                            "oneOf": [
+                              {
+                                "required": [
+                                  "money",
+                                  "credits"
+                                ],
+                                "properties": {
+                                  "money": {
+                                    "type": "integer",
+                                    "format": "int32"
+                                  },
+                                  "credits": {
+                                    "type": "integer",
+                                    "format": "int32"
+                                  }
+                                },
+                                "type": "object"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ]
+                          }
+                        },
+                        "type": "object"
+                      }
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "rewards": {
+                "type": "array",
+                "items": {
+                  "required": [
+                    "type",
+                    "details",
+                    "amount",
+                    "cost",
+                    "expires_at"
+                  ],
+                  "properties": {
+                    "type": {
+                      "$ref": "#/components/schemas/MissionRewardUpgrade"
+                    },
+                    "details": {
+                      "description": "The response depends on the 'type' value.",
+                      "oneOf": [
+                        {
+                          "$ref": "#/components/schemas/MissionRewardDetailsAmmo"
+                        },
+                        {
+                          "$ref": "#/components/schemas/MissionRewardDetailsUpgrade"
+                        },
+                        {
+                          "$ref": "#/components/schemas/MissionRewardDetailsItem"
+                        }
+                      ]
+                    },
+                    "amount": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "cost": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "expires_at": {
+                      "type": "integer",
+                      "format": "int32"
+                    }
+                  },
+                  "type": "object"
+                }
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
       "UserVirus": {
         "required": [
           "item",
@@ -18707,7 +19018,7 @@
       "UserSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','missions','networth','perks','stocks','weaponexp'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'.",
             "type": "string",
             "enum": [
               "attacks",
@@ -18742,6 +19053,7 @@
               "medals",
               "merits",
               "messages",
+              "missions",
               "money",
               "newevents",
               "newmessages",
@@ -18770,7 +19082,6 @@
               "equipment",
               "gym",
               "inventory",
-              "missions",
               "networth",
               "perks",
               "stocks",

package/package.json CHANGED Viewed

@@ -1,13 +1,13 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "4.2.4",
+  "version": "4.3.1",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
     "@scalar/openapi-types": "^0.5.0",
-    "@types/node": "^22.18.12",
+    "@types/node": "^24.9.1",
     "prettier": "^3.6.2",
     "typeconv": "^2.3.1",
     "typescript": "^5.9.3"