@sisense/sdk-ui-vue 1.10.1 → 1.12.0

package/dist/src/components/charts/areamap-chart.d.ts

@@ -36,7 +36,6 @@ import type { PropType } from 'vue';
  * @param props - Areamap chart properties
  * @returns Areamap Chart component
  * @group Charts
- * @beta
  */
 export declare const AreamapChart: import("vue").DefineComponent<{
     dataOptions: PropType<import("@sisense/sdk-ui-preact").AreamapChartDataOptions>;

package/dist/src/components/charts/boxplot-chart.d.ts

@@ -37,7 +37,6 @@ import type { PropType } from 'vue';
  * @param props - Boxplot chart properties
  * @returns Boxplot Chart component
  * @group Charts
- * @beta
  */
 export declare const BoxplotChart: import("vue").DefineComponent<{
     dataOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotChartDataOptions | import("@sisense/sdk-ui-preact").BoxplotChartCustomDataOptions>;

package/dist/src/components/charts/pivot-table.d.ts

@@ -35,12 +35,13 @@ const pivotTableProps = ref<PivotTableProps>({
  * ```
  * <img src="media://vue-pivot-table-example.png" width="800px" />
  * @group Data Grids
- * @alpha
+ * @beta
  */
 export declare const PivotTable: import("vue").DefineComponent<{
     dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions>;
     dataSet: PropType<import("@sisense/sdk-data").DataSource | undefined>;
     filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
     refreshCounter: PropType<number | undefined>;
     styleOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableStyleOptions | undefined>;
 }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
@@ -49,6 +50,7 @@ export declare const PivotTable: import("vue").DefineComponent<{
     dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions>;
     dataSet: PropType<import("@sisense/sdk-data").DataSource | undefined>;
     filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
     refreshCounter: PropType<number | undefined>;
     styleOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableStyleOptions | undefined>;
 }>>, {}, {}>;

package/dist/src/components/charts/scattermap-chart.d.ts

@@ -36,7 +36,6 @@ import type { PropType } from 'vue';
  * @param props - Scattermap chart properties
  * @returns Scattermap Chart component
  * @group Charts
- * @beta
  */
 export declare const ScattermapChart: import("vue").DefineComponent<{
     dataOptions: PropType<import("@sisense/sdk-ui-preact").ScattermapChartDataOptions>;

package/dist/src/components/charts/sunburst-chart.d.ts

@@ -35,7 +35,6 @@ import type { PropType } from 'vue';
  * @param props - Sunburst Chart properties
  * @returns Sunburst Chart component
  * @group Charts
- * @beta
  */
 export declare const SunburstChart: import("vue").DefineComponent<{
     dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;

package/dist/src/components/filters/basic-member-filter-tile.d.ts

@@ -26,7 +26,7 @@ export declare const BasicMemberFilterTile: import("vue").DefineComponent<{
     initialSelectedMembers: PropType<import("@sisense/sdk-ui/dist/filters/components/member-filter-tile/members-reducer").SelectedMember[] | undefined>;
     isDependent: PropType<boolean | undefined>;
     maxAllowedMembers: PropType<number | undefined>;
-    onUpdateSelectedMembers: PropType<((members: string[]) => void) | undefined>;
+    onUpdateSelectedMembers: PropType<((members: string[], disabled?: boolean | undefined) => void) | undefined>;
     shouldUpdateSelectedMembers: PropType<boolean | undefined>;
     title: PropType<string>;
 }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
@@ -36,7 +36,7 @@ export declare const BasicMemberFilterTile: import("vue").DefineComponent<{
     initialSelectedMembers: PropType<import("@sisense/sdk-ui/dist/filters/components/member-filter-tile/members-reducer").SelectedMember[] | undefined>;
     isDependent: PropType<boolean | undefined>;
     maxAllowedMembers: PropType<number | undefined>;
-    onUpdateSelectedMembers: PropType<((members: string[]) => void) | undefined>;
+    onUpdateSelectedMembers: PropType<((members: string[], disabled?: boolean | undefined) => void) | undefined>;
     shouldUpdateSelectedMembers: PropType<boolean | undefined>;
     title: PropType<string>;
 }>>, {}, {}>;

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

@@ -4,3 +4,5 @@ export { useGetDashboardModel } from './use-get-dashboard-model.js';
 export { useGetDashboardModels } from './use-get-dashboard-models.js';
 export { useGetSharedFormula } from './use-get-shared-formula.js';
 export { useGetWidgetModel } from './use-get-widget-model.js';
+export { useFetch } from './use-fetch.js';
+export type { UseFetchOptions } from './use-fetch.js';

package/dist/src/composables/use-custom-drilldown.d.ts

@@ -75,6 +75,7 @@ export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimensio
         };
         readonly filterType: string;
         readonly guid: string;
+        disabled: boolean;
         readonly name: string;
         isScope: boolean;
         jaql: (nested?: boolean | undefined) => any;

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

@@ -1,6 +1,6 @@
 import type { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from '@sisense/sdk-ui-preact';
 import { type ToRefs } from 'vue';
-import type { MaybeWithRefs } from '../types';
+import type { MaybeRefOrWithRefs } from '../types';
 /**
  * A Vue composable function `useExecuteQueryByWidgetId` for executing queries by widget ID using the Sisense SDK.
  * It simplifies the process of fetching data related to a specific widget based on provided parameters and manages
@@ -42,4 +42,4 @@ import type { MaybeWithRefs } from '../types';
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare const useExecuteQueryByWidgetId: (params: MaybeWithRefs<ExecuteQueryByWidgetIdParams>) => ToRefs<QueryByWidgetIdState>;
+export declare const useExecuteQueryByWidgetId: (params: MaybeRefOrWithRefs<ExecuteQueryByWidgetIdParams>) => ToRefs<QueryByWidgetIdState>;

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

@@ -1,12 +1,12 @@
 import { type ExecuteQueryParams } from '@sisense/sdk-ui-preact';
-import type { MaybeWithRefs } from '../types';
+import type { MaybeRefOrWithRefs } from '../types';
 /**
  * A Vue composable function `useExecuteQuery` for executing Sisense queries with flexible parameters.
  * It handles query execution, including loading, error, and success states, and enables dynamic query configuration
  * through reactive parameters. This composable is particularly useful for applications requiring data from Sisense
  * analytics, offering a reactive and declarative approach to data fetching and state management.
  *
- * @param {MaybeWithRefs<ExecuteQueryParams>} params - The parameters for the query, supporting reactive Vue refs.
+ * @param {MaybeRefOrWithRefs<ExecuteQueryParams>} params - The parameters for the query, supporting reactive Vue refs.
  * Includes details such as `dataSource`, `dimensions`, `measures`, `filters`, and more, allowing for comprehensive
  * query configuration. The `filters` parameter supports dynamic filtering based on user interaction or other application
  * state changes.
@@ -42,4 +42,4 @@ import type { MaybeWithRefs } from '../types';
  * to easily manage query states and dynamically adjust query parameters based on application needs.
  * @group Queries
  */
-export declare const useExecuteQuery: (params: MaybeWithRefs<ExecuteQueryParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").QueryState>;
+export declare const useExecuteQuery: (params: MaybeRefOrWithRefs<ExecuteQueryParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").QueryState>;

package/dist/src/composables/use-fetch.d.ts

@@ -0,0 +1,49 @@
+import type { DataState, RequestConfig } from '@sisense/sdk-ui-preact';
+import { type ToRefs } from 'vue';
+import type { MaybeRef, MaybeRefOrWithRefs } from '../types';
+/**
+ * The options for the `useFetch` composable function.
+ */
+export type UseFetchOptions = {
+    /** The request configuration object. */
+    requestConfig?: RequestConfig;
+    /** A boolean indicating whether the fetch operation is enabled. */
+    enabled?: boolean;
+};
+/**
+ * A Vue composable function `useFetch` that allows to make authorized fetch request to any Sisense API.
+ *
+ * @param path - The endpoint path to fetch data from. This should be a relative path like '/api/v1/endpoint'
+ * @param init - The request init object
+ * @param options - The additional request options
+ *
+ * @example
+ * How to use `useFetch` within a Vue component to fetch and display widget information:
+ * ```vue
+ * <script setup>
+ * import { ref } from "vue";
+ * import { useFetch } from "./composables/useFetch";
+ *
+ * const enabled = ref(true);
+ * const { data, isLoading, isError, error } = useFetch(
+ *   "api/v1/elasticubes/getElasticubes",
+ *   {
+ *     method: "POST",
+ *   },
+ *   {
+ *     enabled,
+ *   });
+ * </script>
+ * ```
+ *
+ * The composable returns an object with reactive properties that represent the state of the data fetch operation:
+ * - `data`: The fetched data, which is `undefined` until the operation is successfully completed.
+ * - `isLoading`: A boolean indicating whether the fetch operation is currently in progress.
+ * - `isError`: A boolean indicating whether an error occurred during the fetch operation.
+ * - `isSuccess`: A boolean indicating whether the fetch operation was successfully completed without any errors.
+ * - `error`: An error object containing details about any errors that occurred during the fetch operation.
+ *
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export declare const useFetch: <TData = unknown>(path: MaybeRef<string>, init?: MaybeRefOrWithRefs<RequestInit>, options?: MaybeRefOrWithRefs<UseFetchOptions>) => ToRefs<DataState<TData>>;

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

@@ -1,4 +1,4 @@
-import type { MaybeWithRefs } from '../types';
+import type { MaybeRefOrWithRefs } from '../types';
 import type { GetDashboardModelParams } from '@sisense/sdk-ui-preact';
 /**
  * A Vue composable function `useGetDashboardModel` for fetching a Sisense dashboard model.
@@ -40,4 +40,4 @@ import type { GetDashboardModelParams } from '@sisense/sdk-ui-preact';
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare const useGetDashboardModel: (params: MaybeWithRefs<GetDashboardModelParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DashboardModelState>;
+export declare const useGetDashboardModel: (params: MaybeRefOrWithRefs<GetDashboardModelParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DashboardModelState>;

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

@@ -1,5 +1,5 @@
 import type { GetDashboardModelsParams } from '@sisense/sdk-ui-preact';
-import type { MaybeWithRefs } from '../types';
+import type { MaybeRefOrWithRefs } from '../types';
 /**
  * A Vue composable function `useGetDashboardModels` for fetching multiple Sisense dashboard models.
  * This function abstracts the complexities of managing API calls and state management for fetching an array of
@@ -37,4 +37,4 @@ import type { MaybeWithRefs } from '../types';
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare const useGetDashboardModels: (params: MaybeWithRefs<GetDashboardModelsParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DashboardModelsState>;
+export declare const useGetDashboardModels: (params: MaybeRefOrWithRefs<GetDashboardModelsParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DashboardModelsState>;

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

@@ -1,5 +1,5 @@
 import type { UseGetSharedFormulaParams } from '@sisense/sdk-ui-preact';
-import type { MaybeWithRefs } from '../types';
+import type { MaybeRefOrWithRefs } from '../types';
 /**
  * A Vue composable function `useGetSharedFormula` for retrieving shared formulas from Sisense.
  * This function enables fetching a shared formula either by its unique OID or by its name and associated data source,
@@ -44,4 +44,4 @@ import type { MaybeWithRefs } from '../types';
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare const useGetSharedFormula: (params: MaybeWithRefs<UseGetSharedFormulaParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").SharedFormulaState>;
+export declare const useGetSharedFormula: (params: MaybeRefOrWithRefs<UseGetSharedFormulaParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").SharedFormulaState>;

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

@@ -1,5 +1,5 @@
 import type { GetWidgetModelParams, WidgetModel } from '@sisense/sdk-ui-preact';
-import type { MaybeWithRefs } from '../types';
+import type { MaybeRefOrWithRefs } from '../types';
 /**
  * A Vue composable function `useGetWidgetModel` for retrieving widget models from a Sisense dashboard.
  * It is designed to fetch a specific widget model based on the provided dashboard and widget OIDs, handling the loading,
@@ -40,4 +40,4 @@ import type { MaybeWithRefs } from '../types';
  * @group Fusion Embed
  * @fusionEmbed
  */
-export declare const useGetWidgetModel: (params: MaybeWithRefs<GetWidgetModelParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DataState<WidgetModel>>;
+export declare const useGetWidgetModel: (params: MaybeRefOrWithRefs<GetWidgetModelParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DataState<WidgetModel>>;

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

@@ -84,27 +84,40 @@ export declare const getThemeContext: () => Ref<{
             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;
 /**
@@ -194,27 +207,40 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
                     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;
+                };
             };
         };
         skipTracking: boolean;
@@ -301,27 +327,40 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
                     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;
+                };
             };
         };
         skipTracking?: boolean | undefined;

package/dist/src/setup-helper.d.ts

@@ -1,5 +1,4 @@
 import { type Slots } from 'vue';
-export declare function isObject(value: unknown): boolean;
 export declare function getRawData<T>(data: T): T;
 export declare function toDeepRaw<T>(data: T): T;
 /**

package/dist/src/types.d.ts

@@ -1,5 +1,6 @@
 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];
+export type MaybeWithRefs<T extends object> = {
+    [Property in keyof T]: MaybeRef<T[Property]>;
 };
+export type MaybeRefOrWithRefs<T extends Object> = MaybeRef<T> | MaybeWithRefs<T>;

package/dist/src/utils.d.ts

@@ -1,6 +1,6 @@
-import type { MaybeRef, MaybeWithRefs } from './types';
+import { type Ref } from 'vue';
+import type { MaybeRef, MaybeRefOrWithRefs, MaybeWithRefs } from './types';
+export declare function isObject(value: unknown): boolean;
 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[];
+export declare function toPlainObject<T extends object>(refObj: MaybeRefOrWithRefs<T>): T;
+export declare function collectRefs<UnknownObject extends object>(...params: (MaybeRef<unknown> | MaybeWithRefs<UnknownObject>)[]): Ref<unknown | UnknownObject>[];

package/package.json

@@ -11,11 +11,19 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.10.1",
+  "version": "1.12.0",
   "type": "module",
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "files": [
@@ -34,7 +42,7 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
-    "@sisense/sdk-ui-preact": "^1.10.1",
+    "@sisense/sdk-ui-preact": "^1.12.0",
     "deepmerge": "^4.3.1",
     "lodash": "^4.17.21",
     "vue": "^3.3.2"