@kayahr/edsm 1.1.0

package/lib/system-estimated-value-response.schema.json

@@ -0,0 +1,76 @@
+{
+  "$ref": "#/definitions/SystemEstimatedValueResponse",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "BodyScanValue": {
+      "additionalProperties": false,
+      "properties": {
+        "bodyId": {
+          "type": "number"
+        },
+        "bodyName": {
+          "type": "string"
+        },
+        "distance": {
+          "type": "number"
+        },
+        "valueMax": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "bodyId",
+        "bodyName",
+        "distance",
+        "valueMax"
+      ],
+      "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"
+      ]
+    },
+    "SystemEstimatedValueResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system estimated value request.",
+      "properties": {
+        "estimatedValue": {
+          "type": "number"
+        },
+        "estimatedValueMapped": {
+          "type": "number"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        },
+        "valuableBodies": {
+          "items": {
+            "$ref": "#/definitions/BodyScanValue"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "url",
+        "estimatedValue",
+        "estimatedValueMapped",
+        "valuableBodies"
+      ],
+      "type": "object"
+    }
+  }
+}

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

@@ -0,0 +1,313 @@
+{
+  "$ref": "#/definitions/SystemFactionsResponse",
+  "$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"
+      ]
+    },
+    "Record<string,number>": {
+      "additionalProperties": {
+        "type": "number"
+      },
+      "type": "object"
+    },
+    "Record<string,string>": {
+      "additionalProperties": {
+        "type": "string"
+      },
+      "type": "object"
+    },
+    "Record<string,structure-1543834377-6047-6077-1543834377-6040-6078-1543834377-6025-6079-1543834377-6025-6084-1543834377-5999-6085-1543834377-5740-6601-1543834377-0-8642[]>": {
+      "additionalProperties": {
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "state": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "state"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "type": "object"
+    },
+    "Record<string,structure-1543834377-6222-6276-1543834377-6215-6277-1543834377-6200-6278-1543834377-6200-6283-1543834377-6170-6284-1543834377-5740-6601-1543834377-0-8642[]>": {
+      "additionalProperties": {
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "state": {
+              "type": "string"
+            },
+            "trend": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "state"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "type": "object"
+    },
+    "Record<string,structure-1543834377-6415-6469-1543834377-6408-6470-1543834377-6393-6471-1543834377-6393-6476-1543834377-6366-6477-1543834377-5740-6601-1543834377-0-8642[]>": {
+      "additionalProperties": {
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "state": {
+              "type": "string"
+            },
+            "trend": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "state"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "type": "object"
+    },
+    "ShortSystemFaction": {
+      "additionalProperties": false,
+      "properties": {
+        "allegiance": {
+          "type": "string"
+        },
+        "government": {
+          "type": "string"
+        },
+        "id": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "allegiance",
+        "government"
+      ],
+      "type": "object"
+    },
+    "SystemFaction": {
+      "additionalProperties": false,
+      "properties": {
+        "activeStates": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "state": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "state"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "activeStatesHistory": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Record%3Cstring%2Cstructure-1543834377-6047-6077-1543834377-6040-6078-1543834377-6025-6079-1543834377-6025-6084-1543834377-5999-6085-1543834377-5740-6601-1543834377-0-8642%5B%5D%3E"
+            },
+            {
+              "maxItems": 0,
+              "minItems": 0,
+              "type": "array"
+            }
+          ]
+        },
+        "allegiance": {
+          "type": "string"
+        },
+        "government": {
+          "type": "string"
+        },
+        "happiness": {
+          "type": "string"
+        },
+        "happinessHistory": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Record%3Cstring%2Cstring%3E"
+            },
+            {
+              "maxItems": 0,
+              "minItems": 0,
+              "type": "array"
+            }
+          ]
+        },
+        "id": {
+          "type": "number"
+        },
+        "influence": {
+          "type": "number"
+        },
+        "influenceHistory": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Record%3Cstring%2Cnumber%3E"
+            },
+            {
+              "maxItems": 0,
+              "minItems": 0,
+              "type": "array"
+            }
+          ]
+        },
+        "isPlayer": {
+          "type": "boolean"
+        },
+        "lastUpdate": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        },
+        "pendingStates": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "state": {
+                "type": "string"
+              },
+              "trend": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "state"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "pendingStatesHistory": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Record%3Cstring%2Cstructure-1543834377-6415-6469-1543834377-6408-6470-1543834377-6393-6471-1543834377-6393-6476-1543834377-6366-6477-1543834377-5740-6601-1543834377-0-8642%5B%5D%3E"
+            },
+            {
+              "maxItems": 0,
+              "minItems": 0,
+              "type": "array"
+            }
+          ]
+        },
+        "recoveringStates": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "state": {
+                "type": "string"
+              },
+              "trend": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "state"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "recoveringStatesHistory": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Record%3Cstring%2Cstructure-1543834377-6222-6276-1543834377-6215-6277-1543834377-6200-6278-1543834377-6200-6283-1543834377-6170-6284-1543834377-5740-6601-1543834377-0-8642%5B%5D%3E"
+            },
+            {
+              "maxItems": 0,
+              "minItems": 0,
+              "type": "array"
+            }
+          ]
+        },
+        "state": {
+          "type": "string"
+        },
+        "stateHistory": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/Record%3Cstring%2Cstring%3E"
+            },
+            {
+              "maxItems": 0,
+              "minItems": 0,
+              "type": "array"
+            }
+          ]
+        }
+      },
+      "required": [
+        "activeStates",
+        "allegiance",
+        "government",
+        "happiness",
+        "id",
+        "influence",
+        "isPlayer",
+        "lastUpdate",
+        "name",
+        "pendingStates",
+        "recoveringStates",
+        "state"
+      ],
+      "type": "object"
+    },
+    "SystemFactionsResponse": {
+      "additionalProperties": false,
+      "description": "Response structure of the EDSM system factions request.",
+      "properties": {
+        "controllingFaction": {
+          "$ref": "#/definitions/ShortSystemFaction"
+        },
+        "factions": {
+          "items": {
+            "$ref": "#/definitions/SystemFaction"
+          },
+          "type": "array"
+        },
+        "id": {
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "id64",
+        "name",
+        "url",
+        "factions"
+      ],
+      "type": "object"
+    }
+  }
+}

