@redocly/revel-reef 0.128.0-next.4 → 0.128.0-next.5

package/dist/server/plugins/pages/search/search-resolver.d.ts

@@ -0,0 +1,5 @@
+import type { AfterRoutesCreatedActions, PageRouteDetails, SearchDocument } from '../../../types';
+import type { SearchFacet } from '@redocly/theme/core/types';
+import type { ReactLoadResult } from '../loaders/react-frontmatter-loader.js';
+export declare function searchResolver(frontmatter: ReactLoadResult, relativePath: string, getSearchFacets: () => Map<string, SearchFacet>, setSearchFacets: (searchFacets: Map<string, SearchFacet>) => void): (route: PageRouteDetails, staticData: Record<string, unknown>, actions: AfterRoutesCreatedActions) => Promise<SearchDocument[]>;
+//# sourceMappingURL=search-resolver.d.ts.map

package/dist/server/plugins/pages/search/search-resolver.js

@@ -0,0 +1 @@
+import{REDOCLY_ROUTE_RBAC as l,REDOCLY_TEAMS_RBAC as h}from"@redocly/config";import{SEARCH_DOCUMENT_METADATA_KEY as _}from"../../../constants/plugins/search.js";import{normalizeFrontmatterKeywords as m}from"../../helpers/normalize-frontmatter-keywords.js";import{extractDocumentSearchFacets as E,setDocumentSearchFacets as x}from"./search-facets.js";function F(e,t,o,p){return async(s,A,R)=>{if(!e||e?.excludeFromSearch)return[];const r=e.search?.title||e.seo?.title||e.title,a=e.search?.description||e.seo?.description||e.description;if(!r&&!a)return[];const n=s.slug||t,{result:c}=m(e?.search?.keywords),D=s.metadata||{},d=E(D,o);x(d,o,p);const u={id:n,url:n,title:r||t,text:a||"",path:[],facets:d,[h]:e?.rbac||s[h],[l]:s[l]};if(c){const i={curated:!0};c.includes&&(i.includes=c.includes),c.excludes&&(i.excludes=c.excludes),u[_]=i}return[u]}}export{F as searchResolver};

package/dist/server/plugins/pages/validators/validate-react-pages.d.ts

@@ -0,0 +1,4 @@
+import type { Store } from '../../../store.js';
+import type { LifecycleContext } from '../../../types';
+export declare function validateReactPages(store: Store, lifecycleContext: LifecycleContext): Promise<void>;
+//# sourceMappingURL=validate-react-pages.d.ts.map

package/dist/server/plugins/pages/validators/validate-react-pages.js

@@ -0,0 +1 @@
+import u from"node:path";import{logger as n}from"../../../tools/notifiers/logger.js";import{reporter as s}from"../../../tools/notifiers/reporter.js";import{getServerProps as d}from"../../../ssr/server-side-props/get-server-props.js";import{telemetry as f}from"../../../../cli/telemetry/index.js";async function b(e,o){s.clearPageRenderProblems();const r=e.getAllRoutes().filter(t=>t.fsPath.match(/\.page\.tsx?$/));if(!r.length)return;const l=n.startTiming();n.info("Validating react pages");const g=await p(e.serverOutDir);for(const t of r){const c=await e.resolveRouteStaticData(t,o),m=await d(t,null,c,e);let a;try{a=(await g(t,m,null,e,f,!0)).error}catch(i){a=i}a&&s.reportPageRenderError({message:a.name==="PageMissingDefaultExportError"?a.message:`Runtime error: ${a.message}`,sourceFileRelativePath:t.fsPath})}n.infoTime(l,`Validated ${r.length} React pages`)}async function p(e){const r=await import(u.join(e,"index.mjs"));if(!r.renderPage)throw new Error("renderPage function not found in bundle");return r.renderPage}export{b as validateReactPages};

package/dist/server/plugins/{scorecard → scorecard-classic}/get-scorecard-config.d.ts

