@lgriffin/esi.ts 7.4.0 → 9.0.0

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@lgriffin/esi.ts",
-  "version": "7.4.0",
+  "version": "9.0.0",
   "description": "This is a TypeScript Implementation for the EVE Online API offered through ESI",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "type": "commonjs",
   "engines": {
@@ -14,8 +15,24 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
       "require": "./dist/index.js"
     },
+    "./schemas": {
+      "types": "./dist/schemas/index.d.ts",
+      "import": "./dist/schemas/index.mjs",
+      "require": "./dist/schemas/index.js"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "import": "./dist/errors.mjs",
+      "require": "./dist/errors.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "import": "./dist/testing/index.mjs",
+      "require": "./dist/testing/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -25,7 +42,8 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsup && tsc --emitDeclarationOnly",
+    "typecheck": "tsc --noEmit",
     "start": "ts-node examples/character-profile.ts",
     "example": "ts-node examples/character-profile.ts",
     "example:status": "ts-node examples/status.ts",
@@ -111,6 +129,7 @@
     "bdd:mercenary": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/mercenary",
     "bdd:access-lists": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/access-lists",
     "bdd:status": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/status",
+    "bdd:resilience": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/resilience",
     "bdd:ui": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/ui",
     "bdd:universe": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/universe",
     "bdd:wallet": "jest --config jest.unit.config.cjs --testPathPatterns=step-definitions/core/wallet",
@@ -132,8 +151,12 @@
     "mock:esi": "prism mock https://esi.evetech.net/meta/openapi.json -p 4010",
     "test:types": "tsd --files 'tests/typetests/*.test-d.ts'",
     "generate:types": "ts-node scripts/generate-esi-types.ts",
+    "generate:okf": "ts-node scripts/generate-okf.ts",
+    "generate:endpoints": "ts-node scripts/generate-endpoint-scaffold.ts",
+    "generate:all": "npm run generate:types && npm run generate:okf && npm run contract:snapshot && npm run schema:drift && npm run validate:esi",
     "knip": "knip",
     "validate:esi": "ts-node scripts/validate-esi-endpoints.ts",
+    "validate:auth-scopes": "ts-node scripts/validate-auth-scopes.ts",
     "validate:spec": "redocly lint",
     "validate": "npm run lint && npm run format:check && npm run build && npm run coverage && knip --no-exit-code",
     "validate:versions": "ts-node scripts/validate-versions.ts",
@@ -211,16 +234,20 @@
     "ts-jest": "^29.4.11",
     "ts-node": "^10.9.2",
     "tsd": "^0.33.0",
+    "tsup": "^8.5.1",
     "typedoc": "^0.28.18",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.64.0"
+    "typescript-eslint": "^8.64.0",
+    "zod": "^4.4.3"
   },
   "dependencies": {
-    "winston": "^3.13.0",
-    "zod": "^4.4.3"
+    "pino": "^9.6.0",
+    "zod": "^4.0.0"
   },
   "overrides": {
     "lodash": "4.18.1",
-    "fast-xml-parser": ">=5.7.0"
+    "fast-xml-parser": ">=5.7.0",
+    "qs": ">=6.15.2",
+    "brace-expansion": ">=5.0.8"
   }
 }

package/dist/EsiClient.js

