@openpkg-ts/doc-generator 0.6.1 → 0.6.3

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { OpenPkg as OpenPkg10, SpecExample as SpecExample2, SpecExport as SpecExport6, SpecExportKind as SpecExportKind5, SpecMember as SpecMember2, SpecSchema as SpecSchema3, SpecSignature as SpecSignature2, SpecSignatureParameter as SpecSignatureParameter2, SpecTag, SpecType as SpecType3, SpecTypeKind, SpecTypeParameter as SpecTypeParameter2 } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg10, SpecExample as SpecExample2, SpecExport as SpecExport6, SpecExportKind as SpecExportKind5, SpecMember as SpecMember3, SpecSchema as SpecSchema3, SpecSignature as SpecSignature2, SpecSignatureParameter as SpecSignatureParameter2, SpecTag, SpecType as SpecType3, SpecTypeKind, SpecTypeParameter as SpecTypeParameter2 } from "@openpkg-ts/spec";
 import { OpenPkg, SpecExport } from "@openpkg-ts/spec";
 import { ComponentType, ReactNode } from "react";
 /**
@@ -669,7 +669,17 @@ declare function loadSpec(spec: OpenPkg8): DocsInstance;
 * ```
 */
 declare function createDocs(input: string | OpenPkg8): DocsInstance;
