@redocly/realm 0.138.0-next.15 → 0.138.0-next.16

package/dist/server/plugins/search/engines/typesense/index.js

@@ -0,0 +1 @@
+import{appendFile as D}from"node:fs/promises";import{existsSync as v}from"node:fs";import b from"node:path";import{Client as N}from"typesense";import{SEARCH_GROUP_FACET_FIELD as A,SEARCH_PRODUCT_FIELD as q,SEARCH_RBAC_FIELD as T,SEARCH_VERSION_FIELD as h}from"../../../../../constants/common.js";import{DISABLE_DEEP_LINK_IF_FIELDS_EXIST as L,HIGHLIGHTED_TEXT_MAX_LENGTH as R,SEARCH_DATA_EXPORT_FOLDER as C,SEARCH_DOCUMENT_METADATA_KEY as j,SEARCH_GROUP_LIMIT as O,SEARCH_MAX_FACET_VALUES as y,SEARCH_MAX_INMEMORY_DOCUMENTS_COUNT as k}from"../../../../constants/plugins/search.js";import{telemetryTraceStep as P}from"../../../../telemetry/helpers/trace-step.js";import{envConfig as _}from"../../../../config/env-config.js";import{logger as F}from"../../../../tools/notifiers/logger.js";import{ensureDir as E}from"../../../../utils/index.js";class X{#e=null;#o="";#t=[{name:"title",type:"string",facet:!1,optional:!0},{name:"text",type:"string",facet:!1,optional:!0},{name:"path",type:"string[]",facet:!1,optional:!0},{name:"isAdditionalOperation",type:"bool",facet:!1,optional:!0,queryable:!1},{name:"deprecated",type:"bool",facet:!1,optional:!0,queryable:!1},{name:"parameters",type:"object[]",facet:!1,optional:!0},{name:"parameters.name",type:"string[]",facet:!1,optional:!0,queryable:!1},{name:"parameters.description",type:"string[]",facet:!1,optional:!0,queryable:!1},{name:"parameters.place",type:"string[]",facet:!1,optional:!0,queryable:!1},{name:"parameters.path",type:"string[]",facet:!1,optional:!0,queryable:!1},{name:q,type:"string",facet:!0,optional:!0},{name:h,type:"object",facet:!0,optional:!0},{name:T,type:"string[]",facet:!0},{name:"metadata_curated",type:"bool",facet:!1,optional:!0,queryable:!1},{name:"metadata_keywords_excludes",type:"string[]",facet:!1,optional:!0,queryable:!1},{name:"metadata_keywords_includes",type:"string[]",facet:!1,optional:!0,queryable:!1}];#s=new Map;#r={ORGANIZATION_ID:_.ORGANIZATION_ID??"",PROJECT_ID:_.PROJECT_ID??"",TYPESENSE_API_URL:_.TYPESENSE_API_URL??"",TYPESENSE_API_KEY:_.TYPESENSE_API_KEY??""};constructor(){if(!_.isBuildMode){for(const[e,t]of Object.entries(this.#r))if(!t)throw new Error(`Cannot initialize search index. ${e} is not set`);this.#o=`${this.#r.ORGANIZATION_ID}_${this.#r.PROJECT_ID}_`,this.#e=new N({nodes:[{url:this.#r.TYPESENSE_API_URL}],apiKey:this.#r.TYPESENSE_API_KEY,connectionTimeoutSeconds:5})}}async initIndexSchema(e){this.#_(e)}async addDocuments(e,t){const{locale:s,outDir:a}=t,r=e.map(n=>{const o={...n},c=n[j];return c&&(c.curated&&(o.metadata_curated=c.curated),c.excludes&&(o.metadata_keywords_excludes=c.excludes),c.includes&&(o.metadata_keywords_includes=c.includes)),o}),i=this.#s.get(s)??[];this.#s.set(s,i.concat(r)),i.length+e.length>=k&&await this.exportDocuments(a)}async search(e,t){return await P("com.redocly.search.performed",async s=>{s?.setAttribute("id","searchQueryId"),s?.setAttribute("object","searchQuery"),s?.setAttribute("uri","urn:redocly:realm:api:searchQuery:searchQueryId");const{query:a,locale:r,filter:i,loadMore:n}=e,o=this.#u(r),c={collection:o,q:a||"*",query_by:this.#f(),max_facet_values:y};if(s?.setAttribute("collectionName",o),s?.setAttribute("locale",r),this.#e)if(n){const{groupKey:l,offset:u}=n,f={offset:u,filter_by:this.#a(t,i),facet_by:"*",per_page:O};return s?.setAttribute("isLoadMore",!0),s?.setAttribute("filter",f.filter_by),this.#p(await this.#e.collections(o).documents().search({...c,...f}),l)}else{const l=this.#a(t,i);s?.setAttribute("filter",l);const u=await this.#e.multiSearch.perform({searches:this.#b(t,i)},c),f=this.#i(u,this.#t.filter(p=>p.facet).map(p=>p.name));f&&F.warn("Search facet requests failed: %s",f);const m=this.#m(u),d=(m[A]??[]).map(p=>p.value);s?.setAttribute("groups",d.join(",")),d.length===y&&F.warn("Search category facet list reached the limit of %s; results for some categories may be missing",y);const I=[...new Set(this.#h(i))].slice(0,y),g=I.length?I:d;if(!g.length)return{facets:m,documents:{},groupCounts:{}};const $=await this.#e.multiSearch.perform({searches:g.map(p=>({filter_by:`${A}:=${this.#n(p)} && ${l}`,per_page:O}))},c),S=this.#i($,g);return S&&F.warn("Search category requests failed: %s",S),this.#d($,g,m,i)}else return{facets:{},documents:{}}})}#p(e,t){const s={facets:{},documents:{[t]:[]},groupCounts:typeof e.found=="number"?{[t]:e.found}:{}};if(e.hits&&e.hits.length)for(const a of e.hits)s.documents[t].push({document:this.#c(a),highlight:this.#l(a)});return s}#m(e){const t={};if("results"in e){for(const s of e.results)if(s.facet_counts&&s.facet_counts.length)for(const a of s.facet_counts)t[a.field_name]=a.counts.map(r=>({value:r.value,count:r.count}))}return t}#i(e,t){return"results"in e?e.results.map((s,a)=>({result:s,label:t[a]})).filter(({result:s})=>"error"in s).map(({result:s,label:a})=>`${a}: ${s.error}`).join("; "):""}#d(e,t,s,a){const r={},i={facets:s,documents:{},groupCounts:r};for(const n of this.#h(a))i.documents[n]=[];return"results"in e&&e.results.forEach((n,o)=>{const c=t[o];typeof n.found=="number"&&(r[c]=n.found);const l=n.hits??[];l.length&&(i.documents[c]=l.map(u=>({document:this.#c(u),highlight:this.#l(u)})))}),i}#c(e){return this.#y(e)}#l(e){const t={},s=[];for(const[a,r]of Object.entries(e.highlight??{}))if(Array.isArray(r)){if(a==="path"){const i=r,n=[];for(const o of i)n.push(o.snippet);t.path=n}else if(a==="parameters"){const i=r;for(const n of i){let o=!1;for(const[c,l]of Object.entries(n))if(c!=="deepLink")if(Array.isArray(l))for(const u of l)u.matched_tokens?.length&&(o=!0);else l.matched_tokens?.length&&(o=!0);if(o){const c={name:n.name?.snippet||"",description:n.description?.snippet||"",place:n.place?.snippet||"",path:n.path?.map(l=>l?.snippet)||[]};t.parameters=[c];break}}}}else t[a]=r.snippet,s.push(a);for(const[a,r]of Object.entries(e.document))!s.includes(a)&&typeof r=="string"&&(t[a]=r.length>R?`${r.substring(0,R)}...`:r);return t.parameters||(t.parameters=[]),t}#y(e){let t;const s=Object.keys(e.highlight??{});for(const r of L)if(s.some(i=>i===r))return e.document;const a=e.highlight?.parameters;if(a){for(const r of a)for(const[i,n]of Object.entries(r))if(i!=="deepLink"){if(Array.isArray(n)){for(const o of n)if(o.matched_tokens?.length){t=r.deepLink?.snippet??t;break}}else if(n.matched_tokens?.length){t=r.deepLink?.snippet??t;break}}}if(t){const r=t.split("#")[1];return{...e.document,url:`${e.document.url}#${r}`}}return e.document}async exportDocuments(e){const t='{"documents":[',s=E(b.join(e,C));for(const[a,r]of this.#s){if(r.length===0)continue;const i=E(b.join(s,`${a}.json`)),n=!v(i),o=JSON.stringify(r).substring(1).slice(0,-1),c=n?t+o:","+o;await D(i,c,{encoding:"utf8"}),this.#s.set(a,[])}}async exportIndexes(e){const t=E(b.join(e,C));for(const s of this.#s.keys()){const a=E(b.join(t,`${s}.json`)),r=`],"schemaFields":${JSON.stringify(this.#t)}}`;await D(a,r,{encoding:"utf8"})}}async import(e){}async countFacets(e,t){return await P("com.redocly.search.facets",async s=>{s?.setAttribute("id","searchFacetsId"),s?.setAttribute("object","searchFacets"),s?.setAttribute("uri","urn:redocly:realm:api:searchFacets:searchFacetsId");const{locale:a,query:r,facetQuery:i,filter:n,field:o}=e,c=this.#u(a),l={q:r||"*",query_by:this.#f(),facet_by:"*",facet_query:this.#g(i,o),filter_by:this.#a(t,n,o),max_facet_values:y};if(s?.setAttribute("collectionName",c),s?.setAttribute("query",l.q),s?.setAttribute("facetQuery",l.facet_query),s?.setAttribute("filter",l.filter_by),this.#e){const u={},f=await this.#e.collections(c).documents().search(l);if(f.facet_counts&&f.facet_counts.length)for(const m of f.facet_counts)u[m.field_name]=m.counts.map(d=>({value:d.value,count:d.count,isCounterVisible:!!r||(n?.length||0)>0}));return u}else return{}})}#u(e){return`${this.#o}${e}`}#_(e){for(const[t,{queryable:s}]of e)this.#t.find(a=>a.name===t)||this.#t.push({queryable:s,name:t,type:"string",facet:!0,optional:!0})}#f(){return this.#t.filter(e=>e.facet?e.queryable:e.queryable!==!1).map(e=>e.name).join(",")}#n(e){return`\`${e.replaceAll("`","")}\``}#a(e,t,s){const a=`${T}:[${e.teams.map(i=>`'${i}'`).join(", ")}]`;let r=`${h}.isDefault:true`;if(t&&t.length){const i=t.filter(o=>o.field!==s&&o.field!==h).map(o=>{const c=o.values.map(l=>this.#n(l));return c.length?`${o.field}:=[${c.join(", ")}]`:""}).join(" && "),n=t.find(o=>o.field===h);if(n&&n.values.length&&n.values.length===2){const o=n.values[0],c=n.values[1],l=`(${h}.folderId:! ${o} && ${h}.isDefault:true)`,u=`(${h}.folderId: ${o} && ${h}.version:=${this.#n(c)})`;r=`(${l} || ${u})`}return i?`${a} && ${i} && ${r}`:`${a} && ${r}`}else return`${a} && ${r}`}#g(e,t){return e&&t?`${t}:${e}`:""}#h(e){const t=[];if(e&&e.length)for(const s of e)s.field===A&&t.push(...s.values);return t}#b(e,t){const s=[],a=this.#t.filter(r=>r.facet);for(const r of a){const i={facet_by:r.name,filter_by:this.#a(e,t,r.name)};s.push(i)}return s}cleanupFacetValues(e){const t=e.getSearchFacets();t.forEach(s=>{s.values=[]}),e.setSearchFacets(t)}}export{X as Typesense};

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

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

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

@@ -0,0 +1 @@
+import{DEFAULT_SEARCH_ENGINE as o,REDOCLY_TEAMS_RBAC as u}from"@redocly/config";import{envConfig as i}from"../../config/env-config.js";import{logger as E}from"../../tools/notifiers/logger.js";import{reporter as S}from"../../tools/notifiers/reporter.js";import{prepareSearchDocuments as b}from"./documents/search-documents.js";import{SearchEngine as D}from"./engines/search-engine.js";import{prepareSemanticDocuments as y}from"./ai-indexer/prepare-semantic-documents.js";import{isAiSearchEnabled as A,shouldGenerateEmbeddings as C,shouldIndexSearchDocuments as w}from"./utils.js";import{telemetryTraceStep as R}from"../../../cli/telemetry/helpers/trace-step.js";import{EntitlementsProvider as _}from"../../entitlements/entitlements-provider.js";async function P(){let e=!0;return{async afterRoutesCreated(t,n){(i.SEARCH_DEV_REINIT||e)&&await v(t,n),e=!1},id:"search"}}async function v(e,t){await R("com.redocly.build.plugin.search",async n=>{const r=e.getConfig();if(n?.setAttribute("config",JSON.stringify(r.search||{})),r.search?.hide){E.info("Search is disabled in the config, skipping");return}const m=r.search?.engine||o,s=i.isDevelopMode?i.SEARCH_DEV_DEBUG?m:o:m,{l10n:l}=e.getGlobalData(),h=A(r),c=r.access?.rbac?.features?.aiSearch,d=C(r);let a;try{a=new D(s,l)}catch(p){await S.panic(p);return}await a.initIndexSchema(e.getSearchFacets()),e.setSearchEngine(a),e.setGlobalData({searchFeatures:{advanced:{enabled:s!==o&&!r.search?.filters?.hide},ai:{enabled:h,[u]:c&&Object.keys(c).length?c:void 0}}}),w(s)&&await b(t.fs,e,a);const f=_.instance(),g=!i.isDevelopMode&&f.canAccessFeature("seo")===!0&&r.seo?.llmstxt?.hide!==!0;await y(e,t,{embeddingsEnabled:d,writeLlmstxtFiles:g})})}export{P as searchPlugin};

package/dist/server/plugins/search/llmstxt/build-page-llms-txt-md.d.ts

@@ -0,0 +1,4 @@
+import type { SeoConfig } from '@redocly/config';
+import type { LLMsTxt } from './types.js';
+export declare function buildPageLlmsTxtMd(llmsTxt: LLMsTxt, seoConfig: SeoConfig | undefined): string;
+//# sourceMappingURL=build-page-llms-txt-md.d.ts.map

package/dist/server/plugins/search/llmstxt/build-page-llms-txt-md.js

@@ -0,0 +1,3 @@
+import{envConfig as t}from"../../../config/env-config.js";import{buildAgentFeedbackLlmsFooter as r}from"../../../utils/llmstxt/agent-feedback-llms-footer.js";function d(n,e){const o=t.REDOCLY_EXP_LLMSTXT_AGENT_FEEDBACK_ENABLED?r(e,n.slug):void 0;return`${n.content}${o?`
+
+${o}`:""}`}export{d as buildPageLlmsTxtMd};

package/dist/server/plugins/search/llmstxt/create-llms-txt-generator.d.ts

@@ -0,0 +1,4 @@
+import type { Store } from '../../../store';
+import type { LifecycleContext, LlmsTxtGenerator } from '../../../types';
+export declare function createLlmsTxtGenerator(store: Store, context: LifecycleContext): LlmsTxtGenerator;
+//# sourceMappingURL=create-llms-txt-generator.d.ts.map

package/dist/server/plugins/search/llmstxt/create-llms-txt-generator.js

@@ -0,0 +1 @@
+import p from"node:path";import{logger as f}from"../../../tools/notifiers/logger.js";import{promiseMapLimit as x}from"../../../utils/async/promise-map-limit.js";import{getLlmsTxtMdPathBySlug as L}from"../../../utils/llmstxt/get-llms-txt-md-path-by-slug.js";import{getRouteStaticData as T}from"../../../utils/get-route-static-data.js";import{getRouteAiDocumentsStore as w}from"../../../utils/get-route-ai-documents-store.js";import{generateLLMsTxt as h,validateLLMsTxtConfig as M}from"./index.js";import{buildPageLlmsTxtMd as S}from"./build-page-llms-txt-md.js";import{getLlmsTxtExcludeMatcher as m}from"./get-llms-txt-exclude-matcher.js";import{isIncludedInLlmsTxt as R}from"./is-included-in-llms-txt.js";import{EntitlementsProvider as C}from"../../../entitlements/entitlements-provider.js";const A=20;function v(i,c){const a=new WeakMap,l=()=>{const t=i.getGlobalConfig("seo");return C.instance().canAccessFeature("seo")===!0&&t?.llmstxt?.hide!==!0},d=async t=>{if(t.excludeFromSearch)return[];const e=i,n=await T(t,e);return await(await w(t,n,c,e))?.getLLMsTxts()??[]},u=t=>{const e=a.get(t);if(e)return e;const n=d(t).catch(o=>(a.delete(t),f.warn(`Failed to generate Markdown for LLMs of "${t.slug}". ${o}`),[]));return a.set(t,n),n},g=t=>{const e=t==="/index.html.md"?"/":t.replace(/\.md$/,"");for(let n=e;n.startsWith("/");){const o=i.getRouteBySlug(n,{followRedirect:!1});if(o?.getAiDocumentsStore)return o;const r=p.posix.dirname(n);if(r===n)return;n=r}};return{async getPageMarkdown(t){if(!l())return;const e=g(t);if(!e)return;const n=i.getGlobalConfig("seo"),o=m(n),r=(await u(e)).find(s=>L(s.slug)===t&&!o(s.fsPath));if(r)return{route:e,content:S(r,n)}},async getLlmsTxt(){if(!l())return;const t=i.getConfig(),e=i.getGlobalConfig("seo"),n=m(e),o=[];if(await x(i.getAllRoutes(),A,async r=>{for(const s of await u(r))!n(s.fsPath)&&R(s,r,t)&&o.push(s)}),!!o.length)try{return M(e?.llmstxt),await h(o,e?.llmstxt,{title:e?.title,description:e?.description,siteUrl:e?.siteUrl},c)}catch(r){f.error(`Failed to generate llms.txt. ${r}`);return}}}}export{v as createLlmsTxtGenerator};

package/dist/server/plugins/search/llmstxt/get-llms-txt-exclude-matcher.d.ts

@@ -0,0 +1,4 @@
+import picomatch from 'picomatch';
+import type { SeoConfig } from '@redocly/config';
+export declare function getLlmsTxtExcludeMatcher(seoConfig: SeoConfig | undefined): picomatch.Matcher;
+//# sourceMappingURL=get-llms-txt-exclude-matcher.d.ts.map

package/dist/server/plugins/search/llmstxt/get-llms-txt-exclude-matcher.js

@@ -0,0 +1 @@
+import e from"picomatch";function l(t){return e(t?.llmstxt?.excludeFiles||[])}export{l as getLlmsTxtExcludeMatcher};

package/dist/server/plugins/search/llmstxt/index.d.ts

@@ -0,0 +1,16 @@
+import type { SeoConfig } from '@redocly/config';
+import type { LifecycleContext } from '../../../types';
+import type { LLMsTxt } from './types';
+export declare function generateLLMsTxt(llmstxts: LLMsTxt[], llmstxtConfig: SeoConfig['llmstxt'] | undefined, fallbackConfig: {
+    title?: string;
+    description?: string;
+    siteUrl: string | undefined;
+} | undefined, context: LifecycleContext): Promise<string>;
+export declare function llmsTxtLink({ title, description, slug, siteUrl, }: {
+    title: LLMsTxt['title'];
+    description: LLMsTxt['description'];
+    slug: LLMsTxt['slug'];
+    siteUrl?: string;
+}): string;
+export declare function validateLLMsTxtConfig(llmstxtConfig: SeoConfig['llmstxt']): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/server/plugins/search/llmstxt/index.js

@@ -0,0 +1,13 @@
+import d from"picomatch";import{dirname as T,resolve as $}from"node:path";import{access as x,readFile as E,constants as F}from"fs/promises";import{removeTrailingSlash as w}from"../../../../utils/url/remove-trailing-slash.js";import{logger as g}from"../../../tools/notifiers/logger.js";import{withPathPrefix as U}from"@redocly/theme/core/utils";import{envConfig as y}from"../../../config/env-config.js";import{getLlmsTxtMdPathBySlug as I}from"../../../utils/llmstxt/get-llms-txt-md-path-by-slug.js";const a="llms.txt",u="Table of contents";async function v(e,i,n={title:a,description:void 0},r){if(!i)return{title:n.title||a,description:n.description,details:void 0,sections:[{title:u,description:void 0,llmstxts:e}]};const s=i.title||n.title||a,l=i.description||n.description,t=await D(i,r),o=i.sections?.map(c=>{const{title:f,description:h,excludeFiles:m,includeFiles:L}=c,P=p(e,{excludeFiles:m,includeFiles:L});return{title:f,description:h,llmstxts:P}});return{title:s,description:l,details:t,sections:o||[{title:u,description:void 0,llmstxts:p(e,{includeFiles:["**/*"],excludeFiles:[]})}]}}async function D(e,i){const n=await i.getConfig();if(e?.details?.path&&n.configPath)try{const r=i.fs.getFileInfo(n.configPath);if(!r)throw new Error(`Config file ${n.configPath} not found`);const s=$(i.fs.cwd,T(r.relativePath),e.details.path);return await x(s,F.R_OK),E(s,"utf-8")}catch{throw new Error(`${e.details.path} is not accessible`)}if(e?.details?.content)return e.details.content}function p(e,i){const{excludeFiles:n,includeFiles:r}=i,s=n?.map(t=>d(t)),l=r?.map(t=>d(t));return e.filter(t=>s?.some(c=>c(t.fsPath))?!1:l?.some(c=>c(t.fsPath)))}async function b(e,i,n={title:a,description:void 0,siteUrl:void 0},r){const s=await v(e,i,n,r),l=n.siteUrl,t=[`# ${s.title}
+
+`];return s.description&&t.push(`> ${s.description}
+
+`),s.details&&t.push(`${s.details}
+
+`),s.sections.forEach(o=>{if(!o.llmstxts.length){g.warn(`llms.txt: No links found for section "${o.title}". Please check the includeFiles/excludeFiles patterns.`);return}t.push(`## ${o.title}
+`),o.description?t.push(`${o.description.replace(/(?<!\n)\n+$/,"")}
+
+`):t.push(`
+`),o.llmstxts.forEach(c=>{t.push(` - ${M({title:c.title,description:c.description,slug:I(c.slug),siteUrl:l})}`)}),t.push(`
+`)}),t.join("")}function M({title:e,description:i,slug:n,siteUrl:r}){const l=`${w(r?.trim()||y.REDOCLY_PUBLIC_URL||"")}${encodeURI(U(n))}`,t=i?.replace(/\s+/g," ").trim();return`[${e}](${l})${t?`: ${t}`:""}
+`}function j(e){if(e?.details?.path&&e?.details?.content)throw new Error('"details.path" and "details.content" are mutually exclusive. Please use only one of them.')}export{b as generateLLMsTxt,M as llmsTxtLink,j as validateLLMsTxtConfig};

package/dist/server/plugins/search/llmstxt/is-included-in-llms-txt.d.ts

@@ -0,0 +1,5 @@
+import type { RedoclyConfig, PageProps, PageStaticData } from '@redocly/config';
+import type { PageRouteDetails } from '../../../types';
+import type { LLMsTxt } from './types.js';
+export declare function isIncludedInLlmsTxt(llmsTxt: LLMsTxt, route: PageRouteDetails<PageStaticData, PageProps>, config: RedoclyConfig): boolean;
+//# sourceMappingURL=is-included-in-llms-txt.d.ts.map

package/dist/server/plugins/search/llmstxt/is-included-in-llms-txt.js

@@ -0,0 +1 @@
+import{isResourcePubliclyAccessible as i}from"../../../utils/rbac.js";function o(e,n,c){return!!e.includeInLLMsTxt&&i(n,c)}export{o as isIncludedInLlmsTxt};

package/dist/server/plugins/search/llmstxt/types.d.ts

@@ -0,0 +1,21 @@
+export type LLMsTxt = {
+    content: string;
+    title: string;
+    description?: string;
+    slug: string;
+    fsPath: string;
+    includeInLLMsTxt: boolean;
+};
+type LLMsTxtSection = {
+    title: string;
+    description: string | undefined;
+    llmstxts: LLMsTxt[];
+};
+export type LLMsTxtsConfigBasedHierarchy = {
+    title: string;
+    description: string | undefined;
+    details: string | undefined;
+    sections: LLMsTxtSection[];
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/server/plugins/search/types.d.ts

@@ -0,0 +1,7 @@
+import type { AiSearchDocument } from '../../types';
+import type { LLMsTxt } from './llmstxt/types';
+export type AiDocumentsStore = {
+    getLLMsTxts: () => Promise<LLMsTxt[]>;
+    getSearchDocuments: () => Promise<AiSearchDocument[]>;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/server/plugins/search/utils.d.ts

@@ -0,0 +1,8 @@
+import type { RedoclyConfig, SearchEngineType } from '@redocly/config';
+export declare function isAiSearchEnabled(config: RedoclyConfig): boolean;
+export declare function isDocsMcpEnabled(config: RedoclyConfig): boolean;
+export declare function shouldGenerateEmbeddings(config: RedoclyConfig): boolean;
+export declare function shouldIndexSearchDocuments(engine: SearchEngineType): boolean;
+export declare function getSearchDocumentGroup(documentFacets?: Record<string, string>): string | undefined;
+export declare function formatDocumentMetadata(metadata?: Record<string, unknown>): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/server/plugins/search/utils.js

@@ -0,0 +1,2 @@
+import{SEARCH_GROUP_FACET_FIELD as o}from"../../../constants/common.js";import{DEFAULT_AI_SEARCH_ENABLED as s}from"../../constants/plugins/search.js";import{isPrimitive as c}from"../../../utils/guards/is-primitive.js";import{envConfig as n}from"../../config/env-config.js";import{EntitlementsProvider as i}from"../../entitlements/entitlements-provider.js";function a(e){if(n.isDevelopMode)return n.SEARCH_DEV_DEBUG;if(!i.instance().canAccessFeature("aiSearchLimit"))return!1;const t=e.aiAssistant;return typeof t?.hide=="boolean"?!t?.hide:s}function u(e){return i.instance().canAccessFeature("mcp")?!e.mcp?.hide&&!e.mcp?.docs?.hide:!1}function S(e){const r=a(e),t=u(e);return(r||t)&&n.isProductionEnv}function l(e){return e==="typesense"?!n.REDOCLY_SKIP_TYPESENSE_INDEXING:!0}function A(e){let r;return e&&Object.keys(e).forEach(t=>{t===o&&(r=e[t])}),r}function D(e){return Object.entries(e||{}).map(([r,t])=>`  - ${r}: ${c(t)?t:JSON.stringify(t)}`).join(`
+`)}export{D as formatDocumentMetadata,A as getSearchDocumentGroup,a as isAiSearchEnabled,u as isDocsMcpEnabled,S as shouldGenerateEmbeddings,l as shouldIndexSearchDocuments};

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

@@ -0,0 +1,7 @@
+import type { LifecyclePluginInstance, PluginOptions } from '../../types';
+import type { ResolvedNavItem } from '@redocly/config';
+import type { ContentFs } from '../../fs/content-fs.js';
+export declare function sidebarsPlugin({ contentDir, }: PluginOptions): Promise<LifecyclePluginInstance>;
+export declare function stripMarkdocFromDescriptions(items: ResolvedNavItem[]): void;
+export declare function resolveSidebarId(relativePath: string, sidebarPath: string, fs: ContentFs): Promise<string | null>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,7 @@
+import{writeFileSync as at}from"node:fs";import*as g from"path";import{removeMarkdocTags as nt}from"../../../markdoc/helpers/remove-markdoc-tags.js";import{withoutHash as it}from"@redocly/theme/core/utils";import{DEFAULT_LOCALE_PLACEHOLDER as E,SIDEBAR_PREFIX as st,CONFIG_FILE_NAME as Y}from"../../../constants/common.js";import{CATALOG_OUTPUT_FILE_NAME as lt}from"../../constants/common.js";import{findDeepFirst as B}from"../../../utils/tree/find-deep-first.js";import{isDefined as M}from"../../../utils/guards/is-defined.js";import{partition as ct}from"../../../utils/array/partition.js";import{collectPropValueDeep as N}from"../../../utils/tree/collect-prop-value-deep.js";import{envConfig as ft}from"../../config/env-config.js";import{isLocalLink as ut}from"../../../utils/path/is-local-link.js";import{normalizeRouteSlug as J}from"../../../utils/path/normalize-route-slug.js";import{slash as dt}from"../../../utils/path/slash.js";import{parsePathVersions as mt}from"../../../utils/path/parse-path-versions.js";import{reporter as I}from"../../tools/notifiers/reporter.js";import{logger as $}from"../../tools/notifiers/logger.js";import{sha1 as gt}from"../../utils/crypto/sha1.js";import{getCatalogSharedDataId as pt}from"../../utils/catalog-classic/get-catalog-shared-data-id.js";import{collectItemsLinkedToSidebars as ht,resolveItems as q}from"../nav-utils.js";import{getExcludedFromLinkCheckerPatterns as yt,getSidebarReferences as St,hasCircularDependency as bt}from"./utils.js";import{collectTabRoutes as vt,findDuplicateRoutes as It,hasTabs as Dt,resolveTabs as Ft,tabsAsGroups as Ct,validateTabs as wt}from"./tabs.js";import{getLocaleFromRelativePath as Pt}from"../../fs/utils/get-locale-from-relative-path.js";import{isSystemRouteSlug as Et}from"../../utils/system-routes.js";import{ENTITIES_MAP_GLOBAL_DATA_KEY as Rt}from"../../constants/plugins/catalog-entities.js";import{telemetryTraceStep as At}from"../../../cli/telemetry/helpers/trace-step.js";import{isPathIgnored as kt}from"../../utils/paths.js";const Lt=180,Tt=170,_t=10;async function ce({contentDir:u}){return{id:"sidebars",async afterRoutesCreated(a,c){await At("com.redocly.build.plugin.sidebars",async()=>{const{cache:h,fs:d}=c,D=a.getConfig(),F=new Map,C=new Set,G=[E,...d.localeFolders],x=a.getGlobalData()[Rt]||{},j=new Map;let L=d.scan(/sidebars.yaml$/).map(({relativePath:t})=>t).filter(t=>!kt(t,D.ignore??[])&&t);const H=await St(c,u,L),Z=ct(L.filter(t=>!H.has(t)),t=>{const i=mt(t);return i?`@versioned/${i.versionFolderPath}\0${i.filePathInVersion}`:t}),T=yt(D),tt=await ht(D?.navbar,a,c,{navFile:Y,excludedFromLinkCheckerPatterns:T});let w;const _=bt(H);_&&Array.isArray(_)&&await I.panicOnBuildContentError(`Sidebar references have circular dependency. Please check your sidebar files.
+            Circular dependency chain: ${_.reverse().join(" -> ")}
+          `);for(const t of Z){const i=(await Promise.all(t.map(async r=>{const e=(await h.load(r,"yaml")).data;if(!Array.isArray(e)){await I.panicOnBuildContentErrorForRealFile('Invalid sidebar contents at %rp, items should be an array, got "%s"',r,d,r,typeof e);return}return{items:e,sidebarRelativePath:r,locale:Pt(r)}}))).filter(M),o=(await A(i))?.firstLink;w||(w=o)}const U=Object.entries(D?.catalogClassic??{});for(const t of G){for(const[e,s]of U)await K(e,s,t);const i={},o=new Set,r=a.getAllRoutesForLocale(t);for(const e of r)if(z(e)&&e.fsPath&&!o.has(e.fsPath)){o.add(e.fsPath);let l=g.posix.dirname(e.fsPath);const f=g.parse(l).root;do i[l]=(i[l]||0)+1,l=g.dirname(l);while(l&&l!="."&&f!=l)}for(const e of r){if(F.has(e.slug))continue;const s=z(e),l=g.dirname(e.fsPath),f=i[l]===1,m=Mt(e.baseSlug||e.slug);s&&f?await A([{items:[{directory:l}],sidebarRelativePath:"sidebar.yaml_"+m,locale:t}]):e.getSidebar!==void 0&&await A([{items:[{page:e.fsPath}],sidebarRelativePath:"sidebar.yaml_"+m,locale:t}])}for(const[e,s]of U)await K(e,s,t,!0)}if(L.length===0)for(const t of G){$.verbose("Creating default sidebar");const i=t===E,o=`sidebars.yaml${i?"":"_"+t}`,r=i?"":`${d.localizationFolder}/${t}`,e=(await A([{items:[{directory:`./${r}`}],sidebarRelativePath:o,locale:t,ignoredRoutes:C}]))?.firstLink;w||(w=e)}if(!a.getRouteBySlug("/")&&!a.getConfig().redirects?.["/"]){const i=a.getAllRoutes().find(r=>!Et(r.slug)),o=w?w.link:i?.baseSlug??null;if(o){const r=it(o);a.addRedirect("/",{to:r,type:302}),$.info("Creating default redirect for index page => %s",r)}}const W=ft.REDOCLY_METADATA_OUTPUT_FOLDER;W&&($.info("Writing catalog data..."),at(g.join(W,lt),JSON.stringify(Object.fromEntries(j.entries()))));function z(t){return C.has(t.slug)||x[t.fsPath]}async function A(t){if(t.length===0)return;const i=t.map(({items:e})=>Dt(e)),o=i.some(Boolean);if(o&&!i.every(Boolean)){await I.panicOnBuildContentError("Versioned copies of %rp must either all use navigation tabs or none of them",t[0].sidebarRelativePath);return}const r=o?await ot(t):await et(t);if(r)return rt(t[0].sidebarRelativePath,r)}async function et(t){const o=(await Promise.all(t.map(async({items:r,locale:e,sidebarRelativePath:s,ignoredRoutes:l})=>{const{fromDir:f,resolveOptions:m}=V(s,e,l),p=await q(r,f,a,c,m);if(!p){await I.panicOnBuild("Failed to resolve sidebar configuration. Make sure %rp is valid",s);return}return p}))).flat().filter(M);return{routeOwners:N(o,"routeSlug").map(r=>({routeSlug:r,items:o})),sharedData:{items:o},navItems:o}}async function ot(t){const i=t[0].sidebarRelativePath,r=(await Promise.all(t.map(async({items:l,locale:f,sidebarRelativePath:m,ignoredRoutes:p})=>{const y=wt(l);if(y.length){await I.panicOnBuildContentError(`Invalid navigation tabs in %rp:
+ - ${y.join(`
+ - `)}`,m);return}const{fromDir:k,resolveOptions:n}=V(m,f,p);return Ft(l,k,a,c,n)}))).flat().filter(M),e=vt(r),s=It(e);if(s.length){await I.panicOnBuildContentError(`Navigation tabs conflict in %rp. A route can belong to one tab only:
+ - ${s.map(({routeSlug:l,owners:f})=>`${l} is claimed by ${f.map(m=>`"${m}"`).join(" and ")}`).join(`
+ - `)}`,i);return}return{routeOwners:e,sharedData:{items:[],tabs:r},navItems:Ct(r)}}function V(t,i,o){return{fromDir:g.dirname(g.join(u,t)),resolveOptions:{locale:i,ignoredRoutes:o,navFile:t,excludedFromLinkCheckerPatterns:T}}}async function rt(t,{routeOwners:i,sharedData:o,navItems:r}){const e=Q(t),s=new Set;for(const{routeSlug:f,items:m}of i){const p=a.getRouteBySlug(f)?.fsPath??"",y=x[p];y&&(Array.from(s).find(n=>n.key===y.key&&n.version===y.version)||s.add(y)),a.addRouteSharedData(f,"sidebar",e),F.set(J(f),m)}const l=s.size===1?Array.from(s)[0]:void 0;return await a.createSharedData(e,{relatedNavbarItem:tt?.get(t),...o,catalogEntity:l?{key:l.key,version:l.version}:void 0}),{firstLink:B(r,f=>!!f.link),resolved:r}}async function K(t,i,o,r=!1){const e=structuredClone(i);o&&o!==E&&e.items.forEach(n=>{n.directory=g.posix.join(d.localizationFolder||"",o,n.directory||"")});let s=await q(e.items,u,a,c,{groupCustomSidebars:!0,locale:o,navFile:Y,excludedFromLinkCheckerPatterns:T});if(!s){await I.panicOnBuild(`Failed to resolve catalog configuration. Make sure catalog ${t} has valid config`);return}Bt(s);const l=o===E?"":"/"+o.toLowerCase(),f=o===E?"":`-${o}`,m=J(g.posix.join(l,e.slug));if(r)for(const n of s){const S=B(n.items||[],v=>!!v.routeSlug);if(!S?.routeSlug)continue;const b=F.get(S.routeSlug);if(!b)continue;const O=N(b,"routeSlug"),R="current-catalog-info-"+n.routeSlug+f,P={catalog:{label:e.title,titleTranslationKey:e.titleTranslationKey,link:m,icon:e?.icon},item:{label:n.metadata?.title,link:n.link,icon:n.icon}};await a.createSharedData(R,P);for(const v of O)a.addRouteSharedData(v,"current-catalog-info",R),C.add(v);const X=B(b,v=>!!v.link&&!v.external&&ut(v.link)&&(!n.version||v.version===n.version));X&&(n.sidebar=[{...X,items:void 0}])}const p={},y=new Set;for(const n of s){if(!(n.routeSlug||n.sidebar?.[0]?.routeSlug)||!n.fsPath||y.has(n.fsPath))continue;y.add(n.fsPath);const b=g.dirname(n.fsPath);p[b]=(p[b]||0)+1}if(r){const n=await a.createSharedData(pt(t,f),s.flatMap(S=>{const b=g.dirname(S.fsPath??""),O=p[b]===1,R=P=>({...P,fsPath:O?b:P.fsPath??""});return S.type==="group"&&S.items?.every(P=>P.type==="group")?(S.items||[]).map(R):R(S)}));a.addRouteSharedData(m,"catalog",n),Ot(o,s,j,p)}const k=N(s,"routeSlug");for(const n of k)C.add(n)}})}}}function Ot(u,a,c,h){if(u===E)for(const d of a){const D=d.routeSlug||d.sidebar?.[0]?.routeSlug;if(!D||!d.fsPath)continue;const F=g.dirname(d.fsPath),C=h[F]===1;c.set(D,{rootFileFsPath:d.fsPath,fsPath:C?F:d.fsPath,metadata:d.metadata||{},title:d.metadata?.title||d.label||"Untitled",version:d.version||"latest"})}}function Bt(u){const a=c=>{typeof c.metadata?.description=="string"&&(c.metadata={...c.metadata,description:nt(c.metadata.description)})};for(const c of u)if(c.routeSlug)a(c);else for(const h of c.items||[])a(h)}function Q(u){return st+dt(u)}async function fe(u,a,c){const h=g.posix.join(g.dirname(u),a);return await c.exists(h)?Q(h):(await I.panicOnBuildContentErrorForRealFile("File %rp: Failed to create relative path for sidebars.yaml using %s",u,c,u,a),null)}function Mt(u){const a=u.replaceAll("/","_");if(a.length>Lt){const c=a.slice(0,Tt),h=gt(u).slice(0,_t).replaceAll("/","_");return c+h}else return a}export{fe as resolveSidebarId,ce as sidebarsPlugin,Bt as stripMarkdocFromDescriptions};

package/dist/server/plugins/sidebars/tabs.d.ts

@@ -0,0 +1,19 @@
+import type { NavItem, ResolvedNavItem, ResolvedTab } from '@redocly/config';
+import type { LifecycleContext, ResolveItemsOptions } from '../../types';
+import type { ResolveLinkContext } from '../nav-utils';
+export type TabRoute = {
+    routeSlug: string;
+    owner: string;
+    items: ResolvedNavItem[];
+};
+export declare function hasTabs(items: NavItem[] | undefined): boolean;
+export declare function makeTabId(index: number, label: string): string;
+export declare function validateTabs(sidebarItems: NavItem[]): string[];
+export declare function resolveTabs(items: NavItem[], fromDir: string, actions: ResolveLinkContext, context: LifecycleContext, options: ResolveItemsOptions): Promise<ResolvedTab[]>;
+export declare function collectTabRoutes(tabs: ResolvedTab[]): TabRoute[];
+export declare function findDuplicateRoutes(routes: TabRoute[]): Array<{
+    routeSlug: string;
+    owners: string[];
+}>;
+export declare function tabsAsGroups(tabs: ResolvedTab[]): ResolvedNavItem[];
+//# sourceMappingURL=tabs.d.ts.map

package/dist/server/plugins/sidebars/tabs.js

@@ -0,0 +1 @@
+import{REDOCLY_ROUTE_RBAC as p,REDOCLY_TEAMS_RBAC as c}from"@redocly/config";import{collectPropValueDeep as v}from"../../../utils/tree/collect-prop-value-deep.js";import{isDefined as T}from"../../../utils/guards/is-defined.js";import{resolveItem as $,resolveItems as w}from"../nav-utils.js";function F(n){return Array.isArray(n)&&n.some(b)}function I(n,e){const a=e.normalize("NFKD").replace(/[\u0300-\u036f]/g,"").toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/^-+|(?<!-)-+$/g,"");return`${n}-${a||"tab"}`}function x(n){const e=[],a=n.filter(o=>!b(o));a.length&&e.push(`when a sidebar uses tabs, every top-level entry must be a tab; found ${a.length} other entr${a.length===1?"y":"ies"}: ${JSON.stringify(a)}`);for(const{tab:o,page:i,menu:r,items:f,$ref:t,directory:l,group:s,href:m}of n.filter(b)){const u=`tab "${o}"`;if(r!==void 0&&!Array.isArray(r)){e.push(`${u} "menu" must be a list of entries`);continue}i?.includes("#")&&e.push(`${u} page must not contain a heading anchor`),r&&f?e.push(`${u} cannot have both "menu" and "items"`):r&&i?e.push(`${u} has "menu" and cannot also have "page"`):!r&&!i&&e.push(`${u} needs "page" or "menu"`),(t||l||s||m)&&e.push(`${u} accepts only "page", "items", "menu" and "rbac"; move "$ref"/"directory"/"group"/"href" into "items"`),r?.length===0&&e.push(`${u} has an empty "menu"`),r?.forEach((d,y)=>{const h=`menu entry ${y+1} of ${u}`;d?.page||e.push(`${h} needs "page"`),d?.page?.includes("#")&&e.push(`${h} page must not contain a heading anchor`)});const g=[...r??[],...f??[]];v(g,"tab").length&&e.push(`${u} contains a nested "tab"; tabs are only allowed at the top level`),v(g,"menu").length&&e.push(`${u} contains a nested "menu"; "menu" is only allowed directly on a tab`)}return e}async function C(n,e,a,o,i){const r=[];for(const[f,t]of n.filter(b).entries()){const l=I(f,t.tab);if(t.menu){const g=(await Promise.all(t.menu.map((y,h)=>A(y,l,h,e,a,o,i)))).filter(T),d=t.icon?S(await $({group:t.tab,icon:t.icon,items:[]},e,a,o,i)):void 0;r.push({type:"tab",tabId:l,label:t.tab,labelTranslationKey:t.tabTranslationKey,menu:g,icon:d?.icon,srcSet:d?.srcSet,[c]:t.rbac});continue}const s=S(await $({group:t.tab,rbac:t.rbac,page:t.page,icon:t.icon,items:[]},e,a,o,i)),m=s?.routeSlug?a.getRouteBySlug(s.routeSlug):void 0,u=await w(t.items,e,a,o,i)??[];r.push({type:"tab",tabId:l,label:t.tab,labelTranslationKey:t.tabTranslationKey,link:s?.link,routeSlug:s?.routeSlug,fsPath:s?.fsPath,icon:s?.icon,srcSet:s?.srcSet,items:[...s?.items??[],...u],...k(m?.versions,s),[c]:t.rbac??s?.[c],[p]:s?.[p]})}return r}function M(n){return n.flatMap(e=>e.menu?e.menu.flatMap(a=>R(`${e.label} > ${a.label}`,a.routeSlug,a.items)):R(e.label,e.routeSlug,e.items??[]))}function N(n){const e=new Map;for(const{routeSlug:a,owner:o}of n){const i=a.split("#")[0],r=e.get(i)??new Set;r.add(o),e.set(i,r)}return[...e.entries()].filter(([,a])=>a.size>1).map(([a,o])=>({routeSlug:a,owners:[...o]}))}function O(n){return n.map(e=>({type:"group",label:e.label,labelTranslationKey:e.labelTranslationKey,link:e.link,routeSlug:e.routeSlug,fsPath:e.fsPath,version:e.version,isDefault:e.isDefault,versionFolderId:e.versionFolderId,items:e.menu??e.items??[],[c]:e[c],[p]:e[p]}))}function b(n){return typeof n?.tab=="string"}async function A(n,e,a,o,i,r,f){const t=S(await $({...n,group:n.label||n.page,items:[]},o,i,r,f));if(!t?.link)return;const l=t.routeSlug?i.getRouteBySlug(t.routeSlug):void 0,s=n.label||await l?.getNavText?.()||t.link,m=await w(n.items,o,i,r,f)??[],u=[...t.items??[],...m];return{type:"link",tabId:`${e}/${I(a,s)}`,label:s,labelTranslationKey:n.labelTranslationKey,link:t.link,routeSlug:t.routeSlug,fsPath:t.fsPath,metadata:t.metadata,icon:t.icon,srcSet:t.srcSet,badges:t.badges,items:u,...k(l?.versions,t),[c]:n.rbac??l?.[c]??t[c],[p]:t[p]}}function S(n){const e=Array.isArray(n)?n[0]:n;return e?.type==="group"?e:void 0}function k(n,e){const a=n?.find(o=>o.active);return a?{version:a.version,isDefault:a.default,versionFolderId:a.folderId}:e?.version===void 0?{}:{version:e.version,isDefault:e.isDefault,versionFolderId:e.versionFolderId}}function R(n,e,a){return[e,...v(a,"routeSlug")].filter(T).map(o=>({routeSlug:o,owner:n,items:a}))}export{M as collectTabRoutes,N as findDuplicateRoutes,F as hasTabs,I as makeTabId,C as resolveTabs,O as tabsAsGroups,x as validateTabs};

package/dist/server/plugins/sidebars/utils.d.ts

@@ -0,0 +1,9 @@
+import type { RedoclyConfig } from '@redocly/config';
+import type { LifecycleContext } from '../../types';
+export declare function getSidebarReferences({ fs, cache }: LifecycleContext, contentDir: string, sidebarFiles: string[]): Promise<Map<string, string>>;
+export declare function hasCircularDependency(references: Map<string, string>): boolean | string[];
+export declare function getExcludedFromLinkCheckerPatterns(config: RedoclyConfig): {
+    apiFunctions: RegExp[];
+    catalog: RegExp[];
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/server/plugins/sidebars/utils.js

@@ -0,0 +1 @@
+import s from"path";import{collectPropValueDeep as g}from"../../../utils/tree/collect-prop-value-deep.js";import{removeTrailingSlash as f}from"../../../utils/url/remove-trailing-slash.js";import{slash as C}from"../../../utils/path/slash.js";import{removeLeadingSlash as u}from"../../../utils/url/remove-leading-slash.js";import{reporter as p}from"../../tools/notifiers/reporter.js";import{getCompleteCatalogConfig as h}from"../catalog-entities/get-complete-catalog-config.js";async function k({fs:r,cache:i},e,n){let a=new Map;for(const t of n){if(!await r.exists(t))continue;const o=s.dirname(s.join(e,t)),m=(await i.load(t,"yaml")).data;try{const c=g(m,"$ref");for(const d of c){const l=C(s.relative(e,s.join(o,d)));a.has(l)&&await p.panicOnBuildContentError(`Sidebar reference '${l}' was used multiple times.`),a.set(l,t)}}catch(c){if(c.message.includes("not iterable")){await p.panicOnBuildContentErrorForRealFile('Invalid sidebar format at %rp, "items" should be an array',t,r,t);continue}throw c}}return a}function v(r){function i(e,n){if(n.includes(e))return[...n,e];const a=r.get(e);if(a){const t=i(a,[...n,e]);if(t)return t}return!1}for(const e of r.keys()){const n=i(e,[]);if(n)return n}return!1}function P(r){const i=r.apiFunctions?.folders?.map(o=>new RegExp(`^/?(${u(f(o))})(/|$)`))||[],e=[new RegExp("^/?(api)(/|$)")],n=h(r.entitiesCatalog),t=Object.values(n?.catalogs||{}).map(o=>o?.slug?new RegExp(`^/?(catalogs\\/${u(f(o?.slug||""))})(/|$)`):null).filter(o=>o!==null);return{apiFunctions:[...i,...e],catalog:t}}export{P as getExcludedFromLinkCheckerPatterns,k as getSidebarReferences,v as hasCircularDependency};

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

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

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

@@ -0,0 +1 @@
+import{SitemapStream as l,streamToPromise as d}from"sitemap";import{Readable as p}from"stream";import{writeFileSync as y}from"fs";import g from"path";import{SITEMAP_FILE_NAME as h}from"../../constants/common.js";import{ServerRoutes as w}from"../../../constants/api.js";import{withPathPrefix as P}from"@redocly/theme/core/utils";import{logger as s}from"../../tools/notifiers/logger.js";import{isResourcePubliclyAccessible as b}from"../../utils/index.js";import{telemetryTraceStep as S}from"../../../cli/telemetry/helpers/trace-step.js";async function R(t,n){if(!t)return;const r=t.endsWith(".tsx"),i=t.endsWith(".md");if(!(!r&&!i))try{const o=r?"react-frontmatter":"markdown-frontmatter",e=await n.load(t,o);return e.data.frontmatter?.seo?.priority??e.data.seo?.priority}catch{return}}async function v(t,n){const r=t.fsPath?await R(t.fsPath,n):void 0;if(typeof r=="number"){if(r>=0&&r<=1)return r;s.warn(`Invalid SEO priority value "${r}" found for route "${t.slug}". Priority must be between 0 and 1. Using default priority instead.`)}const i=t.versions?.find(o=>o.active);return i?.default||!i?.5:.3}async function $(){return{id:"sitemap",async afterRoutesCreated(t,n){await S("com.redocly.build.plugin.sitemap",async r=>{const{seo:i}=t.getConfig();if(r?.setAttribute("config",JSON.stringify(i||{})),!i?.siteUrl)return;const o=t.getAllRoutes().filter(e=>!e.excludeFromSearch&&b(e,t.getConfig())&&!Object.keys(w).includes(e.slug));if(o.length)try{const e=g.join(t.outdir,h),m=new l({hostname:i.siteUrl}),c=await Promise.all(o.map(async a=>{const u=await v(a,n.cache);return{url:P(a.slug),priority:u}})),f=await d(p.from(c).pipe(m)).then(a=>a.toString());y(e,f),t.hasSitemap=!0}catch(e){r?.error(e),s.error(`Error creating sitemap: ${e.message}`)}})}}}export{$ as sitemapPlugin};

package/dist/server/plugins/skills/discover-skills.d.ts

@@ -0,0 +1,17 @@
+import type { Skill } from '../../types/plugins/skills.js';
+type DiscoverSkillsInput = {
+    cwd: string;
+    excludeFiles?: string[];
+};
+/**
+ * Produce the full, unfiltered skill set: one skill per `@skills/<folder>/SKILL.md`
+ * plus an optional root `SKILL.md`. Slugs must be unique: the root skill wins over a
+ * colliding `@skills` entry.
+ *
+ * Skill filenames in folders are matched case-insensitively against directory listings,
+ * so behavior is identical on case-sensitive and case-insensitive filesystems — the
+ * lowercase served path is a routing concern, not an authoring rule.
+ */
+export declare function discoverSkills(input: DiscoverSkillsInput): Promise<Skill[]>;
+export {};
+//# sourceMappingURL=discover-skills.d.ts.map

package/dist/server/plugins/skills/discover-skills.js

@@ -0,0 +1 @@
+import k from"picomatch";import{readdir as w,readFile as F}from"fs/promises";import p from"node:path";import{USER_SKILLS_ALIAS as h,USER_SKILL_FILENAME as u}from"../../../constants/common.js";import{logger as S}from"../../tools/notifiers/logger.js";import{slug as y}from"../../../utils/slugger.js";import{envConfig as L}from"../../config/env-config.js";import{parseSkill as j}from"./utils/parse-skill.js";const E="project-docs";async function M(t){const{cwd:s,excludeFiles:e=[]}=t,o=L.PROJECT_SLUG||E,l=e.map(r=>k(r)),c=new Map,d=await g(p.join(s,u)),i=d!==void 0?[{slug:o,fsPath:u,content:d}]:[],a=await _({cwd:s,baseSegments:[h]});for(const r of[...a,...i]){if(l.some(m=>m(r.fsPath)))continue;const n=j(r);if("error"in n){S.warn(n.error);continue}const f=c.get(n.slug);f!==void 0&&S.warn(`Skill "${n.slug}" from "${f.fsPath}" is replaced by "${n.fsPath}".`),c.set(n.slug,n)}return Array.from(c.values())}async function _(t){const{cwd:s,baseSegments:e}=t,o=p.join(s,...e),l=[],c=new Map,d=await P(o);for(const i of d){const a=y(i,{replaceDots:!0}),r=c.get(a);if(r!==void 0){S.warn(`Skipping skill folder "${[...e,i].join("/")}": its slug "${a}" collides with the folder "${r}" after slugification.`);continue}const n=await I(p.join(o,i)),f=$(n,[...e,i].join("/"));if(f===void 0)continue;const m=await g(p.join(o,i,f));m!==void 0&&(c.set(a,i),l.push({slug:a,fsPath:[...e,i,f].join("/"),content:m}))}return l}function $(t,s){const e=t.filter(l=>l.toLowerCase()===u.toLowerCase()),o=e.includes(u)?u:e[0];return e.length>1&&S.warn(`Multiple skill files in "${s}" differ only by case; using "${o}".`),o}async function g(t){try{return await F(t,"utf-8")}catch{return}}async function P(t){try{return(await w(t,{withFileTypes:!0})).filter(e=>e.isDirectory()).map(e=>e.name).sort()}catch{return[]}}async function I(t){try{return(await w(t,{withFileTypes:!0})).filter(e=>e.isFile()).map(e=>e.name).sort()}catch{return[]}}export{M as discoverSkills};

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

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

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

@@ -0,0 +1 @@
+import{discoverSkills as r}from"./discover-skills.js";async function o(){return{id:"skills",async afterRoutesCreated(s,l){const e=s.getConfig();if(e.skills?.hide===!0)return;const i=await r({cwd:l.fs.cwd,excludeFiles:e.skills?.excludeFiles??[]});s.addSkills(i),l.logger.verbose(`Discovered ${i.length} skill(s)`)}}}export{o as skillsPlugin};

package/dist/server/plugins/skills/utils/parse-skill.d.ts

@@ -0,0 +1,18 @@
+import type { Skill } from '../../../types/plugins/skills.js';
+type ParseSkillInput = {
+    slug: string;
+    fsPath: string;
+    content: string;
+};
+type ParseSkillError = {
+    error: string;
+};
+/**
+ * @param input - the skill slug, its project-relative path, and the raw file content
+ * @returns the parsed `Skill` with a `sha256:<hex>` digest over the raw content,
+ * or a `{ error }` object when the frontmatter is invalid or the required
+ * `name`/`description` fields are missing
+ */
+export declare function parseSkill(input: ParseSkillInput): Skill | ParseSkillError;
+export {};
+//# sourceMappingURL=parse-skill.d.ts.map

package/dist/server/plugins/skills/utils/parse-skill.js

@@ -0,0 +1 @@
+import{extractFrontmatter as p}from"../../markdown/extract-frontmatter.js";import{shaHex as d}from"../../../utils/crypto/sha-hex.js";function u(s){const{slug:a,fsPath:t,content:e}=s,{frontmatter:r,frontmatterError:i}=p(e);if(i)return{error:`Invalid frontmatter in ${t}: ${i}`};const n=typeof r.name=="string"?r.name.trim():"",o=typeof r.description=="string"?r.description.trim():"";if(!n)return{error:`Skill ${t} is missing required frontmatter "name"`};if(!o)return{error:`Skill ${t} is missing required frontmatter "description"`};const c=r.rbac&&typeof r.rbac=="object"&&!Array.isArray(r.rbac)?r.rbac:void 0,f=Array.isArray(r.tags)?r.tags.filter(m=>typeof m=="string"):[];return{slug:a,name:n,description:o,content:e,digest:`sha256:${d(e)}`,fsPath:t,rbac:c,tags:f}}export{u as parseSkill};

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

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

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

@@ -0,0 +1 @@
+import{AuthProviderType as A}from"@redocly/config";import{DEFAULT_SSO_IDP_TITLE as I}from"../../../constants/common.js";import{envConfig as d}from"../../config/env-config.js";import{telemetryTraceStep as C}from"../../../cli/telemetry/helpers/trace-step.js";import{logger as O}from"../../tools/notifiers/logger.js";const T="https://auth.cloud.redocly.com/oidc/.well-known/openid-configuration",_="https://auth.cloud.redocly.com/api/sso/oidc/introspect";async function U(h){return{id:"sso",async processContent(i){await C("com.redocly.build.plugin.sso",async f=>{const o=i.getConfig(),s=o.access;if(f?.setAttribute("config",`{"ssoDirect": ${JSON.stringify(o.ssoDirect||{})}}, {"sso": ${JSON.stringify(s?.sso||{})}}, {"idps": ${JSON.stringify(s?.idps||{})}}`),o.ssoDirect&&typeof o.ssoDirect=="object"&&Object.keys(o.ssoDirect).length!==0)return;const y=!!s?.sso&&(Array.isArray(s.sso)?s.sso.length>0:!0),r=!!s?.idps&&(Array.isArray(s.idps)?s.idps.length>0:!0);if(s?.sso&&Array.isArray(s.sso)&&!s.sso.length&&!r)return;const g=!!(s?.rbac&&typeof s.rbac=="object"&&Object.keys(s.rbac).length!==0),u=s?.requiresLogin;if(!g&&!u)return;y&&r&&O.error("access.sso and access.idps both set \u2014 should have been rejected by config validation",{sso:s.sso,idps:s.idps});let c=T,a=d.REDOCLY_OAUTH_USE_INTROSPECT?_:"";const e=s?.residency;if(e){const l=e.endsWith("/")?e.slice(0,-1):e;c=`${l.replace("app.","auth.")}/oidc/.well-known/openid-configuration`,a=d.REDOCLY_OAUTH_USE_INTROSPECT?`${l}/api/sso/oidc/introspect`:""}let n="AUTO";s?.sso&&(Array.isArray(s.sso)?n=s.sso.join(","):n=s.sso);let t="";s?.idps&&(Array.isArray(s.idps)?t=s.idps.join(","):t=s.idps);const p={login_hint:"{{ process.env.ORGANIZATION_ID }}",login_type:n};t&&(p.login_idps=t);const m={oidc:{title:I,type:A.OIDC,configurationUrl:c,clientId:"{{ process.env.OAUTH_CLIENT_ID }}",clientSecret:"{{ process.env.OAUTH_CLIENT_SECRET }}",teamsClaimName:"https://redocly.com/sso/teams",scopes:["openid","offline"],authorizationRequestCustomParams:p,audience:["{{ process.env.ORGANIZATION_ID }}"],introspectEndpoint:a}};i.setGlobalConfig({ssoDirect:m})})},async afterRoutesCreated(i){}}}export{U as ssoPlugin};

package/dist/server/plugins/utils.d.ts

@@ -0,0 +1,16 @@
+import type { ContentFs } from '../fs/content-fs.js';
+import type { LifecycleContext } from '../types';
+export declare function resolveFrontmatterSlugs(slugs: unknown, relativePath: string): string[];
+export declare function parseBaseName(relativePath: string): {
+    baseName: string;
+    isIndexFile: boolean;
+};
+export declare function findFrontmatterSlugs(relativePath: string, loaderName: string, frontmatter: Record<string, any> | undefined, context: LifecycleContext): Promise<string[] | undefined>;
+export declare function getSidebarSharedDataId(sidebar: string | {
+    path: string;
+}, relativePath: string, fs: ContentFs): Promise<string | null>;
+export declare function getRouteSlugsForPath(routes: {
+    fsPath: string;
+    slug: string;
+}[], relativePath: string): string[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/server/plugins/utils.js

@@ -0,0 +1 @@
+import a from"path";import{DEFAULT_LOCALE_PLACEHOLDER as m}from"../../constants/common.js";import{normalizeRouteSlug as l}from"../../utils/path/normalize-route-slug.js";import{slash as i}from"../../utils/path/slash.js";import{logger as u}from"../tools/notifiers/logger.js";import{getLocaleFromRelativePath as f}from"../fs/utils/get-locale-from-relative-path.js";import{isL10nPath as p}from"../fs/utils/is-l10n-path.js";import{removeL10nPrefix as c}from"../fs/utils/remove-l10n-prefix.js";import{resolveSidebarId as d}from"./sidebars/index.js";function b(e,r){return(Array.isArray(e)?e:e?[e]:[]).map(o=>g(o,r))}function g(e,r){const t=f(r).toLowerCase(),o=l(e);return t!==m?`/${t}${o}`:o}function I(e){const r=e.endsWith(".page.tsx")?".page.tsx":a.posix.extname(e),t=a.posix.basename(e,r);return{baseName:t,isIndexFile:t==="index"}}async function P(e,r,t,o){if(t?.slug||!p(e))return t?.slug;const n=c(e);if(!o.fs.exists(n))return;const{data:s}=await o.cache.load(n,r);return s?.frontmatter?.slug}async function w(e,r,t){const o=typeof e=="string",n=o?e:e.path;return o&&u.warnForRealFile("The 'sidebar' property in the front matter of %rp is deprecated. Use 'sidebar.path' instead.",r,t),n?d(r,n,t):null}function C(e,r){return e.filter(t=>i(t.fsPath)===i(r)).map(t=>t.slug)}export{P as findFrontmatterSlugs,C as getRouteSlugsForPath,w as getSidebarSharedDataId,I as parseBaseName,b as resolveFrontmatterSlugs};

package/dist/server/plugins/validate-rbac-config.d.ts

@@ -0,0 +1,7 @@
+import type { RbacConfig } from '@redocly/config';
+export declare enum RbacConfigLocation {
+    Frontmatter = 0,
+    RootRedoclyYaml = 1
+}
+export declare function validateRbacConfig(rbacConfig: RbacConfig, location?: RbacConfigLocation): void;
+//# sourceMappingURL=validate-rbac-config.d.ts.map

package/dist/server/plugins/validate-rbac-config.js

@@ -0,0 +1,2 @@
+import{DEFAULT_RBAC_SCOPE as e,RBAC_ALL_OTHER_TEAMS as m}from"../../constants/common.js";import{bold as r}from"../tools/notifiers/helpers/colors.js";import{logger as a}from"../tools/notifiers/logger.js";var t;(function(o){o[o.Frontmatter=0]="Frontmatter",o[o.RootRedoclyYaml=1]="RootRedoclyYaml"})(t||(t={}));function p(o,i=t.Frontmatter){i===t.RootRedoclyYaml&&!o?.content?.[e]&&a.warn(`Your ${r("rbac:")} configuration is missing ${r(e+":")} property. 
+      In case you do not specify it, it will be treated as ${r('"'+m+'": READ')}.`)}export{t as RbacConfigLocation,p as validateRbacConfig};

package/dist/server/providers/database/base-repository.d.ts

@@ -0,0 +1,15 @@
+import type { DatabaseClient } from './client.js';
+import type { DatabaseConnection } from './types.js';
+export declare abstract class BaseRepository {
+    #private;
+    protected readonly organizationId: string;
+    protected readonly projectId: string;
+    protected readonly databaseClient: DatabaseClient;
+    readonly path: string;
+    protected constructor(dbConnection: DatabaseConnection);
+    close(): Promise<void>;
+    sync(): Promise<void>;
+    protected getTableSizeInBytes(tableName: string): Promise<number>;
+    isNonRemoteDatabaseMode: () => boolean;
+}
+//# sourceMappingURL=base-repository.d.ts.map

package/dist/server/providers/database/base-repository.js

@@ -0,0 +1,5 @@
+import{sql as a}from"drizzle-orm";import{getFirstRunRow as o}from"../../providers/database/utils/get-first-row.js";import{envConfig as i}from"../../config/env-config.js";import{SQLD_REMOTE_DATABASE_URL_NO_DEPLOYMENT_YET_VAR as E}from"../../constants/plugins/catalog-entities.js";class n{static#t="ORGANIZATION_ID";static#e="PROJECT_ID";organizationId;projectId;databaseClient;path;constructor(e){const t=this.isNonRemoteDatabaseMode();this.organizationId=this.#i(t),this.projectId=this.#n(t),this.databaseClient=e.client,this.path=e.path}async close(){await this.databaseClient.close()}async sync(){await this.databaseClient.sync()}async getTableSizeInBytes(e){const t=await this.databaseClient.client.run(a`
+      SELECT COALESCE(SUM(pgsize), 0) AS bytes
+      FROM dbstat
+      WHERE name = ${e}
+    `),s=o(t)?.bytes,r=Number(s??0);return Number.isFinite(r)?r:0}#i=e=>{const t=i.ORGANIZATION_ID;if(t)return t;if(e)return n.#t;throw new Error("ORGANIZATION_ID environment variable is required. Ensure it is set in your environment configuration.")};#n=e=>{const t=i.PROJECT_ID;if(t)return t;if(e)return n.#e;throw new Error("PROJECT_ID environment variable is required. Ensure it is set in your environment configuration.")};isNonRemoteDatabaseMode=()=>i.SQLD_REMOTE_DATABASE_URL===E||!i.SQLD_REMOTE_DATABASE_AUTH_TOKEN}export{n as BaseRepository};

package/dist/server/providers/database/base-service.d.ts

@@ -0,0 +1,25 @@
+import type { ServiceInstanceOptions } from './types.js';
+type SyncableRepository = {
+    sync: () => Promise<void>;
+};
+type RunOptions<T> = {
+    onRepositoryMissing?: () => Promise<T> | T;
+    skipSync?: boolean;
+};
+type BaseServiceConfig<R extends SyncableRepository | null> = {
+    repository: NonNullable<R>;
+    createRepository?: (options: ServiceInstanceOptions) => Promise<NonNullable<R>>;
+};
+export declare abstract class BaseService<R extends SyncableRepository | null> {
+    #private;
+    protected constructor(options: ServiceInstanceOptions | undefined, config: BaseServiceConfig<R>);
+    protected get isLocalDbMode(): boolean;
+    protected getRepository(): R;
+    protected setRepository(repository: NonNullable<R>): void;
+    protected recreateRepository(): Promise<NonNullable<R> | null>;
+    protected syncRepositoryIfNeeded(): Promise<void>;
+    protected runRead<T>(run: (repo: NonNullable<R>) => Promise<T>, options?: RunOptions<T>): Promise<T>;
+    protected runWrite<T>(run: (repo: NonNullable<R>) => Promise<T>, options?: RunOptions<T>): Promise<T>;
+}
+export {};
+//# sourceMappingURL=base-service.d.ts.map

package/dist/server/providers/database/base-service.js

@@ -0,0 +1 @@
+import{envConfig as a}from"../../config/env-config.js";import{logger as n}from"../../tools/notifiers/logger.js";import{SQLD_REMOTE_DATABASE_URL_NO_DEPLOYMENT_YET_VAR as p}from"../../constants/plugins/catalog-entities.js";import{HTTP_TRANSIENT_RETRY as o,describeTransientError as c,isTransientSqldError as R,withTransientErrorRetry as s}from"./transient-sqld-error.js";class w{#i;#r;#o=null;#s;constructor(t,r){this.#i=t,this.#r=l(t)==="local",this.#o=r.repository,this.#s=r.createRepository}get isLocalDbMode(){return this.#r}getRepository(){return this.#o}setRepository(t){this.#o=t}async recreateRepository(){return!this.#s||!this.#i?null:this.#s(this.#i)}async syncRepositoryIfNeeded(){if(this.#r)return;const t=this.getRepository();t&&await s(()=>t.sync(),o)}async runRead(t,r){if(r?.skipSync||await this.syncRepositoryIfNeeded(),this.#r)try{return await this.#t(t,r)}catch(e){throw this.#e("read",e),e}try{return await s(()=>this.#t(t,r),o)}catch(e){throw this.#e("read",e),e}}async runWrite(t,r){if(this.#r)try{return await this.#t(t,r)}catch(e){throw this.#e("write",e),e}try{return await s(async()=>{try{return await this.#t(t,r)}catch(e){throw await this.#a(e),e}},o)}catch(e){throw this.#e("write",e),e}}async#t(t,r){const e=this.getRepository();if(!e){if(r?.onRepositoryMissing)return await r.onRepositoryMissing();throw new Error("Database repository is not initialized")}return t(e)}async#a(t){if(R(t))try{const r=await this.recreateRepository();r&&this.setRepository(r)}catch(r){n.warn(`Reconnect attempt failed, letting original error propagate: ${c(r)}`)}}#e(t,r){const e=this.constructor.name,h=r instanceof Error?c(r):String(r),y=this.#r?"local-no-retry":"remote-retry-enabled";n.error(`[${e}] ${t} operation failed (${y}): ${h}`,r)}}function l(i){if(i?.databaseType)return i.databaseType;const t=a.SQLD_REMOTE_DATABASE_URL||i?.sqldRemoteDatabaseUrl,r=a.SQLD_REMOTE_DATABASE_AUTH_TOKEN||i?.sqldRemoteDatabaseAuthToken;return t&&t!==p&&r?"remote":"local"}export{w as BaseService};

package/dist/server/providers/database/client.d.ts

@@ -0,0 +1,28 @@
+import { drizzle } from 'drizzle-orm/libsql';
+import type { DrizzleConfig } from 'drizzle-orm';
+import type { Client, Config } from '@libsql/client';
+import type { DrizzleTransaction } from './transactions-manager.js';
+import { TransactionsManager } from './transactions-manager.js';
+export type DrizzleClient = ReturnType<typeof drizzle>;
+type DatabaseClientInitOptions = {
+    runWithPragmaWalWriteOptimization?: boolean;
+    clientOptions?: DrizzleConfig;
+};
+export declare class DatabaseClient {
+    #private;
+    readonly dbClient: DrizzleClient;
+    constructor(config: Config, createClient: (c: Config) => Client);
+    get transactionsManager(): TransactionsManager;
+    get client(): DrizzleClient | DrizzleTransaction;
+    static init(config: Config, options?: DatabaseClientInitOptions): Promise<DatabaseClient>;
+    migrate(prefix: string, suffix?: string): Promise<void>;
+    close(): Promise<void>;
+    /**
+     * Closes the client during error handling. Never throws, so the caller can rethrow
+     * the original error; a close failure is logged.
+     */
+    closeAfterFailure(): Promise<void>;
+    sync(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/server/providers/database/client.js

@@ -0,0 +1 @@
+import o from"node:path";import{sql as c}from"drizzle-orm";import{drizzle as l}from"drizzle-orm/libsql";import{migrate as m}from"drizzle-orm/libsql/migrator";import{logger as d}from"../../tools/notifiers/logger.js";import{TransactionsManager as h}from"./transactions-manager.js";class n{dbClient;#t;constructor(t,r){this.dbClient=l(r(t)),this.#t=new h(this.dbClient)}get transactionsManager(){return this.#t}get client(){return this.#t.tx??this.dbClient}static async init(t,r){const{createClient:a}=await import("@libsql/client"),i=new n(t,a);if(r?.runWithPragmaWalWriteOptimization)try{await i.dbClient.run(c.raw("PRAGMA journal_mode = WAL;"))}catch(s){throw await i.closeAfterFailure(),s}return i}async migrate(t,r=""){await m(this.dbClient,{migrationsFolder:o.join(t,"migrations",r)})}async close(){this.dbClient.$client.close()}async closeAfterFailure(){try{await this.close()}catch(t){d.warn("Failed to close the database client: %s",t)}}async sync(){try{await this.dbClient.$client.sync()}catch(t){if(u(t))return;throw t}}}function u(e){if(!(e instanceof Error))return!1;const t=e.message.toLowerCase();return t.includes("syncnotsupported")&&(t.includes('("file")')||t.includes('"file"'))}export{n as DatabaseClient};

package/dist/server/providers/database/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const SQLITE_DATABASE_NAME = "db.sqlite";
+export declare const SQLITE_DATABASE_MIGRATIONS_FOLDER = "sqlite-db";
+export declare const SQLITE_LOCAL_DATABASE_FOLDER = "local-sqlite-db";
+export declare const SQLITE_REMOTE_DATABASE_FOLDER = "remote-sqlite-db";
+//# sourceMappingURL=constants.d.ts.map

package/dist/server/providers/database/constants.js

@@ -0,0 +1 @@
+const A="db.sqlite",E="sqlite-db",t="local-sqlite-db",_="remote-sqlite-db";export{E as SQLITE_DATABASE_MIGRATIONS_FOLDER,A as SQLITE_DATABASE_NAME,t as SQLITE_LOCAL_DATABASE_FOLDER,_ as SQLITE_REMOTE_DATABASE_FOLDER};

package/dist/server/providers/database/copy-migrations.d.ts

@@ -0,0 +1,6 @@
+import type { Store } from '../../store.js';
+/**
+ * Copy databases migrations folders into server output directory
+ */
+export declare const copyMigrationsFolder: (store: Store) => void;
+//# sourceMappingURL=copy-migrations.d.ts.map

package/dist/server/providers/database/copy-migrations.js

@@ -0,0 +1 @@
+import n from"node:path";import{cpSync as m,existsSync as i,mkdirSync as c}from"node:fs";import{logger as e}from"../../tools/notifiers/logger.js";import{fromCurrentDir as u}from"../../utils/index.js";import{hasProjectDatabase as f}from"./has-project-database.js";const D=r=>{if(!f())return;const o="sqlite-db",t=u(import.meta.url,`./databases/${o}/migrations`),a=n.join(r.serverOutDir,"migrations",o);if(!i(t)){e.warn(`Migrations folder not found at ${t}`);return}i(r.serverOutDir)||c(r.serverOutDir,{recursive:!0});try{m(t,a,{recursive:!0})}catch(s){e.error("Failed to copy migrations folder: %s",s)}};export{D as copyMigrationsFolder};

package/dist/server/providers/database/database-connection-factory.d.ts

@@ -0,0 +1,6 @@
+import type { DatabaseConnection, DatabaseConnectionOptions } from './types.js';
+export declare class DatabaseConnectionFactory {
+    #private;
+    static create(options: DatabaseConnectionOptions): Promise<DatabaseConnection | null>;
+}
+//# sourceMappingURL=database-connection-factory.d.ts.map

package/dist/server/providers/database/database-connection-factory.js

@@ -0,0 +1 @@
+import{logger as n}from"../../tools/notifiers/logger.js";import{envConfig as r}from"../../config/env-config.js";import{SQLITE_DATABASE_MIGRATIONS_FOLDER as o,SQLITE_LOCAL_DATABASE_FOLDER as c,SQLITE_REMOTE_DATABASE_FOLDER as l,SQLITE_DATABASE_NAME as i}from"./constants.js";import{DatabaseConnectionsManager as s}from"./database-connections-manager.js";import{SQLD_REMOTE_DATABASE_URL_NO_DEPLOYMENT_YET_VAR as T}from"../../constants/plugins/catalog-entities.js";class u{static async create(e){return this.#r(e)==="local"?await this.#t(e):await this.#a(e)}static async#t(e){return await s.getLocalConnection({...e,databaseName:i,additionalFolder:c,migrationsFolder:o})}static async#a(e){try{const{syncUrl:t,authToken:a}=this.#e(e);return!t||!a?(r.isDevelopMode||n.warn("Your remote database is not initialized yet, please wait for production deployment."),null):await s.getRemoteConnection({...e,databaseName:i,additionalFolder:l,migrationsFolder:o,syncUrl:t,authToken:a})}catch(t){return n.error("Remote database connection initialization failed",t),null}}static#r(e){if(e.databaseType)return e.databaseType;const{syncUrl:t,authToken:a}=this.#e(e);return t&&a?"remote":"local"}static#e(e){const t=r.SQLD_REMOTE_DATABASE_URL||e.sqldRemoteDatabaseUrl,a=r.SQLD_REMOTE_DATABASE_AUTH_TOKEN||e.sqldRemoteDatabaseAuthToken;return{syncUrl:this.#n(t),authToken:a}}static#n(e){return e===T?void 0:e}}export{u as DatabaseConnectionFactory};

package/dist/server/providers/database/database-connections-manager.d.ts

@@ -0,0 +1,7 @@
+import type { DatabaseConnection, LocalDatabaseConnectionInitOptions, RemoteDatabaseConnectionInitOptions } from './types.js';
+export declare class DatabaseConnectionsManager {
+    #private;
+    static getLocalConnection(config: LocalDatabaseConnectionInitOptions): Promise<DatabaseConnection | null>;
+    static getRemoteConnection(config: RemoteDatabaseConnectionInitOptions): Promise<DatabaseConnection | null>;
+}
+//# sourceMappingURL=database-connections-manager.d.ts.map

package/dist/server/providers/database/database-connections-manager.js

@@ -0,0 +1 @@
+import{logger as c}from"../../tools/notifiers/logger.js";import{SqldNotRunningError as y}from"./sqld-not-running-error.js";import{retryAsyncOperation as h}from"./utils/retry-async-operation.js";import{DatabasePathGenerator as w}from"./database-path-generator.js";import{DatabaseClient as g}from"./client.js";import{describeTransientError as z}from"./transient-sqld-error.js";const u="_redocly_db_preconnect_cache_";class i{static get#t(){const t=globalThis;if(!t[u]){const r={connections:new Map,pendingConnections:new Map,failedConnections:new Set};t[u]=r}return t[u]}static get#i(){return i.#t.connections}static get#e(){return i.#t.failedConnections}static get#r(){return i.#t.pendingConnections}static async getLocalConnection(t){return i.#n(t,async()=>i.#a(t))}static async getRemoteConnection(t){return i.#n(t,async()=>i.#d(t))}static async#n(t,r){const e=i.#o(t),n=i.#i.get(e);if(n)if(n.client.dbClient.$client.closed)c.warn("Cached database client is closed. Reinitializing connection..."),i.#i.delete(e);else return n;return i.#l({key:e,initializer:r})}static#o=t=>{const r="syncUrl"in t&&typeof t.syncUrl=="string"?`|${t.syncUrl}`:"",e=t.additionalFolder??"";return`${t.baseDbDir}|${e}|${t.databaseName}${r}`};static async#l({key:t,initializer:r}){let e=i.#r.get(t);e||(i.#e.has(t)&&c.warn("Error connecting to the database, retrying..."),e=i.#s(t,r),i.#r.set(t,e));try{return await e}catch(n){return c.error("Error connecting to the database: %s",z(n)),i.#e.add(t),null}finally{i.#r.delete(t)}}static async#s(t,r){const e=await r();return i.#i.set(t,e),i.#e.delete(t),e}static async#a({removeExisting:t,baseDbDir:r,runWithPragmaWalWriteOptimization:e,databaseName:n,additionalFolder:a,migrationsFolder:d}){c.info("Initializing local database client...");const l=c.startTiming(),s=await i.#c({removeExisting:t,baseDbDir:r,databaseName:n,additionalFolder:a,migrationsFolder:d,runWithPragmaWalWriteOptimization:e});return c.infoTime(l,"Local database client initialized"),s}static async#d({removeExisting:t,baseDbDir:r,syncUrl:e,authToken:n,databaseName:a,additionalFolder:d,migrationsFolder:l}){c.info("Initializing remote database client...");const s=c.startTiming();return await h(async()=>{try{const o=await i.#c({removeExisting:t,baseDbDir:r,databaseName:a,additionalFolder:d,migrationsFolder:l,syncUrl:e,authToken:n});return c.infoTime(s,"Remote database client initialized"),o}catch(o){throw y.isSqldNotRunningError(o)?new y("SQLD server is not running yet, wait for production deployment",{cause:o}):o}},{maxRetries:3,retryStrategy:"exponential",delay:1e3,logger:c,messages:{retry:"Retrying remote database client initialization",maxRetriesReached:"Max retries reached, remote database client initialization failed"}})}static async#c({removeExisting:t,baseDbDir:r,databaseName:e,additionalFolder:n,migrationsFolder:a,runWithPragmaWalWriteOptimization:d,syncUrl:l,authToken:s}){const{databasePath:o}=await w.prepareDatabasePath({baseDir:r,databaseName:e,additionalFolder:n,removeExisting:t}),p=l&&s?{url:`file:${o}`,syncUrl:l,authToken:s}:{url:`file:${o}`},m=await g.init(p,{runWithPragmaWalWriteOptimization:d});try{await m.migrate(r,a)}catch(f){throw await m.closeAfterFailure(),f}return{client:m,path:o}}}export{i as DatabaseConnectionsManager};

package/dist/server/providers/database/database-path-generator.d.ts

@@ -0,0 +1,23 @@
+export type DatabasePathOptions = {
+    baseDir: string;
+    databaseName: string;
+    additionalFolder?: string;
+};
+export declare class DatabasePathGenerator {
+    #private;
+    /**
+     * Generate database path without any file system operations
+     * This is a pure function that can be used synchronously
+     */
+    static generateDatabasePath({ baseDir, databaseName, additionalFolder, }: DatabasePathOptions): string;
+    /**
+     * Prepare database path with file system operations
+     * This handles directory creation and cleanup
+     */
+    static prepareDatabasePath({ baseDir, databaseName, additionalFolder, removeExisting, }: DatabasePathOptions & {
+        removeExisting?: boolean;
+    }): Promise<{
+        databasePath: string;
+    }>;
+}
+//# sourceMappingURL=database-path-generator.d.ts.map

package/dist/server/providers/database/database-path-generator.js

@@ -0,0 +1 @@
+import e from"path";import i from"fs/promises";class m{static#a=".data";static generateDatabasePath({baseDir:r,databaseName:c,additionalFolder:a}){const s=e.join(r,this.#a),t=a?e.join(s,a):s;return e.join(t,c)}static async prepareDatabasePath({baseDir:r,databaseName:c,additionalFolder:a,removeExisting:s}){const t=this.generateDatabasePath({baseDir:r,databaseName:c,additionalFolder:a}),n=e.join(r,this.#a),o=a?e.join(n,a):n;return s?(await i.rm(o,{recursive:!0,force:!0}),await i.mkdir(o,{recursive:!0}),{databasePath:t}):(await i.access(t).then(()=>!0).catch(()=>!1)||await i.mkdir(o,{recursive:!0}),{databasePath:t})}}export{m as DatabasePathGenerator};

package/dist/server/providers/database/database-preconnect-service.d.ts

@@ -0,0 +1,5 @@
+export declare class DatabasePreconnectService {
+    #private;
+    static init(baseDbDir: string): Promise<void>;
+}
+//# sourceMappingURL=database-preconnect-service.d.ts.map

package/dist/server/providers/database/database-preconnect-service.js

@@ -0,0 +1 @@
+import{logger as o}from"../../tools/notifiers/logger.js";import{envConfig as r}from"../../config/env-config.js";import{DatabaseConnectionFactory as i}from"./database-connection-factory.js";class e{static#e=!1;static async init(t){if(!(r.REDOCLY_INTERNAL_DEV||r.CI||r.isDevelopMode)&&!e.#e)try{await e.#t(t)==="PRECONNECTED"&&(e.#e=!0)}catch(a){o.error("Failed to preconnect to sqld remote database",a)}}static#t=async t=>await i.create({baseDbDir:t,databaseType:"remote"})?(o.info("Sqld remote database preconnected"),"PRECONNECTED"):(o.warn("Sqld remote database preconnect failed"),"NOT_PRECONNECTED")}export{e as DatabasePreconnectService};