@lgriffin/esi.ts 7.4.0 → 9.0.0

package/dist/clients/IndustryClient.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndustryClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const industryEndpoints_1 = require("../core/endpoints/industryEndpoints");
-class IndustryClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, industryEndpoints_1.industryEndpoints);
-    }
-    /**
-     * Retrieves all industry jobs for a character, including manufacturing, research, and invention.
-     *
-     * @param characterId - The ID of the character
-     * @returns An array of the character's industry jobs
-     * @requires Authentication
-     */
-    getCharacterIndustryJobs(characterId) {
-        return this.api.getCharacterIndustryJobs(characterId);
-    }
-    /**
-     * Retrieves a character's personal mining ledger, showing ore mined per day.
-     *
-     * @param characterId - The ID of the character
-     * @returns An array of mining ledger entries
-     * @requires Authentication
-     */
-    getCharacterMiningLedger(characterId) {
-        return this.api.getCharacterMiningLedger(characterId);
-    }
-    /**
-     * Retrieves moon extraction timers for a corporation's refineries.
-     *
-     * @param corporationId - The ID of the corporation
-     * @returns An array of moon extraction timers
-     * @requires Authentication
-     */
-    getMoonExtractionTimers(corporationId) {
-        return this.api.getMoonExtractionTimers(corporationId);
-    }
-    /**
-     * Retrieves the list of mining observers (e.g., refineries) owned by a corporation.
-     *
-     * @param corporationId - The ID of the corporation
-     * @returns An array of mining observers
-     * @requires Authentication
-     */
-    getCorporationMiningObservers(corporationId) {
-        return this.api.getCorporationMiningObservers(corporationId);
-    }
-    /**
-     * Retrieves mining activity recorded by a specific corporation mining observer.
-     *
-     * @param corporationId - The ID of the corporation
-     * @param observerId - The ID of the mining observer
-     * @returns An array of mining activity entries for the observer
-     * @requires Authentication
-     */
-    getCorporationMiningObserver(corporationId, observerId) {
-        return this.api.getCorporationMiningObserver(corporationId, observerId);
-    }
-    /**
-     * Retrieves all industry jobs for a corporation, including manufacturing, research, and invention.
-     *
-     * @param corporationId - The ID of the corporation
-     * @returns An array of the corporation's industry jobs
-     * @requires Authentication
-     */
-    getCorporationIndustryJobs(corporationId) {
-        return this.api.getCorporationIndustryJobs(corporationId);
-    }
-    /**
-     * Retrieves a list of all publicly available industry facilities in the universe.
-     *
-     * @returns An array of industry facilities
-     */
-    getIndustryFacilities() {
-        return this.api.getIndustryFacilities();
-    }
-    /**
-     * Retrieves cost indices for solar systems with industry activity, used to calculate job installation fees.
-     *
-     * @returns An array of industry system cost indices
-     */
-    getIndustrySystems() {
-        return this.api.getIndustrySystems();
-    }
-}
-exports.IndustryClient = IndustryClient;

package/dist/clients/InsuranceClient.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InsuranceClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const insuranceEndpoints_1 = require("../core/endpoints/insuranceEndpoints");
-class InsuranceClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, insuranceEndpoints_1.insuranceEndpoints);
-    }
-    /**
-     * Retrieves available insurance levels and their costs for all ship types.
-     *
-     * @returns An array of insurance price listings per ship type
-     */
-    getInsurancePrices() {
-        return this.api.getInsurancePrices();
-    }
-}
-exports.InsuranceClient = InsuranceClient;

