@fullstory/browser 2.0.0-beta.0 → 2.0.0-beta.3

package/README.md

@@ -35,6 +35,8 @@ The only required option is `orgId`, all others are optional.
 * `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`.
+* `startCaptureManually` - Set to `true` if you want to start capture manually using `FS('start')`. FullStory will load but wait for a call to `FS('start')` to begin capturing. See [Manually Delay Data Capture](https://developer.fullstory.com/browser/v2/auto-capture/capture-data/#manually-delay-data-capture) for more information.  Defaults to `false`.
+* `assetMapId` - Use this to set the current asset map id. See [Asset Uploading for Web](https://help.fullstory.com/hc/en-us/articles/4404129191575-Asset-Uploading-for-Web) for more information.
 
 ### Ready Callback
 

package/dist/index.d.ts

@@ -14,14 +14,16 @@ import { FSApi } from '@fullstory/snippet';
  */
 export interface SnippetOptions {
     orgId: string;
-    namespace?: string;
+    assetMapId?: string;
+    cookieDomain?: string;
     debug?: boolean;
+    devMode?: boolean;
     host?: string;
-    script?: string;
-    cookieDomain?: string;
+    namespace?: string;
     recordCrossDomainIFrames?: boolean;
     recordOnlyThisIFrame?: boolean;
-    devMode?: boolean;
+    script?: string;
+    startCaptureManually?: boolean;
 }
 /**
  * A callback that will be invoked when FullStory has begun a session.
@@ -35,6 +37,8 @@ type ReadyCallback = (data: {
 }) => void;
 declare global {
     interface Window {
+        _fs_asset_map_id?: string;
+        _fs_capture_on_startup?: boolean;
         _fs_cookie_domain?: string;
         _fs_debug?: boolean;
         _fs_dev_mode?: boolean;

package/dist/index.esm.js

@@ -50,6 +50,12 @@ var _init = function (inputOptions, readyCallback) {
     if (options.recordCrossDomainIFrames) {
         window._fs_run_in_iframe = true;
     }
+    if (options.assetMapId) {
+        window._fs_asset_map_id = options.assetMapId;
+    }
+    if (options.startCaptureManually) {
+        window._fs_capture_on_startup = false;
+    }
     // record the contents of this iFrame when embedded in a parent site
     if (options.recordOnlyThisIFrame) {
         window._fs_is_outer_script = true;

package/dist/index.js

@@ -52,6 +52,12 @@ var _init = function (inputOptions, readyCallback) {
     if (options.recordCrossDomainIFrames) {
         window._fs_run_in_iframe = true;
     }
+    if (options.assetMapId) {
+        window._fs_asset_map_id = options.assetMapId;
+    }
+    if (options.startCaptureManually) {
+        window._fs_capture_on_startup = false;
+    }
     // record the contents of this iFrame when embedded in a parent site
     if (options.recordOnlyThisIFrame) {
         window._fs_is_outer_script = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstory/browser",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.3",
   "description": "The official FullStory browser SDK",
   "repository": "git://github.com/fullstorydev/fullstory-browser-sdk.git",
   "homepage": "https://github.com/fullstorydev/fullstory-browser-sdk",
@@ -26,7 +26,7 @@
     "sdk"
   ],
   "dependencies": {
-    "@fullstory/snippet": "2.0.0-beta.2"
+    "@fullstory/snippet": "2.0.0-beta.3"
   },
   "devDependencies": {
     "@babel/core": "^7.8.7",

package/src/index.ts

@@ -15,14 +15,16 @@ import { initFS, FSApi } from '@fullstory/snippet';
  */
 export interface SnippetOptions {
   orgId: string;
-  namespace?: string;
+  assetMapId?: string;
+  cookieDomain?: string;
   debug?: boolean;
+  devMode?: boolean;
   host?: string;
-  script?: string;
-  cookieDomain?: string;
+  namespace?: string;
   recordCrossDomainIFrames?: boolean;
   recordOnlyThisIFrame?: boolean;
-  devMode?: boolean;
+  script?: string;
+  startCaptureManually?: boolean;
 }
 
 /**
@@ -35,6 +37,8 @@ type ReadyCallback = (data: { sessionUrl: string, settings: Readonly<object> })
 
 declare global {
   interface Window {
+    _fs_asset_map_id?: string;
+    _fs_capture_on_startup?: boolean;
     _fs_cookie_domain?: string;
     _fs_debug?: boolean;
     _fs_dev_mode?: boolean;
@@ -79,6 +83,14 @@ const _init = (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => {
     window._fs_run_in_iframe = true;
   }
 
+  if (options.assetMapId) {
+    window._fs_asset_map_id = options.assetMapId;
+  }
+
+  if (options.startCaptureManually) {
+    window._fs_capture_on_startup = false;
+  }
+
   // record the contents of this iFrame when embedded in a parent site
   if (options.recordOnlyThisIFrame) {
     window._fs_is_outer_script = true;