fumadocs-openapi 10.8.4 → 10.8.6

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.
Files changed (138) hide show
  1. package/css/generated/shared.css +22 -1
  2. package/dist/generate-file.d.ts +1 -1
  3. package/dist/generate-file.js +1 -1
  4. package/dist/index.d.ts +2 -2
  5. package/dist/node_modules/.pnpm/{@scalar_helpers@0.6.0 → @scalar_helpers@0.8.0}/node_modules/@scalar/helpers/dist/general/create-limiter.js +1 -1
  6. package/dist/node_modules/.pnpm/{@scalar_helpers@0.6.0 → @scalar_helpers@0.8.0}/node_modules/@scalar/helpers/dist/object/is-object.js +1 -1
  7. package/dist/node_modules/.pnpm/{@scalar_helpers@0.6.0 → @scalar_helpers@0.8.0}/node_modules/@scalar/helpers/dist/object/prevent-pollution.js +1 -1
  8. package/dist/node_modules/.pnpm/{@scalar_helpers@0.6.0 → @scalar_helpers@0.8.0}/node_modules/@scalar/helpers/dist/queue/queue.js +1 -1
  9. package/dist/node_modules/.pnpm/{@scalar_helpers@0.6.0 → @scalar_helpers@0.8.0}/node_modules/@scalar/helpers/dist/string/generate-hash.js +1 -1
  10. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/bundle/bundle.js +2 -2
  11. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/bundle/plugins/fetch-urls/index.js +2 -2
  12. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/bundle/plugins/read-files/index.js +1 -1
  13. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/bundle/value-generator.js +2 -2
  14. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/convert-to-local-ref.js +1 -1
  15. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/escape-json-pointer.js +1 -1
  16. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/get-schemas.js +1 -1
  17. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/get-segments-from-path.js +1 -1
  18. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/get-value-by-path.js +1 -1
  19. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/is-file-path.js +1 -1
  20. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/is-http-url.js +1 -1
  21. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/is-json-object.js +2 -2
  22. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/is-yaml.js +1 -1
  23. package/dist/node_modules/.pnpm/@scalar_json-magic@0.12.14/node_modules/@scalar/json-magic/dist/helpers/normalize.js +33 -0
  24. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/resolve-reference-path.js +1 -1
  25. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/set-value-at-path.js +2 -2
  26. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/to-relative-path.js +1 -1
  27. package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/helpers/unescape-json-pointer.js +1 -1
  28. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/2020.js +110 -0
  29. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/codegen/code.js +138 -0
  30. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/codegen/index.js +674 -0
  31. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/codegen/scope.js +141 -0
  32. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/errors.js +102 -0
  33. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/index.js +223 -0
  34. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/names.js +28 -0
  35. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/ref_error.js +18 -0
  36. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/resolve.js +133 -0
  37. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/rules.js +61 -0
  38. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/util.js +146 -0
  39. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/applicability.js +23 -0
  40. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/boolSchema.js +48 -0
  41. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/dataType.js +172 -0
  42. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/defaults.js +31 -0
  43. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/index.js +433 -0
  44. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/keyword.js +113 -0
  45. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/compile/validate/subschema.js +72 -0
  46. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/core.js +583 -0
  47. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/data.js +18 -0
  48. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/index.js +42 -0
  49. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/applicator.js +50 -0
  50. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/content.js +20 -0
  51. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/core.js +51 -0
  52. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/format-annotation.js +16 -0
  53. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/meta-data.js +36 -0
  54. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/unevaluated.js +19 -0
  55. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/meta/validation.js +85 -0
  56. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/refs/json-schema-2020-12/schema.js +59 -0
  57. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/runtime/equal.js +12 -0
  58. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/runtime/ucs2length.js +25 -0
  59. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/runtime/uri.js +12 -0
  60. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/runtime/validation_error.js +16 -0
  61. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/additionalItems.js +57 -0
  62. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/additionalProperties.js +96 -0
  63. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/allOf.js +29 -0
  64. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/anyOf.js +16 -0
  65. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/contains.js +89 -0
  66. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/dependencies.js +87 -0
  67. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/dependentSchemas.js +16 -0
  68. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/if.js +62 -0
  69. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/index.js +60 -0
  70. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/items.js +59 -0
  71. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/items2020.js +34 -0
  72. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/not.js +31 -0
  73. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/oneOf.js +51 -0
  74. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/patternProperties.js +61 -0
  75. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/prefixItems.js +17 -0
  76. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/properties.js +52 -0
  77. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/propertyNames.js +41 -0
  78. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/applicator/thenElse.js +17 -0
  79. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/code.js +130 -0
  80. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/core/id.js +14 -0
  81. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/core/index.js +22 -0
  82. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/core/ref.js +112 -0
  83. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/discriminator/index.js +101 -0
  84. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/discriminator/types.js +14 -0
  85. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/draft2020.js +35 -0
  86. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/dynamic/dynamicAnchor.js +46 -0
  87. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/dynamic/dynamicRef.js +45 -0
  88. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/dynamic/index.js +22 -0
  89. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/dynamic/recursiveAnchor.js +20 -0
  90. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/dynamic/recursiveRef.js +15 -0
  91. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/format/format.js +92 -0
  92. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/format/index.js +10 -0
  93. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/metadata.js +23 -0
  94. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/next.js +19 -0
  95. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/unevaluated/index.js +13 -0
  96. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/unevaluated/unevaluatedItems.js +46 -0
  97. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/unevaluated/unevaluatedProperties.js +59 -0
  98. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/const.js +27 -0
  99. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/dependentRequired.js +17 -0
  100. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/enum.js +49 -0
  101. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/index.js +48 -0
  102. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/limitContains.js +18 -0
  103. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/limitItems.js +28 -0
  104. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/limitLength.js +33 -0
  105. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/limitNumber.js +47 -0
  106. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/limitProperties.js +28 -0
  107. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/multipleOf.js +27 -0
  108. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/pattern.js +38 -0
  109. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/required.js +72 -0
  110. package/dist/node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/vocabularies/validation/uniqueItems.js +70 -0
  111. package/dist/node_modules/.pnpm/fast-deep-equal@3.1.3/node_modules/fast-deep-equal/index.js +33 -0
  112. package/dist/node_modules/.pnpm/fast-uri@3.1.0/node_modules/fast-uri/index.js +236 -0
  113. package/dist/node_modules/.pnpm/fast-uri@3.1.0/node_modules/fast-uri/lib/schemes.js +187 -0
  114. package/dist/node_modules/.pnpm/fast-uri@3.1.0/node_modules/fast-uri/lib/utils.js +282 -0
  115. package/dist/node_modules/.pnpm/json-schema-traverse@1.0.0/node_modules/json-schema-traverse/index.js +78 -0
  116. package/dist/playground/client.js +1 -1
  117. package/dist/playground/schema.d.ts +0 -2
  118. package/dist/playground/schema.js +3 -2
  119. package/dist/server/index.d.ts +108 -3
  120. package/dist/server/index.js +181 -2
  121. package/dist/server/proxy.d.ts +1 -1
  122. package/dist/types.d.ts +1 -1
  123. package/dist/ui/base.d.ts +1 -1
  124. package/dist/ui/components/method-label.js +1 -4
  125. package/dist/ui/index.d.ts +1 -1
  126. package/dist/utils/document/process.js +4 -4
  127. package/dist/utils/pages/builder.d.ts +4 -3
  128. package/dist/utils/pages/builder.js +20 -1
  129. package/dist/utils/pages/to-text.d.ts +1 -1
  130. package/dist/utils/pages/to-text.js +23 -42
  131. package/package.json +12 -8
  132. package/dist/node_modules/.pnpm/@scalar_json-magic@0.12.12/node_modules/@scalar/json-magic/dist/helpers/normalize.js +0 -26
  133. package/dist/server/create.d.ts +0 -40
  134. package/dist/server/create.js +0 -42
  135. package/dist/server/source-api.d.ts +0 -55
  136. package/dist/server/source-api.js +0 -149
  137. /package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/bundle/plugins/node.js +0 -0
  138. /package/dist/node_modules/.pnpm/{@scalar_json-magic@0.12.12 → @scalar_json-magic@0.12.14}/node_modules/@scalar/json-magic/dist/bundle/plugins/parse-yaml/index.js +0 -0