package/dist/clients/KillmailsClient.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KillmailsClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const killmailEndpoints_1 = require("../core/endpoints/killmailEndpoints");
-class KillmailsClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, killmailEndpoints_1.killmailEndpoints);
-    }
-    /**
-     * Retrieves a list of recent killmail summaries for a character.
-     *
-     * @param characterId - The ID of the character to fetch killmails for
-     * @returns A list of recent killmail summaries including killmail IDs and hashes
-     * @requires Authentication
-     */
-    getCharacterRecentKillmails(characterId) {
-        return this.api.getCharacterRecentKillmails(characterId);
-    }
-    /**
-     * Retrieves a list of recent killmail summaries for a corporation.
-     *
-     * @param corporationId - The ID of the corporation to fetch killmails for
-     * @returns A list of recent killmail summaries including killmail IDs and hashes
-     * @requires Authentication
-     */
-    getCorporationRecentKillmails(corporationId) {
-        return this.api.getCorporationRecentKillmails(corporationId);
-    }
-    /**
-     * Retrieves the full details of a specific killmail by its ID and hash.
-     *
-     * @param killmailId - The ID of the killmail to retrieve
-     * @param killmailHash - The hash of the killmail for verification
-     * @returns The full killmail details including victim, attackers, and items
-     */
-    getKillmail(killmailId, killmailHash) {
-        return this.api.getKillmail(killmailId, killmailHash);
-    }
-    streamCharacterRecentKillmails(characterId) {
-        return this.streamEndpoint('getCharacterRecentKillmails', characterId);
-    }
-    streamCorporationRecentKillmails(corporationId) {
-        return this.streamEndpoint('getCorporationRecentKillmails', corporationId);
-    }
-}
-exports.KillmailsClient = KillmailsClient;

package/dist/clients/LocationClient.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocationClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const locationEndpoints_1 = require("../core/endpoints/locationEndpoints");
-class LocationClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, locationEndpoints_1.locationEndpoints);
-    }
-    /**
-     * Retrieves the current solar system, station, and structure location of a character.
-     *
-     * @param characterId - The ID of the character to locate
-     * @returns The character's current location including solar system and optional station or structure
-     * @requires Authentication
-     */
-    getCharacterLocation(characterId) {
-        return this.api.getCharacterLocation(characterId);
-    }
-    /**
-     * Checks whether a character is currently online and retrieves login/logout timestamps.
-     *
-     * @param characterId - The ID of the character to check
-     * @returns The character's online status and last login/logout times
-     * @requires Authentication
-     */
-    getCharacterOnline(characterId) {
-        return this.api.getCharacterOnline(characterId);
-    }
-    /**
-     * Retrieves the type, name, and item ID of the ship a character is currently flying.
-     *
-     * @param characterId - The ID of the character whose ship to retrieve
-     * @returns The character's current ship details including type ID and ship name
-     * @requires Authentication
-     */
-    getCharacterShip(characterId) {
-        return this.api.getCharacterShip(characterId);
-    }
-}
-exports.LocationClient = LocationClient;

package/dist/clients/LoyaltyClient.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoyaltyClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const loyaltyEndpoints_1 = require("../core/endpoints/loyaltyEndpoints");
-class LoyaltyClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, loyaltyEndpoints_1.loyaltyEndpoints);
-    }
-    /**
-     * Retrieves the loyalty points a character has earned with each NPC corporation.
-     *
-     * @param characterId - The ID of the character to fetch loyalty points for
-     * @returns A list of loyalty point balances per corporation
-     * @requires Authentication
-     */
-    getLoyaltyPoints(characterId) {
-        return this.api.getLoyaltyPoints(characterId);
-    }
-    /**
-     * Retrieves the list of items available in an NPC corporation's loyalty point store.
-     *
-     * @param corporationId - The ID of the NPC corporation whose LP store to query
-     * @returns A list of offers available in the loyalty store
-     */
-    getLoyaltyStoreOffers(corporationId) {
-        return this.api.getLoyaltyStoreOffers(corporationId);
-    }
-}
-exports.LoyaltyClient = LoyaltyClient;

package/dist/clients/MailClient.js

