@kayahr/edsm 1.1.0

package/lib/main/api/journal.d.ts

@@ -0,0 +1,51 @@
+import type { Coordinates, Id64 } from "../common.ts";
+/**
+ * Response of a {@link sendEvents} request.
+ */
+export interface EventResponse {
+    /** Responses for each sent event. */
+    events: Array<{
+        /**
+         * 100 means the event was accepted. Every other code means the event was rejected for some reason.
+         * See https://www.edsm.net/en/api-journal-v1 for details.
+         */
+        msgnum: number;
+        /** Response code in text form. */
+        msg: string;
+        /** True if new system was created, false if not. */
+        systemCreated?: boolean;
+        /** EDSM system ID. */
+        systemId?: number;
+    }>;
+}
+/**
+ * Base data for EDSM event to be sent to EDSM. This must be the unmodified event read from the Journal, optionally enriched with additional
+ * context information.
+ */
+export interface EDSMEvent {
+    _systemAddress?: Id64;
+    _systemName?: string;
+    _systemCoordinates?: Coordinates;
+    _marketId?: number;
+    _stationName?: string;
+    _shipId?: number;
+    event: string;
+}
+/**
+ * Sends journal events to EDSM.
+ *
+ * @param commanderName        - The name of the commander as registered on EDSM.
+ * @param apiKey               - The API Key associated with the EDSM account.
+ * @param fromSoftware         - Name of the software (YOUR software using this library, not the name of this library!) used to submit the data.
+ * @param fromSoftwareVersion  - Version of the software used to submit the data.
+ * @param fromGameVersion      - Version of the game which generated the journal messages.
+ * @param fromGameBuild        - Build of the game which generated the journal messages.
+ * @param message              - The journal event (or multiple events to send).
+ */
+export declare function sendEvents(commanderName: string, apiKey: string, fromSoftware: string, fromSoftwareVersion: string, fromGameVersion: string, fromGameBuild: string, message: EDSMEvent | EDSMEvent[]): Promise<EventResponse>;
+/**
+ * Returns the events which must be discarded from the list of journal events sent to EDSM.
+ *
+ * @returns The list of event names to be discarded.
+ */
+export declare function getDiscardEvents(): Promise<string[]>;

package/lib/main/api/journal.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2025 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { request } from "./common.js";
+/**
+ * Sends journal events to EDSM.
+ *
+ * @param commanderName        - The name of the commander as registered on EDSM.
+ * @param apiKey               - The API Key associated with the EDSM account.
+ * @param fromSoftware         - Name of the software (YOUR software using this library, not the name of this library!) used to submit the data.
+ * @param fromSoftwareVersion  - Version of the software used to submit the data.
+ * @param fromGameVersion      - Version of the game which generated the journal messages.
+ * @param fromGameBuild        - Build of the game which generated the journal messages.
+ * @param message              - The journal event (or multiple events to send).
+ */
+export async function sendEvents(commanderName, apiKey, fromSoftware, fromSoftwareVersion, fromGameVersion, fromGameBuild, message) {
+    return (await request("api-journal-v1", {
+        apiKey,
+        fromSoftware,
+        fromSoftwareVersion,
+        fromGameVersion,
+        fromGameBuild,
+        message
+    }));
+}
+/**
+ * Returns the events which must be discarded from the list of journal events sent to EDSM.
+ *
+ * @returns The list of event names to be discarded.
+ */
+export async function getDiscardEvents() {
+    return (await request("api-journal-v1/discard"));
+}
+//# sourceMappingURL=journal.js.map

package/lib/main/api/journal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"journal.js","sourceRoot":"","sources":["../../../src/main/api/journal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAuCtC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,aAAqB,EAAE,MAAc,EAAE,YAAoB,EAAE,mBAA2B,EAAE,eAAuB,EAC1I,aAAqB,EAAE,OAAgC;IAC3D,OAAO,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE;QACpC,MAAM;QACN,YAAY;QACZ,mBAAmB;QACnB,eAAe;QACf,aAAa;QACb,OAAO;KACV,CAAC,CAAE,CAAC;AACT,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB;IAClC,OAAO,CAAC,MAAM,OAAO,CAAC,wBAAwB,CAAC,CAAE,CAAC;AACtD,CAAC"}

