strict-format

Author: tripolskypetr

package-lock.json

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

package.json

@@ -160,7 +160,7 @@ export { IPipelineSchema } from "./model/Pipeline.model";
 
 export { IMCPSchema, IMCPTool, MCPToolProperties, IMCPToolCallDto } from './interfaces/MCP.interface';
 
-export { IOutlineSchema, IOutlineMessage, IOutlineHistory, IOutlineValidationFn, IOutlineResult, IOutlineFormat } from "./interfaces/Outline.interface";
+export { IOutlineSchema, IOutlineMessage, IOutlineHistory, IOutlineValidationFn, IOutlineResult, IOutlineFormat, IOutlineSchemaFormat, IOutlineObjectFormat } from "./interfaces/Outline.interface";
 
 export { IModelMessage } from "./model/ModelMessage.model";
 export { IIncomingMessage, IOutgoingMessage } from "./model/EmitMessage.model";

src/index.ts

@@ -15,14 +15,40 @@ export type IOutlineParam = any;
  */
 export type IOutlineData = any;
 
+/**
+ * Type representing the format definition for outline data.
+ * Can be either a full JSON schema format or an object-based format.
+ * Used to specify the expected structure for outline operations.
+ * @typedef {IOutlineSchemaFormat | IOutlineObjectFormat} IOutlineFormat
+ */
+export type IOutlineFormat = IOutlineSchemaFormat | IOutlineObjectFormat;
+
+/**
+ * Interface representing a format definition using a JSON schema.
+ * Specifies the type and the associated JSON schema object for validation.
+ * Used when the outline format is defined by a complete JSON schema.
+ */
+export interface IOutlineSchemaFormat {
+  /**
+   * The type of the outline format (e.g., "json_schema").
+   */
+  type: string;
+
+  /**
+   * The JSON schema object defining the structure and validation rules.
+   */
+  json_schema: object;
+}
+
 /**
  * Interface representing the format/schema definition for outline data.
  * Specifies the structure, required fields, and property metadata for outline operations.
  * Used to enforce and document the expected shape of outline data.
  */
