@gooddata/sdk-model 11.41.0-alpha.2 → 11.41.0-alpha.4

package/esm/dashboard/parameter.d.ts

@@ -42,6 +42,26 @@ export interface IDashboardParameter {
      */
     readonly label?: string;
 }
+/**
+ * Backend-neutral parameter value carried on a dashboard tabular export.
+ *
+ * @alpha
+ */
+export interface IDashboardExportParameter {
+    /**
+     * Parameter identifier; drives AFM execution. Matches the workspace catalog parameter's id.
+     */
+    id: string;
+    /**
+     * Value to apply for the parameter, encoded as a string.
+     */
+    value: string;
+    /**
+     * Display title rendered into the export's info sheet. Presentation-only; not consumed by
+     * execution.
+     */
+    title: string;
+}
 /**
  * Tests whether the provided object is an instance of {@link IDashboardParameter}.
  *

package/esm/execution/results/index.d.ts

@@ -432,6 +432,89 @@ export interface IResultWarning {
      */
     parameters?: (ObjRef | string)[];
 }
+/**
+ * Known row-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultRowLimitTypes: readonly ["rowCount", "rows", "xtab-rows"];
+/**
+ * Known column-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultColumnLimitTypes: readonly ["columnCount", "columns", "xtab-columns"];
+/**
+ * Known cell-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultCellLimitTypes: readonly ["cellCount", "cells", "xtab-cells"];
+/**
+ * Known execution result limit types grouped by semantic kind.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultLimitTypes: {
+    readonly rows: readonly ["rowCount", "rows", "xtab-rows"];
+    readonly columns: readonly ["columnCount", "columns", "xtab-columns"];
+    readonly cells: readonly ["cellCount", "cells", "xtab-cells"];
+};
+/**
+ * All known row-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export type ExecutionResultRowLimitType = (typeof ExecutionResultRowLimitTypes)[number];
+/**
+ * All known column-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export type ExecutionResultColumnLimitType = (typeof ExecutionResultColumnLimitTypes)[number];
+/**
+ * All known cell-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export type ExecutionResultCellLimitType = (typeof ExecutionResultCellLimitTypes)[number];
+/**
+ * Semantic kind of a known execution result limit type.
+ *
+ * @alpha
+ */
+export type ExecutionResultLimitKind = keyof typeof ExecutionResultLimitTypes;
+/**
+ * All known execution result limit types.
+ *
+ * @alpha
+ */
+export type ExecutionResultLimitType = ExecutionResultRowLimitType | ExecutionResultColumnLimitType | ExecutionResultCellLimitType;
+/**
+ * Describes a limit broken during result computation, resulting in partial data being returned.
+ *
+ * @alpha
+ */
+export interface IExecutionResultLimitBreak<TLimitType extends string = ExecutionResultLimitType | (string & {})> {
+    /**
+     * Type of the limit that was broken.
+     */
+    readonly limitType: TLimitType;
+    /**
+     * The configured limit value.
+     */
+    readonly limit: number;
+    /**
+     * The actual value that triggered the limit. It is omitted when the value cannot be determined exactly.
+     */
+    readonly value?: number;
+}
+/**
+ * Returns semantic kind for a known execution result limit type.
+ *
+ * @alpha
+ */
+export declare function executionResultLimitTypeToKind(limitType: string): ExecutionResultLimitKind | "unknown";
 /**
  * Type-guard testing whether the provided object is an instance of {@link IAttributeDescriptor}.
  *

package/esm/execution/results/index.js

@@ -1,5 +1,50 @@
-// (C) 2019-2025 GoodData Corporation
+// (C) 2019-2026 GoodData Corporation
 import { isEmpty } from "lodash-es";
+/**
+ * Known row-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export const ExecutionResultRowLimitTypes = ["rowCount", "rows", "xtab-rows"];
+/**
+ * Known column-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export const ExecutionResultColumnLimitTypes = ["columnCount", "columns", "xtab-columns"];
+/**
+ * Known cell-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export const ExecutionResultCellLimitTypes = ["cellCount", "cells", "xtab-cells"];
+/**
+ * Known execution result limit types grouped by semantic kind.
+ *
+ * @alpha
+ */
+export const ExecutionResultLimitTypes = {
+    rows: ExecutionResultRowLimitTypes,
+    columns: ExecutionResultColumnLimitTypes,
+    cells: ExecutionResultCellLimitTypes,
+};
+/**
+ * Returns semantic kind for a known execution result limit type.
+ *
+ * @alpha
+ */
+export function executionResultLimitTypeToKind(limitType) {
+    if (ExecutionResultRowLimitTypes.includes(limitType)) {
+        return "rows";
+    }
+    if (ExecutionResultColumnLimitTypes.includes(limitType)) {
+        return "columns";
+    }
+    if (ExecutionResultCellLimitTypes.includes(limitType)) {
+        return "cells";
+    }
+    return "unknown";
+}
 //
 // Type guards
 //

