From 5de3627daa504b31859d1b4bbfdca9ab9ce3a1f6 Mon Sep 17 00:00:00 2001
From: Peter Lauck <griest024@gmail.com>
Date: Tue, 29 Apr 2025 16:08:30 +0000
Subject: [PATCH] feat(docs,dgeni): add `deprecated` to API nav list

---
 libs/docs-utils/src/nav/api.type.ts                | 14 +++++++++-----
 .../helpers/generateApiList.ts                     |  1 +
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/libs/docs-utils/src/nav/api.type.ts b/libs/docs-utils/src/nav/api.type.ts
index 6423b080b0..0242994377 100644
--- a/libs/docs-utils/src/nav/api.type.ts
+++ b/libs/docs-utils/src/nav/api.type.ts
@@ -1,19 +1,23 @@
 import { DaffNavDoc } from './type';
 import { DaffDocsApiRole } from '../api/public_api';
 
-/**
- * A navigation item for an API doc.
- */
-export interface DaffApiNavDoc extends DaffNavDoc {
+interface DaffApiNavDocBase extends DaffNavDoc {
   path: string;
   docType: string;
   role?: DaffDocsApiRole;
 }
 
+/**
+ * A navigation item for an API doc.
+ */
+export interface DaffApiNavDoc extends DaffApiNavDocBase {
+  deprecated?: string;
+}
+
 /**
  * A navigation item for an API doc of a package entrypoint.
  */
-export interface DaffApiNavPackageDoc extends DaffApiNavDoc {
+export interface DaffApiNavPackageDoc extends DaffApiNavDocBase {
   docType: 'package';
   description: string;
 }
diff --git a/tools/dgeni/src/transforms/daffodil-api-package/helpers/generateApiList.ts b/tools/dgeni/src/transforms/daffodil-api-package/helpers/generateApiList.ts
index de5ddc671c..0758d24e7b 100644
--- a/tools/dgeni/src/transforms/daffodil-api-package/helpers/generateApiList.ts
+++ b/tools/dgeni/src/transforms/daffodil-api-package/helpers/generateApiList.ts
@@ -55,6 +55,7 @@ function getExportInfo(exportDoc): DaffDocsApiNavList {
     path: `${exportDoc.path[0] === '/' ? '' : '/'}${exportDoc.path}`,
     docType: getDocType(exportDoc),
     role: exportDoc.role,
+    deprecated: exportDoc.deprecated,
     children: exportDoc.docType === DaffDocsApiType.PACKAGE
       ? exportDoc.exports
         .map(getExportInfo)