fern-api 0.19.2 → 0.19.3

package/bundle.cjs

@@ -797931,7 +797931,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.19.2",
+          version: "0.19.3",
           usingAccessToken: true
         }
       });
@@ -797993,7 +797993,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.19.2",
+        version: "0.19.3",
         ...event,
         ...event.properties
       }
@@ -824771,10 +824771,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.19.2" == null) {
+    if ("0.19.3" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.19.2";
+    return "0.19.3";
   }
   getCliName() {
     if ("fern" == null) {
@@ -841003,10 +841003,6 @@ async function runRemoteGenerationForAPIWorkspace({ organization, workspace, con
   };
 }
 
-// pnp:/home/circleci/project/packages/cli/config-management/docs-configuration/lib/parseDocsConfiguration.js
-var import_fdr_sdk3 = __toESM(require_dist());
-var import_promises40 = require("fs/promises");
-
 // pnp:/home/circleci/project/.yarn/cache/tinycolor2-npm-1.6.0-8df41252c6-6df4d07fce.zip/node_modules/tinycolor2/esm/tinycolor.js
 function _typeof2(obj) {
   "@babel/helpers - typeof";
@@ -841986,6 +841982,7 @@ function validateWCAG2Parms(parms) {
 
 // pnp:/home/circleci/project/packages/cli/config-management/docs-configuration/lib/convertColorsConfiguration.js
 function convertColorsConfiguration(rawConfig, context) {
+  rawConfig.accentPrimary = rawConfig.accentPrimary ?? rawConfig.accentPrimaryDeprecated;
   const colorType = getColorType(rawConfig);
   switch (colorType) {
     case "dark":
@@ -842041,74 +842038,46 @@ function getColorType({ background, accentPrimary, accentPrimaryDeprecated }) {
 }
 function convertThemedColorConfig(rawConfig, context, theme) {
   var _a2, _b2, _c2, _d;
-  let accentPrimaryColor = getColorInstanceFromRawConfig(rawConfig.accentPrimary, context, "accent-primary", theme) ?? tinycolor.random();
-  let backgroundColor = getColorInstanceFromRawConfig(rawConfig.background, context, "background", theme);
-  if (backgroundColor != null) {
-    const newBackgroundColor = enforceBackgroundTheme(tinycolor(backgroundColor.toString()), theme);
-    if (newBackgroundColor.toHexString() !== backgroundColor.toHexString()) {
-      context.logger.warn(`The chosen shade, 'colors.background' in ${theme} mode, fails to meet minimum contrast requirements. The brightness is ${backgroundColor.getBrightness()}. To enhance accessibility and ensure content readability, Fern will adjust from ${backgroundColor.toHexString()} to a more contrast-rich ${newBackgroundColor.toHexString()}.`);
-      backgroundColor = newBackgroundColor;
-    }
-  }
-  if (accentPrimaryColor != null) {
-    const backgroundColorWithFallback = backgroundColor ?? tinycolor(theme === "dark" ? "#000" : "#FFF");
-    const newAccentPrimaryColor = increaseForegroundContrast(tinycolor(accentPrimaryColor.toString()), backgroundColorWithFallback);
-    if (newAccentPrimaryColor.toHexString() !== accentPrimaryColor.toHexString()) {
-      const ratio = tinycolor.readability(accentPrimaryColor, backgroundColorWithFallback);
-      context.logger.warn(`The chosen shade, 'colors.accent-primary' in ${theme} mode, fails to meet minimum contrast requirements. The contrast ratio is ${ratio}, which is below WCAG AA requirements (4.5:1). To enhance accessibility and ensure content readability, Fern will adjust from ${accentPrimaryColor.toHexString()} to a more contrast-rich ${newAccentPrimaryColor.toHexString()}.`);
-      accentPrimaryColor = newAccentPrimaryColor;
-    }
-  }
+  const accentPrimaryColor = getColorInstanceFromRawConfigOrThrow(rawConfig.accentPrimary ?? rawConfig.accentPrimaryDeprecated, context, "accent-primary", theme) ?? tinycolor.random();
+  const backgroundColor = getColorInstanceFromRawConfigOrThrow(rawConfig.background, context, "background", theme);
   return {
     accentPrimary: accentPrimaryColor.toRgb(),
     background: backgroundColor == null ? void 0 : backgroundColor.toRgb(),
-    border: (_a2 = getColorInstanceFromRawConfig(rawConfig.border, context, "border", theme)) == null ? void 0 : _a2.toRgb(),
-    sidebarBackground: (_b2 = getColorInstanceFromRawConfig(rawConfig.sidebarBackground, context, "sidebar-background", theme)) == null ? void 0 : _b2.toRgb(),
-    headerBackground: (_c2 = getColorInstanceFromRawConfig(rawConfig.headerBackground, context, "header-background", theme)) == null ? void 0 : _c2.toRgb(),
-    cardBackground: (_d = getColorInstanceFromRawConfig(rawConfig.cardBackground, context, "card-background", theme)) == null ? void 0 : _d.toRgb()
+    border: (_a2 = getColorInstanceFromRawConfigOrThrow(rawConfig.border, context, "border", theme)) == null ? void 0 : _a2.toRgb(),
+    sidebarBackground: (_b2 = getColorInstanceFromRawConfigOrThrow(rawConfig.sidebarBackground, context, "sidebar-background", theme)) == null ? void 0 : _b2.toRgb(),
+    headerBackground: (_c2 = getColorInstanceFromRawConfigOrThrow(rawConfig.headerBackground, context, "header-background", theme)) == null ? void 0 : _c2.toRgb(),
+    cardBackground: (_d = getColorInstanceFromRawConfigOrThrow(rawConfig.cardBackground, context, "card-background", theme)) == null ? void 0 : _d.toRgb()
   };
 }
-function increaseForegroundContrast(foregroundColor, backgroundColor) {
-  let newForgroundColor = foregroundColor;
-  const dark = backgroundColor.isDark();
-  while (!tinycolor.isReadable(newForgroundColor, backgroundColor)) {
-    if (dark ? newForgroundColor.getBrightness() === 255 : newForgroundColor.getBrightness() === 0) {
-      break;
-    }
-    newForgroundColor = dark ? newForgroundColor.lighten(1) : newForgroundColor.darken(1);
+function getColorFromRawConfig(raw, key2, theme) {
+  if (raw == null) {
+    return void 0;
   }
-  return newForgroundColor;
-}
-function enforceBackgroundTheme(color3, theme) {
-  if (theme === "dark" && color3.isDark()) {
-    return color3;
-  } else if (theme === "light" && color3.isLight()) {
-    return color3;
+  let rawColor = typeof raw === "string" ? raw : raw[theme];
+  if (rawColor == null && key2 === "accent-primary" && typeof raw !== "string") {
+    rawColor = raw[theme === "dark" ? "light" : "dark"];
   }
-  return getOppositeBrightness(color3);
-}
-function getOppositeBrightness(color3) {
-  if (color3 == null) {
+  if (rawColor == null) {
     return void 0;
   }
-  const { h: h3, s: s2, v: v2 } = color3.toHsv();
-  return tinycolor({ h: h3, s: s2, v: 1 - v2 });
+  return rawColor;
 }
-function getColorInstanceFromRawConfig(raw, context, key2, theme) {
-  if (raw == null) {
-    return void 0;
-  }
-  const rawColor = typeof raw === "string" ? raw : raw[theme];
-  if (rawColor == null) {
+function getColorInstanceFromRawConfigOrThrow(raw, context, key2, theme) {
+  const color3 = getColorFromRawConfig(raw, key2, theme);
+  if (color3 == null) {
     return void 0;
   }
-  const color3 = tinycolor(rawColor);
-  if (!color3.isValid()) {
+  const instance = tinycolor(color3);
+  if (!instance.isValid()) {
     context.failAndThrow(`'${typeof raw === "string" ? key2 : `colors.${key2}.${theme}`}' should be a hex color of the format #FFFFFF`);
   }
-  return color3;
+  return instance;
 }
 
+// pnp:/home/circleci/project/packages/cli/config-management/docs-configuration/lib/parseDocsConfiguration.js
+var import_fdr_sdk3 = __toESM(require_dist());
+var import_promises40 = require("fs/promises");
+
 // pnp:/home/circleci/project/packages/cli/config-management/docs-configuration/lib/getAllPages.js
 var import_promises39 = require("fs/promises");
 async function getAllPages({ navigation, absolutePathToFernFolder }) {
@@ -843441,6 +843410,95 @@ function createDocsConfigFileAstVisitorForRules({ relativeFilepath, allRuleVisit
   };
 }
 
+// pnp:/home/circleci/project/packages/cli/yaml/docs-validator/lib/rules/accent-color-contrast/index.js
+var AccentColorContrastRule = {
+  name: "accent-color-contrast",
+  create: () => {
+    return {
+      file: async ({ config }) => {
+        if (config.colors == null) {
+          return [];
+        }
+        const colorType = getColorType(config.colors);
+        if (colorType === "dark") {
+          return validateTheme(config.colors, "dark");
+        } else if (colorType === "light") {
+          return validateTheme(config.colors, "light");
+        } else if (colorType === "darkAndLight") {
+          return [...validateTheme(config.colors, "dark"), ...validateTheme(config.colors, "light")];
+        }
+        return [];
+      }
+    };
+  }
+};
+function validateTheme(colors, theme) {
+  const accentPrimaryColor = getColorFromRawConfig(colors.accentPrimary ?? colors.accentPrimaryDeprecated, "accent-primary", theme);
+  let backgroundColor = getColorFromRawConfig(colors.background, "background", theme) ?? (theme === "dark" ? "#000" : "#FFF");
+  const ruleViolations = [];
+  if (!tinycolor(backgroundColor).isValid()) {
+    ruleViolations.push({
+      severity: "error",
+      message: `Invalid background color provided for colors.background.${theme}: ${backgroundColor}.`
+    });
+  } else {
+    const newBackground = enforceBackgroundTheme(tinycolor(backgroundColor), theme);
+    if (tinycolor(backgroundColor).toHexString() !== newBackground.toHexString()) {
+      ruleViolations.push({
+        severity: "warning",
+        message: `The provided background color for ${theme} mode is not ${theme} enough. It will be adjusted to ${newBackground.toHexString()}.`
+      });
+    }
+    backgroundColor = newBackground.toHexString();
+  }
+  if (accentPrimaryColor == null) {
+    ruleViolations.push({
+      severity: "warning",
+      message: `No accent-color provided for ${theme} mode. A random color will be used.`
+    });
+  } else if (!tinycolor(accentPrimaryColor).isValid()) {
+    ruleViolations.push({
+      severity: "error",
+      message: `Invalid accent-color provided for colors.accent-primary.${theme}: ${accentPrimaryColor}.`
+    });
+  } else {
+    const ratio = tinycolor.readability(accentPrimaryColor, backgroundColor);
+    const readableRatio = `${ratio.toFixed(2)}:1`;
+    if (ratio < 3) {
+      ruleViolations.push({
+        severity: "warning",
+        message: `The contrast ratio between the accent color and the background color for ${theme} mode is ${readableRatio}. It should be at least 3:1.`
+      });
+    } else if (ratio < 4.5) {
+      ruleViolations.push({
+        severity: "warning",
+        message: `The contrast ratio between the accent color and the background color for ${theme} mode is ${readableRatio}. Fern will adjust the color to meet the minimum contrast ratio of 4.5:1 for WCAG AA and 7:1 for WCAG AAA.`
+      });
+    } else if (ratio < 7) {
+      ruleViolations.push({
+        severity: "warning",
+        message: `The contrast ratio between the accent color and the background color for ${theme} mode is ${readableRatio}. Fern will adjust the color to meet the minimum contrast ratio of 7:1 for WCAG AAA.`
+      });
+    }
+  }
+  return ruleViolations;
+}
+function enforceBackgroundTheme(color3, theme) {
+  if (theme === "dark" && color3.isDark()) {
+    return color3;
+  } else if (theme === "light" && color3.isLight()) {
+    return color3;
+  }
+  return getOppositeBrightness(color3);
+}
+function getOppositeBrightness(color3) {
+  if (color3 == null) {
+    return void 0;
+  }
+  const { h: h3, s: s2, v: v2 } = color3.toHsv();
+  return tinycolor({ h: h3, s: s2, v: 1 - v2 });
+}
+
 // pnp:/home/circleci/project/packages/cli/yaml/docs-validator/lib/rules/filepaths-exist/filepaths-exist.js
 var FilepathsExistRule = {
   name: "filepaths-exist",
@@ -868868,7 +868926,13 @@ var ValidateVersionFileRule = {
 
 // pnp:/home/circleci/project/packages/cli/yaml/docs-validator/lib/getAllRules.js
 function getAllRules2() {
-  return [FilepathsExistRule, ValidMarkdownRule, OnlyVersionedNavigation, ValidateVersionFileRule];
+  return [
+    FilepathsExistRule,
+    ValidMarkdownRule,
+    OnlyVersionedNavigation,
+    ValidateVersionFileRule,
+    AccentColorContrastRule
+  ];
 }
 
 // pnp:/home/circleci/project/packages/cli/yaml/docs-validator/lib/validateDocsWorkspace.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fern-api",
-  "version": "0.19.2",
+  "version": "0.19.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern.git",