fit-file-parser 5.2.1 → 6.1.1

package/dist/profile-lookup.d.ts

@@ -0,0 +1,19 @@
+/** Resolves a FIT manufacturer identifier to its canonical profile name. */
+export declare function getFitManufacturerName(value: number | string | null | undefined): string | null;
+/** Resolves a Garmin product identifier to its canonical profile name. */
+export declare function getFitGarminProductName(value: number | string | null | undefined): string | null;
+/** Resolves a FIT sport identifier to its canonical profile name. */
+export declare function getFitSportName(value: number | string | null | undefined): string | null;
+/** Resolves a FIT sub-sport identifier to its canonical profile name. */
+export declare function getFitSubSportName(value: number | string | null | undefined): string | null;
+/** Resolves a FIT sport name to its numeric profile identifier. */
+export declare function getFitSportId(value: string | null | undefined): number | null;
+/** Resolves a FIT sub-sport name to its numeric profile identifier. */
+export declare function getFitSubSportId(value: string | null | undefined): number | null;
+/** Resolves a FIT course-point name to its numeric profile identifier. */
+export declare function getFitCoursePointId(value: string | null | undefined): number | null;
+/**
+ * Resolves a Garmin product identifier to a human-readable device name.
+ * This does not alter parsed `product` or `product_name` fields.
+ */
+export declare function getFitGarminProductDisplayName(value: number | string | null | undefined): string | null;

package/dist/profile-lookup.js

