@sisense/sdk-ui 0.11.3 → 0.12.0

package/dist/models/dashboard/get-dashboard-model.d.ts

@@ -0,0 +1,11 @@
+import { HttpClient } from '@sisense/sdk-rest-client';
+export interface GetDashboardModelOptions {
+    /**
+     * Boolean flag whether to include widgets in the dashboard model
+     *
+     * If not specified, the default value is `false`
+     */
+    includeWidgets?: boolean;
+}
+/** @internal */
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions): Promise<import("./types").DashboardModel>;

package/dist/models/dashboard/get-dashboard-models.d.ts

@@ -0,0 +1,17 @@
+import { HttpClient } from '@sisense/sdk-rest-client';
+export interface GetDashboardModelsOptions {
+    /**
+     * Dashboard title to search by
+     *
+     * The dashboard title is not unique, therefore, the result may return multiple dashboards.
+     */
+    searchByTitle?: string;
+    /**
+     * Boolean flag whether to include widgets in the dashboard model
+     *
+     * If not specified, the default value is `false`
+     */
+    includeWidgets?: boolean;
+}
+/** @internal */
+export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions): Promise<import("./types.js").DashboardModel[]>;

package/dist/models/dashboard/index.d.ts

@@ -0,0 +1,6 @@
+export * from './types';
+export * from './get-dashboard-model';
+export * from './get-dashboard-models';
+export * from './translate-dashboard';
+export * from './use-get-dashboard-model';
+export * from './use-get-dashboard-models';

package/dist/models/dashboard/translate-dashboard.d.ts

@@ -0,0 +1,3 @@
+import { type DashboardDto } from '../../api/types/dashboard-dto';
+import { type DashboardModel } from './types';
+export declare function translateDashboard({ oid, title, datasource, widgets, }: DashboardDto): DashboardModel;

package/dist/models/dashboard/types.d.ts

@@ -0,0 +1,8 @@
+import { type DataSource } from '@sisense/sdk-data';
+import { type WidgetModel } from '../widget/types';
+export type DashboardModel = {
+    oid: string;
+    title: string;
+    dataSource: DataSource;
+    widgets?: WidgetModel[];
+};

package/dist/models/dashboard/use-get-dashboard-model.d.ts

@@ -0,0 +1,99 @@
+import { type DashboardModel } from './types';
+import { GetDashboardModelOptions } from './get-dashboard-model';
+import { HookEnableParam } from '../../common/hooks/types';
+/**
+ * Parameters for {@link useGetDashboardModel} hook.
+ */
+export interface GetDashboardModelParams extends GetDashboardModelOptions, HookEnableParam {
+    /**
+     * Identifier of the dashboard that contains the widget
+     */
+    dashboardOid: string;
+}
+/**
+ * States of a dashboard model load.
+ */
+export type DashboardModelState = DashboardModelLoadingState | DashboardModelErrorState | DashboardModelSuccessState;
+/**
+ * State of a dashboard model loading.
+ */
+export type DashboardModelLoadingState = {
+    /** Whether the dashboard model is loading */
+    isLoading: true;
+    /** Whether the dashboard model load has failed */
+    isError: false;
+    /** Whether the dashboard model load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result dashboard model if the load has succeeded */
+    dashboard: DashboardModel | undefined;
+    /** The status of the dashboard model load */
+    status: 'loading';
+};
+/**
+ * State of a dashboard model load that has failed.
+ */
+export type DashboardModelErrorState = {
+    /** Whether the dashboard model is loading */
+    isLoading: false;
+    /** Whether the dashboard model load has failed */
+    isError: true;
+    /** Whether the dashboard model load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** The result dashboard model if the load has succeeded */
+    dashboard: undefined;
+    /** The status of the dashboard model load */
+    status: 'error';
+};
+/**
+ * State of a dashboard model load that has succeeded.
+ */
+export type DashboardModelSuccessState = {
+    /** Whether the dashboard model is loading */
+    isLoading: false;
+    /** Whether the dashboard model load has failed */
+    isError: false;
+    /** Whether the dashboard model load has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result dashboard model if the load has succeeded */
+    dashboard: DashboardModel;
+    /** The status of the dashboard model load */
+    status: 'success';
+};
+/**
+ * React hook that retrieves an existing dashboard model from the Sisense instance.
+ *
+ * @example
+ * An example of retrieving an existing dashboard model from the Sisense instance and render its widgets with component `DashboardWidget`:
+ ```tsx
+  const { dashboard, isLoading, isError } = useGetDashboardModel({
+    dashboardOid: '6448665edac1920034bce7a8',
+    includeWidgets: true,
+  });
+  if (isLoading) {
+    return <div>Loading...</div>;
+  }
+  if (isError) {
+    return <div>Error</div>;
+  }
+  if (dashboard) {
+    return (
+      <div>
+        {`Dashboard Title - ${dashboard.title}`}
+        {dashboard.widgets?.map((widget) => (
+          <DashboardWidget key={widget.oid} widgetOid={widget.oid} dashboardOid={dashboard.oid} />
+        ))}
+      </div>
+    );
+  }
+  return null;
+ ```
+ * @param params - Parameters of the dashboard to be retrieved
+ * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
+ */
+export declare const useGetDashboardModel: (params: GetDashboardModelParams) => DashboardModelState;

