Merge pull request #8256 from ngbrown/react-router-v2

Updates for react-router v2.0.0

react-router/history-tests.ts

@@ -0,0 +1,132 @@
+/// <reference path="./history.d.ts" />
+
+import { createHistory, createLocation, useBeforeUnload, useQueries, useBasename } from 'history'
+import { getUserConfirmation } from 'history/lib/DOMUtils'
+
+interface Promise<T> {
+    then<TResult>(onfulfilled?: (value: T) => TResult): Promise<TResult>;
+}
+
+let doSomethingAsync: () => Promise<Function>;
+let input = { value: "" };
+
+{
+    let history = createHistory()
+
+    // Listen for changes to the current location. The
+    // listener is called once immediately.
+    let unlisten = history.listen(function(location) {
+        console.log(location.pathname)
+    })
+
+    // When you're finished, stop the listener.
+    unlisten()
+
+    // Push a new entry onto the history stack.
+    history.push('/home')
+
+    // Replace the current entry on the history stack.
+    history.replace('/profile')
+
+    // Push a new entry with state onto the history stack.
+    history.push({
+        pathname: '/about',
+        search: '?the=search',
+        state: { some: 'state' }
+    });
+
+    // Change just the search on an existing location.
+    //history.push({ ...location, search: '?the=other+search' })
+
+    // Go back to the previous history entry. The following
+    // two lines are synonymous.
+    history.go(-1)
+    history.goBack()
+
+    let href = history.createHref('/the/path')
+}
+
+{
+    let history = createHistory()
+
+    // Pushing a path string.
+    history.push('/the/path')
+
+    // Omitting location state when pushing a location descriptor.
+    history.push({ pathname: '/the/path', search: '?the=search' })
+
+    // Extending an existing location object.
+    //history.push({ ...location, search: '?other=search' })
+
+    let location = createLocation('/a/path?a=query', { the: 'state' })
+
+    location = history.createLocation('/a/path?a=query', { the: 'state' })
+}
+
+{
+    let history = createHistory()
+    history.listenBefore(function(location) {
+        if (input.value !== '')
+            return 'Are you sure you want to leave this page?'
+    })
+
+    history.listenBefore(function(location, callback) {
+        doSomethingAsync().then(callback)
+    })
+}
+
+{
+    let history = createHistory({
+        getUserConfirmation(message, callback) {
+            callback(window.confirm(message)) // The default behavior
+        }
+    })
+}
+
+{
+    let history = useBeforeUnload(createHistory)()
+
+    history.listenBeforeUnload(function() {
+        return 'Are you sure you want to leave this page?'
+    })
+}
+
+{
+    let history = useQueries(createHistory)()
+
+    history.listen(function(location) {
+        console.log(location.query)
+    })
+}
+
+{
+    let history = useQueries(createHistory)({
+        parseQueryString: function(queryString) {
+            // TODO: return a parsed version of queryString
+            return {};
+        },
+        stringifyQuery: function(query) {
+            // TODO: return a query string created from query
+            return "";
+        }
+    })
+
+    history.createPath({ pathname: '/the/path', query: { the: 'query' } })
+    history.push({ pathname: '/the/path', query: { the: 'query' } })
+}
+
+{
+    // Run our app under the /base URL.
+    let history = useBasename(createHistory)({
+        basename: '/base'
+    })
+
+    // At the /base/hello/world URL:
+    history.listen(function(location) {
+        console.log(location.pathname) // /hello/world
+        console.log(location.basename) // /base
+    })
+
+    history.createPath('/the/path') // /base/the/path
+    history.push('/the/path') // push /base/the/path
+}

react-router/history.d.ts

@@ -1,6 +1,6 @@
-// Type definitions for history v1.13.1
+// Type definitions for history v2.0.0
 // Project: https://github.com/rackt/history
