@nativesquare/soma 0.8.0 → 0.9.1

package/dist/garmin/client.d.ts

@@ -1,246 +0,0 @@
-import type { GarminActivity, GarminActivityDetail, GarminDailyExtended, GarminSleepExtended, GarminBodyComposition, GarminMenstrualCycle, GarminUserMetrics, GarminStressDetail, GarminSkinTemperature, GarminRespiration, GarminPulseOx, GarminMoveIQEvent, GarminHRVSummary, GarminHealthSnapshot, GarminEpoch, GarminBloodPressure, GarminSolar, GarminWorkout, GarminWorkoutSchedule } from "./types.js";
-export interface GarminClientOptions {
-    /** The user's OAuth 2.0 access token. */
-    accessToken: string;
-    /**
-     * Base URL of the Garmin Health API.
-     * @default "https://apis.garmin.com"
-     */
-    baseUrl?: string;
-}
-/**
- * A client for the Garmin Health API.
- *
- * Wellness API endpoints use openapi-fetch for type safety. Training API
- * endpoints use manual fetch since they are not part of the Wellness API spec.
- *
- * All requests are authenticated with a Bearer token. Time-range parameters
- * use Unix epoch seconds for `uploadStartTimeInSeconds` and
- * `uploadEndTimeInSeconds`.
- *
- * @example
- * ```ts
- * const client = new GarminClient({
- *   accessToken: "user_access_token",
- * });
- *
- * const dailies = await client.getDailies({
- *   uploadStartTimeInSeconds: startEpoch,
- *   uploadEndTimeInSeconds: endEpoch,
- * });
- * ```
- */
-export declare class GarminClient {
-    private readonly accessToken;
-    private readonly baseUrl;
-    private readonly wellness;
-    constructor(opts: GarminClientOptions);
-    /**
-     * Resolve the Garmin user ID for the authenticated user.
-     *
-     * Garmin API: `GET /wellness-api/rest/user/id`
-     */
-    getUserId(): Promise<string | null>;
-    /**
-     * Check which permissions the user has granted.
-     *
-     * Garmin API: `GET /wellness-api/rest/user/permissions`
-     */
-    getUserPermissions(): Promise<string[]>;
-    /**
-     * Get daily wellness summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/dailies`
-     */
-    getDailies(params: TimeRangeParams): Promise<GarminDailyExtended[]>;
-    /**
-     * Get activity summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/activities`
-     */
-    getActivities(params: TimeRangeParams): Promise<GarminActivity[]>;
-    /**
-     * Get detailed activity summaries including GPS, heart rate, and sensor data.
-     *
-     * Garmin API: `GET /wellness-api/rest/activityDetails`
-     */
-    getActivityDetails(params: TimeRangeParams): Promise<GarminActivityDetail[]>;
-    /**
-     * Download a raw activity file (FIT, TCX, or GPX).
-     *
-     * Garmin API: `GET /wellness-api/rest/activityFile`
-     *
-     * @returns The raw file as an ArrayBuffer.
-     */
-    getActivityFile(id: string): Promise<ArrayBuffer>;
-    /**
-     * Get sleep summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/sleeps`
-     */
-    getSleeps(params: TimeRangeParams): Promise<GarminSleepExtended[]>;
-    /**
-     * Get body composition summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/bodyComps`
-     */
-    getBodyCompositions(params: TimeRangeParams): Promise<GarminBodyComposition[]>;
-    /**
-     * Get menstrual cycle tracking data.
-     *
-     * Garmin API: `GET /wellness-api/rest/mct`
-     */
-    getMenstrualCycleData(params: TimeRangeParams): Promise<GarminMenstrualCycle[]>;
-    /**
-     * Get user metrics (VO2 max, fitness age, etc.).
-     *
-     * Garmin API: `GET /wellness-api/rest/userMetrics`
-     */
-    getUserMetrics(params: TimeRangeParams): Promise<GarminUserMetrics[]>;
-    /**
-     * Get stress detail summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/stressDetails`
-     */
-    getStressDetails(params: TimeRangeParams): Promise<GarminStressDetail[]>;
-    /**
-     * Get skin temperature summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/skinTemp`
-     */
-    getSkinTemperature(params: TimeRangeParams): Promise<GarminSkinTemperature[]>;
-    /**
-     * Get respiration summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/respiration`
-     */
-    getRespiration(params: TimeRangeParams): Promise<GarminRespiration[]>;
-    /**
-     * Get pulse oximetry (SpO2) summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/pulseOx`
-     */
-    getPulseOx(params: TimeRangeParams): Promise<GarminPulseOx[]>;
-    /**
-     * Get Move IQ auto-detected activity events.
-     *
-     * Garmin API: `GET /wellness-api/rest/moveiq`
-     */
-    getMoveIQ(params: TimeRangeParams): Promise<GarminMoveIQEvent[]>;
-    /**
-     * Get heart rate variability (HRV) summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/hrv`
-     */
-    getHRV(params: TimeRangeParams): Promise<GarminHRVSummary[]>;
-    /**
-     * Get health snapshot summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/healthSnapshot`
-     */
-    getHealthSnapshot(params: TimeRangeParams): Promise<GarminHealthSnapshot[]>;
-    /**
-     * Get epoch (15-minute interval) summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/epochs`
-     */
-    getEpochs(params: TimeRangeParams): Promise<GarminEpoch[]>;
-    /**
-     * Get blood pressure summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/bloodPressures`
-     */
-    getBloodPressures(params: TimeRangeParams): Promise<GarminBloodPressure[]>;
-    /**
-     * Get manually created or edited activities.
-     *
-     * Garmin API: `GET /wellness-api/rest/manuallyUpdatedActivities`
-     */
-    getManuallyUpdatedActivities(params: TimeRangeParams): Promise<GarminActivity[]>;
-    /**
-     * Get solar intensity summaries.
-     *
-     * Garmin API: `GET /wellness-api/rest/solarIntensity`
-     */
-    getSolarIntensity(params: TimeRangeParams): Promise<GarminSolar[]>;
-    /**
-     * Request historical data backfill from Garmin.
-     *
-     * Garmin processes backfill requests asynchronously and delivers data
-     * via the configured webhook endpoint. Maximum range: 90 days per request.
-     *
-     * Uses manual fetch because the spec defines individual backfill paths
-     * (e.g. `/rest/backfill/dailies`) but this method accepts a dynamic
-     * summaryType string.
-     *
-     * @param summaryType - The data type to backfill (e.g., "dailies", "activities", "sleeps", "bodyComps")
-     * @param params - Time range for the backfill
-     */
-    requestBackfill(summaryType: string, params: TimeRangeParams): Promise<void>;
-    /**
-     * Delete the user's registration with Garmin.
-     *
-     * Must be called when the user disconnects or deletes their account
-     * to comply with Garmin's API requirements.
-     */
-    deleteUserRegistration(): Promise<void>;
-    /**
-     * Create a workout in Garmin Connect.
-     *
-     * Garmin API: `POST /workoutportal/workout/v2`
-     * Note: uses a different base path than other Training API endpoints.
-     */
-    createWorkout(workout: GarminWorkout): Promise<GarminWorkout>;
-    /**
-     * Retrieve a workout by ID.
-     *
-     * Garmin API: `GET /training-api/workout/v2/{workoutId}`
-     */
-    getWorkout(workoutId: number): Promise<GarminWorkout>;
-    /**
-     * Update a workout by ID.
-     *
-     * Garmin API: `PUT /training-api/workout/v2/{workoutId}`
-     */
-    updateWorkout(workoutId: number, workout: GarminWorkout): Promise<GarminWorkout>;
-    /**
-     * Delete a workout by ID.
-     *
-     * Garmin API: `DELETE /training-api/workout/v2/{workoutId}`
-     */
-    deleteWorkout(workoutId: number): Promise<void>;
-    /**
-     * Schedule a workout to a specific date on the user's calendar.
-     *
-     * Garmin API: `POST /training-api/schedule/`
-     */
-    createSchedule(workoutId: number, date: string): Promise<GarminWorkoutSchedule>;
-    /**
-     * Retrieve workout schedules for a date range.
-     *
-     * Garmin API: `GET /training-api/schedule?startDate=...&endDate=...`
-     */
-    getSchedulesByDate(startDate: string, endDate: string): Promise<GarminWorkoutSchedule[]>;
-    /**
-     * Delete a workout schedule by ID.
-     *
-     * Garmin API: `DELETE /training-api/schedule/{scheduleId}`
-     */
-    deleteSchedule(scheduleId: number): Promise<void>;
-    private get;
-    private post;
-    private put;
-    private del;
-}
-export interface TimeRangeParams {
-    /** Start of the time range as Unix epoch seconds. */
-    uploadStartTimeInSeconds: number;
-    /** End of the time range as Unix epoch seconds. */
-    uploadEndTimeInSeconds: number;
-}
-export declare class GarminApiError extends Error {
-    readonly status: number;
-    readonly body: string;
-    constructor(message: string, status: number, body: string);
-}
-//# sourceMappingURL=client.d.ts.map

