@fullstory/browser 1.6.1 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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](https://help.fullstory.com/hc/en-us/articles/360020829233-What-is-fs-debug-).
+
 ## 1.6.1
 
 - Fix a TypeScript type issue with the `readyCallback` API (#144)

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`.
@@ -40,7 +41,7 @@ The only required option is `orgId`, all others are optional.
 The `init` function also accepts an optional `readyCallback` argument. If you provide a function, it will be invoked when the FullStory session has started. Your callback will be called with one parameter: an object containing information about the session. Currently the only property is `sessionUrl`, which is a string containing the URL to the session.
 
 ```javascript
-FullStory.init({ orgId, ({ sessionUrl }) => console.log(`Started session: ${sessionUrl}`));
+FullStory.init({ orgId }, ({ sessionUrl }) => console.log(`Started session: ${sessionUrl}`));
 ```
 
 ### Initialization Examples

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,9 +1,49 @@
+function ownKeys(object, enumerableOnly) {
+  var keys = Object.keys(object);
+
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
+  }
+
+  return keys;
+}
+
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
+  }
+
+  return target;
+}
+
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    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,
-      debug = _ref$debug === void 0 ? false : _ref$debug,
       _ref$host = _ref.host,
       host = _ref$host === void 0 ? 'fullstory.com' : _ref$host,
       _ref$script = _ref.script,
@@ -13,7 +53,6 @@ var snippet = function snippet(_ref) {
     throw new Error('FullStory orgId is a required parameter');
   }
 
-  window['_fs_debug'] = debug;
   window['_fs_host'] = host;
   window['_fs_script'] = script;
   window['_fs_org'] = orgId;
@@ -157,7 +196,9 @@ var restart = guard('restart');
 var anonymize = guard('anonymize');
 var setVars = guard('setVars');
 
-var _init = function _init(options, readyCallback) {
+var _init = function _init(inputOptions, readyCallback) {
+  var options = _objectSpread2({}, inputOptions);
+
   if (fs()) {
     console.warn('The FullStory snippet has already been defined elsewhere (likely in the <head> element)');
     return;
@@ -171,6 +212,18 @@ var _init = function _init(options, 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';
+    } else {
+      console.warn('Ignoring `debug = true` because `script` is set');
+    }
+  }
+
   snippet(options);
 
   if (readyCallback) {

package/dist/index.js

@@ -2,12 +2,52 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+function ownKeys(object, enumerableOnly) {
+  var keys = Object.keys(object);
+
+  if (Object.getOwnPropertySymbols) {
+    var symbols = Object.getOwnPropertySymbols(object);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
+  }
+
+  return keys;
+}
+
+function _objectSpread2(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
+  }
+
+  return target;
+}
+
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    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,
-      debug = _ref$debug === void 0 ? false : _ref$debug,
       _ref$host = _ref.host,
       host = _ref$host === void 0 ? 'fullstory.com' : _ref$host,
       _ref$script = _ref.script,
@@ -17,7 +57,6 @@ var snippet = function snippet(_ref) {
     throw new Error('FullStory orgId is a required parameter');
   }
 
-  window['_fs_debug'] = debug;
   window['_fs_host'] = host;
   window['_fs_script'] = script;
   window['_fs_org'] = orgId;
@@ -161,7 +200,9 @@ var restart = guard('restart');
 var anonymize = guard('anonymize');
 var setVars = guard('setVars');
 
-var _init = function _init(options, readyCallback) {
+var _init = function _init(inputOptions, readyCallback) {
+  var options = _objectSpread2({}, inputOptions);
+
   if (fs()) {
     console.warn('The FullStory snippet has already been defined elsewhere (likely in the <head> element)');
     return;
@@ -175,6 +216,18 @@ var _init = function _init(options, 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';
+    } else {
+      console.warn('Ignoring `debug = true` because `script` is set');
+    }
+  }
+
   snippet(options);
 
   if (readyCallback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstory/browser",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "The official FullStory browser SDK",
   "repository": "git://github.com/fullstorydev/fullstory-browser-sdk.git",
   "homepage": "https://github.com/fullstorydev/fullstory-browser-sdk",

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

@@ -17,14 +17,14 @@ const hasFullStoryWithFunction = (...testNames) => {
 const guard = (name) => (...args) => {
   if (window._fs_dev_mode) {
     const message = `FullStory is in dev mode and is not recording: ${name} method not executed`;
-    console.warn(message); // eslint-disable-line no-console
+    console.warn(message);
     return message;
   }
 
   if (hasFullStoryWithFunction(name)) {
     return fs()[name](...args);
   }
-  console.warn(`FS.${name} not ready`); // eslint-disable-line no-console
+  console.warn(`FS.${name} not ready`);
   return null;
 };
 
@@ -39,9 +39,10 @@ export const restart = guard('restart');
 export const anonymize = guard('anonymize');
 export const setVars = guard('setVars');
 
-const _init = (options, readyCallback) => {
+const _init = (inputOptions, readyCallback) => {
+  // Make a copy so we can modify `options` if desired.
+  const options = { ...inputOptions };
   if (fs()) {
-    // eslint-disable-next-line no-console
     console.warn('The FullStory snippet has already been defined elsewhere (likely in the <head> element)');
     return;
   }
@@ -56,6 +57,19 @@ const _init = (options, 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';
+    } else {
+      console.warn('Ignoring `debug = true` because `script` is set');
+    }
+  }
+
   snippet(options);
 
   if (readyCallback) {
@@ -69,13 +83,12 @@ const _init = (options, readyCallback) => {
     });
     shutdown();
     window._fs_dev_mode = true;
-    console.warn(message); // eslint-disable-line no-console
+    console.warn(message);
   }
 };
 
 const initOnce = (fn, message) => (...args) => {
   if (window._fs_initialized) {
-    // eslint-disable-next-line no-console
     if (message) console.warn(message);
     return;
   }

package/src/snippet.js

@@ -13,8 +13,7 @@ const snippet = (
     throw new Error('FullStory orgId is a required parameter');
   }
   /* begin FullStory snippet */
-  window['_fs_debug'] = debug;
-window['_fs_host'] = host;
+  window['_fs_host'] = host;
 window['_fs_script'] = script;
 window['_fs_org'] = orgId;
 window['_fs_namespace'] = namespace;