@camunda8/docusaurus-theme-openapi-docs 4.5.1

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

@@ -0,0 +1,394 @@
+"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 Translate_1 = require("@docusaurus/Translate");
+const json2xml_1 = __importDefault(require("@theme/ApiExplorer/Body/json2xml"));
+const FormFileUpload_1 = __importDefault(
+  require("@theme/ApiExplorer/FormFileUpload")
+);
+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 LiveEditor_1 = __importDefault(require("@theme/ApiExplorer/LiveEditor"));
+const hooks_1 = require("@theme/ApiItem/hooks");
+const Markdown_1 = __importDefault(require("@theme/Markdown"));
+const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
+const TabItem_1 = __importDefault(require("@theme/TabItem"));
+const translationIds_1 = require("@theme/translationIds");
+const xml_formatter_1 = __importDefault(require("xml-formatter"));
+const slice_1 = require("./slice");
+function BodyWrap({
+  requestBodyMetadata,
+  jsonRequestBodyExample,
+  methods,
+  required,
+}) {
+  const contentType = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.value
+  );
+  // NOTE: We used to check if body was required, but opted to always show the request body
+  // to reduce confusion, see: https://github.com/cloud-annotations/docusaurus-openapi/issues/145
+  // No body
+  if (contentType === undefined) {
+    return null;
+  }
+  return react_1.default.createElement(Body, {
+    requestBodyMetadata: requestBodyMetadata,
+    jsonRequestBodyExample: jsonRequestBodyExample,
+    required: required,
+  });
+}
+function Body({
+  requestBodyMetadata,
+  jsonRequestBodyExample,
+  methods,
+  required,
+}) {
+  const contentType = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.value
+  );
+  const dispatch = (0, hooks_1.useTypedDispatch)();
+  // Lot's of possible content-types:
+  // - application/json
+  // - application/xml
+  // - text/plain
+  // - text/css
+  // - text/html
+  // - text/javascript
+  // - application/javascript
+  // - multipart/form-data
+  // - application/x-www-form-urlencoded
+  // - image/svg+xml;charset=US-ASCII
+  // Show editor:
+  // - application/json
+  // - application/xml
+  // - */*
+  // Show form:
+  // - multipart/form-data
+  // - application/x-www-form-urlencoded
+  const schema = requestBodyMetadata?.content?.[contentType]?.schema;
+  const example = requestBodyMetadata?.content?.[contentType]?.example;
+  const examples = requestBodyMetadata?.content?.[contentType]?.examples;
+  if (schema?.format === "binary") {
+    return react_1.default.createElement(
+      FormItem_1.default,
+      null,
+      react_1.default.createElement(FormFileUpload_1.default, {
+        placeholder:
+          schema.description ||
+          (0, Translate_1.translate)({
+            id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+            message: "Body",
+          }),
+        onChange: (file) => {
+          if (file === undefined) {
+            dispatch((0, slice_1.clearRawBody)());
+            return;
+          }
+          dispatch(
+            (0, slice_1.setFileRawBody)({
+              src: `/path/to/${file.name}`,
+              content: file,
+            })
+          );
+        },
+      })
+    );
+  }
+  if (
+    (contentType === "multipart/form-data" ||
+      contentType === "application/x-www-form-urlencoded") &&
+    schema?.type === "object"
+  ) {
+    return react_1.default.createElement(
+      FormItem_1.default,
+      { className: "openapi-explorer__form-item-body-container" },
+      react_1.default.createElement(
+        "div",
+        null,
+        Object.entries(schema.properties ?? {}).map(([key, val]) => {
+          if (val.format === "binary") {
+            return react_1.default.createElement(
+              FormItem_1.default,
+              {
+                key: key,
+                label: key,
+                required:
+                  Array.isArray(schema.required) &&
+                  schema.required.includes(key),
+              },
+              react_1.default.createElement(FormFileUpload_1.default, {
+                placeholder: val.description || key,
+                onChange: (file) => {
+                  if (file === undefined) {
+                    dispatch((0, slice_1.clearFormBodyKey)(key));
+                    return;
+                  }
+                  dispatch(
+                    (0, slice_1.setFileFormBody)({
+                      key: key,
+                      value: {
+                        src: `/path/to/${file.name}`,
+                        content: file,
+                      },
+                    })
+                  );
+                },
+              })
+            );
+          }
+          if (val.enum) {
+            return react_1.default.createElement(
+              FormItem_1.default,
+              {
+                key: key,
+                label: key,
+                required:
+                  Array.isArray(schema.required) &&
+                  schema.required.includes(key),
+              },
+              react_1.default.createElement(FormSelect_1.default, {
+                options: ["---", ...val.enum],
+                onChange: (e) => {
+                  const val = e.target.value;
+                  if (val === "---") {
+                    dispatch((0, slice_1.clearFormBodyKey)(key));
+                  } else {
+                    dispatch(
+                      (0, slice_1.setStringFormBody)({
+                        key: key,
+                        value: val,
+                      })
+                    );
+                  }
+                },
+              })
+            );
+          }
+          // TODO: support all the other types.
+          return react_1.default.createElement(
+            FormItem_1.default,
+            {
+              key: key,
+              label: key,
+              required:
+                Array.isArray(schema.required) && schema.required.includes(key),
+            },
+            react_1.default.createElement(FormTextInput_1.default, {
+              paramName: key,
+              isRequired:
+                Array.isArray(schema.required) && schema.required.includes(key),
+              placeholder: val.description || key,
+              onChange: (e) => {
+                dispatch(
+                  (0, slice_1.setStringFormBody)({
+                    key: key,
+                    value: e.target.value,
+                  })
+                );
+              },
+            })
+          );
+        })
+      )
+    );
+  }
+  let language = "plaintext";
+  let defaultBody = ""; //"body content";
+  let exampleBody;
+  let examplesBodies = [];
+  if (
+    contentType.includes("application/json") ||
+    contentType.endsWith("+json")
+  ) {
+    if (jsonRequestBodyExample) {
+      defaultBody = JSON.stringify(jsonRequestBodyExample, null, 2);
+    }
+    if (example) {
+      exampleBody = JSON.stringify(example, null, 2);
+    }
+    if (examples) {
+      for (const [key, example] of Object.entries(examples)) {
+        let body = example.value;
+        try {
+          // If the value is already valid JSON we shouldn't double encode the value
+          JSON.parse(example.value);
+        } catch (e) {
+          body = JSON.stringify(example.value, null, 2);
+        }
+        examplesBodies.push({
+          label: key,
+          body,
+          summary: example.summary,
+        });
+      }
+    }
+    language = "json";
+  }
+  if (contentType === "application/xml" || contentType.endsWith("+xml")) {
+    if (jsonRequestBodyExample) {
+      try {
+        defaultBody = (0, xml_formatter_1.default)(
+          (0, json2xml_1.default)(jsonRequestBodyExample, ""),
+          {
+            indentation: "  ",
+            lineSeparator: "\n",
+            collapseContent: true,
+          }
+        );
+      } catch {
+        defaultBody = (0, json2xml_1.default)(jsonRequestBodyExample);
+      }
+    }
+    if (example) {
+      try {
+        exampleBody = (0, xml_formatter_1.default)(
+          (0, json2xml_1.default)(example, ""),
+          {
+            indentation: "  ",
+            lineSeparator: "\n",
+            collapseContent: true,
+          }
+        );
+      } catch {
+        exampleBody = (0, json2xml_1.default)(example);
+      }
+    }
+    if (examples) {
+      for (const [key, example] of Object.entries(examples)) {
+        let formattedXmlBody;
+        try {
+          formattedXmlBody = (0, xml_formatter_1.default)(example.value, {
+            indentation: "  ",
+            lineSeparator: "\n",
+            collapseContent: true,
+          });
+        } catch {
+          formattedXmlBody = example.value;
+        }
+        examplesBodies.push({
+          label: key,
+          body: formattedXmlBody,
+          summary: example.summary,
+        });
+      }
+    }
+    language = "xml";
+  }
+  if (exampleBody) {
+    return react_1.default.createElement(
+      FormItem_1.default,
+      null,
+      react_1.default.createElement(
+        SchemaTabs_1.default,
+        { className: "openapi-tabs__schema", lazy: true },
+        react_1.default.createElement(
+          TabItem_1.default,
+          {
+            label: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_BODY.EXAMPLE_FROM_SCHEMA,
+              message: "Example (from schema)",
+            }),
+            value: "Example (from schema)",
+            default: true,
+          },
+          react_1.default.createElement(
+            LiveEditor_1.default,
+            { action: dispatch, language: language, required: required },
+            defaultBody
+          )
+        ),
+        react_1.default.createElement(
+          TabItem_1.default,
+          { label: "Example", value: "example" },
+          example.summary &&
+            react_1.default.createElement(
+              Markdown_1.default,
+              null,
+              example.summary
+            ),
+          exampleBody &&
+            react_1.default.createElement(
+              LiveEditor_1.default,
+              { action: dispatch, language: language, required: required },
+              exampleBody
+            )
+        )
+      )
+    );
+  }
+  if (examplesBodies && examplesBodies.length > 0) {
+    return react_1.default.createElement(
+      FormItem_1.default,
+      { className: "openapi-explorer__form-item-body-container" },
+      react_1.default.createElement(
+        SchemaTabs_1.default,
+        { className: "openapi-tabs__schema", lazy: true },
+        react_1.default.createElement(
+          TabItem_1.default,
+          {
+            label: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_BODY.EXAMPLE_FROM_SCHEMA,
+              message: "Example (from schema)",
+            }),
+            value: "Example (from schema)",
+            default: true,
+          },
+          react_1.default.createElement(
+            LiveEditor_1.default,
+            { action: dispatch, language: language, required: required },
+            defaultBody
+          )
+        ),
+        examplesBodies.map((example) => {
+          return (
+            // @ts-ignore
+            react_1.default.createElement(
+              TabItem_1.default,
+              {
+                label: example.label,
+                value: example.label,
+                key: example.label,
+              },
+              example.summary &&
+                react_1.default.createElement(
+                  Markdown_1.default,
+                  null,
+                  example.summary
+                ),
+              example.body &&
+                react_1.default.createElement(
+                  LiveEditor_1.default,
+                  { action: dispatch, language: language },
+                  example.body
+                )
+            )
+          );
+        })
+      )
+    );
+  }
+  return react_1.default.createElement(
+    FormItem_1.default,
+    null,
+    react_1.default.createElement(
+      LiveEditor_1.default,
+      { action: dispatch, language: language, required: required },
+      defaultBody
+    )
+  );
+}
+exports.default = BodyWrap;

