Release Merge

.env.example

@@ -8,13 +8,21 @@ MONGO_DB_PASSWORD=1234
 REDIS_DOCKER_URL=redis://redis:6379
 REDIS_LOCALHOST_URL=redis://localhost:6379
 
+SERVER_URL=http://localhost:3000
+WEBSOCKET_URL=ws://localhost:3000
+
+ENCRYPTION_KEY_SECRET=encryption-key-secret #(32 bytes)
+ENCRYPTION_KEY_IV=encryption-key-iv #(12 bytes)
+
 SESSION_SECRET=session-secret
 SESSION_EXPIRES_IN=180d
 
 RECAPTCHA_SECRET=recaptcha-secret
 RECAPTCHA_SITE=recaptcha-site
 DISABLE_RECAPTCHA=false
 
+EMAIL_PROVIDER=mailtrap-gmail
+
 TELWARE_EMAIL=telware@gmail.com
 TELWARE_PASSWORD=telware-password
 GMAIL_HOST=smtp.gmail.com
@@ -36,4 +44,18 @@ GITHUB_CLIENT_SECRET=githu-client-secret
 CROSS_PLATFORM_OAUTH_REDIRECT_URL=telware://telware.online/social-auth-loading
 FRONTEND_URL=localhost:5174
 
-GROUP_SIZE= 5
+GROUP_SIZE= 5
+
+FIREBASE_SERVICE_ACCOUNT='{
+  "type": "service_account",
+  "project_id": "your-project-id",
+  "private_key_id": "your-private-key-id",
+  "private_key": "-----BEGIN PRIVATE KEY-----\\nYOUR_PRIVATE_KEY\\n-----END PRIVATE KEY-----\\n",
+  "client_email": "your-client-email@your-project.iam.gserviceaccount.com",
+  "client_id": "your-client-id",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/your-client-email%40your-project.iam.gserviceaccount.com"
+  "universe_domain": "googleapis.com"
+}'

.github/workflows/checkCodeCompilationForPeter.yaml

@@ -0,0 +1,39 @@
+name: Check That Code Compiles For Peter
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+
+  pull_request:
+    branches:
+      - main
+      - develop
+
+  pull_request_target:
+    branches:
+      - main
+      - develop
+
+jobs: 
+  check-code-compilation:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run Server
+        run: npm run build
+
+

README.md

@@ -1,3 +1,12 @@
 # telware backend
 
+<!-- STATIC ANALYSIS BADGES -->
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=TelwareSW_telware-backend&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=TelwareSW_telware-backend)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=TelwareSW_telware-backend&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=TelwareSW_telware-backend)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=TelwareSW_telware-backend&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=TelwareSW_telware-backend)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=TelwareSW_telware-backend&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=TelwareSW_telware-backend)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=TelwareSW_telware-backend&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=TelwareSW_telware-backend)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=TelwareSW_telware-backend&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=TelwareSW_telware-backend)
+
+
 Backend Repo for TelWare Messaging Platform

docs/api/chat.swagger.ts

@@ -61,42 +61,30 @@
  *                                     Role:
  *                                       type: string
  *                                       description: Role of the user in the chat (e.g., member, admin).
- *                                     _id:
- *                                       type: string
- *                                       description: Unique identifier for the membership entry.
- *                                     id:
- *                                       type: string
- *                                       description: Alias for `_id`.
  *                               type:
  *                                 type: string
  *                                 description: Type of the chat (e.g., "private", "group").
+ *                               encryptionKey:
+ *                                 type: string
+ *                                 description: Key used for encrypting chat messages.
+ *                               initializationVector:
+ *                                 type: string
+ *                                 description: Initialization vector for encrypting chat messages.
  *                               isDeleted:
  *                                 type: boolean
  *                                 description: Indicates if the chat has been deleted.
  *                               chatType:
  *                                 type: string
  *                                 description: Specific type of the chat (e.g., "NormalChat").
- *                               __v:
- *                                 type: integer
- *                                 description: Version key.
  *                               numberOfMembers:
  *                                 type: integer
  *                                 description: Total number of members in the chat.
- *                               id:
- *                                 type: string
- *                                 description: Alias for `_id`.
  *                           isMuted:
  *                             type: boolean
  *                             description: Indicates if the chat is muted.
  *                           draft:
  *                             type: string
  *                             description: Draft message saved for the chat.
- *                           _id:
- *                             type: string
- *                             description: Unique identifier for the chat entry.
- *                           id:
- *                             type: string
- *                             description: Alias for `_id`.
  *                     members:
  *                       type: array
  *                       items:
