@sisense/sdk-ui 1.13.0 → 1.14.0

package/dist/api/rest-api.d.ts

@@ -12,31 +12,31 @@ type GetDashboardOptions = {
 };
 export declare class RestApi {
     private httpClient;
-    constructor(httpClient: HttpClient);
+    constructor(httpClient: HttpClient | undefined);
     /**
      * Get all dashboards
      */
-    getDashboards: (options?: GetDashboardsOptions) => Promise<DashboardDto[]>;
+    getDashboards: (options?: GetDashboardsOptions) => Promise<DashboardDto[] | undefined>;
     /**
      * Get a specific dashboard
      */
-    getDashboard: (dashboardOid: string, options?: GetDashboardOptions) => Promise<DashboardDto>;
+    getDashboard: (dashboardOid: string, options?: GetDashboardOptions) => Promise<DashboardDto | undefined>;
     /**
      * Get all widgets of a specific dashboard
      */
-    getDashboardWidgets: (dashboardOid: string) => Promise<WidgetDto[]>;
+    getDashboardWidgets: (dashboardOid: string) => Promise<WidgetDto[] | undefined>;
     /**
      * Get a specific widget from a dashboard
      */
-    getWidget: (widgetOid: string, dashboardOid: string) => Promise<WidgetDto>;
+    getWidget: (widgetOid: string, dashboardOid: string) => Promise<WidgetDto | undefined>;
     /**
      * Get a GeoJSON data for all countries
      */
-    getCountriesGeoJson: () => Promise<GeoJsonFeatureCollection>;
+    getCountriesGeoJson: () => Promise<GeoJsonFeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined>;
     /**
      * Get a GeoJSON data for all USA states
      */
-    getUsaStatesGeoJson: () => Promise<GeoJsonFeatureCollection>;
+    getUsaStatesGeoJson: () => Promise<GeoJsonFeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined>;
 }
 export declare const useGetApi: () => RestApi;
 export {};

package/dist/api/types/dashboard-dto.d.ts

@@ -21,12 +21,14 @@ export type FilterDto = {
     jaql: FilterJaql & AnyObject;
     instanceid?: string;
     disabled?: boolean;
+    locked?: boolean;
 };
 export type CascadingFilterDto = {
     isCascading: true;
     levels: FilterJaql[];
     instanceid?: string;
     disabled?: boolean;
+    locked?: boolean;
 };
 export declare const isCascadingFilterDto: (filter: FilterDto | CascadingFilterDto) => filter is CascadingFilterDto;
 export type DashboardDto = {

package/dist/chart-options-processor/translations/axis-section.d.ts

@@ -101,6 +101,7 @@ export type AxisPlotBand = {
     };
 };
 export declare const getCategoricalCompareValue: (value: CategoricalXValues) => number;
+export declare const getDefaultDateFormat: (granularity?: string) => "HH:mm:ss" | "yyyy" | "yyyy Q" | "MM/yyyy" | "ww yyyy" | "M/d/yy" | "HH" | "M/d/yy HH" | "HH:mm" | undefined;
 export declare const getDateFormatter: (category: Category, dateFormatter?: ((date: Date, format: string) => string) | undefined) => (time: number) => string;
 export declare const getXAxisDatetimeSettings: (axis: Axis, category: Category, values: number[], dateFormatter?: ((date: Date, format: string) => string) | undefined) => AxisSettings[];
 export declare const getXAxisSettings: (axis: Axis, axis2: Axis | undefined, categories: string[], plotBands: PlotBand[], xAxisOrientation: AxisOrientation, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType) => AxisSettings[];

package/dist/chart-options-processor/translations/sunburst/sunburst-series.d.ts

@@ -35,4 +35,6 @@ export declare function prepareSunburstDataItems(chartData: CategoricalChartData
     id?: string | undefined;
     drilldown?: string | undefined;
     parent?: string | undefined;
+    low?: number | null | undefined;
+    high?: number | null | undefined;
 })[];

package/dist/chart-options-processor/translations/translations-to-highcharts.d.ts

