@atproto/lex-client 0.0.0

package/dist/xrpc.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.xrpc = xrpc;
+exports.xrpcRequestUrl = xrpcRequestUrl;
+exports.xrpcRequestParams = xrpcRequestParams;
+exports.xrpcRequestInit = xrpcRequestInit;
+exports.xrpcRequestHeaders = xrpcRequestHeaders;
+exports.xrpcResponseHandler = xrpcResponseHandler;
+exports.extractEncoding = extractEncoding;
+exports.readResponseBody = readResponseBody;
+const lex_json_1 = require("@atproto/lex-json");
+const lex_schema_1 = require("@atproto/lex-schema");
+const error_js_1 = require("./error.js");
+const response_js_1 = require("./response.js");
+const types_js_1 = require("./types.js");
+async function xrpc(agent, ns, options = {}) {
+    options.signal?.throwIfAborted();
+    const method = (0, types_js_1.getMain)(ns);
+    const url = xrpcRequestUrl(method, options);
+    const request = xrpcRequestInit(method, options);
+    const response = await agent.fetchHandler(url, request);
+    return xrpcResponseHandler(response, method, options);
+}
+function xrpcRequestUrl(method, options) {
+    const path = `/xrpc/${method.nsid}`;
+    const queryString = options.params
+        ? xrpcRequestParams(method.parameters, options.params, options)
+        : undefined;
+    return queryString ? `${path}?${queryString}` : path;
+}
+function xrpcRequestParams(schema, params, options) {
+    const urlSearchParams = schema?.toURLSearchParams(options.validateRequest ? schema.parse(params) : params);
+    return urlSearchParams?.size ? urlSearchParams.toString() : undefined;
+}
+function xrpcRequestInit(schema, options) {
+    const headers = xrpcRequestHeaders(options);
+    // Requests with body
+    if ('input' in schema && schema.input?.encoding) {
+        if (options.validateRequest &&
+            schema.input == null &&
+            options.body !== undefined) {
+            throw new TypeError(`XRPC method ${schema.nsid} does not accept a request body`);
+        }
+        headers.set('content-type', schema.input.encoding);
+        return {
+            duplex: 'half',
+            redirect: 'follow',
+            referrerPolicy: 'strict-origin-when-cross-origin', // (default)
+            mode: 'cors', // (default)
+            signal: options.signal,
+            method: 'POST',
+            headers,
+            body: xrpcRequestBody(schema.input?.encoding, options.validateRequest
+                ? schema.input?.body.parse(options.body)
+                : options.body),
+        };
+    }
+    // Requests without body
+    return {
+        duplex: 'half',
+        redirect: 'follow',
+        referrerPolicy: 'strict-origin-when-cross-origin', // (default)
+        mode: 'cors', // (default)
+        signal: options.signal,
+        method: schema instanceof lex_schema_1.Query ? 'GET' : 'POST',
+        headers,
+    };
+}
+function xrpcRequestHeaders(options) {
+    const headers = new Headers(options.headers);
+    if (options.service && !headers.has('atproto-proxy')) {
+        headers.set('atproto-proxy', options.service);
+    }
+    if (options.labelers) {
+        headers.set('atproto-accept-labelers', [...options.labelers, headers.get('atproto-accept-labelers')?.trim()]
+            .filter(Boolean)
+            .join(', '));
+    }
+    return headers;
+}
+function xrpcRequestBody(encoding, body) {
+    if (encoding === undefined) {
+        return null;
+    }
+    if (encoding === 'application/json') {
+        if (body !== undefined)
+            return (0, lex_json_1.lexStringify)(body);
+    }
+    else if (encoding.startsWith('text/')) {
+        if (typeof body === 'string')
+            return body;
+    }
+    else {
+        if (ArrayBuffer.isView(body) || body instanceof ArrayBuffer)
+            return body;
+    }
+    throw new TypeError(`Invalid ${typeof body} body for ${encoding} encoding`);
+}
+async function xrpcResponseHandler(response, schema, options) {
+    // @NOTE The body MUST either be read or canceled to avoid resource leaks.
+    // Since nothing should cause an exception before "readXrpcResponseBody" is
+    // called, we can safely not use a try/finally here.
+    const encoding = extractEncoding(response.headers);
+    const body = await readResponseBody(response, encoding).catch((cause) => {
+        throw new error_js_1.XrpcServiceError(error_js_1.KnownError.InvalidResponse, response.status, response.headers, undefined, 'Failed to read XRPC response', { cause });
+    });
+    // @NOTE redirect is set to 'follow', so we shouldn't get 3xx responses here
+    if (response.status < 200 || response.status >= 300) {
+        // All unsuccessful responses should follow a standard error response
+        // schema. The Content-Type should be application/json, and the payload
+        // should be a JSON object with the following fields:
+        // - error (string, required): type name of the error (generic ASCII
+        //   constant, no whitespace)
+        // - message (string, optional): description of the error, appropriate for
+        //   display to humans
+        if (body != null &&
+            encoding === 'application/json' &&
+            error_js_1.xrpcErrorBodySchema.check(body)) {
+            throw new error_js_1.XrpcResponseError(response.status, response.headers, encoding, body);
+        }
+        throw new error_js_1.XrpcServiceError(response.status >= 500
+            ? error_js_1.KnownError.InternalServerError
+            : error_js_1.KnownError.InvalidResponse, response.status, response.headers, body);
+    }
+    // Check response encoding
+    if (schema.output.encoding !== encoding) {
+        throw new error_js_1.XrpcServiceError(error_js_1.KnownError.InvalidResponse, response.status, response.headers, body, `Expected response with content-type ${schema.output.encoding}, got ${encoding}`);
+    }
+    if (schema.output.encoding == null) {
+        if (body !== undefined) {
+            throw new error_js_1.XrpcServiceError(error_js_1.KnownError.InvalidResponse, response.status, response.headers, body, `Expected empty response body`);
+        }
+        return new response_js_1.XrpcResponse(schema, response.status, response.headers, undefined);
+    }
+    else {
+        // @NOTE this should already be enforced by readXrpcResponseBody
+        if (body === undefined) {
+            throw new error_js_1.XrpcServiceError(error_js_1.KnownError.InvalidResponse, response.status, response.headers, body, `Expected non-empty response body`);
+        }
+        return new response_js_1.XrpcResponse(schema, response.status, response.headers, schema.output.schema == null || options?.validateResponse === false
+            ? body
+            : schema.output.schema.parse(body));
+    }
+}
+function extractEncoding(headers) {
+    const contentType = headers.get('content-type');
+    if (!contentType)
+        return undefined;
+    return contentType.split(';')[0].trim();
+}
+async function readResponseBody(response, encoding) {
+    // When encoding is undefined or empty, we expect no body
+    if (encoding == null) {
+        if (response.body == null)
+            return undefined;
+        // Let's make sure the body is empty (while avoiding reading it all).
+        if (!('getReader' in response.body)) {
+            // Some environments may not support body.getReader(), fall back to
+            // reading the whole body.
+            const buffer = await response.arrayBuffer();
+            if (buffer.byteLength === 0)
+                return undefined;
+        }
+        else {
+            const reader = response.body.getReader();
+            const next = await reader.read();
+            if (next.done)
+                return undefined;
+            await reader.cancel(); // Drain the rest of the (non-empty) body stream
+        }
+        throw new SyntaxError('Content-type is undefined but body is not empty');
+    }
+    if (encoding === 'application/json') {
+        // @NOTE Using `lexParse(text)` (instead of `jsonToLex(json)`) here as using
+        // a reviver function during JSON.parse should be faster than parsing to
+        // JSON then converting to Lex (?)
+        // @TODO verify statement above
+        return (0, lex_json_1.lexParse)(await response.text());
+    }
+    if (encoding.startsWith('text/')) {
+        return response.text();
+    }
+    return new Uint8Array(await response.arrayBuffer());
+}
+//# sourceMappingURL=xrpc.js.map

package/dist/xrpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xrpc.js","sourceRoot":"","sources":["../src/xrpc.ts"],"names":[],"mappings":";;AAqCA,oBAWC;AAQD,wCAWC;AAED,8CASC;AASD,0CA8CC;AAED,gDAqBC;AAqBD,kDAuGC;AAED,0CAIC;AAUD,4CAsCC;AA7UD,gDAA0D;AAC1D,oDAU4B;AAE5B,yCAKmB;AACnB,+CAA8D;AAC9D,yCAAqE;AAgB9D,KAAK,UAAU,IAAI,CACxB,KAAY,EACZ,EAAgB,EAChB,UAA0B,EAAoB;IAE9C,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAA;IAChC,MAAM,MAAM,GAAG,IAAA,kBAAO,EAAC,EAAE,CAAC,CAAA;IAC1B,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,mBAAmB,CAAI,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AAC1D,CAAC;AAQD,SAAgB,cAAc,CAC5B,MAAS,EACT,OAAiC;IAEjC,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,IAAI,EAAE,CAAA;IAEnC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM;QAChC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAA;IAEb,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACtD,CAAC;AAED,SAAgB,iBAAiB,CAC/B,MAAgC,EAChC,MAA0B,EAC1B,OAAoB;IAEpB,MAAM,eAAe,GAAG,MAAM,EAAE,iBAAiB,CAC/C,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,MAAc,CACjE,CAAA;IACD,OAAO,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;AACvE,CAAC;AASD,SAAgB,eAAe,CAC7B,MAAS,EACT,OAAkC;IAElC,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAE3C,qBAAqB;IACrB,IAAI,OAAO,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC;QAChD,IACE,OAAO,CAAC,eAAe;YACvB,MAAM,CAAC,KAAK,IAAI,IAAI;YACpB,OAAO,CAAC,IAAI,KAAK,SAAS,EAC1B,CAAC;YACD,MAAM,IAAI,SAAS,CACjB,eAAe,MAAM,CAAC,IAAI,iCAAiC,CAC5D,CAAA;QACH,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAClD,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,eAAe,CACnB,MAAM,CAAC,KAAK,EAAE,QAAQ,EACtB,OAAO,CAAC,eAAe;gBACrB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;gBACxC,CAAC,CAAC,OAAO,CAAC,IAAI,CACjB;SACF,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,MAAM,YAAY,kBAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM;QAChD,OAAO;KACR,CAAA;AACH,CAAC;AAED,SAAgB,kBAAkB,CAAC,OAIlC;IACC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAE5C,IAAI,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/C,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CACT,yBAAyB,EACzB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,CAAC;aAClE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,IAAI,CAAC,CACd,CAAA;IACH,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,eAAe,CACtB,QAA4B,EAC5B,IAA0B;IAE1B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,QAAQ,KAAK,kBAAkB,EAAE,CAAC;QACpC,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAA,uBAAY,EAAC,IAAI,CAAC,CAAA;IACnD,CAAC;SAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAA;IAC3C,CAAC;SAAM,CAAC;QACN,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,YAAY,WAAW;YAAE,OAAO,IAAI,CAAA;IAC1E,CAAC;IAED,MAAM,IAAI,SAAS,CAAC,WAAW,OAAO,IAAI,aAAa,QAAQ,WAAW,CAAC,CAAA;AAC7E,CAAC;AAEM,KAAK,UAAU,mBAAmB,CACvC,QAAkB,EAClB,MAAS,EACT,OAAwC;IAExC,0EAA0E;IAC1E,2EAA2E;IAC3E,oDAAoD;IAEpD,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IAElD,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACtE,MAAM,IAAI,2BAAgB,CACxB,qBAAU,CAAC,eAAe,EAC1B,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,SAAS,EACT,8BAA8B,EAC9B,EAAE,KAAK,EAAE,CACV,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,4EAA4E;IAC5E,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QACpD,qEAAqE;QACrE,uEAAuE;QACvE,qDAAqD;QACrD,oEAAoE;QACpE,6BAA6B;QAC7B,0EAA0E;QAC1E,sBAAsB;QACtB,IACE,IAAI,IAAI,IAAI;YACZ,QAAQ,KAAK,kBAAkB;YAC/B,8BAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,EAC/B,CAAC;YACD,MAAM,IAAI,4BAAiB,CACzB,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,QAAQ,EACR,IAAI,CACL,CAAA;QACH,CAAC;QAED,MAAM,IAAI,2BAAgB,CACxB,QAAQ,CAAC,MAAM,IAAI,GAAG;YACpB,CAAC,CAAC,qBAAU,CAAC,mBAAmB;YAChC,CAAC,CAAC,qBAAU,CAAC,eAAe,EAC9B,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,IAAI,CACL,CAAA;IACH,CAAC;IAED,0BAA0B;IAC1B,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACxC,MAAM,IAAI,2BAAgB,CACxB,qBAAU,CAAC,eAAe,EAC1B,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,IAAI,EACJ,uCAAuC,MAAM,CAAC,MAAM,CAAC,QAAQ,SAAS,QAAQ,EAAE,CACjF,CAAA;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,2BAAgB,CACxB,qBAAU,CAAC,eAAe,EAC1B,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,IAAI,EACJ,8BAA8B,CAC/B,CAAA;QACH,CAAC;QAED,OAAO,IAAI,0BAAY,CACrB,MAAM,EACN,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,SAAgC,CACjC,CAAA;IACH,CAAC;SAAM,CAAC;QACN,gEAAgE;QAChE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,2BAAgB,CACxB,qBAAU,CAAC,eAAe,EAC1B,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,IAAI,EACJ,kCAAkC,CACnC,CAAA;QACH,CAAC;QAED,OAAO,IAAI,0BAAY,CACrB,MAAM,EACN,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,OAAO,EAChB,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,IAAI,OAAO,EAAE,gBAAgB,KAAK,KAAK;YACjE,CAAC,CAAE,IAA4B;YAC/B,CAAC,CAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAyB,CAC9D,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAAC,OAAgB;IAC9C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IAC/C,IAAI,CAAC,WAAW;QAAE,OAAO,SAAS,CAAA;IAClC,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;AACzC,CAAC;AAUM,KAAK,UAAU,gBAAgB,CACpC,QAAkB,EAClB,QAA4B;IAE5B,yDAAyD;IACzD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,QAAQ,CAAC,IAAI,IAAI,IAAI;YAAE,OAAO,SAAS,CAAA;QAE3C,qEAAqE;QACrE,IAAI,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,mEAAmE;YACnE,0BAA0B;YAC1B,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;YAC3C,IAAI,MAAM,CAAC,UAAU,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA;YACxC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;YAChC,IAAI,IAAI,CAAC,IAAI;gBAAE,OAAO,SAAS,CAAA;YAC/B,MAAM,MAAM,CAAC,MAAM,EAAE,CAAA,CAAC,gDAAgD;QACxE,CAAC;QAED,MAAM,IAAI,WAAW,CAAC,iDAAiD,CAAC,CAAA;IAC1E,CAAC;IAED,IAAI,QAAQ,KAAK,kBAAkB,EAAE,CAAC;QACpC,4EAA4E;QAC5E,wEAAwE;QACxE,kCAAkC;QAElC,+BAA+B;QAC/B,OAAO,IAAA,mBAAQ,EAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAA;AACrD,CAAC","sourcesContent":["import { LexValue } from '@atproto/lex-data'\nimport { lexParse, lexStringify } from '@atproto/lex-json'\nimport {\n  Did,\n  InferParamsSchema,\n  InferPayloadBody,\n  Params,\n  ParamsSchema,\n  Procedure,\n  Query,\n  Restricted,\n  Subscription,\n} from '@atproto/lex-schema'\nimport { Agent } from './agent.js'\nimport {\n  KnownError,\n  XrpcResponseError,\n  XrpcServiceError,\n  xrpcErrorBodySchema,\n} from './error.js'\nimport { XrpcResponse, XrpcResponseBody } from './response.js'\nimport { CallOptions, Namespace, Service, getMain } from './types.js'\n\nexport type XrpcOptions<M extends Procedure | Query = Procedure | Query> =\n  CallOptions & XrpcRequestUrlOptions<M> & XrpcRequestInitOptions<M>\n\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: NonNullable<unknown> extends XrpcOptions<M>\n    ? Namespace<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: Namespace<M>,\n  options: XrpcOptions<M>,\n): Promise<XrpcResponse<M>>\nexport async function xrpc<const M extends Query | Procedure>(\n  agent: Agent,\n  ns: Namespace<M>,\n  options: XrpcOptions<M> = {} as XrpcOptions<M>,\n): Promise<XrpcResponse<M>> {\n  options.signal?.throwIfAborted()\n  const method = getMain(ns)\n  const url = xrpcRequestUrl(method, options)\n  const request = xrpcRequestInit(method, options)\n  const response = await agent.fetchHandler(url, request)\n  return xrpcResponseHandler<M>(response, method, options)\n}\n\nexport type XrpcRequestUrlOptions<M extends Query | Procedure | Subscription> =\n  CallOptions &\n    (undefined extends InferParamsSchema<M['parameters']>\n      ? { params?: InferParamsSchema<M['parameters']> }\n      : { params: InferParamsSchema<M['parameters']> })\n\nexport function xrpcRequestUrl<M extends Procedure | Query | Subscription>(\n  method: M,\n  options: XrpcRequestUrlOptions<M>,\n) {\n  const path = `/xrpc/${method.nsid}`\n\n  const queryString = options.params\n    ? xrpcRequestParams(method.parameters, options.params, options)\n    : undefined\n\n  return queryString ? `${path}?${queryString}` : path\n}\n\nexport function xrpcRequestParams(\n  schema: ParamsSchema | undefined,\n  params: Params | undefined,\n  options: CallOptions,\n): undefined | string {\n  const urlSearchParams = schema?.toURLSearchParams(\n    options.validateRequest ? schema.parse(params) : (params as any),\n  )\n  return urlSearchParams?.size ? urlSearchParams.toString() : undefined\n}\n\nexport type XrpcRequestInitOptions<T extends Query | Procedure> = CallOptions &\n  (T extends Procedure\n    ? never extends InferPayloadBody<T['input']>\n      ? { body?: InferPayloadBody<T['input']> }\n      : { body: InferPayloadBody<T['input']> }\n    : { body?: never })\n\nexport function xrpcRequestInit<T extends Procedure | Query>(\n  schema: T,\n  options: XrpcRequestInitOptions<T>,\n): RequestInit & { duplex?: 'half' } {\n  const headers = xrpcRequestHeaders(options)\n\n  // Requests with body\n  if ('input' in schema && schema.input?.encoding) {\n    if (\n      options.validateRequest &&\n      schema.input == null &&\n      options.body !== undefined\n    ) {\n      throw new TypeError(\n        `XRPC method ${schema.nsid} does not accept a request body`,\n      )\n    }\n\n    headers.set('content-type', schema.input.encoding)\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: xrpcRequestBody(\n        schema.input?.encoding,\n        options.validateRequest\n          ? schema.input?.body.parse(options.body)\n          : options.body,\n      ),\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: schema instanceof Query ? 'GET' : 'POST',\n    headers,\n  }\n}\n\nexport function xrpcRequestHeaders(options: {\n  headers?: HeadersInit\n  service?: Service\n  labelers?: Iterable<Did>\n}): Headers {\n  const headers = new Headers(options.headers)\n\n  if (options.service && !headers.has('atproto-proxy')) {\n    headers.set('atproto-proxy', options.service)\n  }\n\n  if (options.labelers) {\n    headers.set(\n      'atproto-accept-labelers',\n      [...options.labelers, headers.get('atproto-accept-labelers')?.trim()]\n        .filter(Boolean)\n        .join(', '),\n    )\n  }\n\n  return headers\n}\n\nfunction xrpcRequestBody(\n  encoding: string | undefined,\n  body: LexValue | undefined,\n): BodyInit | null {\n  if (encoding === undefined) {\n    return null\n  }\n\n  if (encoding === 'application/json') {\n    if (body !== undefined) return lexStringify(body)\n  } else if (encoding.startsWith('text/')) {\n    if (typeof body === 'string') return body\n  } else {\n    if (ArrayBuffer.isView(body) || body instanceof ArrayBuffer) return body\n  }\n\n  throw new TypeError(`Invalid ${typeof body} body for ${encoding} encoding`)\n}\n\nexport async function xrpcResponseHandler<M extends Procedure | Query>(\n  response: Response,\n  schema: M,\n  options?: { validateResponse?: boolean },\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 \"readXrpcResponseBody\" is\n  // called, we can safely not use a try/finally here.\n\n  const encoding = extractEncoding(response.headers)\n\n  const body = await readResponseBody(response, encoding).catch((cause) => {\n    throw new XrpcServiceError(\n      KnownError.InvalidResponse,\n      response.status,\n      response.headers,\n      undefined,\n      'Failed to read XRPC response',\n      { cause },\n    )\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    // All unsuccessful responses should follow a standard error response\n    // schema. The Content-Type should be application/json, and the payload\n    // should be a JSON object with the following fields:\n    // - error (string, required): type name of the error (generic ASCII\n    //   constant, no whitespace)\n    // - message (string, optional): description of the error, appropriate for\n    //   display to humans\n    if (\n      body != null &&\n      encoding === 'application/json' &&\n      xrpcErrorBodySchema.check(body)\n    ) {\n      throw new XrpcResponseError(\n        response.status,\n        response.headers,\n        encoding,\n        body,\n      )\n    }\n\n    throw new XrpcServiceError(\n      response.status >= 500\n        ? KnownError.InternalServerError\n        : KnownError.InvalidResponse,\n      response.status,\n      response.headers,\n      body,\n    )\n  }\n\n  // Check response encoding\n  if (schema.output.encoding !== encoding) {\n    throw new XrpcServiceError(\n      KnownError.InvalidResponse,\n      response.status,\n      response.headers,\n      body,\n      `Expected response with content-type ${schema.output.encoding}, got ${encoding}`,\n    )\n  }\n\n  if (schema.output.encoding == null) {\n    if (body !== undefined) {\n      throw new XrpcServiceError(\n        KnownError.InvalidResponse,\n        response.status,\n        response.headers,\n        body,\n        `Expected empty response body`,\n      )\n    }\n\n    return new XrpcResponse<M>(\n      schema,\n      response.status,\n      response.headers,\n      undefined as XrpcResponseBody<M>,\n    )\n  } else {\n    // @NOTE this should already be enforced by readXrpcResponseBody\n    if (body === undefined) {\n      throw new XrpcServiceError(\n        KnownError.InvalidResponse,\n        response.status,\n        response.headers,\n        body,\n        `Expected non-empty response body`,\n      )\n    }\n\n    return new XrpcResponse<M>(\n      schema,\n      response.status,\n      response.headers,\n      schema.output.schema == null || options?.validateResponse === false\n        ? (body as XrpcResponseBody<M>)\n        : (schema.output.schema.parse(body) as XrpcResponseBody<M>),\n    )\n  }\n}\n\nexport function extractEncoding(headers: Headers): string | undefined {\n  const contentType = headers.get('content-type')\n  if (!contentType) return undefined\n  return contentType.split(';')[0].trim()\n}\n\nexport async function readResponseBody(\n  response: Response,\n  encoding: string,\n): Promise<LexValue>\nexport async function readResponseBody(\n  response: Response,\n  encoding: string | undefined,\n): Promise<LexValue | undefined>\nexport async function readResponseBody(\n  response: Response,\n  encoding: string | undefined,\n): Promise<LexValue | undefined> {\n  // When encoding is undefined or empty, we expect no body\n  if (encoding == null) {\n    if (response.body == null) return undefined\n\n    // Let's make sure the body is empty (while avoiding reading it all).\n    if (!('getReader' in response.body)) {\n      // Some environments may not support body.getReader(), fall back to\n      // reading the whole body.\n      const buffer = await response.arrayBuffer()\n      if (buffer.byteLength === 0) return undefined\n    } else {\n      const reader = response.body.getReader()\n      const next = await reader.read()\n      if (next.done) return undefined\n      await reader.cancel() // Drain the rest of the (non-empty) body stream\n    }\n\n    throw new SyntaxError('Content-type is undefined but body is not empty')\n  }\n\n  if (encoding === 'application/json') {\n    // @NOTE Using `lexParse(text)` (instead of `jsonToLex(json)`) here as using\n    // a reviver function during JSON.parse should be faster than parsing to\n    // JSON then converting to Lex (?)\n\n    // @TODO verify statement above\n    return lexParse(await response.text())\n  }\n\n  if (encoding.startsWith('text/')) {\n    return response.text()\n  }\n\n  return new Uint8Array(await response.arrayBuffer())\n}\n"]}

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  transform: { '^.+\\.(t|j)s$': ['@swc/jest'] },
+  moduleNameMapper: { '^(\\.\\.?\\/.+)\\.js$': ['$1.ts', '$1.js'] },
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@atproto/lex-client",
+  "version": "0.0.0",
+  "license": "MIT",
+  "description": "HTTP client for interacting with Lexicon based APIs",
+  "keywords": [
+    "atproto",
+    "lexicon",
+    "xrpc",
+    "client"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/lex/lex-client"
+  },
+  "dependencies": {
+    "@atproto/lex-data": "workspace:*",
+    "@atproto/lex-json": "workspace:*",
+    "@atproto/lex-schema": "workspace:*",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@atproto/lex-cbor": "workspace:*",
+    "@atproto/lex-builder": "workspace:*",
+    "jest": "^28.1.2"
+  },
+  "scripts": {
+    "prebuild": "node ./scripts/lex-build.mjs",
+    "build": "tsc --build tsconfig.build.json",
+    "test": "jest"
+  },
+  "sideEffects": false,
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": "./dist/index.js",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  }
+}

