tesla-fleet-api 0.0.5 → 0.0.6

package/src/helpers.ts

@@ -0,0 +1,11 @@
+import { CommandResponse } from "./types.js";
+
+export const validate = async (body: CommandResponse): Promise<void> => {
+    if (body?.error) {
+        return Promise.reject(body.error);
+    }
+    if (body?.response?.result == false) {
+        return Promise.reject(body.response.reason);
+    }
+    return Promise.resolve();
+};

package/src/teslafleetapi.ts

@@ -63,6 +63,14 @@ export default class TeslaFleetApi {
         }
     }
 
+    /**
+     * Make a request to the Tesla Fleet API.
+     * @param method
+     * @param path
+     * @param params
+     * @param json
+     * @returns
+     */
     async _request(method: Method, path: string, params: Record<string, any> | null = null, json: Record<string, any> | null = null): Promise<any> {
         if (!this.server) {
             throw new Error("Server was not set at init. Call findServer() first.");

package/src/teslemetry.ts

@@ -7,12 +7,17 @@ export default class Telemetry extends TeslaFleetApi {
         super({ accessToken, server: `https://${region}.teslemetry.com`, partnerScope: false, userScope: false });
     }
 
-    /** Test the connection to Teslemetry */
+    /**
+     * Test the connection to Teslemetry
+     */
     async test() {
         return this._request("GET", "/api/test");
     }
 
-    /** Get details about your Teslemetry account */
+    /**
+     * 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) {
         this._request("GET", "/api/metadata").then((metadata) => {
             if (update_region) {

package/src/tessie.ts

@@ -6,7 +6,9 @@ export default class Telemetry extends TeslaFleetApi {
         super({ accessToken, server: `https://api.tessie.com`, partnerScope: false, userScope: false });
     }
 
-    /** Get your approved Tesla scopes */
+    /**
+     * Get your approved Tesla scopes
+     */
     async tesla_scopes(): Promise<Scope[]> {
         return this._request("GET", "auth/tesla_scopes");
     }

package/src/types.ts

@@ -1,3 +1,11 @@
+export interface CommandResponse {
+    response: {
+        result: boolean;
+        reason: string;
+    };
+    error: string;
+}
+
 export type Scope =
     | "user_data"
     | "vehicle_device_data"

package/src/user.ts

@@ -1,4 +1,5 @@
 import TeslaFleetApi from "./teslafleetapi.js";
+import { CommandResponse } from "./types.js";
 
 export default class User {
     parent: TeslaFleetApi;
@@ -8,27 +9,27 @@ export default class User {
     }
 
     /** Returns the public key associated with the user. */
-    async backup_key(): Promise<Record<string, any>> {
+    async backup_key(): Promise<CommandResponse> {
         return this.parent._request("GET", "api/1/users/backup_key");
     }
 
     /** Returns any custom feature flag applied to a user. */
-    async feature_config(): Promise<Record<string, any>> {
+    async feature_config(): Promise<CommandResponse> {
         return this.parent._request("GET", "api/1/users/feature_config");
     }
 
     /** Returns a summary of a user's account. */
-    async me(): Promise<Record<string, any>> {
+    async me(): Promise<CommandResponse> {
         return this.parent._request("GET", "api/1/users/me");
     }
 
     /** Returns the active orders for a user. */
-    async orders(): Promise<Record<string, any>> {
+    async orders(): Promise<CommandResponse> {
         return this.parent._request("GET", "api/1/users/orders");
     }
 
     /** Returns a user's region and appropriate fleet-api base URL. Accepts no parameters, response is based on the authentication token subject. */
-    async region(): Promise<Record<string, any>> {
+    async region(): Promise<CommandResponse> {
         return this.parent._request("GET", "api/1/users/region");
     }
 }