@atlaskit/tmp-editor-statsig 1.0.0 → 1.2.0

package/CHANGELOG.md

@@ -1 +1,14 @@
-# @atlaskit/editor-statsig-tmp
+# @atlaskit/editor-statsig-tmp
+
+## 1.2.0
+
+### Minor Changes
+
+- [#131878](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/131878)
+  [`705fe39cae267`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/705fe39cae267) -
+  [ED-24597] Update to log `platform_editor_basic_text_transformations` exposure event only for
+  users meet all of 3 checks:
+
+  - Are enrolled to the experiment
+  - Have AI disabled
+  - Make top level text selection

package/dist/cjs/experiments-config.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.editorExperimentsConfig = void 0;
+function isBoolean(value) {
+  return typeof value === 'boolean';
+}
+/**
+ * When adding a new experiment, you need to add it here.
+ * Please follow the pattern established in the examples and any
+ * existing experiments.
+ */
+var editorExperimentsConfig = exports.editorExperimentsConfig = {
+  // Added 2024-08-08
+  'example-boolean': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package_boolean'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    // Note -- you need to set the type to boolean for the default value
+    defaultValue: false
+  },
+  // Added 2024-08-08
+  'example-multivariate': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package_multivariate'
+    },
+    param: 'variant',
+    typeGuard: isBoolean,
+    // Note -- you need to specify the type of the default value as the union of all possible values
+    // This is used to provide type safety on consumption
+    defaultValue: 'one'
+  },
+  // Added 2024-08-08
+  'test-new-experiments-package': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package',
+      jira: 'jira_editor_experiment_test_new_package'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
+  },
+  // Add 2024-08-14
+  'basic-text-transformations': {
+    productKeys: {
+      confluence: 'platform_editor_basic_text_transformations'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
+  }
+};

package/dist/cjs/experiments.js

@@ -0,0 +1,123 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.editorExperiment = editorExperiment;
+exports.setupEditorExperiments = setupEditorExperiments;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
+var _experimentsConfig = require("./experiments-config");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var _overrides = {};
+var _product;
+
+/**
+ * This function is used to set up the editor experiments for testing purposes.
+ * It should be called before running code that depends on editor experiments.
+ *
+ * @example
+ * ```ts
+ * setupEditorExperiments('confluence', {
+ *  'experiment-name': 'value',
+ * });
+ * ```
+ */
+function setupEditorExperiments(product,
+/**
+ * Overrides are used to set the value of an experiment for testing purposes.
+ * This is useful when you want to test a specific value of an experiment.
+ */
+overrides) {
+  if (overrides) {
+    // When setting up overrides, we want to ensure that experiments don't end up with invalid
+    // values.
+    // For production usage -- this is done via the feature flag client which takes the type
+    // and performs equivalent logic.
+    // @ts-ignore
+    overrides = Object.entries(overrides).reduce(function (acc, _ref) {
+      var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+      var config = _experimentsConfig.editorExperimentsConfig[key];
+      acc = _objectSpread(_objectSpread({}, acc), {}, (0, _defineProperty2.default)({}, key, config.typeGuard(value) ? value : config.defaultValue));
+      return acc;
+    }, {});
+    _overrides = overrides;
+  }
+  _product = product;
+}
+
+/**
+ * Check the value of an editor experiment.
+ *
+ * Note: By default this will not fire an [exposure event](https://hello.atlassian.net/wiki/spaces/~732385844/pages/3187295823/Exposure+Events+101).
+ *
+ * You need explicitly call it using the exposure property when you need an exposure event to be fired (all experiments should fire exposure events).
+ *
+ * @example Boolean experiment
+ * ```ts
+ * if (editorExperiment('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ * ```
+ *
+ * @example Multivariate experiment
+ * ```ts
+ * switch (true) {
+ * 	 case editorExperiment('example-multivariate', 'one'):
+ *   	 // Run code for variant one
+ *   break;
+ *   case editorExperiment('example-multivariate', 'two'):
+ *     // Run code for variant two
+ *     break;
+ *   case editorExperiment('example-multivariate', 'three'):
+ *     // Run code for variant three
+ *     break;
+ *   }
+ * }
+ *```
+
+ @example Experiment with exposure event
+ * ```ts
+ * // Inside feature surface where either the control or variant should be shown
+ * if (editorExperiment('example-boolean', true, { exposure: true })) {
+ * 	// Run code for on variant
+ * } else {
+ * 	// Run code for off variant
+ * }
+ * ```
+ */
+function editorExperiment(experimentName, expectedExperimentValue) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {
+    exposure: false
+  };
+  var experimentConfig = _experimentsConfig.editorExperimentsConfig[experimentName];
+  if (_overrides[experimentName] !== undefined) {
+    // This will be hit in the case of a test setting an override
+    return _overrides[experimentName] === expectedExperimentValue;
+  }
+  if (!_product) {
+    // This will be hit in the case of a product not having setup the editor experiment tooling
+    return experimentConfig.defaultValue === expectedExperimentValue;
+  }
+
+  // Typescript is complaining here about accessing the productKeys property
+  var experimentKey = experimentConfig.productKeys[_product];
+  if (!experimentKey) {
+    // This will be hit in the case of an experiment not being set up for the product
+    return _experimentsConfig.editorExperimentsConfig[experimentName].defaultValue === expectedExperimentValue;
+  }
+  var experimentValue = _featureGateJsClient.default.getExperimentValue(
+  // @ts-ignore
+  experimentKey, experimentConfig.param, experimentConfig.defaultValue, {
+    typeGuard: experimentConfig.typeGuard,
+    fireExperimentExposure: options.exposure
+  });
+  return expectedExperimentValue === experimentValue;
+}

