@gitsense/gsc-utils 0.2.6 → 0.2.7

package/dist/gsc-utils.cjs.js

@@ -18,8 +18,8 @@ function getDefaultExportFromCjs (x) {
  * Authors: Claude 3.7 Sonnet (v1.0.0), Gemini 2.5 Pro (v1.1.0), Gemini 2.5 Flash Thinking (v1.2.0)
  */
 
-const fs$6 = require$$0;
-const path$4 = require$$1;
+const fs$7 = require$$0;
+const path$5 = require$$1;
 const ANALYZE_MESSAGE_REGEXP = /^# Analyze - `([^`]+)`\n/;
 
 /**
@@ -53,12 +53,12 @@ function unescapeCodeBlocks(content) {
  * @returns {Array} An array of message objects with role and content properties
  */
 function getChatTemplateMessages$1(dirname, messageType) {
-    const messagesDir = path$4.join(dirname, messageType);
+    const messagesDir = path$5.join(dirname, messageType);
     const messages = [];
 
     try {
         // Read all files in the directory
-        const files = fs$6.readdirSync(messagesDir);
+        const files = fs$7.readdirSync(messagesDir);
 
         // Sort files numerically (1.md, 2.md, etc.)
         const sortedFiles = files.sort((a, b) => {
@@ -69,9 +69,9 @@ function getChatTemplateMessages$1(dirname, messageType) {
 
         // Process each file
         for (const file of sortedFiles) {
-            if (path$4.extname(file) === '.md') {
-                const filePath = path$4.join(messagesDir, file);
-                const fileContent = fs$6.readFileSync(filePath, 'utf8');
+            if (path$5.extname(file) === '.md') {
+                const filePath = path$5.join(messagesDir, file);
+                const fileContent = fs$7.readFileSync(filePath, 'utf8');
 
                 // Split by triple newline to separate metadata from content
                 const parts = fileContent.split('\n\n\n');
@@ -10925,8 +10925,8 @@ var dataValidator = {
  * Authors: Gemini 2.5 Flash (v1.0.0)
  */
 
-const fs$5 = require$$0.promises;
-const path$3 = require$$1;
+const fs$6 = require$$0.promises;
+const path$4 = require$$1;
 
 /**
  * Reads and parses the config.json file in a directory.
@@ -10935,9 +10935,9 @@ const path$3 = require$$1;
  *                                 or null if the file doesn't exist or is invalid.
  */
 async function readConfig$1(dirPath) {
-    const configPath = path$3.join(dirPath, 'config.json');
+    const configPath = path$4.join(dirPath, 'config.json');
     try {
-        const fileContent = await fs$5.readFile(configPath, 'utf8');
+        const fileContent = await fs$6.readFile(configPath, 'utf8');
         return JSON.parse(fileContent);
     } catch (error) {
         if (error.code !== 'ENOENT') {
@@ -10974,41 +10974,41 @@ async function getAnalyzers$2(analyzeMessagesBasePath) {
     const analyzers = [];
 
     try {
-        const analyzerEntries = await fs$5.readdir(analyzeMessagesBasePath, { withFileTypes: true });
+        const analyzerEntries = await fs$6.readdir(analyzeMessagesBasePath, { withFileTypes: true });
 
         for (const analyzerEntry of analyzerEntries) {
             if (analyzerEntry.isDirectory() && isValidDirName(analyzerEntry.name)) {
                 const analyzerName = analyzerEntry.name;
-                const analyzerPath = path$3.join(analyzeMessagesBasePath, analyzerName);
+                const analyzerPath = path$4.join(analyzeMessagesBasePath, analyzerName);
                 const analyzerConfig = await readConfig$1(analyzerPath);
                 const analyzerLabel = analyzerConfig?.label || analyzerName;
 
-                const contentEntries = await fs$5.readdir(analyzerPath, { withFileTypes: true });
+                const contentEntries = await fs$6.readdir(analyzerPath, { withFileTypes: true });
 
                 for (const contentEntry of contentEntries) {
                     if (contentEntry.isDirectory() && isValidDirName(contentEntry.name)) {
                         const contentType = contentEntry.name;
-                        const contentPath = path$3.join(analyzerPath, contentType);
+                        const contentPath = path$4.join(analyzerPath, contentType);
                         const contentConfig = await readConfig$1(contentPath);
                         const contentLabel = contentConfig?.label || contentType;
 
-                        const instructionsEntries = await fs$5.readdir(contentPath, { withFileTypes: true });
+                        const instructionsEntries = await fs$6.readdir(contentPath, { withFileTypes: true });
 
                         for (const instructionsEntry of instructionsEntries) {
                             if (instructionsEntry.isDirectory() && isValidDirName(instructionsEntry.name)) {
                                 const instructionsType = instructionsEntry.name;
-                                const instructionsPath = path$3.join(contentPath, instructionsType);
+                                const instructionsPath = path$4.join(contentPath, instructionsType);
                                 const instructionsConfig = await readConfig$1(instructionsPath);
                                 const instructionsLabel = instructionsConfig?.label || instructionsType;
 
                                 // Check for the existence of 1.md to confirm a valid analyzer configuration
-                                const instructionsFilePath = path$3.join(instructionsPath, '1.md');
+                                const instructionsFilePath = path$4.join(instructionsPath, '1.md');
                                 try {
-                                    await fs$5.access(instructionsFilePath); // Check if file exists and is accessible
+                                    await fs$6.access(instructionsFilePath); // Check if file exists and is accessible
 
                                     // If analyzerName starts with 'tutorial-', check its last modified time.
                                     if (analyzerName.startsWith('tutorial-')) {
-                                        const stats = await fs$5.stat(instructionsFilePath);
+                                        const stats = await fs$6.stat(instructionsFilePath);
                                         const lastModified = stats.mtime.getTime(); // Get timestamp in milliseconds
                                         const sixtyMinutesAgo = Date.now() - (60 * 60 * 1000); // Current time - 60 minutes in ms
 
@@ -11062,12 +11062,128 @@ var discovery = {
  * Authors: Gemini 2.5 Flash Thinking (v1.0.0), Gemini 2.5 Flash Thinking (v1.1.0)
  */
 
-require$$0.promises;
+const fs$5 = require$$0.promises;
+const path$3 = require$$1;
 
+/**
+ * Saves or updates an analyzer configuration.
+ *
+ * This function takes the analyzer ID and its full instructions content,
+ * parses the ID to determine the directory structure, creates directories
+ * if necessary, saves the instructions to '1.md'. Optionally, it can
+ * ensure config.json files exist with labels derived from directory names.
+ *
+ * @param {string} analyzeMessagesBasePath - The absolute or relative path to the 'messages/analyze' directory.
+ * @param {string} analyzerId - The unique ID of the analyzer (format: 'analyzer_name::content_type::instructions_type').
+ * @param {string} instructionsContent - The full content of the analyzer instructions message to be saved in '1.md'.
+ * @param {object} [options={}] - Optional configuration options.
+ * @param {boolean} [options.ensureConfigs=false] - If true, ensures config.json files exist in the analyzer, content, and instructions directories. Defaults to false.
+ * @returns {Promise<{success: boolean, message?: string}>} A promise that resolves with a result object.
+ */
+async function saveConfiguration$1(analyzeMessagesBasePath, analyzerId, instructionsContent, options = {}) {
+    const { ensureConfigs = false } = options;
 
-var saver = {
+    // 1. Validate inputs
+    if (typeof analyzeMessagesBasePath !== 'string' || analyzeMessagesBasePath.trim() === '') {
+        return { success: false, message: 'analyzeMessagesBasePath is required.' };
+    }
+    if (typeof analyzerId !== 'string' || analyzerId.trim() === '') {
+        return { success: false, message: 'analyzerId is required.' };
+    }
+    if (typeof instructionsContent !== 'string' || instructionsContent.trim() === '') {
+        return { success: false, message: 'instructionsContent is required.' };
+    }
+
+    // 2. Parse analyzerId
+    const parts = analyzerId.split('::');
+    if (parts.length !== 3) {
+        return { success: false, message: `Invalid analyzerId format. Expected 'analyzer_name::content_type::instructions_type', but got '${analyzerId}'.` };
+    }
+    const [analyzerName, contentType, instructionsType] = parts;
+
+    // Helper to validate directory names based on README.md rules
+    const isValidDirName = (name) => {
+        // Cannot start with underscore, cannot contain dots, must be alphanumeric, dash, or underscore
+        return /^[a-zA-Z0-9_-]+$/.test(name) && !name.startsWith('_') && !name.includes('.');
     };
 
+    if (!isValidDirName(analyzerName)) {
+        return { success: false, message: `Invalid analyzer name '${analyzerName}'. Names must be alphanumeric, dash, or underscore, cannot start with underscore, and cannot contain dots.` };
+    }
+    if (!isValidDirName(contentType)) {
+        return { success: false, message: `Invalid content type name '${contentType}'. Names must be alphanumeric, dash, or underscore, cannot start with underscore, and cannot contain dots.` };
+    }
+    if (!isValidDirName(instructionsType)) {
+        return { success: false, message: `Invalid instructions type name '${instructionsType}'. Names must be alphanumeric, dash, or underscore, cannot start with underscore, and cannot contain dots.` };
+    }
+
+    // 3. Construct directory paths
+    const analyzerDir = path$3.join(analyzeMessagesBasePath, analyzerName);
+    const contentDir = path$3.join(analyzerDir, contentType);
+    const instructionsDir = path$3.join(contentDir, instructionsType);
+    const instructionsFilePath = path$3.join(instructionsDir, '1.md');
+
+    try {
+        // 4. Create directories recursively
+        await fs$5.mkdir(instructionsDir, { recursive: true });
+
+        // 5. Save instructions content to 1.md
+        const finalContent = `; role: assistant\n\n\n${instructionsContent}`; 
+        await fs$5.writeFile(instructionsFilePath, finalContent, 'utf8');
+
+        // 6. Optionally create/Update config.json files
+        if (ensureConfigs) {
+            await ensureConfigJson(analyzerDir, analyzerName);
+            await ensureConfigJson(contentDir, contentType);
+            await ensureConfigJson(instructionsDir, instructionsType);
+        }
+
+        return { success: true, message: `Analyzer configuration '${analyzerId}' saved successfully.` };
+
+    } catch (error) {
+        console.error(`Error saving analyzer configuration '${analyzerId}':`, error);
+        return { success: false, message: `Failed to save analyzer configuration: ${error.message}` };
+    }
+}
+
+/**
+ * Ensures a config.json file exists in the given directory with a label.
+ * If the file exists, it reads it and adds the label if missing.
+ * If the file doesn't exist, it creates it with the label.
+ *
+ * @param {string} dirPath - The path to the directory.
+ * @param {string} label - The label to ensure is in the config.json.
+ */
+async function ensureConfigJson(dirPath, label) {
+    const configPath = path$3.join(dirPath, 'config.json');
+    let config = {};
+
+    try {
+        const fileContent = await fs$5.readFile(configPath, 'utf8');
+        config = JSON.parse(fileContent);
+    } catch (error) {
+        // If file doesn't exist or parsing fails, start with an empty config
+        if (error.code !== 'ENOENT') {
+            console.warn(`Failed to read or parse existing config.json in ${dirPath}: ${error.message}`);
+        }
+        config = {}; // Ensure config is an object even on error
+    }
+
+    // Add or update the label if it's missing or empty
+    if (!config.label || typeof config.label !== 'string' || config.label.trim() === '') {
+         // Capitalize the first letter for the label
+        config.label = label.charAt(0).toUpperCase() + label.slice(1);
+    }
+
+    // Write the updated config back to the file
+    await fs$5.writeFile(configPath, JSON.stringify(config, null, 4), 'utf8');
+}
+
+
+var saver = {
+    saveConfiguration: saveConfiguration$1,
+};
+
 /*
  * Component: AnalyzerUtils Schema Loader
  * Block-UUID: 0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f

package/dist/gsc-utils.esm.js

@@ -16,8 +16,8 @@ function getDefaultExportFromCjs (x) {
  * Authors: Claude 3.7 Sonnet (v1.0.0), Gemini 2.5 Pro (v1.1.0), Gemini 2.5 Flash Thinking (v1.2.0)
  */
 
-const fs$6 = require$$0;
-const path$4 = require$$1;
+const fs$7 = require$$0;
+const path$5 = require$$1;
 const ANALYZE_MESSAGE_REGEXP = /^# Analyze - `([^`]+)`\n/;
 
 /**
@@ -51,12 +51,12 @@ function unescapeCodeBlocks(content) {
  * @returns {Array} An array of message objects with role and content properties
  */
 function getChatTemplateMessages$1(dirname, messageType) {
-    const messagesDir = path$4.join(dirname, messageType);
+    const messagesDir = path$5.join(dirname, messageType);
     const messages = [];
 
     try {
         // Read all files in the directory
-        const files = fs$6.readdirSync(messagesDir);
+        const files = fs$7.readdirSync(messagesDir);
 
         // Sort files numerically (1.md, 2.md, etc.)
         const sortedFiles = files.sort((a, b) => {
@@ -67,9 +67,9 @@ function getChatTemplateMessages$1(dirname, messageType) {
 
         // Process each file
         for (const file of sortedFiles) {
-            if (path$4.extname(file) === '.md') {
-                const filePath = path$4.join(messagesDir, file);
-                const fileContent = fs$6.readFileSync(filePath, 'utf8');
+            if (path$5.extname(file) === '.md') {
+                const filePath = path$5.join(messagesDir, file);
+                const fileContent = fs$7.readFileSync(filePath, 'utf8');
 
                 // Split by triple newline to separate metadata from content
                 const parts = fileContent.split('\n\n\n');
@@ -10923,8 +10923,8 @@ var dataValidator = {
  * Authors: Gemini 2.5 Flash (v1.0.0)
  */
 
-const fs$5 = require$$0.promises;
-const path$3 = require$$1;
+const fs$6 = require$$0.promises;
+const path$4 = require$$1;
 
 /**
  * Reads and parses the config.json file in a directory.
@@ -10933,9 +10933,9 @@ const path$3 = require$$1;
  *                                 or null if the file doesn't exist or is invalid.
  */
 async function readConfig$1(dirPath) {
-    const configPath = path$3.join(dirPath, 'config.json');
+    const configPath = path$4.join(dirPath, 'config.json');
     try {
-        const fileContent = await fs$5.readFile(configPath, 'utf8');
+        const fileContent = await fs$6.readFile(configPath, 'utf8');
         return JSON.parse(fileContent);
     } catch (error) {
         if (error.code !== 'ENOENT') {
@@ -10972,41 +10972,41 @@ async function getAnalyzers$2(analyzeMessagesBasePath) {
     const analyzers = [];
 
     try {
-        const analyzerEntries = await fs$5.readdir(analyzeMessagesBasePath, { withFileTypes: true });
+        const analyzerEntries = await fs$6.readdir(analyzeMessagesBasePath, { withFileTypes: true });
 
         for (const analyzerEntry of analyzerEntries) {
             if (analyzerEntry.isDirectory() && isValidDirName(analyzerEntry.name)) {
                 const analyzerName = analyzerEntry.name;
-                const analyzerPath = path$3.join(analyzeMessagesBasePath, analyzerName);
+                const analyzerPath = path$4.join(analyzeMessagesBasePath, analyzerName);
                 const analyzerConfig = await readConfig$1(analyzerPath);
                 const analyzerLabel = analyzerConfig?.label || analyzerName;
 
-                const contentEntries = await fs$5.readdir(analyzerPath, { withFileTypes: true });
+                const contentEntries = await fs$6.readdir(analyzerPath, { withFileTypes: true });
 
                 for (const contentEntry of contentEntries) {
                     if (contentEntry.isDirectory() && isValidDirName(contentEntry.name)) {
                         const contentType = contentEntry.name;
-                        const contentPath = path$3.join(analyzerPath, contentType);
+                        const contentPath = path$4.join(analyzerPath, contentType);
                         const contentConfig = await readConfig$1(contentPath);
                         const contentLabel = contentConfig?.label || contentType;
 
-                        const instructionsEntries = await fs$5.readdir(contentPath, { withFileTypes: true });
+                        const instructionsEntries = await fs$6.readdir(contentPath, { withFileTypes: true });
 
                         for (const instructionsEntry of instructionsEntries) {
                             if (instructionsEntry.isDirectory() && isValidDirName(instructionsEntry.name)) {
                                 const instructionsType = instructionsEntry.name;
-                                const instructionsPath = path$3.join(contentPath, instructionsType);
+                                const instructionsPath = path$4.join(contentPath, instructionsType);
                                 const instructionsConfig = await readConfig$1(instructionsPath);
                                 const instructionsLabel = instructionsConfig?.label || instructionsType;
 
                                 // Check for the existence of 1.md to confirm a valid analyzer configuration
-                                const instructionsFilePath = path$3.join(instructionsPath, '1.md');
+                                const instructionsFilePath = path$4.join(instructionsPath, '1.md');
                                 try {
-                                    await fs$5.access(instructionsFilePath); // Check if file exists and is accessible
+                                    await fs$6.access(instructionsFilePath); // Check if file exists and is accessible
 
                                     // If analyzerName starts with 'tutorial-', check its last modified time.
                                     if (analyzerName.startsWith('tutorial-')) {
-                                        const stats = await fs$5.stat(instructionsFilePath);
+                                        const stats = await fs$6.stat(instructionsFilePath);
                                         const lastModified = stats.mtime.getTime(); // Get timestamp in milliseconds
                                         const sixtyMinutesAgo = Date.now() - (60 * 60 * 1000); // Current time - 60 minutes in ms
 
@@ -11060,12 +11060,128 @@ var discovery = {
  * Authors: Gemini 2.5 Flash Thinking (v1.0.0), Gemini 2.5 Flash Thinking (v1.1.0)
  */
 
-require$$0.promises;
+const fs$5 = require$$0.promises;
+const path$3 = require$$1;
 
+/**
+ * Saves or updates an analyzer configuration.
+ *
+ * This function takes the analyzer ID and its full instructions content,
+ * parses the ID to determine the directory structure, creates directories
+ * if necessary, saves the instructions to '1.md'. Optionally, it can
+ * ensure config.json files exist with labels derived from directory names.
+ *
+ * @param {string} analyzeMessagesBasePath - The absolute or relative path to the 'messages/analyze' directory.
+ * @param {string} analyzerId - The unique ID of the analyzer (format: 'analyzer_name::content_type::instructions_type').
+ * @param {string} instructionsContent - The full content of the analyzer instructions message to be saved in '1.md'.
+ * @param {object} [options={}] - Optional configuration options.
+ * @param {boolean} [options.ensureConfigs=false] - If true, ensures config.json files exist in the analyzer, content, and instructions directories. Defaults to false.
+ * @returns {Promise<{success: boolean, message?: string}>} A promise that resolves with a result object.
+ */
+async function saveConfiguration$1(analyzeMessagesBasePath, analyzerId, instructionsContent, options = {}) {
+    const { ensureConfigs = false } = options;
 
-var saver = {
+    // 1. Validate inputs
+    if (typeof analyzeMessagesBasePath !== 'string' || analyzeMessagesBasePath.trim() === '') {
+        return { success: false, message: 'analyzeMessagesBasePath is required.' };
+    }
+    if (typeof analyzerId !== 'string' || analyzerId.trim() === '') {
+        return { success: false, message: 'analyzerId is required.' };
+    }
+    if (typeof instructionsContent !== 'string' || instructionsContent.trim() === '') {
+        return { success: false, message: 'instructionsContent is required.' };
+    }
+
+    // 2. Parse analyzerId
+    const parts = analyzerId.split('::');
+    if (parts.length !== 3) {
+        return { success: false, message: `Invalid analyzerId format. Expected 'analyzer_name::content_type::instructions_type', but got '${analyzerId}'.` };
+    }
+    const [analyzerName, contentType, instructionsType] = parts;
+
+    // Helper to validate directory names based on README.md rules
+    const isValidDirName = (name) => {
+        // Cannot start with underscore, cannot contain dots, must be alphanumeric, dash, or underscore
+        return /^[a-zA-Z0-9_-]+$/.test(name) && !name.startsWith('_') && !name.includes('.');
     };
 
+    if (!isValidDirName(analyzerName)) {
+        return { success: false, message: `Invalid analyzer name '${analyzerName}'. Names must be alphanumeric, dash, or underscore, cannot start with underscore, and cannot contain dots.` };
+    }
+    if (!isValidDirName(contentType)) {
+        return { success: false, message: `Invalid content type name '${contentType}'. Names must be alphanumeric, dash, or underscore, cannot start with underscore, and cannot contain dots.` };
+    }
+    if (!isValidDirName(instructionsType)) {
+        return { success: false, message: `Invalid instructions type name '${instructionsType}'. Names must be alphanumeric, dash, or underscore, cannot start with underscore, and cannot contain dots.` };
+    }
+
+    // 3. Construct directory paths
+    const analyzerDir = path$3.join(analyzeMessagesBasePath, analyzerName);
+    const contentDir = path$3.join(analyzerDir, contentType);
+    const instructionsDir = path$3.join(contentDir, instructionsType);
+    const instructionsFilePath = path$3.join(instructionsDir, '1.md');
+
+    try {
+        // 4. Create directories recursively
+        await fs$5.mkdir(instructionsDir, { recursive: true });
+
+        // 5. Save instructions content to 1.md
+        const finalContent = `; role: assistant\n\n\n${instructionsContent}`; 
+        await fs$5.writeFile(instructionsFilePath, finalContent, 'utf8');
+
+        // 6. Optionally create/Update config.json files
+        if (ensureConfigs) {
+            await ensureConfigJson(analyzerDir, analyzerName);
+            await ensureConfigJson(contentDir, contentType);
+            await ensureConfigJson(instructionsDir, instructionsType);
+        }
+
+        return { success: true, message: `Analyzer configuration '${analyzerId}' saved successfully.` };
+
+    } catch (error) {
+        console.error(`Error saving analyzer configuration '${analyzerId}':`, error);
+        return { success: false, message: `Failed to save analyzer configuration: ${error.message}` };
+    }
+}
+
+/**
+ * Ensures a config.json file exists in the given directory with a label.
+ * If the file exists, it reads it and adds the label if missing.
+ * If the file doesn't exist, it creates it with the label.
+ *
+ * @param {string} dirPath - The path to the directory.
+ * @param {string} label - The label to ensure is in the config.json.
+ */
+async function ensureConfigJson(dirPath, label) {
+    const configPath = path$3.join(dirPath, 'config.json');
+    let config = {};
+
+    try {
+        const fileContent = await fs$5.readFile(configPath, 'utf8');
+        config = JSON.parse(fileContent);
+    } catch (error) {
+        // If file doesn't exist or parsing fails, start with an empty config
+        if (error.code !== 'ENOENT') {
+            console.warn(`Failed to read or parse existing config.json in ${dirPath}: ${error.message}`);
+        }
+        config = {}; // Ensure config is an object even on error
+    }
+
+    // Add or update the label if it's missing or empty
+    if (!config.label || typeof config.label !== 'string' || config.label.trim() === '') {
+         // Capitalize the first letter for the label
+        config.label = label.charAt(0).toUpperCase() + label.slice(1);
+    }
+
+    // Write the updated config back to the file
+    await fs$5.writeFile(configPath, JSON.stringify(config, null, 4), 'utf8');
+}
+
+
+var saver = {
+    saveConfiguration: saveConfiguration$1,
+};
+
 /*
  * Component: AnalyzerUtils Schema Loader
  * Block-UUID: 0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitsense/gsc-utils",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "Utilities for GitSense Chat (GSC)",
   "main": "dist/gsc-utils.cjs.js",
   "module": "dist/gsc-utils.esm.js",

package/src/AnalyzerUtils/saver.js

@@ -28,7 +28,7 @@ const path = require('path');
  * @param {boolean} [options.ensureConfigs=false] - If true, ensures config.json files exist in the analyzer, content, and instructions directories. Defaults to false.
  * @returns {Promise<{success: boolean, message?: string}>} A promise that resolves with a result object.
  */
-async function saveAnalyzerConfiguration(analyzeMessagesBasePath, analyzerId, instructionsContent, options = {}) {
+async function saveConfiguration(analyzeMessagesBasePath, analyzerId, instructionsContent, options = {}) {
     const { ensureConfigs = false } = options;
 
     // 1. Validate inputs
@@ -129,5 +129,5 @@ async function ensureConfigJson(dirPath, label) {
 
 
 module.exports = {
-    saveAnalyzerConfiguration,
+    saveConfiguration,
 };