@@ -1,251 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EsiClient = void 0;
-exports.getDefaultClient = getDefaultClient;
-const ApiClient_1 = require("./core/ApiClient");
-const ClientRegistry_1 = require("./core/ClientRegistry");
-const validation_1 = require("./core/util/validation");
-const ETagCacheManager_1 = require("./core/cache/ETagCacheManager");
-const CircuitBreaker_1 = require("./core/circuitBreaker/CircuitBreaker");
-const RateLimiter_1 = require("./core/rateLimiter/RateLimiter");
-const RequestDeduplicator_1 = require("./core/RequestDeduplicator");
-const EsiDiagnostics_1 = require("./core/EsiDiagnostics");
-const BatchRequestHandler_1 = require("./core/BatchRequestHandler");
-const logger_1 = __importDefault(require("./core/logger/logger"));
-class EsiClient {
-    apiClient;
-    clients = new Map();
-    etagCacheEnabled;
-    _diagnostics = null;
-    deduplicator = null;
-    constructor(config) {
-        const token = config?.accessToken || process.env.ESI_ACCESS_TOKEN;
-        const baseUrl = (0, validation_1.validateBaseUrl)(config?.baseUrl || process.env.ESI_BASE_URL || 'https://esi.evetech.net', config?.unsafeAllowCustomHost);
-        this.apiClient = new ApiClient_1.ApiClient(config?.clientId || process.env.ESI_CLIENT_ID || 'esi-client', baseUrl, token);
-        const datasource = config?.datasource ||
-            process.env.ESI_DATASOURCE;
-        if (datasource) {
-            this.apiClient.setDatasource(datasource);
-        }
-        if (config?.language) {
-            this.apiClient.setLanguage(config.language);
-        }
-        if (config?.timeout !== undefined) {
-            this.apiClient.setTimeout(config.timeout);
-        }
-        if (config?.onTokenRefresh) {
-            this.apiClient.setTokenProvider(config.onTokenRefresh);
-        }
-        this.apiClient.setRateLimiter(new RateLimiter_1.RateLimiter(config?.rateLimiterConfig));
-        if (config?.enableRequestDeduplication !== false) {
-            this.deduplicator = new RequestDeduplicator_1.RequestDeduplicator();
-            this.apiClient.setDeduplicator(this.deduplicator);
-        }
-        this.etagCacheEnabled = config?.enableETagCache !== false;
-        if (this.etagCacheEnabled) {
-            this.apiClient.setCache(new ETagCacheManager_1.ETagCacheManager(config?.etagCacheConfig));
-        }
-        if (config?.enableCircuitBreaker) {
-            this.apiClient.setCircuitBreaker(new CircuitBreaker_1.CircuitBreaker(config.circuitBreakerConfig));
-        }
-        if (config?.retryConfig) {
-            this.apiClient.setRetryConfig(config.retryConfig);
-        }
-        else if (config?.retryAttempts !== undefined) {
-            this.apiClient.setRetryConfig({ maxRetries: config.retryAttempts });
-        }
-        if (config?.requestInterceptors) {
-            for (const interceptor of config.requestInterceptors) {
-                this.apiClient.addRequestInterceptor(interceptor);
-            }
-        }
-        if (config?.responseInterceptors) {
-            for (const interceptor of config.responseInterceptors) {
-                this.apiClient.addResponseInterceptor(interceptor);
-            }
-        }
-        if (config?.validateResponse !== undefined) {
-            this.apiClient.setValidateResponse(config.validateResponse);
-        }
-        logger_1.default.info('EsiClient initialized successfully');
-    }
-    getClient(name) {
-        if (!this.clients.has(name)) {
-            this.clients.set(name, (0, ClientRegistry_1.createClientInstance)(name, this.apiClient));
-        }
-        return this.clients.get(name);
-    }
-    // Domain client accessors
-    get alliance() {
-        return this.getClient('alliance');
-    }
-    get assets() {
-        return this.getClient('assets');
-    }
-    get calendar() {
-        return this.getClient('calendar');
-    }
-    get characters() {
-        return this.getClient('characters');
-    }
-    get clones() {
-        return this.getClient('clones');
-    }
-    get contacts() {
-        return this.getClient('contacts');
-    }
-    get contracts() {
-        return this.getClient('contracts');
-    }
-    get corporations() {
-        return this.getClient('corporations');
-    }
-    get dogma() {
-        return this.getClient('dogma');
-    }
-    get factions() {
-        return this.getClient('factions');
-    }
-    get fittings() {
-        return this.getClient('fittings');
-    }
-    get fleets() {
-        return this.getClient('fleets');
-    }
-    get incursions() {
-        return this.getClient('incursions');
-    }
-    get industry() {
-        return this.getClient('industry');
-    }
-    get insurance() {
-        return this.getClient('insurance');
-    }
-    get killmails() {
-        return this.getClient('killmails');
-    }
-    get location() {
-        return this.getClient('location');
-    }
-    get loyalty() {
-        return this.getClient('loyalty');
-    }
-    get mail() {
-        return this.getClient('mail');
-    }
-    get market() {
-        return this.getClient('market');
-    }
-    get pi() {
-        return this.getClient('pi');
-    }
-    get route() {
-        return this.getClient('route');
-    }
-    get search() {
-        return this.getClient('search');
-    }
-    get skills() {
-        return this.getClient('skills');
-    }
-    get sovereignty() {
-        return this.getClient('sovereignty');
-    }
-    get status() {
-        return this.getClient('status');
-    }
-    get ui() {
-        return this.getClient('ui');
-    }
-    get universe() {
-        return this.getClient('universe');
-    }
-    get wallet() {
-        return this.getClient('wallet');
-    }
-    get wars() {
-        return this.getClient('wars');
-    }
-    get meta() {
-        return this.getClient('meta');
-    }
-    get freelanceJobs() {
-        return this.getClient('freelanceJobs');
-    }
-    get skyhooks() {
-        return this.getClient('skyhooks');
-    }
-    get mercenary() {
-        return this.getClient('mercenary');
-    }
-    get accessLists() {
-        return this.getClient('accessLists');
-    }
-    addRequestInterceptor(fn) {
-        return this.apiClient.addRequestInterceptor(fn);
-    }
-    addResponseInterceptor(fn) {
-        return this.apiClient.addResponseInterceptor(fn);
-    }
-    setAccessToken(token) {
-        this.apiClient.setAccessToken(token);
-        logger_1.default.info('Access token updated');
-    }
-    setTokenProvider(provider) {
-        this.apiClient.setTokenProvider(provider);
-        logger_1.default.info(provider ? 'Token provider configured' : 'Token provider removed');
-    }
-    get diagnostics() {
-        if (!this._diagnostics) {
-            this._diagnostics = new EsiDiagnostics_1.EsiDiagnostics(this.apiClient, this.etagCacheEnabled, this.deduplicator);
-        }
-        return this._diagnostics;
-    }
-    getCacheStats() {
-        return this.diagnostics.getCacheStats();
-    }
-    clearCache() {
-        this.diagnostics.clearCache();
-    }
-    updateCacheConfig(newConfig) {
-        this.diagnostics.updateCacheConfig(newConfig);
-    }
-    getCircuitBreakerStats() {
-        return this.diagnostics.getCircuitBreakerStats();
-    }
-    resetCircuitBreaker(endpoint) {
-        this.diagnostics.resetCircuitBreaker(endpoint);
-    }
-    async batch(keys, fetcher, options) {
-        return (0, BatchRequestHandler_1.batchFetch)(keys, fetcher, options);
-    }
-    async batchPost(ids, poster, chunkSize) {
-        return (0, BatchRequestHandler_1.batchPost)(ids, poster, chunkSize);
-    }
-    shutdown() {
-        const cache = this.apiClient.getCache();
-        if (cache) {
-            cache.shutdown();
-        }
-        const cb = this.apiClient.getCircuitBreaker();
-        if (cb) {
-            cb.shutdown();
-        }
-        if (this.deduplicator) {
-            this.deduplicator.clear();
-        }
-        this.clients.clear();
-        logger_1.default.info('EsiClient shutdown completed');
-    }
-}
-exports.EsiClient = EsiClient;
-let _defaultClient = null;
-function getDefaultClient() {
-    if (!_defaultClient) {
-        _defaultClient = new EsiClient();
-    }
-    return _defaultClient;
-}

