@adobe/alloy 2.29.0 → 2.30.0-beta.0

package/libEs6/components/PushNotifications/request/makeSendServiceWorkerTrackingData.js

@@ -0,0 +1,146 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+/* eslint-disable no-underscore-dangle */
+
+/** @import { ServiceWorkerLogger } from '../types.js' */
+/** @import { TrackingDataPayload   } from '../types.js' */
+
+import readFromIndexedDb from "../helpers/readFromIndexedDb.js";
+import uuidv4 from "../../../utils/uuid.js";
+
+/**
+ * @async
+ * @function
+ * @param {Object} options
+ * @param {Object} options.xdm
+ * @param {string} [options.actionLabel]
+ * @param {number} [options.applicationLaunches=0]
+ * @param {Object} utils
+ * @param {ServiceWorkerLogger} utils.logger
+ * @param {(url: string, options: object) => Promise<Response>} utils.fetch
+ *
+ * @returns {Promise<boolean>}
+ * @throws {Error}
+ */
+export default async ({
+  xdm,
+  actionLabel,
+  applicationLaunches = 0
+}, {
+  logger,
+  fetch
+}) => {
+  const configData = await readFromIndexedDb(logger);
+  const {
+    browser,
+    ecid,
+    edgeDomain,
+    edgeBasePath,
+    datastreamId,
+    datasetId
+  } = configData || {};
+  let customActionData = {};
+  if (actionLabel) {
+    customActionData = {
+      customAction: {
+        actionID: actionLabel
+      }
+    };
+  }
+  const requiredFields = [{
+    name: "browser",
+    errorField: "Browser"
+  }, {
+    name: "ecid",
+    errorField: "ECID"
+  }, {
+    name: "edgeDomain",
+    errorField: "Edge domain"
+  }, {
+    name: "edgeBasePath",
+    errorField: "Edge base path"
+  }, {
+    name: "datastreamId",
+    errorField: "Datastream ID"
+  }, {
+    name: "datasetId",
+    errorField: "Dataset ID"
+  }];
+  try {
+    for (const field of requiredFields) {
+      if (!configData[field.name]) {
+        throw new Error(`Cannot send tracking call. ${field.errorField} is missing.`);
+      }
+    }
+    const url = `https://${edgeDomain}/${edgeBasePath}/v1/interact?configId=${datastreamId}`;
+
+    /** @type {TrackingDataPayload} */
+    const payload = {
+      events: [{
+        xdm: {
+          identityMap: {
+            ECID: [{
+              id: ecid
+            }]
+          },
+          timestamp: new Date().toISOString(),
+          pushNotificationTracking: {
+            ...customActionData,
+            pushProviderMessageID: uuidv4(),
+            pushProvider: browser.toLowerCase()
+          },
+          application: {
+            launches: {
+              value: applicationLaunches
+            }
+          },
+          eventType: actionLabel ? "pushTracking.customAction" : "pushTracking.applicationOpened",
+          _experience: {
+            ...xdm._experience,
+            customerJourneyManagement: {
+              ...xdm._experience.customerJourneyManagement,
+              pushChannelContext: {
+                platform: "web"
+              },
+              messageProfile: {
+                channel: {
+                  _id: "https://ns.adobe.com/xdm/channels/push"
+                }
+              }
+            }
+          }
+        },
+        meta: {
+          collect: {
+            datasetId
+          }
+        }
+      }]
+    };
+    const response = await fetch(url, {
+      method: "POST",
+      headers: {
+        "content-type": "text/plain; charset=UTF-8"
+      },
+      body: JSON.stringify(payload)
+    });
+    if (!response.ok) {
+      logger.error("Tracking call failed: ", response.status, response.statusText);
+      return false;
+    }
+    return true;
+  } catch (error) {
+    logger.error("Error sending tracking call:", error);
+    return false;
+  }
+};

package/libEs6/components/PushNotifications/serviceWorker.js

