@gooddata/sdk-ui-analytical-designer 0.0.0-stage → 11.65.0-alpha.10

package/esm/services/reference_point_service.js

@@ -0,0 +1,155 @@
+// (C) 2007-2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+import { getGeoLabelTypeFromVisualization } from "../constants/geo.js";
+import { isDerived, isMeasure } from "../models/bucket_item.js";
+import { isUnmodifiedAndAutoCreated } from "../store/buckets/buckets_meta_helpers.js";
+import { FilterBar, normalizeMeasureValueFilterConditions, } from "../store/filter_bar/filter_bar_types.js";
+import { getUiConfigLocationIcon, isUiConfigChartFillSupported, isUiConfigLocationIconSupported, } from "../store/reference_point/extended_reference_point_selectors.js";
+import { getReferencePointBuckets, getReferencePointFilters, } from "../store/reference_point/reference_point_selectors.js";
+import { getVisualizationClassTypeFromState } from "./visualization_class_service.js";
+export function getRefPointBuckets(state) {
+    return getReferencePointBuckets(state);
+}
+export function getRefPointFilters(state) {
+    return getReferencePointFilters(state);
+}
+export const getActiveGeoLabelType = (state) => {
+    const iconSupported = isUiConfigLocationIconSupported(state);
+    if (!iconSupported) {
+        return undefined;
+    }
+    const configuredLabelType = getUiConfigLocationIcon(state)?.type;
+    if (configuredLabelType) {
+        return configuredLabelType;
+    }
+    const visualizationType = getVisualizationClassTypeFromState(state);
+    return getGeoLabelTypeFromVisualization(visualizationType) ?? "location";
+};
+export const isLocationIconEnabled = (state) => {
+    return Boolean(getActiveGeoLabelType(state));
+};
+export const isChartFillEnabled = (state) => {
+    return isUiConfigChartFillSupported(state);
+};
+export function getRefPointFilteredMeasures(state, filterAssert) {
+    // referencePoint.buckets holds the live buckets value BY REFERENCE
+    return getRefPointBuckets(state)
+        .flatMap((bucket) => bucket.items ?? [])
+        .filter((bucketItem) => isMeasure(bucketItem) && filterAssert(bucketItem));
+}
+export function getRefPointNonDerivedMeasures(state) {
+    return getRefPointFilteredMeasures(state, (bucketItem) => !isDerived(bucketItem));
+}
+export function getRefPointDerivedMeasures(state) {
+    return getRefPointFilteredMeasures(state, isDerived);
+}
+function convertDateFilterToRefPointFilter(dateFilter, bucketsMeta) {
+    return {
+        localIdentifier: dateFilter.localIdentifier,
+        autoCreated: isUnmodifiedAndAutoCreated(dateFilter.cacheItemIdentifier, bucketsMeta),
+        filters: [
+            {
+                overTimeComparisonType: dateFilter.overTimeComparisonType,
+                emptyDateValuesFilter: dateFilter.emptyDateValuesFilter,
+                interval: dateFilter.filterConfig || {
+                    name: "all_time",
+                },
+                attribute: dateFilter.cacheItemIdentifier,
+                ...(dateFilter.filterConfig?.boundedFilter
+                    ? { boundedFilter: dateFilter.filterConfig.boundedFilter }
+                    : {}),
+            },
+        ],
+        attribute: dateFilter.cacheItemIdentifier,
+        dateDatasetRef: dateFilter.dateDatasetRef,
+    };
+}
+function convertAttributeFilterToRefPointFilter(attributeFilter, bucketsMeta) {
+    const { filterConfig, textModeFilter } = attributeFilter;
+    return {
+        localIdentifier: attributeFilter.localIdentifier,
+        autoCreated: isUnmodifiedAndAutoCreated(attributeFilter.cacheItemIdentifier, bucketsMeta),
+        filters: filterConfig || textModeFilter
+            ? [
+                {
+                    attribute: attributeFilter.cacheItemIdentifier,
+                    displayFormRef: attributeFilter.displayFormRef,
+                    allElements: [],
+                    selectedElements: filterConfig?.selectedElements ?? [],
+                    isInverted: filterConfig?.isInverted ?? false,
+                    totalElementsCount: filterConfig?.totalElementsCount ?? 0,
+                    ...(textModeFilter ? { textModeFilter } : {}),
+                },
+            ]
+            : [],
+        attribute: attributeFilter.cacheItemIdentifier,
+    };
+}
+function convertMeasureValueFilterToRefPointFilter(measureValueFilter) {
+    const { measureLocalIdentifier, measureRef, dimensionality, applyOnResult } = measureValueFilter;
+    const conditions = normalizeMeasureValueFilterConditions(measureValueFilter);
+    const conditionsProps = isEmpty(conditions) ? {} : { conditions };
+    const dimensionalityProps = dimensionality?.length ? { dimensionality } : {};
+    const applyOnResultProp = applyOnResult === undefined ? {} : { applyOnResult };
+    // Catalog measures use measureRef, bucket measures use measureLocalIdentifier
+    const measureProps = FilterBar.isCatalogMeasureValueFilter(measureValueFilter)
+        ? { measureRef }
+        : { measureLocalIdentifier };
+    return {
+        localIdentifier: measureValueFilter.localIdentifier,
+        autoCreated: false,
+        ...applyOnResultProp,
+        filters: [
+            {
+                ...measureProps,
+                ...conditionsProps,
+                ...dimensionalityProps,
+            },
+        ],
+    };
+}
+function convertRankingFilterToRefPointFilter(rankingFilter) {
+    const { measureLocalIdentifier, measureRef, attributes, operator, value, applyOnResult, strictLimitOfRows, } = rankingFilter;
+    const conditionProps = isEmpty(attributes) ? {} : { attributes: attributes };
+    const applyOnResultProp = applyOnResult === undefined ? {} : { applyOnResult };
+    const strictLimitOfRowsProp = strictLimitOfRows === undefined ? {} : { strictLimitOfRows };
+    // Catalog measures are referenced by measureRef, bucket measures by their localIdentifier.
+    const measureProps = FilterBar.isCatalogRankingFilter(rankingFilter)
+        ? { measureRef }
+        : { measure: measureLocalIdentifier };
+    return {
+        localIdentifier: rankingFilter.localIdentifier,
+        autoCreated: false,
+        ...applyOnResultProp,
+        ...strictLimitOfRowsProp,
+        filters: [
+            {
+                ...measureProps,
+                ...conditionProps,
+                operator,
+                value,
+            },
+        ],
+    };
+}
+function convertFilterToRefPointFilter(filter, bucketsMeta) {
+    if (FilterBar.isDateFilter(filter)) {
+        return convertDateFilterToRefPointFilter(filter, bucketsMeta);
+    }
+    if (FilterBar.isAttributeFilter(filter)) {
+        return convertAttributeFilterToRefPointFilter(filter, bucketsMeta);
+    }
+    if (FilterBar.isMeasureValueFilter(filter)) {
+        return convertMeasureValueFilterToRefPointFilter(filter);
+    }
+    if (FilterBar.isRankingFilter(filter)) {
+        return convertRankingFilterToRefPointFilter(filter);
+    }
+    throw new Error("Unsupported filter type");
+}
+export function convertFiltersToRefPoint(filters, bucketsMeta) {
+    return {
+        localIdentifier: "filters",
+        items: filters.map((filter) => convertFilterToRefPointFilter(filter, bucketsMeta)),
+    };
+}

