@redocly/openapi-docs 3.15.0-next.2 → 3.15.0-next.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,3 @@
1
1
  import type { PropsWithChildren } from 'react';
2
2
  import type { RedoclyOpenAPIDocsProps } from './types.js';
3
- export declare function RedoclyOpenAPIDocs({ onLoaded, children, store, withCommonStyles, router, disableTelemetry, }: PropsWithChildren<Partial<RedoclyOpenAPIDocsProps>>): import("react/jsx-runtime").JSX.Element | null;
3
+ export declare function RedoclyOpenAPIDocs({ onLoaded, children, store, withCommonStyles, router, }: PropsWithChildren<Partial<RedoclyOpenAPIDocsProps>>): import("react/jsx-runtime").JSX.Element | null;
@@ -1 +1 @@
1
- import{jsx as o,jsxs as m,Fragment as x}from"react/jsx-runtime";import{memo as C,useRef as E}from"react";import{LayoutVariant as d}from"@redocly/config";import{useSetAtom as w}from"jotai";import{ThreePanelLayout as A}from"@redocly/theme/layouts/ThreePanelLayout";import{SidebarLogo as I}from"@redocly/theme/components/SidebarLogo/SidebarLogo";import{GlobalStyle as j,useMount as D}from"@redocly/theme/core/openapi";import{StoreProvider as M}from"./Providers.js";import{Overlay as N}from"../Overlay.js";import{RedocWrap as _}from"./styled.js";import{StickyResponsiveSidebar as V}from"../StickySidebar/index.js";import{SideMenu as k}from"../SideMenu/index.js";import{Content as v}from"../Content/index.js";import{useContentItems as B,useUppercase2LowercaseRedirect as K,useTelemetry as F,usePerformanceMetrics as H}from"../../hooks/index.js";import{withRouter as U}from"../../hoc/withRouter.js";import{withStore as Y}from"../../hoc/withStore.js";import{compose as G}from"../../utils/index.js";import{useLicense as W}from"../../hooks/useLicense.js";import{allOperationsAtom as q}from"../../jotai/replay.js";const z=G(U,Y,C)(({licenseKey:a,onLoaded:c,children:e,options:t,layout:i,collapsedSidebar:n,parser:l,withCommonStyles:y})=>{const b=E(null),{isValid:f,licenseInfo:g}=W(a),R=w(q),u=F();K();const{contentItems:h,flatItems:S}=B({parser:l,options:t});H({sendTelemetry:p=>{const r=Object.fromEntries(Object.entries(p).map(([O,T])=>[O.toLowerCase(),T]));u.sendOpenapiDocsPerformanceMetricsMessage({cls:r.cls,lcp:r.lcp,fcp:r.fcp,ttfb:r.ttfb})}}),D(()=>{if(c?.(),u.sendOpenapiDocsViewedMessage({layout:i}),!t.hideReplay){const p=S.filter(r=>r.type==="operation");R(p)}});const{hideSidebar:P,scrollYOffset:L}=t||{},s=l.definition?.info?.["x-logo"];return m(x,{children:[y&&o(j,{}),m(_,{className:"redoc-wrap",ref:b,children:[!f&&o(N,{licenseInfo:g}),!P&&m(V,{scrollYOffset:L,className:"menu-content",collapsedSidebar:!n,children:[o(I,{imageUrl:s?.url,href:s?.href||l.definition?.info?.contact?.url,altText:s?.altText,backgroundColor:s?.backgroundColor}),o(k,{items:f?h:[]})]}),m(A,{className:"api-content",id:"api-content",layout:i===d.THREE_PANEL?d.THREE_PANEL:d.STACKED,collapsedSidebar:n,children:[o(v,{items:f?h:[],routingBasePath:t.routingBasePath}),e]})]})]})});function ue({onLoaded:a,children:c,store:e,withCommonStyles:t,router:i,disableTelemetry:n}){return e?.definition?o(M,{...e,children:o(z,{onLoaded:a,basePath:e.options?.routingBasePath,licenseKey:e.options?.licenseKey,disableRouter:e.options?.disableRouter,withCommonStyles:t,router:i,disableTelemetry:n,children:c})}):null}export{ue as RedoclyOpenAPIDocs};
1
+ import{jsx as o,jsxs as s,Fragment as C}from"react/jsx-runtime";import{memo as E,useRef as T}from"react";import{LayoutVariant as p}from"@redocly/config";import{useSetAtom as w}from"jotai";import{ThreePanelLayout as A}from"@redocly/theme/layouts/ThreePanelLayout";import{SidebarLogo as I}from"@redocly/theme/components/SidebarLogo/SidebarLogo";import{GlobalStyle as j,useMount as D}from"@redocly/theme/core/openapi";import{StoreProvider as M}from"./Providers.js";import{Overlay as N}from"../Overlay.js";import{RedocWrap as _}from"./styled.js";import{StickyResponsiveSidebar as V}from"../StickySidebar/index.js";import{SideMenu as k}from"../SideMenu/index.js";import{Content as v}from"../Content/index.js";import{useContentItems as B,useUppercase2LowercaseRedirect as K,useTelemetry as F,usePerformanceMetrics as H}from"../../hooks/index.js";import{withRouter as U}from"../../hoc/withRouter.js";import{withStore as Y}from"../../hoc/withStore.js";import{compose as G}from"../../utils/index.js";import{useLicense as W}from"../../hooks/useLicense.js";import{allOperationsAtom as q}from"../../jotai/replay.js";const z=G(U,Y,E)(({licenseKey:m,onLoaded:a,children:e,options:t,layout:i,collapsedSidebar:d,parser:c,withCommonStyles:y})=>{const b=T(null),{isValid:l,licenseInfo:g}=W(m),R=w(q),u=F();K();const{contentItems:h,flatItems:S}=B({parser:c,options:t});H({sendTelemetry:f=>{const r=Object.fromEntries(Object.entries(f).map(([O,x])=>[O.toLowerCase(),x]));u.sendOpenapiDocsPerformanceMetricsMessage({cls:r.cls,lcp:r.lcp,fcp:r.fcp,ttfb:r.ttfb})}}),D(()=>{if(a?.(),u.sendOpenapiDocsViewedMessage({layout:i}),!t.hideReplay){const f=S.filter(r=>r.type==="operation");R(f)}});const{hideSidebar:P,scrollYOffset:L}=t||{},n=c.definition?.info?.["x-logo"];return s(C,{children:[y&&o(j,{}),s(_,{className:"redoc-wrap",ref:b,children:[!l&&o(N,{licenseInfo:g}),!P&&s(V,{scrollYOffset:L,className:"menu-content",collapsedSidebar:!d,children:[o(I,{imageUrl:n?.url,href:n?.href||c.definition?.info?.contact?.url,altText:n?.altText,backgroundColor:n?.backgroundColor}),o(k,{items:l?h:[]})]}),s(A,{className:"api-content",id:"api-content",layout:i===p.THREE_PANEL?p.THREE_PANEL:p.STACKED,collapsedSidebar:d,children:[o(v,{items:l?h:[],routingBasePath:t.routingBasePath}),e]})]})]})});function ue({onLoaded:m,children:a,store:e,withCommonStyles:t,router:i}){return e?.definition?o(M,{...e,children:o(z,{onLoaded:m,basePath:e.options?.routingBasePath,licenseKey:e.options?.licenseKey,disableRouter:e.options?.disableRouter,withCommonStyles:t,router:i,children:a})}):null}export{ue as RedoclyOpenAPIDocs};
@@ -9,7 +9,6 @@ export interface RedoclyOpenAPIDocsProps extends RoutingProps, StoreProps {
9
9
  store?: StoreProviderProps;
10
10
  licenseKey?: string;
11
11
  withCommonStyles?: boolean;
12
- disableTelemetry?: boolean;
13
12
  }
