@redocly/redoc-reef 0.138.0-next.13 → 0.138.0-next.15

package/dist/server/plugins/analytics/gtm/browser-hooks.js

@@ -1 +0,0 @@
-import{onCLS as f,onFID as l,onLCP as p}from"web-vitals";import{envConfig as w}from"../../../config/env-config.js";import{debounce as s}from"../../../../utils/time/debounce.js";const r=new Set,y=(n,a)=>{const e=a?.analytics?.gtm;if(!e||w.NODE_ENV!=="production"&&!e.includeInDevelopment)return;const t=window.redocly?.consent;if(t&&!t.state.analytics){if(e.enableWebVitalsTracking&&!n.prevLocation){const u=t.on("change",m=>{m.analytics&&(u(),d(e.dataLayerName))})}return}e.enableWebVitalsTracking&&!n.prevLocation&&d(e.dataLayerName);const o=e.dataLayerName||"dataLayer",i=window;i[o]=i[o]||[];const c=e.pageViewEventName?e.pageViewEventName:"pageView";i[o].push({event:c})};function d(n="dataLayer"){const a=window;function e(c){r.has(c.name)||(r.add(c.name),L(c,a[n]))}const t=s(e,3e3),o=e,i=s(e,3e3);f(t),l(o),p(i)}function L({name:n,value:a,id:e},t){t.push({event:"core-web-vitals",webVitalsMeasurement:{name:n,id:e,value:Math.round(n==="CLS"?a*1e3:a),nonInteraction:!0}})}export{y as onRouteChange};

package/dist/server/plugins/analytics/gtm/build-scripts.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import type { GtmAnalyticsConfig } from '@redocly/theme/config';
-export declare const buildScripts: (pluginOptions: GtmAnalyticsConfig) => {
-    headComponents: React.JSX.Element[];
-    preBodyComponents: React.JSX.Element[];
-};
-//# sourceMappingURL=build-scripts.d.ts.map

package/dist/server/plugins/analytics/gtm/build-scripts.js

@@ -1,10 +0,0 @@
-import a from"react";const v=n=>{const{trackingId:e,gtmAuth:t,gtmPreview:i,defaultDataLayer:o,dataLayerName:s="dataLayer",enableWebVitalsTracking:u=!1}=n,l=(n.selfHostedOrigin||"https://www.googletagmanager.com").replace(/\/$/,""),c=t&&i?`&gtm_auth=${t}&gtm_preview=${i}&gtm_cookies_win=x`:"";let m="";o&&(m=f(o,s));const r=[];u&&r.push(a.createElement("script",{key:"portal-plugin-google-tagmanager-web-vitals",dangerouslySetInnerHTML:{__html:`
-              !function(){var e,t,n,i,r={passive:!0,capture:!0},a=new Date,o=function(){i=[],t=-1,e=null,f(addEventListener)},c=function(i,r){e||(e=r,t=i,n=new Date,f(removeEventListener),u())},u=function(){if(t>=0&&t<n-a){var r={entryType:"first-input",name:e.type,target:e.target,cancelable:e.cancelable,startTime:e.timeStamp,processingStart:e.timeStamp+t};i.forEach((function(e){e(r)})),i=[]}},s=function(e){if(e.cancelable){var t=(e.timeStamp>1e12?new Date:performance.now())-e.timeStamp;"pointerdown"==e.type?function(e,t){var n=function(){c(e,t),a()},i=function(){a()},a=function(){removeEventListener("pointerup",n,r),removeEventListener("pointercancel",i,r)};addEventListener("pointerup",n,r),addEventListener("pointercancel",i,r)}(t,e):c(t,e)}},f=function(e){["mousedown","keydown","touchstart","pointerdown"].forEach((function(t){return e(t,s,r)}))},p="hidden"===document.visibilityState?0:1/0;addEventListener("visibilitychange",(function e(t){"hidden"===document.visibilityState&&(p=t.timeStamp,removeEventListener("visibilitychange",e,!0))}),!0);o(),self.webVitals={firstInputPolyfill:function(e){i.push(e),u()},resetFirstInputPolyfill:o,get firstHiddenTime(){return p}}}();
-            `}})),r.push(a.createElement("script",{key:"plugin-google-tagmanager",dangerouslySetInnerHTML:{__html:`
-          ${m}
-          ${p({trackingId:e,environmentParamStr:c,dataLayerName:s,selfHostedOrigin:l})}`}}));const d=[a.createElement("noscript",{key:"plugin-google-tagmanager",dangerouslySetInnerHTML:{__html:g({trackingId:e,environmentParamStr:c,selfHostedOrigin:l})}})];return{headComponents:r,preBodyComponents:d}},p=({trackingId:n,environmentParamStr:e,dataLayerName:t,selfHostedOrigin:i})=>`
-  (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
-  new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
-  j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-  '${i}/gtm.js?id='+i+dl+'${e}';f.parentNode.insertBefore(j,f);
-  })(window,document,'script','${t}', '${n}');`,g=({trackingId:n,environmentParamStr:e,selfHostedOrigin:t})=>`<iframe src="${t}/ns.html?id=${n}${e}" height="0" width="0" style="display: none; visibility: hidden" aria-hidden="true"></iframe>`,f=(n,e)=>{let t=`window.${e} = window.${e} || [];`;return t+=`window.${e}.push(${JSON.stringify(n)});`,t};export{v as buildScripts};

package/dist/server/plugins/analytics/gtm/index.d.ts

@@ -1,3 +0,0 @@
-import type { LifecyclePluginInstance } from '../../../types';
-export declare function gtmAnalyticsPlugin(): Promise<LifecyclePluginInstance>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/analytics/gtm/index.js

@@ -1 +0,0 @@
-import{envConfig as a}from"../../../config/env-config.js";import{gateSsrComponents as e}from"../../consent/gate-ssr-components.js";import{buildScripts as c}from"./build-scripts.js";import{resolveBrowserHooksPath as m}from"./resolve-browser-hooks.js";async function u(){return{id:"Google Tag Manager Analytics",requiredEntitlements:["analytics"],async processContent(n,{getConfig:r}){const o=await r(),t=o?.analytics?.gtm;if(!t?.trackingId||!a.isProductionEnv&&!t.includeInDevelopment)return;const{headComponents:s,preBodyComponents:i}=c(t);n.addSsrComponents(e(s,"analytics",o.consent),"head"),n.addSsrComponents(e(i,"analytics",o.consent),"preBody"),n.addBrowserPlugin(m())}}}export{u as gtmAnalyticsPlugin};

package/dist/server/plugins/analytics/gtm/resolve-browser-hooks.d.ts

@@ -1,2 +0,0 @@
-export declare function resolveBrowserHooksPath(): string;
-//# sourceMappingURL=resolve-browser-hooks.d.ts.map

package/dist/server/plugins/analytics/gtm/resolve-browser-hooks.js

@@ -1 +0,0 @@
-import{fromCurrentDir as r}from"../../../utils/index.js";function e(){return r(import.meta.url,"./browser-hooks.js")}export{e as resolveBrowserHooksPath};

package/dist/server/plugins/analytics/heap/browser-hooks.d.ts

@@ -1,3 +0,0 @@
-import type { OnRouteChangeHook } from '../../../types';
-export declare const onRouteChange: OnRouteChangeHook;
-//# sourceMappingURL=browser-hooks.d.ts.map

package/dist/server/plugins/analytics/heap/browser-hooks.js

@@ -1 +0,0 @@
-const h=(r,o)=>{const e=o?.analytics?.heap;if(e?.appId&&!r.prevLocation){const n=window.redocly?.consent;if(n&&!n.state.analytics){const t=n.on("change",a=>{a.analytics&&(t(),i(e.appId))});return}i(e.appId)}};function i(r){window.heap=window.heap||[],window.heap.load=function(o,e){window.heap.appid=o,window.heap.config=e=e||{};let n=e.forceSSL||document.location.protocol==="https:",t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src=(n?"https:":"http:")+"//cdn.heapanalytics.com/js/heap-"+o+".js";let a=document.getElementsByTagName("script")[0];a.parentNode?.insertBefore(t,a);for(let s=function(d){return function(...l){window.heap.push([d].concat(Array.prototype.slice.call(l,0)))}},c=["addEventProperties","addUserProperties","clearEventProperties","identify","resetIdentity","removeEventProperty","setEventProperties","track","unsetEventProperty"],p=0;p<c.length;p++)window.heap[c[p]]=s(c[p])},window.heap.load(r)}export{h as onRouteChange};

package/dist/server/plugins/analytics/heap/index.d.ts

@@ -1,3 +0,0 @@
-import type { LifecyclePluginInstance } from '../../../types';
-export declare function heapAnalyticsPlugin(): Promise<LifecyclePluginInstance>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/analytics/heap/index.js

@@ -1 +0,0 @@
-import{envConfig as t}from"../../../config/env-config.js";import{resolveBrowserHooksPath as e}from"./resolve-browser-hooks.js";async function c(){return{id:"Heap Analytics",requiredEntitlements:["analytics"],async processContent(i,{getConfig:o}){const n=(await o())?.analytics?.heap;!n?.appId||!t.isProductionEnv&&!n.includeInDevelopment||i.addBrowserPlugin(e())}}}export{c as heapAnalyticsPlugin};

