@gooddata/sdk-model 11.54.0-alpha.5 → 11.54.0-alpha.7

package/esm/sdk-model.d.ts

@@ -949,6 +949,42 @@ export declare function bucketsTotals(buckets: IBucket[]): ITotal[];
  */
 export declare function bucketTotals(bucket: IBucket): ITotal[];
 
+/**
+ * Built-in cover page: report title and subtitle.
+ *
+ * @alpha
+ */
+export declare const BuiltInReportPageLayoutCover: IReportPageLayout;
+
+/**
+ * All built-in report pages served by the SPI. Built-ins are read-only: they cannot be
+ * edited or deleted, and they are never persisted on the backend.
+ *
+ * @alpha
+ */
+export declare const BuiltInReportPageLayouts: readonly IReportPageLayout[];
+
+/**
+ * Built-in section divider page.
+ *
+ * @alpha
+ */
+export declare const BuiltInReportPageLayoutSection: IReportPageLayout;
+
+/**
+ * Built-in content page with six visualizations and a text column on the left.
+ *
+ * @alpha
+ */
+export declare const BuiltInReportPageLayoutViz6TextLeft: IReportPageLayout;
+
+/**
+ * List of built-in report slot type names.
+ *
+ * @alpha
+ */
+export declare const BuiltInReportSlotTypes: string[];
+
 /**
  * List of built-in widget types. These type names are reserved and must not be used by custom widgets.
  *
@@ -990,11 +1026,11 @@ export declare type CalendarContext = {
 export declare type CalendarType = "STANDARD" | "FISCAL";
 
 /**
- * Type representing catalog item - attribute, measure, fact or dateDataset
+ * Type representing catalog item - attribute, measure, fact, dateDataset or computedAttribute
  *
  * @public
  */
-export declare type CatalogItem = ICatalogAttribute | ICatalogMeasure | ICatalogFact | ICatalogDateDataset | ICatalogAttributeHierarchy;
+export declare type CatalogItem = ICatalogAttribute | ICatalogMeasure | ICatalogFact | ICatalogDateDataset | ICatalogAttributeHierarchy | ICatalogComputedAttribute;
 
 /**
  * Get metadata object that catalog item represents
@@ -1006,11 +1042,12 @@ export declare type CatalogItem = ICatalogAttribute | ICatalogMeasure | ICatalog
 export declare const catalogItemMetadataObject: (catalogItem: CatalogItem) => MetadataObject;
 
 /**
- * Type representing catalog item type - attribute, measure, fact, dateDataset or attributeHierarchy
+ * Type representing catalog item type - attribute, measure, fact, dateDataset, attributeHierarchy
+ * or computedAttribute
  *
  * @public
  */
-export declare type CatalogItemType = "attribute" | "measure" | "fact" | "dateDataset" | "attributeHierarchy";
+export declare type CatalogItemType = "attribute" | "measure" | "fact" | "dateDataset" | "attributeHierarchy" | "computedAttribute";
 
 /**
  * Certification status.
@@ -1049,6 +1086,13 @@ export declare type ComparatorDirection = "asc" | "desc";
  */
 export declare type ComparisonConditionOperator = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
 
+/**
+ * Data type of the computed attribute values.
+ *
+ * @public
+ */
+export declare type ComputedAttributeDataType = "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
+
 /**
  * Defines possible compute ratio sanitization rules.
  *
@@ -1217,11 +1261,16 @@ export declare const CSV_DELIMITER_PRESETS: {
 };
 
 /**
- * Identifier of a CSV delimiter preset, or "custom" when the user provides their own character.
+ * Identifier of a CSV delimiter preset, "custom" when the user provides their own character,
+ * or "inherit" when no delimiter should be sent and the backend-resolved default should apply.
+ *
+ * @remarks
+ * "custom" and "inherit" are sentinels with no delimiter character of their own; only
+ * {@link CsvDelimiterPresetId} members are valid keys into {@link CSV_DELIMITER_PRESETS}.
  *
  * @alpha
  */
-export declare type CsvDelimiterPreset = CsvDelimiterPresetId | "custom";
+export declare type CsvDelimiterPreset = CsvDelimiterPresetId | "custom" | "inherit";
 
 /**
  * Identifier of a built-in CSV delimiter preset.
@@ -1572,6 +1621,12 @@ export declare const DateGranularity: {
  */
 export declare type DateString = string;
 
+/**
+ * Standard-calendar granularities that an absolute (static) date filter can be configured with.
+ * @alpha
+ */
+export declare const DEFAULT_ABSOLUTE_DATE_FILTER_GRANULARITIES: DateFilterGranularity[];
+
 /**
  * The default CSV delimiter character (comma).
  *
@@ -2408,10 +2463,10 @@ export declare const getChronologicalOrigin: (g: string | undefined) => DateAttr
  * Resolves a delimiter character to its corresponding preset identifier.
  *
  * Returns `"custom"` when the delimiter does not match any built-in preset,
- * or the default preset id (`"comma"`) when no delimiter is provided.
+ * or `"inherit"` when the delimiter is `undefined` or an empty string.
  *
- * @param delimiter - delimiter character to look up
- * @returns the matching preset id, `"custom"`, or the default
+ * @param delimiter - delimiter character to look up; `undefined` or empty resolves to `"inherit"`
+ * @returns the matching preset id, `"custom"`, or `"inherit"`
  * @alpha
  */
 export declare function getCsvDelimiterPreset(delimiter?: string): CsvDelimiterPreset;
@@ -2443,13 +2498,16 @@ export declare function getCsvDelimiterValidationError(delimiter: string): CsvDe
  * Returns the actual delimiter character for a given preset selection.
  *
  * When the preset is `"custom"`, the provided custom delimiter string is returned as-is.
+ * When the preset is `"inherit"`, `undefined` is returned so the `delimiter` field is omitted
+ * from the saved settings, letting the backend-resolved default (workspace or organization
+ * setting) apply instead.
  *
  * @param selectedPreset - the selected preset identifier
  * @param customDelimiter - the user-provided custom delimiter (used only when preset is `"custom"`)