package/lib/theme/ApiExplorer/Body/json2xml.js

@@ -0,0 +1,43 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+export default function json2xml(o, tab) {
+  var toXml = function (v, name, ind) {
+      var xml = "";
+      if (v instanceof Array) {
+        for (var i = 0, n = v.length; i < n; i++)
+          xml += ind + toXml(v[i], name, ind + "\t") + "\n";
+      } else if (typeof v == "object") {
+        var hasChild = false;
+        xml += ind + "<" + name;
+        for (var m in v) {
+          if (m.charAt(0) === "@")
+            xml += " " + m.substr(1) + '="' + v[m].toString() + '"';
+          else hasChild = true;
+        }
+        xml += hasChild ? ">" : "/>";
+        if (hasChild) {
+          for (var m2 in v) {
+            if (m2 === "#text") xml += v[m2];
+            else if (m2 === "#cdata") xml += "<![CDATA[" + v[m2] + "]]>";
+            else if (m2.charAt(0) !== "@") xml += toXml(v[m2], m2, ind + "\t");
+          }
+          xml +=
+            (xml.charAt(xml.length - 1) === "\n" ? ind : "") +
+            "</" +
+            name +
+            ">";
+        }
+      } else {
+        xml += ind + "<" + name + ">" + v.toString() + "</" + name + ">";
+      }
+      return xml;
+    },
+    xml = "";
+  for (var m3 in o) xml += toXml(o[m3], m3, "");
+  return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
+}

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

