@atlaskit/tmp-editor-statsig 13.43.0 → 14.0.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/editor-statsig-tmp
 
+## 14.0.0
+
+### Major Changes
+
+- [`66121121982b2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/66121121982b2) -
+  [EXP-CLEANUP] editor_ai_inline_suggestion_date_v2
+
+### Minor Changes
+
+- [`d84e4018e7a77`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d84e4018e7a77) -
+  ED-29689 create new exp
+
+## 13.44.0
+
+### Minor Changes
+
+- [`60c2daf68b2a9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/60c2daf68b2a9) -
+  add type guard for expected value and default value in expVal, expValNoExposure, expValEquals and
+  expValEqualsNoExposure
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 13.43.0
 
 ### Minor Changes

package/dist/cjs/editor-experiments-test-utils.js

@@ -89,6 +89,10 @@ function eeTest(experimentName, cases, otherExperiments) {
   });
 }
 
+// Namespace declaration to add describe property to eeTest function type
+// TypeScript automatically merges function and namespace declarations with the same name
+// eslint-disable-next-line @typescript-eslint/no-namespace
+
 /**
  * eeTest.describe() Wrapper utility for describe() that runs a test with a editor experiment overides.
  *

package/dist/cjs/exp-test-overrides.js

@@ -13,7 +13,6 @@ var testMultivariateOverrides = exports.testMultivariateOverrides = {
   confluence_whiteboards_quick_insert: 'control',
   confluence_whiteboards_quick_insert_localised: 'control',
   confluence_whiteboards_quick_insert_localised_aa: 'control',
-  editor_ai_inline_suggestion_date_v2: 'control',
   cc_editor_ai_content_mode: 'control',
   platform_editor_add_orange_highlight_color: 'control',
   platform_editor_ai_iw_adf_streaming: 'control',

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

@@ -28,8 +28,8 @@ var _expValEqualsInternal = require("./exp-val-equals-internal");
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */

package/dist/cjs/exp-val-equals.js

@@ -28,8 +28,8 @@ var _expValEqualsInternal = require("./exp-val-equals-internal");
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */

package/dist/cjs/expVal.js

@@ -75,11 +75,11 @@ function expValInternal(_ref) {
  * - 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}
+ * If you need to check a param value without an exposure check see {@link expValNoExposure}
  *
  * @example
  * ```ts
- * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * const delay = expVal('experiment-name', 'param-name', defaultValue)
  * await new Promise(res => setTimeout(res, delay)
  * ```
  */
@@ -90,21 +90,19 @@ function expVal(experimentName, experimentParam, defaultValue) {
     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)
