@gooddata/api-client-tiger 11.36.0-alpha.2 → 11.36.0-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,3 @@
1
- export declare const LIB_VERSION = "11.36.0-alpha.2";
1
+ export declare const LIB_VERSION = "11.36.0-alpha.6";
2
2
  export declare const LIB_DESCRIPTION = "API Client for GoodData Cloud and GoodData.CN";
3
3
  export declare const LIB_NAME = "@gooddata/api-client-tiger";
package/esm/__version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  // (C) 2021 GoodData Corporation
2
2
  // DO NOT CHANGE THIS FILE, IT IS RE-GENERATED ON EVERY BUILD
3
- export const LIB_VERSION = "11.36.0-alpha.2";
3
+ export const LIB_VERSION = "11.36.0-alpha.6";
4
4
  export const LIB_DESCRIPTION = "API Client for GoodData Cloud and GoodData.CN";
5
5
  export const LIB_NAME = "@gooddata/api-client-tiger";
@@ -10504,6 +10504,7 @@ export declare interface AiMultipartContent {
10504
10504
  * Ordered multipart content fragments.
10505
10505
  */
10506
10506
  'parts': Array<AiMultipartContentPartsInner>;
10507
+ 'suggestions'?: AiSuggestions | null;
10507
10508
  }
10508
10509
 
