@gooddata/sdk-backend-spi 11.41.0-alpha.2 → 11.41.0-alpha.4

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.
package/esm/index.d.ts CHANGED
@@ -34,7 +34,7 @@ export type { IWorkspacePermissionsService } from "./workspace/permissions/index
34
34
  export type { IWorkspaceAttributesService, IAttributeWithReferences, IAttributesQuery, IAttributesQueryFilterOptions, IAttributesQueryResult, } from "./workspace/attributes/index.js";
35
35
  export type { IWorkspaceMeasuresService, IGetMeasureOptions, IMeasureReferencing, IMeasureKeyDrivers, IMeasuresQueryResult, IMeasuresQuery, } from "./workspace/measures/index.js";
36
36
  export type { IWorkspaceFactsService, IFactsQuery, IFactsQueryResult } from "./workspace/facts/index.js";
37
- export type { IWorkspaceDashboardsService, IGetDashboardOptions, IGetDashboardPluginOptions, IGetScheduledMailOptions, IWidgetAlertCount, SupportedDashboardReferenceTypes, IWidgetReferences, SupportedWidgetReferenceTypes, IDashboardReferences, IDashboardWithReferences, IDashboardsQuery, IDashboardsQueryResult, IRawExportCustomOverride, IRawExportCustomOverrides, IDashboardExportPdfOptions, IDashboardExportRawOptions, IDashboardExportTabularOptions, IDashboardParameterValueOverride, IDashboardExportImageOptions, IDashboardExportPresentationOptions, FiltersByTab, DashboardSummaryWorkflowStatus, IDashboardSummaryWorkflowStartResult, IDashboardSummaryWorkflowStatusResult, } from "./workspace/dashboards/index.js";
37
+ export type { IWorkspaceDashboardsService, IGetDashboardOptions, IGetDashboardPluginOptions, IGetScheduledMailOptions, IWidgetAlertCount, SupportedDashboardReferenceTypes, IWidgetReferences, SupportedWidgetReferenceTypes, IDashboardReferences, IDashboardWithReferences, IDashboardsQuery, IDashboardsQueryResult, IRawExportCustomOverride, IRawExportCustomOverrides, IDashboardExportPdfOptions, IDashboardExportRawOptions, IDashboardExportTabularOptions, IDashboardExportImageOptions, IDashboardExportPresentationOptions, FiltersByTab, DashboardSummaryWorkflowStatus, IDashboardSummaryWorkflowStartResult, IDashboardSummaryWorkflowStatusResult, } from "./workspace/dashboards/index.js";
38
38
  export { type IWidgetWithLayoutPath, type LayoutPath, isDashboardLayoutEmpty, layoutWidgets, layoutWidgetsWithPaths, walkLayout, } from "./workspace/dashboards/utils.js";
39
39
  export type { IWorkspaceUsersQuery, IWorkspaceUsersQueryOptions, IWorkspaceUsersQueryResult, } from "./workspace/users/index.js";
40
40
  export type { IDateFilterConfigsQuery, IDateFilterConfigsQueryResult, } from "./workspace/dateFilterConfigs/index.js";
@@ -52,6 +52,7 @@ import type { IDashboard } from '@gooddata/sdk-model';
52
52
  import type { IDashboardAttributeFilterConfig } from '@gooddata/sdk-model';
53
53
  import type { IDashboardBase } from '@gooddata/sdk-model';
54
54
  import type { IDashboardDefinition } from '@gooddata/sdk-model';
55
+ import type { IDashboardExportParameter } from '@gooddata/sdk-model';
55
56
  import type { IDashboardFilterView } from '@gooddata/sdk-model';
56
57
  import type { IDashboardFilterViewSaveRequest } from '@gooddata/sdk-model';
57
58
  import { IDashboardLayout } from '@gooddata/sdk-model';
@@ -75,6 +76,7 @@ import { IDimensionDescriptor } from '@gooddata/sdk-model';
75
76
  import { IEntitlementDescriptor } from '@gooddata/sdk-model';
76
77
  import { IExecutionConfig } from '@gooddata/sdk-model';
77
78
  import { IExecutionDefinition } from '@gooddata/sdk-model';
79
+ import { IExecutionResultLimitBreak } from '@gooddata/sdk-model';
78
80
  import type { IExistingDashboard } from '@gooddata/sdk-model';
