@redocly/api-docs 0.0.2

package/lib/services/schema/propertyBuilder.d.ts

@@ -0,0 +1,32 @@
+import type { SchemaNode, DiscriminatorObject, PropertyType, AccessMode } from '../../types/schema.js';
+export declare function detectJsonSchemaType(schema: SchemaNode): string;
+export declare function schemaHasType(type: string | string[], target: string): boolean;
+export declare function isArrayTypedSchema(schema: SchemaNode): boolean;
+export declare function isStructuredArrayItems(items: SchemaNode): boolean;
+export declare function isPrimitiveLikeSchema(schema: SchemaNode, type: string | string[]): boolean;
+/**
+ * Primitive items that carry their own documentation are rendered as a nested
+ * `[i]` row, so the array row keeps only the array-level info; trivial primitive
+ * items stay flattened into the array row with their metadata promoted onto it.
+ */
+export declare function primitiveArrayItemsHaveOwnInfo(items: SchemaNode): boolean;
+export declare function humanizeConstraints(schema: SchemaNode): string[];
+export declare function buildDisplayType(schema: SchemaNode, type: string | string[]): {
+    typePrefix: string;
+    displayType: string;
+    displayFormat: string;
+};
+export declare function getDocumentedPrimitiveArrayItems(schema: SchemaNode, type: string | string[]): SchemaNode | undefined;
+export declare function stringifyValue(value: unknown): string;
+export declare function toPropertyExample(value: unknown, exampleSerializer?: (value: unknown) => string): PropertyType['example'];
+export declare function getAccessMode(schema: SchemaNode): AccessMode;
+export declare function getEnum(schema: SchemaNode): PropertyType['enum'];
+export declare function getDiscriminatorObject(schema: SchemaNode): DiscriminatorObject | undefined;
+export type PropertyShellOptions = {
+    isRequired?: boolean;
+    isAdditionalProperty?: boolean;
+    isPatternProperty?: boolean;
+    exampleSerializer?: (value: unknown) => string;
+};
+export declare function buildPropertyShell(schema: SchemaNode, options?: PropertyShellOptions): PropertyType;
+export declare function promotePrimitiveArrayMetadata(property: PropertyType, schema: SchemaNode, type: string | string[], exampleSerializer?: (value: unknown) => string): void;

package/lib/services/schema/propertyBuilder.js