package/dist/EsiClientBuilder.js

@@ -1,217 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EsiClientBuilder = exports.EsiApiFactory = exports.CustomEsiClient = void 0;
-const ApiClient_1 = require("./core/ApiClient");
-const RateLimiter_1 = require("./core/rateLimiter/RateLimiter");
-const validation_1 = require("./core/util/validation");
-const ClientRegistry_1 = require("./core/ClientRegistry");
-const logger_1 = __importDefault(require("./core/logger/logger"));
-class CustomEsiClient {
-    apiClient;
-    clients = new Map();
-    enabledClients;
-    constructor(config) {
-        this.enabledClients = new Set(config.clients);
-        const baseUrl = (0, validation_1.validateBaseUrl)(config.baseUrl || process.env.ESI_BASE_URL || 'https://esi.evetech.net', config.unsafeAllowCustomHost);
-        this.apiClient = new ApiClient_1.ApiClient(config.clientId || process.env.ESI_CLIENT_ID || 'esi-custom-client', baseUrl, config.accessToken || process.env.ESI_ACCESS_TOKEN);
-        this.apiClient.setRateLimiter(new RateLimiter_1.RateLimiter());
-        for (const name of this.enabledClients) {
-            this.clients.set(name, (0, ClientRegistry_1.createClientInstance)(name, this.apiClient));
-        }
-        logger_1.default.info(`CustomEsiClient initialized with clients: ${config.clients.join(', ')}`);
-    }
-    getClient(clientType) {
-        return this.clients.get(clientType);
-    }
-    hasClient(clientType) {
-        return this.clients.has(clientType);
-    }
-    getEnabledClients() {
-        return Array.from(this.enabledClients);
-    }
-    get alliance() {
-        return this.getClient('alliance');
-    }
-    get assets() {
-        return this.getClient('assets');
-    }
-    get calendar() {
-        return this.getClient('calendar');
-    }
-    get characters() {
-        return this.getClient('characters');
-    }
-    get clones() {
-        return this.getClient('clones');
-    }
-    get contacts() {
-        return this.getClient('contacts');
-    }
-    get contracts() {
-        return this.getClient('contracts');
-    }
-    get corporations() {
-        return this.getClient('corporations');
-    }
-    get dogma() {
-        return this.getClient('dogma');
-    }
-    get factions() {
-        return this.getClient('factions');
-    }
-    get fittings() {
-        return this.getClient('fittings');
-    }
-    get fleets() {
-        return this.getClient('fleets');
-    }
-    get incursions() {
-        return this.getClient('incursions');
-    }
-    get industry() {
-        return this.getClient('industry');
-    }
-    get insurance() {
-        return this.getClient('insurance');
-    }
-    get killmails() {
-        return this.getClient('killmails');
-    }
-    get location() {
-        return this.getClient('location');
-    }
-    get loyalty() {
-        return this.getClient('loyalty');
-    }
-    get mail() {
-        return this.getClient('mail');
-    }
-    get market() {
-        return this.getClient('market');
-    }
-    get pi() {
-        return this.getClient('pi');
-    }
-    get route() {
-        return this.getClient('route');
-    }
-    get search() {
-        return this.getClient('search');
-    }
-    get skills() {
-        return this.getClient('skills');
-    }
-    get sovereignty() {
-        return this.getClient('sovereignty');
-    }
-    get status() {
-        return this.getClient('status');
-    }
-    get ui() {
-        return this.getClient('ui');
-    }
-    get universe() {
-        return this.getClient('universe');
-    }
-    get wallet() {
-        return this.getClient('wallet');
-    }
-    get wars() {
-        return this.getClient('wars');
-    }
-    get meta() {
-        return this.getClient('meta');
-    }
-    get freelanceJobs() {
-        return this.getClient('freelanceJobs');
-    }
-    get skyhooks() {
-        return this.getClient('skyhooks');
-    }
-    get mercenary() {
-        return this.getClient('mercenary');
-    }
-    get accessLists() {
-        return this.getClient('accessLists');
-    }
-    shutdown() {
-        this.clients.clear();
-        logger_1.default.info('CustomEsiClient shutdown completed');
-    }
-}
-exports.CustomEsiClient = CustomEsiClient;
-class EsiApiFactory {
-    static createAllianceClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('alliance', this.buildApiClient(config));
-    }
-    static createCharacterClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('characters', this.buildApiClient(config));
-    }
-    static createCorporationClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('corporations', this.buildApiClient(config));
-    }
-    static createMarketClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('market', this.buildApiClient(config));
-    }
-    static createUniverseClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('universe', this.buildApiClient(config));
-    }
-    static createFleetClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('fleets', this.buildApiClient(config));
-    }
-    static createAssetsClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('assets', this.buildApiClient(config));
-    }
-    static createWalletClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('wallet', this.buildApiClient(config));
-    }
-    static createMailClient(config) {
-        return (0, ClientRegistry_1.createClientInstance)('mail', this.buildApiClient(config));
-    }
-    static createClient(clientType, config) {
-        return (0, ClientRegistry_1.createClientInstance)(clientType, this.buildApiClient(config));
-    }
-    static buildApiClient(config) {
-        const baseUrl = (0, validation_1.validateBaseUrl)(config?.baseUrl || process.env.ESI_BASE_URL || 'https://esi.evetech.net', config?.unsafeAllowCustomHost);
-        const client = new ApiClient_1.ApiClient(config?.clientId || process.env.ESI_CLIENT_ID || 'esi-standalone-client', baseUrl, config?.accessToken || process.env.ESI_ACCESS_TOKEN);
-        client.setRateLimiter(new RateLimiter_1.RateLimiter());
-        return client;
-    }
-}
-exports.EsiApiFactory = EsiApiFactory;
-class EsiClientBuilder {
-    clients = [];
-    config = {};
-    addClient(clientType) {
-        if (!this.clients.includes(clientType)) {
-            this.clients.push(clientType);
-        }
-        return this;
-    }
-    addClients(clientTypes) {
-        clientTypes.forEach((type) => this.addClient(type));
-        return this;
-    }
-    withConfig(config) {
-        this.config = { ...this.config, ...config };
-        return this;
-    }
-    withClientId(clientId) {
-        this.config.clientId = clientId;
-        return this;
-    }
-    withAccessToken(accessToken) {
-        this.config.accessToken = accessToken;
-        return this;
-    }
-    build() {
-        if (this.clients.length === 0) {
-            throw new Error('At least one client type must be specified');
-        }
-        return new CustomEsiClient({ ...this.config, clients: this.clients });
-    }
-}
-exports.EsiClientBuilder = EsiClientBuilder;

