docs ready.. more or less

docs/_sidebar.md

@@ -3,11 +3,11 @@
   - [Installing](/docs/Installing)
   - [Working Locally](/docs/WorkingLocally)
   - [Usage](/docs/Usage)
-- [API](/api/README)
 - Guide
   - [Top Level](/docs/top-level-api)
   - [Screen](/docs/screen-api)
   - [Layout Types](/docs/layout-types)
   - [Styling](/docs/styling)
 - Migration from v1
-  - [Top Level](/docs/top-level-api-migration)
+  - [Top Level](/docs/top-level-api-migration)
+- [API](/api/README)

docs/api/Commands.md

@@ -0,0 +1,107 @@
+# Commands
+
+## setRoot
+
+`setRoot(simpleApi: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L12)
+
+---
+
+## setDefaultOptions
+
+`setDefaultOptions(options: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L22)
+
+---
+
+## mergeOptions
+
+`mergeOptions(componentId: any, options: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L30)
+
+---
+
+## showModal
+
+`showModal(simpleApi: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L38)
+
+---
+
+## dismissModal
+
+`dismissModal(componentId: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L48)
+
+---
+
+## dismissAllModals
+
+`dismissAllModals(): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L54)
+
+---
+
+## push
+
+`push(componentId: any, simpleApi: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L60)
+
+---
+
+## pop
+
+`pop(componentId: any, options: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L71)
+
+---
+
+## popTo
+
+`popTo(componentId: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L77)
+
+---
+
+## popToRoot
+
+`popToRoot(componentId: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L83)
+
+---
+
+## setStackRoot
+
+`setStackRoot(componentId: any, simpleApi: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L89)
+
+---
+
+## showOverlay
+
+`showOverlay(simpleApi: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L100)
+
+---
+
+## dismissOverlay
+
+`dismissOverlay(componentId: any): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/Commands.ts#L111)
+
+---
+
+

docs/api/CommandsObserver.md

@@ -0,0 +1,19 @@
+# CommandsObserver
+
+## register
+
+`register(listener: CommandsListener): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/CommandsObserver.ts#L9)
+
+---
+
+## notify
+
+`notify(commandName: string, params: __type): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/CommandsObserver.ts#L17)
+
+---
+
+

docs/api/ComponentEventsObserver.md

@@ -0,0 +1,11 @@
+# ComponentEventsObserver
+
+## registerForAllComponents
+
+`registerForAllComponents(): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L11)
+
+---
+
+

docs/api/ComponentRegistry.md

