@breautek/router 3.0.0 → 4.0.0

package/dist/src/RouterStrategy.d.ts

@@ -1,117 +1,138 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { Router } from './Router';
-export declare const EVENT_URL_CHANGE: string;
-export declare type URLChangeCallback = (url: string) => void;
-export declare abstract class RouterStrategy extends EventEmitter {
-    private $router;
-    constructor(router: Router);
-    /**
-     * Gets the router
-     */
-    getRouter(): Router;
-    /**
-     * Sets the browser title
-     *
-     * @param {string} title
-     */
-    setTitle(title: string): void;
-    /**
-     * Listen for URL change events
-     *
-     * @param callback
-     */
-    addURLChangeCallback(callback: URLChangeCallback): void;
-    /**
-     * Removes an existing listener
-     *
-     * @param callback
-     */
-    removeURLChangeCallback(callback: URLChangeCallback): void;
-    /**
-     * Gets the URL at the given index in the history stack
-     * @param position index
-     */
-    abstract getLocationAt(position: number): string;
-    /**
-     * Gets the current location.
-     * This is the same as calling [peek(0)]{@link peek}
-     */
-    abstract getLocation(): string;
-    /**
-     * Gets the size of the history stack
-     */
-    abstract getHistoryLength(): number;
-    /**
-     * Gets the scroll restoration
-     */
-    abstract getScrollRestoration(): ScrollRestoration;
-    /**
-     * Navigates the history
-     * @param to Must be an integer.
-     * Negative numbers go back, if possible.
-     * Positive goes forward, if possible.
-     * Zero does nothing.
-     */
-    abstract go(to: number): void;
-    /**
-     * navigate the history forward one entry. This is an alias for [go(1)]{@link go}
-     */
-    forward(): void;
-    /**
-     * Navigate the history back one entry. This is an alias for [go(-1)]{@link go}
-     */
-    back(): void;
-    /**
-     * Returns true, if can be navigated to the given relative index
-     * @param to Must be an integer
-     */
-    abstract canGo(to: number): boolean;
-    /**
-     * Returns true if can go back 1 entry.
-     * This is the same as calling [canGo(-1)]{@link canGo}
-     */
-    canBack(): boolean;
-    /**
-     * Returns true if can go forward 1 entry.
-     * This is the same as calling [canGo(1)]{@link canGo}
-     */
-    canForward(): boolean;
-    /**
-     * Returns the URL stored in the history stack at the given relative index.
-     * @param to Must be an integer
-     */
-    abstract peek(to: number): string;
-    /**
-     * Returns the URL one entry forward.
-     * This is the same as calling [peek(1)]{@link peek}
-     */
-    peekForward(): string;
-    /**
-     * Returns the URL one entry back.
-     * This is the same as calling [peek(-1)]{@link peek}
-     */
-    peekBack(): string;
-    /**
-     * Pushes a new entry into the history stack, navigating to the new location.
-     * @param url
-     * @param state
-     */
-    abstract pushState(url: string, state?: Record<any, any>): void;
-    /**
-     * Replaces the current entry in the history stack with the new location.
-     * This will navigate the screen to the new location.
-     * @param url
-     * @param state
-     */
-    abstract replaceState(url: string, state?: Record<any, any>): void;
-    /**
-     * Clears the history stack.
-     */
-    abstract clear(): void;
-    /**
-     * Fires the {@link EVENT_URL_CHANGE} event
-     * @param url
-     */
-    protected _fireURLChange(url: string): void;
-}
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Router } from './Router';
+import { View } from './View';
+export declare const EVENT_URL_CHANGE: string;
+export type URLChangeCallback = (url: string) => void;
+/**
+ * Invoked when the view's componentDidMount/componentWillUnmount fires.
+ */
+export type ViewMountChangeCallback = (view: View) => void;
+export declare abstract class RouterStrategy extends EventEmitter {
+    private $router;
+    private $viewMountListeners;
+    private $viewUnmountListneners;
+    constructor(router: Router);
+    addViewMountCallback(cb: ViewMountChangeCallback): void;
+    removeViewMountCallback(cb: ViewMountChangeCallback): void;
+    addViewUnmountCallback(cb: ViewMountChangeCallback): void;
+    removeViewUnmountCallback(cb: ViewMountChangeCallback): void;
+    /**
+     * @internal
+     * @param view
+     */
+    __onViewMount(view: View): void;
+    /**
+     * @internal
+     * @param view
+     */
+    __onViewUnmount(view: View): void;
+    /**
+     * Gets the router
+     */
+    getRouter(): Router;
+    /**
+     * Sets the browser title
+     *
+     * @param {string} title
+     */
+    setTitle(title: string): void;
+    /**
+     * Listen for URL change events
+     *
+     * @param callback
+     */
+    addURLChangeCallback(callback: URLChangeCallback): void;
+    /**
+     * Removes an existing listener
+     *
+     * @param callback
+     */
+    removeURLChangeCallback(callback: URLChangeCallback): void;
+    /**
+     * Gets the URL at the given index in the history stack
+     * @param position index
+     */
+    abstract getLocationAt(position: number): string;
+    /**
+     * Gets the current location.
+     * This is the same as calling [peek(0)]{@link peek}
+     */
+    abstract getLocation(): string;
+    /**
+     * Gets the size of the history stack
+     */
+    abstract getHistoryLength(): number;
+    /**
+     * Gets the scroll restoration
+     */
+    abstract getScrollRestoration(): ScrollRestoration;
+    /**
+     * Navigates the history
+     * @param to Must be an integer.
+     * Negative numbers go back, if possible.
+     * Positive goes forward, if possible.
+     * Zero does nothing.
+     */
+    abstract go(to: number): void;
+    /**
+     * navigate the history forward one entry. This is an alias for [go(1)]{@link go}
+     */
+    forward(): void;
+    /**
+     * Navigate the history back one entry. This is an alias for [go(-1)]{@link go}
+     */
+    back(): void;
+    /**
+     * Returns true, if can be navigated to the given relative index
+     * @param to Must be an integer
+     */
+    abstract canGo(to: number): boolean;
+    /**
+     * Returns true if can go back 1 entry.
+     * This is the same as calling [canGo(-1)]{@link canGo}
+     */
+    canBack(): boolean;
+    /**
+     * Returns true if can go forward 1 entry.
+     * This is the same as calling [canGo(1)]{@link canGo}
+     */
+    canForward(): boolean;
+    /**
+     * Returns the URL stored in the history stack at the given relative index.
+     * @param to Must be an integer
+     */
+    abstract peek(to: number): string;
+    /**
+     * Returns the URL one entry forward.
+     * This is the same as calling [peek(1)]{@link peek}
+     */
+    peekForward(): string;
+    /**
+     * Returns the URL one entry back.
+     * This is the same as calling [peek(-1)]{@link peek}
+     */
+    peekBack(): string;
+    /**
+     * Pushes a new entry into the history stack, navigating to the new location.
+     * @param url
+     * @param state
+     */
+    abstract pushState(url: string, state?: Record<any, any>): void;
+    /**
+     * Replaces the current entry in the history stack with the new location.
+     * This will navigate the screen to the new location.
+     * @param url
+     * @param state
+     */
+    abstract replaceState(url: string, state?: Record<any, any>): void;
+    /**
+     * Clears the history stack.
+     */
+    abstract clear(): void;
+    /**
+     * Fires the {@link EVENT_URL_CHANGE} event
+     * @param url
+     */
+    protected _fireURLChange(url: string): void;
+}

