@sisense/sdk-ui 0.11.3 → 0.12.1

package/dist/api/rest-api.d.ts

@@ -0,0 +1,30 @@
+import { HttpClient } from '@sisense/sdk-rest-client';
+import { WidgetDto } from '../dashboard-widget/types';
+import type { DashboardDto } from './types/dashboard-dto';
+type GetDashboardsOptions = {
+    searchByTitle?: string;
+    fields?: string[];
+    expand?: string[];
+};
+type GetDashboardOptions = {
+    fields?: string[];
+    expand?: string[];
+};
+export declare class RestApi {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Get all dashboards
+     */
+    getDashboards: (options?: GetDashboardsOptions) => Promise<DashboardDto[]>;
+    /**
+     * Get a specific dashboard
+     */
+    getDashboard: (dashboardOid: string, options?: GetDashboardOptions) => Promise<DashboardDto>;
+    /**
+     * Get a specific widget from a dashboard
+     */
+    getWidget: (widgetOid: string, dashboardOid: string) => Promise<WidgetDto>;
+}
+export declare const useGetApi: () => RestApi;
+export {};

package/dist/api/types/dashboard-dto.d.ts

@@ -0,0 +1,13 @@
+import { WidgetDto, Datasource, FilterJaql } from '../../dashboard-widget/types';
+type Filter = {
+    jaql: FilterJaql;
+    isCascading: boolean;
+};
+export type DashboardDto = {
+    oid: string;
+    title: string;
+    datasource: Datasource;
+    widgets?: WidgetDto[];
+    filters?: Filter[];
+};
+export {};

package/dist/app/client-application.d.ts