package/esm/services/report_service.d.ts

@@ -0,0 +1,22 @@
+import { type IInsightDefinition, type ObjRef } from "@gooddata/sdk-model";
+import { type IAppState } from "../store/types.js";
+import { type IVisualization, type IBucket as IVisualizationObjectBucket, type VisualizationObjectExtendedFilter } from "../typings/bear/bearTypes.js";
+import { type IElement, type IFilterConfiguration } from "../typings/measure_filters.js";
+import { type IReport } from "../typings/report.js";
+export declare function getReportTitle(state: IAppState): string;
+export declare function isReportTitleEmpty(state: IAppState): boolean;
+export declare function getNewReportMDObject(state: IAppState): IReport;
+export declare function getVisualizationObjectForSave(state: IAppState): IVisualization;
+export declare function getVisualizationForExportFromInsight(state: IAppState, title: string, insight: IInsightDefinition): IReport;
+export declare const getFilterItemsDefinitions: (buckets: IVisualizationObjectBucket[], filters: VisualizationObjectExtendedFilter[]) => IFilterConfiguration[];
+export declare const indexValidElements: (validElements: Array<{
+    filterItemsRef: ObjRef;
+    items: IElement[];
+    total: number;
+}>) => {
+    [uri: string]: {
+        items: IElement[];
+        total: number;
+    };
+};
+//# sourceMappingURL=report_service.d.ts.map

