Interface IPolicySchema

Interface representing the schema for configuring a policy. Defines how policies enforce rules and manage bans within the swarm.

interface IPolicySchema {
    autoBan?: boolean;
    banMessage?: string;
    callbacks?: IPolicyCallbacks;
    docDescription?: string;
    getBanMessage?: (
        clientId: string,
        policyName: string,
        swarmName: string,
    ) => string | Promise<string>;
    getBannedClients?: (
        policyName: string,
        swarmName: string,
    ) => string[] | Promise<string[]>;
    persist?: boolean;
    policyName: string;
    setBannedClients?: (
        clientIds: string[],
        policyName: string,
        swarmName: string,
    ) => void | Promise<void>;
    validateInput?: (
        incoming: string,
        clientId: string,
        policyName: string,
        swarmName: string,
    ) => boolean | Promise<boolean>;
    validateOutput?: (
        outgoing: string,
        clientId: string,
        policyName: string,
        swarmName: string,
    ) => boolean | Promise<boolean>;
}

Properties

autoBan? banMessage? callbacks? docDescription? getBanMessage? getBannedClients? persist? policyName setBannedClients? validateInput? validateOutput?

Properties

OptionalautoBan

autoBan?: boolean

Optional flag to automatically ban a client immediately after failed validation.

OptionalbanMessage

banMessage?: string

Optional default message to display when a client is banned, overridden by getBanMessage if provided.

Optionalcallbacks

callbacks?: IPolicyCallbacks

Optional set of callbacks for policy events, allowing customization of validation and ban actions.

OptionaldocDescription

docDescription?: string

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

OptionalgetBanMessage

getBanMessage?: (
    clientId: string,
    policyName: string,
    swarmName: string,
) => string | Promise<string>

Optional function to retrieve a custom ban message for a client. Overrides the default banMessage if provided.

Type declaration

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

    • Parameters

      • clientId: string

        The unique session ID of the banned client.

      • policyName: string

        The unique name of the policy.

      • swarmName: string

        The unique name of the swarm.

      Returns string | Promise<string>

      The ban message or null, synchronously or asynchronously.

OptionalgetBannedClients

getBannedClients?: (
    policyName: string,
    swarmName: string,
) => string[] | Promise<string[]>

Retrieves the list of currently banned clients under this policy.

Type declaration

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

    • Parameters

      • policyName: string

        The unique name of the policy.

      • swarmName: string

        The unique name of the swarm.

      Returns string[] | Promise<string[]>

      An array of banned session IDs, synchronously or asynchronously.

Optionalpersist

persist?: boolean

Optional flag to enable serialization of banned clients to persistent storage (e.g., hard drive).

policyName

policyName: string

The unique name of the policy within the swarm.

OptionalsetBannedClients

setBannedClients?: (
    clientIds: string[],
    policyName: string,
    swarmName: string,
) => void | Promise<void>

Optional function to set the list of banned clients. Overrides default ban list management if provided.

Type declaration

    • (
          clientIds: string[],
          policyName: string,
          swarmName: string,
      ): void | Promise<void>

    • Parameters

      • clientIds: string[]

        An array of session IDs to ban.

      • policyName: string

        The unique name of the policy.

      • swarmName: string

        The unique name of the swarm.

      Returns void | Promise<void>

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

Throws

If updating the ban list fails (e.g., due to persistence issues).

OptionalvalidateInput

validateInput?: (
    incoming: string,
    clientId: string,
    policyName: string,
    swarmName: string,
) => boolean | Promise<boolean>

Optional function to validate incoming messages against custom policy rules. Overrides default validation if provided.

Type declaration

    • (
          incoming: string,
          clientId: string,
          policyName: string,
          swarmName: string,
      ): boolean | Promise<boolean>

    • Parameters

      • incoming: string

        The incoming message to validate.

      • clientId: string

        The unique session ID of the client sending the message.

      • policyName: string

        The unique name of the policy.

      • swarmName: string

        The unique name of the swarm.

      Returns boolean | Promise<boolean>

      True if the input is valid, false otherwise, synchronously or asynchronously.

OptionalvalidateOutput

validateOutput?: (
    outgoing: string,
    clientId: string,
    policyName: string,
    swarmName: string,
) => boolean | Promise<boolean>

Optional function to validate outgoing messages against custom policy rules. Overrides default validation if provided.

Type declaration

    • (
          outgoing: string,
          clientId: string,
          policyName: string,
          swarmName: string,
      ): boolean | Promise<boolean>

    • Parameters

      • outgoing: string

        The outgoing message to validate.

      • clientId: string

        The unique session ID of the client receiving the message.

      • policyName: string

        The unique name of the policy.

      • swarmName: string

        The unique name of the swarm.

      Returns boolean | Promise<boolean>

      True if the output is valid, false otherwise, synchronously or asynchronously.

Settings

Member Visibility

On This Page

Properties