Added missing packages to dev

Reviewed-on: #24

.gitea/workflows/DRBv3_docs.yaml

@@ -7,6 +7,10 @@ on:
   # schedule:
   #   - cron: '0 0 * * 1' # Every Monday at midnight (UTC)
 
+
+env:
+  NODE_ENV: development
+
 jobs:
   update-wiki:
     runs-on: ubuntu-latest
@@ -23,7 +27,7 @@ jobs:
         run: npm install
 
       - name: Generate JSDoc
-        run: npx jsdoc -c jsdoc.json -d docs
+        run: npm run docs
 
       - name: Checkout the wiki repository
         uses: actions/checkout@v4
@@ -31,12 +35,22 @@ jobs:
           repository: logan/drb-server.wiki # Replace with your wiki repository
           path: wiki
 
+      - name: Output Generated Documentation
+        run: |
+          cat Home.md
+          ls
+
       - name: Update wiki
         run: |
-          cp -r docs/* wiki/
+          cp -rf Home.md wiki/Home.md
           cd wiki
           git config user.name "gitea-actions"
           git config user.email "gitea-actions@cusano.net"
           git add .
-          git commit -m "Update wiki from JSDoc"
-          git push
+          # Check if there are any changes to commit
+          if git diff --cached --quiet; then
+            echo "No changes to commit."
+          else
+            git commit -m "Update wiki from JSDoc"
+            git push
+          fi

.gitignore

@@ -301,4 +301,7 @@ config/
 op25/
 
 # Ignore any local run scripts for development
-*.bat
+*.bat
+
+# Ignore the auto-generated docs folder
+/docs

Dockerfile

@@ -12,7 +12,7 @@ RUN npm install -g node-gyp
 RUN npm install
 
 # Copy the rest of the application code to the working directory
-COPY . .
+COPY ./src ./src
 
 # Expose the port on which your Node.js application will run
 EXPOSE 3420

eslint.config.mjs

@@ -17,7 +17,7 @@ export default [
   // Apply ESLint recommended settings first
   ...compat.extends().map((config) => ({
     ...config,
-    files: ["**/*.mjs", "**/*.js", "**/*.cjs"],
+    files: ["src/**/*.mjs", "src/**/*.js", "src/**/*.cjs"],
   })),
 
   // Custom rules and plugin configuration

jsdoc.conf

@@ -0,0 +1,10 @@
+{
+  "source": {
+    "includePattern": ".+([mc]?js(doc|x)?)$"
+  }, 
+  "plugins": ["node_modules/jsdoc-babel"],
+  "babel": {
+    "presets": [ "es2015" ],
+    "plugins": [ "transform-async-to-generator" ]
+  }
+}

jsdoc.json

@@ -1,14 +0,0 @@
-{
-    "source": {
-      "include": ["addons", "discordBot", "modules", "rss-manager", "test"],
-      "exclude": ["node_modules"],
-      "includePattern": ".+\\.[mc]?js(doc|x)?$",
-      "excludePattern": "(^|\\/|\\\\)_"
-    },
-    "opts": {
-      "destination": "./docs",
-      "recurse": true,
-      "template": "default"
-    }
-  }
-  

makefile

@@ -21,10 +21,6 @@ run:
 				-e MONGO_URL=${MONGO_URL} \
 				-e DISCORD_TOKEN=${DISCORD_TOKEN} \
 				-e RSS_REFRESH_INTERVAL=${RSS_REFRESH_INTERVAL} \
-				-e WELCOME_CHANNEL_ID=${WELCOME_CHANNEL_ID} \
-				-e IGNORED_CHANNEL_IDS=${IGNORED_CHANNEL_IDS} \
-				-e LINKCOP_RESTRICTED_CHANNEL_IDS=${LINKCOP_RESTRICTED_CHANNEL_IDS} \
-				-e DRB_SERVER_INITIAL_PROMPT=${DRB_SERVER_INITIAL_PROMPT} \
 				-e OPENAI_API_KEY=${OPENAI_API_KEY} \
 				-e LOG_LOCATION="./logs/server.log" \
 				-p ${SERVER_PORT}:${SERVER_PORT} \

