gatsby-plugin-rudderstack 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.0.0](https://github.com/rudderlabs/gatsby-plugin-rudderstack/compare/v3.0.0...v4.0.0) (2024-03-28)
+
+
+### Features
+
+* use js sdk v3 ([#30](https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues/30)) ([3c81fd7](https://github.com/rudderlabs/gatsby-plugin-rudderstack/commit/3c81fd7eefefdf3afe1f8a28fd5a5eff7b6009c6))
+* use JS SDK v3 loading snippet with new useLegacySDK option for v2.x usage ([#26](https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues/26)) ([c05cdbb](https://github.com/rudderlabs/gatsby-plugin-rudderstack/commit/c05cdbb15ef5fb6862d7d9804e980219d7ab6fe3))
+
+## [2.0.0](https://github.com/rudderlabs/gatsby-plugin-rudderstack/compare/a2ed4a794130f7a0dd783f42c1107aa44089a45c...v2.0.0) (2022-12-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* modify delayLoad functionality (#17)
+
+### Features
+
+* Added option to use new JS SDK ([#10](https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues/10)) ([a2ed4a7](https://github.com/rudderlabs/gatsby-plugin-rudderstack/commit/a2ed4a794130f7a0dd783f42c1107aa44089a45c))
+* modify delayLoad functionality ([#17](https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues/17)) ([65f176d](https://github.com/rudderlabs/gatsby-plugin-rudderstack/commit/65f176dd8e7fff4749b7142ba16d63519651fe45))
+
 ## [3.0.0](https://github.com/rudderlabs/gatsby-plugin-rudderstack/compare/v2.0.0...v3.0.0) (2023-12-05)
 
 

package/README.md

@@ -120,10 +120,6 @@ plugins: [
       // 'defer' will load the SDK as <script defer></script>
       loadType: 'default',
 
-      // Whether to use the snippet for JS SDK v2.x
-      // Useful for only loading the previous major version of the SDK if you do not want to migrate to v3 yet.
-      useLegacySDK: false,
-
       // Options to the `load` API
       // Note: The above `controlPlaneUrl` overrides the `configUrl` field in this object
       // You can find all the available load options here,

package/gatsby-ssr.js

@@ -21,8 +21,7 @@ exports.onRenderBody = function (_ref, pluginOptions) {
     _pluginOptions$sdkURL = pluginOptions.sdkURL,
     sdkURL = _pluginOptions$sdkURL === void 0 ? 'https://cdn.rudderlabs.com/v3' : _pluginOptions$sdkURL,
     _pluginOptions$loadOp = pluginOptions.loadOptions,
-    loadOptions = _pluginOptions$loadOp === void 0 ? {} : _pluginOptions$loadOp,
-    useLegacySDK = pluginOptions.useLegacySDK;
+    loadOptions = _pluginOptions$loadOp === void 0 ? {} : _pluginOptions$loadOp;
   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.');
   var writeKey = process.env.NODE_ENV === 'production' ? prodKey : devKey;
@@ -30,17 +29,7 @@ exports.onRenderBody = function (_ref, pluginOptions) {
     configUrl: controlPlaneUrl || loadOptions.configUrl
   });
   var loadConfig = "'".concat(writeKey, "', '").concat(dataPlaneUrl, "', ").concat(JSON.stringify(finalLoadOptions));
-  var snippet = "window.RudderSnippetVersion=\"3.0.0-beta.14\";var sdkBaseUrl=\"".concat(sdkURL, "\";var sdkName=\"rsa.min.js\";var asyncScript=true;window.rudderAnalyticsBuildType=\"legacy\",window.rudderanalytics=[];\n  var e=[\"setDefaultInstanceKey\",\"load\",\"ready\",\"page\",\"track\",\"identify\",\"alias\",\"group\",\"reset\",\"setAnonymousId\",\"startSession\",\"endSession\",\"consent\"];\n  for(var n=0;n<e.length;n++){var t=e[n];window.rudderanalytics[t]=function(e){return function(){window.rudderanalytics.push([e].concat(Array.prototype.slice.call(arguments)))}}(t)}\n  try{new Function('return import(\"\")'),window.rudderAnalyticsBuildType=\"modern\"}catch(a){}\n  if(window.rudderAnalyticsMount=function(){\"undefined\"==typeof globalThis&&(Object.defineProperty(Object.prototype,\"__globalThis_magic__\",{get:function get(){return this},configurable:true}),__globalThis_magic__.globalThis=__globalThis_magic__,delete Object.prototype.__globalThis_magic__);\n  var e=document.createElement(\"script\");e.src=\"\".concat(sdkBaseUrl,\"/\").concat(window.rudderAnalyticsBuildType,\"/\").concat(sdkName),e.async=asyncScript,document.head?document.head.appendChild(e):document.body.appendChild(e)},\"undefined\"==typeof Promise||\"undefined\"==typeof globalThis){\n  var d=document.createElement(\"script\");d.src=\"https://polyfill.io/v3/polyfill.min.js?features=Symbol%2CPromise&callback=rudderAnalyticsMount\",d.async=asyncScript,document.head?document.head.appendChild(d):document.body.appendChild(d)}else{window.rudderAnalyticsMount()}\n  ");
-  if (useLegacySDK) {
-    var scriptTagStr = "var s = document.createElement(\"script\");\n      s.type = \"text/javascript\";\n      s.src = \"".concat(sdkURL, "\";");
-    if (loadType === 'async') {
-      scriptTagStr += 's.async = true;';
-    } else if (loadType === 'defer') {
-      scriptTagStr += 's.defer = true;';
-    }
-    scriptTagStr += 'document.head.appendChild(s);';
-    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    ".concat(scriptTagStr);
-  }
+  var snippet = "!function(){\"use strict\";window.RudderSnippetVersion=\"3.0.3\";var sdkBaseUrl=".concat(sdkURL, ";var sdkName=\"rsa.min.js\";var asyncScript=").concat(loadType === 'async', ";var deferScript=").concat(loadType === 'defer', ";window.rudderAnalyticsBuildType=\"legacy\",window.rudderanalytics=[]\n  ;var e=[\"setDefaultInstanceKey\",\"load\",\"ready\",\"page\",\"track\",\"identify\",\"alias\",\"group\",\"reset\",\"setAnonymousId\",\"startSession\",\"endSession\",\"consent\"]\n  ;for(var n=0;n<e.length;n++){var t=e[n];window.rudderanalytics[t]=function(e){return function(){\n  window.rudderanalytics.push([e].concat(Array.prototype.slice.call(arguments)))}}(t)}try{\n  new Function('return import(\"\")'),window.rudderAnalyticsBuildType=\"modern\"}catch(a){}\n  if(window.rudderAnalyticsMount=function(){\n  \"undefined\"==typeof globalThis&&(Object.defineProperty(Object.prototype,\"__globalThis_magic__\",{get:function get(){\n  return this},configurable:true}),__globalThis_magic__.globalThis=__globalThis_magic__,\n  delete Object.prototype.__globalThis_magic__);var e=document.createElement(\"script\")\n  ;e.src=\"\".concat(sdkBaseUrl,\"/\").concat(window.rudderAnalyticsBuildType,\"/\").concat(sdkName);if(asyncScript){e.async=true};if(deferScript){e.defer=true};document.head?document.head.appendChild(e):document.body.appendChild(e)\n  },\"undefined\"==typeof Promise||\"undefined\"==typeof globalThis){var d=document.createElement(\"script\")\n  ;d.src=\"https://polyfill-fastly.io/v3/polyfill.min.js?version=3.111.0&features=Symbol%2CPromise&callback=rudderAnalyticsMount\",\n  d.async=asyncScript,document.head?document.head.appendChild(d):document.body.appendChild(d)}else{\n  window.rudderAnalyticsMount()}}();");
   var instantLoader = "".concat(snippet).concat(manualLoad ? "" : "window.rudderanalytics.load(".concat(loadConfig, ")"), ";");
   var delayedLoader = "\n      window.rudderSnippetLoaded = false;\n      window.rudderSnippetLoading = false;\n      window.rudderSnippetLoadedCallback = undefined;\n      window.rudderSnippetLoader = function (callback) {\n        if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {\n          window.rudderSnippetLoading = true;\n          function loader() {\n            ".concat(snippet, "\n            window.rudderanalytics.load(").concat(loadConfig, ");\n            window.rudderSnippetLoading = false;\n            window.rudderSnippetLoaded = true;\n            if (callback) { callback(); }\n            if (window.rudderSnippetLoadedCallback) {\n              window.rudderSnippetLoadedCallback();\n              window.rudderSnippetLoadedCallback = undefined;\n            }\n          };\n\n          \"requestIdleCallback\" in window\n            ? requestIdleCallback(function () { loader(); })\n            : loader();\n        }\n      }\n      window.addEventListener('scroll',function () {window.rudderSnippetLoader()}, { once: true });\n      setTimeout(\n        function () {\n          \"requestIdleCallback\" in window\n            ? requestIdleCallback(function () { window.rudderSnippetLoader(); })\n            : window.rudderSnippetLoader();\n        },\n        ").concat(delayLoadTime, " || 1000\n      );\n      ");
   var snippetToUse = "".concat(delayLoad && !manualLoad ? delayedLoader : instantLoader);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gatsby-plugin-rudderstack",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Event tracking with RudderStack in your Gatsby frontend.",
   "main": "gatsby-ssr.js",
   "scripts": {