PR for Issue#332 [BE: API key & code snippet]

backend/config/settings.js

@@ -23,6 +23,7 @@ module.exports = {
       popups: [userRole.ADMIN],
       hints: [userRole.ADMIN],
       banners: [userRole.ADMIN],
+      serverUrlAndApiKey: [userRole.ADMIN]
     }
   }
 };

backend/migrations/20241115084356-api_key_server_url_cols_teams_rel.js

@@ -0,0 +1,19 @@
+'use strict';
+
+module.exports = {
+  async up (queryInterface, Sequelize) {
+    await queryInterface.addColumn('teams', 'apiKey', {
+      type: Sequelize.STRING(255),
+      allowNull: true,
+    })
+    await queryInterface.addColumn('teams', 'serverUrl', {
+      type: Sequelize.STRING(255),
+      allowNull: true,
+    })
+  },
+
+  async down (queryInterface, Sequelize) {
+    await queryInterface.removeColumn('teams', 'apiKey')
+    await queryInterface.removeColumn('teams', 'serverUrl')
+  }
+};

backend/src/controllers/team.controller.js

@@ -3,6 +3,7 @@ const TeamService = require("../service/team.service");
 const { internalServerError } = require("../utils/errors.helper");
 const { MAX_ORG_NAME_LENGTH, ORG_NAME_REGEX } = require('../utils/constants.helper');
 const db = require("../models");
+const bcrypt = require('bcrypt');
 
 const Team = db.Team;
 const teamService = new TeamService();
@@ -101,6 +102,33 @@ const updateTeamDetails = async (req, res) => {
     }
 };
 
+const setConfig = async (req, res) => {
+  const { serverUrl, apiKey } = req.body;
+  if (!serverUrl || typeof serverUrl !== 'string' || serverUrl.length === 0) {
+    return res.status(400).json({ message: 'Server URL is required and should be a non-empty string' });
+  }
+  if (!apiKey || typeof apiKey !== "string" || apiKey.length === 0) {
+    return res.status(400).json({ message: 'API Key is required and should be a non-empty string' });
+  }
+
+  try {
+    new URL(serverUrl);
+  } catch (err) {
+    return res.status(400).json({ message: 'Invalid server URL format' });
+  }
+
+  try {
+    await teamService.addServerUrlAndApiKey(serverUrl, apiKey);
+    return res.status(200).json({ message: "Server URL and API Key Set Successfully" });
+  } catch (err) {
+    const { statusCode, payload } = internalServerError(
+      "SET_CONFIG_ERROR",
+      err.message
+    )
+    res.status(statusCode).json(payload);
+  }
+}
+
 const removeMember = async (req, res) => {
   const userId = req.user.id;
   const { memberId } = req.params;
@@ -130,4 +158,4 @@ const changeRole = async (req, res) => {
   }
 }
 
-module.exports = { setOrganisation, getTeamDetails, updateTeamDetails, removeMember, changeRole, getTeamCount };
+module.exports = { setOrganisation, getTeamDetails, updateTeamDetails, removeMember, changeRole, getTeamCount, setConfig };

backend/src/models/Team.js

@@ -11,6 +11,14 @@ module.exports = (sequelize, DataTypes) => {
           type: DataTypes.STRING(50),
           allowNull: false,
         },
