1import React, { useContext } from 'react'; 2 3import DocumentationPageContext from '~/components/DocumentationPageContext'; 4import { P } from '~/components/base/paragraph'; 5import { GeneratedData } from '~/components/plugins/api/APIDataTypes'; 6import APISectionConstants from '~/components/plugins/api/APISectionConstants'; 7import APISectionEnums from '~/components/plugins/api/APISectionEnums'; 8import APISectionInterfaces from '~/components/plugins/api/APISectionInterfaces'; 9import APISectionMethods from '~/components/plugins/api/APISectionMethods'; 10import APISectionProps from '~/components/plugins/api/APISectionProps'; 11import APISectionTypes from '~/components/plugins/api/APISectionTypes'; 12import { TypeDocKind } from '~/components/plugins/api/APISectionUtils'; 13 14const LATEST_VERSION = `v${require('~/package.json').version}`; 15 16type Props = { 17 packageName: string; 18 apiName?: string; 19}; 20 21const filterDataByKind = ( 22 entries: GeneratedData[], 23 kind: TypeDocKind, 24 additionalCondition: (entry: GeneratedData) => boolean = () => true 25) => 26 entries 27 ? entries.filter((entry: GeneratedData) => entry.kind === kind && additionalCondition(entry)) 28 : []; 29 30const renderAPI = ( 31 packageName: string, 32 version: string = 'unversioned', 33 apiName?: string 34): JSX.Element => { 35 try { 36 const data = require(`~/public/static/data/${version}/${packageName}.json`).children; 37 38 const methods = filterDataByKind( 39 data, 40 TypeDocKind.Function, 41 entry => !entry.name.includes('Listener') 42 ); 43 const eventSubscriptions = filterDataByKind(data, TypeDocKind.Function, entry => 44 entry.name.includes('Listener') 45 ); 46 const types = filterDataByKind( 47 data, 48 TypeDocKind.TypeAlias, 49 entry => !!(entry.type.declaration || entry.type.types) 50 ); 51 const props = filterDataByKind(data, TypeDocKind.TypeAlias, entry => 52 entry.name.includes('Props') 53 ); 54 const defaultProps = filterDataByKind( 55 data 56 .filter((entry: GeneratedData) => entry.kind === TypeDocKind.Class) 57 .map((entry: GeneratedData) => entry.children) 58 .flat(), 59 TypeDocKind.Property, 60 entry => entry.name === 'defaultProps' 61 )[0]; 62 const enums = filterDataByKind(data, TypeDocKind.Enum); 63 const interfaces = filterDataByKind(data, TypeDocKind.Interface); 64 const constants = filterDataByKind(data, TypeDocKind.Variable, entry => entry.flags.isConst); 65 66 return ( 67 <> 68 <APISectionConstants data={constants} apiName={apiName} /> 69 <APISectionMethods data={methods} apiName={apiName} /> 70 <APISectionMethods 71 data={eventSubscriptions} 72 apiName={apiName} 73 header="Event Subscriptions" 74 /> 75 <APISectionProps data={props} defaultProps={defaultProps} /> 76 <APISectionTypes data={types} /> 77 <APISectionInterfaces data={interfaces} /> 78 <APISectionEnums data={enums} /> 79 </> 80 ); 81 } catch (error) { 82 return <P>No API data file found, sorry!</P>; 83 } 84}; 85 86const APISection: React.FC<Props> = ({ packageName, apiName }) => { 87 const { version } = useContext(DocumentationPageContext); 88 const resolvedVersion = 89 version === 'unversioned' ? version : version === 'latest' ? LATEST_VERSION : version; 90 return renderAPI(packageName, resolvedVersion, apiName); 91}; 92 93export default APISection; 94