tesla-fleet-api 0.2.2 → 0.4.0

package/dist/teslafleetapi.mjs

@@ -0,0 +1,125 @@
+import Charging from "./charging.mjs";
+import Energy from "./energy.mjs";
+import Partner from "./partner.mjs";
+import User from "./user.mjs";
+import Vehicle from "./vehicle.mjs";
+import { SERVERS, is_valid_region } from "./const.mjs";
+import { ResponseError, TeslaFleetConnectionError, TeslaFleetError, raise_for_status } from "./exceptions.mjs";
+// src/teslafleetapi.ts
+var TeslaFleetApi = class {
+	server = null;
+	accessToken;
+	charging;
+	energy;
+	partner;
+	user;
+	vehicle;
+	debug = false;
+	/** Abort a request (including reading its body) after this many milliseconds; `null` waits indefinitely. */
+	timeout;
+	constructor(options) {
+		this.debug = !!options.debug;
+		this.timeout = options.timeout ?? null;
+		this.accessToken = options.accessToken ?? null;
+		if (options.server) this.server = options.server;
+		else if (options.region && is_valid_region(options.region)) this.server = SERVERS[options.region];
+		else throw new Error("Either server or region must be provided.");
+		this.debug && console.debug(`Using server ${this.server}`);
+		if (options.chargingScope !== false) this.charging = new Charging(this);
+		if (options.energyScope !== false) this.energy = new Energy(this);
+		if (options.userScope !== false) this.user = new User(this);
+		if (options.partnerScope !== false) this.partner = new Partner(this);
+		if (options.vehicleScope !== false) this.vehicle = new Vehicle(this);
+	}
+	/**
+	* Turn a response into its decoded JSON body, throwing the matching
+	* `TeslaFleetError` for an error status and `ResponseError` for a
+	* successful response whose body is not JSON.
+	*/
+	async _response(resp) {
+		await raise_for_status(resp);
+		const text = await resp.text();
+		try {
+			return JSON.parse(text);
+		} catch {
+			throw new ResponseError(text, resp.status);
+		}
+	}
+	/**
+	* Make a request to the Tesla Fleet API.
+	* @param method
+	* @param path
+	* @param params
+	* @param json
+	* @returns The decoded JSON body.
+	* @throws A `TeslaFleetError` subclass for an error status, or
+	* `TeslaFleetConnectionError` (with the original error as `cause`) when the
+	* request could not complete or timed out.
+	*/
+	async _request(method, path, params = null, json = null) {
+		if (!this.server) throw new Error("Server was not set at init. Call findServer() first.");
+		if (method === "GET" && json !== null) throw new Error("GET requests cannot have a body.");
+		this.debug && console.debug(`Sending request to ${path}`);
+		if (params) {
+			params = Object.fromEntries(Object.entries(params).filter(([_, v]) => v != null));
+			this.debug && console.debug(`Parameters: ${JSON.stringify(params)}`);
+		}
+		if (json) {
+			json = Object.fromEntries(Object.entries(json).filter(([_, v]) => v != null));
+			this.debug && console.debug(`Body: ${JSON.stringify(json)}`);
+		}
+		const headers = {
+			Authorization: `Bearer ${this.accessToken}`,
+			"Content-Type": "application/json",
+			"X-Library": `node tesla_fleet_api`
+		};
+		const query = params ? "?" + new URLSearchParams(params).toString() : "";
+		try {
+			const resp = await fetch(`${this.server}/${path}${query}`, {
+				method,
+				headers,
+				body: json ? JSON.stringify(json) : null,
+				signal: this.timeout != null ? AbortSignal.timeout(this.timeout) : null
+			});
+			return await this._response(resp);
+		} catch (error) {
+			if (error instanceof TeslaFleetError) throw error;
+			throw new TeslaFleetConnectionError(null, null, { cause: error });
+		}
+	}
+	/**
+	* Returns products mapped to user.
+	* @returns An array of products including both vehicles and energy sites.
+	*/
+	async products() {
+		return this._request("GET", "api/1/products").then(({ response }) => response);
+	}
+	/**
+	* Return Tesla products separated into vehicles and energy_sites
+	* @returns A dictionary of vehicles and energy sites, each with an array of those products
+	*/
+	async products_by_type() {
+		return this.products().then((products) => ({
+			vehicles: products.filter((product) => "vin" in product),
+			energy_sites: products.filter((product) => "energy_site_id" in product)
+		}));
+	}
+	async loadPrivateKey(path) {
+		return (await import("fs")).promises.readFile(path, "utf8").then((key) => {
+			this.accessToken = key;
+		}).catch(async () => {
+			const { privateKey: _privateKey } = (await import("crypto")).generateKeyPairSync("ec", {
+				namedCurve: "secp256r1",
+				publicKeyEncoding: {
+					type: "spki",
+					format: "pem"
+				},
+				privateKeyEncoding: {
+					type: "pkcs8",
+					format: "pem"
+				}
+			});
+		});
+	}
+};
+export { TeslaFleetApi as default };

