@atlaskit/tmp-editor-statsig 147.1.0 → 148.1.0

package/dist/esm/one-of.js

@@ -0,0 +1,14 @@
+var _process, _process2;
+var IS_TESTING_ENV = typeof process !== 'undefined' && (((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.NODE_ENV) === 'test' || ((_process2 = process) === null || _process2 === void 0 || (_process2 = _process2.env) === null || _process2 === void 0 ? void 0 : _process2.JEST_WORKER_ID) !== undefined);
+export function oneOf(values) {
+  function typeGuard(value) {
+    return values.includes(value);
+  }
+  /**
+   * This is used by test utils to get the variants when running describe.each
+   */
+  if (IS_TESTING_ENV) {
+    typeGuard.values = values;
+  }
+  return typeGuard;
+}

package/dist/esm/setup.js

@@ -38,7 +38,6 @@ paramOverrides, options) {
     // values.
     // For production usage -- this is done via the feature flag client which takes the type
     // and performs equivalent logic.
-    // @ts-ignore
     groupOverrides = Object.entries(groupOverrides).reduce(function (acc, _ref) {
       var _ref2 = _slicedToArray(_ref, 2),
         key = _ref2[0],

package/dist/esm/type-guards.js

@@ -1,20 +0,0 @@
-var _process, _process2;
-export function isBoolean(value) {
-  return typeof value === 'boolean';
-}
-export function oneOf(values) {
-  function typeGuard(value) {
-    return values.includes(value);
-  }
-  /**
-   * This is used by test utils to get the variants when running describe.each
-   */
-  if (IS_TESTING_ENV) {
-    typeGuard.values = values;
-  }
-  return typeGuard;
-}
-
-// @ts-ignore
-
-var IS_TESTING_ENV = typeof process !== 'undefined' && (((_process = process) === null || _process === void 0 || (_process = _process.env) === null || _process === void 0 ? void 0 : _process.NODE_ENV) === 'test' || ((_process2 = process) === null || _process2 === void 0 || (_process2 = _process2.env) === null || _process2 === void 0 ? void 0 : _process2.JEST_WORKER_ID) !== undefined);

package/dist/esm/unstable-editor-experiment-param.js

@@ -0,0 +1,31 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
+import { _paramOverrides } from './setup';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+
+/**
+ * @warning This currently lacks type safety on the param names and return values
+ * and has limited associated test tooling.
+ *
+ * It also only works for experiments where the key matches the productKey used.
+ *
+ * The typeguard and default value is also expected to move to the experiment config
+ */
+export function unstable_editorExperimentParam(experimentName, paramName, options) {
+  var _paramOverrides$exper, _options$exposure;
+  if (((_paramOverrides$exper = _paramOverrides[experimentName]) === null || _paramOverrides$exper === void 0 ? void 0 : _paramOverrides$exper[paramName]) !== undefined) {
+    // This will be hit in the case of a test setting an override
+
+    return _paramOverrides[experimentName][paramName];
+  }
+
+  // eslint-disable-next-line @atlaskit/platform/use-recommended-utils
+  var experimentValue = FeatureGates.getExperimentValue(experimentName, paramName, options.defaultValue, {
+    typeGuard: options.typeGuard,
+    fireExperimentExposure: (_options$exposure = options.exposure) !== null && _options$exposure !== void 0 ? _options$exposure : false
+  });
+  return experimentValue;
+}

package/dist/types/create-boolean-experiment.d.ts

@@ -0,0 +1,11 @@
+import { isBoolean } from './is-boolean';
+import type { BooleanExperimentConfig, ProductKeys } from './types';
+/**
+ * Helper to create a boolean experiment configuration
+ */
+export declare function createBooleanExperiment(config: BooleanExperimentConfig): {
+    defaultValue: boolean;
+    param: string;
+    productKeys?: ProductKeys;
+    typeGuard: typeof isBoolean;
+};

package/dist/types/create-multivariate-experiment.d.ts

@@ -0,0 +1,11 @@
+import type { MultivariateExperimentConfig, ProductKeys } from './types';
+/**
+ * Helper to create a multivariate experiment configuration
+ */
+export declare function createMultivariateExperiment<T extends string[]>(config: MultivariateExperimentConfig<T>): {
+    defaultValue: T[number];
+    param: string;
+    productKeys?: ProductKeys;
+    typeGuard: (value: unknown) => value is T[number];
+    values: [...T][number][];
+};

package/dist/types/editor-experiment.d.ts

@@ -0,0 +1,52 @@
+import type { EditorExperimentsConfig } from './experiments-config';
+/**
+ * Check the value of an editor experiment.
+ *
+ * Note: By default this will not fire an [exposure event](https://hello.atlassian.net/wiki/spaces/~732385844/pages/3187295823/Exposure+Events+101).
+ *
+ * You need explicitly call it using the exposure property when you need an exposure event to be fired (all experiments should fire exposure events).
+ *
+ * @example Boolean experiment
+ * ```ts
+ * if (editorExperiment('example-boolean', true)) {
+ *   // Run code for on variant
+ * } else {
+ *   // Run code for off variant
+ * }
+ * ```
+ *
+ * @example Multivariate experiment
+ * ```ts
+ * switch (true) {
+ * 	 case editorExperiment('example-multivariate', 'one'):
+ *   	 // Run code for variant one
+ *   break;
+ *   case editorExperiment('example-multivariate', 'two'):
+ *     // Run code for variant two
+ *     break;
+ *   case editorExperiment('example-multivariate', 'three'):
+ *     // Run code for variant three
+ *     break;
+ *   }
+ * }
+ *```
+
+ @example Experiment with exposure event
+ * ```ts
+ * // Inside feature surface where either the control or variant should be shown
+ * if (editorExperiment('example-boolean', true, { exposure: true })) {
+ * 	// Run code for on variant
+ * } else {
+ * 	// Run code for off variant
+ * }
+ * ```
+ *
+ * @private
+ * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
+ *             ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
+ *             It also closely aligns with similar utilities in other Atlassian products.
+ *             For no exposure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
+ */
+export declare function editorExperiment<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, expectedExperimentValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], options?: {
+    exposure: boolean;
+}): boolean;

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

@@ -0,0 +1,2 @@
+import type { EditorExperimentsConfig } from './experiments-config';
+export declare function expValNoExposure<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue;

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

@@ -0,0 +1,18 @@
+import type { EditorExperimentsConfig } from './experiments-config';
+/**
+ * Use to check a any param value for an experiment
+ *
+ * **Note**: this will return the default value when the experiment;
+ * - is not being served to the client (ie. pre start)
+ * - or is not configured in experiments-config
+ *
+ * If you need to check a param value without an exposure check see
+ * {@link import('./exp-val-no-exposure').expValNoExposure}
+ *
+ * @example
+ * ```ts
+ * const delay = expVal('experiment-name', 'param-name', defaultValue)
+ * await new Promise(res => setTimeout(res, delay)
+ * ```
+ */
+export declare function expVal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue;

package/dist/types/expVal.d.ts

@@ -1,30 +1,15 @@
 import type { EditorExperimentsConfig } from './experiments-config';
+export declare function expValInternal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>({ experimentName, experimentParam, defaultValue, fireExperimentExposure, }: {
+    defaultValue: DefaultValue;
+    experimentName: ExperimentName;
+    experimentParam: string;
+    fireExperimentExposure: boolean;
+}): DefaultValue;
 /**
- * Use to check a any param value for an experiment
- *
- * **Note**: this will return the default value when the experiment;
- * - is not being served to the client (ie. pre start)
- * - or is not configured in experiments-config
- *
- * If you need to check a param value without an exposure check see {@link expValNoExposure}
- *
- * @example
- * ```ts
- * const delay = expVal('experiment-name', 'param-name', defaultValue)
- * await new Promise(res => setTimeout(res, delay)
- * ```
+ * @deprecated Use `import { expVal } from '@atlaskit/tmp-editor-statsig/expVal'` instead.
  */
-export declare function expVal<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue; /**
- * Use to check a any param value for an experiment without firing an exposure event
- *
- * **Note**: this will return the default value when the experiment;
- * - is not being served to the client (ie. pre start)
- * - or is not configured in experiments-config
- *
- * @example
- * ```ts
- * const delay = expParamEqualsNoExposure('experiment-name', 'param-name', defaultValue)
- * await new Promise(res => setTimeout(res, delay)
- * ```
+export { expVal } from './exp-val';
+/**
+ * @deprecated Use `import { expValNoExposure } from '@atlaskit/tmp-editor-statsig/expVal'` instead.
  */
-export declare function expValNoExposure<ExperimentName extends keyof EditorExperimentsConfig, DefaultValue extends string | number | boolean>(experimentName: ExperimentName, experimentParam: string, defaultValue: DefaultValue extends boolean ? false : DefaultValue): DefaultValue;
+export { expValNoExposure } from './exp-val-no-exposure';

package/dist/types/experiments-config.d.ts

@@ -1,4 +1,4 @@
-import { isBoolean } from './type-guards';
+import { isBoolean } from './is-boolean';
 import type { ProductKeys } from './types';
 type IsBooleanType = typeof isBoolean;
 export type EditorExperimentsConfig = typeof editorExperimentsConfig;
@@ -112,12 +112,6 @@ export declare const editorExperimentsConfig: {
         productKeys?: ProductKeys;
         typeGuard: IsBooleanType;
     };
-    platform_editor_dom_node_count: {
-        defaultValue: boolean;
-        param: string;
-        productKeys?: ProductKeys;
-        typeGuard: IsBooleanType;
-    };
     cc_editor_fix_insm_inp_buffer: {
         defaultValue: boolean;
         param: string;

package/dist/types/experiments.d.ts

@@ -1,67 +1,8 @@
-import type { EditorExperimentsConfig } from './experiments-config';
 /**
- * Check the value of an editor experiment.
- *
- * Note: By default this will not fire an [exposure event](https://hello.atlassian.net/wiki/spaces/~732385844/pages/3187295823/Exposure+Events+101).
- *
- * You need explicitly call it using the exposure property when you need an exposure event to be fired (all experiments should fire exposure events).
- *
- * @example Boolean experiment
- * ```ts
- * if (editorExperiment('example-boolean', true)) {
- *   // Run code for on variant
- * } else {
- *   // Run code for off variant
- * }
- * ```
- *
- * @example Multivariate experiment
- * ```ts
- * switch (true) {
- * 	 case editorExperiment('example-multivariate', 'one'):
- *   	 // Run code for variant one
- *   break;
- *   case editorExperiment('example-multivariate', 'two'):
- *     // Run code for variant two
- *     break;
- *   case editorExperiment('example-multivariate', 'three'):
- *     // Run code for variant three
- *     break;
- *   }
- * }
- *```
-
- @example Experiment with exposure event
- * ```ts
- * // Inside feature surface where either the control or variant should be shown
- * if (editorExperiment('example-boolean', true, { exposure: true })) {
- * 	// Run code for on variant
- * } else {
- * 	// Run code for off variant
- * }
- * ```
- *
- * @private
- * @deprecated This utility is deprecated in favour of using `expValEquals` from `@atlaskit/tmp-editor-statsig/exp-val-equals`.
- *             ExpValEquals fires exposure events by default preventing cases when consumers of exitorExperiment forget to pass the `exposure` option.
- *             It also closely aligns with similar utilities in other Atlassian products.
- *             For no exposure option use `expValEqualsNoExposure` from `@atlaskit/tmp-editor-statsig/exp-val-equals-no-exposure`.
+ * @deprecated Use `import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments'` instead.
  */
-export declare function editorExperiment<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, expectedExperimentValue: EditorExperimentsConfig[ExperimentName]['defaultValue'], options?: {
-    exposure: boolean;
-}): boolean;
-type Unstable_EditorExperimentParams = {};
+export { editorExperiment } from './editor-experiment';
 /**
- * @warning This currently lacks type safety on the param names and return values
- * and has limited associated test tooling.
- *
- * It also only works for experiments where the key matches the productKey used.
- *
- * The typeguard and default value is also expected to move to the experiment config
+ * @deprecated Use `import { unstable_editorExperimentParam } from '@atlaskit/tmp-editor-statsig/experiments'` instead.
  */
-export declare function unstable_editorExperimentParam<ExperimentName extends keyof Unstable_EditorExperimentParams, ParamKey extends Unstable_EditorExperimentParams[ExperimentName]['params'], ParamValue = unknown>(experimentName: ExperimentName, paramName: ParamKey, options: {
-    defaultValue: ParamValue;
-    exposure?: boolean;
-    typeGuard: (value: unknown) => value is ParamValue;
-}): ParamValue;
-export {};
+export { unstable_editorExperimentParam } from './unstable-editor-experiment-param';

package/dist/types/is-boolean.d.ts

@@ -0,0 +1 @@
+export declare function isBoolean(value: unknown): value is boolean;

package/dist/types/one-of.d.ts

@@ -0,0 +1 @@
+export declare function oneOf<T extends string>(values: T[]): (value: unknown) => value is T;

package/dist/types/type-guards.d.ts

@@ -1,2 +1,8 @@
-export declare function isBoolean(value: unknown): value is boolean;
-export declare function oneOf<T extends string>(values: T[]): (value: unknown) => value is T;
+type Global = globalThis.Window & typeof globalThis & {
+    process: {
+        env: {
+            JEST_WORKER_ID: string;
+            NODE_ENV: string;
+        };
+    };
+};

package/dist/types/unstable-editor-experiment-param.d.ts

@@ -0,0 +1,15 @@
+type Unstable_EditorExperimentParams = {};
+/**
+ * @warning This currently lacks type safety on the param names and return values
+ * and has limited associated test tooling.
+ *
+ * It also only works for experiments where the key matches the productKey used.
+ *
+ * The typeguard and default value is also expected to move to the experiment config
+ */
+export declare function unstable_editorExperimentParam<ExperimentName extends keyof Unstable_EditorExperimentParams, ParamKey extends Unstable_EditorExperimentParams[ExperimentName]['params'], ParamValue = unknown>(experimentName: ExperimentName, paramName: ParamKey, options: {
+    defaultValue: ParamValue;
+    exposure?: boolean;
+    typeGuard: (value: unknown) => value is ParamValue;
+}): ParamValue;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/tmp-editor-statsig",
-	"version": "147.1.0",
+	"version": "148.1.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",
@@ -27,7 +27,7 @@
 	"dependencies": {
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
-		"@atlaskit/react-ufo": "^7.5.0",
+		"@atlaskit/react-ufo": "^7.6.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"platform-feature-flags": {

package/dist/types/experiment-builders.d.ts

@@ -1,21 +0,0 @@
-import { isBoolean } from './type-guards';
-import type { BooleanExperimentConfig, MultivariateExperimentConfig, ProductKeys } from './types';
-/**
- * Helper to create a boolean experiment configuration
- */
-export declare function createBooleanExperiment(config: BooleanExperimentConfig): {
-    defaultValue: boolean;
-    param: string;
-    productKeys?: ProductKeys;
-    typeGuard: typeof isBoolean;
-};
-/**
- * Helper to create a multivariate experiment configuration
- */
-export declare function createMultivariateExperiment<T extends string[]>(config: MultivariateExperimentConfig<T>): {
-    defaultValue: T[number];
-    param: string;
-    productKeys?: ProductKeys;
-    typeGuard: (value: unknown) => value is T[number];
-    values: [...T][number][];
-};