oc_chat
Loading...
Searching...
No Matches
oc_chat.registry.roadmap.operations Namespace Reference

Functions

OperationLogRow roadmap_item_create (Registry registry, *, str item_id, str title, str actor_slot, ActorType actor_type, RoadmapTrackKind track_kind="m_phase", str|None phase_code=None, str|None phase_label=None, str|None parent_item_id=None, str|None prose=None, str|None prose_path=None, RoadmapStatus status="todo", RoadmapPriority|None priority=None, int sort_order=0, str|None target_version=None, str|None introduced_in_version_id=None, str|None closed_in_version_id=None, int|None closed_round_no=None, str|None superseded_by_item_id=None, str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
OperationLogRow roadmap_item_set_status (Registry registry, *, str item_id, RoadmapStatus|None from_status, RoadmapStatus to_status, str actor_slot, ActorType actor_type, str|None in_version_id=None, int|None closed_round_no=None, str|None superseded_by_item_id=None, str|None note=None, str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
OperationLogRow roadmap_item_add_dependency (Registry registry, *, str from_item_id, str to_item_id, str actor_slot, ActorType actor_type, DependencyKind kind="gates", str|None in_version_id=None, str|None note=None, str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
OperationLogRow roadmap_version_bump (Registry registry, *, str|None from_version_id, str to_version_id, str actor_slot, ActorType actor_type, Literal["patch", "minor", "major", "out_of_round_revision"] bump_kind="patch", str|None era_id=None, Literal["draft", "current", "superseded"] status="draft", str|None released_at=None, str|None last_updated_at=None, int|None source_round_no=None, str|None notes=None, str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
OperationLogRow roadmap_phase_complete (Registry registry, *, str phase_code, str actor_slot, ActorType actor_type, str|None in_version_id=None, str|None note=None, str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
OperationLogRow roadmap_section_upsert (Registry registry, *, str file_kind, str section_path, int sort_order, str query_kind, str actor_slot, ActorType actor_type, str|None query_params_json=None, str|None required_min_version=None, bool active=True, str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
OperationLogRow roadmap_plan_link_create (Registry registry, *, str plan_id, str item_id, str actor_slot, ActorType actor_type, ContributionKind contribution="partial", str|None command=None, Mapping[str, object]|None auth_proof=None, bool system_actor=False)
None _require_auth (Mapping[str, object]|None auth_proof, bool system_actor, str command, str actor_slot)

Variables

 ActorType = Literal["human_operator", "orchestrator_agent", "worker_agent"]
 RoadmapStatus = Literal["todo", "in_progress", "done", "deferred", "blocked", "superseded"]
 RoadmapPriority = Literal["critical", "high", "medium", "lower"]
 RoadmapTrackKind = Literal["m_phase", "backlog", "vision", "git_workflow", "pre_m0_era"]
 DependencyKind = Literal["blocks", "enables", "gates", "part_of"]
 ContributionKind = Literal["full", "partial", "context_only"]

Detailed Description

Roadmap registry operation executors.

Purpose
-------
Expose typed helpers for the roadmap v0.3 operation catalog.

Responsibilities
----------------
- Build versioned payloads for roadmap item, version, phase, section, and
  plan-link operations.
- Require HMAC proof for non-system callers before invoking the registry seam.
- Keep SQL ownership inside the SQLite backend projection layer.

Diagnostics
-----------
Domain: OC_CHAT.MAIN
Levels:
    L2 - operation helper lifecycle
    L3 - payload construction details
    L4 - preflight validation details

Contracts
---------
- Every mutating helper calls Registry.execute_domain_command.
- The module performs no direct SQL, filesystem, subprocess, or clock work.

Dependencies
------------
- oc_chat.registry.api (Registry facade)
- oc_chat.registry.errors (HMAC preflight error)
- oc_chat.registry.backends.base (OperationLogRow type returned by each helper)
- oc_diagnostics (structured debug logging via _dbg)

Function Documentation

◆ _require_auth()

None oc_chat.registry.roadmap.operations._require_auth ( Mapping[str, object] | None auth_proof,
bool system_actor,
str command,
str actor_slot )
protected

Definition at line 338 of file operations.py.

Here is the caller graph for this function:

◆ roadmap_item_add_dependency()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_item_add_dependency ( Registry registry,
* ,
str from_item_id,
str to_item_id,
str actor_slot,
ActorType actor_type,
DependencyKind kind = "gates",
str | None in_version_id = None,
str | None note = None,
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Create an item-to-item dependency.

Definition at line 156 of file operations.py.

Here is the call graph for this function:

◆ roadmap_item_create()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_item_create ( Registry registry,
* ,
str item_id,
str title,
str actor_slot,
ActorType actor_type,
RoadmapTrackKind track_kind = "m_phase",
str | None phase_code = None,
str | None phase_label = None,
str | None parent_item_id = None,
str | None prose = None,
str | None prose_path = None,
RoadmapStatus status = "todo",
RoadmapPriority | None priority = None,
int sort_order = 0,
str | None target_version = None,
str | None introduced_in_version_id = None,
str | None closed_in_version_id = None,
int | None closed_round_no = None,
str | None superseded_by_item_id = None,
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Create or upsert a roadmap item through the registry seam.

Definition at line 60 of file operations.py.

Here is the call graph for this function:

◆ roadmap_item_set_status()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_item_set_status ( Registry registry,
* ,
str item_id,
RoadmapStatus | None from_status,
RoadmapStatus to_status,
str actor_slot,
ActorType actor_type,
str | None in_version_id = None,
int | None closed_round_no = None,
str | None superseded_by_item_id = None,
str | None note = None,
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Set a roadmap item status and append a roadmap item event.

Definition at line 117 of file operations.py.

Here is the call graph for this function:

◆ roadmap_phase_complete()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_phase_complete ( Registry registry,
* ,
str phase_code,
str actor_slot,
ActorType actor_type,
str | None in_version_id = None,
str | None note = None,
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Mark a roadmap phase complete.

Definition at line 236 of file operations.py.

Here is the call graph for this function:

◆ roadmap_plan_link_create()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_plan_link_create ( Registry registry,
* ,
str plan_id,
str item_id,
str actor_slot,
ActorType actor_type,
ContributionKind contribution = "partial",
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Link a plan to a roadmap item.

Definition at line 306 of file operations.py.

Here is the call graph for this function:

◆ roadmap_section_upsert()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_section_upsert ( Registry registry,
* ,
str file_kind,
str section_path,
int sort_order,
str query_kind,
str actor_slot,
ActorType actor_type,
str | None query_params_json = None,
str | None required_min_version = None,
bool active = True,
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Upsert roadmap render-section configuration.

Definition at line 267 of file operations.py.

Here is the call graph for this function:

◆ roadmap_version_bump()

OperationLogRow oc_chat.registry.roadmap.operations.roadmap_version_bump ( Registry registry,
* ,
str | None from_version_id,
str to_version_id,
str actor_slot,
ActorType actor_type,
Literal["patch", "minor", "major", "out_of_round_revision"] bump_kind = "patch",
str | None era_id = None,
Literal["draft", "current", "superseded"] status = "draft",
str | None released_at = None,
str | None last_updated_at = None,
int | None source_round_no = None,
str | None notes = None,
str | None command = None,
Mapping[str, object] | None auth_proof = None,
bool system_actor = False )
Create a new roadmap version row.

Definition at line 193 of file operations.py.

Here is the call graph for this function:

Variable Documentation

◆ ActorType

oc_chat.registry.roadmap.operations.ActorType = Literal["human_operator", "orchestrator_agent", "worker_agent"]

Definition at line 52 of file operations.py.

◆ ContributionKind

oc_chat.registry.roadmap.operations.ContributionKind = Literal["full", "partial", "context_only"]

Definition at line 57 of file operations.py.

◆ DependencyKind

oc_chat.registry.roadmap.operations.DependencyKind = Literal["blocks", "enables", "gates", "part_of"]

Definition at line 56 of file operations.py.

◆ RoadmapPriority

oc_chat.registry.roadmap.operations.RoadmapPriority = Literal["critical", "high", "medium", "lower"]

Definition at line 54 of file operations.py.

◆ RoadmapStatus

oc_chat.registry.roadmap.operations.RoadmapStatus = Literal["todo", "in_progress", "done", "deferred", "blocked", "superseded"]

Definition at line 53 of file operations.py.

◆ RoadmapTrackKind

oc_chat.registry.roadmap.operations.RoadmapTrackKind = Literal["m_phase", "backlog", "vision", "git_workflow", "pre_m0_era"]

Definition at line 55 of file operations.py.