package/dist/src/TransitionSlide.d.ts

@@ -1,17 +1,17 @@
-import { TransitionStrategy } from './TransitionStrategy';
-import { View } from './View';
-export declare enum TransitionSlideDirection {
-    LEFT = 1,
-    RIGHT = 2,
-    UP = 3,
-    DOWN = 4
-}
-export declare class TransitionSlide extends TransitionStrategy {
-    private $slideDirection;
-    private $slideSpeed;
-    private $transitionTimeout;
-    constructor(slideDirection: TransitionSlideDirection, slideSpeed: number);
-    protected _execute(incoming: View, exiting: View): Promise<void>;
-    private $getTransitionString;
-    private $getSlideStyle;
-}
+import { TransitionStrategy } from './TransitionStrategy';
+import { View } from './View';
+export declare enum TransitionSlideDirection {
+    LEFT = 1,
+    RIGHT = 2,
+    UP = 3,
+    DOWN = 4
+}
+export declare class TransitionSlide extends TransitionStrategy {
+    private $slideDirection;
+    private $slideSpeed;
+    private $transitionTimeout;
+    constructor(slideDirection: TransitionSlideDirection, slideSpeed: number);
+    protected _execute(incoming: View, exiting: View): Promise<void>;
+    private $getTransitionString;
+    private $getSlideStyle;
+}

package/dist/src/TransitionStrategy.d.ts

