@kayahr/edsm 1.1.0

package/lib/system-bodies-response.schema.json

@@ -0,0 +1,609 @@
+{
+  "$ref": "#/definitions/SystemBodiesResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "Asteroids": {
+      "additionalProperties": false,
+      "description": "EDSM data about asteroid ring/belt.",
+      "properties": {
+        "innerRadius": {
+          "type": "number"
+        },
+        "mass": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        },
+        "outerRadius": {
+          "type": "number"
+        },
+        "type": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "mass",
+        "innerRadius",
+        "outerRadius"
+      ],
+      "type": "object"
+    },
+    "AtmosphereComposition": {
+      "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E",
+      "description": "EDSM data about atmosphere composition of a planet."
+    },
+    "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"
+      ]
+    },
+    "Materials": {
+      "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E",
+      "description": "EDSM data about raw materials on a planet."
+    },
+    "Omit<Planet,(\"systemId\"|\"systemId64\"|\"systemName\")>": {
+      "$ref": "#/definitions/Pick%3CPlanet%2CExclude%3C(%22type%22%7C%22isLandable%22%7C%22gravity%22%7C%22earthMasses%22%7C%22radius%22%7C%22surfacePressure%22%7C%22volcanismType%22%7C%22atmosphereType%22%7C%22atmosphereComposition%22%7C%22solidComposition%22%7C%22terraformingState%22%7C%22materials%22%7C%22id%22%7C%22id64%22%7C%22bodyId%22%7C%22systemId%22%7C%22systemId64%22%7C%22systemName%22%7C%22name%22%7C%22discovery%22%7C%22subType%22%7C%22parents%22%7C%22distanceToArrival%22%7C%22surfaceTemperature%22%7C%22orbitalPeriod%22%7C%22semiMajorAxis%22%7C%22orbitalEccentricity%22%7C%22orbitalInclination%22%7C%22argOfPeriapsis%22%7C%22rotationalPeriod%22%7C%22rotationalPeriodTidallyLocked%22%7C%22axialTilt%22%7C%22rings%22%7C%22reserveLevel%22%7C%22belts%22%7C%22updateTime%22)%2C(%22systemId%22%7C%22systemId64%22%7C%22systemName%22)%3E%3E"
+    },
+    "Omit<Star,(\"systemId\"|\"systemId64\"|\"systemName\")>": {
+      "$ref": "#/definitions/Pick%3CStar%2CExclude%3C(%22type%22%7C%22isMainStar%22%7C%22isScoopable%22%7C%22age%22%7C%22spectralClass%22%7C%22luminosity%22%7C%22absoluteMagnitude%22%7C%22solarMasses%22%7C%22solarRadius%22%7C%22surfaceTemperature%22%7C%22id%22%7C%22id64%22%7C%22bodyId%22%7C%22systemId%22%7C%22systemId64%22%7C%22systemName%22%7C%22name%22%7C%22discovery%22%7C%22subType%22%7C%22parents%22%7C%22distanceToArrival%22%7C%22orbitalPeriod%22%7C%22semiMajorAxis%22%7C%22orbitalEccentricity%22%7C%22orbitalInclination%22%7C%22argOfPeriapsis%22%7C%22rotationalPeriod%22%7C%22rotationalPeriodTidallyLocked%22%7C%22axialTilt%22%7C%22rings%22%7C%22reserveLevel%22%7C%22belts%22%7C%22updateTime%22)%2C(%22systemId%22%7C%22systemId64%22%7C%22systemName%22)%3E%3E"
+    },
+    "Pick<Planet,Exclude<(\"type\"|\"isLandable\"|\"gravity\"|\"earthMasses\"|\"radius\"|\"surfacePressure\"|\"volcanismType\"|\"atmosphereType\"|\"atmosphereComposition\"|\"solidComposition\"|\"terraformingState\"|\"materials\"|\"id\"|\"id64\"|\"bodyId\"|\"systemId\"|\"systemId64\"|\"systemName\"|\"name\"|\"discovery\"|\"subType\"|\"parents\"|\"distanceToArrival\"|\"surfaceTemperature\"|\"orbitalPeriod\"|\"semiMajorAxis\"|\"orbitalEccentricity\"|\"orbitalInclination\"|\"argOfPeriapsis\"|\"rotationalPeriod\"|\"rotationalPeriodTidallyLocked\"|\"axialTilt\"|\"rings\"|\"reserveLevel\"|\"belts\"|\"updateTime\"),(\"systemId\"|\"systemId64\"|\"systemName\")>>": {
+      "additionalProperties": false,
+      "properties": {
+        "argOfPeriapsis": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "atmosphereComposition": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/AtmosphereComposition"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "atmosphereType": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "axialTilt": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "belts": {
+          "items": {
+            "$ref": "#/definitions/Asteroids"
+          },
+          "type": "array"
+        },
+        "bodyId": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "discovery": {
+          "additionalProperties": false,
+          "properties": {
+            "commander": {
+              "type": "string"
+            },
+            "date": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "commander",
+            "date"
+          ],
+          "type": "object"
+        },
+        "distanceToArrival": {
+          "type": "number"
+        },
+        "earthMasses": {
+          "type": "number"
+        },
+        "gravity": {
+          "type": "number"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Id64"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "isLandable": {
+          "type": "boolean"
+        },
+        "materials": {
+          "$ref": "#/definitions/Materials"
+        },
+        "name": {
+          "type": "string"
+        },
+        "orbitalEccentricity": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "orbitalInclination": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "orbitalPeriod": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "parents": {
+          "anyOf": [
+            {
+              "type": "null"
+            },
+            {
+              "items": {
+                "anyOf": [
+                  {
+                    "additionalProperties": false,
+                    "properties": {
+                      "Star": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "Star"
+                    ],
+                    "type": "object"
+                  },
+                  {
+                    "additionalProperties": false,
+                    "properties": {
+                      "Planet": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "Planet"
+                    ],
+                    "type": "object"
+                  },
+                  {
+                    "additionalProperties": false,
+                    "properties": {
+                      "Null": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "Null"
+                    ],
+                    "type": "object"
+                  }
+                ]
+              },
+              "type": "array"
+            }
+          ]
+        },
+        "radius": {
+          "type": "number"
+        },
+        "reserveLevel": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "rings": {
+          "items": {
+            "$ref": "#/definitions/Asteroids"
+          },
+          "type": "array"
+        },
+        "rotationalPeriod": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "rotationalPeriodTidallyLocked": {
+          "type": "boolean"
+        },
+        "semiMajorAxis": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "solidComposition": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SolidComposition"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "subType": {
+          "type": "string"
+        },
+        "surfacePressure": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "surfaceTemperature": {
+          "type": "number"
+        },
+        "terraformingState": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "type": {
+          "const": "Planet",
+          "type": "string"
+        },
+        "updateTime": {
+          "type": "string"
+        },
+        "volcanismType": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "type",
+        "isLandable",
+        "gravity",
+        "earthMasses",
+        "radius",
+        "surfacePressure",
+        "volcanismType",
+        "atmosphereType",
+        "atmosphereComposition",
+        "solidComposition",
+        "terraformingState",
+        "id",
+        "id64",
+        "bodyId",
+        "name",
+        "subType",
+        "parents",
+        "distanceToArrival",
+        "surfaceTemperature",
+        "orbitalPeriod",
+        "semiMajorAxis",
+        "orbitalEccentricity",
+        "orbitalInclination",
+        "argOfPeriapsis",
+        "rotationalPeriod",
+        "rotationalPeriodTidallyLocked",
+        "axialTilt",
+        "updateTime"
+      ],
+      "type": "object"
+    },
+    "Pick<Star,Exclude<(\"type\"|\"isMainStar\"|\"isScoopable\"|\"age\"|\"spectralClass\"|\"luminosity\"|\"absoluteMagnitude\"|\"solarMasses\"|\"solarRadius\"|\"surfaceTemperature\"|\"id\"|\"id64\"|\"bodyId\"|\"systemId\"|\"systemId64\"|\"systemName\"|\"name\"|\"discovery\"|\"subType\"|\"parents\"|\"distanceToArrival\"|\"orbitalPeriod\"|\"semiMajorAxis\"|\"orbitalEccentricity\"|\"orbitalInclination\"|\"argOfPeriapsis\"|\"rotationalPeriod\"|\"rotationalPeriodTidallyLocked\"|\"axialTilt\"|\"rings\"|\"reserveLevel\"|\"belts\"|\"updateTime\"),(\"systemId\"|\"systemId64\"|\"systemName\")>>": {
+      "additionalProperties": false,
+      "properties": {
+        "absoluteMagnitude": {
+          "type": "number"
+        },
+        "age": {
+          "type": "number"
+        },
+        "argOfPeriapsis": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "axialTilt": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "belts": {
+          "items": {
+            "$ref": "#/definitions/Asteroids"
+          },
+          "type": "array"
+        },
+        "bodyId": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "discovery": {
+          "additionalProperties": false,
+          "properties": {
+            "commander": {
+              "type": "string"
+            },
+            "date": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "commander",
+            "date"
+          ],
+          "type": "object"
+        },
+        "distanceToArrival": {
+          "type": "number"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Id64"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "isMainStar": {
+          "type": "boolean"
+        },
+        "isScoopable": {
+          "type": "boolean"
+        },
+        "luminosity": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "name": {
+          "type": "string"
+        },
+        "orbitalEccentricity": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "orbitalInclination": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "orbitalPeriod": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "parents": {
+          "anyOf": [
+            {
+              "type": "null"
+            },
+            {
+              "items": {
+                "anyOf": [
+                  {
+                    "additionalProperties": false,
+                    "properties": {
+                      "Star": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "Star"
+                    ],
+                    "type": "object"
+                  },
+                  {
+                    "additionalProperties": false,
+                    "properties": {
+                      "Planet": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "Planet"
+                    ],
+                    "type": "object"
+                  },
+                  {
+                    "additionalProperties": false,
+                    "properties": {
+                      "Null": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "Null"
+                    ],
+                    "type": "object"
+                  }
+                ]
+              },
+              "type": "array"
+            }
+          ]
+        },
+        "reserveLevel": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "rings": {
+          "items": {
+            "$ref": "#/definitions/Asteroids"
+          },
+          "type": "array"
+        },
+        "rotationalPeriod": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "rotationalPeriodTidallyLocked": {
+          "type": "boolean"
+        },
+        "semiMajorAxis": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "solarMasses": {
+          "type": "number"
+        },
+        "solarRadius": {
+          "type": "number"
+        },
+        "spectralClass": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "subType": {
+          "type": "string"
+        },
+        "surfaceTemperature": {
+          "type": "number"
+        },
+        "type": {
+          "const": "Star",
+          "type": "string"
+        },
+        "updateTime": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "type",
+        "age",
+        "spectralClass",
+        "luminosity",
+        "absoluteMagnitude",
+        "solarMasses",
+        "solarRadius",
+        "surfaceTemperature",
+        "id",
+        "id64",
+        "bodyId",
+        "name",
+        "subType",
+        "parents",
+        "distanceToArrival",
+        "orbitalPeriod",
+        "semiMajorAxis",
+        "orbitalEccentricity",
+        "orbitalInclination",
+        "argOfPeriapsis",
+        "rotationalPeriod",
+        "rotationalPeriodTidallyLocked",
+        "axialTilt",
+        "updateTime"
+      ],
+      "type": "object"
+    },
+    "Record<string,number>": {
+      "additionalProperties": {
+        "type": "number"
+      },
+      "type": "object"
+    },
+    "SolidComposition": {
+      "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E",
+      "description": "EDSM data about solid composition of a planet."
+    },
+    "SystemBodiesResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system bodies request.",
+      "properties": {
+        "bodies": {
+          "items": {
+            "$ref": "#/definitions/SystemBody"
+          },
+          "type": "array"
+        },
+        "bodyCount": {
+          "type": "number"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "url",
+        "bodies",
+        "bodyCount"
+      ],
+      "type": "object"
+    },
+    "SystemBody": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/SystemStar"
+        },
+        {
+          "$ref": "#/definitions/SystemPlanet"
+        }
+      ],
+      "description": "Body within a system (without system information because its already in the parent object)"
+    },
+    "SystemPlanet": {
+      "$ref": "#/definitions/Omit%3CPlanet%2C(%22systemId%22%7C%22systemId64%22%7C%22systemName%22)%3E"
+    },
+    "SystemStar": {
+      "$ref": "#/definitions/Omit%3CStar%2C(%22systemId%22%7C%22systemId64%22%7C%22systemName%22)%3E"
+    }
+  }
+}

package/lib/system-deaths-response.schema.json

@@ -0,0 +1,58 @@
+{
+  "$ref": "#/definitions/SystemDeathsResponse",
+  "$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"
+      ]
+    },
+    "SystemDeathsResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system deaths request.",
+      "properties": {
+        "deaths": {
+          "additionalProperties": false,
+          "properties": {
+            "day": {
+              "type": "number"
+            },
+            "total": {
+              "type": "number"
+            },
+            "week": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "total",
+            "week",
+            "day"
+          ],
+          "type": "object"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "url",
+        "deaths"
+      ],
+      "type": "object"
+    }
+  }
+}