@elite-dangerous-plugin-framework/journal 0.20250914.0

package/README.md

@@ -0,0 +1,6 @@
+# Elite Dangerous Journal Schemas
+
+This module contains autogenerated Type definitions for the Elite: Dangerous Journal.
+This uses https://jixxed.github.io/ed-journal-schemas/ as its source of Schemas.
+
+Besides the Type definitions, this module contains 2 helper functions which will parse the Journal Entry with either BigInts or regular IEEE 754 64-bit floats for integers.

package/dist/generated/AfmuRepairs.bi.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when repairing modules using the Auto Field Maintenance Unit (AFMU)
+ */
+type AfmuRepairsEvent_BI = Event & {
+    Module: Module;
+    Module_Localised?: Module_Localised;
+    FullyRepaired: FullyRepaired;
+    Health: Health;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "AfmuRepairs";
+type Module = string;
+type Module_Localised = string;
+type FullyRepaired = boolean;
+type Health = number;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default AfmuRepairsEvent_BI;

package/dist/generated/AfmuRepairs.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when repairing modules using the Auto Field Maintenance Unit (AFMU)
+ */
+type AfmuRepairsEvent = Event & {
+    Module: Module;
+    Module_Localised?: Module_Localised;
+    FullyRepaired: FullyRepaired;
+    Health: Health;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "AfmuRepairs";
+type Module = string;
+type Module_Localised = string;
+type FullyRepaired = boolean;
+type Health = number;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default AfmuRepairsEvent;

package/dist/generated/AppliedToSquadron.bi.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+type AppliedToSquadronEvent_BI = Event & {
+    SquadronID?: SquadronID;
+    SquadronName: SquadronName;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "AppliedToSquadron";
+type SquadronID = bigint;
+type SquadronName = string;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default AppliedToSquadronEvent_BI;

package/dist/generated/AppliedToSquadron.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+type AppliedToSquadronEvent = Event & {
+    SquadronID?: SquadronID;
+    SquadronName: SquadronName;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "AppliedToSquadron";
+type SquadronID = number;
+type SquadronName = string;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default AppliedToSquadronEvent;

package/dist/generated/ApproachBody.bi.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when in Supercruise, and distance from planet drops to within the 'Orbital Cruise' zone
+ */
+type ApproachBodyEvent_BI = Event & {
+    StarSystem: StarSystem;
+    SystemAddress: SystemAddress;
+    Body: Body;
+    BodyID: BodyID;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "ApproachBody";
+type StarSystem = string;
+type SystemAddress = bigint;
+type Body = string;
+type BodyID = bigint;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default ApproachBodyEvent_BI;

package/dist/generated/ApproachBody.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when in Supercruise, and distance from planet drops to within the 'Orbital Cruise' zone
+ */
+type ApproachBodyEvent = Event & {
+    StarSystem: StarSystem;
+    SystemAddress: SystemAddress;
+    Body: Body;
+    BodyID: BodyID;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "ApproachBody";
+type StarSystem = string;
+type SystemAddress = number;
+type Body = string;
+type BodyID = number;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default ApproachBodyEvent;

package/dist/generated/ApproachSettlement.bi.d.ts

@@ -0,0 +1,67 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when approaching a planetary settlement
+ */
+type ApproachSettlementEvent_BI = Event & {
+    Name: Name;
+    MarketID?: MarketID;
+    SystemAddress: SystemAddress;
+    BodyID: BodyID;
+    BodyName: BodyName;
+    Latitude?: Latitude;
+    Longitude?: Longitude;
+    Name_Localised?: Name_Localised;
+    StationFaction?: StationFaction;
+    StationGovernment?: StationGovernment;
+    StationGovernment_Localised?: StationGovernment_Localised;
+    StationAllegiance?: StationAllegiance;
+    StationServices?: StationServices;
+    StationEconomy?: StationEconomy;
+    StationEconomy_Localised?: StationEconomy_Localised;
+    StationEconomies?: StationEconomies;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "ApproachSettlement";
+type Name = string;
+type MarketID = bigint;
+type SystemAddress = bigint;
+type BodyID = bigint;
+type BodyName = string;
+type Latitude = number;
+type Longitude = number;
+type Name_Localised = string;
+type Name1 = string;
+type FactionState = string;
+type StationGovernment = string;
+type StationGovernment_Localised = string;
+type StationAllegiance = string;
+type StationServices = string[];
+type StationEconomy = string;
+type StationEconomy_Localised = string;
+type Name2 = string;
+type Name_Localised1 = string;
+type Proportion = number;
+type StationEconomies = {
+    Name: Name2;
+    Name_Localised?: Name_Localised1;
+    Proportion: Proportion;
+}[];
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+interface StationFaction {
+    Name: Name1;
+    FactionState?: FactionState;
+}
+export default ApproachSettlementEvent_BI;

package/dist/generated/ApproachSettlement.d.ts

@@ -0,0 +1,67 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when approaching a planetary settlement
+ */
+type ApproachSettlementEvent = Event & {
+    Name: Name;
+    MarketID?: MarketID;
+    SystemAddress: SystemAddress;
+    BodyID: BodyID;
+    BodyName: BodyName;
+    Latitude?: Latitude;
+    Longitude?: Longitude;
+    Name_Localised?: Name_Localised;
+    StationFaction?: StationFaction;
+    StationGovernment?: StationGovernment;
+    StationGovernment_Localised?: StationGovernment_Localised;
+    StationAllegiance?: StationAllegiance;
+    StationServices?: StationServices;
+    StationEconomy?: StationEconomy;
+    StationEconomy_Localised?: StationEconomy_Localised;
+    StationEconomies?: StationEconomies;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "ApproachSettlement";
+type Name = string;
+type MarketID = number;
+type SystemAddress = number;
+type BodyID = number;
+type BodyName = string;
+type Latitude = number;
+type Longitude = number;
+type Name_Localised = string;
+type Name1 = string;
+type FactionState = string;
+type StationGovernment = string;
+type StationGovernment_Localised = string;
+type StationAllegiance = string;
+type StationServices = string[];
+type StationEconomy = string;
+type StationEconomy_Localised = string;
+type Name2 = string;
+type Name_Localised1 = string;
+type Proportion = number;
+type StationEconomies = {
+    Name: Name2;
+    Name_Localised?: Name_Localised1;
+    Proportion: Proportion;
+}[];
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+interface StationFaction {
+    Name: Name1;
+    FactionState?: FactionState;
+}
+export default ApproachSettlementEvent;

package/dist/generated/AsteroidCracked.bi.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when the player has broken up a ‘Motherlode’ asteroid for mining
+ */
+type AsteroidCrackedEvent_BI = Event & {
+    Body: Body;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "AsteroidCracked";
+type Body = string;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default AsteroidCrackedEvent_BI;

package/dist/generated/AsteroidCracked.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * When written: when the player has broken up a ‘Motherlode’ asteroid for mining
+ */
+type AsteroidCrackedEvent = Event & {
+    Body: Body;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "AsteroidCracked";
+type Body = string;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default AsteroidCrackedEvent;

package/dist/generated/Backpack.bi.d.ts

@@ -0,0 +1,77 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * Lists the contents of the backpack, in a separate backpack.json file
+ */
+type BackpackEvent_BI = Event & {
+    Items?: Items;
+    Components?: Components;
+    Consumables?: Consumables;
+    Data?: Data;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "Backpack";
+type Name = string;
+type Name_Localised = string;
+type OwnerID = number;
+type MissionID = number;
+type Count = number;
+type Items = Item[];
+type Name1 = string;
+type OwnerID1 = number;
+type Count1 = number;
+type Name_Localised1 = string;
+type MissionID1 = number;
+type Components = Component[];
+type Name2 = string;
+type Name_Localised2 = string;
+type OwnerID2 = number;
+type Count2 = number;
+type Consumables = Consumable[];
+type Name3 = string;
+type OwnerID3 = number;
+type MissionID2 = number;
+type Count3 = number;
+type Name_Localised3 = string;
+type Data = Data1[];
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+interface Item {
+    Name: Name;
+    Name_Localised?: Name_Localised;
+    OwnerID: OwnerID;
+    MissionID?: MissionID;
+    Count: Count;
+}
+interface Component {
+    Name: Name1;
+    OwnerID: OwnerID1;
+    Count: Count1;
+    Name_Localised?: Name_Localised1;
+    MissionID?: MissionID1;
+}
+interface Consumable {
+    Name: Name2;
+    Name_Localised?: Name_Localised2;
+    OwnerID: OwnerID2;
+    Count: Count2;
+}
+interface Data1 {
+    Name: Name3;
+    OwnerID: OwnerID3;
+    MissionID?: MissionID2;
+    Count: Count3;
+    Name_Localised?: Name_Localised3;
+}
+export default BackpackEvent_BI;

package/dist/generated/Backpack.d.ts

@@ -0,0 +1,77 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * Lists the contents of the backpack, in a separate backpack.json file
+ */
+type BackpackEvent = Event & {
+    Items?: Items;
+    Components?: Components;
+    Consumables?: Consumables;
+    Data?: Data;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "Backpack";
+type Name = string;
+type Name_Localised = string;
+type OwnerID = number;
+type MissionID = number;
+type Count = number;
+type Items = Item[];
+type Name1 = string;
+type OwnerID1 = number;
+type Count1 = number;
+type Name_Localised1 = string;
+type MissionID1 = number;
+type Components = Component[];
+type Name2 = string;
+type Name_Localised2 = string;
+type OwnerID2 = number;
+type Count2 = number;
+type Consumables = Consumable[];
+type Name3 = string;
+type OwnerID3 = number;
+type MissionID2 = number;
+type Count3 = number;
+type Name_Localised3 = string;
+type Data = Data1[];
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+interface Item {
+    Name: Name;
+    Name_Localised?: Name_Localised;
+    OwnerID: OwnerID;
+    MissionID?: MissionID;
+    Count: Count;
+}
+interface Component {
+    Name: Name1;
+    OwnerID: OwnerID1;
+    Count: Count1;
+    Name_Localised?: Name_Localised1;
+    MissionID?: MissionID1;
+}
+interface Consumable {
+    Name: Name2;
+    Name_Localised?: Name_Localised2;
+    OwnerID: OwnerID2;
+    Count: Count2;
+}
+interface Data1 {
+    Name: Name3;
+    OwnerID: OwnerID3;
+    MissionID?: MissionID2;
+    Count: Count3;
+    Name_Localised?: Name_Localised3;
+}
+export default BackpackEvent;

package/dist/generated/BackpackChange.bi.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * This is written when there is any change to the contents of the suit backpack – note this can be written at the same time as other events like UseConsumable
+ */
+type BackpackChangeEvent_BI = Event & {
+    Added?: Added;
+    Removed?: Removed;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "BackpackChange";
+type Name = string;
+type Name_Localised = string;
+type OwnerID = bigint;
+type Count = bigint;
+type Type = string;
+type MissionID = bigint;
+type Added = ChangeEntry[];
+type Removed = ChangeEntry[];
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+interface ChangeEntry {
+    Name: Name;
+    Name_Localised?: Name_Localised;
+    OwnerID: OwnerID;
+    Count: Count;
+    Type: Type;
+    MissionID?: MissionID;
+}
+export default BackpackChangeEvent_BI;

package/dist/generated/BackpackChange.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * This is written when there is any change to the contents of the suit backpack – note this can be written at the same time as other events like UseConsumable
+ */
+type BackpackChangeEvent = Event & {
+    Added?: Added;
+    Removed?: Removed;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "BackpackChange";
+type Name = string;
+type Name_Localised = string;
+type OwnerID = number;
+type Count = number;
+type Type = string;
+type MissionID = number;
+type Added = ChangeEntry[];
+type Removed = ChangeEntry[];
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+interface ChangeEntry {
+    Name: Name;
+    Name_Localised?: Name_Localised;
+    OwnerID: OwnerID;
+    Count: Count;
+    Type: Type;
+    MissionID?: MissionID;
+}
+export default BackpackChangeEvent;

package/dist/generated/BookDropship.bi.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * This event is logged when signing up to fight at a recruitment desk
+ */
+type BookDropshipEvent_BI = Event & {
+    Retreat?: Retreat;
+    Cost: Cost;
+    DestinationSystem: DestinationSystem;
+    DestinationLocation: DestinationLocation;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "BookDropship";
+type Retreat = boolean;
+type Cost = bigint;
+type DestinationSystem = string;
+type DestinationLocation = string;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default BookDropshipEvent_BI;

package/dist/generated/BookDropship.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * This event is logged when signing up to fight at a recruitment desk
+ */
+type BookDropshipEvent = Event & {
+    Retreat?: Retreat;
+    Cost: Cost;
+    DestinationSystem: DestinationSystem;
+    DestinationLocation: DestinationLocation;
+};
+/**
+ * Timestamp in UTC, ISO 8601
+ */
+type Timestamp = string;
+type Event1 = "BookDropship";
+type Retreat = boolean;
+type Cost = number;
+type DestinationSystem = string;
+type DestinationLocation = string;
+/**
+ * Generic Event
+ */
+interface Event {
+    timestamp: Timestamp;
+    event: Event1;
+}
+export default BookDropshipEvent;