package/dist/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/test-runner.js

@@ -0,0 +1,83 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.eeTest = eeTest;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _experiments = require("./experiments");
+var _experimentsConfig = require("./experiments-config");
+// This is loosely based on the `ffTest` util from `@atlassian/feature-flags-test-utils` package.
+
+/**
+ * This is a utility function for testing editor experiments.
+ *
+ * @example Boolean experiment
+ * ```ts
+ * eeTest('example-boolean', {
+ *   true: () => {
+ * 	   expect(editorExperiment('example-boolean', true)).toBe(true);
+ * 		 expect(editorExperiment('example-boolean', false)).toBe(false);
+ *   },
+ *   false: () => {
+ *	   expect(editorExperiment('example-boolean', false)).toBe(true);
+ *     expect(editorExperiment('example-boolean', true)).toBe(false);
+ *   },
+ * })
+ * ```
+ *
+ * @example Multivariate experiment
+ * ```ts
+ * eeTest('example-multivariate', {
+ *   one: () => {
+ * 	   expect(editorExperiment('example-multivariate', 'one')).toBe(true);
+ * 		 expect(editorExperiment('example-multivariate', 'two')).toBe(false);
+ *   },
+ *   two: () => {
+ * 	   expect(editorExperiment('example-multivariate', 'two')).toBe(true);
+ * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *   },
+ *   three: () => {
+ * 	   expect(editorExperiment('example-multivariate', 'three')).toBe(true);
+ * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *   },
+ * })
+ * ```
+ */
+function eeTest(experimentName, cases, otherExperiments) {
+  (0, _experiments.setupEditorExperiments)('test', {});
+  describe("eeTest: ".concat(experimentName), function () {
+    afterEach(function () {
+      (0, _experiments.setupEditorExperiments)('test', otherExperiments !== null && otherExperiments !== void 0 ? otherExperiments : {});
+    });
+    var isBooleanExperiment = typeof _experimentsConfig.editorExperimentsConfig[experimentName].defaultValue === 'boolean';
+    if (isBooleanExperiment && Object.keys(cases).length !== 2) {
+      throw new Error("Expected exactly 2 cases for boolean experiment ".concat(experimentName, ", got ").concat(Object.keys(cases).length));
+    }
+    test.each(Object.keys(cases))("".concat(experimentName, ": %s"), /*#__PURE__*/function () {
+      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(value) {
+        var testCaseKey, convertedValue, testCase;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              testCaseKey = value; // For boolean experiments, we need to convert the 'on' and 'off' cases to boolean `true` and `false` values.
+              convertedValue = isBooleanExperiment ? testCaseKey === 'true' ? true : false : testCaseKey;
+              (0, _experiments.setupEditorExperiments)('test', (0, _defineProperty2.default)({}, experimentName, convertedValue));
+              testCase = cases[testCaseKey]; // @ts-ignore
+              _context.next = 6;
+              return Promise.resolve(testCase());
+            case 6:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }());
+  });
+}

package/dist/es2019/experiments-config.js

@@ -0,0 +1,50 @@
+function isBoolean(value) {
+  return typeof value === 'boolean';
+}
+/**
+ * When adding a new experiment, you need to add it here.
+ * Please follow the pattern established in the examples and any
+ * existing experiments.
+ */
+export const editorExperimentsConfig = {
+  // Added 2024-08-08
+  'example-boolean': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package_boolean'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    // Note -- you need to set the type to boolean for the default value
+    defaultValue: false
+  },
+  // Added 2024-08-08
+  'example-multivariate': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package_multivariate'
+    },
+    param: 'variant',
+    typeGuard: isBoolean,
+    // Note -- you need to specify the type of the default value as the union of all possible values
+    // This is used to provide type safety on consumption
+    defaultValue: 'one'
+  },
+  // Added 2024-08-08
+  'test-new-experiments-package': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package',
+      jira: 'jira_editor_experiment_test_new_package'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
+  },
+  // Add 2024-08-14
+  'basic-text-transformations': {
+    productKeys: {
+      confluence: 'platform_editor_basic_text_transformations'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
+  }
+};

