@dpkit/ckan/resource/process/normalize.ts

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

import type { Resource } from "@dpkit/core"
import { getFilename } from "@dpkit/core"
import { normalizeCkanSchema } from "../../schema/index.js"
import type { CkanResource } from "../Resource.js"

/**
 * Normalizes a CKAN resource to Frictionless Data Resource format
 * @param props Object containing the CKAN resource to normalize
 * @returns Normalized Resource object
 */
export function normalizeCkanResource(ckanResource: CkanResource): Resource {
  const resource: Resource = {
    name: slugifyName(ckanResource.name),
    path: ckanResource.url,
    "ckan:key": getFilename(ckanResource.url),
    "ckan:url": ckanResource.url,
  }

  if (ckanResource.description) {
    resource.description = ckanResource.description
  }

  if (ckanResource.format) {
    // Format should be lowercase as per the reference
    resource.format = ckanResource.format.toLowerCase()
  }

  if (ckanResource.mimetype) {
    resource.mediatype = ckanResource.mimetype
  }

  if (ckanResource.size) {
    resource.bytes = ckanResource.size
  }

  if (ckanResource.hash) {
    resource.hash = ckanResource.hash
  }

  if (ckanResource.schema) {
    resource.type = "table"
    resource.schema = normalizeCkanSchema(ckanResource.schema)
  }

  return resource
}

// TODO: improve and move to core
function slugifyName(name: string): string {
  return (
    name
      // Replace spaces, dots, etc. with underscores
      .replace(/[\s\.\(\)\/\\,]+/g, "_")
      // Convert to lowercase
      .toLowerCase()
      // Remove any characters that aren't alphanumeric, underscore, or hyphen
      .replace(/[^a-z0-9_\-]/g, "")
      // Ensure it starts with a letter or underscore (not a number)
      .replace(/^(\d)/, "_$1")
      // Trim to reasonable length
      .slice(0, 100)
  )
}