@elite-dangerous-plugin-framework/journal 0.20260211.0 → 0.20260214.1

package/README.md

@@ -68,6 +68,49 @@ All events have two shared properties: `timestamp` and `event`. You can filter o
 ![Example image showing strong typing](README-src/strongTypingExample.png)
 ![Second example detailling that you do get the event's structure](README-src/strongTypingExample2.png)
 
+### BigInt Handling
+
+If you are using the `_BI` events and need to pass them to another consumer, you can make sure of `stringifyBigIntJSON` function on the default export.
+
+```ts
+import { stringifyBigIntJSON } from "@elite-dangerous-plugin-framework/journal";
+
+const value = {
+  hello: "world",
+  someFloat: 42.3,
+  someBigInt: 123n,
+};
+
+console.log(stringifyBigIntJSON(value));
+//  {
+//    "hello": "world",
+//    "someFloat": 42.3,
+//    "someBigInt": 123
+//  }
+//  (without minification)
+```
+
+#### Importing events
+
+The default import contains all names events, both "simple" events and big-int events. Alternatively, the following imports are scoped to either simple or bigint events:
+
+- `@elite-dangerous-plugin-framework/journal/generated/events`
+- `@elite-dangerous-plugin-framework/journal/generated/events.bi`
+
+```ts
+import { type UndockedEvent_BI } from "@elite-dangerous-plugin-framework/journal/generated/events.bi";
+import { type UndockedEvent } from "@elite-dangerous-plugin-framework/journal/generated/events";
+// or
+import {
+  type UndockedEvent_BI,
+  type UndockedEvent,
+} from "@elite-dangerous-plugin-framework/journal";
+
+function doSomethingWithUndockedEvent(ev: UndockedEvent_BI | UndockedEvent) {
+  // ...
+}
+```
+
 ## Versioning
 
 Other than the other packages that reside in the `@elite-dangerous-plugin-framework` namespace, this package uses calendar-versioning.

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

@@ -1,3 +1,4 @@
+//#region src/generated/AfmuRepairs.bi.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,10 +8,10 @@
  * 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;
+  Module: Module;
+  Module_Localised?: Module_Localised;
+  FullyRepaired: FullyRepaired;
+  Health: Health;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -25,7 +26,9 @@ type Health = number;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default AfmuRepairsEvent_BI;
+//#endregion
+export { AfmuRepairsEvent_BI };
+//# sourceMappingURL=AfmuRepairs.bi.d.ts.map

package/dist/generated/AfmuRepairs.d.ts

@@ -1,3 +1,4 @@
+//#region src/generated/AfmuRepairs.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,10 +8,10 @@
  * 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;
+  Module: Module;
+  Module_Localised?: Module_Localised;
+  FullyRepaired: FullyRepaired;
+  Health: Health;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -25,7 +26,9 @@ type Health = number;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default AfmuRepairsEvent;
+//#endregion
+export { AfmuRepairsEvent };
+//# sourceMappingURL=AfmuRepairs.d.ts.map

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

@@ -1,11 +1,12 @@
+//#region src/generated/AppliedToSquadron.bi.d.ts
 /**
  * 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;
+  SquadronID?: SquadronID;
+  SquadronName: SquadronName;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -18,7 +19,9 @@ type SquadronName = string;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default AppliedToSquadronEvent_BI;
+//#endregion
+export { AppliedToSquadronEvent_BI };
+//# sourceMappingURL=AppliedToSquadron.bi.d.ts.map

package/dist/generated/AppliedToSquadron.d.ts

@@ -1,11 +1,12 @@
+//#region src/generated/AppliedToSquadron.d.ts
 /**
  * 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;
+  SquadronID?: SquadronID;
+  SquadronName: SquadronName;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -18,7 +19,9 @@ type SquadronName = string;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default AppliedToSquadronEvent;
+//#endregion
+export { AppliedToSquadronEvent };
+//# sourceMappingURL=AppliedToSquadron.d.ts.map

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

@@ -1,3 +1,4 @@
+//#region src/generated/ApproachBody.bi.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,10 +8,10 @@
  * 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;
+  StarSystem: StarSystem;
+  SystemAddress: SystemAddress;
+  Body: Body;
+  BodyID: BodyID;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -25,7 +26,9 @@ type BodyID = bigint;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default ApproachBodyEvent_BI;
+//#endregion
+export { ApproachBodyEvent_BI };
+//# sourceMappingURL=ApproachBody.bi.d.ts.map

package/dist/generated/ApproachBody.d.ts

@@ -1,3 +1,4 @@
+//#region src/generated/ApproachBody.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,10 +8,10 @@
  * 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;
+  StarSystem: StarSystem;
+  SystemAddress: SystemAddress;
+  Body: Body;
+  BodyID: BodyID;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -25,7 +26,9 @@ type BodyID = number;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default ApproachBodyEvent;
+//#endregion
+export { ApproachBodyEvent };
+//# sourceMappingURL=ApproachBody.d.ts.map

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

@@ -1,3 +1,4 @@
+//#region src/generated/ApproachSettlement.bi.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,22 +8,22 @@
  * 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;
+  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
@@ -49,19 +50,21 @@ type Name2 = string;
 type Name_Localised1 = string;
 type Proportion = number;
 type StationEconomies = {
-    Name: Name2;
-    Name_Localised?: Name_Localised1;
-    Proportion: Proportion;
+  Name: Name2;
+  Name_Localised?: Name_Localised1;
+  Proportion: Proportion;
 }[];
 /**
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
 interface StationFaction {
-    Name: Name1;
-    FactionState?: FactionState;
+  Name: Name1;
+  FactionState?: FactionState;
 }
-export default ApproachSettlementEvent_BI;
+//#endregion
+export { ApproachSettlementEvent_BI };
+//# sourceMappingURL=ApproachSettlement.bi.d.ts.map

package/dist/generated/ApproachSettlement.d.ts

@@ -1,3 +1,4 @@
+//#region src/generated/ApproachSettlement.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,22 +8,22 @@
  * 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;
+  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
@@ -49,19 +50,21 @@ type Name2 = string;
 type Name_Localised1 = string;
 type Proportion = number;
 type StationEconomies = {
-    Name: Name2;
-    Name_Localised?: Name_Localised1;
-    Proportion: Proportion;
+  Name: Name2;
+  Name_Localised?: Name_Localised1;
+  Proportion: Proportion;
 }[];
 /**
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
 interface StationFaction {
-    Name: Name1;
-    FactionState?: FactionState;
+  Name: Name1;
+  FactionState?: FactionState;
 }
-export default ApproachSettlementEvent;
+//#endregion
+export { ApproachSettlementEvent };
+//# sourceMappingURL=ApproachSettlement.d.ts.map

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

@@ -1,3 +1,4 @@
+//#region src/generated/AsteroidCracked.bi.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,7 +8,7 @@
  * When written: when the player has broken up a ‘Motherlode’ asteroid for mining
  */
 type AsteroidCrackedEvent_BI = Event & {
-    Body: Body;
+  Body: Body;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -19,7 +20,9 @@ type Body = string;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default AsteroidCrackedEvent_BI;
+//#endregion
+export { AsteroidCrackedEvent_BI };
+//# sourceMappingURL=AsteroidCracked.bi.d.ts.map

package/dist/generated/AsteroidCracked.d.ts

@@ -1,3 +1,4 @@
+//#region src/generated/AsteroidCracked.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,7 +8,7 @@
  * When written: when the player has broken up a ‘Motherlode’ asteroid for mining
  */
 type AsteroidCrackedEvent = Event & {
-    Body: Body;
+  Body: Body;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -19,7 +20,9 @@ type Body = string;
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
-export default AsteroidCrackedEvent;
+//#endregion
+export { AsteroidCrackedEvent };
+//# sourceMappingURL=AsteroidCracked.d.ts.map

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

@@ -1,3 +1,4 @@
+//#region src/generated/Backpack.bi.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,10 +8,10 @@
  * Lists the contents of the backpack, in a separate backpack.json file
  */
 type BackpackEvent_BI = Event & {
-    Items?: Items;
-    Components?: Components;
-    Consumables?: Consumables;
-    Data?: Data;
+  Items?: Items;
+  Components?: Components;
+  Consumables?: Consumables;
+  Data?: Data;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -44,34 +45,36 @@ type Data = Data1[];
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
 interface Item {
-    Name: Name;
-    Name_Localised?: Name_Localised;
-    OwnerID: OwnerID;
-    MissionID?: MissionID;
-    Count: Count;
+  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;
+  Name: Name1;
+  OwnerID: OwnerID1;
+  Count: Count1;
+  Name_Localised?: Name_Localised1;
+  MissionID?: MissionID1;
 }
 interface Consumable {
-    Name: Name2;
-    Name_Localised?: Name_Localised2;
-    OwnerID: OwnerID2;
-    Count: Count2;
+  Name: Name2;
+  Name_Localised?: Name_Localised2;
+  OwnerID: OwnerID2;
+  Count: Count2;
 }
 interface Data1 {
-    Name: Name3;
-    OwnerID: OwnerID3;
-    MissionID?: MissionID2;
-    Count: Count3;
-    Name_Localised?: Name_Localised3;
+  Name: Name3;
+  OwnerID: OwnerID3;
+  MissionID?: MissionID2;
+  Count: Count3;
+  Name_Localised?: Name_Localised3;
 }
-export default BackpackEvent_BI;
+//#endregion
+export { BackpackEvent_BI };
+//# sourceMappingURL=Backpack.bi.d.ts.map

package/dist/generated/Backpack.d.ts

@@ -1,3 +1,4 @@
+//#region src/generated/Backpack.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,10 +8,10 @@
  * Lists the contents of the backpack, in a separate backpack.json file
  */
 type BackpackEvent = Event & {
-    Items?: Items;
-    Components?: Components;
-    Consumables?: Consumables;
-    Data?: Data;
+  Items?: Items;
+  Components?: Components;
+  Consumables?: Consumables;
+  Data?: Data;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -44,34 +45,36 @@ type Data = Data1[];
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
 interface Item {
-    Name: Name;
-    Name_Localised?: Name_Localised;
-    OwnerID: OwnerID;
-    MissionID?: MissionID;
-    Count: Count;
+  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;
+  Name: Name1;
+  OwnerID: OwnerID1;
+  Count: Count1;
+  Name_Localised?: Name_Localised1;
+  MissionID?: MissionID1;
 }
 interface Consumable {
-    Name: Name2;
-    Name_Localised?: Name_Localised2;
-    OwnerID: OwnerID2;
-    Count: Count2;
+  Name: Name2;
+  Name_Localised?: Name_Localised2;
+  OwnerID: OwnerID2;
+  Count: Count2;
 }
 interface Data1 {
-    Name: Name3;
-    OwnerID: OwnerID3;
-    MissionID?: MissionID2;
-    Count: Count3;
-    Name_Localised?: Name_Localised3;
+  Name: Name3;
+  OwnerID: OwnerID3;
+  MissionID?: MissionID2;
+  Count: Count3;
+  Name_Localised?: Name_Localised3;
 }
-export default BackpackEvent;
+//#endregion
+export { BackpackEvent };
+//# sourceMappingURL=Backpack.d.ts.map

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

@@ -1,3 +1,4 @@
+//#region src/generated/BackpackChange.bi.d.ts
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -7,8 +8,8 @@
  * 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;
+  Added?: Added;
+  Removed?: Removed;
 };
 /**
  * Timestamp in UTC, ISO 8601
@@ -27,15 +28,17 @@ type Removed = ChangeEntry[];
  * Generic Event
  */
 interface Event {
-    timestamp: Timestamp;
-    event: Event1;
+  timestamp: Timestamp;
+  event: Event1;
 }
 interface ChangeEntry {
-    Name: Name;
-    Name_Localised?: Name_Localised;
-    OwnerID: OwnerID;
-    Count: Count;
-    Type: Type;
-    MissionID?: MissionID;
+  Name: Name;
+  Name_Localised?: Name_Localised;
+  OwnerID: OwnerID;
+  Count: Count;
+  Type: Type;
+  MissionID?: MissionID;
 }
-export default BackpackChangeEvent_BI;
+//#endregion
+export { BackpackChangeEvent_BI };
+//# sourceMappingURL=BackpackChange.bi.d.ts.map