@atlaskit/tmp-editor-statsig 26.0.0 → 27.1.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,25 @@
1
1
  # @atlaskit/editor-statsig-tmp
2
2
 
3
+ ## 27.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`0eed66892511e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0eed66892511e) -
8
+ EDITOR-5120 - Add additional ProseMirror rendered analytics attributes behind the
9
+ platform_editor_prosemirror_rendered_data experiment.
10
+
11
+ ## 27.0.0
12
+
13
+ ### Major Changes
14
+
15
+ - [`19911524eaec5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/19911524eaec5) -
16
+ Cleanup A/A test for cc_fd_db_top_editor_toolbar experiment.
17
+
18
+ ### Minor Changes
19
+
20
+ - [`dece098c3ab1f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/dece098c3ab1f) -
21
+ [ux] ENGHEALTH-46818 Add focus and blur handlers to table buttons to fix a11y
22
+
3
23
  ## 26.0.0
4
24
 
5
25
  ### Major Changes
package/README.md CHANGED
@@ -1,6 +1,124 @@
1
1
  # @atlaskit/tmp-editor-statsig
2
2
 
3
3
  Temp plugin to ease use of statsig feature flags until platform feature flags are available
4
+ Temp plugin to ease use of statsig experiment until a platform solution is available.
5
+
6
+ **Warning:** This is a temporary solution and will be removed once there is a platform solution for statsig experiments.
7
+
8
+ **Warning:** This requires per product setup via the \`setupEditorExperiments\` api (products without this setup will receive the
9
+ default value setup for experiments).
10
+
11
+ ## Usage
12
+
13
+ ### Experiments
14
+
15
+ All experiments must be registered in the \`editorExperimentsConfig\` object in the experiments.ts file.
16
+
17
+ Once they are registered, they can be accessed using the \`editorExperiment\` function from \`@atlaskit/tmp-editor-statsig/experiments\`.
18
+
19
+ #### Boolean experiments
20
+
21
+ ```tsx
22
+ import { editorExperiment } from '@atlaskit/editor-statsig-tmp/experiments';
23
+
24
+ if (editorExperiment('editor_inline_comments_on_inline_nodes', true)) {
25
+ // do something
26
+ } else {
27
+ // do something else
28
+ }
29
+ ```
30
+
31
+ #### Multivariate experiments
32
+
33
+ ```tsx
34
+ import { editorExperiment } from '@atlaskit/editor-statsig-tmp/experiments';
35
+
36
+ switch (true) {
37
+ case editorExperiment('editor_new_control_variants', 'variant-one'): {
38
+ // do something for variant one
39
+ return
40
+ }
41
+ case editorExperiment('editor_new_control_variants', 'variant-two'): {
42
+ // do something for variant two
43
+ return
44
+ }
45
+ case editorExperiment('editor_new_control_variants', 'variant-three'): {
46
+ // do something for variant three
47
+ return
48
+ }
49
+ }
50
+ `}
51
+
52
+
53
+ ### Testing experiments
54
+
55
+ #### Atlaskit examples
56
+
57
+ Not yet supported.
58
+
59
+ #### Jest tests
60
+ ##### Boolean experiments
61
+
62
+ ```tsx
63
+ import { eeTest } from '@atlaskit/tmp-editor-statsig/editor-experiments-test-utils';
64
+
65
+ eeTest('example-boolean', {
66
+ true: () => {
67
+ expect(editorExperiment('example-boolean', true)).toBe(true);
68
+ },
69
+ false: () => {
70
+ expect(editorExperiment('example-boolean', false)).toBe(false);
71
+ },
72
+ });
73
+ ```
74
+
75
+ ##### Multivariate experiments
76
+
77
+ ```tsx
78
+ import { eeTest } from '@atlaskit/tmp-editor-statsig/editor-experiments-test-utils';
79
+
80
+ eeTest('example-multivariate', {
81
+ one: () => {
82
+ expect(editorExperiment('example-boolean')).toBe('variant-one');
83
+ },
84
+ two: () => {
85
+ expect(editorExperiment('example-boolean')).toBe('variant-two');
86
+ },
87
+ three: () => {
88
+ expect(editorExperiment('example-boolean')).toBe('variant-three');
89
+ },
90
+ });
91
+ ```
92
+
93
+ #### Playwright tests
94
+
95
+ Editor Experiments are setup similar to platformFeatureFlags.
96
+
97
+ ```tsx
98
+ test.use({
99
+ adf: exampleAdf,
100
+ platformFeatureFlags: {
101
+ // ...
102
+ },
103
+ editorExperiments: {
104
+ 'example-boolean': true,
105
+ 'example-multivariate': 'variant',
106
+ },
107
+ });
108
+ ```
109
+
110
+ ## Configuration
111
+
112
+ ```tsx
113
+ import { setupEditorExperiments } from '@atlaskit/tmp-editor-statsig/experiments';
114
+
115
+ // Example confluence setup
116
+ setupEditorExperiments('confluence');
117
+
118
+ // Example dev util setup -- takes overrides as a second param (and otherwise defaults all experiments to their default values)
119
+ setupEditorExperiments('test', { 'example-boolean': true });
120
+ ```tsx
121
+
4
122
 
5
123
  ## Usage
6
124
 
@@ -14,8 +14,7 @@ var testMultivariateOverrides = exports.testMultivariateOverrides = {
14
14
  cc_editor_insm_outlier_events: 'test',
15
15
  platform_editor_table_sticky_header_improvements: 'test_with_overflow',
16
16
  platform_sl_3p_unauth_paste_as_block_card: 'control',
17
- cc_fd_db_top_editor_toolbar: 'control',
18
- cc_fd_db_top_editor_toolbar_aa: 'control'
17
+ cc_fd_db_top_editor_toolbar: 'control'
19
18
  };
20
19
  var testBooleanOverrides = exports.testBooleanOverrides = {
21
20
  cc_editor_hover_link_overlay_css_fix: false,
@@ -50,5 +49,6 @@ var testBooleanOverrides = exports.testBooleanOverrides = {
50
49
  platform_editor_find_and_replace_improvements: false,
51
50
  platform_editor_toggle_expand_on_match_found: false,
52
51
  platform_editor_reduce_noisy_steps_ncs: false,
52
+ platform_editor_prosemirror_rendered_data: false,
53
53
  confluence_compact_text_format: false
54
54
  };
@@ -1230,6 +1230,14 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1230
1230
  param: 'isEnabled',
1231
1231
  defaultValue: false
1232
1232
  }),
1233
+ // Added 2026-02-18
1234
+ platform_editor_table_a11y_eslint_fix: (0, _experimentBuilders.createBooleanExperiment)({
1235
+ productKeys: {
1236
+ confluence: 'platform_editor_table_a11y_eslint_fix'
1237
+ },
1238
+ param: 'isEnabled',
1239
+ defaultValue: false
1240
+ }),
1233
1241
  // Added 2026-01-27
1234
1242
  platform_editor_table_cell_colour_change: (0, _experimentBuilders.createBooleanExperiment)({
1235
1243
  productKeys: {
@@ -1332,15 +1340,6 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1332
1340
  values: ['control', 'new-description', 'orig-description'],
1333
1341
  defaultValue: 'control'
1334
1342
  }),
1335
- // Added 2026-02-11
1336
- cc_fd_db_top_editor_toolbar_aa: (0, _experimentBuilders.createMultivariateExperiment)({
1337
- productKeys: {
1338
- confluence: 'cc_fd_db_top_editor_toolbar_aa'
1339
- },
1340
- param: 'cohort',
1341
- values: ['control', 'new-description', 'orig-description'],
1342
- defaultValue: 'control'
1343
- }),
1344
1343
  // Added 2026-01-28
1345
1344
  platform_editor_smartlink_local_cache: (0, _experimentBuilders.createBooleanExperiment)({
1346
1345
  productKeys: {
@@ -1430,5 +1429,14 @@ var editorExperimentsConfig = exports.editorExperimentsConfig = {
1430
1429
  },
1431
1430
  param: 'isEnabled',
1432
1431
  defaultValue: false
1432
+ }),
1433
+ // Added 2026-02-11
1434
+ platform_editor_prosemirror_rendered_data: (0, _experimentBuilders.createBooleanExperiment)({
1435
+ productKeys: {
1436
+ confluence: 'platform_editor_prosemirror_rendered_data',
1437
+ jira: 'platform_editor_prosemirror_rendered_data'
1438
+ },
1439
+ param: 'isEnabled',
1440
+ defaultValue: false
1433
1441
  })
1434
1442
  };
@@ -8,8 +8,7 @@ export const testMultivariateOverrides = {
8
8
  cc_editor_insm_outlier_events: 'test',
9
9
  platform_editor_table_sticky_header_improvements: 'test_with_overflow',
10
10
  platform_sl_3p_unauth_paste_as_block_card: 'control',
11
- cc_fd_db_top_editor_toolbar: 'control',
12
- cc_fd_db_top_editor_toolbar_aa: 'control'
11
+ cc_fd_db_top_editor_toolbar: 'control'
13
12
  };
14
13
  export const testBooleanOverrides = {
15
14
  cc_editor_hover_link_overlay_css_fix: false,
@@ -44,5 +43,6 @@ export const testBooleanOverrides = {
44
43
  platform_editor_find_and_replace_improvements: false,
45
44
  platform_editor_toggle_expand_on_match_found: false,
46
45
  platform_editor_reduce_noisy_steps_ncs: false,
46
+ platform_editor_prosemirror_rendered_data: false,
47
47
  confluence_compact_text_format: false
48
48
  };
@@ -1224,6 +1224,14 @@ export const editorExperimentsConfig = {
1224
1224
  param: 'isEnabled',
1225
1225
  defaultValue: false
1226
1226
  }),
1227
+ // Added 2026-02-18
1228
+ platform_editor_table_a11y_eslint_fix: createBooleanExperiment({
1229
+ productKeys: {
1230
+ confluence: 'platform_editor_table_a11y_eslint_fix'
1231
+ },
1232
+ param: 'isEnabled',
1233
+ defaultValue: false
1234
+ }),
1227
1235
  // Added 2026-01-27
1228
1236
  platform_editor_table_cell_colour_change: createBooleanExperiment({
1229
1237
  productKeys: {
@@ -1326,15 +1334,6 @@ export const editorExperimentsConfig = {
1326
1334
  values: ['control', 'new-description', 'orig-description'],
1327
1335
  defaultValue: 'control'
1328
1336
  }),
1329
- // Added 2026-02-11
1330
- cc_fd_db_top_editor_toolbar_aa: createMultivariateExperiment({
1331
- productKeys: {
1332
- confluence: 'cc_fd_db_top_editor_toolbar_aa'
1333
- },
1334
- param: 'cohort',
1335
- values: ['control', 'new-description', 'orig-description'],
1336
- defaultValue: 'control'
1337
- }),
1338
1337
  // Added 2026-01-28
1339
1338
  platform_editor_smartlink_local_cache: createBooleanExperiment({
1340
1339
  productKeys: {
@@ -1424,5 +1423,14 @@ export const editorExperimentsConfig = {
1424
1423
  },
1425
1424
  param: 'isEnabled',
1426
1425
  defaultValue: false
1426
+ }),
1427
+ // Added 2026-02-11
1428
+ platform_editor_prosemirror_rendered_data: createBooleanExperiment({
1429
+ productKeys: {
1430
+ confluence: 'platform_editor_prosemirror_rendered_data',
1431
+ jira: 'platform_editor_prosemirror_rendered_data'
1432
+ },
1433
+ param: 'isEnabled',
1434
+ defaultValue: false
1427
1435
  })
1428
1436
  };
@@ -8,8 +8,7 @@ export var testMultivariateOverrides = {
8
8
  cc_editor_insm_outlier_events: 'test',
9
9
  platform_editor_table_sticky_header_improvements: 'test_with_overflow',
10
10
  platform_sl_3p_unauth_paste_as_block_card: 'control',
11
- cc_fd_db_top_editor_toolbar: 'control',
12
- cc_fd_db_top_editor_toolbar_aa: 'control'
11
+ cc_fd_db_top_editor_toolbar: 'control'
13
12
  };
14
13
  export var testBooleanOverrides = {
15
14
  cc_editor_hover_link_overlay_css_fix: false,
@@ -44,5 +43,6 @@ export var testBooleanOverrides = {
44
43
  platform_editor_find_and_replace_improvements: false,
45
44
  platform_editor_toggle_expand_on_match_found: false,
46
45
  platform_editor_reduce_noisy_steps_ncs: false,
46
+ platform_editor_prosemirror_rendered_data: false,
47
47
  confluence_compact_text_format: false
48
48
  };
@@ -1224,6 +1224,14 @@ export var editorExperimentsConfig = {
1224
1224
  param: 'isEnabled',
1225
1225
  defaultValue: false
1226
1226
  }),
1227
+ // Added 2026-02-18
1228
+ platform_editor_table_a11y_eslint_fix: createBooleanExperiment({
1229
+ productKeys: {
1230
+ confluence: 'platform_editor_table_a11y_eslint_fix'
1231
+ },
1232
+ param: 'isEnabled',
1233
+ defaultValue: false
1234
+ }),
1227
1235
  // Added 2026-01-27
1228
1236
  platform_editor_table_cell_colour_change: createBooleanExperiment({
1229
1237
  productKeys: {
@@ -1326,15 +1334,6 @@ export var editorExperimentsConfig = {
1326
1334
  values: ['control', 'new-description', 'orig-description'],
1327
1335
  defaultValue: 'control'
1328
1336
  }),
1329
- // Added 2026-02-11
1330
- cc_fd_db_top_editor_toolbar_aa: createMultivariateExperiment({
1331
- productKeys: {
1332
- confluence: 'cc_fd_db_top_editor_toolbar_aa'
1333
- },
1334
- param: 'cohort',
1335
- values: ['control', 'new-description', 'orig-description'],
1336
- defaultValue: 'control'
1337
- }),
1338
1337
  // Added 2026-01-28
1339
1338
  platform_editor_smartlink_local_cache: createBooleanExperiment({
1340
1339
  productKeys: {
@@ -1424,5 +1423,14 @@ export var editorExperimentsConfig = {
1424
1423
  },
1425
1424
  param: 'isEnabled',
1426
1425
  defaultValue: false
1426
+ }),
1427
+ // Added 2026-02-11
1428
+ platform_editor_prosemirror_rendered_data: createBooleanExperiment({
1429
+ productKeys: {
1430
+ confluence: 'platform_editor_prosemirror_rendered_data',
1431
+ jira: 'platform_editor_prosemirror_rendered_data'
1432
+ },
1433
+ param: 'isEnabled',
1434
+ defaultValue: false
1427
1435
  })
1428
1436
  };
@@ -118,6 +118,12 @@ export declare const editorExperimentsConfig: {
118
118
  productKeys?: ProductKeys;
119
119
  typeGuard: IsBooleanType;
120
120
  };
121
+ platform_editor_prosemirror_rendered_data: {
122
+ defaultValue: boolean;
123
+ param: string;
124
+ productKeys?: ProductKeys;
125
+ typeGuard: IsBooleanType;
126
+ };
121
127
  confluence_compact_text_format: {
122
128
  defaultValue: boolean;
123
129
  param: string;
@@ -403,6 +409,12 @@ export declare const editorExperimentsConfig: {
403
409
  productKeys?: ProductKeys;
404
410
  typeGuard: IsBooleanType;
405
411
  };
412
+ platform_editor_table_a11y_eslint_fix: {
413
+ defaultValue: boolean;
414
+ param: string;
415
+ productKeys?: ProductKeys;
416
+ typeGuard: IsBooleanType;
417
+ };
406
418
  platform_editor_find_and_replace_improvements: {
407
419
  defaultValue: boolean;
408
420
  param: string;
@@ -984,13 +996,6 @@ export declare const editorExperimentsConfig: {
984
996
  typeGuard: (value: unknown) => value is 'control' | 'new-description' | 'orig-description';
985
997
  values: ('control' | 'new-description' | 'orig-description')[];
986
998
  };
987
- cc_fd_db_top_editor_toolbar_aa: {
988
- defaultValue: 'control' | 'new-description' | 'orig-description';
989
- param: string;
990
- productKeys?: ProductKeys;
991
- typeGuard: (value: unknown) => value is 'control' | 'new-description' | 'orig-description';
992
- values: ('control' | 'new-description' | 'orig-description')[];
993
- };
994
999
  platform_editor_smartlink_local_cache: {
995
1000
  defaultValue: boolean;
996
1001
  param: string;
@@ -118,6 +118,12 @@ export declare const editorExperimentsConfig: {
118
118
  productKeys?: ProductKeys;
119
119
  typeGuard: IsBooleanType;
120
120
  };
121
+ platform_editor_prosemirror_rendered_data: {
122
+ defaultValue: boolean;
123
+ param: string;
124
+ productKeys?: ProductKeys;
125
+ typeGuard: IsBooleanType;
126
+ };
121
127
  confluence_compact_text_format: {
122
128
  defaultValue: boolean;
123
129
  param: string;
@@ -403,6 +409,12 @@ export declare const editorExperimentsConfig: {
403
409
  productKeys?: ProductKeys;
404
410
  typeGuard: IsBooleanType;
405
411
  };
412
+ platform_editor_table_a11y_eslint_fix: {
413
+ defaultValue: boolean;
414
+ param: string;
415
+ productKeys?: ProductKeys;
416
+ typeGuard: IsBooleanType;
417
+ };
406
418
  platform_editor_find_and_replace_improvements: {
407
419
  defaultValue: boolean;
408
420
  param: string;
@@ -984,13 +996,6 @@ export declare const editorExperimentsConfig: {
984
996
  typeGuard: (value: unknown) => value is 'control' | 'new-description' | 'orig-description';
985
997
  values: ('control' | 'new-description' | 'orig-description')[];
986
998
  };
987
- cc_fd_db_top_editor_toolbar_aa: {
988
- defaultValue: 'control' | 'new-description' | 'orig-description';
989
- param: string;
990
- productKeys?: ProductKeys;
991
- typeGuard: (value: unknown) => value is 'control' | 'new-description' | 'orig-description';
992
- values: ('control' | 'new-description' | 'orig-description')[];
993
- };
994
999
  platform_editor_smartlink_local_cache: {
995
1000
  defaultValue: boolean;
996
1001
  param: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/tmp-editor-statsig",
3
- "version": "26.0.0",
3
+ "version": "27.1.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",