Interface ISwarmSchema

Interface representing the schema for defining a swarm. Configures the swarm's behavior, navigation, and agent management.

interface ISwarmSchema {
    agentList: string[];
    callbacks?: Partial<ISwarmCallbacks>;
    defaultAgent: string;
    docDescription?: string;
    getActiveAgent?: (
        clientId: string,
        swarmName: string,
        defaultAgent: string,
    ) => string | Promise<string>;
    getNavigationStack?: (
        clientId: string,
        swarmName: string,
    ) => string[] | Promise<string[]>;
    persist?: boolean;
    policies?: string[];
    setActiveAgent?: (
        clientId: string,
        agentName: string,
        swarmName: string,
    ) => void | Promise<void>;
    setNavigationStack?: (
        clientId: string,
        navigationStack: string[],
        swarmName: string,
    ) => Promise<void>;
    swarmName: string;
}

Properties

agentList callbacks? defaultAgent docDescription? getActiveAgent? getNavigationStack? persist? policies? setActiveAgent? setNavigationStack? swarmName

Properties

agentList

agentList: string[]

The list of agent names available within the swarm.

Optionalcallbacks

callbacks?: Partial<ISwarmCallbacks>

Optional partial set of lifecycle callbacks for the swarm, allowing customization of events.

defaultAgent

defaultAgent: string

The default agent name to use when no active agent is specified.

OptionaldocDescription

docDescription?: string

Optional description for documentation purposes, aiding in swarm usage understanding.

OptionalgetActiveAgent

getActiveAgent?: (
    clientId: string,
    swarmName: string,
    defaultAgent: string,
) => string | Promise<string>

Optional function to fetch the active agent upon swarm initialization.

Type declaration

    • (
          clientId: string,
          swarmName: string,
          defaultAgent: string,
      ): string | Promise<string>

    • Parameters

      • clientId: string

        The unique ID of the client requesting the agent.

      • swarmName: string

        The unique name of the swarm.

      • defaultAgent: string

        The default agent name to fall back to if no active agent is set.

      Returns string | Promise<string>

      The name of the active agent, synchronously or asynchronously.

OptionalgetNavigationStack

getNavigationStack?: (
    clientId: string,
    swarmName: string,
) => string[] | Promise<string[]>

Optional function to retrieve the initial navigation stack after swarm initialization.

Type declaration

    • (clientId: string, swarmName: string): string[] | Promise<string[]>

    • Parameters

      • clientId: string

        The unique ID of the client requesting the stack.

      • swarmName: string

        The unique name of the swarm.

      Returns string[] | Promise<string[]>

      The navigation stack, synchronously or asynchronously.

Optionalpersist

persist?: boolean

Optional flag to enable serialization of navigation stack and active agent state to persistent storage (e.g., hard drive).

Optionalpolicies

policies?: string[]

Optional array of policy names defining banhammer or access control rules for the swarm.

OptionalsetActiveAgent

setActiveAgent?: (
    clientId: string,
    agentName: string,
    swarmName: string,
) => void | Promise<void>

Optional function to update the active agent after navigation changes.

Type declaration

    • (clientId: string, agentName: string, swarmName: string): void | Promise<void>

    • Parameters

      • clientId: string

        The unique ID of the client updating the agent.

      • agentName: string

        The name of the new active agent.

      • swarmName: string

        The unique name of the swarm.

      Returns void | Promise<void>

      A promise that resolves when the agent is updated, or void if synchronous.

Throws

If the update fails (e.g., due to persistence issues).

OptionalsetNavigationStack

setNavigationStack?: (
    clientId: string,
    navigationStack: string[],
    swarmName: string,
) => Promise<void>

Optional function to persist the navigation stack after a change.

Type declaration

    • (clientId: string, navigationStack: string[], swarmName: string): Promise<void>

    • Parameters

      • clientId: string

        The unique ID of the client updating the stack.

      • navigationStack: string[]

        The updated navigation stack.

      • swarmName: string

        The unique name of the swarm.

      Returns Promise<void>

      A promise that resolves when the stack is persisted.

Throws

If persistence fails (e.g., due to storage issues).

swarmName

swarmName: string

The unique name of the swarm within the system.

Settings

Member Visibility

On This Page

Properties