@sap-ux/fiori-generator-shared 0.6.3 → 0.7.0

package/dist/environment.d.ts

@@ -4,4 +4,13 @@
  * @returns true if it is a cli environment, false otherwise
  */
 export declare function isCli(): boolean;
+/**
+ * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
+ *
+ * @returns the platform name and technical name
+ */
+export declare function getHostEnvironment(): {
+    name: string;
+    technical: string;
+};
 //# sourceMappingURL=environment.d.ts.map

package/dist/environment.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isCli = isCli;
+exports.getHostEnvironment = getHostEnvironment;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const types_1 = require("./types");
 /**
  * Determine if the current prompting environment is cli .
  *
@@ -14,4 +17,15 @@ function isCli() {
         return false;
     }
 }
+/**
+ * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
+ *
+ * @returns the platform name and technical name
+ */
+function getHostEnvironment() {
+    if (isCli()) {
+        return types_1.hostEnvironment.cli;
+    }
+    return (0, btp_utils_1.isAppStudio)() ? types_1.hostEnvironment.bas : types_1.hostEnvironment.vscode;
+}
 //# sourceMappingURL=environment.js.map

package/dist/index.d.ts

@@ -1,9 +1,12 @@
 export * from './cap';
 export * from './environment';
+export * from './logWrapper';
+export * from './system-utils';
+export * from './telemetry';
 export { getPackageScripts } from './getPackageScripts';
 export { getBootstrapResourceUrls, getDefaultTargetFolder } from './helpers';
 export { generateReadMe } from './read-me';
-export * from './system-utils';
-export { PackageJsonScripts, YeomanEnvironment, VSCodeInstance } from './types';
-export * from './logWrapper';
+export { getHostEnvironment } from './environment';
+export { isExtensionInstalled } from './installedCheck';
+export { PackageJsonScripts, YeomanEnvironment, VSCodeInstance, hostEnvironment } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,9 +14,12 @@ 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.generateReadMe = exports.getDefaultTargetFolder = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
+exports.hostEnvironment = exports.isExtensionInstalled = exports.getHostEnvironment = exports.generateReadMe = exports.getDefaultTargetFolder = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
 __exportStar(require("./cap"), exports);
 __exportStar(require("./environment"), exports);
+__exportStar(require("./logWrapper"), exports);
+__exportStar(require("./system-utils"), exports);
+__exportStar(require("./telemetry"), exports);
 var getPackageScripts_1 = require("./getPackageScripts");
 Object.defineProperty(exports, "getPackageScripts", { enumerable: true, get: function () { return getPackageScripts_1.getPackageScripts; } });
 var helpers_1 = require("./helpers");
