piral-dashboard 1.0.0-pre.2217 → 1.0.0

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

@@ -1,6 +1,6 @@
-import { ComponentType } from 'react';
-import { RouteComponentProps } from 'react-router-dom';
-import {
+import type { ComponentType, ReactNode } from 'react';
+import type { RouteComponentProps } from 'react-router-dom';
+import type {
   Dict,
   WrappedComponent,
   BaseComponentProps,
@@ -51,7 +51,23 @@ declare module 'piral-core/lib/types/custom' {
   }
 }
 
-export interface DashboardContainerProps extends RouteComponentProps {}
+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 {
+  /**
+   * The tiles to display.
+   */
+  children?: ReactNode;
+}
 
 export interface DashboardTileProps {
   /**
@@ -70,6 +86,10 @@ export interface DashboardTileProps {
    * The provided tile preferences.
    */
   meta: TilePreferences;
+  /**
+   * The content of the tile to display.
+   */
+  children?: ReactNode;
 }
 
 export interface TileErrorInfoProps {
@@ -89,6 +109,10 @@ export interface TileErrorInfoProps {
    * The currently used number of rows.
    */
   rows: number;
+  /**
+   * The name of the pilet emitting the error.
+   */
+  pilet?: string;
 }
 
 export interface BareTileComponentProps {