docusaurus-theme-openapi-docs 4.5.0 → 4.6.0

package/lib/theme/ApiExplorer/buildPostmanRequest.js

@@ -103,18 +103,10 @@ function setQueryParams(postman, queryParams) {
           });
         }
       }
-      const decodedValue = decodeURI(param.value);
-      const tryJson = () => {
-        try {
-          return JSON.parse(decodedValue);
-        } catch (e) {
-          return false;
-        }
-      };
-      const jsonResult = tryJson();
       // Handle object values
-      if (jsonResult && typeof jsonResult === "object") {
-        if (param.style === "deepObject") {
+      if (param.style === "deepObject") {
+        const jsonResult = tryDecodeJsonParam(param.value);
+        if (jsonResult && typeof jsonResult === "object") {
           return Object.entries(jsonResult).map(
             ([key, val]) =>
               new sdk.QueryParam({
@@ -122,7 +114,10 @@ function setQueryParams(postman, queryParams) {
                 value: String(val),
               })
           );
-        } else if (param.explode) {
+        }
+      } else if (param.explode) {
+        const jsonResult = tryDecodeJsonParam(param.value);
+        if (jsonResult && typeof jsonResult === "object") {
           return Object.entries(jsonResult).map(
             ([key, val]) =>
               new sdk.QueryParam({
@@ -139,16 +134,9 @@ function setQueryParams(postman, queryParams) {
           });
         }
       }
-      // Handle boolean values
-      if (typeof decodedValue === "boolean") {
-        return new sdk.QueryParam({
-          key: param.name,
-          value: decodedValue ? "true" : "false",
-        });
-      }
       // Parameter allows empty value: "/hello?extended"
       if (param.allowEmptyValue) {
-        if (decodedValue === "true") {
+        if (param.value === "true") {
           return new sdk.QueryParam({
             key: param.name,
             value: null,
@@ -188,16 +176,8 @@ function setPathParams(postman, pathParams) {
         value: serializedValue,
       });
     }
-    const decodedValue = decodeURI(param.value);
-    const tryJson = () => {
-      try {
-        return JSON.parse(decodedValue);
-      } catch (e) {
-        return false;
-      }
-    };
-    const jsonResult = tryJson();
-    if (typeof jsonResult === "object") {
+    const jsonResult = tryDecodeJsonParam(param.value);
+    if (jsonResult && typeof jsonResult === "object") {
       if (param.style === "matrix") {
         serializedValue = Object.entries(jsonResult)
           .map(([key, val]) => `;${key}=${val}`)
@@ -208,7 +188,7 @@ function setPathParams(postman, pathParams) {
           .join(",");
       }
     } else {
-      serializedValue = decodedValue || `:${param.name}`;
+      serializedValue = param.value;
     }
     return new sdk.Variable({
       key: param.name,
@@ -224,16 +204,8 @@ function buildCookie(cookieParams) {
   const cookies = cookieParams
     .map((param) => {
       if (param.value) {
-        const decodedValue = decodeURI(param.value);
-        const tryJson = () => {
-          try {
-            return JSON.parse(decodedValue);
-          } catch (e) {
-            return false;
-          }
-        };
-        const jsonResult = tryJson();
-        if (typeof jsonResult === "object") {
+        const jsonResult = tryDecodeJsonParam(param.value);
+        if (jsonResult && typeof jsonResult === "object") {
           if (param.style === "form") {
             // Handle form style
             if (param.explode) {
@@ -286,15 +258,9 @@ function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
   }
   headerParams.forEach((param) => {
     if (param.value) {
-      const decodedValue = decodeURI(param.value);
-      const tryJson = () => {
-        try {
-          return JSON.parse(decodedValue);
-        } catch (e) {
-          return false;
-        }
-      };
-      const jsonResult = tryJson();
+      const jsonResult = Array.isArray(param.value)
+        ? param.value.map(tryDecodeJsonParam)
+        : tryDecodeJsonParam(param.value);
       if (Array.isArray(param.value)) {
         if (param.style === "simple") {
           if (param.explode) {
@@ -340,6 +306,13 @@ function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
     postman.addHeader({ key: "Cookie", value: cookie });
   }
 }
+function tryDecodeJsonParam(value) {
+  try {
+    return JSON.parse(decodeURI(value));
+  } catch (e) {
+    return false;
+  }
+}
 // TODO: this is all a bit hacky
 function setBody(clonedPostman, body) {
   if (clonedPostman.body === undefined) {
@@ -358,7 +331,11 @@ function setBody(clonedPostman, body) {
   switch (clonedPostman.body.mode) {
     case "raw": {
       // check file even though it should already be set from above
-      if (body.type !== "raw" || body.content?.type === "file") {
+      if (
+        body.type !== "raw" ||
+        body.content?.type === "file" ||
+        body.content?.type === "file[]"
+      ) {
         clonedPostman.body = undefined;
         return;
       }
@@ -373,15 +350,23 @@ function setBody(clonedPostman, body) {
         clonedPostman.body.raw = `${body.content?.value}`;
         return;
       }
-      const params = Object.entries(body.content)
+      const params = [];
+      Object.entries(body.content)
         .filter((entry) => !!entry[1])
-        .map(([key, content]) => {
+        .forEach(([key, content]) => {
           if (content.type === "file") {
-            return new sdk.FormParam({ key: key, ...content });
+            params.push(new sdk.FormParam({ key: key, ...content }));
+          } else if (content.type === "file[]") {
+            content.value.forEach((file) =>
+              params.push(new sdk.FormParam({ key, value: file }))
+            );
+          } else {
+            params.push(new sdk.FormParam({ key: key, value: content.value }));
           }
-          return new sdk.FormParam({ key: key, value: content.value });
         });
-      clonedPostman.body.formdata?.assimilate(params, false);
+      params.forEach((param) => {
+        clonedPostman.body?.formdata?.add(param);
+      });
       return;
     }
     case "urlencoded": {
@@ -395,7 +380,11 @@ function setBody(clonedPostman, body) {
       const params = Object.entries(body.content)
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
-          if (content.type !== "file" && content.value) {
+          if (
+            content.type !== "file" &&
+            content.type !== "file[]" &&
+            content.value
+          ) {
             return new sdk.QueryParam({ key: key, value: content.value });
           }
           return undefined;

package/lib/theme/ApiExplorer/index.js

@@ -68,6 +68,7 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const client_1 = require("@docusaurus/plugin-content-docs/client");
 const CodeSnippets_1 = __importDefault(
   require("@theme/ApiExplorer/CodeSnippets")
 );
@@ -78,7 +79,15 @@ const SecuritySchemes_1 = __importDefault(
 );
 const sdk = __importStar(require("postman-collection"));
 function ApiExplorer({ item, infoPath }) {
-  const postman = new sdk.Request(item.postman ? item.postman.toJSON() : {});
+  const metadata = (0, client_1.useDoc)();
+  const { mask_credentials } = metadata.frontMatter;
+  const postman = new sdk.Request(
+    item.postman
+      ? sdk.Request.isRequest(item.postman)
+        ? item.postman.toJSON()
+        : item.postman
+      : {}
+  );
   return react_1.default.createElement(
     react_1.default.Fragment,
     null,
@@ -89,6 +98,7 @@ function ApiExplorer({ item, infoPath }) {
       react_1.default.createElement(CodeSnippets_1.default, {
         postman: postman,
         codeSamples: item["x-codeSamples"] ?? [],
+        maskCredentials: mask_credentials,
       }),
     react_1.default.createElement(Request_1.default, { item: item }),
     react_1.default.createElement(Response_1.default, { item: item })

package/lib/theme/ApiExplorer/persistenceMiddleware.d.ts

@@ -0,0 +1,19 @@
+import type { Middleware } from "@reduxjs/toolkit";
+import type { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
+export declare function createPersistenceMiddleware(options: ThemeConfig["api"]): Middleware<{}, {
+    accept: import("./Accept/slice").State;
+    contentType: import("./ContentType/slice").State;
+    response: import("./Response/slice").State;
+    server: import("./Server/slice").State;
+    body: import("./Body/slice").FormBody | import("./Body/slice").RawBody | import("./Body/slice").EmptyBody;
+    params: import("./ParamOptions/slice").State;
+    auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+}, import("redux-thunk").ThunkDispatch<{
+    accept: import("./Accept/slice").State;
+    contentType: import("./ContentType/slice").State;
+    response: import("./Response/slice").State;
+    server: import("./Server/slice").State;
+    body: import("./Body/slice").FormBody | import("./Body/slice").RawBody | import("./Body/slice").EmptyBody;
+    params: import("./ParamOptions/slice").State;
+    auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+}, undefined, import("redux").UnknownAction> & import("redux").Dispatch<import("redux").UnknownAction>>;

package/lib/theme/ApiExplorer/{persistanceMiddleware.js → persistenceMiddleware.js}

@@ -6,14 +6,16 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPersistanceMiddleware = createPersistanceMiddleware;
+exports.createPersistenceMiddleware = createPersistenceMiddleware;
 const slice_1 = require("@theme/ApiExplorer/Authorization/slice");
 const storage_utils_1 = require("./storage-utils");
-function createPersistanceMiddleware(options) {
-  const persistanceMiddleware = (storeAPI) => (next) => (action) => {
+function createPersistenceMiddleware(options) {
+  const persistenceMiddleware = (storeAPI) => (next) => (action) => {
     const result = next(action);
     const state = storeAPI.getState();
-    const storage = (0, storage_utils_1.createStorage)("sessionStorage");
+    const storage = (0, storage_utils_1.createStorage)(
+      options?.authPersistence ?? "sessionStorage"
+    );
     if (action.type === slice_1.setAuthData.type) {
       for (const [key, value] of Object.entries(state.auth.data)) {
         if (Object.values(value).filter(Boolean).length > 0) {
@@ -42,13 +44,18 @@ function createPersistanceMiddleware(options) {
       storage.setItem("server", action.payload);
     }
     if (action.type === "server/setServerVariable") {
-      const server = storage.getItem("server") ?? "{}";
+      const server = storage.getItem("server");
+      if (!server) {
+        return result;
+      }
       const variables = JSON.parse(action.payload);
-      let serverObject = JSON.parse(server);
-      serverObject.variables[variables.key].default = variables.value;
-      storage.setItem("server", JSON.stringify(serverObject));
+      const serverObject = JSON.parse(server) ?? {};
+      if (serverObject.variables?.[variables.key]) {
+        serverObject.variables[variables.key].default = variables.value;
+        storage.setItem("server", JSON.stringify(serverObject));
+      }
     }
     return result;
   };
-  return persistanceMiddleware;
+  return persistenceMiddleware;
 }

package/lib/theme/ApiExplorer/storage-utils.d.ts

@@ -1,4 +1,4 @@
 export declare function hashArray(arr: string[]): string;
-type Persistance = false | "localStorage" | "sessionStorage" | undefined;
-export declare function createStorage(persistance: Persistance): Storage;
+type Persistence = false | "localStorage" | "sessionStorage" | undefined;
+export declare function createStorage(persistence: Persistence): Storage;
 export {};

package/lib/theme/ApiExplorer/storage-utils.js

@@ -23,8 +23,8 @@ function hashArray(arr) {
   const res = hashed.join();
   return hash(res);
 }
-function createStorage(persistance) {
-  if (persistance === false) {
+function createStorage(persistence) {
+  if (persistence === false) {
     return {
       getItem: () => null,
       setItem: () => {},
@@ -34,7 +34,7 @@ function createStorage(persistance) {
       length: 0,
     };
   }
-  if (persistance === "sessionStorage") {
+  if (persistence === "sessionStorage") {
     return sessionStorage;
   }
   return localStorage;

package/lib/theme/ApiItem/Layout/index.d.ts

@@ -1,3 +1,3 @@
 import { type JSX } from "react";
-import type { Props } from "@theme/ApiItem/Layout";
+import type { Props } from "@theme/DocItem/Layout";
 export default function DocItemLayout({ children }: Props): JSX.Element;

package/lib/theme/ApiItem/hooks.d.ts

@@ -1,12 +1,12 @@
 import { TypedUseSelectorHook } from "react-redux";
 import type { RootState } from "./store";
-export declare const useTypedDispatch: () => import("redux-thunk").ThunkDispatch<import("redux").CombinedState<{
-    accept: unknown;
-    contentType: unknown;
-    response: unknown;
-    server: unknown;
-    body: unknown;
-    params: unknown;
-    auth: unknown;
-}>, undefined, import("redux").AnyAction> & import("redux").Dispatch<any>;
+export declare const useTypedDispatch: () => import("redux-thunk").ThunkDispatch<{
+    accept: import("../ApiExplorer/Accept/slice").State;
+    contentType: import("../ApiExplorer/ContentType/slice").State;
+    response: import("../ApiExplorer/Response/slice").State;
+    server: import("../ApiExplorer/Server/slice").State;
+    body: import("../ApiExplorer/Body/slice").FormBody | import("../ApiExplorer/Body/slice").RawBody | import("../ApiExplorer/Body/slice").EmptyBody;
+    params: import("../ApiExplorer/ParamOptions/slice").State;
+    auth: import("../ApiExplorer/Authorization/slice").AuthState;
+}, undefined, import("redux").UnknownAction> & import("redux").Dispatch<import("redux").UnknownAction>;
 export declare const useTypedSelector: TypedUseSelectorHook<RootState>;

package/lib/theme/ApiItem/index.js

@@ -24,7 +24,8 @@ const useDocusaurusContext_1 = __importDefault(
 );
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
 const slice_1 = require("@theme/ApiExplorer/Authorization/slice");
-const persistanceMiddleware_1 = require("@theme/ApiExplorer/persistanceMiddleware");
+const persistenceMiddleware_1 = require("@theme/ApiExplorer/persistenceMiddleware");
+const storage_utils_1 = require("@theme/ApiExplorer/storage-utils");
 const Layout_1 = __importDefault(require("@theme/ApiItem/Layout"));
 const CodeBlock_1 = __importDefault(require("@theme/CodeBlock"));
 const Metadata_1 = __importDefault(require("@theme/DocItem/Metadata"));
@@ -71,11 +72,11 @@ function ApiItem(props) {
   const statusRegex = new RegExp("(20[0-9]|2[1-9][0-9])");
   // Define store2
   let store2 = {};
-  const persistanceMiddleware = (0,
-  persistanceMiddleware_1.createPersistanceMiddleware)(options);
+  const persistenceMiddleware = (0,
+  persistenceMiddleware_1.createPersistenceMiddleware)(options);
   // Init store for SSR
   if (!isBrowser) {
-    store2 = (0, store_1.createStoreWithoutState)({}, [persistanceMiddleware]);
+    store2 = (0, store_1.createStoreWithoutState)({}, [persistenceMiddleware]);
   }
   // Init store for CSR to hydrate components
   if (isBrowser) {
@@ -106,11 +107,14 @@ function ApiItem(props) {
       securitySchemes: api?.securitySchemes,
       options,
     });
+    const storage = (0, storage_utils_1.createStorage)(
+      options?.authPersistence ?? "sessionStorage"
+    );
     // TODO: determine way to rehydrate without flashing
     // const acceptValue = window?.sessionStorage.getItem("accept");
     // const contentTypeValue = window?.sessionStorage.getItem("contentType");
-    const server = window?.sessionStorage.getItem("server");
-    const serverObject = JSON.parse(server) ?? {};
+    const server = storage.getItem("server");
+    const serverObject = server ? JSON.parse(server) : undefined;
     store2 = (0, store_1.createStoreWithState)(
       {
         accept: {
@@ -122,7 +126,7 @@ function ApiItem(props) {
           options: contentTypeArray,
         },
         server: {
-          value: serverObject.url ? serverObject : undefined,
+          value: serverObject?.url ? serverObject : undefined,
           options: servers,
         },
         response: { value: undefined },
@@ -130,7 +134,7 @@ function ApiItem(props) {
         params,
         auth,
       },
-      [persistanceMiddleware]
+      [persistenceMiddleware]
     );
   }
   if (api) {

package/lib/theme/ApiItem/store.d.ts

@@ -1,46 +1,58 @@
-declare const rootReducer: import("redux").Reducer<import("redux").CombinedState<{
-    accept: unknown;
-    contentType: unknown;
-    response: unknown;
-    server: unknown;
-    body: unknown;
-    params: unknown;
-    auth: unknown;
-}>, any>;
+declare const rootReducer: import("redux").Reducer<{
+    accept: import("@theme/ApiExplorer/Accept/slice").State;
+    contentType: import("@theme/ApiExplorer/ContentType/slice").State;
+    response: import("@theme/ApiExplorer/Response/slice").State;
+    server: import("@theme/ApiExplorer/Server/slice").State;
+    body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
+    params: import("@theme/ApiExplorer/ParamOptions/slice").State;
+    auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+}, import("redux").UnknownAction, Partial<{
+    accept: import("@theme/ApiExplorer/Accept/slice").State | undefined;
+    contentType: import("@theme/ApiExplorer/ContentType/slice").State | undefined;
+    response: import("@theme/ApiExplorer/Response/slice").State | undefined;
+    server: import("@theme/ApiExplorer/Server/slice").State | undefined;
+    body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody | undefined;
+    params: import("@theme/ApiExplorer/ParamOptions/slice").State | undefined;
+    auth: import("@theme/ApiExplorer/Authorization/slice").AuthState | undefined;
+}>>;
 export type RootState = ReturnType<typeof rootReducer>;
-export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
-    accept: unknown;
-    contentType: unknown;
-    response: unknown;
-    server: unknown;
-    body: unknown;
-    params: unknown;
-    auth: unknown;
-}, any, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
-    accept: unknown;
-    contentType: unknown;
-    response: unknown;
-    server: unknown;
-    body: unknown;
-    params: unknown;
-    auth: unknown;
-}>, import("redux").AnyAction>, ...any[]]>>;
-export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
-    accept: unknown;
-    contentType: unknown;
-    response: unknown;
-    server: unknown;
-    body: unknown;
-    params: unknown;
-    auth: unknown;
-}, any, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
-    accept: unknown;
-    contentType: unknown;
-    response: unknown;
-    server: unknown;
-    body: unknown;
-    params: unknown;
-    auth: unknown;
-}>, import("redux").AnyAction>, ...any[]]>>;
+export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit").EnhancedStore<{
+    accept: import("@theme/ApiExplorer/Accept/slice").State;
+    contentType: import("@theme/ApiExplorer/ContentType/slice").State;
+    response: import("@theme/ApiExplorer/Response/slice").State;
+    server: import("@theme/ApiExplorer/Server/slice").State;
+    body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
+    params: import("@theme/ApiExplorer/ParamOptions/slice").State;
+    auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+}, import("redux").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("redux").StoreEnhancer<{
+    dispatch: import("redux-thunk").ThunkDispatch<{
+        accept: import("@theme/ApiExplorer/Accept/slice").State;
+        contentType: import("@theme/ApiExplorer/ContentType/slice").State;
+        response: import("@theme/ApiExplorer/Response/slice").State;
+        server: import("@theme/ApiExplorer/Server/slice").State;
+        body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
+        params: import("@theme/ApiExplorer/ParamOptions/slice").State;
+        auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    }, undefined, import("redux").UnknownAction>;
+}>, import("redux").StoreEnhancer]>>;
+export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit").EnhancedStore<{
+    accept: import("@theme/ApiExplorer/Accept/slice").State;
+    contentType: import("@theme/ApiExplorer/ContentType/slice").State;
+    response: import("@theme/ApiExplorer/Response/slice").State;
+    server: import("@theme/ApiExplorer/Server/slice").State;
+    body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
+    params: import("@theme/ApiExplorer/ParamOptions/slice").State;
+    auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+}, import("redux").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("redux").StoreEnhancer<{
+    dispatch: import("redux-thunk").ThunkDispatch<{
+        accept: import("@theme/ApiExplorer/Accept/slice").State;
+        contentType: import("@theme/ApiExplorer/ContentType/slice").State;
+        response: import("@theme/ApiExplorer/Response/slice").State;
+        server: import("@theme/ApiExplorer/Server/slice").State;
+        body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
+        params: import("@theme/ApiExplorer/ParamOptions/slice").State;
+        auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    }, undefined, import("redux").UnknownAction>;
+}>, import("redux").StoreEnhancer]>>;
 export type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
 export {};

package/lib/theme/ApiTabs/index.js

@@ -70,8 +70,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ApiTabs;
 const react_1 = __importStar(require("react"));
 const internal_1 = require("@docusaurus/theme-common/internal");
+const Translate_1 = require("@docusaurus/Translate");
 const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
 const Heading_1 = __importDefault(require("@theme/Heading"));
+const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
 function TabList({
   className,
@@ -79,7 +81,10 @@ function TabList({
   selectedValue,
   selectValue,
   tabValues,
-  label = "Responses",
+  label = (0, Translate_1.translate)({
+    id: translationIds_1.OPENAPI_TABS.RESPONSES_LABEL,
+    message: "Responses",
+  }),
   id = "responses",
 }) {
   const tabRefs = [];

package/lib/theme/Example/_Example.scss

@@ -0,0 +1,11 @@
+.openapi-examples {
+  > .openapi-tabs__schema-container {
+    margin: 0.4rem;
+
+    @layer docusaurus.infima {
+      > .margin-top--md {
+        margin: 0.2rem !important;
+      }
+    }
+  }
+}

package/lib/theme/Example/index.d.ts

@@ -0,0 +1,24 @@
+import React from "react";
+import { ExampleObject } from "@theme/ParamsItem";
+type ExampleType = string;
+type ExamplesType = Record<string, ExampleObject> | string[];
+/**
+ * Example Component Props
+ */
+type ExampleProps = {
+    example?: ExampleType;
+    examples?: ExamplesType;
+};
+/**
+ * Example Component
+ */
+export declare const Example: ({ example, examples }: ExampleProps) => React.JSX.Element | undefined;
+/**
+ * Render string examples
+ *
+ * @param examples
+ * @returns
+ */
+export declare function renderStringArrayExamples(examples: string[]): React.JSX.Element | undefined;
+export declare const renderExamplesRecord: (examples: Record<string, ExampleObject>) => React.JSX.Element | undefined;
+export {};