@rxdi/router 0.7.190 → 0.7.191-nightly.0

package/dist/decorators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteParams = void 0;
+exports.RouteParams = RouteParams;
 /**
  * Define getter to `this.location.params` from component `this` and assign params to decorated property
  *
@@ -36,4 +36,3 @@ function RouteParams() {
         });
     };
 }
-exports.RouteParams = RouteParams;

package/dist/helpers.js

@@ -9,7 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getQueryParams = exports.loadRoutes = exports.ChildRoutesObservable = void 0;
+exports.ChildRoutesObservable = void 0;
+exports.loadRoutes = loadRoutes;
+exports.getQueryParams = getQueryParams;
 const rxjs_1 = require("rxjs");
 const injection_tokens_1 = require("./injection.tokens");
 const core_1 = require("@rxdi/core");
@@ -106,7 +108,6 @@ function loadRoutes(routes) {
     exports.ChildRoutesObservable.next(null);
     return r;
 }
-exports.loadRoutes = loadRoutes;
 function getQueryParams(params) {
     const uriParams = new URLSearchParams(location.search);
     return params.reduce((prev, curr) => {
@@ -114,4 +115,3 @@ function getQueryParams(params) {
         return prev;
     }, {});
 }
-exports.getQueryParams = getQueryParams;

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -44,10 +48,10 @@ let RouterModule = RouterModule_1 = class RouterModule {
         return RouterModule_1;
     }
 };
-RouterModule = RouterModule_1 = __decorate([
+exports.RouterModule = RouterModule;
+exports.RouterModule = RouterModule = RouterModule_1 = __decorate([
     (0, core_1.Module)()
 ], RouterModule);
-exports.RouterModule = RouterModule;
 __exportStar(require("./injection.tokens"), exports);
 __exportStar(require("./outlet"), exports);
 __exportStar(require("./decorators"), exports);

package/dist/injection.tokens.d.ts

@@ -3,8 +3,8 @@ import { Outlet } from './outlet';
 export interface NavigationTrigger {
 }
 export declare function Router(): (target: Object, propertyKey: string) => void;
-export declare type LazyChildren = (context?: CanActivateContext, commands?: CanActivateCommands) => Promise<any>;
-export declare type Router = Outlet;
+export type LazyChildren = (context?: CanActivateContext, commands?: CanActivateCommands) => Promise<any>;
+export type Router = Outlet;
 export interface Route<C = any> {
     path: string;
     component?: C | Function | string;
@@ -59,8 +59,8 @@ export interface RouterOptions {
     log?: boolean;
     freeze?: boolean;
 }
-export declare type Routes = Route<any>[];
-export declare type RouterRoutlet = Outlet;
+export type Routes = Route<any>[];
+export type RouterRoutlet = Outlet;
 export interface OnBeforeEnter {
     onBeforeEnter(): Promise<any> | void;
 }

package/dist/injection.tokens.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouterOptions = exports.Routes = exports.RouterRoutlet = exports.Router = void 0;
+exports.RouterOptions = exports.Routes = exports.RouterRoutlet = void 0;
+exports.Router = Router;
 const core_1 = require("@rxdi/core");
 function Router() {
     return (target, propertyKey) => {
@@ -9,7 +10,6 @@ function Router() {
         });
     };
 }
-exports.Router = Router;
 exports.RouterRoutlet = 'router-outlet';
 exports.Routes = 'router-routes';
 exports.RouterOptions = 'router-options';

package/dist/not-found.component.js

@@ -10,7 +10,8 @@ exports.NotFoundPathConfig = exports.NotFoundComponent = void 0;
 const lit_html_1 = require("@rxdi/lit-html");
 let NotFoundComponent = class NotFoundComponent extends lit_html_1.LitElement {
 };
-NotFoundComponent = __decorate([
+exports.NotFoundComponent = NotFoundComponent;
+exports.NotFoundComponent = NotFoundComponent = __decorate([
     (0, lit_html_1.Component)({
         selector: 'not-found-component-rxdi',
         template: () => (0, lit_html_1.html) `
@@ -19,7 +20,6 @@ NotFoundComponent = __decorate([
  `,
     })
 ], NotFoundComponent);
-exports.NotFoundComponent = NotFoundComponent;
 exports.NotFoundPathConfig = {
     path: '(.*)',
     component: 'not-found-component-rxdi',

package/dist/router.component.js

@@ -29,6 +29,7 @@ let RouterComponent = class RouterComponent extends lit_html_1.LitElement {
         this.dispatchEvent(new CustomEvent('onRouterLoaded', { detail: router }));
     }
 };
+exports.RouterComponent = RouterComponent;
 __decorate([
     (0, lit_html_1.property)(),
     __metadata("design:type", String)
@@ -37,7 +38,7 @@ __decorate([
     (0, lit_html_1.property)({ type: Array }),
     __metadata("design:type", Array)
 ], RouterComponent.prototype, "routes", void 0);
-RouterComponent = __decorate([
+exports.RouterComponent = RouterComponent = __decorate([
     (0, lit_html_1.Component)({
         selector: "router-outlet",
         template() {
@@ -49,4 +50,3 @@ RouterComponent = __decorate([
         },
     })
 ], RouterComponent);
-exports.RouterComponent = RouterComponent;

package/dist/slot/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/slot/slot.js

@@ -25,6 +25,7 @@ let RouterSlots = class RouterSlots extends lit_html_1.LitElement {
         this.routerSlot.add(this.slots);
     }
 };
+exports.RouterSlots = RouterSlots;
 __decorate([
     (0, lit_html_1.property)({ type: Array }),
     __metadata("design:type", Array)
@@ -33,7 +34,7 @@ __decorate([
     (0, lit_html_1.query)('router-slot'),
     __metadata("design:type", router_slot_1.RouterSlot)
 ], RouterSlots.prototype, "routerSlot", void 0);
-RouterSlots = __decorate([
+exports.RouterSlots = RouterSlots = __decorate([
     (0, lit_html_1.Component)({
         selector: 'router-slots',
         template() {
@@ -41,4 +42,3 @@ RouterSlots = __decorate([
         },
     })
 ], RouterSlots);
-exports.RouterSlots = RouterSlots;

package/dist/vaadin/vaadin-router.d.ts

@@ -36,14 +36,14 @@ export class Resolver {
      *
      * @return {!Array<!Router.Route>}
      */
