@adobe/alloy 2.21.0-beta.1 → 2.21.0-beta.11

package/scripts/alloyBuilder.js

@@ -0,0 +1,215 @@
+#!/usr/bin/env node
+
+/*
+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 fs from "fs";
+import path from "path";
+import { rollup } from "rollup";
+import { Command, Option, InvalidOptionArgumentError } from "commander";
+import inquirer from "inquirer";
+import { fileURLToPath } from "url";
+import { buildConfig } from "../rollup.config.js";
+import conditionalBuildBabelPlugin from "./helpers/conditionalBuildBabelPlugin.js";
+import components from "./helpers/alloyComponents.js";
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+
+let sourceRootPath = `${dirname}/../src`;
+if (!fs.existsSync(sourceRootPath)) {
+  sourceRootPath = `${dirname}/../libEs6`;
+}
+
+const getOptionalComponents = (() => {
+  const componentCreatorsPath = `${sourceRootPath}/core/componentCreators.js`;
+
+  // Read componentCreators.js
+  const componentCreatorsContent = fs.readFileSync(
+    componentCreatorsPath,
+    "utf8",
+  );
+
+  // Extract optional components based on @skipwhen directive
+  const optionalComponents = componentCreatorsContent
+    .split("\n")
+    .filter((line) => line.trim().startsWith("/* @skipwhen"))
+    .map((line) => {
+      const match = line.match(/ENV\.alloy_([a-zA-Z0-9]+) === false/);
+      if (match) {
+        const [, componentName] = match;
+        return componentName.toLowerCase(); // Ensure this matches the expected format for exclusion
+      }
+      return null;
+    })
+    .filter(Boolean);
+
+  return () => optionalComponents;
+})();
+
+const getDefaultPath = () => {
+  return process.cwd();
+};
+
+const getFile = (argv) => {
+  return `${[argv.outputDir, `alloy${argv.minify ? ".min" : ""}.js`].join(path.sep)}`;
+};
+
+const getFileSizeInKB = (filePath) => {
+  const stats = fs.statSync(filePath);
+  const fileSizeInBytes = stats.size;
+  return `${(fileSizeInBytes / 1024).toFixed(2)} K`;
+};
+
+const build = async (argv) => {
+  const rollupConfig = buildConfig({
+    input: `${sourceRootPath}/standalone.js`,
+    file: getFile(argv),
+    minify: argv.minify,
+    babelPlugins: [
+      conditionalBuildBabelPlugin(
+        argv.exclude.reduce((acc, module) => {
+          acc[`alloy_${module}`] = "false";
+          return acc;
+        }, {}),
+      ),
+    ],
+  });
+
+  const bundle = await rollup(rollupConfig);
+  await bundle.write(rollupConfig.output[0]);
+  console.log(
+    `🎉 Wrote ${
+      path.isAbsolute(argv.outputDir)
+        ? rollupConfig.output[0].file
+        : path.relative(process.cwd(), rollupConfig.output[0].file)
+    } (${getFileSizeInKB(rollupConfig.output[0].file)}).`,
+  );
+};
+
+const getMakeBuildCommand = () =>
+  new Command("build")
+    .description("Build a custom version of the alloy.js library.")
+    .addOption(
+      new Option(
+        "-e, --exclude <modules...>",
+        "optional components that can be excluded from the build",
+      )
+        .choices(getOptionalComponents())
+        .default([])
+        .argParser((value) => {
+          const modules = value.split(",");
+
+          modules.forEach((module) => {
+            if (!getOptionalComponents().includes(module))
+              throw new InvalidOptionArgumentError(
+                `Module "${module}" does not exists. Allowed choices are "${getOptionalComponents().join('", "')}".`,
+              );
+          });
+
+          return modules;
+        }),
+    )
+    .addOption(new Option("-M, --no-minify", "disable code minification"))
+    .addOption(
+      new Option(
+        "-o, --outputDir <dir>",
+        "the output directory for the generated build",
+      )
+        .default(getDefaultPath())
+        .argParser((value) => {
+          if (!path.isAbsolute(value)) {
+            value = `${getDefaultPath()}${path.sep}${value}`;
+          }
+
+          try {
+            const stats = fs.statSync(value);
+            if (!stats.isDirectory()) {
+              throw new InvalidOptionArgumentError(
+                `Output directory "${value}" is not a valid directory path.`,
+              );
+            }
+          } catch (error) {
+            throw new InvalidOptionArgumentError(
+              `Output directory "${value}" is not a valid directory path. ${error.message}`,
+            );
+          }
+
+          return value.replace(new RegExp(`${path.sep}+$`, "g"), "");
+        }),
+    )
+    .action(async (opts) => {
+      await build(opts);
+    });
+
+const getInteractiveBuildCommand = () =>
+  new Command("interactive-build")
+    .description(
+      "Interactive process that will ask a series of questions and then it will generate a build.",
+    )
+    .action(async () => {
+      await inquirer
+        .prompt([
+          {
+            type: "checkbox",
+            name: "include",
+            message: "What components should be included in your Alloy build?",
+            choices: components,
+          },
+          {
+            type: "list",
+            name: "minify",
+            message: "How would you like your JavaScript to be?",
+            choices: [
+              { name: "Minified", value: true },
+              { name: "Unminified", value: false },
+            ],
+          },
+          {
+            type: "string",
+            name: "outputDir",
+            message: "Where would you like to save the build?",
+            default: process.cwd(),
+          },
+        ])
+        .then(async (opts) => {
+          const { include } = opts;
+          const exclude = components
+            .map((v) => v.value)
+            .filter((component) => !include.includes(component));
+
+          opts.exclude = exclude;
+          delete opts.include;
+
+          await build(opts);
+        })
+        .catch((error) => {
+          if (error.isTtyError) {
+            console.error(
+              "Prompt couldn't be rendered in the current environment",
+            );
+          } else {
+            console.error("An error occurred: ", error);
+          }
+        });
+    });
+
+const program = new Command();
+
+program
+  .name("alloy")
+  .description(
+    "Tool for generating custom Adobe Experience Platform Web SDK builds.",
+  )
+  .version("1.0.0");
+
+program.addCommand(getMakeBuildCommand());
+program.addCommand(getInteractiveBuildCommand(), { isDefault: true });
+program.parse();

package/scripts/helpers/alloyComponents.js

@@ -0,0 +1,63 @@
+/*
+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 [
+  {
+    name: "Activity Collector",
+    value: "activitycollector",
+    checked: true,
+  },
+  {
+    name: "Audiences",
+    value: "audiences",
+    checked: true,
+  },
+  {
+    name: "Context",
+    value: "context",
+    checked: true,
+  },
+  {
+    name: "Decision Engine",
+    value: "decisioningengine",
+    checked: true,
+  },
+  {
+    name: "Event Merge",
+    value: "eventmerge",
+    checked: true,
+  },
+  {
+    name: "Personalization",
+    value: "personalization",
+    checked: true,
+  },
+  {
+    name: "Privacy",
+    value: "privacy",
+    checked: true,
+  },
+  {
+    name: "Streaming Media",
+    value: "streamingmedia",
+    checked: true,
+  },
+  {
+    name: "Legacy Media Analytics",
+    value: "legacymediaanalytics",
+    checked: true,
+  },
+  {
+    name: "Machine Learning",
+    value: "machinelearning",
+    checked: true,
+  },
+];

package/scripts/helpers/conditionalBuildBabelPlugin.js

@@ -0,0 +1,57 @@
+/*
+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.
+*/
+
+export default (excludedModules) => ({
+  visitor: {
+    ImportDeclaration(path) {
+      let skipWhenComments = [];
+      if (path.node.leadingComments) {
+        skipWhenComments = path.node.leadingComments.filter((c) => {
+          return c.value.trim().startsWith("@skipwhen");
+        });
+      }
+
+      if (skipWhenComments.length > 0) {
+        const [, webSDKModuleName, value] = skipWhenComments[0].value.match(
+          "ENV.(.*) === (false|true)",
+        );
+
+        if (excludedModules[webSDKModuleName] === value) {
+          const variableName = path.node.specifiers[0].local.name;
+
+          // Wrap the variable declaration in an IIFE to turn it into an expression
+          path.replaceWithSourceString(
+            `(() => { const ${variableName} = () => {}; })()`,
+          );
+        }
+      }
+    },
+    ExportDefaultDeclaration(path) {
+      if (path.node.declaration.type === "ArrayExpression") {
+        path.node.declaration.elements = path.node.declaration.elements.filter(
+          (element) => {
+            if (element.name) {
+              const variableName = element.name;
+              const componentName = variableName
+                .replace("create", "")
+                .toLowerCase();
+              return !Object.keys(excludedModules).includes(
+                `alloy_${componentName}`,
+              );
+            }
+            return true;
+          },
+        );
+      }
+    },
+  },
+});

