@codebolt/codeboltjs 2.0.12 → 2.0.15

package/dist/notificationfunctions/crawler.js

@@ -0,0 +1,159 @@
+"use strict";
+/**
+ * Crawler Notification Functions
+ *
+ * This module provides functions for sending crawler-related notifications,
+ * including web crawling search operations and crawler initialization.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.crawlerNotifications = exports.CrawlerStartResponseNotify = exports.CrawlerStartRequestNotify = exports.CrawlerSearchResponseNotify = exports.CrawlerSearchRequestNotify = void 0;
+const utils_1 = require("./utils");
+/**
+ * Sends a request to perform a crawler search
+ *
+ * @param url - The URL to crawl
+ * @param searchQuery - Optional search query
+ * @param maxDepth - Optional maximum crawl depth
+ * @param maxPages - Optional maximum pages to crawl
+ * @param includeSubdomains - Optional flag to include subdomains
+ * @param followRedirects - Optional flag to follow redirects
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 5.1 - WHEN I call `codebolt.notify.crawler.CrawlerSearchRequestNotify()` THEN the system SHALL send a CrawlerSearchRequestNotification via WebSocket
+ */
+function CrawlerSearchRequestNotify(url, searchQuery, maxDepth, maxPages, includeSubdomains, followRedirects, toolUseId) {
+    // Validate required fields
+    if (!(0, utils_1.validateRequiredFields)({ url }, ['url'], 'crawler.CrawlerSearchRequestNotify')) {
+        return;
+    }
+    // Validate URL format
+    try {
+        new URL(url);
+    }
+    catch (error) {
+        console.error('[NotificationFunctions] Invalid URL format for crawler.CrawlerSearchRequestNotify:', url);
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "crawlernotify",
+        action: "crawlerSearchRequest",
+        data: {
+            url: url,
+            searchQuery: searchQuery,
+            maxDepth: maxDepth,
+            maxPages: maxPages,
+            includeSubdomains: includeSubdomains,
+            followRedirects: followRedirects
+        }
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'crawler.CrawlerSearchRequestNotify');
+}
+exports.CrawlerSearchRequestNotify = CrawlerSearchRequestNotify;
+/**
+ * Sends a response to a crawler search request
+ *
+ * @param content - The response content (string or any object)
+ * @param isError - Whether this is an error response (default: false)
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ * @param data - Optional response data containing pages, totalPages, and crawlTime
+ *
+ * Requirements: 5.2 - WHEN I call `codebolt.notify.crawler.CrawlerSearchResponseNotify()` THEN the system SHALL send a CrawlerSearchResponseNotification via WebSocket
+ */
+function CrawlerSearchResponseNotify(content, isError = false, toolUseId, data) {
+    // Validate content is provided
+    if (content === null || content === undefined) {
+        console.error('[NotificationFunctions] Content is required for crawler.CrawlerSearchResponseNotify');
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "crawlernotify",
+        action: "crawlerSearchResult",
+        content: content,
+        isError: isError,
+        data: data
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'crawler.CrawlerSearchResponseNotify');
+}
+exports.CrawlerSearchResponseNotify = CrawlerSearchResponseNotify;
+/**
+ * Sends a request to start a crawler
+ *
+ * @param startUrl - The URL to start crawling from
+ * @param options - Optional crawler configuration options
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 5.3 - WHEN I call `codebolt.notify.crawler.CrawlerStartRequestNotify()` THEN the system SHALL send a CrawlerStartRequestNotification via WebSocket
+ */
+function CrawlerStartRequestNotify(startUrl, options, toolUseId) {
+    // Validate required fields
+    if (!(0, utils_1.validateRequiredFields)({ startUrl }, ['startUrl'], 'crawler.CrawlerStartRequestNotify')) {
+        return;
+    }
+    // Validate URL format
+    try {
+        new URL(startUrl);
+    }
+    catch (error) {
+        console.error('[NotificationFunctions] Invalid URL format for crawler.CrawlerStartRequestNotify:', startUrl);
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "crawlernotify",
+        action: "crawlerStartRequest",
+        data: {
+            startUrl: startUrl,
+            options: options
+        }
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'crawler.CrawlerStartRequestNotify');
+}
+exports.CrawlerStartRequestNotify = CrawlerStartRequestNotify;
+/**
+ * Sends a response to a crawler start request
+ *
+ * @param content - The response content (string or any object)
+ * @param isError - Whether this is an error response (default: false)
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ * @param data - Optional response data containing sessionId and status
+ *
+ * Requirements: 5.4 - WHEN I call `codebolt.notify.crawler.CrawlerStartResponseNotify()` THEN the system SHALL send a CrawlerStartResponseNotification via WebSocket
+ */
+function CrawlerStartResponseNotify(content, isError = false, toolUseId, data) {
+    // Validate content is provided
+    if (content === null || content === undefined) {
+        console.error('[NotificationFunctions] Content is required for crawler.CrawlerStartResponseNotify');
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "crawlernotify",
+        action: "crawlerStartResult",
+        content: content,
+        isError: isError,
+        data: data
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'crawler.CrawlerStartResponseNotify');
+}
+exports.CrawlerStartResponseNotify = CrawlerStartResponseNotify;
+/**
+ * Crawler notification functions object
+ */
+exports.crawlerNotifications = {
+    CrawlerSearchRequestNotify,
+    CrawlerSearchResponseNotify,
+    CrawlerStartRequestNotify,
+    CrawlerStartResponseNotify
+};
+// Default export
+exports.default = exports.crawlerNotifications;

