@redocly/realm 0.132.0 → 0.133.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @redocly/realm
 
+## 0.133.0-next.0
+
+### Minor Changes
+
+- 36c67eafc25: Fixed rendering of non-Latin characters by enforcing UTF-8 encoding.
+
+### Patch Changes
+
+- 8a1e45e9493: Fixed security vulnerability `GHSA-39q2-94rc-95cp` by upgrading `dompurify` to version `3.4.0`.
+- 27cc506931d: Updated `@redocly/openapi-core` to version `2.29.0`.
+- 39f8473e10e: Updated `@redocly/openapi-core` to version `2.27.1`.
+- db587e909d6: Fixed security vulnerability `CVE-2026-39356` by upgrading `drizzle-orm` to version `0.45.2`.
+- a1bb760b292: Fixed an issue where the tooltips in API docs and Replay might partially render outside the viewport.
+- b90d4351949: Fixed multiple moderate security vulnerabilities in `hono` dependency by upgrading it to version `4.12.14`.
+- d1c6eadeb44: Enter prerelease mode.
+- Updated dependencies [8a1e45e9493]
+- Updated dependencies [36c67eafc25]
+- Updated dependencies [27cc506931d]
+- Updated dependencies [f2a18386e51]
+- Updated dependencies [39f8473e10e]
+- Updated dependencies [a1bb760b292]
+- Updated dependencies [d1c6eadeb44]
+- Updated dependencies [4002f20f63b]
+  - @redocly/openapi-docs@3.21.0-next.0
+  - @redocly/theme@0.65.0-next.0
+  - @redocly/realm-asyncapi-sdk@0.11.0-next.0
+  - @redocly/portal-plugin-mock-server@0.18.0-next.0
+  - @redocly/portal-legacy-ui@0.16.0-next.0
+  - @redocly/asyncapi-docs@1.10.0-next.0
+  - @redocly/graphql-docs@1.10.0-next.0
+
 ## 0.132.0
 
 ### Minor Changes
@@ -8,7 +39,6 @@
 - 07483ec059: Added RBAC filtering for Apigee API products in developer onboarding app creation.
 - e88064ce2d: Added support for Excalidraw and PlantUML diagrams.
   Improved dark mode for Mermaid diagrams.
-- e756f2aad5: Added a `palette` configuration option that applies one of built-in color palettes to the project.
 - ae3272861b: Added support for `x-badges` in OpenAPI and AsyncAPI parameters and schema properties.
   Badges can now be rendered before and after field names.
 - ce5a165177: Added support for `or` functions in RBAC conditions within Markdoc content.
@@ -129,7 +159,6 @@
 - 20b850b446a: Fixed an issue where an API path remained visible when all its endpoints were hidden by `x-rbac` access control.
 - 86a3b76a9b9: Fixed an issue where files with identical names but different extensions in the same folder resolved to a single URL, causing pages to be missing from the deployed project.
 - 9ee4d447abf: Fixed banner target priority to ensure that the most specific matching banner is displayed on a page.
-- 92c915d62d7: Added `palette` option to `products` configuration.
 - Updated dependencies [933422fcd9b]
 - Updated dependencies [8710b00b3e1]
 - Updated dependencies [e88064ce2d3]
@@ -146,11 +175,9 @@
 
 - c95cf214aae: Added validation for the `redirects` configuration option to detect dead and circular redirects.
 - 07483ec0596: Added RBAC filtering for Apigee API products in developer onboarding app creation.
-- e756f2aad58: Added a `palette` configuration option that applies one of built-in color palettes to the project.
 
 ### Patch Changes
 
-- e4e8c9f42d4: Updated legacy palette styles.
 - c336f96cb65: Updated `@redocly/openapi-core` to version `2.25.2`.
 - cd3d136f0c2: Fixed an issue where `json-schema` Markdoc tags produced empty output in LLM content by rendering resolved JSON examples as code blocks.
 - d419330f279: Fixed an issue where the build crashed during the search preparation step.

package/dist/cli/build/copy-env-files.js

@@ -1 +1 @@
-import t from"node:path";import{copyFileSync as v,existsSync as s,mkdirSync as u}from"node:fs";import{envConfig as c}from"../../server/config/env-config.js";import{logger as l}from"../../server/tools/notifiers/logger.js";import{sanitizeBranchName as a}from"../../server/utils/envs/sanitize-branch-name.js";const F=n=>{const i=f();s(n.serverOutDir)||u(n.serverOutDir,{recursive:!0});const e=[];for(const o of i){const r=t.join(n.contentDir,o);if(!s(r))continue;const p=t.join(n.serverOutDir,o);v(r,p),e.push(o)}e.length>0&&l.info(`Env files included in bundle: ${e.map(()=>"%rp").join(", ")}`,...e)},f=()=>{const n=c.redoclyEnv,i=c.PUBLIC_REDOCLY_BRANCH_NAME,e=[".env"];switch(i&&e.push(`.env.branch.${a(i)}`),n){case"production":e.push(".env.production");break;case"preview":e.push(".env.preview");break;default:e.push(".env.development");break}return e};export{F as copyEnvFiles};
+import t from"node:path";import{copyFileSync as v,existsSync as s,mkdirSync as u}from"node:fs";import{envConfig as c}from"../../server/config/env-config.js";import{logger as a}from"../../server/tools/notifiers/logger.js";import{sanitizeBranchName as l}from"../../server/utils/envs/sanitize-branch-name.js";const F=n=>{const i=f();s(n.serverOutDir)||u(n.serverOutDir,{recursive:!0});const e=[];for(const o of i){const r=t.join(n.contentDir,o);if(!s(r))continue;const p=t.join(n.serverOutDir,o);v(r,p),e.push(o)}e.length>0&&a.info(`Env files included in bundle: ${e.map(()=>"%rp").join(", ")}`,...e)},f=()=>{const n=c.REDOCLY_ENV,i=c.PUBLIC_REDOCLY_BRANCH_NAME,e=[".env"];switch(i&&e.push(`.env.branch.${l(i)}`),n){case"production":e.push(".env.production");break;case"preview":e.push(".env.preview");break;default:e.push(".env.development");break}return e};export{F as copyEnvFiles};

