@metriport/api-sdk 6.0.1-alpha.1

package/dist/medical/models/patient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patient.d.ts","sourceRoot":"","sources":["../../../src/medical/models/patient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAqB,CAAC;AACtD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA8C,CAAC;AAC/E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAExB,CAAC;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5B,CAAC"}

package/dist/medical/models/patient.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patientListSchema = exports.patientSchema = exports.patientUpdateSchema = exports.patientCreateSchema = void 0;
+const zod_1 = require("zod");
+const base_update_1 = require("./common/base-update");
+const demographics_1 = require("./demographics");
+exports.patientCreateSchema = demographics_1.demographicsSchema;
+exports.patientUpdateSchema = exports.patientCreateSchema.merge(base_update_1.baseUpdateSchema);
+exports.patientSchema = exports.patientUpdateSchema.extend({
+    facilityIds: zod_1.z.array(zod_1.z.string()),
+});
+exports.patientListSchema = zod_1.z.object({
+    patients: zod_1.z.array(exports.patientSchema),
+});
+//# sourceMappingURL=patient.js.map

package/dist/medical/models/patient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patient.js","sourceRoot":"","sources":["../../../src/medical/models/patient.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,sDAAwD;AACxD,iDAAoD;AAEvC,QAAA,mBAAmB,GAAG,iCAAkB,CAAC;AAGzC,QAAA,mBAAmB,GAAG,2BAAmB,CAAC,KAAK,CAAC,8BAAgB,CAAC,CAAC;AAGlE,QAAA,aAAa,GAAG,2BAAmB,CAAC,MAAM,CAAC;IACtD,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;CACjC,CAAC,CAAC;AAGU,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,qBAAa,CAAC;CACjC,CAAC,CAAC"}

package/dist/shared.d.ts

@@ -0,0 +1,14 @@
+import { z, ZodString } from "zod";
+export declare const BASE_ADDRESS = "https://api.metriport.com";
+export declare const BASE_ADDRESS_SANDBOX = "https://api.sandbox.metriport.com";
+export declare const API_KEY_HEADER = "x-api-key";
+export declare const DEFAULT_AXIOS_TIMEOUT_MILLIS = 20000;
+export declare const emptyStringToUndefined: (v: string | undefined | null) => string | undefined;
+export declare const optionalString: (zodSchema: ZodString) => z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodOptional<z.ZodString>]>, string | undefined, string | undefined>;
+export declare function stripNonNumericChars(str: string): string;
+export declare const ISO_DATE = "YYYY-MM-DD";
+export declare const defaultString: z.ZodString;
+export declare const defaultOptionalString: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodOptional<z.ZodString>]>, string | undefined, string | undefined>;
+export declare const defaultDateString: z.ZodEffects<z.ZodString, string, string>;
+export declare const defaultNameString: z.ZodString;
+//# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAEnC,eAAO,MAAM,YAAY,8BAA8B,CAAC;AACxD,eAAO,MAAM,oBAAoB,sCAAsC,CAAC;AACxE,eAAO,MAAM,cAAc,cAAc,CAAC;AAC1C,eAAO,MAAM,4BAA4B,QAAS,CAAC;AAEnD,eAAO,MAAM,sBAAsB,MAAO,MAAM,GAAG,SAAS,GAAG,IAAI,uBACxB,CAAC;AAE5C,eAAO,MAAM,cAAc,cAAe,SAAS,gHACoB,CAAC;AAExE,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,eAAO,MAAM,QAAQ,eAAe,CAAC;AACrC,eAAO,MAAM,aAAa,aAAoB,CAAC;AAC/C,eAAO,MAAM,qBAAqB,6GAAgC,CAAC;AACnE,eAAO,MAAM,iBAAiB,2CAE5B,CAAC;AACH,eAAO,MAAM,iBAAiB,aAAuB,CAAC"}