package/dist/models/dashboard/use-get-dashboard-models.d.ts

@@ -0,0 +1,84 @@
+import { type DashboardModel } from './types.js';
+import { HookEnableParam } from '../../common/hooks/types.js';
+import { GetDashboardModelsOptions } from './get-dashboard-models.js';
+/**
+ * Parameters for {@link useGetDashboardModels} hook.
+ */
+export interface GetDashboardModelsParams extends GetDashboardModelsOptions, HookEnableParam {
+}
+/**
+ * States of a dashboard models load.
+ */
+export type DashboardModelsState = DashboardModelsLoadingState | DashboardModelsErrorState | DashboardModelsSuccessState;
+/**
+ * State of a dashboard models loading.
+ */
+export type DashboardModelsLoadingState = {
+    /** Whether the dashboard models is loading */
+    isLoading: true;
+    /** Whether the dashboard models load has failed */
+    isError: false;
+    /** Whether the dashboard models load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result dashboard models if the load has succeeded */
+    dashboards: DashboardModel[] | undefined;
+    /** The status of the dashboard models load */
+    status: 'loading';
+};
+/**
+ * State of a dashboard models load that has failed.
+ */
+export type DashboardModelsErrorState = {
+    /** Whether the dashboard models is loading */
+    isLoading: false;
+    /** Whether the dashboard models load has failed */
+    isError: true;
+    /** Whether the dashboard models load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** The result dashboard models if the load has succeeded */
+    dashboards: undefined;
+    /** The status of the dashboard models load */
+    status: 'error';
+};
+/**
+ * State of a dashboard models load that has succeeded.
+ */
+export type DashboardModelsSuccessState = {
+    /** Whether the dashboard models is loading */
+    isLoading: false;
+    /** Whether the dashboard models load has failed */
+    isError: false;
+    /** Whether the dashboard models load has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result dashboard models if the load has succeeded */
+    dashboards: DashboardModel[];
+    /** The status of the dashboard models load */
+    status: 'success';
+};
+/**
+  * React hook that retrieves existing dashboards that the user can access to from the Sisense instance.
+ *
+ * @example
+ ```tsx
+  const { dashboards, isLoading, isError } = useGetDashboardModels();
+  if (isLoading) {
+    return <div>Loading...</div>;
+  }
+  if (isError) {
+    return <div>Error</div>;
+  }
+  if (dashboards) {
+    return <div>{`Total Dashboards: ${dashboards.length}`}</div>;
+  }
+  return null;
+ ```
+ * @param params - Parameters of the dashboards to be retrieved
+ * @returns Load state that contains the status of the execution, the result dashboards, or the error if any
+ */
+export declare const useGetDashboardModels: (params?: GetDashboardModelsParams) => DashboardModelsState;

package/dist/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './dashboard';
+export * from './widget';

package/dist/models/widget/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './translate-widget';

package/dist/models/widget/translate-widget.d.ts

@@ -0,0 +1,3 @@
+import { WidgetDto } from '../../dashboard-widget/types';
+import { WidgetModel } from './types';
+export declare function translateWidget(widget: WidgetDto): WidgetModel;

package/dist/models/widget/types.d.ts

@@ -0,0 +1,6 @@
+import { DataSource } from '@sisense/sdk-data';
+export type WidgetModel = {
+    oid: string;
+    title: string;
+    dataSource: DataSource;
+};

package/dist/props.d.ts

