@atlaskit/link-datasource 2.11.14 → 2.11.16

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/link-datasource
 
+## 2.11.16
+
+### Patch Changes
+
+- [#136744](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/136744)
+  [`04df6a1d732b5`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/04df6a1d732b5) -
+  Fix errorLocation analytic attribute typing
+
+## 2.11.15
+
+### Patch Changes
+
+- [#136349](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/136349)
+  [`a1c9a8ac45907`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a1c9a8ac45907) -
+  Adds the ui.form.submitted.inlineEdit analytic event to be fired on when users attempts to update
+  via inline edit.
+
 ## 2.11.14
 
 ### Patch Changes

package/dist/cjs/ui/issue-like-table/table-cell-content/inline-edit.js

@@ -13,6 +13,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _react = _interopRequireWildcard(require("react"));
 var _inlineEdit = _interopRequireDefault(require("@atlaskit/inline-edit"));
 var _primitives = require("@atlaskit/primitives");
+var _analytics = require("../../../analytics");
 var _useDatasourceTableFlag = require("../../../hooks/useDatasourceTableFlag");
 var _state = require("../../../state");
 var _editType = require("../edit-type");
@@ -53,6 +54,8 @@ var InlineEdit = exports.InlineEdit = function InlineEdit(_ref) {
     showErrorFlag = _useDatasourceTableFl.showErrorFlag;
   var _useDatasourceActions = (0, _state.useDatasourceActions)(),
     onUpdateItem = _useDatasourceActions.onUpdateItem;
+  var _useDatasourceAnalyti = (0, _analytics.useDatasourceAnalyticsEvents)(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var onCommitUpdate = (0, _react.useCallback)(function (value) {
     if (!item) {
       setIsEditing(false);
@@ -65,6 +68,7 @@ var InlineEdit = exports.InlineEdit = function InlineEdit(_ref) {
       return;
     }
     onUpdateItem(ari, newItem);
+    fireEvent('ui.form.submitted.inlineEdit', {});
     execute(value).catch(function (error) {
       var status = error && (0, _typeof2.default)(error) === 'object' ? error.status : undefined;
       showErrorFlag({
@@ -73,7 +77,7 @@ var InlineEdit = exports.InlineEdit = function InlineEdit(_ref) {
       onUpdateItem(ari, existingData);
     });
     setIsEditing(false);
-  }, [ari, item, datasourceTypeWithValues.type, columnKey, onUpdateItem, execute, showErrorFlag]);
+  }, [item, datasourceTypeWithValues.type, columnKey, onUpdateItem, ari, execute, fireEvent, showErrorFlag]);
   return /*#__PURE__*/_react.default.createElement(_primitives.Box, {
     xcss: editContainerStyles
   }, /*#__PURE__*/_react.default.createElement(_inlineEdit.default, (0, _extends2.default)({}, (0, _editType.editType)(datasourceTypeWithValues), {

package/dist/es2019/ui/issue-like-table/table-cell-content/inline-edit.js

@@ -2,6 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
 import React, { useCallback, useState } from 'react';
 import AKInlineEdit from '@atlaskit/inline-edit';
 import { Box, xcss } from '@atlaskit/primitives';
+import { useDatasourceAnalyticsEvents } from '../../../analytics';
 import { useDatasourceTableFlag } from '../../../hooks/useDatasourceTableFlag';
 import { useDatasourceActions, useDatasourceItem } from '../../../state';
 import { editType } from '../edit-type';
@@ -41,6 +42,9 @@ export const InlineEdit = ({
   const {
     onUpdateItem
   } = useDatasourceActions();
+  const {
+    fireEvent
+  } = useDatasourceAnalyticsEvents();
   const onCommitUpdate = useCallback(value => {
     if (!item) {
       setIsEditing(false);
@@ -53,6 +57,7 @@ export const InlineEdit = ({
       return;
     }
     onUpdateItem(ari, newItem);
+    fireEvent('ui.form.submitted.inlineEdit', {});
     execute(value).catch(error => {
       const status = error && typeof error === 'object' ? error.status : undefined;
       showErrorFlag({
@@ -61,7 +66,7 @@ export const InlineEdit = ({
       onUpdateItem(ari, existingData);
     });
     setIsEditing(false);
-  }, [ari, item, datasourceTypeWithValues.type, columnKey, onUpdateItem, execute, showErrorFlag]);
+  }, [item, datasourceTypeWithValues.type, columnKey, onUpdateItem, ari, execute, fireEvent, showErrorFlag]);
   return /*#__PURE__*/React.createElement(Box, {
     xcss: editContainerStyles
   }, /*#__PURE__*/React.createElement(AKInlineEdit, _extends({}, editType(datasourceTypeWithValues), {

package/dist/esm/ui/issue-like-table/table-cell-content/inline-edit.js

@@ -7,6 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import React, { useCallback, useState } from 'react';
 import AKInlineEdit from '@atlaskit/inline-edit';
 import { Box, xcss } from '@atlaskit/primitives';
+import { useDatasourceAnalyticsEvents } from '../../../analytics';
 import { useDatasourceTableFlag } from '../../../hooks/useDatasourceTableFlag';
 import { useDatasourceActions, useDatasourceItem } from '../../../state';
 import { editType } from '../edit-type';
@@ -43,6 +44,8 @@ export var InlineEdit = function InlineEdit(_ref) {
     showErrorFlag = _useDatasourceTableFl.showErrorFlag;
   var _useDatasourceActions = useDatasourceActions(),
     onUpdateItem = _useDatasourceActions.onUpdateItem;
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
   var onCommitUpdate = useCallback(function (value) {
     if (!item) {
       setIsEditing(false);
@@ -55,6 +58,7 @@ export var InlineEdit = function InlineEdit(_ref) {
       return;
     }
     onUpdateItem(ari, newItem);
+    fireEvent('ui.form.submitted.inlineEdit', {});
     execute(value).catch(function (error) {
       var status = error && _typeof(error) === 'object' ? error.status : undefined;
       showErrorFlag({
@@ -63,7 +67,7 @@ export var InlineEdit = function InlineEdit(_ref) {
       onUpdateItem(ari, existingData);
     });
     setIsEditing(false);
-  }, [ari, item, datasourceTypeWithValues.type, columnKey, onUpdateItem, execute, showErrorFlag]);
+  }, [item, datasourceTypeWithValues.type, columnKey, onUpdateItem, ari, execute, fireEvent, showErrorFlag]);
   return /*#__PURE__*/React.createElement(Box, {
     xcss: editContainerStyles
   }, /*#__PURE__*/React.createElement(AKInlineEdit, _extends({}, editType(datasourceTypeWithValues), {

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

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::a773c6cad8ff2e59bb7020ea85e35bc5>>
+ * @codegen <<SignedSource::0d4e0c024f984c4facf077d6a3f6ccda>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type ComponentMetaDataType = {
@@ -68,7 +68,7 @@ export type DatasourceRenderSuccessAttributesType = {
 };
 export type DatasourceRenderFailureAttributesType = {};
 export type DatasourceOperationFailedAttributesType = {
-    errorLocation: string | null;
+    errorLocation: 'ProviderOnAuthRequest' | 'loadDatasourceDetails' | 'onNextPage' | 'actionDiscovery' | 'actionExecution' | null;
     traceId: string | null;
     status: number | null;
 };
@@ -151,6 +151,7 @@ export type ActionDiscoverySuccessAttributesType = {
     integrationKey: string | null;
     datasourceId: string | null;
 };
+export type FormSubmittedInlineEditAttributesType = {};
 export type AnalyticsEventAttributes = {
     /**
      * Fires when user sees modal dialog. */
@@ -266,5 +267,8 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when the action discovery and permissions request is successful. */
     'operational.actionDiscovery.success': ActionDiscoverySuccessAttributesType;
+    /**
+     * Fired when the user initiates an update via inline edit through enter key press or submit */
+    'ui.form.submitted.inlineEdit': FormSubmittedInlineEditAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

package/dist/types/hooks/useErrorLogger.d.ts

@@ -1,3 +1,4 @@
+import { type DatasourceOperationFailedAttributesType } from '../analytics/generated/analytics.types';
 /**
  * This function is just a wrapper around captureException that checks if the enable-sentry-client FF is enabled
  * and error is instanceof Error. We have to override the type of error from captureException to unknown so we use
@@ -14,6 +15,6 @@ interface UseErrorLoggerPropsActions {
 }
 export type UseErrorLoggerProps = UseErrorLoggerPropsDatasource | UseErrorLoggerPropsActions;
 declare const useErrorLogger: (loggerProps: UseErrorLoggerProps) => {
-    captureError: (errorLocation: string, error: unknown) => void;
+    captureError: (errorLocation: DatasourceOperationFailedAttributesType['errorLocation'], error: unknown) => void;
 };
 export default useErrorLogger;

package/dist/types/state/actions/index.d.ts

@@ -1,7 +1,7 @@
 import { type Action } from 'react-sweet-state';
 import { useDatasourceClientExtension } from '@atlaskit/link-client-extension';
 import type { ActionsDiscoveryRequest, AtomicActionInterface } from '@atlaskit/linking-types';
-import { type EventKey } from '../../../src/analytics/generated/analytics.types';
+import { type DatasourceOperationFailedAttributesType, type EventKey } from '../../../src/analytics/generated/analytics.types';
 import type createEventPayload from '../../../src/analytics/generated/create-event-payload';
 type IntegrationKey = string;
 type FieldKey = string;
@@ -49,7 +49,7 @@ export interface ActionsStoreState {
 interface Client {
     getDatasourceActionsAndPermissions: ReturnType<typeof useDatasourceClientExtension>['getDatasourceActionsAndPermissions'];
 }
-type AnalyticsCaptureError = (errorLocation: string, error: unknown) => void;
+type AnalyticsCaptureError = (errorLocation: DatasourceOperationFailedAttributesType['errorLocation'], error: unknown) => void;
 type AnalyticsFireEvent = <K extends EventKey>(...params: Parameters<typeof createEventPayload<K>>) => void;
 interface UseDiscoverActionsProps {
     captureError: AnalyticsCaptureError;

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

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::a773c6cad8ff2e59bb7020ea85e35bc5>>
+ * @codegen <<SignedSource::0d4e0c024f984c4facf077d6a3f6ccda>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type ComponentMetaDataType = {
@@ -68,7 +68,7 @@ export type DatasourceRenderSuccessAttributesType = {
 };
 export type DatasourceRenderFailureAttributesType = {};
 export type DatasourceOperationFailedAttributesType = {
-    errorLocation: string | null;
+    errorLocation: 'ProviderOnAuthRequest' | 'loadDatasourceDetails' | 'onNextPage' | 'actionDiscovery' | 'actionExecution' | null;
     traceId: string | null;
     status: number | null;
 };
@@ -151,6 +151,7 @@ export type ActionDiscoverySuccessAttributesType = {
     integrationKey: string | null;
     datasourceId: string | null;
 };
+export type FormSubmittedInlineEditAttributesType = {};
 export type AnalyticsEventAttributes = {
     /**
      * Fires when user sees modal dialog. */
@@ -266,5 +267,8 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when the action discovery and permissions request is successful. */
     'operational.actionDiscovery.success': ActionDiscoverySuccessAttributesType;
+    /**
+     * Fired when the user initiates an update via inline edit through enter key press or submit */
+    'ui.form.submitted.inlineEdit': FormSubmittedInlineEditAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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

@@ -1,3 +1,4 @@
+import { type DatasourceOperationFailedAttributesType } from '../analytics/generated/analytics.types';
 /**
  * This function is just a wrapper around captureException that checks if the enable-sentry-client FF is enabled
  * and error is instanceof Error. We have to override the type of error from captureException to unknown so we use
@@ -14,6 +15,6 @@ interface UseErrorLoggerPropsActions {
 }
 export type UseErrorLoggerProps = UseErrorLoggerPropsDatasource | UseErrorLoggerPropsActions;
 declare const useErrorLogger: (loggerProps: UseErrorLoggerProps) => {
-    captureError: (errorLocation: string, error: unknown) => void;
+    captureError: (errorLocation: DatasourceOperationFailedAttributesType['errorLocation'], error: unknown) => void;
 };
 export default useErrorLogger;

package/dist/types-ts4.5/state/actions/index.d.ts

@@ -1,7 +1,7 @@
 import { type Action } from 'react-sweet-state';
 import { useDatasourceClientExtension } from '@atlaskit/link-client-extension';
 import type { ActionsDiscoveryRequest, AtomicActionInterface } from '@atlaskit/linking-types';
-import { type EventKey } from '../../../src/analytics/generated/analytics.types';
+import { type DatasourceOperationFailedAttributesType, type EventKey } from '../../../src/analytics/generated/analytics.types';
 import type createEventPayload from '../../../src/analytics/generated/create-event-payload';
 type IntegrationKey = string;
 type FieldKey = string;
@@ -49,7 +49,7 @@ export interface ActionsStoreState {
 interface Client {
     getDatasourceActionsAndPermissions: ReturnType<typeof useDatasourceClientExtension>['getDatasourceActionsAndPermissions'];
 }
-type AnalyticsCaptureError = (errorLocation: string, error: unknown) => void;
+type AnalyticsCaptureError = (errorLocation: DatasourceOperationFailedAttributesType['errorLocation'], error: unknown) => void;
 type AnalyticsFireEvent = <K extends EventKey>(...params: Parameters<typeof createEventPayload<K>>) => void;
 interface UseDiscoverActionsProps {
     captureError: AnalyticsCaptureError;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/link-datasource",
-	"version": "2.11.14",
+	"version": "2.11.16",
 	"description": "UI Components to support linking platform dataset feature",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",