@@ -24,6 +27,10 @@ Object.defineProperty(exports, "getBootstrapResourceUrls", { enumerable: true, g
 Object.defineProperty(exports, "getDefaultTargetFolder", { enumerable: true, get: function () { return helpers_1.getDefaultTargetFolder; } });
 var read_me_1 = require("./read-me");
 Object.defineProperty(exports, "generateReadMe", { enumerable: true, get: function () { return read_me_1.generateReadMe; } });
-__exportStar(require("./system-utils"), exports);
-__exportStar(require("./logWrapper"), exports);
+var environment_1 = require("./environment");
+Object.defineProperty(exports, "getHostEnvironment", { enumerable: true, get: function () { return environment_1.getHostEnvironment; } });
+var installedCheck_1 = require("./installedCheck");
+Object.defineProperty(exports, "isExtensionInstalled", { enumerable: true, get: function () { return installedCheck_1.isExtensionInstalled; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "hostEnvironment", { enumerable: true, get: function () { return types_1.hostEnvironment; } });
 //# sourceMappingURL=index.js.map

package/dist/installedCheck.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Check for an installed extension, optionally specifying a minimum version.
+ * Note, this does not check for activation state of specified extension.
+ *
+ * @param vscode - vscode instance
+ * @param extensionId - the id of the extension to find
+ * @param minVersion - the minimum version of the specified extension, lower versions will not be returned. Must be a valid SemVer string.
+ * @returns true if the extension is installed and the version is >= minVersion (if provided), false otherwise
+ */
+export declare function isExtensionInstalled(vscode: any, extensionId: string, minVersion?: string): boolean;
+//# sourceMappingURL=installedCheck.d.ts.map

package/dist/installedCheck.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isExtensionInstalled = isExtensionInstalled;
+const semver_1 = require("semver");
+/**
+ * Check for an installed extension, optionally specifying a minimum version.
+ * Note, this does not check for activation state of specified extension.
+ *
+ * @param vscode - vscode instance
+ * @param extensionId - the id of the extension to find
+ * @param minVersion - the minimum version of the specified extension, lower versions will not be returned. Must be a valid SemVer string.
+ * @returns true if the extension is installed and the version is >= minVersion (if provided), false otherwise
+ */
+function isExtensionInstalled(vscode, extensionId, minVersion) {
+    const foundExt = vscode?.extensions?.getExtension(extensionId);
+    if (foundExt) {
+        const extVersion = (0, semver_1.coerce)(foundExt.packageJSON.version);
+        if (extVersion) {
+            // Check installed ver is >= minVersion or return true if minVersion is not specified
+            return !(minVersion && (0, semver_1.lt)(extVersion, minVersion));
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=installedCheck.js.map

package/dist/telemetry/index.d.ts

@@ -0,0 +1,3 @@
+export { sendTelemetry, sendTelemetryBlocking } from './utils';
+export * from './telemetryHelper';
+//# sourceMappingURL=index.d.ts.map

package/dist/telemetry/index.js

@@ -0,0 +1,22 @@
+"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.sendTelemetryBlocking = exports.sendTelemetry = void 0;
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "sendTelemetry", { enumerable: true, get: function () { return utils_1.sendTelemetry; } });
+Object.defineProperty(exports, "sendTelemetryBlocking", { enumerable: true, get: function () { return utils_1.sendTelemetryBlocking; } });
+__exportStar(require("./telemetryHelper"), exports);
+//# sourceMappingURL=index.js.map

package/dist/telemetry/telemetryHelper.d.ts

@@ -0,0 +1,41 @@
+import { type TelemetryProperties, type ToolsSuiteTelemetryInitSettings } from '@sap-ux/telemetry';
+import type { TelemetryData } from './types';
+/**
+ * Helper class for intialising and preparing event data for telemetry.
+ */
+export declare abstract class TelemetryHelper {
+    private static _telemetryData;
+    private static _previousEventTimestamp;
+    /**
+     * Returns the telemetry data.
+     *
+     * @returns telemetry data
+     */
+    static get telemetryData(): TelemetryData;
+    /**
+     * Load telemetry settings.
+     *
+     * @param options - tools suite telemetry init settings
+     */
+    static initTelemetrySettings(options: ToolsSuiteTelemetryInitSettings): Promise<void>;
+    /**
+     * Creates telemetry data and adds default telemetry props.
+     *
+     * @param additionalData - set additional properties to be reported by telemetry
+     * @param filterDups - filters duplicates by returning undefined if it's suspected to be a repeated event based on previous telemetry data & timestamp (1 second)
+     * @returns telemetry data
+     */
+    static createTelemetryData<T extends TelemetryProperties>(additionalData?: Partial<T>, filterDups?: boolean): TelemetryData | undefined;
+    /**
+     * Marks the start time. Example usage:
+     * At the start of of the writing phase of the yeoman generator.
+     * It should not be updated everytime calling createTelemetryData().
+     */
+    static markAppGenStartTime(): void;
+    /**
+     * Marks the end time. Example usage:
+     * At the end of the writing phase of yeoman generator.
+     */
+    static markAppGenEndTime(): void;
+}
+//# sourceMappingURL=telemetryHelper.d.ts.map

package/dist/telemetry/telemetryHelper.js

@@ -0,0 +1,92 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryHelper = void 0;
+const telemetry_1 = require("@sap-ux/telemetry");
+const environment_1 = require("../environment");
+const os_name_1 = __importDefault(require("os-name"));
+const i18n_1 = require("../i18n");
+/**
+ * Helper class for intialising and preparing event data for telemetry.
+ */
+class TelemetryHelper {
+    static _telemetryData;
+    static _previousEventTimestamp;
+    /**
+     * Returns the telemetry data.
+     *
+     * @returns telemetry data
+     */
+    static get telemetryData() {
+        return this._telemetryData;
+    }
+    /**
+     * Load telemetry settings.
+     *
+     * @param options - tools suite telemetry init settings
+     */
+    static async initTelemetrySettings(options) {
+        await (0, telemetry_1.initTelemetrySettings)(options);
+    }
+    /**
+     * Creates telemetry data and adds default telemetry props.
+     *
+     * @param additionalData - set additional properties to be reported by telemetry
+     * @param filterDups - filters duplicates by returning undefined if it's suspected to be a repeated event based on previous telemetry data & timestamp (1 second)
+     * @returns telemetry data
+     */
+    static createTelemetryData(additionalData, filterDups = false) {
+        const currentTimestamp = new Date().getTime();
+        if (!this._previousEventTimestamp) {
+            filterDups = false; // can't filter duplicates if no previous event timestamp
+            this._previousEventTimestamp = currentTimestamp;
+        }
+        if (!this._telemetryData) {
+            let osVersionName = (0, i18n_1.t)('telemetry.unknownOs');
+            try {
+                osVersionName = (0, os_name_1.default)();
+            }
+            catch {
+                // no matched os name, possible beta or unreleased version
+            }
+            this._telemetryData = {
+                Platform: (0, environment_1.getHostEnvironment)().technical,
+                OperatingSystem: osVersionName
+            };
+        }
+        if (filterDups) {
+            const newTelemData = { ...this._telemetryData, ...additionalData };
+            if (Math.abs(this._previousEventTimestamp - currentTimestamp) < 1000 &&
+                JSON.stringify(newTelemData) === JSON.stringify(this._telemetryData)) {
+                return undefined;
+            }
+        }
+        this._previousEventTimestamp = currentTimestamp;
+        this._telemetryData = Object.assign(this._telemetryData, additionalData);
+        return this._telemetryData;
+    }
+    /**
+     * Marks the start time. Example usage:
+     * At the start of of the writing phase of the yeoman generator.
+     * It should not be updated everytime calling createTelemetryData().
+     */
+    static markAppGenStartTime() {
+        TelemetryHelper.createTelemetryData({
+            markName: telemetry_1.PerformanceMeasurementAPI.startMark('LOADING_TIME')
+        });
+    }
+    /**
+     * Marks the end time. Example usage:
+     * At the end of the writing phase of yeoman generator.
+     */
+    static markAppGenEndTime() {
+        if (this._telemetryData?.markName) {
+            telemetry_1.PerformanceMeasurementAPI.endMark(this._telemetryData.markName);
+            telemetry_1.PerformanceMeasurementAPI.measure(this._telemetryData.markName);
+        }
+    }
+}
+exports.TelemetryHelper = TelemetryHelper;
+//# sourceMappingURL=telemetryHelper.js.map

package/dist/telemetry/types.d.ts

@@ -0,0 +1,4 @@
+export interface TelemetryData {
+    [key: string]: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/telemetry/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/telemetry/utils.d.ts

@@ -0,0 +1,20 @@
+import type { TelemetryData } from './types';
+/**
+ * Sends the telemetry event to the telemetry client.
+ *
+ * @param telemetryEventName - the event name to be reported
+ * @param telemetryData - the telemetry data
+ * @param appPath - the path of the application
+ * @returns - a promise that resolves when the event is sent
+ */
+export declare function sendTelemetry(telemetryEventName: string, telemetryData: TelemetryData, appPath?: string): Promise<void>;
+/**
+ * Sends the telemetry event to the telemetry client and blocks the execution until the event is sent.
+ *
+ * @param telemetryEventName - the event name to be reported
+ * @param telemetryData - the telemetry data
+ * @param appPath - the path of the application
+ * @returns - a promise that resolves when the event is sent
+ */
+export declare function sendTelemetryBlocking(telemetryEventName: string, telemetryData: TelemetryData, appPath?: string): Promise<void>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/telemetry/utils.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendTelemetry = sendTelemetry;
+exports.sendTelemetryBlocking = sendTelemetryBlocking;
+const telemetry_1 = require("@sap-ux/telemetry");
+const telemetryHelper_1 = require("./telemetryHelper");
+/**
+ * Prepares the telemetry event to be sent to the telemetry client.
+ *
+ * @param telemetryEventName - the event name to be reported
+ * @param telemetryData - the telemetry data
+ * @returns - the telemetry event
+ */
+function prepareTelemetryEvent(telemetryEventName, telemetryData) {
+    // Make sure performance measurement end is called
+    telemetryHelper_1.TelemetryHelper.markAppGenEndTime();
+    const generationTime = telemetryData.markName
+        ? telemetry_1.PerformanceMeasurementAPI.getMeasurementDuration(telemetryData.markName)
+        : undefined;
+    return {
+        eventName: telemetryEventName,
+        properties: telemetryData,
+        measurements: generationTime ? { GenerationTime: generationTime } : {}
+    };
+}
+/**
+ * Sends the telemetry event to the telemetry client.
+ *
+ * @param telemetryEventName - the event name to be reported
+ * @param telemetryData - the telemetry data
+ * @param appPath - the path of the application
+ * @returns - a promise that resolves when the event is sent
+ */
+async function sendTelemetry(telemetryEventName, telemetryData, appPath) {
+    const telemetryEvent = prepareTelemetryEvent(telemetryEventName, telemetryData);
+    return telemetry_1.ClientFactory.getTelemetryClient().reportEvent(telemetryEvent, telemetry_1.SampleRate.NoSampling, appPath ? { appPath } : undefined);
+}
+/**
+ * Sends the telemetry event to the telemetry client and blocks the execution until the event is sent.
+ *
+ * @param telemetryEventName - the event name to be reported
+ * @param telemetryData - the telemetry data
+ * @param appPath - the path of the application
+ * @returns - a promise that resolves when the event is sent
+ */
+async function sendTelemetryBlocking(telemetryEventName, telemetryData, appPath) {
+    const telemetryEvent = prepareTelemetryEvent(telemetryEventName, telemetryData);
+    return telemetry_1.ClientFactory.getTelemetryClient().reportEventBlocking(telemetryEvent, telemetry_1.SampleRate.NoSampling, appPath ? { appPath } : undefined);
+}
+//# sourceMappingURL=utils.js.map

package/dist/translations/fiori-generator-shared.i18n.json

@@ -8,5 +8,8 @@
     },
     "debug": {
         "loggingConfigured": "Logging has been configured at log level: {{logLevel}}"
+    },
+    "telemetry": {
+        "unknownOs": "Unknown"
     }
 }

package/dist/types.d.ts

@@ -110,5 +110,23 @@ export interface PackageScriptsOptions {
     /** If true, a script for starting the app without flp will be generated. Defaults to true. */
     generateIndex?: boolean;
 }
+export declare const hostEnvironment: {
+    vscode: {
+        name: string;
+        technical: string;
+    };
+    bas: {
+        name: string;
+        technical: string;
+    };
+    cli: {
+        name: string;
+        technical: string;
+    };
+};
+export declare enum ApiHubType {
+    apiHub = "API_HUB",
+    apiHubEnterprise = "API_HUB_ENTERPRISE"
+}
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -1,3 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiHubType = exports.hostEnvironment = void 0;
+exports.hostEnvironment = {
+    vscode: {
+        name: 'Visual Studio Code',
+        technical: 'VSCode'
+    },
+    bas: {
+        name: 'SAP Business Application Studio',
+        technical: 'SBAS'
+    },
+    cli: {
+        name: 'CLI',
+        technical: 'CLI'
+    }
+};
+var ApiHubType;
+(function (ApiHubType) {
+    ApiHubType["apiHub"] = "API_HUB";
+    ApiHubType["apiHubEnterprise"] = "API_HUB_ENTERPRISE";
+})(ApiHubType || (exports.ApiHubType = ApiHubType = {}));
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-generator-shared",
   "description": "Commonly used shared functionality and types to support the fiori generator.",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -22,12 +22,16 @@
     "logform": "2.4.0",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
+    "os-name": "4.0.1",
+    "semver": "7.5.4",
     "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/project-access": "1.28.1"
+    "@sap-ux/project-access": "1.28.2",
+    "@sap-ux/telemetry": "0.5.36"
   },
   "devDependencies": {
     "@types/mem-fs-editor": "7.0.1",
     "@types/mem-fs": "1.1.2",
+    "@types/semver": "7.5.2",
     "@types/yeoman-environment": "2.10.11"
   },
   "engines": {