@atlaskit/tmp-editor-statsig 101.0.0 → 103.0.0

package/dist/types-ts4.5/experiments.d.ts

@@ -1,67 +0,0 @@
-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;
-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/dist/types-ts4.5/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types-ts4.5/setup.d.ts

@@ -1,40 +0,0 @@
-import { editorExperimentsConfig } from './experiments-config';
-export type EditorExperimentOverrides = Partial<{
-    [ExperimentName in keyof typeof editorExperimentsConfig]: (typeof editorExperimentsConfig)[ExperimentName]['defaultValue'];
-}>;
-export type EditorExperimentParamOverrides = {
-    [experimentName: string]: {
-        [paramName: string]: any;
-    };
-};
-export declare let _overrides: EditorExperimentOverrides;
-export declare let _paramOverrides: EditorExperimentParamOverrides;
-export declare let _product: 'bitbucket' | 'confluence' | 'jira' | 'test' | undefined;
-/**
- * This function is used to set up the editor experiments for testing purposes.
- * It should be called before running code that depends on editor experiments.
- *
- * @example
- * ```ts
- * setupEditorExperiments('confluence', {
- *  'experiment-name': 'value',
- * });
- * ```
- */
-export declare function setupEditorExperiments(product: 'bitbucket' | 'confluence' | 'jira' | 'test', 
-/**
- * Overrides are used to set the group of an experiment for testing purposes.
- * This is useful when you want to test a specific experiment group.
- */
-groupOverrides?: EditorExperimentOverrides, 
-/**
- * Param overrides are used to set the experiment parameters for testing purposes.
- * This is useful when you want to tweak the experiment parameters for testing.
- */
-paramOverrides?: EditorExperimentParamOverrides, options?: {
-    /**
-     * By default, boolean experiments are enabled when using `product === test`
-     * This option allows you to disable this behaviour (ie. for examples)
-     */
-    disableTestOverrides?: boolean;
-}): void;

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

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

package/dist/types-ts4.5/types.d.ts

@@ -1,32 +0,0 @@
-/**
- * Used only for documentation/testing purpose
- */
-export type ProductKeys = {
-    bitbucket?: string;
-    confluence?: string;
-    jira?: string;
-    test?: string;
-};
-export type ExperimentConfigValue = {
-    param: string;
-    productKeys?: ProductKeys;
-    typeGuard: (value: unknown) => boolean;
-} & ({
-    defaultValue: boolean;
-} | {
-    defaultValue: string;
-    values: string[];
-});
-export type BooleanExperimentConfig = {
-    defaultValue: boolean;
-    param: string;
-    productKeys?: ProductKeys;
-};
-export type MultivariateExperimentConfig<T extends string[]> = {
-    defaultValue: T[number];
-    param: string;
-    productKeys?: ProductKeys;
-    values: [
-        ...T
-    ];
-};