package/esm/services/report_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report_service.d.ts","sourceRoot":"","sources":["../../src/services/report_service.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,MAAM,EAA4B,MAAM,qBAAqB,CAAC;AAQrG,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EACH,KAAK,cAAc,EACnB,KAAK,OAAO,IAAI,0BAA0B,EAG1C,KAAK,iCAAiC,EAKzC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACzF,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAgBpD,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,UAE9C;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,WAElD;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAgB9D;AAED,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,SAAS,kBAM7D;AAED,wBAAgB,oCAAoC,CAChD,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,kBAAkB,GAC5B,OAAO,CAiCT;AA8CD,eAAO,MAAM,yBAAyB,YACzB,0BAA0B,EAAE,WAC5B,iCAAiC,EAAE,2BAgB/C,CAAC;AAEF,eAAO,MAAM,kBAAkB,kBACZ,KAAK,CAAC;IAAE,cAAc,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,KACnF;IACC,CAAC,GAAG,EAAE,MAAM,GAAG;QACX,KAAK,EAAE,QAAQ,EAAE,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CA0BL,CAAC"}

package/esm/services/report_service.js

@@ -0,0 +1,133 @@
+// (C) 2007-2026 GoodData Corporation
+import { has, isEqual, truncate, uniq, uniqWith } from "lodash-es";
+import { isUriRef, objRefToString } from "@gooddata/sdk-model";
+import { MAX_TITLE_LENGTH } from "../constants/report.js";
+import { BearToBackendConvertors } from "../convertors/index.js";
+import { currentReportMDObject } from "../selectors/buckets_selector.js";
+import { getInsightForSaveViaMd } from "../selectors/insight_selectors.js";
+import { getInsightTitle } from "../store/insight/insight_selectors.js";
+import { getLastSavedObject } from "../store/report/report_selectors.js";
+import { isVisualizationObjectMeasure, isVisualizationObjectNegativeAttributeFilter, isVisualizationObjectPositiveAttributeFilter, } from "../typings/bear/bearTypes.js";
+import { convertModelInsightToADRep } from "../utils/sdkModelToADRep/InsightConverter.js";
+const measureOf = (item) => item?.measure;
+export function getReportTitle(state) {
+    return getInsightTitle(state);
+}
+export function isReportTitleEmpty(state) {
+    return getReportTitle(state) === "";
+}
+export function getNewReportMDObject(state) {
+    const createdReportMDObjectContent = currentReportMDObject(state);
+    // through the domain accessor: the leaf is absent on the pristine post-reset state
+    const lastReportObject = getLastSavedObject(state);
+    return {
+        ...lastReportObject,
+        visualizationObject: {
+            ...lastReportObject.visualizationObject,
+            content: createdReportMDObjectContent,
+            meta: {
+                ...lastReportObject.visualizationObject?.meta,
+                title: getReportTitle(state),
+            },
+        },
+    };
+}
+export function getVisualizationObjectForSave(state) {
+    const visualization = {
+        visualizationObject: convertModelInsightToADRep(getInsightForSaveViaMd(state), true),
+    };
+    return visualization;
+}
+export function getVisualizationForExportFromInsight(state, title, insight) {
+    const visualization = getNewReportMDObject(state);
+    // to be able to call the fillMissingTitles method, we have to have an insight here as well...
+    const mdObjectWithFilledTitles = BearToBackendConvertors.convertInsightDefinition(insight);
+    const bucketsWithTruncatedTitles = mdObjectWithFilledTitles.content.buckets.map((bucket) => ({
+        ...bucket,
+        items: (bucket.items ?? []).map((item) => {
+            const measure = measureOf(item);
+            return has(item, "measure")
+                ? {
+                    ...item,
+                    measure: { ...measure, title: truncate(measure?.title, { length: MAX_TITLE_LENGTH }) },
+                }
+                : item;
+        }),
+    }));
+    return {
+        ...visualization,
+        visualizationObject: {
+            ...visualization.visualizationObject,
+            content: {
+                ...visualization.visualizationObject.content,
+                buckets: bucketsWithTruncatedTitles,
+            },
+            meta: {
+                ...visualization.visualizationObject.meta,
+                title,
+            },
+        },
+    };
+}
+const isAttributeFilter = (filter) => has(filter, "positiveAttributeFilter") || has(filter, "negativeAttributeFilter");
+const joinFilterConfigurations = (configs) => {
+    const accumulator = {};
+    return configs.reduce((acc, { dfUri, elementUris = [] }) => {
+        const config = acc[dfUri] || { dfUri, elementUris };
+        return {
+            ...acc,
+            [dfUri]: {
+                ...config,
+                elementUris: uniq([...config.elementUris, ...elementUris]),
+            },
+        };
+    }, accumulator);
+};
+const getVisualizationFilterConfiguration = (filter) => {
+    const positive = isVisualizationObjectPositiveAttributeFilter(filter)
+        ? filter.positiveAttributeFilter
+        : undefined;
+    const negative = isVisualizationObjectNegativeAttributeFilter(filter)
+        ? filter.negativeAttributeFilter
+        : undefined;
+    const displayForm = positive?.displayForm ?? negative?.displayForm;
+    const dfUri = isUriRef(displayForm) ? displayForm.uri : undefined;
+    const elementUris = positive?.in || negative?.notIn;
+    return {
+        dfUri,
+        elementUris,
+    };
+};
+export const getFilterItemsDefinitions = (buckets, filters) => {
+    const measureFilters = buckets.reduce((acc, bucket) => {
+        const bucketMeasureFilters = bucket.items.flatMap((item) => isVisualizationObjectMeasure(item) && "measureDefinition" in item.measure.definition
+            ? (item.measure.definition.measureDefinition.filters ?? [])
+            : []);
+        return acc.concat(bucketMeasureFilters.filter(isAttributeFilter));
+    }, []);
+    const attributeFilters = [...measureFilters, ...filters].filter(isAttributeFilter);
+    const configurations = attributeFilters.map(getVisualizationFilterConfiguration);
+    return Object.values(joinFilterConfigurations(configurations));
+};
+export const indexValidElements = (validElements) => {
+    const accumulator = {};
+    return validElements.reduce((filterItems, result) => {
+        // in case there is already filterItemsRef but contains different elements
+        if (filterItems[objRefToString(result.filterItemsRef)]) {
+            return {
+                ...filterItems,
+                [objRefToString(result.filterItemsRef)]: {
+                    items: uniqWith([...result.items, ...filterItems[objRefToString(result.filterItemsRef)].items], isEqual),
+                    total: result.total,
+                },
+            };
+        }
+        return {
+            ...filterItems,
+            [objRefToString(result.filterItemsRef)]: {
+                items: result.items,
+                total: result.total,
+            },
+        };
+    }, accumulator);
+};

