Merge pull request #604 from Countly/sdk-info

SDK info methods

Author: turtledreams

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 25.4.5
+
+- Added SDK info methods:
+  - `Countly.sdk_version()` for retrieving current SDK version
+  - `Countly.sdk_name()` for retrieving the SDK name
+
 ## 25.4.4
 
 - Improved user property recording order with respect to sessions and events.

cypress/e2e/bridged_utils.cy.js

@@ -15,7 +15,7 @@ function initMain(name, version) {
 }
 
 const SDK_NAME = "javascript_native_web";
-const SDK_VERSION = "25.4.4";
+const SDK_VERSION = "25.4.5";
 
 // tests
 describe("Bridged SDK Utilities Tests", () => {

cypress/e2e/sdk_info.cy.js

@@ -0,0 +1,39 @@
+/* eslint-disable cypress/no-unnecessary-waiting */
+/* eslint-disable require-jsdoc */
+var Countly = require("../../lib/countly");
+var hp = require("../support/helper.js");
+const SDK_NAME = "javascript_native_web";
+const SDK_VERSION = "25.4.5";
+
+function initMain(name, version) {
+    Countly.init({
+        app_key: "YOUR_APP_KEY",
+        url: "https://your.domain.count.ly",
+        test_mode: true,
+        debug: true,
+        sdk_name: name,
+        sdk_version: version
+    });
+}
+
+describe("SDK name and version methods", () => {
+    it("sdk_name and sdk_version return default values when not overridden", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(undefined, undefined);
+            const name = Countly.sdk_name();
+            const version = Countly.sdk_version();
+            expect(name).to.equal(SDK_NAME);
+            expect(version).to.equal(SDK_VERSION);
+        });
+    });
+
+    it("sdk_name and sdk_version return overridden values", () => {
+        hp.haltAndClearStorage(() => {
+            initMain("custom_sdk_name", "1.2.3");
+            const name = Countly.sdk_name();
+            const version = Countly.sdk_version();
+            expect(name).to.equal("custom_sdk_name");
+            expect(version).to.equal("1.2.3");
+        });
+    });
+});

lib/countly.d.ts

@@ -75,6 +75,18 @@ declare module "countly-sdk-web" {
      */
     function get_device_id(): string;
 
+    /**
+     * Returns the SDK version string currently in use
+     * @returns {string} sdk version
+     */
+    function sdk_version(): string;
+
+    /**
+     * Returns the SDK name string currently in use
+     * @returns {string} sdk name
+     */
+    function sdk_name(): string;
+
     /**
      * Add consent for specific feature, meaning, user allowed to track that data (either core feature or from custom feature group)
      * @param {string | string[]} feature - name of the feature, possible values: "sessions", "events", "views", "scrolls", "clicks", "forms", "crashes", "attribution", "users", etc. or custom provided through {@link Countly.group_features}

lib/countly.js

@@ -217,7 +217,7 @@
         backoffCount: "cly_hc_backoff_count",
         consecutiveBackoffCount: "cly_hc_consecutive_backoff_count"
     });
-    var SDK_VERSION = "25.4.4";
+    var SDK_VERSION = "25.4.5";
     var SDK_NAME = "javascript_native_web";
 
     // Using this on document.referrer would return an array with 17 elements in it. The 12th element (array[11]) would be the path we are looking for. Others would be things like password and such (use https://regex101.com/ to check more)
@@ -1780,6 +1780,20 @@
             _classPrivateFieldSet2(_SCLimitStackTraceLinesPerThread, _this, undefined);
             _classPrivateFieldSet2(_SCLimitStackTraceLineLength, _this, undefined);
         });
+        /**
+         * Returns the SDK version string currently in use
+         * @returns {string} sdk version
+         */
+        _defineProperty(this, "sdk_version", function () {
+            return _classPrivateFieldGet2(_sdkVersion, _this);
+        });
+        /**
+         * Returns the SDK name string currently in use
+         * @returns {string} sdk name
+         */
+        _defineProperty(this, "sdk_name", function () {
+            return _classPrivateFieldGet2(_sdkName, _this);
+        });
         /**
         * Modify feature groups for consent management. Allows you to group multiple features under one feature group
         * @param {object} features - object to define feature name as key and core features as value

lib/countly.min.js

@@ -1,6 +1,6 @@
 {
   "name": "countly-sdk-web",
-  "version": "25.4.4",
+  "version": "25.4.5",
   "description": "Countly Web SDK",
   "main": "lib/countly.js",
   "types": "lib/countly.d.ts",