@redocly/realm 0.89.6 → 0.89.8-rc.1

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 (464) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/bin.js +1 -1
  4. package/dist/bin.js.map +1 -1
  5. package/dist/cli/build.d.ts.map +1 -1
  6. package/dist/cli/build.js +1 -1
  7. package/dist/cli/build.js.map +1 -1
  8. package/dist/cli/develop.d.ts.map +1 -1
  9. package/dist/cli/develop.js +1 -1
  10. package/dist/cli/develop.js.map +1 -1
  11. package/dist/cli/prepare/index.d.ts.map +1 -1
  12. package/dist/cli/prepare/index.js +1 -1
  13. package/dist/cli/prepare/index.js.map +1 -1
  14. package/dist/cli/telemetry/index.d.ts +2 -2
  15. package/dist/cli/telemetry/index.d.ts.map +1 -1
  16. package/dist/cli/telemetry/index.js +1 -1
  17. package/dist/cli/telemetry/index.js.map +1 -1
  18. package/dist/cli/translations/collect-config-translations.d.ts +2 -2
  19. package/dist/cli/translations/collect-config-translations.d.ts.map +1 -1
  20. package/dist/cli/translations/collect-config-translations.js +1 -1
  21. package/dist/cli/translations/collect-config-translations.js.map +1 -1
  22. package/dist/cli/translations/index.d.ts.map +1 -1
  23. package/dist/cli/translations/index.js +2 -2
  24. package/dist/cli/translations/index.js.map +1 -1
  25. package/dist/cli/translations/update-translations.d.ts +2 -2
  26. package/dist/cli/translations/update-translations.d.ts.map +1 -1
  27. package/dist/cli/translations/update-translations.js +1 -1
  28. package/dist/cli/translations/update-translations.js.map +1 -1
  29. package/dist/client/app/ErrorBubble/DetailedErrors.d.ts.map +1 -1
  30. package/dist/client/app/ErrorBubble/DetailedErrors.js +19 -14
  31. package/dist/client/app/ErrorBubble/DetailedErrors.js.map +1 -1
  32. package/dist/client/app/ErrorBubble/index.d.ts.map +1 -1
  33. package/dist/client/app/ErrorBubble/index.js +17 -3
  34. package/dist/client/app/ErrorBubble/index.js.map +1 -1
  35. package/dist/client/app/Link.d.ts.map +1 -1
  36. package/dist/client/app/Link.js +1 -1
  37. package/dist/client/app/Link.js.map +1 -1
  38. package/dist/client/app/ReviewComments/ReviewComments.d.ts.map +1 -1
  39. package/dist/client/app/ReviewComments/ReviewComments.js.map +1 -1
  40. package/dist/client/app/i18n/index.d.ts.map +1 -1
  41. package/dist/client/app/i18n/index.js +1 -1
  42. package/dist/client/app/i18n/index.js.map +1 -1
  43. package/dist/client/providers/page-data/hooks.d.ts +0 -1
  44. package/dist/client/providers/page-data/hooks.d.ts.map +1 -1
  45. package/dist/client/runtime/loader.js +1 -1
  46. package/dist/client/runtime/loader.js.map +1 -1
  47. package/dist/server/config/schema.d.ts +2 -8
  48. package/dist/server/config/schema.d.ts.map +1 -1
  49. package/dist/server/config/schema.js.map +1 -1
  50. package/dist/server/config/themes.js +1 -1
  51. package/dist/server/config/themes.js.map +1 -1
  52. package/dist/server/constants.js +1 -1
  53. package/dist/server/constants.js.map +1 -1
  54. package/dist/server/esbuild/generate.js +6 -6
  55. package/dist/server/esbuild/plugins/themes-resolver.d.ts.map +1 -1
  56. package/dist/server/esbuild/plugins/themes-resolver.js +2 -2
  57. package/dist/server/esbuild/plugins/themes-resolver.js.map +1 -1
  58. package/dist/server/fs/cache.d.ts +35 -0
  59. package/dist/server/fs/cache.d.ts.map +1 -0
  60. package/dist/server/fs/cache.js +1 -0
  61. package/dist/server/fs/cache.js.map +1 -0
  62. package/dist/server/fs/content-fs.d.ts +22 -0
  63. package/dist/server/fs/content-fs.d.ts.map +1 -0
  64. package/dist/server/fs/content-fs.js +1 -0
  65. package/dist/server/fs/content-fs.js.map +1 -0
  66. package/dist/server/fs/fast-mtime.d.ts.map +1 -0
  67. package/dist/server/fs/fast-mtime.js.map +1 -0
  68. package/dist/server/fs/fs.d.ts +34 -0
  69. package/dist/server/fs/fs.d.ts.map +1 -0
  70. package/dist/server/fs/fs.js +3 -0
  71. package/dist/server/fs/fs.js.map +1 -0
  72. package/dist/server/fs/last-modified-tracker.d.ts +17 -0
  73. package/dist/server/fs/last-modified-tracker.d.ts.map +1 -0
  74. package/dist/server/fs/last-modified-tracker.js +1 -0
  75. package/dist/server/fs/last-modified-tracker.js.map +1 -0
  76. package/dist/server/fs/load-error.d.ts +3 -0
  77. package/dist/server/fs/load-error.d.ts.map +1 -0
  78. package/dist/server/fs/load-error.js +1 -0
  79. package/dist/server/fs/load-error.js.map +1 -0
  80. package/dist/server/fs/types.d.ts +55 -0
  81. package/dist/server/fs/types.d.ts.map +1 -0
  82. package/dist/server/fs/types.js +0 -0
  83. package/dist/server/fs/types.js.map +1 -0
  84. package/dist/server/fs/utils/async-storage.d.ts +12 -0
  85. package/dist/server/fs/utils/async-storage.d.ts.map +1 -0
  86. package/dist/server/fs/utils/async-storage.js +1 -0
  87. package/dist/server/fs/utils/async-storage.js.map +1 -0
  88. package/dist/server/fs/utils/debounced-emit.d.ts +2 -0
  89. package/dist/server/fs/utils/debounced-emit.d.ts.map +1 -0
  90. package/dist/server/fs/utils/debounced-emit.js +1 -0
  91. package/dist/server/fs/utils/debounced-emit.js.map +1 -0
  92. package/dist/server/fs/utils/external-ref-resolver.d.ts +10 -0
  93. package/dist/server/fs/utils/external-ref-resolver.d.ts.map +1 -0
  94. package/dist/server/fs/utils/external-ref-resolver.js +2 -0
  95. package/dist/server/fs/utils/external-ref-resolver.js.map +1 -0
  96. package/dist/server/fs/utils/get-locale-from-relative-path.d.ts +2 -0
  97. package/dist/server/fs/utils/get-locale-from-relative-path.d.ts.map +1 -0
  98. package/dist/server/fs/utils/get-locale-from-relative-path.js +1 -0
  99. package/dist/server/fs/utils/get-locale-from-relative-path.js.map +1 -0
  100. package/dist/server/fs/utils/get-path-for-all-locales.d.ts +2 -0
  101. package/dist/server/fs/utils/get-path-for-all-locales.d.ts.map +1 -0
  102. package/dist/server/fs/utils/get-path-for-all-locales.js +1 -0
  103. package/dist/server/fs/utils/get-path-for-all-locales.js.map +1 -0
  104. package/dist/server/fs/utils/is-i18n-path.d.ts +2 -0
  105. package/dist/server/fs/utils/is-i18n-path.d.ts.map +1 -0
  106. package/dist/server/fs/utils/is-i18n-path.js +1 -0
  107. package/dist/server/fs/utils/is-i18n-path.js.map +1 -0
  108. package/dist/server/fs/utils/nested-map.d.ts +12 -0
  109. package/dist/server/fs/utils/nested-map.d.ts.map +1 -0
  110. package/dist/server/fs/utils/nested-map.js +1 -0
  111. package/dist/server/fs/utils/nested-map.js.map +1 -0
  112. package/dist/server/fs/utils/remove-i18n-prefix.d.ts +2 -0
  113. package/dist/server/fs/utils/remove-i18n-prefix.d.ts.map +1 -0
  114. package/dist/server/fs/utils/remove-i18n-prefix.js +1 -0
  115. package/dist/server/fs/utils/remove-i18n-prefix.js.map +1 -0
  116. package/dist/server/plugins/analytics/adobe/index.js +1 -1
  117. package/dist/server/plugins/analytics/adobe/index.js.map +1 -1
  118. package/dist/server/plugins/analytics/amplitude/index.js +1 -1
  119. package/dist/server/plugins/analytics/amplitude/index.js.map +1 -1
  120. package/dist/server/plugins/analytics/fullstory/index.js +1 -1
  121. package/dist/server/plugins/analytics/fullstory/index.js.map +1 -1
  122. package/dist/server/plugins/analytics/ga/index.js +1 -1
  123. package/dist/server/plugins/analytics/ga/index.js.map +1 -1
  124. package/dist/server/plugins/analytics/gtm/index.js +1 -1
  125. package/dist/server/plugins/analytics/gtm/index.js.map +1 -1
  126. package/dist/server/plugins/analytics/heap/index.js +1 -1
  127. package/dist/server/plugins/analytics/heap/index.js.map +1 -1
  128. package/dist/server/plugins/analytics/rudderstack/index.js +1 -1
  129. package/dist/server/plugins/analytics/rudderstack/index.js.map +1 -1
  130. package/dist/server/plugins/analytics/segment/index.js +1 -1
  131. package/dist/server/plugins/analytics/segment/index.js.map +1 -1
  132. package/dist/server/plugins/catalog/index.d.ts.map +1 -1
  133. package/dist/server/plugins/catalog/index.js +1 -1
  134. package/dist/server/plugins/catalog/index.js.map +1 -1
  135. package/dist/server/plugins/config-parser/index.d.ts.map +1 -1
  136. package/dist/server/plugins/config-parser/index.js +1 -1
  137. package/dist/server/plugins/config-parser/index.js.map +1 -1
  138. package/dist/server/plugins/config-parser/loaders/content-slugs-loader.d.ts +11 -0
  139. package/dist/server/plugins/config-parser/loaders/content-slugs-loader.d.ts.map +1 -0
  140. package/dist/server/plugins/config-parser/loaders/content-slugs-loader.js +1 -0
  141. package/dist/server/plugins/config-parser/loaders/content-slugs-loader.js.map +1 -0
  142. package/dist/server/plugins/config-parser/loaders/index.d.ts +10 -0
  143. package/dist/server/plugins/config-parser/loaders/index.d.ts.map +1 -0
  144. package/dist/server/plugins/config-parser/loaders/index.js +1 -0
  145. package/dist/server/plugins/config-parser/loaders/index.js.map +1 -0
  146. package/dist/server/plugins/config-parser/loaders/is-ignored-loader.d.ts +3 -0
  147. package/dist/server/plugins/config-parser/loaders/is-ignored-loader.d.ts.map +1 -0
  148. package/dist/server/plugins/config-parser/loaders/is-ignored-loader.js +1 -0
  149. package/dist/server/plugins/config-parser/loaders/is-ignored-loader.js.map +1 -0
  150. package/dist/server/plugins/config-parser/loaders/nearest-redocly-config-loader.d.ts +9 -0
  151. package/dist/server/plugins/config-parser/loaders/nearest-redocly-config-loader.d.ts.map +1 -0
  152. package/dist/server/plugins/config-parser/loaders/nearest-redocly-config-loader.js +1 -0
  153. package/dist/server/plugins/config-parser/loaders/nearest-redocly-config-loader.js.map +1 -0
  154. package/dist/server/plugins/config-parser/loaders/product-config-loader.d.ts +3 -0
  155. package/dist/server/plugins/config-parser/loaders/product-config-loader.d.ts.map +1 -0
  156. package/dist/server/plugins/config-parser/loaders/product-config-loader.js +1 -0
  157. package/dist/server/plugins/config-parser/loaders/product-config-loader.js.map +1 -0
  158. package/dist/server/plugins/config-parser/loaders/redocly-config-loader.d.ts +3 -0
  159. package/dist/server/plugins/config-parser/loaders/redocly-config-loader.d.ts.map +1 -0
  160. package/dist/server/plugins/config-parser/loaders/redocly-config-loader.js +1 -0
  161. package/dist/server/plugins/config-parser/loaders/redocly-config-loader.js.map +1 -0
  162. package/dist/server/plugins/config-parser/loaders/utils/read-and-validate-config.d.ts +5 -0
  163. package/dist/server/plugins/config-parser/loaders/utils/read-and-validate-config.d.ts.map +1 -0
  164. package/dist/server/plugins/config-parser/loaders/utils/read-and-validate-config.js +1 -0
  165. package/dist/server/plugins/config-parser/loaders/utils/read-and-validate-config.js.map +1 -0
  166. package/dist/server/plugins/config-parser/loaders/versions-config-loader.d.ts +10 -0
  167. package/dist/server/plugins/config-parser/loaders/versions-config-loader.d.ts.map +1 -0
  168. package/dist/server/plugins/config-parser/loaders/versions-config-loader.js +1 -0
  169. package/dist/server/plugins/config-parser/loaders/versions-config-loader.js.map +1 -0
  170. package/dist/server/plugins/config-parser/loaders/yaml-parser.d.ts +3 -0
  171. package/dist/server/plugins/config-parser/loaders/yaml-parser.d.ts.map +1 -0
  172. package/dist/server/plugins/config-parser/loaders/yaml-parser.js +1 -0
  173. package/dist/server/plugins/config-parser/loaders/yaml-parser.js.map +1 -0
  174. package/dist/server/plugins/config-parser/safe-parse.d.ts +1 -6
  175. package/dist/server/plugins/config-parser/safe-parse.d.ts.map +1 -1
  176. package/dist/server/plugins/config-parser/safe-parse.js +1 -1
  177. package/dist/server/plugins/config-parser/safe-parse.js.map +1 -1
  178. package/dist/server/plugins/default-theme/index.d.ts.map +1 -1
  179. package/dist/server/plugins/default-theme/index.js +1 -1
  180. package/dist/server/plugins/default-theme/index.js.map +1 -1
  181. package/dist/server/plugins/default-theme/resolve-logo.d.ts +2 -2
  182. package/dist/server/plugins/default-theme/resolve-logo.d.ts.map +1 -1
  183. package/dist/server/plugins/default-theme/resolve-logo.js +1 -1
  184. package/dist/server/plugins/default-theme/resolve-logo.js.map +1 -1
  185. package/dist/server/plugins/default-theme/resolve-products-config.d.ts +3 -4
  186. package/dist/server/plugins/default-theme/resolve-products-config.d.ts.map +1 -1
  187. package/dist/server/plugins/default-theme/resolve-products-config.js +1 -1
  188. package/dist/server/plugins/default-theme/resolve-products-config.js.map +1 -1
  189. package/dist/server/plugins/dev-onboarding/index.d.ts.map +1 -1
  190. package/dist/server/plugins/dev-onboarding/index.js +1 -1
  191. package/dist/server/plugins/dev-onboarding/index.js.map +1 -1
  192. package/dist/server/plugins/entitlements/index.js +1 -1
  193. package/dist/server/plugins/entitlements/index.js.map +1 -1
  194. package/dist/server/plugins/error-route.d.ts +2 -2
  195. package/dist/server/plugins/error-route.d.ts.map +1 -1
  196. package/dist/server/plugins/error-route.js +1 -1
  197. package/dist/server/plugins/error-route.js.map +1 -1
  198. package/dist/server/plugins/get-api-config.d.ts.map +1 -1
  199. package/dist/server/plugins/get-api-config.js +1 -1
  200. package/dist/server/plugins/get-api-config.js.map +1 -1
  201. package/dist/server/plugins/graphql-docs/graphql-doc-loader.d.ts +12 -0
  202. package/dist/server/plugins/graphql-docs/graphql-doc-loader.d.ts.map +1 -0
  203. package/dist/server/plugins/graphql-docs/graphql-doc-loader.js +1 -0
  204. package/dist/server/plugins/graphql-docs/graphql-doc-loader.js.map +1 -0
  205. package/dist/server/plugins/graphql-docs/index.d.ts.map +1 -1
  206. package/dist/server/plugins/graphql-docs/index.js +1 -1
  207. package/dist/server/plugins/graphql-docs/index.js.map +1 -1
  208. package/dist/server/plugins/graphql-docs/search/search-resolver.d.ts +2 -2
  209. package/dist/server/plugins/graphql-docs/search/search-resolver.d.ts.map +1 -1
  210. package/dist/server/plugins/graphql-docs/search/search-resolver.js +1 -1
  211. package/dist/server/plugins/graphql-docs/search/search-resolver.js.map +1 -1
  212. package/dist/server/plugins/i18n/index.d.ts.map +1 -1
  213. package/dist/server/plugins/i18n/index.js +1 -1
  214. package/dist/server/plugins/i18n/index.js.map +1 -1
  215. package/dist/server/plugins/lifecycle.d.ts +12 -5
  216. package/dist/server/plugins/lifecycle.d.ts.map +1 -1
  217. package/dist/server/plugins/lifecycle.js +2 -2
  218. package/dist/server/plugins/lifecycle.js.map +1 -1
  219. package/dist/server/plugins/markdown/attribute-resolvers.d.ts +9 -9
  220. package/dist/server/plugins/markdown/attribute-resolvers.d.ts.map +1 -1
  221. package/dist/server/plugins/markdown/attribute-resolvers.js +6 -6
  222. package/dist/server/plugins/markdown/attribute-resolvers.js.map +1 -1
  223. package/dist/server/plugins/markdown/compiler.d.ts +11 -15
  224. package/dist/server/plugins/markdown/compiler.d.ts.map +1 -1
  225. package/dist/server/plugins/markdown/compiler.js +1 -1
  226. package/dist/server/plugins/markdown/compiler.js.map +1 -1
  227. package/dist/server/plugins/markdown/errors.d.ts +3 -1
  228. package/dist/server/plugins/markdown/errors.d.ts.map +1 -1
  229. package/dist/server/plugins/markdown/errors.js +2 -2
  230. package/dist/server/plugins/markdown/errors.js.map +1 -1
  231. package/dist/server/plugins/markdown/index.d.ts.map +1 -1
  232. package/dist/server/plugins/markdown/index.js +1 -1
  233. package/dist/server/plugins/markdown/index.js.map +1 -1
  234. package/dist/server/plugins/markdown/markdoc/custom-components/openapi/replay-openapi.d.ts.map +1 -1
  235. package/dist/server/plugins/markdown/markdoc/custom-components/openapi/replay-openapi.js +1 -1
  236. package/dist/server/plugins/markdown/markdoc/custom-components/openapi/replay-openapi.js.map +1 -1
  237. package/dist/server/plugins/markdown/markdoc/hooks/use-store.d.ts +3 -3
  238. package/dist/server/plugins/markdown/markdoc/hooks/use-store.js +1 -1
  239. package/dist/server/plugins/markdown/markdoc/partials.d.ts +2 -3
  240. package/dist/server/plugins/markdown/markdoc/partials.d.ts.map +1 -1
  241. package/dist/server/plugins/markdown/markdoc/partials.js +1 -1
  242. package/dist/server/plugins/markdown/markdoc/partials.js.map +1 -1
  243. package/dist/server/plugins/markdown/markdoc/resolve-raw-partials.d.ts +2 -2
  244. package/dist/server/plugins/markdown/markdoc/resolve-raw-partials.d.ts.map +1 -1
  245. package/dist/server/plugins/markdown/markdoc/resolve-raw-partials.js +2 -2
  246. package/dist/server/plugins/markdown/markdoc/resolve-raw-partials.js.map +1 -1
  247. package/dist/server/plugins/markdown/markdown-frontmatter-loader.d.ts +3 -0
  248. package/dist/server/plugins/markdown/markdown-frontmatter-loader.d.ts.map +1 -0
  249. package/dist/server/plugins/markdown/markdown-frontmatter-loader.js +1 -0
  250. package/dist/server/plugins/markdown/markdown-frontmatter-loader.js.map +1 -0
  251. package/dist/server/plugins/markdown/markdown-static-data-loader.d.ts +3 -9
  252. package/dist/server/plugins/markdown/markdown-static-data-loader.d.ts.map +1 -1
  253. package/dist/server/plugins/markdown/markdown-static-data-loader.js +1 -1
  254. package/dist/server/plugins/markdown/markdown-static-data-loader.js.map +1 -1
  255. package/dist/server/plugins/markdown/search/search-resolver.d.ts +2 -2
  256. package/dist/server/plugins/markdown/search/search-resolver.d.ts.map +1 -1
  257. package/dist/server/plugins/markdown/search/search-resolver.js +1 -1
  258. package/dist/server/plugins/markdown/search/search-resolver.js.map +1 -1
  259. package/dist/server/plugins/markdown/types.d.ts +2 -4
  260. package/dist/server/plugins/markdown/types.d.ts.map +1 -1
  261. package/dist/server/plugins/nav-utils.d.ts +5 -6
  262. package/dist/server/plugins/nav-utils.d.ts.map +1 -1
  263. package/dist/server/plugins/nav-utils.js +2 -2
  264. package/dist/server/plugins/nav-utils.js.map +1 -1
  265. package/dist/server/plugins/openapi-docs/ast-utils.d.ts +1 -1
  266. package/dist/server/plugins/openapi-docs/ast-utils.d.ts.map +1 -1
  267. package/dist/server/plugins/openapi-docs/ast-utils.js +2 -2
  268. package/dist/server/plugins/openapi-docs/ast-utils.js.map +1 -1
  269. package/dist/server/plugins/openapi-docs/decorators/markdown-parser-decorator.d.ts +3 -0
  270. package/dist/server/plugins/openapi-docs/decorators/markdown-parser-decorator.d.ts.map +1 -1
  271. package/dist/server/plugins/openapi-docs/decorators/markdown-parser-decorator.js +1 -1
  272. package/dist/server/plugins/openapi-docs/decorators/markdown-parser-decorator.js.map +1 -1
  273. package/dist/server/plugins/openapi-docs/index.d.ts.map +1 -1
  274. package/dist/server/plugins/openapi-docs/index.js +1 -1
  275. package/dist/server/plugins/openapi-docs/index.js.map +1 -1
  276. package/dist/server/plugins/openapi-docs/is-openapi-doc.d.ts +2 -2
  277. package/dist/server/plugins/openapi-docs/is-openapi-doc.d.ts.map +1 -1
  278. package/dist/server/plugins/openapi-docs/is-openapi-doc.js +1 -1
  279. package/dist/server/plugins/openapi-docs/is-openapi-doc.js.map +1 -1
  280. package/dist/server/plugins/openapi-docs/load-definition.d.ts +13 -5
  281. package/dist/server/plugins/openapi-docs/load-definition.d.ts.map +1 -1
  282. package/dist/server/plugins/openapi-docs/load-definition.js +3 -3
  283. package/dist/server/plugins/openapi-docs/load-definition.js.map +1 -1
  284. package/dist/server/plugins/openapi-docs/search/search-resolver.d.ts +6 -10
  285. package/dist/server/plugins/openapi-docs/search/search-resolver.d.ts.map +1 -1
  286. package/dist/server/plugins/openapi-docs/search/search-resolver.js +1 -1
  287. package/dist/server/plugins/openapi-docs/search/search-resolver.js.map +1 -1
  288. package/dist/server/plugins/openapi-docs/store-definition-bundles.d.ts.map +1 -1
  289. package/dist/server/plugins/openapi-docs/store-definition-bundles.js +1 -1
  290. package/dist/server/plugins/openapi-docs/store-definition-bundles.js.map +1 -1
  291. package/dist/server/plugins/openapi-docs/template/OpenAPIDocs.d.ts.map +1 -1
  292. package/dist/server/plugins/openapi-docs/template/OpenAPIDocs.js.map +1 -1
  293. package/dist/server/plugins/openapi-docs/template/helpers.d.ts +1 -3
  294. package/dist/server/plugins/openapi-docs/template/helpers.d.ts.map +1 -1
  295. package/dist/server/plugins/openapi-docs/template/helpers.js +1 -1
  296. package/dist/server/plugins/openapi-docs/template/helpers.js.map +1 -1
  297. package/dist/server/plugins/openapi-docs/template/mock-server-config.d.ts +15 -0
  298. package/dist/server/plugins/openapi-docs/template/mock-server-config.d.ts.map +1 -0
  299. package/dist/server/plugins/openapi-docs/template/mock-server-config.js +1 -0
  300. package/dist/server/plugins/openapi-docs/template/mock-server-config.js.map +1 -0
  301. package/dist/server/plugins/pages/index.d.ts.map +1 -1
  302. package/dist/server/plugins/pages/index.js +1 -1
  303. package/dist/server/plugins/pages/index.js.map +1 -1
  304. package/dist/server/plugins/pages/page-data-loaders/static-data-loader.d.ts +2 -3
  305. package/dist/server/plugins/pages/page-data-loaders/static-data-loader.d.ts.map +1 -1
  306. package/dist/server/plugins/pages/page-data-loaders/static-data-loader.js +1 -1
  307. package/dist/server/plugins/pages/page-data-loaders/static-data-loader.js.map +1 -1
  308. package/dist/server/plugins/pages/react-frontmatter-loader.d.ts +4 -0
  309. package/dist/server/plugins/pages/react-frontmatter-loader.d.ts.map +1 -0
  310. package/dist/server/plugins/pages/react-frontmatter-loader.js +1 -0
  311. package/dist/server/plugins/pages/react-frontmatter-loader.js.map +1 -0
  312. package/dist/server/plugins/resolve-frontmatter-keys.d.ts +2 -2
  313. package/dist/server/plugins/resolve-frontmatter-keys.d.ts.map +1 -1
  314. package/dist/server/plugins/resolve-frontmatter-keys.js.map +1 -1
  315. package/dist/server/plugins/scorecard/compute-scorecard.d.ts +5 -0
  316. package/dist/server/plugins/scorecard/compute-scorecard.d.ts.map +1 -0
  317. package/dist/server/plugins/scorecard/compute-scorecard.js +4 -0
  318. package/dist/server/plugins/scorecard/compute-scorecard.js.map +1 -0
  319. package/dist/server/plugins/scorecard/get-scorecard-config.d.ts +4 -25
  320. package/dist/server/plugins/scorecard/get-scorecard-config.d.ts.map +1 -1
  321. package/dist/server/plugins/scorecard/index.d.ts +7 -2
  322. package/dist/server/plugins/scorecard/index.d.ts.map +1 -1
  323. package/dist/server/plugins/scorecard/index.js +1 -4
  324. package/dist/server/plugins/scorecard/index.js.map +1 -1
  325. package/dist/server/plugins/scorecard/lint.d.ts +7 -2
  326. package/dist/server/plugins/scorecard/lint.d.ts.map +1 -1
  327. package/dist/server/plugins/scorecard/lint.js +1 -1
  328. package/dist/server/plugins/scorecard/lint.js.map +1 -1
  329. package/dist/server/plugins/scorecard/loaders/scorecard-config.d.ts +8 -0
  330. package/dist/server/plugins/scorecard/loaders/scorecard-config.d.ts.map +1 -0
  331. package/dist/server/plugins/scorecard/loaders/scorecard-config.js +1 -0
  332. package/dist/server/plugins/scorecard/loaders/scorecard-config.js.map +1 -0
  333. package/dist/server/plugins/scorecard/loaders/scorecard.d.ts +9 -0
  334. package/dist/server/plugins/scorecard/loaders/scorecard.d.ts.map +1 -0
  335. package/dist/server/plugins/scorecard/loaders/scorecard.js +1 -0
  336. package/dist/server/plugins/scorecard/loaders/scorecard.js.map +1 -0
  337. package/dist/server/plugins/search/search-plugin.d.ts.map +1 -1
  338. package/dist/server/plugins/search/search-plugin.js +1 -1
  339. package/dist/server/plugins/search/search-plugin.js.map +1 -1
  340. package/dist/server/plugins/sidebars/index.d.ts +2 -2
  341. package/dist/server/plugins/sidebars/index.d.ts.map +1 -1
  342. package/dist/server/plugins/sidebars/index.js +3 -3
  343. package/dist/server/plugins/sidebars/index.js.map +1 -1
  344. package/dist/server/plugins/sidebars/utils.d.ts +2 -2
  345. package/dist/server/plugins/sidebars/utils.d.ts.map +1 -1
  346. package/dist/server/plugins/sidebars/utils.js +1 -1
  347. package/dist/server/plugins/sidebars/utils.js.map +1 -1
  348. package/dist/server/plugins/sitemap/index.d.ts.map +1 -1
  349. package/dist/server/plugins/sitemap/index.js +1 -1
  350. package/dist/server/plugins/sitemap/index.js.map +1 -1
  351. package/dist/server/plugins/sso/index.d.ts.map +1 -1
  352. package/dist/server/plugins/sso/index.js +1 -1
  353. package/dist/server/plugins/sso/index.js.map +1 -1
  354. package/dist/server/plugins/types.d.ts +51 -21
  355. package/dist/server/plugins/types.d.ts.map +1 -1
  356. package/dist/server/plugins/types.js.map +1 -1
  357. package/dist/server/plugins/utils.d.ts +1 -2
  358. package/dist/server/plugins/utils.d.ts.map +1 -1
  359. package/dist/server/plugins/utils.js +1 -1
  360. package/dist/server/plugins/utils.js.map +1 -1
  361. package/dist/server/plugins/validate-rbac-config.d.ts +1 -1
  362. package/dist/server/plugins/validate-rbac-config.d.ts.map +1 -1
  363. package/dist/server/plugins/validate-rbac-config.js +6 -6
  364. package/dist/server/plugins/validate-rbac-config.js.map +1 -1
  365. package/dist/server/store.d.ts +24 -694
  366. package/dist/server/store.d.ts.map +1 -1
  367. package/dist/server/store.js +1 -1
  368. package/dist/server/store.js.map +1 -1
  369. package/dist/server/utils/crypto.d.ts +3 -1
  370. package/dist/server/utils/crypto.d.ts.map +1 -1
  371. package/dist/server/utils/crypto.js +1 -1
  372. package/dist/server/utils/crypto.js.map +1 -1
  373. package/dist/server/utils/fs.d.ts +0 -2
  374. package/dist/server/utils/fs.d.ts.map +1 -1
  375. package/dist/server/utils/fs.js +1 -1
  376. package/dist/server/utils/fs.js.map +1 -1
  377. package/dist/server/utils/lifecycle-hooks.d.ts.map +1 -1
  378. package/dist/server/utils/lifecycle-hooks.js +1 -1
  379. package/dist/server/utils/lifecycle-hooks.js.map +1 -1
  380. package/dist/server/utils/paths.d.ts +0 -7
  381. package/dist/server/utils/paths.d.ts.map +1 -1
  382. package/dist/server/utils/paths.js +1 -1
  383. package/dist/server/utils/paths.js.map +1 -1
  384. package/dist/server/utils/product.d.ts +1 -2
  385. package/dist/server/utils/product.d.ts.map +1 -1
  386. package/dist/server/utils/product.js +1 -1
  387. package/dist/server/utils/product.js.map +1 -1
  388. package/dist/server/utils/rbac.d.ts +3 -3
  389. package/dist/server/utils/rbac.d.ts.map +1 -1
  390. package/dist/server/utils/rbac.js +1 -1
  391. package/dist/server/utils/rbac.js.map +1 -1
  392. package/dist/server/utils/reporter/formatter.js +3 -3
  393. package/dist/server/utils/reporter/formatter.js.map +1 -1
  394. package/dist/server/utils/reporter/reporter.d.ts +1 -1
  395. package/dist/server/utils/reporter/reporter.d.ts.map +1 -1
  396. package/dist/server/utils/reporter/reporter.js +6 -6
  397. package/dist/server/utils/reporter/reporter.js.map +1 -1
  398. package/dist/server/utils/resolve-src-set.d.ts +2 -2
  399. package/dist/server/utils/resolve-src-set.d.ts.map +1 -1
  400. package/dist/server/utils/resolve-src-set.js +1 -1
  401. package/dist/server/utils/resolve-src-set.js.map +1 -1
  402. package/dist/server/utils/shared-data.d.ts +1 -1
  403. package/dist/server/utils/shared-data.d.ts.map +1 -1
  404. package/dist/server/utils/shared-data.js +1 -1
  405. package/dist/server/utils/shared-data.js.map +1 -1
  406. package/dist/server/web-server/dev-server.d.ts +2 -2
  407. package/dist/server/web-server/dev-server.d.ts.map +1 -1
  408. package/dist/server/web-server/dev-server.js.map +1 -1
  409. package/dist/server/web-server/handle-api-request.d.ts.map +1 -1
  410. package/dist/server/web-server/handle-api-request.js +1 -1
  411. package/dist/server/web-server/handle-api-request.js.map +1 -1
  412. package/dist/server/web-server/middleware/dynamic-middleware/dynamic-middleware.d.ts.map +1 -1
  413. package/dist/server/web-server/middleware/dynamic-middleware/dynamic-middleware.js +1 -1
  414. package/dist/server/web-server/middleware/dynamic-middleware/dynamic-middleware.js.map +1 -1
  415. package/dist/server/web-server/routes/index.d.ts +1 -0
  416. package/dist/server/web-server/routes/index.d.ts.map +1 -1
  417. package/dist/server/web-server/routes/index.js +1 -1
  418. package/dist/server/web-server/routes/index.js.map +1 -1
  419. package/dist/server/web-server/routes/page-data.d.ts.map +1 -1
  420. package/dist/server/web-server/routes/page-data.js +1 -1
  421. package/dist/server/web-server/routes/page-data.js.map +1 -1
  422. package/dist/server/web-server/routes/resolve-route.d.ts.map +1 -1
  423. package/dist/server/web-server/routes/resolve-route.js +1 -1
  424. package/dist/server/web-server/routes/resolve-route.js.map +1 -1
  425. package/dist/server/web-server/utils.d.ts.map +1 -1
  426. package/dist/server/web-server/utils.js +1 -1
  427. package/dist/server/web-server/utils.js.map +1 -1
  428. package/dist/shared/jsUtils.d.ts +1 -1
  429. package/dist/shared/jsUtils.d.ts.map +1 -1
  430. package/dist/shared/jsUtils.js +1 -1
  431. package/dist/shared/jsUtils.js.map +1 -1
  432. package/package.json +6 -6
  433. package/dist/server/content/content-provider.d.ts +0 -176
  434. package/dist/server/content/content-provider.d.ts.map +0 -1
  435. package/dist/server/content/content-provider.js +0 -1
  436. package/dist/server/content/content-provider.js.map +0 -1
  437. package/dist/server/content/content-slugger.d.ts +0 -16
  438. package/dist/server/content/content-slugger.d.ts.map +0 -1
  439. package/dist/server/content/content-slugger.js +0 -1
  440. package/dist/server/content/content-slugger.js.map +0 -1
  441. package/dist/server/content/external-ref-resolver.d.ts +0 -7
  442. package/dist/server/content/external-ref-resolver.d.ts.map +0 -1
  443. package/dist/server/content/external-ref-resolver.js +0 -1
  444. package/dist/server/content/external-ref-resolver.js.map +0 -1
  445. package/dist/server/content/fast-mtime.d.ts.map +0 -1
  446. package/dist/server/content/fast-mtime.js.map +0 -1
  447. package/dist/server/content/i18n-config.d.ts +0 -25
  448. package/dist/server/content/i18n-config.d.ts.map +0 -1
  449. package/dist/server/content/i18n-config.js +0 -1
  450. package/dist/server/content/i18n-config.js.map +0 -1
  451. package/dist/server/content/versions-config.d.ts +0 -41
  452. package/dist/server/content/versions-config.d.ts.map +0 -1
  453. package/dist/server/content/versions-config.js +0 -1
  454. package/dist/server/content/versions-config.js.map +0 -1
  455. package/dist/server/plugins/openapi-docs/mock-server-config.d.ts +0 -13
  456. package/dist/server/plugins/openapi-docs/mock-server-config.d.ts.map +0 -1
  457. package/dist/server/plugins/openapi-docs/mock-server-config.js +0 -1
  458. package/dist/server/plugins/openapi-docs/mock-server-config.js.map +0 -1
  459. package/dist/server/plugins/scorecard/utils.d.ts +0 -3
  460. package/dist/server/plugins/scorecard/utils.d.ts.map +0 -1
  461. package/dist/server/plugins/scorecard/utils.js +0 -1
  462. package/dist/server/plugins/scorecard/utils.js.map +0 -1
  463. /package/dist/server/{content → fs}/fast-mtime.d.ts +0 -0
  464. /package/dist/server/{content → fs}/fast-mtime.js +0 -0