package/esm/services/telemetry/custom_dimensions.d.ts

@@ -0,0 +1,10 @@
+import { type IAppState } from "../../store/types.js";
+export declare const getCustomDimensions: (state: IAppState) => {
+    dimension2: string | undefined;
+    dimension3: string | undefined;
+    dimension4: string | undefined;
+    dimension5: string | undefined;
+    dimension8: string;
+    dimension9: string | undefined;
+};
+//# sourceMappingURL=custom_dimensions.d.ts.map

package/esm/services/telemetry/custom_dimensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom_dimensions.d.ts","sourceRoot":"","sources":["../../../src/services/telemetry/custom_dimensions.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEtD,eAAO,MAAM,mBAAmB,UAAW,SAAS;IAEhD,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IAGV,UAAU;IACV,UAAU;CACZ,CAAC"}

package/esm/services/telemetry/custom_dimensions.js

@@ -0,0 +1,14 @@
+// (C) 2021-2026 GoodData Corporation
+import { getOrganizationName, getProjectId, getProjectTemplate, getUserEmailDomain, getUserLoginMD5, } from "../../selectors/bootstrap_selector.js";
+import { getViewportInfo } from "../../selectors/meta_selector.js";
+export const getCustomDimensions = (state) => ({
+    // dimension1: 'Logged-in' / 'Guest' is used in old client only
+    dimension2: getUserLoginMD5(state),
+    dimension3: getUserEmailDomain(state),
+    dimension4: getOrganizationName(state),
+    dimension5: getProjectId(state),
+    // dimension6: origin used in interactive reports
+    // dimension7: 'dashboard id' is used in new dashboards
+    dimension8: getViewportInfo(state),
+    dimension9: getProjectTemplate(state),
+});