package/scripts/lex-build.mjs

@@ -0,0 +1,40 @@
+/* eslint-env node  */
+
+import { build } from '@atproto/lex-builder'
+
+Promise.all([
+  // For src
+  build({
+    lexicons: '../../../lexicons',
+    out: './src/lexicons',
+    override: true,
+    include: [
+      'com.atproto.repo.createRecord',
+      'com.atproto.repo.deleteRecord',
+      'com.atproto.repo.getRecord',
+      'com.atproto.repo.putRecord',
+      'com.atproto.repo.listRecords',
+      'com.atproto.repo.uploadBlob',
+    ],
+    lib: '@atproto/lex-schema',
+    pretty: true,
+    pureAnnotations: true,
+  }),
+
+  // For tests
+  build({
+    lexicons: '../../../lexicons',
+    out: './tests/lexicons',
+    override: true,
+    include: [
+      'app.bsky.*',
+      'com.atproto.repo.createRecord',
+      'com.atproto.repo.getRecord',
+    ],
+    lib: '@atproto/lex-schema',
+    pretty: true,
+  }),
+]).catch((err) => {
+  console.error('Error building lexicon schemas:', err)
+  process.exit(1)
+})

package/src/agent.ts

@@ -0,0 +1,63 @@
+import { Did } from '@atproto/lex-schema'
+
+export interface Agent {
+  did?: Did
+
+  fetchHandler: (
+    this: Agent,
+    /**
+     * The URL (pathname + query parameters) to make the request to, without the
+     * origin. The origin (protocol, hostname, and port) must be added by this
+     * {@link FetchHandler}, typically based on authentication or other factors.
+     */
+    path: string,
+    init: RequestInit,
+  ) => Promise<Response>
+}
+
+export type AgentConfig = {
+  /**
+   * The identifier (DID) of the user represented by this agent.
+   */
+  did?: Did
+
+  /**
+   * The service URL to make requests to. This can be a string, URL, or a
+   * function that returns a string or URL. This is useful for dynamic URLs,
+   * such as a service URL that changes based on authentication.
+   */
+  service: string | URL
+
+  /**
+   * Bring your own fetch implementation. Typically useful for testing, logging,
+   * mocking, or adding retries, session management, signatures, proof of
+   * possession (DPoP), SSRF protection, etc. Defaults to the global `fetch`
+   * function.
+   */
+  fetch?: typeof globalThis.fetch
+}
+
+export type AgentOptions = AgentConfig | string | URL
+
+export function buildAgent(options: AgentOptions): Agent {
+  const config: AgentConfig =
+    typeof options === 'string' || options instanceof URL
+      ? { did: undefined, service: options }
+      : options
+
+  const { service, fetch = globalThis.fetch } = config
+
+  if (typeof fetch !== 'function') {
+    throw new TypeError('fetch() is not available in this environment')
+  }
+
+  return {
+    get did() {
+      return config.did
+    },
+
+    async fetchHandler(path, init) {
+      return fetch(new URL(path, service), init)
+    },
+  }
+}