@@ -0,0 +1,90 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+/** @import { ServiceWorkerLogger } from './types.js' */
+
+import serviceWorkerNotificationClickListener from "./helpers/serviceWorkerNotificationClickListener.js";
+import serviceWorkerPushListener from "./helpers/serviceWorkerPushListener.js";
+import makeSendServiceWorkerTrackingData from "./request/makeSendServiceWorkerTrackingData.js";
+
+/* eslint-disable no-console */
+/* eslint-disable no-underscore-dangle */
+
+// @ts-check
+/// <reference lib="webworker" />
+
+/** @type {ServiceWorkerGlobalScope} */
+// @ts-ignore
+const sw = self;
+
+/**
+ * @type {ServiceWorkerLogger}
+ */
+const logger = {
+  namespace: "[alloy][pushNotificationWorker]",
+  info: (...args) => console.log(logger.namespace, ...args),
+  error: (...args) => console.error(logger.namespace, ...args)
+};
+
+/**
+ * @listens install
+ */
+sw.addEventListener("install", () => {
+  sw.skipWaiting();
+});
+
+/**
+ * @listens activate
+ * @param {ExtendableEvent} event
+ */
+sw.addEventListener("activate", event => {
+  event.waitUntil(sw.clients.claim());
+});
+
+/**
+ * @listens push
+ * @param {PushEvent} event
+ * @returns {Promise<void>}
+ */
+sw.addEventListener("push", event => serviceWorkerPushListener({
+  event,
+  logger,
+  sw
+}));
+
+/**
+ * @listens notificationclick
+ * @param {NotificationEvent} event
+ */
+sw.addEventListener("notificationclick", event => serviceWorkerNotificationClickListener({
+  event,
+  sw,
+  logger,
+  fetch
+}));
+
+/**
+ * @listens notificationclose
+ * @param {NotificationEvent} event
+ */
+sw.addEventListener("notificationclose", event => {
+  const data = event.notification.data;
+  makeSendServiceWorkerTrackingData({
+    xdm: data._xdm.mixins,
+    actionLabel: "Dismiss"
+  }, {
+    logger,
+    fetch
+  }).catch(error => {
+    logger.error("Failed to send tracking call:", error);
+  });
+});

package/libEs6/components/PushNotifications/types.js

@@ -8,4 +8,85 @@
  * @property {string|null} keys.auth - The authentication secret as an ArrayBuffer, or null if not available
  */
 
+/**
+ * @typedef {Object} CustomerJourneyManagement
+ * @property {Object} messageExecution
+ * @property {string} messageExecution.messageExecutionID
+ * @property {string} messageExecution.messageID
+ * @property {string} messageExecution.messageType
+ * @property {string} messageExecution.campaignID
+ * @property {string} messageExecution.campaignVersionID
+ * @property {string} messageExecution.batchInstanceID
+ * @property {Object} [pushChannelContext]
+ * @property {"web"} [pushChannelContext.platform]
+ * @property {Object} [messageProfile]
+ * @property {Object} [messageProfile.channel]
+ * @property {string} [messageProfile.channel._id]
+ */
+
+/**
+ * @typedef {Object} Decisioning
+ * @property {Object[]} propositions
+ * @property {Object} propositions[].scopeDetails
+ * @property {string} propositions[].scopeDetails.correlationID
+ */
+
+/**
+ * @typedef {Object} XdmTrackingContext
+ * @property {Object} _experience
+ * @property {CustomerJourneyManagement} _experience.customerJourneyManagement
+ * @property {Decisioning} _experience.decisioning
+ */
+
+/**
+ * @typedef {Object} PushNotificationData
+ * @property {Object} web
+ * @property {string} web.title
+ * @property {string} web.body
+ * @property {string|null} web.media
+ * @property {Object} web.interaction
+ * @property {string} web.interaction.type
+ * @property {string|null} web.interaction.uri
+ * @property {Object} web.actions
+ * @property {Object[]} web.actions.buttons
+ * @property {string} web.actions.buttons[].label
+ * @property {string} web.actions.buttons[].type
+ * @property {string} web.actions.buttons[].uri
+ * @property {string} web.priority
+ * @property {Object} web._xdm
+ * @property {XdmTrackingContext} web._xdm.mixins
+ */
+
+/**
+ * @typedef {Object} TrackingDataPayload
+ * @property {Object[]} events
+ * @property {Object} events[].xdm
+ * @property {Object} events[].xdm.identityMap
+ * @property {Object[]} events[].xdm.identityMap.ECID
+ * @property {string} events[].xdm.identityMap.ECID[].id
+ * @property {string} events[].xdm.timestamp
+ * @property {Object} events[].xdm.pushNotificationTracking
+ * @property {string} events[].xdm.pushNotificationTracking.pushProviderMessageID
+ * @property {string} events[].xdm.pushNotificationTracking.pushProvider
+ * @property {Object} [events[].xdm.pushNotificationTracking.customAction]
+ * @property {string} [events[].xdm.pushNotificationTracking.customAction.actionID]
+ * @property {Object} events[].xdm.application
+ * @property {Object} events[].xdm.application.launches
+ * @property {number} events[].xdm.application.launches.value
+ * @property {string} events[].xdm.eventType
+ * @property {Object} events[].xdm._experience
+ * @property {CustomerJourneyManagement} events[].xdm._experience.customerJourneyManagement
+ * @property {Decisioning} events[].xdm._experience.decisioning
+ * @property {Object} events[].meta
+ * @property {Object} events[].meta.collect
+ * @property {string} events[].meta.collect.datasetId
+ */
+
+/**
+ * @typedef {Object} ServiceWorkerLogger
+ * @property {string} namespace
+ * @property {(...args: any[]) => void} info
+ * @property {(...args: any[]) => void} error
+ */
+
 export const Types = {};