package/scripts/helpers/versionBabelPlugin.js

@@ -0,0 +1,43 @@
+import { createRequire } from "module";
+
+const require = createRequire(import.meta.url);
+
+const version = null;
+const getVersion = ({ opts: { cwd } }) => {
+  if (version) {
+    return version;
+  }
+
+  // eslint-disable-next-line import/no-dynamic-require
+  const packageJson = require(`${cwd}/package.json`);
+  return packageJson.version;
+};
+
+export default (_ref) => {
+  const t = _ref.types;
+
+  return {
+    visitor: {
+      // __VERSION__
+      ReferencedIdentifier(path, state) {
+        const identifier = state.opts.identifier;
+        const transform = identifier === undefined ? true : identifier; // 默认转换
+
+        const define = state.opts.define || "__VERSION__"; // 默认值
+        if (transform && path.node.name === define) {
+          path.replaceWith(t.valueToNode(getVersion(state)));
+        }
+      },
+      // "__VERSION__"
+      StringLiteral(path, state) {
+        const stringLiteral = state.opts.stringLiteral;
+        const transform = stringLiteral === undefined ? true : stringLiteral;
+
+        const define = state.opts.define || "__VERSION__";
+        if (transform && path.node.value === define) {
+          path.replaceWith(t.valueToNode(getVersion(state)));
+        }
+      },
+    },
+  };
+};

