@redocly/openapi-docs 3.12.0-next.6 → 3.12.0-next.7

package/lib/components/Replay/EmbeddedReplay.js

@@ -1,9 +1,9 @@
-import{jsx as e}from"react/jsx-runtime";import{Suspense as y,lazy as h,memo as S,useEffect as x,useState as E}from"react";import{useAtomValue as o}from"jotai";import{globalOptionsAtom as O}from"../../jotai/store.js";import{operationStore as R}from"../../jotai/operation.js";import{appStore as L,environmentsAtom as T}from"../../jotai/app.js";import{useTranslate as V}from"../../hooks/index.js";import{convertOperationToReplayValue as j}from"./utils.js";import{styled as i}from"../../styled-components.js";const A=h(async()=>import("@redocly/replay").then(t=>({default:t.EmbeddedReplay})));function C({activeOperationId:t,corsProxyUrl:p,fullOpenApi:s,pointer:r}){const n=V(),{mockServer:m}=o(O),l=o(R(r)),a=o(L),c=o(T),[f,u]=E(!1);return x(()=>{u(!0)},[]),e(k,{children:f?e(y,{fallback:e(d,{children:n("openapi.loading","Loading...")}),children:e(A,{activeOperationId:t,activeOperationPointer:r,api:s,settings:{environment:a.environment,predefinedEnvValues:c,corsProxyUrl:p,mockServer:m,disableCollectionsTab:!0,convertOperationToReplayValue:(v,b,g)=>j(v,b,g,void 0,l,a)}})}):e(d,{children:n("openapi.loading","Loading...")})})}const F=S(C),d=i.div`
+import{jsx as e}from"react/jsx-runtime";import{Suspense as b,lazy as h,memo as S,useEffect as x,useState as E}from"react";import{useAtomValue as o}from"jotai";import{globalOptionsAtom as O}from"../../jotai/store.js";import{operationStore as R}from"../../jotai/operation.js";import{appStore as C,environmentsAtom as L}from"../../jotai/app.js";import{useTranslate as T}from"../../hooks/index.js";import{convertOperationToReplayValue as V}from"./utils.js";import{getDefaultCollectorUrl as j}from"../../utils/telemetry.js";import{styled as i}from"../../styled-components.js";const A=h(async()=>import("@redocly/replay").then(r=>({default:r.EmbeddedReplay})));function k({activeOperationId:r,corsProxyUrl:d,fullOpenApi:l,pointer:t}){const n=T(),{mockServer:m}=o(O),s=o(R(t)),a=o(C),c=o(L),[f,u]=E(!1);return x(()=>{u(!0)},[]),e(U,{children:f?e(b,{fallback:e(p,{children:n("openapi.loading","Loading...")}),children:e(A,{activeOperationId:r,activeOperationPointer:t,api:l,settings:{environment:a.environment,predefinedEnvValues:c,corsProxyUrl:d,mockServer:m,disableCollectionsTab:!0,telemetry:{tracerName:"replay-openapi",collectorUrl:j()},convertOperationToReplayValue:(v,y,g)=>V(v,y,g,void 0,s,a)}})}):e(p,{children:n("openapi.loading","Loading...")})})}const F=S(k),p=i.div`
   display: flex;
   justify-content: center;
   align-items: center;
   min-height: 100px;
-`,k=i.div`
+`,U=i.div`
   border: 1px solid var(--border-color-primary);
   border-radius: var(--border-radius-lg);
   padding: 0;

package/lib/components/Replay/Replay.js

