nodebb-plugin-openai 1.3.1 → 1.4.0

package/eslint.config.mjs

@@ -0,0 +1,10 @@
+'use strict';
+
+import serverConfig from 'eslint-config-nodebb';
+import publicConfig from 'eslint-config-nodebb/public';
+
+export default [
+	...publicConfig,
+	...serverConfig,
+];
+

package/lib/summary.js

@@ -8,7 +8,7 @@ const user = require.main.require('./src/user');
 
 function formatPosts(posts) {
 	return posts
-		.map((post) => `User ${post.username}:\n${post.content}`)
+		.map(post => `User ${post.username}:\n${post.content}`)
 		.join('\n---\n');
 }
 
@@ -17,7 +17,6 @@ function chunkPosts(posts, maxTokensPerChunk = 3000) {
 	let currentChunk = [];
 	let currentTokens = 0;
 
-	// eslint-disable-next-line no-restricted-syntax
 	for (const post of posts) {
 		const estimatedTokens = Math.ceil(post.content.length / 4) + 10;
 		if (currentTokens + estimatedTokens > maxTokensPerChunk) {
@@ -59,7 +58,7 @@ async function summarizeChunk(chunk, openai, settings) {
 	return response.choices[0].message.content.trim();
 }
 
-exports.summarizeTopic = async function(tid, openai, settings) {
+exports.summarizeTopic = async function (tid, openai, settings) {
 	const allPids = await topics.getPids(tid);
 
 	const userMap = {};
@@ -68,11 +67,11 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 
 	await batch.processArray(allPids, async function (pids) {
 		let postData = await posts.getPostsFields(pids, ['uid', 'content', 'deleted']);
-		postData = postData.filter((p) => !p.deleted);
+		postData = postData.filter(p => !p.deleted);
 		const missingUids = [];
 		postData.forEach((p) => {
 			if (!userMap.hasOwnProperty(p.uid)) {
-				missingUids.push(p.uid)
+				missingUids.push(p.uid);
 			}
 		});
 		const userData = await user.getUsersFields(missingUids, ['username']);
@@ -86,7 +85,7 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 		const chunks = chunkPosts(postData);
 
 		chunkSummaries.push(...await Promise.all(chunks.map(async (chunk) => {
-			return summarizeChunk(chunk, openai, settings)
+			return summarizeChunk(chunk, openai, settings);
 		})));
 	}, {
 		batch: 500,
@@ -96,7 +95,7 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 		return chunkSummaries[0];
 	}
 	// Final summary from all summaries
-	const finalInput = chunkSummaries.join("\n\n");
+	const finalInput = chunkSummaries.join('\n\n');
 	if (!finalInput) {
 		return '';
 	}
@@ -118,6 +117,6 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 	return finalResponse.choices[0].message.content.trim();
 };
 
-exports.clearTopicSummary = async function(tids) {
-	await db.deleteObjectFields(tids.map((tid) => `topic:${tid}`), ['openai:summary']);
+exports.clearTopicSummary = async function (tids) {
+	await db.deleteObjectFields(tids.map(tid => `topic:${tid}`), ['openai:summary']);
 };

package/library.js

@@ -34,18 +34,27 @@ const defaults = {
 
 plugin.init = async (params) => {
 	const { router /* , middleware , controllers */ } = params;
-	const settings = await meta.settings.get('openai')
+	const settings = await meta.settings.get('openai');
 	if (settings && settings.apikey) {
 		openai = new OpenAI({
 			apiKey: settings.apikey,
+			baseURL: settings.apiBaseUrl || 'https://api.openai.com/v1',
 		});
+
+		// Uncomment the following lines to list available models
+		// const list = await openai.models.list();
+		// for await (const model of list) {
+		// console.log(model.id);
+		// }
+
+		plugin.openai = openai;
 	}
 
 	routeHelpers.setupAdminPageRoute(router, '/admin/plugins/openai', controllers.renderAdminPage);
 };
 
 async function getSettings() {
-	const settings = await meta.settings.get('openai')
+	const settings = await meta.settings.get('openai');
 	return {...defaults, ...settings };
 }
 
@@ -150,7 +159,7 @@ plugin.actionMessagingSave = async function (hookData) {
 			let messages = await messaging.getMessagesFields(mids, ['fromuid', 'content', 'system']);
 			messages = messages.filter(m => m && !m.system);
 			conversation = messages.map(
-				(msg) => ({ role: msg.fromuid === chatgptUid ? 'assistant' : 'user', content: msg.content })
+				msg => ({ role: msg.fromuid === chatgptUid ? 'assistant' : 'user', content: msg.content })
 			);
 		}
 
@@ -180,7 +189,8 @@ async function canUseOpenAI(uid, settings, silent = false) {
 
 async function checkReputation(uid, settings, silent) {
 	const reputation = await user.getUserField(uid, 'reputation');
-	const hasEnoughRep = parseInt(settings.minimumReputation, 10) === 0 || parseInt(reputation, 10) >= parseInt(settings.minimumReputation, 10);
+	const hasEnoughRep = parseInt(settings.minimumReputation, 10) === 0 ||
+		parseInt(reputation, 10) >= parseInt(settings.minimumReputation, 10);
 
 	if (!hasEnoughRep && !silent) {
 		sockets.server.in(`uid_${uid}`).emit('event:alert', {

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "nodebb-plugin-openai",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "A NodeBB OpenAI plugin",
   "main": "library.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/nodebb/nodebb-plugin-openai"
   },
+  "scripts": {
+    "lint": "eslint ."
+  },
   "keywords": [
     "nodebb",
     "plugin",
@@ -30,17 +33,16 @@
   },
   "readmeFilename": "README.md",
   "nbbpm": {
-    "compatibility": "^3.2.0"
+    "compatibility": "^3.2.0 || ^4.0.0"
   },
   "dependencies": {
-    "openai": "4.53.2"
+    "openai": "4.103.0"
   },
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
     "@commitlint/config-angular": "19.3.0",
-    "eslint": "8.57.0",
-    "eslint-config-nodebb": "0.2.1",
-    "eslint-plugin-import": "2.29.1",
+    "eslint": "9.26.0",
+    "eslint-config-nodebb": "^1.1.4",
     "husky": "9.0.11",
     "lint-staged": "15.2.7"
   }

package/templates/admin/plugins/openai.tpl

@@ -11,9 +11,18 @@
 						<label class="form-label" for="apikey">API Key</label>
 						<input type="text" id="apikey" name="apikey" title="API Key" class="form-control">
 						<p class="form-text">
-							Get your <a href="https://platform.openai.com/api-keys">API Key</a> and enter it above. Requires a restart.
+							Get your <a href="https://platform.openai.com/api-keys">API Key</a> and enter it above. You can enter a Google Gemini API key if you want to use Google Gemini. Don't forget to change the model used to a gemini variant. Requires a restart.
 						</p>
 					</div>
+
+					<div class="mb-3">
+						<label class="form-label" for="apiBaseUrl">API Base Url</label>
+						<input type="text" id="apiBaseUrl" name="apiBaseUrl" title="API Base Url" class="form-control">
+						<p class="form-text">
+							If you want to use Google's Gemini API, enter the base URL here (https://generativelanguage.googleapis.com/v1beta/openai/). Otherwise, leave it blank to use OpenAI's API. Requires a restart.
+						</p>
+					</div>
+
 					<div class="mb-3">
 						<label class="form-label" for="chatgpt-username">ChatGPT Username</label>
 						<input type="text" id="chatgpt-username" name="chatgpt-username" title="ChatGPT Username" class="form-control">
@@ -38,6 +47,9 @@
 							<option value="gpt-4o">gpt-4o</option>
 							<option value="gpt-4-turbo">gpt-4-turbo</option>
 							<option value="gpt-4">gpt-4</option>
+							<option value="gpt-4.1-mini">gpt-4.1-mini</option>
+							<option value="gpt-4.1">gpt-4.1</option>
+							<option value="gemini-2.0-flash">gemini-2.0-flash</option>
 						</select>
 					</div>
 					<div class="">

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "nodebb/public"
-}

package/public/lib/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "nodebb/public"
-}