@sap-ux/telemetry 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,27 @@
+# @sap-ux/telemetry
+
+This library is used by SAP Fiori tools to collect anonymous usage data to guide Fiori tools improvement. This library is
+specific for SAP Fiori tools's telemtry infrastrcture deployed on Azure cloud and it is built on Azure Application Insight node.js client. It is open sourced becaused some open sourced modules of Fiori tools need it for collecting usage data.
+
+
+## Installation
+Npm
+`npm install --save @sap-ux/telemetry`
+
+Yarn
+`yarn add @sap-ux/telemetry`
+
+Pnpm
+`pnpm add @sap-ux/telemetry`
+
+## Example Usage
+
+See code in example folder for basic usage. To run example:
+
+```shell
+# At project root folder of @sap-ux/telemetry
+cd package/telemetry
+# Create a file with name .env
+# Add this line in .env file OpenUxTools_ResourceId=<your_azure_instrument_key>
+pnpm example
+```

package/dist/base/client/azure-appinsight-client.d.ts

@@ -0,0 +1,88 @@
+import { Client } from './client';
+import { SampleRate } from '../types/sample-rate';
+/**
+ *
+ */
+declare class ApplicationInsightClient extends Client {
+    private clients;
+    /**
+     *
+     * @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. 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 `report()` method for non-blocking
+     * usage.
+     *
+     * @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 ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    reportBlocking(eventName: string, properties: {
+        [key: string]: string | boolean;
+    }, measurements: {
+        [key: string]: number;
+    }, sampleRate: SampleRate | undefined, ignoreSettings?: boolean): Promise<void>;
+    /**
+     * Send a telemetry event to Azure Application Insights. The telemetry event sending is still non-blocking
+     * in this API. To make sure telemetry event is sent to Azure backend before next statement, please see
+     * `reportBlocking()`.
+     *
+     * @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 specific TelemetryClient for generating specific properties (E.g. ToolsSuiteTelemetryClient)
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     */
+    report(eventName: string, properties: {
+        [key: string]: string | boolean;
+    }, measurements: {
+        [key: string]: number;
+    }, sampleRate: SampleRate | undefined, telemetryHelperProperties?: {
+        [key: string]: string;
+    }, ignoreSettings?: boolean): Promise<void>;
+    /**
+     * Provide specification of telemetry event to be sent.
+     *
+     * @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
+     * @returns TelemetryClient instance and telemetry event
+     */
+    private prepareClientAndEvent;
+    /**
+     * Send telemetry event in blocking style. It blocks
+     * the subsequent statements until telemetry event has been sent.
+     *
+     * @param client TelemetryClient instance
+     * @param event Telemetry event
+     * @returns Promise<void>
+     */
+    private trackEventBlocking;
+    /**
+     * Send teleemtry event in non-blocking fashion.
+     *
+     * @param client Telemetry client instance
+     * @param event Telemetry event
+     * @returns Send telemetry succeeded or not
+     */
+    private trackEvent;
+    /**
+     * Create telemetry client instance based on sample rate.
+     *
+     * @param sampleRate Sampling telemetry event
+     * @returns Telemetry client instance
+     */
+    private createTelemetryClient;
+}
+export { ApplicationInsightClient };
+//# sourceMappingURL=azure-appinsight-client.d.ts.map

package/dist/base/client/azure-appinsight-client.js

