@openpkg-ts/doc-generator 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/react-styled.d.ts +111 -12
- package/dist/react-styled.js +553 -344
- package/package.json +1 -1
package/dist/react-styled.d.ts
CHANGED
|
@@ -591,28 +591,61 @@ interface ExportIndexPageProps {
|
|
|
591
591
|
* AI SDK-style clean layout with responsive 2-column grid.
|
|
592
592
|
*/
|
|
593
593
|
declare function ExportIndexPage({ spec, baseHref, description, className, showSearch, showFilters }: ExportIndexPageProps): ReactNode4;
|
|
594
|
-
import { OpenPkg as OpenPkg11,
|
|
594
|
+
import { OpenPkg as OpenPkg11, SpecExportKind as SpecExportKind5 } from "@openpkg-ts/spec";
|
|
595
595
|
import { ReactNode as ReactNode5 } from "react";
|
|
596
|
+
interface FullAPIReferencePageProps {
|
|
597
|
+
/** OpenPkg spec */
|
|
598
|
+
spec: OpenPkg11;
|
|
599
|
+
/** Filter to specific kinds (default: all) */
|
|
600
|
+
kinds?: SpecExportKind5[];
|
|
601
|
+
/** Show kind filter buttons (default: true) */
|
|
602
|
+
showFilters?: boolean;
|
|
603
|
+
/** Custom title (default: spec.meta.name) */
|
|
604
|
+
title?: string;
|
|
605
|
+
/** Custom description */
|
|
606
|
+
description?: ReactNode5;
|
|
607
|
+
/** Custom className */
|
|
608
|
+
className?: string;
|
|
609
|
+
}
|
|
610
|
+
/**
|
|
611
|
+
* Single-page API reference that renders all exports in a scrollable view.
|
|
612
|
+
* Similar to Stripe's API documentation layout.
|
|
613
|
+
*
|
|
614
|
+
* @example
|
|
615
|
+
* ```tsx
|
|
616
|
+
* // Show all exports
|
|
617
|
+
* <FullAPIReferencePage spec={spec} />
|
|
618
|
+
* ```
|
|
619
|
+
*
|
|
620
|
+
* @example
|
|
621
|
+
* ```tsx
|
|
622
|
+
* // Show only functions
|
|
623
|
+
* <FullAPIReferencePage spec={spec} kinds={['function']} title="Functions" />
|
|
624
|
+
* ```
|
|
625
|
+
*/
|
|
626
|
+
declare function FullAPIReferencePage({ spec, kinds, showFilters, title, description, className }: FullAPIReferencePageProps): ReactNode5;
|
|
627
|
+
import { OpenPkg as OpenPkg12, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
|
|
628
|
+
import { ReactNode as ReactNode6 } from "react";
|
|
596
629
|
interface FunctionPageProps {
|
|
597
630
|
export: SpecExport6;
|
|
598
|
-
spec:
|
|
631
|
+
spec: OpenPkg12;
|
|
599
632
|
}
|
|
600
633
|
/**
|
|
601
634
|
* Stripe-style function page with two-column layout.
|
|
602
635
|
* Left: parameters, returns. Right: sticky code examples.
|
|
603
636
|
*/
|
|
604
|
-
declare function FunctionPage({ export: exp, spec }: FunctionPageProps):
|
|
605
|
-
import { OpenPkg as
|
|
606
|
-
import { ReactNode as
|
|
637
|
+
declare function FunctionPage({ export: exp, spec }: FunctionPageProps): ReactNode6;
|
|
638
|
+
import { OpenPkg as OpenPkg13, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
|
|
639
|
+
import { ReactNode as ReactNode7 } from "react";
|
|
607
640
|
interface InterfacePageProps {
|
|
608
641
|
export: SpecExport7;
|
|
609
|
-
spec:
|
|
642
|
+
spec: OpenPkg13;
|
|
610
643
|
}
|
|
611
644
|
/**
|
|
612
645
|
* Stripe-style interface/type page with two-column layout.
|
|
613
646
|
* Left: properties, methods. Right: sticky code examples.
|
|
614
647
|
*/
|
|
615
|
-
declare function InterfacePage({ export: exp, spec }: InterfacePageProps):
|
|
648
|
+
declare function InterfacePage({ export: exp, spec }: InterfacePageProps): ReactNode7;
|
|
616
649
|
import { SpecSchema as SpecSchema2, SpecSignatureParameter as SpecSignatureParameter4 } from "@openpkg-ts/spec";
|
|
617
650
|
interface ParameterItemProps {
|
|
618
651
|
/** Parameter to display */
|
|
@@ -637,14 +670,80 @@ interface NestedPropertyItemProps {
|
|
|
637
670
|
* Features expandable nested params, type annotations, and required/optional badges.
|
|
638
671
|
*/
|
|
639
672
|
declare function ParameterItem({ param, depth, className }: ParameterItemProps): React.ReactNode;
|
|
640
|
-
import { OpenPkg as
|
|
641
|
-
import { ReactNode as
|
|
673
|
+
import { OpenPkg as OpenPkg14, SpecExport as SpecExport8 } from "@openpkg-ts/spec";
|
|
674
|
+
import { ReactNode as ReactNode8 } from "react";
|
|
642
675
|
interface VariablePageProps {
|
|
643
676
|
export: SpecExport8;
|
|
644
|
-
spec:
|
|
677
|
+
spec: OpenPkg14;
|
|
645
678
|
}
|
|
646
679
|
/**
|
|
647
680
|
* Stripe-style variable/constant page with two-column layout.
|
|
648
681
|
*/
|
|
649
|
-
declare function VariablePage({ export: exp, spec }: VariablePageProps):
|
|
650
|
-
|
|
682
|
+
declare function VariablePage({ export: exp, spec }: VariablePageProps): ReactNode8;
|
|
683
|
+
import { OpenPkg as OpenPkg15, SpecExport as SpecExport9 } from "@openpkg-ts/spec";
|
|
684
|
+
import { ReactNode as ReactNode9 } from "react";
|
|
685
|
+
interface ClassSectionProps {
|
|
686
|
+
export: SpecExport9;
|
|
687
|
+
spec: OpenPkg15;
|
|
688
|
+
}
|
|
689
|
+
/**
|
|
690
|
+
* Class section for use in single-page API reference.
|
|
691
|
+
* Renders an APISection with constructor, methods, and properties.
|
|
692
|
+
*/
|
|
693
|
+
declare function ClassSection({ export: exp, spec }: ClassSectionProps): ReactNode9;
|
|
694
|
+
import { OpenPkg as OpenPkg16, SpecExport as SpecExport10 } from "@openpkg-ts/spec";
|
|
695
|
+
import { ReactNode as ReactNode10 } from "react";
|
|
696
|
+
interface EnumSectionProps {
|
|
697
|
+
export: SpecExport10;
|
|
698
|
+
spec: OpenPkg16;
|
|
699
|
+
}
|
|
700
|
+
/**
|
|
701
|
+
* Enum section for use in single-page API reference.
|
|
702
|
+
* Renders an APISection with enum members.
|
|
703
|
+
*/
|
|
704
|
+
declare function EnumSection({ export: exp, spec }: EnumSectionProps): ReactNode10;
|
|
705
|
+
import { OpenPkg as OpenPkg17, SpecExport as SpecExport11 } from "@openpkg-ts/spec";
|
|
706
|
+
import { ReactNode as ReactNode11 } from "react";
|
|
707
|
+
interface ExportSectionProps {
|
|
708
|
+
export: SpecExport11;
|
|
709
|
+
spec: OpenPkg17;
|
|
710
|
+
}
|
|
711
|
+
/**
|
|
712
|
+
* Router component that renders the appropriate section based on kind.
|
|
713
|
+
* Used by FullAPIReferencePage to render each inline.
|
|
714
|
+
*/
|
|
715
|
+
declare function ExportSection({ export: exp, spec }: ExportSectionProps): ReactNode11;
|
|
716
|
+
import { OpenPkg as OpenPkg18, SpecExport as SpecExport12 } from "@openpkg-ts/spec";
|
|
717
|
+
import { ReactNode as ReactNode12 } from "react";
|
|
718
|
+
interface FunctionSectionProps {
|
|
719
|
+
export: SpecExport12;
|
|
720
|
+
spec: OpenPkg18;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* Function section for use in single-page API reference.
|
|
724
|
+
* Renders an APISection with parameters and returns.
|
|
725
|
+
*/
|
|
726
|
+
declare function FunctionSection({ export: exp, spec }: FunctionSectionProps): ReactNode12;
|
|
727
|
+
import { OpenPkg as OpenPkg19, SpecExport as SpecExport13 } from "@openpkg-ts/spec";
|
|
728
|
+
import { ReactNode as ReactNode13 } from "react";
|
|
729
|
+
interface InterfaceSectionProps {
|
|
730
|
+
export: SpecExport13;
|
|
731
|
+
spec: OpenPkg19;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* Interface/type section for use in single-page API reference.
|
|
735
|
+
* Renders an APISection with properties and methods.
|
|
736
|
+
*/
|
|
737
|
+
declare function InterfaceSection({ export: exp, spec }: InterfaceSectionProps): ReactNode13;
|
|
738
|
+
import { OpenPkg as OpenPkg20, SpecExport as SpecExport14 } from "@openpkg-ts/spec";
|
|
739
|
+
import { ReactNode as ReactNode14 } from "react";
|
|
740
|
+
interface VariableSectionProps {
|
|
741
|
+
export: SpecExport14;
|
|
742
|
+
spec: OpenPkg20;
|
|
743
|
+
}
|
|
744
|
+
/**
|
|
745
|
+
* Variable/constant section for use in single-page API reference.
|
|
746
|
+
* Renders an APISection with type information.
|
|
747
|
+
*/
|
|
748
|
+
declare function VariableSection({ export: exp, spec }: VariableSectionProps): ReactNode14;
|
|
749
|
+
export { groupMembersByKind, getExampleTitle, getExampleLanguage, getExampleCode, cleanCode, VariableSectionProps, VariableSection, VariablePageProps, VariablePage, TypeTableProps, TypeTable, SignatureProps, Signature, ParameterItemProps, ParameterItem, ParamTableProps, ParamTable, ParamRowProps, ParamRow, NestedPropertyProps, NestedPropertyItemProps, NestedProperty, MembersTableProps, MembersTable, MemberRowProps, MemberRow, MemberGroups, InterfaceSectionProps, InterfaceSection, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, FunctionSectionProps, FunctionSection, FunctionPageProps, FunctionPage, FullAPIReferencePageProps, FullAPIReferencePage, ExportSectionProps, ExportSection, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, ExpandablePropertyProps, ExpandableProperty, ExampleBlockProps, ExampleBlock, EnumSectionProps, EnumSection, EnumPageProps, EnumPage, CollapsibleMethodProps, CollapsibleMethod, CodeTabsProps, CodeTabs, CodeTab, ClassSectionProps, ClassSection, ClassPageProps, ClassPage, APIPageProps, APIPage };
|