@metriport/api-sdk 6.0.1-alpha.1 → 6.0.1-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metriport/api-sdk",
-  "version": "6.0.1-alpha.1",
+  "version": "6.0.1-alpha.2",
   "description": "Metriport helps you access and manage health and medical data, through a single open source API.",
   "author": "Metriport Inc. <contact@metriport.com>",
   "homepage": "https://metriport.com/",
@@ -10,6 +10,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "package.json"
+  ],
   "exports": {
     ".": "./dist/index.js",
     "./devices/*": "./dist/devices/*.js",
@@ -48,7 +54,7 @@
     "url": "https://github.com/metriport/metriport/issues"
   },
   "dependencies": {
-    "@metriport/commonwell-sdk": "^4.4.1-alpha.1",
+    "@metriport/commonwell-sdk": "*",
     "axios": "^1.3.4",
     "dayjs": "^1.11.7",
     "zod": "^3.20.2"
@@ -63,5 +69,5 @@
     "ts-essentials": "^9.3.1",
     "typescript": "^4.9.5"
   },
-  "gitHead": "c77eacae50fdd3fcf56adb64af186ba914b0ff48"
+  "gitHead": "633052184c5afb4d76fdad7d7b91c8e9d9b57557"
 }

package/.eslintignore

@@ -1,4 +0,0 @@
-node_modules
-build
-dist
-lib

package/.eslintrc.js

@@ -1,7 +0,0 @@
-/*global module*/
-module.exports = {
-  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  root: true,
-};

package/src/devices/client/metriport.ts

