@doccov/sdk 0.3.3 → 0.3.5

package/dist/index.js

@@ -1618,6 +1618,20 @@ function withDescription(schema, description) {
     description
   };
 }
+function getPropertyType(prop, parentType, typeChecker) {
+  if (prop.valueDeclaration) {
+    return typeChecker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+  }
+  const propType = typeChecker.getTypeOfPropertyOfType(parentType, prop.getName());
+  if (propType) {
+    return propType;
+  }
+  const decl = prop.declarations?.[0];
+  if (decl) {
+    return typeChecker.getTypeOfSymbolAtLocation(prop, decl);
+  }
+  return typeChecker.getAnyType();
+}
 function propertiesToSchema(properties, description) {
   const schema = {
     type: "object",
@@ -1958,7 +1972,7 @@ function formatTypeReference(type, typeChecker, typeRefs, referencedTypes, visit
             };
             const required = [];
             for (const prop of properties) {
-              const propType = typeChecker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+              const propType = getPropertyType(prop, type, typeChecker);
               const propName = prop.getName();
               objSchema.properties[propName] = formatTypeReference(propType, typeChecker, typeRefs, referencedTypes, visited);
               if (!(prop.flags & ts2.SymbolFlags.Optional)) {
@@ -2043,7 +2057,7 @@ function structureParameter(param, paramDecl, paramType, typeChecker, typeRefs,
       const isAnonymousObject = isObjectLiteralType(subType) || symbol2?.getName().startsWith("__");
       if (isAnonymousObject) {
         for (const prop of subType.getProperties()) {
-          const propType = typeChecker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+          const propType = getPropertyType(prop, subType, typeChecker);
           let description = "";
           if (functionDoc) {
             const propName = prop.getName();
@@ -2063,7 +2077,7 @@ function structureParameter(param, paramDecl, paramType, typeChecker, typeRefs,
         const _symbolName = symbol2.getName();
         if (!isBuiltInType(_symbolName)) {
           for (const prop of subType.getProperties()) {
-            const propType = typeChecker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+            const propType = getPropertyType(prop, subType, typeChecker);
             properties.push({
               name: prop.getName(),
               type: formatTypeReference(propType, typeChecker, typeRefs, referencedTypes),
@@ -2094,7 +2108,7 @@ function structureParameter(param, paramDecl, paramType, typeChecker, typeRefs,
       if (isObjectLiteralType(subType) || symbol2?.getName().startsWith("__")) {
         const properties = [];
         for (const prop of subType.getProperties()) {
-          const propType = typeChecker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+          const propType = getPropertyType(prop, subType, typeChecker);
           properties.push({
             name: prop.getName(),
             type: formatTypeReference(propType, typeChecker, typeRefs, referencedTypes),
@@ -2128,7 +2142,7 @@ function structureParameter(param, paramDecl, paramType, typeChecker, typeRefs,
   if ((symbol?.getName().startsWith("__") || isObjectLiteralType(paramType)) && paramType.getProperties().length > 0) {
     const properties = [];
     for (const prop of paramType.getProperties()) {
-      const propType = typeChecker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+      const propType = getPropertyType(prop, paramType, typeChecker);
       properties.push({
         name: prop.getName(),
         type: formatTypeReference(propType, typeChecker, typeRefs, referencedTypes),
@@ -2825,7 +2839,8 @@ function serializeCallSignatures(signatures, symbol, context, parsedDoc) {
   return signatures.map((signature) => {
     const parameters = signature.getParameters().map((param) => {
       const paramDecl = param.declarations?.find(ts2.isParameter);
-      const paramType = paramDecl ? paramDecl.type != null ? checker.getTypeFromTypeNode(paramDecl.type) : checker.getTypeAtLocation(paramDecl) : checker.getTypeOfSymbolAtLocation(param, symbol?.declarations?.[0] ?? signature.declaration ?? param.declarations?.[0] ?? param.valueDeclaration);
+      const location = symbol?.declarations?.[0] ?? signature.declaration ?? param.declarations?.[0] ?? param.valueDeclaration;
+      const paramType = paramDecl ? paramDecl.type != null ? checker.getTypeFromTypeNode(paramDecl.type) : checker.getTypeAtLocation(paramDecl) : location ? checker.getTypeOfSymbolAtLocation(param, location) : checker.getAnyType();
       collectReferencedTypes(paramType, checker, referencedTypes);
       if (paramDecl?.type) {
         collectReferencedTypesFromNode(paramDecl.type, checker, referencedTypes);
@@ -2895,6 +2910,86 @@ function serializeFunctionExport(declaration, symbol, context) {
 }
 
 // src/analysis/serializers/interfaces.ts
+function serializeInterfaceMembers(declaration, checker, typeRefs, referencedTypes) {
+  const members = [];
+  for (const member of declaration.members) {
+    if (ts2.isPropertySignature(member)) {
+      const memberName = member.name?.getText();
+      if (!memberName)
+        continue;
+      const memberSymbol = member.name ? checker.getSymbolAtLocation(member.name) : undefined;
+      const memberDoc = memberSymbol ? parseJSDocComment(memberSymbol, checker) : null;
+      const memberType = member.type ? checker.getTypeAtLocation(member.type) : checker.getAnyType();
+      collectReferencedTypes(memberType, checker, referencedTypes);
+      const schema = formatTypeReference(memberType, checker, typeRefs, referencedTypes);
+      const flags = {};
+      if (member.questionToken) {
+        flags.optional = true;
+      }
+      if (member.modifiers?.some((mod) => mod.kind === ts2.SyntaxKind.ReadonlyKeyword)) {
+        flags.readonly = true;
+      }
+      members.push({
+        id: memberName,
+        name: memberName,
+        kind: "property",
+        schema,
+        description: memberDoc?.description ?? (memberSymbol ? getJSDocComment(memberSymbol, checker) : undefined),
+        flags: Object.keys(flags).length > 0 ? flags : undefined,
+        tags: memberDoc?.tags
+      });
+    } else if (ts2.isMethodSignature(member)) {
+      const methodName = member.name?.getText();
+      if (!methodName)
+        continue;
+      const memberSymbol = member.name ? checker.getSymbolAtLocation(member.name) : undefined;
+      const methodDoc = memberSymbol ? parseJSDocComment(memberSymbol, checker) : null;
+      const signature = checker.getSignatureFromDeclaration(member);
+      if (signature) {
+        const parameters = signature.getParameters().map((param) => {
+          const paramDecl = param.declarations?.find(ts2.isParameter);
+          const paramType = paramDecl ? checker.getTypeAtLocation(paramDecl) : checker.getTypeOfSymbolAtLocation(param, member);
+          collectReferencedTypes(paramType, checker, referencedTypes);
+          if (paramDecl) {
+            const paramDoc = getParameterDocumentation(param, paramDecl, checker);
+            return structureParameter(param, paramDecl, paramType, checker, typeRefs, null, paramDoc, referencedTypes);
+          }
+          return {
+            name: param.getName(),
+            required: !(param.flags & ts2.SymbolFlags.Optional),
+            schema: formatTypeReference(paramType, checker, typeRefs, referencedTypes)
+          };
+        });
+        const returnType = signature.getReturnType();
+        if (returnType) {
+          collectReferencedTypes(returnType, checker, referencedTypes);
+        }
+        const flags = {};
+        if (member.questionToken) {
+          flags.optional = true;
+        }
+        members.push({
+          id: methodName,
+          name: methodName,
+          kind: "method",
+          signatures: [
+            {
+              parameters,
+              returns: {
+                schema: returnType ? formatTypeReference(returnType, checker, typeRefs, referencedTypes) : { type: "void" }
+              },
+              description: methodDoc?.description
+            }
+          ],
+          description: methodDoc?.description ?? (memberSymbol ? getJSDocComment(memberSymbol, checker) : undefined),
+          flags: Object.keys(flags).length > 0 ? flags : undefined,
+          tags: methodDoc?.tags
+        });
+      }
+    }
+  }
+  return members;
+}
 function serializeInterface(declaration, symbol, context) {
   const { checker, typeRegistry } = context;
   const parsedDoc = parseJSDocComment(symbol, checker);
@@ -2903,6 +2998,7 @@ function serializeInterface(declaration, symbol, context) {
   const referencedTypes = typeRegistry.getReferencedTypes();
   const typeRefs = typeRegistry.getTypeRefs();
   const typeParameters = serializeTypeParameterDeclarations(declaration.typeParameters, checker, referencedTypes);
+  const members = serializeInterfaceMembers(declaration, checker, typeRefs, referencedTypes);
   const exportEntry = {
     id: symbol.getName(),
     name: symbol.getName(),
@@ -2911,6 +3007,7 @@ function serializeInterface(declaration, symbol, context) {
     deprecated: isSymbolDeprecated(symbol),
     description,
     source: getSourceLocation(declaration),
+    members,
     typeParameters,
     tags: parsedDoc?.tags,
     examples: parsedDoc?.examples
@@ -2922,6 +3019,7 @@ function serializeInterface(declaration, symbol, context) {
     ...metadata,
     kind: "interface",
     schema,
+    members,
     description,
     source: getSourceLocation(declaration),
     tags: parsedDoc?.tags

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doccov/sdk",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "DocCov SDK - Documentation coverage and drift detection for TypeScript",
   "keywords": [
     "typescript",