package/dist/es2019/experiments.js

@@ -0,0 +1,110 @@
+import FeatureGates from '@atlaskit/feature-gate-js-client';
+import { editorExperimentsConfig } from './experiments-config';
+let _overrides = {};
+let _product;
+
+/**
+ * This function is used to set up the editor experiments for testing purposes.
+ * It should be called before running code that depends on editor experiments.
+ *
+ * @example
+ * ```ts
+ * setupEditorExperiments('confluence', {
+ *  'experiment-name': 'value',
+ * });
+ * ```
+ */
+export function setupEditorExperiments(product,
+/**
+ * Overrides are used to set the value of an experiment for testing purposes.
+ * This is useful when you want to test a specific value of an experiment.
+ */
+overrides) {
+  if (overrides) {
+    // When setting up overrides, we want to ensure that experiments don't end up with invalid
+    // values.
+    // For production usage -- this is done via the feature flag client which takes the type
+    // and performs equivalent logic.
+    // @ts-ignore
+    overrides = Object.entries(overrides).reduce((acc, [key, value]) => {
+      const config = editorExperimentsConfig[key];
+      acc = {
+        ...acc,
+        [key]: config.typeGuard(value) ? value : config.defaultValue
+      };
+      return acc;
+    }, {});
+    _overrides = overrides;
+  }
+  _product = product;
+}
+
+/**
+ * Check the value of an editor experiment.
+ *
+ * Note: By default this will not fire an [exposure event](https://hello.atlassian.net/wiki/spaces/~732385844/pages/3187295823/Exposure+Events+101).
+ *
+ * You need explicitly call it using the exposure property when you need an exposure event to be fired (all experiments should fire exposure events).
+ *
+ * @example Boolean experiment
+ * ```ts
+ * if (editorExperiment('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ * ```
+ *
+ * @example Multivariate experiment
+ * ```ts
+ * switch (true) {
+ * 	 case editorExperiment('example-multivariate', 'one'):
+ *   	 // Run code for variant one
+ *   break;
+ *   case editorExperiment('example-multivariate', 'two'):
+ *     // Run code for variant two
+ *     break;
+ *   case editorExperiment('example-multivariate', 'three'):
+ *     // Run code for variant three
+ *     break;
+ *   }
+ * }
+ *```
+
+ @example Experiment with exposure event
+ * ```ts
+ * // Inside feature surface where either the control or variant should be shown
+ * if (editorExperiment('example-boolean', true, { exposure: true })) {
+ * 	// Run code for on variant
+ * } else {
+ * 	// Run code for off variant
+ * }
+ * ```
+ */
+export function editorExperiment(experimentName, expectedExperimentValue, options = {
+  exposure: false
+}) {
+  const experimentConfig = editorExperimentsConfig[experimentName];
+  if (_overrides[experimentName] !== undefined) {
+    // This will be hit in the case of a test setting an override
+    return _overrides[experimentName] === expectedExperimentValue;
+  }
+  if (!_product) {
+    // This will be hit in the case of a product not having setup the editor experiment tooling
+    return experimentConfig.defaultValue === expectedExperimentValue;
+  }
+
+  // Typescript is complaining here about accessing the productKeys property
+  const experimentKey = experimentConfig.productKeys[_product];
+  if (!experimentKey) {
+    // This will be hit in the case of an experiment not being set up for the product
+    return editorExperimentsConfig[experimentName].defaultValue === expectedExperimentValue;
+  }
+  const experimentValue = FeatureGates.getExperimentValue(
+  // @ts-ignore
+  experimentKey, experimentConfig.param, experimentConfig.defaultValue, {
+    typeGuard: experimentConfig.typeGuard,
+    fireExperimentExposure: options.exposure
+  });
+  return expectedExperimentValue === experimentValue;
+}

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export {};

