Merge pull request #200 from jvanbruegge/wrapper

Change router to main wrapper

Author: jvanbruegge

package.json

@@ -26,12 +26,14 @@
     "url": "https://github.com/cyclejs-community/cyclic-router/issues"
   },
   "homepage": "https://github.com/cyclejs-community/cyclic-router#readme",
+  "peerDependencies": {
+    "@cycle/history": "*"
+  },
   "dependencies": {
-    "@cycle/history": "^6.3.0",
-    "@cycle/run": "^3.1.0",
-    "history": "^4.6.3"
+    "@cycle/run": "^3.1.0"
   },
   "devDependencies": {
+    "@cycle/history": "^6.3.0",
     "@cycle/rxjs-run": "^7.0.0",
     "@types/history": "^4.6.0",
     "@types/mocha": "^2.2.41",

src/index.ts

@@ -1,3 +1,3 @@
-export * from './makeRouterDriver';
+export * from './routerify';
 export {RouterSource} from './RouterSource';
 export * from './interfaces';

src/makeRouterDriver.ts

@@ -0,0 +1,72 @@
+import xs from 'xstream';
+import {adapt} from '@cycle/run/lib/adapt';
+import {RouteMatcher} from './interfaces';
+import {RouterSource} from './RouterSource';
+import {Location, createPath} from 'history';
+import {HistoryInput, GenericInput} from '@cycle/history';
+import {Stream} from 'xstream';
+
+export declare type HistoryAction = HistoryInput | GenericInput | string;
+export declare type RouterSink = Stream<HistoryAction>;
+
+export interface RouterOptions {
+  basename?: string;
+  historyName?: string;
+  routerName?: string;
+  omitHistory?: boolean;
+}
+
+/**
+ * Wraps main to provide an advanced interface over @cycle/history
+ * @public
+ * @method routerify
+ * @return {main} The augmented main function
+ */
+function routerify(
+  main: (a: any) => any,
+  routeMatcher: RouteMatcher,
+  options?: RouterOptions
+) {
+  if (typeof main !== 'function') {
+    throw new Error('First argument to routerify must be a valid cycle app');
+  }
+  const opts: RouterOptions = {
+    basename: '/',
+    historyName: 'history',
+    routerName: 'router',
+    omitHistory: true,
+    ...options
+  };
+  const createHref = (location: Location) =>
+    opts.basename + createPath(location);
+  return function(sources: any): any {
+    const routerSource = new RouterSource(
+      xs.from(sources[opts.historyName]),
+      [],
+      createHref,
+      routeMatcher
+    );
+    const sinks = main({
+      ...sources,
+      [opts.routerName]: routerSource,
+      [opts.historyName]: opts.omitHistory
+        ? undefined
+        : sources[opts.historyName]
+    });
+    return {
+      ...sinks,
+      [opts.historyName]: adapt(
+        xs.merge(
+          sinks[opts.historyName] && !opts.omitHistory
+            ? xs.fromObservable(sinks[opts.historyName])
+            : xs.never(),
+          sinks[opts.routerName]
+            ? xs.fromObservable(sinks[opts.routerName])
+            : xs.never()
+        )
+      )
+    };
+  };
+}
+
+export {routerify};