feat: audience filters

fern-api · Oct 10, 2024 · 9f3c4ff · 9f3c4ff
1 parent af711fa
commit 9f3c4ff
Show file tree

Hide file tree

Showing 18 changed files with 255 additions and 40 deletions.
diff --git a/fern/apis/fdr/definition/commons.yml b/fern/apis/fdr/definition/commons.yml
@@ -43,6 +43,8 @@ types:
 
   PropertyKey: string
 
+  AudienceId: string
+
   EndpointIdentifier:
     properties:
       path: EndpointPathLiteral

diff --git a/fern/apis/fdr/definition/navigation/latest/__package__.yml b/fern/apis/fdr/definition/navigation/latest/__package__.yml
@@ -334,8 +334,21 @@ types:
         type: optional<Slug>
         docs: The slug that should be used in the canonical URL rel. If not provided, the `slug` will be used.
       icon: optional<string>
-      hidden: optional<boolean>
-      authed: optional<boolean>
+      hidden:
+        type: optional<boolean>
+        docs: If true, this node will not be displayed in the sidebar, and noindex will be considered true.
+      authed:
+        type: optional<boolean>
+        docs: |
+          If true, this node is only visible to authenticated users.
+          If false, this node is only visible to all users (including anonymous).
+      audience:
+        type: optional<list<commons.AudienceId>>
+        availability: in-development
+        docs: |
+          The audience(s) that this node is intended for. If not provided, the node is intended for all audiences.
+          If provided, the node is only intended for the specified audience(s). OR logic is used for multiple audiences on a single node.
+          AND logic is used when evaluating audiences up the tree.
 
   WithPage:
     properties:

diff --git a/packages/fdr-sdk/src/client/generated/api/resources/commons/types/AudienceId.ts b/packages/fdr-sdk/src/client/generated/api/resources/commons/types/AudienceId.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/commons/types/index.ts b/packages/fdr-sdk/src/client/generated/api/resources/commons/types/index.ts
diff --git a/.../src/client/generated/api/resources/navigation/resources/latest/types/WithNodeMetadata.ts b/.../src/client/generated/api/resources/navigation/resources/latest/types/WithNodeMetadata.ts
diff --git a/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts b/packages/fdr-sdk/src/navigation/migrators/v1ToV2.ts
@@ -31,6 +31,7 @@ export class FernNavigationV1ToLatest {
             icon: node.icon,
             hidden: node.hidden,
             authed: undefined,
+            audience: undefined,
         };
 
         return latest;
@@ -100,6 +101,7 @@ export class FernNavigationV1ToLatest {
             authed: undefined,
             id: FernNavigation.NodeId(node.id),
             pointsTo: node.pointsTo ? FernNavigation.Slug(node.pointsTo) : undefined,
+            audience: undefined,
         };
         return latest;
     };
@@ -124,6 +126,7 @@ export class FernNavigationV1ToLatest {
             id: FernNavigation.NodeId(node.id),
             pageId: FernNavigation.PageId(node.pageId),
             noindex: node.noindex,
+            audience: undefined,
         };
         return latest;
     };
@@ -161,6 +164,7 @@ export class FernNavigationV1ToLatest {
             authed: undefined,
             id: FernNavigation.NodeId(node.id),
             pointsTo: node.pointsTo ? FernNavigation.Slug(node.pointsTo) : undefined,
+            audience: undefined,
         };
         return latest;
     };
@@ -261,6 +265,7 @@ export class FernNavigationV1ToLatest {
                 versioned: (value) => this.versioned(value, [...parents, node]),
             }),
             subtitle: node.subtitle,
+            audience: undefined,
         };
         return latest;
     };
@@ -315,6 +320,7 @@ export class FernNavigationV1ToLatest {
             authed: undefined,
             pageId: FernNavigation.PageId(node.pageId),
             noindex: node.noindex,
+            audience: undefined,
         };
         return latest;
     };
@@ -346,6 +352,7 @@ export class FernNavigationV1ToLatest {
             collapsed: node.collapsed,
             overviewPageId,
             noindex: node.noindex,
+            audience: undefined,
         };
         return latest;
     };
@@ -383,6 +390,7 @@ export class FernNavigationV1ToLatest {
             apiDefinitionId: node.apiDefinitionId,
             availability: this.#availability(node.availability),
             pointsTo: node.pointsTo ? FernNavigation.Slug(node.pointsTo) : undefined,
+            audience: undefined,
         };
         return latest;
     };
@@ -412,6 +420,7 @@ export class FernNavigationV1ToLatest {
             authed: undefined,
             overviewPageId,
             noindex: node.noindex,
+            audience: undefined,
         };
         return latest;
     };
