@gooddata/sdk-model 11.57.0-alpha.4 → 11.57.0-alpha.6

package/esm/sdk-model.d.ts

@@ -1026,7 +1026,7 @@ export declare const BuiltInReportPageLayoutViz6TextLeft: IReportPageLayout;
 export declare const BuiltInReportSlotTypes: string[];
 
 /**
- * All semantic kinds a text slot can carry.
+ * All levels a text slot can carry.
  *
  * @alpha
  */
@@ -3729,6 +3729,13 @@ export declare interface IAttributeDisplayFormMetadataObject extends IMetadataOb
      * @alpha
      */
     geoAreaConfig?: IAttributeDisplayFormGeoAreaConfig;
+    /**
+     * Semantic-layer conditional formatting authored on this label; takes precedence over the owning
+     * attribute's (backend-defined).
+     *
+     * @alpha
+     */
+    conditionalFormatting?: ISemanticConditionalFormatting;
 }
 
 /**
@@ -3949,6 +3956,12 @@ export declare interface IAttributeMetadataObject extends IMetadataObject {
      * Source column name in the underlying data source table.
      */
     sourceColumn?: string;
+    /**
+     * Semantic-layer conditional formatting authored on this attribute.
+     *
+     * @alpha
+     */
+    conditionalFormatting?: ISemanticConditionalFormatting;
 }
 
 /**
@@ -5026,7 +5039,7 @@ export declare interface IConditionalFormatting {
      */
     version?: string;
     enabled: boolean;
-    rules: readonly IConditionalFormattingRule[];
+    rules: IConditionalFormattingRule[];
     /**
      * Targets whose formatting is explicitly suppressed — turned off rather than inherited from any
      * semantic-layer conditional formatting carried on the execution result (see
@@ -5034,7 +5047,7 @@ export declare interface IConditionalFormatting {
      * semantic layer has rules for it. A target not listed here (or when this is absent) is
      * Inherited: semantic rules apply as-is.
      */
-    suppressedTargets?: readonly ConditionalFormattingTarget[];
+    suppressedTargets?: ConditionalFormattingTarget[];
 }
 
 /**
@@ -5078,7 +5091,7 @@ export declare interface IConditionalFormattingFormat {
 export declare interface IConditionalFormattingRule {
     id: string;
     target: ConditionalFormattingTarget;
-    conditions: readonly IConditionalFormattingCondition[];
+    conditions: IConditionalFormattingCondition[];
 }
 
 /**
@@ -8225,6 +8238,18 @@ export declare interface IFeatureFlags {
      * Enable the Business Briefing reports application.
      */
     enableBusinessBriefingReportsApp?: boolean;
+    /**
+     * Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
+     *
+     * @remarks
+     * Covers saveDashboard, saveAsDashboard, exportToPdf and openDeleteDashboardDialog in embedded
+     * dashboards, and saveInsight, saveAsInsight and exportInsight in embedded Analytical Designer.
+     * These commands are accepted from any parent origin, so the embedding organization must restrict
+     * who may frame the application through the CSP frame-ancestors directive before this is enabled.
+     *
+     * Disabled by default.
+     */
+    enableEmbeddingWriteCommands?: boolean;
 }
 
 /**
@@ -11658,11 +11683,6 @@ export declare interface IPermanentSettings {
      * @beta
      */
     defaultExportTemplate?: IDefaultExportTemplate;
-    /**
-     * Brand kit offered to report authors: brand colors, typography and shared assets.
-     * @alpha
-     */
-    reportsBrandKit?: IReportsBrandKit;
     /**
      * Indicates current platform edition.
      */
@@ -12681,158 +12701,6 @@ export declare interface IReportPageLayoutDefinition {
     content: IReportPageLayoutContent;
 }
 
-/**
- * Workspace brand kit: the customer's colors, assets, and typography reports are branded with.
- *
- * @remarks
- * Stored as the free-form content of the `reportsBrandKit` workspace setting. Everything is
- * optional; each part degrades independently to the product defaults. Assets resolve report
- * variables, chart colors derive the visualization palette, typography applies to rendered
- * reports.
- *
- * @alpha
- */
-export declare interface IReportsBrandKit {
-    /**
-     * Content model version, for stored-content evolution.
-     */
-    version: "1";
-    colors?: IReportsBrandKitColors;
-    typography?: IReportsBrandKitTypography;
-    assets?: IReportsBrandKitAssets;
-}
-
-/**
- * Brand assets, all hosted outside the platform.
- *
- * @alpha
- */
-export declare interface IReportsBrandKitAssets {
-    /**
-     * Primary logo URL; resolves the `{logo}` report variable, taking precedence over
-     * the workspace white-labeling logo.
-     */
-    logo?: string;
-    /**
-     * Logo variant for dark backgrounds; resolves the `{logoInverse}` report variable.
-     */
-    logoInverse?: string;
-    /**
-     * Additional brand images, each resolving its `{image_<id>}` report variable.
-     */
-    images?: IReportsBrandKitImage[];
-}
-
-/**
- * Brand colors.
- *
- * @remarks
- * Every color but {@link IReportsBrandKitColors.chart} is written into CSS, so it may be stated in
- * any notation CSS reads. Chart colors become palette entries instead of declarations, so they are
- * held to {@link parseReportsBrandChartColor} and a value it cannot read is dropped.
- *
- * @alpha
- */
-export declare interface IReportsBrandKitColors {
-    /**
-     * Primary brand color, offered to authors as a swatch.
-     *
-     * @remarks
-     * Also seeds the derived chart palette when {@link IReportsBrandKitColors.chart} is not
-     * provided — but only when stated in a notation {@link parseReportsBrandChartColor} reads,
-     * since seeding means computing tints of it rather than declaring it. Stated in any other
-     * notation it remains a swatch, and charts keep the workspace palette.
-     */
-    brand?: string;
-    /**
-     * Ordered chart series colors the visualization palette is derived from. Each must be a color
-     * {@link parseReportsBrandChartColor} reads; the sanitizer drops the rest.
-     */
-    chart?: string[];
-    /**
-     * Ink of headings and titles.
-     */
-    ink?: string;
-    /**
-     * Ink of body and secondary text.
-     */
-    inkMuted?: string;
-    /**
-     * Default page background.
-     */
-    paper?: string;
-    /**
-     * Alternate background for covers and highlighted sections.
-     */
-    paperAlt?: string;
-}
-
-/**
- * One hosted font file, loaded as a font face for rendered reports.
- *
- * @alpha
- */
-export declare interface IReportsBrandKitFontFace {
-    /**
-     * Font family name the face registers; reference it from
-     * {@link IReportsBrandKitTypography.fontFamily}.
-     */
-    family: string;
-    /**
-     * Absolute URL of the externally hosted font file (TTF/OTF/WOFF/WOFF2). The organization
-     * CSP must allow the host as a font source, and for exports the host must also serve
-     * CORS headers.
-     */
-    url: string;
-    /**
-     * CSS font-weight the face carries (1-1000). Defaults to 400.
-     */
-    weight?: number;
-    /**
-     * Defaults to "normal".
-     */
-    style?: "normal" | "italic";
-}
-
-/**
- * Named brand image offered to report authors.
- *
- * @alpha
- */
-export declare interface IReportsBrandKitImage {
-    /**
-     * Identifier the image is referenced by from report content, as the
-     * `{image_<id>}` variable. Must match /^[a-zA-Z0-9_]+$/.
-     */
-    id: string;
-    /**
-     * Absolute URL of the externally hosted image. The organization CSP must allow the
-     * host, and for exports the host must also serve CORS headers.
-     */
-    url: string;
-    /**
-     * Human readable description shown when the image is offered in the editor.
-     */
-    description?: string;
-}
-
-/**
- * Brand typography.
- *
- * @alpha
- */
-export declare interface IReportsBrandKitTypography {
-    /**
-     * CSS font-family stack applied to rendered reports.
-     */
-    fontFamily?: string;
-    /**
-     * Hosted font files backing the families named in
-     * {@link IReportsBrandKitTypography.fontFamily}.
-     */
-    fonts?: IReportsBrandKitFontFace[];
-}
-
 /**
  * Structural base of every report slot.
  *
@@ -14076,7 +13944,7 @@ export declare interface ISemanticConditionalFormatting {
      * Model version of the persisted shape. Absent is treated as `"1"`.
      */
     version?: string;