package/dist/server/plugins/analytics/heap/resolve-browser-hooks.d.ts

@@ -1,2 +0,0 @@
-export declare function resolveBrowserHooksPath(): string;
-//# sourceMappingURL=resolve-browser-hooks.d.ts.map

package/dist/server/plugins/analytics/heap/resolve-browser-hooks.js

@@ -1 +0,0 @@
-import{fromCurrentDir as r}from"../../../utils/index.js";function e(){return r(import.meta.url,"./browser-hooks.js")}export{e as resolveBrowserHooksPath};

package/dist/server/plugins/analytics/index.d.ts

@@ -1,3 +0,0 @@
-import { amplitudeAnalyticsPlugin } from './amplitude/index.js';
-export declare const analyticsPlugins: (typeof amplitudeAnalyticsPlugin)[];
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/analytics/index.js

@@ -1 +0,0 @@
-import{amplitudeAnalyticsPlugin as i}from"./amplitude/index.js";import{fullstoryAnalyticsPlugin as t}from"./fullstory/index.js";import{heapAnalyticsPlugin as l}from"./heap/index.js";import{rudderstackAnalyticsPlugin as o}from"./rudderstack/index.js";import{segmentAnalyticsPlugin as n}from"./segment/index.js";import{gtmAnalyticsPlugin as r}from"./gtm/index.js";import{googleAnalyticsPlugin as m}from"./ga/index.js";import{adobeAnalyticsPlugin as a}from"./adobe/index.js";const e=[i,t,l,o,n,r,m,a];export{e as analyticsPlugins};

package/dist/server/plugins/analytics/rudderstack/browser-hooks.d.ts

@@ -1,3 +0,0 @@
-import type { OnRouteChangeHook } from '../../../types';
-export declare const onRouteChange: OnRouteChangeHook;
-//# sourceMappingURL=browser-hooks.d.ts.map

package/dist/server/plugins/analytics/rudderstack/browser-hooks.js

@@ -1 +0,0 @@
-const r=(n,i)=>{const d=i?.analytics?.rudderstack;if(!d)return;const{trackPage:t}=d;function e(){t===!0&&window.rudderanalytics?.page(document.title)}window.rudderSnippetLoaded===!1?window.rudderSnippetLoading===!0?window.rudderSnippetLoadedCallback=function(){e()}:n.prevLocation?(window.rudderSnippetLoadedCallback=void 0,window.rudderSnippetLoader(function(){e()})):window.rudderSnippetLoadedCallback=function(){e()}:e()};export{r as onRouteChange};

package/dist/server/plugins/analytics/rudderstack/build-script.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { RudderstackAnalyticsConfig } from '@redocly/theme/config';
-export declare const buildScript: (pluginOptions: RudderstackAnalyticsConfig) => React.JSX.Element;
-//# sourceMappingURL=build-script.d.ts.map

package/dist/server/plugins/analytics/rudderstack/build-script.js

@@ -1,7 +0,0 @@
-import i from"react";const l=e=>{const{writeKey:r,dataPlaneUrl:a="https://hosted.rudderlabs.com",controlPlaneUrl:n,sdkUrl:d="https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js",loadOptions:t={}}=e,s={...t,configUrl:n||t.configUrl},o=`rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}
-        var s = document.createElement("script");
-        s.type = "text/javascript";
-        s.src = "${d}";
-        document.head.appendChild(s);
-        rudderanalytics.load('${r}', '${a}', ${JSON.stringify(s)})
-    `;return i.createElement("script",{key:"plugin-rudderstack",dangerouslySetInnerHTML:{__html:o}})};export{l as buildScript};

package/dist/server/plugins/analytics/rudderstack/index.d.ts

@@ -1,3 +0,0 @@
-import type { LifecyclePluginInstance } from '../../../types';
-export declare function rudderstackAnalyticsPlugin(): Promise<LifecyclePluginInstance>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/analytics/rudderstack/index.js

@@ -1 +0,0 @@
-import{envConfig as e}from"../../../config/env-config.js";import{gateSsrComponents as i}from"../../consent/gate-ssr-components.js";import{buildScript as s}from"./build-script.js";import{resolveBrowserHooksPath as a}from"./resolve-browser-hooks.js";async function m(){return{id:"Rudderstack Analytics",requiredEntitlements:["analytics"],async processContent(t,{getConfig:o}){const r=await o(),n=r?.analytics?.rudderstack;!n?.writeKey||!e.isProductionEnv&&!n.includeInDevelopment||(t.addSsrComponents(i([s(n)],"analytics",r.consent),"head"),t.addBrowserPlugin(a()))}}}export{m as rudderstackAnalyticsPlugin};

package/dist/server/plugins/analytics/rudderstack/resolve-browser-hooks.d.ts

@@ -1,2 +0,0 @@
-export declare function resolveBrowserHooksPath(): string;
-//# sourceMappingURL=resolve-browser-hooks.d.ts.map

package/dist/server/plugins/analytics/rudderstack/resolve-browser-hooks.js

@@ -1 +0,0 @@
-import{fromCurrentDir as r}from"../../../utils/index.js";function e(){return r(import.meta.url,"./browser-hooks.js")}export{e as resolveBrowserHooksPath};

package/dist/server/plugins/analytics/segment/browser-hooks.d.ts

@@ -1,3 +0,0 @@
-import type { OnRouteChangeHook } from '../../../types';
-export declare const onRouteChange: OnRouteChangeHook;
-//# sourceMappingURL=browser-hooks.d.ts.map

package/dist/server/plugins/analytics/segment/browser-hooks.js

@@ -1 +0,0 @@
-const o=(n,t)=>{if(t?.analytics?.segment?.trackPage!==!0)return;function e(){window.segmentPageviewCaller?.(!!n.prevLocation)}window.portalPluginSegmentSnippetLoader?window.portalPluginSegmentSnippetLoader(e):e()};export{o as onRouteChange};

package/dist/server/plugins/analytics/segment/build-script.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { SegmentAnalyticsConfig } from '@redocly/theme/config';
-export declare const buildScript: (pluginOptions: SegmentAnalyticsConfig) => React.JSX.Element;
-//# sourceMappingURL=build-script.d.ts.map

package/dist/server/plugins/analytics/segment/build-script.js

@@ -1,22 +0,0 @@
-import c from"react";const d=n=>{const{writeKey:t,trackPage:a,host:i="https://cdn.segment.io",includeTitleInPageCall:r=!1}=n,l=`(function () {
-        let segmentPageviewCalledAlready = false;
-        window.segmentPageviewCaller = function (force) {
-
-          ${a===!0?"":"return;"}
-        
-          if (!window.analytics) {
-            return
-          }
-          if (segmentPageviewCalledAlready === true && !force) {
-            return
-          }
-          segmentPageviewCalledAlready = true;
-          window.analytics.page(${r?"document.title":""});
-        };
-      })();`;let e=`(function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"];analytics.factory=function(e){return function(){var t=Array.prototype.slice.call(arguments);t.unshift(e);analytics.push(t);return analytics}};for(var e=0;e<analytics.methods.length;e++){var key=analytics.methods[e];analytics[key]=analytics.factory(key)}analytics.load=function(key,e){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.src="${i}/analytics.js/v1/" + key + "/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n);analytics._loadOptions=e};analytics._writeKey="${t}";analytics.SNIPPET_VERSION="4.15.3";
-          analytics.load('${t}');
-        `;a===!0&&(e+="window.segmentPageviewCaller();"),e+="}})();";const s=`
-        (function () {
-          ${l}
-          ${e}
-        })();`;return c.createElement("script",{key:"plugin-segment",dangerouslySetInnerHTML:{__html:s}})};export{d as buildScript};

package/dist/server/plugins/analytics/segment/index.d.ts

@@ -1,3 +0,0 @@
-import type { LifecyclePluginInstance } from '../../../types';
-export declare function segmentAnalyticsPlugin(): Promise<LifecyclePluginInstance>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/analytics/segment/index.js

@@ -1 +0,0 @@
-import{envConfig as i}from"../../../config/env-config.js";import{gateSsrComponents as r}from"../../consent/gate-ssr-components.js";import{buildScript as s}from"./build-script.js";import{resolveBrowserHooksPath as a}from"./resolve-browser-hooks.js";async function d(){return{id:"Segment Analytics",requiredEntitlements:["analytics"],async processContent(t,{getConfig:o}){const e=await o(),n=e?.analytics?.segment;!n?.writeKey||!i.isProductionEnv&&!n.includeInDevelopment||(t.addSsrComponents(r([s(n)],"analytics",e.consent),"head"),t.addBrowserPlugin(a()))}}}export{d as segmentAnalyticsPlugin};

package/dist/server/plugins/analytics/segment/resolve-browser-hooks.d.ts

@@ -1,2 +0,0 @@
-export declare function resolveBrowserHooksPath(): string;
-//# sourceMappingURL=resolve-browser-hooks.d.ts.map

