		{
		"extends": ["eslint:recommended"],
		"parser": "@typescript-eslint/parser",
		"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
		"env": {
		@@ -9,8 +10,7 @@ "browser": true,
		"parserOptions": {
		"ecmaVersion": 2020
		"ecmaVersion": 2020,
		"sourceType": "module"
		},
		"rules": {

		},
		"rules": {},
		"globals": {}
		}
		}

.pipeline/cumulus-configuration.json

		{
		"backlogIds": ["DEVXCORE"],
		"productStandardsToCheck": ["SLC-25", "SLC-29", "PSL-1", "FC-1", "FC-3", "SAST"]
		}
		}

.vscode/launch.json

		{
		// Use IntelliSense to learn about possible attributes.
		// Hover to view descriptions of existing attributes.
		// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
		"version": "0.2.0",
		"configurations": [
		{
		"type": "node",
		"request": "launch",
		"name": "Mocha Tests",
		"program": "${workspaceRoot}/node_modules/mocha/bin/mocha",
		"args": [
		"-r",
		"esm",
		"--inspect-brk",
		"${workspaceFolder}/test/*/.js"
		],
		"internalConsoleOptions": "openOnSessionStart"
		}
		]
		}
		// Use IntelliSense to learn about possible attributes.
		// Hover to view descriptions of existing attributes.
		// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
		"version": "0.2.0",
		"configurations": [
		{
		"type": "node",
		"request": "launch",
		"name": "Jest Current File",
		"console": "integratedTerminal",
		"internalConsoleOptions": "neverOpen",
		"program": "${workspaceFolder}/node_modules/jest/bin/jest",
		"args": ["${fileBasename}", "--config", "${workspaceFolder}/jest.config.js"],
		"outFiles": ["${workspaceFolder}/dist/*/.js"],
		"resolveSourceMapLocations": ["${workspaceFolder}", "!/node_modules/"]
		}
		]
		}

