gatsby-plugin-rudderstack 1.0.5 → 1.1.0

package/README.md

@@ -85,7 +85,7 @@ plugins: [
       // number (default to 1000); time to wait after the page loads
       // to load the RudderStack SDK
       // To be used when `delayLoad` is set to `true`
-      delayLoadTime: 1000
+      delayLoadTime: 1000,
 
       // Whether to completely skip calling `analytics.load()`.
       // ADVANCED FEATURE: only use if you are calling `analytics.load()` manually
@@ -93,13 +93,19 @@ plugins: [
       // that will call it for you.
       // Useful for only loading the tracking script once a user has opted in to being tracked, for example.
       // *Another use case is if you want to add callbacks to the methods at load time.
-      manualLoad: false
+      manualLoad: false,
 
       // string ('async' or 'defer'); whether to load the RudderStack SDK async or defer. Anything else
       // will load normally.
       // 'async' will load the SDK as <script async></script>
       // 'defer' will load the SDK as <script defer></script>
-      loadType: 'default'
+      loadType: 'default',
+
+      // Options to the `load` API
+      // Note: The above `controlPlaneUrl` overrides the `configUrl` field in this object
+      loadOptions: {
+        ...
+      }
     }
   }
 ];

package/gatsby-ssr.js

@@ -4,38 +4,59 @@ var _react = require("react");
 
 var _react2 = _interopRequireDefault(_react);
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(obj) {
+  return obj && obj.__esModule ? obj : { default: obj };
+}
 
 exports.onRenderBody = function (_ref, pluginOptions) {
   var setHeadComponents = _ref.setHeadComponents;
   var trackPage = pluginOptions.trackPage,
-      prodKey = pluginOptions.prodKey,
-      devKey = pluginOptions.devKey,
-      _pluginOptions$dataPl = pluginOptions.dataPlaneUrl,
-      dataPlaneUrl = _pluginOptions$dataPl === undefined ? "https://hosted.rudderlabs.com" : _pluginOptions$dataPl,
-      controlPlaneUrl = pluginOptions.controlPlaneUrl,
-      delayLoad = pluginOptions.delayLoad,
-      delayLoadTime = pluginOptions.delayLoadTime,
-      manualLoad = pluginOptions.manualLoad,
-      loadType = pluginOptions.loadType,
-      useNewSDK = pluginOptions.useNewSDK;
-
+    prodKey = pluginOptions.prodKey,
+    devKey = pluginOptions.devKey,
+    _pluginOptions$dataPl = pluginOptions.dataPlaneUrl,
+    dataPlaneUrl =
+      _pluginOptions$dataPl === undefined
+        ? "https://hosted.rudderlabs.com"
+        : _pluginOptions$dataPl,
+    controlPlaneUrl = pluginOptions.controlPlaneUrl,
+    delayLoad = pluginOptions.delayLoad,
+    delayLoadTime = pluginOptions.delayLoadTime,
+    manualLoad = pluginOptions.manualLoad,
+    loadType = pluginOptions.loadType,
+    useNewSDK = pluginOptions.useNewSDK,
+    loadOptions = pluginOptions.loadOptions;
 
   var sdkSrc = "https://cdn.rudderlabs.com/v1/rudder-analytics.min.js";
   if (useNewSDK) {
     sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
   }
 
-  if (!prodKey || prodKey.length < 10) console.error("Your Rudderstack prodKey must be at least 10 char in length.");
+  if (!prodKey || prodKey.length < 10)
+    console.error(
+      "Your RudderStack prodKey must be at least 10 char in length."
+    );
 
-  if (devKey && devKey.length < 10) console.error("If present, your Rudderstack devKey must be at least 10 char in length.");
+  if (devKey && devKey.length < 10)
+    console.error(
+      "If present, your RudderStack devKey must be at least 10 char in length."
+    );
 
   var writeKey = process.env.NODE_ENV === "production" ? prodKey : devKey;
 
-  var loadConfig = controlPlaneUrl ? "'" + writeKey + "', '" + dataPlaneUrl + "', {configUrl: '" + controlPlaneUrl + "'}" : "'" + writeKey + "', '" + dataPlaneUrl + "'";
+  var loadConfig = "'" + writeKey + "', '" + dataPlaneUrl + "'";
 
+  if (loadOptions) {
+    // Override config URL if provided separately
+    loadOptions.configUrl = controlPlaneUrl || loadOptions.configUrl;
+    loadConfig += ", " + JSON.stringify(loadOptions);
+  }
 
-  var snippet = "rudderanalytics=window.rudderanalytics=[];for(var methods=[\"load\",\"page\",\"track\",\"identify\",\"alias\",\"group\",\"ready\",\"reset\",\"getAnonymousId\",\"setAnonymousId\"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n  " + (delayLoad || manualLoad ? "" : "rudderanalytics.load(" + loadConfig + ")") + ";\n";
+  var snippet =
+    'rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n  ' +
+    (delayLoad || manualLoad
+      ? ""
+      : "rudderanalytics.load(" + loadConfig + ")") +
+    ";\n";
 
   const delayedLoader = `
       window.rudderSnippetLoaded = false;
@@ -71,30 +92,39 @@ exports.onRenderBody = function (_ref, pluginOptions) {
       );
     `;
 
-  var snippetToUse = "\n      " + (delayLoad && !manualLoad ? delayedLoader : "") + "\n      " + snippet + "\n    ";
+  var snippetToUse =
+    "\n      " +
+    (delayLoad && !manualLoad ? delayedLoader : "") +
+    "\n      " +
+    snippet +
+    "\n    ";
 
   if (writeKey) {
-    var tags = [_react2.default.createElement("script", {
-      key: "plugin-rudderstack",
-      dangerouslySetInnerHTML: { __html: snippetToUse }
-    })];
+    var tags = [
+      _react2.default.createElement("script", {
+        key: "plugin-rudderstack",
+        dangerouslySetInnerHTML: { __html: snippetToUse },
+      }),
+    ];
 
     var tag = void 0;
 
-    if (loadType == 'async') {
-      tag = _react2.default.createElement("script", { async: true,
+    if (loadType == "async") {
+      tag = _react2.default.createElement("script", {
+        async: true,
         key: "rudderstack-cdn",
-        src: sdkSrc
+        src: sdkSrc,
       });
-    } else if (loadType == 'defer') {
-      tag = _react2.default.createElement("script", { defer: true,
+    } else if (loadType == "defer") {
+      tag = _react2.default.createElement("script", {
+        defer: true,
         key: "rudderstack-cdn",
-        src: sdkSrc
+        src: sdkSrc,
       });
     } else {
       tag = _react2.default.createElement("script", {
         key: "rudderstack-cdn",
-        src: sdkSrc
+        src: sdkSrc,
       });
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gatsby-plugin-rudderstack",
-  "version": "1.0.5",
-  "description": "Event tracking with Rudderstack in your Gatsby frontend.",
+  "version": "1.1.0",
+  "description": "Event tracking with RudderStack in your Gatsby frontend.",
   "main": "gatsby-ssr.js",
   "scripts": {
     "build": "babel src --out-dir . --ignore __tests__",
@@ -18,7 +18,7 @@
     "gatsby",
     "gatsby-plugin"
   ],
-  "author": "Rudderstack",
+  "author": "RudderStack",
   "license": "AGPL-3.0-only",
   "bugs": {
     "url": "https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues"