Merge pull request #12 from expatfile/development

🔖 Release stable version

.github/actions/setup-pnpm/action.yml

@@ -15,44 +15,21 @@ runs:
   using: "composite"
 
   steps:
-  - name: Install Node.js ${{ matrix.node-version }}
-    uses: actions/setup-node@v3
-    with:
-      node-version: ${{ matrix.node-version }}
-
   - name: Install pnpm
     uses: pnpm/action-setup@v2
     id: pnpm-install
     with:
       version: 8
       run_install: false
 
-  - name: Set pnpm home
-    shell: bash
-    run: |
-      echo "PNPM_HOME=$HOME/.local/share/pnpm" >> $GITHUB_ENV
-      echo "$HOME/.local/share/pnpm" >> $GITHUB_PATH
-
-  - name: Get pnpm store directory
-    id: pnpm-cache
-    shell: bash
-    run: |
-      echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
-
-  - name: Setup pnpm cache
-    uses: actions/cache@v3
+  - name: Install Node.js ${{ matrix.node-version }}
+    uses: actions/setup-node@v4
     with:
-      path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
-      key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-      restore-keys: |
-        ${{ runner.os }}-pnpm-store-
-
-  - name: Authenticate for private NPM package
-    shell: bash
+      node-version: ${{ matrix.node-version }}
+      cache: pnpm
+      registry-url: 'https://registry.npmjs.org'
     env:
-      NPM_TOKEN: ${{ inputs.npm_token }}
-    run: |
-      echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
+      NODE_AUTH_TOKEN: ${{ inputs.npm_token }}
 
   - name: Install dependencies
     shell: bash

.github/workflows/ci.yml

@@ -80,6 +80,6 @@ jobs:
             --coverage
 
       - name: Upload code coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -6,6 +6,7 @@ A type-safe wrapper around the Cloudflare Zaraz Web API.
 
 - Basic types for `zaraz.track()`;
 - Basic types for `zaraz.set()`;
+- Basic types for `zaraz.consent()`;
 - Extensive types for `zaraz.ecommerce()`;
 - Cheks for `zaraz` being available in the window.
 
@@ -17,22 +18,22 @@ Import zaraz and call the desired method. That's it!
 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 })
+await zaraz.track('button clicked', { userId: 'ABC-123', value: 200 });
 ```
 
 ```ts
 import { zaraz } from 'zaraz-ts';
 
-// Make a variable available in all your events without manually setting it 
+// 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-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. 
+// 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.
 await zaraz.ecommerce('Order Completed', {
   checkout_id: '616727740',
   order_id: '817286897056801',
@@ -72,7 +73,6 @@ Checkout the official Cloudflare docs for more details: https://developers.cloud
 This package is maintained and actively used by [Expatfile.tax][expatfile-site].
 The #1 US expat tax e-filing software. 🇺🇸
 
-
 [build-url]: https://img.shields.io/github/checks-status/expatfile/zaraz-ts/main
 [cov-img]: https://codecov.io/gh/expatfile/zaraz-ts/branch/main/graph/badge.svg?token=mbGgsweFuP
 [cov-url]: https://codecov.io/gh/expatfile/zaraz-ts

package.json

@@ -33,23 +33,23 @@
   "homepage": "https://github.com/expatfile/zaraz-ts#readme",
   "dependencies": {},
   "devDependencies": {
-    "@testing-library/jest-dom": "^6.2.0",
-    "@types/eslint": "^8.56.2",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.4",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
+    "@testing-library/jest-dom": "^6.4.2",
+    "@types/eslint": "^8.56.7",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.6.0",
+    "@typescript-eslint/parser": "^7.6.0",
     "audit-ci": "^6.6.1",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "prettier": "^3.2.2",
-    "semantic-release": "^23.0.0",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.3.3"
+    "prettier": "^3.2.5",
+    "semantic-release": "^23.0.8",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.5"
   }
 }