@swimedge/metrics 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -3,12 +3,11 @@
  * Shared metrics registry for frontend, backend, and watch app
  */
 export declare enum SwimType {
-    INDOOR = "indoor",
-    OPEN_WATER = "open_water"
+    INDOOR = "indoorPool",
+    OPEN_WATER = "openWater"
 }
 export interface SwimSessionLaps {
     lapSplitTimes?: number[];
-    lapTurnTimes?: number[];
     lapStrokeTypes?: string[];
     lapHeartRates?: number[];
     lapStrokeCounts?: number[];
@@ -55,6 +54,10 @@ export interface SwimSession extends SwimSessionLaps {
     equipment?: string[];
     avgDistancePerStroke?: number;
     routeCoordinates?: number[][];
+    routeMapImage?: string;
+    deviceType?: string;
+    osVersion?: string;
+    healthKitWorkoutId?: string;
 }
 export interface AggregatedSwimMetrics {
     totalDistance: number;
@@ -94,7 +97,7 @@ export declare const formatPace: (pace: string | number) => string;
 export declare const formatTime: (seconds: number) => string;
 export declare const formatHeartRate: (bpm: number) => string;
 export declare const formatDistance: (meters: number) => string;
-export declare const formatAverageTurnTime: (session: SwimSession) => string;
+export declare const formatSwimType: (swimType: SwimType | string | undefined) => string;
 export interface MetricDefinition {
     key: string;
     label: string;
@@ -114,6 +117,7 @@ export interface MetricDefinition {
         manual: boolean;
     };
     swimTypes: SwimType[];
+    hasChart?: boolean;
     formatter?: (session: SwimSession) => string | number | null;
     lapFormatter?: (value: any) => string;
     condition?: (session: SwimSession) => boolean;
@@ -122,6 +126,7 @@ export declare const METRICS_REGISTRY: Record<keyof SwimSession, MetricDefinitio
 export declare const MetricsHelper: {
     getMetric: (key: keyof SwimSession) => MetricDefinition;
     getSessionMetrics: () => MetricDefinition[];
+    getChartMetrics: () => MetricDefinition[];
     getLapMetrics: () => MetricDefinition[];
     getMetricsByCategory: (category: MetricCategory) => MetricDefinition[];
     getMetricsBySwimType: (swimType: SwimType) => MetricDefinition[];

package/dist/index.js

@@ -4,11 +4,11 @@
  * Shared metrics registry for frontend, backend, and watch app
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetricsHelper = exports.METRICS_REGISTRY = exports.formatAverageTurnTime = exports.formatDistance = exports.formatHeartRate = exports.formatTime = exports.formatPace = exports.formatNumber = exports.MetricCategory = exports.SwimType = void 0;
+exports.MetricsHelper = exports.METRICS_REGISTRY = exports.formatSwimType = exports.formatDistance = exports.formatHeartRate = exports.formatTime = exports.formatPace = exports.formatNumber = exports.MetricCategory = exports.SwimType = void 0;
 var SwimType;
 (function (SwimType) {
-    SwimType["INDOOR"] = "indoor";
-    SwimType["OPEN_WATER"] = "open_water";
+    SwimType["INDOOR"] = "indoorPool";
+    SwimType["OPEN_WATER"] = "openWater";
 })(SwimType || (exports.SwimType = SwimType = {}));
 var MetricCategory;
 (function (MetricCategory) {
@@ -32,7 +32,12 @@ const formatPace = (pace) => {
 exports.formatPace = formatPace;
 const formatTime = (seconds) => {
     const mins = Math.floor(seconds / 60);
-    const secs = Math.floor(seconds % 60);
+    const secs = seconds % 60;
+    if (mins >= 60) {
+        const hours = Math.floor(mins / 60);
+        const remainingMins = mins % 60;
+        return `${hours}:${remainingMins.toString().padStart(2, '0')}`;
+    }
     return `${mins}:${secs.toString().padStart(2, '0')}`;
 };
 exports.formatTime = formatTime;
@@ -46,16 +51,15 @@ const formatDistance = (meters) => {
         : `${Math.round(meters)}m`;
 };
 exports.formatDistance = formatDistance;
-const formatAverageTurnTime = (session) => {
-    if (!session.lapTurnTimes?.length)
-        return '';
-    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;
-    return `${(0, exports.formatNumber)(avgTime, 1)}s`;
+const formatSwimType = (swimType) => {
+    if (!swimType)
+        return 'Unknown';
+    return ({
+        [SwimType.INDOOR]: 'Indoor Pool',
+        [SwimType.OPEN_WATER]: 'Open Water',
+    }[swimType] || swimType);
 };
-exports.formatAverageTurnTime = formatAverageTurnTime;
+exports.formatSwimType = formatSwimType;
 exports.METRICS_REGISTRY = {
     distance: {
         key: 'distance',
@@ -70,6 +74,7 @@ exports.METRICS_REGISTRY = {
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => (0, exports.formatDistance)(s.distance),
     },
     time: {
@@ -85,6 +90,7 @@ exports.METRICS_REGISTRY = {
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => (0, exports.formatTime)(s.time),
     },
     activeTime: {
@@ -99,6 +105,7 @@ exports.METRICS_REGISTRY = {
         healthKitSource: 'HKWorkoutBuilder.elapsedTime',
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
+        hasChart: true,
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
     },
     restTime: {
@@ -112,6 +119,7 @@ exports.METRICS_REGISTRY = {
         formula: 'Total Duration - Active Time',
         availableFrom: { watch: true, manual: false },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => (0, exports.formatTime)(s.restTime),
         condition: (s) => !!s.restTime,
     },
@@ -126,6 +134,7 @@ exports.METRICS_REGISTRY = {
         formula: 'Distance ÷ Pool Length',
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR],
+        hasChart: true,
         formatter: (s) => String(s.laps),
         condition: (s) => !!s.laps,
     },
@@ -140,6 +149,7 @@ exports.METRICS_REGISTRY = {
         formula: '(Active Time ÷ Distance) × 100',
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => (0, exports.formatPace)(s.avgPace),
         condition: (s) => !!s.avgPace,
     },
@@ -168,7 +178,7 @@ exports.METRICS_REGISTRY = {
         source: 'User selection or workout location type',
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
-        formatter: (s) => s.swimType,
+        formatter: (s) => (0, exports.formatSwimType)(s.swimType),
         condition: (s) => !!s.swimType,
     },
     waterTemp: {
@@ -247,6 +257,7 @@ exports.METRICS_REGISTRY = {
         isHealthKit: true,
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => String(s.calories),
         condition: (s) => !!s.calories,
     },
@@ -263,6 +274,7 @@ exports.METRICS_REGISTRY = {
         isHealthKit: true,
         availableFrom: { watch: true, manual: false },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => String(s.totalStrokeCount || 0),
         condition: (s) => !!s.totalStrokeCount,
     },
@@ -277,6 +289,7 @@ exports.METRICS_REGISTRY = {
         formula: 'Total Strokes ÷ (Active Time in Minutes)',
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => `${(0, exports.formatNumber)(s.avgStrokeRate, 1)} SPM`,
         condition: (s) => !!s.avgStrokeRate,
     },
@@ -291,6 +304,7 @@ exports.METRICS_REGISTRY = {
         formula: 'Distance ÷ Total Strokes',
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+        hasChart: true,
         formatter: (s) => `${(0, exports.formatNumber)(s.avgDistancePerStroke, 2)}m`,
         condition: (s) => !!s.avgDistancePerStroke,
     },
@@ -305,6 +319,7 @@ exports.METRICS_REGISTRY = {
         formula: 'Average of (Lap Time in Seconds + Lap Stroke Count) for each lap',
         availableFrom: { watch: true, manual: true },
         swimTypes: [SwimType.INDOOR],
+        hasChart: true,
         formatter: (s) => (0, exports.formatNumber)(s.avgSwolfScore, 0),
         condition: (s) => !!s.avgSwolfScore,
     },
@@ -405,20 +420,21 @@ exports.METRICS_REGISTRY = {
         availableFrom: { watch: false, manual: false },
         swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
     },
-    lapTurnTimes: {
-        key: 'lapTurnTimes',
-        label: 'Turn',
-        unit: 's',
-        category: MetricCategory.TECHNIQUE,
-        description: 'Time spent turning at pool wall per lap',
-        icon: 'refresh-circle-outline',
-        isPerLap: true,
-        decimals: 2,
-        availableFrom: { watch: true, manual: false },
-        swimTypes: [SwimType.INDOOR],
-        formatter: exports.formatAverageTurnTime,
-        condition: (s) => !!s.lapTurnTimes?.length,
-    },
+    // HealthKit doesn't track turn times
+    /*lapTurnTimes: {
+      key: 'lapTurnTimes',
+      label: 'Turn',
+      unit: 's',
+      category: MetricCategory.TECHNIQUE,
+      description: 'Time spent turning at pool wall per lap',
+      icon: 'refresh-circle-outline',
+      isPerLap: true,
+      decimals: 2,
+      availableFrom: { watch: true, manual: false },
+      swimTypes: [SwimType.INDOOR],
+      formatter: formatAverageTurnTime,
+      condition: (s) => !!s.lapTurnTimes?.length,
+    },*/
     lapStrokeTypes: {
         key: 'lapStrokeTypes',
         label: 'Stroke',
@@ -565,10 +581,48 @@ exports.METRICS_REGISTRY = {
         formatter: (s) => s.routeCoordinates ? `${s.routeCoordinates.length} points` : '',
         condition: (s) => !!s.routeCoordinates?.length,
     },
+    deviceType: {
+        key: 'deviceType',
+        label: 'Device',
+        category: MetricCategory.PERFORMANCE,
+        description: 'Device used to record the session',
+        isPerSession: true,
+        availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+    },
+    osVersion: {
+        key: 'osVersion',
+        label: 'OS Version',
+        category: MetricCategory.PERFORMANCE,
+        description: 'Operating system version of the recording device',
+        isPerSession: true,
+        availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+    },
+    healthKitWorkoutId: {
+        key: 'healthKitWorkoutId',
+        label: 'HealthKit ID',
+        category: MetricCategory.PERFORMANCE,
+        description: 'HealthKit workout identifier',
+        isPerSession: true,
+        availableFrom: { watch: true, manual: false },
+        swimTypes: [SwimType.INDOOR, SwimType.OPEN_WATER],
+    },
+    routeMapImage: {
+        key: 'routeMapImage',
+        label: 'Route Map',
+        category: MetricCategory.PERFORMANCE,
+        description: 'Base64 encoded route map image for open water sessions',
+        isPerSession: true,
+        availableFrom: { watch: false, manual: false },
+        swimTypes: [SwimType.OPEN_WATER],
+        condition: (s) => !!s.routeMapImage,
+    },
 };
 exports.MetricsHelper = {
     getMetric: (key) => exports.METRICS_REGISTRY[key],
     getSessionMetrics: () => Object.values(exports.METRICS_REGISTRY).filter((m) => m.isPerSession),
+    getChartMetrics: () => Object.values(exports.METRICS_REGISTRY).filter((m) => m.isPerSession && m.hasChart),
     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)),

package/dist/index.spec.js

@@ -72,34 +72,4 @@ describe('Metrics Formatting Functions', () => {
             expect((0, index_1.formatDistance)(500.7)).toBe('501m');
         });
     });
-    describe('formatAverageTurnTime', () => {
-        const createSession = (lapTurnTimes) => ({
-            id: '1',
-            date: '2024-01-01',
-            distance: 1000,
-            laps: 20,
-            time: 1200,
-            calories: 300,
-            avgPace: '2:00',
-            poolLength: 50,
-            source: 'watch',
-            lapTurnTimes,
-        });
-        it('should return empty string when no lap turn times', () => {
-            expect((0, index_1.formatAverageTurnTime)(createSession())).toBe('');
-            expect((0, index_1.formatAverageTurnTime)(createSession([]))).toBe('');
-        });
-        it('should calculate average turn time', () => {
-            expect((0, index_1.formatAverageTurnTime)(createSession([2.5, 3.0, 2.5]))).toBe('2.7s');
-        });
-        it('should filter out invalid turn times', () => {
-            expect((0, index_1.formatAverageTurnTime)(createSession([2.5, NaN, 3.0, 0, 2.5]))).toBe('2.7s');
-        });
-        it('should return empty string when all turn times are invalid', () => {
-            expect((0, index_1.formatAverageTurnTime)(createSession([NaN, 0, -1]))).toBe('');
-        });
-        it('should format with 1 decimal place', () => {
-            expect((0, index_1.formatAverageTurnTime)(createSession([2.456]))).toBe('2.5s');
-        });
-    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swimedge/metrics",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Shared metrics registry for SwimEdge (frontend, backend, watch)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,7 +13,6 @@
     "README.md"
   ],
   "scripts": {
-    "prepublishOnly": "npm run build",
     "build": "tsc",
     "watch": "tsc --watch",
     "export-json": "node scripts/export-json.js",