The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
import { OAUTH_SCOPES } from "@/lib/api/oauth/constants";
import { document } from "@/lib/openapi";
import { getMcpDocument } from "@/lib/openapi/mcp-document";
import { describe, expect, test, vi } from "vitest";
vi.mock("server-only", () => ({}));
describe("getMcpDocument", () => {
test("adds the OAuth security scheme with every OAuth scope", () => {
const { components } = getMcpDocument();
expect(components?.securitySchemes?.token).toEqual(
document.components?.securitySchemes?.token,
);
expect(components?.securitySchemes?.oauth).toMatchObject({
type: "oauth2",
flows: {
authorizationCode: {
authorizationUrl: "https://app.dub.co/oauth/authorize",
tokenUrl: "https://api.dub.co/oauth/token",
},
},
});
expect(
Object.keys(
(components?.securitySchemes?.oauth as any).flows.authorizationCode
.scopes,
),
).toEqual([...OAUTH_SCOPES]);
});
test("accepts either the API key or OAuth at the document level", () => {
expect(getMcpDocument().security).toEqual([{ token: [] }, { oauth: [] }]);
});
test("lets authenticated operations inherit the document security rule", () => {
const operations = Object.values(getMcpDocument().paths ?? {}).flatMap(
(pathItem) =>
(["get", "put", "post", "delete", "patch"] as const).flatMap(
(method) => pathItem?.[method] ?? [],
),
);
for (const operation of operations) {
if (["trackOpen", "getQRCode"].includes(operation.operationId ?? "")) {
expect(operation.security).toEqual([]);
continue;
}
expect(operation.security).toBeUndefined();
}
});
test("does not mutate the default document", () => {
const snapshot = structuredClone(document);
getMcpDocument();
expect(document).toEqual(snapshot);
});
});