@atlaskit/tmp-editor-statsig 2.1.14 → 2.2.0

package/dist/esm/editor-experiments-test-utils.js

@@ -1,5 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -7,7 +10,6 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 
 import { setupEditorExperiments } from './setup';
 import { editorExperimentsConfig } from './experiments-config';
-
 /**
  * This is a utility function for testing editor experiments.
  *
@@ -15,11 +17,11 @@ import { editorExperimentsConfig } from './experiments-config';
  * ```ts
  * eeTest('example-boolean', {
  *   true: () => {
- * 	   expect(editorExperiment('example-boolean', true)).toBe(true);
- * 		 expect(editorExperiment('example-boolean', false)).toBe(false);
+ *     expect(editorExperiment('example-boolean', true)).toBe(true);
+ *     expect(editorExperiment('example-boolean', false)).toBe(false);
  *   },
  *   false: () => {
- *	   expect(editorExperiment('example-boolean', false)).toBe(true);
+ *     expect(editorExperiment('example-boolean', false)).toBe(true);
  *     expect(editorExperiment('example-boolean', true)).toBe(false);
  *   },
  * })
@@ -29,21 +31,24 @@ import { editorExperimentsConfig } from './experiments-config';
  * ```ts
  * eeTest('example-multivariate', {
  *   one: () => {
- * 	   expect(editorExperiment('example-multivariate', 'one')).toBe(true);
- * 		 expect(editorExperiment('example-multivariate', 'two')).toBe(false);
+ *     expect(editorExperiment('example-multivariate', 'one')).toBe(true);
+ *     expect(editorExperiment('example-multivariate', 'two')).toBe(false);
  *   },
  *   two: () => {
- * 	   expect(editorExperiment('example-multivariate', 'two')).toBe(true);
- * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *     expect(editorExperiment('example-multivariate', 'two')).toBe(true);
+ *     expect(editorExperiment('example-multivariate', 'one')).toBe(false);
  *   },
  *   three: () => {
- * 	   expect(editorExperiment('example-multivariate', 'three')).toBe(true);
- * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *     expect(editorExperiment('example-multivariate', 'three')).toBe(true);
+ *     expect(editorExperiment('example-multivariate', 'one')).toBe(false);
  *   },
  * })
  * ```
+ *
+ * API based on Legacy ffTest API
+ * - https://hello.atlassian.net/wiki/spaces/AF/pages/2569505829/Task+Testing+your+feature+flag+in+platform+and+product#Legacy-API-lEGACY
  */
-export function eeTest(experimentName, cases, otherExperiments) {
+function eeTest(experimentName, cases, otherExperiments) {
   setupEditorExperiments('test', {});
   describe("eeTest: ".concat(experimentName), function () {
     afterEach(function () {
@@ -76,4 +81,76 @@ export function eeTest(experimentName, cases, otherExperiments) {
       };
     }());
   });
-}
+}
+
+/**
+ * eeTest.describe() Wrapper utility for describe() that runs a test with a editor experiment overides.
+ *
+ * @example Single experiment
+ * ```ts
+ * eeTest.describe('Description of test "suite" containing nested suites and tests.', { 'example-boolean': true }, () => {
+ *  it('should do the thing', () => {
+ * 		expect(editorExperiment('example-boolean', true)).toBe(true);
+ * 	});
+ * });
+ * ```
+ *
+ *
+ * @example Multiple experiment
+ * ```ts
+ * eeTest.describe('Description of test "suite" containing nested suites and tests.', { 'example-boolean': true, 'example-multivariate': 'three' }, () => {
+ *  it('should do the thing', () => {
+ * 		expect(editorExperiment('example-boolean', true)).toBe(true);
+ * 	});
+ * });
+ * ```
+ *
+ * API based on next gen ffTest API
+ * - https://hello.atlassian.net/wiki/spaces/AF/pages/2569505829/Task+Testing+your+feature+flag+in+platform+and+product#Next-Generation-API-%E2%9C%A8
+ */
+eeTest.describe = function eeTestDescribe(experimentName, describeName) {
+  function eeTest(value) {
+    var describeBody = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function () {};
+    describe("".concat(describeName, " [").concat(value, "]"), function () {
+      beforeEach(function () {
+        setupEditorExperiments('test', _defineProperty({}, experimentName, value));
+      });
+      afterEach(function () {
+        setupEditorExperiments('test', {});
+      });
+      describeBody();
+    });
+    setupEditorExperiments('test', {});
+  }
+  function variant(value, describeBody) {
+    eeTest(value, describeBody);
+  }
+  function each(describeBody) {
+    var possibleValues =
+    // @ts-ignore
+    editorExperimentsConfig[experimentName].typeGuard.values;
+    if (possibleValues) {
+      var _iterator = _createForOfIteratorHelper(possibleValues),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var value = _step.value;
+          eeTest(value, describeBody);
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+    } else {
+      // if there are no possible values, it's a boolean experiment
+      eeTest(true, describeBody);
+      eeTest(false, describeBody);
+    }
+  }
+  return {
+    variant: variant,
+    each: each
+  };
+};
+export { eeTest };