@@ -1,261 +0,0 @@
-import axios, { AxiosInstance } from "axios";
-import {
-  API_KEY_HEADER,
-  BASE_ADDRESS,
-  BASE_ADDRESS_SANDBOX,
-  DEFAULT_AXIOS_TIMEOUT_MILLIS,
-} from "../../shared";
-import { Activity } from "../models/activity";
-import { Biometrics } from "../models/biometrics";
-import { Body } from "../models/body";
-import { ProviderSource } from "../models/common/provider-source";
-import { Nutrition } from "../models/nutrition";
-import { Sleep } from "../models/sleep";
-import { User } from "../models/user";
-import { GetConnectTokenResponse } from "./models/get-connect-token-response";
-import { GetMetriportUserIDResponse } from "./models/get-metriport-user-id-response";
-import { SettingsResponse } from "./models/settings-response";
-import { WebhookStatusResponse } from "./models/webhook-status-response";
-import { GetConnectedUsersResponse } from "./models/get-connected-users-response";
-import { ConnectedUserInfo } from "../models/common/connected-user-info";
-import { dateIsValid } from "./util/date-util";
-
-export type Options = {
-  sandbox?: boolean;
-  timeout?: number;
-};
-
-export class MetriportDevicesApi {
-  private api: AxiosInstance;
-
-  /**
-   * Creates a new instance of the Metriport Devices API client.
-   *
-   * @param apiKey - Your Metriport API key.
-   * @param options - Optional parameters
-   * @param options.sandbox - Indicates whether to connect to the sandbox, default false.
-   * @param options.timeout - Connection timeout in milliseconds, default 20 seconds.
-   */
-  constructor(apiKey: string, options: Options = {}) {
-    const { sandbox, timeout } = options;
-    const baseURL = sandbox ? BASE_ADDRESS_SANDBOX : BASE_ADDRESS;
-    this.api = axios.create({
-      timeout: timeout ?? DEFAULT_AXIOS_TIMEOUT_MILLIS,
-      baseURL,
-      headers: { [API_KEY_HEADER]: apiKey },
-    });
-  }
-
-  /**
-   * For your given user ID, returns the Metriport user ID used for identifying
-   * the user and making subsequent calls for the user's data.
-   *
-   * @param {string} appUserId - The unique ID for the user in your app.
-   * @returns The userId of the user.
-   */
-  async getMetriportUserId(appUserId: string): Promise<string> {
-    const resp = await this.api.post<GetMetriportUserIDResponse>("/user", null, {
-      params: { appUserId: appUserId },
-    });
-    return resp.data.userId;
-  }
-
-  /**
-   * For your given user ID, returns the user's connected providers
-   *
-   * @param {string} userId - The unique ID for the user in your app.
-   * @returns Object containing array of connected providers.
-   */
-  async getConnectedProviders(userId: string): Promise<{ connectedProviders: string[] }> {
-    const resp = await this.api.get<{ connectedProviders: string[] }>(
-      `/user/${userId}/connected-providers`
-    );
-
-    return resp.data;
-  }
-
-  /**
-   * Returns all your users and their connected providers.
-   *
-   * @returns List of connected users, containing their ids and providers.
-   */
-  async getConnectedUsers(): Promise<{ connectedUsers: ConnectedUserInfo[] }> {
-    const resp = await this.api.get<GetConnectedUsersResponse>("/user");
-    return resp.data;
-  }
-
-  /**
-   * For the given user ID, get a token to be used for a Metriport Connect session.
-   *
-   * @param {string} userId - The user ID of the user that will be using the Connect widget.
-   * @returns The Metriport Connect session token.
-   */
-  async getConnectToken(userId: string): Promise<string> {
-    const resp = await this.api.get<GetConnectTokenResponse>("/user/connect/token", {
-      params: { userId: userId },
-    });
-    return resp.data.token;
-  }
-
-  /**
-   * For the given user ID, revokes the user's access to the specified provider.
-   *
-   * @param {string}          userId    - The user ID of the user for which to revoke access.
-   * @param {ProviderSource}  provider  - The data provider to revoke access to.
-   * @returns void.
-   */
-  async revokeUserAccessToProvider(userId: string, provider: ProviderSource): Promise<void> {
-    await this.api.delete(`/user/${userId}/revoke`, {
-      params: { provider: provider.toString() },
-    });
-  }
-
-  /**
-   * For the given user ID, revokes access tokens for all providers and deletes the user.
-   *
-   * @param {string} userId    - The user ID of the user to be deleted.
-   * @returns void.
-   */
-  async deleteUser(userId: string): Promise<void> {
-    await this.api.delete(`/user/${userId}`);
-  }
-
-  /**
-   * Gets the activity info for the specified user ID and date.
-   *
-   * @param {string} userId - The userId of the user you want to get data for.
-   * @param {string} date - The date you want to get the data for (YYYY-MM-DD).
-   * @returns An array of activity data from each connected provider.
-   */
-  async getActivityData(userId: string, date: string): Promise<Activity[]> {
-    const resp = await this.api.get<Activity[]>("/activity", {
-      params: this.validateAndBuildParams(userId, date),
-    });
-    return resp.data;
-  }
-
-  /**
-   * Gets the body data for the specified user ID and date.
-   *
-   * @param {string} userId - The userId of the user you want to get data for.
-   * @param {string} date - The date you want to get the data for (YYYY-MM-DD).
-   * @returns An array of body data from each connected provider.
-   */
-  async getBodyData(userId: string, date: string): Promise<Body[]> {
-    const resp = await this.api.get<Body[]>("/body", {
-      params: this.validateAndBuildParams(userId, date),
-    });
-    return resp.data;
-  }
-
-  /**
-   * Gets the biometrics data for the specified user ID and date.
-   *
-   * @param {string} userId - The userId of the user you want to get data for.
-   * @param {string} date - The date you want to get the data for (YYYY-MM-DD).
-   * @returns An array of biometrics data from each connected provider.
-   */
-  async getBiometricsData(userId: string, date: string): Promise<Biometrics[]> {
-    const resp = await this.api.get<Biometrics[]>("/biometrics", {
-      params: this.validateAndBuildParams(userId, date),
-    });
-    return resp.data;
-  }
-
-  /**
-   * Gets the nutrition data for the specified user ID and date.
-   *
-   * @param {string} userId - The userId of the user you want to get data for.
-   * @param {string} date - The date you want to get the data for (YYYY-MM-DD).
-   * @returns An array of nutrition data from each connected provider.
-   */
-  async getNutritionData(userId: string, date: string): Promise<Nutrition[]> {
-    const resp = await this.api.get<Nutrition[]>("/nutrition", {
-      params: this.validateAndBuildParams(userId, date),
-    });
-    return resp.data;
-  }
-
-  /**
-   * Gets the sleep data for the specified user ID and date.
-   *
-   * @param {string} userId - The userId of the user you want to get data for.
-   * @param {string} date - The date you want to get the data for (YYYY-MM-DD).
-   * @returns An array of sleep data from each connected provider.
-   */
-  async getSleepData(userId: string, date: string): Promise<Sleep[]> {
-    const resp = await this.api.get<Sleep[]>("/sleep", {
-      params: this.validateAndBuildParams(userId, date),
-    });
-    return resp.data;
-  }
-
-  /**
-   * Gets the user info for the specified user ID and date.
-   *
-   * @param {string} userId - The userId of the user you want to get data for.
-   * @param {string} date - The date you want to get the data for (YYYY-MM-DD).
-   * @returns An array of user data from each connected provider.
-   */
-  async getUserData(userId: string, date: string): Promise<User[]> {
-    const resp = await this.api.get<User[]>("/user", {
-      params: this.validateAndBuildParams(userId, date),
-    });
-    return resp.data;
-  }
-
-  /**
-   * If the userId is empty or the date is not in the correct format, throw an error. Otherwise, return
-   * an object with the userId and date.
-   *
-   * @param {string} userId - The userId of the user you want to get the data for.
-   * @param {string} date - The date to get the user's schedule for.
-   * @returns an object with the userId and date properties.
-   */
-  private validateAndBuildParams(userId: string, date: string) {
-    if (userId.trim().length < 1) throw Error(`userId must not be empty!`);
-    if (!dateIsValid(date)) throw Error(`date must be in format YYYY-MM-DD!`);
-    return { userId, date };
-  }
-
-  /**
-   * Gets the settings for your account.
-   *
-   * @returns Your account settings.
-   */
-  async getSettings(): Promise<SettingsResponse> {
-    const resp = await this.api.get<SettingsResponse>("/settings");
-    return resp.data;
-  }
-
-  /**
-   * Update the settings for your account.
-   *
-   * @returns Your updated account settings.
-   */
-  async updateSettings(webhookUrl: string): Promise<SettingsResponse> {
-    const resp = await this.api.post<SettingsResponse>("/settings", {
-      webhookUrl,
-    });
-    return resp.data;
-  }
-
-  /**
-   * Gets the status of communication with your app's webhook.
-   *
-   * @returns The status of communication with your app's webhook.
-   */
-  async getWebhookStatus(): Promise<WebhookStatusResponse> {
-    const resp = await this.api.get<WebhookStatusResponse>("/settings/webhook");
-    return resp.data;
-  }
-
-  /**
-   * Retries failed webhook requests.
-   *
-   * @returns void
-   */
-  async retryWebhookRequests(): Promise<void> {
-    await this.api.post("/settings/webhook/retry");
-  }
-}

