@kayahr/edsm 1.1.0

package/lib/main/stations.d.ts

@@ -0,0 +1,69 @@
+import type { Id64 } from "./common.ts";
+export interface StationControllingFaction {
+    id: number | null;
+    name: string | null;
+}
+export interface StationBody {
+    id: number;
+    name: string;
+    latitude?: number;
+    longitude?: number;
+}
+export interface StationUpdateTime {
+    information: string;
+    market: string | null;
+    shipyard: string | null;
+    outfitting: string | null;
+}
+export interface Outfitting {
+    id: string | null;
+    name: string;
+}
+export interface Commodity {
+    id: string | null;
+    name: string;
+    buyPrice: number;
+    stock: number;
+    sellPrice: number;
+    demand: number;
+    stockBracket: number;
+}
+export interface Ship {
+    id: number;
+    name: string;
+}
+export interface Station {
+    id: number;
+    marketId: number | null;
+    type: string | null;
+    name: string;
+    body?: StationBody;
+    distanceToArrival: number | null;
+    allegiance: string | null;
+    government: string | null;
+    economy: string | null;
+    secondEconomy: string | null;
+    haveMarket: boolean;
+    haveShipyard: boolean;
+    haveOutfitting: boolean;
+    otherServices: string[];
+    controllingFaction?: StationControllingFaction;
+    updateTime: StationUpdateTime;
+    systemId?: number;
+    systemId64?: Id64 | null;
+    systemName?: string;
+    commodities: Commodity[] | null;
+    ships: Ship[] | null;
+    outfitting: Outfitting[] | null;
+}
+/** Station data in system objects with less details. */
+export type SystemStation = Omit<Station, "systemId" | "systemId64" | "systemName" | "outfitting" | "ships" | "commodities">;
+/** List of EDSM stations. */
+export type Stations = Station[];
+/**
+ * Parses stations from the given JSON stream.
+ *
+ * @param stream - The JSON input stream.
+ * @returns Stream of stations.
+ */
+export declare function parseStationsJSON(stream: AsyncIterable<Uint8Array>): AsyncIterable<Station>;

package/lib/main/stations.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { parseJSONArray } from "./util.js";
+/**
+ * Parses stations from the given JSON stream.
+ *
+ * @param stream - The JSON input stream.
+ * @returns Stream of stations.
+ */
+export function parseStationsJSON(stream) {
+    return parseJSONArray(stream);
+}
+//# sourceMappingURL=stations.js.map

package/lib/main/stations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stations.js","sourceRoot":"","sources":["../../src/main/stations.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAwE3C;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAiC;IAC/D,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC"}

package/lib/main/systems.d.ts

@@ -0,0 +1,61 @@
+import type { SystemBody } from "./bodies.ts";
+import type { Coordinates, Id64 } from "./common.ts";
+import type { SystemStation } from "./stations.ts";
+export interface EstimatedCoordinates extends Coordinates {
+    precision: number;
+}
+export interface ControllingFaction {
+    id: number;
+    name: string | null;
+    allegiance?: string;
+    government?: string;
+    isPlayer: boolean;
+}
+export interface State {
+    state: string;
+}
+export interface TrendState extends State {
+    trend: number;
+}
+export interface Faction {
+    id: number;
+    name: string;
+    allegiance?: string | null;
+    government?: string | null;
+    influence: number;
+    state: string | null;
+    activeStates: State[];
+    recoveringStates: TrendState[];
+    pendingStates: TrendState[];
+    happiness: string;
+    isPlayer: boolean;
+    lastUpdate: number;
+}
+/** A single EDSM system. */
+export interface System {
+    name: string;
+    id: number;
+    id64: Id64 | null;
+    date: string;
+    coords?: Coordinates;
+    estimatedCoordinates?: EstimatedCoordinates;
+    allegiance?: string | null;
+    government?: string | null;
+    state?: string | null;
+    economy?: string | null;
+    security?: string;
+    population?: number | null;
+    controllingFaction?: ControllingFaction;
+    factions?: Faction[];
+    stations?: SystemStation[];
+    bodies?: SystemBody[];
+}
+/** List of EDSM systems. */
+export type Systems = System[];
+/**
+ * Parses systems from the given JSON stream.
+ *
+ * @param stream - The JSON input stream.
+ * @returns Stream of systems.
+ */
+export declare function parseSystemsJSON(stream: AsyncIterable<Uint8Array>): AsyncIterable<System>;

package/lib/main/systems.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+import { parseJSONArray } from "./util.js";
+/**
+ * Parses systems from the given JSON stream.
+ *
+ * @param stream - The JSON input stream.
+ * @returns Stream of systems.
+ */
+export function parseSystemsJSON(stream) {
+    return parseJSONArray(stream);
+}
+//# sourceMappingURL=systems.js.map

package/lib/main/systems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systems.js","sourceRoot":"","sources":["../../src/main/systems.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AA4D3C;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAiC;IAC9D,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC"}

