@lgriffin/esi.ts 1.0.0 → 2.0.0

package/src/builders/ContractsApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { ContractsClient } from '../clients/ContractsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class ContractsApiBuilder {
+export class ContractsApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/CorporationsApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { CorporationsClient } from '../clients/CorporationsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class CorporationsApiBuilder {
+export class CorporationsApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/DogmaApiBuilder.ts

@@ -1,8 +1,9 @@
 // src/builders/DogmaAPIBuilder.ts
 import { ApiClient } from '../core/ApiClient';
 import { DogmaClient } from '../clients/DogmaClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class DogmaAPIBuilder {
+export class DogmaAPIBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/FactionApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
-import { FactionClient } from '../clients/FactionClient'; 
+import { FactionClient } from '../clients/FactionClient';
+import { IAPIBuilder } from '../core/IAPIBuilder'; 
 
-export class FactionAPIBuilder {
+export class FactionAPIBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/FittingsApiBuilder.ts

@@ -1,9 +1,8 @@
-// src/builders/FittingsApiBuilder.ts
-
 import { ApiClient } from '../core/ApiClient';
 import { FittingsClient } from '../clients/FittingsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class FittingsApiBuilder {
+export class FittingsApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/FleetApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { FleetClient } from '../clients/FleetClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class FleetApiBuilder {
+export class FleetApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/IncursionsApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { IncursionsClient } from '../clients/IncursionsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class IncursionsApiBuilder {
+export class IncursionsApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/IndustryApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { IndustryClient } from '../clients/IndustryClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class IndustryApiBuilder {
+export class IndustryApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/InsuranceApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { InsuranceClient } from '../clients/InsuranceClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class InsuranceAPIBuilder {
+export class InsuranceAPIBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/KillmailsBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { KillmailsClient } from '../clients/KillmailsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class KillmailsApiBuilder {
+export class KillmailsApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/LocationApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { LocationClient } from '../clients/LocationClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class LocationApiBuilder {
+export class LocationApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/LoyaltyApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { LoyaltyClient } from '../clients/LoyaltyClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class LoyaltyApiBuilder {
+export class LoyaltyApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/MailApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { MailClient } from '../clients/MailClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class MailApiBuilder {
+export class MailApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/MarketApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { MarketClient } from '../clients/MarketClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class MarketApiBuilder {
+export class MarketApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/MetaApiBuilder.ts

@@ -0,0 +1,15 @@
+import { ApiClient } from '../core/ApiClient';
+import { MetaClient } from '../clients/MetaClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
+
+export class MetaApiBuilder implements IAPIBuilder<MetaClient> {
+    private client: ApiClient;
+
+    constructor(client: ApiClient) {
+        this.client = client;
+    }
+
+    public build(): MetaClient {
+        return new MetaClient(this.client);
+    }
+}

package/src/builders/OpportunitiesApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { OpportunitiesClient } from '../clients/OpportunitiesClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class OpportunitiesApiBuilder {
+export class OpportunitiesApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/PiApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { PIClient } from '../clients/PiClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class PiApiBuilder {
+export class PiApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/RouteApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { RouteClient } from '../clients/RouteClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class RouteApiBuilder {
+export class RouteApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/SearchApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { SearchClient } from '../clients/SearchClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class SearchApiBuilder {
+export class SearchApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/SkillsApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { CharacterSkillsClient } from '../clients/SkillsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class SkillsApiBuilder {
+export class SkillsApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/SovereigntyApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { SovereigntyClient } from '../clients/SovereigntyClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class SovereigntyApiBuilder {
+export class SovereigntyApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/StatusApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { StatusClient } from '../clients/StatusClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class StatusAPIBuilder {
+export class StatusAPIBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/UiApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { UIClient } from '../clients/UiClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class UiApiBuilder  {
+export class UiApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/UniverseApiBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { UniverseClient } from '../clients/UniverseClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class UniverseAPIBuilder {
+export class UniverseAPIBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/WalletApiBuilder.ts

@@ -1,8 +1,9 @@
 // src/builders/WalletApiBuilder.ts
 import { ApiClient } from '../core/ApiClient';
 import { WalletClient } from '../clients/WalletClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class WalletApiBuilder {
+export class WalletApiBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/builders/WarsAPIBuilder.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from '../core/ApiClient';
 import { WarsClient } from '../clients/WarsClient';
+import { IAPIBuilder } from '../core/IAPIBuilder';
 
-export class WarsAPIBuilder {
+export class WarsAPIBuilder implements IAPIBuilder {
     private client: ApiClient;
 
     constructor(client: ApiClient) {

package/src/clients/AllianceClient.ts

@@ -5,8 +5,17 @@ import { AllianceContactLabelsApi } from '../api/alliances/getAllianceContactLab
 import { AllianceCorporationsApi } from '../api/alliances/getAllianceCorporations';
 import { AllianceIconsApi } from '../api/alliances/getAllianceIcons';
 import { AllAlliancesApi } from '../api/alliances/getAlliances';
-
-export class AllianceClient {
+import { 
+    AllianceInfo, 
+    AllianceContact, 
+    AllianceContactLabel, 
+    AllianceIcon 
+} from '../types/api-responses';
+import { IApiService } from '../core/IAPIBuilder';
+
+export class AllianceClient implements IApiService {
+    readonly name = 'AllianceClient';
+    readonly version = '1.0.0';
     private allianceApi: AllianceByIdApi;
     private allianceContactsApi: AllianceContactsApi;
     private allianceContactLabelsApi: AllianceContactLabelsApi;
@@ -23,27 +32,27 @@ export class AllianceClient {
         this.allAlliancesApi = new AllAlliancesApi(client);
     }
 
-    async getAllianceById(allianceId: number): Promise<any> {
-        return await this.allianceApi.getAllianceById(allianceId);
+    async getAllianceById(allianceId: number): Promise<AllianceInfo> {
+        return await this.allianceApi.getAllianceById(allianceId) as AllianceInfo;
     }
 
-    async getContacts(allianceId: number): Promise<any> {
-        return await this.allianceContactsApi.getAllianceContacts(allianceId);
+    async getContacts(allianceId: number): Promise<AllianceContact[]> {
+        return await this.allianceContactsApi.getAllianceContacts(allianceId) as AllianceContact[];
     }
 
-    async getContactLabels(allianceId: number): Promise<any> {
-        return await this.allianceContactLabelsApi.getAllianceContactLabels(allianceId);
+    async getContactLabels(allianceId: number): Promise<AllianceContactLabel[]> {
+        return await this.allianceContactLabelsApi.getAllianceContactLabels(allianceId) as AllianceContactLabel[];
     }
 
-    async getCorporations(allianceId: number): Promise<any> {
-        return await this.allianceCorporationsApi.getAllianceCorporations(allianceId);
+    async getCorporations(allianceId: number): Promise<number[]> {
+        return await this.allianceCorporationsApi.getAllianceCorporations(allianceId) as number[];
     }
 
-    async getIcons(allianceId: number): Promise<any> {
-        return await this.allianceIconsApi.getAllianceIcons(allianceId);
+    async getIcons(allianceId: number): Promise<AllianceIcon> {
+        return await this.allianceIconsApi.getAllianceIcons(allianceId) as AllianceIcon;
     }
 
-    async getAlliances(): Promise<any> {
-        return await this.allAlliancesApi.getAllAlliances();
+    async getAlliances(): Promise<number[]> {
+        return await this.allAlliancesApi.getAllAlliances() as unknown as number[];
     }
 }

package/src/clients/ClonesClient.ts

@@ -1,14 +1,17 @@
 import { ApiClient } from '../core/ApiClient';
 import { GetClonesApi } from '../api/clones/getClones';
 import { GetImplantsApi } from '../api/clones/getImplants';
+import { PostJumpCloneActivationApi } from '../api/clones/postJumpCloneActivation';
 
 export class ClonesClient {
     private getClonesApi: GetClonesApi;
     private getImplantsApi: GetImplantsApi;
+    private postJumpCloneActivationApi: PostJumpCloneActivationApi;
 
     constructor(client: ApiClient) {
         this.getClonesApi = new GetClonesApi(client);
         this.getImplantsApi = new GetImplantsApi(client);
+        this.postJumpCloneActivationApi = new PostJumpCloneActivationApi(client);
     }
 
     async getClones(characterId: number): Promise<any> {
@@ -18,4 +21,8 @@ export class ClonesClient {
     async getImplants(characterId: number): Promise<any> {
         return await this.getImplantsApi.getImplants(characterId);
     }
+
+    async activateJumpClone(characterId: number, jumpCloneId: number): Promise<any> {
+        return await this.postJumpCloneActivationApi.activateJumpClone(characterId, jumpCloneId);
+    }
 }

package/src/clients/CorporationsClient.ts

@@ -21,6 +21,7 @@ import { GetCorporationStarbaseDetailApi } from '../api/corporations/getCorporat
 import { GetCorporationStructuresApi } from '../api/corporations/getCorporationStructures';
 import { GetCorporationTitlesApi } from '../api/corporations/getCorporationTitles';
 import { GetNpcCorporationsApi } from '../api/corporations/getNpcCorporations';
+import { GetCorporationProjectsApi } from '../api/corporations/getCorporationProjects';
 
 export class CorporationsClient {
     private getCorporationInfoApi: GetCorporationInfoApi;
@@ -45,6 +46,7 @@ export class CorporationsClient {
     private getCorporationStructuresApi: GetCorporationStructuresApi;
     private getCorporationTitlesApi: GetCorporationTitlesApi;
     private getNpcCorporationsApi: GetNpcCorporationsApi;
+    private getCorporationProjectsApi: GetCorporationProjectsApi;
 
     constructor(client: ApiClient) {
         this.getCorporationInfoApi = new GetCorporationInfoApi(client);
@@ -69,6 +71,7 @@ export class CorporationsClient {
         this.getCorporationStructuresApi = new GetCorporationStructuresApi(client);
         this.getCorporationTitlesApi = new GetCorporationTitlesApi(client);
         this.getNpcCorporationsApi = new GetNpcCorporationsApi(client);
+        this.getCorporationProjectsApi = new GetCorporationProjectsApi(client);
     }
 
     async getCorporationInfo(corporationId: number): Promise<any> {
@@ -158,4 +161,8 @@ export class CorporationsClient {
     async getNpcCorporations(): Promise<any> {
         return await this.getNpcCorporationsApi.getNpcCorporations();
     }
+
+    async getCorporationProjects(corporationId: number): Promise<any> {
+        return await this.getCorporationProjectsApi.getCorporationProjects(corporationId);
+    }
 }

package/src/clients/MetaClient.ts

@@ -0,0 +1,24 @@
+import { ApiClient } from '../core/ApiClient';
+import { GetSwaggerJsonApi } from '../api/meta/getSwaggerJson';
+import { GetSwaggerYamlApi } from '../api/meta/getSwaggerYaml';
+import { IApiService } from '../core/IAPIBuilder';
+
+export class MetaClient implements IApiService {
+    readonly name = 'MetaClient';
+    readonly version = '1.0.0';
+    private getSwaggerJsonApi: GetSwaggerJsonApi;
+    private getSwaggerYamlApi: GetSwaggerYamlApi;
+
+    constructor(client: ApiClient) {
+        this.getSwaggerJsonApi = new GetSwaggerJsonApi(client);
+        this.getSwaggerYamlApi = new GetSwaggerYamlApi(client);
+    }
+
+    async getSwaggerJson(): Promise<any> {
+        return await this.getSwaggerJsonApi.getSwaggerJson();
+    }
+
+    async getSwaggerYaml(): Promise<string> {
+        return await this.getSwaggerYamlApi.getSwaggerYaml();
+    }
+}

package/src/core/ApiRequestHandler.ts

@@ -1,7 +1,8 @@
 import { ApiClient } from './ApiClient';
 import { buildError } from '../core/util/error';
-import { logInfo, logWarn, logError } from '../core/logger/loggerUtil';
+import { logInfo, logWarn, logError, logDebug } from '../core/logger/loggerUtil';
 import HeadersUtil from '../core/util/headersUtil';
+import { ETagCacheManager } from './cache/ETagCacheManager';
 
 const statusHandlers: Record<number, string> = {
     201: 'Created',
@@ -20,6 +21,40 @@ const statusHandlers: Record<number, string> = {
     520: 'Internal server error, did the request terminate too soon?',
 };
 
+// Global ETag cache instance
+let etagCache: ETagCacheManager | null = null;
+
+export const initializeETagCache = (config?: any): ETagCacheManager => {
+    if (!etagCache) {
+        etagCache = new ETagCacheManager(config);
+    }
+    return etagCache;
+};
+
+export const getETagCache = (): ETagCacheManager | null => {
+    return etagCache;
+};
+
+export const resetETagCache = (): void => {
+    if (etagCache) {
+        etagCache.shutdown();
+    }
+    etagCache = null;
+};
+
+// Helper function for backward compatibility - returns just the body
+export const handleRequestBody = async (
+    client: ApiClient,
+    endpoint: string,
+    method: string,
+    body?: any,
+    requiresAuth: boolean = false,
+    useETag: boolean = true
+): Promise<any> => {
+    const response = await handleRequest(client, endpoint, method, body, requiresAuth, useETag);
+    return response.body || response; // Handle both new and old response formats
+};
+
 const fetchPageData = async (
     client: ApiClient,
     baseEndpoint: string,
@@ -58,7 +93,8 @@ export const handleRequest = async (
     endpoint: string,
     method: string,
     body?: any,
-    requiresAuth: boolean = false
+    requiresAuth: boolean = false,
+    useETag: boolean = true
 ): Promise<any> => {
     // Extract the base URL (without any pagination or extra query params)
     const [baseEndpoint] = endpoint.split('?');  // Get only the part before `?`
@@ -77,6 +113,15 @@ export const handleRequest = async (
         headers['Authorization'] = authHeader;
     }
 
+    // Add ETag support for GET requests
+    if (useETag && method === 'GET' && etagCache) {
+        const cachedETag = etagCache.getETag(url);
+        if (cachedETag) {
+            headers['If-None-Match'] = cachedETag;
+            logDebug(`Adding If-None-Match header: ${cachedETag}`);
+        }
+    }
+
     const options: RequestInit = {
         method,
         headers,
@@ -95,6 +140,21 @@ export const handleRequest = async (
             if (response.status === 204) {
                 logInfo(`${errorMessage} for endpoint: ${url}`);
                 return { headers: responseHeaders, body: { error: 'no content' } };
+            } else if (response.status === 304) {
+                // Not Modified - return cached data
+                if (useETag && etagCache) {
+                    const cachedEntry = etagCache.get(url);
+                    if (cachedEntry) {
+                        logInfo(`Cache hit (304) for endpoint: ${url}`);
+                        return { 
+                            headers: { ...cachedEntry.headers, ...responseHeaders }, 
+                            body: cachedEntry.data,
+                            fromCache: true 
+                        };
+                    }
+                }
+                logWarn(`${errorMessage} for endpoint: ${url} - no cached data available`);
+                return { headers: responseHeaders, body: { error: errorMessage.toLowerCase() } };
             } else {
                 logWarn(`${errorMessage} for endpoint: ${url}`);
                 return { headers: responseHeaders, body: { error: errorMessage.toLowerCase() } };
@@ -109,6 +169,12 @@ export const handleRequest = async (
         const data = await response.json();
         const totalPages = HeadersUtil.xPages;
 
+        // Cache the response if ETag is present and this is a GET request
+        if (useETag && method === 'GET' && etagCache && HeadersUtil.etag) {
+            etagCache.set(url, HeadersUtil.etag, data, responseHeaders);
+            logDebug(`Cached response for ${url} with ETag ${HeadersUtil.etag}`);
+        }
+
         // If there's only one page, return the data immediately
         if (totalPages <= 1) {
             return { headers: responseHeaders, body: data };
@@ -125,7 +191,15 @@ export const handleRequest = async (
         }
 
         // Merge all pages' data into one response
-        return { headers: responseHeaders, body: allData.flat() };  // Flatten the array if needed
+        const finalData = allData.flat();
+        
+        // Cache the complete paginated response if ETag is present
+        if (useETag && method === 'GET' && etagCache && HeadersUtil.etag) {
+            etagCache.set(url, HeadersUtil.etag, finalData, responseHeaders);
+            logDebug(`Cached paginated response for ${url} with ETag ${HeadersUtil.etag}`);
+        }
+        
+        return { headers: responseHeaders, body: finalData };  // Flatten the array if needed
     } catch (error) {
         if (error instanceof Error) {
             logError(`Unexpected error: ${error.message}`);

package/src/core/IAPIBuilder.ts

@@ -0,0 +1,13 @@
+export interface IAPIBuilder<T = any> {
+    build(): T;
+}
+
+export interface IApiClient {
+    getAuthorizationHeader(): string | undefined;
+    getLink(): string;
+}
+
+export interface IApiService {
+    readonly name: string;
+    readonly version: string;
+}