@rxdi/router 0.7.219 → 0.7.221

package/dist/{vaadin/vaadin-router.d.ts → lib/router.d.ts}

@@ -1,101 +1,6 @@
-export type NavigationTrigger = {
-    activate: () => any;
-    /**
-     * Configures what triggers Router navigation events:
-     *  - `POPSTATE`: popstate events on the current `window`
-     *  - `CLICK`: click events on `<a>` links leading to the current page
-     *
-     * This method is invoked with the pre-configured values when creating a new Router instance.
-     * By default, both `POPSTATE` and `CLICK` are enabled. This setup is expected to cover most of the use cases.
-     *
-     * See the `router-config.js` for the default navigation triggers config. Based on it, you can
-     * create the own one and only import the triggers you need, instead of pulling in all the code,
-     * e.g. if you want to handle `click` differently.
-     *
-     * See also **Navigation Triggers** section in [Live Examples](#/classes/Router/demos/demo/index.html).
-     */
-    inactivate: () => any;
-};
-/**
- */
-export class Resolver {
-    /**
-     * URL constructor polyfill hook. Creates and returns an URL instance.
-     */
-    static __createUrl(url: any, base: any): URL;
-    constructor(routes: any, options?: {});
-    baseUrl: any;
-    errorHandler: any;
-    resolveRoute: any;
-    context: any;
-    root: any;
-    /**
-     * Returns the current list of routes (as a shallow copy). Adding / removing
-     * routes to / from the returned array does not affect the routing config,
-     * but modifying the route objects does.
-     *
-     * @return {!Array<!Router.Route>}
-     */
-    getRoutes(): Array<Router.Route>;
-    /**
-     * Sets the routing config (replacing the existing one).
-     *
-     * @param {!Array<!Router.Route>|!Router.Route} routes a single route or an array of those
-     *    (the array is shallow copied)
-     */
-    setRoutes(routes: Array<Router.Route> | Router.Route): void;
-    /**
-     * Appends one or several routes to the routing config and returns the
-     * effective routing config after the operation.
-     *
-     * @param {!Array<!Router.Route>|!Router.Route} routes a single route or an array of those
-     *    (the array is shallow copied)
-     * @return {!Array<!Router.Route>}
-     * @protected
-     */
-    protected addRoutes(routes: Array<Router.Route> | Router.Route): Array<Router.Route>;
-    /**
-     * Removes all existing routes from the routing config.
-     */
-    removeRoutes(): void;
-    /**
-     * Asynchronously resolves the given pathname, i.e. finds all routes matching
-     * the pathname and tries resolving them one after another in the order they
-     * are listed in the routes config until the first non-null result.
-     *
-     * Returns a promise that is fulfilled with the return value of an object that consists of the first
-     * route handler result that returns something other than `null` or `undefined` and context used to get this result.
-     *
-     * If no route handlers return a non-null result, or if no route matches the
-     * given pathname the returned promise is rejected with a 'page not found'
-     * `Error`.
-     *
-     * @param {!string|!{pathname: !string}} pathnameOrContext the pathname to
-     *    resolve or a context object with a `pathname` property and other
-     *    properties to pass to the route resolver functions.
-     * @return {!Promise<any>}
-     */
-    resolve(pathnameOrContext: string | {
-        pathname: string;
-    }): Promise<any>;
-    /**
-     * If the baseUrl property is set, transforms the baseUrl and returns the full
-     * actual `base` string for using in the `new URL(path, base);` and for
-     * prepernding the paths with. The returned base ends with a trailing slash.
-     *
-     * Otherwise, returns empty string.
-     */
-    get __effectiveBaseUrl(): any;
-    /**
-     * If the baseUrl is set, matches the pathname with the router’s baseUrl,
-     * and returns the local pathname with the baseUrl stripped out.
-     *
-     * If the pathname does not match the baseUrl, returns undefined.
-     *
-     * If the `baseUrl` is not set, returns the unmodified pathname argument.
-     */
-    __normalizePathname(pathname: any): any;
-}
+import { Resolver } from './resolver';
+import { ChainItem, PreventResult, RedirectResult, // fix for shadowing
+Route, RouteContext, RouteParams, RouteResult, RouterLocation, RouterOptions } from './types';
 /**
  * A simple client-side router for single-page applications. It uses
  * express-style middleware and has a first-class support for Web Components and
@@ -131,23 +36,18 @@ export class Resolver {
  *    a given path. It can re-render when triggered or automatically on
  *    'popstate' and / or 'click' events.
  */