package/src/devices/client/models/get-connect-token-response.ts

@@ -1,3 +0,0 @@
-export interface GetConnectTokenResponse {
-  token: string;
-}

package/src/devices/client/models/get-connected-users-response.ts

@@ -1,5 +0,0 @@
-import { ConnectedUserInfo } from "../../models/common/connected-user-info";
-
-export interface GetConnectedUsersResponse {
-  connectedUsers: ConnectedUserInfo[];
-}

package/src/devices/client/models/get-metriport-user-id-response.ts

@@ -1,3 +0,0 @@
-export interface GetMetriportUserIDResponse {
-  userId: string;
-}

package/src/devices/client/models/settings-response.ts

@@ -1,5 +0,0 @@
-export interface SettingsResponse {
-  id: string;
-  webhookUrl?: string | null;
-  webhookKey?: string | null;
-}

package/src/devices/client/models/webhook-status-response.ts

@@ -1,6 +0,0 @@
-export interface WebhookStatusResponse {
-  webhookEnabled: boolean;
-  webhookStatusDetail?: string;
-  webhookRequestsProcessing: number;
-  webhookRequestsFailed: number;
-}

package/src/devices/client/util/date-util.ts

@@ -1,17 +0,0 @@
-export function dateIsValid(dateStr: string): boolean {
-  const regex = /^\d{4}-\d{2}-\d{2}$/;
-
-  if (dateStr.match(regex) === null) {
-    return false;
-  }
-
-  const date = new Date(dateStr);
-
-  const timestamp = date.getTime();
-
-  if (typeof timestamp !== "number" || Number.isNaN(timestamp)) {
-    return false;
-  }
-
-  return date.toISOString().startsWith(dateStr);
-}

