@redocly/revel-reef 0.128.0-next.1 → 0.128.0-next.10

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

@@ -0,0 +1,144 @@
+import type { CatalogItem } from '@redocly/theme/core/types';
+import type { CatalogConfig, ScorecardConfig } from '@redocly/theme/config';
+import type { Data, TeamStats, RuleProblem } from './index.types';
+export declare function useData(props: {
+    pageProps: {
+        catalogId: string;
+        catalogConfig: CatalogConfig;
+        scorecardConfig: ScorecardConfig;
+        scorecardInfo: {
+            levelNames: string[];
+            rulesPerLevel: Record<string, string[]>;
+            rules: string[];
+        };
+    };
+}): {
+    apis: Data[];
+    summary: {
+        total: number;
+        levels: Record<string, number>;
+    };
+    problemsByStatus: {
+        name: string;
+        count: {
+            errors: number;
+            warnings: number;
+        };
+        uniqueCount: {
+            errors: number;
+            warnings: number;
+        };
+    }[];
+    totalProblems: number;
+    problemsByRule: RuleProblem[];
+    sortedStatsByTeam: TeamStats[];
+    handleSortRulesTeams: (property: string) => void;
+    nonConformantByTeam: TeamStats[];
+    filterTerm: string;
+    setFilterTerm: (term: string) => void;
+    groups: {
+        title: string;
+        items: CatalogItem[];
+    }[];
+    filters: import("@redocly/theme").ResolvedFilter[];
+    scorecardInfo: {
+        levelNames: string[];
+        rulesPerLevel: Record<string, string[]>;
+        rules: string[];
+    };
+    catalogConfig: {
+        filters: {
+            type?: "select" | "checkboxes" | "date-range" | undefined;
+            options?: string[] | undefined;
+            titleTranslationKey?: string | undefined;
+            parentFilter?: string | undefined;
+            valuesMapping?: {
+                [x: string]: string;
+            } | undefined;
+            missingCategoryName?: string | undefined;
+            missingCategoryNameTranslationKey?: string | undefined;
+            title: string;
+            property: string;
+        }[];
+        title?: string | undefined;
+        description?: string | undefined;
+        show?: boolean | undefined;
+        groupByFirstFilter?: boolean | undefined;
+        filterValuesCasing?: "sentence" | "original" | "lowercase" | "uppercase" | undefined;
+        requiredPermission?: string | undefined;
+        separateVersions?: boolean | undefined;
+        titleTranslationKey?: string | undefined;
+        descriptionTranslationKey?: string | undefined;
+        items: {
+            [x: string]: unknown;
+            items?: {
+                [x: string]: unknown;
+                items?: {
+                    [x: string]: unknown;
+                }[] | undefined;
+                rbac?: {
+                    [x: string]: string;
+                } | undefined;
+                separatorLine?: boolean | undefined;
+                linePosition?: "top" | "bottom" | undefined;
+                href?: string | undefined;
+                label?: string | undefined;
+                page?: string | undefined;
+                icon?: string | {
+                    [x: string]: unknown;
+                    srcSet: string;
+                } | undefined;
+                version?: string | undefined;
+                directory?: string | undefined;
+                disconnect?: boolean | undefined;
+                group?: string | undefined;
+                external?: boolean | undefined;
+                labelTranslationKey?: string | undefined;
+                groupTranslationKey?: string | undefined;
+                separator?: string | undefined;
+                menuStyle?: "drilldown" | undefined;
+                expanded?: "always" | undefined;
+                selectFirstItemOnExpand?: boolean | undefined;
+                flatten?: boolean | undefined;
+                linkedSidebars?: string[] | undefined;
+                additionalProps?: {
+                    [x: string]: unknown;
+                } | undefined;
+            }[] | undefined;
+            rbac?: {
+                [x: string]: string;
+            } | undefined;
+            separatorLine?: boolean | undefined;
+            linePosition?: "top" | "bottom" | undefined;
+            href?: string | undefined;
+            label?: string | undefined;
+            page?: string | undefined;
+            icon?: string | {
+                [x: string]: unknown;
+                srcSet: string;
+            } | undefined;
+            version?: string | undefined;
+            directory?: string | undefined;
+            disconnect?: boolean | undefined;
+            group?: string | undefined;
+            external?: boolean | undefined;
+            labelTranslationKey?: string | undefined;
+            groupTranslationKey?: string | undefined;
+            separator?: string | undefined;
+            menuStyle?: "drilldown" | undefined;
+            expanded?: "always" | undefined;
+            selectFirstItemOnExpand?: boolean | undefined;
+            flatten?: boolean | undefined;
+            linkedSidebars?: string[] | undefined;
+            additionalProps?: {
+                [x: string]: unknown;
+            } | undefined;
+        }[];
+        slug: string;
+    };
+    hasTeam: boolean;
+    hasPublishedAt: boolean;
+    teamLabel: string;
+    teamProperty: string;
+};
+//# sourceMappingURL=useData.d.ts.map

package/dist/server/plugins/scorecards/workers/run-scorecards-worker.d.ts

@@ -0,0 +1,2 @@
+export declare function runScorecardsWorker(baseDbDir: string): Promise<void>;
+//# sourceMappingURL=run-scorecards-worker.d.ts.map

package/dist/server/plugins/scorecards/workers/run-scorecards-worker.js

@@ -0,0 +1 @@
+import{SCORECARDS_WORKER_KEY as n,scorecardsWorker as i}from"../../../workers/scorecards-worker-pool.js";import{logger as r}from"../../../tools/notifiers/logger.js";const c=5;async function t(s,e){try{const o=await i.exec(n,[{baseDbDir:s,pollingIntervalMs:parseInt(process.env.SCORECARDS_POLLING_INTERVAL_MS||"3000",10)}]);return o.success?r.info(`${o.message}`):r.error(`Scorecards Worker error (attempt ${e}/${c}):`,o.error),Promise.resolve()}catch(o){r.error(`Scorecards Worker execution failed (attempt ${e}/${c}):`,o)}return e<c?(r.info(`Retrying Scorecards Worker (attempt ${e+1}/${c})...`),t(s,e+1)):(r.error(`All ${c} attempts failed. Scorecards Worker could not be started.`),Promise.resolve())}async function l(s){return r.info("Starting continuous Scorecards Worker..."),t(s,1)}export{l as runScorecardsWorker};

package/dist/server/plugins/scorecards/workers/scorecards.d.ts

@@ -0,0 +1,14 @@
+export type ScorecardsWorkerParams = {
+    baseDbDir: string;
+    pollingIntervalMs?: number;
+};
+export type ScorecardsWorkerResponse = {
+    success: true;
+    message: string;
+} | {
+    success: false;
+    message: string;
+    error: string;
+};
+export declare function startScorecardsWorker(params: ScorecardsWorkerParams): Promise<ScorecardsWorkerResponse>;
+//# sourceMappingURL=scorecards.d.ts.map

package/dist/server/plugins/scorecards/workers/scorecards.js