-    conditions: readonly IConditionalFormattingCondition[];
+    conditions: IConditionalFormattingCondition[];
     /**
      * Whether the rules are applied when rendering. Absent is treated as `true` — this lets the
      * object be turned off without deleting the authored conditions, distinct from having no rules
@@ -15122,6 +14990,13 @@ export declare function isReportContentV1(obj: unknown): obj is IReportContent;
  */
 export declare function isReportDefinition(obj: unknown): obj is IReportDefinition;
 
+/**
+ * Whether the level is a heading.
+ *
+ * @alpha
+ */
+export declare function isReportHeadingKind(kind: ReportTextSlotKind): kind is ReportHeadingKind;
+
 /**
  * Type-guard testing whether the provided object is an instance of {@link IReportImageBackground}.
  *
@@ -15341,6 +15216,13 @@ export declare function isTestNotification(notification: unknown): notification
  */
 export declare function isTextAttributeFilter(obj: unknown): obj is TextAttributeFilter;
 
+/**
+ * Type-guard testing whether the value is a {@link IThemeColorPaletteRef}.
+ *
+ * @alpha
+ */
+export declare function isThemeColorPaletteRef(value: unknown): value is IThemeColorPaletteRef;
+
 /** @alpha */
 export declare const isTimeGranularity: (g: string | undefined) => boolean;
 
