@adobe/alloy 2.32.1-beta.0 → 2.33.0-beta.2

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

@@ -0,0 +1,154 @@
+/*
+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 { TrackingDataPayload   } from '../types.js' */
+
+/**
+ * @param {Object} dependencies
+ * @param {(logger: ServiceWorkerLogger) => Promise<Object>} dependencies.readFromIndexedDb
+ * @param {() => string} dependencies.uuidv4
+ * @param {ServiceWorkerLogger} dependencies.logger
+ * @param {(url: string, options: object) => Promise<Response>} dependencies.fetch
+ * @returns {(options: { xdm: Object, actionLabel?: string, applicationLaunches?: number }) => Promise<boolean>}
+ */
+export const createMakeSendServiceWorkerTrackingData = ({
+  readFromIndexedDb,
+  uuidv4,
+  logger,
+  fetch,
+}) => {
+  /**
+   * @async
+   * @function
+   * @param {Object} options
+   * @param {Object} options.xdm
+   * @param {string} [options.actionLabel]
+   * @param {number} [options.applicationLaunches=0]
+   *
+   * @returns {Promise<boolean>}
+   * @throws {Error}
+   */
+  return async ({ xdm, actionLabel, applicationLaunches = 0 }) => {
+    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}&requestId=${uuidv4()}`;
+
+      /** @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/src/components/PushNotifications/types.js

@@ -0,0 +1,104 @@
+/*
+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 { Identity } from '@adobe/alloy-core/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
+ */
+
+export const Types = {};

package/src/components/componentCreators.js

@@ -0,0 +1,16 @@
+/*
+Copyright 2026 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 { default as activityCollector } from "./ActivityCollector/index.js";
+export { default as advertising } from "./Advertising/index.js";
+export { default as personalization } from "./Personalization/index.js";
+export { default as pushNotifications } from "./PushNotifications/index.js";

package/src/components/requiredComponentCreators.js

@@ -0,0 +1,13 @@
+/*
+Copyright 2026 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 { default as context } from "./Context/index.js";

package/src/createEventListeners.js

@@ -0,0 +1,81 @@
+/*
+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 serviceWorkerPushListener from "./components/PushNotifications/helpers/serviceWorkerPushListener.js";
+import createServiceWorkerNotificationClickListener from "./components/PushNotifications/helpers/serviceWorkerNotificationClickListener.js";
+import readFromIndexedDb from "./components/PushNotifications/helpers/readFromIndexedDb.js";
+import { createMakeSendServiceWorkerTrackingData } from "./components/PushNotifications/request/makeSendServiceWorkerTrackingData.js";
+import uuidv4 from "@adobe/alloy-core/utils/uuid.js";
+
+/**
+ * @type {Object} PlatformCapabilities
+ * @property {Logger} logger
+ * @property {(url: string, options: object) => Promise<Response>} fetch
+ *
+ * TODO: Remove dependency on sw (service worker)
+ */
+const createEventListeners = ({ platform, sw }) => {
+  const makeSendServiceWorkerTrackingData =
+    createMakeSendServiceWorkerTrackingData({
+      readFromIndexedDb,
+      uuidv4,
+      logger: platform.logger,
+      fetch: platform.fetch,
+    });
+
+  const serviceWorkerNotificationClickListener =
+    createServiceWorkerNotificationClickListener({
+      makeSendServiceWorkerTrackingData,
+      sw,
+      logger: platform.logger,
+    });
+
+  return {
+    pushNotifications: {
+      /**
+       *
+       * @param {PushEvent} event
+       * @returns Promise<void>
+       */
+      onPush(event) {
+        return serviceWorkerPushListener({
+          event,
+          sw,
+          logger: platform.logger,
+        });
+      },
+      /**
+       * @param {NotificationEvent} event
+       */
+      onNotificationClick(event) {
+        serviceWorkerNotificationClickListener({ event });
+      },
+      /**
+       *
+       * @param {NotificationEvent} event
+       */
+      async onNotificationClose(event) {
+        const data = event.notification.data;
+
+        try {
+          await makeSendServiceWorkerTrackingData({
+            /* eslint-disable-next-line no-underscore-dangle */
+            xdm: data._xdm.mixins,
+            actionLabel: "Dismiss",
+          });
+        } catch (error) {
+          platform.logger.error("Failed to send tracking call:", error);
+        }
+      },
+    },
+  };
+};
+export default createEventListeners;

package/src/index.js

@@ -9,5 +9,17 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-export { createInstance, createCustomInstance } from "@adobe/alloy-core";
-export * as components from "@adobe/alloy-core/core/componentCreators.js";
+import { createCustomInstance } from "@adobe/alloy-core";
+import * as allOptionalComponents from "./allOptionalComponents.js";
+import * as allRequiredComponents from "./components/requiredComponentCreators.js";
+
+export { createCustomInstance };
+export const createInstance = (options = {}) =>
+  createCustomInstance({
+    ...options,
+    components: [
+      ...Object.values(allRequiredComponents),
+      ...Object.values(allOptionalComponents),
+    ],
+  });
+export { allOptionalComponents as components };

package/src/initializeStandalone.js

@@ -0,0 +1,34 @@
+/*
+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 { WindowWithAlloy, AlloyQueueItem } from './types.js' */
+
+import { createCustomInstance } from "./index.js";
+
+const initializeStandalone = ({ components }) => {
+  const instanceNames = /** @type {WindowWithAlloy} */ (window).__alloyNS;
+  if (!instanceNames) {
+    return;
+  }
+  for (const name of instanceNames) {
+    const instance = createCustomInstance({ name, components });
+    const execute = (/** @type {AlloyQueueItem} */ item) => {
+      const [resolve, reject, [commandName, options]] = item;
+      return instance(commandName, options).then(resolve, reject);
+    };
+    const queue = window[name].q;
+    queue.push = execute;
+    queue.forEach(execute);
+  }
+};
+
+export default initializeStandalone;

package/src/serviceWorker.js

@@ -10,14 +10,14 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import createEventListeners from "@adobe/alloy-core/createEventListeners.js";
+import createEventListeners from "./createEventListeners.js";
 
 /* eslint-disable no-console */
 
 // @ts-check
 /// <reference lib="webworker" />
 
-/** @import { ServiceWorkerLogger } from '@adobe/alloy-core/types.js' */
+/** @import { ServiceWorkerLogger } from './components/PushNotifications/types.js' */
 
 /** @type {ServiceWorkerGlobalScope} */
 // @ts-ignore

package/src/standalone.js

@@ -10,31 +10,8 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-/** @import { WindowWithAlloy, AlloyQueueItem } from './types.js' */
+import initializeStandalone from "./initializeStandalone.js";
+import * as optionalComponents from "./allOptionalComponents.js";
 
-import { createCustomInstance } from "./index.js";
-import * as optionalComponents from "@adobe/alloy-core/core/componentCreators.js";
-
-// This file is used by rollup to create the browser version that is uploaded to cdn
-
-const initializeStandalone = ({ components }) => {
-  // eslint-disable-next-line no-underscore-dangle
-  const instanceNames = /** @type {WindowWithAlloy} */ (window).__alloyNS;
-  if (!instanceNames) {
-    return;
-  }
-  for (const name of instanceNames) {
-    const instance = createCustomInstance({ name, components });
-    const execute = (/** @type {AlloyQueueItem} */ item) => {
-      const [resolve, reject, [commandName, options]] = item;
-      return instance(commandName, options).then(resolve, reject);
-    };
-    const queue = window[name].q;
-    queue.push = execute;
-    queue.forEach(execute);
-  }
-};
-
-// If you change this line, check if the custom build script is still working.
-// You might need to change the babel plugin in scripts/helpers/entryPointGeneratorBabelPlugin.js.
+// Custom builds use scripts/helpers/generateEntryPoint.js to generate a modified version of this file.
 initializeStandalone({ components: Object.values(optionalComponents) });

package/.browserslistrc

@@ -1,2 +0,0 @@
-defaults
-not op_mini all

package/babel.config.js

@@ -1,76 +0,0 @@
-/*
-Copyright 2021 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.
-*/
-
-/*
- * This file is used in 4 scenarios:
- * 1. Building files specified in rollup.config.js
- * 2. Building libEs5/ files when publishing to NPM
- * 3. Building libEs6/ files when publishing to NPM
- * 4. Testcafe compiling clientFunctions. Unfortunately, there is no configuration I've found
- *    to tell Testcafe not to use this file.
- *
- * Environments:
- * "rollup" - Used for rollup.config.js
- * "npmEs5" - Used for building libEs5 files when publishing to NPM
- * "npmEs6" - Used for building libEs6 files when publishing to NPM
- */
-import { dirname } from "path";
-import { fileURLToPath } from "url";
-
-const cwd = dirname(fileURLToPath(import.meta.url));
-
-const transformTemplateLiteralsPlugin = [
-  "@babel/plugin-transform-template-literals",
-  {
-    loose: true,
-  },
-];
-const versionPlugin = ["./scripts/helpers/versionBabelPlugin", { cwd }];
-
-const transformModulesCommonjsPlugin = [
-  "@babel/plugin-transform-modules-commonjs",
-  {
-    strict: true,
-    noInterop: true,
-  },
-];
-
-const npmIgnoreFiles = ["src/baseCode.js"];
-
-export default {
-  env: {
-    rollup: {
-      presets: [
-        [
-          "@babel/preset-env",
-          {
-            modules: false,
-          },
-        ],
-      ],
-      plugins: [transformTemplateLiteralsPlugin, versionPlugin],
-    },
-    npmEs5: {
-      presets: [["@babel/preset-env"]],
-      ignore: npmIgnoreFiles,
-      plugins: [
-        transformTemplateLiteralsPlugin,
-        versionPlugin,
-        transformModulesCommonjsPlugin,
-      ],
-    },
-    npmEs6: {
-      ignore: npmIgnoreFiles,
-      plugins: [versionPlugin],
-    },
-  },
-};

package/dist/types/core/src/components/Advertising/identities/collectSurferId.d.ts

@@ -1,2 +0,0 @@
-export default collectSurferId;
-declare function collectSurferId(cookieManager: any, getBrowser: any, resolveSurferIdIfNotAvailable?: boolean): any;

package/dist/types/core/src/components/PushNotifications/request/createSendPushSubscriptionRequest.d.ts

@@ -1,6 +0,0 @@
-declare function _default({ payload }: {
-    payload: DataCollectionRequestPayload;
-}): Request;
-export default _default;
-import type { DataCollectionRequestPayload } from '../../../utils/request/types.js';
-import type { Request } from '../../../utils/request/types.js';

package/dist/types/core/src/constants/sessionDataKeys.d.ts

@@ -1 +0,0 @@
-export const CLICK_ACTIVITY_DATA: "clickData";

package/scripts/helpers/entryPointGeneratorBabelPlugin.js

@@ -1,101 +0,0 @@
-/*
-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.
-*/
-
-const COMPONENT_SOURCE = "@adobe/alloy-core/core/componentCreators.js";
-
-const createComponentArrayExpression = (t, includedModules) => {
-  return t.ArrayExpression(
-    includedModules.map((module) => t.Identifier(module)),
-  );
-};
-
-const createComponentImport = (t, includedModules) => {
-  if (!includedModules.length) {
-    return null;
-  }
-
-  const specifiers = includedModules.map((module) =>
-    t.importSpecifier(t.identifier(module), t.identifier(module)),
-  );
-
-  return t.importDeclaration(specifiers, t.stringLiteral(COMPONENT_SOURCE));
-};
-
-const removeOptionalComponentsImport = (path) => {
-  const importPaths = path
-    .get("body")
-    .filter(
-      (child) =>
-        child.isImportDeclaration() &&
-        child.node.source.value === COMPONENT_SOURCE,
-    );
-
-  importPaths.forEach((importPath) => {
-    importPath.remove();
-  });
-};
-
-const insertComponentImport = (path, importNode) => {
-  if (!importNode) {
-    return;
-  }
-
-  const importDeclarations = path
-    .get("body")
-    .filter((child) => child.isImportDeclaration());
-
-  if (importDeclarations.length === 0) {
-    path.unshiftContainer("body", importNode);
-    return;
-  }
-
-  importDeclarations[importDeclarations.length - 1].insertAfter(importNode);
-};
-
-export default (t, includedModules) => ({
-  visitor: {
-    // rewrite the imports
-    Program: {
-      enter(path, state) {
-        state.componentsArray = createComponentArrayExpression(
-          t,
-          includedModules,
-        );
-        removeOptionalComponentsImport(path);
-      },
-      exit(path, state) {
-        const importNode = createComponentImport(t, includedModules);
-        insertComponentImport(path, importNode);
-        state.componentsArray = null;
-      },
-    },
-    // pass in the new, smaller components array to `initializeStandalone`
-    CallExpression(path, state) {
-      if (path.node.callee.name !== "initializeStandalone") {
-        return;
-      }
-
-      const arrayExpression =
-        state.componentsArray ||
-        createComponentArrayExpression(t, includedModules);
-
-      path.replaceWith(
-        t.CallExpression(t.Identifier("initializeStandalone"), [
-          t.ObjectExpression([
-            t.ObjectProperty(t.Identifier("components"), arrayExpression),
-          ]),
-        ]),
-      );
-
-      path.stop();
-    },
-  },
-});