@Etrenak is attempting to deploy a commit to the Documenso Team Team on Vercel.

A member of the Team first needs to authorize it.

Walkthrough

The changes introduce a new asynchronous function, getFieldsForDocument, in the ApiContractV1Implementation route handler, enabling the API to return additional field data related to a specified document. The schema definitions are updated to include a new ZFieldSchema for field objects and to modify the response schemas, such as ZSuccessfulDocumentResponseSchema, to incorporate an array of these fields, refining the structure of the API responses.

Changes

Possibly related PRs

• fix: show field on pending document #1158: The main PR introduces the getFieldsForDocument function, which is directly related to the changes in fix: show field on pending document #1158 where getCompletedFieldsForDocument is replaced with getFieldsForDocument, indicating a shared focus on field retrieval functionality.

Suggested labels

apps: web, apps: marketing

Poem

🐰 In the meadow where data flows,
New fields sprout, as knowledge grows.
With each document, more to see,
A richer world, for you and me!
Hopping high with joy, we cheer,
For changes bright, we hold so dear! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Hey there, it looks like you haven't accepted our contributor license agreement yet. In order for us to accept your pull request we ask that you please fill out the CLA:

https://documen.so/cla

This one looks good, I'll just need to grab a moment to run through the testing on this one manually!

For my use case, I would like to be able to also get fieldMeta returned by this endpoint. However, when I tried to also return the fieldMeta, I encountered some typing issues.

That is, I simply added fieldMeta in the schema like this :

export const ZSuccessfulGetDocumentResponseSchema = ZSuccessfulDocumentResponseSchema.extend({
  recipients: z.lazy(() => z.array(ZSuccessfulRecipientResponseSchema)),
  fields: ZFieldSchema.pick({
    id: true,
    recipientId: true,
    type: true,
    page: true,
    positionX: true,
    positionY: true,
    width: true,
    height: true,
  }).extend({
    fieldMeta: ZFieldMetaSchema,
  }).array(),
});

But since fieldMeta in only known as a JsonValue in the prisma schema, we cannot simply return the result of the query to the database. Please tell me if this is OK to simply do the parsing of the database result in implementation.ts:getDocument into a correct field meta type ? I think it would be better to edit the database schema to indicate that the type is one of the advanced fields meta (Either TEXT meta, or DROPDOWN meta, ...), but it is certainly not the easiest way.

Do you know why it was chosen to store the field meta as a JsonValue in the database, and which of the two solutions I should prefer ?

EDIT : This can definitely be addressed in another PR

Thank you for following the naming conventions for pull request titles! 💚🚀

So I ended up adding fieldMeta anyway. I hope I did not waste your time on previously testing the PR without it.

I also put back the definition of ZFieldSchema in its original position, since I learned what z.lazy() does (I'm not really familiar with TS). Using z.lazy() seems to mess up the OpenAPI schema generation though ☹️. It only displays fields: "string" instead of the correct schema, but that's not a big issue.

Feel free to tell me if you would like another implementation, my precedent comment still stands.

Hey, I see this has been approved. Any idea when it might get merged ? Thanks!