countly-sdk-web 22.2.4 → 22.6.0

package/.eslintignore

@@ -1,10 +1,9 @@
 lib/countly.min.js
 lib/countly.pack.js
-plugin
-examples
-test
+plugin/boomerang/boomerang.min.js
+examples/react
+examples/symbolication
 node_modules
-coverage
 .vscode
 .github
 .gitignore

package/.eslintrc.js

@@ -1,3 +1,5 @@
+"use strict";
+
 module.exports = {
     /**
      * By default, ESLint expects ECMAScript 5 syntax. You can override that setting to enable support
@@ -210,6 +212,6 @@ module.exports = {
         "no-shadow": [
             "error"
         ]
-    },
+    }
 
 };

package/.github/dependabot.yml

@@ -5,16 +5,34 @@ updates:
   schedule:
     interval: daily
   open-pull-requests-limit: 10
+  reviewers:
+  - turtledreams
+  assignees:
+  - turtledreams
+  labels:
+  - dependencies
+  versioning-strategy: increase-if-necessary
+- package-ecosystem: npm
+  directory: "/examples/symbolication/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  reviewers:
+  - turtledreams
+  assignees:
+  - turtledreams
+  labels:
+  - dependencies
+  versioning-strategy: increase-if-necessary
+- package-ecosystem: npm
+  directory: "/examples/react/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  reviewers:
+  - turtledreams
+  assignees:
+  - turtledreams
+  labels:
+  - dependencies
   versioning-strategy: increase-if-necessary
-  ignore:
-  - dependency-name: webpack
-    versions:
-    - 5.18.0
-    - 5.19.0
-    - 5.20.0
-    - 5.20.1
-    - 5.20.2
-    - 5.21.2
-    - 5.22.0
-    - 5.23.0
-    - 5.24.0

package/.markdownlint.json

@@ -0,0 +1,52 @@
+{
+    "MD001": true,
+    "MD002": false,
+    "MD003": true,
+    "MD004": true,
+    "MD005": true,
+    "MD006": true,
+    "MD007": { "indent": 2 },
+    "MD009": false,
+    "MD010": false,
+    "MD011": true,
+    "MD012": { "maximum": 1 },
+    "MD013": { "line_length": 300 },
+    "MD014": false,
+    "MD018": true,
+    "MD019": true,
+    "MD020": true,
+    "MD021": true,
+    "MD022": false,
+    "MD023": true,
+    "MD024": true,
+    "MD025": true,
+    "MD026": true,
+    "MD027": true,
+    "MD028": true,
+    "MD029": true,
+    "MD030": true,
+    "MD031": true,
+    "MD032": false,
+    "MD033": false,
+    "MD034": false,
+    "MD035": true,
+    "MD036": true,
+    "MD037": true,
+    "MD038": true,
+    "MD039": true,
+    "MD040": true,
+    "MD041": false,
+    "MD042": true,
+    "MD043": false,
+    "MD044": true,
+    "MD045": true,
+    "MD046": true,
+    "MD047": true,
+    "MD048": true,
+    "MD049": true,
+    "MD050": true,
+    "MD051": true,
+    "MD052": true,
+    "MD053": true
+    }
+  

package/.markdownlintignore

@@ -0,0 +1 @@
+/node_modules/

package/.stylelintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": "stylelint-config-standard"
+  }

package/CHANGELOG.md

@@ -1,5 +1,11 @@
+## 22.06.0
+- Updated BoomerangJS to the latest version (1.737.0)
+- Implemented static code analysis recommendations from Codacy, Snyk and Deep Scan
+- Added an Angular integration example
+
 ## 22.02.4
 - Fixed logs that did not obey to the 'debug' flag
+
 ## 22.02.3
 - Added support for userAgentData
 - Now heatmap scroll event is recorded when leaving a view
@@ -37,28 +43,28 @@
 
 ## 21.11.0
 - !! Major breaking change !! Rating and Feedback widgets now require 'star-rating' or 'feedback' consent exclusively, according to their type, instead of both:
-    - `present_feedback_widget` needs 'feedback' consent only
-    - `get_available_feedback_widgets` needs 'feedback' consent only
-    - `enable_feedback` needs 'star-rating' consent only
-    - `show_feedback_popup` needs 'star-rating' consent only
-    - `initialize_feedback_popups` needs 'star-rating' consent only
-    - `report_feedback` needs 'star-rating' consent only
+  - `present_feedback_widget` needs 'feedback' consent only
+  - `get_available_feedback_widgets` needs 'feedback' consent only
+  - `enable_feedback` needs 'star-rating' consent only
+  - `show_feedback_popup` needs 'star-rating' consent only
+  - `initialize_feedback_popups` needs 'star-rating' consent only
+  - `report_feedback` needs 'star-rating' consent only
 - !! Major breaking change !! Enabling offline mode or changing device ID without merging will now clear the current consent. Consent has to be given again after performing this action.
 - ! Minor breaking change ! 'change_id' will now not accept invalid device ID values. It will now reject null, undefined, values that are not of the type string and empty string values.
 - ! Minor breaking change ! Multiple values now have a default limit adjustable at initialization:
-    - Maximum size of all string keys is now 128 characters by default.
-    - Maximum size of all values in key-value pairs is now 256 characters by default.
-    - Maximum amount of segmentation in one event is mow 30 key-value pairs by default.
-    - Maximum amount of breadcrumbs that can be recorded at once is now 100 by default.
-    - Maximum stack trace lines per thread is now 30 by default.
-    - Maximum stack trace line length is now 200 by default. 
+  - Maximum size of all string keys is now 128 characters by default.
+  - Maximum size of all values in key-value pairs is now 256 characters by default.
+  - Maximum amount of segmentation in one event is mow 30 key-value pairs by default.
+  - Maximum amount of breadcrumbs that can be recorded at once is now 100 by default.
+  - Maximum stack trace lines per thread is now 30 by default.
+  - Maximum stack trace line length is now 200 by default.
 - Bug Fix - Fixed a bug where duration counter/timer was not paused even when the browser was out of focus
 - Deprecating `report_feedback`, now it redirects to `recordRatingWidgetWithID`
 - Deprecating `show_feedback_popup`, now it redirects to `presentRatingWidgetWithID`
 - Deprecating `initialize_feedback_popups`, now it redirects to `initializeRatingWidgets`
 - Deprecating `enable_feedback`, now it redirects to `enableRatingWidgets`
 - Deprecating `report_conversion`, now it redirects to `recordDirectAttribution`
-- When recording internal events with 'add_event', the respective feature consent will now be checked instead of the 'events' consent. 
+- When recording internal events with 'add_event', the respective feature consent will now be checked instead of the 'events' consent.
 - Increased the default max event batch size to 100.
 - Automatic orientation tracking is now enabled by default. It can be turned off during init.
 - Device ID can now be changed when no consent is given
@@ -150,7 +156,7 @@
 
 ## 18.08.2
 - Important Fix for regenerated device_id
-    - Update to this version if you use 18.08 or 18.08.1.
+  - Update to this version if you use 18.08 or 18.08.1.
 - Fixed storing none json data
 - Widgets params changed as popups and back-compatibility provided.
 

package/README.md

@@ -1,4 +1,4 @@
-# Countly Web SDK 
+# Countly Web SDK
  [![Codacy Badge](https://app.codacy.com/project/badge/Grade/79582b7ee7ca4021a3950376402fac00)](https://www.codacy.com/gh/Countly/countly-sdk-web/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-web&utm_campaign=Badge_Grade) [![npm version](https://badge.fury.io/js/countly-sdk-web.svg)](https://badge.fury.io/js/countly-sdk-web) [![](https://data.jsdelivr.com/v1/package/npm/countly-sdk-web/badge)](https://www.jsdelivr.com/package/npm/countly-sdk-web)
 
 ## What is Countly?
@@ -10,14 +10,12 @@ Track, measure, and take action - all without leaving Countly.
 * **Questions?** [Ask in our Community forum](https://support.count.ly/hc/en-us/community/topics)
 
 ## Implementing Countly SDK in your web pages
-
 There are 3 ways to get Countly SDK.
 
 ### 1. Available with Countly server
 Since Countly server 16.02, Countly Web SDK is available in your Countly server installation in `countly/frontend/express/public/sdk/web/countly.min.js` which should be available through URL as `https://yourserver.com/sdk/web/countly.min.js`
 
 ### 2. Installation using package managers
-
     bower install countly-sdk-web
 or
 
@@ -25,19 +23,17 @@ or
 or
 
     yarn add countly-sdk-web
-    
-### 3. Use a CDN (content delivery network)
 
+### 3. Use a CDN (content delivery network)
 Countly web SDK is available on CDNJS. Use either
 
-[https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/22.02.4/countly.min.js](https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/22.02.4/countly.min.js)
+[https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/22.06.0/countly.min.js](https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/22.06.0/countly.min.js)
 
 or
 
 [https://cdn.jsdelivr.net/npm/countly-sdk-web@latest/lib/countly.min.js](https://cdn.jsdelivr.net/npm/countly-sdk-web@latest/lib/countly.min.js)
 
 ## How to use Countly Web SDK?
-
 Link to the script and call helper methods based on what you want to track: sessions, views, clicks, custom events, user data, etc. and for much more information check out our documentation at [https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-)
 
 You can reach minimal integration info for your website from here [https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-#minimal-setup](https://support.count.ly/hc/en-us/articles/360037441932-Web-analytics-JavaScript-#minimal-setup)
@@ -45,30 +41,26 @@ You can reach minimal integration info for your website from here [https://suppo
 Countly Web SDK has JSDoc3 compatible comments and you can generate documentation by running `npm run-script docs` or access online version at [https://countly.github.io/countly-sdk-web/](https://countly.github.io/countly-sdk-web/)
 
 ## Security
-
 Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@count.ly and **not by creating a GitHub issue**.
 
 ## Other Github resources
+Check Countly Community Edition source code here:
 
-Check Countly Community Edition source code here: 
-
-- [Countly Server](https://github.com/Countly/countly-server)
+* [Countly Server](https://github.com/Countly/countly-server)
 
 There are also other Countly SDK repositories below:
 
-- [Countly iOS SDK](https://github.com/Countly/countly-sdk-ios)
-- [Countly Android SDK](https://github.com/Countly/countly-sdk-android)
-- [Countly Windows Phone SDK](https://github.com/Countly/countly-sdk-windows-phone)
-- [Countly Appcelerator Titanium SDK](https://github.com/euforic/Titanium-Count.ly) (Community supported)
-- [Countly Unity3D SDK](https://github.com/Countly/countly-sdk-unity) (Community supported)
+* [Countly iOS SDK](https://github.com/Countly/countly-sdk-ios)
+* [Countly Android SDK](https://github.com/Countly/countly-sdk-android)
+* [Countly Windows Phone SDK](https://github.com/Countly/countly-sdk-windows-phone)
+* [Countly Appcelerator Titanium SDK](https://github.com/euforic/Titanium-Count.ly) (Community supported)
+* [Countly Unity3D SDK](https://github.com/Countly/countly-sdk-unity) (Community supported)
 
 ## How can I help you with your efforts?
-
 Glad you asked. We need ideas, feedbacks and constructive comments. All your suggestions will be taken care with upmost importance. We are on [Twitter](http://twitter.com/gocountly) and [Facebook](https://www.facebook.com/Countly) if you would like to keep up with our fast progress!
 
 ## Badges
-
-If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us, so others know about this wonderful platform? 
+If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us, so others know about this wonderful platform?
 
 <a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg?v2" alt="Countly - Product Analytics" /></a>
 
@@ -79,8 +71,6 @@ If you like Countly, [why not use one of our badges](https://count.ly/brand-asse
     <a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>
 
 ## Support
-
 For a public community support page, visit [https://support.count.ly/hc/en-us/community/topics](https://support.count.ly/hc/en-us/community/topics "Countly Community Forum").
 
 [![NPM](https://nodei.co/npm/countly-sdk-web.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/countly-sdk-web/)
-

package/cypress/.eslintrc.js

@@ -11,7 +11,9 @@ module.exports = {
         "cypress/assertion-before-screenshot": "warn",
         "cypress/no-force": "warn",
         "cypress/no-async-tests": "error",
-        "cypress/no-pause": "error"
+        "cypress/no-pause": "error",
+        "comma-dangle": ["error", "never"],
+        "no-multiple-empty-lines": [2, { max: 1, maxEOF: 0 }]
     },
     env: {
         "cypress/globals": true
@@ -19,5 +21,5 @@ module.exports = {
     extends: [
         "plugin:cypress/recommended",
         "plugin:chai-friendly/recommended"
-    ],
+    ]
 };

package/cypress/integration/consents.js

@@ -21,44 +21,44 @@ const eventArray = [
         key: "a",
         count: 1,
         segmentation: {
-            1: "1",
-        },
+            1: "1"
+        }
     },
     // rest can be internal events
     {
         key: "[CLY]_view",
         count: 2,
         segmentation: {
-            2: "2",
-        },
+            2: "2"
+        }
     },
     {
         key: "[CLY]_nps",
         count: 3,
         segmentation: {
-            3: "3",
-        },
+            3: "3"
+        }
     },
     {
         key: "[CLY]_survey",
         count: 4,
         segmentation: {
-            4: "4",
-        },
+            4: "4"
+        }
     },
     {
         key: "[CLY]_star_rating",
         count: 5,
         segmentation: {
-            5: "5",
-        },
+            5: "5"
+        }
     },
     {
         key: "[CLY]_orientation",
         count: 6,
         segmentation: {
-            6: "6",
-        },
+            6: "6"
+        }
     }
 ];
 // event adding loop

package/cypress/integration/device_id.js

@@ -117,7 +117,6 @@ function checkRequestsForT(queue, expectedInternalType) {
     }
 }
 
-
 /**
  *device ID type:
     *0 - device ID was set by the developer during init
@@ -129,7 +128,7 @@ var DeviceIdTypeInternalEnumsTest = {
     DEVELOPER_SUPPLIED: 0,
     SDK_GENERATED: 1,
     TEMPORARY_ID: 2,
-    URL_PROVIDED: 3,
+    URL_PROVIDED: 3
 };
 describe("Device Id tests during first init", ()=>{
     // sdk is initialized w/o custom device id, w/o offline mode, w/o utm device id
@@ -1082,4 +1081,3 @@ describe("Device Id tests during first init", ()=>{
         });
     });
 });
-

package/cypress/integration/events.js

@@ -21,8 +21,8 @@ const eventObj = {
     dur: 1000,
     segmentation: {
         app_version: "1.0",
-        country: "Tahiti",
-    },
+        country: "Tahiti"
+    }
 };
 // a timed event object
 const timedEventObj = {
@@ -30,8 +30,8 @@ const timedEventObj = {
     count: 1,
     segmentation: {
         app_version: "1.0",
-        country: "Tahiti",
-    },
+        country: "Tahiti"
+    }
 };
 
 describe("Events tests ", () => {

package/cypress/integration/internal_limits.js

@@ -24,11 +24,11 @@ function initMain() {
         max_segmentation_values: limits.segment, // set maximum segmentation number here
         max_breadcrumb_count: limits.breadcrumb, // set maximum number of logs that will be stored before erasing old ones
         max_stack_trace_lines_per_thread: limits.line_thread, // set maximum number of lines for stack trace
-        max_stack_trace_line_length: limits.line_length, // set maximum length of a line for stack 
+        max_stack_trace_line_length: limits.line_length // set maximum length of a line for stack 
     });
 }
 const error = {
-    stack: "Lorem ipsum dolor sit amet,\n consectetur adipiscing elit, sed do eiusmod tempor\n incididunt ut labore et dolore magna\n aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n Duis aute irure dolor in reprehenderit in voluptate\n velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n deserunt mollit anim id\n est laborum.",
+    stack: "Lorem ipsum dolor sit amet,\n consectetur adipiscing elit, sed do eiusmod tempor\n incididunt ut labore et dolore magna\n aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n Duis aute irure dolor in reprehenderit in voluptate\n velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n deserunt mollit anim id\n est laborum."
 };
 const bread = {
     one: "log1",
@@ -37,7 +37,7 @@ const bread = {
     four: "log4",
     five: "log5 too many",
     six: "log6",
-    seven: "log7",
+    seven: "log7"
 };
 const customEvent = {
     key: "Enter your key here",
@@ -47,8 +47,8 @@ const customEvent = {
         "key of 2nd seg": "Value of 2nd seg",
         "key of 3rd seg": "Value of 3rd seg",
         "key of 4th seg": "Value of 4th seg",
-        "key of 5th seg": "Value of 5th seg",
-    },
+        "key of 5th seg": "Value of 5th seg"
+    }
 };
 const viewName = "a very long page name";
 
@@ -68,8 +68,8 @@ const userDetail = {
         "SEGkey 2st one": "SEGVal 2st one",
         "SEGkey 3st one": "SEGVal 3st one",
         "SEGkey 4st one": "SEGVal 4st one",
-        "SEGkey 5st one": "SEGVal 5st one",
-    },
+        "SEGkey 5st one": "SEGVal 5st one"
+    }
 };
 
 const customProperties = {
@@ -81,7 +81,7 @@ const customProperties = {
     min: ["byear", 4567890123456789],
     push: ["gender", "II Fernando Valdez"],
     push_unique: ["gender", "III Fernando Valdez"],
-    pull: ["gender", "III Fernando Valdez"],
+    pull: ["gender", "III Fernando Valdez"]
 };
 
 describe("Internal limit tests ", () => {

package/cypress/integration/sessions.js

@@ -8,8 +8,8 @@ const eventObj = {
     key: "buttonClick",
     count: 1,
     segmentation: {
-        id: "id",
-    },
+        id: "id"
+    }
 };
 
 function initMain() {

package/cypress/integration/user_details.js

@@ -22,8 +22,8 @@ const userDetailObj = {
     byear: 1987, // birth year
     custom: {
         "key1 segment": "value1 segment",
-        "key2 segment": "value2 segment",
-    },
+        "key2 segment": "value2 segment"
+    }
 };
 
 describe("User details tests ", () => {

package/cypress/support/commands.js

@@ -161,20 +161,19 @@ Cypress.Commands.add("check_user_details", (details, userDetails, limits) => {
                 expect(keyList).to.include(key);
             }
         }
+        return;
     }
-    else {
-        expect(queue.name).to.equal(userDetails.name);
-        expect(queue.username).to.equal(userDetails.username);
-        expect(queue.email).to.equal(userDetails.email);
-        expect(queue.organization).to.equal(userDetails.organization);
-        expect(queue.phone).to.equal(userDetails.phone);
-        expect(queue.picture).to.equal(userDetails.picture);
-        expect(queue.gender).to.equal(userDetails.gender);
-        expect(queue.byear).to.equal(userDetails.byear);
-        if (userDetails.custom !== undefined) {
-            for (const key in userDetails.custom) {
-                expect(queue.custom[key]).to.equal(userDetails.custom[key]);
-            }
+    expect(queue.name).to.equal(userDetails.name);
+    expect(queue.username).to.equal(userDetails.username);
+    expect(queue.email).to.equal(userDetails.email);
+    expect(queue.organization).to.equal(userDetails.organization);
+    expect(queue.phone).to.equal(userDetails.phone);
+    expect(queue.picture).to.equal(userDetails.picture);
+    expect(queue.gender).to.equal(userDetails.gender);
+    expect(queue.byear).to.equal(userDetails.byear);
+    if (userDetails.custom !== undefined) {
+        for (const key in userDetails.custom) {
+            expect(queue.custom[key]).to.equal(userDetails.custom[key]);
         }
     }
 });

package/cypress/support/helper.js

@@ -27,7 +27,6 @@ function getTimestampMs() {
     return new Date().getTime();
 }
 
-
 /**
  * Fine tuner for flaky tests. Retries test for  a certain amount
  * @param {number} startTime - starting time, timestamp
@@ -48,7 +47,6 @@ var waitFunction = function(startTime, waitTime, waitIncrement, continueCallback
     }
 };
 
-
 module.exports = {
     haltAndClearStorage,
     sWait,
@@ -56,5 +54,5 @@ module.exports = {
     lWait,
     appKey,
     getTimestampMs,
-    waitFunction,
+    waitFunction
 };

package/cypress/support/integration_helper.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-unused-vars */
+
 /**
  *  Extracts the query from url and returns an object with config values
  * @param {string} query - url query

package/examples/Angular/.browserslistrc

@@ -0,0 +1,17 @@
+# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
+# For additional information regarding the format and rule options, please see:
+# https://github.com/browserslist/browserslist#queries
+
+# For the full list of supported browsers by the Angular framework, please see:
+# https://angular.io/guide/browser-support
+
+# You can see what browsers were selected by your queries by running:
+#   npx browserslist
+
+last 1 Chrome version
+last 1 Firefox version
+last 2 Edge major versions
+last 2 Safari major versions
+last 2 iOS major versions
+Firefox ESR
+not IE 11 # Angular supports IE 11 only as an opt-in. To opt-in, remove the 'not' prefix on this line.

package/examples/Angular/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/examples/Angular/README.md

@@ -0,0 +1,27 @@
+# Angular
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.4.
+
+## Development server
+
+Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+
+## Code scaffolding
+
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+
+## Build
+
+Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Running unit tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Running end-to-end tests
+
+Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.