package/dist/esm/experiments-config.js

@@ -1,11 +1,4 @@
-function isBoolean(value) {
-  return typeof value === 'boolean';
-}
-function oneOf(values) {
-  return function (value) {
-    return values.includes(value);
-  };
-}
+import { isBoolean, oneOf } from './type-guards';
 /**
  * When adding a new experiment, you need to add it here.
  * Please follow the pattern established in the examples and any
@@ -208,5 +201,24 @@ export var editorExperimentsConfig = {
     param: 'isEnabled',
     typeGuard: isBoolean,
     defaultValue: false
+  },
+  // Added 2024-09-23
+  // https://console.statsig.com/LqivKg6ADZZaGczRfBKfX/experiments/editor_ai_-_multi_prompts/setup
+  'editor_ai_-_multi_prompts': {
+    productKeys: {
+      confluence: 'editor_ai_-_multi_prompts'
+    },
+    param: 'cohort',
+    typeGuard: oneOf(['control', 'test']),
+    defaultValue: 'control'
+  },
+  // Added 2024-10-01
+  comment_on_bodied_extensions: {
+    productKeys: {
+      confluence: 'platform_editor_comment_on_bodied_extensions'
+    },
+    param: 'isEnabled',
+    typeGuard: isBoolean,
+    defaultValue: false
   }
 };

package/dist/esm/type-guards.js

@@ -0,0 +1,19 @@
+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 = process.env.NODE_ENV === 'test' || process.env.JEST_WORKER_ID !== undefined;

package/dist/types/editor-experiments-test-utils.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="jest" />
 import { type EditorExperimentOverrides } from './setup';
 import { type EditorExperimentsConfig } from './experiments-config';
+type DescribeBody = Parameters<typeof describe>[1];
 /**
  * This is a utility function for testing editor experiments.
  *
@@ -7,11 +9,11 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * ```ts
  * eeTest('example-boolean', {
  *   true: () => {
- * 	   expect(editorExperiment('example-boolean', true)).toBe(true);
- * 		 expect(editorExperiment('example-boolean', false)).toBe(false);
+ *     expect(editorExperiment('example-boolean', true)).toBe(true);
+ *     expect(editorExperiment('example-boolean', false)).toBe(false);
  *   },
  *   false: () => {
- *	   expect(editorExperiment('example-boolean', false)).toBe(true);
+ *     expect(editorExperiment('example-boolean', false)).toBe(true);
  *     expect(editorExperiment('example-boolean', true)).toBe(false);
  *   },
  * })
@@ -21,21 +23,217 @@ import { type EditorExperimentsConfig } from './experiments-config';
  * ```ts
  * eeTest('example-multivariate', {
  *   one: () => {
- * 	   expect(editorExperiment('example-multivariate', 'one')).toBe(true);
- * 		 expect(editorExperiment('example-multivariate', 'two')).toBe(false);
+ *     expect(editorExperiment('example-multivariate', 'one')).toBe(true);
+ *     expect(editorExperiment('example-multivariate', 'two')).toBe(false);
  *   },
  *   two: () => {
- * 	   expect(editorExperiment('example-multivariate', 'two')).toBe(true);
- * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *     expect(editorExperiment('example-multivariate', 'two')).toBe(true);
+ *     expect(editorExperiment('example-multivariate', 'one')).toBe(false);
  *   },
  *   three: () => {
- * 	   expect(editorExperiment('example-multivariate', 'three')).toBe(true);
- * 		 expect(editorExperiment('example-multivariate', 'one')).toBe(false);
+ *     expect(editorExperiment('example-multivariate', 'three')).toBe(true);
+ *     expect(editorExperiment('example-multivariate', 'one')).toBe(false);
  *   },
  * })
  * ```
+ *
+ * API based on Legacy ffTest API
+ * - https://hello.atlassian.net/wiki/spaces/AF/pages/2569505829/Task+Testing+your+feature+flag+in+platform+and+product#Legacy-API-lEGACY
  */