- * @returns the resolved delimiter character
+ * @returns the resolved delimiter character, or `undefined` when the preset is `"inherit"`
  * @alpha
  */
-export declare function getCsvDelimiterValue(selectedPreset: CsvDelimiterPreset, customDelimiter: string): string;
+export declare function getCsvDelimiterValue(selectedPreset: CsvDelimiterPreset, customDelimiter: string): string | undefined;
 
 /**
  * Runs {@link getGranularities} and narrows the result to the {@link DateFilterGranularity} subset.
@@ -2535,6 +2593,13 @@ export declare function getParameterAllowedValueTitle(allowedValue: IParameterAl
  */
 export declare function getParameterValueTitle(definition: IParameterDefinition, value: ParameterValue): string;
 
+/**
+ * Collects the distinct `{{variable}}` names referenced in the text, in order of first occurrence.
+ *
+ * @alpha
+ */
+export declare function getReportTextPlaceholders(text: string): string[];
+
 /**
  * Returns count of selected elements
  * @alpha
@@ -2571,7 +2636,7 @@ export declare type GranularityFamily = "chronological" | "generic";
  *
  * @public
  */
-export declare type GroupableCatalogItem = ICatalogAttribute | ICatalogMeasure | ICatalogFact;
+export declare type GroupableCatalogItem = ICatalogAttribute | ICatalogMeasure | ICatalogFact | ICatalogComputedAttribute;
 
 /**
  * @public
@@ -2628,6 +2693,13 @@ export declare interface IAbsoluteDateFilterForm extends IDateFilterOption {
      * Type to identify the global absolute date filter
      */
     type: DateFilterOptionAbsoluteFormType;
+    /**
+     * Available granularities for the global absolute date filter.
+     *
+     * @remarks
+     * When not set, the absolute date filter behaves exactly as it does today: day-level selection only.
+     */
+    availableGranularities?: DateFilterGranularity[];
     /**
      * Optional configuration for how this option should treat empty date values.
      */
@@ -4330,6 +4402,35 @@ export declare interface ICatalogAttributeHierarchy {
     attributeHierarchy: IAttributeHierarchyMetadataObject;
 }
 
+/**
+ * Type representing catalog computed attribute.
+ *
+ * @remarks
+ * Shaped after {@link ICatalogAttribute} so it can be listed and dragged among
+ * normal attributes; `defaultDisplayForm` is the fabricated display form of the
+ * computed attribute (see {@link IComputedAttributeMetadataObject}).
+ *
+ * @public
+ */
+export declare interface ICatalogComputedAttribute extends IGroupableCatalogItemBase {
+    /**
+     * Catalog item type
+     */
+    type: "computedAttribute";
+    /**
+     * Computed attribute metadata object that this catalog item represents
+     */
+    computedAttribute: IComputedAttributeMetadataObject;
+    /**
+     * Default (and only) display form of the computed attribute
+     */
+    defaultDisplayForm: IAttributeDisplayFormMetadataObject;
+    /**
+     * Display forms of the computed attribute
+     */
+    displayForms: IAttributeDisplayFormMetadataObject[];
+}
+
 /**
  * Type representing catalog dateDataset date attribute
  *
@@ -4557,6 +4658,85 @@ export declare interface IComparisonConditionBody {
     treatNullValuesAs?: number;
 }
 
+/**
+ * Computed attribute metadata object.
+ *
+ * @remarks
+ * A computed attribute is an attribute whose values are computed by a MAQL expression
+ * instead of being backed by a data source column. It is deliberately shaped as close
+ * to {@link IAttributeMetadataObject} as possible so that UI treats it like a normal
+ * attribute wherever it appears (buckets, catalog, ...).
+ *
+ * @public
+ */
+export declare type IComputedAttributeMetadataObject = IMetadataObject & IComputedAttributeMetadataObjectBase & IAuditable & {
+    /**
+     * Display forms of the computed attribute.
+     *
+     * @remarks
+     * A computed attribute has no real labels on the backend. To mimic the structure of
+     * a normal attribute, the backend implementation fabricates exactly one display form
+     * (isDefault and isPrimary, attribute ref pointing to this computed attribute).
+     */
+    displayForms: IAttributeDisplayFormMetadataObject[];
+    /**
+     * Whether the computed attribute is locked for editing (e.g. inherited from a parent workspace).
+     */
+    isLocked?: boolean;
+    /**
+     * Dataset the computed attribute belongs to (if supplied by backend include).
+     */
+    dataSet?: IDataSetMetadataObject;
+    /**
+     * Certification metadata.
+     * @internal
+     */
+    certification?: IObjectCertification;
+};
+
+/**
+ * @public
+ */
+export declare interface IComputedAttributeMetadataObjectBase {
+    type: "computedAttribute";
+    /**
+     * MAQL expression computing the attribute values.
+     */
+    expression: string;
+    /**
+     * Formatting of the computed values.
+     * If empty, a backend implementation-dependent default is used.
+     */
+    format?: string;
+    /**
+     * Categorizes the semantics of the computed values (e.g., currency).
+     */
+    metricType?: MetricType;
+    /**
+     * Data type of the computed values.
+     */
+    dataType?: ComputedAttributeDataType;
+    /**
+     * Whether the computed values may contain nulls.
+     */
+    isNullable?: boolean;
+    /**
+     * Value used in place of null computed values.
+     */
+    nullValue?: string;
+    /**
+     * Locale whose collation order the computed values are sorted by.
+     */
+    locale?: string;
+}
+
+/**
+ * Computed attribute metadata object definition (not yet persisted).
+ *
+ * @public
+ */
+export declare type IComputedAttributeMetadataObjectDefinition = IMetadataObjectDefinition & IComputedAttributeMetadataObjectBase;
+
 /**
  * Conditional-formatting settings: an on/off toggle plus the ordered list of rules. Stored on the
  * table config and (when persisted) on the insight's `properties.controls.conditionalFormatting`.
@@ -7742,6 +7922,14 @@ export declare interface IFeatureFlags {
      * Enable granularity selection for the absolute (static) date filter.
      */
     enableAbsoluteDateFilterGranularity?: boolean;