package/lib/main/util.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Base class for all exceptions. Automatically corrects its prototype and name.
+ */
+export declare abstract class EDSMException extends Error {
+    /**
+     * Creates a new exception.
+     *
+     * @param message - The exception message.
+     * @param options - Optional error options.
+     */
+    constructor(message: string, options?: ErrorOptions);
+}
+/** Thrown when state is illegal. */
+export declare class IllegalStateException extends EDSMException {
+}
+/** Thrown when some resource was not found. */
+export declare class NotFoundException extends EDSMException {
+}
+/**
+ * Helper function to iterate over the array entries of the given stream. The stream must be a JSON file with an array
+ * bracket in the first and last line and all other lines must contain a single dataset each. So it's actually a JSONL
+ * file but wrapped in an array and with comma character suffixes.
+ *
+ * @param stream    - The JSON input as an async iterable.
+ * @yields The created iterable for iterating over the array entries of the JSON stream.
+ */
+export declare function parseJSONArray<T>(stream: AsyncIterable<Uint8Array>): AsyncIterable<T>;
+/**
+ * JSON reviver function which converts numbers of ID properties (property names ending with 'ID' or 'Address') to bigint if needed.
+ *
+ * @param key     - The JSON property key.
+ * @param value   - The parsed JSON property value.
+ * @param context - The reviver context containing the raw JSON source string.
+ * @returns The already parsed JSON property value if suitable or the raw source converted into a bigint.
+ */
+export declare function jsonReviver(key: string, value: unknown, context?: {
+    source: string;
+}): unknown;

package/lib/main/util.js

@@ -0,0 +1,104 @@
+/*
+ * Copyright (C) 2020 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+/**
+ * Base class for all exceptions. Automatically corrects its prototype and name.
+ */
+export class EDSMException extends Error {
+    /**
+     * Creates a new exception.
+     *
+     * @param message - The exception message.
+     * @param options - Optional error options.
+     */
+    constructor(message, options) {
+        super(message, options);
+        this.name = this.constructor.name;
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+/** Thrown when state is illegal. */
+export class IllegalStateException extends EDSMException {
+}
+/** Thrown when some resource was not found. */
+export class NotFoundException extends EDSMException {
+}
+/**
+ * Helper function to iterate over the lines of a data stream.
+ *
+ * @param stream - The input stream.
+ * @yields The created iterable for iterating over the lines of the stream.
+ */
+async function* parseLines(stream) {
+    let line = "";
+    const decoder = new TextDecoder();
+    for await (const chunk of stream) {
+        const data = decoder.decode(chunk);
+        const parts = data.split("\n");
+        const numParts = parts.length;
+        for (let i = 0; i < numParts; i++) {
+            line += parts[i];
+            if (i < numParts - 1) {
+                yield line;
+                line = "";
+            }
+        }
+    }
+    if (line !== "") {
+        yield line;
+    }
+}
+/**
+ * Helper function to iterate over the array entries of the given stream. The stream must be a JSON file with an array
+ * bracket in the first and last line and all other lines must contain a single dataset each. So it's actually a JSONL
+ * file but wrapped in an array and with comma character suffixes.
+ *
+ * @param stream    - The JSON input as an async iterable.
+ * @yields The created iterable for iterating over the array entries of the JSON stream.
+ */
+export async function* parseJSONArray(stream) {
+    let inData = false;
+    for await (let line of parseLines(stream)) {
+        if (!inData) {
+            if (line === "[") {
+                inData = true;
+            }
+            else {
+                throw new IllegalStateException(`Expected array start but got: ${line}`);
+            }
+        }
+        else {
+            if (line === "]") {
+                inData = false;
+            }
+            else {
+                if (line.endsWith(",")) {
+                    line = line.substring(0, line.length - 1);
+                }
+                yield JSON.parse(line, jsonReviver);
+            }
+        }
+    }
+}
+/**
+ * JSON reviver function which converts numbers of ID properties (property names ending with 'ID' or 'Address') to bigint if needed.
+ *
+ * @param key     - The JSON property key.
+ * @param value   - The parsed JSON property value.
+ * @param context - The reviver context containing the raw JSON source string.
+ * @returns The already parsed JSON property value if suitable or the raw source converted into a bigint.
+ */
+export function jsonReviver(key, value, context) {
+    if (context != null && typeof value === "number" && (value > Number.MAX_SAFE_INTEGER || value < Number.MIN_SAFE_INTEGER)) {
+        const source = context.source;
+        if (key === "id64" || key === "systemId64") {
+            return BigInt(source);
+        }
+        else if (String(value) !== source && /^[-+]?\d+$/.test(source)) {
+            throw new IllegalStateException(`Value of property '${key}' looks like a bigint (${source}) but was parsed as an imprecise number (${value})`);
+        }
+    }
+    return value;
+}
+//# sourceMappingURL=util.js.map

package/lib/main/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/main/util.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,OAAgB,aAAc,SAAQ,KAAK;IAC7C;;;;;OAKG;IACH,YAAmB,OAAe,EAAE,OAAsB;QACtD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;CACJ;AAED,oCAAoC;AACpC,MAAM,OAAO,qBAAsB,SAAQ,aAAa;CAAG;AAE3D,+CAA+C;AAC/C,MAAM,OAAO,iBAAkB,SAAQ,aAAa;CAAG;AAEvD;;;;;GAKG;AACH,KAAK,SAAU,CAAC,CAAA,UAAU,CAAC,MAAiC;IACxD,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;YAChC,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,GAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,CAAC;gBACX,IAAI,GAAG,EAAE,CAAC;YACd,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QACd,MAAM,IAAI,CAAC;IACf,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,SAAU,CAAC,CAAA,cAAc,CAAI,MAAiC;IACtE,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,KAAK,EAAE,IAAI,IAAI,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACf,MAAM,GAAG,IAAI,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,qBAAqB,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;YAC7E,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACf,MAAM,GAAG,KAAK,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACrB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAC9C,CAAC;gBACD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACxC,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,KAAc,EAAE,OAA4B;IACjF,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,gBAAgB,IAAI,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACvH,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;YACzC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;aAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,qBAAqB,CAAC,sBAAsB,GAAG,0BAA0B,MAAM,4CAA4C,KAAK,GAAG,CAAC,CAAC;QACnJ,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/lib/powerplay.schema.json

@@ -0,0 +1,90 @@
+{
+  "$ref": "#/definitions/PowerPlay",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "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"
+      ]
+    },
+    "PowerPlay": {
+      "additionalProperties": false,
+      "description": "Single EDSM power play information.",
+      "properties": {
+        "allegiance": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "coords": {
+          "$ref": "#/definitions/Coordinates"
+        },
+        "date": {
+          "type": "string"
+        },
+        "government": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "power": {
+          "type": "string"
+        },
+        "powerState": {
+          "type": "string"
+        },
+        "state": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "power",
+        "powerState",
+        "id",
+        "id64",
+        "name",
+        "coords",
+        "allegiance",
+        "government",
+        "state",
+        "date"
+      ],
+      "type": "object"
+    }
+  }
+}

