@sisense/sdk-ui 1.10.1 → 1.12.0

package/dist/charts/table/types.d.ts

@@ -1,5 +1,5 @@
 import { Column, DataTable } from '../../chart-data-processor/table-processor';
-import { TableDesignOptions } from '../../chart-options-processor/translations/design-options';
+import { TableColorOptions, TableDesignOptions } from '../../chart-options-processor/translations/design-options';
 import { CompleteThemeSettings } from '../../types';
 import { TableDataOptionsInternal } from '../../chart-data-options/types';
 /**
@@ -56,9 +56,18 @@ export type TableCustomStyles = {
     sortIcon?: 'caret' | 'standard';
     headerHeight?: number;
     rowHeight?: number;
-    headersColor?: boolean;
-    alternatingRowsColor?: boolean;
-    alternatingColumnsColor?: boolean;
+    paddingVertical?: number;
+    paddingHorizontal?: number;
+    header?: {
+        color?: TableColorOptions;
+    };
+    columns?: {
+        alternatingColor?: TableColorOptions;
+        width?: 'auto' | 'content';
+    };
+    rows?: {
+        alternatingColor?: TableColorOptions;
+    };
 };
 export type TableReducerState = {
     sortedDataTable: DataTable;

package/dist/common/components/loading-indicator.d.ts

@@ -89,27 +89,40 @@ export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
                 borderGradient: [string, string] | null;
                 borderRadius: string;
                 hover: {
-                    backgroundColor: string;
                     textColor: string;
+                    backgroundColor: string;
                 };
                 loadingGradient: [string, string];
                 gap: string;
             };
             clickableMessages: {
-                backgroundColor: string;
                 textColor: string;
+                backgroundColor: string;
                 border: string | false;
+                borderGradient: [string, string] | null;
                 hover: {
                     textColor: string;
                     backgroundColor: string;
                 };
             };
+            dataTopics: {
+                backgroundColor: string;
+                items: {
+                    textColor: string;
+                    backgroundColor: string;
+                };
+            };
             icons: {
                 color: string;
-                hover: {
-                    color: string;
+                feedbackIcons: {
+                    hoverColor: string;
                 };
             };
+            tooltips: {
+                backgroundColor: string;
+                textColor: string;
+                boxShadow: string;
+            };
         };
     } | undefined;
     onCancel?: (() => void) | undefined;

package/dist/common/hooks/use-fetch.d.ts

@@ -15,8 +15,8 @@ export type RequestConfig = {
 /**
  * The result of the `useFetch` hook.
  * Return value of the `useQuery` hook from `@tanstack/react-query`.
- * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
  *
+ * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
  * @template TData - The type of the data returned by the fetch request
  * @template TError - The type of the error returned by the fetch request
  */

package/dist/common/hooks/use-has-changed.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hook that returns if a value from the previous render has changed.
+ *
+ * @param value - Value for the current render.
+ * @param propNames - Names of keys to compare.
+ * @param [compare] - Optional comparison function
+ * @returns Has the value changed or not.
+ */
+export declare function useHasChanged<T>(value: T, propNames: Array<keyof T>, compare?: (value: T, prev: T) => boolean): boolean;

package/dist/common/hooks/use-should-load.d.ts

@@ -0,0 +1,12 @@
+import { ClientApplication } from '../../app/client-application.js';
+/**
+ * Hook that generates a function for testing whether or not load
+ *  should be performed for this render
+ *
+ * @param params - the component or hook params object
+ * @param isParamsChanged - have the params changed from previous invocation
+ * @returns generated render checking function
+ */
+export declare function useShouldLoad<T extends {
+    enabled?: boolean;
+}>({ enabled }: T, isParamsChanged: boolean): (app: ClientApplication | undefined, force?: boolean) => app is ClientApplication;

package/dist/dashboard/components/content-panel.d.ts

