Doc validator

[ianmacartney]

adds doc and typedV validator helpers

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[sshader]

🚢

[sshader]

I was going to claim that we already had this in the convex package, but turns out we don't

[ianmacartney]

yeah it makes sense to add to the package imo

[sshader]

aren't these redundant with the line above?

[ianmacartney]

I think I had to do this for typescript to stop complaining. Would be nice if there was a type assertion/ refinement as part of vitest. let me know if you know other ways to do this

[sshader]

is it possible to get a VObject<Fields> and somehow extract out field paths from there?

[ianmacartney]

Maybe? It's not a property, but fields are, but afaict we don't have a fields -> FieldPaths type utility - it's just inlined in the VObject type def. Maybe I could do ObjectType<Fields> extends ObjectType<any, any, any, infer FieldPaths> ? FieldPaths : never or something - is that better?

[sshader]

What happens when Fields contains fields that are also in V?

[ianmacartney]

Right now it's just being used for _id & _creationTime, but it's a good q. I think b/c of & it'll either work if they're the same, or be never?

[sshader]

Was going to ask if you could use something similar to the Doc type, but nope this is a validator.

I think you could maybe assemble a Validator out of the data model type directly (especially if we're ok losing the structure of the original validator), but seems just as hard as this

[ianmacartney]

Yeah I'd love to have the original validator so you could do omit(v.doc("users").fields, ["password"]) or v.doc("users").fields.address and still have the structure / types work out

[ianmacartney]

also can you think of a better name than `typedV`?

…

On Thu, Jan 30, 2025 at 3:01 PM Sarah Shader ***@***.***> wrote: ***@***.**** approved this pull request. 🚢 ------------------------------ In packages/convex-helpers/validators.ts <#427 (comment)> : > @@ -106,6 +113,10 @@ export const systemFields = <TableName extends string>( _creationTime: v.number(), }); +export type SystemFields<TableName extends string> = ReturnType< I was going to claim that we already had this in the convex package, but turns out we don't ------------------------------ In packages/convex-helpers/server/validators.test.ts <#427 (comment)> : > + const doc = await t.query(testApi.getUnion, { docId }); + expect(doc).toBeDefined(); + expect(doc!._creationTime).toBeTypeOf("number"); + expect(doc!["foo"]).toBeDefined(); +}); + +test("doc validator adds fields", async () => { + const t = convexTest(schema, modules); + await t.mutation(testApi.toDoc, {}); + const userDoc = doc(schema, "users"); + expect(userDoc.fields.tokenIdentifier).toBeDefined(); + expect(userDoc.fields._id).toBeDefined(); + expect(userDoc.fields._creationTime).toBeDefined(); + const unionDoc = doc(schema, "unionTable"); + expect(unionDoc.kind).toBe("union"); + if (unionDoc.kind !== "union") { aren't these redundant with the line above? ------------------------------ In packages/convex-helpers/validators.ts <#427 (comment)> : > @@ -129,6 +140,112 @@ export const withSystemFields = < } as Expand<T & typeof system>; }; +export type AddFieldsToValidator< + V extends Validator<any, any, any>, + Fields extends PropertyValidators, +> = + V extends VObject<infer T, infer F, infer O> + ? VObject<Expand<T & ObjectType<Fields>>, Expand<F & Fields>, O> + : Validator< + Expand<V["type"] & ObjectType<Fields>>, + V["isOptional"], + V["fieldPaths"] & + { is it possible to get a VObject<Fields> and somehow extract out field paths from there? ------------------------------ In packages/convex-helpers/validators.ts <#427 (comment)> : > @@ -129,6 +140,112 @@ export const withSystemFields = < } as Expand<T & typeof system>; }; +export type AddFieldsToValidator< + V extends Validator<any, any, any>, + Fields extends PropertyValidators, What happens when Fields contains fields that are also in V? ------------------------------ In packages/convex-helpers/validators.ts <#427 (comment)> : > + /** + * Generates a validator for a document, including system fields. + * To be used in validators when passing a full document in or out of a + * function. + * @param tableName A table named in your schema. + * @returns A validator that matches the schema validator, adding _id and + * _creationTime. If the validator was a union, it will update all documents + * recursively, but will currently lose the VUnion-specific type. + */ + doc: < + TableName extends TableNamesInDataModel< + DataModelFromSchemaDefinition<Schema> + >, + >( + tableName: TableName, + ): AddFieldsToValidator< Was going to ask if you could use something similar to the Doc type, but nope this is a validator. I think you could maybe assemble a Validator out of the data model type directly (especially if we're ok losing the structure of the original validator), but seems just as hard as this — Reply to this email directly, view it on GitHub <#427 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACZQW7DLUQJPV4HT7EVQY32NKVMLAVCNFSM6AAAAABWGJL7YSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKOBVGIYDENZUGQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>