@redocly/framework 1.0.0-next.6 → 1.0.0-next.8

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 (189) hide show
  1. package/dist/bundler/build/output-metadata.js +1 -1
  2. package/dist/bundler/build/run.js +1 -1
  3. package/dist/bundler/dev/dev-content-build.js +1 -0
  4. package/dist/bundler/dev/dev-problems.js +1 -1
  5. package/dist/bundler/dev/dev-reporter.js +1 -1
  6. package/dist/bundler/dev/routes/dev-content-build-route.js +1 -0
  7. package/dist/bundler/dev/routes/dev-problems-route.js +1 -1
  8. package/dist/bundler/dev/run.js +1 -1
  9. package/dist/bundler/dev/runtime-app.js +1 -1
  10. package/dist/cli/args.js +1 -1
  11. package/dist/cli/commands/build.js +1 -1
  12. package/dist/cli/commands/ingest.js +1 -1
  13. package/dist/cli/commands/translate.js +1 -1
  14. package/dist/cli/dev-console/{sweep.js → content-build.js} +1 -1
  15. package/dist/cli/dev-console/index.js +1 -1
  16. package/dist/cli/dev-console/lines.js +2 -2
  17. package/dist/cli/dev-console/plain.js +1 -1
  18. package/dist/cli/dev-console/tui.js +2 -2
  19. package/dist/cli/validate-react-pages.js +1 -1
  20. package/dist/client/app.js +2 -7
  21. package/dist/client/client-entry.js +1 -1
  22. package/dist/client/dev-problems/ProblemsBar.js +75 -15
  23. package/dist/client/dev-problems/build-segment.js +1 -0
  24. package/dist/client/dev-problems/index.js +1 -1
  25. package/dist/client/dev-problems/use-dev-problems.js +1 -1
  26. package/dist/client/review/ReviewBar.js +163 -69
  27. package/dist/client/review/login-url.js +1 -0
  28. package/dist/client/use-bar-position.js +1 -0
  29. package/dist/client/use-page-versions.js +1 -1
  30. package/dist/client/use-search.js +1 -1
  31. package/dist/content-layer/api-outputs.js +1 -1
  32. package/dist/content-layer/config-schema.js +1 -1
  33. package/dist/content-layer/config.d.ts +2 -1
  34. package/dist/content-layer/config.js +1 -1
  35. package/dist/content-layer/database/files.js +1 -1
  36. package/dist/content-layer/database/finalize.js +1 -1
  37. package/dist/content-layer/database/origins.js +1 -1
  38. package/dist/content-layer/database/problems.d.ts +2 -0
  39. package/dist/content-layer/database/problems.js +1 -1
  40. package/dist/content-layer/database/reset.js +1 -1
  41. package/dist/content-layer/database/schema.d.ts +17 -0
  42. package/dist/content-layer/database/schema.js +1 -1
  43. package/dist/content-layer/ingest/finalize-phase.js +1 -1
  44. package/dist/content-layer/ingest/git-last-modified.js +3 -3
  45. package/dist/content-layer/ingest/hash.js +1 -1
  46. package/dist/content-layer/ingest/run.js +1 -1
  47. package/dist/content-layer/ingest/search-sync.js +1 -1
  48. package/dist/content-layer/ingest/sync.js +1 -1
  49. package/dist/content-layer/link-checker/delta.js +1 -1
  50. package/dist/content-layer/link-checker/fingerprint.js +1 -1
  51. package/dist/content-layer/link-checker/load-view.js +1 -1
  52. package/dist/content-layer/link-checker/run-build.js +1 -1
  53. package/dist/content-layer/link-checker/validate.js +1 -1
  54. package/dist/content-layer/link-checker/view.js +1 -1
  55. package/dist/content-layer/loaders/context.js +1 -1
  56. package/dist/content-layer/loaders/define.d.ts +3 -0
  57. package/dist/content-layer/markdown/client/JsonSchemaTag.js +1 -1
  58. package/dist/content-layer/markdown/client/code-highlight-notation.js +3 -3
  59. package/dist/content-layer/markdown/client/markdoc-components.js +2 -2
  60. package/dist/content-layer/markdown/resolve/audience-tag.d.ts +1 -5
  61. package/dist/content-layer/markdown/resolve/audience-tag.js +1 -1
  62. package/dist/content-layer/markdown/resolve/markdoc-resolvers/json-schema.js +1 -1
  63. package/dist/content-layer/markdown/resolve/markdoc-resolvers/operation-samples.js +1 -1
  64. package/dist/content-layer/markdown/resolve/references.js +1 -1
  65. package/dist/content-layer/markdown/search/to-sections.d.ts +1 -1
  66. package/dist/content-layer/markdown/search/to-sections.js +1 -1
  67. package/dist/content-layer/markdown/tags/html.d.ts +2 -2
  68. package/dist/content-layer/markdown/tags/html.js +1 -1
  69. package/dist/content-layer/markdown/tags/openapi.js +1 -1
  70. package/dist/content-layer/materialization/entity.js +1 -1
  71. package/dist/content-layer/materialization/static-files.js +1 -1
  72. package/dist/content-layer/plugins/internal/api-docs/client/event-handlers.js +1 -1
  73. package/dist/content-layer/plugins/internal/api-docs/client/template.js +11 -3
  74. package/dist/content-layer/plugins/internal/api-docs/index.js +1 -1
  75. package/dist/content-layer/plugins/internal/api-docs/server/build-definition.d.ts +21 -11
  76. package/dist/content-layer/plugins/internal/api-docs/server/build-definition.js +1 -1
  77. package/dist/content-layer/plugins/internal/api-docs/server/build-sidebar.js +1 -1
  78. package/dist/content-layer/plugins/internal/api-docs/server/markdown-decorator.d.ts +1 -4
  79. package/dist/content-layer/plugins/internal/api-docs/server/markdown-decorator.js +1 -1
  80. package/dist/content-layer/plugins/internal/api-docs/server/markdown-docs.js +14 -14
  81. package/dist/content-layer/plugins/internal/api-docs/server/spec-download.js +1 -1
  82. package/dist/content-layer/plugins/internal/api-functions/server/access.js +1 -1
  83. package/dist/content-layer/plugins/internal/api-functions/server/dispatch.js +1 -1
  84. package/dist/content-layer/plugins/internal/app-data/index.d.ts +1 -1
  85. package/dist/content-layer/plugins/internal/app-data/index.js +1 -1
  86. package/dist/content-layer/plugins/internal/markdoc/index.js +1 -1
  87. package/dist/content-layer/plugins/internal/mcp/constants.d.ts +17 -0
  88. package/dist/content-layer/plugins/internal/mcp/constants.js +1 -1
  89. package/dist/content-layer/plugins/internal/mcp/content-tools.js +1 -1
  90. package/dist/content-layer/plugins/internal/mcp/server/agent-card.js +1 -1
  91. package/dist/content-layer/plugins/internal/mcp/server/audit.js +1 -1
  92. package/dist/content-layer/plugins/internal/mcp/server/auth.js +1 -1
  93. package/dist/content-layer/plugins/internal/mcp/server/codemode/capabilities.js +6 -6
  94. package/dist/content-layer/plugins/internal/mcp/server/codemode/constants.js +1 -1
  95. package/dist/content-layer/plugins/internal/mcp/server/codemode/discover.js +1 -1
  96. package/dist/content-layer/plugins/internal/mcp/server/codemode/prompts.js +8 -8
  97. package/dist/content-layer/plugins/internal/mcp/server/custom-tools.js +1 -1
  98. package/dist/content-layer/plugins/internal/mcp/server/gateway/allowed-http-methods.js +1 -1
  99. package/dist/content-layer/plugins/internal/mcp/server/gateway/api-call-operations.js +1 -1
  100. package/dist/content-layer/plugins/internal/mcp/server/gateway/call-api.js +2 -0
  101. package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials-page/form-page.js +10 -10
  102. package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials-page/outcome-pages.js +1 -1
  103. package/dist/content-layer/plugins/internal/mcp/server/gateway/credentials.js +1 -1
  104. package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/fetch-bridge.js +1 -1
  105. package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/ssrf-guard.js +1 -1
  106. package/dist/content-layer/plugins/internal/mcp/server/gateway/fetch/upstream-detail.js +1 -1
  107. package/dist/content-layer/plugins/internal/mcp/server/gateway/index.js +3 -3
  108. package/dist/content-layer/plugins/internal/mcp/server/gateway/tool-list.js +1 -0
  109. package/dist/content-layer/plugins/internal/mcp/server/gateway/tools.js +4 -4
  110. package/dist/content-layer/plugins/internal/mcp/server/gateway/upstream-auth-scheme.js +1 -1
  111. package/dist/content-layer/plugins/internal/mcp/server/handler.js +1 -1
  112. package/dist/content-layer/plugins/internal/mcp/server/mcp-server.js +1 -1
  113. package/dist/content-layer/plugins/internal/mcp/server/mcp-telemetry.js +1 -1
  114. package/dist/content-layer/plugins/internal/mcp/server/oauth/authorize.js +1 -1
  115. package/dist/content-layer/plugins/internal/mcp/server/oauth/callback.js +1 -1
  116. package/dist/content-layer/plugins/internal/mcp/server/oauth/discovery.js +1 -1
  117. package/dist/content-layer/plugins/internal/mcp/server/oauth/token.js +1 -1
  118. package/dist/content-layer/plugins/internal/mcp/server/oauth/tokens.js +1 -1
  119. package/dist/content-layer/plugins/internal/mcp/server/server-card.js +1 -1
  120. package/dist/content-layer/plugins/internal/mcp/server/skills-resources.js +1 -1
  121. package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-catalog.js +1 -1
  122. package/dist/content-layer/plugins/internal/mcp/server/tools/openapi-document.js +1 -1
  123. package/dist/content-layer/plugins/internal/mcp/server/tools/openapi.js +1 -1
  124. package/dist/content-layer/plugins/internal/mcp/server/tools/pages.js +2 -2
  125. package/dist/content-layer/plugins/internal/mcp/server/tools/schemas.js +1 -1
  126. package/dist/content-layer/plugins/internal/mock/server/handler.js +1 -1
  127. package/dist/content-layer/plugins/internal/sidebar/index.d.ts +2 -1
  128. package/dist/content-layer/plugins/internal/sidebar/index.js +1 -1
  129. package/dist/content-layer/plugins/internal/sidebar/subtree.js +1 -1
  130. package/dist/content-layer/plugins/internal/skills/server/routes.js +1 -1
  131. package/dist/content-layer/plugins/types/markdoc.d.ts +2 -0
  132. package/dist/content-layer/plugins/utils/route-index.js +1 -1
  133. package/dist/content-layer/problems/codes.js +1 -1
  134. package/dist/content-layer/search/postings/fragment-field.d.ts +2 -0
  135. package/dist/content-layer/search/postings/fragment-field.js +1 -1
  136. package/dist/content-layer/search/postings/postings-store.js +1 -1
  137. package/dist/content-layer/server/database.js +1 -1
  138. package/dist/content-layer/static/registry.js +1 -1
  139. package/dist/content-layer/versions/version-groups.d.ts +5 -1
  140. package/dist/content-layer/versions/version-groups.js +1 -1
  141. package/dist/server/app.js +3 -3
  142. package/dist/server/ask-ai/route.js +1 -1
  143. package/dist/server/auth/access-config.js +1 -1
  144. package/dist/server/auth/gate.js +1 -1
  145. package/dist/server/auth/middleware.js +1 -1
  146. package/dist/server/auth/oidc.js +1 -1
  147. package/dist/server/auth/routes.js +1 -1
  148. package/dist/server/content.js +9 -9
  149. package/dist/server/lambda-entry.js +1 -1
  150. package/dist/server/node-entry.js +1 -1
  151. package/dist/server/page-handlers.js +2 -2
  152. package/dist/server/redirects.js +1 -1
  153. package/dist/server/review/route.js +1 -1
  154. package/dist/server/search/route.js +1 -1
  155. package/dist/server/static-files/serve.js +1 -1
  156. package/dist/server/subprocess/child-entry.js +1 -1
  157. package/dist/server/subprocess/host.js +1 -1
  158. package/dist/server/telemetry/mock-server-events.js +1 -0
  159. package/dist/server/telemetry/redirect-event.js +1 -0
  160. package/dist/server/telemetry/sender.js +1 -1
  161. package/dist/shared/constants/content-update.js +1 -1
  162. package/dist/shared/constants/dev-content-build.js +1 -0
  163. package/dist/shared/constants/dev-problems.js +1 -1
  164. package/dist/shared/constants/dev-source-sync.js +1 -1
  165. package/dist/shared/constants/manifest-version.d.ts +3 -1
  166. package/dist/shared/constants/openapi-operation-methods.d.ts +2 -0
  167. package/dist/shared/constants/openapi-operation-methods.js +1 -0
  168. package/dist/shared/constants/review.d.ts +5 -0
  169. package/dist/shared/constants/review.js +1 -1
  170. package/dist/shared/load-dot-env.js +1 -1
  171. package/dist/shared/rbac/api-docs.d.ts +2 -1
  172. package/dist/shared/rbac/api-docs.js +1 -1
  173. package/dist/shared/rbac/engine.d.ts +12 -9
  174. package/dist/shared/rbac/engine.js +0 -0
  175. package/dist/shared/rbac/filter.js +1 -1
  176. package/dist/shared/rbac/route-scope.d.ts +1 -1
  177. package/dist/shared/types/auth.d.ts +1 -0
  178. package/dist/shared/types/config.d.ts +1 -0
  179. package/dist/shared/types/search.d.ts +7 -2
  180. package/drizzle/20261111152552_page_markdown_rbac_scope/migration.sql +1 -0
  181. package/package.json +26 -5
  182. package/dist/bundler/dev/__tests__/reset-content-update-state.js +0 -1
  183. package/dist/bundler/dev/materialization-sweeper.js +0 -1
  184. package/dist/client/dev-problems/sweep-segment.js +0 -1
  185. package/dist/client/review/use-bar-position.js +0 -1
  186. package/dist/content-layer/plugins/internal/mcp/server/gateway/__tests__/fake-kv.js +0 -1
  187. package/dist/content-layer/plugins/internal/mcp/server/gateway/__tests__/secret-store-fixture.js +0 -1
  188. package/dist/server/__tests__/rbac-fixture.js +0 -1
  189. package/dist/server/__tests__/test-session.js +0 -1
@@ -1,8 +1,10 @@
1
- import { type MarkdownUsageSink } from './markdown-decorator.js';
1
+ import type { createConfig as CreateConfigFn } from '@redocly/openapi-core';
2
+ import { type MarkdownUsageSink, type PendingMarkdownResolution } from './markdown-decorator.js';
2
3
  import type { MarkdownService } from '../../../../markdown/types/service.js';
3
4
  import type { MarkdocResolverContextBase } from '../../../../markdown/resolve/markdoc.js';
4
5
  import { type ApiSpecType } from '../../../types/api-entity.js';
5
6
  import type { JsonObject } from '../../../../database/schema.js';
7
+ import type { ProblemDraft } from '../../../../problems/types.js';
6
8
  import { type RbacAnnotationOptions } from '../../../../../shared/rbac/api-docs.js';
7
9
  /**
8
10
  * Context for resolving markdown descriptions in an OpenAPI/AsyncAPI bundle. `markdown`
@@ -35,12 +37,18 @@ export type BundledApiDefinition = {
35
37
  relativePath: string;
36
38
  options: Record<string, unknown>;
37
39
  /**
38
- * Content-relative paths of external `$ref` files (transitively). Registered as
39
- * `file` invalidation deps so edits re-materialize the spec. Excludes the root
40
- * spec (tracked as the origin dep) and any ref outside the content root. Always
41
- * `[]` for graphql (no external ref resolution).
40
+ * Content-relative paths of external `$ref` files (transitively), and of the file each
41
+ * schema catalog link names, also when that file does not exist. Registered as `file`
42
+ * invalidation deps so edits re-materialize the spec. Excludes the root spec (tracked as
43
+ * the origin dep) and any ref outside the content root. Always `[]` for graphql (no
44
+ * external ref resolution).
42
45
  */
43
46
  fileDependencies: string[];
47
+ /**
48
+ * The errors of the bundle, such as a `$ref` that does not resolve, at the referencing file
49
+ * and line when it is in the content root, else at the spec. Always `[]` for graphql.
50
+ */
51
+ problems: ProblemDraft[];
44
52
  };
