support interface docs

docs/api/EventSubscription.md

@@ -0,0 +1,11 @@
+# EventSubscription
+
+## remove
+
+`remove(): any`
+
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/interfaces/EventSubscription.ts#L2)
+
+---
+
+

docs/api/EventsRegistry.md

@@ -4,7 +4,7 @@
 
 `onAppLaunched(callback: function): EventSubscription`
 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L11)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L8)
 
 ---
 
@@ -12,7 +12,7 @@
 
 `componentDidAppear(callback: function): EventSubscription`
 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L15)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L12)
 
 ---
 
@@ -20,7 +20,7 @@
 
 `componentDidDisappear(callback: function): EventSubscription`
 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L19)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L16)
 
 ---
 
@@ -28,7 +28,7 @@
 
 `onNavigationButtonPressed(callback: function): EventSubscription`
 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L23)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L20)
 
 ---
 
@@ -36,7 +36,7 @@
 
 `onNavigationCommand(callback: function): EventSubscription`
 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L27)
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L24)
 
 ---
 

docs/api/README.md

@@ -14,4 +14,5 @@
 - [CommandsObserver](/api/CommandsObserver)
 - [ComponentEventsObserver](/api/ComponentEventsObserver)
 - [EventsRegistry](/api/EventsRegistry)
+- [EventSubscription](/api/EventSubscription)
 - [LayoutType](/api/LayoutType)

docs/api/_sidebar.md

@@ -14,4 +14,5 @@
 - [CommandsObserver](/api/CommandsObserver)
 - [ComponentEventsObserver](/api/ComponentEventsObserver)
 - [EventsRegistry](/api/EventsRegistry)
+- [EventSubscription](/api/EventSubscription)
 - [LayoutType](/api/LayoutType)

lib/src/adapters/NativeEventsReceiver.ts

@@ -1,5 +1,5 @@
 import { NativeModules, NativeEventEmitter } from 'react-native';
-import { EventSubscription } from '../events/EventsRegistry';
+import { EventSubscription } from '../interfaces/EventSubscription';
 
 export class NativeEventsReceiver {
   private emitter: NativeEventEmitter;

lib/src/events/CommandsObserver.ts

@@ -1,5 +1,5 @@
 import * as _ from 'lodash';
-import { EventSubscription } from './EventsRegistry';
+import { EventSubscription } from '../interfaces/EventSubscription';
 
 export type CommandsListener = (name: string, params: {}) => void;
 

lib/src/events/EventsRegistry.ts

@@ -1,9 +1,6 @@
 import { NativeEventsReceiver } from '../adapters/NativeEventsReceiver';
 import { CommandsObserver } from './CommandsObserver';
-
-export interface EventSubscription {
-  remove();
-}
+import { EventSubscription } from '../interfaces/EventSubscription';
 
 export class EventsRegistry {
   constructor(private nativeEventsReceiver: NativeEventsReceiver, private commandsObserver: CommandsObserver) { }

lib/src/interfaces/EventSubscription.ts

@@ -0,0 +1,3 @@
+export interface EventSubscription {
+  remove();
+}

package.json

@@ -101,7 +101,8 @@
       "integration/**/*.js",
       "!lib/dist/index.js",
       "!lib/dist/Navigation.js",
-      "!lib/dist/adapters/**/*"
+      "!lib/dist/adapters/**/*",
+      "!lib/dist/interfaces/**/*"
     ],
     "resetMocks": true,
     "resetModules": true,

scripts/gen-docs/Main.ts

@@ -14,14 +14,18 @@ const SOURCE_LINK_PREFIX = `https://github.com/wix/react-native-navigation/blob/
 class Main {
   public run() {
     const classParser = new ClassParser(SOURCE_LINK_PREFIX);
+    const enumParser = new EnumParser();
     const markdownWriter = new MarkdownWriter(TEMPLATES_DIR, OUTPUT_DIR);
     const reflections = new ReflectionsReader(TSCONFIG_PATH).read(INPUT_DIR);
 
     const parsedClasses = classParser.parseClasses(reflections.classReflections);
-    const parsedEnums = new EnumParser().parse(reflections.enumReflections);
+    const parsedInterfaces = classParser.parseClasses(reflections.interfaceReflections);
+    const parsedEnums = enumParser.parse(reflections.enumReflections);
+
     markdownWriter.writeClasses(parsedClasses);
+    markdownWriter.writeClasses(parsedInterfaces);
     markdownWriter.writeEnums(parsedEnums);
-    markdownWriter.writeMenu(parsedClasses, parsedEnums);
+    markdownWriter.writeMenu(parsedClasses, parsedInterfaces, parsedEnums);
   }
 }
 

scripts/gen-docs/MarkdownWriter.ts

@@ -28,10 +28,13 @@ export class MarkdownWriter {
     });
   }
 
-  public writeMenu(classContexts: ClassContext[], enumContexts: EnumContext[]) {
-    const files = classContexts.map((c) => ({ name: c.name, path: `/api/${c.name}` }));
-    const files2 = enumContexts.map((c) => ({ name: c.name, path: `/api/${c.name}` }));
-    const menuMarkdown = this.menuFn({ files: _.concat(files, files2) });
+  public writeMenu(classContexts: ClassContext[], interfaceContexts: ClassContext[], enumContexts: EnumContext[]) {
+    const mapper = (c) => ({ name: c.name, path: `/api/${c.name}` });
+    const files = classContexts.map(mapper);
+    const files2 = interfaceContexts.map(mapper);
+    const files3 = enumContexts.map(mapper);
+
+    const menuMarkdown = this.menuFn({ files: _.concat(files, files2, files3) });
     fs.writeFileSync(`${this.outputDir}/_sidebar.md`, menuMarkdown, { encoding: 'utf8' });
     fs.writeFileSync(`${this.outputDir}/README.md`, menuMarkdown, { encoding: 'utf8' });
   }

scripts/gen-docs/ReflectionsReader.ts

@@ -13,6 +13,7 @@ const OPTIONS = {
 
 export interface Reflections {
   classReflections: DeclarationReflection[];
+  interfaceReflections: DeclarationReflection[];
   enumReflections: DeclarationReflection[];
 }
 
@@ -32,10 +33,12 @@ export class ReflectionsReader {
 
     const externalModules = this.externalModulesWithoutTestsAndMocks(projectReflection);
     const classReflections = this.reflections(externalModules, ReflectionKind.Class);
+    const interfaceReflections = this.reflections(externalModules, ReflectionKind.Interface);
     const enumReflections = this.reflections(externalModules, ReflectionKind.Enum);
 
     return {
       classReflections,
+      interfaceReflections,
       enumReflections
     };
   }