bothy-sdk
    Preparing search index...

    Interface ScenarioServer

    What the scenarios need from a server (FakeServer or the real server).

    interface ScenarioServer {
        agentId: string;
        baseUrl: string;
        clock: Clock;
        credentials: Credentials;
        instanceId: string;
        origin: string;
        otherAgentId: string;
        sdkSettings: SdkSettings;
        timings: Readonly<Record<string, number>>;
        forgeToken(
            runId: string,
            variant: "bad_signature" | "alg_hs256" | "aud_other_agent" | "typ_access",
        ): Promise<Secret>;
        passTime(ms: number): Promise<void>;
        restart(consumer?: string, ackedSeq?: number): Promise<void>;
        runState(runId: string): Promise<RunView>;
        trigger(text?: string): Promise<Triggered>;
    }

    Implemented by

    Index

    Properties

    agentId baseUrl clock credentials instanceId origin otherAgentId sdkSettings timings

    Methods

    forgeToken passTime restart runState trigger

    Properties

    agentId: string

    Lotse, the agent under test.

    baseUrl: string

    The API base, origin + "/api/v1".

    clock: Clock

    The clock the adapter under test must use.

    credentials: Credentials

    Lotse's API token and DPoP key.

    instanceId: string

    The instance (iss of the invocation tokens).

    origin: string

    The origin, for example http://127.0.0.1:<port>.

    otherAgentId: string

    Texter, another agent.

    sdkSettings: SdkSettings

    The SDK settings the adapter under test uses.

    timings: Readonly<Record<string, number>>

    The server keys the server plays (agent.ack_timeout, ...), in milliseconds.

    Methods

    • Returns a forged token of variant for runId.

      Parameters

      • runId: string

        The run.

      • variant: "bad_signature" | "alg_hs256" | "aud_other_agent" | "typ_access"

        The forgery.

      Returns Promise<Secret>

    • Lets ms milliseconds pass (fake or real).

      Parameters

      • ms: number

        The time to pass.

      Returns Promise<void>

    • Restarts the server on the same data, optionally rewinding a consumer cursor.

      Parameters

      • Optionalconsumer: string

        The consumer to rewind.

      • OptionalackedSeq: number

        The new acknowledged seq of that consumer.

      Returns Promise<void>

    • Returns state, reason, version and the number of starts of a run.

      Parameters

      • runId: string

        The run.

      Returns Promise<RunView>

    • Lets Alex mention Lotse in a new thread.

      Parameters

      • Optionaltext: string

        The first message of the thread.

      Returns Promise<Triggered>

      Run, thread and message IDs.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods