# jquense/yup architecture

> Architecture diagram of the GitHub repository jquense/yup, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jquense/yup
- Repository: https://github.com/jquense/yup

## Overview

Yup is a TypeScript runtime schema library: callers compose schemas, then cast or validate values to obtain parsed results or validation errors. The documented workflow spans schema construction, coercion/transforms, assertions (including asynchronous tests), and typed results; object schemas also validate nested fields, while conditions and references support interdependent rules. The graph preserves the major schema families, Standard Schema compatibility, localization and error reporting. Some implementation links rely on the SOURCE INDEX import references; unsampled details are not inferred.

Main entry points: [`src/index.ts`](https://github.com/jquense/yup/blob/master/src/index.ts) (Exports And Factories), [`src/schema.ts`](https://github.com/jquense/yup/blob/master/src/schema.ts) (Schema Core), [`src/ValidationError.ts`](https://github.com/jquense/yup/blob/master/src/ValidationError.ts) (Validation Errors), [`src/util/createValidation.ts`](https://github.com/jquense/yup/blob/master/src/util/createValidation.ts) (Test Runner)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Public API"]
  node_entry["Exports And Factories<br/>[index.ts]"]
end

subgraph group_engine["Schema Engine"]
  node_schema["Schema Core<br/>[schema.ts]"]
  node_condition["Conditional Rules<br/>[Condition.ts]"]
  node_reference["Value References<br/>[Reference.ts]"]
  node_testengine["Test Runner"]
  node_standard["Standard Schema<br/>[standardSchema.ts]"]
end

subgraph group_types["Schema Families"]
  node_mixed["Mixed Schema<br/>[mixed.ts]"]
  node_string["String Schema<br/>[string.ts]"]
  node_number["Number Schema<br/>[number.ts]"]
  node_boolean["Boolean Schema<br/>[boolean.ts]"]
  node_date["Date Schema<br/>[date.ts]"]
  node_object["Object Schema<br/>[object.ts]"]
  node_array["Array Schema<br/>[array.ts]"]
  node_tuple["Tuple Schema<br/>[tuple.ts]"]
  node_lazy["Lazy Schema<br/>[Lazy.ts]"]
end

subgraph group_support["Errors And Support"]
  node_errors["Validation Errors<br/>[ValidationError.ts]"]
  node_locale["Messages And Locale<br/>[locale.ts]"]
  node_localeconfig["Locale Configuration<br/>[setLocale.ts]"]
  node_typesystem["Type Inference<br/>[types.ts]"]
  node_reach["Nested Path Lookup<br/>[reach.ts]"]
end

node_caller(("Application"))

node_caller -->|"uses API"| node_entry
node_entry -->|"exports"| node_schema
node_entry -->|"exports"| node_mixed
node_entry -->|"exports"| node_string
node_entry -->|"exports"| node_number
node_entry -->|"exports"| node_boolean
node_entry -->|"exports"| node_date
node_entry -->|"exports"| node_object
node_entry -->|"exports"| node_array
node_entry -->|"exports"| node_tuple
node_entry -->|"exports"| node_lazy
node_entry -->|"exports"| node_reference
node_entry -->|"exports"| node_errors
node_entry -->|"exports"| node_reach
node_schema -->|"resolves conditions"| node_condition
node_schema -->|"resolves references"| node_reference
node_schema -->|"runs tests"| node_testengine
node_schema -->|"adapts validation"| node_standard
node_schema -->|"looks up paths"| node_reach
node_schema -->|"raises errors"| node_errors
node_testengine -->|"resolves values"| node_reference
node_testengine -->|"creates errors"| node_errors
node_condition -->|"reads dependencies"| node_reference
node_object -->|"extends core"| node_schema
node_object -->|"runs field tests"| node_testengine
node_array -->|"extends core"| node_schema
node_string -->|"extends core"| node_schema
node_number -->|"extends core"| node_schema
node_date -->|"extends core"| node_schema
node_boolean -->|"extends core"| node_schema
node_mixed -->|"extends core"| node_schema
node_tuple -->|"extends core"| node_schema
node_lazy -->|"resolves schemas"| node_schema
node_standard -->|"converts issues"| node_errors
node_locale -->|"formats messages"| node_errors
node_localeconfig -->|"sets messages"| node_locale
node_entry -->|"exports"| node_localeconfig
node_entry -->|"exports types"| node_typesystem

click node_entry "https://github.com/jquense/yup/blob/master/src/index.ts"
click node_schema "https://github.com/jquense/yup/blob/master/src/schema.ts"
click node_condition "https://github.com/jquense/yup/blob/master/src/Condition.ts"
click node_reference "https://github.com/jquense/yup/blob/master/src/Reference.ts"
click node_testengine "https://github.com/jquense/yup/blob/master/src/util/createValidation.ts"
click node_standard "https://github.com/jquense/yup/blob/master/src/standardSchema.ts"
click node_mixed "https://github.com/jquense/yup/blob/master/src/mixed.ts"
click node_string "https://github.com/jquense/yup/blob/master/src/string.ts"
click node_number "https://github.com/jquense/yup/blob/master/src/number.ts"
click node_boolean "https://github.com/jquense/yup/blob/master/src/boolean.ts"
click node_date "https://github.com/jquense/yup/blob/master/src/date.ts"
click node_object "https://github.com/jquense/yup/blob/master/src/object.ts"
click node_array "https://github.com/jquense/yup/blob/master/src/array.ts"
click node_tuple "https://github.com/jquense/yup/blob/master/src/tuple.ts"
click node_lazy "https://github.com/jquense/yup/blob/master/src/Lazy.ts"
click node_errors "https://github.com/jquense/yup/blob/master/src/ValidationError.ts"
click node_locale "https://github.com/jquense/yup/blob/master/src/locale.ts"
click node_localeconfig "https://github.com/jquense/yup/blob/master/src/setLocale.ts"
click node_typesystem "https://github.com/jquense/yup/blob/master/src/types.ts"
click node_reach "https://github.com/jquense/yup/blob/master/src/util/reach.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry toneBlue
class node_schema,node_condition,node_reference,node_testengine,node_standard toneAmber
class node_mixed,node_string,node_number,node_boolean,node_date,node_object,node_array,node_tuple,node_lazy toneMint
class node_errors,node_locale,node_localeconfig,node_typesystem,node_reach toneRose
class node_caller toneIndigo
```

## Components

### Public API

- [Exports And Factories](https://github.com/jquense/yup/blob/master/src/index.ts): `src/index.ts`

### Schema Engine

- [Schema Core](https://github.com/jquense/yup/blob/master/src/schema.ts): `src/schema.ts`
- [Conditional Rules](https://github.com/jquense/yup/blob/master/src/Condition.ts): `src/Condition.ts`
- [Value References](https://github.com/jquense/yup/blob/master/src/Reference.ts): `src/Reference.ts`
- [Test Runner](https://github.com/jquense/yup/blob/master/src/util/createValidation.ts): `src/util/createValidation.ts`
- [Standard Schema](https://github.com/jquense/yup/blob/master/src/standardSchema.ts): `src/standardSchema.ts`

### Schema Families

- [Mixed Schema](https://github.com/jquense/yup/blob/master/src/mixed.ts): `src/mixed.ts`
- [String Schema](https://github.com/jquense/yup/blob/master/src/string.ts): `src/string.ts`
- [Number Schema](https://github.com/jquense/yup/blob/master/src/number.ts): `src/number.ts`
- [Boolean Schema](https://github.com/jquense/yup/blob/master/src/boolean.ts): `src/boolean.ts`
- [Date Schema](https://github.com/jquense/yup/blob/master/src/date.ts): `src/date.ts`
- [Object Schema](https://github.com/jquense/yup/blob/master/src/object.ts): `src/object.ts`
- [Array Schema](https://github.com/jquense/yup/blob/master/src/array.ts): `src/array.ts`
- [Tuple Schema](https://github.com/jquense/yup/blob/master/src/tuple.ts): `src/tuple.ts`
- [Lazy Schema](https://github.com/jquense/yup/blob/master/src/Lazy.ts): `src/Lazy.ts`

### Errors And Support

- [Validation Errors](https://github.com/jquense/yup/blob/master/src/ValidationError.ts): `src/ValidationError.ts`
- [Messages And Locale](https://github.com/jquense/yup/blob/master/src/locale.ts): `src/locale.ts`
- [Locale Configuration](https://github.com/jquense/yup/blob/master/src/setLocale.ts): `src/setLocale.ts`
- [Type Inference](https://github.com/jquense/yup/blob/master/src/types.ts): `src/types.ts`
- [Nested Path Lookup](https://github.com/jquense/yup/blob/master/src/util/reach.ts): `src/util/reach.ts`

### Other components

- **Application**

## Connections

- Application → Exports And Factories: uses API (evidence: `README.md`)
- Exports And Factories → Schema Core: exports (evidence: `src/index.ts`)
- Exports And Factories → Mixed Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → String Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Number Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Boolean Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Date Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Object Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Array Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Tuple Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Lazy Schema: exports (evidence: `src/index.ts`)
- Exports And Factories → Value References: exports (evidence: `src/index.ts`)
- Exports And Factories → Validation Errors: exports (evidence: `src/index.ts`)
- Exports And Factories → Nested Path Lookup: exports (evidence: `src/index.ts`)
- Schema Core → Conditional Rules: resolves conditions (evidence: `src/schema.ts`)
- Schema Core → Value References: resolves references (evidence: `src/schema.ts`)
- Schema Core → Test Runner: runs tests (evidence: `src/schema.ts`)
- Schema Core → Standard Schema: adapts validation (evidence: `src/schema.ts`)
- Schema Core → Nested Path Lookup: looks up paths (evidence: `src/schema.ts`)
- Schema Core → Validation Errors: raises errors (evidence: `src/schema.ts`)
- Test Runner → Value References: resolves values (evidence: `src/util/createValidation.ts`)
- Test Runner → Validation Errors: creates errors (evidence: `src/util/createValidation.ts`)
- Conditional Rules → Value References: reads dependencies (evidence: `src/Condition.ts`)
- Object Schema → Schema Core: extends core (evidence: `src/object.ts`)
- Object Schema → Test Runner: runs field tests (evidence: `src/object.ts`)
- Array Schema → Schema Core: extends core (evidence: `src/array.ts`)
- String Schema → Schema Core: extends core (evidence: `src/string.ts`)
- Number Schema → Schema Core: extends core (evidence: `src/number.ts`)
- Date Schema → Schema Core: extends core (evidence: `src/date.ts`)
- Boolean Schema → Schema Core: extends core (evidence: `src/boolean.ts`)
- Mixed Schema → Schema Core: extends core (evidence: `src/mixed.ts`)
- Tuple Schema → Schema Core: extends core (evidence: `src/tuple.ts`)
- Lazy Schema → Schema Core: resolves schemas (evidence: `src/Lazy.ts`)
- Standard Schema → Validation Errors: converts issues (evidence: `src/standardSchema.ts`)
- Messages And Locale → Validation Errors: formats messages (evidence: `src/locale.ts`)
- Locale Configuration → Messages And Locale: sets messages (evidence: `src/setLocale.ts`)
- Exports And Factories → Locale Configuration: exports (evidence: `src/index.ts`)
- Exports And Factories → Type Inference: exports types (evidence: `src/index.ts`)
