@atlaskit/tmp-editor-statsig 5.7.0 → 5.8.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-statsig-tmp
 
+## 5.8.0
+
+### Minor Changes
+
+- [#163510](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/163510)
+  [`82ae25a1f9aaa`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/82ae25a1f9aaa) -
+  Adds expValEquals and expValEqualsNoExposure methods
+
 ## 5.7.0
 
 ### Minor Changes

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

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.expValEqualsNoExposure = expValEqualsNoExposure;
+var _experiments = require("./experiments");
+/**
+ * Check the value if an editor experiment and without exposure.
+ *
+ * !!! Note: This method never fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEqualsNoExposure('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @param experimentExpectedValue - expected value to compare with
+ *
+ * @returns boolean
+ */
+function expValEqualsNoExposure(experimentName, experimentExpectedValue) {
+  return (0, _experiments.editorExperiment)(experimentName, experimentExpectedValue, {
+    exposure: false
+  });
+}

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

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.expValEquals = expValEquals;
+var _experiments = require("./experiments");
+/**
+ * Check the value if an editor experiment and fire exposure.
+ *
+ * !!! Note: This method always fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEquals('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEquals('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @param experimentExpectedValue - expected value to compare with
+ *
+ * @returns boolean
+ */
+function expValEquals(experimentName, experimentExpectedValue) {
+  return (0, _experiments.editorExperiment)(experimentName, experimentExpectedValue, {
+    exposure: true
+  });
+}

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

@@ -0,0 +1,31 @@
+import { editorExperiment } from './experiments';
+
+/**
+ * Check the value if an editor experiment and without exposure.
+ *
+ * !!! Note: This method never fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEqualsNoExposure('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @param experimentExpectedValue - expected value to compare with
+ *
+ * @returns boolean
+ */
+export function expValEqualsNoExposure(experimentName, experimentExpectedValue) {
+  return editorExperiment(experimentName, experimentExpectedValue, {
+    exposure: false
+  });
+}

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

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

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

@@ -0,0 +1,31 @@
+import { editorExperiment } from './experiments';
+
+/**
+ * Check the value if an editor experiment and without exposure.
+ *
+ * !!! Note: This method never fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEqualsNoExposure('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @param experimentExpectedValue - expected value to compare with
+ *
+ * @returns boolean
+ */
+export function expValEqualsNoExposure(experimentName, experimentExpectedValue) {
+  return editorExperiment(experimentName, experimentExpectedValue, {
+    exposure: false
+  });
+}

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

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

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

@@ -0,0 +1,26 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value if an editor experiment and without exposure.
+ *
+ * !!! Note: This method never fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEqualsNoExposure('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @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;

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

@@ -0,0 +1,26 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value if an editor experiment and fire exposure.
+ *
+ * !!! Note: This method always fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEquals('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEquals('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @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;

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

@@ -0,0 +1,26 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value if an editor experiment and without exposure.
+ *
+ * !!! Note: This method never fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEqualsNoExposure('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEqualsNoExposure('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @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;

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

@@ -0,0 +1,26 @@
+import { type EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value if an editor experiment and fire exposure.
+ *
+ * !!! Note: This method always fires exposure. !!!
+ *
+ * @example Boolean experiment
+ * if (expValEquals('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ *
+ * @example Multivariate experiment
+ * if (expValEquals('example-multivariate', 'one')) {
+ *   // Run code for 'one' variant
+ * } else {
+ *   // Run code for control
+ * }
+ *
+ * @param experimentName - experiment key
+ * @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;

package/exp-val-equals/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@atlaskit/tmp-editor-statsig/exp-val-equals",
+  "main": "../dist/cjs/exp-val-equals.js",
+  "module": "../dist/esm/exp-val-equals.js",
+  "module:es2019": "../dist/es2019/exp-val-equals.js",
+  "types": "../dist/types/exp-val-equals.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/exp-val-equals.d.ts"
+      ]
+    }
+  }
+}

package/exp-val-equals-no-exposure/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure",
+  "main": "../dist/cjs/exp-val-equals-no-exposure.js",
+  "module": "../dist/esm/exp-val-equals-no-exposure.js",
+  "module:es2019": "../dist/es2019/exp-val-equals-no-exposure.js",
+  "types": "../dist/types/exp-val-equals-no-exposure.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/exp-val-equals-no-exposure.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/tmp-editor-statsig",
-	"version": "5.7.0",
+	"version": "5.8.0",
 	"description": "Temp plugin to ease use of statsig feature flags until platform feature flags are available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,7 +36,9 @@
 		"./setup": "./src/setup.ts",
 		"./experiments": "./src/experiments.ts",
 		"./experiments-config": "./src/experiments-config.ts",
-		"./editor-experiments-test-utils": "./src/editor-experiments-test-utils.ts"
+		"./editor-experiments-test-utils": "./src/editor-experiments-test-utils.ts",
+		"./exp-val-equals": "./src/exp-val-equals.ts",
+		"./exp-val-equals-no-exposure": "./src/exp-val-equals-no-exposure.ts"
 	},
 	"dependencies": {
 		"@atlaskit/feature-gate-js-client": "^5.3.0",