@sisense/sdk-ui-vue 1.2.0 → 1.4.0

package/dist/src/providers/sisense-context-provider.d.ts

@@ -1,18 +1,15 @@
-import type { PropType } from 'vue';
-import type { SisenseContextProviderProps } from '@sisense/sdk-ui-preact';
+import type { PropType, Ref } from 'vue';
 import { ClientApplication } from '@sisense/sdk-ui-preact';
-/**
- * Gets Sisense context
- */
-export declare const getSisenseContext: () => SisenseContextProviderProps;
 /**
  * Gets Sisense application
+ * @internal
  */
-export declare const getApp: () => Promise<ClientApplication>;
+export declare const getApp: () => Ref<ClientApplication | undefined>;
 /**
  * Creates Sisense context connector
+ * @internal
  */
-export declare const createSisenseContextConnector: () => {
+export declare const createSisenseContextConnector: (app: ClientApplication) => {
     prepareContext(): Promise<{
         app: ClientApplication;
         isInitialized: boolean;
@@ -20,8 +17,51 @@ export declare const createSisenseContextConnector: () => {
     renderContextProvider: (contextData: import("@sisense/sdk-ui-preact").CustomSisenseContext | undefined, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
 };
 /**
- * Sisense Context Provider
+ * Sisense Context Provider Component allowing you to connect to
+ * a Sisense instance and provide that context
+ * to all Compose SDK components in your application.
+ *
+ * @example
+ * Here's how to use the `SisenseContextProvider` component to wrap your Sisense-enabled application:
+ * Add SisenseContextProvider to the main component of your app as below and then wrap
+ * other SDK components inside this component.
+ * ```vue
+ * <template>
+ *   <SisenseContextProvider
+ *     :url="sisenseUrl"
+ *     :defaultDataSource="defaultDataSource"
+ *     :ssoEnabled="true"
+ *     :token="authToken"
+ *     :wat="watToken"
+ *     :appConfig="appConfigurations"
+ *     :showRuntimeErrors="true"
+ *     :enableTracking="false"
+ *   >
+ *     <!-- Your application components here -->
+ *   </SisenseContextProvider>
+ * </template>
+ *
+ * <script>
+ * import { ref } from 'vue';
+ * import SisenseContextProvider from './SisenseContextProvider.vue';
+ *
+ * export default {
+ *   components: { SisenseContextProvider },
+ *   setup() {
+ *     const sisenseUrl = ref('https://your-sisense-instance.com');
+ *     const defaultDataSource = ref('default_datasource_id');
+ *     const authToken = ref('your_auth_token');
+ *     const watToken = ref('your_wat_token');
+ *     const appConfigurations = ref({});
+ *
+ *     return { sisenseUrl, defaultDataSource, authToken, watToken, appConfigurations };
+ *   }
+ * };
+ * </script>
+ * ```
  *
+ * @param props - Sisense context provider props
+ * @returns A Sisense Context Provider Component
  */
 export declare const SisenseContextProvider: import("vue").DefineComponent<{
     defaultDataSource: PropType<string | undefined>;

package/dist/src/providers/theme-provider.d.ts

@@ -1,8 +1,9 @@
-import type { PropType } from 'vue';
+import type { PropType, Ref } from 'vue';
+import type { CompleteThemeSettings } from '@sisense/sdk-ui-preact';
 /**
  * Gets Theme context
  */
-export declare const getThemeContext: () => {
+export declare const getThemeContext: () => Ref<{
     chart: {
         textColor: string;
         secondaryTextColor: string;
@@ -23,11 +24,11 @@ export declare const getThemeContext: () => {
         primaryButtonTextColor: string;
         primaryButtonHoverColor: string;
     };
-};
+}> | undefined;
 /**
  * Creates theme context connector
  */
-export declare const createThemeContextConnector: () => {
+export declare const createThemeContextConnector: (themeSettings?: CompleteThemeSettings) => {
     prepareContext(): Promise<{
         themeSettings: {
             chart: {
@@ -80,7 +81,61 @@ export declare const createThemeContextConnector: () => {
     }, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
 };
 /**
- * Theme Provider
+ * Theme provider, which allows you to adjust the look and feel of child components.
+ *
+ * @example
+ * Example of a theme provider, which changes the colors and font of the nested indicator chart:
+ * ```vue
+ * <template>
+ *   <ThemeProvider :theme="customTheme">
+ *     <IndicatorChart .... />
+ *   </ThemeProvider>
+ * </template>
+ *
+ * <script>
+ * import { ref } from 'vue';
+ * import ThemeProvider from './ThemeProvider.vue';
+ *
+ * export default {
+ *   components: { ThemeProvider },
+ *   setup() {
+ *     const customTheme = ref({
+         chart: {
+           backgroundColor: '#333333',
+           textColor: 'orange',
+           secondaryTextColor: 'purple',
+         },
+         typography: {
+           fontFamily: 'impact',
+         },
+ *     });
+ *
+ *     return { customTheme };
+ *   }
+ * };
+ * </script>
+ * ```
+ *
+ * Alternatively, to fetch theme settings based on a theme ID:
+ * ```vue
+ * <template>
+ *   <ThemeProvider :theme="'theme_id_string'">
+ *     <!-- Components that will use the fetched theme settings -->
+ *   </ThemeProvider>
+ * </template>
+ * ```
+ *
+ * Indicator chart with custom theme settings:
+ * <img src="media://indicator-chart-example-2.png" width="400px" />
+ *
+ *
+ * For comparison, indicator chart with default theme settings:
+ *
+ * <img src="media://indicator-chart-example-1.png" width="400px" />
+ * @see {@link ThemeSettings} and {@link IndicatorChart}
+ * @param props - Theme provider props
+ * @returns A Theme Provider component * @prop {Object | String} theme - Theme settings object for custom themes or a string identifier to fetch theme settings. When provided as an object, it merges with the default theme settings. When provided as a string, it attempts to fetch theme settings using the provided ID.
+ * @prop {Boolean} skipTracking [internal] - Specifies whether to skip tracking of theme usage. Intended for internal use and debugging purposes.
  */
 export declare const ThemeProvider: import("vue").DefineComponent<{
     theme: PropType<string | import("@sisense/sdk-ui-preact").ThemeSettings | undefined>;

package/dist/src/sdk-ui-core-exports.d.ts

@@ -0,0 +1,5 @@
+export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, MemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, ExecuteCsvQueryParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
+import type { ContextMenuProps as ContextMenuPropsPreact, ThemeProviderProps as ThemeProviderPropsPreact } from '@sisense/sdk-ui-preact';
+export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
+export type ThemeProviderProps = Omit<ThemeProviderPropsPreact, 'children'>;

package/dist/src/types.d.ts

@@ -0,0 +1,5 @@
+import type { Ref } from 'vue';
+export type MaybeRef<T> = Ref<T> | T;
+export type MaybeWithRefs<T> = {
+    [Property in keyof T]: Ref<T[Property]> | T[Property];
+};

package/dist/src/utils.d.ts

@@ -0,0 +1,6 @@
+import type { MaybeRef, MaybeWithRefs } from './types';
+export declare function toPlainValue<T>(value: MaybeRef<T>): T;
+export declare function toPlainValues<T extends object>(refObj: T): {
+    [K in keyof T]: T[K] extends MaybeRef<infer R> ? R : T[K];
+};
+export declare function collectRefs<T extends {}>(objectWithRefs: MaybeWithRefs<T>): unknown[];

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.2.0",
+  "version": "1.4.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -34,10 +34,13 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
+    "deepmerge": "^4.3.1",
+    "lodash": "^4.17.21",
     "vue": "^3.3.2"
   },
   "devDependencies": {
     "@rushstack/eslint-patch": "^1.2.0",
+    "@types/lodash": "^4.14.194",
     "@types/node": "^18.14.2",
     "@vitejs/plugin-vue": "^4.0.0",
     "@vue/eslint-config-prettier": "^7.1.0",

package/dist/src/hooks/index.d.ts

@@ -1,6 +0,0 @@
-export { useExecuteQuery } from './use-execute-query';
-export { useExecuteQueryByWidgetId } from './use-execute-query-by-widget-id';
-export { useGetDashboardModel } from './use-get-dashboard-model';
-export { useGetDashboardModels } from './use-get-dashboard-models';
-export { useGetSharedFormula } from './use-get-shared-formula';
-export { useGetWidgetModel } from './use-get-widget-model';

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

@@ -1,9 +0,0 @@
-import type { ExecuteQueryByWidgetIdParams } from '@sisense/sdk-ui-preact';
-export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdParams) => Promise<{
-    data: {
-        data: import("@sisense/sdk-data").QueryResultData;
-        query: Omit<import("@sisense/sdk-ui-preact").ExecuteQueryParams, "filters"> & {
-            filters?: import("@sisense/sdk-data").Filter[] | undefined;
-        };
-    };
-}>;

package/dist/src/hooks/use-execute-query.d.ts

@@ -1,11 +0,0 @@
-import type { ExecuteQueryParams } from '@sisense/sdk-ui-preact';
-/**
- * A hook function that executes a data query.
- * TODO Document
- *
- *
- * @returns TODO
- */
-export declare const useExecuteQuery: (params: ExecuteQueryParams) => Promise<{
-    data: import("@sisense/sdk-data").QueryResultData;
-}>;

package/dist/src/hooks/use-get-dashboard-model.d.ts

@@ -1,4 +0,0 @@
-import type { GetDashboardModelParams } from '@sisense/sdk-ui-preact';
-export declare const useGetDashboardModel: (params: GetDashboardModelParams) => Promise<{
-    data: import("@sisense/sdk-ui-preact").DashboardModelState;
-}>;

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

@@ -1,4 +0,0 @@
-import type { GetDashboardModelsParams } from '@sisense/sdk-ui-preact';
-export declare const useGetDashboardModels: (params: GetDashboardModelsParams) => Promise<{
-    data: import("@sisense/sdk-ui-preact").DashboardModelsState;
-}>;

package/dist/src/hooks/use-get-shared-formula.d.ts

@@ -1,4 +0,0 @@
-import type { GetSharedFormulaParams } from '@sisense/sdk-ui-preact';
-export declare const useGetSharedFormula: (params: GetSharedFormulaParams) => Promise<{
-    data: import("@sisense/sdk-ui-preact").SharedFormulaState;
-}>;

package/dist/src/hooks/use-get-widget-model.d.ts

@@ -1,4 +0,0 @@
-import type { GetWidgetModelParams } from '@sisense/sdk-ui-preact';
-export declare const useGetWidgetModel: (params: GetWidgetModelParams) => Promise<{
-    data: import("@sisense/sdk-ui-preact").WidgetModelState;
-}>;