@@ -136,9 +124,20 @@
  *                             items:
  *                               type: string
  *                               description: IDs of users blocked by this member.
- *                           id:
+ *                     unreadMessages:
+ *                       type: array
+ *                       items:
+ *                         type: object
+ *                         properties:
+ *                           chatId:
+ *                             type: string
+ *                             description: Unique identifier of the chat this message belongs to.
+ *                           unreadMessagesCount:
  *                             type: string
- *                             description: Alias for `_id`.
+ *                             description: Number of unread messages in the chat.
+ *                           isMentioned:
+ *                             type: boolean
+ *                             description: Indicates if the user is mentioned in the chat.
  *                     lastMessages:
  *                       type: array
  *                       items:
@@ -186,12 +185,6 @@
  *                                 type: string
  *                                 format: date-time
  *                                 description: Timestamp when the message was sent.
- *                               __v:
- *                                 type: integer
- *                                 description: Version key.
- *                               id:
- *                                 type: string
- *                                 description: Alias for `_id`.
  *       401:
  *         description: User is not logged in or the request is invalid.
  *         content:
@@ -315,16 +308,23 @@
  *         name: page
  *         required: false
  *         schema:
- *           type: integer
- *           example: 1
- *         description: The page number for paginated messages (default is 1).
+ *           type: objectId
+ *           example: "674cbbba97faf0d2e8a93846"
+ *         description: The page starting after that messageId.
  *       - in: query
  *         name: limit
  *         required: false
  *         schema:
  *           type: integer
  *           example: 50
  *         description: The number of messages to retrieve per page (default is 100).
+ *       - in: query
+ *         name: timestamp
+ *         required: false
+ *         schema:
+ *           type: Date
+ *           example: 2024-12-01T19:37:56.399Z
+ *         description: The timestamp to retrieve messages after.
  *     responses:
  *       200:
  *         description: Messages retrieved successfully.
@@ -356,6 +356,12 @@
  *                           contentType:
  *                             type: string
  *                             example: text
+ *                           media:
+ *                            type: string
+ *                            example: "media-file-name.jpg"
+ *                           isEdited:
+ *                             type: boolean
+ *                             example: false
  *                           isPinned:
  *                             type: boolean
  *                             example: false
@@ -383,17 +389,8 @@
  *                             items:
  *                               type: string
  *                             example: []
- *                           messageType:
- *                             type: string
- *                             example: private
- *                           __v:
- *                             type: integer
- *                             example: 0
- *                           id:
- *                             type: string
- *                             example: "674cbbba97faf0d2e8a93846"
  *                     nextPage:
- *                       type: integer
+ *                       type: objectId
  *                       example: 2
  *       400:
  *         description: Bad Request - Chat does not exist.
@@ -1063,3 +1060,67 @@
  *                   type: string
  *                   example: login first
  */
+
+/**
+ * @swagger
+ * /chats/voice-calls/{chatId}:
+ *   get:
+ *     summary: Retrieve voice calls in a specific chat.
+ *     description: Fetch all voice calls associated with a given chat ID. Access is restricted to chat members.
+ *     tags:
+ *       - Chat
+ *     parameters:
+ *       - in: path
+ *         name: chatId
+ *         required: true
+ *         schema:
+ *           type: string
+ *         description: The ID of the chat whose voice calls are being retrieved.
+ *     responses:
+ *       200:
+ *         description: Voice calls retrieved successfully.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: success
+ *                 message:
+ *                   type: string
+ *                   example: voice calls retrieved successfully
+ *                 data:
+ *                   type: object
+ *                   properties:
+ *                     voiceCalls:
+ *                       type: array
+ *                       items:
+ *                         type: object
+ *       400:
+ *         description: Missing required fields or invalid request.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: fail
+ *                 message:
+ *                   type: string
+ *                   example: missing required fields
+ *       403:
+ *         description: Unauthorized request due to missing or invalid user authentication.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: fail
+ *                 message:
+ *                   type: string
+ *                   example: login first
+ */

docs/api/search.swagger.ts

@@ -4,11 +4,10 @@
  *   name: Search
  *   description: API for searching content across various spaces with optional filters and global search capabilities.
  */
-
 /**
  * @swagger
- * /search-request:
- *   get:
+ * /search/search-request:
+ *   post:
  *     summary: Perform a search across specified spaces with optional filters.
  *     tags: [Search]
  *     description: Allows users to search within specific spaces like chats, channels, and groups, apply filters, and enable global search for a broader scope.
@@ -155,6 +154,7 @@
  *                   example: "An unexpected error occurred while processing the request."
  */
 
+
 /**
  * @swagger
  * tags: