@atlaskit/tmp-editor-statsig 101.0.0 → 103.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # @atlaskit/editor-statsig-tmp
2
2
 
3
+ ## 103.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - [`d6c0ba39b44b2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d6c0ba39b44b2) -
8
+ Clean up experiment `platform_editor_outdated_browser_update`
9
+ - [`18c3f1c09a80c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/18c3f1c09a80c) -
10
+ Clean up experiment `platform_editor_rovo_inline_chat_aria_label`
11
+
12
+ ## 102.0.0
13
+
14
+ ### Major Changes
15
+
16
+ - [`db6cfe6d842ac`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/db6cfe6d842ac) -
17
+ Cleaned up stale experiment platform_editor_fix_media_picker_hidden. Removed experiment gating in
18
+ MediaButton, keeping the shipped (true) code path. Removed experiment type definition and config
19
+ entry.
20
+ - [`258fd5f8909fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/258fd5f8909fd) -
21
+ Cleaning up and abandoning the block card post-auth 3P experiment for Jira
22
+
23
+ ### Minor Changes
24
+
25
+ - [`4d71a7433de62`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4d71a7433de62) -
26
+ Use Teamoji default reaction IDs behind the emoji picker refresh experiment.
27
+
3
28
  ## 101.0.0
4
29
 
5
30
  ### Major Changes
@@ -1058,14 +1058,6 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1058
1058
  param: 'isEnabled',
1059
1059
  defaultValue: false
1060
1060
  }),
1061
- // Added 2026-05-01 — Block card rovo action on resolved block card smart links in jira
1062
- platform_sl_3p_auth_rovo_block_card_jira: (0, _experimentBuilders.createBooleanExperiment)({
1063
- productKeys: {
1064
- jira: 'platform_sl_3p_auth_rovo_block_card_jira'
1065
- },
1066
- param: 'isEnabled',
1067
- defaultValue: false
1068
- }),
1069
1061
  // Added 2025-01-23
