@gooddata/sdk-embedding 10.0.0-alpha.9 → 10.1.0-alpha.0

package/esm/sdk-embedding.d.ts

@@ -10,13 +10,7 @@
 
 import { DashboardAttributeFilterConfigMode } from '@gooddata/sdk-model';
 import { DashboardDateFilterConfigMode } from '@gooddata/sdk-model';
-import { IBaseExportConfig } from '@gooddata/api-model-bear';
 import { IInsightDefinition } from '@gooddata/sdk-model';
-import { ILocalIdentifierQualifier as ILocalIdentifierQualifier_2 } from '@gooddata/api-model-bear';
-import { isObjectUriQualifier as isObjectUriQualifier_2 } from '@gooddata/api-model-bear';
-import { isObjIdentifierQualifier as isObjIdentifierQualifier_2 } from '@gooddata/api-model-bear';
-import { IVisualization } from '@gooddata/api-model-bear';
-import { ObjQualifier as ObjQualifier_2 } from '@gooddata/api-model-bear';
 import { ObjRef } from '@gooddata/sdk-model';
 
 /**
@@ -169,9 +163,7 @@ export declare type AdExportFinishedBody = IAdAvailableCommands & {
 export declare type AdExportFinishedData = IGdcAdMessageEnvelope<GdcAdEventType.ExportFinished, AdExportFinishedBody>;
 
 /**
- * Exports current insight into CSV or XLSX. The export configuration matches that of the exportResult
- * function already available in `api-model-bear`. Please consult {@link @gooddata/api-model-bear#IBaseExportConfig} for more
- * detail about possible export configuration options.
+ * Exports current insight into CSV or XLSX.
  *
  * Contract:
  *
@@ -606,6 +598,11 @@ export declare type AdUndoFinishedData = IGdcAdMessageEnvelope<GdcAdEventType.Un
  */
 export declare type AllTimeType = "allTime";
 
+/**
+ * @public
+ */
+export declare type ArithmeticMeasureOperator = "sum" | "difference" | "multiplication" | "ratio" | "change";
+
 /**
  * @public
  */
@@ -616,6 +613,11 @@ export declare type AttributeFilterItem = IPositiveAttributeFilter | INegativeAt
  */
 export declare type AttributeFilterItemSelectionMode = "single" | "multi";
 
+/**
+ * @public
+ */
+export declare type BucketItem = IVisualizationObjectMeasure | IVisualizationObjectAttribute;
+
 /**
  * Base type for error events sent by application in case command processing comes to an expected
  * or unexpected halt.
@@ -632,6 +634,11 @@ export declare type CommandFailed<Product> = IGdcMessageEvent<Product, GdcEventT
  */
 export declare type CommandFailedData<Product> = IGdcMessageEnvelope<Product, GdcEventType.AppCommandFailed, ICommandFailedBody>;
 
+/**
+ * @public
+ */
+export declare type ComparisonConditionOperator = "GREATER_THAN" | "GREATER_THAN_OR_EQUAL_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUAL_TO" | "EQUAL_TO" | "NOT_EQUAL_TO";
+
 /**
  * @public
  */
@@ -1241,6 +1248,15 @@ export declare interface IAdSetApiTokenBody {
     secondsBeforeTokenExpirationToEmitReminder?: number;
 }
 
+/**
+ * @public
+ */
+export declare interface IBucket {
+    localIdentifier?: Identifier;
+    items: BucketItem[];
+    totals?: ITotal[];
+}
+
 /**
  * @public
  */
@@ -1257,6 +1273,17 @@ export declare interface ICommandFailedBody {
     errorMessage: string;
 }
 
+/**
+ * @public
+ */
+export declare interface IComparisonCondition {
+    comparison: {
+        operator: ComparisonConditionOperator;
+        value: number;
+        treatNullValuesAs?: number;
+    };
+}
+
 /**
  * @public
  */