@@ -744,7 +744,7 @@ export interface ExecuteQueryByWidgetIdProps {
      * - `codeFirst` - prioritizes the provided filters over the widget filters in case of filter conflicts by certain attributes.
      * - `codeOnly` - applies only the provided filters and completely ignores the widget filters.
      *
-     * If not specified, the default strategy is `widgetFirst`.
+     * If not specified, the default strategy is `codeFirst`.
      */
     filtersMergeStrategy?: FiltersMergeStrategy;
     /** Function as child component that is called to render the query results */

package/dist/query-execution/query-state-reducer.d.ts

@@ -1,4 +1,5 @@
 import { QueryResultData } from '@sisense/sdk-data';
+import { DataLoadAction } from '../common/hooks/data-load-state-reducer';
 /**
  * State of a query execution.
  */
@@ -54,13 +55,5 @@ export type QuerySuccessState = {
     /** The status of the query execution */
     status: 'success';
 };
-export type QueryAction = {
-    type: 'loading';
-} | {
-    type: 'success';
-    data: QueryResultData;
-} | {
-    type: 'error';
-    error: Error;
-};
+export type QueryAction = DataLoadAction<QueryResultData>;
 export declare function queryStateReducer(state: QueryState, action: QueryAction): QueryState;

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -36,7 +36,7 @@ export type QueryByWidgetIdState = QueryState & {
  * The example below executes a query over the existing dashboard widget with the specified widget and dashboard OIDs.
  ```tsx
   const { data, isLoading, isError } = useExecuteQueryByWidgetId({
-    widgetOid: '64473e07dac1920034bce77f'
+    widgetOid: '64473e07dac1920034bce77f',
     dashboardOid: '6441e728dac1920034bce737'
   });
   if (isLoading) {

package/dist/query-execution/use-execute-query.d.ts

@@ -61,10 +61,3 @@ export type ExecuteQueryParams = {
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  */
 export declare const useExecuteQuery: (params: ExecuteQueryParams) => QueryState;
-/**
- * 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/translation/i18n-provider.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+type I18nProviderProps = {
+    children: React.ReactNode;
+    userLanguage?: string;
+};
+export declare const I18nProvider: ({ children, userLanguage }: I18nProviderProps) => JSX.Element | null;
+export {};

package/dist/translation/initialize-i18n.d.ts

@@ -0,0 +1,2 @@
+export declare function initializeI18n(): import("@sisense/sdk-common").I18NextInitResult;
+export declare const i18nextInstance: import("i18next").i18n;

package/dist/translation/resources/en.d.ts

@@ -0,0 +1,28 @@
+export declare const translation: {
+    errors: {
+        noSisenseContext: string;
+        componentRenderError: string;
+        sisenseContextNoAuthentication: string;
+        chartNoSisenseContext: string;
+        dashboardWidgetNoSisenseContext: string;
+        dashboardWidgetInvalidIdentifiers: string;
+        executeQueryNoSisenseContext: string;
+        executeQueryNoDataSource: string;
+        dataOptions: {
+            emptyValueArray: string;
+            noDimensionsAndMeasures: string;
+            attributeNotFound: string;
+            measureNotFound: string;
+            filterAttributeNotFound: string;
+            highlightAttributeNotFound: string;
+        };
+        themeNotFound: string;
+        paletteNotFound: string;
+        unsupportedWidgetType: string;
+        sisenseContextNotFound: string;
+        dashboardInvalidIdentifier: string;
+    };
+    errorBoxText: string;
+    chartNoData: string;
+};
+export type TranslationDictionary = typeof translation;

package/dist/translation/resources/index.d.ts

@@ -0,0 +1,59 @@
+import { TranslationDictionary } from './en.js';
+export type { TranslationDictionary };
+export declare const PACKAGE_NAMESPACE: "sdkUi";
+export declare const resources: {
+    en: {
+        errors: {
+            noSisenseContext: string;
+            componentRenderError: string;
+            sisenseContextNoAuthentication: string;
+            chartNoSisenseContext: string;
+            dashboardWidgetNoSisenseContext: string;
+            dashboardWidgetInvalidIdentifiers: string;
+            executeQueryNoSisenseContext: string;
+            executeQueryNoDataSource: string;
+            dataOptions: {
+                emptyValueArray: string;
+                noDimensionsAndMeasures: string;
+                attributeNotFound: string;
+                measureNotFound: string;
+                filterAttributeNotFound: string;
+                highlightAttributeNotFound: string;
+            };
+            themeNotFound: string;
+            paletteNotFound: string;
+            unsupportedWidgetType: string;
+            sisenseContextNotFound: string;
+            dashboardInvalidIdentifier: string;
+        };
+        errorBoxText: string;
+        chartNoData: string;
+    };
+    uk: {
+        errors: {
+            noSisenseContext: string;
+            componentRenderError: string;
+            sisenseContextNoAuthentication: string;
+            chartNoSisenseContext: string;
+            dashboardWidgetNoSisenseContext: string;
+            dashboardWidgetInvalidIdentifiers: string;
+            executeQueryNoSisenseContext: string;
+            executeQueryNoDataSource: string;
+            dataOptions: {
+                emptyValueArray: string;
+                noDimensionsAndMeasures: string;
+                attributeNotFound: string;
+                measureNotFound: string;
+                filterAttributeNotFound: string;
+                highlightAttributeNotFound: string;
+            };
+            themeNotFound: string;
+            paletteNotFound: string;
+            unsupportedWidgetType: string;
+            sisenseContextNotFound: string;
+            dashboardInvalidIdentifier: string;
+        };
+        errorBoxText: string;
+        chartNoData: string;
+    };
+};

package/dist/translation/resources/uk.d.ts

@@ -0,0 +1,2 @@
+import { TranslationDictionary } from './index.js';
+export declare const translation: TranslationDictionary;

package/dist/translation/translatable-error.d.ts

@@ -0,0 +1,5 @@
+import { AbstractTranslatableError } from '@sisense/sdk-common';
+import { PACKAGE_NAMESPACE } from './resources';
+export declare class TranslatableError extends AbstractTranslatableError<typeof PACKAGE_NAMESPACE> {
+    constructor(translationKey: string, interpolationOptions?: Record<string, string>);
+}

package/dist/translation/use-initialized-i18n.d.ts

@@ -0,0 +1,2 @@
+import { I18NextInstance } from '@sisense/sdk-common';
+export declare function useInitializedI18n(): I18NextInstance | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui",
-  "version": "0.11.3",
+  "version": "0.12.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -12,10 +12,10 @@
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.11.6",
-    "@sisense/sdk-common": "^0.11.3",
-    "@sisense/sdk-data": "^0.11.3",
-    "@sisense/sdk-query-client": "^0.11.3",
-    "@sisense/sdk-rest-client": "^0.11.3",
+    "@sisense/sdk-common": "^0.12.0",
+    "@sisense/sdk-data": "^0.12.0",
+    "@sisense/sdk-query-client": "^0.12.0",
+    "@sisense/sdk-rest-client": "^0.12.0",
     "@sisense/sisense-charts": "5.1.0-alpha-04052758.0",
     "classnames": "^2.3.2",
     "colorjs.io": "^0.4.3",
@@ -29,6 +29,7 @@
     "lodash": "^4.17.21",
     "merge-deep": "^3.0.3",
     "react-datepicker": "^4.16.0",
+    "react-i18next": "^13.2.2",
     "react-number-format": "^5.1.0",
     "ts-deepmerge": "6.0.2",
     "ts-essentials": "^9.3.0",
@@ -81,6 +82,7 @@
     "@types/react-plotly.js": "^2.6.0",
     "@vitejs/plugin-react-swc": "^3.3.0",
     "autoprefixer": "^10.4.14",
+    "canvas": "^2.11.2",
     "eslint": "^8.40.0",
     "jsdom": "^22.1.0",
     "plotly.js": "^2.25.2",

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

@@ -1,11 +0,0 @@
-import { ClientApplication } from '../app/client-application';
-import { WidgetDto } from './types';
-/**
- * Fetch a dashboard widget from the default Sisense instance using POC
- * authentication code.
- *
- * @param widgetOid - Widget identifier in Sisense instance
- * @param dashboardOid - Dashboard identifier in Sisense instance
- * @param app - Client application
- */
-export declare function fetchWidget(widgetOid: string, dashboardOid: string, app: ClientApplication): Promise<WidgetDto>;

package/dist/locales/en.d.ts

@@ -1,17 +0,0 @@
-export declare const translation: {
-    errors: {
-        componentRenderError: string;
-        sisenseContextNoAuthentication: string;
-        chartNoSisenseContext: string;
-        dashboardWidgetNoSisenseContext: string;
-        dashboardWidgetInvalidIdentifiers: string;
-        executeQueryNoSisenseContext: string;
-        executeQueryNoDataSource: string;
-        dataOptions: {
-            emptyValueArray: string;
-        };
-    };
-    common: {
-        chartNoData: string;
-    };
-};