docusaurus-theme-openapi-docs 5.0.1 → 5.1.0

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

@@ -85,14 +85,13 @@ const buildPostmanRequest_1 = __importDefault(
 const ContentType_1 = __importDefault(
   require("@theme/ApiExplorer/ContentType")
 );
+const useResolvedEncoding_1 = require("@theme/ApiExplorer/EncodingSelection/useResolvedEncoding");
 const ParamOptions_1 = __importDefault(
   require("@theme/ApiExplorer/ParamOptions")
 );
 const slice_1 = require("@theme/ApiExplorer/Response/slice");
 const Server_1 = __importDefault(require("@theme/ApiExplorer/Server"));
-const useResolvedEncoding_1 = require("@theme/ApiExplorer/EncodingSelection/useResolvedEncoding");
 const hooks_1 = require("@theme/ApiItem/hooks");
-const translationIds_1 = require("@theme/translationIds");
 const sdk = __importStar(require("postman-collection"));
 const react_hook_form_1 = require("react-hook-form");
 const makeRequest_1 = __importStar(require("./makeRequest"));
@@ -200,26 +199,26 @@ function Request({ item }) {
     switch (errorType) {
       case "timeout":
         return (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_REQUEST.ERROR_TIMEOUT,
+          id: "theme.openapi.request.error.timeout",
           message:
             "The request timed out waiting for the server to respond. Please try again. If the issue persists, try using a different client (e.g., curl) with a longer timeout.",
         });
       case "network":
         return (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_REQUEST.ERROR_NETWORK,
+          id: "theme.openapi.request.error.network",
           message:
             "Unable to reach the server. Please check your network connection and verify the server URL is correct. If the server is running, this may be a CORS issue.",
         });
       case "cors":
         return (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_REQUEST.ERROR_CORS,
+          id: "theme.openapi.request.error.cors",
           message:
             "The request was blocked, possibly due to CORS restrictions. Ensure the server allows requests from this origin, or try using a proxy.",
         });
       case "unknown":
       default:
         return (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_REQUEST.ERROR_UNKNOWN,
+          id: "theme.openapi.request.error.unknown",
           message:
             "An unexpected error occurred while making the request. Please try again.",
         });
@@ -229,7 +228,7 @@ function Request({ item }) {
     dispatch(
       (0, slice_1.setResponse)(
         (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_REQUEST.FETCHING_MESSAGE,
+          id: "theme.openapi.request.fetchingMessage",
           message: "Fetching...",
         })
       )
@@ -256,7 +255,7 @@ function Request({ item }) {
         errorMessage = getErrorMessage(e.type);
       } else {
         errorMessage = (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_REQUEST.CONNECTION_FAILED,
+          id: "theme.openapi.request.connectionFailed",
           message: "Connection failed",
         });
       }
@@ -314,7 +313,7 @@ function Request({ item }) {
           "span",
           { className: "openapi-explorer__request-title" },
           (0, Translate_1.translate)({
-            id: translationIds_1.OPENAPI_REQUEST.REQUEST_TITLE,
+            id: "theme.openapi.request.title",
             message: "Request",
           })
         ),
@@ -327,7 +326,7 @@ function Request({ item }) {
                 onClick: collapseAllDetails,
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.COLLAPSE_ALL,
+                id: "theme.openapi.request.collapseAll",
                 message: "Collapse all",
               })
             )
@@ -339,7 +338,7 @@ function Request({ item }) {
                 onClick: expandAllDetails,
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.EXPAND_ALL,
+                id: "theme.openapi.request.expandAll",
                 message: "Expand all",
               })
             )
@@ -366,7 +365,7 @@ function Request({ item }) {
                 },
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.BASE_URL_TITLE,
+                id: "theme.openapi.request.baseUrl.title",
                 message: "Base URL",
               })
             ),
@@ -391,7 +390,7 @@ function Request({ item }) {
                 },
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.AUTH_TITLE,
+                id: "theme.openapi.request.auth.title",
                 message: "Auth",
               })
             ),
@@ -415,7 +414,7 @@ function Request({ item }) {
                 },
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.PARAMETERS_TITLE,
+                id: "theme.openapi.request.parameters.title",
                 message: "Parameters",
               })
             ),
