@sap-ux/telemetry 0.2.0

package/dist/tooling-telemetry/data-processor.js

@@ -0,0 +1,354 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spawnCommand = exports.getCommonProperties = exports.processToolsSuiteTelemetry = void 0;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const axios_1 = __importDefault(require("axios"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const yaml_1 = __importDefault(require("yaml"));
+/**
+ * Import with Tree shaking behaviour '@sap/ux-project-access/dist/project/utils'
+ * performance optimization to remove unreachable code automatically from esbuild.
+ * Esbuild will only bundle parts of your packages that you actually use
+ *
+ * Note: Without Tree shaking import '@sap/ux-project-access'
+ * packages consuming telemetry need to add dependencies manually (for ex: sap/cds)
+ * Further, size of generated .vsix will be increased by esbuild
+ */
+const info_1 = require("@sap-ux/project-access/dist/project/info");
+const search_1 = require("@sap-ux/project-access/dist/project/search");
+const cap_1 = require("@sap-ux/project-access/dist/project/cap");
+const types_1 = require("./types");
+const child_process_1 = require("child_process");
+const os_1 = __importDefault(require("os"));
+const config_state_1 = require("./config-state");
+/**
+ * Collect commone properties that needs to be added to telemetry event.
+ *
+ * @param telemetryHelperProperties Pass to report ApplicationInsightClient.report()
+ * @returns Common Fiori project properties
+ */
+function processToolsSuiteTelemetry(telemetryHelperProperties) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const commonProperties = yield getCommonProperties();
+        let appProperties = {};
+        if (telemetryHelperProperties) {
+            appProperties = yield getAppProperties(telemetryHelperProperties['appPath']);
+        }
+        return Object.assign(Object.assign({}, commonProperties), appProperties);
+    });
+}
+exports.processToolsSuiteTelemetry = processToolsSuiteTelemetry;
+/**
+ * Get common properties that related to Fiori project runtime environment.
+ *
+ * @returns Common properties
+ */
+function getCommonProperties() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const commonProperties = {};
+        commonProperties[types_1.CommonProperties.DevSpace] = yield getSbasDevspace();
+        commonProperties[types_1.CommonProperties.AppStudio] = (0, btp_utils_1.isAppStudio)();
+        commonProperties[types_1.CommonProperties.AppStudioBackwardCompatible] = commonProperties[types_1.CommonProperties.AppStudio];
+        commonProperties[types_1.CommonProperties.InternlVsExternal] = getInternalVsExternal();
+        commonProperties[types_1.CommonProperties.InternlVsExternalBackwardCompatible] =
+            commonProperties[types_1.CommonProperties.InternlVsExternal];
+        commonProperties[types_1.CommonProperties.NodeVersion] = (yield getProcessVersions()).node;
+        return commonProperties;
+    });
+}
+exports.getCommonProperties = getCommonProperties;
+/**
+ * Obtain dev space type from SBAS rest api.
+ *
+ * @returns SBAS Dev Space Name. Empty string is returned if unable to fetch workspace type or the environment is not SBAS
+ */
+function getSbasDevspace() {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        if ((0, btp_utils_1.isAppStudio)()) {
+            try {
+                if (!process.env.H2O_URL || !process.env.WORKSPACE_ID) {
+                    return '';
+                }
+                const h20Url = process.env.H2O_URL;
+                const workspaceId = process.env.WORKSPACE_ID.replace('workspaces-', '');
+                const url = `${h20Url}/ws-manager/api/v1/workspace/${workspaceId}`;
+                const response = yield axios_1.default.get(url);
+                if (response.data) {
+                    const workspaceConfig = response.data;
+                    // devspace stored in this path
+                    return (_b = (_a = workspaceConfig === null || workspaceConfig === void 0 ? void 0 : workspaceConfig.config) === null || _a === void 0 ? void 0 : _a.annotations) === null || _b === void 0 ? void 0 : _b.pack;
+                }
+            }
+            catch (error) {
+                // handling error
+            }
+        }
+        return '';
+    });
+}
+/**
+ * Get common properties from a give Fiori project path.
+ *
+ * @param appPath Fiori project path.
+ * @returns Properties to be append to properties in telemetry event
+ */
+function getAppProperties(appPath) {
+    var _a, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!appPath) {
+            return {};
+        }
+        const templateType = yield getTemplateType(appPath);
+        const deployTarget = yield getDeployTarget(appPath);
+        const applicationType = yield (0, info_1.getAppType)(appPath);
+        let odataSource = yield getODataSource(appPath);
+        // Correct logic in getAppType() implementation, if it's reuse lib type, odata source should be unknown
+        if (applicationType === 'Fiori Reuse') {
+            odataSource = types_1.ODataSource.UNKNOWN;
+        }
+        const sourceTemplate = yield getManifestSourceTemplate(appPath);
+        const appProgrammingLanguage = yield (0, info_1.getAppProgrammingLanguage)(appPath);
+        const output = {};
+        output[types_1.CommonProperties.TemplateType] = templateType;
+        output[types_1.CommonProperties.DeployTargetType] = deployTarget;
+        output[types_1.CommonProperties.ODataSourceType] = odataSource;
+        output[types_1.CommonProperties.AppToolsId] = (_a = sourceTemplate.toolsId) !== null && _a !== void 0 ? _a : '';
+        output[types_1.CommonProperties.AppProgrammingLanguage] = appProgrammingLanguage;
+        output[types_1.CommonProperties.TemplateId] = (_b = sourceTemplate.id) !== null && _b !== void 0 ? _b : '';
+        output[types_1.CommonProperties.TemplateVersion] = (_c = sourceTemplate.version) !== null && _c !== void 0 ? _c : '';
+        output[types_1.CommonProperties.ApplicationType] = applicationType !== null && applicationType !== void 0 ? applicationType : '';
+        return output;
+    });
+}
+/**
+ * Read template type from README.md of an Fiori app. This will be improved once we have the floor
+ * plan information added to e.g. manifest.json of generated app.
+ *
+ * @param appPath Root folder path of Fiori app
+ * @returns Template type used in the Fiori app
+ */
+function getTemplateType(appPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const readmeFilePath = path_1.default.join(appPath, 'README.md');
+        if (fs_1.default.existsSync(readmeFilePath)) {
+            const readmeContent = yield fs_1.default.promises.readFile(readmeFilePath, 'utf-8');
+            if (readmeContent) {
+                let templateType = '';
+                const lines = readmeContent.split(/\r?\n/);
+                for (const line of lines) {
+                    // Check if the line matches the pattern |**Template Used**<br>{{TemplateType}}|
+                    const regex = /\|\*\*Template Used\*\*<br>(.*?)\|/;
+                    const match = regex.exec(line);
+                    if (match && match.length >= 2) {
+                        // Extract {{TemplateType}} from the matching pattern
+                        templateType = match[1].trim();
+                        break;
+                    }
+                }
+                return templateType;
+            }
+        }
+        return '';
+    });
+}
+/**
+ * Find OData Source type of a given app folder path.
+ *
+ * @param appPath Root folder path of Fiori app
+ * @returns Project Type ABAP | CAPJava | CAPNode | UNKNOWN
+ */
+function getODataSource(appPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // First attempt: Loop up a folder that contain a pacakge.json that has sapux property as project root
+            // If appPath has package.json that contains sapux, it is EDMX project type and we derive odata source
+            // is ABAP.
+            let projectRoot;
+            try {
+                projectRoot = yield (0, search_1.findProjectRoot)(appPath);
+            }
+            catch (_a) {
+                // No project root can be found
+            }
+            // Second attempt: For FF app, package.json does not have sapux property. Try to find the
+            // first parent folder that contain pacakge.json as CAP root. If no such folder exists,
+            // use appPath as project root.
+            if (!projectRoot) {
+                try {
+                    const appParentFolder = path_1.default.dirname(appPath);
+                    projectRoot = yield (0, search_1.findProjectRoot)(appParentFolder, false);
+                }
+                catch (e) {
+                    // No project root can be found at parent folder.
+                }
+            }
+            // Third attempt: CAPJava that doesn't have package.json at project root. We assume
+            // the project has default structure <projectRoot>/app/<appPath>, and use parent folder
+            // path two levels above appPath as projectRoot. This should cover most cases until we have
+            // a better solution
+            let isCapJavaWithoutPackageJson = false;
+            if (!projectRoot) {
+                const directParentFolder = path_1.default.dirname(appPath);
+                const twoLevelUpParentFolder = path_1.default.dirname(directParentFolder);
+                isCapJavaWithoutPackageJson = yield (0, cap_1.isCapJavaProject)(twoLevelUpParentFolder);
+                projectRoot = isCapJavaWithoutPackageJson ? twoLevelUpParentFolder : appPath;
+            }
+            if (isCapJavaWithoutPackageJson) {
+                return types_1.ODataSource.CAPJava;
+            }
+            const projectType = yield (0, info_1.getProjectType)(projectRoot);
+            return getProjectTypeForTelemetry(projectType);
+        }
+        catch (e) {
+            return types_1.ODataSource.UNKNOWN;
+        }
+    });
+}
+/**
+ * Map ProjectType to values used for telemetry reporting.
+ *
+ * @param projectType ProjectType
+ * @returns Odata source type
+ */
+function getProjectTypeForTelemetry(projectType) {
+    if (projectType === 'EDMXBackend') {
+        return types_1.ODataSource.ABAP;
+    }
+    else if (projectType === 'CAPNodejs') {
+        return types_1.ODataSource.CAPNode;
+    }
+    else if (projectType === 'CAPJava') {
+        return types_1.ODataSource.CAPJava;
+    }
+    else {
+        return types_1.ODataSource.UNKNOWN;
+    }
+}
+/**
+ * Read ui5-deploy.yaml to decide if it is CF or ABAP deploy target.
+ *
+ * @param appPath  appPath Root folder path of Fiori app
+ * @returns CF | ABAP | NO_DEPLOY_CONFIG | UNKNOWN_DEPLOY_CONFIG
+ */
+function getDeployTarget(appPath) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        let deployTarget = types_1.DeployTarget.NO_DEPLOY_CONFIG;
+        const deployConfigPath = path_1.default.join(appPath, 'ui5-deploy.yaml');
+        try {
+            yield fs_1.default.promises.access(deployConfigPath);
+            const deployConfigContent = yield fs_1.default.promises.readFile(deployConfigPath, 'utf-8');
+            const deployConfig = yaml_1.default.parse(deployConfigContent);
+            const customTasks = (_a = deployConfig === null || deployConfig === void 0 ? void 0 : deployConfig.builder) === null || _a === void 0 ? void 0 : _a.customTasks;
+            if (customTasks) {
+                const isAbapDeployTarget = customTasks.some((task) => task.name === 'deploy-to-abap');
+                deployTarget = isAbapDeployTarget ? types_1.DeployTarget.ABAP : types_1.DeployTarget.CF;
+            }
+            else {
+                deployTarget = types_1.DeployTarget.UNKNOWN_DEPLOY_CONFIG;
+            }
+        }
+        catch (_b) {
+            // cannot determine deploy target, use default DeployTarget.NO_DEPLOY_CONFIG
+        }
+        return deployTarget;
+    });
+}
+/**
+ * Convert init setting property internalFeaturesEnabled to string value.
+ *
+ * @returns String value 'internal' | 'external' to be backward compatible with existing telemetry data format.
+ */
+function getInternalVsExternal() {
+    return config_state_1.ToolingTelemetrySettings.internalFeature ? 'internal' : 'external';
+}
+/**
+ * Read the manifest.json for the app and locate the tools id.
+ *
+ * @param appPath appPath Root folder path of Fiori app
+ * @returns sourceTemplate section of data from manifest.json
+ */
+function getManifestSourceTemplate(appPath) {
+    var _a, _b, _c, _d;
+    return __awaiter(this, void 0, void 0, function* () {
+        let sourceTemplate = {};
+        try {
+            const manifestPath = path_1.default.join(appPath, 'webapp', 'manifest.json');
+            if (fs_1.default.existsSync(manifestPath)) {
+                const manifestStr = yield fs_1.default.promises.readFile(manifestPath, 'utf-8');
+                const manifest = JSON.parse(manifestStr);
+                sourceTemplate = (_a = manifest['sap.app']) === null || _a === void 0 ? void 0 : _a.sourceTemplate;
+            }
+        }
+        catch (_e) {
+            // Failed to read manifest.json
+        }
+        sourceTemplate = sourceTemplate !== null && sourceTemplate !== void 0 ? sourceTemplate : {};
+        sourceTemplate.id = (_b = sourceTemplate.id) !== null && _b !== void 0 ? _b : '';
+        sourceTemplate.version = (_c = sourceTemplate.version) !== null && _c !== void 0 ? _c : '';
+        sourceTemplate.toolsId = (_d = sourceTemplate.toolsId) !== null && _d !== void 0 ? _d : types_1.ToolsId.NO_TOOLS_ID;
+        return sourceTemplate;
+    });
+}
+/**
+ * Get node.js runtime version.
+ *
+ * @returns Node.js version
+ */
+function getProcessVersions() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const output = yield spawnCommand('node', ['-p', 'JSON.stringify(process.versions)']);
+            return JSON.parse(output);
+        }
+        catch (_a) {
+            return {};
+        }
+    });
+}
+/**
+ * Spawn a command to find out node.js version used for the runtime.
+ *
+ * @param command command name
+ * @param commandArgs command arguments
+ * @returns Node.js version
+ */
+function spawnCommand(command, commandArgs) {
+    const spawnOptions = process.platform.startsWith('win')
+        ? { windowsVerbatimArguments: true, shell: true, cwd: os_1.default.homedir() }
+        : { cwd: os_1.default.homedir() };
+    return new Promise((resolve, reject) => {
+        let output = '';
+        const spawnProcess = (0, child_process_1.spawn)(command, commandArgs, spawnOptions);
+        spawnProcess.stdout.on('data', (data) => {
+            const newData = data.toString();
+            output += newData;
+        });
+        spawnProcess.stderr.on('data', (data) => {
+            const newData = data.toString();
+            output += newData;
+        });
+        spawnProcess.on('exit', () => {
+            resolve(output);
+        });
+        spawnProcess.on('error', (error) => {
+            reject(error);
+        });
+    });
+}
+exports.spawnCommand = spawnCommand;
+//# sourceMappingURL=data-processor.js.map

