@swimedge/metrics 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -54,6 +54,7 @@ export interface SwimSession extends SwimSessionLaps {
     perceivedEffort?: string;
     equipment?: string[];
     avgDistancePerStroke?: number;
+    routeCoordinates?: number[][];
 }
 export interface AggregatedSwimMetrics {
     totalDistance: number;
@@ -112,6 +113,7 @@ export interface MetricDefinition {
         watch: boolean;
         manual: boolean;
     };
+    swimTypes: SwimType[];
     formatter?: (session: SwimSession) => string | number | null;
     lapFormatter?: (value: any) => string;
     condition?: (session: SwimSession) => boolean;
@@ -122,5 +124,8 @@ export declare const MetricsHelper: {
     getSessionMetrics: () => MetricDefinition[];
     getLapMetrics: () => MetricDefinition[];
     getMetricsByCategory: (category: MetricCategory) => MetricDefinition[];
+    getMetricsBySwimType: (swimType: SwimType) => MetricDefinition[];
+    getIndoorMetrics: () => MetricDefinition[];
+    getOpenWaterMetrics: () => MetricDefinition[];
     getAllMetricKeys: () => string[];
 };

package/dist/index.js

@@ -49,7 +49,7 @@ exports.formatDistance = formatDistance;
 const formatAverageTurnTime = (session) => {
     if (!session.lapTurnTimes?.length)
         return '';
-    const validTurnTimes = session.lapTurnTimes.filter(t => !isNaN(t) && t > 0);
+    const validTurnTimes = session.lapTurnTimes.filter((t) => !isNaN(t) && t > 0);
     if (!validTurnTimes.length)
         return '';
     const avgTime = validTurnTimes.reduce((a, b) => a + b, 0) / validTurnTimes.length;
@@ -69,6 +69,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKWorkout.totalDistance',
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatDistance)(s.distance),
     },
     time: {
@@ -83,6 +84,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKWorkout.duration',
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatTime)(s.time),
     },
     activeTime: {
@@ -97,6 +99,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKWorkoutBuilder.elapsedTime',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
     },
     restTime: {
         key: 'restTime',
@@ -108,6 +111,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         formula: 'Total Duration - Active Time',
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatTime)(s.restTime),
         condition: (s) => !!s.restTime,
     },
@@ -121,6 +125,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         formula: 'Distance ÷ Pool Length',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR],
         formatter: (s) => String(s.laps),
         condition: (s) => !!s.laps,
     },
@@ -134,6 +139,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         formula: '(Active Time ÷ Distance) × 100',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatPace)(s.avgPace),
         condition: (s) => !!s.avgPace,
     },
@@ -147,6 +153,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         source: 'User configuration setting',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR],
         formatter: (s) => `${s.poolLength}m`,
         condition: (s) => !!s.poolLength,
     },
@@ -160,6 +167,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         source: 'User selection or workout location type',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => s.swimType,
         condition: (s) => !!s.swimType,
     },
@@ -174,6 +182,7 @@ exports.METRICS_REGISTRY = {
         source: 'Apple Watch water temperature sensor',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => `${(0, exports.formatNumber)(s.waterTemp, 1)}°C`,
         condition: (s) => !!s.waterTemp,
     },
@@ -189,6 +198,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierHeartRate',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatHeartRate)(s.avgHeartRate),
         condition: (s) => !!s.avgHeartRate,
     },
@@ -204,6 +214,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierHeartRate',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatHeartRate)(s.maxHeartRate),
         condition: (s) => !!s.maxHeartRate,
     },
@@ -219,6 +230,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierHeartRate',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => (0, exports.formatHeartRate)(s.minHeartRate),
         condition: (s) => !!s.minHeartRate,
     },
@@ -234,6 +246,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierActiveEnergyBurned',
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => String(s.calories),
         condition: (s) => !!s.calories,
     },