package/dist/garmin/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/garmin/client.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,aAAa,EACb,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAIpB,MAAM,WAAW,mBAAmB;IAClC,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAEd,IAAI,EAAE,mBAAmB;IAoBrC;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAczC;;;;OAIG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAgB7C;;;;OAIG;IACG,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAiBzE;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAmBvE;;;;OAIG;IACG,kBAAkB,CACtB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAmBlC;;;;;;OAMG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAuBvD;;;;OAIG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAgBxE;;;;OAIG;IACG,mBAAmB,CACvB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAmBnC;;;;OAIG;IACG,qBAAqB,CACzB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAgBlC;;;;OAIG;IACG,cAAc,CAClB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAmB/B;;;;OAIG;IACG,gBAAgB,CACpB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAmBhC;;;;OAIG;IACG,kBAAkB,CACtB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAmBnC;;;;OAIG;IACG,cAAc,CAClB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAmB/B;;;;OAIG;IACG,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAmBnE;;;;OAIG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAmBtE;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAgBlE;;;;OAIG;IACG,iBAAiB,CACrB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAmBlC;;;;OAIG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAgBhE;;;;OAIG;IACG,iBAAiB,CACrB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAmBjC;;;;OAIG;IACG,4BAA4B,CAChC,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,cAAc,EAAE,CAAC;IAmB5B;;;;OAIG;IACG,iBAAiB,CACrB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC;IAmBzB;;;;;;;;;;;;OAYG;IACG,eAAe,CACnB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC;IAyBhB;;;;;OAKG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB7C;;;;;OAKG;IACG,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAInE;;;;OAIG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAM3D;;;;OAIG;IACG,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,aAAa,CAAC;IAOzB;;;;OAIG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;;;OAIG;IACG,cAAc,CAClB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,qBAAqB,CAAC;IAOjC;;;;OAIG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAOnC;;;;OAIG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAMzC,GAAG;YA8BH,IAAI;YA+BJ,GAAG;YAwBH,GAAG;CAkBlB;AAID,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,wBAAwB,EAAE,MAAM,CAAC;IACjC,mDAAmD;IACnD,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAeD,qBAAa,cAAe,SAAQ,KAAK;aAGrB,MAAM,EAAE,MAAM;aACd,IAAI,EAAE,MAAM;gBAF5B,OAAO,EAAE,MAAM,EACC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM;CAK/B"}