outlines

Author: tripolskypetr

package-lock.json

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

package.json

@@ -1,4 +1,8 @@
-import { IOutlineSchema } from "../../interfaces/Outline.interface";
+import {
+  IOutlineData,
+  IOutlineParam,
+  IOutlineSchema,
+} from "../../interfaces/Outline.interface";
 import swarm from "../../lib";
 import { GLOBAL_CONFIG } from "../../config/params";
 import beginContext from "../../utils/beginContext";
@@ -40,6 +44,9 @@ const addOutlineInternal = beginContext((outlineSchema: IOutlineSchema) => {
  * @param {IOutlineSchema} outlineSchema - The outline schema to register, containing the outline name and configuration.
  * @returns {string} The name of the registered outline.
  */
-export function addOutline(outlineSchema: IOutlineSchema) {
+export function addOutline<
+  Data extends IOutlineData = IOutlineData,
+  Param extends IOutlineParam = IOutlineParam
+>(outlineSchema: IOutlineSchema<Data, Param>) {
   return addOutlineInternal(outlineSchema);
 }

src/functions/setup/addOutline.ts

@@ -26,7 +26,11 @@ import ComputeValidationService from "../validation/ComputeValidationService";
 import ComputeSchemaService from "../schema/ComputeSchemaService";
 import OutlineValidationService from "../validation/OutlineValidationService";
 import OutlineSchemaService from "../schema/OutlineSchemaService";
-import { IOutlineSchema } from "../../../interfaces/Outline.interface";
+import {
+  IOutlineSchema,
+  IOutlineValidation,
+} from "../../../interfaces/Outline.interface";
+import isObject from "../../../utils/isObject";
 
 /**
  * Maximum number of concurrent threads for documentation generation tasks.
@@ -495,6 +499,30 @@ export class DocService {
           result.push("");
           result.push(`*Empty parameters*`);
         }
+        result.push("");
+      }
+
+      const getValidations = () => {
+        if (outlineSchema.validations) {
+          return outlineSchema.validations
+            .filter((validation) => typeof validation === "object")
+            .filter((validation) => !!validation.docDescription);
+        }
+        return [];
+      };
+
+      const validations = getValidations();
+
+      if (validations.length) {
+        result.push(`## Validations`);
+        result.push("");
+        for (let i = 0; i !== prompt.length; i++) {
+          if (!validations[i].docDescription) {
+            continue;
+          }
+          result.push(`${i + 1}. \`${sanitizeMarkdown(validations[i].docDescription)}\``);
+          result.push("");
+        }
       }
 
       if (outlineSchema.callbacks) {

src/lib/services/base/DocService.ts

@@ -12051,7 +12051,7 @@ declare function addPipeline<Payload extends object = any>(pipelineSchema: IPipe
  * @param {IOutlineSchema} outlineSchema - The outline schema to register, containing the outline name and configuration.
  * @returns {string} The name of the registered outline.
  */
-declare function addOutline(outlineSchema: IOutlineSchema): string;
+declare function addOutline<Data extends IOutlineData = IOutlineData, Param extends IOutlineParam = IOutlineParam>(outlineSchema: IOutlineSchema<Data, Param>): string;
 
 type TAgentSchema = {
     agentName: IAgentSchema["agentName"];