package/dist/cli/develop.js

@@ -1 +1 @@
-import{logger as t}from"../server/tools/notifiers/logger.js";import{reporter as c}from"../server/tools/notifiers/reporter.js";import{green as v}from"../server/tools/notifiers/helpers/colors.js";import{envConfig as m}from"../server/config/env-config.js";import{resolveCache as w}from"../server/esbuild/plugins/themes-resolver.js";import{getBilledPagesCount as p}from"../server/utils/index.js";import{createClientCompiler as C,createServerCompiler as h}from"../server/esbuild/esbuild.js";import{initPlugins as S,runPlugins as f,writeClientEntries as E}from"../server/plugins/lifecycle.js";import{startDevServer as R}from"../server/web-server/dev-server.js";import{validateAllMarkdowns as b}from"../server/plugins/markdown/compiler.js";import{reportAllErrors as g}from"../server/utils/report-all-errors.js";import{copyMigrationsFolder as y}from"../server/providers/database/copy-migrations.js";import{listenStdin as L}from"./utils/listen-stdin.js";async function J(i,e){t.info("Starting project preview mode."),E(e),t.startTiming("initial-js"),await D(e),t.infoTime("initial-js","JavaScript compiled");const{pluginInstances:a,lifecycleContext:n}=await S({contentDir:e.contentDir,outdir:e.outdir,serverOutDir:void 0,devLogin:i["dev-login"]!==!1,setGlobalConfig:e.setGlobalConfig});e.lifecycleContext=n,y(e),await f(a,e,n,{failFast:!0});const d=async()=>{const r=performance.now();c.clearErrors(),await f(a,e,n),m.REDOCLY_EXP_DISABLE_MD_VALIDATION!=="true"?await b(e,n):t.info("Skipping markdown validation step"),P().then(async()=>{await g(n);const l=p(e.getAllRoutes()),o=c.summary(`  \u{1F440} Last change processed in ${v(Math.round(performance.now()-r)+"ms")}`,l);e.runListeners("errors-updated",void 0,o),e.runListeners("pages-updated",void 0,l),e.runListeners("routes-updated")})};m.REDOCLY_EXP_DISABLE_MD_VALIDATION!=="true"?await b(e,n):t.info("Skipping markdown validation step"),await g(n);const s=p(e.getAllRoutes());c.summary("  \u{1F440} Watching for changes...",s),e.runListeners("pages-updated",void 0,s),n.fs.watch(async()=>{w.clear(),await d()}),t.verbose("Starting development server."),await R(e,n,{port:Number(i.port||4e3)}),L()}async function D(i){let e=!0,a=!0;const n=r=>{r==="client"?e=!0:a=!0,i.runListeners("build-started"),e!=a&&(i.startEsbuildRun(),t.startTiming("rebuild"))},d=async r=>{r==="client"?e=!1:a=!1,!(e||a)&&(i.finishEsbuildRun(),i.buildRevision++,t.infoTime("rebuild","JavaScript re-compiled"),await i.reloadMarkdocOptions(),i.markUserCodeReady(),i.runListeners("build-updated"),i.lifecycleContext&&i.buildRevision>1&&i.lifecycleContext.fs.emitCodeUpdated())},s=[new Promise((r,l)=>{const o={label:"client",buildStart(){t.verbose("Start compiling client code."),t.startTiming(this.label)},buildEnd(){t.verboseTime(this.label,"Client compiled"),r(!0)},rebuildStart:()=>n("client"),rebuildEnd:()=>d("client")};C(i,i.outdir,"development",o).then(u=>u.watch()).catch(l)}),new Promise((r,l)=>{const o={label:"server",buildStart(){t.verbose("Start compiling server code."),t.startTiming(this.label)},buildEnd(){t.verboseTime(this.label,"Server compiled"),r(!0)},rebuildStart:()=>n("server"),rebuildEnd:()=>d("server")};h(i,i.serverOutDir,"development",o).then(u=>u.watch()).catch(l)})];await Promise.all(s),await i.reloadMarkdocOptions()}function P(){return new Promise(i=>{setTimeout(i,0)})}export{J as develop};
+import{logger as t}from"../server/tools/notifiers/logger.js";import{reporter as c}from"../server/tools/notifiers/reporter.js";import{green as v}from"../server/tools/notifiers/helpers/colors.js";import{envConfig as m}from"../server/config/env-config.js";import{resolveCache as w}from"../server/esbuild/plugins/themes-resolver.js";import{getBilledPagesCount as p}from"../server/utils/index.js";import{createClientCompiler as C,createServerCompiler as h}from"../server/esbuild/esbuild.js";import{initPlugins as S,runPlugins as f,writeClientEntries as E}from"../server/plugins/lifecycle.js";import{startDevServer as R}from"../server/web-server/dev-server.js";import{validateAllMarkdowns as b}from"../server/plugins/markdown/compiler.js";import{reportAllErrors as g}from"../server/utils/report-all-errors.js";import{copyMigrationsFolder as y}from"../server/providers/database/copy-migrations.js";import{listenStdin as L}from"./utils/listen-stdin.js";async function J(i,e){t.info("Starting project preview mode."),E(e),t.startTiming("initial-js"),await D(e),t.infoTime("initial-js","JavaScript compiled");const{pluginInstances:a,lifecycleContext:n}=await S({contentDir:e.contentDir,outdir:e.outdir,serverOutDir:void 0,devLogin:i["dev-login"]!==!1,setGlobalConfig:e.setGlobalConfig});e.lifecycleContext=n,y(e),await f(a,e,n,{failFast:!0});const d=async()=>{const r=performance.now();c.clearErrors(),await f(a,e,n),m.REDOCLY_EXP_DISABLE_MD_VALIDATION?t.info("Skipping markdown validation step"):await b(e,n),P().then(async()=>{await g(n);const l=p(e.getAllRoutes()),o=c.summary(`  \u{1F440} Last change processed in ${v(Math.round(performance.now()-r)+"ms")}`,l);e.runListeners("errors-updated",void 0,o),e.runListeners("pages-updated",void 0,l),e.runListeners("routes-updated")})};m.REDOCLY_EXP_DISABLE_MD_VALIDATION?t.info("Skipping markdown validation step"):await b(e,n),await g(n);const s=p(e.getAllRoutes());c.summary("  \u{1F440} Watching for changes...",s),e.runListeners("pages-updated",void 0,s),n.fs.watch(async()=>{w.clear(),await d()}),t.verbose("Starting development server."),await R(e,n,{port:Number(i.port||4e3)}),L()}async function D(i){let e=!0,a=!0;const n=r=>{r==="client"?e=!0:a=!0,i.runListeners("build-started"),e!=a&&(i.startEsbuildRun(),t.startTiming("rebuild"))},d=async r=>{r==="client"?e=!1:a=!1,!(e||a)&&(i.finishEsbuildRun(),i.buildRevision++,t.infoTime("rebuild","JavaScript re-compiled"),await i.reloadMarkdocOptions(),i.markUserCodeReady(),i.runListeners("build-updated"),i.lifecycleContext&&i.buildRevision>1&&i.lifecycleContext.fs.emitCodeUpdated())},s=[new Promise((r,l)=>{const o={label:"client",buildStart(){t.verbose("Start compiling client code."),t.startTiming(this.label)},buildEnd(){t.verboseTime(this.label,"Client compiled"),r(!0)},rebuildStart:()=>n("client"),rebuildEnd:()=>d("client")};C(i,i.outdir,"development",o).then(u=>u.watch()).catch(l)}),new Promise((r,l)=>{const o={label:"server",buildStart(){t.verbose("Start compiling server code."),t.startTiming(this.label)},buildEnd(){t.verboseTime(this.label,"Server compiled"),r(!0)},rebuildStart:()=>n("server"),rebuildEnd:()=>d("server")};h(i,i.serverOutDir,"development",o).then(u=>u.watch()).catch(l)})];await Promise.all(s),await i.reloadMarkdocOptions()}function P(){return new Promise(i=>{setTimeout(i,0)})}export{J as develop};