package/dist/notificationfunctions/dbmemory.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Database Memory Notification Functions
+ *
+ * This module provides functions for sending database memory-related notifications,
+ * including knowledge storage and retrieval operations.
+ */
+import { DbmemoryNotifications } from '../types/notificationFunctions/dbmemory';
+/**
+ * Sends a request to add knowledge to memory
+ *
+ * @param key - The memory key
+ * @param value - The memory value
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.1 - WHEN I call `codebolt.notify.dbmemory.AddMemoryRequestNotify()` THEN the system SHALL send an AddMemoryRequestNotification via WebSocket
+ */
+export declare function AddMemoryRequestNotify(key: string, value: any, toolUseId?: string): void;
+/**
+ * Sends a result response for an add memory operation
+ *
+ * @param content - The response content (string or any object)
+ * @param isError - Whether this is an error response (default: false)
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.2 - WHEN I call `codebolt.notify.dbmemory.AddMemoryResultNotify()` THEN the system SHALL send an AddMemoryResultNotification via WebSocket
+ */
+export declare function AddMemoryResultNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to get knowledge from memory
+ *
+ * @param key - The memory key to retrieve
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.3 - WHEN I call `codebolt.notify.dbmemory.GetMemoryRequestNotify()` THEN the system SHALL send a GetMemoryRequestNotification via WebSocket
+ */
+export declare function GetMemoryRequestNotify(key: string, toolUseId?: string): void;
+/**
+ * Sends a result response for a get memory operation
+ *
+ * @param content - The response content (string or any object)
+ * @param isError - Whether this is an error response (default: false)
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.4 - WHEN I call `codebolt.notify.dbmemory.GetMemoryResultNotify()` THEN the system SHALL send a GetMemoryResultNotification via WebSocket
+ */
+export declare function GetMemoryResultNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Database memory notification functions object
+ */
+export declare const dbmemoryNotifications: DbmemoryNotifications;

package/dist/notificationfunctions/dbmemory.js

