@redocly/redoc 0.137.0-next.6 → 0.137.0-next.7

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

@@ -1,17 +0,0 @@
-import type { OpenAPIParser, ContentItemModel, OperationModel, Options, SchemaModel } from '@redocly/openapi-docs';
-import type { OpenAPIInfo } from '@redocly/openapi-docs/lib/types';
-import type { OperationParameter } from '@redocly/theme/core/types';
-import type { SearchDocument } from '../../types';
-import { OpenApiSearchBuilder } from './openapi-search-builder.js';
-export declare class SearchIndexer extends OpenApiSearchBuilder {
-    #private;
-    constructor(parser: OpenAPIParser, options: Options, basePath: string);
-    addItem(item: ContentItemModel): SearchDocument | undefined;
-    addInfo(info: OpenAPIInfo, metadata: Record<string, unknown>): SearchDocument & {
-        metadata: Record<string, unknown>;
-    };
-    getResult(): SearchDocument[];
-    protected buildOperationDocument(operation: OperationModel, rbac: Record<string, string> | undefined): SearchDocument | undefined;
-    protected addSchema(parameters: Record<string, OperationParameter>, schema: SchemaModel | undefined, mediaType: string | undefined, place: string, isResponse: boolean, path?: string[], visitedPointers?: Set<string>, level?: number): void;
-}
-//# sourceMappingURL=search-indexer.d.ts.map

package/dist/server/plugins/openapi-docs/search-indexer.js