@@ -1,11 +1,11 @@
1
1
  import type { Plugin } from 'esbuild';
2
2
  import type { JSONIndex, SearchData, GlobalData, SearchDataWithLocales, PageStaticData } from '../shared/types';
3
- import type { ApiRouteDetails, CustomSsoProviderDetails, MiddlewareDetails, PageRouteDetails, RouteDetails } from './plugins/types.js';
4
- import type { ContentProvider } from './content/content-provider';
3
+ import type { ApiRouteDetails, CustomSsoProviderDetails, MiddlewareDetails, PageRouteInit, PageRouteDetails, RouteDetails, LifecycleContext, MarkdownParseInput } from './plugins/types.js';
5
4
  import type { RedoclyConfig, RedirectConfig, SsoConfig } from './config/schema';
6
- import type { MarkdocDeps, MarkdocRawContent } from './plugins/markdown/compiler.js';
7
- import type { SearchDocument } from '@redocly/theme';
5
+ import type { MarkdocDeps } from './plugins/markdown/compiler.js';
6
+ import type { SearchDocument, ThemeConfig } from '@redocly/theme';
8
7
  import type { CommonError } from './utils/index.js';
8
+ import type { BundledDefinition } from './plugins/openapi-docs/load-definition.js';
9
9
  export declare const MARKDOC_PARTIALS_DATA_KEY = "markdown/partials";
