@dpkit/core/schema/assert.spec.ts

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

import { describe, expect, expectTypeOf, it } from "vitest"
import { AssertionError } from "../error/index.ts"
import type { Schema } from "./Schema.ts"
import { assertSchema } from "./assert.ts"

describe("assertSchema", () => {
  it("returns typed schema when valid", async () => {
    const descriptor = {
      fields: [
        {
          name: "id",
          type: "integer",
        },
        {
          name: "name",
          type: "string",
        },
      ],
      primaryKey: ["id"],
    }

    const schema = await assertSchema(descriptor)

    expectTypeOf(schema).toEqualTypeOf<Schema>()
    expect(schema).toEqual(descriptor)
  })

  it("throws ValidationError when schema is invalid", async () => {
    const descriptor = {
      fields: [
        {
          name: "id",
          type: 123, // Should be a string
        },
      ],
    }

    await expect(assertSchema(descriptor)).rejects.toThrow(AssertionError)
  })
})