@gooddata/sdk-ui-dashboard 10.15.0-alpha.6 → 10.15.0-alpha.8

package/esm/sdk-ui-dashboard.d.ts

@@ -128,7 +128,6 @@ import { DrillState as DrillState_2 } from './drillState.js';
 import { EntityId } from '@reduxjs/toolkit';
 import { EntityState } from '@reduxjs/toolkit';
 import { ExplicitDrill } from '@gooddata/sdk-ui';
-import { ExtendedDashboardWidget as ExtendedDashboardWidget_2 } from '../../index.js';
 import { FilterContextItem } from '@gooddata/sdk-model';
 import { FilterViewDialogMode as FilterViewDialogMode_2 } from './uiState.js';
 import { GoodDataSdkError } from '@gooddata/sdk-ui';
@@ -7050,13 +7049,23 @@ export declare type ExtendedDashboardItemTypes<T extends ReadonlyArray<ExtendedD
  */
 export declare type ExtendedDashboardLayoutSection = IDashboardLayoutSection<ExtendedDashboardWidget>;
 
+/**
+ * Extension of the default {@link @gooddata/sdk-backend-spi#IDashboardLayoutWidget} type to also include view-only
+ * custom widget types.
+ *
+ * @public
+ */
+export declare interface ExtendedDashboardLayoutWidget extends IDashboardLayout<ExtendedDashboardWidget>, IBaseWidget, IDashboardObjectIdentity {
+    type: "IDashboardLayout";
+}
+
 /**
  * Extension of the default {@link @gooddata/sdk-backend-spi#IWidget} type to also include view-only
  * custom widget types.
  *
  * @public
  */
-export declare type ExtendedDashboardWidget = IWidget | ICustomWidget;
+export declare type ExtendedDashboardWidget = IWidget | ICustomWidget | ExtendedDashboardLayoutWidget;
 
 /**
  * Dumps debug information about a widget into a string.
@@ -7066,6 +7075,13 @@ export declare type ExtendedDashboardWidget = IWidget | ICustomWidget;
  */
 export declare function extendedWidgetDebugStr(widget: ExtendedDashboardWidget): string;
 
+/**
+ * Subset of widget types which support filtering.
+ *
+ * @public
+ */
+export declare type FilterableDashboardWidget = IWidget | ICustomWidget;
+
 /**
  * @internal
  */
@@ -12026,6 +12042,12 @@ export declare function isDrillDownDefinition(obj: unknown): obj is IDrillDownDe
  */
 export declare const isDrillTargetsAdded: (obj: unknown) => obj is DrillTargetsAdded;
 
+/**
+ * Type-guard testing whether the provided object is an instance of {@link ExtendedDashboardLayoutWidget}.
+ * @public
+ */
+export declare function isExtendedDashboardLayoutWidget(obj: unknown): obj is ExtendedDashboardLayoutWidget;
+
 /**
  * @beta
  */
@@ -12383,7 +12405,7 @@ export declare interface IUseCustomWidgetInsightDataViewConfig {
  */
 export declare interface IUseDashboardScheduledEmailsFiltersProps {
     scheduledExportToEdit?: IAutomationMetadataObject;
-    widget?: ExtendedDashboardWidget;
+    widget?: FilterableDashboardWidget;
     insight?: IInsight;
 }
 
@@ -12408,7 +12430,7 @@ export declare interface IUseFiltersForWidgetScheduledExportProps {
     /**
      * Widget to get filters for.
      */
-    widget?: ExtendedDashboardWidget;
+    widget?: FilterableDashboardWidget;
     /**
      * Insight to get filters for.
      */
@@ -13464,7 +13486,7 @@ export declare type OptionalProvider<T> = T extends (...args: infer TArgs) => in
 export declare type OptionalRichTextComponentProvider = OptionalProvider<RichTextComponentProvider>;
 
 /**
- * @public
+ * @alpha
  */
 export declare type OptionalVisualizationSwitcherComponentProvider = OptionalProvider<VisualizationSwitcherComponentProvider>;
 
@@ -15349,7 +15371,7 @@ export declare const selectAllowUnfinishedFeatures: DashboardSelector<boolean>;
 
 /**
  * Selects analytical widget by its ref. This selector will return undefined if the provided
- * widget ref is for a custom widget.
+ * widget ref is not analytical widget, eg. custom widget or nested layout.
  *
  * @remarks
  * To include custom widgets as well, use {@link selectWidgetByRef}.
@@ -19151,7 +19173,7 @@ export declare const useDashboardScheduledEmails: () => {
     automations: IAutomationMetadataObject[];
     automationsCount: number;
     numberOfAvailableDestinations: number;
-    widget: ExtendedDashboardWidget_2 | undefined;
+    widget: IWidget | undefined;
     insight: IInsight | undefined;
     automationsLoading: boolean;
     automationsError: GoodDataSdkError | undefined;
@@ -19580,7 +19602,7 @@ export declare function useWidgetExecutionsHandler(widgetRef: ObjRef): {
  *
  * @public
  */
-export declare function useWidgetFilters(widget: ExtendedDashboardWidget | undefined | null, insight?: IInsightDefinition): QueryProcessingState<IFilter[]>;
+export declare function useWidgetFilters(widget: FilterableDashboardWidget | undefined | null, insight?: IInsightDefinition): QueryProcessingState<IFilter[]>;
 
 /**
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-dashboard",
-  "version": "10.15.0-alpha.6",
+  "version": "10.15.0-alpha.8",
   "description": "GoodData SDK - Dashboard Component",
   "repository": {
     "type": "git",
@@ -57,17 +57,17 @@
     "ts-invariant": "^0.7.5",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2",
-    "@gooddata/sdk-backend-base": "10.15.0-alpha.6",
-    "@gooddata/sdk-model": "10.15.0-alpha.6",
-    "@gooddata/sdk-backend-spi": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui-filters": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui-ext": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui-kit": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui-geo": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui-vis-commons": "10.15.0-alpha.6",
-    "@gooddata/sdk-ui-theme-provider": "10.15.0-alpha.6",
-    "@gooddata/util": "10.15.0-alpha.6"
+    "@gooddata/sdk-backend-base": "10.15.0-alpha.8",
+    "@gooddata/sdk-backend-spi": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui": "10.15.0-alpha.8",
+    "@gooddata/sdk-model": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui-ext": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui-filters": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui-geo": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui-kit": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui-theme-provider": "10.15.0-alpha.8",
+    "@gooddata/util": "10.15.0-alpha.8",
+    "@gooddata/sdk-ui-vis-commons": "10.15.0-alpha.8"
   },
   "peerDependencies": {
     "react": "^16.10.0 || ^17.0.0 || ^18.0.0",
@@ -120,9 +120,9 @@
     "typescript": "5.3.3",
     "vitest": "1.0.4",
     "vitest-dom": "0.1.1",
-    "@gooddata/i18n-toolkit": "10.15.0-alpha.6",
-    "@gooddata/reference-workspace": "10.15.0-alpha.6",
-    "@gooddata/sdk-backend-mockingbird": "10.15.0-alpha.6"
+    "@gooddata/i18n-toolkit": "10.15.0-alpha.8",
+    "@gooddata/reference-workspace": "10.15.0-alpha.8",
+    "@gooddata/sdk-backend-mockingbird": "10.15.0-alpha.8"
   },
   "scripts": {
     "clean": "rm -rf ci dist esm coverage *.log styles/css tsconfig.tsbuildinfo",