@@ -0,0 +1 @@
+import{logger as o}from"../../../tools/notifiers/logger.js";import{loadEnvVariables as l}from"../../../utils/envs/load-env-variables.js";import{CatalogEntitiesService as d}from"../../../plugins/catalog-entities/database/catalog-entities-service.js";const u=3e3;async function y(s){try{const{baseDbDir:r,pollingIntervalMs:a=u}=s;l(r),o.verbose(`Initializing Scorecards Worker: polling interval ${a}ms (${a/1e3}s)`);const t=await d.getInstance({baseDbDir:r});return g(t,a),{success:!0,message:"Scorecards Worker started successfully"}}catch(r){const a=r instanceof Error?r.message:String(r);return o.error("Failed to start Scorecards Worker:",r),{success:!1,message:"Failed to start Scorecards Worker",error:a}}}async function g(s,r){let a=0,t=null;return t=setInterval(n,r),new Promise(()=>{});async function c(e){return e&&(await s.updateEntityScorecardsStatus(e.id,"CALCULATING"),await new Promise(i=>{setTimeout(async()=>{i()},1)}),await s.updateEntityScorecardsStatusIfCalculating(e.id,"UP_TO_DATE")?o.verbose(`Catalog Entity (${e.key}) scorecard evaluation completed successfully`):(await s.updateEntityScorecardsStatus(e.id,"OUTDATED"),o.verbose(`Catalog Entity (${e.key}) was updated during calculation, scorecard evaluation in not applicable anymore`))),Promise.resolve()}async function n(){try{a++;const e=await s.getOutdatedEntity();if(!e)return t||(o.verbose(`\u{1F50D} Resuming normal polling interval ${r}ms (${r/1e3}s)`),t=setInterval(n,r)),Promise.resolve();o.verbose(`\u{1F50D} Poll #${a} in Scorecards Worker: found Catalog Entity (${e.key}) for scorecard evaluation`),t&&(clearInterval(t),t=null,o.verbose(`\u{1F50D} Stopping normal polling while processing Catalog Entity (${e.key}) for scorecard evaluation`)),await c(e),await n()}catch(e){o.error("Error during poll in Scorecards Worker:",e),t||(t=setInterval(n,r))}}}export{y as startScorecardsWorker};

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 x,access as v,rm as N,constants as X}from"fs/promises";import{REDOCLY_ROUTE_RBAC as S,REDOCLY_TEAMS_RBAC as D}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,i,{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(o=>$(o)),d=[];if(await M(C,P,async o=>{if(o.excludeFromSearch)return;const y=await W(o,t),h=await q(o,y,i,t);if(h){if(r)for(const n of await h.getLLMsTxts()){if(O.some(m=>m(n.fsPath)))continue;const g=p.join(t.outdir,V(n.slug));A(g),await x(g,n.content),n.includeInLLMsTxt&&H(o,u)&&d.push(n)}if(e&&B()){const n=await h.getSearchDocuments();if(!n.length)return;const g=z(o,w),m=o.versions?.find(({active:I})=>I),E=m&&{folder:m.folderId,label:m.label,default:m.default};await Q(n,o.fsPath,g,T,F,E)}}}),e&&a.infoTime(c,"AI search documents prepared"),d.length)try{J(l);const o=await K(d,l,{title:f?.title,description:f?.description},i);A(s),await x(s,o),a.infoTime(L,`${R} files generated`)}catch(o){a.error(`${R} Failed to generate llms.txt file. ${o.message}`)}}async function W(t,i){return t.getStaticData?t.getStaticData(t,{...i,contentDir:i.contentDir,parseMarkdoc:(e,r,s)=>i.parseMarkdoc(e,r,s)}):{}}async function q(t,i,e,r){if(t.getAiDocumentsStore)return t.getAiDocumentsStore(t,{...i,[D]:t[D],[S]:t[S]},e,r)}function z(t,i){const e=U(t?.[D]);return e?.length?e:Y(t,i)}async function Q(t,i,e,r,s,L){await M(t,P,async c=>{const f=`${G(i+c.content)}.json`,l=A(p.join(r,f)),T=c.locale===_?s:c.locale;b(l)||await x(l,JSON.stringify({...c,rbacTeams:e||[],version:L,locale:T}),"utf-8")})}export{pt as prepareAiSearchDocuments};

package/dist/server/plugins/search/documents/search-documents.js

@@ -1 +1 @@
-import{REDOCLY_ROUTE_RBAC as D,REDOCLY_TEAMS_RBAC as p}from"@redocly/config";import{existsSync as _}from"fs";import{rm as w}from"node:fs/promises";import{DEFAULT_LOCALE_PLACEHOLDER as x}from"../../../../constants/common.js";import{SEARCH_DATA_EXPORT_FOLDER as T}from"../../../constants/plugins/search.js";import{isBuildMode as h}from"../../../utils/envs/is-build-mode.js";import{logger as c}from"../../../tools/notifiers/logger.js";import{telemetry as b}from"../../../telemetry/index.js";import{extractTeamsForSearch as O,getRbacTeamsForSearch as $}from"../../../utils/index.js";import{getSearchDocumentGroup as M}from"../utils.js";async function G(S,t,f){c.info("Preparing search documents and create indexes..."),h()&&_(`${t.outdir}/${T}`)&&await w(`${t.outdir}/${T}`,{recursive:!0});const R=c.startTiming(),v=t.getConfig().rbac,F=[x,...S.localeFolders.map(s=>s.toLowerCase())];for(const s of F){const i=t.getAllRoutesForLocale(s);for(const r of i){const d=new Map,{product:n}=r,A=await r.getStaticData?.(r,{...t,contentDir:t.contentDir,parseMarkdoc:(a,e,u)=>t.parseMarkdoc(a,e,u)})||{},m=await r.getSearchDocuments?.(r,{...A,[p]:r[p],[D]:r[D]},t),o=r.versions?.find(a=>a.active),C=$(r,v??{});if(m&&m.length)for(const a in m){let e=m[a];const u=O(e?.[p]),g=u?.length?u:C,L=e.tags||[];e={...e,...o&&{version:o.version,isDefaultVersion:o.default,versionFolderId:o.folderId},...n&&{product:n},rbacTeams:g,tags:[...L,...g,...o?o.default?["v:default"]:[`v:${o.folderId}:${o.version}`]:["v:default"],...n?[`p:${n.name}`]:[]],url:e.url&&(e.path&&e.path.length>1?e.url:e.url.split("#")[0])};const l=M(e.facets);if(l){const E=d.get(l)??[];d.set(l,[...E,e])}}for(const[a,e]of d)await f.addDocuments(e,{locale:s,group:a,outDir:t.outdir})}}if(f.cleanupFacetValues(t),c.infoTime(R,"Search indexes created"),h()){c.info("Writing out search data...");const s=c.startTiming();await f.export(t.outdir);const i=c.infoTime(s,"Search data written");i&&b.sendTimingPerformedMessage(i)}}export{G as prepareSearchDocuments};
+import{REDOCLY_ROUTE_RBAC as D,REDOCLY_TEAMS_RBAC as p}from"@redocly/config";import{existsSync as E}from"fs";import{rm as _}from"node:fs/promises";import{DEFAULT_LOCALE_PLACEHOLDER as w}from"../../../../constants/common.js";import{SEARCH_DATA_EXPORT_FOLDER as T}from"../../../constants/plugins/search.js";import{isBuildMode as h}from"../../../utils/envs/is-build-mode.js";import{logger as c}from"../../../tools/notifiers/logger.js";import{telemetry as b}from"../../../telemetry/index.js";import{extractTeamsForSearch as O,getRbacTeamsForSearch as $}from"../../../utils/index.js";import{getSearchDocumentGroup as M}from"../utils.js";async function G(S,t,f){c.info("Preparing search documents and create indexes..."),h()&&E(`${t.outdir}/${T}`)&&await _(`${t.outdir}/${T}`,{recursive:!0});const F=c.startTiming(),R=t.getConfig().rbac,v=[w,...S.localeFolders.map(s=>s.toLowerCase())];for(const s of v){const i=t.getAllRoutesForLocale(s);for(const r of i){if(r.excludeFromSearch)continue;const d=new Map,{product:n}=r,A=await r.getStaticData?.(r,{...t,contentDir:t.contentDir,parseMarkdoc:(a,e,u)=>t.parseMarkdoc(a,e,u)})||{},m=await r.getSearchDocuments?.(r,{...A,[p]:r[p],[D]:r[D]},t),o=r.versions?.find(a=>a.active),C=$(r,R??{});if(m&&m.length)for(const a in m){let e=m[a];const u=O(e?.[p]),g=u?.length?u:C,L=e.tags||[];e={...e,...o&&{version:o.version,isDefaultVersion:o.default,versionFolderId:o.folderId},...n&&{product:n},rbacTeams:g,tags:[...L,...g,...o?o.default?["v:default"]:[`v:${o.folderId}:${o.version}`]:["v:default"],...n?[`p:${n.name}`]:[]],url:e.url&&(e.path&&e.path.length>1?e.url:e.url.split("#")[0])};const l=M(e.facets);if(l){const x=d.get(l)??[];d.set(l,[...x,e])}}for(const[a,e]of d)await f.addDocuments(e,{locale:s,group:a,outDir:t.outdir})}}if(f.cleanupFacetValues(t),c.infoTime(F,"Search indexes created"),h()){c.info("Writing out search data...");const s=c.startTiming();await f.export(t.outdir);const i=c.infoTime(s,"Search data written");i&&b.sendTimingPerformedMessage(i)}}export{G as prepareSearchDocuments};

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