package/src/devices/models/activity.ts

@@ -1,22 +0,0 @@
-import { ActivityDurations } from "./common/activity-durations";
-import { ActivityLog } from "./common/activity-log";
-import { ActivityMovement } from "./common/activity-movement";
-import { EnergyExpenditure } from "./common/energy-expenditure";
-import { HeartRate } from "./common/heart-rate";
-import { HeartRateVariability } from "./common/heart-rate-variability";
-import { Respiration } from "./common/respiration";
-import { MetriportData } from "./metriport-data";
-
-export interface Activity extends MetriportData {
-  summary?: {
-    durations?: ActivityDurations;
-    energy_expenditure?: EnergyExpenditure;
-    movement?: ActivityMovement;
-    biometrics?: {
-      heart_rate?: HeartRate;
-      hrv?: HeartRateVariability;
-      respiration?: Respiration;
-    };
-  };
-  activity_logs?: ActivityLog[];
-}

package/src/devices/models/biometrics.ts

@@ -1,17 +0,0 @@
-import { BloodGlucose } from "./common/blood-glucose";
-import { BloodPressure } from "./common/blood-pressure";
-import { HeartRate } from "./common/heart-rate";
-import { HeartRateVariability } from "./common/heart-rate-variability";
-import { Respiration } from "./common/respiration";
-import { Temperature } from "./common/temperature";
-import { MetriportData } from "./metriport-data";
-
-export interface Biometrics extends MetriportData {
-  blood_glucose?: BloodGlucose;
-  blood_pressure?: BloodPressure;
-  heart_rate?: HeartRate;
-  hrv?: HeartRateVariability;
-  respiration?: Respiration;
-  temperature?: Temperature;
-  // todo: ecg?
-}

package/src/devices/models/body.ts

@@ -1,12 +0,0 @@
-import { MetriportData } from "./metriport-data";
-import { Sample } from "./common/sample";
-export interface Body extends MetriportData {
-  body_fat_pct?: number;
-  height_cm?: number;
-  weight_kg?: number;
-  bone_mass_kg?: number;
-  muscle_mass_kg?: number;
-  lean_mass_kg?: number;
-  max_possible_heart_rate_bpm?: number;
-  weight_samples_kg?: Sample[];
-}

package/src/devices/models/common/activity-durations.ts

@@ -1,20 +0,0 @@
-export interface ActivityDurations {
-  active_seconds?: number;
-  // also referred to as metabolic-equivalent minutes
-  intensity?: {
-    rest_seconds?: number;
-    very_low_seconds?: number;
-    low_seconds?: number;
-    med_seconds?: number;
-    high_seconds?: number;
-  };
-  // also referred to as stress
-  strain?: {
-    rest_seconds?: number;
-    very_low_seconds?: number;
-    low_seconds?: number;
-    med_seconds?: number;
-    high_seconds?: number;
-    very_high_seconds?: number;
-  };
-}

