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

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

{
  "$ref": "#/definitions/Cargo",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "Cargo": {
      "additionalProperties": false,
      "description": "Written slightly later in startup after missions are initialized so cargo coming from an abandoned delivery mission can be detected.\n\nThe first Cargo event in the file will contain the full inventory.\n\nA simple event (with no Inventory property) is written to the main journal file when the cargo file is updated.",
      "properties": {
        "Count": {
          "description": "The total number of items.",
          "type": "number"
        },
        "Inventory": {
          "description": "Array of cargo. Not set when Cargo.json file was written instead.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "Count": {
                "description": "The number of items.",
                "type": "number"
              },
              "MissionID": {
                "$ref": "#/definitions/ID",
                "description": "ID of the mission the item belongs to."
              },
              "Name": {
                "description": "The item name.",
                "type": "string"
              },
              "Name_Localised": {
                "description": "Optional localized item name.",
                "type": "string"
              },
              "Stolen": {
                "description": "How many of the items are stolen.",
                "type": "number"
              }
            },
            "required": [
              "Name",
              "Count"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "Vessel": {
          "$ref": "#/definitions/CargoVessel",
          "description": "Ship or SRV"
        },
        "event": {
          "const": "Cargo",
          "description": "The type of event.",
          "type": "string"
        },
        "timestamp": {
          "description": "The time in GMT, ISO 8601.",
          "type": "string"
        }
      },
      "required": [
        "event",
        "timestamp"
      ],
      "type": "object"
    },
    "CargoVessel": {
      "description": "The vessel for which the cargo event is written.",
      "enum": [
        "Ship",
        "SRV"
      ],
      "type": "string"
    },
    "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"
    }
  }
}