package/esm/services/telemetry/custom_variables.d.ts

@@ -0,0 +1,12 @@
+import { type IInsightDefinition } from "@gooddata/sdk-model";
+import { type IAppState } from "../../store/types.js";
+export type InsightStats = {
+    visType: string;
+    bucketNames: string[];
+    propertyNames: string[];
+    measureGroupDimension?: string;
+    columnHeadersPosition?: string;
+};
+export declare function getInsightStats(insight: IInsightDefinition): InsightStats;
+export declare const getWorkspaceId: (state: IAppState) => string | undefined;
+//# sourceMappingURL=custom_variables.d.ts.map

package/esm/services/telemetry/custom_variables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom_variables.d.ts","sourceRoot":"","sources":["../../../src/services/telemetry/custom_variables.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,kBAAkB,EAI1B,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAKtD,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC,CAAC;AAqBF,wBAAgB,eAAe,CAAC,OAAO,EAAE,kBAAkB,GAAG,YAAY,CAMzE;AAED,eAAO,MAAM,cAAc,UAAW,SAAS,uBAAwB,CAAC"}

package/esm/services/telemetry/custom_variables.js

@@ -0,0 +1,29 @@
+// (C) 2021-2026 GoodData Corporation
+import { insightBuckets, insightProperties, insightVisualizationUrl, } from "@gooddata/sdk-model";
+import { getProjectId } from "../../selectors/bootstrap_selector.js";
+const MEASURE_GROUP_DIMENSION_CONTROLS = "measureGroupDimension";
+const COLUMN_HEADERS_POSITION_CONTROLS = "columnHeadersPosition";
+function controlsToUpdate(key) {
+    return key === MEASURE_GROUP_DIMENSION_CONTROLS || key === COLUMN_HEADERS_POSITION_CONTROLS;
+}
+function getInsightConfiguration(insight) {
+    const controls = insightProperties(insight)?.["controls"] ?? {};
+    const updatedControls = [];
+    Object.entries(controls).forEach(([key, value]) => {
+        if (controlsToUpdate(key)) {
+            updatedControls.push(`${key}=${value}`);
+        }
+        else {
+            updatedControls.push(key);
+        }
+    });
+    return updatedControls;
+}
+export function getInsightStats(insight) {
+    return {
+        visType: insightVisualizationUrl(insight),
+        bucketNames: insightBuckets(insight).map((bucket) => bucket.localIdentifier ?? "unknown_bucket"),
+        propertyNames: getInsightConfiguration(insight),
+    };
+}
+export const getWorkspaceId = (state) => getProjectId(state);

package/esm/services/telemetry/openTelemetry/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const SERVICE_NAME = "ui-ad";
+export declare const VERSION = "0.0.1";
+//# sourceMappingURL=constants.d.ts.map

package/esm/services/telemetry/openTelemetry/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/services/telemetry/openTelemetry/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,YAAY,UAAU,CAAC;AACpC,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/esm/services/telemetry/openTelemetry/constants.js

@@ -0,0 +1,3 @@
+// (C) 2023-2026 GoodData Corporation
+export const SERVICE_NAME = "ui-ad";
+export const VERSION = "0.0.1";

package/esm/services/telemetry/tracker.d.ts