-export class Router extends Resolver {
-    /**
-     * Triggers navigation to a new path. Returns a boolean without waiting until
-     * the navigation is complete. Returns `true` if at least one `Router`
-     * has handled the navigation (was subscribed and had `baseUrl` matching
-     * the `path` argument), otherwise returns `false`.
-     *
-     * @param {!string|!{pathname: !string, search: (string|undefined), hash: (string|undefined)}} path
-     *   a new in-app path string, or an URL-like object with `pathname`
-     *   string property, and optional `search` and `hash` string properties.
-     * @return {boolean}
-     */
-    static go(path: string | {
-        pathname: string;
-        search: (string | undefined);
-        hash: (string | undefined);
-    }): boolean;
+export declare class Router extends Resolver {
+    ready: Promise<RouterLocation | Node | undefined>;
+    location: RouterLocation;
+    __lastStartedRenderId: number;
+    __navigationEventHandler: (event?: CustomEvent) => void;
+    __outlet?: Node;
+    __previousContext?: RouteContext;
+    __urlForName?: (routeName: string, params?: RouteParams) => string;
+    __createdByRouter: WeakMap<HTMLElement, boolean>;
+    __addedByRouter: WeakMap<HTMLElement, boolean>;
+    __appearingContent?: HTMLElement[] | null;
+    __disappearingContent?: HTMLElement[] | null;
     /**
      * Creates a new Router instance with a given outlet, and
      * automatically subscribes it to navigation events on the `window`.
@@ -157,45 +57,16 @@ export class Router extends Resolver {
      * const router = new Router();
      * router.setOutlet(outlet);
      * ```
-     * @param {?Node=} outlet
-     * @param {?RouterOptions=} options
+     * @param outlet
+     * @param options
      */
-    constructor(outlet?: (Node | null) | undefined, options?: (RouterOptions | null) | undefined);
-    resolveRoute: (context: any) => Promise<any>;
+    constructor(outlet?: Node, options?: RouterOptions);
+    __resolveRoute(context: RouteContext): Promise<RouteResult | undefined>;
     /**
-     * The base URL for all routes in the router instance. By default,
-     * if the base element exists in the `<head>`, vaadin-router
-     * takes the `<base href>` attribute value, resolves against current `document.URL`
-     * and gets the `pathname` from the result.
-     *
-     * @public
-     * @type {string}
+     * Takes current routes and set it
+     * @param routes: Route<C>[]
+     * @returns void
      */
-    public baseUrl: string;
-    /**
-     * A promise that is settled after the current render cycle completes. If
-     * there is no render cycle in progress the promise is immediately settled
-     * with the last render cycle result.
-     *
-     * @public
-     * @type {!Promise<!RouterLocation>}
-     */
-    public ready: Promise<RouterLocation>;
-    /**
-     * Contains read-only information about the current router location:
-     * pathname, active routes, parameters. See the
-     * [Location type declaration](#/classes/RouterLocation)
-     * for more details.
-     *
-     * @public
-     * @type {!RouterLocation}
-     */
-    public location: RouterLocation;
-    __lastStartedRenderId: number;
-    __navigationEventHandler: any;
-    __createdByRouter: WeakMap<object, any>;
-    __addedByRouter: WeakMap<object, any>;
-    __resolveRoute(context: any): Promise<any>;
     /**
      * Sets the router outlet (the DOM node where the content for the current
      * route is inserted). Any content pre-existing in the router outlet is
@@ -203,17 +74,24 @@ export class Router extends Resolver {
      *
      * NOTE: this method is automatically invoked first time when creating a new Router instance.
      *
-     * @param {?Node} outlet the DOM node where the content for the current route
+     * @param outlet the DOM node where the content for the current route
      *     is inserted.
      */
-    setOutlet(outlet: Node | null): void;
-    __outlet: Node;
+    setOutlet(outlet?: Node): void;
+    /**
+     * Returns the current router outlet. The initial value is undefined.
+     */
     /**
-     * Returns the current router outlet. The initial value is `undefined`.
+     * Returns the current router outlet. The initial value is undefined.
      *
-     * @return {?Node} the current router outlet (or `undefined`)
+     * @return the current router outlet (or `undefined`)
+     */
+    getOutlet(): Node | undefined;
+    /**
+     * Takes current routes and set it
+     * @param routes: Route | Route[]
+     * @returns Route | Route[]
      */
-    getOutlet(): Node | null;
     /**
      * Sets the routing config (replacing the existing one) and triggers a
      * navigation event so that the router outlet is refreshed according to the
@@ -296,15 +174,20 @@ export class Router extends Resolver {
      * with current context. Note: the component created by this function is reused if visiting the same path twice in row.
      *
      *
-     * @param {!Array<!Route>|!Route} routes a single route or an array of those
-     * @param {?boolean} skipRender configure the router but skip rendering the
+     * @param routes a single route or an array of those
+     * @param skipRender configure the router but skip rendering the
      *     route corresponding to the current `window.location` values
      *
-     * @return {!Promise<!Node>}
+     * @return
+     */
+    setRoutes(routes: Route | Route[], skipRender?: boolean): Promise<RouterLocation | Node | undefined>;
+    /**
+     * Asynchronously resolves the given pathname and renders the resolved route component into the router outlet. If no router outlet is set at the time of calling this method, or at the time when the route resolution is completed, a TypeError is thrown.
+     * Returns a promise that is fulfilled with the router outlet DOM Node after the route component is created and inserted into the router outlet, or rejected if no route matches the given path.
+     * If another render pass is started before the previous one is completed, the result of the previous render pass is ignored.
+     * @param pathnameOrContext — the pathname to render or a context object with a pathname property and other properties to pass to the resolver.
+     * @param shouldUpdateHistory
      */
-    setRoutes(routes: Array<Route> | Route, skipRender?: boolean | null): Promise<Node>;
-    __previousContext: any;
-    __urlForName: (routeName: any, params: any) => any;
     /**
      * Asynchronously resolves the given pathname and renders the resolved route
      * component into the router outlet. If no router outlet is set at the time of
@@ -318,43 +201,42 @@ export class Router extends Resolver {
      * If another render pass is started before the previous one is completed, the
      * result of the previous render pass is ignored.
      *
-     * @param {!string|!{pathname: !string, search: ?string, hash: ?string}} pathnameOrContext
+     * @param pathnameOrContext
      *    the pathname to render or a context object with a `pathname` property,
      *    optional `search` and `hash` properties, and other properties
      *    to pass to the resolver.
-     * @param {boolean=} shouldUpdateHistory
+     * @param shouldUpdateHistory
      *    update browser history with the rendered location
-     * @return {!Promise<!Node>}
+     * @return
      */
-    render(pathnameOrContext: string | {
+    render(pathnameOrContext: string | Partial<RouteContext>, shouldUpdateHistory?: boolean): Promise<RouterLocation | Node | undefined>;
+    __fullyResolveChain(topOfTheChainContextBeforeRedirects: RouteContext, contextBeforeRedirects?: RouteContext): Promise<RouteContext>;
+    __findComponentContextAfterAllRedirects(context: RouteContext): Promise<RouteContext>;
+    __amendWithOnBeforeCallbacks(contextWithFullChain: RouteContext): Promise<RouteContext>;
+    __runOnBeforeCallbacks(newContext: RouteContext): Promise<RouteContext>;
+    __runOnBeforeLeaveCallbacks(callbacks: Promise<PreventResult | RedirectResult | void | undefined>, newContext: RouteContext, commands: {
+        prevent: () => PreventResult;
+    }, chainElement: ChainItem): Promise<PreventResult | RedirectResult | void | undefined>;
+    __runOnBeforeEnterCallbacks(callbacks: Promise<PreventResult | RedirectResult | void | undefined>, newContext: RouteContext, commands: {
+        prevent: () => PreventResult;
+        redirect: (pathname: string) => RedirectResult;
+    }, chainElement: ChainItem): Promise<PreventResult | RedirectResult | void | undefined>;
+    __isReusableElement(element?: HTMLElement, otherElement?: HTMLElement): boolean;
+    __isLatestRender(context: RouteContext): boolean;
+    __redirect(redirectData: {
         pathname: string;
-        search: string | null;
-        hash: string | null;
-    }, shouldUpdateHistory?: boolean | undefined): Promise<Node>;
-    __fullyResolveChain(topOfTheChainContextBeforeRedirects: any, contextBeforeRedirects?: any): any;
-    __findComponentContextAfterAllRedirects(context: any): any;
-    __amendWithOnBeforeCallbacks(contextWithFullChain: any): Promise<any>;
-    __runOnBeforeCallbacks(newContext: any): Promise<any>;
-    __runOnBeforeLeaveCallbacks(callbacks: any, newContext: any, commands: any, chainElement: any): any;
-    __runOnBeforeEnterCallbacks(callbacks: any, newContext: any, commands: any, chainElement: any): any;
-    __isReusableElement(element: any, otherElement: any): boolean;
-    __isLatestRender(context: any): boolean;
-    __redirect(redirectData: any, counter: any, renderId: any): Promise<any>;
+        from: string;
+        params: RouteParams;
+    }, counter?: number, renderId?: number): Promise<RouteContext>;
     __ensureOutlet(outlet?: Node): void;
-    __updateBrowserHistory({ pathname, search, hash }: {
-        pathname: any;
-        search?: string;
-        hash?: string;
-    }, replace: any): void;
-    __copyUnchangedElements(context: any, previousContext: any): Node;
-    __addAppearingContent(context: any, previousContext: any): void;
-    __appearingContent: any[];
-    __disappearingContent: any[];
+    __updateBrowserHistory({ pathname, search, hash }: RouteContext, replace?: boolean): void;
+    __copyUnchangedElements(context: RouteContext, previousContext?: RouteContext): HTMLElement | Node;
+    __addAppearingContent(context: RouteContext, previousContext?: RouteContext): void;
     __removeDisappearingContent(): void;
     __removeAppearingContent(): void;
-    __runOnAfterLeaveCallbacks(currentContext: any, targetContext: any): void;
-    __runOnAfterEnterCallbacks(currentContext: any): void;
-    __animateIfNeeded(context: any): Promise<any>;
+    __runOnAfterLeaveCallbacks(currentContext: RouteContext, targetContext?: RouteContext): void;
+    __runOnAfterEnterCallbacks(currentContext: RouteContext): void;
+    __animateIfNeeded(context: RouteContext): Promise<RouteContext>;
     /**
      * Subscribes this instance to navigation events on the `window`.
      *
@@ -367,7 +249,7 @@ export class Router extends Resolver {
      * method.
      */
     unsubscribe(): void;
-    __onNavigationEvent(event: any): void;
+    __onNavigationEvent(event?: CustomEvent): void;
     /**
      * Generates a URL for the route with the given name, optionally performing
      * substitution of parameters.
@@ -379,25 +261,40 @@ export class Router extends Resolver {
      * It is not possible to generate URLs using a name for routes set with
      * a children function.
      *
-     * @function urlForName
-     * @param {!string} name the route name or the route’s `component` name.
-     * @param {Params=} params Optional object with route path parameters.
+     * @param name the route name or the route’s `component` name.
+     * @param params Optional object with route path parameters.
      * Named parameters are passed by name (`params[name] = value`), unnamed
      * parameters are passed by index (`params[index] = value`).
      *
-     * @return {string}
+     * @return
      */
-    urlForName(name: string, params?: Params | undefined): string;
+    urlForName(name: string, params?: RouteParams): string;
     /**
      * Generates a URL for the given route path, optionally performing
      * substitution of parameters.
      *
-     * @param {!string} path string route path declared in [express.js syntax](https://expressjs.com/en/guide/routing.html#route-paths").
-     * @param {Params=} params Optional object with route path parameters.
+     * @param path string route path declared in [express.js syntax](https://expressjs.com/en/guide/routing.html#route-paths").
+     * @param params Optional object with route path parameters.
      * Named parameters are passed by name (`params[name] = value`), unnamed
      * parameters are passed by index (`params[index] = value`).
      *
-     * @return {string}
+     * @return
      */
-    urlForPath(path: string, params?: Params | undefined): string;
+    urlForPath(path: string, params?: RouteParams): string;
+    /**
+     * Triggers navigation to a new path. Returns a boolean without waiting until
+     * the navigation is complete. Returns `true` if at least one `Router`
+     * has handled the navigation (was subscribed and had `baseUrl` matching
+     * the `path` argument), otherwise returns `false`.
+     *
+     * @param path
+     *   a new in-app path string, or an URL-like object with `pathname`
+     *   string property, and optional `search` and `hash` string properties.
+     * @return
+     */
+    static go(path: string | {
+        pathname: string;
+        search?: string;
+        hash?: string;
+    }): boolean;
 }