@kayahr/edsm 1.1.0

package/lib/commander-inventory-response.schema.json

@@ -0,0 +1,91 @@
+{
+  "$ref": "#/definitions/CommanderInventoryResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "CommanderInventoryResponse": {
+      "additionalProperties": false,
+      "description": "Commander inventory response returned by  {@link  getCommanderInventory }  request.",
+      "properties": {
+        "cargo": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "qty": {
+                "type": "number"
+              },
+              "type": {
+                "type": [
+                  "string",
+                  "null"
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "name",
+              "qty"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "data": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "qty": {
+                "type": "number"
+              },
+              "type": {
+                "type": [
+                  "string",
+                  "number"
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "name",
+              "qty"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "materials": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "qty": {
+                "type": "number"
+              },
+              "type": {
+                "type": [
+                  "string",
+                  "number"
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "name",
+              "qty"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    }
+  }
+}

package/lib/commander-position-response.schema.json

@@ -0,0 +1,101 @@
+{
+  "$ref": "#/definitions/CommanderPositionResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "CommanderPositionResponse": {
+      "additionalProperties": false,
+      "description": "Commander position response returned by  {@link  getCommanderPosition }  request.",
+      "properties": {
+        "coordinates": {
+          "$ref": "#/definitions/Coordinates"
+        },
+        "date": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "dateDocked": {
+          "type": "string"
+        },
+        "dateLastActivity": {
+          "type": "string"
+        },
+        "firstDiscover": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "isDocked": {
+          "type": "boolean"
+        },
+        "shipFuel": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "shipId": {
+          "type": "number"
+        },
+        "shipType": {
+          "type": "string"
+        },
+        "station": {
+          "type": "string"
+        },
+        "stationId": {
+          "type": "number"
+        },
+        "system": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "systemId": {
+          "type": "number"
+        },
+        "systemId64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "system",
+        "firstDiscover",
+        "date"
+      ],
+      "type": "object"
+    },
+    "Coordinates": {
+      "additionalProperties": false,
+      "properties": {
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        },
+        "z": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "x",
+        "y",
+        "z"
+      ],
+      "type": "object"
+    },
+    "Id64": {
+      "description": "A 64 bit ID. Can be a `number` if ID does not need more then 53 bit. Must be `bigint` if ID needs more than 53 bit.",
+      "type": [
+        "number"
+      ]
+    }
+  }
+}

package/lib/commander-ranks-response.schema.json

@@ -0,0 +1,138 @@
+{
+  "$ref": "#/definitions/CommanderRanksResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "CommanderRanksResponse": {
+      "additionalProperties": false,
+      "description": "Commander ranks response returned by  {@link  getCommanderRanks }  request.",
+      "properties": {
+        "progress": {
+          "additionalProperties": false,
+          "properties": {
+            "CQC": {
+              "type": "number"
+            },
+            "Combat": {
+              "type": "number"
+            },
+            "Empire": {
+              "type": "number"
+            },
+            "Exobiologist": {
+              "type": "number"
+            },
+            "Explore": {
+              "type": "number"
+            },
+            "Federation": {
+              "type": "number"
+            },
+            "Soldier": {
+              "type": "number"
+            },
+            "Trade": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "Combat",
+            "Trade",
+            "Explore",
+            "Soldier",
+            "Exobiologist",
+            "CQC",
+            "Federation",
+            "Empire"
+          ],
+          "type": "object"
+        },
+        "ranks": {
+          "additionalProperties": false,
+          "properties": {
+            "CQC": {
+              "type": "number"
+            },
+            "Combat": {
+              "type": "number"
+            },
+            "Empire": {
+              "type": "number"
+            },
+            "Exobiologist": {
+              "type": "number"
+            },
+            "Explore": {
+              "type": "number"
+            },
+            "Federation": {
+              "type": "number"
+            },
+            "Soldier": {
+              "type": "number"
+            },
+            "Trade": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "Combat",
+            "Trade",
+            "Explore",
+            "Soldier",
+            "Exobiologist",
+            "CQC",
+            "Federation",
+            "Empire"
+          ],
+          "type": "object"
+        },
+        "ranksVerbose": {
+          "additionalProperties": false,
+          "properties": {
+            "CQC": {
+              "type": "string"
+            },
+            "Combat": {
+              "type": "string"
+            },
+            "Empire": {
+              "type": "string"
+            },
+            "Exobiologist": {
+              "type": "string"
+            },
+            "Explore": {
+              "type": "string"
+            },
+            "Federation": {
+              "type": "string"
+            },
+            "Soldier": {
+              "type": "string"
+            },
+            "Trade": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "Combat",
+            "Trade",
+            "Explore",
+            "Soldier",
+            "Exobiologist",
+            "CQC",
+            "Federation",
+            "Empire"
+          ],
+          "type": "object"
+        }
+      },
+      "required": [
+        "ranks",
+        "progress",
+        "ranksVerbose"
+      ],
+      "type": "object"
+    }
+  }
+}

package/lib/elite-server-status-response.schema.json

