fumadocs-openapi 9.0.3 → 9.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,9 +4,24 @@ type Proxy = {
4
4
  [K in (typeof keys)[number]]: (req: NextRequest) => Promise<Response>;
5
5
  };
6
6
  interface CreateProxyOptions {
7
+ /**
8
+ * Filter by prefixes of request url
9
+ *
10
+ * @deprecated Use `allowedOrigins` for filtering origins, or `filterRequest` for more detailed rules.
11
+ */
7
12
  allowedUrls?: string[];
8
13
  /**
9
- * Override original request/response with yours
14
+ * List of allowed origins to proxy to.
15
+ */
16
+ allowedOrigins?: string[];
17
+ /**
18
+ * Determine if the proxied request is allowed.
19
+ *
20
+ * @returns true if allowed, otherwise forbidden.
21
+ */
22
+ filterRequest?: (request: Request) => boolean;
23
+ /**
24
+ * Override proxied request/response with yours
10
25
  */
11
26
  overrides?: {
12
27
  request?: (request: Request) => Request;
@@ -1 +1 @@
1
- {"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../src/server/proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,QAAA,MAAM,IAAI,4DAA6D,CAAC;AAExE,KAAK,KAAK,GAAG;KACV,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;CACtE,CAAC;AAEF,UAAU,kBAAkB;IAC1B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;QACxC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC;KAC7C,CAAC;CACH;AAED,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,KAAK,CA8EnE"}
1
+ {"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../src/server/proxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,QAAA,MAAM,IAAI,4DAA6D,CAAC;AAExE,KAAK,KAAK,GAAG;KACV,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;CACtE,CAAC;AAEF,UAAU,kBAAkB;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;IAE9C;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;QACxC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,QAAQ,CAAC;KAC7C,CAAC;CACH;AAED,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,KAAK,CAmGnE"}
@@ -1,39 +1,53 @@
1
1
  const keys = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD'];
2
2
  export function createProxy(options = {}) {
3
- const { allowedUrls, overrides } = options;
3
+ const { allowedOrigins, allowedUrls, filterRequest = (req) => {
4
+ return (!allowedUrls || allowedUrls.some((item) => req.url.startsWith(item)));
5
+ }, overrides, } = options;
4
6
  const handlers = {};
5
7
  async function handler(req) {
6
8
  const url = req.nextUrl.searchParams.get('url');
7
9
  if (!url) {
8
- return Response.json('A `url` query parameter is required for proxy url', {
10
+ return Response.json('[Proxy] A `url` query parameter is required for proxy url', {
9
11
  status: 400,
10
12
  });
11
13
  }
12
- if (allowedUrls &&
13
- allowedUrls.every((allowedUrl) => !allowedUrl.startsWith(url))) {
14
- return Response.json('The given `url` query parameter is not allowed', {
14
+ let parsedUrl;
15
+ try {
16
+ parsedUrl = new URL(url);
17
+ }
18
+ catch {
19
+ return Response.json('[Proxy] Invalid `url` parameter value.', {
20
+ status: 400,
21
+ });
22
+ }
23
+ if (allowedOrigins && !allowedOrigins.includes(parsedUrl.origin)) {
24
+ return Response.json(`[Proxy] The origin "${parsedUrl.origin}" is not allowed.`, {
15
25
  status: 400,
16
26
  });
17
27
  }
18
- let clonedReq = new Request(url, {
28
+ let proxied = new Request(parsedUrl, {
19
29
  ...req,
20
30
  cache: 'no-cache',
21
31
  mode: 'cors',
22
32
  });
23
33
  if (overrides?.request) {
24
- clonedReq = overrides.request(clonedReq);
34
+ proxied = overrides.request(proxied);
25
35
  }
26
- clonedReq.headers.forEach((_value, originalKey) => {
36
+ if (!filterRequest(proxied)) {
37
+ return Response.json('[Proxy] The proxied request is not allowed', {
38
+ status: 403,
39
+ });
40
+ }
41
+ proxied.headers.forEach((_value, originalKey) => {
27
42
  const key = originalKey.toLowerCase();
28
- const notAllowed = key === 'origin';
29
- if (notAllowed) {
30
- clonedReq.headers.delete(originalKey);
43
+ if (key === 'origin') {
44
+ proxied.headers.delete(originalKey);
31
45
  }
32
46
  });
33
- let res = await fetch(clonedReq).catch((e) => new Error(e.toString()));
47
+ let res = await fetch(proxied).catch((e) => new Error(e.toString()));
34
48
  if (res instanceof Error) {
35
- return Response.json(`Failed to proxy request: ${res.message}`, {
36
- status: 400,
49
+ return Response.json(`[Proxy] Failed to proxy request: ${res.message}`, {
50
+ status: 500,
37
51
  });
38
52
  }
39
53
  if (overrides?.response) {
@@ -42,14 +56,14 @@ export function createProxy(options = {}) {
42
56
  const headers = new Headers(res.headers);
43
57
  headers.forEach((_value, originalKey) => {
44
58
  const key = originalKey.toLowerCase();
45
- const notAllowed = key.startsWith('access-control-') || key === 'content-encoding';
46
- if (notAllowed) {
59
+ if (key.startsWith('access-control-') || key === 'content-encoding') {
47
60
  headers.delete(originalKey);
48
61
  }
49
62
  });
50
63
  headers.set('X-Forwarded-Host', res.url);
51
64
  return new Response(res.body, {
52
- ...res,
65
+ status: res.status,
66
+ statusText: res.statusText,
53
67
  headers,
54
68
  });
55
69
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fumadocs-openapi",
3
- "version": "9.0.3",
3
+ "version": "9.0.4",
4
4
  "description": "Generate MDX docs for your OpenAPI spec",
5
5
  "keywords": [
6
6
  "NextJs",