@sisense/sdk-ui-vue 1.33.0 → 2.0.0

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.33.0",
+  "version": "2.0.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -50,12 +50,13 @@
     "build-only": "vite build --mode development",
     "build-only:prod": "vite build",
     "type-check": "vue-tsc --noEmit",
-    "lint": "eslint . --ext .vue,.js,.jsx,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
+    "lint": "eslint . --ext .vue,.js,.jsx,.mjs,.ts,.tsx,.cts,.mts --ignore-path .gitignore --quiet",
+    "lint:fix": "run lint --fix",
     "format": "prettier --write .",
     "format:check": "prettier --check ."
   },
   "dependencies": {
-    "@sisense/sdk-ui-preact": "^1.33.0",
+    "@sisense/sdk-ui-preact": "^2.0.0",
     "deepmerge": "^4.3.1",
     "lodash-es": "^4.17.21",
     "vue": "^3.3.2"
@@ -65,6 +66,7 @@
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^18.14.2",
     "@vitejs/plugin-vue": "^4.0.0",
+    "@vitejs/plugin-vue-jsx": "^4.1.2",
     "@vue/eslint-config-prettier": "^7.1.0",
     "@vue/eslint-config-typescript": "^11.0.2",
     "@vue/tsconfig": "^0.1.3",
@@ -73,7 +75,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.4",
     "typescript": "~4.8.4",
-    "vite": "^4.1.4",
+    "vite": "^4.5.2",
     "vite-plugin-dts": "^2.3.0",
     "vue-tsc": "^1.6.5"
   },

package/dist/packages/sdk-ui-vue/src/components/widgets/dashboard-widget.d.ts

@@ -1,233 +0,0 @@
-/// <reference types="react" />
-import type { PropType } from 'vue';
-import type { DashboardWidgetProps as DashboardWidgetPropsPreact } from '@sisense/sdk-ui-preact';
-/**
- * Props of the {@link @sisense/sdk-ui-vue!DashboardWidget | `DashboardWidget`} component.
- *
- * @deprecated Use {@link @sisense/sdk-ui-vue!WidgetById | `WidgetById`} and {@link @sisense/sdk-ui-vue!WidgetByIdProps | `WidgetByIdProps`} instead
- */
-export interface DashboardWidgetProps extends DashboardWidgetPropsPreact {
-}
-/**
- * The Dashboard Widget component, which is a thin wrapper on the {@link ChartWidget} component,
- * used to render a widget created in the Sisense instance.
- *
- * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
- *
- * @example
- * Here's how you can use the DashboardWidget component in a Vue application:
- * ```vue
- * <template>
- *    <DashboardWidget
- *      widgetOid="64473e07dac1920034bce77f"
- *      dashboardOid="6441e728dac1920034bce737"
- *    />
- * </template>
- *
- * <script setup lang="ts">
- * import { ref } from 'vue';
- * import { DashboardWidget } from '@sisense/sdk-ui-vue';
- *
- * </script>
- * ```
- * @group Fusion Assets
- * @deprecated use the WidgetById component instead
- * @fusionEmbed
- */
-export declare const DashboardWidget: import("vue").DefineComponent<{
-    /** @internal */
-    bottomSlot: PropType<import("react").ReactNode>;
-    /** @internal */
-    contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.dashboardOid}
-     *
-     * @category Widget
-     */
-    dashboardOid: PropType<string>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.description}
-     *
-     * @category Widget
-     */
-    description: PropType<string | undefined>;
-    /** @internal */
-    drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filters}
-     *
-     * @category Data
-     */
-    filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filtersMergeStrategy}
-     *
-     * @category Data
-     */
-    filtersMergeStrategy: PropType<"widgetFirst" | "codeFirst" | "codeOnly" | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlightSelectionDisabled}
-     *
-     * @category Widget
-     */
-    highlightSelectionDisabled: PropType<boolean | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlights}
-     *
-     * @category Data
-     */
-    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.includeDashboardFilters}
-     *
-     * @category Data
-     */
-    includeDashboardFilters: PropType<boolean | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onBeforeRender}
-     *
-     * @category Callbacks
-     */
-    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
-    /** @internal */
-    onContextMenuClose: PropType<(() => void) | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointClick}
-     *
-     * @category Callbacks
-     */
-    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointContextMenu}
-     *
-     * @category Callbacks
-     */
-    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointsSelected}
-     *
-     * @category Callbacks
-     */
-    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.styleOptions}
-     *
-     * @category Widget
-     */
-    styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.title}
-     *
-     * @category Widget
-     */
-    title: PropType<string | undefined>;
-    /** @internal */
-    topSlot: PropType<import("react").ReactNode>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.widgetOid}
-     *
-     * @category Widget
-     */
-    widgetOid: PropType<string>;
-    /** @internal */
-    widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
-}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
-    [key: string]: any;
-}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    /** @internal */
-    bottomSlot: PropType<import("react").ReactNode>;
-    /** @internal */
-    contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.dashboardOid}
-     *
-     * @category Widget
-     */
-    dashboardOid: PropType<string>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.description}
-     *
-     * @category Widget
-     */
-    description: PropType<string | undefined>;
-    /** @internal */
-    drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filters}
-     *
-     * @category Data
-     */
-    filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filtersMergeStrategy}
-     *
-     * @category Data
-     */
-    filtersMergeStrategy: PropType<"widgetFirst" | "codeFirst" | "codeOnly" | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlightSelectionDisabled}
-     *
-     * @category Widget
-     */
-    highlightSelectionDisabled: PropType<boolean | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlights}
-     *
-     * @category Data
-     */
-    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.includeDashboardFilters}
-     *
-     * @category Data
-     */
-    includeDashboardFilters: PropType<boolean | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onBeforeRender}
-     *
-     * @category Callbacks
-     */
-    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
-    /** @internal */
-    onContextMenuClose: PropType<(() => void) | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointClick}
-     *
-     * @category Callbacks
-     */
-    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointContextMenu}
-     *
-     * @category Callbacks
-     */
-    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointsSelected}
-     *
-     * @category Callbacks
-     */
-    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.styleOptions}
-     *
-     * @category Widget
-     */
-    styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.title}
-     *
-     * @category Widget
-     */
-    title: PropType<string | undefined>;
-    /** @internal */
-    topSlot: PropType<import("react").ReactNode>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.widgetOid}
-     *
-     * @category Widget
-     */
-    widgetOid: PropType<string>;
-    /** @internal */
-    widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
-}>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/providers/plugins-provider.d.ts

