feat(docs,dgeni): add deprecated to API nav list (#3649)

Author: griest024

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;
 }

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)