@@ -15675,6 +15557,13 @@ export declare interface ITestNotificationDetails {
  * @beta
  */
 export declare interface ITheme {
+    /**
+     * Shape version of the theme content. Absent means version 1: a theme created before the
+     * `reports` and `assets` sections existed.
+     *
+     * @beta
+     */
+    version?: "2";
     /**
      * Images
      *
@@ -15739,6 +15628,18 @@ export declare interface ITheme {
      * @alpha
      */
     header?: IThemeHeader;
+    /**
+     * Report specific properties
+     *
+     * @alpha
+     */
+    reports?: IThemeReports;
+    /**
+     * Image assets offered to reports
+     *
+     * @alpha
+     */
+    assets?: IThemeAssets;
 }
 
 /**
@@ -15765,6 +15666,51 @@ export declare interface IThemeAnalyticalDesignerTitle {
     color?: ThemeColor;
 }
 
+/**
+ * Externally hosted image the theme offers to reports.
+ *
+ * @remarks
+ * The `id` is also the report variable the asset resolves: report content references it as `{id}`.
+ * It must match `^[a-zA-Z][a-zA-Z0-9_]*$`.
+ *
+ * @alpha
+ */
+export declare interface IThemeAsset {
+    id: string;
+    /**
+     * Absolute http(s) URL. The organization CSP must allow the host; for exports the host must
+     * also serve CORS headers.
+     */
+    url: string;
+    /**
+     * Label the asset is offered under in the editor.
+     */
+    title?: string;
+    /**
+     * Accessible name of the image; also shown when the image cannot be loaded.
+     */
+    altText?: string;
+}
+
+/**
+ * Image assets linked by URL, grouped by what they are used for.
+ *
+ * @alpha
+ */
+export declare interface IThemeAssets {
+    logos?: IThemeAsset[];
+    /**
+     * Images offered for image slots, and as element backgrounds.
+     */
+    images?: IThemeAsset[];
+    /**
+     * Images meant to be painted behind an element. They are offered first where a background is
+     * chosen; {@link IThemeAssets.images} are offered there too, so an image used both ways is
+     * stated once.
+     */
+    backgrounds?: IThemeAsset[];
+}
+
 /**
  * Axis customization
  *
@@ -15917,6 +15863,22 @@ export declare interface IThemeColorFamily {
     contrast?: ThemeColor;
 }
 
+/**
+ * Reference to an existing color palette object, in the same shape the active color palette
+ * setting uses.
+ *
+ * @remarks
+ * A `workspaceColorPalette` is read from the workspace showing the report, which sees its own
+ * palettes and not a parent's. A palette shared across a workspace hierarchy belongs at the
+ * organization level.
+ *
+ * @alpha
+ */
+export declare interface IThemeColorPaletteRef {
+    id: string;
+    type: "colorPalette" | "workspaceColorPalette";
+}
+
 /**
  * Used to color various elements across many components by replacing
  * the default complementary palette of gray color shades
@@ -16541,6 +16503,146 @@ export declare interface IThemePalette {
     complementary?: IThemeComplementaryPalette;
 }
 
+/**
+ * Report specific theme properties.
+ *
+ * @remarks
+ * Consumed by the reports application only; the properties are not part of the shared theming
+ * CSS variable specification.
+ *
+ * @alpha
+ */
+export declare interface IThemeReports {
+    /**
+     * Colors of visualizations in reports: stated inline, or a reference to a color palette
+     * object. When absent, reports use the workspace's active color palette.
+     */
+    visualizationPalette?: ThemeColor[] | IThemeColorPaletteRef;
+    page?: IThemeReportsPage;
+    colors?: IThemeReportsColors;
+    textStyle?: IThemeReportsTextStyle;
+}
+
+/**
+ * Colors offered to report authors as swatches. Each list is exposed as indexed CSS variables.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsColors {
+    /**
+     * Offered for element backgrounds.
+     */
+    backgrounds?: ThemeColor[];
+    /**
+     * Offered for text.
+     */
+    text?: ThemeColor[];
+}
+
+/**
+ * One hosted font file registered as a font face for rendered reports.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsFontFace {
+    /**
+     * Font family name the face registers; referenced from {@link IThemeReportsTypography.fontFamily}.
+     */
+    family: string;
+    /**
+     * Absolute http(s) URL of a TTF/OTF/WOFF/WOFF2 file.
+     */
+    url: string;
+    /**
+     * CSS font-weight (1-1000). Defaults to 400.
+     */
+    weight?: number;
+    /**
+     * Defaults to "normal".
+     */
+    style?: "normal" | "italic";
+}
+
+/**
+ * Heading levels. Each level takes what it does not state from here, then from
+ * {@link IThemeReportsTextStyle}.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsHeading {
+    color?: ThemeColor;
+    lineHeight?: ThemeReportsLength;
+    h1?: IThemeReportsTextLevel;
+    h2?: IThemeReportsTextLevel;
+    h3?: IThemeReportsTextLevel;
+    h4?: IThemeReportsTextLevel;
+    h5?: IThemeReportsTextLevel;
+    h6?: IThemeReportsTextLevel;
+}
+
+/**
+ * Report page properties.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsPage {
+    backgroundColor?: ThemeColor;
+}
+
+/**
+ * Paragraph levels. Each level takes what it does not state from here, then from
+ * {@link IThemeReportsTextStyle}.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsParagraph {
+    color?: ThemeColor;
+    lineHeight?: ThemeReportsLength;
+    p1?: IThemeReportsTextLevel;
+    p2?: IThemeReportsTextLevel;
+    p3?: IThemeReportsTextLevel;
+}
+
+/**
+ * Typography of one text level (h1-h6, p1-p3).
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsTextLevel {
+    fontSize?: ThemeReportsLength;
+    lineHeight?: ThemeReportsLength;
+    /**
+     * Overrides the color of the level's group.
+     */
+    color?: ThemeColor;
+}
+
+/**
+ * Text of rendered reports.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsTextStyle {
+    color?: ThemeColor;
+    lineHeight?: ThemeReportsLength;
+    typography?: IThemeReportsTypography;
+    heading?: IThemeReportsHeading;
+    paragraph?: IThemeReportsParagraph;
+}
+
+/**
+ * Typography of rendered reports.
+ *
+ * @alpha
+ */
+export declare interface IThemeReportsTypography {
+    /**
+     * CSS font-family stack applied to rendered reports.
+     */
+    fontFamily?: string;
+    fonts?: IThemeReportsFontFace[];
+}
+
 /**
  * Table customization
  *
@@ -19088,20 +19190,6 @@ export declare type ParameterValue = IParameterDefinition["defaultValue"];
  */
 export declare function parameterValueMatchesType(definition: IParameterDefinition, value: ParameterValue): boolean;
 