@@ -1,37 +0,0 @@
-import type { Ref } from 'vue';
-import type { CustomPluginsContext } from '@sisense/sdk-ui-preact';
-/**
- * Gets Plugins context
- *
- * @group Contexts
- */
-export declare const getPluginsContext: () => Ref<{
-    pluginMap: Map<string, import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>> & Omit<Map<string, import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>>, keyof Map<any, any>>;
-    registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>) => void;
-    getPlugin: (pluginType: string) => import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>> | undefined;
-}>;
-/**
- * Creates plugins context connector
- *
- * @group Contexts
- * @internal
- */
-export declare const createPluginsContextConnector: () => {
-    prepareContext(): Promise<{
-        pluginMap: Map<string, import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>> & Omit<Map<string, import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>>, keyof Map<any, any>>;
-        registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>) => void;
-        getPlugin: (pluginType: string) => import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>> | undefined;
-    }>;
-    renderContextProvider: (contextData: CustomPluginsContext<any>, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
-};
-/**
- * Provider for working with plugins fetched from an external environment.
- *
- * Provides methods for registering, retrieving, and interacting with plugins.
- *
- * @internal
- * @group Contexts
- */
-export declare const PluginsProvider: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
-    [key: string]: any;
-}>[] | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/setup-helper.d.ts

@@ -1,31 +0,0 @@
-import { type Slots } from 'vue';
-import { type ContextConnector } from '@sisense/sdk-ui-preact';
-export declare function createDefaultContextConnectors(): (ContextConnector<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload> | ContextConnector<{
-    themeSettings: import("@sisense/sdk-ui-preact").CompleteThemeSettings;
-    skipTracking?: boolean | undefined;
-}> | {
-    prepareContext(): Promise<{
-        pluginMap: Map<string, import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>> & Omit<Map<string, import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>>, keyof Map<any, any>>;
-        registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>) => void;
-        getPlugin: (pluginType: string) => import("@sisense/sdk-ui-preact").PluginComponent<import("@sisense/sdk-ui-preact").PluginComponentProps<import("@sisense/sdk-ui-preact").GenericDataOptions, any>> | undefined;
-    }>;
-    renderContextProvider: (contextData: import("@sisense/sdk-ui-preact").CustomPluginsContext<any>, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
-})[];
-export declare function getRawData<T>(data: T): T;
-export declare function toDeepRaw<T>(data: T): T;
-/**
- * Renders a component without children.
- *
- * @internal
- */
-export declare const setupHelper: <P, C>(component: C, props: P, createContextConnectorsFn?: () => ContextConnector<any>[]) => (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
-    [key: string]: any;
-}>) | null;
-/**
- * Renders a component with children.
- *
- * @internal
- */
-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;
-}>[];