@gooddata/sdk-backend-spi - npm Package Compare versions

Comparing version 8.0.0-alpha.62 to 8.0.0-alpha.63

dist/index.d.ts

@@ -22,3 +22,3 @@ export { IAnalyticalBackend, BackendCapabilities, AnalyticalBackendConfig, AnalyticalBackendFactory, prepareExecution, } from "./backend";
 export { IDashboard, IDashboardDefinition, IDateFilterConfig, IListedDashboard, } from "./workspace/dashboards/dashboard";
-export { IFilterContext, AbsoluteType, DateFilterType, FilterContextItem, IAttributeFilter, IDateFilter, IFilterContextDefinition, RelativeType, } from "./workspace/dashboards/filterContext";
+export { IFilterContext, AbsoluteType, DateFilterType, FilterContextItem, IDashboardAttributeFilter, IDashboardDateFilter, IFilterContextDefinition, RelativeType, } from "./workspace/dashboards/filterContext";
 export { Layout, LayoutContent, ILayoutWidget, IFluidLayout, IFluidLayoutColSize, IFluidLayoutColumn, IFluidLayoutRow, IFluidLayoutSize, ISectionDescription, ISectionHeader, SectionHeader, Widget, } from "./workspace/dashboards/layout";
@@ -25,0 +25,0 @@ export { IWidget, IWidgetDefinition, WidgetType } from "./workspace/dashboards/widget";

dist/workspace/dashboards/filterContext.d.ts

@@ -22,3 +22,3 @@ import { ObjRef } from "@gooddata/sdk-model";
  */
-export interface IAttributeFilter {
+export interface IDashboardAttributeFilter {
     attributeFilter: {
@@ -43,3 +43,3 @@ /**
  */
-export interface IDateFilter {
+export interface IDashboardDateFilter {
     dateFilter: {
@@ -76,3 +76,3 @@ /**
  */
-export declare type FilterContextItem = IAttributeFilter | IDateFilter;
+export declare type FilterContextItem = IDashboardAttributeFilter | IDashboardDateFilter;
 /**
@@ -79,0 +79,0 @@ * Filter context consists of configured attribute and date filters

dist/workspace/insights/index.d.ts

@@ -1,2 +0,2 @@
-import { IVisualizationClass, IInsight, IInsightDefinition, ObjRef } from "@gooddata/sdk-model";
+import { IVisualizationClass, IInsight, IInsightDefinition, ObjRef, IMetadataObject, ObjectType } from "@gooddata/sdk-model";
 import { IPagedResource } from "../../common/paging";
@@ -58,2 +58,9 @@ /**
     deleteInsight(ref: ObjRef): Promise<void>;
+    /**
+     * Get all metadata objects referenced by a given insight.
+     *
+     * @param insight - insight to get referenced objects for
+     * @param types - optional array of object types to include
+     */
+    getReferencedObjects(insight: IInsight, types?: Array<Exclude<ObjectType, "insight" | "tag">>): Promise<IMetadataObject[]>;
 }
@@ -60,0 +67,0 @@ /**

package.json

 {
 	"name": "@gooddata/sdk-backend-spi",
-	"version": "8.0.0-alpha.62",
+	"version": "8.0.0-alpha.63",
 	"author": "GoodData",
@@ -36,3 +36,3 @@ "description": "GoodData Backend SPI abstraction interfaces",
 	"dependencies": {
-		"@gooddata/sdk-model": "^8.0.0-alpha.62",
+		"@gooddata/sdk-model": "^8.0.0-alpha.63",
 		"lodash": "^4.17.15",
@@ -39,0 +39,0 @@ "spark-md5": "^3.0.0",

src/index.ts

@@ -131,4 +131,4 @@ // (C) 2019-2020 GoodData Corporation
     FilterContextItem,
-    IAttributeFilter,
-    IDateFilter,
+    IDashboardAttributeFilter,
+    IDashboardDateFilter,
     IFilterContextDefinition,
@@ -135,0 +135,0 @@ RelativeType,

src/workspace/dashboards/filterContext.ts

@@ -27,3 +27,3 @@ // (C) 2019-2020 GoodData Corporation
  */
-export interface IAttributeFilter {
+export interface IDashboardAttributeFilter {
     attributeFilter: {
@@ -51,3 +51,3 @@ /**
  */
-export interface IDateFilter {
+export interface IDashboardDateFilter {
     dateFilter: {
@@ -90,3 +90,3 @@ /**
  */
-export type FilterContextItem = IAttributeFilter | IDateFilter;
+export type FilterContextItem = IDashboardAttributeFilter | IDashboardDateFilter;
 
@@ -93,0 +93,0 @@ /**

src/workspace/insights/index.ts

 // (C) 2019-2020 GoodData Corporation
 
-import { IVisualizationClass, IInsight, IInsightDefinition, ObjRef } from "@gooddata/sdk-model";
+import {
+    IVisualizationClass,
+    IInsight,
+    IInsightDefinition,
+    ObjRef,
+    IMetadataObject,
+    ObjectType,
+} from "@gooddata/sdk-model";
 import { IPagedResource } from "../../common/paging";
@@ -67,2 +74,13 @@
     deleteInsight(ref: ObjRef): Promise<void>;
+
+    /**
+     * Get all metadata objects referenced by a given insight.
+     *
+     * @param insight - insight to get referenced objects for
+     * @param types - optional array of object types to include
+     */
+    getReferencedObjects(
+        insight: IInsight,
+        types?: Array<Exclude<ObjectType, "insight" | "tag">>,
+    ): Promise<IMetadataObject[]>;
 }
@@ -69,0 +87,0 @@

No alert changes

Improved metrics

Total package byte prevSize

289943

0.46%

Lines of code

9174

0.35%

Dependency changes

• Updated

  @gooddata/sdk-model@^8.0.0-alpha.63