Type operations don't preserve metadata

[smolattack]

Report a bug

🔎 Search Terms

custom error

🧩 Context

• ArkType version: 10.0.16.alpha
• TypeScript version (4.8, 4.9, or 5.0): 4.9
• Other context you think may be relevant (Node version, OS, etc.):

🧑‍💻 Repro

import { type, scope } from "arktype"

const emailValidations = scope({
    hasADomain: type(["string", "=>", (s) => s.includes("@")], {
        mustBe: "a valid email with a domain"
    }),
    domainIsValid: type(["string", "=>", (s) => s.endsWith(".com")], {
        mustBe: "a valid domain"
    }),
    all: "hasADomain&domainIsValid"
}).compile()

export const emailValidator = emailValidations.all

export const { data, problems } = emailValidator(
    "should give a list of defined errors"
)

console.log(problems?.summary ?? data)

console shows

'should give a list of defined errors' must be...
• valid
• valid

But I expect it to show

'should give a list of defined errors' must be...
• a valid email with a domain
• a valid domain

https://stackblitz.com/edit/arktype-bug-2d9kpj?devToolsHeight=33&file=demo.ts

[ssalbdivad]

Integrating external concerns like custom error messages with a type system is a really tricky problem, and the solution I came up with for alpha really missed the mark. I'd recommend adding the problems directly like this:

import { type, scope } from 'arktype';

const emailValidations = scope({
  hasADomain: type([
    'string',
    '=>',
    (s, problems) =>
      s.includes('@') || !problems.mustBe('a valid email with a domain'),
  ]),
  domainIsValid: type([
    'string',
    '=>',
    (s, problems) => s.endsWith('.com') || !problems.mustBe('a valid domain'),
  ]),
  all: 'hasADomain&domainIsValid',
}).compile();

export const email = emailValidations.all;

export const { data, problems } = email('should give a list of defined errors');

console.log(problems?.summary ?? data);

(on StackBlitz)

Aptly, I was actually working on metadata intersections on beta when you logged this issue. I'll update the title and use this issue to track that work getting merged and that when it does, your original definition will work as expected ⛵