@dpkit/core/schema/save.ts

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

import { saveDescriptor } from "../general/index.ts"
import type { Schema } from "./Schema.ts"
import { denormalizeSchema } from "./process/denormalize.ts"

const CURRENT_PROFILE = "https://datapackage.org/profiles/2.0/tableschema.json"

/**
 * Save a Schema to a file path
 * Works in Node.js environments
 */
export async function saveSchema(
  schema: Schema,
  options: {
    path: string
  },
) {
  const descriptor = denormalizeSchema(schema)
  descriptor.$schema = descriptor.$schema ?? CURRENT_PROFILE

  await saveDescriptor(descriptor, { path: options.path })
}