@atlaskit/editor-common 127.1.1 → 127.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-common
 
+## 127.2.0
+
+### Minor Changes
+
+- [`823f26ef0b0ba`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/823f26ef0b0ba) -
+  Add uppercase named enum values for Suggested Edits regeneration and entry-point analytics, and
+  use them at production call sites while preserving existing string types and emitted values.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 127.1.1
 
 ### Patch Changes

package/analytics/ai-suggestions-entry-points/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/analytics/ai-suggestions-entry-points",
+  "main": "../../dist/cjs/analytics/types/ai-suggestions-events.js",
+  "module": "../../dist/esm/analytics/types/ai-suggestions-events.js",
+  "module:es2019": "../../dist/es2019/analytics/types/ai-suggestions-events.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/analytics/types/ai-suggestions-events.d.ts"
+}

package/analytics/ai-suggestions-regeneration/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/analytics/ai-suggestions-regeneration",
+  "main": "../../dist/cjs/analytics/types/ai-suggestions-events.js",
+  "module": "../../dist/esm/analytics/types/ai-suggestions-events.js",
+  "module:es2019": "../../dist/es2019/analytics/types/ai-suggestions-events.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/analytics/types/ai-suggestions-events.d.ts"
+}

package/dist/cjs/analytics/types/ai-suggestions-events.js

@@ -2,4 +2,50 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.AiSuggestionsRightRailEntryPointValue = exports.AiSuggestionsRegenerationTriggerValue = exports.AiSuggestionsRegenerationOutcomeValue = exports.AiSuggestionsEntryPointValue = void 0;
+var AiSuggestionsEntryPointValue = exports.AiSuggestionsEntryPointValue = /*#__PURE__*/function (AiSuggestionsEntryPointValue) {
+  AiSuggestionsEntryPointValue["PRIMARY_TOOLBAR"] = "primaryToolbar";
+  /**
+   * @private
+   * @deprecated Legacy entry point retained for backwards compatibility.
+   * Use `SUGGESTIONS_PANEL_EMPTY_STATE` for the standalone suggestions panel.
+   */
+  AiSuggestionsEntryPointValue["COMMENTS_EMPTY_STATE"] = "commentsEmptyState";
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_EMPTY_STATE"] = "suggestionsPanelEmptyState";
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_HEADER"] = "suggestionsPanelHeader";
+  AiSuggestionsEntryPointValue["OBJECT_SIDEBAR_CONTROL"] = "objectSidebarControl";
+  /**
+   * @private
+   * @deprecated Legacy automatic-generation entry point retained for backwards compatibility.
+   */
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_MOUNT"] = "suggestionsPanelMount";
+  /** The "Review" button on the follow-up card after the last suggestion is actioned. */
+  AiSuggestionsEntryPointValue["FOLLOW_UP_CARD"] = "followUpCard";
+  return AiSuggestionsEntryPointValue;
+}({});
+var AiSuggestionsRightRailEntryPointValue = exports.AiSuggestionsRightRailEntryPointValue = /*#__PURE__*/function (AiSuggestionsRightRailEntryPointValue) {
+  AiSuggestionsRightRailEntryPointValue["SUGGESTIONS_PANEL"] = "suggestionsPanel";
+  AiSuggestionsRightRailEntryPointValue["SUGGESTIONS_TAB"] = "suggestionsTab";
+  // Will be deprecated.
+  AiSuggestionsRightRailEntryPointValue["SUGGESTION_CARD"] = "suggestionCard";
+  return AiSuggestionsRightRailEntryPointValue;
+}({});
+var AiSuggestionsRegenerationTriggerValue = exports.AiSuggestionsRegenerationTriggerValue = /*#__PURE__*/function (AiSuggestionsRegenerationTriggerValue) {
+  AiSuggestionsRegenerationTriggerValue["PANEL_OPEN"] = "panelOpen";
+  AiSuggestionsRegenerationTriggerValue["REVIEW_COMPLETED"] = "reviewCompleted";
+  AiSuggestionsRegenerationTriggerValue["SUGGESTION_SELECTED"] = "suggestionSelected";
+  AiSuggestionsRegenerationTriggerValue["SUGGESTIONS_UPDATED"] = "suggestionsUpdated";
+  return AiSuggestionsRegenerationTriggerValue;
+}({});
+var AiSuggestionsRegenerationOutcomeValue = exports.AiSuggestionsRegenerationOutcomeValue = /*#__PURE__*/function (AiSuggestionsRegenerationOutcomeValue) {
+  AiSuggestionsRegenerationOutcomeValue["REMOVED"] = "removed";
+  AiSuggestionsRegenerationOutcomeValue["STILL_STALE"] = "stillStale";
+  AiSuggestionsRegenerationOutcomeValue["UPDATED"] = "updated";
+  return AiSuggestionsRegenerationOutcomeValue;
+}({});
+/**
+ * Fired when the user clicks the "Try again" / retry button on the suggested
+ * edits error screen (the thinking bar's error state). Lets us measure how
+ * often users attempt to recover from a suggestions failure.
+ */

