Merge branch 'main' of https://github.com/Infisical/infisical into bot

frontend/pages/api/auth/CheckAuth.ts

@@ -3,9 +3,6 @@ import SecurityClient from '~/utilities/SecurityClient';
 /**
  * This function is used to check if the user is authenticated.
  * To do that, we get their tokens from cookies, and verify if they are good.
- * @param {*} req
- * @param {*} res
- * @returns
  */
 const checkAuth = async () => {
   return SecurityClient.fetchCall('/api/v1/auth/checkAuth', {

frontend/pages/api/auth/CheckEmailVerificationCode.ts

@@ -5,8 +5,9 @@ interface Props {
 
 /**
  * This route check the verification code from the email that user just recieved
- * @param {*} email
- * @param {*} code
+ * @param {object} obj
+ * @param {string} obj.email
+ * @param {string} obj.code
  * @returns
  */
 const checkEmailVerificationCode = ({ email, code }: Props) => {

frontend/pages/api/auth/CompleteAccountInformationSignup.ts

@@ -15,16 +15,18 @@ interface Props {
 /**
  * This function is called in the end of the signup process.
  * It sends all the necessary nformation to the server.
- * @param {*} email
- * @param {*} firstName
- * @param {*} lastName
- * @param {*} workspace
- * @param {*} publicKey
- * @param {*} ciphertext
- * @param {*} iv
- * @param {*} tag
- * @param {*} salt
- * @param {*} verifier
+ * @param {object} obj
+ * @param {string} obj.email - email of the user completing signup
+ * @param {string} obj.firstName - first name of the user completing signup
+ * @param {string} obj.lastName - last name of the user completing sign up
+ * @param {string} obj.organizationName - organization name for this user (usually, [FIRST_NAME]'s organization)
+ * @param {string} obj.publicKey - public key of the user completing signup
+ * @param {string} obj.ciphertext
+ * @param {string} obj.iv
+ * @param {string} obj.tag
+ * @param {string} obj.salt
+ * @param {string} obj.verifier
+ * @param {string} obj.token - token that confirms a user's identity
  * @returns
  */
 const completeAccountInformationSignup = ({

frontend/pages/api/auth/CompleteAccountInformationSignupInvite.ts

@@ -14,15 +14,17 @@ interface Props {
 /**
  * This function is called in the end of the signup process.
  * It sends all the necessary nformation to the server.
- * @param {*} email
- * @param {*} firstName
- * @param {*} lastName
- * @param {*} publicKey
- * @param {*} ciphertext
- * @param {*} iv
- * @param {*} tag
- * @param {*} salt
- * @param {*} verifier
+ * @param {object} obj
+ * @param {string} obj.email - email of the user completing signupinvite flow
+ * @param {string} obj.firstName - first name of the user completing signupinvite flow
+ * @param {string} obj.lastName - last name of the user completing signupinvite flow
+ * @param {string} obj.publicKey - public key of the user completing signupinvite flow
+ * @param {string} obj.ciphertext
+ * @param {string} obj.iv
+ * @param {string} obj.tag
+ * @param {string} obj.salt
+ * @param {string} obj.verifier
+ * @param {string} obj.token - token that confirms a user's identity
  * @returns
  */
 const completeAccountInformationSignupInvite = ({

frontend/pages/api/auth/IssueBackupPrivateKey.ts

@@ -11,6 +11,14 @@ interface Props {
 
 /**
  * This is the route that issues a backup private key that will afterwards be added into a pdf
+ * @param {object} obj
+ * @param {string} obj.encryptedPrivateKey
+ * @param {string} obj.iv
+ * @param {string} obj.tag
+ * @param {string} obj.salt
+ * @param {string} obj.verifier
+ * @param {string} obj.clientProof
+ * @returns
  */
 const issueBackupPrivateKey = ({
   encryptedPrivateKey,

frontend/pages/api/auth/SRP1.ts

@@ -6,7 +6,7 @@ interface Props {
 
 /**
  * This is the first step of the change password process (pake)
- * @param {*} clientPublicKey
+ * @param {string} clientPublicKey
  * @returns
  */
 const SRP1 = ({ clientPublicKey }: Props) => {

frontend/pages/api/auth/VerifySignupInvite.ts

@@ -5,8 +5,9 @@ interface Props {
 
 /**
  * This route verifies the signup invite link
- * @param {*} email
- * @param {*} code
+ * @param {object} obj
+ * @param {string} obj.email - email that a user is trying to verify
+ * @param {string} obj.code - code that a user received to the abovementioned email
  * @returns
  */
 const verifySignupInvite = ({ email, code }: Props) => {

frontend/pages/api/files/GetSecrets.ts

@@ -2,8 +2,8 @@ import SecurityClient from '~/utilities/SecurityClient';
 
 /**
  * This function fetches the encrypted secrets from the .env file
- * @param {*} workspaceId
- * @param {*} env
+ * @param {string} workspaceId - project is for which a user is trying to get secrets
+ * @param {string} env - environment of a project for which a user is trying ot get secrets
  * @returns
  */
 const getSecrets = async (workspaceId: string, env: string) => {

frontend/pages/api/files/UploadSecrets.ts

@@ -9,8 +9,11 @@ interface Props {
 
 /**
  * This function uploads the encrypted .env file
- * @param {*} req
- * @param {*} res
+ * @param {object} obj
+ * @param {string} obj.workspaceId
+ * @param {} obj.secrets
+ * @param {} obj.keys
+ * @param {string} obj.environment
  * @returns
  */
 const uploadSecrets = async ({

frontend/pages/api/integrations/authorizeIntegration.ts

@@ -7,7 +7,10 @@ interface Props {
 }
 /**
  * This is the first step of the change password process (pake)
- * @param {*} clientPublicKey
+ * @param {object} obj
+ * @param {object} obj.workspaceId - project id for which we want to authorize the integration
+ * @param {object} obj.code
+ * @param {object} obj.integration - integration which a user is trying to turn on
  * @returns
  */
 const AuthorizeIntegration = ({ workspaceId, code, integration }: Props) => {