Back-merge main into development

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [20]
 
     steps:
       - name: Checkout

README.md

@@ -1,6 +1,6 @@
 ![GitHub branch checks state][build-url] [![codecov][cov-img]][cov-url] [![Known Vulnerabilities][snyk-img]][snyk-url]
 
-# Zaraz
+# Zaraz TS
 
 A type-safe wrapper around the Cloudflare Zaraz Web API.
 
@@ -14,22 +14,22 @@ A type-safe wrapper around the Cloudflare Zaraz Web API.
 Import zaraz and call the desired method. That's it!
 
 ```ts
-import { zaraz } from 'zaraz';
+import { zaraz } from 'zaraz-ts';
 
 // Track custom events on your website, that might happen in real time.
 await zaraz.track("button clicked", { userId: "ABC-123", value: 200 })
 ```
 
 ```ts
-import { zaraz } from 'zaraz';
+import { zaraz } from 'zaraz-ts';
 
 // Make a variable available in all your events without manually setting it 
 // every time you are using zaraz.track().
 zaraz.set('user_id', '123456');
 ```
 
 ```ts
-import { zaraz } from 'zaraz';
+import { zaraz } from 'zaraz-ts';
 
 // Track common events of the e-commerce user journey, such as when a user adds 
 // a product to cart, starts the checkout funnel or completes an order. 
@@ -65,6 +65,8 @@ await zaraz.ecommerce('Order Completed', {
 });
 ```
 
+Checkout the official Cloudflare docs for more details: https://developers.cloudflare.com/zaraz/web-api/.
+
 ### Maintenance 👷
 
 This package is maintained and actively used by [Expatfile.tax][expatfile-site].

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "zaraz",
+  "name": "zaraz-ts",
   "version": "0.0.0-development",
-  "description": "Zaraz - A type-safe wrapper around the Cloudflare Zaraz Web API.",
+  "description": "Zaraz TS - A type-safe wrapper around the Cloudflare Zaraz Web API.",
   "main": "build/index.js",
   "scripts": {
     "lint": "eslint ./src",
@@ -15,20 +15,22 @@
     "semantic-release": "semantic-release"
   },
   "keywords": [
+    "zaraz-ts",
     "zaraz",
+    "type-safe",
     "cloudflare",
     "typescript"
   ],
   "author": "Expatfile.tax LLC",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/expatfile/zaraz.git"
+    "url": "https://github.com/expatfile/zaraz-ts.git"
   },
   "bugs": {
-    "url": "https://github.com/expatfile/zaraz/issues"
+    "url": "https://github.com/expatfile/zaraz-ts/issues"
   },
-  "homepage": "https://github.com/expatfile/zaraz#readme",
+  "homepage": "https://github.com/expatfile/zaraz-ts#readme",
   "dependencies": {},
   "devDependencies": {
     "@testing-library/jest-dom": "^6.1.4",

src/ecommerce.spec.ts

@@ -0,0 +1,36 @@
+import { ecommerce } from './ecommerce';
+
+const trackMock = jest.fn();
+const setMock = jest.fn();
+const ecommerceMock = jest.fn();
+
+declare global {
+  interface Window {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    zaraz: any;
+  }
+}
+
+let windowObj: Window & typeof globalThis;
+
+beforeAll(() => {
+  windowObj = window;
+});
+
+afterAll(() => {
+  window = windowObj;
+});
+
+describe('ecommerce()', () => {
+  it('should call zaraz ecommerce when called', () => {
+    window.zaraz = {
+      track: trackMock,
+      set: setMock,
+      ecommerce: ecommerceMock,
+    };
+
+    ecommerce('Cart Viewed');
+
+    expect(ecommerceMock).toHaveBeenCalledWith('Cart Viewed', undefined);
+  });
+});

src/set.spec.ts

@@ -0,0 +1,36 @@
+import { set } from './set';
+
+const trackMock = jest.fn();
+const setMock = jest.fn();
+const ecommerceMock = jest.fn();
+
+declare global {
+  interface Window {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    zaraz: any;
+  }
+}
+
+let windowObj: Window & typeof globalThis;
+
+beforeAll(() => {
+  windowObj = window;
+});
+
+afterAll(() => {
+  window = windowObj;
+});
+
+describe('set()', () => {
+  it('should call zaraz set when called', () => {
+    window.zaraz = {
+      track: trackMock,
+      set: setMock,
+      ecommerce: ecommerceMock,
+    };
+
+    set('user_id', '123456');
+
+    expect(setMock).toHaveBeenCalledWith('user_id', '123456', undefined);
+  });
+});

src/track.spec.ts

@@ -0,0 +1,39 @@
+import { track } from './track';
+
+const trackMock = jest.fn();
+const setMock = jest.fn();
+const ecommerceMock = jest.fn();
+
+declare global {
+  interface Window {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    zaraz: any;
+  }
+}
+
+let windowObj: Window & typeof globalThis;
+
+beforeAll(() => {
+  windowObj = window;
+});
+
+afterAll(() => {
+  window = windowObj;
+});
+
+describe('track()', () => {
+  it('should call zaraz track when called', () => {
+    window.zaraz = {
+      track: trackMock,
+      set: setMock,
+      ecommerce: ecommerceMock,
+    };
+
+    track('button clicked', { userId: 'ABC-123', value: 200 });
+
+    expect(trackMock).toHaveBeenCalledWith('button clicked', {
+      userId: 'ABC-123',
+      value: 200,
+    });
+  });
+});