- * ```
- */
+} /**
+  * 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,

package/dist/cjs/experiments-config.js

@@ -8,6 +8,24 @@ var _experimentBuilders = require("./experiment-builders");
 /* eslint-disable @atlaskit/editor/no-re-export */
 // Entry file in package.json
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- Need value import for typeof
+
+/**
+ * Extract valid expected values.
+ * - For multivariate experiments: returns union of valid string values (inferred from defaultValue type)
+ * - For boolean experiments: returns only 'true' literal (cannot use 'false' as expected value)
+ */
+
+// Multivariate: use the default value type
+
+/**
+ * Extract valid default values.
+ * - For boolean experiments: returns only 'false' literal (cannot use 'true' as default value)
+ * - For multivariate experiments: returns the default value type (one of the string values)
+ */
+
+// Multivariate: use the default value type
+
 /**
  * When adding a new experiment, you need to add it here.
  * Please follow the pattern established in the examples and any
@@ -326,14 +344,13 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2025-04-14
-  editor_ai_inline_suggestion_date_v2: (0, _experimentBuilders.createMultivariateExperiment)({
+  // Added 2025-10-15
+  platform_editor_no_ssr: (0, _experimentBuilders.createBooleanExperiment)({
     productKeys: {
-      confluence: 'editor_ai_inline_suggestion_date_v2'
+      confluence: 'platform_editor_no_ssr'
     },
-    param: 'cohort',
-    values: ['control', 'test'],
-    defaultValue: 'control'
+    param: 'isEnabled',
+    defaultValue: false
   }),
   // Added 2025-10-31
   platform_editor_lovability_suppress_toolbar_event: (0, _experimentBuilders.createBooleanExperiment)({
@@ -400,14 +417,6 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2025-10-15
-  platform_editor_no_ssr: (0, _experimentBuilders.createBooleanExperiment)({
-    productKeys: {
-      confluence: 'platform_editor_no_ssr'
-    },
-    param: 'isEnabled',
-    defaultValue: false
-  }),
   // Added 2025-08-14
   platform_editor_jira_advanced_code_blocks: (0, _experimentBuilders.createBooleanExperiment)({
     productKeys: {
@@ -776,9 +785,9 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
     defaultValue: false
   }),
   // Added 2025-08-05
-  platform_editor_native_anchor_support: (0, _experimentBuilders.createBooleanExperiment)({
+  platform_editor_native_anchor_with_dnd: (0, _experimentBuilders.createBooleanExperiment)({
     productKeys: {
-      confluence: 'platform_editor_native_anchor_support'
+      confluence: 'platform_editor_native_anchor_with_dnd'
     },
     param: 'isEnabled',
     defaultValue: false

package/dist/es2019/editor-experiments-test-utils.js

@@ -70,6 +70,10 @@ function eeTest(experimentName, cases, otherExperiments) {
   });
 }
 
+// Namespace declaration to add describe property to eeTest function type
+// TypeScript automatically merges function and namespace declarations with the same name
+// eslint-disable-next-line @typescript-eslint/no-namespace
+
 /**
  * eeTest.describe() Wrapper utility for describe() that runs a test with a editor experiment overides.
  *

package/dist/es2019/exp-test-overrides.js

@@ -7,7 +7,6 @@ export const testMultivariateOverrides = {
   confluence_whiteboards_quick_insert: 'control',
   confluence_whiteboards_quick_insert_localised: 'control',
   confluence_whiteboards_quick_insert_localised_aa: 'control',
-  editor_ai_inline_suggestion_date_v2: 'control',
   cc_editor_ai_content_mode: 'control',
   platform_editor_add_orange_highlight_color: 'control',
   platform_editor_ai_iw_adf_streaming: 'control',

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

@@ -22,8 +22,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */

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

@@ -22,8 +22,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */

package/dist/es2019/expVal.js

@@ -68,11 +68,11 @@ function expValInternal({
  * - 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}
+ * If you need to check a param value without an exposure check see {@link expValNoExposure}
  *
  * @example
  * ```ts
- * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * const delay = expVal('experiment-name', 'param-name', defaultValue)
  * await new Promise(res => setTimeout(res, delay)
  * ```
  */
@@ -80,29 +80,27 @@ export function expVal(experimentName, experimentParam, defaultValue) {
   return expValInternal({
     experimentName,
     experimentParam,
-    defaultValue,
+    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)
- * ```
- */
+} /**
+  * 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: defaultValue,
     fireExperimentExposure: false
   });
 }

package/dist/es2019/experiments-config.js

@@ -2,6 +2,24 @@
 // Entry file in package.json
 
 import { createBooleanExperiment, createMultivariateExperiment } from './experiment-builders';
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- Need value import for typeof
+
+/**
+ * Extract valid expected values.
+ * - For multivariate experiments: returns union of valid string values (inferred from defaultValue type)
+ * - For boolean experiments: returns only 'true' literal (cannot use 'false' as expected value)
+ */
+
+// Multivariate: use the default value type
+
+/**
+ * Extract valid default values.
+ * - For boolean experiments: returns only 'false' literal (cannot use 'true' as default value)
+ * - For multivariate experiments: returns the default value type (one of the string values)
+ */
+
+// Multivariate: use the default value type
+
 /**
  * When adding a new experiment, you need to add it here.
  * Please follow the pattern established in the examples and any
@@ -320,14 +338,13 @@ export const editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2025-04-14
-  editor_ai_inline_suggestion_date_v2: createMultivariateExperiment({
+  // Added 2025-10-15
+  platform_editor_no_ssr: createBooleanExperiment({
     productKeys: {
-      confluence: 'editor_ai_inline_suggestion_date_v2'
+      confluence: 'platform_editor_no_ssr'
     },
-    param: 'cohort',
-    values: ['control', 'test'],
-    defaultValue: 'control'
+    param: 'isEnabled',
+    defaultValue: false
   }),
   // Added 2025-10-31
   platform_editor_lovability_suppress_toolbar_event: createBooleanExperiment({
@@ -394,14 +411,6 @@ export const editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2025-10-15
-  platform_editor_no_ssr: createBooleanExperiment({
-    productKeys: {
-      confluence: 'platform_editor_no_ssr'
-    },
-    param: 'isEnabled',
-    defaultValue: false
-  }),
   // Added 2025-08-14
   platform_editor_jira_advanced_code_blocks: createBooleanExperiment({
     productKeys: {
@@ -770,9 +779,9 @@ export const editorExperimentsConfig = {
     defaultValue: false
   }),
   // Added 2025-08-05
-  platform_editor_native_anchor_support: createBooleanExperiment({
+  platform_editor_native_anchor_with_dnd: createBooleanExperiment({
     productKeys: {
-      confluence: 'platform_editor_native_anchor_support'
+      confluence: 'platform_editor_native_anchor_with_dnd'
     },
     param: 'isEnabled',
     defaultValue: false

package/dist/esm/editor-experiments-test-utils.js

@@ -86,6 +86,10 @@ function eeTest(experimentName, cases, otherExperiments) {
   });
 }
 
+// Namespace declaration to add describe property to eeTest function type
+// TypeScript automatically merges function and namespace declarations with the same name
+// eslint-disable-next-line @typescript-eslint/no-namespace
+
 /**
  * eeTest.describe() Wrapper utility for describe() that runs a test with a editor experiment overides.
  *

package/dist/esm/exp-test-overrides.js

@@ -7,7 +7,6 @@ export var testMultivariateOverrides = {
   confluence_whiteboards_quick_insert: 'control',
   confluence_whiteboards_quick_insert_localised: 'control',
   confluence_whiteboards_quick_insert_localised_aa: 'control',
-  editor_ai_inline_suggestion_date_v2: 'control',
   cc_editor_ai_content_mode: 'control',
   platform_editor_add_orange_highlight_color: 'control',
   platform_editor_ai_iw_adf_streaming: 'control',

package/dist/esm/exp-val-equals-no-exposure.js

@@ -22,8 +22,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */

package/dist/esm/exp-val-equals.js

@@ -22,8 +22,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */

package/dist/esm/expVal.js

@@ -67,11 +67,11 @@ function expValInternal(_ref) {
  * - 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}
+ * If you need to check a param value without an exposure check see {@link expValNoExposure}
  *
  * @example
  * ```ts
- * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * const delay = expVal('experiment-name', 'param-name', defaultValue)
  * await new Promise(res => setTimeout(res, delay)
  * ```
  */
@@ -82,21 +82,19 @@ export function expVal(experimentName, experimentParam, defaultValue) {
     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)
- * ```
- */
+} /**
+  * 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,

package/dist/esm/experiments-config.js

@@ -2,6 +2,24 @@
 // Entry file in package.json
 
 import { createBooleanExperiment, createMultivariateExperiment } from './experiment-builders';
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- Need value import for typeof
+
+/**
+ * Extract valid expected values.
+ * - For multivariate experiments: returns union of valid string values (inferred from defaultValue type)
+ * - For boolean experiments: returns only 'true' literal (cannot use 'false' as expected value)
+ */
+
+// Multivariate: use the default value type
+
+/**
+ * Extract valid default values.
+ * - For boolean experiments: returns only 'false' literal (cannot use 'true' as default value)
+ * - For multivariate experiments: returns the default value type (one of the string values)
+ */
+
+// Multivariate: use the default value type
+
 /**
  * When adding a new experiment, you need to add it here.
  * Please follow the pattern established in the examples and any
@@ -320,14 +338,13 @@ export var editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2025-04-14
-  editor_ai_inline_suggestion_date_v2: createMultivariateExperiment({
+  // Added 2025-10-15
+  platform_editor_no_ssr: createBooleanExperiment({
     productKeys: {
-      confluence: 'editor_ai_inline_suggestion_date_v2'
+      confluence: 'platform_editor_no_ssr'
     },
-    param: 'cohort',
-    values: ['control', 'test'],
-    defaultValue: 'control'
+    param: 'isEnabled',
+    defaultValue: false
   }),
   // Added 2025-10-31
   platform_editor_lovability_suppress_toolbar_event: createBooleanExperiment({
@@ -394,14 +411,6 @@ export var editorExperimentsConfig = {
     param: 'isEnabled',
     defaultValue: false
   }),
-  // Added 2025-10-15
-  platform_editor_no_ssr: createBooleanExperiment({
-    productKeys: {
-      confluence: 'platform_editor_no_ssr'
-    },
-    param: 'isEnabled',
-    defaultValue: false
-  }),
   // Added 2025-08-14
   platform_editor_jira_advanced_code_blocks: createBooleanExperiment({
     productKeys: {
@@ -770,9 +779,9 @@ export var editorExperimentsConfig = {
     defaultValue: false
   }),
   // Added 2025-08-05
-  platform_editor_native_anchor_support: createBooleanExperiment({
+  platform_editor_native_anchor_with_dnd: createBooleanExperiment({
     productKeys: {
-      confluence: 'platform_editor_native_anchor_support'
+      confluence: 'platform_editor_native_anchor_with_dnd'
     },
     param: 'isEnabled',
     defaultValue: false

package/dist/types/editor-experiments-test-utils.d.ts

@@ -43,10 +43,19 @@ declare function eeTest<ExperimentName extends keyof EditorExperimentsConfig>(ex
     false: DescribeBody;
     true: DescribeBody;
 }, otherExperiments?: EditorExperimentOverrides): void;
+interface EeTestDescribeReturn<ExperimentName extends keyof EditorExperimentsConfig> {
+    each: (describeBody: DescribeBody) => void;
+    variant: (value: EditorExperimentsConfig[ExperimentName]['defaultValue'], describeBody: DescribeBody) => void;
+}
 declare namespace eeTest {
-    var describe: <ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, describeName: string) => {
-        each: (describeBody: DescribeBody) => void;
-        variant: (value: EditorExperimentsConfig[ExperimentName]["defaultValue"], describeBody: DescribeBody) => void;
-    };
+    function describe<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, describeName: string): EeTestDescribeReturn<ExperimentName>;
+}
+interface EeTestFunction {
+    <ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, cases: EditorExperimentsConfig[ExperimentName]['defaultValue'] extends string ? Record<EditorExperimentsConfig[ExperimentName]['defaultValue'], DescribeBody> : {
+        false: DescribeBody;
+        true: DescribeBody;
+    }, otherExperiments?: EditorExperimentOverrides): void;
+    describe: <ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, describeName: string) => EeTestDescribeReturn<ExperimentName>;
 }
 export { eeTest };
+export type { EeTestFunction };

package/dist/types/exp-val-equals-no-exposure.d.ts

@@ -1,4 +1,4 @@
-import { type EditorExperimentsConfig } from './experiments-config';
+import { type EditorExperimentsConfig, type ExperimentDefaultValue, type ExperimentExpectedValue } from './experiments-config';
 /**
  * Check the value if an editor experiment without firing exposure.
  *
@@ -22,9 +22,9 @@ import { type EditorExperimentsConfig } from './experiments-config';
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */
-export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue?: EditorExperimentsConfig[ExperimentName]['defaultValue'] | null): boolean;
+export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: ExperimentExpectedValue<ExperimentName>, experimentDefaultValue?: ExperimentDefaultValue<ExperimentName> | null): boolean;

package/dist/types/exp-val-equals.d.ts

@@ -1,4 +1,4 @@
-import { type EditorExperimentsConfig } from './experiments-config';
+import { type EditorExperimentsConfig, type ExperimentDefaultValue, type ExperimentExpectedValue } from './experiments-config';
 /**
  * Check the value if an editor experiment and fire exposure.
  *
@@ -22,9 +22,9 @@ import { type EditorExperimentsConfig } from './experiments-config';
  *
  * @param experimentName - experiment key
  * @param experimentParam - the name of the parameter to fetch from the experiment config
- * @param experimentExpectedValue - expected value to compare with
- * @param experimentDefaultValue - default value to use if the experiment is not defined.
+ * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
+ * @param experimentDefaultValue - default value to use if the experiment is not defined. Can't use true for boolean experiments or invalid values for multivariate experiments.
  *
  * @returns boolean
  */
-export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue?: EditorExperimentsConfig[ExperimentName]['defaultValue'] | null): boolean;
+export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: ExperimentExpectedValue<ExperimentName>, experimentDefaultValue?: ExperimentDefaultValue<ExperimentName> | null): boolean;

package/dist/types/expVal.d.ts

@@ -6,16 +6,15 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * - 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}
+ * If you need to check a param value without an exposure check see {@link expValNoExposure}
  *
  * @example
  * ```ts
- * const delay = expParamEquals('experiment-name', 'param-name', defaultValue)
+ * const delay = expVal('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;
-/**
+export declare function expVal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : 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;
@@ -28,4 +27,4 @@ export declare function expVal<ExperimentName extends keyof EditorExperimentsCon
  * 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;
+export declare function expValNoExposure<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue;