@atlaskit/tmp-editor-statsig 5.11.0 → 5.11.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-statsig-tmp
 
+## 5.11.1
+
+### Patch Changes
+
+- [#165694](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/165694)
+  [`2e1b7ff8a2e49`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2e1b7ff8a2e49) -
+  refactor: align expValEquals and expValEqualsNoExposure to jira and confluence APIs
+
 ## 5.11.0
 
 ### Minor Changes

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

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.expValEqualsInternal = expValEqualsInternal;
+var _featureGateJsClient = _interopRequireDefault(require("@atlaskit/feature-gate-js-client"));
+var _setup = require("./setup");
+/**
+ * Check the value if an editor experiment.
+ * Internal method that is shared between expValEquals and expValEqualsNoExposure.
+ *
+ * @example
+ * exportValEqualsInternal('example-boolean', 'paramName', true, null, true);
+ *
+ * @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 set
+ * @param experimentExposure - whether to fire an exposure event or not
+ *
+ * @returns boolean
+ */
+function expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, experimentExposure) {
+  // @ts-ignore need to loosen the type here to allow for any experiment name
+  if (_setup._overrides[experimentName] !== undefined) {
+    // This will be hit in the case of a test setting an override
+    // @ts-ignore need to loosen the type here to allow for any experiment name
+    return _setup._overrides[experimentName] === experimentExpectedValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  var experimentValue = _featureGateJsClient.default.getExperimentValue(experimentName, experimentParam, experimentDefaultValue, {
+    fireExperimentExposure: experimentExposure
+  });
+  return experimentValue === experimentExpectedValue;
+}

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

@@ -4,33 +4,32 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.expValEqualsNoExposure = expValEqualsNoExposure;
-var _experiments = require("./experiments");
+var _expValEqualsInternal = require("./exp-val-equals-internal");
 /**
- * Check the value if an editor experiment and without exposure.
+ * Check the value if an editor experiment without firing exposure.
  *
  * !!! Note: This method never fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEqualsNoExposure('example-boolean', true)) {
+ * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ * if (expValEqualsNoExposure('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-function expValEqualsNoExposure(experimentName, experimentExpectedValue) {
-  return (0, _experiments.editorExperiment)(experimentName, experimentExpectedValue, {
-    exposure: false
-  });
+function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue) {
+  return (0, _expValEqualsInternal.expValEqualsInternal)(experimentName, experimentParam, experimentExpectedValue, null, false);
 }

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

@@ -4,33 +4,32 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.expValEquals = expValEquals;
-var _experiments = require("./experiments");
+var _expValEqualsInternal = require("./exp-val-equals-internal");
 /**
  * Check the value if an editor experiment and fire exposure.
  *
  * !!! Note: This method always fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEquals('example-boolean', true)) {
+ * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEquals('example-multivariate', 'one')) {
+ * if (expValEquals('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-function expValEquals(experimentName, experimentExpectedValue) {
-  return (0, _experiments.editorExperiment)(experimentName, experimentExpectedValue, {
-    exposure: true
-  });
+function expValEquals(experimentName, experimentParam, experimentExpectedValue) {
+  return (0, _expValEqualsInternal.expValEqualsInternal)(experimentName, experimentParam, experimentExpectedValue, null, true);
 }

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

@@ -0,0 +1,32 @@
+import FeatureGates from '@atlaskit/feature-gate-js-client';
+import { _overrides } from './setup';
+
+/**
+ * Check the value if an editor experiment.
+ * Internal method that is shared between expValEquals and expValEqualsNoExposure.
+ *
+ * @example
+ * exportValEqualsInternal('example-boolean', 'paramName', true, null, true);
+ *
+ * @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 set
+ * @param experimentExposure - whether to fire an exposure event or not
+ *
+ * @returns boolean
+ */
+export function expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, experimentExposure) {
+  // @ts-ignore need to loosen the type here to allow for any experiment name
+  if (_overrides[experimentName] !== undefined) {
+    // This will be hit in the case of a test setting an override
+    // @ts-ignore need to loosen the type here to allow for any experiment name
+    return _overrides[experimentName] === experimentExpectedValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  const experimentValue = FeatureGates.getExperimentValue(experimentName, experimentParam, experimentDefaultValue, {
+    fireExperimentExposure: experimentExposure
+  });
+  return experimentValue === experimentExpectedValue;
+}

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

@@ -1,31 +1,29 @@
-import { editorExperiment } from './experiments';
-
+import { expValEqualsInternal } from './exp-val-equals-internal';
 /**
- * Check the value if an editor experiment and without exposure.
+ * Check the value if an editor experiment without firing exposure.
  *
  * !!! Note: This method never fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEqualsNoExposure('example-boolean', true)) {
+ * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ * if (expValEqualsNoExposure('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export function expValEqualsNoExposure(experimentName, experimentExpectedValue) {
-  return editorExperiment(experimentName, experimentExpectedValue, {
-    exposure: false
-  });
+export function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue) {
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, false);
 }

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

@@ -1,31 +1,29 @@
-import { editorExperiment } from './experiments';
-
+import { expValEqualsInternal } from './exp-val-equals-internal';
 /**
  * Check the value if an editor experiment and fire exposure.
  *
  * !!! Note: This method always fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEquals('example-boolean', true)) {
+ * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEquals('example-multivariate', 'one')) {
+ * if (expValEquals('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export function expValEquals(experimentName, experimentExpectedValue) {
-  return editorExperiment(experimentName, experimentExpectedValue, {
-    exposure: true
-  });
+export function expValEquals(experimentName, experimentParam, experimentExpectedValue) {
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, true);
 }

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

@@ -0,0 +1,32 @@
+import FeatureGates from '@atlaskit/feature-gate-js-client';
+import { _overrides } from './setup';
+
+/**
+ * Check the value if an editor experiment.
+ * Internal method that is shared between expValEquals and expValEqualsNoExposure.
+ *
+ * @example
+ * exportValEqualsInternal('example-boolean', 'paramName', true, null, true);
+ *
+ * @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 set
+ * @param experimentExposure - whether to fire an exposure event or not
+ *
+ * @returns boolean
+ */
+export function expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, experimentExposure) {
+  // @ts-ignore need to loosen the type here to allow for any experiment name
+  if (_overrides[experimentName] !== undefined) {
+    // This will be hit in the case of a test setting an override
+    // @ts-ignore need to loosen the type here to allow for any experiment name
+    return _overrides[experimentName] === experimentExpectedValue;
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  var experimentValue = FeatureGates.getExperimentValue(experimentName, experimentParam, experimentDefaultValue, {
+    fireExperimentExposure: experimentExposure
+  });
+  return experimentValue === experimentExpectedValue;
+}

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

@@ -1,31 +1,29 @@
-import { editorExperiment } from './experiments';
-
+import { expValEqualsInternal } from './exp-val-equals-internal';
 /**
- * Check the value if an editor experiment and without exposure.
+ * Check the value if an editor experiment without firing exposure.
  *
  * !!! Note: This method never fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEqualsNoExposure('example-boolean', true)) {
+ * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ * if (expValEqualsNoExposure('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export function expValEqualsNoExposure(experimentName, experimentExpectedValue) {
-  return editorExperiment(experimentName, experimentExpectedValue, {
-    exposure: false
-  });
+export function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue) {
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, false);
 }

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

@@ -1,31 +1,29 @@
-import { editorExperiment } from './experiments';
-
+import { expValEqualsInternal } from './exp-val-equals-internal';
 /**
  * Check the value if an editor experiment and fire exposure.
  *
  * !!! Note: This method always fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEquals('example-boolean', true)) {
+ * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEquals('example-multivariate', 'one')) {
+ * if (expValEquals('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export function expValEquals(experimentName, experimentExpectedValue) {
-  return editorExperiment(experimentName, experimentExpectedValue, {
-    exposure: true
-  });
+export function expValEquals(experimentName, experimentParam, experimentExpectedValue) {
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, true);
 }

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

@@ -0,0 +1,17 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value if an editor experiment.
+ * Internal method that is shared between expValEquals and expValEqualsNoExposure.
+ *
+ * @example
+ * exportValEqualsInternal('example-boolean', 'paramName', true, null, true);
+ *
+ * @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 set
+ * @param experimentExposure - whether to fire an exposure event or not
+ *
+ * @returns boolean
+ */
+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;

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

@@ -1,26 +1,27 @@
 import { type EditorExperimentsConfig } from './experiments-config';
 /**
- * Check the value if an editor experiment and without exposure.
+ * Check the value if an editor experiment without firing exposure.
  *
  * !!! Note: This method never fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEqualsNoExposure('example-boolean', true)) {
+ * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ * if (expValEqualsNoExposure('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig, ExperimentValue extends EditorExperimentsConfig[ExperimentName]['defaultValue']>(experimentName: ExperimentName, experimentExpectedValue: ExperimentValue): boolean;
+export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;

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

@@ -5,22 +5,23 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * !!! Note: This method always fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEquals('example-boolean', true)) {
+ * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEquals('example-multivariate', 'one')) {
+ * if (expValEquals('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig, ExperimentValue extends EditorExperimentsConfig[ExperimentName]['defaultValue']>(experimentName: ExperimentName, experimentExpectedValue: ExperimentValue): boolean;
+export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;

package/dist/types-ts4.5/exp-val-equals-internal.d.ts

@@ -0,0 +1,17 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value if an editor experiment.
+ * Internal method that is shared between expValEquals and expValEqualsNoExposure.
+ *
+ * @example
+ * exportValEqualsInternal('example-boolean', 'paramName', true, null, true);
+ *
+ * @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 set
+ * @param experimentExposure - whether to fire an exposure event or not
+ *
+ * @returns boolean
+ */
+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;

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

@@ -1,26 +1,27 @@
 import { type EditorExperimentsConfig } from './experiments-config';
 /**
- * Check the value if an editor experiment and without exposure.
+ * Check the value if an editor experiment without firing exposure.
  *
  * !!! Note: This method never fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEqualsNoExposure('example-boolean', true)) {
+ * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ * if (expValEqualsNoExposure('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig, ExperimentValue extends EditorExperimentsConfig[ExperimentName]['defaultValue']>(experimentName: ExperimentName, experimentExpectedValue: ExperimentValue): boolean;
+export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;

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

@@ -5,22 +5,23 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * !!! Note: This method always fires exposure. !!!
  *
  * @example Boolean experiment
- * if (expValEquals('example-boolean', true)) {
+ * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
  * } else {
  *   // Run code for off variant
  * }
  *
  * @example Multivariate experiment
- * if (expValEquals('example-multivariate', 'one')) {
+ * if (expValEquals('example-multivariate', 'cohort', 'one')) {
  *   // Run code for 'one' variant
  * } else {
  *   // Run code for control
  * }
  *
  * @param experimentName - experiment key
+ * @param experimentParam - the name of the parameter to fetch from the experiment config
  * @param experimentExpectedValue - expected value to compare with
  *
  * @returns boolean
  */
-export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig, ExperimentValue extends EditorExperimentsConfig[ExperimentName]['defaultValue']>(experimentName: ExperimentName, experimentExpectedValue: ExperimentValue): boolean;
+export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/tmp-editor-statsig",
-	"version": "5.11.0",
+	"version": "5.11.1",
 	"description": "Temp plugin to ease use of statsig feature flags until platform feature flags are available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",