@@ -249,6 +262,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierSwimmingStrokeCount',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => String(s.totalStrokeCount || 0),
         condition: (s) => !!s.totalStrokeCount,
     },
@@ -262,6 +276,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         formula: 'Total Strokes ÷ (Active Time in Minutes)',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => `${(0, exports.formatNumber)(s.avgStrokeRate, 1)} SPM`,
         condition: (s) => !!s.avgStrokeRate,
     },
@@ -275,6 +290,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         formula: 'Distance ÷ Total Strokes',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => `${(0, exports.formatNumber)(s.avgDistancePerStroke, 2)}m`,
         condition: (s) => !!s.avgDistancePerStroke,
     },
@@ -288,6 +304,7 @@ exports.METRICS_REGISTRY = {
         isPerSession: true,
         formula: 'Average of (Lap Time in Seconds + Lap Stroke Count) for each lap',
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR],
         formatter: (s) => (0, exports.formatNumber)(s.avgSwolfScore, 0),
         condition: (s) => !!s.avgSwolfScore,
     },
@@ -303,6 +320,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKWorkoutEvent.metadata[HKMetadataKeySwimmingStrokeStyle]',
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
         formatter: (s) => s.primaryStrokeType,
         condition: (s) => !!s.primaryStrokeType,
     },