@@ -12,6 +12,12 @@ export type AppConfig = {
      * A [date-fns Locale](https://date-fns.org/v2.30.0/docs/Locale)
      */
     locale?: Locale;
+    /**
+     * Language code to be used for translations
+     *
+     * @internal
+     */
+    language?: string;
     /**
      * Date Configurations
      */

package/dist/app/settings/settings.d.ts

@@ -10,6 +10,7 @@ export type AppSettings = Required<ConfigurableAppSettings> & ServerSettings;
 type ConfigurableAppSettings = AppConfig;
 type ServerSettings = {
     serverThemeSettings: ThemeSettings;
+    serverLanguage: string;
 };
 /**
  * Gets the application settings

package/dist/chart-data-options/validate-data-options/index.d.ts

@@ -0,0 +1 @@
+export * from './validate-data-options';

package/dist/chart-data-options/validate-data-options/validate-categorical-data-options.d.ts

@@ -0,0 +1,3 @@
+import { CategoricalChartType } from '../../types';
+import { CategoricalChartDataOptions } from '../types';
+export declare function validateCategoricalChartDataOptions(chartType: CategoricalChartType, dataOptions: CategoricalChartDataOptions): CategoricalChartDataOptions;

package/dist/chart-data-options/{validate-data-options.d.ts → validate-data-options/validate-data-options.d.ts}

@@ -1,7 +1,7 @@
-import { ChartDataOptions, ChartDataOptionsInternal, Value } from './types';
-import { ChartType } from '../types';
+import { ChartDataOptions, ChartDataOptionsInternal, Value } from '../types';
+import { ChartType } from '../../types';
 import { Attribute, Data, Filter, Measure } from '@sisense/sdk-data';
-import { DataTable } from '../chart-data-processor/table-processor';
+import { DataTable } from '../../chart-data-processor/table-processor';
 export type DataColumnNamesMapping = Record<string, string>;
 /**
  * Generates and applies unique data column names and creates a mapping of new names to original names.
@@ -18,4 +18,4 @@ export declare const applyDefaultChartDataOptions: (chartDataOptions: ChartDataO
  * Validates attributes, measures, filters, and highlights against the columns in data.
  */
 export declare const validateDataOptionsAgainstData: (data: Data | DataTable, attributes: Attribute[], measures: Measure[], dataColumnNamesMapping: DataColumnNamesMapping, filters?: Filter[], highlights?: Filter[]) => boolean;
-export declare function validateDataOptions(chartType: ChartType, dataOptions: ChartDataOptions): void;
+export declare function validateDataOptions(chartType: ChartType, dataOptions: ChartDataOptions): ChartDataOptions;

package/dist/chart-options-processor/chart-options-service.d.ts

@@ -218,7 +218,7 @@ declare const DEFAULT_STYLE_OPTIONS: {
         };
     };
     readonly y2Axis: {
-        readonly enabled: false;
+        readonly enabled: true;
         readonly gridLines: true;
         readonly isIntervalEnabled: false;
         readonly labels: {

package/dist/common/hooks/data-load-state-reducer.d.ts

@@ -0,0 +1,65 @@
+/**
+ * States of a data load.
+ */
+export type DataState<Data> = DataLoadingState<Data> | DataErrorState | DataSuccessState<Data>;
+/**
+ * State of data loading.
+ */
+export type DataLoadingState<Data> = {
+    /** Whether the data is loading */
+    isLoading: true;
+    /** Whether the data load has failed */
+    isError: false;
+    /** Whether the data load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result data if the load has succeeded */
+    data: Data | undefined;
+    /** The status of the data load */
+    status: 'loading';
+};
+/**
+ * State of a data load that has failed.
+ */
+export type DataErrorState = {
+    /** Whether the data is loading */
+    isLoading: false;
+    /** Whether the data load has failed */
+    isError: true;
+    /** Whether the data load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** The result data if the load has succeeded */
+    data: undefined;
+    /** The status of the data load */
+    status: 'error';
+};
+/**
+ * State of a data load that has succeeded.
+ */
+export type DataSuccessState<Data> = {
+    /** Whether the data is loading */
+    isLoading: false;
+    /** Whether the data load has failed */
+    isError: false;
+    /** Whether the data load has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result data if the load has succeeded */
+    data: Data;
+    /** The status of the data load */
+    status: 'success';
+};
+export type DataLoadAction<Data> = {
+    type: 'loading';
+} | {
+    type: 'success';
+    data: Data;
+} | {
+    type: 'error';
+    error: Error;
+};
+export declare function dataLoadStateReducer<Data>(state: DataState<Data>, action: DataLoadAction<Data>): DataState<Data>;

package/dist/common/hooks/types.d.ts

@@ -0,0 +1,8 @@
+export interface HookEnableParam {
+    /**
+     * Boolean flag to control if the hook is executed
+     *
+     * If not specified, the default value is `true`
+     */
+    enabled?: boolean;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Hook that returns the value from the previous render.
+ *
+ * @param value - Value to return from the previous render.
+ * @returns Value from the previous render.
+ */
+export declare function usePrevious<T>(value: T): T | undefined;

package/dist/dashboard-widget/types.d.ts

@@ -13,6 +13,12 @@ export declare const enum WidgetType {
     TableWithAggregation = "tablewidgetagg"
 }
 export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap';
+export type Datasource = {
+    title: string;
+    id: string;
+    fullname?: string;
+    live: boolean;
+};
 /**
  * The data transfer object (DTO) containing info of a widget on a dashboard.
  *
@@ -23,12 +29,7 @@ export interface WidgetDto {
     oid: string;
     type: WidgetType | string;
     subtype: WidgetSubtype | string;
-    datasource: {
-        title: string;
-        id: string;
-        fullname: string;
-        live: boolean;
-    };
+    datasource: Datasource;
     metadata: {
         panels: Panel[];
     };

package/dist/dashboard-widget/utils.d.ts

@@ -25,7 +25,6 @@ export declare function mergeFilters(sourceFilters?: Filter[], targetFilters?: F
  * @param {Filter[]} widgetFilters - The filters from the widget.
  * @param {Filter[]} codeFilters - The filters from the code.
  * @param {FiltersMergeStrategy} [mergeStrategy] - The strategy to use for merging filters.
- *
  * @returns {Filter[]} The merged filters based on the selected strategy.
  */
 export declare function mergeFiltersByStrategy(widgetFilters?: Filter[], codeFilters?: Filter[], mergeStrategy?: FiltersMergeStrategy): Filter[];

package/dist/decorators/as-sisense-component.d.ts

@@ -9,6 +9,8 @@ export type SisenseComponentConfig = {
     shouldSkipSisenseContextWaiting?: boolean | ((props: any) => boolean);
     /** If set to true (or function returns true), the component will not be tracked */
     shouldSkipTracking?: boolean | ((props: any) => boolean);
+    /** If set, the error message for wrong SisenseContext will be overridden with the provided key */
+    customContextErrorMessageKey?: string;
 };
 export type ComponentDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <ComponentProps extends Record<string, any>>(Component: FunctionComponent<ComponentProps>) => FunctionComponent<ComponentProps>;
 /**

package/dist/decorators/with-default-translations.d.ts

@@ -0,0 +1,6 @@
+import { ComponentDecorator } from './as-sisense-component';
+/**
+ * Adds default translations provider to the component
+ * if it is not wrapped in Sisense context
+ */
+export declare const withDefaultTranslations: ComponentDecorator<void>;

package/dist/decorators/with-sisense-context-validation.d.ts

@@ -1,5 +1,5 @@
 import { ComponentDecorator, SisenseComponentConfig } from './as-sisense-component';
-type SisenseContextValidationConfig = Pick<SisenseComponentConfig, 'shouldSkipSisenseContextWaiting'>;
+type SisenseContextValidationConfig = Pick<SisenseComponentConfig, 'shouldSkipSisenseContextWaiting' | 'customContextErrorMessageKey'>;
 /**
  * Adds waiting for the Sisense context to be initialized
  */

package/dist/decorators/with-tracking/error-tracker.d.ts

@@ -11,10 +11,12 @@ export declare class ErrorTracker extends Component<ErrorTrackerProps, {
     componentName: string;
     context: SisenseContextPayload;
     httpClient?: HttpClient;
+    postponedErrors: Error[];
     constructor(props: ErrorTrackerProps);
     static contextType: import("react").Context<SisenseContextPayload>;
     componentDidMount(): void;
     componentDidCatch(error: Error): void;
+    private sendErrorTracking;
     render(): ReactNode;
 }
 export {};

package/dist/error-boundary/error-boundary-box.d.ts

@@ -1,13 +1,14 @@
 /// <reference types="react" />
+import { AbstractTranslatableError } from '@sisense/sdk-common';
 /**
  * This component is used to display an error message when a component fails to render.
  * It is used by the ErrorBoundary component.
  *
  * @param props - component properties
- * @param props.errorText - The error message to display
+ * @param props.error - The error to translate and display
  * @returns A component which will replace the component when it fails to render
  */
-declare const ErrorBoundaryBox: ({ errorText }: {
-    errorText?: string | undefined;
+declare const ErrorBoundaryBox: ({ error, }: {
+    error: Error | AbstractTranslatableError | string;
 }) => JSX.Element;
 export default ErrorBoundaryBox;

package/dist/error-boundary/error-boundary.d.ts

@@ -1,16 +1,17 @@
 import { Component, ReactNode } from 'react';
 import { SisenseContextPayload } from '../sisense-context/sisense-context';
+import { AbstractTranslatableError } from '@sisense/sdk-common';
 /**
  * @internal
  */
 interface ErrorBoundaryProps {
     showErrorBox?: boolean;
-    error?: Error | string;
+    error?: AbstractTranslatableError | Error | string;
     children: ReactNode;
     resetKeys?: any[];
 }
 type ErrorBoundaryState = {
-    error: Error | string | null;
+    error: AbstractTranslatableError | Error | string | null;
 };
 /**
  * This component is used to catch errors thrown by the UI component and display an error message

package/dist/index.d.ts

@@ -30,6 +30,7 @@ export * from './sisense-context/custom-sisense-context-provider';
 export * from './theme-provider/custom-theme-provider';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './chart-options-processor/theme-option-service';
+export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, } from './models';
 export * from './props';
 export * from './types';
 export * from './filters';