package/dist/es2019/test-runner.js

@@ -0,0 +1,65 @@
+// This is loosely based on the `ffTest` util from `@atlassian/feature-flags-test-utils` package.
+
+import { setupEditorExperiments } from './experiments';
+import { editorExperimentsConfig } from './experiments-config';
+
+/**
+ * This is a utility function for testing editor experiments.
+ *
+ * @example Boolean experiment
+ * ```ts
+ * eeTest('example-boolean', {
+ *   true: () => {
+ * 	   expect(editorExperiment('example-boolean', true)).toBe(true);
+ * 		 expect(editorExperiment('example-boolean', false)).toBe(false);
+ *   },
+ *   false: () => {
+ *	   expect(editorExperiment('example-boolean', false)).toBe(true);
+ *     expect(editorExperiment('example-boolean', true)).toBe(false);
+ *   },
+ * })
+ * ```
+ *
+ * @example Multivariate experiment
+ * ```ts
+ * eeTest('example-multivariate', {
+ *   one: () => {
+ * 	   expect(editorExperiment('example-multivariate', 'one')).toBe(true);
+ * 		 expect(editorExperiment('example-multivariate', 'two')).toBe(false);
+ *   },
+ *   two: () => {
+ * 	   expect(editorExperiment('example-multivariate', 'two')).toBe(true);
+ * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *   },
+ *   three: () => {
+ * 	   expect(editorExperiment('example-multivariate', 'three')).toBe(true);
+ * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *   },
+ * })
+ * ```
+ */
+export function eeTest(experimentName, cases, otherExperiments) {
+  setupEditorExperiments('test', {});
+  describe(`eeTest: ${experimentName}`, () => {
+    afterEach(() => {
+      setupEditorExperiments('test', otherExperiments !== null && otherExperiments !== void 0 ? otherExperiments : {});
+    });
+    const isBooleanExperiment = typeof editorExperimentsConfig[experimentName].defaultValue === 'boolean';
+    if (isBooleanExperiment && Object.keys(cases).length !== 2) {
+      throw new Error(`Expected exactly 2 cases for boolean experiment ${experimentName}, got ${Object.keys(cases).length}`);
+    }
+    test.each(Object.keys(cases))(`${experimentName}: %s`, async value => {
+      const testCaseKey = value;
+
+      // For boolean experiments, we need to convert the 'on' and 'off' cases to boolean `true` and `false` values.
+      const convertedValue = isBooleanExperiment ? testCaseKey === 'true' ? true : false : testCaseKey;
+      setupEditorExperiments('test', {
+        [experimentName]: convertedValue
+      });
+      const testCase = cases[testCaseKey];
+
+      // @ts-ignore
+      await Promise.resolve(testCase());
+    });
+  });
+}

package/dist/esm/experiments-config.js