@@ -1 +1 @@
-import{jsx as n,Fragment as F,jsxs as U}from"react/jsx-runtime";import{lazy as B,memo as z,Suspense as J,useCallback as u,useRef as K,useState as M}from"react";import{Button as w,CircleDashIcon as H,Portal as Q,RocketIcon as W,useFocusTrap as X,useModalScrollLock as Y}from"@redocly/theme";import{useAtom as d,useAtomValue as p}from"jotai";import Z from"deepmerge";const $=B(async()=>import("@redocly/replay").then(t=>({default:t.ReplayOverlay})));import{globalOptionsAtom as ee,globalStoreAtom as te}from"../../jotai/store.js";import{allOperationsAtom as oe,replayStateAtom as ne}from"../../jotai/replay.js";import{allOperations as re,getDefaultOperationStore as ae}from"../../jotai/operation.js";import{LOADING_STATE as a}from"../../constants.js";import{environmentAtom as se,userClaimsAtom as ie}from"../../jotai/app.js";import{convertOperationToReplayValueForRedoc as le}from"./utils.js";import{useTranslate as me,useTelemetry as pe}from"../../hooks/index.js";import{JsonPointer as ce}from"../../utils/index.js";import{createTryItOpenEvent as ue,createTryItSentEvent as de}from"../../events/index.js";function ye({operation:t,corsProxyUrl:D,fullOpenApi:y}){const f=me(),L=pe(),O=K(null),{mockServer:b,oAuth2RedirectURI:C,routingBasePath:c}=p(ee),I=p(oe),{parser:P,options:{events:s}}=p(te),E=p(ie),[l,N]=M(!1),[m,h]=d(ne),[g,v]=d(re),[[,V],A]=d(se);X(O),Y(l);const _=u(({operations:e,environment:o,environments:i})=>{const j=e.reduce((S,r)=>{r.requestValues.body=r.requestValues.body instanceof URLSearchParams?Object.fromEntries(r.requestValues.body.entries()):r.requestValues.body;const{path:k,method:G}=r.apiPath,T=ce.compile(["paths",k,G]);return S[T]=Z(ae(T),r),S},{});v({...g,...j}),A({environment:o,environments:i})},[g,v,A]),R=()=>{if(m!==a.LOADING){if(!l&&(L.send({type:"openapi_docs.try_it.opened"}),s?.tryItOpen&&t)){const e=ue({operation:t});s.tryItOpen(e)}N(!l)}m===a.NOT_LOADED&&h(a.LOADING)},q=u(e=>{if(s?.tryItSent&&t){const o=de({operation:t,isSuccess:e});s.tryItSent(o)}},[s,t]),x=u(e=>{if(!e)return;const o=I.find(i=>i.operationId===e);return c+o?.href},[I,c]);return y?U(F,{children:[n(w,{onClick:R,variant:"primary",iconPosition:"left",icon:m===a.LOADING?n(H,{}):n(W,{}),children:m===a.LOADING?f("openapi.loading","Loading..."):f("openapi.tryIt","Try it")}),l&&n(J,{children:n(Q,{mountId:"api-content",children:n("div",{ref:O,children:n($,{activeOperationId:t.operationId||t.pointer,api:y,onRequestChange:_,onClose:R,onLoad:()=>h(a.LOADED),settings:{corsProxyUrl:D,mockServer:b,environment:V,apiId:P?.definition.info?.["x-metadata"]?.apiId,oAuth2RedirectURI:C,disableCollectionsTab:!0,storageKey:c,convertOperationToReplayValue:(e,o,i)=>le(E)(e,o,i),getOperationUrl:x},onRequestSent:q})})})})]}):null}const Pe=z(ye);export{Pe as Replay};
+import{jsx as r,Fragment as U,jsxs as F}from"react/jsx-runtime";import{lazy as B,memo as z,Suspense as J,useCallback as u,useRef as K,useState as M}from"react";import{Button as w,CircleDashIcon as H,Portal as Q,RocketIcon as W,useFocusTrap as X,useModalScrollLock as Y}from"@redocly/theme";import{useAtom as d,useAtomValue as c}from"jotai";import Z from"deepmerge";const $=B(async()=>import("@redocly/replay").then(t=>({default:t.ReplayOverlay})));import{globalOptionsAtom as ee,globalStoreAtom as te}from"../../jotai/store.js";import{allOperationsAtom as oe,replayStateAtom as re}from"../../jotai/replay.js";import{allOperations as ne,getDefaultOperationStore as ae}from"../../jotai/operation.js";import{LOADING_STATE as a}from"../../constants.js";import{environmentAtom as se,userClaimsAtom as ie}from"../../jotai/app.js";import{convertOperationToReplayValueForRedoc as le}from"./utils.js";import{useTranslate as me,useTelemetry as ce}from"../../hooks/index.js";import{JsonPointer as pe}from"../../utils/index.js";import{getDefaultCollectorUrl as ue}from"../../utils/telemetry.js";import{createTryItOpenEvent as de,createTryItSentEvent as ye}from"../../events/index.js";function fe({operation:t,corsProxyUrl:D,fullOpenApi:y}){const f=me(),C=ce(),O=K(null),{mockServer:L,oAuth2RedirectURI:b,routingBasePath:p}=c(ee),I=c(oe),{parser:P,options:{events:s}}=c(te),N=c(ie),[l,E]=M(!1),[m,h]=d(re),[g,v]=d(ne),[[,V],A]=d(se);X(O),Y(l);const _=u(({operations:e,environment:o,environments:i})=>{const j=e.reduce((S,n)=>{n.requestValues.body=n.requestValues.body instanceof URLSearchParams?Object.fromEntries(n.requestValues.body.entries()):n.requestValues.body;const{path:k,method:G}=n.apiPath,T=pe.compile(["paths",k,G]);return S[T]=Z(ae(T),n),S},{});v({...g,...j}),A({environment:o,environments:i})},[g,v,A]),R=()=>{if(m!==a.LOADING){if(!l&&(C.send({type:"openapi_docs.try_it.opened"}),s?.tryItOpen&&t)){const e=de({operation:t});s.tryItOpen(e)}E(!l)}m===a.NOT_LOADED&&h(a.LOADING)},q=u(e=>{if(s?.tryItSent&&t){const o=ye({operation:t,isSuccess:e});s.tryItSent(o)}},[s,t]),x=u(e=>{if(!e)return;const o=I.find(i=>i.operationId===e);return p+o?.href},[I,p]);return y?F(U,{children:[r(w,{onClick:R,variant:"primary",iconPosition:"left",icon:m===a.LOADING?r(H,{}):r(W,{}),children:m===a.LOADING?f("openapi.loading","Loading..."):f("openapi.tryIt","Try it")}),l&&r(J,{children:r(Q,{mountId:"api-content",children:r("div",{ref:O,children:r($,{activeOperationId:t.operationId||t.pointer,api:y,onRequestChange:_,onClose:R,onLoad:()=>h(a.LOADED),settings:{corsProxyUrl:D,mockServer:L,environment:V,apiId:P?.definition.info?.["x-metadata"]?.apiId,oAuth2RedirectURI:b,disableCollectionsTab:!0,storageKey:p,telemetry:{tracerName:"try-it",collectorUrl:ue()},convertOperationToReplayValue:(e,o,i)=>le(N)(e,o,i),getOperationUrl:x},onRequestSent:q})})})})]}):null}const Ee=z(fe);export{Ee as Replay};

