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

Comparing version 8.0.0-alpha.3 to 8.0.0-alpha.4

dist/sdk-backend-spi.d.ts

@@ -25,2 +25,3 @@ import { AttributeOrMeasure } from '@gooddata/sdk-model';
 import { IWorkspace } from '@gooddata/sdk-model';
+import { ObjRef } from '@gooddata/sdk-model';
 import { SortDirection } from '@gooddata/sdk-model';
@@ -741,6 +742,5 @@ import { SortItem } from '@gooddata/sdk-model';
      * Creates query for valid elements of display form with the provided identifier.
-     * TODO: SDK8: rename to forDisplayForm
-     * @param identifier - display form identifier
+     * @param ref - display form ref
      */
-    forObject(identifier: string): IElementQuery;
+    forDisplayForm(ref: ObjRef): IElementQuery;
 }
@@ -1373,20 +1373,20 @@
 export declare interface IWorkspaceMetadata {
-    getVisualizationClass(id: string): Promise<IVisualizationClass>;
+    getVisualizationClass(ref: ObjRef): Promise<IVisualizationClass>;
     getVisualizationClasses(): Promise<IVisualizationClass[]>;
-    getInsight(id: string): Promise<IInsight>;
+    getInsight(ref: ObjRef): Promise<IInsight>;
     getInsights(options?: IInsightQueryOptions): Promise<IInsightQueryResult>;
     createInsight(insight: IInsightDefinition): Promise<IInsight>;
     updateInsight(insight: IInsight): Promise<IInsight>;
-    deleteInsight(id: string): Promise<void>;
+    deleteInsight(ref: ObjRef): Promise<void>;
     /**
      * Gets the attribute display form with the provided identifier.
-     * @param id - identifier of the attribute display form to retrieve
+     * @param ref - ref of the attribute display form to retrieve
      * @public
      */
-    getAttributeDisplayForm(id: string): Promise<IAttributeDisplayForm>;
+    getAttributeDisplayForm(ref: ObjRef): Promise<IAttributeDisplayForm>;
     /**
      * Get measure expression tokens for provided measure identifier
-     * @param id - identifier of the measure
+     * @param ref - ref of the measure
      */
-    getMeasureExpressionTokens(id: string): Promise<IMeasureExpressionToken[]>;
+    getMeasureExpressionTokens(ref: ObjRef): Promise<IMeasureExpressionToken[]>;
 }
@@ -1421,2 +1421,7 @@
     /**
+     * Sets a text to search
+     * @param search - text to search
+     */
+    withSearch(search: string): IWorkspaceQuery;
+    /**
      * Executes the query and returns the result asynchronously.
@@ -1454,2 +1459,3 @@ */
 export declare interface IWorkspaceQueryResult extends IPagedResource<IWorkspace> {
+    search: string | undefined;
 }
@@ -1456,0 +1462,0 @@

dist/workspace/elements/index.d.ts

@@ -1,2 +0,2 @@
-import { SortDirection, IAttributeElement } from "@gooddata/sdk-model";
+import { SortDirection, IAttributeElement, ObjRef } from "@gooddata/sdk-model";
 import { IPagedResource } from "../../common/paging";
@@ -24,6 +24,5 @@ /**
      * Creates query for valid elements of display form with the provided identifier.
-     * TODO: SDK8: rename to forDisplayForm
-     * @param identifier - display form identifier
+     * @param ref - display form ref
      */
-    forObject(identifier: string): IElementQuery;
+    forDisplayForm(ref: ObjRef): IElementQuery;
 }
@@ -30,0 +29,0 @@ /**

dist/workspace/index.d.ts

@@ -42,2 +42,7 @@ import { IWorkspace } from "@gooddata/sdk-model";
     /**
+     * Sets a text to search
+     * @param search - text to search
+     */
+    withSearch(search: string): IWorkspaceQuery;
+    /**
      * Executes the query and returns the result asynchronously.
@@ -53,2 +58,3 @@ */
 export interface IWorkspaceQueryResult extends IPagedResource<IWorkspace> {
+    search: string | undefined;
 }

dist/workspace/insights/index.d.ts

@@ -1,2 +0,2 @@
-import { IVisualizationClass, IInsight, IAttributeDisplayForm, IMeasureExpressionToken, IInsightDefinition } from "@gooddata/sdk-model";
+import { IVisualizationClass, IInsight, IAttributeDisplayForm, IMeasureExpressionToken, IInsightDefinition, ObjRef } from "@gooddata/sdk-model";
 import { IPagedResource } from "../../common/paging";