14
13
  export interface StoreProviderProps {
15
14
  options?: RedocConfig;
@@ -3,6 +3,6 @@ export { useRouter } from './useRouter.js';
3
3
  export { useContentItems } from './useContentItems.js';
4
4
  export { useActiveWithFallback } from './useActiveWithFallback.js';
5
5
  export { useTranslate } from './useTranslate.js';
6
- export { useUppercase2LowercaseRedirect } from './useUppercase2LowercaseRedirect.js';
7
6
  export { useTelemetry } from './useTelemetry.js';
7
+ export { useUppercase2LowercaseRedirect } from './useUppercase2LowercaseRedirect.js';
8
8
  export { usePerformanceMetrics } from './usePerformanceMetrics.js';
@@ -1 +1 @@
1
- import{useActivateExample as o}from"./useActivateExample.js";import{useRouter as s}from"./useRouter.js";import{useContentItems as p}from"./useContentItems.js";import{useActiveWithFallback as f}from"./useActiveWithFallback.js";import{useTranslate as x}from"./useTranslate.js";import{useUppercase2LowercaseRedirect as i}from"./useUppercase2LowercaseRedirect.js";import{useTelemetry as n}from"./useTelemetry.js";import{usePerformanceMetrics as A}from"./usePerformanceMetrics.js";export{o as useActivateExample,f as useActiveWithFallback,p as useContentItems,A as usePerformanceMetrics,s as useRouter,n as useTelemetry,x as useTranslate,i as useUppercase2LowercaseRedirect};
1
+ import{useActivateExample as o}from"./useActivateExample.js";import{useRouter as s}from"./useRouter.js";import{useContentItems as p}from"./useContentItems.js";import{useActiveWithFallback as f}from"./useActiveWithFallback.js";import{useTranslate as x}from"./useTranslate.js";import{useTelemetry as i}from"./useTelemetry.js";import{useUppercase2LowercaseRedirect as n}from"./useUppercase2LowercaseRedirect.js";import{usePerformanceMetrics as A}from"./usePerformanceMetrics.js";export{o as useActivateExample,f as useActiveWithFallback,p as useContentItems,A as usePerformanceMetrics,s as useRouter,i as useTelemetry,x as useTranslate,n as useUppercase2LowercaseRedirect};
@@ -3,7 +3,7 @@ import type { OpenAPIDefinition } from './types/open-api.js';
3
3
  import type { StoreProviderProps } from './components/RedoclyOpenAPIDocs/types.js';
4
4
  export { setSecurityDetails, setSecurityDetailsVariants } from './utils/security-details.js';
5
5
  export { setParameterValue } from './utils/parameters.js';
6
- export declare function hydrate(store: StoreProviderProps, element?: Element | null, disableTelemetry?: boolean): void;
6
+ export declare function hydrate(store: StoreProviderProps, element?: Element | null): void;
7
7
  export declare function init(definitionOrDefinitionUrl: string | OpenAPIDefinition, options?: RedocConfig & {
8
8
  router?: 'hash' | 'history';
9
9
  disableTelemetry?: boolean;
package/lib/standalone.js CHANGED
@@ -1 +1 @@
1
- import{jsx as l}from"react/jsx-runtime";import{createElement as p}from"react";import{createRoot as m,hydrateRoot as u}from"react-dom/client";import{querySelector as i}from"./utils/dom.js";import{RedoclyOpenAPIDocs as d}from"./components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js";import{RedoclyOpenAPIDocsStandalone as f}from"./components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsStandalone.js";import{setSecurityDetails as V,setSecurityDetailsVariants as j}from"./utils/security-details.js";import{setParameterValue as F}from"./utils/parameters.js";function E(e){const r={},t=e.attributes;for(let o=0;o<t.length;o++){const s=t[o];r[s.name]=s.value}return r}function _(e){const r=E(e),t={};for(const o in r){const s=o.replace(/-(.)/g,(a,n)=>n.toUpperCase());t[s]=r[o]}return t}function N(e,r=document.querySelector("redoc"),t){u(r,l(d,{store:e,disableTelemetry:t}),{onRecoverableError:(o,s)=>{o.message.includes("Minified React error #418")||console.error(o.message,s)}})}function y(e,r={},t=i("redoc")){if(t===null)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');const{router:o,disableTelemetry:s,...a}={...r,..._(t)};let n,c;typeof e=="string"?n=e:typeof e=="object"&&(c=e),m(t).render(p(f,{definition:c,definitionUrl:n,disableTelemetry:s,options:a,router:o??"hash"},["Loading..."]))}const v=__REDOCLY_API_REFERENCE_VERSION__,C=__REDOCLY_API_REFERENCE_REVISION__;function R(){const e=i("redoc");if(!e)return;const r=e.getAttribute("spec-url");if(r){const t=e.getAttribute("disable-telemetry")==="true";y(r,{disableTelemetry:t},e)}}R();export{N as hydrate,y as init,C as revision,F as setParameterValue,V as setSecurityDetails,j as setSecurityDetailsVariants,v as version};
1
+ import{jsx as p}from"react/jsx-runtime";import{createElement as l}from"react";import{createRoot as u,hydrateRoot as m}from"react-dom/client";import{querySelector as i}from"./utils/dom.js";import{RedoclyOpenAPIDocs as f}from"./components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocs.js";import{RedoclyOpenAPIDocsStandalone as d}from"./components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsStandalone.js";import{setSecurityDetails as V,setSecurityDetailsVariants as j}from"./utils/security-details.js";import{setParameterValue as F}from"./utils/parameters.js";function E(e){const o={},t=e.attributes;for(let r=0;r<t.length;r++){const s=t[r];o[s.name]=s.value}return o}function _(e){const o=E(e),t={};for(const r in o){const s=r.replace(/-(.)/g,(a,n)=>n.toUpperCase());t[s]=o[r]}return t}function N(e,o=document.querySelector("redoc")){m(o,p(f,{store:e}),{onRecoverableError:(t,r)=>{t.message.includes("Minified React error #418")||console.error(t.message,r)}})}function R(e,o={},t=i("redoc")){if(t===null)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');const{router:r,disableTelemetry:s,...a}={...o,..._(t)};let n,c;typeof e=="string"?n=e:typeof e=="object"&&(c=e),u(t).render(l(d,{definition:c,definitionUrl:n,disableTelemetry:s,options:a,router:r??"hash"},["Loading..."]))}const v=__REDOCLY_API_REFERENCE_VERSION__,C=__REDOCLY_API_REFERENCE_REVISION__;function y(){const e=i("redoc");if(!e)return;const o=e.getAttribute("spec-url");if(o){const t=e.getAttribute("disable-telemetry")==="true";R(o,{disableTelemetry:t},e)}}y();export{N as hydrate,R as init,C as revision,F as setParameterValue,V as setSecurityDetails,j as setSecurityDetailsVariants,v as version};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/openapi-docs",
3
- "version": "3.15.0-next.2",
3
+ "version": "3.15.0-next.3",
4
4
  "description": "Redocly OpenAPI Docs",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -27,7 +27,7 @@
27
27
  "fast-deep-equal": "^3.1.3",
28
28
  "jotai": "^2.12.5",
29
29
  "json-pointer": "^0.6.2",
30
- "openapi-sampler": "^1.6.1",
30
+ "openapi-sampler": "1.6.2",
31
31
  "react-router-dom": "^6.21.1",
32
32
  "slugify": "^1.4.4",
33
33
  "stringify-object": "^3.3.0",
@@ -37,7 +37,7 @@
37
37
  "util": "~0.12.5",
38
38
  "web-vitals": "3.3.1",
39
39
  "@redocly/config": "0.36.0",
40
- "@redocly/replay": "0.18.0-next.2"
40
+ "@redocly/replay": "0.18.0-next.3"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@jest/globals": "29.5.0",
@@ -75,7 +75,7 @@
75
75
  "typescript": "5.9.3",
76
76
  "url": "~0.11.0",
77
77
  "vite": "7.1.9",
78
- "@redocly/theme": "0.59.0-next.1"
78
+ "@redocly/theme": "0.59.0-next.2"
79
79
  },
80
80
  "scripts": {
81
81
  "start": "npm run copy-highlight-hook && vite",