@atlaskit/insm 0.2.4 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/insm
 
+## 0.3.0
+
+### Minor Changes
+
+- [`707c5a42b5358`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/707c5a42b5358) -
+  [ux] Updates LCM for new Read only mode. Also adds a new static property setter to the insm api.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.2.4
 
 ### Patch Changes

package/README.md

@@ -43,7 +43,22 @@ tracked on the resulting session event.
 
 ### Adding additional information to the session
 
-Additional session information can be added through the `addProperties` api.
+Additional session information can be added through either the `setProperty` or the `addProperties`
+api.
+
+#### setProperty
+
+```ts
+insm.session.setProperty(key: string, value: string | number | boolean): void
+```
+
+This api is an alternative to addProperties for scenarios such as where you have a hot path that
+will repeatedly fire throughout a session.
+
+The last value for a given key will be used, and if there is a matching key from addProperties, the
+addProperties value will be used.
+
+#### addProperties
 
 ```ts
 type ValidProperty = string | number | boolean;

package/dist/cjs/insm-session.js

@@ -31,6 +31,7 @@ var INSMSession = exports.INSMSession = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "pageLoadTime", null);
     (0, _defineProperty2.default)(this, "running", true);
     (0, _defineProperty2.default)(this, "addedProperties", []);
+    (0, _defineProperty2.default)(this, "staticProperties", {});
     (0, _defineProperty2.default)(this, "runningFeatures", new Set());
     this.experienceKey = experienceKey;
     this.experienceProperties = experienceProperties;
@@ -98,6 +99,23 @@ var INSMSession = exports.INSMSession = /*#__PURE__*/function () {
       };
     }
 
+    /**
+     * This api is an alternative to addProperties for scenarios
+     * such as where you have a hot path that will repeatedly fire
+     * throughout a session.
+     * The last value for a given key will be used, and if there is a
+     * matching key from addProperties, the addProperties value will be used.
+     *
+     * ```ts
+     * insm.session.addProperties('custom:lcm', true)
+     * ```
+     */
+  }, {
+    key: "setProperty",
+    value: function setProperty(key, value) {
+      this.staticProperties[key] = value;
+    }
+
     /**
      * This api takes either a static single-level key-value object, or callbacks which return the same and
      * will be evaluated on session end.
@@ -186,7 +204,7 @@ var INSMSession = exports.INSMSession = /*#__PURE__*/function () {
       var operationalEvent = {
         actionSubject: 'insm',
         action: 'measured',
-        attributes: _objectSpread(_objectSpread(_objectSpread({}, evaluatedAddedProperties), {}, {
+        attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, this.staticProperties), evaluatedAddedProperties), {}, {
           'event:population': this.insm.options.population,
           experienceKey: this.experienceKey,
           initial: this.experienceProperties.initial,

package/dist/es2019/insm-session.js

@@ -17,6 +17,7 @@ export class INSMSession {
     _defineProperty(this, "pageLoadTime", null);
     _defineProperty(this, "running", true);
     _defineProperty(this, "addedProperties", []);
+    _defineProperty(this, "staticProperties", {});
     _defineProperty(this, "runningFeatures", new Set());
     this.experienceKey = experienceKey;
     this.experienceProperties = experienceProperties;
@@ -74,6 +75,21 @@ export class INSMSession {
     };
   }
 
+  /**
+   * This api is an alternative to addProperties for scenarios
+   * such as where you have a hot path that will repeatedly fire
+   * throughout a session.
+   * The last value for a given key will be used, and if there is a
+   * matching key from addProperties, the addProperties value will be used.
+   *
+   * ```ts
+   * insm.session.addProperties('custom:lcm', true)
+   * ```
+   */
+  setProperty(key, value) {
+    this.staticProperties[key] = value;
+  }
+
   /**
    * This api takes either a static single-level key-value object, or callbacks which return the same and
    * will be evaluated on session end.
@@ -149,6 +165,7 @@ export class INSMSession {
       action: 'measured',
       attributes: {
         // Added first to ensure these don't overwrite any insm properties
+        ...this.staticProperties,
         ...evaluatedAddedProperties,
         'event:population': this.insm.options.population,
         experienceKey: this.experienceKey,

package/dist/esm/insm-session.js

@@ -25,6 +25,7 @@ export var INSMSession = /*#__PURE__*/function () {
     _defineProperty(this, "pageLoadTime", null);
     _defineProperty(this, "running", true);
     _defineProperty(this, "addedProperties", []);
+    _defineProperty(this, "staticProperties", {});
     _defineProperty(this, "runningFeatures", new Set());
     this.experienceKey = experienceKey;
     this.experienceProperties = experienceProperties;
@@ -92,6 +93,23 @@ export var INSMSession = /*#__PURE__*/function () {
       };
     }
 
+    /**
+     * This api is an alternative to addProperties for scenarios
+     * such as where you have a hot path that will repeatedly fire
+     * throughout a session.
+     * The last value for a given key will be used, and if there is a
+     * matching key from addProperties, the addProperties value will be used.
+     *
+     * ```ts
+     * insm.session.addProperties('custom:lcm', true)
+     * ```
+     */
+  }, {
+    key: "setProperty",
+    value: function setProperty(key, value) {
+      this.staticProperties[key] = value;
+    }
+
     /**
      * This api takes either a static single-level key-value object, or callbacks which return the same and
      * will be evaluated on session end.
@@ -180,7 +198,7 @@ export var INSMSession = /*#__PURE__*/function () {
       var operationalEvent = {
         actionSubject: 'insm',
         action: 'measured',
-        attributes: _objectSpread(_objectSpread(_objectSpread({}, evaluatedAddedProperties), {}, {
+        attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, this.staticProperties), evaluatedAddedProperties), {}, {
           'event:population': this.insm.options.population,
           experienceKey: this.experienceKey,
           initial: this.experienceProperties.initial,

package/dist/types/index.d.ts

@@ -9,5 +9,5 @@ export declare function init(options: INSMOptions): void;
  * **In**teractivity **s**ession **m**onitoring
  */
 export declare const insm: Pick<INSM, 'start' | 'stopEarly' | 'startHeavyTask' | 'endHeavyTask' | 'overrideExperienceKey'> & {
-    session: Pick<INSMSession, 'details' | 'startFeature' | 'endFeature' | 'addProperties'> | undefined;
+    session: Pick<INSMSession, 'details' | 'startFeature' | 'endFeature' | 'addProperties' | 'setProperty'> | undefined;
 };

package/dist/types/insm-session.d.ts

@@ -17,6 +17,7 @@ export declare class INSMSession {
     insm: INSM;
     private running;
     private addedProperties;
+    private staticProperties;
     runningFeatures: Set<string>;
     periodTracking: PeriodTracking;
     longAnimationFrameMeasurer: LongAnimationFrameMeasurer;
@@ -49,6 +50,18 @@ export declare class INSMSession {
          */
         running: boolean;
     };
+    /**
+     * This api is an alternative to addProperties for scenarios
+     * such as where you have a hot path that will repeatedly fire
+     * throughout a session.
+     * The last value for a given key will be used, and if there is a
+     * matching key from addProperties, the addProperties value will be used.
+     *
+     * ```ts
+     * insm.session.addProperties('custom:lcm', true)
+     * ```
+     */
+    setProperty(key: string, value: number | string | boolean): void;
     /**
      * This api takes either a static single-level key-value object, or callbacks which return the same and
      * will be evaluated on session end.

package/dist/types-ts4.5/index.d.ts

@@ -9,5 +9,5 @@ export declare function init(options: INSMOptions): void;
  * **In**teractivity **s**ession **m**onitoring
  */
 export declare const insm: Pick<INSM, 'start' | 'stopEarly' | 'startHeavyTask' | 'endHeavyTask' | 'overrideExperienceKey'> & {
-    session: Pick<INSMSession, 'details' | 'startFeature' | 'endFeature' | 'addProperties'> | undefined;
+    session: Pick<INSMSession, 'details' | 'startFeature' | 'endFeature' | 'addProperties' | 'setProperty'> | undefined;
 };

package/dist/types-ts4.5/insm-session.d.ts

@@ -17,6 +17,7 @@ export declare class INSMSession {
     insm: INSM;
     private running;
     private addedProperties;
+    private staticProperties;
     runningFeatures: Set<string>;
     periodTracking: PeriodTracking;
     longAnimationFrameMeasurer: LongAnimationFrameMeasurer;
@@ -49,6 +50,18 @@ export declare class INSMSession {
          */
         running: boolean;
     };
+    /**
+     * This api is an alternative to addProperties for scenarios
+     * such as where you have a hot path that will repeatedly fire
+     * throughout a session.
+     * The last value for a given key will be used, and if there is a
+     * matching key from addProperties, the addProperties value will be used.
+     *
+     * ```ts
+     * insm.session.addProperties('custom:lcm', true)
+     * ```
+     */
+    setProperty(key: string, value: number | string | boolean): void;
     /**
      * This api takes either a static single-level key-value object, or callbacks which return the same and
      * will be evaluated on session end.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/insm",
-	"version": "0.2.4",
+	"version": "0.3.0",
 	"description": "INSM tooling measures user-perceived interactivity of a page",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 	"dependencies": {
 		"@atlaskit/analytics-listeners": "^9.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^17.0.0",
+		"@atlaskit/tmp-editor-statsig": "^17.5.0",
 		"@babel/runtime": "^7.0.0",
 		"bowser-ultralight": "^1.0.6"
 	},