@@ -0,0 +1,11 @@
+# ComponentRegistry
+
+## registerComponent
+
+`registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentRegistry.ts#L11)
+
+---
+
+

docs/api/ComponentWrapper.md

@@ -0,0 +1,11 @@
+# ComponentWrapper
+
+## wrap
+
+`wrap(componentName: string, OriginalComponentClass: React.ComponentType<any>, store: any): React.ComponentType<any>`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentWrapper.tsx#L7)
+
+---
+
+

docs/api/Element.md

@@ -0,0 +1,178 @@
+# Element
+
+## context
+
+`context (any)`
+
+---
+## props
+
+`props (Readonly<object> & Readonly<object>)`
+
+---
+## refs
+
+`refs (object)`
+
+---
+## state
+
+`state (Readonly<any>)`
+
+---
+
+## render
+
+`render(): Element`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/Element.tsx#L17)
+
+---
+
+## setState
+
+`setState(state: function | S | object, callback: function): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L288)
+
+---
+
+## forceUpdate
+
+`forceUpdate(callBack: function): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L293)
+
+---
+
+## componentDidMount
+
+`componentDidMount(): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L377)
+
+Called immediately after a compoment is mounted. Setting state here will trigger re-rendering.
+
+---
+
+## shouldComponentUpdate
+
+`shouldComponentUpdate(nextProps: Readonly<object>, nextState: Readonly<any>, nextContext: any): boolean`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L388)
+
+Called to determine whether the change in props and state should trigger a re-render.
+
+---
+
+## componentWillUnmount
+
+`componentWillUnmount(): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L393)
+
+Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
+cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`.
+
+---
+
+## componentDidCatch
+
+`componentDidCatch(error: Error, errorInfo: ErrorInfo): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L398)
+
+Catches exceptions generated in descendant components. Unhandled exceptions will cause
+the entire component tree to unmount.
+
+---
+
+## getSnapshotBeforeUpdate
+
+`getSnapshotBeforeUpdate(prevProps: Readonly<object>, prevState: Readonly<any>): SS | null`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L424)
+
+Runs before React applies the result of `render` to the document, and
+returns an object to be given to componentDidUpdate. Useful for saving
+things such as scroll position before `render` causes changes to it.
+
+---
+
+## componentDidUpdate
+
+`componentDidUpdate(prevProps: Readonly<object>, prevState: Readonly<any>, snapshot: SS): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L430)
+
+Called immediately after updating occurs. Not called for the initial render.
+
+---
+
+## componentWillMount
+
+`componentWillMount(): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L445)
+
+Called immediately before mounting occurs, and before `Component#render`.
+Avoid introducing any side-effects or subscriptions in this method.
+
+---
+
+## UNSAFE_componentWillMount
+
+`UNSAFE_componentWillMount(): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L459)
+
+Called immediately before mounting occurs, and before `Component#render`.
+Avoid introducing any side-effects or subscriptions in this method.
+
+---
+
+## componentWillReceiveProps
+
+`componentWillReceiveProps(nextProps: Readonly<object>, nextContext: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L474)
+
+Called when the component may be receiving new props.
+React may call this even if props have not changed, so be sure to compare new and existing
+props if you only want to handle changes.
+
+---
+
+## UNSAFE_componentWillReceiveProps
+
+`UNSAFE_componentWillReceiveProps(nextProps: Readonly<object>, nextContext: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L491)
+
+Called when the component may be receiving new props.
+React may call this even if props have not changed, so be sure to compare new and existing
+props if you only want to handle changes.
+
+---
+
+## componentWillUpdate
+
+`componentWillUpdate(nextProps: Readonly<object>, nextState: Readonly<any>, nextContext: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L504)
+
+Called immediately before rendering when new props or state is received. Not called for the initial render.
+
+---
+
+## UNSAFE_componentWillUpdate
+
+`UNSAFE_componentWillUpdate(nextProps: Readonly<object>, nextState: Readonly<any>, nextContext: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src//Users/danielzlotin/dev/react-native-navigation/node_modules/@types/react/index.d.ts#L519)
+
+Called immediately before rendering when new props or state is received. Not called for the initial render.
+
+---
+
+

docs/api/EventsRegistry.md

@@ -0,0 +1,43 @@
+# EventsRegistry
+
+## onAppLaunched
+
+`onAppLaunched(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L11)
+
+---
+
+## componentDidAppear
+
+`componentDidAppear(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L15)
+
+---
+
+## componentDidDisappear
+
+`componentDidDisappear(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L19)
+
+---
+
+## onNavigationButtonPressed
+
+`onNavigationButtonPressed(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L23)
+
+---
+
+## onNavigationCommand
+
+`onNavigationCommand(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L27)
+
+---
+
+

docs/api/LayoutTreeCrawler.md

@@ -0,0 +1,65 @@
+# LayoutTreeCrawler
+
+## store
+
+`store (any)`
+
+---
+
+## crawl
+
+`crawl(node: LayoutNode): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L27)
+
+---
+
+## processOptions
+
+`processOptions(options: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L39)
+
+---
+
+## _handleComponent
+
+`_handleComponent(node: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L43)
+
+---
+
+## _savePropsToStore
+
+`_savePropsToStore(node: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L49)
+
+---
+
+## _applyStaticOptions
+
+`_applyStaticOptions(node: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L53)
+
+---
+
+## _assertKnownLayoutType
+
+`_assertKnownLayoutType(type: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L60)
+
+---
+
+## _assertComponentDataName
+
+`_assertComponentDataName(component: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeCrawler.ts#L66)
+
+---
+
+

docs/api/LayoutTreeParser.md

@@ -0,0 +1,67 @@
+# LayoutTreeParser
+
+## parse
+
+`parse(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L10)
+
+---
+
+## _topTabs
+
+`_topTabs(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L27)
+
+---
+
+## _sideMenu
+
+`_sideMenu(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L36)
+
+---
+
+## _sideMenuChildren
+
+`_sideMenuChildren(api: any): LayoutNode[]`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L45)
+
+---
+
+## _bottomTabs
+
+`_bottomTabs(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L75)
+
+---
+
+## _stack
+
+`_stack(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L84)
+
+---
+
+## _component
+
+`_component(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L93)
+
+---
+
+## _externalComponent
+
+`_externalComponent(api: any): LayoutNode`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/LayoutTreeParser.ts#L102)
+
+---
+
+

docs/api/NativeCommandsSender.md

@@ -0,0 +1,107 @@
+# NativeCommandsSender
+
+## setRoot
+
+`setRoot(layoutTree: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L9)
+
+---
+
+## setDefaultOptions
+
+`setDefaultOptions(options: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L13)
+
+---
+
+## mergeOptions
+
+`mergeOptions(componentId: string, options: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L17)
+
+---
+
+## push
+
+`push(onComponentId: string, layout: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L21)
+
+---
+
+## pop
+
+`pop(componentId: string, options: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L25)
+
+---
+
+## popTo
+
+`popTo(componentId: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L29)
+
+---
+
+## popToRoot
+
+`popToRoot(componentId: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L33)
+
+---
+
+## setStackRoot
+
+`setStackRoot(onComponentId: string, layout: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L37)
+
+---
+
+## showModal
+
+`showModal(layout: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L41)
+
+---
+
+## dismissModal
+
+`dismissModal(componentId: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L45)
+
+---
+
+## dismissAllModals
+
+`dismissAllModals(): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L49)
+
+---
+
+## showOverlay
+
+`showOverlay(layout: object): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L53)
+
+---
+
+## dismissOverlay
+
+`dismissOverlay(componentId: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeCommandsSender.ts#L57)
+
+---
+
+

docs/api/NativeEventsReceiver.md

@@ -0,0 +1,35 @@
+# NativeEventsReceiver
+
+## registerOnAppLaunched
+
+`registerOnAppLaunched(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L10)
+
+---
+
+## registerComponentDidAppear
+
+`registerComponentDidAppear(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L14)
+
+---
+
+## registerComponentDidDisappear
+
+`registerComponentDidDisappear(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L18)
+
+---
+
+## registerOnNavigationButtonPressed
+
+`registerOnNavigationButtonPressed(callback: function): EventSubscription`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L22)
+
+---
+
+