@@ -0,0 +1 @@
+import{isSchemaNode as T,isStructuredExample as v}from"../../types/schema.js";const D=new Set(["x-circular-ref","x-complex","x-nullable","x-badges","x-enumDescriptions","x-additionalPropertiesName","x-discriminator","x-displayName","x-parentRefs","x-original-ref"]),R={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",properties:"object",additionalProperties:"object",patternProperties:"object"},w=Object.entries(R);function d(e){if(e.type!==void 0&&!Array.isArray(e.type))return e.type;for(const[r,t]of w)if(e[r]!==void 0)return t;return"any"}function l(e,r){return e===r||Array.isArray(e)&&e.includes(r)}function k(e){return l(e.type||d(e),"array")}function y(e){return!e["x-circular-ref"]&&!e["x-complex"]&&k(e)&&(e.items!==void 0||e.prefixItems!==void 0)}function $(e,r){if(e["x-circular-ref"]||e["x-complex"])return!0;if(e.oneOf!==void 0||e.anyOf!==void 0||e.if&&e.then||e.if&&e.else||Array.isArray(e.items)||Array.isArray(e.prefixItems))return!1;if(l(r,"object")){const t=e.properties;if(!(t!==void 0?Object.keys(t).length===0:e.additionalProperties===void 0&&e.unevaluatedProperties===void 0&&e.patternProperties===void 0))return!1}if(l(r,"array")&&e.items!==void 0&&typeof e.items!="boolean"&&!Array.isArray(e.items)){if(y(e.items))return!1;const t=$(e.items,e.items.type||d(e.items));return t&&x(e.items)?!1:t}return!0}function x(e){return!!(e.description||e.pattern||e.externalDocs||e.default!==void 0||e.const!==void 0||e.deprecated||e.contentEncoding||O(e).length)}function c(e,r,t){if(r!==void 0&&t!==void 0)return r===t?`= ${r} ${e}`:`[ ${r} .. ${t} ] ${e}`;if(t!==void 0)return`<= ${t} ${e}`;if(r!==void 0)return r===1?"non-empty":`>= ${r} ${e}`}function q(e){const r=typeof e.exclusiveMinimum=="number"?Math.min(e.exclusiveMinimum,e.minimum??1/0):e.minimum,t=typeof e.exclusiveMaximum=="number"?Math.max(e.exclusiveMaximum,e.maximum??-1/0):e.maximum,u=typeof e.exclusiveMinimum=="number"||!!e.exclusiveMinimum,o=typeof e.exclusiveMaximum=="number"||!!e.exclusiveMaximum;if(r!==void 0&&t!==void 0)return`${u?"( ":"[ "}${r} .. ${t}${o?" )":" ]"}`;if(t!==void 0)return`${o?"< ":"<= "}${t}`;if(r!==void 0)return`${u?"> ":">= "}${r}`}function O(e){const r=[],t=i=>{i&&r.push(i)};t(c("characters",e.minLength,e.maxLength)),t(c("items",e.minItems,e.maxItems));const u=e.minProperties,o=e.maxProperties;t(c(u===1&&o===1?"property":"properties",u,o));const f=e.multipleOf;if(f!==void 0){const i=f.toString(10);r.push(/^0\.0*1$/.test(i)?`decimal places <= ${i.split(".")[1].length}`:`multiple of ${i}`)}return t(q(e)),e.uniqueItems&&r.push("unique"),r}function L(e){return e.split(" or ").map(r=>r.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2")).join(" or ")}function J(e){if(!Y(e)?.propertyName)return e.oneOf??e.anyOf}function _(e){return[...new Set(e.map(r=>{const t=r.type||d(r),{typePrefix:u,displayType:o}=j(r,t),f=r["x-original-ref"]?.split("/").pop(),i=r.title||f;let n=u+(i?`${i} (${o})`:o);return n.indexOf(" or ")>-1&&(n=`(${n})`),n}))].join(" or ")}function j(e,r){const t=J(e);if(t)return{typePrefix:"",displayType:_(t),displayFormat:e.format||""};let u="",o=Array.isArray(r)?r.map(i=>i===null?"null":i).join(" or "):r,f=e.format||"";if(l(r,"array")){const i=e.items;if(i&&!Array.isArray(i)&&typeof i!="boolean"&&!Array.isArray(e.prefixItems)){if(y(i))o="items";else{const n=i.type||d(i);o=L(Array.isArray(n)?n.join(" or "):n),f=S(e,r)?"":i.format||""}u="Array of "}else Array.isArray(e.prefixItems)||Array.isArray(e.items)||e.items===!1?o="Array of items":(o="any",u="Array of ");if(Array.isArray(r)){const n=r.filter(s=>s!=="array");n.length&&(o+=` or ${n.join(" or ")}`)}}if(e.nullable||e["x-nullable"]){const i=Array.isArray(r)?r:[r];!i.includes("null")&&!i.some(n=>n===null)&&(o+=" or null")}return{typePrefix:u,displayType:o,displayFormat:f}}function I(e,r){if(!l(r,"array")||Array.isArray(e.prefixItems))return;const t=e.items;if(T(t)&&!(t["x-circular-ref"]||t["x-complex"])&&!y(t))return $(t,t.type||d(t))?t:void 0}function S(e,r){const t=I(e,r);return t&&x(t)?t:void 0}function z(e,r){const{typePrefix:t,displayType:u,displayFormat:o}=j(e,r),f=e.contentEncoding||"",i=O(e),n=[t+u];return o&&n.push(`(${o})`),f&&n.push(f),n.push(...i),n.join(", ")}function E(e){return typeof e=="string"?e:JSON.stringify(e)}function M(e,r){return r?r(e):v(e)?e:JSON.stringify(e)}function C(e,r){const t=e.examples;if(!t||typeof t!="object"||Array.isArray(t))return;const u=r??E,o={};for(const[f,i]of Object.entries(t)){if(!i||typeof i!="object"||Array.isArray(i))continue;const n=i,s=n.value,p={...typeof n.summary=="string"&&{summary:n.summary},...typeof n.description=="string"&&{description:n.description},...s!==void 0&&{value:u(s)}};Object.keys(p).length>0&&(o[f]=p)}return Object.keys(o).length>0?o:void 0}function V(e){const r={};let t=!1;for(const u of Object.keys(e))u.startsWith("x-")&&!u.startsWith("x-redocly")&&!D.has(u)&&(r[u]=E(e[u]),t=!0);return t?r:void 0}function W(e){if(e.readOnly)return"read-only";if(e.writeOnly)return"write-only"}function N(e){return e["x-enumDescriptions"]??(e.enum?.length?e.enum:void 0)}function Y(e){return e.discriminator??e["x-discriminator"]}function H(e,r={}){const{isRequired:t=!1,isAdditionalProperty:u=!1,isPatternProperty:o=!1,exampleSerializer:f}=r,i=e.type||d(e),n={type:z(e,i)};let s=e["x-original-ref"]?.split("/").pop(),p=e.title||s;if(!p&&l(i,"array")&&!S(e,i)){const a=e.items;a&&!Array.isArray(a)&&typeof a!="boolean"&&(s=a["x-original-ref"]?.split("/").pop(),p=a.title||s)}p&&(n.title=p),s&&(n.schemaName=s),u&&(n.isAdditionalProperty=!0),o&&(n.isPatternProperty=!0),e["x-circular-ref"]&&(n.isCircular=!0),e["x-complex"]&&(n.isComplex=!0),t&&(n.isRequired=!0),e.deprecated&&(n.isDeprecated=!0),e.description&&(n.description=e.description),e.pattern&&(n.pattern=e.pattern),e.example!==void 0&&(n.example=M(e.example,f)),e.default!==void 0&&(n.default=JSON.stringify(e.default));const m=C(e,f);m&&(n.examples=m);const g=e["x-badges"];g?.length&&(n.badges=g);const A=W(e);A&&(n.accessMode=A);const b=N(e);b&&(n.enum=b);const P=V(e);return P&&(n.extensions=P),e.externalDocs&&(n.externalDocs={description:e.externalDocs.description||"",url:e.externalDocs.url||""}),e.const!==void 0&&(n.const=JSON.stringify(e.const)),n}function K(e,r,t,u){const o=I(r,t);!o||x(o)||(e.enum||(e.enum=N(o)),e.example===void 0&&o.example!==void 0&&(e.example=M([o.example],u)))}export{j as buildDisplayType,H as buildPropertyShell,d as detectJsonSchemaType,W as getAccessMode,Y as getDiscriminatorObject,S as getDocumentedPrimitiveArrayItems,N as getEnum,O as humanizeConstraints,k as isArrayTypedSchema,$ as isPrimitiveLikeSchema,y as isStructuredArrayItems,x as primitiveArrayItemsHaveOwnInfo,K as promotePrimitiveArrayMetadata,l as schemaHasType,E as stringifyValue,M as toPropertyExample};

package/lib/services/schema/propertyTreeBuilder.d.ts

@@ -0,0 +1,21 @@
+import type { SchemaNode, PropertyType } from '../../types/schema.js';
+export type SchemaTreeContext = {
+    prepareVariant(ref: SchemaNode): SchemaNode;
+    propertyRefCache: Map<string, PropertyType>;
+    variantResolutionCache: Map<string, SchemaNode>;
+    isChild?: boolean;
+    implicitDiscriminatorChildren?: Record<string, ImplicitDiscriminatorChild[]>;
+    exampleSerializer?: (value: unknown) => string;
+    sortRequiredPropsFirst?: boolean;
+    /** Refs open on the current DFS path; reaching one again is a cycle. */
+    activeRefs: Set<string>;
+    depth: number;
+    /** Refs on a reference cycle; memoized by ref alone so a cyclic component expands once. */
+    recursiveRefs: ReadonlySet<string>;
+};
+type ImplicitDiscriminatorChild = {
+    ref: string;
+    value: string;
+};
+export declare function buildPropertyTree(preparedRoot: SchemaNode, ctx: SchemaTreeContext, rootJsonPointer: string): PropertyType;
+export {};

package/lib/services/schema/propertyTreeBuilder.js

@@ -0,0 +1 @@
+import{encodeJsonPointerSegment as M}from"../../utils/refPointer.js";import{isSchemaNode as O,switcherLabel as A}from"../../types/schema.js";import{buildPropertyShell as K,detectJsonSchemaType as S,getAccessMode as j,getDiscriminatorObject as w,getDocumentedPrimitiveArrayItems as k,getEnum as H,humanizeConstraints as J,isPrimitiveLikeSchema as $,isStructuredArrayItems as X,primitiveArrayItemsHaveOwnInfo as Y,promotePrimitiveArrayMetadata as G,schemaHasType as x,toPropertyExample as T}from"./propertyBuilder.js";import{deriveVariantLabel as U}from"./variant-label.js";const W=10,Q=200;function Z(e,i,r,t){const n=w(i)?`${e}:d`:e;return t?`${n}#rec`:`${n}@${r}`}function I(e){if(e.isCircular)return!0;if(e.properties){for(const i of Object.values(e.properties))if(I(i))return!0}if(e.items){for(const i of e.items)if(I(i))return!0}if(e.switcher)for(const i of Object.values(e.switcher.options)){if(i.isCircular)return!0;if(i.properties){for(const r of Object.values(i.properties))if(I(r))return!0}}return!1}const V=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function h(e){const i=e.match(V);if(i)return i[2].replace(/~1/g,"/").replace(/~0/g,"~")}function y(e,i,r={},t){const n=K(e,{...r,exampleSerializer:i.exampleSerializer});if(!n.title){const l=h(t);l&&(n.title=l)}if(n.isCircular||n.isComplex)return n;const s=e["x-original-ref"];if(s&&i.activeRefs.has(s))return n.isCircular=!0,n;if(i.activeRefs.size>W||i.depth>Q)return n.isComplex=!0,n;const f=s!==void 0&&i.recursiveRefs.has(s),u=s===void 0?void 0:Z(s,e,t,f);if(u){const l=i.propertyRefCache.get(u);if(l)return{...l,...n}}s&&i.activeRefs.add(s);try{ie(n,e,{...i,depth:i.depth+1},t)}finally{s&&i.activeRefs.delete(s)}return u&&(f||!I(n))&&i.propertyRefCache.set(u,n),n.isExpandable=ee(n),n}function ee(e){if(e.isCircular)return!1;const i=t=>!t.isCircular&&(!!t.switcher||!!t.items?.length||!!(t.properties&&Object.keys(t.properties).length)),r=t=>t.isCircular?!1:!!(t.properties&&Object.values(t.properties).some(i)||t.items?.some(r)||t.switcher&&Object.values(t.switcher.options).some(r));return!!(e.properties&&Object.values(e.properties).some(i)||e.switcher&&Object.values(e.switcher.options).some(r)||e.items?.some(r))}function _(e,i){if(!Array.isArray(e)||e.length===0)return;let r;for(let t=0;t<e.length;t++){const n=e[t];if(!O(n))return;const s=i(n);if(s===void 0)return;if(t===0)r=s;else if(s!==r)return}return r}function E(e,i,r){if(e.example!==void 0||_(i,s=>s.example===void 0?void 0:JSON.stringify(s.example))===void 0)return;const n=Array.isArray(i)?i[0]:void 0;O(n)&&(e.example=T(n.example,r))}function R(e,i){if(e.accessMode!==void 0)return;const r=_(i,j);r&&(e.accessMode=r)}function ie(e,i,r,t){const n=i.type||S(i),s=$(i,n),f=w(i);if(!r.isChild&&f?.propertyName){e.switcher=B(i,f,r,t),E(e,i.oneOf??i.anyOf,r.exampleSerializer),R(e,i.oneOf??i.anyOf),i.properties&&(e.properties=g(i,r,t));return}if(i.oneOf!==void 0){if(e.switcher=N(i.oneOf,A.ONE_OF,r,t,"oneOf",i),E(e,i.oneOf,r.exampleSerializer),R(e,i.oneOf),i.properties){const u=g(i,r,t);e.properties=u;for(const l of Object.values(e.switcher.options))l.properties={...u,...l.properties||{}}}return}if(i.anyOf!==void 0){if(e.switcher=N(i.anyOf,A.ANY_OF,r,t,"anyOf",i),E(e,i.anyOf,r.exampleSerializer),R(e,i.anyOf),i.properties){const u=g(i,r,t);e.properties=u;for(const l of Object.values(e.switcher.options))l.properties={...u,...l.properties||{}}}return}if(i.if&&i.then||i.if&&i.else){e.switcher=fe(i,r,t);return}!s&&x(n,"object")&&(e.properties=g(i,r,t)),!s&&x(n,"array")&&(e.items=L(i,r,t),z(i)!==void 0&&delete e.example,e.example===void 0&&O(i.items)&&i.items.example!==void 0&&!k(i,n)&&(e.example=T([i.items.example],r.exampleSerializer))),G(e,i,n,r.exampleSerializer)}function te(e,i){const r=[],t=[],n=[];for(const[s,f]of Object.entries(e))f.isRequired?i.includes(s)?r.push([s,f]):t.push([s,f]):n.push([s,f]);return r.sort(([s],[f])=>i.indexOf(s)-i.indexOf(f)),Object.fromEntries([...r,...t,...n])}function g(e,i,r){const t={},n={...i,isChild:!1},s=e.required||[],f=O(e.default)?e.default:{},u=O(e.example)?e.example:void 0,l=e.properties||{};for(const[o,a]of Object.entries(l)){const p={...a};p.default===void 0&&f[o]!==void 0&&(p.default=f[o]),p.example===void 0&&u?.[o]!==void 0&&(p.example=u[o]);const c=`${r}/properties/${M(o)}`;t[o]=y(p,n,{isRequired:s.includes(o)},c)}for(const[o,a]of Object.entries(e.patternProperties||{})){const p=`${r}/patternProperties/${M(o)}`;t[o]=y(a,n,{isPatternProperty:!0},p)}const d=e.additionalProperties??e.unevaluatedProperties;if(O(d)){const o=(d["x-additionalPropertiesName"]||"property name")+"*",a=`${r}/additionalProperties`;t[o]=y(d,n,{isAdditionalProperty:!0},a)}else d===!0&&(t["property name*"]=y({},n,{isAdditionalProperty:!0},`${r}/additionalProperties`));return i.sortRequiredPropsFirst?F(te(t,s)):F(t)}function F(e){const i={};for(const[r,t]of Object.entries(e).sort(([,n],[,s])=>+!!n.isDeprecated-+!!s.isDeprecated))i[r]=t;return i}function z(e){const i=Array.isArray(e.prefixItems)?e.prefixItems:Array.isArray(e.items)?e.items:void 0;return!i?.length||!Array.isArray(e.example)||!e.example.length||e.example.length>i.length||e.example.some((t,n)=>t!==void 0&&O(i[n])&&i[n].example!==void 0)?void 0:e.example}function L(e,i,r){const t={...i},n=z(e),s=(f,u)=>n?.[u]!==void 0?{...f,example:n[u]}:f;if(Array.isArray(e.prefixItems)){const f=e.prefixItems.map((u,l)=>P(y(s(u,l),t,{},`${r}/prefixItems/${l}`)));return f.push(...q(e.items,t,`${r}/items`)),f}if(Array.isArray(e.items)){const f=e.items.map((u,l)=>P(y(s(u,l),t,{},`${r}/items/${l}`)));return f.push(...q(e.additionalItems,t,`${r}/additionalItems`)),f}return O(e.items)&&(X(e.items)||!$(e.items,e.items.type||S(e.items))||Y(e.items))?[y(e.items,t,{},`${r}/items`)]:[]}function q(e,i,r){return e!==!0&&!O(e)?[]:[re(y(e===!0?{}:e,i,{},r))]}function re(e){return{...e,isAdditionalItems:!0}}function P(e){return{...e,isTupleItem:!0}}function D(e,i){const r=i.variantResolutionCache.get(e);if(r)return r;const t=i.prepareVariant({$ref:e});return O(t)?(delete t.discriminator,delete t["x-discriminator"],delete t["x-original-ref"],i.variantResolutionCache.set(e,t),t):{}}const ne="Default mapping";function se(e,i){if(typeof e["x-original-ref"]=="string")return e["x-original-ref"];if(V.test(i))return i}function B(e,i,r,t){const n=i.mapping||{},s=i["x-explicitMappingOnly"]??Object.keys(n).length>0,f=e.oneOf||e.anyOf||[],u={...r,isChild:!0},l=e.oneOf!==void 0?"oneOf":"anyOf",d={};if(Object.keys(n).length>0)for(const[o,a]of Object.entries(n)){const c=f.find(C=>C["x-original-ref"]===a)??D(a,r),b=f.findIndex(C=>C["x-original-ref"]===a),m=b>=0?`${t}/${l}/${b}`:t;d[o]=v(c||{},u,!1,m,a)}else for(let o=0;o<f.length;o++){const a=f[o],p=a.title||a["x-original-ref"]?.split("/").pop()||"Variant",c=`${t}/${l}/${o}`;d[p]=v(a,u,!1,c,a["x-original-ref"])}if(f.length===0&&!s){const o=new Set(Object.values(n)),a=se(e,t),p=a?r.implicitDiscriminatorChildren?.[a]:void 0;if(p)for(const{ref:c,value:b}of p)o.has(c)||(d[b]=v(D(c,r),u,!1,t,c))}if(i.defaultMapping){const o=i.defaultMapping;for(const[m,C]of Object.entries(n))C===o&&delete d[m];const p=f.find(m=>m["x-original-ref"]===o)??D(o,r),c=f.findIndex(m=>m["x-original-ref"]===o),b=c>=0?`${t}/${l}/${c}`:t;d[ne]=v(p||{},u,!0,b,o)}return{type:"discriminator",label:A.DISCRIMINATOR,propertyName:i.propertyName,jsonPointer:t,options:d}}function N(e,i,r,t,n,s){const f={},u={...r,isChild:!1};for(let l=0;l<e.length;l++){const d=e[l],o={type:s.type,...d},{label:a,typeLabel:p}=U(d,s),c=`${t}/${n}/${l}`,b=f[a]?`${a} (${l+1})`:a,m=v(o,u,!1,c,d["x-original-ref"]);m.typeLabel=p,d.title&&(m.title=d.title),f[b]=m}return{type:"oneOf",label:i,jsonPointer:t,options:f}}function fe(e,i,r){const{if:t,then:n={},else:s={},description:f,...u}=e,l={...i,isChild:!1},d=(...o)=>i.prepareVariant({allOf:o.filter(a=>a!=null)});return{type:"oneOf",label:A.ONE_OF,jsonPointer:r,options:{[t?.["x-displayName"]||t?.title||"case 1"]:v(d(u,n,t),l,!1,r),[s?.["x-displayName"]||s?.title||"case 2"]:v(d(u,s),l,!1,r)}}}function v(e,i,r,t,n){const s={isDeprecated:!!e.deprecated,isDefaultMapping:r};e.description&&(s.description=e.description);const f=e["x-original-ref"]?.split("/").pop();f&&(s.schemaName=f);const u=j(e);u&&(s.accessMode=u);const l=J(e);l.length&&(s.constraints=l);const d=H(e);if(d&&(s.enum=d),n&&i.activeRefs.has(n))return s.isCircular=!0,s;const o=e.type||S(e);n&&i.activeRefs.add(n);try{const a=w(e);if(!i.isChild&&a?.propertyName?(s.switcher=B(e,a,i,t),e.properties&&(s.properties=g(e,i,t))):e.oneOf!==void 0?(s.switcher=N(e.oneOf,A.ONE_OF,i,t,"oneOf",e),e.properties&&(s.properties=g(e,i,t))):e.anyOf!==void 0?(s.switcher=N(e.anyOf,A.ANY_OF,i,t,"anyOf",e),e.properties&&(s.properties=g(e,i,t))):!$(e,o)&&(x(o,"object")||e.properties)&&(s.properties=g(e,i,t)),!$(e,o)&&x(o,"array")){const p=L(e,i,t);p.length&&(s.items=p)}}finally{n&&i.activeRefs.delete(n)}return s}function de(e,i,r){return delete e["x-original-ref"],y(e,i,{},r)}export{de as buildPropertyTree};

package/lib/services/schema/schemaProcessor.d.ts

@@ -0,0 +1,2 @@
+import type { PropertyType, SchemaNode, Document, SchemaProcessorOptions } from '../../types/schema.js';
+export declare function schemaProcessor(schema: SchemaNode, document: Document, options?: SchemaProcessorOptions): PropertyType;

package/lib/services/schema/schemaProcessor.js

@@ -0,0 +1 @@
+import{JsonSchemaDialectId as a,jsonSchemaDialect as d}from"./dialects/jsonSchema.js";import{GraphqlSchemaDialectId as u}from"./dialects/graphqlSchema.js";const l=new WeakMap;function p(t,s,e){const n=e?.dialectId??a;let r;switch(n){case a:r=d;break;case u:default:r=d}const c=e?.rootJsonPointer??"#";if(e?.exampleSerializer)return r.process(t,s,e);const o=l.get(t);if(o?.dialectId===r.id&&o?.rootJsonPointer===c&&o?.sortRequiredPropsFirst===e?.sortRequiredPropsFirst)return o.result;const i=r.process(t,s,e);return l.set(t,{dialectId:r.id,rootJsonPointer:c,sortRequiredPropsFirst:e?.sortRequiredPropsFirst,result:i}),i}export{p as schemaProcessor};

package/lib/services/schema/variant-label.d.ts

@@ -0,0 +1,6 @@
+import type { SchemaNode } from '../../types/schema.js';
+export type VariantLabel = {
+    label: string;
+    typeLabel: string;
+};
+export declare function deriveVariantLabel(variant: SchemaNode, parentSchema: SchemaNode): VariantLabel;

package/lib/services/schema/variant-label.js

@@ -0,0 +1 @@
+import{buildDisplayType as r,detectJsonSchemaType as s,stringifyValue as d}from"./propertyBuilder.js";function f(e,l){const t={type:l.type,...e},n=t.type||s(t),{typePrefix:o,displayType:y,displayFormat:i}=r(t,n);let p=`${o}${y}`;return i&&(p+=` (${i})`),{label:e.title||e["x-original-ref"]?.split("/").pop()||(e.const!==void 0?d(e.const):void 0)||p,typeLabel:p}}export{f as deriveVariantLabel};

package/lib/telemetry/RedocTelemetry.d.ts

@@ -0,0 +1,15 @@
+import { Telemetry } from '@redocly/redoc-opentelemetry';
+import type { EventType, EventPayload } from '@redocly/redoc-opentelemetry';
+export type SpecType = 'openapi' | 'asyncapi' | 'graphql';
+export interface RedocTelemetryConfig {
+    specType: SpecType;
+    collectorUrl?: string;
+    serviceName?: string;
+    disabled?: boolean;
+    serviceVersion?: string;
+}
+export declare class RedocTelemetry extends Telemetry {
+    private specType;
+    constructor(config: RedocTelemetryConfig);
+    send<T extends EventType>(event: T, data?: EventPayload<T>): void;
+}

package/lib/telemetry/RedocTelemetry.js

@@ -0,0 +1 @@
+import{Telemetry as o}from"@redocly/redoc-opentelemetry";import c from"../../package.json"with{type:"json"};const p="https://otel.cloud.redocly.com/v1/traces";class n extends o{specType;constructor(e){super(),this.specType=e.specType,this.init({otel:{isProd:process.env.NODE_ENV==="production"||process.env.ENABLE_LOCAL_TELEMETRY==="true",serviceVersion:e.serviceVersion||`${c.name}@${c.version}`,version:"1.0.0",collectorTraceUrl:e.collectorUrl||p,serviceName:e.serviceName||"redoc-ce",tracerName:"client-telemetry"},disabled:e.disabled||!1})}send(e,r){r&&Array.isArray(r)&&r.length>0&&(r=r.map(s=>s&&typeof s=="object"?{...s,specType:this.specType}:s)),super.send(e,r,{env:process.env.NODE_ENV})}}export{n as RedocTelemetry};

package/lib/types/asyncapi.d.ts

@@ -0,0 +1,367 @@
+import type { ENTITY_RELATION_TYPES } from '@redocly/config';
+import type { Node } from '@markdoc/markdoc';
+import type { ResolvedNavItem, REDOCLY_TEAMS_RBAC } from '@redocly/config';
+import type { JSONSchema7 } from 'json-schema';
+import type { Referenced, ObjectValues } from './common.js';
+import type { ApiItem } from './store.js';
+import type { ApiDocsOptions } from './options.js';
+import type { StoreContext } from './store.js';
+export type AsyncApiDefinition = {
+    asyncapi: string;
+    id?: string;
+    info: AsyncApiInfo;
+    servers?: Record<string, AsyncApiServer>;
+    defaultContentType?: string;
+    channels?: AsyncApiChannels;
+    operations?: AsyncApiOperations;
+    components?: AsyncApiComponents;
+    'x-tagGroups'?: {
+        name: string;
+        tags: string[];
+        [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+    }[];
+    'x-redocly-catalog-key'?: string;
+};
+export type AsyncApiDefinitionReferenced = {
+    asyncapi: string;
+    id?: string;
+    info: AsyncApiInfo;
+    servers?: Record<string, AsyncApiServer>;
+    defaultContentType?: string;
+    channels?: AsyncApiChannels;
+    operations?: AsyncApiOperationsReferenced;
+    components?: AsyncApiComponentsReferenced;
+    'x-tagGroups'?: {
+        name: string;
+        tags: string[];
+        [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+    }[];
+};
+export type AsyncApiInfo = {
+    title: string;
+    version: string;
+    description?: string | Node[] | Node;
+    termsOfService?: string;
+    contact?: AsyncApiContact;
+    license?: AsyncApiLicense;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    'x-metadata'?: Record<string, unknown>;
+};
+export type AsyncApiContact = {
+    name?: string;
+    url?: string;
+    email?: string;
+};
+export type AsyncApiLicense = {
+    name: string;
+    url?: string;
+};
+export type AsyncApiTag = {
+    name: string;
+    description?: string | Node[] | Node;
+    externalDocs?: AsyncApiExternalDocs;
+};
+export type AsyncApiExternalDocs = {
+    description?: string | Node[] | Node;
+    url: string;
+};
+export type AsyncApiServer = {
+    host: string;
+    /** AsyncAPI 2.x servers carry `url` instead of `host`. */
+    url?: string;
+    protocol: string;
+    protocolVersion?: string;
+    pathname?: string;
+    description?: string | Node[] | Node;
+    title?: string;
+    summary?: string;
+    variables?: AsyncApiServerVariables;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiServerBinding;
+};
+export type AsyncApiServerVariables = {
+    [name: string]: AsyncApiServerVariable;
+};
+export type AsyncApiChannels = {
+    [name: string]: AsyncApiChannel;
+};
+export type AsyncApiServerVariable = {
+    enum?: string[];
+    default: string;
+    description?: string | Node[] | Node;
+    examples?: string[];
+};
+export type AsyncApiServerBinding = {
+    kafka?: AsyncApiServerKafkaBinding;
+};
+export type AsyncApiServerKafkaBinding = {
+    schemaRegistryUrl?: string;
+    schemaRegistryVendor?: string;
+    bindingVersion?: string;
+};
+export type AsyncApiChannel = {
+    address?: string;
+    messages?: AsyncApiMessages;
+    title?: string;
+    summary?: string;
+    description?: string | Node[] | Node;
+    servers?: AsyncApiServer[];
+    parameters?: AsyncApiParameters;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiChannelBinding;
+    'x-badges'?: AsyncApiXBadges[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type AsyncApiXBadges = {
+    name: string;
+    position?: 'before' | 'after';
+    color?: string;
+};
+export type AsyncApiChannelBinding = {
+    kafka?: AsyncApiChannelKafkaBinding;
+    amqp?: AsyncApiChannelAMQPBinding;
+};
+export type AsyncApiChannelKafkaBinding = {
+    topic?: string;
+    partitions?: number;
+    replicas?: number;
+    bindingVersion?: string;
+    topicConfiguration?: {
+        'cleanup.policy'?: string[];
+        'retention.ms'?: number;
+        'retention.bytes'?: number;
+        'delete.retention.ms'?: number;
+        'max.message.bytes'?: number;
+        'confluent.key.schema.validation'?: boolean;
+        'confluent.key.subject.name.strategy'?: string;
+        'confluent.value.schema.validation'?: boolean;
+        'confluent.value.subject.name.strategy'?: string;
+    };
+};
+export type AsyncApiChannelAMQPBinding = {
+    is: 'routingKey' | 'queue';
+};
+export type AsyncApiMessages = {
+    [name: string]: AsyncApiMessage;
+};
+export type AsyncApiParameters = {
+    [name: string]: AsyncApiParameter;
+};
+export type AsyncApiParameter = {
+    enum?: string[];
+    default?: string;
+    description?: string | Node[] | Node;
+    examples?: string[];
+    location?: string;
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type AsyncApiMessage = {
+    headers?: AsyncAPISchema;
+    payload?: AsyncAPISchema;
+    correlationId?: AsyncApiCorrelationId;
+    contentType?: string;
+    name?: string;
+    title?: string;
+    summary?: string;
+    description?: string | Node[] | Node;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiMessageBinding;
+    examples?: AsyncApiMessageExample[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type AsyncApiMessageReferenced = {
+    headers?: AsyncAPISchema;
+    payload?: Referenced<AsyncAPISchema>;
+    correlationId?: AsyncApiCorrelationId;
+    contentType?: string;
+    name?: string;
+    title?: string;
+    summary?: string;
+    description?: string | Node[] | Node;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiMessageBinding;
+    examples?: AsyncApiMessageExample[];
+};
+export type AsyncApiCorrelationId = {
+    description?: string | Node[] | Node;
+    location: string;
+};
+export type AsyncApiMessageBinding = {
+    kafka?: AsyncApiMessageKafkaBinding;
+};
+export type AsyncApiMessageKafkaBinding = {
+    key?: JSONSchema7;
+    schemaIdLocation?: string;
+    schemaIdPayloadEncoding?: string;
+    schemaLookupStrategy?: string;
+    bindingVersion?: string;
+};
+export type AsyncApiMessageExample = {
+    payload?: Record<string, unknown>;
+    name?: string;
+    summary?: string;
+};
+export type MultiFormatSchemaObject = {
+    schema: JSONSchema7 | AvroSchema;
+    schemaFormat: string;
+};
+export type AsyncApiOperations = {
+    [name: string]: AsyncApiOperation;
+};
+export type AsyncApiOperationsReferenced = {
+    [name: string]: AsyncApiOperationReferenced;
+};
+export type AsyncApiOperation = {
+    action: 'send' | 'receive';
+    channel: AsyncApiChannel;
+    title?: string;
+    summary?: string;
+    description?: string | Node[] | Node;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiOperationBinding;
+    traits?: AsyncApiOperationTraits[];
+    messages?: AsyncApiMessage[];
+    reply?: AsyncApiOperationReply;
+    'x-badges'?: AsyncApiXBadges[];
+    'x-catalogRelations'?: {
+        type: (typeof ENTITY_RELATION_TYPES)[number];
+        key: string;
+    }[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type AsyncApiOperationReferenced = {
+    action: 'send' | 'receive';
+    channel: AsyncApiChannel;
+    title?: string;
+    summary?: string;
+    description?: string | Node[] | Node;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiOperationBinding;
+    traits?: AsyncApiOperationTraits[];
+    messages?: Referenced<AsyncApiMessage>[];
+    reply?: AsyncApiOperationReply;
+    'x-badges'?: AsyncApiXBadges[];
+    'x-catalogRelations'?: {
+        type: (typeof ENTITY_RELATION_TYPES)[number];
+        key: string;
+    }[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type AsyncApiOperationReply = {
+    address?: {
+        description?: string | Node[] | Node;
+        location: string;
+    };
+    channel?: AsyncApiChannel;
+    messages?: AsyncApiMessage[];
+};
+export type AsyncApiOperationTraits = {
+    title?: string;
+    summary?: string;
+    description?: string | Node[] | Node;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiOperationBinding;
+};
+export type AsyncApiOperationBinding = {
+    kafka?: AsyncApiOperationKafkaBinding;
+};
+export type AsyncApiOperationKafkaBinding = {
+    groupId?: {
+        type: string;
+        enum: string[];
+    };
+    clientId?: {
+        type: string;
+        enum: string[];
+    };
+    bindingVersion?: string;
+};
+export type AsyncApiComponents = {
+    messages: Record<string, AsyncApiMessage>;
+    schemas: Record<string, AsyncAPISchema>;
+    tags: Record<string, AsyncApiTag>;
+};
+export type AsyncApiComponentsReferenced = {
+    messages: Record<string, AsyncApiMessageReferenced>;
+    schemas: Record<string, AsyncAPISchema>;
+    tags: Record<string, AsyncApiTag>;
+};
+export type AvroSchema = {
+    type: string | string[] | AvroSchema[];
+    name?: string;
+    doc?: string;
+    symbols?: string[];
+    fields?: Array<{
+        name: string;
+        type: AvroSchema | string | (string | AvroSchema)[];
+        doc?: string;
+        default?: unknown;
+    }>;
+    items?: AvroSchema | string;
+    values?: AvroSchema | string;
+};
+export type ResolvedAsyncApiNavItem = ResolvedNavItem & {
+    items?: ResolvedAsyncApiNavItem[];
+    action?: string;
+    ast?: Node | Node[];
+    httpVerb?: string;
+};
+export type DownloadUrls = {
+    url: string;
+};
+export type ChannelWithKey = AsyncApiChannel & {
+    key: string;
+};
+export type AsyncAPISchema = JSONSchema7 | MultiFormatSchemaObject;
+export declare const CONST_PROTOCOL_VARIANT: {
+    readonly DEFAULT: 'default';
+    readonly KAFKA: 'kafka';
+    readonly AMQP: 'amqp';
+    readonly WSS: 'wss';
+};
+export type ProtocolVariant = ObjectValues<typeof CONST_PROTOCOL_VARIANT>;
+export type AsyncApiBuildContext = {
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    basePath: string;
+    storeCtx: StoreContext;
+    protocol: ProtocolVariant | null;
+    channelToOperations: Record<string, string[]>;
+    groups: Record<string, ApiItem[]>;
+    items: ApiItem[];
+    descriptionItems: ApiItem[];
+    channelSummaries: Map<string, string>;
+    processContent: boolean;
+};
+export type BrokerData = {
+    /** Server host (3.x `host`, 2.x `url`); absent only for invalid documents. */
+    url?: string;
+    description?: string | Node[] | Node;
+    name?: string;
+    variables?: Record<string, {
+        enum?: string[];
+        default: string;
+        description?: string | Node[] | Node;
+        examples?: string[];
+    }>;
+    protocol?: string;
+    protocolVersion?: string;
+    pathname?: string;
+    title?: string;
+    summary?: string;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiServerBinding;
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type AsyncApiContext = {
+    protocol: string | null;
+};

package/lib/types/asyncapi.js

@@ -0,0 +1 @@
+const A={DEFAULT:"default",KAFKA:"kafka",AMQP:"amqp",WSS:"wss"};export{A as CONST_PROTOCOL_VARIANT};

package/lib/types/common.d.ts

@@ -0,0 +1,168 @@
+import type { Node } from '@markdoc/markdoc';
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '@redocly/theme/ext/configure';
+import type { UserClaims } from '@redocly/theme/core/types';
+export type { ConfigureRequestValues, ConfigureServerRequestValues };
+export type { UserClaims };
+export type { RbacScopeItems } from '@redocly/config';
+export type ObjectValues<T> = T[keyof T];
+export type OpenAPIRef = {
+    $ref: string;
+    'x-refsStack'?: string[];
+    summary?: string;
+    description?: string | Node[] | Node;
+};
+export type Referenced<T> = T | OpenAPIRef;
+export type SeoData = {
+    title?: string;
+    description?: string;
+    keywords?: string;
+    image?: string;
+};
+export type ExternalDocsData = {
+    url: string;
+    description?: string | Node[] | Node;
+};
+export type BadgeData = {
+    name: string;
+    color?: string;
+    position?: 'before' | 'after';
+    icon?: string;
+    description?: string;
+};
+export type Badge = {
+    name: string;
+    color?: string;
+    icon?: string;
+    description?: string;
+};
+export type ServerData = {
+    url: string;
+    name?: string;
+    description?: string;
+    variables?: Record<string, {
+        enum?: string[];
+        default: string;
+        description?: string | Node[] | Node;
+        examples?: string[];
+    }>;
+};
+export declare const apiSpecType: {
+    readonly OPENAPI: 'openapi';
+    readonly ASYNCAPI: 'asyncapi';
+    readonly GRAPHQL: 'graphql';
+};
+export type ApiSpecType = ObjectValues<typeof apiSpecType>;
+export declare const tagKind: {
+    readonly NAV: 'nav';
+    readonly BADGE: 'badge';
+    readonly AUDIENCE: 'audience';
+};
+export type TagKind = ObjectValues<typeof tagKind>;
+export declare const contentType: {
+    readonly OVERVIEW: 'overview';
+    readonly GROUP: 'group';
+    readonly ITEM: 'item';
+};
+export type ContentType = ObjectValues<typeof contentType>;
+export declare const itemVariant: {
+    readonly HTTP_ITEM: 'httpItem';
+    readonly SCHEMA: 'schema';
+    readonly CHANNEL: 'channel';
+    readonly CHANNEL_OPERATION: 'channelOperation';
+    readonly MESSAGE: 'message';
+    readonly QUERY: 'query';
+    readonly MUTATION: 'mutation';
+    readonly SUBSCRIPTION: 'subscription';
+    readonly DIRECTIVE: 'directive';
+    readonly OBJECT: 'object';
+    readonly INTERFACE: 'interface';
+    readonly INPUT: 'input';
+    readonly UNION: 'union';
+    readonly ENUM: 'enum';
+    readonly SCALAR: 'scalar';
+    readonly MARKDOWN: 'markdown';
+};
+export type ItemVariant = ObjectValues<typeof itemVariant>;
+export declare const securitySchemeType: {
+    readonly API_KEY: 'apiKey';
+    readonly HTTP: 'http';
+    readonly OAUTH2: 'oauth2';
+    readonly OPEN_ID_CONNECT: 'openIdConnect';
+    readonly MUTUAL_TLS: 'mutualTLS';
+};
+export type SecuritySchemeType = ObjectValues<typeof securitySchemeType>;
+export declare const securitySchemeIn: {
+    readonly QUERY: 'query';
+    readonly HEADER: 'header';
+    readonly COOKIE: 'cookie';
+    readonly QUERYSTRING: 'querystring';
+};
+export type SecuritySchemeIn = ObjectValues<typeof securitySchemeIn>;
+export declare const nodeTypes: {
+    readonly CONTAINER: 'container';
+    readonly HEADER: 'header';
+    readonly EMPTY_MESSAGE: 'empty-message';
+    readonly ITEM: 'item-content';
+    readonly SECURITY: 'security';
+    readonly MARKDOC: 'markdoc';
+    readonly ADMONITION: 'admonition';
+    readonly OVERVIEW_SECTION_WRAPPER: 'overview-section-wrapper';
+    readonly EXTERNAL_DOCS: 'external-docs';
+    readonly CHANNEL_ADDRESS: 'channel-address';
+    readonly MESSAGE_LINKS: 'message-links';
+    readonly INFO_METADATA: 'info-metadata';
+    readonly EXTENSIONS: 'extensions';
+    readonly FEEDBACK: 'feedback';
+};
+export type NodeTypes = ObjectValues<typeof nodeTypes>;
+export declare const panelKind: {
+    readonly LOCATIONS: 'locations';
+    readonly GROUP_ITEMS: 'group-items';
+    readonly EXTERNAL_LINK: 'externallink';
+    readonly EMAIL: 'email';
+    readonly PAYLOAD: 'payload';
+    readonly TAGS: 'tags';
+    readonly CONNECT_MCP_BUTTON: 'connect-mcp-button';
+    readonly ATTRIBUTE: 'attribute';
+    readonly DOWNLOAD: 'download';
+    readonly SERVERS: 'servers';
+    readonly BROKERS: 'brokers';
+    readonly CHANNEL_BINDING: 'channel-binding';
+    readonly OPERATION_BINDING: 'operation-binding';
+    readonly MESSAGE_BINDING: 'message-binding';
+    readonly MESSAGE_REFERENCES: 'message-references';
+    readonly LANGUAGES: 'languages';
+    readonly REFERENCES: 'references';
+    readonly REPLAY: 'replay';
+    readonly CODE_SAMPLE: 'code-sample';
+    readonly CALLBACK_PAYLOAD: 'callback-payload';
+    readonly RESPONSE: 'response';
+    readonly GRAPHQL_QUERY: 'graphql-query';
+    readonly GRAPHQL_RESPONSE: 'graphql-response';
+    readonly GRAPHQL_VARIABLES: 'graphql-variables';
+    readonly GRAPHQL_TYPE_SAMPLE: 'graphql-type-sample';
+    readonly MCP_EXAMPLE: 'mcp-example';
+};
+export type PanelKind = ObjectValues<typeof panelKind>;
+export declare const schemaKind: {
+    readonly JSON_SCHEMA: 'json-schema';
+    readonly GRAPHQL_TYPE: 'graphql-type';
+};
+export type SchemaKind = ObjectValues<typeof schemaKind>;
+/** A logo as authored, keyed by `url`: OpenAPI `info.x-logo` and the standalone `logo` prop. */
+export type RawLogo = {
+    url?: string;
+    href?: string;
+    altText?: string;
+    backgroundColor?: string;
+};
+/**
+ * A logo normalized to what the `SidebarLogo` component renders, keyed by `imageUrl`.
+ * Also the shape of the `apiLogo` option, which is authored this way already.
+ */
+export type SidebarLogo = {
+    imageUrl?: string;
+    href?: string;
+    altText?: string;
+    backgroundColor?: string;
+};