package/lib/services/code-samples/httpsnippet/index.js

@@ -1 +1 @@
-import{normalizeMimeType as m,unescapeServerVariables as p}from"../../utils.js";import{MediaTypes as s}from"../../../constants.js";import e from"./targets/index.js";import c from"./helpers/reducer.js";import{queryString as b}from"../../../utils/index.js";import{urlParse as h}from"../../../utils/url.js";class g{request;constructor(a){const r={...a};this.request=this.prepare({...r,httpVersion:r.httpVersion||"HTTP/1.1",queryString:r.queryString||[],headers:r.headers||[],cookies:r.cookies||[],postData:r.postData?{...r.postData,jsonObj:void 0,paramsObj:void 0}:void 0,bodySize:0,headersSize:0,queryObj:{},headersObj:{},cookiesObj:{},allHeaders:{},uriObj:{},fullUrl:"",pathParameters:r.pathParameters||{},serverVariables:r.serverVariables||{}})}prepare(a){if(a.queryString&&a.queryString.length&&(a.queryObj=a.queryString.reduce(c,{})),a.headers&&a.headers.length){const i=/^HTTP\/2/;a.headersObj=a.headers.reduce(function(t,o){let n=o.name;return a.httpVersion.match(i)&&(n=n.toLowerCase()),t[n]=o.value,t},{})}a.cookies&&a.cookies.length&&(a.cookiesObj=a.cookies.reduceRight(function(i,t){return i[t.name]=t.value,i},{}));const r=a.cookies.map(function(i){return encodeURIComponent(i.name)+"="+encodeURIComponent(i.value)});if(r.length&&(a.allHeaders.cookie=r.join("; ")),a.postData)switch(m(a.postData.mimeType)){case"multipart/mixed":case"multipart/related":case s.MULTIPART:case"multipart/alternative":break;case s.URL_ENCODED:a.postData?.params?(a.postData.paramsObj=a.postData.params.reduce(c,{}),a.postData.text=b.stringify(a.postData.paramsObj)):a.postData.text="";break;case"text/json":case"text/x-json":case s.JSON:case"application/x-json":if(a.postData.text)try{a.postData.jsonObj=JSON.parse(a.postData.text)}catch{a.postData.mimeType="text/plain"}break}if(a.allHeaders=Object.assign(a.allHeaders,a.headersObj),a.uriObj=h(a.url,!0),!a.uriObj)return{...a,uriObj:{protocol:"",path:"",queryObj:{},query:{}}};if(a.queryObj)for(const[i,t]of Object.entries(a.queryObj))a.uriObj.searchParams.has(i,t)||a.uriObj.searchParams.set(i,t);return a.uriObj.query=Object.fromEntries(a.uriObj.searchParams.entries()),a.queryObj=a.uriObj.query,a.uriObj.path=a.uriObj.pathname=p(a.uriObj.pathname),a.url=p(a.uriObj.toString()),a.uriObj.search&&(a.uriObj.path=a.uriObj.pathname+"?"+a.uriObj.search),a.fullUrl=p(a.uriObj.toString()),a}convert(a,r,i){!i&&r&&(i=r);const t=this._matchTarget(a,r);if(t){const o=t(this.request,i,{target:a,client:r});return o.length===1?o[0]:o}throw new Error("Cannot match target")}_matchTarget(a,r){return Object.prototype.hasOwnProperty.call(e,a)?typeof r=="string"&&typeof e[a][r]=="function"?e[a][r]:e[a][e[a].info.default]:!1}}export{g as HTTPSnippet};
+import{normalizeMimeType as b,unescapeServerVariables as p}from"../../utils.js";import{MediaTypes as s}from"../../../constants.js";import e from"./targets/index.js";import m from"./helpers/reducer.js";import{queryString as h}from"../../../utils/index.js";import{urlParse as j}from"../../../utils/url.js";class D{request;constructor(a){const r={...a};this.request=this.prepare({...r,httpVersion:r.httpVersion||"HTTP/1.1",queryString:r.queryString||[],headers:r.headers||[],cookies:r.cookies||[],postData:r.postData?{...r.postData,jsonObj:void 0,paramsObj:void 0}:void 0,bodySize:0,headersSize:0,queryObj:{},headersObj:{},cookiesObj:{},allHeaders:{},uriObj:{},fullUrl:"",pathParameters:r.pathParameters||{},serverVariables:r.serverVariables||{}})}prepare(a){if(a.queryString&&a.queryString.length&&(a.queryObj=a.queryString.reduce(m,{})),a.headers&&a.headers.length){const i=/^HTTP\/2/;a.headersObj=a.headers.reduce(function(t,c){let n=c.name;return a.httpVersion.match(i)&&(n=n.toLowerCase()),t[n]=c.value,t},{})}a.cookies&&a.cookies.length&&(a.cookiesObj=a.cookies.reduceRight(function(i,t){return i[t.name]=t.value,i},{}));const r=a.cookies.map(function(i){return encodeURIComponent(i.name)+"="+encodeURIComponent(i.value)});if(r.length&&(a.allHeaders.cookie=r.join("; ")),a.postData)switch(b(a.postData.mimeType)){case"multipart/mixed":case"multipart/related":case s.MULTIPART:case"multipart/alternative":break;case s.URL_ENCODED:a.postData?.params?(a.postData.paramsObj=a.postData.params.reduce(m,{}),a.postData.text=h.stringify(a.postData.paramsObj)):a.postData.text="";break;case"text/json":case"text/x-json":case s.JSON:case"application/x-json":if(a.postData.text)try{a.postData.jsonObj=JSON.parse(a.postData.text)}catch{a.postData.mimeType="text/plain"}break}if(a.allHeaders=Object.assign(a.allHeaders,a.headersObj),a.uriObj=j(a.url,!0),!a.uriObj)return{...a,uriObj:{protocol:"",path:"",queryObj:{},query:{}}};if(a.queryObj)for(const[i,t]of Object.entries(a.queryObj))a.uriObj.searchParams.has(i,t)||a.uriObj.searchParams.set(i,t);a.uriObj.query=Object.fromEntries(a.uriObj.searchParams.entries()),a.queryObj=a.uriObj.query,a.uriObj.path=a.uriObj.pathname=p(a.uriObj.pathname);const o=new URL(a.uriObj.toString());return o.search="",a.url=p(o.toString()),a.uriObj.search&&(a.uriObj.path=a.uriObj.pathname+"?"+a.uriObj.search),a.fullUrl=p(a.uriObj.toString()),a}convert(a,r,o){!o&&r&&(o=r);const i=this._matchTarget(a,r);if(i){const t=i(this.request,o,{target:a,client:r});return t.length===1?t[0]:t}throw new Error("Cannot match target")}_matchTarget(a,r){return Object.prototype.hasOwnProperty.call(e,a)?typeof r=="string"&&typeof e[a][r]=="function"?e[a][r]:e[a][e[a].info.default]:!1}}export{D as HTTPSnippet};