@@ -438,7 +437,7 @@ function Request({ item }) {
                 },
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                id: "theme.openapi.request.body.title",
                 message: "Body",
               }),
               requestBodyRequired &&
@@ -447,7 +446,7 @@ function Request({ item }) {
                   { className: "openapi-schema__required" },
                   "\u00A0",
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_REQUEST.REQUIRED_LABEL,
+                    id: "theme.openapi.request.requiredLabel",
                     message: "required",
                   })
                 )
@@ -480,7 +479,7 @@ function Request({ item }) {
                 },
               },
               (0, Translate_1.translate)({
-                id: translationIds_1.OPENAPI_REQUEST.ACCEPT_TITLE,
+                id: "theme.openapi.request.accept.title",
                 message: "Accept",
               })
             ),
@@ -492,7 +491,7 @@ function Request({ item }) {
             "button",
             { className: "openapi-explorer__request-btn", type: "submit" },
             (0, Translate_1.translate)({
-              id: translationIds_1.OPENAPI_REQUEST.SEND_BUTTON,
+              id: "theme.openapi.request.sendButton",
               message: "Send API Request",
             })
           )

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

@@ -80,9 +80,53 @@ const ApiCodeBlock_1 = __importDefault(
 const hooks_1 = require("@theme/ApiItem/hooks");
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
-const translationIds_1 = require("@theme/translationIds");
 const clsx_1 = __importDefault(require("clsx"));
 const slice_1 = require("./slice");
+// Pretty-print a JSON string by re-indenting structural tokens only.
+// Numbers pass through verbatim, so values beyond Number.MAX_SAFE_INTEGER
+// (e.g. 19-digit IDs) keep their exact digits. Issue #1208.
+function prettyPrintJson(raw, indent = 2) {
+  const pad = " ".repeat(indent);
+  let out = "";
+  let depth = 0;
+  let inString = false;
+  let escape = false;
+  for (let i = 0; i < raw.length; i++) {
+    const ch = raw[i];
+    if (inString) {
+      out += ch;
+      if (escape) escape = false;
+      else if (ch === "\\") escape = true;
+      else if (ch === '"') inString = false;
+      continue;
+    }
+    if (ch === " " || ch === "\t" || ch === "\n" || ch === "\r") continue;
+    if (ch === '"') {
+      out += ch;
+      inString = true;
+    } else if (ch === "{" || ch === "[") {
+      let j = i + 1;
+      while (j < raw.length && /\s/.test(raw[j])) j++;
+      if (raw[j] === "}" || raw[j] === "]") {
+        out += ch + raw[j];
+        i = j;
+      } else {
+        depth++;
+        out += ch + "\n" + pad.repeat(depth);
+      }
+    } else if (ch === "}" || ch === "]") {
+      depth--;
+      out += "\n" + pad.repeat(depth) + ch;
+    } else if (ch === ",") {
+      out += ",\n" + pad.repeat(depth);
+    } else if (ch === ":") {
+      out += ": ";
+    } else {
+      out += ch;
+    }
+  }
+  return out;
+}
 // TODO: We probably shouldn't attempt to format XML...
 function formatXml(xml) {
   const tab = "  ";
@@ -130,7 +174,8 @@ function Response({ item }) {
   let prettyResponse = response;
   if (prettyResponse) {
     try {
-      prettyResponse = JSON.stringify(JSON.parse(response), null, 2);
+      JSON.parse(response);
+      prettyResponse = prettyPrintJson(response);
     } catch {
       if (response.startsWith("<")) {
         prettyResponse = formatXml(response);
@@ -147,7 +192,7 @@ function Response({ item }) {
         "span",
         { className: "openapi-explorer__response-title" },
         (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_RESPONSE.TITLE,
+          id: "theme.openapi.response.title",
           message: "Response",
         })
       ),
@@ -163,7 +208,7 @@ function Response({ item }) {
           },
         },
         (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_RESPONSE.CLEAR,
+          id: "theme.openapi.response.clear",
           message: "Clear",
         })
       )
@@ -217,17 +262,14 @@ function Response({ item }) {
                     react_1.default.createElement(
                       Translate_1.default,
                       {
-                        id: translationIds_1.OPENAPI_RESPONSE.PLACEHOLDER,
+                        id: "theme.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,
-                              },
+                              { id: "theme.openapi.request.sendButton" },
                               "Send API Request"
                             )
                           ),
@@ -242,7 +284,7 @@ function Response({ item }) {
               TabItem_1.default,
               {
                 label: (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_RESPONSE.HEADERS_TAB,
+                  id: "theme.openapi.response.headersTab",
                   message: "Headers",
                 }),
                 value: "headers",
@@ -277,14 +319,14 @@ function Response({ item }) {
               react_1.default.createElement(
                 Translate_1.default,
                 {
-                  id: translationIds_1.OPENAPI_RESPONSE.PLACEHOLDER,
+                  id: "theme.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 },
+                        { id: "theme.openapi.request.sendButton" },
                         "Send API Request"
                       )
                     ),

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

@@ -15,7 +15,6 @@ const react_1 = __importDefault(require("react"));
 const Link_1 = __importDefault(require("@docusaurus/Link"));
 const Translate_1 = require("@docusaurus/Translate");
 const hooks_1 = require("@theme/ApiItem/hooks");
-const translationIds_1 = require("@theme/translationIds");
 function SecuritySchemes(props) {
   const options = (0, hooks_1.useTypedSelector)((state) => state.auth.options);
   const selected = (0, hooks_1.useTypedSelector)(
@@ -27,42 +26,46 @@ function SecuritySchemes(props) {
     return null;
   }
   const selectedAuth = options[selected];
-  const keyTranslations = {
-    description: {
-      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.DESCRIPTION,
-      message: "description:",
-    },
-    scheme: {
-      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.SCHEME,
-      message: "scheme:",
-    },
-    bearerFormat: {
-      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.BEARER_FORMAT,
-      message: "bearerFormat:",
-    },
-    openIdConnectUrl: {
-      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.OPEN_ID_CONNECT_URL,
-      message: "openIdConnectUrl:",
-    },
+  // Each label uses a static `translate()` call (literal id + message) so that
+  // `docusaurus write-translations` can statically extract it. A dynamic
+  // `translate({ id: someVar })` would be skipped by the extractor.
+  const renderRestLabel = (k) => {
+    switch (k) {
+      case "description":
+        return (0, Translate_1.translate)({
+          id: "theme.openapi.securitySchemes.description",
+          message: "description:",
+        });
+      case "scheme":
+        return (0, Translate_1.translate)({
+          id: "theme.openapi.securitySchemes.scheme",
+          message: "scheme:",
+        });
+      case "bearerFormat":
+        return (0, Translate_1.translate)({
+          id: "theme.openapi.securitySchemes.bearerFormat",
+          message: "bearerFormat:",
+        });
+      case "openIdConnectUrl":
+        return (0, Translate_1.translate)({
+          id: "theme.openapi.securitySchemes.openIdConnectUrl",
+          message: "openIdConnectUrl:",
+        });
+      default:
+        return `${k}:`;
+    }
   };
   const renderRest = (rest) =>
-    Object.keys(rest).map((k) => {
-      const translation = keyTranslations[k];
-      const label = translation
-        ? (0, Translate_1.translate)({
-            id: translation.id,
-            message: translation.message,
-          })
-        : `${k}:`;
-      return react_1.default.createElement(
+    Object.keys(rest).map((k) =>
+      react_1.default.createElement(
         "span",
         { key: k },
-        react_1.default.createElement("strong", null, label, " "),
+        react_1.default.createElement("strong", null, renderRestLabel(k), " "),
         typeof rest[k] === "object"
           ? JSON.stringify(rest[k], null, 2)
           : String(rest[k])
-      );
-    });
+      )
+    );
   return react_1.default.createElement(
     "details",
     { className: "openapi-security__details", open: false },
@@ -72,7 +75,11 @@ function SecuritySchemes(props) {
       react_1.default.createElement(
         "h4",
         { className: "openapi-security__summary-header" },
-        "Authorization: ",
+        (0, Translate_1.translate)({
+          id: "theme.openapi.securitySchemes.authorization",
+          message: "Authorization:",
+        }),
+        " ",
         selectedAuth[0].name ?? selectedAuth[0].type
       )
     ),
@@ -103,7 +110,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.NAME,
+                    id: "theme.openapi.securitySchemes.name",
                     message: "name:",
                   })
                 ),
@@ -121,7 +128,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.TYPE,
+                    id: "theme.openapi.securitySchemes.type",
                     message: "type:",
                   })
                 ),
@@ -137,7 +144,7 @@ function SecuritySchemes(props) {
                     "strong",
                     null,
                     (0, Translate_1.translate)({
-                      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.SCOPES,
+                      id: "theme.openapi.securitySchemes.scopes",
                       message: "scopes:",
                     })
                   ),
@@ -173,7 +180,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.NAME,
+                    id: "theme.openapi.securitySchemes.name",
                     message: "name:",
                   })
                 ),
