ember-metrics - npm Package Compare versions

Comparing version 2.0.0-beta.1 to 2.0.0-beta.2

-private/utils/object-transforms.d.ts

@@ -1,2 +0,2 @@
-declare type Options = Record<string, string>;
+type Options = Record<string, string>;
 /**
@@ -3,0 +3,0 @@ * Present config options

addon/metrics-adapters/google-tag-manager.js

@@ -1,2 +0,2 @@
-import { assert } from '@ember/debug';
+import { assert, deprecate } from '@ember/debug';
 import { capitalize } from '@ember/string';
@@ -50,2 +50,13 @@ import { compact } from 'ember-metrics/-private/utils/object-transforms';
 
+    deprecate(
+      'Future versions of the GoogleTagManagerAdapter will no longer prefix top-level dataLayer keys with `event`. If you wish to retain this behaviour you will need to override the adapter and prefix the keys yourself.',
+      false,
+      {
+        id: 'ember-metrics.issue-438',
+        for: 'ember-metrics',
+        since: '1.5.0',
+        until: '2.0.0',
+      }
+    );
+
     delete compactedOptions['event'];
@@ -52,0 +63,0 @@

CHANGELOG.md

@@ -1,2 +0,2 @@
-# v1.1.0
+## v2.0.0-beta.2 (2023-01-03)
 
@@ -14,3 +14,15 @@ ## v2.0.0-beta.1 (2022-05-12)
 
+## v1.5.2 (2022-05-17)
 
+### Changes
+
+Introduce deprecation warning for some GA behaviour (https://github.com/adopted-ember-addons/ember-metrics/pull/444)
+
+
+## v1.5.1 (2022-05-12)
+
+### Changes
+
+- Revert a broad refactor to native classes that's not backwards compatible https://github.com/adopted-ember-addons/ember-metrics/pull/372
+
 ## v1.5.0 (2022-05-10)
@@ -17,0 +29,0 @@

package.json

 {
   "name": "ember-metrics",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "Send data to multiple analytics integrations without re-implementing new API",
@@ -51,3 +51,3 @@ "keywords": [
     "ember-cli-babel": "^7.26.6",
-    "ember-cli-typescript": "^4.2.1"
+    "ember-cli-typescript": "^5.1.1"
   },
@@ -57,24 +57,24 @@ "devDependencies": {
     "@ember/test-helpers": "^2.4.2",
-    "@embroider/test-setup": "^1.2.0",
+    "@embroider/test-setup": "^2.0.0",
     "@glimmer/tracking": "^1.0.4",
-    "@types/ember-qunit": "^3.4.14",
+    "@types/ember-qunit": "^5.0.1",
     "@types/ember-resolver": "^5.0.10",
     "@types/ember__application": "^3.16.3",
-    "@types/ember__array": "^3.16.4",
-    "@types/ember__component": "^3.16.6",
-    "@types/ember__controller": "^3.16.6",
-    "@types/ember__debug": "^3.16.5",
-    "@types/ember__engine": "^3.16.3",
-    "@types/ember__error": "^3.16.1",
-    "@types/ember__object": "^3.12.6",
-    "@types/ember__polyfills": "^3.12.1",
-    "@types/ember__routing": "^3.16.15",
-    "@types/ember__runloop": "^3.16.3",
-    "@types/ember__service": "^3.16.1",
+    "@types/ember__array": "^4.0.2",
+    "@types/ember__component": "^4.0.10",
+    "@types/ember__controller": "^4.0.1",
+    "@types/ember__debug": "^4.0.1",
+    "@types/ember__engine": "^4.0.2",
+    "@types/ember__error": "^4.0.0",
+    "@types/ember__object": "^4.0.4",
+    "@types/ember__polyfills": "^4.0.0",
+    "@types/ember__routing": "^4.0.10",
+    "@types/ember__runloop": "^4.0.1",
+    "@types/ember__service": "^4.0.0",
     "@types/ember__string": "^3.16.3",
     "@types/ember__template": "^4.0.0",
-    "@types/ember__test": "^3.16.1",
+    "@types/ember__test": "^4.0.0",
     "@types/ember__test-helpers": "^2.0.2",
     "@types/ember__utils": "^4.0.0",
-    "@types/htmlbars-inline-precompile": "^1.0.1",
+    "@types/htmlbars-inline-precompile": "^3.0.0",
     "@types/qunit": "^2.11.2",
@@ -97,3 +97,3 @@ "@types/rsvp": "^4.0.4",
     "ember-load-initializers": "^2.1.2",
-    "ember-qunit": "^5.1.4",
+    "ember-qunit": "^6.0.0",
     "ember-resolver": "^8.0.3",
@@ -107,3 +107,3 @@ "ember-sinon": "^5.0.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-ember": "^10.5.4",
+    "eslint-plugin-ember": "^11.0.6",
     "eslint-plugin-node": "^11.1.0",
@@ -119,5 +119,5 @@ "eslint-plugin-prettier": "^4.0.0",
     "qunit-sinon-assertions": "^1.0.0",
-    "release-it": "^14.2.1",
-    "release-it-lerna-changelog": "^4.0.0",
-    "typedoc": "^0.22.4",
+    "release-it": "^15.4.1",
+    "release-it-lerna-changelog": "^5.0.0",
+    "typedoc": "^0.23.14",
     "typescript": "^4.4.3",
@@ -124,0 +124,0 @@ "webpack": "5"

README.md

@@ -19,2 +19,16 @@ # ember-metrics
 
+1. `GoogleAnalyticsFour`
+
+   - `id`: [Measurement Id](https://support.google.com/analytics/answer/9539598?hl=en), e.g. `G-XXXX`
+   - `options`: _optional_ An object which will be directly passed to the configuration tag, e.g.:
+
+   ```js
+   options = {
+     anonymize_ip: true,
+     debug_mode: environment === 'development',
+   };
+   ```
+
+   By default GA4 automatically tracks page views when the history locations changes. This means that `this.metrics.trackPage()` is ignoreded by default. However, if you want to track the page views manually, you need to set `send_page_view: false` inside the options. To avoid double counting page views make sure [enhanced measurement](https://support.google.com/analytics/answer/9216061) is configured correctly. Typically, this means disabling _Page changes based on browser history events_ under the advanced settings of the page views section.
+
 1. `Mixpanel`
@@ -42,5 +56,5 @@
 
+   ```js
+   envParams: 'gtm_auth=xxxxx&gtm_preview=env-xx&gtm_cookies_win=x';
    ```
-   envParams: "gtm_auth=xxxxx&gtm_preview=env-xx&gtm_cookies_win=x"
-   ```
 
@@ -88,5 +102,9 @@ 1. `Segment`
 
-  - `matomoUrl`: [Matomo URL](https://developer.matomo.org/guides/tagmanager/embedding)
-  - `containerId`: [Container ID](https://developer.matomo.org/guides/tagmanager/embedding), e.g. `acbd1234`
+   - `matomoUrl`: [Matomo URL](https://developer.matomo.org/guides/tagmanager/embedding)
+   - `containerId`: [Container ID](https://developer.matomo.org/guides/tagmanager/embedding), e.g. `acbd1234`
 
+1. `Hotjar`
+
+   - `siteId`: [SiteID](https://help.hotjar.com/hc/en-us/articles/115009336727-How-to-Install-your-Hotjar-Tracking-Code)
+
 #### Community adapters
@@ -98,2 +116,6 @@
 
+1. `Simple Analytics`
+
+   - [ember-metrics-simple-analytics](https://github.com/mrloop/ember-metrics-simple-analytics)
+
 ## Installing The Addon
@@ -135,2 +157,13 @@
       {
+        name: 'GoogleAnalyticsFour',
+        environments: ['production'],
+        config: {
+          id: 'G-XXXX',
+          options: {
+            anonymize_ip: true,
+            debug_mode: environment === 'development',
+          },
+        },
+      },
+      {
         name: 'Mixpanel',
@@ -215,8 +248,15 @@ environments: ['production'],
         name: 'MatomoTagManager',
-        environments: ['production'], 
+        environments: ['production'],
         config: {
           matomoUrl: 'matomo.my.com',
-          containerId: 'acd123'
+          containerId: 'acd123',
         },
       },
+      {
+        name: 'Hotjar',
+        environments: ['production'],
+        config: {
+          siteId: '123456789',
+        },
+      },
     ],
@@ -223,0 +263,0 @@ };

No alert changes

Improved metrics

Total package byte prevSize

83082

increased by7.38%

Number of package files

49

increased by8.89%

Lines of code

1389

increased by9.98%

Number of lines in readme file

525

increased by8.25%

Dependency changes

• + Addedelectron-to-chromium@1.4.774(transitive)

• + Addedember-cli-typescript@5.3.0(transitive)

• - Removedelectron-to-chromium@1.4.772(transitive)

• - Removedember-cli-typescript@4.2.1(transitive)

• Updatedember-cli-typescript@^5.1.1