Topics

arktype•6mo ago

Usage for HTTP validation

I'm looking to use Arktype as a Request/Response validator This comes with the following requirements: - Request body should be validated with deep reject unknownKeys so invalid requests are immediately 422 - Response should be validated with deep delete unknownKeys so local information can't passthrough - Response input should be cloned rather then inline-morphed (including key deletion) so you can pass in input objects as-is

let User = type({ name: string, meta: { bio: 'string' } })
let CreateUser = type([ User, '&', { password: string, meta: { age: 'number' } } ])
let UserModel = type([ CreateUser, '&', { meta: { isAdult: 'boolean' } } ])

let oneUser: UserModel;
function addUser(user: CreateUser) {
   // should throw on inputs with extra keys on user and on user.meta
   let newUser = AT_asHttpIn(CreateUser).assert(user)
   newUser.meta.isAdult = newUser.meta.age >= 18 
   oneUser = AT_strict(UserModel).assert(newUser)
}
function getUser() {
   // should remove password and age
   // should not remove them on actual data
   return AT_asHttpOut(User).assert(oneUser)
}

let User = type({ name: string, meta: { bio: 'string' } })
let CreateUser = type([ User, '&', { password: string, meta: { age: 'number' } } ])
let UserModel = type([ CreateUser, '&', { meta: { isAdult: 'boolean' } } ])

let oneUser: UserModel;
function addUser(user: CreateUser) {
   // should throw on inputs with extra keys on user and on user.meta
   let newUser = AT_asHttpIn(CreateUser).assert(user)
   newUser.meta.isAdult = newUser.meta.age >= 18 
   oneUser = AT_strict(UserModel).assert(newUser)
}
function getUser() {
   // should remove password and age
   // should not remove them on actual data
   return AT_asHttpOut(User).assert(oneUser)
}

Please list recommended AT APIs for this Please link the related undone issues is any

36 Replies

Unknown User•6mo ago

Message Not Public

Sign In & Join Server To View

DimavaOP•6mo ago

Well, it's either 400 or 422, and if you want to 400 for whatever else it's 422 Github uses 422 Validation failed As I understood it's history, 422 did mean "you sent valid XML but its contents is 💩" So 400 is more or JSON.parse failure then validation failure @ssalbdivad ping

ssalbdivad•6mo ago

I've already answered this haven't I?

DimavaOP•6mo ago

ah, it's still sumday, nevermind

ssalbdivad•6mo ago

I am working today Oh Maybe you meant the m

DimavaOP•6mo ago

I've made this #questions so I don't ever ask it again

ssalbdivad•6mo ago

Actually I added a deep param for onUndeclaredKey I still can't configure it at a scope level yet that's tricky and kinda what I'm working on now Have to be very careful with caching across scopes

DimavaOP•6mo ago

So, I'd like to have a unit test for this So please list what functions I need and I'll try to make one

ssalbdivad•6mo ago

If you want to fuck around with stuff though which you generally do maybe you should look at the transform API on t.raw (t.internal on the next release).

DimavaOP•6mo ago

Hmm What that does?

ssalbdivad•6mo ago

Deeply transforms type nodes

DimavaOP•6mo ago

Ah

ssalbdivad•6mo ago

Here's how I use it to configure description at multkple levels:

    configureShallowDescendants(configOrDescription: BaseMeta | string): this {
        const config: BaseMeta =
            typeof configOrDescription === "string" ?
                { description: configOrDescription }
            :    (configOrDescription as never)
        return this.transform((kind, inner) => ({ ...inner, ...config }), {
            shouldTransform: node => node.kind !== "structure"
        }) as never
    }

    configureShallowDescendants(configOrDescription: BaseMeta | string): this {
        const config: BaseMeta =
            typeof configOrDescription === "string" ?
                { description: configOrDescription }
            :    (configOrDescription as never)
        return this.transform((kind, inner) => ({ ...inner, ...config }), {
            shouldTransform: node => node.kind !== "structure"
        }) as never
    }

Here's the new onUndeclaredKey implementation:

    onUndeclaredKey(cfg: UndeclaredKeyBehavior | UndeclaredKeyConfig): BaseRoot {
        const rule = typeof cfg === "string" ? cfg : cfg.rule
        const deep = typeof cfg === "string" ? false : cfg.deep
        return this.transform(
            (kind, inner) =>
                kind === "structure" ?
                    rule === "ignore" ?
                        omit(inner as StructureInner, { undeclared: 1 })
                    :    { ...inner, undeclared: rule }
                :    inner,
            deep ? undefined : (
                { shouldTransform: node => !includes(structuralKinds, node.kind) }
            )
        )
    }

    onUndeclaredKey(cfg: UndeclaredKeyBehavior | UndeclaredKeyConfig): BaseRoot {
        const rule = typeof cfg === "string" ? cfg : cfg.rule
        const deep = typeof cfg === "string" ? false : cfg.deep
        return this.transform(
            (kind, inner) =>
                kind === "structure" ?
                    rule === "ignore" ?
                        omit(inner as StructureInner, { undeclared: 1 })
                    :    { ...inner, undeclared: rule }
                :    inner,
            deep ? undefined : (
                { shouldTransform: node => !includes(structuralKinds, node.kind) }
            )
        )
    }

