@camunda8/docusaurus-plugin-openapi-docs 4.6.0 → 4.6.2

package/lib/openapi/sdkExamples.d.ts

@@ -8,6 +8,9 @@ export interface SdkExampleSource {
     highlight?: string;
     /** Path to the operation-map.json file (relative to site root or absolute). */
     operationMapPath: string;
+    /** Default import/using statement prepended to every code sample for this language.
+     *  Individual entries in operation-map.json can override this with their own `imports` field. */
+    defaultImports?: string;
 }
 /**
  * A single entry in operation-map.json for one operationId.

package/lib/openapi/sdkExamples.js

@@ -116,6 +116,7 @@ function camelToSnake(str) {
  * @returns Array of x-codeSamples entries, or empty array if none found.
  */
 function buildCodeSamples(operationId, sdkExamples, siteDir, fileCache, mapCache) {
+    var _a;
     const samples = [];
     for (const sdk of sdkExamples) {
         const mapPath = path_1.default.resolve(siteDir, sdk.operationMapPath);
@@ -160,10 +161,11 @@ function buildCodeSamples(operationId, sdkExamples, siteDir, fileCache, mapCache
             // Use "SDK - <label>" only when there are multiple entries for the same
             // operationId, so readers can distinguish between variants.
             const label = hasMultipleEntries && entry.label ? `SDK - ${entry.label}` : "SDK";
+            const imports = (_a = entry.imports) !== null && _a !== void 0 ? _a : sdk.defaultImports;
             samples.push({
                 lang: sdk.lang,
                 label,
-                source: entry.imports ? `${entry.imports}\n\n${code}` : code,
+                source: imports ? `${imports}\n\n${code}` : code,
             });
         }
     }

package/lib/options.js

@@ -50,6 +50,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
             lang: utils_validation_1.Joi.string().required(),
             highlight: utils_validation_1.Joi.string(),
             operationMapPath: utils_validation_1.Joi.string().required(),
+            defaultImports: utils_validation_1.Joi.string(),
         })),
         version: utils_validation_1.Joi.string().when("versions", {
             is: utils_validation_1.Joi.exist(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@camunda8/docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "4.6.0",
+  "version": "4.6.2",
   "license": "MIT",
   "keywords": [
     "openapi",

package/src/openapi/sdkExamples.ts

@@ -19,6 +19,9 @@ export interface SdkExampleSource {
   highlight?: string;
   /** Path to the operation-map.json file (relative to site root or absolute). */
   operationMapPath: string;
+  /** Default import/using statement prepended to every code sample for this language.
+   *  Individual entries in operation-map.json can override this with their own `imports` field. */
+  defaultImports?: string;
 }
 
 /**
@@ -218,10 +221,11 @@ export function buildCodeSamples(
       const label =
         hasMultipleEntries && entry.label ? `SDK - ${entry.label}` : "SDK";
 
+      const imports = entry.imports ?? sdk.defaultImports;
       samples.push({
         lang: sdk.lang,
         label,
-        source: entry.imports ? `${entry.imports}\n\n${code}` : code,
+        source: imports ? `${imports}\n\n${code}` : code,
       });
     }
   }

package/src/options.ts

@@ -55,6 +55,7 @@ export const OptionsSchema = Joi.object({
             lang: Joi.string().required(),
             highlight: Joi.string(),
             operationMapPath: Joi.string().required(),
+            defaultImports: Joi.string(),
           })
         ),
         version: Joi.string().when("versions", {