@@ -0,0 +1,174 @@
+import { type InsightStats } from "./custom_variables.js";
+export type TrackingPayloadType = "event" | "page" | "timing";
+export interface ITrackingPayload {
+    _type: TrackingPayloadType;
+}
+export interface IEventTrackingPayload extends ITrackingPayload {
+    _type: "event";
+    workspaceId: string;
+    reportId?: string;
+    /**
+     * Event category. If not specified will be defaulted to `analyticalDesigner`
+     */
+    category?: string;
+    action: string;
+    label: string;
+    value?: number | string;
+    insightStats?: InsightStats;
+    dataSamplingPercentage?: number;
+    [key: string]: unknown;
+}
+export interface IPageViewTrackingPayload extends ITrackingPayload {
+    _type: "page";
+    workspaceId: string;
+    reportId?: string;
+    page?: string;
+    location?: string;
+    [key: string]: unknown;
+}
+export interface ITimingTrackingPayload extends ITrackingPayload {
+    _type: "timing";
+    label: string;
+    value: number;
+    variable: string;
+    [key: string]: unknown;
+}
+export type AnyTrackingPayload = IEventTrackingPayload | IPageViewTrackingPayload | ITimingTrackingPayload;
+export declare class TelemetryTracker {
+    private trackers;
+    private isSendingEvents;
+    private hasReplayedAccumulated;
+    /**
+     * When all trackers are loaded and registered, keeps record of accumulated events
+     * and propagates it to current trackers.
+     *
+     * @remarks
+     * The accumulator buffers events emitted before the first initialization and is never drained, so the
+     * replay below runs only once. This tracker is a module-level singleton that survives host
+     * unmount→remount (pluggable mode), where the telemetry bootstrap re-runs on every mount — without the
+     * guard those early buffered events would be re-forwarded to the host on each remount.
+     */
+    startReportingEvents(): void;
+    /**
+     * Register new tracker.
+     *
+     * @param tracker - tracker to register
+     */
+    registerTracker(tracker: AbstractAnalyticsTracker): void;
+    /**
+     * Iterates through existing trackers and sends application event.
+     *
+     * @param payload - event payload
+     */
+    trackEvent(payload: IEventTrackingPayload): void;
+    /**
+     * Iterates through existing trackers and sends application page view.
+     *
+     * @param payload - page view payload
+     */
+    trackPageView(payload: IPageViewTrackingPayload): void;
+    /**
+     * Iterates through existing trackers and sends application timing information.
+     *
+     * @param payload - timing payload
+     */
+    trackTiming(payload: ITimingTrackingPayload): void;
+}
+/**
+ * Abstract superclass for all trackers. This already implements some base functionality and
+ * through the different abstract methods specifies the interface to implement in the concrete trackers.
+ *
+ * The different implementations need to transform the payload to whatever the backend accepts and send it
+ * out.
+ */
+export declare abstract class AbstractAnalyticsTracker extends TelemetryTracker {
+    /**
+     * Tracks application event.
+     *
+     * @param payload - event payload
+     */
+    abstract trackEvent(payload: IEventTrackingPayload): void;
+    /**
+     * Tracks application page view.
+     *
+     * @param payload - page view payload
+     */
+    abstract trackPageView(payload: IPageViewTrackingPayload): void;
+    /**
+     * Tracks application timing information.
+     *
+     * @param payload - timing payload
+     */
+    abstract trackTiming(payload: ITimingTrackingPayload): void;
+    /**
+     * Some tracker implementations may accumulating tracking payloads instead of sending them out. Those
+     * trackers should return the accumulated events through
+     */
+    getAccumulated(): AnyTrackingPayload[];
+    /**
+     * Returns whether actual tracker is of type accumulative or not.
+     */
+    abstract isAccumulatorTracker(): boolean;
+    /**
+     * Track all payloads that may be accumulated in the 'other' tracker.
+     *
+     * @param other - the other tracker with accumulated payloads
+     */
+    trackAccumulated(other: AbstractAnalyticsTracker): void;
+}
+/**
+ * This implementation of analytics tracker will hoard the different payloads to track in the order which they
+ * are submitted. The tracker will not do anything apart from that. The accumulated payloads can be retrieved
+ * at later time.
+ *
+ * The purpose of this tracker is to hold onto various tracking payloads that the app MAY try to dispatch before
+ * the tracking is fully initialized. This can happen in some contexts - such as in Tiger where the tracking is
+ * only enabled later on as the app learns whether the telemetry is setup for the current user.
+ */
+export declare class AccumulatingTracker extends AbstractAnalyticsTracker {
+    private readonly accumulator;
+    trackEvent(payload: IEventTrackingPayload): void;
+    trackPageView(payload: IPageViewTrackingPayload): void;
+    trackTiming(payload: ITimingTrackingPayload): void;
+    getAccumulated(): AnyTrackingPayload[];
+    isAccumulatorTracker(): boolean;
+}
+/**
+ * This implementation of analytics tracker does nothing. It sinks all the events.
+ */
+export declare class NoopAnalyticsTracker extends AbstractAnalyticsTracker {
+    trackEvent(_payload: IEventTrackingPayload): void;
+    trackPageView(_payload: IPageViewTrackingPayload): void;
+    trackTiming(_payload: ITimingTrackingPayload): void;
+    isAccumulatorTracker(): boolean;
+}
+/**
+ * Host shell telemetry callbacks, as supplied to a pluggable application at mount time.
+ *
+ * @remarks
+ * Structurally mirrors `IPluggableAppTelemetryCallbacks` from `@gooddata/sdk-pluggable-application-model`.
+ * It is duplicated here so this legacy runtime does not take on a new package dependency; the real type
+ * from the module is structurally assignable to it.
+ */
+export interface IHostTelemetryCallbacks {
+    trackEvent: (eventName: string, data?: Record<string, unknown>, options?: {
+        channel?: "standard" | "ai";
+    }) => void;
+    trackPageView: (page: string, data?: Record<string, unknown>) => void;
+    trackTiming: (variable: string, label: string, valueMs: number, data?: Record<string, unknown>) => void;
+}
+/**
+ * Tracker used when Analytical Designer runs as a pluggable application: instead of talking to its own
+ * page-level providers, it forwards every payload to the host shell's telemetry
+ * callbacks. The host owns provider configuration and tags forwarded events with the source application id.
+ */
+export declare class HostForwardingTracker extends AbstractAnalyticsTracker {
+    private callbacks;
+    constructor(callbacks: IHostTelemetryCallbacks | undefined);
+    setCallbacks(callbacks: IHostTelemetryCallbacks | undefined): void;
+    trackEvent(payload: IEventTrackingPayload): void;
+    trackPageView(payload: IPageViewTrackingPayload): void;
+    trackTiming(payload: ITimingTrackingPayload): void;
+    isAccumulatorTracker(): boolean;
+}
+//# sourceMappingURL=tracker.d.ts.map

