@redocly/framework 1.0.0-next.11 → 1.0.0-next.13
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.
- package/dist/bundler/dev/routes/source-sync-route.js +1 -1
- package/dist/bundler/dev/runtime-app.js +1 -1
- package/dist/bundler/dev/vite-config.js +1 -1
- package/dist/cli/problems-output.js +3 -3
- package/dist/client/UnversionedVersionButton.js +1 -1
- package/dist/client/VersionPicker.js +343 -0
- package/dist/client/ai-search/citations.js +3 -3
- package/dist/client/app.js +2 -2
- package/dist/client/classic-webview-sync.js +1 -0
- package/dist/client/client-entry.js +1 -1
- package/dist/client/history-mount.js +6 -5
- package/dist/client/page-sync.js +1 -0
- package/dist/client/review/ReviewBar.js +31 -31
- package/dist/client/review/login-url.js +1 -1
- package/dist/client/revisions-history.js +1 -1
- package/dist/content-layer/config-schema.js +1 -1
- package/dist/content-layer/config.d.ts +8 -0
- package/dist/content-layer/config.js +1 -1
- package/dist/content-layer/context.d.ts +6 -0
- package/dist/content-layer/database/entities.d.ts +2 -0
- package/dist/content-layer/database/entities.js +1 -1
- package/dist/content-layer/database/origins.d.ts +2 -1
- package/dist/content-layer/database/origins.js +1 -1
- package/dist/content-layer/database/route-query-deps.d.ts +19 -3
- package/dist/content-layer/database/route-query-deps.js +1 -1
- package/dist/content-layer/ingest/git-last-modified.d.ts +20 -0
- package/dist/content-layer/ingest/git-last-modified.js +5 -4
- package/dist/content-layer/ingest/run.js +1 -1
- package/dist/content-layer/link-checker/fingerprint.js +1 -1
- package/dist/content-layer/link-checker/load-view.js +1 -1
- package/dist/content-layer/markdown/client/markdown-text.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/index.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/build-definition.d.ts +2 -0
- package/dist/content-layer/plugins/internal/api-docs/server/build-definition.js +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/markdown-copy.js +11 -9
- package/dist/content-layer/plugins/internal/api-docs/server/options.d.ts +1 -1
- package/dist/content-layer/plugins/internal/api-docs/server/options.js +1 -1
- package/dist/content-layer/plugins/internal/api-functions/server/dispatch.js +1 -1
- package/dist/content-layer/plugins/internal/app-data/index.d.ts +1 -1
- package/dist/content-layer/plugins/internal/app-data/index.js +1 -1
- package/dist/content-layer/plugins/internal/catalog-classic/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/constants.d.ts +4 -3
- package/dist/content-layer/plugins/internal/mcp/constants.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/content-tools.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/index.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/audit.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/constants.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/execute-schema.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/codemode/prompts.js +8 -8
- package/dist/content-layer/plugins/internal/mcp/server/gateway/subject.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/tool-list.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/gateway/tools.js +3 -3
- package/dist/content-layer/plugins/internal/mcp/server/mcp-server.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/authorize.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/callback.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/oauth/error-reporting.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/rate-limit.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/server-card.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/workflows/resolve-workflows.js +1 -1
- package/dist/content-layer/plugins/internal/mcp/server/workflows/schemas.js +2 -1
- package/dist/content-layer/plugins/internal/mcp/server/workflows/tools.js +1 -1
- package/dist/content-layer/plugins/internal/scorecard-classic/client/template.js +1 -1
- package/dist/content-layer/plugins/internal/sidebar/index.js +1 -1
- package/dist/content-layer/plugins/internal/versions/index.js +1 -1
- package/dist/content-layer/plugins/utils/route-index.js +1 -1
- package/dist/content-layer/server/database.js +1 -1
- package/dist/content-layer/versions/group-info.d.ts +2 -1
- package/dist/content-layer/versions/group-info.js +1 -1
- package/dist/server/app.js +1 -1
- package/dist/server/auth/runtime.js +1 -1
- package/dist/server/content.js +7 -7
- package/dist/server/lambda-entry.js +1 -1
- package/dist/server/node-entry.js +1 -1
- package/dist/server/search/route.js +1 -1
- package/dist/server/telemetry/mock-server-events.js +1 -1
- package/dist/server/telemetry/sender.js +1 -1
- package/dist/server/wait-until.js +1 -0
- package/dist/shared/constants/review.d.ts +2 -0
- package/dist/shared/constants/review.js +1 -1
- package/dist/shared/constants/system-routes.d.ts +1 -1
- package/dist/shared/constants/system-routes.js +1 -1
- package/dist/shared/types/config.d.ts +2 -1
- package/package.json +5 -5
|
@@ -1 +1 @@
|
|
|
1
|
-
import{isPlanFeatureGranted as e}from"../../shared/plan-gates.js";import{assembleTemplateSet as t}from"../templates/template-set.js";import{assembleServerModuleSet as n}from"../server-modules/module-set.js";import{formatCount as r}from"../../shared/log-format.js";import{createLogger as i,stopwatch as a}from"../../shared/logger.js";import{L10N_DIR as o}from"../../shared/constants/l10n/defaults.js";import{collectL10nDirLocales as s,l10nDirOf as c,resolveLocaleContext as l}from"../../shared/utils/l10n.js";import{loadEffectiveConfigHash as ee,writeSiteConfig as te}from"../database/site-config.js";import{isConfigChanged as ne,isNestedConfigPath as u,loadContentLayerConfig as re,readNestedConfigProblems as ie}from"../config.js";import{contentIgnoreMatcherOf as ae,normalizeHintPaths as oe,scanContentFiles as d}from"./scan.js";import{resolveContentPluginsForFile as f}from"../plugins/registry.js";import{resolveContentLayerContext as p}from"../context.js";import{openContentLayerDatabase as m}from"../database/connection.js";import{garbageCollectOrphanBlobs as se}from"../database/blobs.js";import"../../shared/constants/app-data.js";import{listConfiguredProducts as ce,productFolderProblems as le}from"../products.js";import{appDataSystemEntityDescriptor as ue}from"../plugins/internal/app-data/index.js";import{warnWhenProjectPluginsAreNotLoaded as de}from"../plugins/project/loaded-set.js";import{apiOutputFiles as fe,readApiOutputs as pe,withApiOutputHints as me}from"../api-outputs.js";import{createContentPlugins as h}from"../plugins/create-content-plugins.js";import"../plugins/index.js";import{listRegisteredAssets as he}from"../database/assets.js";import{createProblem as g}from"../problems/codes.js";import{computeDirtyConfigOrigins as ge,computeDirtyFileOrigins as _e,garbageCollectOrphanedEntities as ve,loadOriginDependencyRows as ye,propagateConfigDependencyInvalidation as be,propagateEntityInvalidation as xe,propagateRetryableProblemInvalidation as Se}from"../database/invalidation.js";import{hasGlobalProblemsForSource as _,listGlobalProblems as Ce,listProblems as we,problemRow as v,replaceGlobalProblemsForKeysTx as Te,replaceGlobalProblemsForSourceTx as y}from"../database/problems.js";import{persistContentFileState as Ee,refreshFileLastModified as De}from"../database/files.js";import{loadContentLayerState as b,partitionIgnoredFiles as Oe,reloadContentLayerEntities as ke}from"../context-state.js";import{garbageCollectOrphanAssetFiles as Ae,restoreMissingAssetFiles as je}from"../materialization/asset-reconcile.js";import{resolveRevisionCapture as Me}from"../revisions/config.js";import{loadPluginHookState as Ne}from"../database/plugin-hook-state.js";import{loadRouteQueryDependencyRows as Pe}from"../database/route-query-deps.js";import{createEntityMaterializer as Fe}from"../materialization/materializer.js";import{runSearchSync as Ie}from"./search-sync.js";import{hashContentFiles as x}from"./hash.js";import{selectCurrentContentFiles as S}from"./current-files.js";import{collectL10nWarnings as Le,l10nLayoutProblems as Re,validateL10nConfig as ze}from"./l10n-warnings.js";import{collectAppDataFragmentOwnerIds as Be,reconcilePluginScopedRows as Ve,registerSystemEntities as He}from"../database/finalize.js";import{hasStaleManifestVersion as Ue,resetContentDatabase as We}from"../database/reset.js";import{readGitLastModified as Ge}from"./git-last-modified.js";import{createContentScanPlan as Ke}from"./scan-plan.js";import{collectPageRedirects as C}from"../page-redirects.js";import{syncContentFiles as qe}from"./sync.js";import{checkAllowedPackages as Je}from"../allowed-packages.js";import{syncUserMarkdocSchemaProblem as Ye}from"./markdoc-schema-problem.js";import{syncConfigLinkRefs as Xe}from"../link-checker/config-links.js";import{collectCollisionPeerOrigins as Ze}from"./slugger/collision-peers.js";async function w(e){let o=p({contentDir:e.contentDir,context:e.context,currentFileIndex:e.currentFileIndex,logger:e.logger??i(),plugins:h(e.contentDir)}),c=o.contentDir,d=o.logger.child(`content-layer`),f=d.child(`content-layer:scan`),x=d.child(`content-layer:hash`),S=d.child(`content-layer:db`),C=d.child(`content-layer:plan`),w=d.child(`content-layer:diff`),T=d.child(`content-layer:sync`),E=e.captureRevisions===!0,D=a();d.debug(`Starting content ingest`,{contentDir:c,hints:e.hints??[]});let A=e.database===void 0,j=e.database??await m({contentDir:c,databaseUrl:e.databaseUrl,migrationsDir:e.migrationsDir,runMigrations:e.runMigrations,platform:o.platform,logger:S});try{if(await Ue(j)){S.warn(`manifest version changed — resetting content database`);let e=a();await We(j,{logger:S}),S.info(`Reset content database`,{durationMs:e()}),o.state=void 0}let i=oe(c,e.hints??[]),p=a(),m=a(),h=await b({context:o,database:j}),A=[...h.filesByPath.values(),...h.ignoredFilesByPath.values()].sort((e,t)=>e.path.localeCompare(t.path));S.debug(`Loaded previous content state`,{loadedCount:A.length,totalCount:A.length,durationMs:m()});let M=await re({context:o,force:!0});await de({contentDir:c,config:M.config,fs:o.platform.fs,logger:d});let N=ne(k(M.config,h.routeBySlug.values()),await ee(j)),P=ze(o.config.l10n);for(let e of P)d.debug(e.message);(N||P.length>0||await _(j,`l10n-config`))&&await j.db.transaction(e=>y(e,`l10n-config`,P.map(e=>v(e,{scope:`global`,source:`l10n-config`})))),(N||M.problems.length>0||await _(j,`config`))&&await j.db.transaction(e=>y(e,`config`,M.problems.map(e=>v(g(e),{scope:`global`,source:`config`}))));let F=await Je(M.config,c,o.platform.fs);(F.length>0||await _(j,`allowed-packages`))&&await j.db.transaction(e=>y(e,`allowed-packages`,F.map(e=>v(g(e),{scope:`global`,source:`allowed-packages`})))),await Ye(j);let I=ae(o.config);Oe(h,I);let L=e=>pe({config:o.config,contentDir:c,fs:o.platform.fs,nestedConfigPaths:e,isIgnored:I}),R=N||i.some(u),z=await L([...h.filesByPath.keys()].filter(u)),tt=a(),B=await Ke({contentDir:c,fs:o.platform.fs,previousFiles:A,hints:me(i,z),ignoredDirectories:e.ignoredDirectories,configChanged:R,logger:C});C.debug(`Resolved ingest scan plan`,{hints:B.hintedPaths.length,configChanged:R,scanTargets:B.scanTargets.length,affectedPreviousFiles:B.affectedPreviousFiles.length,durationMs:tt()});let V=new Map(A.map(e=>[e.path,e.hash])),H=await et({contentDir:c,currentFileIndex:o.currentFileIndex,fs:o.platform.fs,scanPlan:B,ignoredDirectories:e.ignoredDirectories,scanLogger:f,hashLogger:x,previous:o.currentFileIndex?void 0:V,onProgress:e.onProgress});(B.hintedPaths.length===0||B.hintedPaths.includes(``))&&(z=await L(H.map(e=>e.path).filter(e=>u(e)&&!I(e))));let nt=await fe({outputs:z,files:H,contentDir:c,fs:o.platform.fs,previous:V}),U=[...H.filter(e=>!z.has(e.path)),...nt],W=new Map(await Ge(c,f));for(let[e,t]of z){let n=W.get(t);n!==void 0&&W.set(e,n)}d.info(`Scanned ${r(U.length)} files`,{durationMs:p()});let rt=a(),G=O(U,B.affectedPreviousFiles,{hintScopes:B.hintScopes,totalPrevious:A.length});w.debug(`Computed content diff`,{...G.summary,durationMs:rt()}),d.info(`Compared with the previous state: ${G.summary.added} added, ${G.summary.changed} changed, ${G.summary.removed} removed, ${G.summary.unchanged} unchanged`);let it=a(),at=a(),ot=await Ee(j,{upserts:[...G.added.map(e=>({path:e.path,hash:e.hash,lastModifiedAt:W.get(e.path)??null,manifest:JSON.stringify(e.manifest??{}),manifestVersion:e.manifestVersion})),...G.changed.map(e=>({path:e.path,hash:e.nextHash,lastModifiedAt:W.get(e.path)??null,manifest:JSON.stringify(e.file.manifest??{}),manifestVersion:e.file.manifestVersion}))],removedPaths:G.removed.map(e=>e.path),logger:S});S.debug(`Persisted content file state`,{upserts:G.added.length+G.changed.length,removed:G.removed.length,durationMs:at()});for(let e of G.removed)h.filesByPath.delete(e.path),h.ignoredFilesByPath.delete(e.path);for(let e of ot)(I(e.path)?h.ignoredFilesByPath:h.filesByPath).set(e.path,e);let st=l(o.config.l10n,s(h.filesByPath.keys())),K=o.currentFileIndex!==void 0||R||B.hintedPaths.length===0||B.hintedPaths.includes(``);if(K){let e=Re(Le({l10n:o.config.l10n,localeContext:st,filePaths:h.filesByPath.keys()})),t=le(ce(o.config),h.filesByPath.keys());for(let t of e)d.debug(t.message);for(let e of t)d.debug(e.message);await j.db.transaction(async n=>{await y(n,`l10n-layout`,e.map(e=>v(e,{scope:`global`,source:`l10n-layout`}))),await y(n,`products`,t.map(e=>v(g(e),{scope:`global`,source:`products`})))})}let q=K?[...h.filesByPath.keys()].filter(u):[...G.added,...G.changed].map(e=>e.path).filter(e=>u(e)&&!I(e)),ct=G.removed.map(e=>e.path).filter(u);if(K||q.length>0||ct.length>0){let e=(await ie({contentDir:c,fs:o.platform.fs,paths:q})).map(e=>v(g(e),{scope:`global`,source:`nested-config`,key:e.location?.filePath}));await j.db.transaction(t=>K?y(t,`nested-config`,e):Te(t,`nested-config`,[...q,...ct],e))}let lt=U.flatMap(e=>{let t=h.filesByPath.get(e.path),n=W.get(e.path)??null;return!t||t.lastModifiedAt===n?[]:(h.filesByPath.set(e.path,{...t,lastModifiedAt:n}),[{path:e.path,lastModifiedAt:n}])});await De(j,lt,S);let ut=new Set(U.filter(e=>$e(o,e,h.filePluginsByPath.get(e.path))).map(e=>e.path)),dt=await xe(j,{changedFilePaths:[...G.added.map(e=>e.path),...G.changed.map(e=>e.path),...G.removed.map(e=>e.path),...lt.map(e=>e.path),...ut],membershipChangedPaths:[...G.added,...G.removed].map(e=>e.path).filter(e=>!I(e)),logger:S}),ft=o.pluginRegistry.listExtractAllPlugins(),pt=o.pluginRegistry.listFinalizePlugins(),mt=new Set(pt.map(e=>e.id)),J=[...Be(h.entitiesByKey.get(`app-data`)?.loaderArgs??null)].filter(e=>!mt.has(e)),ht=await Ve(j,[...ft.map(e=>({pluginId:e.id,hook:`extractAll`})),...pt.map(e=>({pluginId:e.id,hook:`finalize`}))],{logger:S});J.length>0&&await He(j,[ue({fragmentUpdates:new Map(J.map(e=>[e,null]))})],{logger:S});let[Y,gt,_t]=await Promise.all([ye(j),Pe(j),Ne(j)]),vt=ge(Y,o.config),yt=_e(Y,h),bt=await be(j,{config:o.config,logger:S}),xt=await Se(j,{logger:S});if((await ve(j,S)).removedOrphans)await ke({state:h,database:j});else for(let e of[...dt.invalidatedKeys,...bt.invalidatedKeys,...xt.invalidatedKeys]){let t=h.entitiesByKey.get(e);t&&(t.status=`stale`)}(ht||J.length>0)&&(o.state=void 0,h=await b({context:o,database:j}));let St=await Ce(j,`slugger`),Ct=Ze(St,{touchedPaths:[...G.added.map(e=>e.path),...G.changed.map(e=>e.path),...G.removed.map(e=>e.path),...vt.map(e=>e.originFilePath),...yt.map(e=>e.originFilePath)],storedFilesByPath:h.filesByPath}),X=Qe({context:o,diff:G,currentFiles:U,dirtyOrigins:[...vt,...yt,...Ct],hintedPaths:B.hintedPaths,storedFilesByPath:h.filesByPath,pluginSetChangedPaths:ut}),wt=a(),Tt=Me(o.config,E),Z=await qe({context:o,database:j,localeContext:st,files:X,removedPaths:new Set(G.removed.map(e=>e.path)),pluginScopedOriginRows:Y,routeQueryRows:gt,hookState:_t,storedSluggerProblems:St,revisions:Tt,onFileSynced:(t,n)=>e.onProgress?.({stage:`sync`,done:t,total:n})});o.state=Z.state,T.debug(`Synchronized content routes`,{files:X.length,durationMs:wt()}),await Xe({database:j,config:o.config,configChanged:N,logger:S}),d.info(`Updated content state: ${G.added.length+G.changed.length} upserted, ${G.removed.length} removed, ${X.length} synced`,{durationMs:it()}),e.searchSync!==!1&&await Ie({context:o,database:j,inlineSearchables:Z.inlineSearchables,materializer:Fe({deps:{...o,state:Z.state},database:j,revisions:Tt})});let Et=await se(j,{logger:S});Et.removed>0&&S.debug(`blob GC removed orphan blobs`,{count:Et.removed});let Q=await Ae(o.pluginIO,{contentDir:c,database:j,logger:S});if(Q.removedRows>0&&S.debug(`asset GC removed orphan assets`,{count:Q.removedRows,swept:Q.sweptFilenames.length}),e.reconcileAssetFiles??!0){let e=await je(o.pluginIO,{contentDir:c,registered:await he(j)});e.restored.length>0&&d.info(`Restored ${e.restored.length} missing content ${e.restored.length===1?`asset`:`assets`}`),e.missingSources.length>0&&S.warn(`registered assets are missing their source file`,{paths:e.missingSources}),e.failed.length>0&&S.warn(`could not restore missing content assets; /content-assets/* will 404`,{paths:e.failed})}let{routeBySlug:Dt}=Z.state;o.config=k(M.config,Dt.values()),await te(j,k(M.siteConfig,Dt.values()),o.config);try{await j.db.transaction(e=>y(e,`system`,[]))}catch(e){S.warn(`could not clear the stored run failure`,{error:e instanceof Error?e.message:String(e)})}let Ot=e.collectProblems===!1?[]:await we(j);d.debug(`Content ingest complete`,{durationMs:D()});let $=Z.state,kt=t({registry:o.pluginRegistry,routes:$.routeBySlug.values()}),At=n({registry:o.pluginRegistry,entities:$.entitiesByKey.values()});return{contentDir:c,diff:G,currentFiles:H,previousFiles:B.affectedPreviousFiles,problems:Ot,templateSet:kt,serverModuleSet:At,inlineSearchables:Z.inlineSearchables,routeChanges:{...Z.routeChanges,unbounded:Z.routeChanges.unbounded||N}}}finally{A&&await j.close()}}function Qe(e){let t=/* @__PURE__ */ new Map;for(let n of e.diff.added)t.set(n.path,n);for(let n of e.diff.changed)t.set(n.path,n.file);let n=new Map(e.currentFiles.map(e=>[e.path,e]));for(let n of e.currentFiles)t.has(n.path)||e.pluginSetChangedPaths.has(n.path)&&t.set(n.path,n);for(let r of e.dirtyOrigins){let i=n.get(r.originFilePath)??D(e.context.contentDir,e.storedFilesByPath.get(r.originFilePath));i&&t.set(i.path,i)}let r=[...t.keys(),...e.diff.removed.map(e=>e.path)];for(let i of T(r,e.storedFilesByPath.keys())){if(t.has(i))continue;let r=n.get(i)??D(e.context.contentDir,e.storedFilesByPath.get(i));r&&t.set(i,r)}return Array.from(t.values())}function T(e,t){let n=new Set([...e].filter(e=>!e.startsWith(`${o}/`))),r=[];for(let e of t){let t=c(e);t!==void 0&&n.has(e.slice(`@l10n/${t}/`.length))&&r.push(e)}return r}function $e(e,t,n){let r=f(e,t.path).map(e=>({id:e.id,version:e.version})).sort((e,t)=>e.id.localeCompare(t.id)),i=[...n??[]].sort((e,t)=>e.pluginId.localeCompare(t.pluginId));return r.length!==i.length||r.some((e,t)=>{let n=i[t];return n===void 0||n.pluginId!==e.id||n.pluginVersion!==e.version})}function E(e,t){return`${e.replace(/\/$/,``)}/${t}`}function D(e,t){if(t)return{absolutePath:E(e,t.path),hash:t.hash,manifestVersion:t.manifestVersion,path:t.path}}function O(e,t,n={}){let r=new Map(e.map(e=>[e.path,e])),i=new Map(t.map(e=>[e.path,e])),a=n.hintScopes??[],o=[],s=[],c=[],l=[];for(let t of e){let e=i.get(t.path);if(!e){o.push(t);continue}if(e.hash!==t.hash){s.push({path:t.path,previousHash:e.hash,nextHash:t.hash,file:t});continue}c.push(t)}for(let e of t)r.has(e.path)||l.push(e);return{added:o,changed:s,removed:l,unchanged:c,hintScopes:a,summary:{added:o.length,changed:s.length,removed:l.length,unchanged:c.length,totalCurrent:n.totalPrevious===void 0?e.length:n.totalPrevious-l.length+o.length,totalPrevious:n.totalPrevious??t.length}}}async function et(e){if(e.currentFileIndex){let t=S({currentFileIndex:e.currentFileIndex,hintScopes:e.scanPlan.hintScopes,hintedPaths:e.scanPlan.hintedPaths});return e.scanLogger.debug(`Using provided current file snapshot`,{count:t.length,totalCount:e.currentFileIndex.size}),t}let t=a(),n=await d({fs:e.fs,rootDir:e.contentDir,targets:e.scanPlan.scanTargets,ignoredDirectories:e.ignoredDirectories,logger:e.scanLogger});e.scanLogger.debug(`Scanned content files`,{count:n.length,durationMs:t()});let r=a(),i=await x(n,{fs:e.fs,logger:e.hashLogger,previous:e.previous,onFileHashed:(t,n)=>e.onProgress?.({stage:`scan`,done:t,total:n})});return e.hashLogger.debug(`Computed content hashes`,{count:i.length,durationMs:r()}),i}function k(t,n){let r=e(t,`redirects`)?C(n):{};return{...t,redirects:{...r,...t.redirects}}}export{O as diffContentFiles,w as runContentIngest};
|
|
1
|
+
import{isPlanFeatureGranted as e}from"../../shared/plan-gates.js";import{assembleTemplateSet as t}from"../templates/template-set.js";import{assembleServerModuleSet as n}from"../server-modules/module-set.js";import{formatCount as r}from"../../shared/log-format.js";import{createLogger as i,stopwatch as a}from"../../shared/logger.js";import{L10N_DIR as o}from"../../shared/constants/l10n/defaults.js";import{collectL10nDirLocales as s,l10nDirOf as c,resolveLocaleContext as l}from"../../shared/utils/l10n.js";import{loadEffectiveConfigHash as ee,writeSiteConfig as te}from"../database/site-config.js";import{isConfigChanged as ne,isNestedConfigPath as u,loadContentLayerConfig as re,readNestedConfigProblems as ie}from"../config.js";import{contentIgnoreMatcherOf as ae,normalizeHintPaths as oe,scanContentFiles as d}from"./scan.js";import{resolveContentPluginsForFile as f}from"../plugins/registry.js";import{resolveContentLayerContext as p}from"../context.js";import{openContentLayerDatabase as m}from"../database/connection.js";import{garbageCollectOrphanBlobs as se}from"../database/blobs.js";import"../../shared/constants/app-data.js";import{listConfiguredProducts as ce,productFolderProblems as le}from"../products.js";import{appDataSystemEntityDescriptor as ue}from"../plugins/internal/app-data/index.js";import{warnWhenProjectPluginsAreNotLoaded as de}from"../plugins/project/loaded-set.js";import{apiOutputFiles as fe,readApiOutputs as pe,withApiOutputHints as me}from"../api-outputs.js";import{createContentPlugins as h}from"../plugins/create-content-plugins.js";import"../plugins/index.js";import{listRegisteredAssets as he}from"../database/assets.js";import{createProblem as g}from"../problems/codes.js";import{computeDirtyConfigOrigins as ge,computeDirtyFileOrigins as _e,garbageCollectOrphanedEntities as ve,loadOriginDependencyRows as ye,propagateConfigDependencyInvalidation as be,propagateEntityInvalidation as xe,propagateRetryableProblemInvalidation as Se}from"../database/invalidation.js";import{hasGlobalProblemsForSource as _,listGlobalProblems as Ce,listProblems as we,problemRow as v,replaceGlobalProblemsForKeysTx as Te,replaceGlobalProblemsForSourceTx as y}from"../database/problems.js";import{persistContentFileState as Ee,refreshFileLastModified as De}from"../database/files.js";import{loadContentLayerState as b,partitionIgnoredFiles as Oe,reloadContentLayerEntities as ke}from"../context-state.js";import{garbageCollectOrphanAssetFiles as Ae,restoreMissingAssetFiles as je}from"../materialization/asset-reconcile.js";import{resolveRevisionCapture as Me}from"../revisions/config.js";import{loadPluginHookState as Ne}from"../database/plugin-hook-state.js";import{loadRouteQueryDependencyRows as Pe}from"../database/route-query-deps.js";import{createEntityMaterializer as Fe}from"../materialization/materializer.js";import{runSearchSync as Ie}from"./search-sync.js";import{hashContentFiles as x}from"./hash.js";import{selectCurrentContentFiles as S}from"./current-files.js";import{collectL10nWarnings as Le,l10nLayoutProblems as Re,validateL10nConfig as ze}from"./l10n-warnings.js";import{collectAppDataFragmentOwnerIds as Be,reconcilePluginScopedRows as Ve,registerSystemEntities as He}from"../database/finalize.js";import{hasStaleManifestVersion as Ue,resetContentDatabase as We}from"../database/reset.js";import{readGitLastModified as Ge}from"./git-last-modified.js";import{createContentScanPlan as Ke}from"./scan-plan.js";import{collectPageRedirects as C}from"../page-redirects.js";import{syncContentFiles as qe}from"./sync.js";import{checkAllowedPackages as Je}from"../allowed-packages.js";import{syncUserMarkdocSchemaProblem as Ye}from"./markdoc-schema-problem.js";import{syncConfigLinkRefs as Xe}from"../link-checker/config-links.js";import{collectCollisionPeerOrigins as Ze}from"./slugger/collision-peers.js";async function w(e){let o=p({contentDir:e.contentDir,context:e.context,currentFileIndex:e.currentFileIndex,logger:e.logger??i(),plugins:h(e.contentDir)}),c=o.contentDir,d=o.logger.child(`content-layer`),f=d.child(`content-layer:scan`),x=d.child(`content-layer:hash`),S=d.child(`content-layer:db`),C=d.child(`content-layer:plan`),w=d.child(`content-layer:diff`),T=d.child(`content-layer:sync`),E=e.captureRevisions===!0,D=a();d.debug(`Starting content ingest`,{contentDir:c,hints:e.hints??[]});let A=e.database===void 0,j=e.database??await m({contentDir:c,databaseUrl:e.databaseUrl,migrationsDir:e.migrationsDir,runMigrations:e.runMigrations,platform:o.platform,logger:S});try{if(await Ue(j)){S.warn(`manifest version changed — resetting content database`);let e=a();await We(j,{logger:S}),S.info(`Reset content database`,{durationMs:e()}),o.state=void 0}let i=oe(c,e.hints??[]),p=a(),m=a(),h=await b({context:o,database:j}),A=[...h.filesByPath.values(),...h.ignoredFilesByPath.values()].sort((e,t)=>e.path.localeCompare(t.path));S.debug(`Loaded previous content state`,{loadedCount:A.length,totalCount:A.length,durationMs:m()});let M=await re({context:o,force:!0});await de({contentDir:c,config:M.config,fs:o.platform.fs,logger:d});let N=ne(k(M.config,h.routeBySlug.values()),await ee(j)),P=ze(o.config.l10n);for(let e of P)d.debug(e.message);(N||P.length>0||await _(j,`l10n-config`))&&await j.db.transaction(e=>y(e,`l10n-config`,P.map(e=>v(e,{scope:`global`,source:`l10n-config`})))),(N||M.problems.length>0||await _(j,`config`))&&await j.db.transaction(e=>y(e,`config`,M.problems.map(e=>v(g(e),{scope:`global`,source:`config`}))));let F=await Je(M.config,c,o.platform.fs);(F.length>0||await _(j,`allowed-packages`))&&await j.db.transaction(e=>y(e,`allowed-packages`,F.map(e=>v(g(e),{scope:`global`,source:`allowed-packages`})))),await Ye(j);let I=ae(o.config);Oe(h,I);let L=e=>pe({config:o.config,contentDir:c,fs:o.platform.fs,nestedConfigPaths:e,isIgnored:I}),R=N||i.some(u),z=await L([...h.filesByPath.keys()].filter(u)),tt=a(),B=await Ke({contentDir:c,fs:o.platform.fs,previousFiles:A,hints:me(i,z),ignoredDirectories:e.ignoredDirectories,configChanged:R,logger:C});C.debug(`Resolved ingest scan plan`,{hints:B.hintedPaths.length,configChanged:R,scanTargets:B.scanTargets.length,affectedPreviousFiles:B.affectedPreviousFiles.length,durationMs:tt()});let nt=new Map(A.map(e=>[e.path,e.hash])),V=await et({contentDir:c,currentFileIndex:o.currentFileIndex,fs:o.platform.fs,scanPlan:B,ignoredDirectories:e.ignoredDirectories,scanLogger:f,hashLogger:x,previous:o.currentFileIndex?void 0:nt,onProgress:e.onProgress});(B.hintedPaths.length===0||B.hintedPaths.includes(``))&&(z=await L(V.map(e=>e.path).filter(e=>u(e)&&!I(e))));let rt=await fe({outputs:z,files:V,contentDir:c,fs:o.platform.fs,previous:nt}),H=[...V.filter(e=>!z.has(e.path)),...rt];o.gitLastModified=await Ge(c,f,o.gitLastModified);let U=new Map(o.gitLastModified.index);for(let[e,t]of z){let n=U.get(t);n!==void 0&&U.set(e,n)}d.info(`Scanned ${r(H.length)} files`,{durationMs:p()});let it=a(),W=O(H,B.affectedPreviousFiles,{hintScopes:B.hintScopes,totalPrevious:A.length});w.debug(`Computed content diff`,{...W.summary,durationMs:it()}),d.info(`Compared with the previous state: ${W.summary.added} added, ${W.summary.changed} changed, ${W.summary.removed} removed, ${W.summary.unchanged} unchanged`);let at=a(),ot=a(),st=await Ee(j,{upserts:[...W.added.map(e=>({path:e.path,hash:e.hash,lastModifiedAt:U.get(e.path)??null,manifest:JSON.stringify(e.manifest??{}),manifestVersion:e.manifestVersion})),...W.changed.map(e=>({path:e.path,hash:e.nextHash,lastModifiedAt:U.get(e.path)??null,manifest:JSON.stringify(e.file.manifest??{}),manifestVersion:e.file.manifestVersion}))],removedPaths:W.removed.map(e=>e.path),logger:S});S.debug(`Persisted content file state`,{upserts:W.added.length+W.changed.length,removed:W.removed.length,durationMs:ot()});for(let e of W.removed)h.filesByPath.delete(e.path),h.ignoredFilesByPath.delete(e.path);for(let e of st)(I(e.path)?h.ignoredFilesByPath:h.filesByPath).set(e.path,e);let ct=l(o.config.l10n,s(h.filesByPath.keys())),G=o.currentFileIndex!==void 0||R||B.hintedPaths.length===0||B.hintedPaths.includes(``);if(G){let e=Re(Le({l10n:o.config.l10n,localeContext:ct,filePaths:h.filesByPath.keys()})),t=le(ce(o.config),h.filesByPath.keys());for(let t of e)d.debug(t.message);for(let e of t)d.debug(e.message);await j.db.transaction(async n=>{await y(n,`l10n-layout`,e.map(e=>v(e,{scope:`global`,source:`l10n-layout`}))),await y(n,`products`,t.map(e=>v(g(e),{scope:`global`,source:`products`})))})}let K=G?[...h.filesByPath.keys()].filter(u):[...W.added,...W.changed].map(e=>e.path).filter(e=>u(e)&&!I(e)),lt=W.removed.map(e=>e.path).filter(u);if(G||K.length>0||lt.length>0){let e=(await ie({contentDir:c,fs:o.platform.fs,paths:K})).map(e=>v(g(e),{scope:`global`,source:`nested-config`,key:e.location?.filePath}));await j.db.transaction(t=>G?y(t,`nested-config`,e):Te(t,`nested-config`,[...K,...lt],e))}let ut=H.flatMap(e=>{let t=h.filesByPath.get(e.path),n=U.get(e.path)??null;return!t||t.lastModifiedAt===n?[]:(h.filesByPath.set(e.path,{...t,lastModifiedAt:n}),[{path:e.path,lastModifiedAt:n}])});await De(j,ut,S);let dt=new Set(H.filter(e=>$e(o,e,h.filePluginsByPath.get(e.path))).map(e=>e.path)),ft=await xe(j,{changedFilePaths:[...W.added.map(e=>e.path),...W.changed.map(e=>e.path),...W.removed.map(e=>e.path),...ut.map(e=>e.path),...dt],membershipChangedPaths:[...W.added,...W.removed].map(e=>e.path).filter(e=>!I(e)),logger:S}),pt=o.pluginRegistry.listExtractAllPlugins(),mt=o.pluginRegistry.listFinalizePlugins(),ht=new Set(mt.map(e=>e.id)),q=[...Be(h.entitiesByKey.get(`app-data`)?.loaderArgs??null)].filter(e=>!ht.has(e)),gt=await Ve(j,[...pt.map(e=>({pluginId:e.id,hook:`extractAll`})),...mt.map(e=>({pluginId:e.id,hook:`finalize`}))],{logger:S});q.length>0&&await He(j,[ue({fragmentUpdates:new Map(q.map(e=>[e,null]))})],{logger:S});let[J,_t,vt]=await Promise.all([ye(j),Pe(j,o.routeQueryRows),Ne(j)]);o.routeQueryRows=_t;let yt=_t.rows,bt=ge(J,o.config),xt=_e(J,h),St=await be(j,{config:o.config,logger:S}),Ct=await Se(j,{logger:S});if((await ve(j,S)).removedOrphans)await ke({state:h,database:j});else for(let e of[...ft.invalidatedKeys,...St.invalidatedKeys,...Ct.invalidatedKeys]){let t=h.entitiesByKey.get(e);t&&(t.status=`stale`)}(gt||q.length>0)&&(o.state=void 0,h=await b({context:o,database:j}));let wt=await Ce(j,`slugger`),Tt=Ze(wt,{touchedPaths:[...W.added.map(e=>e.path),...W.changed.map(e=>e.path),...W.removed.map(e=>e.path),...bt.map(e=>e.originFilePath),...xt.map(e=>e.originFilePath)],storedFilesByPath:h.filesByPath}),Y=Qe({context:o,diff:W,currentFiles:H,dirtyOrigins:[...bt,...xt,...Tt],hintedPaths:B.hintedPaths,storedFilesByPath:h.filesByPath,pluginSetChangedPaths:dt}),Et=a(),Dt=Me(o.config,E),X=await qe({context:o,database:j,localeContext:ct,files:Y,removedPaths:new Set(W.removed.map(e=>e.path)),pluginScopedOriginRows:J,routeQueryRows:yt,hookState:vt,storedSluggerProblems:wt,revisions:Dt,onFileSynced:(t,n)=>e.onProgress?.({stage:`sync`,done:t,total:n})});o.state=X.state,T.debug(`Synchronized content routes`,{files:Y.length,durationMs:Et()}),await Xe({database:j,config:o.config,configChanged:N,logger:S}),d.info(`Updated content state: ${W.added.length+W.changed.length} upserted, ${W.removed.length} removed, ${Y.length} synced`,{durationMs:at()}),e.searchSync!==!1&&await Ie({context:o,database:j,inlineSearchables:X.inlineSearchables,materializer:Fe({deps:{...o,state:X.state},database:j,revisions:Dt})});let Z=await se(j,{logger:S});Z.removed>0&&S.debug(`blob GC removed orphan blobs`,{count:Z.removed});let Q=await Ae(o.pluginIO,{contentDir:c,database:j,logger:S});if(Q.removedRows>0&&S.debug(`asset GC removed orphan assets`,{count:Q.removedRows,swept:Q.sweptFilenames.length}),e.reconcileAssetFiles??!0){let e=await je(o.pluginIO,{contentDir:c,registered:await he(j)});e.restored.length>0&&d.info(`Restored ${e.restored.length} missing content ${e.restored.length===1?`asset`:`assets`}`),e.missingSources.length>0&&S.warn(`registered assets are missing their source file`,{paths:e.missingSources}),e.failed.length>0&&S.warn(`could not restore missing content assets; /content-assets/* will 404`,{paths:e.failed})}let{routeBySlug:Ot}=X.state;o.config=k(M.config,Ot.values()),await te(j,k(M.siteConfig,Ot.values()),o.config);try{await j.db.transaction(e=>y(e,`system`,[]))}catch(e){S.warn(`could not clear the stored run failure`,{error:e instanceof Error?e.message:String(e)})}let kt=e.collectProblems===!1?[]:await we(j);d.debug(`Content ingest complete`,{durationMs:D()});let $=X.state,At=t({registry:o.pluginRegistry,routes:$.routeBySlug.values()}),jt=n({registry:o.pluginRegistry,entities:$.entitiesByKey.values()});return{contentDir:c,diff:W,currentFiles:V,previousFiles:B.affectedPreviousFiles,problems:kt,templateSet:At,serverModuleSet:jt,inlineSearchables:X.inlineSearchables,routeChanges:{...X.routeChanges,unbounded:X.routeChanges.unbounded||N}}}finally{A&&await j.close()}}function Qe(e){let t=/* @__PURE__ */ new Map;for(let n of e.diff.added)t.set(n.path,n);for(let n of e.diff.changed)t.set(n.path,n.file);let n=new Map(e.currentFiles.map(e=>[e.path,e]));for(let n of e.currentFiles)t.has(n.path)||e.pluginSetChangedPaths.has(n.path)&&t.set(n.path,n);for(let r of e.dirtyOrigins){let i=n.get(r.originFilePath)??D(e.context.contentDir,e.storedFilesByPath.get(r.originFilePath));i&&t.set(i.path,i)}let r=[...t.keys(),...e.diff.removed.map(e=>e.path)];for(let i of T(r,e.storedFilesByPath.keys())){if(t.has(i))continue;let r=n.get(i)??D(e.context.contentDir,e.storedFilesByPath.get(i));r&&t.set(i,r)}return Array.from(t.values())}function T(e,t){let n=new Set([...e].filter(e=>!e.startsWith(`${o}/`))),r=[];for(let e of t){let t=c(e);t!==void 0&&n.has(e.slice(`@l10n/${t}/`.length))&&r.push(e)}return r}function $e(e,t,n){let r=f(e,t.path).map(e=>({id:e.id,version:e.version})).sort((e,t)=>e.id.localeCompare(t.id)),i=[...n??[]].sort((e,t)=>e.pluginId.localeCompare(t.pluginId));return r.length!==i.length||r.some((e,t)=>{let n=i[t];return n===void 0||n.pluginId!==e.id||n.pluginVersion!==e.version})}function E(e,t){return`${e.replace(/\/$/,``)}/${t}`}function D(e,t){if(t)return{absolutePath:E(e,t.path),hash:t.hash,manifestVersion:t.manifestVersion,path:t.path}}function O(e,t,n={}){let r=new Map(e.map(e=>[e.path,e])),i=new Map(t.map(e=>[e.path,e])),a=n.hintScopes??[],o=[],s=[],c=[],l=[];for(let t of e){let e=i.get(t.path);if(!e){o.push(t);continue}if(e.hash!==t.hash){s.push({path:t.path,previousHash:e.hash,nextHash:t.hash,file:t});continue}c.push(t)}for(let e of t)r.has(e.path)||l.push(e);return{added:o,changed:s,removed:l,unchanged:c,hintScopes:a,summary:{added:o.length,changed:s.length,removed:l.length,unchanged:c.length,totalCurrent:n.totalPrevious===void 0?e.length:n.totalPrevious-l.length+o.length,totalPrevious:n.totalPrevious??t.length}}}async function et(e){if(e.currentFileIndex){let t=S({currentFileIndex:e.currentFileIndex,hintScopes:e.scanPlan.hintScopes,hintedPaths:e.scanPlan.hintedPaths});return e.scanLogger.debug(`Using provided current file snapshot`,{count:t.length,totalCount:e.currentFileIndex.size}),t}let t=a(),n=await d({fs:e.fs,rootDir:e.contentDir,targets:e.scanPlan.scanTargets,ignoredDirectories:e.ignoredDirectories,logger:e.scanLogger});e.scanLogger.debug(`Scanned content files`,{count:n.length,durationMs:t()});let r=a(),i=await x(n,{fs:e.fs,logger:e.hashLogger,previous:e.previous,onFileHashed:(t,n)=>e.onProgress?.({stage:`scan`,done:t,total:n})});return e.hashLogger.debug(`Computed content hashes`,{count:i.length,durationMs:r()}),i}function k(t,n){let r=e(t,`redirects`)?C(n):{};return{...t,redirects:{...r,...t.redirects}}}export{O as diffContentFiles,w as runContentIngest};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{hashContentBytes as e}from"../../shared/utils/content-hash.js";import{inventoryKey as t}from"./view.js";import"./validate.js";const n=`route:`,r=`file:`,i=new TextEncoder;async function a(e,i){let a={};for(let[t,r]of e.routeBySlug)a[`${n}${t}`]=JSON.stringify([r.wildcardPrefix,r.sourcePath]);for(let t of e.servedStaticPaths)a[`static:${t}`]=``;for(let n of e.filePaths)a[`${r}${n}`]=JSON.stringify([i.get(n)??null,e.primaryRouteByFilePath.get(n)??null,await s(e.inventories.get(t(n,`anchor`))),await s(e.inventories.get(t(n,`subpath`)))]);return{unboundedInputs:JSON.stringify([
|
|
1
|
+
import{hashContentBytes as e}from"../../shared/utils/content-hash.js";import{inventoryKey as t}from"./view.js";import"./validate.js";const n=`route:`,r=`file:`,i=new TextEncoder;async function a(e,i){let a={};for(let[t,r]of e.routeBySlug)a[`${n}${t}`]=JSON.stringify([r.wildcardPrefix,r.sourcePath]);for(let t of e.servedStaticPaths)a[`static:${t}`]=``;for(let n of e.filePaths)a[`${r}${n}`]=JSON.stringify([i.get(n)??null,e.primaryRouteByFilePath.get(n)??null,await s(e.inventories.get(t(n,`anchor`))),await s(e.inventories.get(t(n,`subpath`)))]);return{unboundedInputs:JSON.stringify([7,e.localeContext.defaultLocale,e.localeContext.locales,Object.keys(e.redirects).sort().map(t=>[t,e.redirects[t]?.to]),[...e.wildcardSlugs].sort(),e.checkAnchors,e.anchorSeverity]),targets:a}}function o(e,t){let i=[],a=[],o=e=>{e.startsWith(r)?a.push(e.slice(5)):i.push(e.slice(e.startsWith(n)?6:7))};for(let[n,r]of Object.entries(t))e[n]!==r&&o(n);for(let n of Object.keys(e))Object.hasOwn(t,n)||o(n);return{changedSlugs:i,changedFilePaths:a}}async function s(t){if(t===void 0)return null;let n=`${t.exhaustive}\0${[...t.targets].join(`\0`)}`;return e(i.encode(n))}export{o as diffLinkCheckTargets,a as fingerprintLinkCheckView};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{collectL10nDirLocales as e,resolveLocaleContext as t}from"../../shared/utils/l10n.js";import{files as n,routes as r,staticFiles as i,targetInventories as a}from"../database/schema.js";import{
|
|
1
|
+
import{collectL10nDirLocales as e,resolveLocaleContext as t}from"../../shared/utils/l10n.js";import{files as n,routes as r,staticFiles as i,targetInventories as a}from"../database/schema.js";import{loadSiteStart as o}from"../database/entities.js";import{getVersionCatalog as s}from"../versions/resolve.js";import{toVersionlessSlug as c}from"../versions/redirect.js";import{buildLinkCheckView as l}from"./view.js";import{asc as u,eq as d}from"drizzle-orm";async function f(s){let{database:c}=s,[f,h,g,_,v]=await Promise.all([c.db.select({slug:r.slug,wildcardPrefix:r.wildcardPrefix,sourcePath:n.path,version:r.version,versionGroup:r.versionGroup,locale:r.locale}).from(r).leftJoin(n,d(r.sourceId,n.id)).orderBy(u(r.id)),c.db.select({filePath:n.path,kind:a.kind,exhaustive:a.exhaustive,targets:a.targets}).from(a).innerJoin(n,d(a.fileId,n.id)),c.db.select({path:n.path}).from(n),c.db.select({path:i.path}).from(i),o(c)]),y=g.map(e=>e.path),b=t(s.config.l10n,e(y));return l({routes:await m(c,f),filePaths:y,inventories:h,redirects:p(s.config,v),servedStaticPaths:_.map(e=>`/${e.path}`),localeContext:b,checkAnchors:s.config.linkChecker?.anchors?.hide!==!0,anchorSeverity:s.config.linkChecker?.anchors?.severity??`warning`})}function p(e,t){let n=Object.fromEntries(Object.entries(e.redirects??{}).map(([e,t])=>[e,t.to]));return t===null?n:{"/":t,...n}}async function m(e,t){let n=await s(e.db),r=new Set(t.map(e=>e.slug)),i=[];for(let e of t){if(!e.versionGroup||!e.version||(await n.groupInfo(e.versionGroup)).defaultVersion!==e.version)continue;let t=c(e.slug,e.versionGroup,e.version,e.locale);t!==e.slug&&!r.has(t)&&i.push({...e,slug:t})}return[...t,...i]}export{f as loadLinkCheckView};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{headingSlugger as e}from"../utils/heading-slugger.js";import{renderMarkdocAst as t}from"./markdoc-components.js";import{buildMarkdownTextTagSet as n}from"../constants/markdown-text-tag-set.js";import r from"@redocly/markdoc";import{userMarkdocFunctions as i,userMarkdocNodes as a,userMarkdocTags as o}from"virtual:realm-markdoc-schema";let s;function c(c){return c?(s??=n({tags:o,nodes:a,functions:i}),e.reset(),t(r.transform(r.parse(c),s))):null}export{c as renderMarkdownText};
|
|
1
|
+
import{headingSlugger as e}from"../utils/heading-slugger.js";import{renderMarkdocAst as t}from"./markdoc-components.js";import{buildMarkdownTextTagSet as n}from"../constants/markdown-text-tag-set.js";import r from"@redocly/markdoc";import{userMarkdocFunctions as i,userMarkdocNodes as a,userMarkdocTags as o}from"virtual:realm-markdoc-schema";let s;function c(c){return c?(s??=n({tags:o,nodes:a,functions:i}),e.reset(),t(r.transform(r.parse(c,{linkify:!0}),s))):null}export{c as renderMarkdownText};
|
|
@@ -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{runtimeTemplate as r}from"../../templates.js";import{SEARCH_API_TITLE_FACET_FIELD as i,SEARCH_API_VERSION_FACET_FIELD as a,SEARCH_GROUP_FACET_FIELD as o}from"../../../../shared/search/facets.js";import{configuredFacetFields as s,extractFacetsFromFrontmatter as c,invalidFacetValueProblems as l,searchCategoryOf as u}from"../../../search/facet-values.js";import{isPlanFeatureGranted as d}from"../../../../shared/plan-gates.js";import{toPosixPath as f}from"../../../../shared/utils/to-posix-path.js";import{isObject as p}from"../../../../shared/utils/is-object.js";import{API_DOCS_MARKDOC_TAG_SET as m,resolveMarkdocTagSet as h}from"../../../markdown/constants/tag-sets.js";import{TRANSLATIONS_FILE_PATTERN as g}from"../../../../shared/constants/l10n/defaults.js";import{notInPlanProblem as _}from"../../../plan-gates.js";import{filePathToRouteSlug as v}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{SPEC_KIND_ARAZZO as y,SPEC_KIND_ASYNCAPI as b,SPEC_KIND_GRAPHQL as x,SPEC_KIND_GRPC as S,SPEC_KIND_OPENAPI as C}from"../../../../shared/constants/api-spec-kinds.js";import{packMarkdocAstsDeep as w,unpackMarkdocAstsDeep as T}from"../../../../shared/utils/packed-ast.js";import{findVersionFolder as E}from"../../utils/version-path.js";import{toPublicVersionedSlug as D}from"../../../../shared/constants/versions.js";import{readVersionsYaml as ee,versionsYamlPath as te}from"../../../versions/version-groups.js";import{parseMarkdownCached as O}from"../../../markdown/utils/parse-cache.js";import{createApiEntityKey as k}from"../../utils/api-entity-key.js";import{API_DOCS_API_LOADER_ID as ne,API_DOCS_PLUGIN_ID as re,API_DOCS_RENDER_DEP_KEY as ie,API_DOCS_RENDER_LOADER_ID as ae,API_DOCS_SIDEBAR_LOADER_ID as oe,API_DOCS_TEMPLATE_ID as A,SPEC_DOWNLOAD_ROUTE_PATHS as j,SPEC_PATH_PARAM as se}from"./server/shared.js";import{resolveApiBundleConfig as ce,resolveApiOptions as le,resolveNestedFeedback as ue,schemaCatalogLink as de,withDownloadUrls as fe,withFeedbackOption as pe,withMockServerOption as me}from"./server/options.js";import{annotateApiDocsRbac as M}from"../../../../shared/rbac/api-docs.js";import{SERVER_ONLY_VALUE_KEY as N}from"../../../loaders/server-only-value.js";import{getLoadedProjectPlugins as P}from"../../project/loaded-set.js";import{API_OUTPUT_MANIFEST_KEY as F}from"../../../api-outputs.js";import{pageLocale as I}from"../../utils/page-locale.js";import{buildBundledApiDefinition as L,resolveLlmsDescriptions as R}from"./server/build-definition.js";import{collectSidebarSubpathTargets as z,toSidebarSubtree as he,toSubpathTarget as ge}from"./server/build-sidebar.js";import{declaresProtoService as _e}from"./server/declares-proto-service.js";import{join as ve,relative as ye,resolve as B}from"node:path";import be from"@redocly/markdoc";async function xe(e,t){let n=t.originFilePath===null?null:E(t.originFilePath);if(n===null||t.version===null||t.versionGroup===null)return{slug:t.slug,entityDeps:[]};let r=(await ee({io:{exists:t=>e.io.exists(B(e.contentDir,t)),readFile:t=>e.io.readFile(B(e.contentDir,t))},directory:n.parent}))?.default===t.version;return{slug:D(t.slug,t.versionGroup,t.version,r),entityDeps:[{kind:`file`,path:te(n.parent)}]}}const Se=[`.yaml`,`.yml`,`.json`,`.gql`,`.graphql`,`.proto`],Ce={[C]:`OpenAPI`,[b]:`AsyncAPI`,[x]:`GraphQL`,[y]:`Arazzo`,[S]:`gRPC`},V=t(ae,async e=>{let{buildItems:t,descriptionOptions:n}=await import(`@redocly/api-docs/server`),r=W(e),i=await e.io.readFile(r.absolutePath),a=e.routes.byFilePath(e.file.path),o=a?.slug,s=a&&e.args.kind===`openapi`?await xe(e,a):{slug:void 0,entityDeps:[]},c=fe(e.args.options,e.file.path,e.args.kind),l=e.args.kind===`openapi`?me(c,e.config,s.slug):c,u={entityDeps:[],assetUsages:[],linkRefs:[],problems:[],pending:[]},d=U(e.contentDir),f={markdown:e.markdown,loader:{config:e.config,entities:e.entities,file:e.file,io:e.io,logger:e.logger,plugin:e.plugin},sink:u},h=await L({kind:e.args.kind,source:i,relativePath:r.relativePath,contentDir:e.contentDir,pagePath:e.file.path,options:l,bundle:G(e.args,d),metadata:J(e.args.options),io:e.io,markdownResolution:f,rbac:{warn:t=>e.logger?.warn(t)}}),g={...p(h.document)&&p(h.document.info)?{infoDescription:h.document.info.description}:{},...await R(h.document,f,{contentDir:e.contentDir,specPath:r.relativePath,pagePath:e.file.path})};e.args.kind===`openapi`&&l.showSchemaCatalogLinks&&p(h.document)&&(h.document[`x-schema-catalog-link`]=de(e.file.path)),h.options={...pe(h.options,h.document,e.args.feedback??e.config.feedback),...n(e.args.kind,h.document,J(e.args.options))};let _=o?.toLowerCase()??`/`,{items:v,store:y,specType:b}=await t({...h,basePath:_,markdownParser:e=>be.compact(O(e))}),x=JSON.stringify({items:w(v),store:w(y),options:h.options,specType:b,basePath:_,title:ke(h.document,e.args.kind,v),metadata:Oe(h.document),[N]:{llms:g}});return{value:await e.createBlobRef(x,{format:`json`}),entityDeps:[...q(e.file.path,[...h.fileDependencies,...d.paths]),...u.entityDeps,...s.entityDeps],assetUsages:u.assetUsages,markdoc:{tagSet:m},linkRefs:u.linkRefs,problems:u.problems}},{async searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let n=T(e);if(n.specType===`grpc`)return{docs:[]};let r=await $(t.entities,t.route.originFilePath),d={...t.route.metadata,...p(n.metadata)?n.metadata:{}},{category:f,isInvalid:m}=u(d),{facets:h,invalidFields:g}=c({[i]:t.route.metadata.title,[a]:t.route.metadata.version,...d},s(t.config)),{buildApiDocsSearchDocuments:_}=await import(`./server/search-documents.js`);return{..._(n,r,{groupKey:f,facets:h,warn:e=>t.logger?.warn(e)}),problems:l([...g,...m?[o]:[]],t.route.originFilePath)}},async markdown(e,t){if(t.route===void 0)return null;let n=T(e);if(n.specType===`grpc`)return null;let r=t.route.originFilePath??void 0,i=await $(t.entities,r),{tags:a}=await h(m,t.config),{buildApiDocsMarkdownCopies:o}=await import(`./server/markdown-copy.js`);return o(n,De(i,n[N]?.llms),{originFilePath:r,markdown:{tags:a,locale:I(t)},warn:e=>t.logger?.warn(e)})},usesProjectMarkdocSchema:!0}),H=t(ne,async e=>{let t=W(e),n=await e.io.readFile(t.absolutePath),r=U(e.contentDir),i=await L({kind:e.args.kind,source:n,relativePath:t.relativePath,contentDir:e.contentDir,bundle:G(e.args,r),metadata:J(e.args.options),io:e.io}),a=e.args.kind===x,o=a?n:JSON.stringify(i.document);return{value:o.length>65536?await e.createBlobRef(o,{format:a?`text`:`json`}):a?n:i.document,metadata:{...X(e.file.path,e.args.kind,e.args.options,e.args.rbac),...Te(i.document,e.routes.byFilePath(e.file.path)?.slug)},entityDeps:q(e.file.path,[...i.fileDependencies,...r.paths]),problems:i.problems}});function U(e){let t=P(e)?.lintPlugins??[];return{plugins:t,paths:t.map(t=>f(ye(e,t.path))).filter(e=>e!==``&&!e.startsWith(`../`))}}function W(e){let t=e.args.source?.path??e.file.path;return{relativePath:t,absolutePath:ve(e.contentDir,t)}}function we(e){let t=e[F];return p(t)&&typeof t.root==`string`?t.root:void 0}function G(e,t){let{config:n,configDir:r}=e.bundleConfig??{config:{},configDir:``};return{config:n,configDir:r,plugins:t.plugins}}function Te(e,t){let n=p(e)&&p(e.info)?e.info:{},r=p(n[`x-metadata`])?n[`x-metadata`]:{},i=typeof n.description==`string`?n.description.trim():``;return{...t===void 0?{}:{routeSlug:t},...Z(n.version)?{version:String(n.version)}:{},...typeof r.apiId==`string`?{apiId:r.apiId}:{},description:i||void 0}}const K=t(oe,async e=>{let{buildNavItems:t,collectPreviousRouteSlugs:n}=await import(`@redocly/api-docs/server`),r=await e.entities.load(k(e.file.path)),i=e.args.kind===`graphql`?(await import(`graphql`)).parse(r):r,a=M(i,e.args.kind,{warn:t=>e.logger?.warn(t)}),{items:o}=await t({type:e.args.kind,document:a,options:e.args.options,basePath:`/`,markdownParser:O}),s=he(o),c=n(o).map(({from:e})=>ge(e));return{value:s,targetInventories:[{kind:`subpath`,exhaustive:!0,targets:[...z(s),...c]}]}});function q(e,t){return[{kind:`file`,path:e},...t.map(e=>({kind:`file`,path:e}))]}const Ee={arazzo:`Arazzo Docs`,asyncapi:`AsyncAPI Docs`,graphql:`GraphQL Docs`,grpc:`gRPC Docs`,openapi:`OpenAPI Docs`};function De(e,t){if(t===void 0||!p(e))return e;let n=p(e.info)?e.info:{},r=p(e.components)?e.components:{};return{...e,...t.infoDescription===void 0?{}:{info:{...n,description:t.infoDescription}},...t.servers===void 0?{}:{servers:t.servers},...t.securitySchemes===void 0?{}:{components:{...r,securitySchemes:t.securitySchemes}}}}function Oe(e){let t=p(e)&&p(e.info)?e.info:{};return p(t[`x-metadata`])?t[`x-metadata`]:{}}function ke(e,t,n){let r=p(e)&&p(e.info)?e.info:{};if(typeof r.title==`string`&&r.title!==``)return r.title;let i=p(n[0])?n[0].label:void 0;return typeof i==`string`&&i!==``?i:Ee[t]}const Ae=[`rbac`,`sidebar`,`excludeFromSearch`,`template`];function je(e,t){let n=p(e.manifest.info)?e.manifest.info:{},r={};typeof n.title==`string`&&(r.title=n.title),Z(n.version)&&(r.version=String(n.version)),typeof n.summary==`string`&&(r.summary=n.summary),p(n[`x-metadata`])&&Object.assign(r,n[`x-metadata`]),p(t.metadata)&&Object.assign(r,t.metadata);for(let e of Ae)delete r[e];return r}function J(e){return p(e.metadata)?e.metadata:void 0}function Y(e){let t=J(e)?.title;return typeof t==`string`&&t.length>0?t:void 0}function X(e,t,n,r){let i=Y(n);return{specType:t,sourcePath:e,...i===void 0?{}:{title:i},...r===void 0?{}:{rbac:r},...Object.keys(n).length>0?{options:n}:{},...p(n.mockServer)?{mockServer:n.mockServer}:{}}}function Z(e){return typeof e==`string`||typeof e==`number`}function Me(e){if(e.ext===`.gql`||e.ext===`.graphql`)return x;let{openapi:t,swagger:n,asyncapi:r,arazzo:i}=e.manifest;return Z(t)||Z(n)?C:Z(r)?b:Z(i)?y:null}async function Ne(e,t){return t.config.grpcDocsEnabled===!0&&_e(await t.io.readFile(e.path))?S:null}const Pe=e({id:re,version:`0.51.0`,content:{filter:{extensions:Se},async extractFile(e,t){if(g.test(e.path))return null;let n=e.ext===`.proto`?await Ne(e,t):Me(e);if(n===null)return null;if(n!==`arazzo`&&n!==`grpc`&&!d(t.config,n))return{routes:[],problems:[_(`${Ce[n]} documents`)]};let r=e.path,i=we(e.manifest),a=i??r,{rbac:o,...s}=await le(t.io,t.config,r,n,a),c={filePath:r,kind:n,options:s,...o===void 0||!d(t.config,`rbac`)?{}:{rbac:o}};i!==void 0&&(c.source={path:i});let l=await ue(t.io,t.config,a);if(l!==void 0&&(c.feedback=l),n!==`graphql`&&n!==`grpc`){let e=await ce(t.io,t.config,r,a);Object.keys(e.config).length>0&&(c.bundleConfig=e)}let u=H.withArgs(c,{stableKey:k(r),type:`api`,metadata:X(r,n,s,c.rbac)});if(n===`arazzo`)return{routes:[],entities:[u]};let f=je(e,s);s.excludeFromSearch===!0&&(f.excludeFromSearch=!0),f.type=n,c.rbac!==void 0&&(f.rbac=c.rbac);let p=V.withArgs(c,{stableKey:`api-docs:render:${r}`}),m=K.withArgs(c,{stableKey:`api-docs:sidebar:${r}`}),h=v(r);return{routes:[{deps:{[ie]:p},metadata:f,routeId:`page`,sidebarSubtree:m,slug:null,slugHint:h,template:A,wildcardPrefix:!0}],entities:[u,p,m]}}},loaders:[H,V,K],templates:{[A]:r(n(`./client/template.tsx`,import.meta.url))},server:{routes:[Q(j.bundle,`bundle`),Q(j.deprecatedBundle,`bundle`),Q(j.graphql,`graphql`)]}});function Q(e,t){return{method:`GET`,path:e+se,handler:{filePath:`./server/spec-download.ts`,importer:import.meta.url,exportName:t}}}async function $(e,t){if(t)try{return await e.load(k(t))}catch{return}}export{Pe as apiDocsContentPlugin};
|
|
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{runtimeTemplate as r}from"../../templates.js";import{SEARCH_API_TITLE_FACET_FIELD as i,SEARCH_API_VERSION_FACET_FIELD as a,SEARCH_GROUP_FACET_FIELD as o}from"../../../../shared/search/facets.js";import{configuredFacetFields as s,extractFacetsFromFrontmatter as c,invalidFacetValueProblems as l,searchCategoryOf as u}from"../../../search/facet-values.js";import{isPlanFeatureGranted as d}from"../../../../shared/plan-gates.js";import{toPosixPath as f}from"../../../../shared/utils/to-posix-path.js";import{isObject as p}from"../../../../shared/utils/is-object.js";import{API_DOCS_MARKDOC_TAG_SET as m,resolveMarkdocTagSet as h}from"../../../markdown/constants/tag-sets.js";import{TRANSLATIONS_FILE_PATTERN as g}from"../../../../shared/constants/l10n/defaults.js";import{slugifySegment as _}from"../../../../shared/utils/routes/slugify-segment.js";import{notInPlanProblem as v}from"../../../plan-gates.js";import{filePathToRouteSlug as y}from"../../../../shared/utils/routes/file-path-to-route-slug.js";import{SPEC_KIND_ARAZZO as b,SPEC_KIND_ASYNCAPI as x,SPEC_KIND_GRAPHQL as S,SPEC_KIND_GRPC as C,SPEC_KIND_OPENAPI as w}from"../../../../shared/constants/api-spec-kinds.js";import{packMarkdocAstsDeep as T,unpackMarkdocAstsDeep as E}from"../../../../shared/utils/packed-ast.js";import{findVersionFolder as D}from"../../utils/version-path.js";import{toPublicVersionedSlug as O}from"../../../../shared/constants/versions.js";import{readVersionsYaml as ee,versionsYamlPath as te}from"../../../versions/version-groups.js";import{parseMarkdownCached as k}from"../../../markdown/utils/parse-cache.js";import{createApiEntityKey as A}from"../../utils/api-entity-key.js";import{API_DOCS_API_LOADER_ID as ne,API_DOCS_PLUGIN_ID as re,API_DOCS_RENDER_DEP_KEY as ie,API_DOCS_RENDER_LOADER_ID as ae,API_DOCS_SIDEBAR_LOADER_ID as oe,API_DOCS_TEMPLATE_ID as j,SPEC_DOWNLOAD_ROUTE_PATHS as M,SPEC_PATH_PARAM as se}from"./server/shared.js";import{resolveApiBundleConfig as ce,resolveApiOptions as le,resolveNestedFeedback as ue,schemaCatalogLink as de,withDownloadUrls as fe,withFeedbackOption as pe,withMockServerOption as me}from"./server/options.js";import{annotateApiDocsRbac as N}from"../../../../shared/rbac/api-docs.js";import{SERVER_ONLY_VALUE_KEY as P}from"../../../loaders/server-only-value.js";import{getLoadedProjectPlugins as F}from"../../project/loaded-set.js";import{API_OUTPUT_MANIFEST_KEY as I}from"../../../api-outputs.js";import{pageLocale as L}from"../../utils/page-locale.js";import{buildBundledApiDefinition as R,resolveLlmsDescriptions as z}from"./server/build-definition.js";import{collectSidebarSubpathTargets as he,toSidebarSubtree as ge,toSubpathTarget as _e}from"./server/build-sidebar.js";import{declaresProtoService as ve}from"./server/declares-proto-service.js";import{join as ye,relative as be,resolve as B}from"node:path";import xe from"@redocly/markdoc";async function Se(e,t){let n=t.originFilePath===null?null:D(t.originFilePath);if(n===null||t.version===null||t.versionGroup===null)return{slug:t.slug,entityDeps:[]};let r=await ee({io:{exists:t=>e.io.exists(B(e.contentDir,t)),readFile:t=>e.io.readFile(B(e.contentDir,t))},directory:n.parent}),i=typeof r?.default==`string`&&_(r.default)===t.version;return{slug:O(t.slug,t.versionGroup,t.version,i),entityDeps:[{kind:`file`,path:te(n.parent)}]}}const Ce=[`.yaml`,`.yml`,`.json`,`.gql`,`.graphql`,`.proto`],we={[w]:`OpenAPI`,[x]:`AsyncAPI`,[S]:`GraphQL`,[b]:`Arazzo`,[C]:`gRPC`},V=t(ae,async e=>{let{buildItems:t,descriptionOptions:n}=await import(`@redocly/api-docs/server`),r=W(e),i=await e.io.readFile(r.absolutePath),a=e.routes.byFilePath(e.file.path),o=a?.slug,s=a&&e.args.kind===`openapi`?await Se(e,a):{slug:void 0,entityDeps:[]},c=fe(e.args.options,e.file.path,e.args.kind),l=e.args.kind===`openapi`?me(c,e.config,s.slug):c,u={entityDeps:[],assetUsages:[],linkRefs:[],problems:[],pending:[]},d=U(e.contentDir),f={markdown:e.markdown,loader:{config:e.config,entities:e.entities,file:e.file,io:e.io,logger:e.logger,plugin:e.plugin},sink:u},h=await R({kind:e.args.kind,source:i,relativePath:r.relativePath,contentDir:e.contentDir,pagePath:e.file.path,options:l,importPaths:e.args.importPaths,bundle:G(e.args,d),metadata:Y(e.args.options),io:e.io,markdownResolution:f,rbac:{warn:t=>e.logger?.warn(t)}}),g={...p(h.document)&&p(h.document.info)?{infoDescription:h.document.info.description}:{},...await z(h.document,f,{contentDir:e.contentDir,specPath:r.relativePath,pagePath:e.file.path})};e.args.kind===`openapi`&&l.showSchemaCatalogLinks&&p(h.document)&&(h.document[`x-schema-catalog-link`]=de(e.file.path)),h.options={...pe(h.options,h.document,e.args.feedback??e.config.feedback),...n(e.args.kind,h.document,Y(e.args.options))};let _=o?.toLowerCase()??`/`,{items:v,store:y,specType:b}=await t({...h,basePath:_,markdownParser:e=>xe.compact(k(e))}),x=JSON.stringify({items:T(v),store:T(y),options:h.options,specType:b,basePath:_,title:Ae(h.document,e.args.kind,v),metadata:ke(h.document),[P]:{llms:g}});return{value:await e.createBlobRef(x,{format:`json`}),entityDeps:[...q(e.file.path,[...h.fileDependencies,...d.paths]),...u.entityDeps,...s.entityDeps],assetUsages:u.assetUsages,markdoc:{tagSet:m},linkRefs:u.linkRefs,problems:u.problems}},{async searchable(e,t){if(t.route===void 0||t.route.metadata.excludeFromSearch===!0)return{docs:[]};let n=E(e);if(n.specType===`grpc`)return{docs:[]};let r=await $(t.entities,t.route.originFilePath),d={...t.route.metadata,...p(n.metadata)?n.metadata:{}},{category:f,isInvalid:m}=u(d),{facets:h,invalidFields:g}=c({[i]:t.route.metadata.title,[a]:t.route.metadata.version,...d},s(t.config)),{buildApiDocsSearchDocuments:_}=await import(`./server/search-documents.js`);return{..._(n,r,{groupKey:f,facets:h,warn:e=>t.logger?.warn(e)}),problems:l([...g,...m?[o]:[]],t.route.originFilePath)}},async markdown(e,t){if(t.route===void 0)return null;let n=E(e),r=t.route.originFilePath??void 0,i=await $(t.entities,r),{tags:a}=await h(m,t.config),{buildApiDocsMarkdownCopies:o}=await import(`./server/markdown-copy.js`);return o(n,Oe(i,n[P]?.llms),{originFilePath:r,markdown:{tags:a,locale:L(t)},warn:e=>t.logger?.warn(e)})},usesProjectMarkdocSchema:!0}),H=t(ne,async e=>{let t=W(e),n=await e.io.readFile(t.absolutePath),r=U(e.contentDir),i=await R({kind:e.args.kind,source:n,relativePath:t.relativePath,contentDir:e.contentDir,importPaths:e.args.importPaths,bundle:G(e.args,r),metadata:Y(e.args.options),io:e.io}),a=e.args.kind===S,o=a?n:JSON.stringify(i.document);return{value:o.length>65536?await e.createBlobRef(o,{format:a?`text`:`json`}):a?n:i.document,metadata:{...X(e.file.path,e.args.kind,e.args.options,e.args.rbac),...Ee(i.document,e.routes.byFilePath(e.file.path)?.slug)},entityDeps:q(e.file.path,[...i.fileDependencies,...r.paths]),problems:i.problems}});function U(e){let t=F(e)?.lintPlugins??[];return{plugins:t,paths:t.map(t=>f(be(e,t.path))).filter(e=>e!==``&&!e.startsWith(`../`))}}function W(e){let t=e.args.source?.path??e.file.path;return{relativePath:t,absolutePath:ye(e.contentDir,t)}}function Te(e){let t=e[I];return p(t)&&typeof t.root==`string`?t.root:void 0}function G(e,t){let{config:n,configDir:r}=e.bundleConfig??{config:{},configDir:``};return{config:n,configDir:r,plugins:t.plugins}}function Ee(e,t){let n=p(e)&&p(e.info)?e.info:{},r=p(n[`x-metadata`])?n[`x-metadata`]:{},i=typeof n.description==`string`?n.description.trim():``;return{...t===void 0?{}:{routeSlug:t},...Z(n.version)?{version:String(n.version)}:{},...typeof r.apiId==`string`?{apiId:r.apiId}:{},description:i||void 0}}const K=t(oe,async e=>{let{buildNavItems:t,collectPreviousRouteSlugs:n}=await import(`@redocly/api-docs/server`),r=await e.entities.load(A(e.file.path)),i=e.args.kind===`graphql`?(await import(`graphql`)).parse(r):r,a=N(i,e.args.kind,{warn:t=>e.logger?.warn(t)}),{items:o}=await t({type:e.args.kind,document:a,options:e.args.options,basePath:`/`,markdownParser:k}),s=ge(o),c=n(o).map(({from:e})=>_e(e));return{value:s,targetInventories:[{kind:`subpath`,exhaustive:!0,targets:[...he(s),...c]}]}});function q(e,t){return[{kind:`file`,path:e},...t.map(e=>({kind:`file`,path:e}))]}const De={arazzo:`Arazzo Docs`,asyncapi:`AsyncAPI Docs`,graphql:`GraphQL Docs`,grpc:`gRPC Docs`,openapi:`OpenAPI Docs`};function Oe(e,t){if(t===void 0||!p(e))return e;let n=p(e.info)?e.info:{},r=p(e.components)?e.components:{};return{...e,...t.infoDescription===void 0?{}:{info:{...n,description:t.infoDescription}},...t.servers===void 0?{}:{servers:t.servers},...t.securitySchemes===void 0?{}:{components:{...r,securitySchemes:t.securitySchemes}}}}function ke(e){let t=p(e)&&p(e.info)?e.info:{};return p(t[`x-metadata`])?t[`x-metadata`]:{}}function Ae(e,t,n){let r=p(e)&&p(e.info)?e.info:{};if(typeof r.title==`string`&&r.title!==``)return r.title;let i=p(n[0])?n[0].label:void 0;return typeof i==`string`&&i!==``?i:De[t]}const J=[`rbac`,`sidebar`,`excludeFromSearch`,`template`];function je(e,t){let n=p(e.manifest.info)?e.manifest.info:{},r={};typeof n.title==`string`&&(r.title=n.title),Z(n.version)&&(r.version=String(n.version)),typeof n.summary==`string`&&(r.summary=n.summary),p(n[`x-metadata`])&&Object.assign(r,n[`x-metadata`]),p(t.metadata)&&Object.assign(r,t.metadata);for(let e of J)delete r[e];return r}function Y(e){return p(e.metadata)?e.metadata:void 0}function Me(e){let t=Y(e)?.title;return typeof t==`string`&&t.length>0?t:void 0}function X(e,t,n,r){let i=Me(n);return{specType:t,sourcePath:e,...i===void 0?{}:{title:i},...r===void 0?{}:{rbac:r},...Object.keys(n).length>0?{options:n}:{},...p(n.mockServer)?{mockServer:n.mockServer}:{}}}function Z(e){return typeof e==`string`||typeof e==`number`}function Ne(e){if(e.ext===`.gql`||e.ext===`.graphql`)return S;let{openapi:t,swagger:n,asyncapi:r,arazzo:i}=e.manifest;return Z(t)||Z(n)?w:Z(r)?x:Z(i)?b:null}async function Pe(e,t){return t.config.grpcDocsEnabled===!0&&ve(await t.io.readFile(e.path))?C:null}const Fe=e({id:re,version:`0.54.0`,content:{filter:{extensions:Ce},async extractFile(e,t){if(g.test(e.path))return null;let n=e.ext===`.proto`?await Pe(e,t):Ne(e);if(n===null)return null;if(n!==`arazzo`&&n!==`grpc`&&!d(t.config,n))return{routes:[],problems:[v(`${we[n]} documents`)]};let r=e.path,i=Te(e.manifest),a=i??r,{rbac:o,importPaths:s,...c}=await le(t.io,t.config,r,n,a),l={filePath:r,kind:n,options:c,...o===void 0||!d(t.config,`rbac`)?{}:{rbac:o}};i!==void 0&&(l.source={path:i}),s!==void 0&&(l.importPaths=s);let u=await ue(t.io,t.config,a);if(u!==void 0&&(l.feedback=u),n!==`graphql`&&n!==`grpc`){let e=await ce(t.io,t.config,r,a);Object.keys(e.config).length>0&&(l.bundleConfig=e)}let f=H.withArgs(l,{stableKey:A(r),type:`api`,metadata:X(r,n,c,l.rbac)});if(n===`arazzo`)return{routes:[],entities:[f]};let p=je(e,c);c.excludeFromSearch===!0&&(p.excludeFromSearch=!0),p.type=n,l.rbac!==void 0&&(p.rbac=l.rbac);let m=V.withArgs(l,{stableKey:`api-docs:render:${r}`}),h=K.withArgs(l,{stableKey:`api-docs:sidebar:${r}`}),_=y(r);return{routes:[{deps:{[ie]:m},metadata:p,routeId:`page`,sidebarSubtree:h,slug:null,slugHint:_,template:j,wildcardPrefix:!0}],entities:[f,m,h]}}},loaders:[H,V,K],templates:{[j]:r(n(`./client/template.tsx`,import.meta.url))},server:{routes:[Q(M.bundle,`bundle`),Q(M.deprecatedBundle,`bundle`),Q(M.graphql,`graphql`)]}});function Q(e,t){return{method:`GET`,path:e+se,handler:{filePath:`./server/spec-download.ts`,importer:import.meta.url,exportName:t}}}async function $(e,t){if(t)try{return await e.load(A(t))}catch{return}}export{Fe as apiDocsContentPlugin};
|
|
@@ -61,6 +61,8 @@ export declare function buildBundledApiDefinition(input: {
|
|
|
61
61
|
/** Absolute content root; `relativePath` is relative to it. */
|
|
62
62
|
contentDir: string;
|
|
63
63
|
options?: Record<string, unknown>;
|
|
64
|
+
/** The content-relative folders a grpc import resolves from, before the content root. */
|
|
65
|
+
importPaths?: string[];
|
|
64
66
|
/**
|
|
65
67
|
* When provided, registers the markdown decorator during the bundle walk to collect
|
|
66
68
|
* `description` fields; the async post-bundle pass resolves them and writes back the AST.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{isObject as e}from"../../../../../shared/utils/is-object.js";import{toContainedContentPath as t}from"../../../../ingest/scan.js";import{ProblemError as n}from"../../../../problems/problem-error.js";import{SPEC_KIND_ARAZZO as r,SPEC_KIND_GRPC as i}from"../../../../../shared/constants/api-spec-kinds.js";import{annotateApiDocsRbac as a}from"../../../../../shared/rbac/api-docs.js";import{resolveMarkdownAst as o}from"../../../../markdown/resolve/ast.js";import{PLAIN_DESCRIPTION_SOURCE as s,REALM_MARKDOWN_DECORATOR_KEY as c,REALM_MARKDOWN_DECORATOR_NAME as l,createMarkdownDecoratorPlugin as u}from"./markdown-decorator.js";import{captureSnippet as d,splitSourceLines as f}from"../../../../../shared/utils/capture-snippet.js";import{existsSync as p}from"node:fs";import{join as m}from"node:path";async function h(e){if(e.kind===`grpc`){let{io:t}=e;if(t===void 0)throw Error(`A gRPC definition reads its imports through the loader io.`);return x({...e,io:t})}if(e.kind===`graphql`){let{parse:t}=await import(`graphql`),n;try{n=t(e.source)}catch(t){throw C(e.relativePath,t)}return{type:`graphql`,document:n,relativePath:e.relativePath,options:e.options??{},fileDependencies:[],problems:[]}}let{BaseResolver:t,bundleFromString:n,createConfig:i,getLineColLocation:o}=await import(`@redocly/openapi-core`),s=await w(i,{bundle:e.bundle??{config:{},configDir:``,plugins:[]},specRelativePath:e.relativePath,rootDir:e.contentDir,resolution:e.markdownResolution}),c=y(t,s.resolve,e.contentDir),l;try{l=await n({source:e.source,absoluteRef:m(e.contentDir,e.relativePath),config:s,externalRefResolver:c,dereference:e.kind===r})}catch(t){throw C(e.relativePath,t)}let u=l.bundle.parsed,d=O([...l.fileDependencies,...c.catalogLinkPaths],e.contentDir),f=b(l.problems,o,{contentDir:e.contentDir,specRelativePath:e.relativePath});e.markdownResolution&&await E(e.markdownResolution,e.markdownResolution.sink.pending,e.contentDir,e.pagePath??e.relativePath);let p;try{p=await g(e.kind,u)}catch(t){throw C(e.relativePath,t)}let h=_(p,e.metadata);return{type:e.kind,document:e.rbac?a(h,e.kind,e.rbac):h,relativePath:e.relativePath,options:e.options??{},fileDependencies:d,problems:f}}async function g(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 _(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 v=/^https?:\/\/.*\/_bundle\/(.*\.(?:ya?ml|json))$/u;function y(e,n,r){class i extends e{catalogLinkPaths=/* @__PURE__ */ new Set;resolveExternalRef(e,n){let i=super.resolveExternalRef(e,n),a=v.exec(i)?.[1];if(a===void 0)return i;let o=m(r,a);return t(r,o)===null?i:(this.catalogLinkPaths.add(o),p(o)?o:i)}}return new i(n)}function b(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:d(f(a.source.body),l)}}})}async function x(e){let{parseProto:t}=await import(`@redocly/api-docs/server`),r=/* @__PURE__ */ new Set,a=[],o;try{o=await t({entry:e.relativePath,importPaths:[
|
|
1
|
+
import{isObject as e}from"../../../../../shared/utils/is-object.js";import{toContainedContentPath as t}from"../../../../ingest/scan.js";import{ProblemError as n}from"../../../../problems/problem-error.js";import{SPEC_KIND_ARAZZO as r,SPEC_KIND_GRPC as i}from"../../../../../shared/constants/api-spec-kinds.js";import{annotateApiDocsRbac as a}from"../../../../../shared/rbac/api-docs.js";import{resolveMarkdownAst as o}from"../../../../markdown/resolve/ast.js";import{PLAIN_DESCRIPTION_SOURCE as s,REALM_MARKDOWN_DECORATOR_KEY as c,REALM_MARKDOWN_DECORATOR_NAME as l,createMarkdownDecoratorPlugin as u}from"./markdown-decorator.js";import{captureSnippet as d,splitSourceLines as f}from"../../../../../shared/utils/capture-snippet.js";import{existsSync as p}from"node:fs";import{join as m}from"node:path";async function h(e){if(e.kind===`grpc`){let{io:t}=e;if(t===void 0)throw Error(`A gRPC definition reads its imports through the loader io.`);return x({...e,io:t})}if(e.kind===`graphql`){let{parse:t}=await import(`graphql`),n;try{n=t(e.source)}catch(t){throw C(e.relativePath,t)}return{type:`graphql`,document:n,relativePath:e.relativePath,options:e.options??{},fileDependencies:[],problems:[]}}let{BaseResolver:t,bundleFromString:n,createConfig:i,getLineColLocation:o}=await import(`@redocly/openapi-core`),s=await w(i,{bundle:e.bundle??{config:{},configDir:``,plugins:[]},specRelativePath:e.relativePath,rootDir:e.contentDir,resolution:e.markdownResolution}),c=y(t,s.resolve,e.contentDir),l;try{l=await n({source:e.source,absoluteRef:m(e.contentDir,e.relativePath),config:s,externalRefResolver:c,dereference:e.kind===r})}catch(t){throw C(e.relativePath,t)}let u=l.bundle.parsed,d=O([...l.fileDependencies,...c.catalogLinkPaths],e.contentDir),f=b(l.problems,o,{contentDir:e.contentDir,specRelativePath:e.relativePath});e.markdownResolution&&await E(e.markdownResolution,e.markdownResolution.sink.pending,e.contentDir,e.pagePath??e.relativePath);let p;try{p=await g(e.kind,u)}catch(t){throw C(e.relativePath,t)}let h=_(p,e.metadata);return{type:e.kind,document:e.rbac?a(h,e.kind,e.rbac):h,relativePath:e.relativePath,options:e.options??{},fileDependencies:d,problems:f}}async function g(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 _(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 v=/^https?:\/\/.*\/_bundle\/(.*\.(?:ya?ml|json))$/u;function y(e,n,r){class i extends e{catalogLinkPaths=/* @__PURE__ */ new Set;resolveExternalRef(e,n){let i=super.resolveExternalRef(e,n),a=v.exec(i)?.[1];if(a===void 0)return i;let o=m(r,a);return t(r,o)===null?i:(this.catalogLinkPaths.add(o),p(o)?o:i)}}return new i(n)}function b(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:d(f(a.source.body),l)}}})}async function x(e){let{parseProto:t}=await import(`@redocly/api-docs/server`),r=/* @__PURE__ */ new Set,a=[],o;try{o=await t({entry:e.relativePath,importPaths:[...e.importPaths??[],``],read:async t=>{if(t===e.relativePath)return e.source;r.add(t);let n=m(e.contentDir,t);return await e.io.exists(n)?e.io.readFile(n):void 0},onMissingImport:({file:e,message:t})=>{a.push({code:`spec/bundle-error`,message:t,location:{filePath:e}})}})}catch(t){let r=t instanceof Error&&`file`in t?t.file:void 0,i=typeof r==`string`?r:e.relativePath;throw a.length===0?C(i,t):new n({code:`spec/bundle-error`,message:`${a.map(e=>e.message).join(` `)} ${S(t)}`,location:{filePath:i}})}return{type:i,document:o,relativePath:e.relativePath,options:e.options??{},fileDependencies:[...r].sort(),problems:a}}function S(e){return e instanceof Error?e.message:String(e)}function C(e,t){let r=S(t);return new n({code:`spec/parse-failed`,message:r,location:{filePath:e}})}function w(e,n){let{bundle:r,resolution:i}=n,a=m(n.rootDir,r.configDir,`redocly.yaml`),o={configPath:m(a,`redocly.yaml`)},s=async(t,n)=>{let r=await e(t,n);return r.configPath=a,r},d=r.plugins.map(({plugin:e,path:t})=>({...e,absolutePath:t}));if(i===void 0)return s({...r.config,plugins:d},o);let{sink:f}=i,p=u({specSourcePath:n.specRelativePath,sink:f,toContentRelative:e=>t(n.rootDir,e)});return s({...r.config,plugins:[...d,p],decorators:{...r.config.decorators,[c]:`on`,[l]:`on`}},o)}async function T(t,n,r){if(!e(t))return{};let i=[],a=(t,n)=>{if(!e(t)||!e(n))return;let a=n[s];i.push({read:()=>t.description,sourceFilePath:typeof a==`string`?a:r.specPath,writeBack:e=>{t.description=e}})},o={},c=t.servers;if(Array.isArray(c)||e(c)){o.servers=structuredClone(c);for(let[e,t]of Object.entries(c))a(o.servers[e],t)}let l=e(t.components)?t.components:void 0;if(e(l?.securitySchemes)){let e=l.securitySchemes;o.securitySchemes=structuredClone(e);for(let[t,n]of Object.entries(e))a(o.securitySchemes[t],n)}return await E(n,i,r.contentDir,r.pagePath),o}async function E(e,t,n,r){let{markdown:i,sink:a}=e,s={...e.loader,contentDir:n,markdown:i};await Promise.all(t.map(async e=>{let t=e.read();if(typeof t!=`string`||!i.looksLikeMarkdown(t))return;let{ast:n,entityDeps:c,assetUsages:l,linkRefs:u,problems:d}=await o(t,e.sourceFilePath,{resolverContext:s});a.entityDeps.push(...c),a.assetUsages.push(...l);for(let t of u)t.raw.trim().startsWith(`#`)?a.linkRefs.push(D({...t,target:r})):e.sourceFilePath===r||t.filePath!==void 0?a.linkRefs.push(D(t)):a.linkRefs.push({...D(t),filePath:e.sourceFilePath});for(let e of d)a.problems.push({...e,location:{filePath:r}});e.writeBack(n)}))}function D(e){if(e.range===void 0)return e;let t={...e};return delete t.range,t}function O(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{h as buildBundledApiDefinition,w as createBundleConfig,T as resolveLlmsDescriptions,E as resolvePendingMarkdown};
|
|
@@ -1,23 +1,25 @@
|
|
|
1
|
-
import{isObject as e}from"../../../../../shared/utils/is-object.js";import{headingSlugger as t}from"../../../../markdown/utils/heading-slugger.js";import{RBAC_TEAM_ANONYMOUS as n}from"../../../../../shared/rbac/types.js";import{canView as r,isRbacScope as i,resolveRole as a}from"../../../../../shared/rbac/engine.js";import{filterRbacAnnotatedDocument as o,withoutRemovedRequired as s}from"../../../../../shared/rbac/filter.js";import{parseMarkdownCached as c}from"../../../../markdown/utils/parse-cache.js";import{SPEC_DOWNLOAD_ROUTE_PATHS as l}from"./shared.js";import{annotateApiDocsRbac as u}from"../../../../../shared/rbac/api-docs.js";import{markdocAstToMarkdownChunks as d}from"../../../../markdown/search/to-markdown.js";import{isMarkdocAstNode as f}from"../../../../markdown/server/render.js";import{REDOCLY_TEAMS_RBAC as p}from"@redocly/config";import{JsonPointer as m,buildSpecSlice as h,describeSliceTarget as g,resolveSpecSliceScope as _,sliceCopyIntro as v,wrapSliceForCopy as y}from"@redocly/api-docs/server";const b=1e6;async function x(t,n,r){let i=S(r.markdown),{slice:a,readable:o}=await C(t,n,i,r.warn),s=e(n)&&e(n.info)?n.info:{},c=e(s[`x-metadata`])?s[`x-metadata`]:{},l=typeof s.title==`string`&&s.title!==``?s.title:t.title,u=
|
|
1
|
+
import{isObject as e}from"../../../../../shared/utils/is-object.js";import{headingSlugger as t}from"../../../../markdown/utils/heading-slugger.js";import{RBAC_TEAM_ANONYMOUS as n}from"../../../../../shared/rbac/types.js";import{canView as r,isRbacScope as i,resolveRole as a}from"../../../../../shared/rbac/engine.js";import{filterRbacAnnotatedDocument as o,withoutRemovedRequired as s}from"../../../../../shared/rbac/filter.js";import{parseMarkdownCached as c}from"../../../../markdown/utils/parse-cache.js";import{SPEC_DOWNLOAD_ROUTE_PATHS as l}from"./shared.js";import{annotateApiDocsRbac as u}from"../../../../../shared/rbac/api-docs.js";import{markdocAstToMarkdownChunks as d}from"../../../../markdown/search/to-markdown.js";import{isMarkdocAstNode as f}from"../../../../markdown/server/render.js";import{REDOCLY_TEAMS_RBAC as p}from"@redocly/config";import{JsonPointer as m,buildSpecSlice as h,describeSliceTarget as g,resolveSpecSliceScope as _,sliceCopyIntro as v,wrapSliceForCopy as y}from"@redocly/api-docs/server";const b=1e6;async function x(t,n,r){let i=S(r.markdown),{slice:a,readable:o}=await C(t,n,i,r.warn),s=e(n)&&e(n.info)?n.info:{},c=e(s[`x-metadata`])?s[`x-metadata`]:{},l=typeof s.title==`string`&&s.title!==``?s.title:t.title,u=t.specType===`grpc`?U(E(t.items),i).join(`
|
|
2
2
|
|
|
3
|
-
`)
|
|
3
|
+
`):i(typeof c.description==`string`?c.description:s.description).join(`
|
|
4
4
|
|
|
5
|
-
`)
|
|
6
|
-
|
|
5
|
+
`),d=D(t.specType,r.originFilePath),f=t.items,p=/* @__PURE__ */ new Map,m=e=>{typeof e.link==`string`&&!p.has(e.link)&&W(e)&&p.set(e.link,G(e));for(let t of e.items??[])m(t)};for(let e of f)m(e);let h=/* @__PURE__ */ new Map,v=e=>{let n=_(t.specType,e.content,e.label);n?.kind===`graphql-type`&&typeof e.link==`string`&&h.set(n.name,e.link);for(let t of e.items??[])v(t)};if(t.specType===`graphql`)for(let e of f)v(e);let y=[],b=/* @__PURE__ */ new Set,x=async e=>{let r=e.content?.contentType,c=e.link;if(typeof c==`string`&&r!==void 0&&!b.has(c)){b.add(c);let m=r===`overview`,v=p.has(c)?p.get(c):G(e),x=m?l:e.label??``,S={specType:t.specType,document:n,renderMarkdown:i},C=r===`item`?_(t.specType,e.content,e.label):void 0,E=C===void 0?void 0:await a(C,p.has(c)),D;if(m)D=k({...S,title:x,description:u,info:s,readable:o,download:d,items:f});else if(C!==void 0&&E!==void 0){let e=w(E,{scope:C,title:x,target:g(C,n),specUrl:d,contentKind:T[t.specType]??`yaml`}),r=t.specType===`graphql`?await O(E,h):``;D=[r===``?e:`${e}\n\n${r}`]}else D=[x===``?``:`# ${x}`,...U(e.content?.children??[],i),P(e.items??[],`##`,S)].filter(e=>e!==``);y.push({routeSlug:c,chunks:D,headings:q(D),title:x,description:m?u:void 0,rbacScope:v})}for(let t of e.items??[])await x(t)};for(let e of f)await x(e);return y}function S(e){let t=t=>{let n=K(t)?t:{type:`document`,children:Array.isArray(t)?t:[t]};return d(n,e)};return e=>{if(e==null)return[];if(typeof e!=`string`)return t(e);if(!e.includes(`{%`)){let t=e.trim();return t===``?[]:[t]}return t(c(e))}}async function C(e,t,n,r){let i=e.specType,a=e=>n(e).join(`
|
|
6
|
+
|
|
7
|
+
`);if(i===`graphql`){let e=typeof t==`string`?await H(t,a):void 0;return{slice:t=>h(i,e,t,{maxRefDepth:0}),readable:void 0}}let o=(e,t)=>h(i,e,t,{maxRefDepth:3}),s=V(t,a),c=u(s,e.specType,{warn:r});if(c===s)return{slice:e=>o(s,e),readable:s};let l=F(c);return{slice:(e,t)=>o(t?l:F(B(c,z(e,c))),e),readable:l}}function w(e,t){return e.length<=1e6?y(e,t).trimEnd():`${v(t)}\n\nThe subset is longer than ${b} characters, so it is not included.`}const T={graphql:`graphql`,grpc:`proto`};function E(e){return e.find(e=>e.content?.contentType===`overview`)?.content?.children??[]}function D(e,t){if(t!==void 0&&e!==`grpc`)return`${e===`graphql`?l.graphql:l.bundle}/${t}`}async function O(e,t){let{parse:n,visit:r}=await import(`graphql`),i=n(e,{noLocation:!0}),a=new Set(i.definitions.map(e=>`name`in e?e.name?.value:``)),o=/* @__PURE__ */ new Set;r(i,{NamedType(e){o.add(e.name.value)}});let s=[...o].filter(e=>!a.has(e)&&t.has(e)).map(e=>`- [${e}](${t.get(e)}.md)`);return s.length===0?``:`Types:\n\n${s.join(`
|
|
8
|
+
`)}`}function k(t){let{info:n}=t,r=[`# ${t.title}`,t.description];typeof n.summary==`string`&&r.push(n.summary);let i=[];n.version!==void 0&&n.version!==``&&i.push(`Version: ${String(n.version)}`);let a=e(n.license)?n.license:void 0;typeof a?.name==`string`&&i.push(`License: ${a.name}`);let o=e(n[`x-metadata`])?n[`x-metadata`]:{},s=Object.entries(o).filter(([,e])=>typeof e==`string`||typeof e==`number`).filter(([e,t])=>e!==`description`||typeof t!=`string`).map(([e,t])=>`- ${e}: ${String(t)}`);s.length>0&&i.push(`Metadata:\n${s.join(`
|
|
7
9
|
`)}`),r.push(i.join(`
|
|
8
|
-
`));let c=e(t.readable)?t.readable:{},l=
|
|
10
|
+
`));let c=e(t.readable)?t.readable:{},l=A[t.specType]??`API description`;return[r.filter(e=>e!==``).join(`
|
|
9
11
|
|
|
10
|
-
`),
|
|
12
|
+
`),j(c.servers,t.renderMarkdown),M(c.components,t.renderMarkdown),t.download===void 0?``:`## Download ${l}\n\n[${t.title}](${t.download})`,P(t.items,`##`,t)].filter(e=>e!==``)}const A={openapi:`OpenAPI description`,asyncapi:`AsyncAPI description`,graphql:`GraphQL schema`};function j(t,n){if(!Array.isArray(t)||t.length===0)return``;let r=`## Servers
|
|
11
13
|
|
|
12
14
|
`;for(let i of t){if(!e(i))continue;let t=n(i.description).join(`
|
|
13
15
|
|
|
14
16
|
`);if(t&&(r+=`${t}\n`),r+=`\`\`\`\n${String(i.url??``)}\n\`\`\`\n\n`,e(i.variables)){r+=`Variables:
|
|
15
17
|
`;for(let[t,a]of Object.entries(i.variables)){if(!e(a))continue;let i=n(a.description).join(` `).replace(/\s+/g,` `);r+=`- \`${t}\`${i?`: ${i}`:``}\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+=`
|
|
16
|
-
`}}return r.trim()}function
|
|
18
|
+
`}}return r.trim()}function M(t,n){let r=e(t)&&e(t.securitySchemes)?t.securitySchemes:void 0;if(r===void 0)return``;let i=`## Security
|
|
17
19
|
|
|
18
20
|
`;for(let[t,a]of Object.entries(r)){if(!e(a)||`$ref`in a)continue;i+=`### ${t}\n\n`;let r=n(a.description).join(`
|
|
19
21
|
|
|
20
|
-
`);r&&(i+=`${r}\n\n`);for(let[e,t]of
|
|
22
|
+
`);r&&(i+=`${r}\n\n`);for(let[e,t]of N)typeof a[t]==`string`&&a[t]&&(i+=`${e}: ${a[t]}\n`);let o=e(a.flows)?a.flows:{},s=[o.implicit,o.password,o.clientCredentials,o.authorizationCode].find(e);if(s!==void 0&&(typeof s.authorizationUrl==`string`&&(i+=`Authorization URL: ${s.authorizationUrl}\n`),typeof s.tokenUrl==`string`&&(i+=`Token URL: ${s.tokenUrl}\n`),e(s.scopes))){i+=`Scopes:
|
|
21
23
|
`;for(let[e,t]of Object.entries(s.scopes))i+=`- \`${e}\`: ${String(t)}\n`}i+=`
|
|
22
|
-
`}return i.trim()}const
|
|
24
|
+
`}return i.trim()}const N=[[`Type`,`type`],[`In`,`in`],[`Name`,`name`],[`Scheme`,`scheme`],[`Bearer Format`,`bearerFormat`],[`OpenID Connect URL`,`openIdConnectUrl`]];function P(e,t,n){let r=``;for(let i of e)if(W(i)){if(i.content?.contentType===`group`){r+=`${t} ${i.label??``}\n\n`;let e=P(i.items??[],`${t}#`,n);e!==``&&(r+=`${e}\n\n`)}else if(i.content?.contentType===`item`&&typeof i.link==`string`){let e=_(n.specType,i.content,i.label),t=(e===void 0?void 0:g(e,n.document))??i.label??``,a=U(i.content.children??[],n.renderMarkdown).join(` `).replace(/\s+/g,` `).trim();r+=`- [${t}](${i.link}.md)${a?`: ${a.slice(0,200)}`:``}\n`}}return r.trim()}function F(e){return L(o(e,[n]),e)}const I=Symbol(`removed`);function L(t,n){let r=/* @__PURE__ */ new Map,i=a=>{let o=r.get(a);if(o!==void 0)return o;let s=R(t,a),c=s===void 0?R(n,a)!==void 0:e(s)&&typeof s.$ref==`string`&&i(s.$ref);return r.set(a,c),c},a=t=>{if(Array.isArray(t))return t.map(a).filter(e=>e!==I);if(!e(t))return t;if(typeof t.$ref==`string`&&i(t.$ref))return I;let n={};for(let[e,r]of Object.entries(t)){let t=a(r);t!==I&&(n[e]=t)}return s(t,n)},o=a(t);return o===I?void 0:o}function R(t,n){if(!n.startsWith(`#/`))return;let r=t;for(let t of m.parse(n)){if(!(e(r)||Array.isArray(r))||!Object.hasOwn(r,t))return;r=r[t]}return r}function z(t,n){switch(t.kind){case`operation`:{let r=e(n)&&n[`x-webhooks`]?`x-webhooks`:`webhooks`;return[t.source===`webhooks`?r:`paths`,t.pathName,t.httpVerb]}case`schema`:return[`components`,`schemas`,t.name];case`channel`:return[`channels`,t.channelId];case`async-operation`:return[`operations`,t.operationId];default:return[]}}function B(t,n){let[r,...i]=n;if(r===void 0){if(!e(t))return t;let n={...t};return delete n[p],n}return!e(t)||!Object.hasOwn(t,r)?t:{...t,[r]:B(t[r],i)}}function V(t,n,r=!1){if(Array.isArray(t)){let e=t.map(e=>V(e,n));return e.some((e,n)=>e!==t[n])?e:t}if(!e(t))return t;let i;for(let[e,a]of Object.entries(t)){let o=(r||e===`description`||e===`summary`||e===`x-summary`)&&(typeof a==`string`?a.includes(`{%`):f(a))?n(a):V(a,n,e===`x-enumDescriptions`);o!==a&&((i??={...t})[e]=o)}return i??t}async function H(e,t){if(!e.includes(`{%`))return e;let{parse:n,print:r,visit:i}=await import(`graphql`);return r(i(n(e,{noLocation:!0}),{enter(e){let n=`description`in e?e.description:void 0;if(n?.value.includes(`{%`))return{...e,description:{...n,value:t(n.value)}}}}))}function U(e,t){let n=[],r=e=>{if(W(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 W(e){let t=G(e);return t===void 0||r(a(t,[`anonymous`]))}function G(e){let t=e[p];if(t!==void 0)return i(t)?t:{}}function K(t){return e(t)&&t.type===`document`}function q(e){return t.reset(),e.map(e=>{let n=/^#{1,6} +(?! )(.+)$/.exec(e.split(`
|
|
23
25
|
`,1)[0]??``);if(!n)return null;let r=n[1].trim();return{heading:r,anchor:t.slug(r)}})}export{b as MAX_MARKDOWN_SLICE_LENGTH,x as buildApiDocsMarkdownCopies};
|
|
@@ -4,7 +4,7 @@ import type { PluginIO } from '../../../types/io.js';
|
|
|
4
4
|
import type { JsonObject } from '../../../../database/schema.js';
|
|
5
5
|
/**
|
|
6
6
|
* The api options one config supplies for `filePath`, plus the entry's `rbac`;
|
|
7
|
-
* `configDir` anchors `apis.*.root`.
|
|
7
|
+
* `configDir` anchors `apis.*.root` and `grpc.importPaths`.
|
|
8
8
|
*/
|
|
9
9
|
export declare function readApiOptionsFromConfig(config: Pick<NestedConfig, 'apis'>, filePath: string, configDir?: string): Record<string, unknown>;
|
|
10
10
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{isPlanFeatureGranted as e}from"../../../../../shared/plan-gates.js";import{toPosixPath as t}from"../../../../../shared/utils/to-posix-path.js";import{isObject as n}from"../../../../../shared/utils/is-object.js";import{isMissingError as r}from"../../../../../shared/utils/is-missing-error.js";import{NESTED_CONFIG_FILENAME as i,deepMergeConfig as a,parseNestedConfig as o}from"../../../../config.js";import{contentIgnoreMatcherOf as
|
|
1
|
+
import{isPlanFeatureGranted as e}from"../../../../../shared/plan-gates.js";import{toPosixPath as t}from"../../../../../shared/utils/to-posix-path.js";import{isObject as n}from"../../../../../shared/utils/is-object.js";import{isMissingError as r}from"../../../../../shared/utils/is-missing-error.js";import{NESTED_CONFIG_FILENAME as i,deepMergeConfig as a,parseNestedConfig as o,resolveGrpcImportPaths as s}from"../../../../config.js";import{contentIgnoreMatcherOf as c}from"../../../../ingest/scan.js";import{SPEC_KIND_GRAPHQL as l}from"../../../../../shared/constants/api-spec-kinds.js";import{MOCK_SERVER_ROUTE_PREFIX as u,mockPathPrefix as d}from"../../../types/api-entity.js";import{withPathPrefix as f}from"../../../../../shared/path-prefix.js";import{SPEC_DOWNLOAD_ROUTE_PATHS as p}from"./shared.js";import{posix as m}from"node:path";import{FEEDBACK_TYPES as h}from"@redocly/theme/core/constants";import{decoratorTypes as g,preprocessorTypes as _}from"@redocly/config";const v=[`openapi`,`asyncapi`,`graphql`,`grpc`];function y(e,t,n){let r=k(t),i=Object.values(e.apis??{}),a=e=>k(m.join(n,e))===r;return i.find(e=>e.output!==void 0&&a(e.output))??i.find(e=>e.output===void 0&&a(e.root))}function b(e,t,n=``){let r=y(e,t,n);if(!r)return{};let i={};r.metadata&&(i.metadata=r.metadata);for(let e of v)r[e]&&typeof r[e]==`object`&&Object.assign(i,r[e]);return r.grpc?.importPaths!==void 0&&(i.importPaths=s(r.grpc.importPaths,n).folders),r.rbac!==void 0&&(i.rbac=r.rbac),i}async function x(e,t,n,r,i=n){let o=E(t,r,``),s=await T(e,i,c(t));return s===null?a(o,b(t,n)):a(a(o,D(s.config,r,s.dir)),b(s.config,n,s.dir))}const S=[...g,..._];async function C(e,t,r,i=r){let o=await T(e,i,c(t)),s=o===null?[t,y(t,r,``)]:[t,o.config,y(o.config,r,o.dir)],l={};for(let e of s){if(!n(e))continue;let t={};for(let r of S)n(e[r])&&(t[r]=e[r]);l=a(l,t)}return{config:l,configDir:o?.dir??``}}async function w(e,t,n){return(await T(e,n,c(t)))?.config.feedback}async function T(e,t,n){for(let r=m.dirname(t);r!==`.`&&r!==`/`;r=m.dirname(r)){let t=m.join(r,i);if(n(t))continue;let a=await O(e,t);if(a!==null)return{config:a,dir:r}}return null}function E(e,t,n){if(t===`arazzo`)return{};let r=e[t]??{};return t===`grpc`&&e.grpc?.importPaths!==void 0?{...r,importPaths:s(e.grpc.importPaths,n).folders}:r}function D(e,t,n){let r={...E(e,t,n)};return e.mockServer&&(r.mockServer=e.mockServer),r}async function O(e,t){let n;try{n=await e.readFile(t)}catch(e){if(r(e))return null;throw e}return o(n,t).config}function k(e){return m.normalize(t(e)).replace(/^\.\/+/,``).replace(/^\/+/,``)}function A(t,r,i){let a=n(t.mockServer)?t.mockServer:{},o={...r.mockServer,...a};if(i===void 0||o.off===!0||!e(r,`mockServer`))return t;let s=f(u+d(i));return{...t,mockServer:{url:s,position:`first`,description:`Mock server`,...o}}}function j(e,t,n){if(n===`grpc`)return e;let r=e=>e.split(`/`).map(encodeURIComponent).join(`/`),i=n===l,a=i?p.graphql:p.bundle,o=(i?[t]:[`.json`,`.yaml`].map(e=>t.replace(/\.[^./]+$/u,e))).map(e=>({url:f(`${a}/${r(e)}?download`),title:m.basename(e)}));return{...e,downloadUrls:Array.isArray(e.downloadUrls)?e.downloadUrls:o,replayDefinitionUrl:o[0]?.url}}function M(e){return f(`${p.bundle}/${e}`)}const N={[h.RATING]:`Rate this section`,[h.SENTIMENT]:`Was this section helpful?`,[h.MOOD]:`Was this section helpful?`,[h.COMMENT]:`Share your feedback about this section`,[h.SCALE]:`How would you rate this section?`};function P(e,t,r){let i=[n(t)?t[`x-feedback`]:void 0,e.feedback,r].find(n);if(i===void 0)return e;let a=n(i.settings)?i.settings:{},o=typeof i.type==`string`?N[i.type]:void 0,s=a.label||o||``;return{...e,feedback:{...i,settings:{...a,label:s}}}}export{b as readApiOptionsFromConfig,C as resolveApiBundleConfig,x as resolveApiOptions,w as resolveNestedFeedback,M as schemaCatalogLink,j as withDownloadUrls,P as withFeedbackOption,A as withMockServerOption};
|
|
@@ -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
|
|
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 m(500,r(e)),e}return 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};
|
|
@@ -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.
|
|
8
|
+
export declare const APP_DATA_PLUGIN_VERSION = "1.35.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 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.
|
|
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.35.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{createServerFn as r}from"../../server-fn.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{runtimeTemplate as a}from"../../templates.js";import{normalizeRouteSlug as o}from"../../../../shared/utils/routes/normalize-route-slug.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as s}from"../sidebar/contributions.js";import{CATALOG_CLASSIC_DEP_KEY as c}from"./client/contract.js";import{catalogEntityKey as l}from"./entity-key.js";import{buildCatalogCards as u,loadVersionGroups as d,pickDefaultVersions as f,resolveCatalogMembers as p}from"./resolve-items.js";import{catalogSidebarContributions as m}from"./sidebars.js";const h=`internal.catalog-classic`,g=`catalog-classic`,_=i(h,`catalog`),v=i(h,`sidebars`),y=i(h,`deliver`),b=t(_,async e=>{let t=p(e.args.items,e),{versionGroups:n,entityDeps:r}=await d(t,e),i=e.args.config.separateVersions?t:f(t,n),a=await u(i,n,e);return{value:{catalogId:e.args.catalogId,config:e.args.config,items:a},entityDeps:r}}),x=t(v,async e=>{let t=p(e.args.items,{routes:e.routes}),{versionGroups:n,entityDeps:r}=await d(t,e);return{value:await m(t,n,{label:e.args.title,link:e.args.slug},e),entityDeps:r}}),S=r(y,{filePath:`./server/deliver.ts`,importer:import.meta.url,exportName:`deliver`,cacheable:!0});function C(e){return Object.entries(e.catalogClassic??e.catalog??{})}const w=e({id:h,version:`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{createServerFn as r}from"../../server-fn.js";import{createPluginScopedId as i}from"../../utils/scoped-id.js";import{runtimeTemplate as a}from"../../templates.js";import{normalizeRouteSlug as o}from"../../../../shared/utils/routes/normalize-route-slug.js";import{SIDEBAR_CONTRIBUTIONS_ENTITY_TYPE as s}from"../sidebar/contributions.js";import{CATALOG_CLASSIC_DEP_KEY as c}from"./client/contract.js";import{catalogEntityKey as l}from"./entity-key.js";import{buildCatalogCards as u,loadVersionGroups as d,pickDefaultVersions as f,resolveCatalogMembers as p}from"./resolve-items.js";import{catalogSidebarContributions as m}from"./sidebars.js";const h=`internal.catalog-classic`,g=`catalog-classic`,_=i(h,`catalog`),v=i(h,`sidebars`),y=i(h,`deliver`),b=t(_,async e=>{let t=p(e.args.items,e),{versionGroups:n,entityDeps:r}=await d(t,e),i=e.args.config.separateVersions?t:f(t,n),a=await u(i,n,e);return{value:{catalogId:e.args.catalogId,config:e.args.config,items:a},entityDeps:r}}),x=t(v,async e=>{let t=p(e.args.items,{routes:e.routes}),{versionGroups:n,entityDeps:r}=await d(t,e);return{value:await m(t,n,{label:e.args.title,link:e.args.slug},e),entityDeps:r}}),S=r(y,{filePath:`./server/deliver.ts`,importer:import.meta.url,exportName:`deliver`,cacheable:!0});function C(e){return Object.entries(e.catalogClassic??e.catalog??{})}const w=e({id:h,version:`1.9.0`,content:{extractAll(e){let t=[],n=[];for(let[r,i]of C(e.config)){let{items:e,...a}=i,u=o(String(i.slug)),d=typeof i.title==`string`?i.title:`API Catalog`;t.push(b.withArgs({catalogId:r,config:a,items:e},{stableKey:l(r),metadata:{sourcePath:u}}),x.withArgs({items:e,slug:u,title:d},{stableKey:`${l(r)}:sidebars`,type:s})),n.push({deps:{[c]:S.withArgs({catalogId:r})},metadata:{title:d},routeId:r,slug:u,template:g})}return{entities:t,routes:n}}},loaders:[b,x],server:{functions:[S]},templates:{[g]:a(n(`./client/template.tsx`,import.meta.url))}});export{_ as CATALOG_CLASSIC_LOADER_ID,h as CATALOG_CLASSIC_PLUGIN_ID,y as CATALOG_CLASSIC_SERVER_FN_ID,v as CATALOG_CLASSIC_SIDEBARS_LOADER_ID,g as CATALOG_CLASSIC_TEMPLATE_ID,w as catalogClassicContentPlugin};
|
|
@@ -12,14 +12,15 @@ export declare const MCP_TOKEN_ROUTE = "/_mcp/oauth2/token-portal";
|
|
|
12
12
|
export declare const MCP_CALLBACK_ROUTE = "/_mcp/oauth/callback";
|
|
13
13
|
export declare const EXECUTE_TOOL_NAME = "execute";
|
|
14
14
|
export declare const DISCOVER_TOOL_NAME = "discover";
|
|
15
|
-
export declare const CREATE_ANONYMOUS_SESSION_TOOL_NAME = "
|
|
16
|
-
export declare const MANAGE_API_CREDENTIALS_TOOL_NAME = "
|
|
17
|
-
export declare const REMOVE_API_CREDENTIALS_TOOL_NAME = "
|
|
15
|
+
export declare const CREATE_ANONYMOUS_SESSION_TOOL_NAME = "create-anonymous-session";
|
|
16
|
+
export declare const MANAGE_API_CREDENTIALS_TOOL_NAME = "manage-api-credentials";
|
|
17
|
+
export declare const REMOVE_API_CREDENTIALS_TOOL_NAME = "remove-api-credentials";
|
|
18
18
|
export declare const SUBMIT_FEEDBACK_TOOL_NAME = "submit-feedback";
|
|
19
19
|
export declare const CALL_API_WRITE_TOOL_NAME = "call-api_write";
|
|
20
20
|
export declare const LIST_WORKFLOWS_TOOL_NAME = "list-workflows";
|
|
21
21
|
export declare const GET_WORKFLOW_TOOL_NAME = "get-workflow";
|
|
22
22
|
export declare const RUN_WORKFLOW_TOOL_NAME = "run-workflow";
|
|
23
|
+
export declare const RUN_WORKFLOW_WRITE_TOOL_NAME = "run-workflow_write";
|
|
23
24
|
export declare const MCP_CREDENTIALS_ROUTE = "/mcp/credentials";
|
|
24
25
|
export declare const DEFAULT_MCP_SERVER_NAME = "Docs MCP server";
|
|
25
26
|
export declare const PLACEHOLDER_MCP_SERVER_NAMES: readonly string[];
|
|
@@ -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=`
|
|
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=`create-anonymous-session`,h=`manage-api-credentials`,g=`remove-api-credentials`,_=`submit-feedback`,v=`call-api_write`,y=`list-workflows`,b=`get-workflow`,x=`run-workflow`,S=`run-workflow_write`,C=`/mcp/credentials`,w=`Docs MCP server`,T=[w,`MCP server`],E=`X-Redocly-AI-Metadata`,D=`mcp-tools`,O={readOnlyHint:!0,destructiveHint:!1,openWorldHint:!1},k={readOnlyHint:!1,destructiveHint:!0,idempotentHint:!1,openWorldHint:!0},A={"anthropic/requiresUserInteraction":!0};export{a as A2A_ROUTE,i as AGENT_CARD_ROUTE,E as AI_METADATA_HEADER,v as CALL_API_WRITE_TOOL_NAME,m as CREATE_ANONYMOUS_SESSION_TOOL_NAME,w as DEFAULT_MCP_SERVER_NAME,p as DISCOVER_TOOL_NAME,f as EXECUTE_TOOL_NAME,b as GET_WORKFLOW_TOOL_NAME,y as LIST_WORKFLOWS_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,C 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,D as MCP_TOOLS_ENTITY_TYPE,T as PLACEHOLDER_MCP_SERVER_NAMES,t as PUBLIC_MCP_ROUTE,O as READ_ONLY_ANNOTATIONS,g as REMOVE_API_CREDENTIALS_TOOL_NAME,A as REQUIRES_USER_INTERACTION_META,x as RUN_WORKFLOW_TOOL_NAME,S as RUN_WORKFLOW_WRITE_TOOL_NAME,_ as SUBMIT_FEEDBACK_TOOL_NAME,k 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{CALL_API_WRITE_TOOL_NAME as n,CREATE_ANONYMOUS_SESSION_TOOL_NAME as r,DISCOVER_TOOL_NAME as i,EXECUTE_TOOL_NAME as a,GET_WORKFLOW_TOOL_NAME as o,LIST_WORKFLOWS_TOOL_NAME as s,MANAGE_API_CREDENTIALS_TOOL_NAME as c,MCP_TOOLS_ENTITY_TYPE as l,REMOVE_API_CREDENTIALS_TOOL_NAME as u,RUN_WORKFLOW_TOOL_NAME as d,SUBMIT_FEEDBACK_TOOL_NAME as
|
|
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,GET_WORKFLOW_TOOL_NAME as o,LIST_WORKFLOWS_TOOL_NAME as s,MANAGE_API_CREDENTIALS_TOOL_NAME as c,MCP_TOOLS_ENTITY_TYPE as l,REMOVE_API_CREDENTIALS_TOOL_NAME as u,RUN_WORKFLOW_TOOL_NAME as d,RUN_WORKFLOW_WRITE_TOOL_NAME as f,SUBMIT_FEEDBACK_TOOL_NAME as p}from"./constants.js";import{notInPlanProblem as m}from"../../../plan-gates.js";import{MCP_TOOL_NAME_PATTERN as h}from"../../registry.js";import{isMcpHidden as g}from"./server/config-gate.js";import{buildMcpSetupPageRoutes as _}from"./setup-page.js";const v=`@mcp`,y=`mcp/invalid-tool`,b=/\.(ts|js)$/u,x=/\.d\.ts$/u,S=/* @__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`,p,a,i,`describe-tools`,r,c,u,s,o,d,f]);function C(e){return`mcp-tool-file:${e}`}function w(e){if(x.test(e)||!b.test(e))return!1;let t=e.split(`/`),n=t.indexOf(v);return n!==-1&&n<t.length-1}function T(e,t,n){if(!h.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(S.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 E(n){let r=[],i=[];if(g(n.config))return{entities:r,problems:i};if(!t(n.config,`customMcpTools`)){for(let{path:e}of n.files)i.push({...m(`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(b,``),o=T(n,t,a.get(n));if(o!==void 0){i.push({code:y,message:o,location:{filePath:t}});continue}a.set(n,t);let s={name:n,sourcePath:t};r.push(e(s,{stableKey:C(t),type:l,metadata:s}))}return{entities:r,problems:i}}const D={filter:{match:w},extractAll(e){return{routes:_(e.config),entities:[]}}};export{v as MCP_DIR_SEGMENT,y as MCP_TOOL_PROBLEM_CODE,S as RESERVED_MCP_TOOL_NAMES,w as isMcpToolFile,D as mcpContent,C as mcpToolFileEntityKey,E as scanMcpToolFiles};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{runtimeTemplate as r}from"../../templates.js";import{A2A_ROUTE as i,AGENT_CARD_ROUTE as a,MCP_AUTHORIZATION_SERVER_ROUTE as o,MCP_AUTHORIZE_ROUTE as s,MCP_CALLBACK_ROUTE as c,MCP_CREDENTIALS_ROUTE as l,MCP_PROTECTED_RESOURCE_ROUTE as u,MCP_REGISTER_ROUTE as d,MCP_ROUTE as f,MCP_SERVER_CARD_ROUTE as p,MCP_SETUP_TEMPLATE_ID as m,MCP_TOKEN_ROUTE as h,PUBLIC_MCP_ROUTE as g}from"./constants.js";import{collectVersionGroups as _,findVersionedDirectories as v}from"../../../versions/version-groups.js";import{MCP_CREDENTIALS_THEME_ENTITY_KEY as y,MCP_IGNORED_ROUTES_ENTITY_KEY as b}from"../../../../shared/constants/mcp.js";import{buildMcpAppData as x}from"./app-data.js";import{readCredentialsTheme as S}from"./credentials-theme.js";import{mcpContent as C,scanMcpToolFiles as w}from"./content-tools.js";import{collectIgnoredRouteSlugs as T}from"./ignored-routes.js";import{findMcpRedirectConflict as E}from"./redirects.js";function D(e,t,n,r){return{path:e,auth:`manual`,...r?{method:r}:{},handler:{filePath:t,importer:import.meta.url,exportName:n}}}const O=[D(f,`./server/handler.ts`,`mcp`),D(g,`./server/handler.ts`,`mcpPublic`),D(p,`./server/server-card.ts`,`mcpServerCard`,`GET`),D(u,`./server/oauth/discovery.ts`,`oauthProtectedResource`,`GET`),D(o,`./server/oauth/discovery.ts`,`oauthAuthorizationServer`,`GET`),D(d,`./server/oauth/register.ts`,`mcpRegister`,`POST`),D(s,`./server/oauth/authorize.ts`,`mcpAuthorize`,`GET`),D(h,`./server/oauth/token.ts`,`mcpToken`,`POST`),D(c,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(`${c}/*`,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(c,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(`${c}/*`,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(l,`./server/gateway/credentials-handler.ts`,`mcpCredentials`,`ALL`),D(a,`./server/agent-card.ts`,`agentCard`,`GET`),D(i,`./server/agent-card.ts`,`a2a`,`POST`)],k=e({id:`internal.mcp`,version:`1.
|
|
1
|
+
import{defineContentPlugin as e}from"../../define.js";import{createInlineEntity as t}from"../../../loaders/define.js";import{runtimeFile as n}from"../../utils/runtime-file.js";import{runtimeTemplate as r}from"../../templates.js";import{A2A_ROUTE as i,AGENT_CARD_ROUTE as a,MCP_AUTHORIZATION_SERVER_ROUTE as o,MCP_AUTHORIZE_ROUTE as s,MCP_CALLBACK_ROUTE as c,MCP_CREDENTIALS_ROUTE as l,MCP_PROTECTED_RESOURCE_ROUTE as u,MCP_REGISTER_ROUTE as d,MCP_ROUTE as f,MCP_SERVER_CARD_ROUTE as p,MCP_SETUP_TEMPLATE_ID as m,MCP_TOKEN_ROUTE as h,PUBLIC_MCP_ROUTE as g}from"./constants.js";import{collectVersionGroups as _,findVersionedDirectories as v}from"../../../versions/version-groups.js";import{MCP_CREDENTIALS_THEME_ENTITY_KEY as y,MCP_IGNORED_ROUTES_ENTITY_KEY as b}from"../../../../shared/constants/mcp.js";import{buildMcpAppData as x}from"./app-data.js";import{readCredentialsTheme as S}from"./credentials-theme.js";import{mcpContent as C,scanMcpToolFiles as w}from"./content-tools.js";import{collectIgnoredRouteSlugs as T}from"./ignored-routes.js";import{findMcpRedirectConflict as E}from"./redirects.js";function D(e,t,n,r){return{path:e,auth:`manual`,...r?{method:r}:{},handler:{filePath:t,importer:import.meta.url,exportName:n}}}const O=[D(f,`./server/handler.ts`,`mcp`),D(g,`./server/handler.ts`,`mcpPublic`),D(p,`./server/server-card.ts`,`mcpServerCard`,`GET`),D(u,`./server/oauth/discovery.ts`,`oauthProtectedResource`,`GET`),D(o,`./server/oauth/discovery.ts`,`oauthAuthorizationServer`,`GET`),D(d,`./server/oauth/register.ts`,`mcpRegister`,`POST`),D(s,`./server/oauth/authorize.ts`,`mcpAuthorize`,`GET`),D(h,`./server/oauth/token.ts`,`mcpToken`,`POST`),D(c,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(`${c}/*`,`./server/oauth/callback.ts`,`mcpCallback`,`GET`),D(c,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(`${c}/*`,`./server/oauth/callback.ts`,`mcpConsent`,`POST`),D(l,`./server/gateway/credentials-handler.ts`,`mcpCredentials`,`ALL`),D(a,`./server/agent-card.ts`,`agentCard`,`GET`),D(i,`./server/agent-card.ts`,`a2a`,`POST`)],k=e({id:`internal.mcp`,version:`1.11.0`,content:C,server:{routes:O},templates:{[m]:r(n(`./client/template.tsx`,import.meta.url))},async finalize(e){let n=E(e.config.redirects);if(n)throw Error(`Redirect "${n.from}" references the reserved MCP route "${n.route}". Remove it: the MCP endpoints are served by the internal.mcp plugin and a redirect would shadow them.`);let r={mcp:x(e.config)},{entities:i,problems:a}=w(e),o=await S(e.io,e.config.palette,t=>e.logger.debug(t));i.push(t(o,{stableKey:y}));let s=e.config.mcp?.ignore??[];if(s.length===0)return{appData:r,problems:a,entities:i};let c=await _({io:e.io,routes:e.routes,versionedDirectories:v(e.routes.all())}),l=T(e.routes.all(),s,c,e.localeContext);return l.length===0?{appData:r,problems:a,entities:i}:(e.logger.debug(`mcp.ignore: hiding ${l.length} routes from the MCP tools`),i.push(t(l,{stableKey:b})),{appData:r,problems:a,entities:i})}});export{k as mcpContentPlugin};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import"../constants.js";import{isObject as e}from"../../../../../shared/utils/is-object.js";import{
|
|
1
|
+
import"../constants.js";import{isObject as e}from"../../../../../shared/utils/is-object.js";import{waitUntil as t}from"../../../../../server/wait-until.js";import{thrownErrorClass as n}from"./tool-errors.js";import{redactSecretShapes as r}from"./secret-patterns.js";import{maskBodyCredentials as i,maskCodeCredentials as a}from"./code-credentials.js";import{redactSecretsFromString as o}from"./gateway/fetch/redact.js";import{createHash as s}from"node:crypto";function c(e){return{client:e.client,clientVersion:e.clientVersion,requestId:e.requestId,messageId:e.messageId,callerSubject:e.callerSubject,clientIp:e.request.ip??void 0}}const l=`[mcp-audit]`,u=4096;function d(e){return s(`sha256`).update(e,`utf8`).digest(`hex`)}function f(e){if(e.length<=4096)return e;let t=e.slice(0,u),n=t.search(/\s\S*$/),r=n>0?t.slice(0,n):t;return`${r}…[truncated: kept ${r.length} of ${e.length} chars]`}function p(e,t=[]){return r(o(f(e),t))}const m=/(?<=^|[\s('"])(?:file:\/\/\/?|\/)(?:[^\s()/:'"]+\/)+/gm;function h(e){return p(e.replace(m,``))}function g(e){return{sha256:d(e),bytes:Buffer.byteLength(e,`utf8`)}}function _(e){return Object.keys(e??{}).map(e=>e.toLowerCase()).sort().join(`,`)}const v=/* @__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 y(e,t=[],n=[]){let r;try{r=new URL(e)}catch{return p(e,t)}let i=new Set(n.map(e=>e.toLowerCase()));for(let e of[...r.searchParams.keys()]){let t=e.toLowerCase();(v.has(t)||i.has(t))&&r.searchParams.set(e,`redacted`)}return r.username=``,r.password=``,p(r.href,t)}function b(e,t,n){let r=Object.fromEntries(Object.entries(n).filter(([,e])=>e!==void 0&&e!==``));try{e?.info(`${l} ${t}`,r)}catch{}}const x=/(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,S=/(process\s*(?:\.\s*env\b|\[)|globalThis|require\s*\(|__proto__)/;function C(e){let t=[];return S.test(e)&&t.push(`env_probe`),x.test(e)&&t.push(`internal_target`),{sha256:d(e),length:e.length,flags:t.sort().join(`,`)}}function w(e){try{return JSON.stringify(e)??String(e)}catch{return`«[unserializable]»`}}function T(e,{tool:t,mode:n,args:r,result:a,errorClass:o,client:s,clientVersion:c,requestId:l,messageId:u,callerSubject:f,clientIp:m}){if(t===`execute`||t===`call-api_write`)return;let h=w(r),_=a===void 0?void 0:g(a),v=r?.sessionHandle,y=typeof v==`string`&&v!==``?v:void 0,x=f??y;b(e,`Record MCP tool call`,{tool:t,mode:n,server_type:`docs`,error_class:o,client:s,client_version:c,request_id:l,message_id:u,subject_sha256:x?d(x):void 0,client_ip:m,args_sha256:d(h),args:p(i(h),y?[y]:[]),result_sha256:_?.sha256,result_bytes:_?.bytes})}async function E(e,r,i,a){let o={tool:r,mode:e.mcpMode,args:i,...c(e)},s=Date.now(),l;try{l=await a()}catch(i){throw T(e.logger,{...o,errorClass:n(i)}),e.telemetry?.toolThrew(r,Date.now()-s,i),e.telemetry&&t(e.telemetry.flush()),i}let u=O(l)&&l.isError===!0;return T(e.logger,{...o,result:j(l),errorClass:u?`tool_error`:void 0}),e.telemetry?.toolReturned(r,Date.now()-s,l),e.telemetry&&t(e.telemetry.flush()),l}const D=/* @__PURE__ */ new Set([`text`,`image`,`audio`,`resource`,`resource_link`]);function O(t){return e(t)&&Array.isArray(t.content)&&t.content.every(t=>e(t)&&D.has(t.type))}function k(t){return e(t)&&t.resultType===`input_required`}function A(e,t=``){return e.content.map(e=>e.type===`text`?e.text:``).join(t)}function j(e){if(typeof e==`string`)return e;if(O(e))return A(e);if(k(e))return``;try{return JSON.stringify(e)??``}catch{return``}}function M(e,{audit:t,code:n,description:r,sessionHandle:i,toolNames:o,fetchBudget:s,fetchCapable:c,requestId:l,messageId:u,callerSubject:f,clientIp:m}){let h=f??i;b(e,`Record code execution input`,{code_sha256:t.sha256,code_length:t.length,request_id:l,message_id:u,flags:t.flags,subject_sha256:h?d(h):void 0,client_ip:m,description:p(r),tools:[...o].sort().join(`,`),fetch_capable:c,fetch_budget:s,code:p(a(n))})}function N(e,{rawUrl:t,method:n,host:r,outcome:a,durationMs:o,injectedSecretValues:s,credentialQueryParams:c,path:l,api:u,status:f,injectedScheme:m,requestHeaders:h,requestBody:v,responseHeaders:x,responseBody:S,caller:C={}}){let{requestId:w,callerSubject:T,clientIp:E}=C,D=S===void 0?void 0:g(S);b(e,`Record gateway fetch`,{url_sha256:d(t),host:r,method:n,path:l,api:u,outcome:a,status:f,injected_scheme:m,duration_ms:o,request_id:w,subject_sha256:T?d(T):void 0,client_ip:E,url:y(t,s,c),request_header_names:_(h),request_body:v===void 0?void 0:p(i(v),s),response_header_names:_(x),response_sha256:D?.sha256,response_bytes:D?.bytes})}export{u as AUDIT_FIELD_MAX_CHARS,l as AUDIT_LOG_PREFIX,C as auditCode,_ as auditHeaderNames,p as auditInput,d as auditSha256,h as auditStack,E as auditToolCall,y as auditUrl,c as callAttribution,O as isCallToolResult,b as logAuditRecord,M as logCodeExecutionAudit,N as logGatewayFetchAudit,T as logMcpToolCallAudit,j as toolOutputText,A as toolResultText,f as truncateAuditField};
|
|
@@ -1 +1 @@
|
|
|
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
|
|
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,RUN_WORKFLOW_WRITE_TOOL_NAME as o,SUBMIT_FEEDBACK_TOOL_NAME as s}from"../../constants.js";const c=`fetch`,l=/* @__PURE__ */ new Set([r,n,t,i,a,s,e,o]),u=`site`,d=`tools`,f=`__fetchBridge`,p=`fetch`,m=1e4,h=45e3,g=5e4,_=1e3,v=50,y=50,b={ratePerMin:600,quotaPerDay:1e5},x=8388608,S=1048576,C=1048576,w=262144,T=67108864,E=134217728,D=16777216,O=65536,k=2,A=4,j=5e3,M=`The sandbox failed to run this code. The cause was logged on the server.`,N=`HostFunctionError`,P=`HostOutputTooLargeError`,F={NoReturn:`no_return`,OutputTooLarge:`output_too_large`,Timeout:`timeout`,MemoryLimit:`memory_limit`,SyntaxError:`syntax_error`,HostError:`host_error`,RuntimeError:`runtime_error`};export{j as ACQUIRE_TIMEOUT_MS,l as CODE_MODE_TOOL_NAMES,h as DEFAULT_MAX_LIFETIME_MS,m as DEFAULT_TIMEOUT_MS,g as EXECUTE_DEADLINE_MS,p as FETCH_BRIDGE_FUNCTION_NAME,f as FETCH_BRIDGE_GLOBAL_NAME,c as FETCH_TOOL_NAME,y as GATEWAY_FETCH_BUDGET_PER_EXEC,b as GATEWAY_FETCH_LIMITS,N as HOST_FUNCTION_ERROR_NAME,P as HOST_OUTPUT_TOO_LARGE_ERROR_NAME,D as INITIAL_TOTAL_MEMORY_BYTES,M as INTERNAL_ERROR_MESSAGE,T as MAX_ALLOCATION_BYTES,k as MAX_CONCURRENT_RUNS,v as MAX_FETCH_CALLS,S as MAX_FETCH_OUTPUT_BYTES,A as MAX_QUEUED_RUNS,C as MAX_RESULT_BYTES,w as MAX_STACK_SIZE_BYTES,_ as MAX_TOOL_CALLS,x as MAX_TOOL_OUTPUT_BYTES,E as MAX_TOTAL_MEMORY_BYTES,F as SANDBOX_FAILURE,u as SITE_GLOBAL_NAME,d as TOOLS_GLOBAL_ALIAS,O as WASM_PAGE_BYTES};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{EXECUTE_TOOL_NAME as e}from"../../constants.js";import{buildExecuteDescription as t}from"./prompts.js";const n=`Execute code`;function r(e){return e.readOnlyHint?`Query the docs with code`:n}const i={name:e,title:n,description:t(!1),schema:{type:`object`,required:[`code`,`description`],additionalProperties:!1,properties:{code:{type:`string`,description:`JavaScript to run in the sandbox. Return a value to receive it as the result.`,minLength:1},description:{type:`string`,description:`A short, human-readable summary of what this code does.`,minLength:1},sessionHandle:{type:`string`,description
|
|
1
|
+
import{EXECUTE_TOOL_NAME as e}from"../../constants.js";import{buildExecuteDescription as t}from"./prompts.js";const n=`Execute code`;function r(e){return e.readOnlyHint?`Query the docs with code`:n}const i={name:e,title:n,description:t(!1),schema:{type:`object`,required:[`code`,`description`],additionalProperties:!1,properties:{code:{type:`string`,description:`JavaScript to run in the sandbox. Return a value to receive it as the result.`,minLength:1},description:{type:`string`,description:`A short, human-readable summary of what this code does.`,minLength:1},sessionHandle:{type:`string`,description:"Handle returned by `create-anonymous-session`. Required when an API needs credentials. This parameter is only offered when `create-anonymous-session` is available, so pass it whenever you have called that tool.",minLength:1}}}},a={result:{description:`The value the code returned, as JSON`},error:{type:`string`,description:`Why the code failed. Set only on a failed call`}},o={type:`array`,description:"Every `fetch` request that reached an API before the failure, with its status; running the code again sends them again. Set only on a failed call",items:{type:`object`,properties:{method:{type:`string`},url:{type:`string`},status:{type:`number`,description:`Unset when no response arrived`}}}};function s(e){return{type:`object`,properties:e?{...a,sentFetches:o}:a}}export{i as EXECUTE_TOOL_SCHEMA,s as executeOutputSchema,r as executeToolTitle};
|