@adobe/alloy 2.32.0 → 2.32.1-beta.1

package/src/components/ActivityCollector/utils/hasPageName.js

@@ -0,0 +1,23 @@
+/*
+Copyright 2024 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 (event) => {
+  const content = event.getContent();
+  return (
+    content.xdm !== undefined &&
+    // NOTE: A page view event should "ideally" include the pageViews type
+    // && event.xdm.eventType === "web.webpagedetails.pageViews"
+    content.xdm.web !== undefined &&
+    content.xdm.web.webPageDetails !== undefined &&
+    content.xdm.web.webPageDetails.name !== undefined
+  );
+};

package/src/components/ActivityCollector/utils/isDifferentDomains.js

@@ -0,0 +1,19 @@
+/*
+Copyright 2024 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 extractDomain from "./dom/extractDomain.js";
+
+export default (uri1, uri2) => {
+  const domain1 = extractDomain(uri1);
+  const domain2 = extractDomain(uri2);
+  return domain1 !== domain2;
+};

package/src/components/ActivityCollector/utils/trimQueryFromUrl.js

@@ -0,0 +1,31 @@
+/*
+Copyright 2024 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.
+*/
+
+/**
+ * Trims the query from the URL.
+ * @param {string} url
+ * @returns {string}
+ */
+export default (url) => {
+  const questionMarkIndex = url.indexOf("?");
+  const hashIndex = url.indexOf("#");
+  if (
+    questionMarkIndex >= 0 &&
+    (questionMarkIndex < hashIndex || hashIndex < 0)
+  ) {
+    return url.substring(0, questionMarkIndex);
+  }
+  if (hashIndex >= 0) {
+    return url.substring(0, hashIndex);
+  }
+  return url;
+};

package/src/components/ActivityCollector/utils/truncateWhiteSpace.js

@@ -0,0 +1,22 @@
+/*
+Copyright 2024 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.
+*/
+
+/**
+ * Reduces repeated whitespace within a string. Whitespace surrounding the string
+ * is trimmed and any occurrence of whitespace within the string is replaced with
+ * a single space.
+ * @param {string} str String to be formatted.
+ * @returns {string} Formatted string.
+ */
+export default (str) => {
+  return str && str.replace(/\s+/g, " ").trim();
+};

package/src/components/ActivityCollector/validateClickCollectionConfig.js

@@ -0,0 +1,47 @@
+/*
+Copyright 2024 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.
+*/
+// src/components/ActivityCollector/validateClickCollectionConfig.js
+/*
+Copyright 2024 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 { DEFAULT_DOWNLOAD_QUALIFIER } from "./configValidators.js";
+
+export default (config, logger) => {
+  const {
+    clickCollectionEnabled,
+    onBeforeLinkClickSend,
+    downloadLinkQualifier: dlq,
+  } = config;
+
+  if (clickCollectionEnabled === false) {
+    if (onBeforeLinkClickSend) {
+      logger.warn(
+        "The 'onBeforeLinkClickSend' configuration was provided but will be ignored because clickCollectionEnabled is false.",
+      );
+    }
+
+    if (dlq && dlq !== DEFAULT_DOWNLOAD_QUALIFIER) {
+      logger.warn(
+        "The 'downloadLinkQualifier' configuration was provided but will be ignored because clickCollectionEnabled is false.",
+      );
+    }
+  }
+};

package/src/components/componentCreators.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 activityCollector } from "./ActivityCollector/index.js";

package/src/index.js

@@ -9,5 +9,13 @@ 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";
+
+export { createCustomInstance };
+export const createInstance = (options = {}) =>
+  createCustomInstance({
+    ...options,
+    components: 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/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/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();
-    },
-  },
-});