package/dist/server/plugins/analytics/segment/resolve-browser-hooks.js

@@ -1 +0,0 @@
-import{fromCurrentDir as r}from"../../../utils/index.js";function e(){return r(import.meta.url,"./browser-hooks.js")}export{e as resolveBrowserHooksPath};

package/dist/server/plugins/api-docs/get-server-props.d.ts

@@ -1,4 +0,0 @@
-import type { GetServerPropsFn } from '../../types';
-declare const getServerProps: GetServerPropsFn;
-export default getServerProps;
-//# sourceMappingURL=get-server-props.d.ts.map

package/dist/server/plugins/api-docs/get-server-props.js

@@ -1 +0,0 @@
-import{getPublicEnvVariables as n}from"../../utils/envs/get-public-env-variables.js";const l=async({fsPath:r,slug:e},t,{partials:a,variables:i},o)=>{const s=o.getPartialsForRoute?.(e)||a;return{definitionId:r,...t.props,markdown:{partials:s,variables:{...i,env:n()}}}};var d=l;export{d as default};

package/dist/server/plugins/api-docs/get-template-path.d.ts

@@ -1,2 +0,0 @@
-export declare function getTemplatePath(relativePath: string): string;
-//# sourceMappingURL=get-template-path.d.ts.map

package/dist/server/plugins/api-docs/get-template-path.js

@@ -1 +0,0 @@
-import{fromCurrentDir as t}from"../../utils/paths.js";function m(r){return t(import.meta.url,r)}export{m as getTemplatePath};

package/dist/server/plugins/api-docs/import-api-docs-builder.d.ts

@@ -1,8 +0,0 @@
-import type { buildItems } from '@redocly/api-docs/src/adapters/build.js';
-import type { simplifyAstStructure } from '@redocly/api-docs/src/adapters/utils/simplifyAstStructure.js';
-export type ApiDocsBuilder = {
-    buildItems: typeof buildItems;
-    simplifyAstStructure: typeof simplifyAstStructure;
-};
-export declare function importApiDocsBuilder(serverOutDir: string): Promise<ApiDocsBuilder>;
-//# sourceMappingURL=import-api-docs-builder.d.ts.map

package/dist/server/plugins/api-docs/import-api-docs-builder.js

@@ -1 +0,0 @@
-import{existsSync as m,statSync as a}from"node:fs";import{pathToFileURL as c}from"node:url";import{buildItems as p,simplifyAstStructure as n}from"@redocly/api-docs";import{slash as u}from"../../../utils/path/slash.js";import{logger as l}from"../../tools/notifiers/logger.js";async function h(i){const s=u(i),r=`${s}/api-docs-builder-entry.mjs`,e=`${s}/api-docs-builder-entry.js`,o=m(r)?r:e;try{const t=a(o).mtimeMs;return await import(c(o).toString()+"?"+t)}catch(t){return l.verbose(`api-docs: using statically imported builder (remapped bundle not found in '${i}'): ${t?.message}`),{buildItems:p,simplifyAstStructure:n}}}export{h as importApiDocsBuilder};

package/dist/server/plugins/api-docs/index.d.ts

@@ -1,19 +0,0 @@
-import type { LifecyclePluginInstance } from '../../types';
-export declare function apiDocsPlugin(): Promise<LifecyclePluginInstance>;
-/**
- * Item links are absolute (adapter contract: basePath baked in at build time),
- * but routes register relative to fsPath. Map the link to route-slug fields so
- * core route creation runs slugify(fsPath) and keeps content-slugs transforms
- * (versioned `@x.y` folders, custom slugs) applied — an explicit `slug` bypasses
- * them and 404s the public URLs:
- *   - under basePath → `{ slugSuffix }` (also feeds getPageVersions, so the
- *     version picker retains the current page)
- *   - the base route (or an empty suffix) → `{}` — register at fsPath alone
- *   - outside basePath → `{ slug }` (explicit fallback)
- */
-export declare function toRouteSlugFields(link: string, basePath: string): {
-    slugSuffix: string;
-} | {
-    slug: string;
-} | Record<string, never>;
-//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/api-docs/index.js

@@ -1 +0,0 @@
-import{REDOCLY_ROUTE_RBAC as E,REDOCLY_TEAMS_RBAC as v}from"@redocly/config";import{mcpTagSchemas as Z,schemaDefinitionTag as ee,markdocParser as U}from"@redocly/api-docs";import{withPathPrefix as q}from"@redocly/theme/core/utils";import{API_DOCS_TEMPLATE_ID as V,GRAPHQL_SPEC_SLUG as te,PUBLIC_RBAC_SCOPE_ITEM as x}from"../../../constants/common.js";import{DEPRECATED_PUBLIC_API_DEFINITIONS_FOLDER as oe,PUBLIC_API_DEFINITIONS_FOLDER as re}from"../../constants/common.js";import{API_DOCS_SHARED_DATA_PREFIX as w}from"../../constants/plugins/api-docs.js";import{fromCurrentDir as ae}from"../../utils/paths.js";import{normalizeRouteSlug as se}from"../../../utils/path/normalize-route-slug.js";import{createSlugify as ie}from"../create-slugify.js";import{apiDocLoader as ne,apiDocsLoader as ce}from"./loader.js";import{getTemplatePath as j}from"./get-template-path.js";import{storeDefinitionBundles as pe}from"./store-definition-bundles.js";import{telemetryTraceStep as ue}from"../../../cli/telemetry/helpers/trace-step.js";import{searchResolver as de}from"./search/search-resolver.js";import{getAiDocumentsStore as le}from"./search/get-ai-search-documents.js";import{getApiConfigByPath as me}from"../get-api-config.js";import{getRouteSlugsForPath as fe}from"../utils.js";import{collectItemRoutes as he}from"./utils/collect-item-routes.js";import{isChunkCurrent as ge}from"./utils/decorators.js";import{applyNavItemToRoot as De}from"./utils/apply-nav-item-to-root.js";import{buildRoutesMapping as Se}from"./utils/build-routes-mapping.js";import{buildItemPositions as Pe}from"./utils/build-item-positions.js";import{resolveApiDocTitle as ye}from"./utils/resolve-api-doc-title.js";import{resolveConfigRbac as Ie}from"./utils/resolve-config-rbac.js";import{relativePathToBaseSlug as Ae}from"./utils/relative-path-to-base-slug.js";import{normalizeApiVersion as ve}from"./utils/normalize-api-version.js";import{importApiDocsBuilder as W}from"./import-api-docs-builder.js";import{envConfig as $}from"../../config/env-config.js";import{logger as Re}from"../../tools/notifiers/logger.js";const T="openapi-spec-download",be={asyncapi:"AsyncAPI Docs",graphql:"GraphQL Docs",openapi:"OpenAPI Docs"};async function nt(){let t=[],r=new Map;const s=new WeakMap;let n=new Set,m={};function k(o,h,A){const y=s.get(o)??new Map;s.set(o,y);const g=h??"";return y.get(g)===A?!1:(y.set(g,A),!0)}return{id:"api-docs",requiredEntitlements:["openapi","asyncapi","graphql"],loaders:{"api-doc":ne,"api-docs":ce},processContent:async(o,h)=>{await ue("com.redocly.build.plugin.apiDocs",async()=>{o.createRequestHandler(T,ae(import.meta.url,"./spec-download.api.js")),o.addApiRoute({slug:re+"/*",requestHandlerId:T,httpMethod:"all",[v]:x,getStaticData:async()=>({props:{}})}),o.addApiRoute({slug:oe+"/*",requestHandlerId:T,httpMethod:"all",[v]:x,getStaticData:async()=>({props:{}})}),o.addApiRoute({slug:te+"/*",requestHandlerId:T,httpMethod:"all",[v]:x,getStaticData:async()=>({props:{}})});const A=o.createTemplate(V,j("../../../client/templates/api-docs/template.js")),y=o.registerServerPropsGetter(V,j("./get-server-props.js")),g=await h.getConfig();r=new Map,m={};const I=await o.loadApiDocuments(h);pe(I,o.outdir);const C=!!g.plugins?.some(e=>typeof e=="string"&&e.startsWith("@redocly/portal-plugin-async-api/"));C&&I.some(e=>e.type==="asyncapi")&&Re.warn("The plugin '@redocly/portal-plugin-async-api' is deprecated. Please remove it from your config to use built-in AsyncAPI docs.");const c=C?I.filter(e=>e.type!=="asyncapi"):I;t=c.map(({markdocChunks:e,relativePath:P,isVirtual:p,customOutputRelativeFile:a,realRelativePath:f})=>({chunks:e??[],relativePath:P,realRelativePath:f,isVirtual:a!=null||p}));const{buildItems:i}=await W(o.serverOutDir),D=(await h.cache.load("content-slugs","content-slugs")).data,S=ie(D),O=e=>se(S(e));for(const e of c){const P=e.customOutputRelativeFile||e.relativePath,p=O(P);Ee(e,p);const{items:a,store:f}=await i({type:e.type,document:e.document,options:e.options,basePath:p,markdownParser:U}),R=`${w}${e.relativePath}`,M=$.isDevelopMode?e.relativePath:void 0,u=Te(e.document),b=u?.["x-metadata"],_=e.isVirtual?void 0:b?.apiId,N={document:e,basePath:p,sourcePath:M,apiId:_};await o.createSharedData(R,Q(N,a,f));const K=Ie(e.config),F=!!e.options.excludeFromSearch,Y=e.type==="openapi",l=he(a,K).map(d=>{const B=d.metadata?.seo,H={...we(d.link,p),fsPath:P,templateId:A,sharedData:[{key:"apiDocsStore",id:R}],serverPropsGetterIds:[y],excludeFromSearch:F,getStaticData:Ce(d.label,B),[v]:d[v]};return Y?{...H,...d.httpVerb?{httpVerb:d.httpVerb,metadata:{subType:"openapi-operation"}}:{}}:H});if(!l.length)continue;const G=ye(u,e.type,a),X=ve(u?.version),L={type:e.type,title:G,version:X,description:typeof u?.description=="string"?u.description:void 0,summary:typeof u?.summary=="string"?u.summary:void 0,...u?.["x-metadata"]&&typeof u["x-metadata"]=="object"?u["x-metadata"]:{}};l[0]={...l[0],metadata:L,hasClientRoutes:!0,getSidebar:(d,B)=>De(z(a),p,B),getNavText:()=>G??be[e.type]??"API Docs",getSearchDocuments:de(a,L,o.getSearchFacets,o.setSearchFacets,F,f,e.document),getAiDocumentsStore:le({items:a,metadata:L,store:f,document:e.document,specType:e.type,excludeFromSearch:F,basePath:p,getSearchFacets:o.getSearchFacets,markdocTags:{...Z,schemaDefinition:ee}})};const J=l[0];l[0]=l[l.length-1],l[l.length-1]=J;for(const d of l)o.addRoute(d);if(_){const d=me(e.config?.apis,e.realRelativePath);m[_]={[v]:d.rbac,[E]:{fsPath:P}}}r.set(R,N)}})},afterRoutesCreated:async(o,h)=>{const{buildItems:A,simplifyAstStructure:y}=await W(o.serverOutDir),g=new Set,I=new Set;for(const{chunks:c,relativePath:i,isVirtual:D}of t){const S=`${w}${i}`,O=fe(o.getAllRoutes(),i);for(const{node:e,markdown:P,pointer:p,key:a,relativePath:f}of c){const{ast:R,compoundHash:M}=await o.parseMarkdoc({input:{content:P,relativePath:f,isVirtual:D},resource:p,context:h,deps:{sharedDataIds:[`${w}${f}`],routeSlugs:O}});if(g.add(p),!(a==="graphql-docs"?e?.description?.value!==void 0:!!a&&ge(e,a,P))||!k(e,a,M))continue;I.add(S);const b=y(R);if(a==="graphql-docs"){e.description&&(e.description.value=b);const _=`${w}${f}`;_e(r.get(_),b)}else a&&(e[a]=b)}}const C=n.difference(g);for(const c of C)h.cache.delete(c);n=g,Object.entries(m).forEach(([c,i])=>{const D=i[E]?.fsPath;if(!D)return;const S=o.getRouteByFsPath(D)?.baseSlug;m[c]={...i,[E]:{...i[E],slug:S},slug:S}}),o.setGlobalData({apiProducts:m});for(const[c,i]of r){if(!I.has(c))continue;const{items:D,store:S}=await A({type:i.document.type,document:i.document.document,options:i.document.options,basePath:i.basePath,markdownParser:U});await o.createSharedData(c,Q(i,D,S))}}}}function Q({document:t,basePath:r,sourcePath:s,apiId:n},m,k){return{items:m,store:k,options:t.options,baseSlug:r,routesMapping:$.isDevelopMode?Se(m,r):{},graphqlPositions:$.isDevelopMode&&t.type==="graphql"?Pe(m,r):void 0,sourcePath:s,apiId:n}}function _e(t,r){t?.document.type!=="graphql"||!t.document.options||(t.document.options.info={...t.document.options.info||{},description:r})}function Ce(t,r){return async function(s){return{props:{settings:{baseUrlPath:q(s.baseSlug)},disableAutoScroll:!0,seo:{title:t,...r}}}}}function Ee(t,r){const s=t.options?.mockServer,n=q(`/_mock${Ae(t.relativePath)}`);s?.url===n&&(t.options={...t.options,mockServer:{...s,url:q(`/_mock${r}`)}})}function we(t,r){if(t===r)return{};const s=r==="/"?"/":`${r}/`;if(t.startsWith(s)){const n=t.slice(s.length);return n?{slugSuffix:n}:{}}return{slug:t}}function Te(t){if(t&&typeof t=="object"&&"info"in t)return t.info}function z(t){return t.map(({content:r,items:s,...n})=>({...n,...s&&{items:z(s)}}))}export{nt as apiDocsPlugin,we as toRouteSlugFields};

