@atlaskit/tmp-editor-statsig 147.1.0 → 148.1.0

package/dist/cjs/experiments.js

@@ -1,136 +1,19 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.editorExperiment = editorExperiment;
-exports.unstable_editorExperimentParam = unstable_editorExperimentParam;
-var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
-var _featureFlagsAccessed = require("@atlaskit/react-ufo/feature-flags-accessed");
-var _experimentsConfig = require("./experiments-config");
-var _setup = require("./setup");
-/* eslint-disable @atlaskit/editor/no-re-export */
-// Entry file in package.json
-
-/**
- * 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
- * }
- * ```
- *
- * @private
- * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
- *             ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
- *             It also closely aligns with similar utilities in other Atlassian products.
- *             For no exposure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
- */
-function editorExperiment(experimentName, expectedExperimentValue) {
-  var _experimentConfig$pro;
-  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {
-    exposure: false
-  };
-  var experimentConfig = _experimentsConfig.editorExperimentsConfig[experimentName];
-  if (_setup._overrides[experimentName] !== undefined) {
-    // This will be hit in the case of a test setting an override
-    return _setup._overrides[experimentName] === expectedExperimentValue;
-  }
-  if (experimentConfig === undefined) {
-    // Warning! If a product is improperly configured (ie. their editor packages are misaligned)
-    // it can cause the editor to crash here or if the experiment does not exist.
-    // We will definitely crash via any code path later in this function - this just makes the error explicit and clear.
-    throw new Error("Editor experiment configuration is not defined ".concat(experimentName, ". Likely the experiment does not exist or editor package versions are misaligned"));
-  }
-  if (!_setup._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
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  var experimentKey = experimentConfig === null || experimentConfig === void 0 || (_experimentConfig$pro = experimentConfig.productKeys) === null || _experimentConfig$pro === void 0 ? void 0 : _experimentConfig$pro[_setup._product];
-  if (!experimentKey) {
-    var _editorExperimentsCon;
-    // This will be hit in the case of an experiment not being set up for the product
-    return ((_editorExperimentsCon = _experimentsConfig.editorExperimentsConfig[experimentName]) === null || _editorExperimentsCon === void 0 ? void 0 : _editorExperimentsCon.defaultValue) === expectedExperimentValue;
-  }
-
-  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
-  var experimentValue = _featureGateJsClient.default.getExperimentValue(
-  // @ts-ignore
-  experimentKey, experimentConfig.param, experimentConfig.defaultValue, {
-    typeGuard: experimentConfig.typeGuard,
-    fireExperimentExposure: options.exposure
-  });
-  if (
-  // When cleaning this gate up -- `calling where the experiments have the product key set`
-  // in __tests__/experiments should be updated (as it's had the count bumped to include these).
-  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
-  _featureGateJsClient.default.getExperimentValue('cc_editor_experiments_ufo_gate_reporting', 'isEnabled', false)) {
-    (0, _featureFlagsAccessed.addFeatureFlagAccessed)("".concat(experimentName, ":").concat(experimentConfig.param), experimentValue);
+Object.defineProperty(exports, "editorExperiment", {
+  enumerable: true,
+  get: function get() {
+    return _editorExperiment.editorExperiment;
   }
-  return expectedExperimentValue === experimentValue;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-
-/**
- * @warning This currently lacks type safety on the param names and return values
- * and has limited associated test tooling.
- *
- * It also only works for experiments where the key matches the productKey used.
- *
- * The typeguard and default value is also expected to move to the experiment config
- */
-function unstable_editorExperimentParam(experimentName, paramName, options) {
-  var _paramOverrides$exper, _options$exposure;
-  if (((_paramOverrides$exper = _setup._paramOverrides[experimentName]) === null || _paramOverrides$exper === void 0 ? void 0 : _paramOverrides$exper[paramName]) !== undefined) {
-    // This will be hit in the case of a test setting an override
-
-    return _setup._paramOverrides[experimentName][paramName];
+});
+Object.defineProperty(exports, "unstable_editorExperimentParam", {
+  enumerable: true,
+  get: function get() {
+    return _unstableEditorExperimentParam.unstable_editorExperimentParam;
   }
-
-  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
-  var experimentValue = _featureGateJsClient.default.getExperimentValue(experimentName, paramName, options.defaultValue, {
-    typeGuard: options.typeGuard,
-    fireExperimentExposure: (_options$exposure = options.exposure) !== null && _options$exposure !== void 0 ? _options$exposure : false
-  });
-  return experimentValue;
-}
+});
+var _editorExperiment = require("./editor-experiment");
+var _unstableEditorExperimentParam = require("./unstable-editor-experiment-param");

package/dist/cjs/is-boolean.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isBoolean = isBoolean;
+function isBoolean(value) {
+  return typeof value === 'boolean';
+}

package/dist/cjs/one-of.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.oneOf = oneOf;
+var _process, _process2;
+var IS_TESTING_ENV = typeof process !== 'undefined' && (((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.NODE_ENV) === 'test' || ((_process2 = process) === null || _process2 === void 0 || (_process2 = _process2.env) === null || _process2 === void 0 ? void 0 : _process2.JEST_WORKER_ID) !== undefined);
+function oneOf(values) {
+  function typeGuard(value) {
+    return values.includes(value);
+  }
+  /**
+   * This is used by test utils to get the variants when running describe.each
+   */
+  if (IS_TESTING_ENV) {
+    typeGuard.values = values;
+  }
+  return typeGuard;
+}

package/dist/cjs/setup.js

@@ -43,7 +43,6 @@ paramOverrides, options) {
     // values.
     // For production usage -- this is done via the feature flag client which takes the type
     // and performs equivalent logic.
-    // @ts-ignore
     groupOverrides = Object.entries(groupOverrides).reduce(function (acc, _ref) {
       var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
         key = _ref2[0],

package/dist/cjs/type-guards.js

@@ -1,27 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isBoolean = isBoolean;
-exports.oneOf = oneOf;
-var _process, _process2;
-function isBoolean(value) {
-  return typeof value === 'boolean';
-}
-function oneOf(values) {
-  function typeGuard(value) {
-    return values.includes(value);
-  }
-  /**
-   * This is used by test utils to get the variants when running describe.each
-   */
-  if (IS_TESTING_ENV) {
-    typeGuard.values = values;
-  }
-  return typeGuard;
-}
-
-// @ts-ignore
-
-var IS_TESTING_ENV = typeof process !== 'undefined' && (((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.NODE_ENV) === 'test' || ((_process2 = process) === null || _process2 === void 0 || (_process2 = _process2.env) === null || _process2 === void 0 ? void 0 : _process2.JEST_WORKER_ID) !== undefined);
+"use strict";

package/dist/cjs/unstable-editor-experiment-param.js

@@ -0,0 +1,37 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unstable_editorExperimentParam = unstable_editorExperimentParam;
+var _featureGates = _interopRequireDefault(require("@atlaskit/feature-gate-js-client/feature-gates"));
+var _setup = require("./setup");
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+
+/**
+ * @warning This currently lacks type safety on the param names and return values
+ * and has limited associated test tooling.
+ *
+ * It also only works for experiments where the key matches the productKey used.
+ *
+ * The typeguard and default value is also expected to move to the experiment config
+ */
+function unstable_editorExperimentParam(experimentName, paramName, options) {
+  var _paramOverrides$exper, _options$exposure;
+  if (((_paramOverrides$exper = _setup._paramOverrides[experimentName]) === null || _paramOverrides$exper === void 0 ? void 0 : _paramOverrides$exper[paramName]) !== undefined) {
+    // This will be hit in the case of a test setting an override
+
+    return _setup._paramOverrides[experimentName][paramName];
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  var experimentValue = _featureGates.default.getExperimentValue(experimentName, paramName, options.defaultValue, {
+    typeGuard: options.typeGuard,
+    fireExperimentExposure: (_options$exposure = options.exposure) !== null && _options$exposure !== void 0 ? _options$exposure : false
+  });
+  return experimentValue;
+}

package/dist/es2019/create-boolean-experiment.js

@@ -0,0 +1,11 @@
+import { isBoolean } from './is-boolean';
+/**
+ * Helper to create a boolean experiment configuration
+ */
+export function createBooleanExperiment(config) {
+  return {
+    ...config,
+    typeGuard: isBoolean,
+    defaultValue: config.defaultValue
+  };
+}

package/dist/es2019/{experiment-builders.js → create-multivariate-experiment.js}

@@ -1,15 +1,4 @@
-import { isBoolean, oneOf } from './type-guards';
-/**
- * Helper to create a boolean experiment configuration
- */
-export function createBooleanExperiment(config) {
-  return {
-    ...config,
-    typeGuard: isBoolean,
-    defaultValue: config.defaultValue
-  };
-}
-
+import { oneOf } from './one-of';
 /**
  * Helper to create a multivariate experiment configuration
  */

package/dist/es2019/editor-experiment.js

@@ -0,0 +1,100 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
+import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
+import { editorExperimentsConfig } from './experiments-config';
+import { _overrides, _product } from './setup';
+
+/**
+ * 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
+ * }
+ * ```
+ *
+ * @private
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
+ *             ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
+ *             It also closely aligns with similar utilities in other Atlassian products.
+ *             For no exposure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
+ */
+export function editorExperiment(experimentName, expectedExperimentValue, options = {
+  exposure: false
+}) {
+  var _experimentConfig$pro;
+  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 (experimentConfig === undefined) {
+    // Warning! If a product is improperly configured (ie. their editor packages are misaligned)
+    // it can cause the editor to crash here or if the experiment does not exist.
+    // We will definitely crash via any code path later in this function - this just makes the error explicit and clear.
+    throw new Error(`Editor experiment configuration is not defined ${experimentName}. Likely the experiment does not exist or editor package versions are misaligned`);
+  }
+  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
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  const experimentKey = experimentConfig === null || experimentConfig === void 0 ? void 0 : (_experimentConfig$pro = experimentConfig.productKeys) === null || _experimentConfig$pro === void 0 ? void 0 : _experimentConfig$pro[_product];
+  if (!experimentKey) {
+    var _editorExperimentsCon;
+    // This will be hit in the case of an experiment not being set up for the product
+    return ((_editorExperimentsCon = editorExperimentsConfig[experimentName]) === null || _editorExperimentsCon === void 0 ? void 0 : _editorExperimentsCon.defaultValue) === expectedExperimentValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  const experimentValue = FeatureGates.getExperimentValue(experimentKey, experimentConfig.param, experimentConfig.defaultValue, {
+    typeGuard: experimentConfig.typeGuard,
+    fireExperimentExposure: options.exposure
+  });
+  if (
+  // When cleaning this gate up -- `calling where the experiments have the product key set`
+  // in __tests__/experiments should be updated (as it's had the count bumped to include these).
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  FeatureGates.getExperimentValue('cc_editor_experiments_ufo_gate_reporting', 'isEnabled', false)) {
+    addFeatureFlagAccessed(`${experimentName}:${experimentConfig.param}`, experimentValue);
+  }
+  return expectedExperimentValue === experimentValue;
+}

package/dist/es2019/exp-val-equals-internal.js

@@ -25,10 +25,8 @@ const allowsProductKeys = ['cc-maui-experiment', 'cc_maui_create_keyword', 'cc_m
  */
 export function expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, experimentExposure) {
   var _editorExperimentsCon, _editorExperimentsCon2, _editorExperimentsCon3;
-  // @ts-ignore need to loosen the type here to allow for any experiment name
   if (_overrides[experimentName] !== undefined) {
     // This will be hit in the case of a test setting an override
-    // @ts-ignore need to loosen the type here to allow for any experiment name
     return _overrides[experimentName] === experimentExpectedValue;
   }
 

package/dist/es2019/exp-val-no-exposure.js

@@ -0,0 +1,9 @@
+import { expValInternal } from './expVal';
+export function expValNoExposure(experimentName, experimentParam, defaultValue) {
+  return expValInternal({
+    experimentName,
+    experimentParam,
+    defaultValue: defaultValue,
+    fireExperimentExposure: false
+  });
+}

package/dist/es2019/exp-val.js

@@ -0,0 +1,26 @@
+import { expValInternal } from './expVal';
+
+/**
+ * Use to check a any param value for an experiment
+ *
+ * **Note**: this will return the default value when the experiment;
+ * - is not being served to the client (ie. pre start)
+ * - or is not configured in experiments-config
+ *
+ * If you need to check a param value without an exposure check see
+ * {@link import('./exp-val-no-exposure').expValNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expVal('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+export function expVal(experimentName, experimentParam, defaultValue) {
+  return expValInternal({
+    experimentName,
+    experimentParam,
+    defaultValue: defaultValue,
+    fireExperimentExposure: true
+  });
+}

package/dist/es2019/expVal.js

@@ -1,9 +1,11 @@
-import FeatureGates from '@atlaskit/feature-gate-js-client';
-import { fg } from '@atlaskit/platform-feature-flags';
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/* eslint-disable @atlaskit/editor/no-re-export -- deprecated shims re-exporting the split `expVal`/`expValNoExposure` modules for backwards compatibility (VOLTC-139). */
+import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { addFeatureFlagAccessed } from '@atlaskit/react-ufo/feature-flags-accessed';
 import { disallowsProductKeys, editorExperimentsConfig } from './experiments-config';
 import { _overrides, _paramOverrides, _product } from './setup';
-function expValInternal({
+export function expValInternal({
   experimentName,
   experimentParam,
   defaultValue,
@@ -17,8 +19,6 @@ function expValInternal({
     // We will definitely crash via any code path later in this function - this just makes the error explicit and clear.
     throw new Error(`Editor experiment configuration is not defined ${experimentName}. Likely the experiment does not exist or editor package versions are misaligned`);
   }
-
-  // @ts-ignore need to loosen the type here to allow for any experiment name
   if (_overrides[experimentName] !== undefined) {
     // This will be hit in the case of a test setting an override
     // @ts-ignore need to loosen the type here to allow for any experiment name
@@ -64,45 +64,10 @@ function expValInternal({
 }
 
 /**
- * Use to check a any param value for an experiment
- *
- * **Note**: this will return the default value when the experiment;
- * - is not being served to the client (ie. pre start)
- * - or is not configured in experiments-config
- *
- * If you need to check a param value without an exposure check see {@link expValNoExposure}
- *
- * @example
- * ```ts
- * const delay = expVal('experiment-name', 'param-name', defaultValue)
- * await new Promise(res => setTimeout(res, delay)
- * ```
+ * @deprecated Use `import { expVal } from '@atlaskit/tmp-editor-statsig/expVal'` instead.
  */
-export function expVal(experimentName, experimentParam, defaultValue) {
-  return expValInternal({
-    experimentName,
-    experimentParam,
-    defaultValue: defaultValue,
-    fireExperimentExposure: true
-  });
-} /**
-  * Use to check a any param value for an experiment without firing an exposure event
-  *
-  * **Note**: this will return the default value when the experiment;
-  * - is not being served to the client (ie. pre start)
-  * - or is not configured in experiments-config
-  *
-  * @example
-  * ```ts
-  * const delay = expParamEqualsNoExposure('experiment-name', 'param-name', defaultValue)
-  * await new Promise(res => setTimeout(res, delay)
-  * ```
-  */
-export function expValNoExposure(experimentName, experimentParam, defaultValue) {
-  return expValInternal({
-    experimentName,
-    experimentParam,
-    defaultValue: defaultValue,
-    fireExperimentExposure: false
-  });
-}
+export { expVal } from './exp-val';
+/**
+ * @deprecated Use `import { expValNoExposure } from '@atlaskit/tmp-editor-statsig/expVal'` instead.
+ */
+export { expValNoExposure } from './exp-val-no-exposure';

package/dist/es2019/experiments-config.js

@@ -2,7 +2,8 @@
 /* eslint-disable @atlaskit/editor/no-re-export */
 // Entry file in package.json
 
-import { createBooleanExperiment, createMultivariateExperiment } from './experiment-builders';
+import { createBooleanExperiment } from './create-boolean-experiment';
+import { createMultivariateExperiment } from './create-multivariate-experiment';
 // eslint-disable-next-line @typescript-eslint/consistent-type-imports -- Need value import for typeof
 
 // These experiments have a jira-specific key that differs from the experiment name,
@@ -208,14 +209,6 @@ export const editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2026-07-14
-  platform_editor_dom_node_count: createBooleanExperiment({
-    productKeys: {
-      confluence: 'platform_editor_dom_node_count'
-    },
-    param: 'isEnabled',
-    defaultValue: false
-  }),
   // Added 2026-03-26
   cc_editor_fix_insm_inp_buffer: createBooleanExperiment({
     productKeys: {