@fern-api/fern-api-dev 5.77.0 → 5.79.0

package/cli.cjs

@@ -117799,7 +117799,8 @@ var init_DocsYmlSchemas = __esm({
       "ai-examples": external_exports.boolean().optional(),
       "ai-example-style-instructions": external_exports.string().optional(),
       "exclude-apis": external_exports.boolean().optional(),
-      "basepath-aware": external_exports.boolean().optional()
+      "basepath-aware": external_exports.boolean().optional(),
+      "external-sitemaps": external_exports.array(external_exports.string()).optional()
     });
     GitLibraryInputSchema = external_exports.object({
       git: external_exports.string(),
@@ -122972,7 +122973,8 @@ var init_ExperimentalConfig2 = __esm({
       aiExamples: schemas_exports6.property("ai-examples", schemas_exports6.boolean().optional()),
       aiExampleStyleInstructions: schemas_exports6.property("ai-example-style-instructions", schemas_exports6.string().optional()),
       excludeApis: schemas_exports6.property("exclude-apis", schemas_exports6.boolean().optional()),
-      basepathAware: schemas_exports6.property("basepath-aware", schemas_exports6.boolean().optional())
+      basepathAware: schemas_exports6.property("basepath-aware", schemas_exports6.boolean().optional()),
+      externalSitemaps: schemas_exports6.property("external-sitemaps", schemas_exports6.list(schemas_exports6.string()).optional())
     });
   }
 });
@@ -145601,7 +145603,7 @@ var init_convertFullExample = __esm({
 });
 
 // ../api-importers/openapi/openapi-ir-to-fern/lib/buildEndpointExample.js