@@ -0,0 +1,82 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+export interface FileContent {
+    type: "file";
+    value: {
+        src: string;
+        content: Blob;
+    };
+}
+export interface StringContent {
+    type: "string";
+    value?: string;
+}
+export type Content = FileContent | StringContent | undefined;
+export interface FormBody {
+    type: "form";
+    content: {
+        [key: string]: Content;
+    };
+}
+export interface RawBody {
+    type: "raw";
+    content: Content;
+}
+export interface EmptyBody {
+    type: "empty";
+}
+export type Body = EmptyBody | FormBody | RawBody;
+export type State = Body;
+export declare const slice: import("@reduxjs/toolkit").Slice<FormBody | RawBody | EmptyBody, {
+    clearRawBody: (_state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>) => {
+        type: "empty";
+    };
+    setStringRawBody: (_state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>, action: PayloadAction<string>) => {
+        type: "raw";
+        content: {
+            type: "string";
+            value: string;
+        };
+    };
+    setFileRawBody: (_state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>, action: PayloadAction<FileContent["value"]>) => {
+        type: "raw";
+        content: {
+            type: "file";
+            value: {
+                src: string;
+                content: Blob;
+            };
+        };
+    };
+    clearFormBodyKey: (state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>, action: PayloadAction<string>) => void;
+    setStringFormBody: (state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>, action: PayloadAction<{
+        key: string;
+        value: string;
+    }>) => import("immer").WritableDraft<FormBody>;
+    setFileFormBody: (state: import("immer").WritableDraft<FormBody> | import("immer").WritableDraft<RawBody> | import("immer").WritableDraft<EmptyBody>, action: PayloadAction<{
+        key: string;
+        value: FileContent["value"];
+    }>) => import("immer").WritableDraft<FormBody> | {
+        type: "form";
+        content: {
+            [x: string]: {
+                type: "file";
+                value: {
+                    src: string;
+                    content: Blob;
+                };
+            };
+        };
+    };
+}, "body", "body", import("@reduxjs/toolkit").SliceSelectors<FormBody | RawBody | EmptyBody>>;
+export declare const clearRawBody: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"body/clearRawBody">, setStringRawBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "body/setStringRawBody">, setFileRawBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    src: string;
+    content: Blob;
+}, "body/setFileRawBody">, clearFormBodyKey: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "body/clearFormBodyKey">, setStringFormBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    key: string;
+    value: string;
+}, "body/setStringFormBody">, setFileFormBody: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    key: string;
+    value: FileContent["value"];
+}, "body/setFileFormBody">;
+declare const _default: import("redux").Reducer<FormBody | RawBody | EmptyBody>;
+export default _default;

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