package/dist/cjs/monitoring/error.js

@@ -27,7 +27,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "127.1.0";
+var packageVersion = "127.1.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "127.1.0";
+var packageVersion = "127.1.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/analytics/types/ai-suggestions-events.js

@@ -1 +1,46 @@
-export {};
+export let AiSuggestionsEntryPointValue = /*#__PURE__*/function (AiSuggestionsEntryPointValue) {
+  AiSuggestionsEntryPointValue["PRIMARY_TOOLBAR"] = "primaryToolbar";
+  /**
+   * @private
+   * @deprecated Legacy entry point retained for backwards compatibility.
+   * Use `SUGGESTIONS_PANEL_EMPTY_STATE` for the standalone suggestions panel.
+   */
+  AiSuggestionsEntryPointValue["COMMENTS_EMPTY_STATE"] = "commentsEmptyState";
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_EMPTY_STATE"] = "suggestionsPanelEmptyState";
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_HEADER"] = "suggestionsPanelHeader";
+  AiSuggestionsEntryPointValue["OBJECT_SIDEBAR_CONTROL"] = "objectSidebarControl";
+  /**
+   * @private
+   * @deprecated Legacy automatic-generation entry point retained for backwards compatibility.
+   */
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_MOUNT"] = "suggestionsPanelMount";
+  /** The "Review" button on the follow-up card after the last suggestion is actioned. */
+  AiSuggestionsEntryPointValue["FOLLOW_UP_CARD"] = "followUpCard";
+  return AiSuggestionsEntryPointValue;
+}({});
+export let AiSuggestionsRightRailEntryPointValue = /*#__PURE__*/function (AiSuggestionsRightRailEntryPointValue) {
+  AiSuggestionsRightRailEntryPointValue["SUGGESTIONS_PANEL"] = "suggestionsPanel";
+  AiSuggestionsRightRailEntryPointValue["SUGGESTIONS_TAB"] = "suggestionsTab";
+  // Will be deprecated.
+  AiSuggestionsRightRailEntryPointValue["SUGGESTION_CARD"] = "suggestionCard";
+  return AiSuggestionsRightRailEntryPointValue;
+}({});
+export let AiSuggestionsRegenerationTriggerValue = /*#__PURE__*/function (AiSuggestionsRegenerationTriggerValue) {
+  AiSuggestionsRegenerationTriggerValue["PANEL_OPEN"] = "panelOpen";
+  AiSuggestionsRegenerationTriggerValue["REVIEW_COMPLETED"] = "reviewCompleted";
+  AiSuggestionsRegenerationTriggerValue["SUGGESTION_SELECTED"] = "suggestionSelected";
+  AiSuggestionsRegenerationTriggerValue["SUGGESTIONS_UPDATED"] = "suggestionsUpdated";
+  return AiSuggestionsRegenerationTriggerValue;
+}({});
+export let AiSuggestionsRegenerationOutcomeValue = /*#__PURE__*/function (AiSuggestionsRegenerationOutcomeValue) {
+  AiSuggestionsRegenerationOutcomeValue["REMOVED"] = "removed";
+  AiSuggestionsRegenerationOutcomeValue["STILL_STALE"] = "stillStale";
+  AiSuggestionsRegenerationOutcomeValue["UPDATED"] = "updated";
+  return AiSuggestionsRegenerationOutcomeValue;
+}({});
+
+/**
+ * Fired when the user clicks the "Try again" / retry button on the suggested
+ * edits error screen (the thinking bar's error state). Lets us measure how
+ * often users attempt to recover from a suggestions failure.
+ */

package/dist/es2019/monitoring/error.js

@@ -13,7 +13,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "127.1.0";
+const packageVersion = "127.1.1";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/ui/DropList/index.js

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "127.1.0";
+const packageVersion = "127.1.1";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/analytics/types/ai-suggestions-events.js

