systemprompt_identifiers/
lib.rs

1//! Typed newtype identifiers for systemprompt.io.
2//!
3//! Every entity in the platform is referenced through a wrapper newtype
4//! rather than a raw `String`.
5//!
6//! This crate provides both the macros that generate those wrappers
7//! ([`define_id!`], [`define_token!`]) and the canonical concrete types
8//! (`UserId`, `AgentId`, `TaskId`, `TraceId`, `ContextId`, `SessionId`,
9//! `McpServerId`, ...).
10//!
11//! Boundary types for talking to the database — [`DbValue`], [`ToDbValue`],
12//! [`FromDbValue`], [`JsonRow`] — also live here so that identifier modules
13//! can interoperate without depending on the database crate.
14//!
15//! # Construction
16//!
17//! ```ignore
18//! use systemprompt_identifiers::{TaskId, UserId};
19//!
20//! // Known string value (literal, parsed input, DB row).
21//! let user = UserId::new("user_abc");
22//!
23//! // Mint a fresh UUID-backed identifier.
24//! let task = TaskId::generate();
25//! ```
26//!
27//! Validated identifiers (`McpServerId`, `Email`, `ProfileName`,
28//! `ValidatedUrl`, `ValidatedFilePath`, `AgentName`) additionally expose a
29//! fallible `try_new` constructor returning [`error::IdValidationError`].
30//!
31//! # Feature flags
32//!
33//! | Feature | Effect |
34//! |---------|--------|
35//! | (default) | Pure-Rust types only. |
36//! | `sqlx` | Derives `sqlx::Type` on every identifier, allowing direct binding in `query_as!` macros. |
37//!
38//! Copyright (c) systemprompt.io — Business Source License 1.1.
39//! See <https://systemprompt.io> for licensing details.
40
41pub mod db_value;
42
43pub use db_value::{DbValue, FromDbValue, JsonRow, ToDbValue, parse_database_datetime};
44
45mod actor;
46mod agent;
47mod ai;
48mod auth;
49mod client;
50mod cloud;
51mod connection;
52mod content;
53mod context;
54mod email;
55mod evaluation;
56mod events;
57mod execution;
58mod funnel;
59mod gateway_boot;
60mod gateway_conversation;
61mod hook;
62mod jobs;
63mod links;
64mod locale;
65mod marketplace;
66mod mcp;
67mod oauth;
68mod path;
69mod plugin;
70mod policy;
71mod profile;
72mod provider_request;
73mod roles;
74mod section;
75mod session;
76mod slack;
77mod task;
78mod teams;
79mod tenant;
80mod trace;
81mod url;
82mod user;
83mod webhook;
84
85pub mod error;
86pub mod headers;
87pub mod macros;
88
89pub use actor::{Actor, ActorKind, ActorKindTag};
90pub use agent::{AgentId, AgentName, ExternalAgentId};
91pub use ai::{
92    AiGatewayPolicyId, AiQuotaBucketId, AiRequestId, AiSafetyFindingId, ConfigId, MessageId,
93};
94pub use auth::{
95    ApiKeyId, ApiKeySecret, CloudAuthToken, DeviceCertId, DeviceId, JwtToken, SessionToken,
96};
97pub use client::{ClientId, ClientType};
98pub use cloud::PriceId;
99pub use connection::ConnectionId;
100pub use content::{CategoryId, ContentId, FileId, SkillId, SourceId, TagId};
101pub use context::ContextId;
102pub use email::Email;
103pub use evaluation::{
104    EvalCaseId, EvalJudgeCallId, EvalPairId, EvalResultId, EvalRubricId, EvalRunId,
105};
106pub use events::EventOutboxId;
107pub use execution::{ArtifactId, ExecutionStepId, LogId, TokenId};
108pub use funnel::{EngagementEventId, FunnelId, FunnelProgressId};
109pub use gateway_boot::{DepartmentId, DepartmentName, ModelId, ProviderId, RouteId, SecretName};
110pub use gateway_conversation::GatewayConversationId;
111pub use hook::HookId;
112pub use jobs::{JobName, ScheduledJobId};
113pub use links::{CampaignId, LinkClickId, LinkId};
114pub use locale::LocaleCode;
115pub use marketplace::MarketplaceId;
116pub use mcp::{AiToolCallId, McpExecutionId, McpServerId, McpToolName};
117pub use oauth::{AccessTokenId, AuthorizationCode, ChallengeId, RefreshTokenId};
118pub use path::ValidatedFilePath;
119pub use plugin::PluginId;
120pub use policy::{CallId, PolicyId, PolicyVersion, SecretPatternId};
121pub use profile::ProfileName;
122pub use provider_request::ProviderRequestId;
123pub use roles::RoleId;
124pub use section::SectionId;
125pub use session::{SessionId, SessionSource};
126pub use slack::{SlackChannelId, SlackUserId, SlackWorkspaceId};
127pub use task::TaskId;
128pub use teams::{TeamsConversationId, TeamsTenantId, TeamsUserId};
129pub use tenant::TenantId;
130pub use trace::TraceId;
131pub use url::ValidatedUrl;
132pub use user::UserId;
133pub use webhook::WebhookEndpointId;
134
135define_id!(RuleId, generate);
systemprompt_identifiers/lib.rs

systemprompt_identifiers/
lib.rs