@@ -1 +0,0 @@
-import{REDOCLY_TEAMS_RBAC as f}from"@redocly/config";import{SEARCH_DOCUMENT_METADATA_KEY as h}from"../../constants/plugins/search.js";import{removeMarkdownLinks as m,stripFormatting as l}from"./utils.js";import{OpenApiSearchBuilder as p}from"./openapi-search-builder.js";import{normalizeFrontmatterKeywords as x}from"../helpers/normalize-frontmatter-keywords.js";class b extends p{#t=[];#e;constructor(e,t,r){super(e,t,r)}addItem(e){const{result:t}=x(e.keywords||e.operationDefinition?.keywords);t?.excludes&&e.type==="section"&&e.id===""&&(this.#e=t.excludes);try{const r=this.buildSearchDocument(e);if(!r)return;const n=[...new Set([...t?.excludes?t.excludes:[],...this.#e?this.#e:[]])];return(t||n.length)&&(r[h]={curated:!0,...t,excludes:n}),this.#t.push(r),r}catch(r){console.error("Cannot add item to search indexer",r.message)}}addInfo(e,t){const r=this.basePath,n={id:r,url:r,text:l(m(e.description||"")),title:l(`${e.title} (${e.version})`),metadata:t};return this.#t.push(n),n}getResult(){return this.#t}buildOperationDocument(e,t){const r=this.createOperationDocumentBase(e,t);if(r)return{...r,isAdditionalOperation:e.isAdditionalOperation,badges:e.badges.length?e.badges:void 0}}addSchema(e,t,r,n,o,s=[],d=new Set,a=0){if(!(!t||t.isCircular)){if(t.pointer){if(d.has(t.pointer))return;d.add(t.pointer)}if(!(a>this.options.generatedSamplesMaxDepth)){if(t.fields)for(const i of t.fields){if(t[f]||i.kind==="additionalProperties"||i.schema?.readOnly&&!o||i.schema?.writeOnly&&o)continue;const c=this.createSchemaFieldParameter(i,t,n,r,s),u=this.getParameterId(c);e[u]==null&&(e[u]=c,this.addSchema(e,i.schema,r,n,o,s.concat([i.name]),d,a+1))}t.items&&this.addSchema(e,t.items,r,n,o,s,d,a+1)}}}}export{b as SearchIndexer};

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

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

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

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

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

@@ -1,4 +0,0 @@
-import type { BundledDefinition } from './load-definition';
-export declare function storeDefinitionBundles(definitions: BundledDefinition[], outDir: string): void;
-export declare function replaceFileExtension(filePath: string, fileExt: string): string;
-//# sourceMappingURL=store-definition-bundles.d.ts.map

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

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

package/dist/server/plugins/openapi-docs/types.d.ts

@@ -1,17 +0,0 @@
-import type { OperationMenuItem } from '@redocly/openapi-docs/lib/models';
-import type { OperationParameter } from '@redocly/theme/core/types';
-export type TagOperations = {
-    untagged: OperationMenuItem[];
-    tagged: Map<string, OperationMenuItem[]>;
-};
-export type SchemaVariant = {
-    title: string;
-    parameters: OperationParameter[];
-};
-export type OperationParameterWithVariants = OperationParameter & {
-    oneOf?: {
-        discriminator?: string;
-        variants: SchemaVariant[];
-    };
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/server/plugins/openapi-docs/utils.d.ts

@@ -1,25 +0,0 @@
-import type { IMenuItem, SchemaModel } from '@redocly/openapi-docs';
-import type { ItemBadge, NavItem, ResolvedNavItem } from '@redocly/config';
-export type IMenuItemExtended = {
-    httpVerb?: string;
-    isWebhook?: boolean;
-    badges?: ItemBadge[];
-} & IMenuItem;
-export declare function convertOpenAPIDocs2Sidebar(data: {
-    contentItems: IMenuItemExtended[];
-    sidebarItems: ResolvedNavItem[];
-    routeSlug: string;
-    navItem?: NavItem;
-}): void;
-export declare function shouldAddRoute({ item }: {
-    item: IMenuItem;
-}): boolean;
-export declare const removeMarkdownLinks: (text: string | Record<string, any>) => any;
-export declare function normalizeFeedbackOptions(feedbackOptions: Record<string, any> | null | undefined): Record<string, any> | undefined;
-export declare function stripFormatting(text: string | Record<string, any> | null): string;
-/**
- * Returns the oneOf schema when `schema` (or, for an array, its items) is a
- * oneOf/anyOf/discriminator — the single `oneOf` property the model uses for all of them.
- */
-export declare function getOneOfSchema(schema: SchemaModel | undefined): SchemaModel | undefined;
-//# sourceMappingURL=utils.d.ts.map

package/dist/server/plugins/openapi-docs/utils.js

@@ -1 +0,0 @@
-import{REDOCLY_TEAMS_RBAC as i}from"@redocly/config";import{combineUrls as l}from"@redocly/theme/core/utils";import{FEEDBACK_TYPES as c}from"../../../constants/common.js";import{normalizeRouteSlug as f}from"../../../utils/path/normalize-route-slug.js";function u(t){const{contentItems:r,sidebarItems:a,routeSlug:o,navItem:s}=t;let m=!0;for(const e of r){let n;switch(e.type){case"group":a.push({type:"separator",label:e.name,hideWhenEmpty:!0,[i]:e[i]}),u({...t,contentItems:e.items,sidebarItems:a});break;case"tag":n=l(o,e.href);const b={type:"group",label:e.name,items:[],link:n,routeSlug:n,[i]:e[i]};a.push(b),u({routeSlug:o,contentItems:e.items,sidebarItems:b.items||[],navItem:s});break;case"operation":case"schema":case"rsrc":case"prompt":case"tool":e.isWebhook&&m&&(a.push({type:"separator",label:"Webhooks",variant:"secondary",hideWhenEmpty:!0}),m=!1),n=l(o,e.href),a.push({type:"link",label:e.name,httpVerb:e.type==="operation"?e.httpVerb:e.type,routeSlug:f(n),badges:e.badges,link:n,deprecated:e.deprecated,isAdditionalOperation:e.isAdditionalOperation,[i]:e[i]});break;case"section":if(e.depth===-1)continue;n=l(o,e.href);const p=e.href==="/",d={type:e.items.length?"group":"link",label:p&&s?.label?s.label:e.name,labelTranslationKey:s?.labelTranslationKey,routeSlug:n.split("#")[0]===o?o:f(n),link:n,items:[],...p&&s?.icon&&{icon:typeof s.icon=="object"?s.icon.srcSet:s.icon},...p&&s?.badges&&{badges:s.badges}};a.push(d),e.items.length&&u({routeSlug:o,contentItems:e.items,sidebarItems:d.items});break}}}function S({item:t}){return t.id===""?!0:t.type!=="group"||t.description!==""}const I=t=>(typeof t=="string"?t:t?.raw)?.replace(/\[(.*?)\][\[\(].*?[\]\)]/g,"$1")||"";function E(t){if(!t)return;let r="";const{type:a,settings:o}=t;switch(a){case c.RATING:r="Rate this section";break;case c.SENTIMENT:r="Was this section helpful?";break;case c.MOOD:r="Was this section helpful?";break;case c.COMMENT:r="Share your feedback about this section";break;case c.SCALE:r="How would you rate this section?";break}return{...t,settings:{...o,label:o?.label||r}}}function O(t){return(typeof t=="string"?t:t?.raw||"").replace(/<[^>]*>/g,"").replace(/```([\s\S]*?)```/g,"$1").replace(/`([^`]+)`/g,"$1").replace(/\*\*(.*?)\*\*/g,"$1").replace(/\*(.*?)\*/g,"$1").trim()}function A(t){if(t?.oneOf)return t;if(t?.items?.oneOf)return t.items}export{u as convertOpenAPIDocs2Sidebar,A as getOneOfSchema,E as normalizeFeedbackOptions,I as removeMarkdownLinks,S as shouldAddRoute,O as stripFormatting};