(feat): set subpackage display names (#585)

fern-api · Mar 28, 2024 · 9acd72b · 9acd72b
1 parent 59cfb48
commit 9acd72b
Show file tree

Hide file tree

Showing 8 changed files with 108 additions and 1 deletion.
diff --git a/fern/apis/fdr/definition/api/v1/db/__package__.yml b/fern/apis/fdr/definition/api/v1/db/__package__.yml
@@ -48,3 +48,4 @@ types:
       subpackageId: readRoot.SubpackageId
       name: string
       urlSlug: string
+      displayName: optional<string>
diff --git a/fern/apis/fdr/definition/api/v1/read/__package__.yml b/fern/apis/fdr/definition/api/v1/read/__package__.yml
@@ -78,6 +78,7 @@ types:
       subpackageId: SubpackageId
       name: string
       urlSlug: string
+      displayName: optional<string>
 
   SubpackageId: string
 

diff --git a/fern/apis/fdr/definition/api/v1/register/__package__.yml b/fern/apis/fdr/definition/api/v1/register/__package__.yml
@@ -103,6 +103,7 @@ types:
     properties:
       subpackageId: SubpackageId
       name: string
+      displayName: optional<string>
 
   SubpackageId: string
 

diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "test": "CI=true turbo test",
+    "test:update": "CI=true turbo test -- -u",
     "test:playwright": "pnpm exec playwright test --debug",
     "clean": "turbo clean",
     "codegen": "turbo codegen",

diff --git a/packages/commons/fdr-utils/src/flattenApiDefinition.ts b/packages/commons/fdr-utils/src/flattenApiDefinition.ts
@@ -231,7 +231,7 @@ function flattenPackage(
             return {
                 type: "subpackage",
                 subpackageId: subpackage.subpackageId,
-                name: titleCase(subpackage.name),
+                name: subpackage.displayName ?? titleCase(subpackage.name),
                 description: subpackage.description,
                 ...flattenPackage(subpackage, subpackagesMap, subpackageSlugs, subpackageOrder),
             };

diff --git a/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts b/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts
@@ -106,6 +106,7 @@ function transformSubpackage({
         pointsTo: writeShape.pointsTo,
         urlSlug: kebabCase(writeShape.name),
         description: writeShape.description,
+        displayName: writeShape.displayName,
         // htmlDescription,
         // descriptionContainsMarkdown: true,
         webhooks: webhooks ?? [],

diff --git a/packages/fdr-sdk/src/converters/read/convertDbAPIDefinitionToRead.ts b/packages/fdr-sdk/src/converters/read/convertDbAPIDefinitionToRead.ts
@@ -55,6 +55,7 @@ function transformSubpackage({
         // htmlDescription: dbShape.htmlDescription,
         webhooks: dbShape.webhooks ?? [],
         websockets: dbShape.websockets ?? [],
+        displayName: dbShape.displayName,
         // descriptionContainsMarkdown: dbShape.descriptionContainsMarkdown,
     };
 }