package/libEs5/components/ActivityCollector/createGetLinkDetails.js

@@ -1,68 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-/*
-Copyright 2022 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.
-*/
-var _default = exports.default = function _default(_ref) {
-  var window = _ref.window,
-    getLinkName = _ref.getLinkName,
-    getLinkRegion = _ref.getLinkRegion,
-    getAbsoluteUrlFromAnchorElement = _ref.getAbsoluteUrlFromAnchorElement,
-    findSupportedAnchorElement = _ref.findSupportedAnchorElement,
-    determineLinkType = _ref.determineLinkType;
-  return function (_ref2) {
-    var targetElement = _ref2.targetElement,
-      config = _ref2.config,
-      logger = _ref2.logger;
-    var anchorElement = findSupportedAnchorElement(targetElement);
-    if (!anchorElement) {
-      logger.info("This link click event is not triggered because the HTML element is not an anchor.");
-      return undefined;
-    }
-    var linkUrl = getAbsoluteUrlFromAnchorElement(window, anchorElement);
-    if (!linkUrl) {
-      logger.info("This link click event is not triggered because the HTML element doesn't have an URL.");
-      return undefined;
-    }
-    var linkType = determineLinkType(window, config, linkUrl, anchorElement);
-    var linkRegion = getLinkRegion(anchorElement);
-    var linkName = getLinkName(anchorElement);
-    var onBeforeLinkClickSend = config.onBeforeLinkClickSend;
-    var options = {
-      xdm: {
-        eventType: "web.webinteraction.linkClicks",
-        web: {
-          webInteraction: {
-            name: linkName,
-            region: linkRegion,
-            type: linkType,
-            URL: linkUrl,
-            linkClicks: {
-              value: 1
-            }
-          }
-        }
-      },
-      data: {},
-      clickedElement: targetElement
-    };
-    if (!onBeforeLinkClickSend) {
-      return options;
-    }
-    var shouldEventBeTracked = onBeforeLinkClickSend(options);
-    if (shouldEventBeTracked !== false) {
-      return options;
-    }
-    logger.info("This link click event is not triggered because it was canceled in onBeforeLinkClickSend.");
-    return undefined;
-  };
-};

package/libEs5/components/ActivityCollector/utils.js