@@ -1,108 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const mailEndpoints_1 = require("../core/endpoints/mailEndpoints");
-class MailClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, mailEndpoints_1.mailEndpoints);
-    }
-    /**
-     * Retrieves the mail headers (subject, sender, timestamp) for a character's inbox.
-     *
-     * @param characterId - The ID of the character whose mail headers to fetch
-     * @returns A list of mail message headers
-     * @requires Authentication
-     */
-    getMailHeaders(characterId) {
-        return this.api.getCharacterMailHeaders(characterId);
-    }
-    /**
-     * Sends a new mail on behalf of a character via POST.
-     *
-     * @param characterId - The ID of the character sending the mail
-     * @param body - The mail content including recipients, subject, and body text
-     * @returns The ID of the newly created mail
-     * @requires Authentication
-     */
-    sendMail(characterId, body) {
-        return this.api.sendMail(characterId, body);
-    }
-    /**
-     * Deletes a specific mail from a character's mailbox.
-     *
-     * @param characterId - The ID of the character who owns the mail
-     * @param mailId - The ID of the mail to delete
-     * @returns void
-     * @requires Authentication
-     */
-    deleteMail(characterId, mailId) {
-        return this.api.deleteMail(characterId, mailId);
-    }
-    /**
-     * Retrieves the full contents of a specific mail including its body text.
-     *
-     * @param characterId - The ID of the character who owns the mail
-     * @param mailId - The ID of the mail to retrieve
-     * @returns The full mail message including body, sender, and recipients
-     * @requires Authentication
-     */
-    getMail(characterId, mailId) {
-        return this.api.getMail(characterId, mailId);
-    }
-    /**
-     * Updates the metadata of a mail, such as read status or labels, via PUT.
-     *
-     * @param characterId - The ID of the character who owns the mail
-     * @param mailId - The ID of the mail to update
-     * @param body - The metadata fields to update (e.g., labels, read status)
-     * @returns void
-     * @requires Authentication
-     */
-    updateMailMetadata(characterId, mailId, body) {
-        return this.api.updateMailMetadata(characterId, mailId, body);
-    }
-    /**
-     * Retrieves the mail labels and total unread count for a character.
-     *
-     * @param characterId - The ID of the character whose labels to fetch
-     * @returns The character's mail labels and total unread mail count
-     * @requires Authentication
-     */
-    getMailLabels(characterId) {
-        return this.api.getMailLabels(characterId);
-    }
-    /**
-     * Creates a new custom mail label for a character via POST.
-     *
-     * @param characterId - The ID of the character to create the label for
-     * @param body - The label definition including name and optional color
-     * @returns The ID of the newly created label
-     * @requires Authentication
-     */
-    createMailLabel(characterId, body) {
-        return this.api.createMailLabel(characterId, body);
-    }
-    /**
-     * Deletes a custom mail label from a character's mailbox.
-     *
-     * @param characterId - The ID of the character who owns the label
-     * @param labelId - The ID of the label to delete
-     * @returns void
-     * @requires Authentication
-     */
-    deleteMailLabel(characterId, labelId) {
-        return this.api.deleteMailLabel(characterId, labelId);
-    }
-    /**
-     * Retrieves the mailing lists that a character is subscribed to.
-     *
-     * @param characterId - The ID of the character whose mailing lists to fetch
-     * @returns A list of mailing lists with their IDs and names
-     * @requires Authentication
-     */
-    getMailingLists(characterId) {
-        return this.api.getMailingLists(characterId);
-    }
-}
-exports.MailClient = MailClient;

package/dist/clients/MarketClient.js

