support exactOptionalPropertyTypes

fixtures/components/exact-optional-property-types/button/index.tsx

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import * as React from 'react';
+import { CancelableEventHandler } from '../../internal/events';
+
+export interface ButtonProps {
+  /**
+   * String example
+   */
+  children: string;
+
+  /**
+   * Fired when user clicks
+   */
+  onClick?: CancelableEventHandler | undefined;
+}
+
+/**
+ * Component-level description
+ */
+export default function Button({ children, onClick }: ButtonProps) {
+  return <button onClick={onClick}>{children}</button>;
+}

fixtures/components/exact-optional-property-types/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["./**/*.tsx"]
+}

src/components/build-definition.ts

@@ -1,31 +1,58 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { DeclarationReflection, ReflectionKind } from 'typedoc';
-import { Type } from 'typedoc/dist/lib/models';
+import { ReferenceType, Type } from 'typedoc/dist/lib/models';
 import { ComponentDefinition, ComponentFunction } from './interfaces';
 import schema from '../schema';
 import buildTypeDefinition from './build-type-definition';
 import extractDefaultValues from './default-values-extractor';
 
+function mapHandlerToEventInfo(handler: DeclarationReflection) {
+  return {
+    name: handler.name,
+    description: schema.code.buildNodeDescription(handler),
+    deprecatedTag: handler.comment?.tags?.find(tag => tag.tagName === 'deprecated')?.text.trim(),
+  };
+}
+
+function mapReferenceToEventInfo(reference: ReferenceType) {
+  const cancelable = reference.name !== 'NonCancelableEventHandler';
+  const detailType = reference.typeArguments?.[0];
+  if (typeof detailType === 'undefined') {
+    return {
+      cancelable,
+      detailInlineType: undefined,
+      detailType: undefined,
+    };
+  }
+  const { typeName, typeDefinition } = getPropertyType(detailType);
+  return {
+    cancelable,
+    detailInlineType: typeDefinition,
+    detailType: typeName,
+  };
+}
+
 function buildEventInfo(handler: DeclarationReflection) {
+  if (schema.utils.isOptionalDeclaration(handler) && schema.types.isUnionType(handler.type)) {
+    const reference = handler.type.types.find(schema.types.isReferenceType);
+    if (typeof reference !== 'undefined') {
+      return {
+        ...mapHandlerToEventInfo(handler),
+        ...mapReferenceToEventInfo(reference),
+      };
+    }
+  }
   if (!schema.types.isReferenceType(handler.type)) {
     throw new Error(
       `Unknown event handler type: ${handler.type && handler.type.type} at ${schema.utils.getDeclarationSourceFilename(
         handler
       )}`
     );
   }
-  const detailType = handler.type.typeArguments?.[0];
-  const { typeName, typeDefinition } = detailType
-    ? getPropertyType(detailType)
-    : { typeName: undefined, typeDefinition: undefined };
   return {
-    name: handler.name,
-    description: schema.code.buildNodeDescription(handler),
-    cancelable: handler.type.name !== 'NonCancelableEventHandler',
-    detailType: typeName,
-    detailInlineType: typeDefinition,
-    deprecatedTag: handler.comment?.tags?.find(tag => tag.tagName === 'deprecated')?.text.trim(),
+    ...mapHandlerToEventInfo(handler),
+    ...mapReferenceToEventInfo(handler.type),
   };
 }
 

test/components/exact-optional-properties-types.test.ts

@@ -0,0 +1,35 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ComponentDefinition } from '../../src/components/interfaces';
+import { buildProject } from './test-helpers';
+
+let component: ComponentDefinition;
+beforeAll(() => {
+  const result = buildProject('exact-optional-property-types');
+  expect(result).toHaveLength(1);
+
+  component = result[0];
+});
+
+test('should have correct properties', () => {
+  expect(component.properties).toEqual([
+    {
+      name: 'children',
+      description: 'String example',
+      type: 'string',
+      optional: false,
+      defaultValue: undefined,
+    },
+  ]);
+});
+
+test('should have correct events', () => {
+  expect(component.events).toEqual([
+    {
+      name: 'onClick',
+      description: 'Fired when user clicks',
+      cancelable: true,
+      detailType: undefined,
+    },
+  ]);
+});