package/dist/tooling-telemetry/index.d.ts

@@ -0,0 +1,5 @@
+export * from './telemetry-client';
+export { processToolsSuiteTelemetry } from './data-processor';
+export * from './telemetry-settings';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/tooling-telemetry/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processToolsSuiteTelemetry = void 0;
+__exportStar(require("./telemetry-client"), exports);
+var data_processor_1 = require("./data-processor");
+Object.defineProperty(exports, "processToolsSuiteTelemetry", { enumerable: true, get: function () { return data_processor_1.processToolsSuiteTelemetry; } });
+__exportStar(require("./telemetry-settings"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/tooling-telemetry/telemetry-client.d.ts

@@ -0,0 +1,65 @@
+import { ApplicationInsightClient } from '../base/client/azure-appinsight-client';
+import type { SampleRate } from '../base/types/sample-rate';
+import type { TelemetryHelperProperties, TelemetryEvent } from './types';
+/**
+ *
+ */
+declare class ToolsSuiteTelemetryClient extends ApplicationInsightClient {
+    /**
+     *
+     * @param applicationKey Application key to identify the Azure Application Insight resource
+     * @param extensionName Unique name of the extension in the format of {publisher}.{extension}
+     * @param extensionVersion Conventional version number of the extension
+     */
+    constructor(applicationKey: string, extensionName: string, extensionVersion: string);
+    /**
+     * Send a telemetry event to Azure Application Insights.
+     *
+     * @deprecated Use reportEvent instead.
+     * @param eventName Categorize the type of the event within the scope of an extension.
+     * @param properties A set of string properties to be reported
+     * @param measurements  A set of numeric measurements to be reported
+     * @param sampleRate Sampling the event to be sent
+     * @param telemetryHelperProperties Properties that are passed to the processCommonPropertiesHelper function to assit generate project specific telemetry data
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    report(eventName: string, properties: {
+        [key: string]: string;
+    }, measurements: {
+        [key: string]: number;
+    }, sampleRate: SampleRate | undefined, telemetryHelperProperties?: TelemetryHelperProperties, ignoreSettings?: boolean): Promise<void>;
+    /**
+     * Send a telemetry event to Azure Application Insights.
+     *
+     * @param event Telemetry Event
+     * @param sampleRate Sampling the event to be sent
+     * @param telemetryHelperProperties Properties that are passed to the processCommonPropertiesHelper function to assit generate project specific telemetry data
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    reportEvent(event: TelemetryEvent, sampleRate?: SampleRate, telemetryHelperProperties?: TelemetryHelperProperties, ignoreSettings?: boolean): Promise<void>;
+    /**
+     * Send a telemetry event to Azure Application Insights. This API makes sure the telemetry event
+     * is flushed to Azure backend before executing the next statement. Since this API blocks
+     * normal execution flow, please use this API cautiously. See `reportEvent()` method for non-blocking
+     * usage.
+     *
+     * @param event Telemetry Event
+     * @param sampleRate Sampling the event to be sent
+     * @param telemetryHelperProperties Properties that are passed to the processCommonPropertiesHelper function to assit generate project specific telemetry data
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    reportEventBlocking(event: TelemetryEvent, sampleRate?: SampleRate, telemetryHelperProperties?: TelemetryHelperProperties, ignoreSettings?: boolean): Promise<void>;
+    /**
+     * Add common properties to properties and measurements of consumer's telemetry event.
+     *
+     * @param event telemetry event
+     * @param telemetryHelperProperties Additional properties that can be undefined
+     * @returns Telemetry properties and measurements
+     */
+    private collectToolsSuiteTelemetry;
+}
+export { ToolsSuiteTelemetryClient };
+//# sourceMappingURL=telemetry-client.d.ts.map

package/dist/tooling-telemetry/telemetry-client.js

@@ -0,0 +1,118 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolsSuiteTelemetryClient = void 0;
+const azure_appinsight_client_1 = require("../base/client/azure-appinsight-client");
+const _1 = require(".");
+const date_1 = require("../base/utils/date");
+/**
+ *
+ */
+class ToolsSuiteTelemetryClient extends azure_appinsight_client_1.ApplicationInsightClient {
+    /**
+     *
+     * @param applicationKey Application key to identify the Azure Application Insight resource
+     * @param extensionName Unique name of the extension in the format of {publisher}.{extension}
+     * @param extensionVersion Conventional version number of the extension
+     */
+    constructor(applicationKey, extensionName, extensionVersion) {
+        super(applicationKey, extensionName, extensionVersion);
+    }
+    /**
+     * Send a telemetry event to Azure Application Insights.
+     *
+     * @deprecated Use reportEvent instead.
+     * @param eventName Categorize the type of the event within the scope of an extension.
+     * @param properties A set of string properties to be reported
+     * @param measurements  A set of numeric measurements to be reported
+     * @param sampleRate Sampling the event to be sent
+     * @param telemetryHelperProperties Properties that are passed to the processCommonPropertiesHelper function to assit generate project specific telemetry data
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    report(eventName, properties, measurements, sampleRate, telemetryHelperProperties, ignoreSettings) {
+        const _super = Object.create(null, {
+            report: { get: () => super.report }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const fioriProjectCommonProperties = yield (0, _1.processToolsSuiteTelemetry)(telemetryHelperProperties);
+            const commonProperties = {
+                v: this.extensionVersion,
+                datetime: (0, date_1.localDatetimeToUTC)()
+            };
+            const finalProperties = Object.assign(Object.assign(Object.assign({}, properties), fioriProjectCommonProperties), commonProperties);
+            yield _super.report.call(this, eventName, finalProperties, measurements, sampleRate, telemetryHelperProperties, ignoreSettings);
+        });
+    }
+    /**
+     * Send a telemetry event to Azure Application Insights.
+     *
+     * @param event Telemetry Event
+     * @param sampleRate Sampling the event to be sent
+     * @param telemetryHelperProperties Properties that are passed to the processCommonPropertiesHelper function to assit generate project specific telemetry data
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    reportEvent(event, sampleRate, telemetryHelperProperties, ignoreSettings) {
+        const _super = Object.create(null, {
+            report: { get: () => super.report }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const { finalProperties, finalMeasurements } = yield this.collectToolsSuiteTelemetry(event, telemetryHelperProperties);
+            return _super.report.call(this, event.eventName, finalProperties, finalMeasurements, sampleRate, telemetryHelperProperties, ignoreSettings);
+        });
+    }
+    /**
+     * Send a telemetry event to Azure Application Insights. This API makes sure the telemetry event
+     * is flushed to Azure backend before executing the next statement. Since this API blocks
+     * normal execution flow, please use this API cautiously. See `reportEvent()` method for non-blocking
+     * usage.
+     *
+     * @param event Telemetry Event
+     * @param sampleRate Sampling the event to be sent
+     * @param telemetryHelperProperties Properties that are passed to the processCommonPropertiesHelper function to assit generate project specific telemetry data
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    reportEventBlocking(event, sampleRate, telemetryHelperProperties, ignoreSettings) {
+        const _super = Object.create(null, {
+            reportBlocking: { get: () => super.reportBlocking }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const { finalProperties, finalMeasurements } = yield this.collectToolsSuiteTelemetry(event, telemetryHelperProperties);
+            return _super.reportBlocking.call(this, event.eventName, finalProperties, finalMeasurements, sampleRate, ignoreSettings);
+        });
+    }
+    /**
+     * Add common properties to properties and measurements of consumer's telemetry event.
+     *
+     * @param event telemetry event
+     * @param telemetryHelperProperties Additional properties that can be undefined
+     * @returns Telemetry properties and measurements
+     */
+    collectToolsSuiteTelemetry(event, telemetryHelperProperties) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fioriProjectCommonProperties = yield (0, _1.processToolsSuiteTelemetry)(telemetryHelperProperties);
+            const telemetryEventCommonProperties = {
+                v: this.extensionVersion,
+                datetime: (0, date_1.localDatetimeToUTC)()
+            };
+            const finalProperties = Object.assign(Object.assign(Object.assign({}, event.properties), fioriProjectCommonProperties), telemetryEventCommonProperties);
+            const finalMeasurements = Object.assign({}, event.measurements);
+            return {
+                finalProperties,
+                finalMeasurements
+            };
+        });
+    }
+}
+exports.ToolsSuiteTelemetryClient = ToolsSuiteTelemetryClient;
+//# sourceMappingURL=telemetry-client.js.map

package/dist/tooling-telemetry/telemetry-settings.d.ts

@@ -0,0 +1,22 @@
+import type { ToolsSuiteTelemetryInitSettings } from './types';
+import { TelemetrySetting } from '@sap-ux/store';
+/**
+ * Telemetry API function to init settings.
+ *
+ * @param options Settings pass from the consumer module.
+ */
+export declare const initTelemetrySettings: (options: ToolsSuiteTelemetryInitSettings) => Promise<void>;
+/**
+ * Toggle on/off enable telemetry setting. This will update telemetry settings file
+ * and the runtime setting.
+ *
+ * @param enableTelemetry Telemetry is enabled or not
+ */
+export declare function setEnableTelemetry(enableTelemetry: boolean): Promise<void>;
+/**
+ * Get telemetry settings.
+ *
+ * @returns Telemetry settings of context module that consumes telemetry library
+ */
+export declare function getTelemetrySetting(): Promise<TelemetrySetting | undefined>;
+//# sourceMappingURL=telemetry-settings.d.ts.map