@atproto/lex-client 0.0.10 → 0.0.12

package/dist/xrpc.js.map

@@ -1 +1 @@
-{"version":3,"file":"xrpc.js","sourceRoot":"","sources":["../src/xrpc.ts"],"names":[],"mappings":";;AAqEA,sCAMC;AAgBD,oBAUC;AAaD,4BAMC;AAxHD,gDAAwE;AACxE,gDAAgD;AAChD,oDAW4B;AAE5B,2CAIoB;AACpB,+CAA4C;AAE5C,uCAMkB;AAmClB;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,GAAY;IAEZ,IAAI,GAAG,YAAY,6BAAiB;QAAE,OAAO,GAAG,CAAA;IAChD,IAAI,GAAG,YAAY,6BAAiB;QAAE,OAAO,GAAG,CAAA;IAChD,OAAO,+BAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACtC,CAAC;AAgBM,KAAK,UAAU,IAAI,CACxB,KAAY,EACZ,EAAW,EACX,UAA0B,EAAoB;IAE9C,IAAI,CAAC;QACH,OAAO,MAAM,aAAa,CAAI,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;IACnD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,aAAa,CAAI,GAAG,CAAC,CAAA;IAC7B,CAAC;AACH,CAAC;AAaM,KAAK,UAAU,QAAQ,CAC5B,KAAY,EACZ,EAAW,EACX,UAA0B,EAAoB;IAE9C,OAAO,aAAa,CAAI,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAA,aAAgB,CAAA,CAAC,CAAA;AACrE,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,KAAY,EACZ,EAAW,EACX,UAA0B,EAAoB;IAE9C,MAAM,MAAM,GAAG,IAAA,oBAAO,EAAC,EAAE,CAAC,CAAA;IAC1B,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAA;IAChC,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IACvD,OAAO,0BAAY,CAAC,iBAAiB,CAAI,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;AACrE,CAAC;AAED,SAAS,cAAc,CACrB,MAAS,EACT,OAA0C;IAE1C,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,IAAI,EAAE,CAAA;IAEnC,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU;QACnC,EAAE,iBAAiB,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;SACxC,QAAQ,EAAE,CAAA;IAEb,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACtD,CAAC;AAED,SAAS,eAAe,CACtB,MAAS,EACT,OAGC;IAED,MAAM,OAAO,GAAG,IAAA,6BAAmB,EAAC,OAAO,CAAC,CAAA;IAE5C,wDAAwD;IACxD,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC/C,CAAC;IAED,4CAA4C;IAC5C,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC/C,MAAM,IAAI,SAAS,CAAC,mCAAmC,WAAW,GAAG,CAAC,CAAA;IACxE,CAAC;IAED,qBAAqB;IACrB,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAA;QACrC,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;QAE/D,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7C,CAAC;aAAM,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,6BAA6B,YAAY,GAAG,CAAC,CAAA;QACnE,CAAC;QAED,OAAO;YACL,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,cAAc,EAAE,iCAAiC,EAAE,YAAY;YAC/D,IAAI,EAAE,MAAM,EAAE,YAAY;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,KAAK,EAAE,IAAI;SAClB,CAAA;IACH,CAAC;IAED,wBAAwB;IACxB,OAAO;QACL,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,QAAQ;QAClB,cAAc,EAAE,iCAAiC,EAAE,YAAY;QAC/D,IAAI,EAAE,MAAM,EAAE,YAAY;QAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,KAAK;QACb,OAAO;KACR,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAiB,EACjB,OAA2D,EAC3D,YAAqB;IAErB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;IACxB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;IAExB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,kEAAkE;IAClE,IAAI,KAAK,CAAC,QAAQ,KAAK,kBAAkB,EAAE,CAAC;QAC1C,uEAAuE;QACvE,mDAAmD;QACnD,IAAI,CAAC,IAAA,sBAAW,EAAC,IAAI,CAAC,IAAI,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,SAAS,CAAC,+BAA+B,OAAO,IAAI,EAAE,CAAC,CAAA;QACnE,CAAC;QAED,OAAO,YAAY,CAAC,KAAK,EAAE,IAAA,uBAAY,EAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAA;IAC9D,CAAC;IAED,8DAA8D;IAC9D,QAAQ,OAAO,IAAI,EAAE,CAAC;QACpB,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QAChD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,IAAI,KAAK,IAAI;gBAAE,MAAK;YACxB,IACE,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;gBACxB,IAAI,YAAY,WAAW;gBAC3B,IAAI,YAAY,cAAc,EAC9B,CAAC;gBACD,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;YAChD,CAAC;iBAAM,IAAI,IAAA,yBAAe,EAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,OAAO,YAAY,CAAC,KAAK,EAAE,IAAA,0BAAgB,EAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,IAAA,oBAAU,EAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,CAAA;YAC7D,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,IAAI,SAAS,CACjB,WAAW,OAAO,IAAI,aAAa,KAAK,CAAC,QAAQ,WAAW,CAC7D,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CACnB,MAAe,EACf,IAA0B,EAC1B,YAAqB;IAErB,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CACjB,iBAAiB,OAAO,IAAI,+BAA+B,CAC5D,CAAA;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,0EAA0E;QAC1E,2EAA2E;QAC3E,oEAAoE;QACpE,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACpD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,MAAe,EAAE,YAAqB;IAC3D,iDAAiD;IACjD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,YAAY,EAAE,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CACjB,yCAAyC,YAAY,UAAU,MAAM,CAAC,QAAQ,YAAY,CAC3F,CAAA;QACH,CAAC;QACD,OAAO,YAAY,CAAA;IACrB,CAAC;IAED,WAAW;IAEX,IAAI,MAAM,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC9B,OAAO,0BAA0B,CAAA;IACnC,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;YAClC,CAAC,CAAC,2BAA2B;YAC7B,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,iBAAiB,CAAA;IACzC,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,OAAO,MAAM,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED,MAAM,IAAI,SAAS,CACjB,yFAAyF,MAAM,CAAC,QAAQ,GAAG,CAC5G,CAAA;AACH,CAAC","sourcesContent":["import { LexValue, isLexScalar, isPlainObject } from '@atproto/lex-data'\nimport { lexStringify } from '@atproto/lex-json'\nimport {\n  InferInput,\n  InferPayload,\n  Main,\n  Params,\n  Payload,\n  Procedure,\n  Query,\n  Restricted,\n  Subscription,\n  getMain,\n} from '@atproto/lex-schema'\nimport { Agent } from './agent.js'\nimport {\n  XrpcResponseError,\n  XrpcUnexpectedError,\n  XrpcUpstreamError,\n} from './errors.js'\nimport { XrpcResponse } from './response.js'\nimport { BinaryBodyInit, CallOptions } from './types.js'\nimport {\n  XrpcPayload,\n  buildAtprotoHeaders,\n  isAsyncIterable,\n  isBlobLike,\n  toReadableStream,\n} from './util.js'\n\n// If all params are optional, allow omitting the params object\ntype XrpcParamsOptions<P extends Params> =\n  NonNullable<unknown> extends P ? { params?: P } : { params: P }\n\nexport type XrpcRequestParams<M extends Procedure | Query | Subscription> =\n  InferInput<M['parameters']>\n\ntype XrpcRequestPayload<M extends Procedure | Query> = M extends Procedure\n  ? InferPayload<M['input'], BinaryBodyInit>\n  : undefined\n\ntype XrpcInputOptions<In> = In extends { body: infer B; encoding: infer E }\n  ? // encoding will be inferred from the schema at runtime if not provided\n    { body: B; encoding?: E }\n  : { body?: undefined; encoding?: undefined }\n\nexport type XrpcOptions<M extends Procedure | Query = Procedure | Query> =\n  CallOptions &\n    XrpcInputOptions<XrpcRequestPayload<M>> &\n    XrpcParamsOptions<XrpcRequestParams<M>>\n\nexport type XrpcFailure<M extends Procedure | Query> =\n  // The server returned a valid XRPC error response\n  | XrpcResponseError<M>\n  // The response was not a valid XRPC response, or it does not match the schema\n  | XrpcUpstreamError\n  // Something went wrong (network error, etc.)\n  | XrpcUnexpectedError\n\nexport type XrpcResult<M extends Procedure | Query> =\n  | XrpcResponse<M>\n  | XrpcFailure<M>\n\n/**\n * Utility method to type cast the error thrown by {@link xrpc} to an\n * {@link XrpcFailure} matching the provided method. Only use this function\n * inside a catch block right after calling {@link xrpc}, and use the same\n * method type parameter as used in the {@link xrpc} call.\n */\nexport function asXrpcFailure<M extends Procedure | Query = Procedure | Query>(\n  err: unknown,\n): XrpcFailure<M> {\n  if (err instanceof XrpcResponseError) return err\n  if (err instanceof XrpcUpstreamError) return err\n  return XrpcUnexpectedError.from(err)\n}\n\n/**\n * @throws XrpcFailure<M>\n */\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: NonNullable<unknown> extends XrpcOptions<M>\n    ? Main<M>\n    : Restricted<'This XRPC method requires an \"options\" argument'>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResponse<M>> {\n  try {\n    return await lexRpcRequest<M>(agent, ns, options)\n  } catch (err) {\n    throw asXrpcFailure<M>(err)\n  }\n}\n\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: NonNullable<unknown> extends XrpcOptions<M>\n    ? Main<M>\n    : Restricted<'This XRPC method requires an \"options\" argument'>,\n): Promise<XrpcResult<M>>\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResult<M>>\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResult<M>> {\n  return lexRpcRequest<M>(agent, ns, options).catch(asXrpcFailure<M>)\n}\n\nasync function lexRpcRequest<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResponse<M>> {\n  const method = getMain(ns)\n  options.signal?.throwIfAborted()\n  const url = xrpcRequestUrl(method, options)\n  const request = xrpcRequestInit(method, options)\n  const response = await agent.fetchHandler(url, request)\n  return XrpcResponse.fromFetchResponse<M>(method, response, options)\n}\n\nfunction xrpcRequestUrl<M extends Procedure | Query | Subscription>(\n  method: M,\n  options: CallOptions & { params?: Params },\n) {\n  const path = `/xrpc/${method.nsid}`\n\n  const queryString = method.parameters\n    ?.toURLSearchParams(options.params ?? {})\n    .toString()\n\n  return queryString ? `${path}?${queryString}` : path\n}\n\nfunction xrpcRequestInit<T extends Procedure | Query>(\n  schema: T,\n  options: CallOptions & {\n    body?: LexValue | BinaryBodyInit\n    encoding?: string\n  },\n): RequestInit & { duplex?: 'half' } {\n  const headers = buildAtprotoHeaders(options)\n\n  // Tell the server what type of response we're expecting\n  if (schema.output.encoding) {\n    headers.set('accept', schema.output.encoding)\n  }\n\n  // Caller should not set content-type header\n  if (headers.has('content-type')) {\n    const contentType = headers.get('content-type')\n    throw new TypeError(`Unexpected content-type header (${contentType})`)\n  }\n\n  // Requests with body\n  if ('input' in schema) {\n    const encodingHint = options.encoding\n    const input = xrpcProcedureInput(schema, options, encodingHint)\n\n    if (input) {\n      headers.set('content-type', input.encoding)\n    } else if (encodingHint != null) {\n      throw new TypeError(`Unexpected encoding hint (${encodingHint})`)\n    }\n\n    return {\n      duplex: 'half',\n      redirect: 'follow',\n      referrerPolicy: 'strict-origin-when-cross-origin', // (default)\n      mode: 'cors', // (default)\n      signal: options.signal,\n      method: 'POST',\n      headers,\n      body: input?.body,\n    }\n  }\n\n  // Requests without body\n  return {\n    duplex: 'half',\n    redirect: 'follow',\n    referrerPolicy: 'strict-origin-when-cross-origin', // (default)\n    mode: 'cors', // (default)\n    signal: options.signal,\n    method: 'GET',\n    headers,\n  }\n}\n\nfunction xrpcProcedureInput(\n  method: Procedure,\n  options: CallOptions & { body?: LexValue | BinaryBodyInit },\n  encodingHint?: string,\n): null | XrpcPayload<BodyInit> {\n  const { input } = method\n  const { body } = options\n\n  if (options.validateRequest) {\n    input.schema?.check(body)\n  }\n\n  // Special handling for endpoints expecting application/json input\n  if (input.encoding === 'application/json') {\n    // @NOTE **NOT** using isLexValue here to avoid deep checks in order to\n    // distinguish between LexValue and BinaryBodyInit.\n    if (!isLexScalar(body) && !isPlainObject(body) && !Array.isArray(body)) {\n      throw new TypeError(`Expected LexValue body, got ${typeof body}`)\n    }\n\n    return buildPayload(input, lexStringify(body), encodingHint)\n  }\n\n  // Other encodings will be sent unaltered (ie. as binary data)\n  switch (typeof body) {\n    case 'undefined':\n    case 'string':\n      return buildPayload(input, body, encodingHint)\n    case 'object': {\n      if (body === null) break\n      if (\n        ArrayBuffer.isView(body) ||\n        body instanceof ArrayBuffer ||\n        body instanceof ReadableStream\n      ) {\n        return buildPayload(input, body, encodingHint)\n      } else if (isAsyncIterable(body)) {\n        return buildPayload(input, toReadableStream(body), encodingHint)\n      } else if (isBlobLike(body)) {\n        return buildPayload(input, body, encodingHint || body.type)\n      }\n    }\n  }\n\n  throw new TypeError(\n    `Invalid ${typeof body} body for ${input.encoding} encoding`,\n  )\n}\n\nfunction buildPayload(\n  schema: Payload,\n  body: undefined | BodyInit,\n  encodingHint?: string,\n): null | XrpcPayload<BodyInit> {\n  if (schema.encoding === undefined) {\n    if (body !== undefined) {\n      throw new TypeError(\n        `Cannot send a ${typeof body} body with undefined encoding`,\n      )\n    }\n\n    return null\n  }\n\n  if (body === undefined) {\n    // This error would be returned by the server, but we can catch it earlier\n    // to avoid un-necessary requests. Note that a content-length of 0 does not\n    // necessary mean that the body is \"empty\" (e.g. an empty txt file).\n    throw new TypeError(`A request body is expected but none was provided`)\n  }\n\n  const encoding = buildEncoding(schema, encodingHint)\n  return { encoding, body }\n}\n\nfunction buildEncoding(schema: Payload, encodingHint?: string): string {\n  // Should never happen (required for type safety)\n  if (!schema.encoding) {\n    throw new TypeError('Unexpected payload')\n  }\n\n  if (encodingHint?.length) {\n    if (!schema.matchesEncoding(encodingHint)) {\n      throw new TypeError(\n        `Cannot send a body with content-type \"${encodingHint}\" for \"${schema.encoding}\" encoding`,\n      )\n    }\n    return encodingHint\n  }\n\n  // Fallback\n\n  if (schema.encoding === '*/*') {\n    return 'application/octet-stream'\n  }\n\n  if (schema.encoding.startsWith('text/')) {\n    return schema.encoding.includes('*')\n      ? 'text/plain; charset=utf-8'\n      : `${schema.encoding}; charset=utf-8`\n  }\n\n  if (!schema.encoding.includes('*')) {\n    return schema.encoding\n  }\n\n  throw new TypeError(\n    `Unable to determine payload encoding. Please provide a 'content-type' header matching ${schema.encoding}.`,\n  )\n}\n"]}
+{"version":3,"file":"xrpc.js","sourceRoot":"","sources":["../src/xrpc.ts"],"names":[],"mappings":";;AA0GA,oBAQC;AAmDD,4BAeC;AApLD,gDAAwE;AACxE,gDAAgD;AAChD,oDAW4B;AAE5B,2CAAwD;AACxD,+CAA4C;AAE5C,uCAKkB;AAmFX,KAAK,UAAU,IAAI,CACxB,KAAY,EACZ,EAAW,EACX,UAA0B,EAAoB;IAE9C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAI,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;IACtD,IAAI,QAAQ,CAAC,OAAO;QAAE,OAAO,QAAQ,CAAA;;QAChC,MAAM,QAAQ,CAAA;AACrB,CAAC;AAmDM,KAAK,UAAU,QAAQ,CAC5B,KAAY,EACZ,EAAW,EACX,UAA0B,EAAoB;IAE9C,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAA;IAChC,MAAM,MAAM,GAAM,IAAA,oBAAO,EAAC,EAAE,CAAC,CAAA;IAC7B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAChD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QACvD,OAAO,MAAM,0BAAY,CAAC,iBAAiB,CAAI,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC3E,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,IAAA,yBAAa,EAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACrC,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACrB,MAAS,EACT,OAA0C;IAE1C,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,IAAI,EAAE,CAAA;IAEnC,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU;QACnC,EAAE,iBAAiB,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;SACxC,QAAQ,EAAE,CAAA;IAEb,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACtD,CAAC;AAED,SAAS,eAAe,CACtB,MAAS,EACT,OAGC;IAED,MAAM,OAAO,GAAG,IAAA,6BAAmB,EAAC,OAAO,CAAC,CAAA;IAE5C,wDAAwD;IACxD,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC/C,CAAC;IAED,4CAA4C;IAC5C,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC/C,MAAM,IAAI,SAAS,CAAC,mCAAmC,WAAW,GAAG,CAAC,CAAA;IACxE,CAAC;IAED,qBAAqB;IACrB,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAA;QACrC,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;QAE/D,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7C,CAAC;aAAM,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,6BAA6B,YAAY,GAAG,CAAC,CAAA;QACnE,CAAC;QAED,OAAO;YACL,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,cAAc,EAAE,iCAAiC,EAAE,YAAY;YAC/D,IAAI,EAAE,MAAM,EAAE,YAAY;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,KAAK,EAAE,IAAI;SAClB,CAAA;IACH,CAAC;IAED,wBAAwB;IACxB,OAAO;QACL,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,QAAQ;QAClB,cAAc,EAAE,iCAAiC,EAAE,YAAY;QAC/D,IAAI,EAAE,MAAM,EAAE,YAAY;QAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,KAAK;QACb,OAAO;KACR,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAiB,EACjB,OAA2D,EAC3D,YAAqB;IAErB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;IACxB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;IAExB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,kEAAkE;IAClE,IAAI,KAAK,CAAC,QAAQ,KAAK,kBAAkB,EAAE,CAAC;QAC1C,uEAAuE;QACvE,mDAAmD;QACnD,IAAI,CAAC,IAAA,sBAAW,EAAC,IAAI,CAAC,IAAI,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,SAAS,CAAC,+BAA+B,OAAO,IAAI,EAAE,CAAC,CAAA;QACnE,CAAC;QAED,OAAO,YAAY,CAAC,KAAK,EAAE,IAAA,uBAAY,EAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAA;IAC9D,CAAC;IAED,8DAA8D;IAC9D,QAAQ,OAAO,IAAI,EAAE,CAAC;QACpB,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;QAChD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,IAAI,KAAK,IAAI;gBAAE,MAAK;YACxB,IACE,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;gBACxB,IAAI,YAAY,WAAW;gBAC3B,IAAI,YAAY,cAAc,EAC9B,CAAC;gBACD,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;YAChD,CAAC;iBAAM,IAAI,IAAA,yBAAe,EAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,OAAO,YAAY,CAAC,KAAK,EAAE,IAAA,0BAAgB,EAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,IAAA,oBAAU,EAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,CAAA;YAC7D,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,IAAI,SAAS,CACjB,WAAW,OAAO,IAAI,aAAa,KAAK,CAAC,QAAQ,WAAW,CAC7D,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CACnB,MAAe,EACf,IAA0B,EAC1B,YAAqB;IAErB,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CACjB,iBAAiB,OAAO,IAAI,+BAA+B,CAC5D,CAAA;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,0EAA0E;QAC1E,2EAA2E;QAC3E,oEAAoE;QACpE,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACpD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,MAAe,EAAE,YAAqB;IAC3D,iDAAiD;IACjD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,YAAY,EAAE,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CACjB,yCAAyC,YAAY,UAAU,MAAM,CAAC,QAAQ,YAAY,CAC3F,CAAA;QACH,CAAC;QACD,OAAO,YAAY,CAAA;IACrB,CAAC;IAED,WAAW;IAEX,IAAI,MAAM,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC9B,OAAO,0BAA0B,CAAA;IACnC,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;YAClC,CAAC,CAAC,2BAA2B;YAC7B,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,iBAAiB,CAAA;IACzC,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,OAAO,MAAM,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED,MAAM,IAAI,SAAS,CACjB,yFAAyF,MAAM,CAAC,QAAQ,GAAG,CAC5G,CAAA;AACH,CAAC","sourcesContent":["import { LexValue, isLexScalar, isPlainObject } from '@atproto/lex-data'\nimport { lexStringify } from '@atproto/lex-json'\nimport {\n  InferInput,\n  InferPayload,\n  Main,\n  Params,\n  Payload,\n  Procedure,\n  Query,\n  Restricted,\n  Subscription,\n  getMain,\n} from '@atproto/lex-schema'\nimport { Agent } from './agent.js'\nimport { XrpcFailure, asXrpcFailure } from './errors.js'\nimport { XrpcResponse } from './response.js'\nimport { BinaryBodyInit, CallOptions } from './types.js'\nimport {\n  buildAtprotoHeaders,\n  isAsyncIterable,\n  isBlobLike,\n  toReadableStream,\n} from './util.js'\n\n// If all params are optional, allow omitting the params object\ntype XrpcParamsOptions<P extends Params> =\n  NonNullable<unknown> extends P ? { params?: P } : { params: P }\n\n/**\n * The query/path parameters type for an XRPC method, inferred from its schema.\n *\n * @typeParam M - The XRPC method type (Procedure, Query, or Subscription)\n */\nexport type XrpcRequestParams<M extends Procedure | Query | Subscription> =\n  InferInput<M['parameters']>\n\ntype XrpcRequestPayload<M extends Procedure | Query> = M extends Procedure\n  ? InferPayload<M['input'], BinaryBodyInit>\n  : undefined\n\ntype XrpcInputOptions<In> = In extends { body: infer B; encoding: infer E }\n  ? // encoding will be inferred from the schema at runtime if not provided\n    { body: B; encoding?: E }\n  : { body?: undefined; encoding?: undefined }\n\n/**\n * Options for making an XRPC request.\n *\n * Combines {@link CallOptions} with method-specific params and body requirements.\n * The type system ensures required params/body are provided based on the method schema.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\n * @see {@link CallOptions} for general request options like signal and validateRequest\n * @see {@link XrpcParamsOptions} for method-specific query parameters\n * @see {@link XrpcInputOptions} for method-specific body and encoding requirements\n *\n * @example Query with params\n * ```typescript\n * const options: XrpcOptions<typeof app.bsky.feed.getTimeline.main> = {\n *   params: { limit: 50 }\n * }\n * ```\n *\n * @example Procedure with body\n * ```typescript\n * const options: XrpcOptions<typeof com.atproto.repo.createRecord.main> = {\n *   body: { repo: did, collection: 'app.bsky.feed.post', record: { ... } }\n * }\n * ```\n */\nexport type XrpcOptions<M extends Procedure | Query = Procedure | Query> =\n  CallOptions &\n    XrpcInputOptions<XrpcRequestPayload<M>> &\n    XrpcParamsOptions<XrpcRequestParams<M>>\n\n/**\n * Makes an XRPC request and throws on failure.\n *\n * This is the low-level function for making XRPC calls. For most use cases,\n * prefer using {@link Client.xrpc} which provides a more ergonomic API.\n *\n * @param agent - The {@link Agent} to use for making the request\n * @param ns - The lexicon method definition\n * @param options - Request {@link XrpcOptions options} (params, body, headers, etc.)\n * @returns The successful {@link XrpcResponse}\n * @throws {XrpcFailure} When the request fails\n *\n * @example\n * ```typescript\n * const response = await xrpc(agent, app.bsky.feed.getTimeline.main, {\n *   params: { limit: 50 }\n * })\n * ```\n */\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: NonNullable<unknown> extends XrpcOptions<M>\n    ? Main<M>\n    : Restricted<'This XRPC method requires an \"options\" argument'>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResponse<M>> {\n  const response = await xrpcSafe<M>(agent, ns, options)\n  if (response.success) return response\n  else throw response\n}\n\n/**\n * Union type representing either a successful response or a failure.\n *\n * Both {@link XrpcResponse} and {@link XrpcFailure} have a `success` property\n * that can be used to discriminate between them.\n *\n * @typeParam M - The XRPC method type\n */\nexport type XrpcResult<M extends Procedure | Query> =\n  | XrpcResponse<M>\n  | XrpcFailure<M>\n\n/**\n * Makes an XRPC request without throwing on failure.\n *\n * Returns a discriminated union that can be checked via the `success` property.\n * This is useful for handling errors without try/catch blocks. This also allow\n * failure results to be typed with the method schema, which can provide better\n * type safety when handling errors (e.g. checking for specific error codes).\n *\n * @param agent - The {@link Agent} to use for making the request\n * @param ns - The lexicon method definition\n * @param options - Request {@link XrpcOptions options} (params, body, headers, etc.)\n * @returns Either a successful {@link XrpcResponse} or an {@link XrpcFailure}\n *\n * @example\n * ```typescript\n * const result = await xrpcSafe(agent, app.bsky.actor.getProfile.main, {\n *   params: { actor: 'alice.bsky.social' }\n * })\n *\n * if (result.success) {\n *   console.log(result.body.displayName)\n * } else {\n *   console.error('Request failed:', result.error)\n * }\n * ```\n */\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: NonNullable<unknown> extends XrpcOptions<M>\n    ? Main<M>\n    : Restricted<'This XRPC method requires an \"options\" argument'>,\n): Promise<XrpcResult<M>>\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResult<M>>\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResult<M>> {\n  options.signal?.throwIfAborted()\n  const method: M = getMain(ns)\n  try {\n    const url = xrpcRequestUrl(method, options)\n    const request = xrpcRequestInit(method, options)\n    const response = await agent.fetchHandler(url, request)\n    return await XrpcResponse.fromFetchResponse<M>(method, response, options)\n  } catch (cause) {\n    return asXrpcFailure(method, cause)\n  }\n}\n\nfunction xrpcRequestUrl<M extends Procedure | Query | Subscription>(\n  method: M,\n  options: CallOptions & { params?: Params },\n) {\n  const path = `/xrpc/${method.nsid}`\n\n  const queryString = method.parameters\n    ?.toURLSearchParams(options.params ?? {})\n    .toString()\n\n  return queryString ? `${path}?${queryString}` : path\n}\n\nfunction xrpcRequestInit<T extends Procedure | Query>(\n  schema: T,\n  options: CallOptions & {\n    body?: LexValue | BinaryBodyInit\n    encoding?: string\n  },\n): RequestInit & { duplex?: 'half' } {\n  const headers = buildAtprotoHeaders(options)\n\n  // Tell the server what type of response we're expecting\n  if (schema.output.encoding) {\n    headers.set('accept', schema.output.encoding)\n  }\n\n  // Caller should not set content-type header\n  if (headers.has('content-type')) {\n    const contentType = headers.get('content-type')\n    throw new TypeError(`Unexpected content-type header (${contentType})`)\n  }\n\n  // Requests with body\n  if ('input' in schema) {\n    const encodingHint = options.encoding\n    const input = xrpcProcedureInput(schema, options, encodingHint)\n\n    if (input) {\n      headers.set('content-type', input.encoding)\n    } else if (encodingHint != null) {\n      throw new TypeError(`Unexpected encoding hint (${encodingHint})`)\n    }\n\n    return {\n      duplex: 'half',\n      redirect: 'follow',\n      referrerPolicy: 'strict-origin-when-cross-origin', // (default)\n      mode: 'cors', // (default)\n      signal: options.signal,\n      method: 'POST',\n      headers,\n      body: input?.body,\n    }\n  }\n\n  // Requests without body\n  return {\n    duplex: 'half',\n    redirect: 'follow',\n    referrerPolicy: 'strict-origin-when-cross-origin', // (default)\n    mode: 'cors', // (default)\n    signal: options.signal,\n    method: 'GET',\n    headers,\n  }\n}\n\nfunction xrpcProcedureInput(\n  method: Procedure,\n  options: CallOptions & { body?: LexValue | BinaryBodyInit },\n  encodingHint?: string,\n): null | { body: BodyInit; encoding: string } {\n  const { input } = method\n  const { body } = options\n\n  if (options.validateRequest) {\n    input.schema?.check(body)\n  }\n\n  // Special handling for endpoints expecting application/json input\n  if (input.encoding === 'application/json') {\n    // @NOTE **NOT** using isLexValue here to avoid deep checks in order to\n    // distinguish between LexValue and BinaryBodyInit.\n    if (!isLexScalar(body) && !isPlainObject(body) && !Array.isArray(body)) {\n      throw new TypeError(`Expected LexValue body, got ${typeof body}`)\n    }\n\n    return buildPayload(input, lexStringify(body), encodingHint)\n  }\n\n  // Other encodings will be sent unaltered (ie. as binary data)\n  switch (typeof body) {\n    case 'undefined':\n    case 'string':\n      return buildPayload(input, body, encodingHint)\n    case 'object': {\n      if (body === null) break\n      if (\n        ArrayBuffer.isView(body) ||\n        body instanceof ArrayBuffer ||\n        body instanceof ReadableStream\n      ) {\n        return buildPayload(input, body, encodingHint)\n      } else if (isAsyncIterable(body)) {\n        return buildPayload(input, toReadableStream(body), encodingHint)\n      } else if (isBlobLike(body)) {\n        return buildPayload(input, body, encodingHint || body.type)\n      }\n    }\n  }\n\n  throw new TypeError(\n    `Invalid ${typeof body} body for ${input.encoding} encoding`,\n  )\n}\n\nfunction buildPayload(\n  schema: Payload,\n  body: undefined | BodyInit,\n  encodingHint?: string,\n): null | { body: BodyInit; encoding: string } {\n  if (schema.encoding === undefined) {\n    if (body !== undefined) {\n      throw new TypeError(\n        `Cannot send a ${typeof body} body with undefined encoding`,\n      )\n    }\n\n    return null\n  }\n\n  if (body === undefined) {\n    // This error would be returned by the server, but we can catch it earlier\n    // to avoid un-necessary requests. Note that a content-length of 0 does not\n    // necessary mean that the body is \"empty\" (e.g. an empty txt file).\n    throw new TypeError(`A request body is expected but none was provided`)\n  }\n\n  const encoding = buildEncoding(schema, encodingHint)\n  return { encoding, body }\n}\n\nfunction buildEncoding(schema: Payload, encodingHint?: string): string {\n  // Should never happen (required for type safety)\n  if (!schema.encoding) {\n    throw new TypeError('Unexpected payload')\n  }\n\n  if (encodingHint?.length) {\n    if (!schema.matchesEncoding(encodingHint)) {\n      throw new TypeError(\n        `Cannot send a body with content-type \"${encodingHint}\" for \"${schema.encoding}\" encoding`,\n      )\n    }\n    return encodingHint\n  }\n\n  // Fallback\n\n  if (schema.encoding === '*/*') {\n    return 'application/octet-stream'\n  }\n\n  if (schema.encoding.startsWith('text/')) {\n    return schema.encoding.includes('*')\n      ? 'text/plain; charset=utf-8'\n      : `${schema.encoding}; charset=utf-8`\n  }\n\n  if (!schema.encoding.includes('*')) {\n    return schema.encoding\n  }\n\n  throw new TypeError(\n    `Unable to determine payload encoding. Please provide a 'content-type' header matching ${schema.encoding}.`,\n  )\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-client",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "license": "MIT",
   "description": "HTTP client for interacting with Lexicon based APIs",
   "keywords": [
@@ -32,19 +32,19 @@
       "types": "./dist/index.d.ts",
       "browser": "./dist/index.js",
       "import": "./dist/index.js",
-      "require": "./dist/index.js"
+      "default": "./dist/index.js"
     }
   },
   "dependencies": {
     "tslib": "^2.8.1",
-    "@atproto/lex-data": "0.0.9",
-    "@atproto/lex-json": "0.0.9",
-    "@atproto/lex-schema": "0.0.10"
+    "@atproto/lex-data": "^0.0.11",
+    "@atproto/lex-json": "^0.0.11",
+    "@atproto/lex-schema": "^0.0.12"
   },
   "devDependencies": {
     "vitest": "^4.0.16",
-    "@atproto/lex-cbor": "0.0.9",
-    "@atproto/lex-builder": "0.0.12"
+    "@atproto/lex-cbor": "^0.0.11",
+    "@atproto/lex-builder": "^0.0.14"
   },
   "scripts": {
     "prebuild": "node ./scripts/lex-build.mjs",

package/src/agent.ts

@@ -1,5 +1,17 @@
 import { DidString } from '@atproto/lex-schema'
 
+/**
+ * A function that performs HTTP requests towards a service endpoint.
+ *
+ * The handler is responsible for adding the origin (protocol, hostname, and
+ * port) to the provided path, typically based on authentication or service
+ * configuration. The handler are also responsible for adding any necessary
+ * headers, such as authorization tokens.
+ *
+ * @param path - The URL path (pathname + query parameters) without the origin
+ * @param init - Standard fetch RequestInit options
+ * @returns A Promise resolving to the HTTP Response
+ */
 export type FetchHandler = (
   /**
    * The URL (pathname + query parameters) to make the request to, without the
@@ -10,8 +22,27 @@ export type FetchHandler = (
   init: RequestInit,
 ) => Promise<Response>
 
+/**
+ * Core interface for making XRPC requests.
+ *
+ * An Agent encapsulates an identity and request handling for AT Protocol
+ * operations. It can represent an authenticated user session or an
+ * unauthenticated service client.
+ *
+ * @see {@link buildAgent} for creating (simple) Agent instances.
+ *
+ * @example
+ * ```typescript
+ * const agent: Agent = {
+ *   did: 'did:plc:example123',
+ *   fetchHandler: (path, init) => fetch(new URL(path, 'https://bsky.social'), init)
+ * }
+ * ```
+ */
 export interface Agent {
+  /** The DID of the authenticated user, or `undefined` if unauthenticated. */
   readonly did?: DidString
+  /** The fetch handler used to make HTTP requests. */
   fetchHandler: FetchHandler
 }
 
@@ -28,6 +59,12 @@ export type AgentConfig = {
    */
   service: string | URL
 
+  /**
+   * Optional headers to include with every request made by this agent, unless
+   * overridden by the request-specific headers provided to the fetch handler.
+   */
+  headers?: HeadersInit
+
   /**
    * Bring your own fetch implementation. Typically useful for testing, logging,
    * mocking, or adding retries, session management, signatures, proof of
@@ -37,8 +74,44 @@ export type AgentConfig = {
   fetch?: typeof globalThis.fetch
 }
 
+/**
+ * Options for creating an Agent.
+ *
+ * Can be a full {@link AgentConfig} object, or a simple service URL string/{@link URL}.
+ */
 export type AgentOptions = AgentConfig | string | URL
 
+/**
+ * Creates an {@link Agent} from various input types.
+ *
+ * This factory function accepts an existing Agent (returned as-is), a service URL,
+ * or a full configuration object. It handles the common case of creating an
+ * unauthenticated agent from just a service URL.
+ *
+ * @param options - Agent instance, configuration object, or service URL
+ * @returns A configured Agent ready for making requests
+ * @throws {TypeError} If fetch() is not available in the environment
+ *
+ * @example From URL string
+ * ```typescript
+ * const agent = buildAgent('https://public.api.bsky.app')
+ * ```
+ *
+ * @example From configuration
+ * ```typescript
+ * const agent = buildAgent({
+ *   did: 'did:plc:example',
+ *   service: 'https://bsky.social',
+ *   headers: { 'Authorization': 'Bearer ...' }
+ * })
+ * ```
+ *
+ * @example Pass-through existing agent
+ * ```typescript
+ * const existing: Agent = { ... }
+ * const agent = buildAgent(existing) // Returns existing unchanged
+ * ```
+ */
 export function buildAgent(options: Agent | AgentOptions): Agent {
   if (typeof options === 'object' && 'fetchHandler' in options) {
     return options
@@ -61,7 +134,34 @@ export function buildAgent(options: Agent | AgentOptions): Agent {
     },
 
     async fetchHandler(path, init) {
-      return fetch(new URL(path, service), init)
+      const headers =
+        config.headers != null && init.headers != null
+          ? mergeHeaders(config.headers, init.headers)
+          : config.headers || init.headers
+
+      return fetch(
+        new URL(path, service),
+        headers !== init.headers ? { ...init, headers } : init,
+      )
     },
   }
 }
+
+function mergeHeaders(
+  defaultHeaders: HeadersInit,
+  requestHeaders: HeadersInit,
+): Headers {
+  // We don't want to alter the original Headers objects, so we create a new one
+  const result = new Headers(defaultHeaders)
+
+  const overrides =
+    requestHeaders instanceof Headers
+      ? requestHeaders
+      : new Headers(requestHeaders)
+
+  for (const [key, value] of overrides.entries()) {
+    result.set(key, value)
+  }
+
+  return result
+}