@@ -1301,6 +1328,11 @@ export declare interface IDashboardRelativeDateFilter {
     };
 }
 
+/**
+ * @public
+ */
+export declare type Identifier = string;
+
 /**
  * The main data type of drillable items command
  *
@@ -1405,7 +1437,7 @@ export declare interface IGdcMessageEventListenerConfig {
  *
  * @public
  */
-export declare interface IInsightExportConfig extends IBaseExportConfig {
+export declare interface IInsightExportConfig extends ILegacyBaseExportConfig {
     /**
      * Include applied filters
      */
@@ -1707,7 +1739,61 @@ export declare interface IKdUriInsightRef {
 /**
  * @public
  */
-export declare type ILocalIdentifierQualifier = ILocalIdentifierQualifier_2;
+export declare interface ILegacyBaseExportConfig {
+    /**
+     * Specify title of the exported file.
+     */
+    title?: string;
+    /**
+     * Specify format of the exported file (default CSV).
+     */
+    format?: "xlsx" | "csv" | "raw";
+    /**
+     * When exporting to XLSX, specify whether to merge table headers or not.
+     */
+    mergeHeaders?: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface ILegacyObjectMeta {
+    category?: ObjectCategory;
+    title: string;
+    summary?: string;
+    tags?: string;
+    author?: string;
+    contributor?: string;
+    identifier?: string;
+    uri?: string;
+    deprecated?: "0" | "1";
+    isProduction?: 1 | 0;
+    created?: Timestamp;
+    updated?: Timestamp;
+    flags?: string[];
+    locked?: boolean;
+    projectTemplate?: string;
+    sharedWithSomeone?: 1 | 0;
+    unlisted?: 1 | 0;
+}
+
+/**
+ * @public
+ */
+export declare interface ILocalIdentifierQualifier {
+    localIdentifier: string;
+}
+
+/**
+ * @public
+ */
+export declare interface IMeasureContent {
+    localIdentifier: Identifier;
+    definition: VisualizationObjectMeasureDefinitionType;
+    alias?: string;
+    title?: string;
+    format?: string;
+}
 
 /**
  * @public
@@ -1751,6 +1837,27 @@ export declare interface IObjectMeta {
     title: string;
 }
 
+/**
+ * @public
+ */
+export declare interface IObjIdentifierQualifier {
+    identifier: string;
+}
+
+/**
+ * @public
+ */
+export declare interface IObjUriQualifier {
+    uri: string;
+}
+
+/**
+ * @public
+ */
+export declare interface IObjUriQualifier {
+    uri: string;
+}
+
 /**
  * Attribute filters were exposed in the 'old' format that did not match backend and used the
  * textFilter boolean indicator. We have to honor this for the public API.
@@ -1782,6 +1889,26 @@ export declare interface IPostMessageContextPayload {
     };
 }
 
+/**
+ * @public
+ */
+export declare interface IPreviousPeriodDateDataSet {
+    dataSet: ObjQualifier;
+    periodsAgo: number;
+}
+
+/**
+ * @public
+ */
+export declare interface IRangeCondition {
+    range: {
+        operator: RangeConditionOperator;
+        from: number;
+        to: number;
+        treatNullValuesAs?: number;
+    };
+}
+
 /**
  * @public
  */
@@ -1794,6 +1921,13 @@ export declare interface IRankingFilter {
     };
 }
 
+/**
+ * @public
+ */
+export declare interface IReferenceItems {
+    [identifier: string]: string;
+}
+
 /**
  * @public
  */
@@ -2293,6 +2427,11 @@ export declare function isKdSwitchToEditCommandData(obj: unknown): obj is KdSwit
  */
 export declare function isKdUriInsight(obj: unknown): obj is IKdUriInsightRef;
 
+/**
+ * @public
+ */
+export declare function isLocalIdentifierQualifier(qualifier: unknown): qualifier is ILocalIdentifierQualifier;
+
 /**
  * @public
  */
@@ -2301,12 +2440,12 @@ export declare function isNegativeAttributeFilter(filter: unknown): filter is IN
 /**
  * @public
  */
-export declare const isObjectUriQualifier: typeof isObjectUriQualifier_2;
+export declare function isObjectUriQualifier(qualifier: ObjQualifier): qualifier is IObjUriQualifier;
 
 /**
  * @public
  */
-export declare const isObjIdentifierQualifier: typeof isObjIdentifierQualifier_2;
+export declare function isObjIdentifierQualifier(qualifier: ObjQualifier): qualifier is IObjIdentifierQualifier;
 
 /**
  * @public
@@ -2338,6 +2477,184 @@ export declare function isRemoveDateFilter(filter: unknown): filter is IRemoveDa
  */
 export declare function isRemoveRankingFilter(filter: unknown): filter is IRemoveRankingFilterItem;
 
+/**
+ * @public
+ */
+export declare interface ITotal {
+    type: TotalType;
+    measureIdentifier: string;
+    attributeIdentifier: string;
+    alias?: string;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualization {
+    visualizationObject: IVisualizationObject;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationAttributeContent {
+    localIdentifier: Identifier;
+    displayForm: ObjQualifier;
+    alias?: string;
+    showAllValues?: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObject {
+    meta: ILegacyObjectMeta;
+    content: IVisualizationObjectContent;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectAbsoluteDateFilter {
+    absoluteDateFilter: {
+        dataSet: ObjQualifier;
+        from?: string;
+        to?: string;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectArithmeticMeasureDefinition {
+    arithmeticMeasure: {
+        measureIdentifiers: Identifier[];
+        operator: ArithmeticMeasureOperator;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectAttribute {
+    visualizationAttribute: IVisualizationAttributeContent;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectContent {
+    visualizationClass: IObjUriQualifier;
+    buckets: IBucket[];
+    filters?: VisualizationObjectExtendedFilter[];
+    properties?: string;
+    references?: IReferenceItems;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectContent {
+    visualizationClass: IObjUriQualifier;
+    buckets: IBucket[];
+    filters?: VisualizationObjectExtendedFilter[];
+    properties?: string;
+    references?: IReferenceItems;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectMeasure {
+    measure: IMeasureContent;
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectMeasureDefinition {
+    measureDefinition: {
+        item: ObjQualifier;
+        aggregation?: MeasureAggregation;
+        filters?: VisualizationObjectFilter[];
+        computeRatio?: boolean;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectMeasureValueFilter {
+    measureValueFilter: {
+        measure: IObjUriQualifier | ILocalIdentifierQualifier;
+        condition?: MeasureValueFilterCondition;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectNegativeAttributeFilter {
+    negativeAttributeFilter: {
+        displayForm: ObjQualifier;
+        notIn: string[];
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectPoPMeasureDefinition {
+    popMeasureDefinition: {
+        measureIdentifier: Identifier;
+        popAttribute: ObjQualifier;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectPositiveAttributeFilter {
+    positiveAttributeFilter: {
+        displayForm: ObjQualifier;
+        in: string[];
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectPreviousPeriodMeasureDefinition {
+    previousPeriodMeasure: {
+        measureIdentifier: Identifier;
+        dateDataSets: IPreviousPeriodDateDataSet[];
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectRankingFilter {
+    rankingFilter: {
+        measures: (IObjUriQualifier | ILocalIdentifierQualifier)[];
+        attributes?: (IObjUriQualifier | ILocalIdentifierQualifier)[];
+        operator: RankingFilterOperator;
+        value: number;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IVisualizationObjectRelativeDateFilter {
+    relativeDateFilter: {
+        dataSet: ObjQualifier;
+        granularity: string;
+        from?: number;
+        to?: number;
+    };
+}
+
 /**
  * Adds new attribute filter to filter bar and starts the filter customization flow.
  *
@@ -2908,7 +3225,27 @@ export declare type KdWidgetAddedData = IGdcKdMessageEnvelope<GdcKdEventType.Wid
 /**
  * @public
  */
-export declare type ObjQualifier = ObjQualifier_2;
+export declare type MeasureAggregation = "sum" | "count" | "avg" | "min" | "max" | "median" | "runsum";
+
+/**
+ * @public
+ */
+export declare type MeasureValueFilterCondition = IComparisonCondition | IRangeCondition;
+
+/**
+ * @public
+ */
+export declare type ObjectCategory = "analyticalDashboard" | "attribute" | "attributeDisplayForm" | "column" | "dashboardPlugin" | "dataLoadingColumn" | "dataSet" | "dateFilterConfig" | "dimension" | "domain" | "elementMasking" | "etlFile" | "executionContext" | "fact" | "filterContext" | "filter" | "folder" | "kpi" | "kpiAlert" | "metric" | "projectDashboard" | "prompt" | "reportDefinition" | "report" | "scheduledMail" | "tableDataload" | "table" | "userFilter" | "visualizationClass" | "visualizationObject" | "visualizationWidget" | "theme" | "colorPalette" | "attributeHierarchy" | "user" | "userGroup" | "dateHierarchyTemplate" | "dateAttributeHierarchy";
+
+/**
+ * @public
+ */
+export declare type ObjQualifier = IObjUriQualifier | IObjIdentifierQualifier;
+
+/**
+ * @public
+ */
+export declare type RangeConditionOperator = "BETWEEN" | "NOT_BETWEEN";
 
 /**
  * @public
@@ -2930,4 +3267,39 @@ export declare type RemoveFilterItem = IRemoveDateFilterItem | IRemoveAttributeF
  */
 export declare type ResolvedDateFilterValues = IResolvedDateFilterValue[];
 
+/**
+ * @public
+ */
+export declare type Timestamp = string;
+
+/**
+ * @public
+ */
+export declare type TotalType = "sum" | "avg" | "max" | "min" | "nat" | "med";
+
+/**
+ * @public
+ */
+export declare type VisualizationObjectAttributeFilter = IVisualizationObjectPositiveAttributeFilter | IVisualizationObjectNegativeAttributeFilter;
+
+/**
+ * @public
+ */
+export declare type VisualizationObjectDateFilter = IVisualizationObjectRelativeDateFilter | IVisualizationObjectAbsoluteDateFilter;
+
+/**
+ * @public
+ */
+export declare type VisualizationObjectExtendedFilter = VisualizationObjectFilter | IVisualizationObjectMeasureValueFilter | IVisualizationObjectRankingFilter;
+
+/**
+ * @public
+ */
+export declare type VisualizationObjectFilter = VisualizationObjectDateFilter | VisualizationObjectAttributeFilter;
+
+/**
+ * @public
+ */
+export declare type VisualizationObjectMeasureDefinitionType = IVisualizationObjectMeasureDefinition | IVisualizationObjectArithmeticMeasureDefinition | IVisualizationObjectPoPMeasureDefinition | IVisualizationObjectPreviousPeriodMeasureDefinition;
+
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-embedding",
-  "version": "10.0.0-alpha.9",
+  "version": "10.1.0-alpha.0",
   "author": "GoodData",
   "description": "GoodData Embedding APIs",
   "repository": {
@@ -29,8 +29,7 @@
     "lodash": "^4.17.19",
     "tslib": "^2.5.0",
     "ts-invariant": "^0.7.5",
-    "@gooddata/api-model-bear": "10.0.0-alpha.9",
-    "@gooddata/sdk-model": "10.0.0-alpha.9"
+    "@gooddata/sdk-model": "10.1.0-alpha.0"
   },
   "devDependencies": {
     "@gooddata/eslint-config": "^4.1.0",