@atlaskit/editor-common 110.2.3 → 110.3.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/editor-common
 
+## 110.3.0
+
+### Minor Changes
+
+- [`e3780960bb0ae`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e3780960bb0ae) - ##
+  What Update `EditorAnalyticsAPI` to allow for `fireAnalyticsEvent` to use a custom payload if an
+  explicit type parameter is used. This is mostly used by the analytics plugin
+
+  ```ts
+  // Example
+  api?.analytics.actions.fireAnalyticsEvent<CustomPayload, 'customEventType'>({ ... });
+  ```
+
+  ## Why
+
+  The current Payload structure is not extensible. There are times we don't want to update the base
+  analytics types (and increase bundle size) and scope them only to a specific package. This
+  provides an escape hatch but still enforces some level of type safety (currently there are some
+  examples of using `ts-expect-error` to side step this).
+
+  ## How to upgrade
+
+  In most scenarios this should not cause any breaking change but can be breaking if you are side
+  stepping type safety here with `ts-expect-error`.
+
 ## 110.2.3
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 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 = "110.2.2";
+var packageVersion = "110.2.3";
 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 = "110.2.2";
+var packageVersion = "110.2.3";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 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 = "110.2.2";
+const packageVersion = "110.2.3";
 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';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "110.2.2";
+const packageVersion = "110.2.3";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 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 = "110.2.2";
+var packageVersion = "110.2.3";
 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';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "110.2.2";
+var packageVersion = "110.2.3";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/analytics/api.d.ts

@@ -6,6 +6,15 @@ export type FireAnalyticsEventOptions = {
     };
     immediate?: boolean;
 };
+export type BaseEventPayload = {
+    action: string;
+    actionSubject: string;
+    actionSubjectId?: string | null;
+    attributes?: {
+        [key: string]: any;
+    };
+    eventType: string;
+};
 export type EditorAnalyticsAPI = {
     /**
      * attachAnalyticsEvent is used to attach an analytics payloads to a transaction
@@ -24,6 +33,12 @@ export type EditorAnalyticsAPI = {
      * @param {object} [options] - optional options object
      * @param {boolean} [options.immediate] - if true, fire the event immediately
      * @param {object} [options.context] - optional context object will include the selection data.
+     *
+     * @example
+     * You can also pass custom events using a special type signature:
+     * ```ts
+     * editorAnalyticsAPI.fireAnalyticsEvent<CustomEventType, 'customEventType'>(...);
+     * ```
      */
-    fireAnalyticsEvent: (payload: AnalyticsEventPayload, channel?: string, options?: FireAnalyticsEventOptions) => void | undefined;
+    fireAnalyticsEvent: (<Payload extends BaseEventPayload, CustomEventType extends 'customEventType' | false = false>(payload: CustomEventType extends 'customEventType' ? Payload : never, channel?: string, options?: FireAnalyticsEventOptions) => void | undefined) & ((payload: AnalyticsEventPayload, channel?: string, options?: FireAnalyticsEventOptions) => void | undefined);
 };

package/dist/types/analytics/index.d.ts

@@ -36,7 +36,7 @@ export type { OperationalAEP } from './types/utils';
 export type { PluginMethodReport, PluginsReport, NodeCount, PluginPerformanceReportData, } from './types/performance-report';
 export type { InitialiseFragmentMarksAEP, ConnectedNodesAEP, DisconnectedSourceAEP, DisconnectedTargetAEP, GotConnectionsAEP, UpdatedFragmentMarkNameAEP, UpdatedSourceAEP, UpdatedTargetAEP, } from './types/referentiality-events';
 export type { ViewInlineCommentsButtonEventAEP, ViewEventPayload } from './types/view-events';
-export type { EditorAnalyticsAPI, FireAnalyticsEventOptions } from './api';
+export type { EditorAnalyticsAPI, FireAnalyticsEventOptions, BaseEventPayload } from './api';
 export { editorAnalyticsChannel, fireAnalyticsEvent } from './fire-analytics-event';
 export { getAnalyticsEventsFromTransaction } from './utils';
 export { buildEditLinkPayload, buildVisitedLinkPayload, buildVisitedNonHyperLinkPayload, buildOpenedSettingsPayload, unlinkPayload, } from './linking-utils';

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

@@ -6,6 +6,15 @@ export type FireAnalyticsEventOptions = {
     };
     immediate?: boolean;
 };
+export type BaseEventPayload = {
+    action: string;
+    actionSubject: string;
+    actionSubjectId?: string | null;
+    attributes?: {
+        [key: string]: any;
+    };
+    eventType: string;
+};
 export type EditorAnalyticsAPI = {
     /**
      * attachAnalyticsEvent is used to attach an analytics payloads to a transaction
@@ -24,6 +33,12 @@ export type EditorAnalyticsAPI = {
      * @param {object} [options] - optional options object
      * @param {boolean} [options.immediate] - if true, fire the event immediately
      * @param {object} [options.context] - optional context object will include the selection data.
+     *
+     * @example
+     * You can also pass custom events using a special type signature:
+     * ```ts
+     * editorAnalyticsAPI.fireAnalyticsEvent<CustomEventType, 'customEventType'>(...);
+     * ```
      */
-    fireAnalyticsEvent: (payload: AnalyticsEventPayload, channel?: string, options?: FireAnalyticsEventOptions) => void | undefined;
+    fireAnalyticsEvent: (<Payload extends BaseEventPayload, CustomEventType extends 'customEventType' | false = false>(payload: CustomEventType extends 'customEventType' ? Payload : never, channel?: string, options?: FireAnalyticsEventOptions) => void | undefined) & ((payload: AnalyticsEventPayload, channel?: string, options?: FireAnalyticsEventOptions) => void | undefined);
 };

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

@@ -36,7 +36,7 @@ export type { OperationalAEP } from './types/utils';
 export type { PluginMethodReport, PluginsReport, NodeCount, PluginPerformanceReportData, } from './types/performance-report';
 export type { InitialiseFragmentMarksAEP, ConnectedNodesAEP, DisconnectedSourceAEP, DisconnectedTargetAEP, GotConnectionsAEP, UpdatedFragmentMarkNameAEP, UpdatedSourceAEP, UpdatedTargetAEP, } from './types/referentiality-events';
 export type { ViewInlineCommentsButtonEventAEP, ViewEventPayload } from './types/view-events';
-export type { EditorAnalyticsAPI, FireAnalyticsEventOptions } from './api';
+export type { EditorAnalyticsAPI, FireAnalyticsEventOptions, BaseEventPayload } from './api';
 export { editorAnalyticsChannel, fireAnalyticsEvent } from './fire-analytics-event';
 export { getAnalyticsEventsFromTransaction } from './utils';
 export { buildEditLinkPayload, buildVisitedLinkPayload, buildVisitedNonHyperLinkPayload, buildOpenedSettingsPayload, unlinkPayload, } from './linking-utils';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "110.2.3",
+	"version": "110.3.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -71,7 +71,7 @@
 		"@atlaskit/platform-feature-flags-react": "^0.3.0",
 		"@atlaskit/popper": "^7.1.0",
 		"@atlaskit/primitives": "^14.15.0",
-		"@atlaskit/profilecard": "^24.14.0",
+		"@atlaskit/profilecard": "^24.15.0",
 		"@atlaskit/react-ufo": "^4.11.0",
 		"@atlaskit/section-message": "^8.7.0",
 		"@atlaskit/smart-card": "^42.3.0",