node-flipr-client/src/index.ts

Node client for the Flipr Developper API

import debug from 'debug';
import fetch, { BodyInit, HeaderInit, Response } from 'node-fetch';
import { URLSearchParams } from 'url';

export interface FliprModule {
  ActivationKey: string;
  IsSuspended: string;
  Status: {
    Comment: string;
    DateTime: string;
    Status: string;
  };
  BatteryPlugDate: string;
  Comments: string;
  NoAlertUnil: string;
  Serial: string;
  PAC: string;
  ResetsCounter: string;
  SigfoxStatus: string;
  OffsetOrp: string;
  OffsetTemperature: string;
  OffsetPh: string;
  OffsetConductivite: string;
  IsForSpa: string;
  Version: string;
  LastMeasureDateTime: string;
  CommercialType: {
    Id: string;
    Value: string;
  };
  SubscribtionValidUntil: string;
  ModuleType_Id: string;
  Eco_Mode: string;
  EnableFliprFirmwareUpgrade: string;
  FliprFirmwareUpgradeAttempt: string;
  FliprFirmwareUpgradeStart: string;
  FliprFirmwareUpgradeEnd: string;
  BEflipr: string;
  IsSubscriptionValid: string;
}

interface FliprSurvey {
  MeasureId: number;
  Source: string;
  DateTime: string;
  Temperature: number;
  PH: {
    Label: string;
    Message: string;
    Deviation: number;
    Value: number;
    DeviationSector: string;
  };
  OxydoReductionPotentiel: {
    Label: string;
    Value: number;
  };
  Conductivity: {
    Label: string;
    Level: string;
  };
  UvIndex: number;
  Battery: {
    Label: string;
    Deviation: number;
  };
  Desinfectant: {
    Label: string;
    Message: string;
    Deviation: number;
    Value: number;
    DeviationSector: string;
  };
}

export default class FliprClient {
  declare access_token: string;

  debug = debug('node-flipr-client');
  origin = 'https://apis.goflipr.com';

  async authenticate(username, password): Promise<void> {
    const res = await this.post(
      '/OAuth2/token',
      new URLSearchParams({
        grant_type: 'password',
        username: username,
        password: password,
      }),
    );

    const json = await res.json();

    if (!res.ok) {
      throw `${res.status} ${res.statusText}: ${json.error} ${json.error_description}`;
    }

    this.access_token = json.access_token;
  }

  async request(
    method: 'GET' | 'POST',
    path,
    body?: BodyInit,
  ): Promise<Response> {
    let headers: HeaderInit = {};

    if (method === 'GET') {
      headers = {
        'Content-Type': 'application/json',
        Authorization: `Bearer ${this.access_token}`,
      };
    }

    if (method === 'POST') {
      headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
    }

    return await fetch(`${this.origin}/${path}`, {
      method,
      headers,
      body,
    });
  }

  async get(path: `/${string}`): Promise<Response> {
    return await this.request('GET', path);
  }

  async post(path, body: BodyInit): Promise<Response> {
    return await this.request('POST', path, body);
  }

  async modules(): Promise<FliprModule[]> {
    const fliprModulesResponse = await this.get('/modules');

    if (!fliprModulesResponse.ok) {
      this.debug('Could not fetch Flipr Modules', fliprModulesResponse);
      return [];
    }

    return await fliprModulesResponse.json();
  }

  async lastSurvey(serial: FliprModule['Serial']): Promise<FliprSurvey> {
    const res = await this.get(`/modules/${serial}/survey/last`);
    return await res.json();
  }
}