Hessen Way.js

// Variables used by Scriptable.
// These must be at the very top of the file. Do not edit.
// icon-color: blue; icon-glyph: subway; share-sheet-inputs: plain-text;
/* eslint-disable require-await */
/* eslint-disable no-undef */

// Version 1.1.0

// Instructions
//
// When running the widget for the first time you need to setup an access key from RMV.
// In case you don't have one request one here: https://opendata.rmv.de/site/anmeldeseite.html
// It might take a few hours for you to receive your key in the email. 
//
// When adding a widget to the screen add the station you are looking for as a parameter.
// You can get the station id by using https://www.rmv.de/hapi/location.name?format=json&accessId=<API_KEY>&input=<LOCATION>
// and replacing <API_KEY> by your key and <LOCATION> by the name of the station you are looking for.
// In the response look for the extId field.
// 
// More detailed instructions can be found here: https://github.com/Nahoot/HessenWay
//
// ANY CHANGE BELOW THIS POINT IS AT YOUR OWN RISK
// ---------------------------------------------------------

// Init constants

// Layout configuration
const widgetBackgroundColor = "#222222";
const widgetPadding = 10;
const titleTextSize = 14;
const bodyTextSize = 10;

const numberOfLines = { "small": 5, "medium": 10, "large": 24 };

// ---------------------------------------------------------

const small = "small"; medium = "medium"; large = "large";

const baseURL = 'https://www.rmv.de';
const departuresURL = '/hapi/departureBoard?lang=en&format=json&accessId=';

const rmvAccessKey = 'hessenway.rmv.api.key';

// Default station to look for.
// The station's id to be used when the script is run in the app.
// if it's executed from the widget it should be passed as parameter. 
// If it doesn't it will default to the value below
let extId = args.widgetParameter
if(extId == null)
  extId = "3000010" // Hauptbahnhof

// ---------------------------------------------------------
// Base functions

async function getRMVDepartures(departureStationCode){
  const result = {};

  const resp = await get({  
    url: baseURL + departuresURL + Keychain.get(rmvAccessKey) + '&extId=' + departureStationCode
  })
  result.origin = resp.Departure[0].stop;
  result.departures = resp.Departure;

  return result;
}

function getTransportationsSortedByTime(departures){
  let transports = [];
  departures.forEach(function(obj){
    //console.log(obj.name)
    const transport = {};

    // Get tranport type (bus, train, subway, etc..)
    transport.category = obj.Product[0].catOut.trim();
    // 2DO: Replace the text with the image directly
   
    // Get transport time. Always gets scheduled time. If the transport is delayed and there is "real time" use it instead
    // In the end turn the time string into a date object
    let time = obj.time;
    if ("rtTime" in obj){
      time = obj.rtTime
    }
    transport.time = formatTime(time);
    
    // Gets the line code (ex: S5, U3, RE70). Adds empty spaces for visualization in the table.
    // 2DO: Remove the spaces from here and move them to "printing" code
    transport.name = obj.name.trim().padEnd(6, String.fromCodePoint(0x2007)).padEnd(7, ' ')
   
    // Gets the transport's final destination
    transport.destination = obj.direction.trim();
    
    transports.push(transport);
  })
  return transports.sort(function (a, b){
    return a.time.getTime() - b.time.getTime();
  })
}

function printWidgetHeader(widget, origin, widgetSize = medium){
  if(widgetSize == small){
    if(origin.startsWith("Frankfurt (Main) ")){
      origin = origin.replace("Frankfurt (Main) ", '');
    }
  }
  let titleStack = widget.addStack()
  titleStack.centerAlignContent()
  titleStack.addSpacer()
  let titleText = titleStack.addText(origin)
  titleText.centerAlignText()
  titleText.font = Font.boldSystemFont(titleTextSize)
  titleText = Color.white()
  titleStack.addSpacer()
}