@@ -31,4 +31,4 @@ interface CreateProxyOptions {
31
31
  }
32
32
  declare function createProxy(options?: CreateProxyOptions): Proxy;
33
33
  //#endregion
34
- export { createProxy };
34
+ export { CreateProxyOptions, Proxy, createProxy };
package/dist/types.d.ts CHANGED
@@ -2,8 +2,8 @@ import { MediaAdapter } from "./requests/media/adapter.js";
2
2
  import { InlineCodeUsageGenerator } from "./requests/generators/index.js";
3
3
  import { boundary_d_exports } from "./ui/client/boundary.js";
4
4
  import { OpenAPIV3, OpenAPIV3_2 } from "./_openapi/types.js";
5
- import { OpenAPIOptions } from "./server/create.js";
6
5
  import { CreateAPIPageOptions } from "./ui/base.js";
6
+ import { OpenAPIOptions } from "./server/index.js";
7
7
  import { NoReference } from "./utils/schema/index.js";
8
8
  import { DereferencedDocument } from "./utils/document/dereference.js";
9
9
  import { HTMLAttributes, ReactNode } from "react";
package/dist/ui/base.d.ts CHANGED
@@ -3,11 +3,11 @@ import { CodeUsageGeneratorRegistry, InlineCodeUsageGenerator } from "../request
3
3
  import { ExampleRequestItem } from "./operation/get-example-requests.js";