@@ -1 +1,46 @@
-export {};
+export var AiSuggestionsEntryPointValue = /*#__PURE__*/function (AiSuggestionsEntryPointValue) {
+  AiSuggestionsEntryPointValue["PRIMARY_TOOLBAR"] = "primaryToolbar";
+  /**
+   * @private
+   * @deprecated Legacy entry point retained for backwards compatibility.
+   * Use `SUGGESTIONS_PANEL_EMPTY_STATE` for the standalone suggestions panel.
+   */
+  AiSuggestionsEntryPointValue["COMMENTS_EMPTY_STATE"] = "commentsEmptyState";
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_EMPTY_STATE"] = "suggestionsPanelEmptyState";
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_HEADER"] = "suggestionsPanelHeader";
+  AiSuggestionsEntryPointValue["OBJECT_SIDEBAR_CONTROL"] = "objectSidebarControl";
+  /**
+   * @private
+   * @deprecated Legacy automatic-generation entry point retained for backwards compatibility.
+   */
+  AiSuggestionsEntryPointValue["SUGGESTIONS_PANEL_MOUNT"] = "suggestionsPanelMount";
+  /** The "Review" button on the follow-up card after the last suggestion is actioned. */
+  AiSuggestionsEntryPointValue["FOLLOW_UP_CARD"] = "followUpCard";
+  return AiSuggestionsEntryPointValue;
+}({});
+export var AiSuggestionsRightRailEntryPointValue = /*#__PURE__*/function (AiSuggestionsRightRailEntryPointValue) {
+  AiSuggestionsRightRailEntryPointValue["SUGGESTIONS_PANEL"] = "suggestionsPanel";
+  AiSuggestionsRightRailEntryPointValue["SUGGESTIONS_TAB"] = "suggestionsTab";
+  // Will be deprecated.
+  AiSuggestionsRightRailEntryPointValue["SUGGESTION_CARD"] = "suggestionCard";
+  return AiSuggestionsRightRailEntryPointValue;
+}({});
+export var AiSuggestionsRegenerationTriggerValue = /*#__PURE__*/function (AiSuggestionsRegenerationTriggerValue) {
+  AiSuggestionsRegenerationTriggerValue["PANEL_OPEN"] = "panelOpen";
+  AiSuggestionsRegenerationTriggerValue["REVIEW_COMPLETED"] = "reviewCompleted";
+  AiSuggestionsRegenerationTriggerValue["SUGGESTION_SELECTED"] = "suggestionSelected";
+  AiSuggestionsRegenerationTriggerValue["SUGGESTIONS_UPDATED"] = "suggestionsUpdated";
+  return AiSuggestionsRegenerationTriggerValue;
+}({});
+export var AiSuggestionsRegenerationOutcomeValue = /*#__PURE__*/function (AiSuggestionsRegenerationOutcomeValue) {
+  AiSuggestionsRegenerationOutcomeValue["REMOVED"] = "removed";
+  AiSuggestionsRegenerationOutcomeValue["STILL_STALE"] = "stillStale";
+  AiSuggestionsRegenerationOutcomeValue["UPDATED"] = "updated";
+  return AiSuggestionsRegenerationOutcomeValue;
+}({});
+
+/**
+ * Fired when the user clicks the "Try again" / retry button on the suggested
+ * edits error screen (the thinking bar's error state). Lets us measure how
+ * often users attempt to recover from a suggestions failure.
+ */

package/dist/esm/monitoring/error.js

@@ -19,7 +19,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "127.1.0";
+var packageVersion = "127.1.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/ui/DropList/index.js

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "127.1.0";
+var packageVersion = "127.1.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/analytics/types/ai-suggestions-events.d.ts

@@ -1,28 +1,47 @@
 import type { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID } from './enums';
 import type { OperationalAEP, TrackAEP } from './utils';