package/lib/system-response.schema.json

@@ -0,0 +1,137 @@
+{
+  "$ref": "#/definitions/SystemResponse",
+  "$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"
+      ]
+    },
+    "SystemResponse": {
+      "additionalProperties": false,
+      "description": "Response of a  {@link  getSystem }  request.",
+      "properties": {
+        "coords": {
+          "additionalProperties": false,
+          "description": "The coordinates of the system. Only present when  {@link  SystemRequestOptions#showCoordinates  }  option is set to 1.",
+          "properties": {
+            "x": {
+              "type": "number"
+            },
+            "y": {
+              "type": "number"
+            },
+            "z": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "x",
+            "y",
+            "z"
+          ],
+          "type": "object"
+        },
+        "coordsLocked": {
+          "description": "True when exact coords are known. False when position is trilaterated. Only present when  {@link  SystemRequestOptions#showCoordinates  }  option is set to 1",
+          "type": "boolean"
+        },
+        "duplicates": {
+          "description": "The systems ID having the exact same name in the game. Only present when there are duplicated and  {@link  SystemRequestOptions#showId  }  option is set to 1.",
+          "items": {
+            "type": "number"
+          },
+          "type": "array"
+        },
+        "hidden_at": {
+          "description": "The time when the system was hidden. Only present when system is hidden and  {@link  SystemRequestOptions#includeHidden  }  is set to 1",
+          "type": "string"
+        },
+        "id": {
+          "description": "The EDSM ID of the system. Only present when  {@link  SystemRequestOptions#showId  }  option is set to 1.",
+          "type": "number"
+        },
+        "id64": {
+          "$ref": "#/definitions/Id64",
+          "description": "The Frontier ID of the system. Only present when  {@link  SystemRequestOptions#showId  }  option is set to 1."
+        },
+        "information": {
+          "additionalProperties": false,
+          "description": "System information. Only present when  {@link  SystemRequestOptions#showInformation  }  option is set to 1.",
+          "properties": {
+            "allegiance": {
+              "type": "string"
+            },
+            "economy": {
+              "type": "string"
+            },
+            "faction": {
+              "type": "string"
+            },
+            "factionState": {
+              "type": "string"
+            },
+            "government": {
+              "type": "string"
+            },
+            "population": {
+              "type": "number"
+            },
+            "reserve": {
+              "type": "string"
+            },
+            "secondEconomy": {
+              "type": "string"
+            },
+            "security": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "mergedTo": {
+          "description": "The system ID this system was merged to. Only present when system was merged and,   {@link  SystemRequestOptions#includeHidden  }  is set to 1 and  {@link  SystemRequestOptions#showId  }  is also set to 1.",
+          "type": "number"
+        },
+        "name": {
+          "description": "The name of the system.",
+          "type": "string"
+        },
+        "permitName": {
+          "description": "Permit name if any. Only present when  {@link  SystemRequestOptions#showPermit  }  option is set to 1.",
+          "type": "string"
+        },
+        "primaryStar": {
+          "additionalProperties": false,
+          "description": "Information about the primary star if any. Only present when  {@link  SystemRequestOptions#showPrimaryStar  }  option is set to 1.",
+          "properties": {
+            "isScoopable": {
+              "type": "boolean"
+            },
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "type",
+            "name",
+            "isScoopable"
+          ],
+          "type": "object"
+        },
+        "requirePermit": {
+          "description": "Permit information. Only present when  {@link  SystemRequestOptions#showPermit  }  option is set to 1.",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "type": "object"
+    }
+  }
+}