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`, `ContextId`, `Email`, `ProfileName`,
28//! `ValidatedUrl`, `ValidatedFilePath`, `AgentName`, ...) expose **only** the
29//! fallible `try_new` constructor returning [`error::IdValidationError`];
30//! there is no infallible `new` that could panic on runtime input. Values
31//! minted by the platform itself (`ContextId::generate`, `AgentName::system`)
32//! come from dedicated constructors.
33//!
34//! # Feature flags
35//!
36//! | Feature | Effect |
37//! |---------|--------|
38//! | (default) | Pure-Rust types only. |
39//! | `sqlx` | Derives `sqlx::Type` on every identifier, allowing direct binding in `query_as!` macros. |
40//!
41//! Copyright (c) systemprompt.io — Business Source License 1.1.
42//! See <https://systemprompt.io> for licensing details.
43
44pub mod db_value;
45
46pub use db_value::{DbValue, FromDbValue, JsonRow, ToDbValue, parse_database_datetime};
47
48mod actor;
49mod agent;
50mod ai;
51mod auth;
52mod client;
53mod client_session;
54mod cloud;
55mod connection;
56mod content;
57mod context;
58mod email;
59mod engagement;
60mod events;
61mod execution;
62mod gateway_boot;
63mod gateway_conversation;
64mod hook;
65mod instance;
66mod jobs;
67mod links;
68mod locale;
69mod managed;
70mod marketplace;
71mod mcp;
72mod oauth;
73mod path;
74mod plugin;
75mod policy;
76mod profile;
77mod provider_request;
78mod roles;
79mod section;
80mod session;
81mod slack;
82mod task;
83mod teams;
84mod tenant;
85mod trace;
86mod url;
87mod user;
88mod webhook;
89
90pub mod error;
91pub mod headers;
92pub mod macros;
93
94pub use actor::{Actor, ActorKind, ActorKindTag};
95pub use agent::{AgentId, AgentName, ExternalAgentId};
96pub use ai::{
97    AiGatewayPolicyId, AiQuotaBucketId, AiRequestId, AiSafetyFindingId, ConfigId, MessageId,
98};
99pub use auth::{
100    ApiKeyId, ApiKeySecret, CloudAuthToken, DeviceCertId, DeviceId, JwtToken, SessionToken,
101};
102pub use client::{ClientId, ClientType};
103pub use client_session::ClientSessionId;
104pub use cloud::PriceId;
105pub use connection::ConnectionId;
106pub use content::{CategoryId, ContentId, FileId, SkillId, SourceId, TagId};
107pub use context::ContextId;
108pub use email::Email;
109pub use engagement::EngagementEventId;
110pub use events::EventOutboxId;
111pub use execution::{ArtifactId, ExecutionStepId, LogId, TokenId};
112pub use gateway_boot::{DepartmentId, DepartmentName, ModelId, ProviderId, RouteId, SecretName};
113pub use gateway_conversation::GatewayConversationId;
114pub use hook::HookId;
115pub use instance::InstanceId;
116pub use jobs::{JobName, ScheduledJobId};
117pub use links::{CampaignId, LinkClickId, LinkId};
118pub use locale::LocaleCode;
119pub use managed::{
120    ConsumerInstallationId, DistributionId, InstallationReceiptId, InstallationSessionBindingId,
121    InventoryEntryId, ManagedReconciliationId, ManagedResourceId, ManagedSourceId, NativeSessionId,
122    PublicationId, PublicationReviewId, ResourceRevisionId, SourceSnapshotId, WithdrawalProposalId,
123};
124pub use marketplace::MarketplaceId;
125pub use mcp::{AiToolCallId, McpExecutionId, McpServerId, McpToolName};
126pub use oauth::{AccessTokenId, AuthorizationCode, ChallengeId, RefreshTokenId};
127pub use path::ValidatedFilePath;
128pub use plugin::PluginId;
129pub use policy::{CallId, PolicyId, PolicyVersion, SecretPatternId};
130pub use profile::ProfileName;
131pub use provider_request::ProviderRequestId;
132pub use roles::RoleId;
133pub use section::SectionId;
134pub use session::{SessionId, SessionSource};
135pub use slack::{SlackChannelId, SlackUserId, SlackWorkspaceId};
136pub use task::TaskId;
137pub use teams::{TeamsConversationId, TeamsTenantId, TeamsUserId};
138pub use tenant::TenantId;
139pub use trace::TraceId;
140pub use url::ValidatedUrl;
141pub use user::UserId;
142pub use webhook::WebhookEndpointId;
143
144define_id!(RuleId, generate);
145pub use managed::ResourceInvocationId;
systemprompt_identifiers/lib.rs

systemprompt_identifiers/
lib.rs
