@adobe/alloy 2.29.0-beta.5 → 2.30.0-beta.0

package/libEs5/components/PushNotifications/index.js

@@ -0,0 +1,129 @@
+"use strict";
+
+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");
+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 { StorageCreator } from '../../utils/types.js' */
+/** @import { EventManager, Logger } from '../../core/types.js' */
+/** @import { IdentityManager } from '../../core/identity/types.js' */
+/** @import { ConsentManager } from '../../core/consent/types.js' */
+/** @import { EdgeRequestExecutor } from '../../core/edgeNetwork/types.js' */
+
+const isComponentConfigured = ({
+  orgId,
+  pushNotifications: {
+    vapidPublicKey,
+    appId,
+    trackingDatasetId
+  } = {
+    vapidPublicKey: undefined,
+    appId: undefined,
+    trackingDatasetId: undefined
+  }
+}) => orgId && vapidPublicKey && appId && trackingDatasetId;
+
+/**
+ * @function
+ *
+ * @param {Object} options
+ * @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 {{ lifecycle: object, commands: { sendPushSubscription: object } }}
+ */
+const createPushNotifications = ({
+  createNamespacedStorage,
+  eventManager,
+  config,
+  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.");
+          }
+          const {
+            orgId,
+            pushNotifications: {
+              vapidPublicKey,
+              appId
+            } = {
+              vapidPublicKey: undefined,
+              appId: undefined
+            }
+          } = config || {};
+          const storage = createNamespacedStorage((0, _index2.sanitizeOrgIdForCookieName)(orgId) + ".pushNotifications.");
+          return (0, _makeSendPushSubscriptionRequest.default)({
+            config: {
+              vapidPublicKey,
+              appId
+            },
+            storage: storage.persistent,
+            logger,
+            sendEdgeNetworkRequest,
+            consent,
+            eventManager,
+            identity,
+            window
+          });
+        },
+        optionsValidator: (0, _index.objectOf)({}).noUnknownFields()
+      }
+    }
+  };
+};
+createPushNotifications.namespace = "Push Notifications";
+createPushNotifications.configValidators = (0, _index.objectOf)({
+  pushNotifications: (0, _index.objectOf)({
+    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

@@ -0,0 +1,62 @@
+"use strict";
+
+exports.default = void 0;
+var _createDataCollectionRequestPayload = require("../../../utils/request/createDataCollectionRequestPayload.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 { EventManager } from "../../../core/types.js" */
+/** @import { DataCollectionRequestPayload } from "../../../utils/request/types.js" */
+/**
+ * Creates a data collection request payload for sending push subscription details to Adobe Experience Platform.
+ *
+ * This function constructs an event containing push notification subscription information,
+ * including the subscription details, platform information, and identity data. The event
+ * is then packaged into a data collection request payload for transmission to the edge network.
+ *
+ * @async
+ * @function
+ *
+ * @param {Object} options
+ * @param {string} options.ecid
+ * @param {EventManager} options.eventManager
+ * @param {string} options.serializedPushSubscriptionDetails
+ * @param {string} options.appId
+ *
+ * @returns {Promise<DataCollectionRequestPayload>}
+ */
+var _default = async ({
+  ecid,
+  eventManager,
+  serializedPushSubscriptionDetails,
+  appId
+}) => {
+  const event = eventManager.createEvent();
+  event.setUserData({
+    pushNotificationDetails: [{
+      appID: appId,
+      token: serializedPushSubscriptionDetails,
+      platform: "web",
+      denylisted: false,
+      identity: {
+        namespace: {
+          code: "ECID"
+        },
+        id: ecid
+      }
+    }]
+  });
+  event.finalize();
+  const payload = (0, _createDataCollectionRequestPayload.default)();
+  payload.addEvent(event);
+  return payload;
+};
+exports.default = _default;

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

@@ -0,0 +1,35 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../../utils/request/index.js");
+/*
+Copyright 2023 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 { DataCollectionRequestPayload, Request } from '../../../utils/request/types.js' */
+/**
+ * @function
+ *
+ * @param {{ payload: DataCollectionRequestPayload }} options
+ *
+ * @returns {Request}
+ */
+var _default = ({
+  payload
+}) => (0, _index.createRequest)({
+  payload,
+  getAction() {
+    return "interact";
+  },
+  getUseSendBeacon() {
+    return false;
+  }
+});
+exports.default = _default;

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

@@ -0,0 +1,93 @@
+"use strict";
+
+exports.default = void 0;
+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");
+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 { Storage } from '../../../utils/types.js' */
+/** @import { EventManager, Logger } from '../../../core/types.js' */
+/** @import { IdentityManager } from '../../../core/identity/types.js' */
+/** @import { ConsentManager } from '../../../core/consent/types.js' */
+/** @import { EdgeRequestExecutor } from '../../../core/edgeNetwork/types.js' */
+
+const SUBSCRIPTION_DETAILS = "subscriptionDetails";
+
+/**
+ * Retrieves and returns push subscription details with sorted object keys.
+ *
+ * This function gets the push subscription details using the provided VAPID public key
+ * and returns the details with all object keys sorted recursively for consistent output.
+ *
+ * @async
+ * @function
+ *
+ * @param {Object} options
+ * @param {{vapidPublicKey: string, appId: string}} options.config
+ * @param {Storage} options.storage
+ * @param {Logger} options.logger
+ * @param {EventManager} options.eventManager
+ * @param {IdentityManager} options.identity
+ * @param {EdgeRequestExecutor} options.sendEdgeNetworkRequest
+ * @param {ConsentManager} options.consent
+ * @param {Window} options.window
+ *
+ * @returns {Promise<void>}
+ */
+var _default = async ({
+  config: {
+    vapidPublicKey,
+    appId
+  },
+  storage,
+  logger,
+  sendEdgeNetworkRequest,
+  consent,
+  eventManager,
+  identity,
+  window
+}) => {
+  await identity.awaitIdentity();
+  const ecid = identity.getEcidFromCookie();
+  const pushSubscriptionDetails = await (0, _getPushSubscriptionDetails.default)({
+    vapidPublicKey,
+    window
+  });
+  const serializedPushSubscriptionDetails = JSON.stringify((0, _index.sortObjectKeysRecursively)(pushSubscriptionDetails));
+  const cacheValue = "" + ecid + serializedPushSubscriptionDetails;
+  if (cacheValue === storage.getItem(SUBSCRIPTION_DETAILS)) {
+    logger.info("Subscription details have not changed. Not sending to the server.");
+    return;
+  }
+  storage.setItem(SUBSCRIPTION_DETAILS, cacheValue);
+  const payload = await (0, _createSendPushSubscriptionPayload.default)({
+    eventManager,
+    ecid,
+    serializedPushSubscriptionDetails,
+    appId
+  });
+  const request = (0, _createSendPushSubscriptionRequest.default)({
+    payload
+  });
+  await consent.awaitConsent();
+  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);
+  });
+});

package/libEs5/components/PushNotifications/types.js

@@ -0,0 +1,95 @@
+"use strict";
+
+exports.Types = void 0;
+/** @import { Identity } from '../../utils/request/types.js' */
+
+/**
+ * @typedef {Object} PushSubscription
+ * @property {string} endpoint - The push service endpoint URL
+ * @property {Object} keys - The subscription keys object
+ * @property {string|null} keys.p256dh - The P-256 ECDH public key as an ArrayBuffer, or null if not available
+ * @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-beta.5";
+var _default = exports.default = "2.30.0-beta.0";

package/libEs5/core/componentCreators.js

@@ -42,6 +42,12 @@ Object.defineProperty(exports, "personalization", {
     return _index6.default;
   }
 });
+Object.defineProperty(exports, "pushNotifications", {
+  enumerable: true,
+  get: function () {
+    return _index0.default;
+  }
+});
 Object.defineProperty(exports, "rulesEngine", {
   enumerable: true,
   get: function () {
@@ -62,4 +68,5 @@ var _index5 = require("../components/MediaAnalyticsBridge/index.js");
 var _index6 = require("../components/Personalization/index.js");
 var _index7 = require("../components/RulesEngine/index.js");
 var _index8 = require("../components/StreamingMedia/index.js");
-var _index9 = require("../components/Advertising/index.js");
+var _index9 = require("../components/Advertising/index.js");
+var _index0 = require("../components/PushNotifications/index.js");