@@ -0,0 +1,41 @@
+import { Layout, WidgetModel } from '../../models';
+/**
+ * Props for the {@link ContentPanel} component.
+ *
+ * @internal
+ */
+export interface ContentPanelProps {
+    /**
+     * An object defining how the widgets should be laid out.
+     */
+    layout: Layout;
+    /**
+     * A list of widget models to render.
+     */
+    widgets: WidgetModel[];
+}
+/**
+ * A React component used for rendering a layout of widgets.
+ *
+ * @example
+ * Example of using the component with the useGetDashboardModel hook:
+ * ```tsx
+ * const { dashboard, isLoading, isError } = useGetDashboardModel({
+ *   dashboardOid: 'dashboard-oid',
+ *   includeWidgets: true,
+ * });
+ *
+ * const { layout, widgets } = dashboard;
+ * if (!layout || !widgets) return null;
+ *
+ * return (
+ *   <ContentPanel
+ *     layout={layout}
+ *     widgets={widgets}
+ *   />
+ * );
+ * ```
+ * @param props - {@link ContentPanelProps}
+ * @internal
+ */
+export declare const ContentPanel: ({ layout, widgets }: ContentPanelProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/dashboard-container.d.ts

@@ -0,0 +1,2 @@
+import { DashboardLayoutProps } from '../../dashboard/types';
+export declare const DashboardContainer: ({ title, layout, widgets, filters, onFiltersChange, }: DashboardLayoutProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/dashboard-header.d.ts

@@ -0,0 +1,2 @@
+import { DashboardHeaderProps } from '../../dashboard/types';
+export declare const DashboardHeader: ({ title }: DashboardHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/plugin-service.d.ts

@@ -0,0 +1,21 @@
+import { WidgetModel } from '../../models';
+import { CompleteThemeSettings } from '../../types';
+/**
+ * @internal
+ */
+export type ReactWidgetPlugin<P = {}> = {
+    name: string;
+    Plugin: any;
+    createChartProps(w: WidgetModel, themeSettings: CompleteThemeSettings): P;
+};
+/**
+ * POC - singleton plugin store. A widget from a Fusion dashboard can use this
+ * store to look up and render a chart from a third-party plugin that matches its type.
+ *
+ * @internal
+ */
+export declare class PluginService {
+    static pluginMap: Map<string, ReactWidgetPlugin<{}>>;
+    static get(pluginType: string): ReactWidgetPlugin | undefined;
+    static register(pluginType: string, plugin: ReactWidgetPlugin): void;
+}

package/dist/dashboard/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DASHBOARD_DIVIDER_COLOR = "#d5d5d5";
+export declare const DASHBOARD_DIVIDER_WIDTH = 1;

package/dist/dashboard/dashboard-by-id.d.ts

@@ -0,0 +1,7 @@
+import { DashboardByIdProps } from './types';
+/**
+ * React component that renders a dashboard created in Sisense Fusion Embed
+ *
+ * @internal
+ */
+export declare const DashboardById: ({ dashboardOid }: DashboardByIdProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/dashboard.d.ts

@@ -0,0 +1,8 @@
+import { DashboardProps } from '../dashboard/types';
+/**
+ * React component that renders a dashboard
+ * Include inside logic of applying common filters to widgets
+ *
+ * @internal
+ */
+export declare const Dashboard: ({ title, layout, widgets, filters }: DashboardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/types.d.ts

@@ -0,0 +1,41 @@
+import { Layout, WidgetModel } from '../models';
+import { Filter } from '@sisense/sdk-data';
+/**
+ * Props for the DashboardById component
+ *
+ * @internal
+ */
+export interface DashboardByIdProps {
+    dashboardOid: string;
+}
+/**
+ * Props for the DashboardLayout component
+ *
+ * @internal
+ */
+export interface DashboardLayoutProps {
+    title: string;
+    layout: Layout;
+    widgets: WidgetModel[];
+    filters: Filter[];
+    onFiltersChange: (filters: Filter[]) => void;
+}
+/**
+ * Props for the Dashboard component
+ *
+ * @internal
+ */
+export interface DashboardProps {
+    title: string;
+    layout: Layout;
+    widgets: WidgetModel[];
+    filters: Filter[];
+}
+/**
+ * Props for the Dashboard Header component
+ *
+ * @internal
+ */
+export interface DashboardHeaderProps {
+    title: string;
+}

package/dist/dashboard/utils.d.ts

@@ -0,0 +1,5 @@
+import { Filter } from '@sisense/sdk-data';
+import { WidgetModel } from '../models';
+export declare function isSupportedWidgetTypeByDashboard(widgetType: string): boolean;
+export declare function addFiltersToWidget(widget: WidgetModel, filters: Filter[]): WidgetModel;
+export declare const getDividerStyle: (color: string, width: number) => string;