+    /**
+     * Enable computed attributes.
+     */
+    enableComputedAttributes?: boolean;
+    /**
+     * Enable the Business Briefing reports application.
+     */
+    enableBusinessBriefingReportsApp?: boolean;
 }
 
 /**
@@ -11750,144 +11938,591 @@ export declare interface IRemotePluggableApplicationsRegistryV1 {
 }
 
 /**
- * Attribute header specifies name and URI of the attribute element to which the calculated measure
- * values in the particular data view slice belong.
+ * Report metadata object.
  *
- * @public
+ * @alpha
  */
-export declare interface IResultAttributeHeader {
-    attributeHeaderItem: IResultAttributeHeaderItem;
+export declare interface IReport extends IReportDefinition, IAuditableDates, IAuditableUsers {
+    ref: ObjRef;
+    /**
+     * When true, the object comes from a parent workspace and is not editable
+     * in the current workspace.
+     */
+    isLocked?: boolean;
 }
 
 /**
- * Attribute header item specifies name and URI of the attribute element to which the calculated measure
- * values in the particular data view slice belong.
+ * Text generated by AI at report-build time.
  *
- * @public
+ * @alpha
  */
-export declare interface IResultAttributeHeaderItem {
+export declare interface IReportAiTextSource {
+    type: "ai";
     /**
-     * Human readable name of the attribute element.
-     *
-     * @remarks
+     * Instruction for the generator. Supports `{{variables}}`.
      */
-    name: string | null;
+    prompt: string;
     /**
-     * URI of the attribute element.
-     *
-     * @remarks
-     * This is essentially a primary key of the attribute element. It can
-     * be used in places where attribute elements have to be exactly specified - such as positive or
-     * negative attribute filters.
-     *
-     * It is up to the backend implementation whether the URI is transferable across workspaces or not in the
-     * data distribution scenarios. In other words, if a data for one attribute (say Product) is distributed
-     * into multiple workspaces, it is up to the backend whether the URIs of the elements will be same across
-     * all workspaces or not.
-     *
-     * Recommendation for the consumers: URI is safe to use if you obtain in programmatically from this header
-     * and then use it in the same workspace for instance for filtering. It is not safe to hardcode URIs
-     * and use them in a solution which should operate on top of different workspaces.
-     *
-     * Note that this can actually be null on some backends if your data contains NULL values.
-     * We will change the type of this to string | null in the next major (since it is a breaking change),
-     * but for now, if you expect NULLs in your data, treat this as string | null already.
+     * Materialized generation result (markdown), stored so the report renders
+     * deterministically without re-invoking AI. Absent until first generation.
      */
-    uri: string;
+    content?: string;
     /**
-     * Formatted name of attribute element.
-     *
-     * @remarks
-     * This property holds the formatted form of name property in case of date attributes. When using attribute
-     * elements in visualisations, formatted name should have precedence over original name to show a more
-     * readable form of dates. In other cases, such as drilling, original name property must be used to avoid
-     * inconsistencies.
+     * ISO 8601 timestamp of the stored generation.
      */
-    formattedName?: string;
+    generatedAt?: string;
+}
+
+/**
+ * Fields shared by report definitions and persisted reports.
+ *
+ * @alpha
+ */
+export declare interface IReportBase {
+    title: string;
+    description?: string;
+    tags?: string[];
     /**
-     * Normalized value of attribute element.
+     * Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
      *
      * @remarks
-     * This property holds the normalized form of value property in case of attributes if its differ from
-     * name property. Its used by date attributes for example when normalized value can hold ISO string of date.
-     * Its related to type of attribute and can differ for different implementations.
+     * At execution time the period materializes as an absolute date filter on each
+     * visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
+     * ignoreReportPeriod). Also available as `{{periodStart}}` in text.
      */
-    normalizedValue?: string;
+    periodStart: ReportDateString;
+    /**
+     * Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
+     */
+    periodEnd: ReportDateString;
+    /**
+     * Content of the report. When created from a template the content is deep-copied
+     * and NO reference to the template is kept — the report stays frozen while pages
+     * and templates evolve.
+     */
+    content: IReportContent;
+    /**
+     * Values for variables declared in content.variables, keyed by variable name.
+     */
+    variableValues?: Record<string, string>;
 }
 
 /**
- * Result headers provide metadata about data included in the data view.
- *
- * @remarks
- * They are integral part of the data view and are organized in per-dimension and per-dimension-item arrays.
- *
- * @remarks see {@link @gooddata/sdk-backend-spi#IDataView} for further detail on the organization.
+ * Versioned content shared verbatim by report templates and reports.
  *
- * @public
+ * @alpha
  */
-export declare type IResultHeader = IResultAttributeHeader | IResultMeasureHeader | IResultTotalHeader;
+export declare interface IReportContent {
+    /**
+     * Content model version, for stored-content evolution.
+     */
+    version: "1";
+    /**
+     * Ordered pages of the document.
+     */
+    pages: IReportContentPage[];
+    /**
+     * Content-level default filters; pages and slots may extend or override them.
+     * The report period is NOT stored here — it is derived from periodStart/periodEnd
+     * at execution time.
+     */
+    filters?: FilterContextItem[];
+    /**
+     * Custom variable declarations. Values live on the report
+     * ({@link IReportBase.variableValues}).
+     */
+    variables?: IReportVariableDefinition[];
+}
 
 /**
- * Measure header specifies name of the measure to which the calculated values in the particular data view slice belong.
+ * Page instance embedded in template/report content: a deep clone of a page body
+ * plus its own identity.
  *
  * @remarks
- * Measure header also specifies 'order' - this is essentially an index into measure group descriptor's item array; it
- * can be used to obtain further information about the measure.
+ * Cloning a {@link IReportPageLayout} into content assigns the localIdentifier and regenerates
+ * slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
+ * Deliberately carries NO reference back to the source page — later page edits never
+ * affect existing templates or reports.
  *
- * @public
+ * @alpha
  */
-export declare interface IResultMeasureHeader {
-    measureHeaderItem: IResultMeasureHeaderItem;
+export declare interface IReportContentPage extends IReportPageBody {
+    /**
+     * Identifier unique within the content; stable across template-to-report copy and reordering.
+     */
+    localIdentifier: string;
 }
 
 /**
- * Measure header specifies name of the measure to which the calculated values in the particular data view slice belong.
- *
- * @remarks
- * Measure header also specifies 'order' - this is essentially an index into measure group descriptor's item array; it
- * can be used to obtain further information about the measure.
+ * Payload for creating or updating a report.
  *
- * @public
+ * @alpha
  */
-export declare interface IResultMeasureHeaderItem {
+export declare interface IReportDefinition extends IReportBase {
+    type: "report";
     /**
-     * Measure name - equals to the measure name contained in the respective measure descriptor, included here
-     * for convenience and easy access.
-     *
-     * Note: check out the contract for measure name as described in {@link IMeasureDescriptor} - it is
-     * somewhat more convoluted than one would expect.
-     */
-    name: string;
-    /**
-     * Index of this measure's descriptor within the measure group description. The measure group descriptor
-     * is included in the execution result.
+     * Present when updating an existing report.
      */
-    order: number;
+    ref?: ObjRef;
 }
 
 /**
- * Total header specifies name and type of total to which the calculated values in particular data view slice belong.
+ * Slot rendering an image.
  *
- * @public
+ * @alpha
  */
-export declare interface IResultTotalHeader {
-    totalHeaderItem: IResultTotalHeaderItem;
+export declare interface IReportImageSlot extends IReportSlotBase {
+    type: "image";
+    /**
+     * Undefined = declared-but-empty slot.
+     */
+    source?: ReportImageSource;
+    altText?: string;
+    /**
+     * How the image fills the slot area. Defaults to "contain".
+     */
+    fit?: "contain" | "cover" | "fill";
 }
 
 /**
- * Total header specifies name and type of total to which the calculated values in particular data view slice belong.
- * Also can contain measure index which can be used to lookup the measure which belongs to this total.
+ * Fields common to all report layout nodes.
  *
- * @public
+ * @alpha
  */
-export declare interface IResultTotalHeaderItem {
-    name: string;
-    type: string;
-    measureIndex?: number;
+export declare interface IReportLayoutNodeBase {
+    /**
+     * Fractional weight of this node inside its parent (flex-grow semantics).
+     * Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
+     */
+    weight?: number;
 }
 
 /**
- * Represents an execution result warning.
+ * A container splitting its area into children laid out along a direction.
+ *
+ * @alpha
+ */
+export declare interface IReportLayoutSection extends IReportLayoutNodeBase {
+    type: "section";
+    /**
+     * "row" lays children out horizontally, "column" vertically.
+     */
+    direction: "row" | "column";
+    children: ReportPageLayoutNode[];
+}
+
+/**
+ * A leaf assigning its area to a slot. The slot fills the area completely.
+ *
+ * @alpha
+ */
+export declare interface IReportLayoutSlotRef extends IReportLayoutNodeBase {
+    type: "slotRef";
+    /**
+     * Local identifier of a slot in {@link IReportPageBody.slots}.
+     * A slotId with no matching slot renders as an empty area.
+     */
+    slotId: string;
+}
+
+/**
+ * Body of a report page: geometry (flex split tree) plus the slots it places.
+ *
+ * @remarks
+ * This is both the content of the standalone {@link IReportPageLayout} object and the shape
+ * embedded in template/report content ({@link IReportContentPage}).
+ *
+ * There is no header/footer chrome: page title, description, footer, page numbers and
+ * logos are ordinary slots in the layout tree (text slots with `{{pageNumber}}`/`{{totalPages}}`,
+ * an image slot with `{{logo}}`). Every slot fills its layout area completely.
+ *
+ * @alpha
+ */
+export declare interface IReportPageBody {
+    /**
+     * Editor hint only (template galleries, default styling, AI context).
+     * Renderers must not branch layout logic on it — geometry always comes from `layout`.
+     */
+    kind?: "cover" | "section" | "content";
+    /**
+     * Root of the page layout tree.
+     */
+    layout: ReportPageLayoutNode;
+    /**
+     * All slots referenced by the layout, flat, keyed by localIdentifier.
+     */
+    slots: ReportSlot[];
+    /**
+     * Page-level filters: merged over content-level filters (a filter targeting the
+     * same object replaces the inherited one); slot filters apply on top.
+     */
+    filters?: FilterContextItem[];
+}
+
+/**
+ * Validation issue found in a report page body.
+ *
+ * @alpha
+ */
+export declare interface IReportPageBodyValidationIssue {
+    severity: "error" | "warning";
+    message: string;
+}
+
+/**
+ * Reusable report page metadata object.
+ *
+ * @alpha
+ */
+export declare interface IReportPageLayout extends IReportPageLayoutDefinition, IAuditableDates, IAuditableUsers {
+    ref: ObjRef;
+    /**
+     * When true, the object comes from a parent workspace and is not editable
+     * in the current workspace.
+     */
+    isLocked?: boolean;
+    /**
+     * Predefined page shipped with the product, populated by the SPI. Never sent to or
+     * stored on the backend; UI must disable deletion and editing of built-in pages.
+     */
+    isBuiltIn?: boolean;
+}
+
+/**
+ * Stored content of the reportPage entity.
+ *
+ * @alpha
+ */
+export declare interface IReportPageLayoutContent extends IReportPageBody {
+    /**
+     * Content model version, for stored-content evolution.
+     */
+    version: "1";
+}
+
+/**
+ * Payload for creating or updating a report page.
+ *
+ * @alpha
+ */
+export declare interface IReportPageLayoutDefinition {
+    type: "reportPageLayout";
+    /**
+     * Present when updating an existing page.
+     */
+    ref?: ObjRef;
+    title: string;
+    description?: string;
+    tags?: string[];
+    content: IReportPageLayoutContent;
+}
+
+/**
+ * Structural base of every report slot.
+ *
+ * @remarks
+ * Parsers written against this base can skip slot types introduced by a newer
+ * content version instead of failing.
+ *
+ * @alpha
+ */
+export declare interface IReportSlotBase {
+    type: string;
+    /**
+     * Identifier unique within the page body. The layout tree references it, and it is
+     * the join key when a report fills a template's slots. Regenerated when a page is
+     * cloned into template content so repeated use of one page stays unique.
+     */
+    localIdentifier: string;
+    /**
+     * Present when the slot is an unfilled placeholder.
+     */
+    placeholder?: IReportSlotPlaceholder;
+}
+
+/**
+ * Metadata of a slot that is intentionally left unfilled in a report page or template.
+ *
+ * @alpha
+ */
+export declare interface IReportSlotPlaceholder {
+    /**
+     * Authoring hint shown in the empty slot.
+     */
+    hint?: string;
+    /**
+     * When true, a report is not considered complete until this slot is filled.
+     */
+    required?: boolean;
+}
+
+/**
+ * Author-written text.
+ *
+ * @alpha
+ */
+export declare interface IReportStaticTextSource {
+    type: "static";
+    /**
+     * Markdown content with `{{variable}}` placeholders. Stored raw — placeholders are
+     * resolved only at render/export time.
+     */
+    content: string;
+}
+
+/**
+ * Report template metadata object.
+ *
+ * @alpha
+ */
+export declare interface IReportTemplate extends IReportTemplateDefinition, IAuditableDates, IAuditableUsers {
+    ref: ObjRef;
+    /**
+     * When true, the object comes from a parent workspace and is not editable
+     * in the current workspace.
+     */
+    isLocked?: boolean;
+}
+
+/**
+ * Payload for creating or updating a report template.
+ *
+ * @alpha
+ */
+export declare interface IReportTemplateDefinition {
+    type: "reportTemplate";
+    /**
+     * Present when updating an existing template.
+     */
+    ref?: ObjRef;
+    title: string;
+    description?: string;
+    tags?: string[];
+    content: IReportContent;
+}
+
+/**
+ * Slot rendering text.
+ *
+ * @alpha
+ */
+export declare interface IReportTextSlot extends IReportSlotBase {
+    type: "text";
+    kind: ReportTextSlotKind;
+    /**
+     * Undefined = declared-but-empty slot.
+     */
+    source?: ReportTextSource;
+}
+
+/**
+ * A custom variable declared by report content and given a value by a report.
+ *
+ * @remarks
+ * Referenced from text as `{{name}}`. Values come from {@link IReportBase.variableValues},
+ * falling back to {@link IReportVariableDefinition.defaultValue}.
+ *
+ * @alpha
+ */
+export declare interface IReportVariableDefinition {
+    /**
+     * Variable name as used inside the `{{...}}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
+     * Built-in names ({@link ReportBuiltInVariable}) are reserved.
+     */
+    name: string;
+    /**
+     * Human readable label shown in the editor.
+     */
+    title?: string;
+    description?: string;
+    /**
+     * Value used when the report does not provide one. May not contain further
+     * placeholders — there is no recursive expansion.
+     */
+    defaultValue?: string;
+}
+
+/**
+ * Slot rendering an insight, with its own filter context.
+ *
+ * @alpha
+ */
+export declare interface IReportVisualizationSlot extends IReportSlotBase {
+    type: "visualization";
+    /**
+     * Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
+     */
+    insight?: ObjRef;
+    /**
+     * Optional title rendered above the visualization. Supports `{{variables}}`.
+     */
+    title?: string;
+    showTitle?: boolean;
+    /**
+     * Visualization properties overriding the insight's own.
+     */
+    properties?: VisualizationProperties;
+    /**
+     * Slot-level filters, applied on top of the effective content and page filters.
+     * A slot filter targeting the same object replaces the inherited one.
+     */
+    filters?: FilterContextItem[];
+    /**
+     * Content- and page-level filters this slot ignores (matched by display form / date dataset).
+     */
+    ignoredFilters?: IDashboardFilterReference[];
+    /**
+     * Date dataset the report's period (periodStart/periodEnd) is applied to as an
+     * absolute date filter at execution time. Undefined = backend date-dataset
+     * auto-resolution applies.
+     */
+    dateDataSet?: ObjRef;
+    /**
+     * When true, the implicit date filter derived from the report's period is not
+     * applied to this slot.
+     */
+    ignoreReportPeriod?: boolean;
+}
+
+/**
+ * Attribute header specifies name and URI of the attribute element to which the calculated measure
+ * values in the particular data view slice belong.
+ *
+ * @public
+ */
+export declare interface IResultAttributeHeader {
+    attributeHeaderItem: IResultAttributeHeaderItem;
+}
+
+/**
+ * Attribute header item specifies name and URI of the attribute element to which the calculated measure
+ * values in the particular data view slice belong.
+ *
+ * @public
+ */
+export declare interface IResultAttributeHeaderItem {
+    /**
+     * Human readable name of the attribute element.
+     *
+     * @remarks
+     */
+    name: string | null;
+    /**
+     * URI of the attribute element.
+     *
+     * @remarks
+     * This is essentially a primary key of the attribute element. It can
+     * be used in places where attribute elements have to be exactly specified - such as positive or
+     * negative attribute filters.
+     *
+     * It is up to the backend implementation whether the URI is transferable across workspaces or not in the
+     * data distribution scenarios. In other words, if a data for one attribute (say Product) is distributed
+     * into multiple workspaces, it is up to the backend whether the URIs of the elements will be same across
+     * all workspaces or not.
+     *
+     * Recommendation for the consumers: URI is safe to use if you obtain in programmatically from this header
+     * and then use it in the same workspace for instance for filtering. It is not safe to hardcode URIs
+     * and use them in a solution which should operate on top of different workspaces.
+     *
+     * Note that this can actually be null on some backends if your data contains NULL values.
+     * We will change the type of this to string | null in the next major (since it is a breaking change),
+     * but for now, if you expect NULLs in your data, treat this as string | null already.
+     */
+    uri: string;
+    /**
+     * Formatted name of attribute element.
+     *
+     * @remarks
+     * This property holds the formatted form of name property in case of date attributes. When using attribute
+     * elements in visualisations, formatted name should have precedence over original name to show a more
+     * readable form of dates. In other cases, such as drilling, original name property must be used to avoid
+     * inconsistencies.
+     */
+    formattedName?: string;
+    /**
+     * Normalized value of attribute element.
+     *
+     * @remarks
+     * This property holds the normalized form of value property in case of attributes if its differ from
+     * name property. Its used by date attributes for example when normalized value can hold ISO string of date.
+     * Its related to type of attribute and can differ for different implementations.
+     */
+    normalizedValue?: string;
+}
+
+/**
+ * Result headers provide metadata about data included in the data view.
+ *
+ * @remarks
+ * They are integral part of the data view and are organized in per-dimension and per-dimension-item arrays.
+ *
+ * @remarks see {@link @gooddata/sdk-backend-spi#IDataView} for further detail on the organization.
+ *
+ * @public
+ */
+export declare type IResultHeader = IResultAttributeHeader | IResultMeasureHeader | IResultTotalHeader;
+
+/**
+ * Measure header specifies name of the measure to which the calculated values in the particular data view slice belong.
+ *
+ * @remarks
+ * Measure header also specifies 'order' - this is essentially an index into measure group descriptor's item array; it
+ * can be used to obtain further information about the measure.
+ *
+ * @public
+ */
+export declare interface IResultMeasureHeader {
+    measureHeaderItem: IResultMeasureHeaderItem;
+}
+
+/**
+ * Measure header specifies name of the measure to which the calculated values in the particular data view slice belong.
+ *
+ * @remarks
+ * Measure header also specifies 'order' - this is essentially an index into measure group descriptor's item array; it
+ * can be used to obtain further information about the measure.
+ *
+ * @public
+ */
+export declare interface IResultMeasureHeaderItem {
+    /**
+     * Measure name - equals to the measure name contained in the respective measure descriptor, included here
+     * for convenience and easy access.
+     *
+     * Note: check out the contract for measure name as described in {@link IMeasureDescriptor} - it is
+     * somewhat more convoluted than one would expect.
+     */
+    name: string;
+    /**
+     * Index of this measure's descriptor within the measure group description. The measure group descriptor
+     * is included in the execution result.
+     */
+    order: number;
+}
+
+/**
+ * Total header specifies name and type of total to which the calculated values in particular data view slice belong.
+ *
+ * @public
+ */
+export declare interface IResultTotalHeader {
+    totalHeaderItem: IResultTotalHeaderItem;
+}
+
+/**
+ * Total header specifies name and type of total to which the calculated values in particular data view slice belong.
+ * Also can contain measure index which can be used to lookup the measure which belongs to this total.
+ *
+ * @public
+ */
+export declare interface IResultTotalHeaderItem {
+    name: string;
+    type: string;
+    measureIndex?: number;
+}
+
+/**
+ * Represents an execution result warning.
  * (e.g. when execution was executed successfully, but backend didn't take something into the account)
  *
  * @public
@@ -12288,6 +12923,13 @@ export declare function isCatalogAttribute(obj: unknown): obj is ICatalogAttribu
  */
 export declare function isCatalogAttributeHierarchy(obj: unknown): obj is ICatalogAttributeHierarchy;
 
+/**
+ * Type guard checking whether the provided object is a {@link ICatalogComputedAttribute}
+ *
+ * @public
+ */
+export declare function isCatalogComputedAttribute(obj: unknown): obj is ICatalogComputedAttribute;
+
 /**
  * Type guard checking whether object is an instance of ICatalogDateDataset.
  *
@@ -12490,6 +13132,22 @@ export declare function isComparisonCondition(obj: unknown): obj is IComparisonC
  */
 export declare function isComparisonConditionOperator(obj: unknown): obj is ComparisonConditionOperator;
 
+/**
+ * Tests whether the provided object is of type {@link IComputedAttributeMetadataObject}.
+ *
+ * @param obj - object to test
+ * @public
+ */
+export declare function isComputedAttributeMetadataObject(obj: unknown): obj is IComputedAttributeMetadataObject;
+
+/**
+ * Tests whether the provided object is of type {@link IComputedAttributeMetadataObjectDefinition}.
+ *
+ * @param obj - object to test
+ * @public
+ */
+export declare function isComputedAttributeMetadataObjectDefinition(obj: unknown): obj is IComputedAttributeMetadataObjectDefinition;
+
 /**
  * Type-guard testing whether the provided object is an instance of {@link ICrossFiltering}.
  * @alpha
@@ -13758,6 +14416,104 @@ export declare function isRelativeUpperBoundedDateFilterBody(obj: unknown): obj
  */
 export declare function isRemotePluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is RemotePluggableApplicationRegistryItem;
 
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReport}.
+ *
+ * @alpha
+ */
+export declare function isReport(obj: unknown): obj is IReport;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportContent}.
+ *
+ * @alpha
+ */
+export declare function isReportContentV1(obj: unknown): obj is IReportContent;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportDefinition}.
+ *
+ * @alpha
+ */
+export declare function isReportDefinition(obj: unknown): obj is IReportDefinition;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportImageSlot}.
+ *
+ * @alpha
+ */
+export declare function isReportImageSlot(obj: unknown): obj is IReportImageSlot;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSection}.
+ *
+ * @alpha
+ */
+export declare function isReportLayoutSection(obj: unknown): obj is IReportLayoutSection;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportLayoutSlotRef}.
+ *
+ * @alpha
+ */
+export declare function isReportLayoutSlotRef(obj: unknown): obj is IReportLayoutSlotRef;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportPageLayout}.
+ *
+ * @alpha
+ */
+export declare function isReportPageLayout(obj: unknown): obj is IReportPageLayout;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutContent}.
+ *
+ * @alpha
+ */
+export declare function isReportPageLayoutContentV1(obj: unknown): obj is IReportPageLayoutContent;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportPageLayoutDefinition}.
+ *
+ * @alpha
+ */
+export declare function isReportPageLayoutDefinition(obj: unknown): obj is IReportPageLayoutDefinition;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link ReportSlot}.
+ *
+ * @alpha
+ */
+export declare function isReportSlot(obj: unknown): obj is ReportSlot;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportTemplate}.
+ *
+ * @alpha
+ */
+export declare function isReportTemplate(obj: unknown): obj is IReportTemplate;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportTemplateDefinition}.
+ *
+ * @alpha
+ */
+export declare function isReportTemplateDefinition(obj: unknown): obj is IReportTemplateDefinition;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportTextSlot}.
+ *
+ * @alpha
+ */
+export declare function isReportTextSlot(obj: unknown): obj is IReportTextSlot;
+
+/**
+ * Type-guard testing whether the provided object is an instance of {@link IReportVisualizationSlot}.
+ *
+ * @alpha
+ */
+export declare function isReportVisualizationSlot(obj: unknown): obj is IReportVisualizationSlot;
+
 /**
  * Type-guard testing whether the provided object is an instance of {@link IResultAttributeHeader}.
  *
@@ -14016,6 +14772,12 @@ export declare function isValidDashboardTimezoneId(timezoneId: DashboardTimezone
  * sentinel is not a valid IANA ID — use {@link isValidDashboardTimezoneId} for
  * values stored on the dashboard.
  *
+ * Identifiers are case-sensitive. `Intl` accepts timezones case-insensitively, so
+ * a value that only differs in case from the canonical form (e.g. `"america/new_york"`)
+ * is rejected. Aliases that resolve to a different identifier (e.g. `"Etc/UTC"` → `"UTC"`)
+ * are still accepted as ICU-known IDs. Offset-style identifiers (e.g. `"+01"`, `"+0100"`,
+ * `"+01:00"`) are rejected.
+ *
  * @param timezoneId - timezone identifier to test
  * @alpha
  */
