@teslemetry/api 0.3.0 → 0.5.0

package/dist/index.mjs

@@ -1,3 +1,5 @@
+import { EventEmitter } from "events";
+
 //#region src/client/core/bodySerializer.gen.ts
 const jsonBodySerializer = { bodySerializer: (body) => JSON.stringify(body, (_key, value) => typeof value === "bigint" ? value.toString() : value) };
 
@@ -790,23 +792,6 @@ const getApiRefreshByVin = (options) => (options.client ?? client).get({
 	...options
 });
 /**
-* Vehicle Image
-*
-* Redirect to the Tesla Design Studio image of a vehicle
-*/
-const getApiImageByVin = (options) => (options.client ?? client).get({
-	security: [{
-		scheme: "bearer",
-		type: "http"
-	}, {
-		in: "query",
-		name: "token",
-		type: "apiKey"
-	}],
-	url: "/api/image/{vin}",
-	...options
-});
-/**
 * Vehicle Data
 *
 * Returns the cached vehicle data for this vehicle. location_data will only be present if you have provided the location_data scope.
@@ -3004,23 +2989,27 @@ const getSseByVin_ = (options) => (options.client ?? client).sse.get({
 
 //#endregion
 //#region src/TeslemetryVehicleStream.ts
-var TeslemetryVehicleStream = class {
+var TeslemetryVehicleStream = class extends EventEmitter {
 	root;
-	stream;
 	vin;
 	fields = {};
 	_pendingFields = {};
 	_debounceTimeout = null;
 	logger;
-	constructor(root, stream, vin) {
+	data;
+	constructor(root, vin) {
+		if (root.sse.vehicles.has(vin)) throw new Error("Vehicle already exists");
+		super();
 		this.root = root;
-		this.stream = stream;
 		this.vin = vin;
-		this.logger = stream.logger;
-		stream.onConfig((event) => {
+		this.logger = root.sse.logger;
+		this.data = new EventEmitter();
+		root.sse.vehicles.set(vin, this);
+		this.on("config", (event) => {
 			this.fields = event.config.fields;
-		}, { vin: this.vin });
+		});
 	}
+	/** Get the current configuration for the vehicle */
 	async getConfig() {
 		const { data, response } = await getApiConfigByVin({ path: { vin: this.vin } });
 		if (response.status === 200 && data) this.fields = data.fields || {};
@@ -3029,7 +3018,8 @@ var TeslemetryVehicleStream = class {
 			return;
 		} else throw new Error(`Failed to get config: ${response.statusText}`);
 	}
