Skip to content
Sign in

flagon-io/g1t

public
0

g1t/crates/contracts/src/lib.rs

211 lines7,579 bytesCodeBlame

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

API and MCP server, Rust identity service, registration, site redesign1//! Types and service interfaces shared by every g1t service.
2//!
3//! Each service has a module here holding the data it exchanges and the
4//! arguments of each of its methods. Services and their callers depend on
5//! this crate, never on each other's code.
6
About: license, languages, contributors, stars, releases and activity beside the files7pub mod about;
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look8pub mod access;
9pub mod accounts;
GitHub Actions on g1t, part two: running workflows10pub mod actions;
Agents and memory, checks and conflicts, profiles, slug renames, custom domains11pub mod agents;
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API12pub mod audit;
Merge branch 'worktree-agent-ac5b181a013e54348'13pub mod backups;
Agents as a team: lifecycle, merge queue, billing and a new shell14pub mod billing;
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API15pub mod capture;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar16pub mod codeowners;
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API17pub mod credentials;
Rust repos service with shipping; pull requests kept in the model18pub mod events;
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look19pub mod github;
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API20pub mod guardrails;
API and MCP server, Rust identity service, registration, site redesign21pub mod identity;
Inbox: the events service tells people what needs them as events arrive22pub mod inbox;
Integrations: your own model provider, alerts that open issues, tickets agents read23pub mod integrations;
API and MCP server, Rust identity service, registration, site redesign24mod ids;
25mod names;
26mod outcome;
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member27pub mod packages;
Projects: what a workspace builds and runs, first on every page28pub mod projects;
Rust repos service with shipping; pull requests kept in the model29pub mod repos;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge30pub mod rules;
Fast pages, required checks on the branch, self-hosted runners, honest incidents31pub mod runners;
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step32pub mod scopes;
Search across all of g1t, Explore, and a command palette33pub mod search;
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API34pub mod security;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar35pub mod teams;
36pub mod security_suite;
RFC 3339 timestamps in identity and repos37pub mod time;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar38pub mod updates;
Webhooks: every event, to your own addresses, signed and retried39pub mod webhooks;
Work service in Rust, with RFC 3339 timestamps40pub mod work;
API and MCP server, Rust identity service, registration, site redesign41
42pub use ids::new_id;
Merge branch 'worktree-agent-a8385d293d42c913a'43pub use names::{
44 aliasable_name, claimable_namespace, is_namespace_shaped, is_reserved_name, is_route_name, is_valid_namespace,
45 is_valid_repo_name,
46};
API and MCP server, Rust identity service, registration, site redesign47pub use outcome::{Failure, FailureCode, Outcome};
48
49use serde::{Deserialize, Serialize};
50
Workspaces own repositories51/// What a member may do in a workspace.
52#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
53#[serde(rename_all = "lowercase")]
54pub enum Role {
55 /// Everything a member can, plus managing members.
56 Owner,
Issues and pull requests replace intents and attempts57 /// Create repositories, push, manage issues and merge pull requests.
Workspaces own repositories58 Member,
59}
60
61/// One workspace a user belongs to.
API and MCP server, Rust identity service, registration, site redesign62#[derive(Clone, Debug, Serialize, Deserialize)]
Workspaces own repositories63pub struct Membership {
64 /// The workspace's name in URLs: `g1t.sh/<slug>`.
65 pub slug: String,
66 pub role: Role,
Workspace names and icons, and a component kit for every control67 /// The workspace's display name, for showing it to people. Set when a
68 /// user is resolved from credentials; absent on principals made up by
69 /// a service.
70 #[serde(default, skip_serializing_if = "Option::is_none")]
71 pub name: Option<String>,
72 /// The workspace's uploaded icon: the SHA-256 of its bytes, served at
73 /// `/avatars/<avatar>`. Absent means the generated letter avatar.
74 #[serde(default, skip_serializing_if = "Option::is_none")]
75 pub avatar: Option<String>,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look76 /// What a member gets on each of the workspace's repositories: the
77 /// workspace's base permission. Set when a user is resolved from
78 /// credentials; absent means the default, Write. Owners have Admin
79 /// whatever it says. See [`access`].
80 #[serde(default, skip_serializing_if = "Option::is_none")]
81 pub base_permission: Option<access::BasePermission>,
Merge branch 'worktree-agent-ad7c6d88d93adc817'82 /// Who may create the workspace's teams. Set when a user is resolved
83 /// from credentials; absent means the default, any member. See
84 /// [`teams::TeamCreation`].
85 #[serde(default, skip_serializing_if = "Option::is_none")]
86 pub team_creation: Option<teams::TeamCreation>,
Workspaces own repositories87}
88
Workspace names and icons, and a component kit for every control89impl Membership {
90 /// A plain member of `slug`, as services act inside one workspace.
91 pub fn member(slug: impl Into<String>) -> Self {
92 Membership {
93 slug: slug.into(),
94 role: Role::Member,
95 name: None,
96 avatar: None,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look97 base_permission: None,
Merge branch 'worktree-agent-ad7c6d88d93adc817'98 team_creation: None,
Workspace names and icons, and a component kit for every control99 }
100 }
101}
102
Agents as a team: lifecycle, merge queue, billing and a new shell103/// What a set of credentials resolved to.
104#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
105#[serde(rename_all = "lowercase")]
106pub enum PrincipalKind {
107 /// A person's account.
108 #[default]
109 User,
110 /// A workspace, acting through one of its own access tokens. Its `id`
111 /// is the workspace's, its `username` the workspace's slug, and it is a
112 /// member of that workspace and no other.
113 Workspace,
114 /// A g1t agent at work in a sandbox, acting through a token that lives
115 /// as long as its run and can do only what that token's scope lists, in
g1t is one name: its agent's work, commits and comments show as @g1t, and nobody can claim g1t or g1t-agent116 /// one repository. Its `username` is `g1t`.
Agents as a team: lifecycle, merge queue, billing and a new shell117 Agent,
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily118 /// g1t itself: the platform acting on its own, as when it opens a
119 /// pull request to upgrade a vulnerable dependency or merges from the
120 /// queue. Never resolved from credentials: only services make one,
121 /// with [`User::system`]. Its `username` is `g1t`, which nobody can
122 /// register.
123 System,
124}
125
126/// g1t's own identity, as [`PrincipalKind::System`] work is recorded.
127pub mod system {
128 /// Its id wherever an author or actor id is stored.
129 pub const ID: &str = "g1t";
130 /// Its name, shown as the author of what it does.
131 pub const USERNAME: &str = "g1t";
132 /// The address on the commits it makes, which no mailbox receives.
133 pub const EMAIL: &str = "g1t@users.noreply.g1t.sh";
134 /// Ids that earlier versions stored for g1t's own actions, such as a
135 /// merge its settings made. Read as g1t too.
136 pub const LEGACY_IDS: [&str; 3] = ["g1t_policy", "svc_runner", "g1t_runner"];
137
138 /// Whether `id` is g1t's own.
139 pub fn is_system_id(id: &str) -> bool {
140 id == ID || LEGACY_IDS.contains(&id)
141 }
Agents as a team: lifecycle, merge queue, billing and a new shell142}
143
Workspaces own repositories144#[derive(Clone, Debug, Default, Serialize, Deserialize)]
API and MCP server, Rust identity service, registration, site redesign145pub struct User {
146 pub id: String,
147 pub username: String,
Agents as a team: lifecycle, merge queue, billing and a new shell148 #[serde(default)]
149 pub kind: PrincipalKind,
Email verification, password reset, and Git for AI scale positioning150 /// Whether the account's email address has been confirmed. Unverified
151 /// accounts can sign in but cannot create or change anything.
152 #[serde(default)]
153 pub verified: bool,
Workspaces own repositories154 /// The workspaces this user belongs to. Filled in when a user is
155 /// resolved from credentials, so any service can authorize from it.
156 #[serde(default)]
157 pub workspaces: Vec<Membership>,
Workspace names and icons, and a component kit for every control158 /// The person's uploaded avatar: the SHA-256 of its bytes, served at
159 /// `/avatars/<avatar>`. Absent means the generated letter avatar.
160 #[serde(default, skip_serializing_if = "Option::is_none")]
161 pub avatar: Option<String>,
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API162 /// Set on an agent resolved from its token: who it acts for, with which
163 /// credential, and what it may do. See [`credentials`].
164 #[serde(default, skip_serializing_if = "Option::is_none")]
165 pub acting: Option<Box<credentials::Acting>>,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look166 /// The repositories this user has been given a role on directly,
167 /// whether or not they belong to its workspace. Filled in with
168 /// `workspaces`; see [`access`].
169 #[serde(default, skip_serializing_if = "Vec::is_empty")]
170 pub grants: Vec<access::RepoGrant>,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step171 /// Set on a user resolved from an access token: its scopes and the
172 /// workspaces or repositories it is limited to. Absent on a signed-in
173 /// session and on an agent (whose `acting` scope applies instead).
174 /// See [`scopes`].
175 #[serde(default, skip_serializing_if = "Option::is_none")]
176 pub token: Option<Box<scopes::TokenAccess>>,
Workspaces own repositories177}
178
179impl User {
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily180 /// g1t itself, acting in `workspace`: what the platform's own work,
181 /// such as security updates, is done and recorded as.
182 pub fn system(workspace: &str) -> User {
183 User {
184 id: system::ID.to_owned(),
185 username: system::USERNAME.to_owned(),
186 kind: PrincipalKind::System,
187 verified: true,
188 workspaces: vec![Membership::member(workspace.to_lowercase())],
189 ..User::default()
190 }
191 }
192
193 /// Whether this is g1t itself.
194 pub fn is_system(&self) -> bool {
195 self.kind == PrincipalKind::System
196 }
197
Workspaces own repositories198 pub fn role_in(&self, slug: &str) -> Option<Role> {
199 self.workspaces
200 .iter()
201 .find(|membership| membership.slug == slug)
202 .map(|membership| membership.role)
203 }
204
205 pub fn is_member(&self, slug: &str) -> bool {
206 self.role_in(slug).is_some()
207 }
API and MCP server, Rust identity service, registration, site redesign208}
209
210/// Who is asking. Every read and write in every service takes one.
211pub type Viewer = Option<User>;

This file's history is long; its oldest lines are credited to the oldest commit read.