4
4
  import { APIPageClientOptions } from "./client/index.js";
5
5
  import { SchemaUIOptions } from "./schema/index.js";
6
- import { OpenAPIServer } from "../server/create.js";
7
6
  import { ApiPageProps, OperationItem, WebhookItem } from "./api-page.js";
8
7
  import { ResponseTab } from "./operation/response-tabs.js";
9
8
  import { RequestTabsRenderContext } from "./operation/request-tabs.js";
10
9
  import { ClientCodeBlockProvider } from "./components/codeblock.js";
10
+ import { OpenAPIServer } from "../server/index.js";
11
11
  import { Awaitable, MethodInformation, RenderContext } from "../types.js";
12
12
  import { NoReference } from "../utils/schema/index.js";
13
13
  import { DereferencedDocument } from "../utils/document/dereference.js";
@@ -20,10 +20,7 @@ function getMethodColor(method) {
20
20
  }
21
21
  function Badge({ className, color, ...props }) {
22
22
  return /* @__PURE__ */ jsx("span", {
23
- className: cn(badgeVariants({
24
- color,
25
- className
26
- })),
23
+ className: cn(badgeVariants({ color }), className),
27
24
  ...props,
28
25
  children: props.children
29
26
  });
@@ -1,6 +1,6 @@
1
- import { OpenAPIServer } from "../server/create.js";
2
1
  import { ApiPageProps, OperationItem, WebhookItem } from "./api-page.js";
3
2
  import { CreateAPIPageOptions as CreateAPIPageOptions$1, ServerApiPageProps } from "./base.js";
3
+ import { OpenAPIServer } from "../server/index.js";
4
4
  import * as _$react_jsx_runtime0 from "react/jsx-runtime";
5
5
 
6
6
  //#region src/ui/index.d.ts
@@ -1,8 +1,8 @@
1
- import { bundle } from "../../node_modules/.pnpm/@scalar_json-magic@0.12.12/node_modules/@scalar/json-magic/dist/bundle/bundle.js";
1
+ import { bundle } from "../../node_modules/.pnpm/@scalar_json-magic@0.12.14/node_modules/@scalar/json-magic/dist/bundle/bundle.js";
2
2
  import { upgrade } from "../../node_modules/.pnpm/@scalar_openapi-upgrader@0.2.7/node_modules/@scalar/openapi-upgrader/dist/upgrade.js";
3
- import { fetchUrls } from "../../node_modules/.pnpm/@scalar_json-magic@0.12.12/node_modules/@scalar/json-magic/dist/bundle/plugins/fetch-urls/index.js";
4
- import { readFiles } from "../../node_modules/.pnpm/@scalar_json-magic@0.12.12/node_modules/@scalar/json-magic/dist/bundle/plugins/read-files/index.js";
5
- import "../../node_modules/.pnpm/@scalar_json-magic@0.12.12/node_modules/@scalar/json-magic/dist/bundle/plugins/node.js";
3
+ import { fetchUrls } from "../../node_modules/.pnpm/@scalar_json-magic@0.12.14/node_modules/@scalar/json-magic/dist/bundle/plugins/fetch-urls/index.js";
4
+ import { readFiles } from "../../node_modules/.pnpm/@scalar_json-magic@0.12.14/node_modules/@scalar/json-magic/dist/bundle/plugins/read-files/index.js";
5
+ import "../../node_modules/.pnpm/@scalar_json-magic@0.12.14/node_modules/@scalar/json-magic/dist/bundle/plugins/node.js";
6
6
  import { dereferenceDocument } from "./dereference.js";
7
7
  //#region src/utils/document/process.ts
8
8
  /**
@@ -1,5 +1,5 @@
1
- import { OpenAPIServer } from "../../server/create.js";
2
- import { OperationItem, WebhookItem } from "../../ui/api-page.js";
1
+ import { ApiPageProps, OperationItem, WebhookItem } from "../../ui/api-page.js";
2
+ import { OpenAPIServer } from "../../server/index.js";
3
3
  import { OperationObject, PathItemObject, TagObject } from "../../types.js";
4
4
  import { NoReference } from "../schema/index.js";
5
5
  import { DereferencedDocument } from "../document/dereference.js";
@@ -85,5 +85,6 @@ interface ExtractedInfo {
85
85
  }
86
86
  declare function fromServer(server: OpenAPIServer, config: PagesBuilderConfig): Promise<Record<string, OutputEntry[]>>;
87
87
  declare function fromSchema(schemaId: string, processed: DereferencedDocument, config: PagesBuilderConfig): OutputEntry[];
88
+ declare function getPageProps(entry: PageOutput | OperationOutput | WebhookOutput): ApiPageProps;
88
89
  //#endregion
89
- export { OperationOutput, OutputEntry, OutputGroup, PageOutput, PagesBuilder, PagesBuilderConfig, WebhookOutput, fromSchema, fromServer };
90
+ export { OperationOutput, OutputEntry, OutputGroup, PageOutput, PagesBuilder, PagesBuilderConfig, WebhookOutput, fromSchema, fromServer, getPageProps };
@@ -97,5 +97,24 @@ function fromSchema(schemaId, processed, config) {
97
97
  });
98
98
  return files;
99
99
  }
100
+ function getPageProps(entry) {
101
+ if (entry.type === "operation") return {
102
+ document: entry.schemaId,
103
+ operations: [entry.item],
104
+ showDescription: true
105
+ };
106
+ if (entry.type === "webhook") return {
107
+ document: entry.schemaId,
108
+ webhooks: [entry.item],
109
+ showDescription: true
110
+ };
111
+ return {
112
+ showTitle: true,
113
+ showDescription: true,
114
+ document: entry.schemaId,
115
+ operations: entry.operations,
116
+ webhooks: entry.webhooks
117
+ };
118
+ }
100
119
  //#endregion
101
- export { fromSchema, fromServer };
120
+ export { fromSchema, fromServer, getPageProps };
@@ -17,7 +17,7 @@ interface PagesToTextOptions {
17
17
  /**
18
18
  * Add description to document body.
19
19
  *
20
- * We recommend but don't enable it by default because some OpenAPI schemas have invalid description that breaks MDX syntax.
20
+ * We recommend to enable it, it is disabled by default because some OpenAPI schemas have invalid description that breaks Markdown syntax.
21
21
  *
22
22
  * @defaultValue false
23
23
  */
@@ -1,58 +1,24 @@
1
1
  import { removeUndefined } from "../remove-undefined.js";
2
+ import { getPageProps } from "./builder.js";
2
3
  import { toStaticData } from "./to-static-data.js";
3
4
  import { doubleQuote } from "../../requests/string-utils.js";
4
5
  import { dump } from "js-yaml";
5
6
  //#region src/utils/pages/to-text.ts
6
7
  function toText(entry, processed, options = {}) {
7
- switch (entry.type) {
8
- case "operation": return generatePage(entry.schemaId, processed, { operations: [entry.item] }, options, entry);
9
- case "page": return generatePage(entry.schemaId, processed, {
10
- operations: entry.operations,
11
- webhooks: entry.webhooks,
12
- showTitle: true
13
- }, options, entry);
14
- case "webhook": return generatePage(entry.schemaId, processed, { webhooks: [entry.item] }, options, entry);
15
- }
16
- }
17
- function generateDocument(frontmatter, content, options) {
18
- const { addGeneratedComment = true, imports } = options;
19
- const out = [];
20
- const banner = dump(removeUndefined(frontmatter)).trimEnd();
21
- if (banner.length > 0) out.push(`---\n${banner}\n---`);
22
- if (addGeneratedComment) {
23
- let commentContent = "This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again.";
24
- if (typeof addGeneratedComment === "string") commentContent = addGeneratedComment;
25
- commentContent = commentContent.replaceAll("/", "\\/");
26
- out.push(`{/* ${commentContent} */}`);
27
- }
28
- if (imports) out.push(...imports.map((item) => `import { ${item.names.join(", ")} } from ${doubleQuote(item.from)};`).join("\n"));
29
- out.push(content);
30
- return out.join("\n\n");
31
- }
32
- function generatePage(schemaId, processed, pageProps, options, entry) {
33
8
  const { frontmatter, includeDescription = false } = options;
34
9
  const extend = frontmatter?.(entry.info.title, entry.info.description, entry.type === "page" ? entry.tag ? {
35
10
  type: "tag",
36
11
  tag: entry.tag
37
12
  } : { type: "file" } : { type: "operation" });
38
- const page = {
39
- ...pageProps,
40
- document: schemaId
41
- };
13
+ const pageProps = getPageProps(entry);
14
+ if (!includeDescription) pageProps.showDescription = false;
42
15
  let meta;
43
- if (page.operations?.length === 1) meta = {
44
- method: page.operations[0].method.toUpperCase(),
16
+ if (entry.type === "operation" || entry.type === "webhook") meta = {
17
+ method: entry.item.method.toUpperCase(),
18
+ webhook: entry.type === "webhook",
45
19
  deprecated: entry.info.deprecated
46
20
  };
47
- else if (page.webhooks?.length === 1) meta = {
48
- method: page.webhooks[0].method.toUpperCase(),
49
- webhook: true,
50
- deprecated: entry.info.deprecated
51
- };
52
- const data = toStaticData(page, processed.dereferenced);
53
- const content = [];
54
- if (entry.info.description && includeDescription) content.push(entry.info.description);
55
- content.push(pageContent(page));
21
+ const data = toStaticData(pageProps, processed.dereferenced);
56
22
  return generateDocument({
57
23
  title: entry.info.title,
58
24
  description: !includeDescription ? entry.info.description : void 0,
@@ -63,7 +29,22 @@ function generatePage(schemaId, processed, pageProps, options, entry) {
63
29
  ...data,
64
30
  ...extend?._openapi
65
31
  }
66
- }, content.join("\n\n"), options);
32
+ }, pageContent(pageProps), options);
33
+ }
34
+ function generateDocument(frontmatter, content, options) {
35
+ const { addGeneratedComment = true, imports } = options;
36
+ const out = [];
37
+ const banner = dump(removeUndefined(frontmatter)).trimEnd();
38
+ if (banner.length > 0) out.push(`---\n${banner}\n---`);
39
+ if (addGeneratedComment) {
40
+ let commentContent = "This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again.";
41
+ if (typeof addGeneratedComment === "string") commentContent = addGeneratedComment;
42
+ commentContent = commentContent.replaceAll("/", "\\/");
43
+ out.push(`{/* ${commentContent} */}`);
44
+ }
45
+ if (imports) out.push(...imports.map((item) => `import { ${item.names.join(", ")} } from ${doubleQuote(item.from)};`).join("\n"));
46
+ out.push(content);
47
+ return out.join("\n\n");
67
48
  }