package/dist/teslemetry.cjs

@@ -0,0 +1,36 @@
+const require_teslafleetapi = require("./teslafleetapi.cjs");
+// src/teslemetry.ts
+var Teslemetry = class extends require_teslafleetapi.default {
+	constructor(accessToken, region = "api") {
+		super({
+			accessToken,
+			server: `https://${region}.teslemetry.com`,
+			partnerScope: false,
+			userScope: false
+		});
+	}
+	async _response(resp) {
+		if (resp.headers.has("x-region")) {
+			const region = resp.headers.get("x-region")?.toLowerCase();
+			if (region) this.server = `https://${region}.teslemetry.com`;
+		}
+		return super._response(resp);
+	}
+	/**
+	* Test the connection to Teslemetry
+	*/
+	async test() {
+		return this._request("GET", "api/test").then(({ response }) => response);
+	}
+	/**
+	* Get details about your Teslemetry account
+	* @param update_region Update the server URL based on the region in the metadata
+	*/
+	async metadata(update_region = true) {
+		return this._request("GET", "api/metadata").then((metadata) => {
+			if (update_region) this.server = `https://${metadata.region.toLowerCase()}.teslemetry.com`;
+			return metadata;
+		});
+	}
+};
+exports.default = Teslemetry;

package/dist/teslemetry.d.cts

@@ -0,0 +1,23 @@
+import TeslaFleetApi from "./teslafleetapi.cjs";
+import { Scope } from "./const.cjs";
+type Region = "na" | "eu" | "api";
+type Metadata = {
+  uid: string;
+  region: "NA" | "EU";
+  scopes: Scope[];
+  vins: string[];
+};
+declare class Teslemetry extends TeslaFleetApi {
+  constructor(accessToken: string, region?: Region);
+  _response(resp: Response): Promise<any>;
+  /**
+   * Test the connection to Teslemetry
+   */
+  test(): Promise<boolean>;
+  /**
+   * Get details about your Teslemetry account
+   * @param update_region Update the server URL based on the region in the metadata
+   */
+  metadata(update_region?: boolean): Promise<Metadata>;
+}
+export = Teslemetry;

package/dist/teslemetry.d.mts

@@ -0,0 +1,23 @@
+import TeslaFleetApi from "./teslafleetapi.mjs";
+import { Scope } from "./const.mjs";
+type Region = "na" | "eu" | "api";
+type Metadata = {
+  uid: string;
+  region: "NA" | "EU";
+  scopes: Scope[];
+  vins: string[];
+};
+export default class Teslemetry extends TeslaFleetApi {
+  constructor(accessToken: string, region?: Region);
+  _response(resp: Response): Promise<any>;
+  /**
+   * Test the connection to Teslemetry
+   */
+  test(): Promise<boolean>;
+  /**
+   * Get details about your Teslemetry account
+   * @param update_region Update the server URL based on the region in the metadata
+   */
+  metadata(update_region?: boolean): Promise<Metadata>;
+}
+export {};

package/dist/teslemetry.mjs

@@ -0,0 +1,36 @@
+import TeslaFleetApi from "./teslafleetapi.mjs";
+// src/teslemetry.ts
+var Teslemetry = class extends TeslaFleetApi {
+	constructor(accessToken, region = "api") {
+		super({
+			accessToken,
+			server: `https://${region}.teslemetry.com`,
+			partnerScope: false,
+			userScope: false
+		});
+	}
+	async _response(resp) {
+		if (resp.headers.has("x-region")) {
+			const region = resp.headers.get("x-region")?.toLowerCase();
+			if (region) this.server = `https://${region}.teslemetry.com`;
+		}
+		return super._response(resp);
+	}
+	/**
+	* Test the connection to Teslemetry
+	*/
+	async test() {
+		return this._request("GET", "api/test").then(({ response }) => response);
+	}
+	/**
+	* Get details about your Teslemetry account
+	* @param update_region Update the server URL based on the region in the metadata
+	*/
+	async metadata(update_region = true) {
+		return this._request("GET", "api/metadata").then((metadata) => {
+			if (update_region) this.server = `https://${metadata.region.toLowerCase()}.teslemetry.com`;
+			return metadata;
+		});
+	}
+};
+export { Teslemetry as default };

