types

Author: tripolskypetr

src/interfaces/Agent.interface.ts

@@ -31,7 +31,7 @@ export interface TAbortSignal extends AbortSignal { }
 
 /**
  * Type representing possible values for tool parameters.
- * @typedef {string | number | boolean | null} ToolValue
+ * Supports basic data types for flexible parameter passing.
  */
 export type ToolValue = string | number | boolean | null;
 
@@ -642,12 +642,12 @@ export interface IAgent {
 
 /**
  * Type representing the unique name of an agent within the swarm.
- * @typedef {string} AgentName
+ * Used to identify and reference specific agent instances.
  */
 export type AgentName = string;
 
 /**
  * Type representing the unique name of a tool within the swarm.
- * @typedef {string} ToolName
+ * Used to identify and reference specific tool implementations.
  */
 export type ToolName = string;

src/interfaces/Completion.interface.ts

@@ -105,6 +105,6 @@ export interface ICompletionSchema {
 
 /**
  * Type representing the unique name of a completion mechanism within the swarm.
- * @typedef {string} CompletionName
+ * Used to identify and reference specific completion implementations.
  */
 export type CompletionName = string;

src/interfaces/Embedding.interface.ts

@@ -7,7 +7,6 @@ import { IStorageCallbacks, IStorageSchema } from "./Storage.interface";
 /**
  * Type representing an array of numbers as embeddings.
  * Used to encode text or data for similarity comparisons in storage or search operations.
- * @typedef {number[]} Embeddings
  */
 export type Embeddings = number[];
 
@@ -120,6 +119,6 @@ export interface IEmbeddingSchema {
 
 /**
  * Type representing the unique name of an embedding mechanism within the swarm.
- * @typedef {string} EmbeddingName
+ * Used to identify and reference specific embedding implementations.
  */
 export type EmbeddingName = string;

src/interfaces/Outline.interface.ts

@@ -4,22 +4,19 @@ import { CompletionName } from "./Completion.interface";
 /**
  * Generic type representing arbitrary param for outline operations.
  * Used as a flexible placeholder for input param in outline schemas and arguments.
- * @typedef {any} IOutlineParam
  */
 export type IOutlineParam = any;
 
 /**
  * Generic type representing arbitrary data param for outline operations.
  * Used as a flexible placeholder for data param in outline schemas and results.
- * @typedef {any} IOutlineData
  */
 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;
 
@@ -437,7 +434,6 @@ export interface IOutlineSchema<
 
 /**
  * Type representing the unique name of an outline within the system.
- * Used to identify specific outline configurations.
- * @typedef {string} OutlineName
+ * Used to identify and reference specific outline configurations.
  */
 export type OutlineName = string;

src/interfaces/Policy.interface.ts

@@ -254,7 +254,7 @@ export interface IPolicyParams extends IPolicySchema, IPolicyCallbacks {
 
 /**
  * Type representing the unique name of a policy within the swarm.
- * @typedef {string} PolicyName
+ * Used to identify and reference specific policy implementations.
  */
 export type PolicyName = string;
 

src/interfaces/Session.interface.ts

@@ -182,20 +182,18 @@ export interface ISession {
 
 /**
  * Type representing the unique identifier for a session.
- * @typedef {string} SessionId
+ * Used to track and reference specific session instances.
  */
 export type SessionId = string;
 
 /**
  * Type representing the operational mode of a session.
- * Defines the session's behavior: full session, connection setup, or single completion.
- * @typedef {"session" | "makeConnection" | "complete"} SessionMode
+ * Defines the session's behavior: full session, connection setup, single completion, or scoped operation.
  */
 export type SessionMode = "session" | "makeConnection" | "complete" | "scope";
 
 /**
  * Type representing the source of execution within a session.
  * Tools emit "tool" messages (ignored in user history), while users emit "user" messages.
- * @typedef {"tool" | "user"} ExecutionMode
  */
 export type ExecutionMode = "tool" | "user";

src/interfaces/State.interface.ts

@@ -4,7 +4,6 @@ import { ILogger } from "./Logger.interface";
 /**
  * Type representing the data structure of a state.
  * Can be any type, serving as a generic placeholder for state values.
- * @typedef {any} IStateData
  */
 export type IStateData = any;
 
@@ -188,6 +187,6 @@ export interface IState<T extends IStateData = IStateData> {
 
 /**
  * Type representing the unique name of a state within the swarm.
- * @typedef {string} StateName
+ * Used to identify and reference specific state instances.
  */
 export type StateName = string;

src/interfaces/Storage.interface.ts

@@ -9,7 +9,7 @@ import { IBus } from "./Bus.interface";
 
 /**
  * Type representing the unique identifier for storage items.
- * @typedef {string | number} StorageId
+ * Can be either a string or number for flexible item identification.
  */
 type StorageId = string | number;
 
@@ -262,6 +262,6 @@ export interface IStorage<T extends IStorageData = IStorageData> {
 
 /**
  * Type representing the unique name of a storage within the swarm.
- * @typedef {string} StorageName
+ * Used to identify and reference specific storage instances.
  */
 export type StorageName = string;

src/interfaces/Swarm.interface.ts

@@ -274,7 +274,7 @@ export interface ISwarm {
 
 /**
  * Type representing the unique name of a swarm within the system.
- * @typedef {string} SwarmName
+ * Used to identify and reference specific swarm instances.
  */
 export type SwarmName = string;