package/dist/clients/AccessListsClient.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccessListsClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const accessListEndpoints_1 = require("../core/endpoints/accessListEndpoints");
-class AccessListsClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, accessListEndpoints_1.accessListEndpoints);
-    }
-    /**
-     * Retrieves the contents of an access list (ACL) including all character, corporation, and alliance entries.
-     *
-     * @param accessListId - The ID of the access list to retrieve
-     * @returns The access list with its entries
-     */
-    getAccessList(accessListId) {
-        return this.api.getAccessList(accessListId);
-    }
-}
-exports.AccessListsClient = AccessListsClient;

package/dist/clients/AllianceClient.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AllianceClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const createClient_1 = require("../core/endpoints/createClient");
-const allianceEndpoints_1 = require("../core/endpoints/allianceEndpoints");
-const contactEndpoints_1 = require("../core/endpoints/contactEndpoints");
-class AllianceClient extends BaseEsiClient_1.BaseEsiClient {
-    contactApi;
-    constructor(client) {
-        super(client, allianceEndpoints_1.allianceEndpoints);
-        this.contactApi = (0, createClient_1.createClient)(client, contactEndpoints_1.contactEndpoints);
-    }
-    /**
-     * Retrieve public information about an alliance.
-     *
-     * @param allianceId - The ID of the alliance to look up
-     * @returns Public alliance information including name, ticker, and founding date
-     */
-    getAllianceById(allianceId) {
-        return this.api.getAllianceById(allianceId);
-    }
-    /**
-     * Retrieve contacts for an alliance.
-     *
-     * @deprecated Use ContactsClient.getAllianceContacts() instead
-     * @param allianceId - The ID of the alliance whose contacts to retrieve
-     * @returns A list of alliance contacts with standings and contact types
-     * @requires Authentication
-     */
-    getContacts(allianceId) {
-        return this.contactApi.getAllianceContacts(allianceId);
-    }
-    /**
-     * Retrieve custom contact labels for an alliance.
-     *
-     * @deprecated Use ContactsClient.getAllianceContactLabels() instead
-     * @param allianceId - The ID of the alliance whose contact labels to retrieve
-     * @returns A list of custom labels used to categorize alliance contacts
-     * @requires Authentication
-     */
-    getContactLabels(allianceId) {
-        return this.contactApi.getAllianceContactLabels(allianceId);
-    }
-    /**
-     * Retrieve the list of corporation IDs that are members of an alliance.
-     *
-     * @param allianceId - The ID of the alliance whose member corporations to retrieve
-     * @returns An array of corporation IDs belonging to the alliance
-     */
-    getCorporations(allianceId) {
-        return this.api.getCorporations(allianceId);
-    }
-    /**
-     * Retrieve icon URLs for an alliance.
-     *
-     * @param allianceId - The ID of the alliance whose icons to retrieve
-     * @returns Icon URLs at various resolutions for the alliance
-     */
-    getIcons(allianceId) {
-        return this.api.getIcons(allianceId);
-    }
-    /**
-     * Retrieve a list of all active alliance IDs in EVE Online.
-     *
-     * @returns An array of all active alliance IDs
-     */
-    getAlliances() {
-        return this.api.getAlliances();
-    }
-}
-exports.AllianceClient = AllianceClient;