@@ -0,0 +1,97 @@
+"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 _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFileFormBody =
+  exports.setStringFormBody =
+  exports.clearFormBodyKey =
+  exports.setFileRawBody =
+  exports.setStringRawBody =
+  exports.clearRawBody =
+  exports.slice =
+    void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const initialState = {};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "body",
+  initialState,
+  reducers: {
+    clearRawBody: (_state) => {
+      return {
+        type: "empty",
+      };
+    },
+    setStringRawBody: (_state, action) => {
+      return {
+        type: "raw",
+        content: {
+          type: "string",
+          value: action.payload,
+        },
+      };
+    },
+    setFileRawBody: (_state, action) => {
+      return {
+        type: "raw",
+        content: {
+          type: "file",
+          value: action.payload,
+        },
+      };
+    },
+    clearFormBodyKey: (state, action) => {
+      if (state?.type === "form") {
+        delete state.content[action.payload];
+      }
+    },
+    setStringFormBody: (state, action) => {
+      if (state?.type !== "form") {
+        return {
+          type: "form",
+          content: {
+            [action.payload.key]: {
+              type: "string",
+              value: action.payload.value,
+            },
+          },
+        };
+      }
+      state.content[action.payload.key] = {
+        type: "string",
+        value: action.payload.value,
+      };
+      return state;
+    },
+    setFileFormBody: (state, action) => {
+      if (state?.type !== "form") {
+        return {
+          type: "form",
+          content: {
+            [action.payload.key]: {
+              type: "file",
+              value: action.payload.value,
+            },
+          },
+        };
+      }
+      state.content[action.payload.key] = {
+        type: "file",
+        value: action.payload.value,
+      };
+      return state;
+    },
+  },
+});
+((_a = exports.slice.actions),
+  (exports.clearRawBody = _a.clearRawBody),
+  (exports.setStringRawBody = _a.setStringRawBody),
+  (exports.setFileRawBody = _a.setFileRawBody),
+  (exports.clearFormBodyKey = _a.clearFormBodyKey),
+  (exports.setStringFormBody = _a.setStringFormBody),
+  (exports.setFileFormBody = _a.setFileFormBody));
+exports.default = exports.slice.reducer;

package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-types.d.ts

@@ -0,0 +1,21 @@
+export type CodeSampleLanguage = "C" | "C#" | "C++" | "CoffeeScript" | "CSS" | "Dart" | "DM" | "Elixir" | "Go" | "Groovy" | "HTML" | "Java" | "JavaScript" | "Kotlin" | "Objective-C" | "OCaml" | "Perl" | "PHP" | "PowerShell" | "Python" | "R" | "Ruby" | "Rust" | "Scala" | "Shell" | "Swift" | "TypeScript";
+export interface Language {
+    highlight: string;
+    language: string;
+    codeSampleLanguage: CodeSampleLanguage;
+    logoClass: string;
+    variant: string;
+    variants: string[];
+    options?: {
+        [key: string]: boolean;
+    };
+    sample?: string;
+    samples?: string[];
+    samplesSources?: string[];
+    samplesLabels?: string[];
+}
+export interface CodeSample {
+    source: string;
+    lang: CodeSampleLanguage;
+    label?: string;
+}

package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-types.js

@@ -0,0 +1,8 @@
+"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.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+import React from "react";
+import * as sdk from "postman-collection";
+import { CodeSample, Language } from "./code-snippets-types";
+export declare const languageSet: Language[];
+export interface Props {
+    postman: sdk.Request;
+    codeSamples: CodeSample[];
+    maskCredentials?: boolean;
+}
+declare function CodeSnippets({ postman, codeSamples, maskCredentials: propMaskCredentials, }: Props): React.JSX.Element | null;
+export default CodeSnippets;