package/lib/main/api/logs.d.ts

@@ -0,0 +1,130 @@
+import type { Coordinates, Id64 } from "../common.ts";
+import { type SystemIdRequestOptions } from "./common.ts";
+export interface FlightLog {
+    shipId: number | null;
+    system: string;
+    systemId?: number;
+    systemId64?: Id64;
+    firstDiscover: boolean;
+    date: string;
+}
+export interface FlightLogsResponse {
+    startDateTime: string;
+    endDateTime: string;
+    logs: FlightLog[];
+}
+export interface FlightLogFilter {
+    /** Filters flight logs by system name. */
+    systemName?: string;
+    /**
+     * Filters for flight logs after this date & time (inclusive). Must be specified in UTC in the format
+     * YYYY-MM-DD HH:MM:SS.
+     */
+    startDateTime?: string;
+    /**
+     * Filters for flight logs before this date & time (inclusive). Must be specified in UTC in the format
+     * YYYY-MM-DD HH:MM:SS.
+     */
+    endDateTime?: string;
+    /** Set to 1 if you want to get the EDSM internal id. Useful to handle duplicated name systems of the game. */
+    showId?: number;
+}
+/**
+ * Returns the flight log entries.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander.
+ * @param filter        - Optional filter properties.
+ * @returns The flight log entries.
+ */
+export declare function getFlightLogs(commanderName: string, apiKey: string, filter?: FlightLogFilter): Promise<FlightLogsResponse>;
+/**
+ * Commander position response returned by {@link getCommanderPosition} request.
+ */
+export interface CommanderPositionResponse {
+    system: string | null;
+    systemId?: number;
+    systemId64?: Id64;
+    firstDiscover: boolean | null;
+    date: string | null;
+    coordinates?: Coordinates;
+    isDocked?: boolean;
+    station?: string;
+    stationId?: number;
+    dateDocked?: string;
+    shipId?: number;
+    shipType?: string;
+    shipFuel?: number | null;
+    dateLastActivity?: string;
+    url?: string;
+}
+export interface CommanderPositionOptions {
+    /**
+     * If not provided, information will only be returned if the commander has enabled his public profile, and share
+     * logs or map.
+     */
+    apiKey?: string;
+    /** Set to 1 if you want to get the EDSM internal id. Useful to handle duplicated name systems of the game. */
+    showId?: number;
+    /** Set to 1 if you want to get the coordinates of the system. */
+    showCoordinates?: number;
+}
+/**
+ * Returns the last position of the given commander.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param options       - Options.
+ * @returns The last position.
+ */
+export declare function getCommanderPosition(commanderName: string, options?: CommanderPositionOptions): Promise<CommanderPositionResponse>;
+/** Response type of {@link setSystemComment} */
+export interface SystemCommentResponse {
+    comment: string | null;
+    lastUpdate: string | null;
+}
+/**
+ * Sets/Updates a comment.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key associated with the commander.
+ * @param systemName    - The system name for which to set a comment.
+ * @param comment       - The comment to set. Empty string to remove.
+ * @param options       - Additional options.
+ */
+export declare function setSystemComment(commanderName: string, apiKey: string, systemName: string, comment: string, options?: SystemIdRequestOptions): Promise<SystemCommentResponse>;
+/**
+ * Returns a system comment.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key associated with the commander.
+ * @param systemName    - The system name for which to return the comment.
+ * @param options       - Additional options.
+ */
+export declare function getSystemComment(commanderName: string, apiKey: string, systemName: string, options?: SystemIdRequestOptions): Promise<SystemCommentResponse>;
+/** Response of a {@link getSystemComments} request. */
+export interface SystemCommentsResponse {
+    comments: Array<{
+        system: string;
+        systemId?: number;
+        comment: string;
+        lastUpdate: string;
+    }>;
+}
+/** Options for {@link getSystemComments} request. */
+export interface SystemCommentsOptions {
+    /**
+     * If you only want to receive comments updated after a specific date & time, use this parameter.
+     * That parameter is inclusive. All dates must be UTC.
+     */
+    startDateTime?: string;
+    /** Set to 1 if you want to get the EDSM internal id. Useful to handle duplicated name systems of the game. */
+    showId?: number;
+}
+/**
+ * Returns comments set for various systems.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key associated with the commander.
+ * @param options       - Additional options.
+ */
+export declare function getSystemComments(commanderName: string, apiKey: string, options?: SystemCommentsOptions): Promise<SystemCommentsResponse>;