package/dist/server/plugins/api-docs/loader.d.ts

@@ -1,34 +0,0 @@
-import { type ASTNode, type DocumentNode } from 'graphql';
-import type { OpenAPIDefinition, AsyncApiDefinition, ApiSpecType, RawApiDocsOptions } from '@redocly/api-docs';
-import type { Node as MarkdocNode } from '@markdoc/markdoc';
-import type { LifecycleContext } from '../../types';
-import type { RedoclyConfig } from '@redocly/config';
-export type MarkdocChunk = {
-    node: Record<string, unknown> & {
-        description?: {
-            value?: string | ASTNode[] | ASTNode | MarkdocNode | MarkdocNode[];
-        };
-    };
-    pointer: string;
-    markdown: string;
-    relativePath: string;
-    key: string | null;
-};
-export type BundledApiDefinition = {
-    type: ApiSpecType;
-    document: OpenAPIDefinition | AsyncApiDefinition | DocumentNode;
-    config: Partial<RedoclyConfig & NonNullable<RedoclyConfig['apis']>[string]>;
-    relativePath: string;
-    realRelativePath: string;
-    customOutputRelativeFile?: string;
-    markdocChunks?: MarkdocChunk[];
-    isVirtual?: boolean;
-    hash: string;
-    options: RawApiDocsOptions;
-};
-type PartialDefinition = Omit<BundledApiDefinition, 'hash'>;
-export declare function apiDocLoader(relativePath: string, context: LifecycleContext): Promise<PartialDefinition[]>;
-export declare function apiDocsLoader(_: string, context: LifecycleContext): Promise<BundledApiDefinition[]>;
-export declare function collectGraphqlMarkdocChunks(schemaAst: DocumentNode): MarkdocChunk[];
-export {};
-//# sourceMappingURL=loader.d.ts.map

package/dist/server/plugins/api-docs/loader.js