package/esm/services/telemetry/tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["../../../src/services/telemetry/tracker.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAY1D,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE9D,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC3D,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D,KAAK,EAAE,QAAQ,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,GAAG,wBAAwB,GAAG,sBAAsB,CAAC;AAM3G,qBAAa,gBAAgB;IACzB,OAAO,CAAC,QAAQ,CAAkC;IAClD,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,sBAAsB,CAAkB;IAEhD;;;;;;;;;OASG;IACI,oBAAoB,SAe1B;IAED;;;;OAIG;IACI,eAAe,CAAC,OAAO,EAAE,wBAAwB,QAEvD;IAED;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,qBAAqB,QAM/C;IAED;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,wBAAwB,QAMrD;IAED;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,sBAAsB,QAMjD;CACJ;AAED;;;;;;GAMG;AACH,8BAAsB,wBAAyB,SAAQ,gBAAgB;IACnE;;;;OAIG;IACH,SAAyB,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE1E;;;;OAIG;IACH,SAAyB,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEhF;;;;OAIG;IACH,SAAyB,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAE5E;;;OAGG;IACI,cAAc,IAAI,kBAAkB,EAAE,CAE5C;IAED;;OAEG;IACH,SAAgB,oBAAoB,IAAI,OAAO,CAAC;IAEhD;;;;OAIG;IACI,gBAAgB,CAAC,KAAK,EAAE,wBAAwB,GAAG,IAAI,CAiB7D;CACJ;AAED;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,SAAQ,wBAAwB;IAC7D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA4B;IAExC,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAE/D;IAEe,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAErE;IAEe,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAEjE;IAEe,cAAc,IAAI,kBAAkB,EAAE,CAErD;IAEM,oBAAoB,IAAI,OAAO,CAErC;CACJ;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,wBAAwB;IACvD,UAAU,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAG;IAEpD,aAAa,CAAC,QAAQ,EAAE,wBAAwB,GAAG,IAAI,CAAG;IAE1D,WAAW,CAAC,QAAQ,EAAE,sBAAsB,GAAG,IAAI,CAAG;IAEtD,oBAAoB,IAAI,OAAO,CAErC;CACJ;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IACpC,UAAU,EAAE,CACR,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;KAAE,KACxC,IAAI,CAAC;IACV,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACtE,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;CAC3G;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;IACnD,OAAO,CAAC,SAAS;IAA7B,YAAoB,SAAS,EAAE,uBAAuB,GAAG,SAAS,EAEjE;IAEM,YAAY,CAAC,SAAS,EAAE,uBAAuB,GAAG,SAAS,GAAG,IAAI,CAExE;IAEM,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAwBtD;IAEM,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAW5D;IAEM,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAExD;IAEM,oBAAoB,IAAI,OAAO,CAErC;CACJ"}