Get ready to publish Alloy as an NPM repo

README.md

@@ -2,8 +2,56 @@
 
 # Alloy
 
-Alloy is the code name for the Adobe Experience Platform Web SDK. It allows for streaming data into the platform, syncing identities, personalizing content, and more.
+Alloy is the code name for the Adobe Experience Platform Web SDK. It allows for recording events into the Adobe Experience Platform, syncing identities, personalizing content, and more.
 
 For documentation on how to use Alloy, please see the [user documentation](https://adobe.ly/36dGGp6).
 
 For documentation on how to contribute to Alloy, please see the [developer documentation](https://github.com/adobe/alloy/wiki).
+
+## Installation
+
+There are three supported ways to use Alloy.
+  1. Using Adobe Launch, install the Adobe Experience Platform Web SDK Extension.
+  2. Use the pre-built, minified version available via a CDN. You could also self-host this version.
+  3. Use the NPM library which exports an ES6 module.
+
+### Using the launch extension
+
+For documentation on the AEP Web SDK Launch Extension see the [launch documentation](https://docs.adobe.com/content/help/en/launch/using/extensions-ref/adobe-extension/aep-extension/overview.html)
+
+### Using the stand alone version
+
+```html
+<script>
+  !function(n,o){o.forEach(function(o){n[o]||((n.__alloyNS=n.__alloyNS||
+  []).push(o),n[o]=function(){var u=arguments;return new Promise(
+  function(i,l){n[o].q.push([i,l,u])})},n[o].q=[])})}
+  (window,["alloy"]);
+</script>
+<script src="https://cdn1.adoberesources.net/alloy/2.2.0/alloy.min.js" async></script>
+<script>
+  window.alloy("config", { ... });
+  window.alloy("sendEvent", { ... });
+</script>
+```
+
+### Using the NPM library
+
+```bash
+npm install @adobe/alloy
+```
+
+Using the library:
+
+```javascript
+import { baseCode, core } from "@adobe/alloy";
+baseCode(["alloy"]);   // creates the window.alloy function
+core();                // runs
+
+window.alloy("config", { ... });
+window.alloy("sendEvent", { ... });
+```
+
+The ES6 exports are exposed via the NPM "module" property, so you may need to adjust your rollup system to look for the module property.
+
+

coverageignore.js

@@ -14,4 +14,10 @@ governing permissions and limitations under the License.
  * Patterns of source files (files within the src directory) that should be
  * ignored for test coverage checks and reporting.
  */
-module.exports = ["**/.*", "**/constants/**", "**/index.js"];
+module.exports = [
+  "**/.*",
+  "**/constants/**",
+  "**/index.js",
+  "src/baseCode.js",
+  "src/standAlone.js"
+];

package.json

@@ -1,8 +1,11 @@
 {
   "name": "@adobe/alloy",
   "version": "2.2.0",
-  "description": "Client-Side SDK for Unified Data Collection",
-  "main": "src/core/index.js",
+  "description": "Adobe Experience Platform Web SDK",
+  "module": "dist/index.js",
+  "files": [
+    "dist/index.js"
+  ],
   "scripts": {
     "clean": "rimraf dist",
     "lint": "eslint --fix \"*.js\" \"src/**/*.js\" \"test/**/*.js\"",
@@ -28,12 +31,10 @@
     "prebuild": "npm run clean && npm run format && npm run lint",
     "build": "rollup -c",
     "prebuild:prod": "npm run prebuild",
-    "build:prod:standalone:unminified": "rollup -c --environment BUILD:prodStandalone",
-    "build:prod:standalone:minified": "rollup -c --environment MINIFY,BUILD:prodStandalone",
-    "build:prod:reactor:unminified": "rollup -c --environment BUILD:prodReactor",
-    "build:prod": "npm-run-all --parallel build:prod:standalone:unminified build:prod:standalone:minified build:prod:reactor:unminified",
+    "build:prod:unminified": "rollup -c --environment BUILD:prod",
+    "build:prod:minified": "rollup -c --environment MINIFY,BUILD:prod",
+    "build:prod": "npm-run-all --parallel build:prod:unminified build:prod:minified",
     "build:watch": "rollup -c -w",
-    "build:basecode": "terser src/baseCode/index.js --mangle --compress unused=false",
     "sandbox": "cd sandbox && export REACT_APP_NONCE=321 && npm start",
     "sandbox:install": "cd sandbox && npm install",
     "sandbox:build": "cd sandbox && npm run build",
@@ -77,14 +78,20 @@
     }
   ],
   "dependencies": {
+    "css.escape": "^1.5.1",
+    "uuid": "^3.3.2"
+  },
+  "peerDependencies": {
     "@adobe/reactor-cookie": "^1.0.0",
     "@adobe/reactor-load-script": "^1.1.1",
     "@adobe/reactor-object-assign": "^1.0.0",
-    "@adobe/reactor-query-string": "^1.0.0",
-    "css.escape": "^1.5.1",
-    "uuid": "^3.3.2"
+    "@adobe/reactor-query-string": "^1.0.0"
   },
   "devDependencies": {
+    "@adobe/reactor-cookie": "^1.0.0",
+    "@adobe/reactor-load-script": "^1.1.1",
+    "@adobe/reactor-object-assign": "^1.0.0",
+    "@adobe/reactor-query-string": "^1.0.0",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",
     "@babel/plugin-transform-template-literals": "^7.4.4",

rollup.config.js

@@ -11,22 +11,19 @@ governing permissions and limitations under the License.
 */
 
 import path from "path";
-import jscc from "rollup-plugin-jscc";
 import resolve from "rollup-plugin-node-resolve";
 import commonjs from "rollup-plugin-commonjs";
 import babel from "rollup-plugin-babel";
 import { terser } from "rollup-plugin-terser";
 import license from "rollup-plugin-license";
 
 const buildTargets = {
-  PROD_STANDALONE: "prodStandalone",
-  PROD_REACTOR: "prodReactor",
+  PROD: "prod",
   DEV: "dev"
 };
 
 const destDirectoryByBuildTarget = {
-  [buildTargets.PROD_STANDALONE]: "dist/standalone/",
-  [buildTargets.PROD_REACTOR]: "dist/reactor/",
+  [buildTargets.PROD]: "dist/",
   [buildTargets.DEV]: "sandbox/public/"
 };
 
@@ -35,14 +32,14 @@ const minify = process.env.MINIFY;
 const destDirectory = destDirectoryByBuildTarget[buildTarget];
 
 const minifiedExtension = minify ? ".min" : "";
+const baseCodeTerser = terser({
+  mangle: true,
+  compress: {
+    unused: false
+  }
+});
 
 const plugins = [
-  jscc({
-    values: {
-      _DEV: buildTarget === buildTargets.DEV,
-      _REACTOR: buildTarget === buildTargets.PROD_REACTOR
-    }
-  }),
   resolve({
     preferBuiltins: false,
     // Support the browser field in dependencies' package.json.
@@ -53,10 +50,6 @@ const plugins = [
   babel()
 ];
 
-if (minify) {
-  plugins.push(terser());
-}
-
 if (buildTarget !== buildTargets.DEV) {
   plugins.push(
     license({
@@ -69,52 +62,53 @@ if (buildTarget !== buildTargets.DEV) {
   );
 }
 
-const config = {
-  input: "src/core/index.js",
+const config = [];
+
+if (buildTarget === buildTargets.PROD) {
+  config.push({
+    input: "src/baseCode.js",
+    output: [
+      {
+        file: `${destDirectory}baseCode${minifiedExtension}.js`,
+        format: "iife"
+      }
+    ],
+    plugins: minify ? [...plugins, baseCodeTerser] : plugins
+  });
+}
+
+config.push({
+  input: "src/standAlone.js",
   output: [
     {
       file: `${destDirectory}alloy${minifiedExtension}.js`,
-      // For the Reactor-specific build, we need to use the CommonJS format
-      // for output instead of IIFE, otherwise Rollup doesn't know whether the
-      // "external" modules (as defined elsewhere in this configuration) are
-      // coming from global variables or from another CommonJS bundler, so
-      // it adds a bunch of cruft to accommodate and logs build warnings.
-      // Because we have to use the CommonJS format for the Reactor-specific
-      // build, we can't just use an "intro" that looks like:
-      // if (IE less than version 11) {
-      //   console.warn("unsupported browser");
-      //   return;
-      // }
-      // because you can't "return" from a CommonJS module. Therefore, we have
-      // to do an if-else for an "intro" and "outro".
-      // If we do an if-else, we're not compliant with strict mode, because
-      // babel inserts its function declarations directly inside our if-else.
-      // Because function declarations are not allowed directly within an
-      // if-else in strict mode, we need to wrap babel's
-      // function declarations (and our own code) inside an IIFE.
-      // So, what we end up with is output using "format: cjs" but with an
-      // appropriate intro and outro that provides browser checking and an
-      // IIFE. This works for both Reactor-specific and standalone use cases.
-      format: "cjs",
-      // Allow non-IE browsers and IE11
-      // document.documentMode was added in IE8, and is specific to IE.
-      // IE7 and lower are not ES5 compatible so will get a parse error loading
-      // the library.
+      format: "iife",
       intro:
         "if (document.documentMode && document.documentMode < 11) {\n" +
         "  console.warn('The Adobe Experience Cloud Web SDK does not support IE 10 and below.');\n" +
-        "} else {\n" +
-        "  (function() {",
-      outro: "  })();\n}"
+        "  return;\n" +
+        "}\n"
     }
   ],
-  plugins
-};
+  plugins: minify ? [...plugins, terser()] : plugins
+});
 
-// If we're building for Reactor, we'll use Reactor's core modules
-// (named @adobe/reactor-*) instead of including the packages directly.
-if (buildTarget === buildTargets.PROD_REACTOR) {
-  config.external = name => /^@adobe\/reactor-/.test(name);
+if (buildTarget === buildTargets.PROD && !minify) {
+  config.push({
+    input: "src/index.js",
+    output: [
+      {
+        file: `${destDirectory}index.js`,
+        format: "es"
+      }
+    ],
+    // The @adobe/reactor-* dependencies are specified as peerDependencies so no need to include them in the
+    // module build. The Launch extension does not need them included.
+    external(name) {
+      return /^@adobe\/reactor-/.test(name);
+    },
+    plugins
+  });
 }
 
 export default config;

src/baseCode.js

@@ -0,0 +1,17 @@
+/*
+Copyright 2020 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 by rollup to create a base code example
+
+import baseCode from "./baseCode/index";
+
+baseCode(["alloy"]);