@@ -1,13 +1,6 @@
 import type { RedoclyConfig } from '@redocly/config';
 export declare const getScorecardConfig: (config: Partial<RedoclyConfig>) => {
     ignore?: string[] | undefined;
-    ignoreNonCompliant?: boolean | undefined;
-    teamMetadataProperty?: {
-        [x: string]: unknown;
-        default?: string | undefined;
-        label?: string | undefined;
-        property?: string | undefined;
-    } | undefined;
     levels: {
         preprocessors?: {
             [x: string]: unknown;
@@ -112,6 +105,13 @@ export declare const getScorecardConfig: (config: Partial<RedoclyConfig>) => {
         color?: string | undefined;
         name: string;
     }[];
+    ignoreNonCompliant?: boolean | undefined;
+    teamMetadataProperty?: {
+        [x: string]: unknown;
+        default?: string | undefined;
+        label?: string | undefined;
+        property?: string | undefined;
+    } | undefined;
     targets?: {
         rules?: {
             [x: string]: unknown;

package/dist/server/plugins/scorecard-classic/get-scorecard-config.js

@@ -0,0 +1 @@
+const a=e=>{const r=e?.scorecardClassic??e?.scorecard;return{ignoreMetadata:r?.levels?void 0:!0,levels:[{name:"lint",...e}],...r}};export{a as getScorecardConfig};

package/dist/server/plugins/{scorecard → scorecard-classic}/index.d.ts

@@ -5,7 +5,7 @@ export type ScorecardInfo = {
     rules: string[];
     rulesPerLevel: Record<string, string[]>;
 };
-export declare function scorecardPlugin({ id, requiredEntitlements, loadersPrefix, }: {
+export declare function scorecardClassicPlugin({ id, requiredEntitlements, loadersPrefix, }: {
     id?: string;
     requiredEntitlements: Feature[];
     loadersPrefix?: string;

package/dist/server/plugins/scorecard-classic/index.js

@@ -0,0 +1 @@
+import{writeFileSync as E}from"node:fs";import R from"path";import{SCORECARD_OUTPUT_FILE_NAME as L}from"../../constants/common.js";import{mapObject as h}from"../../../utils/object/map-object.js";import{readEnvVariable as P}from"../../utils/envs/read-env-variable.js";import{removeLeadingSlash as T}from"../../../utils/url/remove-leading-slash.js";import{combineUrls as y}from"@redocly/theme/core/utils";import{logger as _}from"../../tools/notifiers/logger.js";import{ensureDir as b}from"../../utils/index.js";import{getTemplatePath as A}from"./get-template-path.js";import{getAllRuleNames as F}from"./lint.js";import{getScorecardConfig as O}from"./get-scorecard-config.js";import{CUSTOM_FIELDS_SERVER_PROPS_GETTER_ID as j}from"../catalog-classic/index.js";import{getScorecardSlug as w}from"./shared-utils.js";import{scorecardConfigLoader as N}from"./loaders/scorecard-config.js";import{scorecardLoader as U}from"./loaders/scorecard.js";import{computeScorecard as q}from"./compute-scorecard.js";import{telemetryTraceStep as M}from"../../../cli/telemetry/helpers/trace-step.js";const k="scorecardClassic";async function ae({id:D,requiredEntitlements:I,loadersPrefix:p=""}){let d=null,S=null,v=!1;return{id:D??"scorecardClassic",requiredEntitlements:I??["scorecard"],loaders:{[`${p}scorecard-config`]:N,[`${p}scorecard`]:U},async processContent(t,i){await M("build.plugin.scorecard_classic",async u=>{const g=t.createTemplate(k,A("./template/index.js")),l=await i.getConfig(),a=O(l);u?.setAttribute("config",JSON.stringify(a||{}));const m=l?.reunite??{},s=l.catalogClassic??{},c=a.levels||[];if(c.length<1)throw Error("Invalid configuration of levels config");d===null&&(d=await q({actions:t,context:i,scorecardConfig:a,reuniteConfig:m}));const{data:{configs:e}}=await i.cache.load("",`${p}scorecard-config`),{perLevel:n,all:C}=F(e);S={levelNames:c.map(o=>o.name),rules:C,rulesPerLevel:n};for(const[o,r]of Object.entries(s)){const f=y(r.slug,"scorecard/");t.addRoute({duplicateInAllLocales:!0,slug:f,fsPath:y(r.slug,"scorecard/"),templateId:g,hasClientRoutes:!0,excludeFromSidebar:!0,serverPropsGetterIds:[j],sharedData:[{id:"scorecard",key:"scorecard"},{key:"catalog",id:"catalog-"+o}],getNavText:()=>Promise.resolve(r.title||"API design scorecard"),getStaticData:async()=>({props:{catalogId:o,catalogConfig:{...r,items:void 0},scorecardConfig:a,scorecardInfo:S}})})}})},afterRoutesCreated:async(t,{getConfig:i})=>{const u=await i(),g=u.catalogClassic??{},l=O(u);if(Object.keys(g).length){const s={};for(const[c,e]of Object.entries(d||{})){const n=t.getRouteByFsPath(c),C=y(Object.values(g)[0].slug,"scorecard/"),o=t.getRouteByFsPath(c)?.slug;if(o&&(n&&!l.ignoreMetadata&&(n.metadata={...n.metadata,scorecardStatus:e.status,scorecardLevel:e.scorecardLevel,scorecardLevelIdx:e.scorecardLevelIdx,scorecardLevels:h(e.levels,r=>({uniqueErrors:r.uniqueErrors,uniqueWarnings:r.uniqueWarnings})),scoreCardSlug:C+"apis/"+encodeURIComponent(T(o))}),s[o]={...e,levels:h(e.levels,r=>({...r,problems:r.problems.map(f=>({ruleId:f.ruleId,severity:f.severity}))}))},!v)){const r=R.resolve(t.outdir,"_scorecard",w(o));E(b(r),JSON.stringify(e))}}await t.createSharedData("scorecard",s)}const a={};for(const[s,c]of Object.entries(d||{})){const e=t.getRouteByFsPath(s)?.slug;e&&(a[e]=c)}const m=P("REDOCLY_METADATA_OUTPUT_FOLDER");!v&&m&&(_.info("Writing scorecard data..."),E(R.join(m,L),JSON.stringify({scorecardData:a,...S}))),v=!0}}}export{ae as scorecardClassicPlugin};

package/dist/server/plugins/{scorecard → scorecard-classic}/template/useData.d.ts

@@ -88,6 +88,7 @@ export declare function useData(props: {
                     [x: string]: unknown;
                     srcSet: string;
                 } | undefined;
+                version?: string | undefined;
                 directory?: string | undefined;
                 disconnect?: boolean | undefined;
                 group?: string | undefined;
@@ -95,7 +96,6 @@ export declare function useData(props: {
                 labelTranslationKey?: string | undefined;
                 groupTranslationKey?: string | undefined;
                 separator?: string | undefined;
-                version?: string | undefined;
                 menuStyle?: "drilldown" | undefined;
                 expanded?: "always" | undefined;
                 selectFirstItemOnExpand?: boolean | undefined;
@@ -117,6 +117,7 @@ export declare function useData(props: {
                 [x: string]: unknown;
                 srcSet: string;
             } | undefined;
+            version?: string | undefined;
             directory?: string | undefined;
             disconnect?: boolean | undefined;
             group?: string | undefined;
@@ -124,7 +125,6 @@ export declare function useData(props: {
             labelTranslationKey?: string | undefined;
             groupTranslationKey?: string | undefined;
             separator?: string | undefined;
-            version?: string | undefined;
             menuStyle?: "drilldown" | undefined;
             expanded?: "always" | undefined;
             selectFirstItemOnExpand?: boolean | undefined;

package/dist/server/plugins/search/ai-indexer/prepare-ai-search-documents.js

@@ -1 +1 @@
-import p from"node:path";import{existsSync as b}from"node:fs";import{writeFile as h,access as v,rm as N,constants as X}from"fs/promises";import{REDOCLY_ROUTE_RBAC as S,REDOCLY_TEAMS_RBAC as x}from"@redocly/config";import $ from"picomatch";import{DEFAULT_LOCALE_PLACEHOLDER as _}from"../../../../constants/common.js";import{AI_INDEX_EXPORT_FOLDER as j}from"../../../constants/plugins/search.js";import{LLMS_TXT_FILE_NAME as k}from"../../../constants/common.js";import{isBuildMode as B}from"../../../utils/envs/is-build-mode.js";import{logger as a}from"../../../tools/notifiers/logger.js";import{shaHexShort as G}from"../../../utils/crypto.js";import{ensureDir as A}from"../../../utils/fs.js";import{isResourcePubliclyAccessible as H,extractTeamsForSearch as U,getRbacTeamsForSearch as Y}from"../../../utils/rbac.js";import{promiseMapLimit as M}from"../../../utils/async.js";import{validateLLMsTxtConfig as J,generateLLMsTxt as K,getLLMsTxtMdSlug as V}from"../llmstxt/index.js";const P=20,R="llms.txt:";async function pt(t,o,{aiSearchEnabled:e,llmstxtEnabled:r}){const s=p.join(t.outdir,k);if(!r){try{await v(s,X.W_OK),await N(s)}catch{}if(!e)return}e&&a.info("Preparing AI search documents..."),r&&a.info(`${R} Generating llms.txt files...`);const L=a.startTiming(),c=a.startTiming(),f=t.getGlobalConfig("seo"),l=f?.llmstxt,T=p.resolve(t.outdir,j),u=t.getConfig(),w=u.rbac??{},C=t.getAllRoutes(),F=u?.l10n?.defaultLocale||u?.i18n?.defaultLocale||_,O=(l?.excludeFiles||[]).map(i=>$(i)),d=[];if(await M(C,P,async i=>{const y=await W(i,t),D=await q(i,y,o,t);if(D){if(r)for(const n of await D.getLLMsTxts()){if(O.some(m=>m(n.fsPath)))continue;const g=p.join(t.outdir,V(n.slug));A(g),await h(g,n.content),n.includeInLLMsTxt&&H(i,u)&&d.push(n)}if(e&&B()){const n=await D.getSearchDocuments();if(!n.length)return;const g=z(i,w),m=i.versions?.find(({active:I})=>I),E=m&&{folder:m.folderId,label:m.label,default:m.default};await Q(n,i.fsPath,g,T,F,E)}}}),e&&a.infoTime(c,"AI search documents prepared"),d.length)try{J(l);const i=await K(d,l,{title:f?.title,description:f?.description},o);A(s),await h(s,i),a.infoTime(L,`${R} files generated`)}catch(i){a.error(`${R} Failed to generate llms.txt file. ${i.message}`)}}async function W(t,o){return t.getStaticData?t.getStaticData(t,{...o,contentDir:o.contentDir,parseMarkdoc:(e,r,s)=>o.parseMarkdoc(e,r,s)}):{}}async function q(t,o,e,r){if(t.getAiDocumentsStore)return t.getAiDocumentsStore(t,{...o,[x]:t[x],[S]:t[S]},e,r)}function z(t,o){const e=U(t?.[x]);return e?.length?e:Y(t,o)}async function Q(t,o,e,r,s,L){await M(t,P,async c=>{const f=`${G(o+c.content)}.json`,l=A(p.join(r,f)),T=c.locale===_?s:c.locale;b(l)||await h(l,JSON.stringify({...c,rbacTeams:e||[],version:L,locale:T}),"utf-8")})}export{pt as prepareAiSearchDocuments};
+import p from"node:path";import{existsSync as b}from"node:fs";import{writeFile as h,access as v,rm as N,constants as X}from"fs/promises";import{REDOCLY_ROUTE_RBAC as S,REDOCLY_TEAMS_RBAC as x}from"@redocly/config";import $ from"picomatch";import{DEFAULT_LOCALE_PLACEHOLDER as _}from"../../../../constants/common.js";import{AI_INDEX_EXPORT_FOLDER as j}from"../../../constants/plugins/search.js";import{LLMS_TXT_FILE_NAME as k}from"../../../constants/common.js";import{isBuildMode as B}from"../../../utils/envs/is-build-mode.js";import{logger as a}from"../../../tools/notifiers/logger.js";import{shaHexShort as G}from"../../../utils/crypto/sha-hex-short.js";import{promiseMapLimit as M}from"../../../utils/async/promise-map-limit.js";import{ensureDir as A}from"../../../utils/fs.js";import{isResourcePubliclyAccessible as H,extractTeamsForSearch as U,getRbacTeamsForSearch as Y}from"../../../utils/rbac.js";import{validateLLMsTxtConfig as J,generateLLMsTxt as K,getLLMsTxtMdSlug as V}from"../llmstxt/index.js";const P=20,R="llms.txt:";async function pt(t,o,{aiSearchEnabled:e,llmstxtEnabled:r}){const s=p.join(t.outdir,k);if(!r){try{await v(s,X.W_OK),await N(s)}catch{}if(!e)return}e&&a.info("Preparing AI search documents..."),r&&a.info(`${R} Generating llms.txt files...`);const L=a.startTiming(),c=a.startTiming(),f=t.getGlobalConfig("seo"),l=f?.llmstxt,T=p.resolve(t.outdir,j),u=t.getConfig(),w=u.rbac??{},C=t.getAllRoutes(),F=u?.l10n?.defaultLocale||u?.i18n?.defaultLocale||_,O=(l?.excludeFiles||[]).map(i=>$(i)),d=[];if(await M(C,P,async i=>{const y=await W(i,t),D=await q(i,y,o,t);if(D){if(r)for(const n of await D.getLLMsTxts()){if(O.some(m=>m(n.fsPath)))continue;const g=p.join(t.outdir,V(n.slug));A(g),await h(g,n.content),n.includeInLLMsTxt&&H(i,u)&&d.push(n)}if(e&&B()){const n=await D.getSearchDocuments();if(!n.length)return;const g=z(i,w),m=i.versions?.find(({active:I})=>I),E=m&&{folder:m.folderId,label:m.label,default:m.default};await Q(n,i.fsPath,g,T,F,E)}}}),e&&a.infoTime(c,"AI search documents prepared"),d.length)try{J(l);const i=await K(d,l,{title:f?.title,description:f?.description},o);A(s),await h(s,i),a.infoTime(L,`${R} files generated`)}catch(i){a.error(`${R} Failed to generate llms.txt file. ${i.message}`)}}async function W(t,o){return t.getStaticData?t.getStaticData(t,{...o,contentDir:o.contentDir,parseMarkdoc:(e,r,s)=>o.parseMarkdoc(e,r,s)}):{}}async function q(t,o,e,r){if(t.getAiDocumentsStore)return t.getAiDocumentsStore(t,{...o,[x]:t[x],[S]:t[S]},e,r)}function z(t,o){const e=U(t?.[x]);return e?.length?e:Y(t,o)}async function Q(t,o,e,r,s,L){await M(t,P,async c=>{const f=`${G(o+c.content)}.json`,l=A(p.join(r,f)),T=c.locale===_?s:c.locale;b(l)||await h(l,JSON.stringify({...c,rbacTeams:e||[],version:L,locale:T}),"utf-8")})}export{pt as prepareAiSearchDocuments};

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

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

package/dist/server/providers/database/databases/catalog-sqlite/migrations/0001_catalog-versions-and-revisions.sql

@@ -0,0 +1,20 @@
+DROP INDEX `idx_entities_relations_source_key_target_to_source_relation_target_key`;--> statement-breakpoint
+ALTER TABLE `entities_relations` ADD `source_version` text;--> statement-breakpoint
+ALTER TABLE `entities_relations` ADD `source_revision` text;--> statement-breakpoint
+ALTER TABLE `entities_relations` ADD `target_version` text;--> statement-breakpoint
+ALTER TABLE `entities_relations` ADD `target_revision` text;--> statement-breakpoint
+CREATE UNIQUE INDEX `idx_entities_relations_unique` ON `entities_relations` (`source_key`,`target_key`,`source_version`,`target_version`,`source_revision`,`target_revision`);--> statement-breakpoint
+ALTER TABLE `entities_relations` DROP COLUMN `schema_version`;--> statement-breakpoint
+DROP INDEX `entities_key_unique`;--> statement-breakpoint
+DROP INDEX `idx_entities_key_source`;--> statement-breakpoint
+ALTER TABLE `entities` ADD `version` text;--> statement-breakpoint
+ALTER TABLE `entities` ADD `revision` text;--> statement-breakpoint
+ALTER TABLE `entities` ADD `hash` text;--> statement-breakpoint
+ALTER TABLE `entities` ADD `is_current` integer DEFAULT true;--> statement-breakpoint
+ALTER TABLE `entities` ADD `is_default_version` integer DEFAULT false;--> statement-breakpoint
+CREATE INDEX `idx_entities_hash` ON `entities` (`hash`);--> statement-breakpoint
+CREATE INDEX `idx_entities_key_source_created_at` ON `entities` (`key`,`created_at`);--> statement-breakpoint
+CREATE INDEX `idx_entities_key_source_is_current` ON `entities` (`key`,`is_current`);--> statement-breakpoint
+CREATE INDEX `idx_entities_key_source_is_default` ON `entities` (`key`,`is_default_version`);--> statement-breakpoint
+CREATE UNIQUE INDEX `idx_entities_key_source` ON `entities` (`key`,`source`,`revision`,`version`);--> statement-breakpoint
+ALTER TABLE `entities` DROP COLUMN `schema_version`;

package/dist/server/providers/database/databases/catalog-sqlite/migrations/meta/0001_snapshot.json

@@ -0,0 +1,378 @@
+{
+  "version": "6",
+  "dialect": "sqlite",
+  "id": "5138f9a4-2c01-49f7-9752-fd30cc163d80",
+  "prevId": "04aed177-3526-4556-a915-9877e3916235",
+  "tables": {
+    "entities_relations": {
+      "name": "entities_relations",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "organization_id": {
+          "name": "organization_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "project_id": {
+          "name": "project_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "source_key": {
+          "name": "source_key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "source_id": {
+          "name": "source_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "source_version": {
+          "name": "source_version",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "source_revision": {
+          "name": "source_revision",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "source_to_target_relation": {
+          "name": "source_to_target_relation",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "target_key": {
+          "name": "target_key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "target_id": {
+          "name": "target_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "target_version": {
+          "name": "target_version",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "target_revision": {
+          "name": "target_revision",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "target_to_source_relation": {
+          "name": "target_to_source_relation",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "source_file": {
+          "name": "source_file",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "file_hash": {
+          "name": "file_hash",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {
+        "idx_entities_relations_source_key": {
+          "name": "idx_entities_relations_source_key",
+          "columns": ["source_key"],
+          "isUnique": false
+        },
+        "idx_entities_relations_target_key": {
+          "name": "idx_entities_relations_target_key",
+          "columns": ["target_key"],
+          "isUnique": false
+        },
+        "idx_entities_relations_source_target": {
+          "name": "idx_entities_relations_source_target",
+          "columns": ["source_to_target_relation"],
+          "isUnique": false
+        },
+        "idx_entities_relations_target_source": {
+          "name": "idx_entities_relations_target_source",
+          "columns": ["target_to_source_relation"],
+          "isUnique": false
+        },
+        "idx_entities_relations_unique": {
+          "name": "idx_entities_relations_unique",
+          "columns": [
+            "source_key",
+            "target_key",
+            "source_version",
+            "target_version",
+            "source_revision",
+            "target_revision"
+          ],
+          "isUnique": true
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    },
+    "entities": {
+      "name": "entities",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "organization_id": {
+          "name": "organization_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "project_id": {
+          "name": "project_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "key": {
+          "name": "key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "type": {
+          "name": "type",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "title": {
+          "name": "title",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "summary": {
+          "name": "summary",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "tags": {
+          "name": "tags",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "metadata": {
+          "name": "metadata",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "git": {
+          "name": "git",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "contact": {
+          "name": "contact",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "links": {
+          "name": "links",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "source": {
+          "name": "source",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false,
+          "default": "'file'"
+        },
+        "source_file": {
+          "name": "source_file",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "file_hash": {
+          "name": "file_hash",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "version": {
+          "name": "version",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "revision": {
+          "name": "revision",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "hash": {
+          "name": "hash",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "is_current": {
+          "name": "is_current",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false,
+          "default": true
+        },
+        "is_default_version": {
+          "name": "is_default_version",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false,
+          "default": false
+        }
+      },
+      "indexes": {
+        "idx_entities_type": {
+          "name": "idx_entities_type",
+          "columns": ["type"],
+          "isUnique": false
+        },
+        "idx_entities_hash": {
+          "name": "idx_entities_hash",
+          "columns": ["hash"],
+          "isUnique": false
+        },
+        "idx_entities_key_source_created_at": {
+          "name": "idx_entities_key_source_created_at",
+          "columns": ["key", "created_at"],
+          "isUnique": false
+        },
+        "idx_entities_key_source_is_current": {
+          "name": "idx_entities_key_source_is_current",
+          "columns": ["key", "is_current"],
+          "isUnique": false
+        },
+        "idx_entities_key_source_is_default": {
+          "name": "idx_entities_key_source_is_default",
+          "columns": ["key", "is_default_version"],
+          "isUnique": false
+        },
+        "idx_entities_key_source": {
+          "name": "idx_entities_key_source",
+          "columns": ["key", "source", "revision", "version"],
+          "isUnique": true
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    }
+  },
+  "views": {},
+  "enums": {},
+  "_meta": {
+    "schemas": {},
+    "tables": {},
+    "columns": {}
+  },
+  "internal": {
+    "indexes": {}
+  }
+}

package/dist/server/providers/database/databases/catalog-sqlite/migrations/meta/_journal.json

@@ -8,6 +8,13 @@
       "when": 1754296264927,
       "tag": "0000_initial_migration",
       "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "6",
+      "when": 1763546809074,
+      "tag": "0001_catalog-versions-and-revisions",
+      "breakpoints": true
     }
   ]
 }