docusaurus-theme-openapi-docs 0.0.0-1103 → 0.0.0-1105

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

@@ -103,6 +103,7 @@ function Request({ item }) {
   const { siteConfig } = (0, useDocusaurusContext_1.default)();
   const themeConfig = siteConfig.themeConfig;
   const requestTimeout = themeConfig.api?.requestTimeout;
+  const requestCredentials = themeConfig.api?.requestCredentials;
   // Frontmatter proxy (per-spec) takes precedence over theme config proxy (site-wide)
   const proxy = frontMatterProxy ?? themeConfig.api?.proxy;
   const pathParams = (0, hooks_1.useTypedSelector)(
@@ -233,7 +234,8 @@ function Request({ item }) {
         postmanRequest,
         proxy,
         body,
-        requestTimeout
+        requestTimeout,
+        requestCredentials
       );
       if (res.headers.get("content-type")?.includes("text/event-stream")) {
         await handleEventStream(res);

package/lib/theme/ApiExplorer/Request/makeRequest.d.ts

@@ -6,5 +6,5 @@ export declare class RequestError extends Error {
     originalError?: Error;
     constructor(type: RequestErrorType, message: string, originalError?: Error);
 }
-declare function makeRequest(request: sdk.Request, proxy: string | undefined, _body: Body, timeout?: number): Promise<Response>;
+declare function makeRequest(request: sdk.Request, proxy: string | undefined, _body: Body, timeout?: number, credentials?: RequestCredentials): Promise<Response>;
 export default makeRequest;

package/lib/theme/ApiExplorer/Request/makeRequest.js

@@ -89,7 +89,8 @@ async function makeRequest(
   request,
   proxy,
   _body,
-  timeout = DEFAULT_REQUEST_TIMEOUT
+  timeout = DEFAULT_REQUEST_TIMEOUT,
+  credentials
 ) {
   const headers = request.toJSON().header;
   let myHeaders = new Headers();
@@ -221,6 +222,7 @@ async function makeRequest(
     method: request.method,
     headers: myHeaders,
     body: myBody,
+    ...(credentials && { credentials }),
   };
   let finalUrl = request.url.toString();
   if (proxy) {

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

@@ -5,6 +5,62 @@
  * 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) {
@@ -14,7 +70,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
 const client_1 = require("@docusaurus/plugin-content-docs/client");
 const theme_common_1 = require("@docusaurus/theme-common");
-const Translate_1 = require("@docusaurus/Translate");
+const Translate_1 = __importStar(require("@docusaurus/Translate"));
 const useDocusaurusContext_1 = __importDefault(
   require("@docusaurus/useDocusaurusContext")
 );
@@ -157,11 +213,27 @@ function Response({ item }) {
                       className:
                         "openapi-explorer__response-placeholder-message",
                     },
-                    (0, Translate_1.translate)({
-                      id: translationIds_1.OPENAPI_RESPONSE.PLACEHOLDER,
-                      message:
-                        "Click the <code>Send API Request</code> button above and see the response here!",
-                    })
+                    react_1.default.createElement(
+                      Translate_1.default,
+                      {
+                        id: translationIds_1.OPENAPI_RESPONSE.PLACEHOLDER,
+                        values: {
+                          code: react_1.default.createElement(
+                            "code",
+                            null,
+                            react_1.default.createElement(
+                              Translate_1.default,
+                              {
+                                id: translationIds_1.OPENAPI_REQUEST
+                                  .SEND_BUTTON,
+                              },
+                              "Send API Request"
+                            )
+                          ),
+                        },
+                      },
+                      "Click the {code} button above and see the response here!"
+                    )
                   )
               )
             ),
@@ -201,11 +273,24 @@ function Response({ item }) {
           : react_1.default.createElement(
               "p",
               { className: "openapi-explorer__response-placeholder-message" },
-              (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_RESPONSE.PLACEHOLDER,
-                message:
-                  "Click the <code>Send API Request</code> button above and see the response here!",
-              })
+              react_1.default.createElement(
+                Translate_1.default,
+                {
+                  id: translationIds_1.OPENAPI_RESPONSE.PLACEHOLDER,
+                  values: {
+                    code: react_1.default.createElement(
+                      "code",
+                      null,
+                      react_1.default.createElement(
+                        Translate_1.default,
+                        { id: translationIds_1.OPENAPI_REQUEST.SEND_BUTTON },
+                        "Send API Request"
+                      )
+                    ),
+                  },
+                },
+                "Click the {code} button above and see the response here!"
+              )
             )
     )
   );

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-1103",
+  "version": "0.0.0-1105",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -38,7 +38,7 @@
     "@types/postman-collection": "^3.5.11",
     "@types/react-modal": "^3.16.3",
     "concurrently": "^9.2.0",
