tornapi-typescript 0.0.2 → 0.0.4

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,27 +1,30 @@
-# 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

@@ -429,7 +429,6 @@ export type TornItemTypeEnum =
     | "Car"
     | "Clothing"
     | "Collectible"
-    | "Defensive"
     | "Drug"
     | "Energy Drink"
     | "Enhancer"
@@ -437,14 +436,10 @@ export type TornItemTypeEnum =
     | "Jewelry"
     | "Material"
     | "Medical"
-    | "Melee"
     | "Other"
     | "Plushie"
-    | "Primary"
-    | "Secondary"
     | "Special"
     | "Supply Pack"
-    | "Temporary"
     | "Tool"
     | "Unused"
     | "Weapon";
@@ -961,7 +956,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 {
@@ -971,9 +968,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;
@@ -993,6 +987,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"
@@ -1002,6 +1000,7 @@ export type FactionSelectionName =
     | "chain"
     | "chainreport"
     | "chains"
+    | "crime"
     | "crimes"
     | "hof"
     | "lookup"
@@ -1223,12 +1222,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 {
@@ -1239,7 +1240,6 @@ export interface ItemMarketItem {
 }
 
 export interface ItemMarketListingStackable {
-    id: number;
     price: number;
     amount: number;
 }
@@ -1252,7 +1252,6 @@ export interface ItemMarketListingItemDetails {
 }
 
 export interface ItemMarketListingNonstackable {
-    id: number;
     price: number;
     amount: number;
     itemDetails: ItemMarketListingItemDetails;

package/dist/openapi.json

@@ -799,7 +799,7 @@
       "get": {
         "tags": [
           "User",
-          "Unstable"
+          "Stable"
         ],
         "summary": "Get your current ongoing organized crime",
         "description": "Requires minimal access key. <br>",
@@ -1740,7 +1740,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 +1818,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 +2501,9 @@
                     {
                       "$ref": "#/components/schemas/FactionCrimesResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/FactionCrimeResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/FactionRankedWarReportResponse"
                     },
@@ -3553,7 +3594,6 @@
         "description": "Requires public key. <br>",
         "parameters": [
           {
-            "parameter": "LogId",
             "name": "log",
             "in": "query",
             "description": "Code of the attack log. E.g. d51ad4fe6be884b309b142e2d1d4f807",
@@ -4799,7 +4839,6 @@
           "Car",
           "Clothing",
           "Collectible",
-          "Defensive",
           "Drug",
           "Energy Drink",
           "Enhancer",
@@ -4807,14 +4846,10 @@
           "Jewelry",
           "Material",
           "Medical",
-          "Melee",
           "Other",
           "Plushie",
-          "Primary",
-          "Secondary",
           "Special",
           "Supply Pack",
-          "Temporary",
           "Tool",
           "Unused",
           "Weapon"
@@ -6560,6 +6595,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"
           }
         },
@@ -6569,7 +6609,8 @@
           "item_requirement",
           "user_id",
           "user",
-          "success_chance"
+          "success_chance",
+          "crime_pass_rate"
         ]
       },
       "FactionCrime": {
@@ -6590,12 +6631,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",
@@ -6641,7 +6676,6 @@
           "difficulty",
           "status",
           "created_at",
-          "initiated_at",
           "planning_at",
           "ready_at",
           "expired_at",
@@ -6668,6 +6702,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",
@@ -6679,6 +6724,7 @@
           "chain",
           "chainreport",
           "chains",
+          "crime",
           "crimes",
           "hof",
           "lookup",
@@ -7333,13 +7379,17 @@
           },
           "description": {
             "type": "string"
+          },
+          "value": {
+            "type": "integer"
           }
         },
         "type": "object",
         "required": [
           "id",
           "title",
-          "description"
+          "description",
+          "value"
         ]
       },
       "ItemMarketListingItemStats": {
@@ -7358,13 +7408,18 @@
             "type": "number",
             "format": "float",
             "nullable": true
+          },
+          "quality": {
+            "type": "number",
+            "format": "float"
           }
         },
         "type": "object",
         "required": [
           "damage",
           "accuracy",
-          "armor"
+          "armor",
+          "quality"
         ]
       },
       "ItemMarketItem": {
@@ -7392,9 +7447,6 @@
       },
       "ItemMarketListingStackable": {
         "properties": {
-          "id": {
-            "type": "integer"
-          },
           "price": {
             "type": "integer"
           },
@@ -7404,7 +7456,6 @@
         },
         "type": "object",
         "required": [
-          "id",
           "price",
           "amount"
         ]
@@ -7443,9 +7494,6 @@
       },
       "ItemMarketListingNonstackable": {
         "properties": {
-          "id": {
-            "type": "integer"
-          },
           "price": {
             "type": "integer"
           },
@@ -7458,7 +7506,6 @@
         },
         "type": "object",
         "required": [
-          "id",
           "price",
           "amount",
           "itemDetails"
@@ -8471,7 +8518,7 @@
                   }
                 },
                 "type": "object",
-                "nullable": "true",
+                "nullable": true,
                 "required": [
                   "id",
                   "name"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },