tesla-fleet-api 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (342) hide show
  1. package/README.md +284 -1
  2. package/dist/_virtual/_rolldown/runtime.cjs +32 -0
  3. package/dist/_virtual/_rolldown/runtime.mjs +12 -0
  4. package/dist/bluetooth/adapters/shared.cjs +38 -0
  5. package/dist/bluetooth/adapters/shared.mjs +36 -0
  6. package/dist/bluetooth/async.cjs +121 -0
  7. package/dist/bluetooth/async.d.cts +10 -0
  8. package/dist/bluetooth/async.d.mts +10 -0
  9. package/dist/bluetooth/async.mjs +116 -0
  10. package/dist/bluetooth/broadcast.cjs +153 -0
  11. package/dist/bluetooth/broadcast.d.cts +59 -0
  12. package/dist/bluetooth/broadcast.d.mts +59 -0
  13. package/dist/bluetooth/broadcast.mjs +151 -0
  14. package/dist/bluetooth/constants.cjs +99 -0
  15. package/dist/bluetooth/constants.d.cts +70 -0
  16. package/dist/bluetooth/constants.d.mts +70 -0
  17. package/dist/bluetooth/constants.mjs +72 -0
  18. package/dist/bluetooth/esphome.cjs +292 -0
  19. package/dist/bluetooth/esphome.d.cts +83 -0
  20. package/dist/bluetooth/esphome.d.mts +83 -0
  21. package/dist/bluetooth/esphome.mjs +291 -0
  22. package/dist/bluetooth/framing.cjs +125 -0
  23. package/dist/bluetooth/framing.d.cts +45 -0
  24. package/dist/bluetooth/framing.d.mts +45 -0
  25. package/dist/bluetooth/framing.mjs +122 -0
  26. package/dist/bluetooth/homey.cjs +155 -0
  27. package/dist/bluetooth/homey.d.cts +75 -0
  28. package/dist/bluetooth/homey.d.mts +75 -0
  29. package/dist/bluetooth/homey.mjs +150 -0
  30. package/dist/bluetooth/names.cjs +24 -0
  31. package/dist/bluetooth/names.d.cts +10 -0
  32. package/dist/bluetooth/names.d.mts +10 -0
  33. package/dist/bluetooth/names.mjs +20 -0
  34. package/dist/bluetooth/noble.cjs +178 -0
  35. package/dist/bluetooth/noble.d.cts +58 -0
  36. package/dist/bluetooth/noble.d.mts +58 -0
  37. package/dist/bluetooth/noble.mjs +177 -0
  38. package/dist/bluetooth/streamglue.cjs +157 -0
  39. package/dist/bluetooth/streamglue.d.cts +37 -0
  40. package/dist/bluetooth/streamglue.d.mts +37 -0
  41. package/dist/bluetooth/streamglue.mjs +154 -0
  42. package/dist/bluetooth/teslabluetooth.cjs +67 -0
  43. package/dist/bluetooth/teslabluetooth.d.cts +41 -0
  44. package/dist/bluetooth/teslabluetooth.d.mts +41 -0
  45. package/dist/bluetooth/teslabluetooth.mjs +66 -0
  46. package/dist/bluetooth/transport.cjs +10 -0
  47. package/dist/bluetooth/transport.d.cts +95 -0
  48. package/dist/bluetooth/transport.d.mts +95 -0
  49. package/dist/bluetooth/transport.mjs +10 -0
  50. package/dist/bluetooth/vehiclebluetooth.cjs +1272 -0
  51. package/dist/bluetooth/vehiclebluetooth.d.cts +495 -0
  52. package/dist/bluetooth/vehiclebluetooth.d.mts +495 -0
  53. package/dist/bluetooth/vehiclebluetooth.mjs +1270 -0
  54. package/dist/bluetooth/verify.cjs +93 -0
  55. package/dist/bluetooth/verify.d.cts +35 -0
  56. package/dist/bluetooth/verify.d.mts +35 -0
  57. package/dist/bluetooth/verify.mjs +91 -0
  58. package/dist/bluetooth.cjs +53 -0
  59. package/dist/bluetooth.d.cts +10 -0
  60. package/dist/bluetooth.d.mts +10 -0
  61. package/dist/bluetooth.mjs +9 -0
  62. package/dist/charging.cjs +53 -0
  63. package/dist/charging.d.cts +31 -0
  64. package/dist/charging.d.mts +30 -0
  65. package/dist/charging.mjs +53 -0
  66. package/dist/commands.cjs +1797 -0
  67. package/dist/commands.d.cts +881 -0
  68. package/dist/commands.d.mts +881 -0
  69. package/dist/commands.mjs +1791 -0
  70. package/dist/const.cjs +322 -0
  71. package/dist/const.d.cts +308 -0
  72. package/dist/const.d.mts +308 -0
  73. package/dist/const.mjs +282 -0
  74. package/dist/energy.cjs +142 -0
  75. package/dist/energy.d.cts +101 -0
  76. package/dist/energy.d.mts +100 -0
  77. package/dist/energy.mjs +142 -0
  78. package/dist/energyisland.cjs +38 -0
  79. package/dist/energyisland.mjs +37 -0
  80. package/dist/energyparsers.cjs +118 -0
  81. package/dist/energyparsers.d.cts +39 -0
  82. package/dist/energyparsers.d.mts +39 -0
  83. package/dist/energyparsers.mjs +116 -0
  84. package/dist/energyspecific.cjs +457 -0
  85. package/dist/energyspecific.d.cts +258 -0
  86. package/dist/energyspecific.d.mts +258 -0
  87. package/dist/energyspecific.mjs +451 -0
  88. package/dist/exceptions.cjs +1488 -0
  89. package/dist/exceptions.d.cts +1143 -0
  90. package/dist/exceptions.d.mts +1143 -0
  91. package/dist/exceptions.mjs +1325 -0
  92. package/dist/funnel.cjs +297 -0
  93. package/dist/funnel.d.cts +118 -0
  94. package/dist/funnel.d.mts +118 -0
  95. package/dist/funnel.mjs +292 -0
  96. package/dist/index.cjs +287 -0
  97. package/dist/index.d.cts +28 -0
  98. package/dist/index.d.mts +28 -0
  99. package/dist/index.mjs +27 -0
  100. package/dist/log.cjs +75 -0
  101. package/dist/log.d.cts +4 -0
  102. package/dist/log.d.mts +4 -0
  103. package/dist/log.mjs +71 -0
  104. package/dist/oauth.cjs +143 -0
  105. package/dist/oauth.d.cts +69 -0
  106. package/dist/oauth.d.mts +69 -0
  107. package/dist/oauth.mjs +143 -0
  108. package/dist/partner.cjs +32 -0
  109. package/dist/partner.d.cts +24 -0
  110. package/dist/partner.d.mts +23 -0
  111. package/dist/partner.mjs +32 -0
  112. package/dist/powerwall/client.cjs +818 -0
  113. package/dist/powerwall/client.d.cts +297 -0
  114. package/dist/powerwall/client.d.mts +297 -0
  115. package/dist/powerwall/client.mjs +807 -0
  116. package/dist/powerwall/components.cjs +188 -0
  117. package/dist/powerwall/components.d.cts +45 -0
  118. package/dist/powerwall/components.d.mts +45 -0
  119. package/dist/powerwall/components.mjs +182 -0
  120. package/dist/powerwall/energysite.cjs +216 -0
  121. package/dist/powerwall/energysite.d.cts +104 -0
  122. package/dist/powerwall/energysite.d.mts +104 -0
  123. package/dist/powerwall/energysite.mjs +214 -0
  124. package/dist/powerwall/exceptions.cjs +59 -0
  125. package/dist/powerwall/exceptions.d.cts +38 -0
  126. package/dist/powerwall/exceptions.d.mts +38 -0
  127. package/dist/powerwall/exceptions.mjs +51 -0
  128. package/dist/powerwall/gateway.cjs +102 -0
  129. package/dist/powerwall/gateway.d.cts +57 -0
  130. package/dist/powerwall/gateway.d.mts +57 -0
  131. package/dist/powerwall/gateway.mjs +101 -0
  132. package/dist/powerwall/merge.cjs +163 -0
  133. package/dist/powerwall/merge.d.cts +63 -0
  134. package/dist/powerwall/merge.d.mts +63 -0
  135. package/dist/powerwall/merge.mjs +159 -0
  136. package/dist/powerwall/models.d.cts +95 -0
  137. package/dist/powerwall/models.d.mts +95 -0
  138. package/dist/powerwall/queries.cjs +17 -0
  139. package/dist/powerwall/queries.mjs +10 -0
  140. package/dist/powerwall/transport.cjs +232 -0
  141. package/dist/powerwall/transport.mjs +227 -0
  142. package/dist/powerwall.cjs +47 -0
  143. package/dist/powerwall.d.cts +9 -0
  144. package/dist/powerwall.d.mts +9 -0
  145. package/dist/powerwall.mjs +8 -0
  146. package/dist/router/base.cjs +203 -0
  147. package/dist/router/base.d.cts +112 -0
  148. package/dist/router/base.d.mts +112 -0
  149. package/dist/router/base.mjs +200 -0
  150. package/dist/router/energysite.cjs +65 -0
  151. package/dist/router/energysite.d.cts +47 -0
  152. package/dist/router/energysite.d.mts +47 -0
  153. package/dist/router/energysite.mjs +60 -0
  154. package/dist/router.cjs +13 -0
  155. package/dist/router.d.cts +3 -0
  156. package/dist/router.d.mts +3 -0
  157. package/dist/router.mjs +3 -0
  158. package/dist/signing/crypto.cjs +59 -0
  159. package/dist/signing/crypto.mjs +52 -0
  160. package/dist/signing/energy.cjs +123 -0
  161. package/dist/signing/energy.d.cts +45 -0
  162. package/dist/signing/energy.d.mts +45 -0
  163. package/dist/signing/energy.mjs +120 -0
  164. package/dist/signing/jws.cjs +229 -0
  165. package/dist/signing/jws.d.cts +45 -0
  166. package/dist/signing/jws.d.mts +45 -0
  167. package/dist/signing/jws.mjs +211 -0
  168. package/dist/signing/keys.cjs +191 -0
  169. package/dist/signing/keys.d.cts +21 -0
  170. package/dist/signing/keys.d.mts +21 -0
  171. package/dist/signing/keys.mjs +182 -0
  172. package/dist/signing/session.cjs +186 -0
  173. package/dist/signing/session.d.cts +106 -0
  174. package/dist/signing/session.d.mts +106 -0
  175. package/dist/signing/session.mjs +184 -0
  176. package/dist/tariff.cjs +319 -0
  177. package/dist/tariff.d.cts +40 -0
  178. package/dist/tariff.d.mts +40 -0
  179. package/dist/tariff.mjs +317 -0
  180. package/dist/teslafleetapi.cjs +326 -0
  181. package/dist/teslafleetapi.d.cts +160 -0
  182. package/dist/teslafleetapi.d.mts +160 -0
  183. package/dist/teslafleetapi.mjs +326 -0
  184. package/dist/teslemetry.cjs +183 -0
  185. package/dist/teslemetry.d.cts +113 -0
  186. package/dist/teslemetry.d.mts +113 -0
  187. package/dist/teslemetry.mjs +181 -0
  188. package/dist/teslemetryenergy.cjs +287 -0
  189. package/dist/teslemetryenergy.d.cts +154 -0
  190. package/dist/teslemetryenergy.d.mts +154 -0
  191. package/dist/teslemetryenergy.mjs +282 -0
  192. package/dist/teslemetryvehicle.cjs +407 -0
  193. package/dist/teslemetryvehicle.d.cts +238 -0
  194. package/dist/teslemetryvehicle.d.mts +238 -0
  195. package/dist/teslemetryvehicle.mjs +405 -0
  196. package/dist/tessie.cjs +71 -0
  197. package/dist/tessie.d.cts +69 -0
  198. package/dist/tessie.d.mts +69 -0
  199. package/dist/tessie.mjs +71 -0
  200. package/dist/tessievehicle.cjs +514 -0
  201. package/dist/tessievehicle.d.cts +333 -0
  202. package/dist/tessievehicle.d.mts +333 -0
  203. package/dist/tessievehicle.mjs +513 -0
  204. package/dist/types/commands.d.cts +28 -0
  205. package/dist/types/commands.d.mts +28 -0
  206. package/dist/types/live_status.d.cts +30 -0
  207. package/dist/types/live_status.d.mts +30 -0
  208. package/dist/types/products.d.cts +58 -0
  209. package/dist/types/products.d.mts +58 -0
  210. package/dist/types/responses.d.cts +13 -0
  211. package/dist/types/responses.d.mts +13 -0
  212. package/dist/types/site_info.d.cts +154 -0
  213. package/dist/types/site_info.d.mts +154 -0
  214. package/dist/types/vehicle.d.cts +33 -0
  215. package/dist/types/vehicle.d.mts +33 -0
  216. package/dist/types/vehicle_data.d.cts +278 -0
  217. package/dist/types/vehicle_data.d.mts +278 -0
  218. package/dist/types.cjs +0 -0
  219. package/dist/types.d.cts +9 -0
  220. package/dist/types.d.mts +9 -0
  221. package/dist/types.mjs +1 -0
  222. package/dist/user.cjs +28 -0
  223. package/dist/user.d.cts +17 -0
  224. package/dist/user.d.mts +16 -0
  225. package/dist/user.mjs +28 -0
  226. package/dist/util.cjs +41 -0
  227. package/dist/util.d.cts +18 -0
  228. package/dist/util.d.mts +18 -0
  229. package/dist/util.mjs +40 -0
  230. package/dist/vehicle.cjs +847 -0
  231. package/dist/vehicle.d.cts +566 -0
  232. package/dist/vehicle.d.mts +565 -0
  233. package/dist/vehicle.mjs +847 -0
  234. package/dist/vehiclesigned.cjs +35 -0
  235. package/dist/vehiclesigned.d.cts +23 -0
  236. package/dist/vehiclesigned.d.mts +22 -0
  237. package/dist/vehiclesigned.mjs +35 -0
  238. package/dist/vehiclespecific.cjs +715 -0
  239. package/dist/vehiclespecific.d.cts +497 -0
  240. package/dist/vehiclespecific.d.mts +496 -0
  241. package/dist/vehiclespecific.mjs +715 -0
  242. package/package.json +178 -38
  243. package/dist/charging.d.ts +0 -30
  244. package/dist/charging.js +0 -51
  245. package/dist/charging.js.map +0 -1
  246. package/dist/commands.d.ts +0 -352
  247. package/dist/commands.js +0 -875
  248. package/dist/commands.js.map +0 -1
  249. package/dist/energy.d.ts +0 -94
  250. package/dist/energy.js +0 -125
  251. package/dist/energy.js.map +0 -1
  252. package/dist/energyspecific.d.ts +0 -77
  253. package/dist/energyspecific.js +0 -97
  254. package/dist/energyspecific.js.map +0 -1
  255. package/dist/helpers.d.ts +0 -2
  256. package/dist/helpers.js +0 -10
  257. package/dist/helpers.js.map +0 -1
  258. package/dist/index.d.ts +0 -15
  259. package/dist/index.js +0 -15
  260. package/dist/index.js.map +0 -1
  261. package/dist/partner.d.ts +0 -23
  262. package/dist/partner.js +0 -31
  263. package/dist/partner.js.map +0 -1
  264. package/dist/signing/crypto.d.ts +0 -10
  265. package/dist/signing/crypto.js +0 -26
  266. package/dist/signing/crypto.js.map +0 -1
  267. package/dist/signing/errors.d.ts +0 -29
  268. package/dist/signing/errors.js +0 -40
  269. package/dist/signing/errors.js.map +0 -1
  270. package/dist/signing/session.d.ts +0 -69
  271. package/dist/signing/session.js +0 -102
  272. package/dist/signing/session.js.map +0 -1
  273. package/dist/tariff.d.ts +0 -29
  274. package/dist/tariff.js +0 -302
  275. package/dist/tariff.js.map +0 -1
  276. package/dist/teslafleetapi.d.ts +0 -58
  277. package/dist/teslafleetapi.js +0 -120
  278. package/dist/teslafleetapi.js.map +0 -1
  279. package/dist/teslemetry.d.ts +0 -29
  280. package/dist/teslemetry.js +0 -39
  281. package/dist/teslemetry.js.map +0 -1
  282. package/dist/tessie.d.ts +0 -23
  283. package/dist/tessie.js +0 -28
  284. package/dist/tessie.js.map +0 -1
  285. package/dist/types/commands.d.ts +0 -44
  286. package/dist/types/commands.js +0 -11
  287. package/dist/types/commands.js.map +0 -1
  288. package/dist/types/live_status.d.ts +0 -26
  289. package/dist/types/live_status.js +0 -2
  290. package/dist/types/live_status.js.map +0 -1
  291. package/dist/types/products.d.ts +0 -54
  292. package/dist/types/products.js +0 -2
  293. package/dist/types/products.js.map +0 -1
  294. package/dist/types/responses.d.ts +0 -5
  295. package/dist/types/responses.js +0 -2
  296. package/dist/types/responses.js.map +0 -1
  297. package/dist/types/site_info.d.ts +0 -150
  298. package/dist/types/site_info.js +0 -2
  299. package/dist/types/site_info.js.map +0 -1
  300. package/dist/types/vehicle.d.ts +0 -23
  301. package/dist/types/vehicle.js +0 -10
  302. package/dist/types/vehicle.js.map +0 -1
  303. package/dist/types/vehicle_data.d.ts +0 -274
  304. package/dist/types/vehicle_data.js +0 -2
  305. package/dist/types/vehicle_data.js.map +0 -1
  306. package/dist/user.d.ts +0 -16
  307. package/dist/user.js +0 -26
  308. package/dist/user.js.map +0 -1
  309. package/dist/vehicle.d.ts +0 -548
  310. package/dist/vehicle.js +0 -774
  311. package/dist/vehicle.js.map +0 -1
  312. package/dist/vehiclesigned.d.ts +0 -13
  313. package/dist/vehiclesigned.js +0 -19
  314. package/dist/vehiclesigned.js.map +0 -1
  315. package/dist/vehiclespecific.d.ts +0 -432
  316. package/dist/vehiclespecific.js +0 -601
  317. package/dist/vehiclespecific.js.map +0 -1
  318. package/src/charging.ts +0 -66
  319. package/src/commands.ts +0 -1134
  320. package/src/energy.ts +0 -217
  321. package/src/energyspecific.ts +0 -116
  322. package/src/helpers.ts +0 -11
  323. package/src/index.ts +0 -21
  324. package/src/partner.ts +0 -37
  325. package/src/signing/crypto.ts +0 -29
  326. package/src/signing/errors.ts +0 -50
  327. package/src/signing/session.ts +0 -132
  328. package/src/tariff.ts +0 -375
  329. package/src/teslafleetapi.ts +0 -182
  330. package/src/teslemetry.ts +0 -54
  331. package/src/tessie.ts +0 -42
  332. package/src/types/commands.ts +0 -62
  333. package/src/types/live_status.ts +0 -27
  334. package/src/types/products.ts +0 -61
  335. package/src/types/responses.ts +0 -1
  336. package/src/types/site_info.ts +0 -159
  337. package/src/types/vehicle.ts +0 -33
  338. package/src/types/vehicle_data.ts +0 -286
  339. package/src/user.ts +0 -35
  340. package/src/vehicle.ts +0 -886
  341. package/src/vehiclesigned.ts +0 -20
  342. package/src/vehiclespecific.ts +0 -818
@@ -0,0 +1,160 @@
1
+ import Charging from "./charging.cjs";
2
+ import Energy from "./energy.cjs";
3
+ import Partner from "./partner.cjs";
4
+ import User from "./user.cjs";
5
+ import Vehicle from "./vehicle.cjs";
6
+ import { Method, Region, Scope } from "./const.cjs";
7
+ import { EnergyProduct, ProductsData, VehicleProduct } from "./types/products.cjs";
8
+ import { Logger } from "./log.cjs";
9
+ import { KeyObject } from "node:crypto";
10
+ export type ProductsByType = {
11
+ vehicles: VehicleProduct[];
12
+ energy_sites: EnergyProduct[];
13
+ };
14
+ /** An access token, or a function returning the current one (e.g. after an OAuth refresh). */
15
+ export type AccessToken = string | (() => Promise<string | null>);
16
+ export default class TeslaFleetApi {
17
+ #private;
18
+ /** Class backing `vehicles`; a subclass (e.g. `Teslemetry`) overrides it instead of its constructor. */
19
+ static Vehicles: new (parent: TeslaFleetApi) => Vehicle;
20
+ /** Class backing `energySites`; a subclass overrides it instead of its constructor. */
21
+ static EnergySites: new (parent: TeslaFleetApi) => Energy;
22
+ server: string | null;
23
+ region: Region | null;
24
+ accessToken: AccessToken | null;
25
+ charging?: Charging;
26
+ energySites?: Energy;
27
+ partner?: Partner;
28
+ user?: User;
29
+ vehicles?: Vehicle;
30
+ /** Log to `console.debug` when no `logger` is set. */
31
+ debug: boolean;
32
+ logger: Logger | null;
33
+ /** Abort a request (including reading its body) after this many milliseconds; `null` waits indefinitely. */
34
+ timeout: number | null;
35
+ /** Transport identity for debug logging; Teslemetry and Tessie override this. */
36
+ readonly _transport_name: string;
37
+ constructor(options: {
38
+ accessToken?: AccessToken;
39
+ region?: Region;
40
+ server?: string;
41
+ chargingScope?: boolean;
42
+ energyScope?: boolean;
43
+ partnerScope?: boolean;
44
+ userScope?: boolean;
45
+ vehicleScope?: boolean;
46
+ debug?: boolean;
47
+ logger?: Logger;
48
+ /** Used for every request in place of the global `fetch`. */
49
+ fetch?: typeof fetch;
50
+ timeout?: number;
51
+ });
52
+ /** Write a debug line to `logger`, or to `console.debug` when `debug` is set. */
53
+ _log(message: string): void;
54
+ /** The injected `fetch`, resolved per call so the global is read late. */
55
+ protected _fetch(input: string, init?: RequestInit): Promise<Response>;
56
+ /**
57
+ * Find the server for this user's region by asking each Tesla server in
58
+ * turn, skipping any that answers `InvalidRegion`.
59
+ * @returns The region, e.g. `"na"`.
60
+ */
61
+ find_server(): Promise<string>;
62
+ /**
63
+ * The current access token, calling it first if it is a function.
64
+ * @throws MissingToken when there is no token.
65
+ */
66
+ access_token(): Promise<string>;
67
+ /**
68
+ * Turn a response into its decoded JSON body, throwing the matching
69
+ * `TeslaFleetError` for an error status and `ResponseError` for a
70
+ * successful response whose body is not JSON.
71
+ */
72
+ _response(resp: Response): Promise<any>;
73
+ /**
74
+ * Make a request to the Tesla Fleet API.
75
+ * @param method
76
+ * @param path
77
+ * @param params Query parameters; null and undefined values are dropped.
78
+ * @param json Body; null and undefined values are dropped, and a GET sends none.
79
+ * @returns The decoded JSON body.
80
+ * @throws `MissingToken` when there is no access token, a `TeslaFleetError`
81
+ * subclass for an error status, or `TeslaFleetConnectionError` (with the
82
+ * original error as `cause`) when the request could not complete or timed out.
83
+ */
84
+ _request(method: Method, path: string, params?: Record<string, any> | null, json?: Record<string, any> | null): Promise<any>;
85
+ /**
86
+ * Returns `"ok"` if the API is operating normally. Sends no headers.
87
+ */
88
+ status(): Promise<string>;
89
+ /**
90
+ * Generate a partner token using client credentials authentication, and use
91
+ * it as the access token for later requests.
92
+ * @param client_id Partner application client ID.
93
+ * @param client_secret Partner application client secret.
94
+ * @param scopes Scopes to request.
95
+ * @returns The token response, including `access_token`.
96
+ */
97
+ partner_login(client_id: string, client_secret: string, scopes?: Scope[]): Promise<Record<string, any>>;
98
+ /**
99
+ * Returns products mapped to user.
100
+ * @returns An array of products including both vehicles and energy sites.
101
+ */
102
+ products(): Promise<ProductsData>;
103
+ /**
104
+ * Return Tesla products separated into vehicles and energy_sites
105
+ * @returns A dictionary of vehicles and energy sites, each with an array of those products
106
+ */
107
+ products_by_type(): Promise<ProductsByType>;
108
+ /**
109
+ * Get or create the P-256 key that signs vehicle commands, and keep it as
110
+ * `private_key`. The file is an unencrypted PEM that Python's
111
+ * `get_private_key` shares, created at mode 0600. If another process wins the
112
+ * create race, its file is read instead.
113
+ * @param path Key file.
114
+ * @returns The raw 32-byte key `Commands` takes.
115
+ * @throws PrivateKeyError for an existing file that cannot be used.
116
+ */
117
+ get_private_key(path?: string): Promise<Buffer>;
118
+ /** The raw 32-byte P-256 key, which `createSigned` falls back to. */
119
+ get private_key(): Buffer | null;
120
+ set private_key(key: Buffer | null);
121
+ /** Whether the private key has been set. */
122
+ get has_private_key(): boolean;
123
+ /** The public key in PEM format. */
124
+ get public_pem(): string;
125
+ /** The public key's uncompressed point, in hex. */
126
+ get public_uncompressed_point(): string;
127
+ /**
128
+ * The EC public key in DER SubjectPublicKeyInfo form, as an energy gateway
129
+ * expects when registering an ECC authorized client. It rejects the raw point
130
+ * that vehicles use.
131
+ */
132
+ get ec_public_der_spki(): Buffer;
133
+ /** `ec_public_der_spki`, base64-encoded. */
134
+ get ec_public_der_spki_b64(): string;
135
+ /**
136
+ * Get or create the RSA key for energy gateway client registration, and keep
137
+ * it as `rsa_private_key`. The file is an unencrypted PEM that Python's
138
+ * `get_rsa_private_key` shares, created at mode 0600. If another process wins
139
+ * the create race, its file is read instead. Generation runs off the event loop.
140
+ * @param path Key file.
141
+ * @param key_size Modulus length in bits for a new key; 4096 is what Powerwall v1r expects.
142
+ * @throws PrivateKeyError for an existing file that cannot be used.
143
+ */
144
+ get_rsa_private_key(path?: string, key_size?: number): Promise<KeyObject>;
145
+ /** The RSA key for energy gateway client registration. */
146
+ get rsa_private_key(): KeyObject | null;
147
+ set rsa_private_key(key: KeyObject | null);
148
+ /** Whether the RSA private key has been set. */
149
+ get has_rsa_private_key(): boolean;
150
+ /**
151
+ * The RSA public key in DER PKCS#1 form, as an energy gateway expects when
152
+ * registering an authorized client.
153
+ */
154
+ get rsa_public_der_pkcs1(): Buffer;
155
+ /** `rsa_public_der_pkcs1`, base64-encoded. */
156
+ get rsa_public_der_pkcs1_b64(): string;
157
+ /** The RSA public key in PEM (SubjectPublicKeyInfo) format. */
158
+ get rsa_public_pem(): string;
159
+ }
160
+ export type { Logger };
@@ -0,0 +1,160 @@
1
+ import Charging from "./charging.mjs";
2
+ import Energy from "./energy.mjs";
3
+ import Partner from "./partner.mjs";
4
+ import User from "./user.mjs";
5
+ import Vehicle from "./vehicle.mjs";
6
+ import { Method, Region, Scope } from "./const.mjs";
7
+ import { EnergyProduct, ProductsData, VehicleProduct } from "./types/products.mjs";
8
+ import { Logger } from "./log.mjs";
9
+ import { KeyObject } from "node:crypto";
10
+ export type ProductsByType = {
11
+ vehicles: VehicleProduct[];
12
+ energy_sites: EnergyProduct[];
13
+ };
14
+ /** An access token, or a function returning the current one (e.g. after an OAuth refresh). */
15
+ export type AccessToken = string | (() => Promise<string | null>);
16
+ export default class TeslaFleetApi {
17
+ #private;
18
+ /** Class backing `vehicles`; a subclass (e.g. `Teslemetry`) overrides it instead of its constructor. */
19
+ static Vehicles: new (parent: TeslaFleetApi) => Vehicle;
20
+ /** Class backing `energySites`; a subclass overrides it instead of its constructor. */
21
+ static EnergySites: new (parent: TeslaFleetApi) => Energy;
22
+ server: string | null;
23
+ region: Region | null;
24
+ accessToken: AccessToken | null;
25
+ charging?: Charging;
26
+ energySites?: Energy;
27
+ partner?: Partner;
28
+ user?: User;
29
+ vehicles?: Vehicle;
30
+ /** Log to `console.debug` when no `logger` is set. */
31
+ debug: boolean;
32
+ logger: Logger | null;
33
+ /** Abort a request (including reading its body) after this many milliseconds; `null` waits indefinitely. */
34
+ timeout: number | null;
35
+ /** Transport identity for debug logging; Teslemetry and Tessie override this. */
36
+ readonly _transport_name: string;
37
+ constructor(options: {
38
+ accessToken?: AccessToken;
39
+ region?: Region;
40
+ server?: string;
41
+ chargingScope?: boolean;
42
+ energyScope?: boolean;
43
+ partnerScope?: boolean;
44
+ userScope?: boolean;
45
+ vehicleScope?: boolean;
46
+ debug?: boolean;
47
+ logger?: Logger;
48
+ /** Used for every request in place of the global `fetch`. */
49
+ fetch?: typeof fetch;
50
+ timeout?: number;
51
+ });
52
+ /** Write a debug line to `logger`, or to `console.debug` when `debug` is set. */
53
+ _log(message: string): void;
54
+ /** The injected `fetch`, resolved per call so the global is read late. */
55
+ protected _fetch(input: string, init?: RequestInit): Promise<Response>;
56
+ /**
57
+ * Find the server for this user's region by asking each Tesla server in
58
+ * turn, skipping any that answers `InvalidRegion`.
59
+ * @returns The region, e.g. `"na"`.
60
+ */
61
+ find_server(): Promise<string>;
62
+ /**
63
+ * The current access token, calling it first if it is a function.
64
+ * @throws MissingToken when there is no token.
65
+ */
66
+ access_token(): Promise<string>;
67
+ /**
68
+ * Turn a response into its decoded JSON body, throwing the matching
69
+ * `TeslaFleetError` for an error status and `ResponseError` for a
70
+ * successful response whose body is not JSON.
71
+ */
72
+ _response(resp: Response): Promise<any>;
73
+ /**
74
+ * Make a request to the Tesla Fleet API.
75
+ * @param method
76
+ * @param path
77
+ * @param params Query parameters; null and undefined values are dropped.
78
+ * @param json Body; null and undefined values are dropped, and a GET sends none.
79
+ * @returns The decoded JSON body.
80
+ * @throws `MissingToken` when there is no access token, a `TeslaFleetError`
81
+ * subclass for an error status, or `TeslaFleetConnectionError` (with the
82
+ * original error as `cause`) when the request could not complete or timed out.
83
+ */
84
+ _request(method: Method, path: string, params?: Record<string, any> | null, json?: Record<string, any> | null): Promise<any>;
85
+ /**
86
+ * Returns `"ok"` if the API is operating normally. Sends no headers.
87
+ */
88
+ status(): Promise<string>;
89
+ /**
90
+ * Generate a partner token using client credentials authentication, and use
91
+ * it as the access token for later requests.
92
+ * @param client_id Partner application client ID.
93
+ * @param client_secret Partner application client secret.
94
+ * @param scopes Scopes to request.
95
+ * @returns The token response, including `access_token`.
96
+ */
97
+ partner_login(client_id: string, client_secret: string, scopes?: Scope[]): Promise<Record<string, any>>;
98
+ /**
99
+ * Returns products mapped to user.
100
+ * @returns An array of products including both vehicles and energy sites.
101
+ */
102
+ products(): Promise<ProductsData>;
103
+ /**
104
+ * Return Tesla products separated into vehicles and energy_sites
105
+ * @returns A dictionary of vehicles and energy sites, each with an array of those products
106
+ */
107
+ products_by_type(): Promise<ProductsByType>;
108
+ /**
109
+ * Get or create the P-256 key that signs vehicle commands, and keep it as
110
+ * `private_key`. The file is an unencrypted PEM that Python's
111
+ * `get_private_key` shares, created at mode 0600. If another process wins the
112
+ * create race, its file is read instead.
113
+ * @param path Key file.
114
+ * @returns The raw 32-byte key `Commands` takes.
115
+ * @throws PrivateKeyError for an existing file that cannot be used.
116
+ */
117
+ get_private_key(path?: string): Promise<Buffer>;
118
+ /** The raw 32-byte P-256 key, which `createSigned` falls back to. */
119
+ get private_key(): Buffer | null;
120
+ set private_key(key: Buffer | null);
121
+ /** Whether the private key has been set. */
122
+ get has_private_key(): boolean;
123
+ /** The public key in PEM format. */
124
+ get public_pem(): string;
125
+ /** The public key's uncompressed point, in hex. */
126
+ get public_uncompressed_point(): string;
127
+ /**
128
+ * The EC public key in DER SubjectPublicKeyInfo form, as an energy gateway
129
+ * expects when registering an ECC authorized client. It rejects the raw point
130
+ * that vehicles use.
131
+ */
132
+ get ec_public_der_spki(): Buffer;
133
+ /** `ec_public_der_spki`, base64-encoded. */
134
+ get ec_public_der_spki_b64(): string;
135
+ /**
136
+ * Get or create the RSA key for energy gateway client registration, and keep
137
+ * it as `rsa_private_key`. The file is an unencrypted PEM that Python's
138
+ * `get_rsa_private_key` shares, created at mode 0600. If another process wins
139
+ * the create race, its file is read instead. Generation runs off the event loop.
140
+ * @param path Key file.
141
+ * @param key_size Modulus length in bits for a new key; 4096 is what Powerwall v1r expects.
142
+ * @throws PrivateKeyError for an existing file that cannot be used.
143
+ */
144
+ get_rsa_private_key(path?: string, key_size?: number): Promise<KeyObject>;
145
+ /** The RSA key for energy gateway client registration. */
146
+ get rsa_private_key(): KeyObject | null;
147
+ set rsa_private_key(key: KeyObject | null);
148
+ /** Whether the RSA private key has been set. */
149
+ get has_rsa_private_key(): boolean;
150
+ /**
151
+ * The RSA public key in DER PKCS#1 form, as an energy gateway expects when
152
+ * registering an authorized client.
153
+ */
154
+ get rsa_public_der_pkcs1(): Buffer;
155
+ /** `rsa_public_der_pkcs1`, base64-encoded. */
156
+ get rsa_public_der_pkcs1_b64(): string;
157
+ /** The RSA public key in PEM (SubjectPublicKeyInfo) format. */
158
+ get rsa_public_pem(): string;
159
+ }
160
+ export type { Logger };
@@ -0,0 +1,326 @@
1
+ import Charging from "./charging.mjs";
2
+ import Energy from "./energy.mjs";
3
+ import Partner from "./partner.mjs";
4
+ import User from "./user.mjs";
5
+ import Vehicle from "./vehicle.mjs";
6
+ import { SERVERS, Scope, TOKEN_URLS, is_valid_region } from "./const.mjs";
7
+ import { InvalidRegion, LibraryError, MissingToken, ResponseError, TeslaFleetConnectionError, TeslaFleetError, raise_for_status } from "./exceptions.mjs";
8
+ import { logRequestError, logRequestResult, redactedJson, redactedQuery } from "./log.mjs";
9
+ import { publicKeyFor } from "./signing/crypto.mjs";
10
+ import { ecPrivateKeyFile, ecPublicKey, rsaPrivateKeyFile, rsaPublicDerPkcs1 } from "./signing/keys.mjs";
11
+ import { createPublicKey } from "node:crypto";
12
+ // src/teslafleetapi.ts
13
+ var TeslaFleetApi = class {
14
+ /** Class backing `vehicles`; a subclass (e.g. `Teslemetry`) overrides it instead of its constructor. */
15
+ static Vehicles = Vehicle;
16
+ /** Class backing `energySites`; a subclass overrides it instead of its constructor. */
17
+ static EnergySites = Energy;
18
+ server = null;
19
+ region = null;
20
+ accessToken;
21
+ charging;
22
+ energySites;
23
+ partner;
24
+ user;
25
+ vehicles;
26
+ /** Log to `console.debug` when no `logger` is set. */
27
+ debug = false;
28
+ logger;
29
+ /** Abort a request (including reading its body) after this many milliseconds; `null` waits indefinitely. */
30
+ timeout;
31
+ /** Transport identity for debug logging; Teslemetry and Tessie override this. */
32
+ _transport_name = "fleet";
33
+ #fetch;
34
+ #privateKey = null;
35
+ #rsaPrivateKey = null;
36
+ constructor(options) {
37
+ this.debug = !!options.debug;
38
+ this.logger = options.logger ?? null;
39
+ this.#fetch = options.fetch ?? null;
40
+ this.timeout = options.timeout ?? null;
41
+ this.accessToken = options.accessToken ?? null;
42
+ if (options.server) this.server = options.server;
43
+ else if (options.region && is_valid_region(options.region)) {
44
+ this.region = options.region;
45
+ this.server = SERVERS[options.region];
46
+ } else throw new Error("Either server or region must be provided.");
47
+ this._log(`Using server ${this.server}`);
48
+ const factories = this.constructor;
49
+ if (options.chargingScope !== false) this.charging = new Charging(this);
50
+ if (options.energyScope !== false) this.energySites = new factories.EnergySites(this);
51
+ if (options.userScope !== false) this.user = new User(this);
52
+ if (options.partnerScope !== false) this.partner = new Partner(this);
53
+ if (options.vehicleScope !== false) this.vehicles = new factories.Vehicles(this);
54
+ }
55
+ /** Write a debug line to `logger`, or to `console.debug` when `debug` is set. */
56
+ _log(message) {
57
+ if (this.logger) this.logger.debug(message);
58
+ else if (this.debug) console.debug(message);
59
+ }
60
+ /** The injected `fetch`, resolved per call so the global is read late. */
61
+ _fetch(input, init) {
62
+ return (this.#fetch ?? fetch)(input, init);
63
+ }
64
+ /**
65
+ * Find the server for this user's region by asking each Tesla server in
66
+ * turn, skipping any that answers `InvalidRegion`.
67
+ * @returns The region, e.g. `"na"`.
68
+ */
69
+ async find_server() {
70
+ for (const server of Object.values(SERVERS)) {
71
+ this.server = server;
72
+ try {
73
+ const { response } = await this._request("GET", "api/1/users/region");
74
+ if (response) {
75
+ this.server = response.fleet_api_base_url;
76
+ if (is_valid_region(response.region)) this.region = response.region;
77
+ this._log(`Using server ${this.server}`);
78
+ return response.region;
79
+ }
80
+ } catch (error) {
81
+ if (error instanceof InvalidRegion) continue;
82
+ throw error;
83
+ }
84
+ }
85
+ throw new LibraryError("Could not find a valid Tesla API server.");
86
+ }
87
+ /**
88
+ * The current access token, calling it first if it is a function.
89
+ * @throws MissingToken when there is no token.
90
+ */
91
+ async access_token() {
92
+ const token = typeof this.accessToken === "function" ? await this.accessToken() : this.accessToken;
93
+ if (token == null) throw new MissingToken();
94
+ return token;
95
+ }
96
+ /**
97
+ * Turn a response into its decoded JSON body, throwing the matching
98
+ * `TeslaFleetError` for an error status and `ResponseError` for a
99
+ * successful response whose body is not JSON.
100
+ */
101
+ async _response(resp) {
102
+ await raise_for_status(resp);
103
+ const text = await resp.text();
104
+ try {
105
+ return JSON.parse(text);
106
+ } catch {
107
+ this._log(`Response type is: ${resp.headers.get("content-type")}`);
108
+ throw new ResponseError(text, resp.status);
109
+ }
110
+ }
111
+ /**
112
+ * Make a request to the Tesla Fleet API.
113
+ * @param method
114
+ * @param path
115
+ * @param params Query parameters; null and undefined values are dropped.
116
+ * @param json Body; null and undefined values are dropped, and a GET sends none.
117
+ * @returns The decoded JSON body.
118
+ * @throws `MissingToken` when there is no access token, a `TeslaFleetError`
119
+ * subclass for an error status, or `TeslaFleetConnectionError` (with the
120
+ * original error as `cause`) when the request could not complete or timed out.
121
+ */
122
+ async _request(method, path, params = null, json = null) {
123
+ const command = path.slice(path.lastIndexOf("/") + 1);
124
+ let data;
125
+ try {
126
+ if (!this.server) throw new Error("Server was not set at init. Call find_server() first.");
127
+ if (method === "GET") json = null;
128
+ const headers = {
129
+ Authorization: `Bearer ${await this.access_token()}`,
130
+ "X-Library": `node tesla_fleet_api 0.5.0`
131
+ };
132
+ const query = new URLSearchParams();
133
+ if (params) {
134
+ for (const [key, value] of Object.entries(params)) if (value != null) query.append(key, typeof value === "boolean" ? value ? "true" : "false" : String(value));
135
+ this._log(`Parameters: ${redactedQuery(query)}`);
136
+ }
137
+ let body = null;
138
+ if (json) {
139
+ json = Object.fromEntries(Object.entries(json).filter(([_, v]) => v != null));
140
+ body = JSON.stringify(json);
141
+ this._log(`Body: ${redactedJson(json)}`);
142
+ headers["Content-Type"] = "application/json";
143
+ }
144
+ const search = query.size ? `?${query.toString()}` : "";
145
+ const url = `${this.server}/${path}${search}`;
146
+ try {
147
+ const resp = await this._fetch(url, {
148
+ method,
149
+ headers,
150
+ body,
151
+ signal: this.timeout != null ? AbortSignal.timeout(this.timeout) : null
152
+ });
153
+ this._log(`Status ${resp.status} from ${this.server}/${path}`);
154
+ for (const [header, label] of [
155
+ ["x-txid", "Response TXID"],
156
+ ["RateLimit-Reset", "Rate limit reset"],
157
+ ["Retry-After", "Retry after"]
158
+ ]) if (resp.headers.has(header)) this._log(`${label}: ${resp.headers.get(header)}`);
159
+ data = await this._response(resp);
160
+ } catch (error) {
161
+ if (error instanceof TeslaFleetError) throw error;
162
+ throw new TeslaFleetConnectionError(null, null, { cause: error });
163
+ }
164
+ this._log(`Response JSON: ${redactedJson(data)}`);
165
+ } catch (error) {
166
+ logRequestError((m) => this._log(m), command, this._transport_name, error);
167
+ throw error;
168
+ }
169
+ logRequestResult((m) => this._log(m), command, this._transport_name, data);
170
+ return data;
171
+ }
172
+ /**
173
+ * Returns `"ok"` if the API is operating normally. Sends no headers.
174
+ */
175
+ async status() {
176
+ if (!this.server) throw new Error("Server was not set at init. Call find_server() first.");
177
+ return (await this._fetch(`${this.server}/status`)).text();
178
+ }
179
+ /**
180
+ * Generate a partner token using client credentials authentication, and use
181
+ * it as the access token for later requests.
182
+ * @param client_id Partner application client ID.
183
+ * @param client_secret Partner application client secret.
184
+ * @param scopes Scopes to request.
185
+ * @returns The token response, including `access_token`.
186
+ */
187
+ async partner_login(client_id, client_secret, scopes = [Scope.OPENID]) {
188
+ if (!this.server) throw new Error("Server was not set at init. Call find_server() first.");
189
+ const resp = await this._fetch(TOKEN_URLS[this.region ?? "na"], {
190
+ method: "POST",
191
+ headers: { "Content-Type": "application/x-www-form-urlencoded" },
192
+ body: new URLSearchParams({
193
+ grant_type: "client_credentials",
194
+ client_id,
195
+ client_secret,
196
+ audience: this.server,
197
+ scope: scopes.join(" ")
198
+ })
199
+ });
200
+ await raise_for_status(resp);
201
+ const tokenData = await resp.json();
202
+ this.accessToken = tokenData.access_token;
203
+ return tokenData;
204
+ }
205
+ /**
206
+ * Returns products mapped to user.
207
+ * @returns An array of products including both vehicles and energy sites.
208
+ */
209
+ async products() {
210
+ return this._request("GET", "api/1/products");
211
+ }
212
+ /**
213
+ * Return Tesla products separated into vehicles and energy_sites
214
+ * @returns A dictionary of vehicles and energy sites, each with an array of those products
215
+ */
216
+ async products_by_type() {
217
+ return this.products().then(({ response: products }) => ({
218
+ vehicles: products.filter((product) => "vin" in product),
219
+ energy_sites: products.filter((product) => "energy_site_id" in product)
220
+ }));
221
+ }
222
+ /**
223
+ * Get or create the P-256 key that signs vehicle commands, and keep it as
224
+ * `private_key`. The file is an unencrypted PEM that Python's
225
+ * `get_private_key` shares, created at mode 0600. If another process wins the
226
+ * create race, its file is read instead.
227
+ * @param path Key file.
228
+ * @returns The raw 32-byte key `Commands` takes.
229
+ * @throws PrivateKeyError for an existing file that cannot be used.
230
+ */
231
+ async get_private_key(path = "private_key.pem") {
232
+ const key = await ecPrivateKeyFile(path);
233
+ this.private_key = key;
234
+ return key;
235
+ }
236
+ /** The raw 32-byte P-256 key, which `createSigned` falls back to. */
237
+ get private_key() {
238
+ return this.#privateKey;
239
+ }
240
+ set private_key(key) {
241
+ this.#privateKey = key;
242
+ }
243
+ /** Whether the private key has been set. */
244
+ get has_private_key() {
245
+ return this.#privateKey != null;
246
+ }
247
+ /** The public key in PEM format. */
248
+ get public_pem() {
249
+ return this.#ecPublicKey("Private key is not set").export({
250
+ type: "spki",
251
+ format: "pem"
252
+ });
253
+ }
254
+ /** The public key's uncompressed point, in hex. */
255
+ get public_uncompressed_point() {
256
+ if (this.#privateKey == null) throw new LibraryError("Private key is not set");
257
+ return publicKeyFor(this.#privateKey).toString("hex");
258
+ }
259
+ /**
260
+ * The EC public key in DER SubjectPublicKeyInfo form, as an energy gateway
261
+ * expects when registering an ECC authorized client. It rejects the raw point
262
+ * that vehicles use.
263
+ */
264
+ get ec_public_der_spki() {
265
+ return this.#ecPublicKey("EC private key is not set").export({
266
+ type: "spki",
267
+ format: "der"
268
+ });
269
+ }
270
+ /** `ec_public_der_spki`, base64-encoded. */
271
+ get ec_public_der_spki_b64() {
272
+ return this.ec_public_der_spki.toString("base64");
273
+ }
274
+ #ecPublicKey(unsetMessage) {
275
+ if (this.#privateKey == null) throw new LibraryError(unsetMessage);
276
+ return ecPublicKey(this.#privateKey);
277
+ }
278
+ /**
279
+ * Get or create the RSA key for energy gateway client registration, and keep
280
+ * it as `rsa_private_key`. The file is an unencrypted PEM that Python's
281
+ * `get_rsa_private_key` shares, created at mode 0600. If another process wins
282
+ * the create race, its file is read instead. Generation runs off the event loop.
283
+ * @param path Key file.
284
+ * @param key_size Modulus length in bits for a new key; 4096 is what Powerwall v1r expects.
285
+ * @throws PrivateKeyError for an existing file that cannot be used.
286
+ */
287
+ async get_rsa_private_key(path = "tedapi_rsa_private.pem", key_size = 4096) {
288
+ const key = await rsaPrivateKeyFile(path, key_size);
289
+ this.rsa_private_key = key;
290
+ return key;
291
+ }
292
+ /** The RSA key for energy gateway client registration. */
293
+ get rsa_private_key() {
294
+ return this.#rsaPrivateKey;
295
+ }
296
+ set rsa_private_key(key) {
297
+ this.#rsaPrivateKey = key;
298
+ }
299
+ /** Whether the RSA private key has been set. */
300
+ get has_rsa_private_key() {
301
+ return this.#rsaPrivateKey != null;
302
+ }
303
+ /**
304
+ * The RSA public key in DER PKCS#1 form, as an energy gateway expects when
305
+ * registering an authorized client.
306
+ */
307
+ get rsa_public_der_pkcs1() {
308
+ return rsaPublicDerPkcs1(this.#rsaKey());
309
+ }
310
+ /** `rsa_public_der_pkcs1`, base64-encoded. */
311
+ get rsa_public_der_pkcs1_b64() {
312
+ return this.rsa_public_der_pkcs1.toString("base64");
313
+ }
314
+ /** The RSA public key in PEM (SubjectPublicKeyInfo) format. */
315
+ get rsa_public_pem() {
316
+ return createPublicKey(this.#rsaKey()).export({
317
+ type: "spki",
318
+ format: "pem"
319
+ });
320
+ }
321
+ #rsaKey() {
322
+ if (this.#rsaPrivateKey == null) throw new LibraryError("RSA private key is not set");
323
+ return this.#rsaPrivateKey;
324
+ }
325
+ };
326
+ export { TeslaFleetApi as default };