data.ts

import type { FeatureCollection } from "geojson";
import { setPrecision } from "lib/maplibre";
import readXlsxFile from "read-excel-file";
import type { FeatureUnion, SchemeCollection, SchemeData } from "types";

// Takes a GeoJSON file representing a bunch of scheme files combined into one.
// Modifies this GeoJSON in-place, and returns a dictionary of Schemes, keyed
// (and ordered) by scheme_reference. Each feature (intervention) in the GJ
// links back to one of these schemes by scheme_reference.
export function processInput(gj: SchemeCollection): Map<string, SchemeData> {
  let schemes = new Map();

  // Assume the input has a top-level dictionary keyed by scheme_reference
  for (let [scheme_reference, scheme] of Object.entries(gj.schemes)) {
    schemes.set(scheme_reference, scheme);
  }

  gj.features = gj.features.filter((f) => keepFeature(f));

  let id = 1;
  for (let feature of gj.features) {
    let scheme: SchemeData = schemes.get(feature.properties!.scheme_reference);
    if (scheme.browse) {
      scheme.browse.num_features =
        scheme.browse.num_features !== undefined
          ? scheme.browse.num_features + 1
          : 1;

      // TODO For easy styling, copy one field from scheme to all its features.
      // As we have more cases like this, revisit what's most performant.
      // @ts-ignore Extend InterventionProps with scheme_reference, current_milestone, and this
      feature.properties!.funding_programme = scheme.browse.funding_programme;
      // @ts-ignore Same
      feature.properties!.current_milestone = scheme.browse.current_milestone;
      // Force numeric IDs (skipping 0) for hovering to work
      feature.id = id++;
    }
  }

  return schemes;
}

// These should ideally be fixed during upstream data validation processes.
function keepFeature(feature: FeatureUnion): boolean {
  // Manually filter out some large areas that describe a boundary or
  // non-specific location of interventions. They make it harder to
  // interact with smaller, more specific interventions.
  let hugeAreas = [
    "eb0ad8ed183c137da4bae66afa944da9",
    "0a568f07241be96f0a70aa73a0de80c8",
    "6c4a5d57176eaeb3296eba790f869909",
    "475e9a43749ce09c7edaaffa0ae57a2f",
    "117b783cb2916a1bb4262960e523acc5",
    "7a600e6342b226aa0983c8dfed19254f",
    "84cc5eb1b52a4e49188058373e587ff0",
  ];

  // @ts-ignore The id field is present in the current input data, but it's not
  // part of our intended schema or used elsewhere, so InterventionProps
  // deliberately does not include it. Only use it here.
  if (hugeAreas.includes(feature.properties.id)) {
    return false;
  }

  return true;
}

interface CriticalRow {
  id: string;
  inspector: string;
  submission_time: Date;
  scheme_reference: string;
  current_design_stage: string;
  critical_type: string;
  lat_lon: string;
  location_description: string;
  notes: string;
}

// Returns a FeatureCollection of points. The properties are described by
// CriticalRow (with the exception that submission_time is already formatted as
// a string).
export async function parseCriticalIssuesExcel(
  input: File
): Promise<FeatureCollection> {
  let mapping = {
    ID: "id",
    Inspector: "inspector",
    "Submission Time": "submission_time",
    "Please enter the Scheme Reference number, (e.g. ATF2_WYO_01)":
      "scheme_reference",
    "Please enter current Design Stage": "current_design_stage",
    "Select Critical Issue type below:": "critical_type",
    "Please Enter Latitude and Longitude \n(Right click on location in Google, left click on information to copy to clipboard, paste below)":
      "lat_lon",
    Column1: "location_description",
    "Enter any additional information (e.g. any comments or notes about this critical issue)":
      "notes",
  };

  let { rows } = await readXlsxFile(input, {
    map: mapping,
    sheet: "Form Input",
  });

  let gj: FeatureCollection = {
    type: "FeatureCollection",
    features: [],
  };
  for (let row of rows as CriticalRow[]) {
    let coordinates = setPrecision(
      row.lat_lon.split(",").map(parseFloat).reverse()
    );
    let properties: { [name: string]: any } = row;
    properties.submission_time = row.submission_time.toLocaleString();
    gj.features.push({
      type: "Feature",
      properties,
      geometry: {
        type: "Point",
        coordinates,
      },
      id: gj.features.length + 1,
    });
  }
  return gj;
}