@sisense/sdk-ui-vue 1.0.0 → 1.2.0

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

@@ -0,0 +1,45 @@
+import type { PropType } from 'vue';
+/**
+ * A Vue component that wraps the AreamapChart Preact component for use in Vue applications.
+ * It maintains compatibility with Vue's reactivity system while preserving the functionality of the AreamapChart.
+ *
+ * @example
+ * Here's how you can use the AreamapChart component in a Vue application:
+ * ```vue
+ * <template>
+ *   <AreamapChart :props="areamapChartProps" />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import AreamapChart from '@sisense/sdk-ui-vue/AreamapChart';
+ *
+ * const areamapChartProps = ref({
+ *   // Configure your AreamapChartProps here
+ * });
+ * </script>
+ * ```
+ */
+export declare const AreamapChart: import("vue").DefineComponent<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").AreamapChartDataOptions>;
+    dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelation | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").AreamapStyleOptions | undefined>;
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").AreamapChartDataOptions>;
+    dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelation | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").AreamapStyleOptions | undefined>;
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+}>>, {}, {}>;

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

@@ -0,0 +1,45 @@
+import type { PropType } from 'vue';
+/**
+ * A Vue component that wraps the BoxplotChart Preact component for use in Vue applications.
+ * It maintains compatibility with Vue's reactivity system while preserving the functionality of the BoxplotChart.
+ *
+ * @example
+ * Here's how you can use the BoxplotChart component in a Vue application:
+ * ```vue
+ * <template>
+ *   <BoxplotChart :props="boxplotChartProps" />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import BoxplotChart from '@sisense/sdk-ui-vue/BoxplotChart';
+ *
+ * const boxplotChartProps = ref({
+ *   // Configure your BoxplotChartProps here
+ * });
+ * </script>
+ * ```
+ */
+export declare const BoxplotChart: import("vue").DefineComponent<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotChartDataOptions | import("@sisense/sdk-ui-preact").BoxplotChartCustomDataOptions>;
+    dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelation | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotStyleOptions | undefined>;
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotChartDataOptions | import("@sisense/sdk-ui-preact").BoxplotChartCustomDataOptions>;
+    dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelation | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotStyleOptions | undefined>;
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+}>>, {}, {}>;

package/dist/src/components/charts/index.d.ts

@@ -14,3 +14,6 @@ export { ChartWidget } from './chart-widget';
 export { Chart } from './chart';
 export { DashboardWidget } from './dashboard-widget';
 export { TableWidget } from './table-widget';
+export { BoxplotChart } from './boxplot-chart';
+export { AreamapChart } from './areamap-chart';
+export { ScattermapChart } from './scattermap-chart';

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

@@ -0,0 +1,37 @@
+import type { PropType } from 'vue';
+/**
+ * A Vue component that wraps the ScattermapChart Preact component for use in Vue applications.
+ * It maintains compatibility with Vue's reactivity system while preserving the functionality of the ScattermapChart.
+ *
+ * @example
+ * Here's how you can use the ScattermapChart component in a Vue application:
+ * ```vue
+ * <template>
+ *   <ScattermapChart :props="ScattermapChartProps" />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import ScattermapChart from '@sisense/sdk-ui-vue/ScattermapChart';
+ *
+ * const ScattermapChartProps = ref({
+ *   // Configure your ScattermapChartProps here
+ * });
+ * </script>
+ * ```
+ */
+export declare const ScattermapChart: import("vue").DefineComponent<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").ScattermapChartDataOptions>;
+    dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelation | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").ScattermapStyleOptions | undefined>;
+}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").ScattermapChartDataOptions>;
+    dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelation | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").ScattermapStyleOptions | undefined>;
+}>>, {}, {}>;

package/dist/src/components/context-menu.d.ts

@@ -0,0 +1,12 @@
+import type { PropType } from 'vue';
+export declare const ContextMenu: import("vue").DefineComponent<{
+    closeContextMenu: PropType<() => void>;
+    itemSections: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
+    position: PropType<import("@sisense/sdk-ui-preact").MenuPosition | null | undefined>;
+}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>[], unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    closeContextMenu: PropType<() => void>;
+    itemSections: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
+    position: PropType<import("@sisense/sdk-ui-preact").MenuPosition | null | undefined>;
+}>>, {}, {}>;

package/dist/src/components/drilldown-breadcrumbs.d.ts

@@ -0,0 +1,14 @@
+import type { PropType } from 'vue';
+export declare const DrilldownBreadcrumbs: import("vue").DefineComponent<{
+    clearDrilldownSelections: PropType<() => void>;
+    currentDimension: PropType<import("@sisense/sdk-data").Attribute>;
+    sliceDrilldownSelections: PropType<(i: number) => void>;
+    filtersDisplayValues: PropType<string[][]>;
+}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>[], unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    clearDrilldownSelections: PropType<() => void>;
+    currentDimension: PropType<import("@sisense/sdk-data").Attribute>;
+    sliceDrilldownSelections: PropType<(i: number) => void>;
+    filtersDisplayValues: PropType<string[][]>;
+}>>, {}, {}>;

package/dist/src/components/drilldown-widget.vue.d.ts

@@ -0,0 +1,46 @@
+import type { Component, PropType } from 'vue';
+import type { ContextMenuProps } from '@sisense/sdk-ui-preact';
+import type { Attribute } from '@sisense/sdk-data';
+type DrilldownWidgetConfig = {
+    isBreadcrumbsDetached?: boolean;
+    breadcrumbsComponent?: Component;
+    contextMenuComponent?: (props: ContextMenuProps) => Component;
+};
+declare const _sfc_main: import("vue").DefineComponent<{
+    config: {
+        type: PropType<DrilldownWidgetConfig>;
+        required: false;
+        default: () => {};
+    };
+    drilldownDimensions: {
+        type: PropType<Attribute[]>;
+        required: false;
+        default: () => never[];
+    };
+    initialDimension: {
+        type: PropType<Attribute>;
+        required: false;
+        default: () => {};
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    config: {
+        type: PropType<DrilldownWidgetConfig>;
+        required: false;
+        default: () => {};
+    };
+    drilldownDimensions: {
+        type: PropType<Attribute[]>;
+        required: false;
+        default: () => never[];
+    };
+    initialDimension: {
+        type: PropType<Attribute>;
+        required: false;
+        default: () => {};
+    };
+}>>, {
+    drilldownDimensions: Attribute[];
+    initialDimension: Attribute;
+    config: DrilldownWidgetConfig;
+}, {}>;
+export default _sfc_main;

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

@@ -1 +1,6 @@
 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-custom-drilldown.d.ts

@@ -0,0 +1,66 @@
+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;
+        }[];
+        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

@@ -0,0 +1,9 @@
+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-get-dashboard-model.d.ts

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,4 @@
+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

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

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, } 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/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/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.0.0",
+  "version": "1.2.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",