@fullstory/browser 2.0.0-beta.4 → 2.0.1

package/README.md

@@ -80,6 +80,7 @@ The only required option is `orgId`, all others are optional.
 * `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.
+* `appHost` - Use this to set the app host for displaying session urls. If using a version of [FullStory Relay](https://help.fullstory.com/hc/en-us/articles/360046112593-How-to-send-captured-traffic-to-your-First-Party-Domain-using-FullStory-Relay), you may need to set `appHost` "app.fullstory.com" or "app.eu1.fullstory.com" depending on your region.
 
 ### Ready Callback
 

package/dist/index.d.ts

@@ -14,6 +14,7 @@ import { FSApi } from '@fullstory/snippet';
  */
 export interface SnippetOptions {
     orgId: string;
+    appHost?: string;
     assetMapId?: string;
     cookieDomain?: string;
     debug?: boolean;
@@ -37,6 +38,7 @@ type ReadyCallback = (data: {
 }) => void;
 declare global {
     interface Window {
+        _fs_app_host?: string;
         _fs_asset_map_id?: string;
         _fs_capture_on_startup?: boolean;
         _fs_cookie_domain?: string;

package/dist/index.esm.js

@@ -50,6 +50,9 @@ var _init = function (inputOptions, readyCallback) {
     if (options.recordCrossDomainIFrames) {
         window._fs_run_in_iframe = true;
     }
+    if (options.appHost) {
+        window._fs_app_host = options.appHost;
+    }
     if (options.assetMapId) {
         window._fs_asset_map_id = options.assetMapId;
     }
@@ -86,7 +89,7 @@ var _init = function (inputOptions, readyCallback) {
         fs('trackEvent', {
             name: 'FullStory Dev Mode',
             properties: {
-                message_str: message,
+                message: message,
             }
         });
         fs('shutdown');

package/dist/index.js

@@ -52,6 +52,9 @@ var _init = function (inputOptions, readyCallback) {
     if (options.recordCrossDomainIFrames) {
         window._fs_run_in_iframe = true;
     }
+    if (options.appHost) {
+        window._fs_app_host = options.appHost;
+    }
     if (options.assetMapId) {
         window._fs_asset_map_id = options.assetMapId;
     }
@@ -88,7 +91,7 @@ var _init = function (inputOptions, readyCallback) {
         fs('trackEvent', {
             name: 'FullStory Dev Mode',
             properties: {
-                message_str: message,
+                message: message,
             }
         });
         fs('shutdown');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstory/browser",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.1",
   "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.3"
+    "@fullstory/snippet": "2.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.8.7",

package/src/index.test.ts

@@ -151,6 +151,16 @@ describe('typescript safety', () => {
     // @ts-expect-error (for testing purposes)
     FS('observe', { type: '🦂', callback: () => console.log('STARTED') });
 
+    // Disconnector can be `void` type
+    const disconnector = FS('observe', { type: 'start', callback: () => console.log('STARTED') });
+
+    // README(scottnorvell): statements where we _don't_ null check the disconnector
+    // work in the editor but not on CI so I got rid of them 🤷‍♂️
+    if (disconnector) {
+      // passes
+      disconnector.disconnect();
+    }
+
     // LEGACY:
     // Passes TypeScript check
     FS.setVars('user', { email: 'e@mail.com' });
@@ -169,4 +179,17 @@ describe('typescript safety', () => {
     // Assertion for posterity's sake...
     expect(true).to.equal(true);
   });
+
+  // NOTE: don't run this test, it will hang since fs.js isn't really running. It's only for typescript safety checks.
+  xit('provides type assistance for the async api', async () => {
+    init({ orgId: testOrg });
+
+    const disconnector = await FS('observeAsync', { type: 'start', callback: () => console.log('STARTED') });
+
+    disconnector.disconnect();
+
+    const url = await FS('getSessionAsync');
+
+    console.log(url.trim());
+  });
 });

package/src/index.ts

@@ -15,6 +15,7 @@ import { initFS, FSApi } from '@fullstory/snippet';
  */
 export interface SnippetOptions {
   orgId: string;
+  appHost?: string;
   assetMapId?: string;
   cookieDomain?: string;
   debug?: boolean;
@@ -37,6 +38,7 @@ type ReadyCallback = (data: { sessionUrl: string, settings: Readonly<object> })
 
 declare global {
   interface Window {
+    _fs_app_host?: string;
     _fs_asset_map_id?: string;
     _fs_capture_on_startup?: boolean;
     _fs_cookie_domain?: string;
@@ -83,6 +85,10 @@ const _init = (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => {
     window._fs_run_in_iframe = true;
   }
 
+  if (options.appHost) {
+    window._fs_app_host = options.appHost;
+  }
+
   if (options.assetMapId) {
     window._fs_asset_map_id = options.assetMapId;
   }
@@ -127,7 +133,7 @@ const _init = (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => {
     fs('trackEvent', {
       name: 'FullStory Dev Mode',
       properties: {
-        message_str: message,
+        message,
       }
     });
     fs('shutdown');