-/**
- * Reads one of {@link IReportsBrandKitColors.chart} as rgb channels, or undefined where the value is
- * not one of the notations those colors are stated in.
- *
- * @remarks
- * Chart colors become palette entries rather than CSS declarations, so unlike the rest of the kit
- * they are held to what this reads: hex (3, 4, 6 or 8 digits) and `rgb()`/`rgba()`. The sanitizer
- * drops what this cannot read, so a stored kit never carries a chart color the palette would
- * silently ignore.
- *
- * @alpha
- */
-export declare function parseReportsBrandChartColor(color: string): IRgbColorValue | undefined;
-
 /**
  * Provenance of a granted permission — granted directly to the grantee,
  * or inherited from a group or rule.
@@ -19347,7 +19435,7 @@ export declare type ReportBackground = IReportColorBackground | IReportImageBack
  *
  * @alpha
  */
-export declare type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo" | "logoInverse";
+export declare type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
 
 /**
  * All built-in report variable names.
@@ -19377,6 +19465,20 @@ export declare function reportContentPage(reportOrTemplate: IReport | IReportDef
  */
 export declare type ReportDateString = string;
 
+/**
+ * Heading levels a text slot can carry.
+ *
+ * @alpha
+ */
+export declare type ReportHeadingKind = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+
+/**
+ * All heading levels, highest first.
+ *
+ * @alpha
+ */
+export declare const ReportHeadingKinds: ReportHeadingKind[];
+
 /**
  * How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to
  * do so, or stretched to its shape.
@@ -19441,19 +19543,18 @@ export declare const ReportPageFormats: ReportPageFormat[];
 export declare type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutSlotRef;
 
 /**
- * Name of the report variable resolving the brand kit image with the given id.
+ * Paragraph levels a text slot can carry.
  *
  * @alpha
  */
-export declare function reportsBrandKitImageVariable(imageId: string): string;
+export declare type ReportParagraphKind = "p1" | "p2" | "p3";
 
 /**
- * Prefix of the report variables brand kit images resolve; custom report variables must not
- * use it.
+ * All paragraph levels, largest first.
  *
  * @alpha
  */
-export declare const ReportsBrandKitImageVariablePrefix = "image_";
+export declare const ReportParagraphKinds: ReportParagraphKind[];
 
 /**
  * All slot types of report content version 1.
@@ -19470,12 +19571,13 @@ export declare type ReportSlot = IReportVisualizationSlot | IReportTextSlot | IR
 export declare function reportTextPlaceholder(name: string): string;
 
 /**
- * Semantic kind of a text slot. Drives default typography/styling and AI context only —
- * never geometry (geometry always comes from the layout tree).
+ * Text level of a text slot. Drives default typography/styling and AI context only —
+ * never geometry (geometry always comes from the layout tree). Each level is styled by the matching
+ * theme text level (`reports.textStyle.heading.h1` ...).
  *
  * @alpha
  */
