@tryvital/vital-node 1.3.0 → 1.3.3

package/.github/workflows/deploy.yaml

@@ -1,57 +1,18 @@
-name: CI
+name: Publish Package to npmjs
 on:
-  push:
-    branches:
-      - "main"
+  release:
+    types: [published]
 jobs:
   build:
-    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        node: ['10.x', '12.x', '14.x']
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v2
-
-      - name: Use Node ${{ matrix.node }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node }}
-
-      - name: Install deps and build (with cache)
-        uses: bahmutov/npm-install@v1
-
-      - name: Lint
-        run: yarn lint
-        
-      - name: Build
-        run: yarn build
-  publish:
-    needs: build
-    name: Build, lint, and test on Node 10
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repo
-        uses: actions/checkout@v2
-      - name: Use Node 10
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
         with:
-          node-version: 10
-      - name: Install deps and build (with cache)
-        uses: bahmutov/npm-install@v1
-      - name: Build
-        run: yarn build
-      - name:  'Automated Version Bump'
-        uses:  'phips28/gh-action-bump-version@master'
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          target-branch: 'main'
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
-          access: public
-        
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

package/__tests__/sleep.test.ts

@@ -14,4 +14,18 @@ describe('Sleep', () => {
         )
         expect(data.sleep.length).toBeGreaterThan(0)
     });
+
+    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.getSleepWithStream(
+            userId,
+            new Date("2021-01-01"),
+            new Date("2022-01-02"),
+        )
+        expect(data.sleep.length).toBeGreaterThan(0)
+        expect(data.sleep[0].sleep_stream).toBeDefined()
+    });
 })

package/client/Activity.ts

