@fullstory/browser 1.4.10 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.5.0
+
+- Adding the `setVars` API function
+
 ## 1.4.10
 
 - Adding docs to the types file (index.d.ts)

package/README.md

@@ -123,3 +123,16 @@ FullStory.event('Subscribed', {
 const startOfPlayback = FullStory.getCurrentSessionURL();
 const playbackAtThisMomentInTime = FullStory.getCurrentSessionURL(true);
 ```
+
+### Sending custom page data
+```JavaScript
+FullStory.setVars('page', {
+ pageName : 'Checkout', // what is the name of the page?
+ cart_size_int : 10, // how many items were in the cart?
+ used_coupon_bool : true, // was a coupon used?
+});
+```
+For more information on setting page vars, view the FullStory help article on [Sending custom page data to FullStory](https://help.fullstory.com/hc/en-us/articles/1500004101581-FS-setVars-API-Sending-custom-page-data-to-FullStory).
+
+#### Note
+`FullStory.setVars(<scope>, <payload>)` currently only supports a string value of "page" for the scope. Using arbitrary strings for the scope parameter will result in an Error that will be logged to the browser console or discarded, depending on whether devMode or debug is enabled.

package/dist/index.d.ts

@@ -29,6 +29,8 @@ interface UserVars {
 
 type LogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
 
+type VarScope = 'page';
+
 // API functions that are available as soon as the snippet has executed.
 export function anonymize(): void;
 export function consent(userConsents?: boolean): void;
@@ -40,6 +42,7 @@ 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

package/dist/index.esm.js

@@ -155,6 +155,7 @@ var consent = guard('consent');
 var shutdown = guard('shutdown');
 var restart = guard('restart');
 var anonymize = guard('anonymize');
+var setVars = guard('setVars');
 
 var _init = function _init(options) {
   if (fs()) {
@@ -197,4 +198,4 @@ var initOnce = function initOnce(fn, message) {
 
 var init = initOnce(_init, 'FullStory init has already been called once, additional invocations are ignored');
 
-export { anonymize, consent, event, getCurrentSessionURL, identify, init, log, restart, setUserVars, shutdown };
+export { anonymize, consent, event, getCurrentSessionURL, identify, init, log, restart, setUserVars, setVars, shutdown };

package/dist/index.js

@@ -159,6 +159,7 @@ var consent = guard('consent');
 var shutdown = guard('shutdown');
 var restart = guard('restart');
 var anonymize = guard('anonymize');
+var setVars = guard('setVars');
 
 var _init = function _init(options) {
   if (fs()) {
@@ -210,4 +211,5 @@ exports.init = init;
 exports.log = log;
 exports.restart = restart;
 exports.setUserVars = setUserVars;
+exports.setVars = setVars;
 exports.shutdown = shutdown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstory/browser",
-  "version": "1.4.10",
+  "version": "1.5.0",
   "description": "The official FullStory browser SDK",
   "repository": "git://github.com/fullstorydev/fullstory-browser-sdk.git",
   "homepage": "https://github.com/fullstorydev/fullstory-browser-sdk",
@@ -43,7 +43,7 @@
     "karma-mocha": "^2.0.1",
     "karma-spec-reporter": "0.0.32",
     "karma-webpack": "^5.0.0",
-    "mocha": "^9.0.0",
+    "mocha": "^9.2.0",
     "rimraf": "^2.7.1",
     "rollup": "^1.32.1",
     "rollup-plugin-copy": "^3.3.0",

package/src/index.d.ts

@@ -29,6 +29,8 @@ interface UserVars {
 
 type LogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
 
+type VarScope = 'page';
+
 // API functions that are available as soon as the snippet has executed.
 export function anonymize(): void;
 export function consent(userConsents?: boolean): void;
@@ -40,6 +42,7 @@ 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

package/src/index.js

@@ -37,6 +37,7 @@ 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 = (options) => {
   if (fs()) {