docusaurus-theme-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.4

package/{lib-next/theme/ApiDemoPanel → lib/theme/ApiExplorer}/Server/slice.js

@@ -1,13 +1,16 @@
+"use strict";
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-
-import { createSlice } from "@reduxjs/toolkit";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setServerVariable = exports.setServer = exports.slice = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
 const initialState = {};
-export const slice = createSlice({
+exports.slice = (0, toolkit_1.createSlice)({
   name: "server",
   initialState,
   reducers: {
@@ -24,5 +27,7 @@ export const slice = createSlice({
     },
   },
 });
-export const { setServer, setServerVariable } = slice.actions;
-export default slice.reducer;
+(_a = exports.slice.actions),
+  (exports.setServer = _a.setServer),
+  (exports.setServerVariable = _a.setServerVariable);
+exports.default = exports.slice.reducer;

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

@@ -0,0 +1,20 @@
+import sdk from "@paloaltonetworks/postman-collection";
+import { AuthState } from "@theme/ApiExplorer/Authorization/slice";
+import { Body } from "@theme/ApiExplorer/Body/slice";
+import { ParameterObject, ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+declare type Param = {
+    value?: string | string[];
+} & ParameterObject;
+interface Options {
+    server?: ServerObject;
+    queryParams: Param[];
+    pathParams: Param[];
+    cookieParams: Param[];
+    headerParams: Param[];
+    contentType: string;
+    accept: string;
+    body: Body;
+    auth: AuthState;
+}
+declare function buildPostmanRequest(postman: sdk.Request, { queryParams, pathParams, cookieParams, contentType, accept, headerParams, body, server, auth, }: Options): sdk.Request;
+export default buildPostmanRequest;

package/{lib-next/theme/ApiDemoPanel → lib/theme/ApiExplorer}/buildPostmanRequest.js

@@ -1,12 +1,20 @@
+"use strict";
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-
-import sdk from "@paloaltonetworks/postman-collection";
-import cloneDeep from "lodash/cloneDeep";
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const postman_collection_1 = __importDefault(
+  require("@paloaltonetworks/postman-collection")
+);
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 function setQueryParams(postman, queryParams) {
   postman.url.query.clear();
   const qp = queryParams
@@ -15,23 +23,22 @@ function setQueryParams(postman, queryParams) {
         return undefined;
       }
       if (Array.isArray(param.value)) {
-        return new sdk.QueryParam({
+        return new postman_collection_1.default.QueryParam({
           key: param.name,
           value: param.value.join(","),
         });
       }
-
       // Parameter allows empty value: "/hello?extended"
       if (param.allowEmptyValue) {
         if (param.value === "true") {
-          return new sdk.QueryParam({
+          return new postman_collection_1.default.QueryParam({
             key: param.name,
             value: null,
           });
         }
         return undefined;
       }
-      return new sdk.QueryParam({
+      return new postman_collection_1.default.QueryParam({
         key: param.name,
         value: param.value,
       });
@@ -43,7 +50,7 @@ function setQueryParams(postman, queryParams) {
 }
 function setPathParams(postman, queryParams) {
   const source = queryParams.map((param) => {
-    return new sdk.Variable({
+    return new postman_collection_1.default.Variable({
       key: param.name,
       value: param.value || `:${param.name}`,
     });
@@ -54,7 +61,7 @@ function buildCookie(cookieParams) {
   const cookies = cookieParams
     .map((param) => {
       if (param.value && !Array.isArray(param.value)) {
-        return new sdk.Cookie({
+        return new postman_collection_1.default.Cookie({
           // TODO: Is this right?
           path: "",
           domain: "",
@@ -65,42 +72,29 @@ function buildCookie(cookieParams) {
       return undefined;
     })
     .filter((item) => item !== undefined);
-  const list = new sdk.CookieList(null, cookies);
+  const list = new postman_collection_1.default.CookieList(null, cookies);
   return list.toString();
 }
 function setHeaders(postman, contentType, accept, cookie, headerParams, other) {
   postman.headers.clear();
   if (contentType) {
-    postman.addHeader({
-      key: "Content-Type",
-      value: contentType,
-    });
+    postman.addHeader({ key: "Content-Type", value: contentType });
   }
   if (accept) {
-    postman.addHeader({
-      key: "Accept",
-      value: accept,
-    });
+    postman.addHeader({ key: "Accept", value: accept });
   }
   headerParams.forEach((param) => {
     if (param.value && !Array.isArray(param.value)) {
-      postman.addHeader({
-        key: param.name,
-        value: param.value,
-      });
+      postman.addHeader({ key: param.name, value: param.value });
     }
   });
   other.forEach((header) => {
     postman.addHeader(header);
   });
   if (cookie) {
-    postman.addHeader({
-      key: "Cookie",
-      value: cookie,
-    });
+    postman.addHeader({ key: "Cookie", value: cookie });
   }
 }
-
 // TODO: this is all a bit hacky
 function setBody(clonedPostman, body) {
   if (clonedPostman.body === undefined) {
@@ -113,9 +107,7 @@ function setBody(clonedPostman, body) {
   if (body.type === "raw" && body.content?.type === "file") {
     // treat it like file.
     clonedPostman.body.mode = "file";
-    clonedPostman.body.file = {
-      src: body.content.value.src,
-    };
+    clonedPostman.body.file = { src: body.content.value.src };
     return;
   }
   switch (clonedPostman.body.mode) {
@@ -140,12 +132,12 @@ function setBody(clonedPostman, body) {
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
           if (content.type === "file") {
-            return new sdk.FormParam({
+            return new postman_collection_1.default.FormParam({
               key: key,
               ...content,
             });
           }
-          return new sdk.FormParam({
+          return new postman_collection_1.default.FormParam({
             key: key,
             value: content.value,
           });
@@ -165,7 +157,7 @@ function setBody(clonedPostman, body) {
         .filter((entry) => !!entry[1])
         .map(([key, content]) => {
           if (content.type !== "file" && content.value) {
-            return new sdk.QueryParam({
+            return new postman_collection_1.default.QueryParam({
               key: key,
               value: content.value,
             });
@@ -180,9 +172,6 @@ function setBody(clonedPostman, body) {
       return;
   }
 }
-
-// TODO: finish these types
-
 function buildPostmanRequest(
   postman,
   {
@@ -197,7 +186,7 @@ function buildPostmanRequest(
     auth,
   }
 ) {
-  const clonedPostman = cloneDeep(postman);
+  const clonedPostman = (0, cloneDeep_1.default)(postman);
   clonedPostman.url.protocol = undefined;
   clonedPostman.url.host = [window.location.origin];
   if (server) {
@@ -253,7 +242,6 @@ function buildPostmanRequest(
       });
       continue;
     }
-
     // Basic Auth
     if (a.type === "http" && a.scheme === "basic") {
       const { username, password } = auth.data[a.key];
@@ -266,7 +254,6 @@ function buildPostmanRequest(
       });
       continue;
     }
-
     // API Key
     if (a.type === "apiKey" && a.in === "header") {
       const { apiKey } = auth.data[a.key];
@@ -295,4 +282,4 @@ function buildPostmanRequest(
   setBody(clonedPostman, body);
   return clonedPostman;
 }
-export default buildPostmanRequest;
+exports.default = buildPostmanRequest;

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
+declare function ApiExplorer({ item, infoPath, }: {
+    item: NonNullable<ApiItem>;
+    infoPath: string;
+}): JSX.Element;
+export default ApiExplorer;

package/lib/theme/ApiExplorer/index.js

@@ -0,0 +1,36 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const postman_collection_1 = __importDefault(
+  require("@paloaltonetworks/postman-collection")
+);
+const CodeSnippets_1 = __importDefault(
+  require("@theme/ApiExplorer/CodeSnippets")
+);
+const Request_1 = __importDefault(require("@theme/ApiExplorer/Request"));
+const Response_1 = __importDefault(require("@theme/ApiExplorer/Response"));
+function ApiExplorer({ item, infoPath }) {
+  const postman = new postman_collection_1.default.Request(item.postman);
+  return react_1.default.createElement(
+    react_1.default.Fragment,
+    null,
+    react_1.default.createElement(CodeSnippets_1.default, {
+      postman: postman,
+      codeSamples: item["x-code-samples"] ?? [],
+    }),
+    react_1.default.createElement(Request_1.default, { item: item }),
+    react_1.default.createElement(Response_1.default, { item: item })
+  );
+}
+exports.default = ApiExplorer;

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

@@ -0,0 +1,3 @@
+import { Middleware } from "@reduxjs/toolkit";
+import { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
+export declare function createPersistanceMiddleware(options: ThemeConfig["api"]): Middleware<{}, RootState, AppDispatch>;

package/{lib-next/theme/ApiDemoPanel → lib/theme/ApiExplorer}/persistanceMiddleware.js

@@ -1,21 +1,20 @@
+"use strict";
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-
-import {
-  setAuthData,
-  setSelectedAuth,
-} from "@theme/ApiDemoPanel/Authorization/slice";
-import { createStorage, hashArray } from "./storage-utils";
-export function createPersistanceMiddleware(options) {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPersistanceMiddleware = void 0;
+const slice_1 = require("@theme/ApiExplorer/Authorization/slice");
+const storage_utils_1 = require("./storage-utils");
+function createPersistanceMiddleware(options) {
   const persistanceMiddleware = (storeAPI) => (next) => (action) => {
     const result = next(action);
     const state = storeAPI.getState();
-    const storage = createStorage("sessionStorage");
-    if (action.type === setAuthData.type) {
+    const storage = (0, storage_utils_1.createStorage)("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) {
           storage.setItem(key, JSON.stringify(value));
@@ -24,24 +23,21 @@ export function createPersistanceMiddleware(options) {
         }
       }
     }
-    if (action.type === setSelectedAuth.type) {
+    if (action.type === slice_1.setSelectedAuth.type) {
       if (state.auth.selected) {
         storage.setItem(
-          hashArray(Object.keys(state.auth.options)),
+          (0, storage_utils_1.hashArray)(Object.keys(state.auth.options)),
           state.auth.selected
         );
       }
     }
-
     // TODO: determine way to rehydrate without flashing
     // if (action.type === "contentType/setContentType") {
     //   storage.setItem("contentType", action.payload);
     // }
-
     // if (action.type === "accept/setAccept") {
     //   storage.setItem("accept", action.payload);
     // }
-
     if (action.type === "server/setServer") {
       storage.setItem("server", action.payload);
     }
@@ -56,3 +52,4 @@ export function createPersistanceMiddleware(options) {
   };
   return persistanceMiddleware;
 }
+exports.createPersistanceMiddleware = createPersistanceMiddleware;

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

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

package/lib/theme/{ApiDemoPanel → ApiExplorer}/storage-utils.js

@@ -1,28 +1,28 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createStorage = createStorage;
-exports.hashArray = hashArray;
-var _cryptoJs = _interopRequireDefault(require("crypto-js"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStorage = exports.hashArray = void 0;
+const crypto_js_1 = __importDefault(require("crypto-js"));
 function hashArray(arr) {
   function hash(message) {
-    return _cryptoJs.default.SHA1(message).toString();
+    return crypto_js_1.default.SHA1(message).toString();
   }
-  const hashed = arr.map(item => hash(item));
+  const hashed = arr.map((item) => hash(item));
   hashed.sort();
   const res = hashed.join();
   return hash(res);
 }
+exports.hashArray = hashArray;
 function createStorage(persistance) {
   if (persistance === false) {
     return {
@@ -31,11 +31,12 @@ function createStorage(persistance) {
       clear: () => {},
       key: () => null,
       removeItem: () => {},
-      length: 0
+      length: 0,
     };
   }
   if (persistance === "sessionStorage") {
     return sessionStorage;
   }
   return localStorage;
-}
+}
+exports.createStorage = createStorage;

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

@@ -0,0 +1,4 @@
+/// <reference types="@docusaurus/theme-classic" />
+/// <reference types="react" />
+import type { Props } from "@theme/DocItem/Layout";
+export default function DocItemLayout({ children }: Props): JSX.Element;

package/lib/theme/ApiItem/Layout/index.js

@@ -1,76 +1,98 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocItemLayout;
-var _react = _interopRequireDefault(require("react"));
-var _themeCommon = require("@docusaurus/theme-common");
-var _internal = require("@docusaurus/theme-common/internal");
-var _DocBreadcrumbs = _interopRequireDefault(require("@theme/DocBreadcrumbs"));
-var _Content = _interopRequireDefault(require("@theme/DocItem/Content"));
-var _Footer = _interopRequireDefault(require("@theme/DocItem/Footer"));
-var _Paginator = _interopRequireDefault(require("@theme/DocItem/Paginator"));
-var _Desktop = _interopRequireDefault(require("@theme/DocItem/TOC/Desktop"));
-var _Mobile = _interopRequireDefault(require("@theme/DocItem/TOC/Mobile"));
-var _DocVersionBadge = _interopRequireDefault(require("@theme/DocVersionBadge"));
-var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
-var _clsx = _interopRequireDefault(require("clsx"));
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const theme_common_1 = require("@docusaurus/theme-common");
+const internal_1 = require("@docusaurus/theme-common/internal");
+const DocBreadcrumbs_1 = __importDefault(require("@theme/DocBreadcrumbs"));
+const Content_1 = __importDefault(require("@theme/DocItem/Content"));
+const Footer_1 = __importDefault(require("@theme/DocItem/Footer"));
+const Paginator_1 = __importDefault(require("@theme/DocItem/Paginator"));
+const Desktop_1 = __importDefault(require("@theme/DocItem/TOC/Desktop"));
+const Mobile_1 = __importDefault(require("@theme/DocItem/TOC/Mobile"));
+const DocVersionBadge_1 = __importDefault(require("@theme/DocVersionBadge"));
+const DocVersionBanner_1 = __importDefault(require("@theme/DocVersionBanner"));
+const clsx_1 = __importDefault(require("clsx"));
+const styles_module_css_1 = __importDefault(require("./styles.module.css"));
 /**
  * Decide if the toc should be rendered, on mobile or desktop viewports
  */
 function useDocTOC() {
-  const {
-    frontMatter,
-    toc
-  } = (0, _internal.useDoc)();
-  const windowSize = (0, _themeCommon.useWindowSize)();
+  const { frontMatter, toc } = (0, internal_1.useDoc)();
+  const windowSize = (0, theme_common_1.useWindowSize)();
   const hidden = frontMatter.hide_table_of_contents;
   const canRender = !hidden && toc.length > 0;
-  const mobile = canRender ? <_Mobile.default /> : undefined;
-  const desktop = canRender && (windowSize === "desktop" || windowSize === "ssr") ? <_Desktop.default /> : undefined;
+  const mobile = canRender
+    ? react_1.default.createElement(Mobile_1.default, null)
+    : undefined;
+  const desktop =
+    canRender && (windowSize === "desktop" || windowSize === "ssr")
+      ? react_1.default.createElement(Desktop_1.default, null)
+      : undefined;
   return {
     hidden,
     mobile,
-    desktop
+    desktop,
   };
 }
-function DocItemLayout({
-  children
-}) {
+function DocItemLayout({ children }) {
   const docTOC = useDocTOC();
   const {
-    frontMatter: {
-      api
-    }
-  } = (0, _internal.useDoc)();
-  return <div className="row">
-      <div className={(0, _clsx.default)("col", !docTOC.hidden && _stylesModule.default.docItemCol)}>
-        <_DocVersionBanner.default />
-        <div className={_stylesModule.default.docItemContainer}>
-          <article>
-            <_DocBreadcrumbs.default />
-            <_DocVersionBadge.default />
-            {docTOC.mobile}
-            <_Content.default>{children}</_Content.default>
-            <div className={(0, _clsx.default)("col", api ? "col--7" : "col--12")}>
-              <_Footer.default />
-            </div>
-          </article>
-          <div className={(0, _clsx.default)("col", api ? "col--7" : "col--12")}>
-            <_Paginator.default />
-          </div>
-        </div>
-      </div>
-      {docTOC.desktop && <div className="col col--3">{docTOC.desktop}</div>}
-    </div>;
-}
+    frontMatter: { api },
+  } = (0, internal_1.useDoc)();
+  return react_1.default.createElement(
+    "div",
+    { className: "row" },
+    react_1.default.createElement(
+      "div",
+      {
+        className: (0, clsx_1.default)(
+          "col",
+          !docTOC.hidden && styles_module_css_1.default.docItemCol
+        ),
+      },
+      react_1.default.createElement(DocVersionBanner_1.default, null),
+      react_1.default.createElement(
+        "div",
+        { className: styles_module_css_1.default.docItemContainer },
+        react_1.default.createElement(
+          "article",
+          null,
+          react_1.default.createElement(DocBreadcrumbs_1.default, null),
+          react_1.default.createElement(DocVersionBadge_1.default, null),
+          docTOC.mobile,
+          react_1.default.createElement(Content_1.default, null, children),
+          react_1.default.createElement(
+            "div",
+            {
+              className: (0, clsx_1.default)("col", api ? "col--7" : "col--12"),
+            },
+            react_1.default.createElement(Footer_1.default, null)
+          )
+        ),
+        react_1.default.createElement(
+          "div",
+          { className: (0, clsx_1.default)("col", api ? "col--7" : "col--12") },
+          react_1.default.createElement(Paginator_1.default, null)
+        )
+      )
+    ),
+    docTOC.desktop &&
+      react_1.default.createElement(
+        "div",
+        { className: "col col--3" },
+        docTOC.desktop
+      )
+  );
+}
+exports.default = DocItemLayout;

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

@@ -0,0 +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<import("redux").Action<any>>;
+export declare const useTypedSelector: TypedUseSelectorHook<RootState>;

package/lib/theme/ApiItem/hooks.js

@@ -1,18 +1,13 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useTypedSelector = exports.useTypedDispatch = void 0;
-var _reactRedux = require("react-redux");
 /* ============================================================================
  * Copyright (c) Palo Alto Networks
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
-
-const useTypedDispatch = () => (0, _reactRedux.useDispatch)();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTypedSelector = exports.useTypedDispatch = void 0;
+const react_redux_1 = require("react-redux");
+const useTypedDispatch = () => (0, react_redux_1.useDispatch)();
 exports.useTypedDispatch = useTypedDispatch;
-const useTypedSelector = _reactRedux.useSelector;
-exports.useTypedSelector = useTypedSelector;
+exports.useTypedSelector = react_redux_1.useSelector;

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

@@ -0,0 +1,4 @@
+/// <reference types="@docusaurus/plugin-content-docs" />
+/// <reference types="react" />
+import type { Props } from "@theme/DocItem";
+export default function ApiItem(props: Props): JSX.Element;