@@ -191,7 +198,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.TYPE,
+                    id: "theme.openapi.securitySchemes.type",
                     message: "type:",
                   })
                 ),
@@ -207,7 +214,7 @@ function SecuritySchemes(props) {
                     "strong",
                     null,
                     (0, Translate_1.translate)({
-                      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.SCOPES,
+                      id: "theme.openapi.securitySchemes.scopes",
                       message: "scopes:",
                     })
                   ),
@@ -241,7 +248,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.NAME,
+                  id: "theme.openapi.securitySchemes.name",
                   message: "name:",
                 })
               ),
@@ -259,7 +266,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.TYPE,
+                  id: "theme.openapi.securitySchemes.type",
                   message: "type:",
                 })
               ),
@@ -273,7 +280,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.IN,
+                  id: "theme.openapi.securitySchemes.in",
                   message: "in:",
                 })
               ),
@@ -304,7 +311,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.NAME,
+                  id: "theme.openapi.securitySchemes.name",
                   message: "name:",
                 })
               ),
@@ -322,7 +329,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.TYPE,
+                  id: "theme.openapi.securitySchemes.type",
                   message: "type:",
                 })
               ),
@@ -338,7 +345,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.SCOPES,
+                    id: "theme.openapi.securitySchemes.scopes",
                     message: "scopes:",
                   })
                 ),
@@ -374,7 +381,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.NAME,
+                  id: "theme.openapi.securitySchemes.name",
                   message: "name:",
                 })
               ),
@@ -392,7 +399,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.TYPE,
+                  id: "theme.openapi.securitySchemes.type",
                   message: "type:",
                 })
               ),
@@ -408,7 +415,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.SCOPES,
+                    id: "theme.openapi.securitySchemes.scopes",
                     message: "scopes:",
                   })
                 ),
@@ -431,7 +438,7 @@ function SecuritySchemes(props) {
                     "strong",
                     null,
                     (0, Translate_1.translate)({
-                      id: translationIds_1.OPENAPI_SECURITY_SCHEMES.FLOWS,
+                      id: "theme.openapi.securitySchemes.flows",
                       message: "flows:",
                     })
                   ),
@@ -463,7 +470,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.NAME,
+                  id: "theme.openapi.securitySchemes.name",
                   message: "name:",
                 })
               ),
@@ -481,7 +488,7 @@ function SecuritySchemes(props) {
                 "strong",
                 null,
                 (0, Translate_1.translate)({
-                  id: translationIds_1.OPENAPI_SECURITY_SCHEMES.TYPE,
+                  id: "theme.openapi.securitySchemes.type",
                   message: "type:",
                 })
               ),
@@ -497,7 +504,7 @@ function SecuritySchemes(props) {
                   "strong",
                   null,
                   (0, Translate_1.translate)({
-                    id: translationIds_1.OPENAPI_SECURITY_SCHEMES.SCOPES,
+                    id: "theme.openapi.securitySchemes.scopes",
                     message: "scopes:",
                   })
                 ),

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

@@ -78,7 +78,6 @@ 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 Server({ labelId }) {
   const [isEditing, setIsEditing] = (0, react_1.useState)(false);
@@ -123,7 +122,7 @@ function Server({ labelId }) {
       {
         onClick: () => setIsEditing(true),
         label: (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_SERVER.EDIT_BUTTON,
+          id: "theme.openapi.server.editButton",
           message: "Edit",
         }),
       },
@@ -146,7 +145,7 @@ function Server({ labelId }) {
       {
         onClick: () => setIsEditing(false),
         label: (0, Translate_1.translate)({
-          id: translationIds_1.OPENAPI_SERVER.HIDE_BUTTON,
+          id: "theme.openapi.server.hideButton",
           message: "Hide",
         }),
       },