@@ -0,0 +1,38 @@
+{
+  "$ref": "#/definitions/EliteServerStatusResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "EliteServerStatusResponse": {
+      "additionalProperties": false,
+      "properties": {
+        "lastUpdate": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "status": {
+          "type": "number"
+        },
+        "type": {
+          "$ref": "#/definitions/EliteServerStatusType"
+        }
+      },
+      "required": [
+        "lastUpdate",
+        "type",
+        "message",
+        "status"
+      ],
+      "type": "object"
+    },
+    "EliteServerStatusType": {
+      "enum": [
+        "success",
+        "warning",
+        "danger"
+      ],
+      "type": "string"
+    }
+  }
+}

package/lib/flight-logs-response.schema.json

@@ -0,0 +1,68 @@
+{
+  "$ref": "#/definitions/FlightLogsResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "FlightLog": {
+      "additionalProperties": false,
+      "properties": {
+        "date": {
+          "type": "string"
+        },
+        "firstDiscover": {
+          "type": "boolean"
+        },
+        "shipId": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "system": {
+          "type": "string"
+        },
+        "systemId": {
+          "type": "number"
+        },
+        "systemId64": {
+          "$ref": "#/definitions/Id64"
+        }
+      },
+      "required": [
+        "shipId",
+        "system",
+        "firstDiscover",
+        "date"
+      ],
+      "type": "object"
+    },
+    "FlightLogsResponse": {
+      "additionalProperties": false,
+      "properties": {
+        "endDateTime": {
+          "type": "string"
+        },
+        "logs": {
+          "items": {
+            "$ref": "#/definitions/FlightLog"
+          },
+          "type": "array"
+        },
+        "startDateTime": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "startDateTime",
+        "endDateTime",
+        "logs"
+      ],
+      "type": "object"
+    },
+    "Id64": {
+      "description": "A 64 bit ID. Can be a `number` if ID does not need more then 53 bit. Must be `bigint` if ID needs more than 53 bit.",
+      "type": [
+        "number"
+      ]
+    }
+  }
+}

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

@@ -0,0 +1,96 @@
+/**
+ * Commander ranks response returned by {@link getCommanderRanks} request.
+ */
+export interface CommanderRanksResponse {
+    ranks: {
+        Combat: number;
+        Trade: number;
+        Explore: number;
+        Soldier: number;
+        Exobiologist: number;
+        CQC: number;
+        Federation: number;
+        Empire: number;
+    };
+    progress: {
+        Combat: number;
+        Trade: number;
+        Explore: number;
+        Soldier: number;
+        Exobiologist: number;
+        CQC: number;
+        Federation: number;
+        Empire: number;
+    };
+    ranksVerbose: {
+        Combat: string;
+        Trade: string;
+        Explore: string;
+        Soldier: string;
+        Exobiologist: string;
+        CQC: string;
+        Federation: string;
+        Empire: string;
+    };
+}
+/** Credits period type */
+export type CreditsPeriod = "7DAY" | "1MONTH" | "3MONTH" | "6MONTH";
+/**
+ * Commander credits response returned by {@link getCommanderCredits} request.
+ */
+export interface CommanderCreditsResponse {
+    credits: Array<{
+        balance: number;
+        loan: number;
+        date: string;
+    }>;
+    period?: CreditsPeriod;
+}
+/** Inventory type */
+export type InventoryType = "materials" | "data" | "cargo";
+/**
+ * Commander inventory response returned by {@link getCommanderInventory} request.
+ */
+export interface CommanderInventoryResponse {
+    materials?: Array<{
+        type: string | number;
+        name: string;
+        qty: number;
+    }>;
+    data?: Array<{
+        type: string | number;
+        name: string;
+        qty: number;
+    }>;
+    cargo?: Array<{
+        type: string | null;
+        name: string;
+        qty: number;
+    }>;
+}
+/**
+ * Returns commander ranks.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander. If not provided, ranks will only be returned if the commander
+ *                        has enabled his public profile.
+ * @returns The commander ranks.
+ */
+export declare function getCommanderRanks(commanderName: string, apiKey?: string): Promise<CommanderRanksResponse>;
+/**
+ * Returns commander credits.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander.
+ * @returns The commander credits.
+ */
+export declare function getCommanderCredits(commanderName: string, apiKey: string, period?: CreditsPeriod): Promise<CommanderCreditsResponse>;
+/**
+ * Returns commander inventory.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander.
+ * @param type          - The inventory type. Defaults to "materials".
+ * @returns The commander inventory.
+ */
+export declare function getCommanderInventory(commanderName: string, apiKey: string, type?: InventoryType): Promise<CommanderInventoryResponse>;

