@atproto/lex-client 0.0.19 → 0.0.20

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atproto/lex-client
 
+## 0.0.20
+
+### Patch Changes
+
+- [#4816](https://github.com/bluesky-social/atproto/pull/4816) [`61e75af`](https://github.com/bluesky-social/atproto/commit/61e75af39e63217d915850b2f8ac8db5f92eed0b) Thanks [@matthieusieben](https://github.com/matthieusieben)! - On NodeJS, improve error reporting by unwrapping undici errors
+
+- Updated dependencies [[`26d793a`](https://github.com/bluesky-social/atproto/commit/26d793af95a6fb3a50f9b2a97187d8ac4fecf676), [`952354c`](https://github.com/bluesky-social/atproto/commit/952354c1dd458251f8b643d02f4b227d40c5df17)]:
+  - @atproto/lex-schema@0.0.19
+  - @atproto/lex-json@0.0.16
+
 ## 0.0.19
 
 ### Patch Changes

package/dist/response.js

@@ -149,9 +149,9 @@ async function readPayload(method, response, options) {
             throw new TypeError(`Invalid content-type "${encoding}" in response`);
         }
         if (options?.parse && encoding === CONTENT_TYPE_JSON) {
-            const arrayBuffer = await response.arrayBuffer();
-            const bytes = new Uint8Array(arrayBuffer);
-            const body = (0, lex_json_1.lexParseJsonBytes)(bytes, options.parse);
+            // @NOTE See ./response.bench.ts to comparison of different parsing approaches.
+            const json = await response.json();
+            const body = (0, lex_json_1.jsonToLex)(json, options.parse);
             return { encoding, body };
         }
         const arrayBuffer = await response.arrayBuffer();

package/dist/response.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.js","sourceRoot":"","sources":["../src/response.ts"],"names":[],"mappings":";;;AAAA,gDAAsE;AAWtE,2CAKoB;AACpB,yCAImB;AAEnB,MAAM,mBAAmB,GAAG,0BAA0B,CAAA;AACtD,MAAM,iBAAiB,GAAG,kBAAkB,CAAA;AA8F5C;;;;GAIG;AACH,MAAa,YAAY;IAYZ;IACA;IACA;IACA;IAZX,yCAAyC;IAChC,OAAO,GAAG,IAAa,CAAA;IAEhC,uCAAuC;IACvC,IAAI,KAAK;QACP,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YACW,MAAS,EACT,MAAc,EACd,OAAgB,EAChB,OAA+B;QAH/B,WAAM,GAAN,MAAM,CAAG;QACT,WAAM,GAAN,MAAM,CAAQ;QACd,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAwB;IACvC,CAAC;IAEJ;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,KAAK,iBAAiB,CAAA;IAC1D,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,EAAE,QAAwC,CAAA;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,EAAE,IAA2B,CAAA;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAC5B,MAAS,EACT,QAAkB,EAClB,OAA6B;QAE7B,0EAA0E;QAC1E,kEAAkE;QAClE,oDAAoD;QAEpD,uDAAuD;QACvD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE;gBAClD,yCAAyC;gBACzC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;aACzB,CAAC,CAAA;YAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,MAAM,IAAI,mCAAuB,CAAI,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;YACjE,CAAC;YAED,MAAM,IAAI,6BAAiB,CAAI,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAED,4EAA4E;QAC5E,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACpD,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAA;YAE7B,MAAM,IAAI,oCAAwB,CAChC,MAAM,EACN,QAAQ,EACR,SAAS,EACT,0BAA0B,QAAQ,CAAC,MAAM,EAAE,CAC5C,CAAA;QACH,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE;YAClD,6DAA6D;YAC7D,qBAAqB;YACrB,KAAK,EACH,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,KAAK,iBAAiB;gBAClE,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,wBAAwB,IAAI,IAAI,EAAE;gBACvD,CAAC,CAAC,kFAAkF;oBAClF,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI;wBAC9B,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE;wBACnB,CAAC,CAAC,KAAK;SACd,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,oCAAwB,CAChC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,YAAY,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAC/G,CAAA;QACH,CAAC;QAED,qFAAqF;QACrF,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YACnC,uEAAuE;YACvE,uEAAuE;YACvE,sDAAsD;YAEtD,sEAAsE;YACtE,0EAA0E;YAC1E,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;YAEjD,8BAA8B;YAC9B,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,EAAE,gBAAgB,KAAK,KAAK,EAAE,CAAC;gBAChE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE;oBAC1D,MAAM,EAAE,OAAO,EAAE,wBAAwB,IAAI,IAAI;iBAClD,CAAC,CAAA;gBAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,MAAM,IAAI,uCAA2B,CACnC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,MAAM,CAAC,MAAM,CACd,CAAA;gBACH,CAAC;gBAED,MAAM,aAAa,GAAG;oBACpB,IAAI,EAAE,MAAM,CAAC,KAAK;oBAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBACD,CAAA;gBAE3B,OAAO,IAAI,YAAY,CACrB,MAAM,EACN,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,aAAa,CACd,CAAA;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,YAAY,CACrB,MAAM,EACN,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,OAAiC,CAClC,CAAA;IACH,CAAC;CACF;AA3JD,oCA2JC;AAWD;;GAEG;AACH,KAAK,UAAU,WAAW,CACxB,MAAyB,EACzB,QAAkB,EAClB,OAA4B;IAE5B,IAAI,CAAC;QACH,2EAA2E;QAC3E,6BAA6B;QAE7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO;aAC9B,GAAG,CAAC,cAAc,CAAC;YACpB,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACd,IAAI,EAAE;aACN,WAAW,EAAE,CAAA;QAEhB,qCAAqC;QACrC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,wDAAwD;YACxD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;YAChD,IAAI,WAAW,CAAC,UAAU,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAA;YAElD,6DAA6D;YAC7D,OAAO;gBACL,QAAQ,EAAE,mBAAmB;gBAC7B,IAAI,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC;aAClC,CAAA;QACH,CAAC;QAED,IAAI,CAAC,IAAA,2BAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,yBAAyB,QAAQ,eAAe,CAAC,CAAA;QACvE,CAAC;QAED,IAAI,OAAO,EAAE,KAAK,IAAI,QAAQ,KAAK,iBAAiB,EAAE,CAAC;YACrD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;YAChD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAA;YACzC,MAAM,IAAI,GAAG,IAAA,4BAAiB,EAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;YACpD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;QAC3B,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;QAChD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC,EAAE,CAAA;IACxD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,kCAAkC,CAAA;QAClD,MAAM,aAAa,GAAG,KAAK,YAAY,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;QAC5E,MAAM,IAAI,oCAAwB,CAChC,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,KAAK,aAAa,EAAE,CAAC,CAAC,CAAC,OAAO,EACxD,EAAE,KAAK,EAAE,CACV,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,QAA4B;IACrD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,YAAY,CAAA;AAClD,CAAC","sourcesContent":["import { LexParseOptions, lexParseJsonBytes } from '@atproto/lex-json'\nimport {\n  InferMethodOutputEncoding,\n  InferOutput,\n  LexValue,\n  Payload,\n  Procedure,\n  Query,\n  ResultSuccess,\n  Validator,\n} from '@atproto/lex-schema'\nimport {\n  XrpcAuthenticationError,\n  XrpcInvalidResponseError,\n  XrpcResponseError,\n  XrpcResponseValidationError,\n} from './errors.js'\nimport {\n  EncodingString,\n  XrpcUnknownResponsePayload,\n  isEncodingString,\n} from './types.js'\n\nconst CONTENT_TYPE_BINARY = 'application/octet-stream'\nconst CONTENT_TYPE_JSON = 'application/json'\n\n// @NOTE the output schema is used in \"parse\" mode (safeParse), which means that\n// defaults will be applied and coercions will be performed, so we need to use\n// InferOutput here to get the final parsed type, not Infer/InferInput. For this\n// reason, we cannot use InferMethodOutputBody and InferMethodOutput from\n// lex-schema here.\n\ntype InferEncodingType<TEncoding extends string> = TEncoding extends '*/*'\n  ? EncodingString\n  : TEncoding extends `${infer T extends string}/*`\n    ? `${T}/${string}`\n    : TEncoding\n\ntype InferBodyType<\n  TEncoding extends string,\n  TSchema,\n> = TSchema extends Validator\n  ? InferOutput<TSchema>\n  : TEncoding extends `application/json`\n    ? LexValue\n    : Uint8Array\n\n/**\n * The body type of an XRPC response, inferred from the method's output schema.\n *\n * For JSON responses, this is the parsed LexValue. For binary responses,\n * this is a Uint8Array.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\n */\nexport type XrpcResponseBody<M extends Procedure | Query> =\n  M['output'] extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? InferBodyType<TEncoding, TSchema>\n      : undefined | LexValue | Uint8Array\n    : never\n\n/**\n * The full payload type of an XRPC response, including body and encoding.\n *\n * Returns `null` for methods that have no output.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\n */\nexport type XrpcResponsePayload<M extends Procedure | Query> =\n  M['output'] extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? {\n          encoding: InferEncodingType<TEncoding>\n          body: InferBodyType<TEncoding, TSchema>\n        }\n      : // If the schema does not specify an output encoding, anything could be\n        // returned, including no payload at all (undefined).\n        undefined | { body: LexValue | Uint8Array; encoding: string }\n    : never\n\nexport type XrpcResponseOptions = {\n  /**\n   * Whether to validate the response against the method's output schema.\n   * Disabling this can improve performance but may lead to runtime errors if\n   * the response does not conform to the expected schema. Only set this to\n   * `false` if you are certain that the upstream service will always return\n   * valid responses.\n   *\n   * @default true\n   */\n  validateResponse?: boolean\n\n  /**\n   * Whether to strictly process response payloads according to Lex encoding\n   * rules. By default, the client will reject responses with invalid Lex data\n   * (floats and invalid $bytes / $link objects).\n   *\n   * Setting this option to `false` will allow the client to accept such\n   * responses in a non-strict mode, where invalid Lex data will be returned\n   * as-is (e.g., floats will not be rejected, and invalid $bytes / $link\n   * objects will not be converted to Uint8Array / Cid). When in non-strict\n   * mode, the validation will also be relaxed when validating the response\n   * against the method's output schema, allowing values that do not strictly\n   * conform to the schema (e.g. datetime strings that are not valid RFC3339\n   * format, blobs that are not of the right size/mime-type, etc.) to be\n   * accepted as long as their basic structure is correct.\n   *\n   * When validation is enabled (the default), the values defined through the\n   * method schema will be enforced, ensuring that the client can still process\n   * the response even if the server returns invalid Lex data.\n   *\n   * @default true\n   * @see {@link LexParseOptions.strict}\n   */\n  strictResponseProcessing?: boolean\n}\n\n/**\n * Small container for XRPC response data.\n *\n * @implements {ResultSuccess<XrpcResponse<M>>} for convenience in result handling contexts.\n */\nexport class XrpcResponse<M extends Procedure | Query>\n  implements ResultSuccess<XrpcResponse<M>>\n{\n  /** @see {@link ResultSuccess.success} */\n  readonly success = true as const\n\n  /** @see {@link ResultSuccess.value} */\n  get value(): this {\n    return this\n  }\n\n  constructor(\n    readonly method: M,\n    readonly status: number,\n    readonly headers: Headers,\n    readonly payload: XrpcResponsePayload<M>,\n  ) {}\n\n  /**\n   * Whether the response payload was parsed as {@link LexValue} (`true`) or is\n   * in binary form {@link Uint8Array} (`false`).\n   */\n  get isParsed() {\n    return this.method.output.encoding === CONTENT_TYPE_JSON\n  }\n\n  /**\n   * The Content-Type encoding of the response (e.g., 'application/json').\n   * Returns `undefined` if the response has no body.\n   */\n  get encoding() {\n    return this.payload?.encoding as InferMethodOutputEncoding<M>\n  }\n\n  /**\n   * The parsed response body.\n   *\n   * For 'application/json' responses, this is the parsed and validated LexValue.\n   * For binary responses, this is a Uint8Array.\n   * Returns `undefined` if the response has no body.\n   */\n  get body() {\n    return this.payload?.body as XrpcResponseBody<M>\n  }\n\n  /**\n   * @throws {XrpcResponseError} in case of (valid) XRPC error responses. Use\n   * {@link XrpcResponseError.matchesSchemaErrors} to narrow the error type based on\n   * the method's declared error schema. This can be narrowed further as a\n   * {@link XrpcAuthenticationError} if the error is an authentication error.\n   * @throws {XrpcInvalidResponseError} when the response is not a valid XRPC\n   * response, or if the response does not conform to the method's schema.\n   */\n  static async fromFetchResponse<const M extends Procedure | Query>(\n    method: M,\n    response: Response,\n    options?: XrpcResponseOptions,\n  ): Promise<XrpcResponse<M>> {\n    // @NOTE The body MUST either be read or canceled to avoid resource leaks.\n    // Since nothing should cause an exception before \"readPayload\" is\n    // called, we can safely not use a try/finally here.\n\n    // Always turn 4xx/5xx responses into XrpcResponseError\n    if (response.status >= 400) {\n      const payload = await readPayload(method, response, {\n        // Always parse errors in non-strict mode\n        parse: { strict: false },\n      })\n\n      if (response.status === 401) {\n        throw new XrpcAuthenticationError<M>(method, response, payload)\n      }\n\n      throw new XrpcResponseError<M>(method, response, payload)\n    }\n\n    // @NOTE redirect is set to 'follow', so we shouldn't get 3xx responses here\n    if (response.status < 200 || response.status >= 300) {\n      await response.body?.cancel()\n\n      throw new XrpcInvalidResponseError(\n        method,\n        response,\n        undefined,\n        `Unexpected status code ${response.status}`,\n      )\n    }\n\n    const payload = await readPayload(method, response, {\n      // Parse response if there is a schema, or if the encoding is\n      // \"application/json\"\n      parse:\n        method.output.schema || method.output.encoding === CONTENT_TYPE_JSON\n          ? { strict: options?.strictResponseProcessing ?? true }\n          : // If there is no declared output encoding, we'll parse the output (in loose mode)\n            method.output.encoding == null\n            ? { strict: false }\n            : false,\n    })\n\n    if (!method.output.matchesEncoding(payload?.encoding)) {\n      throw new XrpcInvalidResponseError(\n        method,\n        response,\n        payload,\n        `Expected ${stringifyEncoding(method.output.encoding)} response (got ${stringifyEncoding(payload?.encoding)})`,\n      )\n    }\n\n    // Response is successful (2xx). Validate payload (data and encoding) against schema.\n    if (method.output.encoding != null) {\n      // If the schema specifies an output, verify that the response properly\n      // matches the expected format (encoding and schema, if present). If no\n      // output is specified, any payload could be returned.\n\n      // Needed for type safety. Should never happen since matchesEncoding()\n      // should return not succeed if there is a schema encoding but no payload.\n      if (!payload) throw new Error('Expected payload')\n\n      // Assert valid response body.\n      if (method.output.schema && options?.validateResponse !== false) {\n        const result = method.output.schema.safeParse(payload.body, {\n          strict: options?.strictResponseProcessing ?? true,\n        })\n\n        if (!result.success) {\n          throw new XrpcResponseValidationError(\n            method,\n            response,\n            payload,\n            result.reason,\n          )\n        }\n\n        const parsedPayload = {\n          body: result.value,\n          encoding: payload.encoding,\n        } as XrpcResponsePayload<M>\n\n        return new XrpcResponse<M>(\n          method,\n          response.status,\n          response.headers,\n          parsedPayload,\n        )\n      }\n    }\n\n    return new XrpcResponse<M>(\n      method,\n      response.status,\n      response.headers,\n      payload as XrpcResponsePayload<M>,\n    )\n  }\n}\n\ntype ReadPayloadOptions = {\n  /**\n   * Whether to parse the response body as JSON and convert it to LexValue.\n   *\n   * @default false\n   */\n  parse?: false | LexParseOptions\n}\n\n/**\n * @note this function always consumes the response body\n */\nasync function readPayload(\n  method: Query | Procedure,\n  response: Response,\n  options?: ReadPayloadOptions,\n): Promise<undefined | XrpcUnknownResponsePayload> {\n  try {\n    // @TODO Should we limit the maximum response size here (this could also be\n    // done by the FetchHandler)?\n\n    const encoding = response.headers\n      .get('content-type')\n      ?.split(';')[0]\n      .trim()\n      .toLowerCase()\n\n    // Response content-type is undefined\n    if (!encoding) {\n      // If the body is empty, return undefined (= no payload)\n      const arrayBuffer = await response.arrayBuffer()\n      if (arrayBuffer.byteLength === 0) return undefined\n\n      // If we got data despite no content-type, treat it as binary\n      return {\n        encoding: CONTENT_TYPE_BINARY,\n        body: new Uint8Array(arrayBuffer),\n      }\n    }\n\n    if (!isEncodingString(encoding)) {\n      throw new TypeError(`Invalid content-type \"${encoding}\" in response`)\n    }\n\n    if (options?.parse && encoding === CONTENT_TYPE_JSON) {\n      const arrayBuffer = await response.arrayBuffer()\n      const bytes = new Uint8Array(arrayBuffer)\n      const body = lexParseJsonBytes(bytes, options.parse)\n      return { encoding, body }\n    }\n\n    const arrayBuffer = await response.arrayBuffer()\n    return { encoding, body: new Uint8Array(arrayBuffer) }\n  } catch (cause) {\n    const message = 'Unable to parse response payload'\n    const messageDetail = cause instanceof TypeError ? cause.message : undefined\n    throw new XrpcInvalidResponseError(\n      method,\n      response,\n      undefined,\n      messageDetail ? `${message}: ${messageDetail}` : message,\n      { cause },\n    )\n  }\n}\n\nfunction stringifyEncoding(encoding: string | undefined) {\n  return encoding ? `\"${encoding}\"` : 'no payload'\n}\n"]}
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../src/response.ts"],"names":[],"mappings":";;;AAAA,gDAA8D;AAW9D,2CAKoB;AACpB,yCAImB;AAEnB,MAAM,mBAAmB,GAAG,0BAA0B,CAAA;AACtD,MAAM,iBAAiB,GAAG,kBAAkB,CAAA;AA8F5C;;;;GAIG;AACH,MAAa,YAAY;IAYZ;IACA;IACA;IACA;IAZX,yCAAyC;IAChC,OAAO,GAAG,IAAa,CAAA;IAEhC,uCAAuC;IACvC,IAAI,KAAK;QACP,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YACW,MAAS,EACT,MAAc,EACd,OAAgB,EAChB,OAA+B;QAH/B,WAAM,GAAN,MAAM,CAAG;QACT,WAAM,GAAN,MAAM,CAAQ;QACd,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAwB;IACvC,CAAC;IAEJ;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,KAAK,iBAAiB,CAAA;IAC1D,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,EAAE,QAAwC,CAAA;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,EAAE,IAA2B,CAAA;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAC5B,MAAS,EACT,QAAkB,EAClB,OAA6B;QAE7B,0EAA0E;QAC1E,kEAAkE;QAClE,oDAAoD;QAEpD,uDAAuD;QACvD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE;gBAClD,yCAAyC;gBACzC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;aACzB,CAAC,CAAA;YAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,MAAM,IAAI,mCAAuB,CAAI,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;YACjE,CAAC;YAED,MAAM,IAAI,6BAAiB,CAAI,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAED,4EAA4E;QAC5E,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACpD,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAA;YAE7B,MAAM,IAAI,oCAAwB,CAChC,MAAM,EACN,QAAQ,EACR,SAAS,EACT,0BAA0B,QAAQ,CAAC,MAAM,EAAE,CAC5C,CAAA;QACH,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE;YAClD,6DAA6D;YAC7D,qBAAqB;YACrB,KAAK,EACH,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,KAAK,iBAAiB;gBAClE,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,wBAAwB,IAAI,IAAI,EAAE;gBACvD,CAAC,CAAC,kFAAkF;oBAClF,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI;wBAC9B,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE;wBACnB,CAAC,CAAC,KAAK;SACd,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,oCAAwB,CAChC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,YAAY,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAC/G,CAAA;QACH,CAAC;QAED,qFAAqF;QACrF,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YACnC,uEAAuE;YACvE,uEAAuE;YACvE,sDAAsD;YAEtD,sEAAsE;YACtE,0EAA0E;YAC1E,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;YAEjD,8BAA8B;YAC9B,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,OAAO,EAAE,gBAAgB,KAAK,KAAK,EAAE,CAAC;gBAChE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE;oBAC1D,MAAM,EAAE,OAAO,EAAE,wBAAwB,IAAI,IAAI;iBAClD,CAAC,CAAA;gBAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,MAAM,IAAI,uCAA2B,CACnC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,MAAM,CAAC,MAAM,CACd,CAAA;gBACH,CAAC;gBAED,MAAM,aAAa,GAAG;oBACpB,IAAI,EAAE,MAAM,CAAC,KAAK;oBAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBACD,CAAA;gBAE3B,OAAO,IAAI,YAAY,CACrB,MAAM,EACN,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,aAAa,CACd,CAAA;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,YAAY,CACrB,MAAM,EACN,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,OAAiC,CAClC,CAAA;IACH,CAAC;CACF;AA3JD,oCA2JC;AAWD;;GAEG;AACH,KAAK,UAAU,WAAW,CACxB,MAAyB,EACzB,QAAkB,EAClB,OAA4B;IAE5B,IAAI,CAAC;QACH,2EAA2E;QAC3E,6BAA6B;QAE7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO;aAC9B,GAAG,CAAC,cAAc,CAAC;YACpB,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACd,IAAI,EAAE;aACN,WAAW,EAAE,CAAA;QAEhB,qCAAqC;QACrC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,wDAAwD;YACxD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;YAChD,IAAI,WAAW,CAAC,UAAU,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAA;YAElD,6DAA6D;YAC7D,OAAO;gBACL,QAAQ,EAAE,mBAAmB;gBAC7B,IAAI,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC;aAClC,CAAA;QACH,CAAC;QAED,IAAI,CAAC,IAAA,2BAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CAAC,yBAAyB,QAAQ,eAAe,CAAC,CAAA;QACvE,CAAC;QAED,IAAI,OAAO,EAAE,KAAK,IAAI,QAAQ,KAAK,iBAAiB,EAAE,CAAC;YACrD,+EAA+E;YAC/E,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YAClC,MAAM,IAAI,GAAG,IAAA,oBAAS,EAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;YAC3C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;QAC3B,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;QAChD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC,EAAE,CAAA;IACxD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,kCAAkC,CAAA;QAClD,MAAM,aAAa,GAAG,KAAK,YAAY,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;QAC5E,MAAM,IAAI,oCAAwB,CAChC,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,KAAK,aAAa,EAAE,CAAC,CAAC,CAAC,OAAO,EACxD,EAAE,KAAK,EAAE,CACV,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,QAA4B;IACrD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,YAAY,CAAA;AAClD,CAAC","sourcesContent":["import { LexParseOptions, jsonToLex } from '@atproto/lex-json'\nimport {\n  InferMethodOutputEncoding,\n  InferOutput,\n  LexValue,\n  Payload,\n  Procedure,\n  Query,\n  ResultSuccess,\n  Validator,\n} from '@atproto/lex-schema'\nimport {\n  XrpcAuthenticationError,\n  XrpcInvalidResponseError,\n  XrpcResponseError,\n  XrpcResponseValidationError,\n} from './errors.js'\nimport {\n  EncodingString,\n  XrpcUnknownResponsePayload,\n  isEncodingString,\n} from './types.js'\n\nconst CONTENT_TYPE_BINARY = 'application/octet-stream'\nconst CONTENT_TYPE_JSON = 'application/json'\n\n// @NOTE the output schema is used in \"parse\" mode (safeParse), which means that\n// defaults will be applied and coercions will be performed, so we need to use\n// InferOutput here to get the final parsed type, not Infer/InferInput. For this\n// reason, we cannot use InferMethodOutputBody and InferMethodOutput from\n// lex-schema here.\n\ntype InferEncodingType<TEncoding extends string> = TEncoding extends '*/*'\n  ? EncodingString\n  : TEncoding extends `${infer T extends string}/*`\n    ? `${T}/${string}`\n    : TEncoding\n\ntype InferBodyType<\n  TEncoding extends string,\n  TSchema,\n> = TSchema extends Validator\n  ? InferOutput<TSchema>\n  : TEncoding extends `application/json`\n    ? LexValue\n    : Uint8Array\n\n/**\n * The body type of an XRPC response, inferred from the method's output schema.\n *\n * For JSON responses, this is the parsed LexValue. For binary responses,\n * this is a Uint8Array.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\n */\nexport type XrpcResponseBody<M extends Procedure | Query> =\n  M['output'] extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? InferBodyType<TEncoding, TSchema>\n      : undefined | LexValue | Uint8Array\n    : never\n\n/**\n * The full payload type of an XRPC response, including body and encoding.\n *\n * Returns `null` for methods that have no output.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\n */\nexport type XrpcResponsePayload<M extends Procedure | Query> =\n  M['output'] extends Payload<infer TEncoding, infer TSchema>\n    ? TEncoding extends string\n      ? {\n          encoding: InferEncodingType<TEncoding>\n          body: InferBodyType<TEncoding, TSchema>\n        }\n      : // If the schema does not specify an output encoding, anything could be\n        // returned, including no payload at all (undefined).\n        undefined | { body: LexValue | Uint8Array; encoding: string }\n    : never\n\nexport type XrpcResponseOptions = {\n  /**\n   * Whether to validate the response against the method's output schema.\n   * Disabling this can improve performance but may lead to runtime errors if\n   * the response does not conform to the expected schema. Only set this to\n   * `false` if you are certain that the upstream service will always return\n   * valid responses.\n   *\n   * @default true\n   */\n  validateResponse?: boolean\n\n  /**\n   * Whether to strictly process response payloads according to Lex encoding\n   * rules. By default, the client will reject responses with invalid Lex data\n   * (floats and invalid $bytes / $link objects).\n   *\n   * Setting this option to `false` will allow the client to accept such\n   * responses in a non-strict mode, where invalid Lex data will be returned\n   * as-is (e.g., floats will not be rejected, and invalid $bytes / $link\n   * objects will not be converted to Uint8Array / Cid). When in non-strict\n   * mode, the validation will also be relaxed when validating the response\n   * against the method's output schema, allowing values that do not strictly\n   * conform to the schema (e.g. datetime strings that are not valid RFC3339\n   * format, blobs that are not of the right size/mime-type, etc.) to be\n   * accepted as long as their basic structure is correct.\n   *\n   * When validation is enabled (the default), the values defined through the\n   * method schema will be enforced, ensuring that the client can still process\n   * the response even if the server returns invalid Lex data.\n   *\n   * @default true\n   * @see {@link LexParseOptions.strict}\n   */\n  strictResponseProcessing?: boolean\n}\n\n/**\n * Small container for XRPC response data.\n *\n * @implements {ResultSuccess<XrpcResponse<M>>} for convenience in result handling contexts.\n */\nexport class XrpcResponse<M extends Procedure | Query>\n  implements ResultSuccess<XrpcResponse<M>>\n{\n  /** @see {@link ResultSuccess.success} */\n  readonly success = true as const\n\n  /** @see {@link ResultSuccess.value} */\n  get value(): this {\n    return this\n  }\n\n  constructor(\n    readonly method: M,\n    readonly status: number,\n    readonly headers: Headers,\n    readonly payload: XrpcResponsePayload<M>,\n  ) {}\n\n  /**\n   * Whether the response payload was parsed as {@link LexValue} (`true`) or is\n   * in binary form {@link Uint8Array} (`false`).\n   */\n  get isParsed() {\n    return this.method.output.encoding === CONTENT_TYPE_JSON\n  }\n\n  /**\n   * The Content-Type encoding of the response (e.g., 'application/json').\n   * Returns `undefined` if the response has no body.\n   */\n  get encoding() {\n    return this.payload?.encoding as InferMethodOutputEncoding<M>\n  }\n\n  /**\n   * The parsed response body.\n   *\n   * For 'application/json' responses, this is the parsed and validated LexValue.\n   * For binary responses, this is a Uint8Array.\n   * Returns `undefined` if the response has no body.\n   */\n  get body() {\n    return this.payload?.body as XrpcResponseBody<M>\n  }\n\n  /**\n   * @throws {XrpcResponseError} in case of (valid) XRPC error responses. Use\n   * {@link XrpcResponseError.matchesSchemaErrors} to narrow the error type based on\n   * the method's declared error schema. This can be narrowed further as a\n   * {@link XrpcAuthenticationError} if the error is an authentication error.\n   * @throws {XrpcInvalidResponseError} when the response is not a valid XRPC\n   * response, or if the response does not conform to the method's schema.\n   */\n  static async fromFetchResponse<const M extends Procedure | Query>(\n    method: M,\n    response: Response,\n    options?: XrpcResponseOptions,\n  ): Promise<XrpcResponse<M>> {\n    // @NOTE The body MUST either be read or canceled to avoid resource leaks.\n    // Since nothing should cause an exception before \"readPayload\" is\n    // called, we can safely not use a try/finally here.\n\n    // Always turn 4xx/5xx responses into XrpcResponseError\n    if (response.status >= 400) {\n      const payload = await readPayload(method, response, {\n        // Always parse errors in non-strict mode\n        parse: { strict: false },\n      })\n\n      if (response.status === 401) {\n        throw new XrpcAuthenticationError<M>(method, response, payload)\n      }\n\n      throw new XrpcResponseError<M>(method, response, payload)\n    }\n\n    // @NOTE redirect is set to 'follow', so we shouldn't get 3xx responses here\n    if (response.status < 200 || response.status >= 300) {\n      await response.body?.cancel()\n\n      throw new XrpcInvalidResponseError(\n        method,\n        response,\n        undefined,\n        `Unexpected status code ${response.status}`,\n      )\n    }\n\n    const payload = await readPayload(method, response, {\n      // Parse response if there is a schema, or if the encoding is\n      // \"application/json\"\n      parse:\n        method.output.schema || method.output.encoding === CONTENT_TYPE_JSON\n          ? { strict: options?.strictResponseProcessing ?? true }\n          : // If there is no declared output encoding, we'll parse the output (in loose mode)\n            method.output.encoding == null\n            ? { strict: false }\n            : false,\n    })\n\n    if (!method.output.matchesEncoding(payload?.encoding)) {\n      throw new XrpcInvalidResponseError(\n        method,\n        response,\n        payload,\n        `Expected ${stringifyEncoding(method.output.encoding)} response (got ${stringifyEncoding(payload?.encoding)})`,\n      )\n    }\n\n    // Response is successful (2xx). Validate payload (data and encoding) against schema.\n    if (method.output.encoding != null) {\n      // If the schema specifies an output, verify that the response properly\n      // matches the expected format (encoding and schema, if present). If no\n      // output is specified, any payload could be returned.\n\n      // Needed for type safety. Should never happen since matchesEncoding()\n      // should return not succeed if there is a schema encoding but no payload.\n      if (!payload) throw new Error('Expected payload')\n\n      // Assert valid response body.\n      if (method.output.schema && options?.validateResponse !== false) {\n        const result = method.output.schema.safeParse(payload.body, {\n          strict: options?.strictResponseProcessing ?? true,\n        })\n\n        if (!result.success) {\n          throw new XrpcResponseValidationError(\n            method,\n            response,\n            payload,\n            result.reason,\n          )\n        }\n\n        const parsedPayload = {\n          body: result.value,\n          encoding: payload.encoding,\n        } as XrpcResponsePayload<M>\n\n        return new XrpcResponse<M>(\n          method,\n          response.status,\n          response.headers,\n          parsedPayload,\n        )\n      }\n    }\n\n    return new XrpcResponse<M>(\n      method,\n      response.status,\n      response.headers,\n      payload as XrpcResponsePayload<M>,\n    )\n  }\n}\n\ntype ReadPayloadOptions = {\n  /**\n   * Whether to parse the response body as JSON and convert it to LexValue.\n   *\n   * @default false\n   */\n  parse?: false | LexParseOptions\n}\n\n/**\n * @note this function always consumes the response body\n */\nasync function readPayload(\n  method: Query | Procedure,\n  response: Response,\n  options?: ReadPayloadOptions,\n): Promise<undefined | XrpcUnknownResponsePayload> {\n  try {\n    // @TODO Should we limit the maximum response size here (this could also be\n    // done by the FetchHandler)?\n\n    const encoding = response.headers\n      .get('content-type')\n      ?.split(';')[0]\n      .trim()\n      .toLowerCase()\n\n    // Response content-type is undefined\n    if (!encoding) {\n      // If the body is empty, return undefined (= no payload)\n      const arrayBuffer = await response.arrayBuffer()\n      if (arrayBuffer.byteLength === 0) return undefined\n\n      // If we got data despite no content-type, treat it as binary\n      return {\n        encoding: CONTENT_TYPE_BINARY,\n        body: new Uint8Array(arrayBuffer),\n      }\n    }\n\n    if (!isEncodingString(encoding)) {\n      throw new TypeError(`Invalid content-type \"${encoding}\" in response`)\n    }\n\n    if (options?.parse && encoding === CONTENT_TYPE_JSON) {\n      // @NOTE See ./response.bench.ts to comparison of different parsing approaches.\n      const json = await response.json()\n      const body = jsonToLex(json, options.parse)\n      return { encoding, body }\n    }\n\n    const arrayBuffer = await response.arrayBuffer()\n    return { encoding, body: new Uint8Array(arrayBuffer) }\n  } catch (cause) {\n    const message = 'Unable to parse response payload'\n    const messageDetail = cause instanceof TypeError ? cause.message : undefined\n    throw new XrpcInvalidResponseError(\n      method,\n      response,\n      undefined,\n      messageDetail ? `${message}: ${messageDetail}` : message,\n      { cause },\n    )\n  }\n}\n\nfunction stringifyEncoding(encoding: string | undefined) {\n  return encoding ? `\"${encoding}\"` : 'no payload'\n}\n"]}

package/dist/xrpc.d.ts

@@ -140,5 +140,14 @@ export type XrpcResult<M extends Procedure | Query> = XrpcResponse<M> | XrpcFail
  */
 export declare function xrpcSafe<const M extends Query | Procedure>(agentOpts: Agent | AgentOptions, ns: NonNullable<unknown> extends XrpcOptions<M> ? Main<M> : Restricted<'This XRPC method requires an "options" argument'>): Promise<XrpcResult<M>>;
 export declare function xrpcSafe<const M extends Query | Procedure>(agentOpts: Agent | AgentOptions, ns: Main<M>, options: XrpcOptions<M>): Promise<XrpcResult<M>>;
+/**
+ * Extracts the root cause from an error, unwrapping common fetch-related errors
+ * such as those from undici (Node's internal fetch implementation).
+ *
+ * @param err - The error to extract the root cause from
+ * @returns The root cause error, or the original error if no specific pattern is matched
+ * @remarks This is useful for getting more specific error information from fetch-related failures, especially in Node environments using undici.
+ */
+export declare function extractFetchErrorCause(err: unknown): unknown;
 export {};
 //# sourceMappingURL=xrpc.d.ts.map

package/dist/xrpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xrpc.d.ts","sourceRoot":"","sources":["../src/xrpc.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,YAAY,EACZ,IAAI,EAEJ,MAAM,EAEN,SAAS,EACT,KAAK,EACL,UAAU,EACV,YAAY,EAEb,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,EAAE,YAAY,EAAc,MAAM,YAAY,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAiC,MAAM,aAAa,CAAA;AACxE,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EACL,yBAAyB,EAK1B,MAAM,WAAW,CAAA;AAElB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,YAAY,IACtE,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;AAG7B,KAAK,wBAAwB,CAAC,CAAC,SAAS,MAAM,IAC5C,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAA;AAEjE,KAAK,kBAAkB,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,IAAI,CAAC,SAAS,SAAS,GACtE,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,GACxC,SAAS,CAAA;AAEb,KAAK,yBAAyB,CAAC,QAAQ,IAAI,QAAQ,SAAS;IAC1D,IAAI,EAAE,MAAM,CAAC,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,CAAA;CAClB,GACG;IACE,IAAI,EAAE,CAAC,CAAA;IAEP;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAA;CACb,GACD;IAAE,IAAI,CAAC,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,IACrE,kBAAkB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA;AAE7C,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,IAC7C,4BAA4B,GAC9B,yBAAyB,GACzB,yBAAyB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAChD,wBAAwB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;AAEhD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IAEpB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC1D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,GAC3C,IAAI,CAAC,CAAC,CAAC,GACP,UAAU,CAAC,iDAAiD,CAAC,GAChE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAC3B,wBAAsB,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC1D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,EACX,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAW3B;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,IAC9C,YAAY,CAAC,CAAC,CAAC,GACf,WAAW,CAAC,CAAC,CAAC,CAAA;AAElB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC9D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,GAC3C,IAAI,CAAC,CAAC,CAAC,GACP,UAAU,CAAC,iDAAiD,CAAC,GAChE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AACzB,wBAAsB,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC9D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,EACX,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA"}
+{"version":3,"file":"xrpc.d.ts","sourceRoot":"","sources":["../src/xrpc.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,YAAY,EACZ,IAAI,EAEJ,MAAM,EAEN,SAAS,EACT,KAAK,EACL,UAAU,EACV,YAAY,EAEb,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,EAAE,YAAY,EAAc,MAAM,YAAY,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAiC,MAAM,aAAa,CAAA;AACxE,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EACL,yBAAyB,EAK1B,MAAM,WAAW,CAAA;AAElB;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,YAAY,IACtE,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;AAG7B,KAAK,wBAAwB,CAAC,CAAC,SAAS,MAAM,IAC5C,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAA;AAEjE,KAAK,kBAAkB,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,IAAI,CAAC,SAAS,SAAS,GACtE,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,GACxC,SAAS,CAAA;AAEb,KAAK,yBAAyB,CAAC,QAAQ,IAAI,QAAQ,SAAS;IAC1D,IAAI,EAAE,MAAM,CAAC,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,CAAA;CAClB,GACG;IACE,IAAI,EAAE,CAAC,CAAA;IAEP;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAA;CACb,GACD;IAAE,IAAI,CAAC,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,IACrE,kBAAkB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAA;AAE7C,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,IAC7C,4BAA4B,GAC9B,yBAAyB,GACzB,yBAAyB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAChD,wBAAwB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;AAEhD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IAEpB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC1D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,GAC3C,IAAI,CAAC,CAAC,CAAC,GACP,UAAU,CAAC,iDAAiD,CAAC,GAChE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAC3B,wBAAsB,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC1D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,EACX,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;AAW3B;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,IAC9C,YAAY,CAAC,CAAC,CAAC,GACf,WAAW,CAAC,CAAC,CAAC,CAAA;AAElB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC9D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,GAC3C,IAAI,CAAC,CAAC,CAAC,GACP,UAAU,CAAC,iDAAiD,CAAC,GAChE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AACzB,wBAAsB,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,EAC9D,SAAS,EAAE,KAAK,GAAG,YAAY,EAC/B,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,EACX,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AAgNzB;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAgB5D"}

package/dist/xrpc.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.xrpc = xrpc;
 exports.xrpcSafe = xrpcSafe;
+exports.extractFetchErrorCause = extractFetchErrorCause;
 const lex_data_1 = require("@atproto/lex-data");
 const lex_json_1 = require("@atproto/lex-json");
 const lex_schema_1 = require("@atproto/lex-schema");
@@ -23,7 +24,8 @@ async function xrpcSafe(agentOpts, ns, options = {}) {
         const agent = (0, agent_js_1.buildAgent)(agentOpts);
         const url = xrpcRequestUrl(method, options);
         const request = xrpcRequestInit(method, options);
-        const response = await agent.fetchHandler(url, request).catch((cause) => {
+        const response = await agent.fetchHandler(url, request).catch((err) => {
+            const cause = extractFetchErrorCause(err);
             throw new errors_js_1.XrpcFetchError(method, cause);
         });
         return await response_js_1.XrpcResponse.fromFetchResponse(method, response, options);
@@ -163,4 +165,25 @@ function buildEncoding(schema, encodingHint) {
     }
     throw new TypeError(`Unable to determine payload encoding. Please provide a 'content-type' header matching ${schema.encoding}.`);
 }
+/**
+ * Extracts the root cause from an error, unwrapping common fetch-related errors
+ * such as those from undici (Node's internal fetch implementation).
+ *
+ * @param err - The error to extract the root cause from
+ * @returns The root cause error, or the original error if no specific pattern is matched
+ * @remarks This is useful for getting more specific error information from fetch-related failures, especially in Node environments using undici.
+ */
+function extractFetchErrorCause(err) {
+    // Unwrap the Network error from undici (i.e. Node's internal fetch() implementation)
+    // https://github.com/nodejs/undici/blob/04cb77327f7ada95c2e5b67424cddcb22d7bf882/lib/web/fetch/index.js#L234-L239
+    if (err instanceof TypeError &&
+        err.message === 'fetch failed' &&
+        err.cause !== undefined) {
+        return err.cause;
+    }
+    // @TODO Add other unwrap patterns here as needed (e.g. for other fetch
+    // implementations or common network libraries, like "node:http", or in other
+    // environments like React Native, Deno, Bun, Browser, etc.)
+    return err;
+}
 //# sourceMappingURL=xrpc.js.map

package/dist/xrpc.js.map

@@ -1 +1 @@
-{"version":3,"file":"xrpc.js","sourceRoot":"","sources":["../src/xrpc.ts"],"names":[],"mappings":";;AAsJA,oBAQC;AAmDD,4BAkBC;AAnOD,gDAAwE;AACxE,gDAAgD;AAChD,oDAY4B;AAC5B,yCAA4D;AAC5D,2CAAwE;AACxE,+CAAiE;AAEjE,uCAMkB;AA6HX,KAAK,UAAU,IAAI,CACxB,SAA+B,EAC/B,EAAW,EACX,UAA0B,EAAoB;IAE9C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAI,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;IAC1D,IAAI,QAAQ,CAAC,OAAO;QAAE,OAAO,QAAQ,CAAA;;QAChC,MAAM,QAAQ,CAAA;AACrB,CAAC;AAmDM,KAAK,UAAU,QAAQ,CAC5B,SAA+B,EAC/B,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,KAAK,GAAG,IAAA,qBAAU,EAAC,SAAS,CAAC,CAAA;QACnC,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,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACtE,MAAM,IAAI,0BAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACzC,CAAC,CAAC,CAAA;QACF,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,OAA4B;IAE5B,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,IAAI,EAAW,CAAA;IAE5C,8EAA8E;IAC9E,4EAA4E;IAE5E,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,CAAE,GAAG,IAAI,IAAI,WAAW,EAAY,CAAC,CAAC,CAAC,IAAI,CAAA;AACjE,CAAC;AAED,SAAS,eAAe,CACtB,MAAS,EACT,OAIG;IAEH,MAAM,OAAO,GAAG,IAAA,iCAAuB,EAAC,OAAO,CAAC,CAAA;IAEhD,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;AAOD,SAAS,kBAAkB,CACzB,MAAiB,EACjB,OAAkC,EAClC,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,CAAC,6BAA6B,CAAC,CAAA;QACpD,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  NsidString,\n  Params,\n  Payload,\n  Procedure,\n  Query,\n  Restricted,\n  Subscription,\n  getMain,\n} from '@atproto/lex-schema'\nimport { Agent, AgentOptions, buildAgent } from './agent.js'\nimport { XrpcFailure, XrpcFetchError, asXrpcFailure } from './errors.js'\nimport { XrpcResponse, XrpcResponseOptions } from './response.js'\nimport { BinaryBodyInit } from './types.js'\nimport {\n  XrpcRequestHeadersOptions,\n  buildXrpcRequestHeaders,\n  isAsyncIterable,\n  isBlobLike,\n  toReadableStream,\n} from './util.js'\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\n// If all params are optional, allow omitting the params object\ntype XrpcRequestParamsOptions<P extends Params> =\n  NonNullable<unknown> extends P ? { params?: P } : { params: P }\n\ntype XrpcRequestPayload<M extends Procedure | Query> = M extends Procedure\n  ? InferPayload<M['input'], BinaryBodyInit>\n  : undefined\n\ntype XrpcRequestPayloadOptions<TPayload> = TPayload extends {\n  body: infer B\n  encoding: infer E\n}\n  ? {\n      body: B\n\n      /**\n       * mime type hint for binary bodies\n       *\n       * Only needed for endpoints that accept binary input (e.g. file uploads)\n       * when the body is a Blob-like object without a type (e.g. fetch-blob's\n       * Blob). If the body is a Blob-like object with a type, that type will be\n       * used as the content-type header instead of this option.\n       *\n       * @default \"application/octet-stream\"\n       */\n      encoding?: E\n    }\n  : { body?: undefined; encoding?: undefined }\n\n/**\n * Options for making an XRPC request, based on the method schema.\n *\n * Combines {@link XrpcRequestOptions} and {@link XrpcResponseOptions} with\n * method-specific params and body requirements. The type system ensures\n * required params/body are provided based on the method schema.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\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  XrpcRequestOptions<M> & XrpcResponseOptions\n\nexport type XrpcRequestOptions<\n  M extends Procedure | Query = Procedure | Query,\n> = XrpcRequestProcessingOptions &\n  XrpcRequestHeadersOptions &\n  XrpcRequestPayloadOptions<XrpcRequestPayload<M>> &\n  XrpcRequestParamsOptions<XrpcRequestParams<M>>\n\nexport type XrpcRequestProcessingOptions = {\n  /**\n   * AbortSignal to cancel the request.\n   */\n  signal?: AbortSignal\n\n  /**\n   * Whether to validate the request against the method's input schema. Enabling\n   * this can help catch errors early but may have a performance cost. This\n   * would typically only be set to `true` in development or debugging\n   * scenarios.\n   *\n   * @default false\n   */\n  validateRequest?: boolean\n}\n\n/**\n * Makes an XRPC request and throws on failure.\n *\n * This is the low-level function for making XRPC calls.\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('https://bsky.network', com.atproto.identity.resolveHandle, {\n *   params: { handle: \"atproto.com\" }\n * })\n * ```\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  agentOpts: Agent | AgentOptions,\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  agentOpts: Agent | AgentOptions,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agentOpts: Agent | AgentOptions,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResponse<M>> {\n  const response = await xrpcSafe<M>(agentOpts, 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('https://example.com', app.bsky.actor.getProfile, {\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  agentOpts: Agent | AgentOptions,\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  agentOpts: Agent | AgentOptions,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResult<M>>\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agentOpts: Agent | AgentOptions,\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 agent = buildAgent(agentOpts)\n    const url = xrpcRequestUrl(method, options)\n    const request = xrpcRequestInit(method, options)\n    const response = await agent.fetchHandler(url, request).catch((cause) => {\n      throw new XrpcFetchError(method, cause)\n    })\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: { params?: Params },\n): `/xrpc/${NsidString}${'' | `?${string}`}` {\n  const path = `/xrpc/${method.nsid}` as const\n\n  // @NOTE param.toURLSearchParams() will always validate the params in order to\n  // apply default values, so we can't disable it with options.validateRequest\n\n  const queryString = method.parameters\n    ?.toURLSearchParams(options.params ?? {})\n    .toString()\n\n  return queryString ? (`${path}?${queryString}` as const) : path\n}\n\nfunction xrpcRequestInit<T extends Procedure | Query>(\n  schema: T,\n  options: XrpcRequestProcessingOptions &\n    XrpcRequestHeadersOptions &\n    XrpcProcedureInputOptions & {\n      encoding?: string\n    },\n): RequestInit & { duplex?: 'half' } {\n  const headers = buildXrpcRequestHeaders(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\ntype XrpcProcedureInputOptions = {\n  body?: LexValue | BinaryBodyInit\n  validateRequest?: boolean\n}\n\nfunction xrpcProcedureInput(\n  method: Procedure,\n  options: XrpcProcedureInputOptions,\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(`Endpoint expects no payload`)\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":";;AAsJA,oBAQC;AAmDD,4BAmBC;AAoMD,wDAgBC;AAxbD,gDAAwE;AACxE,gDAAgD;AAChD,oDAY4B;AAC5B,yCAA4D;AAC5D,2CAAwE;AACxE,+CAAiE;AAEjE,uCAMkB;AA6HX,KAAK,UAAU,IAAI,CACxB,SAA+B,EAC/B,EAAW,EACX,UAA0B,EAAoB;IAE9C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAI,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;IAC1D,IAAI,QAAQ,CAAC,OAAO;QAAE,OAAO,QAAQ,CAAA;;QAChC,MAAM,QAAQ,CAAA;AACrB,CAAC;AAmDM,KAAK,UAAU,QAAQ,CAC5B,SAA+B,EAC/B,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,KAAK,GAAG,IAAA,qBAAU,EAAC,SAAS,CAAC,CAAA;QACnC,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,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACpE,MAAM,KAAK,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAA;YACzC,MAAM,IAAI,0BAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACzC,CAAC,CAAC,CAAA;QACF,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,OAA4B;IAE5B,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,IAAI,EAAW,CAAA;IAE5C,8EAA8E;IAC9E,4EAA4E;IAE5E,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,CAAE,GAAG,IAAI,IAAI,WAAW,EAAY,CAAC,CAAC,CAAC,IAAI,CAAA;AACjE,CAAC;AAED,SAAS,eAAe,CACtB,MAAS,EACT,OAIG;IAEH,MAAM,OAAO,GAAG,IAAA,iCAAuB,EAAC,OAAO,CAAC,CAAA;IAEhD,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;AAOD,SAAS,kBAAkB,CACzB,MAAiB,EACjB,OAAkC,EAClC,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,CAAC,6BAA6B,CAAC,CAAA;QACpD,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;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,GAAY;IACjD,qFAAqF;IACrF,kHAAkH;IAClH,IACE,GAAG,YAAY,SAAS;QACxB,GAAG,CAAC,OAAO,KAAK,cAAc;QAC9B,GAAG,CAAC,KAAK,KAAK,SAAS,EACvB,CAAC;QACD,OAAO,GAAG,CAAC,KAAK,CAAA;IAClB,CAAC;IAED,uEAAuE;IACvE,6EAA6E;IAC7E,4DAA4D;IAE5D,OAAO,GAAG,CAAA;AACZ,CAAC","sourcesContent":["import { LexValue, isLexScalar, isPlainObject } from '@atproto/lex-data'\nimport { lexStringify } from '@atproto/lex-json'\nimport {\n  InferInput,\n  InferPayload,\n  Main,\n  NsidString,\n  Params,\n  Payload,\n  Procedure,\n  Query,\n  Restricted,\n  Subscription,\n  getMain,\n} from '@atproto/lex-schema'\nimport { Agent, AgentOptions, buildAgent } from './agent.js'\nimport { XrpcFailure, XrpcFetchError, asXrpcFailure } from './errors.js'\nimport { XrpcResponse, XrpcResponseOptions } from './response.js'\nimport { BinaryBodyInit } from './types.js'\nimport {\n  XrpcRequestHeadersOptions,\n  buildXrpcRequestHeaders,\n  isAsyncIterable,\n  isBlobLike,\n  toReadableStream,\n} from './util.js'\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\n// If all params are optional, allow omitting the params object\ntype XrpcRequestParamsOptions<P extends Params> =\n  NonNullable<unknown> extends P ? { params?: P } : { params: P }\n\ntype XrpcRequestPayload<M extends Procedure | Query> = M extends Procedure\n  ? InferPayload<M['input'], BinaryBodyInit>\n  : undefined\n\ntype XrpcRequestPayloadOptions<TPayload> = TPayload extends {\n  body: infer B\n  encoding: infer E\n}\n  ? {\n      body: B\n\n      /**\n       * mime type hint for binary bodies\n       *\n       * Only needed for endpoints that accept binary input (e.g. file uploads)\n       * when the body is a Blob-like object without a type (e.g. fetch-blob's\n       * Blob). If the body is a Blob-like object with a type, that type will be\n       * used as the content-type header instead of this option.\n       *\n       * @default \"application/octet-stream\"\n       */\n      encoding?: E\n    }\n  : { body?: undefined; encoding?: undefined }\n\n/**\n * Options for making an XRPC request, based on the method schema.\n *\n * Combines {@link XrpcRequestOptions} and {@link XrpcResponseOptions} with\n * method-specific params and body requirements. The type system ensures\n * required params/body are provided based on the method schema.\n *\n * @typeParam M - The XRPC method type (Procedure or Query)\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  XrpcRequestOptions<M> & XrpcResponseOptions\n\nexport type XrpcRequestOptions<\n  M extends Procedure | Query = Procedure | Query,\n> = XrpcRequestProcessingOptions &\n  XrpcRequestHeadersOptions &\n  XrpcRequestPayloadOptions<XrpcRequestPayload<M>> &\n  XrpcRequestParamsOptions<XrpcRequestParams<M>>\n\nexport type XrpcRequestProcessingOptions = {\n  /**\n   * AbortSignal to cancel the request.\n   */\n  signal?: AbortSignal\n\n  /**\n   * Whether to validate the request against the method's input schema. Enabling\n   * this can help catch errors early but may have a performance cost. This\n   * would typically only be set to `true` in development or debugging\n   * scenarios.\n   *\n   * @default false\n   */\n  validateRequest?: boolean\n}\n\n/**\n * Makes an XRPC request and throws on failure.\n *\n * This is the low-level function for making XRPC calls.\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('https://bsky.network', com.atproto.identity.resolveHandle, {\n *   params: { handle: \"atproto.com\" }\n * })\n * ```\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  agentOpts: Agent | AgentOptions,\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  agentOpts: Agent | AgentOptions,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agentOpts: Agent | AgentOptions,\n  ns: Main<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResponse<M>> {\n  const response = await xrpcSafe<M>(agentOpts, 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('https://example.com', app.bsky.actor.getProfile, {\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  agentOpts: Agent | AgentOptions,\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  agentOpts: Agent | AgentOptions,\n  ns: Main<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResult<M>>\nexport async function xrpcSafe<const M extends Query | Procedure>(\n  agentOpts: Agent | AgentOptions,\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 agent = buildAgent(agentOpts)\n    const url = xrpcRequestUrl(method, options)\n    const request = xrpcRequestInit(method, options)\n    const response = await agent.fetchHandler(url, request).catch((err) => {\n      const cause = extractFetchErrorCause(err)\n      throw new XrpcFetchError(method, cause)\n    })\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: { params?: Params },\n): `/xrpc/${NsidString}${'' | `?${string}`}` {\n  const path = `/xrpc/${method.nsid}` as const\n\n  // @NOTE param.toURLSearchParams() will always validate the params in order to\n  // apply default values, so we can't disable it with options.validateRequest\n\n  const queryString = method.parameters\n    ?.toURLSearchParams(options.params ?? {})\n    .toString()\n\n  return queryString ? (`${path}?${queryString}` as const) : path\n}\n\nfunction xrpcRequestInit<T extends Procedure | Query>(\n  schema: T,\n  options: XrpcRequestProcessingOptions &\n    XrpcRequestHeadersOptions &\n    XrpcProcedureInputOptions & {\n      encoding?: string\n    },\n): RequestInit & { duplex?: 'half' } {\n  const headers = buildXrpcRequestHeaders(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\ntype XrpcProcedureInputOptions = {\n  body?: LexValue | BinaryBodyInit\n  validateRequest?: boolean\n}\n\nfunction xrpcProcedureInput(\n  method: Procedure,\n  options: XrpcProcedureInputOptions,\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(`Endpoint expects no payload`)\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\n/**\n * Extracts the root cause from an error, unwrapping common fetch-related errors\n * such as those from undici (Node's internal fetch implementation).\n *\n * @param err - The error to extract the root cause from\n * @returns The root cause error, or the original error if no specific pattern is matched\n * @remarks This is useful for getting more specific error information from fetch-related failures, especially in Node environments using undici.\n */\nexport function extractFetchErrorCause(err: unknown): unknown {\n  // Unwrap the Network error from undici (i.e. Node's internal fetch() implementation)\n  // https://github.com/nodejs/undici/blob/04cb77327f7ada95c2e5b67424cddcb22d7bf882/lib/web/fetch/index.js#L234-L239\n  if (\n    err instanceof TypeError &&\n    err.message === 'fetch failed' &&\n    err.cause !== undefined\n  ) {\n    return err.cause\n  }\n\n  // @TODO Add other unwrap patterns here as needed (e.g. for other fetch\n  // implementations or common network libraries, like \"node:http\", or in other\n  // environments like React Native, Deno, Bun, Browser, etc.)\n\n  return err\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-client",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "license": "MIT",
   "description": "HTTP client for interacting with Lexicon based APIs",
   "keywords": [
@@ -38,13 +38,13 @@
   "dependencies": {
     "tslib": "^2.8.1",
     "@atproto/lex-data": "^0.0.15",
-    "@atproto/lex-json": "^0.0.15",
-    "@atproto/lex-schema": "^0.0.18"
+    "@atproto/lex-json": "^0.0.16",
+    "@atproto/lex-schema": "^0.0.19"
   },
   "devDependencies": {
     "vitest": "^4.0.16",
     "@atproto/lex-cbor": "^0.0.16",
-    "@atproto/lex-builder": "^0.0.21"
+    "@atproto/lex-builder": "^0.0.22"
   },
   "scripts": {
     "prebuild": "node ./scripts/lex-build.mjs",

package/src/response.bench.ts

@@ -0,0 +1,113 @@
+import { bench, describe } from 'vitest'
+import {
+  LexParseOptions,
+  jsonToLex,
+  lexParse,
+  lexParseJsonBytes,
+} from '@atproto/lex-json'
+
+// This benchmark compares the performance of three approaches to parsing JSON
+// responses in the Lex client:
+// 1. lexParse(await response.text()): An approach that reads the response as
+//    text and directly parses it with lexParse.
+// 2. jsonToLex(await response.json()): An approach that first parses the
+//    response as JSON to a plain JS object and then converts it to LexValue
+//    using jsonToLex.
+// 3. lexParseJsonBytes(await response.bytes()): An approach that reads the
+//    response as bytes and uses a specialized function to parse JSON directly
+//    from bytes.
+
+describe('small object', () => {
+  benchData({
+    $type: 'app.bsky.feed.post',
+    text: 'Hello world! 👋',
+    createdAt: '2024-01-01T00:00:00Z',
+  })
+})
+
+describe('simple mixed structure', () => {
+  benchData({
+    cid: {
+      $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+    },
+    bytes: {
+      $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+    },
+    blob: {
+      $type: 'blob',
+      ref: {
+        $link: 'bafkreig77vqcdozl2wyk6z3cscaj5q5fggi53aoh64fewkdiri3cdauyn4',
+      },
+      mimeType: 'image/jpeg',
+      size: 10000,
+    },
+    nested: {
+      array: [
+        {
+          number: 42,
+          string: 'hello world',
+          bool: true,
+          null: null,
+        },
+      ],
+      string: 'Hello 世界! 🌍🌎🌏 Ñoño',
+      createdAt: '2024-01-01T00:00:00Z',
+    },
+  })
+})
+
+describe('large structure', () => {
+  benchData({
+    items: Array.from({ length: 25 }, (_, i) => ({
+      id: i,
+      name: `Item ${i}`,
+      longUnicode:
+        'Lorem ipsum dolor sit amet, consectetur adipiscing elit 🤩.\n'.repeat(
+          2,
+        ),
+      tags: ['tag1', 'tag2', 'tag3'],
+      bytes: {
+        $bytes: Buffer.from(`This is some byte data for item ${i}`).toString(
+          'base64',
+        ),
+      },
+      cid: {
+        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      },
+      metadata: {
+        created: '2024-01-01T00:00:00Z',
+        count: i * 10,
+        nested: {
+          flag: i % 2 === 0,
+          values: [i, i * 2, i * 3],
+        },
+        items: Array.from({ length: 5 }, (_, j) => ({
+          id: `${i}-${j}`,
+          value: `Value ${i}-${j}`,
+        })),
+      },
+    })),
+  })
+})
+
+function benchData(data: unknown, options?: LexParseOptions) {
+  const body = Buffer.from(JSON.stringify(data))
+  const init = {
+    headers: { 'Content-Type': 'application/json' },
+  }
+
+  bench('lexParse(await response.text())', async () => {
+    const response = new Response(body, init)
+    lexParse(await response.text(), options)
+  })
+
+  bench('jsonToLex(await response.json())', async () => {
+    const response = new Response(body, init)
+    jsonToLex(await response.json(), options)
+  })
+
+  bench('lexParseJsonBytes(await response.bytes())', async () => {
+    const response = new Response(body, init)
+    lexParseJsonBytes(await response.bytes(), options)
+  })
+}

package/src/response.ts

@@ -1,4 +1,4 @@
-import { LexParseOptions, lexParseJsonBytes } from '@atproto/lex-json'
+import { LexParseOptions, jsonToLex } from '@atproto/lex-json'
 import {
   InferMethodOutputEncoding,
   InferOutput,
@@ -323,9 +323,9 @@ async function readPayload(
     }
 
     if (options?.parse && encoding === CONTENT_TYPE_JSON) {
-      const arrayBuffer = await response.arrayBuffer()
-      const bytes = new Uint8Array(arrayBuffer)
-      const body = lexParseJsonBytes(bytes, options.parse)
+      // @NOTE See ./response.bench.ts to comparison of different parsing approaches.
+      const json = await response.json()
+      const body = jsonToLex(json, options.parse)
       return { encoding, body }
     }
 

package/src/xrpc.ts

@@ -218,7 +218,8 @@ export async function xrpcSafe<const M extends Query | Procedure>(
     const agent = buildAgent(agentOpts)
     const url = xrpcRequestUrl(method, options)
     const request = xrpcRequestInit(method, options)
-    const response = await agent.fetchHandler(url, request).catch((cause) => {
+    const response = await agent.fetchHandler(url, request).catch((err) => {
+      const cause = extractFetchErrorCause(err)
       throw new XrpcFetchError(method, cause)
     })
     return await XrpcResponse.fromFetchResponse<M>(method, response, options)
@@ -412,3 +413,29 @@ function buildEncoding(schema: Payload, encodingHint?: string): string {
     `Unable to determine payload encoding. Please provide a 'content-type' header matching ${schema.encoding}.`,
   )
 }
+
+/**
+ * Extracts the root cause from an error, unwrapping common fetch-related errors
+ * such as those from undici (Node's internal fetch implementation).
+ *
+ * @param err - The error to extract the root cause from
+ * @returns The root cause error, or the original error if no specific pattern is matched
+ * @remarks This is useful for getting more specific error information from fetch-related failures, especially in Node environments using undici.
+ */
+export function extractFetchErrorCause(err: unknown): unknown {
+  // Unwrap the Network error from undici (i.e. Node's internal fetch() implementation)
+  // https://github.com/nodejs/undici/blob/04cb77327f7ada95c2e5b67424cddcb22d7bf882/lib/web/fetch/index.js#L234-L239
+  if (
+    err instanceof TypeError &&
+    err.message === 'fetch failed' &&
+    err.cause !== undefined
+  ) {
+    return err.cause
+  }
+
+  // @TODO Add other unwrap patterns here as needed (e.g. for other fetch
+  // implementations or common network libraries, like "node:http", or in other
+  // environments like React Native, Deno, Bun, Browser, etc.)
+
+  return err
+}

package/tsconfig.build.json

@@ -1,7 +1,7 @@
 {
   "extends": ["../../../tsconfig/isomorphic.json"],
   "include": ["./src"],
-  "exclude": ["**/*.test.ts"],
+  "exclude": ["**/*.bench.ts", "**/*.test.ts"],
   "compilerOptions": {
     "noImplicitAny": true,
     "importHelpers": true,