@@ -1,3 +0,0 @@
-import*as l from"node:path";import{parse as B,visit as x}from"graphql";import{Source as D,bundle as N,createConfig as _,getTotals as M,resolvePlugins as V}from"@redocly/openapi-core";import{convertSwagger2OpenAPI as j}from"@redocly/api-docs/lib/adapters/utils/convertSwagger2OpenAPI.js";import{normalizeAsyncApiDefinition as S}from"@redocly/api-docs/lib/adapters/utils/normalizeAsyncApiDefinition.js";import{CONFIG_FILE_NAME as q}from"../../../constants/common.js";import{MAX_BUNDLING_ERRORS_TO_PRINT as F}from"../../constants/plugins/api-docs.js";import{unique as G}from"../../../utils/array/unique.js";import{deepMerge as L}from"../../../utils/object/deep-merge.js";import{pluralize as k}from"../../../utils/string/pluralize.js";import{replaceEnvVariablesDeep as z}from"../../utils/envs/replace-env-variables-deep.js";import{logger as b}from"../../tools/notifiers/logger.js";import{reporter as h}from"../../tools/notifiers/reporter.js";import{ExternalResolver as O}from"../../fs/utils/external-ref-resolver.js";import{collectCopiedDescriptionChunks as H,injectDecoratorIntoConfig as J,isPlainNonMarkdownText as Q}from"./utils/decorators.js";import{getAllApiConfigsByPath as U,getApiConfigByPath as X}from"../get-api-config.js";import{formatBundleError as K}from"./utils/format-bundle-error.js";import{createOptions as P}from"./options.js";const W=/(\.ya?ml|\.json|\.gql|\.graphql)$/,$=/(\.gql|\.graphql)$/;async function On(n,o){if(l.posix.basename(n)===q)return[];if($.test(n)){if(await o.isPathIgnored(n))return[];const u=await an(n,o);return u?[u]:[]}let r;try{r=(await o.cache.load(n,"yaml")).data}catch{return[]}const t=nn(n,r);if(!t||!r||t==="graphql")return t===null&&b.verbose(`${n} file is not a recognized API spec. Skipping`),[];const{fs:s,getConfig:a,isPathIgnored:c}=o,e=t==="openapi"?await a("."):null,i=s.getFileInfo(n),f=await a(l.posix.dirname(n)),p=U(f?.apis,n,f.configPath),w=await c(n),d=[];for(const u of p){if(!u.output&&w)continue;const y=f.configPath?l.posix.dirname(f.configPath):".",g=u.output?l.posix.join(y,u.output):n;if(!await c(g)){i&&u.output&&!s.exists(g)&&s.addVirtualFile(g,i);try{const m=await en({relativePath:n,outputRelativePath:g,loaded:r,specType:t,rootConfig:e,config:f,apiConfig:u,fileRecord:i,fs:s});m&&d.push(m)}catch(m){await h.panicOnBuildContentError(m)}}}return d}async function Pn(n,o){const{fs:r,cache:t}=o,s=[];for(const a of r.scan(W)){let c;try{c=await t.load(a.relativePath,"api-doc")}catch{continue}if(c.data?.length)for(const e of c.data)s.push({...e,isVirtual:a.isVirtual||e.isVirtual,hash:c.compoundHash})}return s}function Y(n){const o=[];return x(n,{leave:r=>{!("description"in r)||!r.description?.value||!("name"in r)||Q(r.description.value)||o.push({node:r,pointer:`#/types/${r?.name?.value}`,markdown:r.description.value,relativePath:"",key:"graphql-docs"})}}),o}async function Z(n){try{const o=B(n);return{document:o,markdocChunks:Y(o)}}catch(o){await h.panicOnBuildContentError(o);return}}function nn(n,o){return $.test(n)?"graphql":o?.openapi||o?.swagger?"openapi":o?.asyncapi?"asyncapi":null}function v(n,o){return o?{...n,info:{...n.info,"x-metadata":{...n.info?.["x-metadata"],...o}}}:n}async function on(n,o,r){if(n==="openapi"){const t=o.swagger!==void 0?await j(o):o;return v(t,r)}return v(S(o),r)}async function rn(n){const{outputRelativePath:o,rootConfig:r,config:t,apiConfig:s,fs:a}=n,c=L({decorators:r?.decorators},t,{rbac:void 0},s),{resolvedObj:e}=z(c);if(e.decorators&&typeof e.decorators!="object"){await h.panicOnBuildContentError(`'decorators' must be an object at redocly.yaml, got '${typeof e.decorators}'`);return}if(e.plugins&&!Array.isArray(e.plugins)){await h.panicOnBuildContentError(`'plugins' must be an array at redocly.yaml, got '${typeof e.plugins}'`);return}const i=l.resolve(a.cwd,t.realConfigPath||q),f=new O(a),p=await _(J(e,o,a.cwd),{configPath:i,externalRefResolver:f});return r?.plugins&&r.configPath!==t.configPath&&(p.plugins=G([...p.plugins||[],...await V(r.plugins,a.cwd)],w=>w.id)),{coreConfig:p,mergedConfig:e}}async function tn(n,o,r){const t=M(n),s=[t.errors&&`${t.errors} ${k(t.errors,"error","errors")}`,t.warnings&&`${t.warnings} ${k(t.warnings,"warning","warnings")}`,t.ignored&&`${t.ignored} ignored`].filter(Boolean).join(", ");if(t.errors){const a=n.filter(i=>i.severity==="error");let c=`${s} while bundling ${o} definition:
-`;const e=Math.min(a.length,F);for(let i=0;i<e;i++){const f=await K(a[i],r);c+=`${f}
-`}if(a.length>e){const i=a.length-e;c+=`... and ${i} more ${k(i,"error","errors")}`}return await h.panicOnBuild(c),!0}return t.warnings&&b.warn(`${s} while bundling %rp definition`,o),!1}async function en(n){const{relativePath:o,outputRelativePath:r,loaded:t,specType:s,rootConfig:a,config:c,apiConfig:e,fileRecord:i,fs:f}=n,p=await rn(n);if(!p)return;const{coreConfig:w,mergedConfig:d}=p,u=l.resolve(f.cwd,o),y=new O(f),g={config:w,base:l.dirname(u),doc:{source:new D(u,await f.read(o)),parsed:JSON.parse(JSON.stringify(t))},externalRefResolver:y},{bundle:{parsed:E},problems:m,visitorsData:A}=await N(g);if(await tn(m,r,f.cwd))return;const C=A["markdown/markdown"]?.markdocChunks??[],I=d.metadata,R=await on(s,E,I);s==="asyncapi"&&C.push(...H(R,C));const T=P(s,R,{rootConfig:a,config:c,apiConfig:e,mergedConfig:d,relativePath:r});return{type:s,document:R,config:d,relativePath:r,realRelativePath:i?.realRelativePath||r,customOutputRelativeFile:e.output?r:void 0,markdocChunks:C,isVirtual:i?.isVirtual,options:T}}async function an(n,o){const{fs:r,getConfig:t}=o,s=await r.read(n),a=r.getFileInfo(n),{document:c,markdocChunks:e}=await Z(s)||{};if(!c){await h.panicOnBuildContentError(new Error("Failed to build GraphQL document"));return}const i=await t(),f=X(i.apis,n);i.graphql?.info?.description&&e?.unshift({node:{description:{value:i.graphql?.info?.description}},pointer:"#/info",markdown:i.graphql?.info?.description,relativePath:"",key:"graphql-docs"});const p=P("graphql",c,{rootConfig:null,config:i,apiConfig:f??{},mergedConfig:{graphql:{...i.graphql??{},...f?.graphql??{}}},relativePath:n});return{type:"graphql",document:c,config:{...i,...f},relativePath:n,realRelativePath:a?.realRelativePath||n,markdocChunks:e,isVirtual:a?.isVirtual,options:p}}export{On as apiDocLoader,Pn as apiDocsLoader,Y as collectGraphqlMarkdocChunks};

package/dist/server/plugins/api-docs/options.d.ts

@@ -1,14 +0,0 @@
-import { type ApiSpecType, type OpenAPIDefinition, type AsyncApiDefinition, type DownloadUrl, type RawApiDocsOptions } from '@redocly/api-docs';
-import type { DocumentNode } from 'graphql';
-export type DocumentBuildContext = {
-    rootConfig: Record<string, unknown> | null;
-    config: Record<string, unknown>;
-    apiConfig: Record<string, unknown>;
-    mergedConfig: Record<string, unknown>;
-    relativePath: string;
-};
-type CreateOptionsDocument = OpenAPIDefinition | AsyncApiDefinition | DocumentNode;
-export declare function buildDownloadUrls(relativePath: string, specType: ApiSpecType): DownloadUrl[];
-export declare function createOptions(specType: ApiSpecType, document: CreateOptionsDocument, context: DocumentBuildContext): RawApiDocsOptions;
-export {};
-//# sourceMappingURL=options.d.ts.map

package/dist/server/plugins/api-docs/options.js

@@ -1 +0,0 @@
-import*as F from"node:path";import{findFirstBinding as P,markdocParser as _}from"@redocly/api-docs";import{combineUrls as i}from"@redocly/theme/core/openapi";import{withPathPrefix as k}from"@redocly/theme/core/utils";import{GRAPHQL_SPEC_SLUG as w}from"../../../constants/common.js";import{PUBLIC_API_DEFINITIONS_FOLDER as f}from"../../constants/common.js";import{envConfig as L}from"../../config/env-config.js";import{deepMerge as M}from"../../../utils/object/deep-merge.js";import{normalizeFeedbackOptions as A}from"./utils/normalize-feedback-options.js";import{replaceFileExtension as g}from"./utils/replace-file-extension.js";import{relativePathToBaseSlug as B}from"./utils/relative-path-to-base-slug.js";const R={tags:{},nodes:{},components:{}};function D(o,r){if(!(o?.off!==!0))return o;const t=B(r);return{url:k(`/_mock${t}`),position:"first",description:"Mock server",...o}}function I(o,r){return(r==="graphql"?[i(w,`${g(o,F.posix.extname(o))}?download`)]:[i(f,`${g(o,".json")}?download`),i(f,`${g(o,".yaml")}?download`)]).map(t=>({url:k(t)}))}function j(o,r,m){const{rootConfig:t,config:c,apiConfig:s,mergedConfig:e,relativePath:l}=m,a=M(t?.[o]||{},c[o]||{},s[o]||s.theme?.[o]||{}),b=r["x-feedback"]||a.feedback||c.feedback,S=!!e[o]?.excludeFromSearch||!!e.theme?.[o]?.excludeFromSearch||!!t?.[o]?.excludeFromSearch||!!t?.theme?.[o]?.excludeFromSearch,x=e.rbac||s.rbac,p=A(b),u=c.metadata,C={...p&&{feedback:p},mockServer:D(e?.mockServer||t?.mockServer,l),disableRouter:!0,downloadUrls:a.downloadUrls||I(l,o),excludeFromSearch:S,rbac:x,markdownParser:_,replayFeatures:{graphql:L.REDOCLY_EXP_REPLAY_GRAPHQL_ENABLED??!1}};let d;if(o==="graphql"){const n=a;d={title:n.info?.title,...u,...n.metadata??{}}}else{const n=r.info,E=n?.["x-metadata"];d={title:n?.title,description:n?.description,...o==="openapi"&&{summary:n?.summary},...u,...E}}o==="openapi"&&a.showSchemaCatalogLinks&&(r["x-schema-catalog-link"]=i(f,l));const O=a.markdocOptions??R,h={...a,...C,specType:o,markdocOptions:O,metadata:d};return o==="asyncapi"&&(h.protocol=P(r)??void 0),h}export{I as buildDownloadUrls,j as createOptions};

package/dist/server/plugins/api-docs/search/create-indexer.d.ts

@@ -1,5 +0,0 @@
-import { ApiDocsSearchIndexer } from '@redocly/api-docs';
-import type { ExampleEntry, SchemaEntry } from '@redocly/api-docs';
-/** The shared api-docs indexer with Markdown descriptions — AI search documents and llms.txt need Markdown. */
-export declare function createApiDocsSearchIndexer(basePath: string, schemaStore?: Record<string, SchemaEntry>, document?: Record<string, unknown>, exampleStore?: Record<string, ExampleEntry>): ApiDocsSearchIndexer;
-//# sourceMappingURL=create-indexer.d.ts.map

package/dist/server/plugins/api-docs/search/create-indexer.js

@@ -1 +0,0 @@
-import{ApiDocsSearchIndexer as e}from"@redocly/api-docs";import{toMarkdown as i}from"../../markdown/search/to-markdown.js";function a(r){if(typeof r=="string")return r;const t=Array.isArray(r)?r:[r];return i(t).trim()}function f(r,t,o,n){return new e(r,t,o,{formatDescription:a,exampleStore:n})}export{f as createApiDocsSearchIndexer};

package/dist/server/plugins/api-docs/search/get-ai-search-documents.d.ts

@@ -1,20 +0,0 @@
-import { type ApiItem, type ApiDocsMetadata, type ApiStore, type ApiSpecType, type OpenAPIDefinition, type AsyncApiDefinition } from '@redocly/api-docs';
-import type { SearchFacet } from '@redocly/theme/core/types';
-import type { AfterRoutesCreatedActions, AfterRoutesCreatedLifecycleContext, PageRouteDetails } from '../../../types';
-import type { MarkdocTagSchema } from '@redocly/theme/markdoc/tags/types';
-import type { AiDocumentsStore } from '../../../plugins/search/types.js';
-type ApiDocument = OpenAPIDefinition | AsyncApiDefinition | Record<string, unknown>;
-type AiDocumentsStoreParams = {
-    items: ApiItem[];
-    metadata: ApiDocsMetadata;
-    store?: ApiStore;
-    document?: ApiDocument;
-    specType: ApiSpecType;
-    excludeFromSearch?: boolean;
-    basePath: string;
-    getSearchFacets: () => Map<string, SearchFacet>;
-    markdocTags?: Record<string, MarkdocTagSchema>;
-};
-export declare function getAiDocumentsStore({ items, metadata, store, document, specType, excludeFromSearch, basePath, getSearchFacets, markdocTags, }: AiDocumentsStoreParams): (route: PageRouteDetails, _staticData: unknown, _context: AfterRoutesCreatedLifecycleContext, actions: AfterRoutesCreatedActions) => Promise<AiDocumentsStore | undefined>;
-export {};
-//# sourceMappingURL=get-ai-search-documents.d.ts.map

package/dist/server/plugins/api-docs/search/get-ai-search-documents.js

