feat(fdr): add header and footer properties to DocsConfig schema (#6091)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Catherine Deskur <[email protected]>
Co-authored-by: chdeskur <[email protected]>
Co-authored-by: Catherine Deskur <[email protected]>

Author: devin-ai-integration[bot]

fern/apis/fdr/definition/docs/v1/db/__package__.yml

@@ -94,6 +94,18 @@ types:
       # page actions
       pageActions: optional<commons.PageActionsConfig>
 
+      # custom components
+      header:
+        type: optional<string>
+        docs: |
+          Compiled JavaScript module for a custom React component that replaces the default header.
+          The Fern CLI transpiles the user's TSX/JSX source file and uploads the compiled JS to FDR.
+      footer:
+        type: optional<string>
+        docs: |
+          Compiled JavaScript module for a custom React component that replaces the default footer.
+          The Fern CLI transpiles the user's TSX/JSX source file and uploads the compiled JS to FDR.
+
       # deprecated
       logo:
         type: optional<rootCommons.FileId>

fern/apis/fdr/definition/docs/v1/read/__package__.yml

@@ -132,6 +132,18 @@ types:
       # page actions
       pageActions: optional<commons.PageActionsConfig>
 
+      # custom components
+      header:
+        type: optional<string>
+        docs: |
+          Compiled JavaScript module for a custom React component that replaces the default header.
+          The Fern CLI transpiles the user's TSX/JSX source file and uploads the compiled JS to FDR.
+      footer:
+        type: optional<string>
+        docs: |
+          Compiled JavaScript module for a custom React component that replaces the default footer.
+          The Fern CLI transpiles the user's TSX/JSX source file and uploads the compiled JS to FDR.
+
       # deprecated
       # backgroundImage:
       #   type: optional<rootCommons.FileId>

fern/apis/fdr/definition/docs/v1/write/__package__.yml

@@ -132,6 +132,18 @@ types:
       # page actions
       pageActions: optional<commons.PageActionsConfig>
 
+      # custom components
+      header:
+        type: optional<string>
+        docs: |
+          Compiled JavaScript module for a custom React component that replaces the default header.
+          The Fern CLI transpiles the user's TSX/JSX source file and uploads the compiled JS to FDR.
+      footer:
+        type: optional<string>
+        docs: |
+          Compiled JavaScript module for a custom React component that replaces the default footer.
+          The Fern CLI transpiles the user's TSX/JSX source file and uploads the compiled JS to FDR.
+
       # deprecated
       backgroundImage: optional<rootCommons.FileId>
       logoV2: optional<commons.ThemedFileId>

packages/cdk/package.json

@@ -16,13 +16,13 @@
   "scripts": {
     "build": "tsc",
     "cdk": "cdk",
-    "deploy-app:dev2": "pnpm build && cdk deploy local-preview-bundle4-dev2 --require-approval never --progress events",
-    "deploy-app:prod": "pnpm build && cdk deploy local-preview-bundle4-prod --require-approval never --progress events",
     "deploy:dev2": "pnpm build && cdk deploy local-preview-bundle2-dev2 --require-approval never --progress events",
     "deploy:prod": "pnpm build && cdk deploy local-preview-bundle2-prod --require-approval never --progress events",
+    "deploy-app:dev2": "pnpm build && cdk deploy local-preview-bundle4-dev2 --require-approval never --progress events",
+    "deploy-app:prod": "pnpm build && cdk deploy local-preview-bundle4-prod --require-approval never --progress events",
     "docs:local:zipBundle": "ts-node --compiler-options='{\"module\":\"commonjs\"}' scripts/zipLocalBundle.ts",
-    "synth-app:dev2": "pnpm build && cdk synth local-preview-bundle4-dev2",
-    "synth:dev2": "pnpm build && cdk synth local-preview-bundle2-dev2"
+    "synth:dev2": "pnpm build && cdk synth local-preview-bundle2-dev2",
+    "synth-app:dev2": "pnpm build && cdk synth local-preview-bundle4-dev2"
   },
   "dependencies": {
     "@fern-fern/fern-cloud-sdk": "^0.0.305",

packages/commons/fdr-utils/src/definition-object-factory.ts

@@ -43,6 +43,8 @@ export class DefinitionObjectFactory {
                 integrations: undefined,
                 css: undefined,
                 js: undefined,
+                header: undefined,
+                footer: undefined,
                 aiChatConfig: undefined,
                 pageActions: undefined
             },