package/libEs6/constants/libraryVersion.js

@@ -13,4 +13,4 @@ governing permissions and limitations under the License.
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
 
-export default "2.29.0";
+export default "2.30.0-beta.0";

package/libEs6/utils/index.js

@@ -32,6 +32,7 @@ export { default as getNamespacedCookieName } from "./getNamespacedCookieName.js
 export { default as groupBy } from "./groupBy.js";
 export { default as injectAreThirdPartyCookiesSupportedByDefault } from "./injectAreThirdPartyCookiesSupportedByDefault.js";
 export { default as injectDoesIdentityCookieExist } from "./injectDoesIdentityCookieExist.js";
+export { openIndexedDb, getFromIndexedDbStore, putToIndexedDbStore } from "./indexedDb.js";
 export { default as injectGetBrowser } from "./injectGetBrowser.js";
 export { default as injectStorage } from "./injectStorage.js";
 export { default as intersection } from "./intersection.js";

package/libEs6/utils/indexedDb.js

@@ -0,0 +1,67 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+/**
+ * @param {string} dbName
+ * @param {number} dbVersion
+ * @param {Function} [upgradeCallback] - Optional callback function to handle database upgrades.
+ *   Called with the database instance when the database is being upgraded.
+ * @returns {Promise<IDBDatabase>}
+ */
+export const openIndexedDb = (dbName, dbVersion, upgradeCallback) => {
+  return new Promise((resolve, reject) => {
+    const request = indexedDB.open(dbName, dbVersion);
+    request.onerror = () => reject(request.error);
+    request.onsuccess = () => resolve(request.result);
+    request.onupgradeneeded = event => {
+      const db = /** @type {IDBOpenDBRequest} */event.target.result;
+      if (upgradeCallback) {
+        upgradeCallback(db);
+      }
+    };
+  });
+};
+
+/**
+ * @param {IDBDatabase} db
+ * @param {string} storeName
+ * @param {string|number|Date|ArrayBuffer|Array} key
+ *
+ * @returns {Promise<any>}
+ */
+export const getFromIndexedDbStore = (db, storeName, key) => {
+  return new Promise((resolve, reject) => {
+    const transaction = db.transaction([storeName], "readonly");
+    const store = transaction.objectStore(storeName);
+    const request = store.get(key);
+    request.onerror = () => reject(request.error);
+    request.onsuccess = () => resolve(request.result);
+  });
+};
+
+/**
+ *
+ * @param {IDBDatabase} db
+ * @param {string} storeName
+ * @param {any} data
+ *
+ * @returns {Promise<any>}
+ */
+export const putToIndexedDbStore = (db, storeName, data) => {
+  return new Promise((resolve, reject) => {
+    const transaction = db.transaction([storeName], "readwrite");
+    const store = transaction.objectStore(storeName);
+    const request = store.put(data);
+    request.onerror = () => reject(request.error);
+    request.onsuccess = () => resolve(request.result);
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.29.0",
+  "version": "2.30.0-beta.0",
   "description": "Adobe Experience Platform Web SDK",
   "type": "module",
   "main": "libEs5/index.js",
@@ -26,16 +26,16 @@
     "lint": "eslint --cache --fix \"*.{js,cjs,mjs,jsx}\" \"{src,test,scripts,sandbox}/**/*.{js,cjs,mjs,jsx}\"",
     "format": "prettier --write \"*.{html,js,cjs,mjs,jsx}\" \"{sandbox,src,test,scripts}/**/*.{html,js,cjs,mjs,jsx}\"",
     "types": "tsc",
-    "test": "npx playwright install chromium && vitest run && npm run test:scripts",
-    "test:coverage": "rimraf coverage && npx playwright install chromium && vitest run --coverage",
-    "test:unit": "npx playwright install chromium && vitest run --project=unit",
-    "test:unit:debug": "npx playwright install chromium && vitest --no-file-parallelism --project=unit --browser=chromium --browser.provider=playwright --browser.headless=false",
-    "test:unit:watch": "npx playwright install chromium && vitest --project=unit",
-    "test:unit:coverage": "npx playwright install chromium && vitest run --coverage --project=unit",
-    "test:integration": "npx playwright install chromium && vitest run --project=integration",
-    "test:integration:debug": "npx playwright install chromium && vitest --no-file-parallelism --project=integration --browser=chromium --browser.provider=playwright --browser.headless=false",
-    "test:integration:watch": "npx playwright install chromium && vitest --project=integration",
-    "test:integration:coverage": "npx playwright install chromium && vitest run --coverage --project=integration",
+    "test": "pnpm exec playwright install chromium && vitest run && pnpm run test:scripts",
+    "test:coverage": "rimraf coverage && pnpm exec playwright install chromium && vitest run --coverage",
+    "test:unit": "pnpm exec playwright install chromium && vitest run --project=unit",
+    "test:unit:debug": "pnpm exec playwright install chromium && vitest --no-file-parallelism --project=unit --browser=chromium --browser.provider=playwright --browser.headless=false",
+    "test:unit:watch": "pnpm exec playwright install chromium && vitest --project=unit",
+    "test:unit:coverage": "pnpm exec playwright install chromium && vitest run --coverage --project=unit",
+    "test:integration": "pnpm exec playwright install chromium && vitest run --project=integration",
+    "test:integration:debug": "pnpm exec playwright install chromium && vitest --no-file-parallelism --project=integration --browser=chromium --browser.provider=playwright --browser.headless=false",
+    "test:integration:watch": "pnpm exec playwright install chromium && vitest --project=integration",
+    "test:integration:coverage": "pnpm exec playwright install chromium && vitest run --coverage --project=integration",
     "test:functional": "EDGE_BASE_PATH=\"ee-pre-prd\" ALLOY_ENV=\"int\" testcafe chrome",
     "test:functional:custom": "node scripts/helpers/runFunctionalTests.js",
     "test:functional:watch": "EDGE_BASE_PATH=\"ee-pre-prd\" ALLOY_ENV=\"int\" ./scripts/watchFunctionalTests.js --browsers chrome",
@@ -43,12 +43,12 @@
     "test:functional:build:int": "rollup -c --environment BASE_CODE_MIN,STANDALONE,NPM_PACKAGE_LOCAL",
     "test:functional:build:prod": "rollup -c --environment BASE_CODE_MIN,NPM_PACKAGE_PROD",
     "test:scripts": "vitest run --config=./scripts/specs/vitest.config.js",
-    "dev": "concurrently --names build,sandbox \"rollup -c -w --environment SANDBOX\" \"cd sandbox && export REACT_APP_NONCE=321 && npm start\"",
-    "build": "npm run clean && rollup -c --environment BASE_CODE_MIN,STANDALONE,STANDALONE_MIN,BUNDLESIZE && echo \"Base Code:\" && cat distTest/baseCode.min.js",
-    "build:watch": "npm run clean && rollup -c --watch --environment BASE_CODE_MIN,STANDALONE",
+    "dev": "concurrently --names build,sandbox \"rollup -c -w --environment SANDBOX\" \"cd sandbox && export REACT_APP_NONCE=321 && pnpm start\"",
+    "build": "pnpm run clean && rollup -c --environment BASE_CODE_MIN,STANDALONE,STANDALONE_MIN,BUNDLESIZE && echo \"Base Code:\" && cat distTest/baseCode.min.js",
+    "build:watch": "pnpm run clean && rollup -c --watch --environment BASE_CODE_MIN,STANDALONE",
     "build:custom": "node scripts/alloyBuilder.js",
-    "prepare": "husky && cd sandbox && npm install",
-    "prepack": "npm run clean && babel src -d libEs5 --env-name npmEs5 && babel src -d libEs6 --env-name npmEs6 && npm run types",
+    "prepare": "husky",
+    "prepack": "pnpm run clean && babel src -d libEs5 --env-name npmEs5 && babel src -d libEs6 --env-name npmEs6 && pnpm run types",
     "checkthattestfilesexist": "./scripts/checkThatTestFilesExist.js",
     "add-license": "./scripts/add-license.js"
   },
@@ -74,11 +74,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@adobe/aep-rules-engine": "^3.1.1",
-    "@adobe/reactor-cookie": "^1.1.0",
-    "@adobe/reactor-load-script": "^1.1.1",
-    "@adobe/reactor-object-assign": "^2.0.0",
     "@adobe/reactor-query-string": "^2.0.0",
-    "@babel/core": "^7.28.3",
+    "@babel/core": "^7.28.4",
     "@babel/plugin-transform-template-literals": "^7.27.1",
     "@babel/preset-env": "^7.28.3",
     "@inquirer/prompts": "^7.8.4",
@@ -89,37 +86,37 @@
     "commander": "^14.0.0",
     "css.escape": "^1.5.1",
     "js-cookie": "3.0.5",
-    "rollup": "^4.48.1",
+    "rollup": "^4.50.1",
     "rollup-plugin-license": "^3.6.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.29.0-beta.15",
+    "@adobe/alloy": "^2.29.0",
     "@babel/cli": "^7.28.3",
     "@babel/plugin-transform-modules-commonjs": "^7.27.1",
-    "@babel/plugin-transform-runtime": "^7.28.3",
-    "@eslint/js": "^9.34.0",
+    "@eslint/js": "^9.35.0",
     "@octokit/rest": "^22.0.0",
+    "@types/node": "^24.3.1",
     "@vitest/browser": "^3.2.4",
     "@vitest/coverage-v8": "^3.2.4",
-    "@vitest/eslint-plugin": "^1.3.4",
-    "chalk": "^5.6.0",
+    "@vitest/eslint-plugin": "^1.3.9",
+    "chalk": "^5.6.2",
     "concurrently": "^9.2.1",
     "date-fns": "^4.1.0",
-    "dotenv": "^17.2.1",
-    "eslint": "^9.34.0",
+    "eslint": "^9.35.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-compat": "^6.0.2",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-react": "^7.37.5",
     "glob": "^11.0.3",
-    "globals": "^16.3.0",
+    "globals": "^16.4.0",
     "handlebars": "^4.7.8",
     "happy-dom": "^18.0.1",
     "husky": "^9.1.7",
-    "lint-staged": "^16.1.5",
-    "msw": "^2.10.5",
+    "lint-staged": "^16.1.6",
+    "minimatch": "^10.0.3",
+    "msw": "^2.11.2",
     "playwright": "^1.55.0",
     "prettier": "^3.6.2",
     "read-cache": "^1.0.0",
@@ -128,15 +125,11 @@
     "semver": "^7.7.2",
     "staged-git-files": "^1.3.0",
     "testcafe": "^3.7.2",
-    "testcafe-browser-provider-saucelabs": "^3.0.0",
-    "testcafe-reporter-junit": "^3.0.2",
-    "testcafe-reporter-saucelabs": "^3.6.0",
     "typescript": "^5.9.2",
     "url-exists-nodejs": "^0.2.4",
-    "url-parse": "^1.5.10",
     "vitest": "^3.2.4"
   },
   "optionalDependencies": {
-    "@rollup/rollup-linux-x64-gnu": "^4.48.1"
+    "@rollup/rollup-linux-x64-gnu": "^4.50.1"
   }
 }