@@ -0,0 +1,140 @@
+import { PROFILE_TYPES } from './profile.js';
+function normalizeProfileName(value) {
+    return value.trim().toLowerCase().replace(/[\s_-]/g, '');
+}
+const FIT_PROFILE_MANUFACTURERS = PROFILE_TYPES.manufacturer;
+const FIT_PROFILE_GARMIN_PRODUCTS = PROFILE_TYPES.garmin_product;
+const FIT_PROFILE_SPORTS = PROFILE_TYPES.sport;
+const FIT_PROFILE_SUB_SPORTS = PROFILE_TYPES.sub_sport;
+const FIT_PROFILE_COURSE_POINTS = PROFILE_TYPES.course_point;
+function createProfileIdMap(mapping) {
+    return new Map(Object.entries(mapping)
+        .filter((entry) => typeof entry[1] === 'string')
+        .map(([id, name]) => [normalizeProfileName(name), Number(id)]));
+}
+const FIT_PROFILE_SPORT_IDS = createProfileIdMap(FIT_PROFILE_SPORTS);
+const FIT_PROFILE_SUB_SPORT_IDS = createProfileIdMap(FIT_PROFILE_SUB_SPORTS);
+const FIT_PROFILE_COURSE_POINT_IDS = createProfileIdMap(FIT_PROFILE_COURSE_POINTS);
+function getProfileName(mapping, value) {
+    if (value === null || value === undefined) {
+        return null;
+    }
+    if (typeof value !== 'number' && typeof value !== 'string') {
+        return null;
+    }
+    const normalizedValue = typeof value === 'string' ? value.trim() : value;
+    if (normalizedValue === '' || (typeof normalizedValue === 'string' && !/^\d+$/.test(normalizedValue))) {
+        return null;
+    }
+    const id = Number(normalizedValue);
+    if (!Number.isSafeInteger(id) || id < 0) {
+        return null;
+    }
+    const name = mapping[id];
+    return typeof name === 'string' ? name : null;
+}
+function getProfileId(mapping, value) {
+    var _a;
+    if (typeof value !== 'string') {
+        return null;
+    }
+    const name = normalizeProfileName(value);
+    if (name === '') {
+        return null;
+    }
+    return (_a = mapping.get(name)) !== null && _a !== void 0 ? _a : null;
+}
+/** Resolves a FIT manufacturer identifier to its canonical profile name. */
+export function getFitManufacturerName(value) {
+    return getProfileName(FIT_PROFILE_MANUFACTURERS, value);
+}
+/** Resolves a Garmin product identifier to its canonical profile name. */
+export function getFitGarminProductName(value) {
+    return getProfileName(FIT_PROFILE_GARMIN_PRODUCTS, value);
+}
+/** Resolves a FIT sport identifier to its canonical profile name. */
+export function getFitSportName(value) {
+    return getProfileName(FIT_PROFILE_SPORTS, value);
+}
+/** Resolves a FIT sub-sport identifier to its canonical profile name. */
+export function getFitSubSportName(value) {
+    return getProfileName(FIT_PROFILE_SUB_SPORTS, value);
+}
+/** Resolves a FIT sport name to its numeric profile identifier. */
+export function getFitSportId(value) {
+    return getProfileId(FIT_PROFILE_SPORT_IDS, value);
+}
+/** Resolves a FIT sub-sport name to its numeric profile identifier. */
+export function getFitSubSportId(value) {
+    return getProfileId(FIT_PROFILE_SUB_SPORT_IDS, value);
+}
+/** Resolves a FIT course-point name to its numeric profile identifier. */
+export function getFitCoursePointId(value) {
+    return getProfileId(FIT_PROFILE_COURSE_POINT_IDS, value);
+}
+/**
+ * Resolves a Garmin product identifier to a human-readable device name.
+ * This does not alter parsed `product` or `product_name` fields.
+ */
+export function getFitGarminProductDisplayName(value) {
+    const name = getFitGarminProductName(value);
+    if (!name) {
+        return null;
+    }
+    // Preserve the established display spelling for the optical heart-rate product.
+    const displaySource = name === 'o_hr' ? 'o_h_r' : name;
+    const formatted = displaySource
+        .replace(/^fr(\d+)/i, 'Forerunner $1')
+        .replace(/^fenix(\d+)/i, 'Fenix $1')
+        .replace(/^edge(\d+)/i, 'Edge $1')
+        .replace(/^vivoactive/i, 'VivoActive')
+        .replace(/^vivosmart/i, 'VivoSmart')
+        .replace(/^vivofit/i, 'VivoFit')
+        .replace(/^vivomove/i, 'VivoMove')
+        .replace(/^vivosport/i, 'VivoSport')
+        .replace(/^approach([A-Z\d])/i, 'Approach $1')
+        .replace(/^marq([A-Z])/i, 'Marq $1')
+        .replace(/^hrm/i, 'HRM ')
+        .replace(/_/g, ' ')
+        .replace(/([a-z])([A-Z0-9])/g, '$1 $2')
+        .replace(/(\d)([a-z])/gi, '$1 $2');
+    return formatted
+        .split(' ')
+        .map((word) => {
+        const lower = word.toLowerCase();
+        if (lower === 'apac')
+            return 'APAC';
+        if (lower === 'xt')
+            return 'XT';
+        if (lower === 'lte')
+            return 'LTE';
+        if (lower === 'hr')
+            return 'HR';
+        if (lower === 'gps')
+            return 'GPS';
+        if (lower === 'mtb')
+            return 'MTB';
+        if (lower === 'ii')
+            return 'II';
+        if (lower === 'iii')
+            return 'III';
+        if (lower === 'm' && name.toLowerCase().includes('645m'))
+            return 'Music';
+        if (lower === 'jpn')
+            return 'Japan';
+        if (lower === 'chn')
+            return 'China';
+        if (lower === 'twn')
+            return 'Taiwan';
+        if (lower === 'kor')
+            return 'Korea';
+        if (lower === 'rus')
+            return 'Russia';
+        if (lower === 'sea')
+            return 'SEA';
+        return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
+    })
+        .join(' ')
+        .replace(/Vivo Active/g, 'VivoActive')
+        .trim();
+}

package/dist/profile.d.ts

@@ -0,0 +1,9 @@
+import type { Message } from './fit.js';
+/**
+ * Static, community-maintained FIT interoperability profile.
+ *
+ * This table is ordinary project source maintained under the repository's MIT
+ * license. See PROFILE.md for the maintenance and verification policy.
+ */
+export declare const PROFILE_MESSAGES: Record<number, Message>;
+export declare const PROFILE_TYPES: Record<string, Record<number, string | number>>;