@@ -9,20 +9,20 @@ /**
 export interface IWorkspaceMetadata {
-    getVisualizationClass(id: string): Promise<IVisualizationClass>;
+    getVisualizationClass(ref: ObjRef): Promise<IVisualizationClass>;
     getVisualizationClasses(): Promise<IVisualizationClass[]>;
-    getInsight(id: string): Promise<IInsight>;
+    getInsight(ref: ObjRef): Promise<IInsight>;
     getInsights(options?: IInsightQueryOptions): Promise<IInsightQueryResult>;
     createInsight(insight: IInsightDefinition): Promise<IInsight>;
     updateInsight(insight: IInsight): Promise<IInsight>;
-    deleteInsight(id: string): Promise<void>;
+    deleteInsight(ref: ObjRef): Promise<void>;
     /**
      * Gets the attribute display form with the provided identifier.
-     * @param id - identifier of the attribute display form to retrieve
+     * @param ref - ref of the attribute display form to retrieve
      * @public
      */
-    getAttributeDisplayForm(id: string): Promise<IAttributeDisplayForm>;
+    getAttributeDisplayForm(ref: ObjRef): Promise<IAttributeDisplayForm>;
     /**
      * Get measure expression tokens for provided measure identifier
-     * @param id - identifier of the measure
+     * @param ref - ref of the measure
      */
-    getMeasureExpressionTokens(id: string): Promise<IMeasureExpressionToken[]>;
+    getMeasureExpressionTokens(ref: ObjRef): Promise<IMeasureExpressionToken[]>;
 }
@@ -29,0 +29,0 @@ /**

package.json

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

src/workspace/elements/index.ts

@@ -1,3 +0,3 @@
-// (C) 2019 GoodData Corporation
-import { SortDirection, IAttributeElement } from "@gooddata/sdk-model";
+// (C) 2019-2020 GoodData Corporation
+import { SortDirection, IAttributeElement, ObjRef } from "@gooddata/sdk-model";
 import { IPagedResource } from "../../common/paging";
@@ -29,6 +29,5 @@
      * Creates query for valid elements of display form with the provided identifier.
-     * TODO: SDK8: rename to forDisplayForm
-     * @param identifier - display form identifier
+     * @param ref - display form ref
      */
-    forObject(identifier: string): IElementQuery;
+    forDisplayForm(ref: ObjRef): IElementQuery;
 }
@@ -35,0 +34,0 @@

src/workspace/index.ts

@@ -1,2 +0,2 @@
-// (C) 2019 GoodData Corporation
+// (C) 2019-2020 GoodData Corporation
 import { IWorkspace } from "@gooddata/sdk-model";
@@ -48,2 +48,8 @@ import { IPagedResource } from "../common/paging";
     /**
+     * Sets a text to search
+     * @param search - text to search
+     */
+    withSearch(search: string): IWorkspaceQuery;
+
+    /**
      * Executes the query and returns the result asynchronously.
@@ -59,2 +65,4 @@ */
  */
-export interface IWorkspaceQueryResult extends IPagedResource<IWorkspace> {}
+export interface IWorkspaceQueryResult extends IPagedResource<IWorkspace> {
+    search: string | undefined;
+}

src/workspace/insights/index.ts

@@ -9,2 +9,3 @@ // (C) 2019-2020 GoodData Corporation
     IInsightDefinition,
+    ObjRef,
 } from "@gooddata/sdk-model";
@@ -19,21 +20,21 @@ import { IPagedResource } from "../../common/paging";
 export interface IWorkspaceMetadata {
-    getVisualizationClass(id: string): Promise<IVisualizationClass>;
+    getVisualizationClass(ref: ObjRef): Promise<IVisualizationClass>;
     getVisualizationClasses(): Promise<IVisualizationClass[]>;
-    getInsight(id: string): Promise<IInsight>;
+    getInsight(ref: ObjRef): Promise<IInsight>;
     getInsights(options?: IInsightQueryOptions): Promise<IInsightQueryResult>;
     createInsight(insight: IInsightDefinition): Promise<IInsight>;
     updateInsight(insight: IInsight): Promise<IInsight>;
-    deleteInsight(id: string): Promise<void>;
+    deleteInsight(ref: ObjRef): Promise<void>;
     /**
      * Gets the attribute display form with the provided identifier.
-     * @param id - identifier of the attribute display form to retrieve
+     * @param ref - ref of the attribute display form to retrieve
      * @public
      */
-    getAttributeDisplayForm(id: string): Promise<IAttributeDisplayForm>;
+    getAttributeDisplayForm(ref: ObjRef): Promise<IAttributeDisplayForm>;
 
     /**
      * Get measure expression tokens for provided measure identifier
-     * @param id - identifier of the measure
+     * @param ref - ref of the measure
      */
-    getMeasureExpressionTokens(id: string): Promise<IMeasureExpressionToken[]>;
+    getMeasureExpressionTokens(ref: ObjRef): Promise<IMeasureExpressionToken[]>;
 }
@@ -40,0 +41,0 @@

No alert changes

Improved metrics

Total package byte prevSize

236157

increased by0.16%

Lines of code

6211

increased by0.29%

Dependency changes

• Updated@gooddata/sdk-model@^8.0.0-alpha.4