@fern-api/fern-api-dev 5.8.0 → 5.8.1

package/cli.cjs

@@ -511686,7 +511686,8 @@ var CheckRulesConfig = external_exports.object({
   "valid-local-references": CheckRuleSeverity.optional(),
   "no-circular-redirects": CheckRuleSeverity.optional(),
   "valid-docs-endpoints": CheckRuleSeverity.optional(),
-  "missing-redirects": CheckRuleSeverity.optional()
+  "missing-redirects": CheckRuleSeverity.optional(),
+  "valid-changelog-slug": CheckRuleSeverity.optional()
 });
 var CheckConfig = external_exports.object({
   rules: CheckRulesConfig.optional()
@@ -514649,7 +514650,8 @@ var CheckRulesConfig2 = schemas_exports6.object({
   validLocalReferences: schemas_exports6.property("valid-local-references", CheckRuleSeverity3.optional()),
   noCircularRedirects: schemas_exports6.property("no-circular-redirects", CheckRuleSeverity3.optional()),
   validDocsEndpoints: schemas_exports6.property("valid-docs-endpoints", CheckRuleSeverity3.optional()),
-  missingRedirects: schemas_exports6.property("missing-redirects", CheckRuleSeverity3.optional())
+  missingRedirects: schemas_exports6.property("missing-redirects", CheckRuleSeverity3.optional()),
+  validChangelogSlug: schemas_exports6.property("valid-changelog-slug", CheckRuleSeverity3.optional())
 });
 
 // ../configuration/lib/docs-yml/schemas/sdk/serialization/resources/docs/types/CheckConfig.js
@@ -622584,7 +622586,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "5.8.0",
+          version: "5.8.1",
           usingAccessToken: true
         }
       });
