torn-client 0.1.0 → 0.1.2

package/README.md

@@ -1,7 +1,7 @@
 # Torn API Client
 
 
-[![API Compatibility](https://img.shields.io/badge/Torn%20API-3.0.0-62a03f)](https://www.torn.com/api.html)
+[![API Compatibility](https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fraw.githubusercontent.com%2Fneon0404%2Ftorn-client%2Fmain%2F.torn-api-version&search=.*&label=Torn%20API&color=62a03f)](https://www.torn.com/api.html)
 [![NPM Version](https://img.shields.io/npm/v/torn-client.svg)](https://www.npmjs.com/package/torn-client)
 [![License](https://img.shields.io/npm/l/torn-client?color=62a03f)](https://github.com/neon0404/torn-client/blob/main/LICENSE)
 [![PRs](https://img.shields.io/badge/PRs-welcome-blue)](https://github.com/neon0404/torn-client/pulls)
@@ -10,18 +10,19 @@ A TypeScript-first, auto-generated client for the [Torn City v2 API](https://www
 
 This client provides full type safety, built-in rate limiting and automatic multi-key balancing to simplify interactions with the Torn API
 
-> **⚠️ Warning**  
+> **⚠️ Warning**
+> 
 > The Torn v2 API is under active development and changes frequently  
-> This client is also a work in progress and may contain bugs
+> This client is also a work in progress, use with caution
 >
 > Some multi-selection endpoints like `/user` - are not yet fully tested and may behave unexpectedly
 
 
 ## Features
 
--   **Fully Typed**: Provides strong type safety and autocompletion for  all API methods and responses
+-   **Fully Typed**: Provides strong type safety and autocompletion for API methods and responses
 -   **Cross-Environment**: Works seamlessly in both Node.js and browser environments
--   **Zero Dependencies**: No external dependencies, ensuring a lightweight footprint and easy integration
+-   **Zero Runtime Dependencies**: No external dependencies, ensuring a lightweight footprint and easy integration
 -   **Multi-Key Management**: Automatically balances requests across multiple API keys using round-robin or random strategies
 -   **Built-in Rate Limiting**: Avoids hitting the API limit by auto-delaying requests
 -   **Robust Pagination**: Simple `.next()` and `.prev()` methods are always available on paginated API responses
@@ -44,7 +45,7 @@ You can also use `torn-client` directly in a browser without any build tools by
 
 ```html
 <script type="module">
-  import { TornAPI, TornApiError } from 'https://unpkg.com/torn-client/dist/index.mjs';
+  import { TornAPI } from 'https://unpkg.com/torn-client/dist/index.mjs';
 
   const client = new TornAPI({ apiKeys: ['YOUR_API_KEY'] });
 </script>
@@ -102,7 +103,7 @@ For information about Torn API endpoints and parameters, see the [official Torn
 ## Contributing
 
 Contributions, issues, and feature requests are welcome!  
-Please feel free to open an issue or submit a pull request on GitHub
+Feel free to open an issue or submit a pull request on GitHub  
 Please read [contributing guide](https://github.com/neon0404/torn-client/blob/main/CONTRIBUTING.md) first
 
 ## Contact

package/dist/index.d.mts

@@ -1,9 +1,13 @@
 /**
  * Defines the rate limit handling strategy for API requests
+ *
+ * @category Core
  */
 type RateLimitMode = "autoDelay" | "throwOnLimit" | "ignore";
 /**
  * Defines the algorithm for distributing requests across multiple API keys
+ *
+ * @category Core
  */
 type ApiKeyBalancing = "roundRobin" | "random";
 /**
@@ -14,6 +18,8 @@ type ApiKeyBalancing = "roundRobin" | "random";
  * @param path The API endpoint path (e.g., "/user/profile")
  * @param params The query parameters for the request
  * @returns A Promise that resolves to the response data of type T
+ *
+ * @category Core
  */
 type Requester = <T = unknown>(path: string, params: Record<string, unknown>) => Promise<T>;
 
@@ -23,6 +29,8 @@ type Requester = <T = unknown>(path: string, params: Record<string, unknown>) =>
  * The properties of the current page's data are directly accessible on instances of this class
  *
  * @template T The type of the data within the paginated response
+ *
+ * @category Core
  */
 declare class PaginatedResponse<T> {
     private readonly nextUrl;
@@ -3953,7 +3961,7 @@ declare class FactionEndpoint {
     withTerritoryWarId(territoryWarId: string | number): FactionTerritoryWarIdContext;
 }
 /**
- * Context class for Faction API endpoints that require a 'id'
+ * Context class for Faction API endpoints that require a "id"
  * @category Endpoints
  */
 declare class FactionIdContext {
@@ -4039,7 +4047,7 @@ declare class FactionIdContext {
     get(): Promise<Faction>;
 }
 /**
- * Context class for Faction API endpoints that require a 'chainId'
+ * Context class for Faction API endpoints that require a "chainId"
  * @category Endpoints
  */
 declare class FactionChainIdContext {
@@ -4055,7 +4063,7 @@ declare class FactionChainIdContext {
     }): Promise<FactionChainReportResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'crimeId'
+ * Context class for Faction API endpoints that require a "crimeId"
  * @category Endpoints
  */
 declare class FactionCrimeIdContext {
@@ -4071,7 +4079,7 @@ declare class FactionCrimeIdContext {
     }): Promise<FactionCrimeResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'raidWarId'
+ * Context class for Faction API endpoints that require a "raidWarId"
  * @category Endpoints
  */
 declare class FactionRaidWarIdContext {
@@ -4087,7 +4095,7 @@ declare class FactionRaidWarIdContext {
     }): Promise<FactionRaidWarReportResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'rankedWarId'
+ * Context class for Faction API endpoints that require a "rankedWarId"
  * @category Endpoints
  */
 declare class FactionRankedWarIdContext {
@@ -4103,7 +4111,7 @@ declare class FactionRankedWarIdContext {
     }): Promise<FactionRankedWarReportResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'territoryWarId'
+ * Context class for Faction API endpoints that require a "territoryWarId"
  * @category Endpoints
  */
 declare class FactionTerritoryWarIdContext {
@@ -4179,7 +4187,7 @@ declare class ForumEndpoint {
     withCategoryIds(categoryIds: string | number): ForumCategoryIdsContext;
 }
 /**
- * Context class for Forum API endpoints that require a 'threadId'
+ * Context class for Forum API endpoints that require a "threadId"
  * @category Endpoints
  */
 declare class ForumThreadIdContext {
@@ -4204,7 +4212,7 @@ declare class ForumThreadIdContext {
     }): Promise<ForumThreadResponse>;
 }
 /**
- * Context class for Forum API endpoints that require a 'categoryIds'
+ * Context class for Forum API endpoints that require a "categoryIds"
  * @category Endpoints
  */
 declare class ForumCategoryIdsContext {
@@ -4308,7 +4316,7 @@ declare class MarketEndpoint {
     withPropertyTypeId(propertyTypeId: string | number): MarketPropertyTypeIdContext;
 }
 /**
- * Context class for Market API endpoints that require a 'id'
+ * Context class for Market API endpoints that require a "id"
  * @category Endpoints
  */
 declare class MarketIdContext {
@@ -4333,7 +4341,7 @@ declare class MarketIdContext {
     }): Promise<PaginatedResponse<MarketItemMarketResponse> & MarketItemMarketResponse>;
 }
 /**
- * Context class for Market API endpoints that require a 'propertyTypeId'
+ * Context class for Market API endpoints that require a "propertyTypeId"
  * @category Endpoints
  */
 declare class MarketPropertyTypeIdContext {
@@ -4396,7 +4404,7 @@ declare class PropertyEndpoint {
     }): Promise<PropertyResponse>;
 }
 /**
- * Context class for Property API endpoints that require a 'id'
+ * Context class for Property API endpoints that require a "id"
  * @category Endpoints
  */
 declare class PropertyIdContext {
@@ -4487,7 +4495,7 @@ declare class RacingEndpoint {
     withTrackId(trackId: string | number): RacingTrackIdContext;
 }
 /**
- * Context class for Racing API endpoints that require a 'raceId'
+ * Context class for Racing API endpoints that require a "raceId"
  * @category Endpoints
  */
 declare class RacingRaceIdContext {
@@ -4503,7 +4511,7 @@ declare class RacingRaceIdContext {
     }): Promise<RacingRaceDetailsResponse>;
 }
 /**
- * Context class for Racing API endpoints that require a 'trackId'
+ * Context class for Racing API endpoints that require a "trackId"
  * @category Endpoints
  */
 declare class RacingTrackIdContext {
@@ -4694,7 +4702,7 @@ declare class TornEndpoint {
     withCrimeId(crimeId: string | number): TornCrimeIdContext;
 }
 /**
- * Context class for Torn API endpoints that require a 'ids'
+ * Context class for Torn API endpoints that require a "ids"
  * @category Endpoints
  */
 declare class TornIdsContext {
@@ -4711,7 +4719,7 @@ declare class TornIdsContext {
     }): Promise<TornItemsResponse>;
 }
 /**
- * Context class for Torn API endpoints that require a 'logCategoryId'
+ * Context class for Torn API endpoints that require a "logCategoryId"
  * @category Endpoints
  */
 declare class TornLogCategoryIdContext {
@@ -4727,7 +4735,7 @@ declare class TornLogCategoryIdContext {
     }): Promise<TornLogTypesResponse>;
 }
 /**
- * Context class for Torn API endpoints that require a 'crimeId'
+ * Context class for Torn API endpoints that require a "crimeId"
  * @category Endpoints
  */
 declare class TornCrimeIdContext {
@@ -5007,7 +5015,7 @@ declare class UserEndpoint {
     withCrimeId(crimeId: string | number): UserCrimeIdContext;
 }
 /**
- * Context class for User API endpoints that require a 'id'
+ * Context class for User API endpoints that require a "id"
  * @category Endpoints
  */
 declare class UserIdContext {
@@ -5080,7 +5088,7 @@ declare class UserIdContext {
     get(): Promise<User>;
 }
 /**
- * Context class for User API endpoints that require a 'crimeId'
+ * Context class for User API endpoints that require a "crimeId"
  * @category Endpoints
  */
 declare class UserCrimeIdContext {
@@ -5135,9 +5143,9 @@ interface TornAPIOptions extends Omit<RequestHandlerOptions, "apiKeys"> {
  * ## Example
  * ```
  * const client = new TornAPI({
- *   apiKeys: ['YOUR_API_KEY1', 'YOUR_API_KEY2'],
- *   comment: 'my-app',
- *   rateLimitMode: 'autoDelay',
+ *   apiKeys: ["YOUR_API_KEY1", "YOUR_API_KEY2"],
+ *   comment: "my-app",
+ *   rateLimitMode: "autoDelay",
  *   verbose: true,
  * });
  *

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 /**
  * Defines the rate limit handling strategy for API requests
+ *
+ * @category Core
  */
 type RateLimitMode = "autoDelay" | "throwOnLimit" | "ignore";
 /**
  * Defines the algorithm for distributing requests across multiple API keys
+ *
+ * @category Core
  */
 type ApiKeyBalancing = "roundRobin" | "random";
 /**
@@ -14,6 +18,8 @@ type ApiKeyBalancing = "roundRobin" | "random";
  * @param path The API endpoint path (e.g., "/user/profile")
  * @param params The query parameters for the request
  * @returns A Promise that resolves to the response data of type T
+ *
+ * @category Core
  */
 type Requester = <T = unknown>(path: string, params: Record<string, unknown>) => Promise<T>;
 
@@ -23,6 +29,8 @@ type Requester = <T = unknown>(path: string, params: Record<string, unknown>) =>
  * The properties of the current page's data are directly accessible on instances of this class
  *
  * @template T The type of the data within the paginated response
+ *
+ * @category Core
  */
 declare class PaginatedResponse<T> {
     private readonly nextUrl;
@@ -3953,7 +3961,7 @@ declare class FactionEndpoint {
     withTerritoryWarId(territoryWarId: string | number): FactionTerritoryWarIdContext;
 }
 /**
- * Context class for Faction API endpoints that require a 'id'
+ * Context class for Faction API endpoints that require a "id"
  * @category Endpoints
  */
 declare class FactionIdContext {
@@ -4039,7 +4047,7 @@ declare class FactionIdContext {
     get(): Promise<Faction>;
 }
 /**
- * Context class for Faction API endpoints that require a 'chainId'
+ * Context class for Faction API endpoints that require a "chainId"
  * @category Endpoints
  */
 declare class FactionChainIdContext {
@@ -4055,7 +4063,7 @@ declare class FactionChainIdContext {
     }): Promise<FactionChainReportResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'crimeId'
+ * Context class for Faction API endpoints that require a "crimeId"
  * @category Endpoints
  */
 declare class FactionCrimeIdContext {
@@ -4071,7 +4079,7 @@ declare class FactionCrimeIdContext {
     }): Promise<FactionCrimeResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'raidWarId'
+ * Context class for Faction API endpoints that require a "raidWarId"
  * @category Endpoints
  */
 declare class FactionRaidWarIdContext {
@@ -4087,7 +4095,7 @@ declare class FactionRaidWarIdContext {
     }): Promise<FactionRaidWarReportResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'rankedWarId'
+ * Context class for Faction API endpoints that require a "rankedWarId"
  * @category Endpoints
  */
 declare class FactionRankedWarIdContext {
@@ -4103,7 +4111,7 @@ declare class FactionRankedWarIdContext {
     }): Promise<FactionRankedWarReportResponse>;
 }
 /**
- * Context class for Faction API endpoints that require a 'territoryWarId'
+ * Context class for Faction API endpoints that require a "territoryWarId"
  * @category Endpoints
  */
 declare class FactionTerritoryWarIdContext {
@@ -4179,7 +4187,7 @@ declare class ForumEndpoint {
     withCategoryIds(categoryIds: string | number): ForumCategoryIdsContext;
 }
 /**
- * Context class for Forum API endpoints that require a 'threadId'
+ * Context class for Forum API endpoints that require a "threadId"
  * @category Endpoints
  */
 declare class ForumThreadIdContext {
@@ -4204,7 +4212,7 @@ declare class ForumThreadIdContext {
     }): Promise<ForumThreadResponse>;
 }
 /**
- * Context class for Forum API endpoints that require a 'categoryIds'
+ * Context class for Forum API endpoints that require a "categoryIds"
  * @category Endpoints
  */
 declare class ForumCategoryIdsContext {
@@ -4308,7 +4316,7 @@ declare class MarketEndpoint {
     withPropertyTypeId(propertyTypeId: string | number): MarketPropertyTypeIdContext;
 }
 /**
- * Context class for Market API endpoints that require a 'id'
+ * Context class for Market API endpoints that require a "id"
  * @category Endpoints
  */
 declare class MarketIdContext {
@@ -4333,7 +4341,7 @@ declare class MarketIdContext {
     }): Promise<PaginatedResponse<MarketItemMarketResponse> & MarketItemMarketResponse>;
 }
 /**
- * Context class for Market API endpoints that require a 'propertyTypeId'
+ * Context class for Market API endpoints that require a "propertyTypeId"
  * @category Endpoints
  */
 declare class MarketPropertyTypeIdContext {
@@ -4396,7 +4404,7 @@ declare class PropertyEndpoint {
     }): Promise<PropertyResponse>;
 }
 /**
- * Context class for Property API endpoints that require a 'id'
+ * Context class for Property API endpoints that require a "id"
  * @category Endpoints
  */
 declare class PropertyIdContext {
@@ -4487,7 +4495,7 @@ declare class RacingEndpoint {
     withTrackId(trackId: string | number): RacingTrackIdContext;
 }
 /**
- * Context class for Racing API endpoints that require a 'raceId'
+ * Context class for Racing API endpoints that require a "raceId"
  * @category Endpoints
  */
 declare class RacingRaceIdContext {
@@ -4503,7 +4511,7 @@ declare class RacingRaceIdContext {
     }): Promise<RacingRaceDetailsResponse>;
 }
 /**
- * Context class for Racing API endpoints that require a 'trackId'
+ * Context class for Racing API endpoints that require a "trackId"
  * @category Endpoints
  */
 declare class RacingTrackIdContext {
@@ -4694,7 +4702,7 @@ declare class TornEndpoint {
     withCrimeId(crimeId: string | number): TornCrimeIdContext;
 }
 /**
- * Context class for Torn API endpoints that require a 'ids'
+ * Context class for Torn API endpoints that require a "ids"
  * @category Endpoints
  */
 declare class TornIdsContext {
@@ -4711,7 +4719,7 @@ declare class TornIdsContext {
     }): Promise<TornItemsResponse>;
 }
 /**
- * Context class for Torn API endpoints that require a 'logCategoryId'
+ * Context class for Torn API endpoints that require a "logCategoryId"
  * @category Endpoints
  */
 declare class TornLogCategoryIdContext {
@@ -4727,7 +4735,7 @@ declare class TornLogCategoryIdContext {
     }): Promise<TornLogTypesResponse>;
 }
 /**
- * Context class for Torn API endpoints that require a 'crimeId'
+ * Context class for Torn API endpoints that require a "crimeId"
  * @category Endpoints
  */
 declare class TornCrimeIdContext {
@@ -5007,7 +5015,7 @@ declare class UserEndpoint {
     withCrimeId(crimeId: string | number): UserCrimeIdContext;
 }
 /**
- * Context class for User API endpoints that require a 'id'
+ * Context class for User API endpoints that require a "id"
  * @category Endpoints
  */
 declare class UserIdContext {
@@ -5080,7 +5088,7 @@ declare class UserIdContext {
     get(): Promise<User>;
 }
 /**
- * Context class for User API endpoints that require a 'crimeId'
+ * Context class for User API endpoints that require a "crimeId"
  * @category Endpoints
  */
 declare class UserCrimeIdContext {
@@ -5135,9 +5143,9 @@ interface TornAPIOptions extends Omit<RequestHandlerOptions, "apiKeys"> {
  * ## Example
  * ```
  * const client = new TornAPI({
- *   apiKeys: ['YOUR_API_KEY1', 'YOUR_API_KEY2'],
- *   comment: 'my-app',
- *   rateLimitMode: 'autoDelay',
+ *   apiKeys: ["YOUR_API_KEY1", "YOUR_API_KEY2"],
+ *   comment: "my-app",
+ *   rateLimitMode: "autoDelay",
  *   verbose: true,
  * });
  *