@garmin/fitsdk 21.202.0 → 21.205.0

package/src/types/profile.d.ts

@@ -0,0 +1,96 @@
+/////////////////////////////////////////////////////////////////////////////////////////////
+// Copyright 2026 Garmin International, Inc.
+// Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
+// may not use this file except in compliance with the Flexible and Interoperable Data
+// Transfer (FIT) Protocol License.
+/////////////////////////////////////////////////////////////////////////////////////////////
+// ****WARNING****  This file is auto-generated!  Do NOT edit this file.
+// Profile Version = 21.205.0Release
+// Tag = production/release/21.205.0-0-gb3c261eb
+/////////////////////////////////////////////////////////////////////////////////////////////
+
+
+export type FitBaseTypeString =
+    | 'enum'
+    | 'byte'
+    | 'sint8'
+    | 'uint8'
+    | 'uint8z'
+    | 'sint16'
+    | 'uint16'
+    | 'uint16z'
+    | 'sint32'
+    | 'uint32'
+    | 'uint32z'
+    | 'sint64'
+    | 'uint64'
+    | 'uint64z'
+    | 'float64'
+    | 'float32'
+    | 'string';
+
+/** A reference mapping a subfield's activation value to its controlling field name */
+export interface SubFieldMap {
+    name: string;
+    value: number;
+}
+
+/** A subfield that is active when a controlling field matches a specific value */
+export interface ProfileSubField {
+    name: string;
+    type: string;
+    baseType: FitBaseTypeString;
+    scale: number | number[];
+    offset: number | number[];
+    units: string | string[];
+    bits: number[];
+    components: string[];
+    hasComponents: boolean;
+    map: SubFieldMap[];
+}
+
+/** A field definition within a profile message */
+export interface ProfileField {
+    num: number;
+    name: string;
+    type: string;
+    baseType: FitBaseTypeString;
+    array: boolean;
+    scale: number | number[];
+    offset: number | number[];
+    units: string | string[];
+    bits: number[];
+    components: string[];
+    isAccumulated: boolean;
+    hasComponents: boolean;
+    subFields: ProfileSubField[];
+}
+
+/** A message definition from the FIT profile */
+export interface ProfileMesg {
+    num: number;
+    name: string;
+    messagesKey: string;
+    fields: Record<number, ProfileField>;
+}
+
+export declare const Profile: {
+    /** The FIT profile version */
+    readonly version: {
+        major: number;
+        minor: number;
+        patch: number;
+        type: string;
+    };
+    readonly CommonFields: {
+        readonly PartIndex: number;
+        readonly Timestamp: number;
+        readonly MessageIndex: number;
+    };
+    /** All profile messages keyed by message number */
+    readonly messages: Record<number, ProfileMesg>;
+    /** All profile types keyed by type name, then value */
+    readonly types: Record<string, Record<number, string>>;
+    /** Message number constants keyed by message name */
+    readonly MesgNum: Record<string, number>;
+};

package/src/types/stream.d.ts