10509
10510
  /**
@@ -10879,6 +10880,34 @@ export declare interface AiSkillResponse {
10879
10880
  'examples': Array<string>;
10880
10881
  }
10881
10882
 
10883
+ /**
10884
+ * A quick-reply action button rendered alongside the follow-up question.
10885
+ */
10886
+ export declare interface AiSuggestedAction {
10887
+ /**
10888
+ * Button display text (3-5 words).
10889
+ */
10890
+ 'label': string;
10891
+ /**
10892
+ * Exact message sent when the user clicks this action.
10893
+ */
10894
+ 'query': string;
10895
+ }
10896
+
10897
+ /**
10898
+ * Follow-up suggestions emitted by the assistant alongside its terminal multipart message. Carried on the assistant ``MultipartContent`` so suggestions are persisted in conversation history and stream on the same SSE event as the response that produced them.
10899
+ */
10900
+ export declare interface AiSuggestions {
10901
+ /**
10902
+ * Yes-answerable follow-up question recommending the next step.
10903
+ */
10904
+ 'followUpQuestion': string;
10905
+ /**
10906
+ * Quick-reply action buttons. The first action matches the follow-up question.
10907
+ */
10908
+ 'actions': Array<AiSuggestedAction>;
10909
+ }
10910
+
10882
10911
  declare interface AiSummarizeRequest {
10883
10912
  'visualizations'?: Array<string> | null;
10884
10913
  'filterContext'?: Array<AiSummarizeRequestFilterContextInner> | null;
@@ -11957,6 +11986,7 @@ declare namespace AnalyticalDashboardModelV2 {
11957
11986
  isDashboardTab,
11958
11987
  IDashboardDateFilterConfigItem,
11959
11988
  IDashboardTab,
11989
+ IAnalyticalDashboardCommonProps,
11960
11990
  IAnalyticalDashboard_2 as IAnalyticalDashboard,
11961
11991
  IFilterContext_2 as IFilterContext,
11962
11992
  IFilterContextWithTab,
@@ -11966,6 +11996,14 @@ declare namespace AnalyticalDashboardModelV2 {
11966
11996
  }
11967
11997
  export { AnalyticalDashboardModelV2 }
11968
11998
 
11999
+ declare namespace AnalyticalDashboardModelV3 {
12000
+ export {
12001
+ isAnalyticalDashboard_3 as isAnalyticalDashboard,
12002
+ IAnalyticalDashboard_3 as IAnalyticalDashboard
12003
+ }
12004
+ }
12005
+ export { AnalyticalDashboardModelV3 }
12006
+
11969
12007
  /**
11970
12008
  * AnalyticsModelApi - object-oriented interface
11971
12009
  * @export
@@ -61193,7 +61231,7 @@ declare interface IAnalyticalDashboard {
61193
61231
  /**
61194
61232
  * @public
61195
61233
  */
61196
- declare interface IAnalyticalDashboard_2 {
61234
+ declare interface IAnalyticalDashboard_2 extends IAnalyticalDashboardCommonProps {
61197
61235
  version: "2";
61198
61236
  layout?: ITigerDashboardLayout;
61199
61237
  filterContextRef?: ObjRef;
@@ -61207,13 +61245,6 @@ declare interface IAnalyticalDashboard_2 {
61207
61245
  * @alpha
61208
61246
  */
61209
61247
  parameters?: ITigerDashboardParameter[];
61210
- plugins?: IDashboardPluginLink[];
61211
- disableCrossFiltering?: boolean;
61212
- disableUserFilterReset?: boolean;
61213
- disableUserFilterSave?: boolean;
61214
- disableFilterViews?: boolean;
61215
- evaluationFrequency?: string;
61216
- sectionHeadersDateDataSet?: ObjRef;
61217
61248
  /**
61218
61249
  * Optional tabs configuration; when defined, the dashboard renders as a tabbed interface.
61219
61250
  * Each tab has its own layout, filter context and filter configs.
@@ -61223,6 +61254,36 @@ declare interface IAnalyticalDashboard_2 {
61223
61254
  tabs?: ITigerDashboardTab[];
61224
61255
  }
61225
61256
 
61257
+ /**
61258
+ * V3 analytical dashboard. Tabs are the sole source of layout, filter context and filter
61259
+ * configurations — root-level `layout`, `dateFilterConfig`, `dateFilterConfigs`,
61260
+ * `attributeFilterConfigs`, `measureValueFilterConfigs` and `parameters` are intentionally
61261
+ * absent. Use V2 if backward compatibility with older SDK readers is required.
61262
+ *
61263
+ * @alpha
61264
+ */
61265
+ declare interface IAnalyticalDashboard_3 extends IAnalyticalDashboardCommonProps {
61266
+ version: "3";
61267
+ tabs: ITigerDashboardTab[];
61268
+ }
61269
+
61270
+ /**
61271
+ * Common analytical-dashboard properties shared across V2 and V3 model versions —
61272
+ * plugins, dashboard-level toggles, evaluation frequency, and the section-headers
61273
+ * date dataset. Version-specific shapes extend this interface.
61274
+ *
61275
+ * @public
61276
+ */
61277
+ declare interface IAnalyticalDashboardCommonProps {
61278
+ plugins?: IDashboardPluginLink[];
61279
+ disableCrossFiltering?: boolean;
61280
+ disableUserFilterReset?: boolean;
61281
+ disableUserFilterSave?: boolean;
61282
+ disableFilterViews?: boolean;
61283
+ evaluationFrequency?: string;
61284
+ sectionHeadersDateDataSet?: ObjRef;
61285
+ }
61286
+
61226
61287
  /**
61227
61288
  * Attribute format used in executions
61228
61289
  *
@@ -62285,6 +62346,12 @@ declare interface IFilterContext_2 {
62285
62346
  */
62286
62347
  declare interface IFilterContextWithTab extends IFilterContext_2 {
62287
62348
  tabLocalIdentifier?: string;
62349
+ /**
62350
+ * Dashboard parameter overrides captured alongside the filter context.
62351
+ *
62352
+ * @alpha
62353
+ */
62354
+ parameters?: ITigerDashboardParameter[];
62288
62355
  }
62289
62356
 
62290
62357
  export declare interface ILiveFeatures {
@@ -62845,6 +62912,11 @@ declare function isAnalyticalDashboard(dashboard: unknown): dashboard is IAnalyt
62845
62912
  */
62846
62913
  declare function isAnalyticalDashboard_2(dashboard: unknown): dashboard is IAnalyticalDashboard_2;
62847
62914
 
62915
+ /**
62916
+ * @alpha
62917
+ */
62918
+ declare function isAnalyticalDashboard_3(dashboard: unknown): dashboard is IAnalyticalDashboard_3;
62919
+
62848
62920
  /**
62849
62921
  * @public
62850
62922
  */
@@ -16,10 +16,26 @@ export interface IDashboardDateFilterConfigItem {
16
16
  * @public
17
17
  */
18
18
  export type IDashboardTab = ITigerDashboardTab;
19
+ /**
20
+ * Common analytical-dashboard properties shared across V2 and V3 model versions —
21
+ * plugins, dashboard-level toggles, evaluation frequency, and the section-headers
22
+ * date dataset. Version-specific shapes extend this interface.
23
+ *
24
+ * @public
25
+ */
26
+ export interface IAnalyticalDashboardCommonProps {
27
+ plugins?: IDashboardPluginLink[];
28
+ disableCrossFiltering?: boolean;
29
+ disableUserFilterReset?: boolean;
30
+ disableUserFilterSave?: boolean;
31
+ disableFilterViews?: boolean;
32
+ evaluationFrequency?: string;
33
+ sectionHeadersDateDataSet?: ObjRef;
34
+ }
19
35
  /**
20
36
  * @public
21
37
  */
22
- export interface IAnalyticalDashboard {
38
+ export interface IAnalyticalDashboard extends IAnalyticalDashboardCommonProps {
23
39
  version: "2";
24
40
  layout?: ITigerDashboardLayout;
25
41
  filterContextRef?: ObjRef;
@@ -33,13 +49,6 @@ export interface IAnalyticalDashboard {
33
49
  * @alpha
34
50
  */
35
51
  parameters?: ITigerDashboardParameter[];
36
- plugins?: IDashboardPluginLink[];
37
- disableCrossFiltering?: boolean;
38
- disableUserFilterReset?: boolean;
39
- disableUserFilterSave?: boolean;
40
- disableFilterViews?: boolean;
41
- evaluationFrequency?: string;
42
- sectionHeadersDateDataSet?: ObjRef;
43
52
  /**
44
53
  * Optional tabs configuration; when defined, the dashboard renders as a tabbed interface.
45
54
  * Each tab has its own layout, filter context and filter configs.
@@ -60,6 +69,12 @@ export interface IFilterContext {
60
69
  */
61
70
  export interface IFilterContextWithTab extends IFilterContext {
62
71
  tabLocalIdentifier?: string;
72
+ /**
73
+ * Dashboard parameter overrides captured alongside the filter context.
74
+ *
75
+ * @alpha
76
+ */
77
+ parameters?: ITigerDashboardParameter[];
63
78
  }
64
79
  /**
65
80
  * @public
@@ -0,0 +1,18 @@
1
+ import { type IAnalyticalDashboardCommonProps } from "./AnalyticalDashboardModelV2.js";
2
+ import { type ITigerDashboardTab } from "./TigerTypes.js";
3
+ /**
4
+ * V3 analytical dashboard. Tabs are the sole source of layout, filter context and filter
5
+ * configurations — root-level `layout`, `dateFilterConfig`, `dateFilterConfigs`,
6
+ * `attributeFilterConfigs`, `measureValueFilterConfigs` and `parameters` are intentionally
7
+ * absent. Use V2 if backward compatibility with older SDK readers is required.
8
+ *
9
+ * @alpha
10
+ */
11
+ export interface IAnalyticalDashboard extends IAnalyticalDashboardCommonProps {
12
+ version: "3";
13
+ tabs: ITigerDashboardTab[];
14
+ }
15
+ /**
16
+ * @alpha
17
+ */
18
+ export declare function isAnalyticalDashboard(dashboard: unknown): dashboard is IAnalyticalDashboard;
@@ -0,0 +1,8 @@
1
+ // (C) 2020-2026 GoodData Corporation
2
+ import { isEmpty } from "lodash-es";
3
+ /**
4
+ * @alpha
5
+ */
6
+ export function isAnalyticalDashboard(dashboard) {
7
+ return !isEmpty(dashboard) && dashboard.version === "3";
8
+ }
@@ -1,5 +1,6 @@
1
1
  import * as AnalyticalDashboardModelV1 from "./AnalyticalDashboardModelV1.js";
2
2
  import * as AnalyticalDashboardModelV2 from "./AnalyticalDashboardModelV2.js";
3
+ import * as AnalyticalDashboardModelV3 from "./AnalyticalDashboardModelV3.js";
3
4
  import * as VisualizationObjectModelV1 from "./VisualizationObjectModelV1.js";
4
5
  import * as VisualizationObjectModelV2 from "./VisualizationObjectModelV2.js";
5
6
  /**
@@ -10,6 +11,10 @@ export { AnalyticalDashboardModelV1 };
10
11
  * @public
11
12
  */
12
13
  export { AnalyticalDashboardModelV2 };
14
+ /**
15
+ * @alpha
16
+ */
17
+ export { AnalyticalDashboardModelV3 };
13
18
  /**
14
19
  * @public
15
20
  */
@@ -1,6 +1,7 @@
1
1
  // (C) 2007-2026 GoodData Corporation
2
2
  import * as AnalyticalDashboardModelV1 from "./AnalyticalDashboardModelV1.js";
3
3
  import * as AnalyticalDashboardModelV2 from "./AnalyticalDashboardModelV2.js";
4
+ import * as AnalyticalDashboardModelV3 from "./AnalyticalDashboardModelV3.js";
4
5
  import * as VisualizationObjectModelV1 from "./VisualizationObjectModelV1.js";
5
6
  import * as VisualizationObjectModelV2 from "./VisualizationObjectModelV2.js";
6
7
  /**
@@ -13,6 +14,11 @@ export { AnalyticalDashboardModelV1 };
13
14
  */
14
15
  // oxlint-disable-next-line no-barrel-files/no-barrel-files
15
16
  export { AnalyticalDashboardModelV2 };
17
+ /**
18
+ * @alpha
19
+ */
20
+ // oxlint-disable-next-line no-barrel-files/no-barrel-files
21
+ export { AnalyticalDashboardModelV3 };
16
22
  /**
17
23
  * @public
18
24
  */
@@ -645,6 +645,7 @@ export interface AiMultipartContent {
645
645
  * Ordered multipart content fragments.
646
646
  */
647
647
  'parts': Array<AiMultipartContentPartsInner>;
648
+ 'suggestions'?: AiSuggestions | null;
648
649
  }
649
650
  export type AiMultipartContentTypeEnum = 'multipart';
650
651
  /**
@@ -963,6 +964,32 @@ export interface AiSkillResponse {
963
964
  'tags': Array<string>;
964
965
  'examples': Array<string>;
965
966
  }
967
+ /**
968
+ * A quick-reply action button rendered alongside the follow-up question.
969
+ */
970
+ export interface AiSuggestedAction {
971
+ /**
972
+ * Button display text (3-5 words).
973
+ */
974
+ 'label': string;
975
+ /**
976
+ * Exact message sent when the user clicks this action.
977
+ */
978
+ 'query': string;
979
+ }
980
+ /**
981
+ * Follow-up suggestions emitted by the assistant alongside its terminal multipart message. Carried on the assistant ``MultipartContent`` so suggestions are persisted in conversation history and stream on the same SSE event as the response that produced them.
982
+ */
983
+ export interface AiSuggestions {
984
+ /**
985
+ * Yes-answerable follow-up question recommending the next step.
986
+ */
987
+ 'followUpQuestion': string;
988
+ /**
989
+ * Quick-reply action buttons. The first action matches the follow-up question.
990
+ */
991
+ 'actions': Array<AiSuggestedAction>;
992
+ }
966
993
  export interface AiSummarizeRequest {
967
994
  'visualizations'?: Array<string> | null;
968
995
  'filterContext'?: Array<AiSummarizeRequestFilterContextInner> | null;
package/esm/index.d.ts CHANGED
@@ -40,7 +40,7 @@ export { BaseAPI as AiBaseAPI, type RequestArgs as AiRequestArgs } from "./gener
40
40
  export { tigerGenAIClientFactory } from "./genAI.js";
41
41
  export * from "./endpoints/genAI/index.js";
42
42
  export type { Configuration as AiConfiguration, ConfigurationParameters as AiConfigurationParameters, } from "./generated/ai-json-api/configuration.js";
43
- export { VisualizationObjectModelV1, VisualizationObjectModelV2, AnalyticalDashboardModelV1, AnalyticalDashboardModelV2, } from "./gd-tiger-model/index.js";
43
+ export { VisualizationObjectModelV1, VisualizationObjectModelV2, AnalyticalDashboardModelV1, AnalyticalDashboardModelV2, AnalyticalDashboardModelV3, } from "./gd-tiger-model/index.js";
44
44
  export type { ITigerAttribute, ITigerAttributeFilterConfig, ITigerAttributeFilterConfigs, ITigerAttributeLocatorItem, ITigerAttributeOrMeasure, ITigerAttributeSortItem, ITigerBucket, ITigerComparisonCondition, ITigerComparisonConditionInCompound, ITigerCompoundCondition, ITigerDashboardArbitraryAttributeFilter, ITigerDashboardAttributeFilterConfig, ITigerDashboardDateFilterConfig, ITigerDashboardMatchAttributeFilter, ITigerDashboardMeasureValueFilter, ITigerDashboardMeasureValueFilterConfig, ITigerDashboardFilterGroupsConfig, ITigerDashboardLayout, ITigerDashboardParameter, ITigerDashboardTab, ITigerFilter, ITigerFilterContextItem, ITigerInsightLayerDefinition, ITigerInsightParameterValue, ITigerMeasure, ITigerSimpleMeasure, ITigerSimpleMeasureDefinition, ITigerArithmeticMeasure, ITigerArithmeticMeasureDefinition, ITigerPopMeasure, ITigerPopMeasureDefinition, ITigerPreviousPeriodMeasure, ITigerPreviousPeriodMeasureDefinition, ITigerTotal, ITigerAbsoluteDateFilter, ITigerRelativeDateFilter, ITigerPositiveAttributeFilter, ITigerNegativeAttributeFilter, ITigerRankingFilter, ITigerMeasureSortItem, ITigerWidget, ITigerDashboardLayoutSection, ITigerDashboardFilterGroup, ITigerDashboardAttributeFilterParent, ITigerDashboardAttributeFilterByDate, ITigerAttributeElements, ITigerLocatorItem, ITigerInsightWidget, ITigerKpiWidget, ITigerRichTextWidget, ITigerDashboardLayoutSectionHeader, ITigerDashboardLayoutColumn, ITigerAttributeElementsByRef, ITigerAttributeElementsByValue, ITigerMeasureLocatorItem, ITigerTotalLocatorItem, ITigerBaseWidget, ITigerDashboardLayoutSize, ITigerDashboardLayoutSizeByScreenSize, ITigerDashboardLayoutItem, ITigerMeasureValueFilter, ITigerMeasureValueFilterCondition, ITigerRangeCondition, ITigerRangeConditionInCompound, ITigerSortItem, ITigerVisualizationProperties, } from "./gd-tiger-model/TigerTypes.js";
45
45
  export { isAttributeHeader, isAfmObjectIdentifier, isAfmObjectLocalIdentifier, isResultAttributeHeader, isResultMeasureHeader, isResultTotalHeader, isVisualizationObjectsItem, isFilterContextData, isTigerFilterContextItem, isTigerFilterContextItems, isTigerFilter, isTigerFilters, isDashboardPluginsItem, isDataSetItem, isLabelItem, isAttributeItem, isMetricItem, isFactItem, } from "./gd-tiger-model/typeGuards.js";
46
46
  export { newAxios, setAxiosAuthorizationToken, setGlobalAuthorizationToken };
package/esm/index.js CHANGED
@@ -55,7 +55,7 @@ export * from "./endpoints/genAI/index.js";
55
55
  // -----------------------------------------------------------------------------
56
56
  // GD Tiger Model
57
57
  // -----------------------------------------------------------------------------
58
- export { VisualizationObjectModelV1, VisualizationObjectModelV2, AnalyticalDashboardModelV1, AnalyticalDashboardModelV2, } from "./gd-tiger-model/index.js";
58
+ export { VisualizationObjectModelV1, VisualizationObjectModelV2, AnalyticalDashboardModelV1, AnalyticalDashboardModelV2, AnalyticalDashboardModelV3, } from "./gd-tiger-model/index.js";
59
59
  export { isAttributeHeader, isAfmObjectIdentifier, isAfmObjectLocalIdentifier, isResultAttributeHeader, isResultMeasureHeader, isResultTotalHeader, isVisualizationObjectsItem, isFilterContextData, isTigerFilterContextItem, isTigerFilterContextItems, isTigerFilter, isTigerFilters, isDashboardPluginsItem, isDataSetItem, isLabelItem, isAttributeItem, isMetricItem, isFactItem, } from "./gd-tiger-model/typeGuards.js";
60
60
  // -----------------------------------------------------------------------------
61
61
  // Axios Utilities
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/api-client-tiger",
3
- "version": "11.36.0-alpha.2",
3
+ "version": "11.36.0-alpha.6",
4
4
  "description": "API Client for GoodData Cloud and GoodData.CN",
5
5
  "license": "MIT",
6
6
  "author": "GoodData",
@@ -42,11 +42,11 @@
42
42
  "./endpoints/smartFunctions": "./esm/endpoints/smartFunctions/index.js"
43
43
  },
44
44
  "dependencies": {
45
- "axios": "^1.9.0",
45
+ "axios": "1.13.5",
46
46
  "axios-cache-interceptor": "^1.8.0",
47
47
  "lodash-es": "^4.17.23",
48
48
  "tslib": "2.8.1",
49
- "@gooddata/sdk-model": "11.36.0-alpha.2"
49
+ "@gooddata/sdk-model": "11.36.0-alpha.6"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@microsoft/api-documenter": "^7.17.0",
@@ -56,7 +56,7 @@
56
56
  "@typescript-eslint/eslint-plugin": "8.58.0",
57
57
  "@typescript-eslint/parser": "8.58.0",
58
58
  "@typescript/native-preview": "7.0.0-dev.20260202.1",
59
- "commander": "^8.1.0",
59
+ "commander": "8.3.0",
60
60
  "dependency-cruiser": "17.3.10",
61
61
  "dotenv": "16.4.5",
62
62
  "eslint": "^9.39.2",
@@ -75,8 +75,8 @@
75
75
  "oxlint-tsgolint": "0.11.4",
76
76
  "typescript": "5.9.3",
77
77
  "vitest": "4.1.0",
78
- "@gooddata/eslint-config": "11.36.0-alpha.2",
79
- "@gooddata/oxlint-config": "11.36.0-alpha.2"
78
+ "@gooddata/eslint-config": "11.36.0-alpha.6",
79
+ "@gooddata/oxlint-config": "11.36.0-alpha.6"
80
80
  },
81
81
  "scripts": {
82
82
  "_phase:build": "npm run build",