package/lib/types/open-api.d.ts

@@ -222,9 +222,10 @@ export interface OpenAPIEncoding {
 export type OpenAPIParameterLocation = 'query' | 'header' | 'path' | 'cookie';
 export type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
 export interface OpenAPIRequestBody extends ParsedDescription {
+    $ref?: string;
     description?: string;
     required?: boolean;
-    content: {
+    content?: {
         [mime: string]: OpenAPIMediaType;
     };
     'x-examples'?: {
@@ -250,6 +251,7 @@ export interface OpenAPIResponse extends ParsedDescription {
     links?: {
         [name: string]: Referenced<OpenAPILink>;
     };
+    $ref?: string;
     'x-examples'?: {
         [mime: string]: {
             [name: string]: Referenced<OpenAPIExample>;

package/lib/utils/index.d.ts

@@ -21,3 +21,4 @@ export * from './isMobile.js';
 export * from './replaceVariables.js';
 export * from './areArraysEqual.js';
 export * from './configure-helpers.js';
+export * from './telemetry.js';

package/lib/utils/index.js

@@ -1 +1 @@
-export*from"./JsonPointer.js";export*from"./openapi.js";export*from"./helpers.js";export*from"./dom.js";export*from"./debug.js";export*from"./sort.js";export*from"./argValuesHelpers.js";export*from"./theme-helpers.js";export*from"./debounce.js";export*from"./security-details.js";export*from"./session-storage.js";export*from"./local-storage.js";export*from"./parameters.js";export*from"./string.js";export*from"./test-utils.js";export*from"./compose.js";export*from"./saveTextBeforeHeading.js";export*from"./path.js";export*from"./queryString.js";export*from"./isMobile.js";export*from"./replaceVariables.js";export*from"./areArraysEqual.js";export*from"./configure-helpers.js";
+export*from"./JsonPointer.js";export*from"./openapi.js";export*from"./helpers.js";export*from"./dom.js";export*from"./debug.js";export*from"./sort.js";export*from"./argValuesHelpers.js";export*from"./theme-helpers.js";export*from"./debounce.js";export*from"./security-details.js";export*from"./session-storage.js";export*from"./local-storage.js";export*from"./parameters.js";export*from"./string.js";export*from"./test-utils.js";export*from"./compose.js";export*from"./saveTextBeforeHeading.js";export*from"./path.js";export*from"./queryString.js";export*from"./isMobile.js";export*from"./replaceVariables.js";export*from"./areArraysEqual.js";export*from"./configure-helpers.js";export*from"./telemetry.js";

package/lib/utils/telemetry.d.ts

@@ -0,0 +1 @@
+export declare function getDefaultCollectorUrl(): string;

package/lib/utils/telemetry.js

@@ -0,0 +1 @@
+import{withPathPrefix as o}from"@redocly/theme";import{TELEMETRY_URLS as t}from"@redocly/shared";function i(){return process.env.NODE_ENV==="development"?t.OTEL_COLLECTOR_LOCAL:window.location.origin+o("/_otel")}export{i as getDefaultCollectorUrl};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-docs",
-  "version": "3.12.0-next.6",
+  "version": "3.12.0-next.7",
   "description": "Redocly OpenAPI Docs",
   "type": "module",
   "main": "lib/index.js",
@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "@markdoc/markdoc": "0.5.2",
-    "@redocly/openapi-core": "2.0.0-next.1",
+    "@redocly/openapi-core": "2.0.0-next.4",
     "deepmerge": "^4.2.2",
     "dompurify": "3.2.6",
     "fast-deep-equal": "^3.1.3",
@@ -37,7 +37,8 @@
     "util": "~0.12.5",
     "web-vitals": "3.3.1",
     "@redocly/config": "0.26.3",
-    "@redocly/replay": "0.15.0-next.3"
+    "@redocly/replay": "0.15.0-next.3",
+    "@redocly/shared": "1.3.1"
   },
   "devDependencies": {
     "@jest/globals": "29.5.0",