-    "docusaurus-plugin-openapi-docs": "0.0.0-1103",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1105",
     "docusaurus-plugin-sass": "^0.2.6",
     "eslint-plugin-prettier": "^5.5.1"
   },
@@ -81,5 +81,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "64034eed5dc0a9ec49301d8ac9d044ceecb6a5ba"
+  "gitHead": "5a573d71d569e71efd1a08fc4abbd4c822533e55"
 }

package/src/theme/ApiExplorer/Request/index.tsx

@@ -43,6 +43,7 @@ function Request({ item }: { item: ApiItem }) {
   const { siteConfig } = useDocusaurusContext();
   const themeConfig = siteConfig.themeConfig as ThemeConfig;
   const requestTimeout = themeConfig.api?.requestTimeout;
+  const requestCredentials = themeConfig.api?.requestCredentials;
   // Frontmatter proxy (per-spec) takes precedence over theme config proxy (site-wide)
   const proxy = frontMatterProxy ?? themeConfig.api?.proxy;
 
@@ -171,7 +172,8 @@ function Request({ item }: { item: ApiItem }) {
         postmanRequest,
         proxy,
         body,
-        requestTimeout
+        requestTimeout,
+        requestCredentials
       );
       if (res.headers.get("content-type")?.includes("text/event-stream")) {
         await handleEventStream(res);

package/src/theme/ApiExplorer/Request/makeRequest.ts

@@ -114,7 +114,8 @@ async function makeRequest(
   request: sdk.Request,
   proxy: string | undefined,
   _body: Body,
-  timeout: number = DEFAULT_REQUEST_TIMEOUT
+  timeout: number = DEFAULT_REQUEST_TIMEOUT,
+  credentials?: RequestCredentials
 ) {
   const headers = request.toJSON().header;
 
@@ -252,6 +253,7 @@ async function makeRequest(
     method: request.method,
     headers: myHeaders,
     body: myBody,
+    ...(credentials && { credentials }),
   };
 
   let finalUrl = request.url.toString();

package/src/theme/ApiExplorer/Response/index.tsx

@@ -9,13 +9,13 @@ import React from "react";
 
 import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import { usePrismTheme } from "@docusaurus/theme-common";
-import { translate } from "@docusaurus/Translate";
+import Translate, { translate } from "@docusaurus/Translate";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
-import { OPENAPI_RESPONSE } from "@theme/translationIds";
+import { OPENAPI_REQUEST, OPENAPI_RESPONSE } from "@theme/translationIds";
 import clsx from "clsx";
 import type { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 import type { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
@@ -126,11 +126,22 @@ function Response({ item }: { item: ApiItem }) {
               >
                 {prettyResponse || (
                   <p className="openapi-explorer__response-placeholder-message">
-                    {translate({
-                      id: OPENAPI_RESPONSE.PLACEHOLDER,
-                      message:
-                        "Click the <code>Send API Request</code> button above and see the response here!",
-                    })}
+                    <Translate
+                      id={OPENAPI_RESPONSE.PLACEHOLDER}
+                      values={{
+                        code: (
+                          <code>
+                            <Translate id={OPENAPI_REQUEST.SEND_BUTTON}>
+                              Send API Request
+                            </Translate>
+                          </code>
+                        ),
+                      }}
+                    >
+                      {
+                        "Click the {code} button above and see the response here!"
+                      }
+                    </Translate>
                   </p>
                 )}
               </ApiCodeBlock>
@@ -163,11 +174,20 @@ function Response({ item }: { item: ApiItem }) {
           </div>
         ) : (
           <p className="openapi-explorer__response-placeholder-message">
-            {translate({
-              id: OPENAPI_RESPONSE.PLACEHOLDER,
-              message:
-                "Click the <code>Send API Request</code> button above and see the response here!",
-            })}
+            <Translate
+              id={OPENAPI_RESPONSE.PLACEHOLDER}
+              values={{
+                code: (
+                  <code>
+                    <Translate id={OPENAPI_REQUEST.SEND_BUTTON}>
+                      Send API Request
+                    </Translate>
+                  </code>
+                ),
+              }}
+            >
+              {"Click the {code} button above and see the response here!"}
+            </Translate>
           </p>
         )}
       </div>

package/src/types.d.ts

@@ -27,6 +27,13 @@ export interface ThemeConfig {
     authPersistence?: false | "sessionStorage" | "localStorage";
     /** Request timeout in milliseconds. Defaults to 30000 (30 seconds). */
     requestTimeout?: number;
+    /**
+     * Controls whether cookies and credentials are sent with API requests.
+     * - `"omit"`: Never send cookies (useful when docs are on same domain as app)
+     * - `"same-origin"`: Send cookies for same-origin requests (default browser behavior)
+     * - `"include"`: Always send cookies, even for cross-origin requests
+     */
+    requestCredentials?: "omit" | "same-origin" | "include";
   };
 }