@adobe/alloy 2.29.0 → 2.30.0-beta.1

package/libEs5/components/PushNotifications/types.js

@@ -11,4 +11,85 @@ exports.Types = void 0;
  * @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
+ */
+
 const Types = exports.Types = {};

package/libEs5/constants/libraryVersion.js

@@ -14,4 +14,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
-var _default = exports.default = "2.29.0";
+var _default = exports.default = "2.30.0-beta.1";

package/libEs5/utils/index.js

@@ -96,6 +96,12 @@ Object.defineProperty(exports, "getApexDomain", {
     return _getApexDomain.default;
   }
 });
+Object.defineProperty(exports, "getFromIndexedDbStore", {
+  enumerable: true,
+  get: function () {
+    return _indexedDb.getFromIndexedDbStore;
+  }
+});
 Object.defineProperty(exports, "getLastArrayItems", {
   enumerable: true,
   get: function () {
@@ -222,6 +228,12 @@ Object.defineProperty(exports, "noop", {
     return _noop.default;
   }
 });
+Object.defineProperty(exports, "openIndexedDb", {
+  enumerable: true,
+  get: function () {
+    return _indexedDb.openIndexedDb;
+  }
+});
 Object.defineProperty(exports, "parseUrl", {
   enumerable: true,
   get: function () {
@@ -234,6 +246,12 @@ Object.defineProperty(exports, "prepareConfigOverridesForEdge", {
     return _prepareConfigOverridesForEdge.default;
   }
 });
+Object.defineProperty(exports, "putToIndexedDbStore", {
+  enumerable: true,
+  get: function () {
+    return _indexedDb.putToIndexedDbStore;
+  }
+});
 Object.defineProperty(exports, "queryString", {
   enumerable: true,
   get: function () {
@@ -333,6 +351,7 @@ var _getNamespacedCookieName = require("./getNamespacedCookieName.js");
 var _groupBy = require("./groupBy.js");
 var _injectAreThirdPartyCookiesSupportedByDefault = require("./injectAreThirdPartyCookiesSupportedByDefault.js");
 var _injectDoesIdentityCookieExist = require("./injectDoesIdentityCookieExist.js");
+var _indexedDb = require("./indexedDb.js");
 var _injectGetBrowser = require("./injectGetBrowser.js");
 var _injectStorage = require("./injectStorage.js");
 var _intersection = require("./intersection.js");

package/libEs5/utils/indexedDb.js

@@ -0,0 +1,73 @@
+"use strict";
+
+exports.putToIndexedDbStore = exports.openIndexedDb = exports.getFromIndexedDbStore = void 0;
+/*
+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>}
+ */
+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>}
+ */
+exports.openIndexedDb = openIndexedDb;
+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>}
+ */
+exports.getFromIndexedDbStore = getFromIndexedDbStore;
+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);
+  });
+};
+exports.putToIndexedDbStore = putToIndexedDbStore;

package/libEs6/components/PushNotifications/helpers/constants.js

@@ -0,0 +1,16 @@
+/*
+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.
+*/
+
+export const DB_NAME = "alloyPushNotifications";
+export const DB_VERSION = 1;
+export const STORE_NAME = "config";
+export const INDEX_KEY = "alloyConfig";

package/libEs6/components/PushNotifications/helpers/readFromIndexedDb.js

@@ -0,0 +1,40 @@
+/*
+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 { getFromIndexedDbStore, openIndexedDb } from "../../../utils/indexedDb.js";
+import { DB_NAME, DB_VERSION, STORE_NAME, INDEX_KEY } from "./constants.js";
+
+/**
+ * @param {ServiceWorkerLogger} logger
+ * @returns {Promise<Object|undefined>}
+ * @throws {Error}
+ */
+export default async logger => {
+  try {
+    const db = await openIndexedDb(DB_NAME, DB_VERSION, (/** @type {IDBDatabase} */db) => {
+      if (!db.objectStoreNames.contains(STORE_NAME)) {
+        db.createObjectStore(STORE_NAME, {
+          keyPath: "id"
+        });
+      }
+    });
+    const existingConfigData = await getFromIndexedDbStore(db, STORE_NAME, INDEX_KEY);
+    db.close();
+    return existingConfigData;
+  } catch (error) {
+    logger.error("Failed to read data from IndexedDB", {
+      error
+    });
+  }
+};

package/libEs6/components/PushNotifications/helpers/saveToIndexedDb.js

@@ -0,0 +1,48 @@
+/*
+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 { Logger } from '../../../core/types.js' */
+
+import { openIndexedDb, getFromIndexedDbStore, putToIndexedDbStore } from "../../../utils/index.js";
+import { DB_NAME, DB_VERSION, STORE_NAME, INDEX_KEY } from "./constants.js";
+
+/**
+ * @param {Object} data
+ * @param {Logger} logger
+ *
+ * @returns {Promise<void>}
+ */
+export default async function saveToIndexedDB(data, logger) {
+  try {
+    const db = await openIndexedDb(DB_NAME, DB_VERSION, (/** @type {IDBDatabase} */db) => {
+      if (!db.objectStoreNames.contains(STORE_NAME)) {
+        db.createObjectStore(STORE_NAME, {
+          keyPath: "id"
+        });
+      }
+    });
+    const existingConfigData = await getFromIndexedDbStore(db, STORE_NAME, INDEX_KEY);
+    const updatedConfigData = {
+      ...(existingConfigData || {}),
+      ...data,
+      id: INDEX_KEY,
+      timestamp: Date.now()
+    };
+    await putToIndexedDbStore(db, STORE_NAME, updatedConfigData);
+    db.close();
+    logger.info("Successfully saved web SDK config to IndexedDB", updatedConfigData);
+  } catch (error) {
+    logger.error("Failed to save config to IndexedDB", {
+      error
+    });
+  }
+}

package/libEs6/components/PushNotifications/helpers/serviceWorkerNotificationClickListener.js

@@ -0,0 +1,82 @@
+/*
+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.
+*/
+
+// @ts-check
+/// <reference lib="webworker" />
+
+/** @import { ServiceWorkerLogger } from '../types.js' */
+
+import makeSendServiceWorkerTrackingData from "../request/makeSendServiceWorkerTrackingData.js";
+
+/**
+ * @param {string} type
+ * @returns {boolean}
+ */
+const canHandleUrl = type => ["DEEPLINK", "WEBURL"].includes(type);
+
+/**
+ * @function
+ *
+ * @param {Object} options
+ * @param {ServiceWorkerGlobalScope} options.sw
+ * @param {NotificationEvent} options.event
+ * @param {(url: string, options: object) => Promise<Response>} options.fetch
+ * @param {ServiceWorkerLogger} options.logger
+ */
+export default ({
+  event,
+  sw,
+  logger,
+  fetch
+}) => {
+  event.notification.close();
+  const data = event.notification.data;
+  let targetUrl = null;
+  let actionLabel = null;
+  if (event.action) {
+    const actionIndex = parseInt(event.action.replace("action_", ""), 10);
+    if (data?.actions?.buttons[actionIndex]) {
+      const button = data.actions.buttons[actionIndex];
+      actionLabel = button.label;
+      if (canHandleUrl(button.type) && button.uri) {
+        targetUrl = button.uri;
+      }
+    }
+  } else if (canHandleUrl(data?.interaction?.type) && data?.interaction?.uri) {
+    targetUrl = data.interaction.uri;
+  }
+  makeSendServiceWorkerTrackingData({
+    // eslint-disable-next-line no-underscore-dangle
+    xdm: data._xdm.mixins,
+    actionLabel,
+    applicationLaunches: 1
+  }, {
+    logger,
+    fetch
+  }).catch(error => {
+    logger.error("Failed to send tracking call:", error);
+  });
+  if (targetUrl) {
+    event.waitUntil(sw.clients.matchAll({
+      type: "window"
+    }).then(clientList => {
+      for (const client of clientList) {
+        if (client.url === targetUrl && "focus" in client) {
+          return client.focus();
+        }
+      }
+      if (sw.clients.openWindow) {
+        return sw.clients.openWindow(targetUrl);
+      }
+    }));
+  }
+};

package/libEs6/components/PushNotifications/helpers/serviceWorkerPushListener.js

@@ -0,0 +1,69 @@
+/*
+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.
+*/
+
+// @ts-check
+/// <reference lib="webworker" />
+
+/** @import {  PushNotificationData  } from '../types.js' */
+/** @import { ServiceWorkerLogger } from '../types.js' */
+
+/**
+ * @async
+ * @function
+ *
+ * @param {Object} options
+ * @param {ServiceWorkerGlobalScope} options.sw
+ * @param {PushEvent} options.event
+ * @param {ServiceWorkerLogger} options.logger
+ * @returns {Promise<void>}
+ */
+export default async ({
+  sw,
+  event,
+  logger
+}) => {
+  if (!event.data) {
+    return;
+  }
+
+  /** @type {PushNotificationData} */
+  let notificationData;
+  try {
+    notificationData = event.data.json();
+  } catch (error) {
+    logger.error("Error decoding notification JSON data:", error);
+    return;
+  }
+  const webData = notificationData.web;
+  if (!webData?.title) {
+    return;
+  }
+  const notificationOptions = {
+    body: webData.body,
+    icon: webData.media,
+    image: webData.media,
+    data: webData,
+    actions: []
+  };
+  Object.keys(notificationOptions).forEach(k => {
+    if (notificationOptions[k] == null) {
+      delete notificationOptions[k];
+    }
+  });
+  if (webData.actions && webData.actions.buttons) {
+    notificationOptions.actions = webData.actions.buttons.map((button, index) => ({
+      action: `action_${index}`,
+      title: button.label
+    }));
+  }
+  return sw.registration.showNotification(webData.title, notificationOptions);
+};

package/libEs6/components/PushNotifications/index.js

@@ -19,27 +19,33 @@ governing permissions and limitations under the License.
 import { objectOf, string } from "../../utils/validation/index.js";
 import { sanitizeOrgIdForCookieName } from "../../utils/index.js";
 import makeSendPushSubscriptionRequest from "./request/makeSendPushSubscriptionRequest.js";
+import saveToIndexedDb from "./helpers/saveToIndexedDb.js";
 const isComponentConfigured = ({
   orgId,
   pushNotifications: {
-    vapidPublicKey
+    vapidPublicKey,
+    appId,
+    trackingDatasetId
   } = {
-    vapidPublicKey: undefined
+    vapidPublicKey: undefined,
+    appId: undefined,
+    trackingDatasetId: undefined
   }
-}) => orgId && vapidPublicKey;
+}) => orgId && vapidPublicKey && appId && trackingDatasetId;
 
 /**
  * @function
  *
  * @param {Object} options
- * @param {{ orgId: string, pushNotifications: { vapidPublicKey: string }}} options.config
+ * @param {{ orgId: string, datastreamId: string, edgeDomain: string, edgeBasePath: string, pushNotifications: { vapidPublicKey: string, appId: string, trackingDatasetId: string }}} options.config
  * @param {StorageCreator} options.createNamespacedStorage
  * @param {EventManager} options.eventManager
  * @param {Logger} options.logger
  * @param {ConsentManager} options.consent
  * @param {IdentityManager} options.identity
+ * @param {function(): string} options.getBrowser
  * @param {EdgeRequestExecutor} options.sendEdgeNetworkRequest
- * @returns {{  commands: { sendPushSubscription: object } }}
+ * @returns {{ lifecycle: object, commands: { sendPushSubscription: object } }}
  */
 const createPushNotifications = ({
   createNamespacedStorage,
@@ -48,27 +54,52 @@ const createPushNotifications = ({
   logger,
   consent,
   identity,
+  getBrowser,
   sendEdgeNetworkRequest
 }) => {
   return {
+    lifecycle: {
+      async onComponentsRegistered() {
+        if (isComponentConfigured(config)) {
+          const {
+            datastreamId,
+            edgeDomain,
+            edgeBasePath,
+            pushNotifications: {
+              trackingDatasetId
+            }
+          } = config;
+          await saveToIndexedDb({
+            datastreamId,
+            edgeDomain,
+            edgeBasePath,
+            datasetId: trackingDatasetId,
+            browser: getBrowser()
+          }, logger);
+        }
+      }
+    },
     commands: {
       sendPushSubscription: {
         run: async () => {
           if (!isComponentConfigured(config)) {
-            throw new Error("Push notifications module is not configured. No VAPID public key was provided.");
+            throw new Error("Push notifications module is not configured.");
           }
           const {
             orgId,
             pushNotifications: {
-              vapidPublicKey
+              vapidPublicKey,
+              appId
             } = {
-              vapidPublicKey: undefined
+              vapidPublicKey: undefined,
+              appId: undefined
             }
           } = config || {};
           const storage = createNamespacedStorage(`${sanitizeOrgIdForCookieName(orgId)}.pushNotifications.`);
           return makeSendPushSubscriptionRequest({
             config: {
-              vapidPublicKey
+              vapidPublicKey,
+              appId
             },
             storage: storage.persistent,
             logger,
@@ -87,7 +118,9 @@ const createPushNotifications = ({
 createPushNotifications.namespace = "Push Notifications";
 createPushNotifications.configValidators = objectOf({
   pushNotifications: objectOf({
-    vapidPublicKey: string().required()
+    vapidPublicKey: string().required(),
+    appId: string().required(),
+    trackingDatasetId: string().required()
   }).noUnknownFields()
 });
 export default createPushNotifications;

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

@@ -29,7 +29,7 @@ import createDataCollectionRequestPayload from "../../../utils/request/createDat
  * @param {string} options.ecid
  * @param {EventManager} options.eventManager
  * @param {string} options.serializedPushSubscriptionDetails
- * @param {Window} options.window
+ * @param {string} options.appId
  *
  * @returns {Promise<DataCollectionRequestPayload>}
  */
@@ -37,12 +37,12 @@ export default async ({
   ecid,
   eventManager,
   serializedPushSubscriptionDetails,
-  window
+  appId
 }) => {
   const event = eventManager.createEvent();
   event.setUserData({
     pushNotificationDetails: [{
-      appID: window.location.host,
+      appID: appId,
       token: serializedPushSubscriptionDetails,
       platform: "web",
       denylisted: false,

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

@@ -20,6 +20,7 @@ import { sortObjectKeysRecursively } from "../../../utils/index.js";
 import getPushSubscriptionDetails from "../helpers/getPushSubscriptionDetails.js";
 import createSendPushSubscriptionRequest from "./createSendPushSubscriptionRequest.js";
 import createSendPushSubscriptionPayload from "./createSendPushSubscriptionPayload.js";
+import saveToIndexedDb from "../helpers/saveToIndexedDb.js";
 const SUBSCRIPTION_DETAILS = "subscriptionDetails";
 
 /**
@@ -32,7 +33,7 @@ const SUBSCRIPTION_DETAILS = "subscriptionDetails";
  * @function
  *
  * @param {Object} options
- * @param {{vapidPublicKey: string}} options.config
+ * @param {{vapidPublicKey: string, appId: string}} options.config
  * @param {Storage} options.storage
  * @param {Logger} options.logger
  * @param {EventManager} options.eventManager
@@ -45,7 +46,8 @@ const SUBSCRIPTION_DETAILS = "subscriptionDetails";
  */
 export default async ({
   config: {
-    vapidPublicKey
+    vapidPublicKey,
+    appId
   },
   storage,
   logger,
@@ -72,7 +74,7 @@ export default async ({
     eventManager,
     ecid,
     serializedPushSubscriptionDetails,
-    window
+    appId
   });
   const request = createSendPushSubscriptionRequest({
     payload
@@ -81,4 +83,7 @@ export default async ({
   await sendEdgeNetworkRequest({
     request
   });
+  await saveToIndexedDb({
+    ecid
+  }, logger);
 };