@@ -0,0 +1,118 @@
+/////////////////////////////////////////////////////////////////////////////////////////////
+// Copyright 2026 Garmin International, Inc.
+// Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
+// may not use this file except in compliance with the Flexible and Interoperable Data
+// Transfer (FIT) Protocol License.
+/////////////////////////////////////////////////////////////////////////////////////////////
+// ****WARNING****  This file is auto-generated!  Do NOT edit this file.
+// Profile Version = 21.205.0Release
+// Tag = production/release/21.205.0-0-gb3c261eb
+/////////////////////////////////////////////////////////////////////////////////////////////
+
+
+import { CrcCalculator } from "./crc-calculator";
+import { FieldValue } from "./mesg";
+
+/** Represents a FIT file's bytes and provides sequential read access. */
+export class Stream {
+    /**
+     * Creates a Stream containing a FIT file.
+     * @param buffer - `ArrayBuffer` containing the FIT file bytes.
+     */
+    constructor(buffer: ArrayBuffer);
+
+    /**
+     * Convenience method for creating a Stream from a byte array.
+     * @param data - An array of bytes or a `Uint8Array`.
+     * @returns A new Stream object.
+     */
+    static fromByteArray(data: number[] | Uint8Array): Stream;
+
+    /**
+     * Convenience method for creating a Stream from a Node Buffer.
+     * @param buffer - Node `Buffer` of bytes.
+     * @returns A new Stream object.
+     */
+    static fromBuffer(buffer: Uint8Array): Stream;
+
+    /**
+     * Convenience method for creating a Stream from an `ArrayBuffer`.
+     * @param buffer - An `ArrayBuffer` of bytes.
+     * @returns A new Stream object.
+     */
+    static fromArrayBuffer(buffer: ArrayBuffer): Stream;
+
+    /** Total length of the underlying buffer in bytes. */
+    readonly length: number;
+    /** Number of bytes read. */
+    readonly bytesRead: number;
+    /** Current read position. */
+    readonly position: number;
+    /** CRC calculator, updated as bytes are read. */
+    crcCalculator: CrcCalculator;
+
+    /** Resets the read position to 0. */
+    reset(): void;
+    /**
+     * Seeks to an absolute byte offset.
+     * @param position - Byte offset to seek to.
+     */
+    seek(position: number): void;
+    /**
+     * Returns a copy of the underlying buffer for the given range.
+     * @param begin - Start index (inclusive).
+     * @param end - End index (exclusive).
+     */
+    slice(begin: number, end: number): ArrayBuffer;
+    /** Returns the byte at the current position without advancing. */
+    peekByte(): number;
+    /** Reads and returns one byte. */
+    readByte(): number;
+    /**
+     * Reads `size` bytes and returns them as a `Uint8Array`.
+     * @param size - Number of bytes to read.
+     */
+    readBytes(size: number): Uint8Array;
+
+    /**
+     * Reads a value of the given FIT base type from the stream.
+     * @param baseType - FIT base type constant.
+     * @param size - Number of bytes to read.
+     * @param opts - Read options.
+     */
+    readValue(baseType: number, size: number, opts?: ReadValueOptions): FieldValue;
+
+    /** Reads an unsigned 8-bit integer. */
+    readUInt8(opts?: ReadValueOptions): number;
+    /** Reads a signed 8-bit integer. */
+    readInt8(opts?: ReadValueOptions): number;
+    /** Reads an unsigned 16-bit integer. */
+    readUInt16(opts?: ReadValueOptions): number;
+    /** Reads a signed 16-bit integer. */
+    readInt16(opts?: ReadValueOptions): number;
+    /** Reads an unsigned 32-bit integer. */
+    readUInt32(opts?: ReadValueOptions): number;
+    /** Reads a signed 32-bit integer. */
+    readInt32(opts?: ReadValueOptions): number;
+    /** Reads an unsigned 64-bit integer as a `bigint`. */
+    readUInt64(opts?: ReadValueOptions): bigint;
+    /** Reads a signed 64-bit integer as a `bigint`. */
+    readInt64(opts?: ReadValueOptions): bigint;
+    /** Reads a 32-bit IEEE 754 float. */
+    readFloat32(opts?: ReadValueOptions): number;
+    /** Reads a 64-bit IEEE 754 float. */
+    readFloat64(opts?: ReadValueOptions): number;
+    /**
+     * Reads a null-terminated UTF-8 string of up to `strlen` bytes.
+     * @param strlen - Maximum number of bytes to read.
+     */
+    readString(strlen: number): string;
+}
+
+/** Options shared by the typed read methods on {@link Stream}. */
+export type ReadValueOptions = {
+    /** Byte order for this read. Defaults to `true`. */
+    littleEndian?: boolean;
+    /** When `true`, invalid values are returned as `null`. Defaults to `true`. */
+    convertInvalidToNull?: boolean;
+}