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

package/esm/sdk-model.d.ts

@@ -1718,7 +1718,7 @@ export declare type DataSourceFileType = "CSV" | "SAV";
 /**
  * @alpha
  */
-export declare type DataSourceType = "POSTGRESQL" | "REDSHIFT" | "VERTICA" | "SNOWFLAKE" | "ADS" | "BIGQUERY" | "MSSQL" | "PRESTO" | "DREMIO" | "AZURESQL" | "SYNAPSESQL" | "DATABRICKS" | "GDSTORAGE" | "CLICKHOUSE" | "CRATEDB" | "MYSQL" | "MARIADB" | "ORACLE" | "PINOT" | "DENODO" | "STARROCKS" | "ATHENA" | "SINGLESTORE" | "MOTHERDUCK" | "MONGODB" | "FLEXCONNECT" | "AILAKEHOUSE" | "DRILL" | "TRINO";
+export declare type DataSourceType = "POSTGRESQL" | "REDSHIFT" | "VERTICA" | "SNOWFLAKE" | "ADS" | "BIGQUERY" | "MSSQL" | "PRESTO" | "DREMIO" | "AZURESQL" | "SYNAPSESQL" | "DATABRICKS" | "GDSTORAGE" | "CLICKHOUSE" | "CRATEDB" | "MYSQL" | "MARIADB" | "ORACLE" | "PINOT" | "DENODO" | "STARROCKS" | "ATHENA" | "SINGLESTORE" | "MOTHERDUCK" | "FLEXCONNECT" | "AILAKEHOUSE" | "TRINO";
 
 /**
  * Permission of the current user to a data source.
@@ -1832,6 +1832,90 @@ export declare const DateGranularity: {
  */
 export declare type DateString = string;
 
+/**
+ * Operation that an aggregated fact applies to its source.
+ *
+ * @alpha
+ */
+export declare type DeclarativeAggregationOperation = "SUM" | "MIN" | "MAX" | "APPROXIMATE_COUNT";
+
+/**
+ * Sort direction of attribute elements.
+ *
+ * @alpha
+ */
+export declare type DeclarativeAttributeSortDirection = "ASC" | "DESC";
+
+/**
+ * Definition of a calendar.
+ *
+ * @alpha
+ */
+export declare type DeclarativeCalendarDefinition = IDeclarativeCustomCalendarDefinition | IDeclarativeFiscalYearCalendarDefinition;
+
+/**
+ * Data type of a source column.
+ *
+ * @alpha
+ */
+export declare type DeclarativeColumnDataType = "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
+
+/**
+ * Operand of a conditional formatting condition in the declarative model.
+ *
+ * @remarks
+ * Relative date values use the {@link DeclarativeDateGranularity} vocabulary.
+ *
+ * @alpha
+ */
+export declare type DeclarativeConditionalFormattingValue = {
+    kind: "none";
+} | {
+    kind: "literal";
+    value: string | number;
+} | {
+    kind: "literalRange";
+    from: number;
+    to: number;
+} | {
+    kind: "absoluteDate";
+    from: string;
+    to: string;
+} | {
+    kind: "relativeDate";
+    granularity: DeclarativeDateGranularity;
+    from: number;
+    to: number;
+};
+
+/**
+ * Type of a dataset.
+ *
+ * @alpha
+ */
+export declare type DeclarativeDatasetType = "NORMAL" | "AUXILIARY";
+
+/**
+ * Granularity of a date dataset or a calendar, in the vocabulary of the declarative model.
+ *
+ * @alpha
+ */
+export declare type DeclarativeDateGranularity = "SECOND" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR" | "HOUR_OF_DAY" | "DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK" | "WEEK_OF_YEAR" | "MONTH" | "MONTH_OF_YEAR" | "QUARTER" | "QUARTER_OF_YEAR" | "YEAR" | "FISCAL_DAY_OF_FISCAL_WEEK" | "FISCAL_DAY_OF_FISCAL_MONTH" | "FISCAL_DAY_OF_FISCAL_QUARTER" | "FISCAL_DAY_OF_FISCAL_SEMESTER" | "FISCAL_DAY_OF_FISCAL_YEAR" | "FISCAL_WEEK" | "FISCAL_WEEK_OF_FISCAL_MONTH" | "FISCAL_WEEK_OF_FISCAL_QUARTER" | "FISCAL_WEEK_OF_FISCAL_SEMESTER" | "FISCAL_WEEK_OF_FISCAL_YEAR" | "FISCAL_MONTH" | "FISCAL_MONTH_OF_FISCAL_QUARTER" | "FISCAL_MONTH_OF_FISCAL_SEMESTER" | "FISCAL_MONTH_OF_FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_QUARTER_OF_FISCAL_SEMESTER" | "FISCAL_QUARTER_OF_FISCAL_YEAR" | "FISCAL_SEMESTER" | "FISCAL_SEMESTER_OF_FISCAL_YEAR" | "FISCAL_YEAR";
+
+/**
+ * Type of the object that is a part of a dataset grain or a target of a reference source.
+ *
+ * @alpha
+ */
+export declare type DeclarativeGrainType = "attribute" | "date";
+
+/**
+ * Value type of a label.
+ *
+ * @alpha
+ */
+export declare type DeclarativeLabelValueType = "TEXT" | "HYPERLINK" | "GEO" | "GEO_LONGITUDE" | "GEO_LATITUDE" | "GEO_AREA" | "GEO_ICON" | "IMAGE" | "HYPERLOGLOG";
+
 /**
  * Standard-calendar granularities that an absolute (static) date filter can be configured with.
  * @alpha
@@ -5625,6 +5709,25 @@ export declare interface ICsvReadOptions {
     useThreads?: boolean;
 }
 
+/**
+ * Setting that an application stores in a workspace.
+ *
+ * @alpha
+ */
+export declare interface ICustomApplicationSetting {
+    id: string;
+    /**
+     * Name of the application that owns the setting.
+     */
+    applicationName: string;
+    /**
+     * Content of the setting. The application defines its structure.
+     */
+    content: {
+        [key: string]: unknown;
+    };
+}
+
 /**
  * @beta
  */