package/dist/tessie.cjs

@@ -0,0 +1,34 @@
+const require_teslafleetapi = require("./teslafleetapi.cjs");
+// src/tessie.ts
+var Tessie = class extends require_teslafleetapi.default {
+	constructor(accessToken) {
+		super({
+			accessToken,
+			server: `https://api.tessie.com`,
+			partnerScope: false,
+			userScope: false
+		});
+	}
+	/**
+	* Get your approved Tesla scopes
+	*/
+	async tesla_scopes() {
+		return this._request("GET", "auth/tesla_scopes").then(({ scopes }) => scopes);
+	}
+	async metadata() {
+		return this._request("GET", "auth/tesla_scopes");
+	}
+	async status(vin) {
+		return this._request("GET", `${vin}/status`).then(({ status }) => status);
+	}
+	async state(vin, use_cache = true) {
+		return this._request("GET", `${vin}/state`, { use_cache });
+	}
+	async vehicles(only_active = false) {
+		return this._request("GET", "vehicles", { only_active }).then(({ results }) => results);
+	}
+	async wake(vin) {
+		return this._request("POST", `${vin}/wake`).then(({ result }) => result);
+	}
+};
+exports.default = Tessie;

package/dist/tessie.d.cts

@@ -0,0 +1,23 @@
+import TeslaFleetApi from "./teslafleetapi.cjs";
+import { Scope } from "./const.cjs";
+import { VehicleDataResponse } from "./types/vehicle_data.cjs";
+type TessieVehicleResponse = {
+  vin: string;
+  is_active: boolean;
+  last_state: VehicleDataResponse;
+};
+declare class Tessie extends TeslaFleetApi {
+  constructor(accessToken: string);
+  /**
+   * Get your approved Tesla scopes
+   */
+  tesla_scopes(): Promise<Scope[]>;
+  metadata(): Promise<{
+    scopes: Scope[];
+  }>;
+  status(vin: string): Promise<"asleep" | "waiting_for_sleep" | "awake">;
+  state(vin: string, use_cache?: boolean): Promise<VehicleDataResponse>;
+  vehicles(only_active?: boolean): Promise<TessieVehicleResponse[]>;
+  wake(vin: string): Promise<boolean>;
+}
+export = Tessie;

package/dist/tessie.d.mts

@@ -0,0 +1,23 @@
+import TeslaFleetApi from "./teslafleetapi.mjs";
+import { Scope } from "./const.mjs";
+import { VehicleDataResponse } from "./types/vehicle_data.mjs";
+type TessieVehicleResponse = {
+  vin: string;
+  is_active: boolean;
+  last_state: VehicleDataResponse;
+};
+export default class Tessie extends TeslaFleetApi {
+  constructor(accessToken: string);
+  /**
+   * Get your approved Tesla scopes
+   */
+  tesla_scopes(): Promise<Scope[]>;
+  metadata(): Promise<{
+    scopes: Scope[];
+  }>;
+  status(vin: string): Promise<"asleep" | "waiting_for_sleep" | "awake">;
+  state(vin: string, use_cache?: boolean): Promise<VehicleDataResponse>;
+  vehicles(only_active?: boolean): Promise<TessieVehicleResponse[]>;
+  wake(vin: string): Promise<boolean>;
+}
+export {};

package/dist/tessie.mjs

@@ -0,0 +1,34 @@
+import TeslaFleetApi from "./teslafleetapi.mjs";
+// src/tessie.ts
+var Tessie = class extends TeslaFleetApi {
+	constructor(accessToken) {
+		super({
+			accessToken,
+			server: `https://api.tessie.com`,
+			partnerScope: false,
+			userScope: false
+		});
+	}
+	/**
+	* Get your approved Tesla scopes
+	*/
+	async tesla_scopes() {
+		return this._request("GET", "auth/tesla_scopes").then(({ scopes }) => scopes);
+	}
+	async metadata() {
+		return this._request("GET", "auth/tesla_scopes");
+	}
+	async status(vin) {
+		return this._request("GET", `${vin}/status`).then(({ status }) => status);
+	}
+	async state(vin, use_cache = true) {
+		return this._request("GET", `${vin}/state`, { use_cache });
+	}
+	async vehicles(only_active = false) {
+		return this._request("GET", "vehicles", { only_active }).then(({ results }) => results);
+	}
+	async wake(vin) {
+		return this._request("POST", `${vin}/wake`).then(({ result }) => result);
+	}
+};
+export { Tessie as default };