-export type AiSuggestionsEntryPoint = 'primaryToolbar'
-/**
- * @private
- * @deprecated Legacy entry point retained for backwards compatibility.
- * Use `suggestionsPanelEmptyState` for the standalone suggestions panel.
- */
- | 'commentsEmptyState' | 'suggestionsPanelEmptyState' | 'suggestionsPanelHeader' | 'objectSidebarControl'
-/**
- * @private
- * @deprecated Legacy automatic-generation entry point retained for backwards compatibility.
- */
- | 'suggestionsPanelMount'
-/**
- * The "Review" button on the follow-up card shown in place of the suggestion card
- * once the last inline comment suggestion has been actioned.
- */
- | 'followUpCard';
+export declare enum AiSuggestionsEntryPointValue {
+    PRIMARY_TOOLBAR = "primaryToolbar",
+    /**
+     * @private
+     * @deprecated Legacy entry point retained for backwards compatibility.
+     * Use `SUGGESTIONS_PANEL_EMPTY_STATE` for the standalone suggestions panel.
+     */
+    COMMENTS_EMPTY_STATE = "commentsEmptyState",
+    SUGGESTIONS_PANEL_EMPTY_STATE = "suggestionsPanelEmptyState",
+    SUGGESTIONS_PANEL_HEADER = "suggestionsPanelHeader",
+    OBJECT_SIDEBAR_CONTROL = "objectSidebarControl",
+    /**
+     * @private
+     * @deprecated Legacy automatic-generation entry point retained for backwards compatibility.
+     */
+    SUGGESTIONS_PANEL_MOUNT = "suggestionsPanelMount",
+    /** The "Review" button on the follow-up card after the last suggestion is actioned. */
+    FOLLOW_UP_CARD = "followUpCard"
+}
+export type AiSuggestionsEntryPoint = `${AiSuggestionsEntryPointValue}`;
 export type AiSuggestionInteractionPoint = 'sidebar' | 'card' | 'statusBar';
-export type AiSuggestionsRightRailEntryPoint = 'suggestionsPanel' | 'suggestionsTab' | 'suggestionCard';
+export declare enum AiSuggestionsRightRailEntryPointValue {
+    SUGGESTIONS_PANEL = "suggestionsPanel",
+    SUGGESTIONS_TAB = "suggestionsTab",// Will be deprecated.
+    SUGGESTION_CARD = "suggestionCard"
+}
+export type AiSuggestionsRightRailEntryPoint = `${AiSuggestionsRightRailEntryPointValue}`;
 export type AiSuggestionsEmptyStateType = 'initial' | 'noSuggestionsFound' | 'suggestionsResolved';
 export type AiSuggestionsConversationErrorReason = 'agentDeactivated' | 'agentProvisioning' | 'agentExternalConfigReference' | 'conversationSetup' | 'streamError';
-export type AiSuggestionsRegenerationTrigger = 'panelOpen' | 'reviewCompleted' | 'suggestionSelected' | 'suggestionsUpdated';
-export type AiSuggestionsRegenerationOutcome = 'removed' | 'stillStale' | 'updated';
+export declare enum AiSuggestionsRegenerationTriggerValue {
+    PANEL_OPEN = "panelOpen",
+    REVIEW_COMPLETED = "reviewCompleted",
+    SUGGESTION_SELECTED = "suggestionSelected",
+    SUGGESTIONS_UPDATED = "suggestionsUpdated"
+}
+export declare enum AiSuggestionsRegenerationOutcomeValue {
+    REMOVED = "removed",
+    STILL_STALE = "stillStale",
+    UPDATED = "updated"
+}
+export type AiSuggestionsRegenerationTrigger = `${AiSuggestionsRegenerationTriggerValue}`;
+export type AiSuggestionsRegenerationOutcome = `${AiSuggestionsRegenerationOutcomeValue}`;
 type SuggestionRemixAttributes = {
     remixSubtype?: string;
     remixType?: string;
@@ -78,7 +97,9 @@ type EntryPointClickedAEP = TrackAEP<ACTION.CLICKED, ACTION_SUBJECT.AI_SUGGESTIO
 type SuggestionsErrorRetryClickedAEP = TrackAEP<ACTION.CLICKED, ACTION_SUBJECT.AI_SUGGESTIONS, ACTION_SUBJECT_ID.SUGGESTIONS_ERROR_RETRY, undefined, undefined>;
 type EntryPointExposureAEP = TrackAEP<ACTION.EXPOSED, ACTION_SUBJECT.AI_SUGGESTIONS, undefined, {
     entryPoint: AiSuggestionsEntryPoint;
-}, undefined>;
+}, undefined> & {
+    source?: 'objectSidebar';
+};
 type SuggestionLifecycleAttributes = SuggestionRemixAttributes & TimeSinceGenerationAttribute & {
     actionKind: string;
     affectedBlocks: number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "127.1.1",
+	"version": "127.2.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -85,7 +85,7 @@
 		"@atlaskit/task-decision": "^21.11.0",
 		"@atlaskit/teams-app-config": "^3.1.0",
 		"@atlaskit/textfield": "^10.2.0",
-		"@atlaskit/tmp-editor-statsig": "^219.0.0",
+		"@atlaskit/tmp-editor-statsig": "^220.0.0",
 		"@atlaskit/tokens": "^20.1.0",
 		"@atlaskit/tooltip": "^24.4.0",
 		"@atlaskit/width-detector": "^7.2.0",