docs/api/OptionsProcessor.md

@@ -0,0 +1,22 @@
+# OptionsProcessor
+
+## store
+
+`store (any)`
+
+---
+## uniqueIdProvider
+
+`uniqueIdProvider (any)`
+
+---
+
+## processOptions
+
+`processOptions(options: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/commands/OptionsProcessor.ts#L8)
+
+---
+
+

docs/api/README.md

@@ -1 +1,16 @@
-WIP
+- [Home](/)
+- [Navigation](/api/Navigation)
+- [Element](/api/Element)
+- [NativeCommandsSender](/api/NativeCommandsSender)
+- [NativeEventsReceiver](/api/NativeEventsReceiver)
+- [UniqueIdProvider](/api/UniqueIdProvider)
+- [Commands](/api/Commands)
+- [LayoutTreeCrawler](/api/LayoutTreeCrawler)
+- [LayoutTreeParser](/api/LayoutTreeParser)
+- [OptionsProcessor](/api/OptionsProcessor)
+- [ComponentRegistry](/api/ComponentRegistry)
+- [ComponentWrapper](/api/ComponentWrapper)
+- [Store](/api/Store)
+- [CommandsObserver](/api/CommandsObserver)
+- [ComponentEventsObserver](/api/ComponentEventsObserver)
+- [EventsRegistry](/api/EventsRegistry)

docs/api/Store.md

@@ -0,0 +1,59 @@
+# Store
+
+## setPropsForId
+
+`setPropsForId(componentId: string, props: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L8)
+
+---
+
+## getPropsForId
+
+`getPropsForId(componentId: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L12)
+
+---
+
+## setOriginalComponentClassForName
+
+`setOriginalComponentClassForName(componentName: string, ComponentClass: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L16)
+
+---
+
+## getOriginalComponentClassForName
+
+`getOriginalComponentClassForName(componentName: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L20)
+
+---
+
+## setRefForId
+
+`setRefForId(id: string, ref: any): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L24)
+
+---
+
+## getRefForId
+
+`getRefForId(id: string): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L28)
+
+---
+
+## cleanId
+
+`cleanId(id: string): void`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/Store.ts#L32)
+
+---
+
+

docs/api/UniqueIdProvider.md

@@ -0,0 +1,11 @@
+# UniqueIdProvider
+
+## generate
+
+`generate(prefix: string): string`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/UniqueIdProvider.ts#L4)
+
+---
+
+

docs/api/_sidebar.md

@@ -1,3 +1,16 @@
 - [Home](/)
 - [Navigation](/api/Navigation)
-- 
+- [Element](/api/Element)
+- [NativeCommandsSender](/api/NativeCommandsSender)
+- [NativeEventsReceiver](/api/NativeEventsReceiver)
+- [UniqueIdProvider](/api/UniqueIdProvider)
+- [Commands](/api/Commands)
+- [LayoutTreeCrawler](/api/LayoutTreeCrawler)
+- [LayoutTreeParser](/api/LayoutTreeParser)
+- [OptionsProcessor](/api/OptionsProcessor)
+- [ComponentRegistry](/api/ComponentRegistry)
+- [ComponentWrapper](/api/ComponentWrapper)
+- [Store](/api/Store)
+- [CommandsObserver](/api/CommandsObserver)
+- [ComponentEventsObserver](/api/ComponentEventsObserver)
+- [EventsRegistry](/api/EventsRegistry)

package.json

@@ -45,7 +45,7 @@
     "prerelease": "npm run build",
     "release": "node ./scripts/release",
     "local-docs": "node ./scripts/local-docs",
-    "gen-docs": "echo 'this is a work in progress!!!' && ts-node ./scripts/gen-docs/Main"
+    "gen-docs": "ts-node ./scripts/gen-docs/Main"
   },
   "peerDependencies": {
     "react": "*",

scripts/gen-docs/MarkdownCreator.ts → scripts/gen-docs/ClassParser.ts

@@ -1,41 +1,63 @@
 import * as Handlebars from 'handlebars';
 import * as Typedoc from 'typedoc';
-import * as fs from 'fs';
 
-export class MarkdownCreator {
-  constructor(private sourceLinkPrefix: string, private handlebarsFn: HandlebarsTemplateDelegate<any>) { }
+export interface PropertyContext {
+  name: string;
+  type: string;
+}
+
+export interface ArgumentContext {
+  name: string;
+  type: string;
+}
+
+export interface MethodContext {
+  name: string;
+  arguments: ArgumentContext[];
+  returnType: string;
+  source: string;
+  comment?: string;
+}
+
+export interface ClassContext {
+  name: string;
+  properties: PropertyContext[];
+  methods: MethodContext[];
+}
+
+export class ClassParser {
+  constructor(private sourceLinkPrefix: string) { }
 
-  public create(reflection: Typedoc.DeclarationReflection) {
-    const context = {
+  public parseClass(reflection: Typedoc.DeclarationReflection): ClassContext {
+    return {
       name: reflection.name,
-      properties: this.readProperties(reflection),
-      methods: this.readMethods(reflection)
+      properties: this.parseProperties(reflection),
+      methods: this.parseMethods(reflection)
     };
-    return this.handlebarsFn(context);
   }
 
-  private readMethods(reflection: Typedoc.DeclarationReflection) {
+  private parseMethods(reflection: Typedoc.DeclarationReflection): MethodContext[] {
     const methodReflections = reflection.getChildrenByKind(Typedoc.ReflectionKind.Method);
 
     methodReflections.sort((a, b) => a.sources[0].line - b.sources[0].line);
 
     return methodReflections.map((methodReflection) => ({
       name: methodReflection.name,
-      arguments: this.readArguments(methodReflection.signatures[0].parameters || []),
+      arguments: this.parseArguments(methodReflection.signatures[0].parameters || []),
       returnType: methodReflection.signatures[0].type.toString(),
       source: `${this.sourceLinkPrefix}/${methodReflection.sources[0].fileName}#L${methodReflection.sources[0].line}`,
       comment: methodReflection.signatures[0].comment ? methodReflection.signatures[0].comment.shortText : ''
     }));
   }
 
