tornapi-typescript 0.0.3 → 0.0.5

package/LICENSE

@@ -1,24 +1,24 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <https://unlicense.org>
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -1,30 +1,30 @@
-# TornAPI Typescript
-
-[![NPM Version](https://img.shields.io/npm/v/tornapi-typescript)](https://www.npmjs.com/package/tornapi-typescript)
-[![NPM Downloads](https://img.shields.io/npm/d18m/tornapi-typescript)](https://www.npmjs.com/package/tornapi-typescript)
-
-Automatically generated type definition in Typescript for [torn.com](https://torn.com) API V2.
-
-## Installation
-
-`npm i -D tornapi-typescript`
-
-## Generation
-
-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
-  * remove all empty objects (caused by the above cleaning)
-  * run through prettier to have it look decent
-
-## Contact
-
-You can join the community in [our Discord server](https://discord.gg/2wb7GKN). There you can discuss anything related
-to the Torn API, or other tools related to Torn. Issues can also be reported there, or as GitHub issue.
+# TornAPI Typescript
+
+[![NPM Version](https://img.shields.io/npm/v/tornapi-typescript)](https://www.npmjs.com/package/tornapi-typescript)
+[![NPM Downloads](https://img.shields.io/npm/d18m/tornapi-typescript)](https://www.npmjs.com/package/tornapi-typescript)
+
+Automatically generated type definition in Typescript for [torn.com](https://torn.com) API V2.
+
+## Installation
+
+`npm i -D tornapi-typescript`
+
+## Generation
+
+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
+  * remove all empty objects (caused by the above cleaning)
+  * run through prettier to have it look decent
+
+## Contact
+
+You can join the community in [our Discord server](https://discord.gg/2wb7GKN). There you can discuss anything related
+to the Torn API, or other tools related to Torn. Issues can also be reported there, or as GitHub issue.

package/dist/index.d.ts

@@ -178,6 +178,8 @@ export type WeaponBonusEnum =
     | "Wind-up"
     | "Wither";
 
+export type UserListEnum = "Friends" | "Enemies" | "Targets";
+
 export type JobPositionCasinoEnum =
     | "Gaming Consultant"
     | "Marketing Manager"
@@ -956,7 +958,9 @@ export interface FactionCrimeSlot {
     } | null;
     user_id: UserId;
     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;
 }
 
 export interface FactionCrime {
@@ -966,9 +970,6 @@ export interface FactionCrime {
     status: FactionCrimeStatusEnum;
     /** The timestamp at which the crime was created. */
     created_at: number;
-    initiated_at: /** Replaced by the 'planning_at' field (same value). This field will be removed in the future (1st Februrary 2025 or later). */
-    | number /** Replaced by the 'planning_at' field (same value). This field will be removed in the future (1st Februrary 2025 or later). */
-        | null;
     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;
@@ -988,6 +989,10 @@ export interface FactionCrimesResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
+export interface FactionCrimeResponse {
+    crime: FactionCrime;
+}
+
 /** The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'contributors', 'crimeexp', 'currency', 'donations', 'drugs', 'medical', 'positions', 'reports', 'stats', 'temporary', 'upgrades', 'weapons'. */
 export type FactionSelectionName =
     | "applications"
@@ -997,6 +1002,7 @@ export type FactionSelectionName =
     | "chain"
     | "chainreport"
     | "chains"
+    | "crime"
     | "crimes"
     | "hof"
     | "lookup"
@@ -1218,12 +1224,14 @@ export interface ItemMarketListingItemBonus {
     id: number;
     title: string;
     description: string;
+    value: number;
 }
 
 export interface ItemMarketListingItemStats {
     damage: number | null;
     accuracy: number | null;
     armor: number | null;
+    quality: number;
 }
 
 export interface ItemMarketItem {
@@ -1234,7 +1242,6 @@ export interface ItemMarketItem {
 }
 
 export interface ItemMarketListingStackable {
-    id: number;
     price: number;
     amount: number;
 }
@@ -1247,7 +1254,6 @@ export interface ItemMarketListingItemDetails {
 }
 
 export interface ItemMarketListingNonstackable {
-    id: number;
     price: number;
     amount: number;
     itemDetails: ItemMarketListingItemDetails;
@@ -2934,6 +2940,20 @@ export interface UserOrganizedCrimeResponse {
     organizedCrime: FactionCrime | null;
 }
 
+export interface UserList {
+    id: UserId;
+    name: string;
+    level: number;
+    faction_id: FactionId & (number | null);
+    last_action: UserLastAction;
+    status: UserStatus;
+}
+
+export interface UserListResponse {
+    list: UserList[];
+    _metadata: RequestMetadataWithLinks;
+}
+
 /** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'. */
 export type UserSelectionName =
     | "attacks"
@@ -2951,6 +2971,7 @@ export type UserSelectionName =
     | "hof"
     | "itemmarket"
     | "jobranks"
+    | "list"
     | "lookup"
     | "organizedcrime"
     | "personalstats"

package/dist/openapi.json

@@ -795,12 +795,59 @@
         ]
       }
     },
-    "/user/organizedcrime": {
+    "/user/list": {
       "get": {
         "tags": [
           "User",
           "Unstable"
         ],
+        "summary": "Get your friends, enemies or targets list",
+        "description": "Requires limited access key. <br>",
+        "parameters": [
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Select list type",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UserListEnum"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit50"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffsetNoDefault"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortAsc"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserListResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ]
+      }
+    },
+    "/user/organizedcrime": {
+      "get": {
+        "tags": [
+          "User",
+          "Stable"
+        ],
         "summary": "Get your current ongoing organized crime",
         "description": "Requires minimal access key. <br>",
         "responses": {
@@ -1310,6 +1357,9 @@
                     {
                       "$ref": "#/components/schemas/UserItemMarketResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserListResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserPersonalStatsResponse"
                     },
@@ -1740,7 +1790,7 @@
       "get": {
         "tags": [
           "Faction",
-          "Unstable"
+          "Stable"
         ],
         "summary": "Get your faction's organized crimes",
         "description": "Requires public minimal access key with faction API access permissions. <br> It's possible to get older entries either by timestamp range (from, to) or with offset.",
@@ -1818,6 +1868,44 @@
         ]
       }
     },
+    "/faction/{id}/crime": {
+      "get": {
+        "tags": [
+          "Faction",
+          "Stable"
+        ],
+        "summary": "Get a specific organized crime",
+        "description": "Requires public minimal access key with faction API access permissions. <br>",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Crime id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/ItemId"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FactionCrimeResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ]
+      }
+    },
     "/faction/hof": {
       "get": {
         "tags": [
@@ -2463,6 +2551,9 @@
                     {
                       "$ref": "#/components/schemas/FactionCrimesResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/FactionCrimeResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/FactionRankedWarReportResponse"
                     },
@@ -4453,6 +4544,14 @@
           "Wither"
         ]
       },
+      "UserListEnum": {
+        "type": "string",
+        "enum": [
+          "Friends",
+          "Enemies",
+          "Targets"
+        ]
+      },
       "JobPositionCasinoEnum": {
         "type": "string",
         "enum": [
@@ -6554,6 +6653,11 @@
             ]
           },
           "success_chance": {
+            "description": "This field is replaced with 'crime_pass_rate' field and will be removed on 1st of May 2025.",
+            "type": "integer",
+            "deprecated": true
+          },
+          "crime_pass_rate": {
             "type": "integer"
           }
         },
@@ -6563,7 +6667,8 @@
           "item_requirement",
           "user_id",
           "user",
-          "success_chance"
+          "success_chance",
+          "crime_pass_rate"
         ]
       },
       "FactionCrime": {
@@ -6584,12 +6689,6 @@
             "description": "The timestamp at which the crime was created.",
             "type": "integer"
           },
-          "initiated_at": {
-            "description": "Replaced by the 'planning_at' field (same value). This field will be removed in the future (1st Februrary 2025 or later).",
-            "type": "integer",
-            "nullable": true,
-            "deprecated": true
-          },
           "planning_at": {
             "description": "The timestamp at which the planning phase for the crime has begun.",
             "type": "integer",
@@ -6635,7 +6734,6 @@
           "difficulty",
           "status",
           "created_at",
-          "initiated_at",
           "planning_at",
           "ready_at",
           "expired_at",
@@ -6662,6 +6760,17 @@
           "_metadata"
         ]
       },
+      "FactionCrimeResponse": {
+        "properties": {
+          "crime": {
+            "$ref": "#/components/schemas/FactionCrime"
+          }
+        },
+        "type": "object",
+        "required": [
+          "crime"
+        ]
+      },
       "FactionSelectionName": {
         "description": "The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'contributors', 'crimeexp', 'currency', 'donations', 'drugs', 'medical', 'positions', 'reports', 'stats', 'temporary', 'upgrades', 'weapons'.",
         "type": "string",
@@ -6673,6 +6782,7 @@
           "chain",
           "chainreport",
           "chains",
+          "crime",
           "crimes",
           "hof",
           "lookup",
@@ -7327,13 +7437,17 @@
           },
           "description": {
             "type": "string"
+          },
+          "value": {
+            "type": "integer"
           }
         },
         "type": "object",
         "required": [
           "id",
           "title",
-          "description"
+          "description",
+          "value"
         ]
       },
       "ItemMarketListingItemStats": {
@@ -7352,13 +7466,18 @@
             "type": "number",
             "format": "float",
             "nullable": true
+          },
+          "quality": {
+            "type": "number",
+            "format": "float"
           }
         },
         "type": "object",
         "required": [
           "damage",
           "accuracy",
-          "armor"
+          "armor",
+          "quality"
         ]
       },
       "ItemMarketItem": {
@@ -7386,9 +7505,6 @@
       },
       "ItemMarketListingStackable": {
         "properties": {
-          "id": {
-            "type": "integer"
-          },
           "price": {
             "type": "integer"
           },
@@ -7398,7 +7514,6 @@
         },
         "type": "object",
         "required": [
-          "id",
           "price",
           "amount"
         ]
@@ -7437,9 +7552,6 @@
       },
       "ItemMarketListingNonstackable": {
         "properties": {
-          "id": {
-            "type": "integer"
-          },
           "price": {
             "type": "integer"
           },
@@ -7452,7 +7564,6 @@
         },
         "type": "object",
         "required": [
-          "id",
           "price",
           "amount",
           "itemDetails"
@@ -12795,6 +12906,64 @@
           "organizedCrime"
         ]
       },
+      "UserList": {
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "level": {
+            "type": "integer"
+          },
+          "faction_id": {
+            "nullable": true,
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/FactionId"
+              },
+              {
+                "type": "integer",
+                "nullable": true
+              }
+            ]
+          },
+          "last_action": {
+            "$ref": "#/components/schemas/UserLastAction"
+          },
+          "status": {
+            "$ref": "#/components/schemas/UserStatus"
+          }
+        },
+        "type": "object",
+        "required": [
+          "id",
+          "name",
+          "level",
+          "faction_id",
+          "last_action",
+          "status"
+        ]
+      },
+      "UserListResponse": {
+        "properties": {
+          "list": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserList"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object",
+        "required": [
+          "list",
+          "_metadata"
+        ]
+      },
       "UserSelectionName": {
         "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'.",
         "type": "string",
@@ -12814,6 +12983,7 @@
           "hof",
           "itemmarket",
           "jobranks",
+          "list",
           "lookup",
           "organizedcrime",
           "personalstats",
@@ -12903,6 +13073,17 @@
           "type": "string"
         }
       },
+      "ApiLimit50": {
+        "name": "limit",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "default": 50,
+          "maximum": 50,
+          "minimum": 1
+        }
+      },
       "ApiLimit100": {
         "name": "limit",
         "in": "query",

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.1.7",
-    "@types/node": "^22.13.1",
-    "prettier": "^3.5.1",
+    "@scalar/openapi-types": "^0.1.9",
+    "@types/node": "^22.13.10",
+    "prettier": "^3.5.3",
     "typeconv": "^2.3.1",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.2"
   },
   "types": "./dist/index.d.ts",
   "files": [