@@ -316,6 +334,7 @@ exports.METRICS_REGISTRY = {
         isPerLap: true,
         source: 'Tracked per lap completion',
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
         formatter: (s) => `${s.lapSplitTimes.length} splits`,
         lapFormatter: (v) => (0, exports.formatTime)(v),
         condition: (s) => !!s.lapSplitTimes?.length,
@@ -333,6 +352,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierHeartRate',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     lapStrokeCounts: {
         key: 'lapStrokeCounts',
@@ -347,6 +367,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKQuantityTypeIdentifierSwimmingStrokeCount',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     id: {
         key: 'id',
@@ -355,6 +376,7 @@ exports.METRICS_REGISTRY = {
         description: 'Session identifier',
         isPerSession: true,
         availableFrom: { watch: false, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     watchSessionId: {
         key: 'watchSessionId',
@@ -363,6 +385,7 @@ exports.METRICS_REGISTRY = {
         description: 'Watch session identifier',
         isPerSession: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     date: {
         key: 'date',
@@ -371,6 +394,7 @@ exports.METRICS_REGISTRY = {
         description: 'Session date',
         isPerSession: true,
         availableFrom: { watch: true, manual: true },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
     },
     source: {
         key: 'source',
@@ -379,6 +403,7 @@ exports.METRICS_REGISTRY = {
         description: 'Data source',
         isPerSession: true,
         availableFrom: { watch: false, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
     },
     lapTurnTimes: {
         key: 'lapTurnTimes',
@@ -390,6 +415,7 @@ exports.METRICS_REGISTRY = {
         isPerLap: true,
         decimals: 2,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
         formatter: exports.formatAverageTurnTime,
         condition: (s) => !!s.lapTurnTimes?.length,
     },
@@ -401,6 +427,7 @@ exports.METRICS_REGISTRY = {
         icon: 'list-outline',
         isPerLap: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
         formatter: (s) => `${s.lapStrokeTypes.length} types`,
         condition: (s) => !!s.lapStrokeTypes?.length,
     },
@@ -413,6 +440,7 @@ exports.METRICS_REGISTRY = {
         isPerLap: true,
         decimals: 1,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     lapCalories: {
         key: 'lapCalories',
@@ -423,6 +451,7 @@ exports.METRICS_REGISTRY = {
         isPerLap: true,
         decimals: 0,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     lapDistances: {
         key: 'lapDistances',
@@ -432,6 +461,7 @@ exports.METRICS_REGISTRY = {
         description: 'Distance per lap',
         isPerLap: true,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     lapSwolfScores: {
         key: 'lapSwolfScores',
@@ -441,6 +471,7 @@ exports.METRICS_REGISTRY = {
         isPerLap: true,
         decimals: 0,
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     lapStrokeRates: {
         key: 'lapStrokeRates',
@@ -453,6 +484,7 @@ exports.METRICS_REGISTRY = {
         decimals: 1,
         formula: 'Lap Strokes ÷ (Lap Time in Minutes)',
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     lapDistancesPerStroke: {
         key: 'lapDistancesPerStroke',
@@ -465,6 +497,7 @@ exports.METRICS_REGISTRY = {
         decimals: 2,
         formula: 'Lap Distance ÷ Lap Strokes',
         availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR],
     },
     poolLocation: {
         key: 'poolLocation',
@@ -473,6 +506,7 @@ exports.METRICS_REGISTRY = {
         description: 'Pool location details',
         isPerSession: true,
         availableFrom: { watch: false, manual: true },
+        swimTypes: [SwimType.INDOOR],
     },
     notes: {
         key: 'notes',
@@ -481,6 +515,7 @@ exports.METRICS_REGISTRY = {
         description: 'Session notes',
         isPerSession: true,
         availableFrom: { watch: false, manual: true },
+        swimTypes: [SwimType.INDOOR],
     },
     trainingTypes: {
         key: 'trainingTypes',
@@ -492,6 +527,7 @@ exports.METRICS_REGISTRY = {
         availableFrom: { watch: false, manual: true },
         formatter: (s) => s.trainingTypes?.join(', ') || '',
         condition: (s) => !!s.trainingTypes?.length,
+        swimTypes: [SwimType.INDOOR],
     },
     perceivedEffort: {
         key: 'perceivedEffort',
@@ -503,6 +539,7 @@ exports.METRICS_REGISTRY = {
         availableFrom: { watch: false, manual: true },
         formatter: (s) => s.perceivedEffort,
         condition: (s) => !!s.perceivedEffort,
+        swimTypes: [SwimType.INDOOR],
     },
     equipment: {
         key: 'equipment',
@@ -514,6 +551,19 @@ exports.METRICS_REGISTRY = {
         availableFrom: { watch: false, manual: true },
         formatter: (s) => s.equipment?.join(', ') || '',
         condition: (s) => !!s.equipment?.length,
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+    },
+    routeCoordinates: {
+        key: 'routeCoordinates',
+        label: 'GPS Route',
+        category: MetricCategory.PERFORMANCE,
+        description: 'GPS coordinates of the swimming route',
+        icon: 'map-outline',
+        isPerSession: true,
+        availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.OPEN_WATER],
+        formatter: (s) => s.routeCoordinates ? `${s.routeCoordinates.length} points` : '',
+        condition: (s) => !!s.routeCoordinates?.length,
     },
 };
 exports.MetricsHelper = {
@@ -521,5 +571,8 @@ exports.MetricsHelper = {
     getSessionMetrics: () => Object.values(exports.METRICS_REGISTRY).filter((m) => m.isPerSession),
     getLapMetrics: () => Object.values(exports.METRICS_REGISTRY).filter((m) => m.isPerLap),
     getMetricsByCategory: (category) => Object.values(exports.METRICS_REGISTRY).filter((m) => m.category === category),
+    getMetricsBySwimType: (swimType) => Object.values(exports.METRICS_REGISTRY).filter((m) => m.swimTypes?.includes(swimType)),
+    getIndoorMetrics: () => Object.values(exports.METRICS_REGISTRY).filter((m) => m.swimTypes?.includes(SwimType.INDOOR)),
+    getOpenWaterMetrics: () => Object.values(exports.METRICS_REGISTRY).filter((m) => m.swimTypes?.includes(SwimType.OPEN_WATER)),
     getAllMetricKeys: () => Object.keys(exports.METRICS_REGISTRY),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swimedge/metrics",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Shared metrics registry for SwimEdge (frontend, backend, watch)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",