-export declare type ReportTextSlotKind = "title" | "subtitle" | "sectionTitle" | "description" | "summary" | "body" | "custom";
+export declare type ReportTextSlotKind = ReportHeadingKind | ReportParagraphKind;
 
 /**
  * Where the text of a text slot comes from.
@@ -19590,20 +19692,6 @@ export declare function sanitizeBucketTotals(bucket: IBucket, sortItems: ISortIt
  */
 export declare function sanitizeParameterValue(definition: IParameterDefinition, value: ParameterValue): ParameterValue;
 
-/**
- * Reads a stored brand kit from free-form JSON, keeping the parts that are valid and dropping
- * everything else.
- *
- * @remarks
- * The setting content is not schema-validated by the backend, so every consumer must go
- * through this. Returns undefined only when the value is not a version "1" brand kit at all;
- * a kit whose sections are absent or entirely invalid comes back empty, which the type permits
- * and a workspace that has not filled its kit in yet carries.
- *
- * @alpha
- */
-export declare function sanitizeReportsBrandKit(value: unknown): IReportsBrandKit | undefined;
-
 /**
  * Supported email attachments
  * @alpha
@@ -19797,6 +19885,23 @@ export declare type ThemeDashboardDensity = "comfortable" | "compact";
  */
 export declare type ThemeFontUri = string;
 
+/**
+ * Length used in rendered reports.
+ *
+ * @remarks
+ * A report page scales with its width, so lengths are stated in `cqw` (1cqw = 1% of the page
+ * width). A bare number means cqw: `3.5` and `"3.5cqw"` are the same length. `cqi`, `em` and `%`
+ * are accepted as well. Anything that does not follow the page width is ignored: `px` and `rem`
+ * hold their size, and `cqh` and `cqb` resolve against the viewport, because a page contains its
+ * inline axis only.
+ *
+ * A line height is the exception to the bare number: `1.5` is the CSS ratio it looks like, a
+ * multiple of the font size, not a share of the page width.
+ *
+ * @alpha
+ */
+export declare type ThemeReportsLength = string | number;
+
 /**
  * Throwing exhaustiveness check for discriminated unions: the `never` parameter fails the build on an
  * unhandled case, and the throw guards runtime values the compiler cannot see. Counterpart: {@link assertNever}.

package/esm/settings/settings.d.ts

@@ -1,5 +1,4 @@
 import type { IDateFilterConfig } from "../dateFilterConfig/index.js";
-import type { IReportsBrandKit } from "../reports/brandKit.js";
 /**
  * Describes metric format override configuration.
  *
@@ -313,11 +312,6 @@ export interface IPermanentSettings {
      * @beta
      */
     defaultExportTemplate?: IDefaultExportTemplate;
-    /**
-     * Brand kit offered to report authors: brand colors, typography and shared assets.
-     * @alpha
-     */
-    reportsBrandKit?: IReportsBrandKit;
     /**
      * Indicates current platform edition.
      */
@@ -1009,5 +1003,17 @@ export interface IFeatureFlags {
      * Enable the Business Briefing reports application.
      */
     enableBusinessBriefingReportsApp?: boolean;
+    /**
+     * Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
+     *
+     * @remarks
+     * Covers saveDashboard, saveAsDashboard, exportToPdf and openDeleteDashboardDialog in embedded
+     * dashboards, and saveInsight, saveAsInsight and exportInsight in embedded Analytical Designer.
+     * These commands are accepted from any parent origin, so the embedding organization must restrict
+     * who may frame the application through the CSP frame-ancestors directive before this is enabled.
+     *
+     * Disabled by default.
+     */
+    enableEmbeddingWriteCommands?: boolean;
 }
 //# sourceMappingURL=settings.d.ts.map