45
53
  export declare function buildBundledApiDefinition(input: {
46
54
  /** An Arazzo bundle has every `$ref` resolved inline. */
@@ -75,12 +83,13 @@ export declare function buildBundledApiDefinition(input: {
75
83
  */
76
84
  metadata?: Record<string, unknown>;
77
85
  }): Promise<BundledApiDefinition>;
78
- /**
79
- * The descriptions the `.md` routes render but the decorator leaves as strings, because
80
- * api-docs shows them as plain labels (see `MARKDOWN_FIELDS`): the root servers and their
81
- * variables, and the security schemes. Copies of the document's nodes, each description that
82
- * holds Markdoc resolved to its AST through the same pass as the decorated fields.
83
- */
86
+ export declare function createBundleConfig(createConfig: typeof CreateConfigFn, options: {
87
+ bundle: ApiBundleInput;
88
+ specRelativePath: string;
89
+ rootDir: string;
90
+ resolution: ApiDocsMarkdownResolution | undefined;
91
+ }): Promise<import("@redocly/openapi-core").Config>;
92
+ /** Copies of the root servers and security schemes with their descriptions resolved to Markdoc ASTs. */
84
93
  export type LlmsDescriptions = {
85
94
  servers?: unknown[] | Record<string, unknown>;
86
95
  securitySchemes?: Record<string, unknown>;
@@ -90,3 +99,4 @@ export declare function resolveLlmsDescriptions(document: unknown, resolution: A
90
99
  specPath: string;
91
100
  pagePath: string;
92
101
  }): Promise<LlmsDescriptions>;
102
+ export declare function resolvePendingMarkdown(resolution: ApiDocsMarkdownResolution, pendingList: readonly PendingMarkdownResolution[], contentDir: string, pagePath: string): Promise<void>;
@@ -1 +1 @@
1
- import{isObject as e}from"../../../../../shared/utils/is-object.js";import{toContainedContentPath as t}from"../../../../ingest/scan.js";import{SPEC_KIND_ARAZZO as n}from"../../../../../shared/constants/api-spec-kinds.js";import{annotateApiDocsRbac as r}from"../../../../../shared/rbac/api-docs.js";import{resolveMarkdownAst as i}from"../../../../markdown/resolve/ast.js";import{PLAIN_DESCRIPTION_SOURCE as a,REALM_MARKDOWN_DECORATOR_KEY as o,REALM_MARKDOWN_DECORATOR_NAME as s,createMarkdownDecoratorPlugin as c}from"./markdown-decorator.js";import{ProblemError as l}from"../../../../problems/problem-error.js";import{join as u}from"node:path";async function d(e){if(e.kind===`graphql`){let{parse:t}=await import(`graphql`),n;try{n=t(e.source)}catch(t){throw m(e.relativePath,t)}return{type:`graphql`,document:n,relativePath:e.relativePath,options:e.options??{},fileDependencies:[]}}let{bundleFromString:t,createConfig:i}=await import(`@redocly/openapi-core`),a=await h(i,{bundle:e.bundle??{config:{},configDir:``,plugins:[]},specRelativePath:e.relativePath,rootDir:e.contentDir,resolution:e.markdownResolution}),o;try{o=await t({source:e.source,absoluteRef:u(e.contentDir,e.relativePath),config:a,dereference:e.kind===n})}catch(t){throw m(e.relativePath,t)}let s=o.bundle.parsed,c=y(o.fileDependencies,e.contentDir);e.markdownResolution&&await _(e.markdownResolution,e.markdownResolution.sink.pending,e.contentDir,e.pagePath??e.relativePath);let l;try{l=await f(e.kind,s)}catch(t){throw m(e.relativePath,t)}let d=p(l,e.metadata);return{type:e.kind,document:e.rbac?r(d,e.kind,e.rbac):d,relativePath:e.relativePath,options:e.options??{},fileDependencies:c}}async function f(e,t){if(typeof t!=`object`||!t||Array.isArray(t))return t;let n=t;if(e===`openapi`&&n.swagger!==void 0){let{convertSwaggerToOpenApi:e}=await import(`@redocly/api-docs/server`);return e(n)}if(e===`asyncapi`){let{normalizeAsyncApiDefinition:e}=await import(`@redocly/api-docs/server`);return e(n)}return t}function p(t,n){if(n===void 0||!e(t))return t;let r=e(t.info)?t.info:{},i=e(r[`x-metadata`])?r[`x-metadata`]:{};return{...t,info:{...r,"x-metadata":{...i,...n}}}}function m(e,t){let n=t instanceof Error?t.message:String(t);return new l({code:`spec/parse-failed`,message:n,location:{filePath:e}})}function h(e,n){let{bundle:r,resolution:i}=n,a={configPath:u(n.rootDir,r.configDir,`redocly.yaml`)},l=r.plugins.map(({plugin:e,path:t})=>({...e,absolutePath:t}));if(i===void 0)return e({...r.config,plugins:l},a);let{sink:d}=i,f=c({specSourcePath:n.specRelativePath,sink:d,toContentRelative:e=>t(n.rootDir,e)});return e({...r.config,plugins:[...l,f],decorators:{...r.config.decorators,[o]:`on`,[s]:`on`}},a)}async function g(t,n,r){if(!e(t))return{};let i=[],o=(t,n)=>{if(!e(t)||!e(n))return;let o=n[a];i.push({read:()=>t.description,sourceFilePath:typeof o==`string`?o:r.specPath,writeBack:e=>{t.description=e}})},s={},c=t.servers;if(Array.isArray(c)||e(c)){s.servers=structuredClone(c);for(let[t,n]of Object.entries(c)){let r=s.servers[t];if(o(r,n),e(n)&&e(n.variables)&&e(r)){let e=r.variables;for(let[t,r]of Object.entries(n.variables))o(e[t],r)}}}let l=e(t.components)?t.components:void 0;if(e(l?.securitySchemes)){let e=l.securitySchemes;s.securitySchemes=structuredClone(e);for(let[t,n]of Object.entries(e))o(s.securitySchemes[t],n)}return await _(n,i,r.contentDir,r.pagePath),s}async function _(e,t,n,r){let{markdown:a,sink:o}=e,s={...e.loader,contentDir:n,markdown:a};await Promise.all(t.map(async e=>{let t=e.read();if(typeof t!=`string`||!a.looksLikeMarkdown(t))return;let{ast:n,entityDeps:c,assetUsages:l,linkRefs:u,problems:d}=await i(t,e.sourceFilePath,{resolverContext:s});o.entityDeps.push(...c),o.assetUsages.push(...l),o.linkRefs.push(...u.map(e=>v(e.raw.trim().startsWith(`#`)?{...e,target:r}:e)));for(let e of d)o.problems.push({...e,location:{filePath:r}});e.writeBack(n)}))}function v(e){if(e.range===void 0)return e;let t={...e};return delete t.range,t}function y(e,n){let r=/* @__PURE__ */ new Set;for(let i of e){let e=t(n,i);e!==null&&r.add(e)}return[...r].sort()}export{d as buildBundledApiDefinition,g as resolveLlmsDescriptions};
1
+ import{isObject as e}from"../../../../../shared/utils/is-object.js";import{toContainedContentPath as t}from"../../../../ingest/scan.js";import{SPEC_KIND_ARAZZO as n}from"../../../../../shared/constants/api-spec-kinds.js";import{annotateApiDocsRbac as r}from"../../../../../shared/rbac/api-docs.js";import{resolveMarkdownAst as i}from"../../../../markdown/resolve/ast.js";import{PLAIN_DESCRIPTION_SOURCE as a,REALM_MARKDOWN_DECORATOR_KEY as o,REALM_MARKDOWN_DECORATOR_NAME as s,createMarkdownDecoratorPlugin as c}from"./markdown-decorator.js";import{ProblemError as l}from"../../../../problems/problem-error.js";import{captureSnippet as u,splitSourceLines as d}from"../../../../../shared/utils/capture-snippet.js";import{existsSync as f}from"node:fs";import{join as p}from"node:path";async function m(e){if(e.kind===`graphql`){let{parse:t}=await import(`graphql`),n;try{n=t(e.source)}catch(t){throw b(e.relativePath,t)}return{type:`graphql`,document:n,relativePath:e.relativePath,options:e.options??{},fileDependencies:[],problems:[]}}let{BaseResolver:t,bundleFromString:i,createConfig:a,getLineColLocation:o}=await import(`@redocly/openapi-core`),s=await x(a,{bundle:e.bundle??{config:{},configDir:``,plugins:[]},specRelativePath:e.relativePath,rootDir:e.contentDir,resolution:e.markdownResolution}),c=v(t,s.resolve,e.contentDir),l;try{l=await i({source:e.source,absoluteRef:p(e.contentDir,e.relativePath),config:s,externalRefResolver:c,dereference:e.kind===n})}catch(t){throw b(e.relativePath,t)}let u=l.bundle.parsed,d=T([...l.fileDependencies,...c.catalogLinkPaths],e.contentDir),f=y(l.problems,o,{contentDir:e.contentDir,specRelativePath:e.relativePath});e.markdownResolution&&await C(e.markdownResolution,e.markdownResolution.sink.pending,e.contentDir,e.pagePath??e.relativePath);let m;try{m=await h(e.kind,u)}catch(t){throw b(e.relativePath,t)}let _=g(m,e.metadata);return{type:e.kind,document:e.rbac?r(_,e.kind,e.rbac):_,relativePath:e.relativePath,options:e.options??{},fileDependencies:d,problems:f}}async function h(e,t){if(typeof t!=`object`||!t||Array.isArray(t))return t;let n=t;if(e===`openapi`&&n.swagger!==void 0){let{convertSwaggerToOpenApi:e}=await import(`@redocly/api-docs/server`);return e(n)}if(e===`asyncapi`){let{normalizeAsyncApiDefinition:e}=await import(`@redocly/api-docs/server`);return e(n)}return t}function g(t,n){if(n===void 0||!e(t))return t;let r=e(t.info)?t.info:{},i=e(r[`x-metadata`])?r[`x-metadata`]:{};return{...t,info:{...r,"x-metadata":{...i,...n}}}}const _=/^https?:\/\/.*\/_bundle\/(.*\.(?:ya?ml|json))$/u;function v(e,n,r){class i extends e{catalogLinkPaths=/* @__PURE__ */ new Set;resolveExternalRef(e,n){let i=super.resolveExternalRef(e,n),a=_.exec(i)?.[1];if(a===void 0)return i;let o=p(r,a);return t(r,o)===null?i:(this.catalogLinkPaths.add(o),f(o)?o:i)}}return new i(n)}function y(e,n,r){return e.filter(e=>e.severity===`error`&&e.ignored!==!0).map(e=>{let i=e.message.replaceAll(`${r.contentDir}/`,``),a=e.location[0],o=a?.source?t(r.contentDir,a.source.absoluteRef):null;if(a===void 0||o===null)return{code:`spec/bundle-error`,message:i,location:{filePath:r.specRelativePath}};let{start:s,end:c}=n(a),l={start:{line:s.line,character:s.col},...c?{end:{line:c.line,character:c.col}}:{}};return{code:`spec/bundle-error`,message:i,location:{filePath:o,range:l,snippet:u(d(a.source.body),l)}}})}function b(e,t){let n=t instanceof Error?t.message:String(t);return new l({code:`spec/parse-failed`,message:n,location:{filePath:e}})}function x(e,n){let{bundle:r,resolution:i}=n,a={configPath:p(n.rootDir,r.configDir,`redocly.yaml`)},l=r.plugins.map(({plugin:e,path:t})=>({...e,absolutePath:t}));if(i===void 0)return e({...r.config,plugins:l},a);let{sink:u}=i,d=c({specSourcePath:n.specRelativePath,sink:u,toContentRelative:e=>t(n.rootDir,e)});return e({...r.config,plugins:[...l,d],decorators:{...r.config.decorators,[o]:`on`,[s]:`on`}},a)}async function S(t,n,r){if(!e(t))return{};let i=[],o=(t,n)=>{if(!e(t)||!e(n))return;let o=n[a];i.push({read:()=>t.description,sourceFilePath:typeof o==`string`?o:r.specPath,writeBack:e=>{t.description=e}})},s={},c=t.servers;if(Array.isArray(c)||e(c)){s.servers=structuredClone(c);for(let[e,t]of Object.entries(c))o(s.servers[e],t)}let l=e(t.components)?t.components:void 0;if(e(l?.securitySchemes)){let e=l.securitySchemes;s.securitySchemes=structuredClone(e);for(let[t,n]of Object.entries(e))o(s.securitySchemes[t],n)}return await C(n,i,r.contentDir,r.pagePath),s}async function C(e,t,n,r){let{markdown:a,sink:o}=e,s={...e.loader,contentDir:n,markdown:a};await Promise.all(t.map(async e=>{let t=e.read();if(typeof t!=`string`||!a.looksLikeMarkdown(t))return;let{ast:n,entityDeps:c,assetUsages:l,linkRefs:u,problems:d}=await i(t,e.sourceFilePath,{resolverContext:s});o.entityDeps.push(...c),o.assetUsages.push(...l);for(let t of u)t.raw.trim().startsWith(`#`)?o.linkRefs.push(w({...t,target:r})):e.sourceFilePath===r||t.filePath!==void 0?o.linkRefs.push(w(t)):o.linkRefs.push({...w(t),filePath:e.sourceFilePath});for(let e of d)o.problems.push({...e,location:{filePath:r}});e.writeBack(n)}))}function w(e){if(e.range===void 0)return e;let t={...e};return delete t.range,t}function T(e,n){let r=/* @__PURE__ */ new Set;for(let i of e){let e=t(n,i);e!==null&&r.add(e)}return[...r].sort()}export{m as buildBundledApiDefinition,x as createBundleConfig,S as resolveLlmsDescriptions,C as resolvePendingMarkdown};
@@ -1 +1 @@
1
- import{isRbacScope as e}from"../../../../../shared/rbac/engine.js";import{REDOCLY_TEAMS_RBAC as t}from"@redocly/config";function n(e){return e.map(o)}function r(e){let t=/* @__PURE__ */ new Set,n=e=>{for(let r of e){let e=i(r.slugSuffix??``);e!==``&&t.add(e),r.items&&r.items.length>0&&n(r.items)}};return n(e),[...t]}function i(e){return e.replace(/^\/+/,``)}function a(e){return e===``||e.startsWith(`/`)?e:`/${e}`}function o(n){let r={};n.label!==void 0&&(r.label=n.label),n.link!==void 0&&(r.slugSuffix=a(n.link)),n.httpVerb!==void 0&&(r.httpVerb=n.httpVerb),n.deprecated!==void 0&&(r.deprecated=n.deprecated),n.badges!==void 0&&(r.badges=n.badges),n.external!==void 0&&(r.external=n.external),n.separatorLine!==void 0&&(r.separatorLine=n.separatorLine),n.icon!==void 0&&(r.icon=n.icon),n.variant!==void 0&&(r.variant=n.variant);let i=n[t];return e(i)&&(r[t]=i),(n.type===`link`||n.type===`group`||n.type===`separator`)&&(r.type=n.type),r.type===`separator`&&(r.separatorLine=!0),n.items&&n.items.length>0&&(r.items=n.items.map(o)),r}export{r as collectSidebarSubpathTargets,n as toSidebarSubtree,i as toSubpathTarget};
1
+ import{isRbacScope as e}from"../../../../../shared/rbac/engine.js";import{REDOCLY_TEAMS_RBAC as t}from"@redocly/config";function n(e){return e.map(o)}function r(e){let t=/* @__PURE__ */ new Set,n=e=>{for(let r of e){let e=i(r.slugSuffix??``);e!==``&&t.add(e),r.items&&r.items.length>0&&n(r.items)}};return n(e),[...t]}function i(e){return e.replace(/^\/+/,``)}function a(e){return e===``||e.startsWith(`/`)?e:`/${e}`}function o(n){let r={};n.label!==void 0&&(r.label=n.label),n.link!==void 0&&(r.slugSuffix=a(n.link)),n.httpVerb!==void 0&&(r.httpVerb=n.httpVerb),n.deprecated!==void 0&&(r.deprecated=n.deprecated),n.badges!==void 0&&(r.badges=n.badges),n.external!==void 0&&(r.external=n.external),n.separatorLine!==void 0&&(r.separatorLine=n.separatorLine),n.icon!==void 0&&(r.icon=n.icon),n.variant!==void 0&&(r.variant=n.variant);let i=n[t];return e(i)&&(r[t]=i),(n.type===`link`||n.type===`group`||n.type===`separator`)&&(r.type=n.type),n.items&&n.items.length>0&&(r.items=n.items.map(o)),r}export{r as collectSidebarSubpathTargets,n as toSidebarSubtree,i as toSubpathTarget};
@@ -25,10 +25,7 @@ export type MarkdownUsageSink = {
25
25
  /** Filled during the sync bundle walk; drained by the async post-bundle pass. */
26
26
  pending: PendingMarkdownResolution[];
27
27
  };
28
- /**
29
- * Key of the content-relative source file on each bundled server, server variable and security
30
- * scheme node, whose `description` stays a plain string. Spread copies keep it; JSON drops it.
31
- */
28
+ /** Key of the content-relative source file on each bundled server and security scheme node. */
32
29
  export declare const PLAIN_DESCRIPTION_SOURCE: unique symbol;
33
30
  /** The unprefixed decorator name as registered on the plugin. openapi-core namespaces
34
31
  * plugin decorators as `<pluginId>/<name>` when it normalizes plugins (`resolvePlugins`),
@@ -1 +1 @@
1
- const e=Symbol(`plainDescriptionSource`),t=`realm-internal`,n=`resolve-markdown`,r=`${t}/${n}`,i=[`description`];function a(r){let a=e=>{let t=o(e);return(t===void 0?null:r.toContentRelative(t))??r.specSourcePath},s=(e,t)=>{if(typeof e!=`object`||!e)return;let n=e,o=a(t);for(let e of i)r.sink.pending.push({read:()=>n[e],sourceFilePath:o,writeBack:t=>{n[e]=t}});let s=n[`x-enumDescriptions`];if(s&&typeof s==`object`){let e=s;for(let t of Object.keys(e))r.sink.pending.push({read:()=>e[t],sourceFilePath:o,writeBack:n=>{e[t]=n}})}},c=(t,n)=>{typeof t==`object`&&t&&(t[e]=a(n))},l=()=>({Server:{enter:c},ServerVariable:{enter:c},SecurityScheme:{enter:c},Info:{enter:s},Tag:{enter:s},Operation:{enter:s},Parameter:{enter:s},Schema:{enter:s},Response:{enter:s},Header:{enter:s},RequestBody:{enter:s}});return{id:t,decorators:{oas3:{[n]:l},oas2:{[n]:l},async2:{[n]:l},async3:{[n]:l}}}}function o(e){let t=(e?.location)?.source?.absoluteRef;return typeof t==`string`?t:void 0}export{e as PLAIN_DESCRIPTION_SOURCE,r as REALM_MARKDOWN_DECORATOR_KEY,n as REALM_MARKDOWN_DECORATOR_NAME,a as createMarkdownDecoratorPlugin};
1
+ const e=Symbol(`plainDescriptionSource`),t=`realm-internal`,n=`resolve-markdown`,r=`${t}/${n}`,i=[`description`],a=/* @__PURE__ */ new Set([`Server`,`SecurityScheme`]);function o(r){let o=e=>{let t=s(e);return(t===void 0?null:r.toContentRelative(t))??r.specSourcePath},c=(e,t)=>{if(typeof e!=`object`||!e)return;let n=e,a=o(t);for(let e of i)r.sink.pending.push({read:()=>n[e],sourceFilePath:a,writeBack:t=>{n[e]=t}});let s=n[`x-enumDescriptions`];if(s&&typeof s==`object`){let e=s;for(let t of Object.keys(e))r.sink.pending.push({read:()=>e[t],sourceFilePath:a,writeBack:n=>{e[t]=n}})}},l=(t,n)=>{typeof t==`object`&&t&&(t[e]=o(n))},u=(e,t)=>{let n=t.type?.name;typeof e.description==`string`&&(n!==void 0&&a.has(n)||c(e,t))},d=()=>({ref:{enter:u},Server:{enter:l},SecurityScheme:{enter:l},ServerVariable:{enter:c},Example:{enter:c},Info:{enter:c},Tag:{enter:c},Operation:{enter:c},Parameter:{enter:c},Schema:{enter:c},Response:{enter:c},Header:{enter:c},RequestBody:{enter:c}});return{id:t,decorators:{oas3:{[n]:d},oas2:{[n]:d},async2:{[n]:d},async3:{[n]:d}}}}function s(e){let t=(e?.location)?.source?.absoluteRef;return typeof t==`string`?t:void 0}export{e as PLAIN_DESCRIPTION_SOURCE,r as REALM_MARKDOWN_DECORATOR_KEY,n as REALM_MARKDOWN_DECORATOR_NAME,o as createMarkdownDecoratorPlugin};
@@ -1,26 +1,26 @@
1
- import{RBAC_TEAM_ANONYMOUS as e}from"../../../../../shared/rbac/types.js";import{canView as t,isRbacScope as n,resolveRole as r}from"../../../../../shared/rbac/engine.js";import{isObject as i}from"../../../../../shared/utils/is-object.js";import{headingSlugger as a}from"../../../../markdown/utils/heading-slugger.js";import{parseMarkdown as o}from"../../../../markdown/utils/parse-cache.js";import{SPEC_DOWNLOAD_ROUTE_PATHS as s}from"./shared.js";import{markdocAstToMarkdownChunks as c}from"../../../../markdown/search/to-markdown.js";import{REDOCLY_TEAMS_RBAC as l}from"@redocly/config";const u=i=>{let a=i[l];return a!==void 0&&!t(r(n(a)?a:{},[e]))};function d(e,t,n,r={}){let a=/* @__PURE__ */ new Map,s=e=>{let t=y(e)?e:{type:`document`,children:Array.isArray(e)?e:[e]};return c(t,r)},l=e=>{if(typeof e!=`string`)return s(e);if(!e.includes(`{%`)){let t=e.trim();return t===``?[]:[t]}let t=a.get(e);return t===void 0&&(t=s(o(e)),a.set(e,t)),t},d=[],m=/* @__PURE__ */ new Set,h=e.items,g=i(e.store)?e.store.schemaStore:{},x=i(t)?t:void 0,S=x?.security,C=i(x?.info)?x.info:{},w=(e,t,n,r)=>{d.push({routeSlug:e,chunks:t,headings:f(t),...typeof n==`string`&&n!==``?{title:n}:{},...r?{description:r}:{}})},T=i(C[`x-metadata`])?C[`x-metadata`]:{},E=l((typeof T.description==`string`?T.description:void 0)??C.description).join(`
1
+ import"../../../../../shared/rbac/types.js";import{canView as e,isRbacScope as t,resolveRole as n}from"../../../../../shared/rbac/engine.js";import{isObject as r}from"../../../../../shared/utils/is-object.js";import{headingSlugger as i}from"../../../../markdown/utils/heading-slugger.js";import{parseMarkdown as a}from"../../../../markdown/utils/parse-cache.js";import{SPEC_DOWNLOAD_ROUTE_PATHS as o}from"./shared.js";import{markdocAstToMarkdownChunks as s}from"../../../../markdown/search/to-markdown.js";import{REDOCLY_TEAMS_RBAC as c}from"@redocly/config";const l=t=>{let r=f(t);return r===void 0||e(n(r,[`anonymous`]))},u=e=>!l(e);function d(e,t,n,i={}){let o=/* @__PURE__ */ new Map,c=e=>{let t=b(e)?e:{type:`document`,children:Array.isArray(e)?e:[e]};return s(t,i)},u=e=>{if(typeof e!=`string`)return c(e);if(!e.includes(`{%`)){let t=e.trim();return t===``?[]:[t]}let t=o.get(e);return t===void 0&&(t=c(a(e)),o.set(e,t)),t},d=[],h=/* @__PURE__ */ new Set,g=e.items,_=r(e.store)?e.store.schemaStore:{},S=r(t)?t:void 0,C=S?.security,w=r(S?.info)?S.info:{},T=(e,t,n,r,i)=>{d.push({routeSlug:t,chunks:n,headings:p(n),...typeof r==`string`&&r!==``?{title:r}:{},...i?{description:i}:{},...e===void 0?{}:{rbacScope:e}})},E=r(w[`x-metadata`])?w[`x-metadata`]:{},D=u((typeof E.description==`string`?E.description:void 0)??w.description).join(`
2
2
 
3
- `),D=t=>{let r=t.content,i=r?.contentType??(t.items?.length&&t.link?`group`:void 0);if(!u(t)&&typeof t.link==`string`&&i!==void 0){let a=i===`overview`,o=t.link;if(!m.has(o)){if(a&&r)m.add(o),w(o,p({doc:x,info:C,description:E,specType:e.specType,items:h,originFilePath:n,renderMarkdown:l}),C.title,E);else if(i===`item`&&r)m.add(o),w(o,v(t,{info:C,schemaStore:g,document:x,globalSecurity:S,specType:e.specType,renderMarkdown:l}),t.label);else if(i===`group`){m.add(o);let e=t.deprecated===!0||r?.meta?.deprecated===!0,n=_(t.items??[],l);w(o,[`# ${t.label??``}${e?` (deprecated)`:``}`.trim(),...b(r?.children??[],l),...n?[n]:[]].filter(e=>e!==``),t.label)}}}for(let e of t.items??[])D(e)};for(let e of h)D(e);return d}function f(e){return a.reset(),e.map(e=>{let t=/^#{1,6} +(?! )(.+)$/.exec(e.split(`
4
- `,1)[0]??``);if(!t)return null;let n=t[1].trim();return{heading:n,anchor:a.slug(n)}})}function p(e){let{doc:t,info:n}=e,r=[],a=[];typeof n.title==`string`&&n.title&&a.push(`# ${n.title}`),e.description&&a.push(e.description),typeof n.summary==`string`&&n.summary&&a.push(n.summary);let o=[];n.version!==void 0&&n.version!==``&&o.push(`Version: ${String(n.version)}`);let s=i(n.license)?n.license:void 0;typeof s?.name==`string`&&o.push(`License: ${s.name}`);let c=i(n[`x-metadata`])?n[`x-metadata`]:void 0;if(c){let e=Object.entries(c).filter(([,e])=>typeof e==`string`||typeof e==`number`).filter(([e,t])=>e!==`description`||typeof t!=`string`).map(([e,t])=>`- ${e}: ${String(t)}`);e.length>0&&o.push(`Metadata:\n${e.join(`
3
+ `),O=/* @__PURE__ */ new Map,k=e=>{typeof e.link==`string`&&!O.has(e.link)&&l(e)&&O.set(e.link,f(e));for(let t of e.items??[])k(t)};for(let e of g)k(e);let A=t=>{let r=t.content,i=r?.contentType??(t.items?.length&&t.link?`group`:void 0);if(typeof t.link==`string`&&i!==void 0){let a=i===`overview`,o=t.link,s=O.has(o)?O.get(o):f(t);if(!h.has(o)){if(a&&r)h.add(o),T(s,o,m({doc:S,info:w,description:D,specType:e.specType,items:g,originFilePath:n,renderMarkdown:u}),w.title,D);else if(i===`item`&&r)h.add(o),T(s,o,y(t,{info:w,schemaStore:_,document:S,globalSecurity:C,specType:e.specType,renderMarkdown:u}),t.label);else if(i===`group`){h.add(o);let e=t.deprecated===!0||r?.meta?.deprecated===!0,n=v(t.items??[],u);T(s,o,[`# ${t.label??``}${e?` (deprecated)`:``}`.trim(),...x(r?.children??[],u),...n?[n]:[]].filter(e=>e!==``),t.label)}}}for(let e of t.items??[])A(e)};for(let e of g)A(e);return d}function f(e){let n=e[c];if(n!==void 0)return t(n)?n:{}}function p(e){return i.reset(),e.map(e=>{let t=/^#{1,6} +(?! )(.+)$/.exec(e.split(`
4
+ `,1)[0]??``);if(!t)return null;let n=t[1].trim();return{heading:n,anchor:i.slug(n)}})}function m(e){let{doc:t,info:n}=e,i=[],a=[];typeof n.title==`string`&&n.title&&a.push(`# ${n.title}`),e.description&&a.push(e.description),typeof n.summary==`string`&&n.summary&&a.push(n.summary);let o=[];n.version!==void 0&&n.version!==``&&o.push(`Version: ${String(n.version)}`);let s=r(n.license)?n.license:void 0;typeof s?.name==`string`&&o.push(`License: ${s.name}`);let c=r(n[`x-metadata`])?n[`x-metadata`]:void 0;if(c){let e=Object.entries(c).filter(([,e])=>typeof e==`string`||typeof e==`number`).filter(([e,t])=>e!==`description`||typeof t!=`string`).map(([e,t])=>`- ${e}: ${String(t)}`);e.length>0&&o.push(`Metadata:\n${e.join(`
5
5
  `)}`)}o.length>0&&a.push(o.join(`
6
- `)),a.length>0&&r.push(a.join(`
6
+ `)),a.length>0&&i.push(a.join(`
7
7
 
8
- `));let l=m(t,e.renderMarkdown);l&&r.push(l);let u=h(t,e.renderMarkdown);u&&r.push(u);let d=g(e.specType,n,e.originFilePath);d&&r.push(d);let f=_(e.items,e.renderMarkdown);return f&&r.push(f),r}function m(e,t){let n=e?.servers;if(!Array.isArray(n)||n.length===0)return;let r=`## Servers
8
+ `));let l=h(t,e.renderMarkdown);l&&i.push(l);let u=g(t,e.renderMarkdown);u&&i.push(u);let d=_(e.specType,n,e.originFilePath);d&&i.push(d);let f=v(e.items,e.renderMarkdown);return f&&i.push(f),i}function h(e,t){let n=e?.servers;if(!Array.isArray(n)||n.length===0)return;let i=`## Servers
9
9
 
10
- `;for(let e of n){if(!i(e))continue;let n=t(e.description).join(`
10
+ `;for(let e of n){if(!r(e))continue;let n=t(e.description).join(`
11
11
 
12
- `);if(n&&(r+=`${n}\n`),r+=`\`\`\`\n${String(e.url??``)}\n\`\`\`\n\n`,i(e.variables)){r+=`Variables:
13
- `;for(let[n,a]of Object.entries(e.variables)){if(!i(a))continue;let e=t(a.description).join(` `).replace(/\s+/g,` `);r+=`- \`${n}\`${e?`: ${e}`:``}\n`,a.default!==void 0&&(r+=` Default: ${JSON.stringify(a.default)}\n`),Array.isArray(a.enum)&&(r+=` Enum: ${a.enum.map(e=>JSON.stringify(e)).join(`, `)}\n`)}r+=`
14
- `}}return r.trim()}function h(e,t){let n=i(e?.components)?e.components:void 0,r=i(n?.securitySchemes)?n.securitySchemes:void 0;if(!r)return;let a=`## Security
12
+ `);if(n&&(i+=`${n}\n`),i+=`\`\`\`\n${String(e.url??``)}\n\`\`\`\n\n`,r(e.variables)){i+=`Variables:
13
+ `;for(let[n,a]of Object.entries(e.variables)){if(!r(a))continue;let e=t(a.description).join(` `).replace(/\s+/g,` `);i+=`- \`${n}\`${e?`: ${e}`:``}\n`,a.default!==void 0&&(i+=` Default: ${JSON.stringify(a.default)}\n`),Array.isArray(a.enum)&&(i+=` Enum: ${a.enum.map(e=>JSON.stringify(e)).join(`, `)}\n`)}i+=`
14
+ `}}return i.trim()}function g(e,t){let n=r(e?.components)?e.components:void 0,i=r(n?.securitySchemes)?n.securitySchemes:void 0;if(!i)return;let a=`## Security
15
15
 
16
- `;for(let[e,n]of Object.entries(r)){if(!i(n)||`$ref`in n)continue;a+=`### ${e}\n\n`;let r=t(n.description).join(`
16
+ `;for(let[e,n]of Object.entries(i)){if(!r(n)||`$ref`in n)continue;a+=`### ${e}\n\n`;let i=t(n.description).join(`
17
17
 
18
- `);r&&(a+=`${r}\n\n`);for(let[e,t]of[[`Type`,`type`],[`In`,`in`],[`Name`,`name`],[`Scheme`,`scheme`],[`Bearer Format`,`bearerFormat`],[`OpenID Connect URL`,`openIdConnectUrl`]])typeof n[t]==`string`&&n[t]&&(a+=`${e}: ${n[t]}\n`);let o=i(n.flows)?n.flows:void 0,s=[o?.implicit,o?.password,o?.clientCredentials,o?.authorizationCode].find(i);if(s&&(typeof s.authorizationUrl==`string`&&(a+=`Authorization URL: ${s.authorizationUrl}\n`),typeof s.tokenUrl==`string`&&(a+=`Token URL: ${s.tokenUrl}\n`),i(s.scopes))){a+=`Scopes:
18
+ `);i&&(a+=`${i}\n\n`);for(let[e,t]of[[`Type`,`type`],[`In`,`in`],[`Name`,`name`],[`Scheme`,`scheme`],[`Bearer Format`,`bearerFormat`],[`OpenID Connect URL`,`openIdConnectUrl`]])typeof n[t]==`string`&&n[t]&&(a+=`${e}: ${n[t]}\n`);let o=r(n.flows)?n.flows:void 0,s=[o?.implicit,o?.password,o?.clientCredentials,o?.authorizationCode].find(r);if(s&&(typeof s.authorizationUrl==`string`&&(a+=`Authorization URL: ${s.authorizationUrl}\n`),typeof s.tokenUrl==`string`&&(a+=`Token URL: ${s.tokenUrl}\n`),r(s.scopes))){a+=`Scopes:
19
19
  `;for(let[e,t]of Object.entries(s.scopes))a+=`- \`${e}\`: ${String(t)}\n`}a+=`
20
- `}return a.trim()}function g(e,t,n){if(!n)return;let r=typeof t.title==`string`&&t.title?t.title:void 0;if(e===`openapi`||e===`asyncapi`){let t=e===`openapi`?`OpenAPI`:`AsyncAPI`;return`## Download ${t} description\n\n[${r??`${t} definition`}](${s.bundle}/${n})`}if(e===`graphql`)return`## Download GraphQL schema\n\n[${r??`GraphQL schema`}](${s.graphql}/${n})`}function _(e,t){let n=``,r=(e,i)=>{for(let a of e)if(!(u(a)||typeof a.link!=`string`)){if(a.content?.contentType===`group`)n+=`${i} ${a.label??``}\n\n`,a.items?.length&&r(a.items,`${i}#`);else if(a.content?.contentType===`item`){let e=a.httpVerb&&a.httpPath?`${a.httpVerb.toUpperCase()} ${a.httpPath}`:a.label??``,r=x(a.content.children??[],t),i=r?`: ${r.slice(0,200)}`:``;n+=`- [${e}](${a.link}.md)${i}\n`}}};return r(e,`##`),n.trim()===``?void 0:n.trim()}function v(e,t){let n=e.content,r=n?.children??[],i=e.deprecated===!0||n?.meta?.deprecated===!0,a=[`# ${e.label??``}${i?` (deprecated)`:``}`.trim()];a.push(...b(r,t.renderMarkdown));let o=[];if(t.specType===`openapi`||t.specType===`asyncapi`){e.httpVerb&&e.httpPath?o.push(`Endpoint: ${e.httpVerb.toUpperCase()} ${e.httpPath}`):e.httpVerb&&o.push(`Method: ${e.httpVerb.toUpperCase()}`),t.info.version!==void 0&&t.info.version!==``&&o.push(`Version: ${String(t.info.version)}`);let n=S(r,t.globalSecurity);n&&o.push(`Security: ${n}`)}if(o.length>0&&a.push(o.join(`
21
- `)),t.specType!==`graphql`){let e=C(r,{schemaStore:t.schemaStore,document:t.document,renderMarkdown:t.renderMarkdown});e.length>0&&a.push(P(e))}return a.filter(e=>e!==``)}function y(e){return typeof e==`object`&&!!e&&e.type===`document`}function b(e,t){let n=[],r=e=>{if(!u(e)){if(e.nodeType===`markdoc`){n.push(...t(e.content));return}if(e.nodeType===`container`||e.nodeType===`overview-section-wrapper`)for(let t of e.children??[])r(t)}};for(let t of e)r(t);return n}function x(e,t){return b(e,t).join(` `).replace(/\s+/g,` `).trim()}function S(e,t){let n=[],r=e=>{for(let t of e)if(t.nodeType===`security`){let e=t.requirements;for(let t of e??[])for(let e of t.schemes??[])u(e)||e.name&&!n.includes(e.name)&&n.push(e.name)}else(t.nodeType===`container`||t.nodeType===`overview-section-wrapper`)&&r(t.children??[])};if(r(e),n.length>0)return n.join(`, `);if(t?.length){let e=[...new Set(t.flatMap(e=>Object.keys(e)))];if(e.length>0)return e.join(`, `)}}function C(e,t){let n=/* @__PURE__ */ new Map,r=/* @__PURE__ */ new Set,i=e=>{for(let a of e)if(a.nodeType===`item-content`){if(u(a))continue;for(let e of a.parameters??[])!u(e)&&e.name&&w(n,{name:e.name,path:[],place:E(a.variant),type:O(e.schemaId,t),required:e.required??!1,description:T(e.description,t.renderMarkdown)});D(a,n,r,t)}else if(a.nodeType===`container`||a.nodeType===`overview-section-wrapper`){if(u(a))continue;i(a.children??[])}};return i(e),[...n.values()]}function w(e,t){e.set([...t.path,t.name].join(`.`)+t.description+t.place,t)}function T(e,t){return e==null?``:t(e).join(`
20
+ `}return a.trim()}function _(e,t,n){if(!n)return;let r=typeof t.title==`string`&&t.title?t.title:void 0;if(e===`openapi`||e===`asyncapi`){let t=e===`openapi`?`OpenAPI`:`AsyncAPI`;return`## Download ${t} description\n\n[${r??`${t} definition`}](${o.bundle}/${n})`}if(e===`graphql`)return`## Download GraphQL schema\n\n[${r??`GraphQL schema`}](${o.graphql}/${n})`}function v(e,t){let n=``,r=(e,i)=>{for(let a of e)if(l(a)&&typeof a.link==`string`){if(a.content?.contentType===`group`)n+=`${i} ${a.label??``}\n\n`,a.items?.length&&r(a.items,`${i}#`);else if(a.content?.contentType===`item`){let e=a.httpVerb&&a.httpPath?`${a.httpVerb.toUpperCase()} ${a.httpPath}`:a.label??``,r=S(a.content.children??[],t),i=r?`: ${r.slice(0,200)}`:``;n+=`- [${e}](${a.link}.md)${i}\n`}}};return r(e,`##`),n.trim()===``?void 0:n.trim()}function y(e,t){let n=e.content,r=n?.children??[],i=e.deprecated===!0||n?.meta?.deprecated===!0,a=[`# ${e.label??``}${i?` (deprecated)`:``}`.trim()];a.push(...x(r,t.renderMarkdown));let o=[];if(t.specType===`openapi`||t.specType===`asyncapi`){e.httpVerb&&e.httpPath?o.push(`Endpoint: ${e.httpVerb.toUpperCase()} ${e.httpPath}`):e.httpVerb&&o.push(`Method: ${e.httpVerb.toUpperCase()}`),t.info.version!==void 0&&t.info.version!==``&&o.push(`Version: ${String(t.info.version)}`);let n=C(r,t.globalSecurity);n&&o.push(`Security: ${n}`)}if(o.length>0&&a.push(o.join(`
21
+ `)),t.specType!==`graphql`){let e=w(r,{schemaStore:t.schemaStore,document:t.document,renderMarkdown:t.renderMarkdown});e.length>0&&a.push(F(e))}return a.filter(e=>e!==``)}function b(e){return typeof e==`object`&&!!e&&e.type===`document`}function x(e,t){let n=[],r=e=>{if(!u(e)){if(e.nodeType===`markdoc`){n.push(...t(e.content));return}if(e.nodeType===`container`||e.nodeType===`overview-section-wrapper`)for(let t of e.children??[])r(t)}};for(let t of e)r(t);return n}function S(e,t){return x(e,t).join(` `).replace(/\s+/g,` `).trim()}function C(e,t){let n=[],r=e=>{for(let t of e)if(t.nodeType===`security`){let e=t.requirements;for(let t of e??[])for(let e of t.schemes??[])u(e)||e.name&&!n.includes(e.name)&&n.push(e.name)}else(t.nodeType===`container`||t.nodeType===`overview-section-wrapper`)&&r(t.children??[])};if(r(e),n.length>0)return n.join(`, `);if(t?.length){let e=[...new Set(t.flatMap(e=>Object.keys(e)))];if(e.length>0)return e.join(`, `)}}function w(e,t){let n=/* @__PURE__ */ new Map,r=/* @__PURE__ */ new Set,i=e=>{for(let a of e)if(a.nodeType===`item-content`){if(u(a))continue;for(let e of a.parameters??[])!u(e)&&e.name&&T(n,{name:e.name,path:[],place:D(a.variant),type:k(e.schemaId,t),required:e.required??!1,description:E(e.description,t.renderMarkdown)});O(a,n,r,t)}else if(a.nodeType===`container`||a.nodeType===`overview-section-wrapper`){if(u(a))continue;i(a.children??[])}};return i(e),[...n.values()]}function T(e,t){e.set([...t.path,t.name].join(`.`)+t.description+t.place,t)}function E(e,t){return e==null?``:t(e).join(`
22
22
 
23
- `)}function E(e){switch(e){case`query`:return`query parameters`;case`path`:return`path parameters`;case`headers`:return`header parameters`;case`cookies`:return`cookie parameters`;case`parameters`:return`channel parameters`;case`body`:return`request fields`;case`responses`:return`response fields`;default:return e?`${e} parameters`:`parameters`}}function D(e,t,n,r){let i=E(e.variant),a=i.startsWith(`response`);if(e.mediaTypeSchemas){let o=Object.values(e.mediaTypeSchemas).find(e=>!u(e));o?.schemaId&&k(o.schemaId,i,a,t,n,r)}else e.schemaId&&k(e.schemaId,i,a,t,n,r);for(let n of e.responses??[]){if(u(n))continue;let e=`response ${n.code??``} fields`.replace(` `,` `),i=/* @__PURE__ */ new Set,a=(n.mediaTypeContent?Object.values(n.mediaTypeContent).find(e=>!u(e)):void 0)?.schemaId??n.schemaId;a&&k(a,e,!0,t,i,r)}for(let n of e.messages??[])!u(n)&&n.name&&w(t,{name:n.name,path:[],place:`message`,type:`unknown`,required:!1,description:`${T(n.description,r.renderMarkdown)} ${n.summary??``}`.trim()})}function O(e,t){if(!e)return`unknown`;let n=t.schemaStore[e];return!i(n)||n.kind!==`json-schema`?`unknown`:M(j(n.data,t))}function k(e,t,n,r,a,o){let s=o.schemaStore[e];i(s)&&s.kind===`json-schema`&&!u(s)&&N(s.data,t,n,r,[],a,0,o)}function A(e,t){if(!e.startsWith(`#/`)||!t.document)return;let n=t.document;for(let t of e.slice(2).split(`/`)){if(typeof n!=`object`||!n)return;n=n[t]}return i(n)?n:void 0}function j(e,t){if(e.allOf){let n={};for(let r of e.allOf){let e=r.$ref?A(r.$ref,t):r;if(e){let t=n.properties,r=n.required;Object.assign(n,e),(t||e.properties)&&(n.properties={...t??{},...e.properties??{}}),(r||e.required)&&(n.required=[...r??[],...e.required??[]])}}return delete n.allOf,e.description&&(n.description=e.description),n}if(e.$ref){let n=A(e.$ref,t);if(n){let t={...n};return e.description&&(t.description=e.description),t}}return e}function M(e){return Array.isArray(e.type)?e.type.join(` | `):e.type?e.type:e.properties||e.additionalProperties?`object`:e.items?`array`:e.enum?`string`:`any`}function N(e,t,n,r,a,o,s,c){if(!(s>10||u(e))){if(e.$ref){if(o.has(e.$ref))return;o.add(e.$ref);let i=A(e.$ref,c);i&&N(i,t,n,r,a,o,s,c);return}if(e.allOf){N(j(e,c),t,n,r,a,o,s,c);return}if(e.discriminator&&e.properties&&e.oneOf){N({...e,oneOf:void 0,discriminator:void 0},t,n,r,a,o,s,c);return}if(e.oneOf||e.anyOf){for(let i of e.oneOf??e.anyOf??[]){if(i.$ref){if(o.has(i.$ref))continue;o.add(i.$ref)}let e=i.$ref?A(i.$ref,c):i;e&&N(e,t,n,r,a,o,s+1,c)}return}if(e.properties){let i=e.required??[];for(let[l,d]of Object.entries(e.properties)){if(u(d))continue;if(d.$ref){if(o.has(d.$ref))continue;o.add(d.$ref)}let e=d.$ref?A(d.$ref,c):d;if(!e)continue;let f=j(e,c);if(u(e)||u(f)||f.readOnly&&!n||f.writeOnly&&n||e.additionalProperties!==void 0&&!e.properties)continue;let p=e.example??f.example;w(r,{name:l,path:a,place:t,type:M(f),required:i.includes(l),description:T(e.description??f.description,c.renderMarkdown),enumValues:Array.isArray(f.enum)&&f.enum.length>0?f.enum:void 0,example:p===void 0?void 0:(typeof p==`string`?p:JSON.stringify(p)).slice(0,200)}),(f.properties||f.items)&&N(f,t,n,r,[...a,l],o,s+1,c)}}if(e.items&&i(e.items)&&!Array.isArray(e.items)){let i=e.items;if(i.$ref){if(o.has(i.$ref))return;o.add(i.$ref)}let l=i.$ref?A(i.$ref,c):i;l&&N(l,t,n,r,a,o,s+1,c)}}}function P(e){let t=/* @__PURE__ */ new Map;for(let n of e){let e=t.get(n.place);e?e.push(n):t.set(n.place,[n])}let n=[];for(let[e,r]of t){let t=r.map(e=>{let t=`- \`${[...e.path,e.name].join(`.`)}\` (${e.type}${e.required?`, required`:``})`,n=e.description.replace(/\s+/g,` `).trim();return n&&(t+=`\n ${n}`),e.enumValues?t+=`\n Enum: ${e.enumValues.map(e=>JSON.stringify(e)).join(`, `)}`:e.example&&(t+=`\n Example: ${e.example}`),t});n.push(`## ${e.charAt(0).toUpperCase()}${e.slice(1)}\n\n${t.join(`
23
+ `)}function D(e){switch(e){case`query`:return`query parameters`;case`path`:return`path parameters`;case`headers`:return`header parameters`;case`cookies`:return`cookie parameters`;case`parameters`:return`channel parameters`;case`body`:return`request fields`;case`responses`:return`response fields`;default:return e?`${e} parameters`:`parameters`}}function O(e,t,n,r){let i=D(e.variant),a=i.startsWith(`response`);if(e.mediaTypeSchemas){let o=Object.values(e.mediaTypeSchemas).find(e=>!u(e));o?.schemaId&&A(o.schemaId,i,a,t,n,r)}else e.schemaId&&A(e.schemaId,i,a,t,n,r);for(let n of e.responses??[]){if(u(n))continue;let e=`response ${n.code??``} fields`.replace(` `,` `),i=/* @__PURE__ */ new Set,a=(n.mediaTypeContent?Object.values(n.mediaTypeContent).find(e=>!u(e)):void 0)?.schemaId??n.schemaId;a&&A(a,e,!0,t,i,r)}for(let n of e.messages??[])!u(n)&&n.name&&T(t,{name:n.name,path:[],place:`message`,type:`unknown`,required:!1,description:`${E(n.description,r.renderMarkdown)} ${n.summary??``}`.trim()})}function k(e,t){if(!e)return`unknown`;let n=t.schemaStore[e];return!r(n)||n.kind!==`json-schema`?`unknown`:N(M(n.data,t))}function A(e,t,n,i,a,o){let s=o.schemaStore[e];r(s)&&s.kind===`json-schema`&&!u(s)&&P(s.data,t,n,i,[],a,0,o)}function j(e,t){if(!e.startsWith(`#/`)||!t.document)return;let n=t.document;for(let t of e.slice(2).split(`/`)){if(typeof n!=`object`||!n)return;n=n[t]}return r(n)?n:void 0}function M(e,t){if(e.allOf){let n={};for(let r of e.allOf){let e=r.$ref?j(r.$ref,t):r;if(e&&!u(e)){let t=n.properties,r=n.required;Object.assign(n,e),(t||e.properties)&&(n.properties={...t??{},...e.properties??{}}),(r||e.required)&&(n.required=[...r??[],...e.required??[]])}}return delete n.allOf,e.description&&(n.description=e.description),n}if(e.$ref){let n=j(e.$ref,t);if(n){let t={...n};return e.description&&(t.description=e.description),t}}return e}function N(e){return Array.isArray(e.type)?e.type.join(` | `):e.type?e.type:e.properties||e.additionalProperties?`object`:e.items?`array`:e.enum?`string`:`any`}function P(e,t,n,i,a,o,s,c){if(!(s>10||u(e))){if(e.$ref){if(o.has(e.$ref))return;o.add(e.$ref);let r=j(e.$ref,c);r&&P(r,t,n,i,a,o,s,c);return}if(e.allOf){P(M(e,c),t,n,i,a,o,s,c);return}if(e.discriminator&&e.properties&&e.oneOf){P({...e,oneOf:void 0,discriminator:void 0},t,n,i,a,o,s,c);return}if(e.oneOf||e.anyOf){for(let r of e.oneOf??e.anyOf??[]){if(r.$ref){if(o.has(r.$ref))continue;o.add(r.$ref)}let e=r.$ref?j(r.$ref,c):r;e&&P(e,t,n,i,a,o,s+1,c)}return}if(e.properties){let r=e.required??[];for(let[l,d]of Object.entries(e.properties)){if(u(d))continue;if(d.$ref){if(o.has(d.$ref))continue;o.add(d.$ref)}let e=d.$ref?j(d.$ref,c):d;if(!e)continue;let f=M(e,c);if(u(e)||u(f)||f.readOnly&&!n||f.writeOnly&&n||e.additionalProperties!==void 0&&!e.properties)continue;let p=e.example??f.example;T(i,{name:l,path:a,place:t,type:N(f),required:r.includes(l),description:E(e.description??f.description,c.renderMarkdown),enumValues:Array.isArray(f.enum)&&f.enum.length>0?f.enum:void 0,example:p===void 0?void 0:(typeof p==`string`?p:JSON.stringify(p)).slice(0,200)}),(f.properties||f.items)&&P(f,t,n,i,[...a,l],o,s+1,c)}}if(e.items&&r(e.items)&&!Array.isArray(e.items)){let r=e.items;if(r.$ref){if(o.has(r.$ref))return;o.add(r.$ref)}let l=r.$ref?j(r.$ref,c):r;l&&P(l,t,n,i,a,o,s+1,c)}}}function F(e){let t=/* @__PURE__ */ new Map;for(let n of e){let e=t.get(n.place);e?e.push(n):t.set(n.place,[n])}let n=[];for(let[e,r]of t){let t=r.map(e=>{let t=`- \`${[...e.path,e.name].join(`.`)}\` (${e.type}${e.required?`, required`:``})`,n=e.description.replace(/\s+/g,` `).trim();return n&&(t+=`\n ${n}`),e.enumValues?t+=`\n Enum: ${e.enumValues.map(e=>JSON.stringify(e)).join(`, `)}`:e.example&&(t+=`\n Example: ${e.example}`),t});n.push(`## ${e.charAt(0).toUpperCase()}${e.slice(1)}\n\n${t.join(`
24
24
  `)}`)}return n.join(`
25
25
 
26
26
  `)}export{d as buildApiDocsMarkdownDocs};
@@ -1 +1 @@
1
- import{filePathToRouteSlug as e}from"../../../../../shared/utils/routes/file-path-to-route-slug.js";import"../../../../../shared/constants/api-spec-kinds.js";import{createApiEntityKey as t}from"../../../utils/api-entity-key.js";import{filterApiDocsByRbac as n}from"../../../../../shared/rbac/api-docs.js";import{EntityAccessDeniedError as r,notFoundResponse as i}from"../../../../../server/plugin-context.js";import{attachmentDisposition as a}from"../../../../../shared/utils/attachment-disposition.js";import{posix as o}from"node:path";import s from"js-yaml";const c={"Cache-Control":`no-store`};function l(e){return e.replace(/\.[^./]+$/u,``)}async function u(e,t,n){let r=l(t);return(await e.entities.list({type:`api`})).find(({metadata:e})=>{let{sourcePath:t,specType:i}=e??{};return typeof t==`string`&&l(t)===r&&i===`graphql`===n})??null}async function d(n,a){let o=e(a);return await n.hasRoute(o)&&!n.isSlugVisible(o)?new r(t(a),n.request.teams).getResponse():i()}function f(e,t,n,r,i){let o=new URL(t.request.url).searchParams.has(`download`);return e.body(n,200,{...c,"Content-Type":r,...o?{"Content-Disposition":a(i)}:{}})}async function p(e,t){let r=e.req.param(`api`)??``,i=await u(t,r,!1);if(!i)return d(t,r);let a=n(await t.entities.load(i.key),i.metadata?.specType,t.request.teams,{warn:e=>t.logger?.warn(e)}),c=/\.ya?ml$/u.test(r),p=l(o.basename(String(i.metadata?.sourcePath)))+(c?`.yaml`:`.json`);return c?f(e,t,s.dump(a),`application/yaml`,p):f(e,t,JSON.stringify(a,null,2),`application/json`,p)}async function m(e,t){let n=e.req.param(`api`)??``,r=await u(t,n,!0);if(!r)return d(t,n);let i=await t.entities.load(r.key),a=String(r.metadata?.sourcePath);return f(e,t,i,`application/graphql`,o.basename(a))}export{p as bundle,m as graphql};
1
+ import{filePathToRouteSlug as e}from"../../../../../shared/utils/routes/file-path-to-route-slug.js";import"../../../../../shared/constants/api-spec-kinds.js";import{createApiEntityKey as t}from"../../../utils/api-entity-key.js";import{filterApiDocsByRbac as n}from"../../../../../shared/rbac/api-docs.js";import{EntityAccessDeniedError as r,notFoundResponse as i}from"../../../../../server/plugin-context.js";import{attachmentDisposition as a}from"../../../../../shared/utils/attachment-disposition.js";import{SPEC_DOWNLOAD_HANDLER_ID as o,withMockServerEvent as s}from"../../../../../server/telemetry/mock-server-events.js";import{posix as c}from"node:path";import l from"js-yaml";const u={"Cache-Control":`no-store`};function d(e){return e.replace(/\.[^./]+$/u,``)}async function f(e,t,n){let r=d(t);return(await e.entities.list({type:`api`})).find(({metadata:e})=>{let{sourcePath:t,specType:i}=e??{};return typeof t==`string`&&d(t)===r&&i===`graphql`===n})??null}async function p(n,a){let o=e(a);return await n.hasRoute(o)&&!n.isSlugVisible(o)?new r(t(a),n.request.teams).getResponse():i()}function m(e,t,n,r,i){let o=new URL(t.request.url).searchParams.has(`download`);return e.body(n,200,{...u,"Content-Type":r,...o?{"Content-Disposition":a(i)}:{}})}function h(e,t,n){return s({handler:o,request:e.req.raw,logger:t.logger},n)}function g(e,t){return h(e,t,()=>v(e,t))}function _(e,t){return h(e,t,()=>y(e,t))}async function v(e,t){let r=e.req.param(`api`)??``,i=await f(t,r,!1);if(!i)return p(t,r);let a=n(await t.entities.load(i.key),i.metadata?.specType,t.request.teams,{warn:e=>t.logger?.warn(e)}),o=/\.ya?ml$/u.test(r),s=d(c.basename(String(i.metadata?.sourcePath)))+(o?`.yaml`:`.json`);return o?m(e,t,l.dump(a,{noRefs:!0}),`application/yaml`,s):m(e,t,JSON.stringify(a,null,2),`application/json`,s)}async function y(e,t){let n=e.req.param(`api`)??``,r=await f(t,n,!0);if(!r)return p(t,n);let i=await t.entities.load(r.key),a=String(r.metadata?.sourcePath);return m(e,t,i,`application/graphql`,c.basename(a))}export{g as bundle,_ as graphql};
@@ -1 +1 @@
1
- import{canView as e,compileRouteAccessMatcher as t,matchContentRule as n,resolveRbacDenialStatus as r,resolveRole as i}from"../../../../../shared/rbac/engine.js";const a=/* @__PURE__ */ new WeakMap;function o(e){let n=a.get(e);return n===void 0&&(n=t(e),a.set(e,n)),n}function s(t,a){let o=n(t,{filePath:a.sourcePath,slug:a.pathname})?.scope;return e(i(o,a.teams))?{allow:!0}:{allow:!1,status:r(a.teams)}}export{s as resolveApiFunctionAccess,o as resolveRbacMatcher};
1
+ import{canView as e,compileRouteAccessMatcher as t,matchContentScope as n,resolveRbacDenialStatus as r,resolveRole as i}from"../../../../../shared/rbac/engine.js";const a=/* @__PURE__ */ new WeakMap;function o(e){let n=a.get(e);return n===void 0&&(n=t(e),a.set(e,n)),n}function s(t,a){let o=n(t,{filePath:a.sourcePath,slug:a.pathname});return e(i(o,a.teams))?{allow:!0}:{allow:!1,status:r(a.teams)}}export{s as resolveApiFunctionAccess,o as resolveRbacMatcher};
@@ -1 +1 @@
1
- import{API_FUNCTION_ENTITY_TYPE as e}from"../constants.js";import{stripPathPrefix as t}from"../../../../../shared/path-prefix.js";import{compareApiFunctionRoutes as n}from"../route-path.js";import{errorMessage as r}from"../../../../../shared/utils/error-message.js";import{isSubprocessError as i}from"../../../../../server/subprocess/runner.js";import{resolveApiFunctionAccess as a,resolveRbacMatcher as o}from"./access.js";import{sendApiFunctionEvent as s}from"./api-function-telemetry.js";import{BodyTooLargeError as c,MAX_REQUEST_BODY_BYTES as l,MAX_RESPONSE_BODY_BYTES as u,deserializeResponse as d,serializeRequest as f}from"./serialize.js";import{invoke as p}from"./invoke.js";import{fileURLToPath as m}from"node:url";import{getCookie as h}from"hono/cookie";import{TrieRouter as g}from"hono/router/trie-router";import{getPath as _,tryDecodeURIComponent as v}from"hono/utils/url";const y=1048576,b=m(import.meta.url);function x(e){let{method:t,honoPath:n,sourcePath:r}=e.metadata??{};return typeof t==`string`&&typeof n==`string`&&typeof r==`string`?{method:t,honoPath:n,sourcePath:r}:null}const S=/* @__PURE__ */ new WeakMap;function C(e){let t=S.get(e);if(!t){t=new g;let r=e.map(x).filter(e=>e!==null);for(let e of r.sort(n))t.add(e.method,e.honoPath,e);S.set(e,t)}return t}function w(e,t,n){let r=C(e),i=t.toUpperCase(),[[a]]=r.match(i===`HEAD`?`GET`:i,n);if(!a)return null;let[o,s]=a,c=Object.fromEntries(Object.entries(s).map(([e,t])=>{let n=v(t);return[e,o.honoPath.includes(`:${e}{.+}`)?n.split(`/`).filter(Boolean):n]}));return{sourcePath:o.sourcePath,params:c}}function T(e){let t={};for(let n of new Set(e.searchParams.keys())){let r=e.searchParams.getAll(n);t[n]=r.length===1?r[0]:r}return t}const E=1048576,D=`Request body size exceeded limit of ${l/E} MB.`,O=`Response size exceeded limit of ${u/E}MB`,k=1e4,A=`Promise timed out after ${k} ms`;function j(e,t){return Response.json({message:t},{status:e,headers:{"Cache-Control":`no-store`}})}function M(e,t){switch(e){case`timeout`:return N(504,`Timeout exceeded`,A);case`input-too-large`:return N(413,D);case`output-too-large`:case`response-too-large`:return N(500,O);default:return N(500,import.meta.env.DEV?t:`Internal server error`,t)}}function N(e,t,n=t){return{response:j(e,t),failure:n}}async function P(n,i,c){let l=t(_(n.req.raw));if(l===null)return i();let u=new URL(c.request.url),d=w(await c.entities.list({type:e}),c.request.method,l);if(!d)return i();n.set(`realmApiFunctionResponder`,`runtime`);let f=o(c.config);if(f){let e=a(f,{sourcePath:d.sourcePath,pathname:l,teams:c.request.teams});if(!e.allow)return j(e.status,e.status===401?`Unauthorized`:`Forbidden`)}let{subprocess:p}=c;if(!p)return j(501,`API functions do not run on this host.`);let m=(e,t)=>s({sourcePath:d.sourcePath,status:e,failure:t},{logger:c.logger}),h;try{h=await F(n,c,p,d,u)}catch(e){throw await m(500,r(e)),e}return await m(h.response.status,h.failure),h.response}async function F(e,t,n,r,a){let o;try{o={modulePath:n.resolveContentModule(r.sourcePath),request:await f(e.req.raw,l),params:r.params,query:T(a),cookies:h(e),user:{teams:t.request.teams,claims:{...t.request.viewer},email:t.request.viewer?.email,idpAccessToken:void 0,idpId:void 0,isAuthenticated:t.request.viewer?.isAuthenticated??!1},config:t.config,baseUrl:a.origin}}catch(e){if(e instanceof c)return M(`input-too-large`,e.message);throw e}let s;try{s=await n.run({modulePath:b,exportName:`invoke`,input:o,reuse:!import.meta.env.DEV,timeoutMs:k,maxInputBytes:Math.ceil(4/3*l)+y,maxOutputBytes:Math.ceil(4/3*u)+y})}catch(n){if(!i(n))throw n;return n.code===`output-too-large`&&e.set(`realmApiFunctionResponder`,`project`),t.logger?.error(`API function ${r.sourcePath} failed (${n.code}): ${n.message}`),M(n.code,n.message)}if(e.set(`realmApiFunctionResponder`,`project`),!s.ok)return t.logger?.error(`API function ${r.sourcePath} failed (${s.code}): ${s.stack??s.message}`),M(s.code,s.message);let p=d(s.response);return p.headers.has(`cache-control`)||p.headers.set(`Cache-Control`,`no-store`),{response:p}}export{P as dispatch,p as invoke,w as matchApiFunction};
1
+ import{API_FUNCTION_ENTITY_TYPE as e}from"../constants.js";import{stripPathPrefix as t}from"../../../../../shared/path-prefix.js";import{compareApiFunctionRoutes as n}from"../route-path.js";import{isSubprocessError as r}from"../../../../../server/subprocess/runner.js";import{errorMessage as i}from"../../../../../shared/utils/error-message.js";import{resolveApiFunctionAccess as a,resolveRbacMatcher as o}from"./access.js";import{sendApiFunctionEvent as s}from"./api-function-telemetry.js";import{BodyTooLargeError as c,MAX_REQUEST_BODY_BYTES as l,MAX_RESPONSE_BODY_BYTES as u,deserializeResponse as d,serializeRequest as f}from"./serialize.js";import{invoke as p}from"./invoke.js";import{fileURLToPath as m}from"node:url";import{getCookie as h}from"hono/cookie";import{TrieRouter as g}from"hono/router/trie-router";import{getPath as _,tryDecodeURIComponent as v}from"hono/utils/url";const y=1048576,b=m(import.meta.url);function x(e){let{method:t,honoPath:n,sourcePath:r}=e.metadata??{};return typeof t==`string`&&typeof n==`string`&&typeof r==`string`?{method:t,honoPath:n,sourcePath:r}:null}const S=/* @__PURE__ */ new WeakMap;function C(e){let t=S.get(e);if(!t){t=new g;let r=e.map(x).filter(e=>e!==null);for(let e of r.sort(n))t.add(e.method,e.honoPath,e);S.set(e,t)}return t}function w(e,t,n){let r=C(e),i=t.toUpperCase(),[[a]]=r.match(i===`HEAD`?`GET`:i,n);if(!a)return null;let[o,s]=a,c=Object.fromEntries(Object.entries(s).map(([e,t])=>{let n=v(t);return[e,o.honoPath.includes(`:${e}{.+}`)?n.split(`/`).filter(Boolean):n]}));return{sourcePath:o.sourcePath,params:c}}function T(e){let t={};for(let n of new Set(e.searchParams.keys())){let r=e.searchParams.getAll(n);t[n]=r.length===1?r[0]:r}return t}const E=1048576,D=`Request body size exceeded limit of ${l/E} MB.`,O=`Response size exceeded limit of ${u/E}MB`,k=1e4,A=`Promise timed out after ${k} ms`;function j(e,t){return Response.json({message:t},{status:e,headers:{"Cache-Control":`no-store`}})}function M(e,t){switch(e){case`timeout`:return N(504,`Timeout exceeded`,A);case`input-too-large`:return N(413,D);case`output-too-large`:case`response-too-large`:return N(500,O);default:return N(500,import.meta.env.DEV?t:`Internal server error`,t)}}function N(e,t,n=t){return{response:j(e,t),failure:n}}async function P(n,r,c){let l=t(_(n.req.raw));if(l===null)return r();let u=new URL(c.request.url),d=w(await c.entities.list({type:e}),c.request.method,l);if(!d)return r();n.set(`realmApiFunctionResponder`,`runtime`);let f=o(c.config);if(f){let e=a(f,{sourcePath:d.sourcePath,pathname:l,teams:c.request.teams});if(!e.allow)return j(e.status,e.status===401?`Unauthorized`:`Forbidden`)}let{subprocess:p}=c;if(!p)return j(501,`API functions do not run on this host.`);let m=(e,t)=>s({sourcePath:d.sourcePath,status:e,failure:t},{logger:c.logger}),h;try{h=await F(n,c,p,d,u)}catch(e){throw await m(500,i(e)),e}return await m(h.response.status,h.failure),h.response}async function F(e,t,n,i,a){let o;try{o={modulePath:n.resolveContentModule(i.sourcePath),request:await f(e.req.raw,l),params:i.params,query:T(a),cookies:h(e),user:{teams:t.request.teams,claims:{...t.request.viewer},email:t.request.viewer?.email,idpAccessToken:void 0,idpId:void 0,isAuthenticated:t.request.viewer?.isAuthenticated??!1},config:t.config,baseUrl:a.origin}}catch(e){if(e instanceof c)return M(`input-too-large`,e.message);throw e}let s;try{s=await n.run({modulePath:b,exportName:`invoke`,input:o,reuse:!import.meta.env.DEV,timeoutMs:k,maxInputBytes:Math.ceil(4/3*l)+y,maxOutputBytes:Math.ceil(4/3*u)+y})}catch(n){if(!r(n))throw n;return n.code===`output-too-large`&&e.set(`realmApiFunctionResponder`,`project`),t.logger?.error(`API function ${i.sourcePath} failed (${n.code}): ${n.message}`),M(n.code,n.message)}if(e.set(`realmApiFunctionResponder`,`project`),!s.ok)return t.logger?.error(`API function ${i.sourcePath} failed (${s.code}): ${s.stack??s.message}`),M(s.code,s.message);let p=d(s.response);return p.headers.has(`cache-control`)||p.headers.set(`Cache-Control`,`no-store`),{response:p}}export{P as dispatch,p as invoke,w as matchApiFunction};
@@ -5,7 +5,7 @@ import type { SystemEntityDescriptor } from '../../../database/finalize';
5
5
  import type { RouteAccess } from '../../utils/route-index.js';
6
6
  export { APP_DATA_STATIC_DATA_SLUG } from '../../../../shared/constants/app-data';
7
7
  export declare const APP_DATA_PLUGIN_ID = "internal.app-data";
8
- export declare const APP_DATA_PLUGIN_VERSION = "1.32.0";
8
+ export declare const APP_DATA_PLUGIN_VERSION = "1.33.0";
9
9
  export declare const APP_DATA_STATIC_DATA_LOADER_ID: "internal.app-data:app-data";
10
10
  export type AppDataFragment = {
11
11
  owner: string;
@@ -1 +1 @@
1
- import{defineContentPlugin as e}from"../../define.js";import{toJsonObject as t,toJsonValue as n}from"../../../database/utils/json.js";import{createEntityLoader as r}from"../../../loaders/define.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{buildSearchAppData as a}from"../../../../shared/search/facets.js";import{isAttributionRemoved as o,isPlanFeatureGranted as s}from"../../../../shared/plan-gates.js";import{isObject as c}from"../../../../shared/utils/is-object.js";import{isAiHidden as l}from"../../../../shared/ask-ai/config-gate.js";import{APP_DATA_STATIC_DATA_SLUG as u}from"../../../../shared/constants/app-data.js";import{splitUrlSuffix as d}from"../../../../shared/utils/routes/split-url-suffix.js";import{toNavItemRbacAnnotation as f}from"../../../../shared/rbac/filter.js";import{resolvePageTarget as p}from"../../../../shared/utils/routes/resolve-page-target.js";import{listConfiguredProducts as m}from"../../../products.js";import{collectVersionGroups as h,findVersionedDirectories as g}from"../../../versions/version-groups.js";import{publicLink as _}from"../../../versions/public-link.js";import{linkedPageAccess as v}from"../../utils/link-access.js";import{loadSidebarSubtreeLabel as ee}from"../../utils/sidebar-label.js";import{resolveBannerForAppData as te}from"./banner.js";import{resolveLogoForAppData as ne}from"./logo.js";import{resolveNavbarIconsForAppData as y}from"./navbar-icons.js";import{resolveHtmlForAppData as b}from"./html.js";import{resolveSeoForAppData as x}from"./seo.js";import{productConfigPath as S,productLandingLink as C,readProductConfig as w,resolveProductAssetsForAppData as T}from"./products.js";import{dirname as E,resolve as D}from"node:path";import{REDOCLY_TEAMS_RBAC as O}from"@redocly/config";const k=`internal.app-data`,A=`1.32.0`,j=i(k,`app-data`);function M(e){return c(e)&&typeof e.owner==`string`&&`value`in e}const N=r(j,async e=>{let n=new Set(e.pluginRegistry.listFinalizePlugins().map(e=>e.id)),r={};for(let[t,i]of Object.entries(e.args.fragments??{}))M(i)&&n.has(i.owner)&&(r[t]=i.value);let i=await ne(e.config.logo,e.markdown,e.file.path);if(Object.keys(i.logo).length>0){let e=c(r.theme)?r.theme:{};r.theme=t({...e,logo:i.logo})}let a=await te(e.config.banner,e);if(a){let e=c(r.theme)?r.theme:{};r.theme=t({...e,banner:a.banner})}let o=await y(c(r.theme)?r.theme.navbar:void 0,e.markdown,e.file.path);if(o){let e=c(r.theme)?r.theme:{};r.theme=t({...e,navbar:o.navbar})}let s=await y(c(r.theme)?r.theme.footer:void 0,e.markdown,e.file.path);if(s){let e=c(r.theme)?r.theme:{};r.theme=t({...e,footer:s.navbar})}let l=await T(c(r.theme)?r.theme.products:void 0,e.markdown,e.file.path);if(l){let e=c(r.theme)?r.theme:{};r.theme=t({...e,products:l.products})}let u=await b(e.config,e.markdown,e.file.path,t=>e.io.readFile(D(E(e.file.absolutePath),t)),e.logger);u&&(r.html=t(u.html));let d=await x(r.seo,e.markdown,e.file.path);d&&(r.seo=d.seo);let f=[i,a,o,s,l,u,d];return{value:r,entityDeps:f.flatMap(e=>e?.deps??[]),assetUsages:f.flatMap(e=>e?.assetUsages??[])}});function P(e){return{isSystem:!0,key:u,kind:`loader`,type:null,metadata:null,loaderArgs:{pluginVersion:A},loaderId:j,pluginId:k,shouldInvalidateValue:!1,value:null,version:null,fragmentUpdates:e.fragmentUpdates}}const F=e({id:k,version:A,async finalize(e){let r=await h({io:e.io,routes:e.routes,versionedDirectories:g(e.routes.all())}),i=e=>e&&_(e,r),a=t=>t&&{slug:_(t,r),loadLabel:()=>ee(e.entities,t)},o=t=>a(e.routes.byFilePath(t)),s=t=>a(e.routes.bySlug(t)),l=t=>v(t,e.routes,r),u=await B(e.config,o,s,e.logger,l),d=await L(e,o,s,i,l);if(Object.keys(d).length>0){let e=c(u.theme)?u.theme:{};u.theme=t({...e,products:d}),u.pageProducts=n(Object.values(d).map(I))}return{appData:u}},loaders:[N]});function I(e){let{name:t,slug:n,configOverride:r}=e,i={name:t,slug:n},a=r?.analytics?.ga;return a&&(i.ga=a),i}async function L(e,n,r,i,o){let s={};for(let t of m(e.config)){let c=await C(t,e.routes,e.io,i);if(c===void 0){e.logger.warn(`Product "${t.id}" is left out of the product picker: "${t.folder}" has no page.`);continue}let l={name:t.name,folder:t.folder,slug:t.slug,link:c,[O]:o(c)??void 0};t.icon!==void 0&&(l.icon=t.icon);let u=S(t.folder),d=await e.io.exists(u)?await R(w(await e.io.readFile(u),u),{page:Q(n,r,u,e.logger),access:o},a(e.config),e.config):{};Object.keys(d).length>0&&(l.configOverride=d),s[t.id]=l}return t(s)}async function R(e,t,n,r){let i={},a=await G(e.navbar,t),o=await W(e.footer,t),c=U(e.breadcrumbs,t);return e.logo&&(i.logo=e.logo),a&&(i.navbar=a),o&&(i.footer=o),c&&s(r,`breadcrumbs`)&&(i.breadcrumbs=c),e.feedback&&(i.feedback=e.feedback),e.sidebar&&(i.sidebar=e.sidebar),e.codeSnippet&&(i.codeSnippet=e.codeSnippet),e.palette&&(i.palette=e.palette),e.search&&(i.search=await z(e.search,n,t)),e.analytics?.ga&&s(r,`analytics`)&&(i.analytics={ga:e.analytics.ga}),i}async function z(e,n,r){let i={...n},a=await K(e?.suggestedPages,r);return e?.hide!==void 0&&(i.hide=e.hide),e?.placement!==void 0&&(i.placement=e.placement),e?.shortcuts!==void 0&&(i.shortcuts=e.shortcuts),a.length>0&&(i.suggestedPages=a),t(i)}async function B(e,n,r,i,s=()=>void 0){let c={},l={page:Q(n,r,Z,i),access:s},u=await G(e.navbar,l),d=await W(e.footer,l),f=e.seo?.projectTitle,p=U(e.breadcrumbs,l),m={...u?{navbar:u}:{},...d?{footer:d}:{},...p?{breadcrumbs:p}:{},markdown:e.markdown,navigation:e.navigation,userMenu:await Y(e.userMenu,l),feedback:e.feedback,consent:e.consent,...f?{seo:{projectTitle:f}}:{},aiAssistant:V(e),mcp:H(e),search:await z(e.search,a(e),l),sidebar:e.sidebar,versionPicker:e.versionPicker,codeSnippet:e.codeSnippet,palette:e.palette};if(e.colorMode&&(m.colorMode=e.colorMode),Object.keys(m).length>0&&(c.theme=m),e.analytics&&(c.analytics=e.analytics),e.planGates&&(c.removeAttribution=o(e)),e.removeAttribution===!0&&(c.removeConsoleAttribution=!0),e.seo){let{projectTitle:t,llmstxt:n,...r}=e.seo;Object.keys(r).length>0&&(c.seo=r)}return t(c)}function V(e){let t=l(e),n=e.aiAssistant?.trigger;return{...e.aiAssistant,hide:t,trigger:{...n,hide:n?.hide??t}}}function H(e){let t=e.mcp?.hide===!0;return{hide:t,docs:{hide:t}}}function U(e,n){if(!e)return null;let r={};e.hide!==void 0&&(r.hide=e.hide);let i=(e.prefixItems??[]).map(e=>{let t=e.page?n.page(e.page)?.link:void 0;return{icon:$(e.icon),label:$(e.label)??``,labelTranslationKey:$(e.labelTranslationKey),link:t,[O]:J(n,t)}});return i.length>0&&(r.prefixItems=i),Object.keys(r).length>0?t(r):null}async function W(e,n){if(!e)return null;let r={hide:e.hide===!0},i=await K(e.items,n);return e.copyrightText!==void 0&&(r.copyrightText=e.copyrightText),e.logo&&(r.logo=e.logo),i.length>0&&(r.items=i),t(r)}async function G(e,n){if(!e)return null;let r={},i=await K(e.items,n);return e.hide!==void 0&&(r.hide=e.hide),i.length>0&&(r.items=i),Object.keys(r).length>0?t(r):null}async function K(e,t){return Array.isArray(e)?(await Promise.all(e.map(e=>q(e,t)))).filter(e=>e!==null):[]}async function q(e,n){if(typeof e==`string`)return q({page:e},n);if(!c(e))return null;if(typeof e.separator==`string`)return t({...X(e),label:e.separator,type:`separator`});let r=await K(e.items,n),i=ie(e,n.page),a=i?.link,o=e.rbac===void 0?J(n,a):void 0,s=$(e.label)??$(e.group)??(i?i.anchor??await i.loadLabel?.()??i.link:``);return typeof e.group==`string`||r.length>0?t({...X(e),...a?{link:a}:{},...r.length>0?{items:r}:{},label:s,labelTranslationKey:$(e.groupTranslationKey)??$(e.labelTranslationKey),type:`group`,[O]:o}):a?t({...X(e),...se(e.external)??ae(a)?{external:!0}:{},label:s,link:a,type:`link`,[O]:o}):null}function J(e,t){return t===void 0?void 0:e.access(t)??void 0}async function Y(e,n){if(!e)return;let r=[];for(let t of e.items??[])r.push({...t,href:t.link});let i=await K(r,n);return t({...e,menu:i.length>0?i:void 0})}function X(e){let t=oe(e,[`additionalProps`,`expanded`,`labelTranslationKey`,`languageInsensitive`,`linePosition`,`linkedSidebars`,`menuStyle`,`selectFirstItemOnExpand`,`separatorLine`,`target`,`version`]),n=re(e.icon);return n.icon&&(t.icon=n.icon),n.srcSet&&(t.srcSet=n.srcSet),{...t,...f(e.rbac)}}function re(e){return typeof e==`string`?{icon:e}:c(e)&&typeof e.srcSet==`string`?{srcSet:e.srcSet}:{}}function ie(e,t){return typeof e.href==`string`&&e.href.trim()!==``?{link:e.href.trim()}:typeof e.page==`string`&&e.page.trim()!==``?t(e.page):null}const Z=`redocly.yaml`;function Q(e,t,n,r){let i={bySlug:e=>t?.(e),byFilePath:t=>e?.(t)};return e=>{let{path:t,suffix:a,anchor:o}=d(e.trim()),s=p(t,n,i);return s.kind===`escaped`?(r?.warn(`Config page reference escapes the content root`,{page:e}),null):s.kind===`missing`?(r?.warn(`Config page has no matching route`,{page:e}),{link:e.trim()}):{link:`${s.value.slug}${a}`,anchor:o,loadLabel:s.value.loadLabel}}}function ae(e){return/^(?:[a-z][a-z\d+.-]*:)?\/\//i.test(e)||/^(?:mailto|tel):/i.test(e)}function oe(e,t){let n={};for(let r of t)e[r]!==void 0&&(n[r]=e[r]);return n}function $(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function se(e){return typeof e==`boolean`?e:void 0}export{k as APP_DATA_PLUGIN_ID,A as APP_DATA_PLUGIN_VERSION,j as APP_DATA_STATIC_DATA_LOADER_ID,u as APP_DATA_STATIC_DATA_SLUG,F as appDataContentPlugin,P as appDataSystemEntityDescriptor,B as buildConfigAppData,M as isAppDataFragment};
1
+ import{defineContentPlugin as e}from"../../define.js";import{toJsonObject as t,toJsonValue as n}from"../../../database/utils/json.js";import{createEntityLoader as r}from"../../../loaders/define.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{buildSearchAppData as a}from"../../../../shared/search/facets.js";import{isAttributionRemoved as o,isPlanFeatureGranted as s}from"../../../../shared/plan-gates.js";import{isObject as c}from"../../../../shared/utils/is-object.js";import{isAiHidden as l}from"../../../../shared/ask-ai/config-gate.js";import{APP_DATA_STATIC_DATA_SLUG as u}from"../../../../shared/constants/app-data.js";import{splitUrlSuffix as d}from"../../../../shared/utils/routes/split-url-suffix.js";import{toNavItemRbacAnnotation as f}from"../../../../shared/rbac/filter.js";import{resolvePageTarget as p}from"../../../../shared/utils/routes/resolve-page-target.js";import{listConfiguredProducts as m}from"../../../products.js";import{collectVersionGroups as h,findVersionedDirectories as g}from"../../../versions/version-groups.js";import{publicLink as _}from"../../../versions/public-link.js";import{linkedPageAccess as v}from"../../utils/link-access.js";import{loadSidebarSubtreeLabel as y}from"../../utils/sidebar-label.js";import{resolveBannerForAppData as ee}from"./banner.js";import{resolveLogoForAppData as te}from"./logo.js";import{resolveNavbarIconsForAppData as b}from"./navbar-icons.js";import{resolveHtmlForAppData as x}from"./html.js";import{resolveSeoForAppData as S}from"./seo.js";import{productConfigPath as C,productLandingLink as w,readProductConfig as T,resolveProductAssetsForAppData as E}from"./products.js";import{dirname as D,resolve as O}from"node:path";import{REDOCLY_TEAMS_RBAC as k}from"@redocly/config";const A=`internal.app-data`,j=`1.33.0`,M=i(A,`app-data`);function N(e){return c(e)&&typeof e.owner==`string`&&`value`in e}const P=r(M,async e=>{let n=new Set(e.pluginRegistry.listFinalizePlugins().map(e=>e.id)),r={};for(let[t,i]of Object.entries(e.args.fragments??{}))N(i)&&n.has(i.owner)&&(r[t]=i.value);let i=await te(e.config.logo,e.markdown,e.file.path);if(Object.keys(i.logo).length>0){let e=c(r.theme)?r.theme:{};r.theme=t({...e,logo:i.logo})}let a=await ee(e.config.banner,e);if(a){let e=c(r.theme)?r.theme:{};r.theme=t({...e,banner:a.banner})}let o=await b(c(r.theme)?r.theme.navbar:void 0,e.markdown,e.file.path);if(o){let e=c(r.theme)?r.theme:{};r.theme=t({...e,navbar:o.navbar})}let s=await b(c(r.theme)?r.theme.footer:void 0,e.markdown,e.file.path);if(s){let e=c(r.theme)?r.theme:{};r.theme=t({...e,footer:s.navbar})}let l=await E(c(r.theme)?r.theme.products:void 0,e.markdown,e.file.path);if(l){let e=c(r.theme)?r.theme:{};r.theme=t({...e,products:l.products})}let u=await x(e.config,e.markdown,e.file.path,t=>e.io.readFile(O(D(e.file.absolutePath),t)),e.logger);u&&(r.html=t(u.html));let d=await S(r.seo,e.markdown,e.file.path);d&&(r.seo=d.seo);let f=[i,a,o,s,l,u,d];return{value:r,entityDeps:f.flatMap(e=>e?.deps??[]),assetUsages:f.flatMap(e=>e?.assetUsages??[])}});function F(e){return{isSystem:!0,key:u,kind:`loader`,type:null,metadata:null,loaderArgs:{pluginVersion:j},loaderId:M,pluginId:A,shouldInvalidateValue:!1,value:null,version:null,fragmentUpdates:e.fragmentUpdates}}const I=e({id:A,version:j,async finalize(e){let r=await h({io:e.io,routes:e.routes,versionedDirectories:g(e.routes.all())}),i=e=>e&&_(e,r),a=t=>t&&{slug:_(t,r),loadLabel:()=>y(e.entities,t)},o=t=>a(e.routes.byFilePath(t)),s=t=>a(e.routes.bySlug(t)),l=t=>v(t,e.routes,r),u=await V(e.config,o,s,e.logger,l),d=await R(e,o,s,i,l);if(Object.keys(d).length>0){let e=c(u.theme)?u.theme:{};u.theme=t({...e,products:d}),u.pageProducts=n(Object.values(d).map(L))}return{appData:u}},loaders:[P]});function L(e){let{name:t,slug:n,configOverride:r}=e,i={name:t,slug:n},a=r?.analytics?.ga;return a&&(i.ga=a),i}async function R(e,n,r,i,o){let s={};for(let t of m(e.config)){let c=await w(t,e.routes,e.io,i);if(c===void 0){e.logger.warn(`Product "${t.id}" is left out of the product picker: "${t.folder}" has no page.`);continue}let l={name:t.name,folder:t.folder,slug:t.slug,link:c,[k]:o(c)??void 0};t.icon!==void 0&&(l.icon=t.icon);let u=C(t.folder),d=await e.io.exists(u)?await z(T(await e.io.readFile(u),u),{page:Q(n,r,u,e.logger),access:o},a(e.config),e.config):{};Object.keys(d).length>0&&(l.configOverride=d),s[t.id]=l}return t(s)}async function z(e,t,n,r){let i={},a=await K(e.navbar,t),o=await G(e.footer,t),c=W(e.breadcrumbs,t);return e.logo&&(i.logo=e.logo),a&&(i.navbar=a),o&&(i.footer=o),c&&s(r,`breadcrumbs`)&&(i.breadcrumbs=c),e.feedback&&(i.feedback=e.feedback),e.sidebar&&(i.sidebar=e.sidebar),e.codeSnippet&&(i.codeSnippet=e.codeSnippet),e.palette&&(i.palette=e.palette),e.search&&(i.search=await B(e.search,n,t)),e.analytics?.ga&&s(r,`analytics`)&&(i.analytics={ga:e.analytics.ga}),i}async function B(e,n,r){let i={...n},a=await q(e?.suggestedPages,r);return e?.hide!==void 0&&(i.hide=e.hide),e?.placement!==void 0&&(i.placement=e.placement),e?.shortcuts!==void 0&&(i.shortcuts=e.shortcuts),a.length>0&&(i.suggestedPages=a),t(i)}async function V(e,n,r,i,s=()=>void 0){let c={},l={page:Q(n,r,ie,i),access:s},u=await K(e.navbar,l),d=await G(e.footer,l),f=e.seo?.projectTitle,p=W(e.breadcrumbs,l),m={...u?{navbar:u}:{},...d?{footer:d}:{},...p?{breadcrumbs:p}:{},markdown:e.markdown,navigation:e.navigation,userMenu:await X(e.userMenu,l),feedback:e.feedback,consent:e.consent,...f?{seo:{projectTitle:f}}:{},aiAssistant:H(e),mcp:U(e),search:await B(e.search,a(e),l),sidebar:e.sidebar,versionPicker:e.versionPicker,codeSnippet:e.codeSnippet,palette:e.palette};if(e.colorMode&&(m.colorMode=e.colorMode),Object.keys(m).length>0&&(c.theme=m),e.analytics&&(c.analytics=e.analytics),e.planGates&&(c.removeAttribution=o(e)),e.removeAttribution===!0&&(c.removeConsoleAttribution=!0),e.seo){let{projectTitle:t,llmstxt:n,...r}=e.seo;Object.keys(r).length>0&&(c.seo=r)}return t(c)}function H(e){let t=l(e),n=e.aiAssistant?.trigger;return{...e.aiAssistant,hide:t,trigger:{...n,hide:n?.hide??t}}}function U(e){let t=e.mcp?.hide===!0;return{hide:t,docs:{hide:t}}}function W(e,n){if(!e)return null;let r={};e.hide!==void 0&&(r.hide=e.hide);let i=(e.prefixItems??[]).map(e=>{let t=e.page?n.page(e.page)?.link:void 0;return{icon:$(e.icon),label:$(e.label)??``,labelTranslationKey:$(e.labelTranslationKey),link:t,[k]:Y(n,t)}});return i.length>0&&(r.prefixItems=i),Object.keys(r).length>0?t(r):null}async function G(e,n){if(!e)return null;let r={hide:e.hide===!0},i=await q(e.items,n);return e.copyrightText!==void 0&&(r.copyrightText=e.copyrightText),e.logo&&(r.logo=e.logo),i.length>0&&(r.items=i),t(r)}async function K(e,n){if(!e)return null;let r={},i=await q(e.items,n);return e.hide!==void 0&&(r.hide=e.hide),i.length>0&&(r.items=i),Object.keys(r).length>0?t(r):null}async function q(e,t){return Array.isArray(e)?(await Promise.all(e.map(e=>J(e,t)))).filter(e=>e!==null):[]}async function J(e,n){if(typeof e==`string`)return J({page:e},n);if(!c(e))return null;if(typeof e.separator==`string`)return t({...Z(e),label:e.separator,type:`separator`});let r=await q(e.items,n),i=re(e,n.page),a=i?.link,o=e.rbac===void 0?Y(n,a):void 0,s=$(e.label)??$(e.group)??(i?i.anchor??await i.loadLabel?.()??i.link:``);return typeof e.group==`string`||r.length>0?t({...Z(e),...a?{link:a}:{},...r.length>0?{items:r}:{},label:s,labelTranslationKey:$(e.groupTranslationKey)??$(e.labelTranslationKey),type:`group`,[k]:o}):a?t({...Z(e),external:oe(e.external),label:s,link:a,type:`link`,[k]:o}):null}function Y(e,t){return t===void 0?void 0:e.access(t)??void 0}async function X(e,n){if(!e)return;let r=[];for(let t of e.items??[])r.push({...t,href:t.link});let i=await q(r,n);return t({...e,menu:i.length>0?i:void 0})}function Z(e){let t=ae(e,[`additionalProps`,`expanded`,`labelTranslationKey`,`languageInsensitive`,`linePosition`,`linkedSidebars`,`menuStyle`,`selectFirstItemOnExpand`,`separatorLine`,`target`,`version`]),n=ne(e.icon);return n.icon&&(t.icon=n.icon),n.srcSet&&(t.srcSet=n.srcSet),{...t,...f(e.rbac)}}function ne(e){return typeof e==`string`?{icon:e}:c(e)&&typeof e.srcSet==`string`?{srcSet:e.srcSet}:{}}function re(e,t){return typeof e.href==`string`&&e.href.trim()!==``?{link:e.href.trim()}:typeof e.page==`string`&&e.page.trim()!==``?t(e.page):null}const ie=`redocly.yaml`;function Q(e,t,n,r){let i={bySlug:e=>t?.(e),byFilePath:t=>e?.(t)};return e=>{let{path:t,suffix:a,anchor:o}=d(e.trim()),s=p(t,n,i);return s.kind===`escaped`?(r?.warn(`Config page reference escapes the content root`,{page:e}),null):s.kind===`missing`?(r?.warn(`Config page has no matching route`,{page:e}),{link:e.trim()}):{link:`${s.value.slug}${a}`,anchor:o,loadLabel:s.value.loadLabel}}}function ae(e,t){let n={};for(let r of t)e[r]!==void 0&&(n[r]=e[r]);return n}function $(e){return typeof e==`string`&&e.trim()!==``?e:void 0}function oe(e){return typeof e==`boolean`?e:void 0}export{A as APP_DATA_PLUGIN_ID,j as APP_DATA_PLUGIN_VERSION,M as APP_DATA_STATIC_DATA_LOADER_ID,u as APP_DATA_STATIC_DATA_SLUG,I as appDataContentPlugin,F as appDataSystemEntityDescriptor,V as buildConfigAppData,N as isAppDataFragment};
@@ -1 +1 @@
1
- import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import{runtimeTemplate as i}from"../../templates.js";import{SEARCH_GROUP_FACET_FIELD as a}from"../../../../shared/search/facets.js";import{configuredFacetFields as o,extractFacetsFromFrontmatter as s,invalidFacetValueProblems as c,searchCategoryOf as l}from"../../../search/facet-values.js";import{isPlanFeatureGranted as u}from"../../../../shared/plan-gates.js";import{SOURCE_TEMPLATE_PREFIX as d}from"../../../../shared/constants/template-ids.js";import{isObject as f}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as p}from"../../../../shared/utils/routes/normalize-route-slug.js";import{resolveContentPath as m}from"../../../../shared/utils/resolve-content-path.js";import{PAGE_BANNER_SCHEMA as h,sanitizeConfig as g}from"../../../config-schema.js";import{notInPlanProblem as _}from"../../../plan-gates.js";import{matchPathMap as v}from"../../utils/glob.js";import{filePathToRouteSlug as y}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{splitUrlSuffix as b}from"../../../../shared/utils/routes/split-url-suffix.js";import{packMarkdocAst as x,unpackMarkdocAst as S}from"../../../../shared/utils/packed-ast.js";import{isRouteSlugTarget as ee}from"../../../../shared/utils/routes/is-route-slug-target.js";import{loadSidebarSubtreeLabel as te}from"../../utils/sidebar-label.js";import{markdocNodeRange as ne}from"../../../markdown/utils/node-source-range.js";import{replaceWithMarkdocError as C}from"../../../markdown/tags/markdoc-error.js";import{getPartialTwins as w}from"../../../markdown/tags/partial.js";import{CODE_WALKTHROUGH_TAG_NAMES as re,builtInMarkdocTags as ie}from"../../../markdown/constants/builtin-tags.js";import{walkMarkdocAst as T}from"../../../markdown/utils/walk-markdoc-ast.js";import{markdocFirstHeading as ae}from"../../../markdown/search/to-text.js";import{safeDecodeURI as oe}from"../../../../shared/utils/safe-decode-uri.js";import{shiftRange as se}from"../../../../shared/utils/shift-range.js";import{classifyLinkTarget as ce}from"../../../link-checker/classify.js";import{onDiskLinkRefs as le}from"../../../link-checker/node-ref.js";import{isPartialPath as ue}from"../../../markdown/utils/partials.js";import{FRONTMATTER_BLOCK_RE as de,computeFrontmatterLineOffset as fe}from"../../../markdown/utils/frontmatter-offset.js";import{inlineRawPartials as E}from"../../../markdown/resolve/raw-partials.js";import{resolveMarkdownAst as D}from"../../../markdown/resolve/ast.js";import{resolveBannerForAppData as O}from"../app-data/banner.js";import{MARKDOC_DOCUMENT_LOADER_KEY as k}from"../../../../shared/constants/route-deps.js";import{isMarkdocValidationEnabled as A,resolveMarkdocTagSet as j,resolveMarkdownPageValidationSet as M,userMarkdocSchemaFiles as N,userMarkdocTagNames as P}from"../../../markdown/constants/tag-sets.js";import{pageLocale as F}from"../../utils/page-locale.js";import{markdocAstToMarkdownDoc as I}from"../../../markdown/search/to-markdown.js";import{collectAnchors as L}from"../../../markdown/utils/collect-anchors.js";import{frontmatterVariable as R}from"../../../markdown/utils/frontmatter-variable.js";import{markdownFirstHeading as z}from"../../../markdown/utils/first-heading.js";import{markdocAstToSearchSections as B}from"../../../markdown/search/to-sections.js";import{isInternalPagePath as V}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as pe}from"../../utils/explicit-slugs.js";import{isSkillContentPath as me}from"../../utils/skill-paths.js";import{captureSnippet as H,splitSourceLines as he}from"../../../../shared/utils/capture-snippet.js";import{curationKeywordsOf as U}from"../../../search/keywords.js";import ge from"js-yaml";const W=`markdoc-page`,G=r(`internal.markdoc`,`document`),K=r(`internal.markdoc`,`sidebar-item`),_e=`Documentation`,q=t(G,async e=>{let t=await e.io.readFile(e.file.absolutePath),{content:n,frontmatter:r,frontmatterError:i}=X(t),a=Y(e),{ast:o,entityDeps:s,assetUsages:c,tagList:l,problems:d,linkRefs:f}=await D(n,e.file.path,{resolverContext:a,tags:(await j()).tags,variables:{get env(){return e.config.publicEnv??{}}},transform:t=>Ee(t,e.file.path,Te(e.config)),validation:A()?await M():void 0}),p=fe(t);Me(o);let m=await we(r.seo,e),h=u(e.config,`banner`)?await O(Ne(r,e.file.path,e.logger),a):void 0,g=await Oe(r,e),_=await ke(r.navigation,e),v={...g.frontmatter,navigation:_.value,seo:m.seo,banner:h?.banner},y=Pe(r,o);return{value:{ast:x(o),frontmatter:v,tagList:l,title:y,editPage:Ce(e.config,r,e.file.path),lastModified:e.file.lastModifiedAt},entityDeps:[...s,...ye(),...m.entityDeps,...h?.deps??[],...g.entityDeps,..._.entityDeps],assetUsages:[...c,...m.assetUsages,...h?.assetUsages??[],...g.assetUsages],problems:be(t,e.file.path,p,d,i),linkRefs:[...le(f,p),..._.linkRefs],targetInventories:[xe(o,{frontmatter:R(v,y)})]}},{usesProjectMarkdocSchema:!0,async markdown(e,t){let{tags:n}=await j(),{chunks:r,headings:i}=I(S(e.ast),{tags:n,locale:F(t),variables:{frontmatter:R(e.frontmatter,e.title),env:t.config.publicEnv??{}}});return[{chunks:r,headings:i,...e.title?{title:e.title}:{}}]},searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let n=t.route.slug,r=e.title??Q(t.route.originFilePath??n),{category:i,isInvalid:u}=l(t.route.metadata),{facets:d,invalidFields:f}=s(t.route.metadata,o(t.config)),p=U(e.frontmatter.keywords);return{docs:B(S(e.ast),r,{frontmatter:R(e.frontmatter,e.title)}).map((e,t)=>{let r={docKey:e.docKey,routeSlug:n,title:e.title,text:e.text,groupKey:i??`Documentation`,facets:d};e.anchor!==void 0&&(r.anchor=e.anchor),e.path!==void 0&&(r.path=e.path);let a=t===0?p:{excludes:p?.excludes};return(a?.includes||a?.excludes)&&(r.keywords=a),e.rbacTeams!==void 0&&(r.rbacScope=Object.fromEntries(e.rbacTeams.map(e=>[e,`read`]))),r}),problems:c([...f,...u?[a]:[]],t.route.originFilePath)}}}),J=t(K,async e=>{let{content:t,frontmatter:n}=X(await e.io.readFile(e.file.absolutePath)),r=await E(t,e.file.path,Y(e));return{value:{label:Z(n)??z(r.source)??Q(e.args.filePath)},entityDeps:r.entityDeps}});function Y(e){return{config:e.config,contentDir:e.contentDir,entities:e.entities,file:e.file,io:e.io,logger:e.logger,markdown:e.markdown,plugin:e.plugin}}const ve=e({id:`internal.markdoc`,version:`3.46.0`,content:{filter:{match:e=>e.toLowerCase().endsWith(`.md`)&&!me(e)},extractFile(e,t){if(V(e.path)||ue(e.path,t.config))return{routes:[]};if(!u(t.config,`markdown`))return{routes:[],problems:[_(`Markdown pages`)]};let{banner:n,...r}=e.manifest,i=Fe(e,t),a=pe(r.slug),o=q.withArgs({filePath:e.path}),s=J.withArgs({filePath:e.path});return{routes:a.length>0?a.map(e=>({deps:{[k]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:e,slugHint:null,template:i})):[{deps:{[k]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:null,slugHint:y(e.path),template:i}],entities:[o]}}},loaders:[q,J],templates:{[W]:i(n(`./client/template.tsx`,import.meta.url))}});function X(e){let t=e.match(de);if(!t)return{content:e,frontmatter:{}};let n=t[1]??``;try{let r=ge.load(n);return{content:e.slice(t[0].length),frontmatter:f(r)?r:{}}}catch(n){let r=n instanceof Error?n.message:String(n);return{content:e.slice(t[0].length),frontmatter:{},frontmatterError:r}}}function ye(){return(N()??[]).map(e=>({kind:`file`,path:e}))}function be(e,t,n,r,i){if(r.length===0&&i===void 0)return[];let a=he(e),o=r.map(e=>Se(e,a,n,t));if(i!==void 0){let e={start:{line:1},end:{line:n}};o.push({code:`markdown/frontmatter-parse`,message:i,location:{filePath:t,range:e,snippet:H(a,e)}})}return o}function xe(e,t){let{ids:n,exhaustive:r}=L(e,t);return{kind:`anchor`,exhaustive:r,targets:n}}function Se(e,t,n,r){let i=e.location?.range;if(!i)return e;let a=se(i,n);return{...e,location:{filePath:r,range:a,snippet:H(t,a)}}}function Ce(e,t,n){let r=f(t.markdown)?t.markdown:{},i={...e.markdown?.editPage,...f(r.editPage)?r.editPage:{}};if(i.hide!==!0&&typeof i.baseUrl==`string`&&i.baseUrl!==``)return{to:`${i.baseUrl.replace(/(?<!\/)\/+$/,``)}/${n}`}}async function we(e,t){if(!f(e)||typeof e.image!=`string`)return{seo:e,entityDeps:[],assetUsages:[]};let n=await t.markdown.resolveImageReference(e.image,t.file.path);return n.result.kind===`assetRef`?{seo:{...e,image:n.result.url},entityDeps:n.entityDeps,assetUsages:n.assetUsages}:{seo:e,entityDeps:n.entityDeps,assetUsages:[]}}function Te(e){let t=/* @__PURE__ */ new Map;if(!u(e,`customMarkdocTags`))for(let e of P())t.set(e,`Custom Markdoc tags are not in this project's plan, so \`${e}\` is ignored.`);if(!u(e,`codeWalkthrough`))for(let e of re)t.set(e,`\`${e}\` is not in this project's plan and is ignored.`);return t}function Ee(e,t,n){let r=[];if(n.size===0)return r;for(let i of T(e,{getExtraNodes:w})){let e=i.type===`tag`&&i.tag!==void 0?n.get(i.tag):void 0;e!==void 0&&(r.push({code:`configuration/ignored`,message:e,location:{filePath:t,range:ne(i)??{start:{line:1},end:{line:1}}}}),C(i,e))}return r}const De=[`image`,`links`];async function Oe(e,t){let n=t.config.markdown?.frontMatterKeysToResolve??De,r={...e},i=[],a=[];for(let o of n){let n=e[o];if(typeof n!=`string`)continue;let s=await t.markdown.resolveLocalReference(n,t.file.path);i.push(...s.entityDeps),a.push(...s.assetUsages),s.result.kind!==`passthrough`&&(r[o]=s.result.url)}return{frontmatter:r,entityDeps:i,assetUsages:a}}async function ke(e,t){let n=[],r=[];if(!f(e))return{value:e,entityDeps:n,linkRefs:r};let i={...e};for(let a of[`nextButton`,`previousButton`]){let o=e[a];if(!f(o)||typeof o.page!=`string`)continue;let{page:s,...c}=o,l=ce(oe(s),t.file.path);l!==null&&r.push({kind:`link`,raw:s,...l});let u=await je(s,t);n.push(...u.entityDeps),i[a]={...c,label:typeof c.label==`string`?c.label:u.route&&await Ae(u.route,t),link:u.link}}return{value:i,entityDeps:n,linkRefs:r}}async function Ae(e,t){let n=await te(t.entities,e);if(n!==void 0)return n;let r=t.routes.get(e.slug)?.metadata.seo;return f(r)&&typeof r.title==`string`&&r.title.trim()!==``?r.title:e.slug}async function je(e,t){let n=e.trim(),{path:r,suffix:i}=b(n);if(ee(r)){let e=t.routes.bySlug(p(r));return{link:e&&`${e.slug}${i}`,route:e,entityDeps:[]}}let a=await t.markdown.resolveLocalReference(n,t.file.path);if(a.result.kind!==`pageUrl`)return{entityDeps:a.entityDeps};let o=a.result.url;return{link:o,route:t.routes.bySlug(b(o).path)??a.entityDeps.map(e=>e.kind===`file`?t.routes.byFilePath(e.path):void 0).reverse().find(e=>e!==void 0),entityDeps:a.entityDeps}}function Me(e){let t=/* @__PURE__ */ new Map;for(let n of T(e)){if(n.type!==`tag`||n.tag===void 0||ie[n.tag]?.attributes?.__idx===void 0)continue;let e=(t.get(n.tag)??0)+1;t.set(n.tag,e),n.attributes.__idx=e}}function Ne(e,t,n){if(e.banner===void 0)return;let{value:r,problems:i}=g(h,{banner:e.banner});for(let e of i)n?.warn(`${t}: ${e.message}`);return r.banner}function Pe(e,t){return Z(e)??ae(t)??void 0}function Z(e){let t=f(e.seo)?e.seo.title:void 0;return typeof t==`string`&&t.trim()!==``?t:void 0}function Q(e){let t=(e.split(`/`).pop()??e).replace(/\.[^.]+$/,``);return t===``?e:t}function Fe(e,t){let n=e.manifest.template;if(typeof n==`string`&&n.trim()!==``)return $(n,e.path,t.logger);let r=v(e.path,t.config.markdown?.template);return typeof r==`string`&&r.trim()!==``?$(r,`redocly.yaml`,t.logger):W}function $(e,t,n){if(!e.startsWith(`./`)&&!e.startsWith(`../`)&&!e.startsWith(`/`))return e;let r=m(e,t);return r===null?(n.warn(`Template reference "${e}" in ${t} escapes the content root; falling back to ${W}.`),W):`${d}${r}`}export{G as MARKDOC_DOCUMENT_LOADER_ID,_e as MARKDOC_SEARCH_GROUP,K as MARKDOC_SIDEBAR_ITEM_LOADER_ID,W as MARKDOC_TEMPLATE_ID,ve as markdocContentPlugin};
1
+ import{defineContentPlugin as e}from"../../define.js";import{createEntityLoader as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{createPluginScopedId as r}from"../../utils/scoped-id.js";import{runtimeTemplate as i}from"../../templates.js";import{SEARCH_GROUP_FACET_FIELD as a}from"../../../../shared/search/facets.js";import{configuredFacetFields as o,extractFacetsFromFrontmatter as s,invalidFacetValueProblems as c,searchCategoryOf as l}from"../../../search/facet-values.js";import{isPlanFeatureGranted as u}from"../../../../shared/plan-gates.js";import{SOURCE_TEMPLATE_PREFIX as d}from"../../../../shared/constants/template-ids.js";import{isObject as f}from"../../../../shared/utils/is-object.js";import{normalizeRouteSlug as p}from"../../../../shared/utils/routes/normalize-route-slug.js";import{resolveContentPath as m}from"../../../../shared/utils/resolve-content-path.js";import{PAGE_BANNER_SCHEMA as h,sanitizeConfig as g}from"../../../config-schema.js";import{notInPlanProblem as _}from"../../../plan-gates.js";import{matchPathMap as v}from"../../utils/glob.js";import{filePathToRouteSlug as y}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{splitUrlSuffix as b}from"../../../../shared/utils/routes/split-url-suffix.js";import{packMarkdocAst as ee,unpackMarkdocAst as x}from"../../../../shared/utils/packed-ast.js";import{isRouteSlugTarget as S}from"../../../../shared/utils/routes/is-route-slug-target.js";import{loadSidebarSubtreeLabel as C}from"../../utils/sidebar-label.js";import{markdocNodeRange as w}from"../../../markdown/utils/node-source-range.js";import{replaceWithMarkdocError as T}from"../../../markdown/tags/markdoc-error.js";import{getPartialTwins as te}from"../../../markdown/tags/partial.js";import{CODE_WALKTHROUGH_TAG_NAMES as ne,builtInMarkdocTags as re}from"../../../markdown/constants/builtin-tags.js";import{walkMarkdocAst as E}from"../../../markdown/utils/walk-markdoc-ast.js";import{markdocFirstHeading as ie}from"../../../markdown/search/to-text.js";import{safeDecodeURI as ae}from"../../../../shared/utils/safe-decode-uri.js";import{shiftRange as oe}from"../../../../shared/utils/shift-range.js";import{classifyLinkTarget as se}from"../../../link-checker/classify.js";import{onDiskLinkRefs as ce}from"../../../link-checker/node-ref.js";import{isPartialPath as le}from"../../../markdown/utils/partials.js";import{FRONTMATTER_BLOCK_RE as ue,computeFrontmatterLineOffset as de}from"../../../markdown/utils/frontmatter-offset.js";import{inlineRawPartials as D}from"../../../markdown/resolve/raw-partials.js";import{resolveMarkdownAst as O}from"../../../markdown/resolve/ast.js";import{resolveBannerForAppData as k}from"../app-data/banner.js";import{MARKDOC_DOCUMENT_LOADER_KEY as A}from"../../../../shared/constants/route-deps.js";import{isMarkdocValidationEnabled as j,resolveMarkdocTagSet as M,resolveMarkdownPageValidationSet as N,userMarkdocSchemaFiles as P,userMarkdocTagNames as F}from"../../../markdown/constants/tag-sets.js";import{pageLocale as I}from"../../utils/page-locale.js";import{captureSnippet as L,splitSourceLines as R}from"../../../../shared/utils/capture-snippet.js";import{markdocAstToMarkdownDoc as z}from"../../../markdown/search/to-markdown.js";import{collectAnchors as B}from"../../../markdown/utils/collect-anchors.js";import{frontmatterVariable as V}from"../../../markdown/utils/frontmatter-variable.js";import{markdownFirstHeading as H}from"../../../markdown/utils/first-heading.js";import{markdocAstToSearchSections as fe}from"../../../markdown/search/to-sections.js";import{isInternalPagePath as pe}from"../../utils/internal-page-path.js";import{parseExplicitSlugs as me}from"../../utils/explicit-slugs.js";import{isSkillContentPath as he}from"../../utils/skill-paths.js";import{curationKeywordsOf as ge}from"../../../search/keywords.js";import _e from"js-yaml";const U=`markdoc-page`,W=r(`internal.markdoc`,`document`),G=r(`internal.markdoc`,`sidebar-item`),ve=`Documentation`,K=t(W,async e=>{let t=await e.io.readFile(e.file.absolutePath),{content:n,frontmatter:r,frontmatterError:i}=Y(t),a=J(e),{ast:o,entityDeps:s,assetUsages:c,tagList:l,problems:d,linkRefs:f}=await O(n,e.file.path,{resolverContext:a,tags:(await M()).tags,variables:{get env(){return e.config.publicEnv??{}}},transform:t=>De(t,e.file.path,Ee(e.config)),validation:j()?await N():void 0}),p=de(t);Me(o);let m=await Te(r.seo,e),h=u(e.config,`banner`)?await k(Ne(r,e.file.path,e.logger),a):void 0,g=await ke(r,e),_=await Ae(r.navigation,e),v={...g.frontmatter,navigation:_.value,seo:m.seo,banner:h?.banner},y=Pe(r,o);return{value:{ast:ee(o),frontmatter:v,tagList:l,title:y,editPage:we(e.config,r,e.file.path),lastModified:e.file.lastModifiedAt},entityDeps:[...s,...be(),...m.entityDeps,...h?.deps??[],...g.entityDeps,..._.entityDeps],assetUsages:[...c,...m.assetUsages,...h?.assetUsages??[],...g.assetUsages],problems:xe(t,e.file.path,p,d,i),linkRefs:[...ce(f,p),..._.linkRefs],targetInventories:[Se(o,{frontmatter:V(v,y)})]}},{usesProjectMarkdocSchema:!0,async markdown(e,t){let{tags:n}=await M(),{chunks:r,headings:i}=z(x(e.ast),{tags:n,locale:I(t),variables:{frontmatter:V(e.frontmatter,e.title),env:t.config.publicEnv??{}}});return[{chunks:r,headings:i,...e.title?{title:e.title}:{}}]},searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let n=t.route.slug,r=e.title??Q(t.route.originFilePath??n),{category:i,isInvalid:u}=l(t.route.metadata),{facets:d,invalidFields:f}=s(t.route.metadata,o(t.config)),p=ge(e.frontmatter.keywords);return{docs:fe(x(e.ast),r,{frontmatter:V(e.frontmatter,e.title)}).map((e,t)=>{let r={docKey:e.docKey,routeSlug:n,title:e.title,text:e.text,groupKey:i??`Documentation`,facets:d};e.anchor!==void 0&&(r.anchor=e.anchor),e.path!==void 0&&(r.path=e.path);let a=t===0?p:{excludes:p?.excludes};return(a?.includes||a?.excludes)&&(r.keywords=a),e.rbacTeams!==void 0&&(r.rbacScope=Object.fromEntries(e.rbacTeams.map(e=>[e,`read`]))),r}),problems:c([...f,...u?[a]:[]],t.route.originFilePath)}}}),q=t(G,async e=>{let{content:t,frontmatter:n}=Y(await e.io.readFile(e.file.absolutePath)),r=await D(t,e.file.path,J(e));return{value:{label:Z(n)??H(r.source)??Q(e.args.filePath)},entityDeps:r.entityDeps}});function J(e){return{config:e.config,contentDir:e.contentDir,entities:e.entities,file:e.file,io:e.io,logger:e.logger,markdown:e.markdown,plugin:e.plugin}}const ye=e({id:`internal.markdoc`,version:`3.48.0`,content:{filter:{match:e=>e.toLowerCase().endsWith(`.md`)&&!he(e)},extractFile(e,t){if(pe(e.path)||le(e.path,t.config))return{routes:[]};if(!u(t.config,`markdown`))return{routes:[],problems:[_(`Markdown pages`)]};let{banner:n,...r}=e.manifest,i=Fe(e,t),a=me(r.slug),o=K.withArgs({filePath:e.path}),s=q.withArgs({filePath:e.path});return{routes:a.length>0?a.map(e=>({deps:{[A]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:e,slugHint:null,template:i})):[{deps:{[A]:o},metadata:r,routeId:`page`,sidebarSubtree:s,slug:null,slugHint:y(e.path),template:i}],entities:[o]}}},loaders:[K,q],templates:{[U]:i(n(`./client/template.tsx`,import.meta.url))}});function Y(e){let t=e.match(ue);if(!t)return{content:e,frontmatter:{}};let n=t[1]??``;try{let r=_e.load(n);return{content:e.slice(t[0].length),frontmatter:f(r)?r:{}}}catch(n){let r=n instanceof Error?n.message:String(n);return{content:e.slice(t[0].length),frontmatter:{},frontmatterError:r}}}function be(){return(P()??[]).map(e=>({kind:`file`,path:e}))}function xe(e,t,n,r,i){if(r.length===0&&i===void 0)return[];let a=R(e),o=r.map(e=>Ce(e,a,n,t));if(i!==void 0){let e={start:{line:1},end:{line:n}};o.push({code:`markdown/frontmatter-parse`,message:i,location:{filePath:t,range:e,snippet:L(a,e)}})}return o}function Se(e,t){let{ids:n,exhaustive:r}=B(e,t);return{kind:`anchor`,exhaustive:r,targets:n}}function Ce(e,t,n,r){let i=e.location?.range;if(!i)return e;let a=oe(i,n);return{...e,location:{filePath:r,range:a,snippet:L(t,a)}}}function we(e,t,n){let r=f(t.markdown)?t.markdown:{},i={...e.markdown?.editPage,...f(r.editPage)?r.editPage:{}};if(i.hide!==!0&&typeof i.baseUrl==`string`&&i.baseUrl!==``)return{to:`${i.baseUrl.replace(/(?<!\/)\/+$/,``)}/${n}`}}async function Te(e,t){if(!f(e)||typeof e.image!=`string`)return{seo:e,entityDeps:[],assetUsages:[]};let n=await t.markdown.resolveImageReference(e.image,t.file.path);return n.result.kind===`assetRef`?{seo:{...e,image:n.result.url},entityDeps:n.entityDeps,assetUsages:n.assetUsages}:{seo:e,entityDeps:n.entityDeps,assetUsages:[]}}function Ee(e){let t=/* @__PURE__ */ new Map;if(!u(e,`customMarkdocTags`))for(let e of F())t.set(e,`Custom Markdoc tags are not in this project's plan, so \`${e}\` is ignored.`);if(!u(e,`codeWalkthrough`))for(let e of ne)t.set(e,`\`${e}\` is not in this project's plan and is ignored.`);return t}function De(e,t,n){let r=[];if(n.size===0)return r;for(let i of E(e,{getExtraNodes:te})){let e=i.type===`tag`&&i.tag!==void 0?n.get(i.tag):void 0;e!==void 0&&(r.push({code:`configuration/ignored`,message:e,location:{filePath:t,range:w(i)??{start:{line:1},end:{line:1}}}}),T(i,e))}return r}const Oe=[`image`,`links`];async function ke(e,t){let n=t.config.markdown?.frontMatterKeysToResolve??Oe,r={...e},i=[],a=[];for(let o of n){let n=e[o];if(typeof n!=`string`)continue;let s=await t.markdown.resolveLocalReference(n,t.file.path);i.push(...s.entityDeps),a.push(...s.assetUsages),s.result.kind!==`passthrough`&&(r[o]=s.result.url)}return{frontmatter:r,entityDeps:i,assetUsages:a}}async function Ae(e,t){let n=[],r=[];if(!f(e))return{value:e,entityDeps:n,linkRefs:r};let i={...e};for(let a of[`nextButton`,`previousButton`]){let o=e[a];if(!f(o)||typeof o.page!=`string`)continue;let{page:s,...c}=o,l=se(ae(s),t.file.path);l!==null&&r.push({kind:`link`,raw:s,...l});let u=await je(s,t);n.push(...u.entityDeps),i[a]={...c,label:typeof c.label==`string`?c.label:u.route&&await X(u.route,t),link:u.link}}return{value:i,entityDeps:n,linkRefs:r}}async function X(e,t){let n=await C(t.entities,e);if(n!==void 0)return n;let r=t.routes.get(e.slug)?.metadata.seo;return f(r)&&typeof r.title==`string`&&r.title.trim()!==``?r.title:e.slug}async function je(e,t){let n=e.trim(),{path:r,suffix:i}=b(n);if(S(r)){let e=t.routes.bySlug(p(r));return{link:e&&`${e.slug}${i}`,route:e,entityDeps:[]}}let a=await t.markdown.resolveLocalReference(n,t.file.path);if(a.result.kind!==`pageUrl`)return{entityDeps:a.entityDeps};let o=a.result.url;return{link:o,route:t.routes.bySlug(b(o).path)??a.entityDeps.map(e=>e.kind===`file`?t.routes.byFilePath(e.path):void 0).reverse().find(e=>e!==void 0),entityDeps:a.entityDeps}}function Me(e){let t=/* @__PURE__ */ new Map;for(let n of E(e)){if(n.type!==`tag`||n.tag===void 0||re[n.tag]?.attributes?.__idx===void 0)continue;let e=(t.get(n.tag)??0)+1;t.set(n.tag,e),n.attributes.__idx=e}}function Ne(e,t,n){if(e.banner===void 0)return;let{value:r,problems:i}=g(h,{banner:e.banner});for(let e of i)n?.warn(`${t}: ${e.message}`);return r.banner}function Pe(e,t){return Z(e)??ie(t)??void 0}function Z(e){let t=f(e.seo)?e.seo.title:void 0;return typeof t==`string`&&t.trim()!==``?t:void 0}function Q(e){let t=(e.split(`/`).pop()??e).replace(/\.[^.]+$/,``);return t===``?e:t}function Fe(e,t){let n=e.manifest.template;if(typeof n==`string`&&n.trim()!==``)return $(n,e.path,t.logger);let r=v(e.path,t.config.markdown?.template);return typeof r==`string`&&r.trim()!==``?$(r,`redocly.yaml`,t.logger):U}function $(e,t,n){if(!e.startsWith(`./`)&&!e.startsWith(`../`)&&!e.startsWith(`/`))return e;let r=m(e,t);return r===null?(n.warn(`Template reference "${e}" in ${t} escapes the content root; falling back to ${U}.`),U):`${d}${r}`}export{W as MARKDOC_DOCUMENT_LOADER_ID,ve as MARKDOC_SEARCH_GROUP,G as MARKDOC_SIDEBAR_ITEM_LOADER_ID,U as MARKDOC_TEMPLATE_ID,ye as markdocContentPlugin};
@@ -16,8 +16,25 @@ export declare const CREATE_ANONYMOUS_SESSION_TOOL_NAME = "createAnonymousSessio
16
16
  export declare const MANAGE_API_CREDENTIALS_TOOL_NAME = "manageApiCredentials";
17
17
  export declare const REMOVE_API_CREDENTIALS_TOOL_NAME = "removeApiCredentials";
18
18
  export declare const SUBMIT_FEEDBACK_TOOL_NAME = "submit-feedback";
19
+ export declare const CALL_API_WRITE_TOOL_NAME = "call-api_write";
19
20
  export declare const MCP_CREDENTIALS_ROUTE = "/mcp/credentials";
20
21
  export declare const DEFAULT_MCP_SERVER_NAME = "Docs MCP server";
21
22
  export declare const PLACEHOLDER_MCP_SERVER_NAMES: readonly string[];
22
23
  export declare const AI_METADATA_HEADER = "X-Redocly-AI-Metadata";
23
24
  export declare const MCP_TOOLS_ENTITY_TYPE = "mcp-tools";
25
+ export declare const READ_ONLY_ANNOTATIONS: {
26
+ readOnlyHint: boolean;
27
+ destructiveHint: boolean;
28
+ openWorldHint: boolean;
29
+ };
30
+ /** The fixed hints of a tool that sends write requests; MCP clients ask the user before each call. */
31
+ export declare const WRITE_TOOL_ANNOTATIONS: {
32
+ readOnlyHint: boolean;
33
+ destructiveHint: boolean;
34
+ idempotentHint: boolean;
35
+ openWorldHint: boolean;
36
+ };
37
+ /** Claude clients ask the user to approve each call of a tool with this `_meta`, whatever the allow rules say. */
38
+ export declare const REQUIRES_USER_INTERACTION_META: {
39
+ 'anthropic/requiresUserInteraction': boolean;
40
+ };
@@ -1 +1 @@
1
- const e=`/mcp`,t=`/mcp-public`,n=`mcp-setup`,r=`/.well-known/mcp/server-card.json`,i=`/.well-known/agent-card.json`,a=`/a2a`,o=`/.well-known/oauth-protected-resource${e}`,s=`/.well-known/oauth-authorization-server`,c=`/_mcp/register`,l=`/_mcp/oauth2/auth`,u=`/_mcp/oauth2/token-portal`,d=`/_mcp/oauth/callback`,f=`execute`,p=`discover`,m=`createAnonymousSession`,h=`manageApiCredentials`,g=`removeApiCredentials`,_=`submit-feedback`,v=`/mcp/credentials`,y=`Docs MCP server`,b=[y,`MCP server`],x=`X-Redocly-AI-Metadata`,S=`mcp-tools`;export{a as A2A_ROUTE,i as AGENT_CARD_ROUTE,x as AI_METADATA_HEADER,m as CREATE_ANONYMOUS_SESSION_TOOL_NAME,y as DEFAULT_MCP_SERVER_NAME,p as DISCOVER_TOOL_NAME,f as EXECUTE_TOOL_NAME,h as MANAGE_API_CREDENTIALS_TOOL_NAME,s as MCP_AUTHORIZATION_SERVER_ROUTE,l as MCP_AUTHORIZE_ROUTE,d as MCP_CALLBACK_ROUTE,v as MCP_CREDENTIALS_ROUTE,o as MCP_PROTECTED_RESOURCE_ROUTE,c as MCP_REGISTER_ROUTE,e as MCP_ROUTE,r as MCP_SERVER_CARD_ROUTE,n as MCP_SETUP_TEMPLATE_ID,u as MCP_TOKEN_ROUTE,S as MCP_TOOLS_ENTITY_TYPE,b as PLACEHOLDER_MCP_SERVER_NAMES,t as PUBLIC_MCP_ROUTE,g as REMOVE_API_CREDENTIALS_TOOL_NAME,_ as SUBMIT_FEEDBACK_TOOL_NAME};
1
+ const e=`/mcp`,t=`/mcp-public`,n=`mcp-setup`,r=`/.well-known/mcp/server-card.json`,i=`/.well-known/agent-card.json`,a=`/a2a`,o=`/.well-known/oauth-protected-resource${e}`,s=`/.well-known/oauth-authorization-server`,c=`/_mcp/register`,l=`/_mcp/oauth2/auth`,u=`/_mcp/oauth2/token-portal`,d=`/_mcp/oauth/callback`,f=`execute`,p=`discover`,m=`createAnonymousSession`,h=`manageApiCredentials`,g=`removeApiCredentials`,_=`submit-feedback`,v=`call-api_write`,y=`/mcp/credentials`,b=`Docs MCP server`,x=[b,`MCP server`],S=`X-Redocly-AI-Metadata`,C=`mcp-tools`,w={readOnlyHint:!0,destructiveHint:!1,openWorldHint:!1},T={readOnlyHint:!1,destructiveHint:!0,idempotentHint:!1,openWorldHint:!0},E={"anthropic/requiresUserInteraction":!0};export{a as A2A_ROUTE,i as AGENT_CARD_ROUTE,S as AI_METADATA_HEADER,v as CALL_API_WRITE_TOOL_NAME,m as CREATE_ANONYMOUS_SESSION_TOOL_NAME,b as DEFAULT_MCP_SERVER_NAME,p as DISCOVER_TOOL_NAME,f as EXECUTE_TOOL_NAME,h as MANAGE_API_CREDENTIALS_TOOL_NAME,s as MCP_AUTHORIZATION_SERVER_ROUTE,l as MCP_AUTHORIZE_ROUTE,d as MCP_CALLBACK_ROUTE,y as MCP_CREDENTIALS_ROUTE,o as MCP_PROTECTED_RESOURCE_ROUTE,c as MCP_REGISTER_ROUTE,e as MCP_ROUTE,r as MCP_SERVER_CARD_ROUTE,n as MCP_SETUP_TEMPLATE_ID,u as MCP_TOKEN_ROUTE,C as MCP_TOOLS_ENTITY_TYPE,x as PLACEHOLDER_MCP_SERVER_NAMES,t as PUBLIC_MCP_ROUTE,w as READ_ONLY_ANNOTATIONS,g as REMOVE_API_CREDENTIALS_TOOL_NAME,E as REQUIRES_USER_INTERACTION_META,_ as SUBMIT_FEEDBACK_TOOL_NAME,T as WRITE_TOOL_ANNOTATIONS};
@@ -1 +1 @@
1
- import{createInlineEntity as e}from"../../../loaders/define.js";import{isPlanFeatureGranted as t}from"../../../../shared/plan-gates.js";import{CREATE_ANONYMOUS_SESSION_TOOL_NAME as n,DISCOVER_TOOL_NAME as r,EXECUTE_TOOL_NAME as i,MANAGE_API_CREDENTIALS_TOOL_NAME as a,MCP_TOOLS_ENTITY_TYPE as o,REMOVE_API_CREDENTIALS_TOOL_NAME as s,SUBMIT_FEEDBACK_TOOL_NAME as c}from"./constants.js";import{notInPlanProblem as l}from"../../../plan-gates.js";import{MCP_TOOL_NAME_PATTERN as u}from"../../registry.js";import{isMcpHidden as d}from"./server/config-gate.js";import{buildMcpSetupPageRoutes as f}from"./setup-page.js";const p=`@mcp`,m=`mcp/invalid-tool`,h=/\.(ts|js)$/u,g=/\.d\.ts$/u,_=/* @__PURE__ */ new Set([`search`,`list-apis`,`get-endpoints`,`get-endpoint-info`,`get-security-schemes`,`get-full-api-description`,`list-graphql-apis`,`get-graphql-type-list`,`get-graphql-type`,`get-graphql-schema`,`list-pages`,`get-page`,`grep-pages`,`whoami`,c,i,r,`describe-tools`,n,a,s]);function v(e){return`mcp-tool-file:${e}`}function y(e){if(g.test(e)||!h.test(e))return!1;let t=e.split(`/`),n=t.indexOf(p);return n!==-1&&n<t.length-1}function b(e,t,n){if(!u.test(e))return`Invalid MCP tool file "${t}": the tool name "${e}" is derived from the file name and may only contain letters, numbers, hyphens, and underscores (max 64 characters). Rename the file.`;if(n!==void 0)return`Duplicate MCP tool name "${e}": defined by both "${n}" and "${t}". Tool names are file names, so each file name must be unique across @mcp folders.`;if(_.has(e))return`Invalid MCP tool file "${t}": the tool name "${e}" is already used by a built-in MCP tool. Rename the file.`}function x(n){let r=[],i=[];if(d(n.config))return{entities:r,problems:i};if(!t(n.config,`customMcpTools`)){for(let{path:e}of n.files)i.push({...l(`Custom MCP tools`),location:{filePath:e}});return{entities:r,problems:i}}let a=/* @__PURE__ */ new Map;for(let{path:t}of n.files){let n=t.slice(t.lastIndexOf(`/`)+1).replace(h,``),s=b(n,t,a.get(n));if(s!==void 0){i.push({code:m,message:s,location:{filePath:t}});continue}a.set(n,t);let c={name:n,sourcePath:t};r.push(e(c,{stableKey:v(t),type:o,metadata:c}))}return{entities:r,problems:i}}const S={filter:{match:y},extractAll(e){return{routes:f(e.config),entities:[]}}};export{p as MCP_DIR_SEGMENT,m as MCP_TOOL_PROBLEM_CODE,_ as RESERVED_MCP_TOOL_NAMES,y as isMcpToolFile,S as mcpContent,v as mcpToolFileEntityKey,x as scanMcpToolFiles};
1
+ import{createInlineEntity as e}from"../../../loaders/define.js";import{isPlanFeatureGranted as t}from"../../../../shared/plan-gates.js";import{CALL_API_WRITE_TOOL_NAME as n,CREATE_ANONYMOUS_SESSION_TOOL_NAME as r,DISCOVER_TOOL_NAME as i,EXECUTE_TOOL_NAME as a,MANAGE_API_CREDENTIALS_TOOL_NAME as o,MCP_TOOLS_ENTITY_TYPE as s,REMOVE_API_CREDENTIALS_TOOL_NAME as c,SUBMIT_FEEDBACK_TOOL_NAME as l}from"./constants.js";import{notInPlanProblem as u}from"../../../plan-gates.js";import{MCP_TOOL_NAME_PATTERN as d}from"../../registry.js";import{isMcpHidden as f}from"./server/config-gate.js";import{buildMcpSetupPageRoutes as p}from"./setup-page.js";const m=`@mcp`,h=`mcp/invalid-tool`,g=/\.(ts|js)$/u,_=/\.d\.ts$/u,v=/* @__PURE__ */ new Set([n,`search`,`list-apis`,`get-endpoints`,`get-endpoint-info`,`get-security-schemes`,`get-full-api-description`,`list-graphql-apis`,`get-graphql-type-list`,`get-graphql-type`,`get-graphql-schema`,`list-pages`,`get-page`,`grep-pages`,`whoami`,l,a,i,`describe-tools`,r,o,c]);function y(e){return`mcp-tool-file:${e}`}function b(e){if(_.test(e)||!g.test(e))return!1;let t=e.split(`/`),n=t.indexOf(m);return n!==-1&&n<t.length-1}function x(e,t,n){if(!d.test(e))return`Invalid MCP tool file "${t}": the tool name "${e}" is derived from the file name and may only contain letters, numbers, hyphens, and underscores (max 64 characters). Rename the file.`;if(n!==void 0)return`Duplicate MCP tool name "${e}": defined by both "${n}" and "${t}". Tool names are file names, so each file name must be unique across @mcp folders.`;if(v.has(e))return`Invalid MCP tool file "${t}": the tool name "${e}" is already used by a built-in MCP tool. Rename the file.`}function S(n){let r=[],i=[];if(f(n.config))return{entities:r,problems:i};if(!t(n.config,`customMcpTools`)){for(let{path:e}of n.files)i.push({...u(`Custom MCP tools`),location:{filePath:e}});return{entities:r,problems:i}}let a=/* @__PURE__ */ new Map;for(let{path:t}of n.files){let n=t.slice(t.lastIndexOf(`/`)+1).replace(g,``),o=x(n,t,a.get(n));if(o!==void 0){i.push({code:h,message:o,location:{filePath:t}});continue}a.set(n,t);let c={name:n,sourcePath:t};r.push(e(c,{stableKey:y(t),type:s,metadata:c}))}return{entities:r,problems:i}}const C={filter:{match:b},extractAll(e){return{routes:p(e.config),entities:[]}}};export{m as MCP_DIR_SEGMENT,h as MCP_TOOL_PROBLEM_CODE,v as RESERVED_MCP_TOOL_NAMES,b as isMcpToolFile,C as mcpContent,y as mcpToolFileEntityKey,S as scanMcpToolFiles};
@@ -1 +1 @@
1
- import{A2A_ROUTE as e,MCP_ROUTE as t,MCP_SERVER_CARD_ROUTE as n}from"../constants.js";import{withPathPrefix as r}from"../../../../../shared/path-prefix.js";import{SKILLS_INDEX_SLUG as i,skillMarkdownPath as a}from"../../../utils/skill-paths.js";import{isMcpContentProtected as o,isMcpHidden as s,resolveMcpAccess as c}from"./config-gate.js";import{SKILL_ENTITY_TYPE as l}from"../../../types/skill-entity.js";import{isEntityScopeVisible as u}from"../../../../../shared/rbac/entity-scope.js";import{notFoundResponse as d}from"../../../../../server/plugin-context.js";import{publicBaseUrl as f}from"../../../utils/request-origin.js";import{CORS_ANY_ORIGIN as p,MCP_AUTH_SCHEMES as m}from"./oauth/constants.js";import"./auth.js";const h=[`text/plain`],g=[`text/plain`],_={streaming:!1,pushNotifications:!1},v={"Cache-Control":`no-store`};async function y(e,t){let n=!!e.request.viewer?.isAuthenticated;return o(c(e.config))&&!n?[]:(await e.entities.list({type:l})).flatMap(n=>{let{slug:i,title:o,description:s}=n.metadata??{};return typeof i!=`string`||!u(n,e.request.teams,t=>e.logger?.warn(t))?[]:[{id:i,name:o??i,description:s??``,tags:[],url:`${t}${r(a(i))}`}]})}async function b(n,i){if(s(i.config)||i.config.skills?.hide===!0)return d();n.set(`realmCacheControlOwned`,!0);let a=f(i.config,i.request),l=o(c(i.config)),u=i.config.seo;return n.json({name:u?.title||u?.projectTitle||`Developer Documentation`,description:u?.description||`Documentation agent card announcing this site's agent skills and MCP server.`,url:`${a}${r(e)}`,documentationUrl:`${a}${r(`/`)}`,version:`0.0.1`,protocolVersion:`0.3.0`,preferredTransport:`HTTP+JSON`,capabilities:{..._,extensions:[{uri:`https://modelcontextprotocol.io`,description:`Model Context Protocol server exposing the documentation tools and skills.`,params:{url:`${a}${r(t)}`,...l?{authentication:{required:!0,schemes:[...m]}}:{}}}]},defaultInputModes:h,defaultOutputModes:g,skills:await y(i,a)},200,{...v,...p})}function x(e,t){if(s(t.config))return d();let a=[`<${r(n)}>; rel="mcp-server-card"`];return t.config.skills?.hide!==!0&&a.push(`<${r(i)}>; rel="agent-skills"`),e.json({error:{code:`405`,message:`Method not allowed`}},405,{Link:a.join(`, `),...p,"Access-Control-Expose-Headers":`Link`})}export{x as a2a,b as agentCard};
1
+ import{A2A_ROUTE as e,MCP_ROUTE as t,MCP_SERVER_CARD_ROUTE as n}from"../constants.js";import{withPathPrefix as r}from"../../../../../shared/path-prefix.js";import{SKILLS_INDEX_SLUG as i,skillMarkdownPath as a}from"../../../utils/skill-paths.js";import{isMcpContentProtected as o,isMcpHidden as s,resolveMcpAccess as c}from"./config-gate.js";import{SKILL_ENTITY_TYPE as l}from"../../../types/skill-entity.js";import{publicBaseUrl as u}from"../../../utils/request-origin.js";import{isEntityScopeVisible as d}from"../../../../../shared/rbac/entity-scope.js";import{notFoundResponse as f}from"../../../../../server/plugin-context.js";import{CORS_ANY_ORIGIN as p,MCP_AUTH_SCHEMES as m}from"./oauth/constants.js";import"./auth.js";const h=[`text/plain`],g=[`text/plain`],_={streaming:!1,pushNotifications:!1},v={"Cache-Control":`no-store`};async function y(e,t){let n=!!e.request.viewer?.isAuthenticated;return o(c(e.config))&&!n?[]:(await e.entities.list({type:l})).flatMap(n=>{let{slug:i,title:o,description:s}=n.metadata??{};return typeof i!=`string`||!d(n,e.request.teams,t=>e.logger?.warn(t))?[]:[{id:i,name:o??i,description:s??``,tags:[],url:`${t}${r(a(i))}`}]})}async function b(n,i){if(s(i.config)||i.config.skills?.hide===!0)return f();n.set(`realmCacheControlOwned`,!0);let a=u(i.config,i.request),l=o(c(i.config)),d=i.config.seo;return n.json({name:d?.title||d?.projectTitle||`Developer Documentation`,description:d?.description||`Documentation agent card announcing this site's agent skills and MCP server.`,url:`${a}${r(e)}`,documentationUrl:`${a}${r(`/`)}`,version:`0.0.1`,protocolVersion:`0.3.0`,preferredTransport:`HTTP+JSON`,capabilities:{..._,extensions:[{uri:`https://modelcontextprotocol.io`,description:`Model Context Protocol server exposing the documentation tools and skills.`,params:{url:`${a}${r(t)}`,...l?{authentication:{required:!0,schemes:[...m]}}:{}}}]},defaultInputModes:h,defaultOutputModes:g,skills:await y(i,a)},200,{...v,...p})}function x(e,t){if(s(t.config))return f();let a=[`<${r(n)}>; rel="mcp-server-card"`];return t.config.skills?.hide!==!0&&a.push(`<${r(i)}>; rel="agent-skills"`),e.json({error:{code:`405`,message:`Method not allowed`}},405,{Link:a.join(`, `),...p,"Access-Control-Expose-Headers":`Link`})}export{x as a2a,b as agentCard};
@@ -1 +1 @@
1
- import"../constants.js";import{isObject as e}from"../../../../../shared/utils/is-object.js";import{thrownErrorClass as t}from"./tool-errors.js";import{maskCodeCredentials as n}from"./code-credentials.js";import{redactSecretsFromString as r}from"./gateway/fetch/redact.js";import{redactSecretShapes as i}from"./secret-patterns.js";import{createHash as a}from"node:crypto";function o(e){return{client:e.client,clientVersion:e.clientVersion,requestId:e.requestId,messageId:e.messageId,callerSubject:e.callerSubject,clientIp:e.request.ip??void 0}}const s=`[mcp-audit]`,c=4096;function l(e){return a(`sha256`).update(e,`utf8`).digest(`hex`)}function u(e){if(e.length<=4096)return e;let t=e.slice(0,c),n=t.search(/\s\S*$/),r=n>0?t.slice(0,n):t;return`${r}…[truncated: kept ${r.length} of ${e.length} chars]`}function d(e,t=[]){return i(r(u(e),t))}const f=/(?<=^|[\s('"])(?:file:\/\/\/?|\/)(?:[^\s()/:'"]+\/)+/gm;function p(e){return d(e.replace(f,``))}function m(e){return{sha256:l(e),bytes:Buffer.byteLength(e,`utf8`)}}function h(e){return Object.keys(e??{}).map(e=>e.toLowerCase()).sort().join(`,`)}const g=/* @__PURE__ */ new Set([`access_token`,`api-key`,`api_key`,`apikey`,`assertion`,`auth`,`client_secret`,`code`,`code_verifier`,`id_token`,`id_token_hint`,`key`,`password`,`refresh_token`,`samlresponse`,`secret`,`session`,`sig`,`signature`,`token`,`x-amz-credential`,`x-amz-security-token`,`x-amz-signature`]);function _(e,t=[],n=[]){let r;try{r=new URL(e)}catch{return d(e,t)}let i=new Set(n.map(e=>e.toLowerCase()));for(let e of[...r.searchParams.keys()]){let t=e.toLowerCase();(g.has(t)||i.has(t))&&r.searchParams.set(e,`redacted`)}return r.username=``,r.password=``,d(r.href,t)}function v(e,t,n){let r=Object.fromEntries(Object.entries(n).filter(([,e])=>e!==void 0&&e!==``));try{e?.info(`${s} ${t}`,r)}catch{}}const y=/(169\.254\.169\.254|metadata\.google\.internal|\.consul\b|\.internal\b|localhost|127\.0\.0\.1|\b10\.\d{1,3}\.\d{1,3}\.\d{1,3}\b|\b192\.168\.\d{1,3}\.\d{1,3}\b|\b172\.(?:1[6-9]|2\d|3[01])\.\d{1,3}\.\d{1,3}\b)/i,b=/(process\s*(?:\.\s*env\b|\[)|globalThis|require\s*\(|__proto__)/;function x(e){let t=[];return b.test(e)&&t.push(`env_probe`),y.test(e)&&t.push(`internal_target`),{sha256:l(e),length:e.length,flags:t.sort().join(`,`)}}function S(e){try{return JSON.stringify(e)??String(e)}catch{return`«[unserializable]»`}}function C(e,{tool:t,mode:n,args:r,result:i,errorClass:a,client:o,clientVersion:s,requestId:c,messageId:u,callerSubject:f,clientIp:p}){if(t===`execute`)return;let h=S(r),g=i===void 0?void 0:m(i),_=r?.sessionHandle,y=typeof _==`string`&&_!==``?_:void 0,b=f??y;v(e,`Record MCP tool call`,{tool:t,mode:n,server_type:`docs`,error_class:a,client:o,client_version:s,request_id:c,message_id:u,subject_sha256:b?l(b):void 0,client_ip:p,args_sha256:l(h),args:d(h,y?[y]:[]),result_sha256:g?.sha256,result_bytes:g?.bytes})}async function w(e,n,r,i){let a={tool:n,mode:e.mcpMode,args:r,...o(e)},s=Date.now(),c;try{c=await i()}catch(r){throw C(e.logger,{...a,errorClass:t(r)}),e.telemetry?.toolThrew(n,Date.now()-s,r),await e.telemetry?.flush(),r}let l=E(c)&&c.isError===!0;return C(e.logger,{...a,result:k(c),errorClass:l?`tool_error`:void 0}),e.telemetry?.toolReturned(n,Date.now()-s,c),await e.telemetry?.flush(),c}const T=/* @__PURE__ */ new Set([`text`,`image`,`audio`,`resource`,`resource_link`]);function E(t){return e(t)&&Array.isArray(t.content)&&t.content.every(t=>e(t)&&T.has(t.type))}function D(t){return e(t)&&t.resultType===`input_required`}function O(e,t=``){return e.content.map(e=>e.type===`text`?e.text:``).join(t)}function k(e){if(typeof e==`string`)return e;if(E(e))return O(e);if(D(e))return``;try{return JSON.stringify(e)??``}catch{return``}}function A(e,{audit:t,code:r,description:i,sessionHandle:a,toolNames:o,fetchBudget:s,fetchCapable:c,requestId:u,messageId:f,callerSubject:p,clientIp:m}){let h=p??a;v(e,`Record code execution input`,{code_sha256:t.sha256,code_length:t.length,request_id:u,message_id:f,flags:t.flags,subject_sha256:h?l(h):void 0,client_ip:m,description:d(i),tools:[...o].sort().join(`,`),fetch_capable:c,fetch_budget:s,code:d(n(r))})}function j(e,{rawUrl:t,method:n,host:r,outcome:i,durationMs:a,injectedSecretValues:o,credentialQueryParams:s,path:c,api:u,status:f,injectedScheme:p,requestHeaders:g,requestBody:y,responseHeaders:b,responseBody:x,caller:S={}}){let{requestId:C,callerSubject:w,clientIp:T}=S,E=x===void 0?void 0:m(x);v(e,`Record gateway fetch`,{url_sha256:l(t),host:r,method:n,path:c,api:u,outcome:i,status:f,injected_scheme:p,duration_ms:a,request_id:C,subject_sha256:w?l(w):void 0,client_ip:T,url:_(t,o,s),request_header_names:h(g),request_body:y===void 0?void 0:d(y,o),response_header_names:h(b),response_sha256:E?.sha256,response_bytes:E?.bytes})}export{c as AUDIT_FIELD_MAX_CHARS,s as AUDIT_LOG_PREFIX,x as auditCode,h as auditHeaderNames,d as auditInput,l as auditSha256,p as auditStack,w as auditToolCall,_ as auditUrl,o as callAttribution,E as isCallToolResult,v as logAuditRecord,A as logCodeExecutionAudit,j as logGatewayFetchAudit,C as logMcpToolCallAudit,k as toolOutputText,O as toolResultText,u as truncateAuditField};
1
+ import"../constants.js";import{isObject as e}from"../../../../../shared/utils/is-object.js";import{thrownErrorClass as t}from"./tool-errors.js";import{maskCodeCredentials as n}from"./code-credentials.js";import{redactSecretsFromString as r}from"./gateway/fetch/redact.js";import{redactSecretShapes as i}from"./secret-patterns.js";import{createHash as a}from"node:crypto";function o(e){return{client:e.client,clientVersion:e.clientVersion,requestId:e.requestId,messageId:e.messageId,callerSubject:e.callerSubject,clientIp:e.request.ip??void 0}}const s=`[mcp-audit]`,c=4096;function l(e){return a(`sha256`).update(e,`utf8`).digest(`hex`)}function u(e){if(e.length<=4096)return e;let t=e.slice(0,c),n=t.search(/\s\S*$/),r=n>0?t.slice(0,n):t;return`${r}…[truncated: kept ${r.length} of ${e.length} chars]`}function d(e,t=[]){return i(r(u(e),t))}const f=/(?<=^|[\s('"])(?:file:\/\/\/?|\/)(?:[^\s()/:'"]+\/)+/gm;function p(e){return d(e.replace(f,``))}function m(e){return{sha256:l(e),bytes:Buffer.byteLength(e,`utf8`)}}function h(e){return Object.keys(e??{}).map(e=>e.toLowerCase()).sort().join(`,`)}const g=/* @__PURE__ */ new Set([`access_token`,`api-key`,`api_key`,`apikey`,`assertion`,`auth`,`client_secret`,`code`,`code_verifier`,`id_token`,`id_token_hint`,`key`,`password`,`refresh_token`,`samlresponse`,`secret`,`session`,`sig`,`signature`,`token`,`x-amz-credential`,`x-amz-security-token`,`x-amz-signature`]);function _(e,t=[],n=[]){let r;try{r=new URL(e)}catch{return d(e,t)}let i=new Set(n.map(e=>e.toLowerCase()));for(let e of[...r.searchParams.keys()]){let t=e.toLowerCase();(g.has(t)||i.has(t))&&r.searchParams.set(e,`redacted`)}return r.username=``,r.password=``,d(r.href,t)}function v(e,t,n){let r=Object.fromEntries(Object.entries(n).filter(([,e])=>e!==void 0&&e!==``));try{e?.info(`${s} ${t}`,r)}catch{}}const y=/(169\.254\.169\.254|metadata\.google\.internal|\.consul\b|\.internal\b|localhost|127\.0\.0\.1|\b10\.\d{1,3}\.\d{1,3}\.\d{1,3}\b|\b192\.168\.\d{1,3}\.\d{1,3}\b|\b172\.(?:1[6-9]|2\d|3[01])\.\d{1,3}\.\d{1,3}\b)/i,b=/(process\s*(?:\.\s*env\b|\[)|globalThis|require\s*\(|__proto__)/;function x(e){let t=[];return b.test(e)&&t.push(`env_probe`),y.test(e)&&t.push(`internal_target`),{sha256:l(e),length:e.length,flags:t.sort().join(`,`)}}function S(e){try{return JSON.stringify(e)??String(e)}catch{return`«[unserializable]»`}}function C(e,{tool:t,mode:n,args:r,result:i,errorClass:a,client:o,clientVersion:s,requestId:c,messageId:u,callerSubject:f,clientIp:p}){if(t===`execute`||t===`call-api_write`)return;let h=S(r),g=i===void 0?void 0:m(i),_=r?.sessionHandle,y=typeof _==`string`&&_!==``?_:void 0,b=f??y;v(e,`Record MCP tool call`,{tool:t,mode:n,server_type:`docs`,error_class:a,client:o,client_version:s,request_id:c,message_id:u,subject_sha256:b?l(b):void 0,client_ip:p,args_sha256:l(h),args:d(h,y?[y]:[]),result_sha256:g?.sha256,result_bytes:g?.bytes})}async function w(e,n,r,i){let a={tool:n,mode:e.mcpMode,args:r,...o(e)},s=Date.now(),c;try{c=await i()}catch(r){throw C(e.logger,{...a,errorClass:t(r)}),e.telemetry?.toolThrew(n,Date.now()-s,r),await e.telemetry?.flush(),r}let l=E(c)&&c.isError===!0;return C(e.logger,{...a,result:k(c),errorClass:l?`tool_error`:void 0}),e.telemetry?.toolReturned(n,Date.now()-s,c),await e.telemetry?.flush(),c}const T=/* @__PURE__ */ new Set([`text`,`image`,`audio`,`resource`,`resource_link`]);function E(t){return e(t)&&Array.isArray(t.content)&&t.content.every(t=>e(t)&&T.has(t.type))}function D(t){return e(t)&&t.resultType===`input_required`}function O(e,t=``){return e.content.map(e=>e.type===`text`?e.text:``).join(t)}function k(e){if(typeof e==`string`)return e;if(E(e))return O(e);if(D(e))return``;try{return JSON.stringify(e)??``}catch{return``}}function A(e,{audit:t,code:r,description:i,sessionHandle:a,toolNames:o,fetchBudget:s,fetchCapable:c,requestId:u,messageId:f,callerSubject:p,clientIp:m}){let h=p??a;v(e,`Record code execution input`,{code_sha256:t.sha256,code_length:t.length,request_id:u,message_id:f,flags:t.flags,subject_sha256:h?l(h):void 0,client_ip:m,description:d(i),tools:[...o].sort().join(`,`),fetch_capable:c,fetch_budget:s,code:d(n(r))})}function j(e,{rawUrl:t,method:n,host:r,outcome:i,durationMs:a,injectedSecretValues:o,credentialQueryParams:s,path:c,api:u,status:f,injectedScheme:p,requestHeaders:g,requestBody:y,responseHeaders:b,responseBody:x,caller:S={}}){let{requestId:C,callerSubject:w,clientIp:T}=S,E=x===void 0?void 0:m(x);v(e,`Record gateway fetch`,{url_sha256:l(t),host:r,method:n,path:c,api:u,outcome:i,status:f,injected_scheme:p,duration_ms:a,request_id:C,subject_sha256:w?l(w):void 0,client_ip:T,url:_(t,o,s),request_header_names:h(g),request_body:y===void 0?void 0:d(y,o),response_header_names:h(b),response_sha256:E?.sha256,response_bytes:E?.bytes})}export{c as AUDIT_FIELD_MAX_CHARS,s as AUDIT_LOG_PREFIX,x as auditCode,h as auditHeaderNames,d as auditInput,l as auditSha256,p as auditStack,w as auditToolCall,_ as auditUrl,o as callAttribution,E as isCallToolResult,v as logAuditRecord,A as logCodeExecutionAudit,j as logGatewayFetchAudit,C as logMcpToolCallAudit,k as toolOutputText,O as toolResultText,u as truncateAuditField};
@@ -1 +1 @@
1
- import{MCP_AUTHORIZATION_SERVER_ROUTE as e,MCP_PROTECTED_RESOURCE_ROUTE as t,PUBLIC_MCP_ROUTE as n}from"../constants.js";import{withPathPrefix as r}from"../../../../../shared/path-prefix.js";import{ANONYMOUS_VIEWER as i}from"../../../../../shared/types/auth.js";import{canAccessMcpFeature as a,isMcpContentProtected as o,isPublicEndpointServed as s,resolveMcpAccess as c}from"./config-gate.js";import{getBearerVerifier as l,getSessionIssuer as u}from"../../../../../server/auth/middleware.js";import{publicOrigin as d}from"../../../utils/request-origin.js";import{isAssistantAnonymousToken as f}from"../../../../../server/ask-ai/assistant-anonymous-token.js";import{CORS_ANY_ORIGIN as p,CORS_EXPOSE_CHALLENGE as m,SUPPORTED_MCP_SCOPES as h}from"./oauth/constants.js";function g(e){let t=/^Bearer\s+(\S+)$/i.exec((e??``).trim());return t?t[1]:null}function _(n,i){let a=i?[`error="${i.code}"`,`error_description="${i.description}"`]:[];return a.push(`resource_metadata="${n}${r(t)}"`,`scope="${h.join(` `)}"`,`authorization_uri="${n}${r(e)}"`),`Bearer ${a.join(`, `)}`}function v(e,t){return t?`${e}. A public endpoint that serves anonymous-accessible content is available at ${t}.`:e}function y(e,t,n){return new Response(JSON.stringify(t),{status:e,headers:{"Content-Type":`application/json`,"Cache-Control":`no-store`,...n}})}function b(e,t){return y(401,{error:`unauthorized`,message:v(`Authentication required`,t)},{"WWW-Authenticate":_(e),...m})}function x(e,t){return y(401,{error:`invalid_token`,message:v(`Invalid or expired token`,t)},{"WWW-Authenticate":_(e,{code:`invalid_token`,description:`Invalid or expired token`}),...m})}function S(){return y(403,{error:`forbidden`,message:`You do not have access to this MCP server`},{...p})}async function C(e){let{c:t,ctx:p}=e,m=e=>p.logger?.warn(e),h=c(p.config),_=o(h);if(e.forceAnonymous){let e=await p.withViewer(i);return a(h,e.request.teams,!1,m)?{kind:`allow`,ctx:e,isProtected:_}:{kind:`deny`,response:S()}}let v=e=>{let t=d(p.request);return{kind:`deny`,response:e(t,s(p.config,h)?`${t}${r(n)}`:void 0)}},y=p.request.viewer??i,C,w,T=p,E=g(t.req.header(`authorization`)),D=u(t)?.artifactSecret,O=E!==null&&D!==void 0&&await f(E,D);if(!_)w=O||E===null?void 0:E;else if(O)y=i,T=await p.withViewer(i);else if(E!==null){let e=await l(t)?.(E);if(!e)return v(x);y=e.viewer,C=e.claims,w=E,T=await p.withViewer(y)}else if(!y.isAuthenticated)return v(b);return a(h,T.request.teams,y.isAuthenticated,m)?{kind:`allow`,ctx:T,isProtected:_,accessToken:w,claims:C}:{kind:`deny`,response:S()}}export{C as authorizeMcpRequest,o as isMcpContentProtected,s as isPublicEndpointServed,g as readBearerToken,c as resolveMcpAccess};
1
+ import{MCP_AUTHORIZATION_SERVER_ROUTE as e,MCP_PROTECTED_RESOURCE_ROUTE as t,PUBLIC_MCP_ROUTE as n}from"../constants.js";import{withPathPrefix as r}from"../../../../../shared/path-prefix.js";import{ANONYMOUS_VIEWER as i}from"../../../../../shared/types/auth.js";import{canAccessMcpFeature as a,isMcpContentProtected as o,isPublicEndpointServed as s,resolveMcpAccess as c}from"./config-gate.js";import{publicOrigin as l}from"../../../utils/request-origin.js";import{getBearerVerifier as u,getSessionIssuer as d}from"../../../../../server/auth/middleware.js";import{isAssistantAnonymousToken as f}from"../../../../../server/ask-ai/assistant-anonymous-token.js";import{CORS_ANY_ORIGIN as p,CORS_EXPOSE_CHALLENGE as m,SUPPORTED_MCP_SCOPES as h}from"./oauth/constants.js";function g(e){let t=/^Bearer\s+(\S+)$/i.exec((e??``).trim());return t?t[1]:null}function _(n,i){let a=i?[`error="${i.code}"`,`error_description="${i.description}"`]:[];return a.push(`resource_metadata="${n}${r(t)}"`,`scope="${h.join(` `)}"`,`authorization_uri="${n}${r(e)}"`),`Bearer ${a.join(`, `)}`}function v(e,t){return t?`${e}. A public endpoint that serves anonymous-accessible content is available at ${t}.`:e}function y(e,t,n){return new Response(JSON.stringify(t),{status:e,headers:{"Content-Type":`application/json`,"Cache-Control":`no-store`,...n}})}function b(e,t){return y(401,{error:`unauthorized`,message:v(`Authentication required`,t)},{"WWW-Authenticate":_(e),...m})}function x(e,t){return y(401,{error:`invalid_token`,message:v(`Invalid or expired token`,t)},{"WWW-Authenticate":_(e,{code:`invalid_token`,description:`Invalid or expired token`}),...m})}function S(){return y(403,{error:`forbidden`,message:`You do not have access to this MCP server`},{...p})}async function C(e){let{c:t,ctx:p}=e,m=e=>p.logger?.warn(e),h=c(p.config),_=o(h);if(e.forceAnonymous){let e=await p.withViewer(i);return a(h,e.request.teams,!1,m)?{kind:`allow`,ctx:e,isProtected:_}:{kind:`deny`,response:S()}}let v=e=>{let t=l(p.request);return{kind:`deny`,response:e(t,s(p.config,h)?`${t}${r(n)}`:void 0)}},y=p.request.viewer??i,C,w,T=p,E=g(t.req.header(`authorization`)),D=d(t)?.artifactSecret,O=E!==null&&D!==void 0&&await f(E,D);if(!_)w=O||E===null?void 0:E;else if(O)y=i,T=await p.withViewer(i);else if(E!==null){let e=await u(t)?.(E);if(!e)return v(x);y=e.viewer,C=e.claims,w=E,T=await p.withViewer(y)}else if(!y.isAuthenticated)return v(b);return a(h,T.request.teams,y.isAuthenticated,m)?{kind:`allow`,ctx:T,isProtected:_,accessToken:w,claims:C}:{kind:`deny`,response:S()}}export{C as authorizeMcpRequest,o as isMcpContentProtected,s as isPublicEndpointServed,g as readBearerToken,c as resolveMcpAccess};
@@ -1,7 +1,7 @@
1
- import{FETCH_TOOL_NAME as e}from"./constants.js";import{buildToolTypeDeclarations as t,sanitizeToolName as n}from"./tool-declarations.js";import{READ_ONLY_ANNOTATIONS as r}from"../tools/schemas.js";import{callableApis as i}from"../gateway/eligibility.js";import{allowsOnlySafeHttpMethods as a,getAllowedHttpMethods as o}from"../gateway/allowed-http-methods.js";import{EXECUTE_ARGS_NOTE as s,PLAIN_JAVASCRIPT_RULE as c,USAGE_NOTES as l,buildExecuteExample as u}from"./prompts.js";const d=["```ts",`/**`,` * Call a documented operation of a callable API. Undocumented paths and methods are refused.`,` * Responses cap at 1 MiB and redirects are not followed.`,` */`,`declare function fetch(url: string | URL, init?: {`,` method?: string;`," /** `content-type` is set automatically for URLSearchParams/FormData unless you set one. */",` headers?: Record<string, string>;`,` /** string · URLSearchParams (→ application/x-www-form-urlencoded) · FormData (→ multipart/form-data) */`,` body?: string | URLSearchParams | FormData;`," /** Security scheme name (from the operation's `security` or `getSecuritySchemes`) whose credential to send. Omit to let the server choose. */",` securityScheme?: string;`,`}): Promise<{`,` status: number;`,` statusText: string;`,` ok: boolean;`,` headers: { get(name: string): string | null };`,` json(): Promise<unknown>;`,` text(): Promise<string>;`,`}>;`,"```"].join(`
2
- `),f=[`listApis`,`getEndpoints`,`getEndpointInfo`],p=[`Example - list the paid invoices of a billing API:`,``,"```js",`const { items } = await site.listApis({ filter: 'billing' });`,`const [api] = items;`,`if (!api) return { error: 'no API matches "billing"' };`,`const { endpoints } = await site.getEndpoints({ name: api.name });`,`const ep = endpoints.find((e) => e.method === 'GET' && e.path.includes('invoices'));`,`const info = await site.getEndpointInfo({ name: api.name, path: ep.path, method: ep.method });`,"// Replace every `{placeholder}` first.",`const url = new URL((info.servers?.[0]?.url ?? '') + ep.path);`,"// Every name below comes from `info.endpoint.parameters` - read them first, never guess them.",`url.searchParams.set('filter', 'status:paid');`,`url.searchParams.set('sort', '-createdTime');`,`url.searchParams.set('limit', '100');`,`try {`,` const res = await fetch(url, { method: ep.method });`,` return res.ok ? await res.json() : { status: res.status, error: await res.text() };`,`} catch (error) {`,` return { error: error instanceof Error ? error.message : String(error), endpointId: info };`,`}`,"```"].join(`
3
- `),m=[`Example - call an endpoint you already read:`,``,"```js","// Call `getEndpointInfo` first for the server URL, the path, and the parameter names.","// Replace every `{placeholder}` first.",`const url = new URL('https://api.example.com/invoices');`,`url.searchParams.set('filter', 'status:paid');`,`try {`,` const res = await fetch(url, { method: 'GET' });`,` return res.ok ? await res.json() : { status: res.status, error: await res.text() };`,`} catch (error) {`,` return { error: error instanceof Error ? error.message : String(error) };`,`}`,"```"].join(`
4
- `);function h(e){return f.every(t=>e.includes(t))?p:m}function g(e){let t=/* @__PURE__ */ new Map;for(let{name:n,version:r}of e){if(!n)continue;let e=t.get(n)??[];r&&e.push(r),t.set(n,e)}return[...t.entries()].map(([e,t])=>t.length>1?`${e} (${t.map(e=>`v${e}`).join(`, `)})`:e).join(`, `)}const _={id:e,purpose:`Call the documented APIs over HTTP`,isActive:async e=>(await i(e)).length>0,annotations:e=>a(e)?{readOnlyHint:!0,destructiveHint:!1,openWorldHint:!0}:{readOnlyHint:!1,destructiveHint:!0,openWorldHint:!0},async renderSection(e,t){let n=g(await i(e));return["## `fetch` — call the documented APIs",``,d,``,"Always call `getEndpointInfo` before `fetch` for the exact URL, required parameters, and body shape. Put filtering, sorting, and paging in the query parameters, and keep sandbox JS for what the endpoint cannot express. Never guess.",``,"An endpoint path can hold `{placeholders}`. Fill each one from `endpoint.parameters` before you call `fetch`. Server URLs come with their variable defaults filled in. A `{placeholder}` left in a server URL has no usable default, so ask the user for its value.",``,`\`fetch\` sends only the methods this project allows: ${o(e.config.mcp).join(`, `)}. Explain any other call to the user instead of making it.`,``,`Callable APIs (their documented hosts are reachable via \`fetch\`): ${n}`,``,h(t)].join(`
5
- `)}},v=[_];async function y(e){let t=await Promise.all(v.map(t=>t.isActive(e)));return v.filter((e,n)=>t[n])}function b(e,t,n){let i=[...e.map(e=>e.annotations??{}),...t.map(e=>e.annotations(n))],a=i.filter(e=>e.readOnlyHint!==!0),o=i.some(e=>e.openWorldHint!==!1);return a.length===0?{...r,openWorldHint:o}:{readOnlyHint:!1,destructiveHint:a.some(e=>e.destructiveHint!==!1),idempotentHint:a.every(e=>e.idempotentHint===!0),openWorldHint:o}}async function x(e,r,i){let a=e.map(e=>n(e.name)),o=[];if(e.length>0){let n=t(e),r=n.includes(`OpenApi`)?`\n\n${l}`:``;o.push(`## Sandbox functions\n\nThe signatures are TypeScript declarations. ${c}\n\n${n}${r}`)}o.push(s),e.length>0&&!r.some(e=>e.id===`fetch`)&&o.push(u(a));for(let e of r)o.push(await e.renderSection(i,a));return o.join(`
1
+ import{CALL_API_WRITE_TOOL_NAME as e,READ_ONLY_ANNOTATIONS as t}from"../../constants.js";import{FETCH_TOOL_NAME as n}from"./constants.js";import{buildToolTypeDeclarations as r,sanitizeToolName as i}from"./tool-declarations.js";import{callableApis as a}from"../gateway/eligibility.js";import{getOfferedWriteHttpMethods as o,getSafeHttpMethods as s}from"../gateway/allowed-http-methods.js";import{EXECUTE_ARGS_NOTE as c,PLAIN_JAVASCRIPT_RULE as l,USAGE_NOTES as u,buildExecuteExample as d}from"./prompts.js";const f=["```ts",`/**`,` * Call a documented operation of a callable API. Undocumented paths and methods are refused.`,` * Responses cap at 1 MiB and redirects are not followed.`,` */`,`declare function fetch(url: string | URL, init?: {`,` method?: string;`," /** `content-type` is set automatically for URLSearchParams/FormData unless you set one. */",` headers?: Record<string, string>;`,` /** string · URLSearchParams (→ application/x-www-form-urlencoded) · FormData (→ multipart/form-data) */`,` body?: string | URLSearchParams | FormData;`," /** Security scheme name (from the operation's `security` or `getSecuritySchemes`) whose credential to send. Omit to let the server choose. */",` securityScheme?: string;`,`}): Promise<{`,` status: number;`,` statusText: string;`,` ok: boolean;`,` headers: { get(name: string): string | null };`,` json(): Promise<unknown>;`,` text(): Promise<string>;`,`}>;`,"```"].join(`
2
+ `),p=[`listApis`,`getEndpoints`,`getEndpointInfo`],m=[`Example - list the paid invoices of a billing API:`,``,"```js",`const { items } = await site.listApis({ filter: 'billing' });`,`const [api] = items;`,`if (!api) return { error: 'no API matches "billing"' };`,`const { endpoints } = await site.getEndpoints({ name: api.name });`,`const ep = endpoints.find((e) => e.method === 'GET' && e.path.includes('invoices'));`,`const info = await site.getEndpointInfo({ name: api.name, path: ep.path, method: ep.method });`,"// Replace every `{placeholder}` first.",`const url = new URL((info.servers?.[0]?.url ?? '') + ep.path);`,"// Every name below comes from `info.endpoint.parameters` - read them first, never guess them.",`url.searchParams.set('filter', 'status:paid');`,`url.searchParams.set('sort', '-createdTime');`,`url.searchParams.set('limit', '100');`,`try {`,` const res = await fetch(url, { method: ep.method });`,` return res.ok ? await res.json() : { status: res.status, error: await res.text() };`,`} catch (error) {`,` return { error: error instanceof Error ? error.message : String(error), endpointId: info };`,`}`,"```"].join(`
3
+ `),h=[`Example - call an endpoint you already read:`,``,"```js","// Call `getEndpointInfo` first for the server URL, the path, and the parameter names.","// Replace every `{placeholder}` first.",`const url = new URL('https://api.example.com/invoices');`,`url.searchParams.set('filter', 'status:paid');`,`try {`,` const res = await fetch(url, { method: 'GET' });`,` return res.ok ? await res.json() : { status: res.status, error: await res.text() };`,`} catch (error) {`,` return { error: error instanceof Error ? error.message : String(error) };`,`}`,"```"].join(`
4
+ `);function g(e){return p.every(t=>e.includes(t))?m:h}function _(e){let t=/* @__PURE__ */ new Map;for(let{name:n,version:r}of e){if(!n)continue;let e=t.get(n)??[];r&&e.push(r),t.set(n,e)}return[...t.entries()].map(([e,t])=>t.length>1?`${e} (${t.map(e=>`v${e}`).join(`, `)})`:e).join(`, `)}function v(t){let n=s(t.config.mcp),r=n.length>0?`\`fetch\` sends only ${n.join(`, `)} requests.`:"`fetch` sends no request on this project.",i=o(t);return i.length>0?`${r} Send a ${i.join(`, `)} request with the \`${e}\` tool.`:`${r} Explain any other call to the user instead of making it.`}const y={id:n,purpose:`Call the documented APIs over HTTP`,isActive:async e=>(await a(e)).length>0,annotations:{...t,openWorldHint:!0},async renderSection(e,t){let n=_(await a(e));return["## `fetch` — call the documented APIs",``,f,``,"Always call `getEndpointInfo` before `fetch` for the exact URL, required parameters, and body shape. Put filtering, sorting, and paging in the query parameters, and keep sandbox JS for what the endpoint cannot express. Never guess.",``,"An endpoint path can hold `{placeholders}`. Fill each one from `endpoint.parameters` before you call `fetch`. Server URLs come with their variable defaults filled in. A `{placeholder}` left in a server URL has no usable default, so ask the user for its value.",``,v(e),``,`Callable APIs (their documented hosts are reachable via \`fetch\`): ${n}`,``,g(t)].join(`
5
+ `)}},b=[y];async function x(e){let t=await Promise.all(b.map(t=>t.isActive(e)));return b.filter((e,n)=>t[n])}function S(e,n){let r=[...e.map(e=>e.annotations??{}),...n.map(e=>e.annotations)],i=r.filter(e=>e.readOnlyHint!==!0),a=r.some(e=>e.openWorldHint!==!1);return i.length===0?{...t,openWorldHint:a}:{readOnlyHint:!1,destructiveHint:i.some(e=>e.destructiveHint!==!1),idempotentHint:i.every(e=>e.idempotentHint===!0),openWorldHint:a}}async function C(e,t,n){let a=e.map(e=>i(e.name)),o=[];if(e.length>0){let t=r(e),n=t.includes(`OpenApi`)?`\n\n${u}`:``;o.push(`## Sandbox functions\n\nThe signatures are TypeScript declarations. ${l}\n\n${t}${n}`)}o.push(c),e.length>0&&!t.some(e=>e.id===`fetch`)&&o.push(d(a));for(let e of t)o.push(await e.renderSection(n,a));return o.join(`
6
6
 
7
- `)}export{v as ALL_CAPABILITIES,d as FETCH_DECLARATION,b as composeExecuteAnnotations,_ as fetchCapability,y as getActiveCapabilities,x as renderDiscoverOutput};
7
+ `)}export{b as ALL_CAPABILITIES,f as FETCH_DECLARATION,S as composeExecuteAnnotations,y as fetchCapability,x as getActiveCapabilities,C as renderDiscoverOutput};
@@ -1 +1 @@
1
- import{CREATE_ANONYMOUS_SESSION_TOOL_NAME as e,DISCOVER_TOOL_NAME as t,EXECUTE_TOOL_NAME as n,MANAGE_API_CREDENTIALS_TOOL_NAME as r,REMOVE_API_CREDENTIALS_TOOL_NAME as i,SUBMIT_FEEDBACK_TOOL_NAME as a}from"../../constants.js";const o=`fetch`,s=/* @__PURE__ */ new Set([n,t,e,r,i,a]),c=`site`,l=`tools`,u=`__fetchBridge`,d=`fetch`,f=1e4,p=45e3,m=5e4,h=1e3,g=50,_=50,v={ratePerMin:600,quotaPerDay:1e5},y=8388608,b=1048576,x=1048576,S=262144,C=67108864,w=134217728,T=16777216,E=65536,D=2,O=4,k=5e3,A=`The sandbox failed to run this code. The cause was logged on the server.`,j=`HostFunctionError`,M=`HostOutputTooLargeError`,N={NoReturn:`no_return`,OutputTooLarge:`output_too_large`,Timeout:`timeout`,MemoryLimit:`memory_limit`,SyntaxError:`syntax_error`,HostError:`host_error`,RuntimeError:`runtime_error`};export{k as ACQUIRE_TIMEOUT_MS,s as CODE_MODE_TOOL_NAMES,p as DEFAULT_MAX_LIFETIME_MS,f as DEFAULT_TIMEOUT_MS,m as EXECUTE_DEADLINE_MS,d as FETCH_BRIDGE_FUNCTION_NAME,u as FETCH_BRIDGE_GLOBAL_NAME,o as FETCH_TOOL_NAME,_ as GATEWAY_FETCH_BUDGET_PER_EXEC,v as GATEWAY_FETCH_LIMITS,j as HOST_FUNCTION_ERROR_NAME,M as HOST_OUTPUT_TOO_LARGE_ERROR_NAME,T as INITIAL_TOTAL_MEMORY_BYTES,A as INTERNAL_ERROR_MESSAGE,C as MAX_ALLOCATION_BYTES,D as MAX_CONCURRENT_RUNS,g as MAX_FETCH_CALLS,b as MAX_FETCH_OUTPUT_BYTES,O as MAX_QUEUED_RUNS,x as MAX_RESULT_BYTES,S as MAX_STACK_SIZE_BYTES,h as MAX_TOOL_CALLS,y as MAX_TOOL_OUTPUT_BYTES,w as MAX_TOTAL_MEMORY_BYTES,N as SANDBOX_FAILURE,c as SITE_GLOBAL_NAME,l as TOOLS_GLOBAL_ALIAS,E as WASM_PAGE_BYTES};
1
+ import{CALL_API_WRITE_TOOL_NAME as e,CREATE_ANONYMOUS_SESSION_TOOL_NAME as t,DISCOVER_TOOL_NAME as n,EXECUTE_TOOL_NAME as r,MANAGE_API_CREDENTIALS_TOOL_NAME as i,REMOVE_API_CREDENTIALS_TOOL_NAME as a,SUBMIT_FEEDBACK_TOOL_NAME as o}from"../../constants.js";const s=`fetch`,c=/* @__PURE__ */ new Set([r,n,t,i,a,o,e]),l=`site`,u=`tools`,d=`__fetchBridge`,f=`fetch`,p=1e4,m=45e3,h=5e4,g=1e3,_=50,v=50,y={ratePerMin:600,quotaPerDay:1e5},b=8388608,x=1048576,S=1048576,C=262144,w=67108864,T=134217728,E=16777216,D=65536,O=2,k=4,A=5e3,j=`The sandbox failed to run this code. The cause was logged on the server.`,M=`HostFunctionError`,N=`HostOutputTooLargeError`,P={NoReturn:`no_return`,OutputTooLarge:`output_too_large`,Timeout:`timeout`,MemoryLimit:`memory_limit`,SyntaxError:`syntax_error`,HostError:`host_error`,RuntimeError:`runtime_error`};export{A as ACQUIRE_TIMEOUT_MS,c as CODE_MODE_TOOL_NAMES,m as DEFAULT_MAX_LIFETIME_MS,p as DEFAULT_TIMEOUT_MS,h as EXECUTE_DEADLINE_MS,f as FETCH_BRIDGE_FUNCTION_NAME,d as FETCH_BRIDGE_GLOBAL_NAME,s as FETCH_TOOL_NAME,v as GATEWAY_FETCH_BUDGET_PER_EXEC,y as GATEWAY_FETCH_LIMITS,M as HOST_FUNCTION_ERROR_NAME,N as HOST_OUTPUT_TOO_LARGE_ERROR_NAME,E as INITIAL_TOTAL_MEMORY_BYTES,j as INTERNAL_ERROR_MESSAGE,w as MAX_ALLOCATION_BYTES,O as MAX_CONCURRENT_RUNS,_ as MAX_FETCH_CALLS,x as MAX_FETCH_OUTPUT_BYTES,k as MAX_QUEUED_RUNS,S as MAX_RESULT_BYTES,C as MAX_STACK_SIZE_BYTES,g as MAX_TOOL_CALLS,b as MAX_TOOL_OUTPUT_BYTES,T as MAX_TOTAL_MEMORY_BYTES,P as SANDBOX_FAILURE,l as SITE_GLOBAL_NAME,u as TOOLS_GLOBAL_ALIAS,D as WASM_PAGE_BYTES};