+        apiKey: {
+          type: DataTypes.STRING(255),
+          allowNull: true,
+        },
+        serverUrl: {
+          type: DataTypes.STRING(255),
+          allowNull: true,
+        },
         createdAt: {
           type: DataTypes.DATE,
           allowNull: false,

backend/src/routes/team.routes.js

@@ -1,6 +1,7 @@
 const express = require("express");
 const { 
   setOrganisation,
+  setConfig,
   getTeamDetails,
   getTeamCount,
   updateTeamDetails, 
@@ -25,6 +26,7 @@ router.post("/set-organisation", authenticateJWT, accessGuard(teamPermissions.se
 router.post("/invite", authenticateJWT, accessGuard(teamPermissions.invite), sendTeamInvite);
 router.put("/update", authenticateJWT, accessGuard(teamPermissions.update), updateTeamDetails);
 router.put("/change-role", authenticateJWT, accessGuard(teamPermissions.changeRole), changeRole);
+router.put('/set-config', authenticateJWT, accessGuard(teamPermissions.serverUrlAndApiKey), setConfig);
 
 router.delete("/remove/:memberId", authenticateJWT, accessGuard(teamPermissions.removeUser), removeMember);
 router.get('/get-all-invites', authenticateJWT, accessGuard(teamPermissions.removeUser), getAllInvites);

backend/src/service/team.service.js

@@ -1,3 +1,4 @@
+const { where } = require("sequelize");
 const settings = require("../../config/settings");
 const db = require("../models");
 const Team = db.Team;
@@ -127,6 +128,24 @@ class TeamService {
             throw new Error(`"Failed to update user role ~ ${err.message}`);
         }
     }
+
+    async addServerUrlAndApiKey(serverUrl, apiKey) {
+        const transaction = await sequelize.transaction();
+        try {
+            await Team.update({
+                serverUrl,
+                apiKey
+            }, {
+                where: {}
+            }, {
+                transaction
+            });
+            await transaction.commit();
+        } catch (err) {
+            await transaction.rollback();
+            throw new Error("Failed to add server url and api key");
+        }
+    }
 }
 
 module.exports = TeamService;

frontend/src/scenes/settings/CodeTab/CodeTab.jsx

@@ -5,6 +5,9 @@ import DeleteOutlinedIcon from '@mui/icons-material/DeleteOutlined';
 import Button from "@components/Button/Button";
 import ContentCopyOutlinedIcon from '@mui/icons-material/ContentCopyOutlined';
 import { generateApiKey } from "../../../utils/generalHelper";
+import { emitToastError } from "../../../utils/guideHelper";
+import { setConfig } from '../../../services/teamServices';
+import toastEmitter, { TOAST_EMITTER_KEY } from "../../../utils/toastEmitter";
 
 const CodeTab = () => {
     const [apiKey, setApiKey] = useState('')
@@ -22,6 +25,28 @@ const CodeTab = () => {
         setApiKey('');
     }
 
+    const onSave = async () => {
+        if (!serverUrl.trim()) {
+            toastEmitter.emit(TOAST_EMITTER_KEY, 'Server URL cannot be empty');
+            return;
+        }
+        if (!serverUrl.startsWith("http://") && !serverUrl.startsWith("https://")) {
+            toastEmitter.emit(TOAST_EMITTER_KEY, 'Server URL must start with http:// or https://');
+            return;
+        }
+        if (!apiKey.trim()) {
+            toastEmitter.emit(TOAST_EMITTER_KEY, 'API key cannot be empty');
+            return;
+        }
+
+        try {
+            const response = await setConfig(serverUrl, apiKey);
+            toastEmitter.emit(TOAST_EMITTER_KEY, response.message);
+        } catch (err) {
+            emitToastError(err);
+        }
+    };
+
     return (
         <section className={styles.container}>
             <h2>API key management</h2>
@@ -49,7 +74,7 @@ const CodeTab = () => {
                     TextFieldWidth="550px"
                 />
                 <span/>
-                <Button text='Save' sx={{width:'120px'}}/>
+                <Button text='Save' sx={{width:'120px'}} onClick={onSave}/>
             </div>
             <h2 style={{marginTop: '25px'}}>Code in your webpage</h2>
             <div className={styles.informativeBlock}>

frontend/src/services/teamServices.js

@@ -22,4 +22,14 @@ export const getTeamCount = async () => {
     console.error('Error getting team count: ', err);
     throw err;
   }
+}
+
+export const setConfig = async (serverUrl, apiKey) => {
+  try {
+    const response = await apiClient.put(`${baseEndpoint}/set-config`, { serverUrl, apiKey });
+    return response.data;
+  } catch (err) {
+    console.error('Error setting Server URL and API Key: ', err);
+    throw err;
+  }
 }

frontend/src/utils/constants.js

@@ -1,9 +1,9 @@
 // API constants
 //local environment
-export const API_BASE_URL = 'http://localhost:3000/api/';
+//export const API_BASE_URL = 'http://localhost:3000/api/';
 
 //staging environment
-// export const API_BASE_URL = 'https://onboarding-demo.bluewavelabs.ca/api/';
+export const API_BASE_URL = 'https://onboarding-demo.bluewavelabs.ca/api/';
 // Other constants
 export const APP_TITLE = 'Bluewave Onboarding';
 export const SUPPORT_EMAIL = '[email protected]';