Metadata-Version: 2.4
Name: 3tears-agent-wake
Version: 0.14.0
Summary: Long-running-agent foundation -- wake schedules, fires, webhook subscriptions
Project-URL: Repository, https://github.com/pacepace/3tears
Author: pace
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.14
Requires-Dist: 3tears
Requires-Dist: 3tears-agent-skills
Requires-Dist: 3tears-observe
Requires-Dist: 3tears-scheduled-jobs
Requires-Dist: apscheduler>=3.10
Requires-Dist: jinja2>=3
Requires-Dist: langchain-core
Requires-Dist: pydantic>=2
Requires-Dist: uuid-utils
Provides-Extra: prometheus
Requires-Dist: prometheus-client>=0.20; extra == 'prometheus'
Description-Content-Type: text/markdown

# 3tears-agent-wake

Long-running-agent foundation for 3tears-based agents. This package
ships the schema + Collection layer for three platform tables:

- `agent_wake_schedules` -- one row per active wake schedule for a
  conversation (cron / one-shot / random-window / etc). Carries a
  nullable `skill_id` FK referencing the cross-package
  `agent_skills.skill_id` standalone UNIQUE.
- `wake_fires` -- one row per wake fire (history; status enum spans
  `'fired'`, `'fired_silent'`, `'yielded'`, `'skipped_busy'`,
  `'skipped_rate_limit'`, `'skipped_cap'`, `'skipped_no_handler'`,
  `'failed'`).
- `webhook_subscriptions` -- one row per inbound HTTP webhook
  subscription. Carries nullable `default_skill_id` FK to
  `agent_skills.skill_id` and Fernet-encrypted `secret_ciphertext`.

Plus three `BaseEntity` subclasses, three `BaseCollection` subclasses,
and an agent-scope migration registration declaring
`depends_on=("conversations", "agent_skills")`.

No tick engine, no dispatch handler, no agent tools, and no Pydantic
API models live in this package.

## Partitioning

All three tables partition by `conversation_id` (wake operations are
conversation-scoped). The Collections expose `partition_column =
"conversation_id"` so the workspace partition-column enforcement walker
audits every SQL string touching these tables for the predicate.

There is intentionally NO database-level FK on `conversation_id` ->
`conversations(conversation_id)`. The 3tears `conversations` table
carries a composite PK `(agent_id, conversation_id)` and no standalone
`UNIQUE (conversation_id)` constraint, so a single-column FK is not
legal. The same precedent applies in `packages/agent/tools/`
(`context_items.conversation_id`) and `packages/agent/skills/`
(`agent_skill_invocations.conversation_id`). Conversation lifecycle is
governed by app-level cascade through `ConversationsCollection`.

**Orphan-row implication.** Because there is no DB-level FK, deleting a
row from `conversations` does NOT automatically remove the wake
schedules, fires, or webhook subscriptions for that conversation.
They become orphans (rows whose `conversation_id` no longer resolves).
The partition-column enforcement walker keeps the application blind to
orphans (every query is filtered by `conversation_id` so an orphan is
invisible at the read path), but the rows still occupy storage. This
is the same trade-off agent-tools and agent-skills make. A future
cross-package cleanup (a TRIGGER on `conversations`-delete that fans
out to dependent tables, or a periodic GC job in `ConversationsCollection`)
would close the gap; that work is intentionally cross-cutting and
out of scope for this package.

## Migration registration

```python
from threetears.agent.wake import register as register_wake
from threetears.core.data.migrations import MigrationRunner

runner = MigrationRunner()
register_wake(runner)
```

Migrations are agent-scoped and declare
`depends_on=("conversations", "agent_skills")` -- the canonical
`MigrationRunner` topologically orders the agent-scope pass so the
`conversations` + `agent_skills` migrations apply before any wake
table is created.

## Design references

See `docs/agent-wake/README.md` for the package overview and the
locked design decisions.