@@ -0,0 +1,195 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.ApplicationInsightClient = void 0;
+const client_1 = require("./client");
+const appInsights = __importStar(require("applicationinsights"));
+const event_header_1 = require("../types/event-header");
+const sample_rate_1 = require("../types/sample-rate");
+const azure_client_config_1 = require("../utils/azure-client-config");
+const config_state_1 = require("../config-state");
+/**
+ *
+ */
+class ApplicationInsightClient extends client_1.Client {
+    /**
+     *
+     * @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();
+        this.clients = new Map();
+        super.applicationKey = applicationKey;
+        this.extensionVersion = extensionVersion;
+        this.extensionName = extensionName;
+        const clientOnePercent = this.createTelemetryClient(sample_rate_1.SampleRate.OnePercent);
+        const clientTenPercent = this.createTelemetryClient(sample_rate_1.SampleRate.TenPercent);
+        const clientNoSampling = this.createTelemetryClient(sample_rate_1.SampleRate.NoSampling);
+        this.clients.set(sample_rate_1.SampleRate.OnePercent, clientOnePercent);
+        this.clients.set(sample_rate_1.SampleRate.TenPercent, clientTenPercent);
+        this.clients.set(sample_rate_1.SampleRate.NoSampling, clientNoSampling);
+    }
+    /**
+     * 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 `report()` method for non-blocking
+     * usage.
+     *
+     * @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 ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     * @returns Promise<void>
+     */
+    reportBlocking(eventName, properties, measurements, sampleRate, ignoreSettings = false) {
+        if (!ignoreSettings || config_state_1.TelemetrySettings.telemetryEnabled) {
+            const { client, event } = this.prepareClientAndEvent(eventName, properties, measurements, sampleRate);
+            return this.trackEventBlocking(client, event);
+        }
+        return Promise.resolve();
+    }
+    /**
+     * Send a telemetry event to Azure Application Insights. The telemetry event sending is still non-blocking
+     * in this API. To make sure telemetry event is sent to Azure backend before next statement, please see
+     * `reportBlocking()`.
+     *
+     * @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 specific TelemetryClient for generating specific properties (E.g. ToolsSuiteTelemetryClient)
+     * @param ignoreSettings Ignore telemetryEnabled settings and skip submitting telemetry data
+     */
+    report(eventName, properties, measurements, sampleRate, telemetryHelperProperties, ignoreSettings) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if ((ignoreSettings !== undefined && !ignoreSettings) || !config_state_1.TelemetrySettings.telemetryEnabled) {
+                return;
+            }
+            const { client, event } = this.prepareClientAndEvent(eventName, properties, measurements, sampleRate);
+            this.trackEvent(client, event);
+        });
+    }
+    /**
+     * Provide specification of telemetry event to be sent.
+     *
+     * @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
+     * @returns TelemetryClient instance and telemetry event
+     */
+    prepareClientAndEvent(eventName, properties, measurements, sampleRate = sample_rate_1.SampleRate.NoSampling) {
+        const client = this.clients.get(sampleRate);
+        const eventHeader = new event_header_1.EventHeader(this.extensionName, eventName);
+        const event = {
+            name: eventHeader.toString(),
+            properties: properties,
+            measurements: measurements
+        };
+        return {
+            client,
+            event
+        };
+    }
+    /**
+     * Send telemetry event in blocking style. It blocks
+     * the subsequent statements until telemetry event has been sent.
+     *
+     * @param client TelemetryClient instance
+     * @param event Telemetry event
+     * @returns Promise<void>
+     */
+    trackEventBlocking(client, event) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (process.env.SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY === 'true') {
+                return Promise.resolve();
+            }
+            return new Promise((resolve, reject) => {
+                try {
+                    client.trackEvent(event);
+                    client.flush({
+                        callback: () => resolve()
+                    });
+                }
+                catch (error) {
+                    reject(error);
+                }
+            });
+        });
+    }
+    /**
+     * Send teleemtry event in non-blocking fashion.
+     *
+     * @param client Telemetry client instance
+     * @param event Telemetry event
+     * @returns Send telemetry succeeded or not
+     */
+    trackEvent(client, event) {
+        if (process.env.SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY !== 'true') {
+            client.trackEvent(event);
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Create telemetry client instance based on sample rate.
+     *
+     * @param sampleRate Sampling telemetry event
+     * @returns Telemetry client instance
+     */
+    createTelemetryClient(sampleRate) {
+        let sampleRateNumer;
+        switch (sampleRate) {
+            case sample_rate_1.SampleRate.OnePercent:
+                sampleRateNumer = 1;
+                break;
+            case sample_rate_1.SampleRate.TenPercent:
+                sampleRateNumer = 10;
+                break;
+            case sample_rate_1.SampleRate.NoSampling:
+            default:
+                sampleRateNumer = 100;
+                break;
+        }
+        const client = new appInsights.TelemetryClient(this.applicationKey);
+        client.config.samplingPercentage = sampleRateNumer;
+        (0, azure_client_config_1.configAzureTelemetryClient)(client);
+        return client;
+    }
+}
+exports.ApplicationInsightClient = ApplicationInsightClient;
+//# sourceMappingURL=azure-appinsight-client.js.map

package/dist/base/client/client.d.ts

@@ -0,0 +1,24 @@
+import type { SampleRate } from '../types/sample-rate';
+/**
+ *
+ */
+declare abstract class Client {
+    abstract report(event: string, properties: Record<string, string>, metrics: Record<string, number>, sampleRate: SampleRate | undefined, telemetryHelperProperties?: Record<string, string>, ignoreSettings?: boolean): Promise<void>;
+    protected applicationKey: string;
+    protected extensionName: string;
+    protected extensionVersion: string;
+    /**
+     * @returns Target Azure application insights resource Id
+     */
+    getApplicationKey(): string;
+    /**
+     * @returns Consumer module version
+     */
+    getExtensionVersion(): string;
+    /**
+     * @returns Consumer module name
+     */
+    getExtensionName(): string;
+}
+export { Client };
+//# sourceMappingURL=client.d.ts.map

package/dist/base/client/client.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+/**
+ *
+ */
+class Client {
+    constructor() {
+        this.applicationKey = '';
+        this.extensionName = '';
+        this.extensionVersion = '';
+    }
+    /**
+     * @returns Target Azure application insights resource Id
+     */
+    getApplicationKey() {
+        return this.applicationKey;
+    }
+    /**
+     * @returns Consumer module version
+     */
+    getExtensionVersion() {
+        return this.extensionVersion;
+    }
+    /**
+     * @returns Consumer module name
+     */
+    getExtensionName() {
+        return this.extensionName;
+    }
+}
+exports.Client = Client;
+//# sourceMappingURL=client.js.map

package/dist/base/client/index.d.ts

@@ -0,0 +1,24 @@
+import type { Client } from './client';
+import { ToolsSuiteTelemetryClient } from '../../tooling-telemetry';
+/**
+ * Factory to get telemetry client instance.
+ */
+declare class ClientFactory {
+    private static clientMap;
+    /**
+     * Get singleton instance of default telemetry client for Azure app insights.
+     *
+     * @returns Telemetry client for Azure app insights
+     */
+    static getTelemetryClient(): ToolsSuiteTelemetryClient;
+    /**
+     * Get singleton instance of telemetry client based on the generics type. Currently, we only support
+     * telemetry client for Azure app insights.
+     *
+     * @param clientConstructor Class passed in as construtor function. Needs to be subclass of Client class
+     * @returns Subclass of telemetry Client class
+     */
+    static getTelemetryClientByClass<T extends Client>(clientConstructor: new (appKey: string, extensionName: string, extensionVersion: string) => T): T;
+}
+export { ClientFactory };
+//# sourceMappingURL=index.d.ts.map

package/dist/base/client/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientFactory = void 0;
+const tooling_telemetry_1 = require("../../tooling-telemetry");
+const config_state_1 = require("../config-state");
+/**
+ * Factory to get telemetry client instance.
+ */
+class ClientFactory {
+    /**
+     * Get singleton instance of default telemetry client for Azure app insights.
+     *
+     * @returns Telemetry client for Azure app insights
+     */
+    static getTelemetryClient() {
+        return ClientFactory.getTelemetryClientByClass(tooling_telemetry_1.ToolsSuiteTelemetryClient);
+    }
+    /**
+     * Get singleton instance of telemetry client based on the generics type. Currently, we only support
+     * telemetry client for Azure app insights.
+     *
+     * @param clientConstructor Class passed in as construtor function. Needs to be subclass of Client class
+     * @returns Subclass of telemetry Client class
+     */
+    static getTelemetryClientByClass(clientConstructor) {
+        let client = ClientFactory.clientMap.get(clientConstructor.name);
+        if (client) {
+            return client;
+        }
+        const ClientConstructor = clientConstructor;
+        client = new ClientConstructor(config_state_1.TelemetrySettings.azureInstrumentationKey, config_state_1.TelemetrySettings.consumerModuleName, config_state_1.TelemetrySettings.consumerModuleVersion);
+        ClientFactory.clientMap.set(clientConstructor.name, client);
+        return client;
+    }
+}
+exports.ClientFactory = ClientFactory;
+ClientFactory.clientMap = new Map();
+//# sourceMappingURL=index.js.map

package/dist/base/config-state.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Runtime telemetry settings
+ */
+export declare const TelemetrySettings: {
+    azureInstrumentationKey: string;
+    telemetryEnabled: boolean;
+    telemetryLibName: string;
+    telemetryLibVersion: string;
+    consumerModuleName: string;
+    consumerModuleVersion: string;
+};
+//# sourceMappingURL=config-state.d.ts.map

package/dist/base/config-state.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetrySettings = void 0;
+// @ts-ignore
+const package_json_1 = __importDefault(require("../../package.json"));
+/**
+ * Runtime telemetry settings
+ */
+exports.TelemetrySettings = {
+    // Target Azure apps insight destination
+    azureInstrumentationKey: '',
+    // Allow user to opt out from telemetry collection
+    telemetryEnabled: true,
+    // Module name in telemetry/pacakge.json
+    telemetryLibName: package_json_1.default.name,
+    // Version in telemetry/pacakge.json
+    telemetryLibVersion: package_json_1.default.version,
+    // Name of module that uses telemetry library
+    consumerModuleName: '',
+    // Version of module that uses telemetry library
+    consumerModuleVersion: ''
+};
+//# sourceMappingURL=config-state.js.map