@adobe/alloy 2.29.0 → 2.30.0-beta.0

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

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

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

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

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

@@ -0,0 +1,50 @@
+"use strict";
+
+exports.default = saveToIndexedDB;
+var _index = require("../../../utils/index.js");
+var _constants = require("./constants.js");
+/*
+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' */
+
+/**
+ * @param {Object} data
+ * @param {Logger} logger
+ *
+ * @returns {Promise<void>}
+ */
+async function saveToIndexedDB(data, logger) {
+  try {
+    const db = await (0, _index.openIndexedDb)(_constants.DB_NAME, _constants.DB_VERSION, (/** @type {IDBDatabase} */db) => {
+      if (!db.objectStoreNames.contains(_constants.STORE_NAME)) {
+        db.createObjectStore(_constants.STORE_NAME, {
+          keyPath: "id"
+        });
+      }
+    });
+    const existingConfigData = await (0, _index.getFromIndexedDbStore)(db, _constants.STORE_NAME, _constants.INDEX_KEY);
+    const updatedConfigData = {
+      ...(existingConfigData || {}),
+      ...data,
+      id: _constants.INDEX_KEY,
+      timestamp: Date.now()
+    };
+    await (0, _index.putToIndexedDbStore)(db, _constants.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/libEs5/components/PushNotifications/helpers/serviceWorkerNotificationClickListener.js

@@ -0,0 +1,85 @@
+"use strict";
+
+exports.default = void 0;
+var _makeSendServiceWorkerTrackingData = require("../request/makeSendServiceWorkerTrackingData.js");
+/*
+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' */
+
+/**
+ * @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
+ */
+var _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;
+  }
+  (0, _makeSendServiceWorkerTrackingData.default)({
+    // 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);
+      }
+    }));
+  }
+};
+exports.default = _default;

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

@@ -0,0 +1,70 @@
+"use strict";
+
+exports.default = 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.
+*/
+// @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>}
+ */
+var _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);
+};
+exports.default = _default;

package/libEs5/components/PushNotifications/index.js

@@ -4,6 +4,7 @@ exports.default = void 0;
 var _index = require("../../utils/validation/index.js");
 var _index2 = require("../../utils/index.js");
 var _makeSendPushSubscriptionRequest = require("./request/makeSendPushSubscriptionRequest.js");
+var _saveToIndexedDb = require("./helpers/saveToIndexedDb.js");
 /*
 Copyright 2025 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -25,24 +26,29 @@ governing permissions and limitations under the License.
 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,
@@ -51,27 +57,52 @@ const createPushNotifications = ({
   logger,
   consent,
   identity,
+  getBrowser,
   sendEdgeNetworkRequest
 }) => {
   return {
+    lifecycle: {
+      async onComponentsRegistered() {
+        if (isComponentConfigured(config)) {
+          const {
+            datastreamId,
+            edgeDomain,
+            edgeBasePath,
+            pushNotifications: {
+              trackingDatasetId
+            }
+          } = config;
+          await (0, _saveToIndexedDb.default)({
+            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((0, _index2.sanitizeOrgIdForCookieName)(orgId) + ".pushNotifications.");
           return (0, _makeSendPushSubscriptionRequest.default)({
             config: {
-              vapidPublicKey
+              vapidPublicKey,
+              appId
             },
             storage: storage.persistent,
             logger,
@@ -90,7 +121,9 @@ const createPushNotifications = ({
 createPushNotifications.namespace = "Push Notifications";
 createPushNotifications.configValidators = (0, _index.objectOf)({
   pushNotifications: (0, _index.objectOf)({
-    vapidPublicKey: (0, _index.string)().required()
+    vapidPublicKey: (0, _index.string)().required(),
+    appId: (0, _index.string)().required(),
+    trackingDatasetId: (0, _index.string)().required()
   }).noUnknownFields()
 });
 var _default = exports.default = createPushNotifications;

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

@@ -29,7 +29,7 @@ governing permissions and limitations under the License.
  * @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 @@ var _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/libEs5/components/PushNotifications/request/makeSendPushSubscriptionRequest.js

@@ -5,6 +5,7 @@ var _index = require("../../../utils/index.js");
 var _getPushSubscriptionDetails = require("../helpers/getPushSubscriptionDetails.js");
 var _createSendPushSubscriptionRequest = require("./createSendPushSubscriptionRequest.js");
 var _createSendPushSubscriptionPayload = require("./createSendPushSubscriptionPayload.js");
+var _saveToIndexedDb = require("../helpers/saveToIndexedDb.js");
 /*
 Copyright 2025 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -35,7 +36,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
@@ -48,7 +49,8 @@ const SUBSCRIPTION_DETAILS = "subscriptionDetails";
  */
 var _default = async ({
   config: {
-    vapidPublicKey
+    vapidPublicKey,
+    appId
   },
   storage,
   logger,
@@ -75,7 +77,7 @@ var _default = async ({
     eventManager,
     ecid,
     serializedPushSubscriptionDetails,
-    window
+    appId
   });
   const request = (0, _createSendPushSubscriptionRequest.default)({
     payload
@@ -84,5 +86,8 @@ var _default = async ({
   await sendEdgeNetworkRequest({
     request
   });
+  await (0, _saveToIndexedDb.default)({
+    ecid
+  }, logger);
 };
 exports.default = _default;

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

@@ -0,0 +1,146 @@
+"use strict";
+
+exports.default = void 0;
+var _readFromIndexedDb = require("../helpers/readFromIndexedDb.js");
+var _uuid = require("../../../utils/uuid.js");
+/*
+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' */
+/**
+ * @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}
+ */
+var _default = async ({
+  xdm,
+  actionLabel,
+  applicationLaunches = 0
+}, {
+  logger,
+  fetch
+}) => {
+  const configData = await (0, _readFromIndexedDb.default)(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: (0, _uuid.default)(),
+            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;
+  }
+};
+exports.default = _default;

package/libEs5/components/PushNotifications/serviceWorker.js

@@ -0,0 +1,91 @@
+"use strict";
+
+var _serviceWorkerNotificationClickListener = require("./helpers/serviceWorkerNotificationClickListener.js");
+var _serviceWorkerPushListener = require("./helpers/serviceWorkerPushListener.js");
+var _makeSendServiceWorkerTrackingData = require("./request/makeSendServiceWorkerTrackingData.js");
+/*
+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' */
+
+/* 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 => (0, _serviceWorkerPushListener.default)({
+  event,
+  logger,
+  sw
+}));
+
+/**
+ * @listens notificationclick
+ * @param {NotificationEvent} event
+ */
+sw.addEventListener("notificationclick", event => (0, _serviceWorkerNotificationClickListener.default)({
+  event,
+  sw,
+  logger,
+  fetch
+}));
+
+/**
+ * @listens notificationclose
+ * @param {NotificationEvent} event
+ */
+sw.addEventListener("notificationclose", event => {
+  const data = event.notification.data;
+  (0, _makeSendServiceWorkerTrackingData.default)({
+    xdm: data._xdm.mixins,
+    actionLabel: "Dismiss"
+  }, {
+    logger,
+    fetch
+  }).catch(error => {
+    logger.error("Failed to send tracking call:", error);
+  });
+});