package/dist/{cjs/garmin_profile.generated.js → profile.js}

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GARMIN_TYPES = exports.GARMIN_MESSAGES = exports.GARMIN_PROFILE_VERSION = void 0;
-exports.GARMIN_PROFILE_VERSION = {
-    major: 21,
-    minor: 208,
-    patch: 0,
-    type: 'Release',
-};
-exports.GARMIN_MESSAGES = {
+/**
+ * Static, community-maintained FIT interoperability profile.
+ *
+ * This table is ordinary project source maintained under the repository's MIT
+ * license. See PROFILE.md for the maintenance and verification policy.
+ */
+export const PROFILE_MESSAGES = {
     0: {
         0: {
             field: 'type',
@@ -2589,6 +2586,13 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: 'Breaths/min',
         },
+        178: {
+            field: 'est_sweat_loss',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'ml',
+        },
         180: {
             field: 'enhanced_min_respiration_rate',
             type: 'uint16',
@@ -2643,6 +2647,13 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: 'Flow',
         },
+        188: {
+            field: 'primary_benefit',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
         192: {
             field: 'workout_feel',
             type: 'uint8',
@@ -2724,6 +2735,27 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: 'm',
         },
+        205: {
+            field: 'beginning_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        206: {
+            field: 'ending_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        207: {
+            field: 'min_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
         208: {
             field: 'avg_core_temperature',
             type: 'uint16',
@@ -4422,6 +4454,13 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: 'm',
         },
+        90: {
+            field: 'garmin_performance_condition',
+            type: 'sint8',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
         91: {
             field: 'absolute_pressure',
             type: 'uint32',
@@ -4629,6 +4668,20 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: 'percent',
         },
+        137: {
+            field: 'potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        138: {
+            field: 'stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
         139: {
             field: 'core_temperature',
             type: 'uint16',
@@ -4959,6 +5012,13 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: '',
         },
+        24: {
+            field: 'ant_id',
+            type: 'uint32z',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
         25: {
             field: 'source_type',
             type: 'source_type',
@@ -6401,6 +6461,107 @@ exports.GARMIN_MESSAGES = {
         },
         name: 'hrv',
     },
+    79: {
+        0: {
+            field: 'vo2_max',
+            type: 'uint16',
+            scale: 292.57142857142856,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        1: {
+            field: 'age',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'years',
+        },
+        2: {
+            field: 'height',
+            type: 'uint8',
+            scale: 100,
+            offset: 0,
+            units: 'm',
+        },
+        3: {
+            field: 'weight',
+            type: 'uint16',
+            scale: 10,
+            offset: 0,
+            units: 'kg',
+        },
+        4: {
+            field: 'gender',
+            type: 'gender',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        6: {
+            field: 'max_heart_rate',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        8: {
+            field: 'remaining_recovery_time',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        11: {
+            field: 'lthr',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        12: {
+            field: 'ltpower',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'watts',
+        },
+        13: {
+            field: 'ltspeed',
+            type: 'uint16',
+            scale: 1000,
+            offset: 0,
+            units: 'm/s',
+        },
+        16: {
+            field: 'start_of_activity',
+            type: 'date_time',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        19: {
+            field: 'first_vo2_max',
+            type: 'uint32',
+            scale: 18724.571428571428,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        35: {
+            field: 'end_of_previous_activity',
+            type: 'date_time',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        253: {
+            field: 'timestamp',
+            type: 'date_time',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        name: 'user_metrics',
+    },
     80: {
         0: {
             field: 'fractional_timestamp',
@@ -7256,6 +7417,93 @@ exports.GARMIN_MESSAGES = {
         },
         name: 'hr',
     },
+    140: {
+        1: {
+            field: 'new_max_heart_rate',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        4: {
+            field: 'aerobic_training_effect',
+            type: 'uint8',
+            scale: 10,
+            offset: 0,
+            units: '',
+        },
+        7: {
+            field: 'vo2_max',
+            type: 'uint32',
+            scale: 18724.571428571428,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        9: {
+            field: 'recovery_time',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'min',
+        },
+        11: {
+            field: 'sport',
+            type: 'sport',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        20: {
+            field: 'anaerobic_training_effect',
+            type: 'uint8',
+            scale: 10,
+            offset: 0,
+            units: '',
+        },
+        29: {
+            field: 'first_vo2_max',
+            type: 'uint32',
+            scale: 18724.571428571428,
+            offset: 0,
+            units: 'ml/kg/min',
+        },
+        41: {
+            field: 'primary_benefit',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: '',
+        },
+        60: {
+            field: 'total_ascent',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'm',
+        },
+        61: {
+            field: 'total_descent',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'm',
+        },
+        62: {
+            field: 'avg_power',
+            type: 'uint16',
+            scale: 1,
+            offset: 0,
+            units: 'watts',
+        },
+        63: {
+            field: 'avg_heart_rate',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'bpm',
+        },
+        name: 'activity_metrics',
+    },
     142: {
         0: {
             field: 'event',
@@ -11790,6 +12038,27 @@ exports.GARMIN_MESSAGES = {
             offset: 0,
             units: 's',
         },
+        107: {
+            field: 'beginning_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        108: {
+            field: 'ending_potential_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
+        109: {
+            field: 'min_stamina',
+            type: 'uint8',
+            scale: 1,
+            offset: 0,
+            units: 'percent',
+        },
         110: {
             field: 'total_moving_time',
             type: 'uint32',
@@ -13035,7 +13304,7 @@ exports.GARMIN_MESSAGES = {
         name: 'sleep_disruption_overnight_severity',
     },
 };
-exports.GARMIN_TYPES = {
+export const PROFILE_TYPES = {
     activity: {
         0: 'manual',
         1: 'auto_multi_sport',
@@ -15765,6 +16034,7 @@ exports.GARMIN_TYPES = {
         55: 'monitoring',
         72: 'training_file',
         78: 'hrv',
+        79: 'user_metrics',
         80: 'ant_rx',
         81: 'ant_tx',
         82: 'ant_channel_id',
@@ -15777,6 +16047,7 @@ exports.GARMIN_TYPES = {
         129: 'weather_alert',
         131: 'cadence_zone',
         132: 'hr',
+        140: 'activity_metrics',
         142: 'segment_lap',
         145: 'memo_glob',
         148: 'segment_id',
@@ -17205,6 +17476,8 @@ exports.GARMIN_TYPES = {
         125: 'rally',
         126: 'pool_triathlon',
         127: 'e_bike_enduro',
+        153: 'mountain_enduro',
+        154: 'mountain_downhill',
         254: 'all',
     },
     supported_exd_screen_layouts: {

package/dist/raw-message-reader.d.ts

@@ -0,0 +1,60 @@
+export type FitMessageReaderErrorCode = 'invalid_input' | 'input_limit' | 'invalid_header' | 'invalid_crc' | 'invalid_structure';
+export type FitMessageReaderIssueCode = 'invalid_timestamp';
+export interface FitRawField {
+    fieldNumber: number;
+    size: number;
+    baseType: number;
+    bytes: Uint8Array;
+}
+export interface FitRawDeveloperField {
+    fieldNumber: number;
+    size: number;
+    developerDataIndex: number;
+    bytes: Uint8Array;
+}
+export interface FitRawMessage {
+    globalMessageNumber: number;
+    messageIndex: number;
+    littleEndian: boolean;
+    /** Native FIT timestamp in seconds since the FIT epoch, when available. */
+    timestamp?: number;
+    /** Reconstructed native timestamp when the record used a compressed header. */
+    compressedTimestamp?: number;
+    fields: FitRawField[];
+    developerFields: FitRawDeveloperField[];
+}
+export interface FitMessageReaderIssue {
+    code: FitMessageReaderIssueCode;
+    globalMessageNumber: number;
+    messageIndex: number;
+}
+export interface FitMessageReaderResult {
+    protocolVersion: number;
+    profileVersion: number;
+    messages: FitRawMessage[];
+    issues: FitMessageReaderIssue[];
+}
+export interface FitMessageReaderOptions {
+    /** Retain only these global message numbers. Omit to retain every message. */
+    messageNumbers?: readonly number[];
+    /** Reject larger inputs before allocating retained message data. */
+    maxInputBytes?: number;
+}
+/** Error thrown when the strict raw-message reader rejects a FIT input. */
+export declare class FitMessageReaderError extends Error {
+    readonly code: FitMessageReaderErrorCode;
+    constructor(code: FitMessageReaderErrorCode);
+}
+/** Returns the five-bit FIT base-type identifier, or null for reserved/unknown values. */
+export declare function getFitBaseTypeId(baseType: number): number | null;
+/** Reads an unsigned one-, two-, or four-byte raw FIT field. */
+export declare function readFitUnsignedField(field: FitRawField | undefined, expectedBaseType: number, size: 1 | 2 | 4, littleEndian: boolean): number | undefined;
+/** Reads UTF-8 bytes, removes trailing NUL padding, and preserves interior NUL separators. */
+export declare function readFitStringField(field: FitRawField | undefined): string | undefined;
+/**
+ * Strictly validates a FIT file and retains raw fields for selected messages.
+ * This entry point does not load the semantic FIT profile or format field values.
+ */
+export declare function readFitMessages(input: ArrayBuffer | Uint8Array, options?: FitMessageReaderOptions): FitMessageReaderResult;
+/** Converts a native FIT timestamp to a JavaScript epoch millisecond value. */
+export declare function fitTimestampToUnixMilliseconds(timestamp: number): number;