# goldencheck-types

> The shared canonical field-type registry for the Golden Suite: one source of
> truth for what a field type like `email` means (name hints, value signals,
> confidence thresholds), across every package and both languages.

## Install

```bash
pip install goldencheck-types
```

## Authoritative sources

Read these instead of inferring semantics from the type table:

- https://docs.bensevern.dev/docs/llms.txt -- index of every Golden Suite surface.
- https://github.com/benseverndev-oss/goldenmatch -- source, issues, and the
  decision records behind the vocabulary.

## What it is

`goldencheck` profiles a dataset and emits inferred field types; other packages
consume them. Producer: `goldencheck`. Consumers: `goldenpipe` (stage I/O
contracts), `infermap` (target-schema inference), and the TypeScript mirror
`goldencheck-types` over a JSON wire.

## Things that are decided, not incidental

- **This package is deliberately tiny and dependency-light.** The vocabulary is
  separated from the profiler so a consumer can depend on the type names without
  pulling in profiling machinery.
- **Its types are snake_case on BOTH languages**, unlike the rest of the
  TypeScript port, which is camelCase. These structures pass through YAML on the
  producer side and JSON on the consumer side with no remapping, so byte-identical
  cross-language shape beats per-language idiom. Do not "fix" the casing.
- **Changing a type's meaning is a cross-package, cross-language change.** The
  point of this registry is that `email` means the same thing everywhere.
