@sisense/sdk-ui-vue 1.1.0 → 1.3.0

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

@@ -0,0 +1,85 @@
+import type { Attribute, Column } from '@sisense/sdk-data';
+import { type DataPoint, type StyledColumn } from '@sisense/sdk-ui-preact';
+import { type Ref } from 'vue';
+/**
+ * @internal
+ */
+export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimension, }: {
+    drilldownDimensions: Ref<Attribute[]>;
+    initialDimension: Column | StyledColumn;
+}) => {
+    selectDrilldown: (points: DataPoint[], nextDimension: Attribute) => void;
+    sliceDrilldownSelections: (i: number) => void;
+    clearDrilldownSelections: () => void;
+    drilldownSelections: Ref<{
+        points: ({
+            value?: string | number | undefined;
+            categoryValue?: string | number | undefined;
+            categoryDisplayValue?: string | undefined;
+            seriesValue?: string | number | undefined;
+        } | {
+            x?: string | number | undefined;
+            y?: string | number | undefined;
+            size?: number | undefined;
+            breakByPoint?: string | undefined;
+            breakByColor?: string | undefined;
+        } | {
+            boxMin: number;
+            boxMedian: number;
+            boxMax: number;
+            whiskerMin: number;
+            whiskerMax: number;
+            categoryValue?: string | number | undefined;
+            categoryDisplayValue?: string | undefined;
+        } | {
+            geoName: string;
+            originalValue: number;
+            formattedOriginalValue: string;
+            color?: import("@sisense/sdk-ui-preact").Color | undefined;
+        })[];
+        nextDimension: {
+            readonly expression: string;
+            getSort: () => import("@sisense/sdk-data").Sort;
+            sort: (sort: import("@sisense/sdk-data").Sort) => Attribute;
+            name: string;
+            readonly type: string;
+            readonly description: string;
+            readonly id: string;
+            serializable: () => any;
+            toJSON: () => any;
+            jaql: (nested?: boolean | undefined) => any;
+            skipValidation?: boolean | undefined;
+        };
+    }[]>;
+    availableDrilldowns: import("vue").ComputedRef<Attribute[]>;
+    drilldownDimension: Ref<Attribute | undefined>;
+    drilldownFilters: Ref<{
+        readonly members: any[];
+        readonly id: string;
+        serializable: () => any;
+        filterJaql: () => any;
+        readonly attribute: {
+            readonly expression: string;
+            getSort: () => import("@sisense/sdk-data").Sort;
+            sort: (sort: import("@sisense/sdk-data").Sort) => Attribute;
+            name: string;
+            readonly type: string;
+            readonly description: string;
+            readonly id: string;
+            serializable: () => any;
+            toJSON: () => any;
+            jaql: (nested?: boolean | undefined) => any;
+            skipValidation?: boolean | undefined;
+        };
+        readonly filterType: string;
+        readonly guid: string;
+        readonly name: string;
+        isScope: boolean;
+        jaql: (nested?: boolean | undefined) => any;
+        readonly description: string;
+        readonly type: string;
+        toJSON: () => any;
+        toString: () => string;
+    }[]>;
+    drilldownFiltersDisplayValues: Ref<string[][]>;
+};

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

@@ -2,8 +2,6 @@ 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;
-        };
+        query: import("@sisense/sdk-ui/dist/query/execute-query").QueryDescription;
     };
 }>;

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

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

package/dist/src/lib.d.ts

@@ -1,5 +1,14 @@
-export { SisenseContextProvider, ThemeProvider } from './providers';
+/**
+ * @packageDocumentation
+ * @alpha
+ */
+export { DrilldownBreadcrumbs } from './components/drilldown-breadcrumbs';
 export * from './components/charts';
 export * from './components/filters';
+export * from './providers';
 export * from './hooks';
-export type { AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, MemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, CustomSisenseContextProviderProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, ExecuteCsvQueryParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, BoxplotChartProps, AreamapChartProps, } from '@sisense/sdk-ui-preact';
+export * from './components/context-menu';
+export { default as DrilldownWidget } from './components/drilldown-widget.vue';
+import type { ContextMenuProps as ContextMenuPropsPreact } from '@sisense/sdk-ui-preact';
+export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
+export type { AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, MemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, CustomSisenseContextProviderProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, ExecuteCsvQueryParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, SisenseContextProviderProps, ThemeProviderProps, ScattermapChartProps, } from '@sisense/sdk-ui-preact';

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

@@ -1,10 +1,5 @@
 import type { PropType } from 'vue';
-import type { SisenseContextProviderProps } from '@sisense/sdk-ui-preact';
 import { ClientApplication } from '@sisense/sdk-ui-preact';
-/**
- * Gets Sisense context
- */
-export declare const getSisenseContext: () => SisenseContextProviderProps;
 /**
  * Gets Sisense application
  */
@@ -40,7 +35,7 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
     enableTracking: PropType<boolean | undefined>;
 }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>[] | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}>[] | null | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     defaultDataSource: PropType<string | undefined>;
     url: PropType<string>;
     ssoEnabled: PropType<boolean | undefined>;

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

@@ -90,7 +90,7 @@ export declare const ThemeProvider: import("vue").DefineComponent<{
     skipTracking: PropType<boolean | undefined>;
 }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>[] | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}>[] | null | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     theme: PropType<string | import("@sisense/sdk-ui-preact").ThemeSettings | undefined>;
     /**
      * @internal

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

@@ -1,6 +1,18 @@
+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;
+/**
+ * @internal
+ * @description This is a helper function to render a component without children.
+ */
 export declare const setupHelper: <P, C>(component: C, props: P) => (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>) | null;
+/**
+ * @internal
+ * @description This is a helper function to render a component with children.
+ */
+export declare const setupHelperWithChildren: <P, C>(component: C, props: P, slots: Slots, contexts?: []) => () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>[];

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,3 @@
+import type { MaybeRef, MaybeWithRefs } from './types';
+export declare function toPlainValue<T>(value: MaybeRef<T>): T;
+export declare function collectRefs<T extends {}>(objectWithRefs: MaybeWithRefs<T>): unknown[];

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.1.0",
+  "version": "1.3.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",