79
81
  import { IExportDefinitionMetadataObject } from '@gooddata/sdk-model';
80
82
  import { IExportDefinitionMetadataObjectDefinition } from '@gooddata/sdk-model';
@@ -1695,7 +1697,7 @@ export declare type IChatConversationItem = {
1695
1697
  responseId: string;
1696
1698
  replyTo?: string;
1697
1699
  createdAt: number;
1698
- role: "user" | "assistant" | "tool";
1700
+ role: "user" | "assistant" | "tool" | "system";
1699
1701
  content: IChatConversationContent;
1700
1702
  feedback?: IChatConversationFeedback;
1701
1703
  };
@@ -2208,6 +2210,12 @@ export declare interface IDashboardExportImageOptions {
2208
2210
  * Filename for the export. If not provided, the dashboard title will be fetched.
2209
2211
  */
2210
2212
  filename?: string;
2213
+ /**
2214
+ * Per-tab parameter runtime-overrides applied when rendering the exported image.
2215
+ * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
2216
+ * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
2217
+ */
2218
+ parametersByTab?: Record<string, IDashboardExportParameter[]>;
2211
2219
  /**
2212
2220
  * Override the default export result polling timeout (in milliseconds).
2213
2221
  *
@@ -2233,6 +2241,11 @@ export declare interface IDashboardExportPdfOptions {
2233
2241
  * Custom export metadata forwarded through the export flow.
2234
2242
  */
2235
2243
  exportMetadata?: Record<string, string>;
2244
+ /**
2245
+ * Per-tab parameter runtime-overrides applied when rendering the exported file. Keyed by tab
2246
+ * `localIdentifier`. Mirrors `dashboardTabsParametersOverrides` on the tabular options.
2247
+ */
2248
+ parametersByTab?: Record<string, IDashboardExportParameter[]>;
2236
2249
  /**
2237
2250
  * Override the default export result polling timeout (in milliseconds).
2238
2251
  *
@@ -2257,6 +2270,12 @@ export declare interface IDashboardExportPresentationOptions {
2257
2270
  hideWidgetTitles?: boolean;
2258
2271
  filename?: string;
2259
2272
  exportMetadata?: Record<string, string>;
2273
+ /**
2274
+ * Per-tab parameter runtime-overrides applied when rendering the exported slides.
2275
+ * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
2276
+ * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
2277
+ */
2278
+ parametersByTab?: Record<string, IDashboardExportParameter[]>;
2260
2279
  /**
2261
2280
  * Override the default export result polling timeout (in milliseconds).
2262
2281
  *
@@ -2327,7 +2346,7 @@ export declare interface IDashboardExportTabularOptions {
2327
2346
  * Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering
2328
2347
  * for that tab's sub-export. Mirrors `dashboardTabsFiltersOverrides`.
2329
2348
  */
2330
- dashboardTabsParametersOverrides?: Record<string, IDashboardParameterValueOverride[]>;
2349
+ dashboardTabsParametersOverrides?: Record<string, IDashboardExportParameter[]>;
2331
2350
  /**
2332
2351
  * PDF-specific configuration options. Only applicable when format is "PDF".
2333
2352
  */
@@ -2347,28 +2366,6 @@ export declare interface IDashboardExportTabularOptions {
2347
2366
  timeout?: number;
2348
2367
  }
2349
2368
 
2350
- /**
2351
- * Backend-neutral parameter value override sent on dashboard tabular export.
2352
- *
2353
- * @alpha
2354
- */
2355
- export declare interface IDashboardParameterValueOverride {
2356
- /**
2357
- * Parameter identifier; drives AFM execution. Matches the workspace catalog parameter's id.
2358
- */
2359
- id: string;
2360
- /**
2361
- * Value to apply for the parameter, encoded as a string (numeric values are stringified).
2362
- * Drives AFM execution.
2363
- */
2364
- value: string;
2365
- /**
2366
- * Display title rendered into the export's info sheet. Presentation-only; not consumed by
2367
- * execution.
2368
- */
2369
- title: string;
2370
- }
2371
-
2372
2369
  /**
2373
2370
  * Dashboard referenced objects
2374
2371
  * @alpha
@@ -3543,6 +3540,10 @@ export declare interface IExecutionResultMetadata {
3543
3540
  * Additional information sent by the underlying data source.
3544
3541
  */
3545
3542
  readonly dataSourceMessages: ReadonlyArray<IExecutionResultDataSourceMessage>;
3543
+ /**
3544
+ * Limits broken during result computation, causing partial data to be returned.
3545
+ */
3546
+ readonly limitBreaks?: ReadonlyArray<IExecutionResultLimitBreak>;
3546
3547
  }
