Skip to main content

Event bus and hook system for Kollabor

Project description

kollabor-events

kollabor-events is Kollabor's event bus and hook foundation.

It provides the shared event models, hook registry, hook executor, event processor, permission models, ready-message aggregation, and small utility helpers used by the CLI, plugins, engine, agent runtime, and TUI.

Current Role

  • Register and execute hooks for core and plugin-defined event types.
  • Order hook execution by priority and preserve hook status/error metadata.
  • Provide event, command, permission, and conversation data models.
  • Store cross-package services on the event bus for loose coupling.
  • Provide utility helpers for safe execution and nested dict access.

Architecture

Module Responsibility
bus.py EventBus, service registry, hook registration, event emission
models.py event types, hooks, command definitions, UI models
registry.py hook storage and enable/disable/status lookup
executor.py hook execution, timeout/retry/error behavior
processor.py event phase mapping and ordered processing
hook_adapter.py sync/async hook compatibility
permissions_models.py / permissions_config.py approval and risk models
data_models.py conversation/session metadata models
ready_message.py startup/ready message collection
dict_utils.py / error_utils.py safe utility helpers

Hook Priorities

Priority Value Purpose
SYSTEM 1000 core lifecycle/system hooks
SECURITY 900 permission and policy hooks
PREPROCESSING 500 input/request transforms
LLM 100 LLM orchestration hooks
POSTPROCESSING 50 response/result transforms
DISPLAY 10 display/UI hooks

Usage

from kollabor_events import EventBus, EventType, Hook, HookPriority

bus = EventBus()


async def on_tool_pre(data, event):
    data["checked"] = True
    return data


await bus.register_hook(Hook(
    plugin_name="example",
    name="check_tool",
    event_type=EventType.TOOL_CALL_PRE,
    priority=HookPriority.SECURITY.value,
    callback=on_tool_pre,
))

result = await bus.emit_with_hooks(
    EventType.TOOL_CALL_PRE,
    {"tool_data": {"type": "terminal"}},
    source="example",
)

Known Gaps

  • The event model is broad and shared across many packages; event ownership and schema expectations should be documented closer to each event type.
  • String-based custom events are supported, but typed contracts are stronger for core events.
  • Hook error/timeout behavior is configurable, so callers should test important security and lifecycle hooks under failure conditions.

Roadmap

Phase 1: Event contract docs

  • Document core event payload schemas and expected mutation behavior.
  • Add examples for common hook categories: security, display, LLM, and plugins.
  • Link event types to the package that owns their primary behavior.

Phase 2: Safer extension points

  • Add optional typed payload helpers for high-risk events.
  • Expand tests for cancellation, timeout, retry, and hook ordering behavior.
  • Make plugin-defined event naming conventions explicit.

Phase 3: Observability

  • Improve hook status snapshots for diagnostics and UI display.
  • Add structured hook execution traces for debugging event-heavy flows.

Development

Targeted validation examples:

python -m py_compile packages/kollabor-events/src/kollabor_events/*.py
python -m pytest tests/unit/test_hub_native_param_compat.py -q

Dependencies

None. This package is intentionally stdlib-only.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kollabor_events-0.5.12.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kollabor_events-0.5.12-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file kollabor_events-0.5.12.tar.gz.

File metadata

  • Download URL: kollabor_events-0.5.12.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for kollabor_events-0.5.12.tar.gz
Algorithm Hash digest
SHA256 1f757239763bf533a7e9aa62129d73a8b75386002f51305f1900b333a1a5166d
MD5 fca3901ce549db2899166ea0fb147453
BLAKE2b-256 4b156dd4db461b4cd294ca02f5c52d83b4b08239f565e28e7b78cf3ce84d8e8e

See more details on using hashes here.

File details

Details for the file kollabor_events-0.5.12-py3-none-any.whl.

File metadata

File hashes

Hashes for kollabor_events-0.5.12-py3-none-any.whl
Algorithm Hash digest
SHA256 45d096346dc4482a0d3bb813da281e47c197a90a33b40a27384f5074253facf4
MD5 fadcabdab759af0ec3b86b49f78ab15f
BLAKE2b-256 81786f393900f994d587ddb32874239a18537a7cce0bc78556e16402156678ad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page