-  private readArguments(parameters: Typedoc.ParameterReflection[]) {
+  private parseArguments(parameters: Typedoc.ParameterReflection[]): ArgumentContext[] {
     return parameters.map((parameter) => ({
       name: parameter.name,
       type: parameter.type.toString()
     }));
   }
 
-  private readProperties(reflection: Typedoc.DeclarationReflection) {
+  private parseProperties(reflection: Typedoc.DeclarationReflection): PropertyContext[] {
     const propsReflections = reflection.getChildrenByKind(Typedoc.ReflectionKind.Property);
     return propsReflections.map((propReflection) => ({
       name: propReflection.name,

scripts/gen-docs/Main.ts

@@ -1,34 +1,31 @@
 import * as fs from 'fs';
 import { ReflectionsReader } from './ReflectionsReader';
-import { MarkdownCreator } from './MarkdownCreator';
-import * as Handlebars from 'handlebars';
+import { ClassParser } from './ClassParser';
+import { MarkdownWriter } from './MarkdownWriter';
+import { ReflectionKind } from 'typedoc';
 
-const INPUT_DIR = `${__dirname}/../../lib/src/Navigation.ts`;
+const INPUT_DIR = `${__dirname}/../../lib/src`;
 const OUTPUT_DIR = `${__dirname}/../../docs/api`;
-const SOURCE_LINK_PREFIX = `https://github.com/wix/react-native-navigation/blob/v2/lib/src`;
 const TEMPLATES_DIR = `${__dirname}/templates`;
-const TSCONFIG = JSON.parse(fs.readFileSync(`${__dirname}/../../tsconfig.json`).toString());
+const TSCONFIG_PATH = `${__dirname}/../../tsconfig.json`;
+const SOURCE_LINK_PREFIX = `https://github.com/wix/react-native-navigation/blob/v2/lib/src`;
 
 class Main {
   public run() {
-    const handlebarsFn = this.setupHandlebars();
-
-    const reflection = new ReflectionsReader(TSCONFIG).read(INPUT_DIR);
-    const markdown = new MarkdownCreator(SOURCE_LINK_PREFIX, handlebarsFn).create(reflection);
-
-    fs.writeFileSync(`${OUTPUT_DIR}/Navigation.md`, markdown, { encoding: 'utf8' });
-  }
+    const classParser = new ClassParser(SOURCE_LINK_PREFIX);
+    const markdownWriter = new MarkdownWriter(TEMPLATES_DIR, OUTPUT_DIR);
+    const projectReflections = new ReflectionsReader(TSCONFIG_PATH).read(INPUT_DIR);
 
-  private setupHandlebars() {
-    const classTemplate = fs.readFileSync(`${TEMPLATES_DIR}/class.hbs`).toString();
-    const methodTemplate = fs.readFileSync(`${TEMPLATES_DIR}/method.hbs`).toString();
-    const propertyTemplate = fs.readFileSync(`${TEMPLATES_DIR}/property.hbs`).toString();
+    const externalModules = projectReflections.getChildrenByKind(ReflectionKind.ExternalModule)
+      .filter((m) => !m.name.endsWith('.mock"') && !m.name.endsWith('.test"'));
 
-    Handlebars.registerPartial('class', classTemplate);
-    Handlebars.registerPartial('method', methodTemplate);
-    Handlebars.registerPartial('property', propertyTemplate);
+    const classReflections = externalModules.filter((m) => m.getChildrenByKind(ReflectionKind.Class).length === 1)
+      .map((m) => m.getChildrenByKind(ReflectionKind.Class)[0]);
+    // just class modules, TODO: extract interfaces and types to their own modules, generate docs for interfaces and types
 
-    return Handlebars.compile('{{> class}}', { strict: true, noEscape: true });
+    const parsedClasses = classReflections.map((c) => classParser.parseClass(c));
+    markdownWriter.writeClasses(parsedClasses);
+    markdownWriter.writeMenu(parsedClasses);
   }
 }
 

scripts/gen-docs/MarkdownWriter.ts

@@ -0,0 +1,44 @@
+import * as Handlebars from 'handlebars';
+import * as fs from 'fs';
+import { ClassContext } from './ClassParser';
+
+export class MarkdownWriter {
+  private classFn;
+  private menuFn;
+  constructor(private templatesDir: string, private outputDir: string) {
+    this.classFn = this.setupClassHandlebars();
+    this.menuFn = this.setupMenuHandlebars();
+  }
+
+  public writeClasses(classContexts: ClassContext[]) {
+    classContexts.forEach((c) => {
+      const classMarkdown = this.classFn(c);
+      fs.writeFileSync(`${this.outputDir}/${c.name}.md`, classMarkdown, { encoding: 'utf8' });
+    });
+  }
+
+  public writeMenu(classContexts: ClassContext[]) {
+    const menuMarkdown = this.menuFn({
+      classes: classContexts.map((c) => ({ name: c.name, path: `/api/${c.name}` }))
+    });
+    fs.writeFileSync(`${this.outputDir}/_sidebar.md`, menuMarkdown, { encoding: 'utf8' });
+    fs.writeFileSync(`${this.outputDir}/README.md`, menuMarkdown, { encoding: 'utf8' });
+  }
+
+  private setupClassHandlebars() {
+    const classTemplate = fs.readFileSync(`${this.templatesDir}/class.hbs`).toString();
+    const methodTemplate = fs.readFileSync(`${this.templatesDir}/method.hbs`).toString();
+    const propertyTemplate = fs.readFileSync(`${this.templatesDir}/property.hbs`).toString();
+
+    Handlebars.registerPartial('class', classTemplate);
+    Handlebars.registerPartial('method', methodTemplate);
+    Handlebars.registerPartial('property', propertyTemplate);
+
+    return Handlebars.compile('{{> class}}', { strict: true, noEscape: true });
+  }
+
+  private setupMenuHandlebars() {
+    const template = fs.readFileSync(`${this.templatesDir}/menu.hbs`).toString();
+    return Handlebars.compile(template, { strict: true, noEscape: true });
+  }
+}

scripts/gen-docs/ReflectionsReader.ts

@@ -1,5 +1,6 @@
 import * as Typedoc from 'typedoc';
 import { OptionsReadMode } from 'typedoc/dist/lib/utils/options';
+import * as fs from 'fs';
 
 const OPTIONS = {
   excludeExternals: true,
@@ -14,16 +15,15 @@ const OPTIONS = {
 export class ReflectionsReader {
   private typedocApp: Typedoc.Application;
 
-  constructor(tsconfig) {
+  constructor(tsconfigPath) {
+    const tsconfig = JSON.parse(fs.readFileSync(tsconfigPath).toString());
     this.typedocApp = new Typedoc.Application({ ...OPTIONS, ...tsconfig.compilerOptions });
   }
 
-  public read(modulePathRoot: string): Typedoc.DeclarationReflection {
-    const expandedFiles = this.typedocApp.expandInputFiles([modulePathRoot]);
+  public read(rootPath: string): Typedoc.ProjectReflection {
+    const expandedFiles = this.typedocApp.expandInputFiles([rootPath]);
     const projectReflection = this.typedocApp.convert(expandedFiles);
     // console.log(JSON.stringify(this.typedocApp.serializer.projectToObject(projectReflection)));
-    const externalModule = projectReflection.getChildrenByKind(Typedoc.ReflectionKind.ExternalModule)[0];
-    const classReflection = externalModule.getChildrenByKind(Typedoc.ReflectionKind.Class)[0];
-    return classReflection;
+    return projectReflection;
   }
 }

scripts/gen-docs/templates/menu.hbs

@@ -0,0 +1,4 @@
+- [Home](/)
+{{#each classes}}
+- [{{name}}]({{path}})
+{{/each}}