@@ -13,7 +13,7 @@ export class ActivityApi {
   public async get(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientActivityResponse> {
     const resp = await this.client.get(
@@ -28,7 +28,7 @@ export class ActivityApi {
   public async get_raw(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientActivityRawResponse> {
     const resp = await this.client.get(

package/client/Body.ts

@@ -14,7 +14,7 @@ export class BodyApi {
   public async get(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientBodyResponse> {
     const resp = await this.client.get(
@@ -29,7 +29,7 @@ export class BodyApi {
   public async get_raw(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientBodyRawResponse> {
     const resp = await this.client.get(

package/client/Link.ts

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

package/client/Sleep.ts

@@ -16,11 +16,27 @@ export class SleepApi {
   public async get(
     userId: string,
     startDate: Date,
-    endDate: Date,
-    provider?: string
+    endDate?: Date,
+    provider?: string,
+    with_stream: boolean = false
   ): Promise<ClientSleepResponse> {
     const resp = await this.client.get(
       this.baseURL.concat(`/summary/sleep/${userId}`),
+      {
+        params: { start_date: startDate, end_date: endDate, provider, with_stream },
+      }
+    );
+    return resp.data;
+  }
+
+  public async getSleepWithStream(
+    userId: string,
+    startDate: Date,
+    endDate?: Date,
+    provider?: string
+  ): Promise<ClientSleepResponse> {
+    const resp = await this.client.get(
+      this.baseURL.concat(`/summary/sleep/${userId}/stream`),
       {
         params: { start_date: startDate, end_date: endDate, provider },
       }
@@ -38,7 +54,7 @@ export class SleepApi {
   public async get_raw(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientSleepRawResponse> {
     const resp = await this.client.get(

package/client/Vitals.ts

@@ -13,7 +13,7 @@ export class VitalsApi {
     user_key: string,
     resource: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     const resp = await this.client.get(
@@ -29,7 +29,7 @@ export class VitalsApi {
     type: 'ldl' | 'total' | 'triglycerides' | 'hdl',
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
@@ -44,7 +44,7 @@ export class VitalsApi {
   public async glucose(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(
@@ -59,7 +59,7 @@ export class VitalsApi {
   public async ige(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(userId, 'ige', startDate, endDate, provider);
@@ -68,7 +68,7 @@ export class VitalsApi {
   public async igg(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(userId, 'igg', startDate, endDate, provider);
@@ -77,7 +77,7 @@ export class VitalsApi {
   public async heartrate(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<TimeseriesPoint[]> {
     return this.timeseriesData(

package/client/Workouts.ts

@@ -16,7 +16,7 @@ export class WorkoutsApi {
   public async get(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientWorkoutResponse> {
     const resp = await this.client.get(
@@ -40,7 +40,7 @@ export class WorkoutsApi {
   public async get_raw(
     userId: string,
     startDate: Date,
-    endDate: Date,
+    endDate?: Date,
     provider?: string
   ): Promise<ClientWorkoutsRawResponse> {
     const resp = await this.client.get(

package/client/models/sleep_models.ts

@@ -127,6 +127,13 @@ export interface ClientFacingSleep {
    * @memberof ClientFacingSleep
    */
   user_id: string;
+  /**
+   * UTC time when the sleep period started
+   * @type {ClientSleepStreamResponse}
+   * @memberof ClientFacingSleep
+   * 
+   */
+  sleep_stream: ClientSleepStreamResponse[];
 }
 
 export interface ClientSleepResponse {

package/dist/client/Activity.d.ts

@@ -5,6 +5,6 @@ export declare class ActivityApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    get(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientActivityResponse>;
-    get_raw(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientActivityRawResponse>;
+    get(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientActivityResponse>;
+    get_raw(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientActivityRawResponse>;
 }

package/dist/client/Body.d.ts

@@ -5,6 +5,6 @@ export declare class BodyApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    get(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientBodyResponse>;
-    get_raw(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientBodyRawResponse>;
+    get(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientBodyResponse>;
+    get_raw(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientBodyRawResponse>;
 }

package/dist/client/Link.d.ts

@@ -5,7 +5,7 @@ export declare class LinkApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    create(userId: string, provider?: string): Promise<LinkTokenExchangeResponse>;
+    create(userId: string, provider?: string, redirect_url?: string): Promise<LinkTokenExchangeResponse>;
     connectProvider(linkToken: string, provider: PasswordProviders, username: string, password: string): Promise<ProviderLinkResponse>;
     connectEmailProvider(linkToken: string, provider: EmailProviders, email: string): Promise<ProviderLinkResponse>;
     getOAuthLink(linkToken: string, provider: OAuthProviders): Promise<SourceWithLinkInfo>;

package/dist/client/Link.js

@@ -42,8 +42,9 @@ var LinkApi = /** @class */ (function () {
         this.baseURL = baseURL;
         this.client = axios;
     }
-    LinkApi.prototype.create = function (userId, provider) {
+    LinkApi.prototype.create = function (userId, provider, redirect_url) {
         if (provider === void 0) { provider = null; }
+        if (redirect_url === void 0) { redirect_url = null; }
         return __awaiter(this, void 0, void 0, function () {
             var resp;
             return __generator(this, function (_a) {
@@ -51,6 +52,7 @@ var LinkApi = /** @class */ (function () {
                     case 0: return [4 /*yield*/, this.client.post(this.baseURL.concat('/link/token/'), {
                             user_key: userId,
                             provider: provider,
+                            redirect_url: redirect_url,
                         })];
                     case 1:
                         resp = _a.sent();

package/dist/client/Sleep.d.ts

@@ -5,7 +5,8 @@ export declare class SleepApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    get(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientSleepResponse>;
+    get(userId: string, startDate: Date, endDate?: Date, provider?: string, with_stream?: boolean): Promise<ClientSleepResponse>;
+    getSleepWithStream(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientSleepResponse>;
     getStream(sleepId: string): Promise<ClientSleepStreamResponse>;
-    get_raw(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientSleepRawResponse>;
+    get_raw(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientSleepRawResponse>;
 }

package/dist/client/Sleep.js

@@ -42,12 +42,28 @@ var SleepApi = /** @class */ (function () {
         this.baseURL = baseURL;
         this.client = axios;
     }
-    SleepApi.prototype.get = function (userId, startDate, endDate, provider) {
+    SleepApi.prototype.get = function (userId, startDate, endDate, provider, with_stream) {
+        if (with_stream === void 0) { with_stream = false; }
         return __awaiter(this, void 0, void 0, function () {
             var resp;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/sleep/" + userId), {
+                            params: { start_date: startDate, end_date: endDate, provider: provider, with_stream: with_stream },
+                        })];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                }
+            });
+        });
+    };
+    SleepApi.prototype.getSleepWithStream = function (userId, startDate, endDate, provider) {
+        return __awaiter(this, void 0, void 0, function () {
+            var resp;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.client.get(this.baseURL.concat("/summary/sleep/" + userId + "/stream"), {
                             params: { start_date: startDate, end_date: endDate, provider: provider },
                         })];
                     case 1:

package/dist/client/Vitals.d.ts

@@ -5,9 +5,9 @@ export declare class VitalsApi {
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
     private timeseriesData;
-    cholesterol(type: 'ldl' | 'total' | 'triglycerides' | 'hdl', userId: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
-    glucose(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
-    ige(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
-    igg(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
-    heartrate(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    cholesterol(type: 'ldl' | 'total' | 'triglycerides' | 'hdl', userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    glucose(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    ige(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    igg(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<TimeseriesPoint[]>;
+    heartrate(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<TimeseriesPoint[]>;
 }

package/dist/client/Workouts.d.ts

@@ -5,7 +5,7 @@ export declare class WorkoutsApi {
     baseURL: string;
     client: AxiosInstance;
     constructor(baseURL: string, axios: AxiosInstance);
-    get(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientWorkoutResponse>;
+    get(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientWorkoutResponse>;
     getStream(workoutId: string): Promise<ClientWorkoutStreamResponse>;
-    get_raw(userId: string, startDate: Date, endDate: Date, provider?: string): Promise<ClientWorkoutsRawResponse>;
+    get_raw(userId: string, startDate: Date, endDate?: Date, provider?: string): Promise<ClientWorkoutsRawResponse>;
 }

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

@@ -126,6 +126,13 @@ export interface ClientFacingSleep {
      * @memberof ClientFacingSleep
      */
     user_id: string;
+    /**
+     * UTC time when the sleep period started
+     * @type {ClientSleepStreamResponse}
+     * @memberof ClientFacingSleep
+     *
+     */
+    sleep_stream: ClientSleepStreamResponse[];
 }
 export interface ClientSleepResponse {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryvital/vital-node",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "description": "Node client for Vital",
   "author": "maitham",
   "keywords": [