package/dist/types/commands.d.cts

@@ -0,0 +1,28 @@
+import { ClimateMode, ClimateModes, Level, Scope, Seat, Seats, Trunk, VehicleDataEndpoint } from "../const.cjs";
+declare namespace commands_d_exports {
+  export { AlertTypes, ClimateMode, ClimateModes, CommandResponse, FleetTelemetryConfig, Level, Scope, Seat, Seats, Trunk, VehicleDataEndpoint };
+}
+export interface CommandResponse {
+  response: {
+    result: boolean;
+    reason: string;
+  };
+  error?: string;
+}
+export type AlertTypes = "customer" | "service";
+export interface FleetTelemetryConfig {
+  vins: string[];
+  config: {
+    hostname: string;
+    ca: string;
+    fields: {
+      [key: string]: {
+        interval_seconds: number;
+      };
+    };
+    alert_types: AlertTypes[];
+    exp: number;
+    port: number;
+  };
+}
+export { type ClimateMode, ClimateModes, type Level, type Scope, type Seat, Seats, type Trunk, type VehicleDataEndpoint, commands_d_exports };

package/dist/types/commands.d.mts

@@ -0,0 +1,28 @@
+import { ClimateMode, ClimateModes, Level, Scope, Seat, Seats, Trunk, VehicleDataEndpoint } from "../const.mjs";
+declare namespace commands_d_exports {
+  export { AlertTypes, ClimateMode, ClimateModes, CommandResponse, FleetTelemetryConfig, Level, Scope, Seat, Seats, Trunk, VehicleDataEndpoint };
+}
+export interface CommandResponse {
+  response: {
+    result: boolean;
+    reason: string;
+  };
+  error?: string;
+}
+export type AlertTypes = "customer" | "service";
+export interface FleetTelemetryConfig {
+  vins: string[];
+  config: {
+    hostname: string;
+    ca: string;
+    fields: {
+      [key: string]: {
+        interval_seconds: number;
+      };
+    };
+    alert_types: AlertTypes[];
+    exp: number;
+    port: number;
+  };
+}
+export { type ClimateMode, ClimateModes, type Level, type Scope, type Seat, Seats, type Trunk, type VehicleDataEndpoint, commands_d_exports };

package/dist/types/live_status.d.cts

@@ -0,0 +1,30 @@
+declare namespace live_status_d_exports {
+  export { LiveStatusResponse, WallConnector };
+}
+export type LiveStatusResponse = {
+  solar_power?: number;
+  energy_left?: number;
+  total_pack_energy?: number;
+  percentage_charged?: number;
+  backup_capable?: boolean;
+  battery_power?: number;
+  load_power?: number;
+  grid_status?: string;
+  grid_services_active?: boolean;
+  grid_power?: number;
+  grid_services_power?: number;
+  generator_power?: number;
+  island_status?: string;
+  storm_mode_active?: boolean;
+  timestamp: Date;
+  wall_connectors?: WallConnector[];
+};
+export type WallConnector = {
+  din: string;
+  vin?: string;
+  wall_connector_state: number;
+  wall_connector_fault_state: number;
+  wall_connector_power: number;
+  ocpp_status: number;
+};
+export { live_status_d_exports };

package/dist/types/live_status.d.mts

@@ -0,0 +1,30 @@
+declare namespace live_status_d_exports {
+  export { LiveStatusResponse, WallConnector };
+}
+export type LiveStatusResponse = {
+  solar_power?: number;
+  energy_left?: number;
+  total_pack_energy?: number;
+  percentage_charged?: number;
+  backup_capable?: boolean;
+  battery_power?: number;
+  load_power?: number;
+  grid_status?: string;
+  grid_services_active?: boolean;
+  grid_power?: number;
+  grid_services_power?: number;
+  generator_power?: number;
+  island_status?: string;
+  storm_mode_active?: boolean;
+  timestamp: Date;
+  wall_connectors?: WallConnector[];
+};
+export type WallConnector = {
+  din: string;
+  vin?: string;
+  wall_connector_state: number;
+  wall_connector_fault_state: number;
+  wall_connector_power: number;
+  ocpp_status: number;
+};
+export { live_status_d_exports };

package/dist/types/products.d.cts

