224 confirmation email when companies register

.env

@@ -20,6 +20,9 @@ JWT_SECRET=Lendas contam que o Rui foi membro do IEEE.
 # Frontend Password Recovery Base Route
 PASSWORD_RECOVERY_LINK=https://localhost:3000/recover
 
+# Frontend Application Confirmation Base Route
+APPLICATION_CONFIRMATION_LINK=https://localhost:3000/apply/
+
 # Specifies the port in which the app will be exposed
 PORT=8087
 
@@ -45,12 +48,12 @@ ACCESS_CONTROL_ALLOW_ORIGINS=
 MAIL_FROM=
 
 # Password for email above
-MAIL_FROM_PASSWORD= 
+MAIL_FROM_PASSWORD=
 
 # Cloudinary API URL to save images
 CLOUDINARY_URL=
 
-# Hostname of the application (where the webserver will be served) - without the trailing '/' 
+# Hostname of the application (where the webserver will be served) - without the trailing '/'
 WEBSERVER_HOST=https://localhost:8087
 
 # Path to save file uploads, the path must be relative to the root of the project - Defaults to static

.eslintrc

@@ -1,4 +1,4 @@
-{   
+{
     "extends": [
         "eslint:recommended"
     ],
@@ -99,6 +99,6 @@
         "no-var": "error",
         "prefer-const": ["error", { "destructuring": "all" }],
         "prefer-template": "error",
-        "template-curly-spacing": "error",
+        "template-curly-spacing": "error"
     }
 }

documentation/docs-index.js

