arktypeio / arktype

TypeScript's 1:1 validator, optimized from editor to runtime
https://arktype.io/
MIT License
3.94k stars 60 forks source link

Investigate typed match expression #802

Open ssalbdivad opened 1 year ago

ssalbdivad commented 1 year ago

I often hear about devs using other languages missing match expressions. I'd need to do some investigation around common syntax and use cases, but I could imagine a thin layer around AT providing type-safe and configurable matching. Something like:

const parseValue = match({
    "uuid": (id) => id,
    "string>5": (s) => s.length,
    "number%2": (n) => n / 2,
    "default": false
})

// 32
console.log(parseValue(64))

// typed as Type<(In: string | number) => Out<number>>
const sizeOf = match({
    string: (s) => s.length,
    "integer>=0": (n) => n,
    // this message could be autogenerated from something like default: "throw"
    default: (v) => error(`${v} must be a string or non-negative integer.`)
})

//   6
const size = sizeOf("foobar")

Here's an example of how it could be used with a scope:

//  can you match, say { a: 1, m: 1 } and bind the properties a m to parameters
// or class C { c: number } and bind c to a parameter

class C {
    declare c: number
}

export const $ = scope({
    SomeObj: {
        a: "1",
        m: "1"
    },
    C: type("instanceof", C)
})

// getSum inferred as (value: {a: 1, m: 1} | C) => number
const getSum = $.match({
    // a, m inferred as 1
    SomeObj: ({ a, m }) => a + m,
    // c inferred as number
    C: ({ c }) => c,
    // could automatically generate a very specific default error messages describing the cases
    default: () => {
        throw new Error()
    }
})

Could use entry syntax for non string serializable types like objects and custom validators, and combine with transformations. It wouldn't really involve any new logic, the types would be very efficient and fully autocompleted. You could even define your own validation keywords and easily use them in your matcher keys.

It could also reuse all the type reduction + auto-discrimination functionality to error on impossible to hit cases and determine if any branches are a match in O(1) time for most unions.

ssalbdivad commented 1 year ago

Messed around with this a bit. Got completions working but only in expressions, and wasn't able to actually get the function inputs to infer. Likely will require similar workarounds to morph/narrow.

type validateCases<cases, $> = {
    -readonly [k in keyof cases as validateDefinition<k, $, {}>]: (
        In: inferTypeRoot<k, $>
    ) => unknown
}

export type MatchParser<$> = {
    <const cases>(def: conform<cases, validateCases<cases, $>>): Type<cases, $>
}

declare const match: MatchParser<Ark>

const sizeOf = match({
    number: (n) => n,
    "string|unknown[]": (data) => data.length
})
ssalbdivad commented 1 year ago

Updated the above example to provide the best completions possible while allowing inference (completions with an expression doesn't seem possible in keys right now):

type validateCases<cases, $> = {
    // adding keyof $ explicitly provides key completions for aliases
    [k in keyof cases | keyof $]?: k extends validateTypeRoot<k, $>
        ? (In: inferTypeRoot<k, $>) => unknown
        : never
}

export type MatchParser<$> = {
    <cases>(
        def: conform<cases, validateCases<cases, $>>
    ): Type<
        (In: inferTypeRoot<keyof cases, $>) => Out<returnOf<cases[keyof cases]>>,
        $
    >
}

export declare const match: MatchParser<Ark>