agent-swarm-kit 1.0.101 → 1.0.103

package/build/index.cjs

@@ -7446,6 +7446,10 @@ var SwarmMetaService = /** @class */ (function () {
 
 var THREAD_POOL_SIZE = 5;
 var SUBDIR_LIST = ["agent", "image"];
+/**
+ * Service for generating documentation for swarms and agents.
+ * @class
+ */
 var DocService = /** @class */ (function () {
     function DocService() {
         var _this = this;
@@ -7459,6 +7463,12 @@ var DocService = /** @class */ (function () {
         this.stateSchemaService = inject(TYPES.stateSchemaService);
         this.agentMetaService = inject(TYPES.agentMetaService);
         this.swarmMetaService = inject(TYPES.swarmMetaService);
+        /**
+         * Writes documentation for a swarm schema.
+         * @param {ISwarmSchema} swarmSchema - The swarm schema to document.
+         * @param {string} dirName - The directory to write the documentation to.
+         * @returns {Promise<void>}
+         */
         this.writeSwarmDoc = functoolsKit.execpool(function (swarmSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
             var result, umlSchema, umlName, umlSvg, docDescription, i, docDescription, callbackList, i;
             return __generator(this, function (_a) {
@@ -7530,6 +7540,12 @@ var DocService = /** @class */ (function () {
         }); }, {
             maxExec: THREAD_POOL_SIZE,
         });
+        /**
+         * Writes documentation for an agent schema.
+         * @param {IAgentSchema} agentSchema - The agent schema to document.
+         * @param {string} dirName - The directory to write the documentation to.
+         * @returns {Promise<void>}
+         */
         this.writeAgentDoc = functoolsKit.execpool(function (agentSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
             var result, umlSchema, umlName, umlSvg, i, i, docDescription, _loop_1, this_1, i, i, _a, docDescription, embedding, shared, callbacks, callbackList, i_1, i, _b, docDescription, shared, callbacks, callbackList, i_2, callbackList, i;
             var _c;
@@ -7622,7 +7638,8 @@ var DocService = /** @class */ (function () {
                                 if ((_c = fn.parameters) === null || _c === void 0 ? void 0 : _c.properties) {
                                     result.push("");
                                     result.push("#### Parameters for model");
-                                    Object.entries(fn.parameters.properties).forEach(function (_a, idx) {
+                                    var entries = Object.entries(fn.parameters.properties);
+                                    entries.forEach(function (_a, idx) {
                                         var _b = __read(_a, 2), key = _b[0], _c = _b[1], type = _c.type, description = _c.description, e = _c.enum;
                                         result.push("");
                                         result.push("> **".concat(idx + 1, ". ").concat(key, "**"));
@@ -7643,6 +7660,11 @@ var DocService = /** @class */ (function () {
                                             result.push("*Required:* [".concat(fn.parameters.required.includes(key) ? "x" : " ", "]"));
                                         }
                                     });
+                                    if (!entries.length) {
+                                        result.push("");
+                                        result.push("*Empty parameters*");
+                                        result.push("");
+                                    }
                                 }
                                 if (callbacks) {
                                     result.push("");
@@ -7748,6 +7770,11 @@ var DocService = /** @class */ (function () {
         }); }, {
             maxExec: THREAD_POOL_SIZE,
         });
+        /**
+         * Dumps the documentation for all swarms and agents.
+         * @param {string} [dirName=join(process.cwd(), "docs/chat")] - The directory to write the documentation to.
+         * @returns {Promise<void>}
+         */
         this.dumpDocs = function () {
             var args_1 = [];
             for (var _i = 0; _i < arguments.length; _i++) {
@@ -7930,12 +7957,40 @@ init();
 var swarm$1 = swarm;
 
 var METHOD_NAME$F = "cli.dumpDocs";
-var dumpDocs = function (dirName) {
+/**
+ * Dumps the documentation for the agents and swarms.
+ *
+ * @param {string} [dirName="./docs/chat"] - The directory where the documentation will be dumped.
+ * @param {function} [PlantUML] - An optional function to process PlantUML diagrams.
+ * @returns {Promise<void>} - A promise that resolves when the documentation has been dumped.
+ */
+var dumpDocs = function (dirName, PlantUML) {
     if (dirName === void 0) { dirName = "./docs/chat"; }
     GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
         swarm$1.loggerService.log(METHOD_NAME$F, {
             dirName: dirName,
         });
+    if (PlantUML) {
+        setConfig({
+            CC_FN_PLANTUML: PlantUML,
+        });
+    }
+    swarm$1.agentValidationService
+        .getAgentList()
+        .forEach(function (agentName) {
+        return swarm$1.agentValidationService.validate(agentName, METHOD_NAME$F);
+    });
+    swarm$1.swarmValidationService
+        .getSwarmList()
+        .forEach(function (swarmName) {
+        return swarm$1.swarmValidationService.validate(swarmName, METHOD_NAME$F);
+    });
+    swarm$1.agentValidationService.getAgentList().forEach(function (agentName) {
+        var dependsOn = swarm$1.agentSchemaService.get(agentName).dependsOn;
+        if (!dependsOn) {
+            console.error("agent-swarm missing dependsOn for agentName=".concat(agentName));
+        }
+    });
     return swarm$1.docService.dumpDocs(dirName);
 };
 

package/build/index.mjs

@@ -7444,6 +7444,10 @@ var SwarmMetaService = /** @class */ (function () {
 
 var THREAD_POOL_SIZE = 5;
 var SUBDIR_LIST = ["agent", "image"];
+/**
+ * Service for generating documentation for swarms and agents.
+ * @class
+ */
 var DocService = /** @class */ (function () {
     function DocService() {
         var _this = this;
@@ -7457,6 +7461,12 @@ var DocService = /** @class */ (function () {
         this.stateSchemaService = inject(TYPES.stateSchemaService);
         this.agentMetaService = inject(TYPES.agentMetaService);
         this.swarmMetaService = inject(TYPES.swarmMetaService);
+        /**
+         * Writes documentation for a swarm schema.
+         * @param {ISwarmSchema} swarmSchema - The swarm schema to document.
+         * @param {string} dirName - The directory to write the documentation to.
+         * @returns {Promise<void>}
+         */
         this.writeSwarmDoc = execpool(function (swarmSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
             var result, umlSchema, umlName, umlSvg, docDescription, i, docDescription, callbackList, i;
             return __generator(this, function (_a) {
@@ -7528,6 +7538,12 @@ var DocService = /** @class */ (function () {
         }); }, {
             maxExec: THREAD_POOL_SIZE,
         });
+        /**
+         * Writes documentation for an agent schema.
+         * @param {IAgentSchema} agentSchema - The agent schema to document.
+         * @param {string} dirName - The directory to write the documentation to.
+         * @returns {Promise<void>}
+         */
         this.writeAgentDoc = execpool(function (agentSchema, dirName) { return __awaiter(_this, void 0, void 0, function () {
             var result, umlSchema, umlName, umlSvg, i, i, docDescription, _loop_1, this_1, i, i, _a, docDescription, embedding, shared, callbacks, callbackList, i_1, i, _b, docDescription, shared, callbacks, callbackList, i_2, callbackList, i;
             var _c;
@@ -7620,7 +7636,8 @@ var DocService = /** @class */ (function () {
                                 if ((_c = fn.parameters) === null || _c === void 0 ? void 0 : _c.properties) {
                                     result.push("");
                                     result.push("#### Parameters for model");
-                                    Object.entries(fn.parameters.properties).forEach(function (_a, idx) {
+                                    var entries = Object.entries(fn.parameters.properties);
+                                    entries.forEach(function (_a, idx) {
                                         var _b = __read(_a, 2), key = _b[0], _c = _b[1], type = _c.type, description = _c.description, e = _c.enum;
                                         result.push("");
                                         result.push("> **".concat(idx + 1, ". ").concat(key, "**"));
@@ -7641,6 +7658,11 @@ var DocService = /** @class */ (function () {
                                             result.push("*Required:* [".concat(fn.parameters.required.includes(key) ? "x" : " ", "]"));
                                         }
                                     });
+                                    if (!entries.length) {
+                                        result.push("");
+                                        result.push("*Empty parameters*");
+                                        result.push("");
+                                    }
                                 }
                                 if (callbacks) {
                                     result.push("");
@@ -7746,6 +7768,11 @@ var DocService = /** @class */ (function () {
         }); }, {
             maxExec: THREAD_POOL_SIZE,
         });
+        /**
+         * Dumps the documentation for all swarms and agents.
+         * @param {string} [dirName=join(process.cwd(), "docs/chat")] - The directory to write the documentation to.
+         * @returns {Promise<void>}
+         */
         this.dumpDocs = function () {
             var args_1 = [];
             for (var _i = 0; _i < arguments.length; _i++) {
@@ -7928,12 +7955,40 @@ init();
 var swarm$1 = swarm;
 
 var METHOD_NAME$F = "cli.dumpDocs";
-var dumpDocs = function (dirName) {
+/**
+ * Dumps the documentation for the agents and swarms.
+ *
+ * @param {string} [dirName="./docs/chat"] - The directory where the documentation will be dumped.
+ * @param {function} [PlantUML] - An optional function to process PlantUML diagrams.
+ * @returns {Promise<void>} - A promise that resolves when the documentation has been dumped.
+ */
+var dumpDocs = function (dirName, PlantUML) {
     if (dirName === void 0) { dirName = "./docs/chat"; }
     GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
         swarm$1.loggerService.log(METHOD_NAME$F, {
             dirName: dirName,
         });
+    if (PlantUML) {
+        setConfig({
+            CC_FN_PLANTUML: PlantUML,
+        });
+    }
+    swarm$1.agentValidationService
+        .getAgentList()
+        .forEach(function (agentName) {
+        return swarm$1.agentValidationService.validate(agentName, METHOD_NAME$F);
+    });
+    swarm$1.swarmValidationService
+        .getSwarmList()
+        .forEach(function (swarmName) {
+        return swarm$1.swarmValidationService.validate(swarmName, METHOD_NAME$F);
+    });
+    swarm$1.agentValidationService.getAgentList().forEach(function (agentName) {
+        var dependsOn = swarm$1.agentSchemaService.get(agentName).dependsOn;
+        if (!dependsOn) {
+            console.error("agent-swarm missing dependsOn for agentName=".concat(agentName));
+        }
+    });
     return swarm$1.docService.dumpDocs(dirName);
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-swarm-kit",
-  "version": "1.0.101",
+  "version": "1.0.103",
   "description": "A TypeScript library for building orchestrated framework-agnostic multi-agent AI systems",
   "author": {
     "name": "Petr Tripolsky",

package/types.d.ts

@@ -3107,6 +3107,10 @@ declare class SwarmMetaService {
     toUML: (swarmName: SwarmName) => string;
 }
 
+/**
+ * Service for generating documentation for swarms and agents.
+ * @class
+ */
 declare class DocService {
     private readonly loggerService;
     private readonly swarmValidationService;
@@ -3118,8 +3122,25 @@ declare class DocService {
     private readonly stateSchemaService;
     private readonly agentMetaService;
     private readonly swarmMetaService;
+    /**
+     * Writes documentation for a swarm schema.
+     * @param {ISwarmSchema} swarmSchema - The swarm schema to document.
+     * @param {string} dirName - The directory to write the documentation to.
+     * @returns {Promise<void>}
+     */
     private writeSwarmDoc;
+    /**
+     * Writes documentation for an agent schema.
+     * @param {IAgentSchema} agentSchema - The agent schema to document.
+     * @param {string} dirName - The directory to write the documentation to.
+     * @returns {Promise<void>}
+     */
     private writeAgentDoc;
+    /**
+     * Dumps the documentation for all swarms and agents.
+     * @param {string} [dirName=join(process.cwd(), "docs/chat")] - The directory to write the documentation to.
+     * @returns {Promise<void>}
+     */
     dumpDocs: (dirName?: string) => Promise<void>;
 }
 
@@ -3163,7 +3184,14 @@ declare const swarm: {
     loggerService: LoggerService;
 };
 
-declare const dumpDocs: (dirName?: string) => Promise<void>;
+/**
+ * Dumps the documentation for the agents and swarms.
+ *
+ * @param {string} [dirName="./docs/chat"] - The directory where the documentation will be dumped.
+ * @param {function} [PlantUML] - An optional function to process PlantUML diagrams.
+ * @returns {Promise<void>} - A promise that resolves when the documentation has been dumped.
+ */
+declare const dumpDocs: (dirName?: string, PlantUML?: (uml: string) => Promise<string>) => Promise<void>;
 
 /**
  * The config for UML generation