πŸ“„ File detail

types/ids.ts

🧩 .tsπŸ“ 45 linesπŸ’Ύ 1,295 bytesπŸ“ text
← Back to All Files

🎯 Use case

This file lives under β€œtypes/”, which covers shared TypeScript types and generated typings. On the API surface it exposes SessionId, AgentId, asSessionId, asAgentId, and toAgentId β€” mainly functions, hooks, or classes. What the file header says: Branded types for session and agent IDs. These prevent accidentally mixing up session IDs and agent IDs at compile time.

Generated from folder role, exports, dependency roots, and inline comments β€” not hand-reviewed for every path.

🧠 Inline summary

Branded types for session and agent IDs. These prevent accidentally mixing up session IDs and agent IDs at compile time.

πŸ“€ Exports (heuristic)

  • SessionId
  • AgentId
  • asSessionId
  • asAgentId
  • toAgentId

πŸ–₯️ Source preview

/**
 * Branded types for session and agent IDs.
 * These prevent accidentally mixing up session IDs and agent IDs at compile time.
 */

/**
 * A session ID uniquely identifies a Claude Code session.
 * Returned by getSessionId().
 */
export type SessionId = string & { readonly __brand: 'SessionId' }

/**
 * An agent ID uniquely identifies a subagent within a session.
 * Returned by createAgentId().
 * When present, indicates the context is a subagent (not the main session).
 */
export type AgentId = string & { readonly __brand: 'AgentId' }

/**
 * Cast a raw string to SessionId.
 * Use sparingly - prefer getSessionId() when possible.
 */
export function asSessionId(id: string): SessionId {
  return id as SessionId
}

/**
 * Cast a raw string to AgentId.
 * Use sparingly - prefer createAgentId() when possible.
 */
export function asAgentId(id: string): AgentId {
  return id as AgentId
}

const AGENT_ID_PATTERN = /^a(?:.+-)?[0-9a-f]{16}$/

/**
 * Validate and brand a string as AgentId.
 * Matches the format produced by createAgentId(): `a` + optional `<label>-` + 16 hex chars.
 * Returns null if the string doesn't match (e.g. teammate names, team-addressing).
 */
export function toAgentId(s: string): AgentId | null {
  return AGENT_ID_PATTERN.test(s) ? (s as AgentId) : null
}