@skyux/docs-tools 9.0.0-alpha.1 → 9.0.0-alpha.2

package/fesm2022/skyux-docs-tools.mjs

@@ -2195,6 +2195,40 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.1.8", ngImpor
                 }]
         }], ctorParameters: function () { return [{ type: i1$4.Title }]; } });
 
+/**
+ * This enum comes from:
+ * https://github.com/TypeStrong/typedoc/blob/v0.24.8/src/lib/models/reflections/kind.ts
+ * The enum is up to date as of version `0.24.8`.
+ */
+var TypeDocKind;
+(function (TypeDocKind) {
+    TypeDocKind[TypeDocKind["Project"] = 1] = "Project";
+    TypeDocKind[TypeDocKind["Module"] = 2] = "Module";
+    TypeDocKind[TypeDocKind["Namespace"] = 4] = "Namespace";
+    TypeDocKind[TypeDocKind["Enum"] = 8] = "Enum";
+    TypeDocKind[TypeDocKind["EnumMember"] = 16] = "EnumMember";
+    TypeDocKind[TypeDocKind["Variable"] = 32] = "Variable";
+    TypeDocKind[TypeDocKind["Function"] = 64] = "Function";
+    TypeDocKind[TypeDocKind["Class"] = 128] = "Class";
+    TypeDocKind[TypeDocKind["Interface"] = 256] = "Interface";
+    TypeDocKind[TypeDocKind["Constructor"] = 512] = "Constructor";
+    TypeDocKind[TypeDocKind["Property"] = 1024] = "Property";
+    TypeDocKind[TypeDocKind["Method"] = 2048] = "Method";
+    TypeDocKind[TypeDocKind["CallSignature"] = 4096] = "CallSignature";
+    TypeDocKind[TypeDocKind["IndexSignature"] = 8192] = "IndexSignature";
+    TypeDocKind[TypeDocKind["ConstructorSignature"] = 16384] = "ConstructorSignature";
+    TypeDocKind[TypeDocKind["Parameter"] = 32768] = "Parameter";
+    TypeDocKind[TypeDocKind["TypeLiteral"] = 65536] = "TypeLiteral";
+    TypeDocKind[TypeDocKind["TypeParameter"] = 131072] = "TypeParameter";
+    TypeDocKind[TypeDocKind["Accessor"] = 262144] = "Accessor";
+    TypeDocKind[TypeDocKind["GetSignature"] = 524288] = "GetSignature";
+    TypeDocKind[TypeDocKind["SetSignature"] = 1048576] = "SetSignature";
+    /** @deprecated will be removed in v0.25, not used */
+    TypeDocKind[TypeDocKind["ObjectLiteral"] = 2097152] = "ObjectLiteral";
+    TypeDocKind[TypeDocKind["TypeAlias"] = 4194304] = "TypeAlias";
+    TypeDocKind[TypeDocKind["Reference"] = 8388608] = "Reference";
+})(TypeDocKind || (TypeDocKind = {}));
+
 /**
  * Converts TypeDoc types into SKY UX docs-tools types, to be supplied to the various definitions components.
  */