-    getRoutes(): Array<any>;
+    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<any> | any): void;
+    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.
@@ -53,7 +53,7 @@ export class Resolver {
      * @return {!Array<!Router.Route>}
      * @protected
      */
-    protected addRoutes(routes: Array<any> | any): Array<any>;
+    protected addRoutes(routes: Array<Router.Route> | Router.Route): Array<Router.Route>;
     /**
      * Removes all existing routes from the routing config.
      */
@@ -160,7 +160,18 @@ export class Router extends Resolver {
      * @param {?Node=} outlet
      * @param {?RouterOptions=} options
      */
-    constructor(outlet?: (Node | null) | undefined, options?: any);
+    constructor(outlet?: (Node | null) | undefined, options?: (RouterOptions | null) | undefined);
+    resolveRoute: (context: any) => Promise<any>;
+    /**
+     * 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}
+     */
+    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
@@ -169,7 +180,7 @@ export class Router extends Resolver {
      * @public
      * @type {!Promise<!RouterLocation>}
      */
-    public ready: Promise<any>;
+    public ready: Promise<RouterLocation>;
     /**
      * Contains read-only information about the current router location:
      * pathname, active routes, parameters. See the
@@ -179,7 +190,7 @@ export class Router extends Resolver {
      * @public
      * @type {!RouterLocation}
      */
-    public location: any;
+    public location: RouterLocation;
     __lastStartedRenderId: number;
     __navigationEventHandler: any;
     __createdByRouter: WeakMap<object, any>;
@@ -203,6 +214,95 @@ export class Router extends Resolver {
      * @return {?Node} the current router outlet (or `undefined`)
      */
     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
+     * current `window.location` and the new routing config.
+     *
+     * Each route object may have the following properties, listed here in the processing order:
+     * * `path` – the route path (relative to the parent route if any) in the
+     * [express.js syntax](https://expressjs.com/en/guide/routing.html#route-paths").
+     *
+     * * `children` – an array of nested routes or a function that provides this
+     * array at the render time. The function can be synchronous or asynchronous:
+     * in the latter case the render is delayed until the returned promise is
+     * resolved. The `children` function is executed every time when this route is
+     * being rendered. This allows for dynamic route structures (e.g. backend-defined),
+     * but it might have a performance impact as well. In order to avoid calling
+     * the function on subsequent renders, you can override the `children` property
+     * of the route object and save the calculated array there
+     * (via `context.route.children = [ route1, route2, ...];`).
+     * Parent routes are fully resolved before resolving the children. Children
+     * 'path' values are relative to the parent ones.
+     *
+     * * `action` – the action that is executed before the route is resolved.
+     * The value for this property should be a function, accepting `context`
+     * and `commands` parameters described below. If present, this function is
+     * always invoked first, disregarding of the other properties' presence.
+     * The action can return a result directly or within a `Promise`, which
+     * resolves to the result. If the action result is an `HTMLElement` instance,
+     * a `commands.component(name)` result, a `commands.redirect(path)` result,
+     * or a `context.next()` result, the current route resolution is finished,
+     * and other route config properties are ignored.
+     * See also **Route Actions** section in [Live Examples](#/classes/Router/demos/demo/index.html).
+     *
+     * * `redirect` – other route's path to redirect to. Passes all route parameters to the redirect target.
+     * The target route should also be defined.
+     * See also **Redirects** section in [Live Examples](#/classes/Router/demos/demo/index.html).
+     *
+     * * `bundle` – string containing the path to `.js` or `.mjs` bundle to load before resolving the route,
+     * or the object with "module" and "nomodule" keys referring to different bundles.
+     * Each bundle is only loaded once. If "module" and "nomodule" are set, only one bundle is loaded,
+     * depending on whether the browser supports ES modules or not.
+     * The property is ignored when either an `action` returns the result or `redirect` property is present.
+     * Any error, e.g. 404 while loading bundle will cause route resolution to throw.
+     * See also **Code Splitting** section in [Live Examples](#/classes/Router/demos/demo/index.html).
+     *
+     * * `component` – the tag name of the Web Component to resolve the route to.
+     * The property is ignored when either an `action` returns the result or `redirect` property is present.
+     * If route contains the `component` property (or an action that return a component)
+     * and its child route also contains the `component` property, child route's component
+     * will be rendered as a light dom child of a parent component.
+     *
+     * * `name` – the string name of the route to use in the
+     * [`router.urlForName(name, params)`](#/classes/Router#method-urlForName)
+     * navigation helper method.
+     *
+     * For any route function (`action`, `children`) defined, the corresponding `route` object is available inside the callback
+     * through the `this` reference. If you need to access it, make sure you define the callback as a non-arrow function
+     * because arrow functions do not have their own `this` reference.
+     *
+     * `context` object that is passed to `action` function holds the following properties:
+     * * `context.pathname` – string with the pathname being resolved
+     *
+     * * `context.search` – search query string
+     *
+     * * `context.hash` – hash string
+     *
+     * * `context.params` – object with route parameters
+     *
+     * * `context.route` – object that holds the route that is currently being rendered.
+     *
+     * * `context.next()` – function for asynchronously getting the next route
+     * contents from the resolution chain (if any)
+     *
+     * `commands` object that is passed to `action` function has
+     * the following methods:
+     *
+     * * `commands.redirect(path)` – function that creates a redirect data
+     * for the path specified.
+     *
+     * * `commands.component(component)` – function that creates a new HTMLElement
+     * 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
+     *     route corresponding to the current `window.location` values
+     *
+     * @return {!Promise<!Node>}
+     */
+    setRoutes(routes: Array<Route> | Route, skipRender?: boolean | null): Promise<Node>;
     __previousContext: any;
     __urlForName: (routeName: any, params: any) => any;
     /**
@@ -287,7 +387,7 @@ export class Router extends Resolver {
      *
      * @return {string}
      */
-    urlForName(name: string, params?: any): string;
+    urlForName(name: string, params?: Params | undefined): string;
     /**
      * Generates a URL for the given route path, optionally performing
      * substitution of parameters.
@@ -299,5 +399,5 @@ export class Router extends Resolver {
      *
      * @return {string}
      */
-    urlForPath(path: string, params?: any): string;
+    urlForPath(path: string, params?: Params | undefined): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rxdi/router",
-  "version": "0.7.190",
+  "version": "0.7.191-nightly.0",
   "main": "./dist/index.js",
   "author": "Kristiyan Tachev",
   "license": "MIT",
@@ -15,8 +15,8 @@
     "router-slot": "^1.5.4"
   },
   "devDependencies": {
-    "@rxdi/core": "^0.7.189",
-    "@rxdi/lit-html": "^0.7.189"
+    "@rxdi/core": "^0.7.190",
+    "@rxdi/lit-html": "^0.7.190"
   },
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",