@@ -1 +1 @@
-import{appendFile as A}from"node:fs/promises";import{existsSync as R}from"node:fs";import m from"node:path";import{Client as $}from"typesense";import{SEARCH_GROUP_FACET_FIELD as D,SEARCH_PRODUCT_FIELD as I,SEARCH_RBAC_FIELD as g,SEARCH_VERSION_FIELD as f}from"../../../../../constants/common.js";import{BASE_SEARCH_DOCUMENT as v,DEFAULT_ORGANIZATION_ID as P,DEFAULT_PROJECT_ID as O,DEFAULT_TYPESENSE_API_KEY as N,DEFAULT_TYPESENSE_API_URL as L,DISABLE_DEEP_LINK_IF_FIELDS_EXIST as C,HIGHLIGHTED_TEXT_MAX_LENGTH as b,SEARCH_DATA_EXPORT_FOLDER as F,SEARCH_DOCUMENT_METADATA_KEY as w,SEARCH_GROUP_LIMIT as k,SEARCH_MAX_FACET_VALUES as S,SEARCH_MAX_INMEMORY_DOCUMENTS_COUNT as M}from"../../../../constants/plugins/search.js";import{telemetryTraceStep as T}from"../../../../telemetry/helpers/trace-step.js";import{isBuildMode as j}from"../../../../utils/envs/is-build-mode.js";import{isDevelopMode as h}from"../../../../utils/envs/is-develop-mode.js";import{logger as x}from"../../../../tools/notifiers/logger.js";import{ensureDir as _}from"../../../../utils/index.js";class z{#e=null;#i="";#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:"parameters",type:"object[]",facet:!1,optional:!0},{name:I,type:"string",facet:!0,optional:!0},{name:f,type:"object",facet:!0,optional:!0},{name:g,type:"string[]",facet:!0},{name:"metadata_curated",type:"auto",facet:!1,optional:!0},{name:"metadata_keywords_excludes",type:"auto",facet:!1,optional:!0},{name:"metadata_keywords_includes",type:"auto",facet:!1,optional:!0}];#s=new Map;#o={ORGANIZATION_ID:process.env.ORGANIZATION_ID||(h()?P:""),PROJECT_ID:process.env.PROJECT_ID||(h()?O:""),TYPESENSE_API_URL:process.env.TYPESENSE_API_URL||(h()?L:""),TYPESENSE_API_KEY:process.env.TYPESENSE_API_KEY||(h()?N:"")};constructor(){if(!j()){for(const[e,t]of Object.entries(this.#o))if(!t)throw new Error(`Cannot initialize search index. ${e} is not set`);this.#i=`${this.#o.ORGANIZATION_ID}_${this.#o.PROJECT_ID}_`,this.#e=new $({nodes:[{url:this.#o.TYPESENSE_API_URL}],apiKey:this.#o.TYPESENSE_API_KEY,connectionTimeoutSeconds:5})}}async initIndexSchema(e){this.#_(e),h()&&await this.#m()}async addDocuments(e,t){e.push(v);const{locale:r,outDir:i}=t,o=e.map(a=>{const s={...a},n=a[w];return n&&(n.curated&&(s.metadata_curated=n.curated),n.excludes&&(s.metadata_keywords_excludes=n.excludes),n.includes&&(s.metadata_keywords_includes=n.includes)),s});if(h()){if(o.length){await this.#p(r);try{const a=o.map(s=>({url:s.url,title:s.title,text:s.text,path:s.path,httpMethod:s.httpMethod,httpPath:s.httpPath,parameters:s.parameters,[I]:s.product?s.product.name:"",[g]:s.rbacTeams??[],[f]:s.version?{isDefault:s.isDefaultVersion,version:s.version,folderId:s.versionFolderId}:{isDefault:!0},...s.facets}));await this.#e?.collections(r).documents().import(a)}catch(a){if(a.importResults)for(const s of a.importResults)s.success===!1&&x.error(`Error adding document to collection: ${r}: ${s.error}`)}}}else{const a=this.#s.get(r)??[];this.#s.set(r,a.concat(o)),a.length+e.length>=M&&await this.exportDocuments(i)}}async search(e){return await T("search",async t=>{const{query:r,locale:i,filter:o,loadMore:a,auth:s}=e,n=h()?i:this.#c(i),l={collection:n,q:r||"*",query_by:this.#l(),max_facet_values:S};if(t?.setAttribute("collectionName",n),t?.setAttribute("locale",i),this.#e)if(a){const{groupKey:c,offset:u}=a,p={offset:u,filter_by:this.#r(s,o),facet_by:"*"};return t?.setAttribute("isLoadMore",!0),t?.setAttribute("filter",p.filter_by),this.#u(await this.#e.collections(n).documents().search({...l,...p}),c)}else{const c={group_by:this.#d(),group_limit:k,filter_by:this.#r(s,o)};t?.setAttribute("groups",c.group_by),t?.setAttribute("filter",c.filter_by);const u=[c,...this.#E(s,o)];return this.#f(await this.#e?.multiSearch.perform({searches:u},l),o)}else return{facets:{},documents:{}}})}#u(e,t){const r={facets:{},documents:{[t]:[]}};if(e.hits&&e.hits.length)for(const i of e.hits)r.documents[t].push({document:this.#n(i),highlight:this.#a(i)});return r}#f(e,t){const r={facets:{},documents:{}};for(const i of this.#y(t))r.documents[i]=[];if("results"in e)for(const i of e.results){if(i.facet_counts&&i.facet_counts.length)for(const o of i.facet_counts)r.facets[o.field_name]=o.counts.map(a=>({value:a.value,count:a.count}));if(i.grouped_hits&&i.grouped_hits.length)for(const o of i.grouped_hits){const a=o.group_key[0],s=[];for(const n of o.hits)s.push({document:this.#n(n),highlight:this.#a(n)});r.documents[a]=s}}return r}#n(e){return this.#h(e)}#a(e){const t={},r=[];for(const[i,o]of Object.entries(e.highlight??{}))if(Array.isArray(o)){if(i==="path"){const a=o,s=[];for(const n of a)s.push(n.snippet);t.path=s}else if(i==="parameters"){const a=o;for(const s of a){let n=!1;for(const[l,c]of Object.entries(s))if(l!=="deepLink")if(Array.isArray(c))for(const u of c)u.matched_tokens?.length&&(n=!0);else c.matched_tokens?.length&&(n=!0);if(n){const l={name:s.name?.snippet||"",description:s.description?.snippet||"",place:s.place?.snippet||"",path:s.path?.map(c=>c?.snippet)||[]};t.parameters=[l];break}}}}else t[i]=o.snippet,r.push(i);for(const[i,o]of Object.entries(e.document))!r.includes(i)&&typeof o=="string"&&(t[i]=o.length>b?`${o.substring(0,b)}...`:o);return t.parameters||(t.parameters=[]),t}#h(e){let t;const r=Object.keys(e.highlight);for(const o of C)if(r.some(a=>a===o))return e.document;const i=e.highlight.parameters;if(i){for(const o of i)for(const[a,s]of Object.entries(o))if(a!=="deepLink"){if(Array.isArray(s)){for(const n of s)if(n.matched_tokens?.length){t=o.deepLink.snippet;break}}else if(s.matched_tokens?.length){t=o.deepLink.snippet;break}}}if(t){const o=t.split("#")[1];return{...e.document,url:`${e.document.url}#${o}`}}return e.document}async exportDocuments(e){const t='{"documents":[',r=_(m.join(e,F));for(const[i,o]of this.#s){if(o.length===0)continue;const a=_(m.join(r,`${i}.json`)),s=!R(a),n=JSON.stringify(o).substring(1).slice(0,-1),l=s?t+n:","+n;await A(a,l,{encoding:"utf8"}),this.#s.set(i,[])}}async exportIndexes(e){const t=_(m.join(e,F));for(const r of this.#s.keys()){const i=_(m.join(t,`${r}.json`)),o=`],"schemaFields":${JSON.stringify(this.#t)}}`;await A(i,o,{encoding:"utf8"})}}async import(e){}async countFacets(e,t){return await T("search.facets",async r=>{const{locale:i,query:o,facetQuery:a,filter:s,field:n,auth:l}=e,c=h()?i:this.#c(i),u={q:o||"*",query_by:this.#l(),facet_by:"*",facet_query:this.#g(a,n),filter_by:this.#r(l,s,n),max_facet_values:S};if(r?.setAttribute("collectionName",c),r?.setAttribute("query",u.q),r?.setAttribute("facetQuery",u.facet_query),r?.setAttribute("filter",u.filter_by),this.#e){const p={},d=await this.#e.collections(c).documents().search(u);if(d.facet_counts&&d.facet_counts.length)for(const y of d.facet_counts)p[y.field_name]=y.counts.map(E=>({value:E.value,count:E.count,isCounterVisible:!!o||(s?.length||0)>0}));return p}else return{}})}#c(e){return`${this.#i}${e}`}async#p(e){const t=await this.#e?.collections().retrieve();t&&t.length&&t.find(r=>r.name===e)||await this.#e?.collections().create({name:e,fields:this.#t,enable_nested_fields:!0})}async#m(){const e=await this.#e?.collections().retrieve();for(const t of e??[])await this.#e?.collections(t.name).delete()}#_(e){for(const[t]of e)this.#t.find(r=>r.name===t)||this.#t.push({name:t,type:"string",facet:!0,optional:!0})}#l(){return this.#t.filter(e=>!e.facet&&!e.name.startsWith("metadata_")).map(e=>e.name).join(",")}#d(){return this.#t.filter(e=>e.facet&&e.name===D).map(e=>e.name).join(",")}#r(e,t,r){const i=`${g}:[${e.teams.map(a=>`'${a}'`).join(", ")}]`;let o=`${f}.isDefault:true`;if(t&&t.length){const a=t.filter(n=>n.field!==r&&n.field!==f).map(n=>{const l=n.values.map(c=>`'${c}'`);return l.length?`${n.field}:[${l.join(", ")}]`:""}).join(" && "),s=t.find(n=>n.field===f);if(s&&s.values.length&&s.values.length===2){const n=s.values[0],l=s.values[1],c=`(${f}.folderId:! ${n} && ${f}.isDefault:true)`,u=`(${f}.folderId:${n} && ${f}.version:${l})`;o=`(${c} || ${u})`}return a?`${i} && ${a} && ${o}`:`${i} && ${o}`}else return`${i} && ${o}`}#g(e,t){return e&&t?`${t}:${e}`:""}#y(e){const t=[];if(e&&e.length)for(const r of e)r.field===D&&t.push(...r.values);return t}#E(e,t){const r=[],i=this.#t.filter(o=>o.facet);for(const o of i){const a={facet_by:o.name,filter_by:this.#r(e,t,o.name)};r.push(a)}return r}cleanupFacetValues(e){const t=e.getSearchFacets();t.forEach(r=>{r.values=[]}),e.setSearchFacets(t)}}export{z as Typesense};
+import{appendFile as A}from"node:fs/promises";import{existsSync as R}from"node:fs";import m from"node:path";import{Client as $}from"typesense";import{SEARCH_GROUP_FACET_FIELD as D,SEARCH_PRODUCT_FIELD as b,SEARCH_RBAC_FIELD as g,SEARCH_VERSION_FIELD as f}from"../../../../../constants/common.js";import{BASE_SEARCH_DOCUMENT as O,DEFAULT_ORGANIZATION_ID as v,DEFAULT_PROJECT_ID as P,DEFAULT_TYPESENSE_API_KEY as N,DEFAULT_TYPESENSE_API_URL as L,DISABLE_DEEP_LINK_IF_FIELDS_EXIST as C,HIGHLIGHTED_TEXT_MAX_LENGTH as I,SEARCH_DATA_EXPORT_FOLDER as F,SEARCH_DOCUMENT_METADATA_KEY as w,SEARCH_GROUP_LIMIT as k,SEARCH_MAX_FACET_VALUES as S,SEARCH_MAX_INMEMORY_DOCUMENTS_COUNT as M}from"../../../../constants/plugins/search.js";import{telemetryTraceStep as T}from"../../../../telemetry/helpers/trace-step.js";import{isBuildMode as j}from"../../../../utils/envs/is-build-mode.js";import{isDevelopMode as h}from"../../../../utils/envs/is-develop-mode.js";import{logger as x}from"../../../../tools/notifiers/logger.js";import{ensureDir as d}from"../../../../utils/index.js";class z{#e=null;#r="";#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},{name:"parameters",type:"object[]",facet:!1,optional:!0},{name:b,type:"string",facet:!0,optional:!0},{name:f,type:"object",facet:!0,optional:!0},{name:g,type:"string[]",facet:!0},{name:"metadata_curated",type:"auto",facet:!1,optional:!0},{name:"metadata_keywords_excludes",type:"auto",facet:!1,optional:!0},{name:"metadata_keywords_includes",type:"auto",facet:!1,optional:!0}];#s=new Map;#o={ORGANIZATION_ID:process.env.ORGANIZATION_ID||(h()?v:""),PROJECT_ID:process.env.PROJECT_ID||(h()?P:""),TYPESENSE_API_URL:process.env.TYPESENSE_API_URL||(h()?L:""),TYPESENSE_API_KEY:process.env.TYPESENSE_API_KEY||(h()?N:"")};constructor(){if(!j()){for(const[e,t]of Object.entries(this.#o))if(!t)throw new Error(`Cannot initialize search index. ${e} is not set`);this.#r=`${this.#o.ORGANIZATION_ID}_${this.#o.PROJECT_ID}_`,this.#e=new $({nodes:[{url:this.#o.TYPESENSE_API_URL}],apiKey:this.#o.TYPESENSE_API_KEY,connectionTimeoutSeconds:5})}}async initIndexSchema(e){this.#d(e),h()&&await this.#m()}async addDocuments(e,t){e.push(O);const{locale:i,outDir:r}=t,o=e.map(a=>{const s={...a},n=a[w];return n&&(n.curated&&(s.metadata_curated=n.curated),n.excludes&&(s.metadata_keywords_excludes=n.excludes),n.includes&&(s.metadata_keywords_includes=n.includes)),s});if(h()){if(o.length){await this.#p(i);try{const a=o.map(s=>({url:s.url,title:s.title,text:s.text,path:s.path,httpMethod:s.httpMethod,isAdditionalOperation:s.isAdditionalOperation,httpPath:s.httpPath,parameters:s.parameters,[b]:s.product?s.product.name:"",[g]:s.rbacTeams??[],[f]:s.version?{isDefault:s.isDefaultVersion,version:s.version,folderId:s.versionFolderId}:{isDefault:!0},...s.facets}));await this.#e?.collections(i).documents().import(a)}catch(a){if(a.importResults)for(const s of a.importResults)s.success===!1&&x.error(`Error adding document to collection: ${i}: ${s.error}`)}}}else{const a=this.#s.get(i)??[];this.#s.set(i,a.concat(o)),a.length+e.length>=M&&await this.exportDocuments(r)}}async search(e){return await T("search",async t=>{const{query:i,locale:r,filter:o,loadMore:a,auth:s}=e,n=h()?r:this.#c(r),l={collection:n,q:i||"*",query_by:this.#l(),max_facet_values:S};if(t?.setAttribute("collectionName",n),t?.setAttribute("locale",r),this.#e)if(a){const{groupKey:c,offset:u}=a,p={offset:u,filter_by:this.#i(s,o),facet_by:"*"};return t?.setAttribute("isLoadMore",!0),t?.setAttribute("filter",p.filter_by),this.#u(await this.#e.collections(n).documents().search({...l,...p}),c)}else{const c={group_by:this.#_(),group_limit:k,filter_by:this.#i(s,o)};t?.setAttribute("groups",c.group_by),t?.setAttribute("filter",c.filter_by);const u=[c,...this.#E(s,o)];return this.#f(await this.#e?.multiSearch.perform({searches:u},l),o)}else return{facets:{},documents:{}}})}#u(e,t){const i={facets:{},documents:{[t]:[]}};if(e.hits&&e.hits.length)for(const r of e.hits)i.documents[t].push({document:this.#n(r),highlight:this.#a(r)});return i}#f(e,t){const i={facets:{},documents:{}};for(const r of this.#y(t))i.documents[r]=[];if("results"in e)for(const r of e.results){if(r.facet_counts&&r.facet_counts.length)for(const o of r.facet_counts)i.facets[o.field_name]=o.counts.map(a=>({value:a.value,count:a.count}));if(r.grouped_hits&&r.grouped_hits.length)for(const o of r.grouped_hits){const a=o.group_key[0],s=[];for(const n of o.hits)s.push({document:this.#n(n),highlight:this.#a(n)});i.documents[a]=s}}return i}#n(e){return this.#h(e)}#a(e){const t={},i=[];for(const[r,o]of Object.entries(e.highlight??{}))if(Array.isArray(o)){if(r==="path"){const a=o,s=[];for(const n of a)s.push(n.snippet);t.path=s}else if(r==="parameters"){const a=o;for(const s of a){let n=!1;for(const[l,c]of Object.entries(s))if(l!=="deepLink")if(Array.isArray(c))for(const u of c)u.matched_tokens?.length&&(n=!0);else c.matched_tokens?.length&&(n=!0);if(n){const l={name:s.name?.snippet||"",description:s.description?.snippet||"",place:s.place?.snippet||"",path:s.path?.map(c=>c?.snippet)||[]};t.parameters=[l];break}}}}else t[r]=o.snippet,i.push(r);for(const[r,o]of Object.entries(e.document))!i.includes(r)&&typeof o=="string"&&(t[r]=o.length>I?`${o.substring(0,I)}...`:o);return t.parameters||(t.parameters=[]),t}#h(e){let t;const i=Object.keys(e.highlight);for(const o of C)if(i.some(a=>a===o))return e.document;const r=e.highlight.parameters;if(r){for(const o of r)for(const[a,s]of Object.entries(o))if(a!=="deepLink"){if(Array.isArray(s)){for(const n of s)if(n.matched_tokens?.length){t=o.deepLink.snippet;break}}else if(s.matched_tokens?.length){t=o.deepLink.snippet;break}}}if(t){const o=t.split("#")[1];return{...e.document,url:`${e.document.url}#${o}`}}return e.document}async exportDocuments(e){const t='{"documents":[',i=d(m.join(e,F));for(const[r,o]of this.#s){if(o.length===0)continue;const a=d(m.join(i,`${r}.json`)),s=!R(a),n=JSON.stringify(o).substring(1).slice(0,-1),l=s?t+n:","+n;await A(a,l,{encoding:"utf8"}),this.#s.set(r,[])}}async exportIndexes(e){const t=d(m.join(e,F));for(const i of this.#s.keys()){const r=d(m.join(t,`${i}.json`)),o=`],"schemaFields":${JSON.stringify(this.#t)}}`;await A(r,o,{encoding:"utf8"})}}async import(e){}async countFacets(e,t){return await T("search.facets",async i=>{const{locale:r,query:o,facetQuery:a,filter:s,field:n,auth:l}=e,c=h()?r:this.#c(r),u={q:o||"*",query_by:this.#l(),facet_by:"*",facet_query:this.#g(a,n),filter_by:this.#i(l,s,n),max_facet_values:S};if(i?.setAttribute("collectionName",c),i?.setAttribute("query",u.q),i?.setAttribute("facetQuery",u.facet_query),i?.setAttribute("filter",u.filter_by),this.#e){const p={},_=await this.#e.collections(c).documents().search(u);if(_.facet_counts&&_.facet_counts.length)for(const y of _.facet_counts)p[y.field_name]=y.counts.map(E=>({value:E.value,count:E.count,isCounterVisible:!!o||(s?.length||0)>0}));return p}else return{}})}#c(e){return`${this.#r}${e}`}async#p(e){const t=await this.#e?.collections().retrieve();t&&t.length&&t.find(i=>i.name===e)||await this.#e?.collections().create({name:e,fields:this.#t,enable_nested_fields:!0})}async#m(){const e=await this.#e?.collections().retrieve();for(const t of e??[])await this.#e?.collections(t.name).delete()}#d(e){for(const[t]of e)this.#t.find(i=>i.name===t)||this.#t.push({name:t,type:"string",facet:!0,optional:!0})}#l(){return this.#t.filter(e=>!e.facet&&!e.name.startsWith("metadata_")&&e.name!=="isAdditionalOperation").map(e=>e.name).join(",")}#_(){return this.#t.filter(e=>e.facet&&e.name===D).map(e=>e.name).join(",")}#i(e,t,i){const r=`${g}:[${e.teams.map(a=>`'${a}'`).join(", ")}]`;let o=`${f}.isDefault:true`;if(t&&t.length){const a=t.filter(n=>n.field!==i&&n.field!==f).map(n=>{const l=n.values.map(c=>`'${c}'`);return l.length?`${n.field}:[${l.join(", ")}]`:""}).join(" && "),s=t.find(n=>n.field===f);if(s&&s.values.length&&s.values.length===2){const n=s.values[0],l=s.values[1],c=`(${f}.folderId:! ${n} && ${f}.isDefault:true)`,u=`(${f}.folderId:${n} && ${f}.version:${l})`;o=`(${c} || ${u})`}return a?`${r} && ${a} && ${o}`:`${r} && ${o}`}else return`${r} && ${o}`}#g(e,t){return e&&t?`${t}:${e}`:""}#y(e){const t=[];if(e&&e.length)for(const i of e)i.field===D&&t.push(...i.values);return t}#E(e,t){const i=[],r=this.#t.filter(o=>o.facet);for(const o of r){const a={facet_by:o.name,filter_by:this.#i(e,t,o.name)};i.push(a)}return i}cleanupFacetValues(e){const t=e.getSearchFacets();t.forEach(i=>{i.values=[]}),e.setSearchFacets(t)}}export{z as Typesense};

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/plugins/sitemap/index.js

@@ -1 +1 @@
-import{SitemapStream as l,streamToPromise as p}from"sitemap";import{Readable as d}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/common.js";import{withPathPrefix as P}from"@redocly/theme/core/utils";import{logger as a}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;a.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("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=>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}),f=await Promise.all(o.map(async s=>{const c=await v(s,n.cache);return{url:P(s.slug),priority:c}})),u=await p(d.from(f).pipe(m)).then(s=>s.toString());y(e,u),t.hasSitemap=!0}catch(e){r?.error(e),a.error(`Error creating sitemap: ${e.message}`)}})}}}export{$ as sitemapPlugin};
+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/common.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("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/providers/database/base-repository.d.ts

@@ -1,12 +1,12 @@
 import type { DatabaseClient } from './client.js';
-import type { DatabaseInitializationResult } from './types.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(initializationResult: DatabaseInitializationResult);
+    protected constructor(dbConnection: DatabaseConnection);
     close(): Promise<void>;
     sync(): Promise<void>;
 }

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