@@ -7168,6 +7271,57 @@ export declare interface IDataSourcePermissionAssignment {
     accessSource?: DataSourceAccessSource;
 }
 
+/**
+ * Problem with a column that the scan found.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanColumnWarning {
+    message: string;
+    name: string;
+}
+
+/**
+ * Options of a data source scan.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanRequest {
+    scanTables: boolean;
+    scanViews: boolean;
+    /**
+     * Schemata to scan. When not set, the backend scans the schema of the data source.
+     */
+    schemata?: string[];
+    /**
+     * Separator of the parts of table and column names that the backend uses to detect LDM objects.
+     */
+    separator: string;
+    tablePrefix?: string;
+    viewPrefix?: string;
+}
+
+/**
+ * Result of a data source scan.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanResult {
+    pdm: IPhysicalDataModel;
+    warnings: IDataSourceScanTableWarning[];
+}
+
+/**
+ * Problem with a table that the scan found.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanTableWarning {
+    columns: IDataSourceScanColumnWarning[];
+    message?: string;
+    name: string;
+}
+
 /**
  * Cached results of the data source expire according to a cron schedule.
  *
@@ -7284,6 +7438,425 @@ export declare interface IDateHierarchyTemplate extends IMetadataObjectIdentity,
     granularities: DateAttributeGranularity[];
 }
 
+/**
+ * Fact that aggregates a fact or an attribute of another dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeAggregatedFact {
+    description?: string;
+    id: string;
+    isNullable?: boolean;
+    nullValue?: string;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    sourceFactReference: IDeclarativeSourceFactReference;
+    tags?: string[];
+}
+
+/**
+ * Attribute of a dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeAttribute {
+    conditionalFormatting?: IDeclarativeConditionalFormatting | null;
+    defaultView?: IDeclarativeLabelIdentifier;
+    description?: string;
+    id: string;
+    isHidden?: boolean;
+    isNullable?: boolean;
+    labels: IDeclarativeLabel[];
+    locale?: string;
+    nullValue?: string;
+    sortColumn?: string;
+    sortDirection?: DeclarativeAttributeSortDirection;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    tags?: string[];
+    title: string;
+}
+
+/**
+ * Calendar of the logical data model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCalendar {
+    definition: DeclarativeCalendarDefinition;
+    description?: string;
+    enabledGranularities: IDeclarativeCalendarGranularity[];
+    name: string;
+}
+
+/**
+ * Granularity that a calendar enables.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCalendarGranularity {
+    granularity: DeclarativeDateGranularity;
+    prefix: string;
+}
+
+/**
+ * Data source table that a custom calendar reads.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCalendarTableReference {
+    path: string[];
+    version: string;
+}
+
+/**
+ * Conditional formatting of an attribute, a label or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeConditionalFormatting {
+    conditions: IDeclarativeConditionalFormattingCondition[];
+    enabled: boolean;
+}
+
+/**
+ * Condition of a conditional formatting in the declarative model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeConditionalFormattingCondition {
+    format: IConditionalFormattingFormat;
+    id?: string;
+    operator: ConditionalFormattingOperator;
+    value: DeclarativeConditionalFormattingValue;
+}
+
+/**
+ * Calendar that reads its periods from data source tables.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCustomCalendarDefinition {
+    type: "custom";
+    dataSourceTables: {
+        [id: string]: IDeclarativeCalendarTableReference;
+    };
+}
+
+/**
+ * Dataset of the logical data model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDataset {
+    aggregatedFacts?: IDeclarativeAggregatedFact[];
+    attributes?: IDeclarativeAttribute[];
+    /**
+     * Data source table that the dataset maps to. A dataset maps to a table or to an SQL statement.
+     */
+    dataSourceTableId?: IDeclarativeDataSourceTableIdentifier;
+    description?: string;
+    facts?: IDeclarativeFact[];
+    grain: IDeclarativeGrainIdentifier[];
+    id: string;
+    precedence?: number;
+    references: IDeclarativeReference[];
+    /**
+     * SQL statement that the dataset maps to. A dataset maps to a table or to an SQL statement.
+     */
+    sql?: IDeclarativeDatasetSql;
+    tags?: string[];
+    title: string;
+    type?: DeclarativeDatasetType;
+    workspaceDataFilterColumns?: IDeclarativeWorkspaceDataFilterColumn[];
+    workspaceDataFilterReferences?: IDeclarativeWorkspaceDataFilterReference[];
+}
+
+/**
+ * Extension of a dataset inherited from a parent workspace.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDatasetExtension {
+    id: string;
+    workspaceDataFilterReferences?: IDeclarativeWorkspaceDataFilterReference[];
+}
+
+/**
+ * Identifier of a dataset or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDatasetIdentifier {
+    id: string;
+    type: "dataset";
+}
+
+/**
+ * SQL statement that a dataset maps to.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDatasetSql {
+    dataSourceId: string;
+    statement: string;
+}
+
+/**
+ * Identifier of a data source table.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDataSourceTableIdentifier {
+    dataSourceId: string;
+    id: string;
+    path?: string[] | null;
+    type: "dataSource";
+}
+
+/**
+ * Date dataset of the logical data model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDateDataset {
+    conditionalFormatting?: IDeclarativeConditionalFormatting | null;
+    description?: string;
+    granularities: DeclarativeDateGranularity[];
+    granularitiesFormatting: IDeclarativeGranularitiesFormatting;
+    id: string;
+    tags?: string[];
+    title: string;
+}
+
+/**
+ * Fact of a dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeFact {
+    description?: string;
+    id: string;
+    isHidden?: boolean;
+    isNullable?: boolean;
+    nullValue?: string;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    tags?: string[];
+    title: string;
+}
+
+/**
+ * Calendar with a fiscal year that starts with an offset from the calendar year.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeFiscalYearCalendarDefinition {
+    type: "fiscalYear";
+    monthOffset: number;
+}
+
+/**
+ * Geo area configuration of a label.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGeoAreaConfig {
+    collection: IDeclarativeGeoCollectionIdentifier;
+}
+
+/**
+ * Identifier of a geo collection.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGeoCollectionIdentifier {
+    id: string;
+    kind?: "STATIC" | "CUSTOM";
+}
+
+/**
+ * Identifier of an attribute or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGrainIdentifier {
+    id: string;
+    type: DeclarativeGrainType;
+}
+
+/**
+ * Title formatting of the attributes of a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGranularitiesFormatting {
+    titleBase: string;
+    titlePattern: string;
+}
+
+/**
+ * Label of an attribute.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLabel {
+    conditionalFormatting?: IDeclarativeConditionalFormatting | null;
+    description?: string;
+    geoAreaConfig?: IDeclarativeGeoAreaConfig;
+    id: string;
+    isHidden?: boolean;
+    isNullable?: boolean;
+    locale?: string;
+    nullValue?: string;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    tags?: string[];
+    title: string;
+    translations?: IDeclarativeLabelTranslation[];
+    valueType?: DeclarativeLabelValueType;
+}
+
+/**
+ * Identifier of a label.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLabelIdentifier {
+    id: string;
+    type: "label";
+}
+
+/**
+ * Source column of a label value in one locale.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLabelTranslation {
+    locale: string;
+    sourceColumn: string;
+}
+
+/**
+ * Logical data model of a workspace in the declarative form.
+ *
+ * @remarks
+ * The model has the same form as the declarative logical model document of the backend, so it can be
+ * exported to JSON and imported back without changes.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLogicalModel {
+    /**
+     * Calendars by their identifier.
+     */
+    calendars?: {
+        [id: string]: IDeclarativeCalendar;
+    };
+    /**
+     * Extensions of datasets that the workspace inherits from its parents.
+     */
+    datasetExtensions?: IDeclarativeDatasetExtension[];
+    datasets?: IDeclarativeDataset[];
+    /**
+     * Date datasets.
+     */
+    dateInstances?: IDeclarativeDateDataset[];
+}
+
+/**
+ * Reference from a dataset to another dataset or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeReference {
+    identifier: IDeclarativeDatasetIdentifier;
+    multivalue: boolean;
+    sourceColumnDataTypes?: DeclarativeColumnDataType[];
+    sourceColumns?: string[];
+    sources?: IDeclarativeReferenceSource[];
+}
+
+/**
+ * Source column of a reference and the grain object of the referenced dataset that it maps to.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeReferenceSource {
+    column?: string;
+    dataType?: DeclarativeColumnDataType;
+    isNullable?: boolean;
+    nullValue?: string;
+    target: IDeclarativeGrainIdentifier;
+}
+
+/**
+ * Source of an aggregated fact.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeSourceFactReference {
+    operation: DeclarativeAggregationOperation;
+    reference: IDeclarativeSourceReferenceIdentifier;
+}
+
+/**
+ * Identifier of the fact or attribute that an aggregated fact aggregates.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeSourceReferenceIdentifier {
+    id: string;
+    type: "fact" | "attribute";
+}
+
+/**
+ * Column of a dataset that workspace data filters use.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeWorkspaceDataFilterColumn {
+    dataType: DeclarativeColumnDataType;
+    name: string;
+}
+
+/**
+ * Identifier of a workspace data filter.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeWorkspaceDataFilterIdentifier {
+    id: string;
+    type: "workspaceDataFilter";
+}
+
+/**
+ * Reference from a dataset column to a workspace data filter.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeWorkspaceDataFilterReference {
+    filterColumn: string;
+    filterColumnDataType: DeclarativeColumnDataType;
+    filterId: IDeclarativeWorkspaceDataFilterIdentifier;
+}
+
+/**
+ * Logical data model and analytical objects of a workspace.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeWorkspaceLayout {
+    ldm: IDeclarativeLogicalModel;
+    /**
+     * Analytical objects in the declarative analytics document of the backend.
+     *
+     * @remarks
+     * The model does not describe this document. Use a document that the backend exported.
+     */
+    analytics: object;
+}
+
 /**
  * Default export template setting.
  *
@@ -8949,6 +9522,13 @@ export declare interface IFeatureFlags {
      * Enable Publisher v2.
      */
     enablePublisherV2?: boolean;
