@tryvital/vital-node 2.1.0 → 2.1.1

package/.github/workflows/test-build.yaml

@@ -0,0 +1,32 @@
+on:
+  push:
+    branches-ignore:
+      - master
+env:
+  TEST_EU_API_KEY: ${{ secrets.TEST_EU_API_KEY }}
+  TEST_US_API_KEY: ${{ secrets.TEST_US_API_KEY }}
+  TEST_ENVIRONMENT: "sandbox"
+name: Test compile
+jobs:
+  test-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+  test-code:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run test-client

package/__tests__/activity.test.ts

@@ -1,18 +1,17 @@
 import { VitalClient } from "..";
-import { testClient, testEuClient, testApiKeyClient, getUserId } from "./arrange";
+import { testUSClient, testEUClient, getUserId } from "./arrange";
 
 
 describe('Activity', () => {
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('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"),
+            new Date("2022-12-01"),
         )
         expect(data.activity.length).toBeGreaterThan(0)
     });

package/__tests__/arrange.ts

@@ -3,22 +3,15 @@ require('dotenv').config({
     path: '.env'
 })
 
-export const testClient = new VitalClient({
-    client_id: process.env.TEST_CLIENT_ID,
-    client_secret: process.env.TEST_CLIENT_SECRET,
+export const testEUClient = new VitalClient({
+    api_key: process.env.TEST_EU_API_KEY,
     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 testApiKeyClient = new VitalClient({
-    api_key: process.env.TEST_API_KEY,
+
+export const testUSClient = new VitalClient({
+    api_key: process.env.TEST_US_API_KEY,
     environment: process.env.TEST_ENVIRONMENT as any,
     region: "us",
 });

package/__tests__/body.test.ts

@@ -1,17 +1,16 @@
 import { VitalClient } from "..";
-import { getUserId, testApiKeyClient, testClient, testEuClient } from "./arrange";
+import { testEUClient, testUSClient, getUserId } from "./arrange";
 
 describe('Body', () => {
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('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"),
+            new Date("2022-12-01"),
         )
         expect(data.body.length).toBeGreaterThan(0)
     });

package/__tests__/link.test.ts

@@ -1,11 +1,10 @@
 import { VitalClient } from "..";
-import { getUserId, testApiKeyClient, testClient, testEuClient } from "./arrange";
+import { testEUClient, testUSClient, getUserId } from "./arrange";
 
 describe('Link', () => {
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('should create a link token %p', async (region: string, client: VitalClient) => {
         const userId = await getUserId(client)
         const data = await client.Link.create(

package/__tests__/profile.test.ts

@@ -1,11 +1,10 @@
 import { VitalClient } from "..";
-import { testClient, testEuClient, getUserId, testApiKeyClient } from "./arrange";
+import { testEUClient, testUSClient, getUserId } from "./arrange";
 
 describe('Profile', () => {
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('should return profile data %p', async (region: string, client: VitalClient) => {
         const userId = await getUserId(client)
         const data = await client.Profile.get(

package/__tests__/providers.test.ts

@@ -1,6 +1,6 @@
-import { testApiKeyClient } from "./arrange";
+import { testUSClient } from "./arrange";
 
 it('should return supported providers', async () => {
-    const data = await testApiKeyClient.Providers.getSupportedProviders()
+    const data = await testUSClient.Providers.getSupportedProviders()
     expect(data.length).toBeGreaterThan(0)
 })

package/__tests__/sleep.test.ts

@@ -1,31 +1,29 @@
 import { VitalClient } from "..";
-import { testClient, testEuClient, getUserId, testApiKeyClient } from "./arrange";
+import { testEUClient, testUSClient, getUserId } from "./arrange";
 
 describe('Sleep', () => {
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('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"),
+            new Date("2022-12-01"),
         )
         expect(data.sleep.length).toBeGreaterThan(0)
     });
 
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('should return sleep stream data %p', async (region: string, client: VitalClient) => {
         const userId = await getUserId(client)
         const data = await client.Sleep.getSleepWithStream(
             userId,
-            new Date("2021-09-10"),
-            new Date("2021-10-10"),
+            new Date("2022-10-30"),
+            new Date("2022-11-01"),
         )
         expect(data.sleep.length).toBeGreaterThan(0)
         expect(data.sleep[0].sleep_stream).toBeDefined()

package/__tests__/user.test.ts

@@ -1,12 +1,11 @@
 import { VitalClient } from "..";
-import { getUserId, randomString, testApiKeyClient, testClient, testEuClient, test_user_id } from "./arrange";
+import { testEUClient, testUSClient, getUserId, randomString, test_user_id } from "./arrange";
 
 describe('User', () => {
     const user_id = randomString(10);
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('should create a user %p', async (region: string, client: VitalClient) => {
         const user = await client.User.create(
             user_id,
@@ -15,9 +14,8 @@ describe('User', () => {
     });
 
     it.each([
-        testClient,
-        testEuClient,
-        testApiKeyClient
+        testEUClient,
+        testUSClient,
     ])('should find a user', async (client: VitalClient) => {
         const user = await client.User.resolve(
             test_user_id,
@@ -26,9 +24,8 @@ describe('User', () => {
     });
 
     it.each([
-        testClient,
-        testEuClient,
-        testApiKeyClient
+        testEUClient,
+        testUSClient,
     ])('should delete a user', async (client: VitalClient) => {
         const userToDelete = await getUserId(client, user_id);
         const user = await client.User.delete(

package/__tests__/vitals.test.ts

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

package/__tests__/workouts.test.ts

@@ -1,17 +1,16 @@
 import { VitalClient } from "..";
-import { testClient, testEuClient, getUserId, testApiKeyClient } from "./arrange";
+import { testEUClient, testUSClient, getUserId } from "./arrange";
 
 describe('Workouts', () => {
     it.each([
-        ["us", testClient],
-        ["eu", testEuClient],
-        ["us_api_key", testApiKeyClient],
+        ["eu_api_key", testEUClient],
+        ["us_api_key", testUSClient],
     ])('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"),
+            new Date("2022-12-01"),
         )
         expect(data.workouts.length).toBeGreaterThan(0)
     });

package/client/LabTests.ts

@@ -8,7 +8,7 @@ import {
     PatientAdress,
     PatientDetails,
     Physician,
-} from './models/testkit_models';
+} from './models/lab_tests_model';
 
 
 
@@ -96,8 +96,6 @@ export class ResultsApi {
 
 
 
-
-
 export class LabTestsApi {
     baseURL: string;
     client: AxiosInstance;

package/client/Testkits.ts

@@ -0,0 +1,107 @@
+import { AxiosInstance } from 'axios';
+import {
+  LabResultsMetadata,
+  LabResultsRaw,
+  Order,
+  OrderRequestResponse,
+  OrderResponse,
+  PatientAdress,
+  PatientDetails,
+  TestkitResponse,
+} from './models/testkit_models';
+
+export class TestkitsApi {
+  baseURL: string;
+  client: AxiosInstance;
+  constructor(baseURL: string, axios: AxiosInstance) {
+    this.baseURL = baseURL;
+    this.client = axios;
+  }
+
+  public async get(): Promise<TestkitResponse> {
+    const resp = await this.client.get(this.baseURL.concat('/testkit'));
+    return resp.data;
+  }
+
+  public async get_orders(
+    startDate: Date,
+    endDate: Date,
+    status?: string[],
+    userId?: string,
+    patientName?: string,
+    page?: number,
+    size?: number
+  ): Promise<OrderResponse> {
+    const resp = await this.client.get(
+      this.baseURL.concat('/testkit/orders'),
+      {
+        params: {
+          start_date: startDate,
+          end_date: endDate,
+          status: status ? status : null,
+          user_id: userId ? userId : null,
+          patient_name: patientName ? patientName : null,
+          ...(page && { page }),
+          ...(size && { size }),
+        },
+      }
+    );
+    return resp.data;
+  }
+
+  public async order(
+    userId: string,
+    testkitId: string,
+    patientAddress: PatientAdress,
+    patientDetails: PatientDetails
+  ): Promise<OrderRequestResponse> {
+    const resp = await this.client.post(
+      this.baseURL.concat('/testkit/orders'),
+      {
+        user_key: userId,
+        testkit_id: testkitId,
+        patient_address: patientAddress,
+        patient_details: patientDetails,
+      }
+    );
+    return resp.data;
+  }
+
+  public async get_order(orderId: string): Promise<Order> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/testkit/orders/${orderId}`)
+    );
+    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`),
+      {
+        responseType: 'arraybuffer',
+      }
+    );
+    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/index.ts

@@ -9,3 +9,4 @@ export { LabTestsApi } from './LabTests';
 export { ProfileApi } from './Profile';
 export { DevicesAPI } from './Devices';
 export { MealsApi } from './Meals';
+export { TestkitsApi } from "./Testkits";

package/client/models/lab_tests_model.ts

@@ -0,0 +1,129 @@
+export interface PatientAdress {
+  receiver_name: string;
+  city: string;
+  state: string;
+  zip: string;
+  country: string;
+  street_number?: string;
+}
+
+export interface PatientDetails {
+  dob: string;
+  gender: string;
+  email?: string;
+  first_name: string;
+  phone_number: string;
+  last_name: string;
+}
+
+export interface Physician {
+  first_name: string;
+  last_name: string;
+  npi: string;
+  email?: string;
+  licensed_states?: string[];
+  created_at?: string;
+  updated_at?: string;
+}
+
+export interface Marker {
+  name: string;
+  slug: string;
+  description?: string;
+}
+
+export interface Testkit {
+  id: string;
+  name: string;
+  description: string;
+  markers: Marker[];
+  turnaround_time_lower: number;
+  turnaround_time_upper: number;
+  price: number;
+}
+
+export interface TestkitEvent {
+  id: number;
+  created_at: string;
+  status: string;
+}
+
+export interface Order {
+  user_id: string;
+  id: string;
+  team_id: string;
+  patient_details: PatientDetails;
+  patient_address: PatientAdress;
+  lab_test: Testkit;
+  // TODO  CHECK WHAT DETAILS IS
+  details: Object;
+  created_at: string;
+  updated_at: string;
+  events: TestkitEvent;
+  user_key?: string;
+  sample_id?: string;
+  notes?: string;
+  status?:
+    | 'ordered'
+    | 'transit_customer'
+    | 'out_for_delivery'
+    | 'with_customer'
+    | 'transit_lab'
+    | 'delivered_to_lab'
+    | 'processing_lab'
+    | 'completed'
+    | 'failure_to_deliver_to_customer'
+    | 'failure_to_deliver_to_lab'
+    | 'cancelled'
+    | 'do_not_process'
+    | 'unknown'
+    | 'rejected'
+    | 'lost';
+}
+
+export interface OrderRequestResponse {
+  order: Order;
+  status: string;
+  message: string;
+}
+
+export interface LabClientFacing {
+  slug: string;
+  name: string;
+  first_line_address: string;
+  city: string;
+  zipcode: string;
+}
+
+export interface ClientFacingLabTest {
+  id: string;
+  slug: string;
+  name: string;
+  sample_type: string;
+  method: string;
+  price: number;
+  is_active: boolean;
+  lab: LabClientFacing;
+  markers: Marker;
+}
+export interface TestkitResponse {
+  testkits: Testkit[];
+}
+
+export interface LabResultsMetadata {
+  age: string;
+  dob: string;
+  patient: string;
+  date_reported: string;
+  date_collected: string;
+  specimen_number: string;
+  clia?: string;
+  provider?: string;
+  laboratory?: string;
+  date_received?: string;
+}
+
+export interface LabResultsResponse {
+  metadata: LabResultsMetadata;
+  results: Object;
+}

package/client/models/testkit_models.ts

@@ -1,33 +1,18 @@
-import internal = require("stream");
-import { IntegrationKeyOut } from "svix";
-
 export interface PatientAdress {
   receiver_name: string;
-  street: string;
+  first_line: string;
+  second_line?: string;
   city: string;
   state: string;
   zip: string;
   country: string;
   phone_number: string;
-  street_number?: string;
 }
 
 export interface PatientDetails {
   dob: string;
   gender: string;
-  email: string;
-}
-
-export interface Physician {
-  first_name: string;
-  last_name: string;
-  npi: string;
-  email?: string;
-  licensed_states?: string[];
-  created_at?: string;
-  updated_at?: string;
 }
-
 export interface Marker {
   name: string;
   slug: string;
@@ -44,30 +29,18 @@ export interface Testkit {
   price: number;
 }
 
-export interface TestkitEvent {
-  id: number;
-  created_at: string;
-  status: string;
-}
-
-
-
 export interface Order {
-  user_id: string;
   id: string;
   team_id: string;
+  created_on: Date;
+  updated_on: Date;
   patient_details: PatientDetails;
   patient_address: PatientAdress;
-  lab_test: Testkit;
-  // TODO  CHECK WHAT DETAILS IS
-  details: Object;
   created_at: string;
   updated_at: string;
-  events: TestkitEvent;
-  user_key?: string;
   sample_id?: string;
   notes?: string;
-  status?:
+  status:
   | 'ordered'
   | 'transit_customer'
   | 'out_for_delivery'
@@ -83,6 +56,20 @@ export interface Order {
   | 'unknown'
   | "rejected"
   | "lost";
+  user_key: string;
+  testkit_id: string;
+  testkit: Testkit;
+  inbound_tracking_number?: string;
+  outbound_tracking_number?: string;
+  outbound_courier?: string;
+  inbound_courier?: string;
+}
+
+export interface OrderResponse {
+  orders: Order[];
+  total: number;
+  page: number;
+  size: number;
 }
 
 export interface OrderRequestResponse {
@@ -91,25 +78,6 @@ export interface OrderRequestResponse {
   message: string;
 }
 
-export interface LabClientFacing {
-  slug: string;
-  name: string;
-  first_line_address: string;
-  city: string;
-  zipcode: string;
-}
-
-export interface ClientFacingLabTest {
-  id: string;
-  slug: string;
-  name: string;
-  sample_type: string;
-  method: string;
-  price: number;
-  is_active: boolean;
-  lab: LabClientFacing;
-  markers: Marker;
-}
 export interface TestkitResponse {
   testkits: Testkit[];
 }
@@ -117,17 +85,18 @@ export interface TestkitResponse {
 export interface LabResultsMetadata {
   age: string;
   dob: string;
+  clia_number: string;
   patient: string;
+  provider: string;
+  laboratory: string;
   date_reported: string;
   date_collected: string;
   specimen_number: string;
-  clia?: string;
-  provider?: string;
-  laboratory?: string;
   date_received?: string;
+  clia?: string;
 }
 
-export interface LabResultsResponse {
+export interface LabResultsRaw {
   metadata: LabResultsMetadata;
-  results: Object;
-}
+  results: Record<string, string>;
+}

package/dist/client/LabTests.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { ClientFacingLabTest, LabResultsMetadata, LabResultsResponse, Order, OrderRequestResponse, PatientAdress, PatientDetails, Physician } from './models/testkit_models';
+import { ClientFacingLabTest, LabResultsMetadata, LabResultsResponse, Order, OrderRequestResponse, PatientAdress, PatientDetails, Physician } from './models/lab_tests_model';
 export declare class OrdersApi {
     baseURL: string;
     client: AxiosInstance;