package/esm/exports/index.d.ts

@@ -1,5 +1,6 @@
 import { type IAuditable } from "../base/metadata.js";
 import { type FilterContextItem } from "../dashboard/filterContext.js";
+import { type IDashboardExportParameter } from "../dashboard/parameter.js";
 import { type IFilter } from "../execution/filter/index.js";
 import { type IMetadataObject, type IMetadataObjectDefinition } from "../ldm/metadata/types.js";
 import { type Identifier } from "../objRef/index.js";
@@ -57,6 +58,10 @@ export interface IExportDefinitionVisualizationObjectContent {
      */
     dashboard?: Identifier;
     filters?: IFilter[] | FilterContextItem[];
+    /**
+     * Parameter runtime-overrides applied on export, keyed by the owning tab's localIdentifier.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
 }
 /**
  * Export definition dashboard content configuration.
@@ -69,6 +74,10 @@ export interface IExportDefinitionDashboardContent {
     dashboard: Identifier;
     filters?: FilterContextItem[];
     filtersByTab?: Record<string, FilterContextItem[]>;
+    /**
+     * Parameter runtime-overrides applied on export, keyed by tab localIdentifier.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
 }
 /**
  * Dashboard attachment types.

package/esm/index.d.ts

@@ -76,13 +76,13 @@ export { type IDashboardAttachment, type IWidgetAttachment, type IExportOptions,
 export { type IUser, type IUserGroup, type IWorkspaceUser, type IOrganizationUser, type IOrganizationUserGroup, userFullName, isIOrganizationUser, isIOrganizationUserGroup, } from "./user/index.js";
 export { type IDashboardLayout, type IDashboardWidget, type IDashboardLayoutSection, type IDashboardLayoutSectionHeader, type IDashboardLayoutSize, type IDashboardLayoutSizeByScreenSize, type IDashboardLayoutItem, type IDashboardLayoutWidget, type IDashboardLayoutConfiguration, type IDashboardLayoutSectionsConfiguration, type IDashboardLayoutContainerDirection, type ScreenSize, isDashboardLayout, isDashboardLayoutSection, isDashboardLayoutItem, isDashboardWidget, } from "./dashboard/layout.js";
 export { type IDashboard, type IDashboardDefinition, type IListedDashboard, type ListedDashboardAvailability, type IDashboardBase, type IDashboardDateFilterConfig, type DashboardDateFilterConfigMode, type IDashboardAttributeFilterConfig, type IDashboardMeasureValueFilterConfig, type IDashboardDateFilterConfigItem, type DashboardAttributeFilterConfigMode, type DashboardAttributeFilterSelectionType, DashboardAttributeFilterSelectionTypeValues, type IDashboardDateFilterAddedPresets, type IDashboardPluginBase, type IDashboardPlugin, type IDashboardPluginDefinition, type IDashboardPluginLink, type IAccessControlAware, type ShareStatus, type SharePermission, type IDashboardPermissions, type IExistingDashboard, type IDashboardTab, type IDashboardFilterGroup, type IDashboardFilterGroupItem, type IDashboardFilterGroupsConfig, DashboardDateFilterConfigModeValues, DashboardAttributeFilterConfigModeValues, isDashboard, isDashboardDefinition, isListedDashboard, isDashboardTab, } from "./dashboard/dashboard.js";
-export { type IDashboardParameter, type DashboardParameterMode, DashboardParameterModeValues, isDashboardParameter, } from "./dashboard/parameter.js";
+export { type IDashboardParameter, type IDashboardExportParameter, type DashboardParameterMode, DashboardParameterModeValues, isDashboardParameter, } from "./dashboard/parameter.js";
 export { type ISettings, type IUserSettings, type IWorkspaceSettings, type IUserWorkspaceSettings, } from "./settings/index.js";
 export { type ISeparators, type IPermanentSettings, type IFeatureFlags, type PlatformEdition, type IWhiteLabeling, type IAlertDefault, type WeekStart, type IFiscalYear, type IActiveCalendars, type CalendarType, type IOpenAiConfig, type ILlmEndpoint, type ILlmActiveProvider, type IAiRateLimit, type DashboardFiltersApplyMode, type EarlyAccessFeatureContext, type EarlyAccessFeatureStatus, type IEarlyAccessFeatureConfig, type IEarlyAccessFeaturesConfig, type IProductionFeatureConfig, type IProductionFeaturesConfig, type IMetricFormatOverrideSetting, isSeparators, } from "./settings/settings.js";
 export type { IWorkspaceUserGroup } from "./userGroup/index.js";
 export type { ThemeFontUri, ThemeColor, IThemeColorFamily, IThemeComplementaryPalette, IThemeWidgetTitle, IThemeTypography, IThemeFontsDef, IThemePalette, IThemeKpi, IThemeKpiValue, IThemeChart, IThemeTable, ITheme, IThemeAnalyticalDesigner, IThemeAnalyticalDesignerTitle, IThemeButton, IThemeDashboard, IThemeDashboardContent, IThemeDashboardContentKpi, IThemeDashboardContentWidget, IThemeDashboardEditPanel, IThemeDashboardFilterBar, IThemeDashboardFilterBarButton, IThemeDashboardNavigation, IThemeDashboardNavigationItem, IThemeDashboardNavigationTitle, IThemeDashboardSection, IThemeDashboardSectionDescription, IThemeDashboardSectionTitle, IThemeDashboardTitle, IThemeMetadataObject, IThemeDefinition, IThemeModal, IThemeModalTitle, IThemeTooltip, IThemeImages, IThemeMessage, IThemeMessageVariant, IThemeToastMessage, IThemeToastMessageVariant, IThemeHeader, ImageUri, IThemeAxis, IThemeChartTooltip, IThemeDataLabel, ThemeDashboardDensity, } from "./theme/index.js";
 export type { IWorkspacePermissions, WorkspacePermission } from "./permissions/index.js";
-export { type DataValue, type ForecastDataValue, type IGeoJsonFeature, type IMeasureDescriptor, type IMeasureDescriptorObject, type IMeasureDescriptorItem, type IDimensionItemDescriptor, type IDimensionDescriptor, type IAttributeHeaderFormOf, type IAttributeDescriptorBody, type IAttributeDescriptor, type IMeasureGroupDescriptor, type IResultAttributeHeader, type IResultHeader, type IResultMeasureHeader, type IResultAttributeHeaderItem, type IResultMeasureHeaderItem, type IResultTotalHeader, type IResultTotalHeaderItem, type ITotalDescriptor, type ITotalDescriptorItem, type IResultWarning, type IColorDescriptor, type IColorDescriptorItem, isColorDescriptor, isAttributeDescriptor, isMeasureGroupDescriptor, isTotalDescriptor, isMeasureDescriptor, isResultAttributeHeader, isResultMeasureHeader, isResultTotalHeader, resultHeaderName, attributeDescriptorLocalId, attributeDescriptorName, geoFeatureId, } from "./execution/results/index.js";
+export { type DataValue, type ForecastDataValue, type ExecutionResultCellLimitType, type ExecutionResultColumnLimitType, type ExecutionResultLimitKind, type ExecutionResultLimitType, type ExecutionResultRowLimitType, type IExecutionResultLimitBreak, type IGeoJsonFeature, type IMeasureDescriptor, type IMeasureDescriptorObject, type IMeasureDescriptorItem, type IDimensionItemDescriptor, type IDimensionDescriptor, type IAttributeHeaderFormOf, type IAttributeDescriptorBody, type IAttributeDescriptor, type IMeasureGroupDescriptor, type IResultAttributeHeader, type IResultHeader, type IResultMeasureHeader, type IResultAttributeHeaderItem, type IResultMeasureHeaderItem, type IResultTotalHeader, type IResultTotalHeaderItem, type ITotalDescriptor, type ITotalDescriptorItem, type IResultWarning, type IColorDescriptor, type IColorDescriptorItem, ExecutionResultCellLimitTypes, ExecutionResultColumnLimitTypes, ExecutionResultLimitTypes, ExecutionResultRowLimitTypes, isColorDescriptor, isAttributeDescriptor, isMeasureGroupDescriptor, isTotalDescriptor, isMeasureDescriptor, isResultAttributeHeader, isResultMeasureHeader, isResultTotalHeader, resultHeaderName, attributeDescriptorLocalId, attributeDescriptorName, executionResultLimitTypeToKind, geoFeatureId, } from "./execution/results/index.js";
 export { type AccessGranteeDetail, type IAccessGrantee, type IUserAccess, type IUserAccessGrantee, type IUserGroupAccess, type IUserGroupAccessGrantee, type IGranularAccessGrantee, type AccessGranularPermission, type PermissionSource, type IGranteeGranularity, type IAvailableAccessGrantee, type IAvailableUserAccessGrantee, type IAvailableUserGroupAccessGrantee, type IGranularUserAccess, type IGranularUserGroupAccess, type IGranularRulesAccess, type IGranularUserAccessGrantee, type IGranularUserGroupAccessGrantee, type IGranularRulesAccessGrantee, type WorkspaceAccessPermission, type IWorkspaceAccess, type IUserWorkspaceAccessGrantee, type IUserGroupWorkspaceAccessGrantee, isUserAccess, isUserAccessGrantee, isUserGroupAccess, isUserGroupAccessGrantee, isGranularAccess, isAvailableUserGroupAccessGrantee, isAvailableUserAccessGrantee, isGranularAccessGrantee, isGranularUserAccessGrantee, isGranularUserGroupAccessGrantee, isGranularUserAccess, isGranularUserGroupAccess, isGranularRulesAccessGrantee, isUserWorkspaceAccessGrantee, isUserGroupWorkspaceAccessGrantee, } from "./accessControl/index.js";
 export { type ObjectPermissionsObjectKind, isObjectPermissionsObjectKind, type IObjectAccessList, } from "./accessControl/objectPermissions.js";
 export { type IOrganizationDescriptor, type IOrganizationDescriptorUpdate, type IWorkspacePermissionAssignment, type IAssignedWorkspace, type AssignedWorkspacePermission, type IOrganizationPermissionAssignment, type OrganizationPermissionAssignment, type IOrganizationAssignee, type AssignedDataSourcePermission, type IAssignedDataSource, type IDataSourcePermissionAssignment, AssignedWorkspacePermissionValue, OrganizationPermissionAssignmentValue, AssignedDataSourcePermissionValue, isAssignedWorkspacePermission, } from "./organization/index.js";

package/esm/index.js

@@ -70,7 +70,7 @@ export { isDashboardLayout, isDashboardLayoutSection, isDashboardLayoutItem, isD
 export { DashboardAttributeFilterSelectionTypeValues, DashboardDateFilterConfigModeValues, DashboardAttributeFilterConfigModeValues, isDashboard, isDashboardDefinition, isListedDashboard, isDashboardTab, } from "./dashboard/dashboard.js";
 export { DashboardParameterModeValues, isDashboardParameter, } from "./dashboard/parameter.js";
 export { isSeparators, } from "./settings/settings.js";
-export { isColorDescriptor, isAttributeDescriptor, isMeasureGroupDescriptor, isTotalDescriptor, isMeasureDescriptor, isResultAttributeHeader, isResultMeasureHeader, isResultTotalHeader, resultHeaderName, attributeDescriptorLocalId, attributeDescriptorName, geoFeatureId, } from "./execution/results/index.js";
+export { ExecutionResultCellLimitTypes, ExecutionResultColumnLimitTypes, ExecutionResultLimitTypes, ExecutionResultRowLimitTypes, isColorDescriptor, isAttributeDescriptor, isMeasureGroupDescriptor, isTotalDescriptor, isMeasureDescriptor, isResultAttributeHeader, isResultMeasureHeader, isResultTotalHeader, resultHeaderName, attributeDescriptorLocalId, attributeDescriptorName, executionResultLimitTypeToKind, geoFeatureId, } from "./execution/results/index.js";
 export { isUserAccess, isUserAccessGrantee, isUserGroupAccess, isUserGroupAccessGrantee, isGranularAccess, isAvailableUserGroupAccessGrantee, isAvailableUserAccessGrantee, isGranularAccessGrantee, isGranularUserAccessGrantee, isGranularUserGroupAccessGrantee, isGranularUserAccess, isGranularUserGroupAccess, isGranularRulesAccessGrantee, isUserWorkspaceAccessGrantee, isUserGroupWorkspaceAccessGrantee, } from "./accessControl/index.js";
 export { isObjectPermissionsObjectKind, } from "./accessControl/objectPermissions.js";
 export { AssignedWorkspacePermissionValue, OrganizationPermissionAssignmentValue, AssignedDataSourcePermissionValue, isAssignedWorkspacePermission, } from "./organization/index.js";

package/esm/sdk-model.d.ts

@@ -1745,6 +1745,80 @@ export declare function emptyDef(workspace: string): IExecutionDefinition;
  */
 export declare type EmptyValues = "include" | "exclude" | "only";
 
+/**
+ * All known cell-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare type ExecutionResultCellLimitType = (typeof ExecutionResultCellLimitTypes)[number];
+
+/**
+ * Known cell-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultCellLimitTypes: readonly ["cellCount", "cells", "xtab-cells"];
+
+/**
+ * All known column-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare type ExecutionResultColumnLimitType = (typeof ExecutionResultColumnLimitTypes)[number];
+
+/**
+ * Known column-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultColumnLimitTypes: readonly ["columnCount", "columns", "xtab-columns"];
+
+/**
+ * Semantic kind of a known execution result limit type.
+ *
+ * @alpha
+ */
+export declare type ExecutionResultLimitKind = keyof typeof ExecutionResultLimitTypes;
+
+/**
+ * All known execution result limit types.
+ *
+ * @alpha
+ */
+export declare type ExecutionResultLimitType = ExecutionResultRowLimitType | ExecutionResultColumnLimitType | ExecutionResultCellLimitType;
+
+/**
+ * Known execution result limit types grouped by semantic kind.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultLimitTypes: {
+    readonly rows: readonly ["rowCount", "rows", "xtab-rows"];
+    readonly columns: readonly ["columnCount", "columns", "xtab-columns"];
+    readonly cells: readonly ["cellCount", "cells", "xtab-cells"];
+};
+
+/**
+ * Returns semantic kind for a known execution result limit type.
+ *
+ * @alpha
+ */
+export declare function executionResultLimitTypeToKind(limitType: string): ExecutionResultLimitKind | "unknown";
+
+/**
+ * All known row-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare type ExecutionResultRowLimitType = (typeof ExecutionResultRowLimitTypes)[number];
+
+/**
+ * Known row-oriented execution result limit types.
+ *
+ * @alpha
+ */
+export declare const ExecutionResultRowLimitTypes: readonly ["rowCount", "rows", "xtab-rows"];
+
 /**
  * Gets the date when the exportDefinition was created
  *
@@ -4674,6 +4748,27 @@ export declare interface IDashboardDefinition<TWidget = IDashboardWidget> extend
     readonly tabs?: IDashboardTab<TWidget>[];
 }
 
+/**
+ * Backend-neutral parameter value carried on a dashboard tabular export.
+ *
+ * @alpha
+ */
+export declare interface IDashboardExportParameter {
+    /**
+     * Parameter identifier; drives AFM execution. Matches the workspace catalog parameter's id.
+     */
+    id: string;
+    /**
+     * Value to apply for the parameter, encoded as a string.
+     */
+    value: string;
+    /**
+     * Display title rendered into the export's info sheet. Presentation-only; not consumed by
+     * execution.
+     */
+    title: string;
+}
+
 /**
  * Single dashboard filter group configuration.
  * Title is displayed in the filter bar.
@@ -6091,6 +6186,26 @@ export declare interface IExecutionDefinition {
     readonly executionConfig?: IExecutionConfig;
 }
 
+/**
+ * Describes a limit broken during result computation, resulting in partial data being returned.
+ *
+ * @alpha
+ */
+export declare interface IExecutionResultLimitBreak<TLimitType extends string = ExecutionResultLimitType | (string & {})> {
+    /**
+     * Type of the limit that was broken.
+     */
+    readonly limitType: TLimitType;
+    /**
+     * The configured limit value.
+     */
+    readonly limit: number;
+    /**
+     * The actual value that triggered the limit. It is omitted when the value cannot be determined exactly.
+     */
+    readonly value?: number;
+}
+
 /**
  * Object describing minimal properties of existing dashboard.
  *
@@ -6124,6 +6239,10 @@ export declare interface IExportDefinitionDashboardContent {
     dashboard: Identifier;
     filters?: FilterContextItem[];
     filtersByTab?: Record<string, FilterContextItem[]>;
+    /**
+     * Parameter runtime-overrides applied on export, keyed by tab localIdentifier.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
 }
 
 /**
@@ -6195,6 +6314,10 @@ export declare interface IExportDefinitionVisualizationObjectContent {
      */
     dashboard?: Identifier;
     filters?: IFilter[] | FilterContextItem[];
+    /**
+     * Parameter runtime-overrides applied on export, keyed by the owning tab's localIdentifier.
+     */
+    parametersByTab?: Record<string, IDashboardExportParameter[]>;
 }
 
 /**

package/esm/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.55.2"
+      "packageVersion": "7.58.7"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-model",
-  "version": "11.41.0-alpha.2",
+  "version": "11.41.0-alpha.4",
   "description": "GoodData Model definitions used by UI components and Backend SPI",
   "license": "MIT",
   "author": "GoodData",
@@ -57,8 +57,8 @@
     "oxlint-tsgolint": "0.15.0",
     "typescript": "5.9.3",
     "vitest": "4.1.8",
-    "@gooddata/eslint-config": "11.41.0-alpha.2",
-    "@gooddata/oxlint-config": "11.41.0-alpha.2"
+    "@gooddata/eslint-config": "11.41.0-alpha.4",
+    "@gooddata/oxlint-config": "11.41.0-alpha.4"
   },
   "scripts": {
     "_phase:build": "npm run build",