docusaurus-theme-openapi-docs 1.4.5 → 1.4.7

package/src/theme/ApiDemoPanel/Server/index.tsx

@@ -7,18 +7,19 @@
 
 import React, { useState } from "react";
 
-import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
-import FloatingButton from "../FloatingButton";
-import FormItem from "./../FormItem";
-import FormSelect from "./../FormSelect";
-import FormTextInput from "./../FormTextInput";
+import FloatingButton from "@theme/ApiDemoPanel/FloatingButton";
+import FormItem from "@theme/ApiDemoPanel/FormItem";
+import FormSelect from "@theme/ApiDemoPanel/FormSelect";
+import FormTextInput from "@theme/ApiDemoPanel/FormTextInput";
+import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+
 import { setServer, setServerVariable } from "./slice";
 import styles from "./styles.module.css";
 
 function Server() {
   const [isEditing, setIsEditing] = useState(false);
-  const value = useTypedSelector((state) => state.server.value);
-  const options = useTypedSelector((state) => state.server.options);
+  const value = useTypedSelector((state: any) => state.server.value);
+  const options = useTypedSelector((state: any) => state.server.options);
   const dispatch = useTypedDispatch();
 
   if (options.length <= 0) {
@@ -36,7 +37,7 @@ function Server() {
 
   // Default to first option when existing server state is mismatched
   if (value) {
-    const urlExists = options.find((s) => s.url === value.url);
+    const urlExists = options.find((s: any) => s.url === value.url);
     if (!urlExists) {
       const defaultOption = options[0];
       dispatch(setServer(JSON.stringify(defaultOption)));
@@ -76,12 +77,12 @@ function Server() {
       <FloatingButton onClick={() => setIsEditing(false)} label="Hide">
         <FormItem label="Base URL">
           <FormSelect
-            options={options.map((s) => s.url)}
-            onChange={(e) => {
+            options={options.map((s: any) => s.url)}
+            onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
               dispatch(
                 setServer(
                   JSON.stringify(
-                    options.filter((s) => s.url === e.target.value)[0]
+                    options.filter((s: any) => s.url === e.target.value)[0]
                   )
                 )
               );
@@ -97,7 +98,7 @@ function Server() {
                 <FormItem label={key}>
                   <FormSelect
                     options={value.variables[key].enum}
-                    onChange={(e) => {
+                    onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
                       dispatch(
                         setServerVariable(
                           JSON.stringify({ key, value: e.target.value })
@@ -113,7 +114,7 @@ function Server() {
               <FormItem label={key}>
                 <FormTextInput
                   placeholder={value.variables?.[key].default}
-                  onChange={(e) => {
+                  onChange={(e: React.ChangeEvent<HTMLInputElement>) => {
                     dispatch(
                       setServerVariable(
                         JSON.stringify({ key, value: e.target.value })

package/src/theme/ApiDemoPanel/buildPostmanRequest.ts

@@ -6,15 +6,14 @@
  * ========================================================================== */
 
 import sdk from "@paloaltonetworks/postman-collection";
+import { AuthState, Scheme } from "@theme/ApiDemoPanel/Authorization/slice";
+import { Body, Content } from "@theme/ApiDemoPanel/Body/slice";
 import {
   ParameterObject,
   ServerObject,
 } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import cloneDeep from "lodash/cloneDeep";
 
-import { AuthState, Scheme } from "./Authorization/slice";
-import { Body, Content } from "./Body/slice";
-
 type Param = {
   value?: string | string[];
 } & ParameterObject;

package/src/theme/ApiDemoPanel/index.tsx

@@ -8,14 +8,13 @@
 import React from "react";
 
 import sdk from "@paloaltonetworks/postman-collection";
+import Curl from "@theme/ApiDemoPanel/Curl";
+import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";
+import Request from "@theme/ApiDemoPanel/Request";
+import Response from "@theme/ApiDemoPanel/Response";
+import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes";
 import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 
-import Curl from "./Curl";
-import MethodEndpoint from "./MethodEndpoint";
-import Request from "./Request";
-import Response from "./Response";
-import SecuritySchemes from "./SecuritySchemes";
-
 function ApiDemoPanel({
   item,
   infoPath,

package/src/theme/ApiDemoPanel/persistanceMiddleware.ts

@@ -6,10 +6,14 @@
  * ========================================================================== */
 
 import { Middleware } from "@reduxjs/toolkit";
+import {
+  setAuthData,
+  setSelectedAuth,
+} from "@theme/ApiDemoPanel/Authorization/slice";
+import { AppDispatch, RootState } from "@theme/ApiItem/store";
+/* eslint-disable import/no-extraneous-dependencies*/
+import { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
 
-import { ThemeConfig } from "../../types";
-import { AppDispatch, RootState } from "../ApiItem/store";
-import { setAuthData, setSelectedAuth } from "./Authorization/slice";
 import { createStorage, hashArray } from "./storage-utils";
 
 export function createPersistanceMiddleware(options: ThemeConfig["api"]) {
@@ -23,7 +27,7 @@ export function createPersistanceMiddleware(options: ThemeConfig["api"]) {
 
       if (action.type === setAuthData.type) {
         for (const [key, value] of Object.entries(state.auth.data)) {
-          if (Object.values(value).filter(Boolean).length > 0) {
+          if (Object.values(value as any).filter(Boolean).length > 0) {
             storage.setItem(key, JSON.stringify(value));
           } else {
             storage.removeItem(key);

package/src/theme/ApiItem/index.tsx

@@ -12,19 +12,22 @@ import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { HtmlClassNameProvider } from "@docusaurus/theme-common";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import useIsBrowser from "@docusaurus/useIsBrowser";
+import { createAuth } from "@theme/ApiDemoPanel/Authorization/slice";
+import { createPersistanceMiddleware } from "@theme/ApiDemoPanel/persistanceMiddleware";
+import DocItemLayout from "@theme/ApiItem/Layout";
 import type { Props } from "@theme/DocItem";
 import DocItemMetadata from "@theme/DocItem/Metadata";
 import clsx from "clsx";
 import { ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 import type { ApiItem as ApiItemType } from "docusaurus-plugin-openapi-docs/src/types";
+/* eslint-disable import/no-extraneous-dependencies*/
+import type {
+  DocFrontMatter,
+  ThemeConfig,
+} from "docusaurus-theme-openapi-docs/src/types";
 import { Provider } from "react-redux";
 
-import { DocFrontMatter } from "../../types";
-import { ThemeConfig } from "../../types";
-import { createAuth } from "../ApiDemoPanel/Authorization/slice";
-import { createPersistanceMiddleware } from "../ApiDemoPanel/persistanceMiddleware";
-import DocItemLayout from "./Layout";
 import { createStoreWithoutState, createStoreWithState } from "./store";
 
 const { DocProvider } = require("@docusaurus/theme-common/internal");

package/src/theme/ApiItem/store.ts

@@ -6,14 +6,13 @@
  * ========================================================================== */
 
 import { configureStore, combineReducers } from "@reduxjs/toolkit";
-
-import accept from "../ApiDemoPanel/Accept/slice";
-import auth from "../ApiDemoPanel/Authorization/slice";
-import body from "../ApiDemoPanel/Body/slice";
-import contentType from "../ApiDemoPanel/ContentType/slice";
-import params from "../ApiDemoPanel/ParamOptions/slice";
-import response from "../ApiDemoPanel/Response/slice";
-import server from "../ApiDemoPanel/Server/slice";
+import accept from "@theme/ApiDemoPanel/Accept/slice";
+import auth from "@theme/ApiDemoPanel/Authorization/slice";
+import body from "@theme/ApiDemoPanel/Body/slice";
+import contentType from "@theme/ApiDemoPanel/ContentType/slice";
+import params from "@theme/ApiDemoPanel/ParamOptions/slice";
+import response from "@theme/ApiDemoPanel/Response/slice";
+import server from "@theme/ApiDemoPanel/Server/slice";
 
 const rootReducer = combineReducers({
   accept,

package/src/theme/MimeTabs/index.js

@@ -16,20 +16,18 @@ import React, {
 
 import { duplicates } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
+import { setAccept } from "@theme/ApiDemoPanel/Accept/slice";
+import { setContentType } from "@theme/ApiDemoPanel/ContentType/slice";
+import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import clsx from "clsx";
 
-import { setAccept } from "../ApiDemoPanel/Accept/slice";
-import { setContentType } from "../ApiDemoPanel/ContentType/slice";
-import { useTypedDispatch, useTypedSelector } from "../ApiItem/hooks";
-import styles from "./styles.module.css"; // A very rough duck type, but good enough to guard against mistakes while
+import styles from "./styles.module.css";
 
 const {
   useScrollPositionBlocker,
   useTabGroupChoice,
 } = require("@docusaurus/theme-common/internal");
 
-// allowing customization
-
 function isTabItem(comp) {
   return typeof comp.props.value !== "undefined";
 }

package/src/theme/ParamsItem/index.js

@@ -8,12 +8,18 @@
 import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
+/* eslint-disable import/no-extraneous-dependencies*/
+import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
+/* eslint-disable import/no-extraneous-dependencies*/
+import {
+  getQualifierMessage,
+  getSchemaName,
+} from "docusaurus-theme-openapi-docs/lib/markdown/schema";
+/* eslint-disable import/no-extraneous-dependencies*/
+import { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
 
-import { createDescription } from "../../markdown/createDescription";
-import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
-import { guard } from "../../markdown/utils";
 import styles from "./styles.module.css";
 
 function ParamsItem({

package/src/theme/SchemaItem/index.js

@@ -8,11 +8,13 @@
 import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
+/* eslint-disable import/no-extraneous-dependencies*/
+import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
+/* eslint-disable import/no-extraneous-dependencies*/
+import { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
 
-import { createDescription } from "../../markdown/createDescription";
-import { guard } from "../../markdown/utils";
 import styles from "./styles.module.css";
 
 function SchemaItem({

package/src/theme-openapi.d.ts

@@ -46,3 +46,189 @@ declare module "@docusaurus/plugin-content-docs-types" {
 declare module "docusaurus-theme-openapi-docs" {
   export type ThemeConfig = Partial<import("./types").ThemeConfig>;
 }
+
+declare module "@theme/ApiItem/hooks" {
+  export { useTypedDispatch, useTypedSelector };
+}
+
+declare module "@theme/ApiItem/Layout" {
+  export default function Layout(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiItem/store" {
+  export { AppDispatch, RootState };
+}
+
+declare module "@theme/SchemaTabs" {
+  export default function SchemaTabs(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Accept" {
+  export default function Accept(): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Accept/slice" {
+  export default accept as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/Authorization" {
+  export default function Authorization(): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Authorization/slice" {
+  export { AuthState, Scheme, setAuthData, setSelectedAuth, createAuth };
+  export default auth as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/Body" {
+  import { Props as BodyProps } from "@theme/ApiDemoPanel/Body";
+
+  export default function Body(props: BodyProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Body/json2xml" {
+  export default function json2xml(any, any?): any;
+}
+
+declare module "@theme/ApiDemoPanel/Body/slice" {
+  import { Body, Content, State } from "@theme/ApiDemoPanel/Body/slice";
+
+  export { Body, Content, State };
+  export function setStringRawBody(any, any?): any;
+  export default body as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/buildPostmanRequest" {
+  export default function buildPostmanRequest(any, any?): any;
+}
+
+declare module "@theme/ApiDemoPanel/CodeTabs" {
+  import { Props as CodeTabsProps } from "@theme/ApiDemoPanel/CodeTabs";
+
+  export default function CodeTabs(props: CodeTabsProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ContentType" {
+  export default function ContentType(): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ContentType/slice" {
+  export { setContentType };
+  export default contentType as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/Curl" {
+  import { Props as CurlProps } from "@theme/ApiDemoPanel/Curl";
+
+  export { languageSet, Language } from "@theme/ApiDemoPanel/Curl";
+  export default function Curl(props: CurlProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/FloatingButton" {
+  import { Props as FloatingButtonProps } from "@theme/ApiDemoPanel/FloatingButton";
+
+  export default function FloatingButton(
+    props: FloatingButtonProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/FormItem" {
+  import { Props as FormItemProps } from "@theme/ApiDemoPanel/FormItem";
+
+  export default function FormItem(props: FormItemProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/FormSelect" {
+  import { Props as FormSelectProps } from "@theme/ApiDemoPanel/FormSelect";
+
+  export default function FormSelect(props: FormSelectProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/FormTextInput" {
+  import { Props as FormTextInputProps } from "@theme/ApiDemoPanel/FormTextInput";
+
+  export default function FormTextInput(props: FormTextInputProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/FormFileUpload" {
+  import { Props as FormFileUploadProps } from "@theme/ApiDemoPanel/FormFileUpload";
+
+  export default function FormFileUpload(
+    props: FormFileUploadProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/FormMultiSelect" {
+  import { Props as FormMultiSelectProps } from "@theme/ApiDemoPanel/FormMultiSelect";
+
+  export default function FormMultiSelect(
+    props: FormMultiSelectProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Execute" {
+  import { Props as ExecuteProps } from "@theme/ApiDemoPanel/Execute";
+
+  export default function Execute(props: ExecuteProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/LiveEditor" {
+  export default function LiveEditor(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/MethodEndpoint" {
+  import { Props as MethodEndpointProps } from "@theme/ApiDemoPanel/MethodEndpoint";
+
+  export default function MethodEndpoint(
+    props: MethodEndpointProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ParamOptions" {
+  import { ParamProps } from "@theme/ApiDemoPanel/ParamOptions";
+
+  export default function ParamOptions(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ParamOptions/slice" {
+  export type { Param };
+  export default params as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/persistanceMiddleware" {
+  export { createPersistanceMiddleware };
+}
+
+declare module "@theme/ApiDemoPanel/Request" {
+  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
+
+  export interface RequestProps {
+    item: NonNullable<ApiItem>;
+  }
+  export default function Request(props: RequestProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Response" {
+  export default function Response(): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Response/slice" {
+  export { setResponse };
+  export default response as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/SecuritySchemes" {
+  export default function SecuritySchemes(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Server" {
+  export default function Server(): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/Server/slice" {
+  export default server as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiDemoPanel/storage-utils" {
+  export { createStorage, hashArray };
+}