1070
1062
  platform_editor_to_use_pmr_for_collab_edit_none_ic: (0, _experimentBuilders.createBooleanExperiment)({
1071
1063
  productKeys: {
@@ -1241,14 +1233,6 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1241
1233
  param: 'isEnabled',
1242
1234
  defaultValue: false
1243
1235
  }),
1244
- // Added 2026-16-05
1245
- platform_editor_outdated_browser_update: (0, _experimentBuilders.createBooleanExperiment)({
1246
- productKeys: {
1247
- confluence: 'platform_editor_outdated_browser_update'
1248
- },
1249
- param: 'isEnabled',
1250
- defaultValue: false
1251
- }),
1252
1236
  // Added 2026-02-05
1253
1237
  cc_fd_db_top_editor_toolbar: (0, _experimentBuilders.createMultivariateExperiment)({
1254
1238
  productKeys: {
@@ -1618,15 +1602,6 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1618
1602
  param: 'isEnabled',
1619
1603
  defaultValue: false
1620
1604
  }),
1621
- // Added 2026-03-24
1622
- platform_editor_fix_media_picker_hidden: (0, _experimentBuilders.createBooleanExperiment)({
1623
- productKeys: {
1624
- confluence: 'platform_editor_fix_media_picker_hidden',
1625
- jira: 'platform_editor_fix_media_picker_hidden'
1626
- },
1627
- param: 'isEnabled',
1628
- defaultValue: false
1629
- }),
1630
1605
  cc_editor_ttvc_media_hold_fix: (0, _experimentBuilders.createBooleanExperiment)({
1631
1606
  productKeys: {
1632
1607
  confluence: 'cc_editor_ttvc_media_hold_fix'
@@ -1642,14 +1617,6 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1642
1617
  param: 'isEnabled',
1643
1618
  defaultValue: false
1644
1619
  }),
1645
- // Added 2026-04-01
1646
- platform_editor_rovo_inline_chat_aria_label: (0, _experimentBuilders.createBooleanExperiment)({
1647
- productKeys: {
1648
- confluence: 'platform_editor_rovo_inline_chat_aria_label'
1649
- },
1650
- param: 'isEnabled',
1651
- defaultValue: false
1652
- }),
1653
1620
  platform_editor_table_fit_to_content_auto_convert: (0, _experimentBuilders.createBooleanExperiment)({
1654
1621
  productKeys: {
1655
1622
  confluence: 'platform_editor_table_fit_to_content_auto_convert'
@@ -1052,14 +1052,6 @@ export const editorExperimentsConfig = {
1052
1052
  param: 'isEnabled',
1053
1053
  defaultValue: false
1054
1054
  }),
1055
- // Added 2026-05-01 — Block card rovo action on resolved block card smart links in jira
1056
- platform_sl_3p_auth_rovo_block_card_jira: createBooleanExperiment({
1057
- productKeys: {
1058
- jira: 'platform_sl_3p_auth_rovo_block_card_jira'
1059
- },
1060
- param: 'isEnabled',
1061
- defaultValue: false
1062
- }),
1063
1055
  // Added 2025-01-23
1064
1056
  platform_editor_to_use_pmr_for_collab_edit_none_ic: createBooleanExperiment({
1065
1057
  productKeys: {
@@ -1235,14 +1227,6 @@ export const editorExperimentsConfig = {
1235
1227
  param: 'isEnabled',
1236
1228
  defaultValue: false
1237
1229
  }),
1238
- // Added 2026-16-05
1239
- platform_editor_outdated_browser_update: createBooleanExperiment({
1240
- productKeys: {
1241
- confluence: 'platform_editor_outdated_browser_update'
1242
- },
1243
- param: 'isEnabled',
1244
- defaultValue: false
1245
- }),
1246
1230
  // Added 2026-02-05
1247
1231
  cc_fd_db_top_editor_toolbar: createMultivariateExperiment({
1248
1232
  productKeys: {
@@ -1612,15 +1596,6 @@ export const editorExperimentsConfig = {
1612
1596
  param: 'isEnabled',
1613
1597
  defaultValue: false
1614
1598
  }),
1615
- // Added 2026-03-24
1616
- platform_editor_fix_media_picker_hidden: createBooleanExperiment({
1617
- productKeys: {
1618
- confluence: 'platform_editor_fix_media_picker_hidden',
1619
- jira: 'platform_editor_fix_media_picker_hidden'
1620
- },
1621
- param: 'isEnabled',
1622
- defaultValue: false
1623
- }),
1624
1599
  cc_editor_ttvc_media_hold_fix: createBooleanExperiment({
1625
1600
  productKeys: {
1626
1601
  confluence: 'cc_editor_ttvc_media_hold_fix'
@@ -1636,14 +1611,6 @@ export const editorExperimentsConfig = {
1636
1611
  param: 'isEnabled',
1637
1612
  defaultValue: false
1638
1613
  }),
1639
- // Added 2026-04-01
1640
- platform_editor_rovo_inline_chat_aria_label: createBooleanExperiment({
1641
- productKeys: {
1642
- confluence: 'platform_editor_rovo_inline_chat_aria_label'
1643
- },
1644
- param: 'isEnabled',
1645
- defaultValue: false
1646
- }),
1647
1614
  platform_editor_table_fit_to_content_auto_convert: createBooleanExperiment({
1648
1615
  productKeys: {
1649
1616
  confluence: 'platform_editor_table_fit_to_content_auto_convert'
@@ -1052,14 +1052,6 @@ export var editorExperimentsConfig = {
1052
1052
  param: 'isEnabled',
1053
1053
  defaultValue: false
1054
1054
  }),
1055
- // Added 2026-05-01 — Block card rovo action on resolved block card smart links in jira
1056
- platform_sl_3p_auth_rovo_block_card_jira: createBooleanExperiment({
1057
- productKeys: {
1058
- jira: 'platform_sl_3p_auth_rovo_block_card_jira'
1059
- },
1060
- param: 'isEnabled',
1061
- defaultValue: false
1062
- }),
1063
1055
  // Added 2025-01-23
1064
1056
  platform_editor_to_use_pmr_for_collab_edit_none_ic: createBooleanExperiment({
1065
1057
  productKeys: {
@@ -1235,14 +1227,6 @@ export var editorExperimentsConfig = {
1235
1227
  param: 'isEnabled',
1236
1228
  defaultValue: false
1237
1229
  }),
1238
- // Added 2026-16-05
1239
- platform_editor_outdated_browser_update: createBooleanExperiment({
1240
- productKeys: {
1241
- confluence: 'platform_editor_outdated_browser_update'
1242
- },
1243
- param: 'isEnabled',
1244
- defaultValue: false
1245
- }),
1246
1230
  // Added 2026-02-05
1247
1231
  cc_fd_db_top_editor_toolbar: createMultivariateExperiment({
1248
1232
  productKeys: {
@@ -1612,15 +1596,6 @@ export var editorExperimentsConfig = {
1612
1596
  param: 'isEnabled',
1613
1597
  defaultValue: false
1614
1598
  }),
1615
- // Added 2026-03-24
1616
- platform_editor_fix_media_picker_hidden: createBooleanExperiment({
1617
- productKeys: {
1618
- confluence: 'platform_editor_fix_media_picker_hidden',
1619
- jira: 'platform_editor_fix_media_picker_hidden'
1620
- },
1621
- param: 'isEnabled',
1622
- defaultValue: false
1623
- }),
1624
1599
  cc_editor_ttvc_media_hold_fix: createBooleanExperiment({
1625
1600
  productKeys: {
1626
1601
  confluence: 'cc_editor_ttvc_media_hold_fix'
@@ -1636,14 +1611,6 @@ export var editorExperimentsConfig = {
1636
1611
  param: 'isEnabled',
1637
1612
  defaultValue: false
1638
1613
  }),
1639
- // Added 2026-04-01
1640
- platform_editor_rovo_inline_chat_aria_label: createBooleanExperiment({
1641
- productKeys: {
1642
- confluence: 'platform_editor_rovo_inline_chat_aria_label'
1643
- },
1644
- param: 'isEnabled',
1645
- defaultValue: false
1646
- }),
1647
1614
  platform_editor_table_fit_to_content_auto_convert: createBooleanExperiment({
1648
1615
  productKeys: {
1649
1616
  confluence: 'platform_editor_table_fit_to_content_auto_convert'
@@ -731,12 +731,6 @@ export declare const editorExperimentsConfig: {
731
731
  productKeys?: ProductKeys;
732
732
  typeGuard: IsBooleanType;
733
733
  };
734
- platform_sl_3p_auth_rovo_block_card_jira: {
735
- defaultValue: boolean;
736
- param: string;
737
- productKeys?: ProductKeys;
738
- typeGuard: IsBooleanType;
739
- };
740
734
  platform_sl_3p_auth_rovo_block_card_confluence: {
741
735
  defaultValue: boolean;
742
736
  param: string;
@@ -918,12 +912,6 @@ export declare const editorExperimentsConfig: {
918
912
  productKeys?: ProductKeys;
919
913
  typeGuard: IsBooleanType;
920
914
  };
921
- platform_editor_outdated_browser_update: {
922
- defaultValue: boolean;
923
- param: string;
924
- productKeys?: ProductKeys;
925
- typeGuard: IsBooleanType;
926
- };
927
915
  cc_fd_db_top_editor_toolbar: {
928
916
  defaultValue: 'control' | 'new-description' | 'orig-description';
929
917
  param: string;
@@ -1250,12 +1238,6 @@ export declare const editorExperimentsConfig: {
1250
1238
  productKeys?: ProductKeys;
1251
1239
  typeGuard: IsBooleanType;
1252
1240
  };
1253
- platform_editor_fix_media_picker_hidden: {
1254
- defaultValue: boolean;
1255
- param: string;
1256
- productKeys?: ProductKeys;
1257
- typeGuard: IsBooleanType;
1258
- };
1259
1241
  cc_editor_ttvc_media_hold_fix: {
1260
1242
  defaultValue: boolean;
1261
1243
  param: string;
@@ -1268,12 +1250,6 @@ export declare const editorExperimentsConfig: {
1268
1250
  productKeys?: ProductKeys;
1269
1251
  typeGuard: IsBooleanType;
1270
1252
  };
1271
- platform_editor_rovo_inline_chat_aria_label: {
1272
- defaultValue: boolean;
1273
- param: string;
1274
- productKeys?: ProductKeys;
1275
- typeGuard: IsBooleanType;
1276
- };
1277
1253
  platform_editor_remove_collab_step_metrics: {
1278
1254
  defaultValue: boolean;
1279
1255
  param: string;
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/dynamic-config-value-contains.js",
4
4
  "module": "../dist/esm/dynamic-config-value-contains.js",
5
5
  "module:es2019": "../dist/es2019/dynamic-config-value-contains.js",
6
- "types": "../dist/types/dynamic-config-value-contains.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/dynamic-config-value-contains.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/dynamic-config-value-contains.d.ts"
14
7
  }
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/editor-experiments-test-utils.js",
4
4
  "module": "../dist/esm/editor-experiments-test-utils.js",
5
5
  "module:es2019": "../dist/es2019/editor-experiments-test-utils.js",
6
- "types": "../dist/types/editor-experiments-test-utils.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/editor-experiments-test-utils.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/editor-experiments-test-utils.d.ts"
14
7
  }
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/exp-val-equals.js",
4
4
  "module": "../dist/esm/exp-val-equals.js",
5
5
  "module:es2019": "../dist/es2019/exp-val-equals.js",
6
- "types": "../dist/types/exp-val-equals.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/exp-val-equals.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/exp-val-equals.d.ts"
14
7
  }
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/exp-val-equals-no-exposure.js",
4
4
  "module": "../dist/esm/exp-val-equals-no-exposure.js",
5
5
  "module:es2019": "../dist/es2019/exp-val-equals-no-exposure.js",
6
- "types": "../dist/types/exp-val-equals-no-exposure.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/exp-val-equals-no-exposure.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/exp-val-equals-no-exposure.d.ts"
14
7
  }
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/expVal.js",
4
4
  "module": "../dist/esm/expVal.js",
5
5
  "module:es2019": "../dist/es2019/expVal.js",
6
- "types": "../dist/types/expVal.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/expVal.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/expVal.d.ts"
14
7
  }
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/experiments.js",
4
4
  "module": "../dist/esm/experiments.js",
5
5
  "module:es2019": "../dist/es2019/experiments.js",
6
- "types": "../dist/types/experiments.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/experiments.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/experiments.d.ts"
14
7
  }
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/experiments-config.js",
4
4
  "module": "../dist/esm/experiments-config.js",
5
5
  "module:es2019": "../dist/es2019/experiments-config.js",
6
- "types": "../dist/types/experiments-config.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/experiments-config.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/experiments-config.d.ts"
14
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/tmp-editor-statsig",
3
- "version": "101.0.0",
3
+ "version": "103.0.0",
4
4
  "description": "Temp plugin to ease use of statsig feature flags until platform feature flags are available",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -3,12 +3,5 @@
3
3
  "main": "../dist/cjs/setup.js",
4
4
  "module": "../dist/esm/setup.js",
5
5
  "module:es2019": "../dist/es2019/setup.js",
6
- "types": "../dist/types/setup.d.ts",
7
- "typesVersions": {
8
- ">=4.5 <5.9": {
9
- "*": [
10
- "../dist/types-ts4.5/setup.d.ts"
11
- ]
12
- }
13
- }
6
+ "types": "../dist/types/setup.d.ts"
14
7
  }
@@ -1,7 +0,0 @@
1
- /**
2
- * Returns whether a Statsig dynamic config's string list (under the `value` key) includes `token`
3
- * (exact match).
4
- *
5
- * Used for UX tokens such as `remove-rovo-placeholder` inside `platform_editor_ai_autocomplete_ux_config`.
6
- */
7
- export declare function dynamicConfigStringListIncludes(configName: string, token: string): boolean;
@@ -1,61 +0,0 @@
1
- import type { EditorExperimentOverrides } from './setup';
2
- import type { EditorExperimentsConfig } from './experiments-config';
3
- type DescribeBody = Parameters<typeof describe>[1];
4
- /**
5
- * This is a utility function for testing editor experiments.
6
- *
7
- * @example Boolean experiment
8
- * ```ts
9
- * eeTest('example-boolean', {
10
- * true: () => {
11
- * expect(editorExperiment('example-boolean', true)).toBe(true);
12
- * expect(editorExperiment('example-boolean', false)).toBe(false);
13
- * },
14
- * false: () => {
15
- * expect(editorExperiment('example-boolean', false)).toBe(true);
16
- * expect(editorExperiment('example-boolean', true)).toBe(false);
17
- * },
18
- * })
19
- * ```
20
- *
21
- * @example Multivariate experiment
22
- * ```ts
23
- * eeTest('example-multivariate', {
24
- * one: () => {
25
- * expect(editorExperiment('example-multivariate', 'one')).toBe(true);
26
- * expect(editorExperiment('example-multivariate', 'two')).toBe(false);
27
- * },
28
- * two: () => {
29
- * expect(editorExperiment('example-multivariate', 'two')).toBe(true);
30
- * expect(editorExperiment('example-multivariate', 'one')).toBe(false);
31
- * },
32
- * three: () => {
33
- * expect(editorExperiment('example-multivariate', 'three')).toBe(true);
34
- * expect(editorExperiment('example-multivariate', 'one')).toBe(false);
35
- * },
36
- * })
37
- * ```
38
- *
39
- * API based on Legacy ffTest API
40
- * - https://hello.atlassian.net/wiki/spaces/AF/pages/2569505829/Task+Testing+your+feature+flag+in+platform+and+product#Legacy-API-lEGACY
41
- */
42
- declare function eeTest<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, cases: EditorExperimentsConfig[ExperimentName]['defaultValue'] extends string ? Record<EditorExperimentsConfig[ExperimentName]['defaultValue'], DescribeBody> : {
43
- false: DescribeBody;
44
- true: DescribeBody;
45
- }, otherExperiments?: EditorExperimentOverrides): void;
46
- interface EeTestDescribeReturn<ExperimentName extends keyof EditorExperimentsConfig> {
47
- each: (describeBody: DescribeBody) => void;
48
- variant: (value: EditorExperimentsConfig[ExperimentName]['defaultValue'], describeBody: DescribeBody) => void;
49
- }
50
- declare namespace eeTest {
51
- function describe<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, describeName: string): EeTestDescribeReturn<ExperimentName>;
52
- }
53
- interface EeTestFunction {
54
- <ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, cases: EditorExperimentsConfig[ExperimentName]['defaultValue'] extends string ? Record<EditorExperimentsConfig[ExperimentName]['defaultValue'], DescribeBody> : {
55
- false: DescribeBody;
56
- true: DescribeBody;
57
- }, otherExperiments?: EditorExperimentOverrides): void;
58
- describe: <ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, describeName: string) => EeTestDescribeReturn<ExperimentName>;
59
- }
60
- export { eeTest };
61
- export type { EeTestFunction };
@@ -1,12 +0,0 @@
1
- import type { EditorExperimentsConfig } from './experiments-config';
2
- type MultivariateConfig<Value> = Value extends boolean ? false : true;
3
- type BooleanConfig<Value> = Value extends boolean ? true : false;
4
- export type EditorExperimentOverridesMultivariate = {
5
- [K in keyof EditorExperimentsConfig as MultivariateConfig<EditorExperimentsConfig[K]['defaultValue']> extends true ? K : never]: EditorExperimentsConfig[K]['defaultValue'];
6
- };
7
- export type EditorExperimentOverridesBoolean = {
8
- [K in keyof EditorExperimentsConfig as BooleanConfig<EditorExperimentsConfig[K]['defaultValue']> extends true ? K : never]?: EditorExperimentsConfig[K]['defaultValue'];
9
- };
10
- export declare const testMultivariateOverrides: EditorExperimentOverridesMultivariate;
11
- export declare const testBooleanOverrides: EditorExperimentOverridesBoolean;
12
- export {};
@@ -1,17 +0,0 @@
1
- import { type EditorExperimentsConfig } from './experiments-config';
2
- /**
3
- * Check the value if an editor experiment.
4
- * Internal method that is shared between expValEquals and expValEqualsNoExposure.
5
- *
6
- * @example
7
- * exportValEqualsInternal('example-boolean', 'paramName', true, null, true);
8
- *
9
- * @param experimentName - experiment key
10
- * @param experimentParam - the name of the parameter to fetch from the experiment config
11
- * @param experimentExpectedValue - expected value to compare with
12
- * @param experimentDefaultValue - default value to use if the experiment is not set
13
- * @param experimentExposure - whether to fire an exposure event or not
14
- *
15
- * @returns boolean
16
- */
17
- export declare function expValEqualsInternal<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue: boolean | string | null, experimentExposure: boolean): boolean;
@@ -1,30 +0,0 @@
1
- import type { EditorExperimentsConfig, ExperimentDefaultValue, ExperimentExpectedValue } from './experiments-config';
2
- /**
3
- * Check the value if an editor experiment without firing exposure.
4
- *
5
- * !!! Note: This method never fires exposure. !!!
6
- *
7
- * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
8
- *
9
- * @example Boolean experiment
10
- * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
11
- * // Run code for on variant
12
- * } else {
13
- * // Run code for off variant
14
- * }
15
- *
16
- * @example Multivariate experiment
17
- * if (expValEqualsNoExposure('example-multivariate', 'cohort', 'one')) {
18
- * // Run code for 'one' variant
19
- * } else {
20
- * // Run code for control
21
- * }
22
- *
23
- * @param experimentName - experiment key
24
- * @param experimentParam - the name of the parameter to fetch from the experiment config
25
- * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
26
- * @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.
27
- *
28
- * @returns boolean
29
- */
30
- export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: ExperimentExpectedValue<ExperimentName>, experimentDefaultValue?: ExperimentDefaultValue<ExperimentName> | null): boolean;
@@ -1,30 +0,0 @@
1
- import type { EditorExperimentsConfig, ExperimentDefaultValue, ExperimentExpectedValue } from './experiments-config';
2
- /**
3
- * Check the value if an editor experiment and fire exposure.
4
- *
5
- * !!! Note: This method always fires exposure. !!!
6
- *
7
- * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
8
- *
9
- * @example Boolean experiment
10
- * if (expValEquals('example-boolean', 'isEnabled', true)) {
11
- * // Run code for on variant
12
- * } else {
13
- * // Run code for off variant
14
- * }
15
- *
16
- * @example Multivariate experiment
17
- * if (expValEquals('example-multivariate', 'cohort', 'one')) {
18
- * // Run code for 'one' variant
19
- * } else {
20
- * // Run code for control
21
- * }
22
- *
23
- * @param experimentName - experiment key
24
- * @param experimentParam - the name of the parameter to fetch from the experiment config
25
- * @param experimentExpectedValue - expected value to compare with. Can't use false for boolean experiments or invalid values for multivariate experiments.
26
- * @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.
27
- *
28
- * @returns boolean
29
- */
30
- export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: ExperimentExpectedValue<ExperimentName>, experimentDefaultValue?: ExperimentDefaultValue<ExperimentName> | null): boolean;
@@ -1,30 +0,0 @@
1
- import type { EditorExperimentsConfig } from './experiments-config';
2
- /**
3
- * Use to check a any param value for an experiment
4
- *
5
- * **Note**: this will return the default value when the experiment;
6
- * - is not being served to the client (ie. pre start)
7
- * - or is not configured in experiments-config
8
- *
9
- * If you need to check a param value without an exposure check see {@link expValNoExposure}
10
- *
11
- * @example
12
- * ```ts
13
- * const delay = expVal('experiment-name', 'param-name', defaultValue)
14
- * await new Promise(res => setTimeout(res, delay)
15
- * ```
16
- */
17
- export declare function expVal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue; /**
18
- * Use to check a any param value for an experiment without firing an exposure event
19
- *
20
- * **Note**: this will return the default value when the experiment;
21
- * - is not being served to the client (ie. pre start)
22
- * - or is not configured in experiments-config
23
- *
24
- * @example
25
- * ```ts
26
- * const delay = expParamEqualsNoExposure('experiment-name', 'param-name', defaultValue)
27
- * await new Promise(res => setTimeout(res, delay)
28
- * ```
29
- */
30
- export declare function expValNoExposure<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue;
@@ -1,23 +0,0 @@
1
- import { isBoolean } from './type-guards';
2
- import type { BooleanExperimentConfig, MultivariateExperimentConfig, ProductKeys } from './types';
3
- /**
4
- * Helper to create a boolean experiment configuration
5
- */
6
- export declare function createBooleanExperiment(config: BooleanExperimentConfig): {
7
- defaultValue: boolean;
8
- param: string;
9
- productKeys?: ProductKeys;
10
- typeGuard: typeof isBoolean;
11
- };
12
- /**
13
- * Helper to create a multivariate experiment configuration
14
- */
15
- export declare function createMultivariateExperiment<T extends string[]>(config: MultivariateExperimentConfig<T>): {
16
- defaultValue: T[number];
17
- param: string;
18
- productKeys?: ProductKeys;
19
- typeGuard: (value: unknown) => value is T[number];
20
- values: [
21
- ...T
22
- ][number][];
23
- };