display_information.ts

import { type Summary, isSummary } from './summary.js'
import { type DataExample, isDataExample } from './data_example.js'

export interface DisplayInformation {
  taskTitle: string
  summary: Summary
  dataFormatInformation?: string
  // TODO merge dataExample
  dataExampleText?: string
  model?: string
  // TODO no need for undefined
  dataExample?: DataExample[]
  // TODO no need for undefined
  headers?: string[]
  // Displays the image at this URL in the UI as an example when connecting data
  dataExampleImage?: string
  // URL to download a dataset for the task, is displayed in the UI when asking to connect data
  sampleDatasetLink?: string
  // Instructions to download, unzip, and connect the right file of the sample dataset
  sampleDatasetInstructions?: string
}

export function isDisplayInformation (raw: unknown): raw is DisplayInformation {
  if (typeof raw !== 'object' || raw === null) {
    return false
  }

  const {
    dataExample,
    dataExampleImage,
    dataExampleText,
    dataFormatInformation,
    sampleDatasetLink,
    sampleDatasetInstructions,
    headers,
    model,
    summary,
    taskTitle,
  }: Partial<Record<keyof DisplayInformation, unknown>> = raw

  if (
    typeof taskTitle !== 'string' ||
    (dataExampleText !== undefined && typeof dataExampleText !== 'string') ||
    (sampleDatasetLink !== undefined && typeof sampleDatasetLink !== 'string') ||
    (dataFormatInformation !== undefined && typeof dataFormatInformation !== 'string') ||
    (model !== undefined && typeof model !== 'string') ||
    (dataExampleImage !== undefined && typeof dataExampleImage !== 'string') ||
    (sampleDatasetInstructions !== undefined && typeof sampleDatasetInstructions !== 'string')
  ) {
    return false
  }

  if (!isSummary(summary)) {
    return false
  }
  if (sampleDatasetLink !== undefined) {
    try {
      new URL(sampleDatasetLink)
    } catch {
      return false
    }
  }
  if (dataExampleImage !== undefined) {
    try {
      new URL(dataExampleImage)
    } catch {
      return false
    }
  }

  if (
    dataExample !== undefined && !(
      Array.isArray(dataExample) &&
      dataExample.every(isDataExample))
  ) {
    return false
  }
  if (
    headers !== undefined && !(
      Array.isArray(headers) &&
      headers.every((e) => typeof e === 'string'))
  ) {
    return false
  }

  const repack = {
    dataExample,
    dataExampleImage,
    dataExampleText,
    dataFormatInformation,
    sampleDatasetLink,
    sampleDatasetInstructions,
    headers,
    model,
    summary,
    taskTitle,
  }
  const _correct: DisplayInformation = repack
  const _total: Record<keyof DisplayInformation, unknown> = repack

  return true
}