librelinkup-api-client/dist/types.d.ts

An unofficial API for Libre Link Up (glucose monitoring system/CGM)

export declare enum LibreLinkUpEndpoints {
    Login = "llu/auth/login",
    Country = "llu/config/country?country=DE",
    Connections = "llu/connections"
}
/**
 * @description A response from the Libre Link Up API.
 */
export interface LibreResponse {
    status: number;
    data?: Record<string, any>;
    error?: Record<string, any>;
}
/**
 * @description The successful login response from the Libre Link Up API.
 */
export interface LibreLoginResponse extends LibreResponse {
    data: {
        /**
         * @description The user object from the Libre Link Up API.
         */
        user: LibreUser;
        /**
         * @description The messages from the Libre Link Up API. Usually only the count of unread messages.
         */
        messages: LibreDataMessages;
        /**
         * @description The notifications from the Libre Link Up API. Usually only the count of unresolved notifications.
         */
        notifications: LibreNotifications;
        /**
         * @description The authentication ticket from the Libre Link Up API. The authentication token is stored here.
         */
        authTicket: LibreAuthTicket;
        invitations: string[] | null;
        trustedDeviceToken: string | "";
    };
}
/**
 * @description The redirect response from the Libre Link Up API. Usually happens when attempting to log in with the wrong region.
 */
export interface LibreRedirectResponse extends LibreResponse {
    data: {
        redirect: boolean;
        region: string;
    };
}
/**
 * @description An error response from the Libre Link Up API.
 */
export interface LibreErrorResponse extends LibreResponse {
    error: {
        message: string;
    };
}
export interface LibreConnectionResponse extends LibreResponse {
    status: number;
    data: {
        connection: LibreConnection;
        activeSensors: LibreActiveSensor[];
        graphData: RawGlucoseReading[];
    };
    ticket: Ticket;
}
export interface LibreLogbookResponse extends LibreResponse {
    status: number;
    data: RawGlucoseReading[];
    ticket: Ticket;
}
export interface LibreActiveSensor {
    sensor: LibreSensor;
    device: LibreDevice;
}
interface LibreDevice {
    did: string;
    dtid: number;
    v: string;
    ll: number;
    hl: number;
    u: number;
    fixedLowAlarmValues: LibreFixedLowAlarmValues;
    alarms: boolean;
}
interface LibreFixedLowAlarmValues {
    mgdl: number;
    mmoll: number;
}
interface LibreSensor {
    deviceId: string;
    sn: string;
    a: number;
    w: number;
    pt: number;
}
/**
 * @description A connection object from the Libre Link Up API.
 */
export interface LibreConnection {
    id: string;
    patientId: string;
    country: string;
    status: number;
    firstName: string;
    lastName: string;
    targetLow: number;
    targetHigh: number;
    uom: number;
    sensor: LibreSensor;
    alarmRules: LibreAlarmRules;
    glucoseMeasurement: RawGlucoseReading;
    glucoseItem: RawGlucoseReading;
    glucoseAlarm: null;
    patientDevice: LibreDevice;
    created: number;
}
/**
 * @description A user object from the Libre Link Up API.
 */
export interface LibreUser {
    id: string;
    firstName: string;
    lastName: string;
    email: string;
    dateOfBirth: Date;
    /** Country of the user in alpha-2 format. eg. PL, DE, GB etc. */
    country: string;
    /** The language of the user interface in culture code format. eg. en-GB, de-DE, pl-PL etc. */
    uiLanguage: string;
    /** The language the system uses to communicate with the user (?) in culture code format. eg. en-GB, de-DE, pl-PL etc. */
    communicationLanguage: string;
    /** The account type of the user. For patient it's 'pat'. */
    accountType: string;
    created: Date;
    lastLogin: Date;
    uom: string;
    dateFormat: string;
    timeFormat: string;
    emailDay: number[];
    system: LibreSystem;
    details: Record<string, any>;
    programs: Record<string, any>;
    /** The practices that can access the user's data. */
    practices: Record<string, LibrePractice>;
    /** The devices that the user has connected to the account. */
    devices: Record<string, LibreDevice>;
    consents: LibreConsents;
}
interface LibreAuthTicket {
    token: string;
    expires: number;
    duration: number;
}
interface LibreDataMessages {
    unread: number;
}
interface LibreNotifications {
    unresolved: number;
}
interface LibreConsents {
    llu?: Llu;
    realWorldEvidence: RealWorldEvidence;
}
interface Llu {
    policyAccept: number;
    touAccept: number;
}
interface RealWorldEvidence {
    policyAccept: number;
    touAccept: number;
    history: {
        policyAccept: number;
        declined?: boolean;
    }[];
}
interface LibreSystem {
    messages: LibreSystemMessages;
}
interface LibreSystemMessages {
    appReviewBanner: number;
    firstUsePhoenix: number;
    firstUsePhoenixReportsDataMerged: number;
    lluGettingStartedBanner: number;
    lluNewFeatureModal: number;
    lluOnboarding?: number;
    lvWebPostRelease: string;
    streamingTourMandatory: number;
}
/** The practice facility that can access the user's data. */
interface LibrePractice {
    id: string;
    practiceId: string;
    name: string;
    address1: string;
    city: string;
    state: string;
    zip: string;
    phoneNumber: string;
    records: null;
}
interface LibreDevice {
    id: string;
    nickname: string;
    sn: string;
    type: number;
    uploadDate: number;
}
interface LibreAlarmRules {
    c: boolean;
    h: H;
    f: F;
    l: F;
    nd: Nd;
    p: number;
    r: number;
    std: Std;
}
interface F {
    th: number;
    thmm: number;
    d: number;
    tl: number;
    tlmm: number;
    on?: boolean;
}
interface H {
    on: boolean;
    th: number;
    thmm: number;
    d: number;
    f: number;
}
interface Nd {
    i: number;
    r: number;
    l: number;
}
interface Std {
}
export interface RawGlucoseReading {
    FactoryTimestamp: string;
    Timestamp: string;
    type: number;
    ValueInMgPerDl: number;
    TrendArrow?: number;
    TrendMessage?: null;
    MeasurementColor: number;
    GlucoseUnits: number;
    Value: number;
    isHigh: boolean;
    isLow: boolean;
}
export interface GlucoseReading {
    timestamp: Date;
    value: number;
    measurementColor: MeasurementColor;
    isHigh: boolean;
    isLow: boolean;
}
interface Ticket {
    token: string;
    expires: number;
    duration: number;
}
export declare enum MeasurementColor {
    Red = 0,
    Green = 1,
    Yellow = 2,
    Orange = 3
}
export type TrendType = "NotComputable" | "SingleDown" | "FortyFiveDown" | "Flat" | "FortyFiveUp" | "SingleUp";
export declare enum Trend {
    'NotComputable' = 0,
    'SingleDown' = 1,
    'FortyFiveDown' = 2,
    'Flat' = 3,
    'FortyFiveUp' = 4,
    'SingleUp' = 5
}
export {};
/**
 * Attribution for the types.
 * @description The types were borrowed from the DiaKEM libre-link-up-api-client project.
 * @see {@link https://github.com/DiaKEM/libre-link-up-api-client/tree/main/src/types}
 * License: MIT License (https://github.com/DiaKEM/libre-link-up-api-client/blob/main/LICENSE)
 */