@@ -1,105 +0,0 @@
-import P from"node:path";import{REDOCLY_TEAMS_RBAC as O}from"@redocly/config";import{nodeTypes as h,contentType as y}from"@redocly/api-docs";import{normalizeApiVersion as sn}from"../utils/normalize-api-version.js";import{replaceFileExtension as U}from"../utils/replace-file-extension.js";import{isResourcePubliclyAccessible as cn,canDownloadApiDefinition as ln,extractTeamsFromScopeItems as fn}from"../../../utils/rbac.js";import{getLlmsTxtMdPathBySlug as J}from"../../../utils/llmstxt/get-llms-txt-md-path-by-slug.js";import{PUBLIC_API_DEFINITIONS_FOLDER as Q}from"../../../constants/common.js";import{GRAPHQL_SPEC_SLUG as an}from"../../../../constants/common.js";import{ANONYMOUS_AUTH_DETAILS as pn}from"../../../constants/rbac.js";import{toMarkdown as v}from"../../markdown/search/to-markdown.js";import{createRenderTagFn as un}from"../../markdown/search/create-render-tag-fn.js";import{getLocaleFromRelativePath as dn}from"../../../fs/utils/get-locale-from-relative-path.js";import{getBuildTranslateContext as hn}from"../../../utils/l10n/get-build-translate-context.js";import{llmsTxtLink as N}from"../../search/llmstxt/index.js";import{formatDocumentMetadata as mn}from"../../search/utils.js";import{extractDocumentSearchFacets as $n}from"./search-facets.js";import{createApiDocsSearchIndexer as yn}from"./create-indexer.js";function A(t,o){return o==="openapi"&&"openapi"in t}function H(t,o){return o==="asyncapi"&&"asyncapi"in t}function Qn({items:t,metadata:o,store:s,document:n,specType:r,excludeFromSearch:i,basePath:e,getSearchFacets:l,markdocTags:c}){return async(f,a,u,d)=>{if(i)return;const m={...d.markdocOptions?.tags,...c},{locale:X,translate:Z}=await hn(f.slug,d.getGlobalData?.().l10n),x=un(m,X,Z),C=d.getConfig(),L=dn(f.fsPath),j=yn(e,s?.schemaStore,n,s?.exampleStore),M=g=>{for(const p of g)j.addItem(p),p.items?.length&&M(p.items)};M(t);const nn=j.getResult(),V=new Map;for(const g of nn)V.set(g.url,g);const R=typeof o.title=="string"?o.title:void 0,_=sn(o.version),D=$n(f.metadata||{},R,_,l),S=[],I=[],q=gn(o,n,r),F=bn(r,o,f.fsPath,C),tn=In(t,C,x),en=q+F+`
-`+tn,on=q+F;I.push({title:R||"API Overview",description:typeof o.description=="string"?o.description:void 0,content:en,slug:e,fsPath:f.fsPath,includeInLLMsTxt:!0}),S.push({title:R||"API Overview",content:on,url:e,fsPath:f.fsPath,locale:L,product:f.product?.name,facets:D});const rn=n&&A(n,r)?n.security:void 0,E=g=>{for(const p of g){if(!p.content||!p.link){p.items?.length&&E(p.items);continue}const k=V.get(p.link),G=p.content.contentType,z=p[O],W=z?fn(z):void 0,B=W?.length?W:void 0;if(G===y.ITEM){const $=Pn(p,n,r)??Y(p,k,r,_,rn,x);if($){const b=p.label||"";I.push({title:b,description:void 0,content:$,slug:p.link,fsPath:f.fsPath,includeInLLMsTxt:!1}),S.push({title:b,content:$,url:p.link,fsPath:f.fsPath,locale:L,product:f.product?.name,facets:D,rbacTeams:B})}}else if(G===y.GROUP){const $=On(p,C,r,x);if($){const b=p.label||"";I.push({title:b,description:k?Rn(k.text):void 0,content:$.llmstxt,slug:p.link,fsPath:f.fsPath,includeInLLMsTxt:!1}),S.push({title:b,content:$.aiSearch,url:p.link,fsPath:f.fsPath,locale:L,product:f.product?.name,facets:D,rbacTeams:B})}}p.items?.length&&E(p.items)}};return E(t),{async getLLMsTxts(){return I},async getSearchDocuments(){return S}}}}function gn(t,o,s){const n=typeof t.title=="string"?t.title:"",r=typeof t.description=="string"?t.description:"",i=typeof t.summary=="string"?t.summary:"",e=typeof t.version=="string"?t.version:"";let l=n?`# ${n}
-
-`:"";if(l+=r?`${r}
-
-`:"",l+=i?`${i}
-
-`:"",l+=e?`Version: ${e}
-`:"",o){if(A(o,s)){const{info:c}=o;c?.license?.name&&(l+=`License: ${c.license.name}
-`);const f=c["x-metadata"],a=mn(f);a&&(l+=`
-Metadata:
-${a}
-`)}else if(H(o,s)){const{info:c}=o;c?.license?.name&&(l+=`License: ${c.license.name}
-`)}}return l+=`
-`,l+=An(o,s),l+=Sn(o,s),l}function bn(t,o,s,n){if(!s)return"";let r,i,e;if(t==="openapi")r=P.posix.join(Q,U(s,".yaml")),i="## Download OpenAPI description",e="OpenAPI definition";else if(t==="asyncapi")r=P.posix.join(Q,U(s,".yaml")),i="## Download AsyncAPI description",e="AsyncAPI definition";else if(t==="graphql"){const f=P.posix.extname(s)||".graphql";r=P.posix.join(an,U(s,f)),i="## Download GraphQL schema",e="GraphQL schema"}else return"";if(!ln(r,n.access?.rbac??{},n.access?.requiresLogin??!1,pn))return"";const c=typeof o.title=="string"&&o.title||e;return`${i}
-
- - ${N({title:c,description:void 0,slug:r,siteUrl:n.seo?.siteUrl})}`}function An(t,o){if(!t)return"";if(A(t,o)){const{servers:s}=t;if(!s?.length)return"";let n=`## Servers
-
-`;for(const r of s)if(r.description&&(n+=`${r.description}
-`),n+=`\`\`\`
-${r.url}
-\`\`\`
-
-`,r.variables){n+=`Variables:
-`;for(const[i,e]of Object.entries(r.variables))n+=`- \`${i}\`${e.description?`: ${e.description}`:""}
-`,e.default&&(n+=`  Default: ${JSON.stringify(e.default)}
-`),e.enum&&(n+=`  Enum: ${e.enum.map(l=>JSON.stringify(l)).join(", ")}
-`);n+=`
-`}return n}if(H(t,o)){const{servers:s}=t;if(!s||!Object.keys(s).length)return"";let n=`## Servers
-
-`;for(const[r,i]of Object.entries(s))n+=`### ${r}
-
-`,i.description&&(n+=`${i.description}
-`),i.host&&(n+=`Host: ${i.host}
-`),i.protocol&&(n+=`Protocol: ${i.protocol}
-`),i.protocolVersion&&(n+=`Protocol Version: ${i.protocolVersion}
-`),i.pathname&&(n+=`Pathname: ${i.pathname}
-`),n+=`
-`;return n}return""}function Sn(t,o){if(!t||!A(t,o))return"";const s=t.components?.securitySchemes;if(!s)return"";let n=`## Security
-
-`;for(const[r,i]of Object.entries(s)){if(!i||"$ref"in i)continue;const e=i;n+=`### ${r}
-
-`,e.description&&(n+=`${e.description}
-
-`),e.type&&(n+=`Type: ${e.type}
-`),e.in&&(n+=`In: ${e.in}
-`),e.name&&(n+=`Name: ${e.name}
-`),e.scheme&&(n+=`Scheme: ${e.scheme}
-`),e.bearerFormat&&(n+=`Bearer Format: ${e.bearerFormat}
-`),e.openIdConnectUrl&&(n+=`OpenID Connect URL: ${e.openIdConnectUrl}
-`);const l=e.flows,c=l?.implicit||l?.password||l?.clientCredentials||l?.authorizationCode;if(c&&("authorizationUrl"in c&&c.authorizationUrl&&(n+=`Authorization URL: ${c.authorizationUrl}
-`),"tokenUrl"in c&&c.tokenUrl&&(n+=`Token URL: ${c.tokenUrl}
-`),c.scopes)){n+=`Scopes:
-`;for(const[f,a]of Object.entries(c.scopes))n+=`- \`${f}\`: ${a}
-`}n+=`
-`}return n}function In(t,o,s){let n="";const r=(i,e)=>{for(const l of i)if(l.link){if(l.content?.contentType===y.GROUP)n+=`${e} ${l.label||""}
-
-`,l.items?.length&&r(l.items,e+"#");else if(l.content?.contentType===y.ITEM){if(!w(l,o))continue;const c=l,f=c.httpVerb,a=c.httpPath,u=f&&a?`${f.toUpperCase()} ${a}`:l.label||"",d=l.content?T(l.content.children,s):void 0;n+=` - ${N({title:u,description:d?d.slice(0,200):void 0,slug:J(l.link),siteUrl:o.seo?.siteUrl})}`}}};return r(t,"##"),n}function Y(t,o,s,n,r,i){if(!t.content)return;const e=t,l=t.label||"",c=T(t.content.children,i),f=t.content.meta?.deprecated;let a=`# ${l}${f?" (deprecated)":""}
-
-`;if(c&&(a+=`${c}
-
-`),s==="openapi"||s==="asyncapi"){const u=e.httpVerb,d=e.httpPath;u&&d?a+=`Endpoint: ${u.toUpperCase()} ${d}
-`:u&&(a+=`Method: ${u.toUpperCase()}
-`),n&&(a+=`Version: ${n}
-`);const m=Tn(t.content.children,r);m&&(a+=`Security: ${m}
-`)}return o?.parameters?.length&&s!=="graphql"&&(a+=`
-`+xn(o.parameters)+`
-`),s==="graphql"&&(a+=Cn(t.content.children)),a}function Pn(t,o,s){if(t.httpVerb!=="tool"||!o||!A(o,s))return;const n=t.content?.meta?.name,r=n?o["x-mcp"]?.tools?.find(e=>e.name===n):void 0;if(!r)return;let i=`# ${t.label||r.name}
-
-`;return typeof r.description=="string"&&r.description&&(i+=`${r.description}
-
-`),i+=`## Input schema:
-
-`,i+=`\`\`\`json
-${JSON.stringify(r.inputSchema,null,2)}
-\`\`\`
-
-`,r.outputSchema&&(i+=`## Output schema:
-
-`,i+=`\`\`\`json
-${JSON.stringify(r.outputSchema,null,2)}
-\`\`\`
-
-`),i}function On(t,o,s,n){if(!t.content)return;const r=t.label||"",i=T(t.content.children,n);let e=`# ${r}
-
-`;if(i&&(e+=`${i}
-
-`),s==="graphql"){let c="";const f=a=>{for(const u of a??[])if(!(!u.content||!w(u,o)))if(u.content.contentType===y.ITEM){const d=Y(u,void 0,s,void 0,void 0,n);d&&(c+=`${d}
-
----
-
-`)}else u.content.contentType===y.GROUP&&f(u.items)};return f(t.items),{llmstxt:e+c,aiSearch:e}}let l="";if(t.items?.length)for(const c of t.items){if(!c.link||!c.content||c.content.contentType!==y.ITEM||!w(c,o))continue;const f=c,a=f.httpVerb,u=f.httpPath,d=a&&u?`${a.toUpperCase()} ${u}`:c.label||"",m=c.content?T(c.content.children,n):void 0;l+=` - ${N({title:d,description:m?m.slice(0,200):void 0,slug:J(c.link),siteUrl:o.seo?.siteUrl})}`}return{llmstxt:e+l,aiSearch:e}}function Tn(t,o){const s=[],n=r=>{for(const i of r)if(i.nodeType===h.SECURITY){const e=i;for(const l of e.requirements)for(const c of l.schemes)c[O]||c.name&&!s.includes(c.name)&&s.push(c.name)}else(i.nodeType===h.CONTAINER||i.nodeType===h.OVERVIEW_SECTION_WRAPPER)&&n(i.children)};if(n(t),s.length)return s.join(", ");if(o?.length){const r=o.flatMap(i=>Object.keys(i));if(r.length)return[...new Set(r)].join(", ")}}function xn(t){const o={};for(const n of t){const r=`${n.place}${n.mediaType?` (${n.mediaType})`:""}`;o[r]||(o[r]=[]),o[r].push(n)}return Object.entries(o).map(([n,r])=>{const i=r.map(e=>{const l=[...e.path||[],e.name],c=Array.isArray(e.description)?e.description.join(" "):e.description;let f=`  - \`${l.join(".")}\` (${e.type}${e.required?", required":""})
-`;return c&&(f+=`    ${c.trim()}
-`),e.enum?f+=`    Enum: ${e.enum.map(a=>JSON.stringify(a)).join(", ")}
-`:e.example&&(f+=`    Example: ${e.example}
-`),f});return`## ${K(n)}:
-
-${i.join(`
-`)}`}).join(`
-`)}function Cn(t){let o="";const s=n=>{for(const r of n)if(r.nodeType===h.ITEM){const i=r;i.graphqlSchema&&(o+=Ln(i.graphqlSchema,i.variant))}else(r.nodeType===h.CONTAINER||r.nodeType===h.OVERVIEW_SECTION_WRAPPER)&&s(r.children)};return s(t),o}function Ln(t,o){let n=`
-## ${K(o==="return-type"?"Return type":o==="graphql-args"||o==="arguments"?"Arguments":o==="graphql-fields"?"Fields":o)}:
-
-`;const r=i=>{const e=i.description?v(Array.isArray(i.description)?i.description:[i.description]).trim():"";return`  - \`${i.name}\` (${i.type})${e?`: ${e}`:""}
-`};if(!Array.isArray(t)){const i=t.description?v(Array.isArray(t.description)?t.description:[t.description]).trim():"";n+=`  Type: ${t.type}`,i&&(n+=` - ${i}`),n+=`
-`;for(const e of t.fields??[])n+=r(e);return n}if(!t.length)return"";for(const i of t)n+=r(i);return n}function T(t,o){const s=[],n=i=>{for(const e of i)if(e.nodeType===h.MARKDOC){const l=e.content,c=Array.isArray(l)?l:[l],f=v(c,{renderTag:o}).trim();f&&s.push(f)}else(e.nodeType===h.CONTAINER||e.nodeType===h.OVERVIEW_SECTION_WRAPPER)&&n(e.children)};return n(t),s.join(" ").trim()||void 0}function Rn(t){return(Array.isArray(t)?t.join(" "):t)||void 0}function K(t){return t.charAt(0).toUpperCase()+t.slice(1)}function w(t,o){return o.access?.requiresLogin?!0:cn({slug:t.link||"",[O]:t[O]},o)}export{Qn as getAiDocumentsStore};

package/dist/server/plugins/api-docs/search/search-facets.d.ts