3547
3548
 
3548
3549
  /**
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.55.2"
8
+ "packageVersion": "7.58.7"
9
9
  }
10
10
  ]
11
11
  }
@@ -1,4 +1,4 @@
1
- import type { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFilterConfig, IDashboardBase, IDashboardDefinition, IDashboardFilterView, IDashboardFilterViewSaveRequest, IDashboardObjectIdentity, IDashboardPermissions, IDashboardPlugin, IDashboardPluginDefinition, IDataSetMetadataObject, IDateFilter, IExecutionDefinition, IExistingDashboard, IFilter, IFilterContext, IFilterContextDefinition, IInsight, IListedDashboard, IObjectCertificationWrite, IScheduledMail, IScheduledMailDefinition, IWidget, IWidgetAlert, IWidgetAlertDefinition, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
1
+ import type { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFilterConfig, IDashboardBase, IDashboardDefinition, IDashboardExportParameter, IDashboardFilterView, IDashboardFilterViewSaveRequest, IDashboardObjectIdentity, IDashboardPermissions, IDashboardPlugin, IDashboardPluginDefinition, IDataSetMetadataObject, IDateFilter, IExecutionDefinition, IExistingDashboard, IFilter, IFilterContext, IFilterContextDefinition, IInsight, IListedDashboard, IObjectCertificationWrite, IScheduledMail, IScheduledMailDefinition, IWidget, IWidgetAlert, IWidgetAlertDefinition, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
2
2
  import type { IFilterBaseOptions } from "../../common/filtering.js";
3
3
  import type { IPagedResource } from "../../common/paging.js";
4
4
  import type { QueryMethod } from "../../common/query.js";
@@ -165,27 +165,6 @@ export interface IRawExportCustomOverrides {
165
165
  */
166
166
  displayForms?: Record<string, IRawExportCustomOverride>;
167
167
  }
168
- /**
169
- * Backend-neutral parameter value override sent on dashboard tabular export.
170
- *
171
- * @alpha
172
- */
173
- export interface IDashboardParameterValueOverride {
174
- /**
175
- * Parameter identifier; drives AFM execution. Matches the workspace catalog parameter's id.
176
- */
177
- id: string;
178
- /**
179
- * Value to apply for the parameter, encoded as a string (numeric values are stringified).
180
- * Drives AFM execution.
181
- */
182
- value: string;
183
- /**
184
- * Display title rendered into the export's info sheet. Presentation-only; not consumed by
185
- * execution.
186
- */
187
- title: string;
188
- }
189
168
  /**
190
169
  * Options for exporting dashboard to tabular format.
191
170
  *
@@ -224,7 +203,7 @@ export interface IDashboardExportTabularOptions {
224
203
  * Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering
225
204
  * for that tab's sub-export. Mirrors `dashboardTabsFiltersOverrides`.
226
205
  */
227
- dashboardTabsParametersOverrides?: Record<string, IDashboardParameterValueOverride[]>;
206
+ dashboardTabsParametersOverrides?: Record<string, IDashboardExportParameter[]>;
228
207
  /**
229
208
  * PDF-specific configuration options. Only applicable when format is "PDF".
230
209
  */