-function buildEndpointExample({ endpointExample, context: context3 }) {
+function buildEndpointExample({ endpointExample, context: context3, pathParameterRenames }) {
   const example = {};
   if (endpointExample.type !== "full") {
     return endpointExample.value;
@@ -145622,7 +145624,7 @@ function buildEndpointExample({ endpointExample, context: context3 }) {
     }
   }
   if (endpointExample.pathParameters != null && endpointExample.pathParameters.length > 0) {
-    Object.assign(pathParametersForExample, convertPathParameterExample(endpointExample.pathParameters));
+    Object.assign(pathParametersForExample, convertPathParameterExample(endpointExample.pathParameters, pathParameterRenames));
   }
   if (Object.keys(pathParametersForExample).length > 0) {
     example["path-parameters"] = pathParametersForExample;
@@ -145724,12 +145726,13 @@ function buildEndpointExample({ endpointExample, context: context3 }) {
   }
   return example;
 }
-function convertPathParameterExample(pathParameterExamples) {
+function convertPathParameterExample(pathParameterExamples, pathParameterRenames) {
   const result = {};
   pathParameterExamples.forEach((pathParameterExample) => {
     const convertedExample = convertFullExample2(pathParameterExample.value);
     if (convertedExample != null) {
-      result[pathParameterExample.parameterNameOverride ?? pathParameterExample.name] = convertedExample;
+      const name2 = pathParameterExample.parameterNameOverride ?? pathParameterRenames?.[pathParameterExample.name] ?? pathParameterExample.name;
+      result[name2] = convertedExample;
     }
   });
   return result;
@@ -145854,17 +145857,92 @@ var init_isWriteMethod = __esm({
 });
 
 // ../api-importers/openapi/openapi-ir-to-fern/lib/buildEndpoint.js
+function getReservedRequestPropertyNames({ endpoint: endpoint3, context: context3, namespace }) {
+  const reservedNames = /* @__PURE__ */ new Set();
+  for (const queryParameter of endpoint3.queryParameters) {
+    reservedNames.add(queryParameter.name);
+  }
+  for (const header of endpoint3.headers) {
+    reservedNames.add(header.parameterNameOverride ?? header.name);
+  }
+  const request7 = endpoint3.request;
+  if (request7 == null) {
+    return reservedNames;
+  }
+  switch (request7.type) {
+    case "multipart":
+      for (const property24 of request7.properties) {
+        reservedNames.add(property24.key);
+      }
+      break;
+    case "json":
+    case "formUrlEncoded": {
+      const maybeSchemaId = request7.schema.type === "reference" ? request7.schema.schema : void 0;
+      const resolvedSchema = request7.schema.type === "reference" ? context3.getSchema(request7.schema.schema, namespace) : request7.schema;
+      if (resolvedSchema?.type !== "object" || maybeSchemaId != null && context3.isResponseReachable(maybeSchemaId)) {
+        reservedNames.add("body");
+        break;
+      }
+      for (const property24 of resolvedSchema.properties) {
+        reservedNames.add(property24.nameOverride ?? property24.key);
+      }
+      for (const allOfRef of resolvedSchema.allOf) {
+        const { properties: allOfProperties } = getProperties(context3, allOfRef.schema, namespace);
+        for (const property24 of allOfProperties) {
+          reservedNames.add(property24.nameOverride ?? property24.key);
+        }
+      }
+      break;
+    }
+    case "octetStream":
+      break;
+    default:
+      assertNever(request7);
+  }
+  return reservedNames;
+}
+function deconflictPathParameterName({ pathParameterName, reservedNames, pathParameters }) {
+  const otherPathParameterNames = /* @__PURE__ */ new Set();
+  for (const pathParameter of pathParameters) {
+    const name2 = pathParameter.parameterNameOverride ?? pathParameter.name;
+    if (name2 !== pathParameterName) {
+      otherPathParameterNames.add(name2);
+    }
+  }
+  let candidate = `${pathParameterName}${PATH_PARAM_DECONFLICT_SUFFIX}`;
+  let counter = 2;
+  while (reservedNames.has(candidate) || otherPathParameterNames.has(candidate)) {
+    candidate = `${pathParameterName}${PATH_PARAM_DECONFLICT_SUFFIX}${counter}`;
+    counter++;
+  }
+  return candidate;
+}
 function buildEndpoint({ endpoint: endpoint3, declarationFile, context: context3 }) {
   let schemaIdsToExclude = [];
   const names2 = /* @__PURE__ */ new Set();
   let path120 = endpoint3.path;
   const maybeEndpointNamespace = getEndpointNamespace(endpoint3.sdkName, endpoint3.namespace);
+  const reservedRequestPropertyNames = getReservedRequestPropertyNames({
+    endpoint: endpoint3,
+    context: context3,
+    namespace: maybeEndpointNamespace
+  });
+  const pathParameterRenames = {};
   const pathParameters = {};
   for (const pathParameter of endpoint3.pathParameters) {
-    if (pathParameter.parameterNameOverride) {
-      path120 = path120.replace(pathParameter.name, pathParameter.parameterNameOverride);
+    let parameterNameOverride = pathParameter.parameterNameOverride;
+    if (parameterNameOverride == null && reservedRequestPropertyNames.has(pathParameter.name)) {
+      parameterNameOverride = deconflictPathParameterName({
+        pathParameterName: pathParameter.name,
+        reservedNames: reservedRequestPropertyNames,
+        pathParameters: endpoint3.pathParameters
+      });
+      pathParameterRenames[pathParameter.name] = parameterNameOverride;
+    }
+    if (parameterNameOverride) {
+      path120 = path120.replace(`{${pathParameter.name}}`, `{${parameterNameOverride}}`);
     }
-    pathParameters[pathParameter.parameterNameOverride ?? pathParameter.name] = buildPathParameter({
+    pathParameters[parameterNameOverride ?? pathParameter.name] = buildPathParameter({
       pathParameter,
       context: context3,
       fileContainingReference: declarationFile,
@@ -146171,7 +146249,8 @@ function buildEndpoint({ endpoint: endpoint3, declarationFile, context: context3
   if (endpoint3.examples.length > 0) {
     convertedEndpoint.examples = convertEndpointExamples({
       endpointExamples: endpoint3.examples,
-      context: context3
+      context: context3,
+      pathParameterRenames
     });
   }
   if (endpoint3.retries != null) {
@@ -146213,10 +146292,10 @@ function convertEndpointAuth({ endpoint: endpoint3, context: context3 }) {
   }
   return endpoint3.security;
 }
-function convertEndpointExamples({ endpointExamples, context: context3 }) {
+function convertEndpointExamples({ endpointExamples, context: context3, pathParameterRenames }) {
   return endpointExamples.map((endpointExample) => {
     try {
-      return buildEndpointExample({ endpointExample, context: context3 });
+      return buildEndpointExample({ endpointExample, context: context3, pathParameterRenames });
     } catch (e2) {
       console.error(`Error building endpoint example: ${e2}`);
       throw e2;
@@ -146548,6 +146627,7 @@ function endpointRequestSupportsInlinedPathParameters({ context: context3, reque
       assertNever(request7);
   }
 }
+var PATH_PARAM_DECONFLICT_SUFFIX;
 var init_buildEndpoint = __esm({
   "../api-importers/openapi/openapi-ir-to-fern/lib/buildEndpoint.js"() {
     "use strict";
@@ -146573,6 +146653,7 @@ var init_buildEndpoint = __esm({
     init_getNamespaceFromGroup();
     init_getTypeFromTypeReference();
     init_isWriteMethod();
+    PATH_PARAM_DECONFLICT_SUFFIX = "PathParam";
   }
 });
 
@@ -233755,7 +233836,8 @@ function convertSettingsConfig(settings) {
     defaultSearchFilters: defaultFilterByCurrentProduct,
     search: {
       prioritizeCurrentProduct,
-      defaultFilterByCurrentProduct
+      defaultFilterByCurrentProduct,
+      externalSitemaps: void 0
     },
     language: settings.language ?? "en",
     disableSearch: settings.disableSearch ?? false,
@@ -463118,7 +463200,7 @@ var init_DocsDefinitionResolver = __esm({
           }),
           typographyV2: this.convertDocsTypographyConfiguration(),
           layout: this.parsedDocsConfig.layout,
-          settings: this.parsedDocsConfig.settings,
+          settings: this.convertDocsSettings(),
           css: this.parsedDocsConfig.css,
           js: this.convertJavascriptConfiguration(),
           agents: this.parsedDocsConfig.agents != null || this.parsedDocsConfig.llmsTxtFile != null || this.parsedDocsConfig.llmsFullTxtFile != null || this.parsedDocsConfig.robotsTxtFile != null ? {
@@ -464377,6 +464459,25 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
           fontVariationSettings: font.fontVariationSettings
         };
       }
+      // Merges the experimental `external-sitemaps` list into `settings.search`
+      // so it is persisted through FDR and read back during Algolia reindexing.
+      // The `as` cast mirrors convertMetadata(): the published FDR SDK
+      // SearchSettingsConfig type does not yet include `externalSitemaps`, but FDR
+      // stores and serves the field at runtime.
+      convertDocsSettings() {
+        const settings = this.parsedDocsConfig.settings;
+        const externalSitemaps = this.parsedDocsConfig.experimental?.externalSitemaps;
+        if (externalSitemaps == null || externalSitemaps.length === 0) {
+          return settings;
+        }
+        return {
+          ...settings,
+          search: {
+            ...settings?.search,
+            externalSitemaps
+          }
+        };
+      }
       convertJavascriptConfiguration() {
         if (this.parsedDocsConfig.js == null) {
           return;
@@ -691395,7 +691496,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "5.77.0",
+          version: "5.79.0",
           usingAccessToken: true,
           ...getRunIdProperties()
         }
@@ -691461,7 +691562,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "5.77.0",
+        version: "5.79.0",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -872567,7 +872668,7 @@ var LOCAL_STORAGE_FOLDER4 = ".fern-dev";
 var LOGS_FOLDER_NAME = "logs";
 var MAX_LOGS_DIR_SIZE_BYTES = 100 * 1024 * 1024;
 function getCliSource() {
-  const version7 = "5.77.0";
+  const version7 = "5.79.0";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -899265,6 +899366,20 @@ var definitions6 = {
           }
         ],
         description: "Deprecated: Use `multi-source: true` on the instance instead. When enabled, docs registration uses a basepath-aware S3 key format, allowing multiple independent doc sites to be hosted under the same custom domain with different basepaths."
+      },
+      "external-sitemaps": {
+        oneOf: [
+          {
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
+          {
+            type: "null"
+          }
+        ],
+        description: "Experimental flag: a list of absolute URLs pointing to external sitemaps (`sitemap.xml`). Their pages are fetched and indexed in search alongside this site's documentation (tagged to the same domain), but are flagged as third-party so they rank below all first-party documentation."
       }
     },
     additionalProperties: false
@@ -905220,7 +905335,7 @@ var LegacyDocsPublisher = class {
         previewId,
         disableTemplates: void 0,
         skipUpload,
-        cliVersion: "5.77.0",
+        cliVersion: "5.79.0",
         loginCommand: "fern auth login"
       });
       if (taskContext.getResult() === TaskResult.Failure) {
@@ -924941,6 +925056,8 @@ var Generation = class {
     userAgentNameFromPackage: () => this.customConfig["user-agent-name-from-package"] ?? false,
     /** When true, moves auth params and IR headers into ClientOptions so the constructor takes only named arguments. Default: false. */
     unifiedClientOptions: () => this.customConfig["unified-client-options"] ?? false,
+    /** When true, exposes server URL variables as ClientOptions properties and interpolates them into the environment URL template(s) at construction time. When false, suppresses those options and the interpolation, falling back to the pre-feature base-URL behavior. Default: true. */
+    serverUrlVariables: () => this.customConfig["server-url-variables"] ?? true,
     /** When true, uses PascalCase for environment names (e.g., "Production" instead of "production"). Default: true. */
     pascalCaseEnvironments: () => this.customConfig["pascal-case-environments"] ?? true,
     /** Solution file format: "sln" generates both .sln and .slnx, "slnx" (default) generates only .slnx. */
@@ -948946,8 +949063,7 @@ var DynamicTypeLiteralMapper5 = class {
     if (!enumVariant2) {
       return rust_exports.Expression.raw(`todo!("Unknown enum variant: ${value2}")`);
     }
-    const rawVariantName = enumVariant2.name.pascalCase.unsafeName;
-    const variantName = this.context.escapeRustReservedType(rawVariantName);
+    const variantName = enumVariant2.name.pascalCase.safeName;
     return rust_exports.Expression.reference(`${enumName}::${variantName}`);
   }
   convertDiscriminatedUnionType({ unionType: unionType2, value: value2 }) {
@@ -950430,8 +950546,7 @@ var EndpointSnippetGenerator7 = class {
             if (namedType.values.length > 0) {
               const firstVariant = namedType.values[0];
               if (firstVariant) {
-                const rawVariantName = firstVariant.name.pascalCase.unsafeName;
-                const variantName = this.context.escapeRustReservedType(rawVariantName);
+                const variantName = firstVariant.name.pascalCase.safeName;
                 return rust_exports.Expression.raw(`${typeName}::${variantName}`);
               }
             }
@@ -972133,7 +972248,7 @@ function getAutomationContextFromEnv() {
     config_branch: process.env.FERN_CONFIG_BRANCH,
     config_pr_number: process.env.FERN_CONFIG_PR_NUMBER,
     trigger: process.env.GITHUB_EVENT_NAME,
-    cli_version: "5.77.0"
+    cli_version: "5.79.0"
   };
 }
 function isAutomationMode() {
@@ -972965,7 +973080,7 @@ var CliContext = class _CliContext {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "5.77.0";
+    return "5.79.0";
   }
   getCliName() {
     if (false) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.77.0",
+  "version": "5.79.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fern-api/fern.git",