@@ -622638,7 +622640,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "5.8.0",
+        version: "5.8.1",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -819754,12 +819756,14 @@ var rules_exports = {};
 __export(rules_exports, {
   AccentColorContrastRule: () => AccentColorContrastRule,
   AllRolesMustBeDeclaredRule: () => AllRolesMustBeDeclaredRule,
+  CHANGELOG_FEED_ALLOWED_SLUGS: () => CHANGELOG_FEED_ALLOWED_SLUGS,
   FilepathsExistRule: () => FilepathsExistRule,
   MissingRedirectsRule: () => MissingRedirectsRule,
   NoCircularRedirectsRule: () => NoCircularRedirectsRule,
   OnlyVersionedNavigation: () => OnlyVersionedNavigation,
   TabWithHrefRule: () => TabWithHrefRule,
   TranslationDirectoriesExistRule: () => TranslationDirectoriesExistRule,
+  ValidChangelogSlugRule: () => ValidChangelogSlugRule,
   ValidDocsEndpoints: () => ValidDocsEndpoints,
   ValidFileTypes: () => ValidFileTypes,
   ValidFrontmatter: () => ValidFrontmatter,
@@ -819770,6 +819774,8 @@ __export(rules_exports, {
   ValidateProductFileRule: () => ValidateProductFileRule,
   ValidateVersionFileRule: () => ValidateVersionFileRule,
   enforceBackgroundTheme: () => enforceBackgroundTheme,
+  getEffectiveChangelogSlugLastSegment: () => getEffectiveChangelogSlugLastSegment,
+  isAllowedChangelogSlug: () => isAllowedChangelogSlug,
   validateTheme: () => validateTheme
 });
 
@@ -820796,6 +820802,148 @@ function buildExpectedDirectoryTree({ translationsDirExists, missingDirs, fernFo
   return lines.join("\n");
 }
 
+// ../yaml/docs-validator/lib/rules/valid-changelog-slug/valid-changelog-slug.js
+init_lodash();
+var CHANGELOG_FEED_ALLOWED_SLUGS = [
+  "changelog",
+  "changelogs",
+  "release-notes",
+  "releasenotes",
+  "whats-new",
+  "whatsnew"
+];
+var DEFAULT_CHANGELOG_TITLE3 = "Changelog";
+function getEffectiveChangelogSlugLastSegment(config5) {
+  const raw = config5.slug ?? kebabCase_default(config5.title ?? DEFAULT_CHANGELOG_TITLE3);
+  const segments = raw.split("/").filter((s9) => s9.length > 0);
+  return segments[segments.length - 1] ?? "";
+}
+function isAllowedChangelogSlug(lastSegment) {
+  return CHANGELOG_FEED_ALLOWED_SLUGS.includes(lastSegment);
+}
+function collectChangelogLocations(items, breadcrumb) {
+  if (items == null) {
+    return [];
+  }
+  const out = [];
+  for (const item of items) {
+    if (isChangelog(item)) {
+      out.push({
+        where: `${breadcrumb} > changelog (${item.changelog})`,
+        slug: item.slug,
+        title: item.title
+      });
+      continue;
+    }
+    if (isSection3(item)) {
+      const next2 = `${breadcrumb} > section "${item.section}"`;
+      out.push(...collectChangelogLocations(item.contents, next2));
+    }
+  }
+  return out;
+}
+function collectFromTabs(tabs, breadcrumb) {
+  if (tabs == null) {
+    return [];
+  }
+  const out = [];
+  for (const [tabId, tab2] of Object.entries(tabs)) {
+    if (tab2.changelog != null) {
+      out.push({
+        where: `${breadcrumb} > tab "${tabId}" (changelog: ${tab2.changelog})`,
+        slug: tab2.slug,
+        title: tab2.displayName
+      });
+    }
+  }
+  return out;
+}
+function collectFromNavigation(navigation2, breadcrumb) {
+  if (navigation2 == null || !Array.isArray(navigation2) || navigation2.length === 0) {
+    return [];
+  }
+  if (isTabbedNavigation(navigation2)) {
+    const out = [];
+    for (const item of navigation2) {
+      const next2 = `${breadcrumb} > tab "${item.tab}"`;
+      if ("layout" in item && Array.isArray(item.layout)) {
+        out.push(...collectChangelogLocations(item.layout, next2));
+      }
+      if ("variants" in item && Array.isArray(item.variants)) {
+        for (const variant of item.variants) {
+          const variantBreadcrumb = `${next2} > variant "${variant.title}"`;
+          out.push(...collectChangelogLocations(variant.layout, variantBreadcrumb));
+        }
+      }
+    }
+    return out;
+  }
+  return collectChangelogLocations(navigation2, breadcrumb);
+}
+function violationsForLocations(locations) {
+  const violations = [];
+  for (const loc of locations) {
+    const lastSegment = getEffectiveChangelogSlugLastSegment(loc);
+    if (lastSegment === "" || isAllowedChangelogSlug(lastSegment)) {
+      continue;
+    }
+    const allowed = CHANGELOG_FEED_ALLOWED_SLUGS.join(", ");
+    const sourceField = loc.slug != null ? `slug: "${loc.slug}"` : `title: "${loc.title ?? DEFAULT_CHANGELOG_TITLE3}"`;
+    violations.push({
+      severity: "error",
+      message: `Changelog at ${loc.where} resolves to URL segment "${lastSegment}" (from ${sourceField}). The docs server only serves changelog feeds (.rss, .atom, .json) when the final URL segment is one of: ${allowed}. Rename the changelog's title or set an explicit slug to one of these values, otherwise subscribers will get a 404 when they request the feed.`
+    });
+  }
+  return violations;
+}
+var ValidChangelogSlugRule = {
+  name: "valid-changelog-slug",
+  create: () => {
+    return {
+      file: async ({ config: config5 }) => {
+        const locations = [
+          ...collectFromNavigation(config5.navigation, "navigation"),
+          ...collectFromTabs(config5.tabs, "tabs")
+        ];
+        return violationsForLocations(locations);
+      },
+      versionFile: async ({ path: path106, content: content5 }) => {
+        const parseResult = await validateVersionConfigFileSchema({ value: content5 });
+        if (parseResult.type !== "success") {
+          return [];
+        }
+        const versionConfig = parseResult.contents;
+        const locations = [
+          ...collectFromNavigation(versionConfig.navigation, `version "${path106}" navigation`),
+          ...collectFromTabs(versionConfig.tabs, `version "${path106}" tabs`)
+        ];
+        return violationsForLocations(locations);
+      },
+      productFile: async ({ path: path106, content: content5 }) => {
+        const parseResult = await validateProductConfigFileSchema({ value: content5 });
+        if (parseResult.type !== "success") {
+          return [];
+        }
+        const productConfig = parseResult.contents;
+        const locations = [
+          ...collectFromNavigation(productConfig.navigation, `product "${path106}" navigation`),
+          ...collectFromTabs(productConfig.tabs, `product "${path106}" tabs`)
+        ];
+        return violationsForLocations(locations);
+      }
+    };
+  }
+};
+function isChangelog(item) {
+  return item?.changelog != null;
+}
+function isSection3(item) {
+  return item?.section != null;
+}
+function isTabbedNavigation(navigation2) {
+  return Array.isArray(navigation2) && navigation2.length > 0 && navigation2[0]?.tab != null;
+}
+
 // ../yaml/docs-validator/lib/rules/valid-docs-endpoints/valid-docs-endpoints.js
 var ValidDocsEndpoints = {
   name: "valid-docs-endpoints",
@@ -843275,7 +843423,8 @@ var allRules = [
   ValidDocsEndpoints,
   AllRolesMustBeDeclaredRule,
   ValidFrontmatter,
-  TranslationDirectoriesExistRule
+  TranslationDirectoriesExistRule,
+  ValidChangelogSlugRule
   // ValidMarkdownFileReferences
 ];
 function getAllRules3(exclusions) {
@@ -843304,7 +843453,8 @@ var CHECK_RULE_CONFIG_TO_RULE_NAME = {
   validLocalReferences: ValidLocalReferencesRule.name,
   noCircularRedirects: NoCircularRedirectsRule.name,
   validDocsEndpoints: ValidDocsEndpoints.name,
-  missingRedirects: MissingRedirectsRule.name
+  missingRedirects: MissingRedirectsRule.name,
+  validChangelogSlug: ValidChangelogSlugRule.name
 };
 function buildSeverityOverrides(checkConfig) {
   const severityOverrides = /* @__PURE__ */ new Map();
@@ -847384,7 +847534,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.8.0";
+  const version7 = "5.8.1";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -856171,6 +856321,16 @@ var definitions6 = {
             type: "null"
           }
         ]
+      },
+      "valid-changelog-slug": {
+        oneOf: [
+          {
+            $ref: "#/definitions/docs.CheckRuleSeverity"
+          },
+          {
+            type: "null"
+          }
+        ]
       }
     },
     additionalProperties: false
@@ -860027,7 +860187,7 @@ var LegacyDocsPublisher = class {
         previewId,
         disableTemplates: void 0,
         skipUpload,
-        cliVersion: "5.8.0",
+        cliVersion: "5.8.1",
         loginCommand: "fern auth login"
       });
       if (taskContext.getResult() === TaskResult.Failure) {
@@ -934469,7 +934629,7 @@ var CliContext = class _CliContext {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "5.8.0";
+    return "5.8.1";
   }
   getCliName() {
     if (false) {

package/package.json

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