@@ -1,131 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarketClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const marketEndpoints_1 = require("../core/endpoints/marketEndpoints");
-class MarketClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, marketEndpoints_1.marketEndpoints);
-    }
-    /**
-     * Retrieves all active market orders placed by a character.
-     *
-     * @param characterId - The ID of the character whose orders to fetch
-     * @returns A list of the character's open market orders
-     * @requires Authentication
-     */
-    getCharacterOrders(characterId) {
-        return this.api.getCharacterOrders(characterId);
-    }
-    /**
-     * Retrieves the history of expired and cancelled market orders for a character.
-     *
-     * @param characterId - The ID of the character whose order history to fetch
-     * @returns A list of the character's historical market orders
-     * @requires Authentication
-     */
-    getCharacterOrderHistory(characterId) {
-        return this.api.getCharacterOrderHistory(characterId);
-    }
-    /**
-     * Retrieves all active market orders placed by members of a corporation.
-     *
-     * @param corporationId - The ID of the corporation whose orders to fetch
-     * @returns A list of the corporation's open market orders
-     * @requires Authentication
-     */
-    getCorporationOrders(corporationId) {
-        return this.api.getCorporationOrders(corporationId);
-    }
-    /**
-     * Retrieves the history of expired and cancelled market orders for a corporation.
-     *
-     * @param corporationId - The ID of the corporation whose order history to fetch
-     * @returns A list of the corporation's historical market orders
-     * @requires Authentication
-     */
-    getCorporationOrderHistory(corporationId) {
-        return this.api.getCorporationOrderHistory(corporationId);
-    }
-    /**
-     * Retrieves the daily price and volume history for a specific item type in a region.
-     *
-     * @param regionId - The ID of the region to fetch market history for
-     * @param typeId - The type ID of the item to get history for
-     * @returns A list of daily market history entries with price and volume data
-     */
-    getMarketHistory(regionId, typeId) {
-        return this.api.getMarketHistory(regionId, typeId);
-    }
-    /**
-     * Retrieves all active market orders in a region for all item types.
-     *
-     * @param regionId - The ID of the region to fetch orders for
-     * @returns A list of all active market orders in the region
-     */
-    getMarketOrders(regionId) {
-        return this.api.getMarketOrders(regionId, 'all');
-    }
-    /**
-     * Retrieves the list of type IDs that have active market orders in a region.
-     *
-     * @param regionId - The ID of the region to check for active types
-     * @returns A list of type IDs with active orders in the region
-     */
-    getMarketTypes(regionId) {
-        return this.api.getMarketTypes(regionId);
-    }
-    /**
-     * Retrieves the list of all market group IDs used to categorize items on the market.
-     *
-     * @returns A list of all market group IDs
-     */
-    getMarketGroups() {
-        return this.api.getMarketGroups();
-    }
-    /**
-     * Retrieves detailed information about a specific market group, including its name, description, and contained types.
-     *
-     * @param marketGroupId - The ID of the market group to look up
-     * @returns The market group details including name, description, types, and optional parent group
-     */
-    getMarketGroupInformation(marketGroupId) {
-        return this.api.getMarketGroupInformation(marketGroupId);
-    }
-    /**
-     * Retrieves the global average and adjusted prices for all tradeable item types.
-     *
-     * @returns A list of item types with their average and adjusted market prices
-     */
-    getMarketPrices() {
-        return this.api.getMarketPrices();
-    }
-    /**
-     * Retrieves all active market orders listed in a specific player-owned structure.
-     *
-     * @param structureId - The ID of the structure to fetch orders for
-     * @returns A list of active market orders in the structure
-     */
-    getMarketOrdersInStructure(structureId) {
-        return this.api.getMarketOrdersInStructure(structureId);
-    }
-    streamMarketOrders(regionId) {
-        return this.streamEndpoint('getMarketOrders', regionId, 'all');
-    }
-    streamMarketTypes(regionId) {
-        return this.streamEndpoint('getMarketTypes', regionId);
-    }
-    streamCharacterOrderHistory(characterId) {
-        return this.streamEndpoint('getCharacterOrderHistory', characterId);
-    }
-    streamCorporationOrders(corporationId) {
-        return this.streamEndpoint('getCorporationOrders', corporationId);
-    }
-    streamCorporationOrderHistory(corporationId) {
-        return this.streamEndpoint('getCorporationOrderHistory', corporationId);
-    }
-    streamMarketOrdersInStructure(structureId) {
-        return this.streamEndpoint('getMarketOrdersInStructure', structureId);
-    }
-}
-exports.MarketClient = MarketClient;

package/dist/clients/MercenaryClient.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MercenaryClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const mercenaryEndpoints_1 = require("../core/endpoints/mercenaryEndpoints");
-class MercenaryClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, mercenaryEndpoints_1.mercenaryEndpoints);
-    }
-    /**
-     * Retrieves all mercenary dens with their development and anarchy parameters.
-     *
-     * @returns A list of mercenary dens
-     */
-    getMercenaryDens() {
-        return this.api.getMercenaryDens();
-    }
-    /**
-     * Retrieves all mercenary tactical operations (MTOs) spawned from mercenary dens.
-     *
-     * @returns A list of mercenary tactical operations
-     */
-    getMercenaryTacticalOperations() {
-        return this.api.getMercenaryTacticalOperations();
-    }
-}
-exports.MercenaryClient = MercenaryClient;