@@ -39,6 +39,8 @@ export type SeriesPointStructure = {
     id?: string;
     drilldown?: string;
     parent?: string;
+    low?: number | null;
+    high?: number | null;
 };
 export type AxisClipped = {
     minClipped: boolean;

package/dist/common-filters/types.d.ts

@@ -1,3 +1,4 @@
+import { DeepRequired } from 'ts-essentials';
 /** @internal */
 export declare enum CommonFiltersApplyMode {
     HIGHLIGHT = "highlight",
@@ -11,4 +12,7 @@ export type CommonFiltersOptions = {
         all?: boolean;
         ids?: string[];
     };
+    forceApplyBackgroundFilters?: boolean;
 };
+/** @internal */
+export type CompleteCommonFiltersOptions = DeepRequired<CommonFiltersOptions>;

package/dist/common-filters/utils.d.ts

@@ -6,4 +6,4 @@ export declare function getFilterByAttribute(filters: Filter[], attribute: Attri
 export declare function createCommonFilter(attribute: Attribute, members: (string | number)[], existingCommonFilters: Filter[]): Filter;
 export declare function isEqualMembersFilters(filterA: Filter, filterB: Filter): boolean;
 export declare function isIncludeAllFilter(filter: Filter): boolean;
-export declare function clearCommonFilter({ attribute, guid }: Filter): Filter;
+export declare function clearCommonFilter(filter: Filter): Filter;

package/dist/dashboard/index.d.ts

@@ -0,0 +1,3 @@
+export { DashboardById } from './dashboard-by-id';
+export { Dashboard } from './dashboard';
+export { type DashboardByIdProps, type DashboardProps } from './types';

package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts

@@ -18,18 +18,8 @@ export declare const fetchWidgetDtoModel: ({ widgetOid, dashboardOid, includeDas
     includeDashboard?: boolean | undefined;
     api: RestApi;
 }) => Promise<{
-    widget: WidgetDto;
-    dashboard: ({
-        oid: string;
-        title: string;
-        datasource: import("./types").Datasource;
-        widgets?: WidgetDto[] | undefined;
-        filters?: (import("../api/types/dashboard-dto").FilterDto | import("../api/types/dashboard-dto").CascadingFilterDto)[] | undefined;
-        filterRelations?: {
-            filterRelations: import("@sisense/sdk-data").FilterRelationsModel;
-        }[] | undefined;
-        layout?: import("../api/types/dashboard-dto").Layout | undefined;
-    } & import("../utils/utility-types").AnyObject) | undefined;
+    widget: WidgetDto | undefined;
+    dashboard: DashboardDto | undefined;
 }>;
 /**
  * Custom hook for fetching Widget DTO and Dashboard DTO models.

package/dist/decorators/hook-decorators/with-tracking.d.ts

@@ -7,7 +7,6 @@ export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig)
  * @param packageName - The name of the package
  * @param app - The client application
  * @param onFinally - The function to call after the tracking is done
- * @returns Promise<void>
  */
-export declare const trackHook: (hookName: string, packageName: string, app: ClientApplication, onFinally: () => void) => Promise<void>;
+export declare const trackHook: (hookName: string, packageName: string, app: ClientApplication, onFinally: () => void) => void;
 export declare const withTracking: HookDecorator<string>;

package/dist/filters/components/cascading-filter-tile/cascading-filter-tile.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { CascadingFilter, Filter } from '@sisense/sdk-data';
+import { CascadingFilter, DataSource, Filter } from '@sisense/sdk-data';
 import { FilterVariant } from '../common/filter-utils.js';
 /**
  * Props for {@link CascadingFilterTile}
@@ -9,6 +9,12 @@ import { FilterVariant } from '../common/filter-utils.js';
 export interface CascadingFilterTileProps {
     /** Cascading filter object to initialize filter type and default values */
     filter: CascadingFilter;
+    /**
+     * Data source the query is run against - e.g. `Sample ECommerce`
+     *
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
+     */
+    dataSource?: DataSource;
     /** Arrangement of the filter inputs. Use vertical for standard filter tiles and horizontal for toolbars */
     arrangement?: FilterVariant;
     /** Callback returning filter object, or null for failure */

package/dist/filters/components/cascading-filter-tile/cascading-level-filter.d.ts

@@ -1,4 +1,4 @@
-import { Filter } from '@sisense/sdk-data';
+import { DataSource, Filter } from '@sisense/sdk-data';
 /**
  * Props of the {@link CascadingLevelFilterTile} component
  *
@@ -7,6 +7,12 @@ import { Filter } from '@sisense/sdk-data';
 export type CascadingLevelFilterTileProps = {
     /** Filter to display */
     filter: Filter;
+    /**
+     * Data source the query is run against - e.g. `Sample ECommerce`
+     *
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
+     */
+    dataSource?: DataSource;
     parentFilters: Filter[];
     /** Callback to handle filter change */
     onChange: (filter: Filter | null) => void;
@@ -18,4 +24,4 @@ export type CascadingLevelFilterTileProps = {
  *
  * @internal
  */
-export declare const CascadingLevelFilterTile: ({ filter, parentFilters, onChange, isLast, }: CascadingLevelFilterTileProps) => import("react/jsx-runtime").JSX.Element;
+export declare const CascadingLevelFilterTile: ({ filter, dataSource, parentFilters, onChange, isLast, }: CascadingLevelFilterTileProps) => import("react/jsx-runtime").JSX.Element;

package/dist/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -18,6 +18,7 @@ export interface CriteriaFilterTileProps {
     measures?: Measure[];
     /**
      * Design options for the filter tile component
+     *
      * @internal
      */
     tileDesignOptions?: FilterTileDesignOptions;

package/dist/filters/components/custom-filter-tile.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { Filter } from '@sisense/sdk-data';
+import { FilterTileDesignOptions } from './filter-tile';
 /**
  * Props for {@link CustomFilterTile}
  *
@@ -14,6 +15,8 @@ export interface CustomFilterTileProps {
      * @param filter - Custom filter
      */
     onUpdate: (filter: Filter | null) => void;
+    /** Design options for the tile @internal */
+    tileDesignOptions?: FilterTileDesignOptions;
 }
 /**
  * UI component for a custom filter defined with JAQL.

package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts

@@ -44,12 +44,14 @@ export interface DateRangeFilterTileProps {
     parentFilters?: Filter[];
     /**
      * Whether to display the filter as a tiled version.
+     *
      * @default false
      * @internal
      */
     tiled?: boolean;
     /**
      * Design options for the filter tile component
+     *
      * @internal
      */
     tileDesignOptions?: FilterTileDesignOptions;

package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-tile.d.ts

@@ -27,6 +27,7 @@ export interface RelativeDateFilterTileProps {
     };
     /**
      * Design options for the filter tile component
+     *
      * @internal
      */
     tileDesignOptions?: FilterTileDesignOptions;

package/dist/filters/components/filter-tile.d.ts

@@ -3,6 +3,7 @@ import { FilterVariant } from './common/filter-utils';
 import { DeepRequired } from 'ts-essentials';
 /**
  * Design options for the filter tile component.
+ *
  * @internal
  */
 export interface FilterTileDesignOptions {
@@ -10,6 +11,7 @@ export interface FilterTileDesignOptions {
         shouldBeShown?: boolean;
         isCollapsible?: boolean;
         hasBorder?: boolean;
+        hasBackgroundFilterIcon?: boolean;
     };
     border?: {
         shouldBeShown?: boolean;
@@ -27,6 +29,7 @@ interface Props {
     isDependent?: boolean;
     design?: FilterTileDesignOptions;
     onToggleDisabled?: () => void;
+    locked?: boolean;
 }
 /**
  * Generic component that owns common functionality of a filter "tile" like

package/dist/filters/components/icons/background-filter-icon.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const BackgroundFilterIcon: import("@emotion/styled").StyledComponent<{
+    theme?: import("@emotion/react").Theme | undefined;
+    as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
+}, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;

package/dist/filters/components/icons/index.d.ts

@@ -3,5 +3,6 @@ export { PencilIcon } from './pencil-icon';
 export { PlusIcon } from './plus-icon';
 export { SearchIcon } from './search-icon';
 export { TrashIcon } from './trash-icon';
+export { LockIcon } from './lock-icon';
 export { DateIcon } from './date-icon';
 export { ArrowDownIcon } from './arrow-down-icon';

package/dist/filters/components/icons/lock-icon.d.ts

@@ -0,0 +1,2 @@
+import type { SVGProps } from 'react';
+export declare const LockIcon: (props: Pick<SVGProps<SVGElement>, 'className' | 'width' | 'height'>) => import("react/jsx-runtime").JSX.Element;