@fullstory/browser 2.0.6 → 2.0.7

package/dist/index.d.ts

@@ -14,17 +14,14 @@ import { FSApi } from '@fullstory/snippet';
  */
 export interface SnippetOptions {
     orgId: string;
-    appHost?: string;
-    assetMapId?: string;
-    cookieDomain?: string;
+    namespace?: string;
     debug?: boolean;
-    devMode?: boolean;
     host?: string;
-    namespace?: string;
+    script?: string;
+    cookieDomain?: string;
     recordCrossDomainIFrames?: boolean;
     recordOnlyThisIFrame?: boolean;
-    script?: string;
-    startCaptureManually?: boolean;
+    devMode?: boolean;
 }
 /**
  * A callback that will be invoked when FullStory has begun a session.
@@ -38,9 +35,6 @@ 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;
         _fs_debug?: boolean;
         _fs_dev_mode?: boolean;
@@ -55,5 +49,5 @@ declare global {
 }
 export declare const init: (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => void;
 export declare const isInitialized: () => boolean;
-export declare const FullStory: FSApi;
-export {};
+declare const FullStory: FSApi;
+export default FullStory;

package/dist/index.esm.js

@@ -14,8 +14,6 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise */
-
 
 var __assign = function() {
     __assign = Object.assign || function __assign(t) {
@@ -52,15 +50,6 @@ 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;
-    }
-    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;
@@ -80,7 +69,7 @@ var _init = function (inputOptions, readyCallback) {
     initFS(options);
     var fs = getFullStory();
     if (!fs) {
-        console.warn('Failed to initialize FS snippet');
+        console.warn('Trouble with fs');
         return;
     }
     if (readyCallback) {
@@ -91,7 +80,7 @@ var _init = function (inputOptions, readyCallback) {
         fs('trackEvent', {
             name: 'FullStory Dev Mode',
             properties: {
-                message: message,
+                message_str: message,
             }
         });
         fs('shutdown');
@@ -125,7 +114,7 @@ var guard = function (name) { return function () {
         args[_i] = arguments[_i];
     }
     if (window._fs_dev_mode) {
-        var message = "FullStory is in dev mode and is not capturing: ".concat(name, " method not executed");
+        var message = "FullStory is in dev mode and is not recording: ".concat(name, " method not executed");
         console.warn(message);
         return message;
     }
@@ -136,30 +125,27 @@ var guard = function (name) { return function () {
     console.warn("FS.".concat(name, " not ready"));
     return null;
 }; };
-var buildFullStoryShim = function () {
-    var FS = function (operation, options, source) {
-        var fs = ensureSnippetLoaded();
-        if (window._fs_dev_mode) {
-            var message = "FullStory is in dev mode and is not capturing: ".concat(operation, " not executed");
-            console.warn(message);
-            return undefined;
-        }
-        return fs(operation, options, source);
-    };
-    FS.anonymize = guard('anonymize');
-    FS.consent = guard('consent');
-    FS.disableConsole = guard('disableConsole');
-    FS.enableConsole = guard('enableConsole');
-    FS.event = guard('event');
-    FS.getCurrentSessionURL = guard('getCurrentSessionURL');
-    FS.identify = guard('identify');
-    FS.log = guard('log');
-    FS.restart = guard('restart');
-    FS.setUserVars = guard('setUserVars');
-    FS.setVars = guard('setVars');
-    FS.shutdown = guard('shutdown');
-    return FS;
-};
-var FullStory = buildFullStoryShim();
+var FullStory = Object.assign(function (operation, options, source) {
+    var fs = ensureSnippetLoaded();
+    if (window._fs_dev_mode) {
+        var message = 'FullStory is in dev mode and is not recording: method not executed';
+        console.warn(message);
+        return undefined;
+    }
+    return fs(operation, options, source);
+}, {
+    anonymize: guard('anonymize'),
+    consent: guard('consent'),
+    disableConsole: guard('disableConsole'),
+    enableConsole: guard('enableConsole'),
+    event: guard('event'),
+    getCurrentSessionURL: guard('getCurrentSessionURL'),
+    identify: guard('identify'),
+    log: guard('log'),
+    restart: guard('restart'),
+    setUserVars: guard('setUserVars'),
+    setVars: guard('setVars'),
+    shutdown: guard('shutdown'),
+});
 
-export { FullStory, init, isInitialized };
+export { FullStory as default, init, isInitialized };

package/dist/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var snippet = require('@fullstory/snippet');
 
 /******************************************************************************
@@ -16,8 +18,6 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise */
-
 
 var __assign = function() {
     __assign = Object.assign || function __assign(t) {
@@ -54,15 +54,6 @@ 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;
-    }
-    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;
@@ -82,7 +73,7 @@ var _init = function (inputOptions, readyCallback) {
     snippet.initFS(options);
     var fs = getFullStory();
     if (!fs) {
-        console.warn('Failed to initialize FS snippet');
+        console.warn('Trouble with fs');
         return;
     }
     if (readyCallback) {
@@ -93,7 +84,7 @@ var _init = function (inputOptions, readyCallback) {
         fs('trackEvent', {
             name: 'FullStory Dev Mode',
             properties: {
-                message: message,
+                message_str: message,
             }
         });
         fs('shutdown');
@@ -127,7 +118,7 @@ var guard = function (name) { return function () {
         args[_i] = arguments[_i];
     }
     if (window._fs_dev_mode) {
-        var message = "FullStory is in dev mode and is not capturing: ".concat(name, " method not executed");
+        var message = "FullStory is in dev mode and is not recording: ".concat(name, " method not executed");
         console.warn(message);
         return message;
     }
@@ -138,32 +129,29 @@ var guard = function (name) { return function () {
     console.warn("FS.".concat(name, " not ready"));
     return null;
 }; };
-var buildFullStoryShim = function () {
-    var FS = function (operation, options, source) {
-        var fs = ensureSnippetLoaded();
-        if (window._fs_dev_mode) {
-            var message = "FullStory is in dev mode and is not capturing: ".concat(operation, " not executed");
-            console.warn(message);
-            return undefined;
-        }
-        return fs(operation, options, source);
-    };
-    FS.anonymize = guard('anonymize');
-    FS.consent = guard('consent');
-    FS.disableConsole = guard('disableConsole');
-    FS.enableConsole = guard('enableConsole');
-    FS.event = guard('event');
-    FS.getCurrentSessionURL = guard('getCurrentSessionURL');
-    FS.identify = guard('identify');
-    FS.log = guard('log');
-    FS.restart = guard('restart');
-    FS.setUserVars = guard('setUserVars');
-    FS.setVars = guard('setVars');
-    FS.shutdown = guard('shutdown');
-    return FS;
-};
-var FullStory = buildFullStoryShim();
+var FullStory = Object.assign(function (operation, options, source) {
+    var fs = ensureSnippetLoaded();
+    if (window._fs_dev_mode) {
+        var message = 'FullStory is in dev mode and is not recording: method not executed';
+        console.warn(message);
+        return undefined;
+    }
+    return fs(operation, options, source);
+}, {
+    anonymize: guard('anonymize'),
+    consent: guard('consent'),
+    disableConsole: guard('disableConsole'),
+    enableConsole: guard('enableConsole'),
+    event: guard('event'),
+    getCurrentSessionURL: guard('getCurrentSessionURL'),
+    identify: guard('identify'),
+    log: guard('log'),
+    restart: guard('restart'),
+    setUserVars: guard('setUserVars'),
+    setVars: guard('setVars'),
+    shutdown: guard('shutdown'),
+});
 
-exports.FullStory = FullStory;
+exports.default = FullStory;
 exports.init = init;
 exports.isInitialized = isInitialized;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstory/browser",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "The official Fullstory browser SDK",
   "repository": "git://github.com/fullstorydev/fullstory-browser-sdk.git",
   "homepage": "https://github.com/fullstorydev/fullstory-browser-sdk",
@@ -11,8 +11,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "clean": "rimraf dist",
-    "pretest": "tsc --project tsconfig.test.json",
-    "test": "npm run lint && karma start --single-run --browsers ChromeHeadless karma.conf.js",
+    "test": "npm run lint && jest",
     "lint": "eslint src",
     "build": "rollup -c"
   },
@@ -26,7 +25,7 @@
     "sdk"
   ],
   "dependencies": {
-    "@fullstory/snippet": "2.0.5"
+    "@fullstory/snippet": "2.0.6"
   },
   "devDependencies": {
     "@babel/core": "^7.8.7",
@@ -34,26 +33,20 @@
     "@babel/preset-env": "^7.10.4",
     "@babel/register": "^7.8.6",
     "@rollup/plugin-typescript": "^11.1.0",
-    "@types/chai": "^4.3.4",
-    "@types/mocha": "^10.0.1",
+    "@types/jest": "^29.5.0",
     "@types/node": "^18.15.11",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
-    "chai": "^4.1.2",
     "eslint": "^8.6.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-plugin-import": "^2.20.1",
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-react": "^7.28.0",
-    "karma": "^6.4.2",
-    "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-mocha": "^2.0.1",
-    "karma-spec-reporter": "0.0.32",
-    "karma-webpack": "^5.0.0",
-    "mocha": "^9.2.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^30.3.0",
     "rimraf": "^2.7.1",
     "rollup": "^3.21.0",
+    "ts-jest": "^29.1.0",
     "tslib": "^2.5.0",
     "typescript": "^4.2.4",
     "webpack": "^5.76.1"

package/src/index.test.ts

@@ -1,4 +1,3 @@
-import { assert, expect } from 'chai';
 import {
   FullStory as FS,
   init,
@@ -19,23 +18,23 @@ beforeEach(() => {
 
 describe('init', () => {
   it('should throw error if not initialized with an orgId', () => {
-    expect(() => { init({} as SnippetOptions); }).to.throw();
+    expect(() => { init({} as SnippetOptions); }).toThrow();
   });
 
   it('should throw error if API called before init', () => {
     try {
       FS('log', { msg: 'my log' });
-      expect(false).to.be('this should have thrown');
+      throw new Error('this should have thrown');
     } catch (error) {
-      expect((error as Error).message).to.match(/FullStory is not loaded/);
+      expect((error as Error).message).toMatch(/FullStory is not loaded/);
     }
     init({ orgId: testOrg });
-    expect(() => { FS('log', { msg: 'my log' }); }).to.not.throw();
+    expect(() => { FS('log', { msg: 'my log' }); }).not.toThrow();
   });
 
   it('should add _fs_org value to window object', () => {
     init({ orgId: testOrg });
-    expect(window._fs_org).to.equal(testOrg);
+    expect(window._fs_org).toBe(testOrg);
   });
 
   it('should add _fs_run_in_iframe value to window object', () => {
@@ -43,7 +42,7 @@ describe('init', () => {
       orgId: testOrg,
       recordCrossDomainIFrames: true,
     });
-    expect(window._fs_run_in_iframe).to.equal(true);
+    expect(window._fs_run_in_iframe).toBe(true);
   });
 
   it('should add _fs_is_outer_script value to window object', () => {
@@ -51,7 +50,7 @@ describe('init', () => {
       orgId: testOrg,
       recordOnlyThisIFrame: true,
     });
-    expect(window._fs_is_outer_script).to.equal(true);
+    expect(window._fs_is_outer_script).toBe(true);
   });
 
   it('should add _fs_dev_mode value to window when initialized with devMode', () => {
@@ -60,19 +59,19 @@ describe('init', () => {
       devMode: true,
     });
 
-    expect(window._fs_dev_mode).to.equal(true);
+    expect(window._fs_dev_mode).toBe(true);
   });
 
   it('should return whether initialized', () => {
     let isInit = isInitialized();
-    expect(isInit).to.equal(false);
+    expect(isInit).toBe(false);
 
     init({
       orgId: testOrg,
     });
 
     isInit = isInitialized();
-    expect(isInit).to.equal(true);
+    expect(isInit).toBe(true);
   });
 
   it('should load fs-debug.js when debug is set', () => {
@@ -81,7 +80,22 @@ describe('init', () => {
       debug: true,
     });
 
-    expect(window._fs_script).to.match(/fs-debug.js$/);
+    expect(window._fs_script).toMatch(/fs-debug.js$/);
+  });
+
+  it('should pass sessionUid to FS init', () => {
+    const sessionUid = 'session-123';
+
+    init({
+      orgId: testOrg,
+      sessionUid,
+    });
+
+    const queue = (window[window._fs_namespace ?? 'FS'] as unknown as { q?: unknown[][] }).q;
+    const initCall = queue?.find((call) => call[0] === 'init');
+    const initOptions = initCall?.[1] as { env?: { sessionUid?: string } } | undefined;
+
+    expect(initOptions?.env?.sessionUid).toBe(sessionUid);
   });
 });
 
@@ -98,17 +112,17 @@ describe('devMode', () => {
   });
 
   it('should return a message for functions invoked when in devMode', () => {
-    expect(consoleWarnedMessage).to.equal(undefined);
+    expect(consoleWarnedMessage).toBeUndefined();
     init({
       orgId: testOrg,
       devMode: true,
     });
 
-    expect(consoleWarnedMessage).to.match(/FullStory was initialized in devMode/);
+    expect(consoleWarnedMessage).toMatch(/FullStory was initialized in devMode/);
 
     FS('log', { msg: 'hello world' });
 
-    expect(consoleWarnedMessage).to.equal('FullStory is in dev mode and is not capturing: log not executed');
+    expect(consoleWarnedMessage).toBe('FullStory is in dev mode and is not capturing: log not executed');
   });
 });
 
@@ -118,11 +132,7 @@ describe('getCurrentSessionURL', () => {
     // in theory, this is a race condition - assuming that fs.js
     // can't load by the time the following statement is executed
     const url = FS('getSession');
-    assert.equal(
-      url,
-      null,
-      'FullStory.getCurrentSessionURL() should return null if executed before fs.js is fully bootstrapped'
-    );
+    expect(url).toBeNull();
   });
 });
 
@@ -177,7 +187,7 @@ describe('typescript safety', () => {
     FS.event(42, { product_id: 'asdf' });
 
     // Assertion for posterity's sake...
-    expect(true).to.equal(true);
+    expect(true).toBe(true);
   });
 
   it('allows the optional "source" param', () => {
@@ -212,7 +222,7 @@ describe('typescript safety', () => {
   });
 
   // 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 () => {
+  it.skip('provides type assistance for the async api', async () => {
     init({ orgId: testOrg });
 
     const disconnector = await FS('observeAsync', { type: 'start', callback: () => console.log('STARTED') });
@@ -220,7 +230,6 @@ describe('typescript safety', () => {
     disconnector.disconnect();
 
     const url = await FS('getSessionAsync');
-
-    console.log(url.trim());
+    expect(url === null || typeof url === 'string' || typeof url === 'object').toBe(true); // type-check only
   });
 });

package/src/index.ts

@@ -12,6 +12,7 @@ import { initFS, FSApi } from '@fullstory/snippet';
  * - 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`.
+ * - sessionUid (beta): Sets the session UID passed to the `FS('init', ...)` v2 operation.
  */
 export interface SnippetOptions {
   orgId: string;
@@ -24,6 +25,7 @@ export interface SnippetOptions {
   namespace?: string;
   recordCrossDomainIFrames?: boolean;
   recordOnlyThisIFrame?: boolean;
+  sessionUid?: string;
   script?: string;
   startCaptureManually?: boolean;
 }
@@ -124,6 +126,10 @@ const _init = (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => {
     return;
   }
 
+  if (options.sessionUid) {
+    fs('init', { env: { sessionUid: options.sessionUid } });
+  }
+
   if (readyCallback) {
     fs('observe', { type: 'start', callback: readyCallback });
   }
@@ -201,7 +207,7 @@ const buildFullStoryShim = (): FSApi => {
   FS.setVars = guard('setVars');
   FS.shutdown = guard('shutdown');
 
-  return FS;
+  return FS as FSApi;
 };
 
 export const FullStory: FSApi = buildFullStoryShim();