package/dist/cli/telemetry/index.js

@@ -1 +1 @@
-import{AsyncApiRealmCLI as c}from"@redocly/realm-asyncapi-sdk";import{ulid as l}from"ulid";import{TELEMETRY_ENABLED as i}from"../../server/constants/common.js";import{shutdowner as s}from"../../server/tools/shutdowner.js";import{envConfig as r}from"../../server/config/env-config.js";import{PACKAGE_NAME as n}from"../../config/product-gates.js";class d extends c.Telemetry{#e=new Map;constructor(){super(),this.updateCloudEventData(()=>({organizationId:r.ORGANIZATION_ID||"",organizationSlug:r.ORGANIZATION_SLUG||"",projectId:r.PROJECT_ID||"",projectSlug:r.PROJECT_SLUG||"",origin:"realmCli",actor:{id:`ann_${l()}`,object:"user",uri:""},source:"cli",env:r.redoclyEnv}))}initialize(e,t,o){const a=t!==void 0?!(t&&i):!i;this.init({otel:{serviceName:"realm-cli",serviceVersion:`${n}@${e}`,collectorTraceUrl:r.OTEL_TRACES_URL||"https://otel.cloud.redocly.com/v1/traces",isProd:r.isProductionEnv,version:"1.0",tracerName:"cli-telemetry"},disabled:a,verbose:o}),s.registerShutdownCallback(this.#r.bind(this))}addTraceStepCallbacks(e,{error:t,end:o}){this.#e.set(e,{error:t,end:o})}removeTraceStepCallbacks(e){this.#e.delete(e)}async#r(e){for(const[,{error:t,end:o}]of this.#e)e&&t(e),o();this.#e.clear(),await this.forceFlush(),await this.shutdown()}}const m=new d,A=m.tracer;export{m as telemetry,A as telemetryTracer};
+import{AsyncApiRealmCLI as c}from"@redocly/realm-asyncapi-sdk";import{ulid as l}from"ulid";import{TELEMETRY_ENABLED as i}from"../../server/constants/common.js";import{shutdowner as s}from"../../server/tools/shutdowner.js";import{envConfig as r}from"../../server/config/env-config.js";import{PACKAGE_NAME as n}from"../../config/product-gates.js";class d extends c.Telemetry{#e=new Map;constructor(){super(),this.updateCloudEventData(()=>({organizationId:r.ORGANIZATION_ID||"",organizationSlug:r.ORGANIZATION_SLUG||"",projectId:r.PROJECT_ID||"",projectSlug:r.PROJECT_SLUG||"",origin:"realmCli",actor:{id:`ann_${l()}`,object:"user",uri:""},source:"cli",env:r.REDOCLY_ENV}))}initialize(e,t,o){const a=t!==void 0?!(t&&i):!i;this.init({otel:{serviceName:"realm-cli",serviceVersion:`${n}@${e}`,collectorTraceUrl:r.OTEL_TRACES_URL||"https://otel.cloud.redocly.com/v1/traces",isProd:r.isProductionEnv,version:"1.0",tracerName:"cli-telemetry"},disabled:a,verbose:o}),s.registerShutdownCallback(this.#r.bind(this))}addTraceStepCallbacks(e,{error:t,end:o}){this.#e.set(e,{error:t,end:o})}removeTraceStepCallbacks(e){this.#e.delete(e)}async#r(e){for(const[,{error:t,end:o}]of this.#e)e&&t(e),o();this.#e.clear(),await this.forceFlush(),await this.shutdown()}}const m=new d,A=m.tracer;export{m as telemetry,A as telemetryTracer};

package/dist/client/app/hooks/catalog/useFetchCatalogEntityRevisions.js

@@ -1 +1 @@
-import{useQuery as s}from"@tanstack/react-query";import{useMemo as c}from"react";import{withPathPrefix as f}from"@redocly/theme/core/utils";function p({entityKey:o,version:t}){const r=s({queryFn:async()=>{const n=new URLSearchParams;t&&n.append("version",t);const e=new URL(f(`/bff/catalog-revisions/${o}`),window.location.origin);e.search=n.toString();const a=await fetch(e.toString());if(!a.ok)throw new Error(`Failed to fetch catalog entity revisions from ${e.pathname}`);return a.json()},queryKey:["bff/catalog-revisions",{entityKey:o,version:t}],refetchOnMount:!0}),i=c(()=>r.data?.items??[],[r.data?.items]);return{query:r,items:i}}export{p as useFetchCatalogEntityRevisions};
+import{useQuery as a}from"@tanstack/react-query";import{useMemo as c}from"react";import{withPathPrefix as u}from"@redocly/theme/core/utils";function f(t){return t.length>=2&&t.startsWith('"')&&t.endsWith('"')?t:`"${t}"`}function l({entityKey:t,version:e}){const r=a({queryFn:async()=>{const o=new URLSearchParams;o.append("filter",`catalogEntityKey:${f(t)}`),e&&o.append("version",e);const n=new URL(u("/bff/catalog-revisions"),window.location.origin);n.search=o.toString();const i=await fetch(n.toString());if(!i.ok)throw new Error(`Failed to fetch catalog entity revisions from ${n.pathname}`);return i.json()},queryKey:["bff/catalog-revisions",{entityKey:t,version:e}],refetchOnMount:!0}),s=c(()=>r.data?.items??[],[r.data?.items]);return{query:r,items:s}}export{l as useFetchCatalogEntityRevisions};

package/dist/constants/common.d.ts

@@ -72,7 +72,7 @@ export declare const ServerRoutes: {
     readonly CATALOG_ENTITIES_RELATIONS: "/catalog-entities-relations/:entityRelationId?";
     readonly BFF_CATALOG_ENTITIES: "/bff/catalog-entities/:entityKey?";
     readonly BFF_CATALOG_RELATED_ENTITIES: "/bff/catalog-related-entities/:entityKey";
-    readonly BFF_CATALOG_REVISIONS: "/bff/catalog-revisions/:entityKey";
+    readonly BFF_CATALOG_REVISIONS: "/bff/catalog-revisions";
     readonly MCP_OAUTH_AUTHORIZATION_SERVER: "/.well-known/oauth-authorization-server";
     readonly MCP_OAUTH_PROTECTED_RESOURCE: "/.well-known/oauth-protected-resource";
     readonly MCP_DYNAMIC_CLIENT_REGISTRATION: "/_mcp/register";
@@ -133,6 +133,7 @@ export declare const FEATURE: {
     readonly ssoDirect: "ssoDirect";
     readonly codeWalkthrough: "codeWalkthrough";
     readonly aiSearchLimit: "aiSearchLimit";
+    readonly kvStorageLimit: "kvStorageLimit";
     readonly mcp: "mcp";
     readonly banner: "banner";
 };

package/dist/constants/common.js

@@ -1 +1 @@
-const E="openapi_docs",n="asyncapi_docs",A="graphql_docs",T="/_spec-gql",O="markdoc",p="tags",i="*",L={"*":"read"},C=["openid","email"],R=1440*60,I="anonymous",l="authenticated",S="**",d="Reunite",N="translations.yaml",u="redocly.yaml",P="@redocly/theme",D="@theme",h="/app-data.json",x="/eject-component";var e;(function(t){t.BUILD="build",t.DEVELOP="develop",t.PREPARE="prepare"})(e||(e={}));var a;(function(t){t.RATING="rating",t.SENTIMENT="sentiment",t.COMMENT="comment",t.MOOD="mood",t.PROBLEM="problem",t.SCALE="scale"})(a||(a={}));const o="entityKey",_="entityId",c="entityRelationId",g={CORS_PROXY:"/_api/cors",INFO:"/_info",EJECT_COMPONENT:"/eject-component/:componentName",SHARED_PAGE_DATA:"/page-data/shared/*",PAGE_DATA:"/page-data/*",APP_DATA:"/app-data.json",AUTHORIZATION:"/authorize",OIDC_CALLBACK:"/_auth/oidc",SAML_CALLBACK:"/_auth/saml2",REDOCLY_CALLBACK:"/_auth/redocly",REPLAY_OAUTH2_CALLBACK:"/_auth/replay-oauth2",REDOCLY_LOGIN_CALLBACK:"/_auth/redocly/redocly-login",REDOCLY_TOKEN_LOGIN:"/_auth/redocly-token-login",SEARCH:"/_search",SEARCH_FACETS:"/_search-facets",SEMANTIC_SEARCH:"/_semantic-search",LOGOUT:"/logout",POST_LOGOUT:"/post-logout",LOGIN:"/login",IDP_LOGIN:"/_auth/idp-login",INVITE:"/invite/:code",RESOLVE_ROUTE_BY_PATH:"/resolve-route-by-path",RESOLVE_ROUTES_BY_PATHS:"/resolve-routes-by-paths",RESOLVE_ROUTE_BY_SLUG:"/resolve-route-by-slug",GET_ROUTES_BY_LINE:"/get-routes-by-line",FEEDBACK:"/feedback",TELEMETRY:"/_events",OTEL_TRACES:"/_otel/v1/traces",HEALTH:"/_health",ASK_AI:"/_ask-ai",CATALOG_ENTITIES:`/catalog-entities/:${_}?`,CATALOG_ENTITIES_RELATIONS:`/catalog-entities-relations/:${c}?`,BFF_CATALOG_ENTITIES:`/bff/catalog-entities/:${o}?`,BFF_CATALOG_RELATED_ENTITIES:`/bff/catalog-related-entities/:${o}`,BFF_CATALOG_REVISIONS:`/bff/catalog-revisions/:${o}`,MCP_OAUTH_AUTHORIZATION_SERVER:"/.well-known/oauth-authorization-server",MCP_OAUTH_PROTECTED_RESOURCE:"/.well-known/oauth-protected-resource",MCP_DYNAMIC_CLIENT_REGISTRATION:"/_mcp/register",MCP_AUTHORIZATION:"/_mcp/oauth2/auth",MCP_TOKEN_PORTAL:"/_mcp/oauth2/token-portal",MCP_CALLBACK:"/_mcp/oauth/callback",SCORECARDS:"/scorecards"};var r;(function(t){t.AI_SEARCH="aiSearch"})(r||(r={}));const U="/login",m="/invite",M={AUTH0_PASS:"/auth/auth0-pass"},b={NotExist:"ENOENT"},G="default_locale",H="sidebar-",F="PUBLIC_",y="branch.",v=["BROKEN_LINK","MARKDOC","RESOLVE"],B=["logo","navbar","products","footer","sidebar","scripts","links","feedback","search","aiAssistant","colorMode","palette","navigation","codeSnippet","markdown","openapi","graphql","analytics","userMenu","versionPicker","breadcrumbs","catalog","entitiesCatalog","scorecard","scorecards","scorecardClassic","mcp","banner"],s="redocly_category",k="redocly_product",f="redocly_version",K="redocly_teams",Y=s,V={asyncapi:"asyncapi",apiFunctions:"apiFunctions",reactPages:"reactPages",catalog:"catalog",catalogClassic:"catalogClassic",lint:"lint",scorecard:"scorecard",scorecards:"scorecards",l10n:"l10n",openapi:"openapi",graphql:"graphql",markdown:"markdown",devOnboarding:"devOnboarding",seo:"seo",redirects:"redirects",customPlugins:"customPlugins",themeEjecting:"themeEjecting",products:"products",breadcrumbs:"breadcrumbs",mockServer:"mockServer",sso:"sso",rbac:"rbac",analytics:"analytics",removeAttribution:"removeAttribution",advancedSearch:"advancedSearch",soap:"soap",ssoDirect:"ssoDirect",codeWalkthrough:"codeWalkthrough",aiSearchLimit:"aiSearchLimit",mcp:"mcp",banner:"banner"};export{n as ASYNC_API_DOCS_TEMPLATE_ID,y as BRANCH_ENV_PREFIX,_ as CATALOG_ENTITY_ID,o as CATALOG_ENTITY_KEY,c as CATALOG_ENTITY_RELATION_ID,u as CONFIG_FILE_NAME,O as CUSTOM_MARKDOC_OPTIONS_PATH,p as CUSTOM_MARKDOC_TAGS_PATH,I as DEFAULT_ANONYMOUS_VISITOR_TEAM,l as DEFAULT_AUTHENTICATED_TEAM,R as DEFAULT_COOKIE_EXPIRATION,G as DEFAULT_LOCALE_PLACEHOLDER,S as DEFAULT_RBAC_SCOPE,d as DEFAULT_SSO_IDP_TITLE,P as DEFAULT_THEME_NAME,U as DEV_LOGIN_SLUG,x as EJECT_COMPONENT_URL,M as ExternalRoutes,V as FEATURE,a as FEEDBACK_TYPES,b as FsErrors,h as GLOBAL_DATA_URL,T as GRAPHQL_SPEC_SLUG,A as GRAPHQL_TEMPLATE_ID,m as INVITE_SLUG,v as MARKDOC_ERROR_TYPES,E as OPENAPI_DOCS_TEMPLATE_ID,F as PUBLIC_ENV_PREFIX,L as PUBLIC_RBAC_SCOPE_ITEM,i as RBAC_ALL_OTHER_TEAMS,C as REQUIRED_OIDC_SCOPES,r as RbacFeatures,s as SEARCH_CATEGORY_FIELD,Y as SEARCH_GROUP_FACET_FIELD,k as SEARCH_PRODUCT_FIELD,K as SEARCH_RBAC_FIELD,f as SEARCH_VERSION_FIELD,H as SIDEBAR_PREFIX,g as ServerRoutes,N as TRANSLATIONS_FILE_NAME,B as UI_ACCESSIBLE_CONFIG_PROPS,D as USER_THEME_ALIAS,e as cliCommandNames};
+const E="openapi_docs",n="asyncapi_docs",A="graphql_docs",T="/_spec-gql",i="markdoc",O="tags",p="*",L={"*":"read"},C=["openid","email"],R=1440*60,I="anonymous",l="authenticated",S="**",d="Reunite",N="translations.yaml",u="redocly.yaml",P="@redocly/theme",D="@theme",h="/app-data.json",g="/eject-component";var o;(function(t){t.BUILD="build",t.DEVELOP="develop",t.PREPARE="prepare"})(o||(o={}));var e;(function(t){t.RATING="rating",t.SENTIMENT="sentiment",t.COMMENT="comment",t.MOOD="mood",t.PROBLEM="problem",t.SCALE="scale"})(e||(e={}));const a="entityKey",_="entityId",c="entityRelationId",x={CORS_PROXY:"/_api/cors",INFO:"/_info",EJECT_COMPONENT:"/eject-component/:componentName",SHARED_PAGE_DATA:"/page-data/shared/*",PAGE_DATA:"/page-data/*",APP_DATA:"/app-data.json",AUTHORIZATION:"/authorize",OIDC_CALLBACK:"/_auth/oidc",SAML_CALLBACK:"/_auth/saml2",REDOCLY_CALLBACK:"/_auth/redocly",REPLAY_OAUTH2_CALLBACK:"/_auth/replay-oauth2",REDOCLY_LOGIN_CALLBACK:"/_auth/redocly/redocly-login",REDOCLY_TOKEN_LOGIN:"/_auth/redocly-token-login",SEARCH:"/_search",SEARCH_FACETS:"/_search-facets",SEMANTIC_SEARCH:"/_semantic-search",LOGOUT:"/logout",POST_LOGOUT:"/post-logout",LOGIN:"/login",IDP_LOGIN:"/_auth/idp-login",INVITE:"/invite/:code",RESOLVE_ROUTE_BY_PATH:"/resolve-route-by-path",RESOLVE_ROUTES_BY_PATHS:"/resolve-routes-by-paths",RESOLVE_ROUTE_BY_SLUG:"/resolve-route-by-slug",GET_ROUTES_BY_LINE:"/get-routes-by-line",FEEDBACK:"/feedback",TELEMETRY:"/_events",OTEL_TRACES:"/_otel/v1/traces",HEALTH:"/_health",ASK_AI:"/_ask-ai",CATALOG_ENTITIES:`/catalog-entities/:${_}?`,CATALOG_ENTITIES_RELATIONS:`/catalog-entities-relations/:${c}?`,BFF_CATALOG_ENTITIES:`/bff/catalog-entities/:${a}?`,BFF_CATALOG_RELATED_ENTITIES:`/bff/catalog-related-entities/:${a}`,BFF_CATALOG_REVISIONS:"/bff/catalog-revisions",MCP_OAUTH_AUTHORIZATION_SERVER:"/.well-known/oauth-authorization-server",MCP_OAUTH_PROTECTED_RESOURCE:"/.well-known/oauth-protected-resource",MCP_DYNAMIC_CLIENT_REGISTRATION:"/_mcp/register",MCP_AUTHORIZATION:"/_mcp/oauth2/auth",MCP_TOKEN_PORTAL:"/_mcp/oauth2/token-portal",MCP_CALLBACK:"/_mcp/oauth/callback",SCORECARDS:"/scorecards"};var r;(function(t){t.AI_SEARCH="aiSearch"})(r||(r={}));const m="/login",U="/invite",M={AUTH0_PASS:"/auth/auth0-pass"},b={NotExist:"ENOENT"},G="default_locale",H="sidebar-",F="PUBLIC_",y="branch.",v=["BROKEN_LINK","MARKDOC","RESOLVE"],B=["logo","navbar","products","footer","sidebar","scripts","links","feedback","search","aiAssistant","colorMode","palette","navigation","codeSnippet","markdown","openapi","graphql","analytics","userMenu","versionPicker","breadcrumbs","catalog","entitiesCatalog","scorecard","scorecards","scorecardClassic","mcp","banner"],s="redocly_category",k="redocly_product",f="redocly_version",K="redocly_teams",Y=s,V={asyncapi:"asyncapi",apiFunctions:"apiFunctions",reactPages:"reactPages",catalog:"catalog",catalogClassic:"catalogClassic",lint:"lint",scorecard:"scorecard",scorecards:"scorecards",l10n:"l10n",openapi:"openapi",graphql:"graphql",markdown:"markdown",devOnboarding:"devOnboarding",seo:"seo",redirects:"redirects",customPlugins:"customPlugins",themeEjecting:"themeEjecting",products:"products",breadcrumbs:"breadcrumbs",mockServer:"mockServer",sso:"sso",rbac:"rbac",analytics:"analytics",removeAttribution:"removeAttribution",advancedSearch:"advancedSearch",soap:"soap",ssoDirect:"ssoDirect",codeWalkthrough:"codeWalkthrough",aiSearchLimit:"aiSearchLimit",kvStorageLimit:"kvStorageLimit",mcp:"mcp",banner:"banner"};export{n as ASYNC_API_DOCS_TEMPLATE_ID,y as BRANCH_ENV_PREFIX,_ as CATALOG_ENTITY_ID,a as CATALOG_ENTITY_KEY,c as CATALOG_ENTITY_RELATION_ID,u as CONFIG_FILE_NAME,i as CUSTOM_MARKDOC_OPTIONS_PATH,O as CUSTOM_MARKDOC_TAGS_PATH,I as DEFAULT_ANONYMOUS_VISITOR_TEAM,l as DEFAULT_AUTHENTICATED_TEAM,R as DEFAULT_COOKIE_EXPIRATION,G as DEFAULT_LOCALE_PLACEHOLDER,S as DEFAULT_RBAC_SCOPE,d as DEFAULT_SSO_IDP_TITLE,P as DEFAULT_THEME_NAME,m as DEV_LOGIN_SLUG,g as EJECT_COMPONENT_URL,M as ExternalRoutes,V as FEATURE,e as FEEDBACK_TYPES,b as FsErrors,h as GLOBAL_DATA_URL,T as GRAPHQL_SPEC_SLUG,A as GRAPHQL_TEMPLATE_ID,U as INVITE_SLUG,v as MARKDOC_ERROR_TYPES,E as OPENAPI_DOCS_TEMPLATE_ID,F as PUBLIC_ENV_PREFIX,L as PUBLIC_RBAC_SCOPE_ITEM,p as RBAC_ALL_OTHER_TEAMS,C as REQUIRED_OIDC_SCOPES,r as RbacFeatures,s as SEARCH_CATEGORY_FIELD,Y as SEARCH_GROUP_FACET_FIELD,k as SEARCH_PRODUCT_FIELD,K as SEARCH_RBAC_FIELD,f as SEARCH_VERSION_FIELD,H as SIDEBAR_PREFIX,x as ServerRoutes,N as TRANSLATIONS_FILE_NAME,B as UI_ACCESSIBLE_CONFIG_PROPS,D as USER_THEME_ALIAS,o as cliCommandNames};

package/dist/server/config/env-config.d.ts

@@ -1,18 +1,167 @@
 import type { EnvConfig } from './env-schema.js';
 export type { EnvConfig };
-export type RedoclyEnv = 'production' | 'preview' | 'development';
-export type RedoclyExecutionMode = 'build' | 'develop' | 'runtime';
-export type EnvConfigDerived = {
-    redoclyEnv: RedoclyEnv;
-    executionMode: RedoclyExecutionMode;
+declare function loadEnvConfig(): {
     isProductionEnv: boolean;
     isPreviewEnv: boolean;
     isReunite: boolean;
     isBuildMode: boolean;
     isDevelopMode: boolean;
     isRuntimeMode: boolean;
-    logFormat: string | undefined;
+    REDOCLY_EXECUTION_MODE: "build" | "develop" | "runtime";
+    REDOCLY_ENV: "development" | "production" | "preview";
+    SEARCH_DEV_DEBUG: boolean;
+    NODE_ENV?: "development" | "production" | undefined;
+    REDOCLY_INTERNAL_DEV?: boolean | undefined;
+    CI?: boolean | undefined;
+    PORT?: number | undefined;
+    REDOCLY_LOG_FORMAT?: string | undefined;
+    REDOCLY_LOG_LEVEL?: string | undefined;
+    TERM?: string | undefined;
+    INSPECT_MODE?: string | undefined;
+    REDOCLY_PREFIX_PATHS?: string | undefined;
+    REDOCLY_CONTENT_DIR?: string | undefined;
+    REDOCLY_PORTAL_VERSION?: string | undefined;
+    REDOCLY_TELEMETRY?: string | undefined;
+    REDOCLY_TELEMETRY_ENDPOINT?: string | undefined;
+    TELEMETRY_DEV_DEBUG?: boolean | undefined;
+    WEB_SERVER_IDLE_TIMEOUT?: string | undefined;
+    REDOCLY_PROBLEMS_OUTPUT_FILE?: string | undefined;
+    REDOCLY_METADATA_OUTPUT_FOLDER?: string | undefined;
+    ORGANIZATION_ID?: string | undefined;
+    ORGANIZATION_SLUG?: string | undefined;
+    ORG_SLUG?: string | undefined;
+    PROJECT_ID?: string | undefined;
+    PROJECT_SLUG?: string | undefined;
+    PROJECT_URL?: string | undefined;
+    PROJECT_BUILD_ID?: string | undefined;
+    PUBLIC_REDOCLY_BRANCH_NAME?: string | undefined;
+    JWT_SECRET_KEY?: string | undefined;
+    AUTH_URL?: string | undefined;
+    BH_API_URL?: string | undefined;
+    ENTITLEMENTS_JWKS_CDN_URL?: string | undefined;
+    OAUTH_CLIENT_ID?: string | undefined;
+    OAUTH_CLIENT_SECRET?: string | undefined;
+    OIDC_CLIENT_ID?: string | undefined;
+    OIDC_CLIENT_SECRET?: string | undefined;
+    OIDC_ISSUER_URL?: string | undefined;
+    LOCALHOST_LOGIN?: boolean | undefined;
+    REDOCLY_OAUTH_USE_INTROSPECT?: string | undefined;
+    REDOCLY_ENFORCE_LOGIN?: boolean | undefined;
+    REDOCLY_ENFORCE_RESIDENCY?: string | undefined;
+    REDOCLY_SSR_RENDER_MODE?: "main" | "worker" | undefined;
+    REDOCLY_SSR_WORKERS_MIN?: number | undefined;
+    REDOCLY_SSR_WORKERS_MAX?: number | undefined;
+    NEW_CATALOG_ENABLED?: boolean | undefined;
+    NEW_SCORECARDS_ENABLED?: boolean | undefined;
+    ENABLE_COMMENTS?: string | undefined;
+    REDOCLY_EXP_DISABLE_MD_VALIDATION?: boolean | undefined;
+    ENABLE_SOURCE_MAPS?: boolean | undefined;
+    PLAN_GATES?: string | undefined;
+    SEARCH_DEV_REINIT?: string | undefined;
+    TYPESENSE_API_URL?: string | undefined;
+    TYPESENSE_API_KEY?: string | undefined;
+    MAIN_API_URL?: string | undefined;
+    SERVER_EDITOR_APP_URL?: string | undefined;
+    REDOCLY_PUBLIC_URL?: string | undefined;
+    REDOCLY_DIAGRAM_MICROSERVICE_URL?: string | undefined;
+    REDOCLY_CORS_ORIGINS?: string | undefined;
+    SQLD_REMOTE_DATABASE_URL?: string | undefined;
+    SQLD_REMOTE_DATABASE_AUTH_TOKEN?: string | undefined;
+    FORCE_CATALOG_CACHE_REVALIDATE?: boolean | undefined;
+    SCORECARDS_POLLING_INTERVAL_MS?: string | undefined;
+    OTEL_TRACES_URL?: string | undefined;
+    REQUEST_ID?: string | undefined;
+    SITE_URL?: string | undefined;
 };
-export type EnvConfigWithDerived = EnvConfig & EnvConfigDerived;
-export declare const envConfig: EnvConfigWithDerived;
+export type EnvConfigWithDerived = ReturnType<typeof loadEnvConfig> & {
+    [K: string]: never;
+};
+export declare const envConfig: {
+    isProductionEnv: boolean;
+    isPreviewEnv: boolean;
+    isReunite: boolean;
+    isBuildMode: boolean;
+    isDevelopMode: boolean;
+    isRuntimeMode: boolean;
+    REDOCLY_EXECUTION_MODE: "build" | "develop" | "runtime";
+    REDOCLY_ENV: "development" | "production" | "preview";
+    SEARCH_DEV_DEBUG: boolean;
+    NODE_ENV?: "development" | "production" | undefined;
+    REDOCLY_INTERNAL_DEV?: boolean | undefined;
+    CI?: boolean | undefined;
+    PORT?: number | undefined;
+    REDOCLY_LOG_FORMAT?: string | undefined;
+    REDOCLY_LOG_LEVEL?: string | undefined;
+    TERM?: string | undefined;
+    INSPECT_MODE?: string | undefined;
+    REDOCLY_PREFIX_PATHS?: string | undefined;
+    REDOCLY_CONTENT_DIR?: string | undefined;
+    REDOCLY_PORTAL_VERSION?: string | undefined;
+    REDOCLY_TELEMETRY?: string | undefined;
+    REDOCLY_TELEMETRY_ENDPOINT?: string | undefined;
+    TELEMETRY_DEV_DEBUG?: boolean | undefined;
+    WEB_SERVER_IDLE_TIMEOUT?: string | undefined;
+    REDOCLY_PROBLEMS_OUTPUT_FILE?: string | undefined;
+    REDOCLY_METADATA_OUTPUT_FOLDER?: string | undefined;
+    ORGANIZATION_ID?: string | undefined;
+    ORGANIZATION_SLUG?: string | undefined;
+    ORG_SLUG?: string | undefined;
+    PROJECT_ID?: string | undefined;
+    PROJECT_SLUG?: string | undefined;
+    PROJECT_URL?: string | undefined;
+    PROJECT_BUILD_ID?: string | undefined;
+    PUBLIC_REDOCLY_BRANCH_NAME?: string | undefined;
+    JWT_SECRET_KEY?: string | undefined;
+    AUTH_URL?: string | undefined;
+    BH_API_URL?: string | undefined;
+    ENTITLEMENTS_JWKS_CDN_URL?: string | undefined;
+    OAUTH_CLIENT_ID?: string | undefined;
+    OAUTH_CLIENT_SECRET?: string | undefined;
+    OIDC_CLIENT_ID?: string | undefined;
+    OIDC_CLIENT_SECRET?: string | undefined;
+    OIDC_ISSUER_URL?: string | undefined;
+    LOCALHOST_LOGIN?: boolean | undefined;
+    REDOCLY_OAUTH_USE_INTROSPECT?: string | undefined;
+    REDOCLY_ENFORCE_LOGIN?: boolean | undefined;
+    REDOCLY_ENFORCE_RESIDENCY?: string | undefined;
+    REDOCLY_SSR_RENDER_MODE?: "main" | "worker" | undefined;
+    REDOCLY_SSR_WORKERS_MIN?: number | undefined;
+    REDOCLY_SSR_WORKERS_MAX?: number | undefined;
+    NEW_CATALOG_ENABLED?: boolean | undefined;
+    NEW_SCORECARDS_ENABLED?: boolean | undefined;
+    ENABLE_COMMENTS?: string | undefined;
+    REDOCLY_EXP_DISABLE_MD_VALIDATION?: boolean | undefined;
+    ENABLE_SOURCE_MAPS?: boolean | undefined;
+    PLAN_GATES?: string | undefined;
+    SEARCH_DEV_REINIT?: string | undefined;
+    TYPESENSE_API_URL?: string | undefined;
+    TYPESENSE_API_KEY?: string | undefined;
+    MAIN_API_URL?: string | undefined;
+    SERVER_EDITOR_APP_URL?: string | undefined;
+    REDOCLY_PUBLIC_URL?: string | undefined;
+    REDOCLY_DIAGRAM_MICROSERVICE_URL?: string | undefined;
+    REDOCLY_CORS_ORIGINS?: string | undefined;
+    SQLD_REMOTE_DATABASE_URL?: string | undefined;
+    SQLD_REMOTE_DATABASE_AUTH_TOKEN?: string | undefined;
+    FORCE_CATALOG_CACHE_REVALIDATE?: boolean | undefined;
+    SCORECARDS_POLLING_INTERVAL_MS?: string | undefined;
+    OTEL_TRACES_URL?: string | undefined;
+    REQUEST_ID?: string | undefined;
+    SITE_URL?: string | undefined;
+};
+/**
+ * Re-parses environment variables from `process.env` into {@link envConfig}.
+ * Call after loading `.env` files (e.g. from dotenv) or mutating `process.env` so reads stay in sync.
+ * Replaces the object contents entirely (no merging with stale keys).
+ */
+export declare function reloadEnvConfig(): void;
+/**
+ * Sets one or more environment variables on `process.env` and reloads {@link envConfig}.
+ *
+ * @example
+ * setEnv('MY_VAR', 'value');
+ * setEnv({ MY_VAR: 'value', OTHER_VAR: 'other' });
+ */
+export declare function setEnv(key: string, value: string | undefined): void;
+export declare function setEnv(entries: Record<string, string | undefined>): void;
 //# sourceMappingURL=env-config.d.ts.map

package/dist/server/config/env-config.js

@@ -1 +1 @@
-import{readEnvVariable as c}from"../utils/envs/read-env-variable.js";import{envSchema as s}from"./env-schema.js";function t(){const n=Object.fromEntries(Object.keys(process.env).map(e=>[e,c(e)]));return n.REDOCLY_PORTAL_VERSION=process.env.REDOCLY_PORTAL_VERSION,s.parse(n)}function o(){return t().REDOCLY_ENV??"development"}function i(){const n=process.env.REDOCLY_EXECUTION_MODE;return n==="build"||n==="develop"||n==="runtime"?n:"develop"}function v(){const e=t().REDOCLY_INTERNAL_DEV;return e==="true"||e==="1"}function d(){return t().REDOCLY_LOG_FORMAT}function a(n){switch(n){case"logFormat":return d();case"redoclyEnv":return o();case"executionMode":return i();case"isProductionEnv":return o()==="production";case"isPreviewEnv":return o()==="preview";case"isReunite":{const e=o(),r=v(),u=t().REDOCLY_ORG_ID;return e==="production"||e==="preview"||e==="development"&&!r&&!!u}case"isBuildMode":return i()==="build";case"isDevelopMode":return i()==="develop";case"isRuntimeMode":return i()==="runtime";default:return n}}const E=new Set(["logFormat","redoclyEnv","executionMode","isProductionEnv","isPreviewEnv","isReunite","isBuildMode","isDevelopMode","isRuntimeMode"]),R=Object.freeze(new Proxy({},{get(n,e){if(typeof e!="string")return;const r=e;return E.has(r)?a(r):t()[e]}}));export{R as envConfig};
+import{readEnvVariable as i}from"../utils/envs/read-env-variable.js";import{envSchema as r}from"./env-schema.js";function O(){const o=Object.fromEntries(Object.keys(process.env).map(n=>[n,i(n)]));o.REDOCLY_EXECUTION_MODE=process.env.REDOCLY_EXECUTION_MODE,o.REDOCLY_INTERNAL_DEV=process.env.REDOCLY_INTERNAL_DEV,o.REDOCLY_PORTAL_VERSION=process.env.REDOCLY_PORTAL_VERSION;const e=r.parse(o);return{...e,isProductionEnv:e.REDOCLY_ENV==="production",isPreviewEnv:e.REDOCLY_ENV==="preview",isReunite:["production","preview"].includes(e.REDOCLY_ENV)||e.REDOCLY_ENV==="development"&&!e.REDOCLY_INTERNAL_DEV&&!!e.ORGANIZATION_ID,isBuildMode:e.REDOCLY_EXECUTION_MODE==="build",isDevelopMode:e.REDOCLY_EXECUTION_MODE==="develop",isRuntimeMode:e.REDOCLY_EXECUTION_MODE==="runtime"}}const E=O();function c(){const o=O();for(const e of Object.keys(E))delete E[e];Object.assign(E,o)}function R(o,e){const n=typeof o=="string"?{[o]:e}:o;for(const[s,t]of Object.entries(n))t==null?delete process.env[s]:process.env[s]=t;c()}export{E as envConfig,c as reloadEnvConfig,R as setEnv};