-import { OpenPkg as OpenPkg9, SpecExport as SpecExport5, SpecMember, SpecSchema as SpecSchema2, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
+import { SpecMember } from "@openpkg-ts/spec";
+/**
+* Extract badge strings from a member's visibility and flags.
+* Handles: visibility (if not public), static, readonly, async, abstract
+*/
+declare function getMemberBadges(member: SpecMember): string[];
+/**
+* Format badges array into a display string (space-separated).
+*/
+declare function formatBadges(badges: string[]): string;
+import { OpenPkg as OpenPkg9, SpecExport as SpecExport5, SpecMember as SpecMember2, SpecSchema as SpecSchema2, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
 /**
 * Format a schema to a human-readable type string.
 *
@@ -767,28 +777,28 @@ declare function resolveTypeRef(ref: string, spec: OpenPkg9): SpecType2 | undefi
 * isMethod({ name: 'bar', schema: { type: 'string' } }) // false
 * ```
 */
-declare function isMethod(member: SpecMember): boolean;
+declare function isMethod(member: SpecMember2): boolean;
 /**
 * Check if a member is a property (no signatures).
 *
 * @param member - The member to check
 * @returns True if the member is a property
 */
-declare function isProperty(member: SpecMember): boolean;
+declare function isProperty(member: SpecMember2): boolean;
 /**
 * Get methods from members list.
 *
 * @param members - Array of members to filter
 * @returns Array of method members
 */
-declare function getMethods(members?: SpecMember[]): SpecMember[];
+declare function getMethods(members?: SpecMember2[]): SpecMember2[];
 /**
 * Get properties from members list.
 *
 * @param members - Array of members to filter
 * @returns Array of property members
 */
-declare function getProperties(members?: SpecMember[]): SpecMember[];
+declare function getProperties(members?: SpecMember2[]): SpecMember2[];
 /**
 * Group members by visibility (public, protected, private).
 *
@@ -802,10 +812,10 @@ declare function getProperties(members?: SpecMember[]): SpecMember[];
 * groups.private // [{ name: 'bar', visibility: 'private' }]
 * ```
 */
-declare function groupByVisibility(members?: SpecMember[]): {
-	public: SpecMember[];
-	protected: SpecMember[];
-	private: SpecMember[];
+declare function groupByVisibility(members?: SpecMember2[]): {
+	public: SpecMember2[];
+	protected: SpecMember2[];
+	private: SpecMember2[];
 };
 /**
 * Sort exports alphabetically by name.
@@ -816,4 +826,4 @@ declare function groupByVisibility(members?: SpecMember[]): {
 declare function sortByName<T extends {
 	name: string;
 }>(items: T[]): T[];
-export { toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toNavigation2 as toNavigation, toMarkdown2 as toMarkdown, toJSONString, toJSON2 as toJSON, toHTML2 as toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords2 as toAlgoliaRecords, sortByName, resolveTypeRef, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs, createAdapterRegistry, buildSignatureString, adapterRegistry, SpecTypeParameter2 as SpecTypeParameter, SpecTypeKind, SpecType3 as SpecType, SpecTag, SpecSignatureParameter2 as SpecSignatureParameter, SpecSignature2 as SpecSignature, SpecSchema3 as SpecSchema, SpecMember2 as SpecMember, SpecExportKind5 as SpecExportKind, SpecExport6 as SpecExport, SpecExample2 as SpecExample, SimplifiedSpec, SimplifiedSignature, SimplifiedReturn, SimplifiedParameter, SimplifiedMember, SimplifiedExport, SimplifiedExample, SearchRecord, SearchOptions, SearchIndex, SearchGeneratorOptions, PagefindRecord, PageGeneratorOptions, OpenPkg10 as OpenPkg, NavOptions, NavItem, NavGroup, NavGeneratorOptions, NavFormat, MarkdownOptions, LoadOptions, JSONOptions, HTMLOptions, GroupBy, GenericNav, GeneratedFile, FumadocsMetaItem, FumadocsMeta, FileGenerator, ExportPageProps, ExportMarkdownOptions, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DocFrameworkAdapter, ConfigValidationResult, ConfigOptions, ConfigHelper, AlgoliaRecord, AdapterRegistry, AdapterComponents, APIPageComponentProps };
+export { toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toNavigation2 as toNavigation, toMarkdown2 as toMarkdown, toJSONString, toJSON2 as toJSON, toHTML2 as toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords2 as toAlgoliaRecords, sortByName, resolveTypeRef, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, getMemberBadges, formatTypeParameters, formatSchema, formatReturnType, formatParameters, formatBadges, exportToMarkdown, createDocs, createAdapterRegistry, buildSignatureString, adapterRegistry, SpecTypeParameter2 as SpecTypeParameter, SpecTypeKind, SpecType3 as SpecType, SpecTag, SpecSignatureParameter2 as SpecSignatureParameter, SpecSignature2 as SpecSignature, SpecSchema3 as SpecSchema, SpecMember3 as SpecMember, SpecExportKind5 as SpecExportKind, SpecExport6 as SpecExport, SpecExample2 as SpecExample, SimplifiedSpec, SimplifiedSignature, SimplifiedReturn, SimplifiedParameter, SimplifiedMember, SimplifiedExport, SimplifiedExample, SearchRecord, SearchOptions, SearchIndex, SearchGeneratorOptions, PagefindRecord, PageGeneratorOptions, OpenPkg10 as OpenPkg, NavOptions, NavItem, NavGroup, NavGeneratorOptions, NavFormat, MarkdownOptions, LoadOptions, JSONOptions, HTMLOptions, GroupBy, GenericNav, GeneratedFile, FumadocsMetaItem, FumadocsMeta, FileGenerator, ExportPageProps, ExportMarkdownOptions, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DocFrameworkAdapter, ConfigValidationResult, ConfigOptions, ConfigHelper, AlgoliaRecord, AdapterRegistry, AdapterComponents, APIPageComponentProps };

package/dist/index.js

@@ -43,6 +43,27 @@ function createAdapterRegistry() {
   };
 }
 var adapterRegistry = createAdapterRegistry();
+// src/core/format.ts
+function getMemberBadges(member) {
+  const badges = [];
+  const visibility = member.visibility ?? "public";
+  if (visibility !== "public") {
+    badges.push(visibility);
+  }
+  const flags = member.flags;
+  if (flags?.static)
+    badges.push("static");
+  if (flags?.readonly)
+    badges.push("readonly");
+  if (flags?.async)
+    badges.push("async");
+  if (flags?.abstract)
+    badges.push("abstract");
+  return badges;
+}
+function formatBadges(badges) {
+  return badges.join(" ");
+}
 export {
   toSearchIndexJSON,
   toSearchIndex,
@@ -63,10 +84,12 @@ export {
   groupByVisibility,
   getProperties,
   getMethods,
+  getMemberBadges,
   formatTypeParameters,
   formatSchema,
   formatReturnType,
   formatParameters,
+  formatBadges,
   exportToMarkdown,
   createDocs,
   createAdapterRegistry,

package/dist/react-styled.d.ts

@@ -670,6 +670,9 @@ interface NestedPropertyItemProps {
 /**
 * Single parameter with expand capability for nested objects.
 * Features expandable nested params, type annotations, and required/optional badges.
+*
+* @deprecated Use APIParameterItem from @doccov/ui with specParamToAPIParam adapter.
+* Will be removed in next major version.
 */
 declare function ParameterItem({ param, depth, className }: ParameterItemProps): React.ReactNode;
 import { OpenPkg as OpenPkg14, SpecExport as SpecExport8 } from "@openpkg-ts/spec";

package/dist/react-styled.js

@@ -3432,6 +3432,25 @@ var require_link = __commonJS((exports, module) => {
 // src/components/headless/CollapsibleMethod.tsx
 import { useEffect, useState } from "react";
 
+// src/core/format.ts
+function getMemberBadges(member) {
+  const badges = [];
+  const visibility = member.visibility ?? "public";
+  if (visibility !== "public") {
+    badges.push(visibility);
+  }
+  const flags = member.flags;
+  if (flags?.static)
+    badges.push("static");
+  if (flags?.readonly)
+    badges.push("readonly");
+  if (flags?.async)
+    badges.push("async");
+  if (flags?.abstract)
+    badges.push("abstract");
+  return badges;
+}
+
 // src/core/query.ts
 function formatSchema(schema) {
   if (!schema)
@@ -3552,25 +3571,15 @@ function CollapsibleMethod({
   const [expanded, setExpanded] = useState(defaultExpanded);
   const sig = member.signatures?.[0];
   const hasParams = sig?.parameters && sig.parameters.length > 0;
-  const visibility = member.visibility ?? "public";
-  const flags = member.flags;
-  const isStatic = flags?.static;
-  const isAsync = flags?.async;
   const returnType = formatReturnType(sig);
   const paramPreview = formatParamPreview(sig?.parameters);
+  const badges = getMemberBadges(member);
   const toggle = () => setExpanded(!expanded);
   useEffect(() => {
     if (typeof window !== "undefined" && window.location.hash === `#${member.name}`) {
       setExpanded(true);
     }
   }, [member.name]);
-  const badges = [];
-  if (visibility !== "public")
-    badges.push(visibility);
-  if (isStatic)
-    badges.push("static");
-  if (isAsync)
-    badges.push("async");
   return /* @__PURE__ */ jsxs("div", {
     id: member.name,
     className,
@@ -3911,11 +3920,6 @@ function groupMembersByKind(members) {
   return groups;
 }
 function MemberRow({ member }) {
-  const visibility = member.visibility ?? "public";
-  const flags = member.flags;
-  const isStatic = flags?.static;
-  const isAbstract = flags?.abstract;
-  const isReadonly = flags?.readonly;
   const type = formatSchema(member.schema);
   const sig = member.signatures?.[0];
   let signature = "";
@@ -3927,15 +3931,7 @@ function MemberRow({ member }) {
     const returnType = formatSchema(sig.returns?.schema) ?? "void";
     signature = `(${params.join(", ")}): ${returnType}`;
   }
-  const badges = [];
-  if (visibility !== "public")
-    badges.push(visibility);
-  if (isStatic)
-    badges.push("static");
-  if (isAbstract)
-    badges.push("abstract");
-  if (isReadonly)
-    badges.push("readonly");
+  const badges = getMemberBadges(member);
   return /* @__PURE__ */ jsxs4("div", {
     "data-member": member.name,
     children: [
@@ -4338,7 +4334,7 @@ function formatMethodSignature(member) {
   const paramStr = params.map((p) => `${p.name}${p.required === false ? "?" : ""}: ${formatSchema(p.schema)}`).join(", ");
   return `(${paramStr}): ${returnType}`;
 }
-function getMemberBadges(member) {
+function getMemberBadges2(member) {
   const badges = [];
   const flags = member.flags;
   if (member.visibility && member.visibility !== "public") {
@@ -4418,7 +4414,7 @@ const instance = new ${exp.name}(${constructorParams.map((p) => p.name).join(",
         className: "mt-6",
         children: [
           staticProperties.map((member) => {
-            const badges = getMemberBadges(member);
+            const badges = getMemberBadges2(member);
             return /* @__PURE__ */ jsx8(APIParameterItem, {
               name: member.name,
               type: formatSchema(member.schema),
@@ -4426,7 +4422,7 @@ const instance = new ${exp.name}(${constructorParams.map((p) => p.name).join(",
             }, member.name);
           }),
           staticMethods.map((member) => {
-            const badges = getMemberBadges(member);
+            const badges = getMemberBadges2(member);
             return /* @__PURE__ */ jsx8(APIParameterItem, {
               name: `${member.name}()`,
               type: formatMethodSignature(member),
@@ -4439,7 +4435,7 @@ const instance = new ${exp.name}(${constructorParams.map((p) => p.name).join(",
         title: "Methods",
         className: "mt-6",
         children: instanceMethods.map((member) => {
-          const badges = getMemberBadges(member);
+          const badges = getMemberBadges2(member);
           return /* @__PURE__ */ jsx8(APIParameterItem, {
             name: `${member.name}()`,
             type: formatMethodSignature(member),
@@ -4451,7 +4447,7 @@ const instance = new ${exp.name}(${constructorParams.map((p) => p.name).join(",
         title: "Properties",
         className: "mt-6",
         children: instanceProperties.map((member) => {
-          const badges = getMemberBadges(member);
+          const badges = getMemberBadges2(member);
           return /* @__PURE__ */ jsx8(APIParameterItem, {
             name: member.name,
             type: formatSchema(member.schema),
@@ -22716,7 +22712,7 @@ function ExportIndexPage({
   const availableKinds = useMemo(() => allGroups.map((g) => g.kind), [allGroups]);
   const totalExports = filteredGroups.reduce((sum, g) => sum + g.exports.length, 0);
   return /* @__PURE__ */ jsxs10("div", {
-    className: cn2("space-y-8 not-prose", className),
+    className: cn2("doccov-index-page space-y-8 not-prose", className),
     children: [
       /* @__PURE__ */ jsxs10("div", {
         children: [
@@ -23394,7 +23390,7 @@ function FullAPIReferencePage({
   });
   const shouldShowFilters = showFilters && !kinds?.length && availableKinds.length > 1;
   return /* @__PURE__ */ jsxs15("div", {
-    className: cn3("not-prose", showTOC && "lg:grid lg:grid-cols-[220px_1fr] lg:gap-8", className),
+    className: cn3("doccov-full-reference-page not-prose", showTOC && "lg:grid lg:grid-cols-[220px_1fr] lg:gap-8", className),
     children: [
       showTOC && /* @__PURE__ */ jsx22("aside", {
         className: "hidden lg:block",

package/dist/react.js

@@ -20,6 +20,25 @@ var __commonJS = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports,
 // src/components/headless/CollapsibleMethod.tsx
 import { useEffect, useState } from "react";
 
+// src/core/format.ts
+function getMemberBadges(member) {
+  const badges = [];
+  const visibility = member.visibility ?? "public";
+  if (visibility !== "public") {
+    badges.push(visibility);
+  }
+  const flags = member.flags;
+  if (flags?.static)
+    badges.push("static");
+  if (flags?.readonly)
+    badges.push("readonly");
+  if (flags?.async)
+    badges.push("async");
+  if (flags?.abstract)
+    badges.push("abstract");
+  return badges;
+}
+
 // src/core/query.ts
 function formatSchema(schema) {
   if (!schema)
@@ -140,25 +159,15 @@ function CollapsibleMethod({
   const [expanded, setExpanded] = useState(defaultExpanded);
   const sig = member.signatures?.[0];
   const hasParams = sig?.parameters && sig.parameters.length > 0;
-  const visibility = member.visibility ?? "public";
-  const flags = member.flags;
-  const isStatic = flags?.static;
-  const isAsync = flags?.async;
   const returnType = formatReturnType(sig);
   const paramPreview = formatParamPreview(sig?.parameters);
+  const badges = getMemberBadges(member);
   const toggle = () => setExpanded(!expanded);
   useEffect(() => {
     if (typeof window !== "undefined" && window.location.hash === `#${member.name}`) {
       setExpanded(true);
     }
   }, [member.name]);
-  const badges = [];
-  if (visibility !== "public")
-    badges.push(visibility);
-  if (isStatic)
-    badges.push("static");
-  if (isAsync)
-    badges.push("async");
   return /* @__PURE__ */ jsxs("div", {
     id: member.name,
     className,
@@ -499,11 +508,6 @@ function groupMembersByKind(members) {
   return groups;
 }
 function MemberRow({ member }) {
-  const visibility = member.visibility ?? "public";
-  const flags = member.flags;
-  const isStatic = flags?.static;
-  const isAbstract = flags?.abstract;
-  const isReadonly = flags?.readonly;
   const type = formatSchema(member.schema);
   const sig = member.signatures?.[0];
   let signature = "";
@@ -515,15 +519,7 @@ function MemberRow({ member }) {
     const returnType = formatSchema(sig.returns?.schema) ?? "void";
     signature = `(${params.join(", ")}): ${returnType}`;
   }
-  const badges = [];
-  if (visibility !== "public")
-    badges.push(visibility);
-  if (isStatic)
-    badges.push("static");
-  if (isAbstract)
-    badges.push("abstract");
-  if (isReadonly)
-    badges.push("readonly");
+  const badges = getMemberBadges(member);
   return /* @__PURE__ */ jsxs4("div", {
     "data-member": member.name,
     children: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/doc-generator",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "API doc generator consuming OpenPkg specs. TypeDoc alternative for modern doc frameworks.",
   "keywords": [
     "openpkg",
@@ -55,7 +55,7 @@
     "test:watch": "bun test --watch"
   },
   "dependencies": {
-    "@doccov/ui": "^0.3.0",
+    "@doccov/ui": "^0.3.1",
     "@openpkg-ts/spec": "^0.11.1",
     "commander": "^14.0.0"
   },