package/dist/clients/MetaClient.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetaClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const metaEndpoints_1 = require("../core/endpoints/metaEndpoints");
-const loggerUtil_1 = require("../core/logger/loggerUtil");
-const constants_1 = require("../core/constants");
-class MetaClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, metaEndpoints_1.metaEndpoints);
-    }
-    /**
-     * Retrieves the ESI OpenAPI specification in JSON format.
-     *
-     * @returns The full ESI OpenAPI specification as a JSON object
-     */
-    /* eslint-disable @typescript-eslint/no-explicit-any */
-    getOpenApiJson() {
-        return this.api.getOpenApiJson();
-    }
-    /* eslint-enable @typescript-eslint/no-explicit-any */
-    /**
-     * Retrieves the ESI OpenAPI specification in YAML format.
-     *
-     * @returns The full ESI OpenAPI specification as a YAML string
-     */
-    async getOpenApiYaml() {
-        const url = `${this._client.getLink()}/meta/openapi.yaml`;
-        (0, loggerUtil_1.logInfo)(`Hitting endpoint: ${url}`);
-        try {
-            const response = await fetch(url, {
-                method: 'GET',
-                headers: {
-                    accept: 'text/yaml, application/x-yaml, text/plain',
-                    'User-Agent': constants_1.USER_AGENT,
-                    'X-Compatibility-Date': constants_1.COMPATIBILITY_DATE,
-                },
-            });
-            if (!response.ok) {
-                throw new Error(`HTTP ${response.status}: ${response.statusText}`);
-            }
-            return await response.text();
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                (0, loggerUtil_1.logError)(`Error fetching YAML: ${error.message}`);
-                throw error;
-            }
-            else {
-                (0, loggerUtil_1.logError)(`Unexpected error: ${String(error)}`);
-                throw new Error(String(error));
-            }
-        }
-    }
-}
-exports.MetaClient = MetaClient;

package/dist/clients/PiClient.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PiClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const piEndpoints_1 = require("../core/endpoints/piEndpoints");
-class PiClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, piEndpoints_1.piEndpoints);
-    }
-    /**
-     * Retrieves the list of planetary interaction colonies owned by a character.
-     *
-     * @param characterId - The ID of the character whose colonies to fetch
-     * @returns A list of the character's planetary colonies
-     * @requires Authentication
-     */
-    getColonies(characterId) {
-        return this.api.getColonies(characterId);
-    }
-    /**
-     * Retrieves the full layout of a planetary colony including pins, links, and routes.
-     *
-     * @param characterId - The ID of the character who owns the colony
-     * @param planetId - The ID of the planet to get the colony layout for
-     * @returns The colony layout with pins, links, and routes
-     * @requires Authentication
-     */
-    getColonyLayout(characterId, planetId) {
-        return this.api.getColonyLayout(characterId, planetId);
-    }
-    /**
-     * Retrieves the list of customs offices owned by a corporation.
-     *
-     * @param corporationId - The ID of the corporation whose customs offices to fetch
-     * @returns A list of the corporation's customs offices with their settings
-     * @requires Authentication
-     */
-    getCorporationCustomsOffices(corporationId) {
-        return this.api.getCorporationCustomsOffices(corporationId);
-    }
-    /**
-     * Retrieves information about a planetary interaction schematic, including its inputs and outputs.
-     *
-     * @param schematicId - The ID of the schematic to look up
-     * @returns The schematic details including cycle time, inputs, and outputs
-     */
-    getSchematicInformation(schematicId) {
-        return this.api.getSchematicInformation(schematicId);
-    }
-}
-exports.PiClient = PiClient;

package/dist/clients/RouteClient.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const routeEndpoints_1 = require("../core/endpoints/routeEndpoints");
-class RouteClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, routeEndpoints_1.routeEndpoints);
-    }
-    /**
-     * Calculates a route between two solar systems, returning the list of system IDs along the path via POST.
-     *
-     * @param origin - The solar system ID to start the route from
-     * @param destination - The solar system ID to route to
-     * @param options - Optional routing preferences such as route type, avoided systems, and custom connections
-     * @returns An ordered list of solar system IDs representing the route
-     */
-    async getRoute(origin, destination, options) {
-        const body = options ?? {};
-        const result = (await this.api.getRoute(origin, destination, body));
-        return result.route;
-    }
-}
-exports.RouteClient = RouteClient;

package/dist/clients/SearchClient.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchClient = void 0;
-const BaseEsiClient_1 = require("./BaseEsiClient");
-const searchEndpoints_1 = require("../core/endpoints/searchEndpoints");
-class SearchClient extends BaseEsiClient_1.BaseEsiClient {
-    constructor(client) {
-        super(client, searchEndpoints_1.searchEndpoints);
-    }
-    /**
-     * Searches for entities matching a query string on behalf of a character.
-     *
-     * @param characterId - The ID of the character performing the search
-     * @param searchString - The search query string to match against
-     * @returns Search results grouped by entity category
-     * @requires Authentication
-     */
-    characterSearch(characterId, searchString, categories) {
-        return this.api.searchCharacter(characterId, searchString, categories.join(','));
-    }
-}
-exports.SearchClient = SearchClient;