@fullstory/browser 1.6.2 → 1.7.1

package/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
+## 1.7.1
+
+- Changed FullStory Snippet to import from @fullstory/snippet
+- Npm audit updates
+
+## 1.7.0
+
+- Add a `cookieDomain` option to the `init` function to support setting `_fs_cookie_domain`. 
+
 ## 1.6.2
 
-- Load `fs-debug.js` capture script when `debug = true` option is used to match updated debug logging practices.
+- Load `fs-debug.js` capture script when `debug = true` option is used to match [updated debug logging practices](https://help.fullstory.com/hc/en-us/articles/360020829233-What-is-fs-debug-).
 
 ## 1.6.1
 

package/README.md

@@ -31,6 +31,7 @@ The only required option is `orgId`, all others are optional.
 *  `host` - The recording server host domain. Can be set to direct recorded events to a proxy that you host. Defaults to `fullstory.com`.
 *  `script` - FullStory script host domain. FullStory hosts the `fs.js` recording script on a CDN, but you can choose to host a copy yourself. Defaults to `edge.fullstory.com`.
 * `namespace` - Sets the global identifier for FullStory when conflicts with `FS` arise; see [help](https://help.fullstory.com/hc/en-us/articles/360020624694-What-if-the-identifier-FS-is-used-by-another-script-on-my-site-).
+* `cookieDomain` - Overrides the cookie domain. By default, cookies will be valid for all subdomains of your site; if you want to limit the cookies to a specific subdomain, you can set the domain value explicitly. More information can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622874-Can-the-FullStory-cookie-be-associated-with-a-specific-subdomain-).
 * `recordCrossDomainIFrames` - Defaults to `false`. FullStory can record cross-domain iFrames if: 1. The FullStory Browser SDK is running in the cross-domain iFrame and 2. `recordCrossDomainIFrames` is set to `true` in the cross-domain iFrame and 3. The FullStory Browser SDK is running in the parent page of the cross-domain iFrame. Click [here](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy) for a detailed explanation of what "cross-domain" means. Before using, you should understand the security implications, and configure your [Content Security Policy](https://www.html5rocks.com/en/tutorials/security/content-security-policy/) (CSP) HTTP headers accordingly - specifically the frame-ancestors directive. Failure to configure your CSP headers while using this setting can bypass IFrames security protections that are included in modern browsers. More information about cross-domain iFrame recording can be found on our [Knowledge Base](https://help.fullstory.com/hc/en-us/articles/360020622514-Can-FullStory-capture-content-that-is-presented-in-iframes-#2-the-outer-page-is-running-fullstory-and-you-have-iframes-runni). Note: the `recordCrossDomainIFrames` parameter is the same as the `window['_fs_run_in_iframe']` referenced in the KB article.
 * `recordOnlyThisIFrame` - When set to `true`, this tells FullStory that the IFrame is the "root" of the recording and should be its own session; defaults to `false`. Use this when your app is embedded in an IFrame on a site not running FullStory or when the site *is* running FullStory, but you want your content sent to a different FullStory org.
 * `devMode` - Set to `true` if you want to deactivate FullStory in your development environment. When set to `true`, FullStory will shutdown recording and all subsequent SDK method calls will be no-ops. At the time `init` is called with `devMode: true`, a single `event` call will be sent to FullStory to indicate that the SDK is in `devMode`; this is to help trouble-shoot the case that the SDK was accidentally set to `devMode: true` in a production environment. Additionally, any calls to SDK methods will `console.warn` that FullStory is in `devMode`. Defaults to `false`.

package/dist/index.d.ts

@@ -6,6 +6,7 @@
  * - debug: Debug mode with extra browser console logging.
  * - host: The recording server host domain. Can be set to direct recorded events to a proxy that you host. Defaults to `fullstory.com`.
  * - script: FullStory script host domain. FullStory hosts the `fs.js` recording script on a CDN, but you can choose to host a copy yourself. Defaults to `edge.fullstory.com`.
+ * - cookieDomain: Overrides the cookie domain. By default, cookies will be valid for all subdomains of your site; if you want to limit the cookies to a specific subdomain, you can set the domain value explicitly. More information can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622874-Can-the-FullStory-cookie-be-associated-with-a-specific-subdomain-).
  * - recordCrossDomainIFrames: FullStory can record cross-domain iFrames. Defaults to `false`. Certain limitations apply and can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622514-Can-FullStory-capture-content-that-is-presented-in-iframes-#h_01F1G333PYKPGZ4B42WDBV3YKV).
  * - recordOnlyThisIFrame: FullStory can record the iFrame as its own unique session. Defaults to `false`. Additional conditions apply and can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622514-Can-FullStory-capture-content-that-is-presented-in-iframes-#h_01F1G33B40Q2TPQA8MA7SF8Y5P).
  * - devMode: In dev mode FullStory won't record sessions. Any calls to SDK methods will `console.warn` that FullStory is in `devMode`. Defaults to `false`.
@@ -16,6 +17,7 @@ interface SnippetOptions {
   debug?: boolean;
   host?: string;
   script?: string;
+  cookieDomain?: string;
   recordCrossDomainIFrames?: boolean;
   recordOnlyThisIFrame?: boolean;
   devMode?: boolean;

package/dist/index.esm.js

@@ -1,3 +1,5 @@
+import { initFS } from '@fullstory/snippet';
+
 function ownKeys(object, enumerableOnly) {
   var keys = Object.keys(object);
 
@@ -39,109 +41,6 @@ function _defineProperty(obj, key, value) {
   return obj;
 }
 
-var snippet = function snippet(_ref) {
-  var orgId = _ref.orgId,
-      _ref$namespace = _ref.namespace,
-      namespace = _ref$namespace === void 0 ? 'FS' : _ref$namespace,
-      _ref$debug = _ref.debug,
-      _ref$host = _ref.host,
-      host = _ref$host === void 0 ? 'fullstory.com' : _ref$host,
-      _ref$script = _ref.script,
-      script = _ref$script === void 0 ? 'edge.fullstory.com/s/fs.js' : _ref$script;
-
-  if (!orgId) {
-    throw new Error('FullStory orgId is a required parameter');
-  }
-
-  window['_fs_host'] = host;
-  window['_fs_script'] = script;
-  window['_fs_org'] = orgId;
-  window['_fs_namespace'] = namespace;
-
-  (function (m, n, e, t, l, o, g, y) {
-    if (e in m) {
-      if (m.console && m.console.log) {
-        m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].');
-      }
-
-      return;
-    }
-
-    g = m[e] = function (a, b, s) {
-      g.q ? g.q.push([a, b, s]) : g._api(a, b, s);
-    };
-
-    g.q = [];
-    o = n.createElement(t);
-    o.async = 1;
-    o.crossOrigin = 'anonymous';
-    o.src = 'https://' + _fs_script;
-    y = n.getElementsByTagName(t)[0];
-    y.parentNode.insertBefore(o, y);
-
-    g.identify = function (i, v, s) {
-      g(l, {
-        uid: i
-      }, s);
-      if (v) g(l, v, s);
-    };
-
-    g.setUserVars = function (v, s) {
-      g(l, v, s);
-    };
-
-    g.event = function (i, v, s) {
-      g('event', {
-        n: i,
-        p: v
-      }, s);
-    };
-
-    g.anonymize = function () {
-      g.identify(!!0);
-    };
-
-    g.shutdown = function () {
-      g("rec", !1);
-    };
-
-    g.restart = function () {
-      g("rec", !0);
-    };
-
-    g.log = function (a, b) {
-      g("log", [a, b]);
-    };
-
-    g.consent = function (a) {
-      g("consent", !arguments.length || a);
-    };
-
-    g.identifyAccount = function (i, v) {
-      o = 'account';
-      v = v || {};
-      v.acctId = i;
-      g(o, v);
-    };
-
-    g.clearUserCookie = function () {};
-
-    g.setVars = function (n, p) {
-      g('setVars', [n, p]);
-    };
-
-    g._w = {};
-    y = 'XMLHttpRequest';
-    g._w[y] = m[y];
-    y = 'fetch';
-    g._w[y] = m[y];
-    if (m[y]) m[y] = function () {
-      return g._w[y].apply(this, arguments);
-    };
-    g._v = "1.3.0";
-  })(window, document, window['_fs_namespace'], 'script', 'user');
-};
-
 var fs = function fs() {
   return window[window._fs_namespace];
 };
@@ -212,6 +111,10 @@ var _init = function _init(inputOptions, readyCallback) {
     window._fs_is_outer_script = true;
   }
 
+  if (options.cookieDomain) {
+    window._fs_cookie_domain = options.cookieDomain;
+  }
+
   if (options.debug === true) {
     if (!options.script) {
       options.script = 'edge.fullstory.com/s/fs-debug.js';
@@ -220,7 +123,7 @@ var _init = function _init(inputOptions, readyCallback) {
     }
   }
 
-  snippet(options);
+  initFS(options);
 
   if (readyCallback) {
     fs()('observe', {

package/dist/index.js

@@ -2,6 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var snippet = require('@fullstory/snippet');
+
 function ownKeys(object, enumerableOnly) {
   var keys = Object.keys(object);
 
@@ -43,109 +45,6 @@ function _defineProperty(obj, key, value) {
   return obj;
 }
 
-var snippet = function snippet(_ref) {
-  var orgId = _ref.orgId,
-      _ref$namespace = _ref.namespace,
-      namespace = _ref$namespace === void 0 ? 'FS' : _ref$namespace,
-      _ref$debug = _ref.debug,
-      _ref$host = _ref.host,
-      host = _ref$host === void 0 ? 'fullstory.com' : _ref$host,
-      _ref$script = _ref.script,
-      script = _ref$script === void 0 ? 'edge.fullstory.com/s/fs.js' : _ref$script;
-
-  if (!orgId) {
-    throw new Error('FullStory orgId is a required parameter');
-  }
-
-  window['_fs_host'] = host;
-  window['_fs_script'] = script;
-  window['_fs_org'] = orgId;
-  window['_fs_namespace'] = namespace;
-
-  (function (m, n, e, t, l, o, g, y) {
-    if (e in m) {
-      if (m.console && m.console.log) {
-        m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].');
-      }
-
-      return;
-    }
-
-    g = m[e] = function (a, b, s) {
-      g.q ? g.q.push([a, b, s]) : g._api(a, b, s);
-    };
-
-    g.q = [];
-    o = n.createElement(t);
-    o.async = 1;
-    o.crossOrigin = 'anonymous';
-    o.src = 'https://' + _fs_script;
-    y = n.getElementsByTagName(t)[0];
-    y.parentNode.insertBefore(o, y);
-
-    g.identify = function (i, v, s) {
-      g(l, {
-        uid: i
-      }, s);
-      if (v) g(l, v, s);
-    };
-
-    g.setUserVars = function (v, s) {
-      g(l, v, s);
-    };
-
-    g.event = function (i, v, s) {
-      g('event', {
-        n: i,
-        p: v
-      }, s);
-    };
-
-    g.anonymize = function () {
-      g.identify(!!0);
-    };
-
-    g.shutdown = function () {
-      g("rec", !1);
-    };
-
-    g.restart = function () {
-      g("rec", !0);
-    };
-
-    g.log = function (a, b) {
-      g("log", [a, b]);
-    };
-
-    g.consent = function (a) {
-      g("consent", !arguments.length || a);
-    };
-
-    g.identifyAccount = function (i, v) {
-      o = 'account';
-      v = v || {};
-      v.acctId = i;
-      g(o, v);
-    };
-
-    g.clearUserCookie = function () {};
-
-    g.setVars = function (n, p) {
-      g('setVars', [n, p]);
-    };
-
-    g._w = {};
-    y = 'XMLHttpRequest';
-    g._w[y] = m[y];
-    y = 'fetch';
-    g._w[y] = m[y];
-    if (m[y]) m[y] = function () {
-      return g._w[y].apply(this, arguments);
-    };
-    g._v = "1.3.0";
-  })(window, document, window['_fs_namespace'], 'script', 'user');
-};
-
 var fs = function fs() {
   return window[window._fs_namespace];
 };
@@ -216,6 +115,10 @@ var _init = function _init(inputOptions, readyCallback) {
     window._fs_is_outer_script = true;
   }
 
+  if (options.cookieDomain) {
+    window._fs_cookie_domain = options.cookieDomain;
+  }
+
   if (options.debug === true) {
     if (!options.script) {
       options.script = 'edge.fullstory.com/s/fs-debug.js';
@@ -224,7 +127,7 @@ var _init = function _init(inputOptions, readyCallback) {
     }
   }
 
-  snippet(options);
+  snippet.initFS(options);
 
   if (readyCallback) {
     fs()('observe', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstory/browser",
-  "version": "1.6.2",
+  "version": "1.7.1",
   "description": "The official FullStory browser SDK",
   "repository": "git://github.com/fullstorydev/fullstory-browser-sdk.git",
   "homepage": "https://github.com/fullstorydev/fullstory-browser-sdk",
@@ -13,7 +13,7 @@
     "clean": "rimraf dist",
     "test": "npm run lint && npm run test:karma",
     "test:karma": "karma start --single-run --browsers ChromeHeadless karma.conf.js",
-    "lint": "eslint src test .github/actions",
+    "lint": "eslint src test",
     "build": "tsc src/index.d.ts && rollup -c"
   },
   "files": [
@@ -25,6 +25,9 @@
     "browser",
     "sdk"
   ],
+  "dependencies": {
+    "@fullstory/snippet": "1.3.1"
+  },
   "devDependencies": {
     "@babel/core": "^7.8.7",
     "@babel/eslint-parser": "^7.16.5",
@@ -48,6 +51,6 @@
     "rollup": "^1.32.1",
     "rollup-plugin-copy": "^3.3.0",
     "typescript": "^3.8.3",
-    "webpack": "^5.38.1"
+    "webpack": "^5.76.1"
   }
 }

package/src/index.d.ts

@@ -6,6 +6,7 @@
  * - debug: Debug mode with extra browser console logging.
  * - host: The recording server host domain. Can be set to direct recorded events to a proxy that you host. Defaults to `fullstory.com`.
  * - script: FullStory script host domain. FullStory hosts the `fs.js` recording script on a CDN, but you can choose to host a copy yourself. Defaults to `edge.fullstory.com`.
+ * - cookieDomain: Overrides the cookie domain. By default, cookies will be valid for all subdomains of your site; if you want to limit the cookies to a specific subdomain, you can set the domain value explicitly. More information can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622874-Can-the-FullStory-cookie-be-associated-with-a-specific-subdomain-).
  * - recordCrossDomainIFrames: FullStory can record cross-domain iFrames. Defaults to `false`. Certain limitations apply and can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622514-Can-FullStory-capture-content-that-is-presented-in-iframes-#h_01F1G333PYKPGZ4B42WDBV3YKV).
  * - recordOnlyThisIFrame: FullStory can record the iFrame as its own unique session. Defaults to `false`. Additional conditions apply and can be found [here](https://help.fullstory.com/hc/en-us/articles/360020622514-Can-FullStory-capture-content-that-is-presented-in-iframes-#h_01F1G33B40Q2TPQA8MA7SF8Y5P).
  * - devMode: In dev mode FullStory won't record sessions. Any calls to SDK methods will `console.warn` that FullStory is in `devMode`. Defaults to `false`.
@@ -16,6 +17,7 @@ interface SnippetOptions {
   debug?: boolean;
   host?: string;
   script?: string;
+  cookieDomain?: string;
   recordCrossDomainIFrames?: boolean;
   recordOnlyThisIFrame?: boolean;
   devMode?: boolean;

package/src/index.js

@@ -1,4 +1,4 @@
-import snippet from './snippet';
+import { initFS } from '@fullstory/snippet';
 
 const fs = () => window[window._fs_namespace];
 
@@ -57,6 +57,11 @@ const _init = (inputOptions, readyCallback) => {
     window._fs_is_outer_script = true;
   }
 
+  // Set cookie domain if it was specified.
+  if (options.cookieDomain) {
+    window._fs_cookie_domain = options.cookieDomain;
+  }
+
   if (options.debug === true) {
     if (!options.script) {
       options.script = 'edge.fullstory.com/s/fs-debug.js';
@@ -65,7 +70,7 @@ const _init = (inputOptions, readyCallback) => {
     }
   }
 
-  snippet(options);
+  initFS(options);
 
   if (readyCallback) {
     fs()('observe', { type: 'start', callback: readyCallback });

package/src/snippet.js

@@ -1,40 +0,0 @@
-// this code is auto-generated. DO NOT EDIT.
-/* eslint-disable */
-const snippet = (
-  {
-    orgId,
-    namespace = 'FS',
-    debug = false,
-    host = 'fullstory.com',
-    script = 'edge.fullstory.com/s/fs.js'
-  }
-) => {
-  if (!orgId) {
-    throw new Error('FullStory orgId is a required parameter');
-  }
-  /* begin FullStory snippet */
-  window['_fs_host'] = host;
-window['_fs_script'] = script;
-window['_fs_org'] = orgId;
-window['_fs_namespace'] = namespace;
-(function(m,n,e,t,l,o,g,y){
-    if (e in m) {if(m.console && m.console.log) { m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].');} return;}
-    g=m[e]=function(a,b,s){g.q?g.q.push([a,b,s]):g._api(a,b,s);};g.q=[];
-    o=n.createElement(t);o.async=1;o.crossOrigin='anonymous';o.src='https://'+_fs_script;
-    y=n.getElementsByTagName(t)[0];y.parentNode.insertBefore(o,y);
-    g.identify=function(i,v,s){g(l,{uid:i},s);if(v)g(l,v,s)};g.setUserVars=function(v,s){g(l,v,s)};g.event=function(i,v,s){g('event',{n:i,p:v},s)};
-    g.anonymize=function(){g.identify(!!0)};
-    g.shutdown=function(){g("rec",!1)};g.restart=function(){g("rec",!0)};
-    g.log = function(a,b){g("log",[a,b])};
-    g.consent=function(a){g("consent",!arguments.length||a)};
-    g.identifyAccount=function(i,v){o='account';v=v||{};v.acctId=i;g(o,v)};
-    g.clearUserCookie=function(){};
-    g.setVars=function(n, p){g('setVars',[n,p]);};
-    g._w={};y='XMLHttpRequest';g._w[y]=m[y];y='fetch';g._w[y]=m[y];
-    if(m[y])m[y]=function(){return g._w[y].apply(this,arguments)};
-    g._v="1.3.0";
-})(window,document,window['_fs_namespace'],'script','user');
-  /* end FullStory snippet */
-};
-
-export default snippet;