tornapi-typescript 4.6.0 → 5.0.0

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.
package/dist/index.d.ts CHANGED
@@ -360,6 +360,19 @@ export interface ReportsResponse {
360
360
  _metadata: RequestMetadataWithLinks;
361
361
  }
362
362
  export type SelectionCategoryEnum = ReportTypeEnum | UserListEnum | PersonalStatsCategoryEnum | RacingRaceTypeEnum;
363
+ export type UserEquipment = TornItemDetails & {
364
+ slot: number;
365
+ };
366
+ export interface UserClothing {
367
+ id: ItemId;
368
+ name: string;
369
+ uid: ItemUid;
370
+ type: TornItemTypeEnum;
371
+ }
372
+ export interface UserEquipmentResponse {
373
+ equipment: UserEquipment[];
374
+ clothing: UserClothing[];
375
+ }
363
376
  export interface UserDiscordResponse {
364
377
  discord: {
365
378
  discord_id: DiscordId;
@@ -464,10 +477,6 @@ export interface UserCooldownsResponse {
464
477
  export interface UserBar {
465
478
  current: number;
466
479
  maximum: number;
467
- increment: number;
468
- interval: number;
469
- tick_time: number;
470
- full_time: number;
471
480
  }
472
481
  export interface UserBars {
473
482
  energy: UserBar;
@@ -1093,7 +1102,7 @@ export interface UserListResponse {
1093
1102
  list: UserList[];
1094
1103
  _metadata: RequestMetadataWithLinks;
1095
1104
  }
1096
- /** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','equipment','gym','inventory','networth','perks','stocks'. */
1105
+ /** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','inventory','networth','perks','stocks'. */
1097
1106
  export type UserSelectionName = string;
1098
1107
  export interface UserLookupResponse {
1099
1108
  selections: UserSelectionName[];
@@ -1998,8 +2007,6 @@ export interface UserStatus {
1998
2007
  state: UserStatusStateEnum | string;
1999
2008
  color: string;
2000
2009
  until: number | null;
2001
- /** This field is replaced by the 'plane_image_type' field and will be removed on October 1st 2025. */
2002
- travel_type?: string;
2003
2010
  plane_image_type?: UserPlaneImageTypeEnum;
2004
2011
  }
2005
2012
  export interface FactionMembersResponse {
@@ -2793,6 +2800,15 @@ export type PropertySelectionName = string;
2793
2800
  export interface PropertyLookupResponse {
2794
2801
  selections: PropertySelectionName[];
2795
2802
  }
2803
+ export interface TornItemDetails extends ItemMarketListingItemDetails {
2804
+ id: ItemId;
2805
+ name: string;
2806
+ type: TornItemTypeEnum;
2807
+ sub_type: TornItemWeaponTypeEnum | null;
2808
+ }
2809
+ export interface TornItemDetailsResponse {
2810
+ itemdetails: TornItemDetails;
2811
+ }
2796
2812
  export interface TornMerit {
2797
2813
  id: MeritId;
2798
2814
  name: string;
@@ -6496,6 +6512,10 @@ export interface UserV2 extends BaseSchema {
6496
6512
  response: UserEnlistedCarsResponse;
6497
6513
  params: "timestamp";
6498
6514
  };
6515
+ equipment: {
6516
+ response: UserEquipmentResponse;
6517
+ params: "timestamp";
6518
+ };
6499
6519
  events: {
6500
6520
  response: UserEventsResponse;
6501
6521
  params: "striptags" | "limit" | "from" | "to" | "timestamp";
@@ -6504,10 +6524,6 @@ export interface UserV2 extends BaseSchema {
6504
6524
  response: UserFactionResponse;
6505
6525
  params: "timestamp";
6506
6526
  };
6507
- factionbalance: {
6508
- response: UserFactionBalanceResponse;
6509
- params: "timestamp";
6510
- };
6511
6527
  forumfeed: {
6512
6528
  response: UserForumFeedResponse;
6513
6529
  params: "timestamp";
@@ -6972,6 +6988,10 @@ export interface TornV2 extends BaseSchema {
6972
6988
  response: TornItemAmmoResponse;
6973
6989
  params: "timestamp";
6974
6990
  };
6991
+ itemdetails: {
6992
+ response: TornItemDetailsResponse;
6993
+ params: "timestamp";
6994
+ };
6975
6995
  itemmods: {
6976
6996
  response: TornItemModsResponse;
6977
6997
  params: "timestamp";
package/dist/index.ts CHANGED
@@ -5323,6 +5323,22 @@ export type SelectionCategoryEnum =
5323
5323
  | PersonalStatsCategoryEnum
5324
5324
  | RacingRaceTypeEnum;
5325
5325
 
5326
+ export type UserEquipment = TornItemDetails & {
5327
+ slot: number;
5328
+ };
5329
+
5330
+ export interface UserClothing {
5331
+ id: ItemId;
5332
+ name: string;
5333
+ uid: ItemUid;
5334
+ type: TornItemTypeEnum;
5335
+ }
5336
+
5337
+ export interface UserEquipmentResponse {
5338
+ equipment: UserEquipment[];
5339
+ clothing: UserClothing[];
5340
+ }
5341
+
5326
5342
  export interface UserDiscordResponse {
5327
5343
  discord: {
5328
5344
  discord_id: DiscordId;
@@ -5443,10 +5459,6 @@ export interface UserCooldownsResponse {
5443
5459
  export interface UserBar {
5444
5460
  current: number;
5445
5461
  maximum: number;
5446
- increment: number;
5447
- interval: number;
5448
- tick_time: number;
5449
- full_time: number;
5450
5462
  }
5451
5463
 
5452
5464
  export interface UserBars {
@@ -5784,8 +5796,7 @@ export interface UserPropertyDetailsExtended extends UserPropertyBasicDetails {
5784
5796
  status: "none" | "in_use";
5785
5797
  }
5786
5798
 
5787
- export interface UserPropertyDetailsExtendedWithRent
5788
- extends UserPropertyBasicDetails {
5799
+ export interface UserPropertyDetailsExtendedWithRent extends UserPropertyBasicDetails {
5789
5800
  used_by: BasicUser[];
5790
5801
  status: "none" | "in_use";
5791
5802
  rented_by?: BasicUser;
@@ -5795,8 +5806,7 @@ export interface UserPropertyDetails extends UserPropertyBasicDetails {
5795
5806
  used_by: BasicUser[];
5796
5807
  }
5797
5808
 
5798
- export interface UserPropertyDetailsExtendedRented
5799
- extends UserPropertyBasicDetails {
5809
+ export interface UserPropertyDetailsExtendedRented extends UserPropertyBasicDetails {
5800
5810
  used_by: BasicUser[];
5801
5811
  status: "rented";
5802
5812
  cost: number;
@@ -5811,8 +5821,7 @@ export interface UserPropertyDetailsExtendedRented
5811
5821
  } | null;
5812
5822
  }
5813
5823
 
5814
- export interface UserPropertyDetailsExtendedForRent
5815
- extends UserPropertyBasicDetails {
5824
+ export interface UserPropertyDetailsExtendedForRent extends UserPropertyBasicDetails {
5816
5825
  used_by: BasicUser[];
5817
5826
  status: "for_rent";
5818
5827
  cost: number;
@@ -5821,8 +5830,7 @@ export interface UserPropertyDetailsExtendedForRent
5821
5830
  renter_asked?: BasicUser;
5822
5831
  }
5823
5832
 
5824
- export interface UserPropertyDetailsExtendedForSale
5825
- extends UserPropertyBasicDetails {
5833
+ export interface UserPropertyDetailsExtendedForSale extends UserPropertyBasicDetails {
5826
5834
  used_by: BasicUser[];
5827
5835
  status: "for_sale";
5828
5836
  cost: number;
@@ -6197,7 +6205,7 @@ export interface UserListResponse {
6197
6205
  _metadata: RequestMetadataWithLinks;
6198
6206
  }
6199
6207
 
6200
- /** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','equipment','gym','inventory','networth','perks','stocks'. */
6208
+ /** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','inventory','networth','perks','stocks'. */
6201
6209
  export type UserSelectionName = string;
6202
6210
 
6203
6211
  export interface UserLookupResponse {
@@ -7497,8 +7505,6 @@ export interface UserStatus {
7497
7505
  state: UserStatusStateEnum | string;
7498
7506
  color: string;
7499
7507
  until: number | null;
7500
- /** This field is replaced by the 'plane_image_type' field and will be removed on October 1st 2025. */
7501
- travel_type?: string;
7502
7508
  plane_image_type?: UserPlaneImageTypeEnum;
7503
7509
  }
7504
7510
 
@@ -8413,6 +8419,17 @@ export interface PropertyLookupResponse {
8413
8419
  selections: PropertySelectionName[];
8414
8420
  }
8415
8421
 
8422
+ export interface TornItemDetails extends ItemMarketListingItemDetails {
8423
+ id: ItemId;
8424
+ name: string;
8425
+ type: TornItemTypeEnum;
8426
+ sub_type: TornItemWeaponTypeEnum | null;
8427
+ }
8428
+
8429
+ export interface TornItemDetailsResponse {
8430
+ itemdetails: TornItemDetails;
8431
+ }
8432
+
8416
8433
  export interface TornMerit {
8417
8434
  id: MeritId;
8418
8435
  name: string;
@@ -8690,7 +8707,7 @@ export interface Bounty {
8690
8707
  export interface AttackLogSummary {
8691
8708
  id: UserId | null;
8692
8709
  name: /** Name of the participant, could be null in stealthed attacks. */
8693
- string | null;
8710
+ string | null;
8694
8711
  hits: number;
8695
8712
  misses: number;
8696
8713
  damage: number;
@@ -12239,6 +12256,10 @@ export interface UserV2 extends BaseSchema {
12239
12256
  response: UserEnlistedCarsResponse;
12240
12257
  params: "timestamp";
12241
12258
  };
12259
+ equipment: {
12260
+ response: UserEquipmentResponse;
12261
+ params: "timestamp";
12262
+ };
12242
12263
  events: {
12243
12264
  response: UserEventsResponse;
12244
12265
  params: "striptags" | "limit" | "from" | "to" | "timestamp";
@@ -12247,10 +12268,6 @@ export interface UserV2 extends BaseSchema {
12247
12268
  response: UserFactionResponse;
12248
12269
  params: "timestamp";
12249
12270
  };
12250
- factionbalance: {
12251
- response: UserFactionBalanceResponse;
12252
- params: "timestamp";
12253
- };
12254
12271
  forumfeed: {
12255
12272
  response: UserForumFeedResponse;
12256
12273
  params: "timestamp";
@@ -12793,6 +12810,10 @@ export interface TornV2 extends BaseSchema {
12793
12810
  response: TornItemAmmoResponse;
12794
12811
  params: "timestamp";
12795
12812
  };
12813
+ itemdetails: {
12814
+ response: TornItemDetailsResponse;
12815
+ params: "timestamp";
12816
+ };
12796
12817
  itemmods: {
12797
12818
  response: TornItemModsResponse;
12798
12819
  params: "timestamp";
package/dist/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Torn API",
5
5
  "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.",
6
- "version": "4.6.0"
6
+ "version": "5.0.0"
7
7
  },
8
8
  "servers": [
9
9
  {
@@ -795,6 +795,45 @@
795
795
  "x-stability": "Stable"
796
796
  }
797
797
  },
798
+ "/user/equipment": {
799
+ "get": {
800
+ "tags": [
801
+ "User"
802
+ ],
803
+ "summary": "Get your equipment & clothing",
804
+ "description": "Requires minimal access key.",
805
+ "operationId": "273c3a96077332793a1b6ffe21c10218",
806
+ "parameters": [
807
+ {
808
+ "$ref": "#/components/parameters/ApiTimestamp"
809
+ },
810
+ {
811
+ "$ref": "#/components/parameters/ApiComment"
812
+ },
813
+ {
814
+ "$ref": "#/components/parameters/ApiKeyMinimal"
815
+ }
816
+ ],
817
+ "responses": {
818
+ "200": {
819
+ "description": "Successful operation",
820
+ "content": {
821
+ "application/json": {
822
+ "schema": {
823
+ "$ref": "#/components/schemas/UserEquipmentResponse"
824
+ }
825
+ }
826
+ }
827
+ }
828
+ },
829
+ "security": [
830
+ {
831
+ "api_key": []
832
+ }
833
+ ],
834
+ "x-stability": "Unstable"
835
+ }
836
+ },
798
837
  "/user/events": {
799
838
  "get": {
800
839
  "tags": [
@@ -933,46 +972,6 @@
933
972
  "x-stability": "Stable"
934
973
  }
935
974
  },
936
- "/user/factionbalance": {
937
- "get": {
938
- "tags": [
939
- "User"
940
- ],
941
- "summary": "Deprecated. Use user/money instead",
942
- "description": "Will be removed on 1st of December 2025. Requires limited access key. <br>",
943
- "operationId": "b7ebbeea51dc2ef56c3ed5fd9d94e680",
944
- "parameters": [
945
- {
946
- "$ref": "#/components/parameters/ApiTimestamp"
947
- },
948
- {
949
- "$ref": "#/components/parameters/ApiComment"
950
- },
951
- {
952
- "$ref": "#/components/parameters/ApiKeyLimited"
953
- }
954
- ],
955
- "responses": {
956
- "200": {
957
- "description": "Successful operation",
958
- "content": {
959
- "application/json": {
960
- "schema": {
961
- "$ref": "#/components/schemas/UserFactionBalanceResponse"
962
- }
963
- }
964
- }
965
- }
966
- },
967
- "deprecated": true,
968
- "security": [
969
- {
970
- "api_key": []
971
- }
972
- ],
973
- "x-stability": "Deprecated"
974
- }
975
- },
976
975
  "/user/forumfeed": {
977
976
  "get": {
978
977
  "tags": [
@@ -8358,6 +8357,45 @@
8358
8357
  "x-stability": "Stable"
8359
8358
  }
8360
8359
  },
8360
+ "/torn/itemdetails": {
8361
+ "get": {
8362
+ "tags": [
8363
+ "Torn"
8364
+ ],
8365
+ "summary": "Get information about a specific item",
8366
+ "description": "Requires public key.",
8367
+ "operationId": "5767dbbbd08f6ce35b7c10922afaf6fc",
8368
+ "parameters": [
8369
+ {
8370
+ "$ref": "#/components/parameters/ApiTimestamp"
8371
+ },
8372
+ {
8373
+ "$ref": "#/components/parameters/ApiComment"
8374
+ },
8375
+ {
8376
+ "$ref": "#/components/parameters/ApiKeyPublic"
8377
+ }
8378
+ ],
8379
+ "responses": {
8380
+ "200": {
8381
+ "description": "Successful operation",
8382
+ "content": {
8383
+ "application/json": {
8384
+ "schema": {
8385
+ "$ref": "#/components/schemas/TornItemDetailsResponse"
8386
+ }
8387
+ }
8388
+ }
8389
+ }
8390
+ },
8391
+ "security": [
8392
+ {
8393
+ "api_key": []
8394
+ }
8395
+ ],
8396
+ "x-stability": "Unstable"
8397
+ }
8398
+ },
8361
8399
  "/torn/itemmods": {
8362
8400
  "get": {
8363
8401
  "tags": [
@@ -13753,7 +13791,6 @@
13753
13791
  "Newsletter Sending",
13754
13792
  "Announcement Changes",
13755
13793
  "Description Changes",
13756
- "Organised Crimes",
13757
13794
  "Utility Item Loaning",
13758
13795
  "Consumable Item Usage"
13759
13796
  ]
@@ -15813,6 +15850,69 @@
15813
15850
  }
15814
15851
  ]
15815
15852
  },
15853
+ "UserEquipment": {
15854
+ "allOf": [
15855
+ {
15856
+ "$ref": "#/components/schemas/TornItemDetails"
15857
+ },
15858
+ {
15859
+ "required": [
15860
+ "slot"
15861
+ ],
15862
+ "properties": {
15863
+ "slot": {
15864
+ "type": "integer",
15865
+ "format": "int32"
15866
+ }
15867
+ },
15868
+ "type": "object"
15869
+ }
15870
+ ]
15871
+ },
15872
+ "UserClothing": {
15873
+ "required": [
15874
+ "id",
15875
+ "name",
15876
+ "uid",
15877
+ "type"
15878
+ ],
15879
+ "properties": {
15880
+ "id": {
15881
+ "$ref": "#/components/schemas/ItemId"
15882
+ },
15883
+ "name": {
15884
+ "type": "string"
15885
+ },
15886
+ "uid": {
15887
+ "$ref": "#/components/schemas/ItemUid"
15888
+ },
15889
+ "type": {
15890
+ "$ref": "#/components/schemas/TornItemTypeEnum"
15891
+ }
15892
+ },
15893
+ "type": "object"
15894
+ },
15895
+ "UserEquipmentResponse": {
15896
+ "required": [
15897
+ "equipment",
15898
+ "clothing"
15899
+ ],
15900
+ "properties": {
15901
+ "equipment": {
15902
+ "type": "array",
15903
+ "items": {
15904
+ "$ref": "#/components/schemas/UserEquipment"
15905
+ }
15906
+ },
15907
+ "clothing": {
15908
+ "type": "array",
15909
+ "items": {
15910
+ "$ref": "#/components/schemas/UserClothing"
15911
+ }
15912
+ }
15913
+ },
15914
+ "type": "object"
15915
+ },
15816
15916
  "UserDiscordResponse": {
15817
15917
  "required": [
15818
15918
  "discord"
@@ -16321,11 +16421,7 @@
16321
16421
  "UserBar": {
16322
16422
  "required": [
16323
16423
  "current",
16324
- "maximum",
16325
- "increment",
16326
- "interval",
16327
- "tick_time",
16328
- "full_time"
16424
+ "maximum"
16329
16425
  ],
16330
16426
  "properties": {
16331
16427
  "current": {
@@ -16335,22 +16431,6 @@
16335
16431
  "maximum": {
16336
16432
  "type": "integer",
16337
16433
  "format": "int32"
16338
- },
16339
- "increment": {
16340
- "type": "integer",
16341
- "format": "int32"
16342
- },
16343
- "interval": {
16344
- "type": "integer",
16345
- "format": "int32"
16346
- },
16347
- "tick_time": {
16348
- "type": "integer",
16349
- "format": "int32"
16350
- },
16351
- "full_time": {
16352
- "type": "integer",
16353
- "format": "int32"
16354
16434
  }
16355
16435
  },
16356
16436
  "type": "object"
@@ -19374,7 +19454,7 @@
19374
19454
  "UserSelectionName": {
19375
19455
  "oneOf": [
19376
19456
  {
19377
- "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','equipment','gym','inventory','networth','perks','stocks'.",
19457
+ "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','inventory','networth','perks','stocks'.",
19378
19458
  "type": "string",
19379
19459
  "enum": [
19380
19460
  "ammo",
@@ -19390,6 +19470,7 @@
19390
19470
  "crimes",
19391
19471
  "discord",
19392
19472
  "enlistedcars",
19473
+ "equipment",
19393
19474
  "events",
19394
19475
  "faction",
19395
19476
  "factionbalance",
@@ -19436,7 +19517,6 @@
19436
19517
  "criminalrecord",
19437
19518
  "display",
19438
19519
  "education",
19439
- "equipment",
19440
19520
  "gym",
19441
19521
  "inventory",
19442
19522
  "networth",
@@ -23926,11 +24006,6 @@
23926
24006
  }
23927
24007
  ]
23928
24008
  },
23929
- "travel_type": {
23930
- "description": "This field is replaced by the 'plane_image_type' field and will be removed on October 1st 2025.",
23931
- "type": "string",
23932
- "deprecated": true
23933
- },
23934
24009
  "plane_image_type": {
23935
24010
  "$ref": "#/components/schemas/UserPlaneImageTypeEnum",
23936
24011
  "description": "This field is populated only if the state is 'Traveling'."
@@ -27871,6 +27946,54 @@
27871
27946
  },
27872
27947
  "type": "object"
27873
27948
  },
27949
+ "TornItemDetails": {
27950
+ "allOf": [
27951
+ {
27952
+ "$ref": "#/components/schemas/ItemMarketListingItemDetails"
27953
+ },
27954
+ {
27955
+ "required": [
27956
+ "id",
27957
+ "name",
27958
+ "type",
27959
+ "sub_type"
27960
+ ],
27961
+ "properties": {
27962
+ "id": {
27963
+ "$ref": "#/components/schemas/ItemId"
27964
+ },
27965
+ "name": {
27966
+ "type": "string"
27967
+ },
27968
+ "type": {
27969
+ "$ref": "#/components/schemas/TornItemTypeEnum"
27970
+ },
27971
+ "sub_type": {
27972
+ "oneOf": [
27973
+ {
27974
+ "$ref": "#/components/schemas/TornItemWeaponTypeEnum"
27975
+ },
27976
+ {
27977
+ "type": "null"
27978
+ }
27979
+ ]
27980
+ }
27981
+ },
27982
+ "type": "object"
27983
+ }
27984
+ ]
27985
+ },
27986
+ "TornItemDetailsResponse": {
27987
+ "required": [
27988
+ "itemdetails"
27989
+ ],
27990
+ "properties": {
27991
+ "itemdetails": {
27992
+ "$ref": "#/components/schemas/TornItemDetails"
27993
+ }
27994
+ },
27995
+ "type": "object"
27996
+ },
27874
27997
  "TornMerit": {
27875
27998
  "required": [
27876
27999
  "id",
package/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "name": "tornapi-typescript",
3
3
  "type": "module",
4
- "version": "4.6.0",
4
+ "version": "5.0.0",
5
5
  "scripts": {
6
6
  "generate-types": "tsc && node build/index.js"
7
7
  },
8
8
  "devDependencies": {
9
9
  "@scalar/openapi-types": "^0.5.1",
10
10
  "@types/node": "^24.10.1",
11
- "prettier": "^3.6.2",
11
+ "prettier": "^3.7.3",
12
12
  "typeconv": "^2.3.1",
13
13
  "typescript": "^5.9.3"
14
14
  },