@@ -431,6 +440,7 @@ export class FernNavigationV1ToLatest {
             hidden: node.hidden,
             authed: undefined,
             year: node.year,
+            audience: undefined,
         };
         return latest;
     };
@@ -450,6 +460,7 @@ export class FernNavigationV1ToLatest {
             hidden: node.hidden,
             authed: undefined,
             month: node.month,
+            audience: undefined,
         };
         return latest;
     };
@@ -475,6 +486,7 @@ export class FernNavigationV1ToLatest {
             date: node.date,
             pageId: FernNavigation.PageId(node.pageId),
             noindex: node.noindex,
+            audience: undefined,
         };
         return latest;
     };
@@ -508,6 +520,7 @@ export class FernNavigationV1ToLatest {
             noindex: node.noindex,
             apiDefinitionId: node.apiDefinitionId,
             availability: this.#availability(node.availability),
+            audience: undefined,
         };
         return latest;
     };
@@ -539,6 +552,7 @@ export class FernNavigationV1ToLatest {
             method: node.method,
             endpointId: node.endpointId,
             isResponseStream: node.isResponseStream,
+            audience: undefined,
         };
         return latest;
     };
@@ -581,6 +595,7 @@ export class FernNavigationV1ToLatest {
             apiDefinitionId: node.apiDefinitionId,
             availability: this.#availability(node.availability),
             webSocketId: node.webSocketId,
+            audience: undefined,
         };
         return latest;
     };
@@ -610,6 +625,7 @@ export class FernNavigationV1ToLatest {
             availability: this.#availability(node.availability),
             method: node.method,
             webhookId: node.webhookId,
+            audience: undefined,
         };
         return latest;
     };

diff --git a/packages/fdr-sdk/src/navigation/utils/__test__/pruneNavigationTree.test.ts b/packages/fdr-sdk/src/navigation/utils/__test__/pruneNavigationTree.test.ts
@@ -20,6 +20,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -30,6 +31,7 @@ describe("pruneNavigationTree", () => {
             overviewPageId: undefined,
             noindex: undefined,
             pointsTo: undefined,
+            audience: undefined,
         };
 
         const result = Pruner.from(root)
@@ -56,6 +58,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -66,6 +69,7 @@ describe("pruneNavigationTree", () => {
             overviewPageId: undefined,
             noindex: undefined,
             pointsTo: FernNavigation.Slug("root/page"),
+            audience: undefined,
         });
     });
 
@@ -87,6 +91,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -97,6 +102,7 @@ describe("pruneNavigationTree", () => {
             overviewPageId: undefined,
             noindex: undefined,
             pointsTo: FernNavigation.Slug("root/page"),
+            audience: undefined,
         };
 
         const result = Pruner.from(root)
@@ -125,6 +131,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -134,6 +141,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: undefined,
+            audience: undefined,
         };
 
         const result = Pruner.from(root)
@@ -161,6 +169,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -170,6 +179,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: FernNavigation.Slug("root/page"),
+            audience: undefined,
         });
     });
 
@@ -192,6 +202,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -201,6 +212,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: undefined,
+            audience: undefined,
         };
 
         const result = Pruner.from(root)
@@ -224,6 +236,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: undefined,
+            audience: undefined,
         });
     });
 
@@ -246,6 +259,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -255,6 +269,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: undefined,
+            audience: undefined,
         };
 
         const result = Pruner.from(root)
@@ -282,6 +297,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -291,6 +307,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: FernNavigation.Slug("root/page"),
+            audience: undefined,
         });
     });
 
@@ -320,6 +337,7 @@ describe("pruneNavigationTree", () => {
                             hidden: undefined,
                             authed: undefined,
                             noindex: undefined,
+                            audience: undefined,
                         },
                     ],
                     collapsed: undefined,
@@ -329,6 +347,7 @@ describe("pruneNavigationTree", () => {
                     authed: undefined,
                     noindex: undefined,
                     pointsTo: undefined,
+                    audience: undefined,
                 },
                 {
                     type: "page",
@@ -341,6 +360,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -350,6 +370,7 @@ describe("pruneNavigationTree", () => {
             authed: undefined,
             noindex: undefined,
             pointsTo: undefined,
+            audience: undefined,
         };
 
         const result = Pruner.from(root)
@@ -377,6 +398,7 @@ describe("pruneNavigationTree", () => {
                     hidden: undefined,
                     authed: undefined,
                     noindex: undefined,
+                    audience: undefined,
                 },
             ],
             collapsed: undefined,
@@ -385,6 +407,7 @@ describe("pruneNavigationTree", () => {
             hidden: undefined,
             authed: undefined,
             noindex: undefined,
+            audience: undefined,
 
             // NOTE: points to is updated!
             pointsTo: "root/page",