package.json

@@ -2,23 +2,27 @@
   "name": "drb-server",
   "version": "3.0.0",
   "description": "",
-  "main": "server.js",
+  "main": "src/server.js",
   "scripts": {
+    "docs": "jsdoc2md -c jsdoc.conf src/*js > Home.md",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "mocha --timeout 5000",
-    "start": "node server.js"
+    "start": "node src/server.js"
   },
   "author": "Logan Cusano",
   "license": "ISC",
   "type": "module",
   "devDependencies": {
+    "babel-plugin-transform-async-to-generator": "^6.24.1",
+    "babel-preset-es2015": "^6.24.1",
     "chai": "^5.1.1",
     "eslint": "^9.9.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-unused-imports": "^4.1.3",
-    "jsdoc": "^4.0.3",
+    "jsdoc-babel": "^0.5.0",
+    "jsdoc-to-markdown": "^8.0.3",
     "mocha": "^10.4.0",
     "prettier": "^3.3.3",
     "socket.io-client": "^4.7.5"

src/discordBot/modules/presenceManager.mjs

@@ -4,10 +4,13 @@ import {
 } from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
 import { ActivityType, PresenceUpdateStatus } from "discord.js";
 
+/**
+ * Control the presence or activity of the discord bot.
+ */
 class PresenceManager {
   /**
    * Creates an instance of PresenceManager.
-   * @param {import('discord.js').Client} client - The Discord client instance.
+   * @param {Client} client - The Discord client instance.
    */
   constructor(client) {
     this.client = client;

src/discordBot/modules/wrappers.mjs

@@ -4,7 +4,6 @@ import {
   checkIfNodeIsConnectedToVC,
   getNodeDiscordID,
   getNodeDiscordUsername,
-  checkIfNodeHasOpenDiscordClient,
   getNodeCurrentListeningSystem,
   requestNodeJoinSystem,
 } from "../../modules/socketServerWrappers.mjs";
@@ -86,9 +85,8 @@ export const getAvailableNodes = async (nodeIo, guildId, system) => {
     openSockets.map(async (openSocket) => {
       openSocket = await nodeIo.sockets.sockets.get(openSocket);
       // Check if the node has an existing open client (meaning the radio is already being listened to)
-      const hasOpenClient = await checkIfNodeHasOpenDiscordClient(openSocket);
-      if (hasOpenClient) {
-        let currentSystem = await getNodeCurrentListeningSystem(openSocket);
+      let currentSystem = await getNodeCurrentListeningSystem(openSocket);
+      if (currentSystem) {
         if (currentSystem != system.name) {
           log.INFO(
             "Node is listening to a different system than requested",

test/socketServerWrappers.test.js

@@ -4,11 +4,11 @@ import ioClient from "socket.io-client";
 import {
   deleteNodeByNuid,
   getNodeByNuid,
-} from "../modules/mongo-wrappers/mongoNodesWrappers.mjs";
+} from "../src/modules/mongo-wrappers/mongoNodesWrappers.mjs";
 import {
   deleteSystemByName,
   getSystemByName,
-} from "../modules/mongo-wrappers/mongoSystemsWrappers.mjs";
+} from "../src/modules/mongo-wrappers/mongoSystemsWrappers.mjs";
 import {
   nodeDisconnectWrapper,
   checkIfNodeHasOpenDiscordClient,
@@ -19,8 +19,8 @@ import {
   requestBotLeaveServer,
   requestNodeJoinSystem,
   requestNodeUpdate,
-} from "../modules/socketServerWrappers.mjs";
-import { nodeIo } from "../modules/socketServer.mjs";
+} from "../src/modules/socketServerWrappers.mjs";
+import { nodeIo } from "../src/modules/socketServer.mjs";
 
 import dotenv from "dotenv";
 dotenv.config();