Add support for consts in jsdoc

Author: Ed-Marcavage

scripts/jsdoc-automation/src/AIService.ts

@@ -0,0 +1,112 @@
+import { ChatOpenAI } from "@langchain/openai";
+import dotenv from "dotenv";
+import { Configuration } from "../Configuration.js";
+import { TypeScriptParser } from "../TypeScriptParser.js";
+import { CodeFormatter } from "./utils/CodeFormatter.js";
+import { DocumentOrganizer } from "./utils/DocumentOrganizer.js";
+
+dotenv.config();
+
+/**
+ * Service for interacting with OpenAI chat API.
+ */
+export class AIService {
+    private chatModel: ChatOpenAI;
+    private typeScriptParser: TypeScriptParser;
+    private codeFormatter: CodeFormatter;
+    private documentOrganizer: DocumentOrganizer;
+
+    /**
+     * Constructor for initializing the ChatOpenAI instance.
+     *
+     * @param {Configuration} configuration - The configuration instance to be used
+     * @throws {Error} If OPENAI_API_KEY environment variable is not set
+     */
+    constructor(private configuration: Configuration) {
+        if (!process.env.OPENAI_API_KEY) {
+            throw new Error("OPENAI_API_KEY is not set");
+        }
+        this.chatModel = new ChatOpenAI({ apiKey: process.env.OPENAI_API_KEY });
+        this.typeScriptParser = new TypeScriptParser();
+        this.codeFormatter = new CodeFormatter();
+        this.documentOrganizer = new DocumentOrganizer();
+    }
+
+    /**
+     * Generates a comment based on the specified prompt by invoking the chat model.
+     * @param {string} prompt - The prompt for which to generate a comment
+     * @returns {Promise<string>} The generated comment
+     */
+    public async generateComment(prompt: string): Promise<string> {
+        try {
+            // First try with generous limit
+            let finalPrompt = this.codeFormatter.truncateCodeBlock(prompt, 8000);
+
+            // Only append language instruction if not English
+            const normalizedLanguage = this.configuration.language
+                .toLowerCase()
+                .trim();
+            if (normalizedLanguage !== "english") {
+                finalPrompt += `\n\nEverything except the JSDoc conventions and code should be in ${this.configuration.language}`;
+            }
+
+            console.log(
+                `Generating comment for prompt of length: ${finalPrompt.length}`
+            );
+
+            try {
+                const response = await this.chatModel.invoke(finalPrompt);
+                return response.content as string;
+            } catch (error) {
+                if (
+                    error instanceof Error &&
+                    error.message.includes("maximum context length")
+                ) {
+                    console.warn(
+                        "Token limit exceeded, attempting with further truncation..."
+                    );
+                    // Try with more aggressive truncation
+                    finalPrompt = this.codeFormatter.truncateCodeBlock(prompt, 4000);
+                    try {
+                        const response =
+                            await this.chatModel.invoke(finalPrompt);
+                        return response.content as string;
+                    } catch (retryError) {
+                        if (
+                            retryError instanceof Error &&
+                            retryError.message.includes(
+                                "maximum context length"
+                            )
+                        ) {
+                            console.warn(
+                                "Still exceeding token limit, using minimal context..."
+                            );
+                            // Final attempt with minimal context
+                            finalPrompt = this.codeFormatter.truncateCodeBlock(prompt, 2000);
+                            const response =
+                                await this.chatModel.invoke(finalPrompt);
+                            return response.content as string;
+                        }
+                        throw retryError;
+                    }
+                }
+                throw error;
+            }
+        } catch (error) {
+            this.handleAPIError(error as Error);
+            return "";
+        }
+    }
+
+    /**
+     * Handle API errors by logging the error message and throwing the error.
+     *
+     *
+     * @param {Error} error The error object to handle
+     * @returns {void}
+     */
+    public handleAPIError(error: Error): void {
+        console.error("API Error:", error.message);
+        throw error;
+    }
+}