package/lib/main/api/logs.js

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { request } from "./common.js";
+/**
+ * Returns the flight log entries.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander.
+ * @param filter        - Optional filter properties.
+ * @returns The flight log entries.
+ */
+export async function getFlightLogs(commanderName, apiKey, filter) {
+    return (await request("api-logs-v1/get-logs", { commanderName, apiKey, ...filter }));
+}
+/**
+ * Returns the last position of the given commander.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param options       - Options.
+ * @returns The last position.
+ */
+export async function getCommanderPosition(commanderName, options) {
+    return (await request("api-logs-v1/get-position", { commanderName, ...options }));
+}
+/**
+ * Sets/Updates a comment.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key associated with the commander.
+ * @param systemName    - The system name for which to set a comment.
+ * @param comment       - The comment to set. Empty string to remove.
+ * @param options       - Additional options.
+ */
+export async function setSystemComment(commanderName, apiKey, systemName, comment, options) {
+    return (await request("api-logs-v1/set-comment", { commanderName, apiKey, systemName, comment, ...options }));
+}
+/**
+ * Returns a system comment.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key associated with the commander.
+ * @param systemName    - The system name for which to return the comment.
+ * @param options       - Additional options.
+ */
+export async function getSystemComment(commanderName, apiKey, systemName, options) {
+    return (await request("api-logs-v1/get-comment", { commanderName, apiKey, systemName, ...options }));
+}
+/**
+ * Returns comments set for various systems.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key associated with the commander.
+ * @param options       - Additional options.
+ */
+export async function getSystemComments(commanderName, apiKey, options) {
+    return (await request("api-logs-v1/get-comments", { commanderName, apiKey, ...options }));
+}
+//# sourceMappingURL=logs.js.map

package/lib/main/api/logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../../../src/main/api/logs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAA+B,OAAO,EAAE,MAAM,aAAa,CAAC;AAqCnE;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,aAAqB,EAAE,MAAc,EAAE,MAAwB;IAC/F,OAAO,CAAC,MAAM,OAAO,CAAC,sBAAsB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAE,CAAC;AAC1F,CAAC;AAqCD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,aAAqB,EAAE,OAAkC;IAChG,OAAO,CAAC,MAAM,OAAO,CAAC,0BAA0B,EAAE,EAAE,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC,CAAE,CAAC;AACvF,CAAC;AAQD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,aAAqB,EAAE,MAAc,EAAE,UAAkB,EAAE,OAAe,EAAE,OAAgC;IAE/I,OAAO,CAAC,MAAM,OAAO,CAAC,yBAAyB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAE,CAAC;AACnH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,aAAqB,EAAE,MAAc,EAAE,UAAkB,EAAE,OAAgC;IAE9H,OAAO,CAAC,MAAM,OAAO,CAAC,yBAAyB,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,CAAC,CAAE,CAAC;AAC1G,CAAC;AAwBD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,aAAqB,EAAE,MAAc,EAAE,OAA+B;IAC1G,OAAO,CAAC,MAAM,OAAO,CAAC,0BAA0B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAE,CAAC;AAC/F,CAAC"}

package/lib/main/api/status.d.ts

@@ -0,0 +1,13 @@
+export type EliteServerStatusType = "success" | "warning" | "danger";
+export interface EliteServerStatusResponse {
+    lastUpdate: string;
+    type: EliteServerStatusType;
+    message: string;
+    status: number;
+}
+/**
+ * Returns the elite server status.
+ *
+ * @returns The elite server status.
+ */
+export declare function getEliteServerStatus(): Promise<EliteServerStatusResponse>;

package/lib/main/api/status.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { request } from "./common.js";
+/**
+ * Returns the elite server status.
+ *
+ * @returns The elite server status.
+ */
+export async function getEliteServerStatus() {
+    return (await request("api-status-v1/elite-server"));
+}
+//# sourceMappingURL=status.js.map