@@ -0,0 +1,132 @@
+"use strict";
+/**
+ * Database Memory Notification Functions
+ *
+ * This module provides functions for sending database memory-related notifications,
+ * including knowledge storage and retrieval operations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dbmemoryNotifications = exports.GetMemoryResultNotify = exports.GetMemoryRequestNotify = exports.AddMemoryResultNotify = exports.AddMemoryRequestNotify = void 0;
+const utils_1 = require("./utils");
+/**
+ * Sends a request to add knowledge to memory
+ *
+ * @param key - The memory key
+ * @param value - The memory value
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.1 - WHEN I call `codebolt.notify.dbmemory.AddMemoryRequestNotify()` THEN the system SHALL send an AddMemoryRequestNotification via WebSocket
+ */
+function AddMemoryRequestNotify(key, value, toolUseId) {
+    // Validate required fields
+    if (!(0, utils_1.validateRequiredFields)({ key }, ['key'], 'dbmemory.AddMemoryRequestNotify')) {
+        return;
+    }
+    // Validate that value is provided (can be any type including null, but not undefined)
+    if (value === undefined) {
+        console.error('[NotificationFunctions] Value is required for dbmemory.AddMemoryRequestNotify');
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "dbmemorynotify",
+        action: "addKnowledgeRequest",
+        data: {
+            key: key,
+            value: value
+        }
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'dbmemory.AddMemoryRequestNotify');
+}
+exports.AddMemoryRequestNotify = AddMemoryRequestNotify;
+/**
+ * Sends a result response for an add memory operation
+ *
+ * @param content - The response content (string or any object)
+ * @param isError - Whether this is an error response (default: false)
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.2 - WHEN I call `codebolt.notify.dbmemory.AddMemoryResultNotify()` THEN the system SHALL send an AddMemoryResultNotification via WebSocket
+ */
+function AddMemoryResultNotify(content, isError = false, toolUseId) {
+    // Validate content is provided
+    if (content === null || content === undefined) {
+        console.error('[NotificationFunctions] Content is required for dbmemory.AddMemoryResultNotify');
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "dbmemorynotify",
+        action: "addKnowledgeResult",
+        content: content,
+        isError: isError
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'dbmemory.AddMemoryResultNotify');
+}
+exports.AddMemoryResultNotify = AddMemoryResultNotify;
+/**
+ * Sends a request to get knowledge from memory
+ *
+ * @param key - The memory key to retrieve
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.3 - WHEN I call `codebolt.notify.dbmemory.GetMemoryRequestNotify()` THEN the system SHALL send a GetMemoryRequestNotification via WebSocket
+ */
+function GetMemoryRequestNotify(key, toolUseId) {
+    // Validate required fields
+    if (!(0, utils_1.validateRequiredFields)({ key }, ['key'], 'dbmemory.GetMemoryRequestNotify')) {
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "dbmemorynotify",
+        action: "getKnowledgeRequest",
+        data: {
+            key: key
+        }
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'dbmemory.GetMemoryRequestNotify');
+}
+exports.GetMemoryRequestNotify = GetMemoryRequestNotify;
+/**
+ * Sends a result response for a get memory operation
+ *
+ * @param content - The response content (string or any object)
+ * @param isError - Whether this is an error response (default: false)
+ * @param toolUseId - Optional custom toolUseId, will be generated if not provided
+ *
+ * Requirements: 6.4 - WHEN I call `codebolt.notify.dbmemory.GetMemoryResultNotify()` THEN the system SHALL send a GetMemoryResultNotification via WebSocket
+ */
+function GetMemoryResultNotify(content, isError = false, toolUseId) {
+    // Validate content is provided
+    if (content === null || content === undefined) {
+        console.error('[NotificationFunctions] Content is required for dbmemory.GetMemoryResultNotify');
+        return;
+    }
+    // Create the notification
+    const notification = {
+        toolUseId: toolUseId || (0, utils_1.generateToolUseId)(),
+        type: "dbmemorynotify",
+        action: "getKnowledgeResult",
+        content: content,
+        isError: isError
+    };
+    // Send the notification
+    (0, utils_1.sendNotification)(notification, 'dbmemory.GetMemoryResultNotify');
+}
+exports.GetMemoryResultNotify = GetMemoryResultNotify;
+/**
+ * Database memory notification functions object
+ */
+exports.dbmemoryNotifications = {
+    AddMemoryRequestNotify,
+    AddMemoryResultNotify,
+    GetMemoryRequestNotify,
+    GetMemoryResultNotify
+};

