Move to event emitters

Author: Bre77

.changeset/sparkly-showers-carry.md

@@ -0,0 +1,5 @@
+---
+"@teslemetry/api": minor
+---
+
+Refactor to use native event emitters, and add emitters for API get requests.

packages/api/examples/sse.ts

@@ -9,25 +9,23 @@ const { TESLEMETRY_ACCESS_TOKEN, TESLEMETRY_VIN } = config().parsed as Record<
   string
 >;
 async function main() {
-  const teslemetry = new Teslemetry(TESLEMETRY_ACCESS_TOKEN, "na");
+  const teslemetry = new Teslemetry(TESLEMETRY_ACCESS_TOKEN, { region: "na" });
 
   const sonic = teslemetry.getVehicle(TESLEMETRY_VIN);
 
   // Listen for battery level updates
   const l1 = sonic.sse.onSignal("ChargerVoltage", (x) => {
     console.log(`BChargerVoltage:`, x);
   });
-  const l2 = sonic.sse.on((x) => {
-    //console.log(`Sonic:`, x);
+  const l2 = sonic.sse.on("connectivity", (x) => {
+    console.log(`Sonic:`, x);
   });
-  const l3 = teslemetry.sse.on((x) => {
-    //console.log(`Enervything:`, x);
+  const l3 = sonic.sse.data.on("VehicleSpeed", (x) => {
+    console.log(`VehicleSpeed:`, x);
   });
   // Listen for connection status changes
-  const l4 = teslemetry.sse.onConnection((connected: boolean) => {
-    console.log(
-      `Stream connection status: ${connected ? "Connected" : "Disconnected"}`,
-    );
+  const l4 = teslemetry.sse.on("connect", () => {
+    console.log(`Stream connection status: Connected`);
   });
 
   // Connect to the stream
@@ -40,9 +38,8 @@ async function main() {
   process.on("SIGINT", () => {
     console.log("Disconnecting from Teslemetry Stream...");
     l1();
-    l2();
-    l3();
-    l4();
+    teslemetry.sse.removeAllListeners();
+    sonic.sse.removeAllListeners();
     teslemetry.sse.disconnect();
     process.exit(0);
   });

packages/api/src/TeslemetryApi.ts

@@ -15,8 +15,8 @@ import { TeslemetryVehicleApi } from "./TeslemetryVehicleApi.js";
 
 export class TeslemetryApi {
   private root: Teslemetry;
-  public _vehicles: Record<string, TeslemetryVehicleApi> = {};
-  public _energySites: Record<string, TeslemetryEnergyApi> = {};
+  public vehicles: Map<string, TeslemetryVehicleApi> = new Map();
+  public energySites: Map<number, TeslemetryEnergyApi> = new Map();
   public user: TeslemetryUserApi;
   public charging: TeslemetryChargingApi;
 
@@ -31,10 +31,10 @@ export class TeslemetryApi {
    * @returns The vehicle API instance for the specified VIN.
    */
   public getVehicle(vin: string) {
-    if (!this._vehicles[vin]) {
-      this._vehicles[vin] = new TeslemetryVehicleApi(this.root, vin);
+    if (!this.vehicles.has(vin)) {
+      new TeslemetryVehicleApi(this.root, vin);
     }
-    return this._vehicles[vin];
+    return this.vehicles.get(vin)!;
   }
 
   /**
@@ -43,10 +43,10 @@ export class TeslemetryApi {
    * @returns The energy site API instance for the specified ID.
    */
   public getEnergySite(id: number) {
-    if (!this._energySites[id]) {
-      this._energySites[id] = new TeslemetryEnergyApi(this.root, id);
+    if (!this.energySites.has(id)) {
+      new TeslemetryEnergyApi(this.root, id);
     }
-    return this._energySites[id];
+    return this.energySites.get(id)!;
   }
 
   /**
@@ -63,10 +63,10 @@ export class TeslemetryApi {
         this.getEnergySite(product.energy_site_id);
       }
     });
-    return { vehicles: this._vehicles, energySites: this._energySites };
+    return { vehicles: this.vehicles, energySites: this.energySites };
   }
 
-  public async fields() {
+  public async getFields() {
     const { data } = await getFieldsJson({ client: this.root.client });
     return data;
   }
@@ -76,7 +76,7 @@ export class TeslemetryApi {
    * @returns A promise that resolves to an object containing a `response` array and count.
    * Each item in the array is a product, which can be a vehicle or an energy site, and a `count` of the products.
    */
-  public async products() {
+  public async getProducts() {
     const { data } = await getApi1Products({ client: this.root.client });
     return data;
   }
@@ -95,7 +95,7 @@ export class TeslemetryApi {
    * @returns Promise to an object containing metadata about the account,
    * including user UID, region, scopes, and lists of vehicles and energy sites.
    */
-  public async metadata() {
+  public async getMetadata() {
     const { data } = await getApiMetadata({ client: this.root.client });
     return data;
   }
@@ -106,7 +106,7 @@ export class TeslemetryApi {
    * @returns Promise to an object containing lists of paired and unpaired VINs,
    * and detailed info for each vehicle.
    */
-  public async fleetStatus(vins: string[]) {
+  public async getFleetStatus(vins: string[]) {
     const { data } = await postApi1VehiclesFleetStatus({
       body: { vins },
       client: this.root.client,
@@ -119,7 +119,7 @@ export class TeslemetryApi {
    * @returns Promise to an object containing a list of vehicles,
    * pagination details, and a total count.
    */
-  public async vehicles() {
+  public async getVehicles() {
     const { data } = await getApi1Vehicles({ client: this.root.client });
     return data;
   }

packages/api/src/TeslemetryEnergyApi.ts

@@ -58,9 +58,14 @@ export class TeslemetryEnergyApi extends EventEmitter {
   public siteId: number;
 
   constructor(root: Teslemetry, siteId: number) {
+    if (root.api.energySites.has(siteId)) {
+      throw new Error("Energy site already exists");
+    }
     super();
     this.root = root;
     this.siteId = siteId;
+
+    root.api.energySites.set(siteId, this);
   }
 
   /**
@@ -218,18 +223,4 @@ export class TeslemetryEnergyApi extends EventEmitter {
     });
     return data;
   }
-
-  public onSiteInfo(
-    callback: (data: GetApi1EnergySitesByIdSiteInfoResponse) => void,
-  ): () => void {
-    this.on("siteInfo", callback);
-    return () => this.off("siteInfo", callback);
-  }
-
-  public onLiveStatus(
-    callback: (data: GetApi1EnergySitesByIdLiveStatusResponse) => void,
-  ): () => void {
-    this.on("liveStatus", callback);
-    return () => this.off("liveStatus", callback);
-  }
 }