Map reference types to type-aliases (#297)

blackbaud · Jan 30, 2025 · c6bd82c · c6bd82c
1 parent 8158bfe
commit c6bd82c
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 12.0.0-alpha.1 (2025-01-30)
+
+- Map reference types to type-aliases. ([#297](https://github.com/blackbaud/skyux-docs-tools/pull/297)) []()
+
+## 11.2.1 (2025-01-30)
+
+- Map reference types to type-aliases. [#297](https://github.com/blackbaud/skyux-docs-tools/pull/297)
+
 ## 12.0.0-alpha.0 (2025-01-14)
 
 ### ⚠ BREAKING CHANGES

diff --git a/projects/docs-tools/package.json b/projects/docs-tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skyux/docs-tools",
-  "version": "12.0.0-alpha.0",
+  "version": "12.0.0-alpha.1",
   "peerDependencies": {
     "@angular/common": "^19.0.6",
     "@angular/core": "^19.0.6",

diff --git a/projects/docs-tools/src/modules/type-definitions/type-definitions.service.spec.ts b/projects/docs-tools/src/modules/type-definitions/type-definitions.service.spec.ts
@@ -671,4 +671,30 @@ describe('Type definitions service', function () {
 
     expect(result.hasPreviewFeatures).toBeTrue();
   });
+
+  it('should consider a "reference" type as a type alias', () => {
+    const serviceAndAdapter = getServiceAndAdapter({
+      anchorIds: {},
+      typeDefinitions: [
+        {
+          anchorId: '',
+          name: 'MyReferenceType',
+          kind: TypeDocKind.Reference,
+          sources: [
+            {
+              fileName:
+                'src/app/public/modules/_documentation-test/foo-reference.ts',
+            },
+          ],
+        },
+      ],
+    });
+
+    const service = serviceAndAdapter.service;
+    const result = service.getTypeDefinitions(
+      '/src/app/public/modules/_documentation-test/',
+    );
+
+    expect(result.typeAliases[0].name).toEqual('MyReferenceType');
+  });
 });
diff --git a/projects/docs-tools/src/modules/type-definitions/type-definitions.service.ts b/projects/docs-tools/src/modules/type-definitions/type-definitions.service.ts
@@ -124,6 +124,7 @@ export class SkyDocsTypeDefinitionsService {
                 types.enumerations.push(enumType);
                 types.hasPreviewFeatures ||= enumType.hasPreviewFeatures;
                 break;
+              case TypeDocKind.Reference:
               case TypeDocKind.TypeAlias:
                 const typeAliasType = this.adapter.toTypeAliasDefinition(item);
                 types.typeAliases.push(typeAliasType);

diff --git a/projects/docs-tools/src/modules/type-definitions/typedoc-types.ts b/projects/docs-tools/src/modules/type-definitions/typedoc-types.ts
@@ -173,6 +173,7 @@ export interface TypeDocEntry {
     | TypeDocKind.Class
     | TypeDocKind.Enum
     | TypeDocKind.Interface
+    | TypeDocKind.Reference
     | TypeDocKind.TypeAlias;
 
   indexSignature?: TypeDocSignature;