@atlaskit/tmp-editor-statsig 9.27.0 → 9.28.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-statsig-tmp
 
+## 9.28.0
+
+### Minor Changes
+
+- [#200948](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/200948)
+  [`8dd9a944113d5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8dd9a944113d5) -
+  Introduced throttling for portals
+
 ## 9.27.0
 
 ### Minor Changes

package/dist/cjs/expVal.js

@@ -0,0 +1,90 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.expVal = expVal;
+exports.expValNoExposure = expValNoExposure;
+var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
+var _experimentsConfig = require("./experiments-config");
+var _setup = require("./setup");
+function expValInternal(_ref) {
+  var _experimentConfig$pro;
+  var experimentName = _ref.experimentName,
+    experimentParam = _ref.experimentParam,
+    defaultValue = _ref.defaultValue,
+    fireExperimentExposure = _ref.fireExperimentExposure;
+  var experimentConfig = _experimentsConfig.editorExperimentsConfig[experimentName];
+  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 defaultValue;
+  }
+
+  // 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) {
+    // This will be hit in the case of an experiment not being set up for the product
+    return defaultValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  var experimentValue = _featureGateJsClient.default.getExperimentValue(experimentName, experimentParam, defaultValue, {
+    fireExperimentExposure: fireExperimentExposure
+  });
+  return experimentValue;
+}
+
+/**
+ * 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 expParamEqualsNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+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
+  });
+}

package/dist/cjs/experiments-config.js

@@ -359,6 +359,14 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
+  // Added 2025-07-14
+  platform_editor_debounce_portal_provider: (0, _experimentBuilders.createBooleanExperiment)({
+    productKeys: {
+      confluence: 'platform_editor_debounce_portal_provider'
+    },
+    param: 'isEnabled',
+    defaultValue: false
+  }),
   // Added 2025-07-08 - Jira work sync description comment summary
   'jira-work-sync-desc-comment-summary': (0, _experimentBuilders.createBooleanExperiment)({
     productKeys: {
@@ -652,6 +660,14 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
+  // Added 2025-08-06
+  cc_editor_limited_mode: (0, _experimentBuilders.createBooleanExperiment)({
+    productKeys: {
+      confluence: 'cc_editor_limited_mode'
+    },
+    param: 'isEnabled',
+    defaultValue: false
+  }),
   // Added 2025-08-05
   platform_editor_tables_scaling_css: (0, _experimentBuilders.createBooleanExperiment)({
     productKeys: {

package/dist/es2019/expVal.js

@@ -0,0 +1,83 @@
+import FeatureGates from '@atlaskit/feature-gate-js-client';
+import { editorExperimentsConfig } from './experiments-config';
+import { _product } from './setup';
+function expValInternal({
+  experimentName,
+  experimentParam,
+  defaultValue,
+  fireExperimentExposure
+}) {
+  var _experimentConfig$pro;
+  const experimentConfig = editorExperimentsConfig[experimentName];
+  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 defaultValue;
+  }
+
+  // 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) {
+    // This will be hit in the case of an experiment not being set up for the product
+    return defaultValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  const experimentValue = FeatureGates.getExperimentValue(experimentName, experimentParam, defaultValue, {
+    fireExperimentExposure: fireExperimentExposure
+  });
+  return experimentValue;
+}
+
+/**
+ * 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 expParamEqualsNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+export function expVal(experimentName, experimentParam, defaultValue) {
+  return expValInternal({
+    experimentName,
+    experimentParam,
+    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,
+    fireExperimentExposure: false
+  });
+}

package/dist/es2019/experiments-config.js

@@ -353,6 +353,14 @@ export const editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
+  // Added 2025-07-14
+  platform_editor_debounce_portal_provider: createBooleanExperiment({
+    productKeys: {
+      confluence: 'platform_editor_debounce_portal_provider'
+    },
+    param: 'isEnabled',
+    defaultValue: false
+  }),
   // Added 2025-07-08 - Jira work sync description comment summary
   'jira-work-sync-desc-comment-summary': createBooleanExperiment({
     productKeys: {
@@ -646,6 +654,14 @@ export const editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
+  // Added 2025-08-06
+  cc_editor_limited_mode: createBooleanExperiment({
+    productKeys: {
+      confluence: 'cc_editor_limited_mode'
+    },
+    param: 'isEnabled',
+    defaultValue: false
+  }),
   // Added 2025-08-05
   platform_editor_tables_scaling_css: createBooleanExperiment({
     productKeys: {

package/dist/esm/expVal.js

@@ -0,0 +1,82 @@
+import FeatureGates from '@atlaskit/feature-gate-js-client';
+import { editorExperimentsConfig } from './experiments-config';
+import { _product } from './setup';
+function expValInternal(_ref) {
+  var _experimentConfig$pro;
+  var experimentName = _ref.experimentName,
+    experimentParam = _ref.experimentParam,
+    defaultValue = _ref.defaultValue,
+    fireExperimentExposure = _ref.fireExperimentExposure;
+  var experimentConfig = editorExperimentsConfig[experimentName];
+  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 (!_product) {
+    // This will be hit in the case of a product not having setup the editor experiment tooling
+    return defaultValue;
+  }
+
+  // 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[_product];
+  if (!experimentKey) {
+    // This will be hit in the case of an experiment not being set up for the product
+    return defaultValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  var experimentValue = FeatureGates.getExperimentValue(experimentName, experimentParam, defaultValue, {
+    fireExperimentExposure: fireExperimentExposure
+  });
+  return experimentValue;
+}
+
+/**
+ * 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 expParamEqualsNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+export 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)
+ * ```
+ */
+export function expValNoExposure(experimentName, experimentParam, defaultValue) {
+  return expValInternal({
+    experimentName: experimentName,
+    experimentParam: experimentParam,
+    defaultValue: defaultValue,
+    fireExperimentExposure: false
+  });
+}

package/dist/esm/experiments-config.js

@@ -353,6 +353,14 @@ export var editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
+  // Added 2025-07-14
+  platform_editor_debounce_portal_provider: createBooleanExperiment({
+    productKeys: {
+      confluence: 'platform_editor_debounce_portal_provider'
+    },
+    param: 'isEnabled',
+    defaultValue: false
+  }),
   // Added 2025-07-08 - Jira work sync description comment summary
   'jira-work-sync-desc-comment-summary': createBooleanExperiment({
     productKeys: {
@@ -646,6 +654,14 @@ export var editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
+  // Added 2025-08-06
+  cc_editor_limited_mode: createBooleanExperiment({
+    productKeys: {
+      confluence: 'cc_editor_limited_mode'
+    },
+    param: 'isEnabled',
+    defaultValue: false
+  }),
   // Added 2025-08-05
   platform_editor_tables_scaling_css: createBooleanExperiment({
     productKeys: {

package/dist/types/expVal.d.ts

@@ -0,0 +1,31 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * 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 expParamEqualsNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+export declare function expVal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue): DefaultValue;
+/**
+ * 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 declare function expValNoExposure<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue): DefaultValue;

package/dist/types/experiments-config.d.ts

@@ -263,6 +263,12 @@ export declare const editorExperimentsConfig: {
         productKeys?: import("./types").ProductKeys;
         param: string;
     };
+    platform_editor_debounce_portal_provider: {
+        typeGuard: typeof import("./type-guards").isBoolean;
+        defaultValue: boolean;
+        productKeys?: import("./types").ProductKeys;
+        param: string;
+    };
     'jira-work-sync-desc-comment-summary': {
         typeGuard: typeof import("./type-guards").isBoolean;
         defaultValue: boolean;
@@ -483,6 +489,12 @@ export declare const editorExperimentsConfig: {
         productKeys?: import("./types").ProductKeys;
         param: string;
     };
+    cc_editor_limited_mode: {
+        typeGuard: typeof import("./type-guards").isBoolean;
+        defaultValue: boolean;
+        productKeys?: import("./types").ProductKeys;
+        param: string;
+    };
     platform_editor_tables_scaling_css: {
         typeGuard: typeof import("./type-guards").isBoolean;
         defaultValue: boolean;

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

@@ -0,0 +1,31 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * 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 expParamEqualsNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+export declare function expVal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue): DefaultValue;
+/**
+ * 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 declare function expValNoExposure<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue): DefaultValue;

package/dist/types-ts4.5/experiments-config.d.ts

@@ -263,6 +263,12 @@ export declare const editorExperimentsConfig: {
         productKeys?: import("./types").ProductKeys;
         param: string;
     };
+    platform_editor_debounce_portal_provider: {
+        typeGuard: typeof import("./type-guards").isBoolean;
+        defaultValue: boolean;
+        productKeys?: import("./types").ProductKeys;
+        param: string;
+    };
     'jira-work-sync-desc-comment-summary': {
         typeGuard: typeof import("./type-guards").isBoolean;
         defaultValue: boolean;
@@ -483,6 +489,12 @@ export declare const editorExperimentsConfig: {
         productKeys?: import("./types").ProductKeys;
         param: string;
     };
+    cc_editor_limited_mode: {
+        typeGuard: typeof import("./type-guards").isBoolean;
+        defaultValue: boolean;
+        productKeys?: import("./types").ProductKeys;
+        param: string;
+    };
     platform_editor_tables_scaling_css: {
         typeGuard: typeof import("./type-guards").isBoolean;
         defaultValue: boolean;

package/expVal/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@atlaskit/tmp-editor-statsig/expVal",
+  "main": "../dist/cjs/expVal.js",
+  "module": "../dist/esm/expVal.js",
+  "module:es2019": "../dist/es2019/expVal.js",
+  "types": "../dist/types/expVal.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/expVal.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/tmp-editor-statsig",
-	"version": "9.27.0",
+	"version": "9.28.0",
 	"description": "Temp plugin to ease use of statsig feature flags until platform feature flags are available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,6 +36,7 @@
 		"./experiments": "./src/experiments.ts",
 		"./experiments-config": "./src/experiments-config.ts",
 		"./editor-experiments-test-utils": "./src/editor-experiments-test-utils.ts",
+		"./expVal": "./src/expVal.ts",
 		"./exp-val-equals": "./src/exp-val-equals.ts",
 		"./exp-val-equals-no-exposure": "./src/exp-val-equals-no-exposure.ts"
 	},