@atlaskit/tmp-editor-statsig 5.11.1 → 5.12.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,13 @@
1
1
  # @atlaskit/editor-statsig-tmp
2
2
 
3
+ ## 5.12.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#165835](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/165835)
8
+ [`b7143f7822214`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b7143f7822214) -
9
+ Deprecate editorExperiments in favour of expValEquals
10
+
3
11
  ## 5.11.1
4
12
 
5
13
  ### Patch Changes
@@ -53,6 +53,12 @@ var _setup = require("./setup");
53
53
  * // Run code for off variant
54
54
  * }
55
55
  * ```
56
+ *
57
+ * @private
58
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
59
+ * ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
60
+ * It also closely aligns with similar utilities in other Atlassian products.
61
+ * For no expisure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
56
62
  */
57
63
  function editorExperiment(experimentName, expectedExperimentValue) {
58
64
  var _experimentConfig$pro;
@@ -46,6 +46,12 @@ import { _overrides, _paramOverrides, _product } from './setup';
46
46
  * // Run code for off variant
47
47
  * }
48
48
  * ```
49
+ *
50
+ * @private
51
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
52
+ * ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
53
+ * It also closely aligns with similar utilities in other Atlassian products.
54
+ * For no expisure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
49
55
  */
50
56
  export function editorExperiment(experimentName, expectedExperimentValue, options = {
51
57
  exposure: false
@@ -46,6 +46,12 @@ import { _overrides, _paramOverrides, _product } from './setup';
46
46
  * // Run code for off variant
47
47
  * }
48
48
  * ```
49
+ *
50
+ * @private
51
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
52
+ * ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
53
+ * It also closely aligns with similar utilities in other Atlassian products.
54
+ * For no expisure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
49
55
  */
50
56
  export function editorExperiment(experimentName, expectedExperimentValue) {
51
57
  var _experimentConfig$pro;
@@ -40,6 +40,12 @@ import { type EditorExperimentsConfig } from './experiments-config';
40
40
  * // Run code for off variant
41
41
  * }
42
42
  * ```
43
+ *
44
+ * @private
45
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
46
+ * ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
47
+ * It also closely aligns with similar utilities in other Atlassian products.
48
+ * For no expisure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
43
49
  */
44
50
  export declare function editorExperiment<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, expectedExperimentValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], options?: {
45
51
  exposure: boolean;
@@ -40,6 +40,12 @@ import { type EditorExperimentsConfig } from './experiments-config';
40
40
  * // Run code for off variant
41
41
  * }
42
42
  * ```
43
+ *
44
+ * @private
45
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
46
+ * ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
47
+ * It also closely aligns with similar utilities in other Atlassian products.
48
+ * For no expisure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
43
49
  */
44
50
  export declare function editorExperiment<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, expectedExperimentValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], options?: {
45
51
  exposure: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/tmp-editor-statsig",
3
- "version": "5.11.1",
3
+ "version": "5.12.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",