package/lib/station-market-response.schema.json

@@ -0,0 +1,95 @@
+{
+  "$ref": "#/definitions/StationMarketResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "Commodity": {
+      "additionalProperties": false,
+      "properties": {
+        "buyPrice": {
+          "type": "number"
+        },
+        "demand": {
+          "type": "number"
+        },
+        "id": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "name": {
+          "type": "string"
+        },
+        "sellPrice": {
+          "type": "number"
+        },
+        "stock": {
+          "type": "number"
+        },
+        "stockBracket": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "buyPrice",
+        "stock",
+        "sellPrice",
+        "demand",
+        "stockBracket"
+      ],
+      "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"
+      ]
+    },
+    "StationMarketResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system stations market request.",
+      "properties": {
+        "commodities": {
+          "items": {
+            "$ref": "#/definitions/Commodity"
+          },
+          "type": "array"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "marketId": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        },
+        "sId": {
+          "type": "number"
+        },
+        "sName": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "marketId",
+        "sId",
+        "sName",
+        "url",
+        "commodities"
+      ],
+      "type": "object"
+    }
+  }
+}

package/lib/station-outfitting-response.schema.json

@@ -0,0 +1,75 @@
+{
+  "$ref": "#/definitions/StationOutfittingResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "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"
+      ]
+    },
+    "Outfitting": {
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "name"
+      ],
+      "type": "object"
+    },
+    "StationOutfittingResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system stations outfitting request.",
+      "properties": {
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "marketId": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        },
+        "outfitting": {
+          "items": {
+            "$ref": "#/definitions/Outfitting"
+          },
+          "type": "array"
+        },
+        "sId": {
+          "type": "number"
+        },
+        "sName": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "marketId",
+        "sId",
+        "sName",
+        "url",
+        "outfitting"
+      ],
+      "type": "object"
+    }
+  }
+}

package/lib/station-shipyard-response.schema.json

@@ -0,0 +1,72 @@
+{
+  "$ref": "#/definitions/StationShipyardResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "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"
+      ]
+    },
+    "Ship": {
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "name"
+      ],
+      "type": "object"
+    },
+    "StationShipyardResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system stations shipyard request.",
+      "properties": {
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "marketId": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        },
+        "sId": {
+          "type": "number"
+        },
+        "sName": {
+          "type": "string"
+        },
+        "ships": {
+          "items": {
+            "$ref": "#/definitions/Ship"
+          },
+          "type": "array"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "marketId",
+        "sId",
+        "sName",
+        "url",
+        "ships"
+      ],
+      "type": "object"
+    }
+  }
+}