function printWidgetBody(widget, departures, widgetSize = medium){
  // console.log(departures)

  var BreakException = {}
  let resultNumber = numberOfLines[widgetSize];
  try {
    departures.forEach(function(obj){
      let entryStack = widget.addStack()
      entryStack.layoutHorizontally()
    
      let cat = obj.category;
      let img = SFSymbol.named("bus.fill")
      if (cat == "Tram")
        img = SFSymbol.named("tram.circle")
      if (cat == "S")
        img = SFSymbol.named("tram")
      if (cat == "RE")
        img = SFSymbol.named("tram.fill")
      img.applyThinWeight()
      // Make this work
      // const bus = entryStack.addImage(images[obj.category].applyThinWeight());
      const bus = entryStack.addImage(img.image)
      bus.tintColor = Color.white()
      bus.imageSize = new Size(bodyTextSize, bodyTextSize)
      bus.leftAlignImage()
      entryStack.addSpacer(10)
    
      let date = entryStack.addDate(obj.time)
      date.applyTimeStyle()
      date.font = Font.thinMonospacedSystemFont(bodyTextSize)
      entryStack.addSpacer(10)
    
      let train = entryStack.addText(obj.name);
      train.font = Font.thinMonospacedSystemFont(bodyTextSize)
      entryStack.addSpacer(10)
        
      // If the widget is small we change lines
      if(widgetSize == small){
        entryStack = widget.addStack();
        entryStack.addSpacer(20);
      }
      let direction = entryStack.addText(obj.destination)
      direction.font = Font.thinMonospacedSystemFont(bodyTextSize)
      entryStack.addSpacer()
      
      if (!--resultNumber)
        throw BreakException;
    }
    )
  } catch (e){
    if (e !== BreakException) throw e
  }
}

async function buildWidget(widget, departureStationCode, widgetSize){
  widget.setPadding(widgetPadding, widgetPadding, widgetPadding, widgetPadding)
  widget.backgroundColor = new Color(widgetBackgroundColor) 
    
  if(!Keychain.contains(rmvAccessKey)){
    // Generate Widget visualization    
    let titleText = widget.addText("The key was not found. Please follow the instructions to obtain a key from RMV and add it in the configuration.")
    titleText.centerAlignText()
    titleText.font = Font.boldSystemFont(titleTextSize)
    titleText.textColor = Color.red()    
  }else if(!departureStationCode){
    // Generate Widget visualization    
    let titleText = widget.addText("No parameter was given. Follow the instructions to configure a departure station.");
    titleText.centerAlignText()
    titleText.font = Font.boldSystemFont(titleTextSize)
    titleText.textColor = Color.red()
  }
  else {
    let result = await getRMVDepartures(departureStationCode);
    let transports = getTransportationsSortedByTime(result.departures);
    printWidgetHeader(widget, result.origin, widgetSize);
    printWidgetBody(widget, transports, widgetSize);
  }
}
// ---------------------------------------------------------

// Helper functions
function formatTime(sTime){
  const arrTime = sTime.split(':')
  let time = new Date()
  time.setHours(arrTime[0], arrTime[1], 0, 0)
  return time
}

async function get(opts) {
      const request = new Request(opts.url)
      request.headers = {
        ...opts.headers,
        ...this.defaultHeaders
      }
      var result=await request.loadJSON()
//       console.log(result)
      return result
}

async function promptForKey(){
  let alert = new Alert();
  alert.title = "API key";
  alert.message = "Paste below the API key you have received from RMV.";
  alert.addTextField("d9z9zz50-dd9d-459d-b0f8-d514e455d386");
  alert.addAction("OK");
  alert.addCancelAction("Cancel");
  alert.addDestructiveAction("Delete key!")
  let idx = await alert.present();
  if(idx == 0){
    Keychain.set(rmvAccessKey, alert.textFieldValue(0));
  }
  if(idx == 1){
    Keychain.remove(rmvAccessKey);
  }
}

async function showWidgetPreview(){
  let idx = 0;
  do{
    let alert = new Alert();
    alert.title = "Widget size";
    alert.addAction("Small");
    alert.addAction("Medium");
    alert.addAction("Large");
    alert.addCancelAction("Back");
    idx = await alert.present();
    switch(idx){
      case 0:
        widget = new ListWidget();
        await buildWidget(widget, extId, small);
        await widget.presentSmall();
        break;
      case 1:
        widget = new ListWidget();
        await buildWidget(widget, extId, medium);
        await widget.presentMedium();
        break;
      case 2:
        widget = new ListWidget();
        await buildWidget(widget, extId, large);
        await widget.presentLarge();
        break;
      default:
        break;
    }
  }while(idx != -1);
}

// ---------------------------------------------------------

if(config.runsInApp){
  let idx = 0;
  do{
    let alert = new Alert();
    alert.title = "Widget options";
    alert.addAction("Enter API key");
    alert.addAction("Show widget");
    //alert.addAction("Update widget");
    alert.addCancelAction("Exit menu");
    idx = await alert.present();
    switch(idx){
      case 0:
        await promptForKey();
        break;
      case 1:
        await showWidgetPreview();
        break;
      case 2:
        // 2DO: Update widget automatically
        break;
      default:
        break;
    }
  }while(idx != -1);
}
else{
  const widget = new ListWidget();
  await buildWidget(widget, args.widgetParameter, config.widgetFamily);  
  Script.setWidget(widget);
}

Script.complete();