@@ -1,10 +0,0 @@
-import type { SearchFacet } from '@redocly/theme/core/types';
-export declare function setDocumentSearchFacets(documentSearchFacets: {
-    [key: string]: string | Set<string>;
-}, getSearchFacets: () => Map<string, SearchFacet>, setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void): void;
-export declare function extractDocumentSearchFacets(metadata: {
-    [key: string]: unknown;
-}, apiTitle: string | undefined, apiVersion: string | undefined, getSearchFacets: () => Map<string, SearchFacet>): {
-    [key: string]: string;
-};
-//# sourceMappingURL=search-facets.d.ts.map

package/dist/server/plugins/api-docs/search/search-facets.js

@@ -1 +0,0 @@
-import{SEARCH_GROUP_FACET_FIELD as a}from"../../../../constants/common.js";import{SEARCH_GROUP_NAME_API as u}from"../../../constants/plugins/search.js";function F(e,n,s){const f=n();for(const[t,o]of Object.entries(e)){const c=f.get(t);if(c){const r=new Set(c.values??[]);if(o instanceof Set)for(const i of o)r.add(i);else r.add(o);c.values=Array.from(r)}}s(f)}function h(e,n,s,f){const t={[a]:u,...n&&{apiTitle:n},...s&&{apiVersion:s}};if(!e)return t;const o=f();for(const[c,r]of Object.entries(e))o.has(c)&&(t[c]=String(r));return e.title&&(t.apiTitle=String(e.title)),t}export{h as extractDocumentSearchFacets,F as setDocumentSearchFacets};

package/dist/server/plugins/api-docs/search/search-resolver.d.ts

@@ -1,5 +0,0 @@
-import type { SearchFacet } from '@redocly/theme/core/types';
-import type { ApiItem, ApiDocsMetadata, ApiStore } from '@redocly/api-docs';
-import type { PageRouteDetails, SearchDocument } from '../../../types';
-export declare function searchResolver(items: ApiItem[], metadata: ApiDocsMetadata, getSearchFacets: () => Map<string, SearchFacet>, setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void, excludeFromSearch?: boolean, store?: ApiStore, document?: Record<string, unknown>): (route: PageRouteDetails) => Promise<SearchDocument[]>;
-//# sourceMappingURL=search-resolver.d.ts.map

package/dist/server/plugins/api-docs/search/search-resolver.js

@@ -1 +0,0 @@
-import{REDOCLY_ROUTE_RBAC as h,REDOCLY_TEAMS_RBAC as o}from"@redocly/config";import{extractDocumentSearchFacets as x,setDocumentSearchFacets as A}from"./search-facets.js";import{ApiDocsSearchIndexer as D}from"@redocly/api-docs";import{normalizeApiVersion as d}from"../utils/normalize-api-version.js";function O(u,i,c,S,R,a,g){return async e=>{if(R)return[];const m=e.baseSlug||e.slug,l=new D(m,a?.schemaStore,g,{exampleStore:a?.exampleStore}),f=t=>{for(const r of t)l.addItem(r),r.items?.length&&f(r.items)};f(u);const s=typeof i.title=="string"?i.title:void 0,n=d(i.version),p=x(e.metadata||{},s,n,c);return A(p,c,S),l.getResult().map(t=>({...t,...t.url===m&&s&&{title:n?`${s} (${n})`:s},[o]:t[o]??e[o],[h]:e[h]??{slug:e.slug,fsPath:e.fsPath},facets:p}))}}export{O as searchResolver};

package/dist/server/plugins/api-docs/spec-download.api.d.ts

@@ -1,4 +0,0 @@
-import type { ApiRoutesHandler } from '@redocly/config';
-declare const specDownloadApi: ApiRoutesHandler;
-export default specDownloadApi;
-//# sourceMappingURL=spec-download.api.d.ts.map

package/dist/server/plugins/api-docs/spec-download.api.js

@@ -1 +0,0 @@
-import e from"node:path";import{existsSync as c}from"node:fs";import{readFile as F}from"node:fs/promises";import C from"js-yaml";import{withoutPathPrefix as U}from"@redocly/theme/core/utils";import{DEPRECATED_PUBLIC_API_DEFINITIONS_FOLDER as I,PUBLIC_API_DEFINITIONS_FOLDER as p}from"../../constants/common.js";import{GRAPHQL_SPEC_SLUG as y}from"../../../constants/common.js";import{canDownloadApiDefinition as O,filterDataByAccessDeep as q}from"../../utils/rbac.js";function A(a,t){const n=e.parse(a);return e.join(n.dir,n.name+t)}const T=async(a,t,n)=>{const{isAuthenticated:i,teams:l,claims:{email:f}}=t.user,S=new URL(a.url),o=U(S.pathname),m=o.startsWith(y),s=decodeURIComponent(m?o.replace(y,""):o.replace(p,"").replace(I,"")),{rbac:u={},requiresLogin:d=!1}=t.config.access||{};if(!O(o,u,d,{isAuthenticated:i,email:f,teams:l}))return new Response("Unauthorized",{status:i?403:401});const r=n.props?.outdir||"";if(m){const E=e.join(r,p,s);if(!c(E))return new Response("Not found",{status:404});const x=await F(E,"utf-8");return new Response(x,{headers:{"Content-Type":"application/graphql"}})}const h=e.join(r,p,A(s,".json")),P=e.join(r,I,A(s,".json")),R=c(h),_=c(P);if(!R&&!_)return new Response("Not found",{status:404});const L=await F(R?h:P,"utf-8"),N=JSON.parse(L),w=q(N,{isAuthenticated:i,email:f,teams:l},u,d),D=e.extname(s),j=D===".yaml"?C.dump(w):JSON.stringify(w,null,2);return new Response(j,{headers:{"Content-Type":D===".yaml"?"application/yaml":"application/json"}})};var k=T;export{k as default};

package/dist/server/plugins/api-docs/store-definition-bundles.d.ts

@@ -1,3 +0,0 @@
-import type { BundledApiDefinition } from './loader.js';
-export declare function storeDefinitionBundles(definitions: BundledApiDefinition[], outDir: string): void;
-//# sourceMappingURL=store-definition-bundles.d.ts.map

package/dist/server/plugins/api-docs/store-definition-bundles.js

@@ -1 +0,0 @@
-import{writeFileSync as m}from"fs";import p from"path";import{print as d}from"graphql";import{PUBLIC_API_DEFINITIONS_FOLDER as h,PUBLIC_STATIC_FOLDER as a}from"../../constants/common.js";import{logger as u}from"../../tools/notifiers/logger.js";import{ensureDir as g}from"../../utils/fs.js";import{replaceFileExtension as S}from"./utils/replace-file-extension.js";const r=new Map;function D(f,t){const n=h.slice(1);try{for(const e of f){const{document:s,relativePath:i,hash:o,type:c}=e;if(r.get(i)!==o){if(c==="graphql"){l({outDir:t,definitionFolder:n,relativePath:i,definitionString:d(s)}),r.set(i,o);continue}if(i.startsWith(a+"/")){l({outDir:t,definitionFolder:".",relativePath:i.replace(a+"/",""),definitionString:JSON.stringify(s,null,2)}),r.set(i,o);continue}l({outDir:t,definitionFolder:n,relativePath:S(i,".json"),definitionString:JSON.stringify(s,null,2)}),r.set(i,o)}}}catch(e){u.error("failed to store definition bundles",e)}}function l({outDir:f,definitionString:t,relativePath:n,definitionFolder:e}){m(g(p.resolve(f,`${e}/${n}`)),t,"utf8")}export{D as storeDefinitionBundles};

package/dist/server/plugins/api-docs/utils/apply-nav-item-to-root.d.ts

@@ -1,9 +0,0 @@
-import type { NavItem, ResolvedNavItem } from '@redocly/config';
-/** A sidebars.yaml entry as core passes it to `getSidebar`: `icon` is the resolved path, or `undefined`
- *  with the resolved `srcSet` when the entry's icon is an `icon.srcSet` object. */
-export type SidebarEntry = NavItem & {
-    srcSet?: string;
-};
-/** Puts the sidebars.yaml entry's label, icon and badges on the API root item, as core does for a page. */
-export declare function applyNavItemToRoot(items: ResolvedNavItem[], basePath: string, entry?: SidebarEntry): ResolvedNavItem[];
-//# sourceMappingURL=apply-nav-item-to-root.d.ts.map

package/dist/server/plugins/api-docs/utils/apply-nav-item-to-root.js

@@ -1 +0,0 @@
-const u=[({label:n,labelTranslationKey:o})=>n?{label:n,labelTranslationKey:o}:void 0,({icon:n,srcSet:o})=>{const t=typeof n=="string"?n:void 0;return t||o?{icon:t,srcSet:o}:void 0},({badges:n})=>n?{badges:n}:void 0];function c(n,o,t){if(!t)return n;const r=d(t);return n.map(e=>i(e,o)?{...e,...r}:e)}function d(n){return u.reduce((o,t)=>({...o,...t(n)}),{})}function i(n,o){return n.link===o}export{c as applyNavItemToRoot};