@@ -16851,7 +17613,7 @@ export declare function mergeFilters(originalFilters: IFilter[], addedFilters: I
  *
  * @public
  */
-export declare type MetadataObject = IAttributeMetadataObject | IAttributeDisplayFormMetadataObject | IFactMetadataObject | IMeasureMetadataObject | IParameterMetadataObject | IDataSetMetadataObject | IVariableMetadataObject | IDashboardMetadataObject | IAttributeHierarchyMetadataObject | IMemoryItemMetadataObject;
+export declare type MetadataObject = IAttributeMetadataObject | IComputedAttributeMetadataObject | IAttributeDisplayFormMetadataObject | IFactMetadataObject | IMeasureMetadataObject | IParameterMetadataObject | IDataSetMetadataObject | IVariableMetadataObject | IDashboardMetadataObject | IAttributeHierarchyMetadataObject | IMemoryItemMetadataObject;
 
 /**
  * Get metadata object identifier
@@ -16990,6 +17752,18 @@ export declare function newAbsoluteDashboardDateFilter(from: DateString, to: Dat
  */
 export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier, from: string, to: string, localIdentifier?: string, emptyValueHandling?: EmptyValues): IAbsoluteDateFilter;
 
+/**
+ * Creates an ad-hoc report definition not based on any template.
+ *
+ * @alpha
+ */
+export declare function newAdHocReportDefinition(options: {
+    title: string;
+    periodStart: ReportDateString;
+    periodEnd: ReportDateString;
+    pages?: IReportContentPage[];
+}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
+
 /**
  * Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the dates.
  *
@@ -17380,6 +18154,54 @@ export declare function newRelativeDashboardDateFilter(granularity: DateFilterGr
  */
 export declare function newRelativeDateFilter(dateDataSet: ObjRef | Identifier, granularity: DateAttributeGranularity, from: number, to: number, localIdentifier?: string, boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter, emptyValueHandling?: EmptyValues): IRelativeDateFilter;
 
+/**
+ * Creates report content from page instances.
+ *
+ * @alpha
+ */
+export declare function newReportContent(pages: IReportContentPage[], modifications?: Partial<Omit<IReportContent, "version" | "pages">>): IReportContent;
+
+/**
+ * Clones a report page into a page instance embeddable in template/report content.
+ *
+ * @remarks
+ * The body is deep-copied and detached from the source page — no reference is kept.
+ * Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
+ * page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
+ *
+ * @alpha
+ */
+export declare function newReportContentPageFromLayout(page: IReportPageLayout | IReportPageLayoutDefinition, localIdentifier?: string): IReportContentPage;
+
+/**
+ * Creates a report definition from a template.
+ *
+ * @remarks
+ * The template content is deep-copied; no reference to the template is kept, so the
+ * report stays frozen while the template evolves.
+ *
+ * @alpha
+ */
+export declare function newReportDefinitionFromTemplate(template: IReportTemplate | IReportTemplateDefinition, options: {
+    title: string;
+    periodStart: ReportDateString;
+    periodEnd: ReportDateString;
+}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
+
+/**
+ * Creates a new report page definition.
+ *
+ * @alpha
+ */
+export declare function newReportPageLayoutDefinition(title: string, body: IReportPageBody, modifications?: Partial<Omit<IReportPageLayoutDefinition, "type" | "title" | "content">>): IReportPageLayoutDefinition;
+
+/**
+ * Creates a new report template definition.
+ *
+ * @alpha
+ */
+export declare function newReportTemplateDefinition(title: string, content: IReportContent, modifications?: Partial<Omit<IReportTemplateDefinition, "type" | "title" | "content">>): IReportTemplateDefinition;
+
 /**
  * Creates a new total.
  *
@@ -17490,7 +18312,7 @@ export declare type ObjectPermissionsObjectKind = "attribute" | "fact" | "label"
  *
  * @public
  */
-export declare type ObjectType = "measure" | "fact" | "attribute" | "displayForm" | "dataSet" | "tag" | "insight" | "variable" | "analyticalDashboard" | "theme" | "colorPalette" | "workspaceTheme" | "workspaceColorPalette" | "filterContext" | "dashboardPlugin" | "attributeHierarchy" | "user" | "userGroup" | "dateHierarchyTemplate" | "dateAttributeHierarchy" | "exportDefinition" | "automation" | "filterView" | "workspaceDataFilter" | "workspaceDataFilterSetting" | "userDataFilter" | "notificationChannel" | "memoryItem" | "parameter";
+export declare type ObjectType = "measure" | "fact" | "attribute" | "computedAttribute" | "displayForm" | "dataSet" | "tag" | "insight" | "variable" | "analyticalDashboard" | "theme" | "colorPalette" | "workspaceTheme" | "workspaceColorPalette" | "filterContext" | "dashboardPlugin" | "attributeHierarchy" | "user" | "userGroup" | "dateHierarchyTemplate" | "dateAttributeHierarchy" | "exportDefinition" | "automation" | "filterView" | "workspaceDataFilter" | "workspaceDataFilterSetting" | "userDataFilter" | "notificationChannel" | "memoryItem" | "parameter" | "reportPageLayout" | "reportTemplate" | "report";
 
 /**
  * Model object reference.
@@ -17789,6 +18611,88 @@ export declare type RemotePluggableApplicationRegistryItem = IRemotePluggableApp
  */
 export declare type RemotePluggableApplicationsRegistry = IRemotePluggableApplicationsRegistryV1;
 
+/**
+ * Variables resolved by the rendering runtime; they are never declared or stored.
+ *
+ * @remarks
+ * Referenced from report text as `{{name}}`. Custom variable names must not collide with these;
+ * on collision the built-in wins.
+ *
+ * @alpha
+ */
+export declare type ReportBuiltInVariable = "reportTitle" | "periodStart" | "periodEnd" | "workspaceName" | "generatedAt" | "pageNumber" | "totalPages" | "logo";
+
+/**
+ * All built-in report variable names.
+ *
+ * @alpha
+ */
+export declare const ReportBuiltInVariables: ReportBuiltInVariable[];
+
+/**
+ * Convenience accessor for a report or template page by its localIdentifier.
+ *
+ * @alpha
+ */
+export declare function reportContentPage(reportOrTemplate: IReport | IReportDefinition | IReportTemplate | IReportTemplateDefinition, pageLocalIdentifier: string): IReportContentPage | undefined;
+
+/**
+ * ISO 8601 calendar date (YYYY-MM-DD).
+ *
+ * @alpha
+ */
+export declare type ReportDateString = string;
+
+/**
+ * What an image slot displays.
+ *
+ * @alpha
+ */
+export declare type ReportImageSource = {
+    type: "url";
+    /**
+     * Image URL. Supports `{{variables}}` — a logo slot uses `{{logo}}`.
+     */
+    url: string;
+} | {
+    type: "asset";
+    /**
+     * Reference to a backend-managed asset.
+     */
+    ref: ObjRef;
+};
+
+/**
+ * Node of a report page layout: a recursive row/column split tree (flexbox semantics)
+ * over a fixed page. Leaves assign their area to slots; the tree carries only geometry,
+ * slot content lives in {@link IReportPageBody.slots}.
+ *
+ * @alpha
+ */
+export declare type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutSlotRef;
+
+/**
+ * All slot types of report content version 1.
+ *
+ * @alpha
+ */
+export declare type ReportSlot = IReportVisualizationSlot | IReportTextSlot | IReportImageSlot;
+
+/**
+ * Semantic kind of a text slot. Drives default typography/styling and AI context only —
+ * never geometry (geometry always comes from the layout tree).
+ *
+ * @alpha
+ */
+export declare type ReportTextSlotKind = "title" | "subtitle" | "sectionTitle" | "description" | "summary" | "body" | "custom";
+
+/**
+ * Where the text of a text slot comes from.
+ *
+ * @alpha
+ */
+export declare type ReportTextSource = IReportStaticTextSource | IReportAiTextSource;
+
 /**
  * Entitlements and their values that must be set for the pluggable application to be accessible for
  * the currently logged user.
@@ -17823,6 +18727,14 @@ export declare type RequiredSettings = Condition<Partial<IPermanentSettings | IF
  */
 export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableApplicationWorkspacePermissions>>;
 
+/**
+ * Replaces `{{variable}}` markers with values. Markers with no value are left as-is.
+ * Values are inserted verbatim — there is no recursive expansion.
+ *
+ * @alpha
+ */
+export declare function resolveReportTextPlaceholders(text: string, values: Record<string, string>): string;
+
 /**
  * Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
  * sentinel resolves to the browser/runtime timezone, any other value is returned as-is.
@@ -18184,6 +19096,16 @@ export declare type UserDataFilterDefinition = IUserDataFilterDefinition | IUser
  */
 export declare function userFullName(user: IUser): string | undefined;
 
+/**
+ * Validates the structural invariants of a page body the type system cannot express:
+ * slot localIdentifiers are unique, layout weights are positive, every slot is placed
+ * by the layout, and every layout slotId resolves (unresolved ones are warnings —
+ * they render as empty areas).
+ *
+ * @alpha
+ */
+export declare function validateReportPageBody(body: IReportPageBody): IReportPageBodyValidationIssue[];
+
 /**
  * Builder for virtual arithmetic measures.
  *