package/src/devices/models/common/activity-log.ts

@@ -1,33 +0,0 @@
-import { ActivityDurations } from "./activity-durations";
-import { ActivityMovement } from "./activity-movement";
-import { EnergyExpenditure } from "./energy-expenditure";
-import { HeartRate } from "./heart-rate";
-import { HeartRateVariability } from "./heart-rate-variability";
-import { LatLon } from "./lat-lon";
-import { Metadata } from "./metadata";
-import { Respiration } from "./respiration";
-
-export interface ActivityLog {
-  metadata: Metadata;
-  name?: string;
-  type?: string;
-  start_time?: string;
-  end_time?: string;
-  durations?: ActivityDurations;
-  energy_expenditure?: EnergyExpenditure;
-  movement?: ActivityMovement;
-  location?: {
-    start_lat_lon_deg?: LatLon;
-    end_lat_lon_deg?: LatLon;
-    polystring?: string;
-    city?: string;
-    country?: string;
-    region?: string; // can be state, province, etc.
-  };
-  biometrics?: {
-    heart_rate?: HeartRate;
-    hrv?: HeartRateVariability;
-    respiration?: Respiration;
-  };
-  // todo: laps + more time samples thoughout the models?
-}

package/src/devices/models/common/activity-movement.ts

@@ -1,15 +0,0 @@
-export interface ActivityMovement {
-  steps_count?: number;
-  floors_count?: number;
-  elevation?: {
-    gain_meters?: number;
-    min_meters?: number;
-    max_meters?: number;
-  };
-  speed?: {
-    max_km_h?: number;
-    avg_km_h?: number;
-  };
-  avg_cadence?: number;
-  distance_meters?: number;
-}

package/src/devices/models/common/aminos.ts

@@ -1,22 +0,0 @@
-export interface Aminos {
-  alanine_g?: number;
-  arginine_g?: number;
-  asparagine_g?: number;
-  aspartic_acid_g?: number;
-  cysteine_g?: number;
-  glutamine_g?: number;
-  glutamic_acid_g?: number;
-  glycine_g?: number;
-  histidine_g?: number;
-  isoleucine_g?: number;
-  leucine_g?: number;
-  lysine_g?: number;
-  methionine_g?: number;
-  phenylalanine_g?: number;
-  proline_g?: number;
-  serine_g?: number;
-  threonine_g?: number;
-  tryptophan_g?: number;
-  tyrosine_g?: number;
-  valine_g?: number;
-}

package/src/devices/models/common/blood-glucose.ts

@@ -1,6 +0,0 @@
-import { Sample } from "./sample";
-
-export interface BloodGlucose {
-  avg_mg_dL?: number;
-  samples_mg_dL: Sample[];
-}

package/src/devices/models/common/blood-pressure.ts

@@ -1,10 +0,0 @@
-import { Sample } from "./sample";
-
-export interface BloodPressure {
-  diastolic_mm_Hg?: {
-    samples?: Sample[];
-  };
-  systolic_mm_Hg?: {
-    samples?: Sample[];
-  };
-}

package/src/devices/models/common/connected-user-info.ts

@@ -1,5 +0,0 @@
-export type ConnectedUserInfo = {
-  metriportUserId: string;
-  appUserId: string;
-  connectedProviders?: string[];
-};

package/src/devices/models/common/energy-expenditure.ts

@@ -1,6 +0,0 @@
-export interface EnergyExpenditure {
-  active_kcal?: number;
-  basal_metabolic_rate_kcal?: number;
-  total_watts?: number;
-  avg_watts?: number;
-}

package/src/devices/models/common/food.ts