You'd have to learn a bit about the different node kinds to use this effectively but it is very powerful for this sort of thing What are the cases you are referring to?

DimavaOP•6mo ago

Validation of untrusted input and serialization of untrimmed output? Using exact same input Type A la Zod's default behaviour I guess (is it? I didn't really use zod) Or what are you asking

ssalbdivad•6mo ago

So, I'd like to have a unit test for this So please list what functions I need and I'll try to make one

What are you asking for the names of the APIs?

DimavaOP•6mo ago

Yep, what API should I point my eyes to

ssalbdivad•6mo ago

There is no builtin for cloning universally before morphs yet. You can pipe to {...o} or whatever clone fn you want easily enough I guess but it would be a nice convenience to have it as a scope option You could probably contribute that feature quite easily if you want

DimavaOP•6mo ago

🤔

ssalbdivad•6mo ago

I mean think about how trivial it is It's just a tiny wrapper And an if check

DimavaOP•6mo ago

Ok I can just use a copy-on-write Proxy 🤔 Can I?

ssalbdivad•6mo ago

No proxies too slow For the input data? or are you talking about an internal solution? I would just use an if check haha

DimavaOP•6mo ago

So I can Okay For input I guess deep reject is enough For the output Hmm

ssalbdivad•6mo ago

I mean input and output are both just types at the ends of morphs

DimavaOP•6mo ago

Nah I mean like Request and Response data

ssalbdivad•6mo ago

Hmm response validation seems weird but I know that's a thing I guess

DimavaOP•6mo ago

That's not really a validation, it's more of serialization Like a custom toJson that picks only needed stuff

ssalbdivad•6mo ago

How does validation really help with that Seems like just object utility methods

DimavaOP•6mo ago

let oneUser: { name: string, password: string };
function getUser() {
   // should remove password
   // should not remove them on actual data
   return AT_asHttpOut(type({name: 'string'})).assert(oneUser)
}

let oneUser: { name: string, password: string };
function getUser() {
   // should remove password
   // should not remove them on actual data
   return AT_asHttpOut(type({name: 'string'})).assert(oneUser)
}

By allowing to throw in any 💩 Maybe not the greatest idea but I want a working prototype

ssalbdivad•6mo ago

export type show<t> = { [k in keyof t]: t[k] } & unknown

export type keySetOf<o> = { [k in keyof o]?: 1 }

export const splitByKeys = <o extends object, leftKeys extends keySetOf<o>>(
    o: o,
    leftKeys: leftKeys
): [
    show<Pick<o, keyof leftKeys & keyof o>>,
    show<Omit<o, keyof leftKeys & keyof o>>
] => {
    const l: any = {}
    const r: any = {}
    let k: keyof o
    for (k in o) {
        if (k in leftKeys) l[k] = o[k]
        else r[k] = o[k]
    }
    return [l, r]
}

export const pick = <o extends object, keys extends keySetOf<o>>(
    o: o,
    keys: keys
): show<Pick<o, keyof keys & keyof o>> => splitByKeys(o, keys)[0] as never

export type show<t> = { [k in keyof t]: t[k] } & unknown

export type keySetOf<o> = { [k in keyof o]?: 1 }

export const splitByKeys = <o extends object, leftKeys extends keySetOf<o>>(
    o: o,
    leftKeys: leftKeys
): [
    show<Pick<o, keyof leftKeys & keyof o>>,
    show<Omit<o, keyof leftKeys & keyof o>>
] => {
    const l: any = {}
    const r: any = {}
    let k: keyof o
    for (k in o) {
        if (k in leftKeys) l[k] = o[k]
        else r[k] = o[k]
    }
    return [l, r]
}

export const pick = <o extends object, keys extends keySetOf<o>>(
    o: o,
    keys: keys
): show<Pick<o, keyof keys & keyof o>> => splitByKeys(o, keys)[0] as never

Or just @arktype/util I guess I dunno Whatever I know people do output validation

DimavaOP•6mo ago

Ah yes, I use that I mean this

ssalbdivad•6mo ago

I would love if you wrote some unit tests for the feature you wanted. Or implemented that config to clone before morphing

DimavaOP•6mo ago

That's what I want as well I can't understand what I want until I make it

ssalbdivad•6mo ago

I mean I guess I basically know what it would be The tricky thing it will be one of the first config options to affect the parsed type result so I have to be a bit careful Actually I guess not really

DimavaOP•6mo ago

Yep, me too But it's a "vibes" understanding, not the "experience" understanding

ssalbdivad•6mo ago

Well not the external type anyways Well look at the way existing config options are passed at various levels in the tests onUndeclaredKey would be a config option on structure I guess it could be at the root as well for convenience will have to think about how to normalize that

Unknown User•6mo ago

Message Not Public

Sign In & Join Server To View

This is a friendly space centered around ArkType, TypeScript's 1:1 validator (https://github.com/arktypeio/arktype)

442Members

View on Discord

Want results from more Discord servers?

Add your server