@atproto/xrpc-server 0.4.4 → 0.5.1

package/dist/types.js

@@ -0,0 +1,163 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodNotImplementedError = exports.UpstreamTimeoutError = exports.NotEnoughResourcesError = exports.UpstreamFailureError = exports.InternalServerError = exports.RateLimitExceededError = exports.ForbiddenError = exports.AuthRequiredError = exports.InvalidRequestError = exports.isHandlerError = exports.XRPCError = exports.isShared = exports.handlerError = exports.handlerPipeThrough = exports.handlerSuccess = exports.handlerAuth = exports.handlerInput = void 0;
+const http_errors_1 = require("http-errors");
+const zod_1 = __importDefault(require("zod"));
+const xrpc_1 = require("@atproto/xrpc");
+exports.handlerInput = zod_1.default.object({
+    encoding: zod_1.default.string(),
+    body: zod_1.default.any(),
+});
+exports.handlerAuth = zod_1.default.object({
+    credentials: zod_1.default.any(),
+    artifacts: zod_1.default.any(),
+});
+exports.handlerSuccess = zod_1.default.object({
+    encoding: zod_1.default.string(),
+    body: zod_1.default.any(),
+    headers: zod_1.default.record(zod_1.default.string()).optional(),
+});
+exports.handlerPipeThrough = zod_1.default.object({
+    encoding: zod_1.default.string(),
+    buffer: zod_1.default.instanceof(ArrayBuffer),
+    headers: zod_1.default.record(zod_1.default.string()).optional(),
+});
+exports.handlerError = zod_1.default.object({
+    status: zod_1.default.number(),
+    error: zod_1.default.string().optional(),
+    message: zod_1.default.string().optional(),
+});
+const isShared = (opts) => {
+    return typeof opts['name'] === 'string';
+};
+exports.isShared = isShared;
+class XRPCError extends Error {
+    constructor(type, errorMessage, customErrorName) {
+        super(errorMessage);
+        Object.defineProperty(this, "type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: type
+        });
+        Object.defineProperty(this, "errorMessage", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: errorMessage
+        });
+        Object.defineProperty(this, "customErrorName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: customErrorName
+        });
+    }
+    get payload() {
+        return {
+            error: this.customErrorName ?? this.typeName,
+            message: this.type === xrpc_1.ResponseType.InternalServerError
+                ? this.typeStr // Do not respond with error details for 500s
+                : this.errorMessage || this.typeStr,
+        };
+    }
+    get typeName() {
+        return xrpc_1.ResponseTypeNames[this.type];
+    }
+    get typeStr() {
+        return xrpc_1.ResponseTypeStrings[this.type];
+    }
+    static fromError(error) {
+        if (error instanceof XRPCError) {
+            return error;
+        }
+        let resultErr;
+        if ((0, http_errors_1.isHttpError)(error)) {
+            resultErr = new XRPCError(error.status, error.message, error.name);
+        }
+        else if (isHandlerError(error)) {
+            resultErr = new XRPCError(error.status, error.message, error.error);
+        }
+        else if (error instanceof Error) {
+            resultErr = new InternalServerError(error.message);
+        }
+        else {
+            resultErr = new InternalServerError('Unexpected internal server error');
+        }
+        resultErr.cause = error;
+        return resultErr;
+    }
+}
+exports.XRPCError = XRPCError;
+function isHandlerError(v) {
+    return (!!v &&
+        typeof v === 'object' &&
+        typeof v['status'] === 'number' &&
+        (v['error'] === undefined || typeof v['error'] === 'string') &&
+        (v['message'] === undefined || typeof v['message'] === 'string'));
+}
+exports.isHandlerError = isHandlerError;
+class InvalidRequestError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.InvalidRequest, errorMessage, customErrorName);
+    }
+}
+exports.InvalidRequestError = InvalidRequestError;
+class AuthRequiredError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.AuthRequired, errorMessage, customErrorName);
+    }
+}
+exports.AuthRequiredError = AuthRequiredError;
+class ForbiddenError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.Forbidden, errorMessage, customErrorName);
+    }
+}
+exports.ForbiddenError = ForbiddenError;
+class RateLimitExceededError extends XRPCError {
+    constructor(status, errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.RateLimitExceeded, errorMessage, customErrorName);
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: status
+        });
+    }
+}
+exports.RateLimitExceededError = RateLimitExceededError;
+class InternalServerError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.InternalServerError, errorMessage, customErrorName);
+    }
+}
+exports.InternalServerError = InternalServerError;
+class UpstreamFailureError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.UpstreamFailure, errorMessage, customErrorName);
+    }
+}
+exports.UpstreamFailureError = UpstreamFailureError;
+class NotEnoughResourcesError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.NotEnoughResources, errorMessage, customErrorName);
+    }
+}
+exports.NotEnoughResourcesError = NotEnoughResourcesError;
+class UpstreamTimeoutError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.UpstreamTimeout, errorMessage, customErrorName);
+    }
+}
+exports.UpstreamTimeoutError = UpstreamTimeoutError;
+class MethodNotImplementedError extends XRPCError {
+    constructor(errorMessage, customErrorName) {
+        super(xrpc_1.ResponseType.MethodNotImplemented, errorMessage, customErrorName);
+    }
+}
+exports.MethodNotImplementedError = MethodNotImplementedError;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;AAEA,6CAAyC;AACzC,8CAAqB;AACrB,wCAIsB;AA4BT,QAAA,YAAY,GAAG,aAAG,CAAC,MAAM,CAAC;IACrC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,aAAG,CAAC,GAAG,EAAE;CAChB,CAAC,CAAA;AAGW,QAAA,WAAW,GAAG,aAAG,CAAC,MAAM,CAAC;IACpC,WAAW,EAAE,aAAG,CAAC,GAAG,EAAE;IACtB,SAAS,EAAE,aAAG,CAAC,GAAG,EAAE;CACrB,CAAC,CAAA;AAGW,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,aAAG,CAAC,GAAG,EAAE;IACf,OAAO,EAAE,aAAG,CAAC,MAAM,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAA;AAGW,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE;IACtB,MAAM,EAAE,aAAG,CAAC,UAAU,CAAC,WAAW,CAAC;IACnC,OAAO,EAAE,aAAG,CAAC,MAAM,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAA;AAGW,QAAA,YAAY,GAAG,aAAG,CAAC,MAAM,CAAC;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE;IACpB,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAA;AA8EK,MAAM,QAAQ,GAAG,CACtB,IAA0B,EACG,EAAE;IAC/B,OAAO,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAA;AACzC,CAAC,CAAA;AAJY,QAAA,QAAQ,YAIpB;AA2BD,MAAa,SAAU,SAAQ,KAAK;IAClC,YACS,IAAkB,EAClB,YAAqB,EACrB,eAAwB;QAE/B,KAAK,CAAC,YAAY,CAAC,CAAA;QAJnB;;;;mBAAO,IAAI;WAAc;QACzB;;;;mBAAO,YAAY;WAAS;QAC5B;;;;mBAAO,eAAe;WAAS;IAGjC,CAAC;IAED,IAAI,OAAO;QACT,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,QAAQ;YAC5C,OAAO,EACL,IAAI,CAAC,IAAI,KAAK,mBAAY,CAAC,mBAAmB;gBAC5C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,6CAA6C;gBAC5D,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO;SACxC,CAAA;IACH,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,wBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,0BAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAc;QAC7B,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,SAAoB,CAAA;QACxB,IAAI,IAAA,yBAAW,EAAC,KAAK,CAAC,EAAE,CAAC;YACvB,SAAS,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QACpE,CAAC;aAAM,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,SAAS,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;QACrE,CAAC;aAAM,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAClC,SAAS,GAAG,IAAI,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,IAAI,mBAAmB,CAAC,kCAAkC,CAAC,CAAA;QACzE,CAAC;QACD,SAAS,CAAC,KAAK,GAAG,KAAK,CAAA;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;CACF;AA5CD,8BA4CC;AAED,SAAgB,cAAc,CAAC,CAAU;IACvC,OAAO,CACL,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,KAAK,QAAQ;QACrB,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAC/B,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;QAC5D,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,CACjE,CAAA;AACH,CAAC;AARD,wCAQC;AAED,MAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,cAAc,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACnE,CAAC;CACF;AAJD,kDAIC;AAED,MAAa,iBAAkB,SAAQ,SAAS;IAC9C,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,YAAY,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACjE,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,cAAe,SAAQ,SAAS;IAC3C,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IAC9D,CAAC;CACF;AAJD,wCAIC;AAED,MAAa,sBAAuB,SAAQ,SAAS;IACnD,YACS,MAAyB,EAChC,YAAqB,EACrB,eAAwB;QAExB,KAAK,CAAC,mBAAY,CAAC,iBAAiB,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;QAJpE;;;;mBAAO,MAAM;WAAmB;IAKlC,CAAC;CACF;AARD,wDAQC;AAED,MAAa,mBAAoB,SAAQ,SAAS;IAChD,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,mBAAmB,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACxE,CAAC;CACF;AAJD,kDAIC;AAED,MAAa,oBAAqB,SAAQ,SAAS;IACjD,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,eAAe,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACpE,CAAC;CACF;AAJD,oDAIC;AAED,MAAa,uBAAwB,SAAQ,SAAS;IACpD,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,kBAAkB,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACvE,CAAC;CACF;AAJD,0DAIC;AAED,MAAa,oBAAqB,SAAQ,SAAS;IACjD,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,eAAe,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACpE,CAAC;CACF;AAJD,oDAIC;AAED,MAAa,yBAA0B,SAAQ,SAAS;IACtD,YAAY,YAAqB,EAAE,eAAwB;QACzD,KAAK,CAAC,mBAAY,CAAC,oBAAoB,EAAE,YAAY,EAAE,eAAe,CAAC,CAAA;IACzE,CAAC;CACF;AAJD,8DAIC"}