@@ -28,13 +28,15 @@ module.exports = {
             "companies/disable",
             "companies/enable",
             "companies/delete",
-            "companies/concurrent-offers"
+            "companies/concurrent-offers",
+            "companies/get-application"
         ],
         Applications: [
             "applications/create",
             "applications/search",
             "applications/approve",
-            "applications/reject"
+            "applications/reject",
+            "applications/validate"
         ],
         Auth: [
             "auth/login",

documentation/docs/applications/approve.md

@@ -13,6 +13,7 @@ import Highlight from "../../src/highlight.js"
 ## Details
 
 This endpoint is used to approve a company Application, specified by applicationId.
+It changes all the companies offers to not pending.
 
 **URL** : `/applications/company/:applicationId/approve`
 
@@ -169,3 +170,39 @@ values={[
 
 </TabItem>
 </Tabs>
+
+### Example 5 - Application is not verified
+
+**Code** : <Highlight level="danger" inline>409 CONFLICT</Highlight>
+
+<Tabs
+defaultValue="request"
+values={[
+{label: 'Request', value: 'request'},
+{label: 'Response', value: 'response'},
+]}
+>
+
+<TabItem value="request">
+
+```bash
+/applications/company/631a18cf8e61e0acea76e5e1/approve
+```
+
+</TabItem>
+
+<TabItem value="response">
+
+```json
+{
+  "error_code": 1,
+  "errors": [
+    {
+      "msg": "application-must-be-verified"
+    }
+  ]
+}
+```
+
+</TabItem>
+</Tabs>

documentation/docs/applications/create.md

@@ -13,8 +13,8 @@ import Highlight from "../../src/highlight.js"
 ## Details
 
 This endpoint is used to create company applications.
-In order of a Company to use its account, the application must be accepted by an Admin and then the Company should
-finish its registration.
+In order for a Company to use its account, the company must verify its application by clicking in a link sent 
+by email after its creation. After that the Company should finish its registration.
 
 **URL** : `/apply/company`
 
@@ -36,7 +36,11 @@ see [register](../auth/register).
 Email used for the company application and subsequent account.
 
 Must be in a valid email format.
-Can't already be in use for accounts or other applications.
+Can't already be in use on any account.
+
+:::info
+After creating an application, if another application is created with the same email after 10 minutes, the existing one will be replaced. Creating the new application before the 10 minute mark will result in an error.
+:::
 
 ### password
 
@@ -181,7 +185,7 @@ values={[
   "password": "password123",
   "companyName": "Company",
   "motivation": "We wish to revolutionize the industry with young engineers."
-}
+}ara quem usa o timetable-bruteforcer
 ```
 
 </TabItem>
@@ -249,7 +253,48 @@ values={[
 </TabItem>
 </Tabs>
 
-### Example 5 - Invalid Password
+### Example 5 - Application with the same email created recently
+
+**Code** : <Highlight level="danger" inline>403 FORBIDDEN</Highlight>
+
+<Tabs
+defaultValue="request"
+values={[
+{label: 'Request', value: 'request'},
+{label: 'Response', value: 'response'},
+]}
+>
+
+<TabItem value="request">
+
+```json
+{
+  "email": "[email protected]",
+  "password": "password123",
+  "companyName": "Company",
+  "motivation": "We wish to revolutionize the industry with young engineers."
+}
+```
+
+</TabItem>
+
+<TabItem value="response">
+
+```json
+{
+  "error_code": 1,
+  "errors": [
+    {
+      "msg": "company-application-recently-created",
+    }
+  ]
+}
+```
+
+</TabItem>
+</Tabs>
+
+### Example 6 - Invalid Password
 
 **Code** : <Highlight level="danger" inline>422 UNPROCESSABLE ENTITY</Highlight>
 

documentation/docs/applications/reject.md

@@ -197,3 +197,42 @@ values={[
 
 </TabItem>
 </Tabs>
+
+### Example 5 - Application is not verified
+
+**Code** : <Highlight level="danger" inline>409 CONFLICT</Highlight>
+
+<Tabs
+defaultValue="request"
+values={[
+{label: 'Request', value: 'request'},
+{label: 'Response', value: 'response'},
+]}
+>
+
+<TabItem value="request">
+
+```json
+{
+ "rejectReason": "The motivation of the company is not convincing" 
+}
+```
+
+</TabItem>
+
+<TabItem value="response">
+
+```json
+{
+  "error_code": 1,
+  "errors": [
+    {
+      "msg": "application-must-be-verified"
+    }
+  ]
+}
+```
+
+</TabItem>
+</Tabs>
+

documentation/docs/applications/search.md

@@ -66,7 +66,7 @@ Filters the applications by the name of the respective companies.
 Array of strings which filters the application by their state.
 
 :::caution
-Must be a valid state (currently `["PENDING", "APPROVED", "REJECTED"]`).
+Must be a valid state (currently `["UNVERIFIED", "PENDING", "APPROVED", "REJECTED"]`).
 :::
 
 ### submissionDateFrom
@@ -153,6 +153,7 @@ values={[
       "companyName": "Company name",
       "motivation": "We wish to revolutionize the industry with young engineers.",
       "submittedAt": "2022-09-08T16:31:11.784Z",
+      "isVerified": true,
       "__v": 0,
       "state": "PENDING"
     },
@@ -162,6 +163,7 @@ values={[
       "companyName": "Example Company",
       "motivation": "We are a brand new tech company in Porto, Portugal",
       "submittedAt": "2022-09-07T13:15:15.971Z",
+      "isVerified": true,
       "__v": 0,
       "approvedAt": "2022-09-07T13:17:30.908Z",
       "state": "APPROVED"
@@ -172,13 +174,24 @@ values={[
       "companyName": "Bad Company",
       "motivation": "We want to exploit workers.",
       "submittedAt": "2022-09-07T13:15:15.971Z",
+      "isVerified": true,
       "__v": 0,
       "rejectedAt": "2022-09-07T13:17:30.908Z",
       "rejectReason": "Motivation doesn't seem right",
       "state": "REJECTED"
+    },
+    {
+      "_id": "63189963541e53a45a423dce",
+      "email": "[email protected]",
+      "companyName": "Unverified",
+      "motivation": "We are a new company in Lisbon",
+      "submittedAt": "2022-09-07T13:15:15.971Z",
+      "isVerified": false,
+      "__v": 0,
+      "state": "UNVERIFIED"
     }
   ],
-  "docCount": 3
+  "docCount": 4
 }
 ```