package/lib/main/api/commander.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { request } from "./common.js";
+/**
+ * Returns commander ranks.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander. If not provided, ranks will only be returned if the commander
+ *                        has enabled his public profile.
+ * @returns The commander ranks.
+ */
+export async function getCommanderRanks(commanderName, apiKey) {
+    return (await request("api-commander-v1/get-ranks", { commanderName, apiKey }));
+}
+/**
+ * Returns commander credits.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander.
+ * @returns The commander credits.
+ */
+export async function getCommanderCredits(commanderName, apiKey, period) {
+    return (await request("api-commander-v1/get-credits", { commanderName, apiKey, period }));
+}
+/**
+ * Returns commander inventory.
+ *
+ * @param commanderName - The name of the commander as registered on EDSM.
+ * @param apiKey        - The API key of the commander.
+ * @param type          - The inventory type. Defaults to "materials".
+ * @returns The commander inventory.
+ */
+export async function getCommanderInventory(commanderName, apiKey, type) {
+    return (await request("api-commander-v1/get-materials", { commanderName, apiKey, type }));
+}
+//# sourceMappingURL=commander.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commander.js","sourceRoot":"","sources":["../../../src/main/api/commander.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AA6EtC;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,aAAqB,EAAE,MAAe;IAC1E,OAAO,CAAC,MAAM,OAAO,CAAyB,4BAA4B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;AAC7G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,aAAqB,EAAE,MAAc,EAAE,MAAsB;IACnG,OAAO,CAAC,MAAM,OAAO,CAAC,8BAA8B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAE,CAAC;AAC/F,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,aAAqB,EAAE,MAAc,EAAE,IAAoB;IACnG,OAAO,CAAC,MAAM,OAAO,CAAC,gCAAgC,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAE,CAAC;AAC/F,CAAC"}

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

@@ -0,0 +1,28 @@
+import type { Id64 } from "../common.ts";
+import { EDSMException } from "../util.ts";
+export declare const edsmBaseUrl = "https://www.edsm.net";
+/**
+ * Request options for referencing a system via EDSM or Frontier ID instead of name. Needed when system name is not unique.
+ */
+export interface SystemIdRequestOptions {
+    /** The system ID if you seek for a duplicate system and want to force a specific ID. */
+    systemId?: number;
+    /** The system ID64 if you seek for a duplicate system and want to force a specific ID. */
+    systemId64?: Id64;
+}
+export declare class ServerException extends EDSMException {
+    readonly status: number;
+    constructor(status: number, message: string);
+}
+export declare class APIException extends EDSMException {
+    readonly status: number;
+    constructor(status: number, message: string);
+}
+/**
+ * Sends JSON request to the given URL with the given parameters and returns the response.
+ *
+ * @param params - Optional parameters.
+ * @returns The JSON result. Null when result was an empty object which for EDSM means "not found".
+ * @throws APIException - When request failed for some unknown reason.
+ */
+export declare function request<T>(url: string, params?: Record<string, unknown>): Promise<T | null>;

package/lib/main/api/common.js

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { JSONStringify } from "json-with-bigint";
+import { EDSMException, jsonReviver } from "../util.js";
+export const edsmBaseUrl = "https://www.edsm.net";
+export class ServerException extends EDSMException {
+    status;
+    constructor(status, message) {
+        super(message);
+        this.status = status;
+    }
+}
+export class APIException extends EDSMException {
+    status;
+    constructor(status, message) {
+        super(message);
+        this.status = status;
+    }
+}
+/**
+ * Sends JSON request to the given URL with the given parameters and returns the response.
+ *
+ * @param params - Optional parameters.
+ * @returns The JSON result. Null when result was an empty object which for EDSM means "not found".
+ * @throws APIException - When request failed for some unknown reason.
+ */
+export async function request(url, params = {}) {
+    const result = await fetch(`${edsmBaseUrl}/${url}`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSONStringify(params)
+    });
+    if (result.status !== 200) {
+        throw new ServerException(result.status, result.statusText);
+    }
+    const text = await result.text();
+    const json = JSON.parse(text, jsonReviver);
+    if (json.msgnum != null && json.msg != null) {
+        if (json.msgnum < 100 || json.msgnum >= 200) {
+            throw new APIException(json.msgnum, json.msg);
+        }
+        else {
+            delete json.msgnum;
+            delete json.msg;
+        }
+    }
+    if (Object.keys(json).length === 0) {
+        return null;
+    }
+    return json;
+}
+//# sourceMappingURL=common.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/main/api/common.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAExD,MAAM,CAAC,MAAM,WAAW,GAAG,sBAAsB,CAAC;AAalD,MAAM,OAAO,eAAgB,SAAQ,aAAa;IAC9B,MAAM,CAAS;IAE/B,YAAmB,MAAc,EAAE,OAAe;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CACJ;AAED,MAAM,OAAO,YAAa,SAAQ,aAAa;IAC3B,MAAM,CAAS;IAE/B,YAAmB,MAAc,EAAE,OAAe;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CACJ;AAOD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAI,GAAW,EAAE,SAAkC,EAAE;IAC9E,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,WAAW,IAAI,GAAG,EAAE,EAAE;QAChD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;QAC/C,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;KAC9B,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAsB,CAAC;IAChE,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC1C,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,MAAM,CAAC;YACnB,OAAO,IAAI,CAAC,GAAG,CAAC;QACpB,CAAC;IACL,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}