Expand description
Typed newtype identifiers for systemprompt.io.
Every entity in the platform is referenced through a wrapper newtype
rather than a raw String.
This crate provides both the macros that generate those wrappers
(define_id!, define_token!) and the canonical concrete types
(UserId, AgentId, TaskId, TraceId, ContextId, SessionId,
McpServerId, …).
Boundary types for talking to the database — DbValue, ToDbValue,
FromDbValue, JsonRow — also live here so that identifier modules
can interoperate without depending on the database crate.
§Construction
use systemprompt_identifiers::{TaskId, UserId};
// Known string value (literal, parsed input, DB row).
let user = UserId::new("user_abc");
// Mint a fresh UUID-backed identifier.
let task = TaskId::generate();Validated identifiers (McpServerId, ContextId, Email, ProfileName,
ValidatedUrl, ValidatedFilePath, AgentName, …) expose only the
fallible try_new constructor returning error::IdValidationError;
there is no infallible new that could panic on runtime input. Values
minted by the platform itself (ContextId::generate, AgentName::system)
come from dedicated constructors.
§Feature flags
| Feature | Effect |
|---|---|
| (default) | Pure-Rust types only. |
sqlx | Derives sqlx::Type on every identifier, allowing direct binding in query_as! macros. |
Copyright (c) systemprompt.io — Business Source License 1.1. See https://systemprompt.io for licensing details.
Re-exports§
pub use db_value::DbValue;pub use db_value::FromDbValue;pub use db_value::JsonRow;pub use db_value::ToDbValue;pub use db_value::parse_database_datetime;
Modules§
- db_
value - Database-value abstraction shared between repository code and the identifier crate.
- error
- Error types raised by identifier validation and database value conversion.
- headers
- Canonical HTTP header name constants used throughout the platform for propagating trace, session, and authorization context across services.
- macros
- Declarative macros that generate the typed identifier and token newtypes.
Macros§
Structs§
- Access
Token Id - Actor
- AgentId
- Agent
Name - AiGateway
Policy Id - AiQuota
Bucket Id - AiRequest
Id - AiSafety
Finding Id - AiTool
Call Id - Analytics
Change Id - Analytics
Fact Id - Analytics
Snapshot JobId - Analytics
Worker Id - ApiKey
Id - ApiKey
Secret - Artifact
Id - Authorization
Code - CallId
- Campaign
Id - Category
Id - Challenge
Id - Client
Id - Client
Session Id - Cloud
Auth Token - Config
Id - Connection
Id - Consumer
Installation Id - Content
Id - Context
Id - Department
Id - Department
Name - Dependency
Verification Id - Device
Cert Id - Device
Id - Distribution
Id - Engagement
Event Id - Event
Outbox Id - Execution
Step Id - External
Agent Id - FileId
- Funnel
Id - Funnel
Progress Id - Gateway
Conversation Id - HookId
- Installation
Receipt Id - Installation
Session Binding Id - Instance
Id - Inventory
Entry Id - Invocation
Attribution Id - JobName
- JwtToken
- Link
Click Id - LinkId
- Locale
Code - LogId
- Managed
Reconciliation Id - Managed
Resource Id - Managed
Source Id - Marketplace
Id - McpExecution
Id - McpServer
Id - McpTool
Name - Message
Id - ModelId
- Native
Session Id - Plugin
Id - Policy
Id - Policy
Version - PriceId
- Profile
Name - Provider
Id - Provider
Request Id - Publication
Id - Publication
Review Id - Refresh
Token Id - Resource
Invocation Id - Resource
Revision Id - RoleId
- RouteId
- RuleId
- Scheduled
JobId - Secret
Name - Secret
Pattern Id - Section
Id - Session
Id - Session
Token - SkillId
- Slack
Channel Id - Slack
User Id - Slack
Workspace Id - Source
Id - Source
Snapshot Id - TagId
- TaskId
- Teams
Conversation Id - Teams
Tenant Id - Teams
User Id - Tenant
Id - TokenId
- TraceId
- UserId
- Validated
File Path - Validated
Url - Webhook
Endpoint Id - Withdrawal
Proposal Id
Enums§
- Actor
Kind - Actor
Kind Tag - Discriminant-only view of
ActorKind, bound to theactor_kindcolumn ingovernance_decisions. - Client
Type - Session
Source