-// Definitions by: Sergey Buturlakin <http://github.com/sergey-buturlakin>
+// Definitions by: Sergey Buturlakin <https://github.com/sergey-buturlakin>, Nathan Brown <https://github.com/ngbrown>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
 
 
@@ -17,21 +17,25 @@ declare namespace HistoryModule {
     type CreateHistoryEnhancer<T, E> = (createHistory: CreateHistory<T>) => CreateHistory<T & E>
 
     interface History {
-        listenBefore(hook: TransitionHook): Function
-        listen(listener: LocationListener): Function
+        listenBefore(hook: TransitionHook): () => void
+        listen(listener: LocationListener): () => void
         transitionTo(location: Location): void
-        pushState(state: LocationState, path: Path): void
-        replaceState(state: LocationState, path: Path): void
-        push(path: Path): void
-        replace(path: Path): void
+        push(path: LocationDescriptor): void
+        replace(path: LocationDescriptor): void
         go(n: number): void
         goBack(): void
         goForward(): void
         createKey(): LocationKey
-        createPath(path: Path): Path
-        createHref(path: Path): Href
-        createLocation(path?: Path, state?: LocationState, action?: Action, key?: LocationKey): Location
+        createPath(path: LocationDescriptor): Path
+        createHref(path: LocationDescriptor): Href
+        createLocation(path?: LocationDescriptor, action?: Action, key?: LocationKey): Location
 
+        /** @deprecated use a location descriptor instead */
+        createLocation(path?: Path, state?: LocationState, action?: Action, key?: LocationKey): Location
+        /** @deprecated use location.key to save state instead */
+        pushState(state: LocationState, path: Path): void
+        /** @deprecated use location.key to save state instead */
+        replaceState(state: LocationState, path: Path): void
         /** @deprecated use location.key to save state instead */
         setState(state: LocationState): void
         /** @deprecated use listenBefore instead */
@@ -40,19 +44,42 @@ declare namespace HistoryModule {
         unregisterTransitionHook(hook: TransitionHook): void
     }
 
-    type HistoryOptions = Object
+    type HistoryOptions = {
+        getCurrentLocation?: () => Location
+        finishTransition?: (nextLocation: Location) => boolean
+        saveState?: (key: LocationKey, state: LocationState) => void
+        go?: (n: number) => void
+        getUserConfirmation?: (message: string, callback: (result: boolean) => void) => void
+        keyLength?: number
+        queryKey?: string | boolean
+        stringifyQuery?: (obj: any) => string
+        parseQueryString?: (str: string) => any
+        basename?: string
+        entries?: string | [any]
+        current?: number
+    }
 
     type Href = string
 
     type Location = {
         pathname: Pathname
-        search: QueryString
+        search: Search
         query: Query
         state: LocationState
         action: Action
         key: LocationKey
+        basename?: string
     }
 
+    type LocationDescriptorObject = {
+        pathname?: Pathname
+        search?: Search
+        query?: Query
+        state?: LocationState
+    }
+
+    type LocationDescriptor = LocationDescriptorObject | Path
+
     type LocationKey = string
 
     type LocationListener = (location: Location) => void
@@ -67,11 +94,13 @@ declare namespace HistoryModule {
 
     type QueryString = string
 
-    type TransitionHook = (location: Location, callback: Function) => any
+    type Search = string
+
+    type TransitionHook = (location: Location, callback: (result: any) => void) => any
 
 
     interface HistoryBeforeUnload {
-        listenBeforeUnload(hook: BeforeUnloadHook): Function
+        listenBeforeUnload(hook: BeforeUnloadHook): () => void
     }
 
     interface HistoryQueries {
@@ -168,6 +197,18 @@ declare module "history/lib/actions" {
 
 }
 
+declare module "history/lib/DOMUtils" {
+    export function addEventListener(node: EventTarget, event: string, listener: EventListenerOrEventListenerObject): void;
+    export function removeEventListener(node: EventTarget, event: string, listener: EventListenerOrEventListenerObject): void;
+    export function getHashPath(): string;
+    export function replaceHashPath(path: string): void;
+    export function getWindowPath(): string;
+    export function go(n: number): void;
+    export function getUserConfirmation(message: string, callback: (result: boolean) => void): void;
+    export function supportsHistory(): boolean;
+    export function supportsGoWithoutReloadUsingHash(): boolean;
+}
+
 
 declare module "history" {
 

react-router/react-router-tests.tsx

@@ -10,8 +10,27 @@ import * as ReactDOM from "react-dom"
 
 import { browserHistory, hashHistory, Router, Route, IndexRoute, Link } from "react-router"
 
+interface MasterContext {
+	router: ReactRouter.RouterOnContext;
+}
+
 class Master extends React.Component<React.Props<{}>, {}> {
 
+	static contextTypes: React.ValidationMap<any> = {
+		router: React.PropTypes.object
+	};
+	context: MasterContext;
+
+	navigate() {
+		var router = this.context.router;
+		router.push("/users");
+		router.push({
+			pathname: "/users/12",
+			query: { modal: true },
+			state: { fromDashboard: true }
+		});
+	}
+
 	render() {
 		return <div>
 			<h1>Master</h1>

react-router/react-router.d.ts

@@ -1,6 +1,6 @@
-// Type definitions for react-router v2.0.0-rc5
+// Type definitions for react-router v2.0.0
 // Project: https://github.com/rackt/react-router
-// Definitions by: Sergey Buturlakin <http://github.com/sergey-buturlakin>, Yuichi Murata <https://github.com/mrk21>, Václav Ostrožlík <https://github.com/vasek17>
+// Definitions by: Sergey Buturlakin <https://github.com/sergey-buturlakin>, Yuichi Murata <https://github.com/mrk21>, Václav Ostrožlík <https://github.com/vasek17>, Nathan Brown <https://github.com/ngbrown>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
 
 
@@ -195,6 +195,10 @@ declare namespace ReactRouter {
     interface IndexRedirectElement extends React.ReactElement<IndexRedirectProps> {}
     const IndexRedirect: IndexRedirect
 
+    interface RouterOnContext extends H.History {
+        setRouteLeaveHook(route: PlainRoute, hook?: RouteHook): () => void;
+        isActive(pathOrLoc: H.LocationDescriptor, indexOnly?: boolean): boolean;
+    }
 
     /* mixins */
 
@@ -448,6 +452,7 @@ declare module "react-router" {
     export type RouterListener = ReactRouter.RouterListener
     export type RouterState = ReactRouter.RouterState
     export type HistoryBase = ReactRouter.HistoryBase
+    export type RouterOnContext = ReactRouter.RouterOnContext
 
     export {
         Router,