-	updateFields(fields) {
+	/** Safely add field configuration to the vehicle */
+	async updateFields(fields) {
 		this._pendingFields = {
 			...this._pendingFields,
 			...fields
@@ -3048,6 +3038,7 @@ var TeslemetryVehicleStream = class {
 			this._debounceTimeout = null;
 		}, 100);
 	}
+	/** Modify the field configuration of the vehicle */
 	async patchConfig(fields) {
 		const { data } = await patchApiConfigByVin({
 			client: this.root.client,
@@ -3056,6 +3047,7 @@ var TeslemetryVehicleStream = class {
 		});
 		return data;
 	}
+	/** Replace the field configuration of the vehicle */
 	async postConfig(fields) {
 		const { data } = await postApiConfigByVin({
 			client: this.root.client,
@@ -3064,6 +3056,12 @@ var TeslemetryVehicleStream = class {
 		});
 		return data;
 	}
+	/**
+	* Add a field to the vehicles streaming configuration
+	* @param field Vehicle Signal
+	* @param interval
+	* @returns
+	*/
 	async addField(field, interval) {
 		if (this.fields && this.fields[field] && (interval === void 0 || this.fields[field].interval_seconds === interval)) {
 			this.logger.debug(`Streaming field ${field} already enabled @ ${this.fields[field]?.interval_seconds || "default"}s`);
@@ -3072,59 +3070,37 @@ var TeslemetryVehicleStream = class {
 		const value = interval !== void 0 ? { interval_seconds: interval } : null;
 		this.updateFields({ [field]: value });
 	}
-	onState(callback) {
-		return this.stream.onState(callback, { vin: this.vin });
-	}
-	onData(callback) {
-		return this.stream.onData(callback, { vin: this.vin });
-	}
-	onErrors(callback) {
-		return this.stream.onErrors(callback, { vin: this.vin });
-	}
-	onAlerts(callback) {
-		return this.stream.onAlerts(callback, { vin: this.vin });
-	}
-	onConnectivity(callback) {
-		return this.stream.onConnectivity(callback, { vin: this.vin });
-	}
-	onVehicleData(callback) {
-		return this.stream.onVehicleData(callback, { vin: this.vin });
-	}
-	onConfig(callback) {
-		return this.stream.onConfig(callback, { vin: this.vin });
-	}
-	on(callback) {
-		return this.stream.on((event) => {
-			callback(event);
-		}, { vin: this.vin });
-	}
+	/**
+	* Helper to enable and listen for specific field signals
+	* @param field Vehicle field to listen for
+	* @param callback Callback function to handle signals
+	* @returns Off function to stop the listener
+	*/
 	onSignal(field, callback) {
 		this.addField(field).catch((error) => {
 			this.logger.error(`Failed to add field ${field}:`, error);
 		});
-		return this.stream.onData((event) => {
-			const value = event.data[field];
-			if (value !== void 0) callback(value);
-		}, {
-			vin: this.vin,
-			data: { [field]: null }
-		});
+		this.data.on(field, callback);
+		return () => this.data.off(field, callback);
+	}
+	stop() {
+		this.removeAllListeners();
+		this.data.removeAllListeners();
 	}
 };
 
 //#endregion
 //#region src/TeslemetryStream.ts
-var TeslemetryStream = class {
+var TeslemetryStream = class extends EventEmitter {
 	root;
 	active = false;
 	connected = false;
 	vin;
 	cache;
 	logger;
-	listeners = /* @__PURE__ */ new Map();
-	_connectionListeners = /* @__PURE__ */ new Map();
 	vehicles = /* @__PURE__ */ new Map();
 	constructor(root, options) {
+		super();
 		this.root = root;
 		this.vin = options?.vin;
 		this.cache = options?.cache;
@@ -3132,7 +3108,7 @@ var TeslemetryStream = class {
 		if (this.vin) this.getVehicle(this.vin);
 	}
 	getVehicle(vin) {
-		if (!this.vehicles.has(vin)) this.vehicles.set(vin, new TeslemetryVehicleStream(this.root, this, vin));
+		if (!this.vehicles.has(vin)) new TeslemetryVehicleStream(this.root, vin);
 		return this.vehicles.get(vin);
 	}
 	async connect() {
@@ -3151,7 +3127,7 @@ var TeslemetryStream = class {
 			this.logger.info(`Connected to stream`);
 			retries = 0;
 			this.connected = true;
-			this._updateConnectionListeners(true);
+			this.emit("connect");
 			if (sse.stream) for await (const event of sse.stream) {
 				if (!this.active) break;
 				this._dispatch(event);
@@ -3160,13 +3136,13 @@ var TeslemetryStream = class {
 			if (!this.active) break;
 			this.logger.error("SSE error:", error);
 			this.connected = false;
-			this._updateConnectionListeners(false);
+			this.emit("disconnect");
 			retries++;
 			const delay = Math.min(2 ** retries, 600) * 1e3;
 			this.logger.info(`Reconnecting in ${delay / 1e3} seconds...`);
 			await new Promise((resolve) => setTimeout(resolve, delay));
 		}
-		this._updateConnectionListeners(false);
+		this.emit("disconnect");
 	}
 	disconnect() {
 		this.active = false;
@@ -3175,99 +3151,37 @@ var TeslemetryStream = class {
 	close() {
 		this.active = false;
 		this.logger.info(`Disconnecting from stream`);
-		this._updateConnectionListeners(false);
-	}
-	onConnection(callback) {
-		const removeListener = () => {
-			this._connectionListeners.delete(removeListener);
-		};
-		this._connectionListeners.set(removeListener, callback);
-		return removeListener;
-	}
-	onState(callback, filters) {
-		return this._createListener("state", callback, filters);
-	}
-	onData(callback, filters) {
-		return this._createListener("data", callback, filters);
-	}
-	onErrors(callback, filters) {
-		return this._createListener("errors", callback, filters);
-	}
-	onAlerts(callback, filters) {
-		return this._createListener("alerts", callback, filters);
-	}
-	onConnectivity(callback, filters) {
-		return this._createListener("connectivity", callback, filters);
-	}
-	onCredits(callback, filters) {
-		return this._createListener("credits", callback, filters);
 	}
-	onVehicleData(callback, filters) {
-		return this._createListener("vehicle_data", callback, filters);
-	}
-	onConfig(callback, filters) {
-		return this._createListener("config", callback, filters);
-	}
-	on(callback, filters) {
-		return this._createListener("all", callback, filters);
-	}
-	_updateConnectionListeners(value) {
-		for (const listener of this._connectionListeners.values()) listener(value);
-	}
-	_createListener(eventType, callback, filters) {
-		const entry = {
-			callback,
-			filters
-		};
-		if (!this.listeners.has(eventType)) this.listeners.set(eventType, /* @__PURE__ */ new Set());
-		this.listeners.get(eventType).add(entry);
-		return () => {
-			const set = this.listeners.get(eventType);
-			if (set) {
-				set.delete(entry);
-				if (set.size === 0) this.listeners.delete(eventType);
-			}
-		};
+	parseCreatedAt(event) {
+		const [main, ns] = event.createdAt.split(".");
+		const date = /* @__PURE__ */ new Date(main + "Z");
+		return new Date(date.getTime() + parseInt((ns || "000").substring(0, 3)));
 	}
 	_dispatch(event) {
-		if (event.createdAt && !event.timestamp) {
-			const [main, ns] = event.createdAt.split(".");
-			event.timestamp = (/* @__PURE__ */ new Date(main + "Z")).getTime() + parseInt((ns || "000").substring(0, 3));
-		}
-		const allListeners = this.listeners.get("all");
-		if (allListeners) {
-			for (const entry of allListeners) if (recursiveMatch(entry.filters, event)) entry.callback(event);
-		}
-		let eventType;
-		if ("state" in event) eventType = "state";
-		else if ("data" in event) eventType = "data";
-		else if ("errors" in event) eventType = "errors";
-		else if ("alerts" in event) eventType = "alerts";
-		else if ("networkInterface" in event) eventType = "connectivity";
-		else if ("credits" in event) eventType = "credits";
-		else if ("vehicle_data" in event) eventType = "vehicle_data";
-		else if ("config" in event) eventType = "config";
-		if (eventType) {
-			const set = this.listeners.get(eventType);
-			if (set) {
-				for (const entry of set) if (recursiveMatch(entry.filters, event)) entry.callback(event);
-			}
+		if ("state" in event) this.emit("state", event);
+		else if ("data" in event) this.emit("data", event);
+		else if ("errors" in event) this.emit("errors", event);
+		else if ("alerts" in event) this.emit("alerts", event);
+		else if ("networkInterface" in event) this.emit("connectivity", event);
+		else if ("credits" in event) this.emit("credits", event);
+		else if ("vehicle_data" in event) this.emit("vehicle_data", event);
+		else if ("config" in event) this.emit("config", event);
+		const vehicle = this.vehicles.get(event.vin);
+		if (vehicle) {
+			if ("state" in event) vehicle.emit("state", event);
+			else if ("data" in event) {
+				vehicle.emit("data", event);
+				Object.keys(event.data).forEach((key) => {
+					if (event.data[key] !== void 0) vehicle.data.emit(key, event.data[key]);
+				});
+			} else if ("errors" in event) vehicle.emit("errors", event);
+			else if ("alerts" in event) vehicle.emit("alerts", event);
+			else if ("networkInterface" in event) vehicle.emit("connectivity", event);
+			else if ("vehicle_data" in event) vehicle.emit("vehicle_data", event);
+			else if ("config" in event) vehicle.emit("config", event);
 		}
 	}
 };
-function recursiveMatch(filter, event) {
-	if (filter === null || filter === void 0) return true;
-	if (typeof filter !== "object" || filter === null || typeof event !== "object" || event === null) return filter === event;
-	if (Array.isArray(filter)) {
-		if (!Array.isArray(event)) return false;
-		return filter.some((fItem) => event.some((eItem) => recursiveMatch(fItem, eItem)));
-	}
-	for (const key in filter) {
-		if (!(key in event)) return false;
-		if (!recursiveMatch(filter[key], event[key])) return false;
-	}
-	return true;
-}
 
 //#endregion
 //#region src/TeslemetryChargingApi.ts
@@ -3328,12 +3242,24 @@ var TeslemetryChargingApi = class {
 
 //#endregion
 //#region src/TeslemetryEnergyApi.ts
-var TeslemetryEnergyApi = class {
+var TeslemetryEnergyApi = class extends EventEmitter {
 	root;
 	siteId;
+	refreshDelay = 3e4;
+	refreshInterval = {
+		siteInfo: null,
+		liveStatus: null
+	};
+	refreshClients = {
+		siteInfo: /* @__PURE__ */ new Set(),
+		liveStatus: /* @__PURE__ */ new Set()
+	};
 	constructor(root, siteId) {
+		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);
 	}
 	/**
 	* Adjust the site's backup reserve.
@@ -3395,6 +3321,7 @@ var TeslemetryEnergyApi = class {
 			path: { id: this.siteId },
 			client: this.root.client
 		});
+		this.emit("liveStatus", data);
 		return data;
 	}
 	/**
@@ -3406,6 +3333,7 @@ var TeslemetryEnergyApi = class {
 			path: { id: this.siteId },
 			client: this.root.client
 		});
+		this.emit("siteInfo", data);
 		return data;
 	}
 	/**
@@ -3467,6 +3395,34 @@ var TeslemetryEnergyApi = class {
 		});
 		return data;
 	}
+	requestPolling(endpoint) {
+		if (!this.refreshInterval[endpoint]) switch (endpoint) {
+			case "siteInfo":
+				this.refreshInterval[endpoint] = setInterval(() => {
+					this.getSiteInfo();
+				}, this.refreshDelay);
+				this.getSiteInfo();
+				break;
+			case "liveStatus":
+				this.refreshInterval[endpoint] = setInterval(() => {
+					this.getLiveStatus();
+				}, this.refreshDelay);
+				this.getLiveStatus();
+				break;
+			default: throw new Error(`Invalid endpoint: ${endpoint}`);
+		}
+		const symbol = Symbol("refreshClient");
+		this.refreshClients[endpoint].add(symbol);
+		return () => {
+			this.refreshClients[endpoint].delete(symbol);
+			if (this.refreshClients[endpoint].size === 0) {
+				if (this.refreshInterval[endpoint]) {
+					clearInterval(this.refreshInterval[endpoint]);
+					this.refreshInterval[endpoint] = null;
+				}
+			}
+		};
+	}
 };
 
 //#endregion
@@ -3538,12 +3494,15 @@ const ALL_SEATS = {
 	7: 7,
 	8: 8
 };
-var TeslemetryVehicleApi = class {
+var TeslemetryVehicleApi = class extends EventEmitter {
 	root;
 	vin;
 	constructor(root, vin) {
+		if (root.api.vehicles.has(vin)) throw new Error("Vehicle already exists");
+		super();
 		this.root = root;
 		this.vin = vin;
+		root.api.vehicles.set(vin, this);
 	}
 	/**
 	* Data about the vehicle.
@@ -3554,6 +3513,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("state", data);
 		return data;
 	}
 	/**
@@ -3571,6 +3531,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("vehicleData", data);
 		return data;
 	}
 	/**
@@ -3585,17 +3546,6 @@ var TeslemetryVehicleApi = class {
 		return data;
 	}
 	/**
-	* Redirect to the Tesla Design Studio image of a vehicle
-	* @return Promise to an object with response containing redirect information
-	*/
-	async getImage() {
-		const { data } = await getApiImageByVin({
-			path: { vin: this.vin },
-			client: this.root.client
-		});
-		return data;
-	}
-	/**
 	* Get the saved vehicle config.
 	* @return Promise to an object with response containing the vehicle configuration
 	*/
@@ -3604,6 +3554,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("vehicleConfig", data);
 		return data;
 	}
 	/**
@@ -3615,6 +3566,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("config", data);
 		return data;
 	}
 	/**
@@ -3663,6 +3615,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("mobileEnabled", data);
 		return data;
 	}
 	/**
@@ -3674,6 +3627,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("nearbyChargingSites", data);
 		return data;
 	}
 	/**
@@ -3685,6 +3639,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("recentAlerts", data);
 		return data;
 	}
 	/**
@@ -3696,6 +3651,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("releaseNotes", data);
 		return data;
 	}
 	/**
@@ -3707,6 +3663,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("serviceData", data);
 		return data;
 	}
 	/**
@@ -3740,6 +3697,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("fleetTelemetryConfig", data);
 		return data;
 	}
 	/**
@@ -3762,6 +3720,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("fleetTelemetryErrors", data);
 		return data;
 	}
 	/**
@@ -4626,6 +4585,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("drivers", data);
 		return data;
 	}
 	/**
@@ -4650,6 +4610,7 @@ var TeslemetryVehicleApi = class {
 			path: { vin: this.vin },
 			client: this.root.client
 		});
+		this.emit("invitations", data);
 		return data;
 	}
 	/**
@@ -4864,8 +4825,8 @@ var TeslemetryVehicleApi = class {
 //#region src/TeslemetryApi.ts
 var TeslemetryApi = class {
 	root;
-	_vehicles = {};
-	_energySites = {};
+	vehicles = /* @__PURE__ */ new Map();
+	energySites = /* @__PURE__ */ new Map();
 	user;
 	charging;
 	constructor(root) {
@@ -4879,8 +4840,8 @@ var TeslemetryApi = class {
 	* @returns The vehicle API instance for the specified VIN.
 	*/
 	getVehicle(vin) {
-		if (!this._vehicles[vin]) this._vehicles[vin] = new TeslemetryVehicleApi(this.root, vin);
-		return this._vehicles[vin];
+		if (!this.vehicles.has(vin)) new TeslemetryVehicleApi(this.root, vin);
+		return this.vehicles.get(vin);
 	}
 	/**
 	* Gets or creates an energy site API instance for the specified ID.
@@ -4888,8 +4849,8 @@ var TeslemetryApi = class {
 	* @returns The energy site API instance for the specified ID.
 	*/
 	getEnergySite(id) {
-		if (!this._energySites[id]) this._energySites[id] = new TeslemetryEnergyApi(this.root, id);
-		return this._energySites[id];
+		if (!this.energySites.has(id)) new TeslemetryEnergyApi(this.root, id);
+		return this.energySites.get(id);
 	}
 	/**
 	* Creates API instances for all products (vehicles and energy sites) associated with the account.
@@ -4902,11 +4863,11 @@ var TeslemetryApi = class {
 			if (product.device_type === "energy") this.getEnergySite(product.energy_site_id);
 		});
 		return {
-			vehicles: this._vehicles,
-			energySites: this._energySites
+			vehicles: this.vehicles,
+			energySites: this.energySites
 		};
 	}
-	async fields() {
+	async getFields() {
 		const { data } = await getFieldsJson({ client: this.root.client });
 		return data;
 	}
@@ -4915,7 +4876,7 @@ var TeslemetryApi = class {
 	* @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.
 	*/
-	async products() {
+	async getProducts() {
 		const { data } = await getApi1Products({ client: this.root.client });
 		return data;
 	}
@@ -4932,7 +4893,7 @@ var TeslemetryApi = class {
 	* @returns Promise to an object containing metadata about the account,
 	* including user UID, region, scopes, and lists of vehicles and energy sites.
 	*/
-	async metadata() {
+	async getMetadata() {
 		const { data } = await getApiMetadata({ client: this.root.client });
 		return data;
 	}
@@ -4942,7 +4903,7 @@ var TeslemetryApi = class {
 	* @returns Promise to an object containing lists of paired and unpaired VINs,
 	* and detailed info for each vehicle.
 	*/
-	async fleetStatus(vins) {
+	async getFleetStatus(vins) {
 		const { data } = await postApi1VehiclesFleetStatus({
 			body: { vins },
 			client: this.root.client
@@ -4954,7 +4915,7 @@ var TeslemetryApi = class {
 	* @returns Promise to an object containing a list of vehicles,
 	* pagination details, and a total count.
 	*/
-	async vehicles() {
+	async getVehicles() {
 		const { data } = await getApi1Vehicles({ client: this.root.client });
 		return data;
 	}
@@ -4983,7 +4944,7 @@ const consoleLogger = {
 
 //#endregion
 //#region package.json
-var version = "0.3.0";
+var version = "0.5.0";
 
 //#endregion
 //#region src/Teslemetry.ts
@@ -5044,27 +5005,25 @@ var Teslemetry = class {
 	* @returns A promise that resolves to an object containing vehicle and energy site names, API, and SSE instances.
 	*/
 	async createProducts() {
-		const { data } = await getApi1Products({ client: this.client });
-		const result = {
-			vehicles: {},
-			energySites: {}
+		const { data } = await getApiMetadata({ client: this.client });
+		return {
+			vehicles: Object.fromEntries(Object.entries(data.vehicles).map(([vin, metadata]) => [vin, {
+				name: metadata.name ?? useTeslaModel(vin),
+				vin,
+				api: this.api.getVehicle(vin),
+				sse: this.sse.getVehicle(vin),
+				metadata
+			}])),
+			energySites: Object.fromEntries(Object.entries(data.energy_sites ?? {}).map(([id, metadata]) => {
+				const siteId = Number(id);
+				return [id, {
+					name: metadata.name ?? "Unnamed",
+					id: siteId,
+					api: this.api.getEnergySite(siteId),
+					metadata
+				}];
+			}))
 		};
-		data.response?.forEach((product) => {
-			if (product.device_type === "vehicle") result.vehicles[product.vin] = {
-				name: product.display_name ?? useTeslaModel(product.vin),
-				vin: product.vin,
-				api: this.api.getVehicle(product.vin),
-				sse: this.sse.getVehicle(product.vin),
-				product
-			};
-			if (product.device_type === "energy") result.energySites[product.energy_site_id] = {
-				name: product.site_name ?? "Unnamed",
-				site: product.energy_site_id,
-				api: this.api.getEnergySite(product.energy_site_id),
-				product
-			};
-		});
-		return result;
 	}
 	/**
 	* Get a vehicle API instance for the specified VIN.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teslemetry/api",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "API client for Teslemetry",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",