chore(api): Fix inconsistencies in zod schema

[Ritika1705]

Description

Email regex validation added.

z.string().regex(/^[a-zA-Z0-9.%+-]+ [<][a-zA-Z0-9.%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}

In this single line, the regex pattern is directly embedded in the schema definition. This keeps the code concise and straightforward. (Expected format is "your-name your-name@email.com")

Fixes #216

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

[codiumai-pr-agent-free]

Failed to generate code suggestions for PR

[rajdip-b]

Hey Ritika! Glad that you put up this pr. The issue also mentions 3 other items that you would need to add to make this pr complete! Do let us know if you face any errors.

[Ritika1705]

Hi @rajdip-b , if you can kindly elaborate as to what needs to be done for the other issues. As I was not so much clear about them. thanks

[rajdip-b]

Okay look the second and 3rd bullets point to separate files where we have used @ts-expect-error becuase typecript was complaining about the value of process.env.NODE_ENV. You would have to remove the @ts-expect-error lines in those files and make sure that the type inference is working properly

The last point was to add another regex expression for email in the zod schema. You can just click on the hyperlinks and it will direct you to the files in concern.

[Ritika1705]

Okay look the second and 3rd bullets point to separate files where we have used @ts-expect-error becuase typecript was complaining about the value of process.env.NODE_ENV. You would have to remove the @ts-expect-error lines in those files and make sure that the type inference is working properly

The last point was to add another regex expression for email in the zod schema. You can just click on the hyperlinks and it will direct you to the files in concern.

Hi @rajdip-b, so the 4th point is clear to me. But for the 2nd point - I have to remove the '@ts-expect-error' comments? and what about the 3rd point? I am sorry if I am taking time to understand this.

[rajdip-b]

No worries! Refer to this to understand how ts expect error works. You would need to remove ts error and also make sure that the value for NODE_ENV is properly inferred. You have to do this for both 2nd and 3rd points.

For the 4th one, you would need to validate the email input in the zod schema. The 4th point in the issue points to the line you need to validate.

Also, you can join our discord if you would like to discuss this more! https://discord.gg/tbsUq3Vv

[kriptonian1]

can't we just do z.string().email() rather than writing the regex manuallly

[rajdip-b]

can't we just do z.string().email() rather than writing the regex manuallly

Yeah totally but not for the first case.

[kriptonian1]

can't we just do z.string().email() rather than writing the regex manuallly

Yeah totally but not for the first case.

oh accha, I didn't check the format that we are using

[kriptonian1]

@rajdip-b I think we should add some zod middleware validation like hono https://hono.dev/guides/validation#zod-validator-middleware

[rajdip-b]

@rajdip-b I think we should add some zod middleware validation like hono https://hono.dev/guides/validation#zod-validator-middleware

That would be an overkill since we are using the zod schema only during application startup

[Ritika1705]

Hi @rajdip-b, made some changes, kindly take a look

[rajdip-b]

@Ritika1705 Thanks! The PR looks clean. I'll just ask the guy who initially developed this to drop a review.

@jamesfrye420 hey bro mind checking out the PR once? It aims to close those @ts-expect-error clauses in zod :D

[jamesfrye420]

Cool will do

[jamesfrye420]

Take your name <email@example.com> into consideration for FROM_EMAIL

[Ritika1705]

Take your name <email@example.com> into consideration for FROM_EMAIL

@jamesfrye420 , @rajdip-b updated the code as per review comments

[jamesfrye420]

Looks good.

@rajdip-b you can merge and close this.

[rajdip-b]

@Ritika1705 can you please try running pnpm e2e:api on your device locally? Seems that it is throwing an error which isn't supposed to happen. This is the line that's responsible for it. Somehow, it is not detecting the e2e NODE_ENV. I specify the NODE_ENV value in this line.

The rest of the PR looks pretty nice, and I think I can merge it as soon as we can fix the error.

[Ritika1705]

@Ritika1705 can you please try running pnpm e2e:api on your device locally? Seems that it is throwing an error which isn't supposed to happen. This is the line that's responsible for it. Somehow, it is not detecting the e2e NODE_ENV. I specify the NODE_ENV value in this line.

The rest of the PR looks pretty nice, and I think I can merge it as soon as we can fix the error.

@rajdip-b , not able to figure out what the issue is here. Some help will be appreciated. Tried in local too. Getting the same error

[rajdip-b]

@Ritika1705 I would recommend you to log the value of NODE_ENV when you run the e2e tests. Do this before, and after you sset the value of node env like you are doing. I think that will be helpful.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
3.9% Duplication on New Code

See analysis details on SonarCloud

[Ritika1705]

Hi @rajdip-b , errors are resolved. kindly look at the commits and merge the PR if you feel everything looks good

[rajdip-b]

I think this works! Thanks for the PR :D

[rajdip-b]

🎉 This PR is included in version 2.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