@clipin/convex-wearables 0.0.1

package/dist/client/index.d.ts

@@ -0,0 +1,244 @@
+/**
+ * @clipin/convex-wearables
+ *
+ * Convex component for wearable device integrations.
+ * Provides health data sync from Garmin, Strava, Whoop, Polar, Suunto,
+ * Apple HealthKit, Samsung Health, and Google Health Connect.
+ */
+import type { GenericActionCtx, GenericDataModel, GenericMutationCtx, GenericQueryCtx, HttpRouter } from "convex/server";
+import type { AggregateStats, BackfillJob, Connection, DailySummary, DataPoint, EventCategory, EventsPage, GarminRoutesConfig, HealthEvent, ProviderCredentials, ProviderName, RegisterRoutesConfig, SdkPushDataPoint, SdkPushEvent, SdkPushPayload, SdkPushSummary, SdkRoutesConfig, SdkSyncPayload, SyncJob, SyncStatus, TimeSeriesPage, WearablesConfig } from "./types.js";
+export { oauthCallback, stravaWebhookEvent, stravaWebhookVerify, } from "../component/httpHandlers.js";
+export type { SeriesType, SleepEvent, SleepStage, WorkoutEvent } from "./types.js";
+export { SERIES_TYPES } from "./types.js";
+export type { AggregateStats, BackfillJob, Connection, DailySummary, DataPoint, EventCategory, EventsPage, GarminRoutesConfig, HealthEvent, ProviderCredentials, ProviderName, RegisterRoutesConfig, SdkPushDataPoint, SdkPushEvent, SdkPushPayload, SdkPushSummary, SdkRoutesConfig, SdkSyncPayload, SyncJob, SyncStatus, TimeSeriesPage, WearablesConfig, };
+export type WearablesComponent = Record<string, any>;
+type QueryRunner = Pick<GenericQueryCtx<GenericDataModel>, "runQuery"> | Pick<GenericActionCtx<GenericDataModel>, "runQuery">;
+type MutationRunner = Pick<GenericMutationCtx<GenericDataModel>, "runMutation"> | Pick<GenericActionCtx<GenericDataModel>, "runMutation">;
+type ActionRunner = Pick<GenericActionCtx<GenericDataModel>, "runAction">;
+/**
+ * Client for interacting with the @clipin/convex-wearables component.
+ *
+ * @example
+ * ```ts
+ * import { WearablesClient } from "@clipin/convex-wearables";
+ * import { components } from "./_generated/api";
+ *
+ * const wearables = new WearablesClient(components.wearables, {
+ *   providers: {
+ *     strava: { clientId: "...", clientSecret: "..." },
+ *     garmin: { clientId: "...", clientSecret: "..." },
+ *   },
+ * });
+ *
+ * // In a query:
+ * export const getWorkouts = query({
+ *   args: { userId: v.string() },
+ *   handler: async (ctx, args) => {
+ *     return await wearables.getEvents(ctx, {
+ *       userId: args.userId,
+ *       category: "workout",
+ *     });
+ *   },
+ * });
+ * ```
+ */
+export declare class WearablesClient {
+    component: WearablesComponent;
+    config: WearablesConfig;
+    constructor(component: WearablesComponent, config: WearablesConfig);
+    /**
+     * Get all connections for a user.
+     */
+    getConnections(ctx: QueryRunner, args: {
+        userId: string;
+    }): Promise<Connection[]>;
+    /**
+     * Get connection for a specific user + provider.
+     */
+    getConnection(ctx: QueryRunner, args: {
+        userId: string;
+        provider: ProviderName;
+    }): Promise<Connection | null>;
+    /**
+     * Get sync status for a user across all providers.
+     */
+    getSyncStatus(ctx: QueryRunner, args: {
+        userId: string;
+    }): Promise<SyncStatus[]>;
+    /**
+     * Disconnect a provider for a user.
+     */
+    disconnect(ctx: MutationRunner, args: {
+        userId: string;
+        provider: ProviderName;
+    }): Promise<any>;
+    /**
+     * Get events (workouts or sleep) for a user with pagination.
+     */
+    getEvents(ctx: QueryRunner, args: {
+        userId: string;
+        category: EventCategory;
+        startDate?: number;
+        endDate?: number;
+        limit?: number;
+        cursor?: string;
+    }): Promise<EventsPage>;
+    /**
+     * Get a single event by ID.
+     */
+    getEvent(ctx: QueryRunner, args: {
+        eventId: string;
+    }): Promise<HealthEvent | null>;
+    /**
+     * Get time-series data for a user.
+     */
+    getTimeSeries(ctx: QueryRunner, args: {
+        userId: string;
+        seriesType: string;
+        startDate: number;
+        endDate: number;
+        limit?: number;
+    }): Promise<DataPoint[]>;
+    /**
+     * Get the latest data point for a metric.
+     */
+    getLatestDataPoint(ctx: QueryRunner, args: {
+        userId: string;
+        seriesType: string;
+    }): Promise<{
+        timestamp: number;
+        value: number;
+        provider: string;
+    } | null>;
+    /**
+     * Get all available series types for a user.
+     */
+    getAvailableSeriesTypes(ctx: QueryRunner, args: {
+        userId: string;
+    }): Promise<string[]>;
+    /**
+     * Get daily summaries for a user.
+     */
+    getDailySummaries(ctx: QueryRunner, args: {
+        userId: string;
+        category: string;
+        startDate: string;
+        endDate: string;
+    }): Promise<DailySummary[]>;
+    /**
+     * Get or create a data source for a user/provider/device.
+     */
+    getOrCreateDataSource(ctx: MutationRunner, args: {
+        userId: string;
+        provider: ProviderName;
+        connectionId?: string;
+        deviceModel?: string;
+        source?: string;
+        deviceType?: string;
+    }): Promise<string>;
+    /**
+     * Get sync jobs for a user.
+     */
+    getSyncJobs(ctx: QueryRunner, args: {
+        userId: string;
+        limit?: number;
+    }): Promise<SyncJob[]>;
+    /**
+     * Generate an OAuth authorization URL for a provider using configured credentials.
+     */
+    generateAuthUrl(ctx: ActionRunner, args: {
+        userId: string;
+        provider: ProviderName;
+        redirectUri: string;
+    }): Promise<string>;
+    /**
+     * Handle an OAuth callback using configured provider credentials.
+     */
+    handleCallback(ctx: ActionRunner, args: {
+        provider: ProviderName;
+        state: string;
+        code: string;
+    }): Promise<{
+        provider: string;
+        userId: string;
+        connectionId: string;
+    }>;
+    /**
+     * Enqueue a durable sync for a specific connection.
+     */
+    syncConnection(ctx: ActionRunner, args: {
+        connectionId: string;
+        startDate?: number;
+        endDate?: number;
+        syncWindowHours?: number;
+        provider: ProviderName;
+    }): Promise<{
+        syncJobId: string;
+        workflowId: string;
+        deduped: boolean;
+    }>;
+    /**
+     * Run a sync across all active connections using the configured provider credentials.
+     */
+    syncAllActive(ctx: ActionRunner, args?: {
+        syncWindowHours?: number;
+    }): Promise<any>;
+    /**
+     * Start a durable Garmin historical backfill workflow.
+     */
+    startGarminBackfill(ctx: ActionRunner, args: {
+        connectionId: string;
+        lookbackDays?: number;
+    }): Promise<{
+        backfillJobId: string;
+        workflowId: string;
+        deduped: boolean;
+    }>;
+    /**
+     * Get the latest Garmin backfill job for a connection.
+     */
+    getGarminBackfillStatus(ctx: QueryRunner, args: {
+        connectionId: string;
+    }): Promise<BackfillJob | null>;
+    /**
+     * Resolve the configured SDK sync path, or null if the route is disabled.
+     */
+    getSdkSyncPath(config?: RegisterRoutesConfig): string | null;
+    /**
+     * Resolve the full SDK sync URL for a Convex deployment.
+     */
+    getSdkSyncUrl(baseUrl: string, config?: RegisterRoutesConfig): string | null;
+    /**
+     * Delete all data for a user (GDPR compliance, account deletion).
+     */
+    deleteAllUserData(ctx: MutationRunner, args: {
+        userId: string;
+    }): Promise<any>;
+    /**
+     * Get credentials for a provider.
+     */
+    getProviderCredentials(provider: ProviderName): ProviderCredentials | undefined;
+    /**
+     * Get list of configured providers.
+     */
+    getConfiguredProviders(): ProviderName[];
+    private requireProviderCredentials;
+}
+/**
+ * Register HTTP routes for wearable provider integrations.
+ *
+ * Registers Garmin webhook routes and the optional normalized SDK push route
+ * for Apple Health / Google Health Connect / Samsung Health.
+ */
+export declare function registerRoutes(http: HttpRouter, component: WearablesComponent, config?: RegisterRoutesConfig): void;
+/**
+ * Resolve the configured SDK sync path, or null if the route is not registered.
+ *
+ * Pass the same `RegisterRoutesConfig` you use with `registerRoutes()`.
+ */
+export declare function getSdkSyncPath(config?: RegisterRoutesConfig): string | null;
+/**
+ * Resolve the full SDK sync URL for a Convex deployment, or null if disabled.
+ */
+export declare function getSdkSyncUrl(baseUrl: string, config?: RegisterRoutesConfig): string | null;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,UAAU,EACX,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,UAAU,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,OAAO,EACP,UAAU,EACV,cAAc,EACd,eAAe,EAChB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACnF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,YAAY,EACV,cAAc,EACd,WAAW,EACX,UAAU,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,OAAO,EACP,UAAU,EACV,cAAc,EACd,eAAe,GAChB,CAAC;AAOF,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACrD,KAAK,WAAW,GACZ,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC,GACnD,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC,CAAC;AACzD,KAAK,cAAc,GACf,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,aAAa,CAAC,GACzD,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,aAAa,CAAC,CAAC;AAC5D,KAAK,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,CAAC;AAQ1E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,eAAe;IACnB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE,eAAe,CAAC;gBAEnB,SAAS,EAAE,kBAAkB,EAAE,MAAM,EAAE,eAAe;IASlE;;OAEG;IACG,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAMvF;;OAEG;IACG,aAAa,CACjB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,YAAY,CAAA;KAAE,GAC/C,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAI7B;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAMtF;;OAEG;IACG,UAAU,CAAC,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,YAAY,CAAA;KAAE;IAQtF;;OAEG;IACG,SAAS,CACb,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,aAAa,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GACA,OAAO,CAAC,UAAU,CAAC;IAItB;;OAEG;IACG,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAUxF;;OAEG;IACG,aAAa,CACjB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,OAAO,CAAC,SAAS,EAAE,CAAC;IAIvB;;OAEG;IACG,kBAAkB,CACtB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAC3C,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAIzE;;OAEG;IACG,uBAAuB,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ5F;;OAEG;IACG,iBAAiB,CACrB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;KACjB,GACA,OAAO,CAAC,YAAY,EAAE,CAAC;IAQ1B;;OAEG;IACG,qBAAqB,CACzB,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,YAAY,CAAC;QACvB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GACA,OAAO,CAAC,MAAM,CAAC;IAQlB;;OAEG;IACG,WAAW,CACf,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GACvC,OAAO,CAAC,OAAO,EAAE,CAAC;IAIrB;;OAEG;IACG,eAAe,CACnB,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,YAAY,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GACpE,OAAO,CAAC,MAAM,CAAC;IAalB;;OAEG;IACG,cAAc,CAClB,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE;QAAE,QAAQ,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5D,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAYtE;;OAEG;IACG,cAAc,CAClB,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,EAAE,YAAY,CAAC;KACxB,GACA,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAevE;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE;QAAE,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE;IAO1E;;OAEG;IACG,mBAAmB,CACvB,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GACpD,OAAO,CAAC;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAU3E;;OAEG;IACG,uBAAuB,CAC3B,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,GAC7B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAM9B;;OAEG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI;IAI5D;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI;IAQ5E;;OAEG;IACG,iBAAiB,CAAC,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IAUrE;;OAEG;IACH,sBAAsB,CAAC,QAAQ,EAAE,YAAY,GAAG,mBAAmB,GAAG,SAAS;IAI/E;;OAEG;IACH,sBAAsB,IAAI,YAAY,EAAE;IAIxC,OAAO,CAAC,0BAA0B;CAOnC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,UAAU,EAChB,SAAS,EAAE,kBAAkB,EAC7B,MAAM,CAAC,EAAE,oBAAoB,QA8M9B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI,CAS3E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,MAAM,GAAG,IAAI,CAM3F"}