@seasketch/geoprocessing/scripts/base/datasources/precalc.ts

Geoprocessing and reporting framework for SeaSketch 2.0

import { precalcConfig } from "../../../src/precalc/config.js";
import { Metric } from "../../../src/types/index.js";
import { readMetrics, writeMetrics, createOrUpdateMetrics } from "./metrics.js";

// Extends metrics datasource

/**
 * Reads metrics from disk, validates them
 * If metrics file not exist then start a new one and ensure directory exists
 */
export function readPrecalcMetrics(filePath?: string) {
  // Optional override
  const finalFilePath =
    filePath && filePath.length > 0 ? filePath : precalcConfig.defaultSrcPath;

  return readMetrics(finalFilePath);
}

/**
 * Writes metrics to disk, sorted and rekeyed for consistent ordering
 */
export function writePrecalcMetrics(metrics: Metric[], filePath?: string) {
  const finalFilePath =
    filePath && filePath.length > 0 ? filePath : precalcConfig.defaultSrcPath;
  return writeMetrics(metrics, finalFilePath);
}

/** Creates or updates metrics on disk */
export async function createOrUpdatePrecalcMetrics(
  metrics: Metric[],
  options: {
    matcher?: (m: Metric) => boolean;
    filePath?: string;
  } = {},
): Promise<Metric[]> {
  // Optional override
  const { matcher, filePath } = options;
  const finalFilePath =
    filePath && filePath.length > 0 ? filePath : precalcConfig.defaultSrcPath;
  return createOrUpdateMetrics(metrics, matcher, finalFilePath);
}