@atlaskit/tmp-editor-statsig 148.0.0 → 149.0.0

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @atlaskit/editor-statsig-tmp
 
+## 149.0.0
+
+### Major Changes
+
+- [`76e9f6152bf16`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/76e9f6152bf16) -
+  Enable launched synced block integrations and remove obsolete experiment scaffolding.
+
+  BREAKING: `@atlaskit/tmp-editor-statsig` no longer defines the `platform_synced_block` editor
+  experiment. Consumers that use `editorExperiment('platform_synced_block', ...)` to conditionally
+  enable synced-block integrations will no longer be able to look up that experiment; synced-block
+  integrations are now enabled by default. Remove each lookup and its conditional branch:
+
+  ```ts
+  // Before
+  if (editorExperiment('platform_synced_block', true)) {
+  	enableSyncedBlocks();
+  }
+
+  // After
+  enableSyncedBlocks();
+  ```
+
+## 148.1.0
+
+### Minor Changes
+
+- [`72434f514923a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/72434f514923a) -
+  Split multi-export modules into one export per file to meet the Volt package standard. The
+  `exports` map is unchanged — all 10 public subpaths keep their existing targets — and every symbol
+  that moved is still re-exported from the subpath that previously exposed it, now marked
+  `@deprecated`:
+  - `@atlaskit/tmp-editor-statsig/expVal` — `expVal` and `expValNoExposure` now live in
+    `src/exp-val.ts` and `src/exp-val-no-exposure.ts`.
+  - `@atlaskit/tmp-editor-statsig/experiments` — `editorExperiment` and
+    `unstable_editorExperimentParam` now live in `src/editor-experiment.ts` and
+    `src/unstable-editor-experiment-param.ts`.
+
+  `expValInternal` is now exported from `@atlaskit/tmp-editor-statsig/expVal`. It was previously a
+  module-private helper and is only public so the split `expVal`/`expValNoExposure` modules can
+  share it — it is not intended for consumer use and will be removed once the deprecated shims go
+  (VOLTC-139).
+
+  Internal-only modules were also split out (`create-boolean-experiment`,
+  `create-multivariate-experiment`, `is-boolean`, `one-of`), and barrel imports of
+  `@atlaskit/feature-gate-js-client` and `@atlaskit/platform-feature-flags` were replaced with their
+  subpath equivalents. No behaviour change.
+
 ## 148.0.0
 
 ### Major Changes

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

@@ -0,0 +1,20 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createBooleanExperiment = createBooleanExperiment;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _isBoolean = require("./is-boolean");
+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; }
+/**
+ * Helper to create a boolean experiment configuration
+ */
+function createBooleanExperiment(config) {
+  return _objectSpread(_objectSpread({}, config), {}, {
+    typeGuard: _isBoolean.isBoolean,
+    defaultValue: config.defaultValue
+  });
+}

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

@@ -4,23 +4,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createBooleanExperiment = createBooleanExperiment;
 exports.createMultivariateExperiment = createMultivariateExperiment;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _typeGuards = require("./type-guards");
+var _oneOf = require("./one-of");
 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; }
-/**
- * Helper to create a boolean experiment configuration
- */
-function createBooleanExperiment(config) {
-  return _objectSpread(_objectSpread({}, config), {}, {
-    typeGuard: _typeGuards.isBoolean,
-    defaultValue: config.defaultValue
-  });
-}
-
 /**
  * Helper to create a multivariate experiment configuration
  */
@@ -29,7 +18,7 @@ function createMultivariateExperiment(config) {
   return _objectSpread(_objectSpread({}, config), {}, {
     values: (0, _toConsumableArray2.default)(values),
     // Maintains the tuple
-    typeGuard: (0, _typeGuards.oneOf)(config.values),
+    typeGuard: (0, _oneOf.oneOf)(config.values),
     defaultValue: config.defaultValue
   });
 }

package/dist/cjs/editor-experiment.js

@@ -0,0 +1,107 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.editorExperiment = editorExperiment;
+var _featureGates = _interopRequireDefault(require("@atlaskit/feature-gate-js-client/feature-gates"));
+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 = _featureGates.default.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.default.getExperimentValue('cc_editor_experiments_ufo_gate_reporting', 'isEnabled', false)) {
+    (0, _featureFlagsAccessed.addFeatureFlagAccessed)("".concat(experimentName, ":").concat(experimentConfig.param), experimentValue);
+  }
+  return expectedExperimentValue === experimentValue;
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.expValNoExposure = expValNoExposure;
+var _expVal = require("./expVal");
+function expValNoExposure(experimentName, experimentParam, defaultValue) {
+  return (0, _expVal.expValInternal)({
+    experimentName: experimentName,
+    experimentParam: experimentParam,
+    defaultValue: defaultValue,
+    fireExperimentExposure: false
+  });
+}

package/dist/cjs/exp-val.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.expVal = expVal;
+var _expVal = require("./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)
+ * ```
+ */
+function expVal(experimentName, experimentParam, defaultValue) {
+  return (0, _expVal.expValInternal)({
+    experimentName: experimentName,
+    experimentParam: experimentParam,
+    defaultValue: defaultValue,
+    fireExperimentExposure: true
+  });
+}

package/dist/cjs/expVal.js

@@ -4,13 +4,29 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.expVal = expVal;
-exports.expValNoExposure = expValNoExposure;
-var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
-var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+Object.defineProperty(exports, "expVal", {
+  enumerable: true,
+  get: function get() {
+    return _expVal.expVal;
+  }
+});
+exports.expValInternal = expValInternal;
+Object.defineProperty(exports, "expValNoExposure", {
+  enumerable: true,
+  get: function get() {
+    return _expValNoExposure.expValNoExposure;
+  }
+});
+var _featureGates = _interopRequireDefault(require("@atlaskit/feature-gate-js-client/feature-gates"));
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _featureFlagsAccessed = require("@atlaskit/react-ufo/feature-flags-accessed");
 var _experimentsConfig = require("./experiments-config");
 var _setup = require("./setup");
+var _expVal = require("./exp-val");
+var _expValNoExposure = require("./exp-val-no-exposure");
+/* 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). */
+
 function expValInternal(_ref) {
   var _paramOverrides2, _experimentConfig$pro;
   var experimentName = _ref.experimentName,
@@ -37,7 +53,7 @@ function expValInternal(_ref) {
   }
 
   // If client is not initialized, we return the default value
-  if (!_featureGateJsClient.default.initializeCompleted()) {
+  if (!_featureGates.default.initializeCompleted()) {
     return defaultValue;
   }
   if (!_setup._product) {
@@ -53,15 +69,15 @@ function expValInternal(_ref) {
     // This will be hit in the case of an experiment not being set up for the product
     return defaultValue;
   }
-  var resolvedExperimentKey = !_experimentsConfig.disallowsProductKeys.includes(experimentName) && (0, _platformFeatureFlags.fg)('platform_editor_experiments_use_product_keys') ? experimentKey : experimentName;
+  var resolvedExperimentKey = !_experimentsConfig.disallowsProductKeys.includes(experimentName) && (0, _fg.fg)('platform_editor_experiments_use_product_keys') ? experimentKey : experimentName;
 
   // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
-  var experimentValue = _featureGateJsClient.default.getExperimentValue(resolvedExperimentKey, experimentParam, defaultValue, {
+  var experimentValue = _featureGates.default.getExperimentValue(resolvedExperimentKey, experimentParam, defaultValue, {
     fireExperimentExposure: fireExperimentExposure
   });
   if (
   // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
-  _featureGateJsClient.default.getExperimentValue('cc_editor_experiments_ufo_gate_reporting_expval', 'isEnabled', false)) {
+  _featureGates.default.getExperimentValue('cc_editor_experiments_ufo_gate_reporting_expval', 'isEnabled', false)) {
     // Duplicated from /confluence/next/packages/feature-experiments/src/index.ts
     (0, _featureFlagsAccessed.addFeatureFlagAccessed)("".concat(resolvedExperimentKey, ":").concat(experimentParam), experimentValue);
   }
@@ -69,45 +85,9 @@ function expValInternal(_ref) {
 }
 
 /**
- * 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.
  */
-function expVal(experimentName, experimentParam, defaultValue) {
-  return expValInternal({
-    experimentName: experimentName,
-    experimentParam: 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)
-  * ```
-  */
-function expValNoExposure(experimentName, experimentParam, defaultValue) {
-  return expValInternal({
-    experimentName: experimentName,
-    experimentParam: experimentParam,
-    defaultValue: defaultValue,
-    fireExperimentExposure: false
-  });
-}
+
+/**
+ * @deprecated Use `import { expValNoExposure } from '@atlaskit/tmp-editor-statsig/expVal'` instead.
+ */