@spec create_session(t(), String.t(), String.t()) :: {:ok, map()} | {:error, error()}

Create a session (login).

Examples

{:ok, session} = Exosphere.ATProto.XRPC.Client.create_session(client, "user@example.com", "password")
client = Exosphere.ATProto.XRPC.Client.with_token(client, session["accessJwt"])

@spec describe_repo(t(), String.t()) :: {:ok, map()} | {:error, error()}

Describe a repository.

Examples

{:ok, info} = Exosphere.ATProto.XRPC.Client.describe_repo(client, "did:plc:...")

@spec get_record(
  t(),
  keyword()
) :: {:ok, map()} | {:error, error()}

Get a record from a repository.

Examples

{:ok, record} = Exosphere.ATProto.XRPC.Client.get_record(client,
  repo: "did:plc:...",
  collection: "app.bsky.feed.post",
  rkey: "3jui7kd2lry2e"
)

@spec list_records(
  t(),
  keyword()
) :: {:ok, map()} | {:error, error()}

List records from a repository.

Examples

{:ok, %{"records" => records}} = Exosphere.ATProto.XRPC.Client.list_records(client,
  repo: "did:plc:...",
  collection: "app.bsky.feed.post",
  limit: 50
)

@spec new(
  String.t(),
  keyword()
) :: t()

Create a new XRPC client.

Options

• :access_token - access token for authentication
• :refresh_token - refresh token
• :dpop - private DPoP JWK (from Exosphere.ATProto.OAuth.Session). When set together with :access_token, requests are DPoP-signed (Authorization: DPoP ... plus a per-request proof header, with automatic nonce retry) instead of plain Bearer
• :timeout - Request timeout in milliseconds (default: 30_000)

Examples

# Unauthenticated client
client = Exosphere.ATProto.XRPC.Client.new("https://bsky.social")

# Authenticated client
client = Exosphere.ATProto.XRPC.Client.new("https://bsky.social",
  access_token: "eyJ...",
  refresh_token: "eyJ..."
)

@spec procedure(t(), String.t(), procedure_body() | keyword(), query_params()) ::
  {:ok, Exosphere.ATProto.HTTP.json_term()} | {:error, error()}

Make an XRPC procedure (HTTP POST).

Procedures are for mutations and may not be idempotent.

Examples

{:ok, %{"uri" => "at://...", "cid" => "bafyrei..."}} =
  Exosphere.ATProto.XRPC.Client.procedure(client, "com.atproto.repo.createRecord",
    repo: "did:plc:...",
    collection: "app.bsky.feed.post",
    record: %{"$type" => "app.bsky.feed.post", "text" => "Hello!"}
  )

@spec query(t(), String.t(), query_params()) ::
  {:ok, Exosphere.ATProto.HTTP.json_term()} | {:error, error()}

Make an XRPC query (HTTP GET).

Queries are for reading data and are idempotent.

Examples

{:ok, %{"did" => "did:plc:..."}} =
  Exosphere.ATProto.XRPC.Client.query(client, "com.atproto.identity.resolveHandle",
    handle: "atproto.com"
  )

@spec refresh_session(t()) :: {:ok, map()} | {:error, error()}

Refresh a session using the refresh token.

Returns {:error, :no_refresh_token} when the client has no refresh token.

@spec upload_blob(t(), binary(), String.t()) :: {:ok, map()} | {:error, error()}

Upload a blob to the PDS.

Examples

{:ok, %{"blob" => blob}} =
  Exosphere.ATProto.XRPC.Client.upload_blob(client, image_bytes, "image/jpeg")

@spec with_token(t(), String.t()) :: t()

Set the access token on a client.