@atlaskit/tmp-editor-statsig 148.0.0 → 149.0.0

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;
@@ -792,12 +792,6 @@ export declare const editorExperimentsConfig: {
         productKeys?: ProductKeys;
         typeGuard: IsBooleanType;
     };
-    platform_synced_block: {
-        defaultValue: boolean;
-        param: string;
-        productKeys?: ProductKeys;
-        typeGuard: IsBooleanType;
-    };
     platform_editor_sync_block_activation: {
         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": "148.0.0",
+	"version": "149.0.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",

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][];
-};