@kayahr/ed-journal/lib/shiplocker.schema.json

Typescript library to read/watch the player journal of Frontier's game Elite Dangerous

{
  "$ref": "#/definitions/ShipLocker",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "ID": {
      "description": "ID numbers in Elite Dangerous may be very large, exceeding the 53 bit range of JavaScript number type. So IDs are treated like both, number and bigint. The JSON parser automatically creates bigint values for ID properties when the value exceeds the safe integer range.",
      "type": "integer"
    },
    "ShipLocker": {
      "additionalProperties": false,
      "description": "Lists the contents of the ship locker, eg at startup. The full list is written into the journal at startup (if in a ship) and when boarding a ship. For other updates the ship locker has to be watched separately.",
      "properties": {
        "Components": {
          "items": {
            "$ref": "#/definitions/ShipLockerItem"
          },
          "type": "array"
        },
        "Consumables": {
          "items": {
            "$ref": "#/definitions/ShipLockerItem"
          },
          "type": "array"
        },
        "Data": {
          "items": {
            "$ref": "#/definitions/ShipLockerItem"
          },
          "type": "array"
        },
        "Items": {
          "items": {
            "$ref": "#/definitions/ShipLockerItem"
          },
          "type": "array"
        },
        "event": {
          "const": "ShipLocker",
          "description": "The type of event.",
          "type": "string"
        },
        "timestamp": {
          "description": "The time in GMT, ISO 8601.",
          "type": "string"
        }
      },
      "required": [
        "event",
        "timestamp"
      ],
      "type": "object"
    },
    "ShipLockerItem": {
      "additionalProperties": false,
      "properties": {
        "Count": {
          "type": "number"
        },
        "MissionID": {
          "$ref": "#/definitions/ID"
        },
        "Name": {
          "type": "string"
        },
        "Name_Localised": {
          "type": "string"
        },
        "OwnerID": {
          "$ref": "#/definitions/ID"
        }
      },
      "required": [
        "Name",
        "OwnerID",
        "Count"
      ],
      "type": "object"
    }
  }
}