SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ServerInfoResponse

    ServerInfoResponse: Message<"soulfire.v1.ServerInfoResponse"> & {
        config?: ServerConfig;
        plugins: ServerPlugin[];
        serverSettings: SettingsPage[];
        settingsDefinitions: SettingsDefinition[];
    }

    Response message for GetServerInfo RPC containing comprehensive server information. This response provides everything needed to render a settings UI, including:

    • Current configuration values
    • All available setting definitions with their types and constraints
    • Page layouts for organizing settings in the UI
    • Information about registered plugins

    Type Declaration

    • Optionalconfig?: ServerConfig

      The current server configuration containing all persisted settings values. If no configuration has been saved yet, this will contain default/empty values.

      from field: soulfire.v1.ServerConfig config = 1;

    • plugins: ServerPlugin[]

      List of registered plugins on the server. Each plugin includes metadata such as ID, version, description, author, license, and website URL. Plugins may own settings pages.

      from field: repeated soulfire.v1.ServerPlugin plugins = 3;

    • serverSettings: SettingsPage[]

      Pages that group settings together for UI organization. Each page has an ID, display name, icon, and references settings by their identifiers. Pages may be associated with plugins and can have an "enabled" toggle setting.

      from field: repeated soulfire.v1.SettingsPage server_settings = 2;

    • settingsDefinitions: SettingsDefinition[]

      All available settings definitions that can be rendered by identifier. Each definition includes the setting's type (string, int, bool, etc.), UI metadata (display name, description), constraints (min/max, patterns), and scope (SERVER, INSTANCE, or BOT level). These definitions are referenced by their identifier (namespace + key).

      from field: repeated soulfire.v1.SettingsDefinition settings_definitions = 4;

    from message soulfire.v1.ServerInfoResponse