package/dist/notificationfunctions/fs.d.ts

@@ -0,0 +1,125 @@
+/**
+ * File System Notification Functions
+ *
+ * This module provides functions for sending file system-related notifications,
+ * including file and folder operations like create, read, edit, delete, etc.
+ */
+import { FsNotifications } from '../types/notificationFunctions/fs';
+/**
+ * Sends a request to create a file
+ * Requirements: 7.1
+ */
+export declare function FileCreateRequestNotify(fileName: string, source: string, filePath: string, toolUseId?: string): void;
+/**
+ * Sends a response to a file creation request
+ * Requirements: 7.2
+ */
+export declare function FileCreateResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to create a folder
+ * Requirements: 7.3
+ */
+export declare function FolderCreateRequestNotify(folderName: string, folderPath: string, toolUseId?: string): void;
+/**
+ * Sends a response to a folder creation request
+ * Requirements: 7.4
+ */
+export declare function FolderCreateResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to read a file
+ * Requirements: 7.4
+ */
+export declare function FileReadRequestNotify(filePath: string, startLine?: string, endLine?: string, toolUseId?: string): void;
+/**
+ * Sends a response to a file read request
+ * Requirements: 7.4
+ */
+export declare function FileReadResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to edit a file
+ * Requirements: 7.5
+ */
+export declare function FileEditRequestNotify(fileName: string, filePath: string, newContent: string, toolUseId?: string): void;
+/**
+ * Sends a response to a file edit request
+ * Requirements: 7.5
+ */
+export declare function FileEditResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to delete a file
+ * Requirements: 7.6
+ */
+export declare function FileDeleteRequestNotify(fileName: string, filePath: string, toolUseId?: string): void;
+/**
+ * Sends a response to a file delete request
+ * Requirements: 7.6
+ */
+export declare function FileDeleteResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to delete a folder
+ * Requirements: 7.6
+ */
+export declare function FolderDeleteRequestNotify(folderName: string, folderPath: string, toolUseId?: string): void;
+/**
+ * Sends a response to a folder delete request
+ * Requirements: 7.6
+ */
+export declare function FolderDeleteResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void; /**
+ *
+Sends a request to list directory contents
+ * Requirements: 7.7
+ */
+export declare function ListDirectoryRequestNotify(dirPath: string, toolUseId?: string): void;
+/**
+ * Sends a response to a directory listing request
+ * Requirements: 7.7
+ */
+export declare function ListDirectoryResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to write to a file
+ * Requirements: 7.8
+ */
+export declare function WriteToFileRequestNotify(filePath: string, text: string, toolUseId?: string): void;
+/**
+ * Sends a response to a write to file request
+ * Requirements: 7.8
+ */
+export declare function WriteToFileResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to append to a file
+ * Requirements: 7.9
+ */
+export declare function AppendToFileRequestNotify(filePath: string, text: string, toolUseId?: string): void;
+/**
+ * Sends a response to an append to file request
+ * Requirements: 7.9
+ */
+export declare function AppendToFileResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void; /**
+
+ * Sends a request to copy a file
+ * Requirements: 7.10
+ */
+export declare function CopyFileRequestNotify(sourceFile: string, destinationFile: string, toolUseId?: string): void;
+/**
+ * Sends a response to a file copy request
+ * Requirements: 7.10
+ */
+export declare function CopyFileResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * Sends a request to move a file
+ * Requirements: 7.11
+ */
+export declare function MoveFileRequestNotify(sourceFile: string, destinationFile: string, toolUseId?: string): void;
+/**
+ * Sends a response to a file move request
+ * Requirements: 7.11
+ */
+export declare function MoveFileResponseNotify(content: string | any, isError?: boolean, toolUseId?: string): void;
+/**
+ * File system notification functions object
+ */
+export declare const fsNotifications: FsNotifications;
+/**
+ * Default export
+ */
+export default fsNotifications;