docusaurus-theme-openapi-docs 4.5.1 → 4.6.0

package/lib/markdown/schema.js

@@ -8,6 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSchemaName = getSchemaName;
 exports.getQualifierMessage = getQualifierMessage;
+const Translate_1 = require("@docusaurus/Translate");
+const translationIds_1 = require("../theme/translationIds");
 function prettyName(schema, circular) {
     if (schema.format) {
         return schema.format;
@@ -35,6 +37,9 @@ function prettyName(schema, circular) {
         return schema.xml?.name ?? schema.type;
         // return schema.type;
     }
+    if (Array.isArray(schema.type)) {
+        return schema.type.join(" | ");
+    }
     return schema.title ?? schema.type;
 }
 function getSchemaName(schema, circular) {
@@ -57,7 +62,10 @@ function getQualifierMessage(schema) {
         schema.maxItems === undefined) {
         return getQualifierMessage(schema.items);
     }
-    let message = "**Possible values:** ";
+    let message = `**${(0, Translate_1.translate)({
+        id: translationIds_1.OPENAPI_SCHEMA_ITEM.POSSIBLE_VALUES,
+        message: "Possible values:",
+    })}** `;
     let qualifierGroups = [];
     if (schema.items && schema.items.enum) {
         if (schema.items.enum) {

package/lib/theme/ApiExplorer/Accept/slice.d.ts

@@ -4,8 +4,11 @@ export interface State {
     options: string[];
 }
 export declare const slice: import("@reduxjs/toolkit").Slice<State, {
-    setAccept: (state: import("immer/dist/internal").WritableDraft<State>, action: PayloadAction<string>) => void;
-}, "accept">;
+    setAccept: (state: {
+        value: string;
+        options: string[];
+    }, action: PayloadAction<string>) => void;
+}, "accept", "accept", import("@reduxjs/toolkit").SliceSelectors<State>>;
 export declare const setAccept: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "accept/setAccept">;
 declare const _default: import("redux").Reducer<State>;
 export default _default;

package/lib/theme/ApiExplorer/Authorization/index.js

@@ -12,12 +12,14 @@ var __importDefault =
   };
 Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
+const Translate_1 = require("@docusaurus/Translate");
 const FormItem_1 = __importDefault(require("@theme/ApiExplorer/FormItem"));
 const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
 const FormTextInput_1 = __importDefault(
   require("@theme/ApiExplorer/FormTextInput")
 );
 const hooks_1 = require("@theme/ApiItem/hooks");
+const translationIds_1 = require("@theme/translationIds");
 const slice_1 = require("./slice");
 function Authorization() {
   const data = (0, hooks_1.useTypedSelector)((state) => state.auth.data);
@@ -37,7 +39,12 @@ function Authorization() {
     optionKeys.length > 1 &&
       react_1.default.createElement(
         FormItem_1.default,
-        { label: "Security Scheme" },
+        {
+          label: (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_AUTH.SECURITY_SCHEME,
+            message: "Security Scheme",
+          }),
+        },
         react_1.default.createElement(FormSelect_1.default, {
           options: optionKeys,
           value: selected,
@@ -50,9 +57,18 @@ function Authorization() {
       if (a.type === "http" && a.scheme === "bearer") {
         return react_1.default.createElement(
           FormItem_1.default,
-          { label: "Bearer Token", key: a.key + "-bearer" },
+          {
+            label: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_AUTH.BEARER_TOKEN,
+              message: "Bearer Token",
+            }),
+            key: a.key + "-bearer",
+          },
           react_1.default.createElement(FormTextInput_1.default, {
-            placeholder: "Bearer Token",
+            placeholder: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_AUTH.BEARER_TOKEN,
+              message: "Bearer Token",
+            }),
             password: true,
             value: data[a.key].token ?? "",
             onChange: (e) => {
@@ -71,9 +87,18 @@ function Authorization() {
       if (a.type === "oauth2") {
         return react_1.default.createElement(
           FormItem_1.default,
-          { label: "Bearer Token", key: a.key + "-oauth2" },
+          {
+            label: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_AUTH.BEARER_TOKEN,
+              message: "Bearer Token",
+            }),
+            key: a.key + "-oauth2",
+          },
           react_1.default.createElement(FormTextInput_1.default, {
-            placeholder: "Bearer Token",
+            placeholder: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_AUTH.BEARER_TOKEN,
+              message: "Bearer Token",
+            }),
             password: true,
             value: data[a.key].token ?? "",
             onChange: (e) => {
@@ -95,9 +120,17 @@ function Authorization() {
           { key: a.key + "-basic" },
           react_1.default.createElement(
             FormItem_1.default,
-            { label: "Username" },
+            {
+              label: (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_AUTH.USERNAME,
+                message: "Username",
+              }),
+            },
             react_1.default.createElement(FormTextInput_1.default, {
-              placeholder: "Username",
+              placeholder: (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_AUTH.USERNAME,
+                message: "Username",
+              }),
               value: data[a.key].username ?? "",
               onChange: (e) => {
                 const value = e.target.value;
@@ -113,9 +146,17 @@ function Authorization() {
           ),
           react_1.default.createElement(
             FormItem_1.default,
-            { label: "Password" },
+            {
+              label: (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_AUTH.PASSWORD,
+                message: "Password",
+              }),
+            },
             react_1.default.createElement(FormTextInput_1.default, {
-              placeholder: "Password",
+              placeholder: (0, Translate_1.translate)({
+                id: translationIds_1.OPENAPI_AUTH.PASSWORD,
+                message: "Password",
+              }),
               password: true,
               value: data[a.key].password ?? "",
               onChange: (e) => {

package/lib/theme/ApiExplorer/Authorization/slice.d.ts

@@ -24,13 +24,155 @@ export interface AuthState {
     selected?: string;
 }
 export declare const slice: import("@reduxjs/toolkit").Slice<AuthState, {
-    setAuthData: (state: import("immer/dist/internal").WritableDraft<AuthState>, action: PayloadAction<{
+    setAuthData: (state: {
+        data: {
+            [x: string]: {
+                [x: string]: string | undefined;
+            };
+        };
+        options: {
+            [x: string]: ({
+                key: string;
+                scopes: string[];
+                type: "apiKey";
+                description?: string | undefined;
+                name: string;
+                in: "query" | "header" | "cookie";
+            } | {
+                key: string;
+                scopes: string[];
+                type: "http";
+                description?: string | undefined;
+                scheme: string;
+                bearerFormat?: string | undefined;
+                name?: string | undefined;
+                in?: string | undefined;
+            } | {
+                key: string;
+                scopes: string[];
+                type: "oauth2";
+                description?: string | undefined;
+                flows: {
+                    implicit?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                    password?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                    clientCredentials?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                    authorizationCode?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                };
+            } | {
+                key: string;
+                scopes: string[];
+                type: "openIdConnect";
+                description?: string | undefined;
+                openIdConnectUrl: string;
+            })[];
+        };
+        selected?: string | undefined;
+    }, action: PayloadAction<{
         scheme: string;
         key: string;
         value?: string;
     }>) => void;
-    setSelectedAuth: (state: import("immer/dist/internal").WritableDraft<AuthState>, action: PayloadAction<string>) => void;
-}, "auth">;
+    setSelectedAuth: (state: {
+        data: {
+            [x: string]: {
+                [x: string]: string | undefined;
+            };
+        };
+        options: {
+            [x: string]: ({
+                key: string;
+                scopes: string[];
+                type: "apiKey";
+                description?: string | undefined;
+                name: string;
+                in: "query" | "header" | "cookie";
+            } | {
+                key: string;
+                scopes: string[];
+                type: "http";
+                description?: string | undefined;
+                scheme: string;
+                bearerFormat?: string | undefined;
+                name?: string | undefined;
+                in?: string | undefined;
+            } | {
+                key: string;
+                scopes: string[];
+                type: "oauth2";
+                description?: string | undefined;
+                flows: {
+                    implicit?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                    password?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                    clientCredentials?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                    authorizationCode?: {
+                        authorizationUrl?: string | undefined;
+                        tokenUrl?: string | undefined;
+                        refreshUrl?: string | undefined;
+                        scopes: {
+                            [x: string]: string;
+                        };
+                    } | undefined;
+                };
+            } | {
+                key: string;
+                scopes: string[];
+                type: "openIdConnect";
+                description?: string | undefined;
+                openIdConnectUrl: string;
+            })[];
+        };
+        selected?: string | undefined;
+    }, action: PayloadAction<string>) => void;
+}, "auth", "auth", import("@reduxjs/toolkit").SliceSelectors<AuthState>>;
 export declare const setAuthData: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     scheme: string;
     key: string;

package/lib/theme/ApiExplorer/Authorization/slice.js

@@ -40,7 +40,9 @@ const auth_types_1 = require("./auth-types");
 // BearerAuth                -> { token: xxx }
 // BasicAuth                 -> { username: xxx, password: xxx }
 function createAuth({ security, securitySchemes, options: opts }) {
-  const storage = (0, storage_utils_1.createStorage)("sessionStorage");
+  const storage = (0, storage_utils_1.createStorage)(
+    opts?.authPersistence ?? "sessionStorage"
+  );
   let data = {};
   let options = {};
   for (const option of security ?? []) {

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

@@ -0,0 +1,7 @@
+import React from "react";
+interface FileArrayFormItemProps {
+    id: string;
+    description: string | undefined;
+}
+export default function FileArrayFormBodyItem({ id, description, }: FileArrayFormItemProps): React.JSX.Element;
+export {};

package/lib/theme/ApiExplorer/Body/FileArrayFormBodyItem/index.js

@@ -0,0 +1,126 @@
+"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 __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  (function () {
+    var ownKeys = function (o) {
+      ownKeys =
+        Object.getOwnPropertyNames ||
+        function (o) {
+          var ar = [];
+          for (var k in o)
+            if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+          return ar;
+        };
+      return ownKeys(o);
+    };
+    return function (mod) {
+      if (mod && mod.__esModule) return mod;
+      var result = {};
+      if (mod != null)
+        for (var k = ownKeys(mod), i = 0; i < k.length; i++)
+          if (k[i] !== "default") __createBinding(result, mod, k[i]);
+      __setModuleDefault(result, mod);
+      return result;
+    };
+  })();
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = FileArrayFormBodyItem;
+const react_1 = __importStar(require("react"));
+const FormFileUpload_1 = __importDefault(
+  require("@theme/ApiExplorer/FormFileUpload")
+);
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("../slice");
+function FileArrayFormBodyItem({ id, description }) {
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  const [fileItems, setFileItems] = (0, react_1.useState)(
+    new Map([[0, undefined]])
+  );
+  const handleFileChange = (index, file) => {
+    const newItems = new Map(fileItems);
+    if (file === undefined) {
+      newItems.delete(index);
+      setFileItems(newItems);
+      dispatch(
+        (0, slice_1.setFileArrayFormBody)({
+          key: id,
+          value: [...newItems.values()].filter((item) => item !== undefined),
+        })
+      );
+      return;
+    }
+    let maxIndex = 0;
+    newItems.keys().forEach((item) => {
+      maxIndex = item > maxIndex ? item : maxIndex;
+    });
+    newItems.set(index, {
+      src: `/path/to/${file.name}`,
+      content: file,
+    });
+    newItems.set(index + 1, undefined);
+    setFileItems(newItems);
+    dispatch(
+      (0, slice_1.setFileArrayFormBody)({
+        key: id,
+        value: [...newItems.values()].filter((item) => item !== undefined),
+      })
+    );
+  };
+  return react_1.default.createElement(
+    "div",
+    null,
+    [...fileItems.keys()].map((index) =>
+      react_1.default.createElement(
+        "div",
+        { key: index },
+        react_1.default.createElement(FormFileUpload_1.default, {
+          placeholder: description || id,
+          onChange: (file) => handleFileChange(index, file),
+        })
+      )
+    )
+  );
+}

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

@@ -0,0 +1,9 @@
+import React from "react";
+import { SchemaObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+interface FormBodyItemProps {
+    schemaObject: SchemaObject;
+    id: string;
+    schema: SchemaObject;
+}
+export default function FormBodyItem({ schemaObject, id, schema, }: FormBodyItemProps): React.JSX.Element;
+export {};

package/lib/theme/ApiExplorer/Body/FormBodyItem/index.js

@@ -0,0 +1,110 @@
+"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 });
+exports.default = FormBodyItem;
+const react_1 = __importDefault(require("react"));
+const FormFileUpload_1 = __importDefault(
+  require("@theme/ApiExplorer/FormFileUpload")
+);
+const FormSelect_1 = __importDefault(require("@theme/ApiExplorer/FormSelect"));
+const FormTextInput_1 = __importDefault(
+  require("@theme/ApiExplorer/FormTextInput")
+);
+const LiveEditor_1 = __importDefault(require("@theme/ApiExplorer/LiveEditor"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const slice_1 = require("../slice");
+const FileArrayFormBodyItem_1 = __importDefault(
+  require("../FileArrayFormBodyItem")
+);
+function FormBodyItem({ schemaObject, id, schema }) {
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  if (
+    schemaObject.type === "array" &&
+    schemaObject.items?.format === "binary"
+  ) {
+    return react_1.default.createElement(FileArrayFormBodyItem_1.default, {
+      id: id,
+      description: schemaObject.description,
+    });
+  }
+  if (schemaObject.format === "binary") {
+    return react_1.default.createElement(FormFileUpload_1.default, {
+      placeholder: schemaObject.description || id,
+      onChange: (file) => {
+        if (file === undefined) {
+          dispatch((0, slice_1.clearFormBodyKey)(id));
+          return;
+        }
+        dispatch(
+          (0, slice_1.setFileFormBody)({
+            key: id,
+            value: {
+              src: `/path/to/${file.name}`,
+              content: file,
+            },
+          })
+        );
+      },
+    });
+  }
+  if (
+    schemaObject.type === "object" &&
+    (schemaObject.example || schemaObject.examples)
+  ) {
+    const objectExample = JSON.stringify(
+      schemaObject.example ?? schemaObject.examples[0],
+      null,
+      2
+    );
+    return react_1.default.createElement(
+      LiveEditor_1.default,
+      {
+        action: (code) =>
+          dispatch((0, slice_1.setStringFormBody)({ key: id, value: code })),
+      },
+      objectExample
+    );
+  }
+  if (
+    schemaObject.enum &&
+    schemaObject.enum.every((value) => typeof value === "string")
+  ) {
+    return react_1.default.createElement(FormSelect_1.default, {
+      options: ["---", ...schemaObject.enum],
+      onChange: (e) => {
+        const val = e.target.value;
+        if (val === "---") {
+          dispatch((0, slice_1.clearFormBodyKey)(id));
+        } else {
+          dispatch(
+            (0, slice_1.setStringFormBody)({
+              key: id,
+              value: val,
+            })
+          );
+        }
+      },
+    });
+  }
+  // TODO: support all the other types.
+  return react_1.default.createElement(FormTextInput_1.default, {
+    paramName: id,
+    isRequired: Array.isArray(schema.required) && schema.required.includes(id),
+    placeholder: schemaObject.description || id,
+    onChange: (e) => {
+      dispatch(
+        (0, slice_1.setStringFormBody)({ key: id, value: e.target.value })
+      );
+    },
+  });
+}