@@ -1,104 +0,0 @@
-"use strict";
-
-exports.urlStartsWithScheme = exports.truncateWhiteSpace = exports.trimQueryFromUrl = exports.isSupportedAnchorElement = exports.isExitLink = exports.isEmptyString = exports.isDownloadLink = exports.getAbsoluteUrlFromAnchorElement = exports.findSupportedAnchorElement = exports.determineLinkType = void 0;
-/*
-Copyright 2019 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.
-*/
-
-var urlStartsWithScheme = exports.urlStartsWithScheme = function urlStartsWithScheme(url) {
-  return url && /^[a-z0-9]+:\/\//i.test(url);
-};
-var getAbsoluteUrlFromAnchorElement = exports.getAbsoluteUrlFromAnchorElement = function getAbsoluteUrlFromAnchorElement(window, element) {
-  var loc = window.location;
-  var url = element.href ? element.href : "";
-  var protocol = element.protocol,
-    host = element.host;
-  if (!urlStartsWithScheme(url)) {
-    if (!protocol) {
-      protocol = loc.protocol ? loc.protocol : "";
-    }
-    protocol = protocol ? protocol + "//" : "";
-    if (!host) {
-      host = loc.host ? loc.host : "";
-    }
-    var path = "";
-    if (url.substring(0, 1) !== "/") {
-      var indx = loc.pathname.lastIndexOf("/");
-      indx = indx < 0 ? 0 : indx;
-      path = loc.pathname.substring(0, indx);
-    }
-    url = "" + protocol + host + path + "/" + url;
-  }
-  return url;
-};
-var isSupportedAnchorElement = exports.isSupportedAnchorElement = function isSupportedAnchorElement(element) {
-  if (element.href && (element.tagName === "A" || element.tagName === "AREA") && (!element.onclick || !element.protocol || element.protocol.toLowerCase().indexOf("javascript") < 0)) {
-    return true;
-  }
-  return false;
-};
-var trimQueryFromUrl = exports.trimQueryFromUrl = function trimQueryFromUrl(url) {
-  var questionMarkIndex = url.indexOf("?");
-  var 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;
-};
-var isDownloadLink = exports.isDownloadLink = function isDownloadLink(downloadLinkQualifier, linkUrl, clickedObj) {
-  var re = new RegExp(downloadLinkQualifier);
-  var trimmedLinkUrl = trimQueryFromUrl(linkUrl).toLowerCase();
-  return clickedObj.download ? true : re.test(trimmedLinkUrl);
-};
-var isExitLink = exports.isExitLink = function isExitLink(window, linkUrl) {
-  var currentHostname = window.location.hostname.toLowerCase();
-  var trimmedLinkUrl = trimQueryFromUrl(linkUrl).toLowerCase();
-  if (trimmedLinkUrl.indexOf(currentHostname) >= 0) {
-    return false;
-  }
-  return true;
-};
-
-/**
- * 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.
- */
-var truncateWhiteSpace = exports.truncateWhiteSpace = function truncateWhiteSpace(str) {
-  return str && str.replace(/\s+/g, " ").trim();
-};
-var isEmptyString = exports.isEmptyString = function isEmptyString(str) {
-  return !str || str.length === 0;
-};
-var determineLinkType = exports.determineLinkType = function determineLinkType(window, config, linkUrl, clickedObj) {
-  var linkType = "other";
-  if (isDownloadLink(config.downloadLinkQualifier, linkUrl, clickedObj)) {
-    linkType = "download";
-  } else if (isExitLink(window, linkUrl)) {
-    linkType = "exit";
-  }
-  return linkType;
-};
-var findSupportedAnchorElement = exports.findSupportedAnchorElement = function findSupportedAnchorElement(targetElement) {
-  var node = targetElement;
-  while (node) {
-    if (isSupportedAnchorElement(node)) {
-      return node;
-    }
-    node = node.parentNode;
-  }
-  return null;
-};

package/libEs6/components/ActivityCollector/createGetLinkDetails.js

@@ -1,70 +0,0 @@
-/*
-Copyright 2022 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 (({
-  window,
-  getLinkName,
-  getLinkRegion,
-  getAbsoluteUrlFromAnchorElement,
-  findSupportedAnchorElement,
-  determineLinkType
-}) => {
-  return ({
-    targetElement,
-    config,
-    logger
-  }) => {
-    const anchorElement = findSupportedAnchorElement(targetElement);
-    if (!anchorElement) {
-      logger.info("This link click event is not triggered because the HTML element is not an anchor.");
-      return undefined;
-    }
-    const linkUrl = getAbsoluteUrlFromAnchorElement(window, anchorElement);
-    if (!linkUrl) {
-      logger.info("This link click event is not triggered because the HTML element doesn't have an URL.");
-      return undefined;
-    }
-    const linkType = determineLinkType(window, config, linkUrl, anchorElement);
-    const linkRegion = getLinkRegion(anchorElement);
-    const linkName = getLinkName(anchorElement);
-    const {
-      onBeforeLinkClickSend
-    } = config;
-    const options = {
-      xdm: {
-        eventType: "web.webinteraction.linkClicks",
-        web: {
-          webInteraction: {
-            name: linkName,
-            region: linkRegion,
-            type: linkType,
-            URL: linkUrl,
-            linkClicks: {
-              value: 1
-            }
-          }
-        }
-      },
-      data: {},
-      clickedElement: targetElement
-    };
-    if (!onBeforeLinkClickSend) {
-      return options;
-    }
-    const shouldEventBeTracked = onBeforeLinkClickSend(options);
-    if (shouldEventBeTracked !== false) {
-      return options;
-    }
-    logger.info("This link click event is not triggered because it was canceled in onBeforeLinkClickSend.");
-    return undefined;
-  };
-});