@tryvital/vital-node 1.3.3 → 1.3.6

package/README.md

@@ -2,7 +2,6 @@
 
 Node client for using Vital API.
 
-
 ### Install
 
 With npm:
@@ -17,22 +16,6 @@ With yarn
 yarn add @tryvital/vital-node
 ```
 
-
 ## Documentation
 
-The official [Vital Link docs](https://docs.tryvital.io) provide a full reference on using this library.
-
-
-### Examples
-```
-const { VitalClient } = require("Vital");
-
-const client = new VitalClient({
-  client_id: <CLIENT_ID>,
-  client_secret:  <CLIENT_SECRET>,
-  environment: "sandbox",
-});
-
-const resp = await client.User.getUser(user_key)
-const data = await resp.data
-```
+Please refer to the official [Vital docs](https://docs.tryvital.io) provide a full reference on using this library.

package/__tests__/activity.test.ts

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

package/__tests__/arrange.ts

@@ -17,6 +17,12 @@ export const testEuClient = new VitalClient({
     region: "eu",
 });
 
+export const testApiKeyClient = new VitalClient({
+    api_key: process.env.TEST_API_KEY,
+    environment: process.env.TEST_ENVIRONMENT as any,
+    region: "us",
+});
+
 export const test_user_id = "test_user_1234";
 
 export const getUserId = async (client: VitalClient, user_id: string = test_user_id) => {

package/__tests__/body.test.ts

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

package/__tests__/devices.test.ts

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

package/__tests__/link.test.ts

@@ -1,10 +1,11 @@
 import { VitalClient } from "..";
-import { getUserId, testClient, testEuClient } from "./arrange";
+import { getUserId, testApiKeyClient, testClient, testEuClient } from "./arrange";
 
 describe('Link', () => {
     it.each([
         ["us", testClient],
-        ["eu", testEuClient]
+        ["eu", testEuClient],
+        ["us_api_key", testApiKeyClient],
     ])('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,10 +1,11 @@
 import { VitalClient } from "..";
-import { testClient, testEuClient, getUserId } from "./arrange";
+import { testClient, testEuClient, getUserId, testApiKeyClient } from "./arrange";
 
 describe('Profile', () => {
     it.each([
         ["us", testClient],
-        ["eu", testEuClient]
+        ["eu", testEuClient],
+        ["us_api_key", testApiKeyClient],
     ])('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

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

package/__tests__/sleep.test.ts

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

package/__tests__/user.test.ts

@@ -1,11 +1,12 @@
 import { VitalClient } from "..";
-import { getUserId, randomString, testClient, testEuClient, test_user_id } from "./arrange";
+import { getUserId, randomString, testApiKeyClient, testClient, testEuClient, test_user_id } from "./arrange";
 
 describe('User', () => {
     const user_id = randomString(10);
     it.each([
         ["us", testClient],
-        ["eu", testEuClient]
+        ["eu", testEuClient],
+        ["us_api_key", testApiKeyClient],
     ])('should create a user %p', async (region: string, client: VitalClient) => {
         const user = await client.User.create(
             user_id,
@@ -15,7 +16,8 @@ describe('User', () => {
 
     it.each([
         testClient,
-        testEuClient
+        testEuClient,
+        testApiKeyClient
     ])('should find a user', async (client: VitalClient) => {
         const user = await client.User.resolve(
             test_user_id,
@@ -25,7 +27,8 @@ describe('User', () => {
 
     it.each([
         testClient,
-        testEuClient
+        testEuClient,
+        testApiKeyClient
     ])('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,10 +1,11 @@
 import { VitalClient } from "..";
-import { testClient, testEuClient, getUserId } from "./arrange";
+import { testClient, testEuClient, getUserId, testApiKeyClient } from "./arrange";
 
 describe('Vitals', () => {
     it.each([
         ["us", testClient],
-        ["eu", testEuClient]
+        ["eu", testEuClient],
+        ["us_api_key", testApiKeyClient],
     ])('should return glucose data %p', async (region: string, client: VitalClient) => {
         const userId = await getUserId(client)
         const data = await client.Vitals.glucose(

package/__tests__/workouts.test.ts

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

package/client/models/testkit_models.ts

@@ -1,7 +1,7 @@
 export interface PatientAdress {
   receiver_name: string;
-  street_number: string;
-  street: string;
+  first_line: string;
+  second_line?: string;
   city: string;
   state: string;
   zip: string;

package/dist/client/models/testkit_models.d.ts

@@ -1,7 +1,7 @@
 export interface PatientAdress {
     receiver_name: string;
-    street_number: string;
-    street: string;
+    first_line: string;
+    second_line?: string;
     city: string;
     state: string;
     zip: string;

package/dist/index.js

@@ -59,7 +59,14 @@ var VitalClient = /** @class */ (function () {
     function VitalClient(config) {
         var _this = this;
         this.config = config;
-        this.clientCredentials = new credentials_1.ClientCredentials(config);
+        if (!config.api_key) {
+            try {
+                this.clientCredentials = new credentials_1.ClientCredentials(config);
+            }
+            catch (error) {
+                throw new Error("You must provide either an API key or a client ID and secret");
+            }
+        }
         var baseURL;
         if (this.config.region && this.config.region === 'eu') {
             baseURL = config_1.default.baseEUUrls[config.environment];
@@ -73,13 +80,22 @@ var VitalClient = /** @class */ (function () {
             retryDelay: axios_retry_1.default.exponentialDelay,
         });
         axiosApiInstance.interceptors.request.use(function (config) { return __awaiter(_this, void 0, void 0, function () {
-            var token;
+            var headers, token;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.clientCredentials.access_token()];
-                    case 1:
+                    case 0:
+                        headers = config.headers;
+                        if (!this.config.api_key) return [3 /*break*/, 1];
+                        headers["x-vital-api-key"] = this.config.api_key;
+                        return [3 /*break*/, 3];
+                    case 1: return [4 /*yield*/, this.clientCredentials.access_token()];
+                    case 2:
                         token = _a.sent();
-                        config.headers = __assign(__assign({}, config.headers), { 'x-vital-client-id': this.config.client_id, Authorization: "Bearer " + token });
+                        headers["Authorization"] = "Bearer " + token;
+                        headers["x-vital-client-id"] = this.config.client_id;
+                        _a.label = 3;
+                    case 3:
+                        config.headers = __assign({}, headers);
                         return [2 /*return*/, config];
                 }
             });

package/dist/lib/models.d.ts

@@ -1,6 +1,7 @@
 export interface ClientConfig {
-    client_id: string;
-    client_secret: string;
+    client_id?: string;
+    client_secret?: string;
+    api_key?: string;
     environment: 'prod' | 'production' | 'sandbox' | 'development';
     region?: 'us' | 'eu';
 }

package/index.ts

@@ -36,7 +36,13 @@ export class VitalClient {
 
   constructor(config: ClientConfig) {
     this.config = config;
-    this.clientCredentials = new ClientCredentials(config);
+    if(!config.api_key){
+      try {
+        this.clientCredentials = new ClientCredentials(config);
+      } catch (error) {
+        throw new Error("You must provide either an API key or a client ID and secret");
+      }
+    }
     let baseURL;
     if (this.config.region && this.config.region === 'eu') {
       baseURL = CONFIG.baseEUUrls[config.environment];
@@ -52,11 +58,16 @@ export class VitalClient {
 
     axiosApiInstance.interceptors.request.use(
       async (config) => {
-        const token = await this.clientCredentials.access_token();
+        const headers = config.headers;
+        if(this.config.api_key){
+          headers["x-vital-api-key"] = this.config.api_key;
+        } else {
+          const token = await this.clientCredentials.access_token();
+          headers["Authorization"] = `Bearer ${token}`;
+          headers["x-vital-client-id"] = this.config.client_id;
+        }
         config.headers = {
-          ...config.headers,
-          'x-vital-client-id': this.config.client_id,
-          Authorization: `Bearer ${token}`,
+          ...headers,
         };
         return config;
       },

package/lib/models.ts

@@ -1,6 +1,7 @@
 export interface ClientConfig {
-  client_id: string;
-  client_secret: string;
+  client_id?: string;
+  client_secret?: string;
+  api_key?: string;
   environment: 'prod' | 'production' | 'sandbox' | 'development';
   region?: 'us' | 'eu';
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryvital/vital-node",
-  "version": "1.3.3",
+  "version": "1.3.6",
   "description": "Node client for Vital",
   "author": "maitham",
   "keywords": [
@@ -56,4 +56,4 @@
     "ts-node": "^10.2.0",
     "typescript": "^4.3.5"
   }
-}
+}