@@ -1 +1 @@
-class n{static#e="ORGANIZATION_ID";static#t="PROJECT_ID";organizationId;projectId;databaseClient;path;constructor(t){const e=this.#s();this.organizationId=this.#n(e),this.projectId=this.#r(e),this.databaseClient=t.client,this.path=t.path}async close(){await this.databaseClient.close()}async sync(){await this.databaseClient.sync()}#n=t=>{const e=process.env.ORGANIZATION_ID;if(e)return e;if(t)return n.#e;throw new Error("ORGANIZATION_ID environment variable is required. Ensure it is set in your environment configuration.")};#r=t=>{const e=process.env.PROJECT_ID;if(e)return e;if(t)return n.#t;throw new Error("PROJECT_ID environment variable is required. Ensure it is set in your environment configuration.")};#s=()=>!process.env.SQLD_REMOTE_DATABASE_URL&&!process.env.SQLD_REMOTE_DATABASE_AUTH_TOKEN}export{n as BaseRepository};
+class n{static#e="ORGANIZATION_ID";static#t="PROJECT_ID";organizationId;projectId;databaseClient;path;constructor(t){const e=this.#r();this.organizationId=this.#n(e),this.projectId=this.#i(e),this.databaseClient=t.client,this.path=t.path}async close(){await this.databaseClient.close()}async sync(){await this.databaseClient.sync()}#n=t=>{const e=process.env.ORGANIZATION_ID;if(e)return e;if(t)return n.#e;throw new Error("ORGANIZATION_ID environment variable is required. Ensure it is set in your environment configuration.")};#i=t=>{const e=process.env.PROJECT_ID;if(e)return e;if(t)return n.#t;throw new Error("PROJECT_ID environment variable is required. Ensure it is set in your environment configuration.")};#r=()=>!process.env.SQLD_REMOTE_DATABASE_URL&&!process.env.SQLD_REMOTE_DATABASE_AUTH_TOKEN}export{n as BaseRepository};

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

@@ -1,7 +1,10 @@
+export declare const CATALOG_LOCAL_DATABASE_NAME = "catalog-local.sqlite";
+export declare const CATALOG_LOCAL_DATABASE_FOLDER = "catalog-local";
+export declare const CATALOG_LOCAL_DATABASE_MIGRATIONS_FOLDER = "catalog-sqlite";
 export declare const MAIN_LOCAL_DATABASE_NAME = "main-local.sqlite";
 export declare const MAIN_LOCAL_DATABASE_FOLDER = "main-local";
-export declare const MAIN_DATABASE_MIGRATIONS_FOLDER = "main-sqlite";
-export declare const PLUGIN_STORAGE_LOCAL_DATABASE_NAME = "plugin-storage-local.sqlite";
-export declare const PLUGIN_STORAGE_LOCAL_DATABASE_FOLDER = "plugin-storage-local";
-export declare const PLUGIN_STORAGE_DATABASE_MIGRATIONS_FOLDER = "plugin-storage-sqlite";
+export declare const MAIN_LOCAL_DATABASE_MIGRATIONS_FOLDER = "main-sqlite";
+export declare const SQLD_REMOTE_DATABASE_NAME = "sqld-remote.sqlite";
+export declare const SQLD_REMOTE_DATABASE_FOLDER = "sqld-remote";
+export declare const SQLD_REMOTE_DATABASE_MIGRATIONS_FOLDER = "sqld-sqlite";
 //# sourceMappingURL=constants.d.ts.map

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

@@ -1 +1 @@
-const A="main-local.sqlite",_="main-local",o="main-sqlite",t="plugin-storage-local.sqlite",l="plugin-storage-local",E="plugin-storage-sqlite";export{o as MAIN_DATABASE_MIGRATIONS_FOLDER,_ as MAIN_LOCAL_DATABASE_FOLDER,A as MAIN_LOCAL_DATABASE_NAME,E as PLUGIN_STORAGE_DATABASE_MIGRATIONS_FOLDER,l as PLUGIN_STORAGE_LOCAL_DATABASE_FOLDER,t as PLUGIN_STORAGE_LOCAL_DATABASE_NAME};
+const A="catalog-local.sqlite",_="catalog-local",t="catalog-sqlite",o="main-local.sqlite",E="main-local",L="main-sqlite",O="sqld-remote.sqlite",l="sqld-remote",e="sqld-sqlite";export{_ as CATALOG_LOCAL_DATABASE_FOLDER,t as CATALOG_LOCAL_DATABASE_MIGRATIONS_FOLDER,A as CATALOG_LOCAL_DATABASE_NAME,E as MAIN_LOCAL_DATABASE_FOLDER,L as MAIN_LOCAL_DATABASE_MIGRATIONS_FOLDER,o as MAIN_LOCAL_DATABASE_NAME,l as SQLD_REMOTE_DATABASE_FOLDER,e as SQLD_REMOTE_DATABASE_MIGRATIONS_FOLDER,O as SQLD_REMOTE_DATABASE_NAME};

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

@@ -1 +1 @@
-import c from"node:path";import{cpSync as m,existsSync as e,mkdirSync as l}from"node:fs";import{logger as t}from"../../tools/notifiers/logger.js";import{fromCurrentDir as u}from"../../utils/index.js";const y=r=>{const s=["catalog-sqlite","main-sqlite","plugin-storage-sqlite"];for(const i of s){const o=u(import.meta.url,`./databases/${i}/migrations`),a=c.join(r.serverOutDir,"migrations",i);if(!e(o)){t.warn(`Migrations folder not found at ${o}`);continue}e(r.serverOutDir)||l(r.serverOutDir,{recursive:!0});try{m(o,a,{recursive:!0}),t.info("Successfully copied migrations")}catch(n){t.error("Failed to copy migrations folder: %s",n)}}};export{y as copyMigrationsFolder};
+import c from"node:path";import{cpSync as m,existsSync as e,mkdirSync as l}from"node:fs";import{logger as t}from"../../tools/notifiers/logger.js";import{fromCurrentDir as f}from"../../utils/index.js";const y=r=>{const s=["catalog-sqlite","main-sqlite","sqld-sqlite"];for(const i of s){const o=f(import.meta.url,`./databases/${i}/migrations`),a=c.join(r.serverOutDir,"migrations",i);if(!e(o)){t.warn(`Migrations folder not found at ${o}`);continue}e(r.serverOutDir)||l(r.serverOutDir,{recursive:!0});try{m(o,a,{recursive:!0}),t.info("Successfully copied migrations")}catch(n){t.error("Failed to copy migrations folder: %s",n)}}};export{y as copyMigrationsFolder};

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

@@ -0,0 +1,6 @@
+import type { DatabaseConnection, DatabaseConnectionOptions, DatabaseName } from './types.js';
+export declare class DatabaseConnectionFactory {
+    #private;
+    static create(databaseName: DatabaseName, 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 e}from"../../tools/notifiers/logger.js";import{CATALOG_LOCAL_DATABASE_MIGRATIONS_FOLDER as r,CATALOG_LOCAL_DATABASE_FOLDER as i,CATALOG_LOCAL_DATABASE_NAME as s,MAIN_LOCAL_DATABASE_MIGRATIONS_FOLDER as _,MAIN_LOCAL_DATABASE_FOLDER as E,MAIN_LOCAL_DATABASE_NAME as l,SQLD_REMOTE_DATABASE_FOLDER as c,SQLD_REMOTE_DATABASE_MIGRATIONS_FOLDER as D,SQLD_REMOTE_DATABASE_NAME as T}from"./constants.js";import{LocalDatabaseInitializationStrategy as n,RemoteDatabaseInitializationStrategy as L}from"./database-initialization-strategy.js";import{DatabaseConnectionsManager as O}from"./database-connections-manager.js";class g{static async create(a,t){switch(a){case"main-local":return await this.#a(t);case"catalog-local":return await this.#t(t);case"sqld-remote":return await this.#e(t);default:return null}}static async#a(a){return await new n().initialize({...a,databaseName:l,additionalFolder:E,migrationsFolder:_})}static async#t(a){return await new n().initialize({...a,databaseName:s,additionalFolder:i,migrationsFolder:r})}static async#e(a){const t=process.env.SQLD_REMOTE_DATABASE_URL&&process.env.SQLD_REMOTE_DATABASE_AUTH_TOKEN,A=a.sqldRemoteDatabaseUrl&&a.sqldRemoteDatabaseAuthToken;if(!t&&!A)return process.env.NEW_CATALOG_ENABLED==="true"&&e.warn("SQLD_REMOTE_DATABASE_URL and SQLD_REMOTE_DATABASE_AUTH_TOKEN env variables or sqldRemoteDatabaseUrl and sqldRemoteDatabaseAuthToken options not set - remote database will not be initialized"),null;try{return await O.getConnection({config:{...a,databaseName:T,additionalFolder:c,migrationsFolder:D,syncUrl:process.env.SQLD_REMOTE_DATABASE_URL||a.sqldRemoteDatabaseUrl,authToken:process.env.SQLD_REMOTE_DATABASE_AUTH_TOKEN||a.sqldRemoteDatabaseAuthToken},strategy:new L})}catch(o){return e.error("Remote database connection initialization failed",o),null}}}export{g as DatabaseConnectionFactory};

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

@@ -1,12 +1,12 @@
-import type { DatabaseInitConnectionOptions, DatabaseInitializationResult } from './types.js';
+import type { DatabaseConnectionInitOptions, DatabaseConnection } from './types.js';
 import { type DatabaseInitializationStrategy } from './database-initialization-strategy.js';
-type GetConnectionParams<TConfig extends DatabaseInitConnectionOptions> = {
+type GetConnectionParams<TConfig extends DatabaseConnectionInitOptions> = {
     config: TConfig;
     strategy: DatabaseInitializationStrategy;
 };
 export declare class DatabaseConnectionsManager {
     #private;
-    static getConnection<TConfig extends DatabaseInitConnectionOptions>({ config, strategy, }: GetConnectionParams<TConfig>): Promise<DatabaseInitializationResult | null>;
+    static getConnection<TConfig extends DatabaseConnectionInitOptions>({ config, strategy, }: GetConnectionParams<TConfig>): Promise<DatabaseConnection | null>;
 }
 export {};
 //# sourceMappingURL=database-connections-manager.d.ts.map

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

@@ -1 +1 @@
-import{logger as o}from"../../tools/notifiers/logger.js";const r="_redocly_db_preconnect_cache_";class t{static get#t(){const e=globalThis;if(!e[r]){const i={connections:new Map,pendingConnections:new Map,failedConnections:new Set};e[r]=i}return e[r]}static get#c(){return t.#t.connections}static get#e(){return t.#t.failedConnections}static get#i(){return t.#t.pendingConnections}static async getConnection({config:e,strategy:i}){const n=t.#l(e),c=t.#c.get(n);return c||t.#n({config:e,key:n,strategy:i})}static#n=async({config:e,key:i,strategy:n})=>{let c=t.#i.get(i);c||(t.#e.has(i)&&o.warn("There was an error connecting to the database, retrying..."),c=t.#r(e,i,n),t.#i.set(i,c));try{return await c}catch{return t.#e.add(i),null}finally{t.#i.delete(i)}};static#r=async(e,i,n)=>{const c=await n.initialize(e);return t.#c.set(i,c),t.#e.delete(i),c};static#l=e=>`${e.baseDbDir}/${e.additionalFolder}/${e.databaseName}`}export{t as DatabaseConnectionsManager};
+import{logger as o}from"../../tools/notifiers/logger.js";const n="_redocly_db_preconnect_cache_";class t{static get#t(){const e=globalThis;if(!e[n]){const i={connections:new Map,pendingConnections:new Map,failedConnections:new Set};e[n]=i}return e[n]}static get#c(){return t.#t.connections}static get#e(){return t.#t.failedConnections}static get#i(){return t.#t.pendingConnections}static async getConnection({config:e,strategy:i}){const r=t.#l(e),c=t.#c.get(r);return c||t.#r({config:e,key:r,strategy:i})}static#r=async({config:e,key:i,strategy:r})=>{let c=t.#i.get(i);c||(t.#e.has(i)&&o.warn("Error connecting to the database, retrying..."),c=t.#n(e,i,r),t.#i.set(i,c));try{return await c}catch(l){return o.error("Error connecting to the database",l),t.#e.add(i),null}finally{t.#i.delete(i)}};static#n=async(e,i,r)=>{const c=await r.initialize(e);return t.#c.set(i,c),t.#e.delete(i),c};static#l=e=>`${e.baseDbDir}/${e.additionalFolder}/${e.databaseName}`}export{t as DatabaseConnectionsManager};

package/dist/server/providers/database/database-initialization-strategy.d.ts

@@ -1,12 +1,9 @@
-import type { DatabaseInitConnectionOptions, DatabaseInitializationResult } from './types.js';
+import type { DatabaseConnectionOptions, DatabaseConnection, DatabaseConnectionInitOptions, RemoteDatabaseConnectionInitOptions } from './types.js';
 export type DatabaseInitializationStrategy = {
-    initialize(options: DatabaseInitConnectionOptions): Promise<DatabaseInitializationResult>;
+    initialize(options: DatabaseConnectionOptions): Promise<DatabaseConnection>;
 };
-export declare class DefaultDatabaseInitializationStrategy implements DatabaseInitializationStrategy {
-    initialize({ baseDbDir, databaseName, additionalFolder, }: DatabaseInitConnectionOptions): Promise<DatabaseInitializationResult>;
-}
 export declare class LocalDatabaseInitializationStrategy implements DatabaseInitializationStrategy {
-    initialize({ removeExisting, baseDbDir, runWithPragmaWalWriteOptimization, databaseName, additionalFolder, migrationsFolder, }: DatabaseInitConnectionOptions): Promise<DatabaseInitializationResult>;
+    initialize({ removeExisting, baseDbDir, runWithPragmaWalWriteOptimization, databaseName, additionalFolder, migrationsFolder, }: DatabaseConnectionInitOptions): Promise<DatabaseConnection>;
 }
 type RemoteDatabaseInitializationStrategyParams = {
     skipLogs?: boolean;
@@ -14,10 +11,7 @@ type RemoteDatabaseInitializationStrategyParams = {
 export declare class RemoteDatabaseInitializationStrategy implements DatabaseInitializationStrategy {
     #private;
     constructor(params?: RemoteDatabaseInitializationStrategyParams);
-    initialize({ removeExisting, baseDbDir, syncUrl, authToken, databaseName, additionalFolder, migrationsFolder, }: DatabaseInitConnectionOptions & {
-        syncUrl: string;
-        authToken: string;
-    }): Promise<DatabaseInitializationResult>;
+    initialize({ removeExisting, baseDbDir, syncUrl, authToken, databaseName, additionalFolder, migrationsFolder, }: RemoteDatabaseConnectionInitOptions): Promise<DatabaseConnection>;
 }
 export {};
 //# sourceMappingURL=database-initialization-strategy.d.ts.map

package/dist/server/providers/database/database-initialization-strategy.js

@@ -1 +1 @@
-import{logger as l}from"../../tools/notifiers/logger.js";import{DatabaseClient as p}from"./client.js";import{DatabasePathGenerator as d}from"./database-path-generator.js";import{retryAsyncOperation as h}from"./utils/retry-async-operation.js";class u{async initialize({baseDbDir:a,databaseName:t,additionalFolder:e}){const{databasePath:i}=await d.prepareDatabasePath({baseDir:a,databaseName:t,additionalFolder:e});return{client:await p.init({url:`file:${i}`}),path:i}}}class w{async initialize({removeExisting:a,baseDbDir:t,runWithPragmaWalWriteOptimization:e,databaseName:i,additionalFolder:r,migrationsFolder:c}){l.info("Initializing local database client...");const m=l.startTiming(),{databasePath:s}=await d.prepareDatabasePath({baseDir:t,databaseName:i,additionalFolder:r,removeExisting:a}),o={url:`file:${s}`},n=await p.init(o,{runWithPragmaWalWriteOptimization:e});return await n.migrate(t,c),l.infoTime(m,"Local database client initialized"),{client:n,path:s}}}class D{#t;#a;constructor(a){this.#t=a?.skipLogs??!1,this.#a=this.#t?void 0:l}async initialize({removeExisting:a,baseDbDir:t,syncUrl:e,authToken:i,databaseName:r,additionalFolder:c,migrationsFolder:m}){this.#a?.info("Initializing remote database client...");const s=this.#a?.startTiming();return await h(async()=>{const{databasePath:o}=await d.prepareDatabasePath({baseDir:t,databaseName:r,additionalFolder:c,removeExisting:a}),n=await p.init({url:`file:${o}`,syncUrl:e,authToken:i});return await n.migrate(t,m),this.#a?.infoTime(s??"","Remote database client initialized"),{client:n,path:o}},{maxRetries:3,retryStrategy:"exponential",delay:1e3,logger:this.#a,messages:{retry:"Retrying remote database client initialization",maxRetriesReached:"Max retries reached, remote database client initialization failed"}})}}export{u as DefaultDatabaseInitializationStrategy,w as LocalDatabaseInitializationStrategy,D as RemoteDatabaseInitializationStrategy};
+import{logger as r}from"../../tools/notifiers/logger.js";import{DatabaseClient as g}from"./client.js";import{DatabasePathGenerator as p}from"./database-path-generator.js";import{retryAsyncOperation as h}from"./utils/retry-async-operation.js";class u{async initialize({removeExisting:a,baseDbDir:t,runWithPragmaWalWriteOptimization:s,databaseName:o,additionalFolder:l,migrationsFolder:c}){r.info("Initializing local database client...");const m=r.startTiming(),{databasePath:e}=await p.prepareDatabasePath({baseDir:t,databaseName:o,additionalFolder:l,removeExisting:a}),n={url:`file:${e}`},i=await g.init(n,{runWithPragmaWalWriteOptimization:s});return await i.migrate(t,c),r.infoTime(m,"Local database client initialized"),{client:i,path:e}}}class w{#t;#a;constructor(a){this.#t=a?.skipLogs??!1,this.#a=this.#t?void 0:r}async initialize({removeExisting:a,baseDbDir:t,syncUrl:s,authToken:o,databaseName:l,additionalFolder:c,migrationsFolder:m}){this.#a?.info("Initializing remote database client...");const e=this.#a?.startTiming();return await h(async()=>{const{databasePath:n}=await p.prepareDatabasePath({baseDir:t,databaseName:l,additionalFolder:c,removeExisting:a}),i=await g.init({url:`file:${n}`,syncUrl:s,authToken:o});return await i.migrate(t,m),this.#a?.infoTime(e??"","Remote database client initialized"),{client:i,path:n}},{maxRetries:3,retryStrategy:"exponential",delay:1e3,logger:this.#a,messages:{retry:"Retrying remote database client initialization",maxRetriesReached:"Max retries reached, remote database client initialization failed"}})}}export{u as LocalDatabaseInitializationStrategy,w as RemoteDatabaseInitializationStrategy};

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

@@ -1 +1 @@
-import{logger as e}from"../../tools/notifiers/logger.js";import{DatabaseConnectionsManager as r}from"./database-connections-manager.js";import{CATALOG_DATABASE_MIGRATIONS_FOLDER as n,CATALOG_REMOTE_DATABASE_FOLDER as i,CATALOG_REMOTE_DATABASE_NAME as E}from"../../plugins/catalog-entities/database/consts.js";import{RemoteDatabaseInitializationStrategy as A}from"./database-initialization-strategy.js";class a{static#t=!1;static async init(s){if(!(process.env.REDOCLY_LOCAL_DEV==="true"||process.env.CI==="true")&&!a.#t)try{await a.#e(s)==="PRECONNECTED"&&(a.#t=!0)}catch(t){e.error("Failed to preconnect to databases",t)}}static#e=async s=>{const o=process.env.SQLD_REMOTE_DATABASE_URL,t=process.env.SQLD_REMOTE_DATABASE_AUTH_TOKEN;return!o||!t?(e.warn("SQLD_REMOTE_DATABASE_URL or SQLD_REMOTE_DATABASE_AUTH_TOKEN is not set yet"),"NOT_PRECONNECTED"):await r.getConnection({config:{baseDbDir:s,syncUrl:o,authToken:t,databaseName:E,additionalFolder:i,migrationsFolder:n},strategy:new A({skipLogs:!1})})?(e.info("Catalog entities database preconnected"),"PRECONNECTED"):(e.warn("Catalog entities database preconnect failed"),"NOT_PRECONNECTED")}}export{a as DatabasePreconnectService};
+import{logger as r}from"../../tools/notifiers/logger.js";import{DatabaseConnectionFactory as a}from"./database-connection-factory.js";class e{static#e=!1;static async init(t){if(!(process.env.REDOCLY_LOCAL_DEV==="true"||process.env.CI==="true")&&!e.#e)try{await e.#t(t)==="PRECONNECTED"&&(e.#e=!0)}catch(o){r.error("Failed to preconnect to sqld remote database",o)}}static#t=async t=>await a.create("sqld-remote",{baseDbDir:t})?(r.info("Sqld remote database preconnected"),"PRECONNECTED"):(r.warn("Sqld remote database preconnect failed"),"NOT_PRECONNECTED")}export{e as DatabasePreconnectService};

package/dist/server/providers/database/databases/catalog-sqlite/drizzle.config.d.ts

@@ -1,13 +1,10 @@
+export declare const SCHEMAS_PATH = "./src/server/providers/database/databases/catalog-sqlite/schemas/*";
 declare const _default: {
     schema: string;
     out: string;
     dialect: "turso";
     dbCredentials: {
         url: string;
-        authToken: string;
-    } | {
-        url: string;
-        authToken?: undefined;
     };
 };
 export default _default;

package/dist/server/providers/database/databases/catalog-sqlite/drizzle.config.js

@@ -1 +1 @@
-import{DatabasePathGenerator as s}from"../../database-path-generator";import{CATALOG_LOCAL_DATABASE_NAME as A,CATALOG_LOCAL_DATABASE_FOLDER as o,CATALOG_REMOTE_DATABASE_NAME as _,CATALOG_REMOTE_DATABASE_FOLDER as E}from"../../../../plugins/catalog-entities/database/consts";const t="./dist/server/esbuild/cache/server",d="./src/server/providers/database/databases/catalog-sqlite/schemas/*",n="./src/server/providers/database/databases/catalog-sqlite/migrations",i=()=>{const r=process.env.DB_MODE,e=process.env.SQLD_REMOTE_DATABASE_URL,a=process.env.SQLD_REMOTE_DATABASE_AUTH_TOKEN;return e&&a?{url:e,authToken:a}:r==="remote"?{url:s.generateDatabasePath({baseDir:t,databaseName:_,additionalFolder:E})}:{url:s.generateDatabasePath({baseDir:t,databaseName:A,additionalFolder:o})}};var D={schema:d,out:n,dialect:"turso",dbCredentials:i()};export{D as default};
+import{DatabasePathGenerator as a}from"../../database-path-generator.js";import{CATALOG_LOCAL_DATABASE_NAME as e,CATALOG_LOCAL_DATABASE_FOLDER as t}from"../../constants.js";const s="./dist/server/esbuild/cache/server",r="./src/server/providers/database/databases/catalog-sqlite/schemas/*",A="./src/server/providers/database/databases/catalog-sqlite/migrations",o=()=>({url:a.generateDatabasePath({baseDir:s,databaseName:e,additionalFolder:t})});var c={schema:r,out:A,dialect:"turso",dbCredentials:o()};export{r as SCHEMAS_PATH,c as default};

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/0002_add-scorecards-status.sql

@@ -0,0 +1 @@
+ALTER TABLE `entities` ADD `scorecards_status` text;