@atlaskit/tmp-editor-statsig 8.2.0 → 8.3.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-statsig-tmp
 
+## 8.3.0
+
+### Minor Changes
+
+- [#177692](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/177692)
+  [`19ab0513e027f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/19ab0513e027f) -
+  Add defaultValue parameter to expValEq and expValEqNoExposure to allow for checking default state
+  (e.g. false state) and avoid issue when experiment is not defined
+
 ## 8.2.0
 
 ### Minor Changes

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

@@ -10,6 +10,8 @@ var _expValEqualsInternal = require("./exp-val-equals-internal");
  *
  * !!! Note: This method never fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -27,9 +29,11 @@ var _expValEqualsInternal = require("./exp-val-equals-internal");
  * @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 defined.
  *
  * @returns boolean
  */
 function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue) {
-  return (0, _expValEqualsInternal.expValEqualsInternal)(experimentName, experimentParam, experimentExpectedValue, null, false);
+  var experimentDefaultValue = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
+  return (0, _expValEqualsInternal.expValEqualsInternal)(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, false);
 }

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

@@ -10,6 +10,8 @@ var _expValEqualsInternal = require("./exp-val-equals-internal");
  *
  * !!! Note: This method always fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -27,9 +29,11 @@ var _expValEqualsInternal = require("./exp-val-equals-internal");
  * @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 defined.
  *
  * @returns boolean
  */
 function expValEquals(experimentName, experimentParam, experimentExpectedValue) {
-  return (0, _expValEqualsInternal.expValEqualsInternal)(experimentName, experimentParam, experimentExpectedValue, null, true);
+  var experimentDefaultValue = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
+  return (0, _expValEqualsInternal.expValEqualsInternal)(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, true);
 }

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

@@ -4,6 +4,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * !!! Note: This method never fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,9 +23,10 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  * @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 defined.
  *
  * @returns boolean
  */
-export function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue) {
-  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, false);
+export function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue = null) {
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, false);
 }

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

@@ -4,6 +4,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * !!! Note: This method always fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,9 +23,10 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  * @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 defined.
  *
  * @returns boolean
  */
-export function expValEquals(experimentName, experimentParam, experimentExpectedValue) {
-  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, true);
+export function expValEquals(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue = null) {
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, true);
 }

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

@@ -4,6 +4,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * !!! Note: This method never fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,9 +23,11 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  * @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 defined.
  *
  * @returns boolean
  */
 export function expValEqualsNoExposure(experimentName, experimentParam, experimentExpectedValue) {
-  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, false);
+  var experimentDefaultValue = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, false);
 }

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

@@ -4,6 +4,8 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  *
  * !!! Note: This method always fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,9 +23,11 @@ import { expValEqualsInternal } from './exp-val-equals-internal';
  * @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 defined.
  *
  * @returns boolean
  */
 export function expValEquals(experimentName, experimentParam, experimentExpectedValue) {
-  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, null, true);
+  var experimentDefaultValue = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
+  return expValEqualsInternal(experimentName, experimentParam, experimentExpectedValue, experimentDefaultValue, true);
 }

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

@@ -4,6 +4,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  *
  * !!! Note: This method never fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,7 +23,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * @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 defined.
  *
  * @returns boolean
  */
-export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;
+export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue?: EditorExperimentsConfig[ExperimentName]['defaultValue'] | null): boolean;

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

@@ -4,6 +4,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  *
  * !!! Note: This method always fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,7 +23,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * @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 defined.
  *
  * @returns boolean
  */
-export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;
+export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue?: EditorExperimentsConfig[ExperimentName]['defaultValue'] | null): boolean;

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

@@ -4,6 +4,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  *
  * !!! Note: This method never fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEqualsNoExposure('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,7 +23,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * @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 defined.
  *
  * @returns boolean
  */
-export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;
+export declare function expValEqualsNoExposure<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue?: EditorExperimentsConfig[ExperimentName]['defaultValue'] | null): boolean;

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

@@ -4,6 +4,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  *
  * !!! Note: This method always fires exposure. !!!
  *
+ * IMPORTANT: If experiment is not defined default value will be null, unless provided otherwise.
+ *
  * @example Boolean experiment
  * if (expValEquals('example-boolean', 'isEnabled', true)) {
  *   // Run code for on variant
@@ -21,7 +23,8 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * @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 defined.
  *
  * @returns boolean
  */
-export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue']): boolean;
+export declare function expValEquals<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, experimentParam: EditorExperimentsConfig[ExperimentName]['param'], experimentExpectedValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], experimentDefaultValue?: EditorExperimentsConfig[ExperimentName]['defaultValue'] | null): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/tmp-editor-statsig",
-	"version": "8.2.0",
+	"version": "8.3.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",