package/dist/util.d.ts

@@ -24,3 +24,4 @@ export interface ServerTiming {
     duration?: number;
     description?: string;
 }
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EAEL,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EACL,eAAe,EACf,MAAM,EACN,YAAY,EACZ,cAAc,EAKd,SAAS,EACV,MAAM,SAAS,CAAA;AAEhB,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,gBAAgB,GAAG,YAAY,GAAG,mBAAmB,EAC1D,MAAM,EAAE,eAAe,GACtB,MAAM,CAmBR;AAED,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,GACb,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAcvC;AAED,wBAAgB,cAAc,CAAC,GAAG,SAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAU1E;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,gBAAgB,GAAG,YAAY,EACpC,GAAG,EAAE,OAAO,CAAC,OAAO,EACpB,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,QAAQ,GACjB,YAAY,GAAG,SAAS,CA8D1B;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,gBAAgB,GAAG,YAAY,EACpC,MAAM,EAAE,cAAc,GAAG,SAAS,EAClC,QAAQ,EAAE,QAAQ,GACjB,cAAc,GAAG,SAAS,CA0C5B;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,OAOtC;AAUD,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,6BAI3C;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAM5E;AA0CD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,UASzD;AAED,qBAAa,WAAY,YAAW,YAAY;IAIrC,IAAI,EAAE,MAAM;IACZ,WAAW,CAAC;IAJd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACxB,OAAO,CAAC,OAAO,CAAC,CAAQ;gBAEf,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,oBAAQ;IAE7B,KAAK;IAIL,IAAI;CAKL;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}