package.json

		{
		"name": "@sap/swa-for-sapbas-vsx",
		"version": "1.2.18",
		"version": "2.0.0",
		"description": "Typescript module for Azure Application Insights to be consumed by VSCode extensions",
		"keywords": [],
		"license": "SEE LICENSE IN LICENSE",
		"author": "SAP SE",
		"description": "Javascript module for SWA tracking to be consumed by VsCode extensions",
		"main": "src/index.js",
		"license": "SEE LICENSE IN LICENSE",
		"typings": "./api.d.ts",
		"main": "dist/src/index.js",
		"scripts": {
		"lint": "eslint src/.js test/.js",
		"test": "nyc --reporter=html mocha -r esm",
		"cover:report": "nyc report --reporter=lcov --reporter=text",
		"set-version": "node ./scripts/setVersion.js",
		"validate-version": "node ./scripts/validateVersion.js",
		"ci": "npm install && npm run test && npm run lint && npm run validate-version && npm run cover:report"
		"build": "tsc --build",
		"ci": "npm run clean && npm run format:validate && npm run lint:validate && npm run build && npm run test",
		"clean": "shx rm -rf dist coverage",
		"example": "ts-node example/reporter.ts",
		"format:fix": "prettier --print-width 120 --write \"*/.@(js\|ts\|json\|md\|vue)\" --ignore-path=.gitignore",
		"format:validate": "prettier --print-width 120 --check \"*/.@(js\|ts\|json\|md\|vue)\" --ignore-path=.gitignore",
		"lint:fix": "eslint . --ext .ts --fix --max-warnings=0 --ignore-path=.gitignore",
		"lint:validate": "eslint . --ext .ts --max-warnings=0 --ignore-path=.gitignore",
		"test": "jest --config jest.config.js --coverage --verbose --color"
		},
		"keywords": [],
		"devDependencies": {
		"@types/node": "^14.14.41",
		"mocha": "^7.2.0",
		"prettier": "^2.0.5",
		"eslint-plugin-import": "2.22.1",
		"eslint": "6.8.0",
		"nyc": "^15.1.0",
		"sinon": "^10.0.0"
		"husky": {
		"hooks": {
		"pre-commit": "lint-staged",
		"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
		}
		},
		"commitlint": {
		"extends": [
		"@commitlint/config-conventional"
		]
		},
		"lint-staged": {
		"*.{js,ts,json,md,vue}": [
		"prettier --write --print-width 120"
		],
		"*.{ts,js,vue}": [
		"eslint --fix --max-warnings=0 --ignore-pattern=!.*"
		]
		},
		"config": {
		"commitizen": {
		"path": "cz-conventional-changelog"
		}
		},
		"dependencies": {
		"esm": "3.2.25",
		"lodash": "4.17.21",
		"matomo-tracker": "2.2.4",
		"semver": "7.5.2"
		"@sap/bas-sdk": "3.7.8",
		"applicationinsights": "2.9.2",
		"lodash": "4.17.21"
		},
		"devDependencies": {
		"@commitlint/cli": "18.6.0",
		"@commitlint/config-conventional": "18.6.0",
		"@types/jest": "29.5.12",
		"@types/lodash": "4.14.202",
		"@types/vscode": "1.85.0",
		"@typescript-eslint/eslint-plugin": "7.0.1",
		"@typescript-eslint/parser": "7.0.1",
		"cz-conventional-changelog": "3.3.0",
		"eslint": "8.56.0",
		"eslint-plugin-import": "2.29.1",
		"husky": "9.0.11",
		"jest": "29.7.0",
		"lint-staged": "15.2.2",
		"prettier": "3.2.5",
		"shx": "0.3.4",
		"ts-jest": "29.1.2",
		"ts-node": "10.9.2",
		"typescript": "5.3.3"
		}
		}

201

README.md

		@@ -1,166 +0,101 @@
		[![Build Status](https://gkeplatform2.jaas-gcp.cloud.sap.corp/buildStatus/icon?job=swa-for-sapbas-vsx-voter/master)](https://gkeplatform2.jaas-gcp.cloud.sap.corp/job/swa-for-sapbas-vsx-voter/job/master/)
		[![Product PR](https://esm-product-status.cfapps.sap.hana.ondemand.com/swa/badge)](https://esm-product-status.cfapps.sap.hana.ondemand.com/swa/pr)
		[![Quality Gate Status](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=alert_status)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		[![Coverage](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=coverage)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		[![Rating](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=sqale_rating)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		[![Bugs](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=bugs)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		[![Code Smells](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=code_smells)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		[![Duplicated Lines Density](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=duplicated_lines_density)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		[![Security Vulnerabilities](https://sonar.wdf.sap.corp/api/project_badges/measure?project=swa-for-sapbas-vsx&metric=vulnerabilities)](https://sonar.wdf.sap.corp/dashboard?id=swa-for-sapbas-vsx)
		# SAP Web Analytics npm package for VSCode Extensions

		Wrapper for application insights meant to be used in VSCode Extensions running in SAP Bussiness Application Studio.

		# SAP Web Analytics npm package for Visual Code Extensions
		Wrapper for SWA meant to be used in Visual code and SAP Application Studio.

		## Usage

		### Installation

		```typescript
		npm install @sap/swa-for-sapbas-vsx
		```

		### ENV
		Everything in the environment should be set up, if using in AppStudio please make sure [swa-chart](https://github.wdf.sap.corp/app-studio/swa-chart) is installed as a ws-ext

		### API
		There are only two functions to call for usage

		#### Import
		```js
		import { SWATracker } from '@sap/swa-for-sapbas-vsx';
		```
		#### Initialize the client telemetry settings

		#### Constructor
		Has 3 params that are detailed in the constructor call:
		```js
		/**
		* constructor
		* @param vsxPublisher should be publisher in package.json
		* @param vsxPackageName should be extension package.json name
		* @param errorListener callback for error, one such callback for all the errors we receive via all the track methods err can be string (err.message) or number (response.statusCode)
		*/
		var myErrorListener = (err) => { myErrorHandling(err); }
		swa = new SWATracker("My Vscode Ext Publisher","My Package name", myErrorListener)
		```
		---
		NOTE
		This can be done in the `activate` stage of a vscode extension.

		The vsxPublisher and vsxPackageName values passed to SWA Tracker constructor must be exact strings as they appear in the extension package.json. Otherwise, the usage data is not reported when extension is running in VS Code.
		```typescript
		import { initTelemetrySettings } from "@sap/swa-for-sapbas-vsx";

		---

		#### Track
		After creating a new swa class as detailed above usage is pretty simple
		```js
		/**
		* Send event to SWA for tracking
		* @param eventType string detailing what event are you looking to track (ex. "Generator Success!")
		* @param {string[]} [custom_events] Optional, can accept up to 4, any more will be ignored
		* @param {int[]} [numericEvents] Optional, can accept up to 2, any more will be ignored
		*/
		swa.track("myEvent", ["custom event 1", "custom event 2", "This array is optional"],[1,2]); // numeric events is also optional
		initTelemetrySettings(extensionName: string, extensionVersion: number);
		```

		#### Example
		```js
		import * as vscode from 'vscode';
		import {SWATracker} from "@sap/swa-for-sapbas-vsx";
		// this method is called when your extension is activated
		// your extension is activated the very first time the command is executed
		Note to take the `extensionName` and the `extensionVersion` dynamically from the `package.json`.
		The `extensionName` is constructed from the vsxPublisher and vsxPackageName: `<vsxPublisher>.<vsxPackageName>`.

		export function activate(context: vscode.ExtensionContext) {
		const swa = new SWATracker("SAP", "vscode-close-editor", (err : string\|number) => {console.log(err);});
		let cmd_closeActiveEditor = vscode.commands.registerCommand('extension.closeActiveEditor', () => {

		vscode.commands.executeCommand("workbench.action.closeActiveEditor");
		// Note that I don't have any custom events so I don't send an extra array
		swa.track("Close Active Editor");
		});
		...
		...
		```
		#### report API

		### Usage Comments
		1. If running in Appstudio and SWA chart is not enabled code will throw error into console log that it is unable to track.
		2. Please take note that if environment is not configured correctly with privacy settings code will not send any tracking.
		```typescript
		import { BASClientFactory, BASTelemetryClient } from "@sap/swa-for-sapbas-vsx";

		#### Use Different Target
		SWA can report usage to a different target.
		These reports are always anonymized.
		```js
		swa.setTarget(<targetUrl>, <targetToken>);
		```
		const basTelemetryClient: BASTelemetryClient = BASClientFactory.getBASTelemetryClient();

		## Enable usage analytics reporting from VS Code
		If you have a VS Code extension that is released to VS Code marketplace and you would like to collect its usage when it runs in VS Code, do the following:
		// Prepare any string/numeric telemetry data to be submitted
		const properties: { [key: string]: string } = {
		customProperty1: "HIGH",
		customProperty2: "DEFAULT",
		customProperty3: "LOW",
		};

		1. Make sure that the vsxPublisher and vsxPackageName parameters initializing SWATracker object are correct.
		The vsxPublisher and vsxPackageName values passed to SWA Tracker constructor must be exact strings as they appear in the extension package.json.
		const measurements: { [key: string]: number } = {
		customMeasure1: 100,
		customMeasure2: 0.73,
		customMeasure3: 2019,
		};

		```js
		/**
		* constructor
		* @param vsxPublisher should be publisher in package.json
		* @param vsxPackageName should be extension package.json name
		* @param errorListener callback for error, one such callback for all the errors we receive via all the track methods err can be string (err.message) or number (response.statusCode)
		*/
		var myErrorListener = (err) => { myErrorHandling(err); }
		swa = new SWATracker("My Vscode Ext Publisher","My Package name", myErrorListener)

		// Submit telemetry data
		basTelemetryClient.report("eventName", properties, measurements);
		```

		---
		NOTE

		If you need to change vsxPublisher and vsxPackageName values after you already have SWA reports presenting the usage data, do not forget to adjust these reports considering the changed publisher info.
		For example, if you use “Custom event parameter 10” in report filter definition, you should specify both old and new values to see the data from the extension.
		#### Example of usage from a VSCode extension

		---
		```typescript
		import * as vscode from "vscode";
		import { initTelemetrySettings } from "@sap/swa-for-sapbas-vsx";
		import { BASClientFactory, BASTelemetryClient } from "@sap/swa-for-sapbas-vsx";
		const packageJson = require("./package.json");

		2. In “configuration” section of your VS code extension add the settings for user to enable/disable sending the reports. Replace the placeholders with the relevant strings.
		// this method is called when your extension is activated
		export function activate(context: vscode.ExtensionContext) {
		const extensionName = `${packageJson.publisher}.${packageJson.name}`; // e.g. SAP.vscode-close-editor
		initTelemetrySettings(extensionName, packageJson.version);
		void vscode.commands.registerCommand("extension.closeActiveEditor", () => {
		void vscode.commands.executeCommand("workbench.action.closeActiveEditor");

		```json
		...
		"<Your package name>.enableSapWebAnalytics": {
		"type": "boolean",
		"default": true,
		"description": "Enable collecting usage analytics data for <Your Tool Name>. If enabled, non-personally identifiable information is used to help understand the product usage and improve the tool.",
		"scope": "resource"
		}
		...
		const basTelemetryClient: BASTelemetryClient = BASClientFactory.getBASTelemetryClient();
		// Only eventName is mandatory.
		basTelemetryClient.report("Close Active Editor");
		});
		}
		```
		3. In README file of your extension, add the following paragraph (do not forget replace the \<Tool Name\> placeholder with your tool name!) :

		The tool collects non-personally identifiable information about your usage of the tool to improve its services.
		If you do not want the tool to collect your usage data, you can set the "Enable Sap Web Analytics" setting to "false".
		Go to File > Preferences > Settings (macOS: Code > Preferences > Settings) > Extensions > \<Tool Name\>, and deselect the "Enable Sap Web Analytics" checkbox.
		### Configuring Telemetry Settings for BAS Usage Tracking

		## SWA Reports and Parameter Mapping
		The following fields can be used for creating SWA reports:
		This module is designed to track usage metrics for BAS, and it requires the VSCode setting `sapbas.telemetryEnabled` to be explicitly set to `true` for telemetry data to be transmitted.

		\| SWA Field \| Origin \|
		\| ------------- \| ------------- \|
		\| eventType \| The "myEvent" parameter sent via track API \|
		\| user \| Hashed user ID unless privacy is activated, then "na" \|
		\| Custom event parameter 1 \| Event additional data 1, "custom event 1" sent via track API \|
		\| Custom event parameter 2 \| Event additional data 2, "custom event 2" sent via track API \|
		\| Custom event parameter 3 \| Event additional data 3, "custom event 3" sent via track API \|
		\| Custom event parameter 4 \| Event additional data 4, "custom event 4" sent via track API \|
		\| Custom event parameter 5 \| Event additional data 5, "custom event 5" sent via track API \|
		\| Custom event parameter 6 \| IAAS (aws,ali,azure), set by the lib automatically \|
		\| Custom event parameter 7 \| Datacenter (stg10.int, cry10.int, ap21, prd40), set by the lib automatically \|
		\| Custom event parameter 8 \| Version (currently not supported), set by the lib automatically \|
		\| Custom event parameter 9 \| Tenant Plan (currently supported only for reports from ws manager) \|
		\| Custom event parameter 10 \| The unique caller ID "vsxPublisher.vsxPackageName", set by lib automatically \|
		\| Numeric event parameter 1 \| Event additional numeric data 1, "numeric event 1" sent via tack API \|
		\| Numeric event parameter 2 \| Event additional numeric data 2, "numeric event 2" sent via tack API \|
		The tool gathers anonymized information regarding your interaction with the software to enhance its offerings. Should you prefer to opt-out of this data collection, simply adjust the `sapbas.telemetryEnabled` setting to `false`.

		## Contribution
		### Contribute and update version
		1. Commit your contribution
		2. Execute 'npm run set-version <new version>' to set new version for the lib (example: 'npm run set-version 3.2.1')
		3. Execute 'npm install' to update package-lock.json
		4. Add a PR with your changes
		## Utilizing Application Insights Events for Report Generation

		### Releasing new version
		2. Add a PR in https://github.wdf.sap.corp/NPMJS/NODE_SWA_FOR_VSC_EXT-1.0 see [example PR](https://github.wdf.sap.corp/NPMJS/NODE_SWA_FOR_VSC_EXT-1.0)
		3. ask project npm project admins (ido goren, asaf dulberg) to approve the PRs
		4. new version should be released soon to npmjs on https://www.npmjs.com/package/@sap/swa-for-sapbas-vsx
		The following fields can be used for creating reports:

		\| Application Insights Field \| Origin \|
		\| -------------------------- \| ------------------------------------------------------------------------------------------------- \|
		\| evenName \| The "eventName" parameter sent via report API. It is constructed by the `extensionName/eventName` \|
		\| properties \| Additional data used to filter events and metrics in the portal. Defaults to empty. \|
		\| measurements \| Metrics associated with this event. Defaults to empty. \|

		You can assume the following properties are automatically being added to each report:

		\| Property Name \| Value \|
		\| -------------------------- \| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \|
		\| iaas \| Refers to the Infrastructure as a Service provider where the extention is running. This could be a cloud provider like AWS, Azure, Google Cloud, etc., indicating the underlying infrastructure platform. \|
		\| landscape \| The specific environment where the application operates. \|
		\| is_sap_user \| A boolean flag indicating whether the user is associated with SAP. \|
		\| bas_mode \| Indicates the mode of SAP Business Application Studio. Can be 'free', 'standard', 'buildCodeFree', 'buildCodeStandard' \|
		\| extension_run_platform \| Indicates the platform on which the reporting VSCode extension is running. \|
		\| extension_version \| Specifies the version of the extension or tool being used \|

whitesource.config.json

		{
		"userKey" : "ab6b751694c34986adce0d2b71488f368cabd74eb7794a9b886fdb48bd9c2a3c",
		"apiKey" : "6971b2eec2d3420bad0caf173ec629f6a3c7d3ba63f3445ab99ffdbf1acfb1d0",
		"userKey": "ab6b751694c34986adce0d2b71488f368cabd74eb7794a9b886fdb48bd9c2a3c",
		"apiKey": "6971b2eec2d3420bad0caf173ec629f6a3c7d3ba63f3445ab99ffdbf1acfb1d0",
		"productName": "SHC - SAP WEB IDE OD 3.0",
		"projectName" : "swa-for-sapbas-vsx",
		"projectVer" : "1.0.0",
		"productToken" : "a670f56895c748a7b05cc37685ba3279f98d88baab734992bd493cafb27c70d6",
		"projectName": "swa-for-sapbas-vsx",
		"projectVer": "1.0.0",
		"productToken": "a670f56895c748a7b05cc37685ba3279f98d88baab734992bd493cafb27c70d6",
		"devDep": "false",
		@@ -9,0 +9,0 @@ "forceUpdate": true,

api.d.ts

renovate.json

scripts/setVersion.js

scripts/validateVersion.js

src/index.js

src/version.json

test/test.js

.pipeline/config.yaml

Sorry, the diff of this file is not supported yet

dependencies

Sorry, the diff of this file is not supported yet

@sap/swa-for-sapbas-vsx - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes