npm - @fullstory/browser - Versions diffs - 1.7.1 → 2.0.0-beta.3 - Mend

@fullstory/browser 1.7.1 → 2.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/src/index.ts ADDED Viewed

@@ -0,0 +1,201 @@
+import { initFS, FSApi } from '@fullstory/snippet';
+/**
+ * FullStory Client SDK snippet options.
+ *
+ * - orgId: Reference for your [Org Id](https://help.fullstory.com/hc/en-us/articles/360047075853) listed in FullStory.
+ * - namespace: Global object name that contains the FullStory browser API methods and properties. Defaults to `FS`.
+ * - 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`.
+ */
+export interface SnippetOptions {
+  orgId: string;
+  assetMapId?: string;
+  cookieDomain?: string;
+  debug?: boolean;
+  devMode?: boolean;
+  host?: string;
+  namespace?: string;
+  recordCrossDomainIFrames?: boolean;
+  recordOnlyThisIFrame?: boolean;
+  script?: string;
+  startCaptureManually?: boolean;
+}
+/**
+ * A callback that will be invoked when FullStory has begun a session.
+ *
+ * `sessionUrl` contains the URL to the current session.
+ * `settings`   contains the org settings for the current session.
+ */
+type ReadyCallback = (data: { sessionUrl: string, settings: Readonly<object> }) => 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;
+    _fs_host?: string;
+    _fs_initialized?: boolean;
+    _fs_is_outer_script?: boolean;
+    _fs_namespace?: string;
+    _fs_org?: string;
+    _fs_run_in_iframe?: boolean;
+    _fs_script?: string;
+  }
+}
+const getFullStory = (): FSApi | undefined => {
+  if (window._fs_namespace) {
+    return window[window._fs_namespace];
+  }
+  return undefined;
+};
+const ensureSnippetLoaded = (): FSApi => {
+  const fs = getFullStory();
+  if (!fs) {
+    throw Error(
+      'FullStory is not loaded, please ensure the init function is invoked before calling FullStory API functions'
+    );
+  }
+  return fs;
+};
+const _init = (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => {
+  // Make a copy so we can modify `options` if desired.
+  const options = { ...inputOptions };
+  if (getFullStory()) {
+    console.warn('The FullStory snippet has already been defined elsewhere (likely in the <head> element)');
+    return;
+  }
+  // see README for details on the recordCrossDomainIFrames option
+  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;
+  }
+  // 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');
+    }
+  }
+  initFS(options);
+  const fs = getFullStory();
+  if (!fs) {
+    console.warn('Failed to initialize FS snippet');
+    return;
+  }
+  if (readyCallback) {
+    fs('observe', { type: 'start', callback: readyCallback });
+  }
+  if (options.devMode === true) {
+    const message = 'FullStory was initialized in devMode and will stop recording';
+    fs('trackEvent', {
+      name: 'FullStory Dev Mode',
+      properties: {
+        message_str: message,
+      }
+    });
+    fs('shutdown');
+    window._fs_dev_mode = true;
+    console.warn(message);
+  }
+};
+const initOnce = (message) => (inputOptions: SnippetOptions, readyCallback?: ReadyCallback) => {
+  if (window._fs_initialized) {
+    if (message) console.warn(message);
+    return;
+  }
+  _init(inputOptions, readyCallback);
+  window._fs_initialized = true;
+};
+export const init = initOnce('FullStory init has already been called once, additional invocations are ignored');
+// normalize undefined into boolean
+export const isInitialized = () => !!window._fs_initialized;
+const hasFullStoryWithFunction = (...testNames) => {
+  const fs = ensureSnippetLoaded();
+  return testNames.every((current) => fs[current]);
+};
+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);
+    return message;
+  }
+  const fs = getFullStory();
+  if (hasFullStoryWithFunction(name) && fs) {
+    return fs[name](...args);
+  }
+  console.warn(`FS.${name} not ready`);
+  return null;
+};
+const buildFullStoryShim = (): FSApi => {
+  const FS = (operation, options, source) => {
+    const fs = ensureSnippetLoaded();
+    if (window._fs_dev_mode) {
+      const message = 'FullStory is in dev mode and is not recording: method 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;
+};
+export const FullStory: FSApi = buildFullStoryShim();

package/CHANGELOG.md DELETED Viewed

@@ -1,107 +0,0 @@
-# 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](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)
-- Add a RELEASING doc (#143)
-## 1.6.0
-- Add a `readyCallback` parameter to the `init` function (#140)
-- Add an `isInitialized` API (#130)
-- Automated dependency updates
-## 1.5.1
-- Updating README to include `host` and `script` configuration options
-## 1.5.0
-- Adding the `setVars` API function
-## 1.4.10
-- Adding docs to the types file (index.d.ts)
-## 1.4.8
-- Updating README to better describe the behavior of the `recordCrossDomainIFrames` option
-## 1.4.7
--  Updating README to include vue 3
-- `npm audit fix` to clean up npm audit warnings
-## 1.4.6
-- Updating snippet.js to include the latest snippet version
-## 1.4.5
-- `npm audit fix` to clean up npm audit warnings
-## 1.4.4
-- Adding a Vue.js initialization example to the readme
-## 1.4.3
-- Updating README to include a link to instructions on how to find the FullStory Org Id
-## 1.4.2
-- Nothing to see here - bumping the version to fix a faulty CircleCI build
-## 1.4.1
-- Updated Angular sample to demo `devMode` configuration option
-## 1.4.0
-- Adding `devMode` configuration option
-## 1.3.1
-- Reformatting init() options doc in the README
-## 1.3.0
-* Added init() options that control IFrame recording
-* Updated README to include option descriptions and usage
-* Updated README with Angular example
-## 1.2.3
-* Incorporate FS.anonymize method now included in the core snippet
-* Update minimist version for package dev package dependancies to fix npm audit alert
-## 1.2.2
-Update npm package dependancies on the acorn package to get a clean npm audit
-## 1.2.1
-Automatic snippet update from FullStory
-## 1.2.0
-Supporting CommonJS builds
-## 1.1.0
-Snippet updates for improving XHR and Fetch API recording fidelity
-## 1.0.0
-Initial Release

package/src/index.d.ts DELETED Viewed

@@ -1,65 +0,0 @@
-/**
- * FullStory Client SDK snippet options.
- *
- * - orgId: Reference for your [Org Id](https://help.fullstory.com/hc/en-us/articles/360047075853) listed in FullStory.
- * - namespace: Global object name that contains the FullStory browser API methods and properties. Defaults to `FS`.
- * - 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`.
- */
-interface SnippetOptions {
-  orgId: string;
-  namespace?: string;
-  debug?: boolean;
-  host?: string;
-  script?: string;
-  cookieDomain?: string;
-  recordCrossDomainIFrames?: boolean;
-  recordOnlyThisIFrame?: boolean;
-  devMode?: boolean;
-}
-interface UserVars {
-  displayName?: string;
-  email?: string;
-  [key: string]: any;
-}
-type LogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
-type VarScope = 'page';
-/**
- * A callback that will be invoked when FullStory has begun a session.
- *
- * `sessionUrl` contains the URL to the current session.
- */
-type ReadyCallback = (data: { sessionUrl: string }) => void;
-// API functions that are available as soon as the snippet has executed.
-export function anonymize(): void;
-export function consent(userConsents?: boolean): void;
-export function event(eventName: string, eventProperties: { [key: string]: any }): void;
-export function identify(uid: string, customVars?: UserVars): void;
-/**
- * Initialize FullStory.
- *
- * @param options Options to pass to the snippet.
- * @param readyCallback If provided, a callback that will be invoked when the FullStory session has begun.
- */
-export function init(options: SnippetOptions, readyCallback?: ReadyCallback): void;
-export function isInitialized(): boolean;
-export function log(level: LogLevel, msg: string): void;
-export function log(msg: string): void;
-export function restart(): void;
-export function setUserVars(customVars: UserVars): void;
-export function shutdown(): void;
-export function setVars(varScope: VarScope, properties?: { [key: string]: any }): void;
-// API functions that are available after /rec/page returns.
-// FullStory bootstrapping details: https://help.fullstory.com/hc/en-us/articles/360032975773
-export function getCurrentSessionURL(now?: boolean): string | null;

package/src/index.js DELETED Viewed

@@ -1,102 +0,0 @@
-import { initFS } from '@fullstory/snippet';
-const fs = () => window[window._fs_namespace];
-const ensureSnippetLoaded = () => {
-  const snippetLoaded = !!fs();
-  if (!snippetLoaded) {
-    throw Error('FullStory is not loaded, please ensure the init function is invoked before calling FullStory API functions');
-  }
-};
-const hasFullStoryWithFunction = (...testNames) => {
-  ensureSnippetLoaded();
-  return testNames.every((current) => fs()[current]);
-};
-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);
-    return message;
-  }
-  if (hasFullStoryWithFunction(name)) {
-    return fs()[name](...args);
-  }
-  console.warn(`FS.${name} not ready`);
-  return null;
-};
-export const event = guard('event');
-export const log = guard('log');
-export const getCurrentSessionURL = guard('getCurrentSessionURL');
-export const identify = guard('identify');
-export const setUserVars = guard('setUserVars');
-export const consent = guard('consent');
-export const shutdown = guard('shutdown');
-export const restart = guard('restart');
-export const anonymize = guard('anonymize');
-export const setVars = guard('setVars');
-const _init = (inputOptions, readyCallback) => {
-  // Make a copy so we can modify `options` if desired.
-  const options = { ...inputOptions };
-  if (fs()) {
-    console.warn('The FullStory snippet has already been defined elsewhere (likely in the <head> element)');
-    return;
-  }
-  // see README for details on the recordCrossDomainIFrames option
-  if (options.recordCrossDomainIFrames) {
-    window._fs_run_in_iframe = true;
-  }
-  // record the contents of this iFrame when embedded in a parent site
-  if (options.recordOnlyThisIFrame) {
-    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');
-    }
-  }
-  initFS(options);
-  if (readyCallback) {
-    fs()('observe', { type: 'start', callback: readyCallback });
-  }
-  if (options.devMode === true) {
-    const message = 'FullStory was initialized in devMode and will stop recording';
-    event('FullStory Dev Mode', {
-      message_str: message,
-    });
-    shutdown();
-    window._fs_dev_mode = true;
-    console.warn(message);
-  }
-};
-const initOnce = (fn, message) => (...args) => {
-  if (window._fs_initialized) {
-    if (message) console.warn(message);
-    return;
-  }
-  fn(...args);
-  window._fs_initialized = true;
-};
-export const init = initOnce(_init, 'FullStory init has already been called once, additional invocations are ignored');
-// normalize undefined into boolean
-export const isInitialized = () => !!window._fs_initialized;