package/dist/util.js

@@ -0,0 +1,263 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerTimer = exports.serverTimingHeader = exports.processBodyAsBytes = exports.hasBody = exports.normalizeMime = exports.validateOutput = exports.validateInput = exports.getQueryParams = exports.decodeQueryParam = exports.decodeQueryParams = void 0;
+const assert_1 = __importDefault(require("assert"));
+const zlib_1 = require("zlib");
+const mime_types_1 = __importDefault(require("mime-types"));
+const lexicon_1 = require("@atproto/lexicon");
+const common_1 = require("@atproto/common");
+const types_1 = require("./types");
+function decodeQueryParams(def, params) {
+    const decoded = {};
+    for (const k in params) {
+        const val = params[k];
+        const property = def.parameters?.properties?.[k];
+        if (property) {
+            if (property.type === 'array') {
+                const vals = [];
+                decoded[k] = val
+                    ? vals
+                        .concat(val) // Cast to array
+                        .flatMap((v) => decodeQueryParam(property.items.type, v) ?? [])
+                    : undefined;
+            }
+            else {
+                decoded[k] = decodeQueryParam(property.type, val);
+            }
+        }
+    }
+    return decoded;
+}
+exports.decodeQueryParams = decodeQueryParams;
+function decodeQueryParam(type, value) {
+    if (!value) {
+        return undefined;
+    }
+    if (type === 'string' || type === 'datetime') {
+        return String(value);
+    }
+    if (type === 'float') {
+        return Number(String(value));
+    }
+    else if (type === 'integer') {
+        return parseInt(String(value), 10) || 0;
+    }
+    else if (type === 'boolean') {
+        return value === 'true';
+    }
+}
+exports.decodeQueryParam = decodeQueryParam;
+function getQueryParams(url = '') {
+    const { searchParams } = new URL(url ?? '', 'http://x');
+    const result = {};
+    for (const key of searchParams.keys()) {
+        result[key] = searchParams.getAll(key);
+        if (result[key].length === 1) {
+            result[key] = result[key][0];
+        }
+    }
+    return result;
+}
+exports.getQueryParams = getQueryParams;
+function validateInput(nsid, def, req, opts, lexicons) {
+    // request expectation
+    const reqHasBody = hasBody(req);
+    if (reqHasBody && (def.type !== 'procedure' || !def.input)) {
+        throw new types_1.InvalidRequestError(`A request body was provided when none was expected`);
+    }
+    if (def.type === 'query') {
+        return;
+    }
+    if (!reqHasBody && def.input) {
+        throw new types_1.InvalidRequestError(`A request body is expected but none was provided`);
+    }
+    // mimetype
+    const inputEncoding = normalizeMime(req.headers['content-type'] || '');
+    if (def.input?.encoding &&
+        (!inputEncoding || !isValidEncoding(def.input?.encoding, inputEncoding))) {
+        if (!inputEncoding) {
+            throw new types_1.InvalidRequestError(`Request encoding (Content-Type) required but not provided`);
+        }
+        else {
+            throw new types_1.InvalidRequestError(`Wrong request encoding (Content-Type): ${inputEncoding}`);
+        }
+    }
+    if (!inputEncoding) {
+        // no input body
+        return undefined;
+    }
+    // if input schema, validate
+    if (def.input?.schema) {
+        try {
+            const lexBody = req.body ? (0, lexicon_1.jsonToLex)(req.body) : req.body;
+            req.body = lexicons.assertValidXrpcInput(nsid, lexBody);
+        }
+        catch (e) {
+            throw new types_1.InvalidRequestError(e instanceof Error ? e.message : String(e));
+        }
+    }
+    // if middleware already got the body, we pass that along as input
+    // otherwise, we pass along a decoded readable stream
+    let body;
+    if (req.readableEnded) {
+        body = req.body;
+    }
+    else {
+        body = decodeBodyStream(req, opts.blobLimit);
+    }
+    return {
+        encoding: inputEncoding,
+        body,
+    };
+}
+exports.validateInput = validateInput;
+function validateOutput(nsid, def, output, lexicons) {
+    // initial validation
+    if (output) {
+        types_1.handlerSuccess.parse(output);
+    }
+    // response expectation
+    if (output?.body && !def.output) {
+        throw new types_1.InternalServerError(`A response body was provided when none was expected`);
+    }
+    if (!output?.body && def.output) {
+        throw new types_1.InternalServerError(`A response body is expected but none was provided`);
+    }
+    // mimetype
+    if (def.output?.encoding &&
+        (!output?.encoding ||
+            !isValidEncoding(def.output?.encoding, output?.encoding))) {
+        throw new types_1.InternalServerError(`Invalid response encoding: ${output?.encoding}`);
+    }
+    // output schema
+    if (def.output?.schema) {
+        try {
+            const result = lexicons.assertValidXrpcOutput(nsid, output?.body);
+            if (output) {
+                output.body = result;
+            }
+        }
+        catch (e) {
+            throw new types_1.InternalServerError(e instanceof Error ? e.message : String(e));
+        }
+    }
+    return output;
+}
+exports.validateOutput = validateOutput;
+function normalizeMime(v) {
+    if (!v)
+        return false;
+    const fullType = mime_types_1.default.contentType(v);
+    if (!fullType)
+        return false;
+    const shortType = fullType.split(';')[0];
+    if (!shortType)
+        return false;
+    return shortType;
+}
+exports.normalizeMime = normalizeMime;
+function isValidEncoding(possibleStr, value) {
+    const possible = possibleStr.split(',').map((v) => v.trim());
+    const normalized = normalizeMime(value);
+    if (!normalized)
+        return false;
+    if (possible.includes('*/*'))
+        return true;
+    return possible.includes(normalized);
+}
+function hasBody(req) {
+    const contentLength = req.headers['content-length'];
+    const transferEncoding = req.headers['transfer-encoding'];
+    return (contentLength && parseInt(contentLength, 10) > 0) || transferEncoding;
+}
+exports.hasBody = hasBody;
+function processBodyAsBytes(req) {
+    return new Promise((resolve) => {
+        const chunks = [];
+        req.on('data', (chunk) => chunks.push(chunk));
+        req.on('end', () => resolve(new Uint8Array(Buffer.concat(chunks))));
+    });
+}
+exports.processBodyAsBytes = processBodyAsBytes;
+function decodeBodyStream(req, maxSize) {
+    let stream = req;
+    const contentEncoding = req.headers['content-encoding'];
+    const contentLength = req.headers['content-length'];
+    if (maxSize !== undefined &&
+        contentLength &&
+        parseInt(contentLength, 10) > maxSize) {
+        throw new types_1.XRPCError(413, 'request entity too large');
+    }
+    let decoder;
+    if (contentEncoding === 'gzip') {
+        decoder = (0, zlib_1.createGunzip)();
+    }
+    else if (contentEncoding === 'deflate') {
+        decoder = (0, zlib_1.createDeflate)();
+    }
+    if (decoder) {
+        (0, common_1.forwardStreamErrors)(stream, decoder);
+        stream = stream.pipe(decoder);
+    }
+    if (maxSize !== undefined) {
+        const maxSizeChecker = new common_1.MaxSizeChecker(maxSize, () => new types_1.XRPCError(413, 'request entity too large'));
+        (0, common_1.forwardStreamErrors)(stream, maxSizeChecker);
+        stream = stream.pipe(maxSizeChecker);
+    }
+    return stream;
+}
+function serverTimingHeader(timings) {
+    return timings
+        .map((timing) => {
+        let header = timing.name;
+        if (timing.duration)
+            header += `;dur=${timing.duration}`;
+        if (timing.description)
+            header += `;desc="${timing.description}"`;
+        return header;
+    })
+        .join(', ');
+}
+exports.serverTimingHeader = serverTimingHeader;
+class ServerTimer {
+    constructor(name, description) {
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: name
+        });
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: description
+        });
+        Object.defineProperty(this, "duration", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "startMs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    start() {
+        this.startMs = Date.now();
+        return this;
+    }
+    stop() {
+        (0, assert_1.default)(this.startMs, "timer hasn't been started");
+        this.duration = Date.now() - this.startMs;
+        return this;
+    }
+}
+exports.ServerTimer = ServerTimer;
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,+BAAkD;AAElD,4DAA6B;AAC7B,8CAMyB;AACzB,4CAAqE;AACrE,mCAUgB;AAEhB,SAAgB,iBAAiB,CAC/B,GAA0D,EAC1D,MAAuB;IAEvB,MAAM,OAAO,GAAW,EAAE,CAAA;IAC1B,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACrB,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAA;QAChD,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC9B,MAAM,IAAI,GAAmB,EAAE,CAAA;gBAC/B,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG;oBACd,CAAC,CAAC,IAAI;yBACD,MAAM,CAAC,GAAG,CAAC,CAAC,gBAAgB;yBAC5B,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;oBACnE,CAAC,CAAC,SAAS,CAAA;YACf,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YACnD,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAtBD,8CAsBC;AAED,SAAgB,gBAAgB,CAC9B,IAAY,EACZ,KAAc;IAEd,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QAC7C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IACD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAC9B,CAAC;SAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;IACzC,CAAC;SAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,KAAK,KAAK,MAAM,CAAA;IACzB,CAAC;AACH,CAAC;AAjBD,4CAiBC;AAED,SAAgB,cAAc,CAAC,GAAG,GAAG,EAAE;IACrC,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,UAAU,CAAC,CAAA;IACvD,MAAM,MAAM,GAAsC,EAAE,CAAA;IACpD,KAAK,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAVD,wCAUC;AAED,SAAgB,aAAa,CAC3B,IAAY,EACZ,GAAoC,EACpC,GAAoB,EACpB,IAAe,EACf,QAAkB;IAElB,sBAAsB;IACtB,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAC/B,IAAI,UAAU,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,2BAAmB,CAC3B,oDAAoD,CACrD,CAAA;IACH,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACzB,OAAM;IACR,CAAC;IACD,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QAC7B,MAAM,IAAI,2BAAmB,CAC3B,kDAAkD,CACnD,CAAA;IACH,CAAC;IAED,WAAW;IACX,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAA;IACtE,IACE,GAAG,CAAC,KAAK,EAAE,QAAQ;QACnB,CAAC,CAAC,aAAa,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,EACxE,CAAC;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,2BAAmB,CAC3B,2DAA2D,CAC5D,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,2BAAmB,CAC3B,0CAA0C,aAAa,EAAE,CAC1D,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,gBAAgB;QAChB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,4BAA4B;IAC5B,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACtB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,mBAAS,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAA;YACzD,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACzD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,2BAAmB,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,qDAAqD;IACrD,IAAI,IAAI,CAAA;IACR,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;QACtB,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;IACjB,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC9C,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,aAAa;QACvB,IAAI;KACL,CAAA;AACH,CAAC;AApED,sCAoEC;AAED,SAAgB,cAAc,CAC5B,IAAY,EACZ,GAAoC,EACpC,MAAkC,EAClC,QAAkB;IAElB,qBAAqB;IACrB,IAAI,MAAM,EAAE,CAAC;QACX,sBAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC9B,CAAC;IAED,uBAAuB;IACvB,IAAI,MAAM,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QAChC,MAAM,IAAI,2BAAmB,CAC3B,qDAAqD,CACtD,CAAA;IACH,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChC,MAAM,IAAI,2BAAmB,CAC3B,mDAAmD,CACpD,CAAA;IACH,CAAC;IAED,WAAW;IACX,IACE,GAAG,CAAC,MAAM,EAAE,QAAQ;QACpB,CAAC,CAAC,MAAM,EAAE,QAAQ;YAChB,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,EAC3D,CAAC;QACD,MAAM,IAAI,2BAAmB,CAC3B,8BAA8B,MAAM,EAAE,QAAQ,EAAE,CACjD,CAAA;IACH,CAAC;IAED,gBAAgB;IAChB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;YACjE,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,IAAI,GAAG,MAAM,CAAA;YACtB,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,2BAAmB,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AA/CD,wCA+CC;AAED,SAAgB,aAAa,CAAC,CAAS;IACrC,IAAI,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACpB,MAAM,QAAQ,GAAG,oBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;IACpC,IAAI,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,SAAS;QAAE,OAAO,KAAK,CAAA;IAC5B,OAAO,SAAS,CAAA;AAClB,CAAC;AAPD,sCAOC;AAED,SAAS,eAAe,CAAC,WAAmB,EAAE,KAAa;IACzD,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAC5D,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;IACvC,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAC7B,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACzC,OAAO,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;AACtC,CAAC;AAED,SAAgB,OAAO,CAAC,GAAoB;IAC1C,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;IACnD,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;IACzD,OAAO,CAAC,aAAa,IAAI,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,gBAAgB,CAAA;AAC/E,CAAC;AAJD,0BAIC;AAED,SAAgB,kBAAkB,CAAC,GAAoB;IACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAC7C,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACrE,CAAC,CAAC,CAAA;AACJ,CAAC;AAND,gDAMC;AAED,SAAS,gBAAgB,CACvB,GAAoB,EACpB,OAA2B;IAE3B,IAAI,MAAM,GAAa,GAAG,CAAA;IAC1B,MAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACvD,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAEnD,IACE,OAAO,KAAK,SAAS;QACrB,aAAa;QACb,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,OAAO,EACrC,CAAC;QACD,MAAM,IAAI,iBAAS,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAA;IACtD,CAAC;IAED,IAAI,OAA8B,CAAA;IAClC,IAAI,eAAe,KAAK,MAAM,EAAE,CAAC;QAC/B,OAAO,GAAG,IAAA,mBAAY,GAAE,CAAA;IAC1B,CAAC;SAAM,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO,GAAG,IAAA,oBAAa,GAAE,CAAA;IAC3B,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,IAAA,4BAAmB,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACpC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC/B,CAAC;IAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,cAAc,GAAG,IAAI,uBAAc,CACvC,OAAO,EACP,GAAG,EAAE,CAAC,IAAI,iBAAS,CAAC,GAAG,EAAE,0BAA0B,CAAC,CACrD,CAAA;QACD,IAAA,4BAAmB,EAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC3C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACtC,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAgB,kBAAkB,CAAC,OAAuB;IACxD,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACd,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAA;QACxB,IAAI,MAAM,CAAC,QAAQ;YAAE,MAAM,IAAI,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAA;QACxD,IAAI,MAAM,CAAC,WAAW;YAAE,MAAM,IAAI,UAAU,MAAM,CAAC,WAAW,GAAG,CAAA;QACjE,OAAO,MAAM,CAAA;IACf,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC;AATD,gDASC;AAED,MAAa,WAAW;IAGtB,YACS,IAAY,EACZ,WAAoB;QAD3B;;;;mBAAO,IAAI;WAAQ;QACnB;;;;mBAAO,WAAW;WAAS;QAJtB;;;;;WAAiB;QAChB;;;;;WAAgB;IAIrB,CAAC;IACJ,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI;QACF,IAAA,gBAAM,EAAC,IAAI,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAA;QACjD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAhBD,kCAgBC"}