package/lib/main/api/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../src/main/api/status.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAWtC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACtC,OAAO,CAAC,MAAM,OAAO,CAAC,4BAA4B,CAAC,CAAE,CAAC;AAC1D,CAAC"}

package/lib/main/api/system.d.ts

@@ -0,0 +1,279 @@
+import type { SystemBody } from "../bodies.ts";
+import type { Id64 } from "../common.ts";
+import type { Commodity, Outfitting, Ship, SystemStation } from "../stations.ts";
+import { type SystemIdRequestOptions } from "./common.ts";
+export interface BodyScanValue {
+    bodyId: number;
+    bodyName: string;
+    distance: number;
+    valueMax: number;
+}
+/**
+ * Response structure of the EDSM system bodies request.
+ */
+export interface SystemBodiesResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    url: string;
+    bodies: SystemBody[];
+    bodyCount: number;
+}
+/**
+ * Response structure of the EDSM system estimated value request.
+ */
+export interface SystemEstimatedValueResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    url: string;
+    estimatedValue: number;
+    estimatedValueMapped: number;
+    valuableBodies: BodyScanValue[];
+}
+/**
+ * Response structure of the EDSM system stations request.
+ */
+export interface SystemStationsResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    url: string;
+    stations: SystemStation[];
+}
+/**
+ * Response structure of the EDSM system stations market request.
+ */
+export interface StationMarketResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    marketId: number;
+    sId: number;
+    sName: string;
+    url: string;
+    commodities: Commodity[];
+}
+/**
+ * Response structure of the EDSM system stations shipyard request.
+ */
+export interface StationShipyardResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    marketId: number;
+    sId: number;
+    sName: string;
+    url: string;
+    ships: Ship[];
+}
+/**
+ * Response structure of the EDSM system stations outfitting request.
+ */
+export interface StationOutfittingResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    marketId: number;
+    sId: number;
+    sName: string;
+    url: string;
+    outfitting: Outfitting[];
+}
+/**
+ * Returns the system bodies of the given star system.
+ *
+ * @param systemName - The system name.
+ * @param ids        - Optional system IDs if you seek for a duplicate system and want to force a specific ID.
+ * @returns The bodies found on EDSM.
+ * @throws NotFoundException - When system was not found.
+ */
+export declare function getSystemBodies(systemName: string, ids?: {
+    systemId?: number;
+    systemId64?: Id64;
+}): Promise<SystemBodiesResponse>;
+/**
+ * Returns the estimated scan values of a system.
+ *
+ * @param systemName - The system name.
+ * @param ids        - Optional parameters.
+ * @returns The scan values.
+ * @throws NotFoundException - When system was not found.
+ */
+export declare function getSystemEstimatedValue(systemName: string, ids?: SystemIdRequestOptions): Promise<SystemEstimatedValueResponse>;
+/**
+ * Returns information about stations in a system.
+ *
+ * @param systemName - The system name.
+ * @param ids        - Optional parameters.
+ * @returns The information about stations in a system.
+ * @throws NotFoundException - When system was not found.
+ */
+export declare function getSystemStations(systemName: string, ids?: SystemIdRequestOptions): Promise<SystemStationsResponse>;
+/**
+ * Returns information about market in a station.
+ *
+ * @param marketId - The market ID.
+ * @returns The information about market in given station.
+ * @throws NotFoundException - When market was not found.
+ */
+export declare function getStationMarket(marketId: number): Promise<StationMarketResponse>;
+/**
+ * Returns information about market in a station.
+ *
+ * @param systemName  - The system name.
+ * @param stationName - The station name.
+ * @param params      - Optional parameters.
+ * @returns The information about market in given station.
+ * @throws NotFoundException - When market was not found.
+ */
+export declare function getStationMarket(systemName: string, stationName: string, params?: SystemIdRequestOptions): Promise<StationMarketResponse>;
+/**
+ * Returns information about shipyard in a station.
+ *
+ * @param marketId - The market ID.
+ * @returns The information about shipyard in given station.
+ * @throws NotFoundException - When shipyard was not found.
+ */
+export declare function getStationShipyard(marketId: number): Promise<StationShipyardResponse>;
+/**
+ * Returns information about shipyard in a station.
+ *
+ * @param systemName  - The system name.
+ * @param stationName - The station name.
+ * @param params      - Optional parameters.
+ * @returns The information about shipyard in given station.
+ * @throws NotFoundException - When shipyard was not found.
+ */
+export declare function getStationShipyard(systemName: string, stationName: string, params?: SystemIdRequestOptions): Promise<StationShipyardResponse>;
+/**
+ * Returns information about outfitting in a station.
+ *
+ * @param marketId - The market ID.
+ * @returns The information about outfitting in given station.
+ * @throws NotFoundException - When station was not found.
+ */
+export declare function getStationOutfitting(marketId: number): Promise<StationOutfittingResponse>;
+/**
+ * Returns information about outfitting in a station.
+ *
+ * @param systemName  - The system name.
+ * @param stationName - The station name.
+ * @param params      - Optional parameters.
+ * @returns The information about outfitting in given station.
+ * @throws NotFoundException - When station was not found.
+ */
+export declare function getStationOutfitting(systemName: string, stationName: string, params?: SystemIdRequestOptions): Promise<StationOutfittingResponse>;
+export interface SystemFactionsOptions extends SystemIdRequestOptions {
+    /** Set to 1 to get the factions history under the requested system. */
+    showHistory?: number;
+}
+export interface ShortSystemFaction {
+    id: number;
+    name: string;
+    allegiance: string;
+    government: string;
+}
+export interface SystemFaction extends ShortSystemFaction {
+    influence: number;
+    influenceHistory?: Record<string, number> | [];
+    state: string;
+    stateHistory?: Record<string, string> | [];
+    activeStates: Array<{
+        state: string;
+    }>;
+    activeStatesHistory?: Record<string, Array<{
+        state: string;
+    }>> | [];
+    recoveringStates: Array<{
+        state: string;
+        trend?: number;
+    }>;
+    recoveringStatesHistory?: Record<string, Array<{
+        state: string;
+        trend?: number;
+    }>> | [];
+    pendingStates: Array<{
+        state: string;
+        trend?: number;
+    }>;
+    pendingStatesHistory?: Record<string, Array<{
+        state: string;
+        trend?: number;
+    }>> | [];
+    happiness: string;
+    happinessHistory?: Record<string, string> | [];
+    isPlayer: boolean;
+    lastUpdate: number;
+}
+/**
+ * Response structure of the EDSM system factions request.
+ */
+export interface SystemFactionsResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    url: string;
+    controllingFaction?: ShortSystemFaction;
+    factions: SystemFaction[];
+}
+/**
+ * Returns information about factions in a system.
+ *
+ * @param systemName - The system name.
+ * @param options    - Optional parameters.
+ * @returns The information about stations in a system.
+ * @throws NotFoundException - When system was not found.
+ */
+export declare function getSystemFactions(systemName: string, options?: SystemFactionsOptions): Promise<SystemFactionsResponse>;
+/**
+ * Response structure of the EDSM system traffic request.
+ */
+export interface SystemTrafficResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    url: string;
+    discovery: {
+        commander: string;
+        date: string;
+    };
+    traffic: {
+        total: number;
+        week: number;
+        day: number;
+    };
+    breakdown: Record<string, number>;
+}
+/**
+ * Returns information about traffic in a system.
+ *
+ * @param systemName - The system name.
+ * @param ids        - Optional parameters.
+ * @returns The information about traffic in a system.
+ * @throws NotFoundException - When system was not found.
+ */
+export declare function getSystemTraffic(systemName: string, ids?: SystemIdRequestOptions): Promise<SystemTrafficResponse>;
+/**
+ * Response structure of the EDSM system deaths request.
+ */
+export interface SystemDeathsResponse {
+    id: number;
+    id64: Id64;
+    name: string;
+    url: string;
+    deaths: {
+        total: number;
+        week: number;
+        day: number;
+    };
+}
+/**
+ * Returns information about deaths in a system.
+ *
+ * @param systemName - The system name.
+ * @param ids        - Optional parameters.
+ * @returns The information about deaths in a system.
+ * @throws NotFoundException - When system was not found.
+ */
+export declare function getSystemDeaths(systemName: string, ids?: SystemIdRequestOptions): Promise<SystemDeathsResponse>;