-export interface IOutlineFormat {
+export interface IOutlineObjectFormat {
   /**
    * The root type of the outline format (e.g., "object").
+   * Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
    */
   type: string;
 

src/interfaces/Outline.interface.ts

@@ -485,7 +485,7 @@ export class DocService {
         }
       }
 
-      if (outlineSchema.format) {
+      if ("properties" in outlineSchema.format) {
         result.push("");
         result.push("## Output format");
         const entries = Object.entries(outlineSchema.format.properties);
@@ -504,7 +504,7 @@ export class DocService {
             result.push("");
             result.push(`*Enum:* \`${e.map(sanitizeMarkdown).join(", ")}\``);
           }
-          {
+          if ("required" in outlineSchema.format) {
             result.push("");
             result.push(
               `*Required:* [${
@@ -520,6 +520,16 @@ export class DocService {
         result.push("");
       }
 
+      if (outlineSchema.format.type === "json_schema") {
+        result.push("");
+        result.push("## Output format");
+        result.push("");
+        result.push("```json");
+        result.push(JSON.stringify(outlineSchema.format, null, 2));
+        result.push("```");
+        result.push("");
+      }
+
       const getValidations = () => {
         if (outlineSchema.validations) {
           return outlineSchema.validations

src/lib/services/base/DocService.ts

@@ -3039,14 +3039,37 @@ type IOutlineParam = any;
  * @typedef {any} IOutlineData
  */
 type IOutlineData = any;
+/**
+ * Type representing the format definition for outline data.
+ * Can be either a full JSON schema format or an object-based format.
+ * Used to specify the expected structure for outline operations.
+ * @typedef {IOutlineSchemaFormat | IOutlineObjectFormat} IOutlineFormat
+ */
+type IOutlineFormat = IOutlineSchemaFormat | IOutlineObjectFormat;
+/**
+ * Interface representing a format definition using a JSON schema.
+ * Specifies the type and the associated JSON schema object for validation.
+ * Used when the outline format is defined by a complete JSON schema.
+ */
+interface IOutlineSchemaFormat {
+    /**
+     * The type of the outline format (e.g., "json_schema").
+     */
+    type: string;
+    /**
+     * The JSON schema object defining the structure and validation rules.
+     */
+    json_schema: object;
+}
 /**
  * Interface representing the format/schema definition for outline data.
  * Specifies the structure, required fields, and property metadata for outline operations.
  * Used to enforce and document the expected shape of outline data.
  */
-interface IOutlineFormat {
+interface IOutlineObjectFormat {
     /**
      * The root type of the outline format (e.g., "object").
+     * Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
      */
     type: string;
     /**
@@ -15718,4 +15741,4 @@ declare const Utils: {
     PersistEmbeddingUtils: typeof PersistEmbeddingUtils;
 };
 
-export { Adapter, Chat, ChatInstance, Compute, type EventSource, ExecutionContextService, History, HistoryMemoryInstance, HistoryPersistInstance, type IAgentSchemaInternal, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type IChatArgs, type IChatInstance, type IChatInstanceCallbacks, type ICompletionArgs, type ICompletionSchema, type IComputeSchema, type ICustomEvent, type IEmbeddingSchema, type IGlobalConfig, type IHistoryAdapter, type IHistoryControl, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMCPSchema, type IMCPTool, type IMCPToolCallDto, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type INavigateToAgentParams, type INavigateToTriageParams, type IOutgoingMessage, type IOutlineFormat, type IOutlineHistory, type IOutlineMessage, type IOutlineResult, type IOutlineSchema, type IOutlineValidationFn, type IPersistActiveAgentData, type IPersistAliveData, type IPersistBase, type IPersistEmbeddingData, type IPersistMemoryData, type IPersistNavigationStackData, type IPersistPolicyData, type IPersistStateData, type IPersistStorageData, type IPipelineSchema, type IPolicySchema, type ISessionConfig, type IStateSchema, type IStorageData, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, type IWikiSchema, Logger, LoggerInstance, MCP, type MCPToolProperties, MethodContextService, Operator, OperatorInstance, PayloadContextService, PersistAlive, PersistBase, PersistEmbedding, PersistList, PersistMemory, PersistPolicy, PersistState, PersistStorage, PersistSwarm, Policy, type ReceiveMessageFn, RoundRobin, Schema, SchemaContextService, type SendMessageFn, SharedCompute, SharedState, SharedStorage, State, Storage, type THistoryInstanceCtor, type THistoryMemoryInstance, type THistoryPersistInstance, type TLoggerInstance, type TOperatorInstance, type TPersistBase, type TPersistBaseCtor, type TPersistList, type ToolValue, Utils, addAgent, addAgentNavigation, addCompletion, addCompute, addEmbedding, addMCP, addOutline, addPipeline, addPolicy, addState, addStorage, addSwarm, addTool, addTriageNavigation, addWiki, beginContext, cancelOutput, cancelOutputForce, changeToAgent, changeToDefaultAgent, changeToPrevAgent, commitAssistantMessage, commitAssistantMessageForce, commitFlush, commitFlushForce, commitStopTools, commitStopToolsForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitToolRequest, commitToolRequestForce, commitUserMessage, commitUserMessageForce, complete, createNavigateToAgent, createNavigateToTriageAgent, disposeConnection, dumpAgent, dumpClientPerformance, dumpDocs, dumpPerfomance, dumpSwarm, emit, emitForce, event, execute, executeForce, fork, getAgent, getAgentHistory, getAgentName, getAssistantHistory, getCheckBusy, getCompletion, getCompute, getEmbeding, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getMCP, getNavigationRoute, getPayload, getPipeline, getPolicy, getRawHistory, getSessionContext, getSessionMode, getState, getStorage, getSwarm, getTool, getToolNameForModel, getUserHistory, getWiki, hasNavigation, hasSession, json, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenExecutionEvent, listenExecutionEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenPolicyEvent, listenPolicyEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, markOffline, markOnline, notify, notifyForce, overrideAgent, overrideCompletion, overrideCompute, overrideEmbeding, overrideMCP, overrideOutline, overridePipeline, overridePolicy, overrideState, overrideStorage, overrideSwarm, overrideTool, overrideWiki, question, questionForce, runStateless, runStatelessForce, scope, session, setConfig, startPipeline, swarm };
+export { Adapter, Chat, ChatInstance, Compute, type EventSource, ExecutionContextService, History, HistoryMemoryInstance, HistoryPersistInstance, type IAgentSchemaInternal, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type IChatArgs, type IChatInstance, type IChatInstanceCallbacks, type ICompletionArgs, type ICompletionSchema, type IComputeSchema, type ICustomEvent, type IEmbeddingSchema, type IGlobalConfig, type IHistoryAdapter, type IHistoryControl, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMCPSchema, type IMCPTool, type IMCPToolCallDto, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type INavigateToAgentParams, type INavigateToTriageParams, type IOutgoingMessage, type IOutlineFormat, type IOutlineHistory, type IOutlineMessage, type IOutlineObjectFormat, type IOutlineResult, type IOutlineSchema, type IOutlineSchemaFormat, type IOutlineValidationFn, type IPersistActiveAgentData, type IPersistAliveData, type IPersistBase, type IPersistEmbeddingData, type IPersistMemoryData, type IPersistNavigationStackData, type IPersistPolicyData, type IPersistStateData, type IPersistStorageData, type IPipelineSchema, type IPolicySchema, type ISessionConfig, type IStateSchema, type IStorageData, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, type IWikiSchema, Logger, LoggerInstance, MCP, type MCPToolProperties, MethodContextService, Operator, OperatorInstance, PayloadContextService, PersistAlive, PersistBase, PersistEmbedding, PersistList, PersistMemory, PersistPolicy, PersistState, PersistStorage, PersistSwarm, Policy, type ReceiveMessageFn, RoundRobin, Schema, SchemaContextService, type SendMessageFn, SharedCompute, SharedState, SharedStorage, State, Storage, type THistoryInstanceCtor, type THistoryMemoryInstance, type THistoryPersistInstance, type TLoggerInstance, type TOperatorInstance, type TPersistBase, type TPersistBaseCtor, type TPersistList, type ToolValue, Utils, addAgent, addAgentNavigation, addCompletion, addCompute, addEmbedding, addMCP, addOutline, addPipeline, addPolicy, addState, addStorage, addSwarm, addTool, addTriageNavigation, addWiki, beginContext, cancelOutput, cancelOutputForce, changeToAgent, changeToDefaultAgent, changeToPrevAgent, commitAssistantMessage, commitAssistantMessageForce, commitFlush, commitFlushForce, commitStopTools, commitStopToolsForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitToolRequest, commitToolRequestForce, commitUserMessage, commitUserMessageForce, complete, createNavigateToAgent, createNavigateToTriageAgent, disposeConnection, dumpAgent, dumpClientPerformance, dumpDocs, dumpPerfomance, dumpSwarm, emit, emitForce, event, execute, executeForce, fork, getAgent, getAgentHistory, getAgentName, getAssistantHistory, getCheckBusy, getCompletion, getCompute, getEmbeding, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getMCP, getNavigationRoute, getPayload, getPipeline, getPolicy, getRawHistory, getSessionContext, getSessionMode, getState, getStorage, getSwarm, getTool, getToolNameForModel, getUserHistory, getWiki, hasNavigation, hasSession, json, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenExecutionEvent, listenExecutionEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenPolicyEvent, listenPolicyEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, markOffline, markOnline, notify, notifyForce, overrideAgent, overrideCompletion, overrideCompute, overrideEmbeding, overrideMCP, overrideOutline, overridePipeline, overridePolicy, overrideState, overrideStorage, overrideSwarm, overrideTool, overrideWiki, question, questionForce, runStateless, runStatelessForce, scope, session, setConfig, startPipeline, swarm };