package/jest.config.js

@@ -1,6 +1,7 @@
-const base = require('../../jest.config.base.js')
-
+/** @type {import('jest').Config} */
 module.exports = {
-  ...base,
   displayName: 'XRPC Server',
+  transform: { '^.+\\.(t|j)s$': '@swc/jest' },
+  transformIgnorePatterns: [`<rootDir>/node_modules/(?!get-port)`],
+  setupFiles: ['<rootDir>/../../jest.setup.ts'],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/xrpc-server",
-  "version": "0.4.4",
+  "version": "0.5.1",
   "license": "MIT",
   "description": "atproto HTTP API (XRPC) server library",
   "keywords": [
@@ -14,6 +14,7 @@
     "directory": "packages/xrpc-server"
   },
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "dependencies": {
     "cbor-x": "^1.5.1",
     "express": "^4.17.2",
@@ -23,9 +24,9 @@
     "uint8arrays": "3.0.0",
     "ws": "^8.12.0",
     "zod": "^3.21.4",
-    "@atproto/common": "^0.3.4",
-    "@atproto/crypto": "^0.3.0",
-    "@atproto/lexicon": "^0.3.3"
+    "@atproto/common": "^0.4.0",
+    "@atproto/crypto": "^0.4.0",
+    "@atproto/lexicon": "^0.4.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
@@ -34,16 +35,14 @@
     "@types/ws": "^8.5.4",
     "get-port": "^6.1.2",
     "jose": "^4.15.4",
+    "jest": "^28.1.2",
     "key-encoder": "^2.0.3",
     "multiformats": "^9.9.0",
-    "@atproto/crypto": "^0.3.0",
-    "@atproto/xrpc": "^0.4.3"
+    "@atproto/crypto": "^0.4.0",
+    "@atproto/xrpc": "^0.5.0"
   },
   "scripts": {
     "test": "jest",
-    "build": "node ./build.js",
-    "postbuild": "tsc --build tsconfig.build.json",
-    "update-main-to-dist": "node ../../update-main-to-dist.js packages/xrpc-server"
-  },
-  "types": "dist/index.d.ts"
+    "build": "tsc --build tsconfig.build.json"
+  }
 }