@@ -1,15 +0,0 @@
-import { Aminos } from "./aminos";
-import { Macros } from "./macros";
-import { Micros } from "./micros";
-
-export interface Food {
-  name?: string;
-  brand?: string;
-  amount?: number;
-  unit?: string;
-  nutrition_facts?: {
-    macros?: Macros;
-    micros?: Micros;
-    aminos?: Aminos;
-  };
-}

package/src/devices/models/common/heart-rate-variability.ts

@@ -1,12 +0,0 @@
-import { Sample } from "./sample";
-
-export interface HeartRateVariability {
-  rmssd?: {
-    avg_millis?: number;
-    samples_millis?: Sample[];
-  };
-  sdnn?: {
-    avg_millis?: number;
-    samples_millis?: Sample[];
-  };
-}

package/src/devices/models/common/heart-rate.ts

@@ -1,9 +0,0 @@
-import { Sample } from "./sample";
-
-export interface HeartRate {
-  min_bpm?: number;
-  max_bpm?: number;
-  avg_bpm?: number;
-  resting_bpm?: number;
-  samples_bpm?: Sample[];
-}

package/src/devices/models/common/lat-lon.ts

@@ -1,4 +0,0 @@
-export interface LatLon {
-  lat: number;
-  lon: number;
-}

package/src/devices/models/common/macros.ts

@@ -1,13 +0,0 @@
-export interface Macros {
-  alcohol_g?: number;
-  carbs_g?: number;
-  cholesterol_mg?: number;
-  energy_kcal?: number;
-  fat_g?: number;
-  fiber_g?: number;
-  protein_g?: number;
-  sodium_mg?: number;
-  sugar_g?: number;
-  trans_fat_g?: number;
-  water_ml?: number;
-}

package/src/devices/models/common/metadata.ts

@@ -1,10 +0,0 @@
-import { ProviderSource } from "./provider-source";
-import { SourceInfo } from "./source-info";
-
-export interface Metadata {
-  date: string;
-  hour?: string;
-  source: ProviderSource;
-  data_source?: SourceInfo;
-  error?: string;
-}

package/src/devices/models/common/micros.ts

@@ -1,27 +0,0 @@
-export interface Micros {
-  biotin_mg?: number;
-  caffeine_mg?: number;
-  calcium_mg?: number;
-  copper_mg?: number;
-  folate_mg?: number;
-  folic_acid_mg?: number;
-  iodine_mg?: number;
-  iron_mg?: number;
-  magnesium_mg?: number;
-  manganese_mg?: number;
-  phosphorus_mg?: number;
-  potassium_mg?: number;
-  selenium_mg?: number;
-  vitamin_A_mg?: number;
-  vitamin_B1_mg?: number;
-  vitamin_B2_mg?: number;
-  vitamin_B3_mg?: number;
-  vitamin_B5_mg?: number;
-  vitamin_B6_mg?: number;
-  vitamin_B12_mg?: number;
-  vitamin_C_mg?: number;
-  vitamin_D_mg?: number;
-  vitamin_E_mg?: number;
-  vitamin_K_mg?: number;
-  zinc_mg?: number;
-}

package/src/devices/models/common/provider-source.ts

@@ -1,11 +0,0 @@
-export enum ProviderSource {
-  apple = "apple",
-  cronometer = "cronometer",
-  dexcom = "dexcom",
-  fitbit = "fitbit",
-  garmin = "garmin",
-  google = "google",
-  oura = "oura",
-  whoop = "whoop",
-  withings = "withings",
-}

package/src/devices/models/common/respiration.ts

@@ -1,16 +0,0 @@
-import { Sample } from "./sample";
-
-export interface Respiration {
-  vo2_max?: number;
-  spo2?: {
-    // blood oxygen
-    min_pct?: number;
-    max_pct?: number;
-    avg_pct?: number;
-  };
-  avg_breaths_per_minute?: number;
-  /**
-   * Samples of respiration readings, breaths per minute over time.
-   */
-  samples_breaths_per_minute?: Sample[];
-}