10
10
  type LifecycleEventType = 'template-updated' | 'global-data-updated' | 'shared-data-updated' | 'search-data-updated' | 'routes-updated' | 'build-updated' | 'build-started' | 'errors-updated';
11
11
  export type StoreOptions = {
@@ -21,7 +21,9 @@ export interface ComputedRedoclyConfig {
21
21
  }
22
22
  export declare class Store {
23
23
  routesBySlug: Map<string, PageRouteDetails>;
24
- contentProvider: ContentProvider | undefined;
24
+ lifecycleContext: LifecycleContext | undefined;
25
+ newRoutes: PageRouteInit[];
26
+ _sharedDataHashes: Record<string, string>;
25
27
  routesByFsPath: Map<string, string>;
26
28
  apiRoutesBySlug: Map<string, ApiRouteDetails>;
27
29
  middleware: MiddlewareDetails[];
@@ -55,12 +57,12 @@ export declare class Store {
55
57
  outdir: string;
56
58
  renderMode: string;
57
59
  buildRevision: number;
58
- contentRevision: number;
59
60
  hasSitemap: boolean;
60
61
  private _resolveSearchIndex;
61
62
  private _resolveUserCodeReady;
62
63
  userCodeReady: Promise<boolean>;
63
64
  private _pluginsRunning;
65
+ private _resolvePluginsRunning;
64
66
  private _queuedLifecycleEvents;
65
67
  constructor({ outdir, renderMode, contentDir, serverMode, serverOutDir, }: StoreOptions);
66
68
  on(type: 'routes-updated', cb: () => void): void;
@@ -71,8 +73,10 @@ export declare class Store {
71
73
  on(type: 'errors-updated', cb: (errors: CommonError[]) => void): void;
72
74
  on(type: 'search-data-updated', cb: (locale: string, data: SearchData) => void): void;
73
75
  on(type: 'global-data-updated', cb: (data: Record<string, unknown>) => void): void;
76
+ queueEvent: <T extends unknown[]>(type: LifecycleEventType, id?: string, ...args: T) => void;
74
77
  runListeners: <T extends unknown[]>(type: LifecycleEventType, id?: string, ...args: T) => void;
75
78
  startPluginsRun(): void;
79
+ waitForPluginsLifecycle(): Promise<void>;
76
80
  finishPluginsRun(): void;
77
81
  get contentDir(): string;
78
82
  loadEnvConfig(replaceEnv?: boolean): void;
@@ -81,7 +85,7 @@ export declare class Store {
81
85
  reloadMarkdocOptions(): Promise<void>;
82
86
  get markdocOptions(): {
83
87
  partials: any;
84
- themeConfig: ({
88
+ themeConfig: {
85
89
  frontMatterKeysToResolve?: string[] | undefined;
86
90
  partialsFolders?: string[] | undefined;
87
91
  lastUpdatedBlock?: {
@@ -98,27 +102,10 @@ export declare class Store {
98
102
  hide?: boolean | undefined;
99
103
  baseUrl?: string | undefined;
100
104
  } | undefined;
101
- } & {
102
- frontMatterKeysToResolve?: string[] | undefined;
103
- partialsFolders?: string[] | undefined;
104
- lastUpdatedBlock?: {
105
- format?: "timeago" | "iso" | "long" | "short" | undefined;
106
- hide?: boolean | undefined;
107
- locale?: string | undefined;
108
- } | undefined;
109
- toc?: {
110
- hide?: boolean | undefined;
111
- header?: string | undefined;
112
- depth?: number | undefined;
113
- } | undefined;
114
- editPage?: {
115
- hide?: boolean | undefined;
116
- baseUrl?: string | undefined;
117
- } | undefined;
118
- }) | undefined;
105
+ } | undefined;
119
106
  tags?: any;
120
- nodes?: any;
121
107
  variables?: Record<string, any> | undefined;
108
+ nodes?: any;
122
109
  functions?: Record<string, import("@markdoc/markdoc").ConfigFunction> | undefined;
123
110
  validation?: {
124
111
  parents?: import("@markdoc/markdoc").Node[] | undefined;
@@ -128,683 +115,26 @@ export declare class Store {
128
115
  };
129
116
  setGlobalData: (data: GlobalData) => void;
130
117
  getGlobalData: () => GlobalData;
131
- parseMarkdoc: (contentRecord: MarkdocRawContent, deps?: MarkdocDeps) => Promise<{
118
+ parseMarkdoc: (input: MarkdownParseInput, context: LifecycleContext, deps?: MarkdocDeps) => Promise<{
132
119
  info: {
133
- sharedDataDeps: Set<string> | undefined;
134
- dynamicMarkdocComponents: string[];
120
+ sharedDataDeps?: Set<string> | undefined;
121
+ dynamicMarkdocComponents?: string[] | undefined;
135
122
  };
136
123
  ast: import("@markdoc/markdoc").Node;
137
124
  }>;
138
- loadOpenApiDefinitions(): Promise<import("./plugins/openapi-docs/load-definition").BundledDefinition[]>;
125
+ loadOpenApiDefinitions(context: LifecycleContext): Promise<BundledDefinition[]>;
139
126
  setSearchDataWithLocales(data: SearchDataWithLocales): void;
140
127
  setSearchData(data: SearchData, locale?: string): void;
141
128
  setSearchIndexReady(): void;
142
129
  setCliOptions(data: Record<string, string>): void;
143
130
  setGlobalConfig: (data: Partial<RedoclyConfig>) => void;
144
- getConfig: <T = {
145
- [x: string]: unknown;
146
- imports?: string[] | undefined;
147
- logo?: {
148
- image?: string | undefined;
149
- srcSet?: string | undefined;
150
- altText?: string | undefined;
151
- link?: string | undefined;
152
- favicon?: string | undefined;
153
- } | undefined;
154
- navbar?: {
155
- items?: {
156
- [x: string]: unknown;
157
- items?: {
158
- [x: string]: unknown;
159
- items?: {
160
- [x: string]: unknown;
161
- }[] | undefined;
162
- separatorLine?: boolean | undefined;
163
- linePosition?: "top" | "bottom" | undefined;
164
- page?: string | undefined;
165
- directory?: string | undefined;
166
- disconnect?: boolean | undefined;
167
- group?: string | undefined;
168
- label?: string | undefined;
169
- href?: string | undefined;
170
- external?: boolean | undefined;
171
- labelTranslationKey?: string | undefined;
172
- groupTranslationKey?: string | undefined;
173
- icon?: string | {
174
- [x: string]: unknown;
175
- srcSet: string;
176
- } | undefined;
177
- separator?: string | undefined;
178
- version?: string | undefined;
179
- menuStyle?: "drilldown" | undefined;
180
- expanded?: "always" | undefined;
181
- selectFirstItemOnExpand?: boolean | undefined;
182
- flatten?: boolean | undefined;
183
- linkedSidebars?: string[] | undefined;
184
- }[] | undefined;
185
- separatorLine?: boolean | undefined;
186
- linePosition?: "top" | "bottom" | undefined;
187
- page?: string | undefined;
188
- directory?: string | undefined;
189
- disconnect?: boolean | undefined;
190
- group?: string | undefined;
191
- label?: string | undefined;
192
- href?: string | undefined;
193
- external?: boolean | undefined;
194
- labelTranslationKey?: string | undefined;
195
- groupTranslationKey?: string | undefined;
196
- icon?: string | {
197
- [x: string]: unknown;
198
- srcSet: string;
199
- } | undefined;
200
- separator?: string | undefined;
201
- version?: string | undefined;
202
- menuStyle?: "drilldown" | undefined;
203
- expanded?: "always" | undefined;
204
- selectFirstItemOnExpand?: boolean | undefined;
205
- flatten?: boolean | undefined;
206
- linkedSidebars?: string[] | undefined;
207
- }[] | undefined;
208
- hide?: boolean | undefined;
209
- } | undefined;
210
- products?: {
211
- [x: string]: {
212
- icon?: string | undefined;
213
- name: string;
214
- folder: string;
215
- };
216
- } | undefined;
217
- footer?: {
218
- items?: {
219
- [x: string]: unknown;
220
- items?: {
221
- [x: string]: unknown;
222
- items?: {
223
- [x: string]: unknown;
224
- }[] | undefined;
225
- separatorLine?: boolean | undefined;
226
- linePosition?: "top" | "bottom" | undefined;
227
- page?: string | undefined;
228
- directory?: string | undefined;
229
- disconnect?: boolean | undefined;
230
- group?: string | undefined;
231
- label?: string | undefined;
232
- href?: string | undefined;
233
- external?: boolean | undefined;
234
- labelTranslationKey?: string | undefined;
235
- groupTranslationKey?: string | undefined;
236
- icon?: string | {
237
- [x: string]: unknown;
238
- srcSet: string;
239
- } | undefined;
240
- separator?: string | undefined;
241
- version?: string | undefined;
242
- menuStyle?: "drilldown" | undefined;
243
- expanded?: "always" | undefined;
244
- selectFirstItemOnExpand?: boolean | undefined;
245
- flatten?: boolean | undefined;
246
- linkedSidebars?: string[] | undefined;
247
- }[] | undefined;
248
- separatorLine?: boolean | undefined;
249
- linePosition?: "top" | "bottom" | undefined;
250
- page?: string | undefined;
251
- directory?: string | undefined;
252
- disconnect?: boolean | undefined;
253
- group?: string | undefined;
254
- label?: string | undefined;
255
- href?: string | undefined;
256
- external?: boolean | undefined;
257
- labelTranslationKey?: string | undefined;
258
- groupTranslationKey?: string | undefined;
259
- icon?: string | {
260
- [x: string]: unknown;
261
- srcSet: string;
262
- } | undefined;
263
- separator?: string | undefined;
264
- version?: string | undefined;
265
- menuStyle?: "drilldown" | undefined;
266
- expanded?: "always" | undefined;
267
- selectFirstItemOnExpand?: boolean | undefined;
268
- flatten?: boolean | undefined;
269
- linkedSidebars?: string[] | undefined;
270
- }[] | undefined;
271
- logo?: {
272
- hide?: boolean | undefined;
273
- } | undefined;
274
- hide?: boolean | undefined;
275
- copyrightText?: string | undefined;
276
- } | undefined;
277
- sidebar?: {
278
- hide?: boolean | undefined;
279
- separatorLine?: boolean | undefined;
280
- linePosition?: "top" | "bottom" | undefined;
281
- } | undefined;
282
- scripts?: {
283
- head?: {
284
- [x: string]: unknown;
285
- type?: string | undefined;
286
- async?: boolean | undefined;
287
- crossorigin?: string | undefined;
288
- defer?: boolean | undefined;
289
- fetchpriority?: string | undefined;
290
- integrity?: string | undefined;
291
- module?: boolean | undefined;
292
- nomodule?: boolean | undefined;
293
- nonce?: string | undefined;
294
- referrerpolicy?: string | undefined;
295
- src: string;
296
- }[] | undefined;
297
- body?: {
298
- [x: string]: unknown;
299
- type?: string | undefined;
300
- async?: boolean | undefined;
301
- crossorigin?: string | undefined;
302
- defer?: boolean | undefined;
303
- fetchpriority?: string | undefined;
304
- integrity?: string | undefined;
305
- module?: boolean | undefined;
306
- nomodule?: boolean | undefined;
307
- nonce?: string | undefined;
308
- referrerpolicy?: string | undefined;
309
- src: string;
310
- }[] | undefined;
311
- } | undefined;
312
- links?: {
313
- [x: string]: unknown;
314
- type?: string | undefined;
315
- title?: string | undefined;
316
- crossorigin?: string | undefined;
317
- fetchpriority?: string | undefined;
318
- integrity?: string | undefined;
319
- referrerpolicy?: string | undefined;
320
- as?: string | undefined;
321
- hreflang?: string | undefined;
322
- imagesizes?: string | undefined;
323
- imagesrcset?: string | undefined;
324
- media?: string | undefined;
325
- prefetch?: string | undefined;
326
- rel?: string | undefined;
327
- sizes?: string | undefined;
328
- href: string;
329
- }[] | undefined;
330
- feedback?: {
331
- type?: "rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale" | undefined;
332
- hide?: boolean | undefined;
333
- settings?: {
334
- items?: string[] | undefined;
335
- label?: string | undefined;
336
- comment?: {
337
- hide?: boolean | undefined;
338
- label?: string | undefined;
339
- likeLabel?: string | undefined;
340
- dislikeLabel?: string | undefined;
341
- satisfiedLabel?: string | undefined;
342
- neutralLabel?: string | undefined;
343
- dissatisfiedLabel?: string | undefined;
344
- } | undefined;
345
- reasons?: {
346
- items?: string[] | undefined;
347
- hide?: boolean | undefined;
348
- label?: string | undefined;
349
- component?: "radio" | "checkbox" | undefined;
350
- } | undefined;
351
- submitText?: string | undefined;
352
- buttonText?: string | undefined;
353
- component?: "radio" | "checkbox" | undefined;
354
- leftScaleLabel?: string | undefined;
355
- rightScaleLabel?: string | undefined;
356
- } | undefined;
357
- } | undefined;
358
- search?: {
359
- hide?: boolean | undefined;
360
- placement?: string | undefined;
361
- shortcuts?: string[] | undefined;
362
- suggestedPages?: {
363
- [x: string]: unknown;
364
- label?: string | undefined;
365
- labelTranslationKey?: string | undefined;
366
- page: string;
367
- }[] | undefined;
368
- fuzzy?: boolean | undefined;
369
- } | undefined;
370
- colorMode?: {
371
- hide?: boolean | undefined;
372
- ignoreDetection?: boolean | undefined;
373
- modes?: string[] | undefined;
374
- } | undefined;
375
- navigation?: {
376
- nextButton?: {
377
- hide?: boolean | undefined;
378
- text?: string | undefined;
379
- } | undefined;
380
- previousButton?: {
381
- hide?: boolean | undefined;
382
- text?: string | undefined;
383
- } | undefined;
384
- } | undefined;
385
- codeSnippet?: {
386
- elementFormat?: string | undefined;
387
- copy?: {
388
- hide?: boolean | undefined;
389
- } | undefined;
390
- report?: {
391
- hide?: boolean | undefined;
392
- label?: string | undefined;
393
- buttonText?: string | undefined;
394
- tooltipText?: string | undefined;
395
- } | undefined;
396
- expand?: {
397
- hide?: boolean | undefined;
398
- } | undefined;
399
- collapse?: {
400
- hide?: boolean | undefined;
401
- } | undefined;
402
- } | undefined;
403
- markdown?: {
404
- frontMatterKeysToResolve?: string[] | undefined;
405
- partialsFolders?: string[] | undefined;
406
- lastUpdatedBlock?: {
407
- format?: "timeago" | "iso" | "long" | "short" | undefined;
408
- hide?: boolean | undefined;
409
- locale?: string | undefined;
410
- } | undefined;
411
- toc?: {
412
- hide?: boolean | undefined;
413
- header?: string | undefined;
414
- depth?: number | undefined;
415
- } | undefined;
416
- editPage?: {
417
- hide?: boolean | undefined;
418
- baseUrl?: string | undefined;
419
- } | undefined;
420
- } | undefined;
421
- openapi?: {
422
- feedback?: {
423
- type?: "rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale" | undefined;
424
- hide?: boolean | undefined;
425
- settings?: {
426
- items?: string[] | undefined;
427
- label?: string | undefined;
428
- comment?: {
429
- hide?: boolean | undefined;
430
- label?: string | undefined;
431
- likeLabel?: string | undefined;
432
- dislikeLabel?: string | undefined;
433
- satisfiedLabel?: string | undefined;
434
- neutralLabel?: string | undefined;
435
- dissatisfiedLabel?: string | undefined;
436
- } | undefined;
437
- reasons?: {
438
- items?: string[] | undefined;
439
- hide?: boolean | undefined;
440
- label?: string | undefined;
441
- component?: "radio" | "checkbox" | undefined;
442
- } | undefined;
443
- submitText?: string | undefined;
444
- buttonText?: string | undefined;
445
- component?: "radio" | "checkbox" | undefined;
446
- leftScaleLabel?: string | undefined;
447
- rightScaleLabel?: string | undefined;
448
- } | undefined;
449
- } | null | undefined;
450
- licenseKey?: string | undefined;
451
- hideLoading?: boolean | undefined;
452
- disableRouter?: boolean | undefined;
453
- hideSidebar?: boolean | undefined;
454
- hideReplay?: boolean | undefined;
455
- oAuth2RedirectURI?: string | null | undefined;
456
- corsProxyUrl?: string | undefined;
457
- sortRequiredPropsFirst?: boolean | undefined;
458
- sanitize?: boolean | undefined;
459
- hideDownloadButtons?: boolean | undefined;
460
- downloadUrls?: {
461
- title?: string | undefined;
462
- url: string;
463
- }[] | undefined;
464
- onlyRequiredInSamples?: boolean | undefined;
465
- generatedSamplesMaxDepth?: string | number | undefined;
466
- showExtensions?: string | boolean | string[] | undefined;
467
- hideSchemaTitles?: boolean | undefined;
468
- jsonSamplesExpandLevel?: string | number | undefined;
469
- schemasExpansionLevel?: string | number | undefined;
470
- mockServer?: {
471
- [x: string]: unknown;
472
- description?: string | undefined;
473
- url?: string | undefined;
474
- position?: "first" | "last" | "replace" | "off" | undefined;
475
- } | undefined;
476
- maxDisplayedEnumValues?: number | undefined;
477
- schemaDefinitionsTagName?: string | undefined;
478
- layout?: "stacked" | "three-panel" | undefined;
479
- hideInfoMetadata?: boolean | undefined;
480
- events?: {
481
- [x: string]: unknown;
482
- } | undefined;
483
- skipBundle?: boolean | undefined;
484
- routingBasePath?: string | undefined;
485
- codeSamples?: {
486
- skipOptionalParameters?: boolean | undefined;
487
- withOAuth2Call?: boolean | undefined;
488
- languages: {
489
- label?: string | undefined;
490
- options?: {
491
- indent?: string | undefined;
492
- withImports?: boolean | undefined;
493
- withComments?: boolean | undefined;
494
- binary?: boolean | undefined;
495
- credentials?: "omit" | "same-origin" | "include" | undefined;
496
- } | undefined;
497
- lang: "curl" | "JavaScript" | "Node.js" | "Python" | "Java8+Apache" | "Java" | "C#" | "C#+Newtonsoft" | "PHP" | "Go" | "Ruby" | "R" | "Payload";
498
- }[];
499
- } | undefined;
500
- ignoreNamedSchemas?: string | string[] | undefined;
501
- hidePropertiesPrefix?: boolean | undefined;
502
- excludeFromSearch?: boolean | undefined;
503
- } | undefined;
504
- graphql?: {
505
- sidebar?: {
506
- [x: string]: unknown;
507
- hide?: boolean | undefined;
508
- } | undefined;
509
- feedback?: {
510
- type?: "rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale" | undefined;
511
- hide?: boolean | undefined;
512
- settings?: {
513
- items?: string[] | undefined;
514
- label?: string | undefined;
515
- comment?: {
516
- hide?: boolean | undefined;
517
- label?: string | undefined;
518
- likeLabel?: string | undefined;
519
- dislikeLabel?: string | undefined;
520
- satisfiedLabel?: string | undefined;
521
- neutralLabel?: string | undefined;
522
- dissatisfiedLabel?: string | undefined;
523
- } | undefined;
524
- reasons?: {
525
- items?: string[] | undefined;
526
- hide?: boolean | undefined;
527
- label?: string | undefined;
528
- component?: "radio" | "checkbox" | undefined;
529
- } | undefined;
530
- submitText?: string | undefined;
531
- buttonText?: string | undefined;
532
- component?: "radio" | "checkbox" | undefined;
533
- leftScaleLabel?: string | undefined;
534
- rightScaleLabel?: string | undefined;
535
- } | undefined;
536
- } | null | undefined;
537
- navigation?: {
538
- [x: string]: unknown;
539
- contentPrefix?: string | undefined;
540
- menuPrefix?: string | undefined;
541
- } | undefined;
542
- licenseKey?: string | undefined;
543
- jsonSamplesExpandLevel?: number | undefined;
544
- pagination?: "none" | "section" | "item" | undefined;
545
- hidePaginationButtons?: boolean | undefined;
546
- menu?: {
547
- requireExactGroups?: boolean | undefined;
548
- groups?: {
549
- items?: {
550
- includeByName?: string[] | undefined;
551
- excludeByName?: string[] | undefined;
552
- } | undefined;
553
- queries?: {
554
- includeByName?: string[] | undefined;
555
- excludeByName?: string[] | undefined;
556
- } | undefined;
557
- mutations?: {
558
- includeByName?: string[] | undefined;
559
- excludeByName?: string[] | undefined;
560
- } | undefined;
561
- subscriptions?: {
562
- includeByName?: string[] | undefined;
563
- excludeByName?: string[] | undefined;
564
- } | undefined;
565
- types?: {
566
- includeByName?: string[] | undefined;
567
- excludeByName?: string[] | undefined;
568
- } | undefined;
569
- directives?: {
570
- includeByName?: string[] | undefined;
571
- excludeByName?: string[] | undefined;
572
- } | undefined;
573
- name: string;
574
- }[] | undefined;
575
- otherItemsGroupName?: string | undefined;
576
- initialLoadState?: "default" | "all-expanded" | undefined;
577
- } | undefined;
578
- apiLogo?: {
579
- [x: string]: unknown;
580
- altText?: string | undefined;
581
- href?: string | undefined;
582
- imageUrl?: string | undefined;
583
- backgroundColor?: string | undefined;
584
- } | undefined;
585
- sampleMaxInlineArgs?: number | undefined;
586
- fieldExpandLevel?: number | undefined;
587
- baseUrlPath?: string | undefined;
588
- } | undefined;
589
- analytics?: {
590
- [x: string]: unknown;
591
- adobe?: {
592
- includeInDevelopment?: boolean | undefined;
593
- pageViewEventName?: string | undefined;
594
- scriptUrl: string;
595
- } | undefined;
596
- amplitude?: {
597
- head?: boolean | undefined;
598
- includeInDevelopment?: boolean | undefined;
599
- pageViewEventName?: string | undefined;
600
- respectDNT?: boolean | undefined;
601
- exclude?: string[] | undefined;
602
- outboundClickEventName?: string | undefined;
603
- amplitudeConfig?: {
604
- [x: string]: unknown;
605
- } | undefined;
606
- apiKey: string;
607
- } | undefined;
608
- fullstory?: {
609
- includeInDevelopment?: boolean | undefined;
610
- orgId: string;
611
- } | undefined;
612
- heap?: {
613
- includeInDevelopment?: boolean | undefined;
614
- appId: string;
615
- } | undefined;
616
- rudderstack?: {
617
- includeInDevelopment?: boolean | undefined;
618
- trackPage?: boolean | undefined;
619
- dataPlaneUrl?: string | undefined;
620
- controlPlaneUrl?: string | undefined;
621
- sdkUrl?: string | undefined;
622
- loadOptions?: {
623
- [x: string]: unknown;
624
- } | undefined;
625
- writeKey: string;
626
- } | undefined;
627
- segment?: {
628
- includeInDevelopment?: boolean | undefined;
629
- trackPage?: boolean | undefined;
630
- includeTitleInPageCall?: boolean | undefined;
631
- host?: string | undefined;
632
- writeKey: string;
633
- } | undefined;
634
- gtm?: {
635
- includeInDevelopment?: boolean | undefined;
636
- pageViewEventName?: string | undefined;
637
- gtmAuth?: string | undefined;
638
- gtmPreview?: string | undefined;
639
- defaultDataLayer?: unknown;
640
- dataLayerName?: string | undefined;
641
- enableWebVitalsTracking?: boolean | undefined;
642
- selfHostedOrigin?: string | undefined;
643
- trackingId: string;
644
- } | undefined;
645
- ga?: {
646
- head?: boolean | undefined;
647
- includeInDevelopment?: boolean | undefined;
648
- respectDNT?: boolean | undefined;
649
- exclude?: string[] | undefined;
650
- conversionId?: string | undefined;
651
- floodlightId?: string | undefined;
652
- optimizeId?: string | undefined;
653
- anonymizeIp?: boolean | undefined;
654
- cookieExpires?: number | undefined;
655
- trackers?: {
656
- [x: string]: {
657
- includeInDevelopment?: boolean | undefined;
658
- exclude?: string[] | undefined;
659
- conversionId?: string | undefined;
660
- floodlightId?: string | undefined;
661
- optimizeId?: string | undefined;
662
- trackingId: string;
663
- };
664
- } | undefined;
665
- trackingId: string;
666
- } | undefined;
667
- } | undefined;
668
- userMenu?: {
669
- items?: {
670
- [x: string]: unknown;
671
- link?: string | undefined;
672
- separatorLine?: boolean | undefined;
673
- label?: string | undefined;
674
- external?: boolean | undefined;
675
- }[] | undefined;
676
- hide?: boolean | undefined;
677
- hideLoginButton?: boolean | undefined;
678
- } | undefined;
679
- versionPicker?: {
680
- [x: string]: unknown;
681
- hide?: boolean | undefined;
682
- showForUnversioned?: boolean | undefined;
683
- } | undefined;
684
- breadcrumbs?: {
685
- hide?: boolean | undefined;
686
- prefixItems?: {
687
- page?: string | undefined;
688
- label?: string | undefined;
689
- labelTranslationKey?: string | undefined;
690
- }[] | undefined;
691
- } | undefined;
692
- catalog?: {
693
- [x: string]: {
694
- [x: string]: unknown;
695
- title?: string | undefined;
696
- description?: string | undefined;
697
- filters?: {
698
- type?: "select" | "checkboxes" | "date-range" | undefined;
699
- options?: string[] | undefined;
700
- titleTranslationKey?: string | undefined;
701
- parentFilter?: string | undefined;
702
- valuesMapping?: {
703
- [x: string]: string;
704
- } | undefined;
705
- missingCategoryName?: string | undefined;
706
- missingCategoryNameTranslationKey?: string | undefined;
707
- title: string;
708
- property: string;
709
- }[] | undefined;
710
- groupByFirstFilter?: boolean | undefined;
711
- filterValuesCasing?: "sentence" | "original" | "lowercase" | "uppercase" | undefined;
712
- requiredPermission?: string | undefined;
713
- separateVersions?: boolean | undefined;
714
- titleTranslationKey?: string | undefined;
715
- descriptionTranslationKey?: string | undefined;
716
- items: {
717
- [x: string]: unknown;
718
- items?: {
719
- [x: string]: unknown;
720
- items?: {
721
- [x: string]: unknown;
722
- }[] | undefined;
723
- separatorLine?: boolean | undefined;
724
- linePosition?: "top" | "bottom" | undefined;
725
- page?: string | undefined;
726
- directory?: string | undefined;
727
- disconnect?: boolean | undefined;
728
- group?: string | undefined;
729
- label?: string | undefined;
730
- href?: string | undefined;
731
- external?: boolean | undefined;
732
- labelTranslationKey?: string | undefined;
733
- groupTranslationKey?: string | undefined;
734
- icon?: string | {
735
- [x: string]: unknown;
736
- srcSet: string;
737
- } | undefined;
738
- separator?: string | undefined;
739
- version?: string | undefined;
740
- menuStyle?: "drilldown" | undefined;
741
- expanded?: "always" | undefined;
742
- selectFirstItemOnExpand?: boolean | undefined;
743
- flatten?: boolean | undefined;
744
- linkedSidebars?: string[] | undefined;
745
- }[] | undefined;
746
- separatorLine?: boolean | undefined;
747
- linePosition?: "top" | "bottom" | undefined;
748
- page?: string | undefined;
749
- directory?: string | undefined;
750
- disconnect?: boolean | undefined;
751
- group?: string | undefined;
752
- label?: string | undefined;
753
- href?: string | undefined;
754
- external?: boolean | undefined;
755
- labelTranslationKey?: string | undefined;
756
- groupTranslationKey?: string | undefined;
757
- icon?: string | {
758
- [x: string]: unknown;
759
- srcSet: string;
760
- } | undefined;
761
- separator?: string | undefined;
762
- version?: string | undefined;
763
- menuStyle?: "drilldown" | undefined;
764
- expanded?: "always" | undefined;
765
- selectFirstItemOnExpand?: boolean | undefined;
766
- flatten?: boolean | undefined;
767
- linkedSidebars?: string[] | undefined;
768
- }[];
769
- slug: string;
770
- };
771
- } | undefined;
772
- scorecard?: {
773
- [x: string]: unknown;
774
- ignoreNonCompliant?: boolean | undefined;
775
- teamMetadataProperty?: {
776
- [x: string]: unknown;
777
- default?: string | undefined;
778
- label?: string | undefined;
779
- property?: string | undefined;
780
- } | undefined;
781
- levels?: {
782
- color?: string | undefined;
783
- extends?: string[] | undefined;
784
- rules?: {
785
- [x: string]: string | {
786
- [x: string]: unknown;
787
- };
788
- } | undefined;
789
- name: string;
790
- }[] | undefined;
791
- targets?: {
792
- minimumLevel?: string | undefined;
793
- where: {
794
- metadata: {
795
- [x: string]: string;
796
- };
797
- };
798
- }[] | undefined;
799
- } | undefined;
800
- }>() => RedoclyConfig<T>;
131
+ getConfig: <T = ThemeConfig>() => RedoclyConfig<T>;
801
132
  getGlobalConfig: <T = unknown>(key: string) => T;
802
133
  addRedirect(from: string, to: RedirectConfig): void;
803
- createSharedData: (id: string, data: unknown) => Promise<string>;
134
+ createSharedData: (id: string, data: unknown, hash?: string) => Promise<string>;
804
135
  addRouteSharedData: (routeSlug: string, dataKey: string, dataId: string) => void;
805
- addRoute: (route: PageRouteDetails) => void;
806
- addRouteToAllLocales: (route: PageRouteDetails, contentProvider: ContentProvider) => void;
807
- addRouteSharedDataToAllLocales: (slug: string, dataKey: string, dataId: string, contentProvider: ContentProvider) => void;
136
+ addRoute: (route: PageRouteInit) => void;
137
+ addRouteSharedDataToAllLocales: (slug: string, dataKey: string, dataId: string) => void;
808
138
  addApiRoute: (route: ApiRouteDetails) => void;
809
139
  addMiddleware: (middleware: MiddlewareDetails) => void;
810
140
  addCustomSsoProvider: (providerDetails: CustomSsoProviderDetails) => void;
@@ -813,7 +143,7 @@ export declare class Store {
813
143
  getRouteBySlug: (slug: string, opts?: {
814
144
  followRedirect?: boolean;
815
145
  }) => PageRouteDetails | undefined;
816
- getAllRoutesForLocale: (locale?: string, nonDefaultLocales?: string[]) => PageRouteDetails<PageStaticData, import("@redocly/config/lib/portal-shared-types").PageProps>[];
146
+ getAllRoutesForLocale: (locale?: string) => PageRouteDetails<PageStaticData, import("@redocly/config/lib/portal-shared-types").PageProps>[];
817
147
  getAllRoutes: () => PageRouteDetails<PageStaticData, import("@redocly/config/lib/portal-shared-types").PageProps>[];
818
148
  getApiRouteBySlug: (slug: string) => ApiRouteDetails<PageStaticData> | undefined;
819
149
  getAllApiRoutes: () => ApiRouteDetails<PageStaticData>[];
@@ -824,8 +154,8 @@ export declare class Store {
824
154
  addBrowserPlugin: (importPath: string) => void;
825
155
  createRequestHandler: (id: string, importPath: string) => string;
826
156
  registerServerPropsGetter: (id: string, importPath: string) => string;
827
- writeRouteStaticData(route: RouteDetails, contentProvider: ContentProvider): Promise<void>;
828
- resolveRouteStaticData(route: RouteDetails, contentProvider: ContentProvider, skipLastModified?: boolean): Promise<PageStaticData>;
157
+ writeRouteStaticData(route: RouteDetails, context: LifecycleContext): Promise<void>;
158
+ resolveRouteStaticData(route: RouteDetails, _context?: LifecycleContext, skipLastModified?: boolean): Promise<PageStaticData>;
829
159
  addSsrComponents(components: JSX.Element[] | string[], position: 'head' | 'preBody' | 'postBody'): void;
830
160
  clear: () => void;
831
161
  toJson(): {