package/src/server.ts

@@ -1,5 +1,10 @@
 import { Readable } from 'stream'
 import express, {
+  Application,
+  Express,
+  Router,
+  Request,
+  Response,
   ErrorRequestHandler,
   NextFunction,
   RequestHandler,
@@ -37,7 +42,6 @@ import {
   isShared,
   RateLimitExceededError,
   HandlerPipeThrough,
-  handlerPipeThrough,
 } from './types'
 import {
   decodeQueryParams,
@@ -53,8 +57,8 @@ export function createServer(lexicons?: LexiconDoc[], options?: Options) {
 }
 
 export class Server {
-  router = express()
-  routes = express.Router()
+  router: Express = express()
+  routes: Router = express.Router()
   subscriptions = new Map<string, XrpcStreamServer>()
   lex = new Lexicons()
   options: Options
@@ -68,9 +72,12 @@ export class Server {
       this.addLexicons(lexicons)
     }
     this.router.use(this.routes)
-    this.router.use('/xrpc/:methodId', this.catchall.bind(this))
+    this.router.use(
+      '/xrpc/:methodId',
+      opts?.catchall ?? this.catchall.bind(this),
+    )
     this.router.use(errorMiddleware)
-    this.router.once('mount', (app: express.Application) => {
+    this.router.once('mount', (app: Application) => {
       this.enableStreamingOnListen(app)
     })
     this.options = opts ?? {}
@@ -179,11 +186,7 @@ export class Server {
     )
   }
 
-  async catchall(
-    req: express.Request,
-    _res: express.Response,
-    next: NextFunction,
-  ) {
+  async catchall(req: Request, _res: Response, next: NextFunction) {
     const def = this.lex.getDef(req.params.methodId)
     if (!def) {
       return next(new MethodNotImplementedError())
@@ -213,7 +216,7 @@ export class Server {
     const routeOpts = {
       blobLimit: routeCfg.opts?.blobLimit ?? this.options.payload?.blobLimit,
     }
-    const validateReqInput = (req: express.Request) =>
+    const validateReqInput = (req: Request) =>
       validateInput(nsid, def, req, routeOpts, this.lex)
     const validateResOutput =
       this.options.validateResponse === false
@@ -390,7 +393,7 @@ export class Server {
     )
   }
 
-  private enableStreamingOnListen(app: express.Application) {
+  private enableStreamingOnListen(app: Application) {
     const _listen = app.listen
     app.listen = (...args) => {
       // @ts-ignore the args spread

package/src/stream/frames.ts

@@ -11,7 +11,7 @@ import {
 } from './types'
 
 export abstract class Frame {
-  header: FrameHeader
+  abstract header: FrameHeader
   body: unknown
   get op(): FrameType {
     return this.header.op

package/src/stream/websocket-keepalive.ts

@@ -80,7 +80,7 @@ export class WebSocketKeepAlive {
 
   startHeartbeat(ws: WebSocket) {
     let isAlive = true
-    let heartbeatInterval: NodeJS.Timer | null = null
+    let heartbeatInterval: NodeJS.Timeout | null = null
 
     const checkAlive = () => {
       if (!isAlive) {
@@ -145,6 +145,7 @@ function forwardSignal(signal: AbortSignal, ac: AbortController) {
     return ac.abort(signal.reason)
   } else {
     signal.addEventListener('abort', () => ac.abort(signal.reason), {
+      // @ts-ignore https://github.com/DefinitelyTyped/DefinitelyTyped/pull/68625
       signal: ac.signal,
     })
   }

package/src/types.ts

@@ -8,8 +8,15 @@ import {
   ResponseTypeNames,
 } from '@atproto/xrpc'
 
+export type CatchallHandler = (
+  req: express.Request,
+  _res: express.Response,
+  next: express.NextFunction,
+) => unknown
+
 export type Options = {
   validateResponse?: boolean
+  catchall?: CatchallHandler
   payload?: {
     jsonLimit?: number
     blobLimit?: number
@@ -22,7 +29,7 @@ export type Options = {
   }
 }
 
-export type UndecodedParams = typeof express.request['query']
+export type UndecodedParams = (typeof express.request)['query']
 
 export type Primitive = string | number | boolean
 export type Params = Record<string, Primitive | Primitive[] | undefined>

package/src/util.ts

@@ -33,7 +33,7 @@ export function decodeQueryParams(
     const property = def.parameters?.properties?.[k]
     if (property) {
       if (property.type === 'array') {
-        const vals: typeof val[] = []
+        const vals: (typeof val)[] = []
         decoded[k] = val
           ? vals
               .concat(val) // Cast to array
@@ -282,7 +282,10 @@ export function serverTimingHeader(timings: ServerTiming[]) {
 export class ServerTimer implements ServerTiming {
   public duration?: number
   private startMs?: number
-  constructor(public name: string, public description?: string) {}
+  constructor(
+    public name: string,
+    public description?: string,
+  ) {}
   start() {
     this.startMs = Date.now()
     return this