+    /**
+     * Enable AI takeaways in the Business Briefing reports application: generating them and their instructions.
+     *
+     * @remarks
+     * Disabled by default.
+     */
+    enableGenAiReportTakeaways?: boolean;
     /**
      * Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
      *
@@ -9823,6 +10403,98 @@ export declare interface IGenAIWidgetDescriptor {
     content?: string;
 }
 
+/**
+ * Change of the LDM object type that the generation detects for a column.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelColumnOverride {
+    labelTargetColumn?: string;
+    labelType?: DeclarativeLabelValueType;
+    ldmTypeOverride?: "FACT" | "LABEL";
+    name: string;
+}
+
+/**
+ * Physical data model that the logical data model generation uses.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelPdm {
+    sqls?: IGenerateLogicalModelSql[];
+    tableOverrides?: IGenerateLogicalModelTableOverride[];
+    tables?: IPhysicalTable[];
+}
+
+/**
+ * Options of the logical data model generation from a data source.
+ *
+ * @remarks
+ * The prefixes and the separator tell the backend how to detect LDM objects from table and column names.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelRequest {
+    aggregatedFactPrefix?: string;
+    dateGranularities?: string;
+    dateReferencePrefix?: string;
+    denormPrefix?: string;
+    factPrefix?: string;
+    generateLongIds?: boolean;
+    grainMultivalueReferencePrefix?: string;
+    grainPrefix?: string;
+    grainReferencePrefix?: string;
+    multivalueReferencePrefix?: string;
+    /**
+     * Physical data model to generate the logical data model from. When not set, the backend scans the data source.
+     */
+    pdm?: IGenerateLogicalModelPdm;
+    primaryLabelPrefix?: string;
+    referencePrefix?: string;
+    secondaryLabelPrefix?: string;
+    separator?: string;
+    tablePrefix?: string;
+    translationPrefix?: string;
+    viewPrefix?: string;
+    wdfPrefix?: string;
+    /**
+     * Workspace whose logical data model the backend uses to keep the existing identifiers.
+     */
+    workspaceId?: string;
+}
+
+/**
+ * SQL statement that the logical data model generation makes a dataset from.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelSql {
+    columns?: IGenerateLogicalModelSqlColumn[];
+    statement: string;
+    title: string;
+}
+
+/**
+ * Column of an SQL statement that the logical data model generation uses.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelSqlColumn {
+    dataType: DeclarativeColumnDataType;
+    name: string;
+    nullValue?: string;
+}
+
+/**
+ * Change of the LDM object types that the generation detects for the columns of a table.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelTableOverride {
+    columns: IGenerateLogicalModelColumnOverride[];
+    path: string[];
+}
+
 /**
  * Represents a custom geo collection stored at the organization level.
  *
@@ -12654,6 +13326,55 @@ export declare interface IPermanentSettings {
     restrictBaseUi?: boolean;
 }
 
+/**
+ * Column of a data source table.
+ *
+ * @alpha
+ */
+export declare interface IPhysicalColumn {
+    dataType: DeclarativeColumnDataType;
+    /**
+     * Name of the column whose values this column labels.
+     * Logical model generation makes this column the default label of the attribute on that column.
+     */
+    defaultLabelOf?: string;
+    description?: string;
+    isNullable?: boolean;
+    isPrimaryKey?: boolean;
+    name: string;
+    nullValue?: string;
+    referencedTableColumn?: string;
+    referencedTableId?: string;
+}
+
+/**
+ * Physical data model of a data source: its tables and their columns.
+ *
+ * @alpha
+ */
+export declare interface IPhysicalDataModel {
+    tables: IPhysicalTable[];
+}
+
+/**
+ * Table or view of a data source.
+ *
+ * @alpha
+ */
+export declare interface IPhysicalTable {
+    columns: IPhysicalColumn[];
+    id: string;
+    namePrefix?: string;
+    /**
+     * Path to the table, for example the schema and the table name.
+     */
+    path: string[];
+    /**
+     * Type of the table, for example TABLE or VIEW.
+     */
+    type: string;
+}
+
 /**
  * Current usage of a platform resource that the organization license can limit.
  *
@@ -17319,6 +18040,31 @@ export declare function isPublisherVisualizationWidgetV2(obj: unknown): obj is I
  */
 export declare function isPublisherWidgetV2(obj: unknown): obj is PublisherWidgetV2;
 
+/**
+ * Column of the result of an SQL statement.
+ *
+ * @alpha
+ */
+export declare interface ISqlScanColumn {
+    dataType: DeclarativeColumnDataType;
+    description?: string;
+    name: string;
+    nullValue?: string;
+}
+
+/**
+ * Result of an SQL statement scan.
+ *
+ * @alpha
+ */
+export declare interface ISqlScanResult {
+    columns: ISqlScanColumn[];
+    /**
+     * First rows of the result of the statement.
+     */
+    dataPreview?: (string | null)[][];
+}
+
 /**
  * Type guard checking whether the provided object is a measure value filter's range condition.
  *