@@ -0,0 +1,58 @@
+import { VehicleResponse } from "./vehicle.cjs";
+import { VehicleConfig } from "./vehicle_data.cjs";
+declare namespace products_d_exports {
+  export { Components, EnergyProduct, Features, ProductsData, ProductsResponse, VehicleProduct, WallConnector };
+}
+export type ProductsData = {
+  response: ProductsResponse;
+  count: number;
+};
+export type ProductsResponse = (VehicleProduct | EnergyProduct)[];
+export type VehicleProduct = VehicleResponse & {
+  vehicle_config: VehicleConfig;
+  command_signing: string;
+  release_notes_supported: boolean;
+};
+export type EnergyProduct = {
+  energy_site_id: number;
+  resource_type: string;
+  site_name: string;
+  id: string;
+  gateway_id: string;
+  asset_site_id: string;
+  warp_site_number: string;
+  energy_left: number;
+  total_pack_energy: number;
+  percentage_charged: number;
+  battery_type: string;
+  backup_capable: boolean;
+  battery_power: number;
+  go_off_grid_test_banner_enabled: null | boolean;
+  storm_mode_enabled: boolean;
+  powerwall_onboarding_settings_set: boolean;
+  powerwall_tesla_electric_interested_in: null | boolean;
+  vpp_tour_enabled: null | boolean;
+  sync_grid_alert_enabled: boolean;
+  breaker_alert_enabled: boolean;
+  components: Components;
+  features: Features;
+};
+export type Components = {
+  battery: boolean;
+  battery_type: string;
+  solar: boolean;
+  solar_type: string;
+  grid: boolean;
+  load_meter: boolean;
+  market_type: string;
+  wall_connectors: WallConnector[];
+};
+export type WallConnector = {
+  device_id: string;
+  din: string;
+  is_active: boolean;
+};
+export type Features = {
+  rate_plan_manager_no_pricing_constraint: boolean;
+};
+export { products_d_exports };

package/dist/types/products.d.mts

@@ -0,0 +1,58 @@
+import { VehicleResponse } from "./vehicle.mjs";
+import { VehicleConfig } from "./vehicle_data.mjs";
+declare namespace products_d_exports {
+  export { Components, EnergyProduct, Features, ProductsData, ProductsResponse, VehicleProduct, WallConnector };
+}
+export type ProductsData = {
+  response: ProductsResponse;
+  count: number;
+};
+export type ProductsResponse = (VehicleProduct | EnergyProduct)[];
+export type VehicleProduct = VehicleResponse & {
+  vehicle_config: VehicleConfig;
+  command_signing: string;
+  release_notes_supported: boolean;
+};
+export type EnergyProduct = {
+  energy_site_id: number;
+  resource_type: string;
+  site_name: string;
+  id: string;
+  gateway_id: string;
+  asset_site_id: string;
+  warp_site_number: string;
+  energy_left: number;
+  total_pack_energy: number;
+  percentage_charged: number;
+  battery_type: string;
+  backup_capable: boolean;
+  battery_power: number;
+  go_off_grid_test_banner_enabled: null | boolean;
+  storm_mode_enabled: boolean;
+  powerwall_onboarding_settings_set: boolean;
+  powerwall_tesla_electric_interested_in: null | boolean;
+  vpp_tour_enabled: null | boolean;
+  sync_grid_alert_enabled: boolean;
+  breaker_alert_enabled: boolean;
+  components: Components;
+  features: Features;
+};
+export type Components = {
+  battery: boolean;
+  battery_type: string;
+  solar: boolean;
+  solar_type: string;
+  grid: boolean;
+  load_meter: boolean;
+  market_type: string;
+  wall_connectors: WallConnector[];
+};
+export type WallConnector = {
+  device_id: string;
+  din: string;
+  is_active: boolean;
+};
+export type Features = {
+  rate_plan_manager_no_pricing_constraint: boolean;
+};
+export { products_d_exports };

package/dist/types/responses.d.cts

@@ -0,0 +1,9 @@
+declare namespace responses_d_exports {
+  export { OptionsResponse };
+}
+export type OptionsResponse = {
+  code: string;
+  displayName: string;
+  isActive: boolean;
+}[];
+export { responses_d_exports };

package/dist/types/responses.d.mts

@@ -0,0 +1,9 @@
+declare namespace responses_d_exports {
+  export { OptionsResponse };
+}
+export type OptionsResponse = {
+  code: string;
+  displayName: string;
+  isActive: boolean;
+}[];
+export { responses_d_exports };