piral-dashboard 0.14.9 → 0.15.0-alpha.3549

package/README.md

@@ -116,17 +116,35 @@ const instance = createInstance({
 });
 ```
 
-To fully integrate the dashboard the `Dashboard` component can be used. It can be part of a page or a page itself:
+By default, the dashboard is located at the homepage (`/`). You can change this via the `routes` setting:
 
-```jsx
-<SetRoute path="/" component={Dashboard} />
+```ts
+const instance = createInstance({
+  // important part
+  plugins: [createDashboardApi({
+    routes: ['/dashboard'],
+  })],
+  // ...
+});
 ```
 
-The `Dashboard` component also comes with a prop called `filter`, which might be handy together with custom options for actually using multiple dashboards.
+Or alternatively, don't use any route for it and just reference the `Dashboard` component on any page or within the layout.
+
+```ts
+// for the instance
+const instance = createInstance({
+  // important part
+  plugins: [createDashboardApi({
+    routes: [],
+  })],
+  // ...
+});
+
+
+// in some component, maybe even in the layout
+import { Dashboard } from 'piral-dashboard';
 
-```jsx
-<SetRoute path="/dashboard1" component={props => <Dashboard {...props} filter={tile => tile.preferences.category === 'self'} />} />
-<SetRoute path="/dashboard2" component={props => <Dashboard {...props} filter={tile => tile.preferences.category === 'group'} />} />
+// then use: <Dashboard />
 ```
 
 ### Customizing

package/esm/create.d.ts

@@ -1,20 +1,14 @@
-import { ComponentType } from 'react';
 import { PiralPlugin } from 'piral-core';
-import { PiletDashboardApi, TilePreferences, BareTileComponentProps } from './types';
-export interface InitialTile {
-    /**
-     * Defines the component to be used for the tile.
-     */
-    component: ComponentType<BareTileComponentProps>;
-    /**
-     * Optionally sets the preferences for the tile.
-     */
-    preferences?: TilePreferences;
-}
+import { InitialTile, PiletDashboardApi, TilePreferences } from './types';
 /**
  * Available configuration options for the dashboard plugin.
  */
 export interface DashboardConfig {
+    /**
+     * Sets the routes where a dashboard should be displayed.
+     * @default ['/']
+     */
+    routes?: Array<string>;
     /**
      * Sets the tiles to be given by the app shell.
      * @default []

package/esm/create.js

@@ -1,33 +1,15 @@
 import * as actions from './actions';
 import { buildName, withApi, withRootExtension, withAll } from 'piral-core';
-import { DefaultTile, DefaultContainer } from './default';
 import { Dashboard } from './Dashboard';
-function getPreferences(defaultPreferences, customPreferences = {}) {
-    return Object.assign(Object.assign({}, defaultPreferences), customPreferences);
-}
-function getTiles(items, defaultPreferences) {
-    const tiles = {};
-    let i = 0;
-    for (const { component, preferences } of items) {
-        tiles[`global-${i++}`] = {
-            pilet: undefined,
-            component,
-            preferences: getPreferences(defaultPreferences, preferences),
-        };
-    }
-    return tiles;
-}
-function withTiles(tiles) {
-    return (state) => (Object.assign(Object.assign({}, state), { components: Object.assign({ DashboardTile: DefaultTile, DashboardContainer: DefaultContainer }, state.components), registry: Object.assign(Object.assign({}, state.registry), { tiles }) }));
-}
+import { getPreferences, getTiles, withRoutes, withTiles } from './helpers';
 /**
  * Creates the Pilet API extension for activating dashboard support.
  */
 export function createDashboardApi(config = {}) {
-    const { tiles = [], defaultPreferences = {} } = config;
+    const { tiles = [], defaultPreferences = {}, routes = ['/'] } = config;
     return (context) => {
         context.defineActions(actions);
-        context.dispatch(withAll(withTiles(getTiles(tiles, defaultPreferences)), withRootExtension('piral-dashboard', Dashboard)));
+        context.dispatch(withAll(withTiles(getTiles(tiles, defaultPreferences)), withRootExtension('piral-dashboard', Dashboard), withRoutes(routes)));
         return (api, target) => {
             const pilet = target.name;
             let next = 0;

package/esm/create.js.map

@@ -1 +1 @@
-{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAqB,iBAAiB,EAAE,OAAO,EAAe,MAAM,YAAY,CAAC;AAC5G,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AA8BxC,SAAS,cAAc,CAAC,kBAAmC,EAAE,oBAAqC,EAAE;IAClG,uCACK,kBAAkB,GAClB,iBAAiB,EACpB;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAyB,EAAE,kBAAmC;IAC9E,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,KAAK,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,EAAE;QAC9C,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG;YACvB,KAAK,EAAE,SAAS;YAChB,SAAS;YACT,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;SAC7D,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,KAA6B;IAC9C,OAAO,CAAC,KAAkB,EAAe,EAAE,CAAC,iCACvC,KAAK,KACR,UAAU,kBACR,aAAa,EAAE,WAAW,EAC1B,kBAAkB,EAAE,gBAAgB,IACjC,KAAK,CAAC,UAAU,GAErB,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,KAAK,OAEP,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAA0B,EAAE;IAC7D,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,kBAAkB,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAEvD,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE/B,OAAO,CAAC,QAAQ,CACd,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,CACzG,CAAC;QAEF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YAEb,OAAO;gBACL,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,WAAY;oBAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;wBAC5B,WAAW,GAAG,GAAG,CAAC;wBAClB,GAAG,GAAG,IAAI,CAAC;wBACX,IAAI,GAAG,IAAI,EAAE,CAAC;qBACf;oBAED,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE;wBACvB,KAAK;wBACL,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC;wBAC7C,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;qBAC7D,CAAC,CAAC;oBACH,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC;gBACD,cAAc,CAAC,IAAI;oBACjB,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAC7B,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAe,iBAAiB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACzF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAuB5E;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAA0B,EAAE;IAC7D,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,kBAAkB,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC;IAEvE,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE/B,OAAO,CAAC,QAAQ,CACd,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAC9C,iBAAiB,CAAC,iBAAiB,EAAE,SAAS,CAAC,EAC/C,UAAU,CAAC,MAAM,CAAC,CACnB,CACF,CAAC;QAEF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YAEb,OAAO;gBACL,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,WAAY;oBAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;wBAC5B,WAAW,GAAG,GAAG,CAAC;wBAClB,GAAG,GAAG,IAAI,CAAC;wBACX,IAAI,GAAG,IAAI,EAAE,CAAC;qBACf;oBAED,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE;wBACvB,KAAK;wBACL,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC;wBAC7C,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;qBAC7D,CAAC,CAAC;oBACH,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC;gBACD,cAAc,CAAC,IAAI;oBACjB,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAC7B,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/esm/helpers.d.ts

@@ -0,0 +1,11 @@
+import { Dict, GlobalState } from 'piral-core';
+import { InitialTile, TilePreferences, TileRegistration } from './types';
+export declare function getPreferences(defaultPreferences: TilePreferences, customPreferences?: TilePreferences): {
+    initialColumns?: number;
+    initialRows?: number;
+    resizable?: boolean;
+    customProperties?: string[];
+};
+export declare function getTiles(items: Array<InitialTile>, defaultPreferences: TilePreferences): Dict<TileRegistration>;
+export declare function withTiles(tiles: Dict<TileRegistration>): (state: GlobalState) => GlobalState;
+export declare function withRoutes(routes: Array<string>): (state: GlobalState) => GlobalState;

package/esm/helpers.js

@@ -0,0 +1,27 @@
+import { DefaultTile, DefaultContainer } from './default';
+import { Dashboard } from './Dashboard';
+export function getPreferences(defaultPreferences, customPreferences = {}) {
+    return Object.assign(Object.assign({}, defaultPreferences), customPreferences);
+}
+export function getTiles(items, defaultPreferences) {
+    const tiles = {};
+    let i = 0;
+    for (const { component, preferences } of items) {
+        tiles[`global-${i++}`] = {
+            pilet: undefined,
+            component,
+            preferences: getPreferences(defaultPreferences, preferences),
+        };
+    }
+    return tiles;
+}
+export function withTiles(tiles) {
+    return (state) => (Object.assign(Object.assign({}, state), { components: Object.assign({ DashboardTile: DefaultTile, DashboardContainer: DefaultContainer }, state.components), registry: Object.assign(Object.assign({}, state.registry), { tiles }) }));
+}
+export function withRoutes(routes) {
+    return (state) => (Object.assign(Object.assign({}, state), { routes: Object.assign(Object.assign({}, state.routes), routes.reduce((newRoutes, route) => {
+            newRoutes[route] = Dashboard;
+            return newRoutes;
+        }, {})) }));
+}
+//# sourceMappingURL=helpers.js.map

package/esm/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,UAAU,cAAc,CAAC,kBAAmC,EAAE,oBAAqC,EAAE;IACzG,uCACK,kBAAkB,GAClB,iBAAiB,EACpB;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAyB,EAAE,kBAAmC;IACrF,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,KAAK,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,EAAE;QAC9C,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG;YACvB,KAAK,EAAE,SAAS;YAChB,SAAS;YACT,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;SAC7D,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAA6B;IACrD,OAAO,CAAC,KAAkB,EAAe,EAAE,CAAC,iCACvC,KAAK,KACR,UAAU,kBACR,aAAa,EAAE,WAAW,EAC1B,kBAAkB,EAAE,gBAAgB,IACjC,KAAK,CAAC,UAAU,GAErB,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,KAAK,OAEP,CAAC;AACL,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAqB;IAC9C,OAAO,CAAC,KAAkB,EAAe,EAAE,CAAC,iCACvC,KAAK,KACR,MAAM,kCACD,KAAK,CAAC,MAAM,GACZ,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;YACpC,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,KAER,CAAC;AACL,CAAC"}

package/esm/types.d.ts

@@ -39,6 +39,16 @@ declare module 'piral-core/lib/types/custom' {
         DashboardTile: ComponentType<DashboardTileProps>;
     }
 }
+export interface InitialTile {
+    /**
+     * Defines the component to be used for the tile.
+     */
+    component: ComponentType<BareTileComponentProps>;
+    /**
+     * Optionally sets the preferences for the tile.
+     */
+    preferences?: TilePreferences;
+}
 export interface DashboardContainerProps extends RouteComponentProps {
 }
 export interface DashboardTileProps {

package/lib/create.d.ts

@@ -1,20 +1,14 @@
-import { ComponentType } from 'react';
 import { PiralPlugin } from 'piral-core';
-import { PiletDashboardApi, TilePreferences, BareTileComponentProps } from './types';
-export interface InitialTile {
-    /**
-     * Defines the component to be used for the tile.
-     */
-    component: ComponentType<BareTileComponentProps>;
-    /**
-     * Optionally sets the preferences for the tile.
-     */
-    preferences?: TilePreferences;
-}
+import { InitialTile, PiletDashboardApi, TilePreferences } from './types';
 /**
  * Available configuration options for the dashboard plugin.
  */
 export interface DashboardConfig {
+    /**
+     * Sets the routes where a dashboard should be displayed.
+     * @default ['/']
+     */
+    routes?: Array<string>;
     /**
      * Sets the tiles to be given by the app shell.
      * @default []

package/lib/create.js

@@ -3,34 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDashboardApi = void 0;
 const actions = require("./actions");
 const piral_core_1 = require("piral-core");
-const default_1 = require("./default");
 const Dashboard_1 = require("./Dashboard");
-function getPreferences(defaultPreferences, customPreferences = {}) {
-    return Object.assign(Object.assign({}, defaultPreferences), customPreferences);
-}
-function getTiles(items, defaultPreferences) {
-    const tiles = {};
-    let i = 0;
-    for (const { component, preferences } of items) {
-        tiles[`global-${i++}`] = {
-            pilet: undefined,
-            component,
-            preferences: getPreferences(defaultPreferences, preferences),
-        };
-    }
-    return tiles;
-}
-function withTiles(tiles) {
-    return (state) => (Object.assign(Object.assign({}, state), { components: Object.assign({ DashboardTile: default_1.DefaultTile, DashboardContainer: default_1.DefaultContainer }, state.components), registry: Object.assign(Object.assign({}, state.registry), { tiles }) }));
-}
+const helpers_1 = require("./helpers");
 /**
  * Creates the Pilet API extension for activating dashboard support.
  */
 function createDashboardApi(config = {}) {
-    const { tiles = [], defaultPreferences = {} } = config;
+    const { tiles = [], defaultPreferences = {}, routes = ['/'] } = config;
     return (context) => {
         context.defineActions(actions);
-        context.dispatch((0, piral_core_1.withAll)(withTiles(getTiles(tiles, defaultPreferences)), (0, piral_core_1.withRootExtension)('piral-dashboard', Dashboard_1.Dashboard)));
+        context.dispatch((0, piral_core_1.withAll)((0, helpers_1.withTiles)((0, helpers_1.getTiles)(tiles, defaultPreferences)), (0, piral_core_1.withRootExtension)('piral-dashboard', Dashboard_1.Dashboard), (0, helpers_1.withRoutes)(routes)));
         return (api, target) => {
             const pilet = target.name;
             let next = 0;
@@ -45,7 +27,7 @@ function createDashboardApi(config = {}) {
                     context.registerTile(id, {
                         pilet,
                         component: (0, piral_core_1.withApi)(context, arg, api, 'tile'),
-                        preferences: getPreferences(defaultPreferences, preferences),
+                        preferences: (0, helpers_1.getPreferences)(defaultPreferences, preferences),
                     });
                     return () => api.unregisterTile(name);
                 },

package/lib/create.js.map

@@ -1 +1 @@
-{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AAErC,2CAA4G;AAC5G,uCAA0D;AAC1D,2CAAwC;AA8BxC,SAAS,cAAc,CAAC,kBAAmC,EAAE,oBAAqC,EAAE;IAClG,uCACK,kBAAkB,GAClB,iBAAiB,EACpB;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAyB,EAAE,kBAAmC;IAC9E,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,KAAK,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,EAAE;QAC9C,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG;YACvB,KAAK,EAAE,SAAS;YAChB,SAAS;YACT,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;SAC7D,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,SAAS,CAAC,KAA6B;IAC9C,OAAO,CAAC,KAAkB,EAAe,EAAE,CAAC,iCACvC,KAAK,KACR,UAAU,kBACR,aAAa,EAAE,qBAAW,EAC1B,kBAAkB,EAAE,0BAAgB,IACjC,KAAK,CAAC,UAAU,GAErB,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,KAAK,OAEP,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,SAA0B,EAAE;IAC7D,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,kBAAkB,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAEvD,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE/B,OAAO,CAAC,QAAQ,CACd,IAAA,oBAAO,EAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,IAAA,8BAAiB,EAAC,iBAAiB,EAAE,qBAAS,CAAC,CAAC,CACzG,CAAC;QAEF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YAEb,OAAO;gBACL,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,WAAY;oBAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;wBAC5B,WAAW,GAAG,GAAG,CAAC;wBAClB,GAAG,GAAG,IAAI,CAAC;wBACX,IAAI,GAAG,IAAI,EAAE,CAAC;qBACf;oBAED,MAAM,EAAE,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE;wBACvB,KAAK;wBACL,SAAS,EAAE,IAAA,oBAAO,EAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC;wBAC7C,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;qBAC7D,CAAC,CAAC;oBACH,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC;gBACD,cAAc,CAAC,IAAI;oBACjB,MAAM,EAAE,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAC7B,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AArCD,gDAqCC"}
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,2CAAyF;AACzF,2CAAwC;AAExC,uCAA4E;AAuB5E;;GAEG;AACH,SAAgB,kBAAkB,CAAC,SAA0B,EAAE;IAC7D,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,kBAAkB,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC;IAEvE,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE/B,OAAO,CAAC,QAAQ,CACd,IAAA,oBAAO,EACL,IAAA,mBAAS,EAAC,IAAA,kBAAQ,EAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAC9C,IAAA,8BAAiB,EAAC,iBAAiB,EAAE,qBAAS,CAAC,EAC/C,IAAA,oBAAU,EAAC,MAAM,CAAC,CACnB,CACF,CAAC;QAEF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YAEb,OAAO;gBACL,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,WAAY;oBAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;wBAC5B,WAAW,GAAG,GAAG,CAAC;wBAClB,GAAG,GAAG,IAAI,CAAC;wBACX,IAAI,GAAG,IAAI,EAAE,CAAC;qBACf;oBAED,MAAM,EAAE,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE;wBACvB,KAAK;wBACL,SAAS,EAAE,IAAA,oBAAO,EAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC;wBAC7C,WAAW,EAAE,IAAA,wBAAc,EAAC,kBAAkB,EAAE,WAAW,CAAC;qBAC7D,CAAC,CAAC;oBACH,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC;gBACD,cAAc,CAAC,IAAI;oBACjB,MAAM,EAAE,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAC7B,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAzCD,gDAyCC"}

package/lib/helpers.d.ts

@@ -0,0 +1,11 @@
+import { Dict, GlobalState } from 'piral-core';
+import { InitialTile, TilePreferences, TileRegistration } from './types';
+export declare function getPreferences(defaultPreferences: TilePreferences, customPreferences?: TilePreferences): {
+    initialColumns?: number;
+    initialRows?: number;
+    resizable?: boolean;
+    customProperties?: string[];
+};
+export declare function getTiles(items: Array<InitialTile>, defaultPreferences: TilePreferences): Dict<TileRegistration>;
+export declare function withTiles(tiles: Dict<TileRegistration>): (state: GlobalState) => GlobalState;
+export declare function withRoutes(routes: Array<string>): (state: GlobalState) => GlobalState;

package/lib/helpers.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withRoutes = exports.withTiles = exports.getTiles = exports.getPreferences = void 0;
+const default_1 = require("./default");
+const Dashboard_1 = require("./Dashboard");
+function getPreferences(defaultPreferences, customPreferences = {}) {
+    return Object.assign(Object.assign({}, defaultPreferences), customPreferences);
+}
+exports.getPreferences = getPreferences;
+function getTiles(items, defaultPreferences) {
+    const tiles = {};
+    let i = 0;
+    for (const { component, preferences } of items) {
+        tiles[`global-${i++}`] = {
+            pilet: undefined,
+            component,
+            preferences: getPreferences(defaultPreferences, preferences),
+        };
+    }
+    return tiles;
+}
+exports.getTiles = getTiles;
+function withTiles(tiles) {
+    return (state) => (Object.assign(Object.assign({}, state), { components: Object.assign({ DashboardTile: default_1.DefaultTile, DashboardContainer: default_1.DefaultContainer }, state.components), registry: Object.assign(Object.assign({}, state.registry), { tiles }) }));
+}
+exports.withTiles = withTiles;
+function withRoutes(routes) {
+    return (state) => (Object.assign(Object.assign({}, state), { routes: Object.assign(Object.assign({}, state.routes), routes.reduce((newRoutes, route) => {
+            newRoutes[route] = Dashboard_1.Dashboard;
+            return newRoutes;
+        }, {})) }));
+}
+exports.withRoutes = withRoutes;
+//# sourceMappingURL=helpers.js.map

package/lib/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AACA,uCAA0D;AAC1D,2CAAwC;AAGxC,SAAgB,cAAc,CAAC,kBAAmC,EAAE,oBAAqC,EAAE;IACzG,uCACK,kBAAkB,GAClB,iBAAiB,EACpB;AACJ,CAAC;AALD,wCAKC;AAED,SAAgB,QAAQ,CAAC,KAAyB,EAAE,kBAAmC;IACrF,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,KAAK,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,EAAE;QAC9C,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG;YACvB,KAAK,EAAE,SAAS;YAChB,SAAS;YACT,WAAW,EAAE,cAAc,CAAC,kBAAkB,EAAE,WAAW,CAAC;SAC7D,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAbD,4BAaC;AAED,SAAgB,SAAS,CAAC,KAA6B;IACrD,OAAO,CAAC,KAAkB,EAAe,EAAE,CAAC,iCACvC,KAAK,KACR,UAAU,kBACR,aAAa,EAAE,qBAAW,EAC1B,kBAAkB,EAAE,0BAAgB,IACjC,KAAK,CAAC,UAAU,GAErB,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,KAAK,OAEP,CAAC;AACL,CAAC;AAbD,8BAaC;AAED,SAAgB,UAAU,CAAC,MAAqB;IAC9C,OAAO,CAAC,KAAkB,EAAe,EAAE,CAAC,iCACvC,KAAK,KACR,MAAM,kCACD,KAAK,CAAC,MAAM,GACZ,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;YACpC,SAAS,CAAC,KAAK,CAAC,GAAG,qBAAS,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,KAER,CAAC;AACL,CAAC;AAXD,gCAWC"}

package/lib/types.d.ts

@@ -39,6 +39,16 @@ declare module 'piral-core/lib/types/custom' {
         DashboardTile: ComponentType<DashboardTileProps>;
     }
 }
+export interface InitialTile {
+    /**
+     * Defines the component to be used for the tile.
+     */
+    component: ComponentType<BareTileComponentProps>;
+    /**
+     * Optionally sets the preferences for the tile.
+     */
+    preferences?: TilePreferences;
+}
 export interface DashboardContainerProps extends RouteComponentProps {
 }
 export interface DashboardTileProps {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-dashboard",
-  "version": "0.14.9",
+  "version": "0.15.0-alpha.3549",
   "description": "Plugin for creating a centralized dashboard in Piral.",
   "keywords": [
     "piral",
@@ -41,10 +41,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "piral-core": "^0.14.9"
+    "piral-core": "0.15.0-alpha.3549"
   },
   "peerDependencies": {
     "piral-core": "0.14.x"
   },
-  "gitHead": "8c378ca7c8a55c1b1e23e7992c3875aaf311f29d"
+  "gitHead": "2edf7bbcee6a7e931348198d14139c7f958877e7"
 }

package/src/create.ts

@@ -1,25 +1,18 @@
 import * as actions from './actions';
-import { ComponentType } from 'react';
-import { buildName, withApi, PiralPlugin, Dict, withRootExtension, withAll, GlobalState } from 'piral-core';
-import { DefaultTile, DefaultContainer } from './default';
+import { buildName, withApi, PiralPlugin, withRootExtension, withAll } from 'piral-core';
 import { Dashboard } from './Dashboard';
-import { PiletDashboardApi, TilePreferences, BareTileComponentProps, TileRegistration } from './types';
-
-export interface InitialTile {
-  /**
-   * Defines the component to be used for the tile.
-   */
-  component: ComponentType<BareTileComponentProps>;
-  /**
-   * Optionally sets the preferences for the tile.
-   */
-  preferences?: TilePreferences;
-}
+import { InitialTile, PiletDashboardApi, TilePreferences } from './types';
+import { getPreferences, getTiles, withRoutes, withTiles } from './helpers';
 
 /**
  * Available configuration options for the dashboard plugin.
  */
 export interface DashboardConfig {
+  /**
+   * Sets the routes where a dashboard should be displayed.
+   * @default ['/']
+   */
+  routes?: Array<string>;
   /**
    * Sets the tiles to be given by the app shell.
    * @default []
@@ -32,54 +25,21 @@ export interface DashboardConfig {
   defaultPreferences?: TilePreferences;
 }
 
-function getPreferences(defaultPreferences: TilePreferences, customPreferences: TilePreferences = {}) {
-  return {
-    ...defaultPreferences,
-    ...customPreferences,
-  };
-}
-
-function getTiles(items: Array<InitialTile>, defaultPreferences: TilePreferences) {
-  const tiles: Dict<TileRegistration> = {};
-  let i = 0;
-
-  for (const { component, preferences } of items) {
-    tiles[`global-${i++}`] = {
-      pilet: undefined,
-      component,
-      preferences: getPreferences(defaultPreferences, preferences),
-    };
-  }
-
-  return tiles;
-}
-
-function withTiles(tiles: Dict<TileRegistration>) {
-  return (state: GlobalState): GlobalState => ({
-    ...state,
-    components: {
-      DashboardTile: DefaultTile,
-      DashboardContainer: DefaultContainer,
-      ...state.components,
-    },
-    registry: {
-      ...state.registry,
-      tiles,
-    },
-  });
-}
-
 /**
  * Creates the Pilet API extension for activating dashboard support.
  */
 export function createDashboardApi(config: DashboardConfig = {}): PiralPlugin<PiletDashboardApi> {
-  const { tiles = [], defaultPreferences = {} } = config;
+  const { tiles = [], defaultPreferences = {}, routes = ['/'] } = config;
 
   return (context) => {
     context.defineActions(actions);
 
     context.dispatch(
-      withAll(withTiles(getTiles(tiles, defaultPreferences)), withRootExtension('piral-dashboard', Dashboard)),
+      withAll(
+        withTiles(getTiles(tiles, defaultPreferences)),
+        withRootExtension('piral-dashboard', Dashboard),
+        withRoutes(routes),
+      ),
     );
 
     return (api, target) => {

package/src/helpers.ts

@@ -0,0 +1,54 @@
+import { Dict, GlobalState } from 'piral-core';
+import { DefaultTile, DefaultContainer } from './default';
+import { Dashboard } from './Dashboard';
+import { InitialTile, TilePreferences, TileRegistration } from './types';
+
+export function getPreferences(defaultPreferences: TilePreferences, customPreferences: TilePreferences = {}) {
+  return {
+    ...defaultPreferences,
+    ...customPreferences,
+  };
+}
+
+export function getTiles(items: Array<InitialTile>, defaultPreferences: TilePreferences) {
+  const tiles: Dict<TileRegistration> = {};
+  let i = 0;
+
+  for (const { component, preferences } of items) {
+    tiles[`global-${i++}`] = {
+      pilet: undefined,
+      component,
+      preferences: getPreferences(defaultPreferences, preferences),
+    };
+  }
+
+  return tiles;
+}
+
+export function withTiles(tiles: Dict<TileRegistration>) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    components: {
+      DashboardTile: DefaultTile,
+      DashboardContainer: DefaultContainer,
+      ...state.components,
+    },
+    registry: {
+      ...state.registry,
+      tiles,
+    },
+  });
+}
+
+export function withRoutes(routes: Array<string>) {
+  return (state: GlobalState): GlobalState => ({
+    ...state,
+    routes: {
+      ...state.routes,
+      ...routes.reduce((newRoutes, route) => {
+        newRoutes[route] = Dashboard;
+        return newRoutes;
+      }, {}),
+    },
+  });
+}

package/src/types.ts

@@ -51,6 +51,17 @@ declare module 'piral-core/lib/types/custom' {
   }
 }
 
+export interface InitialTile {
+  /**
+   * Defines the component to be used for the tile.
+   */
+  component: ComponentType<BareTileComponentProps>;
+  /**
+   * Optionally sets the preferences for the tile.
+   */
+  preferences?: TilePreferences;
+}
+
 export interface DashboardContainerProps extends RouteComponentProps {}
 
 export interface DashboardTileProps {