@@ -1,21 +1,21 @@
-import { View } from './View';
-export declare abstract class TransitionStrategy {
-    constructor();
-    /**
-     * Invoked when the transition should begin.
-     * The promise should only resolve once the transition
-     * has ran to completion.
-     *
-     * The `incomingView` is the view that the user is navigating to.
-     * The `exitingView` is te view that the user is currently on, and is leaving.
-     *
-     * Both views will be rendered and are free to be manipulated in anyway that is desired,
-     * however, the incomingView should be positioned in it's natural position by the end
-     * of the transition to avoid "snapping" behaviour.
-     *
-     * @param {View} incomingView
-     * @param {View} exitingView
-     */
-    execute(incomingView: View, exitingView: View): Promise<void>;
-    protected abstract _execute(incomingView: View, exitingView: View): Promise<void>;
-}
+import { View } from './View';
+export declare abstract class TransitionStrategy {
+    constructor();
+    /**
+     * Invoked when the transition should begin.
+     * The promise should only resolve once the transition
+     * has ran to completion.
+     *
+     * The `incomingView` is the view that the user is navigating to.
+     * The `exitingView` is te view that the user is currently on, and is leaving.
+     *
+     * Both views will be rendered and are free to be manipulated in anyway that is desired,
+     * however, the incomingView should be positioned in it's natural position by the end
+     * of the transition to avoid "snapping" behaviour.
+     *
+     * @param {View} incomingView
+     * @param {View} exitingView
+     */
+    execute(incomingView: View, exitingView: View): Promise<void>;
+    protected abstract _execute(incomingView: View, exitingView: View): Promise<void>;
+}

package/dist/src/URLParser.d.ts

@@ -1,39 +1,39 @@
-export interface IURLParams {
-    [key: string]: string;
-}
-/**
- * Parses the URL for router paths and url-based variables.
- */
-export declare class URLParser {
-    private $allowPartialMatch;
-    private $pattern;
-    /**
-     *
-     * @param {string} pattern The URL pattern
-     * @param {boolean} allowPartialMatch   If true, the pattern will match again urls that contains the pattern,
-     *                                      even if it isn't an exact match.
-     *                                      Defaults to false.
-     */
-    constructor(pattern: string, allowPartialMatch?: boolean);
-    /**
-     * Parses the URL and returns the url parameters.
-     * Returns null the url does not match the pattern
-     *
-     * @param {string} url The url to test
-     */
-    parse(url: string): IURLParams;
-    /**
-     * Strips the url for parsing, removing leading and trailing forward slashes.
-     *
-     * @private
-     * @param {string} url URL to strip
-     */
-    private $stripURL;
-    /**
-     * Splits the url into an array of URL parts, separated by the forward slash
-     *
-     * @private
-     * @param {string} url URL to split
-     */
-    private $getParts;
-}
+export interface IURLParams {
+    [key: string]: string;
+}
+/**
+ * Parses the URL for router paths and url-based variables.
+ */
+export declare class URLParser {
+    private $allowPartialMatch;
+    private $pattern;
+    /**
+     *
+     * @param {string} pattern The URL pattern
+     * @param {boolean} allowPartialMatch   If true, the pattern will match again urls that contains the pattern,
+     *                                      even if it isn't an exact match.
+     *                                      Defaults to false.
+     */
+    constructor(pattern: string, allowPartialMatch?: boolean);
+    /**
+     * Parses the URL and returns the url parameters.
+     * Returns null the url does not match the pattern
+     *
+     * @param {string} url The url to test
+     */
+    parse(url: string): IURLParams;
+    /**
+     * Strips the url for parsing, removing leading and trailing forward slashes.
+     *
+     * @private
+     * @param {string} url URL to strip
+     */
+    private $stripURL;
+    /**
+     * Splits the url into an array of URL parts, separated by the forward slash
+     *
+     * @private
+     * @param {string} url URL to split
+     */
+    private $getParts;
+}

package/dist/src/URLStrategy.d.ts

@@ -1,32 +1,32 @@
-import { RouterStrategy } from './RouterStrategy';
-import { Router } from './Router';
-/**
- * @notice Using the URLStrategy requires some backend configuration
- * to route URLs back to application.
- *
- * To make this easier, by default these URLs are prefixed with
- * `/r/` to easily differentiate between URLs that needs to be re-routed back
- * to the application vs other resources such as images.
- */
-export declare class URLStrategy extends RouterStrategy {
-    private $base;
-    private $stack;
-    private $position;
-    /**
-     *
-     * @param {Router} router
-     */
-    constructor(router: Router);
-    private $init;
-    getLocation(): string;
-    getLocationAt(position: number): string;
-    getHistoryLength(): number;
-    getScrollRestoration(): ScrollRestoration;
-    peek(to: number): string;
-    canGo(to: number): boolean;
-    go(to: number): void;
-    pushState(url: string, state?: Record<any, any>): void;
-    replaceState(url: string, state?: Record<any, any>): void;
-    clear(): void;
-    private $navigate;
-}
+import { RouterStrategy } from './RouterStrategy';
+import { Router } from './Router';
+/**
+ * @notice Using the URLStrategy requires some backend configuration
+ * to route URLs back to application.
+ *
+ * To make this easier, by default these URLs are prefixed with
+ * `/r/` to easily differentiate between URLs that needs to be re-routed back
+ * to the application vs other resources such as images.
+ */
+export declare class URLStrategy extends RouterStrategy {
+    private $base;
+    private $stack;
+    private $position;
+    /**
+     *
+     * @param {Router} router
+     */
+    constructor(router: Router);
+    private $init;
+    getLocation(): string;
+    getLocationAt(position: number): string;
+    getHistoryLength(): number;
+    getScrollRestoration(): ScrollRestoration;
+    peek(to: number): string;
+    canGo(to: number): boolean;
+    go(to: number): void;
+    pushState(url: string, state?: Record<any, any>): void;
+    replaceState(url: string, state?: Record<any, any>): void;
+    clear(): void;
+    private $navigate;
+}