@@ -0,0 +1,50 @@
+function isBoolean(value) {
+  return typeof value === 'boolean';
+}
+/**
+ * When adding a new experiment, you need to add it here.
+ * Please follow the pattern established in the examples and any
+ * existing experiments.
+ */
+export var editorExperimentsConfig = {
+  // Added 2024-08-08
+  'example-boolean': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package_boolean'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    // Note -- you need to set the type to boolean for the default value
+    defaultValue: false
+  },
+  // Added 2024-08-08
+  'example-multivariate': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package_multivariate'
+    },
+    param: 'variant',
+    typeGuard: isBoolean,
+    // Note -- you need to specify the type of the default value as the union of all possible values
+    // This is used to provide type safety on consumption
+    defaultValue: 'one'
+  },
+  // Added 2024-08-08
+  'test-new-experiments-package': {
+    productKeys: {
+      confluence: 'confluence_editor_experiment_test_new_package',
+      jira: 'jira_editor_experiment_test_new_package'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
+  },
+  // Add 2024-08-14
+  'basic-text-transformations': {
+    productKeys: {
+      confluence: 'platform_editor_basic_text_transformations'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
+  }
+};

package/dist/esm/experiments.js

@@ -0,0 +1,115 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import FeatureGates from '@atlaskit/feature-gate-js-client';
+import { editorExperimentsConfig } from './experiments-config';
+var _overrides = {};
+var _product;
+
+/**
+ * This function is used to set up the editor experiments for testing purposes.
+ * It should be called before running code that depends on editor experiments.
+ *
+ * @example
+ * ```ts
+ * setupEditorExperiments('confluence', {
+ *  'experiment-name': 'value',
+ * });
+ * ```
+ */
+export function setupEditorExperiments(product,
+/**
+ * Overrides are used to set the value of an experiment for testing purposes.
+ * This is useful when you want to test a specific value of an experiment.
+ */
+overrides) {
+  if (overrides) {
+    // When setting up overrides, we want to ensure that experiments don't end up with invalid
+    // values.
+    // For production usage -- this is done via the feature flag client which takes the type
+    // and performs equivalent logic.
+    // @ts-ignore
+    overrides = Object.entries(overrides).reduce(function (acc, _ref) {
+      var _ref2 = _slicedToArray(_ref, 2),
+        key = _ref2[0],
+        value = _ref2[1];
+      var config = editorExperimentsConfig[key];
+      acc = _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, config.typeGuard(value) ? value : config.defaultValue));
+      return acc;
+    }, {});
+    _overrides = overrides;
+  }
+  _product = product;
+}
+
+/**
+ * Check the value of an editor experiment.
+ *
+ * Note: By default this will not fire an [exposure event](https://hello.atlassian.net/wiki/spaces/~732385844/pages/3187295823/Exposure+Events+101).
+ *
+ * You need explicitly call it using the exposure property when you need an exposure event to be fired (all experiments should fire exposure events).
+ *
+ * @example Boolean experiment
+ * ```ts
+ * if (editorExperiment('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ * ```
+ *
+ * @example Multivariate experiment
+ * ```ts
+ * switch (true) {
+ * 	 case editorExperiment('example-multivariate', 'one'):
+ *   	 // Run code for variant one
+ *   break;
+ *   case editorExperiment('example-multivariate', 'two'):
+ *     // Run code for variant two
+ *     break;
+ *   case editorExperiment('example-multivariate', 'three'):
+ *     // Run code for variant three
+ *     break;
+ *   }
+ * }
+ *```
+
+ @example Experiment with exposure event
+ * ```ts
+ * // Inside feature surface where either the control or variant should be shown
+ * if (editorExperiment('example-boolean', true, { exposure: true })) {
+ * 	// Run code for on variant
+ * } else {
+ * 	// Run code for off variant
+ * }
+ * ```
+ */
+export function editorExperiment(experimentName, expectedExperimentValue) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {
+    exposure: false
+  };
+  var experimentConfig = editorExperimentsConfig[experimentName];
+  if (_overrides[experimentName] !== undefined) {
+    // This will be hit in the case of a test setting an override
+    return _overrides[experimentName] === expectedExperimentValue;
+  }
+  if (!_product) {
+    // This will be hit in the case of a product not having setup the editor experiment tooling
+    return experimentConfig.defaultValue === expectedExperimentValue;
+  }
+
+  // Typescript is complaining here about accessing the productKeys property
+  var experimentKey = experimentConfig.productKeys[_product];
+  if (!experimentKey) {
+    // This will be hit in the case of an experiment not being set up for the product
+    return editorExperimentsConfig[experimentName].defaultValue === expectedExperimentValue;
+  }
+  var experimentValue = FeatureGates.getExperimentValue(
+  // @ts-ignore
+  experimentKey, experimentConfig.param, experimentConfig.defaultValue, {
+    typeGuard: experimentConfig.typeGuard,
+    fireExperimentExposure: options.exposure
+  });
+  return expectedExperimentValue === experimentValue;
+}

package/dist/esm/index.js

@@ -0,0 +1 @@
+export {};