@tryvital/vital-node 1.1.0 → 1.3.0

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "jest.autoEnable": false
+}

package/__tests__/activity.test.ts

@@ -0,0 +1,18 @@
+import { VitalClient } from "..";
+import { testClient, testEuClient, getUserId } from "./arrange";
+
+
+describe('Activity', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return activity data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Activity.get(
+            userId,
+            new Date("2020-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.activity.length).toBeGreaterThan(0)
+    });
+})

package/__tests__/arrange.ts

@@ -0,0 +1,36 @@
+import { VitalClient } from "..";
+require('dotenv').config({
+    path: '.env'
+})
+
+export const testClient = new VitalClient({
+    client_id: process.env.TEST_CLIENT_ID,
+    client_secret: process.env.TEST_CLIENT_SECRET,
+    environment: process.env.TEST_ENVIRONMENT as any,
+    region: "us",
+});
+
+export const testEuClient = new VitalClient({
+    client_id: process.env.TEST_EU_CLIENT_ID,
+    client_secret: process.env.TEST_EU_CLIENT_SECRET,
+    environment: "development",
+    region: "eu",
+});
+
+export const test_user_id = "test_user_1234";
+
+export const getUserId = async (client: VitalClient, user_id: string = test_user_id) => {
+    const data = await client.User.resolve(user_id);
+    return data.user_id;
+}
+
+export function randomString(length: number): string {
+    var result = '';
+    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    var charactersLength = characters.length;
+    for (var i = 0; i < length; i++) {
+        result += characters.charAt(Math.floor(Math.random() *
+            charactersLength));
+    }
+    return result;
+}

package/__tests__/body.test.ts

@@ -0,0 +1,17 @@
+import { VitalClient } from "..";
+import { getUserId, testClient, testEuClient } from "./arrange";
+
+describe('Body', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return body data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Body.get(
+            userId,
+            new Date("2021-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.body.length).toBeGreaterThan(0)
+    });
+})

package/__tests__/devices.test.ts

@@ -0,0 +1,15 @@
+import { VitalClient } from "..";
+import { testClient, testEuClient, getUserId } from "./arrange";
+
+describe('Devices', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return device data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Devices.get_raw(
+            userId,
+        )
+        expect(data.devices.length).toBeGreaterThan(0)
+    });
+})

package/__tests__/link.test.ts

@@ -0,0 +1,15 @@
+import { VitalClient } from "..";
+import { getUserId, testClient, testEuClient } from "./arrange";
+
+describe('Link', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should create a link token %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Link.create(
+            userId,
+        )
+        expect(data.link_token).toBeDefined()
+    });
+})

package/__tests__/profile.test.ts

@@ -0,0 +1,15 @@
+import { VitalClient } from "..";
+import { testClient, testEuClient, getUserId } from "./arrange";
+
+describe('Profile', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return profile data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Profile.get(
+            userId,
+        )
+        expect(data.user_id).toBe(userId)
+    });
+})

package/__tests__/sleep.test.ts

@@ -0,0 +1,17 @@
+import { VitalClient } from "..";
+import { testClient, testEuClient, getUserId } from "./arrange";
+
+describe('Sleep', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return sleep data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Sleep.get(
+            userId,
+            new Date("2021-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.sleep.length).toBeGreaterThan(0)
+    });
+})

package/__tests__/user.test.ts

@@ -0,0 +1,37 @@
+import { VitalClient } from "..";
+import { getUserId, randomString, testClient, testEuClient, test_user_id } from "./arrange";
+
+describe('User', () => {
+    const user_id = randomString(10);
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should create a user %p', async (region: string, client: VitalClient) => {
+        const user = await client.User.create(
+            user_id,
+        )
+        expect(user.client_user_id).toBe(user_id)
+    });
+
+    it.each([
+        testClient,
+        testEuClient
+    ])('should find a user', async (client: VitalClient) => {
+        const user = await client.User.resolve(
+            test_user_id,
+        )
+        expect(user.client_user_id).toBe(test_user_id)
+    });
+
+    it.each([
+        testClient,
+        testEuClient
+    ])('should delete a user', async (client: VitalClient) => {
+        const userToDelete = await getUserId(client, user_id);
+        const user = await client.User.delete(
+            userToDelete,
+        )
+        expect(user.success).toBe(true)
+    });
+
+})

package/__tests__/vitals.test.ts

@@ -0,0 +1,17 @@
+import { VitalClient } from "..";
+import { testClient, testEuClient, getUserId } from "./arrange";
+
+describe('Vitals', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return glucose data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Vitals.glucose(
+            userId,
+            new Date("2021-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.length).toBeGreaterThan(0)
+    });
+})

package/__tests__/workouts.test.ts

@@ -0,0 +1,17 @@
+import { VitalClient } from "..";
+import { testClient, testEuClient, getUserId } from "./arrange";
+
+describe('Workouts', () => {
+    it.each([
+        ["us", testClient],
+        ["eu", testEuClient]
+    ])('should return workout data %p', async (region: string, client: VitalClient) => {
+        const userId = await getUserId(client)
+        const data = await client.Workouts.get(
+            userId,
+            new Date("2021-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.workouts.length).toBeGreaterThan(0)
+    });
+})

package/client/Activity.ts

@@ -11,13 +11,13 @@ export class ActivityApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientActivityResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/activity/${userKey}`),
+      this.baseURL.concat(`/summary/activity/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -26,13 +26,13 @@ export class ActivityApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientActivityRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/activity/${userKey}/raw`),
+      this.baseURL.concat(`/summary/activity/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Body.ts

@@ -12,13 +12,13 @@ export class BodyApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientBodyResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/body/${userKey}`),
+      this.baseURL.concat(`/summary/body/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -26,15 +26,14 @@ export class BodyApi {
     return resp.data;
   }
 
-
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientBodyRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/body/${userKey}/raw`),
+      this.baseURL.concat(`/summary/body/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Devices.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from 'axios';
+import { ClientDevicesRawResponse } from './models/raw_response';
+
+export class DevicesAPI {
+  baseURL: string;
+  client: AxiosInstance;
+
+  constructor(baseURL: string, axios: AxiosInstance) {
+    this.baseURL = baseURL;
+    this.client = axios;
+  }
+
+  public async get_raw(
+    userId: string,
+    provider?: string
+  ): Promise<ClientDevicesRawResponse> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/summary/devices/${userId}/raw`),
+      {
+        params: { provider },
+      }
+    );
+    return resp.data;
+  }
+}

package/client/Link.ts

@@ -17,11 +17,11 @@ export class LinkApi {
   }
 
   public async create(
-    userKey: string,
+    userId: string,
     provider: string = null
   ): Promise<LinkTokenExchangeResponse> {
     const resp = await this.client.post(this.baseURL.concat('/link/token/'), {
-      user_key: userKey,
+      user_key: userId,
       provider,
     });
     return resp.data;

package/client/Profile.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { ClientFacingProfile, } from './models/profile_model';
+import { ClientFacingProfile } from './models/profile_model';
 import { ClientProfileRawResponse } from './models/raw_response';
 
 export class ProfileApi {
@@ -12,11 +12,11 @@ export class ProfileApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     provider?: string
   ): Promise<ClientFacingProfile> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/profile/${userKey}`),
+      this.baseURL.concat(`/summary/profile/${userId}`),
       {
         params: { provider },
       }
@@ -25,13 +25,13 @@ export class ProfileApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientProfileRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/profile/${userKey}/raw`),
+      this.baseURL.concat(`/summary/profile/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Provider.ts

@@ -0,0 +1,17 @@
+import { AxiosInstance } from 'axios';
+import { Provider } from './models/provider_models';
+
+export class ProviderApi {
+  baseURL: string;
+  client: AxiosInstance;
+
+  constructor(baseURL: string, axios: AxiosInstance) {
+    this.baseURL = baseURL;
+    this.client = axios;
+  }
+
+  public async getSupportedProviders(): Promise<Provider[]> {
+    const resp = await this.client.get(this.baseURL.concat('/providers/'));
+    return resp.data;
+  }
+}

package/client/Sleep.ts

@@ -1,5 +1,8 @@
 import { AxiosInstance } from 'axios';
-import { ClientSleepResponse, ClientSleepStreamResponse  } from './models/sleep_models';
+import {
+  ClientSleepResponse,
+  ClientSleepStreamResponse,
+} from './models/sleep_models';
 import { ClientSleepRawResponse } from './models/raw_response';
 
 export class SleepApi {
@@ -11,13 +14,13 @@ export class SleepApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientSleepResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/sleep/${userKey}`),
+      this.baseURL.concat(`/summary/sleep/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -33,13 +36,13 @@ export class SleepApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientSleepRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/sleep/${userKey}/raw`),
+      this.baseURL.concat(`/summary/sleep/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/Testkits.ts

@@ -1,5 +1,7 @@
 import { AxiosInstance } from 'axios';
 import {
+  LabResultsMetadata,
+  LabResultsRaw,
   Order,
   OrderRequestResponse,
   OrderResponse,
@@ -23,19 +25,20 @@ export class TestkitsApi {
 
   public async get_orders(
     startDate: Date,
-    endDate: Date
+    endDate: Date,
+    status?: string[],
   ): Promise<OrderResponse> {
     const resp = await this.client.get(
       this.baseURL.concat('/testkit/orders/'),
       {
-        params: { start_date: startDate, end_date: endDate },
+        params: { start_date: startDate, end_date: endDate, status: status ? status : null},
       }
     );
     return resp.data;
   }
 
   public async order(
-    userKey: string,
+    userId: string,
     testkitId: string,
     patientAddress: PatientAdress,
     patientDetails: PatientDetails
@@ -43,7 +46,7 @@ export class TestkitsApi {
     const resp = await this.client.post(
       this.baseURL.concat('/testkit/orders'),
       {
-        user_key: userKey,
+        user_key: userId,
         testkit_id: testkitId,
         patient_address: patientAddress,
         patient_details: patientDetails,
@@ -59,6 +62,13 @@ export class TestkitsApi {
     return resp.data;
   }
 
+  public async cancel_order(orderId: string): Promise<OrderRequestResponse> {
+    const resp = await this.client.post(
+      this.baseURL.concat(`/testkit/orders/${orderId}/cancel`)
+    );
+    return resp.data;
+  }
+
   public async get_results(orderId: string): Promise<string> {
     const resp = await this.client.get(
       this.baseURL.concat(`/testkit/orders/${orderId}/results`),
@@ -68,4 +78,18 @@ export class TestkitsApi {
     );
     return resp.data;
   }
+
+  public async getMetadata(orderId: string): Promise<LabResultsMetadata> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/testkit/orders/${orderId}/results/metadata`)
+    );
+    return resp.data;
+  }
+
+  public async getRawResults(orderId: string): Promise<LabResultsRaw> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/testkit/orders/${orderId}/results/raw`)
+    );
+    return resp.data;
+  }
 }

package/client/User.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import {
-  UserKeyResponse,
+  UserIdResponse,
   SuccessResponse,
   ClientFacingUser,
   Providers,
@@ -15,16 +15,16 @@ export class UserApi {
     this.client = axios;
   }
 
-  public async create(clientUserId: string): Promise<UserKeyResponse> {
+  public async create(clientUserId: string): Promise<UserIdResponse> {
     const resp = await this.client.post(this.baseURL.concat('/user/key'), {
       client_user_id: clientUserId,
     });
     return resp.data;
   }
 
-  public async delete(userKey: string): Promise<SuccessResponse> {
+  public async delete(userId: string): Promise<SuccessResponse> {
     const resp = await this.client.delete(
-      this.baseURL.concat(`/user/${userKey}`)
+      this.baseURL.concat(`/user/${userId}`)
     );
     return resp.data;
   }
@@ -34,8 +34,8 @@ export class UserApi {
     return resp.data;
   }
 
-  public async get(userKey: string): Promise<ClientFacingUser> {
-    const resp = await this.client.get(this.baseURL.concat(`/user/${userKey}`));
+  public async get(userId: string): Promise<ClientFacingUser> {
+    const resp = await this.client.get(this.baseURL.concat(`/user/${userId}`));
     return resp.data;
   }
 
@@ -46,19 +46,28 @@ export class UserApi {
     return resp.data;
   }
 
-  public async providers(userKey: string): Promise<ProvidersResponse> {
+  public async providers(userId: string): Promise<ProvidersResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/user/providers/${userKey}`)
+      this.baseURL.concat(`/user/providers/${userId}`)
     );
     return resp.data;
   }
 
   public async deregisterProvider(
-    userKey: string,
+    userId: string,
     provider: Providers
   ): Promise<SuccessResponse> {
     const resp = await this.client.delete(
-      this.baseURL.concat(`/user/${userKey}/${provider}`)
+      this.baseURL.concat(`/user/${userId}/${provider}`)
+    );
+    return resp.data;
+  }
+
+  public async refresh(
+    userId: string,
+  ): Promise<SuccessResponse> {
+    const resp = await this.client.post(
+      this.baseURL.concat(`/user/refresh/${userId}`)
     );
     return resp.data;
   }

package/client/Vitals.ts

@@ -27,13 +27,13 @@ export class VitalsApi {
 
   public async cholesterol(
     type: 'ldl' | 'total' | 'triglycerides' | 'hdl',
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
-      userKey,
+      userId,
       `cholesterol/${type}`,
       startDate,
       endDate,
@@ -42,13 +42,13 @@ export class VitalsApi {
   }
 
   public async glucose(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
-      userKey,
+      userId,
       'glucose',
       startDate,
       endDate,
@@ -57,31 +57,31 @@ export class VitalsApi {
   }
 
   public async ige(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
-    return this.timeseriesData(userKey, 'ige', startDate, endDate, provider);
+    return this.timeseriesData(userId, 'ige', startDate, endDate, provider);
   }
 
   public async igg(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
-    return this.timeseriesData(userKey, 'igg', startDate, endDate, provider);
+    return this.timeseriesData(userId, 'igg', startDate, endDate, provider);
   }
 
   public async heartrate(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
-      userKey,
+      userId,
       'heartrate',
       startDate,
       endDate,

package/client/Workouts.ts

@@ -14,13 +14,13 @@ export class WorkoutsApi {
   }
 
   public async get(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientWorkoutResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/workouts/${userKey}`),
+      this.baseURL.concat(`/summary/workouts/${userId}`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -38,13 +38,13 @@ export class WorkoutsApi {
   }
 
   public async get_raw(
-    userKey: string,
+    userId: string,
     startDate: Date,
     endDate: Date,
     provider?: string
   ): Promise<ClientWorkoutsRawResponse> {
     const resp = await this.client.get(
-      this.baseURL.concat(`/summary/workouts/${userKey}/raw`),
+      this.baseURL.concat(`/summary/workouts/${userId}/raw`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }

package/client/index.ts

@@ -7,3 +7,4 @@ export { WebhooksApi } from './Webhooks';
 export { WorkoutsApi } from './Workouts';
 export { TestkitsApi } from './Testkits';
 export { ProfileApi } from './Profile';
+export { DevicesAPI } from './Devices';