@dpkit/core/package/validate.ts

Fast TypeScript data management framework built on top of the Data Package standard and Polars DataFrames

import { type Descriptor, validateDescriptor } from "../general/index.js"
import { loadProfile } from "../general/index.js"
import type { Package } from "./Package.js"
import { normalizePackage } from "./process/normalize.js"

const DEFAULT_PROFILE = "https://datapackage.org/profiles/1.0/datapackage.json"

/**
 * Validate a Package descriptor (JSON Object) against its profile
 */
export async function validatePackageDescriptor(
  descriptorOrPackage: Descriptor | Package,
  options?: {
    basepath?: string
  },
) {
  const descriptor = descriptorOrPackage as Descriptor

  const $schema =
    typeof descriptor.$schema === "string"
      ? descriptor.$schema
      : DEFAULT_PROFILE

  const profile = await loadProfile($schema)
  const { valid, errors } = await validateDescriptor(descriptor, { profile })

  let dataPackage: Package | undefined = undefined
  if (valid) {
    // Validation + normalization = we can cast it
    dataPackage = normalizePackage(descriptor, {
      basepath: options?.basepath,
    }) as unknown as Package
  }

  return { valid, errors, dataPackage }
}