package/dist/src/View.d.ts

@@ -1,49 +1,48 @@
-import "regenerator-runtime/runtime";
-import * as React from 'react';
-import { RouterStrategy } from './RouterStrategy';
-import { TransitionStrategy } from './TransitionStrategy';
-import { IViewStylesheet } from './IViewStylesheet';
-import "./View.scss";
-export interface IViewProps {
-    router: RouterStrategy;
-    entryTransition?: TransitionStrategy;
-    exitTransition?: TransitionStrategy;
-}
-export declare abstract class View<TPageProps extends IViewProps = IViewProps> extends React.Component<TPageProps> {
-    private $node;
-    /**
-     * @param props See [IViewProps]
-     */
-    constructor(props: TPageProps);
-    /**
-     * Return the CSS class on this view
-     */
-    getCSSClass(): string;
-    /**
-     * Override to return a webpack API style stylesheet
-     */
-    getViewStylesheet(): IViewStylesheet;
-    /**
-     * @ignore
-     */
-    componentDidMount(): void;
-    /**
-     * @ignore
-     */
-    componentWillUnmount(): void;
-    /**
-     * Gets the underlying HTML node for this View
-     */
-    getNode(): HTMLElement;
-    /**
-     * Get the title of this view
-     */
-    getTitle(): Promise<string>;
-    /**
-     * Get the inline styles for this view.
-     * Use React style notation.
-     */
-    getViewStyles(): Record<any, string>;
-    protected abstract _renderView(): React.ReactNode;
-    render(): React.ReactNode;
-}
+import * as React from 'react';
+import { RouterStrategy } from './RouterStrategy';
+import { TransitionStrategy } from './TransitionStrategy';
+import { IViewStylesheet } from './IViewStylesheet';
+import "./View.scss";
+export interface IViewProps {
+    router: RouterStrategy;
+    entryTransition?: TransitionStrategy;
+    exitTransition?: TransitionStrategy;
+}
+export declare abstract class View<TPageProps extends IViewProps = IViewProps> extends React.Component<TPageProps> {
+    private $node;
+    /**
+     * @param props See [IViewProps]
+     */
+    constructor(props: TPageProps);
+    /**
+     * Return the CSS class on this view
+     */
+    getCSSClass(): string;
+    /**
+     * Override to return a webpack API style stylesheet
+     */
+    getViewStylesheet(): IViewStylesheet;
+    /**
+     * @ignore
+     */
+    componentDidMount(): void;
+    /**
+     * @ignore
+     */
+    componentWillUnmount(): void;
+    /**
+     * Gets the underlying HTML node for this View
+     */
+    getNode(): HTMLElement;
+    /**
+     * Get the title of this view
+     */
+    getTitle(): Promise<string>;
+    /**
+     * Get the inline styles for this view.
+     * Use React style notation.
+     */
+    getViewStyles(): Record<any, string>;
+    protected abstract _renderView(): React.ReactNode;
+    render(): React.ReactNode;
+}

package/dist/src/api.d.ts

@@ -1,14 +1,13 @@
-import "regenerator-runtime/runtime";
-export * from './Router';
-export * from './DefaultStrategy';
-export * from './HashStrategy';
-export * from './URLStrategy';
-export * from './Route';
-export * from './RouterStrategy';
-export * from './RouteMatcher';
-export * from './TransitionStrategy';
-export * from './TransitionSlide';
-export * from './View';
-export * from './IViewStylesheet';
-declare const VERSION: string;
-export { VERSION as version };
+export * from './Router';
+export * from './DefaultStrategy';
+export * from './HashStrategy';
+export * from './URLStrategy';
+export * from './Route';
+export * from './RouterStrategy';
+export * from './RouteMatcher';
+export * from './TransitionStrategy';
+export * from './TransitionSlide';
+export * from './View';
+export * from './IViewStylesheet';
+declare const VERSION: string;
+export { VERSION as version };