@@ -257,6 +236,11 @@ export interface IDashboardExportPdfOptions {
257
236
  * Custom export metadata forwarded through the export flow.
258
237
  */
259
238
  exportMetadata?: Record<string, string>;
239
+ /**
240
+ * Per-tab parameter runtime-overrides applied when rendering the exported file. Keyed by tab
241
+ * `localIdentifier`. Mirrors `dashboardTabsParametersOverrides` on the tabular options.
242
+ */
243
+ parametersByTab?: Record<string, IDashboardExportParameter[]>;
260
244
  /**
261
245
  * Override the default export result polling timeout (in milliseconds).
262
246
  *
@@ -301,6 +285,12 @@ export interface IDashboardExportImageOptions {
301
285
  * Filename for the export. If not provided, the dashboard title will be fetched.
302
286
  */
303
287
  filename?: string;
288
+ /**
289
+ * Per-tab parameter runtime-overrides applied when rendering the exported image.
290
+ * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
291
+ * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
292
+ */
293
+ parametersByTab?: Record<string, IDashboardExportParameter[]>;
304
294
  /**
305
295
  * Override the default export result polling timeout (in milliseconds).
306
296
  *
@@ -324,6 +314,12 @@ export interface IDashboardExportPresentationOptions {
324
314
  hideWidgetTitles?: boolean;
325
315
  filename?: string;
326
316
  exportMetadata?: Record<string, string>;
317
+ /**
318
+ * Per-tab parameter runtime-overrides applied when rendering the exported slides.
319
+ * Keyed by tab `localIdentifier`; a widget-scoped export carries the single owning tab.
320
+ * Mirrors `dashboardTabsParametersOverrides` on the tabular options.
321
+ */
322
+ parametersByTab?: Record<string, IDashboardExportParameter[]>;
327
323
  /**
328
324
  * Override the default export result polling timeout (in milliseconds).
329
325
  *
@@ -1,4 +1,4 @@
1
- import { type DataValue, type DimensionGenerator, type GeoCollectionKind, type IAttributeOrMeasure, type IBucket, type IDimension, type IDimensionDescriptor, type IExecutionConfig, type IExecutionDefinition, type IGeoJsonFeature, type IInsight, type IInsightDefinition, type IMeasureDescriptor, type INullableFilter, type IResultHeader, type IResultWarning, type ISortItem } from "@gooddata/sdk-model";
1
+ import { type DataValue, type DimensionGenerator, type GeoCollectionKind, type IAttributeOrMeasure, type IBucket, type IDimension, type IDimensionDescriptor, type IExecutionConfig, type IExecutionDefinition, type IExecutionResultLimitBreak, type IGeoJsonFeature, type IInsight, type IInsightDefinition, type IMeasureDescriptor, type INullableFilter, type IResultHeader, type IResultWarning, type ISortItem } from "@gooddata/sdk-model";
2
2
  import { type ICancelable } from "../../cancelation/index.js";
3
3
  import { type IExportConfig, type IExportResult } from "./export.js";
4
4
  /**
@@ -170,6 +170,10 @@ export interface IExecutionResultMetadata {
170
170
  * Additional information sent by the underlying data source.
171
171
  */
172
172
  readonly dataSourceMessages: ReadonlyArray<IExecutionResultDataSourceMessage>;
173
+ /**
174
+ * Limits broken during result computation, causing partial data to be returned.
175
+ */
176
+ readonly limitBreaks?: ReadonlyArray<IExecutionResultLimitBreak>;
173
177
  }
174
178
  /**
175
179
  * Format in which the result data are streamed.
@@ -763,7 +763,7 @@ export type IChatConversationItem = {
763
763
  responseId: string;
764
764
  replyTo?: string;
765
765
  createdAt: number;
766
- role: "user" | "assistant" | "tool";
766
+ role: "user" | "assistant" | "tool" | "system";
767
767
  content: IChatConversationContent;
768
768
  feedback?: IChatConversationFeedback;
769
769
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-backend-spi",
3
- "version": "11.41.0-alpha.2",
3
+ "version": "11.41.0-alpha.4",
4
4
  "description": "GoodData Backend SPI abstraction interfaces",
5
5
  "license": "MIT",
6
6
  "author": "GoodData",
@@ -24,7 +24,7 @@
24
24
  "lodash-es": "^4.17.23",
25
25
  "ts-invariant": "0.10.3",
26
26
  "tslib": "2.8.1",
27
- "@gooddata/sdk-model": "11.41.0-alpha.2"
27
+ "@gooddata/sdk-model": "11.41.0-alpha.4"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@microsoft/api-documenter": "^7.17.0",
@@ -48,8 +48,8 @@
48
48
  "oxlint-tsgolint": "0.15.0",
49
49
  "typescript": "5.9.3",
50
50
  "vitest": "4.1.8",
51
- "@gooddata/oxlint-config": "11.41.0-alpha.2",
52
- "@gooddata/eslint-config": "11.41.0-alpha.2"
51
+ "@gooddata/eslint-config": "11.41.0-alpha.4",
52
+ "@gooddata/oxlint-config": "11.41.0-alpha.4"
53
53
  },
54
54
  "scripts": {
55
55
  "_phase:build": "npm run build",