package/dist/shared.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultNameString = exports.defaultDateString = exports.defaultOptionalString = exports.defaultString = exports.ISO_DATE = exports.stripNonNumericChars = exports.optionalString = exports.emptyStringToUndefined = exports.DEFAULT_AXIOS_TIMEOUT_MILLIS = exports.API_KEY_HEADER = exports.BASE_ADDRESS_SANDBOX = exports.BASE_ADDRESS = void 0;
+const dayjs_1 = __importDefault(require("dayjs"));
+const zod_1 = require("zod");
+exports.BASE_ADDRESS = "https://api.metriport.com";
+exports.BASE_ADDRESS_SANDBOX = "https://api.sandbox.metriport.com";
+exports.API_KEY_HEADER = "x-api-key";
+exports.DEFAULT_AXIOS_TIMEOUT_MILLIS = 20000;
+const emptyStringToUndefined = (v) => v == null || v.length < 1 ? undefined : v;
+exports.emptyStringToUndefined = emptyStringToUndefined;
+const optionalString = (zodSchema) => zodSchema.or(zod_1.z.string().optional()).transform(exports.emptyStringToUndefined);
+exports.optionalString = optionalString;
+function stripNonNumericChars(str) {
+    return str.trim().replace(/\D/g, "");
+}
+exports.stripNonNumericChars = stripNonNumericChars;
+exports.ISO_DATE = "YYYY-MM-DD";
+exports.defaultString = zod_1.z.string().trim();
+exports.defaultOptionalString = (0, exports.optionalString)(exports.defaultString);
+exports.defaultDateString = exports.defaultString.refine(v => (0, dayjs_1.default)(v, exports.ISO_DATE, true).isValid(), {
+    message: `Date must be a valid ISO 8601 date formatted ${exports.ISO_DATE}. Example: 2023-05-03`,
+});
+exports.defaultNameString = exports.defaultString.min(1);
+//# sourceMappingURL=shared.js.map

package/dist/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,6BAAmC;AAEtB,QAAA,YAAY,GAAG,2BAA2B,CAAC;AAC3C,QAAA,oBAAoB,GAAG,mCAAmC,CAAC;AAC3D,QAAA,cAAc,GAAG,WAAW,CAAC;AAC7B,QAAA,4BAA4B,GAAG,KAAM,CAAC;AAE5C,MAAM,sBAAsB,GAAG,CAAC,CAA4B,EAAE,EAAE,CACrE,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAD/B,QAAA,sBAAsB,0BACS;AAErC,MAAM,cAAc,GAAG,CAAC,SAAoB,EAAE,EAAE,CACrD,SAAS,CAAC,EAAE,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,8BAAsB,CAAC,CAAC;AAD3D,QAAA,cAAc,kBAC6C;AAExE,SAAgB,oBAAoB,CAAC,GAAW;IAC9C,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AACvC,CAAC;AAFD,oDAEC;AAEY,QAAA,QAAQ,GAAG,YAAY,CAAC;AACxB,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;AAClC,QAAA,qBAAqB,GAAG,IAAA,sBAAc,EAAC,qBAAa,CAAC,CAAC;AACtD,QAAA,iBAAiB,GAAG,qBAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,CAAC,EAAE,gBAAQ,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;IAC7F,OAAO,EAAE,gDAAgD,gBAAQ,uBAAuB;CACzF,CAAC,CAAC;AACU,QAAA,iBAAiB,GAAG,qBAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@metriport/api-sdk",
+  "version": "6.0.1-alpha.1",
+  "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/",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./devices/*": "./dist/devices/*.js",
+    "./medical/*": "./dist/medical/*.js"
+  },
+  "typesVersions": {
+    "*": {
+      "/": [
+        "dist/index.d.ts"
+      ],
+      "devices/*": [
+        "dist/devices/*"
+      ],
+      "medical/*": [
+        "dist/medical/*"
+      ]
+    }
+  },
+  "scripts": {
+    "clean": "rimraf dist && rimraf node_modules",
+    "tsc": "tsc",
+    "build": "tsc -p .",
+    "build:cloud": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "lint": "npx eslint . --ext .ts",
+    "lint-fix": "npm run lint --fix",
+    "prettier-fix": "npx prettier '**/*.ts' --write",
+    "test": "echo \"No test specified yet\""
+  },
+  "repository": {
+    "url": "https://github.com/metriport/metriport.git",
+    "type": "git",
+    "directory": "packages/api-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/metriport/metriport/issues"
+  },
+  "dependencies": {
+    "@metriport/commonwell-sdk": "^4.4.1-alpha.1",
+    "axios": "^1.3.4",
+    "dayjs": "^1.11.7",
+    "zod": "^3.20.2"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "prettier": "^2.8.3",
+    "ts-essentials": "^9.3.1",
+    "typescript": "^4.9.5"
+  },
+  "gitHead": "c77eacae50fdd3fcf56adb64af186ba914b0ff48"
+}

package/src/devices/client/metriport.ts

@@ -0,0 +1,261 @@
+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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,22 @@
+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

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

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

@@ -0,0 +1,10 @@
+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

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

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

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

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

@@ -0,0 +1,15 @@
+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;
+  };
+}