@fern-api/fern-api-dev 4.86.2-4-g75bedd9a37f → 4.86.2-6-g0387580a729

package/cli.cjs

@@ -502635,6 +502635,16 @@ var MetadataConfig = external_exports.object({
   "twitter:site": external_exports.string().optional(),
   "twitter:url": external_exports.string().optional(),
   "twitter:card": TwitterCardSetting.optional(),
+  "og:dynamic": external_exports.boolean().optional(),
+  "og:background-image": external_exports.string().optional(),
+  "og:dynamic:text-color": external_exports.string().optional(),
+  "og:dynamic:background-color": external_exports.string().optional(),
+  "og:dynamic:logo-color": external_exports.enum(["dark", "light"]).optional(),
+  "og:dynamic:show-logo": external_exports.boolean().optional(),
+  "og:dynamic:show-section": external_exports.boolean().optional(),
+  "og:dynamic:show-description": external_exports.boolean().optional(),
+  "og:dynamic:show-url": external_exports.boolean().optional(),
+  "og:dynamic:show-gradient": external_exports.boolean().optional(),
   "canonical-host": external_exports.string().optional()
 });
 var RedirectConfig = external_exports.object({
@@ -502957,6 +502967,7 @@ __export(schemas_exports7, {
   Language: () => Language2,
   LanguageSwitcherThemeConfig: () => LanguageSwitcherThemeConfig2,
   LibraryLanguage: () => LibraryLanguage2,
+  OgDynamicLogoColor: () => OgDynamicLogoColor,
   PageActionOption: () => PageActionOption2,
   PageActionsThemeConfig: () => PageActionsThemeConfig2,
   PageDescriptionSource: () => PageDescriptionSource2,
@@ -502998,6 +503009,7 @@ __export(api_exports2, {
   Language: () => Language2,
   LanguageSwitcherThemeConfig: () => LanguageSwitcherThemeConfig2,
   LibraryLanguage: () => LibraryLanguage2,
+  OgDynamicLogoColor: () => OgDynamicLogoColor,
   PageActionOption: () => PageActionOption2,
   PageActionsThemeConfig: () => PageActionsThemeConfig2,
   PageDescriptionSource: () => PageDescriptionSource2,
@@ -503036,6 +503048,7 @@ __export(docs_exports, {
   Language: () => Language2,
   LanguageSwitcherThemeConfig: () => LanguageSwitcherThemeConfig2,
   LibraryLanguage: () => LibraryLanguage2,
+  OgDynamicLogoColor: () => OgDynamicLogoColor,
   PageActionOption: () => PageActionOption2,
   PageActionsThemeConfig: () => PageActionsThemeConfig2,
   PageDescriptionSource: () => PageDescriptionSource2,
@@ -503298,6 +503311,12 @@ var TwitterCardSetting2 = {
   Player: "player"
 };
 
+// ../configuration/lib/docs-yml/schemas/sdk/api/resources/docs/types/OgDynamicLogoColor.js
+var OgDynamicLogoColor = {
+  Dark: "dark",
+  Light: "light"
+};
+
 // ../configuration/lib/docs-yml/schemas/sdk/api/resources/docs/types/VersionAvailability.js
 var VersionAvailability2 = {
   Deprecated: "deprecated",
@@ -503580,6 +503599,7 @@ __export(serialization_exports3, {
   NavbarLinkConfig: () => NavbarLinkConfig2,
   NavigationConfig: () => NavigationConfig2,
   NavigationItem: () => NavigationItem2,
+  OgDynamicLogoColor: () => OgDynamicLogoColor2,
   PageActionOption: () => PageActionOption3,
   PageActionOptions: () => PageActionOptions2,
   PageActionsConfig: () => PageActionsConfig2,
@@ -503728,6 +503748,7 @@ __export(docs_exports2, {
   NavbarLinkConfig: () => NavbarLinkConfig2,
   NavigationConfig: () => NavigationConfig2,
   NavigationItem: () => NavigationItem2,
+  OgDynamicLogoColor: () => OgDynamicLogoColor2,
   PageActionOption: () => PageActionOption3,
   PageActionOptions: () => PageActionOptions2,
   PageActionsConfig: () => PageActionsConfig2,
@@ -505833,6 +505854,9 @@ var LogoConfiguration2 = schemas_exports6.object({
   rightText: schemas_exports6.property("right-text", schemas_exports6.string().optional())
 });
 
+// ../configuration/lib/docs-yml/schemas/sdk/serialization/resources/docs/types/OgDynamicLogoColor.js
+var OgDynamicLogoColor2 = schemas_exports6.enum_(["dark", "light"]);
+
 // ../configuration/lib/docs-yml/schemas/sdk/serialization/resources/docs/types/TwitterCardSetting.js
 var TwitterCardSetting3 = schemas_exports6.enum_(["summary", "summary_large_image", "app", "player"]);
 
@@ -505856,6 +505880,14 @@ var MetadataConfig2 = schemas_exports6.object({
   twitterCard: schemas_exports6.property("twitter:card", TwitterCardSetting3.optional()),
   ogDynamic: schemas_exports6.property("og:dynamic", schemas_exports6.boolean().optional()),
   ogBackgroundImage: schemas_exports6.property("og:background-image", schemas_exports6.string().optional()),
+  ogDynamicTextColor: schemas_exports6.property("og:dynamic:text-color", schemas_exports6.string().optional()),
+  ogDynamicBackgroundColor: schemas_exports6.property("og:dynamic:background-color", schemas_exports6.string().optional()),
+  ogDynamicLogoColor: schemas_exports6.property("og:dynamic:logo-color", OgDynamicLogoColor2.optional()),
+  ogDynamicShowLogo: schemas_exports6.property("og:dynamic:show-logo", schemas_exports6.boolean().optional()),
+  ogDynamicShowSection: schemas_exports6.property("og:dynamic:show-section", schemas_exports6.boolean().optional()),
+  ogDynamicShowDescription: schemas_exports6.property("og:dynamic:show-description", schemas_exports6.boolean().optional()),
+  ogDynamicShowUrl: schemas_exports6.property("og:dynamic:show-url", schemas_exports6.boolean().optional()),
+  ogDynamicShowGradient: schemas_exports6.property("og:dynamic:show-gradient", schemas_exports6.boolean().optional()),
   canonicalHost: schemas_exports6.property("canonical-host", schemas_exports6.string().optional())
 });
 
@@ -536405,7 +536437,7 @@ async function parseDocsConfiguration({ rawDocsConfiguration, absolutePathToFern
   }) : void 0;
   const cssPromise = convertCssConfig(rawCssConfig, absoluteFilepathToDocsConfig);
   const jsPromise = convertJsConfig(rawJsConfig, absoluteFilepathToDocsConfig);
-  const metadataPromise = convertMetadata(rawMetadata, absoluteFilepathToDocsConfig);
+  const metadataPromise = convertMetadata(rawMetadata, absoluteFilepathToDocsConfig, context3);
   const context7FilePromise = parseContext7File({
     rawPath: rawDocsConfiguration.integrations?.context7,
     absoluteFilepathToDocsConfig,
@@ -537550,10 +537582,11 @@ function convertFooterLinks(footerLinks) {
   }
   return links;
 }
-async function convertMetadata(metadata, absoluteFilepathToDocsConfig) {
+async function convertMetadata(metadata, absoluteFilepathToDocsConfig, context3) {
   if (metadata == null) {
     return void 0;
   }
+  warnOnMetadataConflicts(metadata, context3);
   return {
     "og:site_name": metadata.ogSiteName,
     "og:title": metadata.ogTitle,
@@ -537573,11 +537606,54 @@ async function convertMetadata(metadata, absoluteFilepathToDocsConfig) {
     "twitter:card": metadata.twitterCard,
     "og:dynamic": metadata.ogDynamic,
     "og:background-image": await convertFilepathOrUrl(metadata.ogBackgroundImage, absoluteFilepathToDocsConfig),
+    "og:dynamic:text-color": metadata.ogDynamicTextColor,
+    "og:dynamic:background-color": metadata.ogDynamicBackgroundColor,
+    "og:dynamic:logo-color": metadata.ogDynamicLogoColor,
+    "og:dynamic:show-logo": metadata.ogDynamicShowLogo,
+    "og:dynamic:show-section": metadata.ogDynamicShowSection,
+    "og:dynamic:show-description": metadata.ogDynamicShowDescription,
+    "og:dynamic:show-url": metadata.ogDynamicShowUrl,
+    "og:dynamic:show-gradient": metadata.ogDynamicShowGradient,
     nofollow: void 0,
     noindex: void 0,
     canonicalHost: metadata.canonicalHost
   };
 }
+function warnOnMetadataConflicts(metadata, context3) {
+  const dynamicEnabled = metadata.ogDynamic === true;
+  const dynamicSettings = [
+    ["og:background-image", metadata.ogBackgroundImage],
+    ["og:dynamic:text-color", metadata.ogDynamicTextColor],
+    ["og:dynamic:background-color", metadata.ogDynamicBackgroundColor],
+    ["og:dynamic:logo-color", metadata.ogDynamicLogoColor],
+    ["og:dynamic:show-logo", metadata.ogDynamicShowLogo],
+    ["og:dynamic:show-section", metadata.ogDynamicShowSection],
+    ["og:dynamic:show-description", metadata.ogDynamicShowDescription],
+    ["og:dynamic:show-url", metadata.ogDynamicShowUrl],
+    ["og:dynamic:show-gradient", metadata.ogDynamicShowGradient]
+  ];
+  if (dynamicEnabled && metadata.ogImage != null) {
+    context3.logger.warn("[metadata] `og:image` is only applied to the homepage when `og:dynamic: true`. All other pages show the dynamically generated image. Remove `og:image` to rely entirely on dynamic generation, or set `og:dynamic: false` to use `og:image` site-wide.");
+  }
+  if (dynamicEnabled && metadata.twitterImage != null) {
+    context3.logger.warn("[metadata] `twitter:image` is only applied to the homepage when `og:dynamic: true`. All other pages show the dynamically generated image.");
+  }
+  if (!dynamicEnabled) {
+    const ignored = dynamicSettings.filter(([, value2]) => value2 != null).map(([key2]) => key2);
+    if (ignored.length > 0) {
+      context3.logger.warn(`[metadata] The following settings require \`og:dynamic: true\` and will be ignored: ${ignored.map((k5) => `\`${k5}\``).join(", ")}.`);
+    }
+  }
+  if (dynamicEnabled && metadata.ogDynamicShowLogo === false && metadata.ogDynamicLogoColor != null) {
+    context3.logger.warn("[metadata] `og:dynamic:logo-color` has no effect because `og:dynamic:show-logo: false`. Remove one or the other.");
+  }
+  if (metadata.ogImage == null && (metadata.ogImageWidth != null || metadata.ogImageHeight != null)) {
+    context3.logger.warn("[metadata] `og:image:width` / `og:image:height` have no effect without `og:image`.");
+  }
+  if (dynamicEnabled && typeof metadata.ogDynamicTextColor === "string" && typeof metadata.ogDynamicBackgroundColor === "string" && metadata.ogDynamicTextColor.trim().toLowerCase() === metadata.ogDynamicBackgroundColor.trim().toLowerCase()) {
+    context3.logger.warn(`[metadata] \`og:dynamic:text-color\` and \`og:dynamic:background-color\` are both set to \`${metadata.ogDynamicTextColor}\`, which will make text invisible in generated OG images.`);
+  }
+}
 async function convertFilepathOrUrl(value2, absoluteFilepathToDocsConfig) {
   if (value2 == null) {
     return void 0;
@@ -614832,7 +614908,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "4.86.2-4-g75bedd9a37f",
+          version: "4.86.2-6-g0387580a729",
           usingAccessToken: true
         }
       });
@@ -614886,7 +614962,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "4.86.2-4-g75bedd9a37f",
+        version: "4.86.2-6-g0387580a729",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -832408,7 +832484,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 = "4.86.2-4-g75bedd9a37f";
+  const version7 = "4.86.2-6-g0387580a729";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -840191,6 +840267,13 @@ var definitions6 = {
       "player"
     ]
   },
+  "docs.OgDynamicLogoColor": {
+    type: "string",
+    enum: [
+      "dark",
+      "light"
+    ]
+  },
   "docs.MetadataConfig": {
     type: "object",
     properties: {
@@ -840374,6 +840457,86 @@ var definitions6 = {
           }
         ]
       },
+      "og:dynamic:text-color": {
+        oneOf: [
+          {
+            type: "string"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:background-color": {
+        oneOf: [
+          {
+            type: "string"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:logo-color": {
+        oneOf: [
+          {
+            $ref: "#/definitions/docs.OgDynamicLogoColor"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:show-logo": {
+        oneOf: [
+          {
+            type: "boolean"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:show-section": {
+        oneOf: [
+          {
+            type: "boolean"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:show-description": {
+        oneOf: [
+          {
+            type: "boolean"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:show-url": {
+        oneOf: [
+          {
+            type: "boolean"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
+      "og:dynamic:show-gradient": {
+        oneOf: [
+          {
+            type: "boolean"
+          },
+          {
+            type: "null"
+          }
+        ]
+      },
       "canonical-host": {
         oneOf: [
           {
@@ -844061,7 +844224,7 @@ var LegacyDocsPublisher = class {
         previewId,
         disableTemplates: void 0,
         skipUpload,
-        cliVersion: "4.86.2-4-g75bedd9a37f"
+        cliVersion: "4.86.2-6-g0387580a729"
       });
       if (taskContext.getResult() === TaskResult.Failure) {
         return { success: false };
@@ -919449,7 +919612,7 @@ var CliContext = class _CliContext {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "4.86.2-4-g75bedd9a37f";
+    return "4.86.2-6-g0387580a729";
   }
   getCliName() {
     if (false) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.86.2-4-g75bedd9a37f",
+  "version": "4.86.2-6-g0387580a729",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fern-api/fern.git",