@@ -2311,10 +2345,11 @@ class SkyDocsTypeDocAdapterService {
         const definitions = entry.children
             .filter((child) => 
         // We only want properties (both with or without a getter/setter)
-        child.kindString === 'Property' || child.kindString === 'Accessor')
+        child.kind === TypeDocKind.Property ||
+            child.kind === TypeDocKind.Accessor)
             .filter((child) => 
         // We only want accessors that don't have a setter if they are not inputs
-        child.kindString !== 'Accessor' ||
+        child.kind !== TypeDocKind.Accessor ||
             child.setSignature ||
             this.getDecorator(child)?.name !== 'Input')
             .map((child) => {
@@ -2325,7 +2360,7 @@ class SkyDocsTypeDocAdapterService {
             };
             let defaultValue;
             /* Ensure we are properly capturing definitions which use a getter/setter. Final check is a sanity check */
-            if (child.kindString === 'Accessor' &&
+            if (child.kind === TypeDocKind.Accessor &&
                 !child.comment?.summary
                     ?.map((item) => item.text)
                     .join('')
@@ -2353,7 +2388,7 @@ class SkyDocsTypeDocAdapterService {
             }
             else {
                 let tags;
-                if (child.kindString === 'Property' &&
+                if (child.kind === TypeDocKind.Property &&
                     !child.comment?.summary
                         ?.map((item) => item.text)
                         .join('')
@@ -2378,9 +2413,9 @@ class SkyDocsTypeDocAdapterService {
                 definition.decorator = decorator;
             }
             if (!definition.description) {
-                const constructor = entry.children.find((child) => child.kindString === 'Constructor');
+                const constructor = entry.children.find((child) => child.kind === TypeDocKind.Constructor);
                 if (constructor) {
-                    const signature = constructor.signatures.find((signature) => signature.kindString === 'Constructor signature');
+                    const signature = constructor.signatures.find((signature) => signature.kind === TypeDocKind.ConstructorSignature);
                     /* Sanity check */
                     /* istanbul ignore else */
                     if (signature) {
@@ -2401,7 +2436,7 @@ class SkyDocsTypeDocAdapterService {
             return [];
         }
         const methods = entry.children
-            .filter((child) => child.kindString === 'Method' && /^ng/.test(child.name) === false)
+            .filter((child) => child.kind === TypeDocKind.Method && /^ng/.test(child.name) === false)
             .map((child) => {
             const definition = {
                 name: this.getPropertyName(child),
@@ -2427,7 +2462,7 @@ class SkyDocsTypeDocAdapterService {
         }
         const definitions = entry.children?.map((child) => {
             let tags;
-            if (child.kindString === 'Method' && child.signatures.length > 0) {
+            if (child.kind === TypeDocKind.Method && child.signatures.length > 0) {
                 tags = this.getCommentTags(child.signatures[0].comment);
             }
             else if (child.type.type === 'reflection' &&
@@ -2477,14 +2512,14 @@ class SkyDocsTypeDocAdapterService {
     }
     getTypeDefinition(child) {
         let definition;
-        const kindString = child.kindString;
-        switch (kindString) {
-            case 'Accessor':
+        const kind = child.kind;
+        switch (kind) {
+            case TypeDocKind.Accessor:
                 if (child.setSignature) {
                     return this.getTypeDefinition(child.setSignature.parameters[0]);
                 }
                 return this.getTypeDefinition(child.getSignature);
-            case 'Method':
+            case TypeDocKind.Method:
                 definition = {
                     callSignature: this.getCallSignatureDefinition(child.signatures[0], this.getCommentTags(child.comment)),
                     name: child.signatures[0].name,
@@ -2805,7 +2840,7 @@ class SkyDocsTypeDefinitionsService {
             }
             typeDefinitions.forEach((item) => {
                 const decorator = item.decorators && item.decorators[0]?.name;
-                const kindString = item.kindString;
+                const kind = item.kind;
                 switch (decorator) {
                     case 'Component':
                         types.components.push(this.adapter.toDirectiveDefinition(item));
@@ -2824,17 +2859,17 @@ class SkyDocsTypeDefinitionsService {
                         break;
                     default:
                         /*tslint:disable-next-line:switch-default*/
-                        switch (kindString) {
-                            case 'Class':
+                        switch (kind) {
+                            case TypeDocKind.Class:
                                 types.classes.push(this.adapter.toClassDefinition(item));
                                 break;
-                            case 'Interface':
+                            case TypeDocKind.Interface:
                                 types.interfaces.push(this.adapter.toInterfaceDefinition(item));
                                 break;
-                            case 'Enumeration':
+                            case TypeDocKind.Enum:
                                 types.enumerations.push(this.adapter.toEnumerationDefinition(item));
                                 break;
-                            case 'Type alias':
+                            case TypeDocKind.TypeAlias:
                                 types.typeAliases.push(this.adapter.toTypeAliasDefinition(item));
                                 break;
                         }