-export declare function eeTest<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, cases: EditorExperimentsConfig[ExperimentName]['defaultValue'] extends string ? Record<EditorExperimentsConfig[ExperimentName]['defaultValue'], () => void | Promise<void>> : {
-    true: () => void | Promise<void>;
-    false: () => void | Promise<void>;
+declare function eeTest<ExperimentName extends keyof EditorExperimentsConfig>(experimentName: ExperimentName, cases: EditorExperimentsConfig[ExperimentName]['defaultValue'] extends string ? Record<EditorExperimentsConfig[ExperimentName]['defaultValue'], DescribeBody> : {
+    true: DescribeBody;
+    false: DescribeBody;
 }, otherExperiments?: EditorExperimentOverrides): void;
+declare namespace eeTest {
+    var describe: <ExperimentName extends "example-boolean" | "example-multivariate" | "test-new-experiments-package" | "basic-text-transformations" | "platform_editor_ai_command_palate_improvement" | "platform-editor-ai-condensed-floating-toobar" | "dnd-input-performance-optimisation" | "element-level-templates" | "add-media-from-url" | "nested-dnd" | "table-nested-dnd" | "insert-menu-in-right-rail" | "platform_editor_empty_line_prompt" | "support_table_in_comment" | "platform_editor_exp_lazy_node_views" | "platform_editor_ai_ai_button_block_elements" | "platform_renderer_table_sticky_scrollbar" | "nest-media-and-codeblock-in-quote" | "nested-expand-in-expand" | "platform_editor_ai_command_palette_post_ga" | "platform_editor_table_use_shared_state_hook" | "editor_ai_-_multi_prompts" | "comment_on_bodied_extensions">(experimentName: ExperimentName, describeName: string) => {
+        variant: (value: {
+            'example-boolean': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'example-multivariate': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: (value: unknown) => value is "one" | "two" | "three";
+                defaultValue: "one" | "two" | "three";
+            };
+            'test-new-experiments-package': {
+                productKeys: {
+                    confluence: string;
+                    jira: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'basic-text-transformations': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            platform_editor_ai_command_palate_improvement: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: (value: unknown) => value is "test" | "control";
+                defaultValue: "test" | "control";
+            };
+            'platform-editor-ai-condensed-floating-toobar': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: (value: unknown) => value is "control" | "dropdown" | "editor_ai_button";
+                defaultValue: "control" | "dropdown" | "editor_ai_button";
+            };
+            'dnd-input-performance-optimisation': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'element-level-templates': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'add-media-from-url': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'nested-dnd': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'table-nested-dnd': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'insert-menu-in-right-rail': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            platform_editor_empty_line_prompt: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            support_table_in_comment: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            platform_editor_exp_lazy_node_views: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            platform_editor_ai_ai_button_block_elements: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: (value: unknown) => value is "test" | "control";
+                defaultValue: "test" | "control";
+            };
+            platform_renderer_table_sticky_scrollbar: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'nest-media-and-codeblock-in-quote': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'nested-expand-in-expand': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            platform_editor_ai_command_palette_post_ga: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: (value: unknown) => value is "test" | "control";
+                defaultValue: "test" | "control";
+            };
+            platform_editor_table_use_shared_state_hook: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+            'editor_ai_-_multi_prompts': {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: (value: unknown) => value is "test" | "control";
+                defaultValue: "test" | "control";
+            };
+            comment_on_bodied_extensions: {
+                productKeys: {
+                    confluence: string;
+                };
+                param: string;
+                typeGuard: typeof import("./type-guards").isBoolean;
+                defaultValue: boolean;
+            };
+        }[ExperimentName]["defaultValue"], describeBody: jest.EmptyFunction) => void;
+        each: (describeBody: jest.EmptyFunction) => void;
+    };
+}
+export { eeTest };

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

@@ -1,4 +1,4 @@
-declare function isBoolean(value: unknown): value is boolean;
+import { isBoolean } from './type-guards';
 export type EditorExperimentsConfig = typeof editorExperimentsConfig;
 /**
  * When adding a new experiment, you need to add it here.
@@ -44,8 +44,8 @@ export declare const editorExperimentsConfig: {
             confluence: string;
         };
         param: string;
-        typeGuard: (value: unknown) => value is "control" | "test";
-        defaultValue: "control" | "test";
+        typeGuard: (value: unknown) => value is "test" | "control";
+        defaultValue: "test" | "control";
     };
     'platform-editor-ai-condensed-floating-toobar': {
         productKeys: {
@@ -132,8 +132,8 @@ export declare const editorExperimentsConfig: {
             confluence: string;
         };
         param: string;
-        typeGuard: (value: unknown) => value is "control" | "test";
-        defaultValue: "control" | "test";
+        typeGuard: (value: unknown) => value is "test" | "control";
+        defaultValue: "test" | "control";
     };
     platform_renderer_table_sticky_scrollbar: {
         productKeys: {
@@ -164,8 +164,8 @@ export declare const editorExperimentsConfig: {
             confluence: string;
         };
         param: string;
-        typeGuard: (value: unknown) => value is "control" | "test";
-        defaultValue: "control" | "test";
+        typeGuard: (value: unknown) => value is "test" | "control";
+        defaultValue: "test" | "control";
     };
     platform_editor_table_use_shared_state_hook: {
         productKeys: {
@@ -175,5 +175,20 @@ export declare const editorExperimentsConfig: {
         typeGuard: typeof isBoolean;
         defaultValue: boolean;
     };
+    'editor_ai_-_multi_prompts': {
+        productKeys: {
+            confluence: string;
+        };
+        param: string;
+        typeGuard: (value: unknown) => value is "test" | "control";
+        defaultValue: "test" | "control";
+    };
+    comment_on_bodied_extensions: {
+        productKeys: {
+            confluence: string;
+        };
+        param: string;
+        typeGuard: typeof isBoolean;
+        defaultValue: boolean;
+    };
 };
-export {};

package/dist/types/setup.d.ts

@@ -7,7 +7,7 @@ export declare let _overrides: Partial<{
     'example-multivariate': "one" | "two" | "three";
     'test-new-experiments-package': boolean;
     'basic-text-transformations': boolean;
-    platform_editor_ai_command_palate_improvement: "control" | "test";
+    platform_editor_ai_command_palate_improvement: "test" | "control";
     'platform-editor-ai-condensed-floating-toobar': "control" | "dropdown" | "editor_ai_button";
     'dnd-input-performance-optimisation': boolean;
     'element-level-templates': boolean;
@@ -18,12 +18,14 @@ export declare let _overrides: Partial<{
     platform_editor_empty_line_prompt: boolean;
     support_table_in_comment: boolean;
     platform_editor_exp_lazy_node_views: boolean;
-    platform_editor_ai_ai_button_block_elements: "control" | "test";
+    platform_editor_ai_ai_button_block_elements: "test" | "control";
     platform_renderer_table_sticky_scrollbar: boolean;
     'nest-media-and-codeblock-in-quote': boolean;
     'nested-expand-in-expand': boolean;
-    platform_editor_ai_command_palette_post_ga: "control" | "test";
+    platform_editor_ai_command_palette_post_ga: "test" | "control";
     platform_editor_table_use_shared_state_hook: boolean;
+    'editor_ai_-_multi_prompts': "test" | "control";
+    comment_on_bodied_extensions: boolean;
 }>;
 export declare let _product: 'confluence' | 'jira' | 'test' | undefined;
 /**

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

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