68
49
  function pageContent({ showTitle, showDescription, document, webhooks, operations }) {
69
50
  const propStrs = [`document={${doubleQuote(document)}}`];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fumadocs-openapi",
3
- "version": "10.8.4",
3
+ "version": "10.8.6",
4
4
  "description": "Generate MDX docs for your OpenAPI spec",
5
5
  "keywords": [
6
6
  "Docs",
@@ -45,7 +45,6 @@
45
45
  "@radix-ui/react-dialog": "^1.1.15",
46
46
  "@radix-ui/react-select": "^2.2.6",
47
47
  "@radix-ui/react-slot": "^1.2.4",
48
- "ajv": "^8.20.0",
49
48
  "chokidar": "^5.0.0",
50
49
  "class-variance-authority": "^0.7.1",
51
50
  "github-slugger": "^2.0.0",
@@ -61,19 +60,20 @@
61
60
  "devDependencies": {
62
61
  "@fastify/deepmerge": "^3.2.1",
63
62
  "@scalar/api-client-react": "2.0.1",
64
- "@scalar/json-magic": "^0.12.12",
63
+ "@scalar/json-magic": "^0.12.14",
65
64
  "@scalar/openapi-upgrader": "^0.2.7",
66
65
  "@tailwindcss/oxide": "^4.3.0",
67
66
  "@types/js-yaml": "^4.0.9",
68
- "@types/node": "25.7.0",
67
+ "@types/node": "25.8.0",
69
68
  "@types/react": "^19.2.14",
69
+ "ajv": "^8.20.0",
70
70
  "fast-content-type-parse": "^3.0.0",
71
71
  "json-schema-typed": "^8.0.2",
72
72
  "tailwindcss": "^4.3.0",
73
73
  "tsdown": "0.22.0",
74
74
  "xml-js": "^1.6.11",
75
- "fumadocs-ui": "16.8.11",
76
- "fumadocs-core": "16.8.11",
75
+ "fumadocs-core": "16.8.12",
76
+ "fumadocs-ui": "16.8.12",
77
77
  "tsconfig": "0.0.0"
78
78
  },
79
79
  "peerDependencies": {
@@ -98,10 +98,14 @@
98
98
  },
99
99
  "inlinedDependencies": {
100
100
  "@fastify/deepmerge": "3.2.1",
101
- "@scalar/helpers": "0.6.0",
102
- "@scalar/json-magic": "0.12.12",
101
+ "@scalar/helpers": "0.8.0",
102
+ "@scalar/json-magic": "0.12.14",
103
103
  "@scalar/openapi-upgrader": "0.2.7",
104
+ "ajv": "8.20.0",
104
105
  "fast-content-type-parse": "3.0.0",
106
+ "fast-deep-equal": "3.1.3",
107
+ "fast-uri": "3.1.0",
108
+ "json-schema-traverse": "1.0.0",
105
109
  "pathe": "2.0.3",
106
110
  "xml-js": "1.6.11",
107
111
  "yaml": "2.9.0"
@@ -1,26 +0,0 @@
1
- import { parse } from "../../../../../../yaml@2.9.0/node_modules/yaml/browser/dist/public-api.js";
2
- import "../../../../../../yaml@2.9.0/node_modules/yaml/browser/index.js";
3
- //#region ../../node_modules/.pnpm/@scalar+json-magic@0.12.12/node_modules/@scalar/json-magic/dist/helpers/normalize.js
4
- /**
5
- * Normalize a string (YAML, JSON, object) to a JavaScript datatype.
6
- */
7
- function normalize(content) {
8
- if (content === null) return;
9
- if (typeof content === "string") {
10
- if (content.trim() === "") return;
11
- try {
12
- return JSON.parse(content);
13
- } catch (_error) {
14
- const hasColon = /^[^:]+:/.test(content);
15
- const isJson = content.slice(0, 50).trimStart().startsWith("{");
16
- if (!hasColon || isJson) return;
17
- return parse(content, {
18
- maxAliasCount: 1e4,
19
- merge: true
20
- });
21
- }
22
- }
23
- return content;
24
- }
25
- //#endregion
26
- export { normalize };
@@ -1,40 +0,0 @@
1
- import { InlineCodeUsageGenerator } from "../requests/generators/index.js";
2
- import { createProxy } from "./proxy.js";
3
- import { ProcessedDocument } from "../utils/document/process.js";
4
- import { Document } from "../types.js";
5
-
6
- //#region src/server/create.d.ts
7
- /**
8
- * schema id -> file path, URL, or downloaded schema object
9
- */
10
- type SchemaMap = Record<string, string | Document>;
11
- type ProcessedSchemaMap = Record<string, ProcessedDocument>;
12
- interface OpenAPIOptions {
13
- /**
14
- * Schema files, can be:
15
- * - URL
16
- * - file path
17
- * - a function returning records of downloaded schemas.
18
- */
19
- input?: string[] | (() => SchemaMap | Promise<SchemaMap>);
20
- disableCache?: boolean;
21
- /**
22
- * The url of proxy to avoid CORS issues
23
- */
24
- proxyUrl?: string;
25
- }
26
- interface OpenAPIServer {
27
- createProxy: typeof createProxy;
28
- getSchemas: () => Promise<ProcessedSchemaMap>;
29
- getSchema: (document: string) => Promise<ProcessedDocument>;
30
- /** @private internal API */
31
- _getWatchPaths: () => string[];
32
- readonly options: OpenAPIOptions;
33
- }
34
- declare function createOpenAPI(options?: OpenAPIOptions): OpenAPIServer;
35
- /**
36
- * @deprecated
37
- */
38
- declare function createCodeSample<T>(options: InlineCodeUsageGenerator<T>): InlineCodeUsageGenerator<T>;
39
- //#endregion
40
- export { OpenAPIOptions, OpenAPIServer, createCodeSample, createOpenAPI };
@@ -1,42 +0,0 @@
1
- import { createProxy } from "./proxy.js";
2
- import { processDocument } from "../utils/document/process.js";
3
- import fs from "node:fs";
4
- //#region src/server/create.ts
5
- function createOpenAPI(options = {}) {
6
- const { input = [], disableCache = false } = options;
7
- let schemas;
8
- async function getSchemas() {
9
- if (Array.isArray(input)) {
10
- const entries = await Promise.all(input.map(async (item) => [item, await processDocument(item)]));
11
- return Object.fromEntries(entries);
12
- } else {
13
- const entries = await Promise.all(Object.entries(await input()).map(async ([k, v]) => [k, await processDocument(v)]));
14
- return Object.fromEntries(entries);
15
- }
16
- }
17
- return {
18
- options,
19
- createProxy,
20
- _getWatchPaths() {
21
- return (Array.isArray(input) ? input : Object.keys(input)).filter((key) => !URL.canParse(key) && fs.existsSync(key));
22
- },
23
- async getSchema(document) {
24
- const schemas = await this.getSchemas();
25
- if (document in schemas) return schemas[document];
26
- console.warn(`[Fumadocs OpenAPI] the document "${document}" is not listed in the input array, this may not be expected.`);
27
- return processDocument(document);
28
- },
29
- async getSchemas() {
30
- if (disableCache) return getSchemas();
31
- return schemas ??= getSchemas();
32
- }
33
- };
34
- }
35
- /**
36
- * @deprecated
37
- */
38
- function createCodeSample(options) {
39
- return options;
40
- }
41
- //#endregion
42
- export { createCodeSample, createOpenAPI };
@@ -1,55 +0,0 @@
1
- import { OpenAPIServer } from "./create.js";
2
- import { ApiPageProps } from "../ui/api-page.js";
3
- import { SchemaToPagesOptions } from "../utils/pages/preset-auto.js";
4
- import { ClientApiPageProps } from "../ui/create-client.js";
5
- import { DereferencedDocument } from "../utils/document/dereference.js";
6
- import { LoaderPlugin, MetaData, PageData, PageTreeTransformer, Source } from "fumadocs-core/source";
7
- import { StructuredData } from "fumadocs-core/mdx-plugins";
8
- import { TOCItemType } from "fumadocs-core/toc";
9
-
10
- //#region src/server/source-api.d.ts
11
- declare module 'fumadocs-core/source' {
12
- interface PageData {
13
- /**
14
- * Added by Fumadocs OpenAPI
15
- */
16
- _openapi?: InternalOpenAPIMeta;
17
- }
18
- }
19
- interface InternalOpenAPIMeta {
20
- method?: string;
21
- webhook?: boolean;
22
- deprecated?: boolean;
23
- }
24
- /**
25
- * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.
26
- */
27
- declare function openapiPlugin(): LoaderPlugin;
28
- interface OpenAPIPageData extends PageData {
29
- getAPIPageProps: () => ApiPageProps;
30
- getSchema: () => {
31
- id: string;
32
- } & DereferencedDocument;
33
- getClientAPIPageProps: () => Promise<ClientApiPageProps>;
34
- structuredData: StructuredData;
35
- toc: TOCItemType[];
36
- }
37
- type OpenAPISourceOptions = SchemaToPagesOptions & {
38
- baseDir?: string; /** Generate `meta.json` files */
39
- meta?: boolean | {
40
- folderStyle?: 'folder' | 'separator';
41
- };
42
- };
43
- /**
44
- * Generate virtual pages for Fumadocs Source API
45
- */
46
- declare function openapiSource(server: OpenAPIServer, options?: OpenAPISourceOptions): Promise<Source<{
47
- metaData: MetaData;
48
- pageData: OpenAPIPageData;
49
- }>>;
50
- /**
51
- * @deprecated use `openapiPlugin()`
52
- */
53
- declare function transformerOpenAPI(): PageTreeTransformer;
54
- //#endregion
55
- export { InternalOpenAPIMeta, OpenAPIPageData, OpenAPISourceOptions, openapiPlugin, openapiSource, transformerOpenAPI };
@@ -1,149 +0,0 @@
1
- import { toStaticData } from "../utils/pages/to-static-data.js";
2
- import { MethodLabel } from "../ui/components/method-label.js";
3
- import path from "node:path";
4
- import { PathUtils } from "fumadocs-core/source";
5
- import { Fragment, jsx, jsxs } from "react/jsx-runtime";
6
- //#region src/server/source-api.tsx
7
- /**
8
- * Fumadocs Source API integration, pass this to `plugins` array in `loader()`.
9
- */
10
- function openapiPlugin() {
11
- return {
12
- name: "fumadocs:openapi",
13
- enforce: "pre",
14
- transformPageTree: { file(node, filePath) {
15
- if (!filePath) return node;
16
- const file = this.storage.read(filePath);
17
- if (!file || file.format !== "page") return node;
18
- const openApiData = file.data._openapi;
19
- if (!openApiData || typeof openApiData !== "object") return node;
20
- if (openApiData.deprecated) node.name = /* @__PURE__ */ jsx("span", {
21
- className: "fd-page-tree-item-name line-through",
22
- children: node.name
23
- });
24
- if (openApiData.webhook) node.name = /* @__PURE__ */ jsxs(Fragment, { children: [
25
- node.name,
26
- " ",
27
- /* @__PURE__ */ jsx("span", {
28
- className: "ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono",
29
- children: "Webhook"
30
- })
31
- ] });
32
- else if (openApiData.method) node.name = /* @__PURE__ */ jsxs(Fragment, { children: [
33
- node.name,
34
- " ",
35
- /* @__PURE__ */ jsx(MethodLabel, {
36
- className: "ms-auto text-xs text-nowrap",
37
- children: openApiData.method
38
- })
39
- ] });
40
- return node;
41
- } }
42
- };
43
- }
44
- /**
45
- * Generate virtual pages for Fumadocs Source API
46
- */
47
- async function openapiSource(server, options = {}) {
48
- const { baseDir = "", meta = false } = options;
49
- const { createAutoPreset } = await import("../utils/pages/preset-auto.js");
50
- const { fromServer } = await import("../utils/pages/builder.js");
51
- const files = [];
52
- const entries = await fromServer(server, createAutoPreset(options));
53
- for (const [schemaId, list] of Object.entries(entries)) {
54
- const processed = await server.getSchema(schemaId);
55
- function onEntry(entry) {
56
- const props = getProps(entry);
57
- files.push({
58
- type: "page",
59
- path: `${baseDir}/${entry.path}`,
60
- data: {
61
- ...entry.info,
62
- getAPIPageProps() {
63
- return props;
64
- },
65
- async getClientAPIPageProps() {
66
- return {
67
- payload: {
68
- bundled: processed.bundled,
69
- proxyUrl: server.options.proxyUrl
70
- },
71
- ...props
72
- };
73
- },
74
- getSchema() {
75
- return {
76
- id: schemaId,
77
- ...processed
78
- };
79
- },
80
- ...toStaticData(props, processed.dereferenced),
81
- _openapi: {
82
- method: entry.type === "operation" || entry.type === "webhook" ? entry.item.method : void 0,
83
- webhook: entry.type === "webhook",
84
- deprecated: entry.info.deprecated
85
- }
86
- }
87
- });
88
- }
89
- function onEntries(entries, parent) {
90
- if (!meta) {
91
- for (const entry of entries) if (entry.type === "group") onEntries(entry.entries, entry);
92
- else onEntry(entry);
93
- return;
94
- }
95
- const { folderStyle = "folder" } = meta === true ? {} : meta;
96
- const pages = [];
97
- for (const entry of entries) {
98
- const relativePath = PathUtils.slash(parent ? path.relative(parent.path, entry.path) : entry.path);
99
- if (entry.type === "group") {
100
- onEntries(entry.entries, entry);
101
- if (folderStyle === "folder") pages.push(relativePath);
102
- else pages.push(`---${entry.info.title}---`, `...${relativePath}`);
103
- } else {
104
- onEntry(entry);
105
- pages.push(relativePath.slice(0, -PathUtils.extname(entry.path).length));
106
- }
107
- }
108
- if (pages.length === 0) return;
109
- files.push({
110
- type: "meta",
111
- path: path.join(baseDir, parent?.path ?? "", "meta.json"),
112
- data: {
113
- title: parent?.info.title,
114
- description: parent?.info.description,
115
- pages
116
- }
117
- });
118
- }
119
- onEntries(list);
120
- }
121
- return { files };
122
- }
123
- function getProps(entry) {
124
- if (entry.type === "operation") return {
125
- document: entry.schemaId,
126
- operations: [entry.item],
127
- showDescription: true
128
- };
129
- if (entry.type === "webhook") return {
130
- document: entry.schemaId,
131
- webhooks: [entry.item],
132
- showDescription: true
133
- };
134
- return {
135
- showTitle: true,
136
- showDescription: true,
137
- document: entry.schemaId,
138
- operations: entry.operations,
139
- webhooks: entry.webhooks
140
- };
141
- }
142
- /**
143
- * @deprecated use `openapiPlugin()`
144
- */
145
- function transformerOpenAPI() {
146
- return openapiPlugin().transformPageTree;
147
- }
148
- //#endregion
149
- export { openapiPlugin, openapiSource, transformerOpenAPI };