fleek-track-analytics 1.17.61 → 1.17.63

package/README.md

@@ -6,7 +6,7 @@ with trace(session) management.
 ### Table of Contents
 
 - [fleek-track-analytics](#fleek-track-analytics)
-  - [Table of Contents](#table-of-contents)
+    - [Table of Contents](#table-of-contents)
 - [How to Integrate](#how-to-integrate)
 - [How to setup for development](#how-to-setup-for-development)
 - [How to publish changes to npm](#how-to-publish-changes-to-npm)
@@ -17,7 +17,6 @@ with trace(session) management.
 # How to Integrate
 
 1. Install the package
-
 ```sh
 # npm
 npm install fleek-track-analytics
@@ -27,7 +26,6 @@ yarn add fleek-track-analytics
 ```
 
 2. Import based on platform
-
 ```ts
 # node
 import { TrackAnalytics } from "fleek-track-analytics/lib/node";
@@ -41,7 +39,7 @@ import { TrackAnalytics } from "fleek-track-analytics/lib/web";
 
 3. Initialise TrackAnalytics.
 
-```ts
+  ```ts
 import { TrackAnalytics } from 'fleek-track-analytics/lib/__platform__';
 
 const analyticsException = (e: unknown) => {
@@ -64,21 +62,21 @@ const analyticsWrapper = new TrackAnalytics({
 
 analyticsWrapper.initAnalytics();
 
-export { analyticsWrapper };
+export { analyticsWrapper }
 ```
 
 Parameter description for TrackAnalytics class constructor
 
-| property     |                    value                     | description                                                                        |
-| ------------ | :------------------------------------------: | ---------------------------------------------------------------------------------- |
-| platfrom     |        `REACT_NATIVE` , `WEB`, `NODE`        | this is used for internal working of analytics to                                  |
-| App          | `CUSTOMER_APP`, `CUSTOMER_WEB`, `VENDOR_APP` | this property is send with all events as `fleek_platform`                          |
-| segment      |                   boolean                    | enables segment integration                                                        |
-| segmentKey   |                    string                    | writeKey for segment                                                               |
-| devMode      |                   boolean                    | if enabled, only log the event do not trigger network calls                        |
-| debug        |                   boolean                    | if enabled, triggers network calls for events when devMode is true.                |
-| errorHandler |                   function                   | an error handler to manage any errors thrown while initialising and sending events |
-| rudderstack  |              object (optional)               | RudderStack configuration for self-hosted migration (see RudderStack Setup below)  |
+| property        | value           | description  |
+| ------------- |:-------------:| ----- |
+| platfrom     | `REACT_NATIVE` , `WEB`, `NODE`    | this is used for internal working of analytics to  |
+| App      | `CUSTOMER_APP`, `CUSTOMER_WEB`, `VENDOR_APP`       |   this property is send with all events as `fleek_platform` |
+| segment | boolean     |    enables segment integration |
+| segmentKey | string     |   writeKey for segment |
+| devMode | boolean     |   if enabled, only log the event do not trigger network calls |
+| debug | boolean      |  if enabled, triggers network calls for events when devMode is true.  |
+| errorHandler | function     | an error handler to manage any errors thrown while initialising and sending events  |
+| rudderstack | object (optional)     | RudderStack configuration for self-hosted migration (see RudderStack Setup below) |
 
 ## RudderStack Setup (Self-Hosted Migration)
 
@@ -107,8 +105,7 @@ const analyticsWrapper = new TrackAnalytics({
 
 Event routing to RudderStack is controlled by an **internal library configuration** file (`src/web/analytics-tool/rudderstack-event-routing.ts`). This allows you to selectively send specific events to RudderStack during the PoC phase without requiring application changes.
 
-**Important**:
-
+**Important**: 
 - All events are **always sent to Segment** (unchanged behavior)
 - Events are **conditionally sent to RudderStack** based on the internal routing configuration
 - RudderStack failures do not affect Segment sending
@@ -126,8 +123,11 @@ To control which events are sent to RudderStack, modify the `rudderstackEventRou
 ```ts
 export const rudderstackEventRouting: IRudderstackEventRouting = {
   // Option 1: List specific event names
-  sendToRudderstack: ['event_name_1', 'event_name_2'],
-
+  sendToRudderstack: [
+    'event_name_1',
+    'event_name_2',
+  ],
+  
   // Option 2: Use regex patterns
   eventPatterns: ['^test_', '^poc_'], // Matches events starting with 'test_' or 'poc_'
 };
@@ -142,7 +142,6 @@ export const rudderstackEventRouting: IRudderstackEventRouting = {
 ### Documentation
 
 For more details on the migration, see:
-
 - SDK Comparison: `spec-files/rudderstack-migration/SEGMENT_VS_RUDDERSTACK_SDK_COMPARISON.md`
 - Self-Hosted Parameters: `spec-files/rudderstack-migration/RUDDERSTACK_SELF_HOSTED_PARAMETERS.md`
 - Architecture (HLD/LLD): `spec-files/rudderstack-migration/HLD_LLD.md`
@@ -151,12 +150,12 @@ For more details on the migration, see:
 
 ```ts
 import { analyticsWrapper } from '../utils/track-analytics';
-import { EVENT_NAMES } from 'fleek-track-analytics';
+import { EVENT_NAMES } from 'fleek-track-analytics'
 
 analyticsWrapper.track(EVENT_NAMES.HOME_SCREEN_VIEWED, {
-  customer_id: AuthInfo.getAuthData().user?.customerId,
-  access_country: props?.responseHeaders?.resolvedCountryCode,
-});
+      customer_id: AuthInfo.getAuthData().user?.customerId,
+      access_country: props?.responseHeaders?.resolvedCountryCode,
+    })
 ```
 
 Note: Each event name is configured to have specify param type defination via `EVENT_MAP`. In the example above, if one more property is added in the parameters, the typescript will error.
@@ -165,10 +164,12 @@ How to declare events in the `EVENT_MAP` is explained here.
 You can also use the base events given by segment smillarly
 
 ```ts
-analytics.identify(id, traits);
 
-analyticsWrapper.page({ name: pageName }); // web
-analyticsWrapper.screen(name, options); // react-native
+analytics.identify(id , traits)
+
+analyticsWrapper.page({ name: pageName }) // web
+analyticsWrapper.screen(name, options) // react-native
+
 ```
 
 # How to setup for development
@@ -176,7 +177,6 @@ analyticsWrapper.screen(name, options); // react-native
 1. Clone the repository
 
 2. Run
-
 ```sh
 yarn && yarn build
 
@@ -184,16 +184,15 @@ yarn && yarn build
 
 3. Login to npm with fleek credentials. (Acquire the credentials from the team members)
 
+
 # How to publish changes to npm
 
 1. After updating the code, change the package json to a new version based on following rules
-
 - If changes in library code upgrade as minor release patch. Example `1.1.20` to `1.2.20`
 - If changes in eventmap upgrade as patch. Example `1.2.20` to `1.2.21`
 
 2. Build and publish
-
-````sh
+```sh
 yarn build && npm publish
 ``
 
@@ -203,7 +202,7 @@ In order to build reliability in event data consistency across platform, `.track
 
 ```ts
 type track = <T extends EVENT_NAMES>(eventName: T, eventParams: EVENT_MAP[T]) => Promise<void> | void
-````
+```
 
 # How to change event map
 
@@ -211,18 +210,18 @@ type track = <T extends EVENT_NAMES>(eventName: T, eventParams: EVENT_MAP[T]) =>
 
 2. To add a new events, create a enum entry in EVENT_NAMES by updating `src/event-map/event-map.ts`
 
-```ts
+ ```ts
 // src/event-map/event-map.ts
 
 export enum EVENT_NAMES {
- HOME_SCREEN_VIEWED = 'homescreen_viewed',
- PRODUCT_TILE_CLICKED = 'product_tile_clicked',
- PRODUCT_DETAIL_PAGE_VIEWED = 'product_detail_page_viewed',
- ADD_TO_CART = 'add_to_cart',
- CART_VIEWED = 'cart_viewed',
- CHECKOUT_CLICKED = 'checkout_clicked',
- // add a new event name
- MY_NEW_EVENT = 'my_new_event
+  HOME_SCREEN_VIEWED = 'homescreen_viewed',
+  PRODUCT_TILE_CLICKED = 'product_tile_clicked',
+  PRODUCT_DETAIL_PAGE_VIEWED = 'product_detail_page_viewed',
+  ADD_TO_CART = 'add_to_cart',
+  CART_VIEWED = 'cart_viewed',
+  CHECKOUT_CLICKED = 'checkout_clicked',
+  // add a new event name
+  MY_NEW_EVENT = 'my_new_event
 }
 ```
 
@@ -243,7 +242,7 @@ export interface IMyNewEvent {
 4. Add the mapping of event name and params in `src/event-map/event-map.ts`
 
 ```ts
-export interface EVENT_MAP {
+  export interface EVENT_MAP {
   [EVENT_NAMES.HOME_SCREEN_VIEWED]: IHomeScreenViewed;
   [EVENT_NAMES.PRODUCT_TILE_CLICKED]: IProductTileClicked;
   [EVENT_NAMES.PRODUCT_DETAIL_PAGE_VIEWED]: IProductDetailPageViewed;
@@ -251,17 +250,18 @@ export interface EVENT_MAP {
   [EVENT_NAMES.CART_VIEWED]: ICartViewed;
   [EVENT_NAMES.CHECKOUT_CLICKED]: ICheckoutClicked;
   // add mapping for MY_NEW_EVENT
-  [EVENT_NAMES.MY_NEW_EVENT]: IMyNewEvent;
+  [EVENT_NAMES.MY_NEW_EVENT]: IMyNewEvent
 }
+
 ```
 
 5. Follow the step in Releasing a new version of fleek-track-analytic section to release these changes in a new package version
 
 6. Upgrade the package in your application by running
-
 ```sh
 yarn upgrade fleek-track-analytics --latest
 ```
-
 7. Post upgrade the `eventmap` will be updated and available to use (without rebuilding the app if it is already running)
 8. After adding an event here, you also need to update the mapping on [Segment website](https://app.segment.com/joinfleek/destinations/actions-mixpanel/sources/fleek-customer-app/instances/660fd99488053261afc7b686/actions/64o9zGEeDcJcAKXuxWdJFA)
+
+

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);