docusaurus-theme-openapi-docs 0.0.0-1293 → 0.0.0-1295

package/src/theme/SchemaItem/index.tsx

@@ -10,7 +10,6 @@ import React, { ReactNode } from "react";
 import { translate } from "@docusaurus/Translate";
 import { Example } from "@theme/Example";
 import Markdown from "@theme/Markdown";
-import { OPENAPI_SCHEMA_ITEM } from "@theme/translationIds";
 import clsx from "clsx";
 
 import { getQualifierMessage } from "../../markdown/schema";
@@ -41,11 +40,11 @@ const transformEnumDescriptions = (
 const getEnumDescriptionMarkdown = (enumDescriptions?: [string, string][]) => {
   if (enumDescriptions?.length) {
     const enumValue = translate({
-      id: OPENAPI_SCHEMA_ITEM.ENUM_VALUE,
+      id: "theme.openapi.schemaItem.enumValue",
       message: "Enum Value",
     });
     const description = translate({
-      id: OPENAPI_SCHEMA_ITEM.ENUM_DESCRIPTION,
+      id: "theme.openapi.schemaItem.enumDescription",
       message: "Description",
     });
     return `| ${enumValue} | ${description} |
@@ -97,20 +96,29 @@ export default function SchemaItem(props: Props) {
     Array.isArray(required) ? required.includes(name) : required,
     () => (
       <span className="openapi-schema__required">
-        {translate({ id: OPENAPI_SCHEMA_ITEM.REQUIRED, message: "required" })}
+        {translate({
+          id: "theme.openapi.schemaItem.required",
+          message: "required",
+        })}
       </span>
     )
   );
 
   const renderDeprecated = guard(deprecated, () => (
     <span className="openapi-schema__deprecated">
-      {translate({ id: OPENAPI_SCHEMA_ITEM.DEPRECATED, message: "deprecated" })}
+      {translate({
+        id: "theme.openapi.schemaItem.deprecated",
+        message: "deprecated",
+      })}
     </span>
   ));
 
   const renderNullable = guard(nullable, () => (
     <span className="openapi-schema__nullable">
-      {translate({ id: OPENAPI_SCHEMA_ITEM.NULLABLE, message: "nullable" })}
+      {translate({
+        id: "theme.openapi.schemaItem.nullable",
+        message: "nullable",
+      })}
     </span>
   ));
 
@@ -148,7 +156,7 @@ export default function SchemaItem(props: Props) {
           <div>
             <strong>
               {translate({
-                id: OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE,
+                id: "theme.openapi.schemaItem.defaultValue",
                 message: "Default value:",
               })}{" "}
             </strong>
@@ -162,7 +170,7 @@ export default function SchemaItem(props: Props) {
         <div>
           <strong>
             {translate({
-              id: OPENAPI_SCHEMA_ITEM.DEFAULT_VALUE,
+              id: "theme.openapi.schemaItem.defaultValue",
               message: "Default value:",
             })}{" "}
           </strong>
@@ -182,7 +190,7 @@ export default function SchemaItem(props: Props) {
           <div>
             <strong>
               {translate({
-                id: OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+                id: "theme.openapi.schemaItem.constantValue",
                 message: "Constant value:",
               })}{" "}
             </strong>
@@ -196,7 +204,7 @@ export default function SchemaItem(props: Props) {
         <div>
           <strong>
             {translate({
-              id: OPENAPI_SCHEMA_ITEM.CONSTANT_VALUE,
+              id: "theme.openapi.schemaItem.constantValue",
               message: "Constant value:",
             })}{" "}
           </strong>

package/src/theme/StatusCodes/index.tsx

@@ -14,7 +14,6 @@ import Markdown from "@theme/Markdown";
 import ResponseHeaders from "@theme/ResponseHeaders";
 import ResponseSchema from "@theme/ResponseSchema";
 import TabItem from "@theme/TabItem";
-import { OPENAPI_STATUS_CODES } from "@theme/translationIds";
 import type { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
 
 interface Props {
@@ -55,7 +54,7 @@ const StatusCodes: React.FC<Props> = ({ label, id, responses }: any) => {
                   <summary>
                     <strong>
                       {translate({
-                        id: OPENAPI_STATUS_CODES.RESPONSE_HEADERS,
+                        id: "theme.openapi.statusCodes.responseHeaders",
                         message: "Response Headers",
                       })}
                     </strong>
@@ -67,7 +66,7 @@ const StatusCodes: React.FC<Props> = ({ label, id, responses }: any) => {
             )}
             <ResponseSchema
               title={translate({
-                id: OPENAPI_STATUS_CODES.SCHEMA_TITLE,
+                id: "theme.openapi.statusCodes.schemaTitle",
                 message: "Schema",
               })}
               body={{ content: response.content }}

package/src/theme/translationIds.ts

@@ -5,117 +5,41 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-export const OPENAPI_RESPONSE = {
-  TITLE: "theme.openapi.response.title",
-  CLEAR: "theme.openapi.response.clear",
-  PLACEHOLDER: "theme.openapi.response.placeholder",
-  HEADERS_TAB: "theme.openapi.response.headersTab",
-};
-
-export const OPENAPI_TABS = {
-  RESPONSES_LABEL: "theme.openapi.tabs.responses.label",
-};
-
-export const OPENAPI_REQUEST = {
-  BODY_TITLE: "theme.openapi.request.body.title",
-  ACCEPT_TITLE: "theme.openapi.request.accept.title",
-  SEND_BUTTON: "theme.openapi.request.sendButton",
-  REQUIRED_LABEL: "theme.openapi.request.requiredLabel",
-  REQUEST_TITLE: "theme.openapi.request.title",
-  COLLAPSE_ALL: "theme.openapi.request.collapseAll",
-  EXPAND_ALL: "theme.openapi.request.expandAll",
-  BASE_URL_TITLE: "theme.openapi.request.baseUrl.title",
-  AUTH_TITLE: "theme.openapi.request.auth.title",
-  PARAMETERS_TITLE: "theme.openapi.request.parameters.title",
-  FETCHING_MESSAGE: "theme.openapi.request.fetchingMessage",
-  CONNECTION_FAILED: "theme.openapi.request.connectionFailed",
-  ERROR_TIMEOUT: "theme.openapi.request.error.timeout",
-  ERROR_NETWORK: "theme.openapi.request.error.network",
-  ERROR_CORS: "theme.openapi.request.error.cors",
-  ERROR_UNKNOWN: "theme.openapi.request.error.unknown",
-};
-
-export const OPENAPI_SERVER = {
-  EDIT_BUTTON: "theme.openapi.server.editButton",
-  HIDE_BUTTON: "theme.openapi.server.hideButton",
-};
-
-export const OPENAPI_PARAM_OPTIONS = {
-  SHOW_OPTIONAL: "theme.openapi.paramOptions.showOptional",
-  HIDE_OPTIONAL: "theme.openapi.paramOptions.hideOptional",
-};
-
-export const OPENAPI_FORM_FILE_UPLOAD = {
-  CLEAR_BUTTON: "theme.openapi.formFileUpload.clearButton",
-};
-
-export const OPENAPI_FORM = {
-  FIELD_REQUIRED: "theme.openapi.form.fieldRequired",
-};
-
-export const OPENAPI_AUTH = {
-  BEARER_TOKEN: "theme.openapi.auth.bearerToken",
-  USERNAME: "theme.openapi.auth.username",
-  PASSWORD: "theme.openapi.auth.password",
-  SECURITY_SCHEME: "theme.openapi.auth.securityScheme",
-};
-
-export const OPENAPI_RESPONSE_EXAMPLES = {
-  EXAMPLE: "theme.openapi.responseExamples.example",
-  AUTO_EXAMPLE: "theme.openapi.responseExamples.autoExample",
-};
-
-export const OPENAPI_BODY = {
-  EXAMPLE_FROM_SCHEMA: "theme.openapi.body.exampleFromSchema",
-};
-
-export const OPENAPI_STATUS_CODES = {
-  RESPONSE_HEADERS: "theme.openapi.statusCodes.responseHeaders",
-  SCHEMA_TITLE: "theme.openapi.statusCodes.schemaTitle",
-};
-
-export const OPENAPI_SCHEMA = {
-  NO_SCHEMA: "theme.openapi.schema.noSchema",
-};
-
-export const OPENAPI_SCHEMA_EXPANSION = {
-  BUTTON_LABEL: "theme.openapi.schema.expansion.button",
-  MENU_LABEL: "theme.openapi.schema.expansion.menu",
-  ALL: "theme.openapi.schema.expansion.all",
-  DEPTH_OPTION: "theme.openapi.schema.expansion.depthOption",
-};
-
-export const OPENAPI_SCHEMA_ITEM = {
-  CHARACTERS: "theme.openapi.schemaItem.characters",
-  NON_EMPTY: "theme.openapi.schemaItem.nonEmpty",
-  REQUIRED: "theme.openapi.schemaItem.required",
-  DEPRECATED: "theme.openapi.schemaItem.deprecated",
-  NULLABLE: "theme.openapi.schemaItem.nullable",
-  DEFAULT_VALUE: "theme.openapi.schemaItem.defaultValue",
-  EXAMPLE: "theme.openapi.schemaItem.example",
-  EXAMPLES: "theme.openapi.schemaItem.examples",
-  DESCRIPTION: "theme.openapi.schemaItem.description",
-  CONSTANT_VALUE: "theme.openapi.schemaItem.constantValue",
-  ENUM_VALUE: "theme.openapi.schemaItem.enumValue",
-  ENUM_DESCRIPTION: "theme.openapi.schemaItem.enumDescription",
-  POSSIBLE_VALUES: "theme.openapi.schemaItem.possibleValues",
-  EXPRESSION: "theme.openapi.schemaItem.expression",
-  ONE_OF: "theme.openapi.schemaItem.oneOf",
-  ANY_OF: "theme.openapi.schemaItem.anyOf",
-};
-
-export const OPENAPI_PARAMS_DETAILS = {
-  PARAMETERS_TITLE: "theme.openapi.paramsDetails.parametersTitle",
-};
+/*
+ * The central dictionary of translation-id constants that used to live here
+ * (OPENAPI_REQUEST, OPENAPI_SCHEMA_ITEM, ...) has been removed. Each
+ * `translate({ id, message })` / `<Translate id="...">` call site now passes
+ * its id as an inline string literal instead.
+ *
+ * WHY THE DICTIONARY WAS REMOVED
+ * ------------------------------
+ * `docusaurus write-translations` only performs STATIC analysis of the source
+ * code (via @docusaurus/babel) — it never runs the site. To collect a string
+ * it evaluates the argument of every `translate()` / `<Translate>` call with
+ * Babel's `path.evaluate()` and keeps it only when the result is `confident`.
+ *
+ * An id referenced through an imported constant, e.g.
+ *
+ *     import { OPENAPI_REQUEST } from "@theme/translationIds";
+ *     translate({ id: OPENAPI_REQUEST.COLLAPSE_ALL, message: "Collapse all" });
+ *
+ * is a member expression on a binding imported from another module. Babel
+ * cannot statically resolve a cross-module binding, so `evaluate()` returns
+ * `confident === false`, the extractor skips the call (emitting a warning), and
+ * NOTHING is written to the locale `code.json`. As a result `write-translations`
+ * produced an empty template and downstream projects had no ids to translate,
+ * even though the strings rendered fine at runtime (the inlined constant value
+ * matched the runtime lookup key).
+ *
+ * The id and message must therefore be static string literals AT THE CALL SITE.
+ * This is the approach Docusaurus' own theme-classic uses and what its i18n
+ * guide mandates ("Text labels must be static"):
+ *
+ *   - https://docusaurus.io/docs/i18n/tutorial#translate-your-react-code
+ *   - https://docusaurus.io/docs/docusaurus-core#translate
+ *
+ * Keep this note here so the removal of the constants is discoverable; do not
+ * reintroduce a shared id dictionary for `translate()` arguments.
+ */
 
-export const OPENAPI_SECURITY_SCHEMES = {
-  NAME: "theme.openapi.securitySchemes.name",
-  TYPE: "theme.openapi.securitySchemes.type",
-  SCOPES: "theme.openapi.securitySchemes.scopes",
-  IN: "theme.openapi.securitySchemes.in",
-  FLOWS: "theme.openapi.securitySchemes.flows",
-  DESCRIPTION: "theme.openapi.securitySchemes.description",
-  SCHEME: "theme.openapi.securitySchemes.scheme",
-  